forked from laiweijian4/doc-exports
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
412 lines
40 KiB
HTML
412 lines
40 KiB
HTML
<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"><strong id="vpcep_06_0203__b10351135720144">Function</strong></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 the required parameters.
|
|
<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>Parameter description</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_0.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"><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__b334494303">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__b182578907">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>: indicates that 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>: indicates that 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, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same. 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 the form of the UUID. 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 an enhanced 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_b760615179297">vip_port_id</strong> in <a href="https://docs.otc.t-systems.com/en-us/api/elb/en-us_topic_0141008271.html" target="_blank" rel="noopener noreferrer">Querying Details of a Load Balancer</a> in the <em id="vpcep_06_0203__vpcep_06_0201_i454205722813">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 <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 Load Balancing 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 NIC ID of the physical server where virtual resources are created. </li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0203__row1656963160"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0203__p43501320364">vip_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__p2350192013610">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__p143502204610">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__p835016203617">Specifies the ID of the virtual NIC to which the virtual IP address is bound.</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 mapping 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_b1373505296">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_b1940591593">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_p19429767">Specifies the protocol used in port mappings. The protocol can be <strong id="vpcep_06_0203__vpcep_06_0201_b721417262133">TCP</strong> or <strong id="vpcep_06_0203__vpcep_06_0201_b12723196193111">UDP</strong>. The default protocol is <strong id="vpcep_06_0203__vpcep_06_0201_b147231765315">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"><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__b1227667470">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__b600771102">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__b1736106709">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 the form of the UUID. 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 an enhanced 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 NIC ID of the physical server where virtual resources are created. </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__row1428310195461"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p12948182619398">vip_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__p4948326133915">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__p2948122613917">Specifies the ID of the virtual NIC to which the virtual IP address is bound.</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_li180115615307"><strong id="vpcep_06_0203__vpcep_06_0201_b111511354539">VM</strong>: indicates the ECS.</li><li id="vpcep_06_0203__vpcep_06_0201_li14801856163015"><strong id="vpcep_06_0203__vpcep_06_0201_b111348551533">VIP</strong>: indicates the virtual IP address. </li><li id="vpcep_06_0203__vpcep_06_0201_li28085611301"><strong id="vpcep_06_0203__vpcep_06_0201_b1842415561432">LB</strong>: indicates the enhanced load balancer.</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_b1230282120">false</strong>: indicates that connection approval is not required. The created VPC endpoint is in the <strong id="vpcep_06_0203__vpcep_06_0201_b2131257654">Accepted</strong> state.</li><li id="vpcep_06_0203__vpcep_06_0201_li175611550235"><strong id="vpcep_06_0203__vpcep_06_0201_b1413940842">true</strong>: indicates that connection approval is required. The created VPC endpoint is in the <strong id="vpcep_06_0203__vpcep_06_0201_b1887352187">Pending acceptance</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>
|
|
<p id="vpcep_06_0203__p2073619194316"><strong id="vpcep_06_0203__b21426442018">available</strong>: indicates the VPC endpoint service is connectable.</p>
|
|
</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_0.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0203__row671754016266"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0203__p20857123514817">cidr_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__p1185733574815">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__p12391036114918">Specifies the network segment type. The type can be <strong id="vpcep_06_0203__b2058211546521">public</strong> or <strong id="vpcep_06_0203__b15834545522">internal</strong>.</p>
|
|
<ul id="vpcep_06_0203__ul159453471498"><li id="vpcep_06_0203__li294513475497"><strong id="vpcep_06_0203__b12976154418541">public</strong>: indicates the public subnet CIDR block.</li><li id="vpcep_06_0203__li1994624724913"><strong id="vpcep_06_0203__b49313257011">internal</strong>: indicates the private subnet CIDR block.</li></ul>
|
|
<p id="vpcep_06_0203__p1183713122495">The default value is <strong id="vpcep_06_0203__b789259195017">internal</strong>.</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, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same.</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">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">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__p117219186296">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__p29385542114">The values are as follows:</p>
|
|
<ul id="vpcep_06_0203__ul523712223"><li id="vpcep_06_0203__vpcep_06_0201_li46184012471"><strong id="vpcep_06_0203__vpcep_06_0201_b485111422">close</strong>: indicates that 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>: indicates that 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>: indicates that 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>: indicates that the TOA and Proxy Protocol methods are both used.</li></ul>
|
|
<p id="vpcep_06_0203__p1725615331720">The default value is <strong id="vpcep_06_0203__vpcep_06_0201_b842352706144841">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>
|
|
</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 mapping 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_b1791992976">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_vpcep_06_0201_p19429767">Specifies the protocol used in port mappings. The protocol can be <strong id="vpcep_06_0203__vpcep_06_0201_b13162132545919">TCP</strong>or <strong id="vpcep_06_0203__vpcep_06_0201_b31704257599">UDP</strong>. The default protocol is <strong id="vpcep_06_0203__vpcep_06_0201_b117182585913">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><strong id="vpcep_06_0203__vpcep_06_0201_b5155161631">ResourceTags</strong> 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. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).</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 (-), and underscores (_).</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:01.174",
|
|
"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 Code</h4><p class="msonormal" id="vpcep_06_0203__p22802326">For details about status codes, see <a href="vpcep_08_0001.html">Status Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpcep_06_0200.html">APIs for Managing VPC Endpoint Services</a></div>
|
|
</div>
|
|
</div>
|
|
|