vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/elb/api-ref/elb_zq_jk_0003.html

248 lines
28 KiB
HTML
Raw Blame History

<a name="elb_zq_jk_0003"></a><a name="elb_zq_jk_0003"></a>
<h1 class="topictitle1">Querying Details of a Health Check</h1>
<h4 class="sectiontitle">Function</h4><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0049139664_p29306417">This API is used to query details about a health check using its iD.</p>
<h4 class="sectiontitle">URI</h4><p id="elb_zq_jk_0003__en-us_topic_0096561562_p3409194485016">GET /v2.0/lbaas/healthmonitors/{healthmonitor_id}</p>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_jk_0003__en-us_topic_0096561562_table176971727192716" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="elb_zq_jk_0003__en-us_topic_0096561562_row197661727142714"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.3.2.5.1.1"><p id="elb_zq_jk_0003__en-us_topic_0096561562_p9766142719279">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.2.3.2.5.1.2"><p id="elb_zq_jk_0003__en-us_topic_0096561562_p2766132715279">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.3.2.5.1.3"><p id="elb_zq_jk_0003__en-us_topic_0096561562_p87661627142718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.2.3.2.5.1.4"><p id="elb_zq_jk_0003__en-us_topic_0096561562_p7766112732717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_jk_0003__en-us_topic_0096561562_row67681227162719"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_p1576822718273">healthmonitor_id</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_p20768122711272">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_p1768827202719">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.3.2.5.1.4 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_p7768162762710">Specifies the health check ID.</p>
</td>
</tr>
</tbody>
</table>
<h4 class="sectiontitle">Request</h4><p id="elb_zq_jk_0003__en-us_topic_0096561562_p09779584343">None</p>
<h4 class="sectiontitle">Response</h4>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0049139664_table15263883" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0049139664_row23849822"><th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.4.2.2.4.1.1"><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0049139664_p52787457">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.4.2.2.4.1.2"><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0049139664_p47925604">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.59595959595959%" id="mcps1.3.4.2.2.4.1.3"><p id="elb_zq_jk_0003__en-us_topic_0096561562_p6230154717271">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0049139664_row5163807"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0049139664_p15615252">healthmonitor</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0049139664_p56875922">Object</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.2.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0049139664_p37641542">Specifies the health check. For details, see <a href="#elb_zq_jk_0003__en-us_topic_0096561562_table167973062820">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
<a name="elb_zq_jk_0003__en-us_topic_0096561562_table167973062820"></a><a name="en-us_topic_0096561562_table167973062820"></a><table cellpadding="4" cellspacing="0" summary="" id="elb_zq_jk_0003__en-us_topic_0096561562_table167973062820" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b1969320677">healthmonitor</strong> parameter description</caption><thead align="left"><tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row19929157112914"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.3.2.4.1.1"><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p59295713297">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.3.2.4.1.2"><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p79292720293">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67%" id="mcps1.3.4.3.2.4.1.3"><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1258101218348">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row1192911772916"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p5929177112912">id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p5947132518343">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p109296702911">Specifies the health check ID.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row792915762911"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p59290711296">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1792918772913">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p269292715918">Specifies the ID of the project where the health check is performed.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row209291674295"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p692919752912">name</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p131123323411">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p199294713299">Specifies the health check name.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row5929279299"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p892987162910">delay</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p792918772915">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p119293720295">Specifies the maximum time between health checks in the unit of second. The value ranges from <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b53341117227">1</strong> to <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b1233617116226">50</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row179291072296"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p15929157192911">max_retries</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p178711239193411">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p189309702917">Specifies the number of consecutive health checks when the health check result of a backend server changes from <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b1739405266">OFFLINE</strong> to <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b527115768">ONLINE</strong>. The value ranges from <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b1862691373">1</strong> to <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b1023991351">10</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row48196131417"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p17820913710">max_retries_down</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p131913421349">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p69045219322">Specifies the number of consecutive health checks when the health check result of a backend server changes from <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b39931845122517">ONLINE</strong> to <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b16995194552511">OFFLINE</strong>. The value ranges from <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b5997345142512">1</strong> to <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b2999545162516">10</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row1193097152917"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1793016712298">pools</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_en-us_topic_0096561533_p422512115486">Array</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p893015710294">Specifies the ID of the backend server group associated with the health check. For details, see <a href="elb_zq_jk_0001.html#elb_zq_jk_0001__en-us_topic_0096561563_table567815515351">Table 5</a>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row2930197182911"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p79301777292">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p293017715298">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p88489418492">Specifies the administrative status of the health check.</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p148411551101613">This parameter is reserved. The value can be <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_en-us_topic_0141008273_b165949352520">true</strong> or <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_en-us_topic_0141008273_b76047354513">false</strong>.</p>
<ul id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_ul15841751151613"><li id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_en-us_topic_0141008273_li1786915015393"><strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_en-us_topic_0141008273_b1178053714514">true</strong>: Enabled</li><li id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_en-us_topic_0141008273_li1031815323916"><strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_en-us_topic_0141008273_b1524614510615">false</strong>: Disabled</li></ul>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row09302716299"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p19303782913">timeout</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p179315732915">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p37112334494">Specifies the health check timeout duration in the unit of second. The value ranges from <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b1380316275226">1</strong> to <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b1580411278227">50</strong>.</p>
<span class="notetitle"> NOTE: </span><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p57123374911">You are advised to set the value less than that of parameter <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b10582112915225">delay</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row1793116752912"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p6931579296">type</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p49311173296">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p87193317494">Specifies the health check protocol.</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p5711533184919">The value can be <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b9594432122210">TCP</strong>, <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b19595183219229">UDP_CONNECT</strong>, or <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b14595123282211">HTTP</strong>.</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p06541511142">The relationships between the value of this parameter and the protocol of the backend server group are as follows:</p>
<ul id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_ul116545131418"><li id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_li13654201171416">If the protocol of the backend server group is UDP, the parameter value can only be <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b25511132412">UDP_CONNECT</strong>.</li><li id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_li176541119147">If the protocol of the backend server group is TCP, the parameter value can be <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b12116646246">TCP</strong> or <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b191165482412">HTTP</strong>.</li><li id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_li196541819144">If the protocol of the backend server group is HTTP, the parameter value can be <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b167811969241">TCP</strong> or <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b378276152414">HTTP</strong>.</li></ul>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row79313702914"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p29315710299">monitor_port</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1193119762917">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p19915125974920">Specifies the health check port. The port number ranges from 1 to 65535.</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1891535916496">The value is left blank by default, indicating that the port of the backend server is used as the health check port.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row129325719290"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p4639141253611">expected_codes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1263931216363">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p30010494">Specifies the expected HTTP status code. The following options are available:</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1658995">A single value, such as <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b165791552196">200</strong></p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p14930959">A list of values, such as <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b856515132012">200,202</strong></p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p160907">A value range, such as <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b17726313541">200-204</strong></p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1448168">This parameter is valid only when the value of <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b6389401468">type</strong> is set to <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b113907012461">HTTP</strong>.</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p13033520">Currently, this parameter is not supported and is fixed at <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b84235270619455">200</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row1993247182913"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p159326713290">domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p179321712912">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p12394754125016">Specifies the domain name of HTTP requests during the health check.</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p73941354135010">This parameter is valid only when the value of <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b55255217488">type</strong> is set to <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b1752620264817">HTTP</strong>.</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p14394115411501">The value is left blank by default, indicating that the private IP address of the load balancer is used as the destination address of HTTP requests.</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p15394145435010">The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter, for example, <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b67911125183711">www.test.com</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row593217719299"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p793277152911">url_path</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1593247182917">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p6417986512">Specifies the HTTP request path for the health check. The default value is <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b1437591082310">/</strong>, and the value must start with a slash (/).</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p64181884511">This parameter is valid only when the value of <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b16827165119475">type</strong> is set to <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b188288512479">HTTP</strong>.</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1341818185114">An example value is <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b20236172942318">/test</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row3932167132916"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p793218711296">http_method</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1893212710291">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p48511267514">Specifies the HTTP request method. The default value is <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b19886729123413">GET</strong>.</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p11851326135110">The value can be <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b205241432133411">GET</strong>, <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b1524432123415">HEAD</strong>, <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b1452533293413">POST</strong>, <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b12525832163420">PUT</strong>, <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b452653210347">DELETE</strong>, <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b2052773214341">TRACE</strong>, <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b152812324344">OPTIONS</strong>, <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b75281932203417">CONNECT</strong>, and <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b7529193220347">PATCH</strong>.</p>
<p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p485142665115">This parameter is valid only when the value of <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b782231144617">type</strong> is set to <strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b178221611124616">HTTP</strong>.</p>
<span class="notetitle"> NOTE: </span><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1885112263511">This parameter is reserved.</p>
</td>
</tr>
</tbody>
</table>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_jk_0003__en-us_topic_0096561562_table567815515351" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_b47154222110">pools</strong> parameter description</caption><thead align="left"><tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row1679125113520"><th align="left" class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.3.4.4.2.4.1.1"><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p2679751103516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.11%" id="mcps1.3.4.4.2.4.1.2"><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p13679195193510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.540000000000006%" id="mcps1.3.4.4.2.4.1.3"><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1067965123519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_row15679151203513"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.4.4.2.4.1.1 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p767955143510">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.4.4.2.4.1.2 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p1867965119358">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.540000000000006%" headers="mcps1.3.4.4.2.4.1.3 "><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561563_p66791851123518">Specifies the ID of the associated backend server group.</p>
</td>
</tr>
</tbody>
</table>
<h4 class="sectiontitle">Example Request</h4><ul id="elb_zq_jk_0003__en-us_topic_0096561562_ul446824212481"><li id="elb_zq_jk_0003__en-us_topic_0096561562_li49175363419">Example request: Querying details of a health check<pre class="screen" id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0049139664_screen29066061">GET https://{Endpoint}/v2.0/lbaas/healthmonitors/b7633ade-24dc-4d72-8475-06aa22be5412</pre>
</li></ul>
<h4 class="sectiontitle">Example Response</h4><ul id="elb_zq_jk_0003__en-us_topic_0096561562_ul05531330102310"><li id="elb_zq_jk_0003__en-us_topic_0096561562_li15533302236">Example response<pre class="screen" id="elb_zq_jk_0003__en-us_topic_0096561562_screen2055303017234">{
"healthmonitor": {
"name": "",
"admin_state_up": true,
"tenant_id": "145483a5107745e9b3d80f956713e6a3",
"domain_name": null,
"delay": 10,
"expected_codes": "200-204,300-302,401",
"max_retries": 10,
"max_retries_down": 5,
"http_method": "GET",
"timeout": 10,
"pools": [
{
"id": "bb44bffb-05d9-412c-9d9c-b189d9e14193"
}
],
"url_path": "/",
"type": "HTTP",
"id": "61c24cba-19bb-45c1-a013-7565e5f98872",
"monitor_port": 112
}
}</pre>
</li></ul>
<h4 class="sectiontitle">Status Code</h4><p id="elb_zq_jk_0003__en-us_topic_0096561562_en-us_topic_0096561531_en-us_topic_0049139631_p12358762">For details, see <a href="elb_gc_1102.html#elb_gc_1102">Status Codes</a>.</p>
<strong>Parent topic:</strong> <a href="elb_zq_jk_0000.html">Health Check</a>
View Git Blame Copy Permalink