forked from docs/doc-exports
Qin Ying, Fan
ef5d2cd3cf
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>
199 lines
18 KiB
HTML
199 lines
18 KiB
HTML
<a name="vpcep_06_0208"></a><a name="vpcep_06_0208"></a>
|
|
|
|
<h1 class="topictitle1">Querying Whitelist Records of a VPC Endpoint Service</h1>
|
|
<div id="body10624461"><div class="section" id="vpcep_06_0208__section1446932"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="vpcep_06_0208__p55274980">This API is used to query whitelist records of a VPC endpoint service.</p>
|
|
<div class="note" id="vpcep_06_0208__note167071143201517"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="vpcep_06_0208__p167076435153">Your <span id="vpcep_06_0208__text1767115583526"></span><span id="vpcep_06_0208__text13320011533">domain</span> ID is in the whitelist of your own VPC endpoint service by default.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0208__section13022395"><a name="vpcep_06_0208__section13022395"></a><a name="section13022395"></a><h4 class="sectiontitle">URI</h4><p class="msonormal" id="vpcep_06_0208__p48088416">GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions?permission={permission}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}</p>
|
|
<div class="msonormal" id="vpcep_06_0208__p624413203159"><a href="#vpcep_06_0208__table26447764">Table 1</a> describes parameters in this URI.
|
|
<div class="tablenoborder"><a name="vpcep_06_0208__table26447764"></a><a name="table26447764"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0208__table26447764" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="vpcep_06_0208__row61738601"><th align="left" class="cellrowborder" valign="top" width="32.65%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpcep_06_0208__p34770760"><strong id="vpcep_06_0208__b2989112416347">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_0208__p64968164"><strong id="vpcep_06_0208__b3249162617346">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_0208__p27929892"><strong id="vpcep_06_0208__b11183162783419">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0208__row47728752"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0208__p40823729">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_0208__p18387791">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_0208__p13016113">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_0208__row50036160"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0208__p26397123">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_0208__p57792256">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_0208__p50661149">Specifies the ID of the VPC endpoint service.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpcep_06_0208__table61894122"></a><a name="table61894122"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0208__table61894122" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="vpcep_06_0208__row39767838"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.4.2.5.1.1"><p id="vpcep_06_0208__p67078348"><strong id="vpcep_06_0208__b18624194183415">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.36816318368163%" id="mcps1.3.2.4.2.5.1.2"><p id="vpcep_06_0208__p64637118"><strong id="vpcep_06_0208__b1257163530">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.2.4.2.5.1.3"><p id="vpcep_06_0208__p1115229"><strong id="vpcep_06_0208__b14373215355">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.4.2.5.1.4"><p id="vpcep_06_0208__p23224720"><strong id="vpcep_06_0208__b1185928878">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0208__row13678197122319"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0208__p206781178233">permission</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0208__p2678117182316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0208__p1767810720237">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0208__p943616304386">Specifies the authorized <span id="vpcep_06_0208__text16131185717402">domain</span><span id="vpcep_06_0208__text0290194116"></span> ID. The format is the <strong id="vpcep_06_0208__b208001710908">iam:domain::</strong><em id="vpcep_06_0208__i118001103011">domain_id</em>.</p>
|
|
<p id="vpcep_06_0208__p1522916412237"><em id="vpcep_06_0208__i179214531013">domain_id</em> indicates the <span id="vpcep_06_0208__text18134173414">domain</span><span id="vpcep_06_0208__text235714182415"></span> ID, for example, iam:domain::6e9dfd51d1124e8d8498dce894923a0d</p>
|
|
<p id="vpcep_06_0208__p14770432173810">Fuzzy search is supported. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0208__row2154176"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0208__p40270548">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0208__p40688949">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0208__p7470538">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0208__p1133819">Specifies the maximum number of whitelist records displayed on each page.</p>
|
|
<p id="vpcep_06_0208__p10204378">The number ranges from <strong id="vpcep_06_0208__b1254717241318">0</strong> to <strong id="vpcep_06_0208__b1354113691319">500</strong> and is generally <strong id="vpcep_06_0208__b946715895412">10</strong>,<strong id="vpcep_06_0208__b1847005835417"> 20</strong>, or <strong id="vpcep_06_0208__b2471115814546">50</strong>. The default number is <strong id="vpcep_06_0208__b34732586549">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0208__row24730546"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0208__p57017172">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0208__p54988235">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0208__p24862079">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0208__p5736126132214">Specifies the offset.</p>
|
|
<p id="vpcep_06_0208__p11912494222">All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0208__row66994296244"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0208__p594733716244">sort_key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0208__p129471037182413">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0208__p119471937202418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0208__p562418271823">Specifies the sorting field of the whitelist records. The value is <strong id="vpcep_06_0208__b797574616126">created_at</strong>, indicating that the whitelist records are sorted by creation time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0208__row1253984418240"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0208__p146661827153215">sort_dir</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0208__p1666182717328">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0208__p14666182718326">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0208__p1648594010189">Specifies the sorting method of the whitelist record list. The value can be:</p>
|
|
<ul id="vpcep_06_0208__ul9628101291617"><li id="vpcep_06_0208__vpcep_06_0205_li3203210322"><strong id="vpcep_06_0208__b39503129475">desc</strong>: Whitelist records are sorted in descending order.</li><li id="vpcep_06_0208__vpcep_06_0205_li162062117325"><strong id="vpcep_06_0208__b82461415204717">asc</strong>: Whitelist records are sorted in ascending order.</li></ul>
|
|
<p id="vpcep_06_0208__p1719319255168">The default method is <strong id="vpcep_06_0208__vpcep_06_0205_b84235270614202">desc</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0208__section50092695"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0208__ul169664168351"><li class="msonormal" id="vpcep_06_0208__li11115115714268">Parameter description<p class="msonormal" id="vpcep_06_0208__p1883219121514"><a name="vpcep_06_0208__li11115115714268"></a><a name="li11115115714268"></a>None</p>
|
|
</li><li id="vpcep_06_0208__li610802513518">Example request<div class="p" id="vpcep_06_0208__p1170434913111"><a name="vpcep_06_0208__li610802513518"></a><a name="li610802513518"></a>This request is to query whitelist records of the VPC endpoint service whose ID is <strong id="vpcep_06_0208__b104213258311">4189d3c2-8882-4871-a3c2-d380272eed88</strong>.<pre class="codeblock" id="vpcep_06_0208__codeblock526854815117">GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0208__section30976474"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0208__ul113697391465"><li id="vpcep_06_0208__li436963915619">Parameter description
|
|
<div class="tablenoborder"><a name="vpcep_06_0208__table20176194"></a><a name="table20176194"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0208__table20176194" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="vpcep_06_0208__row11639215"><th align="left" class="cellrowborder" valign="top" width="24.242424242424242%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpcep_06_0208__p3252353"><strong id="vpcep_06_0208__b1433254156">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.292929292929294%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpcep_06_0208__p62114027"><strong id="vpcep_06_0208__b1476430521">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.464646464646464%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpcep_06_0208__p65180310"><strong id="vpcep_06_0208__b1020480401">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0208__row45113770"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0208__p30336717">permissions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.292929292929294%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0208__p41355050">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.464646464646464%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0208__p61424743">Lists the whitelist records. For details, see <a href="#vpcep_06_0208__table50257079">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0208__row15951777"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0208__p17025554">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.292929292929294%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0208__p36892599">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.464646464646464%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0208__p35510520">Specifies the total number of whitelist records that meet the search criteria. The number is not affected by the limit or offset.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpcep_06_0208__table50257079"></a><a name="table50257079"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0208__table50257079" frame="border" border="1" rules="all"><caption><b>Table 4 </b>permissions parameters</caption><thead align="left"><tr id="vpcep_06_0208__row15696288"><th align="left" class="cellrowborder" valign="top" width="17.72%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpcep_06_0208__p63439817"><strong id="vpcep_06_0208__b114315252378">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.94%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpcep_06_0208__p38351587"><strong id="vpcep_06_0208__b1259206973">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.339999999999996%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpcep_06_0208__p19470870"><strong id="vpcep_06_0208__b692195690">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0208__row33636617"><td class="cellrowborder" valign="top" width="17.72%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0208__p40211428">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.94%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0208__p35900240">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.339999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0208__p22238324">Specifies the unique ID of the permission.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0208__row65927195"><td class="cellrowborder" valign="top" width="17.72%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0208__p38502599">permission</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.94%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0208__p31702848">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.339999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0208__p8301318441">Lists the whitelist records.</p>
|
|
<p id="vpcep_06_0208__p17793901">The permission format is <strong id="vpcep_06_0208__b10288112415171">iam:domain:: 6e9dfd51d1124e8d8498dce894923a0d</strong> or <strong id="vpcep_06_0208__b1728912421716">*</strong>. <strong id="vpcep_06_0208__b4289142441711">*</strong> indicates all users can connect to the VPC endpoint service. <strong id="vpcep_06_0208__b61191344184217">6e9dfd51d1124e8d8498dce894923a0d</strong> indicates the domain ID of the user.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0208__row53601861191"><td class="cellrowborder" valign="top" width="17.72%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0208__p173604671910">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.94%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0208__p19531153319202">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.339999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0208__p953193312205">Specifies the description of a whitelist record of a VPC endpoint service. The description can contain a maximum of 128 characters and cannot contain left angle brackets (<) or right angle brackets (>).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0208__row25927387"><td class="cellrowborder" valign="top" width="17.72%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0208__p19743602">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.94%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0208__p55727921">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.339999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0208__p22890001">Specifies when the whitelist record is added.</p>
|
|
<p id="vpcep_06_0208__p871616113394">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="vpcep_06_0208__ul62016923"><li id="vpcep_06_0208__li21281395">Example response<pre class="screen" id="vpcep_06_0208__screen57314827">{
|
|
"permissions":
|
|
[
|
|
{
|
|
"id":"<em id="vpcep_06_0208__i37898721015">f2659906-c622-480a-83e9-ef42bdb67b90</em>",
|
|
"permission":"<em id="vpcep_06_0208__i196769155108">*</em>",
|
|
"description":"demo",
|
|
"created_at":"<em id="vpcep_06_0208__i390411117104">2018-10-18T13:26:40Z</em>"
|
|
}
|
|
],
|
|
"total_count":<em id="vpcep_06_0208__i16620144131420">1</em>
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="vpcep_06_0208__section26066437"><h4 class="sectiontitle">Status Codes</h4><p class="msonormal" id="vpcep_06_0208__p11989383">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>
|
|
|