Create Express Tunnel Gateway Health Check
Last Updated：2020-08-06
Description
Create a health check for the express tunnel gateway.
Request Structure
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
}Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| etGatewayId | String | Yes | URL parameter | Id of express tunnel gateway |
| clientToken | String | No | Query parameter | The idempotence Token is a ASCII string with a length not exceeding 64 bits. Refer to ClientToken idempotence for details. |
| healthCheckSourceIp | String | No | RequestBody parameter | If this parameter is not transmitted, the system will automatically allocate an IP address. |
| healthCheckType | String | No | RequestBody parameter | The value taken for the parameter is "ICMP" by default. |
| healthCheckPort | Integer | No | RequestBody parameter | Health check port |
| healthCheckInterval | Integer | Yes | RequestBody parameter | The health check interval is an integral number between 1-60, with the unit of s. |
| healthThreshold | Integer | Yes | RequestBody parameter | The health check threshold is an integral number between 2-5. |
| unhealthThreshold | Integer | Yes | RequestBody parameter | The unhealth check threshold is an integral number between 2-5. |
| autoGenerateRouteRule | Boolean | No | RequestBody parameter | Whether to automatically generate probe routes is enabled by default. To close, select "false". |
Return Parameter
There is no special return parameter.
Request Example
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
}Return Example
HTTP/1.1 200 OK
x-bce-request-id: f7302165-756d-4c83-bb7a-1d4548fbba8c
Cache-Control: no-cache
Server: BWS