查询桶对象列表
功能介绍
查询桶对象列表
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/objectstorage/buckets/objects
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:1 最大长度:1024 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token认证,需要确认Token中包含的Project ID与请求URI中修改资源的Project ID匹配。 最小长度:1 最大长度:16384 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cloud_type |
是 |
String |
云类型 AWS:亚马逊 Aliyun:阿里云 Qiniu:七牛云 QingCloud:青云 Tencent:腾讯云 Baidu:百度云 KingsoftCloud:金山云 Azure:微软云 UCloud:优刻得 HuaweiCloud:华为云 Google: 谷歌云 URLSource:URL HEC:HEC 最小长度:0 最大长度:100 |
file_path |
是 |
String |
目标桶中需要查询的对象文件路径,/结尾 最小长度:0 最大长度:1023 |
ak |
否 |
String |
源端桶的AK(最大长度100个字符) 最小长度:0 最大长度:100 |
sk |
否 |
String |
源端桶的SK(最大长度100个字符) 最小长度:0 最大长度:100 |
json_auth_file |
否 |
String |
用于谷歌云Cloud Storage鉴权 最小长度:0 最大长度:65535 |
data_center |
是 |
String |
数据中心,区域 最小长度:0 最大长度:100 |
page_size |
是 |
Integer |
分页信息,页大小 最小值:0 最大值:100 |
behind_filename |
是 |
String |
分页信息,当前页最后一个对象名称(偏移量) 最小长度:0 最大长度:1024 |
app_id |
否 |
String |
当源端为腾讯云时,会返回此参数。 最小长度:0 最大长度:255 |
bucket_name |
是 |
String |
桶名 最小长度:0 最大长度:100 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
next_page |
Boolean |
是否存在下一页 |
next_marker |
String |
查询下一页所需要的标记(此页末尾对象名,偏移量) 最小长度:0 最大长度:1024 |
records |
Array of ShowBucketRecord objects |
查询桶信息返回的record 数组长度:0 - 100 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
对象名 最小长度:0 最大长度:1024 |
size |
String |
对象大小,若对象无size属性,则返回-- 最小长度:0 最大长度:100 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
请求示例
根据给出信息查询桶对象,返回分页的桶对象列表
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" }
响应示例
状态码: 200
查询桶信息返回体
{ "next_page" : false, "next_marker" : null, "records" : [ { "name" : "xxxx", "size" : "--" }, { "name" : "xxxx", "size" : "73.59 MB" } ] }
SDK代码示例
SDK代码示例如下。
根据给出信息查询桶对象,返回分页的桶对象列表
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 |
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"); ICredential auth = new BasicCredentials() .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()); } } } |
根据给出信息查询桶对象,返回分页的桶对象列表
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 |
# 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"] credentials = BasicCredentials(ak, sk) 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) |
根据给出信息查询桶对象,返回分页的桶对象列表
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). 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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询桶信息返回体 |
400 |
标准错误响应体。 |
错误码
请参见错误码。