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>
274 lines
24 KiB
HTML
274 lines
24 KiB
HTML
<a name="vpcep_06_0206"></a><a name="vpcep_06_0206"></a>
|
|
|
|
<h1 class="topictitle1">Querying Connections of a VPC Endpoint Service</h1>
|
|
<div id="body11956340"><div class="section" id="vpcep_06_0206__section59609807"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="vpcep_06_0206__p28939455">This API is used to query connections of a VPC endpoint service. <strong id="vpcep_06_0206__b12259111179">marker_id</strong> is the unique ID of each connection.</p>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0206__section66726219"><h4 class="sectiontitle">URI</h4><p id="vpcep_06_0206__p391494711710">GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections?id={vpc_endpoint_id}&marker_id={marker_id}&status={status}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}</p>
|
|
<div class="msonormal" id="vpcep_06_0206__p624413203159"><a href="#vpcep_06_0206__table36274863">Table 1</a> describes parameters in this URI.
|
|
<div class="tablenoborder"><a name="vpcep_06_0206__table36274863"></a><a name="table36274863"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0206__table36274863" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="vpcep_06_0206__row8393309"><th align="left" class="cellrowborder" valign="top" width="32.65%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpcep_06_0206__p8769420"><strong id="vpcep_06_0206__b20111832112818">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_0206__p39234444"><strong id="vpcep_06_0206__b189663352812">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_0206__p23873413"><strong id="vpcep_06_0206__b2012193413286">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0206__row54698270"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0206__p1374847">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_0206__p44253777">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_0206__p27786171">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_0206__row48748953"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0206__p56351131">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_0206__p1038922">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_0206__p17043853">Specifies the ID of the VPC endpoint service.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpcep_06_0206__table52582818"></a><a name="table52582818"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0206__table52582818" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="vpcep_06_0206__row52789044"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.4.2.5.1.1"><p id="vpcep_06_0206__p48054166"><strong id="vpcep_06_0206__b4618154752810">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.36816318368163%" id="mcps1.3.2.4.2.5.1.2"><p id="vpcep_06_0206__p73360"><strong id="vpcep_06_0206__b935077498">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.2.4.2.5.1.3"><p id="vpcep_06_0206__p5942219"><strong id="vpcep_06_0206__b92291454292">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.4.2.5.1.4"><p id="vpcep_06_0206__p11557743"><strong id="vpcep_06_0206__b796897364">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0206__row63761954"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0206__p64444687">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0206__p52637148">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0206__p35750577">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0206__p10115639">Specifies the unique ID of the VPC endpoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row23931892"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0206__p59435077">marker_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0206__p49511964">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0206__p51046110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0206__p41094261">Specifies the packet ID of the VPC endpoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row4586144863120"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0206__p30989061">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0206__p5695196162713">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0206__p27086052">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0206__p1936140162713">Specifies the connection status of the VPC endpoint.</p>
|
|
<ul id="vpcep_06_0206__ul32642017171417"><li id="vpcep_06_0206__li192651517121415"><strong id="vpcep_06_0206__b15618144154213">pendingAcceptance</strong>: The VPC endpoint is to be accepted.</li><li id="vpcep_06_0206__li1726581721417"><strong id="vpcep_06_0206__b58094713615">accepted</strong>: The VPC endpoint has been accepted.</li><li id="vpcep_06_0206__li4265121710148"><strong id="vpcep_06_0206__b181305583138">rejected</strong>: The VPC endpoint has been rejected.</li><li id="vpcep_06_0206__li1926551751411"><strong id="vpcep_06_0206__b953411520505">failed</strong>: The VPC endpoint service failed to be created.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row34304036"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0206__p27163541">sort_key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0206__p52763214">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0206__p45961976">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0206__p562418271823">Specifies the sorting field of the VPC endpoint list. The field can be:</p>
|
|
<ul id="vpcep_06_0206__ul512472071414"><li id="vpcep_06_0206__vpcep_06_0205_li348811372710"><strong id="vpcep_06_0206__b1521045925216">created_at</strong>: VPC endpoints are sorted by creation time.</li><li id="vpcep_06_0206__vpcep_06_0205_li8488111318274"><strong id="vpcep_06_0206__b16973132135317">updated_at</strong>: VPC endpoints are sorted by update time.</li></ul>
|
|
<p id="vpcep_06_0206__p36041148141413">The default field is <strong id="vpcep_06_0206__vpcep_06_0205_b84581912152219">created_at</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row18957973"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0206__p59200815">sort_dir</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0206__p30536693">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0206__p57553105">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0206__p2195022">Specifies the sorting method of the VPC endpoint list. The method can be:</p>
|
|
<ul id="vpcep_06_0206__ul9628101291617"><li id="vpcep_06_0206__vpcep_06_0205_li3203210322"><strong id="vpcep_06_0206__b4405105916458">desc</strong>: VPC endpoints are sorted in descending order.</li><li id="vpcep_06_0206__vpcep_06_0205_li162062117325"><strong id="vpcep_06_0206__b20953813164614">asc</strong>: VPC endpoints are sorted in ascending order.</li></ul>
|
|
<p id="vpcep_06_0206__p1719319255168">The default method is <strong id="vpcep_06_0206__vpcep_06_0205_b84235270614202">desc</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row60429836"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0206__p62978522">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0206__p986624">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0206__p12807719">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0206__p30792310">Specifies the maximum number of connections displayed on each page.</p>
|
|
<p id="vpcep_06_0206__p8695341">The number ranges from <strong id="vpcep_06_0206__b11334153516916">0</strong> to <strong id="vpcep_06_0206__b18135173816911">1000</strong> and is generally <strong id="vpcep_06_0206__b18432047311">10</strong>,<strong id="vpcep_06_0206__b194327474118"> 20</strong>, or <strong id="vpcep_06_0206__b743316471615">50</strong>. The default number is <strong id="vpcep_06_0206__b1434247811">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row11149206"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0206__p30670511">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.36816318368163%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0206__p1283432">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0206__p36849129">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0206__p5736126132214">Specifies the offset.</p>
|
|
<p id="vpcep_06_0206__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>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0206__section63665063"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0206__ul169664168351"><li class="msonormal" id="vpcep_06_0206__li11115115714268">Parameter description<p class="msonormal" id="vpcep_06_0206__p1883219121514"><a name="vpcep_06_0206__li11115115714268"></a><a name="li11115115714268"></a>None</p>
|
|
</li><li id="vpcep_06_0206__li1120813467357">Example request<div class="p" id="vpcep_06_0206__p914144017588"><a name="vpcep_06_0206__li1120813467357"></a><a name="li1120813467357"></a>This request is to query connections of the VPC endpoint service whose ID is <strong id="vpcep_06_0206__b2138141092310">4189d3c2-8882-4871-a3c2-d380272eed88</strong>.<pre class="codeblock" id="vpcep_06_0206__codeblock1667883835819">GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/connections</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0206__section56596492"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0206__ul16901451155612"><li id="vpcep_06_0206__li1769010512560">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0206__table3483316" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="vpcep_06_0206__row57609611"><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_0206__p35866908"><strong id="vpcep_06_0206__b1150500205">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_0206__p19538401"><strong id="vpcep_06_0206__b688101039">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_0206__p39106626"><strong id="vpcep_06_0206__b1159501625">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0206__row13520169"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0206__p21391867">connections</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_0206__p55019682">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_0206__p27409286">Lists the connections. For details, see <a href="#vpcep_06_0206__table35346078">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row45356986"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0206__p50037251">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_0206__p26485565">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_0206__p19295714142518">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="tablenoborder"><a name="vpcep_06_0206__table35346078"></a><a name="table35346078"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0206__table35346078" frame="border" border="1" rules="all"><caption><b>Table 4 </b>connection parameters</caption><thead align="left"><tr id="vpcep_06_0206__row47425555"><th align="left" class="cellrowborder" valign="top" width="24.490000000000002%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpcep_06_0206__p16264769"><strong id="vpcep_06_0206__b152329173414">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.73%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpcep_06_0206__p42377887"><strong id="vpcep_06_0206__b48908829">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.779999999999994%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpcep_06_0206__p10056789"><strong id="vpcep_06_0206__b2091614196">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0206__row9293580"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0206__p14582507">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0206__p40332443">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.779999999999994%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0206__p45702468">Specifies the unique ID of the VPC endpoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row8669029"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0206__p31102709">marker_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0206__p36291473">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.779999999999994%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0206__p53928226">Specifies the packet ID of the VPC endpoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row15591994"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0206__p54992021">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0206__p25168729">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.779999999999994%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0206__p22890001">Specifies the creation time of the VPC endpoint.</p>
|
|
<p id="vpcep_06_0206__p871616113394">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row27283604"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0206__p62488324">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0206__p28389464">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.779999999999994%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0206__p27321481">Specifies the update time of the VPC endpoint.</p>
|
|
<p id="vpcep_06_0206__p181016810016">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row26389441"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0206__p57169983">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0206__p257086">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.779999999999994%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0206__p20824038">Specifies the user's domain ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row53198616"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0206__p14120655">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0206__p2922435">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.779999999999994%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0206__p583352918492">Specifies the connection status of the VPC endpoint.</p>
|
|
<ul id="vpcep_06_0206__ul1860111019616"><li id="vpcep_06_0206__li156011015610"><strong id="vpcep_06_0206__b191551251104318">pendingAcceptance</strong>: The VPC endpoint is to be accepted.</li><li id="vpcep_06_0206__li56021506613"><strong id="vpcep_06_0206__b7464355131310">creating</strong>: The VPC endpoint is being created.</li><li id="vpcep_06_0206__li156021601965"><strong id="vpcep_06_0206__b16976115612137">accepted</strong>: The VPC endpoint has been accepted.</li><li id="vpcep_06_0206__li186021501965"><strong id="vpcep_06_0206__b819982636">rejected</strong>: The VPC endpoint has been rejected.</li><li id="vpcep_06_0206__li460211020618"><strong id="vpcep_06_0206__b2047964555015">failed</strong>: The VPC endpoint service failed to be created.</li><li id="vpcep_06_0206__li176021401464"><strong id="vpcep_06_0206__b11461337105417">deleting</strong>: The VPC endpoint is being deleted.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__row8293720736"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0206__p1317922816319">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0206__p41797281633">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.779999999999994%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0206__p12568428134419">Specifies the error message.</p>
|
|
<p id="vpcep_06_0206__p2478152724413">This field is returned when the status of the VPC endpoint service changes to <strong id="vpcep_06_0206__b63071019102">failed</strong>. For details, see <a href="#vpcep_06_0206__table1979118317570">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpcep_06_0206__table1979118317570"></a><a name="table1979118317570"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0206__table1979118317570" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Error parameters</caption><thead align="left"><tr id="vpcep_06_0206__vpcep_06_0202_row4652255153018"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="vpcep_06_0206__vpcep_06_0202_p665015573309"><strong id="vpcep_06_0206__vpcep_06_0202_b085424117110">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.630000000000003%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="vpcep_06_0206__vpcep_06_0202_p865015710307"><strong id="vpcep_06_0206__vpcep_06_0202_b2057561169">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.029999999999994%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="vpcep_06_0206__vpcep_06_0202_p1565011575303"><strong id="vpcep_06_0206__vpcep_06_0202_b1010514442017">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0206__vpcep_06_0202_row865255513010"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0206__vpcep_06_0202_p96501057153013">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.630000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpcep_06_0206__vpcep_06_0202_p6650155710309">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.029999999999994%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpcep_06_0206__vpcep_06_0202_p12650557133019">Specifies the error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0206__vpcep_06_0202_row186521755153018"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0206__vpcep_06_0202_p10650057123018">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.630000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpcep_06_0206__vpcep_06_0202_p14650157113016">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.029999999999994%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpcep_06_0206__vpcep_06_0202_p156501957183013">Specifies the error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="vpcep_06_0206__ul1606041"><li id="vpcep_06_0206__li14454373">Example response<pre class="screen" id="vpcep_06_0206__screen62980495">{
|
|
"connections": [
|
|
{
|
|
"id": "<em id="vpcep_06_0206__i1079314211843">adb7b229-bb11-4072-bcc0-3327cd784263</em>",
|
|
"status": "<em id="vpcep_06_0206__i1542514251414">accepted</em>",
|
|
"marker_id": <em id="vpcep_06_0206__i76418411554">16777510</em>,
|
|
"domain_id": "<em id="vpcep_06_0206__i91981946854">5fc973eea581490997e82ea11a1df31f</em>",
|
|
"created_at": "<em id="vpcep_06_0206__i284812151566">2018-09-17T11:10:11Z</em>",
|
|
"updated_at": "<em id="vpcep_06_0206__i1195421965">2018-09-17T11:10:12Z</em>"
|
|
},
|
|
{
|
|
"id": "<em id="vpcep_06_0206__i182316141172">fd69d29f-dc29-4a9b-80d8-b51d1e7e58ea</em>",
|
|
"status": "<em id="vpcep_06_0206__i4468121712714">accepted</em>",
|
|
"marker_id": <em id="vpcep_06_0206__i05518205716">16777513</em>,
|
|
"domain_id": "<em id="vpcep_06_0206__i4321024772">5fc973eea581490997e82ea11a1df31f</em>",
|
|
"created_at": "<em id="vpcep_06_0206__i18478162717712">2018-09-17T07:28:56Z</em>",
|
|
"updated_at": "<em id="vpcep_06_0206__i76841530378">2018-09-17T07:28:58Z</em>"
|
|
}
|
|
],
|
|
"total_count":<em id="vpcep_06_0206__i148315198144">2</em>
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="vpcep_06_0206__section20913125"><h4 class="sectiontitle">Status Codes</h4><p class="msonormal" id="vpcep_06_0206__p1146441">See <a href="vpcep_08_0001.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpcep_06_0200.html">APIs for Managing VPC Endpoint Services</a></div>
|
|
</div>
|
|
</div>
|
|
|