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

DescribeSubnetAttributes

最近更新时间：2024.04.22 19:00:39

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

我的收藏

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

调试

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

请求参数

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

SubnetId

String

是

subnet-23dscddcffvf3****

子网的ID。
您可以调用 DescribeSubnets 接口，查询子网的ID。

返回数据

参数名称
类型
示例值
描述
AccountIdString210000****当前所属账号的ID。
RequestIdString2021062415303301022514515207C4****请求ID。
SubnetIdStringsubnet-25bcdxs7pv1****子网的ID。
VpcIdStringvpc-257gcdcdq64****子网所属VPC的ID。
StatusStringAvailable当前子网的状态。
  • Pending：表示配置中。
  • Available：表示可用。
    • CidrBlockString172.XX.XX.0/24子网的IPv4网段。

    Ipv6CidrBlock

    String

    2408:XXXX:0:a600::/64

    子网的IPv6网段。

    说明

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

    ZoneIdStringcn-beijing-a子网所属的可用区。
    AvailableIpAddressCountInteger1子网中可用的IP地址数量。
    DescriptionStringDescription子网的描述信息。
    SubnetNameStringsubnet-1子网的名称。
    CreationTimeString2018-01-18T12:43:57+08:00子网的创建时间
    RouteTableStruct-路由表信息。具体请参见下表“RouteTable结构”。
    UpdateTimeString2021-01-11T10:23:57+08:00子网的更新时间。
    TotalIpv4CountInteger253子网下可用IP总数。
    NetworkAclIdStringacl-bp1fg655nh68xyz9****子网关联的网络ACL的ID。
    ProjectNameStringdefault当前子网所属项目的名称。
    TagsArray of Struct-子网的标签信息。具体请参见下表“Tag结构”。

    IsDefault

    Boolean

    false

    该子网是否为默认子网。

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

    RouteTable结构

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

    • Tag结构

    参数名称
    类型
    示例值
    描述
    KeyStringk1用户标签的标签键。
    ValueStringv1用户标签的标签值。

    请求示例

    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
    错误码
    错误信息
    描述
    404InvalidSubnet.NotFoundThe specified subnet does not exist.指定的子网不存在。