liangxiaobi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpcep/api-ref/vpcep_06_0303.html
Qin Ying, Fan 8aa98e3fe1 vpcep_api 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2022-10-18 12:00:20 +00:00

410 lines
38 KiB
HTML
Raw Blame History

<a name="vpcep_06_0303"></a><a name="vpcep_06_0303"></a>
<h1 class="topictitle1">Creating a VPC Endpoint</h1>
<div id="body41429793"><div class="section" id="vpcep_06_0303__section43389233"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="vpcep_06_0303__p370095">This API is used to create a VPC endpoint for accessing a VPC endpoint service.</p>
</div>
<div class="section" id="vpcep_06_0303__section54958778"><h4 class="sectiontitle">URI</h4><p class="litext" id="vpcep_06_0303__p29977709">POST /v1/{project_id}/vpc-endpoints</p>
<div class="msonormal" id="vpcep_06_0303__p624413203159"><a href="#vpcep_06_0303__table40572397">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="vpcep_06_0303__table40572397"></a><a name="table40572397"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0303__table40572397" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpcep_06_0303__row57566450"><th align="left" class="cellrowborder" valign="top" width="32.65%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpcep_06_0303__p32370843"><strong id="vpcep_06_0303__b193009351313">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_0303__p4792588"><strong id="vpcep_06_0303__b205942361039">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_0303__p52655342"><strong id="vpcep_06_0303__b196929379312">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0303__row37224296"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0303__p62378019">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_0303__p19454791">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_0303__p32334202">Specifies the project ID. For details about how to obtain the project ID, see <a href="vpcep_08_0003_0.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="vpcep_06_0303__section24866956"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0303__ul423524472212"><li class="msonormal" id="vpcep_06_0303__li13235164417221">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0303__table29607260" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="vpcep_06_0303__row33522038"><th align="left" class="cellrowborder" valign="top" width="20.407959204079592%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="vpcep_06_0303__p30930573"><strong id="vpcep_06_0303__b590964517320">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.36816318368163%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="vpcep_06_0303__p22348513"><strong id="vpcep_06_0303__b876411197">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="vpcep_06_0303__p65399129"><strong id="vpcep_06_0303__b159017488317">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.89551044895511%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="vpcep_06_0303__p62838110"><strong id="vpcep_06_0303__b158097143">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0303__row56722135"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0303__p31090221">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0303__p35279943">No</p>
<div class="note" id="vpcep_06_0303__note26594588243"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0303__p466016583249">This parameter is mandatory to create an interface VPC endpoint.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0303__p39103117">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0303__p244375111217">The ID must be the ID of the subnet created in the VPC specified by <strong id="vpcep_06_0303__b8191945122110">vpc_id</strong> and in the format of the UUID.</p>
<p id="vpcep_06_0303__p418516465816">For details, see response field <strong id="vpcep_06_0303__b16931153814488">id</strong> in <a href="https://docs.otc.t-systems.com/api/vpc/vpc_subnet01_0002.html" target="_blank" rel="noopener noreferrer">Querying Subnet Details</a> in the <em id="vpcep_06_0303__i1593243818487">Virtual Private Cloud API Reference</em>.</p>
<p id="vpcep_06_0303__p357318621418">This parameter is mandatory only if you create a VPC endpoint for connecting to an interface VPC endpoint service.</p>
<div class="note" id="vpcep_06_0303__note1510244415810"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="vpcep_06_0303__ul114411483253"><li id="vpcep_06_0303__li665614591249">The CIDR block of the VPC subnet cannot overlap with 198.19.128.0/20.</li><li id="vpcep_06_0303__li434713550244">The destination address of the custom route in the VPC route table cannot overlap with 198.19.128.0/20.</li></ul>
</div></div>
</td>
</tr>
<tr id="vpcep_06_0303__row52014641"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0303__p52436422">endpoint_service_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0303__p19491812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0303__p35332914">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0303__p43393752">Specifies the ID of the VPC endpoint service.</p>
<p id="vpcep_06_0303__p3352101421816">You can obtain the ID of the VPC endpoint service to be connected by performing operations in <a href="vpcep_06_0302.html">Querying Basic Information of a VPC Endpoint Service</a>.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row54999452"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0303__p25770618">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0303__p7045317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0303__p33799780">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0303__p53427648">Specifies the ID of the VPC where the VPC endpoint is to be created.</p>
<p id="vpcep_06_0303__p59954614198">For details, see response field <strong id="vpcep_06_0303__vpcep_06_0201_b9758154713317">id</strong> in <a href="https://docs.otc.t-systems.com/api/vpc/vpc_api01_0002.html" target="_blank" rel="noopener noreferrer">Querying VPC Details</a> in the <em id="vpcep_06_0303__vpcep_06_0201_i12759144715337">Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row11346893"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0303__p182860438018">enable_dns</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0303__p132868431013">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0303__p728634315016">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0303__p1255315192149">Specifies whether to create a private domain name.</p>
<ul id="vpcep_06_0303__ul7640194412147"><li id="vpcep_06_0303__li4640194421415"><strong id="vpcep_06_0303__b144641053101013">true</strong>: indicates that a private domain name is created.</li><li id="vpcep_06_0303__li464014411145"><strong id="vpcep_06_0303__b5944823201120">false</strong>: indicates that a private domain name is not created.</li></ul>
<p id="vpcep_06_0303__p59011829135010">The default value is <strong id="vpcep_06_0303__b789259195017">false</strong>.</p>
<div class="note" id="vpcep_06_0303__note13996125195911"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="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_0303__b960193116271">enable_dns</strong> is set to <strong id="vpcep_06_0303__b1156335172819">true</strong> or <strong id="vpcep_06_0303__b844393752815">false</strong>.</p>
</div></div>
</td>
</tr>
<tr id="vpcep_06_0303__row46314724514"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0303__p20921314144517">tags</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0303__p3931314204513">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0303__p89314144458">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0303__p18931714134517">Lists the resource tags. For details, see <a href="#vpcep_06_0303__table15695152144819">Table 3</a>.</p>
<p id="vpcep_06_0303__p1713015423394">A maximum of 20 tags can be added to each VPC endpoint.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row1487961904518"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0303__p6869132344515">routetables</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0303__p1386917232451">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0303__p168691923164510">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0303__p1489814476216">Lists the IDs of route tables.</p>
<p id="vpcep_06_0303__p178431235172013">For details, see response field <strong id="vpcep_06_0303__b0617155320111">id</strong> in <a href="https://docs.otc.t-systems.com/api/vpc/vpc_route_0002.html" target="_blank" rel="noopener noreferrer">Querying a VPC Route</a> in the <em id="vpcep_06_0303__i66180533110">Virtual Private Cloud API Reference</em>.</p>
<p id="vpcep_06_0303__p20869223194517">This parameter is mandatory only if you create a VPC endpoint for connecting to a gateway VPC endpoint service.</p>
<div class="note" id="vpcep_06_0303__note13572522151911"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0303__p115731227197">If this parameter is not configured, use the default route table.</p>
</div></div>
</td>
</tr>
<tr id="vpcep_06_0303__row1429802964411"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0303__p159701149124410">port_ip</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0303__p11970104919445">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0303__p3970249144419">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0303__p1197012493446">Specifies the IP address for accessing the associated VPC endpoint service.</p>
<p id="vpcep_06_0303__p1397074954416">You can specify IP addresses for accessing the associated VPC endpoint service when creating a VPC endpoint. Only IPv4 addresses are supported.</p>
<p id="vpcep_06_0303__p867517423248">This parameter is mandatory only if you create a VPC endpoint for connecting to an interface VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row4298229184418"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0303__p1697064913441">whitelist</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0303__p20970114919441">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0303__p8970349104420">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0303__p179701249104416">Specifies the whitelist for controlling access to the VPC endpoint.</p>
<p id="vpcep_06_0303__p697184913445">IPv4 addresses or CIDR blocks can be specified to control access when you create a VPC endpoint.</p>
<p id="vpcep_06_0303__p163717616252">This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row42991929124416"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0303__p1197117499448">enable_whitelist</p>
</td>
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0303__p697164919446">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0303__p2971849104416">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0303__p2097154974411">Specifies whether to enable access control.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpcep_06_0303__table15695152144819"></a><a name="table15695152144819"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0303__table15695152144819" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpcep_06_0303__vpcep_06_0201_b786712392144">ResourceTags</strong> parameters</caption><thead align="left"><tr id="vpcep_06_0303__vpcep_06_0201_en-us_topic_0056765542_row4410728"><th align="left" class="cellrowborder" valign="top" width="15.601560156015601%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="vpcep_06_0303__vpcep_06_0201_en-us_topic_0056765542_p21724664"><strong id="vpcep_06_0303__vpcep_06_0201_b1563612711">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.061506150615061%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="vpcep_06_0303__vpcep_06_0201_p10931647101614"><strong id="vpcep_06_0303__vpcep_06_0201_b315728576">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.121712171217123%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="vpcep_06_0303__vpcep_06_0201_en-us_topic_0056765542_p63406242"><strong id="vpcep_06_0303__vpcep_06_0201_b1564672112114">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.21522152215221%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="vpcep_06_0303__vpcep_06_0201_en-us_topic_0056765542_p35632012"><strong id="vpcep_06_0303__vpcep_06_0201_b12940209153810">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0303__vpcep_06_0201_en-us_topic_0056765542_row511887"><td class="cellrowborder" valign="top" width="15.601560156015601%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpcep_06_0303__vpcep_06_0201_en-us_topic_0056765542_p41462866">key</p>
</td>
<td class="cellrowborder" valign="top" width="15.061506150615061%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpcep_06_0303__vpcep_06_0201_p12931547141613">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpcep_06_0303__vpcep_06_0201_en-us_topic_0056765542_p45638969">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.21522152215221%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpcep_06_0303__vpcep_06_0201_p48921437201850">Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).</p>
</td>
</tr>
<tr id="vpcep_06_0303__vpcep_06_0201_en-us_topic_0056765542_row51921052"><td class="cellrowborder" valign="top" width="15.601560156015601%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpcep_06_0303__vpcep_06_0201_en-us_topic_0056765542_p44855704">value</p>
</td>
<td class="cellrowborder" valign="top" width="15.061506150615061%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpcep_06_0303__vpcep_06_0201_p2093118475163">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpcep_06_0303__vpcep_06_0201_en-us_topic_0056765542_p25911262">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.21522152215221%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpcep_06_0303__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>
</li><li id="vpcep_06_0303__li66252755">Example request<pre class="codeblock" id="vpcep_06_0303__codeblock8654414195220">POST https://{endpoint}/v1/{project_id}/vpc-endpoints</pre>
<div class="p" id="vpcep_06_0303__p23281810205213"><pre class="screen" id="vpcep_06_0303__screen19677134585113">{
"subnet_id": "<em id="vpcep_06_0303__i1467714455515">68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de</em>",
"vpc_id": "<em id="vpcep_06_0303__i7677114514514">84758cf5-9c62-43ae-a778-3dbd8370c0a4</em>",
"tags":[
{
"key":"test1",
"value":"test1"
}
],
"endpoint_service_id":"<em id="vpcep_06_0303__i106771245145114">e0c748b7-d982-47df-ba06-b9c8c7650c1a</em>",
"enable_dns":<em id="vpcep_06_0303__i1767734585110">true</em>
}</pre>
</div>
<p id="vpcep_06_0303__p067704513510"></p>
</li></ul>
</div>
<div class="section" id="vpcep_06_0303__section22476016"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0303__ul831920182233"><li class="msonormal" id="vpcep_06_0303__li1031919182239">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0303__table65138754" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="vpcep_06_0303__row19593361"><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_0303__p43558418"><strong id="vpcep_06_0303__b565126763">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_0303__p38570971"><strong id="vpcep_06_0303__b2025320503">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_0303__p37240981"><strong id="vpcep_06_0303__b90552176">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0303__row63729512"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p61816827">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_0303__p41107062">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_0303__p41337730">Specifies the unique ID of the VPC endpoint.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row36495254"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p3325565">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_0303__p935369">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_0303__p20173443232">Specifies the type of the VPC endpoint service that is associated with the VPC endpoint.</p>
<ul id="vpcep_06_0303__ul649612552553"><li id="vpcep_06_0303__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_0303__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>
<p id="vpcep_06_0303__p1318010403317">You can view those VPC endpoint services that are configured by operations people and are visible and accessible to all users. For detailed steps, see <a href="vpcep_06_0301.html">Querying Public VPC Endpoint Services</a>. Perform the operations in <a href="vpcep_06_0201.html">Creating a VPC Endpoint Service</a> to create an interface VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row10796023"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p2062637">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_0303__p32855908">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_0303__p583352918492">Specifies the connection status of the VPC endpoint.</p>
<ul id="vpcep_06_0303__ul1594515565918"><li id="vpcep_06_0303__li294525614916"><strong id="vpcep_06_0303__b1396163511383">pendingAcceptance</strong>: indicates that the VPC endpoint is pending acceptance.</li><li id="vpcep_06_0303__li99451566916"><strong id="vpcep_06_0303__b11729191041010">creating</strong>: indicates the VPC endpoint is being created.</li><li id="vpcep_06_0303__li794514565917"><strong id="vpcep_06_0303__b18375142441019">accepted</strong>: indicates the VPC endpoint has been accepted.</li><li id="vpcep_06_0303__li394617565917"><strong id="vpcep_06_0303__b17317153019104">failed</strong>: indicates the creation of the VPC endpoint failed.</li></ul>
</td>
</tr>
<tr id="vpcep_06_0303__row16105144313515"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p11324544145112">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_0303__p6201713164314">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_0303__p14324144165119">Specifies the <span id="vpcep_06_0303__text1337812195564"></span><span id="vpcep_06_0303__text15194211569">domain</span> status.</p>
<ul id="vpcep_06_0303__ul13303174918418"><li id="vpcep_06_0303__li974320857"><strong id="vpcep_06_0303__b34043383318171">frozen</strong>: indicates that the domain is frozen.</li><li id="vpcep_06_0303__li20304164919415"><strong id="vpcep_06_0303__b8423527061970">active</strong>: indicates that the domain is normal.</li></ul>
</td>
</tr>
<tr id="vpcep_06_0303__row55705628"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p15861989">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_0303__p9752694">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_0303__p51770744">Specifies the name of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row63283514"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p25691048">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_0303__p600154">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_0303__p48612537">Specifies the packet ID of the VPC endpoint.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row34859652"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p5059601">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_0303__p7174526">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_0303__p44265715">Specifies the ID of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row62847121"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p57452006">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_0303__p23100887">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_0303__p72792580273">Specifies whether to create a private domain name.</p>
<ul id="vpcep_06_0303__ul145169269292"><li id="vpcep_06_0303__li95161626192917"><strong id="vpcep_06_0303__b10358124333210">true</strong>: indicates that a private domain name is created.</li><li id="vpcep_06_0303__li45171626102919"><strong id="vpcep_06_0303__b6604154417322">false</strong>: indicates that a private domain name is not created.</li></ul>
<div class="note" id="vpcep_06_0303__note1021533535814"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0303__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_0303__vpcep_06_0303_b960193116271">enable_dns</strong> is set to <strong id="vpcep_06_0303__vpcep_06_0303_b1156335172819">true</strong> or <strong id="vpcep_06_0303__vpcep_06_0303_b844393752815">false</strong>.</p>
</div></div>
</td>
</tr>
<tr id="vpcep_06_0303__row63331262"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p8679183214469">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_0303__p467910327469">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_0303__p116791149101913">Specifies the domain name for accessing the associated VPC endpoint service.</p>
<p id="vpcep_06_0303__p13679143220466">This parameter is only available when <strong id="vpcep_06_0303__b513454594811">enable_dns</strong> is set to <strong id="vpcep_06_0303__b10660919124617">true</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row63900256"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p8538219">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_0303__p20507143">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_0303__p50465883">Specifies the ID of the subnet in the VPC specified by <strong id="vpcep_06_0303__b1757761010202">vpc_id</strong>. The ID is in the UUID format.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row55267714"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p751213210">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_0303__p205121639116">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_0303__p122415282419">Specifies the ID of the VPC where the VPC endpoint is to be created.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row3635902"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p26072634">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_0303__p31508570">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_0303__p22890001">Specifies the creation time of the VPC endpoint.</p>
<p id="vpcep_06_0303__p871616113394">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row18516157"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p23413735">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_0303__p17464402">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_0303__p27321481">Specifies the update time of the VPC endpoint.</p>
<p id="vpcep_06_0303__p181016810016">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row47974230"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__p60707417">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_0303__p18353753">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_0303__p10259005">Specifies the project ID. For details about how to obtain the project ID, see <a href="vpcep_08_0003_0.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row204491010122314"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__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_0303__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_0303__p1510414411116">Lists the resource tags. For details, see <a href="#vpcep_06_0303__table489217571060">Table 5</a>.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row4213193174716"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__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_0303__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_0303__p2538528143320">Specifies the whitelist for controlling access to the VPC endpoint.</p>
<p id="vpcep_06_0303__p386713773414">If you do not specify this parameter, an empty whitelist is returned.</p>
<p id="vpcep_06_0303__p1093618430819">This parameter is available only if you create a VPC endpoint for connecting to an interface VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row192131031144718"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__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_0303__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_0303__p1458051113412">Specifies whether to enable access control.</p>
<ul id="vpcep_06_0303__ul1998774161110"><li id="vpcep_06_0303__li1998719418116"><strong id="vpcep_06_0303__b11313153317138">true</strong>: indicates that access control is enabled.</li><li id="vpcep_06_0303__li3987104110119"><strong id="vpcep_06_0303__b12134145911314">false</strong>: indicates that access control is disabled.</li></ul>
<p id="vpcep_06_0303__p16973392358">If you do not specify this parameter, the whitelist is not enabled.</p>
<p id="vpcep_06_0303__p14198121916915">This parameter is available only if you create a VPC endpoint for connecting to an interface VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0303__row42141317475"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0303__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_0303__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_0303__p422280153614">Lists the IDs of route tables.</p>
<p id="vpcep_06_0303__p17737722113611">If you do not specify this parameter, the route table ID of the VPC is returned.</p>
<p id="vpcep_06_0303__p5900254395">This parameter is available only when you create a VPC endpoint for connecting to a gateway VPC endpoint service.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpcep_06_0303__table489217571060"></a><a name="table489217571060"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0303__table489217571060" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="vpcep_06_0303__vpcep_06_0201_b5155161631">ResourceTags</strong> parameters</caption><thead align="left"><tr id="vpcep_06_0303__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_0303__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p21724664"><strong id="vpcep_06_0303__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_0303__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p63406242"><strong id="vpcep_06_0303__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_0303__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p35632012"><strong id="vpcep_06_0303__vpcep_06_0201_b163691023811">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0303__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_0303__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_0303__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_0303__vpcep_06_0201_vpcep_06_0201_p48921437201850">Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="vpcep_06_0303__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_0303__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_0303__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_0303__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 (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="vpcep_06_0303__ul29731038"><li id="vpcep_06_0303__li20214875">Example response<pre class="screen" id="vpcep_06_0303__screen137531453142013">{
"id": "4189d3c2-8882-4871-a3c2-d380272eed83",
"service_type": "interface",
"marker_id": 322312312312,
"status": "creating",
"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,
"created_at": "2018-01-30T07:42:01.174",
"update_at": "2018-01-30T07:42:01.174",
"tags": [
{
"key": "test1",
"value": "test1"
}
]
}</pre>
<p id="vpcep_06_0303__p142781939112013"></p>
</li></ul>
<div class="section" id="vpcep_06_0303__section8618044"><h4 class="sectiontitle">Status Code</h4><p class="msonormal" id="vpcep_06_0303__p2791867">For details about status codes, see <a href="vpcep_08_0001.html">Status Code</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