Creating a Synchronization Event_Synchronization Task Management_APIs V2 (Recommended)_API Reference_Object Storage Migration Service-Huawei Cloud

Function

This API is used to create a synchronization event when objects in the source bucket need to be synchronized. Then OMS synchronizes the objects contained in the synchronization event. This API is available in regions CN North-Beijing4 and CN East-Shanghai1.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/sync-tasks/{sync_task_id}/events

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	The project ID. Minimum length: 1 character Maximum length: 1,024 characters
sync_task_id	Yes	String	The synchronization task 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 API authentication. It is recommended that you use signature authorization. For details, see "Authentication." Minimum length: 1 character Maximum length: 16,384 characters

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
object_keys	Yes	Array of strings	The list of URL-encoded names of objects to be synchronized. A maximum of 10 objects can be included. Minimum length: 1 character Maximum length: 16,384 characters Array length: 1 to 100

Response

Status code: 400

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

Status code: 404

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

Status code: 503

**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 synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the files test %2F001.txt and test %2F002.txt.

/v2/f697f813-554a-4f05-bac8-82a183b20878/sync-tasks/31e9b7e6-6ffb-452f-9842-6ce354d99d75/events

{
  "object_keys" : [ "test%2F001.txt", "test%2F002.txt" ]
}

This example creates a synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the file test %2B001.txt.

/v2/f697f813-554a-4f05-bac8-82a183b20878/sync-tasks/31e9b7e6-6ffb-452f-9842-6ce354d99d75/events

{
  "object_keys" : [ "test%2B001.txt" ]
}

This example creates a synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the file test+001.txt.

/v2/f697f813-554a-4f05-bac8-82a183b20878/sync-tasks/31e9b7e6-6ffb-452f-9842-6ce354d99d75/events

{
  "object_keys" : [ "test+001.txt" ]
}

Example Response

None

SDK Sample Code

The sample code is as follows.

Java

This example creates a synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the files test %2F001.txt and test %2F002.txt.

      
       
         
         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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateSyncEventsSolution {

    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();
        CreateSyncEventsRequest request = new CreateSyncEventsRequest();
        request.withSyncTaskId("{sync_task_id}");
        SyncObjectReq body = new SyncObjectReq();
        List<String> listbodyObjectKeys = new ArrayList<>();
        listbodyObjectKeys.add("test%2F001.txt");
        listbodyObjectKeys.add("test%2F002.txt");
        body.withObjectKeys(listbodyObjectKeys);
        request.withBody(body);
        try {
            CreateSyncEventsResponse response = client.createSyncEvents(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 synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the file test %2B001.txt.

      
       
         
         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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateSyncEventsSolution {

    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();
        CreateSyncEventsRequest request = new CreateSyncEventsRequest();
        request.withSyncTaskId("{sync_task_id}");
        SyncObjectReq body = new SyncObjectReq();
        List<String> listbodyObjectKeys = new ArrayList<>();
        listbodyObjectKeys.add("test%2B001.txt");
        body.withObjectKeys(listbodyObjectKeys);
        request.withBody(body);
        try {
            CreateSyncEventsResponse response = client.createSyncEvents(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 synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the file test+001.txt.

      
       
         
         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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateSyncEventsSolution {

    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();
        CreateSyncEventsRequest request = new CreateSyncEventsRequest();
        request.withSyncTaskId("{sync_task_id}");
        SyncObjectReq body = new SyncObjectReq();
        List<String> listbodyObjectKeys = new ArrayList<>();
        listbodyObjectKeys.add("test+001.txt");
        body.withObjectKeys(listbodyObjectKeys);
        request.withBody(body);
        try {
            CreateSyncEventsResponse response = client.createSyncEvents(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

This example creates a synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the files test %2F001.txt and test %2F002.txt.

      
       
         
         # 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 = CreateSyncEventsRequest()
        request.sync_task_id = "{sync_task_id}"
        listObjectKeysbody = [
            "test%2F001.txt",
            "test%2F002.txt"
        ]
        request.body = SyncObjectReq(
            object_keys=listObjectKeysbody
        )
        response = client.create_sync_events(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 synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the file test %2B001.txt.

      
       
         
         # 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 = CreateSyncEventsRequest()
        request.sync_task_id = "{sync_task_id}"
        listObjectKeysbody = [
            "test%2B001.txt"
        ]
        request.body = SyncObjectReq(
            object_keys=listObjectKeysbody
        )
        response = client.create_sync_events(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 synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the file test+001.txt.

      
       
         
         # 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 = CreateSyncEventsRequest()
        request.sync_task_id = "{sync_task_id}"
        listObjectKeysbody = [
            "test+001.txt"
        ]
        request.body = SyncObjectReq(
            object_keys=listObjectKeysbody
        )
        response = client.create_sync_events(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

This example creates a synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the files test %2F001.txt and test %2F002.txt.

      
       
         
         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.CreateSyncEventsRequest{}
	request.SyncTaskId = "{sync_task_id}"
	var listObjectKeysbody = []string{
        "test%2F001.txt",
	    "test%2F002.txt",
    }
	request.Body = &model.SyncObjectReq{
		ObjectKeys: listObjectKeysbody,
	}
	response, err := client.CreateSyncEvents(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      
     

This example creates a synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the file test %2B001.txt.

      
       
         
         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.CreateSyncEventsRequest{}
	request.SyncTaskId = "{sync_task_id}"
	var listObjectKeysbody = []string{
        "test%2B001.txt",
    }
	request.Body = &model.SyncObjectReq{
		ObjectKeys: listObjectKeysbody,
	}
	response, err := client.CreateSyncEvents(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      
     

This example creates a synchronization event for the task 31e9b7e6-6ffb-452f-9842-6ce354d99d75 to synchronize the file test+001.txt.

      
       
         
         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.CreateSyncEventsRequest{}
	request.SyncTaskId = "{sync_task_id}"
	var listObjectKeysbody = []string{
        "test+001.txt",
    }
	request.Body = &model.SyncObjectReq{
		ObjectKeys: listObjectKeysbody,
	}
	response, err := client.CreateSyncEvents(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. Synchronous event created successfully.
400	Bad request. Invalid parameters.
404	Not found. Synchronization task not found.
503	Service unavailable. Please try again later.

Error Codes

For details, see Error Codes.

Creating a Synchronization Event

Function

Calling Method

URI

Request

Response

Example Request

Example Response

SDK Sample Code

Java

Python

Go

More

Status Codes

Error Codes

Feedback

Was this page helpful?