Bucket API¶
Để tương tác với một bucket , bạn cần phải có bộ S3 Access Key để xác thực các request gửi lên hệ thống. Bạn không thể tương tác với bucket mà không có bộ key này.
Xem thêm Hướng dẫn generate hashed key
Create Bucket¶
Tạo mới một bucket để sử dụng trong hệ thống.
Constraints
Bucket name sẽ là một phần trong sun s3 domain hoặc sun s3 path, vì vậy tên của bucket sẽ follow ràng buộc của domain
Bucket names là duy nhất trong một pool.
Bucket names không được có định dạng giống địa chỉ IP.
Bucket names có độ dài trong khoảng 3 tới 58 ký tự.
Bucket names không được tồn tại ký tự viết hoa hoặc dấu gạch dưới “_”.
Bucket names bắt đầu bằng một chữ viết thường, hoặc số.
Bucket codes sẽ được hệ thống sinh ra theo bucket name.
Note
Người dùng tương tác với hệ thống Sun S3 thông qua bucket code. Bucket code không thể thay đổi sau khi được sinh ra.
Syntax
POST /s3/v1/bucket
api-key: Basic Base64(<access-key>:<hash-of-header-and-secret>)
Parameters
Request Entity
Example
{
"cors": {
"corsRules": [
{
"allowOrigins": [
"http://console.sunteco.vn"
]
}
]
},
"name": "bucket-name",
"poolId": 123
}
Definition
Name |
Type |
Description |
Required |
---|---|---|---|
allowOrigins |
Array String |
Định nghĩa danh sách các origin được phép truy cập từ client. |
No |
name |
String |
Bucket name do người dùng đặt tên |
Yes |
poolId |
number |
Id của pool mà bucket được tạo ra |
Yes |
Response Entity
Name |
Type |
Description |
---|---|---|
Result |
String |
Mô tả trạng thái tạo bucket |
Response Status
HTTP Status |
Status Code |
Description |
---|---|---|
200 |
SUCCESS |
Tạo bucket thành công |
400 |
BAD REQUEST |
Tham số truyền lên không hợp lệ |
401 |
UNAUTHORIZED |
API chưa được xác thực. |
403 |
FORBIDDEN |
Access Key không có quyền thực hiện tạo bucket |
409 |
CONFLICT |
Bucket name đã tồn tại trong pool |
Get bucket¶
Lấy thông tin của một bucket.
Syntax
GET /s3/v1/bucket
api-key: Basic Base64(<access-key>:<hash-of-header-and-secret>)
Parameters
Name |
Description |
Valid values |
Required |
---|---|---|---|
uniqcode |
Bucket code |
any string |
yes |
Request Entity
Response Entity
Response Status
HTTP Status |
Status Code |
Description |
---|---|---|
200 |
SUCCESS |
Lấy thành công |
400 |
BAD REQUEST |
Tham số truyền lên không hợp lệ |
401 |
UNAUTHORIZED |
API chưa được xác thực |
403 |
FORBIDDEN |
Access Key không có quyền thực hiện lấy thông tin bucket |
404 |
NOTFOUND |
Không tìm thấy bucket hợp lệ |
409 |
CONFLICT |
Bucket name đã tồn tại trong pool |
Edit bucket¶
Chỉnh sửa các thông tin của bucket.
Syntax
PUT /s3/v1/bucket
api-key: Basic Base64(<access-key>:<hash-of-header-and-secret>)
Parameters
Request Entity
Example
{
"name": "new bucket name",
"uniqcode": "bucket-code"
}
Definition
Name |
Type |
Description |
Required |
---|---|---|---|
name |
String |
Tên mới của bucket khi muốn thay đổi |
Yes |
uniqcode |
String |
Bucket code của bucket |
Yes |
Response Entity
Response Status
HTTP Status |
Status Code |
Description |
---|---|---|
200 |
SUCCESS |
Sửa thành công |
400 |
BAD REQUEST |
Tham số truyền lên không hợp lệ |
401 |
UNAUTHORIZED |
API chưa được xác thực. |
403 |
FORBIDDEN |
Access Key không có quyền thực hiện sửa bucket |
404 |
NOTFOUND |
Không tìm thấy bucket hợp lệ |
Delete bucket¶
Xóa một bucket để có thể giảm dung lượng sử dụng của pool, tái sử dụng tên của bucket trong pool.
Syntax
DELETE /s3/v1/bucket
api-key: Basic Base64(<access-key>:<hash-of-header-and-secret>)
Parameters
Name |
Description |
Valid values |
Required |
---|---|---|---|
uniqcode |
Bucket code |
any string |
yes |
Request Entity
Response Entity
Response Status
HTTP Status |
Status Code |
Description |
---|---|---|
200 |
SUCCESS |
Xóa thành công |
400 |
BAD REQUEST |
Tham số truyền lên không hợp lệ |
401 |
UNAUTHORIZED |
API chưa được xác thực. |
403 |
FORBIDDEN |
Access Key không có quyền thực hiện xóa bucket |
404 |
NOTFOUND |
Không tìm thấy bucket hợp lệ |
Search Bucket¶
Search các bucket trong một pool theo name.
Syntax
POST /s3/v1/bucket/query
api-key: Basic Base64(<access-key>:<hash-of-header-and-secret>)
Parameters
Request Entity
Example
{
"poolUniqcode": "pool-code",
"textSearch": "any text"
}
Definition
Name |
Type |
Description |
Required |
---|---|---|---|
poolUniqcode |
String |
Pool code, định danh của Sun S3 Pool |
Yes |
textSearch |
String |
Đoạn text cần search |
No |
Response Entity
Response Status
HTTP Status |
Status Code |
Description |
---|---|---|
200 |
SUCCESS |
Tìm kiếm thành công |
400 |
BAD REQUEST |
Tham số truyền lên không hợp lệ |
401 |
UNAUTHORIZED |
API chưa được xác thực. |
403 |
FORBIDDEN |
Access Key không có quyền thực hiện đọc bucket |