Querying a Subnet Pool¶
Function¶
This API is used to query details about the specific subnet pool.
URI¶
GET /v2.0/subnetpools/{subnetpool_id}
Request Message¶
None
Response Message¶
Parameter | Type | Description |
|---|---|---|
subnetpool | subnetpool object | Specifies the subnet pool list. For details, see Table 2. |
Attribute | Type | Description |
|---|---|---|
id | String | Specifies the subnet pool ID. This parameter is not mandatory when you query subnet pools. |
name | String | Specifies the subnet pool name. |
ip_version | Integer | Specifies the IP address version. The value can be 4 (IPv4) or 6 (IPv6). |
default_quota | Integer | Specifies the upper limit of the prefix space that can be allocated from the subnet pool to the subnet. For IPv4 subnet pools, default_quota is measured in units of /32. For IPv6 subnet pools, default_quota is measured in units of /64. |
project_id | String | Specifies the project ID. |
created_at | String | Specifies the time (UTC) when the subnet pool is created. Format: yyyy-MM-ddTHH:mm:ss |
updated_at | String | Specifies the time (UTC) when the subnet pool rule is updated. Format: yyyy-MM-ddTHH:mm:ss |
prefixes | Array of strings | Specifies a list of subnet prefixes that are assigned to the subnet pool. The adjacent prefixes are merged and treated as a single prefix. Each subnet prefix must be unique. |
min_prefixlen | Integer | Specifies the minimum number for the prefix of a subnet that can be allocated from the subnet pool. The minimum number for the prefix of an IPv4 subnet is 8, and that of an IPv6 subnet is 64. |
address_scope_id | String | Specifies the ID of the address range allocated to the subnet pool. Only the administrator can specify this attribute. |
shared | Boolean | Specifies whether the network can be shared to all projects. |
tenant_id | String | Specifies the project ID. |
default_prefixlen | Integer | Specifies the default prefix to be allocated to a subnet if the cidr or prefixlen is not specified when you create the subnet. The default value is 8 for an IPv4 subnet and 64 for an IPv6 subnet. |
max_prefixlen | Integer | Specifies the maximum number for the prefix of a subnet that can be allocated from the subnet pool. The maximum number for the prefix of an IPv4 subnet is 32, and that of an IPv6 subnet is 128. |
description | String | Provides supplementary information about the subnet pool. |
is_default | Boolean | Specifies whether this is the default subnet pool. |
tags | Array of strings | Specifies the tags. |
Example:¶
Example request
GET https://{Endpoint}/v2.0/subnetpools/03f761e6-eee0-43fc-a921-8acf64c14988
Response¶
Example response
{
"subnetpool": {
"min_prefixlen": 64,
"address_scope_id": null,
"default_prefixlen": 64,
"id": "03f761e6-eee0-43fc-a921-8acf64c14988",
"max_prefixlen": 64,
"name": "my-subnet-pool",
"default_quota": null,
"is_default": false,
"project_id": "9fadcee8aa7c40cdb2114fff7d569c08",
"tenant_id": "9fadcee8aa7c40cdb2114fff7d569c08",
"created_at": "2016-03-08T20:19:41",
"prefixes": [
"2001:db8:0:2::/64",
"2001:db8::/63"
],
"updated_at": "2016-03-08T20:19:41",
"ip_version": 6,
"shared": false,
"description": "",
"tags": []
}
}
Status Code¶
See Status Codes.
Error Code¶
See Error Codes.