此接口用于确认媒资上传到视频点播的结果。确认上传成功，将返回 Vid 以及媒资基础信息。了解完整上传流程可参考媒资上传概述。您可以配置开启视频上传完成回调通知，开启后当视频上传完成，您将收到事件回调消息，配置方法详见回调设置。

请求说明 #

• 接口名称：CommitUploadInfo
• 接口地址：https://vod.volcengineapi.com/?Action=CommitUploadInfo&Version=2020-08-01

请求参数 #

Functions 为可扩展的 json 数组，比如：

'Functions':[{
                "Name": "Snapshot", 
                "Input":{
                        "SnapshotTime": 2.0
                }},
                {
                "Name": "xxx",
                        "Input":{}
                }
        ]

Functions 列表 #

注意事项

当素材上传时，需要注意 Function 的顺序。当有 GetMeta 的 Function 时，要放在最前面。代码示例如下所示。

Functions:[{"Name":"GetMeta"},{"Name":"Snapshot","Input":{"SnapshotTime":0}},{"Name":"AddOptionInfo","Input":{"Title":"测试素材","Tags":"test","Description":"测试素材：字幕文件","Category":"subtitle","RecordType":2,"Format":"vtt"}}]

SnapshotInput #

OptionInfo #

获取上传地址凭证中 FileType 取值和 Category 对应关系如下表所示。

WorkflowInput #

返回参数 #

ResponseMetadata #

ResponseError #

VodCommitUploadInfoResult #

VodCommitUploadInfoData #

VodSourceInfo #

VodVideoStreamMeta #

VodAudioStreamMeta #

示例 #

音视频上传 #

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2020110618300501022509205920011***",
        "Action": "CommitUploadInfo",
        "Version": "2020-08-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&CallbackArgs=my callback&Functions=[{"Name":"GetMeta","Input":null},{"Name":"AddOptionInfo","Input":{"Title":"素材测试视频","Tags":"test","Description":"素材测试，视频文件","Category":"video","RecordType":2,"Format":"mp4"}}]&SessionKey=ApplyUploadInfoReturnSessionKey&SpaceName=YourSpaceName&Version=2020-08-01

返回示例

{
    "ResponseMetadata":{
        "RequestId":"202105081616520102040500970B000***",
        "Action":"CommitUploadInfo",
        "Version":"2020-08-01",
        "Service":"vod",
        "Region":"cn-north-1"
    },
    "Result":{
        "Data":{
            "Mid":"v02a36g10000c2b4hr46u54rsoatp***",
            "SourceInfo":{
                "StoreUri":"tos-path-v-da1421/1b4df71b655b4e2c9612659adc685***",
                "Md5":"3845d3fb09755e551f2b7ffb2739c0b6",
                "Width":540,
                "Height":960,
                "Duration":36.16,
                "Bitrate":975999,
                "Format":"MP4",
                "Size":4411516,
                "FileType":"video"
            },
            "CallbackArgs":"my callback"
        }
    }
}

素材上传-图片 #

请求示例

https://vod.volcengineapi.com/?Action=CommitUploadInfo&CallbackArgs=my callback&Functions=[{"Name":"GetMeta","Input":null},{"Name":"AddOptionInfo","Input":{"Title":"素材测试图片","Tags":"test","Description":"素材测试，图片文件","Category":"image","RecordType":2,"Format":"jpg"}}]&SessionKey=ApplyUploadInfoReturnSessionKey&SpaceName=YourSpaceName&Version=2020-08-01

返回示例

{
    "ResponseMetadata":{
        "RequestId":"202105081731060102251070930A01B***",
        "Action":"CommitUploadInfo",
        "Version":"2020-08-01",
        "Service":"vod",
        "Region":"cn-north-1"
    },
    "Result":{
        "Data":{
            "Mid":"i00c1li97hy2c2b5kmjc77u5vb34udm0",
            "SourceInfo":{
                "StoreUri":"tos-path-v-da1421/33f809756c3549cbbc9f3b2214e7d***",
                "Md5":"e521c9e25296f10fd3ac996cfe930***",
                "Width":720,
                "Height":1280,
                "Format":"jpeg",
                "Size":93371
            },
            "CallbackArgs":""
        }
    }
}

素材上传-字幕/字体 #

请求示例

https://vod.volcengineapi.com/?Action=CommitUploadInfo&CallbackArgs=my callback&Functions=[{"Name":"GetMeta","Input":null},{"Name":"AddOptionInfo","Input":{"Title":"素材测试字幕","Tags":"test","Description":"素材测试，字幕文件","Category":"subtitle","RecordType":2,"Format":"vtt"}}]&SessionKey=ApplyUploadInfoReturnSessionKey&SpaceName=YourSpaceName&Version=2020-08-01

返回示例

{
    "ResponseMetadata":{
        "RequestId":"202105081734110102251070930A000***",
        "Action":"CommitUploadInfo",
        "Version":"2020-08-01",
        "Service":"vod",
        "Region":"cn-north-1"
    },
    "Result":{
        "Data":{
            "Mid":"s00c1ukl07ahc2b5m4rc77u5vb34u***",
            "SourceInfo":{
                "StoreUri":"tos-path-v-da1421/000d2e4070b542c69f8048921c0c9***",
                "Md5":"5cede5d5ef20c351873bc0273da1d***",
                "Size":1326
            },
            "CallbackArgs":""
        }
    }
}

错误码 #

下表列举了本接口特有的错误码。视频点播公共错误码，详见 公共错误码。

SDK #

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

• Java
• Python
• PHP
• Go
• Node.js