DescribeTask - Platform For AI - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries the details of a task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eflo:DescribeTask	get	*Cluster `acs:eflo:{#regionId}:{#accountId}:cluster/{#ClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The task ID.	i156331731670384438138

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	A7FD7411-9395-52E8-AF42-EB3A4A55446D
ClusterId	string	The cluster ID.	i119982311660892626523
ClusterName	string	The cluster name.	Standard_Cluster
TaskState	string	The task status. Valid values: running execution_success execution_fail waiting_to_run	running
TaskType	string	The task type. Valid values: reclone_node_sub_task initialize_bare_cluster extend_bare_cluster reclone_node reboot_node extend_ack_edge_cluster extend_cluster initialize_ack_edge_cluster cut_node_sub_task reboot_node_sub_task reclone_ack_edge_node initialize_cluster cut_cluster reclone_bare_node cut_bare_cluster	cut_cluster
Message	string	The error message returned for failed tasks.	Releasing [prod_main_mid_26e234cf] in region [cn-beijing] with weight [0]
Steps	array<object>	The steps.
Steps	object
StepName	string	The name of the step.	create_vpd
StepState	string	The step status. Valid values: execution_success execution_failed	execution_success
StepType	string	The type of the step. Valid values: normal: A normal step has only one successor step. dispersive: A dispersive step has multiple successor steps.	normal
SubTasks	array<object>	The sub tasks.
SubTasks	object
TaskId	string	The task ID.	i158805051661047928377
TaskType	string	The task type. Valid values: reclone_node_sub_task initialize_bare_cluster extend_bare_cluster reclone_node reboot_node extend_ack_edge_cluster extend_cluster initialize_ack_edge_cluster cut_node_sub_task reboot_node_sub_task reclone_ack_edge_node initialize_cluster cut_cluster reclone_bare_node cut_bare_cluster	cut_node_sub_task
CreateTime	string	The creation time.	2022-11-30T2:00:00.852Z
UpdateTime	string	The update time.	2022-11-30T02:20:14.852Z
Message	string	The error message returned for failed sub tasks.	Releasing [prod_main_mid_26e234cf] in region [cn-beijing] with weight [0]
TaskState	string	The task status.	running
StageTag	string	The stage marker. Valid values: 机器释放: Machine release. 节点并发初始化: Node concurrent initialization. 节点释放: Node release. 机器替换: Machine replacement. 节点缩容: Node scale-in. 提前续费: Early renewal. 物理机清理: Physical machine cleanup. 节点清理: Node cleanup. 创建 K8s 集群: Create Kubernetes cluster. 网络初始化: Network initialization. 节点重启: Node restart. 节点退订: Node unsubscribe. 集群扩容: Cluster scale-out. 异常机器释放: Abnormal machine release.	节点缩容
Message	string	The error message of the step.	get taskinfo failed
StartTime	string	The start time.	2022-11-30T2:00:00.852Z
UpdateTime	string	The update time.	2022-11-30T02:20:14.852Z
CreateTime	string	The create time.	2022-11-30T02:00:00.852Z
UpdateTime	string	The update time.	2022-11-30T03:40:14.852Z
NodeIds	array	The IDs of the nodes.
NodeIds	string	A node ID.	['mock-sn-200101']

Examples

Sample success responses

JSONformat

{
  "RequestId": "A7FD7411-9395-52E8-AF42-EB3A4A55446D",
  "ClusterId": "i119982311660892626523",
  "ClusterName": "Standard_Cluster",
  "TaskState": "running",
  "TaskType": "cut_cluster",
  "Message": "Releasing [prod_main_mid_26e234cf] in region [cn-beijing] with weight [0]",
  "Steps": [
    {
      "StepName": "create_vpd",
      "StepState": "execution_success",
      "StepType": "normal",
      "SubTasks": [
        {
          "TaskId": "i158805051661047928377",
          "TaskType": "cut_node_sub_task",
          "CreateTime": "2022-11-30T2:00:00.852Z",
          "UpdateTime": "2022-11-30T02:20:14.852Z",
          "Message": "Releasing [prod_main_mid_26e234cf] in region [cn-beijing] with weight [0]",
          "TaskState": "running"
        }
      ],
      "StageTag": "节点缩容",
      "Message": "get taskinfo failed",
      "StartTime": "2022-11-30T2:00:00.852Z",
      "UpdateTime": "2022-11-30T02:20:14.852Z"
    }
  ],
  "CreateTime": "2022-11-30T02:00:00.852Z",
  "UpdateTime": "2022-11-30T03:40:14.852Z",
  "NodeIds": [
    "['mock-sn-200101']"
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-06-06	The response structure of the API has changed	View Change Details