网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

创建备份迁移任务

更新时间:2025-01-23 GMT+08:00
分享

功能介绍

该接口主要用于三种常见场景下备份迁移任务的配置。

备份迁移支持如下的常见场景:

  • 通过OBS桶备份文件进行全量数据迁移。
  • 通过OBS桶备份文件进行全量+增量数据迁移。
  • 通过RDS全量备份进行全量数据迁移。

URI

POST /v5/{project_id}/backup-migration-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

X-Auth-Token

String

从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。

表3 请求Body参数

参数

是否必选

参数类型

描述

base_info

BackupJobBaseInfo object

创建备份迁移任务基本信息体。

target_db_info

BackupJobEndpointInfo object

备份迁移任务恢复目标RDS for SQL Server实例信息。

backup_info

BackupInfo object

备份文件信息。

options

BackupRestoreOptionInfo object

备份迁移相关配置参数。

表4 BackupJobBaseInfo

参数

是否必选

参数类型

描述

name

String

任务名称。 约束:任务名称在4位到50位之间,不区分大小写,可以包含字母、数字、中划线或下划线,不能包括其他特殊字符。

- 最小长度:4

- 最大长度:50

engine_type

String

数据库引擎。

- sqlserver:RDS for SQL Server引擎

description

String

任务描述。

tags

Array of ResourceTag objects

标签信息。

标签的值可以包含任意语种字母、数字、空格和_ . : / = + - @。

enterprise_project_id

String

企业项目ID。

表5 ResourceTag

参数

是否必选

参数类型

描述

key

String

标签键。

约束:最大长度36,只能包含字母、数字、下划线、中划线和中文。

value

String

标签值。标签的值可以包含任意语种字母、数字、空格和_ . : / = + - @。

表6 BackupJobEndpointInfo

参数

是否必选

参数类型

描述

target_instance_id

String

备份迁移任务恢复目标RDS for SQL Server实例ID。

ms_file_stream_status

String

目标实例是否开启FileStream模式。可通过RDS for SQL Server详情接口获取。

file_id

String

RDS for SQL Server备份文件的文件ID,通过RDS全量恢复时必填。可通过云数据库RDS备份管理页面获取。

表7 BackupInfo

参数

是否必选

参数类型

描述

file_source

String

备份文件来源:(全部大写)

  • OBS:存放在OBS中的备份文件。
  • RDS:RDS实例的备份文件。

bucket_name

String

OBS桶名称,使用OBS桶备份文件恢复时必填。

约束:长度范围为3~63个字符,仅支持小写字母、数字、中划线(-)、点(.),且只能以字母或数字开头和结尾,禁止使用IP地址。

如果选择从OBS桶获取备份文件必填,登录OBS Browser客户端,首页为OBS桶列表,可以获取到备份文件所在桶的名称。

files

Array of BackupFileInfo objects

备份文件信息列表。

表8 BackupFileInfo

参数

是否必选

参数类型

描述

name

String

备份文件名称。

obs_path

String

OBS桶中文件路径。

OBS场景:必选

RDS场景:缺省

rds_version

String

bak文件数据库版本。

OBS场景:缺省

RDS场景:必选

rds_source_instance_id

String

bak文件所属实例。

OBS场景:缺省

RDS场景:必选

表9 BackupRestoreOptionInfo

参数

是否必选

参数类型

描述

is_cover

Boolean

是否覆盖目标数据库,不填默认为false。

值为“true”表示覆盖。

值为“false”表示不覆盖。

is_default_restore

Boolean

是否默认恢复,默认恢复所有数据库。

“true”是代表默认恢复还原备份文件中的全部数据库。

“false”代表需要在db_names这个字段中指定需要恢复的数据库名。

is_last_backup

Boolean

一次典型的增量恢复过程,会涉及多次恢复增量备份。每个增量备份恢复均会使目标数据库保持还原中状态,此时数据库不可读写,直至最后一个增量备份恢复完成后,数据库才能变成可用状态。此后数据库将无法继续进行增量恢复,所以确定为最后一个备份的场景有:

一次性全量迁移,后续将不再进行增量恢复时,设置该字段值为“true”。

增量恢复流程中,确定为最后割接阶段的最后一个增量备份时,设置该字段值为“false”。

is_precheck

Boolean

是否执行预校验。

true:执行。

false:不执行。

recovery_mode

String

恢复模式:

“full”表示全量迁移。

“incre”表示增量迁移 。

db_names

Array of strings

数据库名称。

reset_db_name_map

Map<String,String>

该字段为一个map,目前使用格式key是"",value是新数据库名字。

该功能将忽略备份文件中原有的数据库名,通过DRS将其恢复为指定的新数据库名。

使用条件:

  • 备份文件中只有一个数据库。
  • 备份文件是全量备份类型(待恢复备份类型选择:全量备份),且是一次性恢复(最后一个备份选择:是)。

is_delete_backup_file

Boolean

该参数控制使用OBS桶中备份文件恢复时,当任务结束时是否删除下载到RDS for SQL server磁盘中的OBS备份文件,默认删除。

  • true 删除
  • false 不删除

响应参数

状态码: 200

表10 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

