功能介绍
创建健康检查。
调用方法
请参见如何调用API。
URI
POST /v1/health-checks
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
endpoint_group_id |
是 |
String |
终端节点 组ID。 最小长度：0 最大长度：36 |
|
protocol |
是 |
String |
健康检查的协议。 枚举值：
|
|
port |
是 |
Integer |
健康检查的端口。 最小值：1 最大值：65535 |
|
interval |
是 |
Integer |
健康检查的时间间隔，单位为秒。 最小值：1 最大值：60 |
|
timeout |
是 |
Integer |
健康检查的超时时间，单位为秒。建议该值小于interval的值。 最小值：1 最大值：60 |
|
max_retries |
是 |
Integer |
最大重试次数。将终端节点的状态从“健康”设置为“不健康”或从“不健康”设置为“健康”所需的连续健康检查次数。 最小值：1 最大值：10 |
|
enabled |
是 |
Boolean |
是否开启健康检查。 |
响应参数
状态码： 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
健康检查ID。 |
|
endpoint_group_id |
String |
终端节点组ID。 |
|
protocol |
String |
健康检查的协议。 枚举值：
|
|
status |
String |
配置状态，取值：
枚举值：
|
|
port |
Integer |
健康检查的端口。 最小值：1 最大值：65535 |
|
interval |
Integer |
健康检查的时间间隔，单位为秒。 最小值：1 最大值：60 |
|
timeout |
Integer |
健康检查的超时时间，单位为秒。建议该值小于interval的值。 最小值：1 最大值：60 |
|
max_retries |
Integer |
最大重试次数。将终端节点的状态从“健康”设置为“不健康”或从“不健康”设置为“健康”所需的连续健康检查次数。 最小值：1 最大值：10 |
|
created_at |
String |
创建时间。 |
|
updated_at |
String |
更新时间。 |
|
domain_id |
String |
租户ID。 |
|
enabled |
Boolean |
是否开启健康检查。 |
|
frozen_info |
云服务 或资源实例冻结信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
Integer |
云服务或资源实例状态，取值：
最小值：0 最大值：2 |
|
effect |
Integer |
在冻结/解冻操作下，取值：
最小值：1 最大值：3 缺省值：1 |
|
scene |
Array of strings |
更新云服务状态的业务场景列表，取值：
最大长度：16 |
请求示例
创建并开启健康检查，TCP协议，端口为3333，间隔时间和超时时间均为30秒，最大重试次数1次。
POST https://{ga_endpoint}/v1/health-checks
{
"health_check" : {
"endpoint_group_id" : "3a9f50bb-f041-4eac-a117-82472d8a0007",
"protocol" : "TCP",
"port" : 3333,
"interval" : 30,
"timeout" : 30,
"max_retries" : 1,
"enabled" : true
}
}
响应示例
状态码： 201
创建成功
{
"health_check" : {
"id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7442",
"endpoint_group_id" : "3a9f50bb-f041-4eac-a117-82472d8a0007",
"protocol" : "TCP",
"status" : "ACTIVE",
"port" : 3333,
"interval" : 30,
"timeout" : 30,
"max_retries" : 1,
"created_at" : "2019-01-08T01:21:37.151Z",
"updated_at" : "2019-01-08T01:21:37.151Z",
"domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
"enabled" : true,
"frozen_info" : {
"status" : 2,
"effect" : 1,
"scene" : [ "ARREAR", "POLICE" ]
}
},
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
创建成功 |
错误码
请参见错误码。
