# 上报数据迁移进度和速率 - UpdateTaskSpeed #### 功能介绍 此接口由安装在源端服务器上的迁移Agent在数据迁移阶段调用，用来将迁移的具体进度上报给SMS服务端。 迁移Agent自动调用此接口用于上报数据迁移进度，您无需调用此接口。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-sms/sms_api_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-sms/sms_api_8001.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | sms:server:updateTaskProgress | Write | server \* | - | sms:server:migrationServer | - | | sms:server:updateTaskProgress | Write | - | g:EnterpriseProjectId | sms:server:migrationServer | - | #### URI PUT /v3/tasks/{task_id}/progress 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_id | 是 | String | 主机迁移任务的ID 最小长度：**1** 最大长度：**36** | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | X-Auth-Token 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：**1** 最大长度：**16384** | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | subtask_name | 是 | String | 当前上报进度的子任务名称，子任务名称包括： 创建虚拟机 CREATE_CLOUD_SERVER 配置安全通道 SSL_CONFIG 挂载代理镜像 ATTACH_AGENT_IMAGE 卸载代理镜像 DETTACH_AGENT_IMAGE Linux分区格式化 FORMAT_DISK_LINUX Linux分区格式化(文件级） FORMAT_DISK_LINUX_FILE Linux分区格式化(块级） FORMAT_DISK_LINUX_BLOCK Windows分区格式化 FORMAT_DISK_WINDOWS Linux文件级数据迁移 MIGRATE_LINUX_FILE, Linux块级数据迁移 MIGRATE_LINUX_BLOCK Windows块级数据迁移 MIGRATE_WINDOWS_BLOCK 克隆一个虚拟机 CLONE_VM Linux文件级数据同步 SYNC_LINUX_FILE Linux块级数据同步 SYNC_LINUX_BLOCK Windows块级数据同步 SYNC_WINDOWS_BLOCK Linux配置修改 CONFIGURE_LINUX Linux配置修改(块级）CONFIGURE_LINUX_BLOCK Linux配置修改（文件级） CONFIGURE_LINUX_FILE Windows配置修改 CONFIGURE_WINDOWS 最小长度：**0** 最大长度：**255** 枚举值： - **CREATE_CLOUD_SERVER** - **SSL_CONFIG** - **ATTACH_AGENT_IMAGE** - **DETTACH_AGENT_IMAGE** - **FORMAT_DISK_LINUX** - **FORMAT_DISK_LINUX_FILE** - **FORMAT_DISK_LINUX_BLOCK** - **FORMAT_DISK_WINDOWS** - **MIGRATE_LINUX_FILE** - **MIGRATE_LINUX_BLOCK** - **MIGRATE_WINDOWS_BLOCK** - **CLONE_VM** - **SYNC_LINUX_FILE** - **SYNC_LINUX_BLOCK** - **SYNC_WINDOWS_BLOCK** - **CONFIGURE_LINUX** - **CONFIGURE_LINUX_BLOCK** - **CONFIGURE_LINUX_FILE** - **CONFIGURE_WINDOWS** | | progress | 是 | Integer | 当前上报的子任务的最新百分比进度 最小值：**0** 最大值：**100** | | replicatesize | 是 | Long | 当前任务已经复制的数据量大小（B） 最小值：**0** 最大值：**9223372036854775807** | | totalsize | 是 | Long | 当前任务的总迁移数据大小 最小值：**0** 最大值：**9223372036854775807** | | process_trace | 是 | String | 迁移或同步时，具体的迁移详情 最小长度：**0** 最大长度：**2048** | | migrate_speed | 否 | Double | 实施迁移速率，单位Mbit/s 最小值：**0** 最大值：**10000** | | compress_rate | 否 | Double | 实施文件压缩率 最小值：**0** 最大值：**10000** | | remain_time | 否 | Long | 剩余时间 最小值：**0** 最大值：**2147483647** | | total_cpu_usage | 否 | Double | 主机的CPU使用率，0到100，单位是百分比 最小值：**0** 最大值：**100** | | agent_cpu_usage | 否 | Double | Agent的CPU使用率，0到100，单位是百分比 最小值：**0** 最大值：**100** | | total_mem_usage | 否 | Double | 主机的内存使用值，单位是MB 最小值：**0** 最大值：**1048576.0** | | agent_mem_usage | 否 | Double | Agent的内存使用值，单位是MB 最小值：**0** 最大值：**1048576.0** | | total_disk_io | 否 | Double | 主机的磁盘I/O值，单位是Mbit/s 最小值：**0** 最大值：**10000.0** | | agent_disk_io | 否 | Double | Agent的磁盘I/O值，单位是Mbit/s 最小值：**0** 最大值：**10000.0** | | need_migration_test | 否 | Boolean | 是否开启迁移演练 | | agent_time | 否 | String | Agent的当前时间，用于超速检测，因为限速值是可以分时间段设置的 最小长度：**0** 最大长度：**30** | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 上报数据迁移进度和速率成功 | **状态码：403** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误代码 最小长度：**0** 最大长度：**255** | | error_msg | String | 错误信息 最小长度：**0** 最大长度：**255** | | encoded_authorization_message | String | 加密授权信息 最小长度：**0** 最大长度：**65535** | | error_param | Array of strings | 错误参数 最小长度：**0** 最大长度：**65535** 数组长度：**1 - 20** | | details | Array of [details] objects | 详细错误信息 数组长度：**1 - 20** | 表6details | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | SMS错误代码 最小长度：**0** 最大长度：**65535** | | error_msg | String | SMS错误信息 最小长度：**0** 最大长度：**65535** | #### 请求示例 上报具体的数据迁移进度，当前的子任务名称是ATTACH_AGENT_IMAGE，任务进度为100，当前任务总迁移数据大小为10000. ``` PUT https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx/progress { "subtask_name" : "ATTACH_AGENT_IMAGE", "progress" : 100, "replicatesize" : 1000, "totalsize" : 100000, "process_trace" : "" } ``` #### 响应示例 **状态码：200** 上报数据迁移进度和速率成功 ``` { } ``` **状态码：403** 鉴权失败 ``` { "error_code" : "SMS.9004", "error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.", "encoded_authorization_message" : "XXXXXX", "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ], "details" : [ { "error_code" : "SMS.9004", "error_msg" : "You do not have permission to perform action XXX on resource XXX." } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 上报具体的数据迁移进度，当前的子任务名称是ATTACH_AGENT_IMAGE，任务进度为100，当前任务总迁移数据大小为10000. ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.sms.v3.region.SmsRegion; import com.huaweicloud.sdk.sms.v3.*; import com.huaweicloud.sdk.sms.v3.model.*; public class UpdateTaskSpeedSolution { 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"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); SmsClient client = SmsClient.newBuilder() .withCredential(auth) .withRegion(SmsRegion.valueOf("")) .build(); UpdateTaskSpeedRequest request = new UpdateTaskSpeedRequest(); request.withTaskId("{task_id}"); UpdateTaskSpeedReq body = new UpdateTaskSpeedReq(); body.withProcessTrace(""); body.withTotalsize(100000L); body.withReplicatesize(1000L); body.withProgress(100); body.withSubtaskName(UpdateTaskSpeedReq.UpdateTaskSpeedReq.fromValue("ATTACH_AGENT_IMAGE")); request.withBody(body); try { UpdateTaskSpeedResponse response = client.updateTaskSpeed(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] 上报具体的数据迁移进度，当前的子任务名称是ATTACH_AGENT_IMAGE，任务进度为100，当前任务总迁移数据大小为10000. ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdksms.v3.region.sms_region import SmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksms.v3 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"] credentials = GlobalCredentials(ak, sk) client = SmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(SmsRegion.value_of("")) \ .build() try: request = UpdateTaskSpeedRequest() request.task_id = "{task_id}" request.body = UpdateTaskSpeedReq( process_trace="", totalsize=100000, replicatesize=1000, progress=100, subtask_name="ATTACH_AGENT_IMAGE" ) response = client.update_task_speed(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] 上报具体的数据迁移进度，当前的子任务名称是ATTACH_AGENT_IMAGE，任务进度为100，当前任务总迁移数据大小为10000. ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/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") auth, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := sms.SmsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := sms.NewSmsClient(hcClient) request := &model.UpdateTaskSpeedRequest{} request.TaskId = "{task_id}" request.Body = &model.UpdateTaskSpeedReq{ ProcessTrace: "", Totalsize: int64(100000), Replicatesize: int64(1000), Progress: int32(100), SubtaskName: model.GetUpdateTaskSpeedReqSubtaskNameEnum().ATTACH_AGENT_IMAGE, } response, err := client.UpdateTaskSpeed(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SMS/sdk?api=UpdateTaskSpeed)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 上报数据迁移进度和速率成功 | | 403 | 鉴权失败 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-sms/ErrorCode.html)。