使用ListTasks查询异步API的返回结果-弹性高性能计算-阿里云-弹性高性能计算(E-HPC)-阿里云帮助中心

调用ListTasks查询指定集群下异步API的返回结果。

接口说明

对于一些异步 API（如 AddNodes），请求成功会立即返回结果，但不会等待节点创建成功。此时，您可以使用接口返回的 TaskId 查询具体的任务运行结果。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ehpc:ListTasks

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	待查询的集群 ID。您可以通过调用 ListClusters 获取集群 ID。	ehpc-hz-FYUr32****
PageNumber	integer	否	显示的页码，起始值为 1，取值范围：1~999。	1
PageSize	integer	否	每页显示的条数。取值范围：1~50。默认值：10。	10
TaskId	string	否	任务 ID。您可以调用以下异步 API 获取对应的 TaskId。 CreateCluster StartCluster StopCluster DeleteCluster AddNodes StartNodes ResetNodes StopNodes DeleteNodes	B745C159-3155-4B94-95D0-4B73D4D2****
Archived	boolean	否	是否显示已运行的异步 API 的历史返回结果。取值范围： true：显示正在运行和历史运行的任务返回结果。 false：仅显示正在运行的任务返回结果，当没有正在运行的任务时，task 返回为`[]`。默认值：false。说明当您配置了 TaskId 参数时，此参数无效。枚举值： false : 仅显示正在运行的任务返回结果 true : 显示正在运行和历史运行的任务返回结果	false

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	本页条数。	10
RequestId	string	请求 ID。	89A1AC0F-4A6C-4F3D-98F9-BEF9A823****
PageNumber	integer	当前页码。	1
TotalCount	integer	任务列表条目总数。	10
Tasks	array<object>	任务信息列表。
	object	任务信息列表。
Status	string	任务运行状态。可能值： Processing：运行中 Success：运行成功 Fail：运行失败 PartialFail：部分运行失败	Processing
TaskType	string	任务类型。可能值： CreateCluster：创建集群，对应的 API 为 CreateCluster StartCluster：启动集群，对应的 API 为 StartCluster StopCluster：停止集群，对应的 API 为 StopCluster DeleteCluster：释放集群，对应的 API 为 DeleteCluster AddComputes：添加节点到集群，对应的 API 为 AddNodes StartComputes：启动节点，对应的 API 为 StartNodes ResetComputes：重置节点，对应的 API 为 ResetNodes StopComputes：停止节点，对应的 API 为 StopNodes DeleteComputes：删除节点，对应的 API 为 DeleteNodes	StopCluster
TotalSteps	integer	任务总操作步数。	35
CurrentStep	integer	任务当前操作步数。	16
Result	string	任务运行结果。可能值：当 TaskType 为 CreateCluster 和 AddComputes 时，格式为`{\"Instances\":[]}`，表示加入到集群的节点信息。当 TaskType 为除 CreateCluster 和 AddComputes 的其他值时，格式为`{}`。	{\"Instances\":[{\"InstanceId\":\"i-bp1inb1j2xz8pnoi***\",\"Ip\":\"192.168..*\",\"Hostname\":\"login0\",\"role\":\"login\"}]}
Errors	string	任务运行错误信息列表。您可以在错误中心查看错误信息及对应的解决方案。	[]
TaskId	string	任务 ID。	B745C159-3155-4B94-95D0-4B73D4D2****
Request	string	任务的请求参数信息，格式为 JSON 字符串。	{\"requestId\":\"0A6CA33E-BFBF-4F92-BDAE-4E8860DA**\",\"uid\":\"160998252992\",\"bid\":\"268\",\"clusterId\":\"ehpc-hz-ysQtcZ****\"}
ClusterId	string	集群 ID。	ehpc-hz-FYUr32****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The specified parameter %s is invalid.	指定的参数 %s 无效。
400	NotEnabled	You have not enabled this service	您的账户还未开通此服务
500	UnknownError	An unknown error occurred.	未知错误
404	ClusterNotFound	The specified cluster does not exist.	指定的集群不存在，请您检查该参数是否正确。
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	请求失败，服务暂时不可用
406	DbError	A database service error occurred.	数据库请求失败
406	RedisError	A Redis service error occurred.	Redis请求失败
407	NotAuthorized	You are not authorized by RAM for this request.	此请求未获得RAM授权

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。