数据结构

最近更新时间:2019-08-15 21:40:41

BillDataInfo

带宽和流量信息

被如下接口引用:DescribeBillBandwidthAndFluxList。

名称 类型 描述
Time String 时间点,格式为yyyy-mm-dd HH:MM:SS。
Bandwidth Float 带宽,单位是Mbps。
Flux Float 流量,单位是MB。

CallBackRuleInfo

规则信息

被如下接口引用:DescribeLiveCallbackRules。

名称 类型 描述
CreateTime String 规则创建时间。
UpdateTime String 规则更新时间。
TemplateId Integer 模板Id。
DomainName String 推流域名。
AppName String 推流路径。

CallBackTemplateInfo

回调模板信息

被如下接口引用:DescribeLiveCallbackTemplate、DescribeLiveCallbackTemplates。

名称 类型 描述
TemplateId Integer 模板Id。
TemplateName String 模板名称。
Description String 描述信息。
StreamBeginNotifyUrl String 开播回调URL。
StreamEndNotifyUrl String 断流回调URL。
StreamMixNotifyUrl String 混流回调URL。
RecordNotifyUrl String 录制回调URL。
SnapshotNotifyUrl String 截图回调URL。
PornCensorshipNotifyUrl String 鉴黄回调URL。
CallbackKey String 回调的鉴权key

CdnPlayStatData

下行播放统计指标

被如下接口引用:DescribeGroupProIspPlayInfoList。

名称 类型 描述
Time String 时间点,格式为yyyy-mm-dd HH:MM:SS。
Bandwidth Float 带宽,(单位Mbps)。
Flux Float 流量,(单位MB)。
Request Integer 新增请求数。
Online Integer 并发连接数。

CertInfo

证书信息

被如下接口引用:DescribeLiveCert、DescribeLiveCerts。

名称 类型 描述
CertId Integer 证书Id。
CertName String 证书名称。
Description String 描述信息。
CreateTime String 创建时间,UTC格式。
HttpsCrt String 证书内容。
CertType Integer 证书类型。
0:腾讯云托管证书
1:用户添加证书。
CertExpireTime String 证书过期时间,UTC格式。
DomainList Array of String 使用此证书的域名列表。

ClientIpPlaySumInfo

客户端ip播放汇总信息

被如下接口引用:DescribeTopClientIpSumInfoList。

名称 类型 描述
ClientIp String 客户端ip,点分型。
Province String 客户端所在省份。
TotalFlux Float 总流量。
TotalRequest Integer 总请求数。
TotalFailedRequest Integer 总失败请求数。

DayStreamPlayInfo

流播放信息

被如下接口引用:DescribeStreamPlayInfoList。

名称 类型 描述
Time String 数据时间点,格式:yyyy-mm-dd HH:MM:SS。
Bandwidth Float 带宽(单位Mbps)。
Flux Float 流量 (单位MB)。
Request Integer 请求数。
Online Integer 在线人数。

DelayInfo

延播信息

被如下接口引用:DescribeLiveDelayInfoList。

名称 类型 描述
DomainName String 推流域名。
AppName String 推流路径,与推流和播放地址中的AppName保持一致,默认为 live。
StreamName String 流名称。
DelayInterval Integer 延播时间,单位:秒。
CreateTime String 创建时间,UTC时间。
注意:UTC时间和北京时间相差8小时。
例如:2019-06-18T12:00:00Z(为北京时间 2019 年 6 月 18 日 20 点 0 分 0 秒)。
ExpireTime String 过期时间,UTC时间。
注意:UTC时间和北京时间相差8小时。
例如:2019-06-18T12:00:00Z(为北京时间 2019 年 6 月 18 日 20 点 0 分 0 秒)。
Status Integer 当前状态,
-1:已过期,
1: 生效中。

DomainCertInfo

域名证书信息

被如下接口引用:DescribeLiveDomainCert。

