文档

ListFlowControlTask - 获取流量调控任务列表,按照创建时间倒序返回

查询流控任务列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /v2/openapi/instances/{instanceId}/flowControlTasks

请求参数

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

实例 ID。

airec-cn-****
taskIdstring

流量调控任务 ID。

1661506482
statusstring

任务状态。

取值:

  • DRAFT:草稿。

  • READY:待生效。

  • RUNNING:运行中。

  • ENDED:结束。

DRAFT
pageinteger

分页页数。

1
sizeinteger

指定每页展示条数,默认为 10,限制:[1-50]。

10

返回参数

名称类型描述示例值
object

返回参数。

requestIdstring

请求 ID。

6E427B10-30FC-1873-922F-FC176D3398D4
resultobject []

返回参数。

gmtCreatestring

创建时间,单位为 UTC 时间。

2022-08-06T06:14:01.000Z
gmtModifiedstring

最后修改时间,单位为 UTC 时间。

2022-08-06T06:14:01.000Z
metaobject

流量调控 Meta。

descriptionstring

流量调控描述信息。

这是一个测试任务
endTimelong

结束时间秒级时间戳。

1621267200
metaTypestring

流量调控 Meta 类型,固定值 FlowControlTask。

metaType
sceneIdsstring

场景 ID,支持多个,英文,分割即可。

1,2,3
selectionParamsobject []

选品规则参数列表。

selectTypestring

选品规则过滤条件类型。

selectType
selectValuestring

选品规则过滤条件具体数值。

selectValue
selectionOperationstring

选品规则过滤条件操作。

selectionOperation
startTimelong

开始时间秒级时间戳。

1621267200
targetobject

曝光配置。

typestring

曝光类型。

取值:

  • EXPOSE_PERCENT:每日曝光百分比。

  • EXPOSE_COUNT:曝光总量。

EXPOSE_PERCENT
valuelong

曝光值。

50
taskNamestring

流量调控任务名称。

testtaskname
statusstring

任务状态。

取值:

  • DRAFT:草稿。

  • READY:待生效。

  • RUNNING:运行中。

  • ENDED:结束。

DRAFT
TaskIdstring

流量调控任务 ID。

1661506482

示例

正常返回示例

JSON格式

{
  "requestId": "6E427B10-30FC-1873-922F-FC176D3398D4",
  "result": [
    {
      "gmtCreate": "2022-08-06T06:14:01.000Z",
      "gmtModified": "2022-08-06T06:14:01.000Z",
      "meta": {
        "description": "这是一个测试任务",
        "endTime": 1621267200,
        "metaType": "metaType",
        "sceneIds": "1,2,3",
        "selectionParams": [
          {
            "selectType": "selectType",
            "selectValue": "selectValue",
            "selectionOperation": "selectionOperation"
          }
        ],
        "startTime": 1621267200,
        "target": {
          "type": "EXPOSE_PERCENT",
          "value": 50
        },
        "taskName": "testtaskname"
      },
      "status": "DRAFT",
      "TaskId": "1661506482"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