使用GetVideoPlayAuth获取音视频播放凭证-视频点播-阿里云

调用本接口获取音视频的播放凭证（PlayAuth）。阿里云播放器SDK使用该凭证自动获取播放地址。由于播放凭证具有时效性，且与特定音视频绑定，不可混用或重复使用，因此凭证过期或无效将导致无法播放。此播放方式适用于需要高安全性的音视频播放场景。

接口说明

使用阿里云播放器 SDK（适用于 PlayAuth 播放方式），调用本接口来获取播放凭证，阿里云播放器 SDK 通过播放凭证自动获取播放地址进行播放，更多信息，请参见阿里云播放器 SDK。
如果播放凭证过期则无法获取播放地址，需要重新获取播放凭证。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vod:GetVideoPlayAuth

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
VideoId	string	否	音/视频 ID，仅支持传入单个音/视频 ID。可通过以下方式获取：通过控制台上传的视频，可登录点播控制台，选择媒资库 > 音/视频查看音/视频 ID。通过 CreateUploadVideo 接口上传音/视频时，音/视频 ID 为返回参数 VideoId 的值。音/视频上传后，可通过 SearchMedia 接口查询音/视频 ID，为请求后返回参数 VideoId 的值。	dfde02284a5c46622a097adaf44a****
AuthInfoTimeout	integer	否	播放凭证过期时间，单位：秒。如果凭证过期则无法获取播放地址，需要重新获取凭证。默认为 100 秒。取值范围：`[100,3000]`。	100
ApiVersion	string	否	API 版本号，固定取值为1.0.0。	1.0.0
ReferenceId	string	否		123-123

返回参数

名称	类型	描述	示例值
	object	返回结果。
PlayAuth	string	音/视频播放凭证。	sstyYuew6789000000xtt7TYUh****
RequestId	string	请求 ID。	E4EBD2BF-5EB0-4476-8829-9D94E1B1****
VideoMeta	object	音/视频 Meta 信息。
Status	string	音/视频状态。各取值及描述，请参见Status：音视频状态。	Normal
Duration	number	音/视频时长。单位：秒。	120.0
Title	string	音/视频标题。	阿里云VOD
VideoId	string	音/视频 ID。	dfde02284a5c46622a097adaf44a****
CoverURL	string	音/视频封面地址。	https://example.aliyundoc.com/****.jpg

示例

正常返回示例

JSON格式

{
  "PlayAuth": "sstyYuew6789000000xtt7TYUh****",
  "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
  "VideoMeta": {
    "Status": "Normal",
    "Duration": 120,
    "Title": "阿里云VOD",
    "VideoId": "dfde02284a5c46622a097adaf44a****",
    "CoverURL": "https://example.aliyundoc.com/****.jpg"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。