# 配置在线数据迁移任务 - SetOnlineMigrationTask #### 功能介绍 配置在线数据迁移任务。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dcs/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dcs/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dcs:migrationTask:modify | Write | migrationTask \* | - | - dcs:migrationTask:exchangeIp - dcs:migrationTask:rollbackIp | - | #### URI POST /v2/{project_id}/migration/{task_id}/task 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dcs/dcs-api-0312045.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | task_id | 是 | String | **参数解释**： 在线迁移任务ID。 **约束限制**： 必须为已创建的在线迁移任务ID。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | migration_method | 是 | String | **参数解释**： 迁移方式，包括全量迁移和增量迁移两种类型。 - 全量迁移：该模式为Redis的一次性迁移，适用于可中断业务的迁移场景。 - 增量迁移：该模式为Redis的持续性迁移，适用于对业务中断敏感的迁移场景。 全量迁移过程中，如果源Redis有数据更新，这部分更新数据不会被迁移到目标Redis。 增量迁移阶段通过解析日志等技术， 持续保持源Redis和目标端Redis的数据一致，先进行全量迁移，后进行增量迁移。 **约束限制**： 必填，不合法时返回INVALID_REQUEST_PARAM错误。 **取值范围**： - full_amount_migration：表示全量迁移。 - incremental_migration：表示增量迁移。 **默认取值**： 不涉及。 | | resume_mode | 是 | String | **参数解释**： 自动重连，根据参数决定是否自动重连。 自动重连模式在遇到网络等异常情况时，会无限自动重试。 自动重连模式在无法进行增量同步时，会触发全量同步，增加带宽占用，请谨慎选择。 **约束限制**： 仅V2迁移实例支持该参数，非法值返回QUERY_PARAM_INVALID错误。 **取值范围**： - auto：自动重连。 - manual：手动重连。 **默认取值**： manual。 | | bandwidth_limit_mb | 否 | String | **参数解释**： 迁移带宽限制，单位MB/s。不传表示不限带宽。 当迁移方式为增量迁移时，为保证业务正常运行，您可以启用带宽限制功能，当数据同步速度达到带宽限制时，将限制同步速度的继续增长。 **约束限制**： 若填写必须为正整数，且不超过最大上限值。 **取值范围**： 1\~10240。 **默认取值**： 不涉及。 | | source_instance | 是 | [ConfigMigrationInstanceBody] object | **参数解释**： 表示源Redis信息。 **约束限制**： - id和addrs至少填一个。 - 源端和目标端不能相同。 - 源端不能为开启eventlog的实例。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | target_instance | 是 | [ConfigMigrationInstanceBody] object | **参数解释**： 表示目标Redis信息。 **约束限制**： id和addrs至少填一个。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表3ConfigMigrationInstanceBody | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释**： Redis实例ID。云服务Redis必须填写。 **约束限制**： 与addrs至少填一个。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | addrs | 否 | String | **参数解释**： Redis连接地址。自建Redis必须填写。 **约束限制**： 与id至少填一个。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | password | 否 | String | **参数解释**： Redis连接密码。 **约束限制**： 如果设置了密码，则必须填写。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 迁移任务ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 迁移任务名称。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 迁移任务状态，这个字段的值包括：SUCCESS, FAILED, MIGRATING，TERMINATED **取值范围**： - FULLMIGRATING：全量迁移中。 - SUCCESS：迁移成功。 - FAILED：迁移失败。 - MIGRATING：迁移中。 - TERMINATED：已终止。 | | error | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | #### 请求示例 配置在线迁移任务，迁移方式为增量迁移，开启自动重连，配置源端和目标端实例信息。 ``` 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" : null } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 配置在线迁移任务，迁移方式为增量迁移，开启自动重连，配置源端和目标端实例信息。 ``` 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("")) .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.SetOnlineMigrationTaskBody.fromValue("auto")); body.withMigrationMethod(SetOnlineMigrationTaskBody.SetOnlineMigrationTaskBody.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()); } } } ``` - [Python] 配置在线迁移任务，迁移方式为增量迁移，开启自动重连，配置源端和目标端实例信息。 ``` # 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("")) \ .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) ``` - [Go] 配置在线迁移任务，迁移方式为增量迁移，开启自动重连，配置源端和目标端实例信息。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dcs.DcsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dcs.NewDcsClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/DCS/sdk?api=SetOnlineMigrationTask&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 配置在线数据迁移任务成功。 | | 400 | 非法请求。 | | 401 | 认证信息非法。 | | 403 | 请求被拒绝访问。 | | 404 | 所请求的资源不存在。 | | 500 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。