文档首页/ 云数据库 RDS/ API参考/ API v3/ 实例管理/ 查询资源利用率 - GetInstancesOpsResourceUsage
更新时间:2026-09-20 GMT+08:00
分享

查询资源利用率 - GetInstancesOpsResourceUsage

功能介绍

查询资源利用率。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds:instance:listAll

read

-

-

rds:instance:list

-

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/ops/resource-usage

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    参数解释:

    租户在某一region下的project ID。

    获取方法请参见获取项目ID。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    instance_id

    是

    String

    参数解释:

    实例ID。

    可调用查询数据库实例列表接口,通过表4中的“id”获取。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

请求消息

表2 参数说明

参数

是否必选

参数类型

描述

resource_type

否

String

参数解释:

资源类型。

约束限制:

不涉及。

取值范围:

  • cpu:CPU资源。
  • mem:内存资源。
  • disk:磁盘资源。
  • disk_week:周磁盘资源。
  • io:IO资源。

默认取值:

不涉及。

请求示例

查询资源利用率。

GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/e28979107ed04d3b8b2f1b819b8d2be3in03/ops/resource-usage?resource_type=cpu

响应消息

  • 正常响应要素说明
    表3 参数说明

    参数

    参数类型

    描述

    cpu

    Object

    参数解释:

    CPU资源信息。详情请参见表4 字段说明。

    mem

    Object

    参数解释:

    内存资源信息。详情请参见表4 字段说明。

    disk

    Object

    参数解释:

    磁盘资源信息。详情请参见表4 字段说明。

    io

    Object

    参数解释:

    IO资源信息。详情请参见表4 字段说明。

    表4 资源利用率相关字段说明

    参数

    参数类型

    描述

    value

    Double

    参数解释:

    资源当前使用量。

    取值范围:

    不涉及。

    total

    Double

    参数解释:

    资源总量。

    取值范围:

    不涉及。

    contrast

    Double

    参数解释:

    与昨日的同比值。

    取值范围:

    不涉及。

    unit

    String

    参数解释:

    资源单位。

    取值范围:

    不涉及。

  • 正常响应样例
    {
      "cpu": {
        "value": 1.01,
        "total": 2.0,
        "contrast": 0.54,
        "unit": "core"
      },
      "mem": {
        "value": 2.61,
        "total": 8.0,
        "contrast": 2.36,
        "unit": "GB"
      },
      "disk": {
        "value": 0.42,
        "total": 40.0,
        "contrast": 0.34,
        "unit": "GB"
      },
      "io": {
        "value": 1.0,
        "total": 0.0,
        "contrast": 1.0,
        "unit": "count/s"
      }
    }

状态码

错误码

请参见错误码。

相关文档