# 点播接口文档 ## 点播接口文档 ## 简介 **标题**：点播API接口文档 **简介**：点播系统对外API接口文档 **接口路径**：/v2/api-docs ## 上传视频接口 ### 上传视频接口 **接口说明**:上传视频接口(登记视频信息，并以 POST 的方式上传视频) **接口地址**:`/vod/v1/video/upload/post` **请求方式**：`post` **consumes**:`["multipart/form-data"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | ------------------ | ------------------------------------------------------------------------------------------------------------- | -------- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | audioBitRate | 音频码率：Kbps | query | false | integer | | | audioChannelLayout | 音频声道：stereo | query | false | string | | | audioChannels | 音频声道数：2 | query | false | integer | | | audioCodecName | 音频解码库：aac | query | false | string | | | audioProfile | 音频配置：HE-AAC | query | false | string | | | audioSampleFmt | 音频采样格式：fltp | query | false | string | | | audioSampleRate | 音频采样率：22050 | query | false | integer | | | categoryId | 所属分类ID | query | false | integer | | | coverBucketName | 封面图片所在的空间或者组名 | query | false | string | | | coverFileName | 封面图片文件名 | query | false | string | | | coverStorageSystem | 封面图片使用的存储系统 | query | false | string | | | deptId | 所属部门ID | query | false | integer | | | description | 视频描述 | query | false | string | | | displayAspectRatio | 显示宽高比：16:9 | query | false | string | | | duration | 播放时长：秒 | query | false | integer | | | extJson | 扩展信息，JSON格式 | query | false | string | | | file | 视频文件 | formData | true | file | | | gmtCreate | 创建时间 | query | false | string | | | gmtModified | 最后修改时间 | query | false | string | | | id | 主键ID | query | false | integer | | | isAudio | 是否纯音频 | query | false | boolean | | | isDeleted | 是否已删除：0、1 | query | false | boolean | | | isEncrypted | 是否需要加密 | query | false | boolean | | | isScreen | 是否录屏优化 | query | false | boolean | | | isTranscoding | 是否需要转码 | query | false | boolean | | | originalDefinition | 源分辨率：1280x720 | query | false | string | | | originalHeight | 源视频分辨率：高 | query | false | integer | | | originalWidth | 源视频分辨率：宽 | query | false | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | sourceExtension | 源文件扩展名 | query | false | string | | | sourceFileName | 源文件名 | query | false | string | | | sourceFileSize | 源文件大小：Bytes | query | false | integer | | | sourceMd5sum | 源文件MD5校验码 | query | false | string | | | status | 视频状态 | query | false | string | | | tag1 | 标签1 | query | false | string | | | tag2 | 标签2 | query | false | string | | | tag3 | 标签3 | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | | title | 视频标题 | query | false | string | | | transGroupId | 使用的转码模板组ID | query | false | integer | | | transGroupName | 使用的转码模板组名称 | query | false | string | | | uploadChannel | 上传渠道 | query | false | string | | | uploadClient | 上传客户端IP | query | false | string | | | uploadServer | 上传服务器 | query | false | string | | | uploadTime | 上传时间 | query | false | string | | | userId | 所属用户ID | query | false | integer | | | vid | 视频字符串ID | query | false | string | | | videoAvgFrameRate | 视频平均帧率， | query | false | string | | | videoBitRate | 视频码率：Kbps | query | false | integer | | | videoCodecName | 视频解码库：h264 | query | false | string | | | videoLevel | 视频编码level： | query | false | integer | | | videoNbFrames | 视频总帧数 | query | false | integer | | | videoProfile | 视频编码配置：high | query | false | string | | | videoRotate | 旋转角度 | query | false | string | | **响应数据**: ```json { "code": 0, "data": { "audioBitRate": 0, "audioChannelLayout": "", "audioChannels": 0, "audioCodecName": "", "audioProfile": "", "audioSampleFmt": "", "audioSampleRate": 0, "categoryId": 0, "coverBucketName": "", "coverFileName": "", "coverStorageSystem": "", "deptId": 0, "description": "", "displayAspectRatio": "", "duration": 0, "extJson": "", "gmtCreate": "", "gmtModified": "", "id": 0, "isAudio": true, "isDeleted": true, "isEncrypted": true, "isScreen": true, "isTranscoding": true, "originalDefinition": "", "originalHeight": 0, "originalWidth": 0, "sourceExtension": "", "sourceFileName": "", "sourceFileSize": 0, "sourceMd5sum": "", "status": "", "tag1": "", "tag2": "", "tag3": "", "title": "", "transGroupId": 0, "transGroupName": "", "uploadChannel": "", "uploadClient": "", "uploadServer": "", "uploadTime": "", "userId": 0, "vid": "", "videoAvgFrameRate": "", "videoBitRate": 0, "videoCodecName": "", "videoLevel": 0, "videoNbFrames": 0, "videoProfile": "", "videoRotate": "" }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | Video | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **Video** | 参数名称 | 说明 | 类型 | schema | | ------------------ | ------------------------------------------------ | --------- | ------ | | audioBitRate | 音频码率：Kbps 字段：audio\_bit\_rate | int32 | | | audioChannelLayout | 音频声道：stereo 字段：audio\_channel\_layout | string | | | audioChannels | 音频声道数：2 字段：audio\_channels | int32 | | | audioCodecName | 音频解码库：aac 字段：audio\_codec\_name | string | | | audioProfile | 音频配置：HE-AAC 字段：audio\_profile | string | | | audioSampleFmt | 音频采样格式：fltp 字段：audio\_sample\_fmt | string | | | audioSampleRate | 音频采样率：22050 字段：audio\_sample\_rate | int32 | | | categoryId | 所属分类ID 字段：category\_id | int64 | | | coverBucketName | 封面图片所在的空间或者组名 字段：cover\_bucket\_name | string | | | coverFileName | 封面图片文件名 字段：cover\_file\_name | string | | | coverStorageSystem | 封面图片使用的存储系统 字段：cover\_storage\_system | string | | | deptId | 所属部门ID 字段：dept\_id | int64 | | | description | 视频描述 字段：description | string | | | displayAspectRatio | 显示宽高比：16:9 字段：display\_aspect\_ratio | string | | | duration | 播放时长：秒 字段：duration | int32 | | | extJson | 扩展信息，JSON格式 字段：ext\_json | string | | | gmtCreate | 创建时间 字段：gmt\_create | date-time | | | gmtModified | 最后修改时间 字段：gmt\_modified | date-time | | | id | 主键ID 字段：id | int64 | | | isAudio | 是否纯音频 字段：is\_audio | boolean | | | isDeleted | 是否已删除：0、1 字段：is\_deleted | boolean | | | isEncrypted | 是否需要加密 字段：is\_encrypted | boolean | | | isScreen | 是否录屏优化 字段：is\_screen | boolean | | | isTranscoding | 是否需要转码 字段：is\_transcoding | boolean | | | originalDefinition | 源分辨率：1280x720 字段：original\_definition | string | | | originalHeight | 源视频分辨率：高 字段：original\_height | int32 | | | originalWidth | 源视频分辨率：宽 字段：original\_width | int32 | | | sourceExtension | 源文件扩展名 字段：source\_extension | string | | | sourceFileName | 源文件名 字段：source\_file\_name | string | | | sourceFileSize | 源文件大小：Bytes 字段：source\_file\_size | int64 | | | sourceMd5sum | 源文件MD5校验码 字段：source\_md5sum | string | | | status | 视频状态 字段：status | string | | | tag1 | 标签1 字段：tag1 | string | | | tag2 | 标签2 字段：tag2 | string | | | tag3 | 标签3 字段：tag3 | string | | | title | 视频标题 字段：title | string | | | transGroupId | 使用的转码模板组ID 字段：trans\_group\_id | int64 | | | transGroupName | 使用的转码模板组名称 字段：trans\_group\_name | string | | | uploadChannel | 上传渠道 字段：upload\_channel | string | | | uploadClient | 上传客户端IP 字段：upload\_client | string | | | uploadServer | 上传服务器 字段：upload\_server | string | | | uploadTime | 上传时间 字段：upload\_time | date-time | | | userId | 所属用户ID 字段：user\_id | int64 | | | vid | 视频字符串ID 字段：vid | string | | | videoAvgFrameRate | 视频平均帧率， "30000/1001", 字段：video\_avg\_frame\_rate | string | | | videoBitRate | 视频码率：Kbps 字段：video\_bit\_rate | int32 | | | videoCodecName | 视频解码库：h264 字段：video\_codec\_name | string | | | videoLevel | 视频编码level： 31 字段：video\_level | int32 | | | videoNbFrames | 视频总帧数 字段：video\_nb\_frames | int32 | | | videoProfile | 视频编码配置：high 字段：video\_profile | string | | | videoRotate | 旋转角度 字段：video\_rotate | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------------------------ | | 200 | OK | WrappedResponseV2«Video» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 子账号管理相关接口 ### 新增子账号接口 **接口说明**:新增子账号 **接口地址**:`/vod/v1/account/add` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | -------------------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | email | 子账号邮箱 | query | true | string | | | name | 子账号名称 | query | true | string | | | password | 子账号密码 | query | true | string | | | roleId | 角色ID | query | true | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | status | 状态（Y/N） | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | | viewAllVideosEnabled | 是否有全部视频权限（Y/N） | query | true | string | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 删除子账号接口 **接口说明**:删除子账号 **接口地址**:`/vod/v1/account/delete` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | ----------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | childUserId | 要删除的子账号ID | body | false | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 根据子账号ID获取子账号信息接口 **接口说明**:根据子账号ID获取子账号信息 **接口地址**:`/vod/v1/account/get` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | ----------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | childUserId | 子账号ID | query | true | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "childEmail": "", "childUserId": 0, "childUsername": "", "createdTime": "", "lastModified": "", "roleId": 0, "roleName": "", "status": "", "userId": 0, "viewAllVideosEnabled": "" }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | --------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | UserChildrenDTO | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **UserChildrenDTO** | 参数名称 | 说明 | 类型 | schema | | -------------------- | ------------- | --------- | ------ | | childEmail | 子账号邮箱 | string | | | childUserId | 子账号用户ID | int64 | | | childUsername | 子账号名称 | string | | | createdTime | 创建时间 | date-time | | | lastModified | 更新时间 | date-time | | | roleId | 角色ID | int64 | | | roleName | 角色名称 | string | | | status | 账号状态(Y/N) | string | | | userId | 主账号用户ID | int64 | | | viewAllVideosEnabled | 是否显示全部视频(Y/N) | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ---------------------------------- | | 200 | OK | WrappedResponseV2«UserChildrenDTO» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 分页获取子账号列表接口 **接口说明**:分页获取子账号列表 **接口地址**:`/vod/v1/account/list` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | page | 页码 | query | false | integer | | | pageSize | 每页大小 | query | false | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "contents": [ { "childEmail": "", "childUserId": 0, "childUsername": "", "createdTime": "", "lastModified": "", "roleId": 0, "roleName": "", "status": "", "userId": 0, "viewAllVideosEnabled": "" } ], "endRow": 0, "firstPage": true, "lastPage": true, "limit": 0, "nextPageNumber": 0, "offset": 0, "pageNumber": 0, "pageSize": 0, "prePageNumber": 0, "startRow": 0, "totalItems": 0, "totalPages": 0 }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | -------------------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | Paginator«UserChildrenDTO» | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **Paginator«UserChildrenDTO»** | 参数名称 | 说明 | 类型 | schema | | -------------- | ----------- | ------- | --------------- | | contents | 当前页的内容。 | array | UserChildrenDTO | | endRow | 结束行。 | int32 | | | firstPage | 是否是第一页 | boolean | | | lastPage | 是否是最后一页 | boolean | | | limit | 数据库的limit | int32 | | | nextPageNumber | 下一页页标。 | int32 | | | offset | 数据库的offset | int32 | | | pageNumber | 当前页。 | int32 | | | pageSize | 每页最多显示的记录数。 | int32 | | | prePageNumber | 上一页页标。 | int32 | | | startRow | 开始行。 | int32 | | | totalItems | 总记录数。 | int32 | | | totalPages | 总页数 | int32 | | **UserChildrenDTO** | 参数名称 | 说明 | 类型 | schema | | -------------------- | ------------- | --------- | ------ | | childEmail | 子账号邮箱 | string | | | childUserId | 子账号用户ID | int64 | | | childUsername | 子账号名称 | string | | | createdTime | 创建时间 | date-time | | | lastModified | 更新时间 | date-time | | | roleId | 角色ID | int64 | | | roleName | 角色名称 | string | | | status | 账号状态(Y/N) | string | | | userId | 主账号用户ID | int64 | | | viewAllVideosEnabled | 是否显示全部视频(Y/N) | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | --------------------------------------------- | | 200 | OK | WrappedResponseV2«Paginator«UserChildrenDTO»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 获取角色列表接口 **接口说明**:获取角色列表 **接口地址**:`/vod/v1/account/role/list` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------ | ------ | | appId | 应用ID | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": [ { "id": 0, "name": "" } ], "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | array | 角色对象 | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **角色对象** | 参数名称 | 说明 | 类型 | schema | | ---- | ---- | ------ | ------ | | id | 角色ID | int64 | | | name | 角色名称 | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------------------- | | 200 | OK | WrappedResponseV2«List«角色对象»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 更新子账号信息接口 **接口说明**:更新子账号信息 **接口地址**:`/vod/v1/account/update` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | -------------------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | childUserId | 子账号用户ID | body | true | integer | | | isChangePassword | 是否修改密码 | body | true | string | | | name | 子账号名称 | body | true | string | | | password | 密码 | body | false | string | | | roleId | 角色ID | body | false | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | status | 状态（Y/N） | body | false | string | | | timestamp | 13位时间戳 | query | true | string | | | viewAllVideosEnabled | 是否有全部视频权限（Y/N） | body | false | string | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 字幕上传接口 ### 删除字幕 **接口说明**:删除字幕接口 **接口地址**:`/vod/v1/video/srt/delete` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | id | 字幕ID | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | | videoId | 视频ID | query | true | integer | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 修改字幕名称接口 **接口说明**:修改字幕名称接口 **接口地址**:`/vod/v1/video/srt/edit` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | id | 字幕ID | query | true | string | | | name | 字幕名称 | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | | videoId | 视频ID | query | true | integer | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 获取字幕列表接口 **接口说明**:获取字幕列表接口 **接口地址**:`/vod/v1/video/srt/list` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | | videoId | 视频ID | query | true | integer | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 字幕上传接口 **接口说明**:字幕上传接口 **接口地址**:`/vod/v1/video/srt/upload` **请求方式**：`post` **consumes**:`["multipart/form-data"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | -------- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | file | 文件 | formData | true | file | | | name | 字幕名称 | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | | videoId | 视频id | query | true | integer | | **响应数据**: ```json { "code": 0, "data": [ { "id": "", "name": "", "url": "" } ], "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | array | SrtDTO | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **SrtDTO** | 参数名称 | 说明 | 类型 | schema | | ---- | ---- | ------ | ------ | | id | 字幕ID | string | | | name | 字幕名称 | string | | | url | 字幕地址 | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------------------------------- | | 200 | OK | WrappedResponseV2«List«SrtDTO»» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 广告管理接口 ### 删除广告接口 **接口说明**:删除广告接口 **接口地址**:`/vod/v1/advert/delete` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------ | ------ | | adid | 广告ID | query | true | string | | | appId | 应用ID | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 获取广告详情接口 **接口说明**:获取广告详情接口 **接口地址**:`/vod/v1/advert/detail` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------ | ------ | | adid | 广告ID | query | true | string | | | appId | 应用ID | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "addrurl": "", "adid": "", "cataids": "", "createdtime": "", "height": 0, "location": "", "matterurl": "", "poplocation": 0, "popuptime": "", "size": 0, "skipenabled": "", "skiptime": 0, "status": 0, "title": "", "width": 0 }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | --------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | AdvertDTO | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **AdvertDTO** | 参数名称 | 说明 | 类型 | schema | | ----------- | -------------------------- | --------- | ------ | | addrurl | 链接地址：广告需要跳转的目标地址 | string | | | adid | 主键ID | string | | | cataids | 视频分类id。多个以英文逗号分割 | string | | | createdtime | 创建时间 | date-time | | | height | 原生视频高 | int32 | | | location | 广告位：广告展示的位置,1:片头，2:暂停，3:片尾 | string | | | matterurl | 广告素材：广告展示物料，可上传或外链广告，支持图片 | string | | | poplocation | 显示位置 | int32 | | | popuptime | 显示时间 | string | | | size | 素材大小：可自定义广告显示的时间 | int64 | | | skipenabled | 是否开启跳过片头广告（Y/N） | string | | | skiptime | 允许跳过广告的时间，单位秒 | int32 | | | status | 状态：已上线10,待上线1,已下线0,删除-1 | int32 | | | title | 广告名称：广告的标题 | string | | | width | 原生视频宽 | int32 | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ---------------------------- | | 200 | OK | WrappedResponseV2«AdvertDTO» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 查询广告接口 **接口说明**:查询广告接口 **接口地址**:`/vod/v1/advert/list` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | page | 第几页（默认显示第一页） | query | false | integer | | | pageSize | 每页显示几条（默认显示） | query | false | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | | title | 广告名称（模糊查询） | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "contents": [ { "addrurl": "", "adid": "", "cataids": "", "createdtime": "", "height": 0, "location": "", "matterurl": "", "poplocation": 0, "popuptime": "", "size": 0, "skipenabled": "", "skiptime": 0, "status": 0, "title": "", "width": 0 } ], "endRow": 0, "firstPage": true, "hasNextPage": true, "hasPreviousPage": true, "lastPage": true, "limit": 0, "nextPageNumber": 0, "offset": 0, "pageNumber": 0, "pageSize": 0, "previousPageNumber": 0, "startRow": 0, "totalItems": 0, "totalPages": 0 }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | --------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | Page«AdvertDTO» | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **Page«AdvertDTO»** | 参数名称 | 说明 | 类型 | schema | | ------------------ | ----------- | ------- | --------- | | contents | 当前页的内容。 | array | AdvertDTO | | endRow | | int64 | | | firstPage | | boolean | | | hasNextPage | | boolean | | | hasPreviousPage | | boolean | | | lastPage | | boolean | | | limit | | int64 | | | nextPageNumber | | int32 | | | offset | | int64 | | | pageNumber | 当前页。 | int32 | | | pageSize | 每页最多显示的记录数。 | int32 | | | previousPageNumber | | int32 | | | startRow | | int64 | | | totalItems | 总记录数。 | int64 | | | totalPages | | int32 | | **AdvertDTO** | 参数名称 | 说明 | 类型 | schema | | ----------- | -------------------------- | --------- | ------ | | addrurl | 链接地址：广告需要跳转的目标地址 | string | | | adid | 主键ID | string | | | cataids | 视频分类id。多个以英文逗号分割 | string | | | createdtime | 创建时间 | date-time | | | height | 原生视频高 | int32 | | | location | 广告位：广告展示的位置,1:片头，2:暂停，3:片尾 | string | | | matterurl | 广告素材：广告展示物料，可上传或外链广告，支持图片 | string | | | poplocation | 显示位置 | int32 | | | popuptime | 显示时间 | string | | | size | 素材大小：可自定义广告显示的时间 | int64 | | | skipenabled | 是否开启跳过片头广告（Y/N） | string | | | skiptime | 允许跳过广告的时间，单位秒 | int32 | | | status | 状态：已上线10,待上线1,已下线0,删除-1 | int32 | | | title | 广告名称：广告的标题 | string | | | width | 原生视频宽 | int32 | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ---------------------------------- | | 200 | OK | WrappedResponseV2«Page«AdvertDTO»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 新增或修改广告接口 **接口说明**:新增或修改广告接口 **接口地址**:`/vod/v1/advert/save` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | ----------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | addrurl | 链接地址：广告需要跳转的目标地址 | query | false | string | | | adid | 主键ID | query | false | string | | | appId | 应用ID | query | true | string | | | cataids | 视频分类id。多个以英文逗号分割 | query | false | string | | | height | y原生视频高 | query | false | integer | | | location | 广告位：广告展示的位置,片头，暂停，片尾 | query | false | string | | | matterurl | 广告素材：广告展示物料，可上传或外链广告，支持图片 | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | size | 素材大小：可自定义广告显示的大小 | query | false | integer | | | skipenabled | 是否开启跳过片头广告 | query | false | string | | | skiptime | 允许跳过广告的时间，单位秒 | query | false | integer | | | status | 已上线10,待上线1,已下线0,删除-1 | query | false | integer | | | timestamp | 13位时间戳 | query | true | string | | | title | 广告名称：广告的标题 | query | false | string | | | width | 原生视频宽 | query | false | integer | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 提供分类管理相关接口 ### 新增子分类接口 **接口说明**:新增子分类 **接口地址**:`/vod/v1/category/create-child` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | name | 新增的分类名称 | query | true | string | | | parentId | 父分类ID | query | true | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "css": "", "gmtCreate": "", "gmtModified": "", "icon": "", "id": 0, "isDeleted": true, "name": "", "ordered": 0, "path": "", "playerId": 0, "playerName": "", "transGroupId": 0, "transGroupName": "", "userId": 0 }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | -------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | Category | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **Category** | 参数名称 | 说明 | 类型 | schema | | -------------- | ----------------------------- | --------- | ------ | | css | 展示时的CSS类名 字段：css | string | | | gmtCreate | 创建时间 字段：gmt\_create | date-time | | | gmtModified | 最后修改时间 字段：gmt\_modified | date-time | | | icon | 分类的图标 字段：icon | string | | | id | 主键ID 字段：id | int64 | | | isDeleted | 是否已删除：0、1 字段：is\_deleted | boolean | | | name | 分类名称 字段：name | string | | | ordered | 同级排序，由小到大 字段：ordered | int32 | | | path | 分类ID路径 字段：path | string | | | playerId | 播放器ID 字段：player\_id | int64 | | | playerName | 播放器名称 字段：player\_name | string | | | transGroupId | 转码模板组ID 字段：trans\_group\_id | int64 | | | transGroupName | 转码模板组名称 字段：trans\_group\_name | string | | | userId | 所属用户ID 字段：user\_id | int64 | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | --------------------------- | | 200 | OK | WrappedResponseV2«Category» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 删除指定分类接口 **接口说明**:删除指定的分类 **接口地址**:`/vod/v1/category/delete` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | ---------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | categoryId | 分类ID | query | true | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 获取视频分类接口 **接口说明**:获取视频分类接口 **接口地址**:`/vod/v1/category/list` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | cataId | 要查找的分类ID，不提交时表示获取所有分类 | query | false | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": [ { "cataId": 0, "cataName": "", "children": { "childrenList": [ {} ], "subTotal": 0 }, "level": 0, "parentId": 0 } ], "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | -------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | array | CataNode | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **CataNode** | 参数名称 | 说明 | 类型 | schema | | -------- | -- | ------ | ------------ | | cataId | | int64 | | | cataName | | string | | | children | | string | CataChildren | | level | | int32 | | | parentId | | int64 | | **CataChildren** | 参数名称 | 说明 | 类型 | schema | | ------------ | -- | ----- | -------- | | childrenList | | array | CataNode | | subTotal | | int32 | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | --------------------------------- | | 200 | OK | WrappedResponseV2«List«CataNode»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 修改分类接口 **接口说明**:修改分类 **接口地址**:`/vod/v1/category/update` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | ---------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | categoryId | 分类ID | query | true | integer | | | name | 修改后的分类名称 | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 提供视频管理相关接口 ### 批量删除视频 **接口说明**:批量删除视频接口 **接口地址**:`/vod/v1/video/delete` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | | videoIds | 视频ID列表（多个视频ID通过英文逗号隔开） | query | false | string | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 根据视频vid获取视频信息接口 **接口说明**:根据视频vid获取视频信息接口 **接口地址**:`/vod/v1/video/get-videos-info` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | filters | 需要获取的信息，不提交表示获取所有，取值为：basicInfo:基本信息，metaData:源视频信息，transcodeInfo:转码信息，snapshotInfo:截图信息 | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | | vids | 需要查询的视频ID，多个ID(用英文逗号隔开) | query | false | string | | **响应数据**: ```json { "code": 0, "data": [ { "basicInfo": { "cateId": 0, "cateName": "", "coverUrl": "", "createdTime": 0, "description": "", "duration": 0, "size": 0, "status": "", "statusText": "", "tags": "", "title": "", "updateTime": 0, "uploader": "", "vid": "" }, "metaData": { "bitrate": 0, "codec": "", "duration": 0, "format": "", "fps": "", "height": 0, "size": 0, "width": 0 }, "snapshotInfo": [], "transcodeInfo": [ { "bitrate": 0, "definition": "", "definitionText": "", "duration": 0, "encrypt": true, "encryptType": "", "format": "", "height": 0, "playUrl": "", "size": 0, "status": "", "width": 0 } ], "vid": "" } ], "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | -------------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | array | VideoDetailInfoModel | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **VideoDetailInfoModel** | 参数名称 | 说明 | 类型 | schema | | ------------- | -------- | ------ | ------------------ | | basicInfo | 视频信息 | string | VideoBasicInfo | | metaData | 视频元信息 | string | VideoMetaData | | snapshotInfo | 视频截图列表 | array | | | transcodeInfo | 视频转码信息列表 | array | VideoTranscodeInfo | | vid | 视频VID | string | | **VideoBasicInfo** | 参数名称 | 说明 | 类型 | schema | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | | cateId | 分类ID | int64 | | | cateName | 分类名称 | string | | | coverUrl | 封面图URL | string | | | createdTime | 创建时间 13位时间戳 | int64 | | | description | | string | | | duration | 视频时长，单位秒 | float | | | size | 源文件大小 单位 Bytes | int64 | | | status | 视频状态，取值参考： CREATED 已创建 UPLOADING 上传中 UPLOAD\_FAIL 上传失败 UPLOAD\_SUCCESS 上传成功 TRANSCODING 转码中 TRANSCODE\_FAIL 转码失败 CHECKING 审核中 BLOCKED 屏蔽 NORMAL 正常 | string | | | statusText | 视频状态中文描述值 | string | | | tags | 视频标签，多个标签用英文逗号","分隔 | string | | | title | 视频标题 | string | | | updateTime | 修改时间 13位间戳 | int64 | | | uploader | 上传员账号 | string | | | vid | 视频vid | string | | **VideoMetaData** | 参数名称 | 说明 | 类型 | schema | | -------- | --------------- | ------ | ------ | | bitrate | 视频码率，单位bps | int32 | | | codec | 编码格式，如h264、h265 | string | | | duration | 视频时长，单位秒 | float | | | format | 视频格式，如 mp4、flv | string | | | fps | 视频帧率 格式：25/1 | string | | | height | 视频分辨率高，单位px | int32 | | | size | 源文件大小 单位 Bytes | int64 | | | width | 视频分辨率宽，单位px | int32 | | **VideoTranscodeInfo** | 参数名称 | 说明 | 类型 | schema | | -------------- | ------------------------------------------------------------------------- | ------- | ------ | | bitrate | 视频码率，单位bps | int32 | | | definition | 视频清晰度，取值为：SOURCE 原始文件 LD 流畅 SD 标清 HD 高清 FHD 超清 OD 原画 4K 4K SQ 普通音质 HQ 高音质 | string | | | definitionText | 视频清晰度中文描述 | string | | | duration | 视频时长，单位秒 | int64 | | | encrypt | 是否加密 | boolean | | | encryptType | 加密类型 | string | | | format | 视频格式 | string | | | height | 视频分辨率高，单位px | int32 | | | playUrl | 视频流播放地址 | string | | | size | 源文件大小 | int64 | | | status | 视频流状态,取值：normal 正常；unavailable 不可用 | string | | | width | 视频分辨率宽，单位px | int32 | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | --------------------------------------------- | | 200 | OK | WrappedResponseV2«List«VideoDetailInfoModel»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 搜索视频接口 **接口说明**:搜索视频接口 根据条件搜索获取包含视频基本信息的分页列表 **接口地址**:`/vod/v1/video/search-videos` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | ---------------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | categoryIdList | 视频所属分类ID，多个ID用英文逗号分隔 | query | false | integer | | | endTime | 结束时间。格式为：yyyy-MM-dd | query | false | string | | | includingDeleted | 是否包括已删除的视频。 | query | false | boolean | | | keyword | 搜索关键词。 | query | false | string | | | order | 排序条件,取值：create\_asc | query | false | string | | | page | 分页展示：当前第几页 | query | false | integer | | | pageSize | 分页展示：每页最多显示多少条记录，默认为25 | query | false | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | startTime | 开始时间。格式为：yyyy-MM-dd | query | false | string | | | status | 视频状态。取值参考： | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | | uploadServer | 上传者邮箱账号 | query | false | string | | | vid | 视频VID。 | query | false | string | | **响应数据**: ```json { "code": 0, "data": { "contents": [ { "cateId": 0, "cateName": "", "coverUrl": "", "createdTime": 0, "description": "", "duration": 0, "size": 0, "status": "", "statusText": "", "tags": "", "title": "", "updateTime": 0, "uploader": "", "vid": "" } ], "endRow": 0, "firstPage": true, "hasNextPage": true, "hasPreviousPage": true, "lastPage": true, "limit": 0, "nextPageNumber": 0, "offset": 0, "pageNumber": 0, "pageSize": 0, "previousPageNumber": 0, "startRow": 0, "totalItems": 0, "totalPages": 0 }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | -------------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | Page«VideoBasicInfo» | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **Page«VideoBasicInfo»** | 参数名称 | 说明 | 类型 | schema | | ------------------ | ----------- | ------- | -------------- | | contents | 当前页的内容。 | array | VideoBasicInfo | | endRow | | int64 | | | firstPage | | boolean | | | hasNextPage | | boolean | | | hasPreviousPage | | boolean | | | lastPage | | boolean | | | limit | | int64 | | | nextPageNumber | | int32 | | | offset | | int64 | | | pageNumber | 当前页。 | int32 | | | pageSize | 每页最多显示的记录数。 | int32 | | | previousPageNumber | | int32 | | | startRow | | int64 | | | totalItems | 总记录数。 | int64 | | | totalPages | | int32 | | **VideoBasicInfo** | 参数名称 | 说明 | 类型 | schema | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | | cateId | 分类ID | int64 | | | cateName | 分类名称 | string | | | coverUrl | 封面图URL | string | | | createdTime | 创建时间 13位时间戳 | int64 | | | description | | string | | | duration | 视频时长，单位秒 | float | | | size | 源文件大小 单位 Bytes | int64 | | | status | 视频状态，取值参考： CREATED 已创建 UPLOADING 上传中 UPLOAD\_FAIL 上传失败 UPLOAD\_SUCCESS 上传成功 TRANSCODING 转码中 TRANSCODE\_FAIL 转码失败 CHECKING 审核中 BLOCKED 屏蔽 NORMAL 正常 | string | | | statusText | 视频状态中文描述值 | string | | | tags | 视频标签，多个标签用英文逗号","分隔 | string | | | title | 视频标题 | string | | | updateTime | 修改时间 13位间戳 | int64 | | | uploader | 上传员账号 | string | | | vid | 视频vid | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | --------------------------------------- | | 200 | OK | WrappedResponseV2«Page«VideoBasicInfo»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 视频基础信息更新 **接口说明**:视频基础信息更新接口 **接口地址**:`/vod/v1/video/update` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | ----------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | categoryId | categoryId | query | false | integer | | | description | description | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | tag1 | tag1 | query | false | string | | | tag2 | tag2 | query | false | string | | | tag3 | tag3 | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | | title | title | query | false | string | | | vid | 视频id | query | true | string | | **响应数据**: ```json { "code": 0, "data": true, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------- | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | boolean | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | -------------------------- | | 200 | OK | WrappedResponseV2«boolean» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 上传视频封面图片 **接口说明**:上传视频封面图片 **接口地址**:`/vod/v1/video/upload/cover-image` **请求方式**：`post` **consumes**:`["multipart/form-data"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | -------- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | file | 文件 | formData | false | file | | | isDefault | 是否设置为默认图（是：Y/ | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | | videoId | 视频ID | query | false | integer | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 播放域名统计相关接口 ### 获取域名统计接口 **接口说明**:获取域名统计接口。 **接口地址**:`/vod/v1/statistic/domain` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": [ { "createdTime": "", "currentDay": "", "currentMonth": "", "currentWeek": "", "domain": "", "lastModified": "", "mobileFlowSize": 0, "mobilePlayDuration": 0, "mobileUniqueViewer": 0, "mobileVideoView": 0, "pcFlowSize": 0, "pcPlayDuration": 0, "pcUniqueViewer": 0, "pcVideoView": 0, "userId": "" } ], "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ---------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | array | DomainDailyStats | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **DomainDailyStats** | 参数名称 | 说明 | 类型 | schema | | ------------------ | -------- | --------- | ------ | | createdTime | 创建时间 | date-time | | | currentDay | 当天 | string | | | currentMonth | 当周 | string | | | currentWeek | 当周 | string | | | domain | 域名 | string | | | lastModified | 更新时间 | date-time | | | mobileFlowSize | 移动端流量 | int64 | | | mobilePlayDuration | 移动端观看时长 | int64 | | | mobileUniqueViewer | 移动端观看唯一数 | int32 | | | mobileVideoView | 移动端观看数 | int32 | | | pcFlowSize | pc端流量 | int64 | | | pcPlayDuration | pc端播放时长 | int64 | | | pcUniqueViewer | pc端观看唯一数 | int32 | | | pcVideoView | pc端观看数 | int32 | | | userId | 用户ID | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------------------------------- | | 200 | OK | WrappedResponseV2«List«DomainDailyStats»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 导出域名统计接口 **接口说明**:导出域名统计接口。 **接口地址**:`/vod/v1/statistic/domain/export` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json ``` **响应参数说明**: 暂无 **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------ | | 200 | OK | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 播放时长的统计数据相关接口 ### 查询播放时长统计接口 **接口说明**:查询播放时长统计接口。 **接口地址**:`/vod/v1/statistic/playduration` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | | vid | 视频ID | query | false | string | | **响应数据**: ```json { "code": 0, "data": [ { "currentDay": "", "mobilePerAveragePlayDuration": 0, "mobilePlayDuration": 0, "mobileVideoAveragePlayDuration": 0, "pcPerAveragePlayDuration": 0, "pcPlayDuration": 0, "pcVideoAveragePlayDuration": 0 } ], "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ---------------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | array | PlayDurationStatsModel | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **PlayDurationStatsModel** | 参数名称 | 说明 | 类型 | schema | | ------------------------------ | ----------- | ------ | ------ | | currentDay | 当天 | string | | | mobilePerAveragePlayDuration | 移动端人均观看时长 | int64 | | | mobilePlayDuration | 移动端播放时长 | int64 | | | mobileVideoAveragePlayDuration | 移动端视频平均观看时长 | int64 | | | pcPerAveragePlayDuration | pc人均观看时长 | int64 | | | pcPlayDuration | pc端播放时长 | int64 | | | pcVideoAveragePlayDuration | pc视频平均观看时长 | int64 | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------------------------------------- | | 200 | OK | WrappedResponseV2«List«PlayDurationStatsModel»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 导出播放时长统计接口 **接口说明**:导出播放时长统计接口。 **接口地址**:`/vod/v1/statistic/playduration/export` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | | vid | 视频ID | query | false | string | | **响应数据**: ```json ``` **响应参数说明**: 暂无 **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------ | | 200 | OK | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 播放量统计相关接口 ### 播放量列表接口 **接口说明**:播放量列表接口。 **接口地址**:`/vod/v1/statistic/visitor` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | | vid | 视频ID | query | false | string | | **响应数据**: ```json { "code": 0, "data": [ { "createdTime": "", "currentDay": "", "currentMonth": "", "currentWeek": "", "lastModified": "", "mobileFlowSize": 0, "mobilePlayDuration": 0, "mobileUniqueViewer": 0, "mobileVideoView": 0, "pcFlowSize": 0, "pcPlayDuration": 0, "pcUniqueViewer": 0, "pcVideoView": 0, "percent10": 0, "percent100": 0, "percent20": 0, "percent30": 0, "percent40": 0, "percent50": 0, "percent60": 0, "percent70": 0, "percent80": 0, "percent90": 0, "userId": "" } ], "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | -------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | array | UserDailyStats | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **UserDailyStats** | 参数名称 | 说明 | 类型 | schema | | ------------------ | --------- | --------- | ------ | | createdTime | 创建时间 | date-time | | | currentDay | 当天 | string | | | currentMonth | 当月 | string | | | currentWeek | 当周 | string | | | lastModified | 更新时间 | date-time | | | mobileFlowSize | 移动端流量 | int64 | | | mobilePlayDuration | 移动端观看时长 | int64 | | | mobileUniqueViewer | 移动端观看唯一数 | int32 | | | mobileVideoView | 移动端观看数 | int32 | | | pcFlowSize | pc端流量 | int64 | | | pcPlayDuration | pc端播放时长 | int64 | | | pcUniqueViewer | pc端观看唯一数 | int32 | | | pcVideoView | pc端观看数 | int32 | | | percent10 | 观看10%的比例 | int32 | | | percent100 | 观看100%的比例 | int32 | | | percent20 | 观看20%的比例 | int32 | | | percent30 | 观看30%的比例 | int32 | | | percent40 | 观看40%的比例 | int32 | | | percent50 | 观看50%的比例 | int32 | | | percent60 | 观看60%的比例 | int32 | | | percent70 | 观看70%的比例 | int32 | | | percent80 | 观看80%的比例 | int32 | | | percent90 | 观看90%的比例 | int32 | | | userId | 用户ID | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | --------------------------------------- | | 200 | OK | WrappedResponseV2«List«UserDailyStats»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 导出播放量接口 **接口说明**:导出播放量接口。 **接口地址**:`/vod/v1/statistic/visitor/export` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | | vid | 视频ID | query | false | string | | **响应数据**: ```json ``` **响应参数说明**: 暂无 **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------ | | 200 | OK | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 播放量排行榜接口 **接口说明**:播放量排行榜接口（前100位）。 **接口地址**:`/vod/v1/statistic/visitor/rank/top` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "totalVideoView": 0, "videoViewModels": [ { "duration": 0, "imageUrl": "", "title": "", "videoId": "", "videoView": 0 } ] }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ----------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | VideoViewTopModel | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **VideoViewTopModel** | 参数名称 | 说明 | 类型 | schema | | --------------- | ------ | ----- | ------------------ | | totalVideoView | 总播放数 | int32 | | | videoViewModels | 播放列表排行 | array | VideoViewModelBean | **VideoViewModelBean** | 参数名称 | 说明 | 类型 | schema | | --------- | ---- | ------ | ------ | | duration | 时长 | int32 | | | imageUrl | 头图 | string | | | title | 标题 | string | | | videoId | 视频ID | string | | | videoView | 播放量 | int32 | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------------------------------------ | | 200 | OK | WrappedResponseV2«VideoViewTopModel» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 导出汇总播放量排行接口 **接口说明**:导出汇总播放量排行接口（前100位）。 **接口地址**:`/vod/v1/statistic/visitor/rank/top/export` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json ``` **响应参数说明**: 暂无 **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------ | | 200 | OK | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 整体数据概况相关接口 ### 数据汇总接口 **接口说明**:数据汇总接口。 **接口地址**:`/vod/v1/statistic/overview` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | | vid | 视频ID | query | false | string | | **响应数据**: ```json { "code": 0, "data": { "mobileFlowSize": 0, "mobilePlayDuration": 0, "mobileUniqueViewer": 0, "mobileVideoView": 0, "pcFlowSize": 0, "pcPlayDuration": 0, "pcUniqueViewer": 0, "pcVideoView": 0, "userId": "" }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | StatsSummary | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **StatsSummary** | 参数名称 | 说明 | 类型 | schema | | ------------------ | --------- | ------ | ------ | | mobileFlowSize | 移动端流量 | int64 | | | mobilePlayDuration | 移动端播放分钟数 | int64 | | | mobileUniqueViewer | 移动端唯一观看人数 | int32 | | | mobileVideoView | 移动端观看数 | int32 | | | pcFlowSize | pc端流量 | int64 | | | pcPlayDuration | pc端观看分钟数 | int64 | | | pcUniqueViewer | pc端唯一观众数 | int32 | | | pcVideoView | pc端观看数 | int32 | | | userId | 用户ID | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------------------------------- | | 200 | OK | WrappedResponseV2«StatsSummary» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 概览数据汇总接口 **接口说明**:概览数据汇总接口。 **接口地址**:`/vod/v1/statistic/overview/summary` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------ | ------ | | appId | 应用ID | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "totalPlayDuration": 0, "totalSpace": 0, "totalVideo": 0, "totalVideoView": 0 }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ----------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | StatsTotalSummary | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **StatsTotalSummary** | 参数名称 | 说明 | 类型 | schema | | ----------------- | ------------- | ----- | ------ | | totalPlayDuration | 总播放时长 | int64 | | | totalSpace | 空间大小（单位：byte） | int64 | | | totalVideo | 视频总数 | int32 | | | totalVideoView | 总观看数 | int32 | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------------------------------------ | | 200 | OK | WrappedResponseV2«StatsTotalSummary» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 终端设备统计相关接口 ### 获取终端设备统计接口 **接口说明**:终端设备统计接口。 **接口地址**:`/vod/v1/statistic/device` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "end": "", "start": "", "stats": { "createdTime": "", "currentDay": "", "currentMonth": "", "currentWeek": "", "lastModified": "", "mobileFlowSize": 0, "mobilePlayDuration": 0, "mobileUniqueViewer": 0, "mobileVideoView": 0, "pcFlowSize": 0, "pcPlayDuration": 0, "pcUniqueViewer": 0, "pcVideoView": 0, "percent10": 0, "percent100": 0, "percent20": 0, "percent30": 0, "percent40": 0, "percent50": 0, "percent60": 0, "percent70": 0, "percent80": 0, "percent90": 0, "userId": "" }, "totalVideoView": 0 }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | --------------------------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | StatsSummaryModel«UserDailyStats» | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **StatsSummaryModel«UserDailyStats»** | 参数名称 | 说明 | 类型 | schema | | -------------- | ------ | ------ | -------------- | | end | 结束时间 | string | | | start | 开始时间 | string | | | stats | 播放列表排行 | string | UserDailyStats | | totalVideoView | 总播放数 | int32 | | **UserDailyStats** | 参数名称 | 说明 | 类型 | schema | | ------------------ | --------- | --------- | ------ | | createdTime | 创建时间 | date-time | | | currentDay | 当天 | string | | | currentMonth | 当月 | string | | | currentWeek | 当周 | string | | | lastModified | 更新时间 | date-time | | | mobileFlowSize | 移动端流量 | int64 | | | mobilePlayDuration | 移动端观看时长 | int64 | | | mobileUniqueViewer | 移动端观看唯一数 | int32 | | | mobileVideoView | 移动端观看数 | int32 | | | pcFlowSize | pc端流量 | int64 | | | pcPlayDuration | pc端播放时长 | int64 | | | pcUniqueViewer | pc端观看唯一数 | int32 | | | pcVideoView | pc端观看数 | int32 | | | percent10 | 观看10%的比例 | int32 | | | percent100 | 观看100%的比例 | int32 | | | percent20 | 观看20%的比例 | int32 | | | percent30 | 观看30%的比例 | int32 | | | percent40 | 观看40%的比例 | int32 | | | percent50 | 观看50%的比例 | int32 | | | percent60 | 观看60%的比例 | int32 | | | percent70 | 观看70%的比例 | int32 | | | percent80 | 观看80%的比例 | int32 | | | percent90 | 观看90%的比例 | int32 | | | userId | 用户ID | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ---------------------------------------------------- | | 200 | OK | WrappedResponseV2«StatsSummaryModel«UserDailyStats»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 浏览器统计接口 **接口说明**:浏览器统计接口。 **接口地址**:`/vod/v1/statistic/device/browser` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "end": "", "start": "", "stats": [ { "browser": "", "createdTime": "", "currentDay": "", "currentMonth": "", "currentWeek": "", "lastModified": "", "mobileFlowSize": 0, "mobilePlayDuration": 0, "mobileUniqueViewer": 0, "mobileVideoView": 0, "pcFlowSize": 0, "pcPlayDuration": 0, "pcUniqueViewer": 0, "pcVideoView": 0, "userId": "" } ], "totalVideoView": 0 }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------------------------------------------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | StatsSummaryModel«List«BrowserDailyStats»» | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **StatsSummaryModel«List«BrowserDailyStats»»** | 参数名称 | 说明 | 类型 | schema | | -------------- | ------ | ------ | ----------------- | | end | 结束时间 | string | | | start | 开始时间 | string | | | stats | 播放列表排行 | array | BrowserDailyStats | | totalVideoView | 总播放数 | int32 | | **BrowserDailyStats** | 参数名称 | 说明 | 类型 | schema | | ------------------ | -------- | --------- | ------ | | browser | 浏览器 | string | | | createdTime | 创建时间 | date-time | | | currentDay | 当天 | string | | | currentMonth | 当月 | string | | | currentWeek | 当周 | string | | | lastModified | 更新时间 | date-time | | | mobileFlowSize | 移动端流量 | int64 | | | mobilePlayDuration | 移动端观看时长 | int64 | | | mobileUniqueViewer | 移动端观看唯一数 | int32 | | | mobileVideoView | 移动端观看数 | int32 | | | pcFlowSize | pc端流量 | int64 | | | pcPlayDuration | pc端播放时长 | int64 | | | pcUniqueViewer | pc端观看唯一数 | int32 | | | pcVideoView | pc端观看数 | int32 | | | userId | 用户ID | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------------------------------------------------------------- | | 200 | OK | WrappedResponseV2«StatsSummaryModel«List«BrowserDailyStats»»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 导出浏览器统计接口 **接口说明**:导出浏览器统计接口。 **接口地址**:`/vod/v1/statistic/device/browser/export` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json ``` **响应参数说明**: 暂无 **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------ | | 200 | OK | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 导出终端设备统计接口 **接口说明**:导出终端设备统计接口。 **接口地址**:`/vod/v1/statistic/device/export` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json ``` **响应参数说明**: 暂无 **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------ | | 200 | OK | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 操作系统统计数据 **接口说明**:操作系统统计数据。 **接口地址**:`/vod/v1/statistic/device/os` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "end": "", "start": "", "stats": [ { "createdTime": "", "currentDay": "", "currentMonth": "", "currentWeek": "", "lastModified": "", "mobileFlowSize": 0, "mobilePlayDuration": 0, "mobileUniqueViewer": 0, "mobileVideoView": 0, "operatingSystem": "", "pcFlowSize": 0, "pcPlayDuration": 0, "pcUniqueViewer": 0, "pcVideoView": 0, "userId": "" } ], "totalVideoView": 0 }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------------------------------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | StatsSummaryModel«List«OsDailyStats»» | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **StatsSummaryModel«List«OsDailyStats»»** | 参数名称 | 说明 | 类型 | schema | | -------------- | ------ | ------ | ------------ | | end | 结束时间 | string | | | start | 开始时间 | string | | | stats | 播放列表排行 | array | OsDailyStats | | totalVideoView | 总播放数 | int32 | | **OsDailyStats** | 参数名称 | 说明 | 类型 | schema | | ------------------ | -------- | --------- | ------ | | createdTime | 创建时间 | date-time | | | currentDay | 当天 | string | | | currentMonth | 当月 | string | | | currentWeek | 当周 | string | | | lastModified | 更新时间 | date-time | | | mobileFlowSize | 移动端流量 | int64 | | | mobilePlayDuration | 移动端观看时长 | int64 | | | mobileUniqueViewer | 移动端观看唯一数 | int32 | | | mobileVideoView | 移动端观看数 | int32 | | | operatingSystem | 操作系统 | string | | | pcFlowSize | pc端流量 | int64 | | | pcPlayDuration | pc端播放时长 | int64 | | | pcUniqueViewer | pc端观看唯一数 | int32 | | | pcVideoView | pc端观看数 | int32 | | | userId | 用户ID | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | -------------------------------------------------------- | | 200 | OK | WrappedResponseV2«StatsSummaryModel«List«OsDailyStats»»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 导出操作系统统计接口 **接口说明**:导出操作系统统计接口。 **接口地址**:`/vod/v1/statistic/device/os/export` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json ``` **响应参数说明**: 暂无 **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------ | | 200 | OK | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 观众地理位置统计相关接口 ### 查询地域分布统计接口 **接口说明**:查询地域分布统计接口。 **接口地址**:`/vod/v1/statistic/geo` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": [ { "createdTime": "", "currentDay": "", "currentMonth": "", "currentWeek": "", "lastModified": "", "mobileFlowSize": 0, "mobilePlayDuration": 0, "mobileUniqueViewer": 0, "mobileVideoView": 0, "pcFlowSize": 0, "pcPlayDuration": 0, "pcUniqueViewer": 0, "pcVideoView": 0, "province": "", "userId": "" } ], "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------------------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | array | ProvinceDailyStats | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **ProvinceDailyStats** | 参数名称 | 说明 | 类型 | schema | | ------------------ | -------- | --------- | ------ | | createdTime | 创建时间 | date-time | | | currentDay | 当天 | string | | | currentMonth | 当周 | string | | | currentWeek | 当周 | string | | | lastModified | 更新时间 | date-time | | | mobileFlowSize | 移动端流量 | int64 | | | mobilePlayDuration | 移动端观看时长 | int64 | | | mobileUniqueViewer | 移动端观看唯一数 | int32 | | | mobileVideoView | 移动端观看数 | int32 | | | pcFlowSize | pc端流量 | int64 | | | pcPlayDuration | pc端播放时长 | int64 | | | pcUniqueViewer | pc端观看唯一数 | int32 | | | pcVideoView | pc端观看数 | int32 | | | province | 省份 | string | | | userId | 用户ID | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------------------------------------------- | | 200 | OK | WrappedResponseV2«List«ProvinceDailyStats»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 导出地域分布统计接口 **接口说明**:导出地域分布统计接口。 **接口地址**:`/vod/v1/statistic/geo/export` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | end | 查询结束日期（时间格式：yyyy-MM-dd） | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | start | 查询开始日期（时间格式：yyyy-MM-dd） | query | false | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json ``` **响应参数说明**: 暂无 **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------ | | 200 | OK | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 视频安全 ### 获取播放域名设置信息接口 **接口说明**:获取播放域名设置信息 **接口地址**:`/vod/v1/play-safe/info` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------ | ------ | | appId | 应用ID | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "blackList": "", "securitySetting": "", "userId": "", "whiteList": "" }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | PlayDomainDTO | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **PlayDomainDTO** | 参数名称 | 说明 | 类型 | schema | | --------------- | -------------------------------------- | ------ | ------ | | blackList | 黑名单,可添加多个用逗号隔开 | string | | | securitySetting | 播放限制设置选项， none:无限制，white：白名单，black:黑名单 | string | | | userId | 用户ID | string | | | whiteList | 白名单,可添加多个用逗号隔开 | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | -------------------------------- | | 200 | OK | WrappedResponseV2«PlayDomainDTO» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 新增或修改播放域名限制接口 **接口说明**:新增或修改播放域名限制接口 **接口地址**:`/vod/v1/play-safe/save` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------ | ------ | | appId | 应用ID | query | true | string | | | blackList | 黑名单,可添加多个用逗号隔开 | query | false | string | | | securitySetting | 播放限制设置选项,none:无限制，white：白名单，black:黑名单 | query | true | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | | whiteList | 白名单,可添加多个用逗号隔开 | query | false | string | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ## 视频水印管理相关接口 ### 添加水印设置接口 **接口说明**:添加水印设置 **接口地址**:`/vod/v1/transcoding/create` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | ---------------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | bucketName | 图片水印文件存储所在的空间或者组名 | query | false | string | | | content | 文字水印的内容 | query | false | string | | | fileName | 水印素材的文件名 | query | false | string | | | fontAlpha | 透明度：0-1 | query | false | number | | | fontColor | 文字水印的颜色 | query | false | string | | | fontName | 文字水印的字体 | query | false | string | | | fontSize | 文字水印的字号：像素 | query | false | integer | | | gmtCreate | 创建时间 | query | false | string | | | gmtModified | 最后修改时间 | query | false | string | | | id | 主键ID | query | false | integer | | | imageDxUnit | 图片水印水平偏移的单位：像素-pixel，百分比-percentage | query | false | string | | | imageDxValue | 图片水印水平偏移：值 | query | false | integer | | | imageDyUnit | 图片水印垂直偏移的单位：像素-pixel，百分比-percentage | query | false | string | | | imageDyValue | 图片水印垂直偏移：值 | query | false | integer | | | imageHeightUnit | 图片水印高度的单位：像素-pixel，百分比-percentage | query | false | string | | | imageHeightValue | 图片水印高度：值 | query | false | integer | | | imagePosition | 图片水印的位置：左上、左下、右下、右上 | query | false | string | | | imageWidthUnit | 图片水印宽度的单位：像素-pixel，百分比-percentage | query | false | string | | | imageWidthValue | 图片水印的宽度：值 | query | false | integer | | | isDefault | 是否为默认水印 | query | false | boolean | | | isDeleted | 是否已删除 | query | false | boolean | | | name | 水印名称 | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | storageSystem | 图片水印文件所在的存储系统：FastDFS、AliyunOSS、Local | query | false | string | | | textDx | 水平偏移：像素 | query | false | integer | | | textDy | 垂直偏移：像素 | query | false | integer | | | timestamp | 13位时间戳 | query | true | string | | | type | 水印类型：图片 | query | false | string | | **响应数据**: ```json { "code": 0, "data": { "bucketName": "", "content": "", "fileName": "", "fontAlpha": 0, "fontColor": "", "fontName": "", "fontSize": 0, "gmtCreate": "", "gmtModified": "", "id": 0, "imageDxUnit": "", "imageDxValue": 0, "imageDyUnit": "", "imageDyValue": 0, "imageHeightUnit": "", "imageHeightValue": 0, "imagePosition": "", "imageWidthUnit": "", "imageWidthValue": 0, "isDefault": true, "isDeleted": true, "name": "", "storageSystem": "", "textDx": 0, "textDy": 0, "type": "" }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | -------------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | TranscodingWatermark | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **TranscodingWatermark** | 参数名称 | 说明 | 类型 | schema | | ---------------- | -------------------------------------------------------- | --------- | ------ | | bucketName | 图片水印文件存储所在的空间或者组名 字段：bucket\_name | string | | | content | 文字水印的内容 字段：content | string | | | fileName | 水印素材的文件名 字段：file\_name | string | | | fontAlpha | 透明度：0-1 字段：font\_alpha | number | | | fontColor | 文字水印的颜色 字段：font\_color | string | | | fontName | 文字水印的字体 字段：font\_name | string | | | fontSize | 文字水印的字号：像素 字段：font\_size | int32 | | | gmtCreate | 创建时间 字段：gmt\_create | date-time | | | gmtModified | 最后修改时间 字段：gmt\_modified | date-time | | | id | 主键ID 字段：id | int64 | | | imageDxUnit | 图片水印水平偏移的单位：像素-pixel，百分比-percentage 字段：image\_dx\_unit | string | | | imageDxValue | 图片水印水平偏移：值 字段：image\_dx\_value | int32 | | | imageDyUnit | 图片水印垂直偏移的单位：像素-pixel，百分比-percentage 字段：image\_dy\_unit | string | | | imageDyValue | 图片水印垂直偏移：值 字段：image\_dy\_value | int32 | | | imageHeightUnit | 图片水印高度的单位：像素-pixel，百分比-percentage 字段：image\_height\_unit | string | | | imageHeightValue | 图片水印高度：值 字段：image\_height\_value | int32 | | | imagePosition | 图片水印的位置：左上、左下、右下、右上 字段：image\_position | string | | | imageWidthUnit | 图片水印宽度的单位：像素-pixel，百分比-percentage 字段：image\_width\_unit | string | | | imageWidthValue | 图片水印的宽度：值 字段：image\_width\_value | int32 | | | isDefault | 是否为默认水印 字段：is\_default | boolean | | | isDeleted | 是否已删除 字段：is\_deleted | boolean | | | name | 水印名称 字段：name | string | | | storageSystem | 图片水印文件所在的存储系统：FastDFS、AliyunOSS、Local 字段：storage\_system | string | | | textDx | 水平偏移：像素 字段：text\_dx | int32 | | | textDy | 垂直偏移：像素 字段：text\_dy | int32 | | | type | 水印类型：图片 - image、文字 - text 字段：type | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | --------------------------------------- | | 200 | OK | WrappedResponseV2«TranscodingWatermark» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 删除水印设置接口 **接口说明**:删除水印设置 **接口地址**:`/vod/v1/transcoding/delete` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | id | 需要删除的水印设置id | query | true | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 通过ID获取水印设置接口 **接口说明**:通过ID获取水印设置 **接口地址**:`/vod/v1/transcoding/get` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | id | 获取水印设置id | query | true | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "bucketName": "", "content": "", "fileName": "", "fontAlpha": 0, "fontColor": "", "fontName": "", "fontSize": 0, "gmtCreate": "", "gmtModified": "", "id": 0, "imageDxUnit": "", "imageDxValue": 0, "imageDyUnit": "", "imageDyValue": 0, "imageHeightUnit": "", "imageHeightValue": 0, "imagePosition": "", "imageWidthUnit": "", "imageWidthValue": 0, "isDefault": true, "isDeleted": true, "name": "", "storageSystem": "", "textDx": 0, "textDy": 0, "type": "" }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | -------------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | TranscodingWatermark | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **TranscodingWatermark** | 参数名称 | 说明 | 类型 | schema | | ---------------- | -------------------------------------------------------- | --------- | ------ | | bucketName | 图片水印文件存储所在的空间或者组名 字段：bucket\_name | string | | | content | 文字水印的内容 字段：content | string | | | fileName | 水印素材的文件名 字段：file\_name | string | | | fontAlpha | 透明度：0-1 字段：font\_alpha | number | | | fontColor | 文字水印的颜色 字段：font\_color | string | | | fontName | 文字水印的字体 字段：font\_name | string | | | fontSize | 文字水印的字号：像素 字段：font\_size | int32 | | | gmtCreate | 创建时间 字段：gmt\_create | date-time | | | gmtModified | 最后修改时间 字段：gmt\_modified | date-time | | | id | 主键ID 字段：id | int64 | | | imageDxUnit | 图片水印水平偏移的单位：像素-pixel，百分比-percentage 字段：image\_dx\_unit | string | | | imageDxValue | 图片水印水平偏移：值 字段：image\_dx\_value | int32 | | | imageDyUnit | 图片水印垂直偏移的单位：像素-pixel，百分比-percentage 字段：image\_dy\_unit | string | | | imageDyValue | 图片水印垂直偏移：值 字段：image\_dy\_value | int32 | | | imageHeightUnit | 图片水印高度的单位：像素-pixel，百分比-percentage 字段：image\_height\_unit | string | | | imageHeightValue | 图片水印高度：值 字段：image\_height\_value | int32 | | | imagePosition | 图片水印的位置：左上、左下、右下、右上 字段：image\_position | string | | | imageWidthUnit | 图片水印宽度的单位：像素-pixel，百分比-percentage 字段：image\_width\_unit | string | | | imageWidthValue | 图片水印的宽度：值 字段：image\_width\_value | int32 | | | isDefault | 是否为默认水印 字段：is\_default | boolean | | | isDeleted | 是否已删除 字段：is\_deleted | boolean | | | name | 水印名称 字段：name | string | | | storageSystem | 图片水印文件所在的存储系统：FastDFS、AliyunOSS、Local 字段：storage\_system | string | | | textDx | 水平偏移：像素 字段：text\_dx | int32 | | | textDy | 垂直偏移：像素 字段：text\_dy | int32 | | | type | 水印类型：图片 - image、文字 - text 字段：type | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | --------------------------------------- | | 200 | OK | WrappedResponseV2«TranscodingWatermark» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 获取水印设置列表接口 **接口说明**:获取水印设置列表 **接口地址**:`/vod/v1/transcoding/list` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | page | 页码 | query | false | integer | | | pageSize | 每页大小 | query | false | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": [ { "bucketName": "", "content": "", "fileName": "", "fontAlpha": 0, "fontColor": "", "fontName": "", "fontSize": 0, "gmtCreate": "", "gmtModified": "", "id": 0, "imageDxUnit": "", "imageDxValue": 0, "imageDyUnit": "", "imageDyValue": 0, "imageHeightUnit": "", "imageHeightValue": 0, "imagePosition": "", "imagePositionDesc": "", "imageUrl": "", "imageWidthUnit": "", "imageWidthValue": 0, "isDefault": true, "isDeleted": true, "name": "", "storageSystem": "", "textDx": 0, "textDy": 0, "type": "" } ], "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ----------------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | array | TranscodingWatermarkDTO | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **TranscodingWatermarkDTO** | 参数名称 | 说明 | 类型 | schema | | ----------------- | -------------------------------------------------------- | --------- | ------ | | bucketName | 图片水印文件存储所在的空间或者组名 字段：bucket\_name | string | | | content | 文字水印的内容 字段：content | string | | | fileName | 水印素材的文件名 字段：file\_name | string | | | fontAlpha | 透明度：0-1 字段：font\_alpha | number | | | fontColor | 文字水印的颜色 字段：font\_color | string | | | fontName | 文字水印的字体 字段：font\_name | string | | | fontSize | 文字水印的字号：像素 字段：font\_size | int32 | | | gmtCreate | 创建时间 字段：gmt\_create | date-time | | | gmtModified | 最后修改时间 字段：gmt\_modified | date-time | | | id | 主键ID 字段：id | int64 | | | imageDxUnit | 图片水印水平偏移的单位：像素-pixel，百分比-percentage 字段：image\_dx\_unit | string | | | imageDxValue | 图片水印水平偏移：值 字段：image\_dx\_value | int32 | | | imageDyUnit | 图片水印垂直偏移的单位：像素-pixel，百分比-percentage 字段：image\_dy\_unit | string | | | imageDyValue | 图片水印垂直偏移：值 字段：image\_dy\_value | int32 | | | imageHeightUnit | 图片水印高度的单位：像素-pixel，百分比-percentage 字段：image\_height\_unit | string | | | imageHeightValue | 图片水印高度：值 字段：image\_height\_value | int32 | | | imagePosition | 图片水印的位置：左上、左下、右下、右上 字段：image\_position | string | | | imagePositionDesc | 水印位置的中文描述 | string | | | imageUrl | 水印图片的访问URL | string | | | imageWidthUnit | 图片水印宽度的单位：像素-pixel，百分比-percentage 字段：image\_width\_unit | string | | | imageWidthValue | 图片水印的宽度：值 字段：image\_width\_value | int32 | | | isDefault | 是否为默认水印 字段：is\_default | boolean | | | isDeleted | 是否已删除 字段：is\_deleted | boolean | | | name | 水印名称 字段：name | string | | | storageSystem | 图片水印文件所在的存储系统：FastDFS、AliyunOSS、Local 字段：storage\_system | string | | | textDx | 水平偏移：像素 字段：text\_dx | int32 | | | textDy | 垂直偏移：像素 字段：text\_dy | int32 | | | type | 水印类型：图片 - image、文字 - text 字段：type | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ------------------------------------------------ | | 200 | OK | WrappedResponseV2«List«TranscodingWatermarkDTO»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 分页获取水印设置列表接口 **接口说明**:分页获取水印设置列表 **接口地址**:`/vod/v1/transcoding/list-by-page` **请求方式**：`get` **consumes**:\`\` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | page | 页码 | query | false | integer | | | pageSize | 每页大小 | query | false | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": { "contents": [ { "bucketName": "", "content": "", "fileName": "", "fontAlpha": 0, "fontColor": "", "fontName": "", "fontSize": 0, "gmtCreate": "", "gmtModified": "", "id": 0, "imageDxUnit": "", "imageDxValue": 0, "imageDyUnit": "", "imageDyValue": 0, "imageHeightUnit": "", "imageHeightValue": 0, "imagePosition": "", "imageWidthUnit": "", "imageWidthValue": 0, "isDefault": true, "isDeleted": true, "name": "", "storageSystem": "", "textDx": 0, "textDy": 0, "type": "" } ], "endRow": 0, "firstPage": true, "hasNextPage": true, "hasPreviousPage": true, "lastPage": true, "limit": 0, "nextPageNumber": 0, "offset": 0, "pageNumber": 0, "pageSize": 0, "previousPageNumber": 0, "startRow": 0, "totalItems": 0, "totalPages": 0 }, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | -------------------------- | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | string | Page«TranscodingWatermark» | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **schema属性说明** **Page«TranscodingWatermark»** | 参数名称 | 说明 | 类型 | schema | | ------------------ | ----------- | ------- | -------------------- | | contents | 当前页的内容。 | array | TranscodingWatermark | | endRow | | int64 | | | firstPage | | boolean | | | hasNextPage | | boolean | | | hasPreviousPage | | boolean | | | lastPage | | boolean | | | limit | | int64 | | | nextPageNumber | | int32 | | | offset | | int64 | | | pageNumber | 当前页。 | int32 | | | pageSize | 每页最多显示的记录数。 | int32 | | | previousPageNumber | | int32 | | | startRow | | int64 | | | totalItems | 总记录数。 | int64 | | | totalPages | | int32 | | **TranscodingWatermark** | 参数名称 | 说明 | 类型 | schema | | ---------------- | -------------------------------------------------------- | --------- | ------ | | bucketName | 图片水印文件存储所在的空间或者组名 字段：bucket\_name | string | | | content | 文字水印的内容 字段：content | string | | | fileName | 水印素材的文件名 字段：file\_name | string | | | fontAlpha | 透明度：0-1 字段：font\_alpha | number | | | fontColor | 文字水印的颜色 字段：font\_color | string | | | fontName | 文字水印的字体 字段：font\_name | string | | | fontSize | 文字水印的字号：像素 字段：font\_size | int32 | | | gmtCreate | 创建时间 字段：gmt\_create | date-time | | | gmtModified | 最后修改时间 字段：gmt\_modified | date-time | | | id | 主键ID 字段：id | int64 | | | imageDxUnit | 图片水印水平偏移的单位：像素-pixel，百分比-percentage 字段：image\_dx\_unit | string | | | imageDxValue | 图片水印水平偏移：值 字段：image\_dx\_value | int32 | | | imageDyUnit | 图片水印垂直偏移的单位：像素-pixel，百分比-percentage 字段：image\_dy\_unit | string | | | imageDyValue | 图片水印垂直偏移：值 字段：image\_dy\_value | int32 | | | imageHeightUnit | 图片水印高度的单位：像素-pixel，百分比-percentage 字段：image\_height\_unit | string | | | imageHeightValue | 图片水印高度：值 字段：image\_height\_value | int32 | | | imagePosition | 图片水印的位置：左上、左下、右下、右上 字段：image\_position | string | | | imageWidthUnit | 图片水印宽度的单位：像素-pixel，百分比-percentage 字段：image\_width\_unit | string | | | imageWidthValue | 图片水印的宽度：值 字段：image\_width\_value | int32 | | | isDefault | 是否为默认水印 字段：is\_default | boolean | | | isDeleted | 是否已删除 字段：is\_deleted | boolean | | | name | 水印名称 字段：name | string | | | storageSystem | 图片水印文件所在的存储系统：FastDFS、AliyunOSS、Local 字段：storage\_system | string | | | textDx | 水平偏移：像素 字段：text\_dx | int32 | | | textDy | 垂直偏移：像素 字段：text\_dy | int32 | | | type | 水印类型：图片 - image、文字 - text 字段：type | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | --------------------------------------------- | | 200 | OK | WrappedResponseV2«Page«TranscodingWatermark»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 设置为默认水印接口 **接口说明**:设置水印为默认水印 **接口地址**:`/vod/v1/transcoding/set-default` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | --------- | ------------------------------------------------------------------------------------------------------------- | ----- | ---- | ------- | ------ | | appId | 应用ID | query | true | string | | | id | 需要设置默认的水印设置id | query | true | integer | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | timestamp | 13位时间戳 | query | true | string | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 修改水印设置接口 **接口说明**:修改水印设置 **接口地址**:`/vod/v1/transcoding/update` **请求方式**：`post` **consumes**:`["application/json"]` **produces**:`["application/json;charset=UTF-8"]` **请求参数**： | 参数名称 | 说明 | in | 是否必须 | 类型 | schema | | ---------------- | ------------------------------------------------------------------------------------------------------------- | ----- | ----- | ------- | ------ | | appId | 应用ID | query | true | string | | | bucketName | 图片水印文件存储所在的空间或者组名 | query | false | string | | | content | 文字水印的内容 | query | false | string | | | fileName | 水印素材的文件名 | query | false | string | | | fontAlpha | 透明度：0-1 | query | false | number | | | fontColor | 文字水印的颜色 | query | false | string | | | fontName | 文字水印的字体 | query | false | string | | | fontSize | 文字水印的字号：像素 | query | false | integer | | | gmtCreate | 创建时间 | query | false | string | | | gmtModified | 最后修改时间 | query | false | string | | | id | 主键ID | query | false | integer | | | imageDxUnit | 图片水印水平偏移的单位：像素-pixel，百分比-percentage | query | false | string | | | imageDxValue | 图片水印水平偏移：值 | query | false | integer | | | imageDyUnit | 图片水印垂直偏移的单位：像素-pixel，百分比-percentage | query | false | string | | | imageDyValue | 图片水印垂直偏移：值 | query | false | integer | | | imageHeightUnit | 图片水印高度的单位：像素-pixel，百分比-percentage | query | false | string | | | imageHeightValue | 图片水印高度：值 | query | false | integer | | | imagePosition | 图片水印的位置：左上、左下、右下、右上 | query | false | string | | | imageWidthUnit | 图片水印宽度的单位：像素-pixel，百分比-percentage | query | false | string | | | imageWidthValue | 图片水印的宽度：值 | query | false | integer | | | isDefault | 是否为默认水印 | query | false | boolean | | | isDeleted | 是否已删除 | query | false | boolean | | | name | 水印名称 | query | false | string | | | sign | 签名校验的参数，生成规则：将请求接口提交的其他所有参数（不包括非空参数），按照首字母字典序排序后，再按照 “参数参数值参数参数值“的方式排列，然后在首尾添加secretKey，最后进行MD5加密转大写，即为sign的值 | query | true | string | | | storageSystem | 图片水印文件所在的存储系统：FastDFS、AliyunOSS、Local | query | false | string | | | textDx | 水平偏移：像素 | query | false | integer | | | textDy | 垂直偏移：像素 | query | false | integer | | | timestamp | 13位时间戳 | query | true | string | | | type | 水印类型：图片 | query | false | string | | **响应数据**: ```json { "code": 0, "data": {}, "message": "", "status": "" } ``` **响应参数说明**: | 参数名称 | 说明 | 类型 | schema | | ------- | ---------------------------------------- | ------ | ------ | | code | HTTP响应状态码. | int32 | | | data | 成功放回数据. | object | | | message | 错误信息. | string | | | status | 请求状态，成功："success"，失败："fail", 错误："error". | string | | **响应状态码说明**: | 状态码 | 说明 | schema | | --- | ------------ | ----------------- | | 200 | OK | WrappedResponseV2 | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | |