1. API Description
Domain name for API request: cfs.tencentcloudapi.com.
This API is used to get the list of data source buckets.
To use this API, submit a ticket for us to add you to the allowlist.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeBucketList. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-19. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| SrcService | Yes | String | Data source service provider. Valid values: COS (Tencent Cloud COS), OSS (Alibaba Cloud OSS), and OBS (Huawei Cloud OBS). |
| SrcSecretId | Yes | String | SecretId of the data source account |
| SrcSecretKey | Yes | String | SecretKey of the data source account |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of buckets |
| BucketList | Array of BucketInfo | Bucket list |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Getting the bucket list
This example shows you how to get the bucket list.
Input Example
POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBucketList
<Common request parameters>
{
"SrcSecretId": "******************************",
"SrcSecretKey": "*****************************",
"SrcService": "COS"
}
Output Example
{
"Response": {
"BucketList": [
{
"Name": "1-1256238147",
"Region": "ap-nanjing"
}
],
"TotalCount": 1,
"RequestId": "ea7fe4ad-d508-41f9-bcc7-6e043102b5ba"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
是
否
本页内容是否解决了您的问题？