文档首页/ 智能边缘云 IEC/ API参考/ API/ 子网/ 查询子网详情
更新时间：2024-01-02 GMT+08:00
查看PDF
分享

查询子网详情

功能介绍

根据子网的ID，获取子网的详细信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/subnets/{subnet_id}

表1 路径参数

参数

是否必选

参数类型

描述

subnet_id

是

String

子网ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

subnet

Subnet object

子网字典对象。
表4 Subnet

参数

参数类型

描述

id

String

子网的ID。

name

String

子网名称

取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

cidr

String

子网的网段

取值范围：必须在vpc对应cidr范围内

约束：必须是cidr格式。掩码长度不能大于28

dnsList

Array of strings

子网dns服务器地址列表

gateway_ip

String

子网的网关

取值范围：子网网段中的IP地址

约束：必须是ip格式

dhcp_enable

Boolean

子网是否开启dhcp功能

primary_dns

String

子网dns服务器地址1

secondary_dns

String

子网dns服务器地址2

status

String

子网的状态

取值范围：

  • ACTIVE：表示子网已挂载到ROUTER上

  • UNKNOWN：表示子网还未挂载到ROUTER上

  • ERROR：表示子网状态故障

vpc_id

String

虚拟私有云ID。

site_id

String

子网所属的站点ID。

site_info

String

子网所属的站点信息。

neutron_network_id

String

对应网络（OpenStack Neutron接口） id。

neutron_subnet_id

String

对应子网（OpenStack Neutron接口） id。

cidr_v6

String

IPv6子网的网段，如果子网为IPv4子网，则不返回此参数

ipv6_enable

Boolean

是否是IPv6子网

取值范围：true，false

pool_id

String

IPv6线路ID，如果子网为IPv4子网，则不返回此参数。

neutron_subnet_id_v6

String

对应IPv6子网（OpenStack Neutron接口）id，如果子网为IPv4子网，则不返回此参数。

gateway_ip_v6

String

IPv6子网的网关，如果子网为IPv4子网，则不返回此参数。

请求示例

GET https://{{endpoint}}/v1/subnets/a5ac27e5-d69e-44be-809f-1393438046ce

响应示例

状态码： 200

OK

{
  "subnet" : {
    "id" : "a5ac27e5-d69e-44be-809f-1393438046ce",
    "name" : "subnet-kcps",
    "vpc_id" : "1016972d-357e-4a2a-912b-cf2ab9673790",
    "cidr" : "10.0.0.0/24",
    "gateway_ip" : "10.0.0.1",
    "dhcp_enable" : true,
    "primary_dns" : "114.114.114.114",
    "secondary_dns" : "8.8.8.8",
    "dnsList" : [ "114.114.114.114", "8.8.8.8" ],
    "status" : "ACTIVE",
    "site_id" : "705da43d-fa20-11ea-9fb2-fa1640495574",
    "site_info" : "China/华中地区/湖南/长沙市",
    "neutron_network_id" : "a5ac27e5-d69e-44be-809f-1393438046ce",
    "neutron_subnet_id" : "d2bc9af1-bbee-4fb0-8d0e-fe07339fab7a"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 子网

相关文档