You need to enable JavaScript to run this app.
导航
私有网络
  • 文档首页
    • /
  • 私有网络

DescribeVpcs

最近更新时间：2024.04.22 11:06:02

首次发布时间：2021.07.29 14:11:53

我的收藏

调用 DescribeVpcs 接口，查询满足指定条件的VPC。

调用说明

  • 传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的VPC，若没有符合条件的VPC，则返回空值。
  • 若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有VPC。
  • 使用标签过滤VPC实例时，最多可查询指定标签关联的1000个VPC实例。如果指定标签关联的VPC实例超过1000个，则只返回前1000个。此时请使用ListTagsForResources接口查询。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionString是DescribeVpcs要执行的操作。取值：DescribeVpcs。
VersionString是2020-04-01API版本信息，取值为：2020-04-01。

VpcIds.N

String

否
VpcIds.1=vpc-bp1b1p3ve5yze****&VpcIds.2=vpc-bp1b1xjllp3ve5yze****

VPC的ID。

  • 参数 - N：表示VPC ID的序号，单次调用数量上限为100个。
  • 多个VPC ID之间用&分隔。
VpcNameString否Vpc-1VPC的名称。
ProjectNameString否defaultVPC所属项目的名称。

TagFilters.N.Key

String

否

TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3

标签的标签键。

  • 参数 - N：表示标签键的序号，取值范围：1～10。
  • 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的VPC。
  • 不允许重复。

TagFilters.N.Values.N

String

否

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1

标签的标签值。

  • 第一个N：表示标签键的序号，取值范围：1～10。
  • 第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的VPC。
  • 多个标签值之间用&分隔。

说明

  • 若传入该参数，则必须先传入TagFilters.N.Key。
  • 传入空字符串时，表示查询标签值为空的VPC。

IsDefault

Boolean

否

false

该VPC是否为默认VPC。

  • true：默认VPC，表示该VPC是创建ECS实例时系统自动创建的VPC。
  • false：非默认VPC，表示该VPC是用户手动创建的。

PageNumber

Integer

否

1

列表的页码。默认值为1。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize

Integer

否

20

分页查询时每页的行数。最大值为100，默认值为20。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken

String

否

caeba0bbb2be03f84eb48b699f0a****

分页查询凭证，用于标记分页的位置。

  • 不填则从头开始查询。
  • 传入之前调用本API返回的NextToken，则从该次API调用标记分页的位置往后开始查询。
MaxResultsInteger否50查询的数量，默认为 10，最大为100。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。

TotalCount

Integer

2

符合条件的VPC总数。

说明

本参数即将下线，使用NextToken和MaxResults分页查询时，此参数无意义。

PageNumber

Integer

1

当前页码。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize

Integer

10

当前分页的行数。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。

VpcsArray of Struct-VPC的详细信息。具体请参见下表“ Vpcs结构 ”。

Vpcs结构

参数名称
类型
示例值
描述
VpcIdStringvpc-bp1qpo0kug3a20qqe****VPC的ID。

Status

String

Available

VPC的状态。

  • Creating: 创建中
  • Pending：配置中
  • Available：可用
VpcNameStringvpc1VPC的名称。
CreationTimeString2018-04-18T15:02:37+08:00创建VPC的时间。
UpdateTimeString2019-04-25T01:37:38+08:00更新VPC的时间。
CidrBlockString10.XX.XX.0/8VPC的IPv4网段。

Ipv6CidrBlock

String

2408:XXXX:0:a600::/56

VPC的IPv6网段。

说明

IPv6功能正在邀测中，如需试用，请联系客户经理。

DescriptionStringThis is my VPC.VPC的描述信息。
SubnetIdsArray["subnet-2fe74yvngdukg5oxruwgq****","subnet-1g0f7rju1txj48ibuxxob****"]VPC中子网的列表。

NatGatewayIds

Array

["ngw-3tjx9odz8q3vj0x1****"]

VPC中创建的NAT网关的ID。

说明

若VPC下没有创建NAT网关，将不会返回此参数。

RouteTableIdsArray["vtb-bp1krxxzp0c29fmon****", "vtb-2fe74xo8rwn405oxruwkk****"]VPC关联的路由表ID。
SecurityGroupIdsArray["securitygroup178ftwt45bg****","securitygroup178ftwt23ak****"]VPC中安全组的列表。
DnsServersArray["100.96.0.2", "100.96.0.3"]DNS服务器。
AssociateCensArray of Struct-VPC关联的CEN信息，具体请见下表“ AssociateCens结构 ”。
AccountIdString21000****VPC所属账号的ID。

SecondaryCidrBlocks

