forked from docs/doc-exports
Qin Ying, Fan
ef5d2cd3cf
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>
483 lines
41 KiB
HTML
483 lines
41 KiB
HTML
<a name="vpcep_06_0306"></a><a name="vpcep_06_0306"></a>
|
|
|
|
<h1 class="topictitle1">Querying VPC Endpoints</h1>
|
|
<div id="body43106259"><div class="section" id="vpcep_06_0306__section51695639"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="vpcep_06_0306__p1946052">This API is used to query VPC endpoints.</p>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0306__section62607570"><a name="vpcep_06_0306__section62607570"></a><a name="section62607570"></a><h4 class="sectiontitle">URI</h4><p id="vpcep_06_0306__p9680122101117">GET /v1/{project_id}/vpc-endpoints?endpoint_service_name={endpoint_service_name}&vpc_id={vpc_id}&limit={limit}&offset={offset}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}</p>
|
|
<div class="msonormal" id="vpcep_06_0306__p624413203159"><a href="#vpcep_06_0306__table35342882">Table 1</a> describes the parameter in this URI.
|
|
<div class="tablenoborder"><a name="vpcep_06_0306__table35342882"></a><a name="table35342882"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0306__table35342882" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="vpcep_06_0306__row34818463"><th align="left" class="cellrowborder" valign="top" width="32.65%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpcep_06_0306__p1723244"><strong id="vpcep_06_0306__b0386425811">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_0306__p5365057"><strong id="vpcep_06_0306__b167394261113">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_0306__p31916487"><strong id="vpcep_06_0306__b56611427211">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0306__row35098661"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0306__p24419332">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_0306__p31808908">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_0306__p26384740">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_0306__table44201211"></a><a name="table44201211"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0306__table44201211" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="vpcep_06_0306__row21673883"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.2.4.2.5.1.1"><p id="vpcep_06_0306__p10754092"><strong id="vpcep_06_0306__b16326154916319">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="vpcep_06_0306__p65775089"><strong id="vpcep_06_0306__b1022632792">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.4.2.5.1.3"><p id="vpcep_06_0306__p26181970"><strong id="vpcep_06_0306__b552515521333">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.2.4.2.5.1.4"><p id="vpcep_06_0306__p40364857"><strong id="vpcep_06_0306__b1101051383">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0306__row48327947"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0306__p22249650">endpoint_service_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0306__p57391254">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0306__p18179998">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0306__p63293747">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_0306__row32772813"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0306__p37352224">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0306__p5631283">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0306__p53480750">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0306__p53427648">Specifies the ID of the VPC where the VPC endpoint is to be created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row1959717469498"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0306__p540954724913">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0306__p12410114719497">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0306__p2041024784917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0306__p241024744918">Specifies the unique ID of the VPC endpoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row46491877"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0306__p7745692">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0306__p23421307">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0306__p18077739">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0306__p55010772">Specifies the maximum number of VPC endpoints displayed on each page.</p>
|
|
<p id="vpcep_06_0306__p25334901">The number ranges from <strong id="vpcep_06_0306__b5516178181014">0</strong> to <strong id="vpcep_06_0306__b2325511151014">1000</strong> and is generally <strong id="vpcep_06_0306__b147120145814">10</strong>, <strong id="vpcep_06_0306__b1971310146815">20</strong>, or <strong id="vpcep_06_0306__b771461413810">50</strong>. The default number is <strong id="vpcep_06_0306__b197156146810">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row26687517"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0306__p14205230">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0306__p9772976">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0306__p53413578">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0306__p5736126132214">Specifies the offset.</p>
|
|
<p id="vpcep_06_0306__p11912494222">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>
|
|
<tr id="vpcep_06_0306__row45895083"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0306__p26514257">sort_key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0306__p171215">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0306__p13868494">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0306__p562418271823">Specifies the sorting field of the VPC endpoint list. The field can be:</p>
|
|
<ul id="vpcep_06_0306__ul512472071414"><li id="vpcep_06_0306__vpcep_06_0205_li348811372710"><strong id="vpcep_06_0306__b2551555143814">created_at</strong>: VPC endpoints are sorted by creation time.</li><li id="vpcep_06_0306__vpcep_06_0205_li8488111318274"><strong id="vpcep_06_0306__b15797171353914">updated_at</strong>: VPC endpoints are sorted by update time.</li></ul>
|
|
<p id="vpcep_06_0306__p36041148141413">The default field is <strong id="vpcep_06_0306__vpcep_06_0205_b84581912152219">created_at</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row43803176"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0306__p58396383">sort_dir</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0306__p32486611">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0306__p14169835">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0306__p2195022">Specifies the sorting method of the VPC endpoint list. The method can be:</p>
|
|
<ul id="vpcep_06_0306__ul9628101291617"><li id="vpcep_06_0306__vpcep_06_0205_li3203210322"><strong id="vpcep_06_0306__b383853604518">desc</strong>: VPC endpoints are sorted in descending order.</li><li id="vpcep_06_0306__vpcep_06_0205_li162062117325"><strong id="vpcep_06_0306__b1313815489454">asc</strong>: VPC endpoints are sorted in ascending order.</li></ul>
|
|
<p id="vpcep_06_0306__p1719319255168">The default method is <strong id="vpcep_06_0306__vpcep_06_0205_b84235270614202">desc</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0306__section26597221"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0306__ul833255917328"><li class="msonormal" id="vpcep_06_0306__li9332559143212"><a name="vpcep_06_0306__li9332559143212"></a><a name="li9332559143212"></a>Parameter description<p id="vpcep_06_0306__p1753366194"><a name="vpcep_06_0306__li9332559143212"></a><a name="li9332559143212"></a>None</p>
|
|
</li><li id="vpcep_06_0306__li323661733613">Example request<pre class="codeblock" id="vpcep_06_0306__codeblock1438017135011">GET https://{endpoint}/v1/{project_id}/vpc-endpoints</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0306__section6891296"><a name="vpcep_06_0306__section6891296"></a><a name="section6891296"></a><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0306__ul6297172519332"><li class="msonormal" id="vpcep_06_0306__li152978251336">Parameter description
|
|
<div class="tablenoborder"><a name="vpcep_06_0306__table62266580"></a><a name="table62266580"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0306__table62266580" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="vpcep_06_0306__row18576134"><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_0306__p28271860"><strong id="vpcep_06_0306__b1449643752">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_0306__p8319290"><strong id="vpcep_06_0306__b1899890990">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_0306__p2773889"><strong id="vpcep_06_0306__b1906978591">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0306__row23358448"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0306__p12986160">endpoints</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_0306__p45246057">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_0306__p41051970">Lists the VPC endpoints. For details, see <a href="#vpcep_06_0306__table66917326">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row33923410"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0306__p63441662">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_0306__p38501023">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_0306__p31575197">Specifies the total number of VPC endpoints that meet the search criteria. The number is not affected by the limit or offset.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="msonormal" id="vpcep_06_0306__p15741322">
|
|
<div class="tablenoborder"><a name="vpcep_06_0306__table66917326"></a><a name="table66917326"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0306__table66917326" frame="border" border="1" rules="all"><caption><b>Table 4 </b>endpoint parameters</caption><thead align="left"><tr id="vpcep_06_0306__row13233973"><th align="left" class="cellrowborder" valign="top" width="18.67%" id="mcps1.3.4.2.1.2.1.2.4.1.1"><p id="vpcep_06_0306__p65318886"><strong id="vpcep_06_0306__b199751343956">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.06%" id="mcps1.3.4.2.1.2.1.2.4.1.2"><p id="vpcep_06_0306__p56338379"><strong id="vpcep_06_0306__b945115696">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.27%" id="mcps1.3.4.2.1.2.1.2.4.1.3"><p id="vpcep_06_0306__p5964"><strong id="vpcep_06_0306__b1795265891">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0306__row483155"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p39135557">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p15863564">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p9880336">Specifies the unique ID of the VPC endpoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row21814164"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p22116861">service_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p46635351">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p20173443232">Specifies the type of the VPC endpoint service that is associated with the VPC endpoint.</p>
|
|
<ul id="vpcep_06_0306__ul649612552553"><li id="vpcep_06_0306__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_0306__vpcep_06_0201_li1664631084019">Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.</li></ul>
|
|
<p id="vpcep_06_0306__p183231822163010">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_0306__row40086300"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p25764838">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p6577116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p9341183673">Specifies the connection status of the VPC endpoint.</p>
|
|
<ul id="vpcep_06_0306__ul5651138111613"><li id="vpcep_06_0306__li1665119388168"><strong id="vpcep_06_0306__b7185310918">pendingAcceptance</strong>: The VPC endpoint is to be accepted.</li><li id="vpcep_06_0306__li765133810165"><strong id="vpcep_06_0306__b8388551564">creating</strong>: The VPC endpoint is being created.</li><li id="vpcep_06_0306__li1765113841614"><strong id="vpcep_06_0306__b58094713615">accepted</strong>: The VPC endpoint has been accepted.</li><li id="vpcep_06_0306__li765211380163"><strong id="vpcep_06_0306__b12181151017617">rejected</strong>: The VPC endpoint has been rejected.</li><li id="vpcep_06_0306__li06521038151611"><strong id="vpcep_06_0306__b1828515121565">failed</strong>: The VPC endpoint failed to be created.</li><li id="vpcep_06_0306__li56525382165"><strong id="vpcep_06_0306__b851981414616">deleting</strong>: The VPC endpoint is being deleted.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row649392710720"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p5596102919715">active_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p1832415441514">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p14324144165119">Specifies the <span id="vpcep_06_0306__vpcep_06_0303_text1337812195564"></span><span id="vpcep_06_0306__vpcep_06_0303_text15194211569">domain</span> status.</p>
|
|
<ul id="vpcep_06_0306__ul15778105411011"><li id="vpcep_06_0306__li1177955461020"><strong id="vpcep_06_0306__b7427033698">arrear_frozen</strong>: frozen due to arrears</li><li id="vpcep_06_0306__li87791554101013"><strong id="vpcep_06_0306__b134489345916">verify_frozen</strong>: frozen due to lack of real-name authentication</li><li id="vpcep_06_0306__li157790547103"><strong id="vpcep_06_0306__b442419351092">police_frozen</strong>: frozen for legal management</li><li id="vpcep_06_0306__li19779454101011"><strong id="vpcep_06_0306__b144474368911">illegal_frozen</strong>: frozen due to abuse</li><li id="vpcep_06_0306__li845017031115"><strong id="vpcep_06_0306__b1235217371916">partner_frozen</strong>: frozen for partnership</li><li id="vpcep_06_0306__li15779185412103"><strong id="vpcep_06_0306__b2015933816914">active</strong>: The <span id="vpcep_06_0306__text31606381194"></span><span id="vpcep_06_0306__text111611938795">domain</span> is normal.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row13248788"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p66518913">endpoint_service_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p19322891">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p40790059">Specifies the name of the VPC endpoint service.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row60635237"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p12507189">marker_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p6449406">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p41592001">Specifies the packet ID of the VPC endpoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row3996575"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p55287131">endpoint_service_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p49072652">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p30414410">Specifies the ID of the VPC endpoint service.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row4939503"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p64555475">enable_dns</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p61610950">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p72792580273">Specifies whether to create a private domain name.</p>
|
|
<ul id="vpcep_06_0306__ul145169269292"><li id="vpcep_06_0306__li95161626192917"><strong id="vpcep_06_0306__b9272132515472">true</strong>: A private domain name is created.</li><li id="vpcep_06_0306__li45171626102919"><strong id="vpcep_06_0306__b655202720473">false</strong>: A private domain name is not created.</li></ul>
|
|
<div class="note" id="vpcep_06_0306__note1021533535814"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0306__vpcep_06_0303_p119994525918">When a VPC endpoint for connecting to a gateway VPC endpoint service is created, no private domain name is created no matter <strong id="vpcep_06_0306__vpcep_06_0303_b960193116271">enable_dns</strong> is set to <strong id="vpcep_06_0306__vpcep_06_0303_b1156335172819">true</strong> or <strong id="vpcep_06_0306__vpcep_06_0303_b844393752815">false</strong>.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row18553230"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p19065375">dns_names</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p791512">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p64112473">Specifies the domain name for accessing the associated VPC endpoint service.</p>
|
|
<div class="note" id="vpcep_06_0306__note12165173942919"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0306__vpcep_06_0304_vpcep_06_0303_p20166739192912">This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service and <strong id="vpcep_06_0306__vpcep_06_0304_b19807293645557">enable_dns</strong> is set to <strong id="vpcep_06_0306__vpcep_06_0304_b15910335135557">true</strong>.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row64991609"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p29829016">ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p231264">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p58649253">Specifies the IP address for accessing the associated VPC endpoint service.</p>
|
|
<p id="vpcep_06_0306__p6384123752411">This parameter is returned only under the following conditions:</p>
|
|
<ul id="vpcep_06_0306__ul173695525264"><li id="vpcep_06_0306__vpcep_06_0304_li668413551811">You query a VPC endpoint for accessing an interface VPC endpoint service.</li><li id="vpcep_06_0306__vpcep_06_0304_li1168415355187">The connection approval function is enabled for the VPC endpoint service, and the connection has been approved.<p id="vpcep_06_0306__vpcep_06_0304_p753135720212"><a name="vpcep_06_0306__vpcep_06_0304_li1168415355187"></a><a name="vpcep_06_0304_li1168415355187"></a>The status of the VPC endpoint can be <strong id="vpcep_06_0306__vpcep_06_0304_b918718321178">Accepted</strong> or <strong id="vpcep_06_0306__vpcep_06_0304_b14930933772">Rejected</strong>. The <strong id="vpcep_06_0306__vpcep_06_0304_b11266144183514">Rejected</strong> status only appears when the VPC endpoint is accepted and then rejected.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row27309271653"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p3122202914513">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p131221129354">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p74750053813">Specifies the ID of the VPC where the VPC endpoint is to be created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row48344988"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p23629983">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p34980450">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p1593291111113">Specifies the ID of the subnet in the VPC specified by <strong id="vpcep_06_0306__vpcep_06_0303_b1757761010202">vpc_id</strong>. The ID is in UUID format.</p>
|
|
<div class="note" id="vpcep_06_0306__note1977123123310"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0306__p48629317123">This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row66488697"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p16875413">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p24731180">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p22890001">Specifies the creation time of the VPC endpoint.</p>
|
|
<p id="vpcep_06_0306__p871616113394">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row43855216"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p62611582">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p38373348">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p27321481">Specifies the update time of the VPC endpoint.</p>
|
|
<p id="vpcep_06_0306__p181016810016">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row56883622"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p44170673">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p21054736">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p27712044">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_0306__row726332011274"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p13103244015">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p21037441512">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p1510414411116">Lists the resource tags. For details, see <a href="#vpcep_06_0306__table489217571060">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row1880234911514"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p121325518514">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p1113213511156">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p84071479448">Specifies the error message.</p>
|
|
<p id="vpcep_06_0306__p45203393322">This field is returned when the status of the VPC endpoint changes to <strong id="vpcep_06_0306__b118547229151">failed</strong>. For details, see <a href="#vpcep_06_0306__table1736562411812">Table 6</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row10379344155716"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p165011381477">whitelist</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p450173820473">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p2538528143320">Specifies the whitelist for controlling access to the VPC endpoint.</p>
|
|
<p id="vpcep_06_0306__p386713773414">If you do not specify this parameter, an empty whitelist is returned.</p>
|
|
<div class="note" id="vpcep_06_0306__note0675183412207"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0306__vpcep_06_0303_p197191540171910">This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row5137168152410"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p050938124710">enable_whitelist</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p85019382479">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p1458051113412">Specifies whether access control is enabled.</p>
|
|
<ul id="vpcep_06_0306__ul1343419257325"><li id="vpcep_06_0306__vpcep_06_0303_li1998719418116"><strong id="vpcep_06_0306__vpcep_06_0303_b1795943787">true</strong>: Access control is enabled.</li><li id="vpcep_06_0306__vpcep_06_0303_li3987104110119"><strong id="vpcep_06_0306__vpcep_06_0303_b12134145911314">false</strong>: Access control is disabled.</li></ul>
|
|
<p id="vpcep_06_0306__p16973392358">If you do not specify this parameter, the whitelist is not enabled.</p>
|
|
<div class="note" id="vpcep_06_0306__note166751254239"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0306__vpcep_06_0303_p197191540171910_1">This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row17501117248"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p9502038174719">routetables</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p650203810476">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p422280153614">Lists the IDs of route tables.</p>
|
|
<p id="vpcep_06_0306__p17737722113611">If you do not specify this parameter, the route table ID of the VPC is returned.</p>
|
|
<div class="note" id="vpcep_06_0306__note54641152642"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0306__vpcep_06_0303_p81061157249">This parameter is available only when you create a VPC endpoint for connecting to a gateway VPC endpoint service.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row2031615352816"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p1853163320202">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p15531163322013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p953193312205">Specifies the description of the VPC endpoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row1748219408478"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p52731546125215">specification_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p027354685220">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p927410461524">Specifies the name of the VPC endpoint specifications.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row895218324501"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p186639235611">endpoint_pool_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p9758339428">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p1375873919211">(To be discarded) Specifies the ID of the cluster associated with the VPC endpoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__row154823403476"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="vpcep_06_0306__p12741546125216">enable_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="vpcep_06_0306__p86691815583">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="vpcep_06_0306__p6274174685214">Specifies whether to enable the endpoint.</p>
|
|
<ul id="vpcep_06_0306__ul2871132125712"><li id="vpcep_06_0306__li187143210573"><strong id="vpcep_06_0306__b196211350592">enable</strong>: The endpoint will be enabled.</li><li id="vpcep_06_0306__li18871832205714"><strong id="vpcep_06_0306__b105921530102">disable</strong>: The endpoint will be disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpcep_06_0306__table489217571060"></a><a name="table489217571060"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0306__table489217571060" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Tags parameters</caption><thead align="left"><tr id="vpcep_06_0306__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_0306__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p21724664"><strong id="vpcep_06_0306__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_0306__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p63406242"><strong id="vpcep_06_0306__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_0306__vpcep_06_0201_vpcep_06_0201_en-us_topic_0056765542_p35632012"><strong id="vpcep_06_0306__vpcep_06_0201_b163691023811">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0306__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_0306__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_0306__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_0306__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_0306__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_0306__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_0306__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_0306__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_0306__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_0306__table1736562411812"></a><a name="table1736562411812"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0306__table1736562411812" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Error parameters</caption><thead align="left"><tr id="vpcep_06_0306__vpcep_06_0202_row4652255153018"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="vpcep_06_0306__vpcep_06_0202_p665015573309"><strong id="vpcep_06_0306__vpcep_06_0202_b085424117110">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.630000000000003%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="vpcep_06_0306__vpcep_06_0202_p865015710307"><strong id="vpcep_06_0306__vpcep_06_0202_b2057561169">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.029999999999994%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="vpcep_06_0306__vpcep_06_0202_p1565011575303"><strong id="vpcep_06_0306__vpcep_06_0202_b1010514442017">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0306__vpcep_06_0202_row865255513010"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="vpcep_06_0306__vpcep_06_0202_p96501057153013">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.630000000000003%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="vpcep_06_0306__vpcep_06_0202_p6650155710309">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.029999999999994%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="vpcep_06_0306__vpcep_06_0202_p12650557133019">Specifies the error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0306__vpcep_06_0202_row186521755153018"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="vpcep_06_0306__vpcep_06_0202_p10650057123018">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.630000000000003%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="vpcep_06_0306__vpcep_06_0202_p14650157113016">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.029999999999994%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="vpcep_06_0306__vpcep_06_0202_p156501957183013">Specifies the error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="vpcep_06_0306__ul30083052"><li id="vpcep_06_0306__li2312013"><a name="vpcep_06_0306__li2312013"></a><a name="li2312013"></a>Example response<pre class="screen" id="vpcep_06_0306__screen1239973012354">{
|
|
"endpoints":
|
|
[
|
|
{
|
|
"id":"03184a04-95d5-4555-86c4-e767a371ff99",
|
|
"status":"accepted",
|
|
"ip":"192.168.0.232",
|
|
"marker_id":16777337,
|
|
"active_status":[
|
|
"active"
|
|
],
|
|
"vpc_id":"84758cf5-9c62-43ae-a778-3dbd8370c0a4",
|
|
"service_type":"interface",
|
|
"project_id":"295dacf46a4842fcbf7844dc2dc2489d",
|
|
"subnet_id":"68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de",
|
|
"enable_dns":"true",
|
|
"specification_name":"default",
|
|
"endpoint_pool_id":"501f4a3b-6f96-4309-97d1-e291b8ca5b96",
|
|
"dns_name":"test123",
|
|
"created_at":"2018-10-18T06:49:46Z",
|
|
"updated_at":"2018-10-18T06:49:50Z",
|
|
"endpoint_service_id":"5133655d-0e28-4090-b669-13f87b355c78",
|
|
"endpoint_service_name":"test123",
|
|
"whitelist":["127.0.0.1"],
|
|
"enable_whitelist":true,
|
|
"description" : "",
|
|
"tags":
|
|
[
|
|
{
|
|
"key":"test1",
|
|
"value":"test1"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id":"43b0e3b0-eec9-49da-866b-6687b75f9fe5",
|
|
"status":"accepted",
|
|
"ip":"192.168.0.115",
|
|
"marker_id":16777322,
|
|
"active_status":[
|
|
"active"
|
|
],
|
|
"vpc_id":"e251b400-2963-4131-b38a-da81e32026ee",
|
|
"service_type":"interface",
|
|
"project_id":"295dacf46a4842fcbf7844dc2dc2489d",
|
|
"subnet_id":"65528a22-59a1-4972-ba64-88984b3207cd",
|
|
"enable_dns":"true",
|
|
"specification_name":"default",
|
|
"endpoint_pool_id":"ee38223b-aacb-46f0-ba7e-94fa62e35dde",
|
|
"dns_name":"test123",
|
|
"created_at":"2018-10-18T06:36:20Z",
|
|
"updated_at":"2018-10-18T06:36:24Z",
|
|
"endpoint_service_id":"5133655d-0e28-4090-b669-13f87b355c78",
|
|
"endpoint_service_name":"test123",
|
|
"whitelist":["127.0.0.1"],
|
|
"enable_whitelist":true,
|
|
"description" : "",
|
|
"tags":
|
|
[
|
|
{
|
|
"key":"test1",
|
|
"value":"test1"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"total_count":2
|
|
}</pre>
|
|
<p id="vpcep_06_0306__p2516809"></p>
|
|
</li></ul>
|
|
<div class="section" id="vpcep_06_0306__section21324079"><h4 class="sectiontitle">Status Codes</h4><p class="msonormal" id="vpcep_06_0306__p2534996">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_0300.html">APIs for Managing VPC Endpoints</a></div>
|
|
</div>
|
|
</div>
|
|
|