接口功能介绍
用户可在托管模式/点播模式下通过本接口向云点播获取指定ID的拼接模板详情。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。
URI
POST /stitching/template/get
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| templateId | 是 | Long | 拼接模板ID | 100000023685 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次请求的结果码。 | 0 | |
| message | 是 | String | 错误文本信息，执行成功时，为空字符串。 | "" | |
| data | 是 | Object | 返回数据。 | data |
表 data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 是 | Long | 模板ID | 100000023685 | |
| name | 是 | String | 模板名称 | 测试拼接模板1 | |
| head | 是 | Array of Objects | 片头 | head | |
| tail | 是 | Array of Objects | 片尾 | tail | |
| video | 是 | String | 视频编码 | video | |
| audio | 是 | String | 音频编码 | audio | |
| remark | 是 | String | 备注 | 这是一个测试用的视频拼接模板 |
表 head
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ID | 是 | String | 视频ID | af1c37d7c06740d98fb9dd6f76992435 | |
| bucket | 是 | String | 存储桶名称 | vod-origin-xxxx | |
| name | 是 | String | 视频名称 | head.mp4 | |
| regionCode | 是 | String | 视频存储的区域编码 | 09871 | |
| regionName | 是 | String | 视频存储的区域名称 | 广东资源池1区 | |
| source | 是 | String | 视频存储类型 | VOD |
表 tail
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ID | 是 | String | 视频ID | af1c37d7c06740d98fb9dd6f76992435 | |
| bucket | 是 | String | 存储桶名称 | vod-origin-xxxx | |
| name | 是 | String | 视频名称 | head.mp4 | |
| regionCode | 是 | String | 视频存储的区域编码 | 09871 | |
| regionName | 是 | String | 视频存储的区域名称 | 广东资源池1区 | |
| source | 是 | String | 视频存储类型 | VOD |
表 video
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| follow | 是 | Boolean | 是否跟随主视频 | true | |
| bitRate | 是 | String | 主视频视频部分预设码率 | 512kb | |
| height | 是 | Integer | 主视频预设分辨率高度 | 1024 | |
| width | 是 | Integer | 主视频预设分辨率宽度 | 768 |
表 audio
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| remove | 是 | Boolean | 是否去除音轨。false-保留音轨并按需填充空音频流，true-去除音频。 | false | |
| bitRate | 是 | String | 主视频音频部分预设码率，建议从以下值选择输入 128K/192K/256K/320K，>=128k,<=10000k。 | 128kb |
请求示例
请求体body
{
"templateId": 100000023685
}
响应示例
{
"code": "0",
"message": "",
"data": {
"audio": "{\"remove\":false,\"bitRate\":\"128k\"}",
"createTime": 1695864988000,
"head": [
{
"ID": "687fa23e5827491ea43cdbd6be0e646a.mp4",
"bucket": "vod-origin-xxxx",
"name": "687fa23e5827491ea43cdbd6be0e646a.mp4",
"regionCode": "0210001",
"regionName": "上海资源池1区",
"source": "VOD"
}
],
"id": 100000023685,
"name": "testnew",
"remark": "testNew",
"tail": [
{
"ID": "687fa23e5827491ea43cdbd6be0e646a.mp4",
"bucket": "vod-origin-xxxx",
"name": "687fa23e5827491ea43cdbd6be0e646a.mp4",
"regionCode": "0210001",
"regionName": "上海资源池1区",
"source": "VOD"
}
],
"templateState": "F0A",
"updateTime": 1695864988000,
"video": "{\"follow\":true,\"bitRate\":\"128k\",\"height\":0,\"width\":0}"
}
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败，用户无操作权限 | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | 请求的资源不存在，输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。
