文档

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

更新时间:

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

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-bejing
DBInstanceIdstring

实例 ID。

dds-2zeb2d64cb46xxxx
NodeIdstring

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

说明 DBInstanceId 参数传入的是分片集群实例 ID 时,本参数为必填。
d-2zee48956b4axxxx

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

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

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

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

7892216
FreeSizelong

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

42949672960

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400InvalidDBInstance.MalformedToo many instance ids or instance id format is invalid.

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

  • 本页导读 (1)
文档反馈