查看实例和节点的健康状态。
接口说明
本接口用于查看存储弹性模式和 Serverless 版本的 AnalyticDB PostgreSQL 版的实例、协调节点(也称 Master 节点)以及计算节点(也称 Segment 节点)的健康状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
gpdb:DescribeHealthStatus | get | *DBInstance acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
| gp-bp12ga6v69h86**** |
Key | string | 是 | 性能参数名称,多个指标用英文半角(,)分隔,具体信息,请参见性能参数表。 | node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status |
返回参数
示例
正常返回示例
JSON
格式
{
"Status": {
"adbpg_status": {
"Status": "healthy",
"Value": 1
},
"adbpg_connection_status": {
"Status": "healthy",
"Value": 1.71
},
"adbpg_disk_status": {
"Status": "healthy",
"Value": 1.52
},
"adbpg_disk_usage_percent": {
"Status": "healthy",
"Value": 1.52
},
"adbpg_master_disk_usage_percent_max": {
"Status": "healthy",
"Value": 1.34
},
"adbgp_segment_disk_usage_percent_max": {
"Status": "healthy",
"Value": 1.52
},
"node_master_status": {
"Status": "healthy",
"Value": 1
},
"node_segment_disk_status": {
"Status": "healthy",
"Value": 1.52
},
"node_master_connection_status": {
"Status": "healthy",
"Value": 1.71
},
"node_segment_connection_status": {
"Status": "healthy",
"Value": 0.48
},
"adbpg_master_status": {
"Status": "healthy",
"Value": 1
},
"adbpg_segment_status": {
"Status": "healthy",
"Value": 1
},
"adbpg_instance_total_data_gb": {
"Value": 4.1
},
"adbpg_instance_hot_data_gb": {
"Value": 4.1
},
"adbpg_instance_cold_data_gb": {
"Value": 0
}
},
"RequestId": "D97B4191-104D-10CE-8BC5-53**********",
"DBClusterId": "gp-bp12ga6v69h86****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-06-30 | OpenAPI 返回结构发生变更 | 查看变更详情 |