确认上传并上报上传结果--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

确认上传并上报上传结果

最近更新时间：2024.01.31 15:19:58首次发布时间：2021.02.23 10:42:24

本接口用于确认文件上传到 veImageX 的结果。确认文件上传成功，并向您返回上传结果。具体上传流程请参考服务端上传。

说明

强烈不建议您依赖本接口返回的图片 meta 信息，有获取 meta 需求推荐在上传完成后拼接~info模板获取图片 meta 信息。原因请见为什么不建议依赖 Commit 阶段返回的图片 meta 信息？

注意事项

请求频率：单业务（服务 ID）请求频率限制为 100 次/秒
超时时间：超时时间为 5 秒

请求说明

请求方式：POST
接口地址：https://imagex.volcengineapi.com/?Action=CommitImageUpload&Version=2018-08-01

说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CommitImageUpload`	接口名称。`CommitImageUpload`
Version	String	是	`2018-08-01`	接口版本
ServiceId	String	是	`kjh***9h`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
SkipMeta	Bool	否	`true`	是否返回图片 meta 信息。 `true`：不返回图片 meta 信息。 `false`：（默认）获取图片 meta 信息并返回对应 meta 信息。说明其中若 meta 获取超时或失败，接口返回成功，但对应 meta 信息将为空。如果您的业务要求必须获取 meta 信息，请您参考图片Meta信息获取。

Body

参数	类型	是否必选	示例值	描述
SessionKey	String	是	`8h***98`	一次上传会话 Key。您可参考获取文件上传地址获取。
SuccessOids	Array of String	否	`101629**510102`	上传成功的资源 ID。

返回参数

参数	类型	示例值	描述
Results	Array of Result	`1`	运行结果，数组长度对应上传的数量。
RequestId	String	`202307031500195F***DCD5E1`	请求的唯一标识 ID。
PluginResult	String		JSON 序列化之后的图片信息，结构体请参考 ImageInfo 的 Array。

Result

参数类型示例值描述

参数	类型	示例值	描述
Uri	String	`tos-cn-i-5sfo/f29a.png`	源文件的 Uri。
UriStatus	Integer	`2000`	仅当指定 `SuccessOids` 时才会有返回值。上传结果。返回值为 2000，表示上传成功；返回值为 2001，表示上传失败。

Uri

String

tos-cn-i-5s**fo/f2**9a.png

源文件的 Uri。

UriStatus

Integer

2000

仅当指定 SuccessOids 时才会有返回值。
上传结果。

返回值为 2000，表示上传成功；
返回值为 2001，表示上传失败。

ImageInfo

参数	类型	示例值	描述
FileName	String	`f2**9a.png`	存储文件名
SourceUri	String	`tos-cn-i-5sfo/f29a.png`	源文件 URI
ImageUri	String	`tos-cn-i-5sfo/f219a.png`	源文件 URI
ImageWidth	Integer	`2718`	图片的宽
ImageHeight	Integer	`1300`	图片的高
ImageMd5	String	`9683`	图片的 MD5 值
ImageFormat	String	`png`	图片格式
ImageSize	Integer	`108886`	图片大小
FrameCnt	Integer	`1`	图片帧数
Duration	Integer	`3500`	图片时长，单位为 ms。仅当图片为动图时有值

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CommitImageUpload&Version=2018-08-01&ServiceId=WM**e8&SkipMeta=true 
{
   "SessionKey":"eyJ***==",
}

返回示例

{
   "ResponseMetadata":{
      "RequestId":"202307031500195F01AEFDB6AC1CDCD5E1",
      "Action":"CommitImageUpload",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
      "Results":[
         {
            "Uri":"tos-cn-i-5sfo/f29a.png",
            "UriStatus":2000
         }
      ],
      "RequestId":"202307031500195F01AEFDB6AC1CDCD5E1",
      "PluginResult":[
         {
            "FileName":"f2**9a.png",
            "SourceUri":"tos-cn-i-5sfo/f29a.png",
            "ImageUri":"tos-cn-i-5sfo/f219a.png",
            "ImageWidth":2718,
            "ImageHeight":2300,
            "ImageMd5":"9683",
            "ImageFormat":"png",
            "ImageSize":108886,
            "FrameCnt":1
         }
      ]
   }
}

错误码

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

服务端 SDK

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