調用本介面擷取音視頻的播放憑證(PlayAuth)。阿里雲播放器SDK使用該憑證自動擷取播放地址。由於播放憑證具有時效性,且與特定音視頻綁定,不可混用或重複使用,因此憑證到期或無效將導致無法播放。此播放方式適用於需要高安全性的音視頻播放情境。
介面說明
使用阿里雲播放器 SDK(適用於 PlayAuth 播放方式),調用本介面來擷取播放憑證,阿里雲播放器 SDK 通過播放憑證自動擷取播放地址進行播放,更多資訊,請參見阿里雲播放器 SDK。
如果播放憑證到期則無法擷取播放地址,需要重新擷取播放憑證。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
vod:GetVideoPlayAuth |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| VideoId |
string |
否 |
音/視頻 ID,僅支援傳入單個音/視頻 ID。可通過以下方式擷取:
|
dfde02284a5c46622a097adaf44a**** |
| AuthInfoTimeout |
integer |
否 |
播放憑證到期時間,單位:秒。如果憑證到期則無法擷取播放地址,需要重新擷取憑證。
|
100 |
| ApiVersion |
string |
否 |
API 版本號碼,固定取值為1.0.0。 |
1.0.0 |
| ReferenceId |
string |
否 |
自訂 ID,僅支援小寫字母、大寫字母、數字、橫線、底線,長度 6-64 位元。使用者維度唯一。 |
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 |
音/視頻標題。 |
Alibaba Cloud VOD Video Title |
| 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": "Alibaba Cloud VOD Video Title",
"VideoId": "dfde02284a5c46622a097adaf44a****",
"CoverURL": "https://example.aliyundoc.com/****.jpg"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。