接口功能介绍
创建健康检查。
接口约束
无。
URI
POST /v4/elb/create-health-check
请求参数
请求体Body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 是 | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | |
| regionID | String | 是 | 区域ID | |
| projectID | String | 否 | 企业项目ID，默认为"0" | 0 |
| name | String | 是 | 名称，唯一。支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 - 32 | |
| description | String | 否 | 描述,内容限制：1、长度限制128 2、支持汉字，大小写字母，数字 3、支持英文特殊字符：~!@#$%^&*()_-+=<>?:"{} | |
| protocol | String | 是 | 健康检查协议。取值范围：TCP、UDP、HTTP | |
| timeout | Integer | 否 | 健康检查响应的最大超时时间，取值范围：2-60秒，默认为2秒 | |
| interval | Integer | 否 | 负载均衡进行健康检查的时间间隔，取值范围：1-20940秒，默认为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 | String of Array | 否 | 仅当protocol为HTTP时必填且生效,支持{http_2xx/http_3xx/http_4xx/http_5xx}一个或者多个的列表 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | 错误信息的英文描述 | |
| description | String | 返回信息说明，如果请求成功，返回空字符串；否则为错误信息。 | |
| errCode | String | 错误描述 | |
| returnObj | Object | 接口业务数据 |
表 returnObj
| 参数 | 参数类型 | 说明 |
|---|---|---|
| ID | String | 健康检查ID |
请求示例
POST /v4/elb/create-health-check
请求体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"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
