调用GetVideoPlayAuth获取音视频播放时所需的播放凭证。
使用说明
- 使用阿里云播放器SDK(适用于PlayAuth播放方式),调用本接口来获取播放凭证,阿里云播放器SDK通过播放凭证自动获取播放地址进行播放。
- 如果播放凭证过期则无法获取播放地址,需要重新获取播放凭证。
QPS限制
本接口的单用户QPS限制为360次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetVideoPlayAuth |
系统规定参数。取值:GetVideoPlayAuth。 |
VideoId | String | 是 | dfde02284a5c46622a097adaf44a**** |
音/视频ID。可通过以下方式获取:
|
AuthInfoTimeout | Long | 否 | 100 |
播放凭证过期时间,单位:秒。如果凭证过期则无法获取播放地址,需要重新获取凭证。
|
ApiVersion | String | 否 | 1.0.0 |
API版本号,固定取值为1.0.0。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PlayAuth | String | sstyYuew6789000000xtt7TYUh**** |
音/视频播放凭证。 |
RequestId | String | E4EBD2BF-5EB0-4476-8829-9D94E1B1**** |
请求ID。 |
VideoMeta | Object |
音/视频Meta信息。 |
|
Status | String | Normal |
音/视频状态。具体取值范围及描述,请参见视频状态Status的取值列表。 |
Duration | Float | 120.0 |
音/视频时长。单位:秒。 |
Title | String | 阿里云VOD |
音/视频标题。 |
VideoId | String | dfde02284a5c46622a097adaf44a**** |
音/视频ID。 |
CoverURL | String | https://example.aliyundoc.com/****.jpg |
音/视频封面地址。 |
示例
请求示例
http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetVideoPlayAuth
&VideoId=dfde02284a5c46622a097adaf44a****
&AuthInfoTimeout=100
&ApiVersion=1.0.0
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetVideoPlayAuthResponse>
<PlayAuth>sstyYuew6789000000xtt7TYUh****</PlayAuth>
<RequestId>E4EBD2BF-5EB0-4476-8829-9D94E1B1****</RequestId>
<VideoMeta>
<Status>Normal</Status>
<Duration>120</Duration>
<Title>阿里云VOD</Title>
<VideoId>dfde02284a5c46622a097adaf44a****</VideoId>
<CoverURL>https://example.aliyundoc.com/****.jpg</CoverURL>
</VideoMeta>
</GetVideoPlayAuthResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"PlayAuth" : "sstyYuew6789000000xtt7TYUh****",
"RequestId" : "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
"VideoMeta" : {
"Status" : "Normal",
"Duration" : 120,
"Title" : "阿里云VOD",
"VideoId" : "dfde02284a5c46622a097adaf44a****",
"CoverURL" : "https://example.aliyundoc.com/****.jpg"
}
}
错误码
访问错误中心查看更多错误码。
接口错误码
下表列举了本接口特有的错误码。
错误代码 |
错误信息 |
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参数是必选项。 |
SDK示例
建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: