1
0
forked from docs/doc-exports
doc-exports/docs/css/api-ref/css_03_0107.html
Zheng, Xiu 99a2d77599 css api 23.5.1 20240520
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>
2024-06-07 17:47:08 +00:00

114 lines
7.5 KiB
HTML

<a name="css_03_0107"></a><a name="css_03_0107"></a>
<h1 class="topictitle1">Enabling the Public Network Access Whitelist</h1>
<div id="body0000001476035066"><div class="section" id="css_03_0107__section1337195919015"><h4 class="sectiontitle">Function</h4><p id="css_03_0107__p13825919016">This API is used to enable the public network access whitelist.</p>
</div>
<div class="section" id="css_03_0107__section20381859502"><h4 class="sectiontitle">Debugging</h4><p id="css_03_0107__p4381959707">You can debug this API in . Automatic authentication is supported.</p>
</div>
<div class="section" id="css_03_0107__section133910592001"><h4 class="sectiontitle">URI</h4><p id="css_03_0107__p1839105910010">POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/update</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0107__table1641195915016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0107__row2401059307"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0107__p1741105919012">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_0107__p042115917010">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_0107__p74512591206">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_0107__p18455599016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0107__row194045916014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0107__p04611599011">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0107__p24718599013">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0107__p9485592019">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0107__p348145911012">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_0107__row1140155911020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0107__p348859801">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0107__p194915591507">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0107__p16496593020">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0107__p64912599013">ID of the cluster that you want to enable the public network access whitelist</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0107__section11500591703"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0107__request_StartPublicWhitelistReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameter</caption><thead align="left"><tr id="css_03_0107__row5501659403"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="css_03_0107__p85115915014">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_0107__p4521559606">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_0107__p145310590016">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_0107__p15543591705">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0107__row55012595014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="css_03_0107__p45415917017">whiteList</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="css_03_0107__p25595916019">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="css_03_0107__p105513597018">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="css_03_0107__p17564598020">IP address of the user that enabled public network access whitelist</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0107__section660105911013"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0107__p560659108">None</p>
</div>
<div class="section" id="css_03_0107__section86075916013"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="css_03_0107__screen56195910011">{
"whiteList" : "192.168.0.xx"
}</pre>
</div>
<div class="section" id="css_03_0107__section2624592005"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0107__p18623597016">None</p>
</div>
<div class="section" id="css_03_0107__section12638594010"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0107__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0107__row12651359401"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="css_03_0107__p6661659704">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_0107__p166645915013">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0107__row15651594012"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0107__p12671359805">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0107__p067359505">The request is processed successfully.</p>
</td>
</tr>
<tr id="css_03_0107__row2651259906"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0107__p136718596018">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0107__p368359705">Invalid request.</p>
<p id="css_03_0107__p13689597010">Modify the request instead of retrying.</p>
</td>
</tr>
<tr id="css_03_0107__row165135910010"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0107__p1569959705">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0107__p1169159506">The request cannot be processed due to a conflict.</p>
<p id="css_03_0107__p96985912020">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_0107__row5655591908"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0107__p137065911017">412</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0107__p157013598011">The server does not meet one of the preconditions 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_0103.html">Public Network Access</a></div>
</div>
</div>