You need to enable JavaScript to run this app.
导航

DescribeVpcAttributes

最近更新时间2024.01.10 10:41:27

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

调用 DescribeVpcAttributes 接口,查看指定VPC的详情。

调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionStringDescribeVpcAttributes要执行的操作。取值为DescribeVpcAttributes。
VersionString2020-04-01API版本信息,取值为:2020-04-01。

VpcId

String

vpc-bp1b1llp3ve5yze****

要查看的VPC的ID。
您可以调用 DescribeVpcs 接口,查询VPC的ID。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。
VpcIdStringvpc-bp1b1llp3ve5yze****VPC的ID。
StatusStringAvailableVPC的状态。
  • Creating:创建中
  • Pending:配置中
  • Available:可用
  • VpcNameStringvpc-1VPC的名称。
    CreationTimeString2021-07-27T14:44:00+08:00创建VPC的时间。
    UpdateTimeString2021-08-27T15:33:44+08:00更新VPC的时间。
    CidrBlockString10.XX.XX.0/24VPC的IPv4网段。
    Ipv6CidrBlockString2408:XXXX:0:a600::/56VPC的IPv6网段。
    DescriptionStringThis is my VPC.VPC的描述信息。
    SubnetIdsArray["subnet-bp1nhbnpv2blyz8dl****","subnet-kjrivdfkjgfw8sfvb****"]VPC中子网的列表。
    NatGatewayIdsArray["ngw-3tjx9odz8q3vj0x1****","ngw-3tjtu8hzu23vj0x1****"]VPC中创建的NAT网关的ID。
    AssociateCensArray of Struct-VPC关联的CEN信息。具体请参见下表“ AssociateCens结构 ”。
    RouteTableIdsArray["vtb-bp1krxxzp0c29fmon****","vtb-alferonxxcnzdfe3jd****"]VPC下创建的路由表的ID。
    SecurityGroupIdsArray["securitygroup178ftwt45bg****","securitygroup4838fsjfhsjf****"]VPC的安全组列表。
    DnsServersArray["100.96.0.2","100.96.0.3"]VPC的DNS服务器地址。
    AccountIdString21000****VPC所属账号的ID。
    SecondaryCidrBlocksArray["10.XX.XX.0/16", "10.XX.XX.1/16"]VPC的辅助网段。
    UserCidrBlocksArray["72.XX.XX.0/24", "96.XX.XX.0/24"]VPC的用户网段。
    NetworkAclNumInteger5VPC中的网络ACL的数量。
    ProjectNameStringdefaultVPC所属项目的名称。
    TagsArray of Struct-VPC的标签信息。具体请参见下表“Tag结构”。

    IsDefault

    Boolean

    false

    该VPC是否为默认VPC。

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

    AssociateCens结构

    参数名称
    类型
    示例值
    描述
    CenIdStringcen-23887d****CEN的ID。
    CenOwnerIdString12223****CEN的用户ID。
    CenStatusStringAttachedVPC在CEN中的状态。
  • Attaching:加载中
  • Attached:已加载
  • Tag结构

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

    请求示例

    GET /?Action=DescribeVpcAttributes&Version=2020-04-01&VpcId=vpc-bp1b1llp3ve5yze**** HTTP/1.1
    Host: open.volcengineapi.com
    Service: vpc
    Region: cn-beijing
    

    返回示例

    {
        "ResponseMetadata": {
            "RequestId": "2021062415303301022514515207C4****",
            "Action": "DescribeVpcAttributes",
            "Version": "2020-04-01",
            "Service": "vpc",
            "Region": "cn-beijing"
        },
        "Result": {
            "RequestId": "20210830115555****2524310006EC08C8",
            "VpcId": "vpc-bp1b1llp3ve5yze****",
            "VpcName": "test",
            "Description": "",
            "CreationTime": "2021-07-27T14:44:00+08:00",
            "UpdateTime": "2021-08-27T15:33:44+08:00",
            "CidrBlock": "10.XX.XX.0/24",
            "Ipv6CidrBlock": "2408:XXXX:0:a600::/56",
            "Status": "Available",
            "IsDefault": false,
            "SubnetIds": [
                "subnet-bp1nhbnpv2blyz8dl****",
                "subnet-kjrivdfkjgfw8sfvb****"
            ],
            "NatGatewayIds": [
                "ngw-3tjtu8hzu23vj0x1****"
            ],
            "AssociateCens":  [
                 {
                    "CenId": "cen-23af29****",
                    "CenOwnerId": "12230****",
                    "CenStatus": "Attached"
                 }
            ],
            "RouteTableIds": [
                "vtb-bp1krxxzp0c29fmon***",
                "vtb-alferonxxcnzdfe3jd****"
            ],
            "SecurityGroupIds": [
                "sg-2fenv63****345oxruwfsklo8"
            ],
            "DnsServers":  [
                "100.96.0.2",
                "100.96.0.2"
    .       ],
            "AccountId": "210000****",
            "NetworkAclNum": "5",
            "SecondaryCidrBlocks": [
                "172.XX.XX.0/12",
                "192.XX.XX.0/16"
            ],
            "UserCidrBlocks": [],
            "ProjectName": "default",
            "Tags": [ 
                { 
                    "Key": "k1", 
                    "Value": "v1" 
                }, 
                { 
                    "Key": "k2", 
                    "Value": "v2" 
                } 
            ]
        }    
    }
    

    错误码

    当前API无错误码,更多错误码请参见公共错误码