調用本接口獲取音視頻的播放憑證(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。可通過以下方式獲取:
| 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 入參發生變更 | 查看變更詳情 |