查询指定条件下的流量调控任务信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| pairec:ListTrafficControlTasks | list | *全部资源 * |
| 无 |
请求语法
GET /api/v1/trafficcontroltasks HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Name | string | 否 | 流量调控任务名称。 | task_1 |
| TrafficControlTaskId | string | 否 | 流量调控任务 ID。 | 1 |
| SceneId | string | 否 | 场景 ID,来源于 ListScenes 接口。 | 1 |
| Environment | string | 否 | 运行环境。
| Pre |
| Status | string | 否 | 状态。
| Running |
| Version | string | 否 | 版本。
| Latest |
| ControlTargetFilter | string | 否 | 过滤流量调控目标。
| All |
| SortBy | string | 否 | 排序依据。
| GmtCreateTime |
| Order | string | 否 | 排序方式,取值:
| ASC |
| PageNumber | string | 否 | 分页数,从 1 开始,默认为 1。 | 1 |
| PageSize | string | 否 | 每页记录数。默认值为 10。 | 10 |
| All | boolean | 否 | 是否返回所有数据(不分页)。 | false |
| InstanceId | string | 否 | 实例 ID,可通过接口 ListInstances 获取。 | pairec-cn-******** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "3AAA45F6-0798-5461-9360-81D133823CE7",
"TotalCount": 20,
"TrafficControlTasks": [
{
"TrafficControlTaskId": 1,
"Name": "task_1",
"Description": "this is a test task",
"SceneId": 4,
"SceneName": "home_feed",
"ProductStatus": "Runnning",
"PrepubStatus": "Runnning",
"ExecutionTime": "Permanent",
"StartTime": "2024-03-25",
"EndTime": "2024-04-25",
"BehaviorTableMetaId": 1,
"UserTableMetaId": 2,
"ItemTableMetaId": 3,
"UserConditionType": "Array",
"UserConditionArray": [
{
"field": "gender",
"option": "=",
"value": "male"
}
],
"UserConditionExpress": "age<=30&&(3<=level<=6)&&gender=male",
"StatisBehaviorConditionType": "Array",
"StatisBehaviorConditionArray": [
{
"field": "click",
"option": "<=",
"value": 30
}
],
"StatisBahaviorConditionExpress": "event=click",
"ControlType": "Percent",
"ControlGranularity": "Global",
"ControlLogic": "Guaranteed",
"ItemConditionType": "Array",
"ItemConditionArray": [
{
"field": "status",
"option": "=",
"value": 1
}
],
"ItemConditionExpress": "status=1",
"GmtCreateTime": "2024-03-25T06:04:28.441Z",
"GmtModifiedTime": "2024-03-25T06:04:28.441Z",
"TrafficControlTargets": [
{
"TrafficControlTargetId": 1,
"Name": "target-1",
"StartTime": "2024-03-25",
"EndTime": "2024-04-25",
"ItemConditionType": "Array",
"ItemConditionArray": [
{
"field": "status",
"option": "=",
"value": 1
}
],
"ItemConditionExpress": "status=1",
"Event": "click",
"Value": 30,
"StatisPeriod": "Daily",
"ToleranceValue": 10,
"RecallName": "recall-1",
"Status": "Opened",
"GmtCreateTime": "2025-06-03T15:08:10.58+08:00",
"GmtModifiedTime": "2025-11-21T16:26:58.57+08:00",
"SplitParts": {
"TimePoints": [
10
],
"SetValues": [
3
]
},
"NewProductRegulation": false,
"TrafficControlTaskId": 1
}
],
"EverPublished": false,
"ServiceId": 1,
"PreExperimentIds": "1,2",
"ProdExperimentIds": "6,7",
"FlinkResourceId": "resource-xxx",
"FlinkResourceName": "flink_test",
"StatisBehaviorConditionExpress": "event=exposure",
"EffectiveSceneIds": [
4
],
"EffectiveSceneNames": [
0
],
"ServiceIds": [
4
],
"EffectiveSceneNameList": [
"home_feed"
],
"ServiceIdList": [
3
]
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-04-08 | 新增 OpenAPI | 查看变更详情 |
