vpruthi/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
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

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__section333743320719"><h4 class="sectiontitle">Function</h4><p id="css_03_0130__p10337333979">This API is used to update an Elasticsearch listener.</p>
</div>
<div class="section" id="css_03_0130__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="css_03_0130__p1333814330712">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__table3339733078" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0130__row19339133320720"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0130__p634013314711">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__p1434016331974">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__p2034073319712">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__p1534011336719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row1133923311718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0130__p734113334719">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__p1834120332077">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0130__p153418331472">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0130__p163415331776">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_0130__row153392332711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0130__p53421533770">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__p43421339713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0130__p123421433472">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0130__p20342183317717">ID of the target cluster</p>
</td>
</tr>
<tr id="css_03_0130__row1933912331710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0130__p134310331971">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__p534310336719">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0130__p734363315719">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0130__p16343933471">ID of the listener to be updated</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0130__section934418337717"><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 parameters</caption><thead align="left"><tr id="css_03_0130__row934418331715"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="css_03_0130__p12345633675">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__p12345233779">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__p1434511335712">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__p534612331175">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row8344333772"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0130__p634618339714">listener</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0130__p5346173316718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0130__p834623311719"><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__p133461333711">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__row1834712333717"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0130__p1934863319714">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__p1634819335717">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__p1834814333715">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__p7349113311719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row12347933478"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0130__p1135083318711">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__p17350173312710">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0130__p2351143318713">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0130__p83512033475">ID of the server certificate used by the listener</p>
</td>
</tr>
<tr id="css_03_0130__row634714331674"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0130__p153514331679">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__p16351123313720">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0130__p135333318714">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0130__p435312333713">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__section1535310331675"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0130__p835413332715"><strong id="css_03_0130__b193544331972">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 parameters</caption><thead align="left"><tr id="css_03_0130__row2355163316714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0130__p835553320718">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__p535612331474">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__p10356533376">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row1235553315711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0130__p1435613332712">listener</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0130__p1735633310714"><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__p153575331973">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__row335718339712"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0130__p103598331073">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__p11359133876">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__p735910337711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row1635793316719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0130__p736015332711">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0130__p183607331677">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0130__p10360163316711">Protocol used by the listener</p>
</td>
</tr>
<tr id="css_03_0130__row1835812331777"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0130__p7360933571">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0130__p1336003317714">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0130__p1361113315719">Listener ID</p>
</td>
</tr>
<tr id="css_03_0130__row235817331771"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0130__p103612331172">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0130__p133611331773">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0130__p183611633274">Listener name</p>
</td>
</tr>
<tr id="css_03_0130__row123588331578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0130__p14362113310710">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__p1736243319711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0130__p123631333778">Port used by the listener</p>
</td>
</tr>
<tr id="css_03_0130__row133585331878"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0130__p23636331173">ipgroup</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0130__p9364183319718"><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__p14364123318720">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__row93661333571"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="css_03_0130__p1436718332714">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__p236715338720">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__p93671233673">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row2366333375"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0130__p1636863319715">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__p13681433675">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0130__p1236863310710">ID of the IP address group associated with the listener</p>
</td>
</tr>
<tr id="css_03_0130__row836616331778"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0130__p1836810331713">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__p18369533373">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0130__p7369183312716">Status of an access control group</p>
</td>
</tr>
<tr id="css_03_0130__row436620331973"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0130__p1936919331676">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0130__p337073311718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0130__p1837083314715">Type of an access control group</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0130__section1337073310713"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="css_03_0130__screen23718331375">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__section8372433570"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0130__p33729333714">None</p>
</div>
<div class="section" id="css_03_0130__section93725332710"><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__row237343320716"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0130__p193731233771">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__p937416332071">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0130__row5373233878"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0130__p17375333877">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0130__p16375233678">Request succeeded.</p>
</td>
</tr>
<tr id="css_03_0130__row737373318717"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0130__p1637693316713">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0130__p173767331472">Invalid request.</p>
<p id="css_03_0130__p637620331175">Modify the request instead of retrying.</p>
</td>
</tr>
<tr id="css_03_0130__row16373833679"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0130__p637716331478">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0130__p437713335714">The request cannot be processed due to a conflict.</p>
<p id="css_03_0130__p03771533077">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_0130__row183731233478"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0130__p93774336718">412</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0130__p23771833379">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__section63781331478"><h4 class="sectiontitle">Error Codes</h4><p id="css_03_0130__p5378193319711">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