List Objects in a Bucket
Function
This API is used to list objects in a bucket.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
oms::listObjects
List
-
-
-
-
URI
POST /v2/{project_id}/objectstorage/buckets/objects
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
The project ID. Minimum: 1 Maximum: 1024 |
Request 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 |
|
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 Minimum: 0 Maximum: 100 |
|
file_path |
Yes |
String |
The path of object files to be queried in the destination bucket, which must end with a slash (/). Minimum: 0 Maximum: 1023 |
|
ak |
No |
String |
The AK for accessing the source bucket. Enter a maximum of 100 characters. Minimum: 0 Maximum: 100 |
|
sk |
No |
String |
The SK for accessing the source bucket. Enter a maximum of 100 characters. Minimum: 0 Maximum: 100 |
|
connection_string |
No |
String |
The connection string, which is used for Microsoft Azure Blob authentication. Minimum: 0 Maximum: 2048 |
|
json_auth_file |
No |
String |
The file used for Google Cloud Storage authentication. Minimum: 0 Maximum: 65535 |
|
data_center |
Yes |
String |
The data center region. Minimum: 0 Maximum: 100 |
|
page_size |
Yes |
Integer |
The page size. Minimum: 0 Maximum: 100 |
|
behind_filename |
Yes |
String |
The name of the last object on the current page (offset). Minimum: 0 Maximum: 1024 |
|
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 |
|
bucket_name |
Yes |
String |
The bucket name. Minimum: 0 Maximum: 100 |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
next_page |
Boolean |
Whether the next page exists. |
|
next_marker |
String |
The marker required for querying the next page (object name at the end of the current page, offset) Minimum: 0 Maximum: 1024 |
|
records |
Array of ShowBucketRecord objects |
Record returned for querying bucket information. Array Length: 0 - 100 |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
Object name. Minimum: 0 Maximum: 1024 |
|
size |
String |
The object size. If the object does not have the size attribute, -- is returned. Minimum: 0 Maximum: 100 |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
Error message. |
|
error_code |
String |
Error code. |
Example Requests
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 Responses
Status code: 200
The response body for querying bucket information.
{
"next_page" : false,
"next_marker" : null,
"records" : [ {
"name" : "xxxx",
"size" : "--"
}, {
"name" : "xxxx",
"size" : "73.59 MB"
} ]
}
SDK Sample Code
The SDK sample code is as follows.
This example lists objects in a specified bucket and returns the object information on multiple pages.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.oms.v2.region.OmsRegion; import com.huaweicloud.sdk.oms.v2.*; import com.huaweicloud.sdk.oms.v2.model.*; public class ShowBucketObjectsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); OmsClient client = OmsClient.newBuilder() .withCredential(auth) .withRegion(OmsRegion.valueOf("<YOUR REGION>")) .build(); ShowBucketObjectsRequest request = new ShowBucketObjectsRequest(); ShowBucketReq body = new ShowBucketReq(); body.withBucketName("xxx"); body.withBehindFilename(""); body.withPageSize(100); body.withDataCenter("cn-north-x"); body.withSk("xxxxxsk"); body.withAk("xxxxxak"); body.withFilePath("A/"); body.withCloudType("HuaweiCloud"); request.withBody(body); try { ShowBucketObjectsResponse response = client.showBucketObjects(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
This example lists objects in a specified bucket and returns the object information on multiple pages.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkoms.v2.region.oms_region import OmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkoms.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = OmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(OmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowBucketObjectsRequest() request.body = ShowBucketReq( bucket_name="xxx", behind_filename="", page_size=100, data_center="cn-north-x", sk="xxxxxsk", ak="xxxxxak", file_path="A/", cloud_type="HuaweiCloud" ) response = client.show_bucket_objects(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
This example lists objects in a specified bucket and returns the object information on multiple pages.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" oms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := oms.NewOmsClient( oms.OmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowBucketObjectsRequest{} skShowBucketReq:= "xxxxxsk" akShowBucketReq:= "xxxxxak" request.Body = &model.ShowBucketReq{ BucketName: "xxx", BehindFilename: "", PageSize: int32(100), DataCenter: "cn-north-x", Sk: &skShowBucketReq, Ak: &akShowBucketReq, FilePath: "A/", CloudType: "HuaweiCloud", } response, err := client.ShowBucketObjects(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The response body for querying bucket information. |
|
400 |
Standard error response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot