forked from docs/doc-exports
309 lines
31 KiB
HTML
309 lines
31 KiB
HTML
<a name="elb_jd_jk_0001"></a><a name="elb_jd_jk_0001"></a>
|
|
|
|
<h1 class="topictitle1">Configuring a Health Check</h1>
|
|
<h4 class="sectiontitle">Function</h4><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p18890664">This API is used to configure a health check for backend ECSs.</p>
|
|
|
|
<h4 class="sectiontitle">URI</h4><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p58685418">POST /v1.0/{project_id}/elbaas/healthcheck</p>
|
|
|
|
<table cellpadding="4" cellspacing="0" summary="" id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_table33323423" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row8420641"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.5.1.1"><p id="elb_jd_jk_0001__en-us_topic_0096561512_p75506301858">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.3.2.5.1.2"><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p17233719">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.2.3.2.5.1.3"><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p4164548117122">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.2.3.2.5.1.4"><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p53754023">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row33431272113959"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p1894114191435">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p50996812114013">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p54126260114016">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.2.5.1.4 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p8340728114018">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row59108624"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p23069209">listener_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p56666602">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p1784078717122">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.2.5.1.4 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p6471942">Specifies the ID of the listener with which the health check is associated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row58247484"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p20425774">healthcheck_protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p43875021">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p3581766217122">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.2.5.1.4 "><ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul528706289201"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li4530731212270">Specifies the health check protocol. A listener using UDP is not allowed for a private network load balancer.</li><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li650438059201">The value can be <strong>HTTP</strong>, <strong>TCP</strong>, or <strong id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_b842352706155831">UDP</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row38446258"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p27139175">healthcheck_uri</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p50789581">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p1554952217122">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.2.5.1.4 "><ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul6136760992020"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li63437707122712">Specifies the health check URI. This parameter is valid when <strong>healthcheck_protocol</strong> is <strong>HTTP</strong>.</li><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li2599268292020">The value can contain 1 to 80 characters that must start with a slash (/) and can contain only letters, digits, and special characters such as -/.%?#&_=</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row45979426"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p33345988">healthcheck_connect_port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p16670523">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p5155173317122">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.2.5.1.4 "><ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul569317192032"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li1819643122721">Specifies the health check port.</li><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li6335065392032">The port number ranges from 1 to 65535.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row24945412"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p7312526">healthy_threshold</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p55443761">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p1494088217122">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.2.5.1.4 "><ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul2842639192044"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li54051452122731">Specifies the number of consecutive health checks when the health check result of a backend ECS changes from <strong id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_b3116158110365">fail</strong> to <strong id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_b1201877310365">success</strong>.</li><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li6404840292044">The value ranges from <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b142091226151317">1</strong> to <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b73315292133">10</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row59835867"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p14867095">unhealthy_threshold</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p63384014">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p225191917122">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.2.5.1.4 "><ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul583290992058"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li30689434122740">Specifies the number of consecutive health checks when the health check result of a backend ECS changes from <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b922915126465">success</strong> to <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b15231812194618">fail</strong>.</li><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li1610952892058">The value ranges from <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b172615021415">1</strong> to <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b152622061412">10</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row34232944"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p21405046">healthcheck_timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p56087165">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p4818773217122">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.2.5.1.4 "><ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul562080659218"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li24586246122749">Specifies the maximum time required for waiting for a response from the health check in the unit of second.</li><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li404263679218">The value ranges from <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b77014279409">1</strong> to <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b13643529194019">50</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row1482002"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p52933326">healthcheck_interval</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p59740974">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p1089223417122">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.2.5.1.4 "><ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul4166441692118"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li64655368122759">Specifies the maximum time between health checks in the unit of second.</li><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li3156463992118">The value ranges from <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b1144311156417">1</strong> to <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b13407185416">50</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<h4 class="sectiontitle">Request</h4><ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul14640111064018"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li76402010134019">Request parameters<p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p1630234384314"><a name="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li76402010134019"></a><a name="en-us_topic_0096561512_en-us_topic_0020100164_li76402010134019"></a>None</p>
|
|
</li></ul>
|
|
<ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul11296519134018"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li929611924012">Example request 1: Configuring an HTTP health check<pre class="screen" id="elb_jd_jk_0001__en-us_topic_0096561512_screen9107177300">{
|
|
"healthcheck_connect_port": 80,
|
|
"healthcheck_interval": 5,
|
|
"healthcheck_protocol": "HTTP",
|
|
"healthcheck_timeout": 10,
|
|
"healthcheck_uri": "/",
|
|
"healthy_threshold": 3,
|
|
"listener_id": "3ce8c4429478a5eb6ef4930de2d75b28",
|
|
"unhealthy_threshold": 3
|
|
}</pre>
|
|
</li><li id="elb_jd_jk_0001__en-us_topic_0096561512_li0996112516291">Example request 2: Configuring a TCP health check <pre class="screen" id="elb_jd_jk_0001__en-us_topic_0096561512_screen1699619254295">{
|
|
"healthcheck_connect_port": 80,
|
|
"healthcheck_interval": 5,
|
|
"healthcheck_protocol": "TCP",
|
|
"healthcheck_timeout": 10,
|
|
"healthcheck_uri": "",
|
|
"healthy_threshold": 3,
|
|
"listener_id": "3ce8c4429478a5eb6ef4930de2d75b28",
|
|
"unhealthy_threshold": 3
|
|
}</pre>
|
|
</li></ul>
|
|
|
|
<h4 class="sectiontitle">Response</h4><ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul38830572154720"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li13930836154720">Response parameters
|
|
<table cellpadding="4" cellspacing="0" summary="" id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_table58268660154720" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row43546893154720"><th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p37637446154720">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.141414141414144%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p15158425193624">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.64646464646465%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p45778611154720">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row513410112435"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p5065952912439">healthcheck_interval</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p978118112439">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64646464646465%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p5407822612439">Specifies the maximum time between health checks in the unit of second.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row3070025912523"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p4562333112526">listener_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p450233212526">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64646464646465%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p2914464612526">Specifies the ID of the listener with which the health check is associated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row17079990154720"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p41301921154720">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p66205107193624">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64646464646465%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p63423313154720">Specifies the health check ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row33938912154720"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p2290315212554">healthcheck_protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p4321605112554">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64646464646465%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p1083922212554">Specifies the health check protocol.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row8871928154720"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p1330045612610">unhealthy_threshold</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p359513812610">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64646464646465%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p2277078112610">Specifies the number of consecutive health checks when the health check result of a backend ECS changes from <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b2481928663">success</strong> to <strong id="elb_jd_jk_0001__en-us_topic_0096561512_b4482152813617">fail</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row794063512618"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p6094783912633">update_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p3782791312633">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64646464646465%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p4416213212633">Specifies the time when the health check was updated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row16253572154720"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p4904884012633">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p1353309912633">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64646464646465%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p2243924312633">Specifies the time when the health check was configured.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row1392188154720"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p45658399154720">healthcheck_connect_port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p5661608193624">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64646464646465%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p57899715154720">Specifies the health check port.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row55133490154720"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p36627707154720">healthcheck_timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p5905984019365">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64646464646465%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p64658568154720">Specifies the maximum time required for waiting for a response from the health check in the unit of second.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row45056202154720"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p4309577612648">healthcheck_uri</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p109693812648">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64646464646465%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p2174313612648">Specifies the health check URI. This parameter is valid when <strong>healthcheck_protocol</strong> is <strong>HTTP</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row6017617712347"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p504822112722">healthy_threshold</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p625278012722">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64646464646465%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p3671316712722">Specifies the number of consecutive health checks when the health check result of a backend ECS changes from <strong id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_b3772576810365">fail</strong> to <strong id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_b398759310365">success</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</li></ul>
|
|
|
|
<ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul28048521"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li51110099">Example response 1: Configuring an HTTP health check<pre class="screen" id="elb_jd_jk_0001__en-us_topic_0096561512_screen8755113143115">{
|
|
<em id="elb_jd_jk_0001__en-us_topic_0096561512_i653323111919"> </em><em id="elb_jd_jk_0001__en-us_topic_0096561512_i84081041181912">"</em>healthcheck_interval<em id="elb_jd_jk_0001__en-us_topic_0096561512_i7339105013190">"</em>:5,
|
|
"listener_id":"3ce8c4429478a5eb6ef4930de2d75b28",
|
|
"id":"134e5ea962327c6a574b83e6e7f31f35",
|
|
"healthcheck_protocol":"HTTP",
|
|
"unhealthy_threshold":3,
|
|
"update_time":"2015-12-25 03:57:23",
|
|
"create_time":"2015-12-25 03:57:23",
|
|
"healthcheck_connect_port":80,
|
|
"healthcheck_timeout":10,
|
|
"healthcheck_uri":"\/",
|
|
"healthy_threshold":3
|
|
}</pre>
|
|
</li><li id="elb_jd_jk_0001__en-us_topic_0096561512_li483443717308">Example response 2: Configuring a TCP health check <pre class="screen" id="elb_jd_jk_0001__en-us_topic_0096561512_screen188343373303">{
|
|
<em id="elb_jd_jk_0001__en-us_topic_0096561512_i1085571217201"> </em>"healthcheck_interval":5,
|
|
"listener_id":"3ce8c4429478a5eb6ef4930de2d75b28",
|
|
"id":"134e5ea962327c6a574b83e6e7f31f35",
|
|
"healthcheck_protocol":"TCP",
|
|
"unhealthy_threshold":3,
|
|
"update_time":"2015-12-25 03:57:23",
|
|
"create_time":"2015-12-25 03:57:23",
|
|
"healthcheck_connect_port":80,
|
|
"healthcheck_timeout":10,
|
|
"healthcheck_uri":"",
|
|
"healthy_threshold":3
|
|
}</pre>
|
|
</li></ul>
|
|
<h4 class="sectiontitle">Status Code</h4><ul id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_ul52486654"><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li2617844">Normal<p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p23560597"><a name="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li2617844"></a><a name="en-us_topic_0096561512_en-us_topic_0020100164_li2617844"></a>200</p>
|
|
</li><li id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_li10718788">Error
|
|
<table cellpadding="4" cellspacing="0" summary="" id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_table11098151151527" frame="border" border="1" rules="all"><thead align="left"><tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row16678161151527"><th align="left" class="cellrowborder" valign="top" width="10.299999999999999%" id="mcps1.3.6.2.2.1.1.4.1.1"><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p8753830151527">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.46%" id="mcps1.3.6.2.2.1.1.4.1.2"><p id="elb_jd_jk_0001__en-us_topic_0096561512_p074410397618">Message</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.239999999999995%" id="mcps1.3.6.2.2.1.1.4.1.3"><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p37971652151527">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row55804946151527"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p23906744151527">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_p171381521668">badRequest</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p57398111151527">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row46820954151527"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p34400933151527">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_p91382052765">unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p35012164151527">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row46674023151527"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p22499488151527">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_p13139105218617">userDisabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p10519201151527">You do not have the permission to perform the operation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row27563948151527"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p18087341151527">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_p10139115213615">Not Found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p55788555151527">The requested page does not exist.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row32334952151527"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p1885468151527">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_p213919521619">authFault</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p18505183151527">System error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_row32328927151527"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p1397439151527">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_p0139752267">serviceUnavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_jk_0001__en-us_topic_0096561512_en-us_topic_0020100164_p46083715151527">The service is unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</li></ul>
|
|
|
|
|
|
|
|
|
|
<strong>Parent topic:</strong> <a href="elb_jd_jk_0000.html">Health Check</a>
|
|
|
|
|
|
|