From 1df966763234e592facbd3d598fc7376a4af0a40 Mon Sep 17 00:00:00 2001 From: tencentcloudapi Date: Thu, 19 Dec 2024 04:10:43 +0800 Subject: [PATCH] release 3.0.1237.1 --- CHANGELOG.md | 327 ++++ SERVICE_CHANGELOG.md | 600 +++++++- products.md | 54 +- pyproject.toml | 4 +- tccli/__init__.py | 2 +- .../v20210622/DescribeGeneralMetricData.md | 1311 +++++++++++++---- .../GetServiceLinkedRoleDeletionStatus.md | 2 +- .../v20190116/ListAttachedGroupPolicies.md | 2 +- .../cam/v20190116/ListAttachedRolePolicies.md | 4 +- .../cam/v20190116/ListAttachedUserPolicies.md | 18 +- tccli/examples/cam/v20190116/ListPolicies.md | 6 +- .../ListPoliciesGrantingServiceAccess.md | 11 +- .../cdb/v20170320/ModifyProtectMode.md | 21 + .../cloudaudit/v20190319/LookUpEvents.md | 2 +- .../cloudaudit/v20190319/StartLogging.md | 2 +- .../DescribeClusterDatabaseTables.md | 27 + .../domain/v20180808/DeleteBidding.md | 2 +- .../DescribeBatchOperationLogDetails.md | 22 +- .../v20180808/DescribeBiddingAppointDetail.md | 2 +- .../v20180808/DescribeBiddingAppointList.md | 2 +- .../domain/v20180808/DescribeBiddingDetail.md | 4 +- .../domain/v20180808/DescribeBiddingList.md | 8 +- .../DescribeBiddingSuccessfulDetail.md | 4 +- .../v20180808/DescribeCustomDnsHostSet.md | 4 +- .../v20180808/DescribeDomainBaseInfo.md | 2 +- .../v20180808/DescribeDomainSimpleInfo.md | 2 +- .../domain/v20180808/DescribePayWaitDetail.md | 16 +- .../domain/v20180808/DescribeTemplate.md | 18 +- .../domain/v20180808/DescribeTemplateList.md | 12 +- .../v20180808/DescribeUnPreDomainDetail.md | 26 +- .../v20180808/ModifyDomainOwnerBatch.md | 2 +- .../domain/v20180808/TransferInDomainBatch.md | 2 +- .../examples/domain/v20180808/UploadImage.md | 2 +- .../DescribeOrganizationVerifyStatus.md | 21 + .../gwlb/v20240906/DescribeTargetGroupList.md | 86 +- .../ModifyTargetGroupInstancesWeight.md | 2 +- tccli/examples/lcic/v20220817/CreateRoom.md | 12 +- .../v20200324/DescribeFirewallRules.md | 2 +- .../lighthouse/v20200324/DescribeKeyPairs.md | 2 +- .../mongodb/v20180408/CreateDBInstance.md | 12 +- .../v20180408/DescribeClientConnections.md | 12 +- .../mongodb/v20190725/DescribeCurrentOp.md | 25 +- .../mongodb/v20190725/FlashBackDBInstance.md | 6 +- .../v20180724/CreateExporterIntegration.md | 2 +- .../v20240516/DescribeDeviceCertificate.md | 2 +- .../ssl/v20191205/DescribeCompanies.md | 2 +- .../sts/v20180813/AssumeRoleWithSAML.md | 2 +- .../tdid/v20210519/CreatePresentation.md | 2 +- .../tdid/v20210519/QueryAuthorityInfo.md | 6 +- .../tdid/v20210519/SetTDidAttribute.md | 4 +- .../tdid/v20210519/VerifyPresentation.md | 2 +- .../vpc/v20170312/CreateVpnGateway.md | 36 +- .../wedata/v20210820/CreateHiveTableByDDL.md | 6 +- .../wedata/v20210820/DescribeDsFolderTree.md | 24 + .../wedata/v20210820/DescribeOpsMakePlans.md | 67 +- .../DescribeSchedulerTaskCntByStatus.md | 27 +- tccli/services/apm/v20210622/api.json | 30 +- tccli/services/apm/v20210622/examples.json | 38 +- tccli/services/ba/v20200720/api.json | 5 +- tccli/services/billing/v20180709/api.json | 4 +- tccli/services/cam/v20190116/api.json | 153 +- tccli/services/cam/v20190116/examples.json | 14 +- tccli/services/ccc/v20200210/api.json | 9 + tccli/services/cdb/cdb_client.py | 53 + tccli/services/cdb/v20170320/api.json | 43 + tccli/services/cdb/v20170320/examples.json | 8 + tccli/services/cfg/v20210820/api.json | 21 + tccli/services/cloudapp/v20220530/api.json | 10 + tccli/services/cloudaudit/v20190319/api.json | 79 +- .../cloudaudit/v20190319/examples.json | 4 +- tccli/services/cvm/v20170312/api.json | 10 +- tccli/services/cynosdb/cynosdb_client.py | 53 + tccli/services/cynosdb/v20190107/api.json | 110 ++ .../services/cynosdb/v20190107/examples.json | 8 + tccli/services/domain/v20180808/api.json | 35 +- tccli/services/domain/v20180808/examples.json | 44 +- tccli/services/ess/ess_client.py | 61 +- tccli/services/ess/v20201111/api.json | 53 + tccli/services/ess/v20201111/examples.json | 8 + tccli/services/essbasic/v20210526/api.json | 2 +- tccli/services/gwlb/v20240906/api.json | 32 +- tccli/services/gwlb/v20240906/examples.json | 4 +- tccli/services/hunyuan/v20230901/api.json | 12 +- tccli/services/lcic/v20220817/api.json | 6 +- tccli/services/lcic/v20220817/examples.json | 4 +- .../lighthouse/v20200324/examples.json | 4 +- tccli/services/live/v20180801/api.json | 10 +- tccli/services/mongodb/v20180408/api.json | 92 +- .../services/mongodb/v20180408/examples.json | 8 +- tccli/services/mongodb/v20190725/api.json | 228 +-- .../services/mongodb/v20190725/examples.json | 10 +- .../services/monitor/v20180724/examples.json | 2 +- tccli/services/mqtt/v20240516/api.json | 2 +- tccli/services/mqtt/v20240516/examples.json | 2 +- tccli/services/pts/v20210728/api.json | 8 + tccli/services/ssl/v20191205/examples.json | 2 +- tccli/services/sts/v20180813/examples.json | 2 +- tccli/services/tdid/v20210519/api.json | 68 +- tccli/services/tdid/v20210519/examples.json | 10 +- tccli/services/trocket/v20230308/api.json | 6 +- tccli/services/vpc/v20170312/api.json | 25 +- tccli/services/vpc/v20170312/examples.json | 2 +- tccli/services/vrs/v20200824/api.json | 5 +- tccli/services/wedata/v20210820/api.json | 590 +++++++- tccli/services/wedata/v20210820/examples.json | 14 +- 105 files changed, 3798 insertions(+), 1090 deletions(-) create mode 100644 tccli/examples/cdb/v20170320/ModifyProtectMode.md create mode 100644 tccli/examples/cynosdb/v20190107/DescribeClusterDatabaseTables.md create mode 100644 tccli/examples/ess/v20201111/DescribeOrganizationVerifyStatus.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 7970ade281..a45e20688d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,330 @@ +# Release 3.0.1237.1 + +## 云联络中心(ccc) 版本：2020-02-10 + +### 第 83 次发布 + +发布时间：2024-12-19 01:14:58 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateAICall](https://cloud.tencent.com/document/api/679/111211) + + * 新增入参：NotifyMaxCount + + + + +## 云数据库 MySQL(cdb) 版本：2017-03-20 + +### 第 179 次发布 + +发布时间：2024-12-19 01:15:25 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [ModifyProtectMode](https://cloud.tencent.com/document/api/236/113922) + + + +## 混沌演练平台(cfg) 版本：2021-08-20 + +### 第 25 次发布 + +发布时间：2024-12-19 01:18:07 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [ObjectType](https://cloud.tencent.com/document/api/1500/71784#ObjectType) + + * 新增成员：ArchLayer + +* [TemplateGroupAction](https://cloud.tencent.com/document/api/1500/71784#TemplateGroupAction) + + * 新增成员：FailurePerformance + + + + +## 云应用(cloudapp) 版本：2022-05-30 + +### 第 2 次发布 + +发布时间：2024-12-19 01:20:46 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [License](https://cloud.tencent.com/document/api/1689/108875#License) + + * 新增成员：LicenseType + + + + +## TDSQL-C MySQL 版(cynosdb) 版本：2019-01-07 + +### 第 119 次发布 + +发布时间：2024-12-19 01:26:31 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [DescribeClusterDatabaseTables](https://cloud.tencent.com/document/api/1003/113981) + + + +## 腾讯电子签企业版(ess) 版本：2020-11-11 + +### 第 199 次发布 + +发布时间：2024-12-19 01:34:16 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [DescribeOrganizationVerifyStatus](https://cloud.tencent.com/document/api/1323/113923) + + + +## 云数据库 MongoDB(mongodb) 版本：2019-07-25 + +### 第 46 次发布 + +发布时间：2024-12-19 01:47:13 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [CurrentOp](https://cloud.tencent.com/document/api/240/38576#CurrentOp) + + * 新增成员：ExecNode + + + + +## 云数据库 MongoDB(mongodb) 版本：2018-04-08 + +### 第 7 次发布 + +发布时间：2024-12-19 01:47:07 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateDBInstance](https://cloud.tencent.com/document/api/240/31810) + + * 新增入参：InstanceType + + + + +## 私有网络(vpc) 版本：2017-03-12 + +### 第 234 次发布 + +发布时间：2024-12-19 02:11:29 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateVpnGateway](https://cloud.tencent.com/document/api/215/17521) + + * 新增入参：BgpAsn + + +修改数据结构： + +* [VpnGateway](https://cloud.tencent.com/document/api/215/15824#VpnGateway) + + * 新增成员：BgpAsn + + + + +## 数据开发治理平台 WeData(wedata) 版本：2021-08-20 + +### 第 117 次发布 + +发布时间：2024-12-19 02:14:02 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [BatchStopOpsTasks](https://cloud.tencent.com/document/api/1267/95257) + + * 新增入参：AsyncMode + +* [BatchStopWorkflowsByIds](https://cloud.tencent.com/document/api/1267/95232) + + * 新增入参：AsyncMode + +* [CreateCustomFunction](https://cloud.tencent.com/document/api/1267/81354) + + * 新增入参：FunctionResourceFileType + +* [CreateHiveTableByDDL](https://cloud.tencent.com/document/api/1267/82524) + + * 新增入参：Async + + * 新增出参：TaskId + +* [CreateOfflineTask](https://cloud.tencent.com/document/api/1267/82520) + + * 新增入参：TaskImportInfo + + * 新增出参：ArrangeSpaceTaskId + +* [DescribeDsFolderTree](https://cloud.tencent.com/document/api/1267/100212) + + * 新增入参：NewFolderTreeMode, TaskNodeId + +* [DescribeDsParentFolderTree](https://cloud.tencent.com/document/api/1267/100211) + + * 新增入参：NewFolderTreeMode + +* [DescribeOperateOpsTasks](https://cloud.tencent.com/document/api/1267/95254) + + * 新增入参：ProjectIds + +* [DescribeOpsMakePlanTasks](https://cloud.tencent.com/document/api/1267/95202) + + * 新增入参：StateList + +* [DescribeOpsMakePlans](https://cloud.tencent.com/document/api/1267/95201) + + * 新增入参：StateList, Keyword + +* [DescribeOpsWorkflows](https://cloud.tencent.com/document/api/1267/95200) + + * 新增入参：ProjectIds + +* [DescribeSchedulerInstanceStatus](https://cloud.tencent.com/document/api/1267/95198) + + * 新增入参：ProjectIds + +* [DescribeSchedulerRunTimeInstanceCntByStatus](https://cloud.tencent.com/document/api/1267/95197) + + * 新增入参：ProjectIds + +* [DescribeSchedulerTaskCntByStatus](https://cloud.tencent.com/document/api/1267/95196) + + * 新增入参：ProjectIds, ResourceGroupIds + +* [DescribeStatisticInstanceStatusTrendOps](https://cloud.tencent.com/document/api/1267/95193) + + * 新增入参：ProjectIds, TimePoint + +* [DescribeTaskByCycle](https://cloud.tencent.com/document/api/1267/95192) + + * 新增入参：ProjectIds, ResourceGroupIds, TaskTypeIdList + +* [DescribeTaskByStatusReport](https://cloud.tencent.com/document/api/1267/95190) + + * 新增入参：ProjectIds + +* [FreezeTasksByWorkflowIds](https://cloud.tencent.com/document/api/1267/95179) + + * 新增入参：AsyncMode + +* [KillOpsMakePlanInstances](https://cloud.tencent.com/document/api/1267/95178) + + * 新增入参：AsyncMode, PlanName + +* [KillScheduleInstances](https://cloud.tencent.com/document/api/1267/95177) + + * 新增入参：AsyncMode + +* [RunForceSucScheduleInstances](https://cloud.tencent.com/document/api/1267/100208) + + * 新增入参：AsyncMode + +* [RunRerunScheduleInstances](https://cloud.tencent.com/document/api/1267/100207) + + * 新增入参：AsyncMode + + +新增数据结构： + +* [TaskImportInfo](https://cloud.tencent.com/document/api/1267/76336#TaskImportInfo) + +修改数据结构： + +* [BatchOperateResultOpsDto](https://cloud.tencent.com/document/api/1267/76336#BatchOperateResultOpsDto) + + * 新增成员：AsyncActionId + + * **修改成员**：Result, ErrorId, ErrorDesc + +* [BatchOperationOpsDto](https://cloud.tencent.com/document/api/1267/76336#BatchOperationOpsDto) + + * 新增成员：AsyncActionId + +* [IntegrationTaskInfo](https://cloud.tencent.com/document/api/1267/76336#IntegrationTaskInfo) + + * 新增成员：TaskImportInfo, BusinessLatency, CurrentSyncPosition + +* [MakePlanOpsDto](https://cloud.tencent.com/document/api/1267/76336#MakePlanOpsDto) + + * 新增成员：SameSelfWorkflowDependType, SelfWorkflowDependency + + * **修改成员**：PlanId, MakeName, ProjectId, CheckParent, SameSelfDependType, ParallelNum, SameCycle, SourceTaskCycle, TargetTaskCycle, TargetTaskAction, MapParamList, CreatorId, Creator, CreateTime, TaskIdList, MakeDatetimeList, Remark, SchedulerResourceGroup, SchedulerResourceGroupName, IntegrationResourceGroup, IntegrationResourceGroupName, TaskCount, CompletePercent, SuccessPercent, CheckParentType + +* [OperationOpsDto](https://cloud.tencent.com/document/api/1267/76336#OperationOpsDto) + + * 新增成员：AsyncActionId + + * **修改成员**：Result, ResultMsg, ErrorId, ErrorDesc + +* [RuntimeInstanceCntTop](https://cloud.tencent.com/document/api/1267/76336#RuntimeInstanceCntTop) + + * 新增成员：ProjectId, ProjectName + +* [ScreenInstanceInfo](https://cloud.tencent.com/document/api/1267/76336#ScreenInstanceInfo) + + * 新增成员：SkipRunningNum + +* [ScreenTaskInfo](https://cloud.tencent.com/document/api/1267/76336#ScreenTaskInfo) + + * 新增成员：InvalidNum + + + + # Release 3.0.1236.1 ## 腾讯电子签（基础版）(essbasic) 版本：2021-05-26 diff --git a/SERVICE_CHANGELOG.md b/SERVICE_CHANGELOG.md index f7acb20548..466115fb9a 100644 --- a/SERVICE_CHANGELOG.md +++ b/SERVICE_CHANGELOG.md @@ -1,10 +1,10 @@ # 本版本更新包含以下内容： -## 腾讯电子签（基础版）(essbasic) 版本：2021-05-26 +## 云联络中心(ccc) 版本：2020-02-10 -### 第 199 次发布 +### 第 83 次发布 -发布时间：2024-12-17 14:33:46 +发布时间：2024-12-19 01:14:58 本次发布包含了以下内容： @@ -12,43 +12,76 @@ 修改接口： -* [ChannelCreateFlowByFiles](https://cloud.tencent.com/document/api/1420/73068) +* [CreateAICall](https://cloud.tencent.com/document/api/679/111211) - * 新增出参：PreviewUrl + * 新增入参：NotifyMaxCount -## 腾讯电子签（基础版）(essbasic) 版本：2020-12-22 +## 云数据库 MySQL(cdb) 版本：2017-03-20 +### 第 179 次发布 +发布时间：2024-12-19 01:15:25 -## 物联网开发平台(iotexplorer) 版本：2019-04-23 +本次发布包含了以下内容： -### 第 88 次发布 +改善已有的文档。 -发布时间：2024-12-18 16:59:09 +新增接口： + +* [ModifyProtectMode](https://cloud.tencent.com/document/api/236/113922) + + + +## 混沌演练平台(cfg) 版本：2021-08-20 + +### 第 25 次发布 + +发布时间：2024-12-19 01:18:07 本次发布包含了以下内容： 改善已有的文档。 -新增接口： +修改数据结构： -* [CreateCloudStorageAIServiceTask](https://cloud.tencent.com/document/api/1081/113973) +* [ObjectType](https://cloud.tencent.com/document/api/1500/71784#ObjectType) -**预下线接口**： + * 新增成员：ArchLayer -* PublishBroadcastMessage -* PublishRRPCMessage +* [TemplateGroupAction](https://cloud.tencent.com/document/api/1500/71784#TemplateGroupAction) + * 新增成员：FailurePerformance -## 声音复刻(vrs) 版本：2020-08-24 -### 第 9 次发布 -发布时间：2024-12-18 10:53:30 +## 云应用(cloudapp) 版本：2022-05-30 + +### 第 2 次发布 + +发布时间：2024-12-19 01:20:46 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [License](https://cloud.tencent.com/document/api/1689/108875#License) + + * 新增成员：LicenseType + + + + +## TDSQL-C MySQL 版(cynosdb) 版本：2019-01-07 + +### 第 119 次发布 + +发布时间：2024-12-19 01:26:31 本次发布包含了以下内容： @@ -56,13 +89,238 @@ 新增接口： -* [GetVRSVoiceTypeInfo](https://cloud.tencent.com/document/api/1283/112796) +* [DescribeClusterDatabaseTables](https://cloud.tencent.com/document/api/1003/113981) + + + +## 腾讯电子签企业版(ess) 版本：2020-11-11 + +### 第 199 次发布 + +发布时间：2024-12-19 01:34:16 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [DescribeOrganizationVerifyStatus](https://cloud.tencent.com/document/api/1323/113923) + + + +## 云数据库 MongoDB(mongodb) 版本：2019-07-25 + +### 第 46 次发布 + +发布时间：2024-12-19 01:47:13 + +本次发布包含了以下内容： + +改善已有的文档。 修改数据结构： -* [Words](https://cloud.tencent.com/document/api/1283/90065#Words) +* [CurrentOp](https://cloud.tencent.com/document/api/240/38576#CurrentOp) + + * 新增成员：ExecNode - * **修改成员**：PronAccuracy, PronFluency, Tag, Word + + + +## 云数据库 MongoDB(mongodb) 版本：2018-04-08 + +### 第 7 次发布 + +发布时间：2024-12-19 01:47:07 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateDBInstance](https://cloud.tencent.com/document/api/240/31810) + + * 新增入参：InstanceType + + + + +## 私有网络(vpc) 版本：2017-03-12 + +### 第 234 次发布 + +发布时间：2024-12-19 02:11:29 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateVpnGateway](https://cloud.tencent.com/document/api/215/17521) + + * 新增入参：BgpAsn + + +修改数据结构： + +* [VpnGateway](https://cloud.tencent.com/document/api/215/15824#VpnGateway) + + * 新增成员：BgpAsn + + + + +## 数据开发治理平台 WeData(wedata) 版本：2021-08-20 + +### 第 117 次发布 + +发布时间：2024-12-19 02:14:02 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [BatchStopOpsTasks](https://cloud.tencent.com/document/api/1267/95257) + + * 新增入参：AsyncMode + +* [BatchStopWorkflowsByIds](https://cloud.tencent.com/document/api/1267/95232) + + * 新增入参：AsyncMode + +* [CreateCustomFunction](https://cloud.tencent.com/document/api/1267/81354) + + * 新增入参：FunctionResourceFileType + +* [CreateHiveTableByDDL](https://cloud.tencent.com/document/api/1267/82524) + + * 新增入参：Async + + * 新增出参：TaskId + +* [CreateOfflineTask](https://cloud.tencent.com/document/api/1267/82520) + + * 新增入参：TaskImportInfo + + * 新增出参：ArrangeSpaceTaskId + +* [DescribeDsFolderTree](https://cloud.tencent.com/document/api/1267/100212) + + * 新增入参：NewFolderTreeMode, TaskNodeId + +* [DescribeDsParentFolderTree](https://cloud.tencent.com/document/api/1267/100211) + + * 新增入参：NewFolderTreeMode + +* [DescribeOperateOpsTasks](https://cloud.tencent.com/document/api/1267/95254) + + * 新增入参：ProjectIds + +* [DescribeOpsMakePlanTasks](https://cloud.tencent.com/document/api/1267/95202) + + * 新增入参：StateList + +* [DescribeOpsMakePlans](https://cloud.tencent.com/document/api/1267/95201) + + * 新增入参：StateList, Keyword + +* [DescribeOpsWorkflows](https://cloud.tencent.com/document/api/1267/95200) + + * 新增入参：ProjectIds + +* [DescribeSchedulerInstanceStatus](https://cloud.tencent.com/document/api/1267/95198) + + * 新增入参：ProjectIds + +* [DescribeSchedulerRunTimeInstanceCntByStatus](https://cloud.tencent.com/document/api/1267/95197) + + * 新增入参：ProjectIds + +* [DescribeSchedulerTaskCntByStatus](https://cloud.tencent.com/document/api/1267/95196) + + * 新增入参：ProjectIds, ResourceGroupIds + +* [DescribeStatisticInstanceStatusTrendOps](https://cloud.tencent.com/document/api/1267/95193) + + * 新增入参：ProjectIds, TimePoint + +* [DescribeTaskByCycle](https://cloud.tencent.com/document/api/1267/95192) + + * 新增入参：ProjectIds, ResourceGroupIds, TaskTypeIdList + +* [DescribeTaskByStatusReport](https://cloud.tencent.com/document/api/1267/95190) + + * 新增入参：ProjectIds + +* [FreezeTasksByWorkflowIds](https://cloud.tencent.com/document/api/1267/95179) + + * 新增入参：AsyncMode + +* [KillOpsMakePlanInstances](https://cloud.tencent.com/document/api/1267/95178) + + * 新增入参：AsyncMode, PlanName + +* [KillScheduleInstances](https://cloud.tencent.com/document/api/1267/95177) + + * 新增入参：AsyncMode + +* [RunForceSucScheduleInstances](https://cloud.tencent.com/document/api/1267/100208) + + * 新增入参：AsyncMode + +* [RunRerunScheduleInstances](https://cloud.tencent.com/document/api/1267/100207) + + * 新增入参：AsyncMode + + +新增数据结构： + +* [TaskImportInfo](https://cloud.tencent.com/document/api/1267/76336#TaskImportInfo) + +修改数据结构： + +* [BatchOperateResultOpsDto](https://cloud.tencent.com/document/api/1267/76336#BatchOperateResultOpsDto) + + * 新增成员：AsyncActionId + + * **修改成员**：Result, ErrorId, ErrorDesc + +* [BatchOperationOpsDto](https://cloud.tencent.com/document/api/1267/76336#BatchOperationOpsDto) + + * 新增成员：AsyncActionId + +* [IntegrationTaskInfo](https://cloud.tencent.com/document/api/1267/76336#IntegrationTaskInfo) + + * 新增成员：TaskImportInfo, BusinessLatency, CurrentSyncPosition + +* [MakePlanOpsDto](https://cloud.tencent.com/document/api/1267/76336#MakePlanOpsDto) + + * 新增成员：SameSelfWorkflowDependType, SelfWorkflowDependency + + * **修改成员**：PlanId, MakeName, ProjectId, CheckParent, SameSelfDependType, ParallelNum, SameCycle, SourceTaskCycle, TargetTaskCycle, TargetTaskAction, MapParamList, CreatorId, Creator, CreateTime, TaskIdList, MakeDatetimeList, Remark, SchedulerResourceGroup, SchedulerResourceGroupName, IntegrationResourceGroup, IntegrationResourceGroupName, TaskCount, CompletePercent, SuccessPercent, CheckParentType + +* [OperationOpsDto](https://cloud.tencent.com/document/api/1267/76336#OperationOpsDto) + + * 新增成员：AsyncActionId + + * **修改成员**：Result, ResultMsg, ErrorId, ErrorDesc + +* [RuntimeInstanceCntTop](https://cloud.tencent.com/document/api/1267/76336#RuntimeInstanceCntTop) + + * 新增成员：ProjectId, ProjectName + +* [ScreenInstanceInfo](https://cloud.tencent.com/document/api/1267/76336#ScreenInstanceInfo) + + * 新增成员：SkipRunningNum + +* [ScreenTaskInfo](https://cloud.tencent.com/document/api/1267/76336#ScreenTaskInfo) + + * 新增成员：InvalidNum @@ -9899,6 +10157,19 @@ ## 费用中心(billing) 版本：2018-07-09 +### 第 68 次发布 + +发布时间：2024-12-18 17:13:22 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [DescribeAccountBalance](https://cloud.tencent.com/document/api/555/20253) + + ### 第 67 次发布 发布时间：2024-12-02 01:08:36 @@ -16539,6 +16810,21 @@ ## 云联络中心(ccc) 版本：2020-02-10 +### 第 83 次发布 + +发布时间：2024-12-19 01:14:58 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateAICall](https://cloud.tencent.com/document/api/679/111211) + + * 新增入参：NotifyMaxCount + + ### 第 82 次发布 发布时间：2024-11-19 01:13:32 @@ -18002,6 +18288,18 @@ ## 云数据库 MySQL(cdb) 版本：2017-03-20 +### 第 179 次发布 + +发布时间：2024-12-19 01:15:25 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [[ModifyProtectMode](https://cloud.tencent.com/document/api/236/113922)](https://cloud.tencent.com/document/api/#/#) + ### 第 178 次发布 发布时间：2024-12-06 01:11:07 @@ -25930,6 +26228,25 @@ ## 混沌演练平台(cfg) 版本：2021-08-20 +### 第 25 次发布 + +发布时间：2024-12-19 01:18:07 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [ObjectType](https://cloud.tencent.com/document/api/1500/71784#ObjectType) + + * 新增成员：ArchLayer + +* [TemplateGroupAction](https://cloud.tencent.com/document/api/1500/71784#TemplateGroupAction) + + * 新增成员：FailurePerformance + + ### 第 24 次发布 发布时间：2024-12-11 01:18:19 @@ -34232,6 +34549,21 @@ ## 云应用(cloudapp) 版本：2022-05-30 +### 第 2 次发布 + +发布时间：2024-12-19 01:20:46 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [License](https://cloud.tencent.com/document/api/1689/108875#License) + + * 新增成员：LicenseType + + ### 第 1 次发布 发布时间：2024-07-17 10:02:42 @@ -49628,6 +49960,18 @@ ## TDSQL-C MySQL 版(cynosdb) 版本：2019-01-07 +### 第 119 次发布 + +发布时间：2024-12-19 01:26:31 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [[DescribeClusterDatabaseTables](https://cloud.tencent.com/document/api/1003/113981)](https://cloud.tencent.com/document/api/#/#) + ### 第 118 次发布 发布时间：2024-12-10 01:26:10 @@ -69071,6 +69415,18 @@ ## 腾讯电子签企业版(ess) 版本：2020-11-11 +### 第 199 次发布 + +发布时间：2024-12-19 01:34:16 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [[DescribeOrganizationVerifyStatus](https://cloud.tencent.com/document/api/1323/113923)](https://cloud.tencent.com/document/api/#/#) + ### 第 198 次发布 发布时间：2024-12-05 01:14:35 @@ -85999,7 +86355,7 @@ 新增接口： -* [[CreateCloudStorageAIServiceTask](https://cloud.tencent.com/document/api/1081/113973)](https://cloud.tencent.com/document/api/#/#) +* [CreateCloudStorageAIServiceTask](https://cloud.tencent.com/document/api/1081/113973) **预下线接口**： @@ -100029,6 +100385,21 @@ ## 云数据库 MongoDB(mongodb) 版本：2018-04-08 +### 第 7 次发布 + +发布时间：2024-12-19 01:47:07 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateDBInstance](https://cloud.tencent.com/document/api/240/31810) + + * 新增入参：InstanceType + + ### 第 6 次发布 发布时间：2024-03-11 15:09:36 @@ -100143,6 +100514,21 @@ ## 云数据库 MongoDB(mongodb) 版本：2019-07-25 +### 第 46 次发布 + +发布时间：2024-12-19 01:47:13 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [CurrentOp](https://cloud.tencent.com/document/api/240/38576#CurrentOp) + + * 新增成员：ExecNode + + ### 第 45 次发布 发布时间：2024-08-26 02:06:18 @@ -168126,6 +168512,28 @@ ## 私有网络(vpc) 版本：2017-03-12 +### 第 234 次发布 + +发布时间：2024-12-19 02:11:29 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [CreateVpnGateway](https://cloud.tencent.com/document/api/215/17521) + + * 新增入参：BgpAsn + + +修改数据结构： + +* [VpnGateway](https://cloud.tencent.com/document/api/215/15824#VpnGateway) + + * 新增成员：BgpAsn + + ### 第 233 次发布 发布时间：2024-12-16 02:10:23 @@ -173337,7 +173745,7 @@ 新增接口： -* [[GetVRSVoiceTypeInfo](https://cloud.tencent.com/document/api/1283/112796)](https://cloud.tencent.com/document/api/#/#) +* [GetVRSVoiceTypeInfo](https://cloud.tencent.com/document/api/1283/112796) 修改数据结构： @@ -176344,6 +176752,154 @@ ## 数据开发治理平台 WeData(wedata) 版本：2021-08-20 +### 第 117 次发布 + +发布时间：2024-12-19 02:14:02 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改接口： + +* [BatchStopOpsTasks](https://cloud.tencent.com/document/api/1267/95257) + + * 新增入参：AsyncMode + +* [BatchStopWorkflowsByIds](https://cloud.tencent.com/document/api/1267/95232) + + * 新增入参：AsyncMode + +* [CreateCustomFunction](https://cloud.tencent.com/document/api/1267/81354) + + * 新增入参：FunctionResourceFileType + +* [CreateHiveTableByDDL](https://cloud.tencent.com/document/api/1267/82524) + + * 新增入参：Async + + * 新增出参：TaskId + +* [CreateOfflineTask](https://cloud.tencent.com/document/api/1267/82520) + + * 新增入参：TaskImportInfo + + * 新增出参：ArrangeSpaceTaskId + +* [DescribeDsFolderTree](https://cloud.tencent.com/document/api/1267/100212) + + * 新增入参：NewFolderTreeMode, TaskNodeId + +* [DescribeDsParentFolderTree](https://cloud.tencent.com/document/api/1267/100211) + + * 新增入参：NewFolderTreeMode + +* [DescribeOperateOpsTasks](https://cloud.tencent.com/document/api/1267/95254) + + * 新增入参：ProjectIds + +* [DescribeOpsMakePlanTasks](https://cloud.tencent.com/document/api/1267/95202) + + * 新增入参：StateList + +* [DescribeOpsMakePlans](https://cloud.tencent.com/document/api/1267/95201) + + * 新增入参：StateList, Keyword + +* [DescribeOpsWorkflows](https://cloud.tencent.com/document/api/1267/95200) + + * 新增入参：ProjectIds + +* [DescribeSchedulerInstanceStatus](https://cloud.tencent.com/document/api/1267/95198) + + * 新增入参：ProjectIds + +* [DescribeSchedulerRunTimeInstanceCntByStatus](https://cloud.tencent.com/document/api/1267/95197) + + * 新增入参：ProjectIds + +* [DescribeSchedulerTaskCntByStatus](https://cloud.tencent.com/document/api/1267/95196) + + * 新增入参：ProjectIds, ResourceGroupIds + +* [DescribeStatisticInstanceStatusTrendOps](https://cloud.tencent.com/document/api/1267/95193) + + * 新增入参：ProjectIds, TimePoint + +* [DescribeTaskByCycle](https://cloud.tencent.com/document/api/1267/95192) + + * 新增入参：ProjectIds, ResourceGroupIds, TaskTypeIdList + +* [DescribeTaskByStatusReport](https://cloud.tencent.com/document/api/1267/95190) + + * 新增入参：ProjectIds + +* [FreezeTasksByWorkflowIds](https://cloud.tencent.com/document/api/1267/95179) + + * 新增入参：AsyncMode + +* [KillOpsMakePlanInstances](https://cloud.tencent.com/document/api/1267/95178) + + * 新增入参：AsyncMode, PlanName + +* [KillScheduleInstances](https://cloud.tencent.com/document/api/1267/95177) + + * 新增入参：AsyncMode + +* [RunForceSucScheduleInstances](https://cloud.tencent.com/document/api/1267/100208) + + * 新增入参：AsyncMode + +* [RunRerunScheduleInstances](https://cloud.tencent.com/document/api/1267/100207) + + * 新增入参：AsyncMode + + +新增数据结构： + +* [[TaskImportInfo](https://cloud.tencent.com/document/api/1267/76336#TaskImportInfo)](https://cloud.tencent.com/document/api/1267/76336#[TaskImportInfo](https://cloud.tencent.com/document/api/1267/76336#TaskImportInfo)) + +修改数据结构： + +* [BatchOperateResultOpsDto](https://cloud.tencent.com/document/api/1267/76336#BatchOperateResultOpsDto) + + * 新增成员：AsyncActionId + + * **修改成员**：Result, ErrorId, ErrorDesc + +* [BatchOperationOpsDto](https://cloud.tencent.com/document/api/1267/76336#BatchOperationOpsDto) + + * 新增成员：AsyncActionId + +* [IntegrationTaskInfo](https://cloud.tencent.com/document/api/1267/76336#IntegrationTaskInfo) + + * 新增成员：TaskImportInfo, BusinessLatency, CurrentSyncPosition + +* [MakePlanOpsDto](https://cloud.tencent.com/document/api/1267/76336#MakePlanOpsDto) + + * 新增成员：SameSelfWorkflowDependType, SelfWorkflowDependency + + * **修改成员**：PlanId, MakeName, ProjectId, CheckParent, SameSelfDependType, ParallelNum, SameCycle, SourceTaskCycle, TargetTaskCycle, TargetTaskAction, MapParamList, CreatorId, Creator, CreateTime, TaskIdList, MakeDatetimeList, Remark, SchedulerResourceGroup, SchedulerResourceGroupName, IntegrationResourceGroup, IntegrationResourceGroupName, TaskCount, CompletePercent, SuccessPercent, CheckParentType + +* [OperationOpsDto](https://cloud.tencent.com/document/api/1267/76336#OperationOpsDto) + + * 新增成员：AsyncActionId + + * **修改成员**：Result, ResultMsg, ErrorId, ErrorDesc + +* [RuntimeInstanceCntTop](https://cloud.tencent.com/document/api/1267/76336#RuntimeInstanceCntTop) + + * 新增成员：ProjectId, ProjectName + +* [ScreenInstanceInfo](https://cloud.tencent.com/document/api/1267/76336#ScreenInstanceInfo) + + * 新增成员：SkipRunningNum + +* [ScreenTaskInfo](https://cloud.tencent.com/document/api/1267/76336#ScreenTaskInfo) + + * 新增成员：InvalidNum + + ### 第 116 次发布 发布时间：2024-12-17 02:08:35 diff --git a/products.md b/products.md index 3696556cda..0a1b733397 100644 --- a/products.md +++ b/products.md @@ -15,16 +15,16 @@ | ape | [正版图库直通车](https://cloud.tencent.com/document/product/1181) | 2022-04-04 06:05:40 | | api | [云 API](https://cloud.tencent.com/document/product/1278) | 2023-01-05 01:02:52 | | apigateway | [API 网关](https://cloud.tencent.com/document/product/628) | 2024-11-28 22:52:11 | -| apm | [应用性能监控](https://cloud.tencent.com/document/product/1463) | 2024-11-15 01:09:10 | +| apm | [应用性能监控](https://cloud.tencent.com/document/product/1463) | 2024-12-19 01:10:07 | | as | [弹性伸缩](https://cloud.tencent.com/document/product/377) | 2024-12-02 01:07:50 | | asr | [语音识别](https://cloud.tencent.com/document/product/1093) | 2024-11-21 01:05:01 | | asw | [应用与服务编排工作流](https://cloud.tencent.com/document/product/1272) | 2023-05-18 01:04:02 | -| ba | [ICP备案](https://cloud.tencent.com/document/product/243) | 2024-04-22 01:08:02 | +| ba | [ICP备案](https://cloud.tencent.com/document/product/243) | 2024-12-19 01:10:53 | | batch | [批量计算](https://cloud.tencent.com/document/product/599) | 2024-12-12 01:10:51 | | bda | [人体分析](https://cloud.tencent.com/document/product/1208) | 2024-11-14 01:10:31 | | bh | [运维安全中心（堡垒机）](https://cloud.tencent.com/document/product/1025) | 2024-11-21 01:05:46 | | bi | [商业智能分析 BI](https://cloud.tencent.com/document/product/590) | 2024-11-29 01:09:08 | -| billing | [费用中心](https://cloud.tencent.com/document/product/555) | 2024-12-03 01:09:46 | +| billing | [费用中心](https://cloud.tencent.com/document/product/555) | 2024-12-18 17:13:22 | | bizlive | [商业直播](https://cloud.tencent.com/document/product) | 2020-03-10 01:08:07 | | bm | [黑石物理服务器CPM](https://cloud.tencent.com/document/product/386) | 2024-03-20 01:08:40 | | bma | [品牌经营管家](https://cloud.tencent.com/document/product/1296) | 2024-10-18 01:04:14 | @@ -36,13 +36,13 @@ | bsca | [软件成分分析](https://cloud.tencent.com/document/product/1483) | 2024-11-27 01:09:19 | | btoe | [区块链可信取证](https://cloud.tencent.com/document/product/1259) | 2024-11-06 15:27:32 | | ca | [腾讯云CA](https://cloud.tencent.com/document/product/1691) | 2024-11-05 01:13:21 | -| cam | [访问管理](https://cloud.tencent.com/document/product/598) | 2024-12-11 01:14:06 | +| cam | [访问管理](https://cloud.tencent.com/document/product/598) | 2024-12-19 01:13:54 | | captcha | [验证码](https://cloud.tencent.com/document/product/1110) | 2024-10-23 01:09:56 | | car | [应用云渲染](https://cloud.tencent.com/document/product/1547) | 2024-06-19 01:14:59 | | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2024-11-15 01:13:36 | | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2024-12-02 01:09:38 | -| ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2024-11-21 01:09:52 | -| cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2024-12-17 01:10:25 | +| ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2024-12-19 01:14:58 | +| cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2024-12-19 01:15:25 | | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2024-11-15 01:15:46 | | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2024-12-09 11:17:22 | | cds | [T-Sec-数据安全审计（DSA）](https://cloud.tencent.com/document/product/856) | 2024-11-08 01:17:02 | @@ -50,7 +50,7 @@ | cdwdoris | [腾讯云数据仓库 TCHouse-D](https://cloud.tencent.com/document/product/1387) | 2024-12-03 01:12:05 | | cdwpg | [云数据仓库 PostgreSQL](https://cloud.tencent.com/document/product/878) | 2024-03-28 01:10:53 | | cdz | [专属可用区](https://cloud.tencent.com/document/product/1629) | 2024-11-14 01:17:55 | -| cfg | [混沌演练平台](https://cloud.tencent.com/document/product/1500) | 2024-12-11 01:18:19 | +| cfg | [混沌演练平台](https://cloud.tencent.com/document/product/1500) | 2024-12-19 01:18:07 | | cfs | [文件存储](https://cloud.tencent.com/document/product/582) | 2024-12-05 01:07:44 | | cfw | [云防火墙](https://cloud.tencent.com/document/product/1132) | 2024-12-09 11:19:12 | | chdfs | [云 HDFS](https://cloud.tencent.com/document/product/1105) | 2024-03-20 01:10:55 | @@ -60,8 +60,8 @@ | cis | [](https://cloud.tencent.com/document/product) | 2018-06-07 15:01:42 | | ckafka | [消息队列 CKafka 版](https://cloud.tencent.com/document/product/597) | 2024-12-06 01:12:51 | | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2024-12-13 01:19:49 | -| cloudapp | [云应用](https://cloud.tencent.com/document/product/1689) | 2024-12-04 01:13:45 | -| cloudaudit | [操作审计](https://cloud.tencent.com/document/product/629) | 2024-12-11 01:20:59 | +| cloudapp | [云应用](https://cloud.tencent.com/document/product/1689) | 2024-12-19 01:20:46 | +| cloudaudit | [操作审计](https://cloud.tencent.com/document/product/629) | 2024-12-19 01:20:49 | | cloudhsm | [云加密机](https://cloud.tencent.com/document/product/639) | 2024-11-28 10:52:49 | | cloudstudio | [Cloud Studio（云端 IDE）](https://cloud.tencent.com/document/product/1039) | 2024-11-28 01:12:23 | | cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2024-12-17 01:16:04 | @@ -73,10 +73,10 @@ | cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2023-09-21 02:09:54 | | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2024-11-04 21:21:11 | | csxg | [5G入云服务](https://cloud.tencent.com/document/product/1687) | 2024-03-20 01:12:25 | -| cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2024-12-12 01:22:42 | +| cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2024-12-19 01:22:59 | | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-12-17 01:18:39 | | cws | [漏洞扫描服务](https://cloud.tencent.com/document/product) | 2019-11-22 12:16:15 | -| cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2024-12-10 01:26:10 | +| cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2024-12-19 01:26:31 | | dasb | [运维安全中心（堡垒机）](https://cloud.tencent.com/document/product/1025) | 2024-11-19 01:26:13 | | dataintegration | [数据接入平台](https://cloud.tencent.com/document/product/1591) | 2022-07-26 15:32:15 | | dayu | [DDoS 高防包](https://cloud.tencent.com/document/product/1021) | 2023-05-18 01:20:11 | @@ -86,7 +86,7 @@ | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2024-11-28 01:15:15 | | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2024-11-11 01:28:04 | | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2024-11-28 01:15:53 | -| domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2024-10-25 01:35:02 | +| domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2024-12-19 01:30:24 | | drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2024-11-06 01:31:02 | | ds | [文档服务](https://cloud.tencent.com/document/product/869) | 2024-03-20 01:15:13 | | dsgc | [数据安全治理中心](https://cloud.tencent.com/document/product/1087) | 2024-10-14 01:17:08 | @@ -100,8 +100,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-12-10 01:32:35 | | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2024-12-11 01:33:45 | -| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-12-16 01:33:51 | -| essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2024-12-17 14:33:46 | +| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-12-19 01:34:16 | +| essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2024-12-19 01:35:05 | | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2024-12-11 01:36:12 | | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-12-17 01:30:37 | | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2024-11-15 01:37:24 | @@ -112,12 +112,12 @@ | gpm | [游戏玩家匹配](https://cloud.tencent.com/document/product/1294) | 2022-07-11 06:12:36 | | gs | [云游戏](https://cloud.tencent.com/document/product/1162) | 2024-05-28 01:43:15 | | gse | [游戏服务器伸缩](https://cloud.tencent.com/document/product/1165) | 2022-07-11 06:12:44 | -| gwlb | [网关负载均衡](https://cloud.tencent.com/document/product/1782) | 2024-11-29 01:20:51 | +| gwlb | [网关负载均衡](https://cloud.tencent.com/document/product/1782) | 2024-12-19 01:37:26 | | habo | [](https://cloud.tencent.com/document/product) | 2019-05-09 19:37:22 | | hai | [高性能应用服务](https://cloud.tencent.com/document/product/1721) | 2024-12-06 01:20:03 | | hasim | [高可用物联网卡](https://cloud.tencent.com/document/product/1482) | 2023-05-18 01:29:47 | | hcm | [数学作业批改](https://cloud.tencent.com/document/product/1004) | 2024-05-09 01:16:27 | -| hunyuan | [腾讯混元大模型](https://cloud.tencent.com/document/product/1729) | 2024-12-17 01:32:18 | +| hunyuan | [腾讯混元大模型](https://cloud.tencent.com/document/product/1729) | 2024-12-19 01:37:44 | | iai | [人脸识别](https://cloud.tencent.com/document/product/867) | 2024-11-26 01:18:52 | | iap | [身份识别平台](https://cloud.tencent.com/document/product/1787) | 2024-11-21 18:27:30 | | ic | [图片瘦身](https://cloud.tencent.com/document/product/636) | 2023-03-02 01:23:21 | @@ -139,9 +139,9 @@ | ivld | [媒体智能标签](https://cloud.tencent.com/document/product/1509) | 2024-12-16 01:41:44 | | keewidb | [云数据库 KeeWiDB](https://cloud.tencent.com/document/product/1520) | 2024-03-20 01:19:20 | | kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2024-11-07 01:44:48 | -| lcic | [实时互动-教育版](https://cloud.tencent.com/document/product/1639) | 2024-12-09 11:42:57 | +| lcic | [实时互动-教育版](https://cloud.tencent.com/document/product/1639) | 2024-12-19 01:43:20 | | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2024-12-16 01:42:53 | -| live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2024-12-17 01:38:57 | +| live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2024-12-19 01:44:22 | | lke | [大模型知识引擎](https://cloud.tencent.com/document/product/1759) | 2024-12-16 01:44:38 | | lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 | | lp | [登录保护](https://cloud.tencent.com/document/product/1190) | 2022-04-04 06:56:52 | @@ -152,10 +152,10 @@ | mgobe | [游戏联机对战引擎](https://cloud.tencent.com/document/product/1038) | 2022-07-08 06:11:32 | | mmps | [小程序安全](https://cloud.tencent.com/document/product/1223) | 2024-11-11 01:49:22 | | mna | [多网聚合加速](https://cloud.tencent.com/document/product/1385) | 2024-08-23 01:55:12 | -| mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2024-11-05 01:57:16 | +| mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2024-12-19 01:47:13 | | monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2024-12-13 01:46:19 | | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2024-12-11 01:48:29 | -| mqtt | [消息队列 MQTT 版](https://cloud.tencent.com/document/product/1778) | 2024-12-13 01:48:23 | +| mqtt | [消息队列 MQTT 版](https://cloud.tencent.com/document/product/1778) | 2024-12-19 01:49:38 | | mrs | [医疗报告结构化](https://cloud.tencent.com/document/product/1314) | 2024-12-12 01:48:36 | | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2024-11-14 01:54:52 | | msp | [迁移服务平台](https://cloud.tencent.com/document/product/659) | 2024-04-17 14:48:31 | @@ -163,14 +163,14 @@ | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2024-09-27 01:23:18 | | npp | [号码保护](https://cloud.tencent.com/document/product) | 2020-04-22 08:00:22 | | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2024-11-28 01:23:56 | -| ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2024-12-17 01:45:20 | +| ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2024-12-19 01:50:50 | | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2024-11-21 01:50:50 | | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2024-12-13 01:50:40 | | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2024-11-22 12:03:22 | | pds | [私域安全](https://cloud.tencent.com/document/product/1473) | 2023-05-18 01:44:14 | | postgres | [云数据库 PostgreSQL](https://cloud.tencent.com/document/product/409) | 2024-12-11 01:52:49 | | privatedns | [私有域解析 Private DNS](https://cloud.tencent.com/document/product/1338) | 2024-12-17 01:47:54 | -| pts | [云压测](https://cloud.tencent.com/document/product/1484) | 2024-12-06 01:26:37 | +| pts | [云压测](https://cloud.tencent.com/document/product/1484) | 2024-12-19 01:53:33 | | rce | [全栈式风控引擎](https://cloud.tencent.com/document/product/1343) | 2024-12-04 01:27:22 | | redis | [云数据库Redis](https://cloud.tencent.com/document/product/239) | 2024-12-13 01:53:25 | | region | [地域管理系统](https://cloud.tencent.com/document/product/1596) | 2024-10-25 02:05:36 | @@ -210,7 +210,7 @@ | tcr | [容器镜像服务](https://cloud.tencent.com/document/product/1141) | 2024-12-06 01:29:26 | | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2024-11-04 02:03:35 | | 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 | +| tdid | [分布式身份](https://cloud.tencent.com/document/product/1439) | 2024-12-19 02:00:31 | | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2024-12-12 01:59:27 | | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2024-11-14 02:08:25 | | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2024-11-05 02:16:13 | @@ -230,7 +230,7 @@ | tmt | [机器翻译](https://cloud.tencent.com/document/product/551) | 2024-12-05 01:26:59 | | tourism | [文旅客情大数据](https://cloud.tencent.com/document/product/1684) | 2024-03-20 01:28:59 | | trdp | [流量风险决策平台](https://cloud.tencent.com/document/product/1604) | 2023-05-18 02:01:19 | -| trocket | [消息队列 RocketMQ 版](https://cloud.tencent.com/document/product/1493) | 2024-12-17 02:00:21 | +| trocket | [消息队列 RocketMQ 版](https://cloud.tencent.com/document/product/1493) | 2024-12-19 02:05:48 | | trp | [T-Sec-安心平台(RP)](https://cloud.tencent.com/document/product/1458) | 2024-11-08 02:10:59 | | trro | [远程实时操控](https://cloud.tencent.com/document/product/1584) | 2024-11-14 02:13:50 | | trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2024-12-10 02:04:51 | @@ -247,12 +247,12 @@ | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2024-07-26 02:26:34 | | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2024-03-20 01:30:13 | | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2024-11-18 02:09:13 | -| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2024-12-16 02:10:23 | -| vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2024-12-18 10:53:30 | +| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2024-12-19 02:11:29 | +| vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2024-12-19 02:13:39 | | vtc | [视频转译](https://cloud.tencent.com/document/product/1769) | 2024-10-16 01:32:39 | | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2024-11-19 02:12:25 | | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2024-11-20 02:21:21 | -| wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2024-12-17 02:08:35 | +| wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2024-12-19 02:14:02 | | weilingwith | [微瓴同业开放平台](https://cloud.tencent.com/document/product/1693) | 2024-11-07 02:23:06 | | wss | [SSL证书管理服务](https://cloud.tencent.com/document/product) | 2020-04-01 08:53:44 | | yinsuda | [音速达直播音乐版权引擎](https://cloud.tencent.com/document/product/1592) | 2024-06-05 02:38:46 | diff --git a/pyproject.toml b/pyproject.toml index efac567d52..f914794576 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ exclude = ["tccli/examples"] [project] name = "tccli" -version = "3.0.1236.1" +version = "3.0.1237.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.1236", + "tencentcloud-sdk-python>=3.0.1237", ] [project.urls] diff --git a/tccli/__init__.py b/tccli/__init__.py index 428bd2272c..c284586f2f 100644 --- a/tccli/__init__.py +++ b/tccli/__init__.py @@ -1 +1 @@ -__version__ = '3.0.1236.1' +__version__ = '3.0.1237.1' diff --git a/tccli/examples/apm/v20210622/DescribeGeneralMetricData.md b/tccli/examples/apm/v20210622/DescribeGeneralMetricData.md index 183c30186b..fc4e0a77f4 100644 --- a/tccli/examples/apm/v20210622/DescribeGeneralMetricData.md +++ b/tccli/examples/apm/v20210622/DescribeGeneralMetricData.md @@ -1,91 +1,21 @@ -**Example 1: 查询1分钟聚合粒度的runtime_metric指标数据示例** +**Example 1: 查询1分钟聚合粒度的 service_metric 指标数据示例** -该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的service_gc_full_count（Full GC）的指标数据。 +该示例查询实例为 apm-059oXBfTL，按照 service.name（服务名）、span.kind（客户端/服务端视角）为维度过滤，以 service.name（服务名）、span.kind（客户端/服务端视角）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的 request_count（请求数量）、error_request_count（错误请求数量）、duration_avg（平均响应时间）、slow_request_count（慢请求数量）、duration_p50（耗时 p50）的指标数据。 Input: ``` tccli apm DescribeGeneralMetricData --cli-unfold-argument \ --Filters.0.Key service.name \ - --Filters.0.Value tapm-api-ap-beijing \ - --ViewName runtime_metric \ - --InstanceId apm-ylTJfTSbn \ - --Period 60 \ - --Metrics service_gc_full_count \ - --StartTime 1652666416 \ - --EndTime 1652667616 \ - --GroupBy service.name -``` - -Output: -``` -{ - "Response": { - "Records": [ - { - "Tags": [ - { - "Key": "service.name", - "Value": "java-order-service" - } - ], - "MetricName": "service_gc_full_count", - "MetricNameCN": "full GC", - "TimeSerial": [ - 1656428160, - 1656428220, - 1656428280, - 1656428340, - 1656428400, - 1656428460, - 1656428520, - 1656428580, - 1656428640, - 1656428700, - 1656428760, - 1656428820, - 1656428880 - ], - "DataSerial": [ - 0.016666666666666666, - 0, - 0.016666666666666666, - 0, - 0.016666666666666666, - 0.016666666666666666, - 0, - 0.016666666666666666, - 0, - 0.016666666666666666, - 0.016666666666666666, - 0, - 0.016666666666666666 - ] - } - ], - "RequestId": "test-test-test" - } -} -``` - -**Example 2: 查询1分钟聚合粒度的service_metric指标数据示例** - -该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）、span.kind（客户端/服务端视角）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）的指标数据。 - -Input: - -``` -tccli apm DescribeGeneralMetricData --cli-unfold-argument \ - --Filters.0.Key service.name \ - --Filters.0.Value tapm-api-ap-beijing \ + --Filters.0.Value ot-java-order-service \ --Filters.1.Key span.kind \ --Filters.1.Value client \ --ViewName service_metric \ - --InstanceId apm-ylTJfTSbn \ + --InstanceId apm-059oXBfTL \ --Period 60 \ - --Metrics service_request_count service_duration service_error_req_rate service_slow_call_count service_error_request_count \ - --StartTime 1652666416 \ - --EndTime 1652667616 \ + --Metrics request_count error_request_count duration_avg slow_request_count duration_p50 \ + --StartTime 1734415200 \ + --EndTime 1734418800 \ --GroupBy service.name span.kind ``` @@ -98,220 +28,690 @@ Output: "Tags": [ { "Key": "service.name", - "Value": "java-order-service" + "Value": "ot-java-order-service" }, { "Key": "span.kind", "Value": "client" } ], - "MetricName": "service_request_count", + "MetricName": "request_count", "MetricNameCN": "总请求数", "TimeSerial": [ - 1656428160, - 1656428220, - 1656428280, - 1656428340, - 1656428400, - 1656428460, - 1656428520, - 1656428580, - 1656428640, - 1656428700, - 1656428760, - 1656428820, - 1656428880 + 1734415200, + 1734415260, + 1734415320, + 1734415380, + 1734415440, + 1734415500, + 1734415560, + 1734415620, + 1734415680, + 1734415740, + 1734415800, + 1734415860, + 1734415920, + 1734415980, + 1734416040, + 1734416100, + 1734416160, + 1734416220, + 1734416280, + 1734416340, + 1734416400, + 1734416460, + 1734416520, + 1734416580, + 1734416640, + 1734416700, + 1734416760, + 1734416820, + 1734416880, + 1734416940, + 1734417000, + 1734417060, + 1734417120, + 1734417180, + 1734417240, + 1734417300, + 1734417360, + 1734417420, + 1734417480, + 1734417540, + 1734417600, + 1734417660, + 1734417720, + 1734417780, + 1734417840, + 1734417900, + 1734417960, + 1734418020, + 1734418080, + 1734418140, + 1734418200, + 1734418260, + 1734418320, + 1734418380, + 1734418440, + 1734418500, + 1734418560, + 1734418620, + 1734418680, + 1734418740 ], "DataSerial": [ - 10372, - 10578, - 10430, - 10486, - 10393, - 10509, - 10556, - 10443, - 10560, - 10491, - 10417, - 10507, - 10447 + 22, + 32, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 32, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 26, + 28, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 32, + 12, + 22, + 22, + 32, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 22, + 32, + 22, + 12, + 22, + 22 ] }, { "Tags": [ - { - "Key": "service.name", - "Value": "java-order-service" - }, { "Key": "span.kind", "Value": "client" + }, + { + "Key": "service.name", + "Value": "ot-java-order-service" } ], - "MetricName": "service_duration", - "MetricNameCN": "平均响应时间", + "MetricName": "error_request_count", + "MetricNameCN": "异常数量", "TimeSerial": [ - 1656428160, - 1656428220, - 1656428280, - 1656428340, - 1656428400, - 1656428460, - 1656428520, - 1656428580, - 1656428640, - 1656428700, - 1656428760, - 1656428820, - 1656428880 + 1734415200, + 1734415260, + 1734415320, + 1734415380, + 1734415440, + 1734415500, + 1734415560, + 1734415620, + 1734415680, + 1734415740, + 1734415800, + 1734415860, + 1734415920, + 1734415980, + 1734416040, + 1734416100, + 1734416160, + 1734416220, + 1734416280, + 1734416340, + 1734416400, + 1734416460, + 1734416520, + 1734416580, + 1734416640, + 1734416700, + 1734416760, + 1734416820, + 1734416880, + 1734416940, + 1734417000, + 1734417060, + 1734417120, + 1734417180, + 1734417240, + 1734417300, + 1734417360, + 1734417420, + 1734417480, + 1734417540, + 1734417600, + 1734417660, + 1734417720, + 1734417780, + 1734417840, + 1734417900, + 1734417960, + 1734418020, + 1734418080, + 1734418140, + 1734418200, + 1734418260, + 1734418320, + 1734418380, + 1734418440, + 1734418500, + 1734418560, + 1734418620, + 1734418680, + 1734418740 ], "DataSerial": [ - 68.27933527571001, - 75.1680976742024, - 73.70498622754624, - 74.37902912946632, - 75.79610287066045, - 77.2206395084234, - 69.26122643544272, - 69.63079755913704, - 65.73752328654751, - 76.56275573601707, - 70.60296113316045, - 71.30283125911086, - 70.25328283510882 + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0 ] }, { "Tags": [ { "Key": "service.name", - "Value": "java-order-service" + "Value": "ot-java-order-service" }, { "Key": "span.kind", "Value": "client" } ], - "MetricName": "service_error_req_rate", - "MetricNameCN": "平均错误率", + "MetricName": "duration_avg", + "MetricNameCN": "平均响应时间", "TimeSerial": [ - 1656428160, - 1656428220, - 1656428280, - 1656428340, - 1656428400, - 1656428460, - 1656428520, - 1656428580, - 1656428640, - 1656428700, - 1656428760, - 1656428820, - 1656428880 + 1734415200, + 1734415260, + 1734415320, + 1734415380, + 1734415440, + 1734415500, + 1734415560, + 1734415620, + 1734415680, + 1734415740, + 1734415800, + 1734415860, + 1734415920, + 1734415980, + 1734416040, + 1734416100, + 1734416160, + 1734416220, + 1734416280, + 1734416340, + 1734416400, + 1734416460, + 1734416520, + 1734416580, + 1734416640, + 1734416700, + 1734416760, + 1734416820, + 1734416880, + 1734416940, + 1734417000, + 1734417060, + 1734417120, + 1734417180, + 1734417240, + 1734417300, + 1734417360, + 1734417420, + 1734417480, + 1734417540, + 1734417600, + 1734417660, + 1734417720, + 1734417780, + 1734417840, + 1734417900, + 1734417960, + 1734418020, + 1734418080, + 1734418140, + 1734418200, + 1734418260, + 1734418320, + 1734418380, + 1734418440, + 1734418500, + 1734418560, + 1734418620, + 1734418680, + 1734418740 ], "DataSerial": [ - 1.3594292325491708, - 1.0115333711476648, - 1.2655800575263663, - 1.077627312607286, - 1.1738670258828057, - 1.1704253497002568, - 1.1841606669192877, - 1.0916403332375753, - 1.0700757575757576, - 0.9246020398436755, - 1.12316405875012, - 1.1040258875035691, - 1.206087872116397 + 191.5860133181818, + 191.2110746363636, + 191.23246599999996, + 191.5040949090909, + 191.934274, + 192.05015977272723, + 191.4917418636364, + 191.7598401818182, + 191.47329104545454, + 191.35408840909093, + 191.7695753181818, + 192.1501132727273, + 191.6614135, + 191.72522395454544, + 193.92501624242422, + 209.9224584090909, + 192.50587436363637, + 193.14908313636363, + 200.8337476363636, + 192.21551695454545, + 191.87317959090907, + 191.85476931818184, + 192.0314575909091, + 192.14624168181817, + 192.0624055, + 192.35865707575758, + 191.87331737878793, + 191.806969, + 192.35163881818187, + 192.29478813636362, + 192.3707790454545, + 191.8557721363636, + 191.59646177272725, + 191.55687904545456, + 191.59595163636365, + 191.84944554545453, + 191.78630649999997, + 191.91973590909092, + 191.90514081818182, + 191.9165850909091, + 191.98103199999997, + 191.98323287878785, + 193.0803381818182, + 192.14093727272729, + 192.24286899999998, + 192.6753041818182, + 192.2717468636364, + 192.41461836363635, + 192.3725805, + 191.84485977272726, + 191.85852840909092, + 191.86218731818178, + 191.6467590454545, + 191.52699904545452, + 191.57099809090911, + 192.2197160909091, + 191.91881845454546, + 191.98860699999997, + 224.0602859090909, + 192.05223709090907 ] }, { "Tags": [ { "Key": "service.name", - "Value": "java-order-service" + "Value": "ot-java-order-service" }, { "Key": "span.kind", "Value": "client" } ], - "MetricName": "service_slow_call_count", + "MetricName": "slow_request_count", "MetricNameCN": "慢调用", "TimeSerial": [ - 1656428160, - 1656428220, - 1656428280, - 1656428340, - 1656428400, - 1656428460, - 1656428520, - 1656428580, - 1656428640, - 1656428700, - 1656428760, - 1656428820, - 1656428880 + 1734415200, + 1734415260, + 1734415320, + 1734415380, + 1734415440, + 1734415500, + 1734415560, + 1734415620, + 1734415680, + 1734415740, + 1734415800, + 1734415860, + 1734415920, + 1734415980, + 1734416040, + 1734416100, + 1734416160, + 1734416220, + 1734416280, + 1734416340, + 1734416400, + 1734416460, + 1734416520, + 1734416580, + 1734416640, + 1734416700, + 1734416760, + 1734416820, + 1734416880, + 1734416940, + 1734417000, + 1734417060, + 1734417120, + 1734417180, + 1734417240, + 1734417300, + 1734417360, + 1734417420, + 1734417480, + 1734417540, + 1734417600, + 1734417660, + 1734417720, + 1734417780, + 1734417840, + 1734417900, + 1734417960, + 1734418020, + 1734418080, + 1734418140, + 1734418200, + 1734418260, + 1734418320, + 1734418380, + 1734418440, + 1734418500, + 1734418560, + 1734418620, + 1734418680, + 1734418740 ], "DataSerial": [ - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0 + 2, + 3, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 3, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 3, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 3, + 1, + 2, + 2, + 3, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 2, + 3, + 2, + 1, + 2, + 2 ] }, { "Tags": [ { "Key": "service.name", - "Value": "java-order-service" + "Value": "ot-java-order-service" }, { "Key": "span.kind", "Value": "client" } ], - "MetricName": "service_error_request_count", - "MetricNameCN": "错误数", + "MetricName": "duration_p50", + "MetricNameCN": "P50 响应时间", "TimeSerial": [ - 1656428160, - 1656428220, - 1656428280, - 1656428340, - 1656428400, - 1656428460, - 1656428520, - 1656428580, - 1656428640, - 1656428700, - 1656428760, - 1656428820, - 1656428880 + 1734415200, + 1734415260, + 1734415320, + 1734415380, + 1734415440, + 1734415500, + 1734415560, + 1734415620, + 1734415680, + 1734415740, + 1734415800, + 1734415860, + 1734415920, + 1734415980, + 1734416040, + 1734416100, + 1734416160, + 1734416220, + 1734416280, + 1734416340, + 1734416400, + 1734416460, + 1734416520, + 1734416580, + 1734416640, + 1734416700, + 1734416760, + 1734416820, + 1734416880, + 1734416940, + 1734417000, + 1734417060, + 1734417120, + 1734417180, + 1734417240, + 1734417300, + 1734417360, + 1734417420, + 1734417480, + 1734417540, + 1734417600, + 1734417660, + 1734417720, + 1734417780, + 1734417840, + 1734417900, + 1734417960, + 1734418020, + 1734418080, + 1734418140, + 1734418200, + 1734418260, + 1734418320, + 1734418380, + 1734418440, + 1734418500, + 1734418560, + 1734418620, + 1734418680, + 1734418740 ], "DataSerial": [ - 141, - 107, - 132, - 113, - 122, - 123, - 125, - 114, - 113, - 97, - 117, - 116, - 126 + 10, + 10, + 9.375, + 14, + 14, + 14, + 10, + 9.375, + 9.285714285714285, + 9.166666666666668, + 10, + 14, + 14, + 14, + 15.714285714285714, + 14.444444444444445, + 14, + 14, + 14.444444444444445, + 14, + 14, + 14, + 14, + 14, + 14, + 13.333333333333332, + 16.153846153846153, + 14, + 14, + 14, + 14, + 14, + 14, + 14, + 14, + 14, + 14, + 14, + 14, + 14, + 14, + 15.333333333333332, + 16.666666666666664, + 14, + 14, + 15.333333333333332, + 14, + 14, + 14, + 14, + 14, + 14, + 14, + 14, + 14, + 15.333333333333332, + 14, + 10, + 14.444444444444445, + 14 ] } ], @@ -320,24 +720,23 @@ Output: } ``` -**Example 3: 查询起始到终止时间内统计service_metric指标数据示例** +**Example 2: 查询起始到终止时间内统计 service_metric 指标数据示例** -该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）、span.kind（客户端/服务端视角）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内的service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）的指标数据。 +该示例查询实例为 apm-059oXBfTL，按照 service.name（服务名）、span.kind（客户端/服务端视角）为维度过滤，以 service.name（服务名）、span.kind（客户端/服务端视角）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的 request_count（请求数量）、error_request_count（错误请求数量）、duration_avg（平均响应时间）、slow_request_count（慢请求数量）、duration_p50（耗时 p50）的指标数据。 Input: ``` tccli apm DescribeGeneralMetricData --cli-unfold-argument \ --Filters.0.Key service.name \ - --Filters.0.Value tapm-api-ap-beijing \ + --Filters.0.Value ot-java-order-service \ --Filters.1.Key span.kind \ --Filters.1.Value client \ --ViewName service_metric \ - --InstanceId apm-ylTJfTSbn \ - --Period 0 \ - --Metrics service_request_count service_duration service_error_req_rate service_slow_call_count service_error_request_count \ - --StartTime 1652666416 \ - --EndTime 1652667616 \ + --InstanceId apm-059oXBfTL \ + --Metrics request_count error_request_count duration_avg slow_request_count duration_p50 \ + --StartTime 1734415200 \ + --EndTime 1734418800 \ --GroupBy service.name span.kind ``` @@ -349,91 +748,91 @@ Output: { "Tags": [ { - "Key": "span.kind", - "Value": "client" + "Key": "service.name", + "Value": "ot-java-order-service" }, { - "Key": "service.name", - "Value": "java-order-service" + "Key": "span.kind", + "Value": "client" } ], - "MetricName": "service_request_count", + "MetricName": "request_count", "MetricNameCN": "总请求数", - "TimeSerial": null, + "TimeSerial": [], "DataSerial": [ - 630381 + 1360 ] }, { "Tags": [ { - "Key": "span.kind", - "Value": "client" + "Key": "service.name", + "Value": "ot-java-order-service" }, { - "Key": "service.name", - "Value": "java-order-service" + "Key": "span.kind", + "Value": "client" } ], - "MetricName": "service_duration", - "MetricNameCN": "平均响应时间", - "TimeSerial": null, + "MetricName": "error_request_count", + "MetricNameCN": "异常数量", + "TimeSerial": [], "DataSerial": [ - 72.44506470564654 + 0 ] }, { "Tags": [ { - "Key": "span.kind", - "Value": "client" + "Key": "service.name", + "Value": "ot-java-order-service" }, { - "Key": "service.name", - "Value": "java-order-service" + "Key": "span.kind", + "Value": "client" } ], - "MetricName": "service_error_req_rate", - "MetricNameCN": "平均错误率", - "TimeSerial": null, + "MetricName": "duration_avg", + "MetricNameCN": "平均响应时间", + "TimeSerial": [], "DataSerial": [ - 1.1464495281425042 + 192.96957006641412 ] }, { "Tags": [ { - "Key": "span.kind", - "Value": "client" + "Key": "service.name", + "Value": "ot-java-order-service" }, { - "Key": "service.name", - "Value": "java-order-service" + "Key": "span.kind", + "Value": "client" } ], - "MetricName": "service_slow_call_count", + "MetricName": "slow_request_count", "MetricNameCN": "慢调用", - "TimeSerial": null, + "TimeSerial": [], "DataSerial": [ - 0 + 124 ] }, { "Tags": [ { - "Key": "span.kind", - "Value": "client" + "Key": "service.name", + "Value": "ot-java-order-service" }, { - "Key": "service.name", - "Value": "java-order-service" + "Key": "span.kind", + "Value": "client" } ], - "MetricName": "service_error_request_count", - "MetricNameCN": "错误数", - "TimeSerial": null, + "MetricName": "duration_p50", + "MetricNameCN": "P50 响应时间", + "TimeSerial": [], "DataSerial": [ - 7227 + 13.443708609271523 ] } ], @@ -442,22 +841,22 @@ Output: } ``` -**Example 4: 查询1分钟聚合粒度的sql_metric的service_slow_sql_count（慢调用sql）指标数据示例** +**Example 3: 查询1分钟聚合粒度的 sql_metric 指标数据示例** -该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的service_slow_sql_count（慢sql）的指标数据。 +该示例查询实例为 apm-059oXBfTL，按照 service.name（服务名）为维度过滤，以 service.name（服务名）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的 error_request_count（错误请求数量）、duration_avg（平均响应时间）的指标数据。 Input: ``` tccli apm DescribeGeneralMetricData --cli-unfold-argument \ --Filters.0.Key service.name \ - --Filters.0.Value tapm-api-ap-beijing \ + --Filters.0.Value ot-java-order-service \ --ViewName sql_metric \ - --InstanceId apm-ylTJfTSbn \ + --InstanceId apm-059oXBfTL \ --Period 60 \ - --Metrics service_slow_sql_count \ - --StartTime 1652666416 \ - --EndTime 1652667616 \ + --Metrics error_request_count duration_avg \ + --StartTime 1734415200 \ + --EndTime 1734418800 \ --GroupBy service.name ``` @@ -470,27 +869,121 @@ Output: "Tags": [ { "Key": "service.name", - "Value": "java-order-service" + "Value": "ot-java-order-service" } ], - "MetricName": "service_slow_sql_count", - "MetricNameCN": "", + "MetricName": "error_request_count", + "MetricNameCN": "错误数", "TimeSerial": [ - 1656428160, - 1656428220, - 1656428280, - 1656428340, - 1656428400, - 1656428460, - 1656428520, - 1656428580, - 1656428640, - 1656428700, - 1656428760, - 1656428820, - 1656428880 + 1734415200, + 1734415260, + 1734415320, + 1734415380, + 1734415440, + 1734415500, + 1734415560, + 1734415620, + 1734415680, + 1734415740, + 1734415800, + 1734415860, + 1734415920, + 1734415980, + 1734416040, + 1734416100, + 1734416160, + 1734416220, + 1734416280, + 1734416340, + 1734416400, + 1734416460, + 1734416520, + 1734416580, + 1734416640, + 1734416700, + 1734416760, + 1734416820, + 1734416880, + 1734416940, + 1734417000, + 1734417060, + 1734417120, + 1734417180, + 1734417240, + 1734417300, + 1734417360, + 1734417420, + 1734417480, + 1734417540, + 1734417600, + 1734417660, + 1734417720, + 1734417780, + 1734417840, + 1734417900, + 1734417960, + 1734418020, + 1734418080, + 1734418140, + 1734418200, + 1734418260, + 1734418320, + 1734418380, + 1734418440, + 1734418500, + 1734418560, + 1734418620, + 1734418680, + 1734418740 ], "DataSerial": [ + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, 0, 0, 0, @@ -505,6 +998,140 @@ Output: 0, 0 ] + }, + { + "Tags": [ + { + "Key": "service.name", + "Value": "ot-java-order-service" + } + ], + "MetricName": "duration_avg", + "MetricNameCN": "平均响应时间", + "TimeSerial": [ + 1734415200, + 1734415260, + 1734415320, + 1734415380, + 1734415440, + 1734415500, + 1734415560, + 1734415620, + 1734415680, + 1734415740, + 1734415800, + 1734415860, + 1734415920, + 1734415980, + 1734416040, + 1734416100, + 1734416160, + 1734416220, + 1734416280, + 1734416340, + 1734416400, + 1734416460, + 1734416520, + 1734416580, + 1734416640, + 1734416700, + 1734416760, + 1734416820, + 1734416880, + 1734416940, + 1734417000, + 1734417060, + 1734417120, + 1734417180, + 1734417240, + 1734417300, + 1734417360, + 1734417420, + 1734417480, + 1734417540, + 1734417600, + 1734417660, + 1734417720, + 1734417780, + 1734417840, + 1734417900, + 1734417960, + 1734418020, + 1734418080, + 1734418140, + 1734418200, + 1734418260, + 1734418320, + 1734418380, + 1734418440, + 1734418500, + 1734418560, + 1734418620, + 1734418680, + 1734418740 + ], + "DataSerial": [ + 504.4455225, + 504.49955074999997, + 504.50165175000006, + 504.55699425, + 504.5483053749999, + 504.547519, + 504.73789837500004, + 504.46199262500005, + 504.1922, + 504.22497787500004, + 504.18011225000004, + 504.04929475, + 504.14939112499997, + 504.45689225, + 504.4441259166667, + 504.4853475, + 504.55031125, + 504.458504875, + 504.49732837499994, + 504.50629599999996, + 504.439337, + 504.272122, + 504.267848625, + 504.28821525, + 504.268522875, + 504.28563437500003, + 504.25491391666674, + 504.20538062500003, + 504.54045425000004, + 504.67349375000003, + 504.71599025, + 504.54132337499993, + 504.69503825, + 504.74425037500004, + 504.637164375, + 504.62155600000006, + 504.628113, + 505.07725949999997, + 504.65562800000004, + 504.443061375, + 504.420146125, + 504.41736325000005, + 507.28285875, + 504.59916025, + 504.50750687499993, + 504.67656166666666, + 504.687698625, + 504.7468005, + 504.728723, + 504.71881125, + 504.6750935, + 504.45997087499995, + 504.48766912499997, + 504.5063645, + 504.670277625, + 504.88526525, + 505.09475625, + 505.13066475, + 505.103745375, + 505.101275 + ] } ], "RequestId": "test-test-test" @@ -512,9 +1139,9 @@ Output: } ``` -**Example 5: 查询起始到终止时间内统计sql_metric的sql_duration_avg（耗时时间）指标数据示例** +**Example 4: 查询起始到终止时间内统计 sql_metric 的 duration_avg（耗时时间）指标数据示例** -该示例查询实例为apm-ylTJfTSbn，按照db.instance（数据库名称）、（db.ip）数据库实例ip为维度过滤，以service.name（服务名）、db.statement（sql语句）为维度进行聚合，查找开始时间-终止时间内top5的sql_duration_avg（耗时（ms））的指标数据。 +该示例查询实例为apm-059oXBfTL，按照 db.instance（数据库名称）为维度过滤，以 service.name（服务名）、db.statement（执行语句）为维度进行聚合，查找开始时间-终止时间内 top5 的 duration_avg（耗时（ms））的指标数据。 Input: @@ -522,13 +1149,11 @@ Input: tccli apm DescribeGeneralMetricData --cli-unfold-argument \ --Filters.0.Key db.instance \ --Filters.0.Value mock_project_db \ - --Filters.1.Key db.ip \ - --Filters.1.Value 9.147.18.42 \ --ViewName sql_metric \ - --InstanceId apm-ylTJfTSbn \ - --Metrics sql_duration_avg \ - --StartTime 1652666416 \ - --EndTime 1652667616 \ + --InstanceId apm-059oXBfTL \ + --Metrics duration_avg \ + --StartTime 1734415200 \ + --EndTime 1734418800 \ --GroupBy service.name db.statement \ --OrderBy.Key sql_duration_avg \ --OrderBy.Value desc \ @@ -544,90 +1169,126 @@ Output: "Tags": [ { "Key": "db.statement", - "Value": "select * om un_exist_table limit 1" + "Value": "select sleep(?)" + }, + { + "Key": "service.name", + "Value": "ot-java-order-service" + } + ], + "MetricName": "duration_avg", + "MetricNameCN": "平均响应时间", + "TimeSerial": [], + "DataSerial": [ + 2005.583661869444 + ] + }, + { + "Tags": [ + { + "Key": "service.name", + "Value": "ot-java-stock-service" + }, + { + "Key": "db.statement", + "Value": "select dept, count(dept) as total from mock_project_userinfo" + } + ], + "MetricName": "duration_avg", + "MetricNameCN": "平均响应时间", + "TimeSerial": [], + "DataSerial": [ + 5.746467460185185 + ] + }, + { + "Tags": [ + { + "Key": "db.statement", + "Value": "select dept, count(dept) as total from mock_project_userinfo" }, { "Key": "service.name", - "Value": "java-order-service" + "Value": "ot-java-user-service" } ], - "MetricName": "sql_duration_avg", + "MetricName": "duration_avg", "MetricNameCN": "平均响应时间", - "TimeSerial": null, + "TimeSerial": [], "DataSerial": [ - 29.883333333333333 + 5.719407256481479 ] }, { "Tags": [ { "Key": "db.statement", - "Value": "select * om un_exist_table limit 1" + "Value": "select * from mock_project_userinfo" }, { "Key": "service.name", - "Value": "java-user-service" + "Value": "ot-java-order-service" } ], - "MetricName": "sql_duration_avg", + "MetricName": "duration_avg", "MetricNameCN": "平均响应时间", - "TimeSerial": null, + "TimeSerial": [], "DataSerial": [ - 26.170082239670673 + 5.677464627777778 ] }, { "Tags": [ { "Key": "db.statement", - "Value": "select * from un_exist_table limit 1" + "Value": "select * from mock_project_userinfo" }, { "Key": "service.name", - "Value": "java-market-service" + "Value": "ot-java-delivery-service" } ], - "MetricName": "sql_duration_avg", + "MetricName": "duration_avg", "MetricNameCN": "平均响应时间", - "TimeSerial": null, + "TimeSerial": [], "DataSerial": [ - 25.654237574773983 + 5.636013505555556 ] }, { "Tags": [ { "Key": "db.statement", - "Value": "select * from mock_project_userinfo where id = ? limit 1" + "Value": "select * om un_exist_table limit ?" }, { "Key": "service.name", - "Value": "java-order-service" + "Value": "ot-java-delivery-service" } ], - "MetricName": "sql_duration_avg", + "MetricName": "duration_avg", "MetricNameCN": "平均响应时间", - "TimeSerial": null, + "TimeSerial": [], "DataSerial": [ - 24.333649579223025 + 5.514262441666669 ] }, { "Tags": [ { "Key": "db.statement", - "Value": "select * from un_exist_table limit 1" + "Value": "select dept, count(dept) as total from mock_project_userinfo" }, { "Key": "service.name", - "Value": "java-user-service" + "Value": "ot-java-market-service" } ], - "MetricName": "sql_duration_avg", + "MetricName": "duration_avg", "MetricNameCN": "平均响应时间", - "TimeSerial": null, + "TimeSerial": [], "DataSerial": [ - 22.785741520925463 + 5.44814345277778 ] } ], diff --git a/tccli/examples/cam/v20190116/GetServiceLinkedRoleDeletionStatus.md b/tccli/examples/cam/v20190116/GetServiceLinkedRoleDeletionStatus.md index e4898b7508..43e7b43689 100644 --- a/tccli/examples/cam/v20190116/GetServiceLinkedRoleDeletionStatus.md +++ b/tccli/examples/cam/v20190116/GetServiceLinkedRoleDeletionStatus.md @@ -16,7 +16,7 @@ Output: "Status": "SUCCEEDED", "ServiceType": "cam", "ServiceName": "访问管理", - "Reason": "{}", + "Reason": "ok", "RequestId": "c3da1c1c-df35-467d-9335-99c68d993e0a" } } diff --git a/tccli/examples/cam/v20190116/ListAttachedGroupPolicies.md b/tccli/examples/cam/v20190116/ListAttachedGroupPolicies.md index 127459c8db..cfdc32eac4 100644 --- a/tccli/examples/cam/v20190116/ListAttachedGroupPolicies.md +++ b/tccli/examples/cam/v20190116/ListAttachedGroupPolicies.md @@ -27,7 +27,7 @@ Output: "PolicyType": "User", "PolicyId": 1, "DeactivedDetail": [ - "test" + "ccs" ], "OperateUin": "10001" } diff --git a/tccli/examples/cam/v20190116/ListAttachedRolePolicies.md b/tccli/examples/cam/v20190116/ListAttachedRolePolicies.md index fddbe945c8..7185cbe129 100644 --- a/tccli/examples/cam/v20190116/ListAttachedRolePolicies.md +++ b/tccli/examples/cam/v20190116/ListAttachedRolePolicies.md @@ -18,14 +18,14 @@ Output: "List": [ { "PolicyName": "QcloudAccessForASRole", - "Description": "xx", + "Description": "Free Access to AS Product", "CreateMode": 1, "Deactived": 1, "AddTime": "2019-07-10 11:17:41", "PolicyType": "QCS", "PolicyId": 13847366, "DeactivedDetail": [ - "xx" + "bbs" ] } ], diff --git a/tccli/examples/cam/v20190116/ListAttachedUserPolicies.md b/tccli/examples/cam/v20190116/ListAttachedUserPolicies.md index e594a72e7e..8118317d43 100644 --- a/tccli/examples/cam/v20190116/ListAttachedUserPolicies.md +++ b/tccli/examples/cam/v20190116/ListAttachedUserPolicies.md @@ -18,16 +18,18 @@ Output: "List": [ { "PolicyId": 109360057, - "PolicyName": "test-0103", - "AddTime": "2022-01-03 10:38:28", + "PolicyName": "policygen-20240909141614", + "AddTime": "2024-09-09 15:51:40", "CreateMode": 3, - "Remark": "", - "OperateOwnerUin": null, - "OperateUin": null, - "OperateUinType": null, - "PolicyType": "", + "Remark": "cos policy", + "OperateOwnerUin": "100008847111", + "OperateUin": "100008847111", + "OperateUinType": 0, + "PolicyType": "User", "Deactived": 0, - "DeactivedDetail": [] + "DeactivedDetail": [ + "ccs" + ] } ], "TotalNum": 1, diff --git a/tccli/examples/cam/v20190116/ListPolicies.md b/tccli/examples/cam/v20190116/ListPolicies.md index 8689c6074e..e2eb9cc3af 100644 --- a/tccli/examples/cam/v20190116/ListPolicies.md +++ b/tccli/examples/cam/v20190116/ListPolicies.md @@ -14,9 +14,6 @@ Output: ``` { "Response": { - "ServiceTypeList": [ - "scf" - ], "List": [ { "PolicyId": 16313162, @@ -38,6 +35,9 @@ Output: "AttachEntityBoundaryCount": 0 } ], + "ServiceTypeList": [ + "scf" + ], "TotalNum": 239, "RequestId": "ae2bd2b7-1d55-4b0a-8154-e02407a2b390" } diff --git a/tccli/examples/cam/v20190116/ListPoliciesGrantingServiceAccess.md b/tccli/examples/cam/v20190116/ListPoliciesGrantingServiceAccess.md index 0934b4f231..2d147273d9 100644 --- a/tccli/examples/cam/v20190116/ListPoliciesGrantingServiceAccess.md +++ b/tccli/examples/cam/v20190116/ListPoliciesGrantingServiceAccess.md @@ -19,12 +19,17 @@ Output: "ServiceType": "cvm", "ServiceName": "云服务器" }, - "Action": [], + "Action": [ + { + "Name": "AddInstanceInDeployGroup", + "Description": "新增实例部署组" + } + ], "Policy": [ { "PolicyId": "73019980", "PolicyName": "policygen-20210xxxxxxx", - "PolicyDescription": "-", + "PolicyDescription": "cvm custom policy", "PolicyType": "Custom" } ] @@ -67,7 +72,7 @@ Output: { "PolicyId": "73019980", "PolicyName": "policygen-20210xxxxxxx", - "PolicyDescription": "-", + "PolicyDescription": "cvm custom policy", "PolicyType": "Custom" } ] diff --git a/tccli/examples/cdb/v20170320/ModifyProtectMode.md b/tccli/examples/cdb/v20170320/ModifyProtectMode.md new file mode 100644 index 0000000000..69a207a1ef --- /dev/null +++ b/tccli/examples/cdb/v20170320/ModifyProtectMode.md @@ -0,0 +1,21 @@ +**Example 1: 修改实例同步方式** + + + +Input: + +``` +tccli cdb ModifyProtectMode --cli-unfold-argument \ + --ProtectMode 1 \ + --InstanceId cdb-ezq1vzem +``` + +Output: +``` +{ + "Response": { + "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7" + } +} +``` + diff --git a/tccli/examples/cloudaudit/v20190319/LookUpEvents.md b/tccli/examples/cloudaudit/v20190319/LookUpEvents.md index fcdd1a7696..585d494093 100644 --- a/tccli/examples/cloudaudit/v20190319/LookUpEvents.md +++ b/tccli/examples/cloudaudit/v20190319/LookUpEvents.md @@ -8,7 +8,7 @@ Input: tccli cloudaudit LookUpEvents --cli-unfold-argument \ --EndTime 1553056687 \ --LookupAttributes.0.AttributeKey AccessKeyId \ - --LookupAttributes.0.AttributeValue XXXX \ + --LookupAttributes.0.AttributeValue a9266b0599ff \ --StartTime 1553056487 ``` diff --git a/tccli/examples/cloudaudit/v20190319/StartLogging.md b/tccli/examples/cloudaudit/v20190319/StartLogging.md index 527df00ec1..7b04a93328 100644 --- a/tccli/examples/cloudaudit/v20190319/StartLogging.md +++ b/tccli/examples/cloudaudit/v20190319/StartLogging.md @@ -6,7 +6,7 @@ Input: ``` tccli cloudaudit StartLogging --cli-unfold-argument \ - --AuditName xxxxx + --AuditName audit_log ``` Output: diff --git a/tccli/examples/cynosdb/v20190107/DescribeClusterDatabaseTables.md b/tccli/examples/cynosdb/v20190107/DescribeClusterDatabaseTables.md new file mode 100644 index 0000000000..1741a0ca56 --- /dev/null +++ b/tccli/examples/cynosdb/v20190107/DescribeClusterDatabaseTables.md @@ -0,0 +1,27 @@ +**Example 1: 获取table列表** + + + +Input: + +``` +tccli cynosdb DescribeClusterDatabaseTables --cli-unfold-argument \ + --Db xxx \ + --ClusterId xxx +``` + +Output: +``` +{ + "Response": { + "Tables": [ + "testtable" + ], + "Limit": 20, + "Offset": 0, + "RequestId": "198189", + "TotalCount": 1 + } +} +``` + diff --git a/tccli/examples/domain/v20180808/DeleteBidding.md b/tccli/examples/domain/v20180808/DeleteBidding.md index 24783c62d1..48b5198eca 100644 --- a/tccli/examples/domain/v20180808/DeleteBidding.md +++ b/tccli/examples/domain/v20180808/DeleteBidding.md @@ -6,7 +6,7 @@ Input: ``` tccli domain DeleteBidding --cli-unfold-argument \ - --BusinessID xxxx + --BusinessID *****2561 ``` Output: diff --git a/tccli/examples/domain/v20180808/DescribeBatchOperationLogDetails.md b/tccli/examples/domain/v20180808/DescribeBatchOperationLogDetails.md index 61a36d154c..c460c26304 100644 --- a/tccli/examples/domain/v20180808/DescribeBatchOperationLogDetails.md +++ b/tccli/examples/domain/v20180808/DescribeBatchOperationLogDetails.md @@ -15,20 +15,20 @@ Output: ``` { "Response": { - "TotalCount": 0, + "TotalCount": 1, + "RequestId": "f376d0e6-f064-1234-b27f-a8ae3b054dfa", "DomainBatchDetailSet": [ { - "Id": 0, - "Action": "abc", - "Domain": "abc", - "Status": "abc", - "Reason": "abc", - "CreatedOn": "abc", - "UpdatedOn": "abc", - "BigDealId": "abc" + "UpdatedOn": "2024-12-18 12:21:16", + "BigDealId": "", + "Action": "batch_modify_domain_dns1", + "Status": "failed", + "Domain": "***.com", + "CreatedOn": "2024-12-18 12:21:12", + "Reason": "域名已开启【禁止更新锁】保护域名信息安全，不能修改信息。如需操作，请先关闭【禁止更新锁】", + "Id": 1001 } - ], - "RequestId": "abc" + ] } } ``` diff --git a/tccli/examples/domain/v20180808/DescribeBiddingAppointDetail.md b/tccli/examples/domain/v20180808/DescribeBiddingAppointDetail.md index c87603980a..aa99c78d2d 100644 --- a/tccli/examples/domain/v20180808/DescribeBiddingAppointDetail.md +++ b/tccli/examples/domain/v20180808/DescribeBiddingAppointDetail.md @@ -6,7 +6,7 @@ Input: ``` tccli domain DescribeBiddingAppointDetail --cli-unfold-argument \ - --BusinessID xxxx + --BusinessID ***561 ``` Output: diff --git a/tccli/examples/domain/v20180808/DescribeBiddingAppointList.md b/tccli/examples/domain/v20180808/DescribeBiddingAppointList.md index c33f1a25f5..caff03d920 100644 --- a/tccli/examples/domain/v20180808/DescribeBiddingAppointList.md +++ b/tccli/examples/domain/v20180808/DescribeBiddingAppointList.md @@ -20,7 +20,7 @@ Output: "AppointEndTime": "2023-10-28T09:53:48+08:00", "AppointNum": 1, "AppointPrice": 105, - "BusinessID": "xxxx", + "BusinessID": "***561", "Domain": "sasdfzcccc2216.com", "Status": 1 } diff --git a/tccli/examples/domain/v20180808/DescribeBiddingDetail.md b/tccli/examples/domain/v20180808/DescribeBiddingDetail.md index 2e723cf283..5c48f0aa92 100644 --- a/tccli/examples/domain/v20180808/DescribeBiddingDetail.md +++ b/tccli/examples/domain/v20180808/DescribeBiddingDetail.md @@ -6,7 +6,7 @@ Input: ``` tccli domain DescribeBiddingDetail --cli-unfold-argument \ - --BusinessID xxxx + --BusinessID ***561 ``` Output: @@ -23,7 +23,7 @@ Output: "CurrentNickname": "feng", "CurrentPrice": 120, "DeleteTime": "2023-11-28 09:53:48", - "Domain": "sasdfzcccc2216.com", + "Domain": "***16.com", "ExpireTime": "2023-09-28 09:53:48", "RegTime": "2022-09-28 09:53:48", "RequestId": "5fdc5b55-514b-42f8-85a3-e269db61f752", diff --git a/tccli/examples/domain/v20180808/DescribeBiddingList.md b/tccli/examples/domain/v20180808/DescribeBiddingList.md index 76e5aa24f3..8c78353a41 100644 --- a/tccli/examples/domain/v20180808/DescribeBiddingList.md +++ b/tccli/examples/domain/v20180808/DescribeBiddingList.md @@ -21,10 +21,10 @@ Output: "BiddingFlag": 0, "BiddingNum": 1, "BiddingPrice": 0, - "BusinessID": "xxxx", + "BusinessID": "***2561", "CurrentNickname": "feng", "CurrentPrice": 120, - "Domain": "sasdfzcccc2216.com", + "Domain": "s***16.com", "Status": 7 }, { @@ -33,10 +33,10 @@ Output: "BiddingFlag": 1, "BiddingNum": 1, "BiddingPrice": 150, - "BusinessID": "xxxx", + "BusinessID": "***561", "CurrentNickname": "feng", "CurrentPrice": 120, - "Domain": "sasdfzcccc2216.com", + "Domain": "***16.com", "Status": 2 } ], diff --git a/tccli/examples/domain/v20180808/DescribeBiddingSuccessfulDetail.md b/tccli/examples/domain/v20180808/DescribeBiddingSuccessfulDetail.md index 745b0742b9..b7e152862d 100644 --- a/tccli/examples/domain/v20180808/DescribeBiddingSuccessfulDetail.md +++ b/tccli/examples/domain/v20180808/DescribeBiddingSuccessfulDetail.md @@ -6,7 +6,7 @@ Input: ``` tccli domain DescribeBiddingSuccessfulDetail --cli-unfold-argument \ - --BusinessID xxxx + --BusinessID ***2561 ``` Output: @@ -16,7 +16,7 @@ Output: "BiddingBondPrice": 80, "BiddingBondRefund": "no", "DeleteTime": "2023-11-28 09:53:48", - "Domain": "sasdfzcccc2216.com", + "Domain": "***16.com", "ExpireTime": "2023-09-28 09:53:48", "PayEndTime": "2023-11-07 09:53:48", "RegTime": "2022-09-28 09:53:48", diff --git a/tccli/examples/domain/v20180808/DescribeCustomDnsHostSet.md b/tccli/examples/domain/v20180808/DescribeCustomDnsHostSet.md index f9983edab1..856d2ec077 100644 --- a/tccli/examples/domain/v20180808/DescribeCustomDnsHostSet.md +++ b/tccli/examples/domain/v20180808/DescribeCustomDnsHostSet.md @@ -22,14 +22,14 @@ Output: "IpSet": [ "2.2.2.2" ], - "DnsName": "bbbb" + "DnsName": "a1.dns.dns" }, { "IpSet": [ "8.8.9.9", "3.3.3.3" ], - "DnsName": "aaa" + "DnsName": "a2.dns.dns" } ] } diff --git a/tccli/examples/domain/v20180808/DescribeDomainBaseInfo.md b/tccli/examples/domain/v20180808/DescribeDomainBaseInfo.md index 405931831d..40e6d89818 100644 --- a/tccli/examples/domain/v20180808/DescribeDomainBaseInfo.md +++ b/tccli/examples/domain/v20180808/DescribeDomainBaseInfo.md @@ -35,7 +35,7 @@ Output: "LockEndTime": "2021-12-28 18:00:00" }, "RequestId": "1b76dd88-64d0-4bd1-9cb8-c20de11c3686", - "Uin": "1111" + "Uin": "100**328" } } ``` diff --git a/tccli/examples/domain/v20180808/DescribeDomainSimpleInfo.md b/tccli/examples/domain/v20180808/DescribeDomainSimpleInfo.md index 02409f07bb..b5c510a27d 100644 --- a/tccli/examples/domain/v20180808/DescribeDomainSimpleInfo.md +++ b/tccli/examples/domain/v20180808/DescribeDomainSimpleInfo.md @@ -18,7 +18,7 @@ Output: "DomainId": "domain-1234abcd", "OrganizationName": "tencent cloud", "ExpirationDate": "2018-08-08", - "DomainName": "cloud.tencent.com", + "DomainName": "cent.com", "RegistrarType": "qcloud", "LockEndTime": "", "OrganizationNameCN": "腾讯云", diff --git a/tccli/examples/domain/v20180808/DescribePayWaitDetail.md b/tccli/examples/domain/v20180808/DescribePayWaitDetail.md index fa2892dcb8..16d410f816 100644 --- a/tccli/examples/domain/v20180808/DescribePayWaitDetail.md +++ b/tccli/examples/domain/v20180808/DescribePayWaitDetail.md @@ -6,20 +6,20 @@ Input: ``` tccli domain DescribePayWaitDetail --cli-unfold-argument \ - --BusinessId abc + --BusinessId ***561 ``` Output: ``` { "Response": { - "Domain": "abc", - "Status": "abc", - "EndTime": "abc", - "RegTime": "abc", - "Price": 0, - "RetDeposit": 0, - "RequestId": "abc" + "RequestId": "45559f25-13b9-42fd-b2ae-698842d91fd7", + "Domain": "*1.top", + "Status": "pay", + "EndTime": "2024-12-19 07:24:25", + "RegTime": "2023-11-11 07:24:25", + "Price": 98, + "RetDeposit": 32 } } ``` diff --git a/tccli/examples/domain/v20180808/DescribeTemplate.md b/tccli/examples/domain/v20180808/DescribeTemplate.md index 381e4b75aa..7ea1233a41 100644 --- a/tccli/examples/domain/v20180808/DescribeTemplate.md +++ b/tccli/examples/domain/v20180808/DescribeTemplate.md @@ -19,14 +19,14 @@ Output: "ContactInfo": { "Province": "hu nan sheng", "RegistrantType": "I", - "OrganizationName": "ce shi", - "OrganizationNameCN": "测试", + "OrganizationName": "yan zheng org name", + "OrganizationNameCN": "验证的企业名称", "Country": "CN", - "RegistrantName": "ce shi", + "RegistrantName": "registrant name", "ZipCode": "425000", "Telephone": "155*********", "City": "ce shi", - "RegistrantNameCN": "测试", + "RegistrantNameCN": "注册人名称", "StreetCN": "咸嘉湖街道", "Street": "xian jia hu jie dao", "ProvinceCN": "湖南省", @@ -36,6 +36,7 @@ Output: }, "UpdatedOn": "2020-07-28 13:33:55", "AuditStatus": "InAudit", + "IsBlack": false, "CreatedOn": "2020-07-28 12:50:23", "UserUin": "12334********", "IsDefault": "no", @@ -45,11 +46,14 @@ Output: "CertificateInfo": { "CertificateType": "SFZ", "CertificateCode": "12345679", - "ImgUrl": "https://tencentyun.com/******" + "ImgUrl": "https://image.com/******", + "OriginImgUrl": "https://tencentyun.com/******", + "RegistrantCertificateCode": "12345679", + "RegistrantCertificateType": "SFZ", + "RegistrantImgUrl": "https://image.com/******" } } - }, - "ResultStatus": true + } } ``` diff --git a/tccli/examples/domain/v20180808/DescribeTemplateList.md b/tccli/examples/domain/v20180808/DescribeTemplateList.md index a3969f38e3..2546abeacb 100644 --- a/tccli/examples/domain/v20180808/DescribeTemplateList.md +++ b/tccli/examples/domain/v20180808/DescribeTemplateList.md @@ -10,7 +10,7 @@ tccli domain DescribeTemplateList --cli-unfold-argument \ --Limit 20 \ --Status InAudit \ --Type E \ - --Keyword abc + --Keyword search_name ``` Output: @@ -24,20 +24,20 @@ Output: "ContactInfo": { "Province": "hu nan sheng", "RegistrantType": "I", - "OrganizationName": "ce shi", - "OrganizationNameCN": "测试", + "OrganizationName": "org name", + "OrganizationNameCN": "企业名称", "Country": "CN", - "RegistrantName": "ce shi", + "RegistrantName": "shi ming name", "ZipCode": "425000", "Telephone": "155*********", "City": "ce shi", - "RegistrantNameCN": "测试", + "RegistrantNameCN": "实名人", "StreetCN": "咸嘉湖街道", "Street": "xian jia hu jie dao", "ProvinceCN": "湖南省", "CityCN": "长沙市", "CountryCN": "中国", - "Email": "dnspod@dnspod.com" + "Email": "**d@dnspod.com" }, "UpdatedOn": "2020-07-28 13:33:55", "AuditStatus": "InAudit", diff --git a/tccli/examples/domain/v20180808/DescribeUnPreDomainDetail.md b/tccli/examples/domain/v20180808/DescribeUnPreDomainDetail.md index 16cc0eea34..c56122fc3f 100644 --- a/tccli/examples/domain/v20180808/DescribeUnPreDomainDetail.md +++ b/tccli/examples/domain/v20180808/DescribeUnPreDomainDetail.md @@ -6,25 +6,25 @@ Input: ``` tccli domain DescribeUnPreDomainDetail --cli-unfold-argument \ - --Domain abc + --Domain **m.com ``` Output: ``` { "Response": { - "Domain": "abc", - "PreCount": 0, - "RegTime": "abc", - "DeleteTime": "abc", - "ExpireTime": "abc", - "Status": "abc", - "CurrentPrice": 0, - "AppointBondPrice": 0, - "IsAppoint": true, - "BusinessId": "abc", - "IsDomainUser": true, - "RequestId": "abc" + "RequestId": "cd4379ce-0fb7-1234-bc2f-5a68df5bcd20", + "Domain": "**m.com", + "PreCount": 8, + "RegTime": "2005-11-23 02:26:00", + "DeleteTime": "2025-01-23 02:26:00", + "ExpireTime": "2024-12-23 02:26:00", + "Status": "ing", + "CurrentPrice": 198, + "AppointBondPrice": 90, + "IsAppoint": false, + "BusinessId": "***046", + "IsDomainUser": false } } ``` diff --git a/tccli/examples/domain/v20180808/ModifyDomainOwnerBatch.md b/tccli/examples/domain/v20180808/ModifyDomainOwnerBatch.md index c7072beca1..50b35d348c 100644 --- a/tccli/examples/domain/v20180808/ModifyDomainOwnerBatch.md +++ b/tccli/examples/domain/v20180808/ModifyDomainOwnerBatch.md @@ -7,7 +7,7 @@ Input: ``` tccli domain ModifyDomainOwnerBatch --cli-unfold-argument \ --Domains h101.tencent.com \ - --NewOwnerUin 123456 + --NewOwnerUin 100**238 ``` Output: diff --git a/tccli/examples/domain/v20180808/TransferInDomainBatch.md b/tccli/examples/domain/v20180808/TransferInDomainBatch.md index 5b94a1478b..ddcfe6fa5d 100644 --- a/tccli/examples/domain/v20180808/TransferInDomainBatch.md +++ b/tccli/examples/domain/v20180808/TransferInDomainBatch.md @@ -8,7 +8,7 @@ Input: tccli domain TransferInDomainBatch --cli-unfold-argument \ --TemplateId tmpl-xxxxx \ --Domains h101.tencent.com \ - --PassWords 123456 \ + --PassWords password \ --PayMode 0 ``` diff --git a/tccli/examples/domain/v20180808/UploadImage.md b/tccli/examples/domain/v20180808/UploadImage.md index 8bf22b6d38..15f04a6edf 100644 --- a/tccli/examples/domain/v20180808/UploadImage.md +++ b/tccli/examples/domain/v20180808/UploadImage.md @@ -13,7 +13,7 @@ Output: ``` { "Response": { - "AccessUrl": "xxxxx", + "AccessUrl": "http://cos.url/image.jpg", "RequestId": "1b76dd88-64d0-4bd1-9cb8-c20de11c3686" } } diff --git a/tccli/examples/ess/v20201111/DescribeOrganizationVerifyStatus.md b/tccli/examples/ess/v20201111/DescribeOrganizationVerifyStatus.md new file mode 100644 index 0000000000..c1454be7ac --- /dev/null +++ b/tccli/examples/ess/v20201111/DescribeOrganizationVerifyStatus.md @@ -0,0 +1,21 @@ +**Example 1: 查询当前企业在电子签的认证状态** + +当前企业在电子签已经认证，企业调用方进行调用 + +Input: + +``` +tccli ess DescribeOrganizationVerifyStatus --cli-unfold-argument \ + --Operator.UserId yDRCLUUgygq2xun5UuO4zjEwg0vjoimj +``` + +Output: +``` +{ + "Response": { + "RequestId": "49500cb4-ca5e-4da0-93fb-e15f3a710ed7", + "VerifyStatus": 2 + } +} +``` + diff --git a/tccli/examples/gwlb/v20240906/DescribeTargetGroupList.md b/tccli/examples/gwlb/v20240906/DescribeTargetGroupList.md index 494611ac34..9c252b66ad 100644 --- a/tccli/examples/gwlb/v20240906/DescribeTargetGroupList.md +++ b/tccli/examples/gwlb/v20240906/DescribeTargetGroupList.md @@ -11,37 +11,79 @@ Output: ``` { "Response": { - "TotalCount": 1, + "RequestId": "5c5003ab-126b-4649-8c86-0a98f34cfe12", "TargetGroupSet": [ { - "TargetGroupId": "abc", - "VpcId": "abc", - "TargetGroupName": "abc", - "Port": 1, - "CreatedTime": "2020-09-22T00:00:00+00:00", - "UpdatedTime": "2020-09-22T00:00:00+00:00", - "AssociatedRule": [ - { - "LoadBalancerId": "abc", - "LoadBalancerName": "abc" - } - ], - "Protocol": "abc", - "ScheduleAlgorithm": "abc", + "AllDeadToAlive": true, + "AssociatedRule": null, + "AssociatedRuleCount": 1, + "CreatedTime": "2024-10-15T00:00:00+00:00", + "HealthCheck": { + "HealthNum": 3, + "HealthSwitch": true, + "IntervalTime": 5, + "Port": 0, + "Protocol": "icmp", + "Timeout": 2, + "UnHealthNum": 3 + }, + "Port": 6081, + "Protocol": "tencent_geneve", + "RegisteredInstancesCount": 1, + "ScheduleAlgorithm": "ip_hash_3_elastic", + "TargetGroupId": "lbtg-kbsv74pw", + "TargetGroupName": "targetgroup1727599151", + "UpdatedTime": "2024-10-15T00:00:00+00:00", + "VpcId": "vpc-ojtgv3oh" + }, + { + "AllDeadToAlive": true, + "AssociatedRule": null, + "AssociatedRuleCount": 0, + "CreatedTime": "2024-10-15T00:00:00+00:00", "HealthCheck": { + "HealthNum": 3, "HealthSwitch": true, - "Protocol": "abc", + "IntervalTime": 5, "Port": 0, - "Timeout": 0, - "IntervalTime": 0, - "HealthNum": 0, - "UnHealthNum": 0 + "Protocol": "icmp", + "Timeout": 2, + "UnHealthNum": 3 }, + "Port": 6081, + "Protocol": "tencent_geneve", + "RegisteredInstancesCount": 0, + "ScheduleAlgorithm": "ip_hash_3_elastic", + "TargetGroupId": "lbtg-141xpe2w", + "TargetGroupName": "targetgroup1727175745", + "UpdatedTime": "2024-10-15T00:00:00+00:00", + "VpcId": "vpc-ojtgv3oh" + }, + { "AllDeadToAlive": true, - "AssociatedRuleCount": 0 + "AssociatedRule": null, + "AssociatedRuleCount": 0, + "CreatedTime": "2024-10-15T00:00:00+00:00", + "HealthCheck": { + "HealthNum": 3, + "HealthSwitch": true, + "IntervalTime": 5, + "Port": 0, + "Protocol": "icmp", + "Timeout": 2, + "UnHealthNum": 3 + }, + "Port": 6081, + "Protocol": "tencent_geneve", + "RegisteredInstancesCount": 0, + "ScheduleAlgorithm": "ip_hash_3_elastic", + "TargetGroupId": "lbtg-myhtwkrw", + "TargetGroupName": "targetgroup1726747698", + "UpdatedTime": "2024-10-15T00:00:00+00:00", + "VpcId": "vpc-ojtgv3oh" } ], - "RequestId": "abc" + "TotalCount": 3 } } ``` diff --git a/tccli/examples/gwlb/v20240906/ModifyTargetGroupInstancesWeight.md b/tccli/examples/gwlb/v20240906/ModifyTargetGroupInstancesWeight.md index ffaa3a1f70..4c8f3c25b0 100644 --- a/tccli/examples/gwlb/v20240906/ModifyTargetGroupInstancesWeight.md +++ b/tccli/examples/gwlb/v20240906/ModifyTargetGroupInstancesWeight.md @@ -8,7 +8,7 @@ Input: tccli gwlb ModifyTargetGroupInstancesWeight --cli-unfold-argument \ --TargetGroupId lbtg-815iz538 \ --TargetGroupInstances.0.BindIP 172.16.0.34 \ - --TargetGroupInstances.0.Port 1234 \ + --TargetGroupInstances.0.Port 6081 \ --TargetGroupInstances.0.Weight 55 ``` diff --git a/tccli/examples/lcic/v20220817/CreateRoom.md b/tccli/examples/lcic/v20220817/CreateRoom.md index 5b4e015023..69db0385ad 100644 --- a/tccli/examples/lcic/v20220817/CreateRoom.md +++ b/tccli/examples/lcic/v20220817/CreateRoom.md @@ -6,22 +6,22 @@ Input: ``` tccli lcic CreateRoom --cli-unfold-argument \ - --Name abc \ + --Name abcdfdsf \ --StartTime 1 \ --EndTime 1 \ - --TeacherId abc \ + --TeacherId abcdfgdf \ --SdkAppId 1 \ --Resolution 1 \ --MaxMicNumber 1 \ --AutoMic 1 \ --TurnOffMic 1 \ --AudioQuality 1 \ - --SubType abc \ + --SubType abcdfgd \ --DisableRecord 1 \ - --Assistants abc \ + --Assistants abcxdfgdfg \ --AudienceType 1 \ --RecordLayout 1 \ - --GroupId abc \ + --GroupId abcdfgdf \ --InteractionMode 1 \ --VideoOrientation 1 \ --IsGradingRequiredPostClass 1 \ @@ -34,7 +34,7 @@ Output: { "Response": { "RoomId": 1, - "RequestId": "abc" + "RequestId": "abcdfgdfgfdrg" } } ``` diff --git a/tccli/examples/lighthouse/v20200324/DescribeFirewallRules.md b/tccli/examples/lighthouse/v20200324/DescribeFirewallRules.md index cb93315a86..4308fccf90 100644 --- a/tccli/examples/lighthouse/v20200324/DescribeFirewallRules.md +++ b/tccli/examples/lighthouse/v20200324/DescribeFirewallRules.md @@ -34,7 +34,7 @@ Output: "Action": "ACCEPT", "AppType": "HTTP(80)", "CidrBlock": "0.0.0.0/0", - "FirewallRuleDescription": "test", + "FirewallRuleDescription": "放通TCP端口(80)", "Port": "80", "Protocol": "TCP" }, diff --git a/tccli/examples/lighthouse/v20200324/DescribeKeyPairs.md b/tccli/examples/lighthouse/v20200324/DescribeKeyPairs.md index b90bbc540d..4a3f854f4a 100644 --- a/tccli/examples/lighthouse/v20200324/DescribeKeyPairs.md +++ b/tccli/examples/lighthouse/v20200324/DescribeKeyPairs.md @@ -17,7 +17,7 @@ Output: "KeyPairSet": [ { "KeyId": "lhkp-omd12oc1", - "KeyName": "test", + "KeyName": "koc1", "PublicKey": "", "AssociatedInstanceIds": [], "CreatedTime": "2020-04-28T23:01:47Z", diff --git a/tccli/examples/mongodb/v20180408/CreateDBInstance.md b/tccli/examples/mongodb/v20180408/CreateDBInstance.md index 7a8bd573b8..1d607131aa 100644 --- a/tccli/examples/mongodb/v20180408/CreateDBInstance.md +++ b/tccli/examples/mongodb/v20180408/CreateDBInstance.md @@ -6,17 +6,17 @@ Input: ``` tccli mongodb CreateDBInstance --cli-unfold-argument \ - --Memory 4 \ - --Volume 250 \ - --GoodsNum 1 \ --Zone ap-guangzhou-2 \ --UniqVpcId vpc-0akbol5v \ - --UniqSubnetId subnet-fyrtjbqw \ + --TimeSpan 1 \ --ProjectId 0 \ - --MongoVersion MONGO_3_WT \ --MachineCode TGIO \ + --GoodsNum 1 \ + --Volume 250 \ --SecondaryNum 2 \ - --TimeSpan 1 \ + --UniqSubnetId subnet-fyrtjbqw \ + --Memory 4 \ + --MongoVersion MONGO_42_WT \ --Password pwd123456 ``` diff --git a/tccli/examples/mongodb/v20180408/DescribeClientConnections.md b/tccli/examples/mongodb/v20180408/DescribeClientConnections.md index fc15f0bcfc..40a4529d75 100644 --- a/tccli/examples/mongodb/v20180408/DescribeClientConnections.md +++ b/tccli/examples/mongodb/v20180408/DescribeClientConnections.md @@ -13,18 +13,14 @@ Output: ``` { "Response": { - "TotalCount": 0, "Clients": [ { - "Count": 1, - "IP": "xx" - }, - { - "Count": 1, - "IP": "xx" + "IP": "abc", + "Count": 1 } ], - "RequestId": "xx" + "TotalCount": 0, + "RequestId": "abc" } } ``` diff --git a/tccli/examples/mongodb/v20190725/DescribeCurrentOp.md b/tccli/examples/mongodb/v20190725/DescribeCurrentOp.md index b442765edc..e23e7bfa95 100644 --- a/tccli/examples/mongodb/v20190725/DescribeCurrentOp.md +++ b/tccli/examples/mongodb/v20190725/DescribeCurrentOp.md @@ -1,12 +1,12 @@ **Example 1: 查询云数据库实例的当前操作** - +查询云数据库实例的当前操作 Input: ``` tccli mongodb DescribeCurrentOp --cli-unfold-argument \ - --InstanceId cmgo-p8vnipr5 + --InstanceId cmgo-p8vn**** ``` Output: @@ -16,18 +16,19 @@ Output: "TotalCount": 1, "CurrentOps": [ { - "ReplicaSetName": "xx", - "NodeName": "xx", - "State": "xx", - "MicrosecsRunning": 1, - "Query": "xx", - "OpId": 0, - "Ns": "xx", - "Operation": "xx", - "Op": "xx" + "OpId": 1804858933, + "Ns": "db.****", + "Query": "", + "Op": "command", + "ReplicaSetName": "salve-1", + "NodeName": "salve-1", + "Operation": "****", + "State": "Primary", + "MicrosecsRunning": 30353723, + "ExecNode": "从节点" } ], - "RequestId": "xx" + "RequestId": "66956cf3-2d10-4c68-87c0-7bd558deae7e" } } ``` diff --git a/tccli/examples/mongodb/v20190725/FlashBackDBInstance.md b/tccli/examples/mongodb/v20190725/FlashBackDBInstance.md index 3f04397182..ac1d6c7e6b 100644 --- a/tccli/examples/mongodb/v20190725/FlashBackDBInstance.md +++ b/tccli/examples/mongodb/v20190725/FlashBackDBInstance.md @@ -11,10 +11,10 @@ tccli mongodb FlashBackDBInstance --cli-unfold-argument \ --TargetDatabases.0.DBName my_test \ --TargetDatabases.0.Collections.0.CollectionName my_test1 \ --TargetDatabases.0.Collections.0.KeyValues.0.Key name \ - --TargetDatabases.0.Collections.0.KeyValues.0.Value abc \ + --TargetDatabases.0.Collections.0.KeyValues.0.Value name-demo \ --TargetDatabases.0.Collections.0.TargetResultCollectionName my_test_bak0804143230 \ --TargetDatabases.0.Collections.0.FilterKey name \ - --TargetInstanceId cmgo-05173fe7 + --TargetInstanceId cmgo-0517**** ``` Output: @@ -22,7 +22,7 @@ Output: { "Response": { "FlowId": 1234567, - "RequestId": "abc" + "RequestId": "59b477da-6473-4ea8-85b3-7f4473744****" } } ``` diff --git a/tccli/examples/monitor/v20180724/CreateExporterIntegration.md b/tccli/examples/monitor/v20180724/CreateExporterIntegration.md index 4c059835f2..bd8a13677a 100644 --- a/tccli/examples/monitor/v20180724/CreateExporterIntegration.md +++ b/tccli/examples/monitor/v20180724/CreateExporterIntegration.md @@ -345,7 +345,7 @@ Output: 3.5. spec.instanceSpec.reload_interval_minutes 表示实例刷新间隔，整数，单位是分钟，必填且必须大于等于 10。云产品实例的新增或者云标签的修改，会在刷新实例后反映在指标中，至多需要等待一个实例刷新间隔 3.6. spec.instanceSpec.useRole 表示是否使用服务角色，布尔类型，必填。当前逻辑一定会使用服务角色，所以必填 `true` 3.7. spec.instanceSpec.labels 用于给指标添加自定义标签，键值对类型，选填 -3.8. spec.exporterSpec.[云产品] 表示是否采集对应云产品，布尔类型，`true` 表示采集该云产品。云产品各编码指代含义：`cvm`:云服务器,`cbs`:云硬盘,`lb_public`:负载均衡(公网),`lb_private`:负载均衡(内网),`tgw_set`:负载均衡(独占集群),`cmongo`:数据库MongoDB,`cdb`:数据库MySQL(CDB),`redis`:数据库Redis(CKV版),`redis_mem`:数据库Redis(内存版),`tendis`:Tendis,`xstor`:CTSDB(InfluxDB版),`mariadb`:数据库MariaDB,`postgres`:数据库PostgreSQL,`tdmysql`:TDSQL MySQL版,`cynosdb_mysql`:TDSQL-C MySQL,`sqlserver`:数据库SQL Server,`nat_gateway`:NAT网关,`ckafka`:CKafka,`rocketmq`:RocketMQ(新指标),`lb`:弹性公网IP,`vpngw`:VPN网关,`vpnx`:VPN通道,`vpc_net_detect`:网络探测,`cdn`:CDN,`ov_cdn`:CND(海外),`cos`:COS,`dc`:专线接入-物理专线,`dcx`:专线接入-专用通道,`dcg`:专线接入-专线网关,`lighthouse`:轻量应用服务器,`nacos`:Nacos,`zookeeper`:Zookeeper,`ces`:Elasticsearch,`dts`:数据传输服务,`vbc`:云联网,`gaap`:全球应用加速,`waf`:Web应用防火墙,`cfs`:文件存储,`bwp`:共享带宽包,`scf_v2`:云函数(别名),`vod`:云点播(VOD),`cls`:日志服务(CLS)-日志主题,`apigateway`:API 网关,`ti_traintask`:TI-ONE(任务式建模),`ti_notebook`:TI-ONE(Notebook),`ti_model`:TI-ONE(在线服务),`self`:采集器自监控 +3.8. spec.exporterSpec.[云产品] 表示是否采集对应云产品，布尔类型，`true` 表示采集该云产品。云产品各编码指代含义：`cvm`:云服务器,`cbs`:云硬盘,`lb_public`:负载均衡(公网),`lb_private`:负载均衡(内网),`tgw_set`:负载均衡(独占集群),`cmongo`:数据库MongoDB,`cdb`:数据库MySQL(CDB),`redis`:数据库Redis(CKV版),`redis_mem`:数据库Redis(内存版),`tendis`:Tendis,`xstor`:CTSDB(InfluxDB版),`mariadb`:数据库MariaDB,`postgres`:数据库PostgreSQL,`tdmysql`:TDSQL MySQL版,`cynosdb_mysql`:TDSQL-C MySQL,`sqlserver`:数据库SQL Server,`nat_gateway`:NAT网关,`ckafka`:CKafka,`rocketmq`:RocketMQ(新指标),`lb`:弹性公网IP,`vpngw`:VPN网关,`vpnx`:VPN通道,`vpc_net_detect`:网络探测,`cdn`:CDN,`ov_cdn`:CDN(海外),`cos`:COS,`dc`:专线接入-物理专线,`dcx`:专线接入-专用通道,`dcg`:专线接入-专线网关,`lighthouse`:轻量应用服务器,`nacos`:Nacos,`zookeeper`:Zookeeper,`ces`:Elasticsearch,`dts`:数据传输服务,`vbc`:云联网,`gaap`:全球应用加速,`waf`:Web应用防火墙,`cfs`:文件存储,`bwp`:共享带宽包,`scf_v2`:云函数(别名),`vod`:云点播(VOD),`cls`:日志服务(CLS)-日志主题,`apigateway`:API 网关,`ti_traintask`:TI-ONE(任务式建模),`ti_notebook`:TI-ONE(Notebook),`ti_model`:TI-ONE(在线服务),`self`:采集器自监控 2.9. spec.scrapeSpec.relabelConfigs 用于添加 `metricRelabelings` 配置，选填。该配置是 prometheus-operator 的 relabel 配置，部分字段与 prometheus 原生 relabel 配置不同，具体可参考[官方配置说明](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.RelabelConfig) Input: diff --git a/tccli/examples/mqtt/v20240516/DescribeDeviceCertificate.md b/tccli/examples/mqtt/v20240516/DescribeDeviceCertificate.md index 1195bfc0e0..d406c164a3 100644 --- a/tccli/examples/mqtt/v20240516/DescribeDeviceCertificate.md +++ b/tccli/examples/mqtt/v20240516/DescribeDeviceCertificate.md @@ -18,7 +18,7 @@ Output: "Response": { "CaSn": "1b1e3bf3702110125887a3a721a7e66f05522513", "CertificateSource": "API", - "ClientId": "111", + "ClientId": "client1", "CreatedTime": 1724050379000, "DeviceCertificate": "-----BEGIN CERTIFICATE-----\nMIIEQjCCAyqgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmREwDQYJKoZIhvcNAQEL\n-----END CERTIFICATE-----\n", "DeviceCertificateCn": "mqtt-test.xxx.tencent.com", diff --git a/tccli/examples/ssl/v20191205/DescribeCompanies.md b/tccli/examples/ssl/v20191205/DescribeCompanies.md index c074fb2571..d10b21d22e 100644 --- a/tccli/examples/ssl/v20191205/DescribeCompanies.md +++ b/tccli/examples/ssl/v20191205/DescribeCompanies.md @@ -22,7 +22,7 @@ Output: "CompanyAddress": "深南大道", "CompanyPhone": "2132323", "IdType": "", - "IdNumber": "xxx" + "IdNumber": "" } ], "RequestId": "5779b652-9c64-45b3-a6f4-641db7376a2e" diff --git a/tccli/examples/sts/v20180813/AssumeRoleWithSAML.md b/tccli/examples/sts/v20180813/AssumeRoleWithSAML.md index 53fc27feca..2a0bf6eef7 100644 --- a/tccli/examples/sts/v20180813/AssumeRoleWithSAML.md +++ b/tccli/examples/sts/v20180813/AssumeRoleWithSAML.md @@ -9,7 +9,7 @@ tccli sts AssumeRoleWithSAML --cli-unfold-argument \ --RoleArn qcs::cam::uin/798950673:roleName/OneLogin-Role \ --PrincipalArn qcs::cam::uin/798950673:saml-provider/OneLogin \ --SAMLAssertion c2FtbCBhc3NlcnRpb24= \ - --RoleSessionName test + --RoleSessionName GetSamlRole ``` Output: diff --git a/tccli/examples/tdid/v20210519/CreatePresentation.md b/tccli/examples/tdid/v20210519/CreatePresentation.md index 64f3a7b15f..bb5734da6e 100644 --- a/tccli/examples/tdid/v20210519/CreatePresentation.md +++ b/tccli/examples/tdid/v20210519/CreatePresentation.md @@ -9,7 +9,7 @@ tccli tdid CreatePresentation --cli-unfold-argument \ --DAPId 1 \ --CredentialList.0.Credential {"cptId":1,"issuer":"did:tdid:w1:0x379106c7232aed1a50e8600511655b479c76b149","expirationDate":"2124-06-29T15:25:00+08:00","issuanceDate":"2023-11-30T05:19:40+08:00","context":"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1","id":"0767cc1f93ad541e195bd9f5f00d665f","type":["VerifiableCredential"],"credentialSubject":{"action":"deactiveDid","age":17},"proof":{"created":"2023-11-30T05:19:40+08:00","creator":"did:tdid:w1:0x379106c7232aed1a50e8600511655b479c76b149#keys-0","signatureValue":"MEQCIEWnreXh0siSPnCaAqCldL1E+gTdrT6oSZjbTjAhwn6+AiBXn/ZIirpr69JknKsX3+MWRE7WeIXGdaOIXY10c36hoA==","type":"Secp256r1","metaDigest":"7d6435235cd5afdb7abd06a979eb2237d103401bdb54fa38ff6b8299c7529b76","vcDigest":"d014b006648f48e13c1aff9c16a39979e3d17e6f32c816065158d6a92632a132","privacy":"Public","salt":{"action":"YuzFn","age":"0zche"}}} \ --Did did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8 \ - --VerifyCode test \ + --VerifyCode 1001 \ --PolicyJson {"1":{"age":0}} ``` diff --git a/tccli/examples/tdid/v20210519/QueryAuthorityInfo.md b/tccli/examples/tdid/v20210519/QueryAuthorityInfo.md index 0dc5996142..1306205141 100644 --- a/tccli/examples/tdid/v20210519/QueryAuthorityInfo.md +++ b/tccli/examples/tdid/v20210519/QueryAuthorityInfo.md @@ -8,7 +8,7 @@ Input: tccli tdid QueryAuthorityInfo --cli-unfold-argument \ --Did did:tdid:w1:0xbbf1dee9e082e1a54dd3973beedc59ff7e452862 \ --DAPId 5 \ - --Name test + --Name 某教育学院 ``` Output: @@ -17,9 +17,9 @@ Output: "Response": { "RequestId": "3d5e7818-5027-44ca-bb03-68a9d5389bca", "Did": "did:tdid:w1:0xbbf1dee9e082e1a54dd3973beedc59ff7e452862", - "Name": "test", + "Name": "某教育学院", "Status": 1, - "Description": "test", + "Description": "职业教育", "RecognizeTime": "2023-09-19 11:54:25" } } diff --git a/tccli/examples/tdid/v20210519/SetTDidAttribute.md b/tccli/examples/tdid/v20210519/SetTDidAttribute.md index cb4479dec6..26c8e67ecd 100644 --- a/tccli/examples/tdid/v20210519/SetTDidAttribute.md +++ b/tccli/examples/tdid/v20210519/SetTDidAttribute.md @@ -7,8 +7,8 @@ Input: ``` tccli tdid SetTDidAttribute --cli-unfold-argument \ --Did did:tdid:w1:0x0d342759f20005df531c50f671d414661e381c01 \ - --Attributes.0.Key test \ - --Attributes.0.Val test \ + --Attributes.0.Key name \ + --Attributes.0.Val 张三 \ --DAPId 5 ``` diff --git a/tccli/examples/tdid/v20210519/VerifyPresentation.md b/tccli/examples/tdid/v20210519/VerifyPresentation.md index ecd76dd1cf..480a3ce221 100644 --- a/tccli/examples/tdid/v20210519/VerifyPresentation.md +++ b/tccli/examples/tdid/v20210519/VerifyPresentation.md @@ -9,7 +9,7 @@ tccli tdid VerifyPresentation --cli-unfold-argument \ --Did did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8 \ --PresentationData {"context":["https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1"],"holder":"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8","proof":{"created":"2023-09-12T16:14:56+08:00","nonce":"test","signatureValue":"MEYCIQC4Wmf0NTlNF9BOjyynLasqWQJF4M34oIiemCa2Jl6+1wIhANqKc4/sWbuQmcpp7ilNrpfZQU4Cj0+VqcQcN+/jZH5u","type":"Secp256r1","verificationMethod":"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8#keys-0"},"type":["VerifiablePresentation"],"verifiableCredential":[{"context":"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1","cptId":1,"credentialSubject":{"action":"deactiveDid","age":"0x7cc931132828080cac176a6bf266077bc963d3a8d4afacb147eb7a5fa9d38176","ageCommitment":"/nQps1EGGKMJEEIZhlNu9oFZWTSe6bR5e2w71+/JSgE="},"expirationDate":"2024-06-29T15:25:00+08:00","id":"0971a8c6a1ff17d9b85abaab5e02c50d","issuanceDate":"2023-09-12T15:50:52+08:00","issuer":"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8","proof":{"created":"2023-09-12T15:50:52+08:00","creator":"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8#keys-0","metaDigest":"da11a3571b4920ebdac1b73b03c696606a3b1c380e6502bcb30484d8240ae28d","privacy":"Public","salt":{"action":"0UU2V","age":"0","ageCommitment":"XiqAq"},"signatureValue":"MEQCIHGw37fwROCoqUEz9Rtw2CG3pQP6QYxe2byS45LIlPBmAiBrS93DNqRtVYKUq8dZ4ZUTSgt9Ajr9rzqLB3KZz9ADIg==","type":"Secp256r1","vcDigest":"230653978a8dc2c16f6acfa7bfb779a34d282fb7fd2eae5646c9e3ba95589344"},"type":["VerifiableCredential"]}]} \ --DAPId 1 \ - --VerifyCode test + --VerifyCode 1001 ``` Output: diff --git a/tccli/examples/vpc/v20170312/CreateVpnGateway.md b/tccli/examples/vpc/v20170312/CreateVpnGateway.md index 998bde0dc8..b759a78768 100644 --- a/tccli/examples/vpc/v20170312/CreateVpnGateway.md +++ b/tccli/examples/vpc/v20170312/CreateVpnGateway.md @@ -17,28 +17,34 @@ Output: { "Response": { "VpnGateway": { - "VpnGatewayQuotaSet": [], - "MaxConnection": 5, - "VpcId": "vpc-test", + "VpnGatewayId": "vpngw-awdawc", + "VpcId": "vpc-adxczc", + "VpnGatewayName": "vpn-name", + "Type": "IPSEC", + "State": "Pending", + "PublicIpAddress": "13.15.41.4", "RenewFlag": "", - "Zone": "ap-bangkok-1", - "VpnGatewayName": "test", "InstanceChargeType": "POSTPAID_BY_HOUR", - "CdcId": "", - "IsAddressBlocked": true, "InternetMaxBandwidthOut": 10, - "State": "Pending", - "Version": "", - "VpnGatewayId": "vpngw-xxxxx", - "PublicIpAddress": "12.3.1.3", "CreatedTime": "2020-09-22 00:00:00", - "NewPurchasePlan": "", "ExpiredTime": "2020-09-22 00:00:00", - "Type": "IPSEC", + "IsAddressBlocked": false, + "NewPurchasePlan": "", + "RestrictState": "NORMAL", + "Zone": "", + "VpnGatewayQuotaSet": [ + { + "Bandwidth": 5, + "Cname": "微小型", + "Name": "cdmini" + } + ], + "Version": "ver3.1", "NetworkInstanceId": "", - "RestrictState": "NORMAL" + "CdcId": "", + "MaxConnection": 10 }, - "RequestId": "fa15cd12-e329-1261-c585-3c3ae5c55211" + "RequestId": "b2187525-ab9d-42cb-82ee-998ead365bbe" } } ``` diff --git a/tccli/examples/wedata/v20210820/CreateHiveTableByDDL.md b/tccli/examples/wedata/v20210820/CreateHiveTableByDDL.md index a8002dd875..bc1eb6d8d9 100644 --- a/tccli/examples/wedata/v20210820/CreateHiveTableByDDL.md +++ b/tccli/examples/wedata/v20210820/CreateHiveTableByDDL.md @@ -12,14 +12,16 @@ tccli wedata CreateHiveTableByDDL --cli-unfold-argument \ --Incharge 231232 \ --Privilege 0 \ --ProjectId 124537 \ - --Type HIVE + --Type HIVE \ + --Async True ``` Output: ``` { "Response": { - "Data": "true", + "Data": "tablename", + "TaskId": "25", "RequestId": "as1cs2c123asyi23bh213cc" } } diff --git a/tccli/examples/wedata/v20210820/DescribeDsFolderTree.md b/tccli/examples/wedata/v20210820/DescribeDsFolderTree.md index 1640360d71..93f61a7f92 100644 --- a/tccli/examples/wedata/v20210820/DescribeDsFolderTree.md +++ b/tccli/examples/wedata/v20210820/DescribeDsFolderTree.md @@ -54,3 +54,27 @@ Output: } ``` +**Example 2: 错误示例** + +错误示例 + +Input: + +``` +tccli wedata DescribeDsFolderTree --cli-unfold-argument \ + --ProjectId 1111 +``` + +Output: +``` +{ + "Response": { + "Error": { + "Code": "UnauthorizedOperation", + "Message": "当前用户角色或WeData版本没有权限，请进行角色授权或者升级WeData版本" + }, + "RequestId": "78deafe3-7320-448e-a6a5-2fcb38a4e4a5" + } +} +``` + diff --git a/tccli/examples/wedata/v20210820/DescribeOpsMakePlans.md b/tccli/examples/wedata/v20210820/DescribeOpsMakePlans.md index a76e07cbbc..5bdbb12d3c 100644 --- a/tccli/examples/wedata/v20210820/DescribeOpsMakePlans.md +++ b/tccli/examples/wedata/v20210820/DescribeOpsMakePlans.md @@ -23,44 +23,51 @@ Output: "PageSize": 0, "Items": [ { - "CheckParent": false, - "CompletePercent": 100, - "CreateTime": "2023-05-28 23:02:46", - "Creator": "creatorxxx", - "CreatorId": "10000000xxxx", - "IntegrationResourceGroup": "", - "MakeDatetimeList": [ + "PlanId": "abc", + "MakeName": "abc", + "ProjectId": "abc", + "CheckParent": true, + "SameSelfDependType": true, + "ParallelNum": 0, + "SameCycle": true, + "SourceTaskCycle": "abc", + "TargetTaskCycle": "abc", + "TargetTaskAction": 0, + "MapParamList": [ { - "EndDate": "2023-05-26", - "EndTime": "03:59", - "StartDate": "2023-05-26", - "StartTime": "03:00" + "K": "abc", + "V": "abc" } ], - "MakeName": "patch_20230528230215_xx", - "MapParamList": [], - "ParallelNum": 4, - "PlanId": "e0bed861-0e95-44ca-9d10-28f2xxxxxxxx", - "ProjectId": "14705616027xxxxxxxx", - "Remark": null, - "SameCycle": true, - "SameSelfDependType": false, - "SchedulerResourceGroup": "", - "SourceTaskCycle": null, - "SuccessPercent": 100, - "TargetTaskAction": 1, - "TargetTaskCycle": "month", - "TaskCount": 1, + "CreatorId": "abc", + "Creator": "abc", + "CreateTime": "abc", "TaskIdList": [ - "2023052809431xxxx" + "abc" + ], + "MakeDatetimeList": [ + { + "StartDate": "abc", + "EndDate": "abc", + "StartTime": "abc", + "EndTime": "abc" + } ], - "SchedulerResourceGroupName": null, - "IntegrationResourceGroupName": null, - "CheckParentType": null + "Remark": "abc", + "SchedulerResourceGroup": "abc", + "SchedulerResourceGroupName": "abc", + "IntegrationResourceGroup": "abc", + "IntegrationResourceGroupName": "abc", + "TaskCount": 0, + "CompletePercent": 0, + "SuccessPercent": 0, + "CheckParentType": "abc", + "SameSelfWorkflowDependType": true, + "SelfWorkflowDependency": "abc" } ] }, - "RequestId": "f47ac10b-58cc-4372-a567-0e02b2c3d479" + "RequestId": "abc" } } ``` diff --git a/tccli/examples/wedata/v20210820/DescribeSchedulerTaskCntByStatus.md b/tccli/examples/wedata/v20210820/DescribeSchedulerTaskCntByStatus.md index f91caed601..95b92a27ce 100644 --- a/tccli/examples/wedata/v20210820/DescribeSchedulerTaskCntByStatus.md +++ b/tccli/examples/wedata/v20210820/DescribeSchedulerTaskCntByStatus.md @@ -15,21 +15,22 @@ Output: "Response": { "Data": [ { - "CountTag": 1, - "TotalNum": 1, - "RunningNum": 1, - "StoppingNum": 1, - "StoppedNum": 1, - "FrozenNum": 1, - "YearNum": 1, - "MonthNum": 1, - "WeekNum": 1, - "DayNum": 1, - "HourNum": 1, - "MinuteNum": 1 + "CountTag": 0, + "DayNum": 0, + "FrozenNum": 0, + "HourNum": 0, + "InvalidNum": 0, + "MinuteNum": 0, + "MonthNum": 0, + "RunningNum": 0, + "StoppedNum": 0, + "StoppingNum": 0, + "TotalNum": 0, + "WeekNum": 0, + "YearNum": 0 } ], - "RequestId": "abc" + "RequestId": "717516e8-fece-4821-850b-43b4379c816d" } } ``` diff --git a/tccli/services/apm/v20210622/api.json b/tccli/services/apm/v20210622/api.json index 19273609c3..9b4587f6b8 100644 --- a/tccli/services/apm/v20210622/api.json +++ b/tccli/services/apm/v20210622/api.json @@ -1199,16 +1199,7 @@ "members": [ { "disabled": false, - "document": "要过滤的维度信息：\nservice_metric视图支持：service.name（服务名）、span.kind（客户端/服务端视角）为维度进行过滤，service.name（服务名）必填。\nspan.kind:\n\tserver:服务端视角\n\tclient:客户端视角\n默认为服务端视角进行查询。\nruntime_metric视图支持：service.name（服务名）维度进行过滤，service.name（服务名）必填。\nsql_metric视图支持：service.name（服务名）、db.instance（数据库名称）、db.ip（数据库实例ip）维度进行过滤，查询service_slow_sql_count（慢sql）指标时service.name必填，查询sql_duration_avg（耗时）指标时db.instance（数据库名称）必填。", - "example": "{ \"Key\": \"service.name\", \"Value\": \"java-order-service\" } { \"Key", - "member": "GeneralFilter", - "name": "Filters", - "required": true, - "type": "list" - }, - { - "disabled": false, - "document": "需要查询的指标，不可自定义输入。\nservice_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。\nruntime_metric视图支持：service_gc_full_count（Full GC）。\nsql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。", + "document": "需要查询的指标名称，不可自定义输入，[详情请见。](https://cloud.tencent.com/document/product/248/101681)", "example": "\"service_request_count\"、“service_duration”", "member": "string", "name": "Metrics", @@ -1226,7 +1217,7 @@ }, { "disabled": false, - "document": "视图名称，不可自定义输入。支持：service_metric、runtime_metric、sql_metric。", + "document": "视图名称，不可自定义输入。[详情请见。](https://cloud.tencent.com/document/product/248/101681)", "example": "service_metric", "member": "string", "name": "ViewName", @@ -1235,7 +1226,16 @@ }, { "disabled": false, - "document": "聚合维度：\nservice_metric视图支持：service.name（服务名）、span.kind （客户端/服务端视角）维度进行聚合，service.name（服务名）必填。\nruntime_metric视图支持：service.name（服务名）维度进行聚合，service.name（服务名）必填。\nsql_metric视图支持：service.name（服务名）、db.statement（sql语句）维度进行聚合，查询service_slow_sql_count（慢sql）时service.name（服务名）必填，查询sql_duration_avg（耗时）指标时service.name（服务名）、db.statement（sql语句）必填。", + "document": "要过滤的维度信息，不同视图有对应的指标维度，[详情请见。](https://cloud.tencent.com/document/product/248/101681)", + "example": "{ \"Key\": \"service.name\", \"Value\": \"java-order-service\" } { \"Key", + "member": "GeneralFilter", + "name": "Filters", + "required": true, + "type": "list" + }, + { + "disabled": false, + "document": "聚合维度，不同视图有对应的指标维度，[详情请见。](https://cloud.tencent.com/document/product/248/101681)", "example": "\"service.name\"、\"span.kind\"", "member": "string", "name": "GroupBy", @@ -1271,7 +1271,7 @@ }, { "disabled": false, - "document": "对查询指标进行排序：\nservice_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。\nruntime_metric视图支持：service_gc_full_count（Full GC）。\nsql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。\nasc:对查询指标进行升序排序\ndesc：对查询指标进行降序排序", + "document": "对查询指标进行排序：\nKey 填写云 API 指标名称，[详情请见。](https://cloud.tencent.com/document/product/248/101681)\nValue 填写排序方式： \n- asc:对查询指标进行升序排序\n- desc：对查询指标进行降序排序", "example": "\"OrderBy\": { \t\"Key\": \"sql_duration_avg\", \"Value\": \"desc\"", "member": "OrderBy", "name": "OrderBy", @@ -1296,10 +1296,10 @@ { "disabled": false, "document": "指标结果集\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "无", + "example": "{ \"Response\": { \"Records\": [ { \"Tags\": [], \"MetricName\": \"sql_duration_avg\", \"MetricNameCN\": \"平均响应时间\", \"TimeSerial\": [ 1734407820, 1734407880, 1734407940, 1734408000, 1734408060, 1734408120, 1734408180, 1734408240, 1734408300, 1734408360, 1734408420, 1734408480, 1734408540, 1734408600, 1734408660, 1734408720, 1734408780, 1734408840, 1734408900, 1734408960, 1734409020, 1734409080, 1734409140, 1734409200, 1734409260, 1734409320, 1734409380, 1734409440, 1734409500, 1734409560, 1734409620, 1734409680, 1734409740, 1734409800, 1734409860, 1734409920, 1734409980, 1734410040, 1734410100, 1734410160, 1734410220, 1734410280, 1734410340, 1734410400, 1734410460, 1734410520, 1734410580, 1734410640, 1734410700, 1734410760, 1734410820, 1734410880, 1734410940, 1734411000, 1734411060, 1734411120, 1734411180, 1734411240, 1734411300, 1734411360 ], \"DataSerial\": [ 135728.648236258, 0.4060175286658243, 0.3906675029805307, 118792.06594650316, 0.4067952115687377, 0.41769455288609775, 0.41074237375891975, 0.40921561817335866, 0.41119494805273527, 135649.09198159442, 0.4107937310707512, 0.41151921192748936, 0.4117117637368341, 0.4152493163439583, 0.5001134962935645, 0.41283469768714603, 0.3979470199363206, 0.4083188880940849, 0.40551133267100636, 0.40927287475939206, 0.41014323602968256, 0.4012277709628799, 0.40407118324057745, 0.40985120011494, 0.4071479930279269, 0.3866005448018421, 0.40619437076582554, 0.40142698225557255, 0.40432155746295745, 0.4120485754463827, 0.40451016228819175, 135425.90797938255, 135542.49266812875, 0.40168924095565, 0.4070559973437187, 0.3987184602563491, 0.4076715755099571, 0.4026033027713935, 118990.898319586, 0.405708522267682, 0.404107562330523, 0.40059895515109356, 0.4049696567832813, 0.40152292066215045, 0.3943229870897469, 0.39939697181964084, 0.42871168611138843, 0.39514465476451965, 0.39055195114837243, 0.39710768149694586, 0.40585406731762813, 0.41346395100750705, 0.4089005831960684, 0.4018122312399444, 0.3928633017418557, 0.41502474452429317, 0.4065864888888889, 0.4112395803749857, 0.4158375517725035, null ] } ], \"RequestId\": \"test-test-test\" } }", "member": "Line", "name": "Records", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, diff --git a/tccli/services/apm/v20210622/examples.json b/tccli/services/apm/v20210622/examples.json index 6e7f408403..b24ae988e8 100644 --- a/tccli/services/apm/v20210622/examples.json +++ b/tccli/services/apm/v20210622/examples.json @@ -34,34 +34,28 @@ ], "DescribeGeneralMetricData": [ { - "document": "该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的service_gc_full_count（Full GC）的指标数据。", - "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralMetricData\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"tapm-api-ap-beijing\"\n }\n ],\n \"ViewName\": \"runtime_metric\",\n \"InstanceId\": \"apm-ylTJfTSbn\",\n \"Period\": 60,\n \"Metrics\": [\n \"service_gc_full_count\"\n ],\n \"StartTime\": \"1652666416\",\n \"EndTime\": \"1652667616\",\n \"GroupBy\": [\n \"service.name\"\n ]\n}", - "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n }\n ],\n \"MetricName\": \"service_gc_full_count\",\n \"MetricNameCN\": \"full GC\",\n \"TimeSerial\": [\n 1656428160,\n 1656428220,\n 1656428280,\n 1656428340,\n 1656428400,\n 1656428460,\n 1656428520,\n 1656428580,\n 1656428640,\n 1656428700,\n 1656428760,\n 1656428820,\n 1656428880\n ],\n \"DataSerial\": [\n 0.016666666666666666,\n 0,\n 0.016666666666666666,\n 0,\n 0.016666666666666666,\n 0.016666666666666666,\n 0,\n 0.016666666666666666,\n 0,\n 0.016666666666666666,\n 0.016666666666666666,\n 0,\n 0.016666666666666666\n ]\n }\n ],\n \"RequestId\": \"test-test-test\"\n }\n}", - "title": "查询1分钟聚合粒度的runtime_metric指标数据示例" + "document": "该示例查询实例为 apm-059oXBfTL，按照 service.name（服务名）、span.kind（客户端/服务端视角）为维度过滤，以 service.name（服务名）、span.kind（客户端/服务端视角）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的 request_count（请求数量）、error_request_count（错误请求数量）、duration_avg（平均响应时间）、slow_request_count（慢请求数量）、duration_p50（耗时 p50）的指标数据。", + "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralMetricData\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"ViewName\": \"service_metric\",\n \"InstanceId\": \"apm-059oXBfTL\",\n \"Period\": 60,\n \"Metrics\": [\n \"request_count\",\n \"error_request_count\",\n \"duration_avg\",\n \"slow_request_count\",\n \"duration_p50\"\n ],\n \"StartTime\": 1734415200,\n \"EndTime\": 1734418800,\n \"GroupBy\": [\n \"service.name\",\n \"span.kind\"\n ]\n}", + "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"request_count\",\n \"MetricNameCN\": \"总请求数\",\n \"TimeSerial\": [\n 1734415200,\n 1734415260,\n 1734415320,\n 1734415380,\n 1734415440,\n 1734415500,\n 1734415560,\n 1734415620,\n 1734415680,\n 1734415740,\n 1734415800,\n 1734415860,\n 1734415920,\n 1734415980,\n 1734416040,\n 1734416100,\n 1734416160,\n 1734416220,\n 1734416280,\n 1734416340,\n 1734416400,\n 1734416460,\n 1734416520,\n 1734416580,\n 1734416640,\n 1734416700,\n 1734416760,\n 1734416820,\n 1734416880,\n 1734416940,\n 1734417000,\n 1734417060,\n 1734417120,\n 1734417180,\n 1734417240,\n 1734417300,\n 1734417360,\n 1734417420,\n 1734417480,\n 1734417540,\n 1734417600,\n 1734417660,\n 1734417720,\n 1734417780,\n 1734417840,\n 1734417900,\n 1734417960,\n 1734418020,\n 1734418080,\n 1734418140,\n 1734418200,\n 1734418260,\n 1734418320,\n 1734418380,\n 1734418440,\n 1734418500,\n 1734418560,\n 1734418620,\n 1734418680,\n 1734418740\n ],\n \"DataSerial\": [\n 22,\n 32,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 32,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 26,\n 28,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 32,\n 12,\n 22,\n 22,\n 32,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 22,\n 32,\n 22,\n 12,\n 22,\n 22\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n }\n ],\n \"MetricName\": \"error_request_count\",\n \"MetricNameCN\": \"异常数量\",\n \"TimeSerial\": [\n 1734415200,\n 1734415260,\n 1734415320,\n 1734415380,\n 1734415440,\n 1734415500,\n 1734415560,\n 1734415620,\n 1734415680,\n 1734415740,\n 1734415800,\n 1734415860,\n 1734415920,\n 1734415980,\n 1734416040,\n 1734416100,\n 1734416160,\n 1734416220,\n 1734416280,\n 1734416340,\n 1734416400,\n 1734416460,\n 1734416520,\n 1734416580,\n 1734416640,\n 1734416700,\n 1734416760,\n 1734416820,\n 1734416880,\n 1734416940,\n 1734417000,\n 1734417060,\n 1734417120,\n 1734417180,\n 1734417240,\n 1734417300,\n 1734417360,\n 1734417420,\n 1734417480,\n 1734417540,\n 1734417600,\n 1734417660,\n 1734417720,\n 1734417780,\n 1734417840,\n 1734417900,\n 1734417960,\n 1734418020,\n 1734418080,\n 1734418140,\n 1734418200,\n 1734418260,\n 1734418320,\n 1734418380,\n 1734418440,\n 1734418500,\n 1734418560,\n 1734418620,\n 1734418680,\n 1734418740\n ],\n \"DataSerial\": [\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": [\n 1734415200,\n 1734415260,\n 1734415320,\n 1734415380,\n 1734415440,\n 1734415500,\n 1734415560,\n 1734415620,\n 1734415680,\n 1734415740,\n 1734415800,\n 1734415860,\n 1734415920,\n 1734415980,\n 1734416040,\n 1734416100,\n 1734416160,\n 1734416220,\n 1734416280,\n 1734416340,\n 1734416400,\n 1734416460,\n 1734416520,\n 1734416580,\n 1734416640,\n 1734416700,\n 1734416760,\n 1734416820,\n 1734416880,\n 1734416940,\n 1734417000,\n 1734417060,\n 1734417120,\n 1734417180,\n 1734417240,\n 1734417300,\n 1734417360,\n 1734417420,\n 1734417480,\n 1734417540,\n 1734417600,\n 1734417660,\n 1734417720,\n 1734417780,\n 1734417840,\n 1734417900,\n 1734417960,\n 1734418020,\n 1734418080,\n 1734418140,\n 1734418200,\n 1734418260,\n 1734418320,\n 1734418380,\n 1734418440,\n 1734418500,\n 1734418560,\n 1734418620,\n 1734418680,\n 1734418740\n ],\n \"DataSerial\": [\n 191.5860133181818,\n 191.2110746363636,\n 191.23246599999996,\n 191.5040949090909,\n 191.934274,\n 192.05015977272723,\n 191.4917418636364,\n 191.7598401818182,\n 191.47329104545454,\n 191.35408840909093,\n 191.7695753181818,\n 192.1501132727273,\n 191.6614135,\n 191.72522395454544,\n 193.92501624242422,\n 209.9224584090909,\n 192.50587436363637,\n 193.14908313636363,\n 200.8337476363636,\n 192.21551695454545,\n 191.87317959090907,\n 191.85476931818184,\n 192.0314575909091,\n 192.14624168181817,\n 192.0624055,\n 192.35865707575758,\n 191.87331737878793,\n 191.806969,\n 192.35163881818187,\n 192.29478813636362,\n 192.3707790454545,\n 191.8557721363636,\n 191.59646177272725,\n 191.55687904545456,\n 191.59595163636365,\n 191.84944554545453,\n 191.78630649999997,\n 191.91973590909092,\n 191.90514081818182,\n 191.9165850909091,\n 191.98103199999997,\n 191.98323287878785,\n 193.0803381818182,\n 192.14093727272729,\n 192.24286899999998,\n 192.6753041818182,\n 192.2717468636364,\n 192.41461836363635,\n 192.3725805,\n 191.84485977272726,\n 191.85852840909092,\n 191.86218731818178,\n 191.6467590454545,\n 191.52699904545452,\n 191.57099809090911,\n 192.2197160909091,\n 191.91881845454546,\n 191.98860699999997,\n 224.0602859090909,\n 192.05223709090907\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"slow_request_count\",\n \"MetricNameCN\": \"慢调用\",\n \"TimeSerial\": [\n 1734415200,\n 1734415260,\n 1734415320,\n 1734415380,\n 1734415440,\n 1734415500,\n 1734415560,\n 1734415620,\n 1734415680,\n 1734415740,\n 1734415800,\n 1734415860,\n 1734415920,\n 1734415980,\n 1734416040,\n 1734416100,\n 1734416160,\n 1734416220,\n 1734416280,\n 1734416340,\n 1734416400,\n 1734416460,\n 1734416520,\n 1734416580,\n 1734416640,\n 1734416700,\n 1734416760,\n 1734416820,\n 1734416880,\n 1734416940,\n 1734417000,\n 1734417060,\n 1734417120,\n 1734417180,\n 1734417240,\n 1734417300,\n 1734417360,\n 1734417420,\n 1734417480,\n 1734417540,\n 1734417600,\n 1734417660,\n 1734417720,\n 1734417780,\n 1734417840,\n 1734417900,\n 1734417960,\n 1734418020,\n 1734418080,\n 1734418140,\n 1734418200,\n 1734418260,\n 1734418320,\n 1734418380,\n 1734418440,\n 1734418500,\n 1734418560,\n 1734418620,\n 1734418680,\n 1734418740\n ],\n \"DataSerial\": [\n 2,\n 3,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 3,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 3,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 3,\n 1,\n 2,\n 2,\n 3,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 2,\n 3,\n 2,\n 1,\n 2,\n 2\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"duration_p50\",\n \"MetricNameCN\": \"P50 响应时间\",\n \"TimeSerial\": [\n 1734415200,\n 1734415260,\n 1734415320,\n 1734415380,\n 1734415440,\n 1734415500,\n 1734415560,\n 1734415620,\n 1734415680,\n 1734415740,\n 1734415800,\n 1734415860,\n 1734415920,\n 1734415980,\n 1734416040,\n 1734416100,\n 1734416160,\n 1734416220,\n 1734416280,\n 1734416340,\n 1734416400,\n 1734416460,\n 1734416520,\n 1734416580,\n 1734416640,\n 1734416700,\n 1734416760,\n 1734416820,\n 1734416880,\n 1734416940,\n 1734417000,\n 1734417060,\n 1734417120,\n 1734417180,\n 1734417240,\n 1734417300,\n 1734417360,\n 1734417420,\n 1734417480,\n 1734417540,\n 1734417600,\n 1734417660,\n 1734417720,\n 1734417780,\n 1734417840,\n 1734417900,\n 1734417960,\n 1734418020,\n 1734418080,\n 1734418140,\n 1734418200,\n 1734418260,\n 1734418320,\n 1734418380,\n 1734418440,\n 1734418500,\n 1734418560,\n 1734418620,\n 1734418680,\n 1734418740\n ],\n \"DataSerial\": [\n 10,\n 10,\n 9.375,\n 14,\n 14,\n 14,\n 10,\n 9.375,\n 9.285714285714285,\n 9.166666666666668,\n 10,\n 14,\n 14,\n 14,\n 15.714285714285714,\n 14.444444444444445,\n 14,\n 14,\n 14.444444444444445,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 13.333333333333332,\n 16.153846153846153,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 15.333333333333332,\n 16.666666666666664,\n 14,\n 14,\n 15.333333333333332,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 14,\n 15.333333333333332,\n 14,\n 10,\n 14.444444444444445,\n 14\n ]\n }\n ],\n \"RequestId\": \"test-test-test\"\n }\n}", + "title": "查询1分钟聚合粒度的 service_metric 指标数据示例" }, { - "document": "该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）、span.kind（客户端/服务端视角）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）的指标数据。", - "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralMetricData\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"tapm-api-ap-beijing\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"ViewName\": \"service_metric\",\n \"InstanceId\": \"apm-ylTJfTSbn\",\n \"Period\": 60,\n \"Metrics\": [\n \"service_request_count\",\n \"service_duration\",\n \"service_error_req_rate\",\n \"service_slow_call_count\",\n \"service_error_request_count\"\n ],\n \"StartTime\": \"1652666416\",\n \"EndTime\": \"1652667616\",\n \"GroupBy\": [\n \"service.name\",\n \"span.kind\"\n ]\n}", - "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"service_request_count\",\n \"MetricNameCN\": \"总请求数\",\n \"TimeSerial\": [\n 1656428160,\n 1656428220,\n 1656428280,\n 1656428340,\n 1656428400,\n 1656428460,\n 1656428520,\n 1656428580,\n 1656428640,\n 1656428700,\n 1656428760,\n 1656428820,\n 1656428880\n ],\n \"DataSerial\": [\n 10372,\n 10578,\n 10430,\n 10486,\n 10393,\n 10509,\n 10556,\n 10443,\n 10560,\n 10491,\n 10417,\n 10507,\n 10447\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"service_duration\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": [\n 1656428160,\n 1656428220,\n 1656428280,\n 1656428340,\n 1656428400,\n 1656428460,\n 1656428520,\n 1656428580,\n 1656428640,\n 1656428700,\n 1656428760,\n 1656428820,\n 1656428880\n ],\n \"DataSerial\": [\n 68.27933527571001,\n 75.1680976742024,\n 73.70498622754624,\n 74.37902912946632,\n 75.79610287066045,\n 77.2206395084234,\n 69.26122643544272,\n 69.63079755913704,\n 65.73752328654751,\n 76.56275573601707,\n 70.60296113316045,\n 71.30283125911086,\n 70.25328283510882\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"service_error_req_rate\",\n \"MetricNameCN\": \"平均错误率\",\n \"TimeSerial\": [\n 1656428160,\n 1656428220,\n 1656428280,\n 1656428340,\n 1656428400,\n 1656428460,\n 1656428520,\n 1656428580,\n 1656428640,\n 1656428700,\n 1656428760,\n 1656428820,\n 1656428880\n ],\n \"DataSerial\": [\n 1.3594292325491708,\n 1.0115333711476648,\n 1.2655800575263663,\n 1.077627312607286,\n 1.1738670258828057,\n 1.1704253497002568,\n 1.1841606669192877,\n 1.0916403332375753,\n 1.0700757575757576,\n 0.9246020398436755,\n 1.12316405875012,\n 1.1040258875035691,\n 1.206087872116397\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"service_slow_call_count\",\n \"MetricNameCN\": \"慢调用\",\n \"TimeSerial\": [\n 1656428160,\n 1656428220,\n 1656428280,\n 1656428340,\n 1656428400,\n 1656428460,\n 1656428520,\n 1656428580,\n 1656428640,\n 1656428700,\n 1656428760,\n 1656428820,\n 1656428880\n ],\n \"DataSerial\": [\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"service_error_request_count\",\n \"MetricNameCN\": \"错误数\",\n \"TimeSerial\": [\n 1656428160,\n 1656428220,\n 1656428280,\n 1656428340,\n 1656428400,\n 1656428460,\n 1656428520,\n 1656428580,\n 1656428640,\n 1656428700,\n 1656428760,\n 1656428820,\n 1656428880\n ],\n \"DataSerial\": [\n 141,\n 107,\n 132,\n 113,\n 122,\n 123,\n 125,\n 114,\n 113,\n 97,\n 117,\n 116,\n 126\n ]\n }\n ],\n \"RequestId\": \"test-test-test\"\n }\n}", - "title": "查询1分钟聚合粒度的service_metric指标数据示例" + "document": "该示例查询实例为 apm-059oXBfTL，按照 service.name（服务名）、span.kind（客户端/服务端视角）为维度过滤，以 service.name（服务名）、span.kind（客户端/服务端视角）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的 request_count（请求数量）、error_request_count（错误请求数量）、duration_avg（平均响应时间）、slow_request_count（慢请求数量）、duration_p50（耗时 p50）的指标数据。", + "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralMetricData\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"ViewName\": \"service_metric\",\n \"InstanceId\": \"apm-059oXBfTL\",\n \"Metrics\": [\n \"request_count\",\n \"error_request_count\",\n \"duration_avg\",\n \"slow_request_count\",\n \"duration_p50\"\n ],\n \"StartTime\": 1734415200,\n \"EndTime\": 1734418800,\n \"GroupBy\": [\n \"service.name\",\n \"span.kind\"\n ]\n}", + "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"request_count\",\n \"MetricNameCN\": \"总请求数\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 1360\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"error_request_count\",\n \"MetricNameCN\": \"异常数量\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 0\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 192.96957006641412\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"slow_request_count\",\n \"MetricNameCN\": \"慢调用\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 124\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"MetricName\": \"duration_p50\",\n \"MetricNameCN\": \"P50 响应时间\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 13.443708609271523\n ]\n }\n ],\n \"RequestId\": \"test-test-test\"\n }\n}", + "title": "查询起始到终止时间内统计 service_metric 指标数据示例" }, { - "document": "该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）、span.kind（客户端/服务端视角）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内的service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）的指标数据。", - "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralMetricData\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"tapm-api-ap-beijing\"\n },\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"ViewName\": \"service_metric\",\n \"InstanceId\": \"apm-ylTJfTSbn\",\n \"Period\": \"0\",\n \"Metrics\": [\n \"service_request_count\",\n \"service_duration\",\n \"service_error_req_rate\",\n \"service_slow_call_count\",\n \"service_error_request_count\"\n ],\n \"StartTime\": \"1652666416\",\n \"EndTime\": \"1652667616\",\n \"GroupBy\": [\n \"service.name\",\n \"span.kind\"\n ]\n}", - "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Tags\": [\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n }\n ],\n \"MetricName\": \"service_request_count\",\n \"MetricNameCN\": \"总请求数\",\n \"TimeSerial\": null,\n \"DataSerial\": [\n 630381\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n }\n ],\n \"MetricName\": \"service_duration\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": null,\n \"DataSerial\": [\n 72.44506470564654\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n }\n ],\n \"MetricName\": \"service_error_req_rate\",\n \"MetricNameCN\": \"平均错误率\",\n \"TimeSerial\": null,\n \"DataSerial\": [\n 1.1464495281425042\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n }\n ],\n \"MetricName\": \"service_slow_call_count\",\n \"MetricNameCN\": \"慢调用\",\n \"TimeSerial\": null,\n \"DataSerial\": [\n 0\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n }\n ],\n \"MetricName\": \"service_error_request_count\",\n \"MetricNameCN\": \"错误数\",\n \"TimeSerial\": null,\n \"DataSerial\": [\n 7227\n ]\n }\n ],\n \"RequestId\": \"test-test-test\"\n }\n}", - "title": "查询起始到终止时间内统计service_metric指标数据示例" + "document": "该示例查询实例为 apm-059oXBfTL，按照 service.name（服务名）为维度过滤，以 service.name（服务名）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的 error_request_count（错误请求数量）、duration_avg（平均响应时间）的指标数据。", + "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralMetricData\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n }\n ],\n \"ViewName\": \"sql_metric\",\n \"InstanceId\": \"apm-059oXBfTL\",\n \"Period\": 60,\n \"Metrics\": [\n \"error_request_count\",\n \"duration_avg\"\n ],\n \"StartTime\": 1734415200,\n \"EndTime\": 1734418800,\n \"GroupBy\": [\n \"service.name\"\n ]\n}", + "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n }\n ],\n \"MetricName\": \"error_request_count\",\n \"MetricNameCN\": \"错误数\",\n \"TimeSerial\": [\n 1734415200,\n 1734415260,\n 1734415320,\n 1734415380,\n 1734415440,\n 1734415500,\n 1734415560,\n 1734415620,\n 1734415680,\n 1734415740,\n 1734415800,\n 1734415860,\n 1734415920,\n 1734415980,\n 1734416040,\n 1734416100,\n 1734416160,\n 1734416220,\n 1734416280,\n 1734416340,\n 1734416400,\n 1734416460,\n 1734416520,\n 1734416580,\n 1734416640,\n 1734416700,\n 1734416760,\n 1734416820,\n 1734416880,\n 1734416940,\n 1734417000,\n 1734417060,\n 1734417120,\n 1734417180,\n 1734417240,\n 1734417300,\n 1734417360,\n 1734417420,\n 1734417480,\n 1734417540,\n 1734417600,\n 1734417660,\n 1734417720,\n 1734417780,\n 1734417840,\n 1734417900,\n 1734417960,\n 1734418020,\n 1734418080,\n 1734418140,\n 1734418200,\n 1734418260,\n 1734418320,\n 1734418380,\n 1734418440,\n 1734418500,\n 1734418560,\n 1734418620,\n 1734418680,\n 1734418740\n ],\n \"DataSerial\": [\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n }\n ],\n \"MetricName\": \"duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": [\n 1734415200,\n 1734415260,\n 1734415320,\n 1734415380,\n 1734415440,\n 1734415500,\n 1734415560,\n 1734415620,\n 1734415680,\n 1734415740,\n 1734415800,\n 1734415860,\n 1734415920,\n 1734415980,\n 1734416040,\n 1734416100,\n 1734416160,\n 1734416220,\n 1734416280,\n 1734416340,\n 1734416400,\n 1734416460,\n 1734416520,\n 1734416580,\n 1734416640,\n 1734416700,\n 1734416760,\n 1734416820,\n 1734416880,\n 1734416940,\n 1734417000,\n 1734417060,\n 1734417120,\n 1734417180,\n 1734417240,\n 1734417300,\n 1734417360,\n 1734417420,\n 1734417480,\n 1734417540,\n 1734417600,\n 1734417660,\n 1734417720,\n 1734417780,\n 1734417840,\n 1734417900,\n 1734417960,\n 1734418020,\n 1734418080,\n 1734418140,\n 1734418200,\n 1734418260,\n 1734418320,\n 1734418380,\n 1734418440,\n 1734418500,\n 1734418560,\n 1734418620,\n 1734418680,\n 1734418740\n ],\n \"DataSerial\": [\n 504.4455225,\n 504.49955074999997,\n 504.50165175000006,\n 504.55699425,\n 504.5483053749999,\n 504.547519,\n 504.73789837500004,\n 504.46199262500005,\n 504.1922,\n 504.22497787500004,\n 504.18011225000004,\n 504.04929475,\n 504.14939112499997,\n 504.45689225,\n 504.4441259166667,\n 504.4853475,\n 504.55031125,\n 504.458504875,\n 504.49732837499994,\n 504.50629599999996,\n 504.439337,\n 504.272122,\n 504.267848625,\n 504.28821525,\n 504.268522875,\n 504.28563437500003,\n 504.25491391666674,\n 504.20538062500003,\n 504.54045425000004,\n 504.67349375000003,\n 504.71599025,\n 504.54132337499993,\n 504.69503825,\n 504.74425037500004,\n 504.637164375,\n 504.62155600000006,\n 504.628113,\n 505.07725949999997,\n 504.65562800000004,\n 504.443061375,\n 504.420146125,\n 504.41736325000005,\n 507.28285875,\n 504.59916025,\n 504.50750687499993,\n 504.67656166666666,\n 504.687698625,\n 504.7468005,\n 504.728723,\n 504.71881125,\n 504.6750935,\n 504.45997087499995,\n 504.48766912499997,\n 504.5063645,\n 504.670277625,\n 504.88526525,\n 505.09475625,\n 505.13066475,\n 505.103745375,\n 505.101275\n ]\n }\n ],\n \"RequestId\": \"test-test-test\"\n }\n}", + "title": "查询1分钟聚合粒度的 sql_metric 指标数据示例" }, { - "document": "该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的service_slow_sql_count（慢sql）的指标数据。", - "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralMetricData\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"tapm-api-ap-beijing\"\n }\n ],\n \"ViewName\": \"sql_metric\",\n \"InstanceId\": \"apm-ylTJfTSbn\",\n \"Period\": 60,\n \"Metrics\": [\n \"service_slow_sql_count\"\n ],\n \"StartTime\": \"1652666416\",\n \"EndTime\": \"1652667616\",\n \"GroupBy\": [\n \"service.name\"\n ]\n}", - "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n }\n ],\n \"MetricName\": \"service_slow_sql_count\",\n \"MetricNameCN\": \"\",\n \"TimeSerial\": [\n 1656428160,\n 1656428220,\n 1656428280,\n 1656428340,\n 1656428400,\n 1656428460,\n 1656428520,\n 1656428580,\n 1656428640,\n 1656428700,\n 1656428760,\n 1656428820,\n 1656428880\n ],\n \"DataSerial\": [\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0\n ]\n }\n ],\n \"RequestId\": \"test-test-test\"\n }\n}", - "title": "查询1分钟聚合粒度的sql_metric的service_slow_sql_count（慢调用sql）指标数据示例" - }, - { - "document": "该示例查询实例为apm-ylTJfTSbn，按照db.instance（数据库名称）、（db.ip）数据库实例ip为维度过滤，以service.name（服务名）、db.statement（sql语句）为维度进行聚合，查找开始时间-终止时间内top5的sql_duration_avg（耗时（ms））的指标数据。", - "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralMetricData\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"db.instance\",\n \"Value\": \"mock_project_db\"\n },\n {\n \"Key\": \"db.ip\",\n \"Value\": \"9.147.18.42\"\n }\n ],\n \"ViewName\": \"sql_metric\",\n \"InstanceId\": \"apm-ylTJfTSbn\",\n \"Metrics\": [\n \"sql_duration_avg\"\n ],\n \"StartTime\": \"1652666416\",\n \"EndTime\": \"1652667616\",\n \"GroupBy\": [\n \"service.name\",\n \"db.statement\"\n ],\n \"OrderBy\": {\n \"Key\": \"sql_duration_avg\",\n \"Value\": \"desc\"\n },\n \"PageSize\": 5\n}", - "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Tags\": [\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select * om un_exist_table limit 1\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n }\n ],\n \"MetricName\": \"sql_duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": null,\n \"DataSerial\": [\n 29.883333333333333\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select * om un_exist_table limit 1\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-user-service\"\n }\n ],\n \"MetricName\": \"sql_duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": null,\n \"DataSerial\": [\n 26.170082239670673\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select * from un_exist_table limit 1\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-market-service\"\n }\n ],\n \"MetricName\": \"sql_duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": null,\n \"DataSerial\": [\n 25.654237574773983\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select * from mock_project_userinfo where id = ? limit 1\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-service\"\n }\n ],\n \"MetricName\": \"sql_duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": null,\n \"DataSerial\": [\n 24.333649579223025\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select * from un_exist_table limit 1\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-user-service\"\n }\n ],\n \"MetricName\": \"sql_duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": null,\n \"DataSerial\": [\n 22.785741520925463\n ]\n }\n ],\n \"RequestId\": \"test-test-test\"\n }\n}", - "title": "查询起始到终止时间内统计sql_metric的sql_duration_avg（耗时时间）指标数据示例" + "document": "该示例查询实例为apm-059oXBfTL，按照 db.instance（数据库名称）为维度过滤，以 service.name（服务名）、db.statement（执行语句）为维度进行聚合，查找开始时间-终止时间内 top5 的 duration_avg（耗时（ms））的指标数据。", + "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralMetricData\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"db.instance\",\n \"Value\": \"mock_project_db\"\n }\n ],\n \"ViewName\": \"sql_metric\",\n \"InstanceId\": \"apm-059oXBfTL\",\n \"Metrics\": [\n \"duration_avg\"\n ],\n \"StartTime\": 1734415200,\n \"EndTime\": 1734418800,\n \"GroupBy\": [\n \"service.name\",\n \"db.statement\"\n ],\n \"OrderBy\": {\n \"Key\": \"sql_duration_avg\",\n \"Value\": \"desc\"\n },\n \"PageSize\": 5\n}", + "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Tags\": [\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select sleep(?)\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n }\n ],\n \"MetricName\": \"duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 2005.583661869444\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-stock-service\"\n },\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select dept, count(dept) as total from mock_project_userinfo\"\n }\n ],\n \"MetricName\": \"duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 5.746467460185185\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select dept, count(dept) as total from mock_project_userinfo\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-user-service\"\n }\n ],\n \"MetricName\": \"duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 5.719407256481479\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select * from mock_project_userinfo\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-order-service\"\n }\n ],\n \"MetricName\": \"duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 5.677464627777778\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select * from mock_project_userinfo\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-delivery-service\"\n }\n ],\n \"MetricName\": \"duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 5.636013505555556\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select * om un_exist_table limit ?\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-delivery-service\"\n }\n ],\n \"MetricName\": \"duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 5.514262441666669\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"db.statement\",\n \"Value\": \"select dept, count(dept) as total from mock_project_userinfo\"\n },\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-market-service\"\n }\n ],\n \"MetricName\": \"duration_avg\",\n \"MetricNameCN\": \"平均响应时间\",\n \"TimeSerial\": [],\n \"DataSerial\": [\n 5.44814345277778\n ]\n }\n ],\n \"RequestId\": \"test-test-test\"\n }\n}", + "title": "查询起始到终止时间内统计 sql_metric 的 duration_avg（耗时时间）指标数据示例" } ], "DescribeGeneralSpanList": [ diff --git a/tccli/services/ba/v20200720/api.json b/tccli/services/ba/v20200720/api.json index 6b72135a82..0b991b8e5d 100644 --- a/tccli/services/ba/v20200720/api.json +++ b/tccli/services/ba/v20200720/api.json @@ -35,7 +35,7 @@ { "disabled": false, "document": "代理角色临时密钥的Token", - "example": "", + "example": "yN8d0VyOqBvljYQw0MC", "member": "string", "name": "SessionKey", "required": true, @@ -50,9 +50,10 @@ { "disabled": false, "document": "渠道备案小程序二维码", - "example": "", + "example": "https://beianapi.cloud.tencent.com/?exchangeSkey=yN8d0VyOqBvljYQw0MC", "member": "string", "name": "Url", + "output_required": true, "type": "string", "value_allowed_null": false }, diff --git a/tccli/services/billing/v20180709/api.json b/tccli/services/billing/v20180709/api.json index c7d11a218a..97884984f9 100644 --- a/tccli/services/billing/v20180709/api.json +++ b/tccli/services/billing/v20180709/api.json @@ -8271,7 +8271,7 @@ "value_allowed_null": false }, { - "disabled": false, + "disabled": true, "document": "是否允许欠费消费", "example": "true", "member": "bool", @@ -8281,7 +8281,7 @@ "value_allowed_null": false }, { - "disabled": false, + "disabled": true, "document": "是否限制信用额度", "example": "true", "member": "bool", diff --git a/tccli/services/cam/v20190116/api.json b/tccli/services/cam/v20190116/api.json index 90270c305c..4f783cd5b0 100644 --- a/tccli/services/cam/v20190116/api.json +++ b/tccli/services/cam/v20190116/api.json @@ -1237,80 +1237,80 @@ { "disabled": false, "document": "策略ID", - "example": "", + "example": "9420", "member": "uint64", "name": "PolicyId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "策略名称", - "example": "", + "example": "AdministratorAccess", "member": "string", "name": "PolicyName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "绑定时间", - "example": "", + "example": "2024-12-06 12:00:00", "member": "string", "name": "AddTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "策略类型，User表示自定义策略，QCS表示预设策略\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "User", "member": "string", "name": "PolicyType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "策略创建方式，1表示按产品功能或项目权限创建，其他表示按策略语法创建", - "example": "", + "example": "1", "member": "uint64", "name": "CreateMode", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "是否已下线(0:否 1:是)\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "1", "member": "uint64", "name": "Deactived", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "已下线的产品列表\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "[\"ccs\"]", "member": "string", "name": "DeactivedDetail", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "策略描述\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "admin policy", "member": "string", "name": "Description", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -3664,10 +3664,10 @@ { "disabled": false, "document": "策略版本详情\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "无", + "example": "{\"VersionId\":2,\"CreateDate\":\"2019-08-09T10:31:47Z\",\"IsDefaultVersion\":1,\"Document\":\"{\\\"version\\\":\\\"2.0\\\",\\\"statement\\\":[{\\\"effect\\\":\\\"allow\\\",\\\"action\\\":[\\\"name\\\\/cos:*\\\"],\\\"resource\\\":[\\\"*\\\"]}]}\"}", "member": "PolicyVersionDetail", "name": "PolicyVersion", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": true }, @@ -3686,7 +3686,7 @@ { "disabled": false, "document": "角色ID", - "example": "", + "example": "4611686018441258642", "member": "string", "name": "RoleId", "required": true, @@ -3701,45 +3701,50 @@ { "disabled": false, "document": "策略ID\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "4221356", "member": "int64", "name": "PolicyId", + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "策略名\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "QcloudCOSAccessForCLSRole", "member": "string", "name": "PolicyName", + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "策略语法\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "{\"strategyInfo\":{\"version\":\"2.0\",\"statement\":[{\"effect\":\"allow\",\"action\":\"*\",\"resource\":\"*\"}]}}", "member": "string", "name": "PolicyDocument", + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "策略类型：1.自定义策略，2.预设策略\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "1", "member": "int64", "name": "PolicyType", + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "创建方式：1.按产品功能或项目权限创建，2.按策略语法创建，3.按策略生成器创建，4.按标签授权创建，5.按权限边界规则创建\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "5", "member": "int64", "name": "CreateMode", + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -3918,7 +3923,7 @@ { "disabled": false, "document": "删除任务ID", - "example": "", + "example": "40082", "member": "string", "name": "DeletionTaskId", "required": true, @@ -3933,36 +3938,40 @@ { "disabled": false, "document": "状态：NOT_STARTED，IN_PROGRESS，SUCCEEDED，FAILED", - "example": "", + "example": "SUCCEEDED", "member": "string", "name": "Status", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "失败原因", - "example": "", + "example": "ok", "member": "string", "name": "Reason", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "服务类型\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "advisor", "member": "string", "name": "ServiceType", + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "服务名称\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "云顾问", "member": "string", "name": "ServiceName", + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -4028,7 +4037,7 @@ { "disabled": false, "document": "子账号Uin", - "example": "", + "example": "100000546547", "member": "int64", "name": "TargetUin", "required": true, @@ -4043,45 +4052,50 @@ { "disabled": false, "document": "策略ID\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "213465", "member": "int64", "name": "PolicyId", + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "策略名\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "QcloudCOSAccessForCLSRole", "member": "string", "name": "PolicyName", + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "策略语法\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "{\"strategyInfo\":{\"version\":\"2.0\",\"statement\":[{\"effect\":\"allow\",\"action\":\"*\",\"resource\":\"*\"}]}}", "member": "string", "name": "PolicyDocument", + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "策略类型：1.自定义策略，2.预设策略\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "1", "member": "int64", "name": "PolicyType", + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "创建方式：1.按产品功能或项目权限创建，2.按策略语法创建，3.按策略生成器创建，4.按标签授权创建，5.按权限边界规则创建\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "5", "member": "int64", "name": "CreateMode", + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -4521,7 +4535,7 @@ { "disabled": false, "document": "策略列表", - "example": "无", + "example": "[{\"OperateOwnerUin\":\"10001\",\"PolicyName\":\"AdministratorAccess\",\"Remark\":\"policy remark\",\"OperateUinType\":1,\"CreateMode\":1,\"Deactived\":1,\"AddTime\":\"2020-09-22 00:00:00\",\"PolicyType\":\"User\",\"PolicyId\":1,\"DeactivedDetail\":[\"bbs\"],\"OperateUin\":\"10001\"}]", "member": "AttachPolicyInfo", "name": "List", "output_required": true, @@ -4570,7 +4584,7 @@ { "disabled": false, "document": "角色名。用于指定角色，入参 RoleId 与 RoleName 二选一", - "example": "role_data", + "example": "dev_role", "member": "string", "name": "RoleName", "required": false, @@ -4588,7 +4602,7 @@ { "disabled": false, "document": "搜索关键字", - "example": "searchKey", + "example": "readonly", "member": "string", "name": "Keyword", "required": false, @@ -4603,10 +4617,10 @@ { "disabled": false, "document": "角色关联的策略列表", - "example": "无", + "example": "[{\"PolicyName\":\"QcloudAccessForASRole\",\"Description\":\"Free Access to AS Product\",\"CreateMode\":1,\"Deactived\":1,\"AddTime\":\"2019-07-10 11:17:41\",\"PolicyType\":\"QCS\",\"PolicyId\":13847366,\"DeactivedDetail\":[\"bbs\"]}]", "member": "AttachedPolicyOfRole", "name": "List", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -4616,7 +4630,7 @@ "example": "1", "member": "uint64", "name": "TotalNum", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -4763,17 +4777,17 @@ "example": "1", "member": "uint64", "name": "TotalNum", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "策略列表", - "example": "无", + "example": "{\"PolicyId\":109360057,\"PolicyName\":\"policygen-20220103141614\",\"AddTime\":\"2022-01-03 10:38:28\",\"CreateMode\":3,\"Remark\":\"cos policy\",\"OperateOwnerUin\":100008847111,\"OperateUin\":100008847111,\"OperateUinType\":0,\"PolicyType\":\"User\",\"Deactived\":0,\"DeactivedDetail\":[\"bbs\"]}]", "member": "AttachPolicyInfo", "name": "List", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -4948,30 +4962,30 @@ { "disabled": false, "document": "服务", - "example": "无", + "example": "{\"ServiceType\":\"cvm\",\"ServiceName\":\"云服务器\"}", "member": "ListGrantServiceAccessService", "name": "Service", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, { "disabled": false, "document": "接口信息", - "example": "无", + "example": "{\"Name\":\"AddInstanceInDeployGroup\",\"Description\":\"新增实例部署组\"}", "member": "ListGrantServiceAccessActionNode", "name": "Action", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "授权的策略", - "example": "无", + "example": "{\"PolicyId\":\"73019980\",\"PolicyName\":\"policygen-20210101\",\"PolicyDescription\":\"cvm custom policy\",\"PolicyType\":\"Custom\"}", "member": "ListGrantServiceAccessPolicy", "name": "Policy", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -5237,10 +5251,10 @@ { "disabled": false, "document": "列表", - "example": "无", + "example": "[{\"Service\":{\"ServiceType\":\"cvm\",\"ServiceName\":\"云服务器\"},\"Action\":[{\"Name\":\"AddInstanceInDeployGroup\",\"Description\":\"新增实例部署组\"}],\"Policy\":[{\"PolicyId\":\"73019980\",\"PolicyName\":\"policygen-20210xxxxxxx\",\"PolicyDescription\":\"cvm custom policy\",\"PolicyType\":\"Custom\"}]}]", "member": "ListGrantServiceAccessNode", "name": "List", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -5343,7 +5357,7 @@ { "disabled": false, "document": "策略ID", - "example": "", + "example": "13847366", "member": "uint64", "name": "PolicyId", "required": true, @@ -5358,9 +5372,10 @@ { "disabled": false, "document": "策略版本列表\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "[{\"VersionId\":2,\"CreateDate\":\"2019-08-09T10:31:47Z\",\"IsDefaultVersion\":1},{\"VersionId\":3,\"CreateDate\":\"2019-08-09T10:31:47Z\",\"IsDefaultVersion\":0}]", "member": "PolicyVersionItem", "name": "Versions", + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -5882,40 +5897,40 @@ { "disabled": false, "document": "策略版本号\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "2", "member": "uint64", "name": "VersionId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "策略版本创建时间\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "2019-08-09T10:31:47Z", "member": "string", "name": "CreateDate", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "是否是正在生效的版本。0表示不是，1表示是\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "1", "member": "uint64", "name": "IsDefaultVersion", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "策略语法文本\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "{\"version\":\"2.0\",\"statement\":[{\"effect\":\"allow\",\"action\":[\"name\\/cos:*\"],\"resource\":[\"*\"]}]}", "member": "string", "name": "Document", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -5928,30 +5943,30 @@ { "disabled": false, "document": "策略版本号\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "3", "member": "uint64", "name": "VersionId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "策略版本创建时间\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "2019-08-09T10:31:47Z", "member": "string", "name": "CreateDate", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "是否是正在生效的版本。0表示不是，1表示是\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "example": "0", "member": "int64", "name": "IsDefaultVersion", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true } @@ -6841,7 +6856,7 @@ { "disabled": false, "document": "标签", - "example": "无", + "example": "[{\"Key\":\"AKey\",\"Value\":\"AValue\"}]", "member": "RoleTags", "name": "Tags", "required": true, diff --git a/tccli/services/cam/v20190116/examples.json b/tccli/services/cam/v20190116/examples.json index cd8d974f9c..9418a3bbee 100644 --- a/tccli/services/cam/v20190116/examples.json +++ b/tccli/services/cam/v20190116/examples.json @@ -418,7 +418,7 @@ { "document": "", "input": "https://cam.tencentcloudapi.com/?Action=GetServiceLinkedRoleDeletionStatus\r\n&DeletionTaskId=100\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Status\": \"SUCCEEDED\",\n \"ServiceType\": \"cam\",\n \"ServiceName\": \"访问管理\",\n \"Reason\": \"{}\",\n \"RequestId\": \"c3da1c1c-df35-467d-9335-99c68d993e0a\"\n }\n}", + "output": "{\n \"Response\": {\n \"Status\": \"SUCCEEDED\",\n \"ServiceType\": \"cam\",\n \"ServiceName\": \"访问管理\",\n \"Reason\": \"ok\",\n \"RequestId\": \"c3da1c1c-df35-467d-9335-99c68d993e0a\"\n }\n}", "title": "获取服务相关角色删除状态" } ], @@ -458,7 +458,7 @@ { "document": "查询用户组3349关联的策略列表", "input": "https://cam.tencentcloudapi.com/?Action=ListAttachedGroupPolicies\n&TargetGroupId=3349\n&Page=1\n&Rp=10\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"List\": [\n {\n \"OperateOwnerUin\": \"10001\",\n \"PolicyName\": \"AdministratorAccess\",\n \"Remark\": \"test policy remark\",\n \"OperateUinType\": 1,\n \"CreateMode\": 1,\n \"Deactived\": 1,\n \"AddTime\": \"2020-09-22 00:00:00\",\n \"PolicyType\": \"User\",\n \"PolicyId\": 1,\n \"DeactivedDetail\": [\n \"test\"\n ],\n \"OperateUin\": \"10001\"\n }\n ],\n \"RequestId\": \"836d7034-9854-44f0-9d4a-ee57842f8644\",\n \"TotalNum\": 1\n }\n}", + "output": "{\n \"Response\": {\n \"List\": [\n {\n \"OperateOwnerUin\": \"10001\",\n \"PolicyName\": \"AdministratorAccess\",\n \"Remark\": \"test policy remark\",\n \"OperateUinType\": 1,\n \"CreateMode\": 1,\n \"Deactived\": 1,\n \"AddTime\": \"2020-09-22 00:00:00\",\n \"PolicyType\": \"User\",\n \"PolicyId\": 1,\n \"DeactivedDetail\": [\n \"ccs\"\n ],\n \"OperateUin\": \"10001\"\n }\n ],\n \"RequestId\": \"836d7034-9854-44f0-9d4a-ee57842f8644\",\n \"TotalNum\": 1\n }\n}", "title": "查询用户组关联的策略列表" } ], @@ -466,7 +466,7 @@ { "document": "", "input": "https://cam.tencentcloudapi.com/?Action=ListAttachedRolePolicies\n&RoleId=4611686018427397905\n&Page=1\n&Rp=10\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"List\": [\n {\n \"PolicyName\": \"QcloudAccessForASRole\",\n \"Description\": \"xx\",\n \"CreateMode\": 1,\n \"Deactived\": 1,\n \"AddTime\": \"2019-07-10 11:17:41\",\n \"PolicyType\": \"QCS\",\n \"PolicyId\": 13847366,\n \"DeactivedDetail\": [\n \"xx\"\n ]\n }\n ],\n \"RequestId\": \"60dc7f3f-5d8b-45e9-b703-5feefac9960c\",\n \"TotalNum\": 1\n }\n}", + "output": "{\n \"Response\": {\n \"List\": [\n {\n \"PolicyName\": \"QcloudAccessForASRole\",\n \"Description\": \"Free Access to AS Product\",\n \"CreateMode\": 1,\n \"Deactived\": 1,\n \"AddTime\": \"2019-07-10 11:17:41\",\n \"PolicyType\": \"QCS\",\n \"PolicyId\": 13847366,\n \"DeactivedDetail\": [\n \"bbs\"\n ]\n }\n ],\n \"RequestId\": \"60dc7f3f-5d8b-45e9-b703-5feefac9960c\",\n \"TotalNum\": 1\n }\n}", "title": "获取角色绑定的策略列表" } ], @@ -482,7 +482,7 @@ { "document": "查询绑定到子账号3449203261的策略列表", "input": "https://cam.tencentcloudapi.com/?Action=ListAttachedUserPolicies\n&TargetUin=3449203261\n&Page=1\n&Rp=10\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"List\": [\n {\n \"PolicyId\": 109360057,\n \"PolicyName\": \"test-0103\",\n \"AddTime\": \"2022-01-03 10:38:28\",\n \"CreateMode\": 3,\n \"Remark\": \"\",\n \"OperateOwnerUin\": null,\n \"OperateUin\": null,\n \"OperateUinType\": null,\n \"PolicyType\": \"\",\n \"Deactived\": 0,\n \"DeactivedDetail\": []\n }\n ],\n \"TotalNum\": 1,\n \"RequestId\": \"db1cdf3f-9b1a-47c5-88b3-c49089aaa811\"\n }\n}", + "output": "{\n \"Response\": {\n \"List\": [\n {\n \"PolicyId\": 109360057,\n \"PolicyName\": \"policygen-20240909141614\",\n \"AddTime\": \"2024-09-09 15:51:40\",\n \"CreateMode\": 3,\n \"Remark\": \"cos policy\",\n \"OperateOwnerUin\": \"100008847111\",\n \"OperateUin\": \"100008847111\",\n \"OperateUinType\": 0,\n \"PolicyType\": \"User\",\n \"Deactived\": 0,\n \"DeactivedDetail\": [\n \"ccs\"\n ]\n }\n ],\n \"TotalNum\": 1,\n \"RequestId\": \"db1cdf3f-9b1a-47c5-88b3-c49089aaa811\"\n }\n}", "title": "查询子账号关联的策略列表" } ], @@ -522,7 +522,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: cam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListPolicies\n<公共请求参数>\n\n{\n \"Rp\": \"1\",\n \"Page\": \"10\"\n}", - "output": "{\n \"Response\": {\n \"ServiceTypeList\": [\n \"scf\"\n ],\n \"List\": [\n {\n \"PolicyId\": 16313162,\n \"PolicyName\": \"QcloudAccessForCDNRole\",\n \"AddTime\": \"2019-04-19 10:55:31\",\n \"Type\": 2,\n \"Description\": \"腾讯云内容分发网络(CDN)操作权限含日志服务(CLS)的增删改查日志集，增删改查日志主题，搜索下载上传日志。\",\n \"CreateMode\": 2,\n \"Attachments\": 0,\n \"ServiceType\": \"cooperator\",\n \"IsAttached\": 1,\n \"Deactived\": 1,\n \"DeactivedDetail\": [\n \"cvm\"\n ],\n \"IsServiceLinkedPolicy\": 1,\n \"UpdateTime\": \"2019-04-19 10:55:31\",\n \"AttachEntityCount\": 0,\n \"AttachEntityBoundaryCount\": 0\n }\n ],\n \"TotalNum\": 239,\n \"RequestId\": \"ae2bd2b7-1d55-4b0a-8154-e02407a2b390\"\n }\n}", + "output": "{\n \"Response\": {\n \"List\": [\n {\n \"PolicyId\": 16313162,\n \"PolicyName\": \"QcloudAccessForCDNRole\",\n \"AddTime\": \"2019-04-19 10:55:31\",\n \"Type\": 2,\n \"Description\": \"腾讯云内容分发网络(CDN)操作权限含日志服务(CLS)的增删改查日志集，增删改查日志主题，搜索下载上传日志。\",\n \"CreateMode\": 2,\n \"Attachments\": 0,\n \"ServiceType\": \"cooperator\",\n \"IsAttached\": 1,\n \"Deactived\": 1,\n \"DeactivedDetail\": [\n \"cvm\"\n ],\n \"IsServiceLinkedPolicy\": 1,\n \"UpdateTime\": \"2019-04-19 10:55:31\",\n \"AttachEntityCount\": 0,\n \"AttachEntityBoundaryCount\": 0\n }\n ],\n \"ServiceTypeList\": [\n \"scf\"\n ],\n \"TotalNum\": 239,\n \"RequestId\": \"ae2bd2b7-1d55-4b0a-8154-e02407a2b390\"\n }\n}", "title": "查看策略列表" } ], @@ -530,13 +530,13 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: cam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListPoliciesGrantingServiceAccess\n<公共请求参数>\n\n{\n \"TargetUin\": 100000001\n}", - "output": "{\n \"Response\": {\n \"List\": [\n {\n \"Service\": {\n \"ServiceType\": \"cvm\",\n \"ServiceName\": \"云服务器\"\n },\n \"Action\": [],\n \"Policy\": [\n {\n \"PolicyId\": \"73019980\",\n \"PolicyName\": \"policygen-20210xxxxxxx\",\n \"PolicyDescription\": \"-\",\n \"PolicyType\": \"Custom\"\n }\n ]\n }\n ],\n \"RequestId\": \"6de4c96b-60be-4422-8fe8-5ac09707a116\"\n }\n}", + "output": "{\n \"Response\": {\n \"List\": [\n {\n \"Service\": {\n \"ServiceType\": \"cvm\",\n \"ServiceName\": \"云服务器\"\n },\n \"Action\": [\n {\n \"Name\": \"AddInstanceInDeployGroup\",\n \"Description\": \"新增实例部署组\"\n }\n ],\n \"Policy\": [\n {\n \"PolicyId\": \"73019980\",\n \"PolicyName\": \"policygen-20210xxxxxxx\",\n \"PolicyDescription\": \"cvm custom policy\",\n \"PolicyType\": \"Custom\"\n }\n ]\n }\n ],\n \"RequestId\": \"6de4c96b-60be-4422-8fe8-5ac09707a116\"\n }\n}", "title": "所有已授权服务" }, { "document": "", "input": "POST / HTTP/1.1\nHost: cam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListPoliciesGrantingServiceAccess\n<公共请求参数>\n\n{\n \"TargetUin\": 100000001,\n \"ServiceType\": \"cvm\"\n}", - "output": "{\n \"Response\": {\n \"List\": [\n {\n \"Service\": {\n \"ServiceType\": \"cvm\",\n \"ServiceName\": \"云服务器\"\n },\n \"Action\": [\n {\n \"Name\": \"AddInstanceInDeployGroup\",\n \"Description\": \"新增实例部署组\"\n }\n ],\n \"Policy\": [\n {\n \"PolicyId\": \"73019980\",\n \"PolicyName\": \"policygen-20210xxxxxxx\",\n \"PolicyDescription\": \"-\",\n \"PolicyType\": \"Custom\"\n }\n ]\n }\n ],\n \"RequestId\": \"6de4c96b-60be-4422-8fe8-5ac09707a116\"\n }\n}", + "output": "{\n \"Response\": {\n \"List\": [\n {\n \"Service\": {\n \"ServiceType\": \"cvm\",\n \"ServiceName\": \"云服务器\"\n },\n \"Action\": [\n {\n \"Name\": \"AddInstanceInDeployGroup\",\n \"Description\": \"新增实例部署组\"\n }\n ],\n \"Policy\": [\n {\n \"PolicyId\": \"73019980\",\n \"PolicyName\": \"policygen-20210xxxxxxx\",\n \"PolicyDescription\": \"cvm custom policy\",\n \"PolicyType\": \"Custom\"\n }\n ]\n }\n ],\n \"RequestId\": \"6de4c96b-60be-4422-8fe8-5ac09707a116\"\n }\n}", "title": "查看已授权服务中所有已授权接口" } ], diff --git a/tccli/services/ccc/v20200210/api.json b/tccli/services/ccc/v20200210/api.json index 1e5d2526e6..934422c685 100644 --- a/tccli/services/ccc/v20200210/api.json +++ b/tccli/services/ccc/v20200210/api.json @@ -1692,6 +1692,15 @@ "required": false, "type": "string" }, + { + "disabled": false, + "document": "最大触发AI提示音次数，默认为不限制", + "example": "1", + "member": "uint64", + "name": "NotifyMaxCount", + "required": false, + "type": "int" + }, { "disabled": false, "document": "

和VoiceType字段需要选填一个，这里是使用自己自定义的TTS，VoiceType是系统内置的一些音色

\n\n
{ \n       "TTSType": "tencent", // String TTS类型, 目前支持"tencent" 和 “minixmax”， 其他的厂商支持中\n       "AppId": "您的应用ID", // String 必填\n       "SecretId": "您的密钥ID", // String 必填\n       "SecretKey":  "您的密钥Key", // String 必填\n       "VoiceType": 101001, // Integer  必填，音色 ID，包括标准音色与精品音色，精品音色拟真度更高，价格不同于标准音色，请参见语音合成计费概述。完整的音色 ID 列表请参见语音合成音色列表。\n       "Speed": 1.25, // Integer 非必填，语速，范围：[-2，6]，分别对应不同语速： -2: 代表0.6倍 -1: 代表0.8倍 0: 代表1.0倍（默认） 1: 代表1.2倍 2: 代表1.5倍  6: 代表2.5倍  如果需要更细化的语速，可以保留小数点后 2 位，例如0.5/1.25/2.81等。 参数值与实际语速转换，可参考 语速转换\n       "Volume": 5, // Integer 非必填，音量大小，范围：[0，10]，分别对应11个等级的音量，默认值为0，代表正常音量。\n       "PrimaryLanguage": 1, // Integer 可选 主要语言 1-中文（默认） 2-英文 3-日文\n       "FastVoiceType": "xxxx"   //  可选参数， 快速声音复刻的参数 \n  }\n
\n\n
\n
{\n        "TTSType": "minimax",  // String TTS类型, \n        "Model": "speech-01-turbo",\n        "APIUrl": "https://api.minimax.chat/v1/t2a_v2",\n        "APIKey": "eyxxxx",\n        "GroupId": "181000000000000",\n        "VoiceType":"female-tianmei-jingpin",\n        "Speed": 1.2\n}\n
\n
\n

配置音色类型参考火山TTS文档链接
\n语音合成音色列表–语音技术-火山引擎
\n大模型语音合成音色列表–语音技术-火山引擎

\n
{\n    "TTSType": "volcengine",  // 必填：String TTS类型\n    "AppId" : "xxxxxxxx",   // 必填：String 火山引擎分配的Appid\n    "Token" : "TY9d4sQXHxxxxxxx", // 必填： String类型 火山引擎的访问token\n    "Speed" : 1.0,            // 可选参数 语速，默认为1.0\n    "Volume": 1.0,            // 可选参数， 音量大小， 默认为1.0\n    "Cluster" : "volcano_tts", // 可选参数，业务集群, 默认是 volcano_tts\n    "VoiceType" : "zh_male_aojiaobazong_moon_bigtts"   // 音色类型， 默认为大模型语音合成的音色。 如果使用普通语音合成，则需要填写对应的音色类型。 音色类型填写错误会导致没有声音。\n}\n
\n\n
\n
{\n    "TTSType": "azure", // 必填：String TTS类型\n    "SubscriptionKey": "xxxxxxxx", // 必填：String 订阅的Key\n    "Region": "chinanorth3",  // 必填：String 订阅的地区\n    "VoiceName": "zh-CN-XiaoxiaoNeural", // 必填：String 音色名必填\n    "Language": "zh-CN", // 必填：String 合成的语言  \n    "Rate": 1 // 选填：float 语速  0.5～2 默认为 1\n}\n
\n\n
\n

TTS
\n具体协议规范请参考腾讯文档

\n
{\n  "TTSType": "custom", // String 必填\n  "APIKey": "ApiKey", // String 必填 用来鉴权\n  "APIUrl": "http://0.0.0.0:8080/stream-audio" // String，必填，TTS API URL\n  "AudioFormat": "wav", // String, 非必填，期望输出的音频格式，如mp3， ogg_opus，pcm，wav，默认为 wav，目前只支持pcm和wav，\n  "SampleRate": 16000,  // Integer，非必填，音频采样率，默认为16000(16k)，推荐值为16000\n  "AudioChannel": 1,    // Integer，非必填，音频通道数，取值：1 或 2  默认为1  \n}\n
\n\n
", diff --git a/tccli/services/cdb/cdb_client.py b/tccli/services/cdb/cdb_client.py index 7b69c32a13..40f934a643 100644 --- a/tccli/services/cdb/cdb_client.py +++ b/tccli/services/cdb/cdb_client.py @@ -5529,6 +5529,58 @@ def doCloseCDBProxy(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doModifyProtectMode(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.CdbClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.ModifyProtectModeRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.ModifyProtectMode(model) + result = rsp.to_json_string() + try: + json_obj = json.loads(result) + except TypeError as e: + json_obj = json.loads(result.decode('utf-8')) # python3.3 + if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']: + break + cur_time = time.time() + if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']: + raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' % + (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'], + search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))) + else: + print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)) + time.sleep(g_param['OptionsDefine.WaiterInfo']['interval']) + FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) + + def doDescribeAsyncRequestInfo(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -8974,6 +9026,7 @@ def doModifyAccountMaxUserConnections(args, parsed_globals): "ResetPassword": doResetPassword, "ModifyLocalBinlogConfig": doModifyLocalBinlogConfig, "CloseCDBProxy": doCloseCDBProxy, + "ModifyProtectMode": doModifyProtectMode, "DescribeAsyncRequestInfo": doDescribeAsyncRequestInfo, "DescribeAuditLogs": doDescribeAuditLogs, "DescribeDBInstanceRebootTime": doDescribeDBInstanceRebootTime, diff --git a/tccli/services/cdb/v20170320/api.json b/tccli/services/cdb/v20170320/api.json index a392eb4607..6ce1d65dca 100644 --- a/tccli/services/cdb/v20170320/api.json +++ b/tccli/services/cdb/v20170320/api.json @@ -973,6 +973,13 @@ "output": "ModifyParamTemplateResponse", "status": "online" }, + "ModifyProtectMode": { + "document": "该接口（ModifyProtectMode）用于修改实例的同步方式。", + "input": "ModifyProtectModeRequest", + "name": "修改实例的同步方式", + "output": "ModifyProtectModeResponse", + "status": "online" + }, "ModifyRemoteBackupConfig": { "document": "本接口(ModifyRemoteBackupConfig)用于修改数据库异地备份配置信息。", "input": "ModifyRemoteBackupConfigRequest", @@ -16823,6 +16830,42 @@ ], "type": "object" }, + "ModifyProtectModeRequest": { + "document": "ModifyProtectMode请求参数结构体", + "members": [ + { + "disabled": false, + "document": "无", + "example": "1", + "member": "int64", + "name": "ProtectMode", + "required": true, + "type": "int" + }, + { + "disabled": false, + "document": "实例ID。", + "example": "cdb-ezq1vzem", + "member": "string", + "name": "InstanceId", + "required": true, + "type": "string" + } + ], + "type": "object" + }, + "ModifyProtectModeResponse": { + "document": "ModifyProtectMode返回参数结构体", + "members": [ + { + "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "ModifyRemoteBackupConfigRequest": { "document": "ModifyRemoteBackupConfig请求参数结构体", "members": [ diff --git a/tccli/services/cdb/v20170320/examples.json b/tccli/services/cdb/v20170320/examples.json index 9b827c54b2..6c41baa284 100644 --- a/tccli/services/cdb/v20170320/examples.json +++ b/tccli/services/cdb/v20170320/examples.json @@ -1154,6 +1154,14 @@ "title": "修改参数模板" } ], + "ModifyProtectMode": [ + { + "document": "", + "input": "https://cdb.tencentcloudapi.com/?Action=ModifyProtectMode\n&ProtectMode=1\n&InstanceId=cdb-ezq1vzem\n&<公共请求参数>", + "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}", + "title": "修改实例同步方式" + } + ], "ModifyRemoteBackupConfig": [ { "document": "无", diff --git a/tccli/services/cfg/v20210820/api.json b/tccli/services/cfg/v20210820/api.json index e495b9c47b..99ca847569 100644 --- a/tccli/services/cfg/v20210820/api.json +++ b/tccli/services/cfg/v20210820/api.json @@ -1750,6 +1750,16 @@ "output_required": false, "type": "int", "value_allowed_null": true + }, + { + "disabled": false, + "document": "1.接入层 2.逻辑层 3. 数据层", + "example": "1", + "member": "int64", + "name": "ArchLayer", + "output_required": false, + "type": "int", + "value_allowed_null": false } ], "usage": "out" @@ -3953,6 +3963,17 @@ "required": false, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "故障表现", + "example": "故障表现xxxx", + "member": "string", + "name": "FailurePerformance", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": false } ], "usage": "both" diff --git a/tccli/services/cloudapp/v20220530/api.json b/tccli/services/cloudapp/v20220530/api.json index 0d4f11188d..a5f0f6b11d 100644 --- a/tccli/services/cloudapp/v20220530/api.json +++ b/tccli/services/cloudapp/v20220530/api.json @@ -177,6 +177,16 @@ "output_required": false, "type": "string", "value_allowed_null": false + }, + { + "disabled": false, + "document": "授权的类型：Standard正式版/Development开发版/Trial体验版", + "example": "Standard", + "member": "string", + "name": "LicenseType", + "output_required": true, + "type": "string", + "value_allowed_null": false } ], "usage": "out" diff --git a/tccli/services/cloudaudit/v20190319/api.json b/tccli/services/cloudaudit/v20190319/api.json index 69bc267236..3a63a12024 100644 --- a/tccli/services/cloudaudit/v20190319/api.json +++ b/tccli/services/cloudaudit/v20190319/api.json @@ -146,56 +146,61 @@ "members": [ { "disabled": false, - "document": "输入框类型", - "example": "xx", + "document": "输入框类型\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "type", "member": "string", "name": "LabelType", + "output_required": false, "required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "初始化展示", - "example": "xx", + "document": "初始化展示\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "12", "member": "string", "name": "Starter", + "output_required": false, "required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "展示排序", - "example": "1", + "document": "展示排序\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "desc", "member": "int64", "name": "Order", + "output_required": false, "required": true, "type": "int", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "AttributeKey值", - "example": "xx", + "document": "AttributeKey值\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "tag1", "member": "string", "name": "Value", + "output_required": false, "required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "中文标签", - "example": "xx", + "document": "中文标签\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "事件", "member": "string", "name": "Label", + "output_required": false, "required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true } ], - "usage": "in" + "usage": "both" }, "AuditSummary": { "document": "跟踪集概览", @@ -1131,7 +1136,7 @@ { "disabled": false, "document": "网站类型，取值范围是zh和en。如果不传值默认zh", - "example": "xx", + "example": "ap-guangzhou", "member": "string", "name": "WebsiteType", "required": false, @@ -1146,10 +1151,10 @@ { "disabled": false, "document": "AttributeKey的有效取值范围", - "example": "xx", + "example": " [ { \"Label\": \"只读\", \"Value\": \"ReadOnly\", \"Starter\": \"选择只读值\", \"LabelType\": \"select\", \"Order\": 1 } ]", "member": "AttributeKeyDetail", "name": "AttributeKeyDetails", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1194,26 +1199,28 @@ "members": [ { "disabled": false, - "document": "作为密钥更容易辨识，更容易被人看懂的别名", - "example": "xx", + "document": "作为密钥更容易辨识，更容易被人看懂的别名\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "audit_name", "member": "string", "name": "Alias", + "output_required": false, "required": false, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "CMK的全局唯一标识", - "example": "xx", + "document": "CMK的全局唯一标识\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "key_34244", "member": "string", "name": "KeyId", + "output_required": false, "required": false, "type": "string", - "value_allowed_null": false + "value_allowed_null": true } ], - "usage": "in" + "usage": "both" }, "ListAuditsRequest": { "document": "ListAudits请求参数结构体", @@ -1248,7 +1255,7 @@ { "disabled": false, "document": "站点类型。zh表示中国区，en表示国际区。默认中国区。", - "example": "xx", + "example": "zh", "member": "string", "name": "WebsiteType", "required": false, @@ -1263,7 +1270,7 @@ { "disabled": false, "document": "操作审计支持的cmq的可用区", - "example": "xx", + "example": " [ { \"CmqRegion\": \"sh\", \"CmqRegionName\": \"上海\" }, { \"CmqRegion\": \"hk\", \"CmqRegionName\": \"香港\" } ]", "member": "CmqRegionInfo", "name": "EnableRegions", "output_required": true, @@ -1322,7 +1329,7 @@ { "disabled": false, "document": "Kms地域", - "example": "xx", + "example": "ap-guangzhou", "member": "string", "name": "KmsRegion", "required": true, @@ -1358,7 +1365,7 @@ "example": "1", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -1368,7 +1375,7 @@ "example": "[xx,xx]", "member": "KeyMetadata", "name": "KeyMetadatas", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1414,7 +1421,7 @@ { "disabled": false, "document": "查看更多日志的凭证", - "example": "xxx", + "example": "79ba1f24-c21c-4858-a8e6-a9266b0599ff", "member": "string", "name": "NextToken", "required": false, @@ -1447,7 +1454,7 @@ { "disabled": false, "document": "查看更多日志的凭证\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "xxxxxxx", + "example": "79ba1f24-c21c-4858-a8e6-a9266b0599ff", "member": "string", "name": "NextToken", "output_required": true, @@ -1457,7 +1464,7 @@ { "disabled": false, "document": "日志集合\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "无", + "example": "[ { \"CloudAuditEvent\": \"*\", \"EventId\": \"e92a92fc259c4a9333d2a7ce64d1ef201\", \"EventName\": \"LookupEvents\", \"EventTime\": \"2019-03-20 12:36:27\", \"SecretId\": \"XXX\", \"ErrorCode\": 0, \"RequestID\": \"15936031437374_1553056587.6815_v2\", \"AccountID\": 1150691759, \"SourceIPAddress\": \"*\", \"EventSource\": \"cloudaudit.api.tencentyun.com/v2/index.php\", \"EventRegion\": \"ap-guangzhou\", \"Resources\": { \"ResourceName\": \"\", \"ResourceType\": \"cloudaudit\" }, \"Username\": \"root\", \"ResourceTypeCn\": \"操作审计\", \"EventNameCn\": \"检索日志\" } ]", "member": "Event", "name": "Events", "output_required": true, @@ -1754,7 +1761,7 @@ { "disabled": false, "document": "跟踪集名称", - "example": "xx", + "example": "audit_log", "member": "string", "name": "AuditName", "required": true, @@ -1772,7 +1779,7 @@ "example": "1", "member": "int64", "name": "IsSuccess", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, diff --git a/tccli/services/cloudaudit/v20190319/examples.json b/tccli/services/cloudaudit/v20190319/examples.json index 50562acdc8..1a3c2a701c 100644 --- a/tccli/services/cloudaudit/v20190319/examples.json +++ b/tccli/services/cloudaudit/v20190319/examples.json @@ -107,7 +107,7 @@ "LookUpEvents": [ { "document": "用于对操作日志进行检索，便于用户进行查询相关的操作信息。", - "input": "https://cloudaudit.tencentcloudapi.com/?Action=LookUpEvents\n&EndTime=1553056687\n&LookupAttributes.0.AttributeKey=AccessKeyId\n&LookupAttributes.0.AttributeValue=XXXX\n&StartTime=1553056487\n&<公共请求参数>", + "input": "https://cloudaudit.tencentcloudapi.com/?Action=LookUpEvents\n&EndTime=1553056687\n&LookupAttributes.0.AttributeKey=AccessKeyId\n&LookupAttributes.0.AttributeValue=a9266b0599ff\n&StartTime=1553056487\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"Events\": [\n {\n \"CloudAuditEvent\": \"{\\\"actionType\\\":\\\"Read\\\",\\\"apiErrorCode\\\":\\\"\\\",\\\"apiErrorMessage\\\":\\\"\\\",\\\"apiVersion\\\":\\\"2.0\\\",\\\"errorCode\\\":0,\\\"errorMessage\\\":\\\"permission verify\\\",\\\"eventID\\\":\\\"e92a92fc259c4a9333d2a7ce64d1ef201\\\",\\\"eventName\\\":\\\"LookupEvents\\\",\\\"eventRegion\\\":\\\"ap-guangzhou\\\",\\\"eventSource\\\":\\\"cloudaudit.api.tencentyun.com/v2/index.php\\\",\\\"eventTime\\\":\\\"2019-03-20 12:36:27\\\",\\\"eventType\\\":\\\"ConsoleCall\\\",\\\"eventVersion\\\":2,\\\"httpMethod\\\":\\\"POST\\\",\\\"region\\\":\\\"\\\",\\\"requestID\\\":\\\"15936031437374_1553056587.6815_v2\\\",\\\"requestParameters\\\":\\\"{\\\"Action\\\":\\\"LookupEvents\\\",\\\"EndTime\\\":\\\"1553097599\\\",\\\"MaxResults\\\":\\\"10\\\",\\\"Nonce\\\":\\\"36881\\\",\\\"Region\\\":\\\"gz\\\",\\\"RequestClient\\\":\\\"SDK_NODEJS_0.2.1\\\",\\\"RequestOperator\\\":\\\"1150691759\\\",\\\"RequestSource\\\":\\\"MC\\\",\\\"SecretId\\\":\\\"XXX\\\",\\\"StartTime\\\":\\\"1552406400\\\",\\\"Timestamp\\\":\\\"1553056583\\\",\\\"Token\\\":\\\"147d2c5b0319541a13d9fe6ceb5af2aae9b67f6610001\\\",\\\"seqId\\\":\\\"cdb9c38c-7031-bb13-6a9c-cd7641734c8f\\\"}\\\",\\\"resourceName\\\":\\\"\\\",\\\"resourceType\\\":\\\"cloudaudit\\\",\\\"resources\\\":\\\"\\\",\\\"sourceIPAddress\\\":\\\"59.37.125.124\\\",\\\"userAgent\\\":\\\"\\\",\\\"userIdentity\\\":{\\\"userName\\\":\\\"root\\\",\\\"type\\\":\\\"Root\\\",\\\"secretId\\\":\\\"XXX\\\",\\\"accountId\\\":1150691759,\\\"principalId\\\":1150691759,\\\"sessionContext\\\":{\\\"expireTime\\\":\\\"2019-03-20 13:04:46\\\",\\\"hasPolicyFilter\\\":0,\\\"extraInfo\\\":\\\"\\\",\\\"interfaceName\\\":\\\"\\\",\\\"ownerUin\\\":1150691759,\\\"ua\\\":\\\"27513f02ea3ab649f0cacb6476df54eb\\\",\\\"mfa\\\":0,\\\"userIp\\\":\\\"59.37.125.124\\\",\\\"mfaExpireTime\\\":\\\"2019-03-20 12:34:46\\\",\\\"uin\\\":1150691759,\\\"token\\\":\\\"147d2c5b0319541a13d9fe6ceb5af2aae9b67f6610001\\\",\\\"appId\\\":1251840716,\\\"policyFilter\\\":\\\"\\\"}}}\",\n \"EventId\": \"e92a92fc259c4a9333d2a7ce64d1ef201\",\n \"EventName\": \"LookupEvents\",\n \"EventTime\": \"2019-03-20 12:36:27\",\n \"SecretId\": \"XXX\",\n \"ErrorCode\": 0,\n \"RequestID\": \"15936031437374_1553056587.6815_v2\",\n \"AccountID\": 1150691759,\n \"SourceIPAddress\": \"59.37.125.124\",\n \"EventSource\": \"cloudaudit.api.tencentyun.com/v2/index.php\",\n \"EventRegion\": \"ap-guangzhou\",\n \"Resources\": {\n \"ResourceName\": \"\",\n \"ResourceType\": \"cloudaudit\"\n },\n \"Username\": \"root\",\n \"ResourceTypeCn\": \"操作审计\",\n \"EventNameCn\": \"检索日志\"\n }\n ],\n \"NextToken\": \"DnF1ZXJ5VGhlbkZldGNoDwAAAAAAACBuFjNoRHJ5YTd4U1B5YWY4c1ZmMmxBQWcAAAAAAAAgnBZZZkZoYy04LVJJeVpJNnZJS2hIVTdRAAAAAAAAI1QWYk5mQmZXTzhTWXFNZjFMVlhHY1RjdwAAAAAAAB9sFmhZbV8xbm1FUXE2NGVDQndWSlNoMncAAAAAAAAd9BZOelN1aGMycFNydUVEQ0dQbzdCcEZBAAAAAAAALroWMTh4c00xalhRbk9wR0NsYWZvV20tQQAAAAAAACCdFllmRmhjLTgtUkl5Wkk2dklLaEhVN1EAAAAAAAAuuRYxOHhzTTFqWFFuT3BHQ2xhZm9XbS1BAAAAAAAAIJ4WWWZGaGMtOC1SSXlaSTZ2SUtoSFU3UQAAAAAAAB81FnN5aTBfTWJKU25HdXZuMWxsRkdJZ3cAAAAAAAApMhZ1UjdybjlCY1NRYUZVYWRub2x4YW9RAAAAAAAAHzQWc3lpMF9NYkpTbkd1dm4xbGxGR0lndwAAAAAAAB31Fk56U3VoYzJwU3J1RURDR1BvN0JwRkEAAAAAAAAfbRZoWW1fMW5tRVFxNjRlQ0J3VkpTaDJ3AAAAAAAAH24WaFltXzFubUVRcTY0ZUNCd1ZKU2gydw==\",\n \"ListOver\": true,\n \"TotalCount\": 1,\n \"RequestId\": \"91e2998d-edc0-4ba0-a76d-cebbbfd99391\"\n }\n}", "title": "日志检索" } @@ -131,7 +131,7 @@ "StartLogging": [ { "document": "开启跟踪集", - "input": "https://cloudaudit.tencentcloudapi.com/?Action=StartLogging\n&AuditName=xxxxx\n&<公共请求参数>", + "input": "https://cloudaudit.tencentcloudapi.com/?Action=StartLogging\n&AuditName=audit_log\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"IsSuccess\": 1,\n \"RequestId\": \"94ced030-d9df-4fb3-9894-7accd0c29d23\"\n }\n}", "title": "开启跟踪集" } diff --git a/tccli/services/cvm/v20170312/api.json b/tccli/services/cvm/v20170312/api.json index 49f42ef26f..c831d2a175 100644 --- a/tccli/services/cvm/v20170312/api.json +++ b/tccli/services/cvm/v20170312/api.json @@ -9250,7 +9250,7 @@ }, { "disabled": false, - "document": "私有网络相关信息配置，通过该参数指定私有网络的ID，子网ID，私有网络ip等信息。
  • 当指定私有网络ID和子网ID（子网必须在实例所在的可用区）与指定实例所在私有网络不一致时，会将实例迁移至指定的私有网络的子网下。
  • 可通过`PrivateIpAddresses`指定私有网络子网IP，若需指定则所有已指定的实例均需要指定子网IP，此时`InstanceIds`与`PrivateIpAddresses`一一对应。
  • 不指定`PrivateIpAddresses`时随机分配私有网络子网IP。", + "document": "私有网络相关信息配置，通过该参数指定私有网络的ID，子网ID，私有网络ip等信息。
  • 当指定私有网络ID和子网ID（子网必须在实例所在的可用区）与指定实例所在私有网络不一致时，会将实例迁移至指定的私有网络的子网下。
  • 可通过`PrivateIpAddresses`指定私有网络子网IP，若需指定则所有已指定的实例均需要指定子网IP，此时`InstanceIds`与`PrivateIpAddresses`一一对应。
  • 不指定`PrivateIpAddresses`时随机分配私有网络子网IP。
    • ", "example": "无", "member": "VirtualPrivateCloud", "name": "VirtualPrivateCloud", @@ -9259,8 +9259,8 @@ }, { "disabled": false, - "document": "是否对运行中的实例选择强制关机。默认为TRUE。", - "example": "无", + "document": "是否对运行中的实例选择强制关机。默认为true。", + "example": "false", "member": "bool", "name": "ForceStop", "required": false, @@ -9268,8 +9268,8 @@ }, { "disabled": false, - "document": "是否保留主机名。默认为FALSE。", - "example": "无", + "document": "是否保留主机名。默认为false。", + "example": "false", "member": "bool", "name": "ReserveHostName", "required": false, diff --git a/tccli/services/cynosdb/cynosdb_client.py b/tccli/services/cynosdb/cynosdb_client.py index 441a9e3d73..76b072c464 100644 --- a/tccli/services/cynosdb/cynosdb_client.py +++ b/tccli/services/cynosdb/cynosdb_client.py @@ -3033,6 +3033,58 @@ def doModifyClusterDatabase(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doDescribeClusterDatabaseTables(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.CynosdbClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.DescribeClusterDatabaseTablesRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.DescribeClusterDatabaseTables(model) + result = rsp.to_json_string() + try: + json_obj = json.loads(result) + except TypeError as e: + json_obj = json.loads(result.decode('utf-8')) # python3.3 + if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']: + break + cur_time = time.time() + if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']: + raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' % + (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'], + search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))) + else: + print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)) + time.sleep(g_param['OptionsDefine.WaiterInfo']['interval']) + FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) + + def doModifyParamTemplate(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -8094,6 +8146,7 @@ def doIsolateInstance(args, parsed_globals): "CloseWan": doCloseWan, "DescribeProjectSecurityGroups": doDescribeProjectSecurityGroups, "ModifyClusterDatabase": doModifyClusterDatabase, + "DescribeClusterDatabaseTables": doDescribeClusterDatabaseTables, "ModifyParamTemplate": doModifyParamTemplate, "ModifyResourcePackagesDeductionPriority": doModifyResourcePackagesDeductionPriority, "DescribeInstanceParams": doDescribeInstanceParams, diff --git a/tccli/services/cynosdb/v20190107/api.json b/tccli/services/cynosdb/v20190107/api.json index 0e01ba21db..6eff0347f0 100644 --- a/tccli/services/cynosdb/v20190107/api.json +++ b/tccli/services/cynosdb/v20190107/api.json @@ -315,6 +315,13 @@ "output": "DescribeChangedParamsAfterUpgradeResponse", "status": "online" }, + "DescribeClusterDatabaseTables": { + "document": "获取table列表", + "input": "DescribeClusterDatabaseTablesRequest", + "name": "获取table列表", + "output": "DescribeClusterDatabaseTablesResponse", + "status": "online" + }, "DescribeClusterDatabases": { "document": "本接口（DescribeClusterDatabases）用于获取集群数据库列表。", "input": "DescribeClusterDatabasesRequest", @@ -9339,6 +9346,109 @@ ], "type": "object" }, + "DescribeClusterDatabaseTablesRequest": { + "document": "DescribeClusterDatabaseTables请求参数结构体", + "members": [ + { + "disabled": false, + "document": "集群id", + "example": "xxx", + "member": "string", + "name": "ClusterId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "数据库名", + "example": "xxx", + "member": "string", + "name": "Db", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "偏移", + "example": "0", + "member": "int64", + "name": "Offset", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "个数", + "example": "10", + "member": "int64", + "name": "Limit", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "数据表类型。\n\"view\"表示只返回 view，\"base_table\" 表示只返回基本表，\"all\" 表示返回 view 和表。默认为 all。", + "example": "无", + "member": "string", + "name": "TableType", + "required": false, + "type": "string" + } + ], + "type": "object" + }, + "DescribeClusterDatabaseTablesResponse": { + "document": "DescribeClusterDatabaseTables返回参数结构体", + "members": [ + { + "disabled": false, + "document": "总条数", + "example": "1", + "member": "int64", + "name": "TotalCount", + "output_required": true, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "分页偏移", + "example": "0", + "member": "int64", + "name": "Offset", + "output_required": true, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "分页限制数量", + "example": "20", + "member": "int64", + "name": "Limit", + "output_required": true, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "数据库表列表", + "example": "[\"testtable\"]", + "member": "string", + "name": "Tables", + "output_required": true, + "type": "list", + "value_allowed_null": false + }, + { + "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "DescribeClusterDatabasesRequest": { "document": "DescribeClusterDatabases请求参数结构体", "members": [ diff --git a/tccli/services/cynosdb/v20190107/examples.json b/tccli/services/cynosdb/v20190107/examples.json index 597ed394d5..0492bcee53 100644 --- a/tccli/services/cynosdb/v20190107/examples.json +++ b/tccli/services/cynosdb/v20190107/examples.json @@ -378,6 +378,14 @@ "title": "查询升降配运行参数对比" } ], + "DescribeClusterDatabaseTables": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterDatabaseTables\n<公共请求参数>\n\n{\n \"Db\": \"xxx\",\n \"ClusterId\": \"xxx\"\n}", + "output": "{\n \"Response\": {\n \"Tables\": [\n \"testtable\"\n ],\n \"Limit\": 20,\n \"Offset\": 0,\n \"RequestId\": \"198189\",\n \"TotalCount\": 1\n }\n}", + "title": "获取table列表" + } + ], "DescribeClusterDatabases": [ { "document": "", diff --git a/tccli/services/domain/v20180808/api.json b/tccli/services/domain/v20180808/api.json index 63d1c7a9bf..f608b13e6a 100644 --- a/tccli/services/domain/v20180808/api.json +++ b/tccli/services/domain/v20180808/api.json @@ -1965,7 +1965,7 @@ { "disabled": false, "document": "日志详情列表。\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "[]", + "example": "[{\"UpdatedOn\": \"2024-12-18 12:21:16\",\"BigDealId\": \"\",\"TransferDnsResult\": null,\"Action\": \"batch_modify_domain_dns1\",\"Status\": \"failed\",\"Domain\": \"***.com\",\"ReasonZh\": \"域名已开启【禁止更新锁】保护域名信息安全，不能修改信息。如需操作，请先关闭【禁止更新锁】\",\"CreatedOn\": \"2024-12-18 12:21:12\",\"Reason\": \"域名已开启【禁止更新锁】保护域名信息安全，不能修改信息。如需操作，请先关闭【禁止更新锁】\",\"PayStatus\": 0,\"Id\": 1001}]", "member": "DomainBatchDetailSet", "name": "DomainBatchDetailSet", "output_required": true, @@ -2783,7 +2783,7 @@ { "disabled": false, "document": "自定义DNS Host 列表\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "[]", + "example": "[{\"IpSet\": [\"2.2.2.2\"],\"DnsName\": \"a1.dns.dns\"}]", "member": "CustomDnsHost", "name": "DnsHostSet", "output_required": true, @@ -2830,7 +2830,7 @@ { "disabled": false, "document": "域名信息", - "example": "[]", + "example": "{\"DomainId\": \"domain-xxxxx\",\"DomainName\": \"tencent.com\",\"NameServer\": [\"f1g1ns1.dnspod.net\", \"f1g1ns2.dnspod.net\"],\"RegistrarType\": \"epp\",\"DomainStatus\": [\"ok\"],\"BuyStatus\": \"ok\",\"RealNameAuditUnpassReason\": \"\",\"DomainNameAuditUnpassReason\": \"\",\"RealNameAuditStatus\": \"Approved\",\"ExpirationDate\": \"2020-11-14\",\"CreationDate\": \"2019-11-14\",\"DomainNameAuditStatus\": \"Approved\",\"LockTransfer\": true,\"LockEndTime\": \"2021-12-28 18:00:00\"}", "member": "DomainBaseInfo", "name": "DomainInfo", "output_required": true, @@ -2840,7 +2840,7 @@ { "disabled": false, "document": "用户Uin\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "1111", + "example": "100**328", "member": "string", "name": "Uin", "output_required": true, @@ -2988,7 +2988,7 @@ { "disabled": false, "document": "域名信息", - "example": "[]", + "example": "{\"RegistrantType\": \"I\", \"DomainId\": \"domain-**q\", \"OrganizationName\": \"**ng\", \"ExpirationDate\": \"2025-03-19\", \"DomainName\": \"*g.top\", \"RegistrarType\": \"epp\", \"LockEndTime\": \"\", \"OrganizationNameCN\": \"*铭\", \"RegistrantName\": \"**ng\", \"DomainStatus\": [\"clientTransferProhibited\", \"clientUpdateProhibited\"], \"BuyStatus\": \"ok\", \"RegistrantNameCN\": \"*铭\", \"RealNameAuditStatus\": \"Approved\", \"DomainNameAuditStatus\": \"Approved\", \"LockTransfer\": false, \"NameServer\": [\"expire01.dnspod.net\", \"expire02.dnspod.net\"], \"CreationDate\": \"2022-03-19\", \"RealNameAuditUnpassReason\": \"\", \"DomainNameAuditUnpassReason\": \"\"}", "member": "DomainSimpleInfo", "name": "DomainInfo", "output_required": true, @@ -2998,7 +2998,7 @@ { "disabled": false, "document": "账号ID", - "example": "123456", + "example": "100**328", "member": "string", "name": "Uin", "output_required": true, @@ -3798,7 +3798,7 @@ { "disabled": false, "document": "模板详细信息列表。", - "example": "[]", + "example": "[{\"AuditReason\": \"\",\"ContactInfo\": {\"Province\": \"hu nan sheng\",\"RegistrantType\": \"I\",\"OrganizationName\": \"org name\",\"OrganizationNameCN\": \"企业名称\",\"Country\": \"CN\",\"RegistrantName\": \"shi ming name\",\"ZipCode\": \"425000\",\"Telephone\": \"155*********\",\"City\": \"ce shi\",\"RegistrantNameCN\": \"实名人\",\"StreetCN\": \"咸嘉湖街道\",\"Street\": \"xian jia hu jie dao\",\"ProvinceCN\": \"湖南省\",\"CityCN\": \"长沙市\",\"CountryCN\": \"中国\",\"Email\": \"**d@dnspod.com\"},\"UpdatedOn\": \"2020-07-28 13:33:55\",\"AuditStatus\": \"InAudit\",\"IsBlack\": false,\"CreatedOn\": \"2020-07-28 12:50:23\",\"UserUin\": \"12334********\",\"IsDefault\": \"no\",\"TemplateId\": \"tmpl-dgmgwpe2\",\"InvalidReason\": \"\",\"IsValidTemplate\": 1,\"CertificateInfo\": {\"CertificateType\": \"SFZ\",\"CertificateCode\": \"12345679\",\"ImgUrl\": \"https://image.com/******\",\"OriginImgUrl\": \"https://tencentyun.com/******\",\"RegistrantCertificateCode\": \"12345679\",\"RegistrantCertificateType\": \"SFZ\",\"RegistrantImgUrl\": \"https://image.com/******\"}}]", "member": "TemplateInfo", "name": "TemplateSet", "output_required": true, @@ -3819,8 +3819,8 @@ "members": [ { "disabled": false, - "document": "模板ID", - "example": "", + "document": "模板ID(模板列表接口可获取)", + "example": "tmpl-itxxxxxx", "member": "string", "name": "TemplateId", "required": true, @@ -3835,9 +3835,10 @@ { "disabled": false, "document": "模板信息", - "example": "", + "example": "{\"AuditReason\": \"\",\"ContactInfo\": {\"Province\": \"hu nan sheng\",\"RegistrantType\": \"I\",\"OrganizationName\": \"ce shi\",\"OrganizationNameCN\": \"测试\",\"Country\": \"CN\",\"RegistrantName\": \"ce shi\",\"ZipCode\": \"425000\",\"Telephone\": \"155*********\",\"City\": \"ce shi\",\"RegistrantNameCN\": \"测试\",\"StreetCN\": \"咸嘉湖街道\",\"Street\": \"xian jia hu jie dao\",\"ProvinceCN\": \"湖南省\",\"CityCN\": \"长沙市\",\"CountryCN\": \"中国\",\"Email\": \"dnspod@dnspod.com\"},\"UpdatedOn\": \"2020-07-28 13:33:55\",\"AuditStatus\": \"InAudit\",\"CreatedOn\": \"2020-07-28 12:50:23\",\"UserUin\": \"12334********\",\"IsDefault\": \"no\",\"TemplateId\": \"tmpl-dgxxxxxx\",\"InvalidReason\": \"\",\"IsValidTemplate\": 1,\"CertificateInfo\": {\"CertificateType\": \"SFZ\",\"CertificateCode\": \"12345679\",\"ImgUrl\": \"https://tencentyun.com/******\"}}", "member": "TemplateInfo", "name": "Template", + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -4758,7 +4759,7 @@ { "disabled": false, "document": "转入账户的uin。", - "example": "123456", + "example": "1000**238", "member": "string", "name": "NewOwnerUin", "required": true, @@ -4776,7 +4777,7 @@ { "disabled": false, "document": "转入账户的appid。", - "example": "123456", + "example": "10023322", "member": "string", "name": "NewOwnerAppId", "required": false, @@ -4794,7 +4795,7 @@ "example": "425", "member": "uint64", "name": "LogId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -4813,7 +4814,7 @@ { "disabled": false, "document": "域名ID", - "example": "abc", + "example": "domain-222222q", "member": "string", "name": "DomainId", "required": true, @@ -4822,7 +4823,7 @@ { "disabled": false, "document": "DNS Host", - "example": "abc", + "example": "ns1.dns.net", "member": "string", "name": "DnsName", "required": true, @@ -5994,7 +5995,7 @@ "example": "54", "member": "uint64", "name": "LogId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -6120,7 +6121,7 @@ { "disabled": false, "document": "资质照片地址。", - "example": "xxxxx", + "example": "http://cos.url/image.jpg", "member": "string", "name": "AccessUrl", "output_required": true, diff --git a/tccli/services/domain/v20180808/examples.json b/tccli/services/domain/v20180808/examples.json index f3bbee7ea8..131bdc71f5 100644 --- a/tccli/services/domain/v20180808/examples.json +++ b/tccli/services/domain/v20180808/examples.json @@ -91,7 +91,7 @@ "DeleteBidding": [ { "document": "删除记录", - "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteBidding\n<公共请求参数>\n\n{\n \"BusinessID\": \"xxxx\"\n}", + "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteBidding\n<公共请求参数>\n\n{\n \"BusinessID\": \"*****2561\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"e5ae6a11-ad75-4196-8176-9d72bc287eda\"\n }\n}", "title": "删除记录" } @@ -140,7 +140,7 @@ { "document": "", "input": "https://domain.tencentcloudapi.com/?Action=DescribeBatchOperationLogDetails\n&Offset=0\n&Limit=20\n&LogId=1\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"DomainBatchDetailSet\": [\n {\n \"Id\": 0,\n \"Action\": \"abc\",\n \"Domain\": \"abc\",\n \"Status\": \"abc\",\n \"Reason\": \"abc\",\n \"CreatedOn\": \"abc\",\n \"UpdatedOn\": \"abc\",\n \"BigDealId\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"f376d0e6-f064-1234-b27f-a8ae3b054dfa\",\n \"DomainBatchDetailSet\": [\n {\n \"UpdatedOn\": \"2024-12-18 12:21:16\",\n \"BigDealId\": \"\",\n \"Action\": \"batch_modify_domain_dns1\",\n \"Status\": \"failed\",\n \"Domain\": \"***.com\",\n \"CreatedOn\": \"2024-12-18 12:21:12\",\n \"Reason\": \"域名已开启【禁止更新锁】保护域名信息安全，不能修改信息。如需操作，请先关闭【禁止更新锁】\",\n \"Id\": 1001\n }\n ]\n }\n}", "title": "批量操作日志详情" } ], @@ -155,7 +155,7 @@ "DescribeBiddingAppointDetail": [ { "document": "我预定的域名-预约详情", - "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingAppointDetail\n<公共请求参数>\n\n{\n \"BusinessID\": \"xxxx\"\n}", + "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingAppointDetail\n<公共请求参数>\n\n{\n \"BusinessID\": \"***561\"\n}", "output": "{\n \"Response\": {\n \"AppointBondPrice\": 70,\n \"AppointEndTime\": \"2023-10-28 09:53:48\",\n \"AppointNum\": 1,\n \"AppointPrice\": 105,\n \"AppointStartTime\": \"2023-10-18 09:53:48\",\n \"DeleteTime\": \"2023-11-28 09:53:48\",\n \"Domain\": \"sasdfzcccc2216.com\",\n \"ExpireTime\": \"2023-09-28 09:53:48\",\n \"RegTime\": \"2022-09-28 09:53:48\",\n \"RequestId\": \"e0d60073-3fbb-4216-ba20-7ccad80d030a\",\n \"Status\": 7\n }\n}", "title": "我预定的域名-预约详情" } @@ -164,15 +164,15 @@ { "document": "我的预约列表", "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingAppointList\n<公共请求参数>\n\n{\n \"PageNumber\": 1,\n \"PageSize\": 20\n}", - "output": "{\n \"Response\": {\n \"AppointList\": [\n {\n \"AppointBondPrice\": 70,\n \"AppointEndTime\": \"2023-10-28T09:53:48+08:00\",\n \"AppointNum\": 1,\n \"AppointPrice\": 105,\n \"BusinessID\": \"xxxx\",\n \"Domain\": \"sasdfzcccc2216.com\",\n \"Status\": 1\n }\n ],\n \"RequestId\": \"02f51803-507c-40ad-b26a-9a0178fa7ffc\",\n \"Total\": 1\n }\n}", + "output": "{\n \"Response\": {\n \"AppointList\": [\n {\n \"AppointBondPrice\": 70,\n \"AppointEndTime\": \"2023-10-28T09:53:48+08:00\",\n \"AppointNum\": 1,\n \"AppointPrice\": 105,\n \"BusinessID\": \"***561\",\n \"Domain\": \"sasdfzcccc2216.com\",\n \"Status\": 1\n }\n ],\n \"RequestId\": \"02f51803-507c-40ad-b26a-9a0178fa7ffc\",\n \"Total\": 1\n }\n}", "title": "我的预约列表" } ], "DescribeBiddingDetail": [ { "document": "我竞价的域名-竞价详情", - "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingDetail\n<公共请求参数>\n\n{\n \"BusinessID\": \"xxxx\"\n}", - "output": "{\n \"Response\": {\n \"BiddingBondPrice\": 80,\n \"BiddingBondRefund\": \"no\",\n \"BiddingEndTime\": \"2023-11-04 09:53:48\",\n \"BiddingFlag\": 1,\n \"BiddingNum\": 1,\n \"BiddingPrice\": 150,\n \"BiddingStartTime\": \"2023-10-28 09:53:48\",\n \"CurrentNickname\": \"feng\",\n \"CurrentPrice\": 120,\n \"DeleteTime\": \"2023-11-28 09:53:48\",\n \"Domain\": \"sasdfzcccc2216.com\",\n \"ExpireTime\": \"2023-09-28 09:53:48\",\n \"RegTime\": \"2022-09-28 09:53:48\",\n \"RequestId\": \"5fdc5b55-514b-42f8-85a3-e269db61f752\",\n \"Status\": 2\n }\n}", + "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingDetail\n<公共请求参数>\n\n{\n \"BusinessID\": \"***561\"\n}", + "output": "{\n \"Response\": {\n \"BiddingBondPrice\": 80,\n \"BiddingBondRefund\": \"no\",\n \"BiddingEndTime\": \"2023-11-04 09:53:48\",\n \"BiddingFlag\": 1,\n \"BiddingNum\": 1,\n \"BiddingPrice\": 150,\n \"BiddingStartTime\": \"2023-10-28 09:53:48\",\n \"CurrentNickname\": \"feng\",\n \"CurrentPrice\": 120,\n \"DeleteTime\": \"2023-11-28 09:53:48\",\n \"Domain\": \"***16.com\",\n \"ExpireTime\": \"2023-09-28 09:53:48\",\n \"RegTime\": \"2022-09-28 09:53:48\",\n \"RequestId\": \"5fdc5b55-514b-42f8-85a3-e269db61f752\",\n \"Status\": 2\n }\n}", "title": "我竞价的域名-竞价详情" } ], @@ -180,15 +180,15 @@ { "document": "我的竞价列表", "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingList\n<公共请求参数>\n\n{\n \"PageNumber\": 1,\n \"PageSize\": 20\n}", - "output": "{\n \"Response\": {\n \"BiddingList\": [\n {\n \"BiddingBondPrice\": 0,\n \"BiddingEndTime\": \"2023-11-04 09:53:48\",\n \"BiddingFlag\": 0,\n \"BiddingNum\": 1,\n \"BiddingPrice\": 0,\n \"BusinessID\": \"xxxx\",\n \"CurrentNickname\": \"feng\",\n \"CurrentPrice\": 120,\n \"Domain\": \"sasdfzcccc2216.com\",\n \"Status\": 7\n },\n {\n \"BiddingBondPrice\": 80,\n \"BiddingEndTime\": \"2023-11-04 09:53:48\",\n \"BiddingFlag\": 1,\n \"BiddingNum\": 1,\n \"BiddingPrice\": 150,\n \"BusinessID\": \"xxxx\",\n \"CurrentNickname\": \"feng\",\n \"CurrentPrice\": 120,\n \"Domain\": \"sasdfzcccc2216.com\",\n \"Status\": 2\n }\n ],\n \"RequestId\": \"560e00d9-ddf1-4d4b-a3d8-461eb8c8e40c\",\n \"Total\": 2\n }\n}", + "output": "{\n \"Response\": {\n \"BiddingList\": [\n {\n \"BiddingBondPrice\": 0,\n \"BiddingEndTime\": \"2023-11-04 09:53:48\",\n \"BiddingFlag\": 0,\n \"BiddingNum\": 1,\n \"BiddingPrice\": 0,\n \"BusinessID\": \"***2561\",\n \"CurrentNickname\": \"feng\",\n \"CurrentPrice\": 120,\n \"Domain\": \"s***16.com\",\n \"Status\": 7\n },\n {\n \"BiddingBondPrice\": 80,\n \"BiddingEndTime\": \"2023-11-04 09:53:48\",\n \"BiddingFlag\": 1,\n \"BiddingNum\": 1,\n \"BiddingPrice\": 150,\n \"BusinessID\": \"***561\",\n \"CurrentNickname\": \"feng\",\n \"CurrentPrice\": 120,\n \"Domain\": \"***16.com\",\n \"Status\": 2\n }\n ],\n \"RequestId\": \"560e00d9-ddf1-4d4b-a3d8-461eb8c8e40c\",\n \"Total\": 2\n }\n}", "title": "我的竞价列表" } ], "DescribeBiddingSuccessfulDetail": [ { "document": "我得标的域名-得标详情", - "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingSuccessfulDetail\n<公共请求参数>\n\n{\n \"BusinessID\": \"xxxx\"\n}", - "output": "{\n \"Response\": {\n \"BiddingBondPrice\": 80,\n \"BiddingBondRefund\": \"no\",\n \"DeleteTime\": \"2023-11-28 09:53:48\",\n \"Domain\": \"sasdfzcccc2216.com\",\n \"ExpireTime\": \"2023-09-28 09:53:48\",\n \"PayEndTime\": \"2023-11-07 09:53:48\",\n \"RegTime\": \"2022-09-28 09:53:48\",\n \"RequestId\": \"7a179528-6d80-495b-8e6c-14b935eccec9\",\n \"Status\": 5,\n \"SuccessfulPrice\": 200,\n \"SuccessfulTime\": \"2023-10-25 16:00:00\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingSuccessfulDetail\n<公共请求参数>\n\n{\n \"BusinessID\": \"***2561\"\n}", + "output": "{\n \"Response\": {\n \"BiddingBondPrice\": 80,\n \"BiddingBondRefund\": \"no\",\n \"DeleteTime\": \"2023-11-28 09:53:48\",\n \"Domain\": \"***16.com\",\n \"ExpireTime\": \"2023-09-28 09:53:48\",\n \"PayEndTime\": \"2023-11-07 09:53:48\",\n \"RegTime\": \"2022-09-28 09:53:48\",\n \"RequestId\": \"7a179528-6d80-495b-8e6c-14b935eccec9\",\n \"Status\": 5,\n \"SuccessfulPrice\": 200,\n \"SuccessfulTime\": \"2023-10-25 16:00:00\"\n }\n}", "title": "我得标的域名-得标详情" } ], @@ -204,7 +204,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCustomDnsHostSet\n<公共请求参数>\n\n{\n \"DomainId\": \"domain-esysdasdgq\",\n \"Offset\": 0,\n \"Limit\": 3\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 2,\n \"RequestId\": \"bd4fc5332-23a2-49bd-8cab-48cfe5963651\",\n \"DnsHostSet\": [\n {\n \"IpSet\": [\n \"2.2.2.2\"\n ],\n \"DnsName\": \"bbbb\"\n },\n {\n \"IpSet\": [\n \"8.8.9.9\",\n \"3.3.3.3\"\n ],\n \"DnsName\": \"aaa\"\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 2,\n \"RequestId\": \"bd4fc5332-23a2-49bd-8cab-48cfe5963651\",\n \"DnsHostSet\": [\n {\n \"IpSet\": [\n \"2.2.2.2\"\n ],\n \"DnsName\": \"a1.dns.dns\"\n },\n {\n \"IpSet\": [\n \"8.8.9.9\",\n \"3.3.3.3\"\n ],\n \"DnsName\": \"a2.dns.dns\"\n }\n ]\n }\n}", "title": "查询自定义DNS Host列表" } ], @@ -212,7 +212,7 @@ { "document": "", "input": "https://domain.tencentcloudapi.com/?Action=DescribeDomainBaseInfo\n&Domain=域名\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"DomainInfo\": {\n \"DomainId\": \"domain-xxxxx\",\n \"DomainName\": \"tencent.com\",\n \"NameServer\": [\n \"f1g1ns1.dnspod.net\",\n \"f1g1ns2.dnspod.net\"\n ],\n \"RegistrarType\": \"epp\",\n \"DomainStatus\": [\n \"ok\"\n ],\n \"BuyStatus\": \"ok\",\n \"RealNameAuditUnpassReason\": \"\",\n \"DomainNameAuditUnpassReason\": \"\",\n \"RealNameAuditStatus\": \"Approved\",\n \"ExpirationDate\": \"2020-11-14\",\n \"CreationDate\": \"2019-11-14\",\n \"DomainNameAuditStatus\": \"Approved\",\n \"LockTransfer\": true,\n \"LockEndTime\": \"2021-12-28 18:00:00\"\n },\n \"RequestId\": \"1b76dd88-64d0-4bd1-9cb8-c20de11c3686\",\n \"Uin\": \"1111\"\n }\n}", + "output": "{\n \"Response\": {\n \"DomainInfo\": {\n \"DomainId\": \"domain-xxxxx\",\n \"DomainName\": \"tencent.com\",\n \"NameServer\": [\n \"f1g1ns1.dnspod.net\",\n \"f1g1ns2.dnspod.net\"\n ],\n \"RegistrarType\": \"epp\",\n \"DomainStatus\": [\n \"ok\"\n ],\n \"BuyStatus\": \"ok\",\n \"RealNameAuditUnpassReason\": \"\",\n \"DomainNameAuditUnpassReason\": \"\",\n \"RealNameAuditStatus\": \"Approved\",\n \"ExpirationDate\": \"2020-11-14\",\n \"CreationDate\": \"2019-11-14\",\n \"DomainNameAuditStatus\": \"Approved\",\n \"LockTransfer\": true,\n \"LockEndTime\": \"2021-12-28 18:00:00\"\n },\n \"RequestId\": \"1b76dd88-64d0-4bd1-9cb8-c20de11c3686\",\n \"Uin\": \"100**328\"\n }\n}", "title": "获取域名基础信息" } ], @@ -236,15 +236,15 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDomainSimpleInfo\n<公共请求参数>\n\n{\n \"DomainName\": \"test.cn\"\n}", - "output": "{\n \"Response\": {\n \"DomainInfo\": {\n \"RegistrantType\": \"E\",\n \"DomainId\": \"domain-1234abcd\",\n \"OrganizationName\": \"tencent cloud\",\n \"ExpirationDate\": \"2018-08-08\",\n \"DomainName\": \"cloud.tencent.com\",\n \"RegistrarType\": \"qcloud\",\n \"LockEndTime\": \"\",\n \"OrganizationNameCN\": \"腾讯云\",\n \"RegistrantName\": \"tencent\",\n \"DomainStatus\": [\n \"ok\"\n ],\n \"BuyStatus\": \"ok\",\n \"RegistrantNameCN\": \"腾讯云\",\n \"RealNameAuditStatus\": \"Approved\",\n \"DomainNameAuditStatus\": \"Approved\",\n \"LockTransfer\": false,\n \"NameServer\": [\n \"ns2.qq.com\",\n \"ns4.qq.com\",\n \"ns3.qq.com\",\n \"ns1.qq.com\"\n ],\n \"CreationDate\": \"2018-08-08\",\n \"RealNameAuditUnpassReason\": \"\",\n \"DomainNameAuditUnpassReason\": \"\"\n },\n \"RequestId\": \"88888888-8888-8888-8888-888888888888\",\n \"Uin\": \"100000000001\"\n }\n}", + "output": "{\n \"Response\": {\n \"DomainInfo\": {\n \"RegistrantType\": \"E\",\n \"DomainId\": \"domain-1234abcd\",\n \"OrganizationName\": \"tencent cloud\",\n \"ExpirationDate\": \"2018-08-08\",\n \"DomainName\": \"cent.com\",\n \"RegistrarType\": \"qcloud\",\n \"LockEndTime\": \"\",\n \"OrganizationNameCN\": \"腾讯云\",\n \"RegistrantName\": \"tencent\",\n \"DomainStatus\": [\n \"ok\"\n ],\n \"BuyStatus\": \"ok\",\n \"RegistrantNameCN\": \"腾讯云\",\n \"RealNameAuditStatus\": \"Approved\",\n \"DomainNameAuditStatus\": \"Approved\",\n \"LockTransfer\": false,\n \"NameServer\": [\n \"ns2.qq.com\",\n \"ns4.qq.com\",\n \"ns3.qq.com\",\n \"ns1.qq.com\"\n ],\n \"CreationDate\": \"2018-08-08\",\n \"RealNameAuditUnpassReason\": \"\",\n \"DomainNameAuditUnpassReason\": \"\"\n },\n \"RequestId\": \"88888888-8888-8888-8888-888888888888\",\n \"Uin\": \"100000000001\"\n }\n}", "title": "域名详情" } ], "DescribePayWaitDetail": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePayWaitDetail\n<公共请求参数>\n\n{\n \"BusinessId\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"Domain\": \"abc\",\n \"Status\": \"abc\",\n \"EndTime\": \"abc\",\n \"RegTime\": \"abc\",\n \"Price\": 0,\n \"RetDeposit\": 0,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePayWaitDetail\n<公共请求参数>\n\n{\n \"BusinessId\": \"***561\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"45559f25-13b9-42fd-b2ae-698842d91fd7\",\n \"Domain\": \"*1.top\",\n \"Status\": \"pay\",\n \"EndTime\": \"2024-12-19 07:24:25\",\n \"RegTime\": \"2023-11-11 07:24:25\",\n \"Price\": 98,\n \"RetDeposit\": 32\n }\n}", "title": "等待支付详情接口" } ], @@ -306,15 +306,15 @@ { "document": "", "input": "https://domain.tencentcloudapi.com/?Action=DescribeTemplate\n&TemplateId=模板ID\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"0c209d0e-f244-435f-8222-d86741c3edbd\",\n \"Template\": {\n \"AuditReason\": \"\",\n \"ContactInfo\": {\n \"Province\": \"hu nan sheng\",\n \"RegistrantType\": \"I\",\n \"OrganizationName\": \"ce shi\",\n \"OrganizationNameCN\": \"测试\",\n \"Country\": \"CN\",\n \"RegistrantName\": \"ce shi\",\n \"ZipCode\": \"425000\",\n \"Telephone\": \"155*********\",\n \"City\": \"ce shi\",\n \"RegistrantNameCN\": \"测试\",\n \"StreetCN\": \"咸嘉湖街道\",\n \"Street\": \"xian jia hu jie dao\",\n \"ProvinceCN\": \"湖南省\",\n \"CityCN\": \"长沙市\",\n \"CountryCN\": \"中国\",\n \"Email\": \"dnspod@dnspod.com\"\n },\n \"UpdatedOn\": \"2020-07-28 13:33:55\",\n \"AuditStatus\": \"InAudit\",\n \"CreatedOn\": \"2020-07-28 12:50:23\",\n \"UserUin\": \"12334********\",\n \"IsDefault\": \"no\",\n \"TemplateId\": \"tmpl-dgmgwpe2\",\n \"InvalidReason\": \"\",\n \"IsValidTemplate\": 1,\n \"CertificateInfo\": {\n \"CertificateType\": \"SFZ\",\n \"CertificateCode\": \"12345679\",\n \"ImgUrl\": \"https://tencentyun.com/******\"\n }\n }\n },\n \"ResultStatus\": true\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"0c209d0e-f244-435f-8222-d86741c3edbd\",\n \"Template\": {\n \"AuditReason\": \"\",\n \"ContactInfo\": {\n \"Province\": \"hu nan sheng\",\n \"RegistrantType\": \"I\",\n \"OrganizationName\": \"yan zheng org name\",\n \"OrganizationNameCN\": \"验证的企业名称\",\n \"Country\": \"CN\",\n \"RegistrantName\": \"registrant name\",\n \"ZipCode\": \"425000\",\n \"Telephone\": \"155*********\",\n \"City\": \"ce shi\",\n \"RegistrantNameCN\": \"注册人名称\",\n \"StreetCN\": \"咸嘉湖街道\",\n \"Street\": \"xian jia hu jie dao\",\n \"ProvinceCN\": \"湖南省\",\n \"CityCN\": \"长沙市\",\n \"CountryCN\": \"中国\",\n \"Email\": \"dnspod@dnspod.com\"\n },\n \"UpdatedOn\": \"2020-07-28 13:33:55\",\n \"AuditStatus\": \"InAudit\",\n \"IsBlack\": false,\n \"CreatedOn\": \"2020-07-28 12:50:23\",\n \"UserUin\": \"12334********\",\n \"IsDefault\": \"no\",\n \"TemplateId\": \"tmpl-dgmgwpe2\",\n \"InvalidReason\": \"\",\n \"IsValidTemplate\": 1,\n \"CertificateInfo\": {\n \"CertificateType\": \"SFZ\",\n \"CertificateCode\": \"12345679\",\n \"ImgUrl\": \"https://image.com/******\",\n \"OriginImgUrl\": \"https://tencentyun.com/******\",\n \"RegistrantCertificateCode\": \"12345679\",\n \"RegistrantCertificateType\": \"SFZ\",\n \"RegistrantImgUrl\": \"https://image.com/******\"\n }\n }\n }\n}", "title": "获取模板信息" } ], "DescribeTemplateList": [ { "document": "信息模板列表", - "input": "https://domain.tencentcloudapi.com/?Action=DescribeTemplateList\n&Offset=0\n&Limit=20\n&Status=InAudit\n&Type=E\n&Keyword=abc\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"TemplateSet\": [\n {\n \"AuditReason\": \"\",\n \"ContactInfo\": {\n \"Province\": \"hu nan sheng\",\n \"RegistrantType\": \"I\",\n \"OrganizationName\": \"ce shi\",\n \"OrganizationNameCN\": \"测试\",\n \"Country\": \"CN\",\n \"RegistrantName\": \"ce shi\",\n \"ZipCode\": \"425000\",\n \"Telephone\": \"155*********\",\n \"City\": \"ce shi\",\n \"RegistrantNameCN\": \"测试\",\n \"StreetCN\": \"咸嘉湖街道\",\n \"Street\": \"xian jia hu jie dao\",\n \"ProvinceCN\": \"湖南省\",\n \"CityCN\": \"长沙市\",\n \"CountryCN\": \"中国\",\n \"Email\": \"dnspod@dnspod.com\"\n },\n \"UpdatedOn\": \"2020-07-28 13:33:55\",\n \"AuditStatus\": \"InAudit\",\n \"IsBlack\": false,\n \"CreatedOn\": \"2020-07-28 12:50:23\",\n \"UserUin\": \"12334********\",\n \"IsDefault\": \"no\",\n \"TemplateId\": \"tmpl-dgmgwpe2\",\n \"InvalidReason\": \"\",\n \"IsValidTemplate\": 1,\n \"CertificateInfo\": {\n \"CertificateType\": \"SFZ\",\n \"CertificateCode\": \"12345679\",\n \"ImgUrl\": \"https://image.com/******\",\n \"OriginImgUrl\": \"https://tencentyun.com/******\",\n \"RegistrantCertificateCode\": \"12345679\",\n \"RegistrantCertificateType\": \"SFZ\",\n \"RegistrantImgUrl\": \"https://image.com/******\"\n }\n }\n ],\n \"RequestId\": \"skdwd-eoffew-dwdwq-dwdw\"\n }\n}", + "input": "https://domain.tencentcloudapi.com/?Action=DescribeTemplateList\n&Offset=0\n&Limit=20\n&Status=InAudit\n&Type=E\n&Keyword=search_name\n&<公共请求参数>", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"TemplateSet\": [\n {\n \"AuditReason\": \"\",\n \"ContactInfo\": {\n \"Province\": \"hu nan sheng\",\n \"RegistrantType\": \"I\",\n \"OrganizationName\": \"org name\",\n \"OrganizationNameCN\": \"企业名称\",\n \"Country\": \"CN\",\n \"RegistrantName\": \"shi ming name\",\n \"ZipCode\": \"425000\",\n \"Telephone\": \"155*********\",\n \"City\": \"ce shi\",\n \"RegistrantNameCN\": \"实名人\",\n \"StreetCN\": \"咸嘉湖街道\",\n \"Street\": \"xian jia hu jie dao\",\n \"ProvinceCN\": \"湖南省\",\n \"CityCN\": \"长沙市\",\n \"CountryCN\": \"中国\",\n \"Email\": \"**d@dnspod.com\"\n },\n \"UpdatedOn\": \"2020-07-28 13:33:55\",\n \"AuditStatus\": \"InAudit\",\n \"IsBlack\": false,\n \"CreatedOn\": \"2020-07-28 12:50:23\",\n \"UserUin\": \"12334********\",\n \"IsDefault\": \"no\",\n \"TemplateId\": \"tmpl-dgmgwpe2\",\n \"InvalidReason\": \"\",\n \"IsValidTemplate\": 1,\n \"CertificateInfo\": {\n \"CertificateType\": \"SFZ\",\n \"CertificateCode\": \"12345679\",\n \"ImgUrl\": \"https://image.com/******\",\n \"OriginImgUrl\": \"https://tencentyun.com/******\",\n \"RegistrantCertificateCode\": \"12345679\",\n \"RegistrantCertificateType\": \"SFZ\",\n \"RegistrantImgUrl\": \"https://image.com/******\"\n }\n }\n ],\n \"RequestId\": \"skdwd-eoffew-dwdwq-dwdw\"\n }\n}", "title": "信息模板列表" } ], @@ -329,8 +329,8 @@ "DescribeUnPreDomainDetail": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUnPreDomainDetail\n<公共请求参数>\n\n{\n \"Domain\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"Domain\": \"abc\",\n \"PreCount\": 0,\n \"RegTime\": \"abc\",\n \"DeleteTime\": \"abc\",\n \"ExpireTime\": \"abc\",\n \"Status\": \"abc\",\n \"CurrentPrice\": 0,\n \"AppointBondPrice\": 0,\n \"IsAppoint\": true,\n \"BusinessId\": \"abc\",\n \"IsDomainUser\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUnPreDomainDetail\n<公共请求参数>\n\n{\n \"Domain\": \"**m.com\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"cd4379ce-0fb7-1234-bc2f-5a68df5bcd20\",\n \"Domain\": \"**m.com\",\n \"PreCount\": 8,\n \"RegTime\": \"2005-11-23 02:26:00\",\n \"DeleteTime\": \"2025-01-23 02:26:00\",\n \"ExpireTime\": \"2024-12-23 02:26:00\",\n \"Status\": \"ing\",\n \"CurrentPrice\": 198,\n \"AppointBondPrice\": 90,\n \"IsAppoint\": false,\n \"BusinessId\": \"***046\",\n \"IsDomainUser\": false\n }\n}", "title": "查询预释放未预约域名详情接口" } ], @@ -353,7 +353,7 @@ "ModifyDomainOwnerBatch": [ { "document": "域名批量过户", - "input": "POST / HTTP/1.1\nHost:domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyDomainOwnerBatch\n<公共请求参数>\n\n{\n \"Domains\": [\n \"h101.tencent.com\"\n ],\n \"NewOwnerUin\": \"123456\"\n}", + "input": "POST / HTTP/1.1\nHost:domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyDomainOwnerBatch\n<公共请求参数>\n\n{\n \"Domains\": [\n \"h101.tencent.com\"\n ],\n \"NewOwnerUin\": \"100**238\"\n}", "output": "{\n \"Response\": {\n \"LogId\": 425,\n \"RequestId\": \"3c59eccc-efca-4109-1111-37e2e2bce25f\"\n }\n}", "title": "域名过户" } @@ -417,7 +417,7 @@ "TransferInDomainBatch": [ { "document": "", - "input": "POST / HTTP/1.1\nHost:domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TransferInDomainBatch\n<公共请求参数>\n\n{\n \"TemplateId\": \"tmpl-xxxxx\",\n \"Domains\": [\n \"h101.tencent.com\"\n ],\n \"PassWords\": [\n \"123456\"\n ],\n \"PayMode\": 0\n}", + "input": "POST / HTTP/1.1\nHost:domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TransferInDomainBatch\n<公共请求参数>\n\n{\n \"TemplateId\": \"tmpl-xxxxx\",\n \"Domains\": [\n \"h101.tencent.com\"\n ],\n \"PassWords\": [\n \"password\"\n ],\n \"PayMode\": 0\n}", "output": "{\n \"Response\": {\n \"LogId\": 54,\n \"RequestId\": \"ac64c5c2-c0f0-11ea-ba13-080027f4585e\"\n }\n}", "title": "批量域名转入" } @@ -442,7 +442,7 @@ { "document": "", "input": "https://domain.tencentcloudapi.com/?Action=UploadImage\n&ImageFile=资质照片\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"AccessUrl\": \"xxxxx\",\n \"RequestId\": \"1b76dd88-64d0-4bd1-9cb8-c20de11c3686\"\n }\n}", + "output": "{\n \"Response\": {\n \"AccessUrl\": \"http://cos.url/image.jpg\",\n \"RequestId\": \"1b76dd88-64d0-4bd1-9cb8-c20de11c3686\"\n }\n}", "title": "证件图片上传" } ] diff --git a/tccli/services/ess/ess_client.py b/tccli/services/ess/ess_client.py index 739de610e6..ab4fa21561 100644 --- a/tccli/services/ess/ess_client.py +++ b/tccli/services/ess/ess_client.py @@ -4333,6 +4333,58 @@ def doDescribeCancelFlowsTask(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doCreateSchemeUrl(args, parsed_globals): + g_param = parse_global_arg(parsed_globals) + + if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: + cred = credential.CVMRoleCredential() + elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]: + cred = credential.STSAssumeRoleCredential( + g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')], + g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"] + ) + elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN): + cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials() + else: + cred = credential.Credential( + g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token] + ) + http_profile = HttpProfile( + reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]), + reqMethod="POST", + endpoint=g_param[OptionsDefine.Endpoint], + proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')] + ) + profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256") + if g_param[OptionsDefine.Language]: + profile.language = g_param[OptionsDefine.Language] + mod = CLIENT_MAP[g_param[OptionsDefine.Version]] + client = mod.EssClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.CreateSchemeUrlRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.CreateSchemeUrl(model) + result = rsp.to_json_string() + try: + json_obj = json.loads(result) + except TypeError as e: + json_obj = json.loads(result.decode('utf-8')) # python3.3 + if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']: + break + cur_time = time.time() + if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']: + raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' % + (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'], + search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))) + else: + print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)) + time.sleep(g_param['OptionsDefine.WaiterInfo']['interval']) + FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) + + def doCreateOrganizationGroupInvitationLink(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -4801,7 +4853,7 @@ def doDescribeOrganizationSeals(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doCreateSchemeUrl(args, parsed_globals): +def doDescribeOrganizationVerifyStatus(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -4830,11 +4882,11 @@ def doCreateSchemeUrl(args, parsed_globals): client = mod.EssClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.CreateSchemeUrlRequest() + model = models.DescribeOrganizationVerifyStatusRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.CreateSchemeUrl(model) + rsp = client.DescribeOrganizationVerifyStatus(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -4999,6 +5051,7 @@ def doDeleteExtendedServiceAuthInfos(args, parsed_globals): "DescribeFlowInfo": doDescribeFlowInfo, "CreateSealPolicy": doCreateSealPolicy, "DescribeCancelFlowsTask": doDescribeCancelFlowsTask, + "CreateSchemeUrl": doCreateSchemeUrl, "CreateOrganizationGroupInvitationLink": doCreateOrganizationGroupInvitationLink, "DisableUserAutoSign": doDisableUserAutoSign, "GetTaskResultApi": doGetTaskResultApi, @@ -5008,7 +5061,7 @@ def doDeleteExtendedServiceAuthInfos(args, parsed_globals): "CreateOrganizationBatchSignUrl": doCreateOrganizationBatchSignUrl, "DescribeThirdPartyAuthCode": doDescribeThirdPartyAuthCode, "DescribeOrganizationSeals": doDescribeOrganizationSeals, - "CreateSchemeUrl": doCreateSchemeUrl, + "DescribeOrganizationVerifyStatus": doDescribeOrganizationVerifyStatus, "DeleteExtendedServiceAuthInfos": doDeleteExtendedServiceAuthInfos, } diff --git a/tccli/services/ess/v20201111/api.json b/tccli/services/ess/v20201111/api.json index 840943c0ae..a97822f45c 100644 --- a/tccli/services/ess/v20201111/api.json +++ b/tccli/services/ess/v20201111/api.json @@ -532,6 +532,13 @@ "output": "DescribeOrganizationSealsResponse", "status": "online" }, + "DescribeOrganizationVerifyStatus": { + "document": "仅且仅能查询企业本身在电子签的认证状态", + "input": "DescribeOrganizationVerifyStatusRequest", + "name": "查询本企业认证状态", + "output": "DescribeOrganizationVerifyStatusResponse", + "status": "online" + }, "DescribePersonCertificate": { "document": "此接口（DescribePersonCertificate）用于查询个人数字证书信息。
    注：`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。`
    `2.调用此接口需要开通白名单，使用前请联系相关人员开通白名单。`", "input": "DescribePersonCertificateRequest", @@ -9613,6 +9620,52 @@ ], "type": "object" }, + "DescribeOrganizationVerifyStatusRequest": { + "document": "DescribeOrganizationVerifyStatus请求参数结构体", + "members": [ + { + "disabled": false, + "document": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`", + "example": "无", + "member": "UserInfo", + "name": "Operator", + "required": false, + "type": "object" + }, + { + "disabled": false, + "document": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。\t", + "example": "无", + "member": "Agent", + "name": "Agent", + "required": false, + "type": "object" + } + ], + "type": "object" + }, + "DescribeOrganizationVerifyStatusResponse": { + "document": "DescribeOrganizationVerifyStatus返回参数结构体", + "members": [ + { + "disabled": false, + "document": "当前企业认证状态\n", + "example": "0", + "member": "uint64", + "name": "VerifyStatus", + "output_required": true, + "type": "int", + "value_allowed_null": false + }, + { + "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "DescribePersonCertificateRequest": { "document": "DescribePersonCertificate请求参数结构体", "members": [ diff --git a/tccli/services/ess/v20201111/examples.json b/tccli/services/ess/v20201111/examples.json index a97ce752cb..a1b65c6b72 100644 --- a/tccli/services/ess/v20201111/examples.json +++ b/tccli/services/ess/v20201111/examples.json @@ -1562,6 +1562,14 @@ "title": "请求详细印章列表信息" } ], + "DescribeOrganizationVerifyStatus": [ + { + "document": "当前企业在电子签已经认证，企业调用方进行调用", + "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeOrganizationVerifyStatus\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"49500cb4-ca5e-4da0-93fb-e15f3a710ed7\",\n \"VerifyStatus\": 2\n }\n}", + "title": "查询当前企业在电子签的认证状态" + } + ], "DescribePersonCertificate": [ { "document": "1.张三已开通自动签署服务\n2.查询个人用户张三的自动签证书信息", diff --git a/tccli/services/essbasic/v20210526/api.json b/tccli/services/essbasic/v20210526/api.json index 26d4fed598..a92fe3fb02 100644 --- a/tccli/services/essbasic/v20210526/api.json +++ b/tccli/services/essbasic/v20210526/api.json @@ -716,7 +716,7 @@ }, { "disabled": false, - "document": "是否隐藏一键签署 默认false-不隐藏true-隐藏", + "document": "当签署方有多个签署区时候，是否隐藏一键所有的签署区\n\nfalse：（默认）不隐藏\ntrue：隐藏，每个签署区要单独选择印章或者签名", "example": "true", "member": "bool", "name": "HideOneKeySign", diff --git a/tccli/services/gwlb/v20240906/api.json b/tccli/services/gwlb/v20240906/api.json index c559d2b66c..fc96a354a7 100644 --- a/tccli/services/gwlb/v20240906/api.json +++ b/tccli/services/gwlb/v20240906/api.json @@ -192,7 +192,7 @@ "members": [ { "disabled": false, - "document": "网关负载均衡后端目标设备所属的私有网络 ID，如vpc-12345678，可以通过 DescribeVpcEx 接口获取。 不填此参数则默认为DefaultVPC。创建内网负载均衡实例时，此参数必填。", + "document": "网关负载均衡后端目标设备所属的私有网络 ID，如vpc-azd4dt1c，可以通过 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) 接口获取。", "example": "vpc-30xq****", "member": "string", "name": "VpcId", @@ -302,8 +302,8 @@ }, { "disabled": false, - "document": "目标组的默认端口， 后续添加服务器时可使用该默认端口。Port和TargetGroupInstances.N中的port二者必填其一。", - "example": "80", + "document": "目标组的默认端口， 后续添加服务器时可使用该默认端口。Port和TargetGroupInstances.N中的port二者必填其一。仅支持6081。", + "example": "6081", "member": "uint64", "name": "Port", "required": false, @@ -320,8 +320,8 @@ }, { "disabled": false, - "document": "网关负载均衡目标组协议。\n- TENCENT_GENEVE ：GENEVE 标准协议\n- AWS_GENEVE：GENEVE 兼容协议（需要提交工单申请开白）", - "example": "GENEVE", + "document": "网关负载均衡目标组协议。\n- TENCENT_GENEVE ：GENEVE 标准协议\n- AWS_GENEVE：GENEVE 兼容协议", + "example": "TENCENT_GENEVE", "member": "string", "name": "Protocol", "required": false, @@ -603,7 +603,7 @@ "members": [ { "disabled": false, - "document": "过滤条件，当前仅支持TargetGroupId，BindIP，InstanceId过滤。", + "document": "过滤条件，当前仅支持TargetGroupId，BindIP，InstanceId过滤。\n\n- TargetGroupId - String - 是否必填：否 - （过滤条件）目标组ID，如“lbtg-5xunivs0”。\n- BindIP - String - 是否必填：否 - （过滤条件）目标组绑定实例的IP地址，如“10.1.1.1”\n- InstanceId - String - 是否必填：否 - （过滤条件）目标组绑定实例的名称，如“ins_name”", "example": "无", "member": "Filter", "name": "Filters", @@ -687,7 +687,7 @@ }, { "disabled": false, - "document": "过滤条件数组，支持TargetGroupVpcId和TargetGroupName。", + "document": "过滤条件数组。\n\n- TargetGroupVpcId - String - 是否必填：否 - （过滤条件）按照目标组所属的私有网络过滤，如“vpc-bhqk****”。\n- TargetGroupName - String - 是否必填：否 - （过滤条件）按照目标组的名称过滤，如“tg_name”", "example": "无", "member": "Filter", "name": "Filters", @@ -779,7 +779,7 @@ }, { "disabled": false, - "document": "过滤条件数组，支持TargetGroupVpcId和TargetGroupName。", + "document": "过滤条件数组。\n\n- TargetGroupVpcId - String - 是否必填：否 - （过滤条件）按照目标组所属的私有网络过滤，如“vpc-bhqk****”。\n- TargetGroupName - String - 是否必填：否 - （过滤条件）按照目标组的名称过滤，如“tg_name”", "example": "无", "member": "Filter", "name": "Filters", @@ -862,7 +862,7 @@ { "disabled": false, "document": "辅助描述信息，如失败原因等。\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "无", + "example": "\"error message\"", "member": "string", "name": "Message", "output_required": false, @@ -1453,8 +1453,8 @@ }, { "disabled": false, - "document": "后端服务的转发权重，取值范围：[0, 100]，默认为 10。", - "example": "10", + "document": "后端服务的转发权重，取值为0或16", + "example": "16", "member": "uint64", "name": "Weight", "output_required": true, @@ -1540,7 +1540,7 @@ }, { "disabled": false, - "document": "健康检查使用的协议。支持ping和tcp，默认为ping。\n\n- PING: icmp\n- TCP: tcp", + "document": "健康检查使用的协议。支持PING和TCP两种方式，默认为PING。\n\n- icmp: 使用PING的方式进行健康检查\n- tcp: 使用TCP连接的方式进行健康检查", "example": "icmp", "member": "string", "name": "Protocol", @@ -1682,8 +1682,8 @@ }, { "disabled": false, - "document": "后端协议类型。\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "geneve", + "document": "网关负载均衡目标组协议。\n- tencent_geneve ：GENEVE 标准协议\n- aws_geneve：GENEVE 兼容协议\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "tencent_geneve", "member": "string", "name": "Protocol", "output_required": true, @@ -1692,8 +1692,8 @@ }, { "disabled": false, - "document": "调度算法。\nip_hash_3：弹性哈希\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "ip_hash_3", + "document": "均衡算法。\n- ip_hash_3_elastic：弹性哈希\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "ip_hash_3_elastic", "member": "string", "name": "ScheduleAlgorithm", "output_required": true, diff --git a/tccli/services/gwlb/v20240906/examples.json b/tccli/services/gwlb/v20240906/examples.json index cf2a56ecb8..275baa391f 100644 --- a/tccli/services/gwlb/v20240906/examples.json +++ b/tccli/services/gwlb/v20240906/examples.json @@ -76,7 +76,7 @@ { "document": "获取目标组列表", "input": "https://gwlb.tencentcloudapi.com/?Action=DescribeTargetGroupList\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"TargetGroupSet\": [\n {\n \"TargetGroupId\": \"abc\",\n \"VpcId\": \"abc\",\n \"TargetGroupName\": \"abc\",\n \"Port\": 1,\n \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n \"UpdatedTime\": \"2020-09-22T00:00:00+00:00\",\n \"AssociatedRule\": [\n {\n \"LoadBalancerId\": \"abc\",\n \"LoadBalancerName\": \"abc\"\n }\n ],\n \"Protocol\": \"abc\",\n \"ScheduleAlgorithm\": \"abc\",\n \"HealthCheck\": {\n \"HealthSwitch\": true,\n \"Protocol\": \"abc\",\n \"Port\": 0,\n \"Timeout\": 0,\n \"IntervalTime\": 0,\n \"HealthNum\": 0,\n \"UnHealthNum\": 0\n },\n \"AllDeadToAlive\": true,\n \"AssociatedRuleCount\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"5c5003ab-126b-4649-8c86-0a98f34cfe12\",\n \"TargetGroupSet\": [\n {\n \"AllDeadToAlive\": true,\n \"AssociatedRule\": null,\n \"AssociatedRuleCount\": 1,\n \"CreatedTime\": \"2024-10-15T00:00:00+00:00\",\n \"HealthCheck\": {\n \"HealthNum\": 3,\n \"HealthSwitch\": true,\n \"IntervalTime\": 5,\n \"Port\": 0,\n \"Protocol\": \"icmp\",\n \"Timeout\": 2,\n \"UnHealthNum\": 3\n },\n \"Port\": 6081,\n \"Protocol\": \"tencent_geneve\",\n \"RegisteredInstancesCount\": 1,\n \"ScheduleAlgorithm\": \"ip_hash_3_elastic\",\n \"TargetGroupId\": \"lbtg-kbsv74pw\",\n \"TargetGroupName\": \"targetgroup1727599151\",\n \"UpdatedTime\": \"2024-10-15T00:00:00+00:00\",\n \"VpcId\": \"vpc-ojtgv3oh\"\n },\n {\n \"AllDeadToAlive\": true,\n \"AssociatedRule\": null,\n \"AssociatedRuleCount\": 0,\n \"CreatedTime\": \"2024-10-15T00:00:00+00:00\",\n \"HealthCheck\": {\n \"HealthNum\": 3,\n \"HealthSwitch\": true,\n \"IntervalTime\": 5,\n \"Port\": 0,\n \"Protocol\": \"icmp\",\n \"Timeout\": 2,\n \"UnHealthNum\": 3\n },\n \"Port\": 6081,\n \"Protocol\": \"tencent_geneve\",\n \"RegisteredInstancesCount\": 0,\n \"ScheduleAlgorithm\": \"ip_hash_3_elastic\",\n \"TargetGroupId\": \"lbtg-141xpe2w\",\n \"TargetGroupName\": \"targetgroup1727175745\",\n \"UpdatedTime\": \"2024-10-15T00:00:00+00:00\",\n \"VpcId\": \"vpc-ojtgv3oh\"\n },\n {\n \"AllDeadToAlive\": true,\n \"AssociatedRule\": null,\n \"AssociatedRuleCount\": 0,\n \"CreatedTime\": \"2024-10-15T00:00:00+00:00\",\n \"HealthCheck\": {\n \"HealthNum\": 3,\n \"HealthSwitch\": true,\n \"IntervalTime\": 5,\n \"Port\": 0,\n \"Protocol\": \"icmp\",\n \"Timeout\": 2,\n \"UnHealthNum\": 3\n },\n \"Port\": 6081,\n \"Protocol\": \"tencent_geneve\",\n \"RegisteredInstancesCount\": 0,\n \"ScheduleAlgorithm\": \"ip_hash_3_elastic\",\n \"TargetGroupId\": \"lbtg-myhtwkrw\",\n \"TargetGroupName\": \"targetgroup1726747698\",\n \"UpdatedTime\": \"2024-10-15T00:00:00+00:00\",\n \"VpcId\": \"vpc-ojtgv3oh\"\n }\n ],\n \"TotalCount\": 3\n }\n}", "title": "获取目标组列表" } ], @@ -137,7 +137,7 @@ "ModifyTargetGroupInstancesWeight": [ { "document": "", - "input": "https://gwlb.tencentcloudapi.com/?Action=ModifyTargetGroupInstancesWeight\n&TargetGroupId=lbtg-815iz538\n&TargetGroupInstances.0.BindIP=172.16.0.34\n&TargetGroupInstances.0.Port=1234\n&TargetGroupInstances.0.Weight=55\n&<公共请求参数>", + "input": "https://gwlb.tencentcloudapi.com/?Action=ModifyTargetGroupInstancesWeight\n&TargetGroupId=lbtg-815iz538\n&TargetGroupInstances.0.BindIP=172.16.0.34\n&TargetGroupInstances.0.Port=6081\n&TargetGroupInstances.0.Weight=55\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"ed90470e-eade-423f-aae6-264d814d0d65\"\n }\n}", "title": "批量修改目标组服务器权重" } diff --git a/tccli/services/hunyuan/v20230901/api.json b/tccli/services/hunyuan/v20230901/api.json index b331b0303a..19d290b74d 100644 --- a/tccli/services/hunyuan/v20230901/api.json +++ b/tccli/services/hunyuan/v20230901/api.json @@ -1142,7 +1142,7 @@ { "disabled": false, "document": "输入文本。总长度不超过 1024 个 Token，超过则会截断最后面的内容。", - "example": "无", + "example": "你好", "member": "string", "name": "Input", "required": false, @@ -1151,7 +1151,7 @@ { "disabled": false, "document": "输入文本数组。输入数组总长度不超过 200 。", - "example": "无", + "example": "[\"你好\", \"hello\"]", "member": "string", "name": "InputList", "required": false, @@ -1526,7 +1526,7 @@ { "disabled": false, "document": "输入文本", - "example": "无", + "example": "你是谁", "member": "string", "name": "Prompt", "required": true, @@ -1561,7 +1561,7 @@ { "disabled": false, "document": "切分后的列表", - "example": "无", + "example": "[\"你是\", \"谁\"]", "member": "string", "name": "Tokens", "output_required": false, @@ -2261,7 +2261,7 @@ }, { "disabled": false, - "document": "助手 ID", + "document": "助手 ID（目前未使用，留空）", "example": "asst_x39o8phGyiIC8llpaVShxVmL", "member": "string", "name": "AssistantID", @@ -2280,7 +2280,7 @@ { "disabled": false, "document": "附加消息", - "example": "[]", + "example": "[{\"Role\":\"user\",\"Content\":\"你是谁\"}]", "member": "ThreadAdditionalMessage", "name": "AdditionalMessages", "required": false, diff --git a/tccli/services/lcic/v20220817/api.json b/tccli/services/lcic/v20220817/api.json index d4b3ea1569..cf9a35a8b0 100644 --- a/tccli/services/lcic/v20220817/api.json +++ b/tccli/services/lcic/v20220817/api.json @@ -1692,7 +1692,7 @@ }, { "disabled": false, - "document": "录制模板。房间子类型为视频+白板（SubType=videodoc）时默认为3，房间子类型为纯视频（SubType=video）时默认为0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744", + "document": "录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744", "example": "1", "member": "uint64", "name": "RecordLayout", @@ -1702,7 +1702,7 @@ { "disabled": false, "document": "房间绑定的群组ID,非空时限制组成员进入", - "example": "abc", + "example": "abcdfgd", "member": "string", "name": "GroupId", "required": false, @@ -1800,7 +1800,7 @@ }, { "disabled": false, - "document": "录制自定义场景，仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。", + "document": "录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。\n数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。", "example": "{\"scene\":\"test\",\"lng\":\"zh\",\"type\":\"h5\",\"subjectId\":\"57\",\"customToken\":\"sajdlfjasdglweqirouoiu\"}", "member": "string", "name": "RecordScene", diff --git a/tccli/services/lcic/v20220817/examples.json b/tccli/services/lcic/v20220817/examples.json index 2db77cf199..619ea1f17a 100644 --- a/tccli/services/lcic/v20220817/examples.json +++ b/tccli/services/lcic/v20220817/examples.json @@ -99,8 +99,8 @@ "CreateRoom": [ { "document": "示例", - "input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRoom\n<公共请求参数>\n\n{\n \"Name\": \"abc\",\n \"StartTime\": 1,\n \"EndTime\": 1,\n \"TeacherId\": \"abc\",\n \"SdkAppId\": 1,\n \"Resolution\": 1,\n \"MaxMicNumber\": 1,\n \"AutoMic\": 1,\n \"TurnOffMic\": 1,\n \"AudioQuality\": 1,\n \"SubType\": \"abc\",\n \"DisableRecord\": 1,\n \"Assistants\": [\n \"abc\"\n ],\n \"AudienceType\": 1,\n \"RecordLayout\": 1,\n \"GroupId\": \"abc\",\n \"InteractionMode\": 1,\n \"VideoOrientation\": 1,\n \"IsGradingRequiredPostClass\": 1,\n \"RoomType\": 1,\n \"EnableDirectControl\": 0\n}", - "output": "{\n \"Response\": {\n \"RoomId\": 1,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRoom\n<公共请求参数>\n\n{\n \"Name\": \"abcdfdsf\",\n \"StartTime\": 1,\n \"EndTime\": 1,\n \"TeacherId\": \"abcdfgdf\",\n \"SdkAppId\": 1,\n \"Resolution\": 1,\n \"MaxMicNumber\": 1,\n \"AutoMic\": 1,\n \"TurnOffMic\": 1,\n \"AudioQuality\": 1,\n \"SubType\": \"abcdfgd\",\n \"DisableRecord\": 1,\n \"Assistants\": [\n \"abcxdfgdfg\"\n ],\n \"AudienceType\": 1,\n \"RecordLayout\": 1,\n \"GroupId\": \"abcdfgdf\",\n \"InteractionMode\": 1,\n \"VideoOrientation\": 1,\n \"IsGradingRequiredPostClass\": 1,\n \"RoomType\": 1,\n \"EnableDirectControl\": 0\n}", + "output": "{\n \"Response\": {\n \"RoomId\": 1,\n \"RequestId\": \"abcdfgdfgfdrg\"\n }\n}", "title": "创建房间" } ], diff --git a/tccli/services/lighthouse/v20200324/examples.json b/tccli/services/lighthouse/v20200324/examples.json index 2d5283cb5b..bb69e676e4 100644 --- a/tccli/services/lighthouse/v20200324/examples.json +++ b/tccli/services/lighthouse/v20200324/examples.json @@ -324,7 +324,7 @@ { "document": "", "input": "https://lighthouse.tencentcloudapi.com/?Action=DescribeFirewallRules\n&InstanceId=lhins-aglzynfg\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"FirewallRuleSet\": [\n {\n \"Action\": \"DROP\",\n \"AppType\": \"自定义\",\n \"CidrBlock\": \"0.0.0.0/0\",\n \"FirewallRuleDescription\": \"\",\n \"Port\": \"22,88\",\n \"Protocol\": \"TCP\"\n },\n {\n \"Action\": \"ACCEPT\",\n \"AppType\": \"自定义\",\n \"CidrBlock\": \"0.0.0.0/0\",\n \"FirewallRuleDescription\": \"test\",\n \"Port\": \"88\",\n \"Protocol\": \"TCP\"\n },\n {\n \"Action\": \"ACCEPT\",\n \"AppType\": \"HTTP(80)\",\n \"CidrBlock\": \"0.0.0.0/0\",\n \"FirewallRuleDescription\": \"test\",\n \"Port\": \"80\",\n \"Protocol\": \"TCP\"\n },\n {\n \"Action\": \"ACCEPT\",\n \"AppType\": \"HTTPS(443)\",\n \"CidrBlock\": \"0.0.0.0/0\",\n \"FirewallRuleDescription\": \"放通Web服务HTTPS(443)，如 Apache、Nginx\",\n \"Port\": \"443\",\n \"Protocol\": \"TCP\"\n }\n ],\n \"FirewallVersion\": 1,\n \"RequestId\": \"afa0c876-336a-4ed6-ad01-89b3b2632207\",\n \"TotalCount\": 4\n }\n}", + "output": "{\n \"Response\": {\n \"FirewallRuleSet\": [\n {\n \"Action\": \"DROP\",\n \"AppType\": \"自定义\",\n \"CidrBlock\": \"0.0.0.0/0\",\n \"FirewallRuleDescription\": \"\",\n \"Port\": \"22,88\",\n \"Protocol\": \"TCP\"\n },\n {\n \"Action\": \"ACCEPT\",\n \"AppType\": \"自定义\",\n \"CidrBlock\": \"0.0.0.0/0\",\n \"FirewallRuleDescription\": \"test\",\n \"Port\": \"88\",\n \"Protocol\": \"TCP\"\n },\n {\n \"Action\": \"ACCEPT\",\n \"AppType\": \"HTTP(80)\",\n \"CidrBlock\": \"0.0.0.0/0\",\n \"FirewallRuleDescription\": \"放通TCP端口(80)\",\n \"Port\": \"80\",\n \"Protocol\": \"TCP\"\n },\n {\n \"Action\": \"ACCEPT\",\n \"AppType\": \"HTTPS(443)\",\n \"CidrBlock\": \"0.0.0.0/0\",\n \"FirewallRuleDescription\": \"放通Web服务HTTPS(443)，如 Apache、Nginx\",\n \"Port\": \"443\",\n \"Protocol\": \"TCP\"\n }\n ],\n \"FirewallVersion\": 1,\n \"RequestId\": \"afa0c876-336a-4ed6-ad01-89b3b2632207\",\n \"TotalCount\": 4\n }\n}", "title": "查询实例的所有防火墙规则" }, { @@ -450,7 +450,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: lighthouse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeKeyPairs\n<公共请求参数>\n\n{\n \"KeyIds\": [\n \"lhkp-omd12oc1\"\n ]\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"KeyPairSet\": [\n {\n \"KeyId\": \"lhkp-omd12oc1\",\n \"KeyName\": \"test\",\n \"PublicKey\": \"\",\n \"AssociatedInstanceIds\": [],\n \"CreatedTime\": \"2020-04-28T23:01:47Z\",\n \"PrivateKey\": \"null\"\n }\n ],\n \"RequestId\": \"9abb999a-53d6-4534-9b49-00e53b5c0fea\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"KeyPairSet\": [\n {\n \"KeyId\": \"lhkp-omd12oc1\",\n \"KeyName\": \"koc1\",\n \"PublicKey\": \"\",\n \"AssociatedInstanceIds\": [],\n \"CreatedTime\": \"2020-04-28T23:01:47Z\",\n \"PrivateKey\": \"null\"\n }\n ],\n \"RequestId\": \"9abb999a-53d6-4534-9b49-00e53b5c0fea\"\n }\n}", "title": "查询用户密钥对列表" } ], diff --git a/tccli/services/live/v20180801/api.json b/tccli/services/live/v20180801/api.json index 708befbcd1..5c71f61e96 100644 --- a/tccli/services/live/v20180801/api.json +++ b/tccli/services/live/v20180801/api.json @@ -2791,7 +2791,7 @@ "members": [ { "disabled": false, - "document": "输入源Index。\n范围[1, 20]", + "document": "输入源Index。\n范围[1, 24]", "example": "无", "member": "int64", "name": "InputIndex", @@ -3971,7 +3971,7 @@ { "disabled": false, "document": "导播台ID", - "example": "1234", + "example": "1001", "member": "uint64", "name": "CasterId", "required": true, @@ -3979,7 +3979,7 @@ }, { "disabled": false, - "document": "请求生成推流地址的输入Index。\n允许范围[1,20]。", + "document": "请求生成推流地址的输入Index。\n允许范围[1,24]。", "example": "1", "member": "uint64", "name": "InputIndex", @@ -12211,7 +12211,7 @@ "members": [ { "disabled": false, - "document": "查询开始时间点，精确到分钟粒度，接口查询支持两种时间格式：\n1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO%20%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F,-ISO%20%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。\n2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。\n支持最近两个月的查询，查询开始和结束时间跨度不支持超过31天。", + "document": "查询开始时间点，精确到分钟粒度，接口查询支持两种时间格式：\n1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#52)。\n2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。\n支持最近两个月的查询，查询开始和结束时间跨度不支持超过31天。", "example": "2019-02-01 00:00:00", "member": "string", "name": "StartTime", @@ -12220,7 +12220,7 @@ }, { "disabled": false, - "document": "查询结束时间点，精确到分钟粒度，接口查询支持两种时间格式：\n1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO%20%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F,-ISO%20%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。\n2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。\n支持最近两个月的查询，查询开始和结束时间跨度不支持超过31天。", + "document": "查询结束时间点，精确到分钟粒度，接口查询支持两种时间格式：\n1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#52)。\n2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。\n支持最近两个月的查询，查询开始和结束时间跨度不支持超过31天。", "example": "2019-02-02 00:00:00", "member": "string", "name": "EndTime", diff --git a/tccli/services/mongodb/v20180408/api.json b/tccli/services/mongodb/v20180408/api.json index 3c8fa30356..e2c7c8049d 100644 --- a/tccli/services/mongodb/v20180408/api.json +++ b/tccli/services/mongodb/v20180408/api.json @@ -64,7 +64,7 @@ "status": "online" }, "SetPassword": { - "document": "本接口(SetPassword)用于设置（初始化）MongoDB云数据库实例账户密码。\n\n", + "document": "本接口(SetPassword)用于设置（初始化）MongoDB云数据库实例账户密码。", "input": "SetPasswordRequest", "name": "修改云数据库实例的账户密码", "output": "SetPasswordResponse", @@ -347,7 +347,7 @@ { "disabled": false, "document": "每个副本集内从节点个数", - "example": "", + "example": "2", "member": "uint64", "name": "SecondaryNum", "required": true, @@ -356,7 +356,7 @@ { "disabled": false, "document": "实例内存大小，单位：GB", - "example": "", + "example": "4", "member": "uint64", "name": "Memory", "required": true, @@ -365,7 +365,7 @@ { "disabled": false, "document": "实例硬盘大小，单位：GB", - "example": "", + "example": "100", "member": "uint64", "name": "Volume", "required": true, @@ -373,8 +373,8 @@ }, { "disabled": false, - "document": "版本号，当前支持 MONGO_3_WT、MONGO_3_ROCKS、MONGO_36_WT", - "example": "", + "document": "指版本信息。具体支持的版本信息 ，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本。 - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本。 - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。 - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。 - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。 - MONGO_60_WT：MongoDB 6.0 WiredTiger存储引擎版本。", + "example": "MONGO_44_WT", "member": "string", "name": "MongoVersion", "required": true, @@ -382,8 +382,8 @@ }, { "disabled": false, - "document": "机器类型，GIO：高IO版；TGIO：高IO万兆", - "example": "", + "document": "机器类型，HIO10G：高IO万兆。", + "example": "HIO10G", "member": "string", "name": "MachineCode", "required": true, @@ -392,7 +392,7 @@ { "disabled": false, "document": "实例数量，默认值为1, 最小值1，最大值为10", - "example": "", + "example": "1", "member": "uint64", "name": "GoodsNum", "required": true, @@ -401,7 +401,7 @@ { "disabled": false, "document": "实例所属区域名称，格式如：ap-guangzhou-2", - "example": "", + "example": "ap-guangzhou-2", "member": "string", "name": "Zone", "required": true, @@ -410,7 +410,7 @@ { "disabled": false, "document": "时长，购买月数", - "example": "", + "example": "1", "member": "uint64", "name": "TimeSpan", "required": true, @@ -419,7 +419,7 @@ { "disabled": false, "document": "实例密码", - "example": "", + "example": "********", "member": "string", "name": "Password", "required": true, @@ -428,7 +428,7 @@ { "disabled": false, "document": "项目ID，不填为默认项目", - "example": "", + "example": "0", "member": "uint64", "name": "ProjectId", "required": false, @@ -437,7 +437,7 @@ { "disabled": false, "document": "安全组参数", - "example": "", + "example": "sg-1ad2****", "member": "string", "name": "SecurityGroup", "required": false, @@ -446,7 +446,7 @@ { "disabled": false, "document": "私有网络ID，如果不传则默认选择基础网络", - "example": "", + "example": "vpc-0akb****", "member": "string", "name": "UniqVpcId", "required": false, @@ -455,11 +455,20 @@ { "disabled": false, "document": "私有网络下的子网ID，如果设置了 VpcId，则 SubnetId必填", - "example": "", + "example": "subnet-fyrt****（", "member": "string", "name": "UniqSubnetId", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "实例类型，REPLSET-副本集，SHARD-分片集群，默认为REPLSET", + "example": "REPLSET", + "member": "string", + "name": "InstanceType", + "required": false, + "type": "string" } ], "type": "object" @@ -470,18 +479,20 @@ { "disabled": false, "document": "订单ID", - "example": "", + "example": "7142863", "member": "string", "name": "DealId", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "创建的实例ID列表", - "example": "", + "example": "[\"cmgo-po5f****\"]", "member": "string", "name": "InstanceIds", + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -515,10 +526,10 @@ { "disabled": false, "document": "客户端连接信息，包括客户端IP和对应IP的连接数量\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "无", + "example": "[{\"Count\":1,\"IP\":\"xx\"},{\"Count\":1,\"IP\":\"xx\"}]", "member": "ClientConnection", "name": "Clients", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -528,7 +539,7 @@ "example": "10", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -546,8 +557,8 @@ "members": [ { "disabled": false, - "document": "实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。", - "example": "cmgo-7pjedvz7", + "document": "实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。", + "example": "cmgo-7pje****", "member": "string", "name": "InstanceIds", "required": false, @@ -628,7 +639,7 @@ { "disabled": false, "document": "返回结果集排序的字段，目前支持： \n", - "example": "无", + "example": "InstanceName", "member": "string", "name": "OrderBy", "required": false, @@ -637,7 +648,7 @@ { "disabled": false, "document": "返回结果集排序方式，目前支持：\"ASC\"或者\"DESC\"。\n", - "example": "无", + "example": "ASC", "member": "string", "name": "OrderByType", "required": false, @@ -655,17 +666,17 @@ "example": "19", "member": "uint64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "实例详细信息", - "example": "无", + "example": "{\"Response\":{\"InstanceDetails\":[],\"RequestId\":\"88c9e2c6-a116-4d68-b77e-8136c5e0****\",\"TotalCount\":0}}", "member": "MongoDBInstanceDetail", "name": "InstanceDetails", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1381,8 +1392,8 @@ "members": [ { "disabled": false, - "document": "实例ID，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同", - "example": "cmgo-eqmoa5sf", + "document": "实例ID，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同", + "example": "cmgo-eqmo****", "member": "string", "name": "InstanceId", "required": true, @@ -1399,8 +1410,8 @@ }, { "disabled": false, - "document": "实例新密码，至少包含字母、数字和字符（!@#%^*()）中的两种，长度为8-16个字符", - "example": "test_password123", + "document": "指定账户的新密码， 密码格式为8-32个字符长度，至少包含字母、数字和字符（!@#%^*()_）中的两种", + "example": "********", "member": "string", "name": "Password", "required": true, @@ -1415,10 +1426,10 @@ { "disabled": false, "document": "返回的异步任务ID", - "example": "1082", + "example": "1082****", "member": "uint64", "name": "FlowId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -1814,8 +1825,8 @@ "members": [ { "disabled": false, - "document": "实例ID，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同", - "example": "", + "document": "实例ID，格式如：cmgo-iga0****。与云数据库控制台页面中显示的实例ID相同", + "example": "cmgo-iga0****", "member": "string", "name": "InstanceId", "required": true, @@ -1824,7 +1835,7 @@ { "disabled": false, "document": "升级后的内存大小，单位：GB", - "example": "", + "example": "4", "member": "uint64", "name": "Memory", "required": true, @@ -1833,7 +1844,7 @@ { "disabled": false, "document": "升级后的硬盘大小，单位：GB", - "example": "", + "example": "250", "member": "uint64", "name": "Volume", "required": true, @@ -1842,7 +1853,7 @@ { "disabled": false, "document": "升级后oplog的大小，单位：GB，默认为磁盘空间的10%，允许设置的最小值为磁盘的10%，最大值为磁盘的90%", - "example": "", + "example": "26", "member": "uint64", "name": "OplogSize", "required": false, @@ -1857,9 +1868,10 @@ { "disabled": false, "document": "订单ID", - "example": "", + "example": "19297475", "member": "string", "name": "DealId", + "output_required": true, "type": "string", "value_allowed_null": false }, diff --git a/tccli/services/mongodb/v20180408/examples.json b/tccli/services/mongodb/v20180408/examples.json index a6b9b56ea8..8f0df0acb8 100644 --- a/tccli/services/mongodb/v20180408/examples.json +++ b/tccli/services/mongodb/v20180408/examples.json @@ -11,7 +11,7 @@ "CreateDBInstance": [ { "document": "客户需要通过API创建包年包月云数据库实例", - "input": "https://mongodb.tencentcloudapi.com/?Action=CreateDBInstance\r\n&Memory=4\r\n&Volume=250\r\n&GoodsNum=1\r\n&Zone=ap-guangzhou-2\r\n&UniqVpcId=vpc-0akbol5v\r\n&UniqSubnetId=subnet-fyrtjbqw\r\n&ProjectId=0\r\n&MongoVersion=MONGO_3_WT\r\n&MachineCode=TGIO\r\n&SecondaryNum=2\r\n&TimeSpan=1\r\n&Password=pwd123456\r\n&<公共请求参数>", + "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDBInstance\n<公共请求参数>\n\n{\n \"Zone\": \"ap-guangzhou-2\",\n \"UniqVpcId\": \"vpc-0akbol5v\",\n \"TimeSpan\": \"1\",\n \"ProjectId\": \"0\",\n \"MachineCode\": \"TGIO\",\n \"GoodsNum\": \"1\",\n \"Volume\": \"250\",\n \"SecondaryNum\": \"2\",\n \"UniqSubnetId\": \"subnet-fyrtjbqw\",\n \"Memory\": \"4\",\n \"MongoVersion\": \"MONGO_42_WT\",\n \"Password\": \"pwd123456\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"d88095e5-50e8-4245-a0cf-993a536f9b20\",\n \"DealId\": \"7142863\",\n \"InstanceIds\": [\n \"cmgo-po5f899l\"\n ]\n }\n}", "title": "创建包年包月的云数据库实例" } @@ -28,7 +28,7 @@ { "document": "", "input": "https://mongodb.tencentcloudapi.com/?Action=DescribeClientConnections\n&InstanceId=cmgo-eqmoaxxx\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"Clients\": [\n {\n \"Count\": 1,\n \"IP\": \"xx\"\n },\n {\n \"Count\": 1,\n \"IP\": \"xx\"\n }\n ],\n \"RequestId\": \"xx\"\n }\n}", + "output": "{\n \"Response\": {\n \"Clients\": [\n {\n \"IP\": \"abc\",\n \"Count\": 1\n }\n ],\n \"TotalCount\": 0,\n \"RequestId\": \"abc\"\n }\n}", "title": "查询云数据库实例的客户端连接情况" } ], @@ -75,7 +75,7 @@ "SetPassword": [ { "document": "", - "input": "https://mongodb.tencentcloudapi.com/?Action=SetPassword\n&InstanceId=cmgo-eqmoa5sf\n&UserName=test_user\n&Password=test_password123\n&<公共请求参数>", + "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetPassword\n<公共请求参数>\n\n{\n \"InstanceId\": \"cmgo-eqmoa5sf\",\n \"UserName\": \"test_user\",\n \"Password\": \"test_password123\"\n}", "output": "{\n \"Response\": {\n \"FlowId\": 1082,\n \"RequestId\": \"a02372cf-5e09-4d17-ab79-2ee3f60e86ff\"\n }\n}", "title": "设置云数据库实例账户密码" } @@ -91,7 +91,7 @@ "UpgradeDBInstance": [ { "document": "客户需要通过API升级包年包月的云数据库实例", - "input": "https://mongodb.tencentcloudapi.com/?Action=UpgradeDBInstance\r\n&Memory=4\r\n&Volume=250\r\n&InstanceId=cmgo-f555zzzz\r\n&OplogSize=26\r\n&<公共请求参数>", + "input": "https://mongodb.tencentcloudapi.com/?Action=UpgradeDBInstance\n&Memory=4\n&Volume=250\n&InstanceId=cmgo-f555zzzz\n&OplogSize=26\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"be8f4a30-ea2e-4623-8b6b-0ccce04cd9f7\",\n \"DealId\": \"19297475\"\n }\n}", "title": "升级包年包月的云数据库实例" } diff --git a/tccli/services/mongodb/v20190725/api.json b/tccli/services/mongodb/v20190725/api.json index 49dd7af069..7fd4ff886b 100644 --- a/tccli/services/mongodb/v20190725/api.json +++ b/tccli/services/mongodb/v20190725/api.json @@ -1,7 +1,7 @@ { "actions": { "AssignProject": { - "document": "本接口(AssignProject)用于指定云数据库实例的所属项目。\n", + "document": "本接口(AssignProject)用于指定云数据库实例的所属项目。", "input": "AssignProjectRequest", "name": "指定云数据库实例的所属项目", "output": "AssignProjectResponse", @@ -64,7 +64,7 @@ "status": "online" }, "DescribeAsyncRequestInfo": { - "document": "查询异步任务状态接口", + "document": "本接口（DescribeAsyncRequestInfo）用于查询异步任务状态接口。", "input": "DescribeAsyncRequestInfoRequest", "name": "查询异步任务状态接口", "output": "DescribeAsyncRequestInfoResponse", @@ -92,7 +92,7 @@ "status": "online" }, "DescribeCurrentOp": { - "document": "本接口(DescribeCurrentOp)用于查询MongoDB云数据库实例的当前正在执行的操作。", + "document": "本接口（DescribeCurrentOp）用于查询云数据库实例的当前正在执行的操作。", "input": "DescribeCurrentOpRequest", "name": "查询数据库实例当前正在执行的操作", "output": "DescribeCurrentOpResponse", @@ -380,8 +380,8 @@ "members": [ { "disabled": false, - "document": "实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同", - "example": "[\"cmgo-eqmoa5sf\\r\\n\"]", + "document": "实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同", + "example": "[\"cmgo-eqmo****\"]", "member": "string", "name": "InstanceIds", "required": true, @@ -390,7 +390,7 @@ { "disabled": false, "document": "项目ID，用户已创建项目的唯一ID,非自定义", - "example": "12", + "example": "1118****", "member": "uint64", "name": "ProjectId", "required": true, @@ -405,10 +405,10 @@ { "disabled": false, "document": "返回的异步任务ID列表", - "example": "[1081]", + "example": "[1081****]", "member": "uint64", "name": "FlowIds", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1018,7 +1018,7 @@ { "disabled": false, "document": "私有网络ID。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询确认正确的ID。 示例值：vpc-pxyzim13", - "example": "无", + "example": "vpc-k515****", "member": "string", "name": "VpcId", "required": false, @@ -1027,7 +1027,7 @@ { "disabled": false, "document": "私有网络VPC的子网。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询子网列表确认正确的 ID。 示例值：subnet-7jbabche", - "example": "无", + "example": "subnet-60dr****", "member": "string", "name": "SubnetId", "required": false, @@ -1036,7 +1036,7 @@ { "disabled": false, "document": "实例密码。自定义密码长度为8-32个字符，至少包含字母、数字和字符（!@#%^*()_）中的两种。", - "example": "无", + "example": "********", "member": "string", "name": "Password", "required": false, @@ -1045,7 +1045,7 @@ { "disabled": false, "document": "项目ID。\n- 若不设置该参数，则为默认项目。\n- 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面，可获取项目ID。", - "example": "无", + "example": "1", "member": "int64", "name": "ProjectId", "required": false, @@ -1072,7 +1072,7 @@ { "disabled": false, "document": "父实例 ID。当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。", - "example": "无", + "example": "cmgo-nh1o****", "member": "string", "name": "Father", "required": false, @@ -1081,7 +1081,7 @@ { "disabled": false, "document": "安全组 ID。", - "example": "无", + "example": "sg-abc****", "member": "string", "name": "SecurityGroup", "required": false, @@ -1090,7 +1090,7 @@ { "disabled": false, "document": "克隆实例回档时间。\n- 若为克隆实例，则必须配置该参数。输入格式示例：2021-08-13 16:30:00。\n- 回档时间范围：仅能回档7天内时间点的数据。", - "example": "无", + "example": "2022-09-10 15:04:05", "member": "string", "name": "RestoreTime", "required": false, @@ -1099,7 +1099,7 @@ { "disabled": false, "document": "实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。", - "example": "无", + "example": "testInstance", "member": "string", "name": "InstanceName", "required": false, @@ -1108,7 +1108,7 @@ { "disabled": false, "document": "若多可用区部署云数据库实例，指定多可用区列表。\n- 多可用区部署实例，参数 **Zone** 指定实例主可用区信息；**AvailabilityZoneList** 指定所有可用区信息，包含主可用区。输入格式如：[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。\n- 通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 可获取云数据库不同地域规划的可用区信息，以便指定有效的可用区。\n- 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。\n", - "example": "无", + "example": "[\"ap-guangzhou-2\",\"ap-guangzhou-3\",\"ap-guangzhou-4\"]", "member": "string", "name": "AvailabilityZoneList", "required": false, @@ -1117,7 +1117,7 @@ { "disabled": false, "document": "Mongos CPU 核数，支持1、2、4、8、16。购买分片集群时，必须填写。\n", - "example": "无", + "example": "1", "member": "uint64", "name": "MongosCpu", "required": false, @@ -1126,7 +1126,7 @@ { "disabled": false, "document": "Mongos 内存大小。\n- 购买分片集群时，必须填写。\n- 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。\n\n", - "example": "无", + "example": "2", "member": "uint64", "name": "MongosMemory", "required": false, @@ -1135,7 +1135,7 @@ { "disabled": false, "document": "Mongos 数量。购买分片集群时，必须填写。\n- 单可用区部署实例，其数量范围为[3,32]。\n- 多可用区部署实例，其数量范围为[6,32]。", - "example": "无", + "example": "3", "member": "uint64", "name": "MongosNodeNum", "required": false, @@ -1144,7 +1144,7 @@ { "disabled": false, "document": "只读节点数量，取值范围[0,5]。", - "example": "无", + "example": "0", "member": "uint64", "name": "ReadonlyNodeNum", "required": false, @@ -1153,7 +1153,7 @@ { "disabled": false, "document": "指只读节点所属可用区数组。跨可用区部署实例，参数**ReadonlyNodeNum**不为**0**时，必须配置该参数。", - "example": "无", + "example": "[\"ap-guangzhou-2\"]", "member": "string", "name": "ReadonlyNodeAvailabilityZoneList", "required": false, @@ -1162,7 +1162,7 @@ { "disabled": false, "document": "Hidden节点所属可用区。跨可用区部署实例，必须配置该参数。", - "example": "无", + "example": "ap-guangzhou-2", "member": "string", "name": "HiddenZone", "required": false, @@ -1171,7 +1171,7 @@ { "disabled": false, "document": "参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合，将一组有相同诉求的参数及值 存为模板，在创建实例时，可直接引用参数值到新实例。合理使用参数模板，可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取，注意模板支持的版本。", - "example": "tpl-0vswufxag", + "example": "tpl-0vswu****", "member": "string", "name": "ParamTemplateId", "required": false, @@ -1186,7 +1186,7 @@ { "disabled": false, "document": "订单ID。", - "example": "20190709160000003502416120946732", + "example": "2019070916000000350241612094****", "member": "string", "name": "DealId", "output_required": true, @@ -1196,7 +1196,7 @@ { "disabled": false, "document": "创建的实例ID列表。", - "example": "[\"cmgo-m26c6jsf\"]", + "example": "[\"cmgo-m26c****\"]", "member": "string", "name": "InstanceIds", "output_required": true, @@ -1399,7 +1399,7 @@ { "disabled": false, "document": "私有网络ID。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)查询确认正确的ID。 示例值：vpc-pxyzim13", - "example": "vpc-0akbol5v", + "example": "vpc-0akb****", "member": "string", "name": "VpcId", "required": false, @@ -1408,7 +1408,7 @@ { "disabled": false, "document": "私有网络VPC的子网。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询子网列表确认正确的 ID。 示例值：subnet-7jbabche", - "example": "subnet-fyrtjbqw", + "example": "subnet-fyrt****", "member": "string", "name": "SubnetId", "required": false, @@ -1417,7 +1417,7 @@ { "disabled": false, "document": "实例密码。自定义密码长度为8-32个字符，至少包含字母、数字和字符（!@#%^*()_）中的两种。", - "example": "pwd123456", + "example": "********", "member": "string", "name": "Password", "required": false, @@ -1462,7 +1462,7 @@ { "disabled": false, "document": "父实例 ID。当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。", - "example": "无", + "example": "cmgo-nh1o****", "member": "string", "name": "Father", "required": false, @@ -1471,7 +1471,7 @@ { "disabled": false, "document": "安全组 ID。 ", - "example": "无", + "example": "sg-di48****", "member": "string", "name": "SecurityGroup", "required": false, @@ -1480,7 +1480,7 @@ { "disabled": false, "document": "克隆实例回档时间，当Clone取值为5或6时为必填。- 若为克隆实例，则必须配置该参数。输入格式示例：2021-08-13 16:30:00。- 回档时间范围：仅能回档7天内时间点的数据。", - "example": "无", + "example": "2022-09-15 15:04:05", "member": "string", "name": "RestoreTime", "required": false, @@ -1489,7 +1489,7 @@ { "disabled": false, "document": "实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。", - "example": "无", + "example": "myInstance", "member": "string", "name": "InstanceName", "required": false, @@ -1498,7 +1498,7 @@ { "disabled": false, "document": "若多可用区部署云数据库实例，指定多可用区列表。\n- 多可用区部署实例，参数 **Zone** 指定实例主可用区信息；**AvailabilityZoneList** 指定所有可用区信息，包含主可用区。输入格式如：[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。\n- 通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 可获取云数据库不同地域规划的可用区信息，以便指定有效的可用区。\n- 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。", - "example": "无", + "example": "[\"ap-guangzhou-2\",\"ap-guangzhou-3\",\"ap-guangzhou-4\"]", "member": "string", "name": "AvailabilityZoneList", "required": false, @@ -1507,7 +1507,7 @@ { "disabled": false, "document": "Mongos CPU 核数，支持1、2、4、8、16。购买分片集群时，必须填写。", - "example": "无", + "example": "1", "member": "uint64", "name": "MongosCpu", "required": false, @@ -1516,7 +1516,7 @@ { "disabled": false, "document": "Mongos 内存大小。\n- 购买分片集群时，必须填写。\n- 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。", - "example": "无", + "example": "2", "member": "uint64", "name": "MongosMemory", "required": false, @@ -1525,7 +1525,7 @@ { "disabled": false, "document": "Mongos 数量。购买分片集群时，必须填写。\n- 单可用区部署实例，其数量范围为[3,32]。\n- 多可用区部署实例，其数量范围为[6,32]。", - "example": "无", + "example": "3", "member": "uint64", "name": "MongosNodeNum", "required": false, @@ -1534,7 +1534,7 @@ { "disabled": false, "document": "只读节点数量，取值范围[0,5]。", - "example": "无", + "example": "0", "member": "uint64", "name": "ReadonlyNodeNum", "required": false, @@ -1543,7 +1543,7 @@ { "disabled": false, "document": "指只读节点所属可用区数组。跨可用区部署实例，参数**ReadonlyNodeNum**不为**0**时，必须配置该参数。", - "example": "无", + "example": "[\"ap-guangzhou-2\"]", "member": "string", "name": "ReadonlyNodeAvailabilityZoneList", "required": false, @@ -1552,7 +1552,7 @@ { "disabled": false, "document": "Hidden节点所属可用区。跨可用区部署实例，必须配置该参数。", - "example": "无", + "example": "ap-guangzhou-2", "member": "string", "name": "HiddenZone", "required": false, @@ -1561,7 +1561,7 @@ { "disabled": false, "document": "参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合，将一组有相同诉求的参数及值 存为模板，在创建实例时，可直接引用参数值到新实例。合理使用参数模板，可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取，注意模板支持的版本及实例类型。", - "example": "tpl-0vswufxag", + "example": "tpl-0vswu****", "member": "string", "name": "ParamTemplateId", "required": false, @@ -1576,7 +1576,7 @@ { "disabled": false, "document": "订单ID", - "example": "7142863", + "example": "714****", "member": "string", "name": "DealId", "output_required": true, @@ -1586,7 +1586,7 @@ { "disabled": false, "document": "创建的实例ID列表", - "example": "[\"cmgo-po5f899l\"]", + "example": "[\"cmgo-po5f****\"]", "member": "string", "name": "InstanceIds", "output_required": true, @@ -1607,93 +1607,103 @@ "members": [ { "disabled": false, - "document": "操作序号\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "document": "操作序号。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "-130987****", "member": "int64", "name": "OpId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, - "document": "操作所在的命名空间，形式如db.collection\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "document": "操作所在的命名空间，形式如db.collection。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "db.test", "member": "string", "name": "Ns", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "操作执行语句\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "document": "操作执行语句。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", "member": "string", "name": "Query", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "操作类型，可能的取值：aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "document": "操作类型，可能的取值：aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "update", "member": "string", "name": "Op", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "操作所在的分片名称", - "example": "", + "document": "操作所在的分片名称。", + "example": "无", "member": "string", "name": "ReplicaSetName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, - "document": "筛选条件，节点状态，可能的取值为：Primary、Secondary\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "document": "操作所在的节点名称。", + "example": "无", "member": "string", - "name": "State", - "required": true, + "name": "NodeName", + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "操作详细信息\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "document": "操作详细信息。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", "member": "string", "name": "Operation", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "操作所在的节点名称", - "example": "", + "document": "筛选条件，节点状态，可能的取值为：Primary、Secondary。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", "member": "string", - "name": "NodeName", - "required": true, + "name": "State", + "output_required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "操作已执行时间（ms）\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "", + "document": "操作已执行时间（ms）。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "MicrosecsRunning", "member": "uint64", "name": "MicrosecsRunning", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true + }, + { + "disabled": false, + "document": "当前操作所在节点信息。\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "从节点", + "member": "string", + "name": "ExecNode", + "output_required": true, + "type": "string", + "value_allowed_null": true } ], "usage": "out" @@ -1877,7 +1887,7 @@ "example": "success", "member": "string", "name": "Status", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -2134,8 +2144,8 @@ "members": [ { "disabled": false, - "document": "实例ID，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同", - "example": "cmgo-p8vnipr5", + "document": "指定要查询的实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", + "example": "cmgo-p8vn****", "member": "string", "name": "InstanceId", "required": true, @@ -2143,8 +2153,8 @@ }, { "disabled": false, - "document": "筛选条件，操作所属的命名空间namespace，格式为db.collection", - "example": "无", + "document": "操作所属的命名空间 namespace，格式为 db.collection。", + "example": "data.user", "member": "string", "name": "Ns", "required": false, @@ -2152,8 +2162,8 @@ }, { "disabled": false, - "document": "筛选条件，操作已经执行的时间（单位：毫秒），结果将返回超过设置时间的操作，默认值为0，取值范围为[0, 3600000]", - "example": "无", + "document": "设置查询筛选条件为操作任务已经执行的时间。\n- 默认值为0，取值范围为[0, 3600000]，单位：毫秒。\n- 结果将返回超过设置时间的操作。", + "example": "20", "member": "uint64", "name": "MillisecondRunning", "required": false, @@ -2161,8 +2171,8 @@ }, { "disabled": false, - "document": "筛选条件，操作类型，可能的取值：none，update，insert，query，command，getmore，remove和killcursors", - "example": "无", + "document": "设置查询筛选条件为操作任务类型。取值包括：none、update、insert，query、command、getmore、remove 和 killcursors。", + "example": "update", "member": "string", "name": "Op", "required": false, @@ -2170,8 +2180,8 @@ }, { "disabled": false, - "document": "筛选条件，分片名称", - "example": "无", + "document": "筛选条件，分片名称。", + "example": "cmgo-nh1o****_0", "member": "string", "name": "ReplicaSetName", "required": false, @@ -2179,8 +2189,8 @@ }, { "disabled": false, - "document": "筛选条件，节点状态，可能的取值为：primary\nsecondary", - "example": "无", + "document": "设置查询筛选条件为节点角色。\n- primary：主节点。\n- secondary：从节点。", + "example": "primary", "member": "string", "name": "State", "required": false, @@ -2207,7 +2217,7 @@ { "disabled": false, "document": "返回结果集排序的字段，目前支持：\"MicrosecsRunning\"/\"microsecsrunning\"，默认为升序排序", - "example": "无", + "example": "MicrosecsRunning", "member": "string", "name": "OrderBy", "required": false, @@ -2216,7 +2226,7 @@ { "disabled": false, "document": "返回结果集排序方式，可能的取值：\"ASC\"/\"asc\"或\"DESC\"/\"desc\"", - "example": "无", + "example": "ASC", "member": "string", "name": "OrderByType", "required": false, @@ -2230,21 +2240,21 @@ "members": [ { "disabled": false, - "document": "符合查询条件的操作总数", + "document": "符合查询条件的操作总数。", "example": "19", "member": "uint64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "当前操作列表", + "document": "当前操作列表。", "example": "无", "member": "CurrentOp", "name": "CurrentOps", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -2579,7 +2589,7 @@ { "disabled": false, "document": "参数总个数。\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "TotalCount", "output_required": true, @@ -2609,7 +2619,7 @@ { "disabled": false, "document": "参数模板名称。\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "test", + "example": "my_tpl_demo", "member": "string", "name": "TplName", "output_required": true, @@ -2683,7 +2693,7 @@ { "disabled": false, "document": "参数模板总数。\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "无", + "example": "0", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -2786,7 +2796,7 @@ { "disabled": false, "document": "配置返回结果排序依据的字段。目前支持依据\"ProjectId\"、\"InstanceName\"、\"CreateTime\"排序。", - "example": "无", + "example": "ProjectId", "member": "string", "name": "OrderBy", "required": false, @@ -2795,7 +2805,7 @@ { "disabled": false, "document": "配置返回结果的排序方式。\n- ASC：升序。\n- DESC：降序。", - "example": "无", + "example": "ASC", "member": "string", "name": "OrderByType", "required": false, @@ -2804,7 +2814,7 @@ { "disabled": false, "document": "项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在右上角的账户信息下拉菜单中，选择项目管理查询项目。", - "example": "无", + "example": "[1,2]", "member": "uint64", "name": "ProjectIds", "required": false, @@ -2813,7 +2823,7 @@ { "disabled": false, "document": "指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。", - "example": "无", + "example": "cmgo-glh5****", "member": "string", "name": "SearchKey", "required": false, @@ -3302,7 +3312,7 @@ { "disabled": false, "document": " [密钥管理系统（Key Management Service，KMS）](https://cloud.tencent.com/document/product/573/18809)服务所在地域，例如 ap-shanghai。", - "example": "无", + "example": "ap-shanghai", "member": "string", "name": "KmsRegion", "required": true, @@ -3311,7 +3321,7 @@ { "disabled": false, "document": "密钥 ID。若不设置该参数，不指定具体的密钥 ID，由腾讯云自动生成密钥。", - "example": "无", + "example": "秘钥ID", "member": "string", "name": "KeyId", "required": false, @@ -3326,7 +3336,7 @@ { "disabled": false, "document": "开启透明加密的异步流程id，用于查询流程状态。", - "example": "无", + "example": "17316505316", "member": "int64", "name": "FlowId", "output_required": false, @@ -3372,7 +3382,7 @@ { "disabled": false, "document": "开启按 Key 回档的实例 ID。", - "example": "cmgo-igjysqkr", + "example": "cmgo-iga0****", "member": "string", "name": "InstanceId", "required": true, @@ -3399,7 +3409,7 @@ { "disabled": false, "document": "数据最终写入的实例 ID。", - "example": "无", + "example": "cmgo-iga0****", "member": "string", "name": "TargetInstanceId", "required": false, @@ -3414,7 +3424,7 @@ { "disabled": false, "document": "回档数据异步任务 ID。\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "无", + "example": "16033****", "member": "int64", "name": "FlowId", "output_required": false, @@ -3781,8 +3791,8 @@ "members": [ { "disabled": false, - "document": "实例ID，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同，接口单次最多只支持5个实例进行操作。", - "example": "[\"cmgo-8oij5631\\r\\n\"]", + "document": "实例ID，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同，接口单次最多只支持5个实例进行操作。", + "example": "[cmgo-8oij****]", "member": "string", "name": "InstanceIds", "required": true, @@ -3809,7 +3819,7 @@ "example": "无", "member": "DBInstancePrice", "name": "Price", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, diff --git a/tccli/services/mongodb/v20190725/examples.json b/tccli/services/mongodb/v20190725/examples.json index e35d19d4a3..9a8fa1ab76 100644 --- a/tccli/services/mongodb/v20190725/examples.json +++ b/tccli/services/mongodb/v20190725/examples.json @@ -106,9 +106,9 @@ ], "DescribeCurrentOp": [ { - "document": "", - "input": "https://mongodb.tencentcloudapi.com/?Action=DescribeCurrentOp\n&InstanceId=cmgo-p8vnipr5\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"CurrentOps\": [\n {\n \"ReplicaSetName\": \"xx\",\n \"NodeName\": \"xx\",\n \"State\": \"xx\",\n \"MicrosecsRunning\": 1,\n \"Query\": \"xx\",\n \"OpId\": 0,\n \"Ns\": \"xx\",\n \"Operation\": \"xx\",\n \"Op\": \"xx\"\n }\n ],\n \"RequestId\": \"xx\"\n }\n}", + "document": "查询云数据库实例的当前操作", + "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCurrentOp\n<公共请求参数>\n\n{\n \"InstanceId\": \"cmgo-p8vn****\"\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"CurrentOps\": [\n {\n \"OpId\": 1804858933,\n \"Ns\": \"db.****\",\n \"Query\": \"\",\n \"Op\": \"command\",\n \"ReplicaSetName\": \"salve-1\",\n \"NodeName\": \"salve-1\",\n \"Operation\": \"****\",\n \"State\": \"Primary\",\n \"MicrosecsRunning\": 30353723,\n \"ExecNode\": \"从节点\"\n }\n ],\n \"RequestId\": \"66956cf3-2d10-4c68-87c0-7bd558deae7e\"\n }\n}", "title": "查询云数据库实例的当前操作" } ], @@ -227,8 +227,8 @@ "FlashBackDBInstance": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: FlashBackDBInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"cmgo-igjysqkr\",\n \"TargetFlashbackTime\": \"2023-08-04 14:00:00\",\n \"TargetDatabases\": [\n {\n \"DBName\": \"my_test\",\n \"Collections\": [\n {\n \"CollectionName\": \"my_test1\",\n \"KeyValues\": [\n {\n \"Key\": \"name\",\n \"Value\": \"abc\"\n }\n ],\n \"TargetResultCollectionName\": \"my_test_bak0804143230\",\n \"FilterKey\": \"name\"\n }\n ]\n }\n ],\n \"TargetInstanceId\": \"cmgo-05173fe7\"\n}", - "output": "{\n \"Response\": {\n \"FlowId\": 1234567,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: FlashBackDBInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"cmgo-igjysqkr\",\n \"TargetFlashbackTime\": \"2023-08-04 14:00:00\",\n \"TargetDatabases\": [\n {\n \"DBName\": \"my_test\",\n \"Collections\": [\n {\n \"CollectionName\": \"my_test1\",\n \"KeyValues\": [\n {\n \"Key\": \"name\",\n \"Value\": \"name-demo\"\n }\n ],\n \"TargetResultCollectionName\": \"my_test_bak0804143230\",\n \"FilterKey\": \"name\"\n }\n ]\n }\n ],\n \"TargetInstanceId\": \"cmgo-0517****\"\n}", + "output": "{\n \"Response\": {\n \"FlowId\": 1234567,\n \"RequestId\": \"59b477da-6473-4ea8-85b3-7f4473744****\"\n }\n}", "title": "执行按key回档" } ], diff --git a/tccli/services/monitor/v20180724/examples.json b/tccli/services/monitor/v20180724/examples.json index 75f51d644f..3d9addc353 100644 --- a/tccli/services/monitor/v20180724/examples.json +++ b/tccli/services/monitor/v20180724/examples.json @@ -132,7 +132,7 @@ "title": "r. 创建 Graphite 集成" }, { - "document": "参数说明：\n1. InstanceId 是 Prometheus 实例 ID，必填\n2. Kind 参数固定为 `qcloud-exporter`，必填\n3. Content 参数格式如示例。说明如下：\n3.1. name 是集成名，必填且全局唯一，需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型，必填且这里固定为 `qcloud-exporter`\n3.3. spec.instanceSpec.region 是云产品所在地域，必填，比如采集广州地域的云产品，可以填 `广州` 或 `ap-guangzhou`，该参数最终会转化为指标的 label， 名为 `instance-region`\n3.4. spec.instanceSpec.delaySeconds 表示数据采集延迟，整数，单位是秒，可不填，默认是 0。当值为 0 时，原始数据点的时间戳会被忽略，替换为集成拉取到数据点的时间；当值 >0 时，数据点会保留原始的时间戳，且数据必然会延迟设置的时间\n3.5. spec.instanceSpec.reload_interval_minutes 表示实例刷新间隔，整数，单位是分钟，必填且必须大于等于 10。云产品实例的新增或者云标签的修改，会在刷新实例后反映在指标中，至多需要等待一个实例刷新间隔\n3.6. spec.instanceSpec.useRole 表示是否使用服务角色，布尔类型，必填。当前逻辑一定会使用服务角色，所以必填 `true`\n3.7. spec.instanceSpec.labels 用于给指标添加自定义标签，键值对类型，选填\n3.8. spec.exporterSpec.[云产品] 表示是否采集对应云产品，布尔类型，`true` 表示采集该云产品。云产品各编码指代含义：`cvm`:云服务器,`cbs`:云硬盘,`lb_public`:负载均衡(公网),`lb_private`:负载均衡(内网),`tgw_set`:负载均衡(独占集群),`cmongo`:数据库MongoDB,`cdb`:数据库MySQL(CDB),`redis`:数据库Redis(CKV版),`redis_mem`:数据库Redis(内存版),`tendis`:Tendis,`xstor`:CTSDB(InfluxDB版),`mariadb`:数据库MariaDB,`postgres`:数据库PostgreSQL,`tdmysql`:TDSQL MySQL版,`cynosdb_mysql`:TDSQL-C MySQL,`sqlserver`:数据库SQL Server,`nat_gateway`:NAT网关,`ckafka`:CKafka,`rocketmq`:RocketMQ(新指标),`lb`:弹性公网IP,`vpngw`:VPN网关,`vpnx`:VPN通道,`vpc_net_detect`:网络探测,`cdn`:CDN,`ov_cdn`:CND(海外),`cos`:COS,`dc`:专线接入-物理专线,`dcx`:专线接入-专用通道,`dcg`:专线接入-专线网关,`lighthouse`:轻量应用服务器,`nacos`:Nacos,`zookeeper`:Zookeeper,`ces`:Elasticsearch,`dts`:数据传输服务,`vbc`:云联网,`gaap`:全球应用加速,`waf`:Web应用防火墙,`cfs`:文件存储,`bwp`:共享带宽包,`scf_v2`:云函数(别名),`vod`:云点播(VOD),`cls`:日志服务(CLS)-日志主题,`apigateway`:API 网关,`ti_traintask`:TI-ONE(任务式建模),`ti_notebook`:TI-ONE(Notebook),`ti_model`:TI-ONE(在线服务),`self`:采集器自监控\n2.9. spec.scrapeSpec.relabelConfigs 用于添加 `metricRelabelings` 配置，选填。该配置是 prometheus-operator 的 relabel 配置，部分字段与 prometheus 原生 relabel 配置不同，具体可参考[官方配置说明](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.RelabelConfig)", + "document": "参数说明：\n1. InstanceId 是 Prometheus 实例 ID，必填\n2. Kind 参数固定为 `qcloud-exporter`，必填\n3. Content 参数格式如示例。说明如下：\n3.1. name 是集成名，必填且全局唯一，需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型，必填且这里固定为 `qcloud-exporter`\n3.3. spec.instanceSpec.region 是云产品所在地域，必填，比如采集广州地域的云产品，可以填 `广州` 或 `ap-guangzhou`，该参数最终会转化为指标的 label， 名为 `instance-region`\n3.4. spec.instanceSpec.delaySeconds 表示数据采集延迟，整数，单位是秒，可不填，默认是 0。当值为 0 时，原始数据点的时间戳会被忽略，替换为集成拉取到数据点的时间；当值 >0 时，数据点会保留原始的时间戳，且数据必然会延迟设置的时间\n3.5. spec.instanceSpec.reload_interval_minutes 表示实例刷新间隔，整数，单位是分钟，必填且必须大于等于 10。云产品实例的新增或者云标签的修改，会在刷新实例后反映在指标中，至多需要等待一个实例刷新间隔\n3.6. spec.instanceSpec.useRole 表示是否使用服务角色，布尔类型，必填。当前逻辑一定会使用服务角色，所以必填 `true`\n3.7. spec.instanceSpec.labels 用于给指标添加自定义标签，键值对类型，选填\n3.8. spec.exporterSpec.[云产品] 表示是否采集对应云产品，布尔类型，`true` 表示采集该云产品。云产品各编码指代含义：`cvm`:云服务器,`cbs`:云硬盘,`lb_public`:负载均衡(公网),`lb_private`:负载均衡(内网),`tgw_set`:负载均衡(独占集群),`cmongo`:数据库MongoDB,`cdb`:数据库MySQL(CDB),`redis`:数据库Redis(CKV版),`redis_mem`:数据库Redis(内存版),`tendis`:Tendis,`xstor`:CTSDB(InfluxDB版),`mariadb`:数据库MariaDB,`postgres`:数据库PostgreSQL,`tdmysql`:TDSQL MySQL版,`cynosdb_mysql`:TDSQL-C MySQL,`sqlserver`:数据库SQL Server,`nat_gateway`:NAT网关,`ckafka`:CKafka,`rocketmq`:RocketMQ(新指标),`lb`:弹性公网IP,`vpngw`:VPN网关,`vpnx`:VPN通道,`vpc_net_detect`:网络探测,`cdn`:CDN,`ov_cdn`:CDN(海外),`cos`:COS,`dc`:专线接入-物理专线,`dcx`:专线接入-专用通道,`dcg`:专线接入-专线网关,`lighthouse`:轻量应用服务器,`nacos`:Nacos,`zookeeper`:Zookeeper,`ces`:Elasticsearch,`dts`:数据传输服务,`vbc`:云联网,`gaap`:全球应用加速,`waf`:Web应用防火墙,`cfs`:文件存储,`bwp`:共享带宽包,`scf_v2`:云函数(别名),`vod`:云点播(VOD),`cls`:日志服务(CLS)-日志主题,`apigateway`:API 网关,`ti_traintask`:TI-ONE(任务式建模),`ti_notebook`:TI-ONE(Notebook),`ti_model`:TI-ONE(在线服务),`self`:采集器自监控\n2.9. spec.scrapeSpec.relabelConfigs 用于添加 `metricRelabelings` 配置，选填。该配置是 prometheus-operator 的 relabel 配置，部分字段与 prometheus 原生 relabel 配置不同，具体可参考[官方配置说明](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.RelabelConfig)", "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"qcloud-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"test\\\",\\\"kind\\\":\\\"qcloud-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"region\\\":\\\"广州\\\",\\\"delaySeconds\\\":0,\\\"reload_interval_minutes\\\":10,\\\"useRole\\\":true,\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}},\\\"exporterSpec\\\":{\\\"cvm\\\":true,\\\"cbs\\\":true},\\\"scrapeSpec\\\":{\\\"relabelConfigs\\\":\\\"metricRelabelings:\\\\n- action: labeldrop\\\\n regex: tmp_test_label\\\\n\\\"}}}\"\n}", "output": "{\n \"Response\": {\n \"Names\": [\n \"test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}", "title": "a. 创建 云监控 集成" diff --git a/tccli/services/mqtt/v20240516/api.json b/tccli/services/mqtt/v20240516/api.json index a30263c3a2..62ed44136c 100644 --- a/tccli/services/mqtt/v20240516/api.json +++ b/tccli/services/mqtt/v20240516/api.json @@ -1044,7 +1044,7 @@ { "disabled": false, "document": "设备证书sn", - "example": "123", + "example": "device-certificate-sn", "member": "string", "name": "DeviceCertificateSn", "required": true, diff --git a/tccli/services/mqtt/v20240516/examples.json b/tccli/services/mqtt/v20240516/examples.json index 30c74494e3..c74aa552bf 100644 --- a/tccli/services/mqtt/v20240516/examples.json +++ b/tccli/services/mqtt/v20240516/examples.json @@ -106,7 +106,7 @@ { "document": "示例", "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDeviceCertificate\n<公共请求参数>\n\n{\n \"DeviceCertificateSn\": \"0eef68a582b94254296e54ce754f94d707a59911\",\n \"InstanceId\": \"mqtt-jbgwp4ae\"\n}", - "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"CaSn\": \"1b1e3bf3702110125887a3a721a7e66f05522513\",\n \"CertificateSource\": \"API\",\n \"ClientId\": \"111\",\n \"CreatedTime\": 1724050379000,\n \"DeviceCertificate\": \"-----BEGIN CERTIFICATE-----\\nMIIEQjCCAyqgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmREwDQYJKoZIhvcNAQEL\\n-----END CERTIFICATE-----\\n\",\n \"DeviceCertificateCn\": \"mqtt-test.xxx.tencent.com\",\n \"DeviceCertificateSn\": \"0eef68a582b94254296e54ce754f94d707a59911\",\n \"Format\": \"PEM\",\n \"LastActivationTime\": 1724050378987,\n \"LastInactivationTime\": 0,\n \"NotAfterTime\": 1758185683000,\n \"NotBeforeTime\": 1714985683000,\n \"RequestId\": \"1b5fc3fa-4bbf-421a-aad1-c45d49119a2c\",\n \"Status\": \"ACTIVE\",\n \"UpdateTime\": 1724050379000\n }\n}", + "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"CaSn\": \"1b1e3bf3702110125887a3a721a7e66f05522513\",\n \"CertificateSource\": \"API\",\n \"ClientId\": \"client1\",\n \"CreatedTime\": 1724050379000,\n \"DeviceCertificate\": \"-----BEGIN CERTIFICATE-----\\nMIIEQjCCAyqgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmREwDQYJKoZIhvcNAQEL\\n-----END CERTIFICATE-----\\n\",\n \"DeviceCertificateCn\": \"mqtt-test.xxx.tencent.com\",\n \"DeviceCertificateSn\": \"0eef68a582b94254296e54ce754f94d707a59911\",\n \"Format\": \"PEM\",\n \"LastActivationTime\": 1724050378987,\n \"LastInactivationTime\": 0,\n \"NotAfterTime\": 1758185683000,\n \"NotBeforeTime\": 1714985683000,\n \"RequestId\": \"1b5fc3fa-4bbf-421a-aad1-c45d49119a2c\",\n \"Status\": \"ACTIVE\",\n \"UpdateTime\": 1724050379000\n }\n}", "title": "示例" } ], diff --git a/tccli/services/pts/v20210728/api.json b/tccli/services/pts/v20210728/api.json index d57fc95ff5..29d7db20ac 100644 --- a/tccli/services/pts/v20210728/api.json +++ b/tccli/services/pts/v20210728/api.json @@ -5731,6 +5731,7 @@ "example": "ap-guangzhou", "member": "string", "name": "Region", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -5741,6 +5742,7 @@ "example": "1", "member": "int64", "name": "RegionId", + "output_required": true, "required": true, "type": "int", "value_allowed_null": false @@ -5751,6 +5753,7 @@ "example": "华南地区", "member": "string", "name": "Area", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -5761,6 +5764,7 @@ "example": "广州", "member": "string", "name": "RegionName", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -5771,6 +5775,7 @@ "example": "1", "member": "int64", "name": "RegionState", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -5781,6 +5786,7 @@ "example": "gz", "member": "string", "name": "RegionShortName", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -5791,6 +5797,7 @@ "example": "2021-08-20T16:33:00+08:00", "member": "datetime_iso", "name": "CreatedAt", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -5801,6 +5808,7 @@ "example": "2021-08-20T16:33:00+08:00", "member": "datetime_iso", "name": "UpdatedAt", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false diff --git a/tccli/services/ssl/v20191205/examples.json b/tccli/services/ssl/v20191205/examples.json index 55818bed57..eb1c357f1c 100644 --- a/tccli/services/ssl/v20191205/examples.json +++ b/tccli/services/ssl/v20191205/examples.json @@ -198,7 +198,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: ssl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCompanies\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Companies\": [\n {\n \"CompanyId\": 122,\n \"CompanyName\": \"腾讯\",\n \"CompanyCountry\": \"中国\",\n \"CompanyProvince\": \"广东\",\n \"CompanyCity\": \"深圳\",\n \"CompanyAddress\": \"深南大道\",\n \"CompanyPhone\": \"2132323\",\n \"IdType\": \"\",\n \"IdNumber\": \"xxx\"\n }\n ],\n \"RequestId\": \"5779b652-9c64-45b3-a6f4-641db7376a2e\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Companies\": [\n {\n \"CompanyId\": 122,\n \"CompanyName\": \"腾讯\",\n \"CompanyCountry\": \"中国\",\n \"CompanyProvince\": \"广东\",\n \"CompanyCity\": \"深圳\",\n \"CompanyAddress\": \"深南大道\",\n \"CompanyPhone\": \"2132323\",\n \"IdType\": \"\",\n \"IdNumber\": \"\"\n }\n ],\n \"RequestId\": \"5779b652-9c64-45b3-a6f4-641db7376a2e\"\n }\n}", "title": "查询公司列表" } ], diff --git a/tccli/services/sts/v20180813/examples.json b/tccli/services/sts/v20180813/examples.json index fb4e4d1132..5065bd46e4 100644 --- a/tccli/services/sts/v20180813/examples.json +++ b/tccli/services/sts/v20180813/examples.json @@ -11,7 +11,7 @@ "AssumeRoleWithSAML": [ { "document": "SAML 断言申请角色临时访问凭证", - "input": "POST / HTTP/1.1\nHost: sts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AssumeRoleWithSAML\n<公共请求参数>\n\n{\n \"RoleArn\": \"qcs::cam::uin/798950673:roleName/OneLogin-Role\",\n \"PrincipalArn\": \"qcs::cam::uin/798950673:saml-provider/OneLogin\",\n \"SAMLAssertion\": \"c2FtbCBhc3NlcnRpb24=\",\n \"RoleSessionName\": \"test\"\n}", + "input": "POST / HTTP/1.1\nHost: sts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AssumeRoleWithSAML\n<公共请求参数>\n\n{\n \"RoleArn\": \"qcs::cam::uin/798950673:roleName/OneLogin-Role\",\n \"PrincipalArn\": \"qcs::cam::uin/798950673:saml-provider/OneLogin\",\n \"SAMLAssertion\": \"c2FtbCBhc3NlcnRpb24=\",\n \"RoleSessionName\": \"GetSamlRole\"\n}", "output": "{\n \"Response\": {\n \"Credentials\": {\n \"Token\": \"1siMD***\",\n \"TmpSecretId\": \"AKID***\",\n \"TmpSecretKey\": \"q95K***\"\n },\n \"ExpiredTime\": 1543914376,\n \"Expiration\": \"2018-12-04T09:06:16Z\",\n \"RequestId\": \"4daec797-9cd2-4f09-9e7a-7d4c43b2a74c\"\n }\n}", "title": "SAML 断言申请角色临时访问凭证" } diff --git a/tccli/services/tdid/v20210519/api.json b/tccli/services/tdid/v20210519/api.json index d89be3c7a8..2be8ed08ff 100644 --- a/tccli/services/tdid/v20210519/api.json +++ b/tccli/services/tdid/v20210519/api.json @@ -144,8 +144,7 @@ "member": "uint64", "name": "CPTId", "required": true, - "type": "int", - "value_allowed_null": false + "type": "int" }, { "disabled": false, @@ -154,8 +153,7 @@ "member": "string", "name": "Issuer", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, @@ -164,8 +162,7 @@ "member": "string", "name": "ExpirationDate", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, @@ -174,8 +171,7 @@ "member": "string", "name": "ClaimJson", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, @@ -184,18 +180,16 @@ "member": "string", "name": "Type", "required": false, - "type": "list", - "value_allowed_null": false + "type": "list" }, { "disabled": false, "document": "多方签名的用户did", - "example": "[]", + "example": "[\"did:tdid:f34:0x996d0259c4c09359b8ef0fb1b530a2aa702cf092\",\"did:tdid:c97:0xc1f030ceeb858887f0cc400030d59534cf8098c8\"]", "member": "string", "name": "Parties", "required": false, - "type": "list", - "value_allowed_null": false + "type": "list" } ], "usage": "in" @@ -231,7 +225,7 @@ { "disabled": false, "document": "凭证文本内容，FunctionArg和CredentialText任选其一", - "example": "credential", + "example": "{\"cptId\":1,\"issuer\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827\",\"expirationDate\":\"2124-06-29T15:25:00+08:00\",\"issuanceDate\":\"2024-12-18T10:51:47+08:00\",\"context\":\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\",\"id\":\"6aeea943a851ad83acae1e138c2edc67\",\"type\":[\"VerifiableCredential\"],\"credentialSubject\":{\"action\":\"setAge\",\"age\":17},\"proof\":{\"created\":\"2024-12-18T10:51:47+08:00\",\"creator\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827#keys-0\",\"signatureValue\":\"MEQCIHETsDrIpka838y4NHWU2S07+YwPRb3Mpwq8W5TLDNsNAiBUBFP0mb+eNpc5cTla15MxtIWGk0u8AAiTAHLjYbS2Mg==\",\"type\":\"Secp256r1\",\"metaDigest\":\"79ccefe237c9bf65d804747ca7f20ff9b985242e4e1e8634587bbebe07b51c45\",\"vcDigest\":\"b8e185fdd623d09434460ceaae6dd5563411ed9d8c7ded144248813ba0b4bcfc\",\"privacy\":\"Public\",\"salt\":{\"action\":\"XG9VA\",\"age\":\"yol5B\"}}}", "member": "string", "name": "CredentialData", "required": false, @@ -240,7 +234,7 @@ { "disabled": false, "document": "披露策略文本", - "example": "{\"age\":1}", + "example": "{\"age\":0}", "member": "string", "name": "PolicyJson", "required": false, @@ -264,7 +258,7 @@ { "disabled": false, "document": "凭证字符串", - "example": "{}", + "example": "{\"context\":\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\",\"cptId\":1,\"credentialSubject\":{\"action\":\"setAge\",\"age\":\"0x7a5b0f3813c2bcd4a0b3e2c534aafdb4cf0337af1ad2bc308bd11c6aded91a3c\"},\"expirationDate\":\"2124-06-29T15:25:00+08:00\",\"id\":\"6aeea943a851ad83acae1e138c2edc67\",\"issuanceDate\":\"2024-12-18T10:51:47+08:00\",\"issuer\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827\",\"proof\":{\"created\":\"2024-12-18T10:51:47+08:00\",\"creator\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827#keys-0\",\"metaDigest\":\"79ccefe237c9bf65d804747ca7f20ff9b985242e4e1e8634587bbebe07b51c45\",\"privacy\":\"Public\",\"salt\":{\"action\":\"XG9VA\",\"age\":\"0\"},\"signatureValue\":\"MEQCIHETsDrIpka838y4NHWU2S07+YwPRb3Mpwq8W5TLDNsNAiBUBFP0mb+eNpc5cTla15MxtIWGk0u8AAiTAHLjYbS2Mg==\",\"type\":\"Secp256r1\",\"vcDigest\":\"b8e185fdd623d09434460ceaae6dd5563411ed9d8c7ded144248813ba0b4bcfc\"},\"type\":[\"VerifiableCredential\"]}", "member": "string", "name": "CredentialData", "output_required": true, @@ -295,7 +289,7 @@ { "disabled": false, "document": "凭证列表", - "example": "[]", + "example": "[\"credential1\", \"credential2\"]", "member": "string", "name": "Credentials", "required": false, @@ -313,7 +307,7 @@ { "disabled": false, "document": "VP随机验证码", - "example": "test", + "example": "RIflyg", "member": "string", "name": "VerifyCode", "required": false, @@ -322,7 +316,7 @@ { "disabled": false, "document": "选择性披露策略", - "example": "{}", + "example": "{”action\":1}", "member": "string", "name": "PolicyJson", "required": false, @@ -355,7 +349,7 @@ { "disabled": false, "document": "可验证表达内容", - "example": "\"\"", + "example": "{\"context\":[\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\"],\"holder\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827\",\"proof\":{\"created\":\"2024-12-18T11:12:22+08:00\",\"nonce\":\"RIflyg\",\"signatureValue\":\"eyJjb250ZXh0IjpbImh0dHBzOi8vZ2l0aHViLmNvbS9UZW5jZW50Q2xvdWQtQmxvY2tjaGFpbi9URElEL2Jsb2IvbWFpbi9jb250ZXh0L3YxIl0sImhvbGRlciI6ImRpZDp0ZGlkOmMxMToweGU0ZTA3NjY4OWIxMWRjYWExMTE4YWVmNjU0NzkxY2NhOTVjNzY4MjciLCJ0eXBlIjpbIlZlcmlmaWFibGVQcmVzZW50YXRpb24iXSwidmVyaWZpYWJsZUNyZWRlbnRpYWwiOlt7ImNvbnRleHQiOiJodHRwczovL2dpdGh1Yi5jb20vVGVuY2VudENsb3VkLUJsb2NrY2hhaW4vVERJRC9ibG9iL21haW4vY29udGV4dC92MSIsImNwdElkIjoxLCJjcmVkZW50aWFsU3ViamVjdCI6eyJhY3Rpb24iOiJzZXRBZ2UiLCJhZ2UiOiIweDdhNWIwZjM4MTNjMmJjZDRhMGIzZTJjNTM0YWFmZGI0Y2YwMzM3YWYxYWQyYmMzMDhiZDExYzZhZGVkOTFhM2MifSwiZXhwaXJhdGlvbkRhdGUiOiIyMTI0LTA2LTI5VDE1OjI1OjAwKzA4OjAwIiwiaWQiOiI2YWVlYTk0M2E4NTFhZDgzYWNhZTFlMTM4YzJlZGM2NyIsImlzc3VhbmNlRGF0ZSI6IjIwMjQtMTItMThUMTA6NTE6NDcrMDg6MDAiLCJpc3N1ZXIiOiJkaWQ6dGRpZDpjMTE6MHhlNGUwNzY2ODliMTFkY2FhMTExOGFlZjY1NDc5MWNjYTk1Yzc2ODI3IiwicHJvb2YiOnsiY3JlYXRlZCI6IjIwMjQtMTItMThUMTA6NTE6NDcrMDg6MDAiLCJjcmVhdG9yIjoiZGlkOnRkaWQ6YzExOjB4ZTRlMDc2Njg5YjExZGNhYTExMThhZWY2NTQ3OTFjY2E5NWM3NjgyNyNrZXlzLTAiLCJtZXRhRGlnZXN0IjoiNzljY2VmZTIzN2M5YmY2NWQ4MDQ3NDdjYTdmMjBmZjliOTg1MjQyZTRlMWU4NjM0NTg3YmJlYmUwN2I1MWM0NSIsInByaXZhY3kiOiJQdWJsaWMiLCJzYWx0Ijp7ImFjdGlvbiI6IlhHOVZBIiwiYWdlIjoiMCJ9LCJzaWduYXR1cmVWYWx1ZSI6Ik1FUUNJSEVUc0RySXBrYTgzOHk0TkhXVTJTMDcrWXdQUmIzTXB3cThXNVRMRE5zTkFpQlVCRlAwbWIrZU5wYzVjVGxhMTVNeHRJV0drMHU4QUFpVEFITGpZYlMyTWc9PSIsInR5cGUiOiJTZWNwMjU2cjEiLCJ2Y0RpZ2VzdCI6ImI4ZTE4NWZkZDYyM2QwOTQzNDQ2MGNlYWFlNmRkNTU2MzQxMWVkOWQ4YzdkZWQxNDQyNDg4MTNiYTBiNGJjZmMifSwidHlwZSI6WyJWZXJpZmlhYmxlQ3JlZGVudGlhbCJdfV0sInplcm9Qcm9vZiI6W1tdXX0=\",\"type\":\"Secp256r1\",\"verificationMethod\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827#keys-0\",\"vpDigest\":\"61975d8175b3cf3f7f9f316350d94bcd2e980eb7b2e66ddecc170ab43bbb5183\"},\"type\":[\"VerifiablePresentation\"],\"verifiableCredential\":[{\"context\":\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\",\"cptId\":1,\"credentialSubject\":{\"action\":\"setAge\",\"age\":\"0x7a5b0f3813c2bcd4a0b3e2c534aafdb4cf0337af1ad2bc308bd11c6aded91a3c\"},\"expirationDate\":\"2124-06-29T15:25:00+08:00\",\"id\":\"6aeea943a851ad83acae1e138c2edc67\",\"issuanceDate\":\"2024-12-18T10:51:47+08:00\",\"issuer\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827\",\"proof\":{\"created\":\"2024-12-18T10:51:47+08:00\",\"creator\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827#keys-0\",\"metaDigest\":\"79ccefe237c9bf65d804747ca7f20ff9b985242e4e1e8634587bbebe07b51c45\",\"privacy\":\"Public\",\"salt\":{\"action\":\"XG9VA\",\"age\":\"0\"},\"signatureValue\":\"MEQCIHETsDrIpka838y4NHWU2S07+YwPRb3Mpwq8W5TLDNsNAiBUBFP0mb+eNpc5cTla15MxtIWGk0u8AAiTAHLjYbS2Mg==\",\"type\":\"Secp256r1\",\"vcDigest\":\"b8e185fdd623d09434460ceaae6dd5563411ed9d8c7ded144248813ba0b4bcfc\"},\"type\":[\"VerifiableCredential\"]}],\"zeroProof\":[[]]}", "member": "string", "name": "PresentationData", "output_required": false, @@ -386,7 +380,7 @@ { "disabled": false, "document": "自定义DID文档json属性", - "example": "{}", + "example": "{\"name\":\"张三\"}", "member": "string", "name": "CustomAttribute", "required": false, @@ -442,7 +436,7 @@ { "disabled": false, "document": "pem格式的认证公钥", - "example": "test", + "example": "-----BEGIN PUBLIC KEY-----\\r\\nMFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAEdPxYz6u53NB5WqgESSaRYwDSPeBUuyke8CTlyWn7/BYpbRKQTzt3b3O+QYeMSJULvclDsj+pFCZPh9lLrBNU6w==\\r\\n-----END PUBLIC KEY-----", "member": "string", "name": "PublicKey", "required": false, @@ -451,7 +445,7 @@ { "disabled": false, "document": "自定义DID初始化属性json字符串", - "example": "{}", + "example": "{\"name\":\"李四\"}", "member": "string", "name": "CustomAttribute", "required": false, @@ -702,22 +696,20 @@ { "disabled": false, "document": "键名", - "example": "a", + "example": "name", "member": "string", "name": "Key", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "键值", - "example": "1", + "example": "李四", "member": "string", "name": "Val", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" } ], "usage": "in" @@ -775,7 +767,7 @@ { "disabled": false, "document": "凭证唯一Id", - "example": "a", + "example": "19d88ecb3f04997ccc64d425259ade0d", "member": "string", "name": "CredentialId", "required": false, @@ -1004,7 +996,7 @@ { "disabled": false, "document": "DID公钥数组", - "example": "[]", + "example": "[\"-----BEGIN PUBLIC KEY-----\\r\\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEkb2grT3bobgV6CYqfa91ywqtBHeAR5HnVUQFbSzlG4irxRW7UfN69GISmRKtAWZY9hTD4sBeC0FA/2MSb7Rv7w==\\r\\n-----END PUBLIC KEY-----\"]", "member": "string", "name": "AuthPublicKeyList", "output_required": false, @@ -1099,7 +1091,7 @@ { "disabled": false, "document": "权威机构名称", - "example": "test", + "example": "某教育学院", "member": "string", "name": "Name", "required": false, @@ -1114,7 +1106,7 @@ { "disabled": false, "document": "名称", - "example": "test", + "example": "某教育学院", "member": "string", "name": "Name", "output_required": false, @@ -1144,7 +1136,7 @@ { "disabled": false, "document": "机构备注信息", - "example": "test", + "example": "职业教育", "member": "string", "name": "Description", "output_required": false, @@ -1200,7 +1192,7 @@ { "disabled": false, "document": "凭证模板内容", - "example": "{}", + "example": "{\\n \"cptType\" : \"original\",\\n \"$schema\" : \"http://json-schema.org/draft-04/schema#\",\\n \"description\" : \"operate temp credential\",\\n \"title\" : \"operation\",\\n \"type\" : \"object\",\\n \"properties\" : {\\n \"action\" : {\\n \"description\" : \"操作类型\",\\n \"type\" : \"string\"\\n }\\n },\\n \"required\" : [ \"action\" ]\\n}", "member": "string", "name": "CPTJson", "output_required": true, @@ -1397,7 +1389,7 @@ { "disabled": false, "document": "凭证内容", - "example": "{}", + "example": "{\"cptId\":1,\"issuer\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827\",\"expirationDate\":\"2124-06-29T15:25:00+08:00\",\"issuanceDate\":\"2024-12-18T10:51:47+08:00\",\"context\":\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\",\"id\":\"6aeea943a851ad83acae1e138c2edc67\",\"type\":[\"VerifiableCredential\"],\"credentialSubject\":{\"action\":\"setAge\",\"age\":17},\"proof\":{\"created\":\"2024-12-18T10:51:47+08:00\",\"creator\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827#keys-0\",\"signatureValue\":\"MEQCIHETsDrIpka838y4NHWU2S07+YwPRb3Mpwq8W5TLDNsNAiBUBFP0mb+eNpc5cTla15MxtIWGk0u8AAiTAHLjYbS2Mg==\",\"type\":\"Secp256r1\",\"metaDigest\":\"79ccefe237c9bf65d804747ca7f20ff9b985242e4e1e8634587bbebe07b51c45\",\"vcDigest\":\"b8e185fdd623d09434460ceaae6dd5563411ed9d8c7ded144248813ba0b4bcfc\",\"privacy\":\"Public\",\"salt\":{\"action\":\"XG9VA\",\"age\":\"yol5B\"}}}", "member": "string", "name": "CredentialData", "required": false, @@ -1472,7 +1464,7 @@ { "disabled": false, "document": "可验证表达内容", - "example": "{}", + "example": "{\"context\":[\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\"],\"holder\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827\",\"proof\":{\"created\":\"2024-12-18T11:12:22+08:00\",\"nonce\":\"RIflyg\",\"signatureValue\":\"eyJjb250ZXh0IjpbImh0dHBzOi8vZ2l0aHViLmNvbS9UZW5jZW50Q2xvdWQtQmxvY2tjaGFpbi9URElEL2Jsb2IvbWFpbi9jb250ZXh0L3YxIl0sImhvbGRlciI6ImRpZDp0ZGlkOmMxMToweGU0ZTA3NjY4OWIxMWRjYWExMTE4YWVmNjU0NzkxY2NhOTVjNzY4MjciLCJ0eXBlIjpbIlZlcmlmaWFibGVQcmVzZW50YXRpb24iXSwidmVyaWZpYWJsZUNyZWRlbnRpYWwiOlt7ImNvbnRleHQiOiJodHRwczovL2dpdGh1Yi5jb20vVGVuY2VudENsb3VkLUJsb2NrY2hhaW4vVERJRC9ibG9iL21haW4vY29udGV4dC92MSIsImNwdElkIjoxLCJjcmVkZW50aWFsU3ViamVjdCI6eyJhY3Rpb24iOiJzZXRBZ2UiLCJhZ2UiOiIweDdhNWIwZjM4MTNjMmJjZDRhMGIzZTJjNTM0YWFmZGI0Y2YwMzM3YWYxYWQyYmMzMDhiZDExYzZhZGVkOTFhM2MifSwiZXhwaXJhdGlvbkRhdGUiOiIyMTI0LTA2LTI5VDE1OjI1OjAwKzA4OjAwIiwiaWQiOiI2YWVlYTk0M2E4NTFhZDgzYWNhZTFlMTM4YzJlZGM2NyIsImlzc3VhbmNlRGF0ZSI6IjIwMjQtMTItMThUMTA6NTE6NDcrMDg6MDAiLCJpc3N1ZXIiOiJkaWQ6dGRpZDpjMTE6MHhlNGUwNzY2ODliMTFkY2FhMTExOGFlZjY1NDc5MWNjYTk1Yzc2ODI3IiwicHJvb2YiOnsiY3JlYXRlZCI6IjIwMjQtMTItMThUMTA6NTE6NDcrMDg6MDAiLCJjcmVhdG9yIjoiZGlkOnRkaWQ6YzExOjB4ZTRlMDc2Njg5YjExZGNhYTExMThhZWY2NTQ3OTFjY2E5NWM3NjgyNyNrZXlzLTAiLCJtZXRhRGlnZXN0IjoiNzljY2VmZTIzN2M5YmY2NWQ4MDQ3NDdjYTdmMjBmZjliOTg1MjQyZTRlMWU4NjM0NTg3YmJlYmUwN2I1MWM0NSIsInByaXZhY3kiOiJQdWJsaWMiLCJzYWx0Ijp7ImFjdGlvbiI6IlhHOVZBIiwiYWdlIjoiMCJ9LCJzaWduYXR1cmVWYWx1ZSI6Ik1FUUNJSEVUc0RySXBrYTgzOHk0TkhXVTJTMDcrWXdQUmIzTXB3cThXNVRMRE5zTkFpQlVCRlAwbWIrZU5wYzVjVGxhMTVNeHRJV0drMHU4QUFpVEFITGpZYlMyTWc9PSIsInR5cGUiOiJTZWNwMjU2cjEiLCJ2Y0RpZ2VzdCI6ImI4ZTE4NWZkZDYyM2QwOTQzNDQ2MGNlYWFlNmRkNTU2MzQxMWVkOWQ4YzdkZWQxNDQyNDg4MTNiYTBiNGJjZmMifSwidHlwZSI6WyJWZXJpZmlhYmxlQ3JlZGVudGlhbCJdfV0sInplcm9Qcm9vZiI6W1tdXX0=\",\"type\":\"Secp256r1\",\"verificationMethod\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827#keys-0\",\"vpDigest\":\"61975d8175b3cf3f7f9f316350d94bcd2e980eb7b2e66ddecc170ab43bbb5183\"},\"type\":[\"VerifiablePresentation\"],\"verifiableCredential\":[{\"context\":\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\",\"cptId\":1,\"credentialSubject\":{\"action\":\"setAge\",\"age\":\"0x7a5b0f3813c2bcd4a0b3e2c534aafdb4cf0337af1ad2bc308bd11c6aded91a3c\"},\"expirationDate\":\"2124-06-29T15:25:00+08:00\",\"id\":\"6aeea943a851ad83acae1e138c2edc67\",\"issuanceDate\":\"2024-12-18T10:51:47+08:00\",\"issuer\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827\",\"proof\":{\"created\":\"2024-12-18T10:51:47+08:00\",\"creator\":\"did:tdid:c11:0xe4e076689b11dcaa1118aef654791cca95c76827#keys-0\",\"metaDigest\":\"79ccefe237c9bf65d804747ca7f20ff9b985242e4e1e8634587bbebe07b51c45\",\"privacy\":\"Public\",\"salt\":{\"action\":\"XG9VA\",\"age\":\"0\"},\"signatureValue\":\"MEQCIHETsDrIpka838y4NHWU2S07+YwPRb3Mpwq8W5TLDNsNAiBUBFP0mb+eNpc5cTla15MxtIWGk0u8AAiTAHLjYbS2Mg==\",\"type\":\"Secp256r1\",\"vcDigest\":\"b8e185fdd623d09434460ceaae6dd5563411ed9d8c7ded144248813ba0b4bcfc\"},\"type\":[\"VerifiableCredential\"]}],\"zeroProof\":[[]]}", "member": "string", "name": "PresentationData", "required": false, @@ -1515,7 +1507,7 @@ { "disabled": false, "document": "验证返回码", - "example": "0", + "example": "1001", "member": "uint64", "name": "VerifyCode", "output_required": false, diff --git a/tccli/services/tdid/v20210519/examples.json b/tccli/services/tdid/v20210519/examples.json index 7edcb71919..b7aa8f343a 100644 --- a/tccli/services/tdid/v20210519/examples.json +++ b/tccli/services/tdid/v20210519/examples.json @@ -11,7 +11,7 @@ "CreatePresentation": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tdid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePresentation\n<公共请求参数>\n\n{\n \"DAPId\": 1,\n \"CredentialList\": [\n {\n \"Credential\": \"{\\\"cptId\\\":1,\\\"issuer\\\":\\\"did:tdid:w1:0x379106c7232aed1a50e8600511655b479c76b149\\\",\\\"expirationDate\\\":\\\"2124-06-29T15:25:00+08:00\\\",\\\"issuanceDate\\\":\\\"2023-11-30T05:19:40+08:00\\\",\\\"context\\\":\\\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\\\",\\\"id\\\":\\\"0767cc1f93ad541e195bd9f5f00d665f\\\",\\\"type\\\":[\\\"VerifiableCredential\\\"],\\\"credentialSubject\\\":{\\\"action\\\":\\\"deactiveDid\\\",\\\"age\\\":17},\\\"proof\\\":{\\\"created\\\":\\\"2023-11-30T05:19:40+08:00\\\",\\\"creator\\\":\\\"did:tdid:w1:0x379106c7232aed1a50e8600511655b479c76b149#keys-0\\\",\\\"signatureValue\\\":\\\"MEQCIEWnreXh0siSPnCaAqCldL1E+gTdrT6oSZjbTjAhwn6+AiBXn/ZIirpr69JknKsX3+MWRE7WeIXGdaOIXY10c36hoA==\\\",\\\"type\\\":\\\"Secp256r1\\\",\\\"metaDigest\\\":\\\"7d6435235cd5afdb7abd06a979eb2237d103401bdb54fa38ff6b8299c7529b76\\\",\\\"vcDigest\\\":\\\"d014b006648f48e13c1aff9c16a39979e3d17e6f32c816065158d6a92632a132\\\",\\\"privacy\\\":\\\"Public\\\",\\\"salt\\\":{\\\"action\\\":\\\"YuzFn\\\",\\\"age\\\":\\\"0zche\\\"}}}\"\n }\n ],\n \"Did\": \"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8\",\n \"VerifyCode\": \"test\",\n \"PolicyJson\": \"{\\\"1\\\":{\\\"age\\\":0}}\"\n}", + "input": "POST / HTTP/1.1\nHost: tdid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePresentation\n<公共请求参数>\n\n{\n \"DAPId\": 1,\n \"CredentialList\": [\n {\n \"Credential\": \"{\\\"cptId\\\":1,\\\"issuer\\\":\\\"did:tdid:w1:0x379106c7232aed1a50e8600511655b479c76b149\\\",\\\"expirationDate\\\":\\\"2124-06-29T15:25:00+08:00\\\",\\\"issuanceDate\\\":\\\"2023-11-30T05:19:40+08:00\\\",\\\"context\\\":\\\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\\\",\\\"id\\\":\\\"0767cc1f93ad541e195bd9f5f00d665f\\\",\\\"type\\\":[\\\"VerifiableCredential\\\"],\\\"credentialSubject\\\":{\\\"action\\\":\\\"deactiveDid\\\",\\\"age\\\":17},\\\"proof\\\":{\\\"created\\\":\\\"2023-11-30T05:19:40+08:00\\\",\\\"creator\\\":\\\"did:tdid:w1:0x379106c7232aed1a50e8600511655b479c76b149#keys-0\\\",\\\"signatureValue\\\":\\\"MEQCIEWnreXh0siSPnCaAqCldL1E+gTdrT6oSZjbTjAhwn6+AiBXn/ZIirpr69JknKsX3+MWRE7WeIXGdaOIXY10c36hoA==\\\",\\\"type\\\":\\\"Secp256r1\\\",\\\"metaDigest\\\":\\\"7d6435235cd5afdb7abd06a979eb2237d103401bdb54fa38ff6b8299c7529b76\\\",\\\"vcDigest\\\":\\\"d014b006648f48e13c1aff9c16a39979e3d17e6f32c816065158d6a92632a132\\\",\\\"privacy\\\":\\\"Public\\\",\\\"salt\\\":{\\\"action\\\":\\\"YuzFn\\\",\\\"age\\\":\\\"0zche\\\"}}}\"\n }\n ],\n \"Did\": \"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8\",\n \"VerifyCode\": \"1001\",\n \"PolicyJson\": \"{\\\"1\\\":{\\\"age\\\":0}}\"\n}", "output": "{\n \"Response\": {\n \"PresentationData\": \"{\\\"context\\\":[\\\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\\\"],\\\"holder\\\":\\\"did:tdid:c2:0x379106c7232aed1a50e8600511655b479c76b149\\\",\\\"proof\\\":{\\\"created\\\":\\\"2024-01-08T15:17:00+08:00\\\",\\\"nonce\\\":\\\"test\\\",\\\"signatureValue\\\":\\\"eyJjb250ZXh0IjpbImh0dHBzOi8vZ2l0aHViLmNvbS9UZW5jZW50Q2xvdWQtQmxvY2tjaGFpbi9URElEL2Jsb2IvbWFpbi9jb250ZXh0L3YxIl0sImhvbGRlciI6ImRpZDp0ZGlkOmMyOjB4Mzc5MTA2YzcyMzJhZWQxYTUwZTg2MDA1MTE2NTViNDc5Yzc2YjE0OSIsInR5cGUiOlsiVmVyaWZpYWJsZVByZXNlbnRhdGlvbiJdLCJ2ZXJpZmlhYmxlQ3JlZGVudGlhbCI6W3siY29udGV4dCI6Imh0dHBzOi8vZ2l0aHViLmNvbS9UZW5jZW50Q2xvdWQtQmxvY2tjaGFpbi9URElEL2Jsb2IvbWFpbi9jb250ZXh0L3YxIiwiY3B0SWQiOjEsImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImFjdGlvbiI6ImRlYWN0aXZlRGlkIiwiYWdlIjoiMHg5NzUwNWE0ODY0NzM0NzBlNTBkMTM3MzIzMTM3ZGE4NTE3M2Y5OGU4MzQ0MGEzYjhjMWE3M2Q2ZDI0YWRiNmZlIn0sImV4cGlyYXRpb25EYXRlIjoiMjEyNC0wNi0yOVQxNToyNTowMCswODowMCIsImlkIjoiOGNmZTc1ZjFlMjlkOTk4ZWRhZGI5NjFlMTQxMDEyOWUiLCJpc3N1YW5jZURhdGUiOiIyMDI0LTAxLTA4VDEwOjM3OjU0KzA4OjAwIiwiaXNzdWVyIjoiZGlkOnRkaWQ6YzI6MHgzNzkxMDZjNzIzMmFlZDFhNTBlODYwMDUxMTY1NWI0NzljNzZiMTQ5IiwicHJvb2YiOnsiY3JlYXRlZCI6IjIwMjQtMDEtMDhUMTA6Mzc6NTQrMDg6MDAiLCJjcmVhdG9yIjoiZGlkOnRkaWQ6YzI6MHgzNzkxMDZjNzIzMmFlZDFhNTBlODYwMDUxMTY1NWI0NzljNzZiMTQ5I2tleXMtMCIsIm1ldGFEaWdlc3QiOiJiNGE2ODVjMzQ0ZGViMjg1Y2IwMTFiYzhiNmI3Mjg3NzhmYmU0NmNhOWZhYTE4OGNlYTZkYmM5YzM2ZDNiZDFiIiwicHJpdmFjeSI6IlB1YmxpYyIsInNhbHQiOnsiYWN0aW9uIjoieDZQMG4iLCJhZ2UiOiIwIn0sInNpZ25hdHVyZVZhbHVlIjoiTUVVQ0lFWEJkd2tHRi85UXpkdDRPRzlHS2cyRUJEb1hFOTAySGNFdlVndXMvbTZ3QWlFQW1NU3lRS0F1SUZvYmI4cTNDWkJTRmdBczhZL09WdEMwNTN0VVJTRk5SREk9IiwidHlwZSI6IlNlY3AyNTZyMSIsInZjRGlnZXN0IjoiMmRkNWExZGMzMjQ2ODZjOTNhNWIxNTgyMDZkNWZlOGI5MzdhMWZlNjQ3NjA5ODNkNWY1OWIyMzcxY2RlYjA5NSJ9LCJ0eXBlIjpbIlZlcmlmaWFibGVDcmVkZW50aWFsIl19XX0=\\\",\\\"type\\\":\\\"Secp256r1\\\",\\\"verificationMethod\\\":\\\"did:tdid:c2:0x379106c7232aed1a50e8600511655b479c76b149#keys-0\\\",\\\"vpDigest\\\":\\\"6728c750e86b1b793878c2a281bbebbe8d08b06a9266c1588ef841c6b3768475\\\"},\\\"type\\\":[\\\"VerifiablePresentation\\\"],\\\"verifiableCredential\\\":[{\\\"context\\\":\\\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\\\",\\\"cptId\\\":1,\\\"credentialSubject\\\":{\\\"action\\\":\\\"deactiveDid\\\",\\\"age\\\":\\\"0x97505a486473470e50d137323137da85173f98e83440a3b8c1a73d6d24adb6fe\\\"},\\\"expirationDate\\\":\\\"2124-06-29T15:25:00+08:00\\\",\\\"id\\\":\\\"8cfe75f1e29d998edadb961e1410129e\\\",\\\"issuanceDate\\\":\\\"2024-01-08T10:37:54+08:00\\\",\\\"issuer\\\":\\\"did:tdid:c2:0x379106c7232aed1a50e8600511655b479c76b149\\\",\\\"proof\\\":{\\\"created\\\":\\\"2024-01-08T10:37:54+08:00\\\",\\\"creator\\\":\\\"did:tdid:c2:0x379106c7232aed1a50e8600511655b479c76b149#keys-0\\\",\\\"metaDigest\\\":\\\"b4a685c344deb285cb011bc8b6b728778fbe46ca9faa188cea6dbc9c36d3bd1b\\\",\\\"privacy\\\":\\\"Public\\\",\\\"salt\\\":{\\\"action\\\":\\\"x6P0n\\\",\\\"age\\\":\\\"0\\\"},\\\"signatureValue\\\":\\\"MEUCIEXBdwkGF/9Qzdt4OG9GKg2EBDoXE902HcEvUgus/m6wAiEAmMSyQKAuIFobb8q3CZBSFgAs8Y/OVtC053tURSFNRDI=\\\",\\\"type\\\":\\\"Secp256r1\\\",\\\"vcDigest\\\":\\\"2dd5a1dc324686c93a5b158206d5fe8b937a1fe64760983d5f59b2371cdeb095\\\"},\\\"type\\\":[\\\"VerifiableCredential\\\"]}]}\",\n \"RequestId\": \"52163044-3cd1-4ca9-8963-a36ac5554364\"\n }\n}", "title": "创建可验证表达" } @@ -99,8 +99,8 @@ "QueryAuthorityInfo": [ { "document": "查询权威机构信息", - "input": "POST / HTTP/1.1\nHost: tdid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: QueryAuthorityInfo\n<公共请求参数>\n\n{\n \"Did\": \"did:tdid:w1:0xbbf1dee9e082e1a54dd3973beedc59ff7e452862\",\n \"DAPId\": 5,\n \"Name\": \"test\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"3d5e7818-5027-44ca-bb03-68a9d5389bca\",\n \"Did\": \"did:tdid:w1:0xbbf1dee9e082e1a54dd3973beedc59ff7e452862\",\n \"Name\": \"test\",\n \"Status\": 1,\n \"Description\": \"test\",\n \"RecognizeTime\": \"2023-09-19 11:54:25\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tdid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: QueryAuthorityInfo\n<公共请求参数>\n\n{\n \"Did\": \"did:tdid:w1:0xbbf1dee9e082e1a54dd3973beedc59ff7e452862\",\n \"DAPId\": 5,\n \"Name\": \"某教育学院\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"3d5e7818-5027-44ca-bb03-68a9d5389bca\",\n \"Did\": \"did:tdid:w1:0xbbf1dee9e082e1a54dd3973beedc59ff7e452862\",\n \"Name\": \"某教育学院\",\n \"Status\": 1,\n \"Description\": \"职业教育\",\n \"RecognizeTime\": \"2023-09-19 11:54:25\"\n }\n}", "title": "查询权威机构信息" } ], @@ -115,7 +115,7 @@ "SetTDidAttribute": [ { "document": "设置DID的自定义属性", - "input": "POST / HTTP/1.1\nHost: tdid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetTDidAttribute\n<公共请求参数>\n\n{\n \"Did\": \"did:tdid:w1:0x0d342759f20005df531c50f671d414661e381c01\",\n \"Attributes\": [\n {\n \"Key\": \"test\",\n \"Val\": \"test\"\n }\n ],\n \"DAPId\": 5\n}", + "input": "POST / HTTP/1.1\nHost: tdid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetTDidAttribute\n<公共请求参数>\n\n{\n \"Did\": \"did:tdid:w1:0x0d342759f20005df531c50f671d414661e381c01\",\n \"Attributes\": [\n {\n \"Key\": \"name\",\n \"Val\": \"张三\"\n }\n ],\n \"DAPId\": 5\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"0f7de9d2-2a60-46b1-97c3-62331ddf12ec\",\n \"Transaction\": {\n \"TransactionHash\": \"17864b02e92bea49ca4707214f59ac99910fecf8bfa8434380bb62471a09e61a\"\n }\n }\n}", "title": "设置DID的自定义属性" } @@ -139,7 +139,7 @@ "VerifyPresentation": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tdid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: VerifyPresentation\n<公共请求参数>\n\n{\n \"Did\": \"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8\",\n \"PresentationData\": \"{\\\"context\\\":[\\\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\\\"],\\\"holder\\\":\\\"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8\\\",\\\"proof\\\":{\\\"created\\\":\\\"2023-09-12T16:14:56+08:00\\\",\\\"nonce\\\":\\\"test\\\",\\\"signatureValue\\\":\\\"MEYCIQC4Wmf0NTlNF9BOjyynLasqWQJF4M34oIiemCa2Jl6+1wIhANqKc4/sWbuQmcpp7ilNrpfZQU4Cj0+VqcQcN+/jZH5u\\\",\\\"type\\\":\\\"Secp256r1\\\",\\\"verificationMethod\\\":\\\"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8#keys-0\\\"},\\\"type\\\":[\\\"VerifiablePresentation\\\"],\\\"verifiableCredential\\\":[{\\\"context\\\":\\\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\\\",\\\"cptId\\\":1,\\\"credentialSubject\\\":{\\\"action\\\":\\\"deactiveDid\\\",\\\"age\\\":\\\"0x7cc931132828080cac176a6bf266077bc963d3a8d4afacb147eb7a5fa9d38176\\\",\\\"ageCommitment\\\":\\\"/nQps1EGGKMJEEIZhlNu9oFZWTSe6bR5e2w71+/JSgE=\\\"},\\\"expirationDate\\\":\\\"2024-06-29T15:25:00+08:00\\\",\\\"id\\\":\\\"0971a8c6a1ff17d9b85abaab5e02c50d\\\",\\\"issuanceDate\\\":\\\"2023-09-12T15:50:52+08:00\\\",\\\"issuer\\\":\\\"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8\\\",\\\"proof\\\":{\\\"created\\\":\\\"2023-09-12T15:50:52+08:00\\\",\\\"creator\\\":\\\"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8#keys-0\\\",\\\"metaDigest\\\":\\\"da11a3571b4920ebdac1b73b03c696606a3b1c380e6502bcb30484d8240ae28d\\\",\\\"privacy\\\":\\\"Public\\\",\\\"salt\\\":{\\\"action\\\":\\\"0UU2V\\\",\\\"age\\\":\\\"0\\\",\\\"ageCommitment\\\":\\\"XiqAq\\\"},\\\"signatureValue\\\":\\\"MEQCIHGw37fwROCoqUEz9Rtw2CG3pQP6QYxe2byS45LIlPBmAiBrS93DNqRtVYKUq8dZ4ZUTSgt9Ajr9rzqLB3KZz9ADIg==\\\",\\\"type\\\":\\\"Secp256r1\\\",\\\"vcDigest\\\":\\\"230653978a8dc2c16f6acfa7bfb779a34d282fb7fd2eae5646c9e3ba95589344\\\"},\\\"type\\\":[\\\"VerifiableCredential\\\"]}]}\",\n \"DAPId\": 1,\n \"VerifyCode\": \"test\"\n}", + "input": "POST / HTTP/1.1\nHost: tdid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: VerifyPresentation\n<公共请求参数>\n\n{\n \"Did\": \"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8\",\n \"PresentationData\": \"{\\\"context\\\":[\\\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\\\"],\\\"holder\\\":\\\"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8\\\",\\\"proof\\\":{\\\"created\\\":\\\"2023-09-12T16:14:56+08:00\\\",\\\"nonce\\\":\\\"test\\\",\\\"signatureValue\\\":\\\"MEYCIQC4Wmf0NTlNF9BOjyynLasqWQJF4M34oIiemCa2Jl6+1wIhANqKc4/sWbuQmcpp7ilNrpfZQU4Cj0+VqcQcN+/jZH5u\\\",\\\"type\\\":\\\"Secp256r1\\\",\\\"verificationMethod\\\":\\\"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8#keys-0\\\"},\\\"type\\\":[\\\"VerifiablePresentation\\\"],\\\"verifiableCredential\\\":[{\\\"context\\\":\\\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\\\",\\\"cptId\\\":1,\\\"credentialSubject\\\":{\\\"action\\\":\\\"deactiveDid\\\",\\\"age\\\":\\\"0x7cc931132828080cac176a6bf266077bc963d3a8d4afacb147eb7a5fa9d38176\\\",\\\"ageCommitment\\\":\\\"/nQps1EGGKMJEEIZhlNu9oFZWTSe6bR5e2w71+/JSgE=\\\"},\\\"expirationDate\\\":\\\"2024-06-29T15:25:00+08:00\\\",\\\"id\\\":\\\"0971a8c6a1ff17d9b85abaab5e02c50d\\\",\\\"issuanceDate\\\":\\\"2023-09-12T15:50:52+08:00\\\",\\\"issuer\\\":\\\"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8\\\",\\\"proof\\\":{\\\"created\\\":\\\"2023-09-12T15:50:52+08:00\\\",\\\"creator\\\":\\\"did:tdid:w1:0xc1f030ceeb858887f0cc400030d59534cf8098c8#keys-0\\\",\\\"metaDigest\\\":\\\"da11a3571b4920ebdac1b73b03c696606a3b1c380e6502bcb30484d8240ae28d\\\",\\\"privacy\\\":\\\"Public\\\",\\\"salt\\\":{\\\"action\\\":\\\"0UU2V\\\",\\\"age\\\":\\\"0\\\",\\\"ageCommitment\\\":\\\"XiqAq\\\"},\\\"signatureValue\\\":\\\"MEQCIHGw37fwROCoqUEz9Rtw2CG3pQP6QYxe2byS45LIlPBmAiBrS93DNqRtVYKUq8dZ4ZUTSgt9Ajr9rzqLB3KZz9ADIg==\\\",\\\"type\\\":\\\"Secp256r1\\\",\\\"vcDigest\\\":\\\"230653978a8dc2c16f6acfa7bfb779a34d282fb7fd2eae5646c9e3ba95589344\\\"},\\\"type\\\":[\\\"VerifiableCredential\\\"]}]}\",\n \"DAPId\": 1,\n \"VerifyCode\": \"1001\"\n}", "output": "{\n \"Response\": {\n \"Result\": true,\n \"VerifyCode\": 0,\n \"VerifyMessage\": \"success\",\n \"RequestId\": \"1b5c5ee5-a049-4137-8ca1-f4337a614d91\"\n }\n}", "title": "验证可验证凭证表达" } diff --git a/tccli/services/trocket/v20230308/api.json b/tccli/services/trocket/v20230308/api.json index d4c12b0919..d3be1c60b1 100644 --- a/tccli/services/trocket/v20230308/api.json +++ b/tccli/services/trocket/v20230308/api.json @@ -5738,7 +5738,7 @@ { "disabled": false, "document": "Access Key", - "example": "ak-xxx", + "example": "ak54jmdkpmao909550a62asd", "member": "string", "name": "AccessKey", "output_required": true, @@ -5749,7 +5749,7 @@ { "disabled": false, "document": "Secret Key", - "example": "sk-xxx", + "example": "skc955042d5a678asd", "member": "string", "name": "SecretKey", "output_required": true, @@ -5760,7 +5760,7 @@ { "disabled": false, "document": "备注信息", - "example": "测试角色", + "example": "remark info", "member": "string", "name": "Remark", "output_required": true, diff --git a/tccli/services/vpc/v20170312/api.json b/tccli/services/vpc/v20170312/api.json index 28b6019dd7..d0957b823b 100644 --- a/tccli/services/vpc/v20170312/api.json +++ b/tccli/services/vpc/v20170312/api.json @@ -10650,7 +10650,7 @@ { "disabled": false, "document": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", - "example": "无", + "example": "{'Period':1, 'RenewFlag': 'NOTIFY_AND_AUTO_RENEW'}", "member": "InstanceChargePrepaid", "name": "InstanceChargePrepaid", "required": false, @@ -10677,7 +10677,7 @@ { "disabled": false, "document": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", - "example": "无", + "example": "[{\"Key\": \"name\", \"Value\": \"123\"}]", "member": "Tag", "name": "Tags", "required": false, @@ -10700,6 +10700,15 @@ "name": "MaxConnection", "required": false, "type": "int" + }, + { + "disabled": false, + "document": "BGP ASN。", + "example": "2", + "member": "uint64", + "name": "BgpAsn", + "required": false, + "type": "int" } ], "type": "object" @@ -35744,7 +35753,7 @@ { "disabled": false, "document": "网关带宽配额信息。", - "example": "null", + "example": "[{'Bandwidth': 5, 'Cname': '微小型', 'Name': 'cdmini'}, {'Bandwidth': 10, 'Cname': '小型', 'Name': 'cdsmall'}, {'Bandwidth': 20, 'Cname': '中型', 'Name': 'cdmiddle'}, {'Bandwidth': 50, 'Cname': '大型', 'Name': 'cdlarge'}, {'Bandwidth': 100, 'Cname': '超大型', 'Name': 'cdsuperLarge'}]", "member": "VpnGatewayQuota", "name": "VpnGatewayQuotaSet", "output_required": true, @@ -35790,6 +35799,16 @@ "output_required": true, "type": "int", "value_allowed_null": false + }, + { + "disabled": false, + "document": "Bgp ASN", + "example": "61413", + "member": "uint64", + "name": "BgpAsn", + "output_required": false, + "type": "int", + "value_allowed_null": false } ], "usage": "out" diff --git a/tccli/services/vpc/v20170312/examples.json b/tccli/services/vpc/v20170312/examples.json index 056d5f83b9..d7640b0b8a 100644 --- a/tccli/services/vpc/v20170312/examples.json +++ b/tccli/services/vpc/v20170312/examples.json @@ -756,7 +756,7 @@ { "document": "创建VPNGW", "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateVpnGateway\n<公共请求参数>\n\n{\n \"VpnGatewayName\": \"\\\"test\\\"\",\n \"VpcId\": \"\\\"vpc-xxxx\\\"\",\n \"InstanceChargeType\": \"\\\"POSTPAID_BY_HOUR\\\"\",\n \"InternetMaxBandwidthOut\": 5\n}", - "output": "{\n \"Response\": {\n \"VpnGateway\": {\n \"VpnGatewayQuotaSet\": [],\n \"MaxConnection\": 5,\n \"VpcId\": \"vpc-test\",\n \"RenewFlag\": \"\",\n \"Zone\": \"ap-bangkok-1\",\n \"VpnGatewayName\": \"test\",\n \"InstanceChargeType\": \"POSTPAID_BY_HOUR\",\n \"CdcId\": \"\",\n \"IsAddressBlocked\": true,\n \"InternetMaxBandwidthOut\": 10,\n \"State\": \"Pending\",\n \"Version\": \"\",\n \"VpnGatewayId\": \"vpngw-xxxxx\",\n \"PublicIpAddress\": \"12.3.1.3\",\n \"CreatedTime\": \"2020-09-22 00:00:00\",\n \"NewPurchasePlan\": \"\",\n \"ExpiredTime\": \"2020-09-22 00:00:00\",\n \"Type\": \"IPSEC\",\n \"NetworkInstanceId\": \"\",\n \"RestrictState\": \"NORMAL\"\n },\n \"RequestId\": \"fa15cd12-e329-1261-c585-3c3ae5c55211\"\n }\n}", + "output": "{\n \"Response\": {\n \"VpnGateway\": {\n \"VpnGatewayId\": \"vpngw-awdawc\",\n \"VpcId\": \"vpc-adxczc\",\n \"VpnGatewayName\": \"vpn-name\",\n \"Type\": \"IPSEC\",\n \"State\": \"Pending\",\n \"PublicIpAddress\": \"13.15.41.4\",\n \"RenewFlag\": \"\",\n \"InstanceChargeType\": \"POSTPAID_BY_HOUR\",\n \"InternetMaxBandwidthOut\": 10,\n \"CreatedTime\": \"2020-09-22 00:00:00\",\n \"ExpiredTime\": \"2020-09-22 00:00:00\",\n \"IsAddressBlocked\": false,\n \"NewPurchasePlan\": \"\",\n \"RestrictState\": \"NORMAL\",\n \"Zone\": \"\",\n \"VpnGatewayQuotaSet\": [\n {\n \"Bandwidth\": 5,\n \"Cname\": \"微小型\",\n \"Name\": \"cdmini\"\n }\n ],\n \"Version\": \"ver3.1\",\n \"NetworkInstanceId\": \"\",\n \"CdcId\": \"\",\n \"MaxConnection\": 10\n },\n \"RequestId\": \"b2187525-ab9d-42cb-82ee-998ead365bbe\"\n }\n}", "title": "创建VPNGW" } ], diff --git a/tccli/services/vrs/v20200824/api.json b/tccli/services/vrs/v20200824/api.json index c1016ef628..2097e973f4 100644 --- a/tccli/services/vrs/v20200824/api.json +++ b/tccli/services/vrs/v20200824/api.json @@ -15,7 +15,7 @@ "status": "online" }, "DescribeVRSTaskStatus": { - "document": "在调用声音复刻创建任务请求接口后，有回调和轮询两种方式获取识别结果。\n• 当采用回调方式时，识别完成后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL，具体请参见 声音复刻结果回调 。\n• 当采用轮询方式时，需要主动提交任务ID来轮询识别结果，共有任务成功、等待、执行中和失败四种结果，具体信息请参见下文说明。\n• 请求方法为 HTTP POST , Content-Type为\"application/json; charset=utf-8\"\n• 签名方法参考 公共参数 中签名方法v3。", + "document": "在调用声音复刻创建任务请求接口后，有回调和轮询两种方式获取识别结果。（注意：回调方式目前仅支持轻量版声音复刻）\n• 当采用回调方式时，识别完成后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL，具体请参见 [“声音复刻任务创建接口”](https://cloud.tencent.com/document/product/1283/90064) CallbackUrl参数说明 。\n• 当采用轮询方式时，需要主动提交任务ID来轮询识别结果，共有任务成功、等待、执行中和失败四种结果，具体信息请参见下文说明。\n• 请求方法为 HTTP POST , Content-Type为\"application/json; charset=utf-8\"\n• 签名方法参考 公共参数 中签名方法v3。", "input": "DescribeVRSTaskStatusRequest", "name": "声音复刻任务结果查询接口", "output": "DescribeVRSTaskStatusResponse", @@ -173,7 +173,7 @@ }, { "disabled": false, - "document": "回调 URL，用户自行搭建的用于接收结果的服务URL。如果用户使用轮询方式获取识别结果，则无需提交该参数。\n回调采用POST请求方式，Content-Type为application/json，回调数据格式如下:{\"TaskId\":\"xxxxxxxxxxxxxx\",\"Status\":2,\"StatusStr\":\"success\",\"VoiceType\":xxxxx,\"ErrorMsg\":\"\"}", + "document": "回调 URL，用户自行搭建的用于接收结果的服务URL。如果用户使用轮询方式获取识别结果，则无需提交该参数。（注意：回调方式目前仅支持轻量版声音复刻）\n回调采用POST请求方式，Content-Type为application/json，回调数据格式如下:{\"TaskId\":\"xxxxxxxxxxxxxx\",\"Status\":2,\"StatusStr\":\"success\",\"VoiceType\":xxxxx,\"ErrorMsg\":\"\"}", "example": "无", "member": "string", "name": "CallbackUrl", @@ -348,6 +348,7 @@ "example": "无", "member": "DescribeVRSTaskStatusRespData", "name": "Data", + "output_required": true, "type": "object", "value_allowed_null": false }, diff --git a/tccli/services/wedata/v20210820/api.json b/tccli/services/wedata/v20210820/api.json index 224981bee3..09c2fb3911 100644 --- a/tccli/services/wedata/v20210820/api.json +++ b/tccli/services/wedata/v20210820/api.json @@ -1529,7 +1529,7 @@ "RunForceSucScheduleInstances": { "document": "实例批量置成功", "input": "RunForceSucScheduleInstancesRequest", - "name": "实例运维-实例批量置成功", + "name": "实例运维-实例批量置成功1", "output": "RunForceSucScheduleInstancesResponse", "status": "online" }, @@ -4127,7 +4127,7 @@ "example": "无", "member": "bool", "name": "Result", - "required": false, + "output_required": true, "type": "bool", "value_allowed_null": true }, @@ -4137,7 +4137,7 @@ "example": "无", "member": "string", "name": "ErrorId", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -4147,7 +4147,17 @@ "example": "无", "member": "string", "name": "ErrorDesc", - "required": false, + "output_required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "异步操作id\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "AsyncActionId", + "output_required": false, "type": "string", "value_allowed_null": true } @@ -4186,6 +4196,16 @@ "output_required": true, "type": "int", "value_allowed_null": true + }, + { + "disabled": false, + "document": "异步操作记录的唯一id\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "111222", + "member": "string", + "name": "AsyncActionId", + "output_required": false, + "type": "string", + "value_allowed_null": true } ], "usage": "out" @@ -4778,6 +4798,15 @@ "name": "KillInstance", "required": false, "type": "bool" + }, + { + "disabled": false, + "document": "是否异步模式", + "example": "true", + "member": "bool", + "name": "AsyncMode", + "required": false, + "type": "bool" } ], "type": "object" @@ -4833,6 +4862,15 @@ "name": "KillInstance", "required": false, "type": "bool" + }, + { + "disabled": false, + "document": "是否异步模式", + "example": "false", + "member": "bool", + "name": "AsyncMode", + "required": false, + "type": "bool" } ], "type": "object" @@ -7045,6 +7083,15 @@ "name": "ProjectId", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "函数资源文件类型", + "example": "JAR\\PYTHON", + "member": "string", + "name": "FunctionResourceFileType", + "required": false, + "type": "string" } ], "type": "object" @@ -7500,6 +7547,15 @@ "name": "SchemaName", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "是否异步建表", + "example": "false", + "member": "bool", + "name": "Async", + "required": false, + "type": "bool" } ], "type": "object" @@ -7509,14 +7565,24 @@ "members": [ { "disabled": false, - "document": "表名称", - "example": "\"true\"", + "document": "返回表名称，无论是否异步都有值", + "example": "\"tablename\"", "member": "string", "name": "Data", "output_required": true, "type": "string", "value_allowed_null": false }, + { + "disabled": false, + "document": "异步任务轮询 id，只有异步才有值", + "example": "\"25\"", + "member": "string", + "name": "TaskId", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, { "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。", "member": "string", @@ -7861,6 +7927,15 @@ "name": "TaskMode", "required": true, "type": "string" + }, + { + "disabled": false, + "document": "导入编排空间配置", + "example": "{\"IsImport\": false}", + "member": "TaskImportInfo", + "name": "TaskImportInfo", + "required": false, + "type": "object" } ], "type": "object" @@ -7878,6 +7953,16 @@ "type": "string", "value_allowed_null": true }, + { + "disabled": false, + "document": "导入到编排空间的任务id\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "20220411181355382", + "member": "string", + "name": "ArrangeSpaceTaskId", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, { "disabled": false, "document": "结果", @@ -14021,6 +14106,24 @@ "name": "IncludeTaskFolder", "required": false, "type": "bool" + }, + { + "disabled": false, + "document": "是否使用最新模式展示目录树", + "example": "false", + "member": "bool", + "name": "NewFolderTreeMode", + "required": false, + "type": "bool" + }, + { + "disabled": false, + "document": "节点分类ID", + "example": "aaa_DLC", + "member": "string", + "name": "TaskNodeId", + "required": false, + "type": "string" } ], "type": "object" @@ -14094,6 +14197,15 @@ "name": "DisplayType", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "是否新模式展示目录树", + "example": "true", + "member": "bool", + "name": "NewFolderTreeMode", + "required": false, + "type": "bool" } ], "type": "object" @@ -16476,6 +16588,15 @@ "name": "RequestResourceTypes", "required": false, "type": "list" + }, + { + "disabled": false, + "document": "项目ID列表", + "example": "无", + "member": "string", + "name": "ProjectIds", + "required": false, + "type": "list" } ], "type": "object" @@ -16651,6 +16772,15 @@ "required": true, "type": "string" }, + { + "disabled": false, + "document": "实例状态过滤条件", + "example": "[1,2]", + "member": "int64", + "name": "StateList", + "required": false, + "type": "list" + }, { "disabled": false, "document": "分页页码，默认值1", @@ -16786,6 +16916,24 @@ "name": "MaxCreateTime", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "实例状态过滤条件", + "example": "[1,2]", + "member": "int64", + "name": "StateList", + "required": false, + "type": "list" + }, + { + "disabled": false, + "document": "模糊查询关键字", + "example": "\"20230908070102098\"", + "member": "string", + "name": "Keyword", + "required": false, + "type": "string" } ], "type": "object" @@ -16931,6 +17079,15 @@ "name": "SortType", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "项目ID列表，用于多项目工作流筛选", + "example": "无", + "member": "string", + "name": "ProjectIds", + "required": false, + "type": "list" } ], "type": "object" @@ -19081,6 +19238,15 @@ "name": "WorkflowId", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "任务ID列表", + "example": "无", + "member": "string", + "name": "ProjectIds", + "required": false, + "type": "list" } ], "type": "object" @@ -19199,6 +19365,15 @@ "name": "SortType", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "项目ID列表，如果传了 ProjectIds，则 ProjectId 不会生效，用于多项目筛选", + "example": "无", + "member": "string", + "name": "ProjectIds", + "required": false, + "type": "list" } ], "type": "object" @@ -19272,6 +19447,24 @@ "name": "WorkflowId", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "项目ID列表，如果传了 ProjectIds ，ProjectId 不会生效", + "example": "无", + "member": "string", + "name": "ProjectIds", + "required": false, + "type": "list" + }, + { + "disabled": false, + "document": "资源组ID筛选", + "example": "无", + "member": "string", + "name": "ResourceGroupIds", + "required": false, + "type": "list" } ], "type": "object" @@ -19472,6 +19665,24 @@ "name": "WorkflowId", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "项目ID列表，用于多项目实例趋势筛选，当指定了 ProjectIds 的时候，ProjectId 将只用来鉴权，不做筛选", + "example": "无", + "member": "string", + "name": "ProjectIds", + "required": false, + "type": "list" + }, + { + "disabled": false, + "document": "指定时间点，当统计时常为整天的时候使用，必须小于 24", + "example": "无", + "member": "uint64", + "name": "TimePoint", + "required": false, + "type": "int" } ], "type": "object" @@ -20709,6 +20920,33 @@ "name": "WorkflowId", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "项目ID列表筛选", + "example": "1", + "member": "string", + "name": "ProjectIds", + "required": false, + "type": "list" + }, + { + "disabled": false, + "document": "资源组ID列表筛选", + "example": "1", + "member": "string", + "name": "ResourceGroupIds", + "required": false, + "type": "list" + }, + { + "disabled": false, + "document": "任务类型ID筛选", + "example": "1", + "member": "string", + "name": "TaskTypeIdList", + "required": false, + "type": "list" } ], "type": "object" @@ -20836,6 +21074,15 @@ "name": "WorkflowId", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "项目ID列表，用于多项目实例趋势筛选，当指定了 ProjectIds 的时候，ProjectId 将只用来鉴权，不做筛选", + "example": "无", + "member": "string", + "name": "ProjectIds", + "required": false, + "type": "list" } ], "type": "object" @@ -24007,6 +24254,15 @@ "name": "KillInstance", "required": false, "type": "bool" + }, + { + "disabled": false, + "document": "是否异步模式", + "example": "false", + "member": "bool", + "name": "AsyncMode", + "required": false, + "type": "bool" } ], "type": "object" @@ -27974,6 +28230,39 @@ "required": false, "type": "int", "value_allowed_null": true + }, + { + "disabled": false, + "document": "导入到编排空间配置\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "TaskImportInfo", + "name": "TaskImportInfo", + "output_required": false, + "required": false, + "type": "object", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "业务延迟\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "1000", + "member": "int64", + "name": "BusinessLatency", + "output_required": false, + "required": false, + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "当前同步位点\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "170000010000", + "member": "int64", + "name": "CurrentSyncPosition", + "output_required": false, + "required": false, + "type": "int", + "value_allowed_null": true } ], "usage": "both" @@ -28043,6 +28332,24 @@ "name": "PlanId", "required": true, "type": "string" + }, + { + "disabled": false, + "document": "是否异步模式", + "example": "true", + "member": "bool", + "name": "AsyncMode", + "required": false, + "type": "bool" + }, + { + "disabled": false, + "document": "补录计划名", + "example": "patch_20241114125640_486", + "member": "string", + "name": "PlanName", + "required": false, + "type": "string" } ], "type": "object" @@ -28233,6 +28540,15 @@ "name": "IsCount", "required": false, "type": "bool" + }, + { + "disabled": false, + "document": "是否异步模式", + "example": "true", + "member": "bool", + "name": "AsyncMode", + "required": false, + "type": "bool" } ], "type": "object" @@ -28639,7 +28955,7 @@ "example": "无", "member": "string", "name": "PlanId", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28649,7 +28965,7 @@ "example": "无", "member": "string", "name": "MakeName", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28659,7 +28975,7 @@ "example": "无", "member": "string", "name": "ProjectId", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28669,7 +28985,7 @@ "example": "无", "member": "bool", "name": "CheckParent", - "required": false, + "output_required": true, "type": "bool", "value_allowed_null": true }, @@ -28679,7 +28995,7 @@ "example": "无", "member": "bool", "name": "SameSelfDependType", - "required": false, + "output_required": true, "type": "bool", "value_allowed_null": true }, @@ -28689,7 +29005,7 @@ "example": "无", "member": "int64", "name": "ParallelNum", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -28699,7 +29015,7 @@ "example": "无", "member": "bool", "name": "SameCycle", - "required": false, + "output_required": true, "type": "bool", "value_allowed_null": true }, @@ -28709,7 +29025,7 @@ "example": "无", "member": "string", "name": "SourceTaskCycle", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28719,7 +29035,7 @@ "example": "无", "member": "string", "name": "TargetTaskCycle", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28729,7 +29045,7 @@ "example": "无", "member": "int64", "name": "TargetTaskAction", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -28739,7 +29055,7 @@ "example": "无", "member": "StrToStrMap", "name": "MapParamList", - "required": false, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -28749,7 +29065,7 @@ "example": "无", "member": "string", "name": "CreatorId", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28759,7 +29075,7 @@ "example": "无", "member": "string", "name": "Creator", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28769,7 +29085,7 @@ "example": "无", "member": "string", "name": "CreateTime", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28779,7 +29095,7 @@ "example": "无", "member": "string", "name": "TaskIdList", - "required": false, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -28789,7 +29105,7 @@ "example": "无", "member": "CreateMakeDatetimeInfo", "name": "MakeDatetimeList", - "required": false, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -28799,7 +29115,7 @@ "example": "无", "member": "string", "name": "Remark", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28809,7 +29125,7 @@ "example": "无", "member": "string", "name": "SchedulerResourceGroup", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28819,7 +29135,7 @@ "example": "无", "member": "string", "name": "SchedulerResourceGroupName", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28829,7 +29145,7 @@ "example": "无", "member": "string", "name": "IntegrationResourceGroup", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28839,7 +29155,7 @@ "example": "无", "member": "string", "name": "IntegrationResourceGroupName", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -28849,7 +29165,7 @@ "example": "无", "member": "int64", "name": "TaskCount", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -28859,7 +29175,7 @@ "example": "无", "member": "int64", "name": "CompletePercent", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -28869,7 +29185,7 @@ "example": "无", "member": "int64", "name": "SuccessPercent", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -28879,7 +29195,27 @@ "example": "无", "member": "string", "name": "CheckParentType", - "required": false, + "output_required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "是否和原任务保持相同工作流自依赖属性\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "bool", + "name": "SameSelfWorkflowDependType", + "output_required": true, + "type": "bool", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "工作流自依赖类型\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "yes/no", + "member": "string", + "name": "SelfWorkflowDependency", + "output_required": false, "type": "string", "value_allowed_null": true } @@ -31654,7 +31990,7 @@ "example": "true", "member": "bool", "name": "Result", - "required": false, + "output_required": true, "type": "bool", "value_allowed_null": true }, @@ -31664,7 +32000,7 @@ "example": "无", "member": "string", "name": "ResultMsg", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -31674,7 +32010,7 @@ "example": "无", "member": "string", "name": "ErrorId", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -31684,9 +32020,19 @@ "example": "无", "member": "string", "name": "ErrorDesc", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "异步操作记录id", + "example": "无", + "member": "string", + "name": "AsyncActionId", + "output_required": false, + "type": "string", + "value_allowed_null": false } ], "usage": "out" @@ -37227,6 +37573,15 @@ "name": "IsCount", "required": false, "type": "bool" + }, + { + "disabled": false, + "document": "是否异步模式", + "example": "true", + "member": "bool", + "name": "AsyncMode", + "required": false, + "type": "bool" } ], "type": "object" @@ -37417,6 +37772,15 @@ "name": "IsCount", "required": false, "type": "bool" + }, + { + "disabled": false, + "document": "是否异步模式", + "example": "true", + "member": "bool", + "name": "AsyncMode", + "required": false, + "type": "bool" } ], "type": "object" @@ -37580,6 +37944,26 @@ "output_required": false, "type": "int", "value_allowed_null": true + }, + { + "disabled": false, + "document": "项目ID\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "ProjectId", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "项目名称\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "string", + "name": "ProjectName", + "output_required": false, + "type": "string", + "value_allowed_null": true } ], "usage": "out" @@ -37818,6 +38202,7 @@ "example": "0", "member": "uint64", "name": "CountTag", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37828,6 +38213,7 @@ "example": "2", "member": "uint64", "name": "TotalNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37838,6 +38224,7 @@ "example": "12", "member": "uint64", "name": "RunningNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37848,6 +38235,7 @@ "example": "12", "member": "uint64", "name": "WaitRunningNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37858,6 +38246,7 @@ "example": "12", "member": "uint64", "name": "DependencyNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37868,6 +38257,7 @@ "example": "1", "member": "string", "name": "WaitEventNum", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -37878,6 +38268,7 @@ "example": "2", "member": "uint64", "name": "StoppingNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37888,6 +38279,7 @@ "example": "1", "member": "uint64", "name": "SucceedNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37898,9 +38290,21 @@ "example": "10", "member": "uint64", "name": "FailedNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true + }, + { + "disabled": false, + "document": "跳过运行总数", + "example": "1", + "member": "int64", + "name": "SkipRunningNum", + "output_required": false, + "required": false, + "type": "int", + "value_allowed_null": false } ], "usage": "both" @@ -37914,6 +38318,7 @@ "example": "0", "member": "uint64", "name": "CountTag", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -37924,6 +38329,7 @@ "example": "无", "member": "uint64", "name": "TotalNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37934,6 +38340,7 @@ "example": "无", "member": "uint64", "name": "RunningNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37944,6 +38351,7 @@ "example": "无", "member": "uint64", "name": "StoppingNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37954,6 +38362,7 @@ "example": "无", "member": "uint64", "name": "StoppedNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37964,6 +38373,18 @@ "example": "无", "member": "uint64", "name": "FrozenNum", + "output_required": true, + "required": false, + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "无效任务数\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "无", + "member": "uint64", + "name": "InvalidNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37974,6 +38395,7 @@ "example": "无", "member": "uint64", "name": "YearNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37984,6 +38406,7 @@ "example": "无", "member": "uint64", "name": "MonthNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -37994,6 +38417,7 @@ "example": "无", "member": "uint64", "name": "WeekNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -38004,6 +38428,7 @@ "example": "无", "member": "uint64", "name": "DayNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -38014,6 +38439,7 @@ "example": "无", "member": "uint64", "name": "HourNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -38024,6 +38450,7 @@ "example": "无", "member": "uint64", "name": "MinuteNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -41094,7 +41521,7 @@ { "disabled": false, "document": "表的全局唯一ID\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "12345", + "example": "3sURDHOlTaSQyx7lfuILJg", "member": "string", "name": "TableId", "output_required": true, @@ -41124,7 +41551,7 @@ { "disabled": false, "document": "数据源全局唯一ID\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "111", + "example": "9263", "member": "int64", "name": "DatasourceId", "output_required": true, @@ -41334,7 +41761,7 @@ { "disabled": false, "document": "生命周期\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "111", + "example": "1", "member": "int64", "name": "LifeCycleTime", "output_required": true, @@ -41354,7 +41781,7 @@ { "disabled": false, "document": "数据源引擎的实例ID：如EMR集群实例ID/数据源实例ID\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "abc", + "example": "1333", "member": "string", "name": "InstanceId", "output_required": true, @@ -41434,7 +41861,7 @@ { "disabled": false, "document": "集群ID\n注意：此字段可能返回 null，表示取不到有效值。", - "example": "xxx", + "example": "tbds-hoplnvlm", "member": "string", "name": "ClusterId", "output_required": true, @@ -42690,6 +43117,89 @@ ], "usage": "both" }, + "TaskImportInfo": { + "document": "集成任务导入到编排空间配置", + "members": [ + { + "disabled": false, + "document": "是否导入编排空间\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "true", + "member": "bool", + "name": "IsImport", + "output_required": false, + "required": false, + "type": "bool", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "是否新建工作流\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "true", + "member": "bool", + "name": "IsNewWorkFlow", + "output_required": false, + "required": false, + "type": "bool", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "工作流所属目录id\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "1", + "member": "string", + "name": "WorkFlowFolderId", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "工作流所属目录名称\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "名称", + "member": "string", + "name": "WorkFlowFolderName", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "工作流id\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "1", + "member": "string", + "name": "WorkFlowId", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "工作流名称\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "工作流名称示例", + "member": "string", + "name": "WorkFlowName", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "重名任务处理策略, 0:跳过,不导入; 1: 重命名\n注意：此字段可能返回 null，表示取不到有效值。", + "example": "1", + "member": "uint64", + "name": "TaskNameExistMode", + "output_required": false, + "required": false, + "type": "int", + "value_allowed_null": true + } + ], + "usage": "both" + }, "TaskInnerInfo": { "document": "任务属性", "members": [ diff --git a/tccli/services/wedata/v20210820/examples.json b/tccli/services/wedata/v20210820/examples.json index 9bb7147679..f79d9a571f 100644 --- a/tccli/services/wedata/v20210820/examples.json +++ b/tccli/services/wedata/v20210820/examples.json @@ -253,8 +253,8 @@ "CreateHiveTableByDDL": [ { "document": "创建表", - "input": "POST / HTTP/1.1\nHost: wedata.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateHiveTableByDDL\n<公共请求参数>\n\n{\n \"DatasourceId\": \"12342313\",\n \"Database\": \"hive\",\n \"DDLSql\": \"select * from database;\",\n \"Incharge\": \"231232\",\n \"Privilege\": 0,\n \"ProjectId\": \"124537\",\n \"Type\": \"HIVE\"\n}", - "output": "{\n \"Response\": {\n \"Data\": \"true\",\n \"RequestId\": \"as1cs2c123asyi23bh213cc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: wedata.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateHiveTableByDDL\n<公共请求参数>\n\n{\n \"DatasourceId\": \"12342313\",\n \"Database\": \"hive\",\n \"DDLSql\": \"select * from database;\",\n \"Incharge\": \"231232\",\n \"Privilege\": 0,\n \"ProjectId\": \"124537\",\n \"Type\": \"HIVE\",\n \"Async\": true\n}", + "output": "{\n \"Response\": {\n \"Data\": \"tablename\",\n \"TaskId\": \"25\",\n \"RequestId\": \"as1cs2c123asyi23bh213cc\"\n }\n}", "title": "CreateHiveTableByDDL" } ], @@ -702,6 +702,12 @@ "input": "POST / HTTP/1.1\nHost: wedata.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDsFolderTree\n<公共请求参数>\n\n{\n \"ProjectId\": \"1485413914375667733\",\n \"FirstLevelPull\": true,\n \"FolderId\": \"11265328-2c7d-11ee-8d13-a4ae120f8272\",\n \"WorkflowId\": \"11265328-2c7d-11ee-8d13-a4ae120f8273\",\n \"Keyword\": \"demoKey\",\n \"IncludeWorkflow\": true,\n \"IncludeTask\": true\n}", "output": "{\n \"Response\": {\n \"Data\": [\n {\n \"Children\": [\n {\n \"Children\": [],\n \"Id\": \"156b3b03-2c7d-11ee-8d13-a4ae120f8272\",\n \"IsLeaf\": false,\n \"Params\": \"eyJzdWJtaXRGbGFnIjp0cnVlLCJvd25lcklkIjoiMTAwMDI5NDExMDU2Iiwid29ya2Zsb3dEZXNjIjoiIn0=\",\n \"ParentId\": \"11265328-2c7d-11ee-8d13-a4ae120f8272\",\n \"Title\": \"f1332\",\n \"Type\": \"workflow\"\n },\n {\n \"Children\": [],\n \"Id\": \"2f03778a-2c7d-11ee-8d13-a4ae120f8272\",\n \"IsLeaf\": false,\n \"Params\": \"eyJzdWJtaXRGbGFnIjp0cnVlLCJvd25lcklkIjoiMTAwMDI5NDExMDU2Iiwid29ya2Zsb3dEZXNjIjoiIn0=\",\n \"ParentId\": \"11265328-2c7d-11ee-8d13-a4ae120f8272\",\n \"Title\": \"f2\",\n \"Type\": \"workflow\"\n }\n ],\n \"Id\": \"11265328-2c7d-11ee-8d13-a4ae120f8272\",\n \"IsLeaf\": false,\n \"Params\": null,\n \"ParentId\": \"\",\n \"Title\": \"0_dengboxu\",\n \"Type\": \"folder\"\n }\n ],\n \"RequestId\": \"de4d6055-1501-46e4-86d3-7b6e47c5b8d5\"\n }\n}", "title": "查询目录树" + }, + { + "document": "错误示例", + "input": "POST / HTTP/1.1\nHost: wedata.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDsFolderTree\n<公共请求参数>\n\n{\n \"ProjectId\": \"1111\"\n}", + "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"UnauthorizedOperation\",\n \"Message\": \"当前用户角色或WeData版本没有权限，请进行角色授权或者升级WeData版本\"\n },\n \"RequestId\": \"78deafe3-7320-448e-a6a5-2fcb38a4e4a5\"\n }\n}", + "title": "错误示例" } ], "DescribeDsParentFolderTree": [ @@ -994,7 +1000,7 @@ { "document": "数据补录-获取补录计划", "input": "POST / HTTP/1.1\nHost: wedata.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeOpsMakePlans\n<公共请求参数>\n\n{\n \"PageNumber\": 1,\n \"PageSize\": 1,\n \"ProjectId\": \"147056160274522xxxx\"\n}", - "output": "{\n \"Response\": {\n \"Data\": {\n \"TotalCount\": 0,\n \"TotalPage\": 0,\n \"PageCount\": 0,\n \"PageNumber\": 0,\n \"PageSize\": 0,\n \"Items\": [\n {\n \"CheckParent\": false,\n \"CompletePercent\": 100,\n \"CreateTime\": \"2023-05-28 23:02:46\",\n \"Creator\": \"creatorxxx\",\n \"CreatorId\": \"10000000xxxx\",\n \"IntegrationResourceGroup\": \"\",\n \"MakeDatetimeList\": [\n {\n \"EndDate\": \"2023-05-26\",\n \"EndTime\": \"03:59\",\n \"StartDate\": \"2023-05-26\",\n \"StartTime\": \"03:00\"\n }\n ],\n \"MakeName\": \"patch_20230528230215_xx\",\n \"MapParamList\": [],\n \"ParallelNum\": 4,\n \"PlanId\": \"e0bed861-0e95-44ca-9d10-28f2xxxxxxxx\",\n \"ProjectId\": \"14705616027xxxxxxxx\",\n \"Remark\": null,\n \"SameCycle\": true,\n \"SameSelfDependType\": false,\n \"SchedulerResourceGroup\": \"\",\n \"SourceTaskCycle\": null,\n \"SuccessPercent\": 100,\n \"TargetTaskAction\": 1,\n \"TargetTaskCycle\": \"month\",\n \"TaskCount\": 1,\n \"TaskIdList\": [\n \"2023052809431xxxx\"\n ],\n \"SchedulerResourceGroupName\": null,\n \"IntegrationResourceGroupName\": null,\n \"CheckParentType\": null\n }\n ]\n },\n \"RequestId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n }\n}", + "output": "{\n \"Response\": {\n \"Data\": {\n \"TotalCount\": 0,\n \"TotalPage\": 0,\n \"PageCount\": 0,\n \"PageNumber\": 0,\n \"PageSize\": 0,\n \"Items\": [\n {\n \"PlanId\": \"abc\",\n \"MakeName\": \"abc\",\n \"ProjectId\": \"abc\",\n \"CheckParent\": true,\n \"SameSelfDependType\": true,\n \"ParallelNum\": 0,\n \"SameCycle\": true,\n \"SourceTaskCycle\": \"abc\",\n \"TargetTaskCycle\": \"abc\",\n \"TargetTaskAction\": 0,\n \"MapParamList\": [\n {\n \"K\": \"abc\",\n \"V\": \"abc\"\n }\n ],\n \"CreatorId\": \"abc\",\n \"Creator\": \"abc\",\n \"CreateTime\": \"abc\",\n \"TaskIdList\": [\n \"abc\"\n ],\n \"MakeDatetimeList\": [\n {\n \"StartDate\": \"abc\",\n \"EndDate\": \"abc\",\n \"StartTime\": \"abc\",\n \"EndTime\": \"abc\"\n }\n ],\n \"Remark\": \"abc\",\n \"SchedulerResourceGroup\": \"abc\",\n \"SchedulerResourceGroupName\": \"abc\",\n \"IntegrationResourceGroup\": \"abc\",\n \"IntegrationResourceGroupName\": \"abc\",\n \"TaskCount\": 0,\n \"CompletePercent\": 0,\n \"SuccessPercent\": 0,\n \"CheckParentType\": \"abc\",\n \"SameSelfWorkflowDependType\": true,\n \"SelfWorkflowDependency\": \"abc\"\n }\n ]\n },\n \"RequestId\": \"abc\"\n }\n}", "title": "获取补录计划" } ], @@ -1254,7 +1260,7 @@ { "document": "任务状态统计", "input": "POST / HTTP/1.1\nHost: wedata.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ScheduleTaskCntByStatus\n<公共请求参数>\n\n{\n \"ProjectId\": \"12312\"\n}", - "output": "{\n \"Response\": {\n \"Data\": [\n {\n \"CountTag\": 1,\n \"TotalNum\": 1,\n \"RunningNum\": 1,\n \"StoppingNum\": 1,\n \"StoppedNum\": 1,\n \"FrozenNum\": 1,\n \"YearNum\": 1,\n \"MonthNum\": 1,\n \"WeekNum\": 1,\n \"DayNum\": 1,\n \"HourNum\": 1,\n \"MinuteNum\": 1\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"Data\": [\n {\n \"CountTag\": 0,\n \"DayNum\": 0,\n \"FrozenNum\": 0,\n \"HourNum\": 0,\n \"InvalidNum\": 0,\n \"MinuteNum\": 0,\n \"MonthNum\": 0,\n \"RunningNum\": 0,\n \"StoppedNum\": 0,\n \"StoppingNum\": 0,\n \"TotalNum\": 0,\n \"WeekNum\": 0,\n \"YearNum\": 0\n }\n ],\n \"RequestId\": \"717516e8-fece-4821-850b-43b4379c816d\"\n }\n}", "title": "任务状态统计示例" } ],