diff --git a/CHANGELOG.md b/CHANGELOG.md index 88d3ce9498..e333a5f12c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,76 @@ +# Release 3.0.1082.1 + +## 主机安全(cwp) 版本:2018-02-28 + +### 第 109 次发布 + +发布时间:2024-03-22 01:11:57 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [DescribeBanStatus](https://cloud.tencent.com/document/api/296/60944) + + * 新增出参:OpenSmartMode + +* [ModifyBanStatus](https://cloud.tencent.com/document/api/296/60942) + + * 新增入参:OpenSmartMode + + +修改数据结构: + +* [BruteAttackInfo](https://cloud.tencent.com/document/api/296/19867#BruteAttackInfo) + + * 新增成员:AttackStatusDesc, BanExpiredTime + + + + +## 高性能应用服务(hai) 版本:2023-08-12 + +### 第 7 次发布 + +发布时间:2024-03-22 01:16:13 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [Instance](https://cloud.tencent.com/document/api/1721/101518#Instance) + + * 新增成员:OSType + + + + +## 实时音视频(trtc) 版本:2019-07-22 + +### 第 67 次发布 + +发布时间:2024-03-22 01:25:05 + +本次发布包含了以下内容: + +改善已有的文档。 + +新增接口: + +* [DescribeWebRecord](https://cloud.tencent.com/document/api/647/104542) +* [StartWebRecord](https://cloud.tencent.com/document/api/647/104541) +* [StopWebRecord](https://cloud.tencent.com/document/api/647/104540) + +新增数据结构: + +* [WebRecordVideoParams](https://cloud.tencent.com/document/api/647/44055#WebRecordVideoParams) + + + # Release 3.0.1081.1 ## 云硬盘(cbs) 版本:2017-03-12 diff --git a/SERVICE_CHANGELOG.md b/SERVICE_CHANGELOG.md index 435e4bb498..288a6a73b3 100644 --- a/SERVICE_CHANGELOG.md +++ b/SERVICE_CHANGELOG.md @@ -1,10 +1,10 @@ # 本版本更新包含以下内容: -## 云硬盘(cbs) 版本:2017-03-12 +## 主机安全(cwp) 版本:2018-02-28 -### 第 54 次发布 +### 第 109 次发布 -发布时间:2024-03-21 01:09:20 +发布时间:2024-03-22 01:11:57 本次发布包含了以下内容: @@ -12,91 +12,62 @@ 修改接口: -* [ModifyDisksRenewFlag](https://cloud.tencent.com/document/api/362/15668) - - * 新增入参:AutoRenewPeriod - - - - -## 数据湖计算 DLC(dlc) 版本:2021-01-25 +* [DescribeBanStatus](https://cloud.tencent.com/document/api/296/60944) -### 第 82 次发布 + * 新增出参:OpenSmartMode -发布时间:2024-03-21 01:14:28 +* [ModifyBanStatus](https://cloud.tencent.com/document/api/296/60942) -本次发布包含了以下内容: + * 新增入参:OpenSmartMode -改善已有的文档。 修改数据结构: -* [DataEngineInfo](https://cloud.tencent.com/document/api/1342/53778#DataEngineInfo) +* [BruteAttackInfo](https://cloud.tencent.com/document/api/296/19867#BruteAttackInfo) - * 新增成员:EngineNetworkId + * 新增成员:AttackStatusDesc, BanExpiredTime -## 实时互动-教育版(lcic) 版本:2022-08-17 +## 高性能应用服务(hai) 版本:2023-08-12 -### 第 54 次发布 +### 第 7 次发布 -发布时间:2024-03-21 01:19:23 +发布时间:2024-03-22 01:16:13 本次发布包含了以下内容: 改善已有的文档。 -修改接口: - -* [CreateRoom](https://cloud.tencent.com/document/api/1639/80942) - -* [ModifyRoom](https://cloud.tencent.com/document/api/1639/86030) - - 修改数据结构: -* [RoomInfo](https://cloud.tencent.com/document/api/1639/81423#RoomInfo) - - - - -## 云直播CSS(live) 版本:2018-08-01 - -### 第 121 次发布 - -发布时间:2024-03-21 01:19:47 - -本次发布包含了以下内容: - -改善已有的文档。 - -修改接口: - -* [DescribeLiveWatermarks](https://cloud.tencent.com/document/api/267/30152) +* [Instance](https://cloud.tencent.com/document/api/1721/101518#Instance) - * 新增入参:Name, PageNo, PageSize + * 新增成员:OSType -## 微服务引擎(tse) 版本:2020-12-07 +## 实时音视频(trtc) 版本:2019-07-22 -### 第 62 次发布 +### 第 67 次发布 -发布时间:2024-03-21 01:28:04 +发布时间:2024-03-22 01:25:05 本次发布包含了以下内容: 改善已有的文档。 -修改接口: +新增接口: -* [DescribeGovernanceServiceContracts](https://cloud.tencent.com/document/api/1364/104402) +* [DescribeWebRecord](https://cloud.tencent.com/document/api/647/104542) +* [StartWebRecord](https://cloud.tencent.com/document/api/647/104541) +* [StopWebRecord](https://cloud.tencent.com/document/api/647/104540) - * **修改入参**:Offset, Limit +新增数据结构: +* [WebRecordVideoParams](https://cloud.tencent.com/document/api/647/44055#WebRecordVideoParams) @@ -39728,6 +39699,32 @@ ## 主机安全(cwp) 版本:2018-02-28 +### 第 109 次发布 + +发布时间:2024-03-22 01:11:57 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [DescribeBanStatus](https://cloud.tencent.com/document/api/296/60944) + + * 新增出参:OpenSmartMode + +* [ModifyBanStatus](https://cloud.tencent.com/document/api/296/60942) + + * 新增入参:OpenSmartMode + + +修改数据结构: + +* [BruteAttackInfo](https://cloud.tencent.com/document/api/296/19867#BruteAttackInfo) + + * 新增成员:AttackStatusDesc, BanExpiredTime + + ### 第 108 次发布 发布时间:2024-02-02 01:09:36 @@ -69830,6 +69827,21 @@ ## 高性能应用服务(hai) 版本:2023-08-12 +### 第 7 次发布 + +发布时间:2024-03-22 01:16:13 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [Instance](https://cloud.tencent.com/document/api/1721/101518#Instance) + + * 新增成员:OSType + + ### 第 6 次发布 发布时间:2024-01-03 01:16:14 @@ -131807,6 +131819,24 @@ ## 实时音视频(trtc) 版本:2019-07-22 +### 第 67 次发布 + +发布时间:2024-03-22 01:25:05 + +本次发布包含了以下内容: + +改善已有的文档。 + +新增接口: + +* [[DescribeWebRecord](https://cloud.tencent.com/document/api/647/104542)](https://cloud.tencent.com/document/api/#/#) +* [[StartWebRecord](https://cloud.tencent.com/document/api/647/104541)](https://cloud.tencent.com/document/api/#/#) +* [[StopWebRecord](https://cloud.tencent.com/document/api/647/104540)](https://cloud.tencent.com/document/api/#/#) + +新增数据结构: + +* [[WebRecordVideoParams](https://cloud.tencent.com/document/api/647/44055#WebRecordVideoParams)](https://cloud.tencent.com/document/api/647/44055#[WebRecordVideoParams](https://cloud.tencent.com/document/api/647/44055#WebRecordVideoParams)) + ### 第 66 次发布 发布时间:2024-03-01 01:27:10 diff --git a/products.md b/products.md index 185ebf1bd4..6aa20977e6 100644 --- a/products.md +++ b/products.md @@ -70,7 +70,7 @@ | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2024-03-20 01:12:19 | | csxg | [5G入云服务](https://cloud.tencent.com/document/product/1687) | 2024-03-20 01:12:25 | | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2024-03-20 01:12:26 | -| cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-03-20 01:12:48 | +| cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-03-22 01:11:57 | | cws | [漏洞扫描服务](https://cloud.tencent.com/document/product) | 2019-11-22 12:16:15 | | cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2024-03-20 01:13:46 | | dasb | [T-Sec-堡垒机(BH)](https://cloud.tencent.com/document/product/1025) | 2024-03-20 01:14:04 | @@ -96,10 +96,10 @@ | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 | | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2024-03-20 01:16:19 | | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2024-03-20 01:16:27 | -| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-03-20 01:16:36 | +| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-03-22 01:15:20 | | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2024-03-20 01:16:49 | | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2024-03-20 01:17:05 | -| faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-03-20 01:17:06 | +| faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-03-22 01:15:45 | | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2024-03-20 01:17:11 | | ft | [人像变换](https://cloud.tencent.com/document/product/1202) | 2024-03-20 01:17:13 | | gaap | [全球应用加速](https://cloud.tencent.com/document/product/608) | 2024-03-20 01:17:14 | @@ -109,7 +109,7 @@ | gs | [云游戏](https://cloud.tencent.com/document/product/1162) | 2024-03-20 01:17:33 | | gse | [游戏服务器伸缩](https://cloud.tencent.com/document/product/1165) | 2022-07-11 06:12:44 | | habo | [](https://cloud.tencent.com/document/product) | 2019-05-09 19:37:22 | -| hai | [高性能应用服务](https://cloud.tencent.com/document/product/1721) | 2024-03-20 01:17:34 | +| hai | [高性能应用服务](https://cloud.tencent.com/document/product/1721) | 2024-03-22 01:16:13 | | hasim | [高可用物联网卡](https://cloud.tencent.com/document/product/1482) | 2023-05-18 01:29:47 | | hcm | [数学作业批改](https://cloud.tencent.com/document/product/1004) | 2024-03-20 01:17:36 | | hunyuan | [腾讯混元大模型](https://cloud.tencent.com/document/product/1729) | 2024-03-20 01:17:37 | @@ -184,7 +184,7 @@ | sts | [安全凭证服务](https://cloud.tencent.com/document/product/1312) | 2024-03-20 01:24:08 | | svp | [节省计划](https://cloud.tencent.com/document/product/1761) | 2024-03-20 01:24:09 | | taf | [流量反欺诈](https://cloud.tencent.com/document/product/1031) | 2024-03-21 01:24:01 | -| tag | [标签](https://cloud.tencent.com/document/product/651) | 2024-03-20 01:24:10 | +| tag | [标签](https://cloud.tencent.com/document/product/651) | 2024-03-22 01:21:43 | | tan | [碳引擎](https://cloud.tencent.com/document/product/1498) | 2024-03-20 01:24:15 | | tat | [自动化助手](https://cloud.tencent.com/document/product/1340) | 2024-03-20 01:24:15 | | tav | [文件检测](https://cloud.tencent.com/document/product) | 2019-11-28 22:10:04 | @@ -205,7 +205,7 @@ | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2024-03-20 01:25:54 | | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2024-03-20 01:26:12 | | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2024-03-20 01:26:14 | -| teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-03-21 01:26:17 | +| teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-03-22 01:23:38 | | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2024-03-20 01:27:05 | | tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 | | tic | [资源编排 TIC](https://cloud.tencent.com/document/product/1213) | 2023-08-17 05:26:08 | @@ -224,7 +224,7 @@ | trocket | [消息队列 RocketMQ 版](https://cloud.tencent.com/document/product/1493) | 2024-03-20 01:29:00 | | trp | [T-Sec-安心平台(RP)](https://cloud.tencent.com/document/product/1458) | 2024-03-20 01:29:06 | | trro | [远程实时操控](https://cloud.tencent.com/document/product/1584) | 2024-03-20 01:29:13 | -| trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2024-03-20 01:29:16 | +| trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2024-03-22 01:25:05 | | tse | [微服务引擎](https://cloud.tencent.com/document/product/1364) | 2024-03-21 01:28:04 | | tsf | [微服务平台 TSF](https://cloud.tencent.com/document/product/649) | 2024-03-20 01:29:39 | | tsw | [微服务观测平台 TSW](https://cloud.tencent.com/document/product/1311) | 2024-03-20 01:30:06 | diff --git a/pyproject.toml b/pyproject.toml index ae5bad76ae..eba5cb7605 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "tccli" -version = "3.0.1081.1" +version = "3.0.1082.1" authors = [ { name="tencentcloudapi", email="tencentcloudapi@tencent.com" }, ] @@ -21,7 +21,7 @@ classifiers = [ dependencies = [ "jmespath==0.10.0", "six==1.16.0", - "tencentcloud-sdk-python>=3.0.1081", + "tencentcloud-sdk-python>=3.0.1082", ] [project.urls] diff --git a/tccli/__init__.py b/tccli/__init__.py index 0667c4b926..6c2c98f906 100644 --- a/tccli/__init__.py +++ b/tccli/__init__.py @@ -1 +1 @@ -__version__ = '3.0.1081.1' +__version__ = '3.0.1082.1' diff --git a/tccli/examples/tag/v20180813/AddProject.md b/tccli/examples/tag/v20180813/AddProject.md index 30341c606b..c86198f9e6 100644 --- a/tccli/examples/tag/v20180813/AddProject.md +++ b/tccli/examples/tag/v20180813/AddProject.md @@ -1,12 +1,12 @@ **Example 1: 创建项目** - +创建项目 Input: ``` tccli tag AddProject --cli-unfold-argument \ - --ProjectName tp2 + --ProjectName 测试项目 ``` Output: @@ -14,8 +14,8 @@ Output: { "Response": { "IsNew": 1, - "ProjectId": 1024690, - "RequestId": "caf5c6ba-b21b-4769-b0bb-0b3090e0c282" + "ProjectId": 1001, + "RequestId": "7f831036-30b5-4972-a729-e6851a15d345" } } ``` diff --git a/tccli/examples/tag/v20180813/UpdateProject.md b/tccli/examples/tag/v20180813/UpdateProject.md index f1e82f2643..e6c45e8782 100644 --- a/tccli/examples/tag/v20180813/UpdateProject.md +++ b/tccli/examples/tag/v20180813/UpdateProject.md @@ -1,20 +1,20 @@ **Example 1: 修改项目名称** - +修改项目名称 Input: ``` tccli tag UpdateProject --cli-unfold-argument \ - --ProjectId 1024690 \ - --ProjectName test + --ProjectId 1001 \ + --ProjectName 项目名称 ``` Output: ``` { "Response": { - "RequestId": "f26b281e-0cbc-40ab-a38b-e9e62ef6fd24" + "RequestId": "87ccfc15-4c5a-4f0a-b5f1-eae50aad9e9a" } } ``` diff --git a/tccli/examples/trtc/v20190722/DescribeWebRecord.md b/tccli/examples/trtc/v20190722/DescribeWebRecord.md new file mode 100644 index 0000000000..74bcd4a876 --- /dev/null +++ b/tccli/examples/trtc/v20190722/DescribeWebRecord.md @@ -0,0 +1,21 @@ +**Example 1: 查询页面录制状态** + + + +Input: + +``` +tccli trtc DescribeWebRecord --cli-unfold-argument \ + --TaskId xxx +``` + +Output: +``` +{ + "Response": { + "Status": 1, + "RequestId": "abc" + } +} +``` + diff --git a/tccli/examples/trtc/v20190722/StartWebRecord.md b/tccli/examples/trtc/v20190722/StartWebRecord.md new file mode 100644 index 0000000000..a908cb89c1 --- /dev/null +++ b/tccli/examples/trtc/v20190722/StartWebRecord.md @@ -0,0 +1,31 @@ +**Example 1: 启动一个页面录制任务** + + + +Input: + +``` +tccli trtc StartWebRecord --cli-unfold-argument \ + --RecordUrl https://web-record-xxxxx.cos.ap-xxx.myqcloud.com/xxxx/xxx.mp4 \ + --StorageParams.CloudStorage.Vendor 0 \ + --StorageParams.CloudStorage.Bucket webrecord-1234589 \ + --StorageParams.CloudStorage.Region ap-chengdu \ + --StorageParams.CloudStorage.AccessKey AKxxxxxx \ + --StorageParams.CloudStorage.SecretKey Idxxxxxx \ + --StorageParams.CloudStorage.FileNamePrefix record video \ + --MaxDurationLimit 3600 \ + --WebRecordVideoParams.Width 1280 \ + --WebRecordVideoParams.Height 720 \ + --WebRecordVideoParams.Format mp4 +``` + +Output: +``` +{ + "Response": { + "TaskId": "abc", + "RequestId": "abc" + } +} +``` + diff --git a/tccli/examples/trtc/v20190722/StopWebRecord.md b/tccli/examples/trtc/v20190722/StopWebRecord.md new file mode 100644 index 0000000000..bd51779032 --- /dev/null +++ b/tccli/examples/trtc/v20190722/StopWebRecord.md @@ -0,0 +1,20 @@ +**Example 1: 停止页面录制任务** + + + +Input: + +``` +tccli trtc StopWebRecord --cli-unfold-argument \ + --TaskId xxxx +``` + +Output: +``` +{ + "Response": { + "RequestId": "abc" + } +} +``` + diff --git a/tccli/services/cwp/v20180228/api.json b/tccli/services/cwp/v20180228/api.json index 387e618506..a30dd2fd28 100644 --- a/tccli/services/cwp/v20180228/api.json +++ b/tccli/services/cwp/v20180228/api.json @@ -12774,7 +12774,7 @@ }, { "disabled": false, - "document": "阻断状态:1-阻断成功;非1-阻断失败\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "0 -不阻断(客户端版本不支持)\n1 -已阻断\n2 -阻断失败(程序异常)\n3 -不阻断(内网不阻断)\n4 -可用区不支持阻断\n10-阻断中\n81-不阻断(未开启阻断)\n82-不阻断(非专业版)\n83-不阻断(已加白名单)\n86-不阻断(系统白名单)\n87-不阻断(客户端离线)\n注意:此字段可能返回 null,表示取不到有效值。", "example": "0", "member": "uint64", "name": "BanStatus", @@ -12911,6 +12911,26 @@ "output_required": false, "type": "int", "value_allowed_null": true + }, + { + "disabled": false, + "document": "破解状态说明\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "string", + "name": "AttackStatusDesc", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "阻断过期时间(仅阻断中事件有效)\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "string", + "name": "BanExpiredTime", + "output_required": false, + "type": "string", + "value_allowed_null": true } ], "usage": "out" @@ -21105,6 +21125,16 @@ "type": "bool", "value_allowed_null": false }, + { + "disabled": false, + "document": "是否开启智能过白模式", + "example": "无", + "member": "bool", + "name": "OpenSmartMode", + "output_required": false, + "type": "bool", + "value_allowed_null": false + }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", "member": "string", @@ -46403,12 +46433,21 @@ "members": [ { "disabled": false, - "document": "阻断状态 0:关闭 1:开启", + "document": "阻断开关状态: 0 -- 关闭 1 -- 高级阻断 2 -- 基础阻断(只阻断情报库黑ip)", "example": "1", "member": "uint64", "name": "Status", "required": true, "type": "int" + }, + { + "disabled": false, + "document": "是否开启智能过白模式", + "example": "无", + "member": "bool", + "name": "OpenSmartMode", + "required": false, + "type": "bool" } ], "type": "object" diff --git a/tccli/services/ess/v20201111/api.json b/tccli/services/ess/v20201111/api.json index 654fad08ae..7ecfbcf48a 100644 --- a/tccli/services/ess/v20201111/api.json +++ b/tccli/services/ess/v20201111/api.json @@ -693,7 +693,7 @@ }, { "disabled": false, - "document": "通知签署方经办人的方式, 有以下途径:\n", + "document": "通知签署方经办人的方式, 有以下途径:\n\n```\n注意:\n如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信\n```", "example": "sms", "member": "string", "name": "NotifyType", diff --git a/tccli/services/faceid/v20180301/api.json b/tccli/services/faceid/v20180301/api.json index 786ebd276a..61276f63a9 100644 --- a/tccli/services/faceid/v20180301/api.json +++ b/tccli/services/faceid/v20180301/api.json @@ -1145,7 +1145,7 @@ }, { "disabled": false, - "document": "身份标识(未使用OCR服务时,必须传入)。\n规则:a-z,A-Z,0-9组合。最长长度32位。", + "document": "身份标识(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。\n规则:a-z,A-Z,0-9组合。最长长度32位。", "example": "无", "member": "string", "name": "IdCard", @@ -1154,7 +1154,7 @@ }, { "disabled": false, - "document": "姓名。(未使用OCR服务时,必须传入)最长长度32位。中文请使用UTF-8编码。", + "document": "姓名。(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。\n最长长度32位。中文请使用UTF-8编码。", "example": "无", "member": "string", "name": "Name", diff --git a/tccli/services/hai/v20230812/api.json b/tccli/services/hai/v20230812/api.json index cfc8af7c95..ad3906b579 100644 --- a/tccli/services/hai/v20230812/api.json +++ b/tccli/services/hai/v20230812/api.json @@ -831,6 +831,16 @@ "output_required": true, "type": "list", "value_allowed_null": true + }, + { + "disabled": false, + "document": "应用服务的操作系统类型\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "linux or windows", + "member": "string", + "name": "OSType", + "output_required": true, + "type": "string", + "value_allowed_null": true } ], "usage": "out" diff --git a/tccli/services/tag/v20180813/api.json b/tccli/services/tag/v20180813/api.json index 90142372db..b1a70d0e80 100644 --- a/tccli/services/tag/v20180813/api.json +++ b/tccli/services/tag/v20180813/api.json @@ -231,7 +231,7 @@ { "disabled": false, "document": "项目名称", - "example": "", + "example": "测试项目", "member": "string", "name": "ProjectName", "required": true, @@ -240,7 +240,7 @@ { "disabled": false, "document": "项目描述", - "example": "", + "example": "项目描述", "member": "string", "name": "Info", "required": false, @@ -255,18 +255,20 @@ { "disabled": false, "document": "项目Id", - "example": "", + "example": "1001", "member": "uint64", "name": "ProjectId", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "是否为新项目", - "example": "", + "document": "是否为新项目,1是新项目,0不是新项目", + "example": "1", "member": "int64", "name": "IsNew", + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -2114,7 +2116,7 @@ "members": [ { "disabled": false, - "document": "获取的下一页的Token值", + "document": "获取的下一页的Token值,如果当前是最后一页,返回为空", "example": "无", "member": "string", "name": "PaginationToken", @@ -2188,7 +2190,7 @@ "members": [ { "disabled": false, - "document": "获取的下一页的Token值", + "document": "获取的下一页的Token值,如果当前是最后一页,返回为空", "example": "POzXXYGXh2fRDHxx7PGaJnLApcyIuAYBC5HX25gKI4Sz2R*********", "member": "string", "name": "PaginationToken", @@ -2262,7 +2264,7 @@ "members": [ { "disabled": false, - "document": "获取的下一页的Token值", + "document": "获取的下一页的Token值,如果当前是最后一页,返回为空", "example": "POzXXYGXh2fRDHxx7PGaJnLApcyIuAYBC5HX25gKI4Sz2R*********", "member": "string", "name": "PaginationToken", @@ -2871,7 +2873,7 @@ { "disabled": false, "document": "项目ID", - "example": "", + "example": "1001", "member": "uint64", "name": "ProjectId", "required": true, @@ -2880,7 +2882,7 @@ { "disabled": false, "document": "项目名称", - "example": "", + "example": "测试项目", "member": "string", "name": "ProjectName", "required": false, @@ -2889,7 +2891,7 @@ { "disabled": false, "document": "禁用项目,1,禁用,0,启用", - "example": "", + "example": "0", "member": "int64", "name": "Disable", "required": false, @@ -2898,7 +2900,7 @@ { "disabled": false, "document": "备注", - "example": "", + "example": "备注信息", "member": "string", "name": "Info", "required": false, diff --git a/tccli/services/tag/v20180813/examples.json b/tccli/services/tag/v20180813/examples.json index 548317111d..8df035faec 100644 --- a/tccli/services/tag/v20180813/examples.json +++ b/tccli/services/tag/v20180813/examples.json @@ -2,9 +2,9 @@ "actions": { "AddProject": [ { - "document": "", - "input": "https://tag.tencentcloudapi.com/?Action=AddProject\r\n&ProjectName=tp2\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"IsNew\": 1,\n \"ProjectId\": 1024690,\n \"RequestId\": \"caf5c6ba-b21b-4769-b0bb-0b3090e0c282\"\n }\n}", + "document": "创建项目", + "input": "POST / HTTP/1.1\nHost: tag.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddProject\n<公共请求参数>\n\n{\n \"ProjectName\": \"测试项目\"\n}", + "output": "{\n \"Response\": {\n \"IsNew\": 1,\n \"ProjectId\": 1001,\n \"RequestId\": \"7f831036-30b5-4972-a729-e6851a15d345\"\n }\n}", "title": "创建项目" } ], @@ -67,7 +67,7 @@ "DescribeProjects": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tag.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProjects\n<公共请求参数>\n\n{\n \"Limit\": \"500\",\n \"AllList\": \"0\",\n \"Offset\": \"0\"\n}", + "input": "POST / HTTP/1.1\nHost: tag.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProjects\n<公共请求参数>\n\n{\n \"Limit\": 500,\n \"AllList\": 0,\n \"Offset\": 0\n}", "output": "{\n \"Response\": {\n \"Total\": 1,\n \"Projects\": [\n {\n \"ProjectId\": 1000101,\n \"ProjectName\": \"test1\",\n \"CreatorUin\": 100000012345,\n \"ProjectInfo\": \"\",\n \"CreateTime\": \"2021-10-13 11:03:30\"\n }\n ],\n \"RequestId\": \"d75bbc07-f5bd-4020-b4bd-f877e9ccd1db\"\n }\n}", "title": "获取项目列表" } @@ -246,9 +246,9 @@ ], "UpdateProject": [ { - "document": "", - "input": "https://tag.tencentcloudapi.com/?Action=UpdateProject\r\n&ProjectId=1024690\r\n&ProjectName=test\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"f26b281e-0cbc-40ab-a38b-e9e62ef6fd24\"\n }\n}", + "document": "修改项目名称", + "input": "POST / HTTP/1.1\nHost: tag.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateProject\n<公共请求参数>\n\n{\n \"ProjectId\": 1001,\n \"ProjectName\": \"项目名称\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"87ccfc15-4c5a-4f0a-b5f1-eae50aad9e9a\"\n }\n}", "title": "修改项目名称" } ], diff --git a/tccli/services/teo/v20220901/api.json b/tccli/services/teo/v20220901/api.json index ea89b3b198..daf142db08 100644 --- a/tccli/services/teo/v20220901/api.json +++ b/tccli/services/teo/v20220901/api.json @@ -1966,7 +1966,7 @@ }, { "disabled": false, - "document": "指定绑定或解绑的策略模板 ID 。", + "document": "指定绑定或解绑的策略模板 ID 或站点全局策略\n- 如需绑定至策略模板,或从策略模板解绑,请指定策略模板 ID。\n- 如需绑定至站点全局策略,或从站点全局策略解绑,请使用 @ZoneLevel@domain 参数值。\n\n注意:解绑后,域名将使用独立策略,并单独计算规则配额,请确保解绑前套餐规则配额充足。", "example": "temp-wj86oi2", "member": "string", "name": "TemplateId", @@ -11552,7 +11552,7 @@ }, { "disabled": false, - "document": "子域名/应用名。当使用Entity时可不填写TemplateId,否则必须填写TemplateId。", + "document": "子域名/应用名。\n\n注意:当同时指定本参数和 TemplateId 参数时,本参数不生效。请勿同时指定本参数和 TemplateId 参数。", "example": "a.test.com", "member": "string", "name": "Entity", @@ -11561,8 +11561,8 @@ }, { "disabled": false, - "document": "模板策略id。当使用模板Id时可不填Entity,否则必须填写Entity。", - "example": "1", + "document": "指定模板策略 ID,或指定站点全局策略。\n- 如需配置策略模板,请指定策略模板 ID。\n- 如需配置站点全局策略,请使用 @ZoneLevel@Domain 参数值\n\n注意:当使用本参数时,Entity 参数不生效。请勿同时使用本参数和 Entity 参数。", + "example": "temp-wj86oi2", "member": "string", "name": "TemplateId", "required": false, diff --git a/tccli/services/trtc/trtc_client.py b/tccli/services/trtc/trtc_client.py index d6ae5c9dc4..17d52efb6a 100644 --- a/tccli/services/trtc/trtc_client.py +++ b/tccli/services/trtc/trtc_client.py @@ -225,6 +225,58 @@ def doDescribeTRTCMarketQualityMetricData(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doDeleteCloudRecording(args, parsed_globals): + g_param = parse_global_arg(parsed_globals) + + if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: + cred = credential.CVMRoleCredential() + elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]: + cred = credential.STSAssumeRoleCredential( + g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')], + g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"] + ) + elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN): + cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials() + else: + cred = credential.Credential( + g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token] + ) + http_profile = HttpProfile( + reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]), + reqMethod="POST", + endpoint=g_param[OptionsDefine.Endpoint], + proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')] + ) + profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256") + if g_param[OptionsDefine.Language]: + profile.language = g_param[OptionsDefine.Language] + mod = CLIENT_MAP[g_param[OptionsDefine.Version]] + client = mod.TrtcClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.DeleteCloudRecordingRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.DeleteCloudRecording(model) + result = rsp.to_json_string() + try: + json_obj = json.loads(result) + except TypeError as e: + json_obj = json.loads(result.decode('utf-8')) # python3.3 + if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']: + break + cur_time = time.time() + if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']: + raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' % + (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'], + search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))) + else: + print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)) + time.sleep(g_param['OptionsDefine.WaiterInfo']['interval']) + FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) + + def doStartPublishCdnStream(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -953,6 +1005,58 @@ def doDescribeUserEvent(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doStartWebRecord(args, parsed_globals): + g_param = parse_global_arg(parsed_globals) + + if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: + cred = credential.CVMRoleCredential() + elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]: + cred = credential.STSAssumeRoleCredential( + g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')], + g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"] + ) + elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN): + cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials() + else: + cred = credential.Credential( + g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token] + ) + http_profile = HttpProfile( + reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]), + reqMethod="POST", + endpoint=g_param[OptionsDefine.Endpoint], + proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')] + ) + profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256") + if g_param[OptionsDefine.Language]: + profile.language = g_param[OptionsDefine.Language] + mod = CLIENT_MAP[g_param[OptionsDefine.Version]] + client = mod.TrtcClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.StartWebRecordRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.StartWebRecord(model) + result = rsp.to_json_string() + try: + json_obj = json.loads(result) + except TypeError as e: + json_obj = json.loads(result.decode('utf-8')) # python3.3 + if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']: + break + cur_time = time.time() + if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']: + raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' % + (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'], + search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))) + else: + print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)) + time.sleep(g_param['OptionsDefine.WaiterInfo']['interval']) + FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) + + def doStartMCUMixTranscode(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -1057,6 +1161,58 @@ def doDescribeTRTCMarketScaleData(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doStopWebRecord(args, parsed_globals): + g_param = parse_global_arg(parsed_globals) + + if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: + cred = credential.CVMRoleCredential() + elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]: + cred = credential.STSAssumeRoleCredential( + g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')], + g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"] + ) + elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN): + cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials() + else: + cred = credential.Credential( + g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token] + ) + http_profile = HttpProfile( + reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]), + reqMethod="POST", + endpoint=g_param[OptionsDefine.Endpoint], + proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')] + ) + profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256") + if g_param[OptionsDefine.Language]: + profile.language = g_param[OptionsDefine.Language] + mod = CLIENT_MAP[g_param[OptionsDefine.Version]] + client = mod.TrtcClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.StopWebRecordRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.StopWebRecord(model) + result = rsp.to_json_string() + try: + json_obj = json.loads(result) + except TypeError as e: + json_obj = json.loads(result.decode('utf-8')) # python3.3 + if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']: + break + cur_time = time.time() + if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']: + raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' % + (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'], + search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))) + else: + print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)) + time.sleep(g_param['OptionsDefine.WaiterInfo']['interval']) + FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) + + def doCreateCloudRecording(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -1941,7 +2097,7 @@ def doDescribeTRTCRealTimeQualityData(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDeleteCloudRecording(args, parsed_globals): +def doDescribeWebRecord(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -1970,11 +2126,11 @@ def doDeleteCloudRecording(args, parsed_globals): client = mod.TrtcClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DeleteCloudRecordingRequest() + model = models.DescribeWebRecordRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DeleteCloudRecording(model) + rsp = client.DescribeWebRecord(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -2268,6 +2424,7 @@ def doDescribeTRTCRealTimeScaleMetricData(args, parsed_globals): "DescribeRoomInfo": doDescribeRoomInfo, "DescribeTrtcUsage": doDescribeTrtcUsage, "DescribeTRTCMarketQualityMetricData": doDescribeTRTCMarketQualityMetricData, + "DeleteCloudRecording": doDeleteCloudRecording, "StartPublishCdnStream": doStartPublishCdnStream, "DescribeCallDetailInfo": doDescribeCallDetailInfo, "DescribeStreamIngest": doDescribeStreamIngest, @@ -2282,8 +2439,10 @@ def doDescribeTRTCRealTimeScaleMetricData(args, parsed_globals): "RemoveUser": doRemoveUser, "ModifyCloudRecording": doModifyCloudRecording, "DescribeUserEvent": doDescribeUserEvent, + "StartWebRecord": doStartWebRecord, "StartMCUMixTranscode": doStartMCUMixTranscode, "DescribeTRTCMarketScaleData": doDescribeTRTCMarketScaleData, + "StopWebRecord": doStopWebRecord, "CreateCloudRecording": doCreateCloudRecording, "DescribeScaleInfo": doDescribeScaleInfo, "DescribeRelayUsage": doDescribeRelayUsage, @@ -2301,7 +2460,7 @@ def doDescribeTRTCRealTimeScaleMetricData(args, parsed_globals): "ModifyPicture": doModifyPicture, "UpdatePublishCdnStream": doUpdatePublishCdnStream, "DescribeTRTCRealTimeQualityData": doDescribeTRTCRealTimeQualityData, - "DeleteCloudRecording": doDeleteCloudRecording, + "DescribeWebRecord": doDescribeWebRecord, "DescribePicture": doDescribePicture, "DescribeTRTCMarketQualityData": doDescribeTRTCMarketQualityData, "StopPublishCdnStream": doStopPublishCdnStream, diff --git a/tccli/services/trtc/v20190722/api.json b/tccli/services/trtc/v20190722/api.json index dc588017c3..dd4ba55855 100644 --- a/tccli/services/trtc/v20190722/api.json +++ b/tccli/services/trtc/v20190722/api.json @@ -196,6 +196,13 @@ "output": "DescribeUserInfoResponse", "status": "online" }, + "DescribeWebRecord": { + "document": "查询页面录制任务", + "input": "DescribeWebRecordRequest", + "name": "查询页面录制", + "output": "DescribeWebRecordResponse", + "status": "online" + }, "DismissRoom": { "document": "接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。", "input": "DismissRoomRequest", @@ -266,6 +273,13 @@ "output": "StartStreamIngestResponse", "status": "online" }, + "StartWebRecord": { + "document": "通过此接口可以发起 WEB 页面录制任务,在接口参数中指定录制 URL,录制分辨率,录制结果存储等参数。\n因为参数或API逻辑问题会立即返回结果。而因为页面问题,如页面无法访问,会在回调中返回结果,请关注。", + "input": "StartWebRecordRequest", + "name": "开始页面录制", + "output": "StartWebRecordResponse", + "status": "online" + }, "StopMCUMixTranscode": { "document": "接口说明:结束云端混流", "input": "StopMCUMixTranscodeRequest", @@ -294,6 +308,13 @@ "output": "StopStreamIngestResponse", "status": "online" }, + "StopWebRecord": { + "document": "停止页面录制任务", + "input": "StopWebRecordRequest", + "name": "停止页面录制", + "output": "StopWebRecordResponse", + "status": "online" + }, "UpdatePublishCdnStream": { "document": "更新转推任务。\n注:请参见启动转推任务的接口说明和使用说明。", "input": "UpdatePublishCdnStreamRequest", @@ -2589,6 +2610,43 @@ ], "type": "object" }, + "DescribeWebRecordRequest": { + "document": "DescribeWebRecord请求参数结构体", + "members": [ + { + "disabled": false, + "document": "开始页面录制时返回的任务id", + "example": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri", + "member": "string", + "name": "TaskId", + "required": true, + "type": "string" + } + ], + "type": "object" + }, + "DescribeWebRecordResponse": { + "document": "DescribeWebRecord返回参数结构体", + "members": [ + { + "disabled": false, + "document": "1: 正在录制中\n2: 任务不存在", + "example": "1", + "member": "int64", + "name": "Status", + "output_required": false, + "type": "int", + "value_allowed_null": false + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "DismissRoomByStrRoomIdRequest": { "document": "DismissRoomByStrRoomId请求参数结构体", "members": [ @@ -5435,6 +5493,88 @@ ], "type": "object" }, + "StartWebRecordRequest": { + "document": "StartWebRecord请求参数结构体", + "members": [ + { + "disabled": false, + "document": "需要录制的网页URL\n", + "example": "https://web-record-xxxx.cos.ap-xxx.xxx.com/test/xxx.mp4", + "member": "string", + "name": "RecordUrl", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "录制最大时长限制, 单位 s, 合法取值范围[0, 36000], 默认 36000s(10 小时)\n", + "example": "36000", + "member": "uint64", + "name": "MaxDurationLimit", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "云存储相关的参数,目前支持腾讯云对象存储,不支持第三方云存储以及VOD", + "example": "无", + "member": "StorageParams", + "name": "StorageParams", + "required": false, + "type": "object" + }, + { + "disabled": false, + "document": "页面录制视频参数", + "example": "无", + "member": "WebRecordVideoParams", + "name": "WebRecordVideoParams", + "required": false, + "type": "object" + }, + { + "disabled": false, + "document": "TRTC的SdkAppId", + "example": "无", + "member": "int64", + "name": "SdkAppId", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "当对重复任务敏感时,请关注此值: 为了避免任务在短时间内重复发起,导致任务重复\n传入录制RecordId来标识此次任务, 小于32字节,若携带RecordId发起两次以上的开始录制请求,任务只会启动一个,第二个报错FailedOperation.TaskExist。注意StartWebRecord调用失败时而非FailedOperation.TaskExist错误,请更换RecordId重新发起。", + "example": "record_task_abc_1", + "member": "string", + "name": "RecordId", + "required": false, + "type": "string" + } + ], + "type": "object" + }, + "StartWebRecordResponse": { + "document": "StartWebRecord返回参数结构体", + "members": [ + { + "disabled": false, + "document": "录制任务的唯一Id", + "example": "Vfn+FlMTUh1hL0a6kfBUPUsd9FmPLyznAsbd+QFsasqLg5UulUlA9JhYTw15YEYMCxXlfQwtl5cNmrbJqFubDTUp3OGPsU.", + "member": "string", + "name": "TaskId", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "StopMCUMixTranscodeByStrRoomIdRequest": { "document": "StopMCUMixTranscodeByStrRoomId请求参数结构体", "members": [ @@ -5589,6 +5729,33 @@ ], "type": "object" }, + "StopWebRecordRequest": { + "document": "StopWebRecord请求参数结构体", + "members": [ + { + "disabled": false, + "document": "需要停止的任务Id", + "example": "xxx", + "member": "string", + "name": "TaskId", + "required": true, + "type": "string" + } + ], + "type": "object" + }, + "StopWebRecordResponse": { + "document": "StopWebRecord返回参数结构体", + "members": [ + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "StorageFile": { "document": "云端录制查询接口,录制文件的信息", "members": [ @@ -5856,7 +6023,7 @@ }, { "disabled": false, - "document": "仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用__UserDefine_u_分开。", + "document": "仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用`__UserDefine_u_` 分开。", "example": "xxx", "member": "string", "name": "UserDefineRecordId", @@ -6592,6 +6759,39 @@ } ], "usage": "in" + }, + "WebRecordVideoParams": { + "document": "页面录制视频参数", + "members": [ + { + "disabled": false, + "document": "录制画面宽度,默认为1280,取值范围[0, 1920]", + "example": "1280", + "member": "uint64", + "name": "Width", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "录制画面高度,默认为720,取值范围[0, 1080]", + "example": "720", + "member": "uint64", + "name": "Height", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "指定输出格式,可选hls,mp4\n", + "example": "mp4", + "member": "string", + "name": "Format", + "required": false, + "type": "string" + } + ], + "usage": "in" } }, "version": "1.0" diff --git a/tccli/services/trtc/v20190722/examples.json b/tccli/services/trtc/v20190722/examples.json index 93ea33f8eb..7fcfba7d59 100644 --- a/tccli/services/trtc/v20190722/examples.json +++ b/tccli/services/trtc/v20190722/examples.json @@ -224,6 +224,14 @@ "title": "查询用户列表与通话指标" } ], + "DescribeWebRecord": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeWebRecord\n<公共请求参数>\n\n{\n \"TaskId\": \"xxx\"\n}", + "output": "{\n \"Response\": {\n \"Status\": 1,\n \"RequestId\": \"abc\"\n }\n}", + "title": "查询页面录制状态" + } + ], "DismissRoom": [ { "document": "解散房间1234。", @@ -328,6 +336,14 @@ "title": "启动输入在线媒体流" } ], + "StartWebRecord": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartWebRecord\n<公共请求参数>\n\n{\n \"RecordUrl\": \"https://web-record-xxxxx.cos.ap-xxx.myqcloud.com/xxxx/xxx.mp4\",\n \"StorageParams\": {\n \"CloudStorage\": {\n \"Vendor\": 0,\n \"Bucket\": \"webrecord-1234589\",\n \"Region\": \"ap-chengdu\",\n \"AccessKey\": \"AKxxxxxx\",\n \"SecretKey\": \"Idxxxxxx\",\n \"FileNamePrefix\": [\n \"record\",\n \"video\"\n ]\n }\n },\n \"MaxDurationLimit\": 3600,\n \"WebRecordVideoParams\": {\n \"Width\": 1280,\n \"Height\": 720,\n \"Format\": \"mp4\"\n }\n}", + "output": "{\n \"Response\": {\n \"TaskId\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}", + "title": "启动一个页面录制任务" + } + ], "StopMCUMixTranscode": [ { "document": "结束房间号为3560的云端混流。", @@ -360,6 +376,14 @@ "title": "停止输入在线媒体流" } ], + "StopWebRecord": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StopWebRecord\n<公共请求参数>\n\n{\n \"TaskId\": \"xxxx\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}", + "title": "停止页面录制任务" + } + ], "UpdatePublishCdnStream": [ { "document": "更新为混主播Trtc_User_0和Trtc_User_3的音视频。",