预览服务下的文件--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

预览服务下的文件

最近更新时间：2024.08.20 10:48:12首次发布时间：2024.08.20 10:48:12

本接口支持获取指定服务下存储文件的详细信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`PreviewImageUploadFile`	接口名称。当前 API 的名称为 `PreviewImageUploadFile`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`8h**9q`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
StoreUri	String	是	`tos-cn-i-8h**9q/imagexdemo.heif`	文件存储 URI。您可以在 veImageX 控制台资源管理页面，在已上传文件的名称列获取。您也可以通过 OpenAPI 的方式获取，具体请参考获取服务下的上传文件。

返回参数

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

参数	类型	示例值	描述
ServiceId	String	`8h**9q`	服务 ID。
StoreUri	String	`tos-cn-i-8h**9q/imagexdemo.heif`	文件存储 URI。
ImageFormat	String	`jpeg`	图片格式。
ImageSize	Integer	`64859`	图片大小，单位为字节。
ImageWidth	Integer	`1023`	图片宽度。
ImageHeight	Integer	`683`	图片高度。
ImageFrames	Integer	`20`	图片帧数。
ImageDuration	Integer	`6`	图片播放时间，单位为毫秒，仅当图片为动态图时返回。
StorageContentType	String	`image/heif`	图片的 Content-Type 值。

请求示例

GET https://imagex.volcengineapi.com/?Action=PreviewImageUploadFile&Version=2023-05-01&ServiceId=8h**9q&StoreUri=tos-cn-i-8h**9q/imagexdemo.heif

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "PreviewImageUploadFile",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "ServiceId": "8h**9q",
        "StoreUri": "tos-cn-i-8h**9q/imagexdemo.heif",
        "ImageFormat": "jpeg",
        "ImageSize": 64859,
        "ImageWidth": 1023,
        "ImageHeight": 683,
        "ImageFrames": 20,
        "ImageDuration": 6,
        "StorageContentType": "image/heif"
    }
}

错误码

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

服务端 SDK

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

历史版本

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