• Virtual Private Cloud

vpc
  1. Help Center
  2. Virtual Private Cloud
  3. API Reference
  4. OpenStack Neutron APIs
  5. Subnet Pool
  6. Subnet Pool API Overview

Subnet Pool API Overview

Object Introduction

This interface is used to manage and perform operations on subnet pools, including querying subnet pools, creating a subnet pool, querying a specified subnet pool, deleting a subnet pool, and updating a subnet pool.

Object Model

Table 1 subnetpool object

Attribute

Mandatory

Type

CRUD

Default Value

Constraint

Description

id

Yes

Uuid-str

R

Automatically generated

N/A

Specifies the subnet pool ID.

This parameter is not mandatory when you query subnet pools.

name

No

String(255)

CRU

None

N/A

Specifies the subnet pool name.

ip_version

No

Int

R

4

The value can only be 4 or 6.

Specifies the Internet Protocol (IP) version.

Instructions:

Only IPv4 is supported.

default_quota

No

Int

CRU

The default value is null. There is no upper limit.

N/A

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

No

String(64)

CRU

N/A

N/A

Specifies the project ID of a resource.

created_at

No

String(64)

CRU

Automatically generated

N/A

Specifies the time when the resource was created.

updated_at

No

String(64)

CRU

Automatically generated

N/A

Specifies the time when the resource was updated.

prefixes

No

list

CRUD

Subnet pool prefix

N/A

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

No

Int

CRU

For IPv4, the default value is 8. For IPv6, the default value is 64.

Minimum prefix that can be allocated

min_prefixlen =< default_prefixlen =< max_prefixlen

Specifies the minimum prefix that can be allocated from the subnet pool.

address_scope_id

No

String(64)

CRU

None

The ID of the address scope associated with the subnet pool

Specifies the ID of the address scope associated with the subnet pool.

Instructions:

Only the administrator can specify this attribute.

shared

No

Bool

R

False

Whether the network can be shared with all projects

Specifies whether the network can be shared to all projects.

tenant_id

No

String(255)

R

Specifies the project ID.

N/A

Specifies the project ID.

default_prefixlen

No

Int

CRU

min_prefixlen

min_prefixlen =< default_prefixlen =< max_prefixlen

Specifies the length of the prefix to allocate when the CIDR or prefixlen attributes are omitted when creating a subnet.

max_prefixlen

No

Int

CRU

For IPv4, the default value is 32. For IPv6, the default value is 128.

min_prefixlen =< default_prefixlen =< max_prefixlen

Specifies the maximum prefix length that can be allocated from the subnet pool.

description

No

String(255)

CRU

None

N/A

Specifies the subnet pool description.

is_default

No

Bool

CRU

True

N/A

Specifies whether this is the default subnet pool.

revision_number

No

Int

CR

None

N/A

Specifies the revision number of the subnet pool.