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

421 lines
44 KiB
HTML
Raw Blame History

<a name="vpcep_06_0203"></a><a name="vpcep_06_0203"></a>
<h1 class="topictitle1">Modifying a VPC Endpoint Service</h1>
<div id="body56914325"><div class="section" id="vpcep_06_0203__section49925986"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="vpcep_06_0203__p46657603">This API is used to modify a VPC endpoint service.</p>
</div>
<div class="section" id="vpcep_06_0203__section46680697"><h4 class="sectiontitle">URI</h4><p class="msonormal" id="vpcep_06_0203__p21169502">PUT /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}</p>
<div class="msonormal" id="vpcep_06_0203__p624413203159"><a href="#vpcep_06_0203__table28352855">Table 1</a> describes parameters in this URI.
<div class="tablenoborder"><a name="vpcep_06_0203__table28352855"></a><a name="table28352855"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0203__table28352855" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="vpcep_06_0203__row62825334"><th align="left" class="cellrowborder" valign="top" width="32.65%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpcep_06_0203__p55687332"><strong id="vpcep_06_0203__b92761418131619">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_0203__p14380054"><strong id="vpcep_06_0203__b181859190168">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_0203__p23933749"><strong id="vpcep_06_0203__b203262205169">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0203__row59585512"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0203__p61697176">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_0203__p31415340">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_0203__p61614605">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_0203__row17660533"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0203__p21217075">vpc_endpoint_service_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpcep_06_0203__p40861554">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_0203__p21451610">Specifies the ID of the VPC endpoint service.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="vpcep_06_0203__section17473095"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0203__ul7280829192120"><li class="msonormal" id="vpcep_06_0203__li428072914214">Parameter description
<div class="tablenoborder"><a name="vpcep_06_0203__table14879924"></a><a name="table14879924"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0203__table14879924" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="vpcep_06_0203__row6602325"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="vpcep_06_0203__p65026297"><strong id="vpcep_06_0203__b17745537131614">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="vpcep_06_0203__p32638698"><strong id="vpcep_06_0203__b1326380784">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="vpcep_06_0203__p26488847"><strong id="vpcep_06_0203__b1273283321716">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="vpcep_06_0203__p65221840"><strong id="vpcep_06_0203__b517608212">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0203__row48477719"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0203__p34381129">approval_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0203__p33408080">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0203__p21699988">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0203__p11315182920485">Specifies whether connection approval is required.</p>
<ul id="vpcep_06_0203__ul15639203204411"><li id="vpcep_06_0203__li1863913384414"><strong id="vpcep_06_0203__b769518422617">false</strong>: Connection approval is not required. The created VPC endpoint is in the <strong id="vpcep_06_0203__b1670881064318">accepted</strong> state.</li><li id="vpcep_06_0203__li56391534445"><strong id="vpcep_06_0203__b264772611">true</strong>: Connection approval is required. The created VPC endpoint is unavailable until the owner of the associated VPC endpoint service approves the connection.</li></ul>
<p id="vpcep_06_0203__p186091411112511">The default value is <strong id="vpcep_06_0203__b126481817269">true</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row06694455413"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0203__p15295815134415">service_name</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0203__p6296815164417">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0203__p629611150441">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0203__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>
</td>
</tr>
<tr id="vpcep_06_0203__row7964250"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0203__p41124512">ports</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0203__p42751146">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0203__p40290784">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0203__p206491548175719">Lists the port mappings opened to the VPC endpoint service. For details, see <a href="#vpcep_06_0203__table1186184673416">Table 3</a>.</p>
<p id="vpcep_06_0203__p3651104885713">Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same <strong id="vpcep_06_0203__b229032215128">port_id</strong> value, either <strong id="vpcep_06_0203__b0465103818361">server_port</strong> or <strong id="vpcep_06_0203__b145091044133620">protocol</strong>, or both <strong id="vpcep_06_0203__b153021948163617">server_port</strong> and <strong id="vpcep_06_0203__b5218112103716">protocol</strong> of each of these endpoint services must be unique. A maximum of 200 port mappings can be created at a time.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row64921532133312"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0203__p19878153315338">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0203__p3878133363311">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0203__p15878103314332">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0203__p23501288">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_0203__ul1176004911819"><li id="vpcep_06_0203__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_0203__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_0203__vpcep_06_0201_i24390920309">Elastic Load Balancing API Reference</em>.</li><li id="vpcep_06_0203__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_0203__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_0203__vpcep_06_0201_i8649112044">Elastic Cloud Server API Reference</em>.</li><li id="vpcep_06_0203__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_0203__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>
</td>
</tr>
<tr id="vpcep_06_0203__row1783628195918"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0203__p36920461592">tcp_proxy</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0203__p569164612598">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0203__p11201552105918">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0203__p126913461598">Specifies whether the client IP address and port number or <strong id="vpcep_06_0203__vpcep_06_0201_b1340623194912">marker_id</strong> information is transmitted to the server. The following methods are supported:</p>
<ul id="vpcep_06_0203__ul15201145215599"><li id="vpcep_06_0203__vpcep_06_0201_li148419812461">TCP TOA: The client information is inserted into field <strong id="vpcep_06_0203__vpcep_06_0201_b1328024583915">tcp option</strong> and transmitted to the server.<div class="note" id="vpcep_06_0203__vpcep_06_0201_note11542930143913"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0203__vpcep_06_0201_p654318304392">TCP TOA is supported only when the backend resource is OBS.</p>
</div></div>
</li><li id="vpcep_06_0203__vpcep_06_0201_li98558124617">Proxy Protocol: The client information is inserted into field <strong id="vpcep_06_0203__vpcep_06_0201_b18340846124016">tcp payload</strong> and transmitted to the server.</li></ul>
<p id="vpcep_06_0203__p166904612597">This parameter is available only when the server can parse fields <strong id="vpcep_06_0203__vpcep_06_0201_b1246063817713">tcp option</strong> and <strong id="vpcep_06_0203__vpcep_06_0201_b832154415710">tcp payload</strong>.</p>
<p id="vpcep_06_0203__p186984612595">The values are as follows:</p>
<ul id="vpcep_06_0203__ul1220117529593"><li id="vpcep_06_0203__vpcep_06_0201_li46184012471"><strong id="vpcep_06_0203__vpcep_06_0201_b485111422">close</strong>: The TOA and Proxy Protocol methods are neither used.</li><li id="vpcep_06_0203__vpcep_06_0201_li36440104712"><strong id="vpcep_06_0203__vpcep_06_0201_b1432825911248">toa_open</strong>: The TOA method is used.</li><li id="vpcep_06_0203__vpcep_06_0201_li186204016473"><strong id="vpcep_06_0203__vpcep_06_0201_b1394119162519">proxy_open</strong>: The Proxy Protocol method is used.</li><li id="vpcep_06_0203__vpcep_06_0201_li2069403470"><strong id="vpcep_06_0203__vpcep_06_0201_b123462452517">open</strong>: The TOA and Proxy Protocol methods are both used.</li><li id="vpcep_06_0203__vpcep_06_0201_li47972058516"><strong id="vpcep_06_0203__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_0203__p87064610592">The default value is <strong id="vpcep_06_0203__vpcep_06_0201_b842352706144841">close</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row1487253624115"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0203__p1853163320202">description</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0203__p15531163322013">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0203__p19531153319202">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0203__p953193312205">Supplementary information about the VPC endpoint service. The description can contain a maximum of 128 characters and cannot contain left angle brackets (&lt;) or right angle brackets (&gt;).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpcep_06_0203__table1186184673416"></a><a name="table1186184673416"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0203__table1186184673416" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Port parameters</caption><thead align="left"><tr id="vpcep_06_0203__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_0203__vpcep_06_0201_p17540449"><strong id="vpcep_06_0203__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_0203__vpcep_06_0201_p37204434348"><strong id="vpcep_06_0203__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_0203__vpcep_06_0201_p11490287"><strong id="vpcep_06_0203__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_0203__vpcep_06_0201_p58298029"><strong id="vpcep_06_0203__vpcep_06_0201_b1437247493">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0203__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_0203__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_0203__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_0203__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_0203__vpcep_06_0201_p3481129">Specifies the port for accessing the VPC endpoint.</p>
<p id="vpcep_06_0203__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_0203__vpcep_06_0201_b89637271421">1</strong> to <strong id="vpcep_06_0203__vpcep_06_0201_b62419321421">65535</strong></p>
</td>
</tr>
<tr id="vpcep_06_0203__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_0203__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_0203__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_0203__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_0203__vpcep_06_0201_p23652783">Specifies the port for accessing the VPC endpoint service.</p>
<p id="vpcep_06_0203__vpcep_06_0201_p1136918011496">This port is provided by the backend service to provide services. Supported range: <strong id="vpcep_06_0203__vpcep_06_0201_b99681543184114">1</strong> to <strong id="vpcep_06_0203__vpcep_06_0201_b19968643184115">65535</strong></p>
</td>
</tr>
<tr id="vpcep_06_0203__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_0203__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_0203__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_0203__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_0203__vpcep_06_0201_p12309165616541">Specifies the port mapping protocol. TCP is supported.</p>
<p id="vpcep_06_0203__vpcep_06_0201_p19429767">The default value is <strong id="vpcep_06_0203__vpcep_06_0201_b84235270614202">TCP</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="vpcep_06_0203__li199421322415">Example request<div class="p" id="vpcep_06_0203__p9103114863414"><a name="vpcep_06_0203__li199421322415"></a><a name="li199421322415"></a>This request is to modify the VPC endpoint service whose ID is <strong id="vpcep_06_0203__b168741229112710">4189d3c2-8882-4871-a3c2-d380272eed88</strong>.<pre class="codeblock" id="vpcep_06_0203__codeblock101681917205511">PUT https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88</pre>
</div>
<div class="p" id="vpcep_06_0203__p171691817135517"><pre class="screen" id="vpcep_06_0203__screen1816971785510">{
"approval_enabled":<em id="vpcep_06_0203__i916831705518">true</em>,
"service_name":"test",
"ports":[
{
"client_port":<em id="vpcep_06_0203__i1168181717556">8081</em>,
"server_port":<em id="vpcep_06_0203__i916812173558">22</em>,
"protocol":"<em id="vpcep_06_0203__i141695174552">TCP</em>"
},
{
"client_port":<em id="vpcep_06_0203__i416941711557">8082</em>,
"server_port":<em id="vpcep_06_0203__i0169131745516">23</em>,
"protocol":"<em id="vpcep_06_0203__i4734115512258">TCP</em>"
}
]
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="vpcep_06_0203__section6034613"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0203__ul9520639122312"><li class="msonormal" id="vpcep_06_0203__li19520153916230">Parameter description
<div class="tablenoborder"><a name="vpcep_06_0203__table66810458"></a><a name="table66810458"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0203__table66810458" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="vpcep_06_0203__row35166537"><th align="left" class="cellrowborder" valign="top" width="24.240000000000002%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpcep_06_0203__p29917273"><strong id="vpcep_06_0203__b1134566591">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.25%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpcep_06_0203__p7380066"><strong id="vpcep_06_0203__b621838292">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.51%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpcep_06_0203__p60914443"><strong id="vpcep_06_0203__b498305288">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0203__row35122812"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p26375518">id</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p56042200">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p18497559">Specifies the unique ID of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row52575024"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p30718575">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p5176642">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p107701059124610">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_0203__ul16432132118180"><li id="vpcep_06_0203__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_0203__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_0203__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_0203__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_0203__row148431405813"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p769241384515">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p146925132458">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p05087421426">Specifies the ID of the cluster associated with the target VPCEP resource.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row14179224135"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p43735040">service_name</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p52877372">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p55208773">Specifies the name of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row27759212"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p33903709">server_type</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p61845910">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p1497382074811">Specifies the resource type.</p>
<ul id="vpcep_06_0203__ul1417663314354"><li id="vpcep_06_0203__vpcep_06_0201_li28085611301"><strong id="vpcep_06_0203__vpcep_06_0201_b176367610345">LB</strong>: indicates a load balancer.</li><li id="vpcep_06_0203__vpcep_06_0201_li180115615307"><strong id="vpcep_06_0203__vpcep_06_0201_b111511354539">VM</strong>: indicates an ECS.</li><li id="vpcep_06_0203__vpcep_06_0201_li14801856163015"><strong id="vpcep_06_0203__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_0203__vpcep_06_0201_li142786502511"><strong id="vpcep_06_0203__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_0203__row178231600145"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p6282859">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p39149581">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__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_0203__row9032989"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p60583479">approval_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p8314749">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p126331454145319">Specifies whether connection approval is required.</p>
<ul id="vpcep_06_0203__ul175221837143510"><li id="vpcep_06_0203__vpcep_06_0201_li19756255162316"><strong id="vpcep_06_0203__vpcep_06_0201_b524476057">false</strong>: Connection approval is not required. The created VPC endpoint is in the <strong id="vpcep_06_0203__vpcep_06_0201_b1443244828">accepted</strong> state.</li><li id="vpcep_06_0203__vpcep_06_0201_li175611550235"><strong id="vpcep_06_0203__vpcep_06_0201_b4102993">true</strong>: Connection approval is required. The created VPC endpoint is in the <strong id="vpcep_06_0203__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_0203__row15872492"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p10603509">status</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p53577906">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p44843148">Specifies the status of the VPC endpoint service.</p>
<ul id="vpcep_06_0203__ul353414464460"><li id="vpcep_06_0203__li260495719462"><strong id="vpcep_06_0203__b62481258143510">creating</strong>: The VPC endpoint service is being created.</li><li id="vpcep_06_0203__li17737841145111"><strong id="vpcep_06_0203__b734919115365">available</strong>: The VPC endpoint service is connectable.</li><li id="vpcep_06_0203__li1473717412517"><strong id="vpcep_06_0203__b1574683103611">failed</strong>: The VPC endpoint service failed to be created.</li></ul>
</td>
</tr>
<tr id="vpcep_06_0203__row36653303"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p16127536">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p31262001">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p135911520141219">Specifies the type of the VPC endpoint service.</p>
<div class="p" id="vpcep_06_0203__p3359114552814">There are two types of VPC endpoint services: interface and gateway.<ul id="vpcep_06_0203__vpcep_06_0201_ul87241928184613"><li id="vpcep_06_0203__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_0203__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_0203__p941115410718">You can perform the operations in <a href="vpcep_06_0303.html">Creating a VPC Endpoint</a> to create VPC endpoints for accessing VPC endpoints of the gateway and interface types.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row40094141"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p26400027">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p58027453">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p22890001">Specifies the creation time of the VPC endpoint service.</p>
<p id="vpcep_06_0203__p871616113394">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row23429487"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p18740332">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p41571913">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p27321481">Specifies the update time of the VPC endpoint service.</p>
<p id="vpcep_06_0203__p181016810016">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row39827108"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p4770281">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p50848458">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p25084465">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_0203__row24433593"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p32964001">ports</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p52838401">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p18151624114718">Lists the port mappings opened to the VPC endpoint service. For details, see <a href="#vpcep_06_0203__table20064649">Table 5</a>.</p>
<p id="vpcep_06_0203__p4537192002">Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same <strong id="vpcep_06_0203__vpcep_06_0201_b159801931141111">port_id</strong> value, either <strong id="vpcep_06_0203__vpcep_06_0201_b191031699416">server_port</strong> or <strong id="vpcep_06_0203__vpcep_06_0201_b1740621450">protocol</strong>, or both <strong id="vpcep_06_0203__vpcep_06_0201_b156291281054">server_port</strong> and <strong id="vpcep_06_0203__vpcep_06_0201_b762912815512">protocol</strong> of each of these endpoint services must be unique.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row1391314467277"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p7185174718259">tcp_proxy</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p218516477257">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p3988426182213">Specifies whether the client IP address and port number or <strong id="vpcep_06_0203__vpcep_06_0201_b1340623194912_1">marker_id</strong> information is transmitted to the server. The following methods are supported:</p>
<ul id="vpcep_06_0203__ul113422343220"><li id="vpcep_06_0203__vpcep_06_0201_li148419812461_1">TCP TOA: The client information is inserted into field <strong id="vpcep_06_0203__vpcep_06_0201_b1328024583915_1">tcp option</strong> and transmitted to the server.<div class="note" id="vpcep_06_0203__vpcep_06_0201_note11542930143913_1"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0203__vpcep_06_0201_p654318304392_1">TCP TOA is supported only when the backend resource is OBS.</p>
</div></div>
</li><li id="vpcep_06_0203__vpcep_06_0201_li98558124617_1">Proxy Protocol: The client information is inserted into field <strong id="vpcep_06_0203__vpcep_06_0201_b18340846124016_1">tcp payload</strong> and transmitted to the server.</li></ul>
<p id="vpcep_06_0203__p117219186296">This parameter is available only when the server can parse fields <strong id="vpcep_06_0203__vpcep_06_0201_b1246063817713_1">tcp option</strong> and <strong id="vpcep_06_0203__vpcep_06_0201_b832154415710_1">tcp payload</strong>.</p>
<p id="vpcep_06_0203__p29385542114">The values are as follows:</p>
<ul id="vpcep_06_0203__ul523712223"><li id="vpcep_06_0203__vpcep_06_0201_li46184012471_1"><strong id="vpcep_06_0203__vpcep_06_0201_b485111422_1">close</strong>: The TOA and Proxy Protocol methods are neither used.</li><li id="vpcep_06_0203__vpcep_06_0201_li36440104712_1"><strong id="vpcep_06_0203__vpcep_06_0201_b1432825911248_1">toa_open</strong>: The TOA method is used.</li><li id="vpcep_06_0203__vpcep_06_0201_li186204016473_1"><strong id="vpcep_06_0203__vpcep_06_0201_b1394119162519_1">proxy_open</strong>: The Proxy Protocol method is used.</li><li id="vpcep_06_0203__vpcep_06_0201_li2069403470_1"><strong id="vpcep_06_0203__vpcep_06_0201_b123462452517_1">open</strong>: The TOA and Proxy Protocol methods are both used.</li><li id="vpcep_06_0203__vpcep_06_0201_li47972058516_1"><strong id="vpcep_06_0203__vpcep_06_0201_b15716122802114_1">proxy_vni</strong>: The TOA Protocol method is not used. Proxy and virtual network ID are used.</li></ul>
<p id="vpcep_06_0203__p1725615331720">The default value is <strong id="vpcep_06_0203__vpcep_06_0201_b842352706144841_1">close</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row12807657141616"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p13103244015">tags</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p21037441512">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p1510414411116">Lists the resource tags. For details, see <a href="#vpcep_06_0203__table489217571060">Table 6</a>.</p>
</td>
</tr>
<tr id="vpcep_06_0203__row8356225115"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p48371026219">description</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0203__p2837152616113">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0203__p158371826219">Supplementary information about the VPC endpoint service.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="msonormal" id="vpcep_06_0203__p44030317">
<div class="tablenoborder"><a name="vpcep_06_0203__table20064649"></a><a name="table20064649"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0203__table20064649" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Port parameters</caption><thead align="left"><tr id="vpcep_06_0203__vpcep_06_0201_vpcep_06_0201_row54069340"><th align="left" class="cellrowborder" valign="top" width="17.98%" id="mcps1.3.4.2.1.2.1.2.4.1.1"><p id="vpcep_06_0203__vpcep_06_0201_vpcep_06_0201_p17540449"><strong id="vpcep_06_0203__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.1.2.4.1.2"><p id="vpcep_06_0203__vpcep_06_0201_vpcep_06_0201_p11490287"><strong id="vpcep_06_0203__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.1.2.4.1.3"><p id="vpcep_06_0203__vpcep_06_0201_vpcep_06_0201_p58298029"><strong id="vpcep_06_0203__vpcep_06_0201_b35007480">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0203__vpcep_06_0201_vpcep_06_0201_row24519875"><td class="cellrowborder" valign="top" width="17.98%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0203__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.1.2.4.1.2 "><p id="vpcep_06_0203__vpcep_06_0201_p88823381809">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.370000000000005%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0203__vpcep_06_0201_vpcep_06_0201_p3481129">Specifies the port for accessing the VPC endpoint.</p>
<p id="vpcep_06_0203__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_0203__vpcep_06_0201_b1165913712505">1</strong> to <strong id="vpcep_06_0203__vpcep_06_0201_b0659133735013">65535</strong></p>
</td>
</tr>
<tr id="vpcep_06_0203__vpcep_06_0201_vpcep_06_0201_row31330167"><td class="cellrowborder" valign="top" width="17.98%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0203__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.1.2.4.1.2 "><p id="vpcep_06_0203__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.1.2.4.1.3 "><p id="vpcep_06_0203__vpcep_06_0201_vpcep_06_0201_p23652783">Specifies the port for accessing the VPC endpoint service.</p>
<p id="vpcep_06_0203__vpcep_06_0201_vpcep_06_0201_p1136918011496">This port is provided by the backend service to provide services. Supported range: <strong id="vpcep_06_0203__vpcep_06_0201_b44414139517">1</strong> to <strong id="vpcep_06_0203__vpcep_06_0201_b145181335112">65535</strong></p>
</td>
</tr>
<tr id="vpcep_06_0203__vpcep_06_0201_vpcep_06_0201_row11548462"><td class="cellrowborder" valign="top" width="17.98%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0203__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.1.2.4.1.2 "><p id="vpcep_06_0203__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.1.2.4.1.3 "><p id="vpcep_06_0203__vpcep_06_0201_p1496207155510">Specifies the port mapping protocol. TCP is supported.</p>
<p id="vpcep_06_0203__vpcep_06_0201_p169621578551">The default value is <strong id="vpcep_06_0203__vpcep_06_0201_b6292721191">TCP</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="vpcep_06_0203__table489217571060"></a><a name="table489217571060"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0203__table489217571060" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Tags parameters</caption><thead align="left"><tr id="vpcep_06_0203__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_0203__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p21724664"><strong id="vpcep_06_0203__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_0203__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p63406242"><strong id="vpcep_06_0203__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_0203__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p35632012"><strong id="vpcep_06_0203__vpcep_06_0201_b163691023811">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0203__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_0203__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_0203__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_0203__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_0203__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_0203__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_0203__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_0203__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_0203__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_0203__ul31363207"><li id="vpcep_06_0203__li13833415">Example response<pre class="screen" id="vpcep_06_0203__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_0203__section19041619"><h4 class="sectiontitle">Status Codes</h4><p class="msonormal" id="vpcep_06_0203__p22802326">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