文档首页/ 文档数据库服务 DDS/ API参考（联盟区域）/ API v3（推荐）/ 备份与恢复/ 获取可恢复的数据库集合列表
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

获取可恢复的数据库集合列表

接口说明

获取可恢复的数据库集合列表。

约束说明

该接口只支持副本集实例。

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-collection?db_name={db_name}&restore_time={restore_time}&offset={offset}&limit={limit}

表1 参数说明

名称

类型

是否必选

描述

X-Language

String

否

语言。

project_id

String

是

租户在某一Region下的Project ID。请参考获取项目ID章节获取项目编号。

instance_id

String

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

db_name

String

是

数据库名称。

restore_time

String

是

恢复时间点。

UNIX时间戳格式，单位是毫秒，时区是UTC。

offset

Integer

否

索引位置偏移量。

  • 取值大于或等于0，且为Integer类型。
  • 不传该参数时，查询偏移量默认为0。

limit

Integer

否

查询个数上限值。

  • 取值范围：1~100。
  • 不传该参数时，默认查询前100条信息。

请求参数

表2 请求Header参数

名称

类型

是否必选

描述

X-Auth-Token

String

是

用户Token。

响应参数

  • 参数说明
    表3 参数说明

    名称

    参数类型

    是否必选

    描述

    collections

    Array of objects

    是

    集合列表，列表中每个元素表示一个集合。

    total_count

    Integer

    是

    集合总数。
    表4 参数说明

    名称

    参数类型

    是否必选

    描述

    name

    String

    是

    集合名称。
  • 响应示例 
    {
  "collections": [
    "dds-test"
  ],
  "total_count": 1
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 备份与恢复