liangxiaobi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dcs/api-ref/UpdateIpWhitelist.html
Chen, Junjie 5e34f6ce26 DCS API-REF Initial Version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2022-12-09 16:44:56 +00:00

357 lines
25 KiB
HTML
Raw Blame History

<a name="UpdateIpWhitelist"></a><a name="UpdateIpWhitelist"></a>
<h1 class="topictitle1">Configuring IP Whitelist Groups</h1>
<div id="body0000001374269533"><div class="note" id="UpdateIpWhitelist__note95711281163"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="UpdateIpWhitelist__p105021046151218">IP whitelist groups are supported only by DCS Redis 4.0/5.0 instances, and not by DCS Redis 3.0 instances</p>
</div></div>
<div class="section" id="UpdateIpWhitelist__section4323142018020"><h4 class="sectiontitle">Function</h4><p id="UpdateIpWhitelist__p1832322011019">This API is used to configure IP address whitelist groups for a specific instance, including creating, disabling, editing, and deleting a whitelist. New whitelist settings will overwrite the existing setting. Therefore, save the existing whitelist before you add a new one.</p>
</div>
<div class="section" id="UpdateIpWhitelist__section1632419203018"><h4 class="sectiontitle">URI</h4><p id="UpdateIpWhitelist__p1632515201705">PUT /v2/{project_id}/instance/{instance_id}/whitelist</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateIpWhitelist__table143265202016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="UpdateIpWhitelist__row1732552011014"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateIpWhitelist__p153267203010">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateIpWhitelist__p17326820403">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateIpWhitelist__p33275202019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateIpWhitelist__p183271720406">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateIpWhitelist__row1732518204011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateIpWhitelist__p163278202014">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateIpWhitelist__p1732813207011">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateIpWhitelist__p832816208016">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateIpWhitelist__p0328120707">Project ID.</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row123251200018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateIpWhitelist__p193298201804">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateIpWhitelist__p183299201004">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateIpWhitelist__p143301201205">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateIpWhitelist__p133301720709">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateIpWhitelist__section1331420201"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateIpWhitelist__request_ModifyIpWhitelistBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="UpdateIpWhitelist__row1633114201407"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="UpdateIpWhitelist__p113321201011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="UpdateIpWhitelist__p1533216201506">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="UpdateIpWhitelist__p13333420409">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="UpdateIpWhitelist__p533314209014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateIpWhitelist__row1533112010018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateIpWhitelist__p233312017011">enable_whitelist</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateIpWhitelist__p133341820003">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateIpWhitelist__p16334122019013">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateIpWhitelist__p1334132013019">Whether to enable the whitelist.</p>
<p id="UpdateIpWhitelist__p123351220209">Options:</p>
<ul id="UpdateIpWhitelist__ul103354207011"><li id="UpdateIpWhitelist__li133354201209"><strong id="UpdateIpWhitelist__b73354207010">true</strong></li><li id="UpdateIpWhitelist__li163369201408"><strong id="UpdateIpWhitelist__b533632014012">false</strong></li></ul>
</td>
</tr>
<tr id="UpdateIpWhitelist__row1733113205020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateIpWhitelist__p1833612205016">whitelist</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateIpWhitelist__p733615201406">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateIpWhitelist__p203379203012">Array of <a href="#UpdateIpWhitelist__request_Whitelist">Whitelist</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateIpWhitelist__p83373201501">IP whitelist group.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdateIpWhitelist__request_Whitelist"></a><a name="request_Whitelist"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateIpWhitelist__request_Whitelist" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Whitelist</caption><thead align="left"><tr id="UpdateIpWhitelist__row13381320102"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="UpdateIpWhitelist__p63401220702">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="UpdateIpWhitelist__p123403201707">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="UpdateIpWhitelist__p203401920109">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="UpdateIpWhitelist__p123411120906">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateIpWhitelist__row63391220104"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateIpWhitelist__p12341620509">group_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateIpWhitelist__p10341152017012">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateIpWhitelist__p1834213208019">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateIpWhitelist__p8342152014018">Whitelist group name. A maximum of four groups can be created for each instance.</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row0339182012014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateIpWhitelist__p183421120602">ip_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateIpWhitelist__p133431420505">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateIpWhitelist__p93439201018">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateIpWhitelist__p53431220407">List of IP addresses in the whitelist group. A maximum of 20 IP addresses or IP address ranges can be added to an instance. Separate multiple IP addresses or IP address ranges with commas (,). IP address 0.0.0.0 and IP address range 0.0.0/0 are not supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateIpWhitelist__section63441320409"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateIpWhitelist__p434413206018"><strong id="UpdateIpWhitelist__b18948893245">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateIpWhitelist__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="UpdateIpWhitelist__row1534512012012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="UpdateIpWhitelist__p234616201403">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="UpdateIpWhitelist__p8347162020010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="UpdateIpWhitelist__p123471920504">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateIpWhitelist__row1734514201809"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateIpWhitelist__p3347620401">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateIpWhitelist__p1134817207011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateIpWhitelist__p1834817203010">Error information.</p>
<p id="UpdateIpWhitelist__p034813201401">Maximum length: 1024 characters</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row9345420109"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateIpWhitelist__p33492203015">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateIpWhitelist__p434917201404">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateIpWhitelist__p1735211201105">Error code.</p>
<p id="UpdateIpWhitelist__p43521201304">Maximum length: 9 characters</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row153454201301"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateIpWhitelist__p10353152020013">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateIpWhitelist__p23531720803">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateIpWhitelist__p193546201107">Extended error information. This parameter is not used currently and is set to null.</p>
<p id="UpdateIpWhitelist__p83541420401">Maximum length: 1024 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateIpWhitelist__p173543206017"><strong id="UpdateIpWhitelist__b651015414240">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateIpWhitelist__table1235472019012" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="UpdateIpWhitelist__row1035513204012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="UpdateIpWhitelist__p1635642013012">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="UpdateIpWhitelist__p1435615201108">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="UpdateIpWhitelist__p6357520309">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateIpWhitelist__row1035511201001"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpdateIpWhitelist__p5357192014013">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpdateIpWhitelist__p1235814201300">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpdateIpWhitelist__p193580201507">Error information.</p>
<p id="UpdateIpWhitelist__p635812201601">Maximum length: 1024 characters</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row1355142017017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpdateIpWhitelist__p23599201903">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpdateIpWhitelist__p135915208020">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpdateIpWhitelist__p1636022016010">Error code.</p>
<p id="UpdateIpWhitelist__p11360192019018">Maximum length: 9 characters</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row435519204016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpdateIpWhitelist__p1836152012014">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpdateIpWhitelist__p14361220908">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpdateIpWhitelist__p123625201302">Extended error information. This parameter is not used currently and is set to null.</p>
<p id="UpdateIpWhitelist__p53626200011">Maximum length: 1024 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateIpWhitelist__p163629201008"><strong id="UpdateIpWhitelist__b11323197258">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateIpWhitelist__table7362120408" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="UpdateIpWhitelist__row1236342012019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="UpdateIpWhitelist__p63641420404">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="UpdateIpWhitelist__p1736420201106">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="UpdateIpWhitelist__p1136542011014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateIpWhitelist__row1436313201106"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="UpdateIpWhitelist__p1936532016010">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="UpdateIpWhitelist__p836611201800">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="UpdateIpWhitelist__p336613201002">Error information.</p>
<p id="UpdateIpWhitelist__p23661420206">Maximum length: 1024 characters</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row63637201500"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="UpdateIpWhitelist__p136732016015">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="UpdateIpWhitelist__p9367820101">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="UpdateIpWhitelist__p12367132017013">Error code.</p>
<p id="UpdateIpWhitelist__p193673201009">Maximum length: 9 characters</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row536362010020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="UpdateIpWhitelist__p036819200012">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="UpdateIpWhitelist__p1036811201502">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="UpdateIpWhitelist__p193691420301">Extended error information. This parameter is not used currently and is set to null.</p>
<p id="UpdateIpWhitelist__p73693201606">Maximum length: 1024 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateIpWhitelist__p136910201402"><strong id="UpdateIpWhitelist__b4848826152512">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateIpWhitelist__table43701320108" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="UpdateIpWhitelist__row837015201401"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="UpdateIpWhitelist__p143711920109">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="UpdateIpWhitelist__p1337215201605">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="UpdateIpWhitelist__p183721720605">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateIpWhitelist__row1737010201208"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="UpdateIpWhitelist__p83739205018">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="UpdateIpWhitelist__p1237313202005">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="UpdateIpWhitelist__p17374420105">Error information.</p>
<p id="UpdateIpWhitelist__p13746201209">Maximum length: 1024 characters</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row4370162013016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="UpdateIpWhitelist__p1837411200015">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="UpdateIpWhitelist__p1737532018016">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="UpdateIpWhitelist__p123759209020">Error code.</p>
<p id="UpdateIpWhitelist__p0375162016014">Maximum length: 9 characters</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row1037113207019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="UpdateIpWhitelist__p173766201901">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="UpdateIpWhitelist__p13761620108">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="UpdateIpWhitelist__p0376142010017">Extended error information. This parameter is not used currently and is set to null.</p>
<p id="UpdateIpWhitelist__p8377920104">Maximum length: 1024 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateIpWhitelist__p153771620108"><strong id="UpdateIpWhitelist__b2741193862516">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateIpWhitelist__table143771020908" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="UpdateIpWhitelist__row103770201806"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="UpdateIpWhitelist__p19379920605">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="UpdateIpWhitelist__p193794201409">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="UpdateIpWhitelist__p1837920201906">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateIpWhitelist__row83785201703"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="UpdateIpWhitelist__p1138020201013">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="UpdateIpWhitelist__p938020201204">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="UpdateIpWhitelist__p7380192010018">Error information.</p>
<p id="UpdateIpWhitelist__p13381102010020">Maximum length: 1024 characters</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row19378102013011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="UpdateIpWhitelist__p1381020806">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="UpdateIpWhitelist__p143821420805">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="UpdateIpWhitelist__p19382720704">Error code.</p>
<p id="UpdateIpWhitelist__p938311201408">Maximum length: 9 characters</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row537815201908"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="UpdateIpWhitelist__p113837209016">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="UpdateIpWhitelist__p038314204012">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="UpdateIpWhitelist__p1438412011013">Extended error information. This parameter is not used currently and is set to null.</p>
<p id="UpdateIpWhitelist__p8384020307">Maximum length: 1024 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateIpWhitelist__section1838512209015"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="UpdateIpWhitelist__screen1938632017012">PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist
{
"enable_whitelist" : true,
"whitelist" : [ {
"group_name" : "test001",
"ip_list" : [ "10.10.10.1", "10.10.10.2" ]
} ]
}</pre>
</div>
<div class="section" id="UpdateIpWhitelist__section20388202010013"><h4 class="sectiontitle">Example Response</h4><p id="UpdateIpWhitelist__p103881201305">None</p>
</div>
<div class="section" id="UpdateIpWhitelist__section1338814201501"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateIpWhitelist__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateIpWhitelist__row7389420801"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="UpdateIpWhitelist__p20390520904">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="UpdateIpWhitelist__p10390420506">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateIpWhitelist__row13891420207"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateIpWhitelist__p93911320803">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateIpWhitelist__p13391320305">IP whitelist groups configured successfully.</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row2038982012017"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateIpWhitelist__p43921420509">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateIpWhitelist__p19392132010012">Invalid request.</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row8389182018020"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateIpWhitelist__p1239212209017">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateIpWhitelist__p1739342010011">Invalid authentication information.</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row133891209018"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateIpWhitelist__p839318201408">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateIpWhitelist__p1139319201002">The request is rejected.</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row63894201303"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateIpWhitelist__p839414201018">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateIpWhitelist__p039416201105">The requested resource could not be found.</p>
</td>
</tr>
<tr id="UpdateIpWhitelist__row1039082012011"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateIpWhitelist__p11394120501">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateIpWhitelist__p11395112012015">Internal service error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateIpWhitelist__section103952202012"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateIpWhitelist__p539519201103">See <a href="dcs-api-0312044.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000009.html">Network Security</a></div>
</div>
</div>
View Git Blame Copy Permalink