GetTask - Cloud Control API - Alibaba Cloud Documentation Center

Calls this operation to query a specified asynchronous task.

Operation description

GET /api/v1/tasks/{taskId}.

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

There is currently no authorization information disclosed in the API.

Request syntax

GET /api/v1/tasks/{taskId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
taskId	string	Yes	The ID of the task.	task-433aead756057fff8189a7ce5****

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
requestId	string	The ID of a request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
task	object	The information about the task.
createTime	string	The time when the task was created.	2022-10-09T00:46:03Z
error	object	The error returned for the task.
code	string	The error code.	OperationFailure.OperationFailed
message	string	The error message.	{ "requestId": "123****", "errorCode": "InvalidRamUser.NoPermission", "errorMsg": "Ram user is not authorized to perform the operation." }
product	string	The code of the service.	ECS
regionId	string	The region ID.	cn-beijing
resourceId	string	The ID of the resource.	i-8vbascjthm7kzhp3****
resourcePath	string	The path of the resources. The relative resource ID. The resource path contains the complete resource location (parent resource/child resource).	Instance/i-8vbascjthm7kzhp3**** Instance/r-8vbf5abe31c9c4d4/Account/cctest
resourceType	string	The resource type.	Instance
status	string	The task state. Pending Running Succeeded Failed Cancelling Cancelled.	Succeeded
taskAction	string	The type of the task operation. Valid values: Create, Update, and Delete.	Create
taskId	string	The ID of the task.	task-433aead756057fff8189a7ce5****

Examples

Sample success responses

JSONformat

{
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "task": {
    "createTime": "2022-10-09T00:46:03Z",
    "error": {
      "code": "OperationFailure.OperationFailed",
      "message": "{\n     \"requestId\": \"123****\",\n     \"errorCode\": \"InvalidRamUser.NoPermission\",\n     \"errorMsg\": \"Ram user is not authorized to perform the operation.\"\n}"
    },
    "product": "ECS",
    "regionId": "cn-beijing",
    "resourceId": "i-8vbascjthm7kzhp3****\n",
    "resourcePath": "Instance/i-8vbascjthm7kzhp3****\nInstance/r-8vbf5abe31c9c4d4/Account/cctest",
    "resourceType": "Instance",
    "status": "Succeeded",
    "taskAction": "Create",
    "taskId": "task-433aead756057fff8189a7ce5****"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-07-04	The internal configuration of the API is changed, but the call is not affected	View Change Details