Updated on 2026-06-30 GMT+08:00

Start a Synchronization Task

Function

This API is used to start a paused synchronization task. This API is only available in CN North-Beijing4, CN East-Shanghai1, and CN Southwest-Guiyang1.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/sync-tasks/{sync_task_id}/start

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

Minimum: 1

Maximum: 1024

sync_task_id

Yes

String

The synchronization task ID.

Minimum: 0

Maximum: 255

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

src_ak

Yes

String

The AK for accessing the source node. Enter a maximum of 100 characters. This parameter is not required for URL list–based migration task groups.

Minimum: 1

Maximum: 100

src_sk

Yes

String

The SK for accessing the source node. Enter a maximum of 100 characters. This parameter is not required for URL list–based migration task groups.

Minimum: 1

Maximum: 100

src_crypto_type

No

String

The encryption/decryption type. The default value is DEFAULT. The options are DEFAULT and KMS.

Default: DEFAULT

Minimum: 1

Maximum: 32

Enumeration values:

  • DEFAULT

  • KMS

src_kms_key_id

No

String

The KMS key ID, which contains 36 characters.

Minimum: 0

Maximum: 36

dst_ak

Yes

String

The AK for accessing the destination node. Enter a maximum of 100 characters.

Minimum: 1

Maximum: 100

dst_sk

Yes

String

The SK for accessing the destination node. Enter a maximum of 100 characters.

Minimum: 1

Maximum: 100

dst_crypto_type

No

String

The encryption/decryption type. The default value is DEFAULT. The options are DEFAULT and KMS.

Default: DEFAULT

Minimum: 1

Maximum: 32

Enumeration values:

  • DEFAULT

  • KMS

dst_kms_key_id

No

String

The KMS key ID, which contains 36 characters.

Minimum: 0

Maximum: 36

source_cdn_authentication_key

No

String

The CDN authentication key.

Minimum: 0

Maximum: 255

source_cdn_crypto_type

No

String

The encryption/decryption type. The default value is DEFAULT. The options are DEFAULT and KMS.

Default: DEFAULT

Minimum: 1

Maximum: 32

Enumeration values:

  • DEFAULT

  • KMS

source_cdn_kms_key_id

No

String

The KMS key ID, which contains 36 characters.

Minimum: 0

Maximum: 36

Response Parameters

Status code: 200

OK

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

This example starts a synchronization task.

POST https://{endpoint}/v2/{project_id}/sync-tasks/{sync_task_id}/start

{
  "src_ak" : "src_ak",
  "src_sk" : "src_sk",
  "dst_ak" : "dst_ak",
  "dst_sk" : "dst_sk"
}

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.