名称 类型 描述
CertId Integer 证书Id。
CertName String 证书名称。
Description String 描述信息。
CreateTime String 创建时间,UTC格式。
HttpsCrt String 证书内容。
CertType Integer 证书类型。
0:腾讯云托管证书
1:用户添加证书。
CertExpireTime String 证书过期时间,UTC格式。
DomainName String 使用此证书的域名名称。
Status Integer 证书状态

DomainDetailInfo

每个域名的统计信息

被如下接口引用:DescribeLiveDomainPlayInfoList。

名称 类型 描述
MainlandOrOversea String 国内还是国外,可选值包括Mainland和Oversea,如果为“Mainland”,表示国内数据;如果为“Oversea”,表示国外数据。
Bandwidth Float 带宽,单位是Mbps。
Flux Float 流量,单位是MB。
Online Integer 人数。
Request Integer 请求数。

DomainInfo

直播域名信息

被如下接口引用:DescribeLiveDomain、DescribeLiveDomains。

名称 类型 描述
Name String 直播域名
Type Integer 域名类型。0-推流,1-播放
Status Integer 域名状态。0-停用,1-启用
CreateTime String 添加时间
BCName Integer 是否有CName到固定规则域名。0-否,1-是
TargetDomain String cname对应的域名
PlayType Integer 播放区域,只在Type=1时该参数有意义。
1-国内,2-全球,3-海外。
IsDelayLive Integer 0:普通直播,
1:慢直播。
CurrentCName String 当前客户使用的cname信息

DomainInfoList

多个域名信息列表

被如下接口引用:DescribeLiveDomainPlayInfoList。

名称 类型 描述
Domain String 域名。
DetailInfoList Array of DomainDetailInfo 明细信息。

ForbidStreamInfo

禁推流列表

被如下接口引用:DescribeLiveForbidStreamList。

名称 类型 描述
StreamName String 流名称。
CreateTime String 创建时间。
ExpireTime String 禁推过期时间。

GroupProIspDataInfo

某省份某运营商在某段时间内的带宽,流量,请求数和并发数

被如下接口引用:DescribeGroupProIspPlayInfoList。

名称 类型 描述
ProvinceName String 省份。
IspName String 运营商。
DetailInfoList Array of CdnPlayStatData 分钟维度的明细数据。

HlsSpecialParam

HLS专属录制参数

被如下接口引用:CreateLiveRecordTemplate、DescribeLiveRecordTemplate、DescribeLiveRecordTemplates、ModifyLiveRecordTemplate。

名称 类型 必选 描述
FlowContinueDuration Integer HLS续流超时时间。

HttpCodeInfo

HTTP返回码和统计数据

被如下接口引用:DescribePlayErrorCodeDetailInfoList。

名称 类型 描述
HttpCode String HTTP协议返回码。
例:"2xx", "3xx", "4xx", "5xx"。
ValueList Array of HttpCodeValue 统计信息,对于无数据的时间点,会补0。

HttpCodeValue

HTTP返回码数据信息

被如下接口引用:DescribePlayErrorCodeDetailInfoList。

名称 类型 描述
Time String 时间,格式:yyyy-mm-dd HH:MM:SS。
Numbers Integer 次数。
Percentage Float 占比。

HttpStatusData

播放错误码信息

被如下接口引用:DescribeHttpStatusInfoList。

名称 类型 描述
Time String 数据时间点,
格式:yyyy-mm-dd HH:MM:SS。
HttpStatusInfoList Array of HttpStatusInfo 播放状态码详细信息。

HttpStatusInfo

播放错误码信息

被如下接口引用:DescribeHttpStatusInfoList。

名称 类型 描述
HttpStatus String 播放HTTP状态码。
Num Integer 个数。

LogInfo

日志url信息

被如下接口引用:DescribeLogDownloadList。

名称 类型 描述
LogName String 日志名称。
LogUrl String 日志Url。
LogTime String 日志生成时间

PlayAuthKeyInfo

播放鉴权key信息

被如下接口引用:DescribeLivePlayAuthKey。

名称 类型 描述
DomainName String 域名。
Enable Integer 是否启用,0:关闭,1:启用。
AuthKey String 鉴权key。
AuthDelta Integer 有效时间,单位:秒。
AuthBackKey String 鉴权BackKey。

PlayCodeTotalInfo

各状态码的总次数,暂时支持400,403,404,500,502,503,504

被如下接口引用:DescribePlayErrorCodeSumInfoList。

名称 类型 描述
Code String HTTP code,可选值包括400,403,404,500,502,503,504
Num Integer 总次数

PlayDataInfoByStream

流维度的播放信息

被如下接口引用:DescribeStreamDayPlayInfoList。

名称 类型 描述
StreamName String 流名称。
TotalFlux Float 总流量(单位MB)。

PlayStatInfo

按省份运营商查询的播放信息

被如下接口引用:DescribeProvinceIspPlayInfoList。

名称 类型 描述
Time String 数据时间点。
Value Float 带宽/流量/请求数/并发连接数/下载速度的值,若没数据返回时该值为0
注意:此字段可能返回 null,表示取不到有效值。

PlaySumStatInfo

播放汇总统计信息

被如下接口引用:DescribeVisitTopSumInfoList。

名称 类型 描述
Name String 域名或流id。
AvgFluxPerSecond Float 平均下载速度,单位是MB/s,计算公式是每分钟的下载速度求平均值。
TotalFlux Float 总流量,单位是MB。
TotalRequest Integer 总请求数。

ProIspPlayCodeDataInfo

播放错误码信息

被如下接口引用:DescribePlayErrorCodeSumInfoList。

名称 类型 描述
ProvinceName String 省份。
IspName String 运营商。
Code4xx Integer 错误码为4开头的次数。
Code5xx Integer 错误码为5开头的次数。

ProIspPlaySumInfo

获取省份/运营商的播放信息

被如下接口引用:DescribeProIspPlaySumInfoList。

名称 类型 描述
Name String 省份/运营商。
TotalFlux Float 总流量,单位:MB。
TotalRequest Integer 总请求数。
AvgFluxPerSecond Float 平均下载流量,单位:MB/s

PublishTime

推流时间

被如下接口引用:DescribeLiveStreamOnlineList。

名称 类型 描述
PublishTime String 推流时间
UTC 格式,例如:2018-06-29T19:00:00Z。

PullStreamConfig

拉流配置

被如下接口引用:DescribePullStreamConfigs。

名称 类型 描述
ConfigId String 拉流配置Id。
FromUrl String 源Url。
ToUrl String 目的Url。
AreaName String 区域名。
IspName String 运营商名。
StartTime String 开始时间。
UTC格式时间,
例如:2019-01-08T10:00:00Z。
EndTime String 结束时间。

UTC格式时间,
例如:2019-01-08T10:00:00Z。
Status String 0无效,1初始状态,2正在运行,3拉起失败,4暂停。

PushAuthKeyInfo

推流鉴权key信息

被如下接口引用:DescribeLivePushAuthKey。

名称 类型 描述
DomainName String 域名。
Enable Integer 是否启用,0:关闭,1:启用。
MasterAuthKey String 主鉴权key。
BackupAuthKey String 备鉴权key。
AuthDelta Integer 有效时间,单位:秒。

PushDataInfo

推流数据信息

被如下接口引用:DescribeLiveStreamPushInfoList。

名称 类型 描述
StreamName String 流名称。
AppName String 推流路径。
ClientIp String 推流客户端ip。
ServerIp String 接流服务器ip。
VideoFps Integer 推流视频帧率,单位是Hz。
VideoSpeed Integer 推流视频码率,单位是bps。
AudioFps Integer 推流音频帧率,单位是Hz。
AudioSpeed Integer 推流音频码率,单位是bps。
PushDomain String 推流域名。
BeginPushTime String 推流开始时间。
Acodec String 音频编码格式,
例:"AAC"。
Vcodec String 视频编码格式,
例:"H264"。
Resolution String 分辨率。

PushQualityData

某条流的推流质量详情数据。

被如下接口引用:DescribeStreamPushInfoList。

名称 类型 描述
Time String 数据时间,格式是%Y-%m-%d %H:%M:%S.%ms,精确到毫秒级。
PushDomain String 推流域名。
AppName String 推流路径。
ClientIp String 推流客户端ip。
BeginPushTime String 开始推流时间,格式是%Y-%m-%d %H:%M:%S.%ms,精确到毫秒级。
Resolution String 分辨率信息。
VCodec String 视频编码格式。
ACodec String 音频编码格式。
Sequence String 推流序列号,用来唯一的标志一次推流。
VideoFps Integer 视频帧率。
VideoRate Integer 视频码率,单位是bps。
AudioFps Integer 音频帧率。
AudioRate Integer 音频码率,单位是bps。
LocalTs Integer 本地流逝时间,单位是ms,音视频流逝时间与本地流逝时间的差距越大表示推流质量越差,上行卡顿越严重。
VideoTs Integer 视频流逝时间,单位是ms。
AudioTs Integer 音频流逝时间,单位是ms。

RecordParam

录制模板参数

被如下接口引用:CreateLiveRecordTemplate、DescribeLiveRecordTemplate、DescribeLiveRecordTemplates、ModifyLiveRecordTemplate。

名称 类型 必选 描述
RecordInterval Integer 录制间隔。
单位秒,默认值1800。
取值范围:300-7200。
此参数对 HLS 无效,当录制 HLS 时从推流到断流生成一个文件。
StorageTime Integer 录制存储时长。
单位秒,取值范围: 0-93312000。
0表示永久存储。
Enable Integer 是否开启当前格式录制,0 否 1是。默认值0。

RecordTemplateInfo

录制模板信息

被如下接口引用:DescribeLiveRecordTemplate、DescribeLiveRecordTemplates。

名称 类型 描述
TemplateId Integer 模板Id。
TemplateName String 模板名称。
Description String 描述信息。
FlvParam RecordParam Flv录制参数。
HlsParam RecordParam Hls录制参数。
Mp4Param RecordParam Mp4录制参数。
AacParam RecordParam Aac录制参数。
IsDelayLive Integer 0:普通直播,
1:慢直播。
HlsSpecialParam HlsSpecialParam HLS录制定制参数
Mp3Param RecordParam Mp3录制参数。

RuleInfo

规则信息

被如下接口引用:DescribeLiveRecordRules、DescribeLiveSnapshotRules、DescribeLiveTranscodeRules、DescribeLiveWatermarkRules。

名称 类型 描述
CreateTime String 规则创建时间。
UpdateTime String 规则更新时间。
TemplateId Integer 模板Id。
DomainName String 推流域名。
AppName String 推流路径。
StreamName String 流名称。

SnapshotTemplateInfo

截图模板信息

被如下接口引用:DescribeLiveSnapshotTemplate、DescribeLiveSnapshotTemplates。

名称 类型 描述
TemplateId Integer 模板Id。
TemplateName String 模板名称。
SnapshotInterval Integer 截图时间间隔。5-300秒。
Width Integer 截图宽度。0-3000 0原始宽度并适配原始比例
Height Integer 截图高度。0-2000 0原始高度并适配原始比例
PornFlag Integer 是否开启鉴黄,0:不开启,1:开启。
CosAppId Integer Cos AppId。
CosBucket String Cos Bucket名称。
CosRegion String Cos 地域。
Description String 模板描述

StreamEventInfo

推断流事件信息。

被如下接口引用:DescribeLiveStreamEventList。

名称 类型 描述
AppName String 应用名称。
DomainName String 推流域名。
StreamName String 流名称。
StreamStartTime String 推流开始时间。
UTC格式时间,
例如:2019-01-07T12:00:00Z。
StreamEndTime String 推流结束时间。
UTC格式时间,
例如:2019-01-07T15:00:00Z。
StopReason String 停止原因。
Duration Integer 推流持续时长,单位:秒。
ClientIp String 主播IP。
Resolution String 分辨率。

