有奖捉虫:云通信与企业服务文档专题,速来> HOT

BackupStreamDetailData

主备流详细信息。

被如下接口引用:DescribeBackupStreamList。

名称 类型 描述
DomainName String 推流域名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:5000.livepush.com
AppName String 推流路径。
注意:此字段可能返回 null,表示取不到有效值。
示例值:live
PublishTime String UTC 格式,例如:2018-06-29T19:00:00Z。
注意:和北京时间相差8小时。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2018-06-29T19:00:00Z
UpstreamSequence String 推流唯一标识。
注意:此字段可能返回 null,表示取不到有效值。
示例值:710313341080024599
SourceFrom String 推流来源。示例:
直推流;
拉流转推(1234);
注意:拉流转推来源括号中为拉流转推的任务
ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:直推流
MasterFlag Integer 主备标识。
当前流为主流:1,
当前流为备流: 0。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

BackupStreamGroupInfo

主备流分组信息。

被如下接口引用:DescribeBackupStreamList。

名称 类型 描述
StreamName String 流名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test1
BackupList Array of BackupStreamDetailData 主备流信息。
注意:此字段可能返回 null,表示取不到有效值。
OptimalEnable Integer 是否对该流开启了择优调度。
0 - 未开启。
1 - 已开启。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
HostGroupName String 域名分组的分组名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:groupname

BandwidthInfo

带宽信息

被如下接口引用:DescribeDeliverBandwidthList。

名称 类型 描述
Time String 返回格式:
使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
根据粒度会有不同程度的缩减。
示例值:2022-11-06T16:50:00+08:00
Bandwidth Float 带宽。
示例值:0.01

BatchDomainOperateErrors

批量操作域名相关接口,若其中个别域名操作失败将会跳过,相应的域名错误信息将统一汇总在此类型中

被如下接口引用:ModifyLiveDomainCertBindings。

名称 类型 描述
DomainName String 操作失败的域名。
Code String API3.0错误码。
Message String API3.0错误信息。

BillAreaInfo

海外分区直播带宽出参,分区信息

被如下接口引用:DescribeAreaBillBandwidthAndFluxList。

名称 类型 描述
Name String 大区名称。
示例值:中东/非洲
Countrys Array of BillCountryInfo 国家或地区明细数据。

BillCountryInfo

海外分区直播带宽出参国家带宽信息

被如下接口引用:DescribeAreaBillBandwidthAndFluxList。

名称 类型 描述
Name String 国家名称
BandInfoList Array of BillDataInfo 带宽明细数据信息。

BillDataInfo

带宽和流量信息。

被如下接口引用:DescribeAreaBillBandwidthAndFluxList, DescribeBillBandwidthAndFluxList, DescribePushBandwidthAndFluxList。

名称 类型 描述
Time String 时间点,
使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2022-11-14T16:40:00+08:00
Bandwidth Float 带宽,单位是 Mbps。
示例值:0.1
Flux Float 流量,单位是 MB。
示例值:0.1
PeakTime String 峰值时间点,
使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
原始数据为5分钟粒度,如果查询小时和天粒度数据,则返回对应粒度内的带宽峰值时间点。
示例值:2022-11-14T16:40:00+08:00

CallBackRuleInfo

规则信息

被如下接口引用:DescribeLiveCallbackRules。

名称 类型 描述
CreateTime String 规则创建时间。
注:此字段为北京时间(UTC+8时区)。
UpdateTime String 规则更新时间。
注:此字段为北京时间(UTC+8时区)。
TemplateId Integer 模板 ID。
DomainName String 推流域名。
AppName String 推流路径。

CallBackTemplateInfo

回调模板信息。

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

名称 类型 描述
TemplateId Integer 模板 ID。
示例值:1
TemplateName String 模板名称。
示例值:aaa
Description String 描述信息。
示例值:xxx
StreamBeginNotifyUrl String 开播回调 URL。
示例值:http://abc.com/abc
StreamMixNotifyUrl String 混流回调 URL。(参数已弃用)。
StreamEndNotifyUrl String 断流回调 URL。
示例值:http://abc.com/abc
RecordNotifyUrl String 录制文件回调 URL。
示例值:http://abc.com/abc
SnapshotNotifyUrl String 截图回调 URL。
示例值:http://abc.com/abc
PornCensorshipNotifyUrl String 鉴黄回调 URL。
示例值:http://abc.com/abc
CallbackKey String 回调的鉴权 key。
示例值:def
PushExceptionNotifyUrl String 推流异常回调 URL。
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://abc.com/abc
AudioAuditNotifyUrl String 音频审核回调 URL。
注意:此字段可能返回 null,表示取不到有效值。

CallbackEventInfo

回调事件信息

被如下接口引用:DescribeCallbackRecordsList。

名称 类型 描述
EventTime String 事件时间。
接口返回支持两种时间格式:
1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 ISO 日期格式说明
2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。
接口返回的时间格式和查询请求传入的时间格式一致。
EventType Integer 事件类型
Request String 回调请求
Response String 回调响应
ResponseTime String 客户接口响应时间。
接口返回支持两种时间格式:
1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 ISO 日期格式说明
2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。
接口返回的时间格式和查询请求传入的时间格式一致。
ResultCode Integer 回调结果
StreamId String 流名称

CdnPlayStatData

下行播放统计指标

被如下接口引用:DescribeGroupProIspPlayInfoList。

名称 类型 描述
Time String 时间点,
使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2019-01-08T10:00:00Z
Bandwidth Float 带宽,单位: Mbps。
示例值:0.1
Flux Float 流量,单位: MB。
示例值:0.1
Request Integer 新增请求数。
示例值:1
Online Integer 并发连接数。
示例值:1

CertInfo

证书信息。

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

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

ClientIpPlaySumInfo

客户端ip播放汇总信息。

被如下接口引用:DescribeTopClientIpSumInfoList。

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

CommonMixControlParams

通用混流控制参数

被如下接口引用:CreateCommonMixStream。

名称 类型 必选 描述
UseMixCropCenter Integer 取值范围[0,1]。
填1时,当参数中图层分辨率参数与视频实际分辨率不一致时,自动从视频中按图层设置的分辨率比例进行裁剪。
示例值:0
AllowCopy Integer 取值范围[0,1]
填1时,当InputStreamList中个数为1时,且OutputParams.OutputStreamType为1时,不执行取消操作,执行拷贝流操作
示例值:0
PassInputSei Integer 取值范围[0,1]
填1时,透传原始流的sei
示例值:0

CommonMixCropParams

通用混流输入裁剪参数。

被如下接口引用:CreateCommonMixStream。

名称 类型 必选 描述
CropWidth Float 裁剪的宽度。取值范围[0,2000]。
示例值:0
CropHeight Float 裁剪的高度。取值范围[0,2000]。
示例值:0
CropStartLocationX Float 裁剪的起始X坐标。取值范围[0,2000]。
示例值:0
CropStartLocationY Float 裁剪的起始Y坐标。取值范围[0,2000]。
示例值:0

CommonMixInputParam

通用混流输入参数。

被如下接口引用:CreateCommonMixStream。

名称 类型 必选 描述
InputStreamName String 输入流名称。80字节以内,仅含字母、数字以及下划线的字符串。
当LayoutParams.InputType=0(音视频)/4(纯音频)/5(纯视频)时,该值为需要混流的流名称。
当LayoutParams.InputType=2(图片)/3(画布)时,该值仅用作标识输入,可用类似Canvas1、Pictrue1的名称。
示例值:ExampleStreamName1
LayoutParams CommonMixLayoutParams 输入流布局参数。
CropParams CommonMixCropParams 输入流裁剪参数。
PortraitSegmentParams MixPortraitSegmentParams 抠图参数。

CommonMixLayoutParams

通用混流布局参数。

被如下接口引用:CreateCommonMixStream。

名称 类型 必选 描述
ImageLayer Integer 输入图层。取值范围[1,16]。
1)背景流(即大主播画面或画布)的 image_layer 填1。
2)纯音频混流,该参数也需填。
注意:不同输入,该值不可重复
示例值:1
InputType Integer 输入类型。取值范围[0,5]。
不填默认为0。
0表示输入流为音视频。
2表示输入流为图片。
3表示输入流为画布。
4表示输入流为音频。
5表示输入流为纯视频。
示例值:0
ImageHeight Float 输入画面在输出时的高度。取值范围:
像素:[0,2000]
百分比:[0.01,0.99]
不填默认为输入流的高度。
使用百分比时,期望输出为(百分比 * 背景高)。
示例值:720
ImageWidth Float 输入画面在输出时的宽度。取值范围:
像素:[0,2000]
百分比:[0.01,0.99]
不填默认为输入流的宽度。
使用百分比时,期望输出为(百分比 * 背景宽)。
示例值:1024
LocationX Float 输入在输出画面的X偏移。取值范围:
像素:[0,2000]
百分比:[0.01,0.99]
不填默认为0。
相对于大主播背景画面左上角的横向偏移。
使用百分比时,期望输出为(百分比 * 背景宽)。
示例值:0
LocationY Float 输入在输出画面的Y偏移。取值范围:
像素:[0,2000]
百分比:[0.01,0.99]
不填默认为0。
相对于大主播背景画面左上角的纵向偏移。
使用百分比时,期望输出为(百分比 * 背景宽)
示例值:0
Color String 当InputType为3(画布)时,该值表示画布的颜色。
常用的颜色有:
红色:0xCC0033。
黄色:0xCC9900。
绿色:0xCCCC33。
蓝色:0x99CCFF。
黑色:0x000000。
白色:0xFFFFFF。
灰色:0x999999。
示例值:0xFFFFFF
WatermarkId Integer 当InputType为2(图片)时,该值是水印ID。
示例值:0

CommonMixOutputParams

通用混流输出参数。

被如下接口引用:CreateCommonMixStream。

名称 类型 必选 描述
OutputStreamName String 输出流名称。
OutputStreamType Integer 输出流类型,取值范围[0,1]。
不填默认为0。
当输出流为输入流 list 中的一条时,填写0。
当期望生成的混流结果成为一条新流时,该值填为1。
该值为1时,output_stream_id 不能出现在 input_stram_list 中,且直播后台中,不能存在相同 ID 的流。
OutputStreamBitRate Integer 输出流比特率。取值范围[1,10000]。
不填的情况下,系统会自动判断。
OutputStreamGop Integer 输出流GOP大小。取值范围[1,10]。
不填的情况下,系统会自动判断。
OutputStreamFrameRate Integer 输出流帧率大小。取值范围[1,60]。
不填的情况下,系统会自动判断。
OutputAudioBitRate Integer 输出流音频比特率。取值范围[1,500]
不填的情况下,系统会自动判断。
OutputAudioSampleRate Integer 输出流音频采样率。取值范围[96000, 88200, 64000, 48000, 44100, 32000,24000, 22050, 16000, 12000, 11025, 8000]。
不填的情况下,系统会自动判断。
OutputAudioChannels Integer 输出流音频声道数。取值范围[1,2]。
不填的情况下,系统会自动判断。
MixSei String 输出流中的sei信息。如果无特殊需要,不填。

ConcurrentRecordStreamNum

并发录制路数

被如下接口引用:DescribeConcurrentRecordStreamNum, DescribeUploadStreamNums。

名称 类型 描述
Time String 时间点。
Num Integer 路数。

DayStreamPlayInfo

流播放信息

被如下接口引用:DescribeStreamPlayInfoList。

名称 类型 描述
Time String 数据时间点,接口返回支持两种时间格式:
1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见ISO日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I
2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。
接口返回的时间格式和查询请求传入的时间格式一致。
示例值:2019-01-08T10:00:00Z
Bandwidth Float 带宽(单位Mbps)。
示例值:1.0
Flux Float 流量 (单位MB)。
示例值:1.0
Request Integer 请求数。
示例值:1
Online Integer 在线人数。
示例值:1

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: 生效中。

DiagnoseResult

媒体诊断结果,包含断流信息、低帧率信息等

被如下接口引用:DescribeMonitorReport。

名称 类型 描述
StreamBrokenResults Array of String 断流信息
注意:此字段可能返回 null,表示取不到有效值。
LowFrameRateResults Array of String 低帧率信息
注意:此字段可能返回 null,表示取不到有效值。
StreamFormatResults Array of String 流格式诊断信息
注意:此字段可能返回 null,表示取不到有效值。

DomainCertInfo

域名证书信息

被如下接口引用:DescribeLiveDomainCert。

名称 类型 描述
CertId Integer 证书Id。
CertName String 证书名称。
Description String 描述信息。
CreateTime String 创建时间,UTC格式。
注:此字段为北京时间(UTC+8时区)。
HttpsCrt String 证书内容。
CertType Integer 证书类型。
0:用户添加证书,
1:腾讯云托管证书。
CertExpireTime String 证书过期时间,UTC格式。
注:此字段为北京时间(UTC+8时区)。
DomainName String 使用此证书的域名名称。
Status Integer 证书状态。
CertDomains Array of String 证书本身标识的域名列表。
比如: ["*.x.com"]
注意:此字段可能返回 null,表示取不到有效值。
CloudCertId String 腾讯云ssl的证书Id
注意:此字段可能返回 null,表示取不到有效值。

DomainDetailInfo

每个域名的统计信息。

被如下接口引用:DescribeLiveDomainPlayInfoList。

名称 类型 描述
MainlandOrOversea String 国内还是国外:
Mainland: 表示国内数据。
Oversea: 表示国外数据。
Bandwidth Float 带宽,单位: Mbps。
Flux Float 流量,单位: MB。
Online Integer 人数。
Request Integer 请求数。

DomainInfo

直播域名信息

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

名称 类型 描述
Name String 直播域名。
示例值:abc.com
Type Integer 域名类型:
0: 推流。
1: 播放。
示例值:1
Status Integer 域名状态:
0: 停用。
1: 启用。
示例值:1
CreateTime String 添加时间。
注:此字段为北京时间(UTC+8时区)。
示例值:2011-09-09 11:11:11
BCName Integer 是否有 CName 到固定规则域名:
0: 否。
1: 是。
示例值:1
TargetDomain String cname 对应的域名。
示例值:abc.com
PlayType Integer 播放区域,只在 Type=1 时该参数有意义。
1: 国内。
2: 全球。
3: 海外。
示例值:2
IsDelayLive Integer 是否慢直播:
0: 普通直播。
1: 慢直播。
示例值:0
CurrentCName String 当前客户使用的 cname 信息。
示例值:abc.com
RentTag Integer 失效参数,可忽略。
示例值:a
RentExpireTime String 失效参数,可忽略。
注:此字段为北京时间(UTC+8时区)。
示例值:2011-09-09 11:11:11
IsMiniProgramLive Integer 0: 标准直播。
1: 小程序直播。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

DomainInfoList

多个域名信息列表

被如下接口引用:DescribeLiveDomainPlayInfoList。

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

FlvSpecialParam

flv格式特殊配置

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

名称 类型 必选 描述
UploadInRecording Boolean 是否开启边录边传,仅flv格式有效。
示例值:false

ForbidStreamInfo

禁推流列表

被如下接口引用:DescribeLiveForbidStreamList。

名称 类型 描述
StreamName String 流名称。
示例值:test
CreateTime String 创建时间。
注:此字段为北京时间(UTC+8时区)。
示例值:2020-01-01 12:12:12
ExpireTime String 禁推过期时间。
注:此字段为北京时间(UTC+8时区)。
示例值:2020-01-01 12:12:12
AppName String 推流路径。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
DomainName String 推流域名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test

GroupProIspDataInfo

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

被如下接口引用:DescribeGroupProIspPlayInfoList。

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

HlsSpecialParam

HLS专属录制参数

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

名称 类型 必选 描述
FlowContinueDuration Integer HLS续流超时时间。
取值范围[0,1800]。
注意:此字段可能返回 null,表示取不到有效值。

HttpCodeInfo

HTTP返回码和统计数据

被如下接口引用:DescribePlayErrorCodeDetailInfoList。

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

HttpCodeValue

HTTP返回码数据信息

被如下接口引用:DescribePlayErrorCodeDetailInfoList。

名称 类型 描述
Time String 时间,
使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2022-11-14T16:38:00+08:00
Numbers Integer 次数。
示例值:1
Percentage Float 占比。
示例值:0.1

HttpStatusData

播放错误码信息

被如下接口引用:DescribeHttpStatusInfoList。

名称 类型 描述
Time String 数据时间点,
使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2019-03-01T00:00:00+08:00
HttpStatusInfoList Array of HttpStatusInfo 播放状态码详细信息。

HttpStatusInfo

播放错误码信息

被如下接口引用:DescribeHttpStatusInfoList。

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

LiveCertDomainInfo

用作批量绑定域名和证书。

被如下接口引用:ModifyLiveDomainCertBindings。

名称 类型 必选 描述
DomainName String 域名。
Status Integer 是否启用域名的https规则。
1:启用
0:禁用
-1:保持不变

LiveDomainCertBindings

DescribeLiveDomainCertBindings, DescribeLiveDomainCertBindingsGray接口返回的域名证书信息

被如下接口引用:DescribeLiveDomainCertBindings。

名称 类型 描述
DomainName String 域名。
CertificateAlias String 证书备注。与CertName同义。
CertType Integer 证书类型。
0:自有证书
1:腾讯云ssl托管证书
Status Integer https状态。
1:已开启。
0:已关闭。
CertExpireTime Timestamp 证书过期时间。
注:此字段为北京时间(UTC+8时区)。
CertId Integer 证书Id。
CloudCertId String 腾讯云ssl的证书Id。
UpdateTime Timestamp 规则最后更新时间。
注:此字段为北京时间(UTC+8时区)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2020-05-06 17:00:00

LivePackageInfo

直播包信息。

被如下接口引用:DescribeLivePackageInfo。

名称 类型 描述
Id String 包 ID。
Total Integer 总量。
注意:当为流量包时单位为字节。
当为转码包时单位为分钟。
Used Integer 使用量。
注意:当为流量包时单位为字节。
当为转码包时单位为分钟。
当为连麦包时单位为小时。
Left Integer 剩余量。
注意:当为流量包时单位为字节。
当为转码包时单位为分钟。
当为连麦包时单位为小时。
BuyTime String 购买时间。
注:此字段为北京时间(UTC+8时区)。
ExpireTime String 过期时间。
注:此字段为北京时间(UTC+8时区)。
Type Integer 包类型,可选值:
0: 流量包。
1: 普通转码包。
2: 极速高清包。
3: 连麦包。
Status Integer 包状态,可选值:
0: 未使用。
1: 使用中。
2: 已过期。
3: 已冻结。
4: 已耗尽。
5: 已退款
WillRenew Integer 是否自动续购。
注意:此字段可能返回 null,表示取不到有效值。
RenewalResult Integer 续购状态。
1 :续购成功。
0 :尚未续购。
<0 : 续购失败。
注意:此字段可能返回 null,表示取不到有效值。

LiveStreamMonitorInfo

直播监播任务信息。

被如下接口引用:DescribeLiveStreamMonitor, DescribeLiveStreamMonitorList。

名称 类型 必选 描述
MonitorId String 监播任务ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
MonitorName String 监播任务名称。128字节以内。
注意:此字段可能返回 null,表示取不到有效值。
示例值:ExampleMonitorName
OutputInfo LiveStreamMonitorOutputInfo 监播任务输出信息。
注意:此字段可能返回 null,表示取不到有效值。
示例值: output_info
InputList Array of LiveStreamMonitorInputInfo 待监播的输入流信息。
注意:此字段可能返回 null,表示取不到有效值。
示例值: input_list
Status Integer 监播任务状态。
0: 代表空闲
1: 代表监播中。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
StartTime Integer 上一次的启动时间,unix时间戳。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1640763135
StopTime Integer 上一次的停止时间,unix时间戳。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1640763135
CreateTime Integer 监播任务创建时间,unix时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1640763135
UpdateTime Integer 监播任务更新时间,unix时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1640763135
NotifyPolicy LiveStreamMonitorNotifyPolicy 监播事件通知策略。
注意:此字段可能返回 null,表示取不到有效值。
AudibleInputIndexList Array of Integer 输出音频的输入Index列表。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
AiAsrInputIndexList Array of Integer 开启智能语音识别的输入Index列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
CheckStreamBroken Integer 是否开启断流检测
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CheckStreamLowFrameRate Integer 是否开启低帧率检测
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
AsrLanguage Integer 智能语音识别语种:
0 关闭 1 中文 2 英文 3日文 4 韩文
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
OcrLanguage Integer 智能文字识别语种:
0 关闭 1 中、英文
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
AiOcrInputIndexList Array of Integer 开启智能文字识别的输入Index列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
AllowMonitorReport Integer 是否存储监播事件到监播报告,以及是否允许查询监播报告
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
AiFormatDiagnose Integer 是否开启格式诊断
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

LiveStreamMonitorInputInfo

直播监播功能输入流信息

被如下接口引用:CreateLiveStreamMonitor, DescribeLiveStreamMonitor, DescribeLiveStreamMonitorList, ModifyLiveStreamMonitor。

名称 类型 必选 描述
InputStreamName String 待监播的输入流名称。256字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。
注意:此字段可能返回 null,表示取不到有效值。
示例值:ExampleStreamName
InputDomain String 待监播的输入流推流域名。128字节以内,只允许填处于启用状态的推流域名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:ExampleDomain
InputApp String 待监播的输入流推流路径。32字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Live
InputUrl String 待监播的输入流推流url。一般场景下,无需该参数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:rtmp://ExampleDomain/Live/ExampleStreamName
Description String 描述。256字节以内。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Input1

LiveStreamMonitorNotifyPolicy

直播流监播通知策略

被如下接口引用:CreateLiveStreamMonitor, DescribeLiveStreamMonitor, DescribeLiveStreamMonitorList, ModifyLiveStreamMonitor。

名称 类型 必选 描述
NotifyPolicyType Integer 通知策略类型:范围[0,1]
0:代表不使用任何通知策略
1:代表使用全局回调策略,所有事件通知到CallbackUrl。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CallbackUrl String 回调URL:长度[0,512]
只支持http和https类型的url。
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://notify.example.com/notify

LiveStreamMonitorOutputInfo

直播流监播输出流信息

被如下接口引用:CreateLiveStreamMonitor, DescribeLiveStreamMonitor, DescribeLiveStreamMonitorList, ModifyLiveStreamMonitor。

名称 类型 必选 描述
OutputStreamWidth Integer 监播任务输出流宽度像素。范围[1,1920]。建议至少大于100像素。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1920
OutputStreamHeight Integer 监播任务输出流长度像素。范围[1,1080],建议至少大于100像素。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1080
OutputStreamName String 监播任务输出流名称。
不填时,系统会自动生成。
256字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。
注意:此字段可能返回 null,表示取不到有效值。
示例值:OutputExampleName
OutputDomain String 监播任务播放域名。128字节以内,只允许填处于启用状态的播放域名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:OutputExampleDomain
OutputApp String 监播任务播放路径。32字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Live

LogInfo

日志url信息。

被如下接口引用:DescribeLogDownloadList。

名称 类型 描述
LogName String 日志名称。
LogUrl String 日志 URL。
LogTime String 日志生成时间。
注:此字段为北京时间(UTC+8时区)。
FileSize Integer 文件大小。

MPSResult

媒体处理结果,包含智能语音识别、智能文字识别结果

被如下接口引用:DescribeMonitorReport。

名称 类型 描述
AiAsrResults Array of String 智能语音识别结果
注意:此字段可能返回 null,表示取不到有效值。
AiOcrResults Array of String 智能文字识别结果
注意:此字段可能返回 null,表示取不到有效值。

MixPortraitSegmentParams

混流抠图参数

被如下接口引用:CreateCommonMixStream。

名称 类型 必选 描述
Color String 抠图背景颜色,
常用的颜色有:
红色:0xcc0033。
黄色:0xcc9900。
绿色:0xcccc33。
蓝色:0x99CCFF。
黑色:0x000000。
白色:0xFFFFFF。
灰色:0x999999。
示例值:0xcccc33

MonitorStreamPlayInfo

监控播放数据

被如下接口引用:DescribeAllStreamPlayInfoList。

名称 类型 描述
PlayDomain String 播放域名。
StreamName String 流id。
Rate Integer 播放码率,0表示原始码率。
Protocol String 播放协议,可选值包括 Unknown,Flv,Hls,Rtmp,Huyap2p。
Bandwidth Float 带宽,单位是Mbps。
Online Integer 在线人数,1分钟采样一个点,统计采样点的tcp链接数目。
Request Integer 请求数。

PadTemplate

直播垫片模板。

被如下接口引用:DescribeLivePadTemplate, DescribeLivePadTemplates。

名称 类型 必选 描述
TemplateId Integer 模板id。
示例值:1
TemplateName String 模板名称。
示例值:test
Url String 垫片内容。
示例值:https://test.com/a.mp4
CreateTime String 模板创建时间。
示例值:2020-01-01 08:00:00
UpdateTime String 模板修改时间。
示例值:2020-01-01 08:00:00
Description String 模板描述。
示例值:test
WaitDuration Integer 断流等待时间。
取值范围:0-30000。
单位:ms。
示例值:0
MaxDuration Integer 最大垫片时长。
取值范围:0 - 正无穷。
单位:ms。
示例值:0
Type Integer 垫片内容类型: 1:图片,2:视频。 默认值:1。
示例值:1

PlayAuthKeyInfo

播放鉴权key信息。

被如下接口引用:DescribeLivePlayAuthKey。

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

PlayCodeTotalInfo

各状态码的总次数,支持大多数的 HTTP 协议返回码。

被如下接口引用: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。

名称 类型 描述
CountryAreaName String 国家或地区。
ProvinceName String 省份。
IspName String 运营商。
Code2xx Integer 错误码为2开头的次数。
Code3xx Integer 错误码为3开头的次数。
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。

PullPushWatermarkInfo

云转推水印信息。

被如下接口引用:CreateLivePullStreamTask, DescribeLivePullStreamTasks, ModifyLivePullStreamTask。

