Help Center/ Object Storage Migration Service/ API Reference/ APIs V2 (Recommended)/ Migration Task Management/ Updating Tasks in Batches
Updated on 2025-12-04 GMT+08:00
View PDF

Updating Tasks in Batches

Function

This API is used to update migration tasks in batches. You can update all migration tasks in a migration task group or update migration tasks with specified IDs.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/tasks/batch-update

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

Minimum length: 1 character

Maximum length: 1,024 characters

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The IAM token authentication. Ensure that the project ID in the token matches the project ID in the request URI.

Minimum length: 1 character

Maximum length: 16,384 characters
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

group_id

No

String

The ID of the migration task group. All tasks in the task group will be updated.

Either group_id or ids must be specified.

Minimum length: 1 character

Maximum length: 36 characters

ids

No

Array of longs

The array of IDs of all tasks to be updated in batches.

Either group_id or ids must be specified.

Minimum value: 0

Maximum value: 9223372036854775807

Array length: 0 to 20

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

task_priority

No

String

The task priority. There are three priority levels: high, medium, and low. This setting can only be modified for tasks that are waiting, suspended, or failed.

HIGH: high priority

MEDIUM: medium priority

LOW: low priority

Enumerated values:

  • HIGH

  • MEDIUM

  • LOW
Table 4 BandwidthPolicyDto

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. Batch update succeeded.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

The error message.

error_code

String

The error code.

Example Request

  • This example updates the traffic limiting rules for tasks in the task group with the ID xxxxxxxx by setting start to 00:01, end to 23:59, and max_bandwidth to 50000000.

    /v2/{project_id}/tasks/batch-update

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

  • This example updates the traffic limiting rules for tasks with IDs 111 and 222 by setting start to 00:01, end to 23:59, and max_bandwidth to 50000000.

    /v2/{project_id}/tasks/batch-update

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

Example Response

None

Status Codes

Status Code

Description

200

OK. Batch update succeeded.

400

Bad request. Invalid parameters.

Error Codes

For details, see Error Codes.

Parent Topic: Migration Task Management