Help Center/ Data Replication Service/ API Reference/ APIs V3.0 (Deprecated)/ Public API Management/ Setting Flow Control for Tasks
Updated on 2024-10-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Setting Flow Control for Tasks

Function

This API is used to enable or disable flow control for tasks. By default, the migration speed is not limited after a task is created.

  • You can customize the maximum migration speed.
  • If the migration speed is not limited, the outbound bandwidth of the source database is maximally used, which causes read consumption on the source database accordingly. For example, if the outbound bandwidth of the source database is 100 MB/s and 80% bandwidth is used, the I/O consumption on the source database is 80 MB/s.

Debugging

You can debug the API in API Explorer to support automatic authentication. API Explorer can automatically generate and debug example SDK code.

Constraints

  • You can set the time range based on your service requirements. Flow can be controlled all day or during specific time ranges. The default value is All day.
  • A maximum of ten time ranges can be set, and they cannot overlap.
  • The start time cannot be the same as the end time.
  • If the start time is 16:00 and the end time is 15:59, the bandwidth is limited for the whole day.
  • If speed_limit is set to [], the speed is not limited.
  • The minute in the start time is ignored. The end time must be ended with 59. For example, 03:59 is equivalent to 04:00 (UTC) and the hour is a two-digit number.
  • In the dual-active DR scenario, the parent task cannot call the API.
  • This API cannot be used when the task mode is INCR_TRANS.

URI

PUT /v3/{project_id}/jobs/batch-limit-speed

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

The content type.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

X-Language

No

String

Request language type

Default value: en-us

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

speed_limits

Yes

Array of objects

Speed limit in DR.

For details, see Table 4.
Table 4 Data structure description of field speed_limits

Parameter

Mandatory

Type

Description

job_id

Yes

String

Task ID.

speed_limit

Yes

Array of objects

Request body of flow control information.

For details, see Table 5.
Table 5 Data structure description of field speed_limit

Parameter

Mandatory

Type

Description

begin

Yes

String

Start time (UTC) of flow control. The start time is an integer in hh:mm format and the minutes part is ignored. hh indicates the hour, for example, 01:00.

end

Yes

String

End time (UTC) in the format of hh:mm, for example, 15:59. The value must end with 59.

speed

Yes

String

Speed. The value ranges from 1 to 9,999, in MB/s.

is_utc

No

Boolean

Whether the UTC time is used.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

count

Integer

Total number.

results

Array of objects

List of tasks that are modified in batches.

For details, see Table 7.
Table 7 Data structure description of field results

Parameter

Type

Description

id

String

Task ID.

status

String

Status Values:

  • success: The task is successful.
  • failed: The task fails.

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Set flow control for DR tasks in batches, in which speed is set to 15 MB/s

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-limit-speed

{
  "speed_limits" : [ {
    "job_id" : "7d0504f1-aba3-435f-914f-936b861jb502",
    "speed_limit" : [ {
      "begin" : "16:00",
      "end" : "15:59",
      "speed" : "15"
    } ]
  } ]
}

Example Response

Status code: 200

OK

{
  "results" : [ {
    "id" : "efa2bd29-8780-494f-a2ee-188b003ejb11",
    "status" : "success"
  } ],
  "count" : 1
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Public API Management