forked from docs/doc-exports
zhengxiu
8f6b8d3664
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: zhengxiu <zhengxiu@huawei.com> Co-committed-by: zhengxiu <zhengxiu@huawei.com>
185 lines
14 KiB
HTML
185 lines
14 KiB
HTML
<a name="UpdateCloseKibana"></a><a name="UpdateCloseKibana"></a>
|
|
|
|
<h1 class="topictitle1">Disabling Kibana Public Access</h1>
|
|
<div id="body1708331107508"><div class="section" id="UpdateCloseKibana__section16174152913483"><h4 class="sectiontitle">Function</h4><p id="UpdateCloseKibana__p13175132915486">This API is used to disable public network access to Kibana. </p>
|
|
<div class="note" id="UpdateCloseKibana__note20175429134818"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="UpdateCloseKibana__p18175132920487">If you disable Kibana public network access and then re-enable it, the public IP address for accessing Kibana may change. Exercise caution.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="UpdateCloseKibana__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="UpdateCloseKibana__p151751129174811">For details, see <a href="css_03_0077.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="UpdateCloseKibana__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="UpdateCloseKibana__p21757291487">PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/close</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateCloseKibana__table2017562916487" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdateCloseKibana__row201750295489"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateCloseKibana__p5175329164814">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateCloseKibana__p217522911481">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateCloseKibana__p31761529194817">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateCloseKibana__p15176929184817">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateCloseKibana__row5175162918484"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateCloseKibana__p21762298484">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateCloseKibana__p1217612984816">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateCloseKibana__p1517682912487">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateCloseKibana__p2017642915486"><strong id="UpdateCloseKibana__b817662934810">Definition</strong>:</p>
|
|
<p id="UpdateCloseKibana__p11176229104812">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>
|
|
<p id="UpdateCloseKibana__p717672911481"><strong id="UpdateCloseKibana__b5176129194816">Constraints</strong>:</p>
|
|
<p id="UpdateCloseKibana__p0176172954815">N/A</p>
|
|
<p id="UpdateCloseKibana__p12176152954815"><strong id="UpdateCloseKibana__b617692974816">Value range</strong>:</p>
|
|
<p id="UpdateCloseKibana__p1117672917482">Project ID of the account.</p>
|
|
<p id="UpdateCloseKibana__p1217611299488"><strong id="UpdateCloseKibana__b1417682994810">Default value</strong>:</p>
|
|
<p id="UpdateCloseKibana__p1417610293484">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateCloseKibana__row817542984818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateCloseKibana__p12176142917487">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateCloseKibana__p1117618296485">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateCloseKibana__p18176429184816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateCloseKibana__p1417619298483"><strong id="UpdateCloseKibana__b161761297483">Definition</strong>:</p>
|
|
<p id="UpdateCloseKibana__p81762029154815">ID of the cluster whose Kibana public access you want to disable. For details about how to obtain the cluster ID, see <a href="css_03_0101.html">Obtaining the Cluster ID</a>.</p>
|
|
<p id="UpdateCloseKibana__p2017642915486_1"><strong id="UpdateCloseKibana__b1517662920484">Constraints</strong>:</p>
|
|
<p id="UpdateCloseKibana__p10177192919483">N/A</p>
|
|
<p id="UpdateCloseKibana__p12177142912485"><strong id="UpdateCloseKibana__b12177172964817">Value range</strong>:</p>
|
|
<p id="UpdateCloseKibana__p4177729164811">Cluster ID.</p>
|
|
<p id="UpdateCloseKibana__p16177152944817"><strong id="UpdateCloseKibana__b71776296487">Default value</strong>:</p>
|
|
<p id="UpdateCloseKibana__p917713291489">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateCloseKibana__section1417732914481"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateCloseKibana__request_CloseKibanaPublicReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="UpdateCloseKibana__row19177182934814"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="UpdateCloseKibana__p31772298488">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="UpdateCloseKibana__p7177102994816">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="UpdateCloseKibana__p1017711299484">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="UpdateCloseKibana__p111773298483">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateCloseKibana__row2177529164819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateCloseKibana__p141773294488">eip_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateCloseKibana__p7177132916481">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateCloseKibana__p16178129174811">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateCloseKibana__p1178152912484">Bandwidth. Unit: Mbit/s</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateCloseKibana__row2177172994816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateCloseKibana__p81781429154814">elb_white_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateCloseKibana__p1117892914817">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateCloseKibana__p14178182917480"><a href="#UpdateCloseKibana__request_StartKibanaPublicReqElbWhitelist">StartKibanaPublicReqElbWhitelist</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateCloseKibana__p15178629144818">ELB whitelist.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="UpdateCloseKibana__request_StartKibanaPublicReqElbWhitelist"></a><a name="request_StartKibanaPublicReqElbWhitelist"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateCloseKibana__request_StartKibanaPublicReqElbWhitelist" frame="border" border="1" rules="all"><caption><b>Table 3 </b>StartKibanaPublicReqElbWhitelist</caption><thead align="left"><tr id="UpdateCloseKibana__row1717842915483"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="UpdateCloseKibana__p111783297484">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="UpdateCloseKibana__p817892994817">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="UpdateCloseKibana__p517815296485">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="UpdateCloseKibana__p217816290489">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateCloseKibana__row1217811299484"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateCloseKibana__p1817952994817">enable_white_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateCloseKibana__p10179192944816">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateCloseKibana__p181791629104812">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateCloseKibana__p21791829104811">Whether to enable the whitelist function.</p>
|
|
<ul id="UpdateCloseKibana__ul617922944818"><li id="UpdateCloseKibana__li51791029114820"><p id="UpdateCloseKibana__p11791129114814"><a name="UpdateCloseKibana__li51791029114820"></a><a name="li51791029114820"></a><strong id="UpdateCloseKibana__b111797298484">true</strong>: The whitelist is enabled.</p>
|
|
</li><li id="UpdateCloseKibana__li617912294488"><p id="UpdateCloseKibana__p017902924814"><a name="UpdateCloseKibana__li617912294488"></a><a name="li617912294488"></a><strong id="UpdateCloseKibana__b161791229104819">false</strong>: The whitelist is disabled.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateCloseKibana__row13178729194817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateCloseKibana__p121791229164820">white_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateCloseKibana__p9179122914487">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateCloseKibana__p17179112984819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateCloseKibana__p317922984818">Whitelist.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateCloseKibana__section2017972994818"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateCloseKibana__p7179929104818"><strong id="UpdateCloseKibana__b9179729174812">Status code: 200</strong></p>
|
|
<p id="UpdateCloseKibana__p1617910291481">Request succeeded.</p>
|
|
<p id="UpdateCloseKibana__p19179192934813">None</p>
|
|
</div>
|
|
<div class="section" id="UpdateCloseKibana__section217902919487"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateCloseKibana__p12179729164810">Disable Kibana public access.</p>
|
|
<pre class="screen" id="UpdateCloseKibana__screen017922974818">PUT https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/publickibana/close
|
|
|
|
{
|
|
"eip_size" : 5,
|
|
"elb_white_list" : {
|
|
"enable_white_list" : true,
|
|
"white_list" : "192.168.0.xx"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateCloseKibana__section81806297484"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateCloseKibana__p81801529114817">None</p>
|
|
</div>
|
|
<div class="section" id="UpdateCloseKibana__section173161229134813"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateCloseKibana__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateCloseKibana__row918616298483"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="UpdateCloseKibana__p8316429184815">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="UpdateCloseKibana__p183161229114817">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateCloseKibana__row1118612954813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateCloseKibana__p43165296483">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateCloseKibana__p1631622904818">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateCloseKibana__row5186102974813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateCloseKibana__p931614297489">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateCloseKibana__p531615295480">Invalid request.</p>
|
|
<p id="UpdateCloseKibana__p14316182912484">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateCloseKibana__row20186192974810"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateCloseKibana__p531692917489">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateCloseKibana__p1531682944810">The request could not be completed due to a conflict with the current state of the resource.</p>
|
|
<p id="UpdateCloseKibana__p1931632919484">The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateCloseKibana__row6186112924813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateCloseKibana__p113161429154816">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateCloseKibana__p1631612984818">The server did not meet one of the preconditions contained in the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateCloseKibana__section1431615292482"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateCloseKibana__p1331622910488">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="kibana_public_network_access.html">Kibana Public Network Access</a></div>
|
|
</div>
|
|
</div>
|
|
|