查看健康检查详情
更新时间 2025-10-22 18:26:46
最近更新时间: 2025-10-22 18:26:46
接口功能介绍
查看健康检查详情
接口约束
无
URI
GET /v4/elb/show-health-check
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| id | 否 | String | 健康检查ID, 后续废弃该字段 | xxxx | |
| healthCheckID | 是 | String | 健康检查ID, 推荐使用该字段, 当同时使用 id 和 healthCheckID 时，优先使用 healthCheckID | hc-m2zb05f7s8 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS | |
| returnObj | Object | 接口业务数据 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | String | 可用区名称 | az1 | |
| projectID | String | 项目ID | 0 | |
| ID | String | 健康检查ID | hc-xxx | |
| name | String | 健康检查名称 | test | |
| description | String | 描述 | desc | |
| protocol | String | 健康检查协议: TCP / UDP / HTTP | TCP | |
| protocolPort | Integer | 健康检查端口 | 0 | |
| timeout | Integer | 健康检查响应的最大超时时间 | 3 | |
| Integererval | Integer | 负载均衡进行健康检查的时间间隔 | 1 | |
| maxRetry | Integer | 最大重试次数 | 1 | |
| httpMethod | String | HTTP请求的方法 | GET | |
| httpUrlPath | String | HTTP请求url路径 | // | |
| httpExpectedCodes | String | HTTP预期码 | xxx | |
| status | Integer | 状态 1 表示 UP, 0 表示 DOWN | 1 | |
| createTime | String | 创建时间，为UTC格式 | 2022-10-03T09: 44: 22Z | |
| domainEnabled | Integer | 健康检查支持域名功能开关 | 0 | |
| domain | String | 域名 | xxx | |
| customReqRespEnabled | Integer | 自定义请求响应功能开关 | 0 | |
| customRequest | String | 自定义请求 | xxx | |
| customResponse | String | 自定义响应 | xxx |
枚举参数
无
请求示例
请求url
GET /v4/elb/show-health-check?regionID=81f7728662dd11ec810800155d307d5b&id=hc-m2zb05f7s8
请求头header
无
请求体body
无
响应示例
#### 成功响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": null,
"projectID": "0",
"ID": "hc-m2zb05f7s8",
"name": "testHTTP",
"description": "tianyi-2",
"protocol": "HTTP",
"protocolPort": 0,
"timeout": 3,
"Integererval": 1,
"maxRetry": 1,
"httpMethod": "GET",
"httpUrlPath": "",
"httpExpectedCodes": "http_2xx",
"status": 1,
"createTime": "2022-10-02T07: 27: 42Z"
}
}
#### 失败响应示例
{
"statusCode": 900,
"message": "request param error",
"description": "参数错误",
"errorCode": "Openapi.Parameter.Error"
}
状态码
请参考 状态码
错误码
请参考 错误码
