forked from docs/doc-exports
Zheng, Xiu
bf0cbd66f9
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com> Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
198 lines
13 KiB
HTML
198 lines
13 KiB
HTML
<a name="css_03_0112"></a><a name="css_03_0112"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining an Endpoint Connection</h1>
|
|
<div id="body0000001475730750"><div class="section" id="css_03_0112__section863219015273"><h4 class="sectiontitle">Function</h4><p id="css_03_0112__p6633170132711">This API is used to obtain a VPC endpoint connection.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section13634703275"><h4 class="sectiontitle">URI</h4><p id="css_03_0112__p86342012713">GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0112__table116365022712" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0112__row86352014279"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0112__p1636100152716">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0112__p96363022715">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0112__p1163717013276">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0112__p1863719082710">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0112__row1263512062715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0112__p14637150142713">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0112__p126381014273">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0112__p963810112713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0112__p163910010273">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row96352004274"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0112__p3639180102718">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0112__p364017019278">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0112__p1864014032716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0112__p66415011273">ID of the cluster you want to query.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section0641507273"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0112__p96428072715">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section196421011277"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0112__p8643909279"><strong id="css_03_0112__b14643809272">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0112__response_GetVpcepConnectionResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="css_03_0112__row1064419011278"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0112__p26458011271">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0112__p166451707278">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0112__p964640182718">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0112__row964416092713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0112__p19646203278">connections</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0112__p7646108277">Array of <a href="#css_03_0112__response_connections">connections</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0112__p176478012715">Connection information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row11644405270"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0112__p1464716013276">vpcepUpdateSwitch</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0112__p56488032711">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0112__p16491400272">Whether to update endpoints.</p>
|
|
<ul id="css_03_0112__ul865060112719"><li id="css_03_0112__li14650806273"><strong id="css_03_0112__b965010152711">true</strong>: The VPC endpoint is enabled.</li><li id="css_03_0112__li165019072713"><strong id="css_03_0112__b565113052715">false</strong>: The VPC endpoint is disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row166442007275"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0112__p116512012271">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0112__p1565117082713">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0112__p1865210014278">Number of endpoints.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0112__response_connections"></a><a name="response_connections"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0112__response_connections" frame="border" border="1" rules="all"><caption><b>Table 3 </b>connections</caption><thead align="left"><tr id="css_03_0112__row1165710102714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0112__p146592005271">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="css_03_0112__p1965912020278">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="css_03_0112__p11660180182712">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0112__row565760172715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0112__p36605013271">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0112__p766115012717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0112__p1566118020271">Endpoint ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row06571503276"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0112__p66621052710">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0112__p11662190182716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0112__p3663307271">Endpoint status.</p>
|
|
<ul id="css_03_0112__ul126631202271"><li id="css_03_0112__li76630042714"><strong id="css_03_0112__b166460202712">accepted</strong>: The VPC endpoint connection is enabled.</li><li id="css_03_0112__li17664101270"><strong id="css_03_0112__b366414019279">rejected</strong>: The VPC endpoint connection is disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row165710019275"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0112__p1866519014273">maxSession</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0112__p96656012272">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0112__p16661004273">Maximum number of connections.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row665720014271"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0112__p146669022711">specificationName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0112__p2667200172717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0112__p17667190132713">Endpoint name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row116579012278"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0112__p466811016279">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0112__p566815052717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0112__p13669405273">Creation time. The format is <strong id="css_03_0112__b1266918011274">ISO8601: CCYY-MM-DDThh:mm:ss</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row265780182715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0112__p15670502274">update_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0112__p167060152713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0112__p2670408271">Update time. The default value is <strong id="css_03_0112__b267130102712">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row18658150152712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0112__p767100192717">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0112__p867210014275">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0112__p16672501272">Owner.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section3672190122717"><h4 class="sectiontitle">Example Requests</h4><p id="css_03_0112__p1567330142710">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section1767360172716"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0112__p26731052717"><strong id="css_03_0112__b1567316019276">Status code: 200</strong></p>
|
|
<p id="css_03_0112__p126740032712">Request succeeded.</p>
|
|
<pre class="screen" id="css_03_0112__screen136742002278">{
|
|
"connections" : [ {
|
|
"id" : "connectionsID",
|
|
"status" : "accepted",
|
|
"maxSession" : "3000",
|
|
"specificationName" : "default",
|
|
"created_at" : "2021-09-17T08:00:07Z",
|
|
"update_at" : null,
|
|
"domain_id" : "domainID"
|
|
} ],
|
|
"vpcepUpdateSwitch" : "false",
|
|
"total_count" : 1
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section166779011276"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0112__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0112__row1867820102716"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0112__p967916019272">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="css_03_0112__p1679120192711">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0112__row367815011279"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0112__p06803014277">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0112__p268115052720">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row13678806272"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0112__p196828082719">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0112__p176828032718">Invalid request.</p>
|
|
<p id="css_03_0112__p12683160102712">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row667819020271"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0112__p8683200152718">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0112__p16841100276">The request could not be completed due to a conflict with the current state of the resource.</p>
|
|
<p id="css_03_0112__p368420112715">The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row156782014277"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0112__p18685404276">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0112__p16851062714">The server did not meet one of the preconditions contained in the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0109.html">VPC Endpoint</a></div>
|
|
</div>
|
|
</div>
|
|
|