調(diào)用本接口獲取音視頻的播放憑證(PlayAuth)。阿里云播放器SDK使用該憑證自動(dòng)獲取播放地址。由于播放憑證具有時(shí)效性,且與特定音視頻綁定,不可混用或重復(fù)使用,因此憑證過(guò)期或無(wú)效將導(dǎo)致無(wú)法播放。此播放方式適用于需要高安全性的音視頻播放場(chǎng)景。
接口說(shuō)明
- 使用阿里云播放器 SDK(適用于 PlayAuth 播放方式),調(diào)用本接口來(lái)獲取播放憑證,阿里云播放器 SDK 通過(guò)播放憑證自動(dòng)獲取播放地址進(jìn)行播放,更多信息,請(qǐng)參見(jiàn)阿里云播放器 SDK。
- 如果播放憑證過(guò)期則無(wú)法獲取播放地址,需要重新獲取播放憑證。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
vod:GetVideoPlayAuth | get | *全部資源 * |
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
VideoId | string | 是 | 音/視頻 ID,僅支持傳入單個(gè)音/視頻 ID。可通過(guò)以下方式獲取:
| dfde02284a5c46622a097adaf44a**** |
AuthInfoTimeout | long | 否 | 播放憑證過(guò)期時(shí)間,單位:秒。如果憑證過(guò)期則無(wú)法獲取播放地址,需要重新獲取憑證。
| 100 |
ApiVersion | string | 否 | API 版本號(hào),固定取值為1.0.0。 | 1.0.0 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"PlayAuth": "sstyYuew6789000000xtt7TYUh****",
"RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
"VideoMeta": {
"Status": "Normal",
"Duration": 120,
"Title": "阿里云VOD",
"VideoId": "dfde02284a5c46622a097adaf44a****",
"CoverURL": "https://example.aliyundoc.com/****.jpg"
}
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2021-11-02 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |