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

Liệt kê volume

GET/v3/{project_id}/volumes

Để liệt kê tất cả volume trong project, gửi request GET tới endpoint /v3/{project_id}/volumes của volume service. Request cần token xác thực, gửi kèm trong header.

info

Nguồn: list-volumes

Request​

Tham số​

project_idstringbắt buộcpath

UUID của project trong cloud multi-tenancy.

created_atstringquery

Lọc kết quả theo thời điểm tạo tài nguyên với các toán tử so sánh thời gian: gt, gte, eq, neq, lt, lte. Định dạng dấu thời gian ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm. Ví dụ: 2015-08-27T09:49:58-05:00. Giá trị ±hh (nếu có) là múi giờ lệch so với UTC; trong ví dụ này, độ lệch là -05:00. Mới trong phiên bản 3.60

updated_atstringquery

Lọc kết quả theo thời điểm cập nhật tài nguyên với các toán tử so sánh thời gian: gt, gte, eq, neq, lt, lte. Định dạng dấu thời gian ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm. Ví dụ: 2015-08-27T09:49:58-05:00. Giá trị ±hh (nếu có) là múi giờ lệch so với UTC; trong ví dụ này, độ lệch là -05:00. Mới trong phiên bản 3.60

all_tenantsstringquery

Hiển thị chi tiết của tất cả project. Chỉ admin.

sortstringquery

Danh sách sort key và chiều sắp xếp tuỳ chọn, cách nhau bằng dấu phẩy, dạng <key>[:<direction>]. Chiều hợp lệ là asc (tăng dần) hoặc desc (giảm dần).

limitintegerquery

Kích thước trang item. Trả về số item tối đa bằng giá trị limit. Dùng limit cho request giới hạn đầu tiên, sau đó dùng ID của item cuối cùng trong response làm giá trị marker cho request giới hạn tiếp theo.

offsetintegerquery

Dùng cùng limit để trả về một lát cắt của danh sách. offset là vị trí bắt đầu trong danh sách.

markerstringquery

ID của item cuối cùng đã thấy. Dùng limit cho request giới hạn đầu tiên, sau đó dùng ID của item cuối cùng trong response làm giá trị marker cho request giới hạn tiếp theo.

with_countbooleanquery

Có hiển thị count trong response API hay không, mặc định là false. Mới trong phiên bản 3.45

Request mẫu​

Dùng curl​

curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://api.vietnix.cloud:8776/v3/{PROJECT_ID}/volumes

HTTP request​

GET https://api.vietnix.cloud:8776/v3/f33507157a634f1cac71e06a70fb558e/volumes

Response​

Tham số​

volumesarraybắt buộc

Danh sách object volume.

idstringbắt buộc

UUID của volume.

linksarraybắt buộc

Liên kết của volume.

namestringbắt buộc

Tên volume.

volumes_linksarray

Liên kết của volume.

countinteger

Tổng số tài nguyên được yêu cầu trước khi áp dụng phân trang. Mới trong phiên bản 3.45

Mã trạng thái​

Thành công​

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

Lỗi​

MãMô tả
400 - Bad RequestNội dung request không hợp lệ.

Response mẫu​

Response body
{
    "volumes": [
        {
            "id": "332ee999-4e21-4b1b-bf8d-b139a6950dc4",
            "name": "kubtest01-qrvuvhw7sn5q-kube_masters-ljbufjnwka7m-0-bkrb7mqusj77-kube_node_volume-oaciuhwqxwdr",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.vietnix.cloud:8776/v3/f33507157a634f1cac71e06a70fb558e/volumes/332ee999-4e21-4b1b-bf8d-b139a6950dc4"
                },
                {
                    "rel": "bookmark",
                    "href": "https://api.vietnix.cloud:8776/f33507157a634f1cac71e06a70fb558e/volumes/332ee999-4e21-4b1b-bf8d-b139a6950dc4"
                }
            ]
        },
        {
            "id": "30deaa51-7690-48e4-9a04-131e74db74c3",
            "name": "kub01-diqorkiwjmux-kube_minions-iulg6ecboyfz-0-exmhruv4vsey-kube_node_volume-gbieb2z4bdlf",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.vietnix.cloud:8776/v3/f33507157a634f1cac71e06a70fb558e/volumes/30deaa51-7690-48e4-9a04-131e74db74c3"
                },
                {
                    "rel": "bookmark",
                    "href": "https://api.vietnix.cloud:8776/f33507157a634f1cac71e06a70fb558e/volumes/30deaa51-7690-48e4-9a04-131e74db74c3"
                }
            ]
        },
        {
            "id": "9e5576f7-fb9a-43f1-b701-801c470ee7bd",
            "name": "kub01-diqorkiwjmux-kube_minions-iulg6ecboyfz-0-exmhruv4vsey-docker_volume-esm5ngxm7lim",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.vietnix.cloud:8776/v3/f33507157a634f1cac71e06a70fb558e/volumes/9e5576f7-fb9a-43f1-b701-801c470ee7bd"
                },
                {
                    "rel": "bookmark",
                    "href": "https://api.vietnix.cloud:8776/f33507157a634f1cac71e06a70fb558e/volumes/9e5576f7-fb9a-43f1-b701-801c470ee7bd"
                }
            ]
        },
        {
            "id": "7c0007f3-928c-4d65-8dea-336836e1d837",
            "name": "kub01-diqorkiwjmux-kube_masters-6f45c55gpjy2-0-xv53lzqji4hn-docker_volume-ixvh73br5vog",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.vietnix.cloud:8776/v3/f33507157a634f1cac71e06a70fb558e/volumes/7c0007f3-928c-4d65-8dea-336836e1d837"
                },
                {
                    "rel": "bookmark",
                    "href": "https://api.vietnix.cloud:8776/f33507157a634f1cac71e06a70fb558e/volumes/7c0007f3-928c-4d65-8dea-336836e1d837"
                }
            ]
        },
        {
            "id": "e9ed8887-28a9-4579-bacf-460624995547",
            "name": "kub01-diqorkiwjmux-kube_masters-6f45c55gpjy2-0-xv53lzqji4hn-kube_node_volume-cz7kzzvspbtg",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.vietnix.cloud:8776/v3/f33507157a634f1cac71e06a70fb558e/volumes/e9ed8887-28a9-4579-bacf-460624995547"
                },
                {
                    "rel": "bookmark",
                    "href": "https://api.vietnix.cloud:8776/f33507157a634f1cac71e06a70fb558e/volumes/e9ed8887-28a9-4579-bacf-460624995547"
                }
            ]
        },
        {
            "id": "272de0a1-a155-4bdf-ab76-7ab6da4411f2",
            "name": "vz-guest-tools-lin",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.vietnix.cloud:8776/v3/f33507157a634f1cac71e06a70fb558e/volumes/272de0a1-a155-4bdf-ab76-7ab6da4411f2"
                },
                {
                    "rel": "bookmark",
                    "href": "https://api.vietnix.cloud:8776/f33507157a634f1cac71e06a70fb558e/volumes/272de0a1-a155-4bdf-ab76-7ab6da4411f2"
                }
            ]
        }
    ]
}