yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/vpc/api-ref/vpc_apiv3_0004.html
fanqinying 05458809ab VPC API 20250121 version 
Reviewed-by: Szirovicza Gergő <a94652429@noreply.gitea.eco.tsi-dev.otc-service.com>
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: fanqinying <fanqinying@huawei.com>
Co-committed-by: fanqinying <fanqinying@huawei.com>
2025-09-11 14:33:55 +00:00

347 lines
32 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="vpc_apiv3_0004"></a><a name="vpc_apiv3_0004"></a>
<h1 class="topictitle1">Querying the Details of a VPC</h1>
<div id="body1708331107508"><div class="section" id="vpc_apiv3_0004__section78609204819"><h4 class="sectiontitle">Function</h4><p id="vpc_apiv3_0004__p17860520985">After a VPC is created, you can call this API to query all information about the VPC, including the VPC name, ID, and CIDR block.</p>
</div>
<div class="section" id="vpc_apiv3_0004__section18612020681"><h4 class="sectiontitle">URI</h4><p id="vpc_apiv3_0004__p18614201989">GET /v3/{project_id}/vpc/vpcs/{vpc_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0004__table486282019816" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="vpc_apiv3_0004__row1386115201382"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="vpc_apiv3_0004__p11862820688">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="vpc_apiv3_0004__p1786211201787">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="vpc_apiv3_0004__p13862420988">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="vpc_apiv3_0004__p148625208819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0004__row08614201986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="vpc_apiv3_0004__p2086362019812">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="vpc_apiv3_0004__p14863152014810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="vpc_apiv3_0004__p18631020888">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><ul id="vpc_apiv3_0004__ul17863112019815"><li id="vpc_apiv3_0004__li28631820385"><p id="vpc_apiv3_0004__p118631720084"><a name="vpc_apiv3_0004__li28631820385"></a><a name="li28631820385"></a>Definition: ID of the project that a VPC belongs to.</p>
</li><li id="vpc_apiv3_0004__li168631020785"><p id="vpc_apiv3_0004__p28631820882"><a name="vpc_apiv3_0004__li168631020785"></a><a name="li168631020785"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row786216207811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="vpc_apiv3_0004__p386362018810">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="vpc_apiv3_0004__p1286312201584">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="vpc_apiv3_0004__p208631020986">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><ul id="vpc_apiv3_0004__ul88637208812"><li id="vpc_apiv3_0004__li158631201812"><p id="vpc_apiv3_0004__p786316206812"><a name="vpc_apiv3_0004__li158631201812"></a><a name="li158631201812"></a>Definition: VPC ID, which uniquely identifies the VPC.</p>
</li><li id="vpc_apiv3_0004__li1686314201584"><p id="vpc_apiv3_0004__p1286416201818"><a name="vpc_apiv3_0004__li1686314201584"></a><a name="li1686314201584"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0004__section2864120984"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_apiv3_0004__p158645202085">None</p>
</div>
<div class="section" id="vpc_apiv3_0004__section88648201187"><h4 class="sectiontitle">Response Parameters</h4><p id="vpc_apiv3_0004__p208641620789"><strong id="vpc_apiv3_0004__b3864202010812">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0004__response_ShowVpcResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="vpc_apiv3_0004__row886414202811"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="vpc_apiv3_0004__p986442017815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="vpc_apiv3_0004__p1486518207813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="vpc_apiv3_0004__p88651201781">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0004__row15864102015819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_apiv3_0004__p18651120485">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_apiv3_0004__p17865520789">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><ul id="vpc_apiv3_0004__ul13865720282"><li id="vpc_apiv3_0004__li158657201783"><p id="vpc_apiv3_0004__p118651202083"><a name="vpc_apiv3_0004__li158657201783"></a><a name="li158657201783"></a>Definition: Request ID.</p>
</li><li id="vpc_apiv3_0004__li138653201882"><p id="vpc_apiv3_0004__p68657202082"><a name="vpc_apiv3_0004__li138653201882"></a><a name="li138653201882"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row08645201812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_apiv3_0004__p198651220185">vpc</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_apiv3_0004__p7865520684"><a href="#vpc_apiv3_0004__response_Vpc">Vpc</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><ul id="vpc_apiv3_0004__ul28659201782"><li id="vpc_apiv3_0004__li188657202085"><p id="vpc_apiv3_0004__p28657208817"><a name="vpc_apiv3_0004__li188657202085"></a><a name="li188657202085"></a>Definition: Response body for querying details about a VPC.</p>
</li><li id="vpc_apiv3_0004__li11865172010816"><p id="vpc_apiv3_0004__p2865162020818"><a name="vpc_apiv3_0004__li11865172010816"></a><a name="li11865172010816"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0004__response_Vpc"></a><a name="response_Vpc"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0004__response_Vpc" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Vpc</caption><thead align="left"><tr id="vpc_apiv3_0004__row1586613201987"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="vpc_apiv3_0004__p686732019816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="vpc_apiv3_0004__p68672201584">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="vpc_apiv3_0004__p98671820488">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0004__row128660203818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p78671020288">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p186720208814">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul12867020282"><li id="vpc_apiv3_0004__li1886718209813"><p id="vpc_apiv3_0004__p1886716201812"><a name="vpc_apiv3_0004__li1886718209813"></a><a name="li1886718209813"></a>Definition: VPC ID. After a VPC is created, a VPC ID is generated, which uniquely identifies the VPC.</p>
</li><li id="vpc_apiv3_0004__li1686712200813"><p id="vpc_apiv3_0004__p12867132013814"><a name="vpc_apiv3_0004__li1686712200813"></a><a name="li1686712200813"></a>Range: The value is in UUID format with hyphens (-).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row1286672015812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p78671220085">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p58671520989">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul086717208819"><li id="vpc_apiv3_0004__li19868112010816"><p id="vpc_apiv3_0004__p7868142014816"><a name="vpc_apiv3_0004__li19868112010816"></a><a name="li19868112010816"></a>Definition: VPC name.</p>
</li><li id="vpc_apiv3_0004__li1086862019811"><p id="vpc_apiv3_0004__p10868182011818"><a name="vpc_apiv3_0004__li1086862019811"></a><a name="li1086862019811"></a>Range: The value can contain 0 to 64 characters. It can include letters, digits, underscores (_), hyphens (-), and periods (.).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row17866132011814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p186852011817">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p18683204811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul118681820687"><li id="vpc_apiv3_0004__li1486819202814"><p id="vpc_apiv3_0004__p18868162011812"><a name="vpc_apiv3_0004__li1486819202814"></a><a name="li1486819202814"></a>Definition: Description of a VPC.</p>
</li><li id="vpc_apiv3_0004__li12868112020817"><p id="vpc_apiv3_0004__p178687201288"><a name="vpc_apiv3_0004__li12868112020817"></a><a name="li12868112020817"></a>Range: The value can contain no more than 255 characters and cannot contain angle brackets (&lt; or &gt;).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row15866220187"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p10868820284">cidr</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p1686815201381">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul6868172013811"><li id="vpc_apiv3_0004__li1286812206811"><p id="vpc_apiv3_0004__p208681520180"><a name="vpc_apiv3_0004__li1286812206811"></a><a name="li1286812206811"></a>Definition: Available subnets in a VPC.</p>
</li><li id="vpc_apiv3_0004__li986818201585"><p id="vpc_apiv3_0004__p1186814201889"><a name="vpc_apiv3_0004__li986818201585"></a><a name="li986818201585"></a>Range:</p>
<ul id="vpc_apiv3_0004__ul1686815201282"><li id="vpc_apiv3_0004__li4868112012816"><p id="vpc_apiv3_0004__p78684201889"><a name="vpc_apiv3_0004__li4868112012816"></a><a name="li4868112012816"></a>10.0.0.0/8–24: The IP address ranges from 10.0.0.0 to 10.255.255.255, and the netmask ranges from 8 to 24.</p>
</li><li id="vpc_apiv3_0004__li208680204813"><p id="vpc_apiv3_0004__p1586818208817"><a name="vpc_apiv3_0004__li208680204813"></a><a name="li208680204813"></a>172.16.0.0/12–24: The IP address ranges from 172.16.0.0 to 172.31.255.255, and the netmask ranges from 12 to 24.</p>
</li><li id="vpc_apiv3_0004__li28699201683"><p id="vpc_apiv3_0004__p118695201388"><a name="vpc_apiv3_0004__li28699201683"></a><a name="li28699201683"></a>192.168.0.0/16–24: The IP address ranges from 192.168.0.0 to 192.168.255.255, and the netmask ranges from 16 to 24.</p>
</li><li id="vpc_apiv3_0004__li5869120882"><p id="vpc_apiv3_0004__p1686916202820"><a name="vpc_apiv3_0004__li5869120882"></a><a name="li5869120882"></a>If <strong id="vpc_apiv3_0004__b12869192019819">cidr</strong> is not specified, the default value is <strong id="vpc_apiv3_0004__b4869820982">""</strong>.</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row58661920485"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p486914207819">extend_cidrs</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p686919201489">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul1986942013814"><li id="vpc_apiv3_0004__li086912201084"><p id="vpc_apiv3_0004__p786992015810"><a name="vpc_apiv3_0004__li086912201084"></a><a name="li086912201084"></a>Definition: Secondary CIDR blocks of a VPC.</p>
</li><li id="vpc_apiv3_0004__li6869820483"><p id="vpc_apiv3_0004__p2869720481"><a name="vpc_apiv3_0004__li6869820483"></a><a name="li6869820483"></a>Range: The following CIDR blocks are not supported:</p>
<ul id="vpc_apiv3_0004__ul198691220181"><li id="vpc_apiv3_0004__li158699209818"><p id="vpc_apiv3_0004__p208696206813"><a name="vpc_apiv3_0004__li158699209818"></a><a name="li158699209818"></a>10.0.0.0/8: The IP address range is 10.0.0.0-10.255.255.255.</p>
</li><li id="vpc_apiv3_0004__li586922016819"><p id="vpc_apiv3_0004__p68697200811"><a name="vpc_apiv3_0004__li586922016819"></a><a name="li586922016819"></a>172.16.0.0/12: The IP address range is 172.16.0.0-172.31.255.255.</p>
</li><li id="vpc_apiv3_0004__li138691620582"><p id="vpc_apiv3_0004__p48696201781"><a name="vpc_apiv3_0004__li138691620582"></a><a name="li138691620582"></a>192.168.0.0/16: The IP address range is 192.168.0.0-192.168.255.255.</p>
</li><li id="vpc_apiv3_0004__li158691020581"><p id="vpc_apiv3_0004__p88691520886"><a name="vpc_apiv3_0004__li158691020581"></a><a name="li158691020581"></a>172.31.0.0/16: The IP address range is 172.31.0.0-172.31.255.255.</p>
</li><li id="vpc_apiv3_0004__li128698203810"><p id="vpc_apiv3_0004__p138697201284"><a name="vpc_apiv3_0004__li128698203810"></a><a name="li128698203810"></a>100.64.0.0/10: The IP address range is 100.64.0.0-100.127.255.255.</p>
</li><li id="vpc_apiv3_0004__li28691201280"><p id="vpc_apiv3_0004__p686917201819"><a name="vpc_apiv3_0004__li28691201280"></a><a name="li28691201280"></a>214.0.0.0/7: The IP address range is 214.0.0.0-215.255.255.255.</p>
</li><li id="vpc_apiv3_0004__li208698201388"><p id="vpc_apiv3_0004__p486913201288"><a name="vpc_apiv3_0004__li208698201388"></a><a name="li208698201388"></a>198.18.0.0/15: The IP address range is 198.18.0.0-198.19.255.255.</p>
</li><li id="vpc_apiv3_0004__li118706207814"><p id="vpc_apiv3_0004__p18706201686"><a name="vpc_apiv3_0004__li118706207814"></a><a name="li118706207814"></a>169.254.0.0/16: The IP address range is 169.254.0.0-169.254.255.255.</p>
</li><li id="vpc_apiv3_0004__li887012201482"><p id="vpc_apiv3_0004__p1087012202819"><a name="vpc_apiv3_0004__li887012201482"></a><a name="li887012201482"></a>0.0.0.0/8: The IP address range is 0.0.0.0-0.255.255.255.</p>
</li><li id="vpc_apiv3_0004__li187012017813"><p id="vpc_apiv3_0004__p1870120883"><a name="vpc_apiv3_0004__li187012017813"></a><a name="li187012017813"></a>127.0.0.0/8: The IP address range is 127.0.0.0-127.255.255.255.</p>
</li><li id="vpc_apiv3_0004__li8870142012815"><p id="vpc_apiv3_0004__p98701920684"><a name="vpc_apiv3_0004__li8870142012815"></a><a name="li8870142012815"></a>240.0.0.0/4: The IP address range is 240.0.0.0-255.255.255.255.</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row886632019820"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p20870620885">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p1187016201380">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul587011201584"><li id="vpc_apiv3_0004__li2870122015817"><p id="vpc_apiv3_0004__p6870122020811"><a name="vpc_apiv3_0004__li2870122015817"></a><a name="li2870122015817"></a>Definition: VPC status.</p>
</li><li id="vpc_apiv3_0004__li17870120182"><p id="vpc_apiv3_0004__p28701620882"><a name="vpc_apiv3_0004__li17870120182"></a><a name="li17870120182"></a>Range:</p>
<ul id="vpc_apiv3_0004__ul78701520489"><li id="vpc_apiv3_0004__li1987020201786"><p id="vpc_apiv3_0004__p19870420487"><a name="vpc_apiv3_0004__li1987020201786"></a><a name="li1987020201786"></a><strong id="vpc_apiv3_0004__b208708203810">PENDING</strong>: The VPC is being created.</p>
</li><li id="vpc_apiv3_0004__li687032018813"><p id="vpc_apiv3_0004__p58701206817"><a name="vpc_apiv3_0004__li687032018813"></a><a name="li687032018813"></a><strong id="vpc_apiv3_0004__b587022010817">ACTIVE</strong>: The VPC is created.</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row886611201685"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p1187017209815">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p118701320986">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul1487013208812"><li id="vpc_apiv3_0004__li168705201584"><p id="vpc_apiv3_0004__p158711206816"><a name="vpc_apiv3_0004__li168705201584"></a><a name="li168705201584"></a>Definition: ID of the project that a VPC belongs to.</p>
</li><li id="vpc_apiv3_0004__li1387118201785"><p id="vpc_apiv3_0004__p3871720581"><a name="vpc_apiv3_0004__li1387118201785"></a><a name="li1387118201785"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row1786610202816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p12871120782">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p287114201086">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul1871142014812"><li id="vpc_apiv3_0004__li78711620287"><p id="vpc_apiv3_0004__p887115201984"><a name="vpc_apiv3_0004__li78711620287"></a><a name="li78711620287"></a>Definition: ID of the enterprise project that a VPC belongs to.</p>
</li><li id="vpc_apiv3_0004__li1187114201885"><p id="vpc_apiv3_0004__p1487117201782"><a name="vpc_apiv3_0004__li1187114201885"></a><a name="li1187114201885"></a>Range: The value is <strong id="vpc_apiv3_0004__b17871122014817">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). <strong id="vpc_apiv3_0004__b78715202084">0</strong> indicates the default enterprise project.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row28665207819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p1887115206819">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p78711207817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul1187112201817"><li id="vpc_apiv3_0004__li138711720884"><p id="vpc_apiv3_0004__p9871172015812"><a name="vpc_apiv3_0004__li138711720884"></a><a name="li138711720884"></a>Definition: Time when a VPC was created.</p>
</li><li id="vpc_apiv3_0004__li68711720885"><p id="vpc_apiv3_0004__p5871102019813"><a name="vpc_apiv3_0004__li68711720885"></a><a name="li68711720885"></a>Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row138661120685"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p287110201980">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p387142017819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul12871132014818"><li id="vpc_apiv3_0004__li108711320282"><p id="vpc_apiv3_0004__p108716201489"><a name="vpc_apiv3_0004__li108711320282"></a><a name="li108711320282"></a>Definition: Time when a VPC was updated.</p>
</li><li id="vpc_apiv3_0004__li88711120680"><p id="vpc_apiv3_0004__p487292012810"><a name="vpc_apiv3_0004__li88711120680"></a><a name="li88711120680"></a>Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row19866112020810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p16872162010818">cloud_resources</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p2087213201784">Array of <a href="#vpc_apiv3_0004__response_CloudResource">CloudResource</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul38721020186"><li id="vpc_apiv3_0004__li208726201981"><p id="vpc_apiv3_0004__p2087210201888"><a name="vpc_apiv3_0004__li208726201981"></a><a name="li208726201981"></a>Definition: Type and number of resources associated with a VPC. For example, subnets and route tables.</p>
</li><li id="vpc_apiv3_0004__li98721201288"><p id="vpc_apiv3_0004__p887212207814"><a name="vpc_apiv3_0004__li98721201288"></a><a name="li98721201288"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row1686612201583"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0004__p108727202818">tags</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0004__p13872920482">Array of <a href="#vpc_apiv3_0004__response_ResponseTag">ResponseTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0004__ul287211206817"><li id="vpc_apiv3_0004__li48727205816"><p id="vpc_apiv3_0004__p68726209814"><a name="vpc_apiv3_0004__li48727205816"></a><a name="li48727205816"></a>Definition: Tags of a VPC, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects.</p>
</li><li id="vpc_apiv3_0004__li0872520781"><p id="vpc_apiv3_0004__p1787214201981"><a name="vpc_apiv3_0004__li0872520781"></a><a name="li0872520781"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0004__response_CloudResource"></a><a name="response_CloudResource"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0004__response_CloudResource" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CloudResource</caption><thead align="left"><tr id="vpc_apiv3_0004__row5873720789"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="vpc_apiv3_0004__p17874152011814">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="vpc_apiv3_0004__p1887482015812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="vpc_apiv3_0004__p16874132010816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0004__row10874202020811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="vpc_apiv3_0004__p28746203811">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="vpc_apiv3_0004__p887418201282">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><ul id="vpc_apiv3_0004__ul1187462015814"><li id="vpc_apiv3_0004__li14874120184"><p id="vpc_apiv3_0004__p18874202016817"><a name="vpc_apiv3_0004__li14874120184"></a><a name="li14874120184"></a>Definition: Resource type.</p>
</li><li id="vpc_apiv3_0004__li68740201283"><p id="vpc_apiv3_0004__p1687417201813"><a name="vpc_apiv3_0004__li68740201283"></a><a name="li68740201283"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row68740201686"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="vpc_apiv3_0004__p108747202081">resource_count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="vpc_apiv3_0004__p1287520201819">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><ul id="vpc_apiv3_0004__ul1687516201580"><li id="vpc_apiv3_0004__li48751520384"><p id="vpc_apiv3_0004__p287512017811"><a name="vpc_apiv3_0004__li48751520384"></a><a name="li48751520384"></a>Definition: Number of resources.</p>
</li><li id="vpc_apiv3_0004__li78751200816"><p id="vpc_apiv3_0004__p118751520886"><a name="vpc_apiv3_0004__li78751200816"></a><a name="li78751200816"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0004__response_ResponseTag"></a><a name="response_ResponseTag"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0004__response_ResponseTag" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResponseTag</caption><thead align="left"><tr id="vpc_apiv3_0004__row98751820586"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="vpc_apiv3_0004__p1687517203812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="vpc_apiv3_0004__p178769201985">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="vpc_apiv3_0004__p887632012816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0004__row28751120484"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="vpc_apiv3_0004__p168764208815">key</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="vpc_apiv3_0004__p178761920385">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><ul id="vpc_apiv3_0004__ul3585326104"><li id="vpc_apiv3_0004__li145851921103"><p id="vpc_apiv3_0004__p65857241011"><a name="vpc_apiv3_0004__li145851921103"></a><a name="li145851921103"></a>Definition: Tag key.</p>
</li><li id="vpc_apiv3_0004__li4585622108"><p id="vpc_apiv3_0004__p158592191010"><a name="vpc_apiv3_0004__li4585622108"></a><a name="li4585622108"></a>Range:</p>
<ul id="vpc_apiv3_0004__ul1058511241010"><li id="vpc_apiv3_0004__li0585102141010"><p id="vpc_apiv3_0004__p1158519211011"><a name="vpc_apiv3_0004__li0585102141010"></a><a name="li0585102141010"></a>Each key can contain up to 36 Unicode characters and cannot be left blank.</p>
</li><li id="vpc_apiv3_0004__li155853212101"><p id="vpc_apiv3_0004__p185857291017"><a name="vpc_apiv3_0004__li155853212101"></a><a name="li155853212101"></a>Each key value of a resource must be unique.</p>
</li><li id="vpc_apiv3_0004__li3585025105"><p id="vpc_apiv3_0004__p2586102171014"><a name="vpc_apiv3_0004__li3585025105"></a><a name="li3585025105"></a>The value can contain:</p>
<ul id="vpc_apiv3_0004__ul1358618271019"><li id="vpc_apiv3_0004__li658611215104"><p id="vpc_apiv3_0004__p17586192201013"><a name="vpc_apiv3_0004__li658611215104"></a><a name="li658611215104"></a>Letters</p>
</li><li id="vpc_apiv3_0004__li6586102191017"><p id="vpc_apiv3_0004__p658616271010"><a name="vpc_apiv3_0004__li6586102191017"></a><a name="li6586102191017"></a>Digits</p>
</li><li id="vpc_apiv3_0004__li758619218107"><p id="vpc_apiv3_0004__p558618214106"><a name="vpc_apiv3_0004__li758619218107"></a><a name="li758619218107"></a>Special characters: underscores (_) ,at signs (@), and hyphens (-)</p>
</li></ul>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0004__row68751820781"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="vpc_apiv3_0004__p987732010811">value</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="vpc_apiv3_0004__p16877420883">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><ul id="vpc_apiv3_0004__ul10586625104"><li id="vpc_apiv3_0004__li7586172161016"><p id="vpc_apiv3_0004__p7586102121011"><a name="vpc_apiv3_0004__li7586172161016"></a><a name="li7586172161016"></a>Definition: Tag value.</p>
</li><li id="vpc_apiv3_0004__li458612213107"><p id="vpc_apiv3_0004__p185861261014"><a name="vpc_apiv3_0004__li458612213107"></a><a name="li458612213107"></a>Range:</p>
<ul id="vpc_apiv3_0004__ul1058622161018"><li id="vpc_apiv3_0004__li35861222107"><p id="vpc_apiv3_0004__p19586722108"><a name="vpc_apiv3_0004__li35861222107"></a><a name="li35861222107"></a>Each value can contain up to 43 Unicode characters and can be left blank.</p>
</li><li id="vpc_apiv3_0004__li45861423105"><p id="vpc_apiv3_0004__p55864231017"><a name="vpc_apiv3_0004__li45861423105"></a><a name="li45861423105"></a>The value can contain:</p>
<ul id="vpc_apiv3_0004__ul13586102131015"><li id="vpc_apiv3_0004__li85865271019"><p id="vpc_apiv3_0004__p1958632151014"><a name="vpc_apiv3_0004__li85865271019"></a><a name="li85865271019"></a>Letters</p>
</li><li id="vpc_apiv3_0004__li758613211016"><p id="vpc_apiv3_0004__p458617211106"><a name="vpc_apiv3_0004__li758613211016"></a><a name="li758613211016"></a>Digits</p>
</li><li id="vpc_apiv3_0004__li1758614241017"><p id="vpc_apiv3_0004__p135867215104"><a name="vpc_apiv3_0004__li1758614241017"></a><a name="li1758614241017"></a>Special characters: underscore (_), at signs (@), and hyphen (-)</p>
</li></ul>
</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0004__section1087852012817"><h4 class="sectiontitle">Example Requests</h4><p id="vpc_apiv3_0004__p58781520589">Querying the details of a VPC</p>
<pre class="screen" id="vpc_apiv3_0004__screen18781320283">GET https://{Endpoint}/v3/{project_id}/vpc/vpcs/0552091e-b83a-49dd-88a7-4a5c86fd9ec3</pre>
</div>
<div class="section" id="vpc_apiv3_0004__section2087862010817"><h4 class="sectiontitle">Example Responses</h4><p id="vpc_apiv3_0004__p1987813205817"><strong id="vpc_apiv3_0004__b4878132018810">Status code: 200</strong></p>
<p id="vpc_apiv3_0004__p198781120889">Normal response to the GET operation. For more status codes, see <a href="vpc_api_0002.html">Status Code</a>.</p>
<pre class="screen" id="vpc_apiv3_0004__screen687812201380">{
"request_id" : "84eb4f775d66dd916db121768ec55626",
"vpc" : {
"id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
"name" : "name-test",
"description" : "description-test",
"cidr" : "192.168.0.0/16",
"extend_cidrs" : [ "21.8.0.0/16" ],
"enterprise_project_id" : "0",
"tags" : [ {
"key" : "key",
"value" : "value"
} ],
"cloud_resources" : [ {
"resource_type" : "routetable",
"resource_count" : 1
} ],
"status" : "ACTIVE",
"project_id" : "060576782980d5762f9ec014dd2f1148",
"created_at" : "2018-03-23T09:26:08",
"updated_at" : "2018-08-24T08:49:53"
}
}</pre>
</div>
<div class="section" id="vpc_apiv3_0004__section087911202813"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0004__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="vpc_apiv3_0004__row18796206820"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="vpc_apiv3_0004__p6879420681">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="vpc_apiv3_0004__p38805201083">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0004__row148796201811"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="vpc_apiv3_0004__p148808201381">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="vpc_apiv3_0004__p7880620281">Normal response to the GET operation. For more status codes, see <a href="vpc_api_0002.html">Status Code</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0004__section6880152016817"><h4 class="sectiontitle">Error Codes</h4><p id="vpc_apiv3_0004__p888018205816">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_apiv3_0001.html">VPC</a></div>
</div>
</div>
View Git Blame Copy Permalink