1
0
forked from docs/doc-exports
doc-exports/docs/css/api-ref/css_03_0122.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

137 lines
9.0 KiB
HTML

<a name="css_03_0122"></a><a name="css_03_0122"></a>
<h1 class="topictitle1">Modifying the Kibana Public Network Bandwidth</h1>
<div id="body0000001475770376"><div class="section" id="css_03_0122__section440514411301"><h4 class="sectiontitle">Function</h4><p id="css_03_0122__p1240616411806">This API is used to modify the public network bandwidth of Kibana.</p>
</div>
<div class="section" id="css_03_0122__section1740919415014"><h4 class="sectiontitle">URI</h4><p id="css_03_0122__p20410204112018">POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidth</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0122__table1241110411103" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0122__row1941124119018"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0122__p1641215411407">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_0122__p17412194113010">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_0122__p841213411006">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_0122__p1741314414020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0122__row17411641709"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0122__p6413114110019">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0122__p1041411411904">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0122__p1341444112019">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0122__p144141941504">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_0122__row8411741902"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0122__p134151841403">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0122__p04151341701">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0122__p1441524110015">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0122__p13416194110010">ID of the cluster whose Kibana public network bandwidth you want to modify.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0122__section6416194120012"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0122__request_UpdatePublicKibanaBandwidthReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="css_03_0122__row194178412004"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="css_03_0122__p3419841603">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_0122__p12419241504">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_0122__p141919411102">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_0122__p104201241201">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0122__row64171541806"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0122__p13420104118012">bandWidth</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0122__p19421184111014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0122__p2421104111018"><a href="#css_03_0122__request_UpdatePublicKibanaBandwidthReqBandWidth">UpdatePublicKibanaBandwidthReqBandWidth</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0122__p1142211411504">Bandwidth.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0122__request_UpdatePublicKibanaBandwidthReqBandWidth"></a><a name="request_UpdatePublicKibanaBandwidthReqBandWidth"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0122__request_UpdatePublicKibanaBandwidthReqBandWidth" frame="border" border="1" rules="all"><caption><b>Table 3 </b>UpdatePublicKibanaBandwidthReqBandWidth</caption><thead align="left"><tr id="css_03_0122__row64295411107"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0122__p124305411605">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_0122__p54309413020">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_0122__p2430134116018">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_0122__p134315411905">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0122__row24293416012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0122__p1743116411609">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0122__p84316413014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0122__p174327417015">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0122__p44322412010">New bandwidth size.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0122__section124328411104"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0122__p143214110013">None</p>
</div>
<div class="section" id="css_03_0122__section543314411508"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="css_03_0122__screen743354119016">{
"bandWidth" : {
"size" : 5
}
}</pre>
</div>
<div class="section" id="css_03_0122__section1843494117018"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0122__p243564115020">None</p>
</div>
<div class="section" id="css_03_0122__section184351541509"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0122__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0122__row1543620411304"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0122__p12436641702">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_0122__p18437041804">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0122__row144361441906"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0122__p1443720411901">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0122__p8437114116020">Request succeeded.</p>
</td>
</tr>
<tr id="css_03_0122__row154367411603"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0122__p1043854110017">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0122__p144381941801">Invalid request.</p>
<p id="css_03_0122__p1643944110013">Modify the request before retry.</p>
</td>
</tr>
<tr id="css_03_0122__row1043611411108"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0122__p1444064119013">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0122__p154408415017">The request could not be completed due to a conflict with the current state of the resource.</p>
<p id="css_03_0122__p184407411505">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="css_03_0122__row543612411508"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0122__p104417416017">412</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0122__p644116419015">The server did not meet one of the preconditions contained in 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>