获取服务下单个上传文件--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取服务下单个上传文件

最近更新时间：2024.08.13 20:23:50首次发布时间：2024.02.02 16:35:54

通过指定服务 ID 以及已上传的文件 Uri，来获取上传文件的详细信息，如：文件修改时间和文件字节数等。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageUploadFile`	接口名称。当前 API 的名称为 `GetImageUploadFile`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`uk**ok`	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
StoreUri	String	是	`demo.png`	文件 Uri。您可以在 veImageX 控制台资源管理页面，在已上传文件的名称列获取资源 Uri。您也可以通过 OpenAPI 的方式获取Uri，具体请参考 GetImageUploadFiles。

返回参数

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

参数	类型	示例值	描述
ServiceId	String	`h8**0l`	服务 ID。
StoreUri	String	`demo.png`	文件 Uri。
LastModified	String	`2024-01-21 22:13:57`	文件修改时间，即文件修改时的服务器当地时间。
FileSize	Integer	`7749`	文件字节数。
StorageContentType	String	`image/jpeg`	底层存储的 content-type 值。
RestoreExpiryDate	String	`Wed, 24 Jan 2024 00:00:00 GMT`	文件恢复副本的到期时间。仅当文件执行过恢复操作时有值
Restoring	Boolean	`true`	文件是否处于恢复中状态，取值如下所示： `true`：是 `false`：否
StorageClass	String	`IA`	底层存储类型，取值如下所示： `STANDARD`：标准存储 `IA`：低频存储 `ARCHIVE`：归档存储 `COLD_ARCHIVE`：冷归档存储
Disabled	Boolean	`false`	文件是否被封禁，取值如下所示： `true`：禁用状态，该资源无法被访问。 `false`：正常状态，该资源可正常访问。说明仅当指定的 `ServiceId` 开启了资源级别封禁后展示该字段。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageUploadFile&Version=2023-05-01&ServiceId=h8**0l&StoreUri=demo.png
{}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetImageUploadFile",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "ServiceId": "h8**0l",
        "StoreUri": "demo.png",
        "LastModified": "2024-01-21 22:13:57",
        "FileSize": 7749,
        "StorageContentType": "image/jpeg",
        "RestoreExpiryDate": "Wed, 24 Jan 2024 00:00:00 GMT",
        "Restoring": true,
        "StorageClass": "IA",
        "Disabled": false
    }
}

错误码

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

服务端 SDK

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

历史版本

2018-08-01 版本 GetImageUploadFile 接口文档现已停止维护，建议您参考本文档使用最新版本。