查看文件版本信息--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

查看文件版本信息

最近更新时间：2024.11.15 13:33:59首次发布时间：2024.11.15 13:33:59

本接口支持查询存储文件的历史版本信息。

注意事项

请求频率：单用户请求频率限制为 100 次/秒。
超时时间：超时时间为 20 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetImageStorageVersionFiles&Version=2023-05-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageStorageVersionFiles`	接口名称。当前 API 的名称为 `GetImageStorageVersionFiles`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`test`	指定查询的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
Prefix	String	否	`Example/`	指定查询文件的前缀。
Delimiter	String	否	`/`	指定需要查询文件的前缀，只有资源名匹配该前缀的文件会被列出。缺省时将返回所有文件信息。如果将 prefix 设为文件夹名称后，再把 delimiter 设置为正斜线（/），则只返回该文件夹下的文件，该文件夹下的子文件名在 CommonPrefixes 中返回，子文件夹下递归的文件和文件夹不显示。例如，一个存储服务中有三个文件，分别为 Example/imagex.png、Example/mov/a.avis 和 Example/mov/b.avis。若指定 Prefix 取值 Example/且指定 Delimiter 取值 `/`。则返回 Example/imagex.png，并在 CommonPrefix 里返回 Example/mov/。
Limit	Long	否	`10`	一次查询列出的文件信息条目数，取值范围为 [1,1000]。默认值为 10。
KeyMarker	String	否	`demo.png`	列举多版本对象的起始位置。设定从该值之后按字母排序返回对象列表。通常为上次请求返回的 NextKeyMarker 值。
VersionIdMarker	String	否	`57018BBB397AFFF45386`	与 KeyMarker 配合使用，设定从该值之后按字典排序返回多版本对象列表。从上次列举结果中 NextVersionIDMarker 获取。

返回参数

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

参数	类型	示例值	描述
Versions	Array of Versions	`-`	版本文件信息列表
DeleteMarkers	Array of DeleteMarkers	`-`	删除标记信息列表
NextKeyMarker	String	`demo.png`	`HasMore` 取值 `true` 时，即本次查询还有未列举到的文件信息时。NextKeyMarker 作为起始条目位置标记，您需要在下一次列举时传入该值，作为列举多版本对象的起始位置。
NextVersionIDMarker	String	`57018BBB397AFFF45386`	与 NextKeyMarker 配合使用，设定从该值之后按字典排序返回多版本对象列表
HasMore	Boolean	`true`	是否还有更多文件，取值如下所示： `true`：是，还有文件信息未列出 `false`：否，已列出所有文件信息
CommonPrefix	Array of String		返回目录名称的数组集合。

Versions

参数	类型	示例值	描述
Key	String	`demo.png`	文件的存储 Key
LastModified	String	`2024-08-07T10:42:01Z`	更新时间
FileSize	Integer	`7749`	文件大小
StorageClass	String	`IA`	存储类型
IsLatest	Boolean	`true`	是否是最新版本，取值如下所示： `true`：是，当前文件是最新版本 `false`：否，当前文件为历史版本
Version	String	`56F463B54F5E29003F2D`	文件的版本 ID

DeleteMarkers

参数	类型	示例值	描述
Key	String	`demo.png`	被标记删除的文件的存储 Key
LastModified	String	`2024-08-07T10:42:02Z`	最新更新时间
IsLatest	Boolean	`false`	是否是最新版本，取值如下所示： `true`：是，当前文件是最新版本 `false`：否，当前文件为历史版本
Version	String	`56F463DEC1E284507C12`	文件的版本 ID

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageStorageVersionFiles&Version=2023-05-01&ServiceId=test

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageStorageVersionFiles",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Versions": [
            {
                "Key": "demo.png",
                "LastModified": "2024-08-07T10:42:01Z",
                "FileSize": 7749,
                "StorageClass": "IA",
                "IsLatest": true,
                "Version": "56F463B54F5E29003F2D"
            }
        ],
        "DeleteMarkers": [
            {
                "LastModified": "2024-08-07T10:42:02Z",
                "IsLatest": true,
                "Key": "demo.png",
                "Version": "56F463DEC1E284507C12"
            }
        ],
        "NextKeyMarker": "demo.png",
        "NextVersionIDMarker": "57018BBB397AFFF45386",
        "HasMore": true,
        "CommonPrefix": [
            ""
        ]
    }
}

错误码

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