Creating a Synchronization Task

Function

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

Constraints

A tenant can create a maximum of five synchronization tasks.

Calling Method

For details, see Calling APIs.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the permission listed below is required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
oms:synctask:create	Write	synctask *	-	-	-

URI

POST /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

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_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 value: Aliyun
src_region	Yes	String	The region where the source bucket is located. Minimum length: 0 characters Maximum length: 100 characters
src_bucket	Yes	String	The name of the source bucket. Minimum length: 0 characters Maximum length: 1,024 characters
src_ak	Yes	String	The AK for accessing the source bucket. Enter a maximum of 100 characters. Minimum length: 0 characters Maximum length: 100 characters
src_sk	Yes	String	The SK for accessing the source bucket. Enter a maximum of 100 characters. Minimum length: 0 characters Maximum length: 100 characters
dst_ak	Yes	String	The AK for accessing the destination bucket. Enter a maximum of 100 characters. Minimum length: 0 characters Maximum length: 100 characters
dst_sk	Yes	String	The SK for accessing the destination bucket. Enter a maximum of 100 characters. Minimum length: 0 characters Maximum length: 100 characters
dst_region	Yes	String	The region where the destination bucket is located. Minimum length: 0 characters Maximum length: 100 characters
dst_bucket	Yes	String	The name of the destination bucket. Minimum length: 0 characters Maximum length: 1,024 characters
description	No	String	The task description, which cannot exceed 255 characters. The following special characters are not allowed: <>()"'& Minimum length: 0 characters Maximum length: 255 characters
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 value: false
enable_kms	No	Boolean	Whether KMS encryption is enabled. This function is disabled by default. Default value: 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 value: 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 value: STANDARD Minimum length: 0 characters Maximum length: 128 characters Enumerated values: STANDARD IA ARCHIVE DEEP_ARCHIVE SRC_STORAGE_MAPPING
app_id	No	String	This parameter is mandatory when cloud_type is Tencent. Minimum length: 0 characters Maximum length: 255 characters
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 (default): 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 value is only available for migration within 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 value: size_last_modified Enumerated values: size_last_modified crc64 transmission

**Table 4** SourceCdnReq
Parameter	Mandatory	Type	Description
authentication_key	No	String	The CDN authentication key. This parameter is mandatory if CDN authentication is required. 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 the value of authentication_type. KingsoftCloud: You do not need to set this parameter. Minimum length: 0 characters Maximum length: 255 characters
authentication_type	Yes	String	The authentication type. 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 value: NONE Enumerated 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 length: 0 characters Maximum length: 1,024 characters
protocol	Yes	String	The protocol type. HTTP and HTTPS are supported. Enumerated values: http https

Response

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
sync_task_id	String	The synchronization task ID. Minimum length: 0 characters Maximum length: 255 characters

Status code: 400

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

Example Request

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_kms" : false,
  "enable_restore" : false,
  "enable_metadata_migration" : false
}

Example Response

Status code: 200

Created

{
  "sync_task_id" : "xxxxxxxxxxxxxxxxx"
}

SDK Sample Code

The following shows the sample SDK code.

      
       
         
         
           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 CreateSyncTaskSolution {

    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();
        CreateSyncTaskRequest request = new CreateSyncTaskRequest();
        CreateSyncTaskReq body = new CreateSyncTaskReq();
        body.withEnableRestore(false);
        body.withEnableKms(false);
        body.withEnableMetadataMigration(false);
        body.withDescription("XXXX");
        body.withDstBucket("oms-sonar-north");
        body.withDstRegion("cn-north-4");
        body.withDstSk("dst_sk");
        body.withDstAk("dst_ak");
        body.withSrcSk("src_sk");
        body.withSrcAk("src_ak");
        body.withSrcBucket("api-auto-test1");
        body.withSrcRegion("cn-beijing");
        body.withSrcCloudType("Aliyun");
        request.withBody(body);
        try {
            CreateSyncTaskResponse response = client.createSyncTask(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = CreateSyncTaskRequest()
        request.body = CreateSyncTaskReq(
            enable_restore=False,
            enable_kms=False,
            enable_metadata_migration=False,
            description="XXXX",
            dst_bucket="oms-sonar-north",
            dst_region="cn-north-4",
            dst_sk="dst_sk",
            dst_ak="dst_ak",
            src_sk="src_sk",
            src_ak="src_ak",
            src_bucket="api-auto-test1",
            src_region="cn-beijing",
            src_cloud_type="Aliyun"
        )
        response = client.create_sync_task(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           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.CreateSyncTaskRequest{}
	enableRestoreCreateSyncTaskReq:= false
	enableKmsCreateSyncTaskReq:= false
	enableMetadataMigrationCreateSyncTaskReq:= false
	descriptionCreateSyncTaskReq:= "XXXX"
	srcCloudTypeCreateSyncTaskReq:= "Aliyun"
	request.Body = &model.CreateSyncTaskReq{
		EnableRestore: &enableRestoreCreateSyncTaskReq,
		EnableKms: &enableKmsCreateSyncTaskReq,
		EnableMetadataMigration: &enableMetadataMigrationCreateSyncTaskReq,
		Description: &descriptionCreateSyncTaskReq,
		DstBucket: "oms-sonar-north",
		DstRegion: "cn-north-4",
		DstSk: "dst_sk",
		DstAk: "dst_ak",
		SrcSk: "src_sk",
		SrcAk: "src_ak",
		SrcBucket: "api-auto-test1",
		SrcRegion: "cn-beijing",
		SrcCloudType: &srcCloudTypeCreateSyncTaskReq,
	}
	response, err := client.CreateSyncTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

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