文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 备份管理/ 查询可用于恢复的实例列表V3
更新时间：2026-05-21 GMT+08:00
查看PDF
分享

查询可用于恢复的实例列表V3

功能介绍

查询可用于恢复的实例列表

URI

GET /v3/{project_id}/instances/{instance_id}/backups/restorable-instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

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

instance_id

是

String

DDM实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

索引位置，偏移量。

从第一条数据偏移offset条数据后开始查询，默认为0。

取值必须为数字，且不能为负数。

limit

否

Integer

查询个数上限值。

取值范围：1~128。

不传该参数时，默认值为10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

instances

Array of DDMInstance4Restore objects

可用目标DDM。
表5 DDMInstance4Restore

参数

参数类型

描述

instance_name

String

实例名称。

instance_id

String

实例ID。

status

String

状态。

available

Boolean

是否可用。

unavailable_reason

String

无法使用原因。

vpc_name

String

虚拟私有云名称。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/backups/restorable-instances

响应示例

状态码：200

{
  "instances": [
    {
      "instance_id": "3b65c609427c4b20bc0ae93e161dc7adin09",
      "instance_name": "ddm-agent-create-instance1",
      "status": "normal",
      "available": true,
      "unavailable_reason": "",
      "vpc_name": "vpc-ddm-172"
    }
  ],
  "offset": 0,
  "limit": 10,
  "total": 1
}

状态码：400

bad request

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

状态码：500

server error

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

状态码

状态码

描述

200

ok

400

bad request

500

server error

错误码

请参见错误码。

父主题： 备份管理

相关文档