文档中心

列举服务下的文件

最近更新时间：2024.03.11 13:08:16

首次发布时间：2023.10.19 15:56:24

本接口列举并返回服务对应存储下的全量资源，并按照 Key 的字典序返回。列举资源包括您自行上传的资源，以及您开通持久化后 veImageX 通过服务持久化存储的资源。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间约为 20 秒。
子目录列举说明：当 Delimiter 为空时，对于 2023 年 2 月 16 日之后新增服务，item 中返回包含存储资源子目录的文件；对于其他服务，CommonPrefix 返回的是子目录列表，子目录下包含的文件需要递归调用接口指定 Prefix 去获取。

说明

您可在 veImageX 控制台的服务管理查看各服务的创建时间。
您也可以通过调用 GetAllImageServices 根据 CreateAt 参数查看各服务创建时间。

服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetImageStorageFiles&Version=2018-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageStorageFiles`	接口名称。当前 API 的名称为 `GetImageStorageFiles`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	`8h**0o`	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
Marker	String	否	`eyJjIjowLCJrIjoiMDAwMDAyLmljbyJ9`	上一次列举返回的位置标记，作为本次列举的起点信息。默认值为空。
Limit	Long	否	`1000`	一次查询列出的文件信息条目数，取值范围为[1,1000]。默认值为 10。
Prefix	String	否	`Example/`	指定需要查询文件的前缀，只有资源名匹配该前缀的文件会被列出。缺省时将返回所有文件信息。例如，一个存储服务中有三个文件，分别为 Example/imagex.png、Example/mov/a.avis 和 Example/mov/b.avis。若指定 `Prefix` 取值 `Example/`且指定 `Delimiter` 取值 `/`：则返回 Example/imagex.png，并在 `CommonPrefix` 里返回 Example/mov/。
Delimiter	String	否	`/`	指定目录分隔符，默认值为空。所有文件名字包含指定的前缀，第一次出现 `Delimiter` 字符之间的文件作为一组元素（即 `CommonPrefixe`）。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Items	Array of Items	`-`	文件列表
Marker	String	`eyJjIjowLCJrIjoiMDAwMDAyLmljbyJ9`	`HasMore` 取值 `true` 时，即本次查询还有未列举到的文件信息时。`Marker` 作为起始条目位置标记，您需要在下一次列举时传入该值。
HasMore	Boolean	`true`	是否还有更多文件，取值如下所示： `true`：是，还有文件信息未列出 `false`：否，已列出所有文件信息
CommonPrefix	Array of String	`["Example/mov/"]`	返回目录名称的数组集合。

Items

参数	类型	示例值	描述
StoreUri	String	`tos-cn-i-5s**fo/Example/imagex.png`	文件存储 URI
Key	String	`Example/imagex.png`	文件存储 Key
LastModified	String	`Fri, 01 Sep 2023 06:52:37 GMT`	文件最后修改时间，RFC 时间格式。
FileSize	Integer	`837`	文件大小，单位为 byte。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageStorageFiles&Version=2018-08-01&ServiceId=8h**0o&Marker=eyJjIjowLCJrIjoiMDAwMDAyLmljbyJ9&Limit=1000&Prefix=Example/&Delimiter=/

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetImageStorageFiles",
    "Version": "2018-08-01",
    "Service": "ImageX",
    "Region": "cn-north-1"
  },
  "Result": {
    "Items": [
      {
        "StoreUri": "tos-cn-i-5s**fo/Example/imagex.png",
        "Key": "Example/imagex.png",
        "LastModified": "Fri, 01 Sep 2023 06:52:37 GMT",
        "FileSize": 837
      }
    ],
    "HasMore": true,
    "CommonPrefix": [
      "Example/mov/"
    ],
    "Marker": "eyJjIjowLCJrIjoiMDAwMDAyLmljbyJ9"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，建议您使用服务端 SDK 来调用 API。