ListLiveRecordJobs - 获取实时录制任务列表

更新时间:
复制 MD 格式

调用ListLiveRecordJobs获取实时录制任务列表,可分页获取。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:ListLiveRecordJobs

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

Keyword

string

否

搜索关键词,可以根据任务 ID 和名称搜索。

ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66

StartTime

string

否

查询开始时间。格式为 yyyy-mm-ddthh:mm:ssz(UTC 时间)。

2022-07-15T08:00:00Z

EndTime

string

否

查询结束时间,与 StartTime 相差不超过 30 天。格式为 yyyy-mm-ddthh:mm:ssz(UTC 时间)。

2022-07-11T08:00:00Z

Status

string

否

任务状态。默认不过滤状态。

枚举值:

  • paused :

    暂停

  • initial :

    初始

  • started :

    运行中

started

PageNo

integer

否

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

1

PageSize

integer

否

分页大小。默认值:10。

20

SortBy

string

否

排序参数,默认按创建时间倒序。

枚举值:

  • asc :

    升序排列

  • desc :

    降序排列

desc

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

A27DFFA4-F272-5563-8363-CB0BC42740BA

LiveRecordJobs

array<object>

实时录制任务列表。

array<object>

LiveRecordJobItemType

RecordOutput

object

录制存储地址。

Type

string

存储地址类型。

枚举值:

  • vod :

    vod

  • oss :

    oss

oss

Bucket

string

存储空间名称。

imsbucket1

Endpoint

string

存储服务地址。

oss-cn-hangzhou.aliyuncs.com

Name

string

录制任务名称。

直播活动录制任务1

NotifyUrl

string

回调地址。

https://example.com/imsnotify

TemplateId

string

录制模板 ID。

69e1f9fe-1e97-11ed-ba64-0c42a1b73d66

CreateTime

string

创建时间。时间格式为 ISO 8601,使用 UTC 时间(以 Z 结尾)。

2022-07-20T03:26:36Z

StreamInput

object

直播流地址。

Type

string

直播流地址类型。

rtmp

Url

string

直播流地址。

rtmp://example-live.com/live/stream1

JobId

string

录制任务 ID。

ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66

Status

string

录制任务状态。

paused

TemplateName

string

录制模板名称。

test template

TotalCount

integer

总记录数。

180

PageNo

integer

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

1

PageSize

integer

分页大小。默认值 10。

20

SortBy

string

排序参数,默认根据创建时间倒序。

desc

示例

正常返回示例

JSON格式

{
  "RequestId": "A27DFFA4-F272-5563-8363-CB0BC42740BA",
  "LiveRecordJobs": [
    {
      "RecordOutput": {
        "Type": "oss",
        "Bucket": "imsbucket1",
        "Endpoint": "oss-cn-hangzhou.aliyuncs.com"
      },
      "Name": "直播活动录制任务1",
      "NotifyUrl": "https://example.com/imsnotify",
      "TemplateId": "69e1f9fe-1e97-11ed-ba64-0c42a1b73d66",
      "CreateTime": "2022-07-20T03:26:36Z",
      "StreamInput": {
        "Type": "rtmp",
        "Url": "rtmp://example-live.com/live/stream1"
      },
      "JobId": "ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66",
      "Status": "paused",
      "TemplateName": "test template"
    }
  ],
  "TotalCount": 180,
  "PageNo": 1,
  "PageSize": 20,
  "SortBy": "desc"
}

错误码

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

变更历史

更多信息,参考变更详情。