API | Operation | Description |
Querying bucket list | Queries the list of all buckets under a specified account | |
Creating a bucket | Creates a bucket under a specified account | |
Checking a bucket and its permission | Checks whether a bucket exists and you have permission to access it | |
Deleting a bucket | Deletes an empty bucket under a specified account |
GET Service (List Buckets)
) is used to query the list of all buckets under a specified account.try {let listAllMyBuckets: ListAllMyBuckets = await Cos.getDefaultService().getService();// For bucket list details, see the `ListAllMyBuckets` class.} catch (e) {// An exception will be reported in case of failure. Process the business logic accordingly.console.log(e);}
ListAllMyBuckets
is returned, including the list of buckets and bucket owner information.CosXmlClientError
or CosXmlServiceError
exception reported. For more information, see Troubleshooting.ListAllMyBuckets
response body are as follows:Parameter | Description | Type |
buckets | Bucket list | List<Bucket> |
owner | Bucket owner information | Owner |
Bucket
has the following sub-nodes:Parameter | Description | Type |
name | Bucket name | String |
location | Bucket region | String |
createDate | Bucket creation time in ISO 8601 format, such as 2019-05-24T10:56:40Z | String |
Owner
has the following sub-nodes:Parameter | Description | Type |
id | Complete ID | String |
disPlayName | Bucket owner name | String |
PUT Bucket
) is used to create a bucket.// Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.let bucket = "examplebucket-1250000000";// Bucket region abbreviation. For example, "ap-guangzhou" is the abbreviation of the Guangzhou regionlet region = "COS_REGION";// Whether to enable multi-AZlet enableMAZ = false;try {await Cos.getDefaultService().putBucket(bucket,{region: region,enableMAZ: enableMAZ});} catch (e) {// An exception will be reported in case of failure. Process the business logic accordingly.console.log(e);}
Parameter | Description | Type | Required |
bucket | String | Yes | |
enableMAZ | Whether to create an MAZ bucket | String | No |
CosXmlClientError
or CosXmlServiceError
exception reported. For more information, see Troubleshooting.HEAD Bucket
) is used to verify whether a bucket exists and whether you have permission to access it.// Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.let bucket = "examplebucket-1250000000";// Bucket region abbreviation. For example, "ap-guangzhou" is the abbreviation of the Guangzhou regionlet region = "COS_REGION";try {let header = await Cos.getDefaultService().headBucket(bucket,region);// The HTTP status code is 200, and the HTTP header is `header`.} catch (e) {// View the specific HTTP status code in `e.statusCode`console.log(e);}
Parameter | Description | Type |
bucket | String |
CosXmlClientError
or CosXmlServiceError
exception reported. For more information, see Troubleshooting.DELETE Bucket
) is used to delete a specified bucket.// Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.let bucket = "examplebucket-1250000000";// Bucket region abbreviation. For example, "ap-guangzhou" is the abbreviation of the Guangzhou regionlet region = "COS_REGION";try {await Cos.getDefaultService().deleteBucket(bucket,region);} catch (e) {// An exception will be reported in case of failure. Process the business logic accordingly.console.log(e);}
Parameter | Description | Type |
bucket | String |
CosXmlClientError
or CosXmlServiceError
exception reported. For more information, see Troubleshooting.
Was this page helpful?