forked from docs/doc-exports
Qin Ying, Fan
e1710ee7e4
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
134 lines
12 KiB
HTML
134 lines
12 KiB
HTML
<a name="vpcep_06_0209"></a><a name="vpcep_06_0209"></a>
|
|
|
|
<h1 class="topictitle1">Batch Adding or Deleting Whitelist Records</h1>
|
|
<div id="body52658159"><div class="section" id="vpcep_06_0209__section1779922"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="vpcep_06_0209__p37452510">This API is used to batch add or delete whitelist records of a VPC endpoint service.</p>
|
|
<div class="note" id="vpcep_06_0209__note167071143201517"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="vpcep_06_0209__p167076435153">Your <span id="vpcep_06_0209__text1512515297533">account</span><span id="vpcep_06_0209__text20746530195316"></span> ID is in the whitelist of your own VPC endpoint service by default.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0209__section16019298"><h4 class="sectiontitle">URI</h4><p class="litext" id="vpcep_06_0209__p13754465">POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/action</p>
|
|
<div class="msonormal" id="vpcep_06_0209__p624413203159"><a href="#vpcep_06_0209__table16108480">Table 1</a> describes parameters in this URI.
|
|
<div class="tablenoborder"><a name="vpcep_06_0209__table16108480"></a><a name="table16108480"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0209__table16108480" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="vpcep_06_0209__row34443075"><th align="left" class="cellrowborder" valign="top" width="32.65%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpcep_06_0209__p38425723"><strong id="vpcep_06_0209__b88821758165117">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.2.3.2.2.4.1.2"><p id="vpcep_06_0209__p25475843"><strong id="vpcep_06_0209__b176481159175118">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.82%" id="mcps1.3.2.3.2.2.4.1.3"><p id="vpcep_06_0209__p50277379"><strong id="vpcep_06_0209__b16569305528">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0209__row45935908"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0209__p29821069">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpcep_06_0209__p66696423">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpcep_06_0209__p33701210">Specifies the project ID. For details about how to obtain the project ID, see <a href="vpcep_08_0003.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0209__row34875436"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0209__p6338038">vpc_endpoint_service_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpcep_06_0209__p43619052">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpcep_06_0209__p43482360">Specifies the ID of the VPC endpoint service.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0209__section9955955"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0209__ul188592039161113"><li class="msonormal" id="vpcep_06_0209__li6858113981112">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0209__table10758598" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="vpcep_06_0209__row52439445"><th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="vpcep_06_0209__p19736666"><strong id="vpcep_06_0209__b487721515524">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="vpcep_06_0209__p20637053172113"><strong id="vpcep_06_0209__b11256164710358">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.141414141414144%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="vpcep_06_0209__p55166099"><strong id="vpcep_06_0209__b5530133416520">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.515151515151516%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="vpcep_06_0209__p39269033"><strong id="vpcep_06_0209__b170799741">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0209__row26675075"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0209__p13197449">permissions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0209__p176371453152114">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0209__p62360485">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0209__p18034492">Lists the whitelist records.</p>
|
|
<p id="vpcep_06_0209__p76111038194314">The record is in the <strong id="vpcep_06_0209__b1365133231514">iam:domain::</strong><em id="vpcep_06_0209__i1010514289444">domain_id</em> format.</p>
|
|
<p id="vpcep_06_0209__p1352132984711">Fields are described as follows:</p>
|
|
<ul id="vpcep_06_0209__ul62895310478"><li id="vpcep_06_0209__li8464734164720"><strong id="vpcep_06_0209__b935331518163">iam:domain::</strong> is fixed.</li><li id="vpcep_06_0209__li147863211493"><em id="vpcep_06_0209__i17905144416583">domain_id</em> indicates the <span id="vpcep_06_0209__text350284375314">account</span><span id="vpcep_06_0209__text13301345155317"></span> ID of the target user.<p id="vpcep_06_0209__p1750851145016">The value contains 1 to 64 characters, including letters, digits, and asterisks (*). If you enter an asterisk, this VPC endpoint service allows access from any VPC endpoints.</p>
|
|
<p id="vpcep_06_0209__p1617325735014">Example: <strong id="vpcep_06_0209__b1224819205238">iam:domain::6e9dfd51d1124e8d8498dce894923a0dd</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0209__row28092706"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0209__p60916736">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0209__p15637165313211">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0209__p35308558">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0209__p183695194593">Specifies the operation to be performed.</p>
|
|
<p id="vpcep_06_0209__p41420916">The value is <strong id="vpcep_06_0209__b129245133539">add</strong> or <strong id="vpcep_06_0209__b260781915531">remove</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="vpcep_06_0209__li0655814135210"><a name="vpcep_06_0209__li0655814135210"></a><a name="li0655814135210"></a>Example request<p id="vpcep_06_0209__p123196461130"><a name="vpcep_06_0209__li0655814135210"></a><a name="li0655814135210"></a>This request is to add a whitelist record to the VPC endpoint service whose ID is <strong id="vpcep_06_0209__b977412814362">4189d3c2-8882-4871-a3c2-d380272eed88</strong>.</p>
|
|
<pre class="codeblock" id="vpcep_06_0209__codeblock3800148143114">POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions/action</pre>
|
|
<pre class="screen" id="vpcep_06_0209__screen43179316284">{
|
|
"permissions":
|
|
[
|
|
"<em id="vpcep_06_0209__i1231683120287">iam:domain::fc973eea581490997e82ea11a1d0101</em>"
|
|
],
|
|
"action":"<em id="vpcep_06_0209__i16317113182813">add</em>"
|
|
} </pre>
|
|
<p id="vpcep_06_0209__p1790121713419">This request is to delete a whitelist record from the VPC endpoint service whose ID is <strong id="vpcep_06_0209__b17990152635017">4189d3c2-8882-4871-a3c2-d380272eed88</strong>.</p>
|
|
<pre class="codeblock" id="vpcep_06_0209__codeblock104153468327">POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions/action</pre>
|
|
<pre class="screen" id="vpcep_06_0209__screen331711312285">{
|
|
"permissions":
|
|
[
|
|
"<em id="vpcep_06_0209__i331713102817">iam:domain::5fc973eea581490997e82ea11a1d0101</em>"
|
|
],
|
|
"action":"<em id="vpcep_06_0209__i12317173182819">remove</em>"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0209__section1126021"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0209__ul15674111131212"><li class="msonormal" id="vpcep_06_0209__li867451116129">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0209__table29718523" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter</caption><thead align="left"><tr id="vpcep_06_0209__row41415880"><th align="left" class="cellrowborder" valign="top" width="28.28282828282828%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpcep_06_0209__p66352009"><strong id="vpcep_06_0209__b765840167">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.303030303030305%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpcep_06_0209__p5803687"><strong id="vpcep_06_0209__b791544931">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.41414141414141%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpcep_06_0209__p336649"><strong id="vpcep_06_0209__b1955840042">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0209__row27268632"><td class="cellrowborder" valign="top" width="28.28282828282828%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0209__p61275579">permissions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.303030303030305%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0209__p04210448589">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.41414141414141%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0209__p8301318441">Lists the whitelist records.</p>
|
|
<p id="vpcep_06_0209__p12963317204216">The permission format is <strong id="vpcep_06_0209__b1126124011505">iam:domain:: 6e9dfd51d1124e8d8498dce894923a0d</strong> or <strong id="vpcep_06_0209__b4281740125018">*</strong>. <strong id="vpcep_06_0209__b1028840105010">*</strong> indicates all users can connect to the VPC endpoint service. <strong id="vpcep_06_0209__b1285813487500">6e9dfd51d1124e8d8498dce894923a0d</strong> indicates the domain ID of the user.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="vpcep_06_0209__ul24625200"><li id="vpcep_06_0209__li33704534">Example response<pre class="screen" id="vpcep_06_0209__screen34905357">{
|
|
"permissions":
|
|
[
|
|
"<em id="vpcep_06_0209__i8590315171311">iam:domain::5fc973eea581490997e82ea11a1d0101</em>",
|
|
"<em id="vpcep_06_0209__i15241919151311">iam:domain::5fc973eea581490997e82ea11a1d0102</em>"
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="vpcep_06_0209__section24098863"><h4 class="sectiontitle">Status Codes</h4><p class="msonormal" id="vpcep_06_0209__p8761701">See <a href="vpcep_08_0001.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpcep_06_0200.html">APIs for Managing VPC Endpoint Services</a></div>
|
|
</div>
|
|
</div>
|
|
|