QueryTrafficControlTaskDeployResult - 查询流量调控任务部署结果

更新时间:
复制为 MD 格式

获取指定流量调控任务在特定环境下的部署状态和相关信息。

接口说明

请求说明

通过此 API,您可以查询特定TrafficControlTaskId的流量调控任务在给定实例 ID 和环境下的部署结果。请确保提供的InstanceId与您的账户相关联,并且Environment参数值符合预期(Daily-日常环境, Pre-预发环境, Prod-生产环境)。所有请求参数均为必填项。

调试

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

授权信息

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

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

请求语法

GET /api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/queryresult HTTP/1.1

请求参数

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

流量调控 ID

1
InstanceIdstring

实例 ID。

pairec_123****
Environmentstring

所属的环境。Daily-日常环境 Pre-预发环境 Prod-生产环境

Daily

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 id。

728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77
TrafficControlTaskIdstring

流量调控任务 ID。

3
DraftStatusstring

推送草稿至 Flink 的状态,枚举值:

  • Failed:失败。
  • Running:运行中
  • Success:成功。
Success
DraftMessagestring

推送草稿至 Flink 的信息

push draft success
DeployStatusstring

部署草稿的状态,枚举值:

  • Failed:失败。
  • Running:运行中。
  • Success:成功。
Success
DeployMessagestring

flink 平台部署操作的信息。

deploy job draft success
StartStatusstring

启动 Flink 任务状态,枚举值:

  • Failed:失败。
  • Running:运行中。
  • Success:成功。
Success
StartMessagestring

启动 flink 任务信息。

start job success
PrepareStatusstring

准备阶段的状态:

  • Failed:失败。
  • Running:运行中
  • Success:成功。
Success
PrepareMessagestring

准备阶段信息。

success

示例

正常返回示例

JSON格式

{
  "RequestId": "728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77",
  "TrafficControlTaskId": 3,
  "DraftStatus": "Success",
  "DraftMessage": "push draft success",
  "DeployStatus": "Success",
  "DeployMessage": "deploy job draft success",
  "StartStatus": "Success",
  "StartMessage": "start job success",
  "PrepareStatus": "Success",
  "PrepareMessage": "success"
}

错误码

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

变更历史

变更时间变更内容概要操作
2026-04-08新增 OpenAPI查看变更详情