全部產品
Search

搜尋本產品

    ApsaraVideo VOD：GetVideoPlayAuth

    文件中心

    ApsaraVideo VOD：GetVideoPlayAuth

    更新時間：Jul 21, 2026

    呼叫本介面取得影音的播放憑證（PlayAuth）。阿里雲端播放器 SDK 使用該憑證自動取得播放地址。由於播放憑證具有時效性，且與特定影音綁定，不可混用或重複使用，因此憑證過期或無效將導致無法播放。此播放方式適用於需要高安全性的影音播放場景。

    介面說明

    • 使用阿里雲端播放器 SDK（適用於 PlayAuth 播放方式），呼叫本介面來取得播放憑證，阿里雲端播放器 SDK 透過播放憑證自動取得播放地址進行播放，更多資訊，請參見阿里雲端播放器 SDK。

    • 如果播放憑證過期則無法取得播放地址，需要重新取得播放憑證。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vod:GetVideoPlayAuth

    get

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    VideoId

    string

    否

    音/影片 ID，僅支援傳入單個音/影片 ID。可透過以下方式取得：

    • 透過主控台上傳的影片，可登入點播主控台，選擇媒體資源庫 > 音/影片檢視音/影片 ID。

    • 透過 CreateUploadVideo 介面上傳音/影片時，音/影片 ID 為返回參數 VideoId 的值。

    • 音/影片上傳後，可透過 SearchMedia 介面查詢音/影片 ID，為請求後返回參數 VideoId 的值。

    dfde02284a5c46622a097adaf44a****
    AuthInfoTimeout

    integer

    否

    播放憑證過期時間，單位：秒。如果憑證過期則無法取得播放地址，需要重新取得憑證。

    • 預設為 100 秒。

    • 取值範圍：[100,3000]。

    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"
  }
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。