Update 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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	The project ID. Minimum: 1 Maximum: 1024
task_id	Yes	Long	The task ID. Minimum: 0 Maximum: 999999999999999

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The token used for IAM authentication. Minimum: 1 Maximum: 16384

**Table 3** Request body parameters
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 - 5

**Table 4** BandwidthPolicyDto
Parameter	Mandatory	Type	Description
end	Yes	String	The time when traffic limiting ends, in the format of hh:mm, for example, 12:03. This time must be later than and on the same day as the start time. Cross-day settings are not supported.
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: 1048576 Maximum: 209715200
start	Yes	String	The time when traffic limiting starts, in the format of hh:mm, for example, 12:03. This time must be earlier than and on the same day as the end time. Cross-day settings are not supported.

Response Parameters

Status code: 200

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Error message.
error_code	String	Error code.

Example Requests

This example updates the traffic limiting rule of task xxxxxxxx by setting start to 00:01, end to 23:59, and max_bandwidth to 50 MB/s.

/v2/{project_id}/tasks/xxxxxxxx/bandwidth-policy

{
  "bandwidth_policy" : [ {
    "start" : "00:01",
    "end" : "23:59",
    "max_bandwidth" : 50000000
  } ]
}