You need to enable JavaScript to run this app.
导航

预览服务下的文件

最近更新时间2024.01.31 15:19:58

首次发布时间2021.02.23 10:42:24

通过指定服务 ID 以及上传文件 Uri,来获取指定文件的详细信息。

请求说明

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

说明

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

请求参数

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

Query

参数类型是否必选描述
ActionString接口名称。
VersionString接口版本。veImageX 当前 API 的版本为 2018-08-01

ServiceId

String

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息

StoreUri

String

文件 Uri。

  • 您可以在 veImageX 控制台 资源管理页面,在已上传文件的名称列获取资源 Uri。
  • 您也可以通过 OpenAPI 的方式获取Uri,具体请参考文件上传完成上报

返回参数

参数类型描述
ServiceIdString服务 ID。
StoreUriString文件 Uri。
ImageFormatString图片格式。
ImageSizeInteger图片字节数。
ImageWidthInteger图片宽度。
ImageHeightInteger图片高度。
ImageFramesInteger图片帧数。
ImageDurationInteger图片播放时间,单位为毫秒,仅当图片为动态图时返回。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=PreviewImageUploadFile&Version=2018-08-01&ServiceId=fc51f8f9*&StoreUri=xxx 

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "PreviewImageUploadFile",
        "Version": "2018-08-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "ServiceId": "fc51f8f98",
        "StoreUri": "xxx",
        "ImageFormat": "JPEG",
        "ImageSize": 12345,
        "ImageWidth": 1024,
        "ImageHeight": 768,
        "ImageFrames": 1
    }
}

异常返回示例

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

错误码

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