Updated on 2025-03-31 GMT+08:00

Listing Synchronization Tasks

Function

This API is used to list all synchronization tasks in an account.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/sync-tasks

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

Minimum length: 1 character

Maximum length: 1,024 characters

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

The maximum number of synchronization tasks displayed on one page. By default, 10 synchronization tasks are displayed on one page.

A maximum of 100 synchronization tasks can be displayed.

Minimum value: 1

Maximum value: 100

Default value: 10

offset

No

Integer

The start serial number of synchronization tasks.

The value must be greater than or equal to 0. If offset is set to 0, the query starts from the first record.

Minimum value: 0

Maximum value: 10000

Default value: 0

status

No

String

The synchronization task status. If this parameter is not specified, tasks in all statuses are queried.

SYNCHRONIZING: a synchronizing status

STOPPED: a stopped status

Minimum length: 0 characters

Maximum length: 255 characters

Request

Table 3 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

Response

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

tasks

Array of SyncTaskInfo objects

The details of queried synchronization tasks.

Array length: 0 to 100

count

Long

The total number of the synchronization tasks that meet the query criteria.

Minimum value: 0

Maximum value: 9223372036854775807

Table 5 SyncTaskInfo field description

Parameter

Type

Description

sync_task_id

String

The synchronization task ID.

Minimum length: 0 characters

Maximum length: 255 characters

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.

The value can be:

  • AWS

  • Azure

  • Aliyun

  • Tencent

  • HuaweiCloud

  • QingCloud

  • KingsoftCloud

  • Baidu

  • Qiniu

  • UCloud

src_region

String

The region where the source bucket is located.

Minimum length: 0 characters

Maximum length: 100 characters

src_bucket

String

The name of the source bucket.

Minimum length: 0 characters

Maximum length: 1,024 characters

create_time

Long

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

Minimum value: 0

Maximum value: 9223372036854775807

last_start_time

Long

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

Minimum value: 0

Maximum value: 9223372036854775807

dst_bucket

String

The name of the destination bucket.

Minimum length: 0 characters

Maximum length: 1,024 characters

dst_region

String

The region where the destination bucket is located.

Minimum length: 0 characters

Maximum length: 100 characters

description

String

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

Minimum length: 0 characters

Maximum length: 255 characters

status

String

The synchronization task status.

SYNCHRONIZING: a synchronizing status

STOPPED: a stopped status

The value can be:

  • SYNCHRONIZING

  • STOPPED

enable_kms

Boolean

Indicates whether KMS encryption is enabled. This function is disabled by default.

enable_metadata_migration

Boolean

Indicates whether metadata migration is enabled. The default value is false. Even if this function is disabled, the ContentType metadata will still be migrated to ensure a successful migration.

enable_restore

Boolean

Indicates whether archive data restoration is enabled. If this function is enabled, archive data is automatically restored and migrated.

app_id

String

This parameter is mandatory when cloud_type is Tencent.

Minimum length: 0 characters

Maximum length: 255 characters

source_cdn

SourceCdnResp object

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

object_overwrite_mode

String

Indicates whether to skip a source object or allow the source object to overwrite its paired destination object. The default value is SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE. NO_OVERWRITE indicates the system never allows overwrite. The system always skips source objects and keeps their paired destination objects. SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE indicates the system allows overwrite based on the results of size or modification time checks. It is the default setting. If a source object is not as large as or was last modified more recently than its paired destination object, the source object will overwrite the destination object. Otherwise, the source object will be skipped. CRC64_COMPARISON_OVERWRITE indicates the system allows overwrite if the source and destination objects have different CRC64 checksums. This option is only available for migration on Huawei Cloud or from Alibaba Cloud or Tencent Cloud. If a source object has a CRC64 checksum different from the paired destination object, the source object will overwrite the destination object. Otherwise, the source object will be skipped. If one of them does not have a CRC64 checksum, their sizes and last modification times are checked. FULL_OVERWRITE indicates the system always allows overwrite. The system always allows source objects to overwrite their paired destination objects.

The value can be:

  • 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: converts the source storage class into an OBS storage class based on the predefined rules.

Default value: STANDARD

Minimum length: 0 characters

Maximum length: 128 characters

The value can be:

  • STANDARD

  • IA

  • ARCHIVE

  • DEEP_ARCHIVE

  • SRC_STORAGE_MAPPING

consistency_check

String

The consistency check method, which is used to check whether objects are consistent before and after migration. The selected check method and results will be recorded in the object list. The default value is size_last_modified. size_last_modified: It is the default setting. The system checks object consistency with object size and last modification time. If a source object is as large as but was last modified earlier than its paired destination object, 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. If a source object and its paired destination object have CRC64 checksums, 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. These source objects are marked as successfully migrated. 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.

The value can be:

  • size_last_modified

  • crc64

  • no_check

Table 6 SourceCdnResp field description

Parameter

Type

Description

domain

String

The domain name from which to obtain objects to be migrated.

Minimum length: 0 characters

Maximum length: 1,024 characters

protocol

String

The protocol type.

The value can be:

  • http

  • https

authentication_type

String

The authentication type.

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

The value can be:

  • 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

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

The error message.

error_code

String

The error code.

Example Request

This example queries five synchronization tasks in the 2c0689c860ad4728a497c91ec0844383 project.

GET https://{endpoint}/v2/2c0689c860ad4728a497c91ec0844383/sync-tasks?offset=0&limit=5&status=SYNCHRONIZING

Example Response

Status code: 200

OK

{
  "tasks" : [ {
    "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_kms" : false,
    "enable_metadata_migration" : false,
    "enable_restore" : false,
    "app_id" : null,
    "source_cdn" : null,
    "object_overwrite_mode" : "SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE",
    "dst_storage_policy" : null,
    "consistency_check" : "size_last_modified"
  } ],
  "count" : 1
}

SDK Sample Code

The sample code is as follows.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.oms.v2.region.OmsRegion;
import com.huaweicloud.sdk.oms.v2.*;
import com.huaweicloud.sdk.oms.v2.model.*;


public class ListSyncTasksSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        OmsClient client = OmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(OmsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListSyncTasksRequest request = new ListSyncTasksRequest();
        try {
            ListSyncTasksResponse response = client.listSyncTasks(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkoms.v2.region.oms_region import OmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkoms.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = OmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(OmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListSyncTasksRequest()
        response = client.list_sync_tasks(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    oms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := oms.NewOmsClient(
        oms.OmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListSyncTasksRequest{}
	response, err := client.ListSyncTasks(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For more SDK sample code of programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

For details, see Error Codes.