DescribeBackupDBs_云数据库 MongoDB 版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

您可以调用 CreateDBInstance 接口进行单库恢复。更多信息,请参见 MongoDB 单库恢复

调用本接口时,实例必须满足以下条件:

  • 实例的创建时间晚于 2019 年 3 月 26 日。
  • 实例属于华北 1、华北 2、华北 3、华北 5、华东 1、华东 2、华南 1 或亚太东南 1(新加坡)地域。
  • 实例类型为副本集实例。
  • 实例版本须为 3.4、4.0、4.2 本地盘版本。
  • 实例存储引擎必须为 WiredTiger。

流控信息

请求速率为200/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dds:DescribeBackupDBs
Get
Instance
acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

字段名称字段详情
PageNumberinteger<int32>

页码,取值为大于 0 且不超过 Integer 数据类型的最大值,默认值为 1

示例值:1取值 >= 1
PageSizeinteger<int32>

每页可展示的记录数。取值: 30(默认值)、50100

示例值:30枚举值:3050100
SourceDBInstancestring

待恢复数据的源实例 ID。

示例值:dds-bp2286****
RestoreTimestring

实例所需恢复的时间点,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。展开详情

示例值:2019-08-22T12:00:00Z
BackupIdstring

备份 ID。展开详情

示例值:5664****参考取值来源:
    CreateBackup
    DescribeBackups
ResourceGroupIdstring

资源组 ID。

示例值:rg-ax68****

返回参数

字段名称字段详情
TotalCountinteger<int32>

查询结果中数据库的数量。

示例值:5
Databasesobject
RequestIdstring

请求 ID。

示例值:1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455
PageSizeinteger<int32>

每页可展示的记录数。

示例值:30
PageNumberinteger<int32>

页码。

示例值:1

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidMeta.WrongFormat
Meta information is wrong formatter.诊断
400
InvalidRestoreTime.Format
Specified restore time is not valid.诊断
403
InvalidDBName
The specified database name is not allowed.诊断
403
InvalidMeta.TooLarge
Meta information is too large.诊断
403
SingleDBRestore.BackupSetNotSupport
This backup set do not support this operation.诊断
403
IncorrectDBInstanceType
Current DB instance type does not support this operation.诊断
403
IncorrectEngineVersion
Current engine version does not support operations.诊断
403
InvalidBackupLogStatus
Current backup log enable status does not support this operation.诊断
403
IncorrectBackupSetState
Current backup set state does not support operations..诊断
404
InvalidBackupSetID.NotFound
Specifiedbackup set ID does not exist.诊断
404
InvalidBackup.NotFound
Theavailable backup does not exist in recovery time.诊断

变更历史

暂无变更历史

相关示例

用于执行单库恢复前,查询指定的时间点或备份集内包含的数据库
2021-11-22