全部产品
云市场

Appserver控制台接口文档

更新时间:2019-07-01 10:30:35

简介

本文档主要介绍趣视频控制台接口调用方法和返回值。

返回值结构说明

所有请求均返回此JSON格式的数据,所有API只描述[data]结构数据。

result bool 操作是否成功
requestId string 服务端生成的本次请求ID。
code string 服务端生成的本次请求code。
message string 服务端消息多用于描述错误原因。
data object 服务端返回的业务结构体数据,不同业务数据结构不同。

控制台

getVideos

查询条件获取视频列表。

method get
url /console/vod/getVideos
param
名称 类型 是否必需 描述
consoletoken string token
pageIndex int 起始页 (从1开始)
pageSize int 每页条数
videoId string 视频id
userId string 用户id
title string 标题
startTime string 开始时间
endTime string 结束时间
userName string 用户名
censorStatus string 审核状态
return param
名称 类型 描述
total string 视频总条数
videoList List<Video> 个人中心视频信息列表

Video

名称 类型 描述
title string 视频标题
videoId string 视频id
description string 视频描述
duration string 视频时长(秒)
coverUrl string 视频封面URL
status string 视频状态
firstFrameUrl string 首帧地址
size string 视频源文件大小(字节)。
tags string 视频标签.多个用逗号分隔。
cateId string 视频分类。
cateName string 视频分类名称。
creationTime string 创建时间
transcodeStatus string 转码状态。
snapshotStatus string 截图状态
censorStatus string 审核状态
narrowTranscodeStatus string 窄带高清转码状态
SnapshotList list 截图列表
fileUrlList list 视频地址列表
user User 用户

User

名称 类型 描述
userId string 用户id
userName string 用户名
avatarUrl string 头像url

result:

  1. {
  2. "result": "true",
  3. "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "total": 7,
  8. "videoList": [
  9. {
  10. "id": "25",
  11. "videoId": "23rfewc23",
  12. "title": "test video",
  13. "description": "test33",
  14. "duration": 12,
  15. "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
  16. "creationTime": "2019-01-09 22:11:29.0",
  17. "status": "",
  18. "firstFrameUrl": "",
  19. "size": 56,
  20. "cateId": 12,
  21. "cateName": "12",
  22. "tags": "测试",
  23. "shareUrl": "",
  24. "user": {
  25. "userId": "2434793223202",
  26. "userName": "Anne",
  27. "avatarUrl": "https://alivc-demo-vod.aliyuncs.com/dd38cab5-2951-43a0-b9ed-ad0eebf83a70"
  28. },
  29. "transcodeStatus": "",
  30. "snapshotStatus": "",
  31. "censorStatus": "onCensor",
  32. "narrowTranscodeStatus": "",
  33. "SnapshotList": { "http://sample/covers/990f3820db2948b5b4a13d65d9a449f6-2.jpg"
  34. , "http://sample/covers/sprite/990f3820db2948b5b4a13d65d9a449f6-1.jpg"
  35. },
  36. "fileUrlList": { "http://vod.aliyunsample.com/ABEBDE15CC479FD4D1329/52a53151eba5226f8e2da3b55bc57c49.mp4"
  37. , "http://vod.aliyunsample.com/ABEBDE15CC479FD4D1329/52a53151eba5226f8e2da3b55bc57c49.mp4"
  38. }
  39. }
  40. ]
  41. }
  42. }

submitTranscode

发起非窄带高清转码

method get
url /console/vod/submitTranscode
param
名称 类型 是否必需 描述
consoletoken string token
mediaId String 视频id
return param
名称 类型 描述

result:

  1. {
  2. "result": "true",
  3. "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  4. "message": "发起非窄带高清转码作业完成!",
  5. "code": "200",
  6. "data": null
  7. }

createAudit

手动人工审核。

method get
url /console/vod/createAudit
param
名称 类型 是否必需 描述
consoletoken string token
mediaId String 视频id
status String 状态(Blocked(屏蔽),Normal(正常))
reason String 若审核状态为屏蔽时,需给出屏蔽的理由,最长支持128字节。
comment String 备注
return param
名称 类型 描述

result:

  1. {
  2. "result": "true",
  3. "requestId": "c312edd-1dc3-132r313rfef-qfevw42ghrnk",
  4. "message": "审核完成",
  5. "code": "200",
  6. "data": null
  7. }

submitTranscode

发起窄带高清转码。

method get
url /console/vod/submitTabTranscode
param
名称 类型 是否必需 描述
consoletoken string token
mediaId String 视频id
return param
名称 类型 描述

result:

  1. {
  2. "result": "true",
  3. "requestId": "dsgb455-e85f-443f9-a50a-12323rfg34t34g",
  4. "message": "发起窄带高清转码作业完成!",
  5. "code": "200",
  6. "data": null
  7. }

getVideoById

根据videoId查询视频详情。

