forked from docs/doc-exports
Zheng, Xiu
99a2d77599
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>
157 lines
10 KiB
HTML
157 lines
10 KiB
HTML
<a name="css_03_0127"></a><a name="css_03_0127"></a>
|
|
|
|
<h1 class="topictitle1">Enabling or Disabling the ES Load Balancer</h1>
|
|
<div id="body0000001667597892"><div class="section" id="css_03_0127__section18691104555"><h4 class="sectiontitle">Function</h4><p id="css_03_0127__p14691610145518">This API is used to enable or disable the ES load balancer.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0127__section5701710115510"><h4 class="sectiontitle">URI</h4><p id="css_03_0127__p1704109553">POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switch</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0127__table177251018550" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0127__row771131065518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0127__p197221085515">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_0127__p27211105552">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_0127__p8731410195515">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_0127__p187317103555">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0127__row87111055519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0127__p1073161005518">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0127__p17321015517">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0127__p20741410105513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0127__p97451014559">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_0127__row971210185516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0127__p1974111065519">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0127__p67411011555">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0127__p675610205514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0127__p127531075517">ID of the target cluster</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0127__section1075510105515"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0127__request_UpdateEsElbRequestBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameter</caption><thead align="left"><tr id="css_03_0127__row187661065511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="css_03_0127__p2078131011554">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="css_03_0127__p187881065517">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="css_03_0127__p10781810115512">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="css_03_0127__p19791910155520">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0127__row12764106552"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0127__p197991011557">enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0127__p1780810105520">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0127__p178121019556">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0127__p88391010552">Indicates whether the ES load balancer is enabled.</p>
|
|
<ul id="css_03_0127__ul883131065517"><li id="css_03_0127__li12831107550"><strong id="css_03_0127__b140319435053514">true</strong>: enabled</li><li id="css_03_0127__li1583510135516"><strong id="css_03_0127__b184013710598">false</strong>: disable</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0127__row117681065515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0127__p98481017559">agency</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0127__p168451020556">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0127__p168481005520">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0127__p3847103557">Agency name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0127__row5761010185515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0127__p385181005515">elb_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0127__p78511010557">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0127__p158519108552">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0127__p1585131010554">Load balancer ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0127__section1286171019552"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0127__p2861510165512"><strong id="css_03_0127__b19832779442385">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0127__response_UpdateEsElbResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameter</caption><thead align="left"><tr id="css_03_0127__row7861610155518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0127__p58731014554">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_0127__p5889108551">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_0127__p1588161005516">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0127__row6871710145517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0127__p1388161005515">elb_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0127__p389191055512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0127__p989121055516">Load balancer ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0127__section68920101556"><h4 class="sectiontitle">Request Example</h4><p id="css_03_0127__p889710165518">Enable the load balancer.</p>
|
|
<pre class="screen" id="css_03_0127__screen190181010552">POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/loadbalancers/es-switch
|
|
|
|
{
|
|
"enable" : true,
|
|
"elb_id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268",
|
|
"agency" : "css_elb_agency"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0127__section129141012552"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0127__p6916103558">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0127__section992141014554"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0127__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0127__row11921510105510"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0127__p1394111035516">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_0127__p12946102559">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0127__row6922102550"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0127__p17941010105517">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0127__p29551085511">The request is processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0127__row592121065512"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0127__p1095101045515">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0127__p49641045510">Invalid request.</p>
|
|
<p id="css_03_0127__p129621017551">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0127__row69391014555"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0127__p896141055519">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0127__p19791055510">The request cannot be processed due to a conflict.</p>
|
|
<p id="css_03_0127__p197710115511">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_0127__row793161035511"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0127__p2971010145515">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0127__p12981710125515">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_0127__section109816107552"><h4 class="sectiontitle">Error Codes</h4><p id="css_03_0127__p698191014553">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>
|
|
|