• Virtual Private Cloud

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

Network API Overview

Object Introduction

This interface is used to manage and perform operations on network resources, including querying networks, creating a network, querying a specified network, deleting a network, and updating a network.

Object Model

Table 1 network object

Attribute

Mandatory

Type

CRUD

Default Value

Constraint

Description

status

No

String

R

ACTIVE

N/A

Specifies the network status. The value can be ACTIVE, BUILD, DOWN, or ERROR.

subnets

No

List(Uuid-str)

R

Empty list

N/A

Specifies IDs of the subnets associated with this network. The IDs are in a list.

Only one subnet can be associated with each network.

name

No

String(255)

CRU

None

N/A

Specifies the network name.

The name cannot be admin_external_net.

router:external

No

Bool

R

false

The value can only be true or false.

Specifies whether the network is an external network. This is an extended attribute.

admin_state_up

No

Bool

CRU

true

The value can only be true or false.

Specifies the administrative status.

The value can only be true.

tenant_id

No

String(255)

R

N/A

N/A

Specifies the project ID.

shared

No

Bool

R

false

The value can only be true or false.

Specifies whether the network can be shared by different tenants.

id

Yes

Uuid-str

R

Automatically generated

N/A

Specifies the network ID.

This parameter is not mandatory when you query networks.

provider:network_type

No

String(32)

CR

N/A

N/A

Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute.

By default, VXLAN networks are created. To create GENEVE networks, set the parameter value to geneve.

availability_zone_hints

No

List<String>

R

N/A

N/A

Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling.

availability_zones

No

List<String>

R

N/A

N/A

Specifies the availability zone of this network.

port_security_enabled

No

Bool

CRU

true

N/A

Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect.

dns_domain

No

String(255)

R

Automatically generated

N/A

Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value.

project_id

No

String(64)

R

N/A

N/A

Specifies the project ID of a resource.

created_at

No

String(64)

R

Automatically generated

N/A

Specifies the time when the resource was created.

updated_at

No

String(64)

R

Automatically generated

N/A

Specifies the time when the resource was updated.