备案 控制台 登录 注册
文档中心 > DescribeVpc
DescribeVpc

最近更新时间：2021-12-23

请求方法：GET

接口描述：使用 DescribeVpc 查询已创建的 VPC 列表。


请求参数

Param

名称

类型

是否必选

描述

Action

String

是

要执行的操作。 取值： DescribeVpc。

RegionId

String

是

地域ID。
  HB1-BJMY （华北2-北京2） ；
  HD1-SHMY（华东1-上海）

VpcId

String

否

指定VPC实例的ID。

Name

String

否

指定VPC实例的名称。


返回参数

名称

类型

示例值

RequestId

String

请求ID。

Code

String

请求结果编码。

Msg

String

请求结果描述。

Res

Array

VPC列表。

+Status

String

VPC实例状态。

+RegionId

String

地域ID。

+InstanceCode

String

VPC实例规格。

+UserId

String

用户ID。

+InstanceId

String

VPC实例ID。

+Cidr

String

VPC实例CIDR网段。

+InstanceName

String

VPC实例名称。

+Subnets

Array

子网列表。

++BindResources

Array

子网下的资源列表。

+++ReviceId

String

绑定资源的ID。

+++ResourceType

String

绑定资源的类型。

++Name

String

子网名称。

++DnsNameServers

Array

DNS域名服务器。

++IpAssignedCount

Integer

子网内已分配IP数。

++IpTotalCount

Integer

子网内可用IP总数。

++Cidr

String

子网网段。

IsCrossZone

Boolean

是否跨可用区。

AzoneId

String

可用区ID。

IpV6Cidr

String

IPv6网段。

IpV6GatewayIp

String

IPv6网关。

HasIpV6

Boolean

子网是否支持IPv6。

++GatewayIp

String

网关。

++AllocationPool

Object

可分配IP地址池。

+++End

String

可分配IP地址池结束IP。

+++Start

String

可分配IP地址池起始IP。

++Id

String

子网ID。


示例

请求示例

GET https://api.unicloud.com/networks/vpc?Action=DescribeVpc
&RegionId=HB1-BJMY
&公共请求参数

返回示例

JSON格式

{
   "Code": "Network.Success",
   "Msg": "获取VPC列表成功",                          
   "Res": [                          
       {                          
          "Status": "RUNNING",                          
           "RegionId": "cn-beijing",                          
           "InstanceCode": "vpc.standard",                          
           "UserId": "de3d55a8-f822-461e-8133-52375100ad87",                          
           "InstanceId": "vpc-0g3gllt1jy2ob",                          
           "Cidr": "172.16.0.0/12",                          
           "InstanceName": "vpc17212",                          
           "Subnets": [                          
                   {                          
                        "BindResources": [                                                    
                          {                                                    
                               "ReviceId": "ecs-Dj06HAMiQu15qSdtvol3bSpLOv5qASUn",                                                    
                               "ResourceType": "UNICLOUD::ECS::Instance"                                                    
                          }                                                    
                      ],                                                    
                   "Name": "sub1721",                                                    
                   "DnsNameServers": [                                                    
                       "113.207.55.15",                                                    
                       "220.194.70.15"                                                    
                   ],                                                    
                   "IpAssignedCount": 1,                                                    
                   "Cidr": "172.16.1.0/24",                                                    
                   "IpTotalCount": 250,                                                    
                   "IsCrossZone": false,                                                    
                   "AzoneId": "cn-beijing-a",                                                    
                   "GatewayIp": "172.16.1.1",                                                                              
                   "IpV6Cidr": "1A1A:1A1A:1A1A:C/64",                                                                              
                   "IpV6GatewayIp": "1A1A:1A1A:1A1A:C::2",                                                                              
                   "HasIpV6": true,                                                                              
                   "AllocationPool": {                                                                              
                       "End": "172.16.1.251",                                                                              
                       "Start": "172.16.1.2"                                                                               
                   },                                                                              
                   "Id": "ecf43e97390a4e6e8db9328cfabbf91a"                                                                              
               }                                                                              
           ]                                                                              
       },                                                                              
       {                                                                                                              
           "Status": "RUNNING",                                                                                                        
           "RegionId": "cn-beijing",                                                                                                        
           "InstanceCode": "vpc.standard",                                                                                                        
           "UserId": "de3d55a8-f822-461e-8133-52375100ad87",

          "InstanceId": "vpc-gk4pnp0x872ob",                                                                                                        
           "Cidr": "101.150.6.0/24",                                                                                                        
           "InstanceName": "test",                                                                                                        
           "Subnets": [                                                                                                        
               {                                                                                                        
                   "BindResources": {},                                                                                                        
                   "Name": "ttt",                                                                                                        
                   "DnsNameServers": [                                                                                                        
                       "113.207.55.15",                                                                                                        
                       "220.194.70.15"                                                                                                        
                   ],                                                                                                        
                   "IpAssignedCount": 0,                                                                                                        
                   "Cidr": "101.150.6.0/25",                                                                                                        
                   "IpTotalCount": 122,                                                                                                        
                   "IsCrossZone": ture,                                                                                                        
                   "AzoneId": "cn-beijing-a",                                                                                                                                
                   "IpV6Cidr": "1A1A:1A1A:1A1A:C/64",                                                                                                                 
                   "IpV6GatewayIp": "1A1A:1A1A:1A1A:C::2",                                                                                                         
                   "HasIpV6": true,                                                                                                                                  
                   "GatewayIp": "101.150.6.1",                                                                                                                              
                   "AllocationPool": {                                                                                                                                  
                       "End": "101.150.6.123",                                                                                                                                
                       "Start": "101.150.6.2"                                                                                                                                  
                   },                                                                                                                                                            
                   "Id": "cade3cf7f6b44b64aa2b1a99708f4518"                                                             
               }                                                                                                                                                            
           ]                                                                                                                                                            
       }                                                                                                                                                                        
   ],                                                                                                                                                                                      
   "RequestId": "4cbe3e81-4c7c-4db3-a5a5-3b877ab2df1f"                                                                                                  
}