DescribeBackupStorage - 查询实例的备份使用量

查询MongoDB云盘版副本集或分片集群的备份使用量。

接口说明

分片集群备份用量的计费规则是每个分片单独计费,本接口只支持查询单分片的备份用量。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeBackupStorage

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

实例所属的地域 ID,您可以通过调用 DescribeDBInstanceAttribute 进行查询。

cn-bejing

DBInstanceId

string

实例 ID。

dds-2zeb2d64cb46xxxx

NodeId

string

分片集群实例中 Shard 节点 ID。

说明

DBInstanceId 参数传入的是分片集群实例 ID 时,本参数为必填。

d-2zee48956b4axxxx

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

D648B367-15B6-1B42-BD4B-4XXXXXXXXX

FullStorageSize

integer

实例全量备份数据内置存储量,单位为字节(B)。

说明

云盘版实例使用快照备份,当前全量的备份的大小为快照链的大小。

789221621

LogStorageSize

integer

实例日志备份数据内置存储量,单位为字节(B)。

7892216

FreeSize

integer

实例免费备份数据额度,单位为字节(B)。

42949672960

示例

正常返回示例

JSON格式

{
  "RequestId": "D648B367-15B6-1B42-BD4B-4XXXXXXXXX",
  "FullStorageSize": 789221621,
  "LogStorageSize": 7892216,
  "FreeSize": 42949672960
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidDBInstance.Malformed Too many instance ids or instance id format is invalid.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情