最近更新时间:2024.01.18 11:54:19
首次发布时间:2022.12.21 11:32:38
此接口用于确认媒资上传到视频点播的结果。
请求地址: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 | 是 |
| 点播空间名称。可通过以下方式获取空间名称: |
SessionKey | String | 是 | eyJleHRyYSI6InM2MjM4Nz*****0ZzEwMDAxY20wa25paHMxdjBocWpnZ2RkODAifQ== | 会话 ID。获取上传地址和凭证接口下发。 |
CallbackArgs | String | 否 | Yourcallbackargs | 回调时回传参数。通常为客户端上传时,服务端希望透传客户端的一些信息。 |
GetMetaMode | Integer | 否 |
| 提取视频元信息的方式。默认为不传或者 0。取值如下:
|
Functions | String | 否 | [{"Name":"GetMeta"},{"Name":"AddOptionInfo","Input":{"Title":"视频01.mp4"}},{"Name":"StartWorkflow","Input":{"TemplateId":"8ecbf1ede093407aa9908fe700cedd06"}}] | 详见上传功能函数说明。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Object of Data | - | 返回信息 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Vid | String |
| 视频 ID。 说明 当请求参数 |
PosterUri | String | tos-vod-cn-v-03e4d***3112705/视频01_cover | 视频对应的封面图 URI。 |
SourceInfo | Object of SourceInfo | - | 视频元信息。 |
Mid | String |
| 素材 ID。 说明 当请求参数 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
FileId | String | 83745893fdsfh*** | 文件 ID。 |
Md5 | String | f6bd77b31cbd***a4687a886df9c8 | 文件哈希值。 |
FileType | String |
| 文件类型。取值如下:
|
Height | Integer | 1080 | 视频高度,单位为 px。 |
Width | Integer | 2872 | 视频宽度,单位为 px。 |
Format | String | MP4 | 文件格式。 |
Duration | Float | 11.423 | 时长,单位为 s。 |
Size | Double | 4301565 | 文件大小,单位为字节。 |
StoreUri | String | tos-vod-cn-v-03e4d54***112705/视频01.mp4 | 存储地址。 |
FileName | String | 视频01.mp4 | 文件路径。 |
Bitrate | Integer | 3012564 | 视频码率,单位为 bps。 |
Fps | Float | 30 | 帧率。 |
VideoStreamMeta | Object of VideoStreamMeta | - | 视频流信息。 |
AudioStreamMeta | Object of AudioStreamMeta | - | 音频流信息。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 | 帧率。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Duration | Float | 11.422766 | 音频时长,单位为 s。 |
SampleRate | Integer | 44100 | 音频采样率。 |
Bitrate | Integer | 128455 | 音频码率,单位为 bps。 |
音视频上传
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}}]
{ "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": "" } } }
素材上传-音视频
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}}]
{ "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" } } }
素材上传-图片
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}}]
{ "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" } } }
如下为素材上传-字幕或者字体示例:
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}}]
{ "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" } } }
本接口无特有的错误码。更多信息请见公共错误码。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.InvalidAccessKeyError | - | AK 错误。 |
400 | InvalidParameter.InvalidParamError | - | 参数错误,包括 Session 的各个部分错误。 |
400 | InvalidParameter.UserNotSupportTosError | - | 账号配置错误 |
429 | RequestLimitExceeded.TooManyRequestError | - | 请求超过上限。 |
400 | InvalidParameter.InvalidSpaceError | - | Space 填写错误。 |
404 | ResourceNotFound.VideoNotFoundError | - | 未找到对应视频 |
400 | InvalidParameter.InvalidTopAccountError | - | 账号无权限。 |
400 | InvalidParameter.CategoryMismatchError | - | 素材上传 Category 与 FileType 不匹配。 |
400 | InvalidParameter.ImageDataProcessError | - | 图片抽取元信息失败时,图片数据处理错误 |
403 | RequestForbidden.AccessIsRestricted | - | 账号访问受到限制。 |
500 | InternalError.SaveDBError | - | 内部错误。 |
500 | InternalError.RunFunctionError | - | 内部错误,执行 Function 时失败。 |
500 | InternalError.GetSignError | - | 内部错误,获取上传地址签名失败。 |
500 | InternalError.RunPluginError | - | 内部错误,运行插件失败。 |
点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API,此 API 各语言调用的示例代码,请参考如下: