Help Center/ Object Storage Migration Service/ API Reference/ APIs V2/ Synchronization Task/ Create a Synchronization Task
Updated on 2026-06-30 GMT+08:00
View PDF

Create a Synchronization Task

Function

This API is used to create a synchronization task. After the synchronization task is created, it will be automatically started.

Constraints

  • A tenant can create a maximum of five synchronization tasks.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/sync-tasks

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

Minimum: 1

Maximum: 1024

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_cloud_type

No

String

The source cloud service provider.The value can be AWS, Azure, Aliyun, Tencent, HuaweiCloud, QingCloud, KingsoftCloud, Baidu, Qiniu, or UCloud. The default value is Aliyun.

Default: Aliyun

src_region

Yes

String

The region where the source bucket is located.

Minimum: 0

Maximum: 100

src_bucket

Yes

String

The name of the source bucket.

Minimum: 0

Maximum: 1024

src_ak

Yes

String

The AK for accessing the source bucket. Enter a maximum of 100 characters.

Minimum: 0

Maximum: 100

src_sk

Yes

String

The SK for accessing the source bucket. Enter a maximum of 100 characters.

Minimum: 0

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 bucket. Enter a maximum of 100 characters.

Minimum: 0

Maximum: 100

dst_sk

Yes

String

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

Minimum: 0

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

dst_region

Yes

String

The region where the destination bucket is located.

Minimum: 0

Maximum: 100

dst_bucket

Yes

String

The name of the destination bucket.

Minimum: 0

Maximum: 1024

description

No

String

The task description, which cannot exceed 255 characters. The following special characters are not allowed: <>()"'&

Minimum: 0

Maximum: 255

enable_metadata_migration

No

Boolean

Whether metadata migration is enabled. This function is disabled by default. Even if this function is disabled, the Content-Type metadata will still be migrated to ensure a successful migration.

Default: false

enable_restore

No

Boolean

Whether automatic restoration of archived data is enabled. This function is disabled by default.

If this function is enabled, archived data is automatically restored and migrated.

Default: false

dst_storage_policy

No

String

The destination storage class. This parameter is required only when the destination is Huawei Cloud OBS. The default value is STANDARD.

STANDARD: Huawei Cloud OBS Standard storage

IA: Huawei Cloud OBS Infrequent Access storage

ARCHIVE: Huawei Cloud OBS Archive storage

DEEP_ARCHIVE: Huawei Cloud OBS Deep Archive storage

SRC_STORAGE_MAPPING: The source storage class is retained and mapped to Huawei Cloud OBS storage class.

Default: STANDARD

Minimum: 0

Maximum: 128

Enumeration values:

  • STANDARD

  • IA

  • ARCHIVE

  • DEEP_ARCHIVE

  • SRC_STORAGE_MAPPING

app_id

No

String

Tencent Cloud app ID. This parameter is mandatory when cloud_type is Tencent. You can obtain the value from the account information page on the Tencent Cloud console.

Minimum: 0

Maximum: 255

source_cdn

No

SourceCdnReq object

Whether migration from CDN is enabled. If this field is included, migration from CDN is supported. Otherwise, it is not supported. If migration from CDN is enabled, the source objects to be migrated are obtained from the specified CDN domain name during migration.

consistency_check

No

String

The method for checking whether objects are consistent before and after migration. The encryption status of the source and destination objects must be the same. The check method and results will be recorded in the object list. The default value is size_last_modified.size_last_modified: The default value. The system checks object consistency with object size and last modification time. If the source and destination objects have the same size and the destination's last modification time is not earlier than the source's, the system considers the source object does not need to be migrated or has been already migrated successfully.crc64: This option is only available for migration on Huawei Cloud or from Alibaba Cloud or Tencent Cloud. If a source object and its paired destination object have CRC64 checksums in the metadata, the checksums are checked. Otherwise, their sizes and last modification times are checked.transmission: This value is only available for migration of HTTP/HTTPS data. This option takes effect for source objects whose sizes cannot be obtained from the Content-Length field in the standard HTTP protocol. In this case, the migration is considered successful once the data is downloaded successfully, without requiring additional data check. These source objects will overwrite their paired destination objects directly. If the size of a source object can be obtained from the Content-Length field in the standard HTTP protocol, its size and last modification time will be checked.

Default: size_last_modified

Enumeration values:

  • size_last_modified

  • crc64

  • transmission
Table 4 SourceCdnReq

Parameter

Mandatory

Type

Description

authentication_key

No

String

The CDN authentication key. If the CDN authentication is required, this parameter is mandatory.

If no authorization is required, do not set this parameter.

Qiniu: You do not need to set this parameter.

Aliyun: Set this parameter based on authentication_type.

KingsoftCloud: You do not need to set this parameter.

Minimum: 0

Maximum: 255

authentication_type

Yes

String

The authentication type. The value can be:

NONE: public access without authentication type

QINIU_PRIVATE_AUTHENTICATION: Qiniu private URL signature

ALIYUN_OSS_A: Alibaba Cloud URL signature, simple and universal

ALIYUN_OSS_B: Alibaba Cloud header signature, used for API calling

ALIYUN_OSS_C: Alibaba Cloud STS temporary security token, the most secure

KSYUN_PRIVATE_AUTHENTICATION: Kingsoft Cloud private URL signature

AZURE_SAS_TOKEN: Microsoft Azure shared access signature, flexible and secure

TENCENT_COS_A: Tencent Cloud multi-signature scenarios (not recommended)

TENCENT_COS_B: Tencent Cloud single-signature scenarios, the most secure

TENCENT_COS_C: Tencent Cloud header signature, used for API calling

TENCENT_COS_D: Tencent Cloud header signature, used for API calling

Default: NONE

Enumeration values:

  • NONE

  • QINIU_PRIVATE_AUTHENTICATION

  • ALIYUN_OSS_A

  • ALIYUN_OSS_B

  • ALIYUN_OSS_C

  • KSYUN_PRIVATE_AUTHENTICATION

  • AZURE_SAS_TOKEN

  • TENCENT_COS_A

  • TENCENT_COS_B

  • TENCENT_COS_C

  • TENCENT_COS_D

domain

Yes

String

The domain name used to obtain objects to be migrated.

Minimum: 0

Maximum: 1024

protocol

Yes

String

The protocol type. HTTP and HTTPS are supported.

Enumeration values:

  • http

  • https

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

kms_key_id

No

String

The KMS key ID, which contains 36 characters.

Minimum: 0

Maximum: 36

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

sync_task_id

String

The synchronization task ID.

Minimum: 0

Maximum: 255

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

This example creates a task for synchronizing data from the api-auto-test1 bucket in the Alibaba Cloud's China (Beijing) region to the oms-sonar-north bucket in the Huawei Cloud's CN North-Beijing4 region.

POST https://v2/{project_id}/sync-tasks

{
  "src_cloud_type" : "Aliyun",
  "src_region" : "cn-beijing",
  "src_bucket" : "api-auto-test1",
  "src_ak" : "src_ak",
  "src_sk" : "src_sk",
  "dst_ak" : "dst_ak",
  "dst_sk" : "dst_sk",
  "dst_region" : "cn-north-4",
  "dst_bucket" : "oms-sonar-north",
  "description" : "XXXX",
  "enable_restore" : false,
  "enable_metadata_migration" : false
}

Example Responses

Status code: 200

Created

{
  "sync_task_id" : "xxxxxxxxxxxxxxxxx"
}

Status Codes

Status Code

Description

200

Created

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: Synchronization Task