forked from docs/doc-exports
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com> Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
409 lines
26 KiB
HTML
409 lines
26 KiB
HTML
<a name="css_03_0129"></a><a name="css_03_0129"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining the ELB Information and Health Check Status</h1>
|
|
<div id="body0000001667757616"><div class="section" id="css_03_0129__section1939511105551"><h4 class="sectiontitle">Function</h4><p id="css_03_0129__p18396310175520">This API is used to obtain the ES ELB information and health check status.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0129__section1239611014553"><h4 class="sectiontitle">URI</h4><p id="css_03_0129__p43975102555">GET /v1.0/{project_id}/clusters/{cluster_id}/es-listeners</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0129__table53992010155513" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0129__row33981210165517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0129__p1939918100554">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__p1739913106554">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__p2400161015518">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__p2400410205516">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0129__row14398131017554"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0129__p44001010185513">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__p1740801095517">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0129__p54091110105513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0129__p19409121005515">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row1439871055515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0129__p641017108554">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__p14103102555">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0129__p5410171025510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0129__p1041081095510">ID of the cluster to be queried</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0129__section84111710175513"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0129__p12411131035518">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0129__section1541241019551"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0129__p17412101055517"><strong id="css_03_0129__b17109759692387">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 parameter</caption><thead align="left"><tr id="css_03_0129__row1841351018555"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0129__p1741691015511">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__p24163107558">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__p5417161015550">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0129__row154134104558"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p84176103556">serverCertName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p12417210195516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p15418210165517">Server certificate name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row13413310175516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p64199101559">serverCertId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p1541971018552">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p941901012556">Server certificate ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row1041319107559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p441931013559">cacertName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p0420171025510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p1142081014553">CA certificate name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row541411095514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p1342010104554">cacertId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p1042018100555">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p142116108559">CA certificate ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row2041411011551"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p3421171015558">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__p17422181014557">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p17422141013550">Indicates whether ELB is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row1414111018550"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p44232010165511">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__p44233108557">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0129__p16423141055518">Authentication mode</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row134142107552"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p44231910155510">loadBalancer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p2042481019553"><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__p342414103557">Load balancer object information</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row1741591095515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0129__p18424171085513">healthmonitors</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0129__p742561085511"><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__p9425171045517">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__row1426121015554"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0129__p13428131095520">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__p2042941016556">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__p542981016554">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0129__row10426161055518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p34291610135513">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p6433610145514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p14436171065513">Load balancer ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row9426141010558"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p1343651011559">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p104361110165513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p64391710185520">Load balancer name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row1342711095515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p1443971035512">guaranteed</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p134401310175519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p5441111018551">Indicates whether the load balancer is of the dedicated type.</p>
|
|
<ul id="css_03_0129__ul644151045514"><li id="css_03_0129__li1944111025515"><strong id="css_03_0129__b1852613110196">false</strong>: shared load balancer</li><li id="css_03_0129__li9441111011559"><strong id="css_03_0129__b14372986208">true</strong>: dedicated load balancer</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row1642711105553"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p244311085520">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p1544321055511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p1244351016551">Template description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row184271810175518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p14440100551">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__p19444181016552">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p134442109555">ID of the VPC where the load balancer resides</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row18427151015516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p2444141015518">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__p194451410165512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p0445121015551">Status of the load balancer</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row2042741065520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p94461110105510">listeners</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p8447151095515"><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__p15447910175512">Associated listeners.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row342781085515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p5448210175511">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__p544831095510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0129__p844851095518">IPv4 virtual IP address bound to the load balancer</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row34271108552"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0129__p16448171012553">publicips</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0129__p8449101014553"><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__p64493105556">EIP 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__row1450101065520"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="css_03_0129__p124514106559">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__p12451121014555">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__p44521010185515">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0129__row645071085515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0129__p164527106557">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0129__p14452171055515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0129__p645391045517">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__row1345311045511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="css_03_0129__p94557103554">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__p144551810125512">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__p44568109558">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0129__row14541010135510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0129__p1845615100557">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__p1545771025511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0129__p745701015517">EIP configuration ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row5454610195511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0129__p1045751045510">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__p2045841011553">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0129__p6458141013557">IP address</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row24541910155519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0129__p134583101555">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__p645851014552">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0129__p245991025514">IP address version.</p>
|
|
<ul id="css_03_0129__ul445951015556"><li id="css_03_0129__li18459151019554"><strong id="css_03_0129__b41033462290">4</strong>: IPv4</li><li id="css_03_0129__li1646091019554"><strong id="css_03_0129__b119735964172419">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__row1046041012553"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="css_03_0129__p14462161035516">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__p1046291095511">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__p7463131045517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0129__row204613102554"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0129__p16463131005518">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="css_03_0129__p194631210145520">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="css_03_0129__p19464171065516">Backend server ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row18461121012555"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0129__p12464181045515">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="css_03_0129__p15464181065517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="css_03_0129__p12465610145515">Backend server name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row346115105555"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0129__p16465710125510">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__p20465310195514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="css_03_0129__p7465131095514">Frontend listening port of the backend service</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row0461310205512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0129__p19466171095518">ipgroup</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="css_03_0129__p174661410195515"><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__p134671910185515">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__row1946761025513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="css_03_0129__p14477510125516">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__p54781810125510">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__p1447813108557">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0129__row19474101035512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="css_03_0129__p194791010175513">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__p7479181085518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="css_03_0129__p164791710195513">ID of the access control group associated with the listener</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row6474151025516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="css_03_0129__p1547911065514">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__p1047913106557">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="css_03_0129__p1648014102555">Access control group status</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row1474101018558"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="css_03_0129__p16480131045511">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="css_03_0129__p18480710185512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="css_03_0129__p348117103550">Access control group type</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0129__section4481121016552"><h4 class="sectiontitle">Request Example</h4><p id="css_03_0129__p1348371014550">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0129__section164831910135513"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0129__p948361018558"><strong id="css_03_0129__b9465349702387">Status code: 200</strong></p>
|
|
<p id="css_03_0129__p14833109558">The request is processed successfully.</p>
|
|
<pre class="screen" id="css_03_0129__screen1148719102553">{
|
|
"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__section8971131015513"><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__row549651085518"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0129__p179711710125513">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__p19715101554">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0129__row549661020552"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0129__p797191014555">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0129__p1997151015554">The request is processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row1149620103559"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0129__p129711210185511">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0129__p697161010554">Invalid request.</p>
|
|
<p id="css_03_0129__p3971151055519">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row5496310105511"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0129__p1997121019559">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0129__p397114103558">The request cannot be processed due to a conflict.</p>
|
|
<p id="css_03_0129__p5971710115519">This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0129__row154963102551"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0129__p3971410125512">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0129__p9971151065515">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__section1497121035520"><h4 class="sectiontitle">Error Codes</h4><p id="css_03_0129__p1697141014554">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>
|
|
|