ListObjects - 查询Object信息 - 边缘节点服务ENS

调用ListObjects列出Bucket中的所有文件（Object）的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:ListObjects

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
BucketName	string	是	Bucket 名称。	test
EncodingType	string	否	请求响应体中文件名称采用的编码方式，目前仅支持 url。	url
Marker	string	否	此次列举文件的起点。设定从 Marker 之后按字母排序开始返回 Object。Marker 用来实现分页显示效果，参数的长度必须小于 1024 字节。做条件查询时，即使 Marker 在列表中不存在，也会从符合 Marker 字母排序的下一个开始打印。	a
MaxKeys	integer	否	限定此次列举文件的最大个数。取值范围：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

返回参数

名称	类型	描述	示例值
	object
CommonPrefixes	array	如果请求中指定了 Delimiter 参数，则会在返回的响应中包含 CommonPrefixes 元素。该元素表明以 Delimiter 结尾，并有共同前缀的 Object 名称的集合。
	string	如果请求中指定了 Delimiter 参数，则会在返回的响应中包含 CommonPrefixes 元素。该元素表明以 Delimiter 结尾，并有共同前缀的 Object 名称的集合。	不涉及
NextContinuationToken	string	下次列举文件的 ContinuationToken。	CgJiYw--
ContinuationToken	string	此次列举文件操作使用 ContinuationToken。	test1.txt
Delimiter	string	对文件名称进行分组的字符。	/
EncodingType	string	指明返回结果中编码使用的类型。	不涉及
Prefix	string	本次查询结果的前缀。	b
Marker	string	标明本次列举文件的起点。	ceshi.txt1617853707991
BucketName	string	Bucket 名称。	test
Contents	array<object>	Object 元信息列表。
	object
Key	string	Object 名称。	ceshi.txt1617853706546
LastModified	string	Object 最后被修改的时间。	2021-04-08T03:48:47.488Z
ETag	string	ETag 在每个 Object 生成时创建，用于标识一个 Object 的内容。对于 PutObject 请求创建的 Object，ETag 值是其内容的 MD5 值。对于其他方式创建的 Object，ETag 值是其内容的 UUID。 ETag 值可以用于检查 Object 内容是否发生变化。不建议使用 ETag 值作为 Object 内容的 MD5 校验数据完整性的依据。	5B3C1A2E053D763E1B002CC607C5****
Size	integer	Object 的字节数。	15
IsTruncated	boolean	指明列举文件是否被截断。 false：列举完没有截断。 true：没列举完就有截断。	true
KeyCount	integer	此次请求返回的 Key 的个数。	10
NextMarker	string	下一次列举文件的起点。	ceshi.txt1617853707991
MaxKeys	integer	列举文件的最大个数。	10
RequestId	string	请求 ID。	4833C4AC-9396-458C-8F25-1D701334E560

示例

正常返回示例

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.	指定的BucketName参数无效。
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.
400	InvalidArgument	Specified parameter ContinuationToken is incorrect.	设置的ContinuationToken参数不正确。
500	InternalError	The request processing has failed due to some unknown error.
403	AccessDenied	auth is not valid
403	UserDisable	The user has been disabled due to arrears.	该用户因欠费被禁用。
404	NoSuchBucket	The specified bucket does not exist.	请求的目标Bucket不存在。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。