Querying the Migration Rate Limiting Rules of a Migration Task
Function
This API is used to query the time segment-based migration rate limiting rules of a migration task.
Calling Method
For details, see Calling APIs.
URI
GET /v3/tasks/{task_id}/speed-limit
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
task_id |
Yes |
String |
The ID of the task for which you want to query the speed limiting rules Minimum length: 1 character Maximum length: 36 |
Request
|
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. Minimum length: 1 character Maximum length: 16,384 characters |
Response
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
speed_limit |
Array of SpeedLimitlJson objects |
The information about the time period-based speed limiting rules. Array length: 0 to 65,535 |
|
Parameter |
Type |
Description |
|---|---|---|
|
start |
String |
The start time of a period. The format is XX:XX. Minimum length: 0 characters Maximum length: 255 characters |
|
end |
String |
The end time of a period. The format is XX:XX. Minimum length: 0 characters Maximum length: 255 characters |
|
speed |
Integer |
The migration rate limit for the specified period. The value is an integer ranging from 0 to 1000. The unit is Mbit/s. Minimum value: 0 Maximum value: 10000 |
|
over_speed_threshold |
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. Minimum value: 10 Maximum value: 100 |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. Minimum length: 0 characters Maximum length: 255 characters |
|
error_msg |
String |
The error message. Minimum length: 0 characters Maximum length: 255 characters |
|
encoded_authorization_message |
String |
The encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters |
|
error_param |
Array of strings |
Invalid parameters. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20 |
|
details |
Array of details objects |
The error details. Array length: 1 to 20 |
Example Request
This example queries the migration rate limiting rules for a migration task.
GET https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx/speed-limit
Example Response
Status code: 200
The migration rate limiting rules of a migration task were obtained.
{
"speed_limit" : [ {
"start" : "00:00",
"end" : "23:59",
"speed" : 1000,
"over_speed_threshold" : 50.0
} ]
}
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."
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The migration rate limiting rules of a migration task were obtained. |
|
403 |
Authentication failed. |
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.
