Liệt kê mạng

GET/v2.0/networks

Theo policy mặc định, chỉ các mạng thuộc project gửi request được trả về, trừ khi request được gửi bởi user admin. Ngoài ra, các mạng được chia sẻ với project gửi request cũng được trả về.

info

Nguồn: list-networks

Request

Tham số query

admin_state_upboolean

Lọc theo trạng thái quản trị: up (true) hoặc down (false).

idstring

Lọc theo ID mạng.

mtuinteger

Lọc theo MTU. Tối thiểu 68 (IPv4) hoặc 1280 (IPv6).

namestring

Lọc theo tên.

project_idstring

Lọc theo ID project sở hữu.

provider:network_typestring

Lọc theo loại mạng provider (ví dụ flat, vlan, vxlan, gre).

provider:physical_networkstring

Lọc theo mạng vật lý.

provider:segmentation_idinteger

Lọc theo ID segmentation của provider.

revision_numberinteger

Lọc theo revision number.

router:externalboolean

Lọc theo việc mạng có phải mạng external hay không.

sharedboolean

Lọc theo việc mạng có được chia sẻ hay không.

statusstring

Lọc theo trạng thái: ACTIVE, DOWN, BUILD, ERROR.

tenant_idstring

Lọc theo ID project sở hữu.

vlan_transparentboolean

Lọc theo chế độ VLAN transparent.

descriptionstring

Lọc theo mô tả.

is_defaultboolean

Lọc theo việc mạng có phải default pool hay không.

tagsstring

Danh sách phân tách bằng dấu phẩy; khớp các tài nguyên có tất cả tag.

tags-anystring

Danh sách phân tách bằng dấu phẩy; khớp các tài nguyên có bất kỳ tag nào.

not-tagsstring

Danh sách phân tách bằng dấu phẩy; loại trừ tài nguyên khớp tất cả tag.

not-tags-anystring

Danh sách phân tách bằng dấu phẩy; loại trừ tài nguyên khớp bất kỳ tag nào.

sort_dirstring

Hướng sắp xếp: asc hoặc desc. Có thể lặp lại cùng sort_key.

sort_keystring

Sắp xếp theo thuộc tính. Giá trị hợp lệ: admin_state_up, availability_zone_hints, id, mtu, name, status, tenant_id, project_id.

fieldsstring

Các field trả về. Có thể chỉ định nhiều lần (ví dụ fields=id&fields=name).

Request mẫu

Dùng curl

curl -ks -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: gAAAAA<...>' \
  https://api.vietnix.cloud:9696/v2.0/networks

HTTP request

GET https://api.vietnix.cloud:9696/v2.0/networks

Response

Tham số

networksarraybắt buộc

Danh sách object mạng.

admin_state_upbooleanbắt buộc

Trạng thái quản trị: up (true) hoặc down (false).

availability_zone_hintsarraybắt buộc

Các availability zone ứng viên. VHI hiện tại trả về giá trị mặc định hoặc null.

availability_zonesarraybắt buộc

Các availability zone. VHI hiện tại trả về giá trị mặc định hoặc null.

created_atstringbắt buộc

Thời điểm tạo (ISO 8601).

dns_domainstringbắt buộc

DNS domain.

idstringbắt buộc

ID mạng.

ipv4_address_scopestringbắt buộc

ID address scope IPv4.

ipv6_address_scopestringbắt buộc

ID address scope IPv6.

l2_adjacencybooleanbắt buộc

Mạng có khả năng kết nối L2 xuyên suốt hay không.

mtuintegerbắt buộc

Maximum transmission unit.

namestringbắt buộc

Tên dễ đọc.

port_security_enabledbooleanbắt buộc

Trạng thái port security (mặc định cho port mới).

project_idstringbắt buộc

ID project sở hữu.

provider:network_typestringbắt buộc

Loại mạng provider (ví dụ flat, vlan, vxlan, gre).

provider:physical_networkstringbắt buộc

Mạng vật lý.

provider:segmentation_idintegerbắt buộc

ID segmentation của provider.

qos_policy_idstringbắt buộc

ID policy QoS liên kết.

revision_numberintegerbắt buộc

Revision number.

router:externalbooleanbắt buộc

Mạng có phải mạng external hay không.

segmentsarraybắt buộc

Danh sách object segment của provider.

sharedbooleanbắt buộc

Mạng có được chia sẻ giữa các tenant hay không.

statusstringbắt buộc

Trạng thái mạng: ACTIVE, DOWN, BUILD, ERROR.

subnetsarraybắt buộc

ID các subnet liên kết.

tenant_idstringbắt buộc

ID project sở hữu.

updated_atstringbắt buộc

Thời điểm cập nhật gần nhất (ISO 8601) hoặc null.

vlan_transparentbooleanbắt buộc

Chế độ VLAN transparent.

default_vnic_typestringbắt buộc

vnic_type mặc định cho các port trong mạng này.

descriptionstringbắt buộc

Mô tả dễ đọc.

is_defaultbooleanbắt buộc

Mạng có phải default pool hay không.

tagsarraybắt buộc

Danh sách tag của tài nguyên.

Response mẫu

