全部產品
Search

搜尋本產品

    ApsaraVideo Live：ListEdgeTranscodeJob - 查詢邊緣轉碼工作清單

    文件中心

    ApsaraVideo Live：ListEdgeTranscodeJob - 查詢邊緣轉碼工作清單

    更新時間：Apr 21, 2026

    查詢邊緣轉碼工作清單。

    介面說明

    • 本介面用於查詢邊緣轉碼工作清單。

    • 使用者需要具有訪問邊緣轉碼服務的許可權，才能正常調用本介面。

    • 本介面只返回距今 180 天內的任務，且最後一次操作時間需要在這 180 天之內。

    QPS 限制

    本介面的單使用者 QPS 限制為 6000 次/分鐘。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:ListEdgeTranscodeJob

    *Domain

    acs:live:*:{#accountId}:domain/{#DomainName}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地區 ID。

    cn-shanghai
    ClusterId

    string

    是

    機房 ID。

    cluster-1
    Type

    string

    否

    邊緣轉碼類型，枚舉：

    • common，通用(普通+窄帶高清 1.0)。

    • nbhd-2，窄帶高清 2.0。

    • ultra-hd，超高清。

    說明

    該參數不填寫時，會展示使用者有對應轉碼類型許可權的轉碼模板

    common
    Status

    integer

    否

    邊緣轉碼任務狀態，枚舉：

    • 0 未啟動。

    • 1 運行中。

    0
    PageNo

    integer

    否

    當前頁碼。預設值為 1.

    1
    PageSize

    integer

    否

    分頁大小，即每頁顯示條數。預設值為 10，最大值為 100。

    20
    SortBy

    string

    否

    定序，按 CreateTime 排序。預設是 desc，枚舉：

    • desc 降序排序。

    • asc 升序排序。

    desc
    Keyword

    string

    否

    搜尋關鍵詞，枚舉：

    • 任務 ID，任務 ID 支援精確匹配。

    • 任務名稱，任務名稱支援模糊搜尋。

    test

    請求參數使用說明

    • 本介面支援按轉碼類型(Type)、轉碼任務狀態(Status)篩選查詢結果。

    • 本介面支援按任務建立時間(CreateTime)對查詢結果排序，預設為降序。

    • 本介面支援以任務 ID（精確匹配）、任務名稱（模糊查詢）為關鍵字(Keyword)進行查詢。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    JobList

    object

    Job

    array<object>

    邊緣轉碼工作清單。

    object

    CreateTime

    string

    任務建立時間。

    2023-07-24T16:44:55Z
    JobId

    string

    任務 ID。

    ****20b48fb04483915d4f2cd8ac****
    LastStartAt

    string

    任務上一次啟動的時間。

    2023-07-25T02:48:58Z
    LastStopAt

    string

    任務上一次停止的時間。

    2023-07-25T05:48:58Z
    Name

    string

    任務名稱。

    my_job
    Status

    string

    邊緣轉碼任務狀態，枚舉：

    • 0 未啟動。

    • 1 運行中。

    0
    StreamInput

    string

    輸入資料流地址。

    rtmp://mydomain/app/stream1
    StreamOutput

    string

    輸出資料流地址。

    rtmp://testdomain/app/stream2
    TemplateId

    string

    任務使用的邊緣轉碼模板 ID。

    9b1571b513cb44f7a1ba6ae561ff****
    TemplateName

    string

    任務使用的邊緣轉碼模板名。

    my_template
    Type

    string

    邊緣轉碼類型，枚舉：

    • common，通用(普通+窄帶高清 1.0)。

    • nbhd-2，窄帶高清 2.0。

    • ultra-hd，超高清。

    common
    RequestId

    string

    請求 ID。

    ******3B-0E1A-586A-AC29-742247******
    TotalCount

    integer

    總數。

    100

    樣本

    正常返回樣本

    JSON格式

    {
  "JobList": {
    "Job": [
      {
        "CreateTime": "2023-07-24T16:44:55Z",
        "JobId": "****20b48fb04483915d4f2cd8ac****",
        "LastStartAt": "2023-07-25T02:48:58Z",
        "LastStopAt": "2023-07-25T05:48:58Z",
        "Name": "my_job",
        "Status": "0",
        "StreamInput": "rtmp://mydomain/app/stream1",
        "StreamOutput": "rtmp://testdomain/app/stream2",
        "TemplateId": "9b1571b513cb44f7a1ba6ae561ff****",
        "TemplateName": "my_template",
        "Type": "common"
      }
    ]
  },
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "TotalCount": 100
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParameter %s. 參數錯誤
    400 MissingParameter %s. 參數缺失
    403 OperationDenied %s, please check and try again later. 操作拒絕，請檢查後重試。

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

    變更歷史

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