diff --git a/CHANGELOG.md b/CHANGELOG.md index 3dda04dc5f..cff0883eaf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,76 @@ +# Release 3.0.1153.1 + +## 云应用(cloudapp) 版本：2022-05-30 + +### 第 1 次发布 + +发布时间：2024-07-17 10:02:42 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [VerifyLicense](https://cloud.tencent.com/document/api/1689/108874) + +新增数据结构： + +* [License](https://cloud.tencent.com/document/api/1689/108875#License) +* [SaleParam](https://cloud.tencent.com/document/api/1689/108875#SaleParam) + + + +## 数据安全治理中心(dsgc) 版本：2019-07-23 + +### 第 16 次发布 + +发布时间：2024-07-18 01:10:11 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateDSPADiscoveryTask](https://cloud.tencent.com/document/api/1087/97252) + + * 新增入参：Order, Rows, GlobalOrderField + +* [DescribeDSPAESDataSample](https://cloud.tencent.com/document/api/1087/97209) + + * 新增入参：Order, OrderField + +* [DescribeDSPATaskResultDataSample](https://cloud.tencent.com/document/api/1087/97203) + + * 新增入参：Order, OrderField + + + + +## 腾讯电子签（基础版）(essbasic) 版本：2021-05-26 + +### 第 175 次发布 + +发布时间：2024-07-18 01:11:43 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [ChannelCreateBatchSignUrl](https://cloud.tencent.com/document/api/1420/98671) + + * 新增入参：OpenId, OrganizationOpenId + + + + +## 腾讯电子签（基础版）(essbasic) 版本：2020-12-22 + + + # Release 3.0.1152.1 ## 本地专用集群(cdc) 版本：2020-12-14 diff --git a/SERVICE_CHANGELOG.md b/SERVICE_CHANGELOG.md index f0f1b073c6..803a7331cb 100644 --- a/SERVICE_CHANGELOG.md +++ b/SERVICE_CHANGELOG.md @@ -1,112 +1,31 @@ # 本版本更新包含以下内容： -## 本地专用集群(cdc) 版本：2020-12-14 - -### 第 10 次发布 - -发布时间：2024-07-17 01:09:51 - -本次发布包含了以下内容： - -改善已有的文档。 - -修改接口： - -* [DescribeDedicatedClusterOrders](https://cloud.tencent.com/document/api/1346/73761) - - * 新增入参：OrderTypes - - -修改数据结构： - -* [DedicatedClusterOrder](https://cloud.tencent.com/document/api/1346/73770#DedicatedClusterOrder) - - * 新增成员：CheckStatus, DeliverExpectTime, DeliverFinishTime, CheckExpectTime, CheckFinishTime, OrderSLA, OrderPayPlan - - - - -## 数据湖计算 DLC(dlc) 版本：2021-01-25 - -### 第 97 次发布 - -发布时间：2024-07-17 01:14:09 - -本次发布包含了以下内容： - -改善已有的文档。 - -修改接口： - -* [DescribeDataEngineImageVersions](https://cloud.tencent.com/document/api/1342/99270) - - * 新增入参：Sort, Asc - - - - -## Elasticsearch Service(es) 版本：2018-04-16 - -### 第 62 次发布 - -发布时间：2024-07-17 01:15:53 - -本次发布包含了以下内容： - -改善已有的文档。 - -修改接口： - -* [UpdateInstance](https://cloud.tencent.com/document/api/845/30629) +## 云应用(cloudapp) 版本：2022-05-30 - * 新增入参：ShardAllocationConcurrents, ShardAllocationBytes - - - - -## 全球应用加速(gaap) 版本：2018-05-29 - -### 第 49 次发布 - -发布时间：2024-07-17 01:16:44 - -本次发布包含了以下内容： - -改善已有的文档。 - -修改接口： - -* [DescribeTaskStatus](https://cloud.tencent.com/document/api/608/108598) - - * 新增出参：Status, TaskId - - - - -## 腾讯混元大模型(hunyuan) 版本：2023-09-01 - -### 第 11 次发布 +### 第 1 次发布 -发布时间：2024-07-17 01:17:08 +发布时间：2024-07-17 10:02:42 本次发布包含了以下内容： 改善已有的文档。 -修改接口： +新增接口： -* [ChatCompletions](https://cloud.tencent.com/document/api/1729/105701) +* [VerifyLicense](https://cloud.tencent.com/document/api/1689/108874) - * 新增出参：ModerationLevel +新增数据结构： +* [License](https://cloud.tencent.com/document/api/1689/108875#License) +* [SaleParam](https://cloud.tencent.com/document/api/1689/108875#SaleParam) -## 实时互动-教育版(lcic) 版本：2022-08-17 +## 数据安全治理中心(dsgc) 版本：2019-07-23 -### 第 57 次发布 +### 第 16 次发布 -发布时间：2024-07-17 01:19:12 +发布时间：2024-07-18 01:10:11 本次发布包含了以下内容： @@ -114,66 +33,26 @@ 修改接口： -* [CreateRoom](https://cloud.tencent.com/document/api/1639/80942) - - * 新增入参：RecordStream - - -修改数据结构： - -* [RoomInfo](https://cloud.tencent.com/document/api/1639/81423#RoomInfo) - - * 新增成员：RecordStream - - - - -## 腾讯云可观测平台(monitor) 版本：2018-07-24 - -### 第 119 次发布 - -发布时间：2024-07-17 01:20:37 - -本次发布包含了以下内容： - -改善已有的文档。 - -修改数据结构： - -* [PrometheusRecordRuleYamlItem](https://cloud.tencent.com/document/api/248/30354#PrometheusRecordRuleYamlItem) - - * **修改成员**：Status, Id, Count - - - - -## 消息队列 TDMQ(tdmq) 版本：2020-02-17 - -### 第 119 次发布 - -发布时间：2024-07-17 01:25:48 +* [CreateDSPADiscoveryTask](https://cloud.tencent.com/document/api/1087/97252) -本次发布包含了以下内容： + * 新增入参：Order, Rows, GlobalOrderField -改善已有的文档。 +* [DescribeDSPAESDataSample](https://cloud.tencent.com/document/api/1087/97209) -新增接口： + * 新增入参：Order, OrderField -* [DescribeRocketMQTopicStats](https://cloud.tencent.com/document/api/1179/108864) -* [DescribeRocketMQTopicsByGroup](https://cloud.tencent.com/document/api/1179/108863) -* [ModifyRocketMQInstance](https://cloud.tencent.com/document/api/1179/108862) +* [DescribeDSPATaskResultDataSample](https://cloud.tencent.com/document/api/1087/97203) -新增数据结构： + * 新增入参：Order, OrderField -* [TopicStats](https://cloud.tencent.com/document/api/1179/46089#TopicStats) -## 私有网络(vpc) 版本：2017-03-12 +## 腾讯电子签（基础版）(essbasic) 版本：2021-05-26 -### 第 195 次发布 +### 第 175 次发布 -发布时间：2024-07-17 01:29:26 +发布时间：2024-07-18 01:11:43 本次发布包含了以下内容： @@ -181,31 +60,14 @@ 修改接口： -* [CreateHaVip](https://cloud.tencent.com/document/api/215/30652) - - * 新增入参：CheckAssociate - - * **修改入参**：SubnetId - - -新增数据结构： - -* [HaVipAssociation](https://cloud.tencent.com/document/api/215/15824#HaVipAssociation) - -修改数据结构： - -* [CcnInstance](https://cloud.tencent.com/document/api/215/15824#CcnInstance) +* [ChannelCreateBatchSignUrl](https://cloud.tencent.com/document/api/1420/98671) - * 新增成员：OrderType + * 新增入参：OpenId, OrganizationOpenId -* [CrossBorderCompliance](https://cloud.tencent.com/document/api/215/15824#CrossBorderCompliance) - * 新增成员：LegalPersonId, LegalPersonIdCard -* [HaVip](https://cloud.tencent.com/document/api/215/15824#HaVip) - - * 新增成员：HaVipAssociationSet, CheckAssociate, FlushedTime +## 腾讯电子签（基础版）(essbasic) 版本：2020-12-22 @@ -31153,6 +31015,28 @@ +## 云应用(cloudapp) 版本：2022-05-30 + +### 第 1 次发布 + +发布时间：2024-07-17 10:02:42 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [[VerifyLicense](https://cloud.tencent.com/document/api/1689/108874)](https://cloud.tencent.com/document/api/#/#) + +新增数据结构： + +* [[License](https://cloud.tencent.com/document/api/1689/108875#License)](https://cloud.tencent.com/document/api/1689/108875#[License](https://cloud.tencent.com/document/api/1689/108875#License)) +* [[SaleParam](https://cloud.tencent.com/document/api/1689/108875#SaleParam)](https://cloud.tencent.com/document/api/1689/108875#[SaleParam](https://cloud.tencent.com/document/api/1689/108875#SaleParam)) + + + + ## 操作审计(cloudaudit) 版本：2019-03-19 ### 第 13 次发布 @@ -55104,6 +54988,29 @@ ## 数据安全治理中心(dsgc) 版本：2019-07-23 +### 第 16 次发布 + +发布时间：2024-07-18 01:10:11 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateDSPADiscoveryTask](https://cloud.tencent.com/document/api/1087/97252) + + * 新增入参：Order, Rows, GlobalOrderField + +* [DescribeDSPAESDataSample](https://cloud.tencent.com/document/api/1087/97209) + + * 新增入参：Order, OrderField + +* [DescribeDSPATaskResultDataSample](https://cloud.tencent.com/document/api/1087/97203) + + * 新增入参：Order, OrderField + + ### 第 15 次发布 发布时间：2024-06-25 01:13:45 @@ -66270,6 +66177,21 @@ ## 腾讯电子签（基础版）(essbasic) 版本：2021-05-26 +### 第 175 次发布 + +发布时间：2024-07-18 01:11:43 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [ChannelCreateBatchSignUrl](https://cloud.tencent.com/document/api/1420/98671) + + * 新增入参：OpenId, OrganizationOpenId + + ### 第 174 次发布 发布时间：2024-07-12 01:16:22 @@ -124079,13 +124001,13 @@ 新增接口： -* [[DescribeRocketMQTopicStats](https://cloud.tencent.com/document/api/1179/108864)](https://cloud.tencent.com/document/api/#/#) -* [[DescribeRocketMQTopicsByGroup](https://cloud.tencent.com/document/api/1179/108863)](https://cloud.tencent.com/document/api/#/#) -* [[ModifyRocketMQInstance](https://cloud.tencent.com/document/api/1179/108862)](https://cloud.tencent.com/document/api/#/#) +* [DescribeRocketMQTopicStats](https://cloud.tencent.com/document/api/1179/108864) +* [DescribeRocketMQTopicsByGroup](https://cloud.tencent.com/document/api/1179/108863) +* [ModifyRocketMQInstance](https://cloud.tencent.com/document/api/1179/108862) 新增数据结构： -* [[TopicStats](https://cloud.tencent.com/document/api/1179/46089#TopicStats)](https://cloud.tencent.com/document/api/1179/46089#[TopicStats](https://cloud.tencent.com/document/api/1179/46089#TopicStats)) +* [TopicStats](https://cloud.tencent.com/document/api/1179/46089#TopicStats) ### 第 118 次发布 @@ -152889,7 +152811,7 @@ 新增数据结构： -* [[HaVipAssociation](https://cloud.tencent.com/document/api/215/15824#HaVipAssociation)](https://cloud.tencent.com/document/api/215/15824#[HaVipAssociation](https://cloud.tencent.com/document/api/215/15824#HaVipAssociation)) +* [HaVipAssociation](https://cloud.tencent.com/document/api/215/15824#HaVipAssociation) 修改数据结构： diff --git a/products.md b/products.md index 4cafc68e75..ecd2b45247 100644 --- a/products.md +++ b/products.md @@ -58,6 +58,7 @@ | cis | [](https://cloud.tencent.com/document/product) | 2018-06-07 15:01:42 | | ckafka | [消息队列 CKafka 版](https://cloud.tencent.com/document/product/597) | 2024-07-08 01:10:21 | | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2024-07-16 01:11:14 | +| cloudapp | [云应用](https://cloud.tencent.com/document/product/1689) | 2024-07-18 01:06:41 | | cloudaudit | [操作审计](https://cloud.tencent.com/document/product/629) | 2024-01-15 01:09:37 | | cloudhsm | [云加密机](https://cloud.tencent.com/document/product/639) | 2024-03-20 01:11:31 | | cloudstudio | [Cloud Studio（云端 IDE）](https://cloud.tencent.com/document/product/1039) | 2024-05-29 01:21:54 | @@ -86,7 +87,7 @@ | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2024-07-02 01:14:51 | | drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2024-07-12 01:14:44 | | ds | [文档服务](https://cloud.tencent.com/document/product/869) | 2024-03-20 01:15:13 | -| dsgc | [数据安全治理中心](https://cloud.tencent.com/document/product/1087) | 2024-06-25 01:13:45 | +| dsgc | [数据安全治理中心](https://cloud.tencent.com/document/product/1087) | 2024-07-18 01:10:11 | | dtf | [分布式事务](https://cloud.tencent.com/document/product/1224) | 2022-04-04 06:38:57 | | dts | [数据传输服务](https://cloud.tencent.com/document/product/571) | 2024-07-15 01:10:34 | | eb | [事件总线](https://cloud.tencent.com/document/product/1359) | 2024-06-07 01:44:56 | @@ -97,8 +98,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-07-09 01:14:34 | | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2024-07-17 01:15:53 | -| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-07-16 01:16:14 | -| essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2024-07-16 01:16:31 | +| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-07-18 01:11:27 | +| essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2024-07-18 01:11:43 | | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2024-07-16 01:16:45 | | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-06-26 01:16:46 | | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2024-07-05 01:10:44 | @@ -134,7 +135,7 @@ | keewidb | [云数据库 KeeWiDB](https://cloud.tencent.com/document/product/1520) | 2024-03-20 01:19:20 | | kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2024-04-17 01:17:16 | | lcic | [实时互动-教育版](https://cloud.tencent.com/document/product/1639) | 2024-07-17 01:19:12 | -| lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2024-07-11 01:19:19 | +| lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2024-07-18 01:14:43 | | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2024-07-12 01:19:39 | | lke | [大模型知识引擎](https://cloud.tencent.com/document/product/1759) | 2024-07-17 01:19:55 | | lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 | @@ -146,8 +147,8 @@ | mgobe | [游戏联机对战引擎](https://cloud.tencent.com/document/product/1038) | 2022-07-08 06:11:32 | | mmps | [小程序安全](https://cloud.tencent.com/document/product/1223) | 2024-07-02 01:19:41 | | mna | [多网聚合加速](https://cloud.tencent.com/document/product/1385) | 2024-07-11 01:20:22 | -| mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2024-07-15 01:15:52 | -| monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2024-07-17 01:20:37 | +| mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2024-07-18 01:15:51 | +| monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2024-07-18 01:15:58 | | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2024-07-16 01:21:13 | | mrs | [医疗报告结构化](https://cloud.tencent.com/document/product/1314) | 2024-06-14 02:16:42 | | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2024-06-05 02:02:03 | @@ -200,7 +201,7 @@ | tchd | [腾讯云健康看板](https://cloud.tencent.com/document/product/1688) | 2024-03-20 01:24:49 | | tci | [腾讯智学课堂分析](https://cloud.tencent.com/document/product) | 2020-08-24 08:06:03 | | tcm | [服务网格](https://cloud.tencent.com/document/product/1261) | 2024-06-18 02:13:19 | -| tcr | [容器镜像服务](https://cloud.tencent.com/document/product/1141) | 2024-07-01 01:23:21 | +| tcr | [容器镜像服务](https://cloud.tencent.com/document/product/1141) | 2024-07-18 01:20:10 | | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2024-06-26 01:23:56 | | tdcpg | [TDSQL-C PostgreSQL 版](https://cloud.tencent.com/document/product/1556) | 2024-07-10 01:25:35 | | tdid | [分布式身份](https://cloud.tencent.com/document/product/1439) | 2024-06-04 02:17:43 | @@ -239,7 +240,7 @@ | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2024-06-06 02:47:30 | | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2024-03-20 01:30:13 | | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2024-07-17 01:28:46 | -| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2024-07-17 01:29:26 | +| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2024-07-18 01:24:25 | | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2024-04-02 01:27:45 | | vtc | [视频转译](https://cloud.tencent.com/document/product/1769) | 2024-06-07 02:52:58 | | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2024-07-10 01:30:00 | diff --git a/pyproject.toml b/pyproject.toml index da95751d18..5a5e09664f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ exclude = ["tccli/examples"] [project] name = "tccli" -version = "3.0.1152.1" +version = "3.0.1153.1" authors = [ { name="tencentcloudapi", email="tencentcloudapi@tencent.com" }, ] @@ -24,7 +24,7 @@ classifiers = [ dependencies = [ "jmespath==0.10.0", "six==1.16.0", - "tencentcloud-sdk-python>=3.0.1152", + "tencentcloud-sdk-python>=3.0.1153", ] [project.urls] diff --git a/tccli/__init__.py b/tccli/__init__.py index 290c6f6d32..5bff7ec777 100644 --- a/tccli/__init__.py +++ b/tccli/__init__.py @@ -1 +1 @@ -__version__ = '3.0.1152.1' +__version__ = '3.0.1153.1' diff --git a/tccli/examples/cloudapp/v20220530/VerifyLicense.md b/tccli/examples/cloudapp/v20220530/VerifyLicense.md new file mode 100644 index 0000000000..3f77de3b04 --- /dev/null +++ b/tccli/examples/cloudapp/v20220530/VerifyLicense.md @@ -0,0 +1,43 @@ +**Example 1: 通过运行时roleId查询对应的软件 LICENSE** + + + +Input: + +``` +tccli cloudapp VerifyLicense --cli-unfold-argument ``` + +Output: +``` +{ + "Response": { + "License": { + "LicenseId": "abc", + "LicenseMode": "abc", + "LicenseStatus": "abc", + "ProviderId": 1, + "SoftwarePackageId": "abc", + "SoftwarePackageVersion": "abc", + "AuthorizedUserUin": "abc", + "AuthorizedCloudappId": "abc", + "AuthorizedCloudappRoleId": "abc", + "AuthorizedSpecification": [ + { + "ParamKey": "abc", + "ParamValue": "abc", + "ParamKeyName": "abc", + "ParamValueName": "abc" + } + ], + "BillingMode": 0, + "LifeSpan": 0, + "IssueDate": "2020-09-22T00:00:00+00:00", + "ActivationDate": "2020-09-22T00:00:00+00:00", + "ExpirationDate": "2020-09-22T00:00:00+00:00", + "LifeSpanUnit": "abc" + }, + "RequestId": "abc" + } +} +``` + diff --git a/tccli/examples/essbasic/v20210526/ChannelCreateBatchSignUrl.md b/tccli/examples/essbasic/v20210526/ChannelCreateBatchSignUrl.md index 902321f414..22fcea9542 100644 --- a/tccli/examples/essbasic/v20210526/ChannelCreateBatchSignUrl.md +++ b/tccli/examples/essbasic/v20210526/ChannelCreateBatchSignUrl.md @@ -29,9 +29,9 @@ Output: } ``` -**Example 2: 生成企业经办人小程序批量签署链接** +**Example 2: 生成saas企业经办人小程序批量签署链接** -按照合同发起时候填入的信息生成企业经办人批量签署链接，并通过FlowIds参数对用户可以批签的合同进行限制 +按照合同发起时候填入的信息生成saas企业经办人批量签署链接，并通过FlowIds参数对用户可以批签的合同进行限制 Input: @@ -125,3 +125,35 @@ Output: } ``` +**Example 5: 生成子客经办人小程序批量签署链接** + +按照合同发起时候填入的信息生成子客企业经办人批量签署链接，并通过FlowIds参数对用户可以批签的合同进行限制 + +Input: + +``` +tccli essbasic ChannelCreateBatchSignUrl --cli-unfold-argument \ + --OpenId test_open_id \ + --OrganizationOpenId test_org_open_id \ + --Name \ + --NotifyType SMS \ + --Mobile \ + --OrganizationName \ + --Agent.ProxyOperator.OpenId test_open_id \ + --Agent.ProxyOrganizationOpenId test_org_open_id \ + --Agent.AppId yDxbWUyKQ*******4zjEB8mxCcDjAyF \ + --FlowIds yDwFdUUckpsw******yQ0af8bHosXQtb yDR1AUUgygj******uO4zjE8gTG7xvgH +``` + +Output: +``` +{ + "Response": { + "ExpiredTime": 1684899114, + "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e", + "SignUrl": "https://ess.url.cn/FuP**Swc", + "MiniAppPath": "pages/guide/index?shortKey=FuP3**wc" + } +} +``` + diff --git a/tccli/examples/monitor/v20180724/CreatePrometheusClusterAgent.md b/tccli/examples/monitor/v20180724/CreatePrometheusClusterAgent.md index c3587cc2dd..ccf3808b0c 100644 --- a/tccli/examples/monitor/v20180724/CreatePrometheusClusterAgent.md +++ b/tccli/examples/monitor/v20180724/CreatePrometheusClusterAgent.md @@ -6,28 +6,28 @@ Input: ``` tccli monitor CreatePrometheusClusterAgent --cli-unfold-argument \ - --InstanceId xxx \ + --InstanceId prom-wjeh \ --Agents.0.EnableExternal True \ - --Agents.0.Region xxx \ - --Agents.0.ClusterId xxx \ - --Agents.0.ClusterType xxx \ + --Agents.0.Region ap-jehr \ + --Agents.0.ClusterId cls-hrbr \ + --Agents.0.ClusterType eks \ --Agents.0.NotInstallBasicScrape True \ --Agents.0.InClusterPodConfig.HostNet True \ - --Agents.0.InClusterPodConfig.Tolerations.0.Operator xxx \ - --Agents.0.InClusterPodConfig.Tolerations.0.Effect xxx \ - --Agents.0.InClusterPodConfig.Tolerations.0.Key xxx \ - --Agents.0.InClusterPodConfig.NodeSelector.0.Name xxx \ - --Agents.0.InClusterPodConfig.NodeSelector.0.Value xxx \ + --Agents.0.InClusterPodConfig.Tolerations.0.Operator Exists \ + --Agents.0.InClusterPodConfig.Tolerations.0.Effect NoSchedule \ + --Agents.0.InClusterPodConfig.Tolerations.0.Key key-name \ + --Agents.0.InClusterPodConfig.NodeSelector.0.Name label-name \ + --Agents.0.InClusterPodConfig.NodeSelector.0.Value label-value \ --Agents.0.NotScrape True \ - --Agents.0.ExternalLabels.0.Name xxx \ - --Agents.0.ExternalLabels.0.Value xxx + --Agents.0.ExternalLabels.0.Name label-name \ + --Agents.0.ExternalLabels.0.Value label-value ``` Output: ``` { "Response": { - "RequestId": "xxx" + "RequestId": "ejfhfol-lejrgbf" } } ``` diff --git a/tccli/examples/monitor/v20180724/CreatePrometheusTemp.md b/tccli/examples/monitor/v20180724/CreatePrometheusTemp.md index c2deeb48f2..730b61f7f1 100644 --- a/tccli/examples/monitor/v20180724/CreatePrometheusTemp.md +++ b/tccli/examples/monitor/v20180724/CreatePrometheusTemp.md @@ -15,112 +15,125 @@ tccli monitor CreatePrometheusTemp --cli-unfold-argument \ { "Template": { - "Name": "abc", - "Describe": "abc", - "Level": "abc", - "RecordRules": [ - { - "Name": "abc", - "Config": "abc", - "TemplateId": "abc", - "Targets": { - "Total": 1, - "Up": 1, - "Down": 1, - "Unknown": 1 - } - } - ], - "ServiceMonitors": [ - { - "Name": "abc", - "Config": "abc", - "TemplateId": "abc", - "Targets": { - "Total": 1, - "Up": 1, - "Down": 1, - "Unknown": 1 - } - } - ], - "PodMonitors": [ - { - "Name": "abc", - "Config": "abc", - "TemplateId": "abc", - "Targets": { - "Total": 1, - "Up": 1, - "Down": 1, - "Unknown": 1 - } - } - ], - "TemplateId": "abc", - "UpdateTime": "abc", - "Version": "abc", - "IsDefault": true, - "AlertDetailRules": [ - { - "Id": "abc", - "Name": "abc", - "TemplateId": "abc", - "Notification": { - "Enabled": true, - "Type": "abc", - "WebHook": "abc", - "AlertManager": { - "ClusterType": "abc", - "ClusterId": "abc", - "Url": "abc" - }, - "RepeatInterval": "abc", - "TimeRangeStart": "abc", - "TimeRangeEnd": "abc", - "NotifyWay": [ - "abc" - ], - "ReceiverGroups": [ - "abc" - ], - "PhoneNotifyOrder": [ - 1 - ], - "PhoneCircleTimes": 0, - "PhoneInnerInterval": 0, - "PhoneCircleInterval": 0, - "PhoneArriveNotice": true - }, - "Rules": [ + "Name": "test", + "Describe": "test", + "Level": "instance", + "RecordRules": [ + { + "Name": "testRule", + "Config": "abc", + "TemplateId": "temp-asdj", + "Targets": { + "Total": 1, + "Up": 1, + "Down": 1, + "Unknown": 1 + } + } + ], + "RawJobs": [ { "Name": "abc", - "Rule": "abc", - "Labels": [ - { - "Name": "abc", - "Value": "abc" - } - ], - "Template": "abc", - "For": "abc", - "Describe": "abc", - "Annotations": [ + "Config": "abc", + "TemplateId": "abc", + "Targets": { + "Total": 1, + "Up": 1, + "Down": 1, + "Unknown": 1 + } + } + ], + "ServiceMonitors": [ + { + "Name": "test-sm", + "Config": "abc", + "TemplateId": "temp-asdj", + "Targets": { + "Total": 1, + "Up": 1, + "Down": 1, + "Unknown": 1 + } + } + ], + "PodMonitors": [ + { + "Name": "test-pm", + "Config": "abc", + "TemplateId": "temp-asdj", + "Targets": { + "Total": 1, + "Up": 1, + "Down": 1, + "Unknown": 1 + } + } + ], + "TemplateId": "temp-asdj", + "UpdateTime": "2024-07-16T08:28:54Z", + "Version": "v1", + "IsDefault": true, + "AlertDetailRules": [ + { + "Id": "rule-asdk", + "Name": "testAlert", + "TemplateId": "temp-asdj", + "Notification": { + "Enabled": true, + "Type": "amp", + "WebHook": "abc", + "AlertManager": { + "ClusterType": "tke", + "ClusterId": "cls-askj", + "Url": "http://asasdkfh:9000" + }, + "RepeatInterval": "5m", + "TimeRangeStart": "00:00:00", + "TimeRangeEnd": "23:59:59", + "NotifyWay": [ + "abc" + ], + "ReceiverGroups": [ + "notice-yakj" + ], + "PhoneNotifyOrder": [ + 1 + ], + "PhoneCircleTimes": 0, + "PhoneInnerInterval": 0, + "PhoneCircleInterval": 0, + "PhoneArriveNotice": true + }, + "Rules": [ { - "Name": "abc", - "Value": "abc" + "Name": "rule-ajdb", + "Rule": "avg by (abc) skdj", + "Labels": [ + { + "Name": "label-name", + "Value": "label-value" + } + ], + "Template": "temp-asdj", + "For": "5m", + "Describe": "test-temp", + "Annotations": [ + { + "Name": "label-name", + "Value": "label-value" + } + ], + "RuleState": 0 } ], - "RuleState": 0 + "UpdatedAt": "2024-07-16 16:28:54", + "ClusterId": "cls-djfb", + "Interval": "5m" } ], - "UpdatedAt": "abc", - "ClusterId": "abc", - "Interval": "abc" + "TargetsTotal": 0 } - ], - "TargetsTotal": 0 - } }' ``` @@ -129,7 +142,7 @@ Output: { "Response": { "RequestId": "eac6b301-a322-493a-8e36-83b295459397", - "TemplateId": "temp-xxx" + "TemplateId": "temp-lejrh" } } ``` diff --git a/tccli/examples/monitor/v20180724/DeletePrometheusClusterAgent.md b/tccli/examples/monitor/v20180724/DeletePrometheusClusterAgent.md index 50697756fe..5822805bcb 100644 --- a/tccli/examples/monitor/v20180724/DeletePrometheusClusterAgent.md +++ b/tccli/examples/monitor/v20180724/DeletePrometheusClusterAgent.md @@ -6,10 +6,10 @@ Input: ``` tccli monitor DeletePrometheusClusterAgent --cli-unfold-argument \ - --Agents.0.ClusterType abc \ - --Agents.0.ClusterId abc \ - --Agents.0.Describe abc \ - --InstanceId abc + --Agents.0.ClusterType cls-kehr \ + --Agents.0.ClusterId tke \ + --Agents.0.Describe test-des \ + --InstanceId prom-sjerg ``` Output: diff --git a/tccli/examples/monitor/v20180724/DeletePrometheusConfig.md b/tccli/examples/monitor/v20180724/DeletePrometheusConfig.md index 0c7c0f2da9..f454e0684d 100644 --- a/tccli/examples/monitor/v20180724/DeletePrometheusConfig.md +++ b/tccli/examples/monitor/v20180724/DeletePrometheusConfig.md @@ -6,9 +6,9 @@ Input: ``` tccli monitor DeletePrometheusConfig --cli-unfold-argument \ - --InstanceId prom-xxx \ + --InstanceId prom-pejrh \ --ClusterType tke \ - --ClusterId cls-xxx + --ClusterId cls-hegr ``` Output: diff --git a/tccli/examples/monitor/v20180724/DeletePrometheusRecordRuleYaml.md b/tccli/examples/monitor/v20180724/DeletePrometheusRecordRuleYaml.md index 56da404c22..2bdaae351f 100644 --- a/tccli/examples/monitor/v20180724/DeletePrometheusRecordRuleYaml.md +++ b/tccli/examples/monitor/v20180724/DeletePrometheusRecordRuleYaml.md @@ -6,8 +6,8 @@ Input: ``` tccli monitor DeletePrometheusRecordRuleYaml --cli-unfold-argument \ - --InstanceId prom-xxx \ - --Names xxx + --InstanceId prom-ejfdgh \ + --Names test-rule ``` Output: diff --git a/tccli/examples/monitor/v20180724/DescribePrometheusClusterAgents.md b/tccli/examples/monitor/v20180724/DescribePrometheusClusterAgents.md index d5ab5c6581..6795d37162 100644 --- a/tccli/examples/monitor/v20180724/DescribePrometheusClusterAgents.md +++ b/tccli/examples/monitor/v20180724/DescribePrometheusClusterAgents.md @@ -6,7 +6,7 @@ Input: ``` tccli monitor DescribePrometheusClusterAgents --cli-unfold-argument \ - --InstanceId abc \ + --InstanceId prom-abc \ --Limit 1 \ --Offset 1 ``` @@ -17,29 +17,32 @@ Output: "Response": { "Agents": [ { - "ClusterType": "abc", - "ClusterId": "abc", - "Status": "abc", + "ClusterId": "cls-abc", "ClusterName": "abc", + "ClusterType": "tke", + "EnableExternal": false, "ExternalLabels": [ { - "Name": "abc", - "Value": "abc" + "Name": "cluster", + "Value": "cls-cde" + }, + { + "Name": "cluster_type", + "Value": "tke" } ], - "Region": "abc", - "VpcId": "abc", - "FailedReason": "abc", - "Name": "abc", - "EnableExternal": true, - "DesiredAgentNum": 0, - "ReadyAgentNum": 0 + "FailedReason": "", + "Name": "", + "ReadyAgentNum": 1, + "Region": "ap-guangzhou", + "Status": "normal", + "VpcId": "vpc-abc" } ], - "Total": 1, - "IsFirstBind": true, - "ImageNeedUpdate": true, - "RequestId": "abc" + "IsFirstBind": false, + "RequestId": "56ce7-sdsd", + "ImageNeedUpdate": false, + "Total": 1 } } ``` diff --git a/tccli/examples/monitor/v20180724/DescribePrometheusConfig.md b/tccli/examples/monitor/v20180724/DescribePrometheusConfig.md index 7ad82a0259..5ce7c5c57b 100644 --- a/tccli/examples/monitor/v20180724/DescribePrometheusConfig.md +++ b/tccli/examples/monitor/v20180724/DescribePrometheusConfig.md @@ -18,9 +18,9 @@ Output: "Config": "abc", "ServiceMonitors": [ { - "Name": "abc", - "Config": "abc", - "TemplateId": "abc", + "Name": "test-sm", + "Config": "scrape_interval:5s\n", + "TemplateId": "temp-akdj", "Targets": { "Total": 1, "Up": 1, @@ -31,9 +31,9 @@ Output: ], "PodMonitors": [ { - "Name": "abc", - "Config": "abc", - "TemplateId": "abc", + "Name": "test-pm", + "Config": "scrape_interval:5s\n", + "TemplateId": "temp-akdj", "Targets": { "Total": 1, "Up": 1, @@ -44,9 +44,9 @@ Output: ], "RawJobs": [ { - "Name": "abc", - "Config": "abc", - "TemplateId": "abc", + "Name": "test-rawjob", + "Config": "scrape_interval:5s\n", + "TemplateId": "temp-akdj", "Targets": { "Total": 1, "Up": 1, @@ -57,9 +57,9 @@ Output: ], "Probes": [ { - "Name": "abc", - "Config": "abc", - "TemplateId": "abc", + "Name": "test-probe", + "Config": "scrape_interval:5s\n", + "TemplateId": "temp-akdj", "Targets": { "Total": 1, "Up": 1, diff --git a/tccli/examples/monitor/v20180724/DescribePrometheusGlobalConfig.md b/tccli/examples/monitor/v20180724/DescribePrometheusGlobalConfig.md index 4bc7b5bb13..b865d704de 100644 --- a/tccli/examples/monitor/v20180724/DescribePrometheusGlobalConfig.md +++ b/tccli/examples/monitor/v20180724/DescribePrometheusGlobalConfig.md @@ -16,9 +16,9 @@ Output: "Config": "abc", "ServiceMonitors": [ { - "Name": "abc", - "Config": "abc", - "TemplateId": "abc", + "Name": "test-sm", + "Config": "scrape_interval:5s\n", + "TemplateId": "temp-akdj", "Targets": { "Total": 1, "Up": 1, @@ -29,9 +29,9 @@ Output: ], "PodMonitors": [ { - "Name": "abc", - "Config": "abc", - "TemplateId": "abc", + "Name": "test-pm", + "Config": "scrape_interval:5s\n", + "TemplateId": "temp-akdj", "Targets": { "Total": 1, "Up": 1, @@ -40,11 +40,11 @@ Output: } } ], - "Probes": [ + "RawJobs": [ { - "Name": "abc", - "Config": "abc", - "TemplateId": "abc", + "Name": "test-rawjob", + "Config": "scrape_interval:5s\n", + "TemplateId": "temp-akdj", "Targets": { "Total": 1, "Up": 1, @@ -53,11 +53,11 @@ Output: } } ], - "RawJobs": [ + "Probes": [ { - "Name": "abc", - "Config": "abc", - "TemplateId": "abc", + "Name": "test-probe", + "Config": "scrape_interval:5s\n", + "TemplateId": "temp-akdj", "Targets": { "Total": 1, "Up": 1, diff --git a/tccli/examples/monitor/v20180724/DescribePrometheusInstanceDetail.md b/tccli/examples/monitor/v20180724/DescribePrometheusInstanceDetail.md index abbef974d4..6489078dc3 100644 --- a/tccli/examples/monitor/v20180724/DescribePrometheusInstanceDetail.md +++ b/tccli/examples/monitor/v20180724/DescribePrometheusInstanceDetail.md @@ -13,20 +13,20 @@ Output: ``` { "Response": { - "InstanceId": "abc", - "InstanceName": "abc", - "VpcId": "abc", - "SubnetId": "abc", - "InstanceStatus": 0, - "ChargeStatus": 0, + "InstanceId": "prom-skdfj", + "InstanceName": "test-prom", + "VpcId": "vpc-sjdh", + "SubnetId": "subnet-kdhe", + "InstanceStatus": 3, + "ChargeStatus": 1, "EnableGrafana": 0, - "GrafanaURL": "abc", + "GrafanaURL": "http://djeb:9000", "InstanceChargeType": 0, - "SpecName": "abc", - "DataRetentionTime": 0, - "ExpireTime": "abc", + "SpecName": "name-sjdb", + "DataRetentionTime": 15, + "ExpireTime": "2024-07-16 16:28:54", "AutoRenewFlag": 0, - "RequestId": "abc" + "RequestId": "skdbfdi-akenfhl" } } ``` diff --git a/tccli/examples/monitor/v20180724/DescribePrometheusInstanceInitStatus.md b/tccli/examples/monitor/v20180724/DescribePrometheusInstanceInitStatus.md index bca7808739..65a2198821 100644 --- a/tccli/examples/monitor/v20180724/DescribePrometheusInstanceInitStatus.md +++ b/tccli/examples/monitor/v20180724/DescribePrometheusInstanceInitStatus.md @@ -6,26 +6,26 @@ Input: ``` tccli monitor DescribePrometheusInstanceInitStatus --cli-unfold-argument \ - --InstanceId abc + --InstanceId prom-asdf1234 ``` Output: ``` { "Response": { - "Status": "abc", + "Status": "initializing", "Steps": [ { - "Step": "abc", - "LifeState": "abc", - "StartAt": "abc", - "EndAt": "abc", - "FailedMsg": "abc" + "Step": "preCheck", + "LifeState": "success", + "StartAt": "2022-04-19T07:29:46Z", + "EndAt": "2022-04-19T07:30:46Z", + "FailedMsg": "message" } ], - "EksClusterId": "abc", - "SecurityGroupId": "abc", - "RequestId": "abc" + "EksClusterId": "cls-asdf1234", + "SecurityGroupId": "sg-asdf1234", + "RequestId": "abc-123-asdfghjk" } } ``` @@ -38,26 +38,26 @@ Input: ``` tccli monitor DescribePrometheusInstanceInitStatus --cli-unfold-argument \ - --InstanceId prom-7vp71ppt + --InstanceId prom-asdf1234 ``` Output: ``` { "Response": { - "Status": "abc", + "Status": "initializing", "Steps": [ { - "Step": "abc", - "LifeState": "abc", - "StartAt": "abc", - "EndAt": "abc", - "FailedMsg": "abc" + "Step": "preCheck", + "LifeState": "success", + "StartAt": "2022-04-19T07:29:46Z", + "EndAt": "2022-04-19T07:30:46Z", + "FailedMsg": "message" } ], - "EksClusterId": "abc", - "SecurityGroupId": "abc", - "RequestId": "abc" + "EksClusterId": "cls-asdf1234", + "SecurityGroupId": "sg-asdf1234", + "RequestId": "abc-123-asdfghjk" } } ``` diff --git a/tccli/examples/monitor/v20180724/DescribePrometheusInstancesOverview.md b/tccli/examples/monitor/v20180724/DescribePrometheusInstancesOverview.md index 89833818b6..b3070839fa 100644 --- a/tccli/examples/monitor/v20180724/DescribePrometheusInstancesOverview.md +++ b/tccli/examples/monitor/v20180724/DescribePrometheusInstancesOverview.md @@ -18,27 +18,27 @@ Output: "Response": { "Instances": [ { - "InstanceStatus": 0, - "BoundNormal": 0, - "VpcId": "xxx", + "InstanceStatus": 3, + "BoundNormal": 1, + "VpcId": "vpc-sjdfb", "AutoRenewFlag": 0, - "InstanceId": "xxx", - "BoundTotal": 0, - "ExpireTime": "xxx", - "SpecName": "xxx", - "InstanceChargeType": 0, + "InstanceId": "prom-ajsh", + "BoundTotal": 1, + "ExpireTime": "2024-07-16 16:28:54", + "SpecName": "spec-name", + "InstanceChargeType": 2, "EnableGrafana": 0, - "DataRetentionTime": 0, - "GrafanaURL": "xxx", - "SubnetId": "xxx", - "InstanceName": "xxx", - "ChargeStatus": 0, + "DataRetentionTime": 15, + "GrafanaURL": "http://1.1.1.1:9000", + "SubnetId": "subnet-ljeb", + "InstanceName": "test-prom", + "ChargeStatus": 1, "ResourcePackageStatus": 1, - "ResourcePackageSpecName": "fff" + "ResourcePackageSpecName": "pkg-name" } ], "Total": 1, - "RequestId": "xxx" + "RequestId": "sjehg-jdgrg" } } ``` diff --git a/tccli/examples/monitor/v20180724/DescribePrometheusTargetsTMP.md b/tccli/examples/monitor/v20180724/DescribePrometheusTargetsTMP.md index 2970a6eac1..67a47e4928 100644 --- a/tccli/examples/monitor/v20180724/DescribePrometheusTargetsTMP.md +++ b/tccli/examples/monitor/v20180724/DescribePrometheusTargetsTMP.md @@ -20,9 +20,9 @@ Output: "Targets": [ {} ], - "JobName": "abc", "Total": 1, - "Up": 1 + "Up": 0, + "JobName": "test-job" } ], "RequestId": "abc" diff --git a/tccli/examples/monitor/v20180724/DescribePrometheusTemp.md b/tccli/examples/monitor/v20180724/DescribePrometheusTemp.md index 7b3acb66bc..b77f5e653c 100644 --- a/tccli/examples/monitor/v20180724/DescribePrometheusTemp.md +++ b/tccli/examples/monitor/v20180724/DescribePrometheusTemp.md @@ -18,14 +18,14 @@ Output: "Response": { "Templates": [ { - "Name": "abc", - "Describe": "abc", - "Level": "abc", + "Name": "test", + "Describe": "test", + "Level": "instance", "RecordRules": [ { - "Name": "abc", + "Name": "testRule", "Config": "abc", - "TemplateId": "abc", + "TemplateId": "temp-asdj", "Targets": { "Total": 1, "Up": 1, @@ -49,9 +49,9 @@ Output: ], "ServiceMonitors": [ { - "Name": "abc", + "Name": "test-sm", "Config": "abc", - "TemplateId": "abc", + "TemplateId": "temp-asdj", "Targets": { "Total": 1, "Up": 1, @@ -62,9 +62,9 @@ Output: ], "PodMonitors": [ { - "Name": "abc", + "Name": "test-pm", "Config": "abc", - "TemplateId": "abc", + "TemplateId": "temp-asdj", "Targets": { "Total": 1, "Up": 1, @@ -73,32 +73,32 @@ Output: } } ], - "TemplateId": "abc", - "UpdateTime": "abc", - "Version": "abc", + "TemplateId": "temp-asdj", + "UpdateTime": "2024-07-16T08:28:54Z", + "Version": "v1", "IsDefault": true, "AlertDetailRules": [ { - "Id": "abc", - "Name": "abc", - "TemplateId": "abc", + "Id": "rule-asdk", + "Name": "testAlert", + "TemplateId": "temp-asdj", "Notification": { "Enabled": true, - "Type": "abc", + "Type": "amp", "WebHook": "abc", "AlertManager": { - "ClusterType": "abc", - "ClusterId": "abc", - "Url": "abc" + "ClusterType": "tke", + "ClusterId": "cls-askj", + "Url": "http://asasdkfh:9000" }, - "RepeatInterval": "abc", - "TimeRangeStart": "abc", - "TimeRangeEnd": "abc", + "RepeatInterval": "5m", + "TimeRangeStart": "00:00:00", + "TimeRangeEnd": "23:59:59", "NotifyWay": [ "abc" ], "ReceiverGroups": [ - "abc" + "notice-yakj" ], "PhoneNotifyOrder": [ 1 @@ -110,35 +110,35 @@ Output: }, "Rules": [ { - "Name": "abc", - "Rule": "abc", + "Name": "rule-ajdb", + "Rule": "avg by (abc) skdj", "Labels": [ { - "Name": "abc", - "Value": "abc" + "Name": "label-name", + "Value": "label-value" } ], - "Template": "abc", - "For": "abc", - "Describe": "abc", + "Template": "temp-asdj", + "For": "5m", + "Describe": "test-temp", "Annotations": [ { - "Name": "abc", - "Value": "abc" + "Name": "label-name", + "Value": "label-value" } ], "RuleState": 0 } ], - "UpdatedAt": "abc", - "ClusterId": "abc" + "UpdatedAt": "2024-07-16 16:28:54", + "ClusterId": "cls-djfb" } ], "TargetsTotal": 0 } ], "Total": 1, - "RequestId": "abc" + "RequestId": "skdh-afbri" } } ``` diff --git a/tccli/examples/monitor/v20180724/DescribePrometheusTempSync.md b/tccli/examples/monitor/v20180724/DescribePrometheusTempSync.md index 46f493b09f..be3313d75f 100644 --- a/tccli/examples/monitor/v20180724/DescribePrometheusTempSync.md +++ b/tccli/examples/monitor/v20180724/DescribePrometheusTempSync.md @@ -15,14 +15,14 @@ Output: "Response": { "Targets": [ { - "Region": "abc", - "InstanceId": "abc", - "ClusterId": "abc", - "SyncTime": "abc", - "Version": "abc", - "ClusterType": "abc", - "InstanceName": "abc", - "ClusterName": "abc" + "Region": "ap-beijing", + "InstanceId": "prom-sjfgh", + "ClusterId": "cls-kdje", + "SyncTime": "2024-07-16 16:28:54", + "Version": "v1", + "ClusterType": "tke", + "InstanceName": "test-prom", + "ClusterName": "test-cluster" } ], "RequestId": "abc" diff --git a/tccli/examples/monitor/v20180724/ModifyPrometheusAgentExternalLabels.md b/tccli/examples/monitor/v20180724/ModifyPrometheusAgentExternalLabels.md index bafed53d72..bc18cf6dad 100644 --- a/tccli/examples/monitor/v20180724/ModifyPrometheusAgentExternalLabels.md +++ b/tccli/examples/monitor/v20180724/ModifyPrometheusAgentExternalLabels.md @@ -6,10 +6,10 @@ Input: ``` tccli monitor ModifyPrometheusAgentExternalLabels --cli-unfold-argument \ - --InstanceId abc \ - --ClusterId abc \ - --ExternalLabels.0.Name abc \ - --ExternalLabels.0.Value abc + --InstanceId prom-jegh \ + --ClusterId cls-uerhf \ + --ExternalLabels.0.Name label-name \ + --ExternalLabels.0.Value label-value ``` Output: diff --git a/tccli/examples/monitor/v20180724/ModifyPrometheusConfig.md b/tccli/examples/monitor/v20180724/ModifyPrometheusConfig.md index 1de35fc907..24e5e28524 100644 --- a/tccli/examples/monitor/v20180724/ModifyPrometheusConfig.md +++ b/tccli/examples/monitor/v20180724/ModifyPrometheusConfig.md @@ -1,6 +1,6 @@ -**Example 1: 新增配置** +**Example 1: 修改采集配置** -新增配置 +修改采集配置 Input: diff --git a/tccli/examples/monitor/v20180724/RunPrometheusInstance.md b/tccli/examples/monitor/v20180724/RunPrometheusInstance.md index 3b6908017d..4dc1950743 100644 --- a/tccli/examples/monitor/v20180724/RunPrometheusInstance.md +++ b/tccli/examples/monitor/v20180724/RunPrometheusInstance.md @@ -6,14 +6,14 @@ Input: ``` tccli monitor RunPrometheusInstance --cli-unfold-argument \ - --InstanceId prom-xxx + --InstanceId prom-asdfghjk ``` Output: ``` { "Response": { - "RequestId": "xxx" + "RequestId": "abc-123-asdfghjk" } } ``` diff --git a/tccli/examples/tcr/v20190924/ModifyUserPasswordPersonal.md b/tccli/examples/tcr/v20190924/ModifyUserPasswordPersonal.md index 5fc6836d97..285fe97e90 100644 --- a/tccli/examples/tcr/v20190924/ModifyUserPasswordPersonal.md +++ b/tccli/examples/tcr/v20190924/ModifyUserPasswordPersonal.md @@ -1,6 +1,6 @@ **Example 1: 修改个人用户登录密码** -ccr修改个人用户登陆密码 +ccr修改个人用户登录密码 Input: diff --git a/tccli/examples/waf/v20180125/DescribeAccessHistogram.md b/tccli/examples/waf/v20180125/DescribeAccessHistogram.md index ef08131f40..8de7962b13 100644 --- a/tccli/examples/waf/v20180125/DescribeAccessHistogram.md +++ b/tccli/examples/waf/v20180125/DescribeAccessHistogram.md @@ -22,6 +22,7 @@ Output: "HistogramInfos": [ { "BTime": 0, + "BeginTime": 0, "Count": 0 } ] diff --git a/tccli/services/__init__.py b/tccli/services/__init__.py index 106ecde7b1..e53ee97a07 100644 --- a/tccli/services/__init__.py +++ b/tccli/services/__init__.py @@ -200,6 +200,9 @@ def action_caller(service): "clb": [ "2018-03-17" ], + "cloudapp": [ + "2022-05-30" + ], "cloudaudit": [ "2019-03-19" ], diff --git a/tccli/services/cloudapp/__init__.py b/tccli/services/cloudapp/__init__.py new file mode 100644 index 0000000000..2e12270a03 --- /dev/null +++ b/tccli/services/cloudapp/__init__.py @@ -0,0 +1,4 @@ +# -*- coding: utf-8 -*- + +from tccli.services.cloudapp.cloudapp_client import action_caller + \ No newline at end of file diff --git a/tccli/services/cloudapp/cloudapp_client.py b/tccli/services/cloudapp/cloudapp_client.py new file mode 100644 index 0000000000..e9a5fd8948 --- /dev/null +++ b/tccli/services/cloudapp/cloudapp_client.py @@ -0,0 +1,195 @@ +# -*- coding: utf-8 -*- +import os +import sys +import six +import json +import tccli.options_define as OptionsDefine +import tccli.format_output as FormatOutput +from tccli import __version__ +from tccli.utils import Utils +from tccli.exceptions import ConfigurationError, ClientError, ParamError +from tencentcloud.common import credential +from tencentcloud.common.profile.http_profile import HttpProfile +from tencentcloud.common.profile.client_profile import ClientProfile +from tencentcloud.cloudapp.v20220530 import cloudapp_client as cloudapp_client_v20220530 +from tencentcloud.cloudapp.v20220530 import models as models_v20220530 + +from jmespath import search +import time + +def doVerifyLicense(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.CloudappClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.VerifyLicenseRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.VerifyLicense(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]) + + +CLIENT_MAP = { + "v20220530": cloudapp_client_v20220530, + +} + +MODELS_MAP = { + "v20220530": models_v20220530, + +} + +ACTION_MAP = { + "VerifyLicense": doVerifyLicense, + +} + +AVAILABLE_VERSION_LIST = [ + "v20220530", + +] + + +def action_caller(): + return ACTION_MAP + + +def parse_global_arg(parsed_globals): + g_param = parsed_globals + + is_exist_profile = True + if not parsed_globals["profile"]: + is_exist_profile = False + g_param["profile"] = os.environ.get("TCCLI_PROFILE", "default") + + configure_path = os.path.join(os.path.expanduser("~"), ".tccli") + is_conf_exist, conf_path = Utils.file_existed(configure_path, g_param["profile"] + ".configure") + is_cred_exist, cred_path = Utils.file_existed(configure_path, g_param["profile"] + ".credential") + + conf = {} + cred = {} + + if is_conf_exist: + conf = Utils.load_json_msg(conf_path) + if is_cred_exist: + cred = Utils.load_json_msg(cred_path) + + if not (isinstance(conf, dict) and isinstance(cred, dict)): + raise ConfigurationError( + "file: %s or %s is not json format" + % (g_param["profile"] + ".configure", g_param["profile"] + ".credential")) + + if OptionsDefine.Token not in cred: + cred[OptionsDefine.Token] = None + + if not is_exist_profile: + if os.environ.get(OptionsDefine.ENV_SECRET_ID) and os.environ.get(OptionsDefine.ENV_SECRET_KEY): + cred[OptionsDefine.SecretId] = os.environ.get(OptionsDefine.ENV_SECRET_ID) + cred[OptionsDefine.SecretKey] = os.environ.get(OptionsDefine.ENV_SECRET_KEY) + cred[OptionsDefine.Token] = os.environ.get(OptionsDefine.ENV_TOKEN) + + if os.environ.get(OptionsDefine.ENV_REGION): + conf[OptionsDefine.SysParam][OptionsDefine.Region] = os.environ.get(OptionsDefine.ENV_REGION) + + if os.environ.get(OptionsDefine.ENV_ROLE_ARN) and os.environ.get(OptionsDefine.ENV_ROLE_SESSION_NAME): + cred[OptionsDefine.RoleArn] = os.environ.get(OptionsDefine.ENV_ROLE_ARN) + cred[OptionsDefine.RoleSessionName] = os.environ.get(OptionsDefine.ENV_ROLE_SESSION_NAME) + + for param in g_param.keys(): + if g_param[param] is None: + if param in [OptionsDefine.SecretKey, OptionsDefine.SecretId, OptionsDefine.Token]: + if param in cred: + g_param[param] = cred[param] + elif not (g_param[OptionsDefine.UseCVMRole.replace('-', '_')] + or os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN)): + raise ConfigurationError("%s is invalid" % param) + elif param in [OptionsDefine.Region, OptionsDefine.Output, OptionsDefine.Language]: + if param in conf[OptionsDefine.SysParam]: + g_param[param] = conf[OptionsDefine.SysParam][param] + elif param != OptionsDefine.Language: + raise ConfigurationError("%s is invalid" % param) + elif param.replace('_', '-') in [OptionsDefine.RoleArn, OptionsDefine.RoleSessionName]: + if param.replace('_', '-') in cred: + g_param[param] = cred[param.replace('_', '-')] + + try: + if g_param[OptionsDefine.ServiceVersion]: + g_param[OptionsDefine.Version] = "v" + g_param[OptionsDefine.ServiceVersion].replace('-', '') + else: + version = conf["cloudapp"][OptionsDefine.Version] + g_param[OptionsDefine.Version] = "v" + version.replace('-', '') + + if g_param[OptionsDefine.Endpoint] is None: + g_param[OptionsDefine.Endpoint] = conf["cloudapp"][OptionsDefine.Endpoint] + g_param["sts_cred_endpoint"] = conf.get("sts", {}).get("endpoint") + except Exception as err: + raise ConfigurationError("config file:%s error, %s" % (conf_path, str(err))) + + if g_param[OptionsDefine.Version] not in AVAILABLE_VERSION_LIST: + raise Exception("available versions: %s" % " ".join(AVAILABLE_VERSION_LIST)) + + if g_param[OptionsDefine.Waiter]: + param = eval(g_param[OptionsDefine.Waiter]) + if 'expr' not in param: + raise Exception('`expr` in `--waiter` must be defined') + if 'to' not in param: + raise Exception('`to` in `--waiter` must be defined') + if 'timeout' not in param: + if 'waiter' in conf and 'timeout' in conf['waiter']: + param['timeout'] = conf['waiter']['timeout'] + else: + param['timeout'] = 180 + if 'interval' not in param: + if 'waiter' in conf and 'interval' in conf['waiter']: + param['interval'] = conf['waiter']['interval'] + else: + param['interval'] = 5 + param['interval'] = min(param['interval'], param['timeout']) + g_param['OptionsDefine.WaiterInfo'] = param + + if six.PY2: + for key, value in g_param.items(): + if isinstance(value, six.text_type): + g_param[key] = value.encode('utf-8') + return g_param + diff --git a/tccli/services/cloudapp/v20220530/api.json b/tccli/services/cloudapp/v20220530/api.json new file mode 100644 index 0000000000..ebf8c6722f --- /dev/null +++ b/tccli/services/cloudapp/v20220530/api.json @@ -0,0 +1,259 @@ +{ + "actions": { + "VerifyLicense": { + "document": "通过运行时roleId查询对应的软件 LICENSE", + "input": "VerifyLicenseRequest", + "name": "从应用软件进程验证授权信息", + "output": "VerifyLicenseResponse", + "status": "online" + } + }, + "metadata": { + "apiVersion": "2022-05-30", + "api_brief": "介绍如何使用 API 对云应用进行部署、管理等操作。", + "serviceNameCN": "云应用", + "serviceShortName": "cloudapp" + }, + "objects": { + "License": { + "document": "表示应用实例的软件授权，包含颁发信息、激活信息等内容。", + "members": [ + { + "disabled": false, + "document": "License ID", + "example": "LICENSE_CLOUDAPP_A95275D8", + "member": "string", + "name": "LicenseId", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "软件授权模式。\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
枚举值说明
Permanent永久授权。该授权不受有效期限制。
Subscription订阅授权。授权如果过了有效期，则会进入过期状态。
", + "example": "Subscription", + "member": "string", + "name": "LicenseMode", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "软件的授权状态。\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
枚举值说明
Issued已颁发，等待激活。一般来说，如果软件已经在运行，不会出现该状态。
Active授权在有效期内，这是软件运行期间最常见的状态。
Expired授权已过期。订阅类的软件授权有有效期，如果服务器时间已晚于有效期，则会进入过期状态。
Deactivated授权已失效。用户如果退货软件，则授权会自动失效。
", + "example": "Active", + "member": "string", + "name": "LicenseStatus", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "软件供应方 ID。", + "example": "1000", + "member": "uint64", + "name": "ProviderId", + "output_required": true, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "软件包 ID。", + "example": "pkg-kby01bv4", + "member": "string", + "name": "SoftwarePackageId", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "软件包版本。", + "example": "1.0.0", + "member": "string", + "name": "SoftwarePackageVersion", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "被授权的用户 UIN。", + "example": "100008888888", + "member": "string", + "name": "AuthorizedUserUin", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "被授权的应用实例 ID。", + "example": "cloudapp-95t785d8", + "member": "string", + "name": "AuthorizedCloudappId", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "被授权的角色 ID。", + "example": "4000008000060000", + "member": "string", + "name": "AuthorizedCloudappRoleId", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "被授权的软件规格，具体字段请参考结构SaleParam", + "example": "无", + "member": "SaleParam", + "name": "AuthorizedSpecification", + "output_required": true, + "type": "list", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "被授权的软件的计费模式。\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
枚举值说明
1线上计费，软件的授权从腾讯云线上购买，支持续费、退款等操作。
2线下计费，软件的授权线下签订合同购买，定向客户交付，无法从线上续费和退款。
4免费
", + "example": "1", + "member": "int64", + "name": "BillingMode", + "output_required": true, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "授权时长（单位由LifeSpanUnit确定，枚举值有Y年/M月/D日三种）", + "example": "1", + "member": "int64", + "name": "LifeSpan", + "output_required": false, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "授权颁发时间。", + "example": "2024-06-29T00:00:00+08:00", + "member": "datetime_iso", + "name": "IssueDate", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "授权激活时间，如从未激活则返回 null。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "2024-06-30T00:00:00+08:00", + "member": "datetime_iso", + "name": "ActivationDate", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "授权过期时间，如未过期或者是永久授权，则返回 null。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "2025-06-30T00:00:00+08:00", + "member": "datetime_iso", + "name": "ExpirationDate", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "授权时长单位，枚举值有Y年/M月/D日三种", + "example": "Y", + "member": "string", + "name": "LifeSpanUnit", + "output_required": false, + "type": "string", + "value_allowed_null": false + } + ], + "usage": "out" + }, + "SaleParam": { + "document": "表示商品 SKU 的单个售卖参数", + "members": [ + { + "disabled": false, + "document": "售卖参数标识", + "example": "user_scale", + "member": "string", + "name": "ParamKey", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "售卖参数值", + "example": "100", + "member": "string", + "name": "ParamValue", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "售卖参数的展示名称\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "用户规模", + "member": "string", + "name": "ParamKeyName", + "output_required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "售卖参数值的展示名称\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "100人", + "member": "string", + "name": "ParamValueName", + "output_required": true, + "type": "string", + "value_allowed_null": true + } + ], + "usage": "out" + }, + "VerifyLicenseRequest": { + "document": "VerifyLicense请求参数结构体", + "members": [], + "type": "object" + }, + "VerifyLicenseResponse": { + "document": "VerifyLicense返回参数结构体", + "members": [ + { + "disabled": false, + "document": "软件的详细授权信息。", + "example": "见 License 数据结构。", + "member": "License", + "name": "License", + "output_required": true, + "type": "object", + "value_allowed_null": false + }, + { + "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + } + }, + "version": "1.0" +} \ No newline at end of file diff --git a/tccli/services/cloudapp/v20220530/examples.json b/tccli/services/cloudapp/v20220530/examples.json new file mode 100644 index 0000000000..5db222d0b2 --- /dev/null +++ b/tccli/services/cloudapp/v20220530/examples.json @@ -0,0 +1,13 @@ +{ + "actions": { + "VerifyLicense": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: cloudapp.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: VerifyLicense\n<公共请求参数>\n\n{}", + "output": "{\n \"Response\": {\n \"License\": {\n \"LicenseId\": \"abc\",\n \"LicenseMode\": \"abc\",\n \"LicenseStatus\": \"abc\",\n \"ProviderId\": 1,\n \"SoftwarePackageId\": \"abc\",\n \"SoftwarePackageVersion\": \"abc\",\n \"AuthorizedUserUin\": \"abc\",\n \"AuthorizedCloudappId\": \"abc\",\n \"AuthorizedCloudappRoleId\": \"abc\",\n \"AuthorizedSpecification\": [\n {\n \"ParamKey\": \"abc\",\n \"ParamValue\": \"abc\",\n \"ParamKeyName\": \"abc\",\n \"ParamValueName\": \"abc\"\n }\n ],\n \"BillingMode\": 0,\n \"LifeSpan\": 0,\n \"IssueDate\": \"2020-09-22T00:00:00+00:00\",\n \"ActivationDate\": \"2020-09-22T00:00:00+00:00\",\n \"ExpirationDate\": \"2020-09-22T00:00:00+00:00\",\n \"LifeSpanUnit\": \"abc\"\n },\n \"RequestId\": \"abc\"\n }\n}", + "title": "通过运行时roleId查询对应的软件 LICENSE" + } + ] + }, + "version": "1.0" +} \ No newline at end of file diff --git a/tccli/services/dsgc/v20190723/api.json b/tccli/services/dsgc/v20190723/api.json index 80ec3c24de..1c41d79259 100644 --- a/tccli/services/dsgc/v20190723/api.json +++ b/tccli/services/dsgc/v20190723/api.json @@ -3955,6 +3955,33 @@ "name": "TimingStartTime", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "random-随机，asc生序，desc降序", + "example": "抽样方式", + "member": "string", + "name": "Order", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "抽样的条数，范围30-1000", + "example": "20", + "member": "int64", + "name": "Rows", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "抽样的排序字段", + "example": "id", + "member": "string", + "name": "GlobalOrderField", + "required": false, + "type": "string" } ], "type": "object" @@ -3968,7 +3995,7 @@ "example": "1", "member": "int64", "name": "TaskId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -3978,7 +4005,7 @@ "example": "1", "member": "int64", "name": "ResultId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -9480,6 +9507,24 @@ "name": "FieldResultId", "required": true, "type": "int" + }, + { + "disabled": false, + "document": "排序方式", + "example": "random", + "member": "string", + "name": "Order", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "排序字段", + "example": "id", + "member": "string", + "name": "OrderField", + "required": false, + "type": "string" } ], "type": "object" @@ -9924,6 +9969,24 @@ "name": "FieldResultId", "required": true, "type": "int" + }, + { + "disabled": false, + "document": "排序方式", + "example": "random", + "member": "string", + "name": "Order", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "排序字段", + "example": "id", + "member": "string", + "name": "OrderField", + "required": false, + "type": "string" } ], "type": "object" @@ -9937,7 +10000,7 @@ "example": "无", "member": "DspaFieldResultDataSample", "name": "Items", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, diff --git a/tccli/services/ess/v20201111/api.json b/tccli/services/ess/v20201111/api.json index 7b56838a0b..0b4908da4d 100644 --- a/tccli/services/ess/v20201111/api.json +++ b/tccli/services/ess/v20201111/api.json @@ -6106,7 +6106,7 @@ }, { "disabled": false, - "document": "电子印章类型 , 可选类型如下: 注: `同企业下只能有一个公章, 重复创建会报错`", + "document": "电子印章类型 , 可选类型如下: 注: 同企业下只能有一个公章, 重复创建会报错", "example": "OFFICIAL", "member": "string", "name": "SealType", diff --git a/tccli/services/essbasic/v20210526/api.json b/tccli/services/essbasic/v20210526/api.json index 46e31762e9..2abe8cbd08 100644 --- a/tccli/services/essbasic/v20210526/api.json +++ b/tccli/services/essbasic/v20210526/api.json @@ -43,7 +43,7 @@ "status": "online" }, "ChannelCreateBatchSignUrl": { - "document": "通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注：\n- 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 参与人点击链接后需短信验证码才能查看合同内容。\n- 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，请确保此企业已完成腾讯电子签企业认证。暂时仅支持给自建应用集成企业生成员工批签链接，不支持子客企业。\n- 生成批量签署链接时，合同目标参与方状态需为待签署状态。\n- 个人批量签署进行的合同的签名区， 全部变成手写签名（不管合同里边设置的签名限制）来进行。", + "document": "通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注：\n- 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 参与人点击链接后需短信验证码才能查看合同内容。\n- 个人用户批量签署，需要传Name，Mobile，IdCardNumber(IdCardType) 参数。\n- saas企业员工用户批量签署，在传递了姓名等基本信息参数的情况下，还需要传OrganizationName（参与方所在企业名称）参数生成签署链接，请确保此企业已完成腾讯电子签企业认证。\n- 子客企业员工用户批签签署，需要传递员工OpenId和子客企业的OrganizationOpenId。请确保此OrganizationOpenId对应子客已经认证，且OpenId对应员工此子客下已经实名。Name，Mobile, IdCard等信息此时可以不传，系统会查询此OpenId实名信息自动补充。\n- 生成批量签署链接时，合同目标参与方状态需为待签署状态。\n- 个人批量签署进行的合同的签名区， 全部变成手写签名（不管合同里边设置的签名限制）来进行。", "input": "ChannelCreateBatchSignUrlRequest", "name": "获取跳转至腾讯电子签小程序的批量签署链接", "output": "ChannelCreateBatchSignUrlResponse", @@ -1686,7 +1686,7 @@ }, { "disabled": false, - "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。\n\n注：`请确保和合同中填入的一致`，`除动态签署人场景外，此参数必填`", + "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。\n\n注：`请确保和合同中填入的一致`，`除动态签署人或子客员工经办人场景外，此参数必填`", "example": "无", "member": "string", "name": "Name", @@ -1695,7 +1695,7 @@ }, { "disabled": false, - "document": "手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`", + "document": "手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人或子客员工经办人场景外，此参数必填`", "example": "无", "member": "string", "name": "Mobile", @@ -1749,7 +1749,7 @@ }, { "disabled": false, - "document": "目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。\n\n注：\n", + "document": "SaaS平台企业员工签署方的企业名称。目标签署人如果为saas应用企业员工身份，此参数必填。\n\n注：\n", "example": "无", "member": "string", "name": "OrganizationName", @@ -1773,6 +1773,24 @@ "name": "FlowBatchUrlInfo", "required": false, "type": "object" + }, + { + "disabled": false, + "document": "第三方平台子客企业员工的标识OpenId，批签合同经办人为子客员工的情况下为必填。\n\n注：\n", + "example": "无", + "member": "string", + "name": "OpenId", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "第三方平台子客企业的企业的标识, 即OrganizationOpenId，批签合同经办人为子客企业员工是为必填。", + "example": "无", + "member": "string", + "name": "OrganizationOpenId", + "required": false, + "type": "string" } ], "type": "object" @@ -6803,7 +6821,7 @@ }, { "disabled": false, - "document": "电子印章类型 , 可选类型如下: 注: `同企业下只能有一个公章, 重复创建会报错`", + "document": "电子印章类型 , 可选类型如下: 注: 同企业下只能有一个公章, 重复创建会报错", "example": "OFFICIAL", "member": "string", "name": "SealType", diff --git a/tccli/services/essbasic/v20210526/examples.json b/tccli/services/essbasic/v20210526/examples.json index 4056d30ccd..95672c1339 100644 --- a/tccli/services/essbasic/v20210526/examples.json +++ b/tccli/services/essbasic/v20210526/examples.json @@ -122,10 +122,10 @@ "title": "生成个人小程序批量签署链接" }, { - "document": "按照合同发起时候填入的信息生成企业经办人批量签署链接，并通过FlowIds参数对用户可以批签的合同进行限制", + "document": "按照合同发起时候填入的信息生成saas企业经办人批量签署链接，并通过FlowIds参数对用户可以批签的合同进行限制", "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchSignUrl\n<公共请求参数>\n\n{\n \"IdCardNumber\": \"610000000000000000\",\n \"IdCardType\": \"ID_CARD\",\n \"Name\": \"小明\",\n \"NotifyType\": \"SMS\",\n \"Mobile\": \"1234567890\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"FlowIds\": [\n \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n \"yDR1AUUgygj******uO4zjE8gTG7xvgH\"\n ]\n}", "output": "{\n \"Response\": {\n \"ExpiredTime\": 1684899114,\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n \"SignUrl\": \"https://ess.url.cn/FuP**Swc\",\n \"MiniAppPath\": \"pages/guide/index?shortKey=FuP3**wc\"\n }\n}", - "title": "生成企业经办人小程序批量签署链接" + "title": "生成saas企业经办人小程序批量签署链接" }, { "document": "合同（yDR1AUUgygja******uO4zjEB8zAkJEFN）中的参与方为：【姓名：张三 ，手机号：18888888888】，发起的时候并未填入证件号且18888888888手机号并未在腾讯电子签注册实名。 \n\n此时，如果使用 【姓名：张三，手机号：17777777777】生成批量签署链接，且FlowIds参数传入（yDR1AUUgygja******uO4zjEB8zAkJEFN）时，会报错，提示签署方信息不存在。\n\n因为手机号不同，无法定位到签署方。 此时，除了将手机号修改成 18888888888 之外来解决问题，也可以在发起合同和生成链接的时候传入证件信息，保证姓名和证件一致的情况下，手机号可以不相同。", @@ -138,6 +138,12 @@ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"FlowIds\": [\n \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n \"yDR1AUUgygj******uO4zjE8gTG7xvgH\"\n ],\n \"FlowBatchUrlInfo\": {\n \"FlowBatchApproverInfos\": [\n {\n \"FlowId\": \"yDC5yUUckpwexoz4UuoHfkT1DMEDQSG5\",\n \"RecipientId\": \"yDC5yUUckpwexozwUuoHfkTwB00zdfLo\"\n }\n ]\n }\n}", "output": "{\n \"Response\": {\n \"ExpiredTime\": 1684899114,\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n \"SignUrl\": \"https://ess.url.cn/FuP**Swc\",\n \"MiniAppPath\": \"pages/guide/index?shortKey=FuP3**wc\"\n }\n}", "title": "生成动态签署人批量领取链接" + }, + { + "document": "按照合同发起时候填入的信息生成子客企业经办人批量签署链接，并通过FlowIds参数对用户可以批签的合同进行限制", + "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchSignUrl\n<公共请求参数>\n\n{\n \"OpenId\": \"test_open_id\",\n \"OrganizationOpenId\": \"test_org_open_id\",\n \"Name\": \"\",\n \"NotifyType\": \"SMS\",\n \"Mobile\": \"\",\n \"OrganizationName\": \"\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"FlowIds\": [\n \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n \"yDR1AUUgygj******uO4zjE8gTG7xvgH\"\n ]\n}", + "output": "{\n \"Response\": {\n \"ExpiredTime\": 1684899114,\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n \"SignUrl\": \"https://ess.url.cn/FuP**Swc\",\n \"MiniAppPath\": \"pages/guide/index?shortKey=FuP3**wc\"\n }\n}", + "title": "生成子客经办人小程序批量签署链接" } ], "ChannelCreateBoundFlows": [ diff --git a/tccli/services/lighthouse/v20200324/api.json b/tccli/services/lighthouse/v20200324/api.json index 2fe10f9afa..360702976b 100644 --- a/tccli/services/lighthouse/v20200324/api.json +++ b/tccli/services/lighthouse/v20200324/api.json @@ -4837,7 +4837,7 @@ "members": [ { "disabled": false, - "document": "可用区列表排序的依据字段。取值范围：\n
  • ZONE：依据可用区排序。\n
  • INSTANCE_DISPLAY_LABEL：依据可用区展示标签排序，可用区展示标签包括：HIDDEN（隐藏）、NORMAL（普通）、SELECTED（默认选中），默认采用的升序排列为：['HIDDEN', 'NORMAL', 'SELECTED']。\n默认按可用区排序。", + "document": "可用区列表排序的依据字段。取值范围：\n
  • ZONE：依据可用区排序。
    • \n
  • INSTANCE_DISPLAY_LABEL：依据可用区展示标签排序，可用区展示标签包括：HIDDEN（隐藏）、NORMAL（普通）、SELECTED（默认选中），默认采用的升序排列为：['HIDDEN', 'NORMAL', 'SELECTED']。\n默认按可用区排序。
    • ", "example": "\"ZONE\"", "member": "string", "name": "OrderField", @@ -4846,7 +4846,7 @@ }, { "disabled": false, - "document": "输出可用区列表的排列顺序。取值范围：\n
  • ASC：升序排列。 \n
  • DESC：降序排列。\n默认按升序排列。", + "document": "输出可用区列表的排列顺序。取值范围：\n
  • ASC：升序排列。
    • \n
  • DESC：降序排列。
    • \n默认按升序排列。", "example": "\"DESC\"", "member": "string", "name": "Order", @@ -4865,7 +4865,7 @@ "example": "1", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -4875,7 +4875,7 @@ "example": "无", "member": "ZoneInfo", "name": "ZoneInfoSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, diff --git a/tccli/services/mongodb/v20190725/api.json b/tccli/services/mongodb/v20190725/api.json index d69c5d74c9..af0b8dd116 100644 --- a/tccli/services/mongodb/v20190725/api.json +++ b/tccli/services/mongodb/v20190725/api.json @@ -921,7 +921,7 @@ }, { "disabled": false, - "document": "- 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", + "document": "- 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", "example": "2", "member": "uint64", "name": "NodeNum", @@ -1166,7 +1166,7 @@ "members": [ { "disabled": false, - "document": "- 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", + "document": "- 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", "example": "3", "member": "uint64", "name": "NodeNum", diff --git a/tccli/services/monitor/v20180724/api.json b/tccli/services/monitor/v20180724/api.json index b4df65b90e..9cc6018809 100644 --- a/tccli/services/monitor/v20180724/api.json +++ b/tccli/services/monitor/v20180724/api.json @@ -869,7 +869,7 @@ "status": "online" }, "ModifyPrometheusConfig": { - "document": "修改prometheus配置，如果配置项不存在，则会新增", + "document": "修改prometheus采集配置", "input": "ModifyPrometheusConfigRequest", "name": "修改prometheus配置", "output": "ModifyPrometheusConfigResponse", @@ -4372,7 +4372,7 @@ { "disabled": false, "document": "实例ID", - "example": "prom-xxx", + "example": "prom-oejhr", "member": "string", "name": "InstanceId", "required": true, @@ -4917,7 +4917,7 @@ }, { "disabled": false, - "document": "服务发现配置信息，YAML 格式\n\n示例值：\n\n```\napiVersion: monitoring.coreos.com/v1\nkind: ServiceMonitor\nmetadata:\n name: go-demo # 填写一个唯一名称\n namespace: cm-prometheus # namespace固定，不要修改\nspec:\n endpoints:\n - interval: 30s\n # 填写service yaml中Prometheus Exporter对应的Port的Name\n port: 2112\n # 填写Prometheus Exporter对应的Path的值，不填默认/metrics\n path: /metrics\n relabelings:\n # ** 必须要有一个 label 为 application，这里假设 k8s 有一个 label 为 app，\n # 我们通过 relabel 的 replace 动作把它替换成了 application\n - action: replace\n sourceLabels: [__meta_kubernetes_pod_label_app]\n targetLabel: application\n # 选择要监控service所在的namespace\n namespaceSelector:\n matchNames:\n - golang-demo\n # 填写要监控service的Label值，以定位目标service\n selector:\n matchLabels:\n app: golang-app-demo\n```", + "document": "服务发现配置信息，YAML 格式，[具体YAML参数内容请参考](https://cloud.tencent.com/document/product/1416/55995#service-monitor)", "example": "yaml", "member": "string", "name": "Yaml", @@ -5426,7 +5426,7 @@ { "disabled": false, "document": "agent列表", - "example": "无", + "example": "{\"ClusterType\":\"cls-kehr\",\"ClusterId\":\"tke\",\"Describe\":\"test-des\"}", "member": "PrometheusAgentInfo", "name": "Agents", "required": true, @@ -5435,7 +5435,7 @@ { "disabled": false, "document": "实例id", - "example": "prome-xx", + "example": "prom-kehf", "member": "string", "name": "InstanceId", "required": true, @@ -5489,7 +5489,7 @@ { "disabled": false, "document": "要删除的ServiceMonitor名字列表", - "example": "xxx", + "example": "[\"test-sm\"]", "member": "string", "name": "ServiceMonitors", "required": false, @@ -5498,7 +5498,7 @@ { "disabled": false, "document": "要删除的PodMonitor名字列表", - "example": "xxx", + "example": "[\"test-pm\"]", "member": "string", "name": "PodMonitors", "required": false, @@ -5507,7 +5507,7 @@ { "disabled": false, "document": "要删除的RawJobs名字列表", - "example": "xxx", + "example": "[\"test-rj\"]", "member": "string", "name": "RawJobs", "required": false, @@ -5534,7 +5534,7 @@ { "disabled": false, "document": "实例id", - "example": "xxx", + "example": "prom-wjheg", "member": "string", "name": "InstanceId", "required": true, @@ -5543,7 +5543,7 @@ { "disabled": false, "document": "聚合规则列表", - "example": "xxx", + "example": "[\"test-rule\"]", "member": "string", "name": "Names", "required": true, @@ -5785,7 +5785,7 @@ }, { "disabled": false, - "document": "服务发现配置信息，YAML 格式\n\n示例值：\n\n```\napiVersion: monitoring.coreos.com/v1\nkind: ServiceMonitor\nmetadata:\n name: go-demo # 填写一个唯一名称\n namespace: cm-prometheus # namespace固定，不要修改\nspec:\n endpoints:\n - interval: 30s\n # 填写service yaml中Prometheus Exporter对应的Port的Name\n port: 2112\n # 填写Prometheus Exporter对应的Path的值，不填默认/metrics\n path: /metrics\n relabelings:\n # ** 必须要有一个 label 为 application，这里假设 k8s 有一个 label 为 app，\n # 我们通过 relabel 的 replace 动作把它替换成了 application\n - action: replace\n sourceLabels: [__meta_kubernetes_pod_label_app]\n targetLabel: application\n # 选择要监控service所在的namespace\n namespaceSelector:\n matchNames:\n - golang-demo\n # 填写要监控service的Label值，以定位目标service\n selector:\n matchLabels:\n app: golang-app-demo\n```", + "document": "服务发现配置信息，YAML 格式，[具体YAML参数内容请参考](https://cloud.tencent.com/document/product/1416/55995#service-monitor)", "example": "yaml", "member": "string", "name": "Yaml", @@ -11163,7 +11163,7 @@ { "disabled": false, "document": "集群id\n可以是tke, eks, edge的集群id", - "example": "cls-xxx", + "example": "cls-dkrb", "member": "string", "name": "ClusterId", "required": true, @@ -11178,7 +11178,7 @@ { "disabled": false, "document": "关联该集群的实例列表\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "prom-xxx", + "example": "[\"prom-oebnrfg\"]", "member": "string", "name": "Instances", "output_required": true, @@ -11448,7 +11448,7 @@ }, { "disabled": false, - "document": "用于分页", + "document": "偏移量，默认为0。", "example": "1", "member": "uint64", "name": "Offset", @@ -11457,7 +11457,7 @@ }, { "disabled": false, - "document": "用于分页", + "document": "返回数量，默认为20，最大值为100。", "example": "1", "member": "uint64", "name": "Limit", @@ -11937,7 +11937,7 @@ { "disabled": false, "document": "实例ID", - "example": "prom-xxx", + "example": "prom-asdfghjk", "member": "string", "name": "InstanceId", "required": true, @@ -11962,7 +11962,7 @@ { "disabled": false, "document": "初始化任务步骤\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "{\"Step\":\"abc\",\"LifeState\":\"abc\",\"StartAt\":\"abc\",\"EndAt\":\"abc\",\"FailedMsg\":\"abc\"}", + "example": "无", "member": "TaskStepInfo", "name": "Steps", "output_required": true, @@ -11972,7 +11972,7 @@ { "disabled": false, "document": "实例eks集群ID\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "cls-abc", + "example": "cls-asdf1234", "member": "string", "name": "EksClusterId", "output_required": true, @@ -11982,7 +11982,7 @@ { "disabled": false, "document": "eks集群内pod的安全组\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "sg-abc", + "example": "sg-asdf1234", "member": "string", "name": "SecurityGroupId", "output_required": false, @@ -12058,7 +12058,7 @@ "members": [ { "disabled": false, - "document": "用于分页", + "document": "分页偏移量，默认为0", "example": "1", "member": "uint64", "name": "Offset", @@ -12067,7 +12067,7 @@ }, { "disabled": false, - "document": "用于分页", + "document": "返回数量，默认为20，最大值为100", "example": "20", "member": "uint64", "name": "Limit", @@ -12077,7 +12077,7 @@ { "disabled": false, "document": "过滤实例，目前支持：\nID: 通过实例ID来过滤 \nName: 通过实例名称来过滤", - "example": "无", + "example": "[{\"Name\": \"Name\",\"Values\": [\"test\"]}]", "member": "Filter", "name": "Filters", "required": false, @@ -12535,7 +12535,7 @@ }, { "disabled": false, - "document": "targets偏移量，默认为0", + "document": "targets分页偏移量，默认为0", "example": "0", "member": "uint64", "name": "Offset", @@ -12560,7 +12560,7 @@ { "disabled": false, "document": "所有Job的targets信息", - "example": "{ \"Targets\": [ { \"LastScrape\": \"xx\", \"ScrapeDuration\": 0.0, \"Url\": \"xx\", \"Labels\": [ { \"Name\": \"xx\", \"Value\": \"xx\" } ], \"State\": \"xx\", \"Error\": \"xx\" } ], \"Total\": 1, \"Up\": 1, \"JobName\": \"xx\" }", + "example": "{\"Targets\":[{\"LastScrape\":\"2024-06-19 16:22:26\",\"ScrapeDuration\":0.2,\"Url\":\"http://1.1.1.1:9000\",\"Labels\":[{\"Name\":\"label-name\",\"Value\":\"label-value\"}],\"State\":\"down\",\"Error\":\"scrape timeout\"}],\"Total\":1,\"Up\":0,\"JobName\":\"test-job\"}", "member": "PrometheusJobTargets", "name": "Jobs", "output_required": true, @@ -12590,7 +12590,7 @@ }, { "disabled": false, - "document": "分页偏移", + "document": "分页偏移量，默认为0", "example": "0", "member": "uint64", "name": "Offset", @@ -14389,7 +14389,7 @@ { "disabled": false, "document": "map表中的Name", - "example": "xxx", + "example": "label-name", "member": "string", "name": "Name", "output_required": true, @@ -14400,7 +14400,7 @@ { "disabled": false, "document": "map表中的Value", - "example": "xxx", + "example": "label-value", "member": "string", "name": "Value", "output_required": true, @@ -15719,7 +15719,7 @@ { "disabled": false, "document": "新的external_labels", - "example": "Name=xx, Value=xxx", + "example": "{\"Name\":\"label-name\",\"Value\":\"label-value\"}", "member": "Label", "name": "ExternalLabels", "required": true, @@ -15836,7 +15836,7 @@ { "disabled": false, "document": "0: 更新实例组件镜像版本；\n1: 不更新实例组件镜像版本", - "example": "0,1", + "example": "0", "member": "int64", "name": "UpdateImage", "required": false, @@ -19257,7 +19257,7 @@ { "disabled": false, "document": "实例ID", - "example": "prom-xxx", + "example": "prom-asdfghjk", "member": "string", "name": "InstanceId", "required": true, @@ -19266,7 +19266,7 @@ { "disabled": false, "document": "子网ID，默认使用实例所用子网初始化，也可通过该参数传递新的子网ID初始化", - "example": "xx-xxx", + "example": "subnet-asdfghjk", "member": "string", "name": "SubnetId", "required": false, @@ -20637,8 +20637,8 @@ "members": [ { "disabled": false, - "document": "Prometheus 实例 ID，例如：prom-abcd1234", - "example": "xx", + "document": "Prometheus 实例 ID", + "example": "prom-abcd1234", "member": "string", "name": "InstanceId", "required": true, @@ -20646,8 +20646,8 @@ }, { "disabled": false, - "document": "Agent ID 列表，例如：agent-abcd1234，可在控制台 Agent 管理中获取\n\n示例值：[\"agent-abcd1234\"]", - "example": "[\"xx\"]", + "document": "Agent ID 列表，例如：agent-abcd1234，可在控制台 Agent 管理中获取", + "example": "[\"agent-abcd1234\"]", "member": "string", "name": "AgentIds", "required": true, @@ -21044,7 +21044,7 @@ }, { "disabled": false, - "document": "服务发现配置信息，YAML 格式\n\n示例值：\n\n```\napiVersion: monitoring.coreos.com/v1\nkind: ServiceMonitor\nmetadata:\n name: go-demo # 填写一个唯一名称\n namespace: cm-prometheus # namespace固定，不要修改\nspec:\n endpoints:\n - interval: 30s\n # 填写service yaml中Prometheus Exporter对应的Port的Name\n port: 2112\n # 填写Prometheus Exporter对应的Path的值，不填默认/metrics\n path: /metrics\n relabelings:\n # ** 必须要有一个 label 为 application，这里假设 k8s 有一个 label 为 app，\n # 我们通过 relabel 的 replace 动作把它替换成了 application\n - action: replace\n sourceLabels: [__meta_kubernetes_pod_label_app]\n targetLabel: application\n # 选择要监控service所在的namespace\n namespaceSelector:\n matchNames:\n - golang-demo\n # 填写要监控service的Label值，以定位目标service\n selector:\n matchLabels:\n app: golang-app-demo\n```", + "document": "服务发现配置信息，YAML 格式，[具体YAML参数内容请参考](https://cloud.tencent.com/document/product/1416/55995#service-monitor)", "example": "yaml", "member": "string", "name": "Yaml", diff --git a/tccli/services/monitor/v20180724/examples.json b/tccli/services/monitor/v20180724/examples.json index 267bb6f8eb..48308a6100 100644 --- a/tccli/services/monitor/v20180724/examples.json +++ b/tccli/services/monitor/v20180724/examples.json @@ -257,8 +257,8 @@ "CreatePrometheusClusterAgent": [ { "document": "关联eks集群", - "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrometheusClusterAgent\n<公共请求参数>\n\n{\n \"InstanceId\": \"xxx\",\n \"Agents\": [\n {\n \"EnableExternal\": true,\n \"Region\": \"xxx\",\n \"ClusterId\": \"xxx\",\n \"ClusterType\": \"xxx\",\n \"NotInstallBasicScrape\": true,\n \"InClusterPodConfig\": {\n \"HostNet\": true,\n \"Tolerations\": [\n {\n \"Operator\": \"xxx\",\n \"Effect\": \"xxx\",\n \"Key\": \"xxx\"\n }\n ],\n \"NodeSelector\": [\n {\n \"Name\": \"xxx\",\n \"Value\": \"xxx\"\n }\n ]\n },\n \"NotScrape\": true,\n \"ExternalLabels\": [\n {\n \"Name\": \"xxx\",\n \"Value\": \"xxx\"\n }\n ]\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"xxx\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrometheusClusterAgent\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-wjeh\",\n \"Agents\": [\n {\n \"EnableExternal\": true,\n \"Region\": \"ap-jehr\",\n \"ClusterId\": \"cls-hrbr\",\n \"ClusterType\": \"eks\",\n \"NotInstallBasicScrape\": true,\n \"InClusterPodConfig\": {\n \"HostNet\": true,\n \"Tolerations\": [\n {\n \"Operator\": \"Exists\",\n \"Effect\": \"NoSchedule\",\n \"Key\": \"key-name\"\n }\n ],\n \"NodeSelector\": [\n {\n \"Name\": \"label-name\",\n \"Value\": \"label-value\"\n }\n ]\n },\n \"NotScrape\": true,\n \"ExternalLabels\": [\n {\n \"Name\": \"label-name\",\n \"Value\": \"label-value\"\n }\n ]\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"ejfhfol-lejrgbf\"\n }\n}", "title": "关联集群" }, { @@ -311,8 +311,8 @@ "CreatePrometheusTemp": [ { "document": "创建一个模板", - "input": "https://monitor.tencentcloudapi.com/?Action=CreatePrometheusTemp\n&Template.Name=t1\n&Template.Describe=一个模板\n&Template.ServiceMonitors.0.Name=s\n&Template.ServiceMonitors.0.Config=abc\n&Template.Level=cluster\n&<公共请求参数>\n\n{\n \"Template\": {\n \"Name\": \"abc\",\n \"Describe\": \"abc\",\n \"Level\": \"abc\",\n \"RecordRules\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"ServiceMonitors\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"PodMonitors\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"TemplateId\": \"abc\",\n \"UpdateTime\": \"abc\",\n \"Version\": \"abc\",\n \"IsDefault\": true,\n \"AlertDetailRules\": [\n {\n \"Id\": \"abc\",\n \"Name\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Notification\": {\n \"Enabled\": true,\n \"Type\": \"abc\",\n \"WebHook\": \"abc\",\n \"AlertManager\": {\n \"ClusterType\": \"abc\",\n \"ClusterId\": \"abc\",\n \"Url\": \"abc\"\n },\n \"RepeatInterval\": \"abc\",\n \"TimeRangeStart\": \"abc\",\n \"TimeRangeEnd\": \"abc\",\n \"NotifyWay\": [\n \"abc\"\n ],\n \"ReceiverGroups\": [\n \"abc\"\n ],\n \"PhoneNotifyOrder\": [\n 1\n ],\n \"PhoneCircleTimes\": 0,\n \"PhoneInnerInterval\": 0,\n \"PhoneCircleInterval\": 0,\n \"PhoneArriveNotice\": true\n },\n \"Rules\": [\n {\n \"Name\": \"abc\",\n \"Rule\": \"abc\",\n \"Labels\": [\n {\n \"Name\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Template\": \"abc\",\n \"For\": \"abc\",\n \"Describe\": \"abc\",\n \"Annotations\": [\n {\n \"Name\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"RuleState\": 0\n }\n ],\n \"UpdatedAt\": \"abc\",\n \"ClusterId\": \"abc\",\n \"Interval\": \"abc\"\n }\n ],\n \"TargetsTotal\": 0\n }\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\",\n \"TemplateId\": \"temp-xxx\"\n }\n}", + "input": "https://monitor.tencentcloudapi.com/?Action=CreatePrometheusTemp\n&Template.Name=t1\n&Template.Describe=一个模板\n&Template.ServiceMonitors.0.Name=s\n&Template.ServiceMonitors.0.Config=abc\n&Template.Level=cluster\n&<公共请求参数>\n\n{\n \"Template\": {\n \"Name\": \"test\",\n \"Describe\": \"test\",\n \"Level\": \"instance\",\n \"RecordRules\": [\n {\n \"Name\": \"testRule\",\n \"Config\": \"abc\",\n \"TemplateId\": \"temp-asdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"RawJobs\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"ServiceMonitors\": [\n {\n \"Name\": \"test-sm\",\n \"Config\": \"abc\",\n \"TemplateId\": \"temp-asdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"PodMonitors\": [\n {\n \"Name\": \"test-pm\",\n \"Config\": \"abc\",\n \"TemplateId\": \"temp-asdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"TemplateId\": \"temp-asdj\",\n \"UpdateTime\": \"2024-07-16T08:28:54Z\",\n \"Version\": \"v1\",\n \"IsDefault\": true,\n \"AlertDetailRules\": [\n {\n \"Id\": \"rule-asdk\",\n \"Name\": \"testAlert\",\n \"TemplateId\": \"temp-asdj\",\n \"Notification\": {\n \"Enabled\": true,\n \"Type\": \"amp\",\n \"WebHook\": \"abc\",\n \"AlertManager\": {\n \"ClusterType\": \"tke\",\n \"ClusterId\": \"cls-askj\",\n \"Url\": \"http://asasdkfh:9000\"\n },\n \"RepeatInterval\": \"5m\",\n \"TimeRangeStart\": \"00:00:00\",\n \"TimeRangeEnd\": \"23:59:59\",\n \"NotifyWay\": [\n \"abc\"\n ],\n \"ReceiverGroups\": [\n \"notice-yakj\"\n ],\n \"PhoneNotifyOrder\": [\n 1\n ],\n \"PhoneCircleTimes\": 0,\n \"PhoneInnerInterval\": 0,\n \"PhoneCircleInterval\": 0,\n \"PhoneArriveNotice\": true\n },\n \"Rules\": [\n {\n \"Name\": \"rule-ajdb\",\n \"Rule\": \"avg by (abc) skdj\",\n \"Labels\": [\n {\n \"Name\": \"label-name\",\n \"Value\": \"label-value\"\n }\n ],\n \"Template\": \"temp-asdj\",\n \"For\": \"5m\",\n \"Describe\": \"test-temp\",\n \"Annotations\": [\n {\n \"Name\": \"label-name\",\n \"Value\": \"label-value\"\n }\n ],\n \"RuleState\": 0\n }\n ],\n \"UpdatedAt\": \"2024-07-16 16:28:54\",\n \"ClusterId\": \"cls-djfb\",\n \"Interval\": \"5m\"\n }\n ],\n \"TargetsTotal\": 0\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\",\n \"TemplateId\": \"temp-lejrh\"\n }\n}", "title": "创建一个模板" } ], @@ -423,7 +423,7 @@ "DeletePrometheusClusterAgent": [ { "document": "删除agent", - "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeletePrometheusClusterAgent\n<公共请求参数>\n\n{\n \"Agents\": [\n {\n \"ClusterType\": \"abc\",\n \"ClusterId\": \"abc\",\n \"Describe\": \"abc\"\n }\n ],\n \"InstanceId\": \"abc\"\n}", + "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeletePrometheusClusterAgent\n<公共请求参数>\n\n{\n \"Agents\": [\n {\n \"ClusterType\": \"cls-kehr\",\n \"ClusterId\": \"tke\",\n \"Describe\": \"test-des\"\n }\n ],\n \"InstanceId\": \"prom-sjerg\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n }\n}", "title": "删除agent" } @@ -431,7 +431,7 @@ "DeletePrometheusConfig": [ { "document": "删除prometheus配置", - "input": "https://monitor.tencentcloudapi.com/?Action=DeletePrometheusConfig\n&InstanceId=prom-xxx\n&ClusterType=tke\n&ClusterId=cls-xxx\n&<公共请求参数>", + "input": "https://monitor.tencentcloudapi.com/?Action=DeletePrometheusConfig\n&InstanceId=prom-pejrh\n&ClusterType=tke\n&ClusterId=cls-hegr\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n }\n}", "title": "删除prometheus配置" } @@ -439,7 +439,7 @@ "DeletePrometheusRecordRuleYaml": [ { "document": "删除聚合规则", - "input": "https://monitor.tencentcloudapi.com/?Action=DeletePrometheusRecordRuleYaml\n&InstanceId=prom-xxx\n&Names.0=xxx\n&<公共请求参数>", + "input": "https://monitor.tencentcloudapi.com/?Action=DeletePrometheusRecordRuleYaml\n&InstanceId=prom-ejfdgh\n&Names.0=test-rule\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n }\n}", "title": "删除聚合规则" } @@ -839,8 +839,8 @@ "DescribePrometheusClusterAgents": [ { "document": "拉取agent信息", - "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusClusterAgents\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"Limit\": 1,\n \"Offset\": 1\n}", - "output": "{\n \"Response\": {\n \"Agents\": [\n {\n \"ClusterType\": \"abc\",\n \"ClusterId\": \"abc\",\n \"Status\": \"abc\",\n \"ClusterName\": \"abc\",\n \"ExternalLabels\": [\n {\n \"Name\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Region\": \"abc\",\n \"VpcId\": \"abc\",\n \"FailedReason\": \"abc\",\n \"Name\": \"abc\",\n \"EnableExternal\": true,\n \"DesiredAgentNum\": 0,\n \"ReadyAgentNum\": 0\n }\n ],\n \"Total\": 1,\n \"IsFirstBind\": true,\n \"ImageNeedUpdate\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusClusterAgents\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-abc\",\n \"Limit\": 1,\n \"Offset\": 1\n}", + "output": "{\n \"Response\": {\n \"Agents\": [\n {\n \"ClusterId\": \"cls-abc\",\n \"ClusterName\": \"abc\",\n \"ClusterType\": \"tke\",\n \"EnableExternal\": false,\n \"ExternalLabels\": [\n {\n \"Name\": \"cluster\",\n \"Value\": \"cls-cde\"\n },\n {\n \"Name\": \"cluster_type\",\n \"Value\": \"tke\"\n }\n ],\n \"FailedReason\": \"\",\n \"Name\": \"\",\n \"ReadyAgentNum\": 1,\n \"Region\": \"ap-guangzhou\",\n \"Status\": \"normal\",\n \"VpcId\": \"vpc-abc\"\n }\n ],\n \"IsFirstBind\": false,\n \"RequestId\": \"56ce7-sdsd\",\n \"ImageNeedUpdate\": false,\n \"Total\": 1\n }\n}", "title": "拉取agent信息" } ], @@ -848,7 +848,7 @@ { "document": "拉取prometheus配置", "input": "https://monitor.tencentcloudapi.com/?Action=DescribePrometheusConfig\r\n&InstanceId=prom-xxx\r\n&ClusterType=tke\r\n&ClusterId=cls-xxx\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Config\": \"abc\",\n \"ServiceMonitors\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"PodMonitors\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"RawJobs\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"Probes\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"ImageNeedUpdate\": true,\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"Config\": \"abc\",\n \"ServiceMonitors\": [\n {\n \"Name\": \"test-sm\",\n \"Config\": \"scrape_interval:5s\\n\",\n \"TemplateId\": \"temp-akdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"PodMonitors\": [\n {\n \"Name\": \"test-pm\",\n \"Config\": \"scrape_interval:5s\\n\",\n \"TemplateId\": \"temp-akdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"RawJobs\": [\n {\n \"Name\": \"test-rawjob\",\n \"Config\": \"scrape_interval:5s\\n\",\n \"TemplateId\": \"temp-akdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"Probes\": [\n {\n \"Name\": \"test-probe\",\n \"Config\": \"scrape_interval:5s\\n\",\n \"TemplateId\": \"temp-akdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"ImageNeedUpdate\": true,\n \"RequestId\": \"abc\"\n }\n}", "title": "拉取prometheus配置" } ], @@ -856,7 +856,7 @@ { "document": "获得实例级别监控配置", "input": "https://monitor.tencentcloudapi.com/?Action=DescribePrometheusGlobalConfig\n&InstanceId=prom-xxx\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Config\": \"abc\",\n \"ServiceMonitors\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"PodMonitors\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"Probes\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"RawJobs\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"Config\": \"abc\",\n \"ServiceMonitors\": [\n {\n \"Name\": \"test-sm\",\n \"Config\": \"scrape_interval:5s\\n\",\n \"TemplateId\": \"temp-akdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"PodMonitors\": [\n {\n \"Name\": \"test-pm\",\n \"Config\": \"scrape_interval:5s\\n\",\n \"TemplateId\": \"temp-akdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"RawJobs\": [\n {\n \"Name\": \"test-rawjob\",\n \"Config\": \"scrape_interval:5s\\n\",\n \"TemplateId\": \"temp-akdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"Probes\": [\n {\n \"Name\": \"test-probe\",\n \"Config\": \"scrape_interval:5s\\n\",\n \"TemplateId\": \"temp-akdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", "title": "获得实例级别监控配置" } ], @@ -872,21 +872,21 @@ { "document": "查询TMP实例详情", "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusInstanceDetail\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"InstanceId\": \"abc\",\n \"InstanceName\": \"abc\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"InstanceStatus\": 0,\n \"ChargeStatus\": 0,\n \"EnableGrafana\": 0,\n \"GrafanaURL\": \"abc\",\n \"InstanceChargeType\": 0,\n \"SpecName\": \"abc\",\n \"DataRetentionTime\": 0,\n \"ExpireTime\": \"abc\",\n \"AutoRenewFlag\": 0,\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"InstanceId\": \"prom-skdfj\",\n \"InstanceName\": \"test-prom\",\n \"VpcId\": \"vpc-sjdh\",\n \"SubnetId\": \"subnet-kdhe\",\n \"InstanceStatus\": 3,\n \"ChargeStatus\": 1,\n \"EnableGrafana\": 0,\n \"GrafanaURL\": \"http://djeb:9000\",\n \"InstanceChargeType\": 0,\n \"SpecName\": \"name-sjdb\",\n \"DataRetentionTime\": 15,\n \"ExpireTime\": \"2024-07-16 16:28:54\",\n \"AutoRenewFlag\": 0,\n \"RequestId\": \"skdbfdi-akenfhl\"\n }\n}", "title": "查询TMP实例详情" } ], "DescribePrometheusInstanceInitStatus": [ { "document": "获取初始化任务状态", - "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusInstanceInitStatus\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"Status\": \"abc\",\n \"Steps\": [\n {\n \"Step\": \"abc\",\n \"LifeState\": \"abc\",\n \"StartAt\": \"abc\",\n \"EndAt\": \"abc\",\n \"FailedMsg\": \"abc\"\n }\n ],\n \"EksClusterId\": \"abc\",\n \"SecurityGroupId\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusInstanceInitStatus\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-asdf1234\"\n}", + "output": "{\n \"Response\": {\n \"Status\": \"initializing\",\n \"Steps\": [\n {\n \"Step\": \"preCheck\",\n \"LifeState\": \"success\",\n \"StartAt\": \"2022-04-19T07:29:46Z\",\n \"EndAt\": \"2022-04-19T07:30:46Z\",\n \"FailedMsg\": \"message\"\n }\n ],\n \"EksClusterId\": \"cls-asdf1234\",\n \"SecurityGroupId\": \"sg-asdf1234\",\n \"RequestId\": \"abc-123-asdfghjk\"\n }\n}", "title": "获取初始化任务状态" }, { "document": "获取2.0实例初始化任务状态", - "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusInstanceInitStatus\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-7vp71ppt\"\n}", - "output": "{\n \"Response\": {\n \"Status\": \"abc\",\n \"Steps\": [\n {\n \"Step\": \"abc\",\n \"LifeState\": \"abc\",\n \"StartAt\": \"abc\",\n \"EndAt\": \"abc\",\n \"FailedMsg\": \"abc\"\n }\n ],\n \"EksClusterId\": \"abc\",\n \"SecurityGroupId\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusInstanceInitStatus\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-asdf1234\"\n}", + "output": "{\n \"Response\": {\n \"Status\": \"initializing\",\n \"Steps\": [\n {\n \"Step\": \"preCheck\",\n \"LifeState\": \"success\",\n \"StartAt\": \"2022-04-19T07:29:46Z\",\n \"EndAt\": \"2022-04-19T07:30:46Z\",\n \"FailedMsg\": \"message\"\n }\n ],\n \"EksClusterId\": \"cls-asdf1234\",\n \"SecurityGroupId\": \"sg-asdf1234\",\n \"RequestId\": \"abc-123-asdfghjk\"\n }\n}", "title": "获取2.0实例初始化任务状态" } ], @@ -910,7 +910,7 @@ { "document": "获取实例列表", "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusInstancesOverview\n<公共请求参数>\n\n{\n \"Limit\": 1,\n \"Filters\": [\n {\n \"Name\": \"Name\",\n \"Values\": [\n \"alert-test\"\n ]\n }\n ],\n \"Offset\": 1\n}", - "output": "{\n \"Response\": {\n \"Instances\": [\n {\n \"InstanceStatus\": 0,\n \"BoundNormal\": 0,\n \"VpcId\": \"xxx\",\n \"AutoRenewFlag\": 0,\n \"InstanceId\": \"xxx\",\n \"BoundTotal\": 0,\n \"ExpireTime\": \"xxx\",\n \"SpecName\": \"xxx\",\n \"InstanceChargeType\": 0,\n \"EnableGrafana\": 0,\n \"DataRetentionTime\": 0,\n \"GrafanaURL\": \"xxx\",\n \"SubnetId\": \"xxx\",\n \"InstanceName\": \"xxx\",\n \"ChargeStatus\": 0,\n \"ResourcePackageStatus\": 1,\n \"ResourcePackageSpecName\": \"fff\"\n }\n ],\n \"Total\": 1,\n \"RequestId\": \"xxx\"\n }\n}", + "output": "{\n \"Response\": {\n \"Instances\": [\n {\n \"InstanceStatus\": 3,\n \"BoundNormal\": 1,\n \"VpcId\": \"vpc-sjdfb\",\n \"AutoRenewFlag\": 0,\n \"InstanceId\": \"prom-ajsh\",\n \"BoundTotal\": 1,\n \"ExpireTime\": \"2024-07-16 16:28:54\",\n \"SpecName\": \"spec-name\",\n \"InstanceChargeType\": 2,\n \"EnableGrafana\": 0,\n \"DataRetentionTime\": 15,\n \"GrafanaURL\": \"http://1.1.1.1:9000\",\n \"SubnetId\": \"subnet-ljeb\",\n \"InstanceName\": \"test-prom\",\n \"ChargeStatus\": 1,\n \"ResourcePackageStatus\": 1,\n \"ResourcePackageSpecName\": \"pkg-name\"\n }\n ],\n \"Total\": 1,\n \"RequestId\": \"sjehg-jdgrg\"\n }\n}", "title": "获取实例列表" } ], @@ -950,7 +950,7 @@ { "document": "获取targets列表", "input": "https://monitor.tencentcloudapi.com/?Action=DescribePrometheusTargetsTMP\n&InstanceId=prom-xxx\n&ClusterType=tke\n&ClusterId=cls-xxx\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Jobs\": [\n {\n \"Targets\": [\n {}\n ],\n \"JobName\": \"abc\",\n \"Total\": 1,\n \"Up\": 1\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"Jobs\": [\n {\n \"Targets\": [\n {}\n ],\n \"Total\": 1,\n \"Up\": 0,\n \"JobName\": \"test-job\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", "title": "获取targets列表" } ], @@ -958,7 +958,7 @@ { "document": "拉取模板列表", "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusTemp\n<公共请求参数>\n\n{\n \"Limit\": 1,\n \"Filters\": [\n {\n \"Name\": \"ID\",\n \"Values\": [\n \"alert-test\"\n ]\n }\n ],\n \"Offset\": 1\n}", - "output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"Name\": \"abc\",\n \"Describe\": \"abc\",\n \"Level\": \"abc\",\n \"RecordRules\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"RawJobs\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"ServiceMonitors\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"PodMonitors\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"TemplateId\": \"abc\",\n \"UpdateTime\": \"abc\",\n \"Version\": \"abc\",\n \"IsDefault\": true,\n \"AlertDetailRules\": [\n {\n \"Id\": \"abc\",\n \"Name\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Notification\": {\n \"Enabled\": true,\n \"Type\": \"abc\",\n \"WebHook\": \"abc\",\n \"AlertManager\": {\n \"ClusterType\": \"abc\",\n \"ClusterId\": \"abc\",\n \"Url\": \"abc\"\n },\n \"RepeatInterval\": \"abc\",\n \"TimeRangeStart\": \"abc\",\n \"TimeRangeEnd\": \"abc\",\n \"NotifyWay\": [\n \"abc\"\n ],\n \"ReceiverGroups\": [\n \"abc\"\n ],\n \"PhoneNotifyOrder\": [\n 1\n ],\n \"PhoneCircleTimes\": 0,\n \"PhoneInnerInterval\": 0,\n \"PhoneCircleInterval\": 0,\n \"PhoneArriveNotice\": true\n },\n \"Rules\": [\n {\n \"Name\": \"abc\",\n \"Rule\": \"abc\",\n \"Labels\": [\n {\n \"Name\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Template\": \"abc\",\n \"For\": \"abc\",\n \"Describe\": \"abc\",\n \"Annotations\": [\n {\n \"Name\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"RuleState\": 0\n }\n ],\n \"UpdatedAt\": \"abc\",\n \"ClusterId\": \"abc\"\n }\n ],\n \"TargetsTotal\": 0\n }\n ],\n \"Total\": 1,\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"Name\": \"test\",\n \"Describe\": \"test\",\n \"Level\": \"instance\",\n \"RecordRules\": [\n {\n \"Name\": \"testRule\",\n \"Config\": \"abc\",\n \"TemplateId\": \"temp-asdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"RawJobs\": [\n {\n \"Name\": \"abc\",\n \"Config\": \"abc\",\n \"TemplateId\": \"abc\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"ServiceMonitors\": [\n {\n \"Name\": \"test-sm\",\n \"Config\": \"abc\",\n \"TemplateId\": \"temp-asdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"PodMonitors\": [\n {\n \"Name\": \"test-pm\",\n \"Config\": \"abc\",\n \"TemplateId\": \"temp-asdj\",\n \"Targets\": {\n \"Total\": 1,\n \"Up\": 1,\n \"Down\": 1,\n \"Unknown\": 1\n }\n }\n ],\n \"TemplateId\": \"temp-asdj\",\n \"UpdateTime\": \"2024-07-16T08:28:54Z\",\n \"Version\": \"v1\",\n \"IsDefault\": true,\n \"AlertDetailRules\": [\n {\n \"Id\": \"rule-asdk\",\n \"Name\": \"testAlert\",\n \"TemplateId\": \"temp-asdj\",\n \"Notification\": {\n \"Enabled\": true,\n \"Type\": \"amp\",\n \"WebHook\": \"abc\",\n \"AlertManager\": {\n \"ClusterType\": \"tke\",\n \"ClusterId\": \"cls-askj\",\n \"Url\": \"http://asasdkfh:9000\"\n },\n \"RepeatInterval\": \"5m\",\n \"TimeRangeStart\": \"00:00:00\",\n \"TimeRangeEnd\": \"23:59:59\",\n \"NotifyWay\": [\n \"abc\"\n ],\n \"ReceiverGroups\": [\n \"notice-yakj\"\n ],\n \"PhoneNotifyOrder\": [\n 1\n ],\n \"PhoneCircleTimes\": 0,\n \"PhoneInnerInterval\": 0,\n \"PhoneCircleInterval\": 0,\n \"PhoneArriveNotice\": true\n },\n \"Rules\": [\n {\n \"Name\": \"rule-ajdb\",\n \"Rule\": \"avg by (abc) skdj\",\n \"Labels\": [\n {\n \"Name\": \"label-name\",\n \"Value\": \"label-value\"\n }\n ],\n \"Template\": \"temp-asdj\",\n \"For\": \"5m\",\n \"Describe\": \"test-temp\",\n \"Annotations\": [\n {\n \"Name\": \"label-name\",\n \"Value\": \"label-value\"\n }\n ],\n \"RuleState\": 0\n }\n ],\n \"UpdatedAt\": \"2024-07-16 16:28:54\",\n \"ClusterId\": \"cls-djfb\"\n }\n ],\n \"TargetsTotal\": 0\n }\n ],\n \"Total\": 1,\n \"RequestId\": \"skdh-afbri\"\n }\n}", "title": "拉取模板列表" } ], @@ -966,7 +966,7 @@ { "document": "拉取同步目标", "input": "https://monitor.tencentcloudapi.com/?Action=DescribePrometheusTempSync\n&TemplateId=\"temp-xxx\"\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Targets\": [\n {\n \"Region\": \"abc\",\n \"InstanceId\": \"abc\",\n \"ClusterId\": \"abc\",\n \"SyncTime\": \"abc\",\n \"Version\": \"abc\",\n \"ClusterType\": \"abc\",\n \"InstanceName\": \"abc\",\n \"ClusterName\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"Targets\": [\n {\n \"Region\": \"ap-beijing\",\n \"InstanceId\": \"prom-sjfgh\",\n \"ClusterId\": \"cls-kdje\",\n \"SyncTime\": \"2024-07-16 16:28:54\",\n \"Version\": \"v1\",\n \"ClusterType\": \"tke\",\n \"InstanceName\": \"test-prom\",\n \"ClusterName\": \"test-cluster\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", "title": "拉取同步目标" } ], @@ -1159,7 +1159,7 @@ "ModifyPrometheusAgentExternalLabels": [ { "document": "修改label", - "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyPrometheusAgentExternalLabels\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ClusterId\": \"abc\",\n \"ExternalLabels\": [\n {\n \"Name\": \"abc\",\n \"Value\": \"abc\"\n }\n ]\n}", + "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyPrometheusAgentExternalLabels\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-jegh\",\n \"ClusterId\": \"cls-uerhf\",\n \"ExternalLabels\": [\n {\n \"Name\": \"label-name\",\n \"Value\": \"label-value\"\n }\n ]\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}", "title": "修改label" } @@ -1174,10 +1174,10 @@ ], "ModifyPrometheusConfig": [ { - "document": "新增配置", + "document": "修改采集配置", "input": "https://monitor.tencentcloudapi.com/?Action=ModifyPrometheusConfig\n&InstanceId=prom-xxx\n&ClusterType=tke\n&ClusterId=cls-xxx\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n }\n}", - "title": "新增配置" + "title": "修改采集配置" } ], "ModifyPrometheusGlobalNotification": [ @@ -1223,8 +1223,8 @@ "RunPrometheusInstance": [ { "document": "初始化实例", - "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RunPrometheusInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-xxx\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"xxx\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RunPrometheusInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-asdfghjk\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"abc-123-asdfghjk\"\n }\n}", "title": "初始化实例" } ], diff --git a/tccli/services/tcr/v20190924/api.json b/tccli/services/tcr/v20190924/api.json index 920f7a6390..f7d95cea90 100644 --- a/tccli/services/tcr/v20190924/api.json +++ b/tccli/services/tcr/v20190924/api.json @@ -1025,7 +1025,7 @@ }, { "disabled": false, - "document": "1: Illegal（名子非法）, 2:Reserved（名字保留）, 3:Existed（名字已存在）\n注意：此字段可能返回 null，表示取不到有效值。", + "document": "1: Illegal（名称非法）, 2:Reserved（名字保留）, 3:Existed（名字已存在）\n注意：此字段可能返回 null，表示取不到有效值。", "example": "1", "member": "int64", "name": "DetailCode", diff --git a/tccli/services/tcr/v20190924/examples.json b/tccli/services/tcr/v20190924/examples.json index d9572a25b0..b06a8cbacf 100644 --- a/tccli/services/tcr/v20190924/examples.json +++ b/tccli/services/tcr/v20190924/examples.json @@ -878,7 +878,7 @@ ], "ModifyUserPasswordPersonal": [ { - "document": "ccr修改个人用户登陆密码", + "document": "ccr修改个人用户登录密码", "input": "https://tcr.tencentcloudapi.com/?Action=ModifyUserPasswordPersonal\r\n&Password=XXXXX\r\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n }\n}", "title": "修改个人用户登录密码" diff --git a/tccli/services/vpc/v20170312/api.json b/tccli/services/vpc/v20170312/api.json index 53bdb3bbcf..d57f14e7b1 100644 --- a/tccli/services/vpc/v20170312/api.json +++ b/tccli/services/vpc/v20170312/api.json @@ -2082,7 +2082,7 @@ "ModifySecurityGroupPolicies": { "document": "本接口（ModifySecurityGroupPolicies）用于重置安全组出站和入站规则（SecurityGroupPolicy）。\n\n", "input": "ModifySecurityGroupPoliciesRequest", - "name": "修改安全组出站和入站规则", + "name": "重置安全组出站和入站规则", "output": "ModifySecurityGroupPoliciesResponse", "status": "online" }, diff --git a/tccli/services/waf/v20180125/examples.json b/tccli/services/waf/v20180125/examples.json index 069f700cb5..8bccc1755d 100644 --- a/tccli/services/waf/v20180125/examples.json +++ b/tccli/services/waf/v20180125/examples.json @@ -252,7 +252,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: waf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAccessHistogram\n<公共请求参数>\n\n{\n \"TopicId\": \"1ae37c76-df99-4e2b-998c-20f39eba6226\",\n \"From\": 1625395948532,\n \"To\": 1626000748532,\n \"Query\": \"\"\n}", - "output": "{\n \"Response\": {\n \"Interval\": 12096000,\n \"TotalCount\": 6221,\n \"RequestId\": \"9b02bf9e-c89c-42c3-9ae1-685f968fa02d\",\n \"HistogramInfos\": [\n {\n \"BTime\": 0,\n \"Count\": 0\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"Interval\": 12096000,\n \"TotalCount\": 6221,\n \"RequestId\": \"9b02bf9e-c89c-42c3-9ae1-685f968fa02d\",\n \"HistogramInfos\": [\n {\n \"BTime\": 0,\n \"BeginTime\": 0,\n \"Count\": 0\n }\n ]\n }\n}", "title": "访问日志柱状趋势图" } ],