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:

• vStorage API: bạn có thể sử dụng Service Account để authenticate và làm việc với project, bucket, object, report thông qua API.

• S3 API: bạn có thể sử dụng S3 keys để authenticate và làm việc với bucket, object thông qua API.

vStorage API - Authentication

Thực hiện theo các bước bên dưới làm việc với vStorage thông qua Service Account

1. Đăng nhập vào https://vstorage.console.vngcloud.vn

2. Chọn thư mục Integration.

3. Chọn biểu tượng vStorage API.

4. Tại mục Authentication, bạn cần điền thông tin cần thiết để cấu hình vStorage API của bạn bao gồm:

   1. Nhập Client ID. Một Client ID là một chuỗi ký tự được sử dụng bởi Service API để định danh ứng dụng, đồng thời cũng được dùng để xây dựng "authorization URL" hiển thị phía người dùng. Bạn có thể tạo và quản lý Client ID thông qua hệ thống vIAM. Client ID sẽ được tự động sinh ra khi bạn tạo mới một Service Account.

   2. Nhập Client Secret tương ứng của Client ID vừa nhập. Cặp Client ID và Client Secret được bạn tạo và quản lý thông qua hệ thống vIAM. Bạn có thể chọn Click here to manage your Client ID. để chúng tôi điều hướng bạn tới hệ thống vIAM và chi tiết là các màn hình quản lý Service Account.

5. Sau khi hoàn tất chọn cấu hình xác thực, chọn Authentication để chuyển tới màn hình Configuration. Tại đây bạn có thể sử dụng trực tiếp các vStorage API hoặc bạn có thể sử dụng API thông qua Postman. Bạn luôn có thể quay lại đây để thay đổi thông tin Cấp quyền của mình, sau đó chọn lại Xác thực để cập nhật danh sách S3 Rest API theo thông số mới của bạn.

Chi tiết, vui lòng tham khảo thêm tại https://docs.api.vngcloud.vn/service-docs/vstorage-hcm04-api.html.

S3 API - 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:

  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:

  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:

    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:

    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:

    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:

    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:

    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:

    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:

    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:

    curl --location 'https://hcm04.vstorage.vngcloud.vn/demobucket01/?publicAccessBlock=null' \
    --header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
    --header 'X-Amz-Date: 20240829T063914Z' \
    --header 'Authorization: AWS4-HMAC-SHA256 Credential=9c9624d2ac082b98e6925444ab497746/20240829/HCM04/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=041a0737e3e204ca2941069a3bab021ad54a8eb837fcbfd2ff8d2a3dd647d060'

3. API Quản Lý Phiên Bản (Versioning)

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

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

  • Hoặc Curl qua lệnh:

    curl --location --request PUT 'https://hcm04.vstorage.vngcloud.vn/demobucket?versioning=null' \
    --header 'Content-Type: application/xml' \
    --header 'X-Amz-Content-Sha256: beaead3198f7da1e70d03ab969765e0821b24fc913697e929e726aeaebf0eba3' \
    --header 'X-Amz-Date: 20240829T041647Z' \
    --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=79d17ba3ab6fe55a68df54b423fa17c9633ed24b462ab4727f9997bef28ed3ac' \
    --data '<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
       <Status>Enabled</Status>
    </VersioningConfiguration>'

• 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

  • Ví dụ: GET https://hcm04.vstorage.vngcloud.vn/demobucket?versioning

  • Hoặc Curl qua lệnh:

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

• 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

  • Ví dụ: GET https://hcm04.vstorage.vngcloud.vn/demobucket/?versions

  • Hoặc Curl qua lệnh:

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

4. API Lifecycle

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

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

  • Hoặc Curl qua lệnh:

    curl --location --request PUT 'https://hcm04.vstorage.vngcloud.vn/demobucket?lifecycle=null' \
    --header 'Content-Type: application/xml' \
    --header 'X-Amz-Content-Sha256: beaead3198f7da1e70d03ab969765e0821b24fc913697e929e726aeaebf0eba3' \
    --header 'X-Amz-Date: 20240829T042040Z' \
    --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=9bc1af859707fb67367fda2cb60236b2d1b9c4442a9e44a77f918242ae8bca87' \
    --data '<LifecycleConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
        <Rule>
            <Expiration>
                <Days>1</Days>
            </Expiration>
            <ID>test-lifecyle</ID>
            <Filter>
                <Prefix>*</Prefix>
            </Filter>
            <Status>Enabled</Status>
        </Rule>
    </LifecycleConfiguration>'

• GET Bucket Lifecycle: Lấy thông tin quy tắc vòng đời của bucket.

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

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

  • Hoặc Curl qua lệnh:

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

• 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

  • Ví dụ: DELETEhttps://hcm04.vstorage.vngcloud.vn/demobucket?lifecycle

  • Hoặc Curl qua lệnh:

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

5. API CORS

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

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

  • Hoặc Curl qua lệnh:

    curl --location --request PUT 'https://hcm04.vstorage.vngcloud.vn/demobucket?cors=null' \
    --header 'Content-Type: application/xml' \
    --header 'X-Amz-Content-Sha256: beaead3198f7da1e70d03ab969765e0821b24fc913697e929e726aeaebf0eba3' \
    --header 'X-Amz-Date: 20240829T042330Z' \
    --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=bdfa1e44bd7f1e52c0c40b73ea484b68dbd2bd80c2a470f41262740614d64a1d' \
    --data '<CORSConfiguration>
      <CORSRule>
        <AllowedOrigin>*</AllowedOrigin> <!-- Allows all origins -->
        <AllowedMethod>GET</AllowedMethod> <!-- Allows the GET HTTP method -->
        <AllowedMethod>POST</AllowedMethod> <!-- Allows the POST HTTP method -->
        <AllowedMethod>PUT</AllowedMethod> <!-- Allows the PUT HTTP method -->
        <AllowedMethod>DELETE</AllowedMethod> <!-- Allows the DELETE HTTP method -->
        <AllowedHeader>*</AllowedHeader> <!-- Allows all headers in requests -->
        <MaxAgeSeconds>3000</MaxAgeSeconds> <!-- Cache the response for preflight requests for 3000 seconds -->
        <ExposeHeader>x-amz-request-id</ExposeHeader> <!-- Exposes the x-amz-request-id header to the client -->
      </CORSRule>
    </CORSConfiguration>
    '

