Updating the Traffic Limiting Rules of a Migration Task
Function
This API is used to update the traffic limiting rules for a migration task before it is completed.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/tasks/{task_id}/bandwidth-policy
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
The project ID. Minimum length: 1 character Maximum length: 1,024 characters |
task_id |
Yes |
String |
The task ID. Minimum length: 1 character Maximum length: 1,024 characters |
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
The token used for IAM authentication. Minimum length: 1 character Maximum length: 16,384 characters |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
bandwidth_policy |
Yes |
Array of BandwidthPolicyDto objects |
The traffic limiting rules. Each element in the array corresponds to the maximum bandwidth in a time period. A maximum of five periods are allowed, and the periods cannot overlap. Array length: 0 to 5 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
end |
Yes |
String |
The end time of the traffic limiting rule. The format is hh:mm, for example, 12:03. |
max_bandwidth |
Yes |
Long |
The maximum traffic bandwidth allowed in the specified time period. The unit is byte/s. The value ranges from 1,048,576 bytes/s (equivalent to 1 MB/s) to 209,715,200 bytes/s (equivalent to 200 MB/s). Minimum value: 1048576 Maximum value: 209715200 |
start |
Yes |
String |
The start time of the traffic limiting rule. The format is hh:mm, for example, 12:03. |
Response
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
The error message. |
error_code |
String |
The error code. |
Example Request
This example sets the migration rate limit for the task whose ID is xxxxxxxx during the time period from 00:01 to 23:59 to 50 MB/s.
/v2/{project_id}/tasks/xxxxxxxx/bandwidth-policy { "bandwidth_policy" : [ { "start" : "00:01", "end" : "23:59", "max_bandwidth" : 50000000 } ] }
Example Response
None
SDK Sample Code
The sample code is as follows:
This example sets the migration rate limit for the task whose ID is xxxxxxxx during the time period from 00:01 to 23:59 to 50 MB/s.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
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.oms.v2.region.OmsRegion; import com.huaweicloud.sdk.oms.v2.*; import com.huaweicloud.sdk.oms.v2.model.*; import java.util.List; import java.util.ArrayList; public class UpdateBandwidthPolicySolution { 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 BasicCredentials() .withAk(ak) .withSk(sk); OmsClient client = OmsClient.newBuilder() .withCredential(auth) .withRegion(OmsRegion.valueOf("<YOUR REGION>")) .build(); UpdateBandwidthPolicyRequest request = new UpdateBandwidthPolicyRequest(); UpdateBandwidthPolicyReq body = new UpdateBandwidthPolicyReq(); List<BandwidthPolicyDto> listbodyBandwidthPolicy = new ArrayList<>(); listbodyBandwidthPolicy.add( new BandwidthPolicyDto() .withEnd("23:59") .withMaxBandwidth(50000000L) .withStart("00:01") ); body.withBandwidthPolicy(listbodyBandwidthPolicy); request.withBody(body); try { UpdateBandwidthPolicyResponse response = client.updateBandwidthPolicy(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()); } } } |
This example sets the migration rate limit for the task whose ID is xxxxxxxx during the time period from 00:01 to 23:59 to 50 MB/s.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkoms.v2.region.oms_region import OmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkoms.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"] credentials = BasicCredentials(ak, sk) client = OmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(OmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateBandwidthPolicyRequest() listBandwidthPolicybody = [ BandwidthPolicyDto( end="23:59", max_bandwidth=50000000, start="00:01" ) ] request.body = UpdateBandwidthPolicyReq( bandwidth_policy=listBandwidthPolicybody ) response = client.update_bandwidth_policy(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
This example sets the migration rate limit for the task whose ID is xxxxxxxx during the time period from 00:01 to 23:59 to 50 MB/s.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" oms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := oms.NewOmsClient( oms.OmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateBandwidthPolicyRequest{} var listBandwidthPolicybody = []model.BandwidthPolicyDto{ { End: "23:59", MaxBandwidth: int64(50000000), Start: "00:01", }, } request.Body = &model.UpdateBandwidthPolicyReq{ BandwidthPolicy: listBandwidthPolicybody, } response, err := client.UpdateBandwidthPolicy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For more SDK sample code of programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot