全部产品
Search

搜索本产品

    视频直播：ListEdgeTranscodeJob - 查询边缘转码任务列表

    文档中心

    视频直播：ListEdgeTranscodeJob - 查询边缘转码任务列表

    更新时间：Dec 05, 2024

    查询边缘转码任务列表。

    接口说明

    • 本接口用于查询边缘转码任务列表。

    • 用户需要具有访问边缘转码服务的权限，才能正常调用本接口。

    • 本接口只返回距今 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}
      无
    		无

    请求参数

    名称类型必填描述示例值
    ClusterIdstring是

    机房 ID。

    		cluster-1
    Typestring否

    边缘转码类型，枚举：

    • common，通用(普通+窄带高清 1.0)。
    • nbhd-2，窄带高清 2.0。
    • ultra-hd，超高清。
    说明 该参数不填写时，会展示用户有对应转码类型权限的转码模板
    		common
    Statusinteger否

    边缘转码任务状态，枚举：

    • 0 未启动。
    • 1 运行中。
    		0
    PageNointeger否

    当前页码。默认值为 1.

    		1
    PageSizeinteger否

    分页大小，即每页显示条数。默认值为 10，最大值为 100。

    		20
    SortBystring否

    排序规则，按 CreateTime 排序。默认是 desc，枚举：

    • desc 降序排序。
    • asc 升序排序。
    		desc
    Keywordstring否

    搜索关键词，枚举：

    • 任务 ID，任务 ID 支持精确匹配。
    • 任务名称，任务名称支持模糊搜索。
    		test

    请求参数使用说明

    • 本接口支持按转码类型(Type)、转码任务状态(Status)筛选查询结果。
    • 本接口支持按任务创建时间(CreateTime)对查询结果排序，默认为降序。
    • 本接口支持以任务 ID（精确匹配）、任务名称（模糊查询）为关键字(Keyword)进行查询。

    返回参数

    名称类型描述示例值
    object
    JobListarray<object>

    边缘转码任务列表。

    Jobobject
    CreateTimestring

    任务创建时间。

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

    任务 ID。

    		****20b48fb04483915d4f2cd8ac****
    LastStartAtstring

    任务上一次启动的时间。

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

    任务上一次停止的时间。

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

    任务名称。

    		my_job
    Statusstring

    边缘转码任务状态，枚举：

    • 0 未启动。
    • 1 运行中。
    		0
    StreamInputstring

    输入流地址。

    		rtmp://mydomain/app/stream1
    StreamOutputstring

    输出流地址。

    		rtmp://testdomain/app/stream2
    TemplateIdstring

    任务使用的边缘转码模板 ID。

    		9b1571b513cb44f7a1ba6ae561ff****
    TemplateNamestring

    任务使用的边缘转码模板名。

    		my_template
    Typestring

    边缘转码类型，枚举：

    • common，通用(普通+窄带高清 1.0)。
    • nbhd-2，窄带高清 2.0。
    • ultra-hd，超高清。
    		common
    RequestIdstring

    请求 ID。

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

    总数。

    		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错误码错误信息
    400InvalidParameter%s
    400MissingParameter%s
    403OperationDenied%s

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史