DescribeLiveRecordConfig - 查询域名下所有App录制配置

查询直播域名下所有APP录制配置。

接口说明

使用说明

先获取主播流域名,再调用本接口查询直播域名下所有 APP 录制配置。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

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

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

请求参数

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

主播流域名。

example.com
AppNamestring

播流所属应用名称。

liveApp****
StreamNamestring

播流名称。

liveStream****
PageNuminteger

当前页码。默认值:1

1
PageSizeinteger

每页大小。默认值:10,取值范围:5~30

5
Orderstring

按创建时间排序。取值:

  • asc(默认值):升序。
  • desc:降序。
asc

返回参数

名称类型描述示例值
object
PageNuminteger

分页的页码。

5
RequestIdstring

请求 ID。

5056369B-D337-499E-B8B7-B761BD37B08A
Orderstring

排序。

desc
TotalPageinteger

总页数。

20
PageSizeinteger

每页大小。

10
TotalNuminteger

符合条件的总个数。

12
LiveAppRecordListarray<object>

录制配置列表。

LiveAppRecordobject

录制配置列表。

EndTimestring

计划录制结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2018-11-08T03:49:18Z
StartTimestring

计划录制开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2018-11-08T02:49:18Z
AppNamestring

播流所属应用名称。

liveApp****
StreamNamestring

直播流名称。

liveStream****
DelayTimeinteger

断流拼接时长。 直播断流时长超过设定的拼接时长后,将会生成新文件,断流拼接时长支持 15~21600 秒。

180
CreateTimestring

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2016-05-20T09:33:38Z
OnDemondinteger

按需录制。取值:

  • 0:关闭。
  • 1:通过 HTTP 回调方式。
  • 2:通过推流参数方式。
  • 7:默认不录制,可以通过 RealTimeRecordCommand 接口手动控制录制开启或停止。
说明 当 OnDemand 取值为 1 时,需要先通过 AddLiveRecordNotifyConfig 接口配置 OnDemandUrl,否则默认不录制。
0
OssBucketstring

OSS 存储 Bucket 名称。

liveBucket****
DomainNamestring

主播流域名。

example.com
OssEndpointstring

OSS 存储的 Endpoint 名称。

cn-oss-****.aliyuncs.com
RecordFormatListarray<object>

格式列表。

RecordFormatobject

格式列表。

SliceDurationinteger

转码流录制单个切片时长。单位:秒。

30
CycleDurationinteger

周期录制时间。单位:秒。

3600
SliceOssObjectPrefixstring

切片名称。

record/{liveApp****}/{liveStream****}/{UnixTimestamp}
OssObjectPrefixstring

录制文件名称。

record/{liveApp****}/{liveStream****}
Formatstring

格式。

M3U8
TranscodeRecordFormatListarray<object>

转码流录制格式列表。

RecordFormatobject

录制配置文件格式列表。

SliceDurationinteger

转码流录制单个切片时长。单位:秒。

30
CycleDurationinteger

周期录制时间。单位:秒。

3600
SliceOssObjectPrefixstring

转码流录制切片名称。

record/{liveApp****}/{liveStream****}/{UnixTimestamp}
OssObjectPrefixstring

转码流录制文件名称。

record/{liveApp****}/{liveStream****}
Formatstring

转码流录制格式。

M3U8
TranscodeTemplatesarray

转码模板。

Templatesstring

转码流录制的转码模板。设置了录制所有转码流,则返回为["*"]。

["sd","hd"]

示例

正常返回示例

JSON格式

{
  "PageNum": 5,
  "RequestId": "5056369B-D337-499E-B8B7-B761BD37B08A",
  "Order": "desc",
  "TotalPage": 20,
  "PageSize": 10,
  "TotalNum": 12,
  "LiveAppRecordList": {
    "LiveAppRecord": [
      {
        "EndTime": "2018-11-08T03:49:18Z",
        "StartTime": "2018-11-08T02:49:18Z",
        "AppName": "liveApp****",
        "StreamName": "liveStream****",
        "DelayTime": 180,
        "CreateTime": "2016-05-20T09:33:38Z",
        "OnDemond": 0,
        "OssBucket": "liveBucket****",
        "DomainName": "example.com",
        "OssEndpoint": "cn-oss-****.aliyuncs.com",
        "RecordFormatList": {
          "RecordFormat": [
            {
              "SliceDuration": 30,
              "CycleDuration": 3600,
              "SliceOssObjectPrefix": "record/{liveApp****}/{liveStream****}/{UnixTimestamp}",
              "OssObjectPrefix": "record/{liveApp****}/{liveStream****}",
              "Format": "M3U8"
            }
          ]
        },
        "TranscodeRecordFormatList": {
          "RecordFormat": [
            {
              "SliceDuration": 30,
              "CycleDuration": 3600,
              "SliceOssObjectPrefix": "record/{liveApp****}/{liveStream****}/{UnixTimestamp}",
              "OssObjectPrefix": "record/{liveApp****}/{liveStream****}",
              "Format": "M3U8"
            }
          ]
        },
        "TranscodeTemplates": {
          "Templates": [
            "[\"sd\",\"hd\"]"
          ]
        }
      }
    ]
  }
}

错误码

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