API developers
Last updated
Last updated
Địa chỉ
VNG CorporationObject Storage (HCM04) cung cấp một loạt API để quản lý dữ liệu và tương tác với các tài nguyên lưu trữ đám mây của bạn. Dưới đây là một tóm tắt về các loại API chính mà chúng tôi đang cung cấp:
Type: AWS Signature
Access Key: khởi tạo và lấy thông tin trên vStorage Portal.
Secret Key: khởi tạo và lấy thông tin trên vStorage Portal.
Region: HCM04
Endpoint: https://hcm04.vstorage.vngcloud.vn
Ví dụ:
Những API này cho phép bạn quản lý các bucket
Create Bucket: Tạo một bucket mới.
Đường dẫn: PUT /<bucket-name>
Hoặc Curl qua lệnh:
List Buckets: Liệt kê tất cả các bucket thuộc về người dùng.
Đường dẫn: GET /
Ví dụ: GET
https://hcm04.vstorage.vngcloud.vn/
Hoặc Curl qua lệnh:
Delete Bucket: Xóa một bucket (chỉ khi bucket rỗng).
Đường dẫn: DELETE /<bucket-name>
Ví dụ: DELETE
https://hcm04.vstorage.vngcloud.vn/demobucket
Hoặc Curl qua lệnh:
GET Bucket (List Objects): Liệt kê các đối tượng trong một bucket.
Đường dẫn: GET /<bucket-name>
Hoặc Curl qua lệnh:
HEAD Bucket: Kiểm tra sự tồn tại và quyền truy cập vào bucket.
Đường dẫn: HEAD /<bucket-name>
Ví dụ: HEAD
https://hcm04.vstorage.vngcloud.vn/demobucket
Hoặc Curl qua lệnh:
Quản lý quyền truy cập cho các bucket và đối tượng.
GET Bucket ACL: Lấy danh sách quyền kiểm soát truy cập (ACL) của bucket.
Đường dẫn: GET /<bucket-name>?acl
Hoặc Curl qua lệnh:
PUT Bucket ACL: Thiết lập ACL cho bucket.
Đường dẫn: PUT /<bucket-name>?acl
Hoặc Curl qua lệnh:
GET Object ACL: Lấy ACL của một đối tượng.
Đường dẫn: GET /<bucket-name>/<object-key>?acl
Hoặc Curl qua lệnh:
PUT Bucket Make Public: Thiết lập Bucket Public
Đường dẫn: GET /<bucket-name>/?publicAccessBlock
Hoặc Curl qua lệnh:
GET Bucket Make Public: Lấy thông tin bucket public hay private.
Đường dẫn: GET /<bucket-name>/?publicAccessBlock
Hoặc Curl qua lệnh:
Quản lý phiên bản của đối tượng trong bucket.
PUT Bucket Versioning: Bật hoặc tắt tính năng quản lý phiên bản cho bucket.
Đường dẫn: PUT /<bucket-name>?versioning
Hoặc Curl qua lệnh:
GET Bucket Versioning: Kiểm tra trạng thái quản lý phiên bản của bucket.
Đường dẫn: GET /<bucket-name>?versioning
Hoặc Curl qua lệnh:
GET Object Versions: Liệt kê các phiên bản của các đối tượng trong bucket.
Đường dẫn: GET /<bucket-name>?versions
Hoặc Curl qua lệnh:
Quản lý vòng đời cho bucket và đối tượng:
PUT Bucket Lifecycle: Khởi tạo lifecycle expiration cho một bucket.
Đường dẫn: PUT /<bucket-name>?lifecycle
Hoặc Curl qua lệnh:
GET Bucket Lifecycle: Lấy thông tin quy tắc vòng đời của bucket.
Đường dẫn: GET /<bucket-name>?lifecycle
Hoặc Curl qua lệnh:
DELETE Bucket Lifecycle: Xóa các quy tắc vòng đời đã thiết lập cho bucket.
Đường dẫn: DELETE /<bucket-name>?lifecycle
Hoặc Curl qua lệnh:
Quản lý truy cập và sử dụng S3 như một dịch vụ lưu trữ trang web tĩnh.
PUT Bucket Website: Thiết lập bucket như một trang web tĩnh.
Đường dẫn: PUT /<bucket-name>?cors
Hoặc Curl qua lệnh:
GET Bucket Website: Lấy cấu hình trang web của bucket.
Đường dẫn: GET /<bucket-name>?cors
Hoặc Curl qua lệnh:
DELETE Bucket Website: Xóa cấu hình trang web của bucket.
Đường dẫn: DELETE /<bucket-name>?website
Ví dụ: DELETE
https://hcm04.vstorage.vngcloud.vn/demobucket?cors
Hoặc Curl qua lệnh:
Chú ý:
Để thiết lập Object Locked cho một bucket, khi khởi tạo bucket, bạn cần thêm parameter x-amz-bucket-object-lock-enabled = true.
Thiết lập Object Locked thông qua API.
Update Object Locked Configuration: Được sử dụng để tải lên các đối tượng vào một bucket.
Đường dẫn: PUT /<bucket-name>?object-lock
Hoặc Curl tạo qua lệnh:
Đây là những API cơ bản để thao tác với các đối tượng (tệp tin) trong S3.
PUT Object: Được sử dụng để tải lên các đối tượng vào một bucket.
Đường dẫn: PUT /<bucket-name>/<object-key>
Hoặc Curl qua lệnh:
GET Object: Lấy một đối tượng từ S3.
Đường dẫn: GET /<bucket-name>/<object-key>
Hoặc Curl qua lệnh:
DELETE Object: Xóa một đối tượng khỏi S3.
Đường dẫn: DELETE /<bucket-name>/<object-key>
Hoặc Curl qua lệnh:
Chú ý:
Để xóa một object version, bạn cần thêm param versionId vào API này. Ví dụ, để xóa object test.txt có version-id = "z3-o0S5HEC6-XsjEjuHoRwoE-F6X1IF", bạn có thể curl theo lệnh:
HEAD Object: Truy vấn metadata của đối tượng mà không cần tải về nội dung.
Đường dẫn: HEAD /<bucket-name>/<object-key>
Hoặc Curl qua lệnh:
COPY Object: Sao chép một đối tượng từ một vị trí S3 này sang một vị trí khác.
Request: PUT /<destination-bucket>/<destination-object-key>
với header x-amz-copy-source
.
Hoặc Curl qua lệnh: