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

488 lines
51 KiB
HTML
Raw Blame History

<a name="elb_zq_jk_0002"></a><a name="elb_zq_jk_0002"></a>
<h1 class="topictitle1">Querying Health Checks</h1>
<h4 class="sectiontitle">Function</h4><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0049139663_p58846418">This API is used to query the health checks. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.</p>
<h4 class="sectiontitle">URI</h4><p id="elb_zq_jk_0002__en-us_topic_0096561561_p5672402485">GET /v2.0/lbaas/healthmonitors</p>
<h4 class="sectiontitle">Constraints</h4><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_p1425263917142">Parameters <strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_b842352706173057">marker</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_b84235270617310">limit</strong>, and <strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_b84235270617314">page_reverse</strong> are used for pagination query. Parameters <strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_b842352706173217">marker</strong> and <strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_b842352706173221">page_reverse</strong> take effect only when they are used together with parameter <strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_b842352706173232">limit</strong>.</p>
<h4 class="sectiontitle">Request</h4>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_jk_0002__en-us_topic_0096561561_table475513722510" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="elb_zq_jk_0002__en-us_topic_0096561561_row62353814250"><th align="left" class="cellrowborder" valign="top" width="23.607639236076388%" id="mcps1.3.4.2.2.5.1.1"><p id="elb_zq_jk_0002__en-us_topic_0096561561_p623838172512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.73882611738826%" id="mcps1.3.4.2.2.5.1.2"><p id="elb_zq_jk_0002__en-us_topic_0096561561_p17231738172520"><strong id="elb_zq_jk_0002__en-us_topic_0096561561_b842352706192244">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.168783121687829%" id="mcps1.3.4.2.2.5.1.3"><p id="elb_zq_jk_0002__en-us_topic_0096561561_p7231938162519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.4847515248475%" id="mcps1.3.4.2.2.5.1.4"><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1723183812513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_jk_0002__en-us_topic_0096561561_row223153816256"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1323738122511">marker</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p423038182519">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p323103802513">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p4235152211344">Specifies the ID of the health check from which pagination query starts, that is, the ID of the last health check on the previous page.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p06221826143418">This parameter must be used together with <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b17447204517392">limit</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row92383812516"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p12259381251">limit</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1425138152515">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p825153822512">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p163282306342">Specifies the number of health checks on each page. If this parameter is not set, all health checks are queried by default.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row1225638172517"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1825143819256">page_reverse</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p192563832513">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1225138162511">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p15227113913341">Specifies the page direction. The value can be <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b3335104216582">true</strong> or <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b7336142195813">false</strong>, and the default value is <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1733610423581">false</strong>. The last page in the list requested with <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b19337174210587">page_reverse</strong> set to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1433774216586">false</strong> will not contain the "next" link, and the last page in the list requested with <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b20338542105814">page_reverse</strong> set to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b13338184211583">true</strong> will not contain the "previous" link.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p5244104243413">This parameter must be used together with <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b6580105914399">limit</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row925183882518"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1325133811258">id</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p142553892513">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p121782018181719">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p825538132511">Specifies the health check ID.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row025173810255"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1425538202516">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p162543820253">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p02517389256">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p20526512">Specifies the ID of the project where the health check is performed.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p1264211013318">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row112503842517"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p72593832511">name</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p3251738182518">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p525338102512">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p14251338172514">Specifies the health check name.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p1572924515612">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row32516389251"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1625163892519">delay</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1525183872520">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1325938152515">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p62583818257">Specifies the maximum time between health checks in the unit of second. The value ranges from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b75431021403">1</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b254432154011">50</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row82583892516"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1425193811250">max_retries</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p6266382258">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p112523813252">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p32643817257">Specifies the number of consecutive health checks when the health check result of a backend server changes from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b163681955151117">OFFLINE</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b13370155511120">ONLINE</strong>. The value ranges from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1237165511113">1</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b93711055191111">10</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row156113818410"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p16612981946">max_retries_down</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p4612198341">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p161213810415">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p10612118547">Specifies the number of consecutive health checks when the health check result of a backend server changes from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b43623310122">ONLINE</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b83636316127">OFFLINE</strong>. The value ranges from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1136483181214">1</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b73651238127">10</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row10268386257"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p626123818257">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p726123817254">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p182615381254">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p88489418492">Specifies the administrative status of the health check.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p136141610163013">This parameter is reserved, and the default value is <strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008273_b7386530455">true</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row126183852517"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p12268381258">timeout</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p10268386258">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1826193817257">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p37112334494">Specifies the health check timeout duration in the unit of second. The value ranges from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b206981131408">1</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b186992013144017">50</strong>.</p>
<span class="notetitle"> NOTE: </span><p id="elb_zq_jk_0002__en-us_topic_0096561561_p57123374911">You are advised to set the value less than that of parameter <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b10731157401">delay</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row727133820254"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1027738102511">type</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p102713814259">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p15271738142512">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p87193317494">Specifies the health check protocol.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p5711533184919">The value can be <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b279712198409">TCP</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b11797119184013">UDP_CONNECT</strong>, or <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b8798101910404">HTTP</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row1527103816252"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1327173832513">monitor_port</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p3271638132514">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p172723818256">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p19915125974920">Specifies the port used for the health check.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_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_0002__en-us_topic_0096561561_row0271038162513"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p629133810250">expected_codes</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p19291638162512">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p122919386252">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p49464171">Specifies the expected HTTP status code. The following options are available:</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p42524361">A single value, such as <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b7408915102011">200</strong></p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p47174935">A list of values, such as <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b5561152812546">200,202</strong></p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p21921239">A value range, such as <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1453893075415">200-204</strong></p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p63073424">This parameter is valid only when the value of <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b198618422388">type</strong> is set to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1615439386">HTTP</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p08925875615">The value contains a maximum of 64 characters.</p>
<span class="notetitle"> NOTE: </span><p class="textintable" id="elb_zq_jk_0002__en-us_topic_0096561561_p8673725">This parameter is reserved.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row18291238142519"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p8291238142511">domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1829338142510">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p102993802515">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p12394754125016">Specifies the domain name of HTTP requests during the health check.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p73941354135010">This parameter is valid only when the value of <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b6474934154017">type</strong> is set to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b17474534174013">HTTP</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_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_0002__en-us_topic_0096561561_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_0002__en-us_topic_0096561561_b14041559174319">www.test.com</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p17715201310572">The value contains a maximum of 100 characters.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row1629183822512"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p829238162515">url_path</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1129638142512">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p112993814256">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p6417986512">Specifies the HTTP request path for the health check. The default value is <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1424610413402">/</strong>, and the value must start with a slash (/).</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p64181884511">This parameter is valid only when the value of <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b13342114424010">type</strong> is set to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b9343184424014">HTTP</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p1341818185114">An example value is <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b489644594013">/test</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p1255119268570">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row202953802512"><td class="cellrowborder" valign="top" width="23.607639236076388%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p829238102516">http_method</p>
</td>
<td class="cellrowborder" valign="top" width="11.73882611738826%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p20305388256">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.168783121687829%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p15291338172512">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.4847515248475%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p48511267514">Specifies the HTTP request method. The default value is <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b0191547144015">GET</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p11851326135110">The value can be <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b184467487409">GET</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b444774816404">HEAD</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b18448124815404">POST</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b3449194810402">PUT</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b84496486404">DELETE</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b11450124818402">TRACE</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1745164804010">OPTIONS</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1745294815405">CONNECT</strong>, and <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b184531848154018">PATCH</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p485142665115">This parameter is valid only when the value of <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b679174914011">type</strong> is set to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b157921949144015">HTTP</strong>.</p>
<span class="notetitle"> NOTE: </span><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1885112263511">This parameter is reserved.</p>
</td>
</tr>
</tbody>
</table>
<h4 class="sectiontitle">Response</h4>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0049139663_table5773255" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0049139663_row19618454"><th align="left" class="cellrowborder" valign="top" width="21.19%" id="mcps1.3.5.2.2.4.1.1"><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0049139663_p45590951">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.46%" id="mcps1.3.5.2.2.4.1.2"><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0049139663_p1879552">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.349999999999994%" id="mcps1.3.5.2.2.4.1.3"><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0049139663_p50824621">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0049139663_row23153616"><td class="cellrowborder" valign="top" width="21.19%" headers="mcps1.3.5.2.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0049139663_p63503579">healthmonitors</p>
</td>
<td class="cellrowborder" valign="top" width="27.46%" headers="mcps1.3.5.2.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0049139663_p43516279">Array</p>
</td>
<td class="cellrowborder" valign="top" width="51.349999999999994%" headers="mcps1.3.5.2.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0049139663_p29202048">Lists the health checks. For details, see <a href="#elb_zq_jk_0002__en-us_topic_0096561561_table6429512132610">Table 3</a>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row16871151835419"><td class="cellrowborder" valign="top" width="21.19%" headers="mcps1.3.5.2.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p312554035410">healthmonitors_links</p>
</td>
<td class="cellrowborder" valign="top" width="27.46%" headers="mcps1.3.5.2.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p3125114018549">Array</p>
</td>
<td class="cellrowborder" valign="top" width="51.349999999999994%" headers="mcps1.3.5.2.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p181251740125417">Provides links to the previous or next page during pagination query, respectively.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p41259409543">This parameter exists only in the response body of pagination query.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p3125540175411">For details, see <a href="#elb_zq_jk_0002__en-us_topic_0096561561_table31726924112">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
<a name="elb_zq_jk_0002__en-us_topic_0096561561_table6429512132610"></a><a name="en-us_topic_0096561561_table6429512132610"></a><table cellpadding="4" cellspacing="0" summary="" id="elb_zq_jk_0002__en-us_topic_0096561561_table6429512132610" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="elb_zq_jk_0002__en-us_topic_0096561561_b19767174972320">healthmonitors</strong> parameter description</caption><thead align="left"><tr id="elb_zq_jk_0002__en-us_topic_0096561561_row6625112172620"><th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.5.3.2.4.1.1"><p id="elb_zq_jk_0002__en-us_topic_0096561561_p13625012132618">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.18%" id="mcps1.3.5.3.2.4.1.2"><p id="elb_zq_jk_0002__en-us_topic_0096561561_p146251412102614">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.61%" id="mcps1.3.5.3.2.4.1.3"><p id="elb_zq_jk_0002__en-us_topic_0096561561_p3625151282618">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_jk_0002__en-us_topic_0096561561_row206251212202620"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p76251212172616">id</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1391115489185">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1262661216262">Specifies the health check ID.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row1562618124262"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p14407135075919">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p34401551201812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p198921122117">Specifies the ID of the project where the health check is performed.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row20626101212267"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p136267128260">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p26262127261">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p10626612112610">Specifies the health check name.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p4781165175717">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row3626131262613"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p862641211265">delay</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p162641210268">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p16626161282618">Specifies the maximum time between health checks in the unit of second. The value ranges from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b161271213417">1</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1812820194117">50</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row162621232617"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p162616124260">max_retries</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p662617122262">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p158471132332">Specifies the number of consecutive health checks when the health check result of a backend server changes from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1082873392718">OFFLINE</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b8829113372716">ONLINE</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p4626312172618">The value ranges from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b189231058315">1</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b14924145811115">10</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row932616216715"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p8328524718">max_retries_down</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p53281822713">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p16251152215338">Specifies the number of consecutive health checks when the health check result of a backend server changes from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b143415118217">ONLINE</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b173416113213">OFFLINE</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p143284218711">The value ranges from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b14128512216">1</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b14121057212">10</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row14626151212614"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p7626412102613">pools</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p46264126265">Array</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p893015710294">Lists the IDs of backend server groups associated with the health check.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row1262611122264"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p15626212202614">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p862611214269">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1395749185817">Specifies the administrative status of the health check.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p154951119177">This parameter is reserved. The value can be <strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008273_b165949352520">true</strong> or <strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008273_b76047354513">false</strong>.</p>
<ul id="elb_zq_jk_0002__en-us_topic_0096561561_ul12491110171"><li id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008273_li1786915015393"><strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008273_b1178053714514">true</strong>: Enabled</li><li id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008273_li1031815323916"><strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008273_b1524614510615">false</strong>: Disabled</li></ul>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row10626201220263"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1627712112615">timeout</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1462719125261">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p39594917584">Specifies the health check timeout duration in the unit of second. The value ranges from <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b199591417144115">1</strong> to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b196071744118">50</strong>.</p>
<span class="notetitle"> NOTE: </span><p id="elb_zq_jk_0002__en-us_topic_0096561561_p195104920588">You are advised to set the value less than that of parameter <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b9590151916412">delay</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row16627312172620"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p86271012162613">type</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p26271212122619">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1095154995817">Specifies the health check protocol.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p139654917587">The value can be <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b4231523104120">TCP</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b152592364118">UDP_CONNECT</strong>, or <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b7263233410">HTTP</strong>.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row462771217266"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p17627131211261">monitor_port</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1862741242610">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p119674915580">Specifies the health check port. The port number ranges from 1 to 65535.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p796124913588">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_0002__en-us_topic_0096561561_row362791219268"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p6627121282613">expected_codes</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p662714129261">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p55431899">Specifies the expected HTTP status code. The following options are available:</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p29125048">A single value, such as <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b710533422017">200</strong></p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p60798848">A list of values, such as <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b2788144312548">200,202</strong></p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p10318722">A value range, such as <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b19139114615417">200-204</strong></p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p25759641">This parameter is valid only when the value of <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b385414488457">type</strong> is set to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1285514814513">HTTP</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p19695101010580">The value contains a maximum of 64 characters.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row1962761272613"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p16627161292612">domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p8627151219265">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p19451641195915">Specifies the domain name of HTTP requests during the health check.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p945841135916">This parameter is valid only when the value of <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b2064992219463">type</strong> is set to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b865002294612">HTTP</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p1045104175910">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_0002__en-us_topic_0096561561_p845134113593">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_0002__en-us_topic_0096561561_b113015586429">www.test.com</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p201302012585">The value contains a maximum of 100 characters.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row196271312192614"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p7627181292610">url_path</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p10627141214267">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1745114145914">Specifies the HTTP request path for the health check. The default value is <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b15642184416411">/</strong>, and the value must start with a slash (/).</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p5451741195912">This parameter is valid only when the value of <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b10870113994713">type</strong> is set to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b168709399478">HTTP</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p16451641185910">An example value is <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b857214719411">/test</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p1656842965819">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_row5627612182610"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p156271512122620">http_method</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p8627212142610">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_p1147104111593">Specifies the HTTP request method. The default value is <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b7695248174112">GET</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p84774115591">The value can be <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b18677114915415">GET</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1967854911416">HEAD</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1678149134116">POST</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b0679144916412">PUT</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b13679849204115">DELETE</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b13680124914112">TRACE</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b668116498413">OPTIONS</strong>, <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b4682104916419">CONNECT</strong>, and <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b368213491413">PATCH</strong>.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_p1747144116591">This parameter is valid only when the value of <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b77175161489">type</strong> is set to <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b20718111644817">HTTP</strong>.</p>
<span class="notetitle"> NOTE: </span><p id="elb_zq_jk_0002__en-us_topic_0096561561_p5471741175911">This parameter is reserved.</p>
</td>
</tr>
</tbody>
</table>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_jk_0002__en-us_topic_0096561561_table567815515351" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0096561563_b47154222110">pools</strong> parameter description</caption><thead align="left"><tr id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0096561563_row1679125113520"><th align="left" class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.3.5.4.2.4.1.1"><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0096561563_p2679751103516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.11%" id="mcps1.3.5.4.2.4.1.2"><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0096561563_p13679195193510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.540000000000006%" id="mcps1.3.5.4.2.4.1.3"><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0096561563_p1067965123519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0096561563_row15679151203513"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0096561563_p767955143510">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.5.4.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0096561563_p1867965119358">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.540000000000006%" headers="mcps1.3.5.4.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0096561563_p66791851123518">Specifies the ID of the associated backend server group.</p>
</td>
</tr>
</tbody>
</table>
<a name="elb_zq_jk_0002__en-us_topic_0096561561_table31726924112"></a><a name="en-us_topic_0096561561_table31726924112"></a><table cellpadding="4" cellspacing="0" summary="" id="elb_zq_jk_0002__en-us_topic_0096561561_table31726924112" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1812877926">healthmonitors_links</strong> parameter description</caption><thead align="left"><tr id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_en-us_topic_0096561531_row12653175213336"><th align="left" class="cellrowborder" valign="top" width="34.69%" id="mcps1.3.5.5.2.4.1.1"><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_en-us_topic_0096561531_p15653195215335">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.47%" id="mcps1.3.5.5.2.4.1.2"><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_en-us_topic_0096561531_p065315253310">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.839999999999996%" id="mcps1.3.5.5.2.4.1.3"><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_en-us_topic_0096561531_p765365253319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_en-us_topic_0096561531_row206531152103314"><td class="cellrowborder" valign="top" width="34.69%" headers="mcps1.3.5.5.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_en-us_topic_0096561531_p1465311528337">href</p>
</td>
<td class="cellrowborder" valign="top" width="23.47%" headers="mcps1.3.5.5.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_en-us_topic_0096561531_p12653952113318">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.839999999999996%" headers="mcps1.3.5.5.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_en-us_topic_0096561531_p1653852193312">Provides links to the previous or next page during pagination query, respectively.</p>
</td>
</tr>
<tr id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_en-us_topic_0096561531_row186535529338"><td class="cellrowborder" valign="top" width="34.69%" headers="mcps1.3.5.5.2.4.1.1 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_en-us_topic_0096561531_p1065325215337">rel</p>
</td>
<td class="cellrowborder" valign="top" width="23.47%" headers="mcps1.3.5.5.2.4.1.2 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_en-us_topic_0096561531_p165305243318">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.839999999999996%" headers="mcps1.3.5.5.2.4.1.3 "><p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_p1772113411218">Specifies the prompt of the previous or next page.</p>
<p id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0141008270_p422510443113">The value can be <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1018001315421">next</strong> or <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b218116132423">previous</strong>. The value <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b1059011158426">next</strong> indicates the href containing the URL of the next page, and <strong id="elb_zq_jk_0002__en-us_topic_0096561561_b359111554215">previous</strong> indicates the href containing the URL of the previous page.</p>
</td>
</tr>
</tbody>
</table>
<h4 class="sectiontitle">Example Request</h4><ul id="elb_zq_jk_0002__en-us_topic_0096561561_ul7938114023312"><li id="elb_zq_jk_0002__en-us_topic_0096561561_li193811403332">Example request 1: Querying all health checks<pre class="screen" id="elb_zq_jk_0002__en-us_topic_0096561561_en-us_topic_0049139663_screen16555710">GET https://{Endpoint}/v2.0/lbaas/healthmonitors</pre>
</li><li id="elb_zq_jk_0002__en-us_topic_0096561561_li1609921174610">Example request 2: Querying HTTP health checks<pre class="screen" id="elb_zq_jk_0002__en-us_topic_0096561561_screen106091421124617">GET https://{Endpoint}/v2.0/lbaas/healthmonitors?type=HTTP</pre>
</li></ul>
<h4 class="sectiontitle">Example Response</h4><ul id="elb_zq_jk_0002__en-us_topic_0096561561_ul118561755172220"><li id="elb_zq_jk_0002__en-us_topic_0096561561_li1185775517225">Example response 1<pre class="screen" id="elb_zq_jk_0002__en-us_topic_0096561561_screen8857655202214">{
"healthmonitors": [
{
"monitor_port": null,
"name": "",
"admin_state_up": true,
"tenant_id": "601240b9c5c94059b63d484c92cfe308",
"domain_name": null,
"delay": 5,
"max_retries": 3,
"max_retries_down": 5,
"http_method": "GET",
"timeout": 10,
"pools": [
{
"id": "caef8316-6b65-4676-8293-cf41fb63cc2a"
}
],
"url_path": "/",
"type": "HTTP",
"id": "1b587819-d619-49c1-9101-fe72d8b361ef"
}
]
}</pre>
</li><li id="elb_zq_jk_0002__en-us_topic_0096561561_li148571855122220">Example response 2<pre class="screen" id="elb_zq_jk_0002__en-us_topic_0096561561_screen1685720557222">{
"healthmonitors": [
{
"monitor_port": null,
"name": "",
"admin_state_up": true,
"tenant_id": "601240b9c5c94059b63d484c92cfe308",
"domain_name": null,
"delay": 5,
"expected_codes": "200-204,300-302,401",
"max_retries": 3,
"max_retries_down": 5,
"http_method": "GET",
"timeout": 10,
"pools": [
{
"id": "caef8316-6b65-4676-8293-cf41fb63cc2a"
}
],
"url_path": "/",
"type": "HTTP",
"id": "1b587819-d619-49c1-9101-fe72d8b361ef"
}
]
}</pre>
</li></ul>
<h4 class="sectiontitle">Status Code</h4><p id="elb_zq_jk_0002__en-us_topic_0096561561_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