API指引-视频点播(VOD)-阿里云帮助中心

本文介绍VodAppServer的API接口。

播单管理

创建播单

接口地址：POST /appServer/createPlaylist。

请求参数：

{
  "playlistName": "精选短剧合集",
  "playlistDescribe": "2024年最受欢迎的短剧",
  "playlistTags": "爱情,都市,热播",
  "playlistCoverUrl": "IMAGE_ID",
  "playlistVideos": "[{\"VideoId\":\"video1\",\"Title\":\"第1集\"}]"
}

参数说明：

名称	类型	必填	描述
playlistName	String	是	播单名称。
playlistDescribe	String	否	播单描述。
playlistTags	String	否	播单标签，以逗号分隔。
playlistCoverUrl	String	否	播单封面地址。
playlistVideos	String	否	播单媒资列表，为JSON字符串。

响应示例：

{
  "playlistId": "pl_xxx",
  "requestId": "xxx"
}

删除播单

接口地址：POST /appServer/deletePlaylists。

请求参数：

{
  "playlistIds": "pl_001,pl_002",
  "forceDelete": false
}

参数说明：

名称

类型

必填

描述

playlistIds

String

是

播单ID，以逗号分隔。

forceDelete

Boolean

否

是否强制删除，取值：

true。
false（默认）。

说明

forceDelete参数为false时仅允许删除空播单，为true时允许删除含视频的播单，删除播单不会删除相关媒资。

获取播单详情

接口地址：POST /appServer/getPlaylist。

请求参数：

{
  "playlistId": "pl_xxx"
}

响应示例：

{
  "playlistId": "pl_xxx",
  "playlistName": "精选短剧合集",
  "playlistDescribe": "2024年最受欢迎的短剧",
  "playlistStatus": "Normal",
  "playlistTags": "爱情,都市,热播",
  "playlistCoverUrl": "https://xxx.oss.com/cover.jpg",
  "createTime": "2025-01-01T00:00:00Z",
  "playlistVideos": [
    {
      "videoId": "video1",
      "title": "第1集",
      "coverUrl": "https://xxx.oss.com/video1.jpg",
      "sortKey": 1
    }
  ]
}

获取播单列表

接口地址：POST /appServer/getPlaylists。

请求参数：

{
  "pageNo": "1",
  "pageSize": "10",
  "sortBy": "CreationTime:Desc"
}

参数说明：

名称	类型	必填	描述
pageNo	String	是	播单列表分页页数。
pageSize	String	否	播单列表分页每页数量，默认值为10。
sortBy	String	否	播单列表排序规则，以冒号分隔，左边为排序项，右边为排序规则，取值： ● asc（默认）。 ● desc。

更新播单基本信息

接口地址：POST /appServer/updatePlaylistBasicInfo。

请求参数：

{
  "playlistId": "pl_xxx",
  "playlistName": "超级热播短剧",
  "playlistDescribe": "最新热播短剧精选",
  "playlistStatus": "Normal",
  "playlistTags": "热门,推荐",
  "playlistCoverUrl": "new_image_id"
}

参数说明：

名称	类型	必填	描述
playlistId	String	是	播单ID。
playlistName	String	否	播单名称。
playlistDescribe	String	否	播单描述。
playlistStatus	String	否	播单状态，取值： Normal。 Disabled。
playlistTags	String	否	播单标签，以逗号分隔。
playlistCoverUrl	String	否	播单封面地址。

添加播单视频

接口地址：POST /appServer/addPlaylistVideos。

请求参数：

{
  "playlistId": "pl_xxx",
  "preVideoId": "video1",
  "playlistVideos": "[{\"VideoId\":\"video2\",\"Title\":\"第2集\",\"Description\":\"剧情介绍\",\"CoverUrl\":\"image_id\"}]"
}

参数说明：

名称	类型	必填	描述
playlistId	String	是	播单ID。
preVideoId	String	否	前置媒资ID，为空则添加至末尾。
playlistVideos	String	是	添加的播单媒资列表，为JSON字符串。

删除播单视频

接口地址：POST /appServer/deletePlaylistVideos。

请求参数：

{
  "playlistId": "pl_xxx",
  "videoIds": "video1,video2"
}

说明

仅删除媒资与播单关联，不删除媒资本身。

更新播单视频列表

接口地址：POST /appServer/updatePlaylistVideos。

请求参数：

{
  "playlistId": "pl_xxx",
  "videoIds": "video1,video2,video3"
}

获取播单详情

接口地址：POST /appServer/getPlaylistInfo?playListId=pl_xxx。

响应示例：

{
  "code": 0,
  "httpCode": "200",
  "success": true,
  "data": {
    "playlistId": "pl_xxx",
    "playlistName": "精选短剧合集",
    "playlistCoverUrl": "https://xxx.oss.com/cover.jpg",
    "playlistVideos": [
      {
        "videoId": "video1",
        "title": "第1集",
        "playAuth": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
        "coverUrl": "https://xxx.oss.com/video1.jpg"
      }
    ]
  }
}

说明

获取播单详情时：

自动生成playAuth播放凭证。
封面图媒资ImageId自动转换为可访问URL。
未传playListId参数时将返回首个播单详情。

获取播单列表

接口地址：POST /appServer/getPlaylistVideos。

请求参数：

{
  "pageNo": "1",
  "pageSize": "10"
}

说明

获取播单列表时：

每个播单包含首个视频作为预览（包含播放凭证）。
封面图媒资ImageId自动转换为可访问URL。

媒体处理

提交转码任务

接口地址：POST /submitTransCodeJob?videoId=xxx&templateGroupId=xxx。

参数说明：

名称	类型	必填	描述
videoId	String	是	媒资ID。
templateGroupId	String	是	转码模板组ID，可参考转码模板组创建和获取。

系统接口

健康检查

接口地址：GET/POST /appServer/health。

响应示例：

{
  "code": 0,
  "httpCode": "200",
  "success": true,
  "message": "服务响应成功"
}

错误码

业务错误码

错误码	说明	解决方案
0	成功。	-
10001	参数无效。	请检查请求参数格式。
10002	参数为空。	请补充必填参数。
10003	参数类型错误。	请检查参数类型。
10004	参数缺失。	请补充缺失参数。
40001	系统内部错误。	请查看日志排查。