GetVideoPlayAuth - 获取音视频播放凭证

调用GetVideoPlayAuth获取音视频播放时所需的播放凭证。

接口说明

使用说明

  • 使用阿里云播放器SDK(适用于PlayAuth播放方式),调用本接口来获取播放凭证,阿里云播放器SDK通过播放凭证自动获取播放地址进行播放。
  • 如果播放凭证过期则无法获取播放地址,需要重新获取播放凭证。

QPS限制

本接口的单用户QPS限制为360次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
VideoIdstring

音/视频ID。可通过以下方式获取:

  • 通过控制台上传的视频,可登录点播控制台,选择媒资库 > 音/视频查看音/视频ID。
  • 通过CreateUploadVideo接口上传音/视频时,音/视频ID为返回参数VideoId的值。
  • 音/视频上传后,可通过SearchMedia接口查询音/视频ID,为请求后返回参数VideoId的值。
dfde02284a5c46622a097adaf44a****
AuthInfoTimeoutLong

播放凭证过期时间,单位:。如果凭证过期则无法获取播放地址,需要重新获取凭证。

  • 默认为100秒。
  • 取值范围:[100,3000]
100
ApiVersionstring

API版本号,固定取值为1.0.0

1.0.0

返回参数

名称类型描述示例值
object

返回结果。

PlayAuthstring

音/视频播放凭证。

sstyYuew6789000000xtt7TYUh****
RequestIdstring

请求ID。

E4EBD2BF-5EB0-4476-8829-9D94E1B1****
VideoMetaobject

音/视频Meta信息。

Statusstring

音/视频状态。具体取值范围及描述,请参见视频状态Status的取值列表

Normal
Durationnumber

音/视频时长。单位:秒。

120.0
Titlestring

音/视频标题。

阿里云VOD
VideoIdstring

音/视频ID。

dfde02284a5c46622a097adaf44a****
CoverURLstring

音/视频封面地址。

https://example.aliyundoc.com/****.jpg

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetVideoPlayAuth
&VideoId=dfde02284a5c46622a097adaf44a****
&AuthInfoTimeout=100
&ApiVersion=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"
    }
}

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>

错误码

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

变更历史

变更时间变更内容概要操作
2021-11-02OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ApiVersion

接口错误码

下表列举了本接口特有的错误码。

错误代码错误信息HTTP 状态码说明
Forbidden.IllegalStatusStatus of the video is illegal.403视频状态无效。
InvalidVideo.NotFoundThe video does not exist.404视频不存在。
MissingVideoIdVideoId is mandatory for this action.400VideoId参数是必选项。
阿里云首页 视频点播 相关技术圈