DescribeTask-阿里云帮助中心

Queries the details of a specified task, including its status, type, steps, and subtasks.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eflo:DescribeTask

get

*Cluster

acs:eflo:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request parameters

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

Response elements

Element	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 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 Valid values: reclone_node_sub_task : 重装节点子任务 initialize_bare_cluster : 初始化裸集群 extend_bare_cluster : 扩容裸集群 reclone_node : 重装节点 reboot_node : 重启节点 extend_ack_edge_cluster : 扩容 ack 集群 extend_cluster : 扩容集群 initialize_ack_edge_cluster : 初始化 ack 集群 cut_node_sub_task : 缩容集群子任务 reboot_node_sub_task : 重启节点子任务 reclone_ack_edge_node : 重装 ack 节点 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.
	array<object>
StepName	string	The name of the step.	create_vpd
StepState	string	The step status. Valid values: execution_success execution_failed 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. Valid values: normal : 普通类型，有且只有一个后继 step dispersive : 发散类型，有多个后继 step	normal
SubTasks	array<object>	The 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 Valid values: reclone_node_sub_task : 重装节点子任务 initialize_bare_cluster : 初始化裸集群 extend_bare_cluster : 扩容裸集群 reclone_node : 重装节点 reboot_node : 重启节点 extend_ack_edge_cluster : 扩容 ack 集群 extend_cluster : 扩容集群 initialize_ack_edge_cluster : 初始化 ack 集群 cut_node_sub_task : 缩容集群子任务 reboot_node_sub_task : 重启节点子任务 reclone_ack_edge_node : 重装 ack 节点 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 subtasks.	Releasing [prod_main_mid_26e234cf] in region [cn-beijing] with weight [0]
TaskState	string	The task status.	running
StageTag	string	The stage tag. 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. Valid values: 机器释放 : 机器释放节点并发初始化 : 节点并发初始化节点释放 : 节点释放机器替换 : 机器替换节点缩容 : 节点缩容提前续费 : 提前续费物理机清理 : 物理机清理节点清理 : 节点清理创建K8s集群 : 创建 K8s 集群网络初始化 : 网络初始化节点重启 : 节点重启节点退订 : 节点退订集群扩容 : 集群扩容异常机器释放 : 异常机器释放	节点缩容
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 time when the task was created.	2022-11-30T02:00:00.852Z
UpdateTime	string	The update time.	2022-11-30T03:40:14.852Z
NodeIds	array	The IDs of the nodes.
	string	A node ID.	['mock-sn-200101']

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.