功能介绍

查询录制配置接口。

当前页面接口为历史版本API，未来可能停止维护，建议您使用新版视频直播录制API。您也可以通过视频直播控制台使用新录制功能，具体请参见录制至OBS。

调试

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

URI

GET /v1/{project_id}/record/config

请求参数

请求示例

  GET /v1/{project_id}/record/config?domain=play.example.com

返回参数

• 查询录制配置成功

  表1 查询成功返回参数说明

  参数	类型	说明
  total	Integer	查询结果的总模板数量。
  record_config	Array of RecordConfigInfo objects	录制配置数组。

  表2 RecordConfigInfo参数说明

  参数	类型	说明
  domain	String	播放域名。
  push_domain	String	推流域名。
  app_name	String	应用名称。
  record_duration	Integer	周期录制时长，最小15分钟，最大6小时，默认1小时。单位：秒。
  record_format	String	录制格式，默认为flv。
  record_location	String	录制存储位置， 默认为vod。
  record_prefix	String	录制文件前缀， DomainName，AppName，StreamName必须，默认Record_{DomainName}_{AppName}_{StreamName}_{StartTime}_{EndTime}
  create_time	String	创建时间。
  start_time	String	开始时间。
  end_time	String	结束时间。
  stream_name	String	流名称。

• 查询录制配置失败

  表3 查询失败返回参数说明

  参数	类型	说明
  error_code	String	错误码。
  error_msg	String	错误描述。

返回示例

• 处理成功返回

  {
    "total": 1,
    "record_config": [
      {
        "domain": "cxf-live.huawei.com",
        "app_name": "live",
        "record_type": "configer_record",
        "record_duration": 1200,
        "record_format": "mp4",
        "record_location": "vod",
        "record_prefix": "Record_{DomainName}_{AppName}_{StreamName}_{StartTime}_{EndTime}",
        "obs_addr": {
          "bucket": "",
          "location": "",
          "object": ""
        },
        "create_time": "2019-03-20T15:42:04.706+08:00"
        "stream_name":"",
        "start_time":"",
        "end_time":""
      }
    ]
  }
  

• 处理失败返回

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

状态码

状态码请参见状态码。

错误码

请参见错误码。