From 7edbbf445df4aa6e5272fbfe51816eeb2390027c Mon Sep 17 00:00:00 2001 From: tencentcloudapi Date: Thu, 7 Mar 2024 04:12:33 +0800 Subject: [PATCH] release 3.0.1070.1 --- CHANGELOG.md | 262 ++++++++++ SERVICE_CHANGELOG.md | 471 ++++++++++++++---- products.md | 38 +- pyproject.toml | 4 +- tccli/__init__.py | 2 +- .../ccc/v20200210/DescribeStaffInfoList.md | 1 + .../v20180317/DescribeLoadBalancersDetail.md | 236 ++++++++- .../examples/cls/v20201016/CreateConsumer.md | 4 +- .../cls/v20201016/CreateKafkaRecharge.md | 11 +- .../cls/v20201016/DescribeConfigExtras.md | 23 + .../cls/v20201016/DescribeDashboards.md | 50 +- .../cls/v20201016/DescribeKafkaRecharges.md | 47 +- .../examples/cls/v20201016/ModifyConsumer.md | 4 +- .../cls/v20201016/PreviewKafkaRecharge.md | 2 +- tccli/examples/cwp/v20180228/DeleteMachine.md | 2 +- .../v20180228/DescribeLogKafkaDeliverInfo.md | 43 +- .../cwp/v20180228/ModifyLogKafkaAccess.md | 8 +- .../cwp/v20180228/ModifyLogKafkaState.md | 6 +- .../dasb/v20191018/ModifyOAuthSetting.md | 26 + .../DescribeDSPARDBDataAssetByComplianceId.md | 33 +- .../ess/v20201111/CreateFlowSignUrl.md | 37 ++ .../ess/v20201111/DescribeSignFaceVideo.md | 36 ++ .../v20210526/ChannelCreateFlowSignUrl.md | 38 ++ .../v20210526/ChannelDescribeSignFaceVideo.md | 38 ++ ...associateDirectConnectGatewayNatGateway.md | 2 +- tccli/services/apm/v20210622/api.json | 4 +- tccli/services/ccc/v20200210/api.json | 26 +- tccli/services/ccc/v20200210/examples.json | 2 +- tccli/services/cdb/v20170320/api.json | 4 +- tccli/services/clb/v20180317/api.json | 2 +- tccli/services/clb/v20180317/examples.json | 4 +- tccli/services/cls/v20201016/api.json | 250 ++++++---- tccli/services/cls/v20201016/examples.json | 24 +- tccli/services/cwp/v20180228/api.json | 38 +- tccli/services/cwp/v20180228/examples.json | 10 +- tccli/services/dasb/dasb_client.py | 53 ++ tccli/services/dasb/v20191018/api.json | 97 ++++ tccli/services/dasb/v20191018/examples.json | 8 + tccli/services/dsgc/v20190723/api.json | 206 +++++++- tccli/services/dsgc/v20190723/examples.json | 2 +- tccli/services/ess/ess_client.py | 53 ++ tccli/services/ess/v20201111/api.json | 256 ++++++++++ tccli/services/ess/v20201111/examples.json | 14 + tccli/services/essbasic/essbasic_client.py | 53 ++ tccli/services/essbasic/v20210526/api.json | 247 +++++++++ .../services/essbasic/v20210526/examples.json | 14 + tccli/services/ocr/v20181119/api.json | 2 +- tccli/services/tdmq/v20200217/api.json | 4 +- tccli/services/teo/v20220901/api.json | 6 +- tccli/services/trocket/v20230308/api.json | 223 +++++++-- tccli/services/trtc/v20190722/api.json | 2 +- tccli/services/tse/v20201207/api.json | 22 + tccli/services/vpc/v20170312/api.json | 20 +- tccli/services/vpc/v20170312/examples.json | 2 +- 54 files changed, 2637 insertions(+), 435 deletions(-) create mode 100644 tccli/examples/dasb/v20191018/ModifyOAuthSetting.md create mode 100644 tccli/examples/ess/v20201111/DescribeSignFaceVideo.md create mode 100644 tccli/examples/essbasic/v20210526/ChannelDescribeSignFaceVideo.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 87021eac23..d37d5f06c3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,265 @@ +# Release 3.0.1070.1 + +## 云联络中心(ccc) 版本：2020-02-10 + +### 第 61 次发布 + +发布时间：2024-03-07 01:09:17 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [StaffInfo](https://cloud.tencent.com/document/api/679/47715#StaffInfo) + + * 新增成员：RoleId + + + + +## 日志服务(cls) 版本：2020-10-16 + +### 第 83 次发布 + +发布时间：2024-03-07 01:11:18 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增数据结构： + +* [CollectConfig](https://cloud.tencent.com/document/api/614/56471#CollectConfig) +* [CollectInfo](https://cloud.tencent.com/document/api/614/56471#CollectInfo) + +修改数据结构： + +* [ConfigExtraInfo](https://cloud.tencent.com/document/api/614/56471#ConfigExtraInfo) + + * 新增成员：CollectInfos + +* [ConsumerContent](https://cloud.tencent.com/document/api/614/56471#ConsumerContent) + + * 新增成员：JsonType + +* [LogInfo](https://cloud.tencent.com/document/api/614/56471#LogInfo) + + * **修改成员**：RawLog, IndexStatus + + + + +## T-Sec-堡垒机（BH）(dasb) 版本：2019-10-18 + +### 第 24 次发布 + +发布时间：2024-03-07 01:13:28 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [ModifyOAuthSetting](https://cloud.tencent.com/document/api/1025/104132) + + + +## 数据安全治理中心(dsgc) 版本：2019-07-23 + +### 第 7 次发布 + +发布时间：2024-03-07 01:14:47 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateDSPASelfBuildMetaResource](https://cloud.tencent.com/document/api/1087/97178) + + * 新增入参：InstanceType, InstanceValue + +* [DescribeDSPADataSourceDbInfo](https://cloud.tencent.com/document/api/1087/97216) + + * 新增入参：DataSourceType + +* [DescribeDSPAESDataAssetByComplianceId](https://cloud.tencent.com/document/api/1087/97144) + + * 新增入参：BuildType, DataSourceType + +* [DescribeDSPARDBDataAssetByComplianceId](https://cloud.tencent.com/document/api/1087/97205) + + * 新增入参：BuildType + +* [ModifyDSPACOSTaskResult](https://cloud.tencent.com/document/api/1087/97197) + + * 新增入参：FileName, BucketName, DataSourceId + + +修改数据结构： + +* [DspaCOSDataAssetDetail](https://cloud.tencent.com/document/api/1087/96844#DspaCOSDataAssetDetail) + + * 新增成员：IdentifyType, CheckStatus + +* [DspaDiscoveryTaskDataSource](https://cloud.tencent.com/document/api/1087/96844#DspaDiscoveryTaskDataSource) + + * 新增成员：DataSourceType + +* [DspaUserResourceMeta](https://cloud.tencent.com/document/api/1087/96844#DspaUserResourceMeta) + + * 新增成员：InstanceType, InstanceValue + + + + +## 腾讯电子签企业版(ess) 版本：2020-11-11 + +### 第 152 次发布 + +发布时间：2024-03-07 01:16:07 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [DescribeSignFaceVideo](https://cloud.tencent.com/document/api/1323/104133) + +新增数据结构： + +* [DetectInfoVideoData](https://cloud.tencent.com/document/api/1323/70369#DetectInfoVideoData) +* [Intention](https://cloud.tencent.com/document/api/1323/70369#Intention) +* [IntentionAction](https://cloud.tencent.com/document/api/1323/70369#IntentionAction) +* [IntentionActionResult](https://cloud.tencent.com/document/api/1323/70369#IntentionActionResult) +* [IntentionActionResultDetail](https://cloud.tencent.com/document/api/1323/70369#IntentionActionResultDetail) +* [IntentionQuestion](https://cloud.tencent.com/document/api/1323/70369#IntentionQuestion) +* [IntentionQuestionResult](https://cloud.tencent.com/document/api/1323/70369#IntentionQuestionResult) + +修改数据结构： + +* [FlowCreateApprover](https://cloud.tencent.com/document/api/1323/70369#FlowCreateApprover) + + * 新增成员：Intention + + + + +## 腾讯电子签（基础版）(essbasic) 版本：2021-05-26 + +### 第 155 次发布 + +发布时间：2024-03-07 01:16:27 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [ChannelDescribeSignFaceVideo](https://cloud.tencent.com/document/api/1420/104134) + +新增数据结构： + +* [DetectInfoVideoData](https://cloud.tencent.com/document/api/1420/61525#DetectInfoVideoData) +* [Intention](https://cloud.tencent.com/document/api/1420/61525#Intention) +* [IntentionAction](https://cloud.tencent.com/document/api/1420/61525#IntentionAction) +* [IntentionActionResult](https://cloud.tencent.com/document/api/1420/61525#IntentionActionResult) +* [IntentionActionResultDetail](https://cloud.tencent.com/document/api/1420/61525#IntentionActionResultDetail) +* [IntentionQuestion](https://cloud.tencent.com/document/api/1420/61525#IntentionQuestion) +* [IntentionQuestionResult](https://cloud.tencent.com/document/api/1420/61525#IntentionQuestionResult) + +修改数据结构： + +* [FlowApproverInfo](https://cloud.tencent.com/document/api/1420/61525#FlowApproverInfo) + + * 新增成员：Intention + + + + +## 腾讯电子签（基础版）(essbasic) 版本：2020-12-22 + + + +## 消息队列 RocketMQ 版(trocket) 版本：2023-03-08 + +### 第 11 次发布 + +发布时间：2024-03-07 01:26:39 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateInstance](https://cloud.tencent.com/document/api/1493/97868) + + * 新增入参：PayMode, RenewFlag, TimeSpan, MaxTopicNum + +* [CreateTopic](https://cloud.tencent.com/document/api/1493/97947) + + * 新增入参：MsgTTL + +* [DescribeTopic](https://cloud.tencent.com/document/api/1493/97945) + + * **修改入参**：Offset, Limit + + * 新增出参：MsgTTL + +* [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) + + * **修改入参**：Offset, Limit + +* [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865) + + * 新增入参：MaxTopicNum + + +修改数据结构： + +* [SubscriptionData](https://cloud.tencent.com/document/api/1493/96031#SubscriptionData) + + * 新增成员：MessageModel + + * **修改成员**：InstanceId, Topic, TopicType, TopicQueueNum, ConsumerGroup, IsOnline, ConsumeType, SubString, ExpressionType, Consistency, ConsumerLag, LastUpdateTime, MaxRetryTimes, ConsumeMessageOrderly + +* [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) + + * 新增成员：ClusterIdV4, NamespaceV4, TopicV4, FullNamespaceV4, MsgTTL + + + + +## 微服务引擎(tse) 版本：2020-12-07 + +### 第 59 次发布 + +发布时间：2024-03-07 01:27:04 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [KongUpstreamInfo](https://cloud.tencent.com/document/api/1364/54942#KongUpstreamInfo) + + * 新增成员：ScfCamAuthEnable + +* [UpstreamHealthCheckConfig](https://cloud.tencent.com/document/api/1364/54942#UpstreamHealthCheckConfig) + + * 新增成员：IgnoreZeroWeightNodes + + + + # Release 3.0.1069.1 ## 负载均衡(clb) 版本：2018-03-17 diff --git a/SERVICE_CHANGELOG.md b/SERVICE_CHANGELOG.md index 6b95c71843..c80c0ea9f3 100644 --- a/SERVICE_CHANGELOG.md +++ b/SERVICE_CHANGELOG.md @@ -1,120 +1,127 @@ # 本版本更新包含以下内容： -## 负载均衡(clb) 版本：2018-03-17 +## 云联络中心(ccc) 版本：2020-02-10 -### 第 103 次发布 +### 第 61 次发布 -发布时间：2024-03-06 01:10:51 +发布时间：2024-03-07 01:09:17 本次发布包含了以下内容： 改善已有的文档。 -修改接口： +修改数据结构： -* [BatchRegisterTargets](https://cloud.tencent.com/document/api/214/38303) +* [StaffInfo](https://cloud.tencent.com/document/api/679/47715#StaffInfo) - * 新增出参：Message + * 新增成员：RoleId -* [CreateClsLogSet](https://cloud.tencent.com/document/api/214/46803) -修改数据结构： -* [Cluster](https://cloud.tencent.com/document/api/214/30694#Cluster) +## 日志服务(cls) 版本：2020-10-16 - * 新增成员：IPVersion +### 第 83 次发布 -* [ExtraInfo](https://cloud.tencent.com/document/api/214/30694#ExtraInfo) +发布时间：2024-03-07 01:11:18 - * **修改成员**：ZhiTong, TgwGroupName +本次发布包含了以下内容： -* [Listener](https://cloud.tencent.com/document/api/214/30694#Listener) +改善已有的文档。 - * 新增成员：RescheduleInterval +新增数据结构： -* [LoadBalancer](https://cloud.tencent.com/document/api/214/30694#LoadBalancer) +* [CollectConfig](https://cloud.tencent.com/document/api/614/56471#CollectConfig) +* [CollectInfo](https://cloud.tencent.com/document/api/614/56471#CollectInfo) -* [RsWeightRule](https://cloud.tencent.com/document/api/214/30694#RsWeightRule) +修改数据结构： -* [RuleOutput](https://cloud.tencent.com/document/api/214/30694#RuleOutput) +* [ConfigExtraInfo](https://cloud.tencent.com/document/api/614/56471#ConfigExtraInfo) - * **修改成员**：LocationId, SessionExpireTime, HealthCheck, Certificate, Scheduler + * 新增成员：CollectInfos -* [ZoneInfo](https://cloud.tencent.com/document/api/214/30694#ZoneInfo) +* [ConsumerContent](https://cloud.tencent.com/document/api/614/56471#ConsumerContent) - * **修改成员**：ZoneId, Zone, ZoneName, ZoneRegion, LocalZone, EdgeZone + * 新增成员：JsonType +* [LogInfo](https://cloud.tencent.com/document/api/614/56471#LogInfo) + * **修改成员**：RawLog, IndexStatus -## 专线接入(dc) 版本：2018-04-10 -### 第 25 次发布 -发布时间：2024-03-06 01:13:45 +## T-Sec-堡垒机（BH）(dasb) 版本：2019-10-18 -本次发布包含了以下内容： +### 第 24 次发布 -改善已有的文档。 +发布时间：2024-03-07 01:13:28 -修改接口： +本次发布包含了以下内容： -* [ModifyDirectConnectTunnelExtra](https://cloud.tencent.com/document/api/216/49100) +改善已有的文档。 - * 新增入参：TencentIPv6Address, TencentBackupIPv6Address, CustomerIPv6Address +新增接口： +* [ModifyOAuthSetting](https://cloud.tencent.com/document/api/1025/104132) -## 腾讯电子签企业版(ess) 版本：2020-11-11 +## 数据安全治理中心(dsgc) 版本：2019-07-23 -### 第 151 次发布 +### 第 7 次发布 -发布时间：2024-03-06 01:15:49 +发布时间：2024-03-07 01:14:47 本次发布包含了以下内容： 改善已有的文档。 -修改数据结构： +修改接口： -* [TemplateInfo](https://cloud.tencent.com/document/api/1323/70369#TemplateInfo) +* [CreateDSPASelfBuildMetaResource](https://cloud.tencent.com/document/api/1087/97178) - * 新增成员：CreatorId + * 新增入参：InstanceType, InstanceValue +* [DescribeDSPADataSourceDbInfo](https://cloud.tencent.com/document/api/1087/97216) + * 新增入参：DataSourceType +* [DescribeDSPAESDataAssetByComplianceId](https://cloud.tencent.com/document/api/1087/97144) -## 物联网智能视频服务(iotvideo) 版本：2021-11-25 + * 新增入参：BuildType, DataSourceType -### 第 29 次发布 +* [DescribeDSPARDBDataAssetByComplianceId](https://cloud.tencent.com/document/api/1087/97205) -发布时间：2024-03-06 01:17:55 + * 新增入参：BuildType -本次发布包含了以下内容： +* [ModifyDSPACOSTaskResult](https://cloud.tencent.com/document/api/1087/97197) -改善已有的文档。 + * 新增入参：FileName, BucketName, DataSourceId -新增接口： -* [DescribeP2PInfo](https://cloud.tencent.com/document/api/1131/104107) +修改数据结构： +* [DspaCOSDataAssetDetail](https://cloud.tencent.com/document/api/1087/96844#DspaCOSDataAssetDetail) + * 新增成员：IdentifyType, CheckStatus -## 物联网智能视频服务(iotvideo) 版本：2020-12-15 +* [DspaDiscoveryTaskDataSource](https://cloud.tencent.com/document/api/1087/96844#DspaDiscoveryTaskDataSource) + * 新增成员：DataSourceType +* [DspaUserResourceMeta](https://cloud.tencent.com/document/api/1087/96844#DspaUserResourceMeta) -## 物联网智能视频服务(iotvideo) 版本：2019-11-26 + * 新增成员：InstanceType, InstanceValue -## 消息队列 TDMQ(tdmq) 版本：2020-02-17 -### 第 103 次发布 +## 腾讯电子签企业版(ess) 版本：2020-11-11 -发布时间：2024-03-06 01:24:29 +### 第 152 次发布 + +发布时间：2024-03-07 01:16:07 本次发布包含了以下内容： @@ -122,11 +129,32 @@ 新增接口： -* [DescribeMsg](https://cloud.tencent.com/document/api/1179/104108) +* [DescribeSignFaceVideo](https://cloud.tencent.com/document/api/1323/104133) -### 第 102 次发布 +新增数据结构： -发布时间：2024-03-05 16:41:09 +* [DetectInfoVideoData](https://cloud.tencent.com/document/api/1323/70369#DetectInfoVideoData) +* [Intention](https://cloud.tencent.com/document/api/1323/70369#Intention) +* [IntentionAction](https://cloud.tencent.com/document/api/1323/70369#IntentionAction) +* [IntentionActionResult](https://cloud.tencent.com/document/api/1323/70369#IntentionActionResult) +* [IntentionActionResultDetail](https://cloud.tencent.com/document/api/1323/70369#IntentionActionResultDetail) +* [IntentionQuestion](https://cloud.tencent.com/document/api/1323/70369#IntentionQuestion) +* [IntentionQuestionResult](https://cloud.tencent.com/document/api/1323/70369#IntentionQuestionResult) + +修改数据结构： + +* [FlowCreateApprover](https://cloud.tencent.com/document/api/1323/70369#FlowCreateApprover) + + * 新增成员：Intention + + + + +## 腾讯电子签（基础版）(essbasic) 版本：2021-05-26 + +### 第 155 次发布 + +发布时间：2024-03-07 01:16:27 本次发布包含了以下内容： @@ -134,99 +162,100 @@ 新增接口： -* [DescribeMqMsgTrace](https://cloud.tencent.com/document/api/1179/104106) +* [ChannelDescribeSignFaceVideo](https://cloud.tencent.com/document/api/1420/104134) -**删除接口**： +新增数据结构： -* DeleteProClusters +* [DetectInfoVideoData](https://cloud.tencent.com/document/api/1420/61525#DetectInfoVideoData) +* [Intention](https://cloud.tencent.com/document/api/1420/61525#Intention) +* [IntentionAction](https://cloud.tencent.com/document/api/1420/61525#IntentionAction) +* [IntentionActionResult](https://cloud.tencent.com/document/api/1420/61525#IntentionActionResult) +* [IntentionActionResultDetail](https://cloud.tencent.com/document/api/1420/61525#IntentionActionResultDetail) +* [IntentionQuestion](https://cloud.tencent.com/document/api/1420/61525#IntentionQuestion) +* [IntentionQuestionResult](https://cloud.tencent.com/document/api/1420/61525#IntentionQuestionResult) -修改接口： +修改数据结构： -* [DescribeRabbitMQQueues](https://cloud.tencent.com/document/api/1179/100809) +* [FlowApproverInfo](https://cloud.tencent.com/document/api/1420/61525#FlowApproverInfo) - * **修改入参**：VirtualHost + * 新增成员：Intention -修改数据结构： -* [PulsarProClusterInfo](https://cloud.tencent.com/document/api/1179/46089#PulsarProClusterInfo) - * 新增成员：BillingLabelVersion +## 腾讯电子签（基础版）(essbasic) 版本：2020-12-22 - * **修改成员**：ClusterId, ClusterName, Remark, CreateTime, Status, Version, NodeDistribution, MaxStorage, CanEditRoute -* [PulsarProInstance](https://cloud.tencent.com/document/api/1179/46089#PulsarProInstance) - * 新增成员：BillingLabelVersion +## 消息队列 RocketMQ 版(trocket) 版本：2023-03-08 -* [RabbitMQQueueListInfo](https://cloud.tencent.com/document/api/1179/46089#RabbitMQQueueListInfo) +### 第 11 次发布 - * 新增成员：CreateTime, ModifyTime +发布时间：2024-03-07 01:26:39 -* [RabbitMQVipInstance](https://cloud.tencent.com/document/api/1179/46089#RabbitMQVipInstance) +本次发布包含了以下内容： - * 新增成员：PublicAccessEndpoint, Vpcs +改善已有的文档。 - * **修改成员**：ExceptionInformation, ClusterStatus +修改接口： +* [CreateInstance](https://cloud.tencent.com/document/api/1493/97868) + * 新增入参：PayMode, RenewFlag, TimeSpan, MaxTopicNum +* [CreateTopic](https://cloud.tencent.com/document/api/1493/97947) -## 边缘安全加速平台(teo) 版本：2022-09-01 + * 新增入参：MsgTTL -### 第 75 次发布 +* [DescribeTopic](https://cloud.tencent.com/document/api/1493/97945) -发布时间：2024-03-06 01:24:59 + * **修改入参**：Offset, Limit -本次发布包含了以下内容： + * 新增出参：MsgTTL -改善已有的文档。 +* [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) -新增接口： + * **修改入参**：Offset, Limit -* [CreateCLSIndex](https://cloud.tencent.com/document/api/1552/104113) -* [CreateRealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/104112) -* [DeleteRealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/104111) -* [DescribeRealtimeLogDeliveryTasks](https://cloud.tencent.com/document/api/1552/104110) -* [ModifyRealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/104109) +* [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865) -新增数据结构： + * 新增入参：MaxTopicNum -* [CLSTopic](https://cloud.tencent.com/document/api/1552/80721#CLSTopic) -* [CustomEndpoint](https://cloud.tencent.com/document/api/1552/80721#CustomEndpoint) -* [CustomField](https://cloud.tencent.com/document/api/1552/80721#CustomField) -* [DeliveryCondition](https://cloud.tencent.com/document/api/1552/80721#DeliveryCondition) -* [RealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/80721#RealtimeLogDeliveryTask) -* [S3](https://cloud.tencent.com/document/api/1552/80721#S3) +修改数据结构： +* [SubscriptionData](https://cloud.tencent.com/document/api/1493/96031#SubscriptionData) -## 边缘安全加速平台(teo) 版本：2022-01-06 + * 新增成员：MessageModel + * **修改成员**：InstanceId, Topic, TopicType, TopicQueueNum, ConsumerGroup, IsOnline, ConsumeType, SubString, ExpressionType, Consistency, ConsumerLag, LastUpdateTime, MaxRetryTimes, ConsumeMessageOrderly +* [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) -## 消息队列 RocketMQ 版(trocket) 版本：2023-03-08 + * 新增成员：ClusterIdV4, NamespaceV4, TopicV4, FullNamespaceV4, MsgTTL -### 第 10 次发布 -发布时间：2024-03-06 01:26:32 -本次发布包含了以下内容： -改善已有的文档。 +## 微服务引擎(tse) 版本：2020-12-07 -修改接口： +### 第 59 次发布 -* [DescribeInstance](https://cloud.tencent.com/document/api/1493/97866) +发布时间：2024-03-07 01:27:04 - * 新增出参：ScaledTpsEnabled, RenewFlag, ExpiryTime, RoleNumLimit, AclEnabled, TopicNumLowerLimit, TopicNumUpperLimit +本次发布包含了以下内容： +改善已有的文档。 修改数据结构： -* [Endpoint](https://cloud.tencent.com/document/api/1493/96031#Endpoint) +* [KongUpstreamInfo](https://cloud.tencent.com/document/api/1364/54942#KongUpstreamInfo) - * **修改成员**：Type, Status, PayMode, EndpointUrl, VpcId, SubnetId, Bandwidth, IpRules + * 新增成员：ScfCamAuthEnable + +* [UpstreamHealthCheckConfig](https://cloud.tencent.com/document/api/1364/54942#UpstreamHealthCheckConfig) + + * 新增成员：IgnoreZeroWeightNodes @@ -14889,6 +14918,21 @@ ## 云联络中心(ccc) 版本：2020-02-10 +### 第 61 次发布 + +发布时间：2024-03-07 01:09:17 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [StaffInfo](https://cloud.tencent.com/document/api/679/47715#StaffInfo) + + * 新增成员：RoleId + + ### 第 60 次发布 发布时间：2024-03-05 01:09:20 @@ -30272,6 +30316,34 @@ ## 日志服务(cls) 版本：2020-10-16 +### 第 83 次发布 + +发布时间：2024-03-07 01:11:18 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增数据结构： + +* [[CollectConfig](https://cloud.tencent.com/document/api/614/56471#CollectConfig)](https://cloud.tencent.com/document/api/614/56471#[CollectConfig](https://cloud.tencent.com/document/api/614/56471#CollectConfig)) +* [[CollectInfo](https://cloud.tencent.com/document/api/614/56471#CollectInfo)](https://cloud.tencent.com/document/api/614/56471#[CollectInfo](https://cloud.tencent.com/document/api/614/56471#CollectInfo)) + +修改数据结构： + +* [ConfigExtraInfo](https://cloud.tencent.com/document/api/614/56471#ConfigExtraInfo) + + * 新增成员：CollectInfos + +* [ConsumerContent](https://cloud.tencent.com/document/api/614/56471#ConsumerContent) + + * 新增成员：JsonType + +* [LogInfo](https://cloud.tencent.com/document/api/614/56471#LogInfo) + + * **修改成员**：RawLog, IndexStatus + + ### 第 82 次发布 发布时间：2024-03-01 01:12:07 @@ -44767,6 +44839,18 @@ ## T-Sec-堡垒机（BH）(dasb) 版本：2019-10-18 +### 第 24 次发布 + +发布时间：2024-03-07 01:13:28 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [[ModifyOAuthSetting](https://cloud.tencent.com/document/api/1025/104132)](https://cloud.tencent.com/document/api/#/#) + ### 第 23 次发布 发布时间：2024-01-24 01:26:26 @@ -51751,6 +51835,52 @@ ## 数据安全治理中心(dsgc) 版本：2019-07-23 +### 第 7 次发布 + +发布时间：2024-03-07 01:14:47 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateDSPASelfBuildMetaResource](https://cloud.tencent.com/document/api/1087/97178) + + * 新增入参：InstanceType, InstanceValue + +* [DescribeDSPADataSourceDbInfo](https://cloud.tencent.com/document/api/1087/97216) + + * 新增入参：DataSourceType + +* [DescribeDSPAESDataAssetByComplianceId](https://cloud.tencent.com/document/api/1087/97144) + + * 新增入参：BuildType, DataSourceType + +* [DescribeDSPARDBDataAssetByComplianceId](https://cloud.tencent.com/document/api/1087/97205) + + * 新增入参：BuildType + +* [ModifyDSPACOSTaskResult](https://cloud.tencent.com/document/api/1087/97197) + + * 新增入参：FileName, BucketName, DataSourceId + + +修改数据结构： + +* [DspaCOSDataAssetDetail](https://cloud.tencent.com/document/api/1087/96844#DspaCOSDataAssetDetail) + + * 新增成员：IdentifyType, CheckStatus + +* [DspaDiscoveryTaskDataSource](https://cloud.tencent.com/document/api/1087/96844#DspaDiscoveryTaskDataSource) + + * 新增成员：DataSourceType + +* [DspaUserResourceMeta](https://cloud.tencent.com/document/api/1087/96844#DspaUserResourceMeta) + + * 新增成员：InstanceType, InstanceValue + + ### 第 6 次发布 发布时间：2023-11-21 01:16:05 @@ -58687,6 +58817,35 @@ ## 腾讯电子签企业版(ess) 版本：2020-11-11 +### 第 152 次发布 + +发布时间：2024-03-07 01:16:07 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [[DescribeSignFaceVideo](https://cloud.tencent.com/document/api/1323/104133)](https://cloud.tencent.com/document/api/#/#) + +新增数据结构： + +* [[DetectInfoVideoData](https://cloud.tencent.com/document/api/1323/70369#DetectInfoVideoData)](https://cloud.tencent.com/document/api/1323/70369#[DetectInfoVideoData](https://cloud.tencent.com/document/api/1323/70369#DetectInfoVideoData)) +* [[Intention](https://cloud.tencent.com/document/api/1323/70369#Intention)](https://cloud.tencent.com/document/api/1323/70369#[Intention](https://cloud.tencent.com/document/api/1323/70369#Intention)) +* [[IntentionAction](https://cloud.tencent.com/document/api/1323/70369#IntentionAction)](https://cloud.tencent.com/document/api/1323/70369#[IntentionAction](https://cloud.tencent.com/document/api/1323/70369#IntentionAction)) +* [[IntentionActionResult](https://cloud.tencent.com/document/api/1323/70369#IntentionActionResult)](https://cloud.tencent.com/document/api/1323/70369#[IntentionActionResult](https://cloud.tencent.com/document/api/1323/70369#IntentionActionResult)) +* [[IntentionActionResultDetail](https://cloud.tencent.com/document/api/1323/70369#IntentionActionResultDetail)](https://cloud.tencent.com/document/api/1323/70369#[IntentionActionResultDetail](https://cloud.tencent.com/document/api/1323/70369#IntentionActionResultDetail)) +* [[IntentionQuestion](https://cloud.tencent.com/document/api/1323/70369#IntentionQuestion)](https://cloud.tencent.com/document/api/1323/70369#[IntentionQuestion](https://cloud.tencent.com/document/api/1323/70369#IntentionQuestion)) +* [[IntentionQuestionResult](https://cloud.tencent.com/document/api/1323/70369#IntentionQuestionResult)](https://cloud.tencent.com/document/api/1323/70369#[IntentionQuestionResult](https://cloud.tencent.com/document/api/1323/70369#IntentionQuestionResult)) + +修改数据结构： + +* [FlowCreateApprover](https://cloud.tencent.com/document/api/1323/70369#FlowCreateApprover) + + * 新增成员：Intention + + ### 第 151 次发布 发布时间：2024-03-06 01:15:49 @@ -61614,6 +61773,35 @@ ## 腾讯电子签（基础版）(essbasic) 版本：2021-05-26 +### 第 155 次发布 + +发布时间：2024-03-07 01:16:27 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [[ChannelDescribeSignFaceVideo](https://cloud.tencent.com/document/api/1420/104134)](https://cloud.tencent.com/document/api/#/#) + +新增数据结构： + +* [[DetectInfoVideoData](https://cloud.tencent.com/document/api/1420/61525#DetectInfoVideoData)](https://cloud.tencent.com/document/api/1420/61525#[DetectInfoVideoData](https://cloud.tencent.com/document/api/1420/61525#DetectInfoVideoData)) +* [[Intention](https://cloud.tencent.com/document/api/1420/61525#Intention)](https://cloud.tencent.com/document/api/1420/61525#[Intention](https://cloud.tencent.com/document/api/1420/61525#Intention)) +* [[IntentionAction](https://cloud.tencent.com/document/api/1420/61525#IntentionAction)](https://cloud.tencent.com/document/api/1420/61525#[IntentionAction](https://cloud.tencent.com/document/api/1420/61525#IntentionAction)) +* [[IntentionActionResult](https://cloud.tencent.com/document/api/1420/61525#IntentionActionResult)](https://cloud.tencent.com/document/api/1420/61525#[IntentionActionResult](https://cloud.tencent.com/document/api/1420/61525#IntentionActionResult)) +* [[IntentionActionResultDetail](https://cloud.tencent.com/document/api/1420/61525#IntentionActionResultDetail)](https://cloud.tencent.com/document/api/1420/61525#[IntentionActionResultDetail](https://cloud.tencent.com/document/api/1420/61525#IntentionActionResultDetail)) +* [[IntentionQuestion](https://cloud.tencent.com/document/api/1420/61525#IntentionQuestion)](https://cloud.tencent.com/document/api/1420/61525#[IntentionQuestion](https://cloud.tencent.com/document/api/1420/61525#IntentionQuestion)) +* [[IntentionQuestionResult](https://cloud.tencent.com/document/api/1420/61525#IntentionQuestionResult)](https://cloud.tencent.com/document/api/1420/61525#[IntentionQuestionResult](https://cloud.tencent.com/document/api/1420/61525#IntentionQuestionResult)) + +修改数据结构： + +* [FlowApproverInfo](https://cloud.tencent.com/document/api/1420/61525#FlowApproverInfo) + + * 新增成员：Intention + + ### 第 154 次发布 发布时间：2024-02-29 01:16:27 @@ -74636,7 +74824,7 @@ 新增接口： -* [[DescribeP2PInfo](https://cloud.tencent.com/document/api/1131/104107)](https://cloud.tencent.com/document/api/#/#) +* [DescribeP2PInfo](https://cloud.tencent.com/document/api/1131/104107) ### 第 28 次发布 @@ -114893,7 +115081,7 @@ 新增接口： -* [[DescribeMsg](https://cloud.tencent.com/document/api/1179/104108)](https://cloud.tencent.com/document/api/#/#) +* [DescribeMsg](https://cloud.tencent.com/document/api/1179/104108) ### 第 102 次发布 @@ -114905,7 +115093,7 @@ 新增接口： -* [[DescribeMqMsgTrace](https://cloud.tencent.com/document/api/1179/104106)](https://cloud.tencent.com/document/api/#/#) +* [DescribeMqMsgTrace](https://cloud.tencent.com/document/api/1179/104106) **删除接口**： @@ -119427,20 +119615,20 @@ 新增接口： -* [[CreateCLSIndex](https://cloud.tencent.com/document/api/1552/104113)](https://cloud.tencent.com/document/api/#/#) -* [[CreateRealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/104112)](https://cloud.tencent.com/document/api/#/#) -* [[DeleteRealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/104111)](https://cloud.tencent.com/document/api/#/#) -* [[DescribeRealtimeLogDeliveryTasks](https://cloud.tencent.com/document/api/1552/104110)](https://cloud.tencent.com/document/api/#/#) -* [[ModifyRealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/104109)](https://cloud.tencent.com/document/api/#/#) +* [CreateCLSIndex](https://cloud.tencent.com/document/api/1552/104113) +* [CreateRealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/104112) +* [DeleteRealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/104111) +* [DescribeRealtimeLogDeliveryTasks](https://cloud.tencent.com/document/api/1552/104110) +* [ModifyRealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/104109) 新增数据结构： -* [[CLSTopic](https://cloud.tencent.com/document/api/1552/80721#CLSTopic)](https://cloud.tencent.com/document/api/1552/80721#[CLSTopic](https://cloud.tencent.com/document/api/1552/80721#CLSTopic)) -* [[CustomEndpoint](https://cloud.tencent.com/document/api/1552/80721#CustomEndpoint)](https://cloud.tencent.com/document/api/1552/80721#[CustomEndpoint](https://cloud.tencent.com/document/api/1552/80721#CustomEndpoint)) -* [[CustomField](https://cloud.tencent.com/document/api/1552/80721#CustomField)](https://cloud.tencent.com/document/api/1552/80721#[CustomField](https://cloud.tencent.com/document/api/1552/80721#CustomField)) -* [[DeliveryCondition](https://cloud.tencent.com/document/api/1552/80721#DeliveryCondition)](https://cloud.tencent.com/document/api/1552/80721#[DeliveryCondition](https://cloud.tencent.com/document/api/1552/80721#DeliveryCondition)) -* [[RealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/80721#RealtimeLogDeliveryTask)](https://cloud.tencent.com/document/api/1552/80721#[RealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/80721#RealtimeLogDeliveryTask)) -* [[S3](https://cloud.tencent.com/document/api/1552/80721#S3)](https://cloud.tencent.com/document/api/1552/80721#[S3](https://cloud.tencent.com/document/api/1552/80721#S3)) +* [CLSTopic](https://cloud.tencent.com/document/api/1552/80721#CLSTopic) +* [CustomEndpoint](https://cloud.tencent.com/document/api/1552/80721#CustomEndpoint) +* [CustomField](https://cloud.tencent.com/document/api/1552/80721#CustomField) +* [DeliveryCondition](https://cloud.tencent.com/document/api/1552/80721#DeliveryCondition) +* [RealtimeLogDeliveryTask](https://cloud.tencent.com/document/api/1552/80721#RealtimeLogDeliveryTask) +* [S3](https://cloud.tencent.com/document/api/1552/80721#S3) ### 第 74 次发布 @@ -129533,6 +129721,52 @@ ## 消息队列 RocketMQ 版(trocket) 版本：2023-03-08 +### 第 11 次发布 + +发布时间：2024-03-07 01:26:39 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateInstance](https://cloud.tencent.com/document/api/1493/97868) + + * 新增入参：PayMode, RenewFlag, TimeSpan, MaxTopicNum + +* [CreateTopic](https://cloud.tencent.com/document/api/1493/97947) + + * 新增入参：MsgTTL + +* [DescribeTopic](https://cloud.tencent.com/document/api/1493/97945) + + * **修改入参**：Offset, Limit + + * 新增出参：MsgTTL + +* [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) + + * **修改入参**：Offset, Limit + +* [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865) + + * 新增入参：MaxTopicNum + + +修改数据结构： + +* [SubscriptionData](https://cloud.tencent.com/document/api/1493/96031#SubscriptionData) + + * 新增成员：MessageModel + + * **修改成员**：InstanceId, Topic, TopicType, TopicQueueNum, ConsumerGroup, IsOnline, ConsumeType, SubString, ExpressionType, Consistency, ConsumerLag, LastUpdateTime, MaxRetryTimes, ConsumeMessageOrderly + +* [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) + + * 新增成员：ClusterIdV4, NamespaceV4, TopicV4, FullNamespaceV4, MsgTTL + + ### 第 10 次发布 发布时间：2024-03-06 01:26:32 @@ -131836,6 +132070,25 @@ ## 微服务引擎(tse) 版本：2020-12-07 +### 第 59 次发布 + +发布时间：2024-03-07 01:27:04 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [KongUpstreamInfo](https://cloud.tencent.com/document/api/1364/54942#KongUpstreamInfo) + + * 新增成员：ScfCamAuthEnable + +* [UpstreamHealthCheckConfig](https://cloud.tencent.com/document/api/1364/54942#UpstreamHealthCheckConfig) + + * 新增成员：IgnoreZeroWeightNodes + + ### 第 58 次发布 发布时间：2024-03-04 01:26:55 diff --git a/products.md b/products.md index 481c2944a0..817c1447e8 100644 --- a/products.md +++ b/products.md @@ -15,7 +15,7 @@ | ape | [正版图库直通车](https://cloud.tencent.com/document/product/1181) | 2022-04-04 06:05:40 | | api | [云 API](https://cloud.tencent.com/document/product/1278) | 2023-01-05 01:02:52 | | apigateway | [API 网关](https://cloud.tencent.com/document/product/628) | 2024-01-31 01:06:22 | -| apm | [应用性能监控](https://cloud.tencent.com/document/product/1463) | 2024-03-05 15:10:32 | +| apm | [应用性能监控](https://cloud.tencent.com/document/product/1463) | 2024-03-06 10:02:39 | | as | [弹性伸缩](https://cloud.tencent.com/document/product/377) | 2024-02-22 01:07:53 | | asr | [语音识别](https://cloud.tencent.com/document/product/1093) | 2024-02-23 01:07:51 | | asw | [应用与服务编排工作流](https://cloud.tencent.com/document/product/1272) | 2023-05-18 01:04:02 | @@ -39,8 +39,8 @@ | car | [应用云渲染](https://cloud.tencent.com/document/product/1547) | 2024-02-05 01:08:13 | | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2023-12-29 01:09:11 | | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2023-12-27 01:08:57 | -| ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2024-03-05 01:09:20 | -| cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2024-03-01 01:10:05 | +| ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2024-03-07 01:09:17 | +| cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2024-03-07 01:09:26 | | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2024-01-15 01:08:17 | | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2024-03-05 01:09:53 | | cds | [T-Sec-数据安全审计（DSA）](https://cloud.tencent.com/document/product/856) | 2024-01-24 01:23:26 | @@ -56,11 +56,11 @@ | cim | [](https://cloud.tencent.com/document/product) | 2019-05-16 17:21:18 | | cis | [](https://cloud.tencent.com/document/product) | 2018-06-07 15:01:42 | | ckafka | [消息队列 CKafka 版](https://cloud.tencent.com/document/product/597) | 2024-03-04 01:10:58 | -| clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2024-03-06 01:10:51 | +| clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2024-03-07 01:10:58 | | cloudaudit | [操作审计](https://cloud.tencent.com/document/product/629) | 2024-01-15 01:09:37 | | cloudhsm | [云加密机](https://cloud.tencent.com/document/product/639) | 2024-02-29 01:11:23 | | cloudstudio | [Cloud Studio（云端 IDE）](https://cloud.tencent.com/document/product/1039) | 2023-08-03 01:03:28 | -| cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2024-03-01 01:12:07 | +| cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2024-03-07 01:11:18 | | cme | [多媒体创作引擎](https://cloud.tencent.com/document/product/1156) | 2023-12-05 01:27:33 | | cmq | [消息队列 CMQ](https://cloud.tencent.com/document/product/406) | 2023-08-17 02:03:39 | | cms | [内容安全](https://cloud.tencent.com/document/product/669) | 2023-08-24 01:10:10 | @@ -70,10 +70,10 @@ | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2024-03-04 01:11:59 | | csxg | [5G入云服务](https://cloud.tencent.com/document/product/1687) | 2023-05-19 11:26:14 | | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2024-03-06 01:11:54 | -| cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-02-29 01:12:25 | +| cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-03-07 01:12:14 | | 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-01 01:13:53 | -| dasb | [T-Sec-堡垒机（BH）](https://cloud.tencent.com/document/product/1025) | 2024-01-24 01:26:26 | +| dasb | [T-Sec-堡垒机（BH）](https://cloud.tencent.com/document/product/1025) | 2024-03-07 01:13:28 | | dataintegration | [数据接入平台](https://cloud.tencent.com/document/product/1591) | 2022-07-26 15:32:15 | | dayu | [DDoS 高防包](https://cloud.tencent.com/document/product/1021) | 2023-05-18 01:20:11 | | dbbrain | [数据库智能管家 DBbrain](https://cloud.tencent.com/document/product/1130) | 2024-01-16 01:12:56 | @@ -81,11 +81,11 @@ | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2024-03-06 01:13:45 | | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2023-10-30 00:33:47 | | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2024-02-29 01:14:14 | -| dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2024-03-05 01:14:22 | +| dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2024-03-07 01:14:20 | | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2024-02-29 01:14:41 | | drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2023-11-10 01:14:28 | | ds | [文档服务](https://cloud.tencent.com/document/product/869) | 2023-08-17 02:59:40 | -| dsgc | [数据安全治理中心](https://cloud.tencent.com/document/product/1087) | 2023-11-29 01:53:04 | +| dsgc | [数据安全治理中心](https://cloud.tencent.com/document/product/1087) | 2024-03-07 01:14:47 | | dtf | [分布式事务](https://cloud.tencent.com/document/product/1224) | 2022-04-04 06:38:57 | | dts | [数据传输服务](https://cloud.tencent.com/document/product/571) | 2024-02-23 01:14:38 | | eb | [事件总线](https://cloud.tencent.com/document/product/1359) | 2024-01-17 01:14:14 | @@ -96,8 +96,8 @@ | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 | | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2024-02-28 01:16:01 | | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2024-01-25 01:13:20 | -| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-03-06 01:15:49 | -| essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2024-03-05 01:16:12 | +| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-03-07 01:16:07 | +| essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2024-03-07 01:16:27 | | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-12-15 19:41:44 | | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-02-22 01:16:11 | | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2024-02-28 01:16:53 | @@ -154,7 +154,7 @@ | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2023-09-15 02:14:19 | | npp | [号码保护](https://cloud.tencent.com/document/product) | 2020-04-22 08:00:22 | | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2024-01-19 01:18:01 | -| ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2024-02-21 01:20:39 | +| ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2024-03-07 01:21:02 | | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2024-03-04 01:21:08 | | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2024-02-29 01:21:30 | | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2024-01-23 01:25:29 | @@ -202,10 +202,10 @@ | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2024-02-02 01:21:42 | | tdcpg | [TDSQL-C PostgreSQL 版](https://cloud.tencent.com/document/product/1556) | 2023-06-21 01:36:25 | | tdid | [分布式身份](https://cloud.tencent.com/document/product/1439) | 2024-01-23 01:28:41 | -| tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2024-03-06 01:24:29 | +| tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2024-03-07 01:24:49 | | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2023-11-15 02:26:59 | | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2023-12-20 02:13:36 | -| teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-03-06 01:24:59 | +| teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-03-06 17:57:27 | | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2024-02-21 01:25:12 | | 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 | @@ -221,11 +221,11 @@ | tmt | [机器翻译](https://cloud.tencent.com/document/product/551) | 2024-02-22 01:26:17 | | tourism | [文旅客情大数据](https://cloud.tencent.com/document/product/1684) | 2023-08-10 01:43:37 | | trdp | [流量风险决策平台](https://cloud.tencent.com/document/product/1604) | 2023-05-18 02:01:19 | -| trocket | [消息队列 RocketMQ 版](https://cloud.tencent.com/document/product/1493) | 2024-03-06 01:26:32 | +| trocket | [消息队列 RocketMQ 版](https://cloud.tencent.com/document/product/1493) | 2024-03-07 01:26:39 | | trp | [T-Sec-安心平台(RP)](https://cloud.tencent.com/document/product/1458) | 2024-03-04 01:26:24 | | trro | [远程实时操控](https://cloud.tencent.com/document/product/1584) | 2024-01-31 01:25:41 | -| trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2024-03-04 01:26:49 | -| tse | [微服务引擎](https://cloud.tencent.com/document/product/1364) | 2024-03-04 01:26:55 | +| trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2024-03-07 01:26:57 | +| tse | [微服务引擎](https://cloud.tencent.com/document/product/1364) | 2024-03-07 01:27:04 | | tsf | [微服务平台 TSF](https://cloud.tencent.com/document/product/649) | 2024-02-23 01:26:28 | | tsw | [微服务观测平台 TSW](https://cloud.tencent.com/document/product/1311) | 2023-05-18 02:04:00 | | tts | [语音合成](https://cloud.tencent.com/document/product/1073) | 2023-11-27 00:22:20 | @@ -233,9 +233,9 @@ | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2023-12-22 01:27:31 | | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2023-08-17 05:50:56 | | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2024-03-01 01:28:03 | -| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2024-01-30 01:27:12 | +| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2024-03-07 01:28:21 | | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-11-27 00:23:42 | -| waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2024-03-05 01:29:14 | +| waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2024-03-07 01:28:58 | | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-11-15 02:42:49 | | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2024-03-05 01:29:38 | | weilingwith | [微瓴同业开放平台](https://cloud.tencent.com/document/product/1693) | 2024-01-31 01:28:56 | diff --git a/pyproject.toml b/pyproject.toml index 8a7e3ad9cc..a0ecac45b6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "tccli" -version = "3.0.1069.1" +version = "3.0.1070.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.1069", + "tencentcloud-sdk-python>=3.0.1070", ] [project.urls] diff --git a/tccli/__init__.py b/tccli/__init__.py index e83c5d31e7..5b0662f2f6 100644 --- a/tccli/__init__.py +++ b/tccli/__init__.py @@ -1 +1 @@ -__version__ = '3.0.1069.1' +__version__ = '3.0.1070.1' diff --git a/tccli/examples/ccc/v20200210/DescribeStaffInfoList.md b/tccli/examples/ccc/v20200210/DescribeStaffInfoList.md index 350727fbc9..59628507e3 100644 --- a/tccli/examples/ccc/v20200210/DescribeStaffInfoList.md +++ b/tccli/examples/ccc/v20200210/DescribeStaffInfoList.md @@ -26,6 +26,7 @@ Output: "Phone": "008617636049517", "Nick": "测试3", "StaffNumber": "125", + "RoleId": 1, "SkillGroupList": [ { "SkillGroupId": 53, diff --git a/tccli/examples/clb/v20180317/DescribeLoadBalancersDetail.md b/tccli/examples/clb/v20180317/DescribeLoadBalancersDetail.md index 1c0378d7de..e219731699 100644 --- a/tccli/examples/clb/v20180317/DescribeLoadBalancersDetail.md +++ b/tccli/examples/clb/v20180317/DescribeLoadBalancersDetail.md @@ -6,17 +6,243 @@ Input: ``` tccli clb DescribeLoadBalancersDetail --cli-unfold-argument \ - --Limit 20 \ - --Offset 0 + --Limit 2 \ + --Offset 5 ``` Output: ``` { "Response": { - "TotalCount": 0, - "LoadBalancerDetailSet": [], - "RequestId": "d09b91ba-a81e-4ca3-b423-c64e60127c64" + "LoadBalancerDetailSet": [ + { + "LoadBalancerId": "lb-42ua7vc4", + "LoadBalancerName": "lb-65e19dc1-Swzo", + "LoadBalancerDomain": "lb-42ua7vc4-*****8.clb.ap-guangzhou.com", + "Status": 1, + "Isolation": 0, + "Address": null, + "AddressIPv6": null, + "AddressIPVersion": "IPv4", + "IPv6Mode": null, + "Zone": "ap-guangzhou-2", + "Zones": null, + "SlaveZone": null, + "LoadBalancerType": "Public", + "AddressIsp": null, + "VpcId": "vpc-1yxy51wh", + "ChargeType": "POSTPAID_BY_HOUR", + "NetworkAttributes": { + "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR", + "InternetMaxBandwidthOut": 6, + "BandwidthpkgSubType": null + }, + "PrepaidAttributes": null, + "ProjectId": 0, + "SecurityGroup": null, + "LoadBalancerPassToTarget": 0, + "Tags": null, + "ExtraInfo": null, + "ConfigId": null, + "CreateTime": "2024-03-05 22:08:01", + "ListenerId": null, + "Protocol": null, + "Port": null, + "SniSwitch": null, + "LocationId": null, + "Domain": null, + "Domains": null, + "Url": null, + "TargetId": null, + "TargetAddress": null, + "TargetPort": null, + "TargetWeight": null, + "TargetHealth": null, + "Egress": "" + }, + { + "LoadBalancerId": "lb-5e5gta0w", + "LoadBalancerName": "lb-65e19e54-4rzS", + "LoadBalancerDomain": "lb-5e5gta0w-*******.clb.ap-guangzhou.com", + "Status": 1, + "Isolation": 0, + "Address": null, + "AddressIPv6": null, + "AddressIPVersion": "IPv4", + "IPv6Mode": null, + "Zone": "ap-guangzhou-2", + "Zones": null, + "SlaveZone": null, + "LoadBalancerType": "Public", + "AddressIsp": null, + "VpcId": "vpc-1yxy51wh", + "ChargeType": "POSTPAID_BY_HOUR", + "NetworkAttributes": { + "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR", + "InternetMaxBandwidthOut": 6, + "BandwidthpkgSubType": null + }, + "PrepaidAttributes": null, + "ProjectId": 0, + "SecurityGroup": null, + "LoadBalancerPassToTarget": 0, + "Tags": null, + "ExtraInfo": null, + "ConfigId": null, + "CreateTime": "2024-03-05 22:10:28", + "ListenerId": null, + "Protocol": null, + "Port": null, + "SniSwitch": null, + "LocationId": null, + "Domain": null, + "Domains": null, + "Url": null, + "TargetId": null, + "TargetAddress": null, + "TargetPort": null, + "TargetWeight": null, + "TargetHealth": null, + "Egress": "" + }, + { + "LoadBalancerId": "lb-7pqspi5i", + "LoadBalancerName": "lb-65e19f3e-R6qu", + "LoadBalancerDomain": "lb-7pqspi5i-********.clb.ap-guangzhou..com", + "Status": 1, + "Isolation": 0, + "Address": null, + "AddressIPv6": null, + "AddressIPVersion": "IPv4", + "IPv6Mode": null, + "Zone": "ap-guangzhou-2", + "Zones": null, + "SlaveZone": null, + "LoadBalancerType": "Public", + "AddressIsp": null, + "VpcId": "vpc-1yxy51wh", + "ChargeType": "POSTPAID_BY_HOUR", + "NetworkAttributes": { + "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR", + "InternetMaxBandwidthOut": 6, + "BandwidthpkgSubType": null + }, + "PrepaidAttributes": null, + "ProjectId": 0, + "SecurityGroup": null, + "LoadBalancerPassToTarget": 0, + "Tags": null, + "ExtraInfo": null, + "ConfigId": null, + "CreateTime": "2024-03-05 22:14:23", + "ListenerId": null, + "Protocol": null, + "Port": null, + "SniSwitch": null, + "LocationId": null, + "Domain": null, + "Domains": null, + "Url": null, + "TargetId": null, + "TargetAddress": null, + "TargetPort": null, + "TargetWeight": null, + "TargetHealth": null, + "Egress": "" + }, + { + "LoadBalancerId": "lb-av9bugwy", + "LoadBalancerName": "lb-65e19f53-HOij", + "LoadBalancerDomain": "lb-av9bugwy-*****.clb.ap-guangzhou.com", + "Status": 1, + "Isolation": 0, + "Address": null, + "AddressIPv6": null, + "AddressIPVersion": "IPv4", + "IPv6Mode": null, + "Zone": "ap-guangzhou-2", + "Zones": null, + "SlaveZone": null, + "LoadBalancerType": "Public", + "AddressIsp": null, + "VpcId": "vpc-1yxy51wh", + "ChargeType": "POSTPAID_BY_HOUR", + "NetworkAttributes": { + "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR", + "InternetMaxBandwidthOut": 6, + "BandwidthpkgSubType": null + }, + "PrepaidAttributes": null, + "ProjectId": 0, + "SecurityGroup": null, + "LoadBalancerPassToTarget": 0, + "Tags": null, + "ExtraInfo": null, + "ConfigId": null, + "CreateTime": "2024-03-05 22:14:45", + "ListenerId": null, + "Protocol": null, + "Port": null, + "SniSwitch": null, + "LocationId": null, + "Domain": null, + "Domains": null, + "Url": null, + "TargetId": null, + "TargetAddress": null, + "TargetPort": null, + "TargetWeight": null, + "TargetHealth": null, + "Egress": "" + }, + { + "LoadBalancerId": "lb-0s4e1oww", + "LoadBalancerName": "lb-65e5692e-a8pT", + "LoadBalancerDomain": "lb-0s4e1oww-*********.clb.ap-guangzhou.com", + "Status": 1, + "Isolation": 0, + "Address": null, + "AddressIPv6": null, + "AddressIPVersion": "IPv4", + "IPv6Mode": null, + "Zone": "ap-guangzhou-2", + "Zones": null, + "SlaveZone": null, + "LoadBalancerType": "Public", + "AddressIsp": null, + "VpcId": "vpc-1yxy51wh", + "ChargeType": "POSTPAID_BY_HOUR", + "NetworkAttributes": { + "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR", + "InternetMaxBandwidthOut": 5, + "BandwidthpkgSubType": null + }, + "PrepaidAttributes": null, + "ProjectId": 0, + "SecurityGroup": null, + "LoadBalancerPassToTarget": 0, + "Tags": null, + "ExtraInfo": null, + "ConfigId": null, + "CreateTime": "2024-03-05 19:12:19", + "ListenerId": null, + "Protocol": null, + "Port": null, + "SniSwitch": null, + "LocationId": null, + "Domain": null, + "Domains": null, + "Url": null, + "TargetId": null, + "TargetAddress": null, + "TargetPort": null, + "TargetWeight": null, + "TargetHealth": null, + "Egress": "" + } + ], + "TotalCount": 16, + "RequestId": "1626ec6f-f87e-476c-a9f3-ac3a87a5f3e6" } } ``` diff --git a/tccli/examples/cls/v20201016/CreateConsumer.md b/tccli/examples/cls/v20201016/CreateConsumer.md index e442accc8d..66f8a9ff3d 100644 --- a/tccli/examples/cls/v20201016/CreateConsumer.md +++ b/tccli/examples/cls/v20201016/CreateConsumer.md @@ -1,6 +1,6 @@ -**Example 1: 创建投递任务** - +**Example 1: 创建投递Ckafka任务** +CLS 日志投递Ckafka之后，您可以对日志进行实时计算后入库。 Input: diff --git a/tccli/examples/cls/v20201016/CreateKafkaRecharge.md b/tccli/examples/cls/v20201016/CreateKafkaRecharge.md index 909b652f42..25858ed34f 100644 --- a/tccli/examples/cls/v20201016/CreateKafkaRecharge.md +++ b/tccli/examples/cls/v20201016/CreateKafkaRecharge.md @@ -14,14 +14,13 @@ tccli cls CreateKafkaRecharge --cli-unfold-argument \ --UserKafkaTopics topic-1212123123,topic-sadf5r32f3ww \ --ConsumerGroupName consumer-group-name \ --Offset -1 \ - --LogRechargeRule.RechargeType json_log \ - --LogRechargeRule.TimeKey abc \ - --LogRechargeRule.TimeFormat abc \ - --LogRechargeRule.LogRegex abc \ - --LogRechargeRule.UnMatchLogSwitch True \ - --LogRechargeRule.UnMatchLogKey abc \ + --LogRechargeRule.DefaultTimeSrc 0 \ --LogRechargeRule.DefaultTimeSwitch True \ --LogRechargeRule.EncodingFormat 0 \ + --LogRechargeRule.RechargeType minimalist_log \ + --LogRechargeRule.UnMatchLogKey LogParseFailure \ + --LogRechargeRule.UnMatchLogSwitch True \ + --LogRechargeRule.UnMatchLogTimeSrc 0 \ --Protocol.Protocol plaintext ``` diff --git a/tccli/examples/cls/v20201016/DescribeConfigExtras.md b/tccli/examples/cls/v20201016/DescribeConfigExtras.md index c967906466..153d3d27b7 100644 --- a/tccli/examples/cls/v20201016/DescribeConfigExtras.md +++ b/tccli/examples/cls/v20201016/DescribeConfigExtras.md @@ -19,6 +19,29 @@ Output: "Configs": [ { "AdvancedConfig": "{\"ClsAgentFileTimeout\":3600}", + "CollectInfos": [ + { + "CollectConfigs": [ + { + "Name": "container_name" + }, + { + "Name": "namespace" + }, + { + "Name": "pod_name" + }, + { + "Name": "pod_ip" + } + ], + "Type": 0 + }, + { + "CollectConfigs": [], + "Type": 1 + } + ], "ConfigExtraId": "26ea1681-dfef-4429-a84f-3450d5d46796", "ConfigFlag": "label_k8s", "ContainerFile": { diff --git a/tccli/examples/cls/v20201016/DescribeDashboards.md b/tccli/examples/cls/v20201016/DescribeDashboards.md index 7b4f8da4a8..ada3864932 100644 --- a/tccli/examples/cls/v20201016/DescribeDashboards.md +++ b/tccli/examples/cls/v20201016/DescribeDashboards.md @@ -1,4 +1,4 @@ -**Example 1: 获取仪表盘** +**Example 1: 示例一** 获取仪表盘 @@ -42,3 +42,51 @@ Output: } ``` +**Example 2: 示例二** + +获取仪表盘 + +Input: + +``` +tccli cls DescribeDashboards --cli-unfold-argument \ + --Offset 0 \ + --Limit 20 \ + --Filters.0.Key tag:bowww-tag-key \ + --Filters.0.Values bowww-tag-value +``` + +Output: +``` +{ + "Response": { + "TotalCount": 1, + "DashboardInfos": [ + { + "DashboardId": "dashboard-47bf0f13-279c-461f-bb78-5b60229177ea", + "DashboardName": "API-TEST2", + "Data": "", + "CreateTime": "2023-07-05 20:46:25", + "UpdateTime": "2023-08-25 11:18:18", + "DashboardRegion": "", + "DashboardTopicInfos": [], + "AssumerUin": 0, + "RoleName": "", + "AssumerName": "", + "Tags": [ + { + "Key": "bowww-tag-key", + "Value": "bowww-tag-value" + }, + { + "Key": "bowww-tag-key1", + "Value": "bowww-tag-value1" + } + ] + } + ], + "RequestId": "6bf3355c-3c88-4566-89c8-76c3ca37bae9" + } +} +``` + diff --git a/tccli/examples/cls/v20201016/DescribeKafkaRecharges.md b/tccli/examples/cls/v20201016/DescribeKafkaRecharges.md index bdbbb9a3f6..a59bc3bbb2 100644 --- a/tccli/examples/cls/v20201016/DescribeKafkaRecharges.md +++ b/tccli/examples/cls/v20201016/DescribeKafkaRecharges.md @@ -16,29 +16,50 @@ Output: "Response": { "Infos": [ { - "Id": "abc", - "TopicId": "abc", - "Name": "abc", - "ServerAddr": "test.cls.tencentyun.com:9095", - "UserKafkaTopics": "topic1,topic2", + "Id": "86076b49-1234-4321-ab09-a5d7e7972825", + "TopicId": "957f4aed-1234-4321-b98b-c3c806f9e71b", + "Name": "task-test", + "KafkaType": 1, + "KafkaInstance": "", + "ServerAddr": "kafkaconsumer-ap-chongqing.aaa.com:1234", + "IsEncryptionAddr": true, + "Protocol": { + "Protocol": "sasl_plaintext", + "Mechanism": "PLAIN", + "UserName": "1234567-8146-461f-a951-348c4748f63d", + "Password": "AKIDxxxxx#abcdefjxxxx" + }, + "UserKafkaTopics": "1256238147-f3061593-cd5b-4321-1234-3ba507d43301", "ConsumerGroupName": "", "Status": 1, - "CreateTime": "abc", - "UpdateTime": "abc", + "Offset": -2, + "CreateTime": "2023-04-03 19:46:52", + "UpdateTime": "2023-04-04 11:41:54", "LogRechargeRule": { "RechargeType": "json_log", - "TimeKey": "abc", - "TimeFormat": "abc", - "LogRegex": "abc", + "LogRegex": "", "UnMatchLogSwitch": true, - "UnMatchLogKey": "abc", + "UnMatchLogKey": "LogParseFailure", + "UnMatchLogTimeSrc": 0, "EncodingFormat": 0, - "DefaultTimeSwitch": true + "DefaultTimeSwitch": true, + "DefaultTimeSrc": 0, + "TimeKey": "", + "TimeRegex": "", + "TimeFormat": "", + "TimeZone": "UTC-11:00", + "Metadata": [ + "kafka_topic", + "kafka_partition", + "kafka_offset", + "kafka_timestamp" + ], + "Keys": [] } } ], "TotalCount": 1, - "RequestId": "abc" + "RequestId": "7101f52f-a442-475b-90a3-4855133fefbf" } } ``` diff --git a/tccli/examples/cls/v20201016/ModifyConsumer.md b/tccli/examples/cls/v20201016/ModifyConsumer.md index 5502198014..1cad75d486 100644 --- a/tccli/examples/cls/v20201016/ModifyConsumer.md +++ b/tccli/examples/cls/v20201016/ModifyConsumer.md @@ -1,6 +1,6 @@ -**Example 1: 修改投递任务** - +**Example 1: 修改投递Ckafka任务** +修改投递Ckafka任务 Input: diff --git a/tccli/examples/cls/v20201016/PreviewKafkaRecharge.md b/tccli/examples/cls/v20201016/PreviewKafkaRecharge.md index 9a86127286..544c4696ea 100644 --- a/tccli/examples/cls/v20201016/PreviewKafkaRecharge.md +++ b/tccli/examples/cls/v20201016/PreviewKafkaRecharge.md @@ -11,7 +11,7 @@ tccli cls PreviewKafkaRecharge --cli-unfold-argument \ --ServerAddr test.cls.tencentyun.com:9095 \ --IsEncryptionAddr False \ --UserKafkaTopics topic1,topic2 \ - --Offset 0 \ + --Offset -1 \ --LogRechargeRule.RechargeType json_log \ --LogRechargeRule.TimeKey abc \ --LogRechargeRule.TimeFormat abc \ diff --git a/tccli/examples/cwp/v20180228/DeleteMachine.md b/tccli/examples/cwp/v20180228/DeleteMachine.md index 70ac858a83..9633393e17 100644 --- a/tccli/examples/cwp/v20180228/DeleteMachine.md +++ b/tccli/examples/cwp/v20180228/DeleteMachine.md @@ -1,6 +1,6 @@ **Example 1: 卸载客户端** -本接口（DeleteMachine）用于卸载云镜客户端。 +本接口（DeleteMachine）用于卸载主机安全客户端。 Input: diff --git a/tccli/examples/cwp/v20180228/DescribeLogKafkaDeliverInfo.md b/tccli/examples/cwp/v20180228/DescribeLogKafkaDeliverInfo.md index 9c3bae9583..4ec8f9425f 100644 --- a/tccli/examples/cwp/v20180228/DescribeLogKafkaDeliverInfo.md +++ b/tccli/examples/cwp/v20180228/DescribeLogKafkaDeliverInfo.md @@ -11,39 +11,34 @@ Output: ``` { "Response": { - "AccessAddr": "100.119.167.50:6281", - "AccessType": 2, - "Az": "广州三区", - "BandWidth": 0, + "KafkaEnvName": "abc", + "KafkaId": "abc", + "Zone": "abc", + "Az": "abc", + "VpcId": "abc", + "SubnetId": "abc", + "AccessType": 1, + "AccessAddr": "abc", "DeliverStatus": 1, + "InsVersion": "abc", + "BandWidth": 0, + "DiskSize": 0, + "Username": "abc", "DeliverTypeDetails": [ { "SecurityType": 1, "LogType": [ - 1, - 2, - 3, - 4, - 5, - 6, - 7 + 0 ], - "TopicId": "topic-p9d8q5tm", - "TopicName": "test", + "TopicId": "abc", + "TopicName": "abc", "Switch": 1, - "Status": 0, - "ErrInfo": " " + "Status": 1, + "ErrInfo": "abc", + "StatusTime": 0 } ], - "DiskSize": 0, - "InsVersion": "0.10.2.1", - "KafkaEnvName": "云镜测试环境", - "KafkaId": "ckafka-ce80kte5", - "RequestId": "33e0611b-d363-4727-a7d6-ca405225bd52", - "SubnetId": "-", - "Username": "yunjing2", - "VpcId": "-", - "Zone": "广州" + "RequestId": "abc" } } ``` diff --git a/tccli/examples/cwp/v20180228/ModifyLogKafkaAccess.md b/tccli/examples/cwp/v20180228/ModifyLogKafkaAccess.md index 9ef9b5e90f..1100bc5ebf 100644 --- a/tccli/examples/cwp/v20180228/ModifyLogKafkaAccess.md +++ b/tccli/examples/cwp/v20180228/ModifyLogKafkaAccess.md @@ -12,20 +12,20 @@ tccli cwp ModifyLogKafkaAccess --cli-unfold-argument \ --KafkaId aa \ --InsVersion 1.1.1 \ --AccessType 1 \ - --KafkaEnvName 云镜测试环境 \ + --KafkaEnvName 主机安全测试环境 \ --BandWidth 300 \ --AccessAddr 1.1.1.1 \ --Pwd b \ --DiskSize 400 \ --SubnetId 1.1.1.1 \ --DeliverTypeDetails.0.Status 0 \ - --DeliverTypeDetails.0.TopicId xx \ + --DeliverTypeDetails.0.TopicId 11 \ --DeliverTypeDetails.0.SecurityType 1 \ --DeliverTypeDetails.0.LogType 1 \ --DeliverTypeDetails.0.Switch 0 \ --DeliverTypeDetails.0.StatusTime 11 \ - --DeliverTypeDetails.0.TopicName xx \ - --DeliverTypeDetails.0.ErrInfo x \ + --DeliverTypeDetails.0.TopicName 11 \ + --DeliverTypeDetails.0.ErrInfo 1 \ --Az 广州三区 \ --DeliverStatus 1 \ --HasPwd 1 diff --git a/tccli/examples/cwp/v20180228/ModifyLogKafkaState.md b/tccli/examples/cwp/v20180228/ModifyLogKafkaState.md index c93008122b..60b2f60cc4 100644 --- a/tccli/examples/cwp/v20180228/ModifyLogKafkaState.md +++ b/tccli/examples/cwp/v20180228/ModifyLogKafkaState.md @@ -6,11 +6,11 @@ Input: ``` tccli cwp ModifyLogKafkaState --cli-unfold-argument \ - --KafkaEnvName 云镜测试环境 \ + --KafkaEnvName 主机安全测试环境 \ --KafkaId ckafka-ce80kte5 \ --AccessType 1 \ --AccessAddr 127.0.0.1:80 \ - --Username xx \ + --Username 12 \ --Zone 广州 \ --Az 广州三区 \ --VpcId - \ @@ -25,7 +25,7 @@ Output: ``` { "Response": { - "RequestId": "xx" + "RequestId": "absc" } } ``` diff --git a/tccli/examples/dasb/v20191018/ModifyOAuthSetting.md b/tccli/examples/dasb/v20191018/ModifyOAuthSetting.md new file mode 100644 index 0000000000..67dc11fc3c --- /dev/null +++ b/tccli/examples/dasb/v20191018/ModifyOAuthSetting.md @@ -0,0 +1,26 @@ +**Example 1: 设置Okta认证配置** + + + +Input: + +``` +tccli dasb ModifyOAuthSetting --cli-unfold-argument \ + --Enable True \ + --AuthMethod okta \ + --ClientId client-id \ + --ClientSecret client-secret \ + --CodeUrl https://some-url/oauth2/v1/authorize \ + --TokenUrl https://some-url/oauth2/v1/token \ + --UserInfoUrl https://some-url/oauth2/v1/userinfo +``` + +Output: +``` +{ + "Response": { + "RequestId": "abc" + } +} +``` + diff --git a/tccli/examples/dsgc/v20190723/DescribeDSPARDBDataAssetByComplianceId.md b/tccli/examples/dsgc/v20190723/DescribeDSPARDBDataAssetByComplianceId.md index b0bcffff5d..1a95381208 100644 --- a/tccli/examples/dsgc/v20190723/DescribeDSPARDBDataAssetByComplianceId.md +++ b/tccli/examples/dsgc/v20190723/DescribeDSPARDBDataAssetByComplianceId.md @@ -15,31 +15,32 @@ Output: { "Response": { "Stats": { - "SensitiveDbCnt": 3, + "DataAssetType": 0, + "TotalDbCnt": 0, + "TotalTableCnt": 0, + "SensitiveCategoryCnt": 0, + "SensitiveFieldCnt": 0, "SensitiveLevel": [ { - "LevelCnt": 10, - "LevelRiskName": "S2", - "LevelRiskScore": 10, - "LevelId": 1 + "LevelId": 0, + "LevelCnt": 0, + "LevelRiskName": "abc", + "LevelRiskScore": 0 } ], + "SensitiveDbCnt": 0, + "SensitiveTableCnt": 0, + "TotalFieldCnt": 0, "CategoryDistributed": [ { - "Count": 1, "CategoryId": 0, - "CategoryName": "xx" + "CategoryName": "abc", + "Count": 1, + "CategoryFullPath": "abc" } - ], - "TotalFieldCnt": 50, - "SensitiveCategoryCnt": 6, - "TotalTableCnt": 20, - "TotalDbCnt": 5, - "SensitiveFieldCnt": 20, - "SensitiveTableCnt": 10, - "DataAssetType": 0 + ] }, - "RequestId": "xx" + "RequestId": "abc" } } ``` diff --git a/tccli/examples/ess/v20201111/CreateFlowSignUrl.md b/tccli/examples/ess/v20201111/CreateFlowSignUrl.md index 137013027a..28bfccf69e 100644 --- a/tccli/examples/ess/v20201111/CreateFlowSignUrl.md +++ b/tccli/examples/ess/v20201111/CreateFlowSignUrl.md @@ -224,3 +224,40 @@ Output: } ``` +**Example 8: 创建个人用户H5签署链接，使用视频认证方式** + +发起流程后，给其中的C端签署人创建签署链接，并且使用视频认证方式 + +Input: + +``` +tccli ess CreateFlowSignUrl --cli-unfold-argument \ + --Operator.UserId yDRCLUUgygq2xun5UuO4zjEwg0vjoimj \ + --FlowApproverInfos.0.ApproverType 1 \ + --FlowApproverInfos.0.ApproverMobile 13200000000 \ + --FlowApproverInfos.0.ApproverName 典子谦 \ + --FlowApproverInfos.0.ApproverSignTypes 1 \ + --FlowApproverInfos.0.Intention.IntentionType 1 \ + --FlowApproverInfos.0.Intention.IntentionQuestions.0.Question 请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。 \ + --FlowApproverInfos.0.Intention.IntentionQuestions.0.Answers 同意 我同意 \ + --FlowId yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm +``` + +Output: +``` +{ + "Response": { + "FlowApproverUrlInfos": [ + { + "ApproverMobile": "13200000000", + "ApproverName": "典子谦", + "ApproverType": 1, + "LongUrl": "https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=Mi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&ApproverType=1&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA", + "SignUrl": "https://essurl.cn/bR8**HA" + } + ], + "RequestId": "s1693832180480950012" + } +} +``` + diff --git a/tccli/examples/ess/v20201111/DescribeSignFaceVideo.md b/tccli/examples/ess/v20201111/DescribeSignFaceVideo.md new file mode 100644 index 0000000000..0ee06dd158 --- /dev/null +++ b/tccli/examples/ess/v20201111/DescribeSignFaceVideo.md @@ -0,0 +1,36 @@ +**Example 1: 查询签署认证人脸视频结果** + +1. 个人用户在H5端完成合同签署，通过视频问答模式认证。 +2. 所需白名单已经开通。 +3. 在签署完成后的三天内获取人脸图片。 + +Input: + +``` +tccli ess DescribeSignFaceVideo --cli-unfold-argument \ + --Operator.UserId yDRCLUUgygq2xun5UuO4zjEwg0vjoimj \ + --FlowId yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm \ + --SignId yDCNOUUckpv3ecwcUECtq4n1jXPLxLq7 +``` + +Output: +``` +{ + "Response": { + "IntentionQuestionResult": { + "AsrResult": [ + "同意" + ], + "ResultCode": [ + "0" + ], + "Video": "AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB" + }, + "RequestId": "s1709628366717791449", + "VideoData": { + "LiveNessVideo": "AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB" + } + } +} +``` + diff --git a/tccli/examples/essbasic/v20210526/ChannelCreateFlowSignUrl.md b/tccli/examples/essbasic/v20210526/ChannelCreateFlowSignUrl.md index d65efcdc98..d07b0d00b1 100644 --- a/tccli/examples/essbasic/v20210526/ChannelCreateFlowSignUrl.md +++ b/tccli/examples/essbasic/v20210526/ChannelCreateFlowSignUrl.md @@ -136,3 +136,41 @@ Output: } ``` +**Example 5: 创建个人用户H5签署链接，并指定视频问答模式认证** + +发起流程后，给其中的C端签署人创建签署链接，并指定视频问答模式认证 + +Input: + +``` +tccli essbasic ChannelCreateFlowSignUrl --cli-unfold-argument \ + --Agent.ProxyOperator.OpenId n9527 \ + --Agent.AppId yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF \ + --Agent.ProxyOrganizationOpenId org_dianziqian \ + --FlowApproverInfos.0.Mobile 13200000000 \ + --FlowApproverInfos.0.Name 典子谦 \ + --FlowApproverInfos.0.ApproverSignTypes 1 \ + --FlowApproverInfos.0.Intention.IntentionType 1 \ + --FlowApproverInfos.0.Intention.IntentionQuestions.0.Question 请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。 \ + --FlowApproverInfos.0.Intention.IntentionQuestions.0.Answers 同意 我同意 \ + --FlowId yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm +``` + +Output: +``` +{ + "Response": { + "FlowApproverUrlInfos": [ + { + "ApproverType": "PERSON", + "LongUrl": "https://quick.qian.tencent.cn/home?ApproverIdCardNumber=NCoqK***&ApproverIdCardType=ID_CARD&ApproverMobile=MTU4%3D&ApproverName=%25E9%2583%2591%****1%2589&ApproverType=1&Code=yDwhGUUckp3s****z1m3P&CodeType=QUICK&FlowId=yD****T&ShowHeader=1&token=HXC***d", + "Mobile": "13200000000", + "Name": "典子谦", + "SignUrl": "https://test.essurl.cn/HXC***d" + } + ], + "RequestId": "s1690514917653165172" + } +} +``` + diff --git a/tccli/examples/essbasic/v20210526/ChannelDescribeSignFaceVideo.md b/tccli/examples/essbasic/v20210526/ChannelDescribeSignFaceVideo.md new file mode 100644 index 0000000000..d7ff9edfe8 --- /dev/null +++ b/tccli/examples/essbasic/v20210526/ChannelDescribeSignFaceVideo.md @@ -0,0 +1,38 @@ +**Example 1: 查询签署认证人脸视频结果** + +1. 个人用户在H5端完成合同签署，通过视频问答模式认证。 +2. 所需白名单已经开通。 +3. 在签署完成后的三天内获取人脸图片。 + +Input: + +``` +tccli essbasic ChannelDescribeSignFaceVideo --cli-unfold-argument \ + --Agent.ProxyOperator.OpenId n9527 \ + --Agent.AppId yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF \ + --Agent.ProxyOrganizationOpenId org_dianziqian \ + --FlowId yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm \ + --SignId yDCNOUUckpv3ecwcUECtq4n1jXPLxLq7 +``` + +Output: +``` +{ + "Response": { + "IntentionQuestionResult": { + "AsrResult": [ + "同意" + ], + "ResultCode": [ + "0" + ], + "Video": "AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB" + }, + "RequestId": "s1709628366717791449", + "VideoData": { + "LiveNessVideo": "AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB" + } + } +} +``` + diff --git a/tccli/examples/vpc/v20170312/DisassociateDirectConnectGatewayNatGateway.md b/tccli/examples/vpc/v20170312/DisassociateDirectConnectGatewayNatGateway.md index da1e6399fb..fb9c00cb2b 100644 --- a/tccli/examples/vpc/v20170312/DisassociateDirectConnectGatewayNatGateway.md +++ b/tccli/examples/vpc/v20170312/DisassociateDirectConnectGatewayNatGateway.md @@ -1,6 +1,6 @@ **Example 1: 专线网关解绑NAT网关** - +解绑专线网关与公网NAT网关 Input: diff --git a/tccli/services/apm/v20210622/api.json b/tccli/services/apm/v20210622/api.json index fa5d51f821..32cba098b4 100644 --- a/tccli/services/apm/v20210622/api.json +++ b/tccli/services/apm/v20210622/api.json @@ -50,9 +50,9 @@ "status": "online" }, "ModifyApmInstance": { - "document": "修改Apm实例接口", + "document": "修改APM实例接口", "input": "ModifyApmInstanceRequest", - "name": "修改Apm实例", + "name": "修改APM实例", "output": "ModifyApmInstanceResponse", "status": "online" }, diff --git a/tccli/services/ccc/v20200210/api.json b/tccli/services/ccc/v20200210/api.json index 2154790bd6..af9f79f39d 100644 --- a/tccli/services/ccc/v20200210/api.json +++ b/tccli/services/ccc/v20200210/api.json @@ -3657,7 +3657,7 @@ { "disabled": false, "document": "坐席用户信息列表", - "example": "[{\"Name\":\"xiao\",\"Mail\":\"1000273@qq.com\",\"Phone\":\"008617636049517\",\"Nick\":\"测试3\",\"StaffNumber\":\"125\",\"SkillGroupList\":[{\"SkillGroupId\":53,\"SkillGroupName\":\"ALL-dingoding-测试\",\"Priority\":3,\"Type\":\"ALL\"},{\"SkillGroupId\":82,\"SkillGroupName\":\"uu\",\"Priority\":1,\"Type\":\"IM\"}],\"LastModifyTimestamp\":1613988825}]", + "example": "[{\"Name\":\"xiao\",\"Mail\":\"1000273@qq.com\",\"Phone\":\"008617636049517\",\"Nick\":\"测试3\",\"StaffNumber\":\"125\",\"RoleId\":1,\"SkillGroupList\":[{\"SkillGroupId\":53,\"SkillGroupName\":\"ALL-dingoding-测试\",\"Priority\":3,\"Type\":\"ALL\"},{\"SkillGroupId\":82,\"SkillGroupName\":\"uu\",\"Priority\":1,\"Type\":\"IM\"}],\"LastModifyTimestamp\":1613988825}]", "member": "StaffInfo", "name": "StaffList", "output_required": true, @@ -5789,7 +5789,7 @@ "example": "xiaowang", "member": "string", "name": "Name", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5799,7 +5799,7 @@ "example": "10982291@qq.com", "member": "string", "name": "Mail", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -5809,7 +5809,7 @@ "example": "18092226822", "member": "string", "name": "Phone", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5819,7 +5819,7 @@ "example": "xiaohong", "member": "string", "name": "Nick", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5829,17 +5829,27 @@ "example": "101", "member": "string", "name": "StaffNumber", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, + { + "disabled": false, + "document": "用户角色id", + "example": "1", + "member": "uint64", + "name": "RoleId", + "output_required": true, + "type": "int", + "value_allowed_null": false + }, { "disabled": false, "document": "所属技能组列表\n注意：此字段可能返回 null，表示取不到有效值。", "example": "0", "member": "SkillGroupItem", "name": "SkillGroupList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -5849,7 +5859,7 @@ "example": "1614149408", "member": "int64", "name": "LastModifyTimestamp", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true } diff --git a/tccli/services/ccc/v20200210/examples.json b/tccli/services/ccc/v20200210/examples.json index 0505627ec7..6f8378d364 100644 --- a/tccli/services/ccc/v20200210/examples.json +++ b/tccli/services/ccc/v20200210/examples.json @@ -276,7 +276,7 @@ { "document": "获取坐席列表示例", "input": "POST / HTTP/1.1\nHost: ccc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeStaffInfoList\n<公共请求参数>\n\n{\n \"ModifiedTime\": 1590147606,\n \"PageSize\": 10,\n \"PageNumber\": 0,\n \"StaffMail\": \"“121223@qq.com”\",\n \"SdkAppId\": \"1400000000\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"5ac74e13-ef15-41a6-9639-f1bc8c9896bd\",\n \"TotalCount\": 602,\n \"StaffList\": [\n {\n \"Name\": \"xiao\",\n \"Mail\": \"1000273@qq.com\",\n \"Phone\": \"008617636049517\",\n \"Nick\": \"测试3\",\n \"StaffNumber\": \"125\",\n \"SkillGroupList\": [\n {\n \"SkillGroupId\": 53,\n \"SkillGroupName\": \"ALL-dingoding-测试\",\n \"Priority\": 3,\n \"Type\": \"ALL\"\n },\n {\n \"SkillGroupId\": 82,\n \"SkillGroupName\": \"uu\",\n \"Priority\": 1,\n \"Type\": \"IM\"\n }\n ],\n \"LastModifyTimestamp\": 1613988825\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"5ac74e13-ef15-41a6-9639-f1bc8c9896bd\",\n \"TotalCount\": 602,\n \"StaffList\": [\n {\n \"Name\": \"xiao\",\n \"Mail\": \"1000273@qq.com\",\n \"Phone\": \"008617636049517\",\n \"Nick\": \"测试3\",\n \"StaffNumber\": \"125\",\n \"RoleId\": 1,\n \"SkillGroupList\": [\n {\n \"SkillGroupId\": 53,\n \"SkillGroupName\": \"ALL-dingoding-测试\",\n \"Priority\": 3,\n \"Type\": \"ALL\"\n },\n {\n \"SkillGroupId\": 82,\n \"SkillGroupName\": \"uu\",\n \"Priority\": 1,\n \"Type\": \"IM\"\n }\n ],\n \"LastModifyTimestamp\": 1613988825\n }\n ]\n }\n}", "title": "获取坐席列表示例" } ], diff --git a/tccli/services/cdb/v20170320/api.json b/tccli/services/cdb/v20170320/api.json index 218121028f..73d8dd5e0e 100644 --- a/tccli/services/cdb/v20170320/api.json +++ b/tccli/services/cdb/v20170320/api.json @@ -10315,7 +10315,7 @@ "example": "1", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -10325,7 +10325,7 @@ "example": "无", "member": "ErrlogItem", "name": "Items", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, diff --git a/tccli/services/clb/v20180317/api.json b/tccli/services/clb/v20180317/api.json index 55e00a920a..550302c658 100644 --- a/tccli/services/clb/v20180317/api.json +++ b/tccli/services/clb/v20180317/api.json @@ -1487,7 +1487,7 @@ { "disabled": false, "document": "客户端证书的 ID。\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "\"\"", + "example": "4Ih****6", "member": "string", "name": "CertCaId", "output_required": true, diff --git a/tccli/services/clb/v20180317/examples.json b/tccli/services/clb/v20180317/examples.json index 4dd7638508..7e4a2d27f5 100644 --- a/tccli/services/clb/v20180317/examples.json +++ b/tccli/services/clb/v20180317/examples.json @@ -439,8 +439,8 @@ "DescribeLoadBalancersDetail": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: clb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLoadBalancersDetail\n<公共请求参数>\n\n{\n \"Limit\": \"20\",\n \"Offset\": \"0\"\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"LoadBalancerDetailSet\": [],\n \"RequestId\": \"d09b91ba-a81e-4ca3-b423-c64e60127c64\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: clb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLoadBalancersDetail\n<公共请求参数>\n\n{\n \"Limit\": \"2\",\n \"Offset\": \"5\"\n}", + "output": "{\n \"Response\": {\n \"LoadBalancerDetailSet\": [\n {\n \"LoadBalancerId\": \"lb-42ua7vc4\",\n \"LoadBalancerName\": \"lb-65e19dc1-Swzo\",\n \"LoadBalancerDomain\": \"lb-42ua7vc4-*****8.clb.ap-guangzhou.com\",\n \"Status\": 1,\n \"Isolation\": 0,\n \"Address\": null,\n \"AddressIPv6\": null,\n \"AddressIPVersion\": \"IPv4\",\n \"IPv6Mode\": null,\n \"Zone\": \"ap-guangzhou-2\",\n \"Zones\": null,\n \"SlaveZone\": null,\n \"LoadBalancerType\": \"Public\",\n \"AddressIsp\": null,\n \"VpcId\": \"vpc-1yxy51wh\",\n \"ChargeType\": \"POSTPAID_BY_HOUR\",\n \"NetworkAttributes\": {\n \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\",\n \"InternetMaxBandwidthOut\": 6,\n \"BandwidthpkgSubType\": null\n },\n \"PrepaidAttributes\": null,\n \"ProjectId\": 0,\n \"SecurityGroup\": null,\n \"LoadBalancerPassToTarget\": 0,\n \"Tags\": null,\n \"ExtraInfo\": null,\n \"ConfigId\": null,\n \"CreateTime\": \"2024-03-05 22:08:01\",\n \"ListenerId\": null,\n \"Protocol\": null,\n \"Port\": null,\n \"SniSwitch\": null,\n \"LocationId\": null,\n \"Domain\": null,\n \"Domains\": null,\n \"Url\": null,\n \"TargetId\": null,\n \"TargetAddress\": null,\n \"TargetPort\": null,\n \"TargetWeight\": null,\n \"TargetHealth\": null,\n \"Egress\": \"\"\n },\n {\n \"LoadBalancerId\": \"lb-5e5gta0w\",\n \"LoadBalancerName\": \"lb-65e19e54-4rzS\",\n \"LoadBalancerDomain\": \"lb-5e5gta0w-*******.clb.ap-guangzhou.com\",\n \"Status\": 1,\n \"Isolation\": 0,\n \"Address\": null,\n \"AddressIPv6\": null,\n \"AddressIPVersion\": \"IPv4\",\n \"IPv6Mode\": null,\n \"Zone\": \"ap-guangzhou-2\",\n \"Zones\": null,\n \"SlaveZone\": null,\n \"LoadBalancerType\": \"Public\",\n \"AddressIsp\": null,\n \"VpcId\": \"vpc-1yxy51wh\",\n \"ChargeType\": \"POSTPAID_BY_HOUR\",\n \"NetworkAttributes\": {\n \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\",\n \"InternetMaxBandwidthOut\": 6,\n \"BandwidthpkgSubType\": null\n },\n \"PrepaidAttributes\": null,\n \"ProjectId\": 0,\n \"SecurityGroup\": null,\n \"LoadBalancerPassToTarget\": 0,\n \"Tags\": null,\n \"ExtraInfo\": null,\n \"ConfigId\": null,\n \"CreateTime\": \"2024-03-05 22:10:28\",\n \"ListenerId\": null,\n \"Protocol\": null,\n \"Port\": null,\n \"SniSwitch\": null,\n \"LocationId\": null,\n \"Domain\": null,\n \"Domains\": null,\n \"Url\": null,\n \"TargetId\": null,\n \"TargetAddress\": null,\n \"TargetPort\": null,\n \"TargetWeight\": null,\n \"TargetHealth\": null,\n \"Egress\": \"\"\n },\n {\n \"LoadBalancerId\": \"lb-7pqspi5i\",\n \"LoadBalancerName\": \"lb-65e19f3e-R6qu\",\n \"LoadBalancerDomain\": \"lb-7pqspi5i-********.clb.ap-guangzhou..com\",\n \"Status\": 1,\n \"Isolation\": 0,\n \"Address\": null,\n \"AddressIPv6\": null,\n \"AddressIPVersion\": \"IPv4\",\n \"IPv6Mode\": null,\n \"Zone\": \"ap-guangzhou-2\",\n \"Zones\": null,\n \"SlaveZone\": null,\n \"LoadBalancerType\": \"Public\",\n \"AddressIsp\": null,\n \"VpcId\": \"vpc-1yxy51wh\",\n \"ChargeType\": \"POSTPAID_BY_HOUR\",\n \"NetworkAttributes\": {\n \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\",\n \"InternetMaxBandwidthOut\": 6,\n \"BandwidthpkgSubType\": null\n },\n \"PrepaidAttributes\": null,\n \"ProjectId\": 0,\n \"SecurityGroup\": null,\n \"LoadBalancerPassToTarget\": 0,\n \"Tags\": null,\n \"ExtraInfo\": null,\n \"ConfigId\": null,\n \"CreateTime\": \"2024-03-05 22:14:23\",\n \"ListenerId\": null,\n \"Protocol\": null,\n \"Port\": null,\n \"SniSwitch\": null,\n \"LocationId\": null,\n \"Domain\": null,\n \"Domains\": null,\n \"Url\": null,\n \"TargetId\": null,\n \"TargetAddress\": null,\n \"TargetPort\": null,\n \"TargetWeight\": null,\n \"TargetHealth\": null,\n \"Egress\": \"\"\n },\n {\n \"LoadBalancerId\": \"lb-av9bugwy\",\n \"LoadBalancerName\": \"lb-65e19f53-HOij\",\n \"LoadBalancerDomain\": \"lb-av9bugwy-*****.clb.ap-guangzhou.com\",\n \"Status\": 1,\n \"Isolation\": 0,\n \"Address\": null,\n \"AddressIPv6\": null,\n \"AddressIPVersion\": \"IPv4\",\n \"IPv6Mode\": null,\n \"Zone\": \"ap-guangzhou-2\",\n \"Zones\": null,\n \"SlaveZone\": null,\n \"LoadBalancerType\": \"Public\",\n \"AddressIsp\": null,\n \"VpcId\": \"vpc-1yxy51wh\",\n \"ChargeType\": \"POSTPAID_BY_HOUR\",\n \"NetworkAttributes\": {\n \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\",\n \"InternetMaxBandwidthOut\": 6,\n \"BandwidthpkgSubType\": null\n },\n \"PrepaidAttributes\": null,\n \"ProjectId\": 0,\n \"SecurityGroup\": null,\n \"LoadBalancerPassToTarget\": 0,\n \"Tags\": null,\n \"ExtraInfo\": null,\n \"ConfigId\": null,\n \"CreateTime\": \"2024-03-05 22:14:45\",\n \"ListenerId\": null,\n \"Protocol\": null,\n \"Port\": null,\n \"SniSwitch\": null,\n \"LocationId\": null,\n \"Domain\": null,\n \"Domains\": null,\n \"Url\": null,\n \"TargetId\": null,\n \"TargetAddress\": null,\n \"TargetPort\": null,\n \"TargetWeight\": null,\n \"TargetHealth\": null,\n \"Egress\": \"\"\n },\n {\n \"LoadBalancerId\": \"lb-0s4e1oww\",\n \"LoadBalancerName\": \"lb-65e5692e-a8pT\",\n \"LoadBalancerDomain\": \"lb-0s4e1oww-*********.clb.ap-guangzhou.com\",\n \"Status\": 1,\n \"Isolation\": 0,\n \"Address\": null,\n \"AddressIPv6\": null,\n \"AddressIPVersion\": \"IPv4\",\n \"IPv6Mode\": null,\n \"Zone\": \"ap-guangzhou-2\",\n \"Zones\": null,\n \"SlaveZone\": null,\n \"LoadBalancerType\": \"Public\",\n \"AddressIsp\": null,\n \"VpcId\": \"vpc-1yxy51wh\",\n \"ChargeType\": \"POSTPAID_BY_HOUR\",\n \"NetworkAttributes\": {\n \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\",\n \"InternetMaxBandwidthOut\": 5,\n \"BandwidthpkgSubType\": null\n },\n \"PrepaidAttributes\": null,\n \"ProjectId\": 0,\n \"SecurityGroup\": null,\n \"LoadBalancerPassToTarget\": 0,\n \"Tags\": null,\n \"ExtraInfo\": null,\n \"ConfigId\": null,\n \"CreateTime\": \"2024-03-05 19:12:19\",\n \"ListenerId\": null,\n \"Protocol\": null,\n \"Port\": null,\n \"SniSwitch\": null,\n \"LocationId\": null,\n \"Domain\": null,\n \"Domains\": null,\n \"Url\": null,\n \"TargetId\": null,\n \"TargetAddress\": null,\n \"TargetPort\": null,\n \"TargetWeight\": null,\n \"TargetHealth\": null,\n \"Egress\": \"\"\n }\n ],\n \"TotalCount\": 16,\n \"RequestId\": \"1626ec6f-f87e-476c-a9f3-ac3a87a5f3e6\"\n }\n}", "title": "查询负载均衡详细信息" } ], diff --git a/tccli/services/cls/v20201016/api.json b/tccli/services/cls/v20201016/api.json index a6eda90ee7..94b722ae20 100644 --- a/tccli/services/cls/v20201016/api.json +++ b/tccli/services/cls/v20201016/api.json @@ -71,9 +71,9 @@ "status": "online" }, "CreateConsumer": { - "document": "本接口用于创建投递任务", + "document": "本接口用于创建投递CKafka任务", "input": "CreateConsumerRequest", - "name": "创建投递任务", + "name": "创建投递Ckafka任务", "output": "CreateConsumerResponse", "status": "online" }, @@ -386,7 +386,7 @@ "status": "online" }, "DescribeLogContext": { - "document": "本接口用于搜索日志上下文附近的内容\nAPI返回数据包最大49MB，建议启用 gzip 压缩（HTTP Request Header Accept-Encoding:gzip）。", + "document": "本接口用于搜索日志上下文附近的内容，详情参考[上下文检索](https://cloud.tencent.com/document/product/614/53248)。\nAPI返回数据包最大49MB，建议启用 gzip 压缩（HTTP Request Header Accept-Encoding:gzip）。", "input": "DescribeLogContextRequest", "name": "上下文检索", "output": "DescribeLogContextResponse", @@ -512,9 +512,9 @@ "status": "online" }, "ModifyConsumer": { - "document": "本接口用于修改投递任务", + "document": "本接口用于修改投递Ckafka任务", "input": "ModifyConsumerRequest", - "name": "修改投递任务", + "name": "修改投递Ckafka任务", "output": "ModifyConsumerResponse", "status": "online" }, @@ -700,7 +700,7 @@ "members": [ { "disabled": false, - "document": "键\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "键。支持以下key：\nSyntaxRule：语法规则，value支持 0：Lucene语法；1： CQL语法。\nQueryIndex：执行语句序号。value支持 -1：自定义； 1：执行语句1； 2：执行语句2。\nCustomQuery：检索语句。 QueryIndex为-1时有效且必填，value示例： \"* | select count(*) as count\"。\nFields：字段。value支持 __SOURCE__；__FILENAME__；__HOSTNAME__；__TIMESTAMP__；__INDEX_STATUS__；__PKG_LOGID__；__TOPIC__。\nFormat：显示形式。value支持 1：每条日志一行；2：每条日志每个字段一行。\nLimit：最大日志条数。 value示例： 5。\n注意：此字段可能返回 null，表示取不到有效值。", "example": "k", "member": "string", "name": "Key", @@ -711,7 +711,7 @@ }, { "disabled": false, - "document": "值\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "值。\n键对应值如下：\nSyntaxRule：语法规则，value支持 0：Lucene语法；1： CQL语法。\nQueryIndex：执行语句序号。value支持 -1：自定义； 1：执行语句1； 2：执行语句2。\nCustomQuery：检索语句。 QueryIndex为-1时有效且必填，value示例： \"* | select count(*) as count\"。\nFields：字段。value支持 __SOURCE__；__FILENAME__；__HOSTNAME__；__TIMESTAMP__；__INDEX_STATUS__；__PKG_LOGID__；__TOPIC__。\nFormat：显示形式。value支持 1：每条日志一行；2：每条日志每个字段一行。\nLimit：最大日志条数。 value示例： 5。\n注意：此字段可能返回 null，表示取不到有效值。", "example": "v", "member": "string", "name": "Value", @@ -1556,7 +1556,7 @@ }, { "disabled": false, - "document": "多维分析配置。\n\n当Analysis的Type字段为query（自定义）时，支持\n{\n\"Key\": \"SyntaxRule\", // 语法规则\n\"Value\": \"1\" //0：Lucene语法 ，1： CQL语法\n}\n\n\n\n当Analysis的Type字段为field（top5）时, 支持\n {\n \"Key\": \"QueryIndex\",\n \"Value\": \"-1\" // -1：自定义， 1：执行语句1， 2：执行语句2\n},{\n \"Key\": \"CustomQuery\", //检索语句。 QueryIndex为-1时有效且必填\n \"Value\": \"* | select count(*) as count\"\n},{\n \"Key\": \"SyntaxRule\", // 查不到这个字段也是老语法（Lucene）\n \"Value\": \"0\"//0:Lucene, 1:CQL\n} \n\n当Analysis的Type字段为original（原始日志）时, 支持\n{\n \"Key\": \"Fields\",\n \"Value\": \"__SOURCE__,__HOSTNAME__,__TIMESTAMP__,__PKG_LOGID__,__TAG__.pod_ip\"\n}, {\n \"Key\": \"QueryIndex\",\n \"Value\": \"-1\" // -1：自定义， 1：执行语句1， 2：执行语句2\n},{\n \"Key\": \"CustomQuery\", // //检索语句。 QueryIndex为-1时有效且必填\n \"Value\": \"* | select count(*) as count\"\n},{\n \"Key\": \"Format\", //显示形式。1：每条日志一行，2：每条日志每个字段一行\n \"Value\": \"2\"\n},\n{\n \"Key\": \"Limit\", //最大日志条数\n \"Value\": \"5\"\n},{\n \"Key\": \"SyntaxRule\", // 查不到这个字段也是老语法\n \"Value\": \"0\"//0:Lucene, 1:CQL\n}\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "多维分析配置。\n\n当Analysis的Type字段为query（自定义）时，支持\n{\n\"Key\": \"SyntaxRule\", // 语法规则\n\"Value\": \"1\" //0：Lucene语法 ，1： CQL语法\n}\n\n当Analysis的Type字段为field（top5）时, 支持\n {\n \"Key\": \"QueryIndex\",\n \"Value\": \"-1\" // -1：自定义， 1：执行语句1， 2：执行语句2\n},{\n \"Key\": \"CustomQuery\", //检索语句。 QueryIndex为-1时有效且必填\n \"Value\": \"* | select count(*) as count\"\n},{\n \"Key\": \"SyntaxRule\", // 查不到这个字段也是老语法（Lucene）\n \"Value\": \"0\"//0:Lucene, 1:CQL\n} \n\n当Analysis的Type字段为original（原始日志）时, 支持\n{\n \"Key\": \"Fields\",\n \"Value\": \"__SOURCE__,__HOSTNAME__,__TIMESTAMP__,__PKG_LOGID__,__TAG__.pod_ip\"\n}, {\n \"Key\": \"QueryIndex\",\n \"Value\": \"-1\" // -1：自定义， 1：执行语句1， 2：执行语句2\n},{\n \"Key\": \"CustomQuery\", // //检索语句。 QueryIndex为-1时有效且必填\n \"Value\": \"* | select count(*) as count\"\n},{\n \"Key\": \"Format\", //显示形式。1：每条日志一行，2：每条日志每个字段一行\n \"Value\": \"2\"\n},\n{\n \"Key\": \"Limit\", //最大日志条数\n \"Value\": \"5\"\n},{\n \"Key\": \"SyntaxRule\", // 查不到这个字段也是老语法\n \"Value\": \"0\"//0:Lucene, 1:CQL\n}\n注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "member": "AlarmAnalysisConfig", "name": "ConfigInfo", @@ -1861,6 +1861,51 @@ ], "type": "object" }, + "CollectConfig": { + "document": "采集配置信息", + "members": [ + { + "disabled": false, + "document": "指定采集类型的采集配置名称信息。\n
  • 当CollectInfo中Type为0：表示元数据配置，name为元数据名称。\n目前支持\"container_id\"，\"container_name\"，\"image_name\"，\"namespace\"，\"pod_uid\"，\"pod_name\"，\"pod_ip\"。\n
    • \n
  • 当CollectInfo中Type为1：指定pod label，name为指定pod label名称。
    • ", + "example": "pod_name", + "member": "string", + "name": "Name", + "output_required": true, + "required": true, + "type": "string", + "value_allowed_null": false + } + ], + "usage": "both" + }, + "CollectInfo": { + "document": "采集配置信息", + "members": [ + { + "disabled": false, + "document": "采集类型，必填字段。\n
  • 0：元数据配置。
    • \n
  • 1：指定Pod Label。
    • \n注意：此字段可能返回 null，表示取不到有效值。", + "example": "0", + "member": "uint64", + "name": "Type", + "output_required": true, + "required": true, + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "指定采集类型的采集配置信息。\n
  • 当Type为0时，CollectConfigs不允许为空。
    • \n
  • 当Type为1时，CollectConfigs为空时，表示选择所有Pod Label；否则CollectConfigs为指定Pod Label。
    • \n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "CollectConfig", + "name": "CollectConfigs", + "output_required": true, + "required": false, + "type": "list", + "value_allowed_null": true + } + ], + "usage": "both" + }, "Column": { "document": "日志分析的列属性", "members": [ @@ -2096,6 +2141,16 @@ "type": "string", "value_allowed_null": true }, + { + "disabled": false, + "document": "采集相关配置信息。详情见 CollectInfo复杂类型配置。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "CollectInfo", + "name": "CollectInfos", + "output_required": true, + "type": "list", + "value_allowed_null": true + }, { "disabled": false, "document": "高级采集配置。 Json字符串， Key/Value定义为如下：\n- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时\n- ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数\n- ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false\n样例：{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}\n注意：此字段可能返回 null，表示取不到有效值。", @@ -2240,10 +2295,11 @@ "members": [ { "disabled": false, - "document": "是否投递 TAG 信息\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "是否投递 TAG 信息。\n当EnableTag为true时，表示投递TAG元信息。\n注意：此字段可能返回 null，表示取不到有效值。", "example": "false", "member": "bool", "name": "EnableTag", + "output_required": true, "required": true, "type": "bool", "value_allowed_null": true @@ -2254,26 +2310,40 @@ "example": "{\"__SOURCE__\", \"__FILENAME__\", \"__TIMESTAMP__\"}", "member": "string", "name": "MetaFields", + "output_required": true, "required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, - "document": "当EnableTag为true时，必须填写TagJsonNotTiled字段，TagJsonNotTiled用于标识tag信息是否json平铺，TagJsonNotTiled为true时不平铺，false时平铺\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "当EnableTag为true时，必须填写TagJsonNotTiled字段。\nTagJsonNotTiled用于标识tag信息是否json平铺。\n\nTagJsonNotTiled为true时不平铺，示例：\nTAG信息：`{\"__TAG__\":{\"fieldA\":200,\"fieldB\":\"text\"}}`\n不平铺：`{\"__TAG__\":{\"fieldA\":200,\"fieldB\":\"text\"}}`\n\nTagJsonNotTiled为false时平铺，示例：\nTAG信息：`{\"__TAG__\":{\"fieldA\":200,\"fieldB\":\"text\"}}`\n平铺：`{\"__TAG__.fieldA\":200,\"__TAG__.fieldB\":\"text\"}`\n注意：此字段可能返回 null，表示取不到有效值。", "example": "false", "member": "bool", "name": "TagJsonNotTiled", + "output_required": true, "required": false, "type": "bool", "value_allowed_null": true }, { "disabled": false, - "document": "投递时间戳精度，可选项 [1:秒；2:毫秒] ，默认是秒\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "投递时间戳精度，可选项 [1：秒；2：毫秒] ，默认是1。\n注意：此字段可能返回 null，表示取不到有效值。", "example": "1", "member": "int64", "name": "TimestampAccuracy", + "output_required": true, + "required": false, + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "投递Json格式。\nJsonType为0：和原始日志一致，不转义。示例：\n日志原文：`{\"a\":\"aa\", \"b\":{\"b1\":\"b1b1\", \"c1\":\"c1c1\"}}`\n投递到Ckafka：`{\"a\":\"aa\", \"b\":{\"b1\":\"b1b1\", \"c1\":\"c1c1\"}}`\n\nJsonType为1：转义。示例：\n日志原文：`{\"a\":\"aa\", \"b\":{\"b1\":\"b1b1\", \"c1\":\"c1c1\"}}`\n投递到Ckafka：`{\"a\":\"aa\",\"b\":\"{\\\"b1\\\":\\\"b1b1\\\", \\\"c1\\\":\\\"c1c1\\\"}\"}`\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "0", + "member": "int64", + "name": "JsonType", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -3397,7 +3467,7 @@ }, { "disabled": false, - "document": "是否投递日志的元数据信息，默认为 true", + "document": "是否投递日志的元数据信息，默认为 true。\n当NeedContent为true时：字段Content有效。\n当NeedContent为false时：字段Content无效。", "example": "false", "member": "bool", "name": "NeedContent", @@ -3424,7 +3494,7 @@ }, { "disabled": false, - "document": "投递时压缩方式，取值0，2，3。[0:NONE；2:SNAPPY；3:LZ4]", + "document": "投递时压缩方式，取值0，2，3。[0：NONE；2：SNAPPY；3：LZ4]", "example": "0", "member": "int64", "name": "Compression", @@ -3478,7 +3548,7 @@ }, { "disabled": false, - "document": "COS存储桶。\n存储桶命名规范：https://cloud.tencent.com/document/product/436/13312", + "document": "COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。", "example": "examplebucket-1-1250000000", "member": "string", "name": "Bucket", @@ -3487,7 +3557,7 @@ }, { "disabled": false, - "document": "COS存储桶所在地域。地域和访问域名：https://cloud.tencent.com/document/product/436/6224", + "document": "COS存储桶所在地域，详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。", "example": "ap-guangzhou", "member": "string", "name": "BucketRegion", @@ -3560,7 +3630,7 @@ "members": [ { "disabled": false, - "document": "任务类型. 1: 指定主题；2:动态创建", + "document": "任务类型. 1: 指定主题；2:动态创建。详情请参考[创建加工任务文档](https://cloud.tencent.com/document/product/614/63940)。", "example": "1", "member": "int64", "name": "FuncType", @@ -3596,13 +3666,22 @@ }, { "disabled": false, - "document": "加工类型 1 使用源日志主题中的随机数据，进行加工预览 :2 使用用户自定义测试数据，进行加工预览 3 创建真实加工任务", + "document": "加工类型。\n1：使用源日志主题中的随机数据，进行加工预览；2：使用用户自定义测试数据，进行加工预览；3：创建真实加工任务。", "example": "1", "member": "int64", "name": "TaskType", "required": true, "type": "int" }, + { + "disabled": false, + "document": "加工任务目的topic_id以及别名,当FuncType=1时，该参数必填，当FuncType=2时，无需填写。", + "example": "{\"dst_topics\":[{\"topic_id\":\"xxx\", \"alias\":\"topic\"}]}", + "member": "DataTransformResouceInfo", + "name": "DstResources", + "required": false, + "type": "list" + }, { "disabled": false, "document": "任务启动状态. 默认为1:开启, 2:关闭", @@ -3612,15 +3691,6 @@ "required": false, "type": "int" }, - { - "disabled": false, - "document": "加工任务目的topic_id以及别名,当FuncType=1时，该参数必填，当FuncType=2时，无需填写", - "example": "{\"dst_topics\":[{\"topic_id\":\"xxx\", \"alias\":\"topic\"}]}", - "member": "DataTransformResouceInfo", - "name": "DstResources", - "required": false, - "type": "list" - }, { "disabled": false, "document": "用于预览加工结果的测试数据", @@ -4547,7 +4617,7 @@ }, { "disabled": false, - "document": "生命周期，单位天，标准存储取值范围1\\~3600，低频存储取值范围7\\~3600天。取值为3640时代表永久保存", + "document": "生命周期，单位天，标准存储取值范围1\\~3600，低频存储取值范围7\\~3600天。取值为3640时代表永久保存。\n不传此值，默认获取该日志主题对应日志集的Period值（当获取失败时默认为30天）。", "example": "30", "member": "int64", "name": "Period", @@ -4565,7 +4635,7 @@ }, { "disabled": false, - "document": "0：关闭日志沉降。\n非0：开启日志沉降后标准存储的天数。HotPeriod需要大于等于7，且小于Period。仅在StorageType为 hot 时生效", + "document": "0：关闭日志沉降。\n非0：开启日志沉降后标准存储的天数，HotPeriod需要大于等于7，且小于Period。\n仅在StorageType为 hot 时生效。", "example": "7", "member": "uint64", "name": "HotPeriod", @@ -4574,7 +4644,7 @@ }, { "disabled": false, - "document": "免鉴权开关； false: 关闭 true： 开启", + "document": "免鉴权开关。 false：关闭； true：开启。\n开启后将支持指定操作匿名访问该日志主题。详情请参见[日志主题](https://cloud.tencent.com/document/product/614/41035)。", "example": "false", "member": "bool", "name": "IsWebTracking", @@ -6074,7 +6144,7 @@ }, { "disabled": false, - "document": "
  • dashboardId\n\n按照【仪表盘id】进行过滤。\n类型：String\n\n必选：否
    • \n\n
  • dashboardName\n\n按照【仪表盘名字】进行模糊搜索过滤。\n类型：String\n\n必选：否
    • \n\n
  • dashboardRegion\n\n按照【仪表盘地域】进行过滤，为了兼容老的仪表盘，通过云API创建的仪表盘没有地域属性\n类型：String\n\n必选：否
    • \n\n
  • tagKey\n\n按照【标签键】进行过滤。\n\n类型：String\n\n必选：否
    • \n\n
  • tag:tagKey\n\n按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。\n\n类型：String\n\n必选：否
    • \n\n每次请求的Filters的上限为10，Filter.Values的上限为100。", + "document": "
  • dashboardId\n\n按照【仪表盘id】进行过滤。\n类型：String\n\n必选：否
    • \n\n
  • dashboardName\n\n按照【仪表盘名字】进行模糊搜索过滤。\n类型：String\n\n必选：否
    • \n\n
  • dashboardRegion\n\n按照【仪表盘地域】进行过滤，为了兼容老的仪表盘，通过云API创建的仪表盘没有地域属性\n类型：String\n\n必选：否
    • \n\n
  • tagKey\n\n按照【标签键】进行过滤。\n\n类型：String\n\n必选：否
    • \n\n
  • tag:tagKey\n\n按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换。使用请参考示例二。\n\n类型：String\n\n必选：否
    • \n\n每次请求的Filters的上限为10，Filter.Values的上限为100。", "example": "无", "member": "Filter", "name": "Filters", @@ -6431,7 +6501,7 @@ { "disabled": false, "document": "日志主题 ID", - "example": "xxx-xxx-xxx-xxx", + "example": "6bf3355c-3c88-4566-89c8-76c3ca37bae9", "member": "string", "name": "TopicId", "required": true, @@ -6495,7 +6565,7 @@ "members": [ { "disabled": false, - "document": "kafka消费用户名", + "document": "kafka用户名。", "example": "test", "member": "string", "name": "UserName", @@ -6510,11 +6580,11 @@ "members": [ { "disabled": false, - "document": "kafka消费用户名", + "document": "如果返回不为空，代表用户名UserName已经创建成功。", "example": "test", "member": "string", "name": "UserName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -6550,7 +6620,7 @@ }, { "disabled": false, - "document": "日志包序号", + "document": "日志包序号。SearchLog接口返回信息中Results结构体中的PkgId。", "example": "528C1318606EFEB8-1A7", "member": "string", "name": "PkgId", @@ -6559,7 +6629,7 @@ }, { "disabled": false, - "document": "日志包内一条日志的序号", + "document": "日志包内一条日志的序号。\nSearchLog接口返回信息中Results结构中的PkgLogId。", "example": "65536", "member": "int64", "name": "PkgLogId", @@ -6568,7 +6638,7 @@ }, { "disabled": false, - "document": "上文日志条数, 默认值10", + "document": "前${PrevLogs}条日志，默认值10。", "example": "10", "member": "int64", "name": "PrevLogs", @@ -6577,7 +6647,7 @@ }, { "disabled": false, - "document": "下文日志条数, 默认值10", + "document": "后${NextLogs}条日志，默认值10。", "example": "10", "member": "int64", "name": "NextLogs", @@ -6602,7 +6672,7 @@ }, { "disabled": false, - "document": "上文日志是否已经返回", + "document": "上文日志是否已经返回完成（当PrevOver为false，表示有上文日志还未全部返回）。", "example": "true", "member": "bool", "name": "PrevOver", @@ -6612,7 +6682,7 @@ }, { "disabled": false, - "document": "下文日志是否已经返回", + "document": "下文日志是否已经返回完成（当NextOver为false，表示有下文日志还未全部返回）。", "example": "true", "member": "bool", "name": "NextOver", @@ -6912,7 +6982,7 @@ { "disabled": false, "document": "机器状态信息组", - "example": "0 ", + "example": "无", "member": "MachineInfo", "name": "Machines", "output_required": true, @@ -6921,7 +6991,7 @@ }, { "disabled": false, - "document": "机器组是否开启自动升级功能", + "document": "机器组是否开启自动升级功能。 0：未开启自动升级；1：开启了自动升级。", "example": "0", "member": "int64", "name": "AutoUpdate", @@ -7056,7 +7126,7 @@ }, { "disabled": false, - "document": "
  • srcTopicName按照【源日志主题名称】进行过滤，模糊匹配。类型：String。必选：否
    • \n
  • dstTopicName按照【目标日志主题名称】进行过滤，模糊匹配。类型：String。必选：否
    • \n
  • srcTopicId按照【源日志主题ID】进行过滤。类型：String。必选：否
    • \n
  • dstTopicId按照【目标日志主题ID】进行过滤。类型：String。必选：否
    • \n
  • bizType按照【主题类型】进行过滤,0日志主题 1指标主题。类型：String。必选：否
    • \n
  • status按照【任务状态】进行过滤，1:运行 2:停止。类型：String。必选：否
    • \n
  • taskName按照【任务名称】进行过滤，模糊匹配。类型：String。必选：否
    • \n
  • taskId按照【任务ID】进行过滤，模糊匹配。类型：String。必选：否
    • \n", + "document": "
  • srcTopicName按照【源日志主题名称】进行过滤，模糊匹配。类型：String。必选：否
    • \n
  • dstTopicName按照【目标日志主题名称】进行过滤，模糊匹配。类型：String。必选：否
    • \n
  • srcTopicId按照【源日志主题ID】进行过滤。类型：String。必选：否
    • \n
  • dstTopicId按照【目标日志主题ID】进行过滤。类型：String。必选：否
    • \n
  • bizType按照【主题类型】进行过滤，0日志主题 1指标主题。类型：String。必选：否
    • \n
  • status按照【任务状态】进行过滤，1：运行；2：停止。类型：String。必选：否
    • \n
  • taskName按照【任务名称】进行过滤，模糊匹配。类型：String。必选：否
    • \n
  • taskId按照【任务ID】进行过滤，模糊匹配。类型：String。必选：否
    • \n", "example": "无", "member": "Filter", "name": "Filters", @@ -7507,7 +7577,7 @@ }, { "disabled": false, - "document": "日志导出路径", + "document": "日志导出路径,有效期一个小时，请尽快使用该路径下载。", "example": "\"\"", "member": "string", "name": "CosPath", @@ -7543,7 +7613,7 @@ "members": [ { "disabled": false, - "document": "时间字段的key名字，time_key和time_format必须成对出现\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "时间字段的key名字，TikeKey和TimeFormat必须成对出现\n注意：此字段可能返回 null，表示取不到有效值。", "example": "test", "member": "string", "name": "TimeKey", @@ -7565,7 +7635,7 @@ }, { "disabled": false, - "document": "分隔符类型日志的分隔符，只有log_type为delimiter_log时有效\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "分隔符类型日志的分隔符，只有LogType为delimiter_log时有效\n注意：此字段可能返回 null，表示取不到有效值。", "example": ",", "member": "string", "name": "Delimiter", @@ -7576,7 +7646,7 @@ }, { "disabled": false, - "document": "整条日志匹配规则，只有log_type为fullregex_log时有效\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "整条日志匹配规则，只有LogType为fullregex_log时有效\n注意：此字段可能返回 null，表示取不到有效值。", "example": "\\w", "member": "string", "name": "LogRegex", @@ -7587,7 +7657,7 @@ }, { "disabled": false, - "document": "行首匹配规则，只有log_type为multiline_log或fullregex_log时有效\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "行首匹配规则，只有LogType为multiline_log或fullregex_log时有效\n注意：此字段可能返回 null，表示取不到有效值。", "example": "\\w", "member": "string", "name": "BeginRegex", @@ -7598,7 +7668,7 @@ }, { "disabled": false, - "document": "取的每个字段的key名字，为空的key代表丢弃这个字段，只有log_type为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "取的每个字段的key名字，为空的key代表丢弃这个字段，只有LogType为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。\n注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "member": "string", "name": "Keys", @@ -7642,7 +7712,7 @@ }, { "disabled": false, - "document": "增量采集模式下的回溯数据量，默认-1（全量采集）\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "增量采集模式下的回溯数据量，默认-1（全量采集）；其他非负数表示增量采集（从最新的位置，往前采集${Backtracking}字节（Byte）的日志）最大支持1073741824（1G）。\n注意：此字段可能返回 null，表示取不到有效值。", "example": "-1", "member": "int64", "name": "Backtracking", @@ -7936,7 +8006,7 @@ }, { "disabled": false, - "document": "如果Query包含SQL语句，UseNewAnalysis为true时响应参数AnalysisRecords和Columns有效， UseNewAnalysis为false时响应参数AnalysisResults和ColNames有效", + "document": "为true代表使用新的检索结果返回方式，输出参数AnalysisRecords和Columns有效；\n为false代表使用老的检索结果返回方式，输出AnalysisResults和ColNames有效；\n两种返回方式在编码格式上有少量区别，建议使用true。\n示例值：false", "example": "false", "member": "bool", "name": "UseNewAnalysis", @@ -8001,7 +8071,7 @@ }, { "disabled": false, - "document": "执行详情统计分析结果。当Query字段有SQL语句时，返回sql统计结果，否则可能返回null。\n\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "执行详情统计分析结果。当Query字段有SQL语句时，返回SQL统计结果，否则可能返回null。\n\n注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "member": "LogItems", "name": "AnalysisResults", @@ -8011,7 +8081,7 @@ }, { "disabled": false, - "document": "执行详情统计分析结果; UseNewAnalysis为true有效\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "执行详情统计分析结果；UseNewAnalysis为true有效。\n注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"xxx\",\"yy\"]", "member": "string", "name": "AnalysisRecords", @@ -8196,7 +8266,7 @@ "members": [ { "disabled": false, - "document": "消费格式 0:全文；1:json", + "document": "消费数据格式。 0：原始内容；1：JSON。", "example": "1", "member": "int64", "name": "Format", @@ -8229,7 +8299,7 @@ }, { "disabled": false, - "document": "tag数据处理方式：\n1:不平铺（默认值）\n2:平铺\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "tag数据处理方式：1:不平铺（默认值）；2:平铺。\n\n不平铺示例：\nTAG信息：`{\"__TAG__\":{\"fieldA\":200,\"fieldB\":\"text\"}}`\n不平铺：`{\"__TAG__\":{\"fieldA\":200,\"fieldB\":\"text\"}}`\n\n平铺示例：\nTAG信息：`{\"__TAG__\":{\"fieldA\":200,\"fieldB\":\"text\"}}`\n平铺：`{\"__TAG__.fieldA\":200,\"__TAG__.fieldB\":\"text\"}`\n注意：此字段可能返回 null，表示取不到有效值。", "example": "1", "member": "int64", "name": "TagTransaction", @@ -8240,7 +8310,7 @@ }, { "disabled": false, - "document": "消费数据Json格式：\n1：不转义（默认格式）\n2：转义", + "document": "消费数据Json格式：\n1：不转义（默认格式）\n2：转义\n\n投递Json格式。\nJsonType为1：和原始日志一致，不转义。示例：\n日志原文：`{\"a\":\"aa\", \"b\":{\"b1\":\"b1b1\", \"c1\":\"c1c1\"}}`\n投递到Ckafka：`{\"a\":\"aa\", \"b\":{\"b1\":\"b1b1\", \"c1\":\"c1c1\"}}`\n\nJsonType为2：转义。示例：\n日志原文：`{\"a\":\"aa\", \"b\":{\"b1\":\"b1b1\", \"c1\":\"c1c1\"}}`\n投递到Ckafka：`{\"a\":\"aa\",\"b\":\"{\\\"b1\\\":\\\"b1b1\\\", \\\"c1\\\":\\\"c1c1\\\"}\"}`", "example": "1", "member": "int64", "name": "JsonType", @@ -8308,7 +8378,7 @@ { "disabled": false, "document": "主键ID\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "xxxxxxxx", + "example": "86076b49-1234-4321-ab09-a5d7e7972825", "member": "string", "name": "Id", "output_required": true, @@ -8318,7 +8388,7 @@ { "disabled": false, "document": "日志主题ID\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "xxx-xxx-xxx-xxx", + "example": "957f4aed-1234-4321-b98b-c3c806f9e71b", "member": "string", "name": "TopicId", "output_required": true, @@ -8358,7 +8428,7 @@ { "disabled": false, "document": "服务地址\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "test.cls.tencentyun.com:9095", + "example": "kafkaconsumer-ap-chongqing.aaa.com:1234", "member": "string", "name": "ServerAddr", "output_required": true, @@ -8388,7 +8458,7 @@ { "disabled": false, "document": "用户需要导入的Kafka相关topic列表，多个topic之间使用半角逗号隔开\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "topic1,topic2\t", + "example": "1256238147-f3061593-cd5b-4321-1234-3ba507d43301", "member": "string", "name": "UserKafkaTopics", "output_required": true, @@ -8407,7 +8477,7 @@ }, { "disabled": false, - "document": "状态 status 1: 运行中, 2: 暂停 ...\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "状态 ，1：运行中；2：暂停。\n注意：此字段可能返回 null，表示取不到有效值。", "example": "1", "member": "int64", "name": "Status", @@ -8625,7 +8695,7 @@ "example": "1619162953000", "member": "int64", "name": "Time", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -8635,7 +8705,7 @@ "example": "4463e7b0-3ec8-41a1-ae48-5d24b22167c2", "member": "string", "name": "TopicId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -8645,7 +8715,7 @@ "example": "test", "member": "string", "name": "TopicName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -8655,7 +8725,7 @@ "example": "10.0.0.1", "member": "string", "name": "Source", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -8665,7 +8735,7 @@ "example": "/test/access.log", "member": "string", "name": "FileName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -8675,7 +8745,7 @@ "example": "0", "member": "string", "name": "PkgId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -8685,17 +8755,17 @@ "example": "0", "member": "string", "name": "PkgLogId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "日志内容的Json序列化字符串\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "{\"content\":\"test\"}", + "example": "{\\\"content\\\":\\\"test\\\"}", "member": "string", "name": "LogJson", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -8705,17 +8775,17 @@ "example": "hostName-1", "member": "string", "name": "HostName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "原始日志(仅在日志创建索引异常时有值)\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "{\"content\":\"test\"}", + "example": "{\\\"content\\\":\\\"test\\\"}", "member": "string", "name": "RawLog", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -8725,7 +8795,7 @@ "example": "IndexAllFail:fields like 'a' and 'a.b' can not appear in the same topic", "member": "string", "name": "IndexStatus", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -9215,7 +9285,7 @@ }, { "disabled": false, - "document": "机器升级功能状态。", + "document": "机器升级功能状态。 0：升级成功；1：升级中；-1：升级失败。", "example": "0", "member": "int64", "name": "UpdateStatus", @@ -9225,7 +9295,7 @@ }, { "disabled": false, - "document": "机器升级结果标识。", + "document": "机器升级结果标识。\n0：成功；1200：升级成功；其他值表示异常。", "example": "0", "member": "int64", "name": "ErrCode", @@ -9235,7 +9305,7 @@ }, { "disabled": false, - "document": "机器升级结果信息。", + "document": "机器升级结果信息。\n“ok”：成功；“update success”：升级成功；其他值为失败原因。", "example": "OK", "member": "string", "name": "ErrMsg", @@ -10008,7 +10078,7 @@ }, { "disabled": false, - "document": "是否投递日志的元数据信息，默认为 false", + "document": "是否投递日志的元数据信息，默认为 true。\n当NeedContent为true时：字段Content有效。\n当NeedContent为false时：字段Content无效。", "example": "false", "member": "bool", "name": "NeedContent", @@ -10035,7 +10105,7 @@ }, { "disabled": false, - "document": "投递时压缩方式，取值0，2，3。[0:NONE；2:SNAPPY；3:LZ4]", + "document": "投递时压缩方式，取值0，2，3。[0：NONE；2：SNAPPY；3：LZ4]", "example": "0", "member": "int64", "name": "Compression", @@ -10854,7 +10924,7 @@ }, { "disabled": false, - "document": "该日志主题是否开始采集", + "document": "主题是否开启采集，true：开启采集；false：关闭采集。\n控制台目前不支持修改此参数。", "example": "true", "member": "bool", "name": "Status", @@ -10908,7 +10978,7 @@ }, { "disabled": false, - "document": "免鉴权开关； false: 关闭 true: 开启", + "document": "免鉴权开关。 false：关闭； true：开启。\n开启后将支持指定操作匿名访问该日志主题。详情请参见[日志主题](https://cloud.tencent.com/document/product/614/41035)。", "example": "false", "member": "bool", "name": "IsWebTracking", @@ -11353,7 +11423,7 @@ }, { "disabled": false, - "document": "ServerAddr是否为加密连接。。\nKafkaType为1时有效。", + "document": "ServerAddr是否为加密连接。\nKafkaType为1时有效。", "example": "true", "member": "bool", "name": "IsEncryptionAddr", @@ -12086,7 +12156,7 @@ }, { "disabled": false, - "document": "存储桶。\n存储桶命名规范：https://cloud.tencent.com/document/product/436/13312", + "document": "COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。", "example": "examplebucket-1-1250000000", "member": "string", "name": "Bucket", @@ -12095,7 +12165,7 @@ }, { "disabled": false, - "document": "存储桶所在地域。\n地域和访问域名：https://cloud.tencent.com/document/product/436/6224", + "document": "COS存储桶所在地域，详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。", "example": "ap-guangzhou", "member": "string", "name": "BucketRegion", @@ -12902,18 +12972,16 @@ "member": "string", "name": "TopicId", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, - "document": "日志主题id 所在的地域id\n地域ID - 访问链接查看详情：https://iwiki.woa.com/pages/viewpage.action?pageId=780556968#id-地域码表-一.region大区（标准地域）", + "document": "日志主题id所在的地域id。\n\nid,地域,简称信息如下：\n- 1, 广州,ap-guangzhou\n- 4, 上海,ap-shanghai\n- 5, 中国香港,ap-hongkong\n- 6, 多伦多,na-toronto\n- 7, 上海金融,ap-shanghai-fsi\n- 8, 北京,ap-beijing\n- 9, 新加坡,ap-singapore\n- 11, 深圳金融,ap-shenzhen-fsi\n- 15, 硅谷,na-siliconvalley\n- 16, 成都,ap-chengdu\n- 17, 法兰克福,eu-frankfurt\n- 18, 首尔,ap-seoul\n- 19, 重庆,ap-chongqing\n- 21, 孟买,ap-mumbai\n- 22, 弗吉尼亚,na-ashburn\n- 23, 曼谷,ap-bangkok\n- 25, 东京,ap-tokyo\n- 33, 南京,ap-nanjing\n- 46, 北京金融,ap-beijing-fsi\n- 72, 雅加达,ap-jakarta\n- 74, 圣保罗,sa-saopaulo", "example": "19", "member": "uint64", "name": "RegionId", "required": true, - "type": "int", - "value_allowed_null": false + "type": "int" } ], "usage": "in" @@ -12993,7 +13061,7 @@ }, { "disabled": false, - "document": "主题是否开启采集", + "document": "主题是否开启采集，true：开启采集；false：关闭采集。\n创建日志主题时默认开启，可通过SDK调用ModifyTopic修改此字段。\n控制台目前不支持修改此参数。", "example": "true", "member": "bool", "name": "Status", @@ -13093,7 +13161,7 @@ }, { "disabled": false, - "document": "免鉴权开关。\n- false: 关闭\n- true: 开启\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "免鉴权开关。 false：关闭； true：开启。\n开启后将支持指定操作匿名访问该日志主题。详情请参见[日志主题](https://cloud.tencent.com/document/product/614/41035)。\n注意：此字段可能返回 null，表示取不到有效值。", "example": "false", "member": "bool", "name": "IsWebTracking", diff --git a/tccli/services/cls/v20201016/examples.json b/tccli/services/cls/v20201016/examples.json index 78a2c72798..f4e404b588 100644 --- a/tccli/services/cls/v20201016/examples.json +++ b/tccli/services/cls/v20201016/examples.json @@ -82,10 +82,10 @@ ], "CreateConsumer": [ { - "document": "", + "document": "CLS 日志投递Ckafka之后，您可以对日志进行实时计算后入库。", "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConsumer\n<公共请求参数>\n\n{\n \"TopicId\": \"xxx-xxx-xxx-xxx\",\n \"Ckafka\": {\n \"Vip\": \"10.123.123.123\",\n \"Vport\": \"8888\",\n \"InstanceId\": \"xxxxx\",\n \"InstanceName\": \"myname\",\n \"TopicId\": \"xxxxx\",\n \"TopicName\": \"xxxxx\"\n },\n \"Content\": {\n \"EnableTag\": true,\n \"MetaFields\": [\n \"__SOURCE__\"\n ]\n },\n \"NeedContent\": true,\n \"Compression\": 0\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx\"\n }\n}", - "title": "创建投递任务" + "title": "创建投递Ckafka任务" } ], "CreateCosRecharge": [ @@ -131,7 +131,7 @@ "CreateKafkaRecharge": [ { "document": "创建Kafka导入规则", - "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateKafkaRecharge\n<公共请求参数>\n\n{\n \"TopicId\": \"b53fe5be-7ee3-4031-8043-5a73bad4f572\",\n \"Name\": \"testname\",\n \"KafkaType\": 1,\n \"ServerAddr\": \"192.168.0.1:9095\",\n \"IsEncryptionAddr\": true,\n \"UserKafkaTopics\": \"topic-1212123123,topic-sadf5r32f3ww\",\n \"ConsumerGroupName\": \"consumer-group-name\",\n \"Offset\": -1,\n \"LogRechargeRule\": {\n \"RechargeType\": \"json_log\",\n \"TimeKey\": \"abc\",\n \"TimeFormat\": \"abc\",\n \"LogRegex\": \"abc\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogKey\": \"abc\",\n \"DefaultTimeSwitch\": true,\n \"EncodingFormat\": 0\n },\n \"Protocol\": {\n \"Protocol\": \"plaintext\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateKafkaRecharge\n<公共请求参数>\n\n{\n \"TopicId\": \"b53fe5be-7ee3-4031-8043-5a73bad4f572\",\n \"Name\": \"testname\",\n \"KafkaType\": 1,\n \"ServerAddr\": \"192.168.0.1:9095\",\n \"IsEncryptionAddr\": true,\n \"UserKafkaTopics\": \"topic-1212123123,topic-sadf5r32f3ww\",\n \"ConsumerGroupName\": \"consumer-group-name\",\n \"Offset\": -1,\n \"LogRechargeRule\": {\n \"DefaultTimeSrc\": 0,\n \"DefaultTimeSwitch\": true,\n \"EncodingFormat\": 0,\n \"RechargeType\": \"minimalist_log\",\n \"UnMatchLogKey\": \"LogParseFailure\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogTimeSrc\": 0\n },\n \"Protocol\": {\n \"Protocol\": \"plaintext\"\n }\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"48d6a72b-99f7-4643-bc57-d63b6952b752\",\n \"Id\": \"11d6a72b-99f7-4643-bc57-d63b6952b711\"\n }\n}", "title": "创建Kafka导入规则" } @@ -348,7 +348,7 @@ { "document": "获取特殊采集配置", "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigExtras\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"configExtraId\",\n \"Values\": [\n \"xxxx-xxx-xxxx\"\n ]\n }\n ],\n \"Offset\": 0,\n \"Limit\": 10\n}", - "output": "{\n \"Response\": {\n \"Configs\": [\n {\n \"AdvancedConfig\": \"{\\\"ClsAgentFileTimeout\\\":3600}\",\n \"ConfigExtraId\": \"26ea1681-dfef-4429-a84f-3450d5d46796\",\n \"ConfigFlag\": \"label_k8s\",\n \"ContainerFile\": {\n \"Container\": \"\",\n \"CustomLabels\": null,\n \"ExcludeLabels\": null,\n \"ExcludeNamespace\": \"\",\n \"FilePaths\": [],\n \"FilePattern\": \"\",\n \"IncludeLabels\": null,\n \"LogPath\": \"\",\n \"Namespace\": \"\",\n \"WorkLoad\": {\n \"Container\": \"\",\n \"Kind\": \"\",\n \"Name\": \"\",\n \"Namespace\": \"\"\n }\n },\n \"ContainerStdout\": {\n \"AllContainers\": true,\n \"Container\": \"\",\n \"CustomLabels\": null,\n \"ExcludeLabels\": null,\n \"ExcludeNamespace\": \"\",\n \"IncludeLabels\": null,\n \"Namespace\": \"*\",\n \"WorkLoads\": null\n },\n \"CreateTime\": \"2023-12-04 14:32:35\",\n \"ExcludePaths\": null,\n \"ExtractRule\": {\n \"Address\": \"\",\n \"Backtracking\": 0,\n \"BeginRegex\": \"\",\n \"Delimiter\": \"\",\n \"EventLogRules\": [],\n \"FilterKeyRegex\": [],\n \"IsGBK\": 0,\n \"JsonStandard\": 0,\n \"Keys\": [\n \"__CONTENT__\"\n ],\n \"LogRegex\": \"\",\n \"MetaTags\": [],\n \"MetadataType\": 0,\n \"ParseProtocol\": \"\",\n \"PathRegex\": \"\",\n \"Protocol\": \"\",\n \"TimeFormat\": \"\",\n \"TimeKey\": \"\",\n \"UnMatchLogKey\": null,\n \"UnMatchUpLoadSwitch\": false\n },\n \"GroupId\": \"886bf7a8-7340-4314-8d64-b360da0ffd78\",\n \"HostFile\": {\n \"CustomLabels\": null,\n \"FilePattern\": \"\",\n \"LogPath\": \"\"\n },\n \"LogFormat\": \"\",\n \"LogType\": \"minimalist_log\",\n \"LogsetId\": \"40907915-faa6-46e0-985f-b2fa8c17a080\",\n \"LogsetName\": \"logset-test\",\n \"Name\": \"config-test-886bf7a8-7340-4314-8d64-b360da0ffd78\",\n \"TopicId\": \"b2dcf2e5-9582-4c87-9286-cccccb53889d\",\n \"TopicName\": \"topic-test\",\n \"Type\": \"container_stdout\",\n \"UpdateTime\": \"2023-12-04 14:32:34\",\n \"UserDefineRule\": \"\"\n }\n ],\n \"RequestId\": \"4e48c681-ebf8-4df1-bf0a-51f689117ac6\",\n \"TotalCount\": 1\n }\n}", + "output": "{\n \"Response\": {\n \"Configs\": [\n {\n \"AdvancedConfig\": \"{\\\"ClsAgentFileTimeout\\\":3600}\",\n \"CollectInfos\": [\n {\n \"CollectConfigs\": [\n {\n \"Name\": \"container_name\"\n },\n {\n \"Name\": \"namespace\"\n },\n {\n \"Name\": \"pod_name\"\n },\n {\n \"Name\": \"pod_ip\"\n }\n ],\n \"Type\": 0\n },\n {\n \"CollectConfigs\": [],\n \"Type\": 1\n }\n ],\n \"ConfigExtraId\": \"26ea1681-dfef-4429-a84f-3450d5d46796\",\n \"ConfigFlag\": \"label_k8s\",\n \"ContainerFile\": {\n \"Container\": \"\",\n \"CustomLabels\": null,\n \"ExcludeLabels\": null,\n \"ExcludeNamespace\": \"\",\n \"FilePaths\": [],\n \"FilePattern\": \"\",\n \"IncludeLabels\": null,\n \"LogPath\": \"\",\n \"Namespace\": \"\",\n \"WorkLoad\": {\n \"Container\": \"\",\n \"Kind\": \"\",\n \"Name\": \"\",\n \"Namespace\": \"\"\n }\n },\n \"ContainerStdout\": {\n \"AllContainers\": true,\n \"Container\": \"\",\n \"CustomLabels\": null,\n \"ExcludeLabels\": null,\n \"ExcludeNamespace\": \"\",\n \"IncludeLabels\": null,\n \"Namespace\": \"*\",\n \"WorkLoads\": null\n },\n \"CreateTime\": \"2023-12-04 14:32:35\",\n \"ExcludePaths\": null,\n \"ExtractRule\": {\n \"Address\": \"\",\n \"Backtracking\": 0,\n \"BeginRegex\": \"\",\n \"Delimiter\": \"\",\n \"EventLogRules\": [],\n \"FilterKeyRegex\": [],\n \"IsGBK\": 0,\n \"JsonStandard\": 0,\n \"Keys\": [\n \"__CONTENT__\"\n ],\n \"LogRegex\": \"\",\n \"MetaTags\": [],\n \"MetadataType\": 0,\n \"ParseProtocol\": \"\",\n \"PathRegex\": \"\",\n \"Protocol\": \"\",\n \"TimeFormat\": \"\",\n \"TimeKey\": \"\",\n \"UnMatchLogKey\": null,\n \"UnMatchUpLoadSwitch\": false\n },\n \"GroupId\": \"886bf7a8-7340-4314-8d64-b360da0ffd78\",\n \"HostFile\": {\n \"CustomLabels\": null,\n \"FilePattern\": \"\",\n \"LogPath\": \"\"\n },\n \"LogFormat\": \"\",\n \"LogType\": \"minimalist_log\",\n \"LogsetId\": \"40907915-faa6-46e0-985f-b2fa8c17a080\",\n \"LogsetName\": \"logset-test\",\n \"Name\": \"config-test-886bf7a8-7340-4314-8d64-b360da0ffd78\",\n \"TopicId\": \"b2dcf2e5-9582-4c87-9286-cccccb53889d\",\n \"TopicName\": \"topic-test\",\n \"Type\": \"container_stdout\",\n \"UpdateTime\": \"2023-12-04 14:32:34\",\n \"UserDefineRule\": \"\"\n }\n ],\n \"RequestId\": \"4e48c681-ebf8-4df1-bf0a-51f689117ac6\",\n \"TotalCount\": 1\n }\n}", "title": "获取特殊采集配置" } ], @@ -389,7 +389,13 @@ "document": "获取仪表盘", "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDashboards\n<公共请求参数>\n\n{\n \"Limit\": 1,\n \"Filters\": [\n {\n \"Values\": [\n \"dashboard-7ff51cf1-bff9-49f7-9fbb-6a9743225f92\"\n ],\n \"Key\": \"dashboardId\"\n }\n ],\n \"Offset\": 0\n}", "output": "{\n \"Response\": {\n \"DashboardInfos\": [\n {\n \"AssumerName\": \"\",\n \"AssumerUin\": 0,\n \"CreateTime\": \"2023-12-01 15:53:29\",\n \"DashboardId\": \"dashboard-7ff51cf1-bff9-49f7-9fbb-6a9743225f92\",\n \"DashboardName\": \"E32E23\",\n \"DashboardRegion\": \"\",\n \"DashboardTopicInfos\": [],\n \"Data\": \"\",\n \"RoleName\": \"\",\n \"Tags\": [\n {\n \"Key\": \"team\",\n \"Value\": \"test\"\n }\n ],\n \"UpdateTime\": \"2023-12-01 15:53:29\"\n }\n ],\n \"RequestId\": \"56c8e3f5-2b05-419d-acd0-8d2062df093f\",\n \"TotalCount\": 1\n }\n}", - "title": "获取仪表盘" + "title": "示例一" + }, + { + "document": "获取仪表盘", + "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDashboards\n<公共请求参数>\n\n{\n \"Offset\": 0,\n \"Limit\": 20,\n \"Filters\": [\n {\n \"Key\": \"tag:bowww-tag-key\",\n \"Values\": [\n \"bowww-tag-value\"\n ]\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"DashboardInfos\": [\n {\n \"DashboardId\": \"dashboard-47bf0f13-279c-461f-bb78-5b60229177ea\",\n \"DashboardName\": \"API-TEST2\",\n \"Data\": \"\",\n \"CreateTime\": \"2023-07-05 20:46:25\",\n \"UpdateTime\": \"2023-08-25 11:18:18\",\n \"DashboardRegion\": \"\",\n \"DashboardTopicInfos\": [],\n \"AssumerUin\": 0,\n \"RoleName\": \"\",\n \"AssumerName\": \"\",\n \"Tags\": [\n {\n \"Key\": \"bowww-tag-key\",\n \"Value\": \"bowww-tag-value\"\n },\n {\n \"Key\": \"bowww-tag-key1\",\n \"Value\": \"bowww-tag-value1\"\n }\n ]\n }\n ],\n \"RequestId\": \"6bf3355c-3c88-4566-89c8-76c3ca37bae9\"\n }\n}", + "title": "示例二" } ], "DescribeDataTransformInfo": [ @@ -428,7 +434,7 @@ { "document": "获取Kafka导入配置信息", "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeKafkaRecharges\n<公共请求参数>\n\n{\n \"TopicId\": \"abc\",\n \"Status\": 1\n}", - "output": "{\n \"Response\": {\n \"Infos\": [\n {\n \"Id\": \"abc\",\n \"TopicId\": \"abc\",\n \"Name\": \"abc\",\n \"ServerAddr\": \"test.cls.tencentyun.com:9095\",\n \"UserKafkaTopics\": \"topic1,topic2\",\n \"ConsumerGroupName\": \"\",\n \"Status\": 1,\n \"CreateTime\": \"abc\",\n \"UpdateTime\": \"abc\",\n \"LogRechargeRule\": {\n \"RechargeType\": \"json_log\",\n \"TimeKey\": \"abc\",\n \"TimeFormat\": \"abc\",\n \"LogRegex\": \"abc\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogKey\": \"abc\",\n \"EncodingFormat\": 0,\n \"DefaultTimeSwitch\": true\n }\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"Infos\": [\n {\n \"Id\": \"86076b49-1234-4321-ab09-a5d7e7972825\",\n \"TopicId\": \"957f4aed-1234-4321-b98b-c3c806f9e71b\",\n \"Name\": \"task-test\",\n \"KafkaType\": 1,\n \"KafkaInstance\": \"\",\n \"ServerAddr\": \"kafkaconsumer-ap-chongqing.aaa.com:1234\",\n \"IsEncryptionAddr\": true,\n \"Protocol\": {\n \"Protocol\": \"sasl_plaintext\",\n \"Mechanism\": \"PLAIN\",\n \"UserName\": \"1234567-8146-461f-a951-348c4748f63d\",\n \"Password\": \"AKIDxxxxx#abcdefjxxxx\"\n },\n \"UserKafkaTopics\": \"1256238147-f3061593-cd5b-4321-1234-3ba507d43301\",\n \"ConsumerGroupName\": \"\",\n \"Status\": 1,\n \"Offset\": -2,\n \"CreateTime\": \"2023-04-03 19:46:52\",\n \"UpdateTime\": \"2023-04-04 11:41:54\",\n \"LogRechargeRule\": {\n \"RechargeType\": \"json_log\",\n \"LogRegex\": \"\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogKey\": \"LogParseFailure\",\n \"UnMatchLogTimeSrc\": 0,\n \"EncodingFormat\": 0,\n \"DefaultTimeSwitch\": true,\n \"DefaultTimeSrc\": 0,\n \"TimeKey\": \"\",\n \"TimeRegex\": \"\",\n \"TimeFormat\": \"\",\n \"TimeZone\": \"UTC-11:00\",\n \"Metadata\": [\n \"kafka_topic\",\n \"kafka_partition\",\n \"kafka_offset\",\n \"kafka_timestamp\"\n ],\n \"Keys\": []\n }\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"7101f52f-a442-475b-90a3-4855133fefbf\"\n }\n}", "title": "获取Kafka导入配置信息" } ], @@ -592,10 +598,10 @@ ], "ModifyConsumer": [ { - "document": "", + "document": "修改投递Ckafka任务", "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConsumer\n<公共请求参数>\n\n{\n \"TopicId\": \"xxx-xxx-xxx-xxx\",\n \"Effective\": true,\n \"Ckafka\": {\n \"Vip\": \"10.123.123.123\",\n \"Vport\": \"8888\",\n \"InstanceId\": \"xxxxx\",\n \"InstanceName\": \"myname\",\n \"TopicId\": \"xxxxx\",\n \"TopicName\": \"xxxxx\"\n },\n \"Content\": {\n \"EnableTag\": true,\n \"MetaFields\": [\n \"__SOURCE__\"\n ]\n },\n \"NeedContent\": true,\n \"Compression\": 0\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx\"\n }\n}", - "title": "修改投递任务" + "title": "修改投递Ckafka任务" } ], "ModifyCosRecharge": [ @@ -689,7 +695,7 @@ "PreviewKafkaRecharge": [ { "document": "Kafka导入数据预览", - "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCosRecharge\n<公共请求参数>\n\n{\n \"PreviewType\": 1,\n \"KafkaType\": 1,\n \"ServerAddr\": \"test.cls.tencentyun.com:9095\",\n \"IsEncryptionAddr\": false,\n \"UserKafkaTopics\": \"topic1,topic2\",\n \"Offset\": 0,\n \"LogRechargeRule\": {\n \"RechargeType\": \"json_log\",\n \"TimeKey\": \"abc\",\n \"TimeFormat\": \"abc\",\n \"LogRegex\": \"abc\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogKey\": \"abc\",\n \"EncodingFormat\": 0,\n \"DefaultTimeSwitch\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCosRecharge\n<公共请求参数>\n\n{\n \"PreviewType\": 1,\n \"KafkaType\": 1,\n \"ServerAddr\": \"test.cls.tencentyun.com:9095\",\n \"IsEncryptionAddr\": false,\n \"UserKafkaTopics\": \"topic1,topic2\",\n \"Offset\": -1,\n \"LogRechargeRule\": {\n \"RechargeType\": \"json_log\",\n \"TimeKey\": \"abc\",\n \"TimeFormat\": \"abc\",\n \"LogRegex\": \"abc\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogKey\": \"abc\",\n \"EncodingFormat\": 0,\n \"DefaultTimeSwitch\": true\n }\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx\",\n \"LogData\": \"xxxxxxx\",\n \"LogSample\": \"abc\"\n }\n}", "title": "Kafka导入数据预览" } diff --git a/tccli/services/cwp/v20180228/api.json b/tccli/services/cwp/v20180228/api.json index 788eaa0afd..0bd40b0dca 100644 --- a/tccli/services/cwp/v20180228/api.json +++ b/tccli/services/cwp/v20180228/api.json @@ -26854,10 +26854,10 @@ { "disabled": false, "document": "实例环境", - "example": "云镜测试环境", + "example": "主机安全测试环境", "member": "string", "name": "KafkaEnvName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -26867,7 +26867,7 @@ "example": "ckafka-ce80kte5", "member": "string", "name": "KafkaId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -26877,7 +26877,7 @@ "example": "广州", "member": "string", "name": "Zone", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -26887,7 +26887,7 @@ "example": "广州三区", "member": "string", "name": "Az", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -26897,7 +26897,7 @@ "example": "xx", "member": "string", "name": "VpcId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -26907,7 +26907,7 @@ "example": "xx", "member": "string", "name": "SubnetId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -26917,7 +26917,7 @@ "example": "1", "member": "uint64", "name": "AccessType", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -26927,7 +26927,7 @@ "example": "192.168.1.1:80", "member": "string", "name": "AccessAddr", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -26937,7 +26937,7 @@ "example": "1", "member": "uint64", "name": "DeliverStatus", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -26947,7 +26947,7 @@ "example": "0.10.2.1", "member": "string", "name": "InsVersion", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -26957,7 +26957,7 @@ "example": "1200", "member": "int64", "name": "BandWidth", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -26967,7 +26967,7 @@ "example": "2500", "member": "int64", "name": "DiskSize", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -26977,7 +26977,7 @@ "example": "xx", "member": "string", "name": "Username", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -26987,7 +26987,7 @@ "example": "无", "member": "DeliverTypeDetails", "name": "DeliverTypeDetails", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -47298,8 +47298,8 @@ "members": [ { "disabled": false, - "document": "实例名称 如 云镜测试环境", - "example": "云镜测试环境", + "document": "实例名称 如 主机安全测试环境", + "example": "主机安全测试环境", "member": "string", "name": "KafkaEnvName", "required": true, @@ -47523,8 +47523,8 @@ "members": [ { "disabled": false, - "document": "实例名称 如 云镜测试环境", - "example": "云镜测试环境", + "document": "实例名称 如 主机安全测试环境", + "example": "主机安全测试环境", "member": "string", "name": "KafkaEnvName", "required": true, diff --git a/tccli/services/cwp/v20180228/examples.json b/tccli/services/cwp/v20180228/examples.json index 4c8ae45c26..b1d5588ec3 100644 --- a/tccli/services/cwp/v20180228/examples.json +++ b/tccli/services/cwp/v20180228/examples.json @@ -360,7 +360,7 @@ ], "DeleteMachine": [ { - "document": "本接口（DeleteMachine）用于卸载云镜客户端。", + "document": "本接口（DeleteMachine）用于卸载主机安全客户端。", "input": "https://cwp.tencentcloudapi.com/?Action=DeleteMachine\n&Uuid=354f4ac3-8546-4516-8c8a-69e3ab73aa8a\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"354f4ac3-8546-4516-8c8a-69e3ab73aa8a\"\n }\n}", "title": "卸载客户端" @@ -1784,7 +1784,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: cwp.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLogKafkaDeliverInfo\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"AccessAddr\": \"100.119.167.50:6281\",\n \"AccessType\": 2,\n \"Az\": \"广州三区\",\n \"BandWidth\": 0,\n \"DeliverStatus\": 1,\n \"DeliverTypeDetails\": [\n {\n \"SecurityType\": 1,\n \"LogType\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7\n ],\n \"TopicId\": \"topic-p9d8q5tm\",\n \"TopicName\": \"test\",\n \"Switch\": 1,\n \"Status\": 0,\n \"ErrInfo\": \" \"\n }\n ],\n \"DiskSize\": 0,\n \"InsVersion\": \"0.10.2.1\",\n \"KafkaEnvName\": \"云镜测试环境\",\n \"KafkaId\": \"ckafka-ce80kte5\",\n \"RequestId\": \"33e0611b-d363-4727-a7d6-ca405225bd52\",\n \"SubnetId\": \"-\",\n \"Username\": \"yunjing2\",\n \"VpcId\": \"-\",\n \"Zone\": \"广州\"\n }\n}", + "output": "{\n \"Response\": {\n \"KafkaEnvName\": \"abc\",\n \"KafkaId\": \"abc\",\n \"Zone\": \"abc\",\n \"Az\": \"abc\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"AccessType\": 1,\n \"AccessAddr\": \"abc\",\n \"DeliverStatus\": 1,\n \"InsVersion\": \"abc\",\n \"BandWidth\": 0,\n \"DiskSize\": 0,\n \"Username\": \"abc\",\n \"DeliverTypeDetails\": [\n {\n \"SecurityType\": 1,\n \"LogType\": [\n 0\n ],\n \"TopicId\": \"abc\",\n \"TopicName\": \"abc\",\n \"Switch\": 1,\n \"Status\": 1,\n \"ErrInfo\": \"abc\",\n \"StatusTime\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", "title": "获取kafka投递信息" } ], @@ -3705,7 +3705,7 @@ "ModifyLogKafkaAccess": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: cwp.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLogKafkaAccess\n<公共请求参数>\n\n{\n \"Username\": \"a\",\n \"VpcId\": \"1.1.1.1\",\n \"Zone\": \"广州\",\n \"KafkaId\": \"aa\",\n \"InsVersion\": \"1.1.1\",\n \"AccessType\": \"1\",\n \"KafkaEnvName\": \"云镜测试环境\",\n \"BandWidth\": \"300\",\n \"AccessAddr\": \"1.1.1.1\",\n \"Pwd\": \"b\",\n \"DiskSize\": \"400\",\n \"SubnetId\": \"1.1.1.1\",\n \"DeliverTypeDetails\": [\n {\n \"Status\": \"0\",\n \"TopicId\": \"xx\",\n \"SecurityType\": \"1\",\n \"LogType\": [\n \"1\"\n ],\n \"Switch\": \"0\",\n \"StatusTime\": \"11\",\n \"TopicName\": \"xx\",\n \"ErrInfo\": \"x\"\n }\n ],\n \"Az\": \"广州三区\",\n \"DeliverStatus\": \"1\",\n \"HasPwd\": \"1\"\n}", + "input": "POST / HTTP/1.1\nHost: cwp.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLogKafkaAccess\n<公共请求参数>\n\n{\n \"Username\": \"a\",\n \"VpcId\": \"1.1.1.1\",\n \"Zone\": \"广州\",\n \"KafkaId\": \"aa\",\n \"InsVersion\": \"1.1.1\",\n \"AccessType\": \"1\",\n \"KafkaEnvName\": \"主机安全测试环境\",\n \"BandWidth\": \"300\",\n \"AccessAddr\": \"1.1.1.1\",\n \"Pwd\": \"b\",\n \"DiskSize\": \"400\",\n \"SubnetId\": \"1.1.1.1\",\n \"DeliverTypeDetails\": [\n {\n \"Status\": \"0\",\n \"TopicId\": \"11\",\n \"SecurityType\": \"1\",\n \"LogType\": [\n \"1\"\n ],\n \"Switch\": \"0\",\n \"StatusTime\": \"11\",\n \"TopicName\": \"11\",\n \"ErrInfo\": \"1\"\n }\n ],\n \"Az\": \"广州三区\",\n \"DeliverStatus\": \"1\",\n \"HasPwd\": \"1\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"fee0ea18-d002-4af0-bee3-7f6efd19e357\"\n }\n}", "title": "示例" } @@ -3721,8 +3721,8 @@ "ModifyLogKafkaState": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: cwp.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLogKafkaState\n<公共请求参数>\n\n{\n \"KafkaEnvName\": \"云镜测试环境\",\n \"KafkaId\": \"ckafka-ce80kte5\",\n \"AccessType\": 1,\n \"AccessAddr\": \"127.0.0.1:80\",\n \"Username\": \"xx\",\n \"Zone\": \"广州\",\n \"Az\": \"广州三区\",\n \"VpcId\": \"-\",\n \"SubnetId\": \"-\",\n \"DeliverStatus\": 1,\n \"InsVersion\": \"0.10.2.1\",\n \"BandWidth\": 1200,\n \"DiskSize\": 2500\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"xx\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: cwp.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLogKafkaState\n<公共请求参数>\n\n{\n \"KafkaEnvName\": \"主机安全测试环境\",\n \"KafkaId\": \"ckafka-ce80kte5\",\n \"AccessType\": 1,\n \"AccessAddr\": \"127.0.0.1:80\",\n \"Username\": \"12\",\n \"Zone\": \"广州\",\n \"Az\": \"广州三区\",\n \"VpcId\": \"-\",\n \"SubnetId\": \"-\",\n \"DeliverStatus\": 1,\n \"InsVersion\": \"0.10.2.1\",\n \"BandWidth\": 1200,\n \"DiskSize\": 2500\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"absc\"\n }\n}", "title": "修改日志投递状态信息" } ], diff --git a/tccli/services/dasb/dasb_client.py b/tccli/services/dasb/dasb_client.py index a289f4ebec..abcd250f15 100644 --- a/tccli/services/dasb/dasb_client.py +++ b/tccli/services/dasb/dasb_client.py @@ -121,6 +121,58 @@ def doDescribeDeviceGroupMembers(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doModifyOAuthSetting(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.DasbClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.ModifyOAuthSettingRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.ModifyOAuthSetting(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 doDescribeLoginEvent(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -2890,6 +2942,7 @@ def doSearchSessionCommand(args, parsed_globals): ACTION_MAP = { "ModifyDeviceGroup": doModifyDeviceGroup, "DescribeDeviceGroupMembers": doDescribeDeviceGroupMembers, + "ModifyOAuthSetting": doModifyOAuthSetting, "DescribeLoginEvent": doDescribeLoginEvent, "CreateDeviceGroup": doCreateDeviceGroup, "DeleteDeviceAccounts": doDeleteDeviceAccounts, diff --git a/tccli/services/dasb/v20191018/api.json b/tccli/services/dasb/v20191018/api.json index fe2d6a523b..a7e7e2a7bc 100644 --- a/tccli/services/dasb/v20191018/api.json +++ b/tccli/services/dasb/v20191018/api.json @@ -294,6 +294,13 @@ "output": "ModifyDeviceGroupResponse", "status": "online" }, + "ModifyOAuthSetting": { + "document": "设置OAuth认证参数", + "input": "ModifyOAuthSettingRequest", + "name": "设置OAuth认证参数", + "output": "ModifyOAuthSettingResponse", + "status": "online" + }, "ModifyResource": { "document": "资源变配", "input": "ModifyResourceRequest", @@ -4646,6 +4653,96 @@ ], "type": "object" }, + "ModifyOAuthSettingRequest": { + "document": "ModifyOAuthSetting请求参数结构体", + "members": [ + { + "disabled": false, + "document": "是否开启OAuth认证，false-不开启，true-开启。", + "example": "无", + "member": "bool", + "name": "Enable", + "required": true, + "type": "bool" + }, + { + "disabled": false, + "document": "OAuth认证方式。", + "example": "okta", + "member": "string", + "name": "AuthMethod", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "OAuth认证客户端Id", + "example": "无", + "member": "string", + "name": "ClientId", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "OAuth认证客户端密钥", + "example": "无", + "member": "string", + "name": "ClientSecret", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "获取OAuth认证授权码URL", + "example": "无", + "member": "string", + "name": "CodeUrl", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "获取OAuth令牌URL", + "example": "无", + "member": "string", + "name": "TokenUrl", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "获取OAuth用户信息URL", + "example": "无", + "member": "string", + "name": "UserInfoUrl", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "使用Okta认证时指定范围。为空时默认使用 openid、profile、email。", + "example": "无", + "member": "string", + "name": "Scopes", + "required": false, + "type": "list" + } + ], + "type": "object" + }, + "ModifyOAuthSettingResponse": { + "document": "ModifyOAuthSetting返回参数结构体", + "members": [ + { + "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "ModifyResourceRequest": { "document": "ModifyResource请求参数结构体", "members": [ diff --git a/tccli/services/dasb/v20191018/examples.json b/tccli/services/dasb/v20191018/examples.json index 4be99fa5d9..dfba79872f 100644 --- a/tccli/services/dasb/v20191018/examples.json +++ b/tccli/services/dasb/v20191018/examples.json @@ -354,6 +354,14 @@ "title": "修改资产组" } ], + "ModifyOAuthSetting": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: dasb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyOAuthSetting\n<公共请求参数>\n\n{\n \"Enable\": true,\n \"AuthMethod\": \"okta\",\n \"ClientId\": \"client-id\",\n \"ClientSecret\": \"client-secret\",\n \"CodeUrl\": \"https://some-url/oauth2/v1/authorize\",\n \"TokenUrl\": \"https://some-url/oauth2/v1/token\",\n \"UserInfoUrl\": \"https://some-url/oauth2/v1/userinfo\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}", + "title": "设置Okta认证配置" + } + ], "ModifyResource": [ { "document": "已购买资源变配", diff --git a/tccli/services/dsgc/v20190723/api.json b/tccli/services/dsgc/v20190723/api.json index 2ba473b1bf..eed34eca68 100644 --- a/tccli/services/dsgc/v20190723/api.json +++ b/tccli/services/dsgc/v20190723/api.json @@ -4207,6 +4207,24 @@ "name": "ResourceName", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "实例类型\ndatabse\nsid\nserviceName", + "example": "无", + "member": "string", + "name": "InstanceType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "实例值", + "example": "无", + "member": "string", + "name": "InstanceValue", + "required": false, + "type": "string" } ], "type": "object" @@ -4220,7 +4238,7 @@ "example": "无", "member": "string", "name": "ConnectivityStatus", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -4230,7 +4248,7 @@ "example": "无", "member": "string", "name": "ConnectivityDescription", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -8686,6 +8704,15 @@ "name": "DataSourceId", "required": true, "type": "string" + }, + { + "disabled": false, + "document": "数据源类型", + "example": "mysql", + "member": "string", + "name": "DataSourceType", + "required": false, + "type": "string" } ], "type": "object" @@ -8699,7 +8726,7 @@ "example": "无", "member": "DSPADataSourceDbInfo", "name": "Items", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -9225,6 +9252,24 @@ "name": "ComplianceId", "required": true, "type": "int" + }, + { + "disabled": false, + "document": "云上还是自建\n", + "example": "cloud", + "member": "string", + "name": "BuildType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "数据源类型", + "example": "无", + "member": "string", + "name": "DataSourceType", + "required": false, + "type": "string" } ], "type": "object" @@ -9640,6 +9685,15 @@ "name": "DataSourceType", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "自建还是云上", + "example": "cloud", + "member": "string", + "name": "BuildType", + "required": false, + "type": "string" } ], "type": "object" @@ -9653,7 +9707,7 @@ "example": "无", "member": "DspaRDBDataAssetCount", "name": "Stats", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -10681,7 +10735,7 @@ "example": "bucket-1", "member": "string", "name": "BucketName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -10691,7 +10745,7 @@ "example": "test.txt", "member": "string", "name": "FileName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -10701,7 +10755,7 @@ "example": "身份证", "member": "string", "name": "RuleName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -10711,7 +10765,7 @@ "example": "2", "member": "int64", "name": "SensitiveDataCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -10721,7 +10775,7 @@ "example": "个人基本信息", "member": "string", "name": "CategoryName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -10731,7 +10785,7 @@ "example": "高", "member": "string", "name": "LevelRiskName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -10741,7 +10795,7 @@ "example": "TRUE", "member": "bool", "name": "KMSEncrypted", - "required": true, + "output_required": true, "type": "bool", "value_allowed_null": false }, @@ -10751,7 +10805,7 @@ "example": "text", "member": "string", "name": "FileType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -10761,7 +10815,7 @@ "example": "32B", "member": "string", "name": "FileSize", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -10771,7 +10825,7 @@ "example": "1", "member": "int64", "name": "LevelRiskScore", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -10781,7 +10835,7 @@ "example": "datasource-00000000", "member": "string", "name": "DataSourceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -10791,7 +10845,7 @@ "example": "1", "member": "int64", "name": "RuleId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -10801,7 +10855,7 @@ "example": "ap-guangzhou", "member": "string", "name": "ResourceRegion", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -10811,7 +10865,7 @@ "example": "1", "member": "int64", "name": "CategoryId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -10821,7 +10875,7 @@ "example": "1", "member": "int64", "name": "LevelId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -10831,7 +10885,7 @@ "example": "1", "member": "int64", "name": "FileResultId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -10841,7 +10895,7 @@ "example": "test", "member": "string", "name": "DataSourceName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -10851,9 +10905,29 @@ "example": "无", "member": "string", "name": "CategoryFullPath", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "0-系统识别\n1-人工识别\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "1", + "member": "int64", + "name": "IdentifyType", + "output_required": false, + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "0-系统识别\n1-人工识别\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "1", + "member": "int64", + "name": "CheckStatus", + "output_required": false, + "type": "int", + "value_allowed_null": true } ], "usage": "out" @@ -12268,7 +12342,7 @@ "example": "1", "member": "string", "name": "DataSourceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12278,7 +12352,7 @@ "example": "db1,db2", "member": "string", "name": "Condition", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12288,7 +12362,7 @@ "example": "1.1.1.1:8080", "member": "string", "name": "ProxyAddress", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -12298,7 +12372,7 @@ "example": "test", "member": "string", "name": "DataSourceName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -12308,7 +12382,17 @@ "example": "ap-guangzhou", "member": "string", "name": "ResourceRegion", - "required": true, + "output_required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "无\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "DataSourceType", + "output_required": false, "type": "string", "value_allowed_null": true } @@ -13324,6 +13408,7 @@ "example": "无", "member": "string", "name": "ResourceId", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -13334,6 +13419,7 @@ "example": "无", "member": "string", "name": "ResourceName", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -13344,6 +13430,7 @@ "example": "无", "member": "string", "name": "ResourceVip", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -13354,6 +13441,7 @@ "example": "无", "member": "uint64", "name": "ResourceVPort", + "output_required": true, "required": true, "type": "int", "value_allowed_null": false @@ -13364,6 +13452,7 @@ "example": "无", "member": "string", "name": "ResourceCreateTime", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -13374,6 +13463,7 @@ "example": "无", "member": "string", "name": "ResourceUniqueVpcId", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -13384,6 +13474,7 @@ "example": "无", "member": "string", "name": "ResourceUniqueSubnetId", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -13394,6 +13485,7 @@ "example": "mysql", "member": "string", "name": "MetaType", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -13404,6 +13496,7 @@ "example": "无", "member": "string", "name": "ResourceRegion", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -13414,6 +13507,7 @@ "example": "无", "member": "string", "name": "ResourceSyncTime", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -13424,6 +13518,7 @@ "example": "无", "member": "string", "name": "AuthStatus", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -13434,6 +13529,7 @@ "example": "无", "member": "string", "name": "BuildType", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -13444,6 +13540,7 @@ "example": "无", "member": "string", "name": "MasterInsId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -13454,6 +13551,7 @@ "example": "1", "member": "uint64", "name": "ResourceVpcId", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -13464,6 +13562,7 @@ "example": "1", "member": "uint64", "name": "ResourceSubnetId", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -13474,6 +13573,7 @@ "example": "mysql", "member": "string", "name": "Protocol", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -13484,6 +13584,7 @@ "example": "无", "member": "string", "name": "ResourceVersion", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -13494,6 +13595,7 @@ "example": "automatic", "member": "string", "name": "ResourceAuthType", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -13504,9 +13606,32 @@ "example": "无", "member": "string", "name": "ResourceAuthAccount", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false + }, + { + "disabled": false, + "document": "x\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "InstanceType", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "x\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "InstanceValue", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": true } ], "usage": "both" @@ -15362,6 +15487,33 @@ "name": "IsSetNonSensitiveFile", "required": false, "type": "bool" + }, + { + "disabled": false, + "document": "文件名", + "example": "file1", + "member": "string", + "name": "FileName", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "桶名", + "example": "bucket-xx", + "member": "string", + "name": "BucketName", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "数据源id", + "example": "cos-xxx", + "member": "string", + "name": "DataSourceId", + "required": false, + "type": "string" } ], "type": "object" diff --git a/tccli/services/dsgc/v20190723/examples.json b/tccli/services/dsgc/v20190723/examples.json index da8b76f7dd..b3e48a50ae 100644 --- a/tccli/services/dsgc/v20190723/examples.json +++ b/tccli/services/dsgc/v20190723/examples.json @@ -748,7 +748,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: dsgc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDSPARDBDataAssetByComplianceId\n<公共请求参数>\n\n{\n \"DspaId\": \"dspa-00001\",\n \"ComplianceId\": \"1\"\n}", - "output": "{\n \"Response\": {\n \"Stats\": {\n \"SensitiveDbCnt\": 3,\n \"SensitiveLevel\": [\n {\n \"LevelCnt\": 10,\n \"LevelRiskName\": \"S2\",\n \"LevelRiskScore\": 10,\n \"LevelId\": 1\n }\n ],\n \"CategoryDistributed\": [\n {\n \"Count\": 1,\n \"CategoryId\": 0,\n \"CategoryName\": \"xx\"\n }\n ],\n \"TotalFieldCnt\": 50,\n \"SensitiveCategoryCnt\": 6,\n \"TotalTableCnt\": 20,\n \"TotalDbCnt\": 5,\n \"SensitiveFieldCnt\": 20,\n \"SensitiveTableCnt\": 10,\n \"DataAssetType\": 0\n },\n \"RequestId\": \"xx\"\n }\n}", + "output": "{\n \"Response\": {\n \"Stats\": {\n \"DataAssetType\": 0,\n \"TotalDbCnt\": 0,\n \"TotalTableCnt\": 0,\n \"SensitiveCategoryCnt\": 0,\n \"SensitiveFieldCnt\": 0,\n \"SensitiveLevel\": [\n {\n \"LevelId\": 0,\n \"LevelCnt\": 0,\n \"LevelRiskName\": \"abc\",\n \"LevelRiskScore\": 0\n }\n ],\n \"SensitiveDbCnt\": 0,\n \"SensitiveTableCnt\": 0,\n \"TotalFieldCnt\": 0,\n \"CategoryDistributed\": [\n {\n \"CategoryId\": 0,\n \"CategoryName\": \"abc\",\n \"Count\": 1,\n \"CategoryFullPath\": \"abc\"\n }\n ]\n },\n \"RequestId\": \"abc\"\n }\n}", "title": "获取单个合规组下的RDB关系数据库分类分级数据资产" } ], diff --git a/tccli/services/ess/ess_client.py b/tccli/services/ess/ess_client.py index e0ae7babff..8c8c693545 100644 --- a/tccli/services/ess/ess_client.py +++ b/tccli/services/ess/ess_client.py @@ -2721,6 +2721,58 @@ def doCreateIntegrationUserRoles(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doDescribeSignFaceVideo(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.EssClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.DescribeSignFaceVideoRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.DescribeSignFaceVideo(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 doUploadFiles(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -3824,6 +3876,7 @@ def doCreateFlowGroupByFiles(args, parsed_globals): "DescribeFlowBriefs": doDescribeFlowBriefs, "CreateIntegrationRole": doCreateIntegrationRole, "CreateIntegrationUserRoles": doCreateIntegrationUserRoles, + "DescribeSignFaceVideo": doDescribeSignFaceVideo, "UploadFiles": doUploadFiles, "CreateBatchSignUrl": doCreateBatchSignUrl, "CreateOrganizationBatchSignUrl": doCreateOrganizationBatchSignUrl, diff --git a/tccli/services/ess/v20201111/api.json b/tccli/services/ess/v20201111/api.json index 05a2e4db4c..b7c79dcfc0 100644 --- a/tccli/services/ess/v20201111/api.json +++ b/tccli/services/ess/v20201111/api.json @@ -406,6 +406,13 @@ "output": "DescribePersonCertificateResponse", "status": "online" }, + "DescribeSignFaceVideo": { + "document": "该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。\n\n1. 该接口**仅适用于在H5端签署**的合同，**在通过视频认证后**获取人脸图片。\n2. 该接口**不支持小程序端**的签署人脸图片获取。\n3. 请在**签署完成后的三天内**获取人脸图片，**过期后将无法获取**。\n\n**注意：该接口需要开通白名单，请联系客户经理开通后使用。**", + "input": "DescribeSignFaceVideoRequest", + "name": "查询签署认证人脸视频", + "output": "DescribeSignFaceVideoResponse", + "status": "online" + }, "DescribeThirdPartyAuthCode": { "document": "通过AuthCode查询个人用户是否实名\n\n\n注意: \n", "input": "DescribeThirdPartyAuthCodeRequest", @@ -7386,6 +7393,90 @@ ], "type": "object" }, + "DescribeSignFaceVideoRequest": { + "document": "DescribeSignFaceVideo请求参数结构体", + "members": [ + { + "disabled": false, + "document": "执行本接口操作的员工信息。使用此接口时，必须填写userId。
    注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`", + "example": "无", + "member": "UserInfo", + "name": "Operator", + "required": true, + "type": "object" + }, + { + "disabled": false, + "document": "合同流程ID，为32位字符串。", + "example": "yDCNsUUckpvqwg3kUyIemOrwQm9ltij5", + "member": "string", + "name": "FlowId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "签署参与人在本流程中的编号ID(每个流程不同)，可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。", + "example": "yDxjNUUgydjfeklxUuO4zjEBgCqAHMKu", + "member": "string", + "name": "SignId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "代理企业和员工的信息。\n在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。", + "example": "无", + "member": "Agent", + "name": "Agent", + "required": false, + "type": "object" + } + ], + "type": "object" + }, + "DescribeSignFaceVideoResponse": { + "document": "DescribeSignFaceVideo返回参数结构体", + "members": [ + { + "disabled": false, + "document": "核身视频结果。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "DetectInfoVideoData", + "name": "VideoData", + "output_required": false, + "type": "object", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "IntentionQuestionResult", + "name": "IntentionQuestionResult", + "output_required": false, + "type": "object", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "意愿核身点头确认模式的结果信息，若未使用该意愿核身功能，该字段返回值可以不处理。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "IntentionActionResult", + "name": "IntentionActionResult", + "output_required": false, + "type": "object", + "value_allowed_null": true + }, + { + "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "DescribeThirdPartyAuthCodeRequest": { "document": "DescribeThirdPartyAuthCode请求参数结构体", "members": [ @@ -7535,6 +7626,22 @@ ], "type": "object" }, + "DetectInfoVideoData": { + "document": "视频认证结果", + "members": [ + { + "disabled": false, + "document": "活体视频的base64编码，mp4格式\n\n注:`需进行base64解码获取活体视频文件`\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "LiveNessVideo", + "output_required": false, + "type": "string", + "value_allowed_null": true + } + ], + "usage": "out" + }, "DisableUserAutoSignRequest": { "document": "DisableUserAutoSign请求参数结构体", "members": [ @@ -8658,6 +8765,15 @@ "name": "Deadline", "required": false, "type": "int" + }, + { + "disabled": false, + "document": "视频核身意图配置，可指定问答模式或者点头模式的语音文本。\n\n注:\n `1.视频认证为白名单功能，使用前请联系对接的客户经理沟通。`\n`2.使用视频认证必须指定签署认证方式为人脸（即ApproverSignTypes）。`", + "example": "无", + "member": "Intention", + "name": "Intention", + "required": false, + "type": "object" } ], "usage": "in" @@ -9427,6 +9543,146 @@ ], "usage": "out" }, + "Intention": { + "document": "视频核身意图配置，可指定问答模式或者点头模式的语音文本。\n\n注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`", + "members": [ + { + "disabled": false, + "document": "视频认证类型，支持以下类型\n\n\n注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`", + "example": "1", + "member": "int64", + "name": "IntentionType", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。", + "example": "无", + "member": "IntentionQuestion", + "name": "IntentionQuestions", + "required": false, + "type": "list" + }, + { + "disabled": false, + "document": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。", + "example": "无", + "member": "IntentionAction", + "name": "IntentionActions", + "required": false, + "type": "list" + } + ], + "usage": "in" + }, + "IntentionAction": { + "document": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。", + "members": [ + { + "disabled": false, + "document": "点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。", + "example": "请问您本次业务是本人自愿办理吗？如是，请点头确认。", + "member": "string", + "name": "Text", + "required": false, + "type": "string" + } + ], + "usage": "in" + }, + "IntentionActionResult": { + "document": "意愿核身点头确认模式结果", + "members": [ + { + "disabled": false, + "document": "意愿核身结果详细数据，与每段点头确认过程一一对应\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "IntentionActionResultDetail", + "name": "Details", + "output_required": false, + "type": "list", + "value_allowed_null": true + } + ], + "usage": "out" + }, + "IntentionActionResultDetail": { + "document": "意愿核身点头确认模式结果详细数据", + "members": [ + { + "disabled": false, + "document": "视频base64编码（其中包含全程提示文本和点头音频，mp4格式）\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "Video", + "output_required": false, + "type": "string", + "value_allowed_null": true + } + ], + "usage": "out" + }, + "IntentionQuestion": { + "document": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。", + "members": [ + { + "disabled": false, + "document": "当选择语音问答模式时，系统自动播报的问题文本，最大长度为150个字符。", + "example": "请问您本次业务是本人自愿办理吗？如是，请回复“我同意”。", + "member": "string", + "name": "Question", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": " 当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。", + "example": "“同意”，“我同意”，“确认”，“我确认”", + "member": "string", + "name": "Answers", + "required": false, + "type": "list" + } + ], + "usage": "in" + }, + "IntentionQuestionResult": { + "document": "意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。", + "members": [ + { + "disabled": false, + "document": "视频base64（其中包含全程问题和回答音频，mp4格式）\n\n注：`需进行base64解码获取视频文件`\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "Video", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": " 和答案匹配结果列表\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "ResultCode", + "output_required": false, + "type": "list", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "回答问题语音识别结果列表\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "AsrResult", + "output_required": false, + "type": "list", + "value_allowed_null": true + } + ], + "usage": "out" + }, "ModifyApplicationCallbackInfoRequest": { "document": "ModifyApplicationCallbackInfo请求参数结构体", "members": [ diff --git a/tccli/services/ess/v20201111/examples.json b/tccli/services/ess/v20201111/examples.json index 53bdef9323..5200543f36 100644 --- a/tccli/services/ess/v20201111/examples.json +++ b/tccli/services/ess/v20201111/examples.json @@ -544,6 +544,12 @@ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowSignUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"UrlType\": 1,\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\"\n}", "output": "{\n \"Response\": {\n \"FlowApproverUrlInfos\": [\n {\n \"ApproverMobile\": \"\",\n \"ApproverName\": \"\",\n \"ApproverType\": 0,\n \"LongUrl\": \"https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=Mi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&PreviewType=2&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA\",\n \"SignUrl\": \"https://essurl.cn/bR8**HA\"\n }\n ],\n \"RequestId\": \"s1693832180480950012\"\n }\n}", "title": "创建合同发起方预览链接" + }, + { + "document": "发起流程后，给其中的C端签署人创建签署链接，并且使用视频认证方式", + "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowSignUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"FlowApproverInfos\": [\n {\n \"ApproverType\": 1,\n \"ApproverMobile\": \"13200000000\",\n \"ApproverName\": \"典子谦\",\n \"ApproverSignTypes\": [\n 1\n ],\n \"Intention\": {\n \"IntentionType\": 1,\n \"IntentionQuestions\": [\n {\n \"Question\": \"请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。\",\n \"Answers\": [\n \"同意\",\n \"我同意\"\n ]\n }\n ]\n }\n }\n ],\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\"\n}", + "output": "{\n \"Response\": {\n \"FlowApproverUrlInfos\": [\n {\n \"ApproverMobile\": \"13200000000\",\n \"ApproverName\": \"典子谦\",\n \"ApproverType\": 1,\n \"LongUrl\": \"https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=Mi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&ApproverType=1&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA\",\n \"SignUrl\": \"https://essurl.cn/bR8**HA\"\n }\n ],\n \"RequestId\": \"s1693832180480950012\"\n }\n}", + "title": "创建个人用户H5签署链接，使用视频认证方式" } ], "CreateIntegrationDepartment": [ @@ -1268,6 +1274,14 @@ "title": "查询个人自动签证书-用户未开通自动签" } ], + "DescribeSignFaceVideo": [ + { + "document": "1. 个人用户在H5端完成合同签署，通过视频问答模式认证。\n2. 所需白名单已经开通。\n3. 在签署完成后的三天内获取人脸图片。", + "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSignFaceVideo\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"SignId\": \"yDCNOUUckpv3ecwcUECtq4n1jXPLxLq7\"\n}", + "output": "{\n \"Response\": {\n \"IntentionQuestionResult\": {\n \"AsrResult\": [\n \"同意\"\n ],\n \"ResultCode\": [\n \"0\"\n ],\n \"Video\": \"AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB\"\n },\n \"RequestId\": \"s1709628366717791449\",\n \"VideoData\": {\n \"LiveNessVideo\": \"AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB\"\n }\n }\n}", + "title": "查询签署认证人脸视频结果" + } + ], "DescribeThirdPartyAuthCode": [ { "document": "通过AuthCode查询用户是否实名，AuthCode 查询后作废，只能查询一次", diff --git a/tccli/services/essbasic/essbasic_client.py b/tccli/services/essbasic/essbasic_client.py index ae3455c692..516e4795c4 100644 --- a/tccli/services/essbasic/essbasic_client.py +++ b/tccli/services/essbasic/essbasic_client.py @@ -435,6 +435,58 @@ def doSendFlowUrl(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doChannelDescribeSignFaceVideo(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.EssbasicClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.ChannelDescribeSignFaceVideoRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.ChannelDescribeSignFaceVideo(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 doChannelDeleteRoleUsers(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -6384,6 +6436,7 @@ def doCreateServerFlowSign(args, parsed_globals): "DescribeBatchOrganizationRegistrationUrls": doDescribeBatchOrganizationRegistrationUrls, "DescribeUsage": doDescribeUsage, "SendFlowUrl": doSendFlowUrl, + "ChannelDescribeSignFaceVideo": doChannelDescribeSignFaceVideo, "ChannelDeleteRoleUsers": doChannelDeleteRoleUsers, "CreateSignUrls": doCreateSignUrls, "ChannelCreateBoundFlows": doChannelCreateBoundFlows, diff --git a/tccli/services/essbasic/v20210526/api.json b/tccli/services/essbasic/v20210526/api.json index 8c8bd058dd..bd2a4e1868 100644 --- a/tccli/services/essbasic/v20210526/api.json +++ b/tccli/services/essbasic/v20210526/api.json @@ -259,6 +259,13 @@ "output": "ChannelDescribeRolesResponse", "status": "online" }, + "ChannelDescribeSignFaceVideo": { + "document": "该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。\n\n1. 该接口**仅适用于在H5端签署**的合同，**在通过视频认证后**获取人脸图片。\n2. 该接口**不支持小程序端**的签署人脸图片获取。\n3. 请在**签署完成后的三天内**获取人脸图片，**过期后将无法获取**。\n\n**注意：该接口需要开通白名单，请联系客户经理开通后使用。**", + "input": "ChannelDescribeSignFaceVideoRequest", + "name": "查询签署认证人脸视频", + "output": "ChannelDescribeSignFaceVideoResponse", + "status": "online" + }, "ChannelDescribeUserAutoSignStatus": { "document": "通过此接口获取个人用户自动签的开通状态。\n\n注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`", "input": "ChannelDescribeUserAutoSignStatusRequest", @@ -4346,6 +4353,81 @@ ], "type": "object" }, + "ChannelDescribeSignFaceVideoRequest": { + "document": "ChannelDescribeSignFaceVideo请求参数结构体", + "members": [ + { + "disabled": false, + "document": "合同流程ID，为32位字符串。\n建议开发者妥善保存此流程ID，以便于顺利进行后续操作。\n可登录腾讯电子签控制台，在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。", + "example": "yDCNsUUckpvqwg3kUyIemOrwQm9ltij5", + "member": "string", + "name": "FlowId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "签署参与人在本流程中的编号ID(每个流程不同)，可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。", + "example": "yDxjNUUgydjfeklxUuO4zjEBgCqAHMKu", + "member": "string", + "name": "SignId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。\n\n此接口下面信息必填。\n\n第三方平台子客企业和员工必须已经经过实名认证", + "example": "无", + "member": "Agent", + "name": "Agent", + "required": true, + "type": "object" + } + ], + "type": "object" + }, + "ChannelDescribeSignFaceVideoResponse": { + "document": "ChannelDescribeSignFaceVideo返回参数结构体", + "members": [ + { + "disabled": false, + "document": "核身视频结果。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "DetectInfoVideoData", + "name": "VideoData", + "output_required": false, + "type": "object", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "IntentionQuestionResult", + "name": "IntentionQuestionResult", + "output_required": false, + "type": "object", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "意愿核身点头确认模式的结果信息，若未使用该意愿核身功能，该字段返回值可以不处理。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "IntentionActionResult", + "name": "IntentionActionResult", + "output_required": false, + "type": "object", + "value_allowed_null": true + }, + { + "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "ChannelDescribeUserAutoSignStatusRequest": { "document": "ChannelDescribeUserAutoSignStatus请求参数结构体", "members": [ @@ -7390,6 +7472,22 @@ ], "type": "object" }, + "DetectInfoVideoData": { + "document": "视频认证结果", + "members": [ + { + "disabled": false, + "document": "活体视频的base64编码，mp4格式\n\n注:`需进行base64解码获取活体视频文件`\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "LiveNessVideo", + "output_required": false, + "type": "string", + "value_allowed_null": true + } + ], + "usage": "out" + }, "DownloadFlowInfo": { "document": "签署流程下载信息", "members": [ @@ -8037,6 +8135,15 @@ "name": "Components", "required": false, "type": "list" + }, + { + "disabled": false, + "document": "视频核身意图配置，可指定问答模式或者点头模式的语音文本。\n\n注:\n `1.视频认证为白名单功能，使用前请联系对接的客户经理沟通。`\n`2.使用视频认证必须指定签署认证方式为人脸（即ApproverSignTypes）。`", + "example": "无", + "member": "Intention", + "name": "Intention", + "required": false, + "type": "object" } ], "usage": "in" @@ -8718,6 +8825,146 @@ ], "usage": "both" }, + "Intention": { + "document": "视频核身意图配置，可指定问答模式或者点头模式的语音文本。\n\n注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`", + "members": [ + { + "disabled": false, + "document": "视频认证类型，支持以下类型\n\n\n注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`", + "example": "1", + "member": "int64", + "name": "IntentionType", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。", + "example": "无", + "member": "IntentionQuestion", + "name": "IntentionQuestions", + "required": false, + "type": "list" + }, + { + "disabled": false, + "document": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。", + "example": "无", + "member": "IntentionAction", + "name": "IntentionActions", + "required": false, + "type": "list" + } + ], + "usage": "in" + }, + "IntentionAction": { + "document": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。", + "members": [ + { + "disabled": false, + "document": "点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。", + "example": "请问您本次业务是本人自愿办理吗？如是，请点头确认。", + "member": "string", + "name": "Text", + "required": false, + "type": "string" + } + ], + "usage": "in" + }, + "IntentionActionResult": { + "document": "意愿核身点头确认模式结果", + "members": [ + { + "disabled": false, + "document": "意愿核身结果详细数据，与每段点头确认过程一一对应\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "IntentionActionResultDetail", + "name": "Details", + "output_required": false, + "type": "list", + "value_allowed_null": true + } + ], + "usage": "out" + }, + "IntentionActionResultDetail": { + "document": "意愿核身点头确认模式结果详细数据", + "members": [ + { + "disabled": false, + "document": "视频base64编码（其中包含全程提示文本和点头音频，mp4格式）\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "Video", + "output_required": false, + "type": "string", + "value_allowed_null": true + } + ], + "usage": "out" + }, + "IntentionQuestion": { + "document": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。", + "members": [ + { + "disabled": false, + "document": "当选择语音问答模式时，系统自动播报的问题文本，最大长度为150个字符。", + "example": "请问您本次业务是本人自愿办理吗？如是，请回复“我同意”。", + "member": "string", + "name": "Question", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": " 当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。", + "example": "“同意”，“我同意”，“确认”，“我确认”", + "member": "string", + "name": "Answers", + "required": false, + "type": "list" + } + ], + "usage": "in" + }, + "IntentionQuestionResult": { + "document": "意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。", + "members": [ + { + "disabled": false, + "document": "视频base64（其中包含全程问题和回答音频，mp4格式）\n\n注：`需进行base64解码获取视频文件`\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "Video", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": " 和答案匹配结果列表\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "ResultCode", + "output_required": false, + "type": "list", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "回答问题语音识别结果列表\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "AsrResult", + "output_required": false, + "type": "list", + "value_allowed_null": true + } + ], + "usage": "out" + }, "ModifyExtendedServiceRequest": { "document": "ModifyExtendedService请求参数结构体", "members": [ diff --git a/tccli/services/essbasic/v20210526/examples.json b/tccli/services/essbasic/v20210526/examples.json index 761c434154..c1731cc11c 100644 --- a/tccli/services/essbasic/v20210526/examples.json +++ b/tccli/services/essbasic/v20210526/examples.json @@ -254,6 +254,12 @@ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"UrlType\": 1,\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\"\n}", "output": "{\n \"Response\": {\n \"FlowApproverUrlInfos\": [\n {\n \"ApproverType\": \"\",\n \"LongUrl\": \"https://quick.qian.tencent.cn/home?ApproverIdCardNumber=NCoqK***&ApproverIdCardType=ID_CARD&ApproverMobile=MTU4%3D&ApproverName=%25E9%2583%2591%****1%2589&PreviewType=2&Code=yDwhGUUckp3s****z1m3P&CodeType=QUICK&FlowId=yD****T&ShowHeader=1&token=HXC***d\",\n \"Mobile\": \"\",\n \"Name\": \"\",\n \"SignUrl\": \"https://test.essurl.cn/HXC***d\"\n }\n ],\n \"RequestId\": \"s1690514917653165172\"\n }\n}", "title": "创建合同发起方预览链接" + }, + { + "document": "发起流程后，给其中的C端签署人创建签署链接，并指定视频问答模式认证", + "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"FlowApproverInfos\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"ApproverSignTypes\": [\n 1\n ],\n \"Intention\": {\n \"IntentionType\": 1,\n \"IntentionQuestions\": [\n {\n \"Question\": \"请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。\",\n \"Answers\": [\n \"同意\",\n \"我同意\"\n ]\n }\n ]\n }\n }\n ],\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\"\n}", + "output": "{\n \"Response\": {\n \"FlowApproverUrlInfos\": [\n {\n \"ApproverType\": \"PERSON\",\n \"LongUrl\": \"https://quick.qian.tencent.cn/home?ApproverIdCardNumber=NCoqK***&ApproverIdCardType=ID_CARD&ApproverMobile=MTU4%3D&ApproverName=%25E9%2583%2591%****1%2589&ApproverType=1&Code=yDwhGUUckp3s****z1m3P&CodeType=QUICK&FlowId=yD****T&ShowHeader=1&token=HXC***d\",\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"SignUrl\": \"https://test.essurl.cn/HXC***d\"\n }\n ],\n \"RequestId\": \"s1690514917653165172\"\n }\n}", + "title": "创建个人用户H5签署链接，并指定视频问答模式认证" } ], "ChannelCreateMultiFlowSignQRCode": [ @@ -542,6 +548,14 @@ "title": "查询角色列表（返回权限树信息）" } ], + "ChannelDescribeSignFaceVideo": [ + { + "document": "1. 个人用户在H5端完成合同签署，通过视频问答模式认证。\n2. 所需白名单已经开通。\n3. 在签署完成后的三天内获取人脸图片。", + "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSignFaceVideo\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"SignId\": \"yDCNOUUckpv3ecwcUECtq4n1jXPLxLq7\"\n}", + "output": "{\n \"Response\": {\n \"IntentionQuestionResult\": {\n \"AsrResult\": [\n \"同意\"\n ],\n \"ResultCode\": [\n \"0\"\n ],\n \"Video\": \"AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB\"\n },\n \"RequestId\": \"s1709628366717791449\",\n \"VideoData\": {\n \"LiveNessVideo\": \"AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB\"\n }\n }\n}", + "title": "查询签署认证人脸视频结果" + } + ], "ChannelDescribeUserAutoSignStatus": [ { "document": "查看个人自动签状态, 同时也会返回自动签license类型，如果是 0 类型，则同时会返回开始和过期时间。", diff --git a/tccli/services/ocr/v20181119/api.json b/tccli/services/ocr/v20181119/api.json index c4eca9c62d..73714b8f70 100644 --- a/tccli/services/ocr/v20181119/api.json +++ b/tccli/services/ocr/v20181119/api.json @@ -7121,7 +7121,7 @@ }, { "disabled": false, - "document": "证件图片", + "document": "证件中的人像图片base64", "example": "无", "member": "string", "name": "Image", diff --git a/tccli/services/tdmq/v20200217/api.json b/tccli/services/tdmq/v20200217/api.json index fb7f222f70..b95e2d5f4a 100644 --- a/tccli/services/tdmq/v20200217/api.json +++ b/tccli/services/tdmq/v20200217/api.json @@ -3855,8 +3855,8 @@ }, { "disabled": false, - "document": "主题类型，可选值为Normal, PartitionedOrder, Transaction, DelayScheduled。", - "example": "Default", + "document": "主题类型，可选值为Normal, GlobalOrder, PartitionedOrder, Transaction, DelayScheduled。Transaction仅在专享版支持。", + "example": "Normal", "member": "string", "name": "Type", "required": true, diff --git a/tccli/services/teo/v20220901/api.json b/tccli/services/teo/v20220901/api.json index 03ecebfcca..d0112b1f90 100644 --- a/tccli/services/teo/v20220901/api.json +++ b/tccli/services/teo/v20220901/api.json @@ -6636,7 +6636,7 @@ "members": [ { "disabled": false, - "document": "过滤条件，Filters.Values的上限为20。详细的过滤条件如下：\n
  • zone-name
       按照【站点名称】进行过滤。
       类型：String
       必选：是
    • ", + "document": "过滤条件，Filters.Values的上限为20。详细的过滤条件如下：\n
  • zone-name：按照站点名称进行过滤。
    • ", "example": "无", "member": "Filter", "name": "Filters", @@ -6673,7 +6673,7 @@ "example": "10", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -6683,7 +6683,7 @@ "example": "无", "member": "Identification", "name": "Identifications", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, diff --git a/tccli/services/trocket/v20230308/api.json b/tccli/services/trocket/v20230308/api.json index c4072b01bf..028b7619e3 100644 --- a/tccli/services/trocket/v20230308/api.json +++ b/tccli/services/trocket/v20230308/api.json @@ -516,7 +516,7 @@ }, { "disabled": false, - "document": "商品规格，可用规格如下：\nexperiment_500,\nbasic_1k,\nbasic_2k,\nbasic_4k,\nbasic_6k", + "document": "商品规格，可用规格如下：\nexperiment_500,\nbasic_1k,\nbasic_2k,\nbasic_4k,\nbasic_6k,\npro_4k,\npro_6k,\npro_1w,\npro_2w,\npro_3w,\npro_4w,\npro_5w,\nplatinum_6k,\nplatinum_1w,\nplatinum_2w,\nplatinum_4w,\nplatinum_10w,\nplatinum_15w,\nplatinum_20w,\nplatinum_40w,\nplatinum_60w,\nplatinum_100w", "example": "无", "member": "string", "name": "SkuCode", @@ -561,7 +561,7 @@ }, { "disabled": false, - "document": "公网带宽", + "document": "公网带宽（单位：兆）", "example": "无", "member": "int64", "name": "Bandwidth", @@ -579,12 +579,48 @@ }, { "disabled": false, - "document": "消息保留时长，小时为单位", + "document": "消息保留时长（单位：小时）", "example": "无", "member": "int64", "name": "MessageRetention", "required": false, "type": "int" + }, + { + "disabled": false, + "document": "付费模式（0: 后付费；1: 预付费）", + "example": "无", + "member": "int64", + "name": "PayMode", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "是否自动续费（0: 不自动续费；1: 自动续费）", + "example": "无", + "member": "int64", + "name": "RenewFlag", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "购买时长（单位：月）", + "example": "无", + "member": "int64", + "name": "TimeSpan", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "最大可创建主题数", + "example": "50", + "member": "int64", + "name": "MaxTopicNum", + "required": false, + "type": "int" } ], "type": "object" @@ -598,6 +634,7 @@ "example": "rmq-xxxx", "member": "string", "name": "InstanceId", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1038,6 +1075,15 @@ "name": "Remark", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "消息保留时长", + "example": "72", + "member": "int64", + "name": "MsgTTL", + "required": false, + "type": "int" } ], "type": "object" @@ -1051,6 +1097,7 @@ "example": "无", "member": "string", "name": "InstanceId", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1060,6 +1107,7 @@ "example": "无", "member": "string", "name": "Topic", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -3018,13 +3066,22 @@ "required": true, "type": "string" }, + { + "disabled": false, + "document": "查询条件列表", + "example": "无", + "member": "Filter", + "name": "Filters", + "required": false, + "type": "list" + }, { "disabled": false, "document": "查询起始位置", "example": "0", "member": "int64", "name": "Offset", - "required": true, + "required": false, "type": "int" }, { @@ -3033,17 +3090,8 @@ "example": "10", "member": "int64", "name": "Limit", - "required": true, - "type": "int" - }, - { - "disabled": false, - "document": "查询条件列表", - "example": "无", - "member": "Filter", - "name": "Filters", "required": false, - "type": "list" + "type": "int" } ], "type": "object" @@ -3099,13 +3147,22 @@ "required": true, "type": "string" }, + { + "disabled": false, + "document": "查询条件列表", + "example": "无", + "member": "Filter", + "name": "Filters", + "required": false, + "type": "list" + }, { "disabled": false, "document": "查询起始位置", "example": "0", "member": "int64", "name": "Offset", - "required": true, + "required": false, "type": "int" }, { @@ -3114,17 +3171,8 @@ "example": "10", "member": "int64", "name": "Limit", - "required": true, - "type": "int" - }, - { - "disabled": false, - "document": "查询条件列表", - "example": "无", - "member": "Filter", - "name": "Filters", "required": false, - "type": "list" + "type": "int" } ], "type": "object" @@ -3138,6 +3186,7 @@ "example": "无", "member": "string", "name": "InstanceId", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -3147,6 +3196,7 @@ "example": "无", "member": "string", "name": "Topic", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -3156,6 +3206,7 @@ "example": "无", "member": "string", "name": "TopicType", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -3165,6 +3216,7 @@ "example": "无", "member": "string", "name": "Remark", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -3174,6 +3226,7 @@ "example": "无", "member": "int64", "name": "CreatedTime", + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -3183,6 +3236,7 @@ "example": "无", "member": "int64", "name": "LastUpdateTime", + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -3192,6 +3246,7 @@ "example": "无", "member": "int64", "name": "SubscriptionCount", + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -3201,9 +3256,20 @@ "example": "无", "member": "SubscriptionData", "name": "SubscriptionData", + "output_required": true, "type": "list", "value_allowed_null": false }, + { + "disabled": false, + "document": "消息保留时长", + "example": "72", + "member": "int64", + "name": "MsgTTL", + "output_required": false, + "type": "int", + "value_allowed_null": false + }, { "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。", "member": "string", @@ -4329,6 +4395,15 @@ "name": "ScaledTpsEnabled", "required": false, "type": "bool" + }, + { + "disabled": false, + "document": "最大可创建主题数", + "example": "100", + "member": "int64", + "name": "MaxTopicNum", + "required": false, + "type": "int" } ], "type": "object" @@ -4983,7 +5058,7 @@ "example": "rmq-xxx", "member": "string", "name": "InstanceId", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -4993,7 +5068,7 @@ "example": "test", "member": "string", "name": "Topic", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5003,7 +5078,7 @@ "example": "无", "member": "string", "name": "TopicType", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5013,7 +5088,7 @@ "example": "无", "member": "int64", "name": "TopicQueueNum", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -5023,7 +5098,7 @@ "example": "无", "member": "string", "name": "ConsumerGroup", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5033,7 +5108,7 @@ "example": "无", "member": "bool", "name": "IsOnline", - "required": false, + "output_required": true, "type": "bool", "value_allowed_null": true }, @@ -5043,7 +5118,7 @@ "example": "无", "member": "string", "name": "ConsumeType", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5053,7 +5128,7 @@ "example": "无", "member": "string", "name": "SubString", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5063,7 +5138,7 @@ "example": "无", "member": "string", "name": "ExpressionType", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5073,7 +5148,7 @@ "example": "无", "member": "int64", "name": "Consistency", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -5083,7 +5158,7 @@ "example": "无", "member": "int64", "name": "ConsumerLag", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -5093,7 +5168,7 @@ "example": "无", "member": "int64", "name": "LastUpdateTime", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -5103,7 +5178,7 @@ "example": "无", "member": "int64", "name": "MaxRetryTimes", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -5113,9 +5188,19 @@ "example": "无", "member": "bool", "name": "ConsumeMessageOrderly", - "required": false, + "output_required": true, "type": "bool", "value_allowed_null": true + }, + { + "disabled": false, + "document": "消费模式: \nBROADCASTING 广播模式;\nCLUSTERING 集群模式;\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "CLUSTERING", + "member": "string", + "name": "MessageModel", + "output_required": false, + "type": "string", + "value_allowed_null": true } ], "usage": "out" @@ -5179,6 +5264,7 @@ "example": "rmq-xxxx", "member": "string", "name": "InstanceId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -5189,6 +5275,7 @@ "example": "test", "member": "string", "name": "Topic", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -5199,6 +5286,7 @@ "example": "无", "member": "string", "name": "TopicType", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -5209,6 +5297,7 @@ "example": "3", "member": "int64", "name": "QueueNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -5219,9 +5308,65 @@ "example": "无", "member": "string", "name": "Remark", + "output_required": true, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "4.x的集群id\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "ClusterIdV4", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "4.x的命名空间\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "NamespaceV4", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "4.x的主题名称\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "TopicV4", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "4.x的完整命名空间\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "FullNamespaceV4", + "output_required": false, "required": false, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "消息保留时长\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "72", + "member": "int64", + "name": "MsgTTL", + "output_required": false, + "required": false, + "type": "int", + "value_allowed_null": true } ], "usage": "both" diff --git a/tccli/services/trtc/v20190722/api.json b/tccli/services/trtc/v20190722/api.json index f215c5cdc9..1fe0b54fb2 100644 --- a/tccli/services/trtc/v20190722/api.json +++ b/tccli/services/trtc/v20190722/api.json @@ -976,7 +976,7 @@ }, { "disabled": false, - "document": "需查询的指标，不填则只返回用户列表，填all则返回所有指标。\nappCpu：APP CPU使用率；\nsysCpu：系统 CPU使用率；\naBit：上/下行音频码率；单位：bps\naBlock：音频卡顿时长；单位：ms\nbigvBit：上/下行视频码率；单位：bps\nbigvCapFps：视频采集帧率；\nbigvEncFps：视频发送帧率；\nbigvDecFps：渲染帧率；\nbigvBlock：视频卡顿时长；单位：ms\naLoss：上/下行音频丢包率；\nbigvLoss：上/下行视频丢包率；\nbigvWidth：上/下行分辨率宽；\nbigvHeight：上/下行分辨率高", + "document": "需查询的指标，不填则只返回用户列表，填all则返回所有指标。\nappCpu：APP CPU使用率；\nsysCpu：系统 CPU使用率；\naBit：上/下行音频码率；单位：bps\naBlock：音频卡顿时长；单位：ms\nbigvBit：上/下行视频码率；单位：bps\nbigvCapFps：视频采集帧率；\nbigvEncFps：视频发送帧率；\nbigvDecFps：渲染帧率；\nbigvBlock：视频卡顿时长；单位：ms\naLoss：上/下行音频丢包率；\nbigvLoss：上/下行视频丢包率；\nbigvWidth：上/下行分辨率宽；\nbigvHeight：上/下行分辨率高；\naCapEnergy：音频采集能量；\naPlayEnergy：音频播放能量；\nrtt：SDK到云端的往返延时；单位: ms", "example": "[\"bigvCapFps\"]", "member": "string", "name": "DataType", diff --git a/tccli/services/tse/v20201207/api.json b/tccli/services/tse/v20201207/api.json index 806afd1e29..d3d0856779 100644 --- a/tccli/services/tse/v20201207/api.json +++ b/tccli/services/tse/v20201207/api.json @@ -8177,6 +8177,17 @@ "required": false, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "云函数是否开启CAM鉴权，不填时默认为开启(true)\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "true", + "member": "bool", + "name": "ScfCamAuthEnable", + "output_required": false, + "required": false, + "type": "bool", + "value_allowed_null": true } ], "usage": "both" @@ -10896,6 +10907,17 @@ "required": false, "type": "list", "value_allowed_null": true + }, + { + "disabled": false, + "document": "健康检查屏蔽权重为0的节点\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "true", + "member": "bool", + "name": "IgnoreZeroWeightNodes", + "output_required": false, + "required": false, + "type": "bool", + "value_allowed_null": true } ], "usage": "both" diff --git a/tccli/services/vpc/v20170312/api.json b/tccli/services/vpc/v20170312/api.json index 6d18af23dc..822dace52e 100644 --- a/tccli/services/vpc/v20170312/api.json +++ b/tccli/services/vpc/v20170312/api.json @@ -3696,7 +3696,7 @@ "members": [ { "disabled": false, - "document": "VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", + "document": "VPC实例ID。形如：vpc-xxx。", "example": "vpc-8xpno8ee", "member": "string", "name": "VpcId", @@ -3705,7 +3705,7 @@ }, { "disabled": false, - "document": "NAT网关ID。", + "document": "NAT网关ID。形如：nat-xxx", "example": "nat-ig8xpno8", "member": "string", "name": "NatGatewayId", @@ -3714,7 +3714,7 @@ }, { "disabled": false, - "document": "专线网关ID。", + "document": "专线网关ID。形如：dcg-xxx", "example": "dcg-fxa6gh5t", "member": "string", "name": "DirectConnectGatewayId", @@ -17390,8 +17390,8 @@ "members": [ { "disabled": false, - "document": "专线网关ID。", - "example": "vpc-xxx", + "document": "VPC实例ID。形如：vpc-xxx。", + "example": "vpc-8xpno8ee", "member": "string", "name": "VpcId", "required": true, @@ -17399,8 +17399,8 @@ }, { "disabled": false, - "document": "NAT网关ID。", - "example": "nat-xxx", + "document": "NAT网关ID。形如：nat-xxx", + "example": "nat-ig8xpno8", "member": "string", "name": "NatGatewayId", "required": true, @@ -17408,8 +17408,8 @@ }, { "disabled": false, - "document": "VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", - "example": "dcg-xxx", + "document": "专线网关ID。形如：dcg-xxx", + "example": "dcg-fxa6gh5t", "member": "string", "name": "DirectConnectGatewayId", "required": true, @@ -22025,7 +22025,7 @@ "members": [ { "disabled": false, - "document": "VPC实例ID。形如：vpc-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpcIds和Filters。", + "document": "VPC实例ID。形如：vpc-f49l6u0z。", "example": "vpc-m7sr81gh", "member": "string", "name": "VpcId", diff --git a/tccli/services/vpc/v20170312/examples.json b/tccli/services/vpc/v20170312/examples.json index 256d5c7340..c6243e9c40 100644 --- a/tccli/services/vpc/v20170312/examples.json +++ b/tccli/services/vpc/v20170312/examples.json @@ -1962,7 +1962,7 @@ ], "DisassociateDirectConnectGatewayNatGateway": [ { - "document": "", + "document": "解绑专线网关与公网NAT网关", "input": "https://vpc.tencentcloudapi.com/?Action=DisassociateDirectConnectGatewayNatGateway\n&VpcId=\"vpc-8xpno8ee\"\n&DirectConnectGatewayId=\"dcg-fxa6gh5t\"\n&NatGatewayId=\"nat-ig8xpno8\"\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"dbffc3f0-1807-4683-89ee-2d2b96425ee1\"\n }\n}", "title": "专线网关解绑NAT网关"