创建备份导入任务
功能介绍
创建备份导入任务。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/migration-task
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_name |
是 |
String |
备份导入任务名称。 |
description |
否 |
String |
备份导入任务描述。 |
migration_type |
是 |
String |
迁移任务类型。 取值范围:
|
migration_method |
是 |
String |
迁移方式,包括全量迁移和增量迁移两种类型。 取值范围:
|
backup_files |
否 |
BackupFilesBody object |
迁移任务类型为备份文件导入场景时的备份文件列表。 |
network_type |
否 |
String |
迁移任务类型为在线迁移时,表示源Redis和目标Redis连通的网络类型,包括vpc和vpn两种类型。目前已不支持用该接口创建在线迁移任务,请调用CreateOnlineMigrationTask创建在线迁移任务。 |
source_instance |
否 |
SourceInstanceBody object |
迁移任务类型为在线迁移场景时该参数为必填参数,表示源Redis信息。目前已不支持用该接口创建在线迁移任务,请调用CreateOnlineMigrationTask创建在线迁移任务。 |
target_instance |
是 |
TargetInstanceBody object |
表示目标Redis信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
file_source |
否 |
String |
数据来源,包含OBS桶和备份记录两种类型。 |
bucket_name |
否 |
String |
OBS桶名。 |
files |
是 |
Array of Files objects |
导入的备份文件文件列表,数据来源为OBS桶时必须填写。 |
backup_id |
否 |
String |
备份记录ID,数据来源为备份记录时必须填写。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
file_name |
是 |
String |
备份文件名。 |
size |
否 |
String |
文件大小(单位:Byte)。 |
update_at |
否 |
String |
文件最后修改时间(格式YYYY-MM-DD HH:MM:SS)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
addrs |
是 |
String |
Redis实例地址(source_instance信息中填写)。 |
password |
否 |
String |
Redis密码,如果设置了密码,则必须填写。 |
task_status |
否 |
String |
任务状态。 |
id |
否 |
String |
Redis实例ID。 |
ip |
否 |
String |
Redis IP地址。 |
port |
否 |
String |
Redis端口。 |
name |
否 |
String |
Redis名称。 |
proxy_multi_db |
否 |
Boolean |
proxy实例是否开启了多DB。 |
db |
否 |
String |
Redis数据库。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
Redis实例ID(target_instance信息中必须填写)。 |
name |
否 |
String |
Redis实例名称(target_instance信息中填写)。 |
password |
否 |
String |
Redis密码,如果设置了密码,则必须填写。 |
task_status |
否 |
String |
任务状态。 |
ip |
否 |
String |
Redis IP地址。 |
port |
否 |
String |
Redis端口。 |
addrs |
否 |
String |
Redis实例地址。 |
proxy_multi_db |
否 |
Boolean |
proxy实例是否开启了多DB。 |
db |
否 |
String |
Redis数据库。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
迁移任务ID。 |
name |
String |
迁移任务名称。 |
status |
String |
迁移任务状态,这个字段的值包括:SUCCESS(成功), FAILED(失败), MIGRATING(迁移中),TERMINATED(已结束)。 |
error |
String |
错误信息。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
请求示例
创建备份导入迁移任务,备份数据来源于OBS桶。
POST https://{dcs_endpoint}/v2/{project_id}/migration-task { "task_name" : "migration1", "description" : "Test", "migration_type" : "backupfile_import", "migration_method" : "full_amount_migration", "backup_files" : { "bucket_name" : "bucketName", "file_source" : "self_build_obs", "files" : [ { "size" : "754.0MB", "file_name" : "fileName" } ] }, "target_instance" : { "id" : "d2c8399f-bdba-43c1-8069-3ff17a1a79d5", "name" : "dcs-test", "password" : "xxxxxx" } }
响应示例
状态码: 200
创建备份导入任务成功。
{ "id" : "8aa6999e71cb638b0171f485f5266ef0", "name" : "dcs-test", "status" : "MIGRATING", "error" : "" }
SDK代码示例
SDK代码示例如下。
创建备份导入迁移任务,备份数据来源于OBS桶。
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 61 62 63 64 65 66 67 68 69 70 71 |
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.*; import java.util.List; import java.util.ArrayList; public class CreateMigrationTaskSolution { 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(); CreateMigrationTaskRequest request = new CreateMigrationTaskRequest(); CreateMigrationTaskBody body = new CreateMigrationTaskBody(); TargetInstanceBody targetInstancebody = new TargetInstanceBody(); targetInstancebody.withId("d2c8399f-bdba-43c1-8069-3ff17a1a79d5") .withName("dcs-test") .withPassword("xxxxxx"); List<Files> listBackupFilesFiles = new ArrayList<>(); listBackupFilesFiles.add( new Files() .withFileName("fileName") .withSize("754.0MB") ); BackupFilesBody backupFilesbody = new BackupFilesBody(); backupFilesbody.withFileSource(BackupFilesBody.FileSourceEnum.fromValue("self_build_obs")) .withBucketName("bucketName") .withFiles(listBackupFilesFiles); body.withTargetInstance(targetInstancebody); body.withBackupFiles(backupFilesbody); body.withMigrationMethod(CreateMigrationTaskBody.MigrationMethodEnum.fromValue("full_amount_migration")); body.withMigrationType(CreateMigrationTaskBody.MigrationTypeEnum.fromValue("backupfile_import")); body.withDescription("Test"); body.withTaskName("migration1"); request.withBody(body); try { CreateMigrationTaskResponse response = client.createMigrationTask(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()); } } } |
创建备份导入迁移任务,备份数据来源于OBS桶。
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 |
# 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 = CreateMigrationTaskRequest() targetInstancebody = TargetInstanceBody( id="d2c8399f-bdba-43c1-8069-3ff17a1a79d5", name="dcs-test", password="xxxxxx" ) listFilesBackupFiles = [ Files( file_name="fileName", size="754.0MB" ) ] backupFilesbody = BackupFilesBody( file_source="self_build_obs", bucket_name="bucketName", files=listFilesBackupFiles ) request.body = CreateMigrationTaskBody( target_instance=targetInstancebody, backup_files=backupFilesbody, migration_method="full_amount_migration", migration_type="backupfile_import", description="Test", task_name="migration1" ) response = client.create_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) |
创建备份导入迁移任务,备份数据来源于OBS桶。
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 61 62 63 64 65 66 67 |
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.CreateMigrationTaskRequest{} nameTargetInstance:= "dcs-test" passwordTargetInstance:= "xxxxxx" targetInstancebody := &model.TargetInstanceBody{ Id: "d2c8399f-bdba-43c1-8069-3ff17a1a79d5", Name: &nameTargetInstance, Password: &passwordTargetInstance, } sizeFiles:= "754.0MB" var listFilesBackupFiles = []model.Files{ { FileName: "fileName", Size: &sizeFiles, }, } fileSourceBackupFiles:= model.GetBackupFilesBodyFileSourceEnum().SELF_BUILD_OBS bucketNameBackupFiles:= "bucketName" backupFilesbody := &model.BackupFilesBody{ FileSource: &fileSourceBackupFiles, BucketName: &bucketNameBackupFiles, Files: listFilesBackupFiles, } descriptionCreateMigrationTaskBody:= "Test" request.Body = &model.CreateMigrationTaskBody{ TargetInstance: targetInstancebody, BackupFiles: backupFilesbody, MigrationMethod: model.GetCreateMigrationTaskBodyMigrationMethodEnum().FULL_AMOUNT_MIGRATION, MigrationType: model.GetCreateMigrationTaskBodyMigrationTypeEnum().BACKUPFILE_IMPORT, Description: &descriptionCreateMigrationTaskBody, TaskName: "migration1", } response, err := client.CreateMigrationTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
创建备份导入任务成功。 |
400 |
非法请求。 |
401 |
认证信息非法。 |
403 |
请求被拒绝访问。 |
404 |
所请求的资源不存在。 |
500 |
内部服务错误。 |
错误码
请参见错误码。