获取音视频播放时所需的播放凭证。
接口说明
使用说明
- 使用阿里云播放器SDK（适用于PlayAuth播放方式），调用本接口来获取播放凭证，阿里云播放器SDK通过播放凭证自动获取播放地址进行播放。
- 如果播放凭证过期则无法获取播放地址，需要重新获取播放凭证。
QPS限制
本接口的单用户QPS限制为360次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vod:GetVideoPlayAuth | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| VideoId | string | 是 | 音/视频ID。可通过以下方式获取：
| dfde02284a5c46622a097adaf44a**** |
| AuthInfoTimeout | long | 否 | 播放凭证过期时间，单位：秒。如果凭证过期则无法获取播放地址，需要重新获取凭证。
| 100 |
| ApiVersion | string | 否 | API版本号，固定取值为1.0.0。 | 1.0.0 |
返回参数
示例
正常返回示例
JSON格式
{
"PlayAuth": "sstyYuew6789000000xtt7TYUh****",
"RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
"VideoMeta": {
"Status": "Normal",
"Duration": 120,
"Title": "阿里云VOD",
"VideoId": "dfde02284a5c46622a097adaf44a****",
"CoverURL": "https://example.aliyundoc.com/****.jpg"
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||
|---|---|---|---|---|---|---|
| 2021-11-02 | OpenAPI 入参发生变更 | |||||
|
接口错误码
下表列举了本接口特有的错误码。
| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |
|---|---|---|---|
| Forbidden.IllegalStatus | Status of the video is illegal. | 403 | 视频状态无效。 |
| InvalidVideo.NotFound | The video does not exist. | 404 | 视频不存在。 |
| MissingVideoId | VideoId is mandatory for this action. | 400 | VideoId参数是必选项。 |