tencentcloud-sdk-nodejs 4.0.409 → 4.0.412

package/tencentcloud/services/live/v20180801/live_models.d.ts

@@ -1446,6 +1446,39 @@ export interface DescribeLiveRecordTemplateRequest {
       */
     TemplateId: number;
 }
+/**
+ * 监控播放数据
+ */
+export interface MonitorStreamPlayInfo {
+    /**
+      * 播放域名。
+      */
+    PlayDomain: string;
+    /**
+      * 流id。
+      */
+    StreamName: string;
+    /**
+      * 播放码率，0表示原始码率。
+      */
+    Rate: number;
+    /**
+      * 播放协议，可选值包括 Unknown，Flv，Hls，Rtmp，Huyap2p。
+      */
+    Protocol: string;
+    /**
+      * 带宽，单位是Mbps。
+      */
+    Bandwidth: number;
+    /**
+      * 在线人数，1分钟采样一个点，统计采样点的tcp链接数目。
+      */
+    Online: number;
+    /**
+      * 请求数。
+      */
+    Request: number;
+}
 /**
  * 查询当前正在推流的信息
  */
@@ -1662,32 +1695,76 @@ export interface LogInfo {
     FileSize: number;
 }
 /**
- * AddDelayLiveStream请求参数结构体
+ * 通用混流布局参数。
  */
-export interface AddDelayLiveStreamRequest {
+export interface CommonMixLayoutParams {
     /**
-      * 推流路径，与推流和播放地址中的 AppName 保持一致，默认为 live。
+      * 输入图层。取值范围[1，16]。
+1)背景流（即大主播画面或画布）的 image_layer 填1。
+2)纯音频混流，该参数也需填。
+注意：不同输入，该值不可重复
       */
-    AppName: string;
+    ImageLayer: number;
     /**
-      * 推流域名。
+      * 输入类型。取值范围[0，5]。
+不填默认为0。
+0表示输入流为音视频。
+2表示输入流为图片。
+3表示输入流为画布。
+4表示输入流为音频。
+5表示输入流为纯视频。
       */
-    DomainName: string;
+    InputType?: number;
     /**
-      * 流名称。
+      * 输入画面在输出时的高度。取值范围：
+像素：[0，2000]
+百分比：[0.01，0.99]
+不填默认为输入流的高度。
+使用百分比时，期望输出为（百分比 * 背景高）。
       */
-    StreamName: string;
+    ImageHeight?: number;
     /**
-      * 延播时间，单位：秒，上限：600秒。
+      * 输入画面在输出时的宽度。取值范围：
+像素：[0，2000]
+百分比：[0.01，0.99]
+不填默认为输入流的宽度。
+使用百分比时，期望输出为（百分比 * 背景宽）。
       */
-    DelayTime: number;
+    ImageWidth?: number;
     /**
-      * 延播设置的过期时间。UTC 格式，例如：2018-11-29T19:00:00Z。
-注意：
-1. 默认7天后过期，且最长支持7天内生效。
-2. 北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
+      * 输入在输出画面的X偏移。取值范围：
+像素：[0，2000]
+百分比：[0.01，0.99]
+不填默认为0。
+相对于大主播背景画面左上角的横向偏移。
+使用百分比时，期望输出为（百分比 * 背景宽）。
       */
-    ExpireTime?: string;
+    LocationX?: number;
+    /**
+      * 输入在输出画面的Y偏移。取值范围：
+像素：[0，2000]
+百分比：[0.01，0.99]
+不填默认为0。
+相对于大主播背景画面左上角的纵向偏移。
+使用百分比时，期望输出为（百分比 * 背景宽）
+      */
+    LocationY?: number;
+    /**
+      * 当InputType为3(画布)时，该值表示画布的颜色。
+常用的颜色有：
+红色：0xcc0033。
+黄色：0xcc9900。
+绿色：0xcccc33。
+蓝色：0x99CCFF。
+黑色：0x000000。
+白色：0xFFFFFF。
+灰色：0x999999。
+      */
+    Color?: string;
+    /**
+      * 当InputType为2(图片)时，该值是水印ID。
+      */
+    WatermarkId?: number;
 }
 /**
  * DescribeLiveDomainCert请求参数结构体
@@ -1986,105 +2063,22 @@ export interface TimeValue {
     Num: number;
 }
 /**
- * ModifyLivePullStreamTask请求参数结构体
+ * ModifyLiveDomainCertBindings返回参数结构体
  */
-export interface ModifyLivePullStreamTaskRequest {
-    /**
-      * 任务Id。
-      */
-    TaskId: string;
-    /**
-      * 操作人姓名。
-      */
-    Operator: string;
-    /**
-      * 拉流源url列表。
-SourceType为直播（PullLivePushLive）只可以填1个，
-SourceType为点播（PullVodPushLive）可以填多个，上限30个。
-      */
-    SourceUrls?: Array<string>;
-    /**
-      * 开始时间。
-使用UTC格式时间，
-例如：2019-01-08T10:00:00Z。
-注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
-      */
-    StartTime?: string;
-    /**
-      * 结束时间，注意：
-1. 结束时间必须大于开始时间；
-2. 结束时间和开始时间必须大于当前时间；
-3. 结束时间 和 开始时间 间隔必须小于七天。
-使用UTC格式时间，
-例如：2019-01-08T10:00:00Z。
-注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
-      */
-    EndTime?: string;
-    /**
-      * 点播拉流转推循环次数。
--1：无限循环，直到任务结束。
-0：不循环。
->0：具体循环次数。次数和时间以先结束的为准。
-注意：拉流源为点播，该配置生效。
-      */
-    VodLoopTimes?: number;
-    /**
-      * 点播更新SourceUrls后的播放方式：
-ImmediateNewSource：立即从更新的拉流源开始播放；
-ContinueBreakPoint：从上次断流url源的断点处继续，结束后再使用新的拉流源。
-注意：拉流源为点播，该配置生效。
-      */
-    VodRefreshType?: string;
-    /**
-      * 任务状态：
-enable - 启用，
-pause - 暂停。
-      */
-    Status?: string;
-    /**
-      * 选择需要回调的事件（不填则回调全部）：
-TaskStart：任务启动回调，
-TaskExit：任务停止回调，
-VodSourceFileStart：从点播源文件开始拉流回调，
-VodSourceFileFinish：从点播源文件拉流结束回调，
-ResetTaskConfig：任务更新回调。
-      */
-    CallbackEvents?: Array<string>;
-    /**
-      * 自定义回调地址。
-相关事件会回调到该地址。
-      */
-    CallbackUrl?: string;
-    /**
-      * 指定播放文件索引。
-注意： 从1开始，不大于SourceUrls中文件个数。
-      */
-    FileIndex?: number;
-    /**
-      * 指定播放文件偏移。
-注意：
-1. 单位：秒，配合FileIndex使用。
-      */
-    OffsetTime?: number;
+export interface ModifyLiveDomainCertBindingsResponse {
     /**
-      * 任务备注。
+      * DomainNames 入参中，与证书不匹配的域名列表，将会跳过处理。
       */
-    Comment?: string;
+    MismatchedDomainNames: Array<string>;
     /**
-      * 备源的类型：
-PullLivePushLive -直播，
-PullVodPushLive -点播。
-注意：
-1. 仅当主源类型为直播源时，备源才会生效。
-2. 主直播源拉流中断时，自动使用备源进行拉流。
-3. 如果备源为点播文件时，则每次轮播完点播文件就检查主源是否恢复，如果主源恢复则自动切回到主源，否则继续拉备源。
+      * 操作失败的域名及错误码，错误信息，包括MismatchedDomainNames中的域名。
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    BackupSourceType?: string;
+    Errors: Array<BatchDomainOperateErrors>;
     /**
-      * 备源 URL。
-只允许填一个备源 URL
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    BackupSourceUrl?: string;
+    RequestId?: string;
 }
 /**
  * 拉流配置。
@@ -2184,6 +2178,35 @@ export interface UpdateLiveWatermarkResponse {
       */
     RequestId?: string;
 }
+/**
+ * ModifyLiveDomainCertBindings请求参数结构体
+ */
+export interface ModifyLiveDomainCertBindingsRequest {
+    /**
+      * 要绑定证书的播放域名/状态 信息列表。
+如果CloudCertId和证书公钥私钥对均不传，且域名列表已有绑定规则，只批量更新域名https规则的启用状态，并把未上传至腾讯云ssl的已有自有证书上传。
+      */
+    DomainInfos: Array<LiveCertDomainInfo>;
+    /**
+      * 腾讯云ssl的证书Id。
+见 https://cloud.tencent.com/document/api/400/41665
+      */
+    CloudCertId?: string;
+    /**
+      * 证书公钥。
+CloudCertId和公钥私钥对二选一，若CloudCertId将会舍弃公钥和私钥参数，否则将自动先把公钥私钥对上传至ssl新建证书，并使用上传成功后返回的CloudCertId。
+      */
+    CertificatePublicKey?: string;
+    /**
+      * 证书私钥。
+CloudCertId和公钥私钥对二选一，若传CloudCertId将会舍弃公钥和私钥参数，否则将自动先把公钥私钥对上传至ssl新建证书，并使用上传成功后返回的CloudCertId。
+      */
+    CertificatePrivateKey?: string;
+    /**
+      * 上传至ssl证书中心的备注信息，只有新建证书时有效。传CloudCertId时会忽略。
+      */
+    CertificateAlias?: string;
+}
 /**
  * DescribeRecordTask请求参数结构体
  */
@@ -2295,17 +2318,20 @@ export interface BillAreaInfo {
     Countrys: Array<BillCountryInfo>;
 }
 /**
- * 流维度的播放信息。
+ * 用作批量绑定域名和证书。
  */
-export interface PlayDataInfoByStream {
+export interface LiveCertDomainInfo {
     /**
-      * 流名称。
+      * 域名。
       */
-    StreamName: string;
+    DomainName: string;
     /**
-      * 总流量，单位: MB。
+      * 是否启用域名的https规则。
+1：启用
+0：禁用
+-1：保持不变
       */
-    TotalFlux: number;
+    Status: number;
 }
 /**
  * DescribeVisitTopSumInfoList请求参数结构体
@@ -2396,6 +2422,23 @@ export interface CancelCommonMixStreamResponse {
       */
     RequestId?: string;
 }
+/**
+ * DescribeLiveDomainCertBindings返回参数结构体
+ */
+export interface DescribeLiveDomainCertBindingsResponse {
+    /**
+      * 有绑定证书的域名信息数组。
+      */
+    LiveDomainCertBindings: Array<LiveDomainCertBindings>;
+    /**
+      * 总的记录行数，便于分页。
+      */
+    TotalNum: number;
+    /**
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      */
+    RequestId?: string;
+}
 /**
  * DescribeConcurrentRecordStreamNum返回参数结构体
  */
@@ -2603,6 +2646,19 @@ export interface DescribeScreenshotTaskRequest {
       */
     ScrollToken?: string;
 }
+/**
+ * 流维度的播放信息。
+ */
+export interface PlayDataInfoByStream {
+    /**
+      * 流名称。
+      */
+    StreamName: string;
+    /**
+      * 总流量，单位: MB。
+      */
+    TotalFlux: number;
+}
 /**
  * DescribeCallbackRecordsList请求参数结构体
  */
@@ -3128,76 +3184,32 @@ export interface PushDataInfo {
     MetaFps: number;
 }
 /**
- * 通用混流布局参数。
+ * AddDelayLiveStream请求参数结构体
  */
-export interface CommonMixLayoutParams {
-    /**
-      * 输入图层。取值范围[1，16]。
-1)背景流（即大主播画面或画布）的 image_layer 填1。
-2)纯音频混流，该参数也需填。
-注意：不同输入，该值不可重复
-      */
-    ImageLayer: number;
-    /**
-      * 输入类型。取值范围[0，5]。
-不填默认为0。
-0表示输入流为音视频。
-2表示输入流为图片。
-3表示输入流为画布。
-4表示输入流为音频。
-5表示输入流为纯视频。
-      */
-    InputType?: number;
-    /**
-      * 输入画面在输出时的高度。取值范围：
-像素：[0，2000]
-百分比：[0.01，0.99]
-不填默认为输入流的高度。
-使用百分比时，期望输出为（百分比 * 背景高）。
-      */
-    ImageHeight?: number;
+export interface AddDelayLiveStreamRequest {
     /**
-      * 输入画面在输出时的宽度。取值范围：
-像素：[0，2000]
-百分比：[0.01，0.99]
-不填默认为输入流的宽度。
-使用百分比时，期望输出为（百分比 * 背景宽）。
+      * 推流路径，与推流和播放地址中的 AppName 保持一致，默认为 live。
       */
-    ImageWidth?: number;
+    AppName: string;
     /**
-      * 输入在输出画面的X偏移。取值范围：
-像素：[0，2000]
-百分比：[0.01，0.99]
-不填默认为0。
-相对于大主播背景画面左上角的横向偏移。
-使用百分比时，期望输出为（百分比 * 背景宽）。
+      * 推流域名。
       */
-    LocationX?: number;
+    DomainName: string;
     /**
-      * 输入在输出画面的Y偏移。取值范围：
-像素：[0，2000]
-百分比：[0.01，0.99]
-不填默认为0。
-相对于大主播背景画面左上角的纵向偏移。
-使用百分比时，期望输出为（百分比 * 背景宽）
+      * 流名称。
       */
-    LocationY?: number;
+    StreamName: string;
     /**
-      * 当InputType为3(画布)时，该值表示画布的颜色。
-常用的颜色有：
-红色：0xcc0033。
-黄色：0xcc9900。
-绿色：0xcccc33。
-蓝色：0x99CCFF。
-黑色：0x000000。
-白色：0xFFFFFF。
-灰色：0x999999。
+      * 延播时间，单位：秒，上限：600秒。
       */
-    Color?: string;
+    DelayTime: number;
     /**
-      * 当InputType为2(图片)时，该值是水印ID。
+      * 延播设置的过期时间。UTC 格式，例如：2018-11-29T19:00:00Z。
+注意：
+1. 默认7天后过期，且最长支持7天内生效。
+2. 北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
       */
-    WatermarkId?: number;
+    ExpireTime?: string;
 }
 /**
  * DescribeGroupProIspPlayInfoList请求参数结构体
@@ -4269,37 +4281,105 @@ export interface ModifyLiveTranscodeTemplateResponse {
     RequestId?: string;
 }
 /**
- * 监控播放数据
+ * ModifyLivePullStreamTask请求参数结构体
  */
-export interface MonitorStreamPlayInfo {
+export interface ModifyLivePullStreamTaskRequest {
     /**
-      * 播放域名。
+      * 任务Id。
       */
-    PlayDomain: string;
+    TaskId: string;
     /**
-      * 流id。
+      * 操作人姓名。
       */
-    StreamName: string;
+    Operator: string;
     /**
-      * 播放码率，0表示原始码率。
+      * 拉流源url列表。
+SourceType为直播（PullLivePushLive）只可以填1个，
+SourceType为点播（PullVodPushLive）可以填多个，上限30个。
       */
-    Rate: number;
+    SourceUrls?: Array<string>;
     /**
-      * 播放协议，可选值包括 Unknown，Flv，Hls，Rtmp，Huyap2p。
+      * 开始时间。
+使用UTC格式时间，
+例如：2019-01-08T10:00:00Z。
+注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
       */
-    Protocol: string;
+    StartTime?: string;
     /**
-      * 带宽，单位是Mbps。
+      * 结束时间，注意：
+1. 结束时间必须大于开始时间；
+2. 结束时间和开始时间必须大于当前时间；
+3. 结束时间 和 开始时间 间隔必须小于七天。
+使用UTC格式时间，
+例如：2019-01-08T10:00:00Z。
+注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
       */
-    Bandwidth: number;
+    EndTime?: string;
     /**
-      * 在线人数，1分钟采样一个点，统计采样点的tcp链接数目。
+      * 点播拉流转推循环次数。
+-1：无限循环，直到任务结束。
+0：不循环。
+>0：具体循环次数。次数和时间以先结束的为准。
+注意：拉流源为点播，该配置生效。
       */
-    Online: number;
+    VodLoopTimes?: number;
     /**
-      * 请求数。
+      * 点播更新SourceUrls后的播放方式：
+ImmediateNewSource：立即从更新的拉流源开始播放；
+ContinueBreakPoint：从上次断流url源的断点处继续，结束后再使用新的拉流源。
+注意：拉流源为点播，该配置生效。
       */
-    Request: number;
+    VodRefreshType?: string;
+    /**
+      * 任务状态：
+enable - 启用，
+pause - 暂停。
+      */
+    Status?: string;
+    /**
+      * 选择需要回调的事件（不填则回调全部）：
+TaskStart：任务启动回调，
+TaskExit：任务停止回调，
+VodSourceFileStart：从点播源文件开始拉流回调，
+VodSourceFileFinish：从点播源文件拉流结束回调，
+ResetTaskConfig：任务更新回调。
+      */
+    CallbackEvents?: Array<string>;
+    /**
+      * 自定义回调地址。
+相关事件会回调到该地址。
+      */
+    CallbackUrl?: string;
+    /**
+      * 指定播放文件索引。
+注意： 从1开始，不大于SourceUrls中文件个数。
+      */
+    FileIndex?: number;
+    /**
+      * 指定播放文件偏移。
+注意：
+1. 单位：秒，配合FileIndex使用。
+      */
+    OffsetTime?: number;
+    /**
+      * 任务备注。
+      */
+    Comment?: string;
+    /**
+      * 备源的类型：
+PullLivePushLive -直播，
+PullVodPushLive -点播。
+注意：
+1. 仅当主源类型为直播源时，备源才会生效。
+2. 主直播源拉流中断时，自动使用备源进行拉流。
+3. 如果备源为点播文件时，则每次轮播完点播文件就检查主源是否恢复，如果主源恢复则自动切回到主源，否则继续拉备源。
+      */
+    BackupSourceType?: string;
+    /**
+      * 备源 URL。
+只允许填一个备源 URL
+      */
+    BackupSourceUrl?: string;
 }
 /**
  * DescribePlayErrorCodeSumInfoList请求参数结构体
@@ -4991,6 +5071,23 @@ export interface CreateLiveRecordTemplateResponse {
       */
     RequestId?: string;
 }
+/**
+ * 某省份某运营商在某段时间内的带宽，流量，请求数和并发数
+ */
+export interface GroupProIspDataInfo {
+    /**
+      * 省份。
+      */
+    ProvinceName: string;
+    /**
+      * 运营商。
+      */
+    IspName: string;
+    /**
+      * 分钟维度的明细数据。
+      */
+    DetailInfoList: Array<CdnPlayStatData>;
+}
 /**
  * 录制模板参数。
  */
@@ -5447,6 +5544,23 @@ export interface PlayAuthKeyInfo {
       */
     AuthBackKey: string;
 }
+/**
+ * 批量操作域名相关接口，若其中个别域名操作失败将会跳过，相应的域名错误信息将统一汇总在此类型中
+ */
+export interface BatchDomainOperateErrors {
+    /**
+      * 操作失败的域名。
+      */
+    DomainName: string;
+    /**
+      * API3.0错误码。
+      */
+    Code: string;
+    /**
+      * API3.0错误信息。
+      */
+    Message: string;
+}
 /**
  * ModifyLiveTranscodeTemplate请求参数结构体
  */
@@ -5975,6 +6089,48 @@ export interface DescribeLiveSnapshotTemplateRequest {
       */
     TemplateId: number;
 }
+/**
+ * DescribeLiveDomainCertBindings, DescribeLiveDomainCertBindingsGray接口返回的域名证书信息
+ */
+export interface LiveDomainCertBindings {
+    /**
+      * 域名。
+      */
+    DomainName: string;
+    /**
+      * 证书备注。与CertName同义。
+      */
+    CertificateAlias: string;
+    /**
+      * 证书类型。
+0：自有证书
+1：腾讯云ssl托管证书
+      */
+    CertType: number;
+    /**
+      * https状态。
+1：已开启。
+0：已关闭。
+      */
+    Status: number;
+    /**
+      * 证书过期时间。
+      */
+    CertExpireTime: string;
+    /**
+      * 证书Id。
+      */
+    CertId: number;
+    /**
+      * 腾讯云ssl的证书Id。
+      */
+    CloudCertId: string;
+    /**
+      * 规则最后更新时间。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    UpdateTime: string;
+}
 /**
  * CreateCommonMixStream返回参数结构体
  */
@@ -6681,21 +6837,32 @@ export interface ResumeDelayLiveStreamResponse {
     RequestId?: string;
 }
 /**
- * 某省份某运营商在某段时间内的带宽，流量，请求数和并发数
+ * DescribeLiveDomainCertBindings请求参数结构体
  */
-export interface GroupProIspDataInfo {
+export interface DescribeLiveDomainCertBindingsRequest {
     /**
-      * 省份。
+      * 要搜索的域名字符串。
       */
-    ProvinceName: string;
+    DomainSearch?: string;
     /**
-      * 运营商。
+      * 记录行的位置，从0开始。默认0。
       */
-    IspName: string;
+    Offset?: number;
     /**
-      * 分钟维度的明细数据。
+      * 记录行的最大数目。默认50。
+若不传，则最多返回50条数据。
       */
-    DetailInfoList: Array<CdnPlayStatData>;
+    Length?: number;
+    /**
+      * 要查询的单个域名。
+      */
+    DomainName?: string;
+    /**
+      * 可取值：
+ExpireTimeAsc：证书过期时间升序。
+ExpireTimeDesc：证书过期时间降序。
+      */
+    OrderBy?: string;
 }
 /**
  * DeleteLiveDomain返回参数结构体