更新时间:2024-11-06 GMT+08:00

配置在线数据迁移任务

功能介绍

配置在线数据迁移任务。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/migration/{task_id}/task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

task_id

String

在线迁移任务ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

migration_method

String

迁移方式,包括全量迁移和增量迁移两种类型。

  • 全量迁移:该模式为Redis的一次性迁移,适用于可中断业务的迁移场景。

    全量迁移过程中,如果源Redis有数据更新,这部分更新数据不会被迁移到目标Redis。

  • 增量迁移:该模式为Redis的持续性迁移,适用于对业务中断敏感的迁移场景。

    增量迁移阶段通过解析日志等技术, 持续保持源Redis和目标端Redis的数据一致,

    先进行全量迁移,后进行增量迁移。取值范围:

  • full_amount_migration:表示全量迁移。

  • incremental_migration:表示增量迁移。

resume_mode

String

自动重连,根据参数决定是否自动重连。

自动重连模式在遇到网络等异常情况时,会无限自动重试。

自动重连模式在无法进行增量同步时,会触发全量同步,增加带宽占用,请谨慎选择。取值范围:

  • auto:自动重连。

  • manual:手动重连。

bandwidth_limit_mb

String

带宽限制,当迁移方式为增量迁移时,为保证业务正常运行,您可以启用带宽限制功能,当数据同步速度达到带宽限制时,将限制同步速度的继续增长。

  • 带宽限制的单位为MB/s。

  • 取值范围:1-10240(大于0小于10241之间的整数)。

source_instance

ConfigMigrationInstanceBody object

表示源Redis信息。

target_instance

ConfigMigrationInstanceBody object

表示目标Redis信息。

表3 ConfigMigrationInstanceBody

参数

是否必选

参数类型

描述

id

String

Redis实例ID(若不填写addrs,则必须填写ID)。

addrs

String

Redis实例地址(若不填写ID,则必须填写addrs)。

password

String

Redis密码,如果设置了密码,则必须填写。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

迁移任务ID。

name

String

迁移任务名称。

status

String

迁移任务状态,这个字段的值包括:SUCCESS(成功), FAILED(失败), MIGRATING(迁移中),TERMINATED(已结束)。

error

String

错误信息。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)。

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)。

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)。

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)。

请求示例

配置在线迁移任务,迁移方式为增量迁移,开启自动重连,配置源端和目标端实例信息。

POST https://{dcs_endpoint}/v2/{project_id}/migration/{task_id}/task

{
  "migration_method" : "incremental_migration",
  "bandwidth_limit_mb" : 123,
  "resume_mode" : "auto",
  "source_instance" : {
    "id" : null,
    "addrs" : "192.168.1.1:6379,192.168.0.0:6379",
    "password" : "xxxxxx"
  },
  "target_instance" : {
    "id" : "cf4a05df-1c38-47c5-bb5a-0a7b3673b3bd",
    "addrs" : null,
    "password" : null
  }
}

响应示例

状态码: 200

配置在线数据迁移任务成功。

{
  "id" : "90754308-a156-406f-a837-8f852f38a646",
  "name" : "dcs-migration-1db7",
  "status" : "FULLMIGRATING",
  "error" : ""
}

SDK代码示例

SDK代码示例如下。

配置在线迁移任务,迁移方式为增量迁移,开启自动重连,配置源端和目标端实例信息。

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


public class SetOnlineMigrationTaskSolution {

    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();
        SetOnlineMigrationTaskRequest request = new SetOnlineMigrationTaskRequest();
        request.withTaskId("{task_id}");
        SetOnlineMigrationTaskBody body = new SetOnlineMigrationTaskBody();
        ConfigMigrationInstanceBody targetInstancebody = new ConfigMigrationInstanceBody();
        targetInstancebody.withId("cf4a05df-1c38-47c5-bb5a-0a7b3673b3bd");
        ConfigMigrationInstanceBody sourceInstancebody = new ConfigMigrationInstanceBody();
        sourceInstancebody.withAddrs("192.168.1.1:6379,192.168.0.0:6379")
            .withPassword("xxxxxx");
        body.withTargetInstance(targetInstancebody);
        body.withSourceInstance(sourceInstancebody);
        body.withBandwidthLimitMb("123");
        body.withResumeMode(SetOnlineMigrationTaskBody.ResumeModeEnum.fromValue("auto"));
        body.withMigrationMethod(SetOnlineMigrationTaskBody.MigrationMethodEnum.fromValue("incremental_migration"));
        request.withBody(body);
        try {
            SetOnlineMigrationTaskResponse response = client.setOnlineMigrationTask(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());
        }
    }
}

配置在线迁移任务,迁移方式为增量迁移,开启自动重连,配置源端和目标端实例信息。

 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
# 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 = SetOnlineMigrationTaskRequest()
        request.task_id = "{task_id}"
        targetInstancebody = ConfigMigrationInstanceBody(
            id="cf4a05df-1c38-47c5-bb5a-0a7b3673b3bd"
        )
        sourceInstancebody = ConfigMigrationInstanceBody(
            addrs="192.168.1.1:6379,192.168.0.0:6379",
            password="xxxxxx"
        )
        request.body = SetOnlineMigrationTaskBody(
            target_instance=targetInstancebody,
            source_instance=sourceInstancebody,
            bandwidth_limit_mb="123",
            resume_mode="auto",
            migration_method="incremental_migration"
        )
        response = client.set_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)

配置在线迁移任务,迁移方式为增量迁移,开启自动重连,配置源端和目标端实例信息。

 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
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.SetOnlineMigrationTaskRequest{}
	request.TaskId = "{task_id}"
	idTargetInstance:= "cf4a05df-1c38-47c5-bb5a-0a7b3673b3bd"
	targetInstancebody := &model.ConfigMigrationInstanceBody{
		Id: &idTargetInstance,
	}
	addrsSourceInstance:= "192.168.1.1:6379,192.168.0.0:6379"
	passwordSourceInstance:= "xxxxxx"
	sourceInstancebody := &model.ConfigMigrationInstanceBody{
		Addrs: &addrsSourceInstance,
		Password: &passwordSourceInstance,
	}
	bandwidthLimitMbSetOnlineMigrationTaskBody:= "123"
	request.Body = &model.SetOnlineMigrationTaskBody{
		TargetInstance: targetInstancebody,
		SourceInstance: sourceInstancebody,
		BandwidthLimitMb: &bandwidthLimitMbSetOnlineMigrationTaskBody,
		ResumeMode: model.GetSetOnlineMigrationTaskBodyResumeModeEnum().AUTO,
		MigrationMethod: model.GetSetOnlineMigrationTaskBodyMigrationMethodEnum().INCREMENTAL_MIGRATION,
	}
	response, err := client.SetOnlineMigrationTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

配置在线数据迁移任务成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码