Listing Objects in a Bucket
Function
This API is used to list objects in a bucket.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/objectstorage/buckets/objects
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
The project ID. Minimum length: 1 character Maximum length: 1,024 characters |
Request
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
The IAM token authentication. Ensure that the project ID contained in the token matches the project ID in the request URI. Minimum length: 1 character Maximum length: 16,384 characters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
cloud_type |
Yes |
String |
The cloud service provider. The value can be AWS, Aliyun, Qiniu, QingCloud, Tencent, Baidu, KingsoftCloud, Azure, UCloud, HuaweiCloud, Google, URLSource, or HEC. Minimum length: 0 characters Maximum length: 100 characters |
|
file_path |
Yes |
String |
The path to be queried in the bucket, which must end with a slash (/). Minimum length: 0 characters Maximum length: 1,023 characters |
|
ak |
No |
String |
The AK for accessing the source bucket. Minimum length: 0 characters Maximum length: 100 characters |
|
sk |
No |
String |
The SK for accessing the source bucket. Minimum length: 0 characters Maximum length: 100 characters |
|
json_auth_file |
No |
String |
The file used for Google Cloud Storage authentication. Minimum length: 0 characters Maximum length: 65,535 characters |
|
data_center |
Yes |
String |
The region. Minimum length: 0 characters Maximum length: 100 characters |
|
page_size |
Yes |
Integer |
The page size. Minimum value: 0 Maximum value: 100 |
|
behind_filename |
Yes |
String |
The name of the last object on the current page (offset). Minimum length: 0 characters Maximum length: 1,024 characters |
|
app_id |
No |
String |
This parameter is mandatory when cloud_type is Tencent. Minimum length: 0 characters Maximum length: 255 characters |
|
bucket_name |
Yes |
String |
The bucket name. Minimum length: 0 characters Maximum length: 100 characters |
Response
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
next_page |
Boolean |
Whether there is a next page. |
|
next_marker |
String |
Marker required for querying the next page (object name at the end of the current page, offset) Minimum length: 0 characters Maximum length: 1,024 characters |
|
records |
Array of ShowBucketRecord objects |
The queried object information. Array length: 0 to 100 |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
The object name. Minimum length: 0 characters Maximum length: 1,024 characters |
|
size |
String |
The object size. If the object does not have the size attribute, "--" is returned. Minimum length: 0 characters Maximum length: 100 characters |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
The error message. |
|
error_code |
String |
The error code. |
Example Request
This example lists objects in a specified bucket and returns the object information on multiple pages.
POST https://{endpoint}/v2/{project_id}/objectstorage/buckets/objects
{
"page_size" : 100,
"behind_filename" : "",
"file_path" : "A/",
"cloud_type" : "HuaweiCloud",
"bucket_name" : "xxx",
"ak" : "xxxxxak",
"sk" : "xxxxxsk",
"data_center" : "cn-north-x"
}
Example Response
Status code: 200
The object information is obtained.
{
"next_page" : false,
"next_marker" : null,
"records" : [ {
"name" : "xxxx",
"size" : "--"
}, {
"name" : "xxxx",
"size" : "73.59 MB"
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The object information is obtained. |
|
400 |
Standard error response. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
