Creating a Synchronization Task
Function
This API is used to create a synchronization task. After the synchronization task is created, it will be automatically started.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/sync-tasks
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
The project ID. Minimum length: 1 character Maximum length: 1,024 characters |
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
The token used for IAM authentication. Minimum length: 1 character Maximum length: 16,384 characters |
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. Minimum length: 0 characters Maximum length: 100 characters |
src_sk |
Yes |
String |
The SK for accessing the source bucket. Minimum length: 0 characters Maximum length: 100 characters |
dst_ak |
Yes |
String |
The AK for accessing the destination bucket. Minimum length: 0 characters Maximum length: 100 characters |
dst_sk |
Yes |
String |
The SK for accessing the destination bucket. 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 |
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. Default value: false |
enable_kms |
No |
Boolean |
Indicates whether KMS encryption is enabled. This function is disabled by default. Default value: false |
enable_restore |
No |
Boolean |
Indicates whether archive data restoration is enabled. If this function is enabled, archive data is automatically restored and migrated. Default value: false |
dst_storage_policy |
No |
String |
The destination storage class. STANDARD indicates the Huawei Cloud OBS Standard. IA indicates the Huawei Cloud OBS Infrequent Access. ARCHIVE indicates the Huawei Cloud OBS Archive. DEEP_ARCHIVE indicates the Huawei Cloud OBS Deep Archive. 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: |
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 |
Indicates whether migration from CDN is enabled. If this field is contained, 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 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 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, 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 using the content-length field in the standard HTTP protocol. These source objects will overwrite their paired destination objects directly. If the size of a source object can be obtained, its size and last modification time will be checked. Default value: size_last_modified The value can be: |
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 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. Default value: NONE The value can be: |
domain |
Yes |
String |
The domain name from which to obtain objects to be migrated. Minimum length: 0 characters Maximum length: 1,024 characters |
protocol |
Yes |
String |
The protocol type. The value can be: |
Response
Status code: 200
Parameter |
Type |
Description |
---|---|---|
sync_task_id |
String |
The synchronization task ID. Minimum length: 0 characters Maximum length: 255 characters |
Status code: 400
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 China (Beijing) region to the oms-sonar-north bucket in the Huawei Cloud 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 sample code is as follows:
This example creates a task for synchronizing data from the api-auto-test1 bucket in the Alibaba Cloud China (Beijing) region to the oms-sonar-north bucket in the Huawei Cloud CN North-Beijing4 region.
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 48 49 50 51 52 53 54 55 56 57 58 59 60 |
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"); ICredential auth = new BasicCredentials() .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()); } } } |
This example creates a task for synchronizing data from the api-auto-test1 bucket in the Alibaba Cloud China (Beijing) region to the oms-sonar-north bucket in the Huawei Cloud CN North-Beijing4 region.
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 |
# 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"] credentials = BasicCredentials(ak, sk) 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) |
This example creates a task for synchronizing data from the api-auto-test1 bucket in the Alibaba Cloud China (Beijing) region to the oms-sonar-north bucket in the Huawei Cloud CN North-Beijing4 region.
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 48 49 50 51 52 53 54 55 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). 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 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 |
Created |
400 |
Bad Request |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot