文档首页> 视频直播 Live> API参考> 录制管理> 查询录制规则列表
更新时间:2022-04-15 GMT+08:00
分享

查询录制规则列表

功能介绍

查询录制规则列表接口,通过指定条件,查询满足条件的录制规则列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/record/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

publish_domain

String

直播推流域名

app

String

流应用名称

stream

String

流名称

record_type

String

录制类型,如果不填写则查询所有录制类型,包括:CONTINUOUS_RECORD,COMMAND_RECORD。默认CONTINUOUS_RECORD。

  • CONTINUOUS_RECORD:持续录制,在该规则类型配置后,只要有流到推送到录制系统,就触发录制。

  • COMMAND_RECORD:命令录制,在该规则类型配置后,在流推送到录制系统后,租户需要通过命令控制该流的录制开始和结束。

offset

Integer

偏移量,表示从此偏移量开始查询,offset大于等于0

limit

Integer

每页记录数,取值范围[1,100],默认值10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称)

表5 响应Body参数

参数

参数类型

描述

total

Integer

查询结果的总元素数量

record_config

Array of RecordRule objects

录制配置数组

表6 RecordRule

参数

参数类型

描述

id

String

规则id,由服务端返回。创建或修改的时候不携带

publish_domain

String

直播推流域名

app

String

应用名,如果需要匹配任意应用则需填写*。录制规则匹配的时候,优先精确app匹配,如果匹配不到,则匹配*

stream

String

录制的流名,如果需要匹配任意流名则需填写*。录制规则匹配的时候,优先精确stream匹配,如果匹配不到,则匹配*

record_type

String

录制类型,包括:CONTINUOUS_RECORD,COMMAND_RECORD。默认CONTINUOUS_RECORD。

  • CONTINUOUS_RECORD:持续录制,在该规则类型配置后,只要有流到推送到录制系统,就触发录制。

  • COMMAND_RECORD:命令录制,在该规则类型配置后,在流推送到录制系统后,租户需要通过命令控制该流的录制开始和结束。

default_record_config

DefaultRecordConfig object

默认录制规则配置

create_time

String

创建时间,格式:yyyy-mm-ddThh:mm:ssZ,UTC时间。 在查询的时候返回

update_time

String

修改时间,格式:yyyy-mm-ddThh:mm:ssZ,UTC时间。 在查询的时候返回

表7 DefaultRecordConfig

参数

参数类型

描述

record_format

Array of strings

录制格式,当前支持:FLV,HLS,MP4三种格式,设置格式时必须使用大写字母

obs_addr

RecordObsFileAddr object

录制保存的租户的桶信息

hls_config

HLSRecordConfig object

HLS配置规则

flv_config

FLVRecordConfig object

FLV配置规则

mp4_config

MP4RecordConfig object

MP4配置规则

表8 RecordObsFileAddr

参数

参数类型

描述

bucket

String

OBS的bucket名称

location

String

OBS Bucket所在RegionID

object

String

OBS对象路径,遵守OBS Object定义。如果为空则保存到根目录

表9 HLSRecordConfig

参数

参数类型

描述

record_cycle

Integer

单位为秒,周期录制时长,最小1分钟(60秒),最大12小时。如果为0,则整个流录制一个文件(录制文件时长超过10天会强制创建新文件)。

record_prefix

String

录制m3u8文件,含路径和文件名的前缀, 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}{file_start_time}/{stream}{file_start_time}

record_ts_prefix

String

录制ts文件名的前缀, 默认{file_start_time_unix}{file_end_time_unix}{ts_sequence_number}

record_slice_duration

Integer

录制HLS时ts的切片时长,非必须,缺省为10,单位秒,最小2,最大60

record_max_duration_to_merge_file

Integer

录制HLS文件拼接时长,如果流中断超过该时间,则生成新文件。单位秒。如果为0表示流中断就生成新文件,如果为-1则表示相同的流中断恢复后,继续在30天内的前一个文件保存。默认为0。

表10 FLVRecordConfig

参数

参数类型

描述

record_cycle

Integer

单位为秒,周期录制时长,最小1分钟,最大12小时。

record_prefix

String

录制FLV文件,含路径和文件名的前缀, 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}

record_max_duration_to_merge_file

Integer

录制flv拼接时长,如果流中断超过该时间,则生成新文件。单位秒。如果为0表示流中断就生成新文件。默认为0。

表11 MP4RecordConfig

参数

参数类型

描述

record_cycle

Integer

单位为秒,周期录制时长,最小1分钟,最大12小时。

record_prefix

String

录制文件含路径和文件名的前缀, 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}

record_max_duration_to_merge_file

Integer

录制mp4拼接时长,如果流中断超过该时间,则生成新文件。单位秒。如果为0表示流中断就生成新文件。默认为0。

状态码: 400

表12 响应Header参数

参数

参数类型

描述

X-request-id

String

此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称)

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://live.hwcloud.com/v1/{project_id}/record/rules?publish_domain=xxx

响应示例

状态码: 200

查询录制配置成功

{
  "total" : 1,
  "record_config" : [ {
    "id" : "42810594c2fc9xxxx36b7784c76a06e8",
    "project_id" : "05a8ae592500xxxx2f83c0091083231a",
    "publish_domain" : "publish.xxx.com",
    "app" : "live",
    "stream" : "*",
    "record_type" : "CONTINUOUS_RECORD",
    "default_record_config" : {
      "record_format" : [ "HLS" ],
      "obs_addr" : {
        "bucket" : "mybucket",
        "location" : "cn-north-4",
        "object" : "record/"
      },
      "hls_config" : {
        "record_cycle" : 900,
        "record_prefix" : "record-publish_domain-app-stream-file_start_time_unix/record-publish_domain-app-stream-file_start_time_unix",
        "record_ts_prefix" : "{stream}-{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}",
        "record_slice_duration" : 10,
        "record_max_duration_to_merge_file" : 60
      },
      "start_time" : "2020-03-08T14:10:25Z",
      "end_time" : "2020-03-08T15:06:25Z",
      "create_time" : "2020-02-26T15:54:53.84Z",
      "update_time" : "2020-02-27T15:54:53.84Z"
    }
  } ]
}

状态码: 400

参数错误

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

状态码

状态码

描述

200

查询录制配置成功

400

参数错误

错误码

请参见错误码

分享:

    相关文档

    相关产品

close