API developers

Object 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:

Authentication

• 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ụ:

Làm việc với Bucket

Những API này cho phép bạn quản lý các bucket

1. Những API cơ bản

• Create Bucket: Tạo một bucket mới.

  • Đường dẫn: PUT /<bucket-name>

  • Ví dụ: PUThttps://hcm04.vstorage.vngcloud.vn/demobucket

  • Hoặc Curl qua lệnh:

  Copy

  curl --location --request PUT 'https://hcm04.vstorage.vngcloud.vn/demobucket' \
  --header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
  --header 'X-Amz-Date: 20240829T041014Z' \
  --header 'Authorization: AWS4-HMAC-SHA256 Credential=f8502b7bf7ca4773c68899d9efd85474/20240829/HCM04/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=8b4d67b37ab0ba0c6bb42df8d6451fdb48aba5874a0717798aeee9f4c57b8fe9'

• 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:

  Copy

  curl --location 'https://hcm04.vstorage.vngcloud.vn/' \
  --header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
  --header 'X-Amz-Date: 20240829T041050Z' \
  --header 'Authorization: AWS4-HMAC-SHA256 Credential=f8502b7bf7ca4773c68899d9efd85474/20240829/HCM04/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=997d9b761262a6827002384dd9ba21b777ec4f26e84dedd164a5866bf78d348a'

• 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:

    Copy

    curl --location --request DELETE 'https://hcm04.vstorage.vngcloud.vn/demobucket' \
    --header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
    --header 'X-Amz-Date: 20240829T041239Z' \
    --header 'Authorization: AWS4-HMAC-SHA256 Credential=f8502b7bf7ca4773c68899d9efd85474/20240829/HCM04/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=e164da98dd0564eea205ec8624d701d8809afab7ab57867e45a3beb227f8a71d'

• GET Bucket (List Objects): Liệt kê các đối tượng trong một bucket.

  • Đường dẫn: GET /<bucket-name>

  • Ví dụ: GEThttps://hcm04.vstorage.vngcloud.vn/demobucket

  • Hoặc Curl qua lệnh:

    Copy

    curl --location 'https://hcm04.vstorage.vngcloud.vn/demobucket' \
    --header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
    --header 'X-Amz-Date: 20240829T041313Z' \
    --header 'Authorization: AWS4-HMAC-SHA256 Credential=f8502b7bf7ca4773c68899d9efd85474/20240829/HCM04/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=7481242fb41364a753658d7db3b2e95c4b2e10458987e14584dc297330ea7dab'

• 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:

    Copy

    curl --location --head 'https://hcm04.vstorage.vngcloud.vn/demobucket' \
    --header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
    --header 'X-Amz-Date: 20240829T041336Z' \
    --header 'Authorization: AWS4-HMAC-SHA256 Credential=f8502b7bf7ca4773c68899d9efd85474/20240829/HCM04/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=425119560f45bd0cd7a5a58f6835d189e0cc3d7907cdd72bfd84bd6d88f59ae9'

2. API Kiểm soát truy cập (Access Control APIs)

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

  • Ví dụ: GEThttps://hcm04.vstorage.vngcloud.vn/demobucket?acl

  • Hoặc Curl qua lệnh:

    Copy

    curl --location 'https://hcm04.vstorage.vngcloud.vn/demobucket?acl=null' \
    --header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
    --header 'X-Amz-Date: 20240829T041447Z' \
    --header 'Authorization: AWS4-HMAC-SHA256 Credential=f8502b7bf7ca4773c68899d9efd85474/20240829/HCM04/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=fd112a35fed96929de946f9c48d050c8f15ca1249ae549d7b86664adde8d81cd'

