# 查询后台任务详细信息 - ShowBackgroundTaskProgress #### 功能介绍 查询后台任务详细信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dcs/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dcs/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dcs:instance:getBackgroundTask | Read | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}/progress 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dcs/dcs-api-0312045.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。可通过DCS控制台进入实例详情界面查看。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | task_id | 是 | String | **参数解释**： 后台任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | progress | Integer | **参数解释**： 总体进度，单位：%。 **取值范围**： 0-100。 | | remain_time | Integer | **参数解释**： 剩余时间，单位：秒。 **取值范围**： 不涉及。 | | step_details | Array of [StepDetail] objects | **参数解释**： 任务详情列表。 | 表3StepDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | step_id | String | **参数解释**： 后台任务ID。 **取值范围**： 不涉及。 | | step_name | String | **参数解释**： 任务名。 **取值范围**： 不涉及。 | | step_status | String | **参数解释**： 任务状态。 **取值范围**： - FINISH：完成。 - FAILED：失败。 - EXECUTING：执行中。 - WAITING：等待中。 | | begin_time | String | **参数解释**： 任务启动时间，格式为2020-06-17T07:38:42.503Z。 **取值范围**： 不涉及。 | | end_time | String | **参数解释**： 任务结束时间，格式为2020-06-17T07:38:42.503Z。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | sub_step_details | Array of [SubStepDetail] objects | **参数解释**： 子任务详情列表。 | 表4SubStepDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | sub_step_id | String | **参数解释**： 任务ID。 **取值范围**： 不涉及。 | | sub_step_name | String | **参数解释**： 任务名。 **取值范围**： 不涉及。 | | sub_step_status | String | **参数解释**： 任务状态。 **取值范围**： - FINISH：已完成。 - SUSPEND：已暂停。 - EXECUTING：执行中。 - WAITING：等待中。 - CANCELED：已取消。 - FAILED：失败。 | | begin_time | String | **参数解释**： 任务启动时间，格式为2020-06-17T07:38:42.503Z。 **取值范围**： 不涉及。 | | end_time | String | **参数解释**： 任务结束时间，格式为2020-06-17T07:38:42.503Z。 **取值范围**： 不涉及。 | | detail | String | **参数解释**： 子任务的附加属性详情。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | #### 请求示例 ``` GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks/8abf6e1e72c12e7c0172c15b508500aa/progress ``` #### 响应示例 **状态码：200** ``` { "progress" : 30, "remain_time" : 100, "step_details" : [ { "step_id" : "9d1d1da8-650e-406f-81e4-b3c11515869f", "step_name" : "前置检查", "step_status" : "FINISH", "begin_time" : "2022-09-01 11:52:24", "end_time" : "2022-09-01 11:52:29", "error_code" : "DCS.4064", "sub_step_details" : [ { "sub_step_id" : "4692b05b-fa55-4f7d-9be6-527bde25b424", "sub_step_name" : "资源检查", "sub_step_status" : "FINISH", "begin_time" : "2022-09-01 11:52:24", "end_time" : "2022-09-01 11:52:26", "detail" : "", "error_code" : "DCS.4065" }, { "sub_step_id" : "4692b05b-fa55-4f7d-9be6-527bde25b425", "sub_step_name" : "实例状态检查", "sub_step_status" : "FINISH", "begin_time" : "2022-09-01 11:52:26", "end_time" : "2022-09-01 11:52:29", "detail" : "", "error_code" : "DCS.4064" } ] }, { "step_id" : "9d1d1da8-650e-406f-3fad-c4a22515869f", "step_name" : "数据迁移", "step_status" : "EXECUTING", "begin_time" : "2022-09-01 11:52:30", "end_time" : "2022-09-01 11:54:30", "error_code" : "DCS.4065", "sub_step_details" : [ { "sub_step_id" : "cb58a8ea-b8e2-4626-b3fa-57ab1a830724", "sub_step_name" : "申请资源", "sub_step_status" : "FINISH", "begin_time" : "2022-09-01 11:52:30", "end_time" : "2022-09-01 11:53:30", "detail" : "{node_id:9996c3376318417281fb5e611f3fb1a0,slot_range:[0 5460],full_migration:迁移中,inc_migration:迁移中}", "error_code" : "DCS.4065" }, { "sub_step_id" : "f9df7fd2-b31f-4ec3-bbb1-3dc740326342", "sub_step_name" : "申请资源", "sub_step_status" : "FINISH", "begin_time" : "2022-09-01 11:53:30", "end_time" : "2022-09-01 11:54:30", "detail" : "{node_id:5b70f440ccc94789b34a5c98c2ba05ea,slot_range:[5461 10921],full_migration:待开始,inc_migration:待开始}", "error_code" : "DCS.4066" } ] } ] } ``` #### 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.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class ShowBackgroundTaskProgressSolution { 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); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("")) .build(); ShowBackgroundTaskProgressRequest request = new ShowBackgroundTaskProgressRequest(); request.withInstanceId("{instance_id}"); request.withTaskId("{task_id}"); try { ShowBackgroundTaskProgressResponse response = client.showBackgroundTaskProgress(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 huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.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 = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("")) \ .build() try: request = ShowBackgroundTaskProgressRequest() request.instance_id = "{instance_id}" request.task_id = "{task_id}" response = client.show_background_task_progress(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" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/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 := dcs.DcsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dcs.NewDcsClient(hcClient) request := &model.ShowBackgroundTaskProgressRequest{} request.InstanceId = "{instance_id}" request.TaskId = "{task_id}" response, err := client.ShowBackgroundTaskProgress(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DCS/sdk?api=ShowBackgroundTaskProgress&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询后台任务详情成功。 | | 400 | 非法请求。 | | 401 | 认证信息非法。 | | 403 | 请求被拒绝访问。 | | 404 | 所请求的资源不存在。 | | 500 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。