• GET Bucket Website: Lấy cấu hình trang web của bucket.

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

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

  • Hoặc Curl qua lệnh:

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

• DELETE Bucket Website: Xóa cấu hình trang web của bucket.

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

  • Ví dụ: DELETEhttps://hcm04.vstorage.vngcloud.vn/demobucket?cors

  • Hoặc Curl qua lệnh:

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

---

6. API Object Locked

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

  • Ví dụ: PUT https://hcm04.vstorage.vngcloud.vn/demoobjectlocked?object-lock

  • Hoặc Curl tạo qua lệnh:

    curl --location --request PUT 'https://hcm04.vstorage.vngcloud.vn/demoobjectlocked?object-lock=null' \
    --header 'Content-MD5: frQ6AD8WUb/ZlO+2+AKIlw==' \
    --header 'X-Amz-Content-Sha256: beaead3198f7da1e70d03ab969765e0821b24fc913697e929e726aeaebf0eba3' \
    --header 'X-Amz-Date: 20240829T085503Z' \
    --header 'Authorization: AWS4-HMAC-SHA256 Credential=c65bce455f431914fe5f39c28e8d56f7/20240829/HCM04/s3/aws4_request, SignedHeaders=content-length;content-md5;content-type;host;x-amz-content-sha256;x-amz-date, Signature=f39c72fe719ac44ea493df3013534510ea44d5f75360186532b514fe38139a8c' \
    --data '<ObjectLockConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> 
        <ObjectLockEnabled>Enabled</ObjectLockEnabled>
        <Rule>
            <DefaultRetention> 
                <Mode>COMPLIANCE</Mode>
                <Days>1</Days>
            </DefaultRetention>
        </Rule>
    </ObjectLockConfiguration>'

  

---

Làm việc với Object

Đâ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>

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

  • Hoặc Curl qua lệnh:

    curl --location --request PUT 'https://hcm04.vstorage.vngcloud.vn/demobucket/demoobject.txt' \
    --header 'Content-MD5: h6xLdLBQrPaV94Ve6q8WPQ==' \
    --header 'Content-Type: text/plain' \
    --header 'X-Amz-Content-Sha256: beaead3198f7da1e70d03ab969765e0821b24fc913697e929e726aeaebf0eba3' \
    --header 'X-Amz-Date: 20240829T042534Z' \
    --header 'Authorization: AWS4-HMAC-SHA256 Credential=f8502b7bf7ca4773c68899d9efd85474/20240829/HCM04/s3/aws4_request, SignedHeaders=content-length;content-md5;content-type;host;x-amz-content-sha256;x-amz-date, Signature=f0592a78ee6b84a5b7cbc4edaf90e76cacc496a0351c5d10b19b9a574e4e9a1a' \
    --data 'datatest'

• GET Object: Lấy một đối tượng từ S3.

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

  • Ví dụ: GET https://hcm04.vstorage.vngcloud.vn/demobucket/demoobject.txt

  • Hoặc Curl qua lệnh:

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

• DELETE Object: Xóa một đối tượng khỏi S3.

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

  • Ví dụ: DELETE https://hcm04.vstorage.vngcloud.vn/demobucket/demoobject.txt

  • Hoặc Curl qua lệnh:

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

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:

curl --location --request DELETE 'https://hcm04.vstorage.vngcloud.vn/demobucket/test.txt?versionId=z3-o0S5HEC6-XsjEjuHoRwoE-F6X1IF' \
--header 'x-amz-bypass-governance-retention: true' \
--header 'versionId: z3-o0S5HEC6-XsjEjuHoRwoE-F6X1IF' \
--header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
--header 'X-Amz-Date: 20240911T065412Z' \
--header 'Authorization: AWS4-HMAC-SHA256 Credential=b98adf996bb003a1bd79748c5e779ccd/20240911/HCM04/s3/aws4_request, SignedHeaders=host;x-amz-bypass-governance-retention;x-amz-content-sha256;x-amz-date, Signature=6a69759b132a6be8f609fb66bca41f06a33e560ca4ff012de01351cc7bcbd05e'

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

  • Ví dụ: HEADhttps://hcm04.vstorage.vngcloud.vn/demobucket/demoobject.txt

  • Hoặc Curl qua lệnh:

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

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

  • Ví dụ: PUT https://hcm04.vstorage.vngcloud.vn/demobucket01/demoobject.txt

  • Hoặc Curl qua lệnh:

curl --location --request PUT 'https://hcm04.vstorage.vngcloud.vn/demobucket01/demoobject.txt' \
--header 'x-amz-copy-source: /demobucket/demoobject.txt' \
--header 'x-amz-object-lock-legal-hold: OFF' \
--header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
--header 'X-Amz-Date: 20240829T040428Z' \
--header 'Authorization: AWS4-HMAC-SHA256 Credential=f8502b7bf7ca4773c68899d9efd85474/20240829/HCM04/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-copy-source;x-amz-date;x-amz-object-lock-legal-hold, Signature=bf53eedc8b407de21d94c73191940f2257a6c9759f411e844c912de3c2b26ee9'