接口功能介绍
创建健康检查
接口约束
无
URI
POST /v4/elb/create-health-check
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 | |
| regionID | 是 | String | 区域ID | ||
| name | 是 | String | 唯一。支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 - 32 | acl11 | |
| description | 否 | String | 支持拉丁字母、中文、数字, 特殊字符： |
||
| protocol | 是 | String | 健康检查协议。取值范围：TCP、UDP、HTTP | ||
| timeout | 否 | Integer | 健康检查响应的最大超时时间，取值范围：2-60秒，默认为2秒 | 2 | |
| interval | 否 | Integer | 负载均衡进行健康检查的时间间隔，取值范围：1-20940秒，默认为5秒 | 5 | |
| maxRetry | 否 | Integer | 最大重试次数，取值范围：1-10次，默认为2次 | 2 | |
| httpMethod | 否 | String | 仅当protocol为HTTP时必填且生效,HTTP请求的方法默认GET，{GET/HEAD/POST/PUT/DELETE/TRACE/OPTIONS/CONNECT/PATCH} | ||
| httpUrlPath | 否 | String | 仅当protocol为HTTP时必填且生效,默认为'/',支持的最大字符长度：80 | ||
| httpExpectedCodes | 否 | Array of Strings | 仅当protocol为HTTP时必填且生效,支持http_2xx/http_3xx/http_4xx/http_5xx，一个或者多个的列表, 当 protocol 为 HTTP 时, 不填默认为 http_2xx |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 |
| error | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ID | String | 健康检查ID | hc-4xvz5g2y5h |
枚举参数
无
请求示例
请求url
POST /v4/elb/create-health-check
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "tianyi-2-http",
"protocol": "HTTP",
"timeout": 3,
"interval": 1,
"maxRetry": 1,
"httpMethod": "GET",
"httpUrlPath": "",
"httpExpectedCodes": [
"http_2xx"
],
"description": "tianyi-2",
"clientToken": "123e4567-b89b-12d3-a456-62665544001"
}
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"ID": "hc-4xvz5g2y5h"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
