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

489 lines
50 KiB
HTML
Raw Blame History

<a name="vpcep_06_0201"></a><a name="vpcep_06_0201"></a>
<h1 class="topictitle1">Creating a VPC Endpoint Service</h1>
<div id="body10659114"><div class="section" id="vpcep_06_0201__section49369256"><a name="vpcep_06_0201__section49369256"></a><a name="section49369256"></a><h4 class="sectiontitle">Function</h4><p class="msonormal" id="vpcep_06_0201__p58081920">This API is used to create a VPC endpoint service. Other users can create a VPC endpoint to connect to the endpoint service.</p>
<div class="note" id="vpcep_06_0201__note91020528135"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="vpcep_06_0201__p1287461961410">This API is asynchronous. If it is successfully invoked, status code <strong id="vpcep_06_0201__b1629483817117">200</strong> is returned, indicating that the request has been successfully delivered. It takes 1 to 2 minutes to create a VPC endpoint service. You can view the creation result by performing operations in <a href="vpcep_06_0202.html">Querying Details About a VPC Endpoint Service</a>.</p>
</div></div>
</div>
<div class="section" id="vpcep_06_0201__section41670120"><h4 class="sectiontitle">URI</h4><p class="msonormal" id="vpcep_06_0201__p63135782">POST /v1/{project_id}/vpc-endpoint-services</p>
<div class="msonormal" id="vpcep_06_0201__p624413203159"><a href="#vpcep_06_0201__d0e2135">Table 1</a> describes the parameter in this URI.
<div class="tablenoborder"><a name="vpcep_06_0201__d0e2135"></a><a name="d0e2135"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0201__d0e2135" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="vpcep_06_0201__row8845746"><th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpcep_06_0201__p45416839"><strong id="vpcep_06_0201__b6872143614716">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.2.3.2.2.4.1.2"><p id="vpcep_06_0201__p54885328"><strong id="vpcep_06_0201__b84235270619640">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41%" id="mcps1.3.2.3.2.2.4.1.3"><p id="vpcep_06_0201__p16526582"><strong id="vpcep_06_0201__b1320433479">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0201__row63584736"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0201__p50089974">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpcep_06_0201__p30756130">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="41%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpcep_06_0201__p8218569">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>
<div class="section" id="vpcep_06_0201__section39486763"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0201__ul13206184771918"><li class="msonormal" id="vpcep_06_0201__li820654771914">Parameter description
<div class="tablenoborder"><a name="vpcep_06_0201__ref520834027"></a><a name="ref520834027"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0201__ref520834027" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="vpcep_06_0201__row4849437"><th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="vpcep_06_0201__p57260105"><strong id="vpcep_06_0201__b796910283482">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="vpcep_06_0201__p7556889"><strong id="vpcep_06_0201__b1544111436">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.131313131313133%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="vpcep_06_0201__p8128245"><strong id="vpcep_06_0201__b1501836154812">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.494949494949495%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="vpcep_06_0201__p54408134"><strong id="vpcep_06_0201__b368054208">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0201__row44982772"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0201__p19725926">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0201__p54296197">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0201__p35915832">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.494949494949495%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0201__p1984135532819">Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in universally unique identifier (UUID) format.</p>
<p id="vpcep_06_0201__p23501288">The values are as follows:</p>
<ul id="vpcep_06_0201__ul930495217232"><li id="vpcep_06_0201__li6984352461">If the backend resource is a load balancer, the value is the ID of the port bound to the private IP address of the load balancer. For details, see response field <strong id="vpcep_06_0201__b64381910301">port_id</strong> in <a href="https://docs.otc.t-systems.com/elastic-load-balancing/api-ref/apis_v2.0/load_balancer/querying_details_of_a_load_balancer.html" target="_blank" rel="noopener noreferrer">Querying Details of a Load Balancer</a> and <a href="https://docs.otc.t-systems.com/elastic-load-balancing/api-ref/apis_v3/load_balancer/viewing_details_of_a_load_balancer.html#showloadbalancer" target="_blank" rel="noopener noreferrer">Viewing Details of a Load Balancer</a> in the <em id="vpcep_06_0201__i24390920309">Elastic Load Balancing API Reference</em>.</li><li id="vpcep_06_0201__li17416143014812">If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed. For details, see <strong id="vpcep_06_0201__b681602414176">port_id</strong> in the response in section <a href="https://docs.otc.t-systems.com/en-us/api/ecs/en-us_topic_0020212662.html" target="_blank" rel="noopener noreferrer">Querying NICs of an ECS</a> in the <em id="vpcep_06_0201__i8649112044">Elastic Cloud Server API Reference</em>.</li><li id="vpcep_06_0201__li17881440181816">If the backend resource is a virtual IP address, the value is the port ID of the physical server where virtual resources are created. (This value will be discarded. The LB type is recommended.)</li><li id="vpcep_06_0201__li1684171618416">If the backend resource is a BMS, the value is the NIC ID of the BMS where the VPC endpoint service is deployed. (This value will be discarded. The LB type is recommended.)</li></ul>
<div class="note" id="vpcep_06_0201__note246113343810"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="vpcep_06_0201__ul846143103818"><li id="vpcep_06_0201__li10461936385">To create a VPC endpoint service, the CIDR block of the VPC where the VPC endpoint service is deployed cannot overlap with 198.19.128.0/17.</li><li id="vpcep_06_0201__li1146133163813">The destination address of the custom route in the VPC route table cannot overlap with 198.19.128.0/17.</li></ul>
</div></div>
</td>
</tr>
<tr id="vpcep_06_0201__row970518853214"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0201__p244314143323">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0201__p124439147323">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0201__p1644381433213">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.494949494949495%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0201__p6443514133211">Specifies the ID of the cluster associated with the target VPCEP resource.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row1729441514442"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0201__p15295815134415">service_name</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0201__p6296815164417">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0201__p629611150441">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.494949494949495%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0201__p1970935114472">Specifies the name of the VPC endpoint service. The name can contain a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).</p>
<ul id="vpcep_06_0201__ul16118939152215"><li id="vpcep_06_0201__li19118173914229">If you do not specify this parameter, the VPC endpoint service name is in the format: <strong id="vpcep_06_0201__b124119223595">regionName.serviceId</strong>.</li><li id="vpcep_06_0201__li51187398223">If you specify this parameter, the VPC endpoint service name is in the format: <strong id="vpcep_06_0201__b1540117284016">regionName+.+serviceName+.+serviceId</strong>.</li></ul>
</td>
</tr>
<tr id="vpcep_06_0201__row11878883"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0201__p22665468">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0201__p23963654">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0201__p62007849">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.494949494949495%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0201__p1490095811316">Specifies the ID of the VPC to which the backend resource of the VPC endpoint service belongs.</p>
<p id="vpcep_06_0201__p161940143417">For details, see response field <strong id="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_0201__i12759144715337">Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row39456621"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0201__p41869715">approval_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0201__p36003791">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0201__p30625926">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="49.494949494949495%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0201__p0379724124813">Specifies whether connection approval is required.</p>
<ul id="vpcep_06_0201__ul11323972220"><li id="vpcep_06_0201__li43229102213"><strong id="vpcep_06_0201__b75811234123816">false</strong>: Connection approval is not required. The created VPC endpoint is in the <strong id="vpcep_06_0201__b78271532134215">accepted</strong> state.</li><li id="vpcep_06_0201__li132696225"><strong id="vpcep_06_0201__b15111167142314">true</strong>: Connection approval is required. The created VPC endpoint is in the <strong id="vpcep_06_0201__b109861945115019">pendingAcceptance</strong> state until the owner of the associated VPC endpoint service approves the connection.</li></ul>
<p id="vpcep_06_0201__p1138312242488">The default value is <strong id="vpcep_06_0201__b1593639103810">true</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row27461928"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0201__p9823714">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0201__p57523360">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0201__p28880587">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.494949494949495%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0201__p08121553172517">Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.</p>
<div class="p" id="vpcep_06_0201__p767124834219">There are two types of VPC endpoint services: interface and gateway.<ul id="vpcep_06_0201__ul87241928184613"><li id="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_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_0201__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_0303.html">Creating a VPC Endpoint</a> to create VPC endpoints for accessing VPC endpoint services of the gateway type and interface type.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row37209478"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0201__p61177702">server_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0201__p56446802">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0201__p8788275">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.494949494949495%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0201__p139061546194411">Specifies the resource type.</p>
<ul id="vpcep_06_0201__ul093471482216"><li id="vpcep_06_0201__li1593481419224"><strong id="vpcep_06_0201__b16791645512">LB</strong>: Select this value if the backend resource is a load balancer. Backend resources of this type suit services that receive high access traffic and demand high reliability and disaster recovery (DR) performance.</li><li id="vpcep_06_0201__li189341514142219"><strong id="vpcep_06_0201__b18688124125214">VM</strong>: Select this value if the backend resource is an ECS. Backend resources of this type serve as servers.</li><li id="vpcep_06_0201__li29341214112218"><strong id="vpcep_06_0201__b468419237317">VIP</strong>: Select this value if the backend resource is a virtual IP address. (This value will be discarded. The LB type is recommended.)</li><li id="vpcep_06_0201__li6188752174"><strong id="vpcep_06_0201__b990994016516">BMS</strong>: Select this value if the backend resource is a BMS. (This value will be discarded. The LB type is recommended.)</li></ul>
</td>
</tr>
<tr id="vpcep_06_0201__row8780066"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0201__p40096741">ports</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0201__p26610597">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0201__p7974729">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="49.494949494949495%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0201__p5656200651">Lists the port mappings opened to the VPC endpoint service. For details, see <a href="#vpcep_06_0201__table56834929">Table 3</a>.</p>
<p id="vpcep_06_0201__p41973306">Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same <strong id="vpcep_06_0201__b19168134611101">port_id</strong> value, either <strong id="vpcep_06_0201__b2414194143911">server_port</strong> or <strong id="vpcep_06_0201__b114147413911">protocol</strong>, or both <strong id="vpcep_06_0201__b176601375572">server_port</strong> and <strong id="vpcep_06_0201__b153501142195712">protocol</strong> of each VPC endpoint service must be unique. A maximum of 200 port mappings can be created at a time.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row191058366348"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0201__p6679144311349">tcp_proxy</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0201__p1867920439347">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0201__p368018439344">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.494949494949495%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0201__p17290163812450">Specifies whether the client IP address and port number or <strong id="vpcep_06_0201__b1340623194912">marker_id</strong> information is transmitted to the server. The following methods are supported:</p>
<ul id="vpcep_06_0201__ul18589152018359"><li id="vpcep_06_0201__li148419812461">TCP TOA: The client information is inserted into field <strong id="vpcep_06_0201__b1328024583915">tcp option</strong> and transmitted to the server.<div class="note" id="vpcep_06_0201__note11542930143913"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0201__p654318304392">TCP TOA is supported only when the backend resource is OBS.</p>
</div></div>
</li><li id="vpcep_06_0201__li98558124617">Proxy Protocol: The client information is inserted into field <strong id="vpcep_06_0201__b18340846124016">tcp payload</strong> and transmitted to the server.</li></ul>
<p id="vpcep_06_0201__p2849528112718">This parameter is available only when the server can parse fields <strong id="vpcep_06_0201__b1246063817713">tcp option</strong> and <strong id="vpcep_06_0201__b832154415710">tcp payload</strong>.</p>
<p id="vpcep_06_0201__p12999539124717">The values are as follows:</p>
<ul id="vpcep_06_0201__ul10684011476"><li id="vpcep_06_0201__li46184012471"><strong id="vpcep_06_0201__b485111422">close</strong>: The TOA and Proxy Protocol methods are neither used.</li><li id="vpcep_06_0201__li36440104712"><strong id="vpcep_06_0201__b1432825911248">toa_open</strong>: The TOA method is used.</li><li id="vpcep_06_0201__li186204016473"><strong id="vpcep_06_0201__b1394119162519">proxy_open</strong>: The Proxy Protocol method is used.</li><li id="vpcep_06_0201__li2069403470"><strong id="vpcep_06_0201__b123462452517">open</strong>: The TOA and Proxy Protocol methods are both used.</li><li id="vpcep_06_0201__li47972058516"><strong id="vpcep_06_0201__b15716122802114">proxy_vni</strong>: The TOA Protocol method is not used. Proxy and virtual network ID are used.</li></ul>
<p id="vpcep_06_0201__p249810201616">The default value is <strong id="vpcep_06_0201__b842352706144841">close</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row1522122419321"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0201__p1322222413216">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0201__p522232411328">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0201__p1722217249324">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="49.494949494949495%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0201__p222215247324">Lists the resource tags. For details, see <a href="#vpcep_06_0201__table194945101376">Table 4</a>.</p>
<p id="vpcep_06_0201__p1713015423394">A maximum of 20 tags can be added to each VPC endpoint service.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpcep_06_0201__table56834929"></a><a name="table56834929"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0201__table56834929" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Port parameters</caption><thead align="left"><tr id="vpcep_06_0201__row54069340"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="vpcep_06_0201__p17540449"><strong id="vpcep_06_0201__b10452353115447">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="vpcep_06_0201__p37204434348"><strong id="vpcep_06_0201__b1956043410136">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="vpcep_06_0201__p11490287"><strong id="vpcep_06_0201__b1111841595">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="vpcep_06_0201__p58298029"><strong id="vpcep_06_0201__b1437247493">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0201__row24519875"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpcep_06_0201__p39952858">client_port</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpcep_06_0201__p472013433341">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpcep_06_0201__p137021518125918">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpcep_06_0201__p3481129">Specifies the port for accessing the VPC endpoint.</p>
<p id="vpcep_06_0201__p209011349124811">This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service. Supported range: <strong id="vpcep_06_0201__b89637271421">1</strong> to <strong id="vpcep_06_0201__b62419321421">65535</strong></p>
</td>
</tr>
<tr id="vpcep_06_0201__row31330167"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpcep_06_0201__p54715587">server_port</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpcep_06_0201__p77211043133417">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpcep_06_0201__p109821525125912">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpcep_06_0201__p23652783">Specifies the port for accessing the VPC endpoint service.</p>
<p id="vpcep_06_0201__p1136918011496">This port is provided by the backend service to provide services. Supported range: <strong id="vpcep_06_0201__b99681543184114">1</strong> to <strong id="vpcep_06_0201__b19968643184115">65535</strong></p>
</td>
</tr>
<tr id="vpcep_06_0201__row11548462"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpcep_06_0201__p63010216">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpcep_06_0201__p6721134319347">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpcep_06_0201__p3553891">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpcep_06_0201__p12309165616541">Specifies the port mapping protocol. TCP is supported.</p>
<p id="vpcep_06_0201__p19429767">The default value is <strong id="vpcep_06_0201__b84235270614202">TCP</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpcep_06_0201__table194945101376"></a><a name="table194945101376"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0201__table194945101376" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Tags parameters</caption><thead align="left"><tr id="vpcep_06_0201__en-us_topic_0056765542_row4410728"><th align="left" class="cellrowborder" valign="top" width="15.601560156015601%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="vpcep_06_0201__en-us_topic_0056765542_p21724664"><strong id="vpcep_06_0201__b1563612711">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.061506150615061%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="vpcep_06_0201__p10931647101614"><strong id="vpcep_06_0201__b665969323">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.121712171217123%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="vpcep_06_0201__en-us_topic_0056765542_p63406242"><strong id="vpcep_06_0201__b1564672112114">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.21522152215221%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="vpcep_06_0201__en-us_topic_0056765542_p35632012"><strong id="vpcep_06_0201__b12940209153810">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0201__en-us_topic_0056765542_row511887"><td class="cellrowborder" valign="top" width="15.601560156015601%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="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.3.2.5.1.2 "><p id="vpcep_06_0201__p12931547141613">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="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.3.2.5.1.4 "><p id="vpcep_06_0201__p48921437201850">Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. <strong id="vpcep_06_0201__b98331357143611">key</strong> cannot be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).</p>
</td>
</tr>
<tr id="vpcep_06_0201__en-us_topic_0056765542_row51921052"><td class="cellrowborder" valign="top" width="15.601560156015601%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="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.3.2.5.1.2 "><p id="vpcep_06_0201__p2093118475163">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="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.3.2.5.1.4 "><p id="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_0201__li55615708">Example request<pre class="codeblock" id="vpcep_06_0201__codeblock462262741917">POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services</pre>
<div class="p" id="vpcep_06_0201__p1465142317193"><pre class="screen" id="vpcep_06_0201__screen4803751171810">{
"port_id":"4189d3c2-8882-4871-a3c2-d380272eed88",
"vpc_id":"4189d3c2-8882-4871-a3c2-d380272eed80",
"approval_enabled":false,
"service_type":"interface",
"server_type":"VM",
"ports":
[
{
"client_port":8080,
"server_port":90,
"protocol":"TCP"
},
{
"client_port":8081,
"server_port":80,
"protocol":"TCP"
}
]
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="vpcep_06_0201__section19836555"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0201__ul3348145112313"><li class="msonormal" id="vpcep_06_0201__li1634834516239">Parameter description
<div class="tablenoborder"><a name="vpcep_06_0201__d0e2279"></a><a name="d0e2279"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0201__d0e2279" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameters</caption><thead align="left"><tr id="vpcep_06_0201__row66860061"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpcep_06_0201__p46955892"><strong id="vpcep_06_0201__b10635914719">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpcep_06_0201__p45330870"><strong id="vpcep_06_0201__b439222627">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.99999999999999%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpcep_06_0201__p47921869"><strong id="vpcep_06_0201__b1086127561">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0201__row56466209"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p10360217">id</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p33871262">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p59217687">Specifies the unique ID of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row63197139"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p18694614">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p37868737">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p6738104653019">Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in UUID format. The values are as follows:</p>
<ul id="vpcep_06_0201__ul633165518179"><li id="vpcep_06_0201__vpcep_06_0201_li6984352461">If the backend resource is a load balancer, the value is the ID of the port bound to the private IP address of the load balancer.</li><li id="vpcep_06_0201__vpcep_06_0201_li17416143014812">If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.</li><li id="vpcep_06_0201__vpcep_06_0201_li17881440181816">If the backend resource is a virtual IP address, the value is the port ID of the physical server where virtual resources are created. (This value will be discarded. The LB type is recommended.)</li><li id="vpcep_06_0201__li534551001">If the backend resource is a BMS, the value is the NIC ID of the BMS where the VPC endpoint service is deployed. (This value will be discarded. The LB type is recommended.)</li></ul>
</td>
</tr>
<tr id="vpcep_06_0201__row24566569"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p43735040">service_name</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p52877372">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p55208773">Specifies the name of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row27116914"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p48986392">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p8474815">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p135911520141219">Specifies the type of the VPC endpoint service.</p>
<div class="p" id="vpcep_06_0201__p3359114552814">There are two types of VPC endpoint services: interface and gateway.<ul id="vpcep_06_0201__vpcep_06_0201_ul87241928184613"><li id="vpcep_06_0201__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_0201__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_0201__p20491271179">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_0201__row4124933"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p65684132">server_type</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p18814464">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p115742037154612">Specifies the resource type.</p>
<ul id="vpcep_06_0201__ul180115619307"><li id="vpcep_06_0201__li28085611301"><strong id="vpcep_06_0201__b176367610345">LB</strong>: indicates a load balancer.</li><li id="vpcep_06_0201__li180115615307"><strong id="vpcep_06_0201__b111511354539">VM</strong>: indicates an ECS.</li><li id="vpcep_06_0201__li14801856163015"><strong id="vpcep_06_0201__b111348551533">VIP</strong>: indicates a virtual IP address. (This value has been discarded. The LB type is recommended.)</li><li id="vpcep_06_0201__li142786502511"><strong id="vpcep_06_0201__b10566154617515">BMS</strong>: indicates a BMS. (This value has been discarded. The LB type is recommended.)</li></ul>
</td>
</tr>
<tr id="vpcep_06_0201__row26589709"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p6282859">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p39149581">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p16536246191512">Specifies the ID of the VPC to which the backend resource of the VPC endpoint service belongs.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row13433388428"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p15508124214211">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p145081342114217">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p05087421426">Specifies the ID of the cluster associated with the target VPCEP resource.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row18777919"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p44616508">approval_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p57167385">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p1875615510237">Specifies whether connection approval is required.</p>
<ul id="vpcep_06_0201__ul1775615522311"><li id="vpcep_06_0201__li19756255162316"><strong id="vpcep_06_0201__b524476057">false</strong>: Connection approval is not required. The created VPC endpoint is in the <strong id="vpcep_06_0201__b1443244828">accepted</strong> state.</li><li id="vpcep_06_0201__li175611550235"><strong id="vpcep_06_0201__b4102993">true</strong>: Connection approval is required. The created VPC endpoint is in the <strong id="vpcep_06_0201__b230947185">pendingAcceptance</strong> state until the owner of the associated VPC endpoint service approves the connection.</li></ul>
</td>
</tr>
<tr id="vpcep_06_0201__row37245954"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p64132337">status</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p27336841">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p107216429310">Specifies the status of the VPC endpoint service.</p>
<ul id="vpcep_06_0201__ul353414464460"><li id="vpcep_06_0201__li260495719462"><strong id="vpcep_06_0201__b197875919345">creating</strong>: The VPC endpoint service is being created.</li><li id="vpcep_06_0201__li17737841145111"><strong id="vpcep_06_0201__b12323276351">available</strong>: The VPC endpoint service is connectable.</li><li id="vpcep_06_0201__li1473717412517"><strong id="vpcep_06_0201__b9313171812356">failed</strong>: The VPC endpoint service failed to be created.</li></ul>
</td>
</tr>
<tr id="vpcep_06_0201__row1088027"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p21021397">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p25011624">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p12675643">Specifies the creation time of the VPC endpoint service.</p>
<p id="vpcep_06_0201__p17561950164517">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row46971924"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p46629482">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p18891734">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p53835453">Specifies the update time of the VPC endpoint service.</p>
<p id="vpcep_06_0201__p2629419134616">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row14757035"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p54469209">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p49929783">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p17780589">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_0201__row25807577"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p10038983">ports</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p7851298">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p7734311105614">Lists the port mappings opened to the VPC endpoint service. For details, see <a href="#vpcep_06_0201__table9158581886">Table 6</a>.</p>
<p id="vpcep_06_0201__p1373601110564">Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same <strong id="vpcep_06_0201__b159801931141111">port_id</strong> value, either <strong id="vpcep_06_0201__b191031699416">server_port</strong> or <strong id="vpcep_06_0201__b1740621450">protocol</strong>, or both <strong id="vpcep_06_0201__b156291281054">server_port</strong> and <strong id="vpcep_06_0201__b762912815512">protocol</strong> of each of these endpoint services must be unique.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row3628122492213"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p1898819266227">tcp_proxy</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p139881326142212">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p3988426182213">Specifies whether the client IP address and port number or <strong id="vpcep_06_0201__vpcep_06_0201_b1340623194912">marker_id</strong> information is transmitted to the server. The following methods are supported:</p>
<ul id="vpcep_06_0201__ul113422343220"><li id="vpcep_06_0201__vpcep_06_0201_li148419812461">TCP TOA: The client information is inserted into field <strong id="vpcep_06_0201__vpcep_06_0201_b1328024583915">tcp option</strong> and transmitted to the server.<div class="note" id="vpcep_06_0201__vpcep_06_0201_note11542930143913"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0201__vpcep_06_0201_p654318304392">TCP TOA is supported only when the backend resource is OBS.</p>
</div></div>
</li><li id="vpcep_06_0201__vpcep_06_0201_li98558124617">Proxy Protocol: The client information is inserted into field <strong id="vpcep_06_0201__vpcep_06_0201_b18340846124016">tcp payload</strong> and transmitted to the server.</li></ul>
<p id="vpcep_06_0201__p117219186296">This parameter is available only when the server can parse fields <strong id="vpcep_06_0201__vpcep_06_0201_b1246063817713">tcp option</strong> and <strong id="vpcep_06_0201__vpcep_06_0201_b832154415710">tcp payload</strong>.</p>
<p id="vpcep_06_0201__p29385542114">The values are as follows:</p>
<ul id="vpcep_06_0201__ul523712223"><li id="vpcep_06_0201__vpcep_06_0201_li46184012471"><strong id="vpcep_06_0201__vpcep_06_0201_b485111422">close</strong>: The TOA and Proxy Protocol methods are neither used.</li><li id="vpcep_06_0201__vpcep_06_0201_li36440104712"><strong id="vpcep_06_0201__vpcep_06_0201_b1432825911248">toa_open</strong>: The TOA method is used.</li><li id="vpcep_06_0201__vpcep_06_0201_li186204016473"><strong id="vpcep_06_0201__vpcep_06_0201_b1394119162519">proxy_open</strong>: The Proxy Protocol method is used.</li><li id="vpcep_06_0201__vpcep_06_0201_li2069403470"><strong id="vpcep_06_0201__vpcep_06_0201_b123462452517">open</strong>: The TOA and Proxy Protocol methods are both used.</li><li id="vpcep_06_0201__vpcep_06_0201_li47972058516"><strong id="vpcep_06_0201__vpcep_06_0201_b15716122802114">proxy_vni</strong>: The TOA Protocol method is not used. Proxy and virtual network ID are used.</li></ul>
<p id="vpcep_06_0201__p1725615331720">The default value is <strong id="vpcep_06_0201__vpcep_06_0201_b842352706144841">close</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0201__row6103144416112"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0201__p13103244015">tags</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0201__p21037441512">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0201__p1510414411116">Lists the resource tags. For details, see <a href="#vpcep_06_0201__table489217571060">Table 7</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpcep_06_0201__table9158581886"></a><a name="table9158581886"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0201__table9158581886" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Port parameters</caption><thead align="left"><tr id="vpcep_06_0201__vpcep_06_0201_row54069340"><th align="left" class="cellrowborder" valign="top" width="17.98%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpcep_06_0201__vpcep_06_0201_p17540449"><strong id="vpcep_06_0201__b8302057171210">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.650000000000002%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpcep_06_0201__vpcep_06_0201_p11490287"><strong id="vpcep_06_0201__b1355134319224">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.370000000000005%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpcep_06_0201__vpcep_06_0201_p58298029"><strong id="vpcep_06_0201__b35007480">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0201__vpcep_06_0201_row24519875"><td class="cellrowborder" valign="top" width="17.98%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0201__vpcep_06_0201_p39952858">client_port</p>
</td>
<td class="cellrowborder" valign="top" width="19.650000000000002%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0201__p88823381809">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.370000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0201__vpcep_06_0201_p3481129">Specifies the port for accessing the VPC endpoint.</p>
<p id="vpcep_06_0201__vpcep_06_0201_p209011349124811">This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service. Supported range: <strong id="vpcep_06_0201__b1165913712505">1</strong> to <strong id="vpcep_06_0201__b0659133735013">65535</strong></p>
</td>
</tr>
<tr id="vpcep_06_0201__vpcep_06_0201_row31330167"><td class="cellrowborder" valign="top" width="17.98%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0201__vpcep_06_0201_p54715587">server_port</p>
</td>
<td class="cellrowborder" valign="top" width="19.650000000000002%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0201__vpcep_06_0201_p2777523">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.370000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0201__vpcep_06_0201_p23652783">Specifies the port for accessing the VPC endpoint service.</p>
<p id="vpcep_06_0201__vpcep_06_0201_p1136918011496">This port is provided by the backend service to provide services. Supported range: <strong id="vpcep_06_0201__b44414139517">1</strong> to <strong id="vpcep_06_0201__b145181335112">65535</strong></p>
</td>
</tr>
<tr id="vpcep_06_0201__vpcep_06_0201_row11548462"><td class="cellrowborder" valign="top" width="17.98%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0201__vpcep_06_0201_p63010216">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="19.650000000000002%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0201__vpcep_06_0201_p3553891">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.370000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0201__p1496207155510">Specifies the port mapping protocol. TCP is supported.</p>
<p id="vpcep_06_0201__p169621578551">The default value is <strong id="vpcep_06_0201__b6292721191">TCP</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpcep_06_0201__table489217571060"></a><a name="table489217571060"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0201__table489217571060" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Tags parameters</caption><thead align="left"><tr id="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.3.2.4.1.1"><p id="vpcep_06_0201__vpcep_06_0201_en-us_topic_0056765542_p21724664"><strong id="vpcep_06_0201__b1866348132314">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="vpcep_06_0201__vpcep_06_0201_en-us_topic_0056765542_p63406242"><strong id="vpcep_06_0201__b616714104231">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.91%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="vpcep_06_0201__vpcep_06_0201_en-us_topic_0056765542_p35632012"><strong id="vpcep_06_0201__b163691023811">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="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.3.2.4.1.1 "><p id="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.3.2.4.1.2 "><p id="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.3.2.4.1.3 "><p id="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_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_0201__vpcep_06_0201_en-us_topic_0056765542_row51921052"><td class="cellrowborder" valign="top" width="18.09%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="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.3.2.4.1.2 "><p id="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.3.2.4.1.3 "><p id="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>
</li></ul>
</div>
<ul id="vpcep_06_0201__ul13333376"><li id="vpcep_06_0201__li52891525">Example response<pre class="screen" id="vpcep_06_0201__screen45123516559">{
"id":"4189d3c2-8882-4871-a3c2-d380272eed83",
"port_id":"4189d3c2-8882-4871-a3c2-d380272eed88",
"vpc_id":"4189d3c2-8882-4871-a3c2-d380272eed80",
"pool_id":"5289d3c2-8882-4871-a3c2-d380272eed80",
"status":"available",
"approval_enabled":false,
"service_name":"test123",
"service_type":"interface",
"server_type":"VM",
"project_id":"6e9dfd51d1124e8d8498dce894923a0d",
"created_at":"2018-01-30T07:42:01Z",
"ports":
[
{
"client_port":8080,
"server_port":90,
"protocol":"TCP"
},
{
"client_port":8081,
"server_port":80,
"protocol":"TCP"
}
]
}</pre>
</li></ul>
<div class="section" id="vpcep_06_0201__section63257131"><h4 class="sectiontitle">Status Codes</h4><p class="msonormal" id="vpcep_06_0201__p37434462">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>
View Git Blame Copy Permalink