Help Center/ Server Migration Service/ API Reference/ API/ Task Management/ Setting Migration Rate Limiting Rules for a Migration Task

Updated on 2025-11-11 GMT+08:00

Online Debugging

CLI Examples

View PDF

Setting Migration Rate Limiting Rules for a Migration Task

Function

This API is used to set migration rate limiting rules for a migration task.

Calling Method

For details, see Calling APIs.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the permission listed below is required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	The migration task ID.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	X-Auth-Token The user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
speed_limit	Yes	Array of SpeedLimitlJson objects	The information about the time period-based speed limiting rules.

**Table 4** **SpeedLimitlJson** field description
Parameter	Mandatory	Type	Description
start	Yes	String	The start time of a period. The format is XX:XX.
end	Yes	String	The end time of a period. The format is XX:XX.
speed	Yes	Integer	The migration rate limit for the specified period. The value is an integer ranging from 0 to 1000. The unit is Mbit/s. Range 0 to 10000
over_speed_threshold	No	Double	The overspeed threshold for stopping migration. This is a protection measure. If the migration rate exceeds the threshold, the task is stopped. It is used to control the consumption of resources (especially network bandwidth) during the migration to ensure that the overall system performance is not affected by a single migration task. The unit is percentage. Range 10 to 100

Response

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
-	String	Setting migration rate limiting rules for a migration task succeeded.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	The error code.
error_msg	String	The error message.
encoded_authorization_message	String	The encrypted authorization information.
error_param	Array of strings	Invalid parameters.
details	Array of details objects	The error details.

**Table 7** **details** field description
Parameter	Type	Description
error_code	String	The SMS error code.
error_msg	String	The SMS error message.

Example Request

This example limits the speed of a migration task to 20 Mbit/s from 0:00 to 8:00, 50 Mbit/s from 8:00 to 15:00, and 25 Mbit/s from 15:00 to 23:59. It also sets an overspeed threshold for the task.

POST https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx/speed-limit

{
  "speed_limit" : [ {
    "start" : "00:00",
    "end" : "23:59",
    "speed" : 1000,
    "over_speed_threshold" : 50.0
  } ]
}

This example updates the migration rate limiting rules for the task whose ID is a45a300b-86b5-4b13-8802-52274fa43016.

POST https://{endpoint}/v3/tasks/a45a300b-86b5-4b13-8802-52274fa43016/speed-limit

{
  "speed_limit" : [ {
    "start" : "0:00",
    "end" : "8:00",
    "speed" : 20
  }, {
    "start" : "8:00",
    "end" : "15:00",
    "speed" : 50
  }, {
    "start" : "15:00",
    "end" : "23:59",
    "speed" : 25
  } ]
}

Example Response

Status code: 200

Setting migration rate limiting rules for a migration task succeeded.

{ }

Status code: 403

Authentication failed.

{
  "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 Sample Code

The sample code is as follows.

This example limits the speed of a migration task to 20 Mbit/s from 0:00 to 8:00, 50 Mbit/s from 8:00 to 15:00, and 25 Mbit/s from 15:00 to 23:59. It also sets an overspeed threshold for the task.

        
         
           
           
             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("<YOUR REGION>"))
                .build();
        UpdateSpeedRequest request = new UpdateSpeedRequest();
        request.withTaskId("{task_id}");
        SpeedLimit body = new SpeedLimit();
        List<SpeedLimitlJson> listbodySpeedLimit = new ArrayList<>();
        listbodySpeedLimit.add(
            new SpeedLimitlJson()
                .withStart("00:00")
                .withEnd("23:59")
                .withSpeed(1000)
                .withOverSpeedThreshold((double)50.0)
        );
        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());
        }
    }
}

            

          

        
       

This example updates the migration rate limiting rules for the task whose ID is 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("<YOUR REGION>"))
                .build();
        UpdateSpeedRequest request = new UpdateSpeedRequest();
        request.withTaskId("{task_id}");
        SpeedLimit body = new SpeedLimit();
        List<SpeedLimitlJson> listbodySpeedLimit = new ArrayList<>();
        listbodySpeedLimit.add(
            new SpeedLimitlJson()
                .withStart("0:00")
                .withEnd("8:00")
                .withSpeed(20)
        );
        listbodySpeedLimit.add(
            new SpeedLimitlJson()
                .withStart("8: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());
        }
    }
}

            

          

        
       

This example limits the speed of a migration task to 20 Mbit/s from 0:00 to 8:00, 50 Mbit/s from 8:00 to 15:00, and 25 Mbit/s from 15:00 to 23:59. It also sets an overspeed threshold for the task.

        
         
           
           
             # 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("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateSpeedRequest()
        request.task_id = "{task_id}"
        listSpeedLimitbody = [
            SpeedLimitlJson(
                start="00:00",
                end="23:59",
                speed=1000,
                over_speed_threshold=50.0
            )
        ]
        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)

            

          

        
       

This example updates the migration rate limiting rules for the task whose ID is 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("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateSpeedRequest()
        request.task_id = "{task_id}"
        listSpeedLimitbody = [
            SpeedLimitlJson(
                start="0:00",
                end="8:00",
                speed=20
            ),
            SpeedLimitlJson(
                start="8: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)

            

          

        
       

This example limits the speed of a migration task to 20 Mbit/s from 0:00 to 8:00, 50 Mbit/s from 8:00 to 15:00, and 25 Mbit/s from 15:00 to 23:59. It also sets an overspeed threshold for the task.

        
         
           
           
             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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := sms.NewSmsClient(
        sms.SmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateSpeedRequest{}
	request.TaskId = "{task_id}"
	overSpeedThresholdSpeedLimit:= float64(50.0)
	var listSpeedLimitbody = []model.SpeedLimitlJson{
        {
            Start: "00:00",
            End: "23:59",
            Speed: int32(1000),
            OverSpeedThreshold: &overSpeedThresholdSpeedLimit,
        },
    }
	request.Body = &model.SpeedLimit{
		SpeedLimit: listSpeedLimitbody,
	}
	response, err := client.UpdateSpeed(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

This example updates the migration rate limiting rules for the task whose ID is 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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := sms.NewSmsClient(
        sms.SmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateSpeedRequest{}
	request.TaskId = "{task_id}"
	var listSpeedLimitbody = []model.SpeedLimitlJson{
        {
            Start: "0:00",
            End: "8:00",
            Speed: int32(20),
        },
        {
            Start: "8:00",
            End: "15:00",
            Speed: int32(50),
        },
        {
            Start: "15:00",
            End: "23:59",
            Speed: int32(25),
        },
    }
	request.Body = &model.SpeedLimit{
		SpeedLimit: listSpeedLimitbody,
	}
	response, err := client.UpdateSpeed(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

For SDK code examples in more programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.