Chuyển tới nội dung chính

Liệt kê virtual router

GET/v2.0/routers

Liệt kê các virtual router mà project gửi request có thể truy cập.

Theo policy mặc định, chỉ các router thuộc project gửi request được trả về, trừ khi request được gửi bởi user admin.

Request​

Tham số​

idstring

Lọc kết quả theo ID của router.

tenant_idstring

Lọc kết quả theo ID của project sở hữu tài nguyên.

project_idstring

Lọc kết quả theo ID của project sở hữu tài nguyên.

namestring

Lọc kết quả theo tên dễ đọc của tài nguyên.

descriptionstring

Lọc kết quả theo mô tả dễ đọc của tài nguyên.

admin_state_upboolean

Lọc kết quả theo trạng thái quản trị của tài nguyên: up (true) hoặc down (false).

revision_numberinteger

Lọc kết quả theo revision number của tài nguyên.

sort_dirstring

Hướng sắp xếp. Giá trị hợp lệ là asc (tăng dần) hoặc desc (giảm dần). Bạn có thể chỉ định nhiều cặp tham số query sort key và sort direction.

sort_keystring

Sắp xếp theo một thuộc tính của router. Bạn có thể chỉ định nhiều cặp tham số query sort key và sort direction. Các sort key được giới hạn ở: admin_state_up, flavor_id, id, name, status, tenant_id, project_id

tagsstring

Danh sách tag để lọc kết quả. Các tài nguyên khớp tất cả tag trong danh sách sẽ được trả về. Các tag trong query phải phân tách bằng dấu phẩy.

tags-anystring

Danh sách tag để lọc kết quả. Các tài nguyên khớp bất kỳ tag nào trong danh sách sẽ được trả về. Các tag trong query phải phân tách bằng dấu phẩy.

not-tagsstring

Danh sách tag để lọc kết quả. Các tài nguyên khớp tất cả tag trong danh sách sẽ bị loại trừ. Các tag trong query phải phân tách bằng dấu phẩy.

not-tags-anystring

Danh sách tag để lọc kết quả. Các tài nguyên khớp bất kỳ tag nào trong danh sách sẽ bị loại trừ. Các tag trong query phải phân tách bằng dấu phẩy.

fieldsstring

Các field bạn muốn server trả về. Nếu không chỉ định tham số query fields, API networking trả về tất cả thuộc tính được policy cho phép. Khi dùng tham số fields, API chỉ trả về tập thuộc tính được yêu cầu. Tham số fields có thể được chỉ định nhiều lần. Ví dụ, nếu bạn chỉ định fields=id&fields=name trong URL request, chỉ thuộc tính id và name được trả về.

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/routers

HTTP request​

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

Response​

Tham số response​

routersarraybắt buộc

Danh sách object router.

idstringbắt buộc

ID của router.

tenant_idstringbắt buộc

ID của project.

project_idstringbắt buộc

ID của project.

namestringbắt buộc

Tên dễ đọc của tài nguyên.

descriptionstringbắt buộc

Mô tả dễ đọc của tài nguyên.

admin_state_upbooleanbắt buộc

Trạng thái quản trị của tài nguyên: up (true) hoặc down (false).

statusstringbắt buộc

Trạng thái router.

external_gateway_infoobjectbắt buộc

Thông tin external gateway của router. Nếu router có external gateway, đây là dictionary gồm network_id, enable_snat và external_fixed_ips. Ngược lại là null.

network_idstringbắt buộc

ID mạng mà gateway của router kết nối tới.

enable_snatbooleanbắt buộc

Thuộc tính Enable Source NAT (SNAT). true nghĩa là Network Address Translation (NAT) được bật cho lưu lượng do các subnet gắn với router tạo ra khi gửi đến/nhận từ mạng external. false nghĩa là không áp dụng NAT cho lưu lượng đến/từ mạng external. Có hiệu lực khi extension ext-gw-mode được bật.

external_fixed_ipsarraybắt buộc

Địa chỉ IP của external gateway của router. Là danh sách địa chỉ IP. Mỗi phần tử là dictionary gồm ip_address và subnet_id.

revision_numberintegerbắt buộc

Revision number của tài nguyên.

routesarraybắt buộc

Cấu hình extra route cho L3 router. Danh sách dictionary gồm tham số destination và nexthop. Có hiệu lực khi extension extraroute được bật.

destinationstringbắt buộc

CIDR đích.

nexthopstringbắt buộc

