Query the Bucket List

Function

This API is used to list buckets.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/objectstorage/buckets

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	The project ID. Minimum: 1 Maximum: 1024

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The token used for IAM authentication. Ensure that the project ID in the token matches the project ID in the request URI. Minimum: 1 Maximum: 16384

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
cloud_type	Yes	String	The cloud service provider. AWS: Amazon Web Services Aliyun: Alibaba Cloud Qiniu: Qiniu Cloud QingCloud Tencent: Tencent Cloud Baidu: Baidu Cloud KingsoftCloud Azure: Microsoft Azure UCloud HuaweiCloud: Huawei Cloud Google: Google Cloud URLSource: URL data sources HEC Default: Aliyun Minimum: 0 Maximum: 100
ak	No	String	The AK for accessing the source bucket. Enter a maximum of 100 characters. This parameter is mandatory when task_type is not url_list. Minimum: 0 Maximum: 100
sk	No	String	The SK for accessing the destination bucket. Enter a maximum of 100 characters. This parameter is mandatory when task_type is not url_list. Minimum: 0 Maximum: 100
json_auth_file	No	String	The file used for Google Cloud Storage authentication. Minimum: 0 Maximum: 65535
connection_string	No	String	The connection string, which is used for Microsoft Azure Blob authentication. Minimum: 0 Maximum: 2048
app_id	No	String	Tencent Cloud app ID. This parameter is mandatory when cloud_type is Tencent. You can obtain the value from the account information page on the Tencent Cloud console. Minimum: 0 Maximum: 255

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
[items]	Array of strings	The bucket name list.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Error message.
error_code	String	Error code.

Example Requests

This example queries the list of all buckets in an account using an AK/SK pair.

POST https://{endpoint}/v2/{project_id}/objectstorage/buckets

{
  "cloud_type" : "HuaweiCloud",
  "ak" : "xxxxak",
  "sk" : "xxxxsk",
  "app_id" : "apptest123"
}