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

接口说明

当某些API为异步API,如AddNodes,请求成功就会立即返回结果,但不会等待节点创建成功。您可以使用AddNodes返回的TaskId查询具体的任务运行结果。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTasks

系统规定参数。取值:ListTasks

ClusterId String ehpc-hz-FYUr32****

待查询的集群ID。

您可以通过调用ListClusters获取集群ID。

PageNumber Integer 1

显示的页码,起始值为1,取值范围:1~999

PageSize Integer 10

每页显示的条数。取值范围:1~50

默认值:10

TaskId String B745C159-3155-4B94-95D0-4B73D4D2****

任务ID。您可以调用以下异步API获取对应的TaskId。

Archived Boolean false

是否显示已运行的异步API的历史返回结果。取值范围:

  • true:显示正在运行和历史运行的任务返回结果。
  • false:仅显示正在运行的任务返回结果,当没有正在运行的任务时,task返回为[]

默认值:false

说明 当您配置了TaskId参数时,此参数无效。

返回数据

名称 类型 示例值 描述
PageNumber Integer 1

当前页码。

PageSize Integer 10

本页条数。

RequestId String 89A1AC0F-4A6C-4F3D-98F9-BEF9A823****

请求ID。

Tasks Array of TaskInfo

任务信息列表。

ClusterId String ehpc-hz-FYUr32****

集群ID。

CurrentStep Integer 16

任务当前操作步数。

Errors String []

任务运行错误信息列表。

您可以在错误中心查看错误信息及对应的解决方案。

Request String {\"requestId\":\"0A6CA33E-BFBF-4F92-BDAE-4E8860DA****\",\"uid\":\"160998252992****\",\"bid\":\"268**\",\"clusterId\":\"ehpc-hz-ysQtcZ****\"}

任务的请求参数信息,格式为JSON字符串。

Result String {\"Instances\":[{\"InstanceId\":\"i-bp1inb1j2xz8pnoi****\",\"Ip\":\"192.168.*.*\",\"Hostname\":\"login0\",\"role\":\"login\"}]}

任务运行结果。可能值:

  • 当TaskType为CreateCluster和AddComputes时,格式为{\"Instances\":[]},表示加入到集群的节点信息。
  • 当TaskType为除CreateCluster和AddComputes的其他值时,格式为{}
Status String Processing

任务运行状态。可能值:

  • Processing:运行中
  • Success:运行成功
  • Fail:运行失败
  • PartialFail:部分运行失败
TaskId String B745C159-3155-4B94-95D0-4B73D4D2****

任务ID。

TaskType String StopCluster

任务类型。可能值:

  • 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
TotalSteps Integer 35

任务总操作步数。

TotalCount Integer 10

任务列表条目总数。

示例

请求示例

http(s)://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListTasks
&ClusterId=ehpc-hz-FYUr32****
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

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

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