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

Liệt kê snapshot

GET/v3/{project_id}/snapshots

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

info

Nguồn: list-accessible-snapshots

Request​

Tham số​

project_idstringbắt buộcpath

UUID của project trong cloud multi-tenancy.

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}/snapshots

HTTP request​

GET https://api.vietnix.cloud:8776/v3/f5d834d636c642c7bfe8af86139c6f26/snapshots

Response​

Tham số​

snapshotsarraybắt buộc

Danh sách object snapshot.

user_idstringbắt buộc

UUID của user. Mới trong phiên bản 3.41

volume_idstringbắt buộc

Nếu snapshot được tạo từ volume, đây là ID của volume.

namestringbắt buộc

Tên snapshot.

statusstringbắt buộc

Trạng thái của snapshot.

descriptionstringbắt buộc

Mô tả snapshot.

created_atstringbắt buộc

Ngày giờ tạo tài nguyên. Đị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.

metadataobjectbắt buộc

Một hoặc nhiều cặp key-value metadata của snapshot, nếu có.

idstringbắt buộc

UUID của snapshot.

sizeintegerbắt buộc

Dung lượng volume, tính bằng gibibyte (GiB).

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

updated_atstringbắt buộc

Ngày giờ cập nhật tài nguyên. Nếu tài nguyên chưa từng được cập nhật, trường này có giá trị null. Đị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.

snapshots_linksarray

Liên kết của snapshot.

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
{
    "snapshots": [
        {
            "id": "40181172-d8b9-46a2-a9d8-c40ed9e098b5",
            "created_at": "2025-10-07T07:07:26.294739",
            "updated_at": "2025-10-07T07:07:27.932048",
            "name": "Snapshot-VM-west/Ubuntu-22.04-LTS-x64/Boot volume/2025-10-07 02:07:25",
            "description": null,
            "volume_id": "b0738bcc-3513-4066-852d-c70b8d966ffd",
            "volume_type_id": "e9f2ecf9-697f-4af7-b084-8d4d072d7974",
            "status": "available",
            "size": 10,
            "metadata": {}
        },
        {
            "id": "46e81440-3f96-470c-aada-b89e713d169a",
            "created_at": "2025-10-07T07:07:22.202796",
            "updated_at": "2025-10-07T07:07:24.092480",
            "name": "Snapshot-VM-east/Ubuntu-22.04-LTS-x64/Boot volume/2025-10-07 02:07:21",
            "description": null,
            "volume_id": "97ccf169-afa9-4610-849d-abb476a7f795",
            "volume_type_id": "e9f2ecf9-697f-4af7-b084-8d4d072d7974",
            "status": "available",
            "size": 10,
            "metadata": {}
        }
    ]
}