全部產品
Search

搜尋本產品

    ApsaraVideo Live：CreateRTCWhipStreamAddress

    文件中心

    ApsaraVideo Live：CreateRTCWhipStreamAddress

    更新時間：Jul 15, 2026

    呼叫 CreateRTCWhipStreamAddress 建立 RTC 頻道 WHIP 推流位址。

    介面說明

    使用說明

    1. 透過呼叫 CreateRTCWhipStreamAddress 介面，建立在對應 RTC 房間（頻道）的 WhipAddress 推流位址。

    2. 使用 OBS 工具，透過 WHIP 通訊協定進行推流。

      • 執行 OBS 推流工具。

      • 在選單列中選擇檔案 > 設定。

      • 在設定頁面選擇直播，設定如下資訊，按一下確定。

        參數描述
        服務選擇 WHIP。
        伺服器使用步驟 1 中透過介面產生的 WhipAddress 位址。
        Bearer Token串流金鑰為空。

    3. 其他使用者進入相應房間（頻道）觀看。

    QPS 限制

    本介面的單一使用者 QPS 限制為每秒 40 次。超過限制時，API 呼叫會被限流，這可能會影響您的業務，請合理呼叫。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:CreateRTCWhipStreamAddress

    none

    *全部資源。

    *

    		 無 無

    請求文法

    POST  HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ClientToken

    string

    否

    冪等參數。

    說明

    用於區分多次請求是否為同一個請求的識別碼，針對本介面不建議填寫。

    58E73333-xxxx-xxxx-xxxx
    AppId

    string

    是

    應用程式 ID。透過存取影片直播 > 直播+ > 即時音視訊 > 應用程式管理可以檢視擁有的應用程式 ID，若無則可透過【建立應用程式】進行新建。

    6a0**6dcc-xxxx-xxxx-xxxx-e**e3exxxxxx

    ChannelId

    string

    是

    加入的頻道 ID。

    ch00000****001
    UserId

    string

    是

    使用者 ID，不能與頻道中的其他使用者 ID 重複。

    zb0000****0001
    DisplayName

    string

    是

    在頻道中顯示的使用者名稱。

    說明

    支援填寫中文等字元，為避免名稱過長，大小建議小於 32 個位元組。

    主播小二
    ExpireTime

    integer

    否

    推流有效時長，單位：秒，預設為 43200 秒。

    說明

    若超過設定的有效期，則正在使用由本介面所產生位址進行的推流不受影響，但是用該位址重新推流則會失敗。

    43200

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID。

    58E7**D4-xxxx-xxxx-xxxx-6B5**6Cxxxxx
    WhipAddress

    string

    WHIP 通訊協定 URL。

    https://xxxxxx.media-sh.xxxxx.com/xxxxxxxxxxxx/3723a3xxxxxxxxx223c606b***5f7a2bc7c56ea5cdd0xxxxe?auth_key=17495xxxxx-xxxx-0-f013003067c78c4053f9cd0xxxxxxx&qqzr=H4sIAAAAAAAC_6pWSlayUkrOMxxxxxxrPyCxQ0lFKQTCLlKyUjM2Nj**NDQ1TEy2Mjc3xxxxxxxxxxqRYAAAD__xxxxx__xxxxxxxx

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "58E7**D4-xxxx-xxxx-xxxx-6B5**6Cxxxxx",
  "WhipAddress": "https://xxxxxx.media-sh.xxxxx.com/xxxxxxxxxxxx/3723a3xxxxxxxxx223c606b***5f7a2bc7c56ea5cdd0xxxxe?auth_key=17495xxxxx-xxxx-0-f013003067c78c4053f9cd0xxxxxxx&qqzr=H4sIAAAAAAAC_6pWSlayUkrOMxxxxxxrPyCxQ0lFKQTCLlKyUjM2Nj**NDQ1TEy2Mjc3xxxxxxxxxxqRYAAAD__xxxxx__xxxxxxxx"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InputInvalid %s. 輸入參數不合法。
    500 ServerError %s. 未知錯誤，請稍後重試或提交工單諮詢。
    403 NoAuth %s. 沒有權限。
    404 ResourceNotExist %s. 請求資源不存在，請檢查後重新嘗試。

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

    變更歷史

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