创建专线网关健康检查
更新时间：2020-06-02
描述
为专线网关创建健康检查。
请求结构
POST /v{version}/etGateway/{etGatewayId}/healthCheck?clientToken={clientToken} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"healthCheckSourceIp":"healthCheckSourceIp",
"healthCheckType":"healthCheckSourceType",
"healthCheckPort":healthCheckSourcePort,
"healthCheckInterval":healthCheckInterval,
"healthThreshold":healthThreshold,
"unhealthThreshold":unhealthThreshold,
"autoGenerateRouteRule":true
}请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1 |
| etGatewayId | String | 是 | URL参数 | 专线网关的id |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见ClientToken幂等性 |
| healthCheckSourceIp | String | 否 | RequestBody参数 | 若不传该参数，系统会自动分配一个IP |
| healthCheckType | String | 否 | RequestBody参数 | 参数可取值为"ICMP",默认为"ICMP" |
| healthCheckPort | Integer | 否 | RequestBody参数 | 健康检查的端口 |
| healthCheckInterval | Integer | 是 | RequestBody参数 | 健康检查的间隔，1-60之间的整数，单位s |
| healthThreshold | Integer | 是 | RequestBody参数 | 健康检查阈值，2-5之间的整数 |
| unhealthThreshold | Integer | 是 | RequestBody参数 | 不健康检查阈值，2-5之间的整数 |
| autoGenerateRouteRule | Boolean | 否 | RequestBody参数 | 是否自动生成探测路由，默认开启。如需关闭，选择false。 |
返回参数
无特殊返回参数。
请求示例
POST /v1/etGateway/dcgw-4ds9x3kmds88/healthCheck?clientToken={clientToken} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"healthCheckInterval":3,
"healthThreshold":2,
"unhealthThreshold":2
}返回示例
HTTP/1.1 200 OK
x-bce-request-id: f7302165-756d-4c83-bb7a-1d4548fbba8c
Cache-Control: no-cache
Server: BWS