• PUT Bucket ACL: Thiết lập ACL cho bucket.

  • Đường dẫn: PUT /<bucket-name>?acl

  • Ví dụ: PUT https://hcm04.vstorage.vngcloud.vn/demobucket?acl

  • Hoặc Curl qua lệnh:

    Copy

    curl --location --request PUT 'https://hcm04.vstorage.vngcloud.vn/demobucket?acl=null' \
    --header 'Content-Type: application/xml' \
    --header 'X-Amz-Content-Sha256: beaead3198f7da1e70d03ab969765e0821b24fc913697e929e726aeaebf0eba3' \
    --header 'X-Amz-Date: 20240829T043655Z' \
    --header 'Authorization: AWS4-HMAC-SHA256 Credential=f8502b7bf7ca4773c68899d9efd85474/20240829/HCM04/s3/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=47e95dfbf5a61141dd1088cc286ee2f187ae78c0f7cc108c20538ac1ee77d18b' \
    --data '<AccessControlPolicy xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
      <Owner>
        <ID>rootuser-092410</ID> <!-- Replace with the bucket owner'\''s canonical user ID -->
        <DisplayName>Demo_user</DisplayName> <!-- Optional: Owner'\''s display name -->
      </Owner>
      <AccessControlList>
        <Grant>
          <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
            <ID>user1-054549</ID> <!-- Replace with the grantee'\''s canonical user ID -->
            <DisplayName>UserA</DisplayName> <!-- Optional: Grantee'\''s display name -->
          </Grantee>
          <Permission>FULL_CONTROL</Permission> <!-- Possible values: FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP -->
        </Grant>
        <Grant>
          <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group">
            <URI>http://acs.amazonaws.com/groups/global/AllUsers</URI> <!-- All users -->
          </Grantee>
          <Permission>READ</Permission>
        </Grant>
      </AccessControlList>
    </AccessControlPolicy>
    '

• GET Object ACL: Lấy ACL của một đối tượng.

  • Đường dẫn: GET /<bucket-name>/<object-key>?acl

  • Ví dụ: GEThttps://hcm04.vstorage.vngcloud.vn/demobucket/videoplayback.mp4?acl

  • Hoặc Curl qua lệnh:

    Copy

    curl --location 'https://hcm04.vstorage.vngcloud.vn/demobucket/videoplayback.mp4?acl=null' \
    --header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
    --header 'X-Amz-Date: 20240829T041603Z' \
    --header 'Authorization: AWS4-HMAC-SHA256 Credential=f8502b7bf7ca4773c68899d9efd85474/20240829/HCM04/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=eb53bff6d55ade68e688ea5af5b44ff9da9afb7b361e5e60563f6d0f3e4c763b'

• PUT Bucket Make Public: Thiết lập Bucket Public

  • Đường dẫn: GET /<bucket-name>/?publicAccessBlock

  • Ví dụ: PUT https://hcm04.vstorage.vngcloud.vn/demobucket01/?publicAccessBlock

  • Hoặc Curl qua lệnh:

    Copy

    curl --location --request PUT 'https://hcm04.vstorage.vngcloud.vn/demobucket01/?publicAccessBlock=null' \
    --header 'Content-Type: application/xml' \
    --header 'X-Amz-Content-Sha256: beaead3198f7da1e70d03ab969765e0821b24fc913697e929e726aeaebf0eba3' \
    --header 'X-Amz-Date: 20240829T063152Z' \
    --header 'Authorization: AWS4-HMAC-SHA256 Credential=9c9624d2ac082b98e6925444ab497746/20240829/HCM04/s3/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=341d2a2ba5e1645ae7ee1b9d5e06649333b08433c7efcd47953ac3e2603ee0bb' \
    --data '<PublicAccessBlockConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
      <BlockPublicAcls>true</BlockPublicAcls>
      <IgnorePublicAcls>true</IgnorePublicAcls>
      <BlockPublicPolicy>true</BlockPublicPolicy>
      <RestrictPublicBuckets>true</RestrictPublicBuckets>
    </PublicAccessBlockConfiguration>'

• GET Bucket Make Public: Lấy thông tin bucket public hay private.

  • Đường dẫn: GET /<bucket-name>/?publicAccessBlock

  • Ví dụ: GEThttps://hcm04.vstorage.vngcloud.vn/demobucket01/?publicAccessBlock

  • Hoặc Curl qua lệnh:

    Copy