文档首页/ 云数据库 RDS/ API参考/ API v3/ 实例管理/ 总览页面实例统计 - CollectInstanceStatistic
更新时间:2026-09-20 GMT+08:00
分享

总览页面实例统计 - CollectInstanceStatistic

功能介绍

总览页面实例统计。

调试

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

授权信息

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

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds:instance:listAll

read

-

-

rds:instance:list

-

URI

  • URI格式

    GET /v3/{project_id}/instances/statistic

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    参数解释:

    租户在某一region下的project ID。

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

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

请求消息

表2 参数说明

参数

是否必选

参数类型

描述

engine

否

String

参数解释:

引擎类型。

约束限制:

不涉及。

取值范围:

  • mysql
  • postgresql
  • sqlserver

默认取值:

不涉及。

请求示例

总览页面实例统计。

GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/statistic?engine=postgresql

响应消息

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

    参数

    参数类型

    描述

    total_num

    Integer

    参数解释:

    实例总数。

    取值范围:

    不涉及。

    abnormal_num

    Integer

    参数解释:

    异常实例数。

    取值范围:

    不涉及。

    disk_full_num

    Integer

    参数解释:

    磁盘不足实例数。

    取值范围:

    不涉及。

    frozen_num

    Integer

    参数解释:

    冻结实例数。

    取值范围:

    不涉及。

    normal_num

    Integer

    参数解释:

    运行中实例数。

    取值范围:

    不涉及。

    wait_reboot_num

    Integer

    参数解释:

    等待重启实例数。

    取值范围:

    不涉及。

  • 正常响应样例
    {
      "total_num": 10,
      "abnormal_num": 1,
      "disk_full_num": 0,
      "frozen_num": 0,
      "normal_num": 8,
      "wait_reboot_num": 1
    }

状态码

错误码

请参见错误码。

相关文档