# 设置迁移限速规则 - UpdateSpeed #### 功能介绍 设置迁移任务的迁移速率。 #### 调用方法 请参见[如何调用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:updateTaskSpeedLimit | Write | server \* | - | sms:server:migrationServer | - | | sms:server:updateTaskSpeedLimit | Write | - | g:EnterpriseProjectId | sms:server:migrationServer | - | #### URI POST /v3/tasks/{task_id}/speed-limit 表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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | speed_limit | 是 | Array of [SpeedLimitlJson] objects | 按时间段限速信息 数组长度：**0 - 5** | 表4SpeedLimitlJson | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start | 是 | String | 时间段开始时间，格式：XX:XX。 最小长度：**0** 最大长度：**255** | | end | 是 | String | 时间段结束时间，格式：XX:XX。 最小长度：**0** 最大长度：**255** | | speed | 否 | Integer | 时间段的速率，0-1000的整数，单位：Mbit/s。 最小值：**0** 最大值：**1000** 缺省值：**0** | | over_speed_threshold | 否 | Double | 停止迁移的超速阈值。 是一个迁移速率的保护机制，超出该阈值会停止任务。它主要用于控制迁移过程中资源（特别是网络带宽）的消耗，确保系统的整体性能不受单一迁移任务影响 单位是百分比 最小值：**10** 最大值：**100** 缺省值：**10** | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 设置迁移限速规则成功 | **状态码：403** 表6响应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** | 表7details | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | SMS错误代码 最小长度：**0** 最大长度：**65535** | | error_msg | String | SMS错误信息 最小长度：**0** 最大长度：**65535** | #### 请求示例 - 设置迁移任务的迁移速率和停止迁移的阈值速率，0:00到8:00是20M/s，8:00到15:00是50M/s，15:00到23:59是25M/s。 ``` POST https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx/speed-limit { "speed_limit" : [ { "start" : "00:00", "end" : "08:00", "speed" : 20, "over_speed_threshold" : 50 }, { "start" : "08:00", "end" : "15:00", "speed" : 50, "over_speed_threshold" : 50 }, { "start" : "15:00", "end" : "23:59", "speed" : 25, "over_speed_threshold" : 50 } ] } ``` - 更新ID为a45a300b-86b5-4b13-8802-52274fa43016的迁移速率。 ``` POST https://{endpoint}/v3/tasks/a45a300b-86b5-4b13-8802-52274fa43016/speed-limit { "speed_limit" : [ { "start" : "00:00", "end" : "08:00", "speed" : 20 }, { "start" : "08:00", "end" : "15:00", "speed" : 50 }, { "start" : "15:00", "end" : "23:59", "speed" : 25 } ] } ``` #### 响应示例 **状态码：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] - 设置迁移任务的迁移速率和停止迁移的阈值速率，0:00到8:00是20M/s，8:00到15:00是50M/s，15:00到23:59是25M/s。 ``` 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.*; import java.util.List; import java.util.ArrayList; public class UpdateSpeedSolution { 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(); UpdateSpeedRequest request = new UpdateSpeedRequest(); request.withTaskId("{task_id}"); SpeedLimit body = new SpeedLimit(); List listbodySpeedLimit = new ArrayList<>(); listbodySpeedLimit.add( new SpeedLimitlJson() .withStart("00:00") .withEnd("08:00") .withSpeed(20) .withOverSpeedThreshold((double)50) ); listbodySpeedLimit.add( new SpeedLimitlJson() .withStart("08:00") .withEnd("15:00") .withSpeed(50) .withOverSpeedThreshold((double)50) ); listbodySpeedLimit.add( new SpeedLimitlJson() .withStart("15:00") .withEnd("23:59") .withSpeed(25) .withOverSpeedThreshold((double)50) ); body.withSpeedLimit(listbodySpeedLimit); request.withBody(body); try { UpdateSpeedResponse response = client.updateSpeed(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()); } } } ``` - 更新ID为a45a300b-86b5-4b13-8802-52274fa43016的迁移速率。 ``` 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.*; import java.util.List; import java.util.ArrayList; public class UpdateSpeedSolution { 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(); UpdateSpeedRequest request = new UpdateSpeedRequest(); request.withTaskId("{task_id}"); SpeedLimit body = new SpeedLimit(); List listbodySpeedLimit = new ArrayList<>(); listbodySpeedLimit.add( new SpeedLimitlJson() .withStart("00:00") .withEnd("08:00") .withSpeed(20) ); listbodySpeedLimit.add( new SpeedLimitlJson() .withStart("08:00") .withEnd("15:00") .withSpeed(50) ); listbodySpeedLimit.add( new SpeedLimitlJson() .withStart("15:00") .withEnd("23:59") .withSpeed(25) ); body.withSpeedLimit(listbodySpeedLimit); request.withBody(body); try { UpdateSpeedResponse response = client.updateSpeed(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] - 设置迁移任务的迁移速率和停止迁移的阈值速率，0:00到8:00是20M/s，8:00到15:00是50M/s，15:00到23:59是25M/s。 ``` # 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 = UpdateSpeedRequest() request.task_id = "{task_id}" listSpeedLimitbody = [ SpeedLimitlJson( start="00:00", end="08:00", speed=20, over_speed_threshold=50 ), SpeedLimitlJson( start="08:00", end="15:00", speed=50, over_speed_threshold=50 ), SpeedLimitlJson( start="15:00", end="23:59", speed=25, over_speed_threshold=50 ) ] request.body = SpeedLimit( speed_limit=listSpeedLimitbody ) response = client.update_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) ``` - 更新ID为a45a300b-86b5-4b13-8802-52274fa43016的迁移速率。 ``` # 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 = UpdateSpeedRequest() request.task_id = "{task_id}" listSpeedLimitbody = [ SpeedLimitlJson( start="00:00", end="08:00", speed=20 ), SpeedLimitlJson( start="08:00", end="15:00", speed=50 ), SpeedLimitlJson( start="15:00", end="23:59", speed=25 ) ] request.body = SpeedLimit( speed_limit=listSpeedLimitbody ) response = client.update_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] - 设置迁移任务的迁移速率和停止迁移的阈值速率，0:00到8:00是20M/s，8:00到15:00是50M/s，15:00到23:59是25M/s。 ``` 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.UpdateSpeedRequest{} request.TaskId = "{task_id}" speedSpeedLimit:= int32(20) overSpeedThresholdSpeedLimit:= float64(50) speedSpeedLimit1:= int32(50) overSpeedThresholdSpeedLimit1:= float64(50) speedSpeedLimit2:= int32(25) overSpeedThresholdSpeedLimit2:= float64(50) var listSpeedLimitbody = []model.SpeedLimitlJson{ { Start: "00:00", End: "08:00", Speed: &speedSpeedLimit, OverSpeedThreshold: &overSpeedThresholdSpeedLimit, }, { Start: "08:00", End: "15:00", Speed: &speedSpeedLimit1, OverSpeedThreshold: &overSpeedThresholdSpeedLimit1, }, { Start: "15:00", End: "23:59", Speed: &speedSpeedLimit2, OverSpeedThreshold: &overSpeedThresholdSpeedLimit2, }, } request.Body = &model.SpeedLimit{ SpeedLimit: listSpeedLimitbody, } response, err := client.UpdateSpeed(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - 更新ID为a45a300b-86b5-4b13-8802-52274fa43016的迁移速率。 ``` 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.UpdateSpeedRequest{} request.TaskId = "{task_id}" speedSpeedLimit:= int32(20) speedSpeedLimit1:= int32(50) speedSpeedLimit2:= int32(25) var listSpeedLimitbody = []model.SpeedLimitlJson{ { Start: "00:00", End: "08:00", Speed: &speedSpeedLimit, }, { Start: "08:00", End: "15:00", Speed: &speedSpeedLimit1, }, { Start: "15:00", End: "23:59", Speed: &speedSpeedLimit2, }, } request.Body = &model.SpeedLimit{ SpeedLimit: listSpeedLimitbody, } response, err := client.UpdateSpeed(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=UpdateSpeed)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 设置迁移限速规则成功 | | 403 | 鉴权失败 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-sms/ErrorCode.html)。