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

文档中心

veImageX

资源管理

确认上传并上报上传结果

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

说明

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

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CommitImageUpload`	接口名称。当前 API 的名称为 `CommitImageUpload`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	`WM***Xed`	服务 ID。可通过以下任一方式获取。在服务管理页面，获取服务 ID。调用 GetAllImageServices 接口，获取服务 ID。
SkipMeta	Boolean	否	`false`	文件上传成功后，是否跳过图片 meta 信息获取。默认值为 `false`。取值如下： `true`：跳过信息获取，即不返回图片 meta 信息。 `false`：不跳过信息获取，即返回图片 meta 信息。说明如果图片 meta 信息获取超时或失败，接口返回成功，但对应 meta 信息为空。如果您的业务要求必须获取 meta 信息，请您参考图片Meta信息获取。
ForceMeta	Boolean	否	`true`	文件上传成功后，是否强制获取图片 meta 信息。默认值为 `false`。取值如下： `true`：强制获取，即返回图片 meta 信息。 `false`：不强制获取，即不返回图片 meta 信息。说明该参数优先级高于 `SkipMeta`。如果图片 meta 信息获取超时或失败，接口返回失败，对应 meta 信息为空。如果您的业务要求必须获取 meta 信息，请您参考图片Meta信息获取。

Body

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

返回参数

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

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

Results

参数类型示例值描述

Uri String tos-cn-i-5s**fo/a.png 源图片的 Uri。

参数	类型	示例值	描述
Uri	String	`tos-cn-i-5s**fo/a.png`	源图片的 Uri。
UriStatus	Integer	`200`	上传结果。传入 SuccessOids 时，无论上传图片/非图片，成功返回 2000，失败返回 2001；未传入 SuccessOids 时，对于非图片返回 0；对于图片，成功返回 2000，失败返回 2001。

UriStatus

Integer

200

上传结果。

传入 SuccessOids 时，无论上传图片/非图片，成功返回 2000，失败返回 2001；
未传入 SuccessOids 时，对于非图片返回 0；对于图片，成功返回 2000，失败返回 2001。

PluginResult

参数	类型	示例值	描述
FileName	String	`f2**9a.png`	图片文件名。
SourceUri	String	`tos-cn-i-5sfo/b.png`	源文件 URI
ImageUri	String	`tos-cn-i-5sfo/c.png`	图片 Uri。
ImageWidth	Integer	`2718`	图片的宽。
ImageHeight	Integer	`1300`	图片的高。
ImageMd5	String	`e10adc3949ba59****56e057f20f883e`	图片的 `MD5` 哈希值。
ImageFormat	String	`png`	图片格式。
ImageSize	Integer	`1024`	图片的大小。
FrameCnt	Integer	`5`	图片的帧数量。
Duration	Integer	`3500`	图片时长，单位为 ms。仅当图片为动图时有值
Orientation	Object of Orientation	`-`	图片旋转信息。
ColorModel	String	`ycbcr`	颜色模型。
ImageAve	String	`#88867b`	主题颜色。

Orientation

参数类型示例值描述

Rotation Integer 90 旋转角度。

参数	类型	示例值	描述
Rotation	Integer	`90`	旋转角度。
Fliph	Boolean	`true`	是否水平翻转。取值如下： `true`：水平翻转。 `false`：未水平翻转。
Flipv	Boolean	`true`	是否垂直翻转。取值如下： `true`：垂直翻转。 `false`：未垂直翻转。

Fliph

Boolean

true

是否水平翻转。取值如下：

true：水平翻转。
false：未水平翻转。

Flipv

Boolean

true

是否垂直翻转。取值如下：

true：垂直翻转。
false：未垂直翻转。

请求示例

POST https://imagex.volcengineapi.com/?Action=CommitImageUpload&Version=2018-08-01&ServiceId=WM***Xed&SkipMeta=false&ForceMeta=true
{
    "SessionKey": "8h***98",
    "SuccessOids": [
        "101629**510102"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CommitImageUpload",
        "Version": "2018-08-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Results": [
            {
                "Uri": "tos-cn-i-5s**fo/a.png",
                "UriStatus": 200
            }
        ],
        "PluginResult": [
            {
                "FileName": "f2**9a.png",
                "ImageUri": "tos-cn-i-5sfo/c.png",
                "ImageHeight": 1300,
                "ImageMd5": "e10adc3949ba59****56e057f20f883e",
                "ImageWidth": 2718,
                "ImageFormat": "png",
                "ImageSize": 1024,
                "FrameCnt": 5,
                "Duration": 3500,
                "SourceUri": "tos-cn-i-5sfo/b.png",
                "Orientation": {
                    "Rotation": 90,
                    "Fliph": true,
                    "Flipv": true
                },
                "ColorModel": "ycbcr",
                "ImageAve": "#88867b"
            }
        ],
        "RequestId": "202307031500195F***DCD5E1"
    }
}

错误码

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

服务端 SDK

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

最近更新时间：2026.01.20 17:37:49

这个页面对您有帮助吗？

有用

无用

veImageX

注意事项 #

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

Results #

PluginResult #

Orientation #

请求示例 #

返回示例 #

错误码 #

服务端 SDK #