Docs
api
Object-based Storage(US3)
CreateBucket

Create Bucket - CreateBucket

Overview

Create Bucket

💡 The -BucketName parameter will form part of the domain name (the domain name associated with the Bucket by default is .ufile.ucloud.cn) and must be globally unique. The BucketName parameter must comply with the Bucket naming standards, which are as follows: (1) The length should be between 3~63 bytes; (2) It can only contain lowercase letters, numbers, and hyphens; (3) The first and last characters cannot be hyphens.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CreateBucket.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
BucketNamestringThe name of the bucket to be created, which is globally unique.Yes
TypestringBucket access type, public or private; default is privateNo
TagstringThe business group to which the Bucket belongs, default is ‘default’.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
BucketNamestringName of the created BucketNo
BucketIdstringID of the created BucketNo

Example

Request Example

https://api.dezai.com/?Action=CreateBucket
&BucketName=blue
&Type=public
&Region=cn-bj2
&Tag=ajkWmXoX

Response Example

{
  "Action": "CreateBucketResponse",
  "BucketId": "ufile-xxx",
  "BucketName": "blue",
  "Retcode": 0
}