Liệt kê floating IP

GET/v2.0/floatingips

Liệt kê các floating IP.

info

Nguồn: list-floating-ips

Request

Tham số

idstring

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

router_idstring

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

statusstring

Lọc kết quả floating IP theo trạng thái của floating IP. Giá trị là ACTIVE, DOWN và ERROR.

descriptionstring

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

tenant_idstring

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

revision_numberinteger

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

project_idstring

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

floating_network_idstring

Lọc kết quả floating IP theo ID của mạng liên kết với floating IP.

fixed_ip_addressstring

Lọc kết quả floating IP theo địa chỉ fixed IP liên kết với địa chỉ floating IP.

floating_ip_addressstring

Lọc kết quả floating IP theo địa chỉ floating IP.

port_idstring

Lọc kết quả floating IP theo ID của port liên kết với floating IP.

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 floatingip. 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 ở: fixed_ip_address, floating_ip_address, floating_network_id, id, router_id, 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/floatingips

HTTP request

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

Response

Tham số response

floatingipsarraybắt buộc

Danh sách object floatingip.

idstringbắt buộc

ID của địa chỉ floating IP.

router_idstringbắt buộc

ID của router của floating IP.

statusstringbắt buộc

Trạng thái của floating IP. Giá trị là ACTIVE, DOWN và ERROR.

descriptionstringbắt buộc

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

dns_domainstringbắt buộc

Một DNS domain hợp lệ.

dns_namestringbắt buộc

Một DNS name hợp lệ.

port_detailsstringbắt buộc

Thông tin của port mà floating IP này liên kết. Cụ thể, nếu floating IP được liên kết với một port, field này chứa một số thuộc tính của port đó, gồm name, network_id, mac_address, admin_state_up, status, device_id và device_owner. Nếu floating IP không liên kết với port, field này là null.

tenant_idstringbắt buộc

ID của project.

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.

revision_numberintegerbắt buộc

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

project_idstringbắt buộc

ID của project.

floating_network_idstringbắt buộc

ID của mạng liên kết với floating IP.

fixed_ip_addressstringbắt buộc

Địa chỉ fixed IP liên kết với địa chỉ floating IP.

floating_ip_addressstringbắt buộc

Địa chỉ floating IP.

port_idstringbắt buộc

ID của port liên kết với floating IP.

tagsarraybắt buộc

Danh sách tag trên tài nguyên.

port_forwardingsarraybắt buộc

Các tài nguyên port forwarding liên kết với floating IP. Nếu floating IP có nhiều tài nguyên port forwarding, field này có nhiều phần tử. Mỗi phần tử gồm giao thức IP mạng (protocol), địa chỉ fixed IP của neutron port nội bộ (internal_ip_address), port TCP hoặc UDP dùng bởi neutron port nội bộ (internal_port) và port TCP hoặc UDP dùng bởi floating IP (external_port).

Response mẫu

Response body

{
    "floatingips": [
        {
            "id": "15adb7f5-05ce-4ec0-a146-b4921dcc5b4c",
            "tenant_id": "f33507157a634f1cac71e06a70fb558e",
            "floating_ip_address": "45.115.16.163",
            "floating_network_id": "79cab11a-122d-43a7-9427-3575d9512413",
            "router_id": "2740d75c-9a36-48fe-b660-16d47c2d0b29",
            "port_id": "92f0c431-a2d6-4d74-94c4-74136353759b",
            "fixed_ip_address": "192.168.0.131",
            "status": "DOWN",
            "description": "",
            "qos_policy_id": null,
            "port_details": {
                "name": "kub02-og2n27k6f2kz-kube_masters-6vvzptxbvy5x-0-c7l5byvrp3xu-kube_master_eth0-wmsgxbcjat4h-0-qthrc3kaycd6",
                "network_id": "87aa2b20-580c-420c-9ca0-15f20144024b",
                "mac_address": "fa:16:3e:4f:0f:d9",
                "admin_state_up": true,
                "status": "ACTIVE",
                "device_id": "3503c7d0-d59b-4996-9fd8-7ca5b479351f",
                "device_owner": "compute:nova"
            },
            "tags": [],
            "created_at": "2025-09-25T01:33:46Z",
            "updated_at": "2025-09-25T01:33:54Z",
            "revision_number": 6,
            "project_id": "f33507157a634f1cac71e06a70fb558e"
        }
    ]
}

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.