tccli 3.0.1237.1__py2.py3-none-any.whl → 3.0.1239.1__py2.py3-none-any.whl

tccli/services/live/v20180801/api.json

@@ -1247,7 +1247,7 @@
       "status": "online"
     },
     "ModifyPullStreamConfig": {
-      "document": "更新拉流配置。该接口为已下线接口，请使用新接口 ModifyLivePullStreamTask。 ",
+      "document": "更新拉流配置。该接口为已下线接口，请使用新接口 ModifyLivePullStreamTask。",
       "input": "ModifyPullStreamConfigRequest",
       "name": "更新拉流配置(该接口已下线,请使用新接口 ModifyLivePullStreamTask)",
       "output": "ModifyPullStreamConfigResponse",
@@ -1379,7 +1379,7 @@
         {
           "disabled": false,
           "document": "导播台ID。",
-          "example": "1234",
+          "example": "63501",
           "member": "uint64",
           "name": "CasterId",
           "required": true,
@@ -1435,7 +1435,7 @@
         {
           "disabled": false,
           "document": "导播台ID",
-          "example": "1234",
+          "example": "63501",
           "member": "uint64",
           "name": "CasterId",
           "required": true,
@@ -1471,7 +1471,7 @@
         {
           "disabled": false,
           "document": "导播台ID",
-          "example": "1234",
+          "example": "63501",
           "member": "uint64",
           "name": "CasterId",
           "required": true,
@@ -1507,7 +1507,7 @@
         {
           "disabled": false,
           "document": "导播台ID。",
-          "example": "1234",
+          "example": "63501",
           "member": "uint64",
           "name": "CasterId",
           "required": true,
@@ -1543,7 +1543,7 @@
         {
           "disabled": false,
           "document": "导播台ID",
-          "example": "1234",
+          "example": "63501",
           "member": "uint64",
           "name": "CasterId",
           "required": true,
@@ -3916,7 +3916,7 @@
         {
           "disabled": false,
           "document": "源导播台的ID",
-          "example": "1234",
+          "example": "63501",
           "member": "uint64",
           "name": "CasterId",
           "required": true,
@@ -3949,7 +3949,7 @@
         {
           "disabled": false,
           "document": "复制生成的导播台ID",
-          "example": "1235",
+          "example": "63502",
           "member": "uint64",
           "name": "CasterId",
           "output_required": true,
@@ -4026,7 +4026,7 @@
         {
           "disabled": false,
           "document": "导播台ID。",
-          "example": "1234",
+          "example": "63501",
           "member": "uint64",
           "name": "CasterId",
           "required": true,
@@ -4050,13 +4050,13 @@
         },
         {
           "disabled": false,
-          "document": "注：该字段已废弃，请结合腾讯云直播播放地址生成策略生成cdn播放地址\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "注：该字段已废弃，请结合腾讯云直播播放地址生成策略生成cdn播放地址",
           "example": "https://example.cdn.com/live/example_stream_id",
           "member": "string",
           "name": "CdnPlayUrl",
           "output_required": true,
           "type": "string",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
@@ -4102,7 +4102,7 @@
         {
           "disabled": false,
           "document": "导播台ID。",
-          "example": "1234",
+          "example": "63501",
           "member": "uint64",
           "name": "CasterId",
           "required": true,
@@ -4116,43 +4116,43 @@
       "members": [
         {
           "disabled": false,
-          "document": "主监任务的rtmp协议预览地址。\n注：该地址仅供预览，不可分发。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "主监任务的rtmp协议预览地址。\n注：该地址仅供预览，不可分发。",
           "example": "rtmp://www.example.com/live/example_stream_id",
           "member": "string",
           "name": "PgmPlayUrl",
           "output_required": true,
           "type": "string",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "注：该字段已废弃，请结合腾讯云直播播放地址生成策略生成cdn播放地址。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "注：该字段已废弃，请结合腾讯云直播播放地址生成策略生成cdn播放地址。",
           "example": "https://example.cdn.com/live/example_stream_id",
           "member": "string",
           "name": "CdnPlayUrl",
           "output_required": true,
           "type": "string",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "主监任务在腾讯云直播侧的流ID。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "主监任务在腾讯云直播侧的流ID。",
           "example": "example_stream_id",
           "member": "string",
           "name": "CdnStreamId",
           "output_required": true,
           "type": "string",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "主监任务的webrtc协议播放地址。\n注：\n1. 该预览地址仅作为预览，不可分发。\n2. webrtc播放地址需配合腾讯云快直播播放sdk使用。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "主监任务的webrtc协议播放地址。\n注：\n1. 该预览地址仅作为预览，不可分发。\n2. webrtc播放地址需配合腾讯云快直播播放sdk使用。",
           "example": "webrtc://webrtc.domain.com/live/example_stream",
           "member": "string",
           "name": "PgmWebRTCPlayUrl",
           "output_required": true,
           "type": "string",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
@@ -4178,7 +4178,7 @@
         {
           "disabled": false,
           "document": "导播台ID。",
-          "example": "1234",
+          "example": "63501",
           "member": "uint64",
           "name": "CasterId",
           "required": true,
@@ -4225,7 +4225,7 @@
         {
           "disabled": false,
           "document": "导播台名称",
-          "example": "test",
+          "example": "example",
           "member": "string",
           "name": "CasterName",
           "required": false,
@@ -4234,7 +4234,7 @@
         {
           "disabled": false,
           "document": "导播台的描述\n最大允许长度256",
-          "example": "test_caster",
+          "example": "example_caster",
           "member": "string",
           "name": "Description",
           "required": false,
@@ -4330,7 +4330,7 @@
         {
           "disabled": false,
           "document": "导播台ID",
-          "example": "10",
+          "example": "63501",
           "member": "uint64",
           "name": "CasterId",
           "output_required": true,
@@ -4804,7 +4804,7 @@
         {
           "disabled": false,
           "document": "推流参数。\n推流时携带自定义参数。\n示例：\nbak=1&test=2 。",
-          "example": "无",
+          "example": "bak=1&room=2",
           "member": "string",
           "name": "PushArgs",
           "required": false,
@@ -4813,7 +4813,7 @@
         {
           "disabled": false,
           "document": "选择需要回调的事件（不填则回调全部）：\nTaskStart：任务启动回调，\nTaskExit：任务停止回调，\nVodSourceFileStart：从点播源文件开始拉流回调，\nVodSourceFileFinish：从点播源文件拉流结束回调，\nResetTaskConfig：任务更新回调。\n\nTaskAlarm: 用于告警事件通知，AlarmType 示例:\nPullFileUnstable - 文件拉取不稳定，\nPushStreamUnstable - 推流不稳定，\nPullFileFailed - 文件拉取出错，\nPushStreamFailed - 推流出现失败，\nFileEndEarly - 文件提前结束。",
-          "example": "无",
+          "example": "[\"PushStreamFailed\"]",
           "member": "string",
           "name": "CallbackEvents",
           "required": false,
@@ -4840,7 +4840,7 @@
         {
           "disabled": false,
           "document": "自定义回调地址。\n拉流转推任务相关事件会回调到该地址。\n回调事件使用方法请查看：\nhttps://cloud.tencent.com/document/product/267/32744\nhttps://cloud.tencent.com/document/product/267/56208",
-          "example": "无",
+          "example": "http://my.callback.rcv/lvb/interface.php",
           "member": "string",
           "name": "CallbackUrl",
           "required": false,
@@ -4849,7 +4849,7 @@
         {
           "disabled": false,
           "document": "其他参数。\n示例: ignore_region  用于忽略传入地域, 内部按负载分配。",
-          "example": "无",
+          "example": "ignore_region",
           "member": "string",
           "name": "ExtraCmd",
           "required": false,
@@ -4858,7 +4858,7 @@
         {
           "disabled": false,
           "document": "自定义任务 ID。\n注：\n1. 该自定义 ID 为可选参数，如果传入，请确保该账号下传入的 ID 唯一。\n2. 该自定义 ID 用于防止重复发起请求时产生重复任务。后面也可以用 SpecifyTaskId 来修改或删除任务。",
-          "example": "无",
+          "example": "sfvdfsdfserfsdff",
           "member": "string",
           "name": "SpecifyTaskId",
           "required": false,
@@ -4876,12 +4876,30 @@
         {
           "disabled": false,
           "document": "完整目标 URL 地址。\n用法注意：如果使用该参数来传完整目标地址，则 DomainName, AppName, StreamName 需要传入空字符串，任务将会使用该 ToUrl 参数指定的目标地址。\n\n使用该方式传入目标地址支持的协议有：\nrtmp、rtmps、rtsp、rtp、srt。\n\n注意：签名时间需要超过任务结束时间，避免因签名过期造成任务失败。",
-          "example": "无",
+          "example": "rtmp://5000.livepush.myqcloud.com/live/myroom?txSecret=0065e4ef55825ab5883e2771a91017bd&txTime=687bfb41",
           "member": "string",
           "name": "ToUrl",
           "required": false,
           "type": "string"
         },
+        {
+          "disabled": false,
+          "document": "指定播放文件索引。\n注意： 1. 从1开始，不大于SourceUrls中文件个数。\n2. 该偏移仅在首次轮播时有效。\n3. 提前创建的任务指定的偏移最长有效期为24小时，24小时后未开始的任务偏移失效。",
+          "example": "0",
+          "member": "int64",
+          "name": "FileIndex",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "指定播放文件偏移。\n注意：\n1. 单位：秒，配合FileIndex使用。",
+          "example": "0",
+          "member": "int64",
+          "name": "OffsetTime",
+          "required": false,
+          "type": "int"
+        },
         {
           "disabled": false,
           "document": "备源的类型：\nPullLivePushLive -直播，\nPullVodPushLive -点播。\n注意：\n1. 仅当主源类型为直播源时，备源才会生效。\n2. 主直播源拉流中断时，自动使用备源进行拉流。\n3. 如果备源为点播文件时，则每次轮播完点播文件就检查主源是否恢复，如果主源恢复则自动切回到主源，否则继续拉备源。",
@@ -4921,7 +4939,7 @@
         {
           "disabled": false,
           "document": "录制模板 ID。",
-          "example": "无",
+          "example": "19342",
           "member": "string",
           "name": "RecordTemplateId",
           "required": false,
@@ -4930,7 +4948,7 @@
         {
           "disabled": false,
           "document": "新的目标地址，用于任务同时推两路场景。",
-          "example": "无",
+          "example": "rtmp://5000.livepush.myqcloud.com/live/mybackroom?txSecret=58deaf30f95a7a134c7f0d8512e90b14&txTime=687bfb1d",
           "member": "string",
           "name": "BackupToUrl",
           "required": false,
@@ -4954,7 +4972,7 @@
         {
           "disabled": false,
           "document": "任务 Id 。",
-          "example": "无",
+          "example": "940323",
           "member": "string",
           "name": "TaskId",
           "output_required": true,
@@ -6147,10 +6165,10 @@
         {
           "disabled": false,
           "document": "配置成功后的 ID。",
-          "example": "123",
+          "example": "965231",
           "member": "string",
           "name": "ConfigId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -6888,7 +6906,7 @@
         {
           "disabled": false,
           "document": "任务 Id。",
-          "example": "123",
+          "example": "9564231",
           "member": "string",
           "name": "TaskId",
           "required": true,
@@ -6906,7 +6924,7 @@
         {
           "disabled": false,
           "document": "指定任务 ID。注意：用于删除使用自定义任务 ID 创建的任务。",
-          "example": "test",
+          "example": "myspecifytaskid",
           "member": "string",
           "name": "SpecifyTaskId",
           "required": false,
@@ -6933,7 +6951,7 @@
         {
           "disabled": false,
           "document": "流名称。",
-          "example": "",
+          "example": "stream1",
           "member": "string",
           "name": "StreamName",
           "required": true,
@@ -6942,7 +6960,7 @@
         {
           "disabled": false,
           "document": "任务ID，由CreateLiveRecord接口返回。",
-          "example": "",
+          "example": "5621442",
           "member": "int64",
           "name": "TaskId",
           "required": true,
@@ -7365,7 +7383,7 @@
         {
           "disabled": false,
           "document": "配置 ID。\n1. 在添加拉流配置接口 [CreatePullStreamConfig](/document/api/267/30159) 调用返回值中获取配置 ID。\n2. 可以从接口 [DescribePullStreamConfigs](/document/api/267/30158) 中查询已创建过的拉流配置列表。",
-          "example": "123",
+          "example": "9485234",
           "member": "string",
           "name": "ConfigId",
           "required": true,
@@ -7571,13 +7589,13 @@
       "members": [
         {
           "disabled": false,
-          "document": "主备流分组信息列表。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "主备流分组信息列表。",
           "example": "无",
           "member": "BackupStreamGroupInfo",
           "name": "StreamInfoList",
           "output_required": true,
           "type": "list",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
@@ -7753,7 +7771,7 @@
         {
           "disabled": false,
           "document": "流名称，精确匹配。",
-          "example": "test",
+          "example": "stream1",
           "member": "string",
           "name": "StreamName",
           "required": true,
@@ -9228,7 +9246,7 @@
         {
           "disabled": false,
           "document": "分辨率，如果不填则默认查全部的数据。",
-          "example": "无",
+          "example": "[\"1080P\"]",
           "member": "string",
           "name": "Resolution",
           "required": false,
@@ -9237,7 +9255,7 @@
         {
           "disabled": false,
           "document": "帧率，如果不填则默认查全部的数据。",
-          "example": "无",
+          "example": "[\"30\"]",
           "member": "string",
           "name": "Fps",
           "required": false,
@@ -9516,13 +9534,13 @@
       "members": [
         {
           "disabled": false,
-          "document": "当前正在拉取垫片的流名称列表。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "当前正在拉取垫片的流名称列表。",
           "example": "[\"test1\",\"test2\"]",
           "member": "string",
           "name": "StreamNameList",
           "output_required": false,
           "type": "list",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
@@ -9666,7 +9684,7 @@
         {
           "disabled": false,
           "document": "任务 ID。",
-          "example": "12345",
+          "example": "965421",
           "member": "string",
           "name": "TaskId",
           "required": true,
@@ -9684,7 +9702,7 @@
           "example": "无",
           "member": "TaskStatusInfo",
           "name": "TaskStatusInfo",
-          "required": true,
+          "output_required": true,
           "type": "object",
           "value_allowed_null": false
         },
@@ -10459,7 +10477,7 @@
         {
           "disabled": false,
           "document": "流名称，支持模糊匹配。",
-          "example": "test",
+          "example": "myroomname",
           "member": "string",
           "name": "StreamName",
           "required": false,
@@ -10712,7 +10730,7 @@
         {
           "disabled": false,
           "document": "推流域名列表，若不传递此参数，则表示查询总体数据。",
-          "example": "[\"5000.playdomain.com\"]",
+          "example": "[\"5000.pushdomain.com\"]",
           "member": "string",
           "name": "PushDomains",
           "required": false,
@@ -10821,7 +10839,7 @@
         {
           "disabled": false,
           "document": "域名。",
-          "example": "无",
+          "example": "[\"5000.livepull.stream.com\"]",
           "member": "string",
           "name": "DomainNames",
           "required": false,
@@ -10839,7 +10857,7 @@
         {
           "disabled": false,
           "document": "时移天数。",
-          "example": "5",
+          "example": "[1,3,7,15,30]",
           "member": "int64",
           "name": "StorageDays",
           "required": false,
@@ -11186,13 +11204,13 @@
       "members": [
         {
           "disabled": false,
-          "document": "统计数据列表。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "统计数据列表。",
           "example": "无",
           "member": "TranscodeTotalInfo",
           "name": "DataInfoList",
           "output_required": true,
           "type": "list",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
@@ -12814,7 +12832,7 @@
         {
           "disabled": false,
           "document": "流名称。",
-          "example": "abcd",
+          "example": "stream1",
           "member": "string",
           "name": "StreamName",
           "required": true,
@@ -12841,7 +12859,7 @@
         {
           "disabled": false,
           "document": "推流域名。",
-          "example": "abc",
+          "example": "5000.livepush.com",
           "member": "string",
           "name": "PushDomain",
           "required": false,
@@ -12850,7 +12868,7 @@
         {
           "disabled": false,
           "document": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。",
-          "example": "abc",
+          "example": "live",
           "member": "string",
           "name": "AppName",
           "required": false,
@@ -15841,7 +15859,7 @@
         {
           "disabled": false,
           "document": "任务Id。",
-          "example": "123",
+          "example": "965454",
           "member": "string",
           "name": "TaskId",
           "required": true,
@@ -15913,7 +15931,7 @@
         {
           "disabled": false,
           "document": "选择需要回调的事件（不填则回调全部）：\nTaskStart：任务启动回调，\nTaskExit：任务停止回调，\nVodSourceFileStart：从点播源文件开始拉流回调，\nVodSourceFileFinish：从点播源文件拉流结束回调，\nResetTaskConfig：任务更新回调。",
-          "example": "无",
+          "example": "[\"TaskStart\"]",
           "member": "string",
           "name": "CallbackEvents",
           "required": false,
@@ -16012,7 +16030,7 @@
         {
           "disabled": false,
           "document": "新的目标地址。传空值，则取消该地址的推流。\n传入新值，则替换原有地址。",
-          "example": "无",
+          "example": "rtmp://5000.livepush.myqcloud.com/live/mybackroom?txSecret=58deaf30f95a7a134c7f0d8512e90b45&txTime=687bfb2d",
           "member": "string",
           "name": "BackupToUrl",
           "required": false,
@@ -16795,7 +16813,7 @@
         {
           "disabled": false,
           "document": "配置 ID。\n获取来源：\n1. 创建拉流配置接口CreatePullStreamConfig返回的配置 ID。\n2. 通过查询接口DescribePullStreamConfigs获取配置 ID。",
-          "example": "123",
+          "example": "9542135",
           "member": "string",
           "name": "ConfigId",
           "required": true,
@@ -18852,7 +18870,7 @@
         {
           "disabled": false,
           "document": "任务 Id。",
-          "example": "123",
+          "example": "965421",
           "member": "string",
           "name": "TaskId",
           "required": true,
@@ -18951,7 +18969,7 @@
         {
           "disabled": false,
           "document": "流名称。",
-          "example": "test",
+          "example": "mystreamname",
           "member": "string",
           "name": "StreamName",
           "required": true,
@@ -19387,13 +19405,13 @@
       "members": [
         {
           "disabled": false,
-          "document": "处理结果信息。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "处理结果信息。",
           "example": "no match processor stream",
           "member": "string",
           "name": "ResultMessage",
           "output_required": false,
           "type": "string",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
@@ -19410,7 +19428,7 @@
         {
           "disabled": false,
           "document": "流名称。",
-          "example": "",
+          "example": "stream1",
           "member": "string",
           "name": "StreamName",
           "required": true,
@@ -19419,7 +19437,7 @@
         {
           "disabled": false,
           "document": "任务ID，由CreateLiveRecord接口返回。",
-          "example": "",
+          "example": "562134",
           "member": "int64",
           "name": "TaskId",
           "required": true,
@@ -19793,7 +19811,7 @@
         {
           "disabled": false,
           "document": "流名称。",
-          "example": "test",
+          "example": "stream1",
           "member": "string",
           "name": "StreamName",
           "required": true,