ListObjects_对象存储_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • GetBucket (ListObjects)接口已修订为 GetBucketV2 (ListObjectsV2)。建议您在开发应用程序时使用较新的版本 GetBucketV2 (ListObjectsV2)。为保证向后兼容性,OSS 继续支持 GetBucket (ListObjects)。有关 GetBucketV2 (ListObjectsV2)的更多信息,请参见GetBucketV2 (ListObjectsV2)

  • 执行 GetBucket (ListObjects)请求时不会返回 Object 中自定义的元信息。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
oss:ListObjects
List
Bucket
acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}
oss:Prefix
oss:Delimiter
acs:UserAgent
acs:AccessId
oss:BucketTag
oss:TLSVersion
oss:DataAccessPointArn
oss:AccessPointNetworkOrigin
oss:DataAccessPointAccount
oss:GetObject

请求语法

GET / HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com

请求参数

字段名称字段详情
bucketstring

Bucket 名称。

示例值:examplebucket
delimiterstring

对 Object 名字进行分组的字符。所有 Object 名字包含指定的前缀,第一次出现 delimiter 字符之间的 Object 作为一组元素(即 CommonPrefixes)。

示例值:/
markerstring

设定从 marker 之后按字母排序开始返回 Object。展开详情

示例值:test1.txt
max-keysinteger<int64>

指定返回 Object 的最大数。 如果因为 max-keys 的设定无法一次完成列举,返回结果会附加 NextMarker 元素作为下一次列举的 marker。
取值:大于 0 小于 1000
默认值:100

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:100
prefixstring

限定返回文件的 Key 必须以 prefix 作为前缀。展开详情

示例值:fun
encoding-typeEncodeType

对返回的内容进行编码并指定编码的类型。展开详情

枚举值:

返回参数

字段名称字段详情
ListBucketResultobject

保存 GetBucket 请求结果的容器。

返回示例

变更历史

变更时间变更内容概要操作
2024-02-21
变更返回参数

相关示例