Modifying Traffic Limiting Rules for a Migration Task Group
Function
This API is used to update the traffic limiting rules for a migration task group before it is completed.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/taskgroups/{group_id}/update
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | The project ID. Minimum length: 1 character Maximum length: 1,024 characters |
| group_id | Yes | String | The task group 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 time when traffic limiting is ended. The format is hh:mm, for example, 12:03. |
| max_bandwidth | Yes | Long | The maximum traffic bandwidth allowed in the specified 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 time when traffic limiting is started. The format is hh:mm, for example, 12:03. |
Response
Status code: 200
Ok
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | The error message. |
| error_code | String | The error code. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | The error message. |
| error_code | String | The error code. |
Example Request
This example updates the migration rate limit to 50 MB/s for the task whose ID is xxxxxxxx from 00:01 to 23:59.
PUT /v2/{project_id}/taskgroup/xxxxxxxx/update
{
"bandwidth_policy" : [ {
"start" : "00:01",
"end" : "23:59",
"max_bandwidth" : 50000000
} ]
} Example Response
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | Ok |
| 400 | Bad request |
| 403 | Forbidden |
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.
