lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/css/api-ref/css_03_0130.html
Zheng, Xiu 99a2d77599 css api 23.5.1 20240520 
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>
2024-06-07 17:47:08 +00:00

258 lines
17 KiB
HTML
Raw Blame History

<a name="css_03_0130"></a><a name="css_03_0130"></a>
<h1 class="topictitle1">Updating an ES Listener</h1>
<div id="body0000001715757209"><div class="section" id="css_03_0130__section656231015516"><h4 class="sectiontitle">Function</h4><p id="css_03_0130__p19562410135516">This API is used to update an ES listener.</p>
</div>
<div class="section" id="css_03_0130__section19563181025512"><h4 class="sectiontitle">URI</h4><p id="css_03_0130__p356441075518">PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0130__table96101810105517" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0130__row1360681045515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0130__p146106109552">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_0130__p5611410145514">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_0130__p161141018555">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_0130__p1661121045516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row160617105552"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0130__p1261261035519">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0130__p96126102551">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0130__p1461341016556">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0130__p5613310195520">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_0130__row14606410135511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0130__p2613111018553">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0130__p161317106552">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0130__p5614101018559">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0130__p16614141045516">ID of the target cluster</p>
</td>
</tr>
<tr id="css_03_0130__row1660681020553"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0130__p56146104551">listener_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0130__p0615181015518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0130__p1261511035510">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0130__p11615510115511">ID of the listener to be updated</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0130__section14615210135512"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0130__request_UpdateESListenerRequestBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameter</caption><thead align="left"><tr id="css_03_0130__row15616151015515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="css_03_0130__p18617171015515">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_0130__p2061731075513">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_0130__p7617171095520">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_0130__p196173107559">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row6616191019557"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0130__p361816104553">listener</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0130__p116181510185518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0130__p17618101015510"><a href="#css_03_0130__request_EsListenerRequest">EsListenerRequest</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0130__p1761841018557">Listener object</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0130__request_EsListenerRequest"></a><a name="request_EsListenerRequest"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0130__request_EsListenerRequest" frame="border" border="1" rules="all"><caption><b>Table 3 </b>EsListenerRequest</caption><thead align="left"><tr id="css_03_0130__row96191210185513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0130__p13627191018553">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="css_03_0130__p56281010105516">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="css_03_0130__p1462871014557">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="css_03_0130__p11629151012553">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row15626610145511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0130__p3629121065511">default_tls_container_ref</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0130__p1763031015513">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0130__p18630910125517">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0130__p18631110125516">ID of the server certificate used by the listener</p>
</td>
</tr>
<tr id="css_03_0130__row9626141085511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0130__p1263191010558">client_ca_tls_container_ref</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0130__p663171014551">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0130__p1063131012557">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0130__p12632610125511">ID of the CA certificate used by the listener. This parameter is mandatory when bidirectional authentication is to be updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0130__section2632171014550"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0130__p17632131025511"><strong id="css_03_0130__b16666969532389">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0130__response_UpdateESListenerResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameter</caption><thead align="left"><tr id="css_03_0130__row12633610185517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0130__p10633151045511">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_0130__p13634161013558">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_0130__p463421095515">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row7633141095518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0130__p1563401015517">listener</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0130__p15634810155516"><a href="#css_03_0130__response_EsListenerResponse">EsListenerResponse</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0130__p13635510135519">Listener object</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0130__response_EsListenerResponse"></a><a name="response_EsListenerResponse"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0130__response_EsListenerResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>EsListenerResponse</caption><thead align="left"><tr id="css_03_0130__row146351310145514"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0130__p1363611017558">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_0130__p14637210125510">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_0130__p163751045517">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row20635171045514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0130__p196371410195511">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0130__p186372010155516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0130__p15638210115515">Protocol used by the listener</p>
</td>
</tr>
<tr id="css_03_0130__row1663516103559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0130__p1563812107555">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0130__p663831055510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0130__p3638171035510">Listener ID</p>
</td>
</tr>
<tr id="css_03_0130__row663517103559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0130__p18639141015553">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0130__p963971045512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0130__p17639111025510">Listener name</p>
</td>
</tr>
<tr id="css_03_0130__row163631016559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0130__p263961018557">protocol_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0130__p0640610155512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0130__p19640111010558">Port used by the listener</p>
</td>
</tr>
<tr id="css_03_0130__row156361610155518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0130__p176402010195511">ipgroup</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0130__p1164021014555"><a href="#css_03_0130__response_EsIpgroupResource">EsIpgroupResource</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0130__p66409106550">Access control information of the listener object</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0130__response_EsIpgroupResource"></a><a name="response_EsIpgroupResource"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0130__response_EsIpgroupResource" frame="border" border="1" rules="all"><caption><b>Table 6 </b>EsIpgroupResource</caption><thead align="left"><tr id="css_03_0130__row4641111013554"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="css_03_0130__p17642111025518">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_0130__p1764201020557">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_0130__p56421710175516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row1164161017556"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0130__p18642161013559">ipgroup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0130__p10643210165512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0130__p964311045519">ID of the access control group associated with the listener</p>
</td>
</tr>
<tr id="css_03_0130__row1264191018559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0130__p1464316101557">enable_ipgroup</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0130__p17643171075518">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0130__p126431102558">Access control group status</p>
</td>
</tr>
<tr id="css_03_0130__row664151017550"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0130__p11644101019552">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0130__p126441109556">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0130__p19644171025512">Access control group type</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0130__section176440108554"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="css_03_0130__screen1645410155513">PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/es-listeners/4425eb63-78ce-4c63-b60e-492befdac0e7
{
"listener" : {
"default_tls_container_ref" : "9c82320a8dd049eba49b28e70a2c0c3e"
}
}</pre>
</div>
<div class="section" id="css_03_0130__section1964641013552"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0130__p1646151014553">None</p>
</div>
<div class="section" id="css_03_0130__section564641015550"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0130__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0130__row15647810195518"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0130__p18647181045516">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_0130__p15648101075510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row136471410155518"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0130__p7648410105514">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0130__p15648910145514">The request is processed successfully.</p>
</td>
</tr>
<tr id="css_03_0130__row364714101556"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0130__p964871065516">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0130__p196491510145515">Invalid request.</p>
<p id="css_03_0130__p126491110175512">Modify the request instead of retrying.</p>
</td>
</tr>
<tr id="css_03_0130__row9647101017558"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0130__p764981015517">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0130__p165015109553">The request cannot be processed due to a conflict.</p>
<p id="css_03_0130__p13650131035510">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_0130__row18647171016559"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0130__p17650110185511">412</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0130__p19650810115510">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_0130__section6650910205516"><h4 class="sectiontitle">Error Codes</h4><p id="css_03_0130__p18651191045510">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>
View Git Blame Copy Permalink