StreamInfo

推流信息

被如下接口引用:DescribeLiveStreamOnlineInfo。

名称 类型 描述
AppName String 直播流所属应用名称
CreateMode String 创建模式
CreateTime String 创建时间,如: 2018-07-13 14:48:23
Status Integer 流状态
StreamId String 流id
StreamName String 流名称
WaterMarkId String 水印id

StreamName

流名称列表

被如下接口引用:DescribeLiveStreamPublishedList。

名称 类型 描述
StreamName String 流名称。
AppName String 应用名称。
DomainName String 推流域名。
StreamStartTime String 推流开始时间。
UTC格式时间,
例如:2019-01-07T12:00:00Z。
StreamEndTime String 推流结束时间。
UTC格式时间,
例如:2019-01-07T15:00:00Z。
StopReason String 停止原因。
Duration Integer 推流持续时长,单位:秒。
ClientIp String 主播IP。
Resolution String 分辨率。

StreamOnlineInfo

查询当前正在推流的信息

被如下接口引用:DescribeLiveStreamOnlineList。

名称 类型 描述
StreamName String 流名称。
PublishTimeList Array of PublishTime 推流时间列表
AppName String 应用名称。
DomainName String 推流域名。

TemplateInfo

转码模板信息

被如下接口引用:DescribeLiveTranscodeTemplate、DescribeLiveTranscodeTemplates。

名称 类型 描述
Vcodec String 视频编码:
h264/h265。
VideoBitrate Integer 视频码率。100-8000kbps
Acodec String 音频编码:aac/mp3
aac/mp3。
AudioBitrate Integer 音频码率。0-500
Width Integer 宽。0-3000
Height Integer 高。0-3000
Fps Integer 帧率。0-200
Gop Integer 关键帧间隔,单位:秒。1-50
Rotate Integer 旋转角度。0 90 180 270
Profile String 编码质量:
baseline/main/high。
BitrateToOrig Integer 是否不超过原始码率。0:否,1:是。
HeightToOrig Integer 是否不超过原始高度。0:否,1:是。
FpsToOrig Integer 是否不超过原始帧率。0:否,1:是。
NeedVideo Integer 是否保留视频。0:否,1:是。
NeedAudio Integer 是否保留音频。0:否,1:是。
TemplateId Integer 模板Id。
TemplateName String 模板名称
Description String 模板描述
AiTransCode Integer 是否是急速高清模板,0:否,1:是。默认0。
AdaptBitratePercent Float 急速高清相比VideoBitrate少多少码率,0.1到0.5

TranscodeDetailInfo

转码详细信息

被如下接口引用:DescribeLiveTranscodeDetailInfo。

名称 类型 描述
StreamName String 流名称。
StartTime String 开始时间,北京时间,
格式:yyyy-mm-dd HH:MM。
EndTime String 结束时间,北京时间,
格式:yyyy-mm-dd HH:MM。
Duration Integer 转码时长,单位:分钟。
注意:因推流过程中可能有中断重推情况,此处时长为真实转码时长累加值,并非结束时间和开始时间的间隔。
ModuleCodec String 编码方式,带模块,
示例:
liveprocessor_H264 =》直播转码-H264,
liveprocessor_H265 =》 直播转码-H265,
topspeed_H264 =》极速高清-H264,
topspeed_H265 =》极速高清-H265。
Bitrate Integer 码率。
Type String 类型,包含:转码(Transcode),混流(MixStream),水印(WaterMark)。
PushDomain String 推流域名。

WatermarkInfo

水印信息

被如下接口引用:DescribeLiveWatermark、DescribeLiveWatermarks。

名称 类型 描述
WatermarkId Integer 水印ID。
PictureUrl String 水印图片url。
XPosition Integer 显示位置,X轴偏移。
YPosition Integer 显示位置,Y轴偏移。
WatermarkName String 水印名称。
Status Integer 当前状态。0:未使用,1:使用中。
CreateTime String 添加时间。
Width Integer 水印宽
Height Integer 水印高