# 查询集群任务详情 - ListClusterActions #### 功能介绍 查询集群任务详情。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dws/dws_02_0062.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dws/dws_02_0056.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dws:cluster:getTaskDetail | Read | cluster \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - | #### URI GET /v1/{project_id}/clusters/{cluster_id}/actions/{action_name} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dws/dws_02_0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | cluster_id | 是 | String | **参数解释**： 集群ID。获取方法请参见[获取集群ID](https://support.huaweicloud.com/api-dws/dws_02_00068.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | action_name | 是 | String | **参数解释**： 任务名称。当前仅部分任务在操作中阶段支持查看任务详情。 **约束限制**： 不涉及。 **取值范围**： - GROWING：扩容中。 - RESIZE_FAILURE：扩容失败。 - RESTORING：恢复中。 - RESTORING_FAILED：恢复失败。 - SNAPSHOTTING：快照中。 - SNAPSHOTTING_FAILED：快照失败。 - FINE_GRAINED_RESTORING：细粒度恢复中。 - FINE_GRAINED_RESTORING_FAILED：细粒度恢复失败。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 任务详情响应体。 **取值范围**： 随机生成的UUID。 | | action_name | String | **参数解释**： 任务名称，同入参字段。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 任务状态。 **取值范围**： - SUCCESS：成功。 - RUNNING：运行中。 - WAITING：等待中。 - FAILED：失败。 - ROLLBACK_RUNNING：回滚运行中。 - ROLLBACK_SUCCESS：回滚成功。 - ROLLBACK_FAIL：回滚失败。 | | cluster_name | String | **参数解释**： 集群名称。 **取值范围**： 不涉及。 | | submit_time | String | **参数解释**： 任务提交时间。 **取值范围**： yyyy-MM-dd HH:mm:ss格式的时间字符串。 | | items | Array of [ActionItemVo] objects | **参数解释**： 任务详情子项。 **取值范围**： 不涉及。 | 表3ActionItemVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | item_name | String | **参数解释**： 任务详情子项，一级菜单。 **取值范围**： 不涉及。 | | sub_items | Array of [ActionSubItemVo] objects | **参数解释**： 任务详情子项，一级菜单详情。 **取值范围**： 不涉及。 | 表4ActionSubItemVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**： 状态。 **取值范围**： - SUCCESS：成功。 - RUNNING：运行中。 - WAITING：等待中。 - FAILED：失败。 - ROLLBACK_RUNNING：回滚运行中。 - ROLLBACK_SUCCESS：回滚成功。 - ROLLBACK_FAIL：回滚失败。 | | detail | String | **参数解释**： 扩展信息。 **取值范围**： 不涉及。 | | sub_item_name | String | **参数解释**： 子项名称，根据请求header中的x-language字段返回对应的中/英文名称。 **取值范围**： 不涉及。 | | begin_time | String | **参数解释**： 开始时间。 **取值范围**： yyyy-MM-dd HH:mm:ss.S格式的时间字符串，或null表示尚未开始。 | | end_time | String | **参数解释**： 结束时间。 **取值范围**： yyyy-MM-dd HH:mm:ss.S格式的时间字符串，或null表示尚未结束。 | | estimated_time | Integer | **参数解释**： 预估时间。 **取值范围**： 不涉及。 | #### 请求示例 查询快照失败的任务详情。 ``` get https://{Endpoint}/v1/05f2cff45100d5112f4bc00b794ea08e/clusters/9f76c502-fc9c-4a52-8656-65d0da6e3d57/actions/SNAPSHOTTING_FAILED ``` #### 响应示例 **状态码：200** ``` { "id" : "abb30649-4ab5-448f-a199-f764d2a4271d", "status" : "FAILED", "items" : [ { "item_name" : "创建快照", "sub_items" : [ { "status" : "FAILED", "detail" : "{\"progressInfo\":\"{\\\"actionEndTime\\\":\\\"2025-05-19 09:07:42\\\",\\\"failedStep\\\":\\\"INIT\\\",\\\"partialPassKeys\\\":\\\"N/A\\\",\\\"errorCode\\\":\\\"\\\",\\\"updateTime\\\":\\\"2025-05-19 09:07:43\\\",\\\"errorMsg\\\":\\\"host-172-16-13-211 SUCCESS host-172-16-47-24 SUCCESS host-172-16-19-132 SUCCESS \\\",\\\"backupSize\\\":157661926,\\\"backupRate\\\":{\\\"compressRate\\\":\\\"0MB/s\\\",\\\"consumerRate\\\":\\\"0MB/s\\\",\\\"producerRate\\\":\\\"0MB/s\\\"},\\\"currentStep\\\":\\\"FINISH\\\",\\\"actionType\\\":\\\"Backup\\\",\\\"unrestoreKeys\\\":\\\"N/A\\\",\\\"progress\\\":\\\"100.00%\\\",\\\"actionStartTime\\\":\\\"2025-05-19 09:07:28\\\",\\\"priorKey\\\":\\\"N/A\\\",\\\"key\\\":\\\"20250519_090729\\\"}\"}", "sub_item_name" : "执行备份", "begin_time" : "2025-05-19 09:06:18", "end_time" : "2025-05-19 10:06:08", "estimated_time" : -1 } ] } ], "action_name" : "SNAPSHOTTING_FAILED", "cluster_name" : "cluster_779", "submit_time" : "2025-05-19 09:05:10" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dws.v2.region.DwsRegion; import com.huaweicloud.sdk.dws.v2.*; import com.huaweicloud.sdk.dws.v2.model.*; public class ListClusterActionsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DwsClient client = DwsClient.newBuilder() .withCredential(auth) .withRegion(DwsRegion.valueOf("")) .build(); ListClusterActionsRequest request = new ListClusterActionsRequest(); request.withClusterId("{cluster_id}"); request.withActionName("{action_name}"); try { ListClusterActionsResponse response = client.listClusterActions(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdws.v2.region.dws_region import DwsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdws.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DwsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DwsRegion.value_of("")) \ .build() try: request = ListClusterActionsRequest() request.cluster_id = "{cluster_id}" request.action_name = "{action_name}" response = client.list_cluster_actions(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dws.DwsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dws.NewDwsClient(hcClient) request := &model.ListClusterActionsRequest{} request.ClusterId = "{cluster_id}" request.ActionName = "{action_name}" response, err := client.ListClusterActions(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DWS/sdk?api=ListClusterActions)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | | 400 | 请求错误。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 500 | 服务内部错误。 | | 503 | 服务不可用。 |