开发者社区 问答 正文

API参考 - API参考 -监控管理 - DescribeResourceUsage



描述


查看实例的资源利用信息。返回用户的某个实例的已用空间大小,通过DBInstanceId来获取实例资源使用情况。

请求参数

[tr=rgb(51, 205, 229)][td]名称 类型是否必须描述ActionString是系统规定参数,取值:DescribeResourceUsage。DBInstanceIdString是实例名。

返回参数

[tr=rgb(51, 205, 229)][td]名称 类型描述<公共返回参数>无详见公共参数。DBInstanceIdString实例名。EngineString数据库类型。DiskUsedInteger已用空间(DataSize+LogSize),单位:Byte,-1表示没有数据。DataSizeInteger数据文件占用空间,单位:Byte,-1表示没有数据。LogSizeInteger日志占用空间,单位:Byte,-1表示没有数据。BackupSizeInteger备份占用空间,单位:Byte,-1表示没有数据。ColdBackupSizeInteger冷备的存储量,单位:Byte,-1表示没有数据。[tr=rgb(239, 251, 255)][td]SQLSize IntegerSQL的存储量,单位:Byte,-1表示没有数据。

展开
收起
梨好橙 2018-09-15 22:37:43 1460 分享 版权
阿里云 AI 助理回答

为了查看指定实例的资源利用信息,特别是已用空间大小,您可以通过调用阿里云RDS服务的DescribeResourceUsage接口来实现。以下是调用该接口所需的具体步骤和参数说明:

请求参数

  1. Action: String 类型, 必须参数,固定取值为 DescribeResourceUsage
  2. DBInstanceId: String 类型, 必须参数,表示您想查询的RDS实例ID。您可以通过其他API如DescribeDBInstances先获取到这个ID。

返回参数说明

当调用成功后,接口将返回以下与实例资源使用情况相关的关键参数:

  • DBInstanceId: 实例名,确认所查询的实例。
  • Engine: 数据库类型,例如MySQL、PostgreSQL等。
  • DiskUsed: 已用空间大小,单位为Byte。此值是数据文件(DataSize)和日志文件(LogSize)占用空间的总和,若为-1则表示没有数据。
  • DataSize: 数据文件占用的空间大小,单位为Byte,-1表示没有数据。
  • LogSize: 日志占用的空间大小,单位为Byte,-1表示没有数据。
  • BackupSize: 备份占用的总空间(包括数据备份和日志备份),单位为Byte,-1表示没有数据。
  • ColdBackupSize: 冷备存储量,单位为Byte,-1表示没有数据。
  • SQLSize: SQL的存储量,单位为Byte,-1表示没有数据。

调用示例及注意事项

  • 调用方式: 您可以在阿里云OpenAPI Explorer中直接调试此接口,无需手动计算签名,系统会自动生成SDK代码示例以供集成。
  • 权限需求: 确保调用账号具有rds:DescribeResourceUsage的操作权限,这通常需要在RAM角色中配置相应的策略。
  • 异常处理: 如果遇到错误,请参考错误码文档进行排查,常见的问题可能涉及实名认证、账户额度、地域运营状态等。

通过上述步骤,您可以准确地获取到指定RDS实例的资源使用详情,特别是已用空间大小。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答