DescribeSubnetAttributes--私有网络-火山引擎

文档中心

立即注册

导航

DescribeSubnetAttributes

最近更新时间：2024.08.07 15:42:33首次发布时间：2021.07.29 14:11:53

调用 DescribeSubnetAttributes 接口，查看指定子网的详细信息。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSubnetAttributes	要执行的操作。取值：DescribeSubnetAttributes。
Version	String	是	2020-04-01	API版本信息，取值为：2020-04-01。
SubnetId	String	是	subnet-23dscddcffvf3****	子网的ID。您可以调用 DescribeSubnets 接口，查询子网的ID。

返回数据

参数名称	类型	示例值	描述
AccountId	String	210000****	当前所属账号的ID。
RequestId	String	2021062415303301022514515207C4****	请求ID。
SubnetId	String	subnet-25bcdxs7pv1****	子网的ID。
VpcId	String	vpc-257gcdcdq64****	子网所属VPC的ID。
Status	String	Available	当前子网的状态。 Pending：表示配置中。 Available：表示可用。
CidrBlock	String	172.XX.XX.0/24	子网的IPv4网段。
Ipv6CidrBlock	String	2408:XXXX:0:a600::/64	子网的IPv6网段。说明 IPv6功能正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。
ZoneId	String	cn-beijing-a	子网所属的可用区。
AvailableIpAddressCount	Integer	1	子网中可用的IP地址数量。
Description	String	Description	子网的描述信息。
SubnetName	String	subnet-1	子网的名称。
CreationTime	String	2018-01-18T12:43:57+08:00	子网的创建时间
RouteTable	Struct	-	路由表信息。具体请参见下表“RouteTable结构”。
UpdateTime	String	2021-01-11T10:23:57+08:00	子网的更新时间。
TotalIpv4Count	Integer	253	子网下可用IP总数。
NetworkAclId	String	acl-bp1fg655nh68xyz9****	子网关联的网络ACL的ID。
ProjectName	String	default	当前子网所属项目的名称。
Tags	Array of Struct	-	子网的标签信息。具体请参见下表“Tag结构”。
IsDefault	Boolean	false	该子网是否为默认子网。 true：默认子网，表示该子网是创建ECS实例时系统自动创建的子网。 false：非默认子网，表示该子网是用户手动创建的。

RouteTable结构

参数名称	类型	示例值	描述
RouteTableId	String	vrt-bp145q7glnuzdv****	子网关联的路由表ID。
RouteTableType	String	System	子网关联的路由表的类型。 System：表示系统路由表。 Custom：表示自定义路由表。

Tag结构

参数名称	类型	示例值	描述
Key	String	k1	用户标签的标签键。
Value	String	v1	用户标签的标签值。

请求示例

GET /?Action=DescribeSubnetAttributes&Version=2020-04-01&SubnetId=subnet-23dscddcffvf3**** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeSubnetAttributes",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
   "Result": {
        "AccountId": "200000****",
        "RequestId": "2021062415303301022514515207C4****",
        "SubnetId": "subnet-1g0esbs70pfr48ibuxwpu****",
        "SubnetName": "subnet-1g0esbs70pfr48ibuxwpu****",
        "VpcId": "vpc-2ff3bpyczwc1s5oxruwe8****",
        "ZoneId": "cn-beijing-a",
        "CidrBlock": "172.XX.XX.16/24",
        "Ipv6CidrBlock": "2408:XXXX:0:a600::/56",
        "AvailableIpAddressCount": 1,
        "Description": "test",
        "TotalIpv4Count": 253,
        "CreationTime": "2021-01-23T16:32:45+08:00",
        "UpdateTime": "2021-03-18T13:43:57+08:00",
        "ProjectName": "default",
        "Tags": [
            {
                "Key": "k1",
                "Value": "v1"
            },
            {
                "Key": "k2",
                "Value": "v2"
            }
        ],
        "RouteTable": {
            "RouteTableId": "vtb-2ff3bq0c10e0w5oxruvx6****",
            "RouteTableType": "System"
        },
        "NetworkAclId": "acl-bp1fg655nh68xyz9****",
        "IsDefault": false,
        "Status": "Available"
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
404	InvalidSubnet.NotFound	The specified subnet does not exist.	指定的子网不存在。