查询实例的健康检查结果
接口方法：GET
Action
DescribeHealthCheckDetail
Version
2018-06-14
请求url
/rds?Action=DescribeHealthCheckDetail&Version=2018-06-14&InstanceId=
Method
GET
描述
该接口用于查询实例的健康检查结果，当开启一个实例的健康检查之后，需要多次调用该接口进行查询。
请求参数
query
| 参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| InstanceId | 数据库的实例id，数字类型 | integer | 是 | |
| Action | DescribeHealthCheckDetail | string | 是 | |
| Version | 2018-06-14 | string | 是 |
返回参数
| 参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| RequestId | string | 是 | ||
| InstanceId | integer | 是 | ||
| HealthCheck | 健康检查的详情 | object | 是 | 详细信息见下表 |
HealthCheck
| 参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| HealthCheckEndTime | null | string | 是 | |
| AutoHealthCheckEndTime | null | string | 是 | |
| BeatPercent | null | integer | 是 | |
| ProductId | null | string | 是 | |
| AutoHealthCheckEnable | null | boolean | 是 | |
| DBInstanceIdentifier | null | string | 是 | |
| TotalHealthCheckPoint | null | integer | 是 | |
| Score | null | integer | 是 | |
| HealthCheckStartTime | null | string | 是 | |
| HealthCheckProcess | null | integer | 是 | |
| AutoHealthCheckStartTime | null | string | 是 | |
| HealthCheckCatalogs | null | array | 是 | 详细信息见下表 |
| HealthCheckBefore | null | boolean | 是 | |
| NormalItems | null | integer | 是 | |
| NeedRepairItems | null | integer | 是 | |
| HealthCheckType | null | string | 是 | |
| HealthCheckUUID | null | string | 是 |
HealthCheckCatalogs
| 参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| healthCheckPoints | null | array | 是 | 详细信息见下表 |
| healthCheckCatalogComment | null | string | 是 | |
| displayName | null | string | 是 | |
| healthCheckCatalog | null | string | 是 |
healthCheckPoints
| 参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| result | null | string | 是 | |
| healthCheckPoint | null | string | 是 | |
| displayName | null | string | 是 | |
| advises | null | array | 是 | |
| status | null | string | 是 |
状态码
| 错误码（Code） | 错误提示（Message） | http status code | 说明 |
|---|---|---|---|
| DBInstanceNotFound | dbinstance not found | 400 | 当前租户下，实例不存在 |
| InternalFailure | internal failure | 500 | 内部错误 |
请求示例
https://open.cn-east-1.163yun.com/rds?Action=DescribeHealthCheckDetail&Version=2018-06-14&InstanceId=201&<公共请求参数>
返回示例
{
"RequestId": "abc",
"HealthCheck": {
"HealthCheckUUID": "1784dd2c-4a29-44e7-92ea-55cf2851eb0a",
"ProductId": "3683188b2a614be79466ccaebf202905",
"DBInstanceIdentifier": "chjl-open-02",
"Score": 100,
"HealthCheckBefore": true,
"HealthCheckStartTime": "2019-04-09 10:11:38",
"HealthCheckEndTime": "2019-04-09 10:11:42",
"TotalHealthCheckPoint": 21,
"NormalItems": 21,
"NeedRepairItems": 0,
"BeatPercent": 100,
"HealthCheckProcess": 100,
"HealthCheckType": "MANUAL",
"AutoHealthCheckEnable": true,
"AutoHealthCheckStartTime": "00:00",
"AutoHealthCheckEndTime": "23:00",
"HealthCheckCatalogs": [
{
"healthCheckCatalog": "CheckCapacity",
"displayName": "容量规划",
"healthCheckPoints": [
{
"status": "FINISHED",
"healthCheckPoint": "CheckStorageCapacity",
"advises": [],
"displayName": "存储空间",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckMemory",
"advises": [],
"displayName": "内存",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckNetworkBindth",
"advises": [],
"displayName": "网络带宽",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckCPU",
"advises": [],
"displayName": "CPU",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckIOCapacity",
"advises": [],
"displayName": "IO能力",
"result": "SUCCESS"
}
],
"healthCheckCatalogComment": "检测当前资源是否成为瓶颈"
},
{
"healthCheckCatalog": "CheckSecurity",
"displayName": "安全检查",
"healthCheckPoints": [
{
"status": "FINISHED",
"healthCheckPoint": "CheckPrivileges",
"advises": [],
"displayName": "权限检查",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckNetworkSecurity",
"advises": [],
"displayName": "网络安全",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckPeriodHealthCheck",
"advises": [],
"displayName": "定时体检",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckWeakPassword",
"advises": [],
"displayName": "弱密码检查",
"result": "SUCCESS"
}
],
"healthCheckCatalogComment": "检查服务是否存在安全隐患"
},
{
"healthCheckCatalog": "CheckReplication",
"displayName": "主从复制",
"healthCheckPoints": [
{
"status": "FINISHED",
"healthCheckPoint": "CheckSafeReplication",
"advises": [],
"displayName": "数据安全",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckReplicationPerformance",
"advises": [],
"displayName": "复制性能",
"result": "SUCCESS"
}
],
"healthCheckCatalogComment": "检查主从复制是否存在隐患"
},
{
"healthCheckCatalog": "CheckUserVisit",
"displayName": "用户访问",
"healthCheckPoints": [
{
"status": "FINISHED",
"healthCheckPoint": "CheckMysqlDeadLock",
"advises": [],
"displayName": "死锁记录",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckSlowLog",
"advises": [],
"displayName": "慢日志统计",
"result": "SUCCESS"
}
],
"healthCheckCatalogComment": "检查用户访问是否正常"
},
{
"healthCheckCatalog": "CheckParameter",
"displayName": "参数检查",
"healthCheckPoints": [
{
"status": "FINISHED",
"healthCheckPoint": "CheckMemoryParameter",
"advises": [],
"displayName": "内存参数",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckRedoLog",
"advises": [],
"displayName": "重做日志",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckConnections",
"advises": [],
"displayName": "连接数配置",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckBinaryLog",
"advises": [],
"displayName": "二进制日志",
"result": "SUCCESS"
}
],
"healthCheckCatalogComment": "检查相关配置参数是否合理"
},
{
"healthCheckCatalog": "CheckIndex",
"displayName": "索引检查",
"healthCheckPoints": [
{
"status": "FINISHED",
"healthCheckPoint": "CheckInvalidIndex",
"advises": [],
"displayName": "无效索引",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckPrimaryKey",
"advises": [],
"displayName": "主键检查",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckIndexCardinality",
"advises": [],
"displayName": "索引区分度",
"result": "SUCCESS"
},
{
"status": "FINISHED",
"healthCheckPoint": "CheckRedundancyIndex",
"advises": [],
"displayName": "冗余索引",
"result": "SUCCESS"
}
],
"healthCheckCatalogComment": "检测索引设计是否合理"
}
]
},
"InstanceId": 201
}