method get
url /console/vod/getVideoById
param
名称 类型 是否必需 描述
consoletoken string token
videoId string 视频id
return param
名称 类型 描述
title string 视频标题
videoId string 视频id
description string 视频描述
duration string 视频时长(秒)
coverUrl string 视频封面URL
status string 视频状态
firstFrameUrl string 首帧地址
size string 视频源文件大小(字节)。
tags string 视频标签.多个用逗号分隔。
cateId string 视频分类。
cateName string 视频分类名称。
creationTime string 创建时间
transcodeStatus string 转码状态。
snapshotStatus string 截图状态
censorStatus string 审核状态
narrowTranscodeStatus string 窄带高清转码状态
SnapshotList list 截图列表
fileUrilList list 视频地址列表
user User 用户

User

名称 类型 描述
userId string 用户id
userName string 用户名
avatarUrl string 头像url

result:

  1. {
  2. "result": "true",
  3. "requestId": "f8163b40-6192-4edc-97ec-52c6cd96e996",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "id": "25",
  8. "videoId": "23rfewc23",
  9. "title": "test video",
  10. "description": "test33",
  11. "duration": 12,
  12. "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
  13. "creationTime": "2019-01-09 22:11:29.0",
  14. "status": "",
  15. "firstFrameUrl": "",
  16. "size": 56,
  17. "cateId": 12,
  18. "cateName": "12",
  19. "tags": "测试",
  20. "shareUrl": "",
  21. "user": {
  22. "userId": "2434793223202",
  23. "userName": "Anne",
  24. "avatarUrl": "https://alivc-demo-vod.aliyuncs.com/dd38cab5-2951-43a0-b9ed-ad0eebf83a70"
  25. },
  26. "transcodeStatus": "",
  27. "snapshotStatus": "",
  28. "censorStatus": "onCensor",
  29. "narrowTranscodeStatus": "",
  30. "SnapshotList": { "http://sample/covers/990f3820db2948b5b4a13d65d9a449f6-2.jpg"
  31. , "http://sample/covers/sprite/990f3820db2948b5b4a13d65d9a449f6-1.jpg"
  32. },
  33. "fileUrilList": { "http://vod.aliyunsample.com/ABEBDE15CC479FD4D1329/52a53151eba5226f8e2da3b55bc57c49.mp4"
  34. , "http://vod.aliyunsample.com/ABEBDE15CC479FD4D1329/52a53151eba5226f8e2da3b55bc57c49.mp4"
  35. }
  36. }
  37. }

getRecommendVideos

查询条件获取推荐视频列表。

method get
url /console/vod/getRecommendVideos
param
名称 类型 是否必需 描述
consoletoken string token
pageIndex int 起始页 (从1开始)
pageSize int 每页条数
videoId string 视频id
userId string 用户id
title string 标题
startTime string 开始时间
endTime string 结束时间
userName string 用户名
censorStatus string 审核状态
return param
名称 类型 描述
total string 视频总条数
videoList List<Video> 个人中心视频信息列表

Video

名称 类型 描述
title string 视频标题
videoId string 视频id
description string 视频描述
duration string 视频时长(秒)
coverUrl string 视频封面URL
status string 视频状态
firstFrameUrl string 首帧地址
size string 视频源文件大小(字节)。
tags string 视频标签.多个用逗号分隔。
cateId string 视频分类。
cateName string 视频分类名称。
creationTime string 创建时间
transcodeStatus string 转码状态。
snapshotStatus string 截图状态
censorStatus string 审核状态
narrowTranscodeStatus string 窄带高清转码状态
SnapshotList list 截图列表
fileUrlList list 视频地址列表
user User 用户

User

名称 类型 描述
userId string 用户id
userName string 用户名
avatarUrl string 头像url

result:

  1. {
  2. "result": "true",
  3. "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "total": 7,
  8. "videoList": [
  9. {
  10. "id": "25",
  11. "videoId": "23rfewc23",
  12. "title": "test video",
  13. "description": "test33",
  14. "duration": 12,
  15. "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
  16. "creationTime": "2019-01-09 22:11:29.0",
  17. "status": "",
  18. "firstFrameUrl": "",
  19. "size": 56,
  20. "cateId": 12,
  21. "cateName": "12",
  22. "tags": "测试",
  23. "shareUrl": "",
  24. "user": {
  25. "userId": "2434793223202",
  26. "userName": "Anne",
  27. "avatarUrl": "https://alivc-demo-vod.aliyuncs.com/dd38cab5-2951-43a0-b9ed-ad0eebf83a70"
  28. },
  29. "transcodeStatus": "",
  30. "snapshotStatus": "",
  31. "censorStatus": "onCensor",
  32. "narrowTranscodeStatus": ""
  33. }
  34. ]
  35. }
  36. }

recommendVideo

推荐视频到推荐列表中。

