ListTrafficControlTasks - 获取流量调控任务列表

更新时间:
复制为 MD 格式

查询指定条件下的流量调控任务信息。

接口说明

请求说明

  • 该 API 用于获取符合特定条件的流量调控任务列表。
  • 用户可以通过提供不同的查询参数来过滤和排序返回的任务列表。
  • 支持分页查询,也可以选择一次性返回所有数据(不分页)。
  • 注意:InstanceId 是必填项,其他参数均为可选项,根据实际需求填写以获得更精确的结果。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pairec:ListTrafficControlTaskslist
*全部资源
*

请求语法

GET /api/v1/trafficcontroltasks HTTP/1.1

请求参数

名称类型必填描述示例值
Namestring

流量调控任务名称。

task_1
TrafficControlTaskIdstring

流量调控任务 ID。

1
SceneIdstring

场景 ID,来源于 ListScenes 接口。

1
Environmentstring

运行环境。

  • Daily-日常环境。

  • Pre-预发环境。

  • Prod-生产环境。

Pre
Statusstring

状态。

  • NotRunning:未运行。

  • Ready:待运行。

  • Running:运行中。

  • Finished:已结束。

Running
Versionstring

版本。

  • Latest:最新版本,默认值

  • Released:已发布版本

Latest
ControlTargetFilterstring

过滤流量调控目标。

  • All:返回所有。

  • Valid:返回有效的(开始结束时间段内是开启状态的)。

  • None:不返回。

All
SortBystring

排序依据。

  • GmtCreateTime:按创建时间排序。
  • GmtModifiedTime-按更新时间排序。
GmtCreateTime
Orderstring

排序方式,取值:

  • ASC:升序。
  • DESC:降序。
ASC
PageNumberstring

分页数,从 1 开始,默认为 1。

1
PageSizestring

每页记录数。默认值为 10。

10
Allboolean

是否返回所有数据(不分页)。

false
InstanceIdstring

实例 ID,可通过接口 ListInstances 获取。

pairec-cn-********

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

3AAA45F6-0798-5461-9360-81D133823CE7
TotalCountstring

列表内元素总数。

20
TrafficControlTasksarray<object>

流量调控任务列表。

TrafficControlTasksobject

流量调控任务详情。

TrafficControlTaskIdstring

流量调控任务 ID。

1
Namestring

流量调控名称。

task_1
Descriptionstring

流量调控描述。

this is a test task
SceneIdstring

场景 ID,可通过接口 ListScenes 获取。

4
SceneNamestring

场景名称。

home_feed
ProductStatusstring

生产环境状态。

Runnning
PrepubStatusstring

预发环境状态。

Runnning
ExecutionTimestring

执行时间.

  • Permanent:永久执行。

  • TimeRange: 指定时间范围。选择此参数时,需要指定 StartTime 和 EndTime。

Permanent
StartTimestring

开始时间。

2024-03-25
EndTimestring

结束时间。

2024-04-25
BehaviorTableMetaIdstring

行为表表 ID。

1
UserTableMetaIdstring

用户表表 ID。

2
ItemTableMetaIdstring

物品表表 ID。

3
UserConditionTypestring

干预人群条件类型。

Array
UserConditionArraystring

干预人群数组格式条件。

[{"field":"gender","option":"=","value":"male"}]
UserConditionExpressstring

干预人群表达式格式条件。

age<=30&&(3<=level<=6)&&gender=male
StatisBehaviorConditionTypestring

行为统计条件类型。

Array
StatisBehaviorConditionArraystring

行为统计数组格式条件。

[{"field":"click","option":"<=","value":"30"}]
StatisBahaviorConditionExpressstring

行为统计表达式格式。

event=click
ControlTypestring

调控类型。

Percent
ControlGranularitystring

调控粒度。

Global
ControlLogicstring

调控逻辑。

Guaranteed
ItemConditionTypestring

物品条件类型。

Array
ItemConditionArraystring

物品条件,设置数组格式条件。

[{"field":"status","option":"=","value":"1"}]
ItemConditionExpressstring

物品条件,设置表达式格式条件。

status=1
GmtCreateTimestring

创建时间。

2024-03-25T06:04:28.441Z
GmtModifiedTimestring

更新时间。

2024-03-25T06:04:28.441Z
TrafficControlTargetsarray<object>

流量调控目标列表。

TrafficControlTargetsobject

流量调控目标详情。

TrafficControlTargetIdstring

流量调控目标 ID。

1
Namestring

调控目标。

target-1
StartTimestring

开始时间。

2024-03-25
EndTimestring

结束时间。

2024-04-25
ItemConditionTypestring

物品条件类型。

Array
ItemConditionArraystring

物品条件,设置数组格式条件。

[{"field":"status","option":"=","value":"1"}]
ItemConditionExpressstring

物品条件,设置表达式格式条件。

status=1
Eventstring

调控目标事件。

click
Valuefloat

调控目标值。

30
StatisPeriodstring

统计周期。

Daily
ToleranceValuelong

调控目标容错范围。

10
RecallNamestring

召回策略名称。

recall-1
Statusstring

状态。

Opened
GmtCreateTimestring

创建时间。

2025-06-03T15:08:10.58+08:00
GmtModifiedTimestring

更新时间。

2025-11-21T16:26:58.57+08:00
SplitPartsobject

分割点详情。

TimePointsarray

时间分割点列表。

TimePointslong

时间点。

10
SetValuesarray

目标值分割点列表。

SetValueslong

目标值分割具体值。

3
NewProductRegulationboolean

是否是新品召回。

false
TrafficControlTaskIdstring

流量调控任务 ID。

1
EverPublishedboolean

是否已发布。

false
ServiceIdstring

服务 ID。

1
PreExperimentIdsstring

预发实验 ID 列表。

1,2
ProdExperimentIdsstring

生产试验列表。

6,7
FlinkResourceIdstring

Flink 资源 ID。

resource-xxx
FlinkResourceNamestring

Flink 资源名称。

flink_test
StatisBehaviorConditionExpressstring

行为表达式。

event=exposure
EffectiveSceneIdsarray

有效服务 ID 列表。

EffectiveSceneIdsinteger

有效服务 ID。

4
EffectiveSceneNamesarray

生效场景名称列表。

EffectiveSceneNamesinteger

生效场景名称。

home_feed
ServiceIdsarray

绑定的引擎服务 ID 列表。

ServiceIdsstring

引擎服务 ID。

4
EffectiveSceneNameListarray

生效场景列表。

EffectiveSceneNameListstring

生效场景。

home_feed
ServiceIdListarray

服务 ID 列表。

ServiceIdListinteger

服务 ID。

3

示例

正常返回示例

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查看变更详情