获取可恢复的数据库列表-ObtainingtheListofDatabasesThatCanBeRestored
功能介绍
获取可恢复的数据库列表。
接口约束
该接口只支持副本集实例。
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
dds:backup:getRestoreDatabases
list
-
-
dds:instance:list
-
URI
|
名称 |
是否必选 |
类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
instance_id |
是 |
String |
参数解释： 实例ID，可以调用“查询实例列表和详情-QueryingInstancesandDetails”接口获取。如果未申请实例，可以调用“创建实例-CreatingaDBInstance”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
名称 |
是否必选 |
类型 |
描述 |
|---|---|---|---|
|
restore_time |
是 |
String |
参数解释： 恢复时间点。 UNIX时间戳格式，单位是毫秒，时区是UTC。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
offset |
否 |
Integer |
参数解释： 索引位置偏移量。 约束限制： 大于或等于0。 取值范围： 不涉及。 默认取值： 0，查询偏移量默认为0。 |
|
limit |
否 |
Integer |
参数解释： 查询个数上限值。 约束限制： 不涉及。 取值范围： 1~100。 默认取值： 100，默认查询前100条信息。 |
请求参数
|
名称 |
是否必选 |
类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
|
名称 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
databases |
是 |
Array of String |
参数解释： 数据库列表，列表中每个元素表示一个数据库。 取值范围： 不涉及。 |
|
total_count |
是 |
Integer |
参数解释： 数据库总数。 取值范围： 不涉及。 |
请求示例
GET https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-database?restore_time=1607689584000&limit=10&offset=1
响应示例
{
"databases": [
"test_db"
],
"total_count": 1
}
SDK
单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
