接口功能介绍
获取健康检查列表
接口约束
URI
GET /v4/elb/list-health-check
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 否 | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | |
| regionID | String | 是 | 区域ID | |
| IDs | Array of String | 否 | 健康检查ID列表 | |
| name | String | 否 | 健康检查名称, 只能由数字，字母，-组成不能以数字和-开头，最大长度32 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| 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 | Array of Objects | 接口业务数据 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| regionID | String | 区域ID | |
| azName | String | 可用区名称 | |
| projectID | String | 项目ID | |
| ID | String | 健康检查ID | |
| name | String | 健康检查名称 | |
| description | String | 描述 | |
| protocol | String | 健康检查协议: TCP / UDP / HTTP | |
| protocolPort | Integer | 健康检查端口 | |
| timeout | Integer | 健康检查响应的最大超时时间 | |
| Integererval | Integer | 负载均衡进行健康检查的时间间隔 | |
| maxRetry | Integer | 最大重试次数 | |
| httpMethod | String | HTTP请求的方法 | |
| httpUrlPath | String | HTTP请求url路径 | |
| httpExpectedCodes | String | HTTP预期码 | |
| status | Integer | 状态 1 表示 UP, 0 表示 DOWN | 1 |
| createTime | String | 创建时间，为UTC格式 |
请求示例
GET /v4/elb/list-health-check?regionID=81f7728662dd11ec810800155d307d5b
请求体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"
},
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
