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

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

接口说明

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

约束说明

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

调试

您可以在API Explorer中调试该接口。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    dds:backup:getRestoreCollections

    list

    -

    -

    dds:instance:list

    -

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/restore-collection

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-collection?db_name=mydbx&restore_time=1607689584000&limit=10&offset=0

表1 参数说明

名称

类型

是否必选

描述

X-Auth-Token

String

是

从IAM服务获取的用户Token。请参考认证鉴权。

X-Language

String

否

语言。

project_id

String

是

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

instance_id

String

是

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

db_name

String

是

数据库名称。

restore_time

String

是

恢复时间点。

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

offset

Integer

否

索引位置偏移量。

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

limit

Integer

否

查询个数上限值。

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

请求消息

无。

响应消息

  • 参数说明
    表2 参数说明

    名称

    参数类型

    是否必选

    描述

    collections

    Array of objects

    是

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

    total_count

    Integer

    是

    集合总数。
    表3 参数说明

    名称

    参数类型

    是否必选

    描述

    name

    String

    是

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

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 备份与恢复

相关文档