视频直播 LIVE-查询直播截图配置:响应参数

时间:2024-07-19 14:22:40

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总条目数

snapshot_config_list

Array of LiveSnapshotConfig objects

截图配置

limit

Integer

每页记录数

offset

Integer

偏移量

表5 LiveSnapshotConfig

参数

参数类型

描述

domain

String

直播推流 域名

app_name

String

应用名称

auth_key

String

回调鉴权密钥值

长度范围:[32-128]

若需要使用回调鉴权功能,请配置鉴权密钥,否则,留空即可。

time_interval

Integer

截图频率

取值范围:[5-3600]

单位:秒

object_write_mode

Integer

在OBS桶存储截图的方式:

  • 0:实时截图,以时间戳命名截图文件,保存所有截图文件到OBS桶。例:snapshot/{domain}/{app_name}/{stream_name}/{UnixTimestamp}.jpg

  • 1:覆盖截图,只保存最新的截图文件,新的截图会覆盖原来的截图文件。例:snapshot/{domain}/{app_name}/{stream_name}.jpg

obs_location

ObsFileAddr object

OBS存储位置信息

call_back_enable

String

是否启用回调通知

  • on:启用。

  • off:不启用。

call_back_url

String

通知服务器地址,必须是合法的URL且携带协议,协议支持http和https。截图完成后直播服务会向此地址推送截图状态信息。

表6 ObsFileAddr

参数

参数类型

描述

bucket

String

OBS的bucket名称

location

String

OBS Bucket所在的区域,且必须保持与使用的直播服务区域保持一致。

object

String

OBS对象路径,遵守OSS Object定义

  • 当用于指示input时,需要指定到具体对象

  • 当用于指示output时,只需指定到截图结果期望存放的路径

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

support.huaweicloud.com/api-live/ListSnapshotConfigs.html