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>
169 lines
11 KiB
HTML
169 lines
11 KiB
HTML
<a name="css_03_0120"></a><a name="css_03_0120"></a>
|
|
|
|
<h1 class="topictitle1">Enabling Kibana Public Access</h1>
|
|
<div id="body0000001526490601"><div class="section" id="css_03_0120__section1489092085713"><h4 class="sectiontitle">Function</h4><p id="css_03_0120__p88913202573">This API is used to enable Kibana public network access.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0120__section10891152055718"><h4 class="sectiontitle">Debugging</h4><p id="css_03_0120__p18891112010579">You can debug this API in . Automatic authentication is supported.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0120__section2892192016573"><h4 class="sectiontitle">URI</h4><p id="css_03_0120__p19892102035718">POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/open</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0120__table1389452013578" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0120__row19893182019577"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0120__p15895202015712">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_0120__p889510203573">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_0120__p1889532085717">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_0120__p489611203571">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0120__row689362017577"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0120__p2089642035715">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0120__p128965209574">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0120__p489711206575">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0120__p2897112019577">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_0120__row3893120105711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0120__p128971020125714">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0120__p08971420115717">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0120__p6898420205714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0120__p98985203570">ID of the cluster that you want to enable Kibana public access</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0120__section16898120165710"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0120__request_StartKibanaPublicReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameter</caption><thead align="left"><tr id="css_03_0120__row1189932017577"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="css_03_0120__p9900122025712">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="css_03_0120__p8900320135716">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="css_03_0120__p1790172025714">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="css_03_0120__p9901192019575">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0120__row389942015579"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="css_03_0120__p6901132095715">eipSize</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="css_03_0120__p109011120195718">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="css_03_0120__p19021020185714">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="css_03_0120__p2902202035715">Bandwidth. Unit: Mbit/s</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0120__row16899142015720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="css_03_0120__p149022020185712">elbWhiteList</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="css_03_0120__p17902620165715">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="css_03_0120__p109037209573"><a href="#css_03_0120__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="css_03_0120__p15903162035720">ELB whitelist</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0120__request_StartKibanaPublicReqElbWhitelist"></a><a name="request_StartKibanaPublicReqElbWhitelist"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0120__request_StartKibanaPublicReqElbWhitelist" frame="border" border="1" rules="all"><caption><b>Table 3 </b>StartKibanaPublicReqElbWhitelist</caption><thead align="left"><tr id="css_03_0120__row1390819202571"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="css_03_0120__p1590912204578">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="css_03_0120__p69126208574">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="css_03_0120__p2912162005716">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="css_03_0120__p109124209579">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0120__row18908122016573"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="css_03_0120__p4913920195711">enableWhiteList</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="css_03_0120__p49131020195710">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="css_03_0120__p19131120135711">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="css_03_0120__p69141120175718">Indicates whether to enable the whitelist.</p>
|
|
<ul id="css_03_0120__ul491422013571"><li id="css_03_0120__li691412017579"><strong id="css_03_0120__b1589261111219">true</strong>: The whitelist is enabled.</li><li id="css_03_0120__li17914520105711"><strong id="css_03_0120__b121217161321">false</strong>: The whitelist is disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0120__row99094207575"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="css_03_0120__p591419206571">whiteList</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="css_03_0120__p69152203570">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="css_03_0120__p19915132012576">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="css_03_0120__p39152208571">Whitelist</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0120__section1591552015577"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0120__p1091672055718">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0120__section591662095713"><h4 class="sectiontitle">Request Example</h4><ul id="css_03_0120__ul8916172025718"><li id="css_03_0120__li591692025713"><pre class="screen" id="css_03_0120__screen1991712201571">{
|
|
"eipSize" : 5,
|
|
"elbWhiteList" : {
|
|
"enableWhiteList" : true,
|
|
"whiteList" : "192.168.0.xx"
|
|
},
|
|
"isAutoPay" : 1
|
|
}</pre>
|
|
</li><li id="css_03_0120__li59181320145713"><pre class="screen" id="css_03_0120__screen139214202570">{
|
|
"eipSize" : 5,
|
|
"elbWhiteList" : {
|
|
"enableWhiteList" : true,
|
|
"whiteList" : "192.168.0.xx"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="css_03_0120__section13923152005713"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0120__p15924620145716">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0120__section149241120115715"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0120__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0120__row1192542011572"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="css_03_0120__p139261200574">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="css_03_0120__p13927112085712">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0120__row292652014579"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0120__p1992782075710">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0120__p292862085712">The request is processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0120__row1992662019573"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0120__p1892822011575">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0120__p1492892017574">Invalid request.</p>
|
|
<p id="css_03_0120__p1929720165713">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0120__row17926420155717"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0120__p4929220145715">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0120__p16930132005715">The request cannot be processed due to a conflict.</p>
|
|
<p id="css_03_0120__p17930122075712">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_0120__row892615206576"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0120__p593012209578">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0120__p59301207572">The server does not meet one of the requirements that the requester puts on the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0119.html">Kibana Public Network Access</a></div>
|
|
</div>
|
|
</div>
|
|
|