状态码: 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

  • 通过OBS备份文件进行全量备份恢复。
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs
    
    {
      "base_info" : {
        "name" : "DRS-7526",
        "engine_type" : "sqlserver",
        "enterprise_project_id" : "0",
        "description" : "目标RDS实例名称:rds-sqlserver-2022-stand",
        "tags" : [ ]
      },
      "target_db_info" : {
        "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04",
        "ms_file_stream_status" : "off",
        "file_id" : ""
      },
      "backup_info" : {
        "file_source" : "OBS",
        "bucket_name" : "zyy-obs",
        "files" : [ {
          "name" : "1706510914000_0_Test_Database.bak",
          "obs_path" : ""
        } ]
      },
      "options" : {
        "is_cover" : true,
        "recovery_mode" : "full",
        "is_default_restore" : true,
        "is_last_backup" : true,
        "reset_db_name_map" : { },
        "is_precheck" : true,
        "is_delete_backup_file" : true,
        "db_names" : [ "" ]
      }
    }
  • RDS备份文件备份恢复。
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs
    
    {
      "base_info" : {
        "name" : "DRS-7526",
        "engine_type" : "sqlserver",
        "enterprise_project_id" : "0",
        "description" : "miao'shu",
        "tags" : [ ]
      },
      "target_db_info" : {
        "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04",
        "ms_file_stream_status" : "off",
        "file_id" : "0d87037d934848999fdc10bbabb08e6fbr04"
      },
      "backup_info" : {
        "file_source" : "RDS",
        "files" : [ {
          "name" : "",
          "obs_path" : "",
          "rds_version" : "2019_EE",
          "rds_source_instance_id" : "7fb189b57339473a929d41dabb3878a2in04"
        } ]
    
    
      },
      "options" : {
        "is_precheck" : true,
        "recovery_mode" : "",
        "is_last_backup" : "",
        "reset_db_name_map" : {
          "db_test12" : "",
          "db_hailiang_schema" : "",
          "db_sqls2v5_01" : ""
        },
        "db_names" : [ "db_test12", "db_hailiang_schema", "db_sqls2v5_01" ]
      }
    }
  • 通过OBS桶备份文件进行全量+增量备份恢复。

    首先进行一次全量迁移,is_last_backup选择“false”。

    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs
    
    {
      "base_info" : {
        "name" : "DRS-7527",
        "engine_type" : "sqlserver",
        "enterprise_project_id" : "0",
        "description" : "描述",
        "tags" : [ ]
      },
      "target_db_info" : {
        "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04",
        "ms_file_stream_status" : "off",
        "file_id" : ""
      },
      "backup_info" : {
        "file_source" : "OBS",
        "bucket_name" : "zyy-obs",
        "files" : [ {
          "name" : "ims.bak",
          "obs_path" : "floder/"
        } ]
      },
      "options" : {
        "is_cover" : true,
        "recovery_mode" : "full",
        "is_default_restore" : true,
        "is_last_backup" : false,
        "reset_db_name_map" : { },
        "is_precheck" : true,
        "is_delete_backup_file" : true,
        "db_names" : [ "" ]
      }
    }
  • 通过OBS桶备份文件进行全量+增量备份恢复。

    全量迁移完成后,然后进行一次增量迁移。如果不止一个增量备份文件,is_last_backup依然选择“false”。

    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs
    
    {
      "base_info" : {
        "name" : "DRS-7527",
        "engine_type" : "sqlserver",
        "enterprise_project_id" : "0",
        "description" : "描述",
        "tags" : [ ]
      },
      "target_db_info" : {
        "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04",
        "ms_file_stream_status" : "off",
        "file_id" : ""
      },
      "backup_info" : {
        "file_source" : "OBS",
        "bucket_name" : "zyy-obs",
        "files" : [ {
          "name" : "ims_log1.bak",
          "obs_path" : "floder/"
        } ]
      },
      "options" : {
        "is_cover" : true,
        "recovery_mode" : "incre",
        "is_default_restore" : true,
        "is_last_backup" : false,
        "reset_db_name_map" : { },
        "is_precheck" : true,
        "is_delete_backup_file" : true,
        "db_names" : [ "" ]
      }
    }
  • 通过OBS桶备份文件进行全量+增量备份恢复。

    停止数据库业务,进行最后一次增量迁移,is_last_backup选择“true”。

    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs
    
    {
      "base_info" : {
        "name" : "DRS-7527",
        "engine_type" : "sqlserver",
        "enterprise_project_id" : "0",
        "description" : "描述",
        "tags" : [ ]
      },
      "target_db_info" : {
        "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04",
        "ms_file_stream_status" : "off",
        "file_id" : ""
      },
      "backup_info" : {
        "file_source" : "OBS",
        "bucket_name" : "zyy-obs",
        "files" : [ {
          "name" : "ims_log2.bak",
          "obs_path" : "floder/"
        } ]
      },
      "options" : {
        "is_cover" : true,
        "recovery_mode" : "incre",
        "is_default_restore" : true,
        "is_last_backup" : true,
        "reset_db_name_map" : { },
        "is_precheck" : true,
        "is_delete_backup_file" : true,
        "db_names" : [ "" ]
      }
    }

响应示例

状态码: 200

OK

{
  "job_id" : "0667845a-6291-4e2a-95b0-190c0abjb703"
}

状态码: 400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容