Địa chỉ IP của next hop tương ứng với destination. Địa chỉ IP next hop phải thuộc một trong các subnet mà interface của router kết nối tới.

distributedbooleanbắt buộc

true biểu thị router phân tán. Có hiệu lực khi extension dvr được bật.

habooleanbắt buộc

true biểu thị router highly-available. Có hiệu lực khi extension l3-ha được bật.

availability_zone_hintsarraybắt buộc

Các availability zone ứng viên cho router. Có hiệu lực khi extension router_availability_zone được bật. Phiên bản Virtuozzo Hybrid Infrastructure hiện tại không hỗ trợ availability zone. Response trả về availability zone mặc định hoặc null.

availability_zonesarraybắt buộc

Các availability zone cho router. Có hiệu lực khi extension router_availability_zone được bật. Phiên bản Virtuozzo Hybrid Infrastructure hiện tại không hỗ trợ availability zone. Response trả về availability zone mặc định hoặc null.

service_type_idstringbắt buộc

ID của service type liên kết với router.

flavor_idstringbắt buộc

ID của flavor liên kết với router.

created_atstringbắt buộc

Ngày giờ tạo tài nguyên. Định dạng timestamp ISO 8601: CCYY-MM-DDThh:mm±hh. Ví dụ: 2015-08-27T09:49:58-05:00. Giá trị ±hh, nếu có, là múi giờ so với UTC. Trong ví dụ này, offset là -05:00.

updated_atstringbắt buộc

Ngày giờ cập nhật tài nguyên. Nếu tài nguyên chưa được cập nhật, field này là null. Định dạng timestamp ISO 8601: CCYY-MM-DDThh:mm±hh. Ví dụ: 2015-08-27T09:49:58-05:00. Giá trị ±hh, nếu có, là múi giờ so với UTC. Trong ví dụ này, offset là -05:00.

tagsarraybắt buộc

Danh sách tag trên router.

conntrack_helpersarraybắt buộc

Các tài nguyên conntrack helper liên kết với router. Nếu router có nhiều tài nguyên conntrack helper, field này có nhiều phần tử. Mỗi phần tử gồm netfilter conntrack helper (helper), giao thức mạng (protocol), port mạng (port).

Response mẫu​

Response body
{
    "routers": [
        {
            "id": "66fa6a3b-4b3a-485f-819d-c671765eb915",
            "name": "R1",
            "tenant_id": "f33507157a634f1cac71e06a70fb558e",
            "admin_state_up": true,
            "status": "ACTIVE",
            "external_gateway_info": {
                "network_id": "79cab11a-122d-43a7-9427-3575d9512413",
                "external_fixed_ips": [
                    {
                        "subnet_id": "54ca4e27-7dfd-4504-a36b-8c47527f7a23",
                        "ip_address": "45.115.16.196"
                    }
                ],
                "enable_snat": true
            },
            "description": "",
            "availability_zones": [
                "nova"
            ],
            "availability_zone_hints": [],
            "routes": [],
            "flavor_id": null,
            "tags": [],
            "created_at": "2025-09-23T16:01:29Z",
            "updated_at": "2025-09-23T16:01:34Z",
            "revision_number": 11,
            "project_id": "f33507157a634f1cac71e06a70fb558e"
        },
        {
            "id": "7a5730df-f3e4-4054-8ea0-caa9eab08b61",
            "name": "R3",
            "tenant_id": "f33507157a634f1cac71e06a70fb558e",
            "admin_state_up": true,
            "status": "ACTIVE",
            "external_gateway_info": {
                "network_id": "79cab11a-122d-43a7-9427-3575d9512413",
                "external_fixed_ips": [
                    {
                        "subnet_id": "54ca4e27-7dfd-4504-a36b-8c47527f7a23",
                        "ip_address": "45.115.16.221"
                    }
                ],
                "enable_snat": true
            },
            "description": "",
            "availability_zones": [
                "nova"
            ],
            "availability_zone_hints": [],
            "routes": [],
            "flavor_id": null,
            "tags": [],
            "created_at": "2025-09-24T01:59:30Z",
            "updated_at": "2025-09-24T01:59:33Z",
            "revision_number": 9,
            "project_id": "f33507157a634f1cac71e06a70fb558e"
        }
    ]
}

Mã trạng thái​

Thành công​

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

Lỗi​

MãMô tả
401 - UnauthorizedCần xác thực trước khi gửi request.