文档

DescribeResourceUsage - 查看实例的空间利用信息

更新时间:

该接口用于查询RDS实例的空间使用信息。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeResourceUsageRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
ResourceGroupIdstring

资源组 ID。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

BackupOssDataSizelong

OSS 中备份集的数据文件大小,单位:Byte。0 表示没有数据。

8821760
DiskUsedlong

已用空间(DataSize+LogSize),单位:Byte。-1 表示没有数据。

2337275904
ArchiveBackupSizelong

归档备份的占用空间,单位:Byte。

0
BackupOssLogSizelong

OSS 中备份集的日志文件大小,单位:Byte。0 表示没有数据。

44180999
BackupLogSizelong

日志备份的占用空间(不包括归档备份),单位:Byte。

45145563
BackupDataSizelong

数据备份的占用空间(不包括归档备份),单位:Byte。

94324736
ColdBackupSizelong

冷备份的占用空间,单位:Byte。-1 表示没有数据。

2337275904
DataSizelong

数据文件占用空间,单位:Byte。-1 表示没有数据。

1292094741
PaidBackupSizelong

扣除免费额度后,需要付费的备份占用空间,单位:Byte。

0
RequestIdstring

请求 ID。

F937E173-559C-4498-8D90-38D32342B9E4
LogSizelong

日志占用空间,单位:Byte。-1 表示没有数据。

1045181163
BackupSizelong

备份占用空间,单位:Byte。-1 表示没有数据。

53002759
DBInstanceIdstring

实例 ID。

rm-uf6wjk5xxxxxxx
Enginestring

数据库类型。

MySQL
SQLSizelong

SQL 的占用空间,单位:Byte。-1 表示没有数据。

315052751

示例

正常返回示例

JSON格式

{
  "BackupOssDataSize": 8821760,
  "DiskUsed": 2337275904,
  "ArchiveBackupSize": 0,
  "BackupOssLogSize": 44180999,
  "BackupLogSize": 45145563,
  "BackupDataSize": 94324736,
  "ColdBackupSize": 2337275904,
  "DataSize": 1292094741,
  "PaidBackupSize": 0,
  "RequestId": "F937E173-559C-4498-8D90-38D32342B9E4",
  "LogSize": 1045181163,
  "BackupSize": 53002759,
  "DBInstanceId": " rm-uf6wjk5xxxxxxx",
  "Engine": "MySQL",
  "SQLSize": 315052751
}

错误码

HTTP status code错误码错误信息描述
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。

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

变更历史

变更时间变更内容概要操作
2022-08-04OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
  • 本页导读 (1)
文档反馈