You need to enable JavaScript to run this app.
导航
确认上传
最近更新时间:2024.06.24 10:08:16首次发布时间:2022.12.21 11:32:38

此接口用于在指定空间下,设置会话 ID、提取视频元信息方式、上传函数等参数,确认媒资上传到视频点播的结果。

使用说明

  • 确认上传成功后将返回 Vid 以及媒资基础信息。
  • 完整上传流程可参考媒资上传概述
  • 您可以配置视频上传完成回调通知。当视频上传完成时,您将收到事件回调消息,配置方法详见回调设置

请求说明

请求地址:https://vod.volcengineapi.com?Action=CommitUploadInfo&Version=2022-01-01

调试

请求参数

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

参数
类型
是否必选
示例值
描述
Action
String
CommitUploadInfo
接口名称。当前 API 的名称为 CommitUploadInfo
Version
String
2022-01-01
接口版本。当前 API 的版本为 2022-01-01
SpaceName
String
test

点播空间名称。可通过以下方式获取空间名称:

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
SessionKey
String
eyJleHRyYSI6InM2MjM4Nz*****0ZzEwMDAxY20wa25paHMxdjBocWpnZ2RkODAifQ==
会话 ID。获取上传地址和凭证接口下发。
CallbackArgs
String
Yourcallbackargs
回调时回传参数。通常为客户端上传时,服务端希望透传客户端的一些信息。
GetMetaMode
Integer
1

提取视频元信息的方式。默认为不传或者 0。取值如下:

  • 1:全异步提取的方式。
  • 其他取值:同步+异步提取的方式。
Functions
String
[{"Name":"GetMeta"},{"Name":"AddOptionInfo","Input":{"Title":"视频01.mp4"}},{"Name":"StartWorkflow","Input":{"TemplateId":"8ecbf1ede093407aa9908fe700cedd06"}}]

返回参数

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

参数
类型
示例值
描述
Data
Object
-
媒资信息。
Vid
String
v0dc24g10001c***ihs1v0hqjggdd80

视频 ID。

说明

当请求参数 RecordType 取值为 1(音视频)时,返回此参数。

PosterUri
String
tos-vod-cn-v-03e4d***3112705/视频01_cover
视频对应的封面图 URI。
SourceInfo
Object
-
片源信息。
Md5
String
f6bd77b31cbd***a4687a886df9c8
文件哈希值。
FileType
String
video

文件类型。取值如下:

  • video:视频。
  • audio:音频。
Height
Integer
1080
视频高度,单位为 px。
Width
Integer
2872
视频宽度,单位为 px。
Format
String
MP4
文件格式。
Duration
Float
11.423
时长,单位为秒。
Size
Double
4301565
文件大小,单位为字节。
StoreUri
String
tos-vod-cn-v-03e4d54***112705/视频01.mp4
文件存储位置。
FileName
String
视频01.mp4
文件路径。
Bitrate
Integer
3012564
视频码率,单位为 bps。
Fps
Float
30
帧率,单位为 fps。
VideoStreamMeta
Object
-
视频流元信息。
Codec
String
h264
视频编码格式。
Height
Integer
1080
视频高度,单位为 px。
Width
Integer
2872
视频宽度,单位为 px。
Duration
Float
11.423
视频时长,单位为 s。
Definition
String
unknown
视频清晰度。
Bitrate
Integer
3012564
视频码率,单位为 bps。
Fps
Float
30
帧率。
AudioStreamMeta
Object
-
音频流元信息。
Duration
Float
11.422766
音频时长,单位为 s。
SampleRate
Integer
44100
音频采样率。
Bitrate
Integer
128455
音频码率,单位为 bps。
Mid
String
weyiujweir379***

素材 ID。

说明

当请求参数 RecordType 取值为 2(素材)时,返回此参数。

请求示例 1

音视频上传

https://vod.volcengineapi.com?Action=CommitUploadInfo&Version=2022-01-01&SpaceName=YourSpaceName&SessionKey=ApplyUploadInfoReturnSessionKey&CallbackArgs=""&GetMetaMode=&Functions=[{"Name": "GetMeta"},{"Name":"Snapshot","Input":{"SnapshotTime": 2.0}}]

返回示例 1

{
  "ResponseMetadata": {
    "RequestId": "2020110618300501022509205920011***",
    "Action": "CommitUploadInfo",
    "Version": "2022-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Data": {
      "Vid": "v0c255fa007abu0lc8a0oej77lbbv***",
      "SourceInfo": {
        "StoreUri": "tos-path-v-da1421/49ad5efabc3a4b32bed5df34fa7fd***",
        "Md5": "cf2b56eaa3fe3ec856ec4503a068a***",
        "Width": 960,
        "Height": 540,
        "Duration": 52.036,
        "Bitrate": 2068561,
        "Format": "MP4",
        "Size": 13454959,
        "FileType": "video"
      },
      "PosterUri": "tos-path-v-da1421/3108f4e3298248bda9e5658ae0a52***",
      "CallbackArgs": ""
    }
  }
}

请求示例 2

