forked from docs/doc-exports
Zheng, Xiu
bf0cbd66f9
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>
113 lines
7.3 KiB
HTML
113 lines
7.3 KiB
HTML
<a name="css_03_0107"></a><a name="css_03_0107"></a>
|
|
|
|
<h1 class="topictitle1">Enabling the Public Network Access Control Whitelist</h1>
|
|
<div id="body0000001476035066"><div class="section" id="css_03_0107__section156091755129"><h4 class="sectiontitle">Function</h4><p id="css_03_0107__p1360910551213">This API is used to enable the public network access control whitelist.</p>
|
|
</div>
|
|
<p id="css_03_0107__p06105558210"></p>
|
|
<div class="section" id="css_03_0107__section196111055629"><h4 class="sectiontitle">URI</h4><p id="css_03_0107__p2611355520">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__table1261275518216" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0107__row166127551423"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0107__p861315557210">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__p156137551129">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__p061416551726">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__p56151255621">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0107__row66128551213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0107__p861510551217">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__p16155553211">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0107__p8616135515219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0107__p19616185511212">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__row166128553220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0107__p5617115510216">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__p1961717551424">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0107__p361814559216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0107__p1961819554217">ID of the cluster whose public network access control whitelist you want to enable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0107__section561925519212"><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 parameters</caption><thead align="left"><tr id="css_03_0107__row1061914551629"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="css_03_0107__p116214555214">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__p156218553217">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__p1262205513217">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__p20622155424">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0107__row762010551529"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="css_03_0107__p1862315551629">whiteList</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="css_03_0107__p186232553220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="css_03_0107__p36234551210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="css_03_0107__p16624145512219">IP address of the user for whom the whitelist is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0107__section1162415551621"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0107__p5624185514216">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0107__section2062511551421"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="css_03_0107__screen962613551220">{
|
|
"whiteList" : "192.168.0.xx"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0107__section126271551215"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0107__p1762845518210">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0107__section7628255929"><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__row262918551424"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="css_03_0107__p563055514211">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__p3630115519216">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0107__row562916551226"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0107__p563110555218">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0107__p1463165510211">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0107__row8629165513219"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0107__p146320551522">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0107__p10632125515215">Invalid request.</p>
|
|
<p id="css_03_0107__p19632125516212">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0107__row1163016551026"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0107__p663319551922">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0107__p146348551624">The request could not be completed due to a conflict with the current state of the resource.</p>
|
|
<p id="css_03_0107__p1663412551624">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_0107__row36301055120"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0107__p963535513219">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0107__p96351255621">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_0103.html">Public Network Access</a></div>
|
|
</div>
|
|
</div>
|
|
|