调用ListTasks查询指定集群下异步API的返回结果。
接口说明
对于一些异步 API(如 AddNodes),请求成功会立即返回结果,但不会等待节点创建成功。此时,您可以使用接口返回的 TaskId 查询具体的任务运行结果。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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。 | B745C159-3155-4B94-95D0-4B73D4D2**** |
Archived | boolean | 否 | 是否显示已运行的异步 API 的历史返回结果。取值范围:
默认值:false。 说明
当您配置了 TaskId 参数时,此参数无效。
| false |
返回参数
示例
正常返回示例
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 | 您的账户还未开通此服务 |
404 | ClusterNotFound | The specified cluster does not exist. | 指定的集群不存在,请您检查该参数是否正确。 |
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授权 |
500 | UnknownError | An unknown error occurred. | 未知错误 |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | 请求失败,服务暂时不可用 |
访问错误中心查看更多错误码。