创建备份导入任务

project_id

是

String

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

task_name

是

String

备份导入任务名称。

description

否

String

备份导入任务描述。

migration_type

是

String

迁移任务类型。

取值范围：

• backupfile_import：表示备份文件导入。

• online_migration：表示在线迁移。目前已不支持使用该接口创建在线迁移任务，请调用CreateOnlineMigrationTask创建在线迁移任务。

migration_method

是

String

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

取值范围：

• full_amount_migration：表示全量迁移。

• incremental_migration：表示增量迁移。

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

数据来源

• self_build_obs：实例备份记录。

• backup_record：OBS桶数据。

bucket_name

否

String

OBS桶名，如果数据来源是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。只有当源Redis数据为DCS Proxy集群实例，且开启了多DB（Proxy实例multi-db参数值为yes）时需要配置为true。其他场景无需配置。

约束限制：

非多DB Proxy集群源实例如果配置该参数为开启，可能会导致任务失败。

取值范围：

• true：开启。

• false：未开启。

默认取值：

false

db

否

String

Redis数据库（DB）。指定DB进行迁移，例如填写5，表示只迁移DB5。不填写时迁移全部DB。多DB实例的取值范围是0~255。

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数据库（DB）。例如填写5，表示将数据都写入到指定的DB5中，不填写表示不指定。多DB实例的取值范围是0~255。

id

String

迁移任务ID。

name

String

迁移任务名称。

status

String

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

error

String

错误信息。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

200

创建备份导入任务成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。