doc-exports/docs/vpcep/api-ref/vpcep_06_0301.html
Qin Ying, Fan ef5d2cd3cf VPCEP API 20230307 version
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>
2023-06-14 11:56:35 +00:00

224 lines
19 KiB
HTML

<a name="vpcep_06_0301"></a><a name="vpcep_06_0301"></a>
<h1 class="topictitle1">Querying Public VPC Endpoint Services</h1>
<div id="body18558635"><div class="section" id="vpcep_06_0301__section1226995"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="vpcep_06_0301__p26854429">This API is used to query public VPC endpoint services. These services are created by operations people and can be visible to and assessed by all users.</p>
</div>
<div class="section" id="vpcep_06_0301__section11042957"><h4 class="sectiontitle">URI</h4><p class="litext" id="vpcep_06_0301__p48199819">GET /v1/{project_id}/vpc-endpoint-services/public?limit={limit}&amp;offset={offset}&amp;endpoint_service_name={endpoint_service_name}&amp;id={endpoint_service_id}&amp;sort_key={sort_key}&amp;sort_dir={sort_dir}</p>
<div class="msonormal" id="vpcep_06_0301__p624413203159"><a href="#vpcep_06_0301__table52235709">Table 1</a> describes parameters in this URI.
<div class="tablenoborder"><a name="vpcep_06_0301__table52235709"></a><a name="table52235709"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0301__table52235709" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="vpcep_06_0301__row50088028"><th align="left" class="cellrowborder" valign="top" width="32.65%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpcep_06_0301__p30598464"><strong id="vpcep_06_0301__b13906917134110">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_0301__p62556549"><strong id="vpcep_06_0301__b88701118124110">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_0301__p33915731"><strong id="vpcep_06_0301__b1577412196418">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0301__row62819665"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0301__p55228071">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_0301__p44288766">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_0301__p30620285">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>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="vpcep_06_0301__table15507252"></a><a name="table15507252"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0301__table15507252" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="vpcep_06_0301__row19550945"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.4.2.5.1.1"><p id="vpcep_06_0301__p40122709"><strong id="vpcep_06_0301__b4886252426">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_0301__p28714026"><strong id="vpcep_06_0301__b146026819">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_0301__p44134792"><strong id="vpcep_06_0301__b138371333184217">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_0301__p18148374"><strong id="vpcep_06_0301__b2056046537">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0301__row60732156"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0301__p20357603">limit</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0301__p38353138">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0301__p19596498">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0301__p43812523">Specifies the maximum number of public VPC endpoint services displayed on each page.</p>
<p id="vpcep_06_0301__p58768388">The number ranges from <strong id="vpcep_06_0301__b059014481693">0</strong> to <strong id="vpcep_06_0301__b18994550791">1000</strong> and is generally <strong id="vpcep_06_0301__b14762151110419">10</strong>, <strong id="vpcep_06_0301__b157634113418">20</strong>, or <strong id="vpcep_06_0301__b6764141117412">50</strong>. The default number is <strong id="vpcep_06_0301__b1876421111411">10</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0301__row59153444"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0301__p26699621">offset</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0301__p15185687">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0301__p22081121">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0301__p5736126132214">Specifies the offset.</p>
<p id="vpcep_06_0301__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_0301__row58119249"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0301__p10038752">endpoint_service_name</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0301__p7832579">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0301__p30459171">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0301__p51273767">Specifies the name of the public VPC endpoint service. The value is not case-sensitive and supports fuzzy match.</p>
</td>
</tr>
<tr id="vpcep_06_0301__row58810722"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0301__p66048056">id</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0301__p48292326">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0301__p19364373">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0301__p25010413">Specifies the unique ID of the public VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0301__row23767127"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0301__p46089150">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_0301__p42233698">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0301__p65486378">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0301__p562418271823">Specifies the sorting field of the VPC endpoint service list. The field can be:</p>
<ul id="vpcep_06_0301__ul512472071414"><li id="vpcep_06_0301__vpcep_06_0205_li348811372710"><strong id="vpcep_06_0301__vpcep_06_0205_b91061528181018">created_at</strong>: VPC endpoint services are sorted by creation time.</li><li id="vpcep_06_0301__vpcep_06_0205_li8488111318274"><strong id="vpcep_06_0301__vpcep_06_0205_b10717101561115">updated_at</strong>: VPC endpoint services are sorted by update time.</li></ul>
<p id="vpcep_06_0301__p36041148141413">The default field is <strong id="vpcep_06_0301__vpcep_06_0205_b84581912152219">created_at</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0301__row25167737"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0301__p25320844">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_0301__p37722463">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0301__p35620634">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0301__p2195022">Specifies the sorting method of the VPC endpoint service list. The method can be:</p>
<ul id="vpcep_06_0301__ul9628101291617"><li id="vpcep_06_0301__vpcep_06_0205_li3203210322"><strong id="vpcep_06_0301__vpcep_06_0205_b842352706193046">desc</strong>: VPC endpoint services are sorted in descending order.</li><li id="vpcep_06_0301__vpcep_06_0205_li162062117325"><strong id="vpcep_06_0301__vpcep_06_0205_b84235270619316">asc</strong>: VPC endpoint services are sorted in ascending order.</li></ul>
<p id="vpcep_06_0301__p1719319255168">The default method is <strong id="vpcep_06_0301__vpcep_06_0205_b84235270614202">desc</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpcep_06_0301__section32277752"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0301__ul154412303441"><li id="vpcep_06_0301__li45449305443"><a name="vpcep_06_0301__li45449305443"></a><a name="li45449305443"></a>Parameter description<p id="vpcep_06_0301__p105031658191317"><a name="vpcep_06_0301__li45449305443"></a><a name="li45449305443"></a>None</p>
</li></ul>
</div>
<ul id="vpcep_06_0301__ul199061127111717"><li id="vpcep_06_0301__li189061227201719">Example request<pre class="codeblock" id="vpcep_06_0301__codeblock171482017165315">GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/public</pre>
</li></ul>
<div class="section" id="vpcep_06_0301__section64361134"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0301__ul1055920483172"><li class="msonormal" id="vpcep_06_0301__li95596487176">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0301__table359340" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="vpcep_06_0301__row55100582"><th align="left" class="cellrowborder" valign="top" width="24.242424242424242%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="vpcep_06_0301__p33962133"><strong id="vpcep_06_0301__b163156506">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="29.292929292929294%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="vpcep_06_0301__p66578241"><strong id="vpcep_06_0301__b1422498420">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.464646464646464%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="vpcep_06_0301__p24128401"><strong id="vpcep_06_0301__b962148932">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0301__row8243437"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="vpcep_06_0301__p63738686">endpoint_services</p>
</td>
<td class="cellrowborder" valign="top" width="29.292929292929294%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="vpcep_06_0301__p62559980">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="46.464646464646464%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="vpcep_06_0301__p34193630">Lists the VPC endpoint services. For details, see <a href="#vpcep_06_0301__table55935485">Table 4</a>.</p>
</td>
</tr>
<tr id="vpcep_06_0301__row39307221"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="vpcep_06_0301__p29768296">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="29.292929292929294%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="vpcep_06_0301__p62421813">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.464646464646464%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="vpcep_06_0301__p23002082">Specifies the total number of public VPC endpoint services 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_0301__table55935485"></a><a name="table55935485"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0301__table55935485" frame="border" border="1" rules="all"><caption><b>Table 4 </b>endpoint_service parameters</caption><thead align="left"><tr id="vpcep_06_0301__row2212450"><th align="left" class="cellrowborder" valign="top" width="24.240000000000002%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="vpcep_06_0301__p44990746"><strong id="vpcep_06_0301__b01908481117">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="29.659999999999997%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="vpcep_06_0301__p20371786"><strong id="vpcep_06_0301__b498003508">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.1%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="vpcep_06_0301__p39501979"><strong id="vpcep_06_0301__b545346137">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0301__row45543732"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpcep_06_0301__p65163710">id</p>
</td>
<td class="cellrowborder" valign="top" width="29.659999999999997%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpcep_06_0301__p43769185">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.1%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpcep_06_0301__p55643076">Specifies the unique ID of the public VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0301__row50153511499"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpcep_06_0301__p22343611293">owner</p>
</td>
<td class="cellrowborder" valign="top" width="29.659999999999997%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpcep_06_0301__p1234176152920">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.1%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpcep_06_0301__p1234266298">Specifies the owner of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0301__row31025637"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpcep_06_0301__p30048651">service_name</p>
</td>
<td class="cellrowborder" valign="top" width="29.659999999999997%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpcep_06_0301__p18021703">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.1%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpcep_06_0301__p50471806">Specifies the name of the public VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0301__row51593076"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpcep_06_0301__p18289650">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="29.659999999999997%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpcep_06_0301__p5066656">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.1%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><div class="p" id="vpcep_06_0301__p135911520141219">Specifies the type of the VPC endpoint service. The value can be:<ul id="vpcep_06_0301__vpcep_06_0201_ul87241928184613"><li id="vpcep_06_0301__vpcep_06_0201_li10401049390">Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.</li><li id="vpcep_06_0301__vpcep_06_0201_li1664631084019">Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.</li></ul>
</div>
<p id="vpcep_06_0301__p941115410718">You can perform the operations in <a href="vpcep_06_0303.html">Creating a VPC Endpoint</a> to create VPC endpoints for accessing VPC endpoints of the gateway and interface types.</p>
</td>
</tr>
<tr id="vpcep_06_0301__row2604762"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpcep_06_0301__p9659160">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="29.659999999999997%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpcep_06_0301__p44194499">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.1%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpcep_06_0301__p22890001">Specifies the creation time of the VPC endpoint service.</p>
<p id="vpcep_06_0301__p871616113394">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="vpcep_06_0301__row1162673919385"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpcep_06_0301__p2089991612413">is_charge</p>
</td>
<td class="cellrowborder" valign="top" width="29.659999999999997%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpcep_06_0301__p68996168416">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="46.1%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpcep_06_0301__p1389951614111">Specifies whether the associated VPC endpoint carries a charge.</p>
<ul id="vpcep_06_0301__ul4942193713444"><li id="vpcep_06_0301__li18942937174412"><strong id="vpcep_06_0301__b19200830195415">true</strong>: indicates that the associated VPC endpoint carries a charge.</li><li id="vpcep_06_0301__li19396242194417"><strong id="vpcep_06_0301__b950713385556">false</strong>: indicates that the associated VPC endpoint does not a charge.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="vpcep_06_0301__ul45697134"><li id="vpcep_06_0301__li8621022">Example response<pre class="screen" id="vpcep_06_0301__screen1165113244420">{
"endpoint_services": [
{
"id": "b0e22f6f-26f4-461c-b140-d873464d4fa0",
"owner": "example"
"service_name": "test123",
"service_type": "interface",
"created_at": "2018-09-10T13:13:23Z",
"is_charge": "true"
},
{
"id": "26391a76-546b-42a9-b2fc-496ec68c0e4d",
"owner": "example"
"service_name": "OBS",
"service_type": "gateway",
"created_at": "2019-03-28T09:30:27Z",
"is_charge": "true"
}
],
"total_count": 2
}</pre>
</li></ul>
<div class="section" id="vpcep_06_0301__section45869372"><h4 class="sectiontitle">Status Codes</h4><p class="msonormal" id="vpcep_06_0301__p42003979">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>