Response body

{
    "networks": [
        {
            "id": "4cda9d1d-a3a6-40cb-a276-682bc4f4d774",
            "name": "test03",
            "tenant_id": "f33507157a634f1cac71e06a70fb558e",
            "admin_state_up": true,
            "mtu": 8913,
            "default_vnic_type": null,
            "status": "ACTIVE",
            "subnets": [
                "1d4cbc73-1a4e-4b37-86f8-ab09cec02e87"
            ],
            "shared": false,
            "availability_zone_hints": [],
            "availability_zones": [
                "nova"
            ],
            "ipv4_address_scope": null,
            "ipv6_address_scope": null,
            "router:external": false,
            "description": "",
            "port_security_enabled": true,
            "rbac_policies": [],
            "qos_policy_id": "dfc42ced-02c8-4b1f-bbe6-14cc014f259d",
            "tags": [],
            "created_at": "2025-09-17T02:48:19Z",
            "updated_at": "2025-09-17T02:48:19Z",
            "revision_number": 2,
            "project_id": "f33507157a634f1cac71e06a70fb558e",
            "provider:network_type": "vxlan"
        },
        {
            "id": "568e8929-249c-4e5c-afb5-ff72914ac3ca",
            "name": "test02",
            "tenant_id": "f33507157a634f1cac71e06a70fb558e",
            "admin_state_up": true,
            "mtu": 8913,
            "default_vnic_type": null,
            "status": "ACTIVE",
            "subnets": [
                "a83b46c4-0489-49fa-a037-487d761ff107"
            ],
            "shared": false,
            "availability_zone_hints": [],
            "availability_zones": [
                "nova"
            ],
            "ipv4_address_scope": null,
            "ipv6_address_scope": null,
            "router:external": false,
            "description": "",
            "port_security_enabled": true,
            "rbac_policies": [],
            "qos_policy_id": "dfc42ced-02c8-4b1f-bbe6-14cc014f259d",
            "tags": [],
            "created_at": "2025-09-17T02:53:25Z",
            "updated_at": "2025-09-17T02:53:25Z",
            "revision_number": 2,
            "project_id": "f33507157a634f1cac71e06a70fb558e",
            "provider:network_type": "vxlan"
        },
        {
            "id": "79cab11a-122d-43a7-9427-3575d9512413",
            "name": "FLOATING_45_115_16_0_24_VLAN102",
            "tenant_id": "a430f930af8e47d7a1820a477129c343",
            "admin_state_up": true,
            "mtu": 1500,
            "default_vnic_type": null,
            "status": "ACTIVE",
            "subnets": [
                "18847364-07d0-48c8-a175-6dc839ae737e",
                "54ca4e27-7dfd-4504-a36b-8c47527f7a23"
            ],
            "shared": false,
            "availability_zone_hints": [],
            "availability_zones": [
                "nova"
            ],
            "ipv4_address_scope": null,
            "ipv6_address_scope": null,
            "router:external": true,
            "description": "",
            "port_security_enabled": true,
            "rbac_policies": [
                {
                    "id": "ff6ed553-4bdc-4ac6-9e7e-230e71cbcaf7",
                    "action": "access_as_external",
                    "target_tenant": "*"
                }
            ],
            "qos_policy_id": null,
            "is_default": false,
            "tags": [],
            "created_at": "2025-08-25T05:51:46Z",
            "updated_at": "2025-09-04T06:23:26Z",
            "revision_number": 7,
            "project_id": "a430f930af8e47d7a1820a477129c343",
            "provider:network_type": "vlan"
        },
        {
            "id": "8ae2b710-ad3d-469e-a75a-c3e203887d2e",
            "name": "test01",
            "tenant_id": "f33507157a634f1cac71e06a70fb558e",
            "admin_state_up": true,
            "mtu": 8913,
            "default_vnic_type": null,
            "status": "ACTIVE",
            "subnets": [
                "7e35a1a1-ffcd-48a4-82c2-39836d2add00"
            ],
            "shared": false,
            "availability_zone_hints": [],
            "availability_zones": [
                "nova"
            ],
            "ipv4_address_scope": null,
            "ipv6_address_scope": null,
            "router:external": false,
            "description": "",
            "port_security_enabled": true,
            "rbac_policies": [],
            "qos_policy_id": "dfc42ced-02c8-4b1f-bbe6-14cc014f259d",
            "tags": [],
            "created_at": "2025-09-17T02:52:19Z",
            "updated_at": "2025-09-17T02:52:19Z",
            "revision_number": 2,
            "project_id": "f33507157a634f1cac71e06a70fb558e",
            "provider:network_type": "vxlan"
        }
    ]
}

Mã trạng thái

Thành công

Mã	Mô tả
200 - OK	Request thành công.

Lỗi

Mã	Mô tả
401 - Unauthorized	Cần xác thực trước khi gửi request.
403 - Forbidden	Policy không cho phép user hiện tại thực hiện thao tác này.

Request​

Tham số query​

Request mẫu​

Dùng curl​

HTTP request​

Response​

Tham số​

Response mẫu​

Mã trạng thái​

Thành công​

Lỗi​