forked from docs/doc-exports
Wuwan, Qi
8675132585
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>
169 lines
11 KiB
HTML
169 lines
11 KiB
HTML
<a name="css_03_0128"></a><a name="css_03_0128"></a>
|
|
|
|
<h1 class="topictitle1">Configuring ES Listener</h1>
|
|
<div id="body0000001667761932"><div class="section" id="css_03_0128__section13631333378"><h4 class="sectiontitle">Function</h4><p id="css_03_0128__p36316331716">This API is used to configure the Elasticsearch listener.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0128__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="css_03_0128__p564233876">POST /v1.0/{project_id}/clusters/{cluster_id}/es-listeners</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0128__table166533319714" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0128__row76416336719"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0128__p365203313716">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_0128__p10654331072">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_0128__p3663332710">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_0128__p7661633875">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0128__row9644333711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0128__p56614339712">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0128__p16690336711">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0128__p19691033270">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0128__p1870153317718">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_0128__row36411332072"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0128__p97013336711">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0128__p670193316719">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0128__p207117337719">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0128__p67120337715">ID of the cluster that you want to rename.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0128__section12711633472"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0128__request_CreateEsListenerRequestBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="css_03_0128__row13725331976"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="css_03_0128__p173333772">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_0128__p177316332718">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_0128__p16735331271">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_0128__p1774193316713">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0128__row127210331772"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0128__p47416331477">protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0128__p1374033977">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0128__p57413331974">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0128__p1374173318719">Protocol type. <strong id="css_03_0128__b6753337714">HTTP</strong> and <strong id="css_03_0128__b6751331478">HTTPS</strong> are supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0128__row15727331777"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0128__p11759332713">protocol_port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0128__p1175633271">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0128__p15751133773">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0128__p575123319714">Port</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0128__row1672233474"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0128__p476193313719">server_cert_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0128__p276933477">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0128__p576103316718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0128__p276333179">Server certificate ID. This parameter is mandatory when protocol is set to <strong id="css_03_0128__b876163317714">HTTPS</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0128__row7721433371"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0128__p19767330711">ca_cert_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0128__p187793318717">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0128__p47711332075">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0128__p16775331979">CA certificate ID. This parameter is mandatory when protocol is set to <strong id="css_03_0128__b07710331075">HTTPS</strong> and bidirectional authentication is used.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0128__section19780334714"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0128__p1786331577"><strong id="css_03_0128__b177916338711">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0128__response_CreateEsListenerResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="css_03_0128__row38012333712"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0128__p1181203317719">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_0128__p128173318720">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_0128__p188113315716">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0128__row1801433772"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0128__p782173316716">elb_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0128__p5827331173">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0128__p168303314713">Load balancer ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0128__section18314336710"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="css_03_0128__screen148415331072">POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/es-listeners
|
|
|
|
{
|
|
"protocol" : "HTTPS",
|
|
"protocol_port" : "9200",
|
|
"server_cert_id" : "1b74ae4afad741e6bc9497429d3d0838",
|
|
"ca_cert_id" : "2a7b050f598e4ea8a61cffbe2bdb312f"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0128__section14858336719"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0128__p1385433679"><strong id="css_03_0128__b148514336713">Status code: 200</strong></p>
|
|
<p id="css_03_0128__p148583316711">Request succeeded.</p>
|
|
<pre class="screen" id="css_03_0128__screen108617331774">{
|
|
"elb_id" : "56a83547-a55a-407a-8245-7f9b3a0606c0"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0128__section68623314718"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0128__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0128__row28819335718"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0128__p288333972">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_0128__p2891233877">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0128__row38812338712"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0128__p48919331575">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0128__p20892331871">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0128__row788133876"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0128__p98914331770">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0128__p4904337716">Invalid request.</p>
|
|
<p id="css_03_0128__p890193318720">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0128__row178813316718"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0128__p590203310720">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0128__p690433372">The request cannot be processed due to a conflict.</p>
|
|
<p id="css_03_0128__p390233776">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_0128__row18885331475"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0128__p1290123317714">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0128__p8911337711">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_0128__section199116336720"><h4 class="sectiontitle">Error Codes</h4><p id="css_03_0128__p6911833876">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>
|
|
|