forked from laiweijian4/doc-exports
gtema
4cfecba474
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com> Co-authored-by: gtema <artem.goncharov@gmail.com> Co-committed-by: gtema <artem.goncharov@gmail.com>
180 lines
15 KiB
HTML
180 lines
15 KiB
HTML
<a name="vpc_peering_0002"></a><a name="vpc_peering_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying a VPC Peering Connection</h1>
|
|
<div id="body1504753416893"><div class="section" id="vpc_peering_0002__section1018045115610"><h4 class="sectiontitle">Function</h4><p id="vpc_peering_0002__p16365145114613">This API is used to query details about a VPC peering connection.</p>
|
|
</div>
|
|
<div class="section" id="vpc_peering_0002__section121811651468"><h4 class="sectiontitle">URI</h4><p id="vpc_peering_0002__p36714378122">GET /v2.0/vpc/peerings/{peering_id}</p>
|
|
<div class="p" id="vpc_peering_0002__p1399515108616"><a href="#vpc_peering_0002__table18880184689">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="vpc_peering_0002__table18880184689"></a><a name="table18880184689"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_peering_0002__table18880184689" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_peering_0002__row13968641385"><th align="left" class="cellrowborder" valign="top" width="22.222222222222225%" id="mcps1.3.2.3.2.2.5.1.1"><p id="vpc_peering_0002__p209684410817"><strong id="vpc_peering_0002__b842352706195711">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.14141414141414%" id="mcps1.3.2.3.2.2.5.1.2"><p id="vpc_peering_0002__p69681441386"><strong id="vpc_peering_0002__b84235270615219">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.27272727272727%" id="mcps1.3.2.3.2.2.5.1.3"><p id="vpc_peering_0002__p1096813412811"><strong id="vpc_peering_0002__b842352706145623">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.36363636363636%" id="mcps1.3.2.3.2.2.5.1.4"><p id="vpc_peering_0002__p139686416813"><strong id="vpc_peering_0002__b8423527061645">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_peering_0002__row19681041189"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="vpc_peering_0002__p1013244217196">peering_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="vpc_peering_0002__p1797015416817">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="vpc_peering_0002__p19701411813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="vpc_peering_0002__p109701641488">Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. The <strong id="vpc_peering_0002__b842352706144243">peering_id</strong> value is used as the filter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_peering_0002__section101901751566"><h4 class="sectiontitle">Request Message</h4><ul id="vpc_peering_0002__ul18655151321410"><li id="vpc_peering_0002__li96554136146">Request parameter<p id="vpc_peering_0002__p1283161719145"><a name="vpc_peering_0002__li96554136146"></a><a name="li96554136146"></a>None</p>
|
|
</li><li id="vpc_peering_0002__li17655813121419">Example request<pre class="screen" id="vpc_peering_0002__screen17367155113616">GET https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_peering_0002__section101901851869"><h4 class="sectiontitle">Response Message</h4><ul id="vpc_peering_0002__ul7782193911141"><li id="vpc_peering_0002__li15782939131419">Response parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_peering_0002__table919115511064" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_peering_0002__row436713511462"><th align="left" class="cellrowborder" valign="top" width="23.169999999999998%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpc_peering_0002__p23677513619">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.61%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpc_peering_0002__p18367251264">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.22%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpc_peering_0002__p1136715519612">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_peering_0002__row93671514617"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpc_peering_0002__p13367651061">peering</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpc_peering_0002__p936745111620"><a href="#vpc_peering_0002__table1026243410414">peering</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpc_peering_0002__p1036719511614">Specifies the VPC peering connection object list. For details, see <a href="#vpc_peering_0002__table1026243410414">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_peering_0002__table1026243410414"></a><a name="table1026243410414"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_peering_0002__table1026243410414" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_peering_0002__b591191411312">peering</strong> objects</caption><thead align="left"><tr id="vpc_peering_0002__row145386341548"><th align="left" class="cellrowborder" valign="top" width="32.81%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpc_peering_0002__p553843415417"><strong id="vpc_peering_0002__b13521521193113">Attribute</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.43%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpc_peering_0002__p453814344418"><strong id="vpc_peering_0002__b8393522113112">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.76%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpc_peering_0002__p13539183410412"><strong id="vpc_peering_0002__b10312132312313">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_peering_0002__row195391034944"><td class="cellrowborder" valign="top" width="32.81%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_peering_0002__p1053943410414">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.43%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_peering_0002__p753963414417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_peering_0002__p17539123411413">Specifies the VPC peering connection ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_peering_0002__row185391134449"><td class="cellrowborder" valign="top" width="32.81%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_peering_0002__p15540123413417">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.43%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_peering_0002__p85405341547">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_peering_0002__p1654017341747">Specifies the VPC peering connection name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_peering_0002__row45401734847"><td class="cellrowborder" valign="top" width="32.81%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_peering_0002__p354083416417">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.43%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_peering_0002__p11540034946">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_peering_0002__p11298143785016">Specifies the VPC peering connection status. Possible values are as follows:</p>
|
|
<ul id="vpc_peering_0002__ul6640134318521"><li id="vpc_peering_0002__li146411343125218"><strong id="vpc_peering_0002__b1662883413311">PENDING_ACCEPTANCE</strong></li><li id="vpc_peering_0002__li186411432525"><strong id="vpc_peering_0002__b104441235133118">REJECTED</strong></li><li id="vpc_peering_0002__li1164164315525"><strong id="vpc_peering_0002__b11641036133114">EXPIRED</strong></li><li id="vpc_peering_0002__li146411643165213"><strong id="vpc_peering_0002__b12730103733120">DELETED</strong></li><li id="vpc_peering_0002__li10641443115215"><strong id="vpc_peering_0002__b6352938163119">ACTIVE</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_peering_0002__row155415343411"><td class="cellrowborder" valign="top" width="32.81%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_peering_0002__p185411334349">request_vpc_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.43%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_peering_0002__p1854183414414"><a href="#vpc_peering_0002__table1132310347417">vpc_info</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_peering_0002__p155422348412">Specifies information about the local VPC. For details, see <a href="#vpc_peering_0002__table1132310347417">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_peering_0002__row145425341249"><td class="cellrowborder" valign="top" width="32.81%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_peering_0002__p25421834641">accept_vpc_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.43%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_peering_0002__p354211341141"><a href="#vpc_peering_0002__table1132310347417">vpc_info</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_peering_0002__p3542143419414">Specifies information about the peer VPC. For details, see <a href="#vpc_peering_0002__table1132310347417">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_peering_0002__row17791105316527"><td class="cellrowborder" valign="top" width="32.81%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_peering_0002__p9792195385219">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.43%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_peering_0002__p3792205365218">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_peering_0002__p10792953155215">Provides supplementary information about the VPC peering connection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_peering_0002__row4121155915218"><td class="cellrowborder" valign="top" width="32.81%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_peering_0002__p1312155914528">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.43%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_peering_0002__p201218597524">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_peering_0002__p1395374115919">Specifies the time (UTC) when the VPC peering connection is created.</p>
|
|
<p id="vpc_peering_0002__p65980291419">Format: <em id="vpc_peering_0002__i1085175123211">yyyy-MM-ddTHH:mm:ss</em></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_peering_0002__row15465113115319"><td class="cellrowborder" valign="top" width="32.81%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_peering_0002__p74651838533">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.43%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_peering_0002__p8465203125315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_peering_0002__p271618182568">Specifies the time (UTC) when the VPC peering connection is updated.</p>
|
|
<p id="vpc_peering_0002__p187161918125617">Format: <em id="vpc_peering_0002__i12818202683215">yyyy-MM-ddTHH:mm:ss</em></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_peering_0002__table1132310347417"></a><a name="table1132310347417"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_peering_0002__table1132310347417" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_peering_0002__b847313283325">vpc_info</strong> objects</caption><thead align="left"><tr id="vpc_peering_0002__row65431034046"><th align="left" class="cellrowborder" valign="top" width="32.81%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="vpc_peering_0002__p14543173418413"><strong id="vpc_peering_0002__b130133015324">Attribute</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.43%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="vpc_peering_0002__p1354353413410"><strong id="vpc_peering_0002__b09719317322">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.76%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="vpc_peering_0002__p19543634641"><strong id="vpc_peering_0002__b138551031203220">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_peering_0002__row4543434247"><td class="cellrowborder" valign="top" width="32.81%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpc_peering_0002__p13544163416415">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.43%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpc_peering_0002__p654410341549">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpc_peering_0002__p55448348416">Specifies the ID of a VPC involved in a VPC peering connection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_peering_0002__row65441334646"><td class="cellrowborder" valign="top" width="32.81%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpc_peering_0002__p14544034945">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.43%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpc_peering_0002__p454413347419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpc_peering_0002__p105449344410">Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="vpc_peering_0002__li12224202151515">Example response<pre class="screen" id="vpc_peering_0002__screen936745117620">{
|
|
"peering": {
|
|
"name": "test",
|
|
"id": "22b76469-08e3-4937-8c1d-7aad34892be1",
|
|
"request_vpc_info": {
|
|
"vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299",
|
|
"tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e"
|
|
},
|
|
"accept_vpc_info": {
|
|
"vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5",
|
|
"tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e"
|
|
},
|
|
"status": "ACTIVE"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_peering_0002__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_peering_0002__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_peering_0002__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_peering_0002__p17281622133910">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_peering_0000.html">VPC Peering Connection</a></div>
|
|
</div>
|
|
</div>
|
|
|