Starting a Synchronization Task

Function

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

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 length: 1 character Maximum length: 1,024 characters
sync_task_id	Yes	String	The synchronization task ID. Minimum length: 0 characters Maximum length: 255 characters

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The token used for IAM authentication. Minimum length: 1 character Maximum length: 16,384 characters

**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 tasks. Minimum length: 1 character Maximum length: 100 characters
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 tasks. Minimum length: 1 character Maximum length: 100 characters
dst_ak	Yes	String	The AK for accessing the destination node. Enter a maximum of 100 characters. Minimum length: 1 character Maximum length: 100 characters
dst_sk	Yes	String	The SK for accessing the destination node. Enter a maximum of 100 characters. Minimum length: 1 character Maximum length: 100 characters
source_cdn_authentication_key	No	String	The CDN authentication key. Minimum length: 0 characters Maximum length: 255 characters

Response

Status code: 200

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	The error message.
error_code	String	The error code.

Example Request

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"
}