tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary

Bucket Operations

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 2024-02-04 16:51:44

Overview

This document provides an overview of APIs and SDK code samples for basic bucket operations.
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

Querying a Bucket List

Feature description

This API (GET Service (List Buckets)) is used to query the list of all buckets under a specified account.

Sample code

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);
}

Parameter description

None.

Response description

Success: ListAllMyBuckets is returned, including the list of buckets and bucket owner information.
Failure: An error (such as authentication failure) occurs, with a CosXmlClientError or CosXmlServiceError exception reported. For more information, see Troubleshooting.
Parameters in the 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

Creating a Bucket

Feature description

This API (PUT Bucket) is used to create a bucket.

Sample code

// 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 region
let region = "COS_REGION";
// Whether to enable multi-AZ
let 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

Parameter
Description
Type
Required
bucket
Bucket name in the format of BucketName-APPID. For more information, see Bucket Overview.
String
Yes
enableMAZ
Whether to create an MAZ bucket
String
No

Response description

Success: No value is returned.
Failure: An error (such as authentication failure) occurs, with a CosXmlClientError or CosXmlServiceError exception reported. For more information, see Troubleshooting.

Checking a Bucket and Its Permissions

Feature description

This API (HEAD Bucket) is used to verify whether a bucket exists and whether you have permission to access it.
If the bucket exists and you have permission to read it, HTTP status code 200 will be returned.
If you do not have permission to read the bucket, HTTP status code 403 will be returned.
If the bucket does not exist, HTTP status code 404 will be returned.

Sample code

// 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 region
let 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

Parameter
Description
Type
bucket
Bucket name in the format of BucketName-APPID. For more information, see Bucket Overview.
String

Response description

Success: The HTTP Header is returned.
Failure: An error (such as authentication failure) occurs, with a CosXmlClientError or CosXmlServiceError exception reported. For more information, see Troubleshooting.

Deleting a Bucket

Feature description

This API (DELETE Bucket) is used to delete a specified bucket.
Note:
Before deleting a bucket, make sure that all the data and incomplete multipart uploads in the bucket have been cleared; otherwise, the bucket cannot be deleted.

Sample code

// 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 region
let 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

Parameter
Description
Type
bucket
Bucket name in the format of BucketName-APPID. For more information, see Bucket Overview.
String

Response description

Success: No value is returned.
Failure: An error (such as authentication failure) occurs, with a CosXmlClientError or CosXmlServiceError exception reported. For more information, see Troubleshooting.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan