Help Center/ Distributed Cache Service/ API Reference/ API V2/ Data Migration/ Creating an Online Data Migration Task
Updated on 2024-11-06 GMT+08:00

Creating an Online Data Migration Task

Function

This API is used to create an online data migration task.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/migration/instance

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name of the online migration task.

description

No

String

Description of the online migration task.

vpc_id

Yes

String

VPC ID.

To obtain it, do as follows:

  • Method 1: Log in to the VPC console and view the VPC ID in the VPC details.

  • Method 2: Call the VPC API. For details, see Querying VPCs.

subnet_id

Yes

String

Network ID of the subnet.

To obtain it, do as follows:

  • Method 1: Log in to VPC console and click the target subnet on the Subnets tab page. You can view the network ID on the displayed page.

  • Method 2: Call the VPC API. For details, see Querying Subnets.

security_group_id

Yes

String

Security group which the instance belongs to.

A security group implements access control for VMs within a security group or in different security groups, enhancing VM security. You can define different access rules for a security group to protect the VMs that are added to this security group.

To obtain it, do as follows:

  • Method 1: Log in to the VPC console and choose Access Control > Security Groups. You can create and configure a security group, and obtain the security group ID.

  • Method 2: Call the API used to query security group details. For details, see Querying Security Group Details.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

instance_id

String

Online migration task ID.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Example Requests

Creating an online migration task and configuring the VPC, subnet, and security group for the migration ECS

POST https://{dcs_endpoint}/v2/{project_id}/migration/instance

{
  "name" : "dcs-migration-thrc",
  "description" : "Creating an online data migration task",
  "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481",
  "subnet_id" : "40f15ed6-7f85-49d5-ba0e-65b940d4812c",
  "security_group_id" : "9df96622-24b7-4813-84b8-ab74552a21d7"
}

Example Responses

Status code: 200

Online data migration task created.

{
  "instance_id" : "b21989ec-2889-4b8e-99db-19c073425ec2"
}

SDK Sample Code

The SDK sample code is as follows.

Creating an online migration task and configuring the VPC, subnet, and security group for the migration ECS

 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
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.dcs.v2.region.DcsRegion;
import com.huaweicloud.sdk.dcs.v2.*;
import com.huaweicloud.sdk.dcs.v2.model.*;


public class CreateOnlineMigrationTaskSolution {

    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);

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateOnlineMigrationTaskRequest request = new CreateOnlineMigrationTaskRequest();
        CreateOnlineMigrationTaskBody body = new CreateOnlineMigrationTaskBody();
        body.withSecurityGroupId("9df96622-24b7-4813-84b8-ab74552a21d7");
        body.withSubnetId("40f15ed6-7f85-49d5-ba0e-65b940d4812c");
        body.withVpcId("5e37b3be-950a-48e1-b498-65b63d336481");
        body.withDescription("Creating an online data migration task");
        body.withName("dcs-migration-thrc");
        request.withBody(body);
        try {
            CreateOnlineMigrationTaskResponse response = client.createOnlineMigrationTask(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());
        }
    }
}

Creating an online migration task and configuring the VPC, subnet, and security group for the migration ECS

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdcs.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 = DcsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateOnlineMigrationTaskRequest()
        request.body = CreateOnlineMigrationTaskBody(
            security_group_id="9df96622-24b7-4813-84b8-ab74552a21d7",
            subnet_id="40f15ed6-7f85-49d5-ba0e-65b940d4812c",
            vpc_id="5e37b3be-950a-48e1-b498-65b63d336481",
            description="Creating an online data migration task",
            name="dcs-migration-thrc"
        )
        response = client.create_online_migration_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)

Creating an online migration task and configuring the VPC, subnet, and security group for the migration ECS

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/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 := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateOnlineMigrationTaskRequest{}
	descriptionCreateOnlineMigrationTaskBody:= "Creating an online data migration task"
	request.Body = &model.CreateOnlineMigrationTaskBody{
		SecurityGroupId: "9df96622-24b7-4813-84b8-ab74552a21d7",
		SubnetId: "40f15ed6-7f85-49d5-ba0e-65b940d4812c",
		VpcId: "5e37b3be-950a-48e1-b498-65b63d336481",
		Description: &descriptionCreateOnlineMigrationTaskBody,
		Name: "dcs-migration-thrc",
	}
	response, err := client.CreateOnlineMigrationTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Online data migration task created.

400

Invalid request.

401

Invalid authentication information.

403

The request is rejected.

404

The requested resource is not found.

500

Internal service error.

Error Codes

See Error Codes.