forked from laiweijian4/doc-exports
Zheng, Xiu
99a2d77599
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>
200 lines
14 KiB
HTML
200 lines
14 KiB
HTML
<a name="css_03_0112"></a><a name="css_03_0112"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining a VPC Endpoint Connection</h1>
|
|
<div id="body0000001475730750"><div class="section" id="css_03_0112__section15665659102019"><h4 class="sectiontitle">Function</h4><p id="css_03_0112__p146661359102019">This API is used to obtain a VPC endpoint connection.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section7666185915205"><h4 class="sectiontitle">Debugging</h4><p id="css_03_0112__p8667155972016">You can debug this API in . Automatic authentication is supported.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section10667359182012"><h4 class="sectiontitle">URI</h4><p id="css_03_0112__p2667195913203">GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0112__table13670959132010" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0112__row1666915912018"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0112__p867165913204">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="css_03_0112__p12671175918208">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="css_03_0112__p1671125911207">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="css_03_0112__p1967245912010">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0112__row0670155914206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0112__p1267215932012">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0112__p176727591201">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0112__p146734595206">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0112__p5674159122011">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__row1267018597204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0112__p9674165992011">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0112__p186757598202">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0112__p8675145919206">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0112__p1967625912011">ID of the cluster to be queried</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section1267635952011"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0112__p146761359142018">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section6677195932019"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0112__p3677165922019"><strong id="css_03_0112__b816740518113034">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 parameter</caption><thead align="left"><tr id="css_03_0112__row1683125915209"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="css_03_0112__p1268495913202">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="css_03_0112__p1368575916204">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="css_03_0112__p11685105942019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0112__row06832059162012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="css_03_0112__p136851659122012">connections</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="css_03_0112__p106861859182013">Array of <a href="#css_03_0112__response_connections">connections</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="css_03_0112__p1469320594209">Connection information</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row2683659162011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="css_03_0112__p469435911206">vpcepUpdateSwitch</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="css_03_0112__p19695959142011">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="css_03_0112__p66951459182015">Indicates whether the endpoint update function is enabled.</p>
|
|
<ul id="css_03_0112__ul169555910201"><li id="css_03_0112__li769535910206"><strong id="css_03_0112__b33438167504">true</strong>: enabled</li><li id="css_03_0112__li126961159202013"><strong id="css_03_0112__b162042261502">false</strong>: disabled</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row368395910202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="css_03_0112__p46960595209">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="css_03_0112__p1969605992010">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="css_03_0112__p17697185911204">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__row974635962018"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="css_03_0112__p1748259142012">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="css_03_0112__p174818598203">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="css_03_0112__p1748185982010">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0112__row147461059102011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0112__p16749559182013">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0112__p275013591202">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0112__p5750185922015">Endpoint ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row10746759102019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0112__p4751115962013">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0112__p87517598203">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0112__p19752359172016">Endpoint status.</p>
|
|
<ul id="css_03_0112__ul875235932018"><li id="css_03_0112__li07521959132011"><strong id="css_03_0112__b255243304613">accepted</strong>: The VPC endpoint connection is enabled.</li><li id="css_03_0112__li775215596205"><strong id="css_03_0112__b1440194164616">rejected</strong>: The VPC endpoint connection is disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row374612592201"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0112__p375375911201">maxSession</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0112__p3753165917203">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0112__p10754165912012">Maximum number of connections</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row127464597205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0112__p14754175912202">specificationName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0112__p1375485911203">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0112__p177554597206">Endpoint name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row6746165902014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0112__p1975555962015">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0112__p27579596200">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0112__p275815593202">Time when a cluster is created. The format is <strong id="css_03_0112__b13260162014493">ISO8601: CCYY-MM-DDThh:mm:ss</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row12746155962017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0112__p1475917598201">update_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0112__p1775985962016">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0112__p676045911204">Update time. The default value is <strong id="css_03_0112__b66194315497">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row20746159162015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0112__p107602059132014">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0112__p7761165919206">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0112__p14761115972014">Owner</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section1576185912018"><h4 class="sectiontitle">Request Example</h4><p id="css_03_0112__p2761155992012">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0112__section676218592205"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0112__p576265910207"><strong id="css_03_0112__b976424923113034">Status code: 200</strong></p>
|
|
<p id="css_03_0112__p137621359192010">The request is processed successfully.</p>
|
|
<pre class="screen" id="css_03_0112__screen16763165920205">{
|
|
"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__section576605982014"><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__row8767759172019"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="css_03_0112__p6768125942014">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="css_03_0112__p77691159152016">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0112__row11767185918208"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0112__p077011593207">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0112__p97701659192020">The request is processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row676755918204"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0112__p5774159142017">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0112__p10774195910206">Invalid request.</p>
|
|
<p id="css_03_0112__p777565982018">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row676725992020"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0112__p97763591208">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0112__p477675992010">The request cannot be processed due to a conflict.</p>
|
|
<p id="css_03_0112__p57773591207">This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0112__row11767125902014"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0112__p177719594207">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0112__p37775592209">The server does not meet one of the requirements that the requester puts on 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>
|
|
|