调用ListObjects列出Bucket中的所有文件(Object)的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
BucketName | string | 是 | Bucket 名称。 | test |
EncodingType | string | 否 | 请求响应体中文件名称采用的编码方式,目前仅支持 url。 | url |
Marker | string | 否 | 此次列举文件的起点。设定从 Marker 之后按字母排序开始返回 Object。Marker 用来实现分页显示效果,参数的长度必须小于 1024 字节。 做条件查询时,即使 Marker 在列表中不存在,也会从符合 Marker 字母排序的下一个开始打印。 | a |
MaxKeys | long | 否 | 限定此次列举文件的最大个数。 取值范围:0~1000(包含 1000),默认值为 100。 | 100 |
Prefix | string | 否 | 限定返回的文件必须以 prefix 作为前缀。使用 Prefix 查询时,返回的 Key 中仍会包含 Prefix。 参数的长度必须小于 1000 字节。 | b |
ContinuationToken | string | 否 | 此次列举文件使用的 continuationToken。如果 MaxKeys 的设定无法一次完成列举,返回结果会附加 NextContinuationToken 作为下一次列举的 ContinuationToken。 | test1.txt |
StartAfter | string | 否 | 此次列举文件的起点。设定从 StartAfter 之后按字母排序开始返回 Object。StartAfter 用来实现分页显示效果,参数的长度必须小于 1000 字节。 做条件查询时,即使 StartAfter 在列表中不存在,也会从符合 StartAfter 字母排序的下一个开始打印。 | b |
返回参数
示例
正常返回示例
JSON
格式
{
"CommonPrefixes": [
"不涉及"
],
"NextContinuationToken": "CgJiYw--",
"ContinuationToken": "test1.txt",
"Delimiter": "/",
"EncodingType": "不涉及",
"Prefix": "b",
"Marker": "ceshi.txt1617853707991",
"BucketName": "test",
"Contents": [
{
"Key": "ceshi.txt1617853706546",
"LastModified": "2021-04-08T03:48:47.488Z",
"ETag": "5B3C1A2E053D763E1B002CC607C5****",
"Size": 15
}
],
"IsTruncated": true,
"KeyCount": 10,
"NextMarker": "ceshi.txt1617853707991",
"MaxKeys": 10,
"RequestId": "4833C4AC-9396-458C-8F25-1D701334E560"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Invalid%s | Specified parameter %s is not valid | - |
400 | InvalidBucketName | Specified parameter BucketName is not valid. | - |
400 | InvalidPrefix | Specified parameter Prefix is not valid. | - |
400 | InvalidStartAfter | Specified parameter StartAfter is not valid. | - |
400 | InvalidMarker | Specified parameter Marker is not valid. | - |
400 | InvalidDelimiter | Specified parameter Delimiter is not valid. | - |
400 | NoPermission | Permission denied. | 没有足够的权限,请联系云账号管理员授予您相应权限。 |
400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
403 | AccessDenied | auth is not valid | - |
404 | NoSuchBucket | The specified bucket does not exist. | - |
500 | InternalError | The request processing has failed due to some unknown error. | - |
访问错误中心查看更多错误码。