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

428 lines
41 KiB
HTML
Raw Blame History

<a name="vpcep_06_0205"></a><a name="vpcep_06_0205"></a>
<h1 class="topictitle1">Querying VPC Endpoint Services</h1>
<div id="body40481485"><div class="section" id="vpcep_06_0205__section11645525"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="vpcep_06_0205__p57774862">This API is used to query VPC endpoint services.</p>
</div>
<div class="section" id="vpcep_06_0205__section37700862"><h4 class="sectiontitle">URI</h4><p id="vpcep_06_0205__p23809231712">GET /v1/{project_id}/vpc-endpoint-services?endpoint_service_name={endpoint_service_name}&amp;id={id}&amp;sort_key={sort_key}&amp;sort_dir={sort_dir}&amp;limit={limit}&amp;offset={offset}&amp;status={status}</p>
<div class="msonormal" id="vpcep_06_0205__p624413203159"><a href="#vpcep_06_0205__table29895862">Table 1</a> describes the parameter in this URI.
<div class="tablenoborder"><a name="vpcep_06_0205__table29895862"></a><a name="table29895862"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0205__table29895862" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="vpcep_06_0205__row52794610"><th align="left" class="cellrowborder" valign="top" width="32.65%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpcep_06_0205__p48504985"><strong id="vpcep_06_0205__b739411332713">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_0205__p36589733"><strong id="vpcep_06_0205__b185121834272">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_0205__p10978430"><strong id="vpcep_06_0205__b2548193514715">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0205__row16837643"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0205__p21671861">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_0205__p10590307">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_0205__p52508542">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 class="tablenoborder"><a name="vpcep_06_0205__table5645742"></a><a name="table5645742"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0205__table5645742" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="vpcep_06_0205__row43414540"><th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.2.4.2.5.1.1"><p id="vpcep_06_0205__p26916874"><strong id="vpcep_06_0205__b1193410431676">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.2.4.2.5.1.2"><p id="vpcep_06_0205__p32783160"><strong id="vpcep_06_0205__b1661430614">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.2.4.2.5.1.3"><p id="vpcep_06_0205__p38190270"><strong id="vpcep_06_0205__b1192018202817">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.46464646464647%" id="mcps1.3.2.4.2.5.1.4"><p id="vpcep_06_0205__p6404165"><strong id="vpcep_06_0205__b210557031">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0205__row48975348"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0205__p7580276">endpoint_service_name</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0205__p10022637">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0205__p6527238">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0205__p58944231">Specifies the name of the VPC endpoint service. The name is not case-sensitive and supports fuzzy match.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row60736034"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0205__p20671747">id</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0205__p63798849">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0205__p324291">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0205__p26267634">Specifies the unique ID of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row35082117"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0205__p23079266">status</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0205__p57481247">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0205__p25469412">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0205__p49756506">Specifies the status of the VPC endpoint service.</p>
<ul id="vpcep_06_0205__ul6347132317483"><li id="vpcep_06_0205__li634762317480"><strong id="vpcep_06_0205__b148984611116">creating</strong>: The VPC endpoint service is being created.</li><li id="vpcep_06_0205__li53489231482"><strong id="vpcep_06_0205__b96779410228">available</strong>: The VPC endpoint service is connectable.</li><li id="vpcep_06_0205__li18348192384812"><strong id="vpcep_06_0205__b15850165162214">failed</strong>: The VPC endpoint service failed to be created.</li><li id="vpcep_06_0205__li1234813231482"><strong id="vpcep_06_0205__b19521811171116">deleting</strong>: The VPC endpoint service is being deleted.</li></ul>
</td>
</tr>
<tr id="vpcep_06_0205__row1922383593019"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0205__p1122353518302">sort_key</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0205__p2439305315">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0205__p1422315351303">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0205__p1517010112277">Specifies the sorting field of the VPC endpoint service list. The field can be:</p>
<ul id="vpcep_06_0205__ul248814136274"><li id="vpcep_06_0205__li348811372710"><strong id="vpcep_06_0205__b91061528181018">created_at</strong>: VPC endpoint services are sorted by creation time.</li><li id="vpcep_06_0205__li8488111318274"><strong id="vpcep_06_0205__b10717101561115">updated_at</strong>: VPC endpoint services are sorted by update time.</li></ul>
<p id="vpcep_06_0205__p31932603">The default field is <strong id="vpcep_06_0205__b84581912152219">created_at</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row36340727"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0205__p57917784">sort_dir</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0205__p60828929">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0205__p28196251">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0205__p116071347131216">Specifies the sorting method of the VPC endpoint service list. The method can be:</p>
<ul id="vpcep_06_0205__ul18204217325"><li id="vpcep_06_0205__li3203210322"><strong id="vpcep_06_0205__b842352706193046">desc</strong>: VPC endpoint services are sorted in descending order.</li><li id="vpcep_06_0205__li162062117325"><strong id="vpcep_06_0205__b84235270619316">asc</strong>: VPC endpoint services are sorted in ascending order.</li></ul>
<p id="vpcep_06_0205__p3562616138">The default method is <strong id="vpcep_06_0205__b84235270614202">desc</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row56667338"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0205__p26651648">limit</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0205__p11299916">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0205__p42877971">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0205__p50563647">Specifies the maximum number of VPC endpoint services displayed on each page.</p>
<p id="vpcep_06_0205__p52419647">The number ranges from <strong id="vpcep_06_0205__b417724545611">0</strong> to <strong id="vpcep_06_0205__b2177164512562">1000</strong> and is generally <strong id="vpcep_06_0205__b1417724535618">10</strong>, <strong id="vpcep_06_0205__b2178345105614">20</strong>, or <strong id="vpcep_06_0205__b11178194575611">50</strong>. The default number is <strong id="vpcep_06_0205__b111781045135614">10</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row2014776"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0205__p28979173">offset</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0205__p65611695">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0205__p12947069">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0205__p183133831912">Specifies the offset.</p>
<p id="vpcep_06_0205__p11316385191">All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpcep_06_0205__section3763446"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0205__ul1385957173519"><li class="msonormal" id="vpcep_06_0205__li1385457113510"><a name="vpcep_06_0205__li1385457113510"></a><a name="li1385457113510"></a>Parameter description<p id="vpcep_06_0205__p4945102416125"><a name="vpcep_06_0205__li1385457113510"></a><a name="li1385457113510"></a>None</p>
</li><li id="vpcep_06_0205__li33861429320">Example request<pre class="codeblock" id="vpcep_06_0205__codeblock4611452615">GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services</pre>
</li></ul>
</div>
<div class="section" id="vpcep_06_0205__section36403741"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0205__ul135146113816"><li class="msonormal" id="vpcep_06_0205__li20358611383">Parameter description
<div class="tablenoborder"><a name="vpcep_06_0205__table50811679"></a><a name="table50811679"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0205__table50811679" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="vpcep_06_0205__row1443251"><th align="left" class="cellrowborder" valign="top" width="24.242424242424242%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpcep_06_0205__p49794519"><strong id="vpcep_06_0205__b585393067">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="29.292929292929294%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpcep_06_0205__p6824202"><strong id="vpcep_06_0205__b431713845">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.464646464646464%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpcep_06_0205__p15889527"><strong id="vpcep_06_0205__b384249964">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0205__row11983300"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0205__p31123225">endpoint_services</p>
</td>
<td class="cellrowborder" valign="top" width="29.292929292929294%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0205__p37953311">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="46.464646464646464%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0205__p54319357">Lists the VPC endpoint services. For details, see <a href="#vpcep_06_0205__table11315049">Table 4</a>.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row19112173"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0205__p4582212">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="29.292929292929294%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0205__p35614854">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.464646464646464%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0205__p18744171320381">Specifies the total number of VPC endpoint services that meet the search criteria. The number is not affected by the limit or offset.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpcep_06_0205__table11315049"></a><a name="table11315049"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0205__table11315049" frame="border" border="1" rules="all"><caption><b>Table 4 </b>endpoint_service parameters</caption><thead align="left"><tr id="vpcep_06_0205__row58655549"><th align="left" class="cellrowborder" valign="top" width="19.59%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpcep_06_0205__p53478999">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.59%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpcep_06_0205__p36831645">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.81999999999999%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpcep_06_0205__p30573305">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0205__row60518608"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p3060236">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p46552597">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p18497559">Specifies the unique ID of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row46867304"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p38155279">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p3569886">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__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_0205__ul16432132118180"><li id="vpcep_06_0205__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_0205__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_0205__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_0205__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_0205__row24563651"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p43498701">service_name</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p33733912">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p48092364">Specifies the name of the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row18205265"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p65340323">server_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p58074826">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p1497382074811">Specifies the resource type.</p>
<ul id="vpcep_06_0205__ul1417663314354"><li id="vpcep_06_0205__vpcep_06_0201_li28085611301"><strong id="vpcep_06_0205__vpcep_06_0201_b176367610345">LB</strong>: indicates a load balancer.</li><li id="vpcep_06_0205__vpcep_06_0201_li180115615307"><strong id="vpcep_06_0205__vpcep_06_0201_b111511354539">VM</strong>: indicates an ECS.</li><li id="vpcep_06_0205__vpcep_06_0201_li14801856163015"><strong id="vpcep_06_0205__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_0205__vpcep_06_0201_li142786502511"><strong id="vpcep_06_0205__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_0205__row202495420397"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p6282859">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p39149581">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__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_0205__row64608875"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p65936421">approval_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p39249912">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p11315182920485">Specifies whether connection approval is required.</p>
<ul id="vpcep_06_0205__ul175221837143510"><li id="vpcep_06_0205__vpcep_06_0201_li19756255162316"><strong id="vpcep_06_0205__vpcep_06_0201_b524476057">false</strong>: Connection approval is not required. The created VPC endpoint is in the <strong id="vpcep_06_0205__vpcep_06_0201_b1443244828">accepted</strong> state.</li><li id="vpcep_06_0205__vpcep_06_0201_li175611550235"><strong id="vpcep_06_0205__vpcep_06_0201_b4102993">true</strong>: Connection approval is required. The created VPC endpoint is in the <strong id="vpcep_06_0205__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_0205__row34173714"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p16607446">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p3025915">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p13535121115119">Specifies the status of the VPC endpoint service.</p>
<ul id="vpcep_06_0205__ul16737041185119"><li id="vpcep_06_0205__li13737541195120"><strong id="vpcep_06_0205__b1024439143">creating</strong>: The VPC endpoint service is being created.</li><li id="vpcep_06_0205__li17737841145111"><strong id="vpcep_06_0205__b17785192602216">available</strong>: The VPC endpoint service is connectable.</li><li id="vpcep_06_0205__li1473717412517"><strong id="vpcep_06_0205__b10839928162214">failed</strong>: The VPC endpoint service failed to be created.</li><li id="vpcep_06_0205__li9737164135112"><strong id="vpcep_06_0205__b1414102144">deleting</strong>: The VPC endpoint service is being deleted.</li></ul>
</td>
</tr>
<tr id="vpcep_06_0205__row39472279"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p43138034">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p4519841">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p135911520141219">Specifies the type of the VPC endpoint service.</p>
<div class="p" id="vpcep_06_0205__p3359114552814">There are two types of VPC endpoint services: interface and gateway.<ul id="vpcep_06_0205__vpcep_06_0201_ul87241928184613"><li id="vpcep_06_0205__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_0205__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_0205__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_0205__row6630005"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p159494">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p12919048">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p22890001">Specifies the creation time of the VPC endpoint service.</p>
<p id="vpcep_06_0205__p871616113394">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row22745272"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p30427754">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p48729033">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p27321481">Specifies the update time of the VPC endpoint service.</p>
<p id="vpcep_06_0205__p181016810016">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row22876321"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p41042702">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p36124547">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p40407209">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_0205__row11968104313302"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p1068485517236">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p13684135572312">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p868514553238">Specifies the user's domain ID.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row28120566"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p63173351">ports</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p16767838">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p5656200651">Lists the port mappings opened to the VPC endpoint service. For details, see <a href="#vpcep_06_0205__table31283788">Table 5</a>.</p>
<p id="vpcep_06_0205__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_0205__vpcep_06_0201_b159801931141111">port_id</strong> value, either <strong id="vpcep_06_0205__vpcep_06_0201_b191031699416">server_port</strong> or <strong id="vpcep_06_0205__vpcep_06_0201_b1740621450">protocol</strong>, or both <strong id="vpcep_06_0205__vpcep_06_0201_b156291281054">server_port</strong> and <strong id="vpcep_06_0205__vpcep_06_0201_b762912815512">protocol</strong> of each of these endpoint services must be unique.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row58021781920"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p13103244015">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p21037441512">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p1510414411116">Lists the resource tags. For details, see <a href="#vpcep_06_0205__table489217571060">Table 6</a>.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row5508840184111"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p185091040184118">connection_count</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p35097402411">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p1650984011411">Specifies the number of <strong id="vpcep_06_0205__b863117258508">Creating</strong> or <strong id="vpcep_06_0205__b4632122525016">Accepted</strong> VPC endpoints under the VPC endpoint service.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row1794114562189"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p6679144311349">tcp_proxy</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p1867920439347">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p3988426182213">Specifies whether the client IP address and port number or <strong id="vpcep_06_0205__vpcep_06_0201_b1340623194912">marker_id</strong> information is transmitted to the server. The following methods are supported:</p>
<ul id="vpcep_06_0205__ul113422343220"><li id="vpcep_06_0205__vpcep_06_0201_li148419812461">TCP TOA: The client information is inserted into field <strong id="vpcep_06_0205__vpcep_06_0201_b1328024583915">tcp option</strong> and transmitted to the server.<div class="note" id="vpcep_06_0205__vpcep_06_0201_note11542930143913"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0205__vpcep_06_0201_p654318304392">TCP TOA is supported only when the backend resource is OBS.</p>
</div></div>
</li><li id="vpcep_06_0205__vpcep_06_0201_li98558124617">Proxy Protocol: The client information is inserted into field <strong id="vpcep_06_0205__vpcep_06_0201_b18340846124016">tcp payload</strong> and transmitted to the server.</li></ul>
<p id="vpcep_06_0205__p117219186296">This parameter is available only when the server can parse fields <strong id="vpcep_06_0205__vpcep_06_0201_b1246063817713">tcp option</strong> and <strong id="vpcep_06_0205__vpcep_06_0201_b832154415710">tcp payload</strong>.</p>
<p id="vpcep_06_0205__p29385542114">The values are as follows:</p>
<ul id="vpcep_06_0205__ul523712223"><li id="vpcep_06_0205__vpcep_06_0201_li46184012471"><strong id="vpcep_06_0205__vpcep_06_0201_b485111422">close</strong>: The TOA and Proxy Protocol methods are neither used.</li><li id="vpcep_06_0205__vpcep_06_0201_li36440104712"><strong id="vpcep_06_0205__vpcep_06_0201_b1432825911248">toa_open</strong>: The TOA method is used.</li><li id="vpcep_06_0205__vpcep_06_0201_li186204016473"><strong id="vpcep_06_0205__vpcep_06_0201_b1394119162519">proxy_open</strong>: The Proxy Protocol method is used.</li><li id="vpcep_06_0205__vpcep_06_0201_li2069403470"><strong id="vpcep_06_0205__vpcep_06_0201_b123462452517">open</strong>: The TOA and Proxy Protocol methods are both used.</li><li id="vpcep_06_0205__vpcep_06_0201_li47972058516"><strong id="vpcep_06_0205__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_0205__p1725615331720">The default value is <strong id="vpcep_06_0205__vpcep_06_0201_b842352706144841">close</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row11979515"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p134782274443">error</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p20478112713443">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p12568428134419">Specifies the error message.</p>
<p id="vpcep_06_0205__p2478152724413">This field is returned when the status of the VPC endpoint service changes to <strong id="vpcep_06_0205__b1015018215149">failed</strong>. For details, see <a href="#vpcep_06_0205__table178701348456">Table 7</a>.</p>
</td>
</tr>
<tr id="vpcep_06_0205__row93415167217"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0205__p9820124524">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0205__p1282018241124">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.81999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0205__p13820124525">Specifies the ID of the cluster the VPC endpoint belongs to.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="p" id="vpcep_06_0205__p1821491693910">
<div class="tablenoborder"><a name="vpcep_06_0205__table31283788"></a><a name="table31283788"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0205__table31283788" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Port parameters</caption><thead align="left"><tr id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_row54069340"><th align="left" class="cellrowborder" valign="top" width="17.98%" id="mcps1.3.4.2.1.3.1.2.4.1.1"><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_p17540449"><strong id="vpcep_06_0205__vpcep_06_0201_b8302057171210">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.650000000000002%" id="mcps1.3.4.2.1.3.1.2.4.1.2"><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_p11490287"><strong id="vpcep_06_0205__vpcep_06_0201_b1355134319224">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.370000000000005%" id="mcps1.3.4.2.1.3.1.2.4.1.3"><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_p58298029"><strong id="vpcep_06_0205__vpcep_06_0201_b35007480">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_row24519875"><td class="cellrowborder" valign="top" width="17.98%" headers="mcps1.3.4.2.1.3.1.2.4.1.1 "><p id="vpcep_06_0205__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.3.1.2.4.1.2 "><p id="vpcep_06_0205__vpcep_06_0201_p88823381809">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.370000000000005%" headers="mcps1.3.4.2.1.3.1.2.4.1.3 "><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_p3481129">Specifies the port for accessing the VPC endpoint.</p>
<p id="vpcep_06_0205__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_0205__vpcep_06_0201_b1165913712505">1</strong> to <strong id="vpcep_06_0205__vpcep_06_0201_b0659133735013">65535</strong></p>
</td>
</tr>
<tr id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_row31330167"><td class="cellrowborder" valign="top" width="17.98%" headers="mcps1.3.4.2.1.3.1.2.4.1.1 "><p id="vpcep_06_0205__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.3.1.2.4.1.2 "><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_p2777523">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.370000000000005%" headers="mcps1.3.4.2.1.3.1.2.4.1.3 "><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_p23652783">Specifies the port for accessing the VPC endpoint service.</p>
<p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_p1136918011496">This port is provided by the backend service to provide services. Supported range: <strong id="vpcep_06_0205__vpcep_06_0201_b44414139517">1</strong> to <strong id="vpcep_06_0205__vpcep_06_0201_b145181335112">65535</strong></p>
</td>
</tr>
<tr id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_row11548462"><td class="cellrowborder" valign="top" width="17.98%" headers="mcps1.3.4.2.1.3.1.2.4.1.1 "><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_p63010216">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="19.650000000000002%" headers="mcps1.3.4.2.1.3.1.2.4.1.2 "><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_p3553891">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.370000000000005%" headers="mcps1.3.4.2.1.3.1.2.4.1.3 "><p id="vpcep_06_0205__vpcep_06_0201_p1496207155510">Specifies the port mapping protocol. TCP is supported.</p>
<p id="vpcep_06_0205__vpcep_06_0201_p169621578551">The default value is <strong id="vpcep_06_0205__vpcep_06_0201_b6292721191">TCP</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="vpcep_06_0205__table489217571060"></a><a name="table489217571060"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0205__table489217571060" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Tags parameters</caption><thead align="left"><tr id="vpcep_06_0205__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.4.2.4.1.1"><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p21724664"><strong id="vpcep_06_0205__vpcep_06_0201_b1866348132314">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p63406242"><strong id="vpcep_06_0205__vpcep_06_0201_b616714104231">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.91%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p35632012"><strong id="vpcep_06_0205__vpcep_06_0201_b163691023811">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0205__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.4.2.4.1.1 "><p id="vpcep_06_0205__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.4.2.4.1.2 "><p id="vpcep_06_0205__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.4.2.4.1.3 "><p id="vpcep_06_0205__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_0205__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_0205__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.4.2.4.1.1 "><p id="vpcep_06_0205__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.4.2.4.1.2 "><p id="vpcep_06_0205__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.4.2.4.1.3 "><p id="vpcep_06_0205__vpcep_06_0201_vpcep_06_0201_p61714725112922">Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpcep_06_0205__table178701348456"></a><a name="table178701348456"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0205__table178701348456" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Error parameters</caption><thead align="left"><tr id="vpcep_06_0205__vpcep_06_0202_row4652255153018"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="vpcep_06_0205__vpcep_06_0202_p665015573309"><strong id="vpcep_06_0205__vpcep_06_0202_b085424117110">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.630000000000003%" id="mcps1.3.4.2.1.5.2.4.1.2"><p id="vpcep_06_0205__vpcep_06_0202_p865015710307"><strong id="vpcep_06_0205__vpcep_06_0202_b2057561169">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.029999999999994%" id="mcps1.3.4.2.1.5.2.4.1.3"><p id="vpcep_06_0205__vpcep_06_0202_p1565011575303"><strong id="vpcep_06_0205__vpcep_06_0202_b1010514442017">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0205__vpcep_06_0202_row865255513010"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="vpcep_06_0205__vpcep_06_0202_p96501057153013">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20.630000000000003%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="vpcep_06_0205__vpcep_06_0202_p6650155710309">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.029999999999994%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="vpcep_06_0205__vpcep_06_0202_p12650557133019">Specifies the error code.</p>
</td>
</tr>
<tr id="vpcep_06_0205__vpcep_06_0202_row186521755153018"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="vpcep_06_0205__vpcep_06_0202_p10650057123018">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="20.630000000000003%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="vpcep_06_0205__vpcep_06_0202_p14650157113016">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.029999999999994%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="vpcep_06_0205__vpcep_06_0202_p156501957183013">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="vpcep_06_0205__ul29535755"><li id="vpcep_06_0205__li64495211"><a name="vpcep_06_0205__li64495211"></a><a name="li64495211"></a>Example response<pre class="screen" id="vpcep_06_0205__screen441961062711">{
"endpoint_services":[
{
"id":"4189d3c2-8882-4871-a3c2-d380272eed83",
"port_id":"4189d3c2-8882-4871-a3c2-d380272eed88",
"vpc_id":"4189d3c2-8882-4871-a3c2-d380272eed80",
"status":"available",
"approval_enabled":false,
"service_name":"test123",
"server_type":"VM",
"service_type":"interface",
"ports":[
{
"client_port":8080,
"server_port":90,
"protocol":"TCP"
},
{
"client_port":8081,
"server_port":80,
"protocol":"TCP"
}
],
"project_id":"6e9dfd51d1124e8d8498dce894923a0d",
"domain_id" : "5fc973eea581490997e82ea11a1df31f",
"created_at":"2018-01-30T07:42:01Z",
"updated_at":"2018-01-30T07:42:01Z"
}
],
"total_count":1
}</pre>
</li></ul>
</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