名称 类型 必选 描述
PictureUrl String 水印图片 URL。
URL中禁止包含的字符:
;(){}$>`#"'|
示例值:http://xxx.gifshow/pic.jpg
XPosition Integer 显示位置,X轴偏移,单位是百分比,默认 0。
示例值:0
YPosition Integer 显示位置,Y轴偏移,单位是百分比,默认 0。
示例值:0
Width Integer 水印宽度,占直播原始画面宽度百分比,建议高宽只设置一项,另外一项会自适应缩放,避免变形。默认原始宽度。
示例值:100
Height Integer 水印高度,占直播原始画面高度百分比,建议高宽只设置一项,另外一项会自适应缩放,避免变形。默认原始高度。
示例值:100
Location Integer 水印位置,默认 0。
0:左上角。
1:右上角。
2:右下角。
3:左下角。
示例值:0

PullStreamConfig

拉流配置。

被如下接口引用:DescribePullStreamConfigs。

名称 类型 描述
ConfigId String 拉流配置 ID。
FromUrl String 源 URL。
ToUrl String 目的 URL。
AreaName String 区域名。
IspName String 运营商名。
StartTime String 开始时间。
UTC格式时间,例如: 2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
EndTime String 结束时间。

UTC格式时间,例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
Status String 状态:
0: 无效。
1: 初始状态。
2: 正在运行。
3: 拉起失败。
4: 暂停。

PullStreamTaskInfo

直播拉流任务信息。

被如下接口引用:DescribeLivePullStreamTasks。

名称 类型 描述
TaskId String 拉流任务Id。
示例值:12345
SourceType String 拉流源的类型:
PullLivePushLive -直播,
PullVodPushLive -点播,
PullPicPushLive -图片。
示例值:PullLivePushLive
SourceUrls Array of String 拉流源url列表。
SourceType为直播(PullLiveToLive)只可以填1个,
SourceType为点播(PullVodToLive)可以填多个,上限10个。
示例值:http://test.domain/live/test.flv?txSecret=xx&txTime=xxx
DomainName String 推流域名。
将拉到的源推到该域名。
示例值:5000.livepush.qcloud.com
AppName String 推流路径。
将拉到的源推到该路径。
示例值:live
StreamName String 流名称。
将拉到的源推到该流名称。
示例值:teststream
PushArgs String 推流参数。
推流携带的自定义参数。
示例值:secret=abc&time=F7F78AE7
StartTime String 开始时间。
使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2021-02-24T00:00:00Z
EndTime String 结束时间,注意:
1. 结束时间必须大于开始时间;
2. 结束时间和开始时间必须大于当前时间;
3. 结束时间 和 开始时间 间隔必须小于七天。
使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2021-02-28T00:00:00Z
Region String 任务创建所在地域:
ap-beijing - 华北地区(北京),
ap-shanghai -华东地区(上海),
ap-guangzhou -华南地区(广州),
ap-mumbai - 印度,
ap-hongkong - 香港,
eu-frankfurt - 德国,
ap-seoul - 韩国,
ap-bangkok - 泰国,
ap-singapore - 新加坡,
na-siliconvalley - 美西,
na-ashburn - 美东,
ap-tokyo - 日本。
示例值:ap-guangzhou
VodLoopTimes Integer 点播拉流转推循环次数。
-1:无限循环,直到任务结束。
0:不循环。
>0:具体循环次数。次数和时间以先结束的为准。
注意:拉流源为点播,该配置生效。
示例值:-1
VodRefreshType String 点播更新SourceUrls后的播放方式:
ImmediateNewSource:立即从更新的拉流源开始播放;
ContinueBreakPoint:从上次断流url源的断点处继续,结束后再使用新的拉流源。

注意:拉流源为点播,该配置生效。
示例值:ImmediateNewSource
CreateTime String 任务创建时间。
使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2021-02-23T00:00:00Z
UpdateTime String 任务更新时间。
使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2021-02-24T10:00:00Z
CreateBy String 创建任务的操作者。
示例值:admin
UpdateBy String 最后更新任务的操作者。
示例值:admin
CallbackUrl String 回调地址。
示例值:http://you.callback.url
CallbackEvents Array of String 选择需要回调的事件:
TaskStart:任务启动回调,
TaskExit:任务停止回调,
VodSourceFileStart:从点播源文件开始拉流回调,
VodSourceFileFinish:从点播源文件拉流结束回调,
ResetTaskConfig:任务更新回调。
CallbackInfo String 注意:该信息暂不返回。
最后一次回调信息。
ErrorInfo String 注意:该信息暂不返回。
错误信息。
Status String 状态。
enable:生效中。
pause:暂停中。
示例值:enable
RecentPullInfo RecentPullInfo 注意:该信息仅在查询单个任务时返回。
任务最新拉流信息。
包含:源 url,偏移时间,上报时间。
Comment String 任务备注信息。
示例值:直播活动任务
BackupSourceType String 备源类型:
PullLivePushLive -直播,
PullVodPushLive -点播。
注意:此字段可能返回 null,表示取不到有效值。
示例值:PullLivePushLive
BackupSourceUrl String 备源URL。
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://test.domain/live/test.flv?txSecret=xx&txTime=xxx
WatermarkList Array of PullPushWatermarkInfo 水印信息列表。
注意:此字段可能返回 null,表示取不到有效值。
VodLocalMode Integer 点播源是否启用本地推流模式,默认0,不启用。
0 - 不启用。
1 - 启用。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RecordTemplateId String 录制模板 ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:123
BackupToUrl String 新增的推流地址。用于单任务推两路场景。
注意:此字段可能返回 null,表示取不到有效值。
示例值:rtmp://5000.livepush.myqcloud.com/live/vinback?txSecret=6e9797ce

PushAuthKeyInfo

推流鉴权key信息。

被如下接口引用:DescribeLivePushAuthKey。

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

PushDataInfo

推流数据信息

被如下接口引用:DescribeLiveStreamPushInfoList。

名称 类型 描述
StreamName String 流名称。
示例值:test1
AppName String 推流路径。
示例值:live
ClientIp String 推流客户端 IP。
示例值:127.0.0.1
ServerIp String 接流服务器 IP。
示例值:127.0.0.1
VideoFps Integer 推流视频帧率,单位: Hz。
示例值:100
VideoSpeed Integer 推流视频码率,单位: bps。
示例值:100
AudioFps Integer 推流音频帧率,单位: Hz。
示例值:40
AudioSpeed Integer 推流音频码率,单位: bps。
示例值:40
PushDomain String 推流域名。
示例值:5000.pushdomain.com
BeginPushTime String 推流开始时间。
示例值:2019-02-01 00:00:00
Acodec String 音频编码格式,
例:"AAC"。
示例值:AAC
Vcodec String 视频编码格式,
例:"H264"。
示例值:H264
Resolution String 分辨率。
示例值:350*350
AsampleRate Integer 采样率。
示例值:48000
MetaAudioSpeed Integer metadata 中的音频码率,单位: bps。
示例值:22
MetaVideoSpeed Integer metadata 中的视频码率,单位: bps。
示例值:4885
MetaFps Integer metadata 中的帧率。
示例值:30

PushLogInfo

推流域名日志信息。

被如下接口引用:DescribeDeliverLogDownList。

名称 类型 描述
LogName String 日志名称。
示例值:pushlog-xxx
LogUrl String 日志下载地址。
示例值:https://livelog-down.cdn.qcloud.com/20220804/11/202208041125-pul
LogTime String 日志时间。UTC 格式,例如:2018-11-29T19:00:00Z。
注意:
1. 北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2022-02-09T12:36:42Z
FileSize Integer 文件大小,单位字节。
示例值:1222

PushQualityData

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

被如下接口引用:DescribeStreamPushInfoList。

名称 类型 描述
Time String 数据时间,使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2021-03-01T00:00:00+08:00
PushDomain String 推流域名。
示例值:test.com
AppName String 推流路径。
示例值:live
ClientIp String 推流客户端 IP。
示例值:0.0.0.0
BeginPushTime String 开始推流时间,格式: %Y-%m-%d %H:%M:%S.%ms,精确到毫秒级。
示例值:2021-03-01 00:00:00
Resolution String 分辨率信息。
示例值:480*864
VCodec String 视频编码格式。
示例值:H264
ACodec String 音频编码格式。
示例值:AAC
Sequence String 推流序列号,用来唯一的标志一次推流。
示例值:11111
VideoFps Integer 视频帧率。
示例值:1
VideoRate Integer 视频码率,单位: bps。
示例值:1
AudioFps Integer 音频帧率。
示例值:1
AudioRate Integer 音频码率,单位: bps。
示例值:1
LocalTs Integer 本地流逝时间,单位: ms,音视频流逝时间与本地流逝时间的差距越大表示推流质量越差,上行卡顿越严重。
示例值:10
VideoTs Integer 视频流逝时间,单位: ms。
示例值:10
AudioTs Integer 音频流逝时间,单位: ms。
示例值:10
MetaVideoRate Integer metadata 中的视频码率,单位: kbps。
示例值:1
MetaAudioRate Integer metadata 中的音频码率,单位: kbps。
示例值:1
MateFps Integer metadata 中的帧率。
示例值:1
StreamParam String 推流参数
示例值:&test=1
Bandwidth Float 带宽,单位Mbps。
示例值:0.1
Flux Float 流量,单位MB。
示例值:0.1
ServerIp String 推流服务端 IP。
注意:此字段可能返回 null,表示取不到有效值。
示例值:192.1.1.1

RecentPullInfo

直播拉流当前正在拉的文件信息。

被如下接口引用:DescribeLivePullStreamTasks。

名称 类型 描述
FileUrl String 当前正在拉的文件地址。
示例值:http://youfile.domain.com/vod/file.mp4
OffsetTime Integer 当前正在拉的文件偏移,单位:秒。
示例值:2300
ReportTime String 最新上报偏移信息时间。UTC格式。
如:2020-07-23T03:20:39Z。
注意:与北京时间相差八小时。
示例值:2022-10-20T03:35:11Z
LoopedTimes Integer 已经轮播的次数。
示例值:2

RecordParam

录制模板参数。

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

名称 类型 必选 描述
RecordInterval Integer 录制间隔。
单位秒,默认:1800。
取值范围:30-7200。
此参数对 HLS 无效,当录制 HLS 时从推流到断流生成一个文件。
示例值:400
StorageTime Integer 录制存储时长。
单位秒,取值范围: 0 - 1500天。
0:表示永久存储。
示例值:123
Enable Integer 是否开启当前格式录制,默认值为0,0:否, 1:是。
示例值:0
VodSubAppId Integer 点播子应用 ID。
示例值:1
VodFileName String 录制文件名。
支持的特殊占位符有:
{StreamID}: 流ID
{StartYear}: 开始时间-年
{StartMonth}: 开始时间-月
{StartDay}: 开始时间-日
{StartHour}: 开始时间-小时
{StartMinute}: 开始时间-分钟
{StartSecond}: 开始时间-秒
{StartMillisecond}: 开始时间-毫秒
{EndYear}: 结束时间-年
{EndMonth}: 结束时间-月
{EndDay}: 结束时间-日
{EndHour}: 结束时间-小时
{EndMinute}: 结束时间-分钟
{EndSecond}: 结束时间-秒
{EndMillisecond}: 结束时间-毫秒

若未设置默认录制文件名为{StreamID}{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}
示例值:{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{Star
Procedure String 任务流
注意:此字段可能返回 null,表示取不到有效值。
示例值:liu
StorageMode String 视频存储策略。
normal:标准存储。
cold:低频存储。
注意:此字段可能返回 null,表示取不到有效值。
示例值:normal
ClassId Integer 点播应用分类
注意:此字段可能返回 null,表示取不到有效值。
示例值:123

RecordTask

录制任务

被如下接口引用:DescribeRecordTask。

名称 类型 描述
TaskId String 录制任务ID。
DomainName String 推流域名。
AppName String 推流路径。
StreamName String 流名称。
StartTime Integer 任务开始时间,Unix时间戳。
EndTime Integer 任务结束时间,Unix时间戳。
TemplateId Integer 录制模板ID。
Stopped Integer 调用 StopRecordTask 停止任务时间,Unix时间戳。值为0表示未曾调用接口停止任务。

RecordTemplateInfo

录制模板信息

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

名称 类型 描述
TemplateId Integer 模板 ID。
示例值:1
TemplateName String 模板名称。
示例值:test-1
Description String 描述信息。
示例值:test
FlvParam RecordParam FLV 录制参数。
HlsParam RecordParam HLS 录制参数。
Mp4Param RecordParam MP4 录制参数。
AacParam RecordParam AAC 录制参数。
IsDelayLive Integer 0:普通直播,
1:慢直播。
示例值:1
HlsSpecialParam HlsSpecialParam HLS 录制定制参数。
Mp3Param RecordParam MP3 录制参数。
RemoveWatermark Boolean 是否去除水印。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
FlvSpecialParam FlvSpecialParam FLV 录制定制参数。
注意:此字段可能返回 null,表示取不到有效值。

RefererAuthConfig

直播域名Referer黑白名单配置

被如下接口引用:DescribeLiveDomainReferer。

名称 类型 描述
DomainName String 域名。
Enable Integer 是否启用,0:关闭,1:启用。
Type Integer 名单类型,0:黑名单,1:白名单。
AllowEmpty Integer 是否允许空Referer,0:不允许,1:允许。
Rules String 名单列表,以分号(;)分隔。

RuleInfo

规则信息。

被如下接口引用:DescribeLivePadRules, DescribeLiveRecordRules, DescribeLiveSnapshotRules, DescribeLiveTimeShiftRules, DescribeLiveTranscodeRules, DescribeLiveWatermarkRules。

名称 类型 描述
CreateTime String 规则创建时间。
注:此字段为北京时间(UTC+8时区)。
UpdateTime String 规则更新时间。
注:此字段为北京时间(UTC+8时区)。
TemplateId Integer 模板 ID。
DomainName String 推流域名。
AppName String 推流路径。
StreamName String 流名称。

ScreenshotTask

截图任务

被如下接口引用:DescribeScreenshotTask。

名称 类型 描述
TaskId String 截图任务ID。
示例值:""
DomainName String 推流域名。
示例值:""
AppName String 推流路径。
示例值:""
StreamName String 流名称。
示例值:""
StartTime Integer 任务开始时间,Unix时间戳。
示例值:0
EndTime Integer 任务结束时间,Unix时间戳。
示例值:0
TemplateId Integer 截图模板ID。
示例值:0
Stopped Integer 调用 StopScreenshotTask 停止任务时间,Unix时间戳。值为0表示未曾调用接口停止任务。
示例值:0

SnapshotTemplateInfo

截图模板信息。

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

名称 类型 描述
TemplateId Integer 模板 ID。
示例值:123
TemplateName String 模板名称。
示例值:test
SnapshotInterval Integer 截图时间间隔,5-300秒。
示例值:5
Width Integer 截图宽度,范围:0-3000。
0:原始宽度并适配原始比例。
示例值:5
Height Integer 截图高度,范围:0-2000。
0:原始高度并适配原始比例。
示例值:5
PornFlag Integer 是否开启鉴黄,0:不开启,1:开启。
示例值:0
CosAppId Integer Cos 应用 ID。
示例值:123456
CosBucket String Cos Bucket名称。
示例值:test
CosRegion String Cos 地域。
示例值:ap-nanjing
Description String 模板描述。
示例值:测试模板
CosPrefix String Cos Bucket文件夹前缀。
注意:此字段可能返回 null,表示取不到有效值。
示例值:prefix_
CosFileName String Cos 文件名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:testname

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 分辨率。

StreamName

流名称列表。

被如下接口引用:DescribeLiveStreamPublishedList。

名称 类型 描述
StreamName String 流名称。
示例值:test
AppName String 应用名称。
示例值:live
DomainName String 推流域名。
示例值:5000.livepush.myqcloud.com
StreamStartTime String 推流开始时间。
UTC格式时间,例如:2019-01-07T12:00:00Z。
示例值:2022-11-04T08:42:06Z
StreamEndTime String 推流结束时间。
UTC格式时间,例如:2019-01-07T15:00:00Z。
示例值:2022-11-04T09:10:58Z
StopReason String 停止原因。
示例值:推流客户端主动断流
Duration Integer 推流持续时长,单位:秒。
示例值:1732
ClientIp String 主播 IP。
示例值:127.0.0.1
Resolution String 分辨率。
示例值:640*360

StreamOnlineInfo

查询当前正在推流的信息

被如下接口引用:DescribeLiveStreamOnlineList。

名称 类型 描述
StreamName String 流名称。
示例值:test
PublishTimeList Array of PublishTime 推流时间列表
示例值:[{"PublishTime":"2022-07-11T08:56:36Z"}]
AppName String 应用名称。
示例值:live
DomainName String 推流域名。
示例值:5000.livepush.myqcloud.com
PushToDelay Integer 流是否推送到延播。
0 - 无延播,
1 - 有延播。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

TaskDurationInfo

拉流转推任务的时长分布信息

被如下接口引用:DescribePullTransformPushInfo。

名称 类型 描述
Time String 拉流转推任务的时间点
示例值:2021-05-21 00:00:00
Duration Integer 拉流转推任务的时长,单位为分钟
示例值:5

TaskStatusInfo

直播拉流任务状态信息。

被如下接口引用:DescribeLivePullStreamTaskStatus。

名称 类型 描述
FileUrl String 当前使用的源 URL。
示例值:http://live.push.com/live/stream.flv
LoopedTimes Integer 点播源任务的轮播次数。
示例值:2
OffsetTime Integer 点播源的播放偏移,单位:秒。
示例值:1500
ReportTime String 最新心跳上报时间。UTC时间,例如:
2022-02-11T10:00:00Z。
注意:UTC时间与北京时间相差八小时。
示例值:2022-02-11T10:00:00Z
RunStatus String 实际运行状态:
active - 活跃,
inactive - 不活跃。
示例值:active
FileDuration Integer 点播源的文件时长,单位:秒。
示例值:56000
NextFileUrl String 下一进度点播文件 URL。
示例值:http://vod.play.com/live/stream.flv

TemplateInfo

转码模板信息。

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

名称 类型 描述
Vcodec String 视频编码:h264/h265/origin,默认h264。

origin: 保持原始编码格式
示例值:h264
VideoBitrate Integer 视频码率。范围:0kbps - 8000kbps。
0为保持原始码率。
注: 转码模板有码率唯一要求,最终保存的码率可能与输入码率有所差别。
示例值:0
Acodec String 音频编码:aac,默认aac。
注意:当前该参数未生效,待后续支持!
示例值:aac
AudioBitrate Integer 音频码率。取值范围:0kbps - 500kbps。
默认0。
示例值:0
Width Integer 宽,默认0。
范围[0-3000]
数值必须是2的倍数,0是原始宽度
示例值:0
Height Integer 高,默认0。
范围[0-3000]
数值必须是2的倍数,0是原始宽度
示例值:0
Fps Integer 帧率,默认0。
范围0-60fps
示例值:0
Gop Integer 关键帧间隔,单位:秒。
默认原始的间隔
范围2-6
示例值:3
Rotate Integer 旋转角度,默认0。
可取值:0,90,180,270
示例值:0
Profile String 编码质量:
baseline/main/high。默认baseline
示例值:baseline
BitrateToOrig Integer 当设置的码率>原始码率时,是否以原始码率为准。
0:否, 1:是
默认 0。
示例值:0
HeightToOrig Integer 当设置的高度>原始高度时,是否以原始高度为准。
0:否, 1:是
默认 0。
示例值:0
FpsToOrig Integer 当设置的帧率>原始帧率时,是否以原始帧率为准。
0:否, 1:是
默认 0。
示例值:0
NeedVideo Integer 是否保留视频。0:否,1:是。
示例值:0
NeedAudio Integer 是否保留音频。0:否,1:是。
示例值:0
TemplateId Integer 模板 ID。
示例值:123
TemplateName String 模板名称。
示例值:xxx
Description String 模板描述。
AiTransCode Integer 是否是极速高清模板,0:否,1:是。默认0。
示例值:0
AdaptBitratePercent Float 极速高清视频码率压缩比。
极速高清目标码率=VideoBitrate * (1-AdaptBitratePercent)

取值范围:0.0到0.5
示例值:0.5
ShortEdgeAsHeight Integer 是否以短边作为高度,0:否,1:是。默认0。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
DRMType String DRM 加密类型,可选值:fairplay、normalaes、widevine。
注意:此字段可能返回 null,表示取不到有效值。
示例值:widevine
DRMTracks String DRM 加密项,多个用|分割,可选值:AUDIO、SD、HD、UHD1、UHD2,后四个为一组,同组中的内容只能选一个。
注意:此字段可能返回 null,表示取不到有效值。
示例值:AUDIO|UHD2

TimeShiftBillData

时移计费明细数据。

被如下接口引用:DescribeLiveTimeShiftBillInfoList。

名称 类型 描述
Domain String 推流域名。
示例值:"5000.playdomain.com"
Duration Float 时移文件时长,单位分钟。
示例值:3.25
StoragePeriod Float 时移配置天数,单位天。
示例值:1
Time String 时间点,格式: yyyy-mm-ddTHH:MM:SSZ。
示例值:2022-02-21T17:37:43+08:00
TotalDuration Float 时移总时长,单位分钟。
示例值:67.43

TimeShiftRecord

时移录制段。

被如下接口引用:DescribeTimeShiftRecordDetail。

名称 类型 描述
Sid String 时移录制会话标识。
StartTime Integer 录制会话开始时间,Unix 时间戳。
EndTime Integer 录制会话结束时间,Unix 时间戳。

TimeShiftStreamInfo

时移流。

被如下接口引用:DescribeTimeShiftStreamList。

名称 类型 描述
DomainGroup String 推流域名所属组。
注意:此字段可能返回 null,表示取不到有效值。
Domain String 推流域名。
AppName String 推流路径。
StreamName String 流名称。
StartTime Integer 流起始时间,Unix 时间戳。
EndTime Integer 截止查询时流结束时间,Unix 时间戳。
TransCodeId Integer 转码模板ID。
注意:此字段可能返回 null,表示取不到有效值。
StreamType Integer 流类型,取值0为原始流,1为水印流,2为转码流。
Duration Integer 时移数据存储时长,单位秒。
注意:此字段可能返回 null,表示取不到有效值。

TimeShiftTemplate

直播时移模板配置

被如下接口引用:DescribeLiveTimeShiftTemplates。

名称 类型 必选 描述
TemplateName String 模板名称。
示例值:test
Duration Integer 时移时长。
单位:秒。
示例值:6000
ItemDuration Integer 分片时长。
可取3-10。
单位:s。
默认值:5。
示例值:5
TemplateId Integer 模板id。
示例值:1
Description String 模板描述。
示例值:test
Area String 地域:
Mainland:中国大陆;
Overseas:海外及港澳台地区;
默认值:Mainland。
示例值:Mainland
RemoveWatermark Boolean 是否去除水印。
为true则将录制原始流。
默认值:false。
示例值:false
TranscodeTemplateIds Array of Integer 转码流id列表。
此参数仅在 RemoveWatermark为false时生效。
示例值:[1]

TimeValue

某个时间点的指标的数值是多少。

被如下接口引用:DescribeScreenShotSheetNumList。

名称 类型 描述
Time String UTC 时间,时间格式:yyyy-mm-ddTHH:MM:SSZ。
Num Integer 数值。

TranscodeDetailInfo

转码详细信息。

被如下接口引用:DescribeLiveTranscodeDetailInfo。

名称 类型 描述
StreamName String 流名称。
示例值:test
StartTime String 开始时间(北京时间),格式:yyyy-mm-dd HH:MM。
示例值:2019-03-01 01:00
EndTime String 结束时间(北京时间),格式:yyyy-mm-dd HH:MM。
示例值:2019-03-01 01:00
Duration Integer 转码时长,单位:分钟。
注意:因推流过程中可能有中断重推情况,此处时长为真实转码时长累加值,并非结束时间和开始时间的间隔。
示例值:8
ModuleCodec String 编码方式,带模块,
示例:
liveprocessor_ACC: 音频转码,
liveprocessor_H264:直播转码-H264,
liveprocessor_H265: 直播转码-H265,
topspeed_H264:极速高清-H264,
topspeed_H265:极速高清-H265。
示例值:liveprocessor_H265
Bitrate Integer 码率。
示例值:1
Type String 类型,包含:转码(Transcode),混流(MixStream),水印(WaterMark),快直播(Webrtc)。
示例值:Transcode
PushDomain String 推流域名。
示例值:5000.livepush.com
Resolution String 分辨率。
示例值:720p
MainlandOrOversea String 地域:
Mainland:国内。
Overseas:海外。
示例值:Mainland

TranscodeTaskNum

转码任务数。

被如下接口引用:DescribeTranscodeTaskNum。

名称 类型 描述
Time String 时间点。
示例值:2022-01-09 21:45
CodeRate Integer 码率。
示例值:2000
Num Integer 任务数。
示例值:1

TranscodeTotalInfo

转码总量数据

被如下接口引用:DescribeLiveTranscodeTotalInfo。

名称 类型 描述
Time String 时间点,
使用UTC格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2022-11-14T14:04:59+08:00
Duration Integer 转码时长,单位:分钟。
示例值:1
ModuleCodec String 编码方式,带模块,
示例:
liveprocessor_H264 =》直播转码-H264,
liveprocessor_H265 =》 直播转码-H265,
topspeed_H264 =》极速高清-H264,
topspeed_H265 =》极速高清-H265。
示例值:liveprocessor_H264
Resolution String 分辨率,
示例:540*480。
示例值:720P

WatermarkInfo

水印信息。

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

名称 类型 描述
WatermarkId Integer 水印 ID。
PictureUrl String 水印图片 URL。
XPosition Integer 显示位置,X 轴偏移。
YPosition Integer 显示位置,Y 轴偏移。
WatermarkName String 水印名称。
Status Integer 当前状态。0:未使用,1:使用中。
CreateTime String 添加时间。
注:此字段为北京时间(UTC+8时区)。
Width Integer 水印宽。
Height Integer 水印高。
BackgroundWidth Integer 背景水印宽。
BackgroundHeight Integer 背景水印高。

XP2PDetailInfo

P2P流信息。

被如下接口引用:DescribeLiveXP2PDetailInfoList。

名称 类型 描述
CdnBytes Integer CDN流量。
示例值:2825
P2pBytes Integer P2P流量。
示例值:4785
StuckPeople Integer 卡播人数。
示例值:23
StuckTimes Integer 卡播次数。
示例值:75
OnlinePeople Integer 在线人数。
示例值:28
Request Integer 起播请求次数
示例值:66
RequestSuccess Integer 起播成功次数
示例值:21
Time String 时间,一分钟粒度,utc格式:yyyy-mm-ddTHH:MM:SSZ,参考https://cloud.tencent.com/document/product/266/11732#I。。
示例值:2022-08-03T16:00:00Z
Type String 类型,分live和vod两种。
注意:此字段可能返回 null,表示取不到有效值。
示例值:live
StreamName String 流ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:7852921
AppId String AppId。
注意:此字段可能返回 null,表示取不到有效值。
示例值:appidtest