# 查询监控大盘列表 - ListInstancesResourceMetrics #### 功能介绍 查询监控大盘列表。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=ListInstancesResourceMetrics)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:instance:listAll | read | - | - | rds:instance:list | - | #### URI - URI格式 GET /v3/{project_id}/instances/resource-monitoring - 参数说明 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2要素说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | engine | 是 | String | **参数解释：** 引擎类型。 **约束限制：** 不涉及。 **取值范围：** - mysql - postgresql - sqlserver **默认取值** **：** mysql | | search_field | 否 | String | **参数解释：** 按实例名称模糊搜索。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及 | | offset | 否 | String | **参数解释：** 索引位置，偏移量。 **约束限制：** 不涉及。 **取值范围：** 大于等于0的整数。 **默认取值** **：** 0 | | limit | 否 | String | **参数解释：** 查询数据条数。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值** **：** 10 | | order | 否 | String | **参数解释：** 排序方式。 **约束限制：** 不涉及。 **取值范围：** - DESC：倒序。 - ASC：正序。 **默认取值** **：** DESC | | sort_field | 否 | String | **参数解释：** 排序字段。 **约束限制：** 不涉及。 **取值范围：** - instance_name：实例名称。 - status：运行状态。 - type：实例类型。 - cpu_usage：CPU使用率。 - memory_usage：内存使用率。 - disk_usage：磁盘使用率。 - tps：TPS。 - qps：QPS。 - iops：IOPS。 - active_connections：活跃连接数。 - slow_sql：慢SQL数。 **默认取值** **：** instance_name | #### 请求示例 查询监控大盘列表。 ``` GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/resource-monitoring?engine=postgresql&offset=0&limit=10&order=ASC&sort_field=instance_name ``` #### 响应消息 - 正常响应要素说明 表3要素说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | resource_monitoring_infos | Array of objects | **参数解释：** 资源监控信息，详情请参见[表4]。 | 表4resource_moinitoring_info字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | instance_state | Object | **参数解释：** 实例状态，详情请参见[表5]。 | | type | String | **参数解释：** 实例类型。 **取值范围：** - Single：单机。 - Ha：主备： - Replica：只读。 | | cpu | String | **参数解释：** CPU大小。例如，1表示1U。 **取值范围：** 不涉及。 | | mem | String | **参数解释：** 内存大小，单位GB。 **取值范围：** 不涉及。 | | engine_name | String | **参数解释：** 引擎名称。 **取值范围：** - mysql - postgresql - sqlserver | | engine_version | String | **参数解释：** 引擎版本。 **取值范围：** 不涉及。 | | cpu_usage | Double | **参数解释：** CPU使用率，单位%。 **取值范围：** 不涉及。 | | memory_usage | Double | **参数解释：** 内存使用率，单位%。 **取值范围：** 不涉及。 | | disk_usage | Double | **参数解释：** 磁盘使用率，单位%。 **取值范围：** 不涉及。 | | tps | Double | **参数解释：** TPS，单位count/s。 **取值范围：** 不涉及。 | | qps | Double | **参数解释：** QPS，单位count/s。 **取值范围：** 不涉及。 | | iops | Double | **参数解释：** IOPS，单位count/s。 **取值范围：** 不涉及。 | | active_connections | Double | **参数解释：** 活跃连接数，单位count。 **取值范围：** 不涉及。 | | slow_sql | Double | **参数解释：** 慢SQL，单位count。 **取值范围：** 不涉及。 | | readonly_instance_resource_monitoring_info | Array of objects | **参数解释：** 只读实例资源监控指标。 **取值范围：** 不涉及。 | 表5instance_state字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释：** 实例状态。 **取值范围：** normal、abnormal、deleted、shutdown、data_disk_full、frozen等。 | | wait_restart_for_params | Boolean | **参数解释：** 参数变更后是否需要重启实例。 **取值范围：** - true：需要重启。 - false：不需要重启。 | - 正常响应样例 ``` { "total_count": 2, "resource_monitoring_infos": [ { "id": "0d8b0f192bez22acbc6c2f9966da791ein03", "name": "rds_001", "instance_state": { "status": "normal", "wait_restart_for_params": true }, "type": "Single", "cpu": "1", "mem": "2", "engine_name": "postgresql", "engine_version": "11.18", "cpu_usage": "12.32", "memory_usage": "15.68", "disk_usage": "7.54", "tps": "1.32", "qps": "8.25", "iops": "0.31", "active_connections": "8", "slow_sql": "2.3", "readonly_instance_resource_monitoring_info": [ ] }, { "id": "a3dwqf192bez22acbc6c2asdz6da791ein03", "name": "rds_002", "instance_state": { "status": "abnormal", "wait_restart_for_params": false }, "type": "Ha", "cpu": "2", "mem": "4", "engine_name": "postgresql", "engine_version": "12.13", "cpu_usage": "22.32", "memory_usage": "25.68", "disk_usage": "17.24", "tps": "4.32", "qps": "3.25", "iops": "0.51", "active_connections": "3", "slow_sql": "3.2", "readonly_instance_resource_monitoring_info": [ ] } ] } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。