Querying the Migration Rate Limit Rules of a Migration Task
Function
This API is used to query the time segment-based migration rate rules of a migration task.
URI
GET /v3/tasks/{task_id}/speed-limit
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
task_id |
Yes |
String |
ID of the task for which you want to query the rate limit rules Minimum length: 0 characters Maximum length: 255 characters |
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 character Maximum length: 16,384 characters |
Response
Status code: 200
Parameter |
Type |
Description |
---|---|---|
speed_limit |
Array of SpeedLimitlJson objects |
Specifies the information about the time segments when the migration rate is limited. |
Parameter |
Type |
Description |
---|---|---|
start |
String |
Specifies the start time of a segment. The format is XX:XX. Minimum length: 0 characters Maximum length: 255 characters |
end |
String |
Specifies the end time of a segment. The format is XX:XX. Minimum length: 0 characters Maximum length: 255 characters |
speed |
Integer |
Specifies the migration rate during a specified period of time. The value is an integer ranging from 0 to 1000. The unit is Mbit/s. Minimum value: 0 Maximum value: 10000 |
Example Request
Query the migration rate limit rules of the task whose ID is 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.
GET https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx/speed-limit
Example Response
Status code: 200
OK
{ "speed_limit" : [ { "start" : "00:00", "end" : "23:59", "speed" : 0 } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
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