获取服务下的上传文件列表--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取服务下的上传文件列表

最近更新时间：2024.08.22 15:39:06首次发布时间：2021.02.23 10:42:24

通过指定服务 ID，获取当前服务下的上传文件信息。

说明

最多可返回 1000 条上传文件信息。

请求说明

接口名称：GetImageUploadFiles
请求方式：GET
接口地址示例：https://imagex.volcengineapi.com/?Action=GetImageUploadFiles&Version=2018-08-01
请求频率限制：10 次/秒
超时时间：20 秒

说明

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

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
Limit	Integer	否	获取文件个数，最大值为 1000。
Marker	Integer	否	分页标志。

返回参数

参数	类型	描述
ServiceId	String	服务 ID。
FileObjects	Array of FileObjects	上传文件信息。
Status	String	当前存储状态，取值为：正常、未审核、禁用。
hasMore	Bool	是否还有下页数据。

FileObjects

参数	类型	描述
StoreUri	String	文件 Uri。
Key	String	资源 Key。
LastModified	String	文件修改时间，文件修改时的服务器当地时间。
FileSize	Integer	文件字节数。
Marker	Integer	分页标志。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageUploadFiles&Version=2018-08-01&ServiceId=fc51f8f9x*

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetImageUploadFiles",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "ServiceId": "fc51f8f9*",
        "FileObjects": [
            {
                "StoreUri": "xxx",
                "LastModified": "2018-05-09 17:44:40",
                "FileSize": 12345,
                "Marker": 125
            }
        ],
        "Status": "正常",
        "hasMore": true
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetImageUploadFiles",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
        "Error": {
            "Code": "RetrieveUploadFilesFailure",
            "Message": "Service not found."
        }
    }
}

错误码

访问公共错误码获取详细信息。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：