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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetVideoPlayAuth

系统规定参数。取值:GetVideoPlayAuth

VideoId String dfde02284a5c466*****22a097adaf4a

视频ID。

AuthInfoTimeout Long 3000

播放凭证过期时间。

  • 默认为100秒。
  • 取值范围:[100,3000]
PlayConfig String {"PlayDomain":"vod.test_domain"}

播放自定义设置。为JSON字符串,支持指定域名播放设置。参数构造详情,请参见PlayConfig

返回数据

名称 类型 示例值 描述
RequestId String 25818875-5F78-4A*****F6-D7393642CA58

请求ID。

VideoMeta Struct

视频Meta信息。

CoverURL String https://image.example.com/****.jpg

视频封面。

Duration Float 120.0

视频时长。单位:秒。

Status String Normal

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

Title String 阿里云VOD

视频标题。

VideoId String 93ab850b4f6f*****4b6e91d24d81d4

视频ID。

PlayAuth String sstyYuew6789*****00000xtt7TYUh

视频播放凭证。

示例

请求示例

https://vod.aliyuncs.com/?Action=GetVideoPlayAuth
&VideoId=dfde02284a5c466*****22a097adaf4a
&<公共请求参数>

正常返回示例

XML 格式

<GetVideoPlayAuthResponse>
      <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
	  <VideoMeta>
		    <VideoId>93ab850b4f6f*****4b6e91d24d81d4</VideoId>
		    <Title>阿里云VOD</Title>
		    <Duration>135.6</Duration>
		    <CoverURL>https://image.example.com/****.jpg</CoverURL>
		    <Status>Normal</Status>
	  </VideoMeta>
	  <PlayAuth>sstyYuew6789*****00000xtt7TYUh</PlayAuth>
</GetVideoPlayAuthResponse>

JSON 格式

{
    "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
    "VideoMeta": {
        "VideoId": "93ab850b4f6f*****4b6e91d24d81d4",
        "Title": "阿里云VOD",
        "Duration": 135.6,
        "CoverURL": "https://image.example.com/****.jpg",
        "Status": "Normal"
    },
    "PlayAuth": "sstyYuew6789*****00000xtt7TYUh"
}

错误码

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

接口错误码

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

错误代码

错误信息

HTTP 状态码

说明

Forbidden.IllegalStatus

Status of the video is illegal.

403

视频状态无效。

InvalidVideo.NotFound

The video does not exist.

404

视频不存在。

SDK示例

建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: