文档

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

更新时间:

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

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

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

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

2022-07-15T08:00:00Z
EndTimestring

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

2022-07-11T08:00:00Z
Statusstring

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

枚举值:
  • pausedpaused
  • initialinitial
  • startedstarted
started
PageNolong

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

1
PageSizelong

分页大小。默认值:10。

20
SortBystring

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

枚举值:
  • ascasc
  • descdesc
desc

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

A27DFFA4-F272-5563-8363-CB0BC42740BA
LiveRecordJobsobject []

实时录制任务列表。

RecordOutputobject

录制存储地址。

Typestring

存储地址类型。

枚举值:
  • vodvod
  • ossoss
oss
Bucketstring

存储空间名称。

imsbucket1
Endpointstring

存储服务地址。

oss-cn-hangzhou.aliyuncs.com
Namestring

录制任务名称。

直播活动录制任务1
NotifyUrlstring

回调地址。

https://example.com/imsnotify
TemplateIdstring

录制模板 ID。

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

创建时间。

2022-07-20T03:26:36Z
StreamInputobject

直播流地址。

Typestring

直播流地址类型。

rtmp
Urlstring

直播流地址。

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

录制任务 ID。

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

录制任务状态。

paused
TemplateNamestring

录制模板名称。

test template
TotalCountlong

总记录数。

180
PageNolong

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

1
PageSizelong

分页大小。默认值 10。

20
SortBystring

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

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"
}

错误码

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

  • 本页导读 (1)
文档反馈