QueryTrafficControlTaskDeployResult

更新时间:
复制 MD 格式

Retrieves the deployment status and related information for a specified traffic control task in a specific environment.

Operation description

Description

Queries the deployment result of a traffic control task for a specific TrafficControlTaskId in a given instance and environment. Ensure the provided InstanceId is associated with your account and the Environment is one of the following: Daily (daily environment), Pre (pre-release environment), or Prod (production environment).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

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

Path Parameters

Parameter

Type

Required

Description

Example

TrafficControlTaskId

string

No

The traffic control task ID.

1

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

No

The instance ID.

pairec_123****

Environment

string

No

The environment where the task is deployed. Valid values: Daily (daily environment), Pre (pre-release environment), and Prod (production environment).

Daily

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77

TrafficControlTaskId

string

The traffic control task ID.

3

DraftStatus

string

The status of pushing the draft to Flink. Valid values:

  • Failed: The push failed.

  • Running: The push is in progress.

  • Success: The push was successful.

Success

DraftMessage

string

The message returned from pushing the draft to Flink.

push draft success

DeployStatus

string

The deployment status of the draft. Valid values:

  • Failed: The deployment failed.

  • Running: The deployment is in progress.

  • Success: The deployment was successful.

Success

DeployMessage

string

The message returned from the deployment operation.

deploy job draft success

StartStatus

string

The startup status of the Flink task. Valid values:

  • Failed: The startup failed.

  • Running: The startup is in progress.

  • Success: The startup was successful.

Success

StartMessage

string

The message returned from the Flink task startup.

start job success

PrepareStatus

string

The status of the preparation phase. Valid values:

  • Failed: The preparation failed.

  • Running: The preparation is in progress.

  • Success: The preparation was successful.

Success

PrepareMessage

string

The message returned from the preparation phase.

success

Examples

Success response

JSON format

{
  "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"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.