ListTasks - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Queries the response of an asynchronous API operation for a cluster.

Operation description

If you succeed in calling an asynchronous API operation, a response is generated before a resulting task is completed. Therefore, to query the result of the task, you can use the TaskId parameter returned by the API operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster. You can call the ListClusters operation to obtain the cluster ID.	ehpc-hz-FYUr32****
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Valid values: 1 to 999.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10	10
TaskId	string	No	The ID of the task. You can call the following asynchronous API operations to obtain the task ID. CreateCluster StartCluster StopCluster DeleteCluster AddNodes StartNodes ResetNodes StopNodes DeleteNodes	B745C159-3155-4B94-95D0-4B73D4D2****
Archived	boolean	No	Specifies whether to display the response history of the asynchronous API operation. Valid values: true: displays the current response and response history of the asynchronous API operation. false: displays only the current response of the asynchronous API operation. If no tasks are running, `[]` is returned. Default value: false Note If you specify the TaskId parameter, the Archived parameter is invalid.	false

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	89A1AC0F-4A6C-4F3D-98F9-BEF9A823****
PageNumber	integer	The page number of the returned page.	1
TotalCount	integer	The total number of entries of the task.	10
Tasks	object []	The list of task information.
Status	string	The status of the task. Valid values: Processing: The task is running. Success: The task is completed. Fail: The task failed. PartialFail: The task partially failed.	Processing
TaskType	string	The type of the task. Valid values: CreateCluster: creates a cluster by calling the CreateCluster operation. StartCluster: starts a cluster by calling the StartCluster operation. StopCluster: stops a cluster by calling the StopCluster operation. DeleteCluster: releases a cluster by calling the DeleteCluster operation. AddComputes: adds nodes to a cluster by calling the AddNodes operation. StartComputes: starts nodes by calling the StartNodes operation. ResetCompute: resets nodes by calling the ResetNodes operation. StopComputes: stops nodes by calling the StopNodes operation. DeleteComputes: deletes nodes by calling the DeleteNodes operation.	StopCluster
TotalSteps	integer	The total number of steps of the task.	35
CurrentStep	integer	The current step of the task.	16
Result	string	The result of the task. Valid values: If TaskType is set to CreateCluster and AddComputes, the value is in the `{\"Instances\":[]}` format, which indicates the information of the nodes added to the cluster. If TaskType is set to a value other than CreateCluster and AddComputes, the value is in the `{}` format.	{\"Instances\":[{\"InstanceId\":\"i-bp1inb1j2xz8pnoi***\",\"Ip\":\"192.168..*\",\"Hostname\":\"login0\",\"role\":\"login\"}]}
Errors	string	The list of error messages returned for the task. For information about error messages and their solutions, visit the API Error Center.	[]
TaskId	string	The ID of the task.	B745C159-3155-4B94-95D0-4B73D4D2****
Request	string	The request parameters of the task. The value is a JSON string.	{\"requestId\":\"0A6CA33E-BFBF-4F92-BDAE-4E8860DA**\",\"uid\":\"160998252992\",\"bid\":\"268\",\"clusterId\":\"ehpc-hz-ysQtcZ****\"}
ClusterId	string	The ID of the cluster.	ehpc-hz-FYUr32****

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "89A1AC0F-4A6C-4F3D-98F9-BEF9A823****",
  "PageNumber": 1,
  "TotalCount": 10,
  "Tasks": [
    {
      "Status": "Processing",
      "TaskType": "StopCluster",
      "TotalSteps": 35,
      "CurrentStep": 16,
      "Result": "{\\\"Instances\\\":[{\\\"InstanceId\\\":\\\"i-bp1inb1j2xz8pnoi****\\\",\\\"Ip\\\":\\\"192.168.*.*\\\",\\\"Hostname\\\":\\\"login0\\\",\\\"role\\\":\\\"login\\\"}]}",
      "Errors": "[]",
      "TaskId": "B745C159-3155-4B94-95D0-4B73D4D2****",
      "Request": "{\\\"requestId\\\":\\\"0A6CA33E-BFBF-4F92-BDAE-4E8860DA****\\\",\\\"uid\\\":\\\"160998252992****\\\",\\\"bid\\\":\\\"268**\\\",\\\"clusterId\\\":\\\"ehpc-hz-ysQtcZ****\\\"}",
      "ClusterId": "ehpc-hz-FYUr32****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	Invalid param: %s	-
400	NotEnabled	You have not enabled this service	You have not enabled this service
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
406	DbError	A database service error occurred.	Database request failed.
406	RedisError	A Redis service error occurred.	Redis request failed.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.

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