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

Tạo snapshot

POST/v3/{project_id}/snapshots

Tạo snapshot volume, là bản sao đầy đủ của volume tại một thời điểm. Request cần token xác thực, gửi kèm trong header.

info

Nguồn: create-a-snapshot

Request​

Tham số​

project_idstringbắt buộcpath

UUID của project trong cloud multi-tenancy.

snapshotobjectbắt buộcbody

Object snapshot.

volume_idstringbắt buộcbody

UUID của volume.

namestringbắt buộcbody

Tên snapshot.

descriptionstringbody

Mô tả snapshot. Mặc định là None.

forcebooleanbody

Có backup kể cả khi volume đang được gắn hay không. Mặc định là false.

metadataobjectbody

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

Request mẫu​

Dùng curl​

curl -ks -X POST -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
-d '{
  "snapshot": {
    "name": "snapshot1",
    "volume_id": "b0738bcc-3513-4066-852d-c70b8d966ffd",
    "force": true
  }
}' https://api.vietnix.cloud:8776/v3/f5d834d636c642c7bfe8af86139c6f26/snapshots

HTTP request​

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

với body

{
  "snapshot": {
    "name": "snapshot1",
    "volume_id": "b0738bcc-3513-4066-852d-c70b8d966ffd",
    "force": true
  }
}

Response​

Tham số​

snapshotobjectbắt buộc

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.

Mã trạng thái​

Thành công​

MãMô tả
202 - AcceptedRequest đã được chấp nhận để xử lý nhưng chưa hoàn tất. Response có header 'location' chứa liên kết để kiểm tra tiến độ request.

Lỗi​

MãMô tả
400 - Bad RequestNội dung request không hợp lệ.
404 - Not FoundKhông tìm thấy tài nguyên được yêu cầu.

Response mẫu​

Response body
{
    "snapshot": {
        "id": "d54589c3-7e86-47d5-a59d-0eae51dbd992",
        "created_at": "2025-10-07T07:19:27.702681",
        "updated_at": null,
        "name": "snapshot1",
        "description": null,
        "volume_id": "b0738bcc-3513-4066-852d-c70b8d966ffd",
        "volume_type_id": "e9f2ecf9-697f-4af7-b084-8d4d072d7974",
        "status": "creating",
        "size": 10,
        "metadata": {}
    }
}