method post
url /console/vod/recommendVideo
param
名称 类型 是否必需 描述
consoletoken string token
title string 视频标题
videoId string 视频id
userId string 用户id
description string 视频描述
duration String 视频时长(秒)
coverUrl string 视频封面URL
size String 视频源文件大小(字节)。
tags string 视频标签.多个用逗号分隔。
cateId String 视频分类。
cateName string 视频分类名称。
firstFrameUrl string 首帧图
transcodeStatus String 转码状态(非窄带高清)
snapshotStatus string 截图状态
censorStatus String 审核状态
isNarrow String 是否窄带高清
isCache String 是否预热

result:

  1. {
  2. "result": "true",
  3. "requestId": "f8163b40-6192-4edc-97ec-52c6cd96e996",
  4. "message": "插入推荐视频成功!",
  5. "code": "200",
  6. "data":null
  7. }

pushObjectCache

预热缓存。

method post
url /console/vod/pushObjectCache
param
名称 类型 是否必需 描述
consoletoken string token
objectPath string 对象地址,输入示例:a.com/image/1.png,多个URL间用换行符(\n或\r\n)分隔 。

result:

  1. {
  2. "result": "true",
  3. "requestId": "f8163b40-6192-4edc-97ec-52c6cd96e996",
  4. "message": "预热完成",
  5. "code": "200",
  6. "data":null
  7. }

getRecommendVideoById

根据videoId查询推荐视频详情。

method get
url /console/vod/getRecommendVideoById
param
名称 类型 是否必需 描述
consoletoken string token
videoId string 视频id
return param
名称 类型 描述
title string 视频标题
videoId string 视频id
description string 视频描述
duration string 视频时长(秒)
coverUrl string 视频封面URL
status string 视频状态
firstFrameUrl string 首帧地址
size string 视频源文件大小(字节)。
tags string 视频标签.多个用逗号分隔。
cateId string 视频分类。
cateName string 视频分类名称。
creationTime string 创建时间
transcodeStatus string 转码状态。
snapshotStatus string 截图状态
censorStatus string 审核状态
narrowTranscodeStatus string 窄带高清转码状态
SnapshotList list 截图列表
fileUrilList list 视频地址列表
user User 用户

User

名称 类型 描述
userId string 用户id
userName string 用户名
avatarUrl string 头像url

result:

  1. {
  2. "result": "true",
  3. "requestId": "f8163b40-6192-4edc-97ec-52c6cd96e996",
  4. "message": "根据videoId获取视频详情完成!",
  5. "code": "200",
  6. "data": {
  7. "id": "25",
  8. "videoId": "23rfewc23",
  9. "title": "test video",
  10. "description": "test33",
  11. "duration": 12,
  12. "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
  13. "creationTime": "2019-01-09 22:11:29.0",
  14. "status": "",
  15. "firstFrameUrl": "",
  16. "size": 56,
  17. "cateId": 12,
  18. "cateName": "12",
  19. "tags": "测试",
  20. "shareUrl": "",
  21. "user": {
  22. "userId": "2434793223202",
  23. "userName": "Anne",
  24. "avatarUrl": "https://alivc-demo-vod.aliyuncs.com/dd38cab5-2951-43a0-b9ed-ad0eebf83a70"
  25. },
  26. "transcodeStatus": "success",
  27. "snapshotStatus": "success",
  28. "censorStatus": "onCensor",
  29. "narrowTranscodeStatus": "onCensor"
  30. }
  31. }

deleteVideoById

删除视频。

method post
url /console/vod/deleteVideoById
param
名称 类型 是否必需 描述
consoletoken string token
videoId string 视频id
userId string 用户id

result:

  1. {
  2. "result": "true",
  3. "requestId": "f9a8sdf09iaf3-2f23r23-0965iyhk4",
  4. "message": 删除完成!,
  5. "code": "200",
  6. "data":null
  7. }

deleteRecommendById

取消推荐。

method post
url /console/vod/deleteRecommendById
param
名称 类型 是否必需 描述
consoletoken string token
videoId string 视频id

result:

  1. {
  2. "result": "true",
  3. "requestId": "f8163b40-6192-4edc-97ec-52c6cd96e996",
  4. "message": "取消推荐完成",
  5. "code": "200",
  6. "data":null
  7. }

login

控制台登录。

method post
url /console/user/login
param
名称 类型 是否必需 描述
userName string 用户名
password string 密码

result:

  1. {
  2. "result": "true",
  3. "requestId": "c30f63ed-3f66-45e9-9df0-a15e7d3a7e6a",
  4. "message": "登录成功!",
  5. "code": "200",
  6. "data": {
  7. "consoleToken": "12351232334123456781548765480698"
  8. }
  9. }

signOut

控制台退出登录。

method post
url /console/user/signOut
param
名称 类型 是否必需 描述
userName string 用户名
password string 密码

result:

  1. {
  2. "result": "true",
  3. "requestId": "d4b6405b-86fb-45e7-826c-68b69926147b",
  4. "message": "退出完成!",
  5. "code": "200",
  6. "data": null
  7. }