Starting a Synchronization Task
Function
This API is used to start a paused a synchronization task. Currently, this API is only available CN North-Beijing4 and CN East-Shanghai1.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/sync-tasks/{sync_task_id}/start
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: 0 characters Maximum length: 255 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_ak |
Yes |
String |
The AK for accessing the source node. Enter a maximum of 100 characters. This parameter is not required for URL list-based migration tasks. Minimum length: 1 character Maximum length: 100 characters |
src_sk |
Yes |
String |
The SK for accessing the source node. Enter a maximum of 100 characters. This parameter is not required for URL list-based migration tasks. Minimum length: 1 character Maximum length: 100 characters |
dst_ak |
Yes |
String |
The AK for accessing the destination node. Enter a maximum of 100 characters. Minimum length: 1 character Maximum length: 100 characters |
dst_sk |
Yes |
String |
The SK for accessing the destination node. Enter a maximum of 100 characters. Minimum length: 1 character Maximum length: 100 characters |
source_cdn_authentication_key |
No |
String |
The CDN authentication key. Minimum length: 0 characters Maximum length: 255 characters |
Response
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
The error message. |
error_code |
String |
The error code. |
Example Request
This example starts a synchronization task.
POST https://{endpoint}/v2/{project_id}/sync-tasks/{sync_task_id}/start { "src_ak" : "src_ak", "src_sk" : "src_sk", "dst_ak" : "dst_ak", "dst_sk" : "dst_sk" }
Example Response
None
SDK Sample Code
The sample code is as follows:
This example starts a synchronization task.
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 |
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 StartSyncTaskSolution { 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(); StartSyncTaskRequest request = new StartSyncTaskRequest(); StartSyncTaskReq body = new StartSyncTaskReq(); body.withDstSk("dst_sk"); body.withDstAk("dst_ak"); body.withSrcSk("src_sk"); body.withSrcAk("src_ak"); request.withBody(body); try { StartSyncTaskResponse response = client.startSyncTask(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 starts a synchronization task.
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 |
# 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 = StartSyncTaskRequest() request.body = StartSyncTaskReq( dst_sk="dst_sk", dst_ak="dst_ak", src_sk="src_sk", src_ak="src_ak" ) response = client.start_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 starts a synchronization task.
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 |
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.StartSyncTaskRequest{} request.Body = &model.StartSyncTaskReq{ DstSk: "dst_sk", DstAk: "dst_ak", SrcSk: "src_sk", SrcAk: "src_ak", } response, err := client.StartSyncTask(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 |
OK |
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