ListLiveTranscodeJobs - 获取实时媒体转码任务列表

调用ListLiveTranscodeJobs获取实时媒体转码任务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:ListLiveTranscodeJobs
*全部资源
*

请求参数

名称类型必填描述示例值
Typestring

转码任务对应的模版类型。

  • normal - 普通
  • narrow-band - 窄高
  • audio-only - 纯音频
  • origin - 原画
normal
StartModeinteger

启动模式。

  • 0 - 立即启动
  • 1 - 定时启动
0
Statusinteger

任务状态。

  • 0:未启动

  • 1:运行中

  • 2:已停止

1
PageNointeger

分页的页码。默认值:1。

1
PageSizeinteger

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

20
SortBystring

排序,按 CreateTime 排序,默认是 desc。

  • asc:正序
  • desc:倒序
asc
KeyWordstring

搜索关键词。任务 ID/名称,名称支持模糊搜索。

24ecbb5c-4f98-4194-9400-f17102e27fc5

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

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

总数。

100
JobListarray<object>

转码任务列表。

jobobject
Namestring

转码任务名称。

mytask
JobIdstring

任务 ID。

****a046-263c-3560-978a-fb287782****
TemplateTypestring

转码任务对应转码模版的类型。

normal
TemplateIdstring

转码任务对应的模板 ID。

****a046-263c-3560-978a-fb287666****
TemplateNamestring

模板名称。

模板1
StartModeinteger

启动模式。

0
Statusinteger

任务状态。

1
StreamInputobject

输入流信息。

Typestring

输入流类型。

rtmp
InputUrlstring

输入流地址。

rtmp://mydomain/app/stream1
OutputStreamobject

输出流信息。

StreamInfosarray<object>

播放地址列表。

streamInfoobject
Typestring

输出流协议类型。 目前只支持 rtmp 协议。

rtmp
OutputUrlstring

输出流地址。

rtmp://mydomain/app/mytranscode1
CreateTimestring

创建时间。

2022-07-20T02:48:58Z

示例

正常返回示例

JSON格式

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "TotalCount": 100,
  "JobList": [
    {
      "Name": "mytask",
      "JobId": "****a046-263c-3560-978a-fb287782****",
      "TemplateType": "normal",
      "TemplateId": "****a046-263c-3560-978a-fb287666****",
      "TemplateName": "模板1",
      "StartMode": 0,
      "Status": 1,
      "StreamInput": {
        "Type": "rtmp",
        "InputUrl": "rtmp://mydomain/app/stream1"
      },
      "OutputStream": {
        "StreamInfos": [
          {
            "Type": "rtmp",
            "OutputUrl": "rtmp://mydomain/app/mytranscode1"
          }
        ]
      },
      "CreateTime": "2022-07-20T02:48:58Z"
    }
  ]
}

错误码

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