Querying Virtual Subnets

project_id

Yes

String

Definition:

ID of the project that the subnet belongs to. For details about how to obtain a project ID, see Obtaining a Project ID.

Range:

N/A

limit

No

Integer

Definition:

Number of resources on each page.

Range:

0 to 2000

marker

No

String

Definition:

Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

Range:

Subnet ID.

id

No

Array of strings

Definition:

ID of the subnet, which can be used to filter the subnet. Multiple IDs can be specified for filtering.

Range:

N/A

name

No

Array of strings

Definition:

Subnet name, which can be used to filter the subnet. Multiple names can be specified for filtering.

Range:

N/A

vpc_id

No

Array of strings

Definition:

ID of the VPC that the subnet belongs to, which can be used to filter the subnet. Multiple IDs can be specified for filtering.

Range:

N/A

status

No

String

Definition:

Subnet status, which can be used to filter the subnet. Only one status can be specified for filtering.

Range:

• ACTIVE: The subnet has been associated with a VPC.

• UNKNOWN: The subnet has not been associated with a VPC.

• ERROR: The subnet is abnormal.

scope

No

Array of strings

Definition:

Scope of the subnet. If this parameter is specified, the subnet can be filtered by scope. Multiple scopes can be specified for filtering.

Range:

• center: The subnet is in a central AZ.

• {publicBorderGroup}: The subnet is in a public border group. The public border group limits the AZs of a subnet but it can have multiple edge AZs associated.

zone_id

No

Array of strings

Definition:

AZ ID of the subnet. If this parameter is specified, the subnet can be filtered by AZ ID. Multiple AZ IDs can be specified for filtering.

Range:

N/A

description

No

Array of strings

Definition:

Description of the subnet, which can be used to filter the subnet. Multiple descriptions can be specified for filtering.

Range:

N/A

request_id

String

Definition:

Request ID.

Range:

N/A.

virsubnets

Array of Virsubnet objects

Definition:

Response body for querying the subnets.

Range:

N/A.

page_info

PageInfo object

Definition:

Pagination information.

Range:

N/A.

id

String

Definition:

Subnet ID. After a subnet is created, a subnet ID is generated, which uniquely identifies the subnet.

Range:

The value is in UUID format with hyphens (-).

name

String

Definition:

Subnet name.

Range:

The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

description

String

Definition:

Supplementary information about a subnet.

Range:

The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).

dns_nameservers

Array of strings

Definition:

DNS server addresses of a subnet.

Range:

N/A.

zone_id

String

Definition:

ID of the AZ that the subnet belongs to.

Range:

N/A

vpc_id

String

Definition:

ID of the VPC that the subnet belongs to.

Range:

N/A

status

String

Definition:

Subnet status.

Range:

• ACTIVE: The subnet has been associated with a VPC.

• UNKNOWN: The subnet has not been associated with a VPC.

• ERROR: The subnet is abnormal.

project_id

String

Definition:

ID of the project that the subnet belongs to.

Range:

N/A

scope

String

Definition:

Scope of the subnet (edge cloud scenario).

Range:

• center: The subnet is in a central AZ.

• {publicBorderGroup}: The subnet is in a public border group. The public border group limits the AZs of a subnet but it can have multiple edge AZs associated.

subnet_cidrs

Array of SubnetCidr objects

Definition:

OpenStack Neutron subnet information.

Range:

N/A

tags

Array of ResponseTag objects

Definition:

Tags of a subnet, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects.

Range:

N/A

extra_dhcp_opts

Array of SubnetExtraDhcpOpt objects

Definition:

DHCP attributes of a subnet. You can configure the NTP address, DNS domain name, or lease expiration time.

Range:

N/A.

created_at

String

Definition:

Time when a subnet was created.

Range:

The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss.

updated_at

String

Definition:

Time when a subnet was updated.

Range:

The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss.

id

String

Definition:

ID of the OpenStack Neutron subnet.

Range:

The value is in UUID format with hyphens (-).

ip_version

String

Definition:

IP address version of the OpenStack Neutron subnet.

Range:

• 4: IPv4 subnet.

• 6: IPv6 subnet.

cidr

String

Definition:

IP address range of the OpenStack Neutron subnet.

Range:

The value is in CIDR format, for example, 192.168.23.0/24 for IPv4 and 2420:2023:410:d5d::/64 for IPv6.

gateway_ip

String

Definition:

Gateway IP address of the OpenStack Neutron subnet.

Range:

N/A

enable_dhcp

Boolean

Definition:

Whether the DHCP function is enabled for the OpenStack Neutron subnet.

Range:

• true: The DHCP function is enabled.

• false: The DHCP function is disabled.

key

String

Definition:

Tag key.

Range:

• A tag key can contain a maximum of 128 Unicode characters and cannot be left blank.

• Each tag key of a resource must be unique.

• The value can contain:

  • Letters

  • Digits

  • Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=)

  • Chinese characters

value

String

Definition:

Tag value.

Range:

• Each value can contain a maximum of 255 Unicode characters and can be left blank.

• The value can contain:

  • Letters

  • Digits

  • Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=)

  • Chinese characters

opt_name

String

Definition:

Name of the NTP server address, domain name, or DHCP lease expiration time configured for the subnet.

Range:

• 42: NTP server address of the subnet.

• 15: DNS domain name, which is used to obtain the IP address from the DNS server.

• 51: DHCP lease expiration time of the IPv4 subnet.

• 651: DHCP lease expiration time of the IPv6 subnet.

opt_value

String

Definition:

NTP server address, domain name, or DHCP lease expiration time configured for the subnet.

Range:

• If opt_name is set to 42, the value indicates the NTP server address configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,).

• If opt_name is set to 15, the value is the DNS domain name and is used to obtain the IP address from the DNS server. A domain name can contain only letters, digits, and hyphens (-) and cannot start or end with a hyphen (-). A domain name can contain multiple character strings separated by periods (.). Each character string can contain up to 63 characters. The total length of a domain name cannot exceed 254 characters.

• The option 51 for opt_name indicates the DHCP lease expiration time of the IPv4 subnet. The value can be -1, which indicates unlimited lease time, or Numberh. The number ranges from 1 to 175200. For example, the value can be 5h. The default value is 87600h.

• The option 651 for opt_name indicates the DHCP lease expiration time of the IPv6 subnet. The value can be -1, which indicates unlimited lease time, or Numberh. The number ranges from 1 to 175200. For example, the value can be 5h. The default value is 2h.

ip_version

Integer

Definition:

IP address version of a subnet.

Range:

• 4: IPv4 (default value)

• 6: IPv6 (only when opt_name is 651)

previous_marker

String

Definition:

The first record on the current page.

Range:

N/A

current_count

Integer

Definition:

Total number of resources on the current page.

Range:

N/A

next_marker

String

Definition:

The last record on the current page. The next_marker field does not exist if the page is the last one.

Range:

N/A

200

The GET operation is successful. For more status codes, see Status Codes.