Array

["10.XX.XX.0/16", "10.XX.XX.1/16"]

VPC的辅助网段。

说明

VPC的辅助网段正在邀测中，如需试用，请联系客户经理

UserCidrBlocks

Array

["72.XX.XX.0/24", "96.XX.XX.0/24"]

VPC的用户网段。

说明

VPC的用户网段正在邀测中，如需试用，请联系客户经理

NetworkAclNumInteger5VPC中的网络ACL的数量。
ProjectNameStringdefaultVPC所属项目的名称。
TagsArray of Struct-VPC的标签信息。具体请参见下表“Tag结构”。

IsDefault

Boolean

false

该VPC是否为默认VPC。

  • true：默认VPC，表示该VPC是创建ECS实例时系统自动创建的VPC。
  • false：非默认VPC，表示该VPC是用户手动创建的。

AssociateCens结构

参数名称
类型
示例值
描述
CenIdStringcen-23987fdc****CEN的ID。
CenOwnerIdString122023****CEN的用户ID。
CenStatusStringAttachedVPC在CEN中的状态。
  • Attaching：加载中
  • Attached：已加载

    • Tag结构

    参数名称
    类型
    示例值
    描述
    KeyStringk1VPC标签的标签键。
    ValueStringv1VPC标签的标签值。

    请求示例

    GET /?Action=DescribeVpcs&Version=2020-04-01&VpcIds.1=vpc-bp1b1p3ve5yze****&VpcIds.2=vpc-bp1b1xjllp3ve5yze****&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

    返回示例

    {
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeVpcs",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "Vpcs": [
            {
                "VpcId": "vpc-bp1b1p3ve5yze****",
                "VpcName": "vpc-1",
                "Description": "This is my VPC.",
                "CreationTime": "2021-08-16T20:08:09+08:00",
                "UpdateTime": "2021-08-20T18:43:03+08:00",
                "CidrBlock": "10.XX.XX.0/8",
                "Ipv6CidrBlock": "2408:XXXX:0:a600::/56",
                "Status": "Available",
                "IsDefault": false,
                "SubnetIds":  [
                    "subnet-2fe74yvngdukg5oxruwgq****",
                    "subnet-1g0f7rju1txj48ibuxxob****"
                ],
                "NatGatewayIds": [
                    "ngw-3tjx9odz8q3vj0x1****",
                    "ngw-3tjtu8hzu23vj0x1****"
                ],
                "AssociateCens":[
                  {
                   	"CenId": "cen-23af298****",
                   	"CenOwnerId": "1223****",
                   	"CenStatus": "Attached"
                   }
                ],
                "RouteTableIds": [
                    "vtb-1g0oxlluo8ibuxxym2dqr****"
                ],
                "SecurityGroupIds": [
                    "sg-1g0oxlpsw8ibuxwqs32nz****"
                ],
                "DnsServers": [
                    "100.96.0.2",
                    "100.96.0.3"
                ],
                "AccountId": "21000*****",
                "NetworkAclNum": "5",
                "SecondaryCidrBlocks": [
                    "172.XX.XX.0/12",
                    "192.XX.XX.0/16"
                ],
                "UserCidrBlocks": [],
                "ProjectName": "default",
                "Tags": [ 
                    { 
                        "Key":"k1", 
                        "Value":"v1" 
                    }, 
                    { 
                        "Key":"k2", 
                        "Value":"" 
                    } 
                ]
             }
          ]
       }
    }

    错误码

    此处仅展示当前API的错误码，更多错误码请参见公共错误码。

    HttpCode
    错误码
    错误信息
    描述
    400InvalidMaxResults.MalformedThe specified parameter MaxResults is malformed.查询数量不合法。
    400InvalidNextToken.MalformedThe specified parameter NextToken is invalid.查询 NextToken 不合法。
    400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
    400InvalidTagFilter.DisorderThe specified index order of tag filter is malformed.指定标签过滤项的索引顺序参数格式不合法。
    400InvalidTagFilterKey.MalformedThe specified parameter tag filter key is invalid.过滤标签键不合法。
    400InvalidTagFilterValue.MalformedThe specified parameter tag filter value is invalid.过滤标签值不合法。
    400LimitExceeded.TagFilterKeyYou've reached the limit on the number of tag keys that you can filter.已达到单次可指定过滤标签键数量的上限。
    400LimitExceeded.TagFilterValueYou've reached the limit on the number of tag values that you can filter.已达到单次可指定过滤标签值数量的上限。
    400LimitExceeded.VpcIdYou've reached the limit on the number of VPC IDs that you can describe.已达到可查询的VPC ID数量上限。