doc-exports/docs/css/api-ref/css_03_0129.html
Wuwan, Qi 8675132585 CSS API 23.2.1 20230926
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
2023-10-23 09:34:01 +00:00

409 lines
26 KiB
HTML

<a name="css_03_0129"></a><a name="css_03_0129"></a>
<h1 class="topictitle1">Obtaining the ES ELB Information and Displaying the Health Check Status</h1>
<div id="body0000001667757616"><div class="section" id="css_03_0129__section1919817335716"><h4 class="sectiontitle">Function</h4><p id="css_03_0129__p4198633372">This API is used to obtain the ES ELB information and display the health check status on the page.</p>
</div>
<div class="section" id="css_03_0129__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="css_03_0129__p9199143313716">GET /v1.0/{project_id}/clusters/{cluster_id}/es-listeners</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0129__table420010332715" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0129__row1519913331575"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0129__p72003331773">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0129__p62001833577">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0129__p102015331278">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0129__p17201163310713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0129__row9199733972"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0129__p12015338718">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0129__p102011333373">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0129__p82011033177">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0129__p120215337711">Project ID. For details about how to obtain the project ID and name, see <a href="css_03_0071.html">Obtaining the Project ID and Name</a>.</p>
</td>
</tr>
<tr id="css_03_0129__row3199433673"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0129__p120213318716">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0129__p520217333713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0129__p1520216338713">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0129__p92033335714">ID of the cluster you want to query.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0129__section172039331472"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0129__p1020311331472">None</p>
</div>
<div class="section" id="css_03_0129__section020412333712"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0129__p172051433273"><strong id="css_03_0129__b13206103315717">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0129__response_GetEsElbDetailResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="css_03_0129__row1620617337710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0129__p3211133377">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0129__p2211203311712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0129__p121112337711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0129__row220715331674"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p521210338713">serverCertName</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p1421318338719">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p1521316331677">Server certificate name</p>
</td>
</tr>
<tr id="css_03_0129__row42075331275"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p202143331771">serverCertId</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p192143331719">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p4214333676">Server certificate ID</p>
</td>
</tr>
<tr id="css_03_0129__row182074331072"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p1521423320716">cacertName</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p1215133878">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p32155331872">CA certificate name</p>
</td>
</tr>
<tr id="css_03_0129__row32095331070"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p1021593312720">cacertId</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p12215733378">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p2215733976">CA certificate ID</p>
</td>
</tr>
<tr id="css_03_0129__row42091333713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p921643315712">elb_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p15216163317715">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p202163337720">Indicates whether ELB is enabled.</p>
</td>
</tr>
<tr id="css_03_0129__row1020915332713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p102161333079">authentication_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p3217333978">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p1921711337716">Authentication mode</p>
</td>
</tr>
<tr id="css_03_0129__row1021063316719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p132178335712">loadBalancer</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p102171233874"><a href="#css_03_0129__response_EsLoadBalancerResource">EsLoadBalancerResource</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p4218183311710">Load balancer object information</p>
</td>
</tr>
<tr id="css_03_0129__row142101933073"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p5218133311714">healthmonitors</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p221833318715"><a href="#css_03_0129__response_EsHealthmonitorsResource">EsHealthmonitorsResource</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p1421920331973">Health check result set</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0129__response_EsLoadBalancerResource"></a><a name="response_EsLoadBalancerResource"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0129__response_EsLoadBalancerResource" frame="border" border="1" rules="all"><caption><b>Table 3 </b>EsLoadBalancerResource</caption><thead align="left"><tr id="css_03_0129__row7219123317713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0129__p62217339712">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="css_03_0129__p822119332716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="css_03_0129__p162221331971">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0129__row62199331714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p822217331579">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p122220334718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p1322316337719">Load balancer ID</p>
</td>
</tr>
<tr id="css_03_0129__row722019331772"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p132231033476">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p62248331710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p14224833578">Load balancer name</p>
</td>
</tr>
<tr id="css_03_0129__row142208332711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p422518331275">guaranteed</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p122516332711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p12225103313719">Indicates whether the load balancer is an exclusive LB.</p>
<ul id="css_03_0129__ul722511331712"><li id="css_03_0129__li1522583315711"><strong id="css_03_0129__b6226333673">false</strong>: Shared load balancer</li><li id="css_03_0129__li222617331076"><strong id="css_03_0129__b2226143316720">true</strong>: Dedicated load balancer</li></ul>
</td>
</tr>
<tr id="css_03_0129__row022016331272"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p16227153310710">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p1222713317717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p1722719331477">Description</p>
</td>
</tr>
<tr id="css_03_0129__row0220123312714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p222810331379">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p1622823311714">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p1222817337712">ID of the VPC to which the load balancer belongs</p>
</td>
</tr>
<tr id="css_03_0129__row822010336715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p22284331170">provisioning_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p1022819337717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p152298331973">Provisioning status of the load balancer</p>
</td>
</tr>
<tr id="css_03_0129__row1122018331972"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p152291433578">listeners</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p7229733577"><a href="#css_03_0129__response_EsListenersResource">EsListenersResource</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p162294336714">Associated listener list</p>
</td>
</tr>
<tr id="css_03_0129__row222010332712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p122910331775">vip_address</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p1423063312717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p22301033779">IPv4 virtual IP address bound to the load balancer</p>
</td>
</tr>
<tr id="css_03_0129__row022016331971"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p10230133176">publicips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p19230123315714"><a href="#css_03_0129__response_EsPublicipsResource">EsPublicipsResource</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p2023063319716">Public IP address bound to the load balancer</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0129__response_EsListenersResource"></a><a name="response_EsListenersResource"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0129__response_EsListenersResource" frame="border" border="1" rules="all"><caption><b>Table 4 </b>EsListenersResource</caption><thead align="left"><tr id="css_03_0129__row1223113331712"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="css_03_0129__p11232133579">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="css_03_0129__p11232133313714">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="css_03_0129__p32336331573">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0129__row122311133175"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0129__p102331133976">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0129__p1123317334710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0129__p723383310716">Listener ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0129__response_EsPublicipsResource"></a><a name="response_EsPublicipsResource"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0129__response_EsPublicipsResource" frame="border" border="1" rules="all"><caption><b>Table 5 </b>EsPublicipsResource</caption><thead align="left"><tr id="css_03_0129__row623403314711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="css_03_0129__p12235113316714">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="css_03_0129__p112358331874">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="css_03_0129__p423520334719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0129__row72341331079"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0129__p132363331879">publicip_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="css_03_0129__p14236033771">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0129__p20236193315717">EIP configuration ID</p>
</td>
</tr>
<tr id="css_03_0129__row72342331572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0129__p02364331473">publicip_address</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="css_03_0129__p62371533477">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0129__p1923713331172">IP address</p>
</td>
</tr>
<tr id="css_03_0129__row152346331374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0129__p9237933479">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="css_03_0129__p32381433676">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0129__p623812331174">IP address version.</p>
<ul id="css_03_0129__ul182381133576"><li id="css_03_0129__li16238113317715"><strong id="css_03_0129__b12241933872">4</strong>: IPv4</li><li id="css_03_0129__li72412331720"><strong id="css_03_0129__b12241133320719">6</strong>: IPv6</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0129__response_EsHealthmonitorsResource"></a><a name="response_EsHealthmonitorsResource"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0129__response_EsHealthmonitorsResource" frame="border" border="1" rules="all"><caption><b>Table 6 </b>EsHealthmonitorsResource</caption><thead align="left"><tr id="css_03_0129__row172421233375"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="css_03_0129__p1124318331574">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="css_03_0129__p324318331873">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="css_03_0129__p524463313717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0129__row124215337712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0129__p172443331877">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="css_03_0129__p52447331871">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="css_03_0129__p924416339718">Backend server ID</p>
</td>
</tr>
<tr id="css_03_0129__row122421233375"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0129__p172451733078">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="css_03_0129__p92451733378">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="css_03_0129__p152459331173">Backend server name</p>
</td>
</tr>
<tr id="css_03_0129__row9242163313717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0129__p624533319716">protocol_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="css_03_0129__p172456338710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="css_03_0129__p142468334716">Frontend listening port of the backend service</p>
</td>
</tr>
<tr id="css_03_0129__row1624212331079"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0129__p1824623314716">ipgroup</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="css_03_0129__p024623316717"><a href="#css_03_0129__response_EsHealthIpgroupResource">EsHealthIpgroupResource</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="css_03_0129__p172476334714">Access control information of the listener object</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0129__response_EsHealthIpgroupResource"></a><a name="response_EsHealthIpgroupResource"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0129__response_EsHealthIpgroupResource" frame="border" border="1" rules="all"><caption><b>Table 7 </b>EsHealthIpgroupResource</caption><thead align="left"><tr id="css_03_0129__row13247933472"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="css_03_0129__p92498337717">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="css_03_0129__p1824913334712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="css_03_0129__p32497334719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0129__row92481333671"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="css_03_0129__p1024914331870">ipgroup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="css_03_0129__p1424953314710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="css_03_0129__p172508331775">ID of the IP address group associated with the listener</p>
</td>
</tr>
<tr id="css_03_0129__row112488331071"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="css_03_0129__p325017335717">enable_ipgroup</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="css_03_0129__p20250143319716">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="css_03_0129__p1825019331377">Status of an access control group</p>
</td>
</tr>
<tr id="css_03_0129__row112481533177"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="css_03_0129__p825019331171">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="css_03_0129__p225110331071">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="css_03_0129__p925118331674">Type of an access control group</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0129__section825243318716"><h4 class="sectiontitle">Example Requests</h4><p id="css_03_0129__p32521133879">None</p>
</div>
<div class="section" id="css_03_0129__section1225216337710"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0129__p1825216331773"><strong id="css_03_0129__b52525334715">Status code: 200</strong></p>
<p id="css_03_0129__p1625311336717">Request succeeded.</p>
<pre class="screen" id="css_03_0129__screen82566332714">{
"loadBalancer" : {
"id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268",
"name" : "elb-css",
"guaranteed" : "true",
"description" : "",
"listeners" : [ {
"id" : "011d14fa-908b-4cd9-b0d6-0768ddc6cb71"
}, {
"id" : "04b86029-c281-4490-a3bd-5ea1266658ba"
} ],
"publicips" : [ {
"publicip_id" : "f678e23c-96a5-49e8-8ea2-bd8b47d41e78",
"publicip_address" : "100.1.1.1",
"ip_version" : 4
} ],
"billing_info" : null,
"vpc_id" : "4f3deec3-efa8-4598-bf91-560aad1377a3",
"provisioning_status" : "ACTIVE",
"vip_address" : "10.0.0.1"
},
"listener" : {
"id" : "41ff041d-c7b9-4142-9167-fa93d54f97da",
"name" : "css-searchServer",
"protocol" : "HTTPS",
"ipgroup" : null,
"protocol_port" : 9265
},
"healthmonitors" : [ {
"id" : "bac86342-2222-43e6-817f-57f040a174a6",
"name" : "",
"address" : "10.0.0.87",
"protocol_port" : 9200,
"operating_status" : "ONLINE"
}, {
"id" : "d935b82c-f94b-4ae0-9997-ddc90885d8c6",
"name" : "",
"address" : "10.0.0.61",
"protocol_port" : 9200,
"operating_status" : "ONLINE"
} ],
"serverCertName" : "server1",
"serverCertId" : "82375af01c0d40f6a44c15962c570625",
"cacertName" : null,
"cacertId" : null,
"elb_enable" : true,
"authentication_type" : "single"
}</pre>
</div>
<div class="section" id="css_03_0129__section996310331379"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0129__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0129__row132646331574"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0129__p296317331777">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="css_03_0129__p1296313317716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0129__row142651133278"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0129__p3963833874">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0129__p69634331873">Request succeeded.</p>
</td>
</tr>
<tr id="css_03_0129__row12265183313711"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0129__p1996333310720">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0129__p296319335715">Invalid request.</p>
<p id="css_03_0129__p20963113316718">Modify the request instead of retrying.</p>
</td>
</tr>
<tr id="css_03_0129__row13265103314711"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0129__p696415331773">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0129__p396414331972">The request cannot be processed due to a conflict.</p>
<p id="css_03_0129__p19964733074">This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.</p>
</td>
</tr>
<tr id="css_03_0129__row102651333271"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0129__p1496417331713">412</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0129__p199641333378">The server does not meet one of the requirements that the requester puts on the request.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0129__section69641331470"><h4 class="sectiontitle">Error Codes</h4><p id="css_03_0129__p159648337710">See <a href="css_03_0076.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0125.html">Load Balancing</a></div>
</div>
</div>