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 Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is CreateBucket . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
BucketName | string | The name of the bucket to be created, which is globally unique. | Yes |
Type | string | Bucket access type, public or private; default is private | No |
Tag | string | The business group to which the Bucket belongs, default is 'default'. | No |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
BucketName | string | Name of the created Bucket | No |
BucketId | string | ID of the created Bucket | No |
Example
Request Example
https://api.surfercloud.com/?Action=CreateBucket
&BucketName=blue
&Type=public
&Region=cn-bj2
&Tag=ajkWmXoX
Response Example
{
"Action": "CreateBucketResponse",
"BucketId": "ufile-xxx",
"BucketName": "blue",
"Retcode": 0
}