vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpcep/api-ref/vpcep_06_0304.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

341 lines
32 KiB
HTML
Raw Blame History

<a name="vpcep_06_0304"></a><a name="vpcep_06_0304"></a>
<h1 class="topictitle1">Querying Details About a VPC Endpoint</h1>
<div id="body60513502"><div class="section" id="vpcep_06_0304__section16885652"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="vpcep_06_0304__p2646657">This API is used to query details about a VPC endpoint.</p>
</div>
<div class="section" id="vpcep_06_0304__section17753146"><h4 class="sectiontitle">URI</h4><p class="msonormal" id="vpcep_06_0304__p13052644">GET /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}</p>
<div class="msonormal" id="vpcep_06_0304__p624413203159"><a href="#vpcep_06_0304__table22005568">Table 1</a> describes parameters in this URI.
<div class="tablenoborder"><a name="vpcep_06_0304__table22005568"></a><a name="table22005568"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0304__table22005568" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="vpcep_06_0304__row13047058"><th align="left" class="cellrowborder" valign="top" width="32.65%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpcep_06_0304__p50178752"><strong id="vpcep_06_0304__b784315133388">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_0304__p37947078"><strong id="vpcep_06_0304__b953712152384">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_0304__p53814477"><strong id="vpcep_06_0304__b18591191619384">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0304__row64005372"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0304__p17052668">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_0304__p39088885">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_0304__p12083086">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_0304__row41638910"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0304__p17308522">vpc_endpoint_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_0304__p59813067">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_0304__p13020297">Specifies the ID of the VPC endpoint.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="vpcep_06_0304__section25560587"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0304__ul18115165715262"><li class="msonormal" id="vpcep_06_0304__li11115115714268">Parameter description<p class="msonormal" id="vpcep_06_0304__p1883219121514"><a name="vpcep_06_0304__li11115115714268"></a><a name="li11115115714268"></a>None</p>
</li><li id="vpcep_06_0304__li28832019122719">Example request<div class="p" id="vpcep_06_0304__p1624211315920"><a name="vpcep_06_0304__li28832019122719"></a><a name="li28832019122719"></a>This request is to query details about the VPC endpoint service whose ID is <strong id="vpcep_06_0304__b314022051511">4189d3c2-8882-4871-a3c2-d380272eed83</strong>.<pre class="codeblock" id="vpcep_06_0304__codeblock4814115916">GET https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2-d380272eed83</pre>
</div>
</li></ul>
</div>
<div class="section" id="vpcep_06_0304__section57141695"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0304__ul63478398278"><li class="msonormal" id="vpcep_06_0304__li7347739102710">Parameter description
<div class="tablenoborder"><a name="vpcep_06_0304__table37620597"></a><a name="table37620597"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0304__table37620597" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="vpcep_06_0304__row54996362"><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_0304__p25520307"><strong id="vpcep_06_0304__b1021188675">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_0304__p53878948"><strong id="vpcep_06_0304__b14320349163814">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_0304__p2118662"><strong id="vpcep_06_0304__b622894946">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0304__row37393920"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p9008699">id</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_0304__p58616031">String</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_0304__p50278034">Specifies the unique ID of the VPC endpoint.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row49849130"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p11247738">service_type</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_0304__p38651566">String</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_0304__p20173443232">Specifies the type of the VPC endpoint service that is associated with the VPC endpoint.</p>
<ul id="vpcep_06_0304__ul649612552553"><li id="vpcep_06_0304__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_0304__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>
</td>
</tr>
<tr id="vpcep_06_0304__row58377895"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p30989061">status</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_0304__p27086052">String</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_0304__p583352918492">Specifies the connection status of the VPC endpoint.</p>
<ul id="vpcep_06_0304__ul32642017171417"><li id="vpcep_06_0304__li192651517121415"><strong id="vpcep_06_0304__b1766940194413">pendingAcceptance</strong>: The VPC endpoint is to be accepted.</li><li id="vpcep_06_0304__li1726516179142"><strong id="vpcep_06_0304__b1321917323393">creating</strong>: The VPC endpoint is being created.</li><li id="vpcep_06_0304__li1726581721417"><strong id="vpcep_06_0304__b5827333123919">accepted</strong>: The VPC endpoint has been accepted.</li><li id="vpcep_06_0304__li4265121710148"><strong id="vpcep_06_0304__b1997793453910">rejected</strong>: The VPC endpoint has been rejected.</li><li id="vpcep_06_0304__li1926551751411"><strong id="vpcep_06_0304__b11250636123918">failed</strong>: The VPC endpoint failed to be created.</li><li id="vpcep_06_0304__li1326551711142"><strong id="vpcep_06_0304__b649012385392">deleting</strong>: The VPC endpoint is being deleted.</li></ul>
</td>
</tr>
<tr id="vpcep_06_0304__row1388715392538"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p8122041105310">active_status</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_0304__p1832415441514">Array of strings</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_0304__p14324144165119">Specifies the <span id="vpcep_06_0304__vpcep_06_0303_text1337812195564"></span><span id="vpcep_06_0304__vpcep_06_0303_text15194211569">domain</span> status.</p>
<ul id="vpcep_06_0304__ul15778105411011"><li id="vpcep_06_0304__li1177955461020"><strong id="vpcep_06_0304__b21761561698">arrear_frozen</strong>: frozen due to arrears</li><li id="vpcep_06_0304__li87791554101013"><strong id="vpcep_06_0304__b1496221819912">verify_frozen</strong>: frozen due to lack of real-name authentication</li><li id="vpcep_06_0304__li157790547103"><strong id="vpcep_06_0304__b6497820390">police_frozen</strong>: frozen for legal management</li><li id="vpcep_06_0304__li19779454101011"><strong id="vpcep_06_0304__b1556217215918">illegal_frozen</strong>: frozen due to abuse</li><li id="vpcep_06_0304__li845017031115"><strong id="vpcep_06_0304__b184463229915">partner_frozen</strong>: frozen for partnership</li><li id="vpcep_06_0304__li15779185412103"><strong id="vpcep_06_0304__b133401238918">active</strong>: The <span id="vpcep_06_0304__text134114231598"></span><span id="vpcep_06_0304__text183412023495">domain</span> is normal.</li></ul>
</td>
</tr>
<tr id="vpcep_06_0304__row51268101"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p59075518">endpoint_service_name</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_0304__p20387688">String</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_0304__p40790059">Specifies the name of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row31566213"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p6726431">marker_id</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_0304__p7970021">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_0304__p41592001">Specifies the packet ID of the VPC endpoint.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row38783689"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p54471134">endpoint_service_id</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_0304__p50085756">String</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_0304__p30414410">Specifies the ID of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row5294234"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p26179828">enable_dns</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_0304__p40191314">Boolean</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_0304__p72792580273">Specifies whether to create a private domain name.</p>
<ul id="vpcep_06_0304__ul145169269292"><li id="vpcep_06_0304__li95161626192917"><strong id="vpcep_06_0304__b9726154032110">true</strong>: A private domain name is created.</li><li id="vpcep_06_0304__li45171626102919"><strong id="vpcep_06_0304__b2911242202119">false</strong>: A private domain name is not created.</li></ul>
<div class="note" id="vpcep_06_0304__note1021533535814"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0304__vpcep_06_0303_p119994525918">When a VPC endpoint for connecting to a gateway VPC endpoint service is created, no private domain name is created no matter <strong id="vpcep_06_0304__vpcep_06_0303_b960193116271">enable_dns</strong> is set to <strong id="vpcep_06_0304__vpcep_06_0303_b1156335172819">true</strong> or <strong id="vpcep_06_0304__vpcep_06_0303_b844393752815">false</strong>.</p>
</div></div>
</td>
</tr>
<tr id="vpcep_06_0304__row40003590"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p19065375">dns_names</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_0304__p791512">Array of strings</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_0304__p64112473">Specifies the domain name for accessing the associated VPC endpoint service.</p>
<div class="note" id="vpcep_06_0304__note12165173942919"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0304__vpcep_06_0303_p20166739192912">This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service and <strong id="vpcep_06_0304__b19807293645557">enable_dns</strong> is set to <strong id="vpcep_06_0304__b15910335135557">true</strong>.</p>
</div></div>
</td>
</tr>
<tr id="vpcep_06_0304__row40141348"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p30223781">ip</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_0304__p32207235">String</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_0304__p136794324466">Specifies the IP address for accessing the associated VPC endpoint service.</p>
<p id="vpcep_06_0304__p3149164017153">This parameter is returned only under the following conditions:</p>
<ul id="vpcep_06_0304__ul146842035181816"><li id="vpcep_06_0304__li668413551811">You query a VPC endpoint for accessing an interface VPC endpoint service.</li><li id="vpcep_06_0304__li1168415355187">The connection approval function is enabled for the VPC endpoint service, and the connection has been approved.<p id="vpcep_06_0304__p753135720212"><a name="vpcep_06_0304__li1168415355187"></a><a name="li1168415355187"></a>The status of the VPC endpoint can be <strong id="vpcep_06_0304__b918718321178">Accepted</strong> or <strong id="vpcep_06_0304__b14930933772">Rejected</strong>. The <strong id="vpcep_06_0304__b11266144183514">Rejected</strong> status only appears when the VPC endpoint is accepted and then rejected.</p>
</li></ul>
</td>
</tr>
<tr id="vpcep_06_0304__row596514534219"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p72595555215">vpc_id</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_0304__p1725913551625">String</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_0304__p53427648">Specifies the ID of the VPC where the VPC endpoint is to be created.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row52205435"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p781836">subnet_id</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_0304__p63328721">String</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_0304__p1593291111113">Specifies the ID of the subnet in the VPC specified by <strong id="vpcep_06_0304__vpcep_06_0303_b1757761010202">vpc_id</strong>. The ID is in UUID format.</p>
<div class="note" id="vpcep_06_0304__note1977123123310"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0304__p48629317123">This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.</p>
</div></div>
</td>
</tr>
<tr id="vpcep_06_0304__row62848201"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p57539553">created_at</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_0304__p30192201">String</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_0304__p22890001">Specifies the creation time of the VPC endpoint.</p>
<p id="vpcep_06_0304__p871616113394">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row65516150"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p5207934">updated_at</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_0304__p19189523">String</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_0304__p27321481">Specifies the update time of the VPC endpoint.</p>
<p id="vpcep_06_0304__p181016810016">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row30518784"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p56102419">project_id</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_0304__p48002062">String</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_0304__p62961818">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_0304__row323004311252"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p13103244015">tags</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_0304__p21037441512">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_0304__p1510414411116">Lists the resource tags. For details, see <a href="#vpcep_06_0304__table489217571060">Table 3</a>.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row198546211357"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p152721023351">error</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_0304__p12721234511">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_0304__p84071479448">Specifies the error message.</p>
<p id="vpcep_06_0304__p45203393322">This field is returned when the status of the VPC endpoint changes to <strong id="vpcep_06_0304__b97214711155">failed</strong>. For details, see <a href="#vpcep_06_0304__table14419242754">Table 4</a>.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row20357162719161"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p165011381477">whitelist</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_0304__p450173820473">Array of strings</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_0304__p2538528143320">Specifies the whitelist for controlling access to the VPC endpoint.</p>
<p id="vpcep_06_0304__p386713773414">If you do not specify this parameter, an empty whitelist is returned.</p>
<div class="note" id="vpcep_06_0304__note0675183412207"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0304__vpcep_06_0303_p197191540171910">This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.</p>
</div></div>
</td>
</tr>
<tr id="vpcep_06_0304__row780312293161"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p050938124710">enable_whitelist</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_0304__p85019382479">Boolean</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_0304__p1458051113412">Specifies whether access control is enabled.</p>
<ul id="vpcep_06_0304__ul1343419257325"><li id="vpcep_06_0304__vpcep_06_0303_li1998719418116"><strong id="vpcep_06_0304__vpcep_06_0303_b1795943787">true</strong>: Access control is enabled.</li><li id="vpcep_06_0304__vpcep_06_0303_li3987104110119"><strong id="vpcep_06_0304__vpcep_06_0303_b12134145911314">false</strong>: Access control is disabled.</li></ul>
<p id="vpcep_06_0304__p16973392358">If you do not specify this parameter, the whitelist is not enabled.</p>
<div class="note" id="vpcep_06_0304__note85431946172215"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0304__vpcep_06_0303_p197191540171910_1">This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.</p>
</div></div>
</td>
</tr>
<tr id="vpcep_06_0304__row1598111334163"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p9502038174719">routetables</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_0304__p650203810476">Array of strings</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_0304__p422280153614">Lists the IDs of route tables.</p>
<p id="vpcep_06_0304__p17737722113611">If you do not specify this parameter, the route table ID of the VPC is returned.</p>
<div class="note" id="vpcep_06_0304__note54641152642"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0304__vpcep_06_0303_p81061157249">This parameter is available only when you create a VPC endpoint for connecting to a gateway VPC endpoint service.</p>
</div></div>
</td>
</tr>
<tr id="vpcep_06_0304__row127151532142718"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p1853163320202">description</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_0304__p15531163322013">String</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_0304__p953193312205">Specifies the description of the VPC endpoint.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row123961653174611"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p52731546125215">specification_name</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_0304__p027354685220">String</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_0304__p927410461524">Specifies the name of the VPC endpoint specifications.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row9420112424714"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p186639235611">endpoint_pool_id</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_0304__p9758339428">String</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_0304__p1375873919211">(To be discarded) Specifies the ID of the cluster associated with the VPC endpoint.</p>
</td>
</tr>
<tr id="vpcep_06_0304__row1739575344610"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0304__p12741546125216">enable_status</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_0304__p86691815583">String</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_0304__p6274174685214">Specifies whether to enable the endpoint.</p>
<ul id="vpcep_06_0304__ul2871132125712"><li id="vpcep_06_0304__li187143210573"><strong id="vpcep_06_0304__b2660136094">enable</strong>: The endpoint will be enabled.</li><li id="vpcep_06_0304__li18871832205714"><strong id="vpcep_06_0304__b315117391911">disable</strong>: The endpoint will be disabled.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpcep_06_0304__table489217571060"></a><a name="table489217571060"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0304__table489217571060" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Tags parameters</caption><thead align="left"><tr id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_row4410728"><th align="left" class="cellrowborder" valign="top" width="18.09%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p21724664"><strong id="vpcep_06_0304__vpcep_06_0201_b1866348132314">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p63406242"><strong id="vpcep_06_0304__vpcep_06_0201_b616714104231">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.91%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p35632012"><strong id="vpcep_06_0304__vpcep_06_0201_b163691023811">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_row511887"><td class="cellrowborder" valign="top" width="18.09%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p41462866">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p45638969">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.91%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_p48921437201850">Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. <strong id="vpcep_06_0304__vpcep_06_0201_b1957518572342">key</strong> cannot be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).</p>
</td>
</tr>
<tr id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_row51921052"><td class="cellrowborder" valign="top" width="18.09%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p44855704">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p25911262">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.91%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0304__vpcep_06_0201_vpcep_06_0201_p61714725112922">Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpcep_06_0304__table14419242754"></a><a name="table14419242754"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0304__table14419242754" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Error parameters</caption><thead align="left"><tr id="vpcep_06_0304__vpcep_06_0202_row4652255153018"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="vpcep_06_0304__vpcep_06_0202_p665015573309"><strong id="vpcep_06_0304__vpcep_06_0202_b085424117110">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.630000000000003%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="vpcep_06_0304__vpcep_06_0202_p865015710307"><strong id="vpcep_06_0304__vpcep_06_0202_b2057561169">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.029999999999994%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="vpcep_06_0304__vpcep_06_0202_p1565011575303"><strong id="vpcep_06_0304__vpcep_06_0202_b1010514442017">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0304__vpcep_06_0202_row865255513010"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0304__vpcep_06_0202_p96501057153013">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20.630000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpcep_06_0304__vpcep_06_0202_p6650155710309">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.029999999999994%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpcep_06_0304__vpcep_06_0202_p12650557133019">Specifies the error code.</p>
</td>
</tr>
<tr id="vpcep_06_0304__vpcep_06_0202_row186521755153018"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0304__vpcep_06_0202_p10650057123018">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="20.630000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpcep_06_0304__vpcep_06_0202_p14650157113016">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.029999999999994%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpcep_06_0304__vpcep_06_0202_p156501957183013">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="vpcep_06_0304__ul66742494"><li id="vpcep_06_0304__li63811541"><a name="vpcep_06_0304__li63811541"></a><a name="li63811541"></a>Example response<pre class="screen" id="vpcep_06_0304__screen137531453142013">{
"id": "4189d3c2-8882-4871-a3c2-d380272eed83",
"status": "accepted",
"service_type": "interface",
"marker_id": 322312312312,
"active_status":[
"active"
],
"vpc_id": "4189d3c2-8882-4871-a3c2-d380272eed83",
"enable_dns": false,
"endpoint_service_name": "test123",
"endpoint_service_id": "test123",
"project_id": "6e9dfd51d1124e8d8498dce894923a0d",
"whitelist": [
"127.0.0.1"
],
"enable_whitelist": true,
"specification_name":"default",
"endpoint_pool_id":"501f4a3b-6f96-4309-97d1-e291b8ca5b96",
"description":"demo",
"created_at": "2018-01-30T07:42:01Z",
"updated_at": "2018-01-30T07:42:01Z",
"description" : "",
"tags": [
{
"key": "test1",
"value": "test1"
}
]
}</pre>
</li></ul>
<div class="section" id="vpcep_06_0304__section65074583"><h4 class="sectiontitle">Status Codes</h4><p class="msonormal" id="vpcep_06_0304__p46341903">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_0300.html">APIs for Managing VPC Endpoints</a></div>
</div>
</div>
View Git Blame Copy Permalink