素材上传-音视频

https://vod.volcengineapi.com?Action=CommitUploadInfo&Version=2022-01-01&SpaceName=YourSpaceName&SessionKey=ApplyUploadInfoReturnSessionKey&CallbackArgs=""&GetMetaMode=&Functions=[{"name":"GetMeta"},{"name":"AddOptionInfo","input":{"Title":"视频01.mp4","Category":"video","FileType":"media","Format":"mp4","RecordType":2}}]

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "20231219194***543B816B334B878A66",
        "Action": "CommitUploadInfo",
        "Version": "2022-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": {
            "SourceInfo": {
                "Md5": "f6bd77b31cbd***4687a886df9c8",
                "FileType": "video",
                "Height": 1080,
                "Width": 2872,
                "Format": "MP4",
                "Duration": 11.423,
                "Size": 4301565,
                "StoreUri": "tos-vod-cn-v-03e4d54***112705/视频01.mp4",
                "Bitrate": 3012564,
                "Fps": 30,
                "VideoStreamMeta": {
                    "Codec": "h264",
                    "Height": 1080,
                    "Width": 2872,
                    "Duration": 11.423,
                    "Definition": "unknown",
                    "Bitrate": 3012564,
                    "Fps": 30
                },
                "AudioStreamMeta": {
                    "Duration": 11.422766,
                    "SampleRate": 44100,
                    "Bitrate": 128455
                },
                "TosStorageClass": "STANDARD",
                "FileName": "视频01.mp4"
            },
            "PosterUri": "tos-vod-cn-v-03e4d5***12705/视频01_cover",
            "Mid": "v02c24g10001cm***s1v0vvbrod9rg"
        }
    }
}

请求示例 3

素材上传-图片

https://vod.volcengineapi.com?Action=CommitUploadInfo&Version=2022-01-01&SpaceName=YourSpaceName&SessionKey=ApplyUploadInfoReturnSessionKey&CallbackArgs=""&GetMetaMode=&Functions=[{"name":"GetMeta"},{"name":"AddOptionInfo","input":{"Title":"03.png","Category":"image","FileType":"image","Format":"png","RecordType":2}}]

返回示例 3

{
    "ResponseMetadata": {
        "RequestId": "2023121919***A1890C411D0907DC666",
        "Action": "CommitUploadInfo",
        "Version": "2022-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": {
            "SourceInfo": {
                "Md5": "7ea8e3d4739d***6546dc9f71ac1d0",
                "Height": 378,
                "Width": 966,
                "Format": "png_pipe",
                "Size": 24221,
                "StoreUri": "tos-vod-cn-v-03e4d54***12705/03.png",
                "FileName": "03.png"
            },
            "Mid": "i0032s8ri4dl***83c77u4bfeg3utg"
        }
    }
}

请求示例 4

如下为素材上传-字幕或者字体示例:

https://vod.volcengineapi.com?Action=CommitUploadInfo&Version=2022-01-01&SpaceName=YourSpaceName&SessionKey=eyJBcHBJRCI6IiIsIkxlZ2FsIjoiIiwiVXNlcklEIjo***MjcwNS/lrZfluZUwMSJ9&CallbackArgs=""&GetMetaMode=&Functions=[{"name":"GetMeta"},{"name":"AddOptionInfo","input":{"Title":"字幕.AAC.ass","Category":"subtitle","FileType":"object","Format":"ass","RecordType":2}}]

返回示例 4

{
    "ResponseMetadata": {
        "RequestId": "2023121919***41C8A3521108088CEEED",
        "Action": "CommitUploadInfo",
        "Version": "2022-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": {
            "SourceInfo": {
                "Size": 228349,
                "StoreUri": "tos-vod-cn-v-03e4d5***112705/字幕01",
                "FileName": "字幕01"
            },
            "Mid": "s00d250hbohsc***jc77u3of8hvsfg"
        }
    }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码,详见视频点播公共错误码

状态码错误码错误信息说明
400InvalidParameter.InvalidAccessKeyError-AK 错误。
400InvalidParameter.InvalidParamError-参数错误,包括 Session 的各个部分错误。
400InvalidParameter.UserNotSupportTosError-账号配置错误
429RequestLimitExceeded.TooManyRequestError-请求超过上限。
400InvalidParameter.InvalidSpaceError-Space 填写错误。
404ResourceNotFound.VideoNotFoundError-未找到对应视频
400InvalidParameter.InvalidTopAccountError-账号无权限。
400InvalidParameter.CategoryMismatchError-素材上传 CategoryFileType 不匹配。
400InvalidParameter.ImageDataProcessError-图片抽取元信息失败时,图片数据处理错误
403RequestForbidden.AccessIsRestricted-账号访问受到限制。
500InternalError.SaveDBError-内部错误。
500InternalError.RunFunctionError-内部错误,执行 Function 时失败。
500InternalError.GetSignError-内部错误,获取上传地址签名失败。
500InternalError.RunPluginError-内部错误,运行插件失败。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API,此 API 各语言调用的示例代码,请参考如下: