Help Center/ Object Storage Migration Service/ API Reference/ APIs V2/ Synchronization Task/ Query the Details of a Synchronization Task with a Specified ID
Updated on 2026-06-30 GMT+08:00
View PDF

Query the Details of a Synchronization Task with a Specified ID

Function

This API is used to query details about a synchronization task with a specified ID.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/sync-tasks/{sync_task_id}

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
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

query_time

Yes

Long

The time (in milliseconds) when the synchronization task details are queried. The statistics of the current month are returned based on the value of this parameter.

Minimum: 0

Maximum: 9223372036854775807

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The token used for IAM authentication.

Minimum: 1

Maximum: 16384

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

sync_task_id

String

The synchronization task ID.

Minimum: 0

Maximum: 255

src_cloud_type

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.

Enumeration values:

  • AWS

  • Azure

  • Aliyun

  • Tencent

  • HuaweiCloud

  • QingCloud

  • KingsoftCloud

  • Baidu

  • Qiniu

  • UCloud

src_region

String

The region where the source bucket is located.

Minimum: 0

Maximum: 100

src_bucket

String

Source bucket.

Minimum: 0

Maximum: 1024

create_time

Long

The time (Unix timestamp, in milliseconds) when the synchronization task was created.

Minimum: 0

Maximum: 9223372036854775807

last_start_time

Long

The last time (Unix timestamp, in milliseconds) when the synchronization task was started.

Minimum: 0

Maximum: 9223372036854775807

dst_bucket

String

The destination bucket.

Minimum: 0

Maximum: 1024

dst_region

String

The region where the destination bucket is located.

Minimum: 0

Maximum: 100

description

String

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

Minimum: 0

Maximum: 255

status

String

The synchronization task status. The value can be:

SYNCHRONIZING: being synchronizing

STOPPED: already stopped

Enumeration values:

  • SYNCHRONIZING

  • STOPPED

enable_metadata_migration

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.

enable_restore

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.

app_id

String

Tencent Cloud app ID. This parameter is returned if cloud_type is Tencent.

Minimum: 0

Maximum: 255

monthly_acceptance_request

Long

The number of objects requested for synchronization in the current month.

Minimum: 0

Maximum: 9223372036854775807

monthly_success_object

Long

The number of objects that were successfully synchronized in the current month.

Minimum: 0

Maximum: 9223372036854775807

monthly_failure_object

Long

The number of objects that failed to be synchronized in the current month.

Minimum: 0

Maximum: 9223372036854775807

monthly_skip_object

Long

The number of objects that were skipped in the current month.

Minimum: 0

Maximum: 9223372036854775807

monthly_size

Long

The total size of synchronized objects in the current month, in bytes.

Minimum: 0

Maximum: 9223372036854775807

object_overwrite_mode

String

How a source object handles its paired destination object, either overwriting the object or skipping the migration. The default value is SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE.NO_OVERWRITE indicates the system never allows overwriting. The system always skips source objects and keeps their paired destination objects.SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE: The system allows overwriting based on the results of size or modification time checks. This is the default value. If a source object has the same name as the paired destination object, the system compares the sizes and last modification time of the source and destination objects to determine whether to overwrite the destination object. The encryption status of the source and destination objects must be the same. If the source object has a different size or was last modified more recently than its paired destination object, the destination object will be overwritten.CRC64_COMPARISON_OVERWRITE: The system allows overwriting if the source and destination objects have different CRC64 checksums. This option is only available for migration within Huawei Cloud or from Alibaba Cloud or Tencent Cloud. If a source object has a CRC64 checksum different from its paired destination object, the destination object will be overwritten. The encryption status of the source and destination objects must be the same. If there are no CRC64 checksums in the metadata, the SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE value is used.FULL_OVERWRITE indicates the system always allows overwriting. The system always allows source objects to overwrite their paired destination objects.

Enumeration values:

  • NO_OVERWRITE

  • SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE

  • CRC64_COMPARISON_OVERWRITE

  • FULL_OVERWRITE

dst_storage_policy

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

consistency_check

String

The method for checking whether objects are consistent 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 has been already migrated successfully.crc64: This option is only available for migration on Huawei Cloud or from Alibaba Cloud or Tencent Cloud. After migration, 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.no_check: This option 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. 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.

Enumeration values:

  • size_last_modified

  • crc64

  • no_check

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

This example queries the details of the task 0d146099-8cf4-437d-b6ef-88e043771c8b in the project 2c0689c860ad4728a497c91ec0844383.

GET https://{endpoint}/v2/2c0689c860ad4728a497c91ec0844383/sync-tasks/0d146099-8cf4-437d-b6ef-88e043771c8b

Example Responses

Status code: 200

OK

{
  "sync_task_id" : "d18befdd-eb82-41f3-8019-bbb593d74a3e",
  "src_cloud_type" : "HuaweiCloud",
  "src_region" : "cn-north-7",
  "src_bucket" : "oms-sdk-test-src",
  "create_time" : 1700639560751,
  "last_start_time" : 1700639560751,
  "dst_bucket" : "oms-sdk-test-dst",
  "dst_region" : "cn-north-7",
  "description" : "sync task test",
  "status" : "SYNCHRONIZING",
  "enable_metadata_migration" : false,
  "enable_restore" : false,
  "app_id" : null,
  "monthly_acceptance_request" : 11,
  "monthly_success_object" : 0,
  "monthly_failure_object" : 11,
  "monthly_skip_object" : 0,
  "monthly_size" : 0,
  "object_overwrite_mode" : "SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE",
  "dst_storage_policy" : null,
  "consistency_check" : "size_last_modified"
}

Status Codes

Status Code

Description

200

OK

404

Not Found

Error Codes

See Error Codes.

Parent Topic: Synchronization Task