文档首页/数据复制服务 DRS/API参考/API v5（公测中）/备份迁移/查询备份迁移任务详细信息 - ShowReplicationJob
更新时间：2025-12-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询备份迁移任务详细信息 - ShowReplicationJob

功能介绍

获取指定备份迁移任务详细信息。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/backup-migration-jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

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

job_id

是

String

备份迁移任务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

请求语言类型。

  • en-us：英文
  • zh-cn：中文

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

id

String

任务ID。

status

String

任务状态。

create_time

String

任务创建时间。

finish_time

String

任务完成时间。

backup_info

BackupInfoResp object

备份文件信息。

base_info

BackupJobBaseInfo object

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

target_db_info

BackupJobEndpointInfo object

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

options

BackupRestoreOptionInfo object

备份迁移相关配置参数。

new_db_names

String

备份恢复数据库映射新名称。

instance_name

String

RDS实例名称。

error_log

String

迁移过程中失败原因。

表4 BackupInfoResp

参数

参数类型

描述

file_source

String

备份文件来源，包括OBS和RDS两种。

bucket_name

String

OBS桶名称。

file_info

Array of BackupFileResp objects

备份文件列表。

表5 BackupFileResp

参数

参数类型

描述

file_name

String

文件名称。

file_size

String

备份文件大小。

file_last_modify

String

备份文件最近修改时间。

表6 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。

表7 ResourceTag

参数

参数类型

描述

key

String

标签键。

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

value

String

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

表8 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备份管理页面获取。

表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 不删除

状态码：400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询备份迁移任务详情。

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs/341de3a3-c58a-445d-82e3-8e062b6jb703

响应示例

状态码：200

OK

{
  "id" : "0667845a-6291-4e2a-95b0-190c0abjb703",
  "status" : "SUCCESS",
  "create_time" : "2024-08-19T02:27:15Z",
  "finish_time" : "2024-08-19T02:29:03Z",
  "backup_info" : {
    "file_source" : "OBS",
    "bucket_name" : "zyy-obs",
    "file_info" : [ {
      "file_name" : "1706510914000_1_Test_Database.bak",
      "file_size" : "704KB",
      "file_last_modify" : "1706511360000"
    } ]
  },
  "base_info" : {
    "name" : "DRS-6813",
    "engine_type" : "sqlserver",
    "enterprise_project_id" : "0",
    "description" : "目标RDS实例名称：rds-sqlserver2022-stand"
  },
  "target_db_info" : {
    "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04"
  },
  "options" : {
    "is_cover" : true,
    "is_default_restore" : true,
    "is_last_backup" : false,
    "is_precheck" : true,
    "is_delete_backup_file" : false,
    "recovery_mode" : "full",
    "db_names" : [ ]
  },
  "new_db_names" : "[]",
  "instance_name" : ""
}

状态码：400

Bad Request

{
  "error_code" : "DRS.10000010",
  "error_msg" : "Job does not exist, please check job ID."
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题：备份迁移