From a4584cacb92bbb6cfaf94fb33c9f1abe9f1cff34 Mon Sep 17 00:00:00 2001 From: tencentcloudapi <tencentcloudapi@tencent.com> Date: Mon, 30 Dec 2024 04:11:22 +0800 Subject: [PATCH] release 3.0.1241.1 --- CHANGELOG.md | 335 +++ SERVICE_CHANGELOG.md | 1098 ++++++++- products.md | 94 +- pyproject.toml | 4 +- tccli/__init__.py | 2 +- .../apm/v20210622/CreateApmInstance.md | 8 +- .../apm/v20210622/DescribeApmAgent.md | 2 +- .../v20210622/DescribeGeneralMetricData.md | 8 +- .../apm/v20210622/DescribeGeneralSpanList.md | 76 +- .../apm/v20210622/DescribeMetricRecords.md | 46 +- .../apm/v20210622/DescribeServiceOverview.md | 230 +- .../apm/v20210622/ModifyApmInstance.md | 10 +- .../apm/v20210622/TerminateApmInstance.md | 6 +- .../examples/car/v20220110/DestroySession.md | 2 +- .../v20220110/StartPublishStreamWithURL.md | 6 +- .../cdb/v20170320/CreateAuditRuleTemplate.md | 2 +- .../cdb/v20170320/DescribeAuditLogFiles.md | 3 +- .../v20170320/DescribeCpuExpandStrategy.md | 10 +- .../cdb/v20170320/DescribeDBImportRecords.md | 6 +- .../cdb/v20170320/DescribeDBInstances.md | 140 +- .../cdb/v20170320/DescribeDatabases.md | 3 +- .../cdb/v20170320/DescribeParamTemplates.md | 11 +- .../cdb/v20170320/ModifyDBInstanceVipVport.md | 2 +- .../chdfs/v20201112/DescribeFileSystems.md | 4 +- .../cvm/v20170312/CreateLaunchTemplate.md | 4 +- .../cvm/v20170312/DescribeChcHosts.md | 89 +- .../cvm/v20170312/DescribeImageFromFamily.md | 30 +- .../cvm/v20170312/DescribeImportImageOs.md | 8 +- .../cvm/v20170312/DescribeInstances.md | 12 +- .../cvm/v20170312/InquiryPriceRunInstances.md | 2 +- .../v20190107/CreateAuditRuleTemplate.md | 6 +- .../cynosdb/v20190107/CreateCLSDelivery.md | 2 +- .../cynosdb/v20190107/DeleteAuditLogFile.md | 2 +- .../DescribeAccountAllGrantPrivileges.md | 12 +- .../v20190107/DescribeAccountPrivileges.md | 6 +- .../cynosdb/v20190107/DescribeAuditLogs.md | 6 +- .../v20190107/DescribeClusterInstanceGrps.md | 420 ++-- .../v20190107/DescribeIsolatedInstances.md | 229 +- .../v20190107/DescribeParamTemplates.md | 3 +- .../v20190107/GrantAccountPrivileges.md | 10 +- .../cynosdb/v20190107/IsolateCluster.md | 6 +- .../cynosdb/v20190107/ModifyAccountParams.md | 4 +- .../v20190107/ModifyAccountPrivileges.md | 4 +- .../OpenClusterReadOnlyInstanceGroupAccess.md | 4 +- .../v20190107/RevokeAccountPrivileges.md | 10 +- .../cynosdb/v20190107/RollBackCluster.md | 6 +- .../v20191016/CreateDBDiagReportTask.md | 2 +- .../dbbrain/v20191016/DescribeDBDiagEvent.md | 6 +- .../v20191016/DescribeUserSqlAdvice.md | 8 +- .../v20210527/CreateDBDiagReportTask.md | 2 +- .../v20210527/CreateProxySessionKillTask.md | 4 +- .../v20210527/DescribeAlarmTemplate.md | 2 +- .../dbbrain/v20210527/DescribeDBDiagEvent.md | 6 +- .../v20210527/DescribeSlowLogTopSqls.md | 4 +- .../v20210527/DescribeUserSqlAdvice.md | 4 +- .../dts/v20180330/CreateMigrateJob.md | 12 +- .../dts/v20180330/DescribeMigrateJobs.md | 16 +- .../dts/v20211206/DescribeCompareReport.md | 107 +- .../dts/v20211206/DescribeMigrationDetail.md | 4 +- .../dts/v20211206/DescribeSyncJobs.md | 1 + .../dts/v20211206/ModifyMigrationJob.md | 172 +- .../ecm/v20190719/AllocateAddresses.md | 2 +- .../ecm/v20190719/AssociateAddress.md | 2 +- .../ecm/v20190719/DescribeAddresses.md | 14 +- .../ecm/v20190719/DisassociateAddress.md | 2 +- .../ecm/v20190719/ModifyAddressesBandwidth.md | 2 +- .../ecm/v20190719/ReleaseAddresses.md | 2 +- .../ReleaseIpv6AddressesBandwidth.md | 2 +- .../emr/v20190103/AddNodeResourceConfig.md | 56 + tccli/examples/emr/v20190103/AttachDisks.md | 21 + .../emr/v20190103/DeleteNodeResourceConfig.md | 24 + .../emr/v20190103/DescribeNodeDataDisks.md | 46 + .../DescribeNodeResourceConfigFast.md | 102 + .../emr/v20190103/ModifyInstanceBasic.md | 23 + .../examples/emr/v20190103/ModifyResource.md | 23 + .../examples/emr/v20190103/ResizeDataDisks.md | 23 + .../v20190103/SetNodeResourceConfigDefault.md | 24 + .../v20210526/ChannelCreateBatchSignUrl.md | 31 + .../essbasic/v20210526/CreateSignUrls.md | 53 + .../gaap/v20180529/CreateCertificate.md | 8 +- tccli/examples/gaap/v20180529/CreateDomain.md | 2 +- tccli/examples/gaap/v20180529/CreateProxy.md | 2 +- .../gaap/v20180529/CreateProxyGroup.md | 2 +- .../gaap/v20180529/DeleteCertificate.md | 2 +- .../gaap/v20180529/DescribeAccessRegions.md | 16 +- .../gaap/v20180529/DescribeAuthSignature.md | 2 +- .../gaap/v20180529/DescribeCertificates.md | 4 +- .../gaap/v20180529/DescribeGlobalDomains.md | 4 +- .../gaap/v20180529/DescribeHTTPListeners.md | 2 +- .../gaap/v20180529/DescribeHTTPSListeners.md | 30 +- .../gaap/v20180529/DescribeProxyDetail.md | 102 +- .../v20180529/DescribeProxyGroupDetails.md | 40 +- .../v20180529/DescribeRealServerStatistics.md | 6 +- .../v20180529/DescribeRealServersStatus.md | 8 +- .../gaap/v20180529/DescribeResourcesByTag.md | 4 +- .../gaap/v20180529/DescribeRulesByRuleIds.md | 4 +- .../gaap/v20180529/DescribeTCPListeners.md | 2 +- .../gaap/v20180529/DescribeUDPListeners.md | 6 +- .../v20180529/ModifyCertificateAttributes.md | 2 +- .../v20180529/ModifyGlobalDomainAttribute.md | 2 +- .../gaap/v20180529/ModifyGroupDomainConfig.md | 2 +- .../gaap/v20180529/ModifyProxiesAttribute.md | 2 +- .../v20180529/ModifyProxyGroupAttribute.md | 2 +- .../gaap/v20180529/ModifyRuleAttribute.md | 4 +- .../examples/gaap/v20180529/SetTlsVersion.md | 4 +- tccli/examples/gs/v20191118/CreateSession.md | 2 +- .../gs/v20191118/StartPublishStream.md | 2 +- .../gs/v20191118/StopPublishStream.md | 2 +- .../iai/v20200303/DetectFaceSimilarity.md | 47 + .../v20180801/CreateCasterInputPushUrl.md | 2 +- .../v20180801/CreateLiveCallbackTemplate.md | 2 +- .../live/v20180801/CreateLivePadTemplate.md | 6 +- .../v20180801/CreateLivePullStreamTask.md | 2 +- .../v20180801/CreateLiveRecordTemplate.md | 2 +- .../v20180801/CreateLiveSnapshotTemplate.md | 2 +- .../v20180801/CreateLiveTimeShiftTemplate.md | 8 +- .../v20180801/CreateLiveTranscodeTemplate.md | 2 +- tccli/examples/live/v20180801/DeleteCaster.md | 2 +- .../live/v20180801/DeleteCasterInputInfo.md | 4 +- .../live/v20180801/DeleteCasterLayoutInfo.md | 2 +- .../live/v20180801/DeleteCasterMarkPicInfo.md | 2 +- .../v20180801/DeleteCasterMarkWordInfo.md | 2 +- .../live/v20180801/DeleteCasterOutputInfo.md | 2 +- .../live/v20180801/DeleteLivePadRule.md | 6 +- .../live/v20180801/DeleteLiveTimeShiftRule.md | 6 +- .../live/v20180801/DeleteLiveWatermark.md | 2 +- .../examples/live/v20180801/DescribeCaster.md | 4 +- .../v20180801/DescribeCasterDisplayInfo.md | 2 +- .../v20180801/DescribeCasterInputInfos.md | 2 +- .../v20180801/DescribeCasterLayoutInfos.md | 2 +- .../live/v20180801/DescribeCasterList.md | 2 +- .../v20180801/DescribeCasterMarkPicInfos.md | 2 +- .../v20180801/DescribeCasterMarkWordInfos.md | 2 +- .../v20180801/DescribeCasterOutputInfos.md | 2 +- .../live/v20180801/DescribeCasterPlayUrl.md | 2 +- .../DescribeCasterTransitionTypes.md | 2 +- .../v20180801/DescribeDeliverLogDownList.md | 8 +- .../v20180801/DescribeLiveCallbackTemplate.md | 4 +- .../DescribeLiveCallbackTemplates.md | 4 +- .../live/v20180801/DescribeLiveCert.md | 2 +- .../live/v20180801/DescribeLiveCerts.md | 2 +- .../live/v20180801/DescribeLiveDomain.md | 18 +- .../live/v20180801/DescribeLiveDomainCert.md | 10 +- .../live/v20180801/DescribeLivePackageInfo.md | 122 +- .../live/v20180801/DescribeLivePadRules.md | 11 +- .../live/v20180801/DescribeLivePadTemplate.md | 15 +- .../v20180801/DescribeLivePadTemplates.md | 15 +- .../live/v20180801/DescribeLivePlayAuthKey.md | 4 +- .../v20180801/DescribeLivePullStreamTasks.md | 4 +- .../live/v20180801/DescribeLivePushAuthKey.md | 4 +- .../v20180801/DescribeLiveRecordTemplate.md | 102 +- .../v20180801/DescribeLiveRecordTemplates.md | 106 +- .../v20180801/DescribeLiveSnapshotTemplate.md | 8 +- .../DescribeLiveSnapshotTemplates.md | 8 +- .../v20180801/DescribeLiveStreamMonitor.md | 12 +- .../DescribeLiveStreamMonitorList.md | 24 +- .../v20180801/DescribeLiveTimeShiftRules.md | 11 +- .../DescribeLiveTimeShiftTemplates.md | 8 +- .../DescribeLiveTranscodeTemplate.md | 12 +- .../live/v20180801/DescribeLiveWatermarks.md | 8 +- .../live/v20180801/DescribeLogDownloadList.md | 2 +- .../live/v20180801/DescribeMonitorReport.md | 7 +- .../DescribeTimeShiftRecordDetail.md | 4 +- .../v20180801/DescribeTimeShiftStreamList.md | 2 +- tccli/examples/live/v20180801/ModifyCaster.md | 2 +- .../live/v20180801/ModifyCasterInputInfo.md | 2 +- .../live/v20180801/ModifyCasterLayoutInfo.md | 2 +- .../live/v20180801/ModifyCasterMarkPicInfo.md | 2 +- .../v20180801/ModifyCasterMarkWordInfo.md | 2 +- .../live/v20180801/ModifyCasterOutputInfo.md | 2 +- .../v20180801/ModifyLiveCallbackTemplate.md | 2 +- .../live/v20180801/ModifyLivePadTemplate.md | 6 +- .../live/v20180801/ModifyLivePlayAuthKey.md | 4 +- .../v20180801/ModifyLiveRecordTemplate.md | 2 +- .../v20180801/ModifyLiveSnapshotTemplate.md | 17 +- .../live/v20180801/ModifyLiveStreamMonitor.md | 22 +- .../v20180801/ModifyLiveTimeShiftTemplate.md | 12 +- .../v20180801/ModifyLiveTranscodeTemplate.md | 2 +- .../examples/live/v20180801/ReleaseCaster.md | 2 +- .../examples/live/v20180801/StopCasterPgm.md | 2 +- .../examples/live/v20180801/StopCasterPvw.md | 2 +- .../live/v20180801/UpdateLiveWatermark.md | 2 +- .../oceanus/v20190422/DeleteWorkSpace.md | 2 +- .../v20180328/DescribeProductSpec.md | 12 +- .../v20180328/ModifyAccountRemark.md | 4 +- ...scribeCertificateBindResourceTaskDetail.md | 144 +- ...scribeCertificateBindResourceTaskResult.md | 2 +- .../DescribeHostDeployRecordDetail.md | 56 +- .../v20191205/DescribeHostTeoInstanceList.md | 22 +- .../ssl/v20191205/DescribeHostUpdateRecord.md | 2 +- .../examples/tbaas/v20180416/ApplyUserCert.md | 4 +- .../tbaas/v20180416/DescribeFabricBlock.md | 2 +- .../tbaas/v20180416/GetClusterSummary.md | 27 +- .../v20180416/GetTransactionDetailForUser.md | 6 +- .../v20180416/InvokeChainMakerContract.md | 2 +- .../v20180416/QueryChainMakerContract.md | 2 +- .../CreateAndDeployCloudBaseProject.md | 42 +- .../DescribeCloudBaseProjectVersionList.md | 68 +- .../tcm/v20210413/DescribeAccessLogConfig.md | 26 +- .../tem/v20210701/CreateApplication.md | 25 +- .../v20210701/CreateApplicationAutoscaler.md | 33 +- .../tem/v20210701/CreateApplicationService.md | 22 +- .../tem/v20210701/CreateConfigData.md | 9 +- .../tem/v20210701/CreateEnvironment.md | 6 +- .../examples/tem/v20210701/CreateLogConfig.md | 26 +- .../examples/tem/v20210701/CreateResource.md | 3 +- .../tem/v20210701/DeployApplication.md | 126 +- .../DescribeApplicationAutoscalerList.md | 93 +- .../tem/v20210701/DescribeApplicationInfo.md | 689 +++--- .../tem/v20210701/DescribeApplicationPods.md | 98 +- .../DescribeApplicationServiceList.md | 92 +- .../v20210701/DescribeApplicationsStatus.md | 194 +- .../tem/v20210701/DescribeConfigData.md | 127 +- .../tem/v20210701/DescribeConfigDataList.md | 141 +- .../DescribeDeployApplicationDetail.md | 151 +- .../tem/v20210701/DescribeEnvironment.md | 31 +- .../v20210701/DescribeEnvironmentStatus.md | 4 +- .../tem/v20210701/DescribeEnvironments.md | 59 +- .../examples/tem/v20210701/DescribeIngress.md | 32 +- .../tem/v20210701/DescribeIngresses.md | 18 +- .../tem/v20210701/DescribeLogConfig.md | 60 +- .../v20210701/DescribePagedLogConfigList.md | 6 +- .../tem/v20210701/DescribeRelatedIngresses.md | 18 +- .../tem/v20210701/DestroyLogConfig.md | 2 +- .../v20210701/ModifyApplicationAutoscaler.md | 34 +- .../tem/v20210701/ModifyApplicationInfo.md | 4 +- .../tem/v20210701/ModifyApplicationService.md | 86 +- .../tem/v20210701/ModifyConfigData.md | 12 +- .../tem/v20210701/ModifyEnvironment.md | 2 +- .../examples/tem/v20210701/ModifyLogConfig.md | 2 +- .../RollingUpdateApplicationByVersion.md | 2 +- .../v20180525/CreateBackupStorageLocation.md | 8 +- tccli/examples/tke/v20180525/DeleteAddon.md | 6 +- .../v20180525/DeleteBackupStorageLocation.md | 4 +- tccli/examples/tke/v20180525/DescribeAddon.md | 11 +- .../tke/v20180525/DescribeAddonValues.md | 10 +- .../tke/v20180525/GetTkeAppChartList.md | 19 +- tccli/examples/tke/v20180525/InstallAddon.md | 167 +- tccli/examples/tke/v20180525/UpdateAddon.md | 132 +- tccli/examples/trro/v20220325/GetLicenses.md | 2 +- .../v20201207/CreateGovernanceInstances.md | 14 +- .../v20201207/CreateGovernanceNamespaces.md | 17 +- .../tse/v20201207/CreateGovernanceServices.md | 26 +- .../tse/v20201207/DeleteGovernanceAliases.md | 12 +- .../v20201207/DeleteGovernanceInstances.md | 12 +- .../DeleteGovernanceInstancesByHost.md | 10 +- .../v20201207/DeleteGovernanceNamespaces.md | 6 +- .../tse/v20201207/DeleteGovernanceServices.md | 8 +- .../tse/v20201207/DescribeConfigFile.md | 40 +- .../DescribeConfigFileReleaseHistories.md | 10 +- .../v20201207/DescribeGovernanceAliases.md | 30 +- .../v20201207/DescribeGovernanceNamespaces.md | 16 +- .../v20201207/DescribeGovernanceServices.md | 32 +- .../tse/v20201207/DescribeInstanceTagInfos.md | 2 +- .../tse/v20201207/DescribeSREInstances.md | 2 +- .../tse/v20201207/ModifyConfigFiles.md | 34 +- .../v20201207/ModifyGovernanceNamespaces.md | 16 +- tccli/examples/tsf/v20180326/BindApiGroup.md | 6 +- .../tsf/v20180326/CreateAllGatewayApiAsync.md | 7 +- .../examples/tsf/v20180326/CreateApiGroup.md | 12 +- .../tsf/v20180326/CreateApiRateLimitRule.md | 7 +- tccli/examples/tsf/v20180326/CreateConfig.md | 14 +- .../tsf/v20180326/CreateConfigTemplate.md | 18 +- .../CreateConfigTemplateWithDetailResp.md | 28 +- .../tsf/v20180326/CreateFileConfig.md | 19 +- .../tsf/v20180326/CreateGatewayApi.md | 17 +- .../tsf/v20180326/CreateMicroservice.md | 7 +- .../CreatePathRewritesWithDetailResp.md | 16 +- .../tsf/v20180326/CreatePublicConfig.md | 12 +- .../examples/tsf/v20180326/DeleteApiGroup.md | 4 +- tccli/examples/tsf/v20180326/DeleteConfig.md | 4 +- .../tsf/v20180326/DeleteFileConfig.md | 4 +- .../tsf/v20180326/DeleteGatewayApi.md | 6 +- tccli/examples/tsf/v20180326/DeleteLane.md | 6 +- .../tsf/v20180326/DeleteMicroservice.md | 4 +- .../tsf/v20180326/DeletePathRewrites.md | 4 +- .../tsf/v20180326/DeletePublicConfig.md | 4 +- .../examples/tsf/v20180326/DeleteUnitRule.md | 4 +- .../tsf/v20180326/DescribeApiDetail.md | 143 +- .../examples/tsf/v20180326/DescribeConfig.md | 28 +- .../v20180326/DescribeConfigReleaseLogs.md | 80 +- .../tsf/v20180326/DescribeConfigReleases.md | 41 +- .../tsf/v20180326/DescribeConfigSummary.md | 58 +- .../tsf/v20180326/DescribeDeliveryConfig.md | 32 +- .../DescribeDeliveryConfigByGroupId.md | 8 +- .../tsf/v20180326/DescribeDownloadInfo.md | 2 +- .../tsf/v20180326/DescribeEnabledUnitRule.md | 36 +- .../v20180326/DescribeFileConfigReleases.md | 30 +- .../tsf/v20180326/DescribeGroupRelease.md | 91 +- .../tsf/v20180326/DescribeMicroservices.md | 30 +- .../tsf/v20180326/DescribeMsApiList.md | 33 +- .../tsf/v20180326/DescribePluginInstances.md | 28 +- .../tsf/v20180326/DescribePublicConfig.md | 22 +- .../DescribePublicConfigReleaseLogs.md | 48 +- .../v20180326/DescribePublicConfigReleases.md | 43 +- .../v20180326/DescribePublicConfigSummary.md | 40 +- .../tsf/v20180326/DescribeReleasedConfig.md | 6 +- .../tsf/v20180326/DisableUnitRoute.md | 4 +- .../examples/tsf/v20180326/DisableUnitRule.md | 4 +- tccli/examples/tsf/v20180326/DraftApiGroup.md | 4 +- .../examples/tsf/v20180326/EnableLaneRule.md | 6 +- .../examples/tsf/v20180326/EnableUnitRoute.md | 4 +- .../examples/tsf/v20180326/EnableUnitRule.md | 4 +- tccli/examples/tsf/v20180326/ModifyLane.md | 10 +- .../tsf/v20180326/ModifyMicroservice.md | 5 +- .../tsf/v20180326/ModifyPathRewrite.md | 9 +- .../examples/tsf/v20180326/ReleaseApiGroup.md | 4 +- tccli/examples/tsf/v20180326/ReleaseConfig.md | 7 +- .../v20180326/ReleaseConfigWithDetailResp.md | 37 +- .../tsf/v20180326/ReleasePublicConfig.md | 7 +- .../tsf/v20180326/RevocationConfig.md | 4 +- .../tsf/v20180326/RevocationPublicConfig.md | 4 +- .../tsf/v20180326/RevokeFileConfig.md | 4 +- .../examples/tsf/v20180326/UnbindApiGroup.md | 6 +- .../examples/tsf/v20180326/UpdateApiGroup.md | 13 +- .../tsf/v20180326/UpdateApiRateLimitRule.md | 8 +- .../tsf/v20180326/UpdateApiRateLimitRules.md | 4 +- .../tsf/v20180326/UpdateApiTimeouts.md | 6 +- .../tsf/v20180326/UpdateGatewayApi.md | 12 +- .../vpc/v20170312/CreateCustomerGateway.md | 7 +- .../DownloadVpnGatewaySslClientCert.md | 14 +- .../InquiryPriceAllocateAddresses.md | 87 + .../InquiryPriceModifyAddressesBandwidth.md | 83 + .../v20170312/InquiryPriceRenewAddresses.md | 27 + .../v20170312/InquiryPriceRenewVpnGateway.md | 20 +- .../v20170312/ModifyVpnConnectionAttribute.md | 2 +- .../examples/vpc/v20170312/RenewVpnGateway.md | 6 +- .../waf/v20180125/CreateAreaBanRule.md | 31 + .../waf/v20180125/DescribeAreaBanRule.md | 43 + .../waf/v20180125/ModifyAreaBanRule.md | 30 + .../waf/v20180125/ModifyProtectionStatus.md | 2 +- tccli/services/apm/v20210622/api.json | 135 +- tccli/services/apm/v20210622/examples.json | 52 +- tccli/services/autoscaling/v20180419/api.json | 13 +- tccli/services/batch/v20170312/api.json | 22 +- tccli/services/billing/v20180709/api.json | 20 + tccli/services/cam/v20190116/api.json | 2 +- tccli/services/car/v20220110/api.json | 2 +- tccli/services/car/v20220110/examples.json | 6 +- tccli/services/cdb/v20170320/api.json | 1161 +++++----- tccli/services/cdb/v20170320/examples.json | 18 +- tccli/services/cdwdoris/v20211228/api.json | 40 + tccli/services/cfg/v20210820/api.json | 11 + tccli/services/chdfs/v20201112/api.json | 20 +- tccli/services/chdfs/v20201112/examples.json | 2 +- tccli/services/cls/v20201016/api.json | 2 +- tccli/services/cmq/v20190304/api.json | 154 +- tccli/services/cvm/cvm_client.py | 385 +--- tccli/services/cvm/v20170312/api.json | 2019 +++++------------ tccli/services/cvm/v20170312/examples.json | 56 +- tccli/services/cwp/cwp_client.py | 53 - tccli/services/cwp/v20180228/api.json | 34 - tccli/services/cwp/v20180228/examples.json | 8 - tccli/services/cynosdb/v20190107/api.json | 910 ++++---- .../services/cynosdb/v20190107/examples.json | 46 +- tccli/services/dbbrain/v20191016/api.json | 20 +- .../services/dbbrain/v20191016/examples.json | 10 +- tccli/services/dbbrain/v20210527/api.json | 88 +- .../services/dbbrain/v20210527/examples.json | 16 +- tccli/services/dts/v20180330/api.json | 60 +- tccli/services/dts/v20180330/examples.json | 8 +- tccli/services/dts/v20211206/api.json | 28 +- tccli/services/dts/v20211206/examples.json | 10 +- tccli/services/ecm/v20190719/api.json | 103 +- tccli/services/ecm/v20190719/examples.json | 14 +- tccli/services/emr/emr_client.py | 509 ++++- tccli/services/emr/v20190103/api.json | 1569 +++++++++++-- tccli/services/emr/v20190103/examples.json | 72 + tccli/services/ess/v20201111/api.json | 17 +- tccli/services/essbasic/v20210526/api.json | 13 +- .../services/essbasic/v20210526/examples.json | 12 + tccli/services/faceid/v20180301/api.json | 6 +- tccli/services/gaap/v20180529/api.json | 364 ++- tccli/services/gaap/v20180529/examples.json | 68 +- tccli/services/gs/v20191118/api.json | 6 +- tccli/services/gs/v20191118/examples.json | 6 +- tccli/services/iai/iai_client.py | 53 + tccli/services/iai/v20200303/api.json | 80 + tccli/services/iai/v20200303/examples.json | 14 + tccli/services/iotexplorer/v20190423/api.json | 10 + tccli/services/keewidb/v20220308/api.json | 378 ++- tccli/services/live/v20180801/api.json | 545 +++-- tccli/services/live/v20180801/examples.json | 158 +- tccli/services/mna/v20210119/api.json | 40 +- tccli/services/mps/v20190612/api.json | 40 + tccli/services/oceanus/v20190422/api.json | 446 +++- .../services/oceanus/v20190422/examples.json | 2 +- tccli/services/ocr/v20181119/api.json | 50 + tccli/services/sqlserver/v20180328/api.json | 374 +-- .../sqlserver/v20180328/examples.json | 4 +- tccli/services/ssl/v20191205/api.json | 1556 +++++++------ tccli/services/ssl/v20191205/examples.json | 16 +- tccli/services/tbaas/v20180416/api.json | 200 +- tccli/services/tbaas/v20180416/examples.json | 14 +- tccli/services/tcb/v20180608/api.json | 36 +- tccli/services/tcb/v20180608/examples.json | 4 +- tccli/services/tcm/v20210413/api.json | 12 +- tccli/services/tcm/v20210413/examples.json | 2 +- tccli/services/tcr/v20190924/api.json | 29 +- tccli/services/tdmq/v20200217/api.json | 18 + tccli/services/tem/v20210701/api.json | 719 +++--- tccli/services/tem/v20210701/examples.json | 78 +- tccli/services/tke/v20180525/api.json | 89 +- tccli/services/tke/v20180525/examples.json | 72 +- tccli/services/trro/v20220325/api.json | 54 +- tccli/services/trro/v20220325/examples.json | 2 +- tccli/services/tse/v20201207/api.json | 55 +- tccli/services/tse/v20201207/examples.json | 62 +- tccli/services/tsf/v20180326/api.json | 882 +++---- tccli/services/tsf/v20180326/examples.json | 244 +- tccli/services/tts/v20190823/api.json | 2 +- tccli/services/vpc/v20170312/api.json | 315 ++- tccli/services/vpc/v20170312/examples.json | 64 +- tccli/services/vpc/vpc_client.py | 159 ++ tccli/services/waf/v20180125/api.json | 307 ++- tccli/services/waf/v20180125/examples.json | 26 +- tccli/services/waf/waf_client.py | 167 +- 417 files changed, 15124 insertions(+), 10022 deletions(-) create mode 100644 tccli/examples/emr/v20190103/AddNodeResourceConfig.md create mode 100644 tccli/examples/emr/v20190103/AttachDisks.md create mode 100644 tccli/examples/emr/v20190103/DeleteNodeResourceConfig.md create mode 100644 tccli/examples/emr/v20190103/DescribeNodeDataDisks.md create mode 100644 tccli/examples/emr/v20190103/DescribeNodeResourceConfigFast.md create mode 100644 tccli/examples/emr/v20190103/ModifyInstanceBasic.md create mode 100644 tccli/examples/emr/v20190103/ModifyResource.md create mode 100644 tccli/examples/emr/v20190103/ResizeDataDisks.md create mode 100644 tccli/examples/emr/v20190103/SetNodeResourceConfigDefault.md create mode 100644 tccli/examples/iai/v20200303/DetectFaceSimilarity.md create mode 100644 tccli/examples/vpc/v20170312/InquiryPriceAllocateAddresses.md create mode 100644 tccli/examples/vpc/v20170312/InquiryPriceModifyAddressesBandwidth.md create mode 100644 tccli/examples/vpc/v20170312/InquiryPriceRenewAddresses.md create mode 100644 tccli/examples/waf/v20180125/CreateAreaBanRule.md create mode 100644 tccli/examples/waf/v20180125/DescribeAreaBanRule.md create mode 100644 tccli/examples/waf/v20180125/ModifyAreaBanRule.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 3b1c21a5c6..1b483029d8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,338 @@ +# Release 3.0.1241.1 + +## 弹性伸缩(as) 版本:2018-04-19 + +### 第 79 次发布 + +发布时间:2024-12-30 01:10:05 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [ServiceSettings](https://cloud.tencent.com/document/api/377/20453#ServiceSettings) + + * 新增成员:DesiredCapacitySyncWithMaxMinSize + + + + +## 弹性 MapReduce(emr) 版本:2019-01-03 + +### 第 86 次发布 + +发布时间:2024-12-30 01:32:38 + +本次发布包含了以下内容: + +改善已有的文档。 + +新增接口: + +* [AddNodeResourceConfig](https://cloud.tencent.com/document/api/589/115194) +* [AttachDisks](https://cloud.tencent.com/document/api/589/115188) +* [DeleteNodeResourceConfig](https://cloud.tencent.com/document/api/589/115193) +* [DescribeNodeDataDisks](https://cloud.tencent.com/document/api/589/115191) +* [DescribeNodeResourceConfigFast](https://cloud.tencent.com/document/api/589/115195) +* [ModifyInstanceBasic](https://cloud.tencent.com/document/api/589/115192) +* [ModifyResource](https://cloud.tencent.com/document/api/589/115187) +* [ResizeDataDisks](https://cloud.tencent.com/document/api/589/115186) +* [SetNodeResourceConfigDefault](https://cloud.tencent.com/document/api/589/115190) + +新增数据结构: + +* [CBSInstance](https://cloud.tencent.com/document/api/589/33981#CBSInstance) +* [DescribeResourceConfig](https://cloud.tencent.com/document/api/589/33981#DescribeResourceConfig) +* [NodeResource](https://cloud.tencent.com/document/api/589/33981#NodeResource) +* [NodeSpecDiskV2](https://cloud.tencent.com/document/api/589/33981#NodeSpecDiskV2) + +修改数据结构: + +* [SchedulerTaskDetail](https://cloud.tencent.com/document/api/589/33981#SchedulerTaskDetail) + + * <font color="#dd0000">**修改成员**:</font>JobId + +* [YarnApplication](https://cloud.tencent.com/document/api/589/33981#YarnApplication) + + * <font color="#dd0000">**修改成员**:</font>Id, User, Name, Queue, ApplicationType, ElapsedTime, State, FinalStatus, Progress, StartedTime, FinishedTime, AllocatedMB, AllocatedVCores, RunningContainers, MemorySeconds, VCoreSeconds, QueueUsagePercentage, ClusterUsagePercentage, PreemptedResourceMB, PreemptedResourceVCores, NumNonAMContainerPreempted, NumAMContainerPreempted, MapsTotal, MapsCompleted, ReducesTotal, ReducesCompleted, AvgMapTime, AvgReduceTime, AvgShuffleTime, AvgMergeTime, FailedReduceAttempts, KilledReduceAttempts, SuccessfulReduceAttempts, FailedMapAttempts, KilledMapAttempts, SuccessfulMapAttempts, GcTimeMillis, VCoreMillisMaps, MbMillisMaps, VCoreMillisReduces, MbMillisReduces, TotalLaunchedMaps, TotalLaunchedReduces, MapInputRecords, MapOutputRecords, ReduceInputRecords, ReduceOutputRecords, HDFSBytesWritten, HDFSBytesRead + + + + +## 多网聚合加速(mna) 版本:2021-01-19 + +### 第 24 次发布 + +发布时间:2024-12-30 01:46:00 + +本次发布包含了以下内容: + +改善已有的文档。 + +<font color="#dd0000">**预下线接口**:</font> + +* CreateQos +* DeleteQos +* DescribeQos + + + +## 媒体处理(mps) 版本:2019-06-12 + +### 第 107 次发布 + +发布时间:2024-12-30 01:47:47 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [SegmentRecognitionItem](https://cloud.tencent.com/document/api/862/37615#SegmentRecognitionItem) + + * 新增成员:AudioUrl, AudioBeginTime, AudioEndTime, PersonPositionUrl + + + + +## 流计算 Oceanus(oceanus) 版本:2019-04-22 + +### 第 66 次发布 + +发布时间:2024-12-30 01:49:42 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [CreateJobConfig](https://cloud.tencent.com/document/api/849/52004) + + * 新增入参:JobManagerCpu, JobManagerMem, TaskManagerCpu, TaskManagerMem + +* [DescribeResources](https://cloud.tencent.com/document/api/849/54668) + + * 新增入参:SystemResource + +* [DescribeSystemResources](https://cloud.tencent.com/document/api/849/51999) + + * 新增入参:WorkSpaceId + + +修改数据结构: + +* [Cluster](https://cloud.tencent.com/document/api/849/52010#Cluster) + + * 新增成员:TotalCpu, TotalMem, RunningCpu, RunningMem + +* [ClusterGroupSetItem](https://cloud.tencent.com/document/api/849/52010#ClusterGroupSetItem) + + * 新增成员:TotalCpu, TotalMem, RunningCpu, RunningMem + +* [JobConfig](https://cloud.tencent.com/document/api/849/52010#JobConfig) + + * 新增成员:JobManagerCpu, JobManagerMem, TaskManagerCpu, TaskManagerMem, JobConfigItem + +* [ResourceItem](https://cloud.tencent.com/document/api/849/52010#ResourceItem) + + * 新增成员:Connector, ConnectorVersion, ConnectionMethod, RelatedResourceId, Icon, ConnectorName, ConnectorUrl + + * <font color="#dd0000">**修改成员**:</font>ResourceId, Name, ResourceType, ResourceLoc, Region, AppId, OwnerUin, CreatorUin, CreateTime, UpdateTime, LatestResourceConfigVersion, Remark, VersionCount, RefJobCount, IsJobRun, FileName, WorkSpaceId, RefJobStatusCountSet + +* [ResourceRefDetail](https://cloud.tencent.com/document/api/849/52010#ResourceRefDetail) + + * 新增成员:Connector + +* [SqlGatewayItem](https://cloud.tencent.com/document/api/849/52010#SqlGatewayItem) + + * 新增成员:Cpu, Mem + +* [SubEks](https://cloud.tencent.com/document/api/849/52010#SubEks) + + * 新增成员:TotalCpu, TotalMem, RunningCpu, RunningMem + +* [SystemResourceItem](https://cloud.tencent.com/document/api/849/52010#SystemResourceItem) + + * 新增成员:SystemProvide + +* [TreeJobSets](https://cloud.tencent.com/document/api/849/52010#TreeJobSets) + + * 新增成员:ScalingType, RunningCpu, RunningMem + + + + +## SSL 证书(ssl) 版本:2019-12-05 + +### 第 74 次发布 + +发布时间:2024-12-30 01:56:22 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [ClbListener](https://cloud.tencent.com/document/api/400/41679#ClbListener) + + * <font color="#dd0000">**修改成员**:</font>NoMatchDomains + +* [UpdateRecordDetails](https://cloud.tencent.com/document/api/400/41679#UpdateRecordDetails) + + * <font color="#dd0000">**修改成员**:</font>TotalCount + + + + +## 消息队列 TDMQ(tdmq) 版本:2020-02-17 + +### 第 134 次发布 + +发布时间:2024-12-30 01:59:55 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [CreateTopic](https://cloud.tencent.com/document/api/1179/46088) + + * 新增入参:UnackPolicy + +* [ModifyTopic](https://cloud.tencent.com/document/api/1179/46085) + + * 新增入参:UnackPolicy + + + + +## 弹性微服务(tem) 版本:2021-07-01 + +### 第 47 次发布 + +发布时间:2024-12-30 02:00:58 + +本次发布包含了以下内容: + +改善已有的文档。 + +<font color="#dd0000">**预下线接口**:</font> + +* ModifyIngress + +修改数据结构: + +* [DescribeRunPodPage](https://cloud.tencent.com/document/api/1371/60171#DescribeRunPodPage) + + * <font color="#dd0000">**修改成员**:</font>Offset, Limit, TotalCount, RequestId, PodList + +* [NodeInfo](https://cloud.tencent.com/document/api/1371/60171#NodeInfo) + + * <font color="#dd0000">**修改成员**:</font>Name, Zone, SubnetId, AvailableIpCount, Cidr + +* [RunVersionPod](https://cloud.tencent.com/document/api/1371/60171#RunVersionPod) + + * <font color="#dd0000">**修改成员**:</font>Webshell, PodId, Status, CreateTime, PodIp, Zone, DeployVersion, RestartCount, Ready, ContainerState, NodeInfo, StartTime, Unhealthy, UnhealthyWarningMsg, VersionId, ApplicationName + +* [WorkloadInfo](https://cloud.tencent.com/document/api/1371/60171#WorkloadInfo) + + * <font color="#dd0000">**修改成员**:</font>ClusterId, ApplicationName, VersionName, ReadyReplicas, Replicas, UpdatedReplicas, UpdatedReadyReplicas, UpdateRevision, CurrentRevision + + + + +## 弹性微服务(tem) 版本:2020-12-21 + + + +## 容器服务(tke) 版本:2022-05-01 + + + +## 容器服务(tke) 版本:2018-05-25 + +### 第 188 次发布 + +发布时间:2024-12-30 02:02:56 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [Addon](https://cloud.tencent.com/document/api/457/31866#Addon) + + * 新增成员:CreateTime + + * <font color="#dd0000">**修改成员**:</font>AddonName, AddonVersion, RawValues, Phase, Reason + +* [Switch](https://cloud.tencent.com/document/api/457/31866#Switch) + + * <font color="#dd0000">**修改成员**:</font>MasterLog + + + + +## 微服务引擎(tse) 版本:2020-12-07 + +### 第 84 次发布 + +发布时间:2024-12-30 02:05:51 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [DescribeGovernanceNamespaces](https://cloud.tencent.com/document/api/1364/104406) + + * 新增入参:SyncToGlobalRegistry + +* [DescribeGovernanceServices](https://cloud.tencent.com/document/api/1364/104380) + + * 新增入参:SyncToGlobalRegistry + + +修改数据结构: + +* [GovernanceNamespace](https://cloud.tencent.com/document/api/1364/54942#GovernanceNamespace) + + * 新增成员:ServiceExportTo + +* [GovernanceNamespaceInput](https://cloud.tencent.com/document/api/1364/54942#GovernanceNamespaceInput) + + * 新增成员:ServiceExportTo + + + + +## 私有网络(vpc) 版本:2017-03-12 + +### 第 236 次发布 + +发布时间:2024-12-30 02:10:17 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [CustomerGateway](https://cloud.tencent.com/document/api/215/15824#CustomerGateway) + + * <font color="#dd0000">**修改成员**:</font>BgpAsn + + + + # Release 3.0.1240.1 ## 云安全一体化平台(csip) 版本:2022-11-21 diff --git a/SERVICE_CHANGELOG.md b/SERVICE_CHANGELOG.md index 7707478bda..8655a61acc 100644 --- a/SERVICE_CHANGELOG.md +++ b/SERVICE_CHANGELOG.md @@ -1,10 +1,29 @@ # 本版本更新包含以下内容: -## 云安全一体化平台(csip) 版本:2022-11-21 +## 弹性伸缩(as) 版本:2018-04-19 -### 第 49 次发布 +### 第 79 次发布 -发布时间:2024-12-26 18:44:26 +发布时间:2024-12-30 01:10:05 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [ServiceSettings](https://cloud.tencent.com/document/api/377/20453#ServiceSettings) + + * 新增成员:DesiredCapacitySyncWithMaxMinSize + + + + +## 弹性 MapReduce(emr) 版本:2019-01-03 + +### 第 86 次发布 + +发布时间:2024-12-30 01:32:38 本次发布包含了以下内容: @@ -12,22 +31,305 @@ 新增接口: -* [DescribeClusterAssets](https://cloud.tencent.com/document/api/664/114843) -* [DescribeOrganizationInfo](https://cloud.tencent.com/document/api/664/114848) -* [DescribeSubUserInfo](https://cloud.tencent.com/document/api/664/114847) -* [DescribeUebaRule](https://cloud.tencent.com/document/api/664/114846) -* [ModifyUebaRuleSwitch](https://cloud.tencent.com/document/api/664/114845) +* [AddNodeResourceConfig](https://cloud.tencent.com/document/api/589/115194) +* [AttachDisks](https://cloud.tencent.com/document/api/589/115188) +* [DeleteNodeResourceConfig](https://cloud.tencent.com/document/api/589/115193) +* [DescribeNodeDataDisks](https://cloud.tencent.com/document/api/589/115191) +* [DescribeNodeResourceConfigFast](https://cloud.tencent.com/document/api/589/115195) +* [ModifyInstanceBasic](https://cloud.tencent.com/document/api/589/115192) +* [ModifyResource](https://cloud.tencent.com/document/api/589/115187) +* [ResizeDataDisks](https://cloud.tencent.com/document/api/589/115186) +* [SetNodeResourceConfigDefault](https://cloud.tencent.com/document/api/589/115190) 新增数据结构: -* [AssetCluster](https://cloud.tencent.com/document/api/664/90825#AssetCluster) -* [CloudCountDesc](https://cloud.tencent.com/document/api/664/90825#CloudCountDesc) -* [OrganizationInfo](https://cloud.tencent.com/document/api/664/90825#OrganizationInfo) -* [StatisticalFilter](https://cloud.tencent.com/document/api/664/90825#StatisticalFilter) -* [SubUserInfo](https://cloud.tencent.com/document/api/664/90825#SubUserInfo) -* [UebaCustomRule](https://cloud.tencent.com/document/api/664/90825#UebaCustomRule) -* [UebaEventContent](https://cloud.tencent.com/document/api/664/90825#UebaEventContent) -* [UebaRule](https://cloud.tencent.com/document/api/664/90825#UebaRule) +* [CBSInstance](https://cloud.tencent.com/document/api/589/33981#CBSInstance) +* [DescribeResourceConfig](https://cloud.tencent.com/document/api/589/33981#DescribeResourceConfig) +* [NodeResource](https://cloud.tencent.com/document/api/589/33981#NodeResource) +* [NodeSpecDiskV2](https://cloud.tencent.com/document/api/589/33981#NodeSpecDiskV2) + +修改数据结构: + +* [SchedulerTaskDetail](https://cloud.tencent.com/document/api/589/33981#SchedulerTaskDetail) + + * <font color="#dd0000">**修改成员**:</font>JobId + +* [YarnApplication](https://cloud.tencent.com/document/api/589/33981#YarnApplication) + + * <font color="#dd0000">**修改成员**:</font>Id, User, Name, Queue, ApplicationType, ElapsedTime, State, FinalStatus, Progress, StartedTime, FinishedTime, AllocatedMB, AllocatedVCores, RunningContainers, MemorySeconds, VCoreSeconds, QueueUsagePercentage, ClusterUsagePercentage, PreemptedResourceMB, PreemptedResourceVCores, NumNonAMContainerPreempted, NumAMContainerPreempted, MapsTotal, MapsCompleted, ReducesTotal, ReducesCompleted, AvgMapTime, AvgReduceTime, AvgShuffleTime, AvgMergeTime, FailedReduceAttempts, KilledReduceAttempts, SuccessfulReduceAttempts, FailedMapAttempts, KilledMapAttempts, SuccessfulMapAttempts, GcTimeMillis, VCoreMillisMaps, MbMillisMaps, VCoreMillisReduces, MbMillisReduces, TotalLaunchedMaps, TotalLaunchedReduces, MapInputRecords, MapOutputRecords, ReduceInputRecords, ReduceOutputRecords, HDFSBytesWritten, HDFSBytesRead + + + + +## 多网聚合加速(mna) 版本:2021-01-19 + +### 第 24 次发布 + +发布时间:2024-12-30 01:46:00 + +本次发布包含了以下内容: + +改善已有的文档。 + +<font color="#dd0000">**预下线接口**:</font> + +* CreateQos +* DeleteQos +* DescribeQos + + + +## 媒体处理(mps) 版本:2019-06-12 + +### 第 107 次发布 + +发布时间:2024-12-30 01:47:47 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [SegmentRecognitionItem](https://cloud.tencent.com/document/api/862/37615#SegmentRecognitionItem) + + * 新增成员:AudioUrl, AudioBeginTime, AudioEndTime, PersonPositionUrl + + + + +## 流计算 Oceanus(oceanus) 版本:2019-04-22 + +### 第 66 次发布 + +发布时间:2024-12-30 01:49:42 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [CreateJobConfig](https://cloud.tencent.com/document/api/849/52004) + + * 新增入参:JobManagerCpu, JobManagerMem, TaskManagerCpu, TaskManagerMem + +* [DescribeResources](https://cloud.tencent.com/document/api/849/54668) + + * 新增入参:SystemResource + +* [DescribeSystemResources](https://cloud.tencent.com/document/api/849/51999) + + * 新增入参:WorkSpaceId + + +修改数据结构: + +* [Cluster](https://cloud.tencent.com/document/api/849/52010#Cluster) + + * 新增成员:TotalCpu, TotalMem, RunningCpu, RunningMem + +* [ClusterGroupSetItem](https://cloud.tencent.com/document/api/849/52010#ClusterGroupSetItem) + + * 新增成员:TotalCpu, TotalMem, RunningCpu, RunningMem + +* [JobConfig](https://cloud.tencent.com/document/api/849/52010#JobConfig) + + * 新增成员:JobManagerCpu, JobManagerMem, TaskManagerCpu, TaskManagerMem, JobConfigItem + +* [ResourceItem](https://cloud.tencent.com/document/api/849/52010#ResourceItem) + + * 新增成员:Connector, ConnectorVersion, ConnectionMethod, RelatedResourceId, Icon, ConnectorName, ConnectorUrl + + * <font color="#dd0000">**修改成员**:</font>ResourceId, Name, ResourceType, ResourceLoc, Region, AppId, OwnerUin, CreatorUin, CreateTime, UpdateTime, LatestResourceConfigVersion, Remark, VersionCount, RefJobCount, IsJobRun, FileName, WorkSpaceId, RefJobStatusCountSet + +* [ResourceRefDetail](https://cloud.tencent.com/document/api/849/52010#ResourceRefDetail) + + * 新增成员:Connector + +* [SqlGatewayItem](https://cloud.tencent.com/document/api/849/52010#SqlGatewayItem) + + * 新增成员:Cpu, Mem + +* [SubEks](https://cloud.tencent.com/document/api/849/52010#SubEks) + + * 新增成员:TotalCpu, TotalMem, RunningCpu, RunningMem + +* [SystemResourceItem](https://cloud.tencent.com/document/api/849/52010#SystemResourceItem) + + * 新增成员:SystemProvide + +* [TreeJobSets](https://cloud.tencent.com/document/api/849/52010#TreeJobSets) + + * 新增成员:ScalingType, RunningCpu, RunningMem + + + + +## SSL 证书(ssl) 版本:2019-12-05 + +### 第 74 次发布 + +发布时间:2024-12-30 01:56:22 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [ClbListener](https://cloud.tencent.com/document/api/400/41679#ClbListener) + + * <font color="#dd0000">**修改成员**:</font>NoMatchDomains + +* [UpdateRecordDetails](https://cloud.tencent.com/document/api/400/41679#UpdateRecordDetails) + + * <font color="#dd0000">**修改成员**:</font>TotalCount + + + + +## 消息队列 TDMQ(tdmq) 版本:2020-02-17 + +### 第 134 次发布 + +发布时间:2024-12-30 01:59:55 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [CreateTopic](https://cloud.tencent.com/document/api/1179/46088) + + * 新增入参:UnackPolicy + +* [ModifyTopic](https://cloud.tencent.com/document/api/1179/46085) + + * 新增入参:UnackPolicy + + + + +## 弹性微服务(tem) 版本:2021-07-01 + +### 第 47 次发布 + +发布时间:2024-12-30 02:00:58 + +本次发布包含了以下内容: + +改善已有的文档。 + +<font color="#dd0000">**预下线接口**:</font> + +* ModifyIngress + +修改数据结构: + +* [DescribeRunPodPage](https://cloud.tencent.com/document/api/1371/60171#DescribeRunPodPage) + + * <font color="#dd0000">**修改成员**:</font>Offset, Limit, TotalCount, RequestId, PodList + +* [NodeInfo](https://cloud.tencent.com/document/api/1371/60171#NodeInfo) + + * <font color="#dd0000">**修改成员**:</font>Name, Zone, SubnetId, AvailableIpCount, Cidr + +* [RunVersionPod](https://cloud.tencent.com/document/api/1371/60171#RunVersionPod) + + * <font color="#dd0000">**修改成员**:</font>Webshell, PodId, Status, CreateTime, PodIp, Zone, DeployVersion, RestartCount, Ready, ContainerState, NodeInfo, StartTime, Unhealthy, UnhealthyWarningMsg, VersionId, ApplicationName + +* [WorkloadInfo](https://cloud.tencent.com/document/api/1371/60171#WorkloadInfo) + + * <font color="#dd0000">**修改成员**:</font>ClusterId, ApplicationName, VersionName, ReadyReplicas, Replicas, UpdatedReplicas, UpdatedReadyReplicas, UpdateRevision, CurrentRevision + + + + +## 弹性微服务(tem) 版本:2020-12-21 + + + +## 容器服务(tke) 版本:2022-05-01 + + + +## 容器服务(tke) 版本:2018-05-25 + +### 第 188 次发布 + +发布时间:2024-12-30 02:02:56 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [Addon](https://cloud.tencent.com/document/api/457/31866#Addon) + + * 新增成员:CreateTime + + * <font color="#dd0000">**修改成员**:</font>AddonName, AddonVersion, RawValues, Phase, Reason + +* [Switch](https://cloud.tencent.com/document/api/457/31866#Switch) + + * <font color="#dd0000">**修改成员**:</font>MasterLog + + + + +## 微服务引擎(tse) 版本:2020-12-07 + +### 第 84 次发布 + +发布时间:2024-12-30 02:05:51 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [DescribeGovernanceNamespaces](https://cloud.tencent.com/document/api/1364/104406) + + * 新增入参:SyncToGlobalRegistry + +* [DescribeGovernanceServices](https://cloud.tencent.com/document/api/1364/104380) + + * 新增入参:SyncToGlobalRegistry + + +修改数据结构: + +* [GovernanceNamespace](https://cloud.tencent.com/document/api/1364/54942#GovernanceNamespace) + + * 新增成员:ServiceExportTo + +* [GovernanceNamespaceInput](https://cloud.tencent.com/document/api/1364/54942#GovernanceNamespaceInput) + + * 新增成员:ServiceExportTo + + + + +## 私有网络(vpc) 版本:2017-03-12 + +### 第 236 次发布 + +发布时间:2024-12-30 02:10:17 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [CustomerGateway](https://cloud.tencent.com/document/api/215/15824#CustomerGateway) + + * <font color="#dd0000">**修改成员**:</font>BgpAsn + @@ -5428,6 +5730,21 @@ ## 弹性伸缩(as) 版本:2018-04-19 +### 第 79 次发布 + +发布时间:2024-12-30 01:10:05 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [ServiceSettings](https://cloud.tencent.com/document/api/377/20453#ServiceSettings) + + * 新增成员:DesiredCapacitySyncWithMaxMinSize + + ### 第 78 次发布 发布时间:2024-12-02 01:07:50 @@ -10010,6 +10327,21 @@ ## 费用中心(billing) 版本:2018-07-09 +### 第 69 次发布 + +发布时间:2024-12-27 10:52:13 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [VoucherInfos](https://cloud.tencent.com/document/api/555/19183#VoucherInfos) + + * 新增成员:PolicyRemark, CreateTime + + ### 第 68 次发布 发布时间:2024-12-18 17:13:22 @@ -18167,6 +18499,19 @@ ## 云数据库 MySQL(cdb) 版本:2017-03-20 +### 第 182 次发布 + +发布时间:2024-12-27 10:53:17 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [DescribeCpuExpandStrategy](https://cloud.tencent.com/document/api/236/96018) + + ### 第 181 次发布 发布时间:2024-12-26 01:14:34 @@ -25309,6 +25654,32 @@ ## 腾讯云数据仓库 TCHouse-D(cdwdoris) 版本:2021-12-28 +### 第 35 次发布 + +发布时间:2024-12-27 10:54:32 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [DescribeClusterConfigs](https://cloud.tencent.com/document/api/1387/102619) + + * 新增出参:HasCN + + +修改数据结构: + +* [InstanceInfo](https://cloud.tencent.com/document/api/1387/102385#InstanceInfo) + + * 新增成员:MonitorMode, CNSummary + +* [InstanceNode](https://cloud.tencent.com/document/api/1387/102385#InstanceNode) + + * 新增成员:CreateTime + + ### 第 34 次发布 发布时间:2024-12-26 01:17:01 @@ -26190,6 +26561,21 @@ ## 混沌演练平台(cfg) 版本:2021-08-20 +### 第 26 次发布 + +发布时间:2024-12-27 10:54:56 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [ObjectTypeConfigFields](https://cloud.tencent.com/document/api/1500/71784#ObjectTypeConfigFields) + + * 新增成员:Type + + ### 第 25 次发布 发布时间:2024-12-19 01:18:07 @@ -29022,6 +29408,21 @@ ## 云 HDFS(chdfs) 版本:2020-11-12 +### 第 8 次发布 + +发布时间:2024-12-27 10:55:07 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [MountPoint](https://cloud.tencent.com/document/api/1105/51158#MountPoint) + + * <font color="#dd0000">**修改成员**:</font>MountPointName + + ### 第 7 次发布 发布时间:2024-12-26 01:18:37 @@ -38850,6 +39251,27 @@ ## 消息队列 CMQ(cmq) 版本:2019-03-04 +### 第 3 次发布 + +发布时间:2024-12-27 11:04:06 + +本次发布包含了以下内容: + +改善已有的文档。 + +<font color="#dd0000">**预下线接口**:</font> + +* ClearQueue +* ClearSubscriptionFilterTags +* CreateSubscribe +* DeleteSubscribe +* DeleteTopic +* DescribeDeadLetterSourceQueues +* ModifySubscriptionAttribute +* ModifyTopicAttribute +* RewindQueue +* UnbindDeadLetter + ### 第 2 次发布 发布时间:2022-03-03 08:03:36 @@ -41893,22 +42315,22 @@ 新增接口: -* [[DescribeClusterAssets](https://cloud.tencent.com/document/api/664/114843)](https://cloud.tencent.com/document/api/#/#) -* [[DescribeOrganizationInfo](https://cloud.tencent.com/document/api/664/114848)](https://cloud.tencent.com/document/api/#/#) -* [[DescribeSubUserInfo](https://cloud.tencent.com/document/api/664/114847)](https://cloud.tencent.com/document/api/#/#) -* [[DescribeUebaRule](https://cloud.tencent.com/document/api/664/114846)](https://cloud.tencent.com/document/api/#/#) -* [[ModifyUebaRuleSwitch](https://cloud.tencent.com/document/api/664/114845)](https://cloud.tencent.com/document/api/#/#) +* [DescribeClusterAssets](https://cloud.tencent.com/document/api/664/114843) +* [DescribeOrganizationInfo](https://cloud.tencent.com/document/api/664/114848) +* [DescribeSubUserInfo](https://cloud.tencent.com/document/api/664/114847) +* [DescribeUebaRule](https://cloud.tencent.com/document/api/664/114846) +* [ModifyUebaRuleSwitch](https://cloud.tencent.com/document/api/664/114845) 新增数据结构: -* [[AssetCluster](https://cloud.tencent.com/document/api/664/90825#AssetCluster)](https://cloud.tencent.com/document/api/664/90825#[AssetCluster](https://cloud.tencent.com/document/api/664/90825#AssetCluster)) -* [[CloudCountDesc](https://cloud.tencent.com/document/api/664/90825#CloudCountDesc)](https://cloud.tencent.com/document/api/664/90825#[CloudCountDesc](https://cloud.tencent.com/document/api/664/90825#CloudCountDesc)) -* [[OrganizationInfo](https://cloud.tencent.com/document/api/664/90825#OrganizationInfo)](https://cloud.tencent.com/document/api/664/90825#[OrganizationInfo](https://cloud.tencent.com/document/api/664/90825#OrganizationInfo)) -* [[StatisticalFilter](https://cloud.tencent.com/document/api/664/90825#StatisticalFilter)](https://cloud.tencent.com/document/api/664/90825#[StatisticalFilter](https://cloud.tencent.com/document/api/664/90825#StatisticalFilter)) -* [[SubUserInfo](https://cloud.tencent.com/document/api/664/90825#SubUserInfo)](https://cloud.tencent.com/document/api/664/90825#[SubUserInfo](https://cloud.tencent.com/document/api/664/90825#SubUserInfo)) -* [[UebaCustomRule](https://cloud.tencent.com/document/api/664/90825#UebaCustomRule)](https://cloud.tencent.com/document/api/664/90825#[UebaCustomRule](https://cloud.tencent.com/document/api/664/90825#UebaCustomRule)) -* [[UebaEventContent](https://cloud.tencent.com/document/api/664/90825#UebaEventContent)](https://cloud.tencent.com/document/api/664/90825#[UebaEventContent](https://cloud.tencent.com/document/api/664/90825#UebaEventContent)) -* [[UebaRule](https://cloud.tencent.com/document/api/664/90825#UebaRule)](https://cloud.tencent.com/document/api/664/90825#[UebaRule](https://cloud.tencent.com/document/api/664/90825#UebaRule)) +* [AssetCluster](https://cloud.tencent.com/document/api/664/90825#AssetCluster) +* [CloudCountDesc](https://cloud.tencent.com/document/api/664/90825#CloudCountDesc) +* [OrganizationInfo](https://cloud.tencent.com/document/api/664/90825#OrganizationInfo) +* [StatisticalFilter](https://cloud.tencent.com/document/api/664/90825#StatisticalFilter) +* [SubUserInfo](https://cloud.tencent.com/document/api/664/90825#SubUserInfo) +* [UebaCustomRule](https://cloud.tencent.com/document/api/664/90825#UebaCustomRule) +* [UebaEventContent](https://cloud.tencent.com/document/api/664/90825#UebaEventContent) +* [UebaRule](https://cloud.tencent.com/document/api/664/90825#UebaRule) ### 第 48 次发布 @@ -43109,6 +43531,60 @@ ## 云服务器(cvm) 版本:2017-03-12 +### 第 138 次发布 + +发布时间:2024-12-27 11:35:31 + +本次发布包含了以下内容: + +改善已有的文档。 + +<font color="#dd0000">**删除接口**:</font> + +* DescribeReservedInstances +* DescribeReservedInstancesConfigInfos +* DescribeReservedInstancesOfferings +* InquirePricePurchaseReservedInstancesOffering +* PurchaseReservedInstancesOffering + +修改接口: + +* [ConfigureChcAssistVpc](https://cloud.tencent.com/document/api/213/76417) + + * 新增入参:ChcDeployExtraConfig + +* [ConfigureChcDeployVpc](https://cloud.tencent.com/document/api/213/76416) + + * 新增入参:ChcDeployExtraConfig + + +<font color="#dd0000">**删除数据结构**:</font> + +* ReservedInstanceConfigInfoItem +* ReservedInstanceFamilyItem +* ReservedInstancePrice +* ReservedInstancePriceItem +* ReservedInstanceTypeItem +* ReservedInstances +* ReservedInstancesOffering + +修改数据结构: + +* [ChcDeployExtraConfig](https://cloud.tencent.com/document/api/213/15753#ChcDeployExtraConfig) + + * 新增成员:MiniOsType, BootType, BootFile, NextServerAddress + +* [ChcHost](https://cloud.tencent.com/document/api/213/15753#ChcHost) + + * 新增成员:Gpu, NetworkCard, IsPredefinedType, ChcInstanceType, ChcInstanceFamily, ChcInstanceFamilyName, ResaleAppId, ResaleAccountId, SaleStatus, Tags, LatestOperation, LatestOperationErrorCode, LatestOperationErrorMsg, LatestOperationName, LatestOperationState + + * <font color="#dd0000">**修改成员**:</font>DeviceType, BmcVirtualPrivateCloud, BmcIp, BmcSecurityGroupIds, DeployVirtualPrivateCloud, DeployIp, DeploySecurityGroupIds, CvmInstanceId, HardwareDescription, TenantType, DeployExtraConfig + +* [InternetBandwidthConfig](https://cloud.tencent.com/document/api/213/15753#InternetBandwidthConfig) + + * <font color="#dd0000">**修改成员**:</font>StartTime, EndTime, InternetAccessible + + ### 第 137 次发布 发布时间:2024-12-11 01:23:11 @@ -44653,12 +45129,12 @@ 新增接口: -* [DescribeReservedInstancesConfigInfos](https://cloud.tencent.com/document/api/213/48128) -* [InquirePricePurchaseReservedInstancesOffering](https://cloud.tencent.com/document/api/213/48127) +* [DescribeReservedInstancesConfigInfos](https://cloud.tencent.com/document/api/#/#) +* [InquirePricePurchaseReservedInstancesOffering](https://cloud.tencent.com/document/api/#/#) 修改接口: -* [PurchaseReservedInstancesOffering](https://cloud.tencent.com/document/api/213/38093) +* [PurchaseReservedInstancesOffering](https://cloud.tencent.com/document/api/#/#) * 新增入参:ReservedInstanceName @@ -44990,9 +45466,9 @@ 新增接口: -* [DescribeReservedInstances](https://cloud.tencent.com/document/api/213/38095) -* [DescribeReservedInstancesOfferings](https://cloud.tencent.com/document/api/213/38094) -* [PurchaseReservedInstancesOffering](https://cloud.tencent.com/document/api/213/38093) +* [DescribeReservedInstances](https://cloud.tencent.com/document/api/#/#) +* [DescribeReservedInstancesOfferings](https://cloud.tencent.com/document/api/#/#) +* [PurchaseReservedInstancesOffering](https://cloud.tencent.com/document/api/#/#) 新增数据结构: @@ -45666,6 +46142,18 @@ ## 主机安全(cwp) 版本:2018-02-28 +### 第 137 次发布 + +发布时间:2024-12-27 11:04:23 + +本次发布包含了以下内容: + +改善已有的文档。 + +<font color="#dd0000">**删除接口**:</font> + +* DescribeIndexList + ### 第 136 次发布 发布时间:2024-12-17 01:18:39 @@ -49986,6 +50474,21 @@ ## TDSQL-C MySQL 版(cynosdb) 版本:2019-01-07 +### 第 121 次发布 + +发布时间:2024-12-27 11:07:10 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [OldAddrInfo](https://cloud.tencent.com/document/api/1003/48097#OldAddrInfo) + + * <font color="#dd0000">**修改成员**:</font>Vip, Vport, ReturnTime + + ### 第 120 次发布 发布时间:2024-12-26 01:25:16 @@ -62352,6 +62855,21 @@ ## 数据传输服务(dts) 版本:2021-12-06 +### 第 36 次发布 + +发布时间:2024-12-27 11:10:08 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [SyncJobInfo](https://cloud.tencent.com/document/api/571/82108#SyncJobInfo) + + * 新增成员:OptObjStatus + + ### 第 35 次发布 发布时间:2024-12-26 01:31:15 @@ -66107,6 +66625,44 @@ ## 弹性 MapReduce(emr) 版本:2019-01-03 +### 第 86 次发布 + +发布时间:2024-12-30 01:32:38 + +本次发布包含了以下内容: + +改善已有的文档。 + +新增接口: + +* [[AddNodeResourceConfig](https://cloud.tencent.com/document/api/589/115194)](https://cloud.tencent.com/document/api/#/#) +* [[AttachDisks](https://cloud.tencent.com/document/api/589/115188)](https://cloud.tencent.com/document/api/#/#) +* [[DeleteNodeResourceConfig](https://cloud.tencent.com/document/api/589/115193)](https://cloud.tencent.com/document/api/#/#) +* [[DescribeNodeDataDisks](https://cloud.tencent.com/document/api/589/115191)](https://cloud.tencent.com/document/api/#/#) +* [[DescribeNodeResourceConfigFast](https://cloud.tencent.com/document/api/589/115195)](https://cloud.tencent.com/document/api/#/#) +* [[ModifyInstanceBasic](https://cloud.tencent.com/document/api/589/115192)](https://cloud.tencent.com/document/api/#/#) +* [[ModifyResource](https://cloud.tencent.com/document/api/589/115187)](https://cloud.tencent.com/document/api/#/#) +* [[ResizeDataDisks](https://cloud.tencent.com/document/api/589/115186)](https://cloud.tencent.com/document/api/#/#) +* [[SetNodeResourceConfigDefault](https://cloud.tencent.com/document/api/589/115190)](https://cloud.tencent.com/document/api/#/#) + +新增数据结构: + +* [[CBSInstance](https://cloud.tencent.com/document/api/589/33981#CBSInstance)](https://cloud.tencent.com/document/api/589/33981#[CBSInstance](https://cloud.tencent.com/document/api/589/33981#CBSInstance)) +* [[DescribeResourceConfig](https://cloud.tencent.com/document/api/589/33981#DescribeResourceConfig)](https://cloud.tencent.com/document/api/589/33981#[DescribeResourceConfig](https://cloud.tencent.com/document/api/589/33981#DescribeResourceConfig)) +* [[NodeResource](https://cloud.tencent.com/document/api/589/33981#NodeResource)](https://cloud.tencent.com/document/api/589/33981#[NodeResource](https://cloud.tencent.com/document/api/589/33981#NodeResource)) +* [[NodeSpecDiskV2](https://cloud.tencent.com/document/api/589/33981#NodeSpecDiskV2)](https://cloud.tencent.com/document/api/589/33981#[NodeSpecDiskV2](https://cloud.tencent.com/document/api/589/33981#NodeSpecDiskV2)) + +修改数据结构: + +* [SchedulerTaskDetail](https://cloud.tencent.com/document/api/589/33981#SchedulerTaskDetail) + + * <font color="#dd0000">**修改成员**:</font>JobId + +* [YarnApplication](https://cloud.tencent.com/document/api/589/33981#YarnApplication) + + * <font color="#dd0000">**修改成员**:</font>Id, User, Name, Queue, ApplicationType, ElapsedTime, State, FinalStatus, Progress, StartedTime, FinishedTime, AllocatedMB, AllocatedVCores, RunningContainers, MemorySeconds, VCoreSeconds, QueueUsagePercentage, ClusterUsagePercentage, PreemptedResourceMB, PreemptedResourceVCores, NumNonAMContainerPreempted, NumAMContainerPreempted, MapsTotal, MapsCompleted, ReducesTotal, ReducesCompleted, AvgMapTime, AvgReduceTime, AvgShuffleTime, AvgMergeTime, FailedReduceAttempts, KilledReduceAttempts, SuccessfulReduceAttempts, FailedMapAttempts, KilledMapAttempts, SuccessfulMapAttempts, GcTimeMillis, VCoreMillisMaps, MbMillisMaps, VCoreMillisReduces, MbMillisReduces, TotalLaunchedMaps, TotalLaunchedReduces, MapInputRecords, MapOutputRecords, ReduceInputRecords, ReduceOutputRecords, HDFSBytesWritten, HDFSBytesRead + + ### 第 85 次发布 发布时间:2024-12-24 01:32:22 @@ -69728,6 +70284,36 @@ ## 腾讯电子签企业版(ess) 版本:2020-11-11 +### 第 204 次发布 + +发布时间:2024-12-27 12:48:34 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [CreatePrepareFlow](https://cloud.tencent.com/document/api/1323/83412) + + * <font color="#dd0000">**修改入参**:</font>CcInfos + + +### 第 203 次发布 + +发布时间:2024-12-27 10:50:39 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [ApproverOption](https://cloud.tencent.com/document/api/1323/70369#ApproverOption) + + * 新增成员:ForbidAddSignDate + + ### 第 202 次发布 发布时间:2024-12-26 01:34:27 @@ -73557,6 +74143,21 @@ ## 腾讯电子签(基础版)(essbasic) 版本:2021-05-26 +### 第 204 次发布 + +发布时间:2024-12-27 11:11:25 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [ApproverOption](https://cloud.tencent.com/document/api/1420/61525#ApproverOption) + + * 新增成员:ForbidAddSignDate + + ### 第 203 次发布 发布时间:2024-12-26 01:35:17 @@ -84009,6 +84610,18 @@ ## 人脸识别(iai) 版本:2020-03-03 +### 第 11 次发布 + +发布时间:2024-12-27 11:13:24 + +本次发布包含了以下内容: + +改善已有的文档。 + +新增接口: + +* [DetectFaceSimilarity](https://cloud.tencent.com/document/api/867/114852) + ### 第 10 次发布 发布时间:2024-11-14 01:41:32 @@ -86831,6 +87444,21 @@ ## 物联网开发平台(iotexplorer) 版本:2019-04-23 +### 第 89 次发布 + +发布时间:2024-12-27 11:13:42 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [TWeCallActiveInfo](https://cloud.tencent.com/document/api/1081/34988#TWeCallActiveInfo) + + * 新增成员:PkgType + + ### 第 88 次发布 发布时间:2024-12-18 16:59:09 @@ -91942,6 +92570,25 @@ ## 云数据库 KeeWiDB(keewidb) 版本:2022-03-08 +### 第 7 次发布 + +发布时间:2024-12-27 11:14:33 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [TaskInfoDetail](https://cloud.tencent.com/document/api/1520/86230#TaskInfoDetail) + + * <font color="#dd0000">**修改成员**:</font>OperatorUin + +* [TradeDealDetail](https://cloud.tencent.com/document/api/1520/86230#TradeDealDetail) + + * <font color="#dd0000">**修改成员**:</font>DealId, DealName, ZoneId, GoodsNum, Creater, CreatTime, OverdueTime, EndTime, Status, Description, Price, InstanceIds + + ### 第 6 次发布 发布时间:2024-12-23 01:41:18 @@ -95106,6 +95753,38 @@ ## 云直播CSS(live) 版本:2018-08-01 +### 第 139 次发布 + +发布时间:2024-12-27 11:14:50 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [CreateLiveStreamMonitor](https://cloud.tencent.com/document/api/267/93521) + + * 新增入参:CasterId, PullPushTaskId + + +修改数据结构: + +* [LiveStreamMonitorInfo](https://cloud.tencent.com/document/api/267/20474#LiveStreamMonitorInfo) + + * 新增成员:CasterId, PullPushTaskId + +* [LiveStreamMonitorInputInfo](https://cloud.tencent.com/document/api/267/20474#LiveStreamMonitorInputInfo) + + * 新增成员:CasterInputIndex, NeedMonitor + +* [MPSResult](https://cloud.tencent.com/document/api/267/20474#MPSResult) + + * 新增成员:StreamQuaCtrlResults + + * <font color="#dd0000">**修改成员**:</font>AiAsrResults, AiOcrResults + + ### 第 138 次发布 发布时间:2024-12-24 01:43:12 @@ -100446,6 +101125,20 @@ ## 多网聚合加速(mna) 版本:2021-01-19 +### 第 24 次发布 + +发布时间:2024-12-30 01:46:00 + +本次发布包含了以下内容: + +改善已有的文档。 + +<font color="#dd0000">**预下线接口**:</font> + +* CreateQos +* DeleteQos +* DescribeQos + ### 第 23 次发布 发布时间:2024-08-23 01:55:12 @@ -104443,6 +105136,21 @@ ## 媒体处理(mps) 版本:2019-06-12 +### 第 107 次发布 + +发布时间:2024-12-30 01:47:47 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [SegmentRecognitionItem](https://cloud.tencent.com/document/api/862/37615#SegmentRecognitionItem) + + * 新增成员:AudioUrl, AudioBeginTime, AudioEndTime, PersonPositionUrl + + ### 第 106 次发布 发布时间:2024-12-24 01:47:28 @@ -110378,6 +111086,70 @@ ## 流计算 Oceanus(oceanus) 版本:2019-04-22 +### 第 66 次发布 + +发布时间:2024-12-30 01:49:42 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [CreateJobConfig](https://cloud.tencent.com/document/api/849/52004) + + * 新增入参:JobManagerCpu, JobManagerMem, TaskManagerCpu, TaskManagerMem + +* [DescribeResources](https://cloud.tencent.com/document/api/849/54668) + + * 新增入参:SystemResource + +* [DescribeSystemResources](https://cloud.tencent.com/document/api/849/51999) + + * 新增入参:WorkSpaceId + + +修改数据结构: + +* [Cluster](https://cloud.tencent.com/document/api/849/52010#Cluster) + + * 新增成员:TotalCpu, TotalMem, RunningCpu, RunningMem + +* [ClusterGroupSetItem](https://cloud.tencent.com/document/api/849/52010#ClusterGroupSetItem) + + * 新增成员:TotalCpu, TotalMem, RunningCpu, RunningMem + +* [JobConfig](https://cloud.tencent.com/document/api/849/52010#JobConfig) + + * 新增成员:JobManagerCpu, JobManagerMem, TaskManagerCpu, TaskManagerMem, JobConfigItem + +* [ResourceItem](https://cloud.tencent.com/document/api/849/52010#ResourceItem) + + * 新增成员:Connector, ConnectorVersion, ConnectionMethod, RelatedResourceId, Icon, ConnectorName, ConnectorUrl + + * <font color="#dd0000">**修改成员**:</font>ResourceId, Name, ResourceType, ResourceLoc, Region, AppId, OwnerUin, CreatorUin, CreateTime, UpdateTime, LatestResourceConfigVersion, Remark, VersionCount, RefJobCount, IsJobRun, FileName, WorkSpaceId, RefJobStatusCountSet + +* [ResourceRefDetail](https://cloud.tencent.com/document/api/849/52010#ResourceRefDetail) + + * 新增成员:Connector + +* [SqlGatewayItem](https://cloud.tencent.com/document/api/849/52010#SqlGatewayItem) + + * 新增成员:Cpu, Mem + +* [SubEks](https://cloud.tencent.com/document/api/849/52010#SubEks) + + * 新增成员:TotalCpu, TotalMem, RunningCpu, RunningMem + +* [SystemResourceItem](https://cloud.tencent.com/document/api/849/52010#SystemResourceItem) + + * 新增成员:SystemProvide + +* [TreeJobSets](https://cloud.tencent.com/document/api/849/52010#TreeJobSets) + + * 新增成员:ScalingType, RunningCpu, RunningMem + + ### 第 65 次发布 发布时间:2024-11-28 01:23:56 @@ -111672,6 +112444,21 @@ ## 文字识别(ocr) 版本:2018-11-19 +### 第 165 次发布 + +发布时间:2024-12-27 11:17:11 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [VatElectronicInfo](https://cloud.tencent.com/document/api/866/33527#VatElectronicInfo) + + * 新增成员:TotalCnMark, TotalMark, PretaxAmountMark, TaxMark, CompanySealMark + + ### 第 164 次发布 发布时间:2024-12-23 01:49:23 @@ -124096,6 +124883,44 @@ ## 云数据库 SQL Server(sqlserver) 版本:2018-03-28 +### 第 67 次发布 + +发布时间:2024-12-27 11:18:44 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [DescribeInstanceTradeParameter](https://cloud.tencent.com/document/api/238/101748) + + * 新增入参:MultiNodes, DrZones + + +修改数据结构: + +* [AccountCreateInfo](https://cloud.tencent.com/document/api/238/19976#AccountCreateInfo) + + * 新增成员:EncryptedVersion + +* [AccountPassword](https://cloud.tencent.com/document/api/238/19976#AccountPassword) + + * 新增成员:EncryptedVersion + +* [DBInstance](https://cloud.tencent.com/document/api/238/19976#DBInstance) + + * 新增成员:MultiSlaveZones + +* [DrReadableInfo](https://cloud.tencent.com/document/api/238/19976#DrReadableInfo) + + * 新增成员:DrInstanceId, Zone, RoWeight, ReadMode + +* [SlaveZones](https://cloud.tencent.com/document/api/238/19976#SlaveZones) + + * 新增成员:DrInstanceId + + ### 第 66 次发布 发布时间:2024-12-26 01:56:11 @@ -126137,6 +126962,40 @@ ## SSL 证书(ssl) 版本:2019-12-05 +### 第 74 次发布 + +发布时间:2024-12-30 01:56:22 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [ClbListener](https://cloud.tencent.com/document/api/400/41679#ClbListener) + + * <font color="#dd0000">**修改成员**:</font>NoMatchDomains + +* [UpdateRecordDetails](https://cloud.tencent.com/document/api/400/41679#UpdateRecordDetails) + + * <font color="#dd0000">**修改成员**:</font>TotalCount + + +### 第 73 次发布 + +发布时间:2024-12-27 11:19:42 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [TeoInstanceDetail](https://cloud.tencent.com/document/api/400/41679#TeoInstanceDetail) + + * <font color="#dd0000">**修改成员**:</font>ZoneId, Status + + ### 第 72 次发布 发布时间:2024-12-17 01:51:36 @@ -133504,6 +134363,21 @@ ## 容器镜像服务(tcr) 版本:2019-09-24 +### 第 69 次发布 + +发布时间:2024-12-27 11:21:21 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [ReplicationRule](https://cloud.tencent.com/document/api/1141/41603#ReplicationRule) + + * 新增成员:Deletion + + ### 第 68 次发布 发布时间:2024-12-06 01:29:26 @@ -137709,6 +138583,25 @@ ## 消息队列 TDMQ(tdmq) 版本:2020-02-17 +### 第 134 次发布 + +发布时间:2024-12-30 01:59:55 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [CreateTopic](https://cloud.tencent.com/document/api/1179/46088) + + * 新增入参:UnackPolicy + +* [ModifyTopic](https://cloud.tencent.com/document/api/1179/46085) + + * 新增入参:UnackPolicy + + ### 第 133 次发布 发布时间:2024-12-25 14:28:45 @@ -140780,6 +141673,37 @@ ## 弹性微服务(tem) 版本:2021-07-01 +### 第 47 次发布 + +发布时间:2024-12-30 02:00:58 + +本次发布包含了以下内容: + +改善已有的文档。 + +<font color="#dd0000">**预下线接口**:</font> + +* ModifyIngress + +修改数据结构: + +* [DescribeRunPodPage](https://cloud.tencent.com/document/api/1371/60171#DescribeRunPodPage) + + * <font color="#dd0000">**修改成员**:</font>Offset, Limit, TotalCount, RequestId, PodList + +* [NodeInfo](https://cloud.tencent.com/document/api/1371/60171#NodeInfo) + + * <font color="#dd0000">**修改成员**:</font>Name, Zone, SubnetId, AvailableIpCount, Cidr + +* [RunVersionPod](https://cloud.tencent.com/document/api/1371/60171#RunVersionPod) + + * <font color="#dd0000">**修改成员**:</font>Webshell, PodId, Status, CreateTime, PodIp, Zone, DeployVersion, RestartCount, Ready, ContainerState, NodeInfo, StartTime, Unhealthy, UnhealthyWarningMsg, VersionId, ApplicationName + +* [WorkloadInfo](https://cloud.tencent.com/document/api/1371/60171#WorkloadInfo) + + * <font color="#dd0000">**修改成员**:</font>ClusterId, ApplicationName, VersionName, ReadyReplicas, Replicas, UpdatedReplicas, UpdatedReadyReplicas, UpdateRevision, CurrentRevision + + ### 第 46 次发布 发布时间:2024-11-01 02:08:02 @@ -150174,6 +151098,27 @@ ## 容器服务(tke) 版本:2018-05-25 +### 第 188 次发布 + +发布时间:2024-12-30 02:02:56 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [Addon](https://cloud.tencent.com/document/api/457/31866#Addon) + + * 新增成员:CreateTime + + * <font color="#dd0000">**修改成员**:</font>AddonName, AddonVersion, RawValues, Phase, Reason + +* [Switch](https://cloud.tencent.com/document/api/457/31866#Switch) + + * <font color="#dd0000">**修改成员**:</font>MasterLog + + ### 第 187 次发布 发布时间:2024-11-27 01:28:41 @@ -158019,6 +158964,36 @@ ## 微服务引擎(tse) 版本:2020-12-07 +### 第 84 次发布 + +发布时间:2024-12-30 02:05:51 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改接口: + +* [DescribeGovernanceNamespaces](https://cloud.tencent.com/document/api/1364/104406) + + * 新增入参:SyncToGlobalRegistry + +* [DescribeGovernanceServices](https://cloud.tencent.com/document/api/1364/104380) + + * 新增入参:SyncToGlobalRegistry + + +修改数据结构: + +* [GovernanceNamespace](https://cloud.tencent.com/document/api/1364/54942#GovernanceNamespace) + + * 新增成员:ServiceExportTo + +* [GovernanceNamespaceInput](https://cloud.tencent.com/document/api/1364/54942#GovernanceNamespaceInput) + + * 新增成员:ServiceExportTo + + ### 第 83 次发布 发布时间:2024-12-25 02:08:01 @@ -169501,6 +170476,40 @@ ## 私有网络(vpc) 版本:2017-03-12 +### 第 236 次发布 + +发布时间:2024-12-30 02:10:17 + +本次发布包含了以下内容: + +改善已有的文档。 + +修改数据结构: + +* [CustomerGateway](https://cloud.tencent.com/document/api/215/15824#CustomerGateway) + + * <font color="#dd0000">**修改成员**:</font>BgpAsn + + +### 第 235 次发布 + +发布时间:2024-12-27 11:25:22 + +本次发布包含了以下内容: + +改善已有的文档。 + +新增接口: + +* [InquiryPriceAllocateAddresses](https://cloud.tencent.com/document/api/215/114855) +* [InquiryPriceModifyAddressesBandwidth](https://cloud.tencent.com/document/api/215/114854) +* [InquiryPriceRenewAddresses](https://cloud.tencent.com/document/api/215/114853) + +新增数据结构: + +* [InternetPrice](https://cloud.tencent.com/document/api/215/15824#InternetPrice) +* [InternetPriceDetail](https://cloud.tencent.com/document/api/215/15824#InternetPriceDetail) + ### 第 234 次发布 发布时间:2024-12-19 02:11:29 @@ -174989,6 +175998,25 @@ ## Web 应用防火墙(waf) 版本:2018-01-25 +### 第 104 次发布 + +发布时间:2024-12-27 11:44:13 + +本次发布包含了以下内容: + +改善已有的文档。 + +新增接口: + +* [CreateAreaBanRule](https://cloud.tencent.com/document/api/627/114858) +* [DescribeAreaBanRule](https://cloud.tencent.com/document/api/627/114857) +* [ModifyAreaBanRule](https://cloud.tencent.com/document/api/627/114856) + +新增数据结构: + +* [Area](https://cloud.tencent.com/document/api/627/53609#Area) +* [AreaBanRule](https://cloud.tencent.com/document/api/627/53609#AreaBanRule) + ### 第 103 次发布 发布时间:2024-11-18 02:11:35 diff --git a/products.md b/products.md index 6eef88dc96..3f3d79d0c9 100644 --- a/products.md +++ b/products.md @@ -16,16 +16,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-12-26 01:10:06 | -| as | [弹性伸缩](https://cloud.tencent.com/document/product/377) | 2024-12-02 01:07:50 | +| apm | [应用性能监控](https://cloud.tencent.com/document/product/1463) | 2024-12-30 01:09:55 | +| as | [弹性伸缩](https://cloud.tencent.com/document/product/377) | 2024-12-30 01:10:05 | | 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-12-19 01:10:53 | -| batch | [批量计算](https://cloud.tencent.com/document/product/599) | 2024-12-25 01:11:07 | +| batch | [批量计算](https://cloud.tencent.com/document/product/599) | 2024-12-27 10:51:28 | | 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-12-20 01:07:23 | -| billing | [费用中心](https://cloud.tencent.com/document/product/555) | 2024-12-18 17:13:22 | +| billing | [费用中心](https://cloud.tencent.com/document/product/555) | 2024-12-27 10:52:13 | | 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 | @@ -37,24 +37,24 @@ | 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-20 01:08:55 | +| cam | [访问管理](https://cloud.tencent.com/document/product/598) | 2024-12-27 10:52:43 | | 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 | +| car | [应用云渲染](https://cloud.tencent.com/document/product/1547) | 2024-12-27 10:53:11 | | 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-12-20 01:10:00 | -| cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2024-12-26 01:14:34 | +| cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2024-12-30 01:14:22 | | 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 | | cdwch | [腾讯云数据仓库TCHouse-C](https://cloud.tencent.com/document/product/1299) | 2024-12-24 01:16:40 | -| cdwdoris | [腾讯云数据仓库 TCHouse-D](https://cloud.tencent.com/document/product/1387) | 2024-12-26 01:17:01 | +| cdwdoris | [腾讯云数据仓库 TCHouse-D](https://cloud.tencent.com/document/product/1387) | 2024-12-27 10:54:32 | | 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-20 01:13:12 | +| cfg | [混沌演练平台](https://cloud.tencent.com/document/product/1500) | 2024-12-27 10:54:56 | | cfs | [文件存储](https://cloud.tencent.com/document/product/582) | 2024-12-24 01:17:32 | | cfw | [云防火墙](https://cloud.tencent.com/document/product/1132) | 2024-12-09 11:19:12 | -| chdfs | [云 HDFS](https://cloud.tencent.com/document/product/1105) | 2024-12-26 01:18:37 | +| chdfs | [云 HDFS](https://cloud.tencent.com/document/product/1105) | 2024-12-27 10:55:07 | | ciam | [账号风控平台](https://cloud.tencent.com/document/product/1441) | 2024-10-28 01:19:38 | | cii | [智能保险助手](https://cloud.tencent.com/document/product/1368) | 2023-05-18 01:12:07 | | cim | [](https://cloud.tencent.com/document/product) | 2019-05-16 17:21:18 | @@ -64,24 +64,24 @@ | cloudapp | [云应用](https://cloud.tencent.com/document/product/1689) | 2024-12-25 01:20:35 | | cloudaudit | [操作审计](https://cloud.tencent.com/document/product/629) | 2024-12-25 01:20:38 | | 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-12-20 01:16:11 | -| cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2024-12-25 01:21:03 | +| cloudstudio | [Cloud Studio(云端 IDE)](https://cloud.tencent.com/document/product/1039) | 2024-12-27 10:55:16 | +| cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2024-12-27 11:03:22 | | cme | [多媒体创作引擎](https://cloud.tencent.com/document/product/1156) | 2024-09-25 01:13:30 | -| cmq | [消息队列 CMQ](https://cloud.tencent.com/document/product/406) | 2024-11-07 01:22:53 | +| cmq | [消息队列 CMQ](https://cloud.tencent.com/document/product/406) | 2024-12-30 01:21:08 | | cms | [内容安全](https://cloud.tencent.com/document/product/669) | 2024-06-20 01:24:47 | | config | [配置审计](https://cloud.tencent.com/document/product/1579) | 2024-12-25 01:22:32 | | controlcenter | [控制中心](https://cloud.tencent.com/document/product/1708) | 2024-10-24 01:13:25 | | cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2023-09-21 02:09:54 | | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2024-12-26 18:44:26 | | 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-19 01:22:59 | -| cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-12-17 01:18:39 | +| cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2024-12-27 11:35:31 | +| cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-12-27 11:04:23 | | 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-26 01:25:16 | +| cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2024-12-30 01:25:19 | | 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 | -| dbbrain | [数据库智能管家 DBbrain](https://cloud.tencent.com/document/product/1130) | 2024-12-26 01:26:56 | +| dbbrain | [数据库智能管家 DBbrain](https://cloud.tencent.com/document/product/1130) | 2024-12-30 01:26:32 | | dbdc | [云数据库独享集群](https://cloud.tencent.com/document/product/1322) | 2024-11-27 01:14:54 | | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2024-12-26 01:27:35 | | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2024-12-25 01:27:55 | @@ -92,26 +92,26 @@ | ds | [文档服务](https://cloud.tencent.com/document/product/869) | 2024-03-20 01:15:13 | | dsgc | [数据安全治理中心](https://cloud.tencent.com/document/product/1087) | 2024-12-20 16:58:37 | | dtf | [分布式事务](https://cloud.tencent.com/document/product/1224) | 2022-04-04 06:38:57 | -| dts | [数据传输服务](https://cloud.tencent.com/document/product/571) | 2024-12-26 01:31:15 | +| dts | [数据传输服务](https://cloud.tencent.com/document/product/571) | 2024-12-27 11:10:08 | | eb | [事件总线](https://cloud.tencent.com/document/product/1359) | 2024-12-26 01:31:46 | | ecc | [英文作文批改](https://cloud.tencent.com/document/product/1076) | 2024-09-05 01:32:54 | | ecdn | [全站加速网络](https://cloud.tencent.com/document/product/570) | 2024-10-22 01:18:29 | -| ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2024-12-26 01:32:12 | +| ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2024-12-30 01:31:32 | | eiam | [数字身份管控平台(员工版)](https://cloud.tencent.com/document/product/1442) | 2024-06-25 01:14:34 | | 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-24 01:32:22 | +| emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2024-12-30 01:32:38 | | 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-26 17:01:50 | -| essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2024-12-26 01:35:17 | +| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-12-30 01:33:53 | +| essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2024-12-27 11:11:25 | | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2024-12-26 01:36:01 | -| faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-12-17 01:30:37 | +| faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-12-27 11:12:08 | | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2024-12-25 01:36:47 | | ft | [人像变换](https://cloud.tencent.com/document/product/1202) | 2024-11-21 01:34:23 | -| gaap | [全球应用加速](https://cloud.tencent.com/document/product/608) | 2024-12-26 01:36:32 | +| gaap | [全球应用加速](https://cloud.tencent.com/document/product/608) | 2024-12-30 01:35:52 | | gme | [游戏多媒体引擎](https://cloud.tencent.com/document/product/607) | 2024-11-20 01:39:48 | | goosefs | [数据加速器 GooseFS](https://cloud.tencent.com/document/product/1424) | 2024-11-28 01:18:42 | | 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 | +| gs | [云游戏](https://cloud.tencent.com/document/product/1162) | 2024-12-27 11:13:19 | | gse | [游戏服务器伸缩](https://cloud.tencent.com/document/product/1165) | 2022-07-11 06:12:44 | | 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 | @@ -119,7 +119,7 @@ | 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-26 01:37:46 | -| iai | [人脸识别](https://cloud.tencent.com/document/product/867) | 2024-11-26 01:18:52 | +| iai | [人脸识别](https://cloud.tencent.com/document/product/867) | 2024-12-27 11:13:24 | | 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 | | icr | [对话机器人](https://cloud.tencent.com/document/product/1268) | 2024-04-22 01:17:48 | @@ -131,18 +131,18 @@ | ioa | [iOA 零信任安全管理系统](https://cloud.tencent.com/document/product/1092) | 2024-11-11 01:39:45 | | iot | [加速物联网套件](https://cloud.tencent.com/document/product/568) | 2023-07-17 01:22:28 | | iotcloud | [物联网通信](https://cloud.tencent.com/document/product/634) | 2024-06-05 01:47:50 | -| iotexplorer | [物联网开发平台](https://cloud.tencent.com/document/product/1081) | 2024-12-18 16:59:09 | +| iotexplorer | [物联网开发平台](https://cloud.tencent.com/document/product/1081) | 2024-12-27 11:13:42 | | iottid | [物联网设备身份认证](https://cloud.tencent.com/document/product/1086) | 2023-05-18 01:33:02 | | iotvideo | [物联网智能视频服务](https://cloud.tencent.com/document/product/1131) | 2024-12-17 01:35:29 | | iotvideoindustry | [物联网智能视频服务(行业版)](https://cloud.tencent.com/document/product/1361) | 2024-03-20 01:18:54 | | irp | [智能推荐平台](https://cloud.tencent.com/document/product/1541) | 2024-10-17 01:22:29 | | iss | [智能视图计算平台](https://cloud.tencent.com/document/product/1344) | 2024-12-24 01:40:55 | | ivld | [媒体智能标签](https://cloud.tencent.com/document/product/1509) | 2024-12-16 01:41:44 | -| keewidb | [云数据库 KeeWiDB](https://cloud.tencent.com/document/product/1520) | 2024-12-23 01:41:18 | +| keewidb | [云数据库 KeeWiDB](https://cloud.tencent.com/document/product/1520) | 2024-12-30 01:41:59 | | kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2024-11-07 01:44:48 | | lcic | [实时互动-教育版](https://cloud.tencent.com/document/product/1639) | 2024-12-26 01:43:11 | | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2024-12-26 01:43:38 | -| live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2024-12-26 01:44:14 | +| live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2024-12-27 11:14:50 | | 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 @@ | memcached | [云数据库Memcached](https://cloud.tencent.com/document/product/241) | 2024-12-16 01:45:51 | | 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 | +| mna | [多网聚合加速](https://cloud.tencent.com/document/product/1385) | 2024-12-30 01:46:00 | | mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2024-12-26 01:47:15 | | monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2024-12-23 01:46:05 | -| mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2024-12-24 01:47:28 | +| mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2024-12-30 01:47:47 | | 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 | @@ -163,8 +163,8 @@ | mvj | [营销价值判断](https://cloud.tencent.com/document/product) | 2020-03-19 08:11:44 | | 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-26 01:50:51 | +| oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2024-12-30 01:49:42 | +| ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2024-12-27 11:17:11 | | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2024-12-25 01:52:29 | | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2024-12-20 01:46:38 | | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2024-11-22 12:03:22 | @@ -186,9 +186,9 @@ | sms | [短信](https://cloud.tencent.com/document/product/382) | 2024-12-26 16:48:49 | | soe | [智聆口语评测](https://cloud.tencent.com/document/product/884) | 2024-11-13 02:01:41 | | solar | [智汇零售](https://cloud.tencent.com/document/product) | 2020-03-19 08:01:59 | -| sqlserver | [云数据库 SQL Server](https://cloud.tencent.com/document/product/238) | 2024-12-26 01:56:11 | +| sqlserver | [云数据库 SQL Server](https://cloud.tencent.com/document/product/238) | 2024-12-30 01:55:25 | | ssa | [安全运营中心](https://cloud.tencent.com/document/product/664) | 2023-11-15 02:18:28 | -| ssl | [SSL 证书](https://cloud.tencent.com/document/product/400) | 2024-12-23 01:55:45 | +| ssl | [SSL 证书](https://cloud.tencent.com/document/product/400) | 2024-12-30 01:56:22 | | sslpod | [证书监控 SSLPod](https://cloud.tencent.com/document/product/1084) | 2024-03-20 01:24:03 | | ssm | [凭据管理系统](https://cloud.tencent.com/document/product/1140) | 2024-11-08 02:01:05 | | sts | [安全凭证服务](https://cloud.tencent.com/document/product/1312) | 2024-12-11 01:57:49 | @@ -198,23 +198,23 @@ | tan | [碳引擎](https://cloud.tencent.com/document/product/1498) | 2024-03-20 01:24:15 | | tat | [自动化助手](https://cloud.tencent.com/document/product/1340) | 2024-11-22 12:09:41 | | tav | [文件检测](https://cloud.tencent.com/document/product) | 2019-11-28 22:10:04 | -| tbaas | [腾讯云区块链服务平台 TBaaS](https://cloud.tencent.com/document/product/663) | 2024-12-26 01:58:32 | +| tbaas | [腾讯云区块链服务平台 TBaaS](https://cloud.tencent.com/document/product/663) | 2024-12-27 11:20:26 | | tbm | [](https://cloud.tencent.com/document/product) | 2019-03-29 14:49:11 | | tbp | [腾讯智能对话平台](https://cloud.tencent.com/document/product/1060) | 2024-03-20 01:24:24 | | tcaplusdb | [游戏数据库 TcaplusDB](https://cloud.tencent.com/document/product/596) | 2024-08-05 02:05:20 | -| tcb | [云开发 CloudBase](https://cloud.tencent.com/document/product/876) | 2024-12-24 01:57:49 | +| tcb | [云开发 CloudBase](https://cloud.tencent.com/document/product/876) | 2024-12-27 11:20:42 | | tcbr | [云托管 CloudBase Run](https://cloud.tencent.com/document/product/1243) | 2024-12-17 01:54:06 | | tcex | [腾讯云释义](https://cloud.tencent.com/document/product/1266) | 2022-07-21 06:17:29 | | tchd | [腾讯云健康看板](https://cloud.tencent.com/document/product/1688) | 2024-11-21 02:00:04 | | tci | [腾讯智学课堂分析](https://cloud.tencent.com/document/product) | 2020-08-24 08:06:03 | -| tcm | [服务网格](https://cloud.tencent.com/document/product/1261) | 2024-06-18 02:13:19 | -| tcr | [容器镜像服务](https://cloud.tencent.com/document/product/1141) | 2024-12-06 01:29:26 | +| tcm | [服务网格](https://cloud.tencent.com/document/product/1261) | 2024-12-30 01:58:54 | +| tcr | [容器镜像服务](https://cloud.tencent.com/document/product/1141) | 2024-12-27 11:21:21 | | 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-12-19 02:00:31 | -| tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2024-12-25 14:28:45 | +| tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2024-12-30 01:59:55 | | 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 | +| tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2024-12-30 02:00:58 | | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-12-23 11:33:37 | | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2024-12-23 02:01:00 | | tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 | @@ -233,13 +233,13 @@ | 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-25 13:04:28 | | 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 | +| trro | [远程实时操控](https://cloud.tencent.com/document/product/1584) | 2024-12-27 11:23:20 | | trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2024-12-10 02:04:51 | -| tse | [微服务引擎](https://cloud.tencent.com/document/product/1364) | 2024-12-25 02:08:01 | -| tsf | [微服务平台 TSF](https://cloud.tencent.com/document/product/649) | 2024-12-26 02:07:14 | +| tse | [微服务引擎](https://cloud.tencent.com/document/product/1364) | 2024-12-30 02:05:51 | +| tsf | [微服务平台 TSF](https://cloud.tencent.com/document/product/649) | 2024-12-30 02:06:44 | | tsi | [腾讯同传系统](https://cloud.tencent.com/document/product/1399) | 2024-10-23 01:36:51 | | tsw | [微服务观测平台 TSW](https://cloud.tencent.com/document/product/1311) | 2024-03-20 01:30:06 | -| tts | [语音合成](https://cloud.tencent.com/document/product/1073) | 2024-12-03 01:32:15 | +| tts | [语音合成](https://cloud.tencent.com/document/product/1073) | 2024-12-27 11:25:13 | | ump | [客流数字化平台](https://cloud.tencent.com/document/product/1320) | 2024-03-20 01:30:08 | | vcg | [视频生成](https://cloud.tencent.com/document/product/1770) | 2024-11-22 12:20:45 | | vclm | [大模型视频创作引擎](https://cloud.tencent.com/document/product/1616) | 2024-12-25 02:10:30 | @@ -248,10 +248,10 @@ | 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-26 02:10:54 | +| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2024-12-30 02:10:17 | | 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 | +| waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2024-12-27 11:44:13 | | 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-19 02:14:02 | | weilingwith | [微瓴同业开放平台](https://cloud.tencent.com/document/product/1693) | 2024-11-07 02:23:06 | diff --git a/pyproject.toml b/pyproject.toml index 66aa1aac1d..e3e697cc91 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ exclude = ["tccli/examples"] [project] name = "tccli" -version = "3.0.1240.1" +version = "3.0.1241.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.1240", + "tencentcloud-sdk-python>=3.0.1241", ] [project.urls] diff --git a/tccli/__init__.py b/tccli/__init__.py index ae61b8b061..62e3d6f67d 100644 --- a/tccli/__init__.py +++ b/tccli/__init__.py @@ -1 +1 @@ -__version__ = '3.0.1240.1' +__version__ = '3.0.1241.1' diff --git a/tccli/examples/apm/v20210622/CreateApmInstance.md b/tccli/examples/apm/v20210622/CreateApmInstance.md index caeacfd421..37975bc635 100644 --- a/tccli/examples/apm/v20210622/CreateApmInstance.md +++ b/tccli/examples/apm/v20210622/CreateApmInstance.md @@ -1,12 +1,12 @@ -**Example 1: 创建APM实例** +**Example 1: 创建 APM 业务系统** -创建APM实例 +创建 APM 业务系统 Input: ``` tccli apm CreateApmInstance --cli-unfold-argument \ - --Name 云监控-测试 \ + --Name 可观测-测试 \ --Description 测试环境 \ --Tags.0.Key appid \ --Tags.0.Value 123123422 @@ -16,7 +16,7 @@ Output: ``` { "Response": { - "InstanceId": "sSBebnOhf", + "InstanceId": "apm-CVfliqa8U", "RequestId": "49fktc24elkfi4a1mkyir-9t2pt2stlx" } } diff --git a/tccli/examples/apm/v20210622/DescribeApmAgent.md b/tccli/examples/apm/v20210622/DescribeApmAgent.md index d834304e81..14cd5a3b47 100644 --- a/tccli/examples/apm/v20210622/DescribeApmAgent.md +++ b/tccli/examples/apm/v20210622/DescribeApmAgent.md @@ -1,4 +1,4 @@ -**Example 1: 获取Apm Agent信息** +**Example 1: 获取 APM Agent信息** diff --git a/tccli/examples/apm/v20210622/DescribeGeneralMetricData.md b/tccli/examples/apm/v20210622/DescribeGeneralMetricData.md index fc4e0a77f4..2f92a2ab14 100644 --- a/tccli/examples/apm/v20210622/DescribeGeneralMetricData.md +++ b/tccli/examples/apm/v20210622/DescribeGeneralMetricData.md @@ -1,6 +1,6 @@ **Example 1: 查询1分钟聚合粒度的 service_metric 指标数据示例** -该示例查询实例为 apm-059oXBfTL,按照 service.name(服务名)、span.kind(客户端/服务端视角)为维度过滤,以 service.name(服务名)、span.kind(客户端/服务端视角)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 request_count(请求数量)、error_request_count(错误请求数量)、duration_avg(平均响应时间)、slow_request_count(慢请求数量)、duration_p50(耗时 p50)的指标数据。 +该示例查询业务系统为 apm-059oXBfTL,按照 service.name(应用名)、span.kind(客户端/服务端视角)为维度过滤,以 service.name(应用名)、span.kind(客户端/服务端视角)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 request_count(请求数量)、error_request_count(错误请求数量)、duration_avg(平均响应时间)、slow_request_count(慢请求数量)、duration_p50(耗时 p50)的指标数据。 Input: @@ -722,7 +722,7 @@ Output: **Example 2: 查询起始到终止时间内统计 service_metric 指标数据示例** -该示例查询实例为 apm-059oXBfTL,按照 service.name(服务名)、span.kind(客户端/服务端视角)为维度过滤,以 service.name(服务名)、span.kind(客户端/服务端视角)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 request_count(请求数量)、error_request_count(错误请求数量)、duration_avg(平均响应时间)、slow_request_count(慢请求数量)、duration_p50(耗时 p50)的指标数据。 +该示例查询业务系统为 apm-059oXBfTL,按照 service.name(应用名)、span.kind(客户端/服务端视角)为维度过滤,以 service.name(应用名)、span.kind(客户端/服务端视角)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 request_count(请求数量)、error_request_count(错误请求数量)、duration_avg(平均响应时间)、slow_request_count(慢请求数量)、duration_p50(耗时 p50)的指标数据。 Input: @@ -843,7 +843,7 @@ Output: **Example 3: 查询1分钟聚合粒度的 sql_metric 指标数据示例** -该示例查询实例为 apm-059oXBfTL,按照 service.name(服务名)为维度过滤,以 service.name(服务名)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 error_request_count(错误请求数量)、duration_avg(平均响应时间)的指标数据。 +该示例查询业务系统为 apm-059oXBfTL,按照 service.name(应用名)为维度过滤,以 service.name(应用名)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 error_request_count(错误请求数量)、duration_avg(平均响应时间)的指标数据。 Input: @@ -1141,7 +1141,7 @@ Output: **Example 4: 查询起始到终止时间内统计 sql_metric 的 duration_avg(耗时时间)指标数据示例** -该示例查询实例为apm-059oXBfTL,按照 db.instance(数据库名称)为维度过滤,以 service.name(服务名)、db.statement(执行语句)为维度进行聚合,查找开始时间-终止时间内 top5 的 duration_avg(耗时(ms))的指标数据。 +该示例查询业务系统为apm-059oXBfTL,按照 db.instance(数据库名称)为维度过滤,以 service.name(应用名)、db.statement(执行语句)为维度进行聚合,查找开始时间-终止时间内 top5 的 duration_avg(耗时(ms))的指标数据。 Input: diff --git a/tccli/examples/apm/v20210622/DescribeGeneralSpanList.md b/tccli/examples/apm/v20210622/DescribeGeneralSpanList.md index d397fea755..a5c1993924 100644 --- a/tccli/examples/apm/v20210622/DescribeGeneralSpanList.md +++ b/tccli/examples/apm/v20210622/DescribeGeneralSpanList.md @@ -6,8 +6,8 @@ Input: ``` tccli apm DescribeGeneralSpanList --cli-unfold-argument \ - --OrderBy.Value xx \ - --OrderBy.Key xx \ + --OrderBy.Value startTime \ + --OrderBy.Key desc \ --Filters.0.Key traceID \ --Filters.0.Type in \ --Filters.0.Value 663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac \ @@ -22,51 +22,51 @@ Output: { "Response": { "TotalCount": 0, - "RequestId": "xx", + "RequestId": "test-test-test", "Spans": [ { - "TraceID": "xx", + "TraceID": "663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac", "Logs": [ { "Timestamp": 0, "Fields": [ { - "Type": "xx", - "Value": "xx", - "Key": "xx" + "Type": "service.name", + "Value": "=", + "Key": "java-order-service" } ] } ], "Tags": [ { - "Type": "xx", - "Value": "xx", - "Key": "xx" + "Type": "service.name", + "Value": "=", + "Key": "java-order-service" } ], "Process": { - "ServiceName": "xx", + "ServiceName": "java-order-service", "Tags": [ { - "Type": "xx", - "Value": "xx", - "Key": "xx" + "Type": "service.name", + "Value": "=", + "Key": "java-order-service" } ] }, "Timestamp": 0, - "OperationName": "xx", + "OperationName": "/test", "References": [ { - "RefType": "xx", - "SpanID": "xx", - "TraceID": "xx" + "RefType": "1", + "SpanID": "4q6549c49aaa", + "TraceID": "663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac" } ], "StartTime": 0, "Duration": 0, - "SpanID": "xx", + "SpanID": "1q23w1q32165", "StartTimeMillis": 0 } ] @@ -82,8 +82,8 @@ Input: ``` tccli apm DescribeGeneralSpanList --cli-unfold-argument \ - --OrderBy.Value xx \ - --OrderBy.Key xx \ + --OrderBy.Value startTime \ + --OrderBy.Key desce \ --Filters.0.Key pulsar:sub_name \ --Filters.0.Type = \ --Filters.0.Value participants \ @@ -99,51 +99,51 @@ Output: { "Response": { "TotalCount": 0, - "RequestId": "xx", + "RequestId": "test-test-test", "Spans": [ { - "TraceID": "xx", + "TraceID": "663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac", "Logs": [ { "Timestamp": 0, "Fields": [ { - "Type": "xx", - "Value": "xx", - "Key": "xx" + "Type": "test", + "Value": "=", + "Key": "test1" } ] } ], "Tags": [ { - "Type": "xx", - "Value": "xx", - "Key": "xx" + "Type": "=", + "Value": "java-order-service", + "Key": "service.name" } ], "Process": { - "ServiceName": "xx", + "ServiceName": "java-order-service", "Tags": [ { - "Type": "xx", - "Value": "xx", - "Key": "xx" + "Type": "test", + "Value": "=", + "Key": "test2" } ] }, "Timestamp": 0, - "OperationName": "xx", + "OperationName": "/test", "References": [ { - "RefType": "xx", - "SpanID": "xx", - "TraceID": "xx" + "RefType": "1", + "SpanID": "qertuytw", + "TraceID": "663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac" } ], "StartTime": 0, "Duration": 0, - "SpanID": "xx", + "SpanID": "xasfvava", "StartTimeMillis": 0 } ] diff --git a/tccli/examples/apm/v20210622/DescribeMetricRecords.md b/tccli/examples/apm/v20210622/DescribeMetricRecords.md index 0b9a266d8e..48682f8ca4 100644 --- a/tccli/examples/apm/v20210622/DescribeMetricRecords.md +++ b/tccli/examples/apm/v20210622/DescribeMetricRecords.md @@ -1,6 +1,6 @@ -**Example 1: 请求参数实例** +**Example 1: 请求参数示例** -场景一 +场景1 Input: @@ -33,34 +33,34 @@ Output: { "Fields": [ { - "CompareVal": "abc", + "CompareVal": "", "CompareVals": [ { - "Key": "abc", - "Value": "abc" + "Key": "CompareByYesterday", + "Value": "1%" } ], "Value": 0, - "Unit": "abc", - "Key": "abc", + "Unit": "", + "Key": "service_duration_avg", "LastPeriodValue": [ { - "Key": "abc", - "Value": 0 + "Key": "CompareByYesterday", + "Value": 71308388 } ] } ], "Tags": [ { - "Key": "abc", - "Value": "abc" + "Key": "service.name", + "Value": "java-order-demo" } ] } ], "TotalCount": 0, - "RequestId": "abc" + "RequestId": "test-test-test" } } ``` @@ -97,35 +97,35 @@ Output: { "LastPeriodValue": [ { - "Key": "abc", - "Value": 0 + "Key": "CompareByYesterday", + "Value": 71308388 } ], - "CompareVal": "abc", + "CompareVal": "CompareByYesterday", "Unit": "s", "Value": 691.42, - "Key": "ab", + "Key": "duration_avg", "CompareVals": [ { - "Value": "v1", - "Key": "k1" + "Value": "CompareByYesterday", + "Key": "2%" }, { - "Key": "k2", - "Value": "v2" + "Key": "CompareByLastWeek", + "Value": "-1%" } ] } ], "Tags": [ { - "Value": "v1", - "Key": "k1" + "Value": "service.name", + "Key": "java-order-demo" } ] } ], - "RequestId": "re", + "RequestId": "test-test-test", "TotalCount": 0 } } diff --git a/tccli/examples/apm/v20210622/DescribeServiceOverview.md b/tccli/examples/apm/v20210622/DescribeServiceOverview.md index 84f63437cb..01aba1d314 100644 --- a/tccli/examples/apm/v20210622/DescribeServiceOverview.md +++ b/tccli/examples/apm/v20210622/DescribeServiceOverview.md @@ -1,4 +1,4 @@ -**Example 1: 获取服务概览数据** +**Example 1: 获取应用概览数据** @@ -6,19 +6,13 @@ Input: ``` tccli apm DescribeServiceOverview --cli-unfold-argument \ - --Filters.0.Key span.kind \ --Filters.0.Type = \ - --Filters.0.Value SPAN_KIND_SERVER \ - --Metrics.0.MetricName service_duration_avg \ - --Metrics.0.Compare 1 \ - --Metrics.1.MetricName request_count_sum \ - --GroupBy operation service.component \ - --Limit 10 \ - --Offset 1 \ - --StartTime 1618361193 \ - --EndTime 1618677137 \ - --OrderBy.Key service_duration_avg \ - --OrderBy.Value DESC + --Filters.0.Key span.kind \ + --Filters.0.Value client \ + --InstanceId apm-059oXBfTL \ + --Metrics.0.Compare CompareByYesterday \ + --Metrics.0.MetricName service_request_count_sum \ + --GroupBy service.name ``` Output: @@ -27,199 +21,43 @@ Output: "Response": { "Records": [ { - "Tags": [ - { - "Key": "operation", - "Value": "/DescribeAlarmList" - }, - { - "Key": "service.component", - "Value": "HTTP" - } - ], "Fields": [ { - "Key": "service_duration_avg", - "Value": 0.02383373177662466, - "CompareVal": -0.004148131882911392 - }, - { - "Key": "request_count_sum", - "Value": 31184, - "CompareVal": 0 - } - ] - }, - { - "Tags": [ - { - "Key": "operation", - "Value": "/collector.CollectorService/PostSpans" - }, - { - "Key": "service.component", - "Value": "gRPC" + "CompareVal": "", + "CompareVals": [ + { + "Key": "CompareByYesterday", + "Value": "-1.6%" + }, + { + "Key": "CompareByLastWeek", + "Value": "-0.8%" + } + ], + "Key": "service_request_count_sum", + "LastPeriodValue": [ + { + "Key": "CompareByYesterday", + "Value": 125 + }, + { + "Key": "CompareByLastWeek", + "Value": 124 + } + ], + "Unit": "", + "Value": 126 } ], - "Fields": [ - { - "Key": "service_duration_avg", - "Value": 18.811467216411906, - "CompareVal": 0.17306355798699288 - }, - { - "Key": "request_count_sum", - "Value": 4986, - "CompareVal": 0 - } - ] - }, - { "Tags": [ { - "Key": "operation", - "Value": "/notify.Notify/SendAlert" - }, - { - "Key": "service.component", - "Value": "gRPC" - } - ], - "Fields": [ - { - "Key": "service_duration_avg", - "Value": 9.486143798828124, - "CompareVal": 0.4454246545216073 - }, - { - "Key": "request_count_sum", - "Value": 4111, - "CompareVal": 0 - } - ] - }, - { - "Tags": [ - { - "Key": "operation", - "Value": "HTTP GET" - }, - { - "Key": "service.component", - "Value": "net/http" - } - ], - "Fields": [ - { - "Key": "service_duration_avg", - "Value": 14.46367618133845, - "CompareVal": 1 - }, - { - "Key": "request_count_sum", - "Value": 8345, - "CompareVal": 0 - } - ] - }, - { - "Tags": [ - { - "Key": "operation", - "Value": "HTTP POST" - }, - { - "Key": "service.component", - "Value": "net/http" - } - ], - "Fields": [ - { - "Key": "service_duration_avg", - "Value": 12.396896973135917, - "CompareVal": 0.1693196368191666 - }, - { - "Key": "request_count_sum", - "Value": 15094, - "CompareVal": 0 - } - ] - }, - { - "Tags": [ - { - "Key": "operation", - "Value": "http_server_root" - }, - { - "Key": "service.component", - "Value": "net/http" - } - ], - "Fields": [ - { - "Key": "service_duration_avg", - "Value": 68.29158163921177, - "CompareVal": -0.05762747632987753 - }, - { - "Key": "request_count_sum", - "Value": 104642033, - "CompareVal": 0 - } - ] - }, - { - "Tags": [ - { - "Key": "service.component", - "Value": "httpserverv3" - }, - { - "Key": "operation", - "Value": "Ping" - } - ], - "Fields": [ - { - "Key": "service_duration_avg", - "Value": 0.4196629148780232, - "CompareVal": 1 - }, - { - "Key": "request_count_sum", - "Value": 10182, - "CompareVal": 0 - } - ] - }, - { - "Tags": [ - { - "Key": "operation", - "Value": "microServer_cdbwan" - }, - { - "Key": "service.component", - "Value": "httpserverv3" - } - ], - "Fields": [ - { - "Key": "service_duration_avg", - "Value": 3.6889778198423007, - "CompareVal": 0.15496546525321617 - }, - { - "Key": "request_count_sum", - "Value": 191205, - "CompareVal": 0 + "Key": "service.name", + "Value": "ot-java-delivery-service" } ] } ], - "RequestId": "fyy3-g7ujmxbouxshy3plmkmhlnmdbfh" + "RequestId": "c7a656fe-971c-47cc-8dc4-ae76630e4761" } } ``` diff --git a/tccli/examples/apm/v20210622/ModifyApmInstance.md b/tccli/examples/apm/v20210622/ModifyApmInstance.md index 648363d7b7..57ced7cad4 100644 --- a/tccli/examples/apm/v20210622/ModifyApmInstance.md +++ b/tccli/examples/apm/v20210622/ModifyApmInstance.md @@ -1,15 +1,15 @@ **Example 1: 成功事例** -修改APM Instance参数 +修改 APM 业务系统参数 Input: ``` tccli apm ModifyApmInstance --cli-unfold-argument \ - --InstanceId abc \ - --Description abc \ + --InstanceId apm-CVfliqa8U \ + --Description 测试业务系统 \ --TraceDuration 0 \ - --Name abc \ + --Name 测试业务系统 \ --OpenBilling True \ --SpanDailyCounters 1 \ --ErrRateThreshold 5 \ @@ -27,7 +27,7 @@ Output: ``` { "Response": { - "RequestId": "abc" + "RequestId": "test-test-test" } } ``` diff --git a/tccli/examples/apm/v20210622/TerminateApmInstance.md b/tccli/examples/apm/v20210622/TerminateApmInstance.md index 757ac46245..990eb83d36 100644 --- a/tccli/examples/apm/v20210622/TerminateApmInstance.md +++ b/tccli/examples/apm/v20210622/TerminateApmInstance.md @@ -1,12 +1,12 @@ -**Example 1: 销毁apm实例** +**Example 1: 销毁 APM 业务系统** -销毁apm实例 +销毁 APM 业务系统 Input: ``` tccli apm TerminateApmInstance --cli-unfold-argument \ - --InstanceId 6Dxp7Nd0B + --InstanceId apm-CVfliqa8U ``` Output: diff --git a/tccli/examples/car/v20220110/DestroySession.md b/tccli/examples/car/v20220110/DestroySession.md index e7459fb0e1..4eb9bf1709 100644 --- a/tccli/examples/car/v20220110/DestroySession.md +++ b/tccli/examples/car/v20220110/DestroySession.md @@ -6,7 +6,7 @@ Input: ``` tccli car DestroySession --cli-unfold-argument \ - --UserId abc + --UserId 639d069e-a13a-437a-a10b-64a33ecb8e78 ``` Output: diff --git a/tccli/examples/car/v20220110/StartPublishStreamWithURL.md b/tccli/examples/car/v20220110/StartPublishStreamWithURL.md index 085f89d0f1..baa086c713 100644 --- a/tccli/examples/car/v20220110/StartPublishStreamWithURL.md +++ b/tccli/examples/car/v20220110/StartPublishStreamWithURL.md @@ -6,15 +6,15 @@ Input: ``` tccli car StartPublishStreamWithURL --cli-unfold-argument \ - --UserId abc \ - --PublishStreamURL abc + --UserId user_id \ + --PublishStreamURL rtmp://1.1.1.1:1935/live/my_live ``` Output: ``` { "Response": { - "RequestId": "abc" + "RequestId": "25b6f399-bd7c-4e5e-99a3-9a6f4b11e1b7" } } ``` diff --git a/tccli/examples/cdb/v20170320/CreateAuditRuleTemplate.md b/tccli/examples/cdb/v20170320/CreateAuditRuleTemplate.md index dda632cc95..53abe2b480 100644 --- a/tccli/examples/cdb/v20170320/CreateAuditRuleTemplate.md +++ b/tccli/examples/cdb/v20170320/CreateAuditRuleTemplate.md @@ -11,7 +11,7 @@ tccli cdb CreateAuditRuleTemplate --cli-unfold-argument \ --RuleFilters.0.Value 100.122.76.176 10.0.0.9 \ --RuleFilters.1.Type user \ --RuleFilters.1.Compare EQS \ - --RuleFilters.1.Value wy test \ + --RuleFilters.1.Value wy \ --RuleFilters.2.Type sqlType \ --RuleFilters.2.Compare EQS \ --RuleFilters.2.Value Update Delete \ diff --git a/tccli/examples/cdb/v20170320/DescribeAuditLogFiles.md b/tccli/examples/cdb/v20170320/DescribeAuditLogFiles.md index 366ff30d77..a2b6b160d2 100644 --- a/tccli/examples/cdb/v20170320/DescribeAuditLogFiles.md +++ b/tccli/examples/cdb/v20170320/DescribeAuditLogFiles.md @@ -21,7 +21,8 @@ Output: "Status": "running", "CreateTime": "2019-03-20 17:09:13", "FileSize": 3, - "DownloadUrl": "http://xxxxxx" + "DownloadUrl": "http://xxxxxx", + "ErrMsg": "" } ] } diff --git a/tccli/examples/cdb/v20170320/DescribeCpuExpandStrategy.md b/tccli/examples/cdb/v20170320/DescribeCpuExpandStrategy.md index ec109d342f..a9ea54dec0 100644 --- a/tccli/examples/cdb/v20170320/DescribeCpuExpandStrategy.md +++ b/tccli/examples/cdb/v20170320/DescribeCpuExpandStrategy.md @@ -6,17 +6,17 @@ Input: ``` tccli cdb DescribeCpuExpandStrategy --cli-unfold-argument \ - --InstanceId abc + --InstanceId cdb-sad1dsfa ``` Output: ``` { "Response": { - "Type": "abc", - "ExpandCpu": "abc", - "AutoStrategy": "abc", - "RequestId": "abc" + "Type": "auto", + "ExpandCpu": "4", + "AutoStrategy": "auto", + "RequestId": "dasdqw13-dasdhd3-123v-1234-v432" } } ``` diff --git a/tccli/examples/cdb/v20170320/DescribeDBImportRecords.md b/tccli/examples/cdb/v20170320/DescribeDBImportRecords.md index 6779deb0e7..588ca03d18 100644 --- a/tccli/examples/cdb/v20170320/DescribeDBImportRecords.md +++ b/tccli/examples/cdb/v20170320/DescribeDBImportRecords.md @@ -27,10 +27,10 @@ Output: "FileName": "monkey_1501490864.sql", "Process": 5, "CreateTime": "2017-11-09 14:26:31", - "FileSize": 12, + "FileSize": "12", "Message": "lock_inst.cgi: 某些实例id不存在对应的实例记录", "JobId": 16242, - "DbName": "test", + "DbName": "db1", "AsyncRequestId": "a4788d0a-df23758a-ac961e5a-af414d33" }, { @@ -60,7 +60,7 @@ Output: "FileSize": "2", "Message": "lock_inst.cgi: 某些实例id不存在对应的实例记录", "JobId": 16222, - "DbName": "test", + "DbName": "db1", "AsyncRequestId": "9706dfbf-0d1bc6df-5f18f4e1-bb86f2f4" }, { diff --git a/tccli/examples/cdb/v20170320/DescribeDBInstances.md b/tccli/examples/cdb/v20170320/DescribeDBInstances.md index 8b01107430..0748aa4f64 100644 --- a/tccli/examples/cdb/v20170320/DescribeDBInstances.md +++ b/tccli/examples/cdb/v20170320/DescribeDBInstances.md @@ -20,7 +20,7 @@ Output: "WanStatus": 0, "Zone": "100001", "WanPort": 0, - "DiskType": "test", + "DiskType": "CLOUD_SSD", "RoVipInfo": { "RoVport": 0, "RoVpcId": 0, @@ -35,134 +35,134 @@ Output: "SlaveInfo": { "Second": { "Vport": 0, - "Vip": "test", + "Vip": "172.1.1.1", "Region": "ap-guangzhou", "Zone": "ap-guangzhou-1" }, "First": { "Vport": 0, - "Vip": "test", + "Vip": "17.1.1.1", "Region": "ap-guangzhou", "Zone": "ap-guangzhou-1" } }, - "InstanceId": "cdn-abc", - "PhysicalId": "test", + "InstanceId": "cdn-ahend", + "PhysicalId": "136527", "Volume": 50, "AutoRenew": 0, "ProtectMode": 0, "CdbError": 0, - "DeviceClass": "test", + "DeviceClass": "20", "MasterInfo": { - "Status": 0, + "Status": 1, "VpcId": 0, "Zone": "100001", - "ExClusterName": "test", - "InstanceId": "test", - "ResourceId": "test", + "ExClusterName": "andy", + "InstanceId": "cdb-hsyhend", + "ResourceId": "", "Region": "ap-guangzhou", "RegionId": 0, "ZoneId": 0, "Volume": 0, - "DeviceType": "test", + "DeviceType": "UNIVERSAL", "Memory": 0, "SubnetId": 0, "Qps": 0, "TaskStatus": 0, - "InstanceName": "test", + "InstanceName": "cdb342", "InstanceType": 0, - "ExClusterId": "test" + "ExClusterId": "cdb-3ho6jddd" }, - "DeployGroupId": "test", + "DeployGroupId": "ps-7t11vrwf", "InstanceNodes": 2, "RoGroups": [ { "RoOfflineDelay": 0, - "RoGroupMode": "test", - "RoGroupZone": "test", + "RoGroupMode": "alone", + "RoGroupZone": "800003", "MinRoInGroup": 1, "DelayReplicationTime": 0, - "RoGroupId": "test", + "RoGroupId": "cdbrg-92zkeaq2", "RoMaxDelayTime": 1, - "RoGroupName": "test", + "RoGroupName": "cdbro2", "Weight": 0, - "UniqVpcId": "test", + "UniqVpcId": "vpc-ja6ts123", "RoInstances": [ { - "Zone": "test", - "MasterInstanceId": "test", + "Zone": "ap-guangzhou-3", + "MasterInstanceId": "cdb-fapcrp1q", "Memory": 1000, "Status": 1, "VpcId": 511512, - "InstanceId": "test", + "InstanceId": "cdb-hendhs", "Volume": 50, - "OfflineTime": "test", + "OfflineTime": "2024-09-09 16:40:31", "SubnetId": 115839, "HourFeeStatus": 1, - "RoStatus": "test", - "Region": "test", - "DeadlineTime": "test", + "RoStatus": "online", + "Region": "ap-guangzhou", + "DeadlineTime": "2024-12-29 08:37:33", "TaskStatus": 0, - "DeviceType": "test", - "EngineVersion": "test", - "InstanceName": "test", + "DeviceType": "UNIVERSAL", + "EngineVersion": "5.7", + "InstanceName": "cdbro732", "Weight": 0, "PayType": 1, "InstanceType": 3, - "Vip": "test", + "Vip": "127.0.0.1", "Qps": 1000, "Vport": 3306 } ], - "Vip": "test", - "UniqSubnetId": "test", - "RoGroupRegion": "test", + "Vip": "10.89.90.66", + "UniqSubnetId": "subnet-njh2bc99", + "RoGroupRegion": "ap-guangzhou", "Vport": 3306, - "WeightMode": "test" + "WeightMode": "system" }, { "RoOfflineDelay": 0, - "RoGroupMode": "test", - "RoGroupZone": "test", + "RoGroupMode": "alone", + "RoGroupZone": "ap-guangzhou", "MinRoInGroup": 1, "DelayReplicationTime": 0, - "RoGroupId": "test", + "RoGroupId": "cdbrg-92zkeaq4", "RoMaxDelayTime": 1, - "RoGroupName": "test", - "UniqVpcId": "test", + "RoGroupName": "andy6", + "UniqVpcId": "vpc-ja6ts453", "Weight": 0, "RoInstances": [ { - "Zone": "test", - "MasterInstanceId": "test", + "Zone": "ap-guangzhou-4", + "MasterInstanceId": "cdb-fapcrp12", "Memory": 1000, "Status": 1, "VpcId": 511512, - "InstanceId": "test", + "InstanceId": "cdbro-c1nl9rpv", "Volume": 25, - "OfflineTime": "test", + "OfflineTime": "2024-09-09 16:40:30", "SubnetId": 115839, "HourFeeStatus": 1, - "RoStatus": "test", - "Region": "test", - "DeadlineTime": "test", + "RoStatus": "online", + "Region": "ap-guangzhou", + "DeadlineTime": "2024-12-29 08:37:33", "TaskStatus": 0, - "DeviceType": "test", - "EngineVersion": "test", - "InstanceName": "test", + "DeviceType": "UNIVERSAL", + "EngineVersion": "5.7", + "InstanceName": "cdbro7", "Weight": 0, "PayType": 1, "InstanceType": 3, - "Vip": "test", + "Vip": "127.0.0.1", "Qps": 1000, "Vport": 3306 } ], - "Vip": "test", - "UniqSubnetId": "test", - "RoGroupRegion": "test", + "Vip": "12.1.1.1", + "UniqSubnetId": "subnet-njh2bc11", + "RoGroupRegion": "ap-guangzhou", "Vport": 3306, - "WeightMode": "test" + "WeightMode": "system" } ], "ProjectId": 0, @@ -170,41 +170,41 @@ Output: "DeployMode": 0, "TaskStatus": 0, "SubnetId": 115839, - "DeviceType": "test", - "EngineVersion": "test", + "DeviceType": "EXCLUSIVE", + "EngineVersion": "5.7", "MaxDelayTime": 0, - "InstanceName": "test", + "InstanceName": "cdbandy", "Cpu": 8, "DrInfo": [ { "Status": 0, - "Zone": "test", - "InstanceId": "test", - "Region": "test", + "Zone": "ap-beijing-3", + "InstanceId": "cdb-hegns", + "Region": "ap-beijing", "SyncStatus": 0, - "InstanceName": "test", + "InstanceName": "andydr", "InstanceType": 0 } ], - "UniqVpcId": "test", - "WanDomain": "test", + "UniqVpcId": "vpc-5v8wn9m1", + "WanDomain": "gz-cdb-******.sql.tencentcdb.com", "InitFlag": 1, "PayType": 1, "InstanceType": 1, - "Vip": "test", - "UniqSubnetId": "test", - "Region": "test", + "Vip": "13.1.1.1", + "UniqSubnetId": "subnet-1typ0s7d", + "Region": "ap-beijing", "Qps": 0, "Vport": 3306, "TagList": [ { - "TagKey": "test", - "TagValue": "test" + "TagKey": "name", + "TagValue": "andy" } ], - "CreateTime": "test", + "CreateTime": "2023-08-29 08:37:33", "ZoneId": 720001, - "ZoneName": "test" + "ZoneName": "北京三区" } ] } diff --git a/tccli/examples/cdb/v20170320/DescribeDatabases.md b/tccli/examples/cdb/v20170320/DescribeDatabases.md index 7bff20cb74..e790b40f3e 100644 --- a/tccli/examples/cdb/v20170320/DescribeDatabases.md +++ b/tccli/examples/cdb/v20170320/DescribeDatabases.md @@ -17,7 +17,7 @@ Output: "DatabaseList": [ { "CharacterSet": "UTF8", - "DatabaseName": "test" + "DatabaseName": "db1" } ], "TotalCount": 7, @@ -25,7 +25,6 @@ Output: "information_schema", "mysql", "performance_schema", - "test", "trsf1", "trsf2", "trsf3" diff --git a/tccli/examples/cdb/v20170320/DescribeParamTemplates.md b/tccli/examples/cdb/v20170320/DescribeParamTemplates.md index 399a0cf090..3f7731c258 100644 --- a/tccli/examples/cdb/v20170320/DescribeParamTemplates.md +++ b/tccli/examples/cdb/v20170320/DescribeParamTemplates.md @@ -11,17 +11,18 @@ Output: ``` { "Response": { - "RequestId": "756bb037-a44a-4b4f-abe0-6efd34a6c792", "TotalCount": 1, "Items": [ { "TemplateId": 2333, - "Name": "test", - "Description": "test", + "Name": "andy", + "Description": "5.7", "EngineVersion": "5.7", - "TemplateType": "HIGH_STABILITY" + "TemplateType": "HIGH_STABILITY", + "EngineType": "InnoDB" } - ] + ], + "RequestId": "756bb037-a44a-4b4f-abe0-6efd34a6c792" } } ``` diff --git a/tccli/examples/cdb/v20170320/ModifyDBInstanceVipVport.md b/tccli/examples/cdb/v20170320/ModifyDBInstanceVipVport.md index 1ad814a357..83af9e4d4a 100644 --- a/tccli/examples/cdb/v20170320/ModifyDBInstanceVipVport.md +++ b/tccli/examples/cdb/v20170320/ModifyDBInstanceVipVport.md @@ -11,7 +11,7 @@ tccli cdb ModifyDBInstanceVipVport --cli-unfold-argument \ --DstPort 1025 \ --UniqVpcId 11357 \ --UniqSubnetId 23789 \ - --ReleaseDuration 12 + --ReleaseDuration 24 ``` Output: diff --git a/tccli/examples/chdfs/v20201112/DescribeFileSystems.md b/tccli/examples/chdfs/v20201112/DescribeFileSystems.md index 27b2427056..7ef5275b7e 100644 --- a/tccli/examples/chdfs/v20201112/DescribeFileSystems.md +++ b/tccli/examples/chdfs/v20201112/DescribeFileSystems.md @@ -14,10 +14,10 @@ Output: "FileSystems": [ { "AppId": 1251006373, - "FileSystemName": "test", + "FileSystemName": "fs-test", "Description": "", "Region": "ap-guangzhou", - "FileSystemId": "f4mnvilzmdd", + "FileSystemId": "f4mnvilxxxx", "CreateTime": "2019-07-30T17:03:20+08:00", "BlockSize": 4194304, "CapacityQuota": 1073741824, diff --git a/tccli/examples/cvm/v20170312/CreateLaunchTemplate.md b/tccli/examples/cvm/v20170312/CreateLaunchTemplate.md index 2ade386018..73efc473d3 100644 --- a/tccli/examples/cvm/v20170312/CreateLaunchTemplate.md +++ b/tccli/examples/cvm/v20170312/CreateLaunchTemplate.md @@ -1,12 +1,12 @@ **Example 1: 使用最简单参数创建实例启动模板** -只传必传的Zone、镜像ID和启动模板ID,其他均采用系统默认值,具体配置如下:实例所在位置为广州二区,镜像ID为:img-pmqg1cw7,实例启动模板名称:test +只传必传的Zone、镜像ID和启动模板ID,其他均采用系统默认值,具体配置如下:实例所在位置为广州二区,镜像ID为:img-pmqg1cw7,实例启动模板名称:myTemplate Input: ``` tccli cvm CreateLaunchTemplate --cli-unfold-argument \ - --LaunchTemplateName test \ + --LaunchTemplateName myTemplate \ --Placement.Zone ap-guangzhou-2 \ --ImageId img-pmqg1cw7 ``` diff --git a/tccli/examples/cvm/v20170312/DescribeChcHosts.md b/tccli/examples/cvm/v20170312/DescribeChcHosts.md index 1a91713bec..addd89ea82 100644 --- a/tccli/examples/cvm/v20170312/DescribeChcHosts.md +++ b/tccli/examples/cvm/v20170312/DescribeChcHosts.md @@ -15,42 +15,75 @@ Output: "Response": { "ChcHostSet": [ { - "ChcId": "chc-1a2b3c4d", - "InstanceName": "托管服务器", - "SerialNumber": "sn34asdfabd", - "InstanceState": "RUNNING", - "DeviceType": "CHC_HS1", - "Placement": { - "Zone": "ap-guangzhou-2" - }, + "BmcIp": "10.0.0.17", + "BmcMAC": "52:54:00:71:B5:A1", + "BmcSecurityGroupIds": [ + "sg-8l03md6z" + ], "BmcVirtualPrivateCloud": { - "SubnetId": "subnet-a2676p0e", - "VpcId": "vpc-g7wzcv7n" + "SubnetId": "subnet-hmpeps7u", + "VpcId": "vpc-b9y7wgix", + "AsVpcGateway": false, + "Ipv6AddressCount": 0, + "PrivateIpAddresses": [ + "10.10.2.4" + ] }, - "BmcIp": "10.12.10.34", - "BmcSecurityGroupIds": [ - "sg-1a2b3c4d" + "CPU": 64, + "ChcId": "chc-1a2b3c4d", + "ChcInstanceFamily": "CHCS5", + "ChcInstanceFamilyName": "高性能计算型CHCS5", + "ChcInstanceType": "CHCS5.128C384M", + "CreatedTime": "2024-07-19 16:41:20", + "CvmInstanceId": "", + "DeployExtraConfig": { + "BootFile": "pxelinux.0", + "BootType": "x86_uefi", + "MiniOsType": "public", + "NextServerAddress": "169.254.68.10" + }, + "DeployIp": "172.16.0.17", + "DeployMAC": "52:54:00:41:8D:7B", + "DeploySecurityGroupIds": [ + "sg-8l03md6z" ], "DeployVirtualPrivateCloud": { - "SubnetId": "subnet-a26734fs", - "VpcId": "vpc-g7wz234f" + "SubnetId": "subnet-pad8nabc", + "VpcId": "vpc-gbgzjb6r", + "AsVpcGateway": false, + "Ipv6AddressCount": 0, + "PrivateIpAddresses": [ + "10.10.2.4" + ] }, - "DeployIp": "10.12.20.34", - "DeploySecurityGroupIds": [ - "sg-1a2b34af" + "DeviceType": "CHCS5", + "Disk": "480GB*2/3.84TB*12", + "Gpu": "", + "HardwareDescription": "64核 256GB 480GB*2/3.84TB*12", + "InstanceName": "vlan502", + "InstanceState": "PREPARED", + "IsPredefinedType": true, + "Memory": 256, + "NetworkCard": "", + "Placement": { + "Zone": "ap-guangzhou-2", + "ProjectId": 0 + }, + "ResaleAccountId": "", + "ResaleAppId": "", + "SaleStatus": "NOT_FOR_SALE", + "SerialNumber": "7DF112345678", + "Tags": [ + { + "Key": "test", + "Value": "test22" + } ], - "CvmInstanceId": "ins-1a2bafst", - "CreatedTime": "2020-03-10T02:43:51Z", - "HardwareDescription": "50C 128G 12*4T", - "Memory": 128, - "DeployMAC": "52:54:00:68:CC:00", - "BmcMAC": "52:54:00:68:CC:01", - "Disk": "12*4T", - "CPU": 50 + "TenantType": "HOSTING" } ], - "TotalCount": 2, - "RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A" + "RequestId": "d2ab63c0-576f-44c4-b6c1-f519fb58654b", + "TotalCount": 1 } } ``` diff --git a/tccli/examples/cvm/v20170312/DescribeImageFromFamily.md b/tccli/examples/cvm/v20170312/DescribeImageFromFamily.md index 7112563e93..94039c21e5 100644 --- a/tccli/examples/cvm/v20170312/DescribeImageFromFamily.md +++ b/tccli/examples/cvm/v20170312/DescribeImageFromFamily.md @@ -14,34 +14,34 @@ Output: { "Response": { "Image": { - "ImageId": "abc", - "OsName": "abc", - "ImageType": "abc", + "ImageId": "img-xxx", + "OsName": "Xserver", + "ImageType": "PRIVATE_IMAGE", "CreatedTime": "2020-09-22T00:00:00+00:00", - "ImageName": "abc", - "ImageDescription": "abc", + "ImageName": "myImg", + "ImageDescription": "", "ImageSize": 0, - "Architecture": "abc", - "ImageState": "abc", - "Platform": "abc", - "ImageCreator": "abc", - "ImageSource": "abc", + "Architecture": "x86_64", + "ImageState": "NORMAL", + "Platform": "Windows", + "ImageCreator": "tencent", + "ImageSource": "CREATE_IMAGE", "SyncPercent": 0, "IsSupportCloudinit": true, "SnapshotSet": [ { - "SnapshotId": "abc", - "DiskUsage": "abc", + "SnapshotId": "snap-nbxxx56", + "DiskUsage": "SYSTEM_DISK", "DiskSize": 0 } ], "Tags": [ { - "Key": "abc", - "Value": "abc" + "Key": "myKey", + "Value": "myValue" } ], - "LicenseType": "abc", + "LicenseType": "TencentCloud", "ImageFamily": "business-daily-update", "ImageDeprecated": false }, diff --git a/tccli/examples/cvm/v20170312/DescribeImportImageOs.md b/tccli/examples/cvm/v20170312/DescribeImportImageOs.md index 8c32e929a6..11479fb1dd 100644 --- a/tccli/examples/cvm/v20170312/DescribeImportImageOs.md +++ b/tccli/examples/cvm/v20170312/DescribeImportImageOs.md @@ -32,7 +32,7 @@ Output: { "OsName": "Windows Server 2008", "OsVersions": [ - "-" + "9" ], "Architecture": [ "x86_64", @@ -42,7 +42,7 @@ Output: { "OsName": "Windows Server 2012", "OsVersions": [ - "-" + "9" ], "Architecture": [ "x86_64", @@ -52,7 +52,7 @@ Output: { "OsName": "Windows Server 2016", "OsVersions": [ - "-" + "9" ], "Architecture": [ "x86_64", @@ -156,7 +156,7 @@ Output: { "OsName": "Other Linux", "OsVersions": [ - "-" + "8" ], "Architecture": [ "x86_64", diff --git a/tccli/examples/cvm/v20170312/DescribeInstances.md b/tccli/examples/cvm/v20170312/DescribeInstances.md index 2b12017726..bcbae2a835 100644 --- a/tccli/examples/cvm/v20170312/DescribeInstances.md +++ b/tccli/examples/cvm/v20170312/DescribeInstances.md @@ -50,8 +50,8 @@ Output: ], "Tags": [ { - "Value": "test", - "Key": "test" + "Value": "myKey", + "Key": "myValue" } ], "InstanceId": "ins-xlsyru2j", @@ -78,7 +78,7 @@ Output: "SecurityGroupIds": [ "sg-p1ezv4wz" ], - "InstanceName": "test", + "InstanceName": "myInstance", "DataDisks": [ { "DeleteWithInstance": true, @@ -270,8 +270,8 @@ Output: ], "Tags": [ { - "Value": "test", - "Key": "test" + "Value": "myKey", + "Key": "myValue" } ], "InstanceId": "ins-xlsyru2j", @@ -298,7 +298,7 @@ Output: "SecurityGroupIds": [ "sg-p1ezv4wz" ], - "InstanceName": "test", + "InstanceName": "myInstance", "DataDisks": [ { "DeleteWithInstance": true, diff --git a/tccli/examples/cvm/v20170312/InquiryPriceRunInstances.md b/tccli/examples/cvm/v20170312/InquiryPriceRunInstances.md index f059593b66..5c8ce92033 100644 --- a/tccli/examples/cvm/v20170312/InquiryPriceRunInstances.md +++ b/tccli/examples/cvm/v20170312/InquiryPriceRunInstances.md @@ -213,7 +213,7 @@ Output: "UnitPriceDiscount": 0.52, "DiscountPriceFiveYear": 0.0, "OriginalPriceOneYear": 0.0, - "ChargeUnit": "xx", + "ChargeUnit": "HOUR", "DiscountPriceThreeYear": 0.0, "DiscountPriceOneYear": 0.0 } diff --git a/tccli/examples/cynosdb/v20190107/CreateAuditRuleTemplate.md b/tccli/examples/cynosdb/v20190107/CreateAuditRuleTemplate.md index dc9cdfb1dc..e2bbecbfac 100644 --- a/tccli/examples/cynosdb/v20190107/CreateAuditRuleTemplate.md +++ b/tccli/examples/cynosdb/v20190107/CreateAuditRuleTemplate.md @@ -11,12 +11,12 @@ tccli cynosdb CreateAuditRuleTemplate --cli-unfold-argument \ --RuleFilters.0.Value 100.122.76.176 10.0.0.9 \ --RuleFilters.1.Type user \ --RuleFilters.1.Compare EQS \ - --RuleFilters.1.Value wy test \ + --RuleFilters.1.Value wy andy \ --RuleFilters.2.Type sqlType \ --RuleFilters.2.Compare EQS \ --RuleFilters.2.Value Update Delete \ - --RuleTemplateName test \ - --Description 用于测试的规则模板 + --RuleTemplateName andy \ + --Description andy模板 ``` Output: diff --git a/tccli/examples/cynosdb/v20190107/CreateCLSDelivery.md b/tccli/examples/cynosdb/v20190107/CreateCLSDelivery.md index d1e509a385..cac0c07a8e 100644 --- a/tccli/examples/cynosdb/v20190107/CreateCLSDelivery.md +++ b/tccli/examples/cynosdb/v20190107/CreateCLSDelivery.md @@ -18,7 +18,7 @@ Output: ``` { "Response": { - "TaskId": 123456, + "TaskId": 148728, "RequestId": "347698da-03e4-4078-8d96-9a8b219c01a5" } } diff --git a/tccli/examples/cynosdb/v20190107/DeleteAuditLogFile.md b/tccli/examples/cynosdb/v20190107/DeleteAuditLogFile.md index 50b41dbea7..2b6c9e92ff 100644 --- a/tccli/examples/cynosdb/v20190107/DeleteAuditLogFile.md +++ b/tccli/examples/cynosdb/v20190107/DeleteAuditLogFile.md @@ -7,7 +7,7 @@ Input: ``` tccli cynosdb DeleteAuditLogFile --cli-unfold-argument \ --InstanceId cynosdbmysql-ins-qwerasdf \ - --FileName aaa + --FileName andy.csv ``` Output: diff --git a/tccli/examples/cynosdb/v20190107/DescribeAccountAllGrantPrivileges.md b/tccli/examples/cynosdb/v20190107/DescribeAccountAllGrantPrivileges.md index b6489de9c7..36276c909f 100644 --- a/tccli/examples/cynosdb/v20190107/DescribeAccountAllGrantPrivileges.md +++ b/tccli/examples/cynosdb/v20190107/DescribeAccountAllGrantPrivileges.md @@ -7,8 +7,8 @@ Input: ``` tccli cynosdb DescribeAccountAllGrantPrivileges --cli-unfold-argument \ --Account.Host % \ - --Account.AccountName test \ - --ClusterId cynosdbmysql-xxxxxxxx + --Account.AccountName andy \ + --ClusterId cynosdbmysql-j9i41hfv ``` Output: @@ -17,7 +17,7 @@ Output: "Response": { "DatabasePrivileges": [ { - "Db": "test1", + "Db": "db1", "Privileges": [ "DROP", "EXECUTE" @@ -30,13 +30,13 @@ Output: ], "PrivilegeStatements": [ "GRANT CREATE, ALTER ON *.* TO 'test'@'%'", - "GRANT DROP, EXECUTE ON `test1`.* TO 'test'@'%'", - "GRANT UPDATE, SHOW VIEW ON `test1`.`user1` TO 'test'@'%'" + "GRANT DROP, EXECUTE ON `db1`.* TO 'andy'@'%'", + "GRANT UPDATE, SHOW VIEW ON `db1`.`user1` TO 'andy'@'%'" ], "RequestId": "46bf5c40-3fc1-4030-ab84-a66355ae25ab", "TablePrivileges": [ { - "Db": "test1", + "Db": "andy1", "Privileges": [ "UPDATE", "SHOW VIEW" diff --git a/tccli/examples/cynosdb/v20190107/DescribeAccountPrivileges.md b/tccli/examples/cynosdb/v20190107/DescribeAccountPrivileges.md index 5fcc15de3d..afee446671 100644 --- a/tccli/examples/cynosdb/v20190107/DescribeAccountPrivileges.md +++ b/tccli/examples/cynosdb/v20190107/DescribeAccountPrivileges.md @@ -7,11 +7,11 @@ Input: ``` tccli cynosdb DescribeAccountPrivileges --cli-unfold-argument \ --ClusterId cynosdbmysql-xxxxxx \ - --AccountName test \ + --AccountName andy \ --Host 1.1.1.1 \ - --Db testDb \ + --Db Db1 \ --Type table \ - --TableName testTable + --TableName Table1 ``` Output: diff --git a/tccli/examples/cynosdb/v20190107/DescribeAuditLogs.md b/tccli/examples/cynosdb/v20190107/DescribeAuditLogs.md index 2d78f04f41..31823a5ed3 100644 --- a/tccli/examples/cynosdb/v20190107/DescribeAuditLogs.md +++ b/tccli/examples/cynosdb/v20190107/DescribeAuditLogs.md @@ -28,11 +28,11 @@ Output: "ErrCode": 0, "Host": "10.0.0.1", "SentRows": 0, - "User": "test", + "User": "andy", "Sql": "SELECT * FROM test LIMIT 1;", "SqlType": "SELECT", - "InstanceName": "test", - "DBName": "test_db" + "InstanceName": "cynosdbandy", + "DBName": "db1" } ] } diff --git a/tccli/examples/cynosdb/v20190107/DescribeClusterInstanceGrps.md b/tccli/examples/cynosdb/v20190107/DescribeClusterInstanceGrps.md index 304b88d412..dbbd23c9b7 100644 --- a/tccli/examples/cynosdb/v20190107/DescribeClusterInstanceGrps.md +++ b/tccli/examples/cynosdb/v20190107/DescribeClusterInstanceGrps.md @@ -6,273 +6,223 @@ Input: ``` tccli cynosdb DescribeClusterInstanceGrps --cli-unfold-argument \ - --ClusterId cynosdbmysql-oib3wx0i + --ClusterId cynosdbmysql-grhvkwd ``` Output: ``` { "Response": { - "TotalCount": 0, - "InstanceGrpInfoList": [ + "InstanceGroupInfoList": [ { - "AppId": 0, - "ClusterId": "abc", - "CreatedTime": "2020-09-22 00:00:00", - "DeletedTime": "2020-09-22 00:00:00", - "InstanceGrpId": "abc", - "Status": "abc", - "Type": "abc", - "UpdatedTime": "2020-09-22 00:00:00", - "Vip": "abc", - "Vport": 0, - "WanDomain": "abc", - "WanIP": "abc", - "WanPort": 0, - "WanStatus": "abc", + "AppId": 1312008346, + "ClusterId": "cynosdbmysql-grhvkwd", + "CreatedTime": "2024-12-03 14:03:58", + "DeletedTime": "0001-01-01 00:00:00", + "InstanceGroupId": "cynosdbmysql-grp-r7hmdx4", "InstanceSet": [ { - "Uin": "abc", - "AppId": 0, - "ClusterId": "abc", - "ClusterName": "abc", - "InstanceId": "abc", - "InstanceName": "abc", - "ProjectId": 0, - "Region": "abc", - "Zone": "abc", - "Status": "abc", - "StatusDesc": "abc", - "DbMode": "abc", - "DbType": "abc", - "DbVersion": "abc", - "Cpu": 0, - "Memory": 0, - "Storage": 0, - "InstanceType": "abc", - "InstanceRole": "abc", - "UpdateTime": "2020-09-22 00:00:00", - "CreateTime": "2020-09-22 00:00:00", - "VpcId": "abc", - "SubnetId": "abc", - "Vip": "abc", - "Vport": 0, - "PayMode": 0, - "PeriodEndTime": "2020-09-22 00:00:00", - "DestroyDeadlineText": "abc", - "IsolateTime": "2020-09-22 00:00:00", - "NetType": 0, - "WanDomain": "abc", - "WanIP": "abc", - "WanPort": 0, - "WanStatus": "abc", - "DestroyTime": "abc", - "CynosVersion": "abc", - "ProcessingTask": "abc", - "RenewFlag": 0, - "MinCpu": 0, - "MaxCpu": 0, - "ServerlessStatus": "abc", - "StorageId": "abc", - "StoragePayMode": 0, - "PhysicalZone": "abc", - "BusinessType": "abc", - "Tasks": [ - { - "TaskId": 0, - "TaskType": "abc", - "TaskStatus": "abc", - "ObjectId": "abc", - "ObjectType": "abc" - } - ], - "IsFreeze": "abc", - "ResourceTags": [ - { - "TagKey": "abc", - "TagValue": "abc" - } - ], - "MasterZone": "abc", - "SlaveZones": [ - "abc" - ], + "AppId": 1312008346, + "BusinessType": "", + "ClusterId": "cynosdbmysql-grhvkwd", + "ClusterName": "cynosdbmysql-grhvkwd", + "Cpu": 2, + "CreateTime": "2024-12-03 14:03:58", + "CynosVersion": "2.1.13.001", + "DbMode": "NORMAL", + "DbType": "MYSQL", + "DbVersion": "5.7", + "DestroyDeadlineText": "", + "DestroyTime": "", + "DeviceType": "exclusive", + "InstanceAbility": { + "IsSupportForceRestart": "no", + "NonsupportForceRestartReason": "NoForcedRestartAllowed" + }, + "InstanceId": "cynosdbmysql-ins-crl6j3l", + "InstanceIndexMode": "onlyRowIndex", + "InstanceName": "cynosdbmysql-ins-crl6j3l", "InstanceNetInfo": [ { - "InstanceGroupType": "abc", - "InstanceGroupId": "abc", - "VpcId": "abc", - "SubnetId": "abc", - "NetType": 0, - "Vip": "abc", - "Vport": 0, - "WanDomain": "abc", - "WanIP": "abc", + "InstanceGroupId": "cynosdbmysql-grp-r7hmdx4", + "InstanceGroupType": "ha", + "NetType": 1, + "SubnetId": "subnet-oiz56c8", + "Vip": "172.0.0.2", + "VpcId": "vpc-gy34uq2", + "Vport": 3306, + "WanDomain": "", + "WanIP": "", "WanPort": 0, - "WanStatus": "abc" + "WanStatus": "init" } ], - "ResourcePackages": [ - { - "PackageId": "abc", - "PackageType": "abc" - } - ], - "InstanceIndexMode": "abc" + "InstanceRole": "master", + "InstanceStorageType": "", + "InstanceType": "rw", + "IsFreeze": "no", + "IsolateTime": "0001-01-01 00:00:00", + "MasterZone": "ap-chongqing-1", + "MaxCpu": 0, + "Memory": 4, + "MinCpu": 0, + "NetType": 1, + "PayMode": 1, + "PeriodEndTime": "2025-01-03 14:04:40", + "PhysicalZone": "ap-chongqing-1", + "ProcessingTask": "", + "ProjectId": 0, + "Region": "ap-chongqing", + "RenewFlag": 1, + "ResourcePackages": null, + "ResourceTags": null, + "ServerlessStatus": "", + "SlaveZones": [], + "Status": "running", + "StatusDesc": "运行中", + "Storage": 10, + "StorageId": "cynosdbmysql-grhvkwd", + "StoragePayMode": 1, + "SubnetId": "subnet-oiz56c8", + "Tasks": [], + "Uin": "100021117054", + "UpdateTime": "2024-12-03 14:04:40", + "Vip": "172.0.0.12", + "VpcId": "vpc-gy34uq2", + "Vport": 3306, + "WanDomain": "", + "WanIP": "", + "WanPort": 0, + "WanStatus": "init", + "Zone": "ap-chongqing-1" } ], - "UniqVpcId": "abc", - "UniqSubnetId": "abc", + "NetServiceId": 53990, "OldAddrInfo": { - "Vip": "abc", - "Vport": 0, - "ReturnTime": "abc" + "ReturnTime": "", + "Vip": "", + "Vport": 0 }, - "ProcessingTasks": [ - "abc" - ], - "Tasks": [ - { - "TaskId": 0, - "TaskType": "abc", - "TaskStatus": "abc", - "ObjectId": "abc", - "ObjectType": "abc" - } - ], - "NetServiceId": 0 - } - ], - "InstanceGroupInfoList": [ - { - "AppId": 0, - "ClusterId": "abc", - "CreatedTime": "abc", - "DeletedTime": "abc", - "InstanceGroupId": "abc", - "Status": "abc", - "Type": "abc", - "UpdatedTime": "abc", - "Vip": "abc", - "Vport": 0, - "WanDomain": "abc", - "WanIP": "abc", + "ProcessingTasks": [], + "Status": "running", + "Tasks": [], + "Type": "ha", + "UniqSubnetId": "subnet-oiz56c8", + "UniqVpcId": "vpc-gy34uq2", + "UpdatedTime": "2024-12-03 14:04:40", + "Vip": "172.0.0.12", + "Vport": 3306, + "WanDomain": "", + "WanIP": "", "WanPort": 0, - "WanStatus": "abc", + "WanStatus": "init" + }, + { + "AppId": 1310008346, + "ClusterId": "cynosdbmysql-grhvkwd", + "CreatedTime": "2024-12-03 14:03:58", + "DeletedTime": "0001-01-01 00:00:00", + "InstanceGroupId": "cynosdbmysql-grp-08o6vjh", "InstanceSet": [ { - "Uin": "abc", - "AppId": 0, - "ClusterId": "abc", - "ClusterName": "abc", - "InstanceId": "abc", - "InstanceName": "abc", - "ProjectId": 0, - "Region": "abc", - "Zone": "abc", - "Status": "abc", - "StatusDesc": "abc", - "DbMode": "abc", - "DbType": "abc", - "DbVersion": "abc", - "Cpu": 0, - "Memory": 0, - "Storage": 0, - "InstanceType": "abc", - "InstanceRole": "abc", - "UpdateTime": "2020-09-22 00:00:00", - "CreateTime": "2020-09-22 00:00:00", - "VpcId": "abc", - "SubnetId": "abc", - "Vip": "abc", - "Vport": 0, - "PayMode": 0, - "PeriodEndTime": "2020-09-22 00:00:00", - "DestroyDeadlineText": "abc", - "IsolateTime": "2020-09-22 00:00:00", - "NetType": 0, - "WanDomain": "abc", - "WanIP": "abc", - "WanPort": 0, - "WanStatus": "abc", - "DestroyTime": "abc", - "CynosVersion": "abc", - "ProcessingTask": "abc", - "RenewFlag": 0, - "MinCpu": 0, - "MaxCpu": 0, - "ServerlessStatus": "abc", - "StorageId": "abc", - "StoragePayMode": 0, - "PhysicalZone": "abc", - "BusinessType": "abc", - "Tasks": [ - { - "TaskId": 0, - "TaskType": "abc", - "TaskStatus": "abc", - "ObjectId": "abc", - "ObjectType": "abc" - } - ], - "IsFreeze": "abc", - "ResourceTags": [ - { - "TagKey": "abc", - "TagValue": "abc" - } - ], - "MasterZone": "abc", - "SlaveZones": [ - "abc" - ], + "AppId": 1310008346, + "BusinessType": "", + "ClusterId": "cynosdbmysql-grhvkwd", + "ClusterName": "cynosdbmysql-grhvkwd", + "Cpu": 2, + "CreateTime": "2024-12-03 14:03:58", + "CynosVersion": "2.1.13.001", + "DbMode": "NORMAL", + "DbType": "MYSQL", + "DbVersion": "5.7", + "DestroyDeadlineText": "", + "DestroyTime": "", + "DeviceType": "exclusive", + "InstanceAbility": { + "IsSupportForceRestart": "no", + "NonsupportForceRestartReason": "NoForcedRestartAllowed" + }, + "InstanceId": "cynosdbmysql-ins-6t9ynb7", + "InstanceIndexMode": "onlyRowIndex", + "InstanceName": "cynosdbmysql-ins-6t9ynb7", "InstanceNetInfo": [ { - "InstanceGroupType": "abc", - "InstanceGroupId": "abc", - "VpcId": "abc", - "SubnetId": "abc", - "NetType": 0, - "Vip": "abc", - "Vport": 0, - "WanDomain": "abc", - "WanIP": "abc", + "InstanceGroupId": "cynosdbmysql-grp-08o6vj0", + "InstanceGroupType": "singleRo", + "NetType": 1, + "SubnetId": "subnet-oiz56c8", + "Vip": "172.0.0.7", + "VpcId": "vpc-gy34uq2", + "Vport": 3306, + "WanDomain": "", + "WanIP": "", "WanPort": 0, - "WanStatus": "abc" - } - ], - "ResourcePackages": [ - { - "PackageId": "abc", - "PackageType": "abc" + "WanStatus": "init" } ], - "InstanceIndexMode": "abc" + "InstanceRole": "ro", + "InstanceStorageType": "", + "InstanceType": "ro", + "IsFreeze": "no", + "IsolateTime": "0001-01-01 00:00:00", + "MasterZone": "ap-chongqing-1", + "MaxCpu": 0, + "Memory": 4, + "MinCpu": 0, + "NetType": 1, + "PayMode": 1, + "PeriodEndTime": "2025-01-03 14:04:40", + "PhysicalZone": "ap-chongqing-1", + "ProcessingTask": "", + "ProjectId": 0, + "Region": "ap-chongqing", + "RenewFlag": 1, + "ResourcePackages": null, + "ResourceTags": null, + "ServerlessStatus": "", + "SlaveZones": [], + "Status": "running", + "StatusDesc": "运行中", + "Storage": 10, + "StorageId": "cynosdbmysql-grhvkwd", + "StoragePayMode": 1, + "SubnetId": "subnet-oiz56c8", + "Tasks": [], + "Uin": "100021117054", + "UpdateTime": "2024-12-09 15:18:23", + "Vip": "172.0.0.7", + "VpcId": "vpc-gy34uq2", + "Vport": 3306, + "WanDomain": "", + "WanIP": "", + "WanPort": 0, + "WanStatus": "init", + "Zone": "ap-chongqing-1" } ], - "UniqVpcId": "abc", - "UniqSubnetId": "abc", + "NetServiceId": 53991, "OldAddrInfo": { - "Vip": "abc", - "Vport": 0, - "ReturnTime": "abc" + "ReturnTime": "", + "Vip": "", + "Vport": 0 }, - "ProcessingTasks": [ - "abc" - ], - "Tasks": [ - { - "TaskId": 0, - "TaskType": "abc", - "TaskStatus": "abc", - "ObjectId": "abc", - "ObjectType": "abc" - } - ], - "NetServiceId": 0 + "ProcessingTasks": [], + "Status": "running", + "Tasks": [], + "Type": "singleRo", + "UniqSubnetId": "subnet-oiz56c8", + "UniqVpcId": "vpc-gy34uq2", + "UpdatedTime": "2024-12-03 14:04:40", + "Vip": "172.0.0.7", + "Vport": 3306, + "WanDomain": "", + "WanIP": "", + "WanPort": 0, + "WanStatus": "init" } ], - "RequestId": "abc" + "RequestId": "c32019ab-0d57-4b3d-80ea-5f52c12b523f", + "TotalCount": 2 } } ``` diff --git a/tccli/examples/cynosdb/v20190107/DescribeIsolatedInstances.md b/tccli/examples/cynosdb/v20190107/DescribeIsolatedInstances.md index 6fcca1aba5..928c4bee1f 100644 --- a/tccli/examples/cynosdb/v20190107/DescribeIsolatedInstances.md +++ b/tccli/examples/cynosdb/v20190107/DescribeIsolatedInstances.md @@ -17,105 +17,160 @@ Output: ``` { "Response": { - "TotalCount": 0, "InstanceSet": [ { - "Uin": "abc", - "AppId": 0, - "ClusterId": "abc", - "ClusterName": "abc", - "InstanceId": "abc", - "InstanceName": "abc", - "ProjectId": 0, - "Region": "abc", - "Zone": "abc", - "Status": "abc", - "StatusDesc": "abc", - "DbMode": "abc", - "DbType": "abc", - "DbVersion": "abc", - "Cpu": 0, - "Memory": 0, - "Storage": 0, - "InstanceType": "abc", - "InstanceRole": "abc", - "UpdateTime": "2020-09-22 00:00:00", - "CreateTime": "2020-09-22 00:00:00", - "VpcId": "abc", - "SubnetId": "abc", - "Vip": "abc", - "Vport": 0, - "PayMode": 0, - "PeriodEndTime": "2020-09-22 00:00:00", - "DestroyDeadlineText": "abc", - "IsolateTime": "2020-09-22 00:00:00", - "NetType": 0, - "WanDomain": "abc", - "WanIP": "abc", - "WanPort": 0, - "WanStatus": "abc", - "DestroyTime": "abc", - "CynosVersion": "abc", - "ProcessingTask": "abc", - "RenewFlag": 0, - "MinCpu": 0, - "MaxCpu": 0, - "ServerlessStatus": "abc", - "StorageId": "abc", - "StoragePayMode": 0, - "PhysicalZone": "abc", - "BusinessType": "abc", - "Tasks": [ - { - "TaskId": 0, - "TaskType": "abc", - "TaskStatus": "abc", - "ObjectId": "abc", - "ObjectType": "abc" - } - ], - "IsFreeze": "abc", - "ResourceTags": [ - { - "TagKey": "abc", - "TagValue": "abc" - } - ], - "MasterZone": "abc", - "SlaveZones": [ - "abc" - ], + "AppId": 1311111346, + "BusinessType": "", + "ClusterId": "cynosdbmysql-grhvkwd", + "ClusterName": "cynosdbmysql-grhvkwd", + "Cpu": 2, + "CreateTime": "2024-12-03 14:03:58", + "CynosVersion": "2.1.13.001", + "DbMode": "NORMAL", + "DbType": "MYSQL", + "DbVersion": "5.7", + "DestroyDeadlineText": "<7 天", + "DestroyTime": "2024-12-30 19:51:33", + "DeviceType": "exclusive", + "InstanceAbility": { + "IsSupportForceRestart": "no", + "NonsupportForceRestartReason": "NoForcedRestartAllowed" + }, + "InstanceId": "cynosdbmysql-ins-crl6j3l", + "InstanceIndexMode": "onlyRowIndex", + "InstanceName": "cynosdbmysql-ins-crl6j3l", "InstanceNetInfo": [ { - "InstanceGroupType": "abc", - "InstanceGroupId": "abc", - "VpcId": "abc", - "SubnetId": "abc", - "NetType": 0, - "Vip": "abc", - "Vport": 0, - "WanDomain": "abc", - "WanIP": "abc", + "InstanceGroupId": "cynosdbmysql-grp-r7hmdx4", + "InstanceGroupType": "ha", + "NetType": 1, + "SubnetId": "subnet-oiz56c8", + "Vip": "172.0.0.2", + "VpcId": "vpc-gy34uq2", + "Vport": 3306, + "WanDomain": "", + "WanIP": "", "WanPort": 0, - "WanStatus": "abc" + "WanStatus": "init" } ], - "ResourcePackages": [ + "InstanceRole": "master", + "InstanceStorageType": "", + "InstanceType": "rw", + "IsFreeze": "no", + "IsolateTime": "2024-12-23 19:51:33", + "MasterZone": "ap-chongqing-1", + "MaxCpu": 0, + "Memory": 4, + "MinCpu": 0, + "NetType": 1, + "PayMode": 1, + "PeriodEndTime": "2024-12-23 19:51:24", + "PhysicalZone": "ap-chongqing-1", + "ProcessingTask": "", + "ProjectId": 0, + "Region": "ap-chongqing", + "RenewFlag": 1, + "ResourcePackages": null, + "ResourceTags": null, + "ServerlessStatus": "", + "SlaveZones": [], + "Status": "isolated", + "StatusDesc": "已隔离", + "Storage": 10, + "StorageId": "cynosdbmysql-grhvkwd", + "StoragePayMode": 1, + "SubnetId": "subnet-oiz56c8", + "Tasks": [], + "Uin": "100011147054", + "UpdateTime": "2024-12-23 19:51:33", + "Vip": "172.0.0.2", + "VpcId": "vpc-gy34uq2", + "Vport": 3306, + "WanDomain": "", + "WanIP": "", + "WanPort": 0, + "WanStatus": "init", + "Zone": "ap-chongqing-1" + }, + { + "AppId": 1311111346, + "BusinessType": "", + "ClusterId": "cynosdbmysql-grhvkwd", + "ClusterName": "cynosdbmysql-grhvkwd", + "Cpu": 2, + "CreateTime": "2024-12-03 14:03:58", + "CynosVersion": "2.1.13.001", + "DbMode": "NORMAL", + "DbType": "MYSQL", + "DbVersion": "5.7", + "DestroyDeadlineText": "<7 天", + "DestroyTime": "2024-12-30 19:51:33", + "DeviceType": "exclusive", + "InstanceAbility": { + "IsSupportForceRestart": "no", + "NonsupportForceRestartReason": "NoForcedRestartAllowed" + }, + "InstanceId": "cynosdbmysql-ins-6t9ynb7", + "InstanceIndexMode": "onlyRowIndex", + "InstanceName": "cynosdbmysql-ins-6t9ynb7", + "InstanceNetInfo": [ { - "PackageId": "abc", - "PackageType": "abc", - "DeductionPriority": 0 + "InstanceGroupId": "cynosdbmysql-grp-08o6vj0", + "InstanceGroupType": "singleRo", + "NetType": 1, + "SubnetId": "subnet-oiz56c8", + "Vip": "172.0.0.7", + "VpcId": "vpc-gy34uq2", + "Vport": 3306, + "WanDomain": "", + "WanIP": "", + "WanPort": 0, + "WanStatus": "init" } ], - "InstanceIndexMode": "abc", - "InstanceAbility": { - "IsSupportForceRestart": "abc", - "NonsupportForceRestartReason": "abc" - }, - "DeviceType": "abc" + "InstanceRole": "ro", + "InstanceStorageType": "", + "InstanceType": "ro", + "IsFreeze": "no", + "IsolateTime": "2024-12-23 19:51:33", + "MasterZone": "ap-chongqing-1", + "MaxCpu": 0, + "Memory": 4, + "MinCpu": 0, + "NetType": 1, + "PayMode": 1, + "PeriodEndTime": "2024-12-23 19:51:24", + "PhysicalZone": "ap-chongqing-1", + "ProcessingTask": "", + "ProjectId": 0, + "Region": "ap-chongqing", + "RenewFlag": 1, + "ResourcePackages": null, + "ResourceTags": null, + "ServerlessStatus": "", + "SlaveZones": [], + "Status": "isolated", + "StatusDesc": "已隔离", + "Storage": 10, + "StorageId": "cynosdbmysql-grhvkwd", + "StoragePayMode": 1, + "SubnetId": "subnet-oiz56c8", + "Tasks": [], + "Uin": "100011147054", + "UpdateTime": "2024-12-23 19:51:33", + "Vip": "172.0.0.7", + "VpcId": "vpc-gy34uq2", + "Vport": 3306, + "WanDomain": "", + "WanIP": "", + "WanPort": 0, + "WanStatus": "init", + "Zone": "ap-chongqing-1" } ], - "RequestId": "abc" + "RequestId": "8f291dbc-3840-40f9-aa39-841437c247fb", + "TotalCount": 2 } } ``` diff --git a/tccli/examples/cynosdb/v20190107/DescribeParamTemplates.md b/tccli/examples/cynosdb/v20190107/DescribeParamTemplates.md index 51c4c8d162..7050f0af30 100644 --- a/tccli/examples/cynosdb/v20190107/DescribeParamTemplates.md +++ b/tccli/examples/cynosdb/v20190107/DescribeParamTemplates.md @@ -28,7 +28,8 @@ Output: "Max": "10000", "ParamType": "integer", "EnumValue": [ - "test" + "ON", + "OFF" ], "ParamName": "param1", "NeedReboot": 0 diff --git a/tccli/examples/cynosdb/v20190107/GrantAccountPrivileges.md b/tccli/examples/cynosdb/v20190107/GrantAccountPrivileges.md index d3cd87d7c6..7ad303fb08 100644 --- a/tccli/examples/cynosdb/v20190107/GrantAccountPrivileges.md +++ b/tccli/examples/cynosdb/v20190107/GrantAccountPrivileges.md @@ -6,20 +6,20 @@ Input: ``` tccli cynosdb GrantAccountPrivileges --cli-unfold-argument \ - --ClusterId cynosdbmysql-xxxxxxxx \ + --ClusterId cynosdbmysql-j9i41hdd \ --DbTablePrivileges ALTER DROP \ - --Account.AccountName test \ + --Account.AccountName andy \ --Account.Host % \ - --DbTables.0.Db test1 \ + --DbTables.0.Db db1 \ --DbTables.0.TableName user1 \ - --DbTables.1.Db test2 + --DbTables.1.Db db2 ``` Output: ``` { "Response": { - "RequestId": "147706" + "RequestId": "51169b54-61d4-4604-a07e-e519a5527923" } } ``` diff --git a/tccli/examples/cynosdb/v20190107/IsolateCluster.md b/tccli/examples/cynosdb/v20190107/IsolateCluster.md index 892b5a99d4..5f42bee761 100644 --- a/tccli/examples/cynosdb/v20190107/IsolateCluster.md +++ b/tccli/examples/cynosdb/v20190107/IsolateCluster.md @@ -13,10 +13,10 @@ Output: ``` { "Response": { - "RequestId": "128046", - "FlowId": 123, + "RequestId": "51169b54-61d4-4604-a07e-e519a5527923", + "FlowId": 147284, "DealNames": [ - "123" + "20241226054077125855171" ] } } diff --git a/tccli/examples/cynosdb/v20190107/ModifyAccountParams.md b/tccli/examples/cynosdb/v20190107/ModifyAccountParams.md index 6213a6a247..88776c9616 100644 --- a/tccli/examples/cynosdb/v20190107/ModifyAccountParams.md +++ b/tccli/examples/cynosdb/v20190107/ModifyAccountParams.md @@ -7,7 +7,7 @@ Input: ``` tccli cynosdb ModifyAccountParams --cli-unfold-argument \ --ClusterId cynosdbmysql-xxxxxxxx \ - --Account.AccountName test \ + --Account.AccountName andy \ --Account.Host % \ --AccountParams.0.ParamName max_user_connections \ --AccountParams.0.ParamValue 400 @@ -17,7 +17,7 @@ Output: ``` { "Response": { - "RequestId": "147706" + "RequestId": "51169b54-61d4-4604-a07e-e519a5527923" } } ``` diff --git a/tccli/examples/cynosdb/v20190107/ModifyAccountPrivileges.md b/tccli/examples/cynosdb/v20190107/ModifyAccountPrivileges.md index f64f5c7857..5bb9034ee8 100644 --- a/tccli/examples/cynosdb/v20190107/ModifyAccountPrivileges.md +++ b/tccli/examples/cynosdb/v20190107/ModifyAccountPrivileges.md @@ -7,7 +7,7 @@ Input: ``` tccli cynosdb ModifyAccountPrivileges --cli-unfold-argument \ --ClusterId cynosdbmysql-xxxxxxx \ - --Account.AccountName test \ + --Account.AccountName andy \ --Account.Host 1.1.1.1 \ --GlobalPrivileges CREATE \ --DatabasePrivileges.0.Db testDb \ @@ -21,7 +21,7 @@ Output: ``` { "Response": { - "RequestId": "147706" + "RequestId": "51169b54-61d4-4604-a07e-e519a5527923" } } ``` diff --git a/tccli/examples/cynosdb/v20190107/OpenClusterReadOnlyInstanceGroupAccess.md b/tccli/examples/cynosdb/v20190107/OpenClusterReadOnlyInstanceGroupAccess.md index d7008ed437..36452de92b 100644 --- a/tccli/examples/cynosdb/v20190107/OpenClusterReadOnlyInstanceGroupAccess.md +++ b/tccli/examples/cynosdb/v20190107/OpenClusterReadOnlyInstanceGroupAccess.md @@ -15,8 +15,8 @@ Output: ``` { "Response": { - "FlowId": "12345", - "RequestId": "qwertyuiop" + "FlowId": "147287", + "RequestId": "51169b54-61d4-4604-a07e-e519a5527923" } } ``` diff --git a/tccli/examples/cynosdb/v20190107/RevokeAccountPrivileges.md b/tccli/examples/cynosdb/v20190107/RevokeAccountPrivileges.md index 42a0c6a085..b59a411e9b 100644 --- a/tccli/examples/cynosdb/v20190107/RevokeAccountPrivileges.md +++ b/tccli/examples/cynosdb/v20190107/RevokeAccountPrivileges.md @@ -7,18 +7,18 @@ Input: ``` tccli cynosdb RevokeAccountPrivileges --cli-unfold-argument \ --Account.Host % \ - --Account.AccountName test \ + --Account.AccountName andy \ --DbTablePrivileges ALTER \ - --ClusterId cynosdbmysql-xxxxxxxx \ - --DbTables.0.TableName test-table \ - --DbTables.0.Db test-db + --ClusterId cynosdbmysql-j9i41hkf \ + --DbTables.0.TableName andy-table \ + --DbTables.0.Db andy-db ``` Output: ``` { "Response": { - "RequestId": "147706" + "RequestId": "347698da-03e4-4078-8d96-9a8b219c01a5" } } ``` diff --git a/tccli/examples/cynosdb/v20190107/RollBackCluster.md b/tccli/examples/cynosdb/v20190107/RollBackCluster.md index c6616adefe..4e2a6db980 100644 --- a/tccli/examples/cynosdb/v20190107/RollBackCluster.md +++ b/tccli/examples/cynosdb/v20190107/RollBackCluster.md @@ -7,7 +7,7 @@ Input: ``` tccli cynosdb RollBackCluster --cli-unfold-argument \ --RollbackId 1 \ - --ClusterId cynosdbmysql-xxxxxxxx \ + --ClusterId cynosdbmysql-j9i41hff \ --ExpectTimeThresh 1 \ --RollbackStrategy snapRollback \ --RollbackTables.0.Tables.0.OldTable old_table \ @@ -22,8 +22,8 @@ Output: ``` { "Response": { - "RequestId": "128046", - "FlowId": "123" + "RequestId": "347698da-03e4-4078-8d96-9a8b219c01a5", + "FlowId": "147283" } } ``` diff --git a/tccli/examples/dbbrain/v20191016/CreateDBDiagReportTask.md b/tccli/examples/dbbrain/v20191016/CreateDBDiagReportTask.md index bbd0837701..a431a9c935 100644 --- a/tccli/examples/dbbrain/v20191016/CreateDBDiagReportTask.md +++ b/tccli/examples/dbbrain/v20191016/CreateDBDiagReportTask.md @@ -6,7 +6,7 @@ Input: ``` tccli dbbrain CreateDBDiagReportTask --cli-unfold-argument \ - --InstanceId test \ + --InstanceId cdb-test1234 \ --StartTime 2019-01-01T00:00:00+08:00 \ --EndTime 2019-01-02T00:00:00+08:00 \ --SendMailFlag 1 \ diff --git a/tccli/examples/dbbrain/v20191016/DescribeDBDiagEvent.md b/tccli/examples/dbbrain/v20191016/DescribeDBDiagEvent.md index 13f1f7d7b3..c2d66f31a8 100644 --- a/tccli/examples/dbbrain/v20191016/DescribeDBDiagEvent.md +++ b/tccli/examples/dbbrain/v20191016/DescribeDBDiagEvent.md @@ -6,7 +6,7 @@ Input: ``` tccli dbbrain DescribeDBDiagEvent --cli-unfold-argument \ - --InstanceId test \ + --InstanceId cdb-test1234 \ --EventId 5 ``` @@ -14,11 +14,11 @@ Output: ``` { "Response": { - "Suggestions": "[]", + "Suggestions": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"SQL优化\"}},[{\"DataType\":\"sqlAdvice\",\"Data\":{\"Advices\":[{\"TableName\":\"t1\",\"TableSchema\":\"demo\",\"Keys\":[{\"SqlText\":\"alter table `demo`.`t1` add index index_0(`c_time`);\"}]}],\"Comments\":[],\"Schema\":\"demo\",\"SqlPlan\":{},\"SqlText\":\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\",\"Tables\":[{\"TableName\":\"t1\",\"TableSchema\":\"demo\",\"TableDDL\":\"CREATE TABLE `t1` (\\n `id` int NOT NULL AUTO_INCREMENT,\\n `c_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,\\n `name` varchar(32) DEFAULT NULL,\\n `age` int NOT NULL DEFAULT '0',\\n PRIMARY KEY (`id`)\\n) ENGINE=InnoDB AUTO_INCREMENT=786393 DEFAULT CHARSET=utf8mb3\"}],\"Cost\":{\"Before\":1.060202269597E10,\"After\":1.060202269597E10,\"Ratio\":0}}}]]", "DiagType": "数据库快照", "EndTime": "2019-11-06 12:05:50", "RequestId": "78cf7bb1-0608-11ea-a9ef-2736f0f7f829", - "Explanation": "[]", + "Explanation": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"慢会话详情\"}},[{\"Layout\":\"vertical\",\"DataType\":\"table\",\"Data\":{\"Names\":[\"Schema\",{\"Type\":\"sql\",\"Name\":\"SqlText\"}],\"Data\":[{\"Schema\":\"demo\",\"SqlText\":\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\"}]}}]]", "StartTime": "2019-11-06 12:05:40", "Severity": 4, "EventId": 5, diff --git a/tccli/examples/dbbrain/v20191016/DescribeUserSqlAdvice.md b/tccli/examples/dbbrain/v20191016/DescribeUserSqlAdvice.md index 5074159936..df0a15a5a6 100644 --- a/tccli/examples/dbbrain/v20191016/DescribeUserSqlAdvice.md +++ b/tccli/examples/dbbrain/v20191016/DescribeUserSqlAdvice.md @@ -15,10 +15,10 @@ Output: { "Response": { "RequestId": "e2a51350-8c9f-11eb-bc0f-c9f5ab88d057", - "Advices": "[{\"TableName\": \"t1\", \"TableSchema\": \"test\", \"Keys\": [{\"SqlText\": \"alter table `test`.`t1` add index index_0(`id`);\"}]}]", + "Advices": "[{\"TableName\": \"t1\", \"TableSchema\": \"demo_db\", \"Keys\": [{\"SqlText\": \"alter table `test`.`t1` add index index_0(`id`);\"}]}]", "Comments": "[\"Failed to parse SQL statement\"]", "Schema": "demo_db", - "Tables": "[{\"TableName\": \"t1\", \"TableSchema\": \"test\", \"TableDDL\": \"CREATE TABLE `test` (\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\"}]", + "Tables": "[{\"TableName\": \"t1\", \"TableSchema\": \"demo_db\", \"TableDDL\": \"CREATE TABLE `test` (\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\"}]", "SqlText": "select * from t1 where id in ( ? )", "SqlPlan": "{\"Before\": [{\"Format\": \"Table\", \"Data\": {\"Names\": [\"id\", \"select_type\", \"table\", \"partitions\", \"type\", \"possible_keys\", \"key\", \"key_len\", \"ref\", \"rows\", \"filtered\", \"Extra\"], \"Data\": [ [1, \"SIMPLE\", \"t1\", null, \"ALL\", null, null, null, null, 1530, 10, \"Using where\" ]]}}], \"After\": [{ \"Format\": \"Table\", \"Data\": {\"Names\": [\"id\", \"select_type\", \"table\", \"partitions\", \"type\", \"possible_keys\", \"key\", \"key_len\", \"ref\", \"rows\", \"filtered\", \"Extra\"], \"Data\": [[1, \"SIMPLE\", \"t1\", null, \"ref\", \"index_0\", \"index_0\", 1056, \"const\", 51, 100.00, null]]}}]}", "Cost": "{\"Before\": 0.1, \"After\": 0.03, \"Ratio\": 90.61}" @@ -45,8 +45,8 @@ Output: "RequestId": "e2a51350-8c9f-11eb-bc0f-c9f5ab88d057", "Advices": "", "Comments": "", - "Schema": "test", - "Tables": "[{\"TableName\": \"t1\", \"TableSchema\": \"test\", \"TableDDL\": \"CREATE TABLE `test` (\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\"}]", + "Schema": "demo_db", + "Tables": "[{\"TableName\": \"t1\", \"TableSchema\": \"demo_db\", \"TableDDL\": \"CREATE TABLE `test` (\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\"}]", "SqlText": "select * from t1 where id in ( ? )", "SqlPlan": "", "Cost": "" diff --git a/tccli/examples/dbbrain/v20210527/CreateDBDiagReportTask.md b/tccli/examples/dbbrain/v20210527/CreateDBDiagReportTask.md index 0c664ca7ad..91143dea74 100644 --- a/tccli/examples/dbbrain/v20210527/CreateDBDiagReportTask.md +++ b/tccli/examples/dbbrain/v20210527/CreateDBDiagReportTask.md @@ -6,7 +6,7 @@ Input: ``` tccli dbbrain CreateDBDiagReportTask --cli-unfold-argument \ - --InstanceId test \ + --InstanceId cdb-test1234 \ --StartTime 2019-01-01T00:00:00+08:00 \ --EndTime 2019-01-02T00:00:00+08:00 \ --SendMailFlag 1 \ diff --git a/tccli/examples/dbbrain/v20210527/CreateProxySessionKillTask.md b/tccli/examples/dbbrain/v20210527/CreateProxySessionKillTask.md index deddfe21d9..93e0feed2d 100644 --- a/tccli/examples/dbbrain/v20210527/CreateProxySessionKillTask.md +++ b/tccli/examples/dbbrain/v20210527/CreateProxySessionKillTask.md @@ -14,8 +14,8 @@ Output: ``` { "Response": { - "AsyncRequestId": 123456, - "RequestId": "xx" + "AsyncRequestId": 14672492, + "RequestId": "17351ed0-c126-11ef-9567-2ff75b8b0530" } } ``` diff --git a/tccli/examples/dbbrain/v20210527/DescribeAlarmTemplate.md b/tccli/examples/dbbrain/v20210527/DescribeAlarmTemplate.md index 3679f998fa..1da21108c8 100644 --- a/tccli/examples/dbbrain/v20210527/DescribeAlarmTemplate.md +++ b/tccli/examples/dbbrain/v20210527/DescribeAlarmTemplate.md @@ -6,7 +6,7 @@ Input: ``` tccli dbbrain DescribeAlarmTemplate --cli-unfold-argument \ - --TemplateNameRegexp test \ + --TemplateNameRegexp demoTemplate \ --Limit 50 \ --Offset 0 ``` diff --git a/tccli/examples/dbbrain/v20210527/DescribeDBDiagEvent.md b/tccli/examples/dbbrain/v20210527/DescribeDBDiagEvent.md index 77bb856ed2..cab5b2c760 100644 --- a/tccli/examples/dbbrain/v20210527/DescribeDBDiagEvent.md +++ b/tccli/examples/dbbrain/v20210527/DescribeDBDiagEvent.md @@ -6,7 +6,7 @@ Input: ``` tccli dbbrain DescribeDBDiagEvent --cli-unfold-argument \ - --InstanceId test \ + --InstanceId cdb-test1234 \ --EventId 5 ``` @@ -14,11 +14,11 @@ Output: ``` { "Response": { - "Suggestions": "[]", + "Suggestions": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"SQL优化\"}},[{\"DataType\":\"sqlAdvice\",\"Data\":{\"Advices\":[{\"TableName\":\"t1\",\"TableSchema\":\"demo\",\"Keys\":[{\"SqlText\":\"alter table `demo`.`t1` add index index_0(`c_time`);\"}]}],\"Comments\":[],\"Schema\":\"demo\",\"SqlPlan\":{},\"SqlText\":\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\",\"Tables\":[{\"TableName\":\"t1\",\"TableSchema\":\"demo\",\"TableDDL\":\"CREATE TABLE `t1` (\\n `id` int NOT NULL AUTO_INCREMENT,\\n `c_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,\\n `name` varchar(32) DEFAULT NULL,\\n `age` int NOT NULL DEFAULT '0',\\n PRIMARY KEY (`id`)\\n) ENGINE=InnoDB AUTO_INCREMENT=786393 DEFAULT CHARSET=utf8mb3\"}],\"Cost\":{\"Before\":1.060202269597E10,\"After\":1.060202269597E10,\"Ratio\":0}}}]]", "DiagType": "数据库快照", "EndTime": "2019-11-06 12:05:50", "RequestId": "78cf7bb1-0608-11ea-a9ef-2736f0f7f829", - "Explanation": "[]", + "Explanation": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"慢会话详情\"}},[{\"Layout\":\"vertical\",\"DataType\":\"table\",\"Data\":{\"Names\":[\"Schema\",{\"Type\":\"sql\",\"Name\":\"SqlText\"}],\"Data\":[{\"Schema\":\"demo\",\"SqlText\":\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\"}]}}]]", "StartTime": "2019-11-06 12:05:40", "Severity": 4, "EventId": 5, diff --git a/tccli/examples/dbbrain/v20210527/DescribeSlowLogTopSqls.md b/tccli/examples/dbbrain/v20210527/DescribeSlowLogTopSqls.md index 7bef8b35ae..d7d7c3cb4b 100644 --- a/tccli/examples/dbbrain/v20210527/DescribeSlowLogTopSqls.md +++ b/tccli/examples/dbbrain/v20210527/DescribeSlowLogTopSqls.md @@ -6,7 +6,7 @@ Input: ``` tccli dbbrain DescribeSlowLogTopSqls --cli-unfold-argument \ - --InstanceId test \ + --InstanceId cdb-test1234 \ --SortBy QueryTime \ --OrderBy ASC \ --Limit 10 \ @@ -33,7 +33,7 @@ Output: "RowsExaminedMin": 0, "RowsSentMin": 0, "SqlText": "select * from user where name='sz'", - "Schema": "test", + "Schema": "dbName", "LockTimeMax": 0.0, "LockTimeRatio": 0.0, "ExecTimes": 2, diff --git a/tccli/examples/dbbrain/v20210527/DescribeUserSqlAdvice.md b/tccli/examples/dbbrain/v20210527/DescribeUserSqlAdvice.md index 3b6d2994c9..8f97f42f31 100644 --- a/tccli/examples/dbbrain/v20210527/DescribeUserSqlAdvice.md +++ b/tccli/examples/dbbrain/v20210527/DescribeUserSqlAdvice.md @@ -45,8 +45,8 @@ Output: "RequestId": "e2a51350-8c9f-11eb-bc0f-c9f5ab88d057", "Advices": "", "Comments": "", - "Schema": "test", - "Tables": "[{\"TableName\": \"t1\", \"TableSchema\": \"test\", \"TableDDL\": \"CREATE TABLE `test` (\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\"}]", + "Schema": "demo_db", + "Tables": "[{\"TableName\": \"t1\", \"TableSchema\": \"demo_db\", \"TableDDL\": \"CREATE TABLE `test` (\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\"}]", "SqlText": "select * from t1 where id in ( ? )", "SqlPlan": "", "Cost": "" diff --git a/tccli/examples/dts/v20180330/CreateMigrateJob.md b/tccli/examples/dts/v20180330/CreateMigrateJob.md index 908f889204..6aa1550000 100644 --- a/tccli/examples/dts/v20180330/CreateMigrateJob.md +++ b/tccli/examples/dts/v20180330/CreateMigrateJob.md @@ -25,10 +25,10 @@ tccli dts CreateMigrateJob --cli-unfold-argument \ --DstInfo.ReadOnly 0 \ --DstInfo.User root \ --DstInfo.Password yourPassword \ - --DatabaseInfo [{"Database":"test","Table":["user","log"]}] \ + --DatabaseInfo \ --Tags.0.TagKey 负责人 \ --Tags.0.TagValue bob \ - --MigrateOption.ExternParams {} \ + --MigrateOption.ExternParams \ --MigrateOption.MigrateObject 1 \ --MigrateOption.RunMode 1 \ --MigrateOption.ExpectTime 2020-09-22 00:00:00 \ @@ -69,10 +69,10 @@ tccli dts CreateMigrateJob --cli-unfold-argument \ --DstInfo.ReadOnly 0 \ --DstInfo.User root \ --DstInfo.Password yourPassword \ - --DatabaseInfo [] \ + --DatabaseInfo \ --Tags.0.TagKey 负责人 \ --Tags.0.TagValue bob \ - --MigrateOption.ExternParams {} \ + --MigrateOption.ExternParams \ --MigrateOption.MigrateObject 1 \ --MigrateOption.RunMode 1 \ --MigrateOption.ExpectTime 2020-09-22 00:00:00 \ @@ -115,10 +115,10 @@ tccli dts CreateMigrateJob --cli-unfold-argument \ --DstInfo.ReadOnly 0 \ --DstInfo.User root \ --DstInfo.Password yourPassword \ - --DatabaseInfo [] \ + --DatabaseInfo \ --Tags.0.TagKey 负责人 \ --Tags.0.TagValue bob \ - --MigrateOption.ExternParams {} \ + --MigrateOption.ExternParams \ --MigrateOption.MigrateObject 1 \ --MigrateOption.RunMode 1 \ --MigrateOption.ExpectTime 2020-09-22 00:00:00 \ diff --git a/tccli/examples/dts/v20180330/DescribeMigrateJobs.md b/tccli/examples/dts/v20180330/DescribeMigrateJobs.md index 7978fef442..ed633fb9b9 100644 --- a/tccli/examples/dts/v20180330/DescribeMigrateJobs.md +++ b/tccli/examples/dts/v20180330/DescribeMigrateJobs.md @@ -28,7 +28,7 @@ Output: "MigrateObject": 2, "ConsistencyType": 5, "IsOverrideRoot": 0, - "ExternParams": "[]", + "ExternParams": "", "ConsistencyParams": { "SelectRowsPerTable": 0, "TablesSelectAll": 0, @@ -50,7 +50,10 @@ Output: "UniqVpnGwId": "", "InstanceId": "", "Region": "ap-guangzhou", - "VpcId": "" + "VpcId": "", + "CcnId": "", + "EngineVersion": "", + "Supplier": "" }, "DstAccessType": "cdb", "DstDatabaseType": "mysql", @@ -59,7 +62,9 @@ Output: "Ip": "", "Port": 0, "Region": "ap-shanghai", - "ReadOnly": 0 + "ReadOnly": 0, + "User": "", + "Password": "" }, "Tags": [ { @@ -77,11 +82,12 @@ Output: "StepInfo": [] }, "Status": 1, - "DatabaseInfo": "[]", + "DatabaseInfo": "", "CreateTime": "2018-05-24 15:06:03", "StartTime": "0000-00-00 00:00:00", "EndTime": "0000-00-00 00:00:00", - "ErrorInfo": [] + "ErrorInfo": [], + "SrcInfoMulti": [] } ], "RequestId": "c032aab5-b56a-428d-9cf7-e5f324ee408b" diff --git a/tccli/examples/dts/v20211206/DescribeCompareReport.md b/tccli/examples/dts/v20211206/DescribeCompareReport.md index 1a9a29ae2e..2e19006e7c 100644 --- a/tccli/examples/dts/v20211206/DescribeCompareReport.md +++ b/tccli/examples/dts/v20211206/DescribeCompareReport.md @@ -15,85 +15,68 @@ Output: { "Response": { "Abstract": { - "Options": { - "Method": "abc", - "SampleRate": 0, - "ThreadCount": 0 - }, + "CheckedTables": 1, + "Conclusion": "same", + "DifferentRows": 0, + "DifferentTables": 0, + "DstSampleRows": 0, + "FinishedAt": "2024-12-20 19:07:20", + "NearlyTableCount": 1, "Objects": { - "ObjectMode": "abc", + "AdvancedObjects": [], "ObjectItems": [ { - "DbName": "abc", - "SchemaName": "abc", - "DbMode": "abc", - "TableMode": "abc", + "DbMode": "partial", + "DbName": "db_1", + "SchemaName": "", + "TableMode": "partial", "Tables": [ { - "TableName": "abc", - "ColumnMode": "abc", - "Columns": [ - { - "ColumnName": "abc" - } - ] + "ColumnMode": "all", + "Columns": [], + "TableName": "tb_1" } ], - "ViewMode": "abc", - "Views": [ - { - "ViewName": "abc" - } - ] + "ViewMode": "partial", + "Views": null } ], - "AdvancedObjects": [ - "abc" - ] + "ObjectMode": "partial" }, - "Conclusion": "abc", - "Status": "abc", - "TotalTables": 1, - "CheckedTables": 1, - "DifferentTables": 1, - "SkippedTables": 1, - "NearlyTableCount": 1, - "DifferentRows": 1, - "SrcSampleRows": 1, - "DstSampleRows": 1, - "StartedAt": "abc", - "FinishedAt": "abc" + "Options": { + "Method": "dataCheck", + "SampleRate": 100, + "ThreadCount": 1 + }, + "SkippedTables": 0, + "SrcSampleRows": 0, + "StartedAt": "2024-12-20 19:04:03", + "Status": "success", + "TotalTables": 1 }, "Detail": { "Difference": { - "TotalCount": 1, - "Items": [ - { - "Db": "abc", - "Table": "abc", - "Chunk": 0, - "SrcItem": "abc", - "DstItem": "abc", - "IndexName": "abc", - "LowerBoundary": "abc", - "UpperBoundary": "abc", - "CostTime": 0, - "FinishedAt": "abc" - } - ] + "Items": [], + "TotalCount": 0 + }, + "DifferenceAdvancedObjects": { + "Items": null, + "TotalCount": 0 + }, + "DifferenceData": { + "Items": null, + "TotalCount": 0 + }, + "DifferenceRow": { + "Items": null, + "TotalCount": 0 }, "Skipped": { - "TotalCount": 1, - "Items": [ - { - "Db": "abc", - "Table": "abc", - "Reason": "abc" - } - ] + "Items": [], + "TotalCount": 0 } }, - "RequestId": "abc" + "RequestId": "a3365b29-2042-4565-9206-8df9e2af1a17" } } ``` diff --git a/tccli/examples/dts/v20211206/DescribeMigrationDetail.md b/tccli/examples/dts/v20211206/DescribeMigrationDetail.md index feda4eb728..8ceeb0576c 100644 --- a/tccli/examples/dts/v20211206/DescribeMigrationDetail.md +++ b/tccli/examples/dts/v20211206/DescribeMigrationDetail.md @@ -227,7 +227,7 @@ Output: "EngineVersion": "", "Host": "", "InstanceId": "cdb-o7uph0cj", - "Password": "xxx", + "Password": "Abc_123456789", "Port": 0, "Role": "", "SubnetId": "", @@ -340,7 +340,7 @@ Output: "EngineVersion": "5.7", "Host": "9.123.456.789", "InstanceId": "", - "Password": "xxx", + "Password": "Abc_123456789", "Port": 31035, "Role": "", "SubnetId": "", diff --git a/tccli/examples/dts/v20211206/DescribeSyncJobs.md b/tccli/examples/dts/v20211206/DescribeSyncJobs.md index f0ea2b6f48..10ab261a36 100644 --- a/tccli/examples/dts/v20211206/DescribeSyncJobs.md +++ b/tccli/examples/dts/v20211206/DescribeSyncJobs.md @@ -173,6 +173,7 @@ Output: } }, "OfflineTime": "0000-00-00 00:00:00", + "OptObjStatus": "Normal", "Options": { "AddAdditionalColumn": false, "AutoRetryTimeRangeMinutes": 0, diff --git a/tccli/examples/dts/v20211206/ModifyMigrationJob.md b/tccli/examples/dts/v20211206/ModifyMigrationJob.md index be1edb6e92..05eb97a941 100644 --- a/tccli/examples/dts/v20211206/ModifyMigrationJob.md +++ b/tccli/examples/dts/v20211206/ModifyMigrationJob.md @@ -6,102 +6,86 @@ Input: ``` tccli dts ModifyMigrationJob --cli-unfold-argument \ - --JobId abc \ - --JobName abc \ - --RunMode abc \ - --ExpectRunTime abc \ - --MigrateOption.MigrateType abc \ - --MigrateOption.Consistency.Mode abc \ - --MigrateOption.DatabaseTable.ObjectMode abc \ - --MigrateOption.DatabaseTable.Databases.0.DbName abc \ - --MigrateOption.DatabaseTable.Databases.0.NewDbName abc \ - --MigrateOption.DatabaseTable.Databases.0.SchemaName abc \ - --MigrateOption.DatabaseTable.Databases.0.NewSchemaName abc \ - --MigrateOption.DatabaseTable.Databases.0.DBMode abc \ - --MigrateOption.DatabaseTable.Databases.0.SchemaMode abc \ - --MigrateOption.DatabaseTable.Databases.0.TableMode abc \ - --MigrateOption.DatabaseTable.Databases.0.Tables.0.TableName abc \ - --MigrateOption.DatabaseTable.Databases.0.Tables.0.NewTableName abc \ - --MigrateOption.DatabaseTable.Databases.0.Tables.0.TmpTables abc \ - --MigrateOption.DatabaseTable.Databases.0.Tables.0.TableEditMode abc \ - --MigrateOption.DatabaseTable.Databases.0.ViewMode abc \ - --MigrateOption.DatabaseTable.Databases.0.Views.0.ViewName abc \ - --MigrateOption.DatabaseTable.Databases.0.Views.0.NewViewName abc \ - --MigrateOption.DatabaseTable.Databases.0.RoleMode abc \ - --MigrateOption.DatabaseTable.Databases.0.Roles.0.RoleName abc \ - --MigrateOption.DatabaseTable.Databases.0.Roles.0.NewRoleName abc \ - --MigrateOption.DatabaseTable.Databases.0.FunctionMode abc \ - --MigrateOption.DatabaseTable.Databases.0.TriggerMode abc \ - --MigrateOption.DatabaseTable.Databases.0.EventMode abc \ - --MigrateOption.DatabaseTable.Databases.0.ProcedureMode abc \ - --MigrateOption.DatabaseTable.Databases.0.Functions abc \ - --MigrateOption.DatabaseTable.Databases.0.Procedures abc \ - --MigrateOption.DatabaseTable.Databases.0.Events abc \ - --MigrateOption.DatabaseTable.Databases.0.Triggers abc \ - --MigrateOption.DatabaseTable.AdvancedObjects abc \ + --JobId dts-efyc7e7l \ + --JobName dts-efyc7e7l \ + --RunMode immediate \ + --ExpectRunTime 2024-12-20 19:01:07 \ + --MigrateOption.MigrateType fullAndIncrement \ + --MigrateOption.Consistency.Mode full \ + --MigrateOption.DatabaseTable.ObjectMode partial \ + --MigrateOption.DatabaseTable.Databases.0.DbName db_1 \ + --MigrateOption.DatabaseTable.Databases.0.NewDbName \ + --MigrateOption.DatabaseTable.Databases.0.SchemaName \ + --MigrateOption.DatabaseTable.Databases.0.NewSchemaName \ + --MigrateOption.DatabaseTable.Databases.0.DBMode partial \ + --MigrateOption.DatabaseTable.Databases.0.SchemaMode \ + --MigrateOption.DatabaseTable.Databases.0.TableMode partial \ + --MigrateOption.DatabaseTable.Databases.0.Tables.0.TableName tb_1 \ + --MigrateOption.DatabaseTable.Databases.0.Tables.0.NewTableName \ + --MigrateOption.DatabaseTable.Databases.0.Tables.0.TableEditMode \ + --MigrateOption.DatabaseTable.Databases.0.ViewMode partial \ + --MigrateOption.DatabaseTable.Databases.0.Views.0.ViewName view_tb_1 \ + --MigrateOption.DatabaseTable.Databases.0.Views.0.NewViewName \ + --MigrateOption.DatabaseTable.Databases.0.RoleMode \ + --MigrateOption.DatabaseTable.Databases.0.FunctionMode \ + --MigrateOption.DatabaseTable.Databases.0.TriggerMode \ + --MigrateOption.DatabaseTable.Databases.0.EventMode \ + --MigrateOption.DatabaseTable.Databases.0.ProcedureMode \ --MigrateOption.IsMigrateAccount True \ --MigrateOption.IsOverrideRoot True \ --MigrateOption.IsDstReadOnly True \ - --MigrateOption.ExtraAttr.0.Key abc \ - --MigrateOption.ExtraAttr.0.Value abc \ - --SrcInfo.Supplier abc \ - --SrcInfo.Region abc \ - --SrcInfo.AccessType abc \ - --SrcInfo.DatabaseType abc \ - --SrcInfo.NodeType abc \ - --SrcInfo.Info.0.Role abc \ - --SrcInfo.Info.0.DbKernel abc \ - --SrcInfo.Info.0.Host abc \ - --SrcInfo.Info.0.Port 1 \ - --SrcInfo.Info.0.User abc \ - --SrcInfo.Info.0.Password abc \ - --SrcInfo.Info.0.CvmInstanceId abc \ - --SrcInfo.Info.0.UniqVpnGwId abc \ - --SrcInfo.Info.0.UniqDcgId abc \ - --SrcInfo.Info.0.InstanceId abc \ - --SrcInfo.Info.0.CcnGwId abc \ - --SrcInfo.Info.0.VpcId abc \ - --SrcInfo.Info.0.SubnetId abc \ - --SrcInfo.Info.0.EngineVersion abc \ - --SrcInfo.Info.0.Account abc \ - --SrcInfo.Info.0.AccountRole abc \ - --SrcInfo.Info.0.AccountMode abc \ - --SrcInfo.Info.0.TmpSecretId abc \ - --SrcInfo.Info.0.TmpSecretKey abc \ - --SrcInfo.Info.0.TmpToken abc \ - --SrcInfo.ExtraAttr.0.Key abc \ - --SrcInfo.ExtraAttr.0.Value abc \ - --SrcInfo.DatabaseNetEnv abc \ - --DstInfo.Supplier abc \ - --DstInfo.Region abc \ - --DstInfo.AccessType abc \ - --DstInfo.DatabaseType abc \ - --DstInfo.NodeType abc \ - --DstInfo.Info.0.Role abc \ - --DstInfo.Info.0.DbKernel abc \ - --DstInfo.Info.0.Host abc \ - --DstInfo.Info.0.Port 1 \ - --DstInfo.Info.0.User abc \ - --DstInfo.Info.0.Password abc \ - --DstInfo.Info.0.CvmInstanceId abc \ - --DstInfo.Info.0.UniqVpnGwId abc \ - --DstInfo.Info.0.UniqDcgId abc \ - --DstInfo.Info.0.InstanceId abc \ - --DstInfo.Info.0.CcnGwId abc \ - --DstInfo.Info.0.VpcId abc \ - --DstInfo.Info.0.SubnetId abc \ - --DstInfo.Info.0.EngineVersion abc \ - --DstInfo.Info.0.Account abc \ - --DstInfo.Info.0.AccountRole abc \ - --DstInfo.Info.0.AccountMode abc \ - --DstInfo.Info.0.TmpSecretId abc \ - --DstInfo.Info.0.TmpSecretKey abc \ - --DstInfo.Info.0.TmpToken abc \ - --DstInfo.ExtraAttr.0.Key abc \ - --DstInfo.ExtraAttr.0.Value abc \ - --DstInfo.DatabaseNetEnv abc \ - --Tags.0.TagKey abc \ - --Tags.0.TagValue abc \ + --SrcInfo.Supplier \ + --SrcInfo.Region ap-qingyuan \ + --SrcInfo.AccessType cdb \ + --SrcInfo.DatabaseType mysql \ + --SrcInfo.NodeType \ + --SrcInfo.Info.0.Role \ + --SrcInfo.Info.0.DbKernel \ + --SrcInfo.Info.0.Host \ + --SrcInfo.Info.0.Port 0 \ + --SrcInfo.Info.0.User tencent \ + --SrcInfo.Info.0.Password tencent*** \ + --SrcInfo.Info.0.CvmInstanceId \ + --SrcInfo.Info.0.UniqVpnGwId \ + --SrcInfo.Info.0.UniqDcgId \ + --SrcInfo.Info.0.InstanceId cdb-4gp2nzqy \ + --SrcInfo.Info.0.CcnGwId \ + --SrcInfo.Info.0.VpcId \ + --SrcInfo.Info.0.SubnetId \ + --SrcInfo.Info.0.EngineVersion 8.0 \ + --SrcInfo.Info.0.Account \ + --SrcInfo.Info.0.AccountRole \ + --SrcInfo.Info.0.AccountMode \ + --SrcInfo.Info.0.TmpSecretId \ + --SrcInfo.Info.0.TmpSecretKey \ + --SrcInfo.Info.0.TmpToken \ + --SrcInfo.DatabaseNetEnv \ + --DstInfo.Supplier \ + --DstInfo.Region ap-qingyuan \ + --DstInfo.AccessType cdb \ + --DstInfo.DatabaseType mysql \ + --DstInfo.NodeType \ + --DstInfo.Info.0.Role \ + --DstInfo.Info.0.DbKernel \ + --DstInfo.Info.0.Host \ + --DstInfo.Info.0.Port 0 \ + --DstInfo.Info.0.User tencent \ + --DstInfo.Info.0.Password tencent*** \ + --DstInfo.Info.0.CvmInstanceId \ + --DstInfo.Info.0.UniqVpnGwId \ + --DstInfo.Info.0.UniqDcgId \ + --DstInfo.Info.0.InstanceId cdb-4gp2nzqy \ + --DstInfo.Info.0.CcnGwId \ + --DstInfo.Info.0.VpcId \ + --DstInfo.Info.0.SubnetId \ + --DstInfo.Info.0.EngineVersion 8.0 \ + --DstInfo.Info.0.Account \ + --DstInfo.Info.0.AccountRole \ + --DstInfo.Info.0.AccountMode \ + --DstInfo.Info.0.TmpSecretId \ + --DstInfo.Info.0.TmpSecretKey \ + --DstInfo.Info.0.TmpToken \ + --DstInfo.DatabaseNetEnv \ --AutoRetryTimeRangeMinutes 0 ``` @@ -109,7 +93,7 @@ Output: ``` { "Response": { - "RequestId": "abc" + "RequestId": "a3365b29-2042-4565-9206-8df9e2af1a17" } } ``` diff --git a/tccli/examples/ecm/v20190719/AllocateAddresses.md b/tccli/examples/ecm/v20190719/AllocateAddresses.md index 69fd2299b5..e34f1b1564 100644 --- a/tccli/examples/ecm/v20190719/AllocateAddresses.md +++ b/tccli/examples/ecm/v20190719/AllocateAddresses.md @@ -18,7 +18,7 @@ Output: "AddressSet": [ "eip-11112222" ], - "TaskId": "123", + "TaskId": "202869021", "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7" } } diff --git a/tccli/examples/ecm/v20190719/AssociateAddress.md b/tccli/examples/ecm/v20190719/AssociateAddress.md index 4f597acf52..4db798d1c6 100644 --- a/tccli/examples/ecm/v20190719/AssociateAddress.md +++ b/tccli/examples/ecm/v20190719/AssociateAddress.md @@ -15,7 +15,7 @@ Output: ``` { "Response": { - "TaskId": "123", + "TaskId": "202869021", "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03" } } diff --git a/tccli/examples/ecm/v20190719/DescribeAddresses.md b/tccli/examples/ecm/v20190719/DescribeAddresses.md index d1280d801c..ef05653fc5 100644 --- a/tccli/examples/ecm/v20190719/DescribeAddresses.md +++ b/tccli/examples/ecm/v20190719/DescribeAddresses.md @@ -18,15 +18,21 @@ Output: "AddressSet": [ { "AddressId": "eip-11221122", - "AddressName": "test", + "AddressName": "demo", "AddressIp": "123.121.34.33", "AddressStatus": "BINDED", + "AddressType": "EIP", "InstanceId": "ins-11221122", - "NetworkInterfaceId": null, - "PrivateAddressIp": null, + "NetworkInterfaceId": "eni-2regnhmp", + "PrivateAddressIp": "10.212.0.26", "IsArrears": false, "IsBlocked": false, - "CreatedTime": "2020-01-12T07:52:00Z" + "IsEipDirectConnection": true, + "CascadeRelease": false, + "CreatedTime": "2024-12-03T02:19:31Z", + "Bandwidth": 2048, + "PayMode": "BANDWIDTH_PACKAGE", + "InternetServiceProvider": "CUCC" } ], "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03" diff --git a/tccli/examples/ecm/v20190719/DisassociateAddress.md b/tccli/examples/ecm/v20190719/DisassociateAddress.md index b5e4abca05..8dfe7f0161 100644 --- a/tccli/examples/ecm/v20190719/DisassociateAddress.md +++ b/tccli/examples/ecm/v20190719/DisassociateAddress.md @@ -14,7 +14,7 @@ Output: ``` { "Response": { - "TaskId": "123", + "TaskId": "824963", "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03" } } diff --git a/tccli/examples/ecm/v20190719/ModifyAddressesBandwidth.md b/tccli/examples/ecm/v20190719/ModifyAddressesBandwidth.md index 83a87b1ee9..d1f424e050 100644 --- a/tccli/examples/ecm/v20190719/ModifyAddressesBandwidth.md +++ b/tccli/examples/ecm/v20190719/ModifyAddressesBandwidth.md @@ -15,7 +15,7 @@ Output: ``` { "Response": { - "TaskId": "123", + "TaskId": "3594621", "RequestId": "24cfceab-3492-482c-b86f-27f598b1b044" } } diff --git a/tccli/examples/ecm/v20190719/ReleaseAddresses.md b/tccli/examples/ecm/v20190719/ReleaseAddresses.md index 0d23e062db..0634c7aa27 100644 --- a/tccli/examples/ecm/v20190719/ReleaseAddresses.md +++ b/tccli/examples/ecm/v20190719/ReleaseAddresses.md @@ -14,7 +14,7 @@ Output: ``` { "Response": { - "TaskId": "123", + "TaskId": "4569821", "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7" } } diff --git a/tccli/examples/ecm/v20190719/ReleaseIpv6AddressesBandwidth.md b/tccli/examples/ecm/v20190719/ReleaseIpv6AddressesBandwidth.md index 651a2a161c..1e624d43a9 100644 --- a/tccli/examples/ecm/v20190719/ReleaseIpv6AddressesBandwidth.md +++ b/tccli/examples/ecm/v20190719/ReleaseIpv6AddressesBandwidth.md @@ -14,7 +14,7 @@ Output: ``` { "Response": { - "TaskId": 202869021, + "TaskId": "2568423", "RequestId": "aac03e7b-3c91-4970-b2bc-c20f0c6bdd38" } } diff --git a/tccli/examples/emr/v20190103/AddNodeResourceConfig.md b/tccli/examples/emr/v20190103/AddNodeResourceConfig.md new file mode 100644 index 0000000000..4f2c1c20c3 --- /dev/null +++ b/tccli/examples/emr/v20190103/AddNodeResourceConfig.md @@ -0,0 +1,56 @@ +**Example 1: 增加当前集群的节点规格配置** + + + +Input: + +``` +tccli emr AddNodeResourceConfig --cli-unfold-argument \ + --InstanceId abc \ + --ResourceType abc \ + --IsDefault abc \ + --ResourceConfig.Spec abc \ + --ResourceConfig.StorageType 0 \ + --ResourceConfig.DiskType abc \ + --ResourceConfig.RootSize 0 \ + --ResourceConfig.MemSize 0 \ + --ResourceConfig.Cpu 0 \ + --ResourceConfig.DiskSize 0 \ + --ResourceConfig.MultiDisks.0.DiskType abc \ + --ResourceConfig.MultiDisks.0.Volume 0 \ + --ResourceConfig.MultiDisks.0.Count 0 \ + --ResourceConfig.Tags.0.TagKey abc \ + --ResourceConfig.Tags.0.TagValue abc \ + --ResourceConfig.InstanceType abc \ + --ResourceConfig.LocalDiskNum 1 \ + --ResourceConfig.DiskNum 1 \ + --PayMode 0 \ + --ZoneId 0 \ + --MultipleResourceConfig.0.Spec abc \ + --MultipleResourceConfig.0.StorageType 0 \ + --MultipleResourceConfig.0.DiskType abc \ + --MultipleResourceConfig.0.RootSize 0 \ + --MultipleResourceConfig.0.MemSize 0 \ + --MultipleResourceConfig.0.Cpu 0 \ + --MultipleResourceConfig.0.DiskSize 0 \ + --MultipleResourceConfig.0.MultiDisks.0.DiskType abc \ + --MultipleResourceConfig.0.MultiDisks.0.Volume 0 \ + --MultipleResourceConfig.0.MultiDisks.0.Count 0 \ + --MultipleResourceConfig.0.Tags.0.TagKey abc \ + --MultipleResourceConfig.0.Tags.0.TagValue abc \ + --MultipleResourceConfig.0.InstanceType abc \ + --MultipleResourceConfig.0.LocalDiskNum 1 \ + --MultipleResourceConfig.0.DiskNum 1 \ + --ResourceBaseType abc \ + --ComputeResourceId abc +``` + +Output: +``` +{ + "Response": { + "RequestId": "f0f11d21-6d0d-4f73-9177-8ae4ec456068" + } +} +``` + diff --git a/tccli/examples/emr/v20190103/AttachDisks.md b/tccli/examples/emr/v20190103/AttachDisks.md new file mode 100644 index 0000000000..2164c48730 --- /dev/null +++ b/tccli/examples/emr/v20190103/AttachDisks.md @@ -0,0 +1,21 @@ +**Example 1: 云盘挂载** + + + +Input: + +``` +tccli emr AttachDisks --cli-unfold-argument \ + --InstanceId emr-xxxx \ + --DiskIds disk-xxx1 disk-xxx2 +``` + +Output: +``` +{ + "Response": { + "RequestId": "95eb9120-0883-407c-aa5a-43b4e2c250d1" + } +} +``` + diff --git a/tccli/examples/emr/v20190103/DeleteNodeResourceConfig.md b/tccli/examples/emr/v20190103/DeleteNodeResourceConfig.md new file mode 100644 index 0000000000..6a22198b39 --- /dev/null +++ b/tccli/examples/emr/v20190103/DeleteNodeResourceConfig.md @@ -0,0 +1,24 @@ +**Example 1: 输入输出例子** + + + +Input: + +``` +tccli emr DeleteNodeResourceConfig --cli-unfold-argument \ + --InstanceId abc \ + --ResourceType abc \ + --ResourceConfigId 1 \ + --ResourceBaseType abc \ + --ComputeResourceId abc +``` + +Output: +``` +{ + "Response": { + "RequestId": "8c2ff02e-5f38-494a-8d2d-68a7dec6efcd" + } +} +``` + diff --git a/tccli/examples/emr/v20190103/DescribeNodeDataDisks.md b/tccli/examples/emr/v20190103/DescribeNodeDataDisks.md new file mode 100644 index 0000000000..331bd0516f --- /dev/null +++ b/tccli/examples/emr/v20190103/DescribeNodeDataDisks.md @@ -0,0 +1,46 @@ +**Example 1: 查询节点数据盘信息** + + + +Input: + +``` +tccli emr DescribeNodeDataDisks --cli-unfold-argument \ + --InstanceId emr-xxxxxxx \ + --CvmInstanceIds ins-xxxxxxxx +``` + +Output: +``` +{ + "Response": { + "CBSList": [ + { + "DeleteWithInstance": true, + "DiskChargeType": "POSTPAID_BY_HOUR", + "DiskId": "disk-xxxxxxxx", + "DiskName": "未命名_1", + "DiskSize": 100, + "DiskState": "ATTACHED", + "DiskType": "CLOUD_SSD", + "DiskUsage": "DATA_DISK", + "DeadlineTime": "" + }, + { + "DeleteWithInstance": true, + "DiskChargeType": "POSTPAID_BY_HOUR", + "DiskId": "disk-xxxxxxxx", + "DiskName": "未命名_0", + "DiskSize": 50, + "DiskState": "ATTACHED", + "DiskType": "CLOUD_SSD", + "DiskUsage": "SYSTEM_DISK", + "DeadlineTime": "" + } + ], + "RequestId": "9dd6b795-aed5-4a09-b493-f460c1f1a0c5", + "TotalCount": 2 + } +} +``` + diff --git a/tccli/examples/emr/v20190103/DescribeNodeResourceConfigFast.md b/tccli/examples/emr/v20190103/DescribeNodeResourceConfigFast.md new file mode 100644 index 0000000000..e3daf3dd7f --- /dev/null +++ b/tccli/examples/emr/v20190103/DescribeNodeResourceConfigFast.md @@ -0,0 +1,102 @@ +**Example 1: DescribeNodeResourceConfigFast示例** + + + +Input: + +``` +tccli emr DescribeNodeResourceConfigFast --cli-unfold-argument \ + --InstanceId emr-laoxdz4n \ + --ResourceType ALL \ + --PayMode 0 +``` + +Output: +``` +{ + "Response": { + "Data": [ + { + "ResourceData": [ + { + "CreateTime": "2024-03-25 17:52:23", + "IsDefault": "DEFAULT", + "MaxResourceNum": 0, + "Resource": { + "Cpu": 4, + "DiskNum": 1, + "DiskSize": 200, + "DiskType": "CLOUD_SSD", + "InstanceType": "SA2.LARGE8", + "LocalDiskNum": 0, + "MemSize": 8192, + "MultiDisks": [], + "RootSize": 70, + "Spec": "CVM.SA2", + "StorageType": 4, + "Tags": null + }, + "ResourceConfigId": 20332, + "UpdateTime": "2024-03-25 17:52:23" + } + ], + "ResourceType": "CORE" + }, + { + "ResourceData": [ + { + "CreateTime": "2024-04-08 15:13:04", + "IsDefault": "DEFAULT", + "MaxResourceNum": 0, + "Resource": { + "Cpu": 8, + "DiskNum": 1, + "DiskSize": 200, + "DiskType": "CLOUD_HSSD", + "InstanceType": "S6.2XLARGE32", + "LocalDiskNum": 0, + "MemSize": 32768, + "MultiDisks": [], + "RootSize": 70, + "Spec": "CVM.S6", + "StorageType": 6, + "Tags": null + }, + "ResourceConfigId": 20560, + "UpdateTime": "2024-04-08 15:13:04" + } + ], + "ResourceType": "TASK" + }, + { + "ResourceData": [ + { + "CreateTime": "2024-04-08 22:04:42", + "IsDefault": "DEFAULT", + "MaxResourceNum": 0, + "Resource": { + "Cpu": 4, + "DiskNum": 1, + "DiskSize": 200, + "DiskType": "CLOUD_HSSD", + "InstanceType": "SA2.LARGE8", + "LocalDiskNum": 0, + "MemSize": 8192, + "MultiDisks": [], + "RootSize": 70, + "Spec": "CVM.SA2", + "StorageType": 6, + "Tags": null + }, + "ResourceConfigId": 20563, + "UpdateTime": "2024-04-08 22:04:42" + } + ], + "ResourceType": "ROUTER" + } + ], + "RequestId": "638ef562-a954-4963-ae70-b54c2dd2bf94" + } +} +``` + diff --git a/tccli/examples/emr/v20190103/ModifyInstanceBasic.md b/tccli/examples/emr/v20190103/ModifyInstanceBasic.md new file mode 100644 index 0000000000..7cd17adbdd --- /dev/null +++ b/tccli/examples/emr/v20190103/ModifyInstanceBasic.md @@ -0,0 +1,23 @@ +**Example 1: ModifyInstanceBasic** + + + +Input: + +``` +tccli emr ModifyInstanceBasic --cli-unfold-argument \ + --InstanceId abc \ + --ClusterName abc \ + --ResourceBaseType abc \ + --ComputeResourceId abc +``` + +Output: +``` +{ + "Response": { + "RequestId": "abc" + } +} +``` + diff --git a/tccli/examples/emr/v20190103/ModifyResource.md b/tccli/examples/emr/v20190103/ModifyResource.md new file mode 100644 index 0000000000..d5428f436a --- /dev/null +++ b/tccli/examples/emr/v20190103/ModifyResource.md @@ -0,0 +1,23 @@ +**Example 1: 变配实例** + + + +Input: + +``` +tccli emr ModifyResource --cli-unfold-argument \ + --InstanceId emr-3ap64zl6 \ + --PayMode 0 \ + --NewCpu 8 \ + --NewMem 32 +``` + +Output: +``` +{ + "Response": { + "RequestId": "ef0a7e45-2f47-4379-bbc8-9594f51cb95f" + } +} +``` + diff --git a/tccli/examples/emr/v20190103/ResizeDataDisks.md b/tccli/examples/emr/v20190103/ResizeDataDisks.md new file mode 100644 index 0000000000..94349b8f7f --- /dev/null +++ b/tccli/examples/emr/v20190103/ResizeDataDisks.md @@ -0,0 +1,23 @@ +**Example 1: 云盘扩容** + + + +Input: + +``` +tccli emr ResizeDataDisks --cli-unfold-argument \ + --InstanceId emr-xxxx \ + --CvmInstanceIds ins-xx \ + --DiskIds disk-xxx1 disk-xxx2 \ + --DiskSize 500 +``` + +Output: +``` +{ + "Response": { + "RequestId": "95eb9120-0883-407c-aa5a-43b4e2c250d1" + } +} +``` + diff --git a/tccli/examples/emr/v20190103/SetNodeResourceConfigDefault.md b/tccli/examples/emr/v20190103/SetNodeResourceConfigDefault.md new file mode 100644 index 0000000000..a8e1e24086 --- /dev/null +++ b/tccli/examples/emr/v20190103/SetNodeResourceConfigDefault.md @@ -0,0 +1,24 @@ +**Example 1: 输出输入参数** + + + +Input: + +``` +tccli emr SetNodeResourceConfigDefault --cli-unfold-argument \ + --InstanceId abc \ + --ResourceType abc \ + --ResourceConfigId 1 \ + --ResourceBaseType abc \ + --ComputeResourceId abc +``` + +Output: +``` +{ + "Response": { + "RequestId": "8c2ff02e-5f38-494a-8d2d-68a7dec6efcd" + } +} +``` + diff --git a/tccli/examples/essbasic/v20210526/ChannelCreateBatchSignUrl.md b/tccli/examples/essbasic/v20210526/ChannelCreateBatchSignUrl.md index 51c0ff755a..5ec83a70b8 100644 --- a/tccli/examples/essbasic/v20210526/ChannelCreateBatchSignUrl.md +++ b/tccli/examples/essbasic/v20210526/ChannelCreateBatchSignUrl.md @@ -159,3 +159,34 @@ Output: } ``` +**Example 6: 生成动态签署人批量领取链接-并且预设平台子客企业OpenId** + +按照合同发起时候返回的合同信息生成批量签署链接,通过FlowIds参数对用户可以批签的合同进行限制,并指定批量领取的动态签署方,预设了平台子客企业OpenId后进入领取链接只能以该平台子客企业企业身份去领取并签署合同 + +Input: + +``` +tccli essbasic ChannelCreateBatchSignUrl --cli-unfold-argument \ + --Agent.ProxyOperator.OpenId test_open_id \ + --Agent.ProxyOrganizationOpenId test_org_open_id \ + --Agent.AppId yDxbWUyKQ*******4zjEB8mxCcDjAyF \ + --FlowIds yDwFdUUckpsw******yQ0af8bHosXQtb yDR1AUUgygj******uO4zjE8gTG7xvgH \ + --FlowBatchUrlInfo.FlowBatchApproverInfos.0.FlowId yDwFdUUckpsw******yQ0af8bHosXQtb \ + --FlowBatchUrlInfo.FlowBatchApproverInfos.0.RecipientId yDC5yUUckpwexozwUuoHfkTwB00zdfLo \ + --FlowBatchUrlInfo.FlowBatchApproverInfos.1.FlowId yDR1AUUgygj******uO4zjE8gTG7xvgH \ + --FlowBatchUrlInfo.FlowBatchApproverInfos.1.RecipientId yDCY3UUckp7tpp8rUEGRbNoRjQJ7t9bd \ + --OrganizationOpenId test_org_open_id +``` + +Output: +``` +{ + "Response": { + "ExpiredTime": 1735801457, + "MiniAppPath": "pages/guide/index?shortKey=yDCYSUx7LAQNwHZxaR93", + "RequestId": "s1735196657684290155", + "SignUrl": "https://essurl.cn/exssUH2TNe" + } +} +``` + diff --git a/tccli/examples/essbasic/v20210526/CreateSignUrls.md b/tccli/examples/essbasic/v20210526/CreateSignUrls.md index 651ec926a4..e4b1f4b06b 100644 --- a/tccli/examples/essbasic/v20210526/CreateSignUrls.md +++ b/tccli/examples/essbasic/v20210526/CreateSignUrls.md @@ -466,3 +466,56 @@ Output: } ``` +**Example 10: 获取合同组动态签署人补充链接, 并且预设平台子客企业OpenId** + +获取动态签署人补充链接,创建合同组时未指定具体签署人,可获取链接后推送给指定的人进行补充 +注: +`1.参数GenerateType需传值为RECIPIENT` +`2.需指定对应的合同组FlowGroupUrlInfo签署方角色编号(即RecipientId)` +`3.通过参数OrganizationOpenId 指定要以那个平台子企业身份进行补充` + + +Input: + +``` +tccli essbasic CreateSignUrls --cli-unfold-argument \ + --FlowGroupId yDCVAUUckpwa592pUxoLjOlRVS9Zgusf \ + --FlowGroupUrlInfo.FlowGroupApproverInfos.0.FlowId yDCVAUUckpwa59rcUxoLjOlEctyesTzj \ + --FlowGroupUrlInfo.FlowGroupApproverInfos.0.RecipientId yDCVAUUckpwa59riUxoLjOluu9cf6B3s \ + --FlowGroupUrlInfo.FlowGroupApproverInfos.1.FlowId yDCVAUUckpwa592dUxoLjOl8StWKvg9K \ + --FlowGroupUrlInfo.FlowGroupApproverInfos.1.RecipientId yDCVAUUckpwa59r6UxoLjOlCC6ZHk7rL \ + --GenerateType RECIPIENT \ + --OrganizationOpenId dian_zi_qian \ + --Agent.ProxyOrganizationOpenId 1000***8062 \ + --Agent.ProxyOperator.OpenId yDR3L****eTdCt5TVx \ + --Agent.AppId 125***319 +``` + +Output: +``` +{ + "Response": { + "ErrorMessages": [], + "RequestId": "s1735197391369377331", + "SignUrlInfos": [ + { + "ApproverType": "", + "CustomUserId": "", + "Deadline": 0, + "FlowGroupId": "", + "FlowId": "yDCVAUUckpwa592pUxoLjOlRVS9Zgusf", + "IdCardNumber": "", + "Mobile": "", + "Name": "", + "OpenId": "", + "OrganizationName": "", + "SignId": "", + "SignOrder": 0, + "SignQrcodeUrl": "https://file.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06d80c4246fb57d8a524d6bfe32b7434ba9f1xxxxxx1dc3aff08c747a658df2039a153bf6256b31d292522a4231", + "SignUrl": "https://essurl.cn/pazAUBJ4vi" + } + ] + } +} +``` + diff --git a/tccli/examples/gaap/v20180529/CreateCertificate.md b/tccli/examples/gaap/v20180529/CreateCertificate.md index 66d02cc3d1..bd6a0436a4 100644 --- a/tccli/examples/gaap/v20180529/CreateCertificate.md +++ b/tccli/examples/gaap/v20180529/CreateCertificate.md @@ -7,9 +7,9 @@ Input: ``` tccli gaap CreateCertificate --cli-unfold-argument \ --CertificateType 2 \ - --CertificateAlias xxx \ + --CertificateAlias cert-alias \ --CertificateKey %0A-----BEGIN%20RSA%20PRIVATE%20KEY-----%0Axxxxxxxxxxx%0A-----END%20RSA%20PRIVATE%20KEY-----%0A \ - --CertificateContent %0A-----BEGIN%20CERTIFICATE-----%0AMIIFmDCCBICgAwIBAgIQC6TGAPV%2B4MO7NIhlkkKFljANBgkqhkiG9w0BAQsFADBy%0AMQswCQYDVQQGEwJDTjElMCMGA1UEChMcVHJ1c3RBc2lhIFRlY2hub2xvZ2llcywg%0ASW5jLjEdMBsGA1UECxMURG9tYWluIFZhbGlkYXRlZCBTU0wxHTAbBgNVBAMTFFRy%0AdXN0QXNpYSBUTFMgUlNBIENBMB4XDTE5MDQwMjAwMDAwMFoXDTIwMDQwMTEyMDAw%0AMFowGTEXMBUGA1UEAxMObGFnYW1lZnQwMS54eXowggEiMA0GCSqGSIb3DQEBAQUA%0AA4IBDwAwggEKAoIBAQCuSgglfAksbFSrvWp6cEFr8ulTWEND2KvXf6cCs3kBBCzE%0AMLhCw4792LMFY0%2BFE7a0j7i5nJ9%2BQvhX7GRiu1P9flyge0eUCOBOAtVCn0dvhbLy%0A7efWsmH3kp/owWXnZXeb/k5R1FvojCiV968MxMC%2B2Y7ejz5qMm5XlQPn3xQOEj2h%0AQmHwQ9XwO8qRsIuCD1oNrsXsyXuEhA2zkEvcgtYP35zPsXfjbBaBg7Iw3o0j3jXj%0AgdhD2Q2OzH05jDn3hDhSnej1jbWuGmDEOO%2Bu6W/xqnCOhBMjWLnuW2aUddiBiqsH%0A8BQK/Ge6HUp%2BmMdkdNAw5FN6ztIPzP6GFb0OOLitAgMBAAGjggKBMIICfTAfBgNV%0AHSMEGDAWgBR/05nzoEcOMQBWViKOt8ye3coBijAdBgNVHQ4EFgQUqYL1l3uFqYHC%0A2mJcZC26nLHtkjYwLQYDVR0RBCYwJIIObGFnYW1lZnQwMS54eXqCEnd3dy5sYWdh%0AbWVmdDAxLnh5ejAOBgNVHQ8BAf8EBAMCBaAwHQYDVR0lBBYwFAYIKwYBBQUHAwEG%0ACCsGAQUFBwMCMEwGA1UdIARFMEMwNwYJYIZIAYb9bAECMCowKAYIKwYBBQUHAgEW%0AHGh0dHBzOi8vd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwCAYGZ4EMAQIBMH0GCCsGAQUF%0ABwEBBHEwbzAhBggrBgEFBQcwAYYVaHR0cDovL29jc3AuZGNvY3NwLmNuMEoGCCsG%0AAQUFBzAChj5odHRwOi8vY2FjZXJ0cy5kaWdpdGFsY2VydHZhbGlkYXRpb24uY29t%0AL1RydXN0QXNpYVRMU1JTQUNBLmNydDAJBgNVHRMEAjAAMIIBAwYKKwYBBAHWeQIE%0AAgSB9ASB8QDvAHUAu9nfvB%2BKcbWTlCOXqpJ7RzhXlQqrUugakJZkNo4e0YUAAAFp%0A3cON9gAABAMARjBEAiABFpvdLsJKm6zxh5wLS6uN5%2BTnX8bXD5bj7CPVC4Kg/wIg%0AB%2BBzdsZL0UmuvbNAYkr8W53bJKhEgoHJ0RdSyoF5yZAAdgCHdb/nWXz4jEOZX73z%0Abv9WjUdWNv9KtWDBtOr/XqCDDwAAAWndw47mAAAEAwBHMEUCIQC%2BDdvaJ2kKvsVv%0AiivLe4W/YFa/K64HdnyOdHksEl9pSAIgTqLXfw6Tc7d%2BgiKMtt%2B6P/xdrvjGt5Du%0Aokvgu70INuQwDQYJKoZIhvcNAQELBQADggEBAHxewHgySBS5UoO6l/IcU95baR/O%0AYGLcCpgEbWj4MigIZcrkHsD7RddRDoyM/3hxKyzs3Dkes4wHTQDWnyrNuXdn8aNV%0AJAhrh/0yzAe3/UTJ/%2BSRoMg1K6rHWORmLa52d9u3Ei%2B1BF2qLi5L2tTmLrSQJXzB%0ANSIFd40x1mZLp9uqhcB9kcwwkHSFUtLjFwUSN6Zjn9FStlq06ezjgnVv2tP9/HoP%0AKWiRgRFDgqj8%2BROJPQvfuO2xdWoxYUmuMcx1o6IiSVn2F48ood029cyT%2Bt3TaYpb%0AhVI9JuYnHW9kN69xPNzamJVCdu4i/1ELvcr0p/wQf9ax63XsgX4YYhdYgMQ%3D%0A-----END%20CERTIFICATE-----%0A-----BEGIN%20CERTIFICATE-----%0AMIIErjCCA5agAwIBAgIQBYAmfwbylVM0jhwYWl7uLjANBgkqhkiG9w0BAQsFADBh%0AMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3%0Ad3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBD%0AQTAeFw0xNzEyMDgxMjI4MjZaFw0yNzEyMDgxMjI4MjZaMHIxCzAJBgNVBAYTAkNO%0AMSUwIwYDVQQKExxUcnVzdEFzaWEgVGVjaG5vbG9naWVzLCBJbmMuMR0wGwYDVQQL%0AExREb21haW4gVmFsaWRhdGVkIFNTTDEdMBsGA1UEAxMUVHJ1c3RBc2lhIFRMUyBS%0AU0EgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCgWa9X%2Bph%2BwAm8%0AYh1Fk1MjKbQ5QwBOOKVaZR/OfCh%2BF6f93u7vZHGcUU/lvVGgUQnbzJhR1UV2epJa%0Ae%2Bm7cxnXIKdD0/VS9btAgwJszGFvwoqXeaCqFoP71wPmXjjUwLT70%2BqvX4hdyYfO%0AJcjeTz5QKtg8zQwxaK9x4JT9CoOmoVdVhEBAiD3DwR5fFgOHDwwGxdJWVBvktnoA%0AzjdTLXDdbSVC5jZ0u8oq9BiTDv7jAlsB5F8aZgvSZDOQeFrwaOTbKWSEInEhnchK%0AZTD1dz6aBlk1xGEI5PZWAnVAba/ofH33ktymaTDsE6xRDnW97pDkimCRak6CEbfe%0A3dXw6OV5AgMBAAGjggFPMIIBSzAdBgNVHQ4EFgQUf9OZ86BHDjEAVlYijrfMnt3K%0AAYowHwYDVR0jBBgwFoAUA95QNVbRTLtm8KPiGxvDl7I90VUwDgYDVR0PAQH/BAQD%0AAgGGMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjASBgNVHRMBAf8ECDAG%0AAQH/AgEAMDQGCCsGAQUFBwEBBCgwJjAkBggrBgEFBQcwAYYYaHR0cDovL29jc3Au%0AZGlnaWNlcnQuY29tMEIGA1UdHwQ7MDkwN6A1oDOGMWh0dHA6Ly9jcmwzLmRpZ2lj%0AZXJ0LmNvbS9EaWdpQ2VydEdsb2JhbFJvb3RDQS5jcmwwTAYDVR0gBEUwQzA3Bglg%0AhkgBhv1sAQIwKjAoBggrBgEFBQcCARYcaHR0cHM6Ly93d3cuZGlnaWNlcnQuY29t%0AL0NQUzAIBgZngQwBAgEwDQYJKoZIhvcNAQELBQADggEBAK3dVOj5dlv4MzK2i233%0AlDYvyJ3slFY2X2HKTYGte8nbK6i5/fsDImMYihAkp6VaNY/en8WZ5qcrQPVLuJrJ%0ADSXT04NnMeZOQDUoj/NHAmdfCBB/h1bZ5OGK6Sf1h5Yx/5wR4f3TUoPgGlnU7EuP%0AISLNdMRiDrXntcImDAiRvkh5GJuH4YCVE6XEntqaNIgGkRwxKSgnU3Id3iuFbW9F%0AUQ9Qqtb1GX91AJ7i4153TikGgYCdwYkBURD8gSVe8OAco6IfZOYt/TEwii1Ivi1C%0AqnuUlWpsF1LdQNIdfbW3TSe0BhQa7ifbVIfvPWHYOu3rkg1ZeMo6XRU9B4n5VyJY%0ARmE%3D%0A-----END%20CERTIFICATE-----%0A + --CertificateContent %0A-----BEGIN%20CERTIFICATE-----%0AMIIFmDIUJIJL.......C%0A-----END%20CERTIFICATE-----%0A ``` Output: @@ -17,7 +17,7 @@ Output: { "Response": { "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8", - "CertificateId": "cert-xxx" + "CertificateId": "cert-jlwr6865" } } ``` @@ -31,7 +31,7 @@ Input: ``` tccli gaap CreateCertificate --cli-unfold-argument \ --CertificateType 2 \ - --CertificateAlias 123 \ + --CertificateAlias cert-alias \ --CertificateKey -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAn7CUY5bRNtt/YVT9BBDtfyqmF09KXzI+BCrIvrGDrjxRdIsT Hs0xZL5EbZXt7uc5leXJ47RnVAQtNMCOuqeYtFWNMzGydVchMkImBHEsATE+ukqs diff --git a/tccli/examples/gaap/v20180529/CreateDomain.md b/tccli/examples/gaap/v20180529/CreateDomain.md index 0aee93c6f0..c11ce489bd 100644 --- a/tccli/examples/gaap/v20180529/CreateDomain.md +++ b/tccli/examples/gaap/v20180529/CreateDomain.md @@ -7,7 +7,7 @@ Input: ``` tccli gaap CreateDomain --cli-unfold-argument \ --Domain a.a.com \ - --CertificateId abc \ + --CertificateId cert-lal2lslf \ --ListenerId 0 ``` diff --git a/tccli/examples/gaap/v20180529/CreateProxy.md b/tccli/examples/gaap/v20180529/CreateProxy.md index 908d45c2ee..16bc6071fd 100644 --- a/tccli/examples/gaap/v20180529/CreateProxy.md +++ b/tccli/examples/gaap/v20180529/CreateProxy.md @@ -7,7 +7,7 @@ Input: ``` tccli gaap CreateProxy --cli-unfold-argument \ --ProjectId 0 \ - --ProxyName test \ + --ProxyName proxy-name \ --AccessRegion Hongkong \ --Bandwidth 10 \ --Concurrent 2 \ diff --git a/tccli/examples/gaap/v20180529/CreateProxyGroup.md b/tccli/examples/gaap/v20180529/CreateProxyGroup.md index 0c331f0ad3..1f7b1fe7b5 100644 --- a/tccli/examples/gaap/v20180529/CreateProxyGroup.md +++ b/tccli/examples/gaap/v20180529/CreateProxyGroup.md @@ -8,7 +8,7 @@ Input: tccli gaap CreateProxyGroup --cli-unfold-argument \ --ProjectId 0 \ --RealServerRegion EastChina \ - --GroupName test + --GroupName group-name ``` Output: diff --git a/tccli/examples/gaap/v20180529/DeleteCertificate.md b/tccli/examples/gaap/v20180529/DeleteCertificate.md index 2b03d0dc65..0751c305ba 100644 --- a/tccli/examples/gaap/v20180529/DeleteCertificate.md +++ b/tccli/examples/gaap/v20180529/DeleteCertificate.md @@ -6,7 +6,7 @@ Input: ``` tccli gaap DeleteCertificate --cli-unfold-argument \ - --CertificateId xxxx + --CertificateId cert-l2l4l545 ``` Output: diff --git a/tccli/examples/gaap/v20180529/DescribeAccessRegions.md b/tccli/examples/gaap/v20180529/DescribeAccessRegions.md index dcbc2a4117..a39fef1e5f 100644 --- a/tccli/examples/gaap/v20180529/DescribeAccessRegions.md +++ b/tccli/examples/gaap/v20180529/DescribeAccessRegions.md @@ -1,4 +1,4 @@ -**Example 1: 示例** +**Example 1: 查询加速区域** @@ -14,20 +14,20 @@ Output: "TotalCount": 1, "AccessRegionSet": [ { - "RegionId": "abc", - "RegionName": "abc", - "RegionArea": "abc", - "RegionAreaName": "abc", - "IDCType": "abc", + "RegionId": "NorthChina", + "RegionName": "中国大陆-华北", + "RegionArea": "NorthChina", + "RegionAreaName": "中国大陆-华北", + "IDCType": "dc", "FeatureBitmap": 1, "SupportFeature": { "NetworkType": [ - "abc" + "normal" ] } } ], - "RequestId": "abc" + "RequestId": "209e95b9-488d-4a58-bc86-810859577af3" } } ``` diff --git a/tccli/examples/gaap/v20180529/DescribeAuthSignature.md b/tccli/examples/gaap/v20180529/DescribeAuthSignature.md index 5477f87636..dc56e45e3d 100644 --- a/tccli/examples/gaap/v20180529/DescribeAuthSignature.md +++ b/tccli/examples/gaap/v20180529/DescribeAuthSignature.md @@ -11,7 +11,7 @@ Output: ``` { "Response": { - "RequestId": "abc" + "RequestId": "250de15a-35fa-4f3b-9924-25c2b9d9bb1e" } } ``` diff --git a/tccli/examples/gaap/v20180529/DescribeCertificates.md b/tccli/examples/gaap/v20180529/DescribeCertificates.md index 355f6a289b..c4a38c5e43 100644 --- a/tccli/examples/gaap/v20180529/DescribeCertificates.md +++ b/tccli/examples/gaap/v20180529/DescribeCertificates.md @@ -21,8 +21,8 @@ Output: { "CertificateId": "cert-8k1l0pat", "SubjectCN": "lagameft01.xyz", - "CertificateAlias": "test", - "CertificateName": "test", + "CertificateAlias": "alias-name", + "CertificateName": "cert-name", "BeginTime": 1554134400, "CertificateType": 2, "EndTime": 1585713600, diff --git a/tccli/examples/gaap/v20180529/DescribeGlobalDomains.md b/tccli/examples/gaap/v20180529/DescribeGlobalDomains.md index a98a2ba66a..19193f0af0 100644 --- a/tccli/examples/gaap/v20180529/DescribeGlobalDomains.md +++ b/tccli/examples/gaap/v20180529/DescribeGlobalDomains.md @@ -19,7 +19,7 @@ Output: { "DomainId": "dm-00ye8ek7", "FullDomain": "gd-qbsrvjtf.gaapqcloud.com.cn", - "Alias": "abc", + "Alias": "alias-name", "Type": "IP", "Status": 0, "ProjectId": 0, @@ -30,7 +30,7 @@ Output: "TagSet": [ { "TagKey": "project", - "TagValue": "abc" + "TagValue": "tag-value" } ], "BanStatus": "RECOVER" diff --git a/tccli/examples/gaap/v20180529/DescribeHTTPListeners.md b/tccli/examples/gaap/v20180529/DescribeHTTPListeners.md index 928f8f6c8b..9e5e5793db 100644 --- a/tccli/examples/gaap/v20180529/DescribeHTTPListeners.md +++ b/tccli/examples/gaap/v20180529/DescribeHTTPListeners.md @@ -20,7 +20,7 @@ Output: "ListenerSet": [ { "ListenerId": "listener-kuwra6qh", - "ListenerName": "test", + "ListenerName": "listener-name", "Port": 80, "CreateTime": 1729568991, "Protocol": "HTTP", diff --git a/tccli/examples/gaap/v20180529/DescribeHTTPSListeners.md b/tccli/examples/gaap/v20180529/DescribeHTTPSListeners.md index ef4b19601f..d0abb54129 100644 --- a/tccli/examples/gaap/v20180529/DescribeHTTPSListeners.md +++ b/tccli/examples/gaap/v20180529/DescribeHTTPSListeners.md @@ -18,34 +18,34 @@ Output: "TotalCount": 1, "ListenerSet": [ { - "ListenerId": "abc", - "ListenerName": "abc", + "ListenerId": "listener-12345", + "ListenerName": "listener-name", "Port": 1, - "Protocol": "abc", + "Protocol": "TCP", "ListenerStatus": 1, - "CertificateId": "abc", - "ForwardProtocol": "abc", + "CertificateId": "cert-12345", + "ForwardProtocol": "TCP", "CreateTime": 1, - "CertificateAlias": "abc", - "ClientCertificateId": "abc", + "CertificateAlias": "alias-name", + "ClientCertificateId": "cert-54321", "AuthType": 0, - "ClientCertificateAlias": "abc", + "ClientCertificateAlias": "alias-name", "PolyClientCertificateAliasInfo": [ { - "CertificateId": "abc", - "CertificateAlias": "abc" + "CertificateId": "cert-12345", + "CertificateAlias": "cert-alias" } ], "Http3Supported": 0, - "ProxyId": "abc", - "GroupId": "abc", + "ProxyId": "link-12345", + "GroupId": "lg-12345", "TLSSupportVersion": [ - "abc" + "TLSv1.1" ], - "TLSCiphers": "abc" + "TLSCiphers": "GAAP_TLS_CIPHERS_WIDE" } ], - "RequestId": "abc" + "RequestId": "209e95b9-488d-4a58-bc86-810859577af3" } } ``` diff --git a/tccli/examples/gaap/v20180529/DescribeProxyDetail.md b/tccli/examples/gaap/v20180529/DescribeProxyDetail.md index e6698d8d1d..8bf96db91b 100644 --- a/tccli/examples/gaap/v20180529/DescribeProxyDetail.md +++ b/tccli/examples/gaap/v20180529/DescribeProxyDetail.md @@ -55,7 +55,7 @@ Output: "ForwardIP": "124.222.42.242;118.25.142.34;", "TagSet": [ { - "TagKey": "test", + "TagKey": "tag-key", "TagValue": "10" } ], @@ -90,103 +90,3 @@ Output: } ``` -**Example 2: 查询通道详情2** - - - -Input: - -``` -tccli gaap DescribeProxyDetail --cli-unfold-argument \ - --ProxyId link-4m6fx36h -``` - -Output: -``` -{ - "Response": { - "ProxyDetail": { - "InstanceId": "abc", - "CreateTime": 1, - "ProjectId": 0, - "ProxyName": "abc", - "AccessRegion": "abc", - "RealServerRegion": "abc", - "Bandwidth": 0, - "Concurrent": 0, - "Status": "abc", - "Domain": "abc", - "IP": "abc", - "Version": "abc", - "ProxyId": "abc", - "Scalarable": 0, - "SupportProtocols": [ - "abc" - ], - "GroupId": "abc", - "PolicyId": "abc", - "AccessRegionInfo": { - "RegionId": "abc", - "RegionName": "abc", - "RegionArea": "abc", - "RegionAreaName": "abc", - "IDCType": "abc", - "FeatureBitmap": 1, - "SupportFeature": { - "NetworkType": [ - "abc" - ] - } - }, - "RealServerRegionInfo": { - "RegionId": "abc", - "RegionName": "abc", - "RegionArea": "abc", - "RegionAreaName": "abc", - "IDCType": "abc", - "FeatureBitmap": 1, - "SupportFeature": { - "NetworkType": [ - "abc" - ] - } - }, - "ForwardIP": "abc", - "TagSet": [ - { - "TagKey": "abc", - "TagValue": "abc" - } - ], - "SupportSecurity": 0, - "BillingType": 0, - "RelatedGlobalDomains": [ - "abc" - ], - "ModifyConfigTime": 1, - "ProxyType": 1, - "ClientIPMethod": [ - 0 - ], - "IPAddressVersion": "abc", - "NetworkType": "abc", - "PackageType": "abc", - "BanStatus": "abc", - "IPList": [ - { - "IP": "abc", - "Provider": "abc", - "Bandwidth": 0 - } - ], - "Http3Supported": 0, - "InBanBlacklist": 0, - "FeatureBitmap": 0, - "IsAutoScaleProxy": 0, - "IsSupportTLSChoice": 0 - }, - "RequestId": "abc" - } -} -``` - diff --git a/tccli/examples/gaap/v20180529/DescribeProxyGroupDetails.md b/tccli/examples/gaap/v20180529/DescribeProxyGroupDetails.md index 42914fbbc3..746e676164 100644 --- a/tccli/examples/gaap/v20180529/DescribeProxyGroupDetails.md +++ b/tccli/examples/gaap/v20180529/DescribeProxyGroupDetails.md @@ -6,7 +6,7 @@ Input: ``` tccli gaap DescribeProxyGroupDetails --cli-unfold-argument \ - --GroupId lg + --GroupId lg-123456 ``` Output: @@ -18,44 +18,44 @@ Output: "ProjectId": 0, "ProxyNum": 0, "Status": 0, - "OwnerUin": "abc", - "CreateUin": "abc", - "GroupName": "abc", - "DnsDefaultIp": "abc", - "Domain": "abc", + "OwnerUin": "12345678", + "CreateUin": "12345678", + "GroupName": "grup-name", + "DnsDefaultIp": "127.0.0.1", + "Domain": "www.domain.com", + "PolicyId": "gsp-123456", "RealServerRegionInfo": { - "RegionId": "abc", - "RegionName": "abc", - "RegionArea": "abc", - "RegionAreaName": "abc", - "IDCType": "abc", + "RegionId": "Beijing", + "RegionName": "BEIJING", + "RegionArea": "NorthChina", + "RegionAreaName": "NorthChina", + "IDCType": "dc", "FeatureBitmap": 1, "SupportFeature": { "NetworkType": [ - "abc" + "normal" ] } }, "IsOldGroup": true, - "GroupId": "abc", + "GroupId": "lg-123456", "TagSet": [ { - "TagKey": "abc", - "TagValue": "abc" + "TagKey": "tag_key", + "TagValue": "tag_value" } ], - "PolicyId": "abc", - "Version": "abc", + "Version": "3.0", "ClientIPMethod": [ 0 ], - "IPAddressVersion": "abc", - "PackageType": "abc", + "IPAddressVersion": "IPv4", + "PackageType": "BGP", "Http3Supported": 0, "FeatureBitmap": 0, "IsSupportTLSChoice": 1 }, - "RequestId": "abc" + "RequestId": "bf46572b-700d-4797-831c-7fcf8232358a" } } ``` diff --git a/tccli/examples/gaap/v20180529/DescribeRealServerStatistics.md b/tccli/examples/gaap/v20180529/DescribeRealServerStatistics.md index 354df1f7db..9469704671 100644 --- a/tccli/examples/gaap/v20180529/DescribeRealServerStatistics.md +++ b/tccli/examples/gaap/v20180529/DescribeRealServerStatistics.md @@ -27,7 +27,7 @@ Output: "Time": 1 } ], - "MetricName": "xx" + "MetricName": "bandwidth" }, { "MetricData": [ @@ -40,10 +40,10 @@ Output: "Time": 1 } ], - "MetricName": "xx" + "MetricName": "bandwidth" } ], - "RequestId": "xx", + "RequestId": "hlkjlk4-5435jlk-kjl", "StatisticsData": [ { "Data": 0.0, diff --git a/tccli/examples/gaap/v20180529/DescribeRealServersStatus.md b/tccli/examples/gaap/v20180529/DescribeRealServersStatus.md index e7bef39390..99896edf6a 100644 --- a/tccli/examples/gaap/v20180529/DescribeRealServersStatus.md +++ b/tccli/examples/gaap/v20180529/DescribeRealServersStatus.md @@ -14,13 +14,13 @@ Output: { "Response": { "TotalCount": 1, - "RequestId": "xx", + "RequestId": "dad2a717-3c7d-444d-8f98-0cca9c897ff3", "RealServerStatusSet": [ { - "ProxyId": "xx", + "ProxyId": "link-123456", "BindStatus": 0, - "RealServerId": "xx", - "GroupId": "xx" + "RealServerId": "rs-123456", + "GroupId": "lg-123456" } ] } diff --git a/tccli/examples/gaap/v20180529/DescribeResourcesByTag.md b/tccli/examples/gaap/v20180529/DescribeResourcesByTag.md index dca5950eb2..4074522dbc 100644 --- a/tccli/examples/gaap/v20180529/DescribeResourcesByTag.md +++ b/tccli/examples/gaap/v20180529/DescribeResourcesByTag.md @@ -7,8 +7,8 @@ Input: ``` tccli gaap DescribeResourcesByTag --cli-unfold-argument \ --ResourceType Proxy \ - --TagKey testkey \ - --TagValue test + --TagKey tag-key \ + --TagValue tag-value ``` Output: diff --git a/tccli/examples/gaap/v20180529/DescribeRulesByRuleIds.md b/tccli/examples/gaap/v20180529/DescribeRulesByRuleIds.md index 6a7ad8703a..f335f8bdee 100644 --- a/tccli/examples/gaap/v20180529/DescribeRulesByRuleIds.md +++ b/tccli/examples/gaap/v20180529/DescribeRulesByRuleIds.md @@ -22,7 +22,7 @@ Output: "DelayLoop": 30, "Domain": "baidu.com", "Method": "HEAD", - "Path": "/", + "Path": "/path", "StatusCode": [ 100, 200, @@ -36,7 +36,7 @@ Output: "ForwardHost": "baidu.com", "HealthCheck": 0, "ListenerId": "listener-qjm2tftd", - "Path": "/", + "Path": "/path", "RealServerSet": [ { "DownIPList": [], diff --git a/tccli/examples/gaap/v20180529/DescribeTCPListeners.md b/tccli/examples/gaap/v20180529/DescribeTCPListeners.md index c8fec2b8fd..cd8c6b9449 100644 --- a/tccli/examples/gaap/v20180529/DescribeTCPListeners.md +++ b/tccli/examples/gaap/v20180529/DescribeTCPListeners.md @@ -28,7 +28,7 @@ Output: "ListenerId": "listener-gkzl9e7t", "UnhealthyThreshold": 1, "ListenerStatus": 1, - "ListenerName": "test", + "ListenerName": "listener-name", "Scheduler": "rr", "ClientIPMethod": 1, "FailoverSwitch": 1, diff --git a/tccli/examples/gaap/v20180529/DescribeUDPListeners.md b/tccli/examples/gaap/v20180529/DescribeUDPListeners.md index f321c436b4..1e7ef4e1d2 100644 --- a/tccli/examples/gaap/v20180529/DescribeUDPListeners.md +++ b/tccli/examples/gaap/v20180529/DescribeUDPListeners.md @@ -17,12 +17,12 @@ Output: "TotalCount": 1, "ListenerSet": [ { - "RecvContext": "123", + "RecvContext": "recv_contenxt", "RealServerType": "IP", "CheckPort": 4000, "ListenerId": "listener-pbsgn7ej", "ContextType": "TEXT", - "ListenerName": "test", + "ListenerName": "listener-name", "Port": 2000, "BindStatus": 1, "FailoverSwitch": 0, @@ -43,7 +43,7 @@ Output: ], "SessionPersist": 1, "ConnectTimeout": 2, - "SendContext": "123", + "SendContext": "send_context", "HealthCheck": 1, "HealthyThreshold": 1, "DelayLoop": 1, diff --git a/tccli/examples/gaap/v20180529/ModifyCertificateAttributes.md b/tccli/examples/gaap/v20180529/ModifyCertificateAttributes.md index e9406c8edf..7352199f7a 100644 --- a/tccli/examples/gaap/v20180529/ModifyCertificateAttributes.md +++ b/tccli/examples/gaap/v20180529/ModifyCertificateAttributes.md @@ -7,7 +7,7 @@ Input: ``` tccli gaap ModifyCertificateAttributes --cli-unfold-argument \ --CertificateId cert-kj5pa5lj \ - --CertificateAlias test + --CertificateAlias cert-alias ``` Output: diff --git a/tccli/examples/gaap/v20180529/ModifyGlobalDomainAttribute.md b/tccli/examples/gaap/v20180529/ModifyGlobalDomainAttribute.md index 0251b34182..656bca1bfc 100644 --- a/tccli/examples/gaap/v20180529/ModifyGlobalDomainAttribute.md +++ b/tccli/examples/gaap/v20180529/ModifyGlobalDomainAttribute.md @@ -9,7 +9,7 @@ tccli gaap ModifyGlobalDomainAttribute --cli-unfold-argument \ --ProjectId 0 \ --DefaultValue 1.1.1.1 \ --DomainId dm-00ye8ek7 \ - --Alias test + --Alias alias-name ``` Output: diff --git a/tccli/examples/gaap/v20180529/ModifyGroupDomainConfig.md b/tccli/examples/gaap/v20180529/ModifyGroupDomainConfig.md index 2f8f5a9150..2cac602cba 100644 --- a/tccli/examples/gaap/v20180529/ModifyGroupDomainConfig.md +++ b/tccli/examples/gaap/v20180529/ModifyGroupDomainConfig.md @@ -8,7 +8,7 @@ Input: tccli gaap ModifyGroupDomainConfig --cli-unfold-argument \ --DefaultDnsIp 1.1.1.1 \ --GroupId lg-b7h4d02f \ - --AccessRegionList.0.RegionId 111 + --AccessRegionList.0.RegionId Beijing ``` Output: diff --git a/tccli/examples/gaap/v20180529/ModifyProxiesAttribute.md b/tccli/examples/gaap/v20180529/ModifyProxiesAttribute.md index 882bdb0f4c..fddabddd7f 100644 --- a/tccli/examples/gaap/v20180529/ModifyProxiesAttribute.md +++ b/tccli/examples/gaap/v20180529/ModifyProxiesAttribute.md @@ -6,7 +6,7 @@ Input: ``` tccli gaap ModifyProxiesAttribute --cli-unfold-argument \ - --ProxyName test \ + --ProxyName link-name \ --ProxyIds link-11113333 link-11112222 ``` diff --git a/tccli/examples/gaap/v20180529/ModifyProxyGroupAttribute.md b/tccli/examples/gaap/v20180529/ModifyProxyGroupAttribute.md index 0c1897cfa9..eac85b8d14 100644 --- a/tccli/examples/gaap/v20180529/ModifyProxyGroupAttribute.md +++ b/tccli/examples/gaap/v20180529/ModifyProxyGroupAttribute.md @@ -6,7 +6,7 @@ Input: ``` tccli gaap ModifyProxyGroupAttribute --cli-unfold-argument \ - --GroupName test \ + --GroupName group-name \ --GroupId lg-pheemncl ``` diff --git a/tccli/examples/gaap/v20180529/ModifyRuleAttribute.md b/tccli/examples/gaap/v20180529/ModifyRuleAttribute.md index 4897cc00cd..28c283f431 100644 --- a/tccli/examples/gaap/v20180529/ModifyRuleAttribute.md +++ b/tccli/examples/gaap/v20180529/ModifyRuleAttribute.md @@ -8,7 +8,7 @@ Input: tccli gaap ModifyRuleAttribute --cli-unfold-argument \ --ListenerId listener-0s9kb7qt \ --RuleId rule-o8aq26zj \ - --Path / \ + --Path /path \ --ForwardHost www.baidu.com \ --ForcedRedirect \ --Scheduler rr \ @@ -17,7 +17,7 @@ tccli gaap ModifyRuleAttribute --cli-unfold-argument \ --CheckParams.DelayLoop 30 \ --CheckParams.FailedThreshold 5 \ --CheckParams.BlockInter 600 \ - --CheckParams.Path / \ + --CheckParams.Path /path \ --CheckParams.Method HEAD \ --CheckParams.StatusCode 100 200 300 400 500 \ --CheckParams.FailedCountInter 60 \ diff --git a/tccli/examples/gaap/v20180529/SetTlsVersion.md b/tccli/examples/gaap/v20180529/SetTlsVersion.md index 1f936a265d..7c6639593e 100644 --- a/tccli/examples/gaap/v20180529/SetTlsVersion.md +++ b/tccli/examples/gaap/v20180529/SetTlsVersion.md @@ -6,7 +6,7 @@ Input: ``` tccli gaap SetTlsVersion --cli-unfold-argument \ - --ListenerId abc \ + --ListenerId lgl-123456 \ --TLSSupportVersion TLSv1.2 \ --TLSCiphers GAAP_TLS_CIPHERS_GENERAL ``` @@ -15,7 +15,7 @@ Output: ``` { "Response": { - "RequestId": "wqdcasdca-da-wedqfc" + "RequestId": "dad2a717-3c7d-444d-8f98-0cca9c897ff3" } } ``` diff --git a/tccli/examples/gs/v20191118/CreateSession.md b/tccli/examples/gs/v20191118/CreateSession.md index 6b418420df..a81ef9866a 100644 --- a/tccli/examples/gs/v20191118/CreateSession.md +++ b/tccli/examples/gs/v20191118/CreateSession.md @@ -17,7 +17,7 @@ Output: { "Response": { "RoleNumber": "1", - "ServerSession": "abc", + "ServerSession": "e30=", "Role": "Player", "RequestId": "req123" } diff --git a/tccli/examples/gs/v20191118/StartPublishStream.md b/tccli/examples/gs/v20191118/StartPublishStream.md index 1a6747e86b..a88205275e 100644 --- a/tccli/examples/gs/v20191118/StartPublishStream.md +++ b/tccli/examples/gs/v20191118/StartPublishStream.md @@ -6,7 +6,7 @@ Input: ``` tccli gs StartPublishStream --cli-unfold-argument \ - --UserId 123123 \ + --UserId 639d069e-a13a-437a-a10b-64a33ecb8e79 \ --PublishUrl rtmp://live.stream.com/publish ``` diff --git a/tccli/examples/gs/v20191118/StopPublishStream.md b/tccli/examples/gs/v20191118/StopPublishStream.md index d784f7ee50..078284a5d1 100644 --- a/tccli/examples/gs/v20191118/StopPublishStream.md +++ b/tccli/examples/gs/v20191118/StopPublishStream.md @@ -6,7 +6,7 @@ Input: ``` tccli gs StopPublishStream --cli-unfold-argument \ - --UserId 123123 + --UserId 639d069e-a13a-437a-a10b-64a33ecb8e79 ``` Output: diff --git a/tccli/examples/iai/v20200303/DetectFaceSimilarity.md b/tccli/examples/iai/v20200303/DetectFaceSimilarity.md new file mode 100644 index 0000000000..fde3c3a7b7 --- /dev/null +++ b/tccli/examples/iai/v20200303/DetectFaceSimilarity.md @@ -0,0 +1,47 @@ +**Example 1: 人脸相似度检测接口成功示例** + + + +Input: + +``` +tccli iai DetectFaceSimilarity --cli-unfold-argument \ + --UrlA http://test.image.myqcloud.com/testA.jpg \ + --UrlB http://test.image.myqcloud.com/testB.jpg +``` + +Output: +``` +{ + "Response": { + "Score": 0.999, + "RequestId": "a8eb4545-a154-4f86-9510-57a8be9cae0c" + } +} +``` + +**Example 2: 人脸相似度检测接口异常示例** + + + +Input: + +``` +tccli iai DetectFaceSimilarity --cli-unfold-argument \ + --UrlA http://test.image.myqcloud.com/testA.jpg \ + --UrlB http://test.image.myqcloud.com/testB.jpg +``` + +Output: +``` +{ + "Response": { + "Error": { + "Code": "FailedOperation.FaceQualityNotQualified", + "Message": "人脸图片质量不符要求。" + }, + "RequestId": "788270e8-91b7-4c59-bd00-1af257b1e482" + } +} +``` + diff --git a/tccli/examples/live/v20180801/CreateCasterInputPushUrl.md b/tccli/examples/live/v20180801/CreateCasterInputPushUrl.md index 1f6a2cccba..ed76719b62 100644 --- a/tccli/examples/live/v20180801/CreateCasterInputPushUrl.md +++ b/tccli/examples/live/v20180801/CreateCasterInputPushUrl.md @@ -7,7 +7,7 @@ Input: ``` tccli live CreateCasterInputPushUrl --cli-unfold-argument \ --InputIndex 1 \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/CreateLiveCallbackTemplate.md b/tccli/examples/live/v20180801/CreateLiveCallbackTemplate.md index 8b46166062..d559bca154 100644 --- a/tccli/examples/live/v20180801/CreateLiveCallbackTemplate.md +++ b/tccli/examples/live/v20180801/CreateLiveCallbackTemplate.md @@ -13,7 +13,7 @@ tccli live CreateLiveCallbackTemplate --cli-unfold-argument \ --SnapshotNotifyUrl http://www.yourdomain.com/api/notify?action=snapshot \ --PornCensorshipNotifyUrl http://www.yourdomain.com/api/notify?action=porn \ --CallbackKey adasda131312 \ - --Description test + --Description 回调模板 ``` Output: diff --git a/tccli/examples/live/v20180801/CreateLivePadTemplate.md b/tccli/examples/live/v20180801/CreateLivePadTemplate.md index 9a7fe77668..93120dcc55 100644 --- a/tccli/examples/live/v20180801/CreateLivePadTemplate.md +++ b/tccli/examples/live/v20180801/CreateLivePadTemplate.md @@ -6,11 +6,11 @@ Input: ``` tccli live CreateLivePadTemplate --cli-unfold-argument \ - --Url xx \ + --Url http://domain.com/app/name \ --WaitDuration 1 \ - --Description xx \ + --Description pad \ --MaxDuration 1 \ - --TemplateName xx + --TemplateName name ``` Output: diff --git a/tccli/examples/live/v20180801/CreateLivePullStreamTask.md b/tccli/examples/live/v20180801/CreateLivePullStreamTask.md index dddfa812d1..38b5d90d83 100644 --- a/tccli/examples/live/v20180801/CreateLivePullStreamTask.md +++ b/tccli/examples/live/v20180801/CreateLivePullStreamTask.md @@ -9,7 +9,7 @@ tccli live CreateLivePullStreamTask --cli-unfold-argument \ --SourceType PullLivePushLive \ --DomainName 5000.livepush.myqcloud.com \ --SourceUrls rtmp://5000.liveplay.myqcloud.com/live/stream1 \ - --StreamName test \ + --StreamName stream1 \ --AppName live \ --StartTime 2019-12-16T11:02:00Z \ --Operator vinson \ diff --git a/tccli/examples/live/v20180801/CreateLiveRecordTemplate.md b/tccli/examples/live/v20180801/CreateLiveRecordTemplate.md index 65ed5fa9b7..18eccdf77f 100644 --- a/tccli/examples/live/v20180801/CreateLiveRecordTemplate.md +++ b/tccli/examples/live/v20180801/CreateLiveRecordTemplate.md @@ -35,7 +35,7 @@ Input: ``` tccli live CreateLiveRecordTemplate --cli-unfold-argument \ --TemplateName templat \ - --Description test \ + --Description 录制规则 \ --FlvParam.Enable 0 \ --FlvParam.RecordInterval 1800 \ --FlvParam.StorageTime 600 \ diff --git a/tccli/examples/live/v20180801/CreateLiveSnapshotTemplate.md b/tccli/examples/live/v20180801/CreateLiveSnapshotTemplate.md index 956f7d91e7..1a0f950804 100644 --- a/tccli/examples/live/v20180801/CreateLiveSnapshotTemplate.md +++ b/tccli/examples/live/v20180801/CreateLiveSnapshotTemplate.md @@ -13,7 +13,7 @@ tccli live CreateLiveSnapshotTemplate --cli-unfold-argument \ --CosBucket bucket \ --TemplateName testName \ --Height 250 \ - --CosAppId 123 \ + --CosAppId 8954511 \ --Width 250 ``` diff --git a/tccli/examples/live/v20180801/CreateLiveTimeShiftTemplate.md b/tccli/examples/live/v20180801/CreateLiveTimeShiftTemplate.md index f5ce4e5fd3..ddb5ca43f4 100644 --- a/tccli/examples/live/v20180801/CreateLiveTimeShiftTemplate.md +++ b/tccli/examples/live/v20180801/CreateLiveTimeShiftTemplate.md @@ -6,9 +6,9 @@ Input: ``` tccli live CreateLiveTimeShiftTemplate --cli-unfold-argument \ - --TemplateName abc \ - --Description abc \ - --Area abc \ + --TemplateName name \ + --Description timeshift \ + --Area 0 \ --Duration 1 \ --ItemDuration 1 \ --RemoveWatermark True \ @@ -20,7 +20,7 @@ Output: { "Response": { "TemplateId": 0, - "RequestId": "abc" + "RequestId": "3fefec28-3f95-4055-8a22-714cc271251e" } } ``` diff --git a/tccli/examples/live/v20180801/CreateLiveTranscodeTemplate.md b/tccli/examples/live/v20180801/CreateLiveTranscodeTemplate.md index a5a60fb052..4ea2167507 100644 --- a/tccli/examples/live/v20180801/CreateLiveTranscodeTemplate.md +++ b/tccli/examples/live/v20180801/CreateLiveTranscodeTemplate.md @@ -9,7 +9,7 @@ tccli live CreateLiveTranscodeTemplate --cli-unfold-argument \ --Profile main \ --AudioBitrate 500 \ --Rotate 0 \ - --Description test \ + --Description transcode \ --TemplateName 900m \ --VideoBitrate 900 \ --Vcodec h264 \ diff --git a/tccli/examples/live/v20180801/DeleteCaster.md b/tccli/examples/live/v20180801/DeleteCaster.md index 6f6a60de2c..13e367038b 100644 --- a/tccli/examples/live/v20180801/DeleteCaster.md +++ b/tccli/examples/live/v20180801/DeleteCaster.md @@ -6,7 +6,7 @@ Input: ``` tccli live DeleteCaster --cli-unfold-argument \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/DeleteCasterInputInfo.md b/tccli/examples/live/v20180801/DeleteCasterInputInfo.md index 998eee5b1b..be45cb1b4d 100644 --- a/tccli/examples/live/v20180801/DeleteCasterInputInfo.md +++ b/tccli/examples/live/v20180801/DeleteCasterInputInfo.md @@ -1,13 +1,13 @@ **Example 1: 请求示例** -删除导播台1234的输入源1。 +删除导播台63501的输入源1。 Input: ``` tccli live DeleteCasterInputInfo --cli-unfold-argument \ --InputIndex 1 \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/DeleteCasterLayoutInfo.md b/tccli/examples/live/v20180801/DeleteCasterLayoutInfo.md index 21bf05e45b..ca38650f49 100644 --- a/tccli/examples/live/v20180801/DeleteCasterLayoutInfo.md +++ b/tccli/examples/live/v20180801/DeleteCasterLayoutInfo.md @@ -6,7 +6,7 @@ Input: ``` tccli live DeleteCasterLayoutInfo --cli-unfold-argument \ - --CasterId 1234 \ + --CasterId 63501 \ --LayoutIndex 1 ``` diff --git a/tccli/examples/live/v20180801/DeleteCasterMarkPicInfo.md b/tccli/examples/live/v20180801/DeleteCasterMarkPicInfo.md index 6f36eeabe0..f5860fce7d 100644 --- a/tccli/examples/live/v20180801/DeleteCasterMarkPicInfo.md +++ b/tccli/examples/live/v20180801/DeleteCasterMarkPicInfo.md @@ -6,7 +6,7 @@ Input: ``` tccli live DeleteCasterMarkPicInfo --cli-unfold-argument \ - --CasterId 1234 \ + --CasterId 63501 \ --MarkPicIndex 1 ``` diff --git a/tccli/examples/live/v20180801/DeleteCasterMarkWordInfo.md b/tccli/examples/live/v20180801/DeleteCasterMarkWordInfo.md index 656308be51..a96d00b8d5 100644 --- a/tccli/examples/live/v20180801/DeleteCasterMarkWordInfo.md +++ b/tccli/examples/live/v20180801/DeleteCasterMarkWordInfo.md @@ -7,7 +7,7 @@ Input: ``` tccli live DeleteCasterMarkWordInfo --cli-unfold-argument \ --MarkWordIndex 1 \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/DeleteCasterOutputInfo.md b/tccli/examples/live/v20180801/DeleteCasterOutputInfo.md index e2debfe84c..614c730281 100644 --- a/tccli/examples/live/v20180801/DeleteCasterOutputInfo.md +++ b/tccli/examples/live/v20180801/DeleteCasterOutputInfo.md @@ -7,7 +7,7 @@ Input: ``` tccli live DeleteCasterOutputInfo --cli-unfold-argument \ --OutputIndex 1 \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/DeleteLivePadRule.md b/tccli/examples/live/v20180801/DeleteLivePadRule.md index 17c31dcd70..244908f9c2 100644 --- a/tccli/examples/live/v20180801/DeleteLivePadRule.md +++ b/tccli/examples/live/v20180801/DeleteLivePadRule.md @@ -7,9 +7,9 @@ Input: ``` tccli live DeleteLivePadRule --cli-unfold-argument \ --TemplateId 1 \ - --DomainName xx \ - --StreamName xx \ - --AppName xx + --DomainName domain.com \ + --StreamName streamname \ + --AppName appname ``` Output: diff --git a/tccli/examples/live/v20180801/DeleteLiveTimeShiftRule.md b/tccli/examples/live/v20180801/DeleteLiveTimeShiftRule.md index b9c1907e69..8bc4755235 100644 --- a/tccli/examples/live/v20180801/DeleteLiveTimeShiftRule.md +++ b/tccli/examples/live/v20180801/DeleteLiveTimeShiftRule.md @@ -6,9 +6,9 @@ Input: ``` tccli live DeleteLiveTimeShiftRule --cli-unfold-argument \ - --DomainName xx \ - --StreamName xx \ - --AppName xx + --DomainName domain.com \ + --StreamName streamname \ + --AppName appname ``` Output: diff --git a/tccli/examples/live/v20180801/DeleteLiveWatermark.md b/tccli/examples/live/v20180801/DeleteLiveWatermark.md index c64aecc4c7..631f297ea2 100644 --- a/tccli/examples/live/v20180801/DeleteLiveWatermark.md +++ b/tccli/examples/live/v20180801/DeleteLiveWatermark.md @@ -6,7 +6,7 @@ Input: ``` tccli live DeleteLiveWatermark --cli-unfold-argument \ - --WatermarkId 123 + --WatermarkId 43527 ``` Output: diff --git a/tccli/examples/live/v20180801/DescribeCaster.md b/tccli/examples/live/v20180801/DescribeCaster.md index 8cc9fa505c..5695dd2cdb 100644 --- a/tccli/examples/live/v20180801/DescribeCaster.md +++ b/tccli/examples/live/v20180801/DescribeCaster.md @@ -6,7 +6,7 @@ Input: ``` tccli live DescribeCaster --cli-unfold-argument \ - --CasterId 1234 + --CasterId 63501 ``` Output: @@ -14,7 +14,7 @@ Output: { "Response": { "CasterInfo": { - "CasterId": 1234, + "CasterId": 63501, "CasterName": "example", "StartLiveTime": 0, "Description": "", diff --git a/tccli/examples/live/v20180801/DescribeCasterDisplayInfo.md b/tccli/examples/live/v20180801/DescribeCasterDisplayInfo.md index cf7ff630ba..19c0a764a1 100644 --- a/tccli/examples/live/v20180801/DescribeCasterDisplayInfo.md +++ b/tccli/examples/live/v20180801/DescribeCasterDisplayInfo.md @@ -6,7 +6,7 @@ Input: ``` tccli live DescribeCasterDisplayInfo --cli-unfold-argument \ - --CasterId 130 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/DescribeCasterInputInfos.md b/tccli/examples/live/v20180801/DescribeCasterInputInfos.md index c226c78378..fb87defe50 100644 --- a/tccli/examples/live/v20180801/DescribeCasterInputInfos.md +++ b/tccli/examples/live/v20180801/DescribeCasterInputInfos.md @@ -6,7 +6,7 @@ Input: ``` tccli live DescribeCasterInputInfos --cli-unfold-argument \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/DescribeCasterLayoutInfos.md b/tccli/examples/live/v20180801/DescribeCasterLayoutInfos.md index 8595130ea7..784852bd0e 100644 --- a/tccli/examples/live/v20180801/DescribeCasterLayoutInfos.md +++ b/tccli/examples/live/v20180801/DescribeCasterLayoutInfos.md @@ -6,7 +6,7 @@ Input: ``` tccli live DescribeCasterLayoutInfos --cli-unfold-argument \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/DescribeCasterList.md b/tccli/examples/live/v20180801/DescribeCasterList.md index 3cef43c210..d7f8939d07 100644 --- a/tccli/examples/live/v20180801/DescribeCasterList.md +++ b/tccli/examples/live/v20180801/DescribeCasterList.md @@ -14,7 +14,7 @@ Output: "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03", "CasterList": [ { - "CasterId": 10, + "CasterId": 63501, "CasterName": "example", "StartBillingTime": 0, "StopBillingTime": 1731964027, diff --git a/tccli/examples/live/v20180801/DescribeCasterMarkPicInfos.md b/tccli/examples/live/v20180801/DescribeCasterMarkPicInfos.md index da429a39c4..0885d05821 100644 --- a/tccli/examples/live/v20180801/DescribeCasterMarkPicInfos.md +++ b/tccli/examples/live/v20180801/DescribeCasterMarkPicInfos.md @@ -6,7 +6,7 @@ Input: ``` tccli live DescribeCasterMarkPicInfos --cli-unfold-argument \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/DescribeCasterMarkWordInfos.md b/tccli/examples/live/v20180801/DescribeCasterMarkWordInfos.md index 1efa53a8cc..058a3fc18f 100644 --- a/tccli/examples/live/v20180801/DescribeCasterMarkWordInfos.md +++ b/tccli/examples/live/v20180801/DescribeCasterMarkWordInfos.md @@ -6,7 +6,7 @@ Input: ``` tccli live DescribeCasterMarkWordInfos --cli-unfold-argument \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/DescribeCasterOutputInfos.md b/tccli/examples/live/v20180801/DescribeCasterOutputInfos.md index a727e11242..7e31ec513e 100644 --- a/tccli/examples/live/v20180801/DescribeCasterOutputInfos.md +++ b/tccli/examples/live/v20180801/DescribeCasterOutputInfos.md @@ -6,7 +6,7 @@ Input: ``` tccli live DescribeCasterOutputInfos --cli-unfold-argument \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/DescribeCasterPlayUrl.md b/tccli/examples/live/v20180801/DescribeCasterPlayUrl.md index 9c02f96c45..fb2fc2b78d 100644 --- a/tccli/examples/live/v20180801/DescribeCasterPlayUrl.md +++ b/tccli/examples/live/v20180801/DescribeCasterPlayUrl.md @@ -7,7 +7,7 @@ Input: ``` tccli live DescribeCasterPlayUrl --cli-unfold-argument \ --PlayUrlType 1 \ - --CasterId 10 \ + --CasterId 63501 \ --PlayUrlIndex 1 ``` diff --git a/tccli/examples/live/v20180801/DescribeCasterTransitionTypes.md b/tccli/examples/live/v20180801/DescribeCasterTransitionTypes.md index 6e33348135..d2e1f30989 100644 --- a/tccli/examples/live/v20180801/DescribeCasterTransitionTypes.md +++ b/tccli/examples/live/v20180801/DescribeCasterTransitionTypes.md @@ -6,7 +6,7 @@ Input: ``` tccli live DescribeCasterTransitionTypes --cli-unfold-argument \ - --CasterId 10 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/DescribeDeliverLogDownList.md b/tccli/examples/live/v20180801/DescribeDeliverLogDownList.md index b618066d66..40c0971573 100644 --- a/tccli/examples/live/v20180801/DescribeDeliverLogDownList.md +++ b/tccli/examples/live/v20180801/DescribeDeliverLogDownList.md @@ -13,14 +13,14 @@ Output: "Response": { "LogInfoList": [ { - "LogName": "abc", - "LogUrl": "abc", - "LogTime": "abc", + "LogName": "mylog", + "LogUrl": "https://livelog-down.cdn.qcloud.com/20220804/11/202208041125-pul", + "LogTime": "2022-02-09T12:36:42Z", "FileSize": 0 } ], "TotalNum": 1, - "RequestId": "abc" + "RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e" } } ``` diff --git a/tccli/examples/live/v20180801/DescribeLiveCallbackTemplate.md b/tccli/examples/live/v20180801/DescribeLiveCallbackTemplate.md index 6f09ba9264..8cc2a39acb 100644 --- a/tccli/examples/live/v20180801/DescribeLiveCallbackTemplate.md +++ b/tccli/examples/live/v20180801/DescribeLiveCallbackTemplate.md @@ -16,12 +16,14 @@ Output: "Template": { "TemplateId": 1000, "TemplateName": "testName", - "Description": "test", + "Description": "回调模板", "StreamBeginNotifyUrl": "http://www.qq.com/api/notify?action=streamBegin", "StreamEndNotifyUrl": "http://www.qq.com/api/notify?action=streamEnd", "StreamMixNotifyUrl": "", "RecordNotifyUrl": "http://www.qq.com/api/notify?action=record", "SnapshotNotifyUrl": "http://www.qq.com/api/notify?action=record", + "AudioAuditNotifyUrl": "http://www.qq.com/api/notify?action=record", + "PushExceptionNotifyUrl": "http://www.qq.com/api/notify?action=record", "PornCensorshipNotifyUrl": "http://www.qq.com/api/notify?action=porn", "CallbackKey": "adasdasda1312312" }, diff --git a/tccli/examples/live/v20180801/DescribeLiveCallbackTemplates.md b/tccli/examples/live/v20180801/DescribeLiveCallbackTemplates.md index 12ceb957ac..e9aa1f14f7 100644 --- a/tccli/examples/live/v20180801/DescribeLiveCallbackTemplates.md +++ b/tccli/examples/live/v20180801/DescribeLiveCallbackTemplates.md @@ -15,12 +15,14 @@ Output: { "TemplateId": 1000, "TemplateName": "testName", - "Description": "test", + "Description": "回调模版", "StreamBeginNotifyUrl": "http://www.qq.com/api/notify?action=streamBegin", "StreamEndNotifyUrl": "http://www.qq.com/api/notify?action=streamEnd", "StreamMixNotifyUrl": "", "RecordNotifyUrl": "http://www.qq.com/api/notify?action=record", "SnapshotNotifyUrl": "http://www.qq.com/api/notify?action=record", + "AudioAuditNotifyUrl": "http://www.qq.com/api/notify?action=record", + "PushExceptionNotifyUrl": "http://www.qq.com/api/notify?action=record", "PornCensorshipNotifyUrl": "http://www.qq.com/api/notify?action=porn", "CallbackKey": "adafas1412423432" } diff --git a/tccli/examples/live/v20180801/DescribeLiveCert.md b/tccli/examples/live/v20180801/DescribeLiveCert.md index 81ec5f5e0c..9a47965eba 100644 --- a/tccli/examples/live/v20180801/DescribeLiveCert.md +++ b/tccli/examples/live/v20180801/DescribeLiveCert.md @@ -18,7 +18,7 @@ Output: "CertName": "testName", "Description": "testDesc", "CreateTime": "2018-11-30T15:50:12Z", - "HttpsCrt": "xxx", + "HttpsCrt": "gfdsfsdfdsfdsfdsfsdfsd", "CertType": 0, "CertExpireTime": "2018-12-30T15:50:12Z", "DomainList": [ diff --git a/tccli/examples/live/v20180801/DescribeLiveCerts.md b/tccli/examples/live/v20180801/DescribeLiveCerts.md index 878369ee89..e2035934c5 100644 --- a/tccli/examples/live/v20180801/DescribeLiveCerts.md +++ b/tccli/examples/live/v20180801/DescribeLiveCerts.md @@ -17,7 +17,7 @@ Output: "CertName": "testName", "Description": "testDesc", "CreateTime": "2018-11-30T15:50:12Z", - "HttpsCrt": "xxx", + "HttpsCrt": "dfdsfdsfdsfsdfsd", "CertType": 0, "CertExpireTime": "2018-12-30T15:50:12Z", "DomainList": [ diff --git a/tccli/examples/live/v20180801/DescribeLiveDomain.md b/tccli/examples/live/v20180801/DescribeLiveDomain.md index 5012faaa71..4a0608c91f 100644 --- a/tccli/examples/live/v20180801/DescribeLiveDomain.md +++ b/tccli/examples/live/v20180801/DescribeLiveDomain.md @@ -13,18 +13,20 @@ Output: ``` { "Response": { - "RequestId": "eac6b301-a322-493a-8e36-83b295459397", + "RequestId": "6dad49b1-6a37-4288-9068-0be2ab6ce19b", "DomainInfo": { - "Name": "abc.com", - "Type": 1, + "Name": "push.livhub.net", + "Type": 0, "Status": 1, - "CreateTime": "2018-08-29 10:00:00", - "BCName": 1, - "TargetDomain": "yourdomain.test2.com", - "CurrentCName": "yourdomain.test.com", + "PlayType": 1, "IsDelayLive": 0, + "IsMiniProgramLive": 0, + "CreateTime": "2023-10-30 14:01:48", + "BCName": 1, + "CurrentCName": "push.livhub.net.tlivepush.com.", + "TargetDomain": "push.livhub.net.tlivepush.com", "RentTag": 0, - "RentExpireTime": "0000-00-00 00:00:00" + "RentExpireTime": "78894" } } } diff --git a/tccli/examples/live/v20180801/DescribeLiveDomainCert.md b/tccli/examples/live/v20180801/DescribeLiveDomainCert.md index a736636e77..d59b14752d 100644 --- a/tccli/examples/live/v20180801/DescribeLiveDomainCert.md +++ b/tccli/examples/live/v20180801/DescribeLiveDomainCert.md @@ -6,7 +6,7 @@ Input: ``` tccli live DescribeLiveDomainCert --cli-unfold-argument \ - --DomainName 5000.livepush.myqcloud.com + --DomainName 5000.liveplay.myqcloud.com ``` Output: @@ -18,11 +18,15 @@ Output: "CertName": "testName", "Description": "testDesc", "CreateTime": "2018-11-30T15:50:12Z", - "HttpsCrt": "xxx", + "HttpsCrt": "fsgfdsfsdfdsfd", "CertType": 0, "CertExpireTime": "2018-12-30T15:50:12Z", "DomainName": "5000.livepush.play.com", - "Status": 1 + "Status": 1, + "CertDomains": [ + "*.play.com" + ], + "CloudCertId": "sfrsfvdf" }, "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03" } diff --git a/tccli/examples/live/v20180801/DescribeLivePackageInfo.md b/tccli/examples/live/v20180801/DescribeLivePackageInfo.md index 1f259b06d9..289b752fa8 100644 --- a/tccli/examples/live/v20180801/DescribeLivePackageInfo.md +++ b/tccli/examples/live/v20180801/DescribeLivePackageInfo.md @@ -13,27 +13,123 @@ Output: ``` { "Response": { + "RequestId": "53fc3618-4152-4e12-a1e6-3805e647a602", "LivePackageInfoList": [ { - "Id": "abc", - "Total": 0, - "Used": 0, + "Id": "281975", + "Type": 0, + "Status": 1, + "Total": 500000000000, + "Used": 2365271265, + "Left": 497634728735, + "BuyTime": "2024-07-16 18:46:08", + "ExpireTime": "2025-07-16 18:46:08", + "WillRenew": 0, + "RenewalResult": 0 + }, + { + "Id": "272177", + "Type": 0, + "Status": 4, + "Total": 500000000000, + "Used": 500000000000, + "Left": 0, + "BuyTime": "2023-12-05 10:17:04", + "ExpireTime": "2024-12-05 10:17:04", + "WillRenew": 0, + "RenewalResult": 0 + }, + { + "Id": "265480", + "Type": 0, + "Status": 4, + "Total": 100000000000, + "Used": 100000000000, "Left": 0, - "BuyTime": "abc", - "ExpireTime": "abc", + "BuyTime": "2023-07-14 14:14:30", + "ExpireTime": "2024-07-14 14:14:30", + "WillRenew": 0, + "RenewalResult": 0 + }, + { + "Id": "242917", + "Type": 0, + "Status": 4, + "Total": 1000000000000, + "Used": 1000000000000, + "Left": 0, + "BuyTime": "2022-09-30 10:01:19", + "ExpireTime": "2023-09-30 10:01:19", + "WillRenew": 0, + "RenewalResult": 0 + }, + { + "Id": "224805", "Type": 0, - "Status": 0, + "Status": 4, + "Total": 100000000000, + "Used": 100000000000, + "Left": 0, + "BuyTime": "2022-04-01 10:13:27", + "ExpireTime": "2023-04-01 10:13:27", + "WillRenew": 0, + "RenewalResult": 0 + }, + { + "Id": "224804", + "Type": 0, + "Status": 4, + "Total": 100000000000, + "Used": 100000000000, + "Left": 0, + "BuyTime": "2022-04-01 10:13:27", + "ExpireTime": "2023-04-01 10:13:27", + "WillRenew": 0, + "RenewalResult": 0 + }, + { + "Id": "210034", + "Type": 0, + "Status": 4, + "Total": 100000000000, + "Used": 100000000000, + "Left": 0, + "BuyTime": "2021-11-16 16:48:39", + "ExpireTime": "2022-11-16 16:48:39", + "WillRenew": 0, + "RenewalResult": 0 + }, + { + "Id": "174007", + "Type": 0, + "Status": 4, + "Total": 100000000000, + "Used": 100000000000, + "Left": 0, + "BuyTime": "2021-03-19 16:21:52", + "ExpireTime": "2022-03-19 16:21:52", + "WillRenew": 0, + "RenewalResult": 0 + }, + { + "Id": "138556", + "Type": 0, + "Status": 4, + "Total": 20000000000, + "Used": 20000000000, + "Left": 0, + "BuyTime": "2020-09-09 12:45:48", + "ExpireTime": "2021-09-09 12:45:48", "WillRenew": 0, "RenewalResult": 0 } ], - "PackageBillMode": 0, - "TotalPage": 0, - "TotalNum": 0, - "PageNum": 0, - "PageSize": 0, - "FluxPackageBillMode": "abc", - "RequestId": "abc" + "PackageBillMode": 204, + "FluxPackageBillMode": "204,204,204,204,-1,-1", + "TotalPage": 1, + "TotalNum": 9, + "PageNum": 1, + "PageSize": 100 } } ``` diff --git a/tccli/examples/live/v20180801/DescribeLivePadRules.md b/tccli/examples/live/v20180801/DescribeLivePadRules.md index 52c77df015..fe0ca15d97 100644 --- a/tccli/examples/live/v20180801/DescribeLivePadRules.md +++ b/tccli/examples/live/v20180801/DescribeLivePadRules.md @@ -11,16 +11,7 @@ Output: ``` { "Response": { - "Rules": [ - { - "UpdateTime": "xx", - "AppName": "xx", - "DomainName": "xx", - "StreamName": "xx", - "TemplateId": 1000, - "CreateTime": "xx" - } - ], + "Rules": [], "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03" } } diff --git a/tccli/examples/live/v20180801/DescribeLivePadTemplate.md b/tccli/examples/live/v20180801/DescribeLivePadTemplate.md index e7ccc67124..b11fc67cae 100644 --- a/tccli/examples/live/v20180801/DescribeLivePadTemplate.md +++ b/tccli/examples/live/v20180801/DescribeLivePadTemplate.md @@ -14,16 +14,17 @@ Output: { "Response": { "Template": { - "UpdateTime": "xx", - "Description": "xx", - "TemplateName": "xx", - "Url": "xx", + "UpdateTime": "2020-01-01 08:00:00", + "Description": "template", + "TemplateName": "mytemplate", + "Url": "https://test.com/a.mp4", "TemplateId": 1, - "CreateTime": "xx", + "CreateTime": "2020-01-01 08:00:00", "WaitDuration": 1, - "MaxDuration": 1 + "MaxDuration": 1, + "Type": 1 }, - "RequestId": "xx" + "RequestId": "3fefec28-3f95-4055-8a22-714cc271251e" } } ``` diff --git a/tccli/examples/live/v20180801/DescribeLivePadTemplates.md b/tccli/examples/live/v20180801/DescribeLivePadTemplates.md index 4540b8e0e9..e27f84d478 100644 --- a/tccli/examples/live/v20180801/DescribeLivePadTemplates.md +++ b/tccli/examples/live/v20180801/DescribeLivePadTemplates.md @@ -13,17 +13,18 @@ Output: "Response": { "Templates": [ { - "UpdateTime": "xx", - "Description": "xx", - "TemplateName": "xx", - "Url": "xx", + "UpdateTime": "2020-01-01 08:00:00", + "Description": "template", + "TemplateName": "mytemplate", + "Url": "https://test.com/a.mp4", "TemplateId": 1, - "CreateTime": "xx", + "CreateTime": "2020-01-01 08:00:00", "WaitDuration": 1, - "MaxDuration": 1 + "MaxDuration": 1, + "Type": 1 } ], - "RequestId": "xx" + "RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e" } } ``` diff --git a/tccli/examples/live/v20180801/DescribeLivePlayAuthKey.md b/tccli/examples/live/v20180801/DescribeLivePlayAuthKey.md index 5ceb5abb71..0b586021ea 100644 --- a/tccli/examples/live/v20180801/DescribeLivePlayAuthKey.md +++ b/tccli/examples/live/v20180801/DescribeLivePlayAuthKey.md @@ -16,9 +16,9 @@ Output: "PlayAuthKeyInfo": { "DomainName": "5000.livepush.myqcloud.com", "Enable": 1, - "AuthKey": "xxxx", + "AuthKey": "AKID0QJ82oYdLJ", "AuthDelta": 300, - "AuthBackKey": "xxx" + "AuthBackKey": "lbPUl5VIKKFB1KazNB" }, "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424" } diff --git a/tccli/examples/live/v20180801/DescribeLivePullStreamTasks.md b/tccli/examples/live/v20180801/DescribeLivePullStreamTasks.md index a54692c11b..56e30c948d 100644 --- a/tccli/examples/live/v20180801/DescribeLivePullStreamTasks.md +++ b/tccli/examples/live/v20180801/DescribeLivePullStreamTasks.md @@ -6,7 +6,7 @@ Input: ``` tccli live DescribeLivePullStreamTasks --cli-unfold-argument \ - --TaskId 123 + --TaskId 9654231 ``` Output: @@ -37,7 +37,7 @@ Output: "StartTime": "2020-04-20T00:30:00Z", "Status": "enable", "StreamName": "teststream", - "Comment": "abc", + "Comment": "重要活动", "TaskId": "10054", "UpdateBy": "", "UpdateTime": "2020-04-23T05:07:43Z", diff --git a/tccli/examples/live/v20180801/DescribeLivePushAuthKey.md b/tccli/examples/live/v20180801/DescribeLivePushAuthKey.md index e99e9f3311..cde7f4fc9a 100644 --- a/tccli/examples/live/v20180801/DescribeLivePushAuthKey.md +++ b/tccli/examples/live/v20180801/DescribeLivePushAuthKey.md @@ -16,8 +16,8 @@ Output: "PushAuthKeyInfo": { "DomainName": "5000.livepush.myqcloud.com", "Enable": 1, - "MasterAuthKey": "xxxx", - "BackupAuthKey": "xxxx", + "MasterAuthKey": "PUl5VIKKFB1KazNB", + "BackupAuthKey": "AKID0QJ82oYdLJIgA", "AuthDelta": 300 }, "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424" diff --git a/tccli/examples/live/v20180801/DescribeLiveRecordTemplate.md b/tccli/examples/live/v20180801/DescribeLiveRecordTemplate.md index 29873487c8..b4e5c31886 100644 --- a/tccli/examples/live/v20180801/DescribeLiveRecordTemplate.md +++ b/tccli/examples/live/v20180801/DescribeLiveRecordTemplate.md @@ -13,56 +13,86 @@ Output: ``` { "Response": { + "RequestId": "3fefec28-3f95-4055-8a22-714cc271251e", "Template": { - "TemplateId": 1000, - "Mp4Param": { - "ClassId": 0, - "StorageMode": "xx", - "StorageTime": 0, - "VodSubAppId": 0, - "VodFileName": "xx", - "Enable": 0, - "RecordInterval": 0, - "Procedure": "xx" - }, "AacParam": { - "ClassId": 0, - "StorageMode": "xx", - "StorageTime": 0, - "VodSubAppId": 0, - "VodFileName": "xx", + "ClassId": null, + "CosBucketName": "", + "CosBucketPath": "", + "CosBucketRegion": "", "Enable": 0, - "RecordInterval": 0, - "Procedure": "xx" - }, - "Mp3Param": { - "ClassId": 0, - "StorageMode": "xx", + "Procedure": "", + "RecordInterval": 1800, + "StorageMode": "normal", "StorageTime": 0, - "VodSubAppId": 0, - "VodFileName": "xx", - "Enable": 0, - "RecordInterval": 0, - "Procedure": "xx" + "VodFileName": "", + "VodSubAppId": 251006352 }, - "TemplateName": "testName", - "Description": "test", + "CosStore": 0, + "Description": "", "FlvParam": { + "ClassId": null, + "CosBucketName": "", + "CosBucketPath": "", + "CosBucketRegion": "", "Enable": 1, + "Procedure": "", "RecordInterval": 1800, - "StorageTime": 600 + "StorageMode": "normal", + "StorageTime": 123, + "VodFileName": "", + "VodSubAppId": 251006352 + }, + "FlvSpecialParam": { + "UploadInRecording": true }, "HlsParam": { + "ClassId": null, + "CosBucketName": "", + "CosBucketPath": "", + "CosBucketRegion": "", "Enable": 0, + "Procedure": "", "RecordInterval": 1800, - "StorageTime": 600 + "StorageMode": "normal", + "StorageTime": 0, + "VodFileName": "", + "VodSubAppId": 251006352 }, - "IsDelayLive": 0, "HlsSpecialParam": { - "FlowContinueDuration": 60 - } - }, - "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03" + "FlowContinueDuration": 0 + }, + "IsDelayLive": 0, + "Mp3Param": { + "ClassId": null, + "CosBucketName": "", + "CosBucketPath": "", + "CosBucketRegion": "", + "Enable": 0, + "Procedure": "", + "RecordInterval": 1800, + "StorageMode": "normal", + "StorageTime": 0, + "VodFileName": "", + "VodSubAppId": 251006352 + }, + "Mp4Param": { + "ClassId": null, + "CosBucketName": "", + "CosBucketPath": "", + "CosBucketRegion": "", + "Enable": 0, + "Procedure": "", + "RecordInterval": 1800, + "StorageMode": "normal", + "StorageTime": 0, + "VodFileName": "", + "VodSubAppId": 251006352 + }, + "RemoveWatermark": true, + "TemplateId": 1370613, + "TemplateName": "victor0001" + } } } ``` diff --git a/tccli/examples/live/v20180801/DescribeLiveRecordTemplates.md b/tccli/examples/live/v20180801/DescribeLiveRecordTemplates.md index 9e0d57bfd2..e11c0a6f8d 100644 --- a/tccli/examples/live/v20180801/DescribeLiveRecordTemplates.md +++ b/tccli/examples/live/v20180801/DescribeLiveRecordTemplates.md @@ -13,60 +13,88 @@ Output: ``` { "Response": { + "RequestId": "bc76b15f-734f-4bb5-9b0d-b3a1ecd5444d", "Templates": [ { - "TemplateId": 1000, - "TemplateName": "testName", - "IsDelayLive": 1, - "Description": "test", - "FlvParam": { + "AacParam": { + "ClassId": 0, + "CosBucketName": "", + "CosBucketPath": "", + "CosBucketRegion": "", "Enable": 0, + "Procedure": "", "RecordInterval": 1800, - "StorageTime": 6000, - "VodSubAppId": 123456 - }, - "Mp4Param": { - "ClassId": 0, - "StorageMode": "xx", + "StorageMode": "normal", "StorageTime": 0, - "VodSubAppId": 0, - "VodFileName": "xx", - "Enable": 0, - "RecordInterval": 0, - "Procedure": "xx" + "VodFileName": "", + "VodSubAppId": 251006352 }, - "AacParam": { + "CosStore": 0, + "Description": "", + "FlvParam": { + "ClassId": null, + "CosBucketName": "", + "CosBucketPath": "", + "CosBucketRegion": "", + "Enable": 1, + "Procedure": "", + "RecordInterval": 1800, + "StorageMode": "normal", + "StorageTime": 4572, + "VodFileName": "", + "VodSubAppId": 251006352 + }, + "FlvSpecialParam": { + "UploadInRecording": true + }, + "HlsParam": { "ClassId": 0, - "StorageMode": "xx", - "StorageTime": 0, - "VodSubAppId": 0, - "VodFileName": "xx", + "CosBucketName": "", + "CosBucketPath": "", + "CosBucketRegion": "", "Enable": 0, - "RecordInterval": 0, - "Procedure": "xx" + "Procedure": "", + "RecordInterval": 1800, + "StorageMode": "normal", + "StorageTime": 0, + "VodFileName": "", + "VodSubAppId": 251006352 + }, + "HlsSpecialParam": { + "FlowContinueDuration": 0 }, + "IsDelayLive": 0, "Mp3Param": { - "ClassId": 0, - "StorageMode": "xx", - "StorageTime": 0, - "VodSubAppId": 0, - "VodFileName": "xx", + "ClassId": null, + "CosBucketName": "", + "CosBucketPath": "", + "CosBucketRegion": "", "Enable": 0, - "RecordInterval": 0, - "Procedure": "xx" + "Procedure": "", + "RecordInterval": 1800, + "StorageMode": "normal", + "StorageTime": 0, + "VodFileName": "", + "VodSubAppId": 251006352 }, - "HlsParam": { - "Enable": 1, + "Mp4Param": { + "ClassId": 0, + "CosBucketName": "", + "CosBucketPath": "", + "CosBucketRegion": "", + "Enable": 0, + "Procedure": "", "RecordInterval": 1800, - "StorageTime": 600, - "VodSubAppId": 123456 + "StorageMode": "normal", + "StorageTime": 0, + "VodFileName": "", + "VodSubAppId": 251006352 }, - "HlsSpecialParam": { - "FlowContinueDuration": 60 - } + "RemoveWatermark": true, + "TemplateId": 1370613, + "TemplateName": "victor0001" } - ], - "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03" + ] } } ``` diff --git a/tccli/examples/live/v20180801/DescribeLiveSnapshotTemplate.md b/tccli/examples/live/v20180801/DescribeLiveSnapshotTemplate.md index 6db1bdda33..957dc1a283 100644 --- a/tccli/examples/live/v20180801/DescribeLiveSnapshotTemplate.md +++ b/tccli/examples/live/v20180801/DescribeLiveSnapshotTemplate.md @@ -16,14 +16,16 @@ Output: "Template": { "TemplateId": 1000, "TemplateName": "testName", - "Description": "test", + "Description": "active_template", "SnapshotInterval": 10, "Width": 250, "Height": 250, "PornFlag": 0, - "CosAppId": 123, + "CosAppId": 934258, "CosBucket": "bucket", - "CosRegion": "beijing" + "CosRegion": "beijing", + "CosPrefix": "live", + "CosFileName": "myfilename" }, "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03" } diff --git a/tccli/examples/live/v20180801/DescribeLiveSnapshotTemplates.md b/tccli/examples/live/v20180801/DescribeLiveSnapshotTemplates.md index 2f786b24de..ace6d0433d 100644 --- a/tccli/examples/live/v20180801/DescribeLiveSnapshotTemplates.md +++ b/tccli/examples/live/v20180801/DescribeLiveSnapshotTemplates.md @@ -15,16 +15,16 @@ Output: { "TemplateId": 1000, "TemplateName": "testName", - "Description": "test", + "Description": "template", "SnapshotInterval": 10, "Width": 250, "Height": 250, "PornFlag": 0, - "CosAppId": 123, + "CosAppId": 85421, "CosBucket": "bucket", "CosRegion": "beijing", - "CosPrefix": "xx", - "CosFileName": "xx" + "CosPrefix": "live", + "CosFileName": "myfilename" } ], "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03" diff --git a/tccli/examples/live/v20180801/DescribeLiveStreamMonitor.md b/tccli/examples/live/v20180801/DescribeLiveStreamMonitor.md index 832f7d3757..a9c5699f2e 100644 --- a/tccli/examples/live/v20180801/DescribeLiveStreamMonitor.md +++ b/tccli/examples/live/v20180801/DescribeLiveStreamMonitor.md @@ -37,7 +37,7 @@ Output: "UpdateTime": 1640591812, "NotifyPolicy": { "NotifyPolicyType": 1, - "CallbackUrl": "xx" + "CallbackUrl": "http://my.callback.com/recv/interface" }, "AudibleInputIndexList": [ 1 @@ -48,7 +48,15 @@ Output: "CheckStreamBroken": 1, "CheckStreamLowFrameRate": 1, "AsrLanguage": 1, - "OcrLanguage": 1 + "OcrLanguage": 1, + "AiFormatDiagnose": 1, + "AiQualityControl": 1, + "AllowMonitorReport": 1, + "AiOcrInputIndexList": [ + 1 + ], + "StartTime": 1735190919, + "StopTime": 1735190919 }, "RequestId": "" } diff --git a/tccli/examples/live/v20180801/DescribeLiveStreamMonitorList.md b/tccli/examples/live/v20180801/DescribeLiveStreamMonitorList.md index 82d4b7b073..b0c5e1d1d0 100644 --- a/tccli/examples/live/v20180801/DescribeLiveStreamMonitorList.md +++ b/tccli/examples/live/v20180801/DescribeLiveStreamMonitorList.md @@ -36,7 +36,29 @@ Output: "InputApp": "", "InputUrl": "" } - ] + ], + "CheckStreamBroken": 1, + "AsrLanguage": 1, + "UpdateTime": 1640694582, + "OcrLanguage": 1, + "NotifyPolicy": { + "CallbackUrl": "www.baidu.com", + "NotifyPolicyType": 0 + }, + "CreateTime": 1640694582, + "AiAsrInputIndexList": [ + 1 + ], + "AiFormatDiagnose": 1, + "AiOcrInputIndexList": [ + 1 + ], + "CheckStreamLowFrameRate": 1, + "AudibleInputIndexList": [ + 1 + ], + "AllowMonitorReport": 1, + "AiQualityControl": 1 } ], "TotalNum": 7, diff --git a/tccli/examples/live/v20180801/DescribeLiveTimeShiftRules.md b/tccli/examples/live/v20180801/DescribeLiveTimeShiftRules.md index 8ff1985c97..019537f898 100644 --- a/tccli/examples/live/v20180801/DescribeLiveTimeShiftRules.md +++ b/tccli/examples/live/v20180801/DescribeLiveTimeShiftRules.md @@ -11,16 +11,7 @@ Output: ``` { "Response": { - "Rules": [ - { - "UpdateTime": "xx", - "AppName": "xx", - "DomainName": "xx", - "StreamName": "xx", - "TemplateId": 1000, - "CreateTime": "xx" - } - ], + "Rules": [], "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03" } } diff --git a/tccli/examples/live/v20180801/DescribeLiveTimeShiftTemplates.md b/tccli/examples/live/v20180801/DescribeLiveTimeShiftTemplates.md index 89b387d23d..5eed36f2f5 100644 --- a/tccli/examples/live/v20180801/DescribeLiveTimeShiftTemplates.md +++ b/tccli/examples/live/v20180801/DescribeLiveTimeShiftTemplates.md @@ -13,19 +13,19 @@ Output: "Response": { "Templates": [ { - "Description": "xx", + "Description": "timeshift", "TranscodeTemplateIds": [ 1 ], "RemoveWatermark": true, - "Area": 1, + "Area": "1", "ItemDuration": 1, "TemplateId": 1, "Duration": 1, - "TemplateName": 1 + "TemplateName": "1" } ], - "RequestId": "xx" + "RequestId": "3fefec28-3f95-4055-8a22-714cc271251e" } } ``` diff --git a/tccli/examples/live/v20180801/DescribeLiveTranscodeTemplate.md b/tccli/examples/live/v20180801/DescribeLiveTranscodeTemplate.md index 0058e533dc..c335a03e3f 100644 --- a/tccli/examples/live/v20180801/DescribeLiveTranscodeTemplate.md +++ b/tccli/examples/live/v20180801/DescribeLiveTranscodeTemplate.md @@ -14,14 +14,14 @@ Output: { "Response": { "Template": { - "Profile": "xx", + "Profile": "baseline", "AudioBitrate": 15, "Rotate": 0, "BitrateToOrig": 0, - "TemplateName": "xx", + "TemplateName": "mytemplate", "VideoBitrate": 30, "ShortEdgeAsHeight": 0, - "Vcodec": "xx", + "Vcodec": "h264", "AdaptBitratePercent": 0.0, "AiTransCode": 0, "Height": 250, @@ -30,11 +30,13 @@ Output: "FpsToOrig": 0, "Fps": 30, "TemplateId": 1000, - "Description": "xx", + "Description": "desc", "HeightToOrig": 0, "NeedVideo": 1, "Gop": 3, - "Acodec": "xx" + "Acodec": "aac", + "DRMTracks": "AUDIO", + "DRMType": "widevine" }, "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03" } diff --git a/tccli/examples/live/v20180801/DescribeLiveWatermarks.md b/tccli/examples/live/v20180801/DescribeLiveWatermarks.md index 071946e566..1a3be09d4b 100644 --- a/tccli/examples/live/v20180801/DescribeLiveWatermarks.md +++ b/tccli/examples/live/v20180801/DescribeLiveWatermarks.md @@ -15,19 +15,19 @@ Output: "WatermarkList": [ { "WatermarkId": 0, - "PictureUrl": "abc", + "PictureUrl": "http://wechatapppro.file.myqcloud.com/app1vg363qr9722/image/2024-12-05/app1vg363qr9722_watermark.png", "XPosition": 0, "YPosition": 0, - "WatermarkName": "abc", + "WatermarkName": "wechatapppro", "Status": 0, - "CreateTime": "abc", + "CreateTime": "2024-12-05", "Width": 0, "Height": 0, "BackgroundWidth": 0, "BackgroundHeight": 0 } ], - "RequestId": "abc" + "RequestId": "98ceb7f4-61bd-473c-9381-59a0ed0c25b7" } } ``` diff --git a/tccli/examples/live/v20180801/DescribeLogDownloadList.md b/tccli/examples/live/v20180801/DescribeLogDownloadList.md index 8a31ca58cb..84e4bd35c2 100644 --- a/tccli/examples/live/v20180801/DescribeLogDownloadList.md +++ b/tccli/examples/live/v20180801/DescribeLogDownloadList.md @@ -17,7 +17,7 @@ Output: "Response": { "LogInfoList": [ { - "LogName": "test", + "LogName": "mylivelog", "LogUrl": "http://test.log.com", "LogTime": "2019-03-13 00:00:00", "FileSize": 1000 diff --git a/tccli/examples/live/v20180801/DescribeMonitorReport.md b/tccli/examples/live/v20180801/DescribeMonitorReport.md index 4106a55d79..f489f2a932 100644 --- a/tccli/examples/live/v20180801/DescribeMonitorReport.md +++ b/tccli/examples/live/v20180801/DescribeMonitorReport.md @@ -16,10 +16,13 @@ Output: "RequestId": "", "MPSResult": { "AiAsrResults": [], - "AiOcrResults": [] + "AiOcrResults": [], + "StreamQuaCtrlResults": [] }, "DiagnoseResult": { - "StreamBrokenResults": [] + "StreamBrokenResults": [], + "StreamFormatResults": [], + "LowFrameRateResults": [] } } } diff --git a/tccli/examples/live/v20180801/DescribeTimeShiftRecordDetail.md b/tccli/examples/live/v20180801/DescribeTimeShiftRecordDetail.md index 3ff85318f7..5a8fc07755 100644 --- a/tccli/examples/live/v20180801/DescribeTimeShiftRecordDetail.md +++ b/tccli/examples/live/v20180801/DescribeTimeShiftRecordDetail.md @@ -19,10 +19,10 @@ Output: ``` { "Response": { - "RequestId": "xxx", + "RequestId": "27b51725-321e-4347-8906-4e1d94b5a373", "RecordList": [ { - "Sid": "xxx", + "Sid": "2980018187870252785", "StartTime": 1668064484, "EndTime": 1668064584 } diff --git a/tccli/examples/live/v20180801/DescribeTimeShiftStreamList.md b/tccli/examples/live/v20180801/DescribeTimeShiftStreamList.md index 899e22745a..103b623135 100644 --- a/tccli/examples/live/v20180801/DescribeTimeShiftStreamList.md +++ b/tccli/examples/live/v20180801/DescribeTimeShiftStreamList.md @@ -14,7 +14,7 @@ Output: ``` { "Response": { - "RequestId": "xxx", + "RequestId": "27b51725-321e-4347-8906-4e1d94b5a373", "TotalSize": 100, "StreamList": [ { diff --git a/tccli/examples/live/v20180801/ModifyCaster.md b/tccli/examples/live/v20180801/ModifyCaster.md index 6dda4b94c2..b3fa4c93d7 100644 --- a/tccli/examples/live/v20180801/ModifyCaster.md +++ b/tccli/examples/live/v20180801/ModifyCaster.md @@ -8,7 +8,7 @@ Input: tccli live ModifyCaster --cli-unfold-argument \ --RecordStatus 1 \ --RecordTemplateId 1 \ - --CasterId 10 \ + --CasterId 63501 \ --CasterName Modify Caster ``` diff --git a/tccli/examples/live/v20180801/ModifyCasterInputInfo.md b/tccli/examples/live/v20180801/ModifyCasterInputInfo.md index 5d2a0f210b..6ba3a25bbb 100644 --- a/tccli/examples/live/v20180801/ModifyCasterInputInfo.md +++ b/tccli/examples/live/v20180801/ModifyCasterInputInfo.md @@ -10,7 +10,7 @@ tccli live ModifyCasterInputInfo --cli-unfold-argument \ --InputInfo.InputIndex 1 \ --InputInfo.InputType 0 \ --InputInfo.InputUrl rtmp://caster.push.example.com/live/example \ - --CasterId 10 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/ModifyCasterLayoutInfo.md b/tccli/examples/live/v20180801/ModifyCasterLayoutInfo.md index 4de0e078f4..9d492c58f9 100644 --- a/tccli/examples/live/v20180801/ModifyCasterLayoutInfo.md +++ b/tccli/examples/live/v20180801/ModifyCasterLayoutInfo.md @@ -9,7 +9,7 @@ tccli live ModifyCasterLayoutInfo --cli-unfold-argument \ --LayoutInfo.LayoutIndex 1 \ --LayoutInfo.InputIndexList 2|3 \ --LayoutInfo.LayoutTemplateId 20 \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/ModifyCasterMarkPicInfo.md b/tccli/examples/live/v20180801/ModifyCasterMarkPicInfo.md index 55ec452124..67fb65ab4c 100644 --- a/tccli/examples/live/v20180801/ModifyCasterMarkPicInfo.md +++ b/tccli/examples/live/v20180801/ModifyCasterMarkPicInfo.md @@ -12,7 +12,7 @@ tccli live ModifyCasterMarkPicInfo --cli-unfold-argument \ --MarkPicInfo.MarkPicLocationX 0.2 \ --MarkPicInfo.MarkPicLocationY 0.2 \ --MarkPicInfo.MarkPicWidth 0.3 \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/ModifyCasterMarkWordInfo.md b/tccli/examples/live/v20180801/ModifyCasterMarkWordInfo.md index ffe4c2a19d..55bcccc75c 100644 --- a/tccli/examples/live/v20180801/ModifyCasterMarkWordInfo.md +++ b/tccli/examples/live/v20180801/ModifyCasterMarkWordInfo.md @@ -6,7 +6,7 @@ Input: ``` tccli live ModifyCasterMarkWordInfo --cli-unfold-argument \ - --CasterId 1234 \ + --CasterId 63501 \ --MarkWordInfo.MarkWordIndex 1 \ --MarkWordInfo.MarkWordFontSize 18 \ --MarkWordInfo.MarkWordText Modify example \ diff --git a/tccli/examples/live/v20180801/ModifyCasterOutputInfo.md b/tccli/examples/live/v20180801/ModifyCasterOutputInfo.md index d69addf658..491cefc4a1 100644 --- a/tccli/examples/live/v20180801/ModifyCasterOutputInfo.md +++ b/tccli/examples/live/v20180801/ModifyCasterOutputInfo.md @@ -6,7 +6,7 @@ Input: ``` tccli live ModifyCasterOutputInfo --cli-unfold-argument \ - --CasterId 1234 \ + --CasterId 63501 \ --OutputInfo.OutputIndex 1 \ --OutputInfo.OutputUrl rtmp://another.third.push.domain/live/another_stream_id ``` diff --git a/tccli/examples/live/v20180801/ModifyLiveCallbackTemplate.md b/tccli/examples/live/v20180801/ModifyLiveCallbackTemplate.md index be3c21fba7..0c3a4be682 100644 --- a/tccli/examples/live/v20180801/ModifyLiveCallbackTemplate.md +++ b/tccli/examples/live/v20180801/ModifyLiveCallbackTemplate.md @@ -14,7 +14,7 @@ tccli live ModifyLiveCallbackTemplate --cli-unfold-argument \ --TemplateId 1000 \ --PornCensorshipNotifyUrl http://www.yourdomain.com/api/notify?action=porn \ --CallbackKey adasdas23432423 \ - --Description test + --Description 回调模板 ``` Output: diff --git a/tccli/examples/live/v20180801/ModifyLivePadTemplate.md b/tccli/examples/live/v20180801/ModifyLivePadTemplate.md index 5571a836ea..488d5033cb 100644 --- a/tccli/examples/live/v20180801/ModifyLivePadTemplate.md +++ b/tccli/examples/live/v20180801/ModifyLivePadTemplate.md @@ -6,9 +6,9 @@ Input: ``` tccli live ModifyLivePadTemplate --cli-unfold-argument \ - --Description xx \ - --TemplateName xx \ - --Url xx \ + --Description padtemplate \ + --TemplateName mytemplate \ + --Url http://mypad.file.com/pad/file.mp4 \ --WaitDuration 1 \ --TemplateId 1 \ --MaxDuration 1 diff --git a/tccli/examples/live/v20180801/ModifyLivePlayAuthKey.md b/tccli/examples/live/v20180801/ModifyLivePlayAuthKey.md index 457f23476f..cd66efa734 100644 --- a/tccli/examples/live/v20180801/ModifyLivePlayAuthKey.md +++ b/tccli/examples/live/v20180801/ModifyLivePlayAuthKey.md @@ -8,9 +8,9 @@ Input: tccli live ModifyLivePlayAuthKey --cli-unfold-argument \ --DomainName 5000.livepush.myqcloud.com \ --Enable 0 \ - --AuthKey xxxx \ + --AuthKey AKID0QJ82oYdLJ \ --AuthDelta 300 \ - --AuthBackKey xxxx + --AuthBackKey IgAQlbPUl5VIKKFB1KazNB ``` Output: diff --git a/tccli/examples/live/v20180801/ModifyLiveRecordTemplate.md b/tccli/examples/live/v20180801/ModifyLiveRecordTemplate.md index c12715372b..5c0ea9494e 100644 --- a/tccli/examples/live/v20180801/ModifyLiveRecordTemplate.md +++ b/tccli/examples/live/v20180801/ModifyLiveRecordTemplate.md @@ -7,7 +7,7 @@ Input: ``` tccli live ModifyLiveRecordTemplate --cli-unfold-argument \ --TemplateName templat \ - --Description test \ + --Description record \ --FlvParam.Enable 1 \ --FlvParam.RecordInterval 1800 \ --FlvParam.StorageTime 700 \ diff --git a/tccli/examples/live/v20180801/ModifyLiveSnapshotTemplate.md b/tccli/examples/live/v20180801/ModifyLiveSnapshotTemplate.md index 0fe25863df..d706065da5 100644 --- a/tccli/examples/live/v20180801/ModifyLiveSnapshotTemplate.md +++ b/tccli/examples/live/v20180801/ModifyLiveSnapshotTemplate.md @@ -5,13 +5,26 @@ Input: ``` -tccli live ModifyLiveSnapshotTemplate --cli-unfold-argument ``` +tccli live ModifyLiveSnapshotTemplate --cli-unfold-argument \ + --TemplateId 0 \ + --TemplateName mytemplate \ + --Description 模板 \ + --SnapshotInterval 0 \ + --Width 0 \ + --Height 0 \ + --PornFlag 0 \ + --CosAppId 0 \ + --CosBucket sfjjsidexample \ + --CosRegion ap-beijing \ + --CosPrefix live \ + --CosFileName myfilename +``` Output: ``` { "Response": { - "RequestId": "xx" + "RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e" } } ``` diff --git a/tccli/examples/live/v20180801/ModifyLiveStreamMonitor.md b/tccli/examples/live/v20180801/ModifyLiveStreamMonitor.md index 3aeb2851c0..2972167271 100644 --- a/tccli/examples/live/v20180801/ModifyLiveStreamMonitor.md +++ b/tccli/examples/live/v20180801/ModifyLiveStreamMonitor.md @@ -6,20 +6,20 @@ Input: ``` tccli live ModifyLiveStreamMonitor --cli-unfold-argument \ - --MonitorId abc \ - --MonitorName abc \ - --OutputInfo.OutputStreamName abc \ + --MonitorId caster-124 \ + --MonitorName caster-124 \ + --OutputInfo.OutputStreamName stream1 \ --OutputInfo.OutputStreamWidth 1 \ --OutputInfo.OutputStreamHeight 1 \ - --OutputInfo.OutputDomain abc \ - --OutputInfo.OutputApp abc \ - --InputList.0.InputStreamName abc \ - --InputList.0.InputDomain abc \ - --InputList.0.InputApp abc \ - --InputList.0.InputUrl abc \ - --InputList.0.Description abc \ + --OutputInfo.OutputDomain \ + --OutputInfo.OutputApp live \ + --InputList.0.InputStreamName stream2 \ + --InputList.0.InputDomain live.monitor.push.com \ + --InputList.0.InputApp live \ + --InputList.0.InputUrl rtmp://live.monitor.push.com/live/stream1 \ + --InputList.0.Description stream 1 \ --NotifyPolicy.NotifyPolicyType 1 \ - --NotifyPolicy.CallbackUrl abc \ + --NotifyPolicy.CallbackUrl www.baidu.com \ --AsrLanguage 1 \ --OcrLanguage 1 \ --AiAsrInputIndexList 1 \ diff --git a/tccli/examples/live/v20180801/ModifyLiveTimeShiftTemplate.md b/tccli/examples/live/v20180801/ModifyLiveTimeShiftTemplate.md index bacc76ca62..38d4a32091 100644 --- a/tccli/examples/live/v20180801/ModifyLiveTimeShiftTemplate.md +++ b/tccli/examples/live/v20180801/ModifyLiveTimeShiftTemplate.md @@ -6,14 +6,14 @@ Input: ``` tccli live ModifyLiveTimeShiftTemplate --cli-unfold-argument \ - --Description xx \ - --TranscodeTemplateIds 0 \ - --RemoveWatermark True \ - --TemplateName xx \ - --ItemDuration 1 \ --TemplateId 1 \ + --TemplateName timeshift \ + --Description timeshift \ --Duration 1 \ - --Area xx + --ItemDuration 1 \ + --RemoveWatermark True \ + --TranscodeTemplateIds 0 \ + --Area 0 ``` Output: diff --git a/tccli/examples/live/v20180801/ModifyLiveTranscodeTemplate.md b/tccli/examples/live/v20180801/ModifyLiveTranscodeTemplate.md index 074de921ca..7d3e0841c0 100644 --- a/tccli/examples/live/v20180801/ModifyLiveTranscodeTemplate.md +++ b/tccli/examples/live/v20180801/ModifyLiveTranscodeTemplate.md @@ -9,7 +9,7 @@ tccli live ModifyLiveTranscodeTemplate --cli-unfold-argument \ --Profile main \ --AudioBitrate 600 \ --Rotate 0 \ - --Description test \ + --Description transcode \ --VideoBitrate 1500 \ --Vcodec h265 \ --Height 240 \ diff --git a/tccli/examples/live/v20180801/ReleaseCaster.md b/tccli/examples/live/v20180801/ReleaseCaster.md index a23e0e1f11..1f6c01651b 100644 --- a/tccli/examples/live/v20180801/ReleaseCaster.md +++ b/tccli/examples/live/v20180801/ReleaseCaster.md @@ -6,7 +6,7 @@ Input: ``` tccli live ReleaseCaster --cli-unfold-argument \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/StopCasterPgm.md b/tccli/examples/live/v20180801/StopCasterPgm.md index 1d0c5696d7..a3170be5a5 100644 --- a/tccli/examples/live/v20180801/StopCasterPgm.md +++ b/tccli/examples/live/v20180801/StopCasterPgm.md @@ -6,7 +6,7 @@ Input: ``` tccli live StopCasterPgm --cli-unfold-argument \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/StopCasterPvw.md b/tccli/examples/live/v20180801/StopCasterPvw.md index 2e2d9dd2f3..b806d43ca8 100644 --- a/tccli/examples/live/v20180801/StopCasterPvw.md +++ b/tccli/examples/live/v20180801/StopCasterPvw.md @@ -6,7 +6,7 @@ Input: ``` tccli live StopCasterPvw --cli-unfold-argument \ - --CasterId 1234 + --CasterId 63501 ``` Output: diff --git a/tccli/examples/live/v20180801/UpdateLiveWatermark.md b/tccli/examples/live/v20180801/UpdateLiveWatermark.md index 3b88f0d796..16de5b513e 100644 --- a/tccli/examples/live/v20180801/UpdateLiveWatermark.md +++ b/tccli/examples/live/v20180801/UpdateLiveWatermark.md @@ -6,7 +6,7 @@ Input: ``` tccli live UpdateLiveWatermark --cli-unfold-argument \ - --WatermarkId 123 \ + --WatermarkId 452356 \ --PictureUrl http://watermark-10005041.cos.myqcloud.com/1251830167/watermark_img_Alogo.png \ --XPosition 80 \ --YPosition 10 \ diff --git a/tccli/examples/oceanus/v20190422/DeleteWorkSpace.md b/tccli/examples/oceanus/v20190422/DeleteWorkSpace.md index 5d5f951a03..1c28b035b6 100644 --- a/tccli/examples/oceanus/v20190422/DeleteWorkSpace.md +++ b/tccli/examples/oceanus/v20190422/DeleteWorkSpace.md @@ -14,7 +14,7 @@ Output: { "Response": { "Delete": true, - "RequestId": "xx" + "RequestId": "a123" } } ``` diff --git a/tccli/examples/sqlserver/v20180328/DescribeProductSpec.md b/tccli/examples/sqlserver/v20180328/DescribeProductSpec.md index fab609890d..2f2f3a9176 100644 --- a/tccli/examples/sqlserver/v20180328/DescribeProductSpec.md +++ b/tccli/examples/sqlserver/v20180328/DescribeProductSpec.md @@ -31,7 +31,9 @@ Output: "SpecId": 15, "SuitInfo": "独立用户数上百人的小型应用", "Version": "2008R2", - "VersionName": "SQL Server 2008 Enterprise" + "VersionName": "SQL Server 2008 Enterprise", + "InstanceType": "HA", + "MultiZonesStatus": "ALL" }, { "CPU": 1, @@ -49,7 +51,9 @@ Output: "SpecId": 15, "SuitInfo": "独立用户数上百人的小型应用", "Version": "2012SP3", - "VersionName": "SQL Server 2012 Enterprise" + "VersionName": "SQL Server 2012 Enterprise", + "InstanceType": "HA", + "MultiZonesStatus": "ALL" }, { "CPU": 1, @@ -67,7 +71,9 @@ Output: "SpecId": 15, "SuitInfo": "独立用户数上百人的小型应用", "Version": "2016SP1", - "VersionName": "SQL Server 2016 Enterprise" + "VersionName": "SQL Server 2016 Enterprise", + "InstanceType": "HA", + "MultiZonesStatus": "ALL" } ], "RegionId": 1, diff --git a/tccli/examples/sqlserver/v20180328/ModifyAccountRemark.md b/tccli/examples/sqlserver/v20180328/ModifyAccountRemark.md index a8c97122fa..fe8983bccf 100644 --- a/tccli/examples/sqlserver/v20180328/ModifyAccountRemark.md +++ b/tccli/examples/sqlserver/v20180328/ModifyAccountRemark.md @@ -7,8 +7,8 @@ Input: ``` tccli sqlserver ModifyAccountRemark --cli-unfold-argument \ --InstanceId mssql-j8kv137v \ - --Accounts.0.UserName test \ - --Accounts.0.Remark testRemark + --Accounts.0.UserName usetName \ + --Accounts.0.Remark userRemark ``` Output: diff --git a/tccli/examples/ssl/v20191205/DescribeCertificateBindResourceTaskDetail.md b/tccli/examples/ssl/v20191205/DescribeCertificateBindResourceTaskDetail.md index 5330934c79..10d6dfe0f9 100644 --- a/tccli/examples/ssl/v20191205/DescribeCertificateBindResourceTaskDetail.md +++ b/tccli/examples/ssl/v20191205/DescribeCertificateBindResourceTaskDetail.md @@ -6,9 +6,9 @@ Input: ``` tccli ssl DescribeCertificateBindResourceTaskDetail --cli-unfold-argument \ - --TaskId abc \ - --Limit abc \ - --Offset abc + --TaskId 758439 \ + --Limit 0 \ + --Offset 10 ``` Output: @@ -17,45 +17,45 @@ Output: "Response": { "CLB": [ { - "Region": "abc", + "Region": "ap-guangzhou", "InstanceList": [ { - "LoadBalancerId": "abc", - "LoadBalancerName": "abc", + "LoadBalancerId": "lb-*****", + "LoadBalancerName": "test", "Listeners": [ { - "ListenerId": "abc", - "ListenerName": "abc", + "ListenerId": "lbl-*****", + "ListenerName": "test", "SniSwitch": 1, - "Protocol": "abc", + "Protocol": "https", "Certificate": { - "CertId": "abc", + "CertId": "T***jdj", "DnsNames": [ - "abc" + "www.test.com" ], - "CertCaId": "abc", - "SSLMode": "abc" + "CertCaId": "T***jdj", + "SSLMode": "mutual" }, "Rules": [ { - "LocationId": "abc", - "Domain": "abc", + "LocationId": "/test", + "Domain": "www.test.com", "IsMatch": true, "Certificate": { - "CertId": "abc", + "CertId": "hr***jdj", "DnsNames": [ - "abc" + "www.test.com" ], - "CertCaId": "abc", - "SSLMode": "abc" + "CertCaId": "hr***jdj", + "SSLMode": "mutual" }, "NoMatchDomains": [ - "abc" + "www.test2.com" ] } ], "NoMatchDomains": [ - "abc" + "www.test2.com" ] } ] @@ -70,10 +70,10 @@ Output: "TotalCount": 1, "InstanceList": [ { - "Domain": "abc", - "CertId": "abc", - "Status": "abc", - "HttpsBillingSwitch": "abc" + "Domain": "www.test.com", + "CertId": "T***jdj", + "Status": "online", + "HttpsBillingSwitch": "on" } ], "Error": "" @@ -81,11 +81,11 @@ Output: ], "WAF": [ { - "Region": "abc", + "Region": "ap-guangzhou", "InstanceList": [ { - "Domain": "abc", - "CertId": "abc", + "Domain": "www.test.com", + "CertId": "T***jdj", "Keepalive": 1 } ], @@ -98,11 +98,11 @@ Output: "TotalCount": 1, "InstanceList": [ { - "Domain": "abc", - "InstanceId": "abc", - "Protocol": "abc", - "CertId": "abc", - "VirtualPort": "abc" + "Domain": "www.test.com", + "InstanceId": "ddos-*****", + "Protocol": "https", + "CertId": "T***jdj", + "VirtualPort": "443" } ], "Error": "" @@ -113,8 +113,8 @@ Output: "TotalCount": 1, "InstanceList": [ { - "Domain": "abc", - "CertId": "abc", + "Domain": "www.test.com", + "CertId": "T***jdj", "Status": 0 } ], @@ -125,8 +125,8 @@ Output: { "InstanceList": [ { - "Domain": "abc", - "CertId": "abc" + "Domain": "www.test.com", + "CertId": "T***jdj" } ], "TotalCount": 1, @@ -135,38 +135,38 @@ Output: ], "TKE": [ { - "Region": "abc", + "Region": "ap-guangzhou", "InstanceList": [ { - "ClusterId": "abc", - "ClusterName": "abc", + "ClusterId": "test", + "ClusterName": "test", "NamespaceList": [ { - "Name": "abc", + "Name": "test", "SecretList": [ { - "Name": "abc", - "CertId": "abc", + "Name": "test", + "CertId": "T***jdj", "IngressList": [ { - "IngressName": "abc", + "IngressName": "test", "TlsDomains": [ - "abc" + "www.test.com" ], "Domains": [ - "abc" + "www.test.com" ] } ], "NoMatchDomains": [ - "abc" + "www.test2.com" ] } ] } ], - "ClusterType": "abc", - "ClusterVersion": "abc" + "ClusterType": "tke", + "ClusterVersion": "1.16" } ], "TotalCount": 1, @@ -175,14 +175,14 @@ Output: ], "APIGATEWAY": [ { - "Region": "abc", + "Region": "ap-guangzhou", "InstanceList": [ { - "ServiceId": "abc", - "ServiceName": "abc", - "Domain": "abc", - "CertId": "abc", - "Protocol": "abc" + "ServiceId": "service-*****", + "ServiceName": "test", + "Domain": "www.test.com", + "CertId": "T***jdj", + "Protocol": "https" } ], "TotalCount": 1, @@ -191,25 +191,25 @@ Output: ], "TCB": [ { - "Region": "abc", + "Region": "ap-guangzhou", "Error": "", "Environments": [ { "Environment": { - "ID": "abc", - "Source": "abc", - "Name": "abc", - "Status": "abc" + "ID": "TCB-*****", + "Source": "cdn", + "Name": "test-*****", + "Status": "online" }, "AccessService": { "InstanceList": [ { - "Domain": "abc", + "Domain": "www.test.com", "Status": 0, "UnionStatus": 0, "IsPreempted": true, "ICPStatus": 0, - "OldCertificateId": "abc" + "OldCertificateId": "jd***jdj" } ], "TotalCount": 0 @@ -217,10 +217,10 @@ Output: "HostService": { "InstanceList": [ { - "Domain": "abc", - "Status": "abc", - "DNSStatus": "abc", - "OldCertificateId": "abc" + "Domain": "www.test.com", + "Status": "online", + "DNSStatus": "online", + "OldCertificateId": "jd***jdj" } ], "TotalCount": 0 @@ -233,10 +233,10 @@ Output: { "InstanceList": [ { - "Host": "abc", - "CertId": "abc", - "ZoneId": "abc", - "Status": "abc" + "Host": "www.test.com", + "CertId": "T***jdj", + "ZoneId": "zone-*****", + "Status": "online" } ], "TotalCount": 1, @@ -244,8 +244,8 @@ Output: } ], "Status": 1, - "CacheTime": "abc", - "RequestId": "abc" + "CacheTime": "2023-10-12 12:00:00", + "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456" } } ``` diff --git a/tccli/examples/ssl/v20191205/DescribeCertificateBindResourceTaskResult.md b/tccli/examples/ssl/v20191205/DescribeCertificateBindResourceTaskResult.md index 60800efd90..1a489bc430 100644 --- a/tccli/examples/ssl/v20191205/DescribeCertificateBindResourceTaskResult.md +++ b/tccli/examples/ssl/v20191205/DescribeCertificateBindResourceTaskResult.md @@ -33,7 +33,7 @@ Output: "CacheTime": "2023-10-12 12:00:00" } ], - "RequestId": "abc" + "RequestId": "d9aa752b-dbd8-49c9-958f-75c051eddfe2" } } ``` diff --git a/tccli/examples/ssl/v20191205/DescribeHostDeployRecordDetail.md b/tccli/examples/ssl/v20191205/DescribeHostDeployRecordDetail.md index 5154c808b9..3e171ce4a3 100644 --- a/tccli/examples/ssl/v20191205/DescribeHostDeployRecordDetail.md +++ b/tccli/examples/ssl/v20191205/DescribeHostDeployRecordDetail.md @@ -6,45 +6,49 @@ Input: ``` tccli ssl DescribeHostDeployRecordDetail --cli-unfold-argument \ - --DeployRecordId 1 + --DeployRecordId 74889 ``` Output: ``` { "Response": { - "FailedTotalCount": 1, - "SuccessTotalCount": 1, "TotalCount": 1, - "RequestId": "xx111", - "RunningTotalCount": 1, + "SuccessTotalCount": 1, + "FailedTotalCount": 0, + "RunningTotalCount": 0, "DeployRecordDetailList": [ { + "Id": 182241, + "CertId": "Fvu**OA", + "OldCertId": "FxG***jc", "Status": 1, - "Bucket": "test-1302189209", - "UpdateTime": "xx1", - "CertId": "xx1", - "Protocol": "xx1", - "InstanceId": "xx1", - "ErrorMsg": "xx1", - "ListenerId": "xx1", - "CreateTime": "xaax", - "OldCertId": "xaax", - "EnvId": "ssl-xx", - "TCBType": "HostService", - "Region": "ap-shanghai", - "SniSwitch": 1, - "SecretName": "asdasd", - "ListenerName": "asdasd", - "Port": "123", - "Namespace": "asdasd", + "ErrorMsg": "", + "CreateTime": "2024-06-26T11:36:33.000000Z", + "UpdateTime": "2024-06-26T11:37:40.000000Z", + "InstanceId": "lb-jaj**fy", + "InstanceName": "zrhtest2", + "ListenerId": "lbl-fx***3l2", + "ListenerName": "zrhtest7", "Domains": [ - "xx1" + "ni***uang.online" ], - "InstanceName": "xx2", - "Id": 1 + "Protocol": "HTTPS", + "SniSwitch": 1, + "Bucket": "", + "Namespace": "", + "SecretName": "", + "EnvId": "", + "TCBType": "", + "Region": "", + "Port": 0, + "Url": [ + "/zrh1", + "/zrh2" + ] } - ] + ], + "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456" } } ``` diff --git a/tccli/examples/ssl/v20191205/DescribeHostTeoInstanceList.md b/tccli/examples/ssl/v20191205/DescribeHostTeoInstanceList.md index 618ed3d298..26e4131724 100644 --- a/tccli/examples/ssl/v20191205/DescribeHostTeoInstanceList.md +++ b/tccli/examples/ssl/v20191205/DescribeHostTeoInstanceList.md @@ -6,12 +6,12 @@ Input: ``` tccli ssl DescribeHostTeoInstanceList --cli-unfold-argument \ - --CertificateId abc \ + --CertificateId YT****j \ --IsCache 1 \ - --Filters.0.FilterKey abc \ - --Filters.0.FilterValue abc \ - --ResourceType abc \ - --OldCertificateId abc + --Filters.0.FilterKey domainMatch \ + --Filters.0.FilterValue 1 \ + --ResourceType teo \ + --OldCertificateId k****j ``` Output: @@ -20,14 +20,14 @@ Output: "Response": { "InstanceList": [ { - "Host": "abc", - "CertId": "abc", - "ZoneId": "abc", - "Status": "abc" + "Host": "www.zrh.com", + "CertId": "jk****L", + "ZoneId": "zone-*****", + "Status": "online" } ], - "TotalCount": 0, - "RequestId": "abc" + "TotalCount": 1, + "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456" } } ``` diff --git a/tccli/examples/ssl/v20191205/DescribeHostUpdateRecord.md b/tccli/examples/ssl/v20191205/DescribeHostUpdateRecord.md index 65000d2385..d5768c3036 100644 --- a/tccli/examples/ssl/v20191205/DescribeHostUpdateRecord.md +++ b/tccli/examples/ssl/v20191205/DescribeHostUpdateRecord.md @@ -30,7 +30,7 @@ Output: "UpdateTime": "2023-12-18 12:11:00" } ], - "RequestId": "abc" + "RequestId": "d9aa752b-dbd8-49c9-958f-75c051eddfe2" } } ``` diff --git a/tccli/examples/tbaas/v20180416/ApplyUserCert.md b/tccli/examples/tbaas/v20180416/ApplyUserCert.md index 9b33f9eff6..a4e775d342 100644 --- a/tccli/examples/tbaas/v20180416/ApplyUserCert.md +++ b/tccli/examples/tbaas/v20180416/ApplyUserCert.md @@ -12,7 +12,7 @@ tccli tbaas ApplyUserCert --cli-unfold-argument \ --GroupName youtuOrg \ --UserIdentity kyloz \ --Applicant 优图SDK \ - --IdentityNum 123 \ + --IdentityNum 3503******2342 \ --CsrData -----BEGINCERTIFICATEREQUEST----- MIIBSTCB8AIBADCBjTELMAkGA1UEBhMCQ04xEjAQBgNVBAgMCUd1YW5nWmhvdTER MA8GA1UEBwwIU2hlblpoZW4xFDASBgNVBAoMC2V4YW1wbGUuY29tMQ8wDQYDVQQL @@ -22,7 +22,7 @@ z+JMfmZjPEJ8x4H8a/CnqBIwcCaJjg5cMqOi+VyFHkCM9Sv4MFOqPAK7rE62m9XF s4B8hfKgADAKBggqhkjOPQQDAgNIADBFAiEAtl/h0DHfRJl170U6OGpCkN34jX0a GGGSHbFu2KxLUHsCIAFxXa6UsQOf93vT0FQldeBodbVCbNhM8/jtVqfZ/lhB -----ENDCERTIFICATEREQUEST----- \ - --Notes test + --Notes fact ``` Output: diff --git a/tccli/examples/tbaas/v20180416/DescribeFabricBlock.md b/tccli/examples/tbaas/v20180416/DescribeFabricBlock.md index 9140064d95..de8b86065e 100644 --- a/tccli/examples/tbaas/v20180416/DescribeFabricBlock.md +++ b/tccli/examples/tbaas/v20180416/DescribeFabricBlock.md @@ -26,7 +26,7 @@ Output: "BlockHeight": 4, "ChaincodeName": "_lifecycle", "CreateTime": "2023-08-05 15:44:04", - "Sender": "区块链测试机构pettychen", + "Sender": "区块链测试机构", "TxId": "03389f4a5af1883347ecdb15471e70abf3a8e6cf5b6648dc789674af7930e229" } ], diff --git a/tccli/examples/tbaas/v20180416/GetClusterSummary.md b/tccli/examples/tbaas/v20180416/GetClusterSummary.md index 874290e9d0..3bda49228e 100644 --- a/tccli/examples/tbaas/v20180416/GetClusterSummary.md +++ b/tccli/examples/tbaas/v20180416/GetClusterSummary.md @@ -9,7 +9,7 @@ tccli tbaas GetClusterSummary --cli-unfold-argument \ --Module cluster_mng \ --Operation cluster_summary \ --ClusterId 251005746bc0f03q8u93j \ - --GroupId 0 \ + --GroupId 12 \ --GroupName liulanOrg ``` @@ -17,21 +17,22 @@ Output: ``` { "Response": { - "ClientCertCount": 2, - "JoinChannelCount": 1, - "MyChaincodeCount": 1, - "MyChannelCount": 1, - "MyGroupCount": 1, - "MyPeerCount": 2, - "PeerCertCount": 2, - "RecentChaincodeCount": 1, - "RequestId": "8646a1d8-bae3-4b41-8732-06b8c004eaa5", - "TlsCertCount": 4, - "TotalCertCount": 8, + "MyPeerCount": 1, + "ClientCertCount": 1, "TotalChaincodeCount": 1, "TotalChannelCount": 1, + "TlsCertCount": 1, + "OrderCount": 1, + "RecentChaincodeCount": 1, + "PeerCertCount": 1, + "MyChaincodeCount": 1, + "RequestId": "aeae4ed4-a4ce-4ffd-9826-1aae7669bb7c", + "TotalCertCount": 1, + "MyGroupCount": 1, + "MyChannelCount": 1, "TotalGroupCount": 1, - "TotalPeerCount": 2 + "JoinChannelCount": 1, + "TotalPeerCount": 1 } } ``` diff --git a/tccli/examples/tbaas/v20180416/GetTransactionDetailForUser.md b/tccli/examples/tbaas/v20180416/GetTransactionDetailForUser.md index d3e3eb634a..182a4e063b 100644 --- a/tccli/examples/tbaas/v20180416/GetTransactionDetailForUser.md +++ b/tccli/examples/tbaas/v20180416/GetTransactionDetailForUser.md @@ -23,7 +23,7 @@ Output: "BlockHeight": 1, "BlockId": 0, "ChannelName": "tyler", - "ContractName": "", + "ContractName": "fact", "CreateOrgName": "org2", "CreateTime": "2019-10-28 18:48:28", "EndorserOrgList": [ @@ -35,8 +35,8 @@ Output: } ], "RequestId": "a13c4aed-ba4a-4357-850a-66707d7d5e74", - "TransactionData": "\"\"", - "TransactionHash": "", + "TransactionData": "{\"chaincode_spec\":{\"timeout\":0,\"type\":\"UNDEFINED\"}}", + "TransactionHash": "42c562517707bf53f08fe6e5a1cf5f50c784352ff0d8166e77514ebe518bd6c0", "TransactionId": "42c562517707bf53f08fe6e5a1cf5f50c784352ff0d8166e77514ebe518bd6c0", "TransactionStatus": "VALID", "TransactionType": "CONFIG" diff --git a/tccli/examples/tbaas/v20180416/InvokeChainMakerContract.md b/tccli/examples/tbaas/v20180416/InvokeChainMakerContract.md index 0e725831a1..d753055663 100644 --- a/tccli/examples/tbaas/v20180416/InvokeChainMakerContract.md +++ b/tccli/examples/tbaas/v20180416/InvokeChainMakerContract.md @@ -11,7 +11,7 @@ tccli tbaas InvokeChainMakerContract --cli-unfold-argument \ --ClusterId chainmaker-j1juwsmndn \ --FuncName save \ --AsyncFlag 0 \ - --ContractName test + --ContractName fact ``` Output: diff --git a/tccli/examples/tbaas/v20180416/QueryChainMakerContract.md b/tccli/examples/tbaas/v20180416/QueryChainMakerContract.md index 4de8b97ad5..fd796a2c68 100644 --- a/tccli/examples/tbaas/v20180416/QueryChainMakerContract.md +++ b/tccli/examples/tbaas/v20180416/QueryChainMakerContract.md @@ -8,7 +8,7 @@ Input: tccli tbaas QueryChainMakerContract --cli-unfold-argument \ --ChainId chain_dcwtt \ --ClusterId chainmaker-j1juwsmndn \ - --ContractName test \ + --ContractName fact \ --FuncParam {"file_hash":"1234567"} \ --FuncName find_by_file_hash ``` diff --git a/tccli/examples/tcb/v20180608/CreateAndDeployCloudBaseProject.md b/tccli/examples/tcb/v20180608/CreateAndDeployCloudBaseProject.md index 539df3dccb..45955a059c 100644 --- a/tccli/examples/tcb/v20180608/CreateAndDeployCloudBaseProject.md +++ b/tccli/examples/tcb/v20180608/CreateAndDeployCloudBaseProject.md @@ -6,29 +6,29 @@ Input: ``` tccli tcb CreateAndDeployCloudBaseProject --cli-unfold-argument \ - --EnvId xx \ - --Name xx \ - --Parameters.0.Value xx \ - --Parameters.0.Key xx \ - --Tags None \ - --RcJson xx \ - --FreeQuota xx \ - --NetworkConfig xx \ - --RepoUrl xx \ - --Source.CodingPackageVersion xx \ - --Source.WorkDir xx \ - --Source.Name xx \ - --Source.Url xx \ + --EnvId env-absdsasda \ + --Name name \ + --Parameters.0.Value value \ + --Parameters.0.Key key \ + --Tags tag1 \ + --RcJson {"key":"value"} \ + --FreeQuota quota \ + --NetworkConfig {"key":"value"} \ + --RepoUrl http://repourl \ + --Source.CodingPackageVersion version \ + --Source.WorkDir dir \ + --Source.Name name \ + --Source.Url http://url \ --Source.ProjectId 0 \ - --Source.RawCode xx \ - --Source.Branch xx \ - --Source.ProjectName xx \ - --Source.Type xx \ - --Source.CodingPackageName xx \ - --AddonConfig xx \ + --Source.RawCode rawCode \ + --Source.Branch branch \ + --Source.ProjectName projectName \ + --Source.Type type \ + --Source.CodingPackageName packageName \ + --AddonConfig {"key":"value"} \ --AutoDeployOnCodeChange True \ - --EnvAlias xx \ - --Type xx + --EnvAlias env \ + --Type pre ``` Output: diff --git a/tccli/examples/tcb/v20180608/DescribeCloudBaseProjectVersionList.md b/tccli/examples/tcb/v20180608/DescribeCloudBaseProjectVersionList.md index d3b040945c..b8d1c5561d 100644 --- a/tccli/examples/tcb/v20180608/DescribeCloudBaseProjectVersionList.md +++ b/tccli/examples/tcb/v20180608/DescribeCloudBaseProjectVersionList.md @@ -18,57 +18,57 @@ Output: "Response": { "ProjectVersions": [ { - "Name": "abc", - "Sam": "abc", + "Name": "name", + "Sam": "sam", "Source": { - "Type": "abc", - "Url": "abc", - "Name": "abc", - "WorkDir": "abc", - "CodingPackageName": "abc", - "CodingPackageVersion": "abc", - "RawCode": "abc", - "Branch": "abc", + "Type": "type", + "Url": "http://url", + "Name": "name", + "WorkDir": "dir", + "CodingPackageName": "projectName", + "CodingPackageVersion": "0.0.1", + "RawCode": "rawcode", + "Branch": "branch", "ProjectId": 0, - "ProjectName": "abc" + "ProjectName": "projectName" }, "CreateTime": 0, "UpdateTime": 0, - "Status": "abc", + "Status": "success", "Parameters": [ { - "Key": "abc", - "Value": "abc" + "Key": "key", + "Value": "value" } ], - "Type": "abc", - "CIId": "abc", - "CDId": "abc", - "EnvId": "abc", + "Type": "type", + "CIId": "ciid", + "CDId": "cdid", + "EnvId": "env-asdf", "VersionNum": 0, - "FailReason": "abc", - "RcJson": "abc", - "AddonConfig": "abc", + "FailReason": "failed with reason", + "RcJson": "{\"key\":\"value\"}", + "AddonConfig": "{\"key\":\"value\"}", "Tags": [ - "abc" + "tag" ], - "NetworkConfig": "abc", - "ExtensionId": "abc", - "FailType": "abc", - "RepoUrl": "abc", + "NetworkConfig": "{\"key\":\"value\"}", + "ExtensionId": "extensionid", + "FailType": "system", + "RepoUrl": "http://repourl", "AutoDeployOnCodeChange": true, "BuildPercent": 0, - "Uin": "abc", - "BuildFinishTime": "abc", - "DeployFinishTime": "abc", - "BuildId": "abc", - "SourceUrl": "abc", - "FailReasonShort": "abc", - "FirstInitRepo": "abc" + "Uin": "10000101123", + "BuildFinishTime": "2024-12-26 14:00:00", + "DeployFinishTime": "2024-12-26 14:05:00", + "BuildId": "buildid", + "SourceUrl": "http://sourceurl", + "FailReasonShort": "failed with something", + "FirstInitRepo": "http://firstinitrepo" } ], "TotalCount": 1, - "RequestId": "abc" + "RequestId": "asdasfas-hfgd-skdj-shaksldiaosu" } } ``` diff --git a/tccli/examples/tcm/v20210413/DescribeAccessLogConfig.md b/tccli/examples/tcm/v20210413/DescribeAccessLogConfig.md index d9f1e1b157..e21a1c9a06 100644 --- a/tccli/examples/tcm/v20210413/DescribeAccessLogConfig.md +++ b/tccli/examples/tcm/v20210413/DescribeAccessLogConfig.md @@ -13,35 +13,35 @@ Output: ``` { "Response": { - "File": "abc", - "Format": "abc", - "Encoding": "abc", + "File": "/dev/stdout", + "Format": "{xxx: xxx}", + "Encoding": "JSON", "SelectedRange": { "Items": [ { - "Namespace": "abc", - "ClusterName": "abc", - "ItemName": "abc", + "Namespace": "test", + "ClusterName": "cls-xxxxxxxx", + "ItemName": "test", "Gateways": [ - "abc" + "test" ] } ], "All": true }, - "Template": "abc", + "Template": "test", "CLS": { "Enable": true, - "LogSet": "abc", - "Topic": "abc", + "LogSet": "test", + "Topic": "test", "NeedDelete": true, - "Region": "abc" + "Region": "sh" }, - "Address": "abc", + "Address": "x.x.x.x", "EnableServer": true, "EnableStdout": true, "Enable": true, - "RequestId": "abc" + "RequestId": "xxxxxxxxxxxxxxxxxxx" } } ``` diff --git a/tccli/examples/tem/v20210701/CreateApplication.md b/tccli/examples/tem/v20210701/CreateApplication.md index 0e68db4800..8911310777 100644 --- a/tccli/examples/tem/v20210701/CreateApplication.md +++ b/tccli/examples/tem/v20210701/CreateApplication.md @@ -6,31 +6,18 @@ Input: ``` tccli tem CreateApplication --cli-unfold-argument \ - --ApplicationName abc \ - --Description abc \ - --UseDefaultImageService 0 \ - --RepoType 0 \ - --InstanceId abc \ - --RepoServer abc \ - --RepoName abc \ - --SourceChannel 0 \ - --SubnetList abc \ - --CodingLanguage abc \ - --DeployMode abc \ - --EnableTracing 0 \ - --UseDefaultImageServiceParameters.EnterpriseInstanceName abc \ - --UseDefaultImageServiceParameters.EnterpriseInstanceChargeType 0 \ - --UseDefaultImageServiceParameters.EnterpriseInstanceType abc \ - --Tags.0.TagKey abc \ - --Tags.0.TagValue abc + --ApplicationName tem-app \ + --Description 这是一个描述 \ + --CodingLanguage JAVA \ + --RepoType 3 ``` Output: ``` { "Response": { - "Result": "abc", - "RequestId": "abc" + "Result": "57d58b44-ee28-4db6-acba-c1cb0cxxx", + "RequestId": "app-xxxxxx" } } ``` diff --git a/tccli/examples/tem/v20210701/CreateApplicationAutoscaler.md b/tccli/examples/tem/v20210701/CreateApplicationAutoscaler.md index 4ac68e6e57..feaa88d273 100644 --- a/tccli/examples/tem/v20210701/CreateApplicationAutoscaler.md +++ b/tccli/examples/tem/v20210701/CreateApplicationAutoscaler.md @@ -9,27 +9,22 @@ tccli tem CreateApplicationAutoscaler --cli-unfold-argument \ --ApplicationId app-xxxxxx \ --SourceChannel 0 \ --EnvironmentId en-xxxxxx \ - --Autoscaler.MinReplicas 0 \ - --Autoscaler.MaxReplicas 0 \ - --Autoscaler.HorizontalAutoscaler.0.MinReplicas 0 \ - --Autoscaler.HorizontalAutoscaler.0.MaxReplicas 0 \ - --Autoscaler.HorizontalAutoscaler.0.Metrics abc \ - --Autoscaler.HorizontalAutoscaler.0.Threshold 0 \ + --Autoscaler.MinReplicas 1 \ + --Autoscaler.MaxReplicas 3 \ + --Autoscaler.AutoscalerName pk-test-1 \ + --Autoscaler.Description 这是一个描述 \ + --Autoscaler.Enabled False \ + --Autoscaler.HorizontalAutoscaler.0.MinReplicas 1 \ + --Autoscaler.HorizontalAutoscaler.0.MaxReplicas 3 \ + --Autoscaler.HorizontalAutoscaler.0.Metrics CPU \ + --Autoscaler.HorizontalAutoscaler.0.DoubleThreshold 50 \ --Autoscaler.HorizontalAutoscaler.0.Enabled True \ - --Autoscaler.HorizontalAutoscaler.0.DoubleThreshold 0 \ - --Autoscaler.CronHorizontalAutoscaler.0.Name abc \ - --Autoscaler.CronHorizontalAutoscaler.0.Period abc \ - --Autoscaler.CronHorizontalAutoscaler.0.Schedules.0.StartAt abc \ - --Autoscaler.CronHorizontalAutoscaler.0.Schedules.0.TargetReplicas 0 \ + --Autoscaler.CronHorizontalAutoscaler.0.Name policy-test \ + --Autoscaler.CronHorizontalAutoscaler.0.Period * * * \ + --Autoscaler.CronHorizontalAutoscaler.0.Schedules.0.StartAt 00:00 \ + --Autoscaler.CronHorizontalAutoscaler.0.Schedules.0.TargetReplicas 1 \ --Autoscaler.CronHorizontalAutoscaler.0.Enabled True \ - --Autoscaler.CronHorizontalAutoscaler.0.Priority 0 \ - --Autoscaler.AutoscalerId abc \ - --Autoscaler.AutoscalerName abc \ - --Autoscaler.Description abc \ - --Autoscaler.CreateDate abc \ - --Autoscaler.ModifyDate abc \ - --Autoscaler.EnableDate abc \ - --Autoscaler.Enabled True + --Autoscaler.CronHorizontalAutoscaler.0.Priority 0 ``` Output: diff --git a/tccli/examples/tem/v20210701/CreateApplicationService.md b/tccli/examples/tem/v20210701/CreateApplicationService.md index acec40d6ec..5c6f16de9b 100644 --- a/tccli/examples/tem/v20210701/CreateApplicationService.md +++ b/tccli/examples/tem/v20210701/CreateApplicationService.md @@ -10,18 +10,18 @@ tccli tem CreateApplicationService --cli-unfold-argument \ --SourceChannel 0 \ --EnvironmentId en-xxxxxx \ --Service.Type VPC \ - --Service.ServiceName abc \ - --Service.ClusterIp abc \ - --Service.ExternalIp abc \ - --Service.SubnetId abc \ - --Service.VpcId abc \ - --Service.LoadBalanceId abc \ - --Service.Yaml abc \ + --Service.ServiceName svc-name-xxx \ + --Service.ClusterIp 10.xx.xx.xx \ + --Service.ExternalIp 10.xx.xx.xx \ + --Service.SubnetId subnet-xxxxxx \ + --Service.VpcId vpc-xxxxxx \ + --Service.LoadBalanceId 10.xx.xx.xx \ + --Service.Yaml yaml-apiVersion-xxx \ --Service.Ports 0 \ - --Service.PortMappingItemList.0.Port 0 \ - --Service.PortMappingItemList.0.TargetPort 0 \ - --Service.PortMappingItemList.0.Protocol abc \ - --Service.ExternalDomain abc + --Service.PortMappingItemList.0.Port 8080 \ + --Service.PortMappingItemList.0.TargetPort 8080 \ + --Service.PortMappingItemList.0.Protocol TCP \ + --Service.ExternalDomain ext.domain.xxx ``` Output: diff --git a/tccli/examples/tem/v20210701/CreateConfigData.md b/tccli/examples/tem/v20210701/CreateConfigData.md index 3ddeba8955..e5eb276624 100644 --- a/tccli/examples/tem/v20210701/CreateConfigData.md +++ b/tccli/examples/tem/v20210701/CreateConfigData.md @@ -7,13 +7,10 @@ Input: ``` tccli tem CreateConfigData --cli-unfold-argument \ --EnvironmentId en-xxxxxx \ - --Name abc \ + --Name config-name-xxx \ --SourceChannel 0 \ - --Data.0.Key abc \ - --Data.0.Value abc \ - --Data.0.Type abc \ - --Data.0.Config abc \ - --Data.0.Secret abc + --Data.0.Key key-xxx \ + --Data.0.Value val-xxx ``` Output: diff --git a/tccli/examples/tem/v20210701/CreateEnvironment.md b/tccli/examples/tem/v20210701/CreateEnvironment.md index 2ab092e529..a97466a580 100644 --- a/tccli/examples/tem/v20210701/CreateEnvironment.md +++ b/tccli/examples/tem/v20210701/CreateEnvironment.md @@ -7,12 +7,12 @@ Input: ``` tccli tem CreateEnvironment --cli-unfold-argument \ --EnvironmentName name-xxx \ - --Description 描述 \ + --Description 这是一个描述 \ --K8sVersion 1.69.1 \ --SubnetIds subnet-xxx \ --EnableTswTraceService True \ --SourceChannel 0 \ - --Vpc vpc-xxx + --Vpc vpc-1n5javez ``` Output: @@ -20,7 +20,7 @@ Output: { "Response": { "RequestId": "81f74023-563c-437d-abf7-8139449ef178", - "Result": "env-xxxx" + "Result": "en-xxxx" } } ``` diff --git a/tccli/examples/tem/v20210701/CreateLogConfig.md b/tccli/examples/tem/v20210701/CreateLogConfig.md index 99dc7e2679..4c1489bb6a 100644 --- a/tccli/examples/tem/v20210701/CreateLogConfig.md +++ b/tccli/examples/tem/v20210701/CreateLogConfig.md @@ -6,27 +6,15 @@ Input: ``` tccli tem CreateLogConfig --cli-unfold-argument \ - --EnvironmentId en-xxxxxx \ - --ApplicationId app-xxxxxx \ - --Name abc \ - --LogsetId abc-xxx \ - --TopicId abc-xxxxx \ + --EnvironmentId en-dpxydze5 \ + --ApplicationId app-5vaz8x85 \ + --LogsetId 7a126551-62d1-4e12-b426-84bd5b2fdbca \ + --TopicId 6c69fdb7-5e4c-4e52-8437-32c2c729b85a \ --InputType container_stdout \ --LogType json_log \ - --BeginningRegex abc \ - --LogPath /abc \ - --FilePattern abc \ - --ExtractRule.BeginningRegex abc \ - --ExtractRule.Keys abc \ - --ExtractRule.FilterKeys abc \ - --ExtractRule.FilterRegex abc \ - --ExtractRule.LogRegex abc \ - --ExtractRule.TimeKey abc \ - --ExtractRule.TimeFormat abc \ - --ExtractRule.UnMatchUpload abc \ - --ExtractRule.UnMatchedKey abc \ - --ExtractRule.Backtracking abc \ - --ExtractRule.Delimiter abc + --Name log-cfg-xxx \ + --ExtractRule.UnMatchUpload true \ + --ExtractRule.UnMatchedKey LogParseFailure ``` Output: diff --git a/tccli/examples/tem/v20210701/CreateResource.md b/tccli/examples/tem/v20210701/CreateResource.md index 5cf234f145..9a6135506c 100644 --- a/tccli/examples/tem/v20210701/CreateResource.md +++ b/tccli/examples/tem/v20210701/CreateResource.md @@ -10,8 +10,7 @@ tccli tem CreateResource --cli-unfold-argument \ --ResourceType CFS \ --ResourceId resource-xxxxxx \ --SourceChannel 0 \ - --ResourceFrom test \ - --ResourceConfig abc + --ResourceFrom existing ``` Output: diff --git a/tccli/examples/tem/v20210701/DeployApplication.md b/tccli/examples/tem/v20210701/DeployApplication.md index 18181f4e72..5dcaf50cab 100644 --- a/tccli/examples/tem/v20210701/DeployApplication.md +++ b/tccli/examples/tem/v20210701/DeployApplication.md @@ -8,89 +8,57 @@ Input: tccli tem DeployApplication --cli-unfold-argument \ --ApplicationId app-5vaz8x85 \ --ConfEdited False \ + --DeployMode JAR \ + --JdkVersion KONA:11 \ + --PkgName tem/pkg/130xxxx/app-5vaz8x85/1733xxxx/K8sDemo-1.0.jar \ + --SpeedUp True \ + --OsFlavour ALPINE \ + --DeployVersion 20241202165113 \ + --JvmOpts -Xms128m -XX:MetaspaceSize=128m \ + --InitPodNum 3 \ --CpuSpec 1 \ - --DeployMode IMAGE \ - --DeployStrategyConf.BatchInterval 0 \ - --DeployStrategyConf.BetaBatchNum 0 \ - --DeployStrategyConf.DeployStrategyType 0 \ - --DeployStrategyConf.Force False \ - --DeployStrategyConf.MinAvailable 1 \ - --DeployStrategyConf.TotalBatchCount 1 \ - --DeployVersion hello-world \ - --EnableTracing 0 \ - --EnvironmentId en-dpxydze5 \ - --ImgRepo tem_demo/tem_demo \ - --InitPodNum 1 \ - --JvmOpts \ - --LogEnable 0 \ --MemorySpec 2 \ - --PostStart \ - --PreStop \ - --RepoServer ccr.ccs.tencentyun.com \ - --RepoType 4 \ - --SecurityGroupIds \ + --EnvConf.0.Key key \ + --EnvConf.0.Value val \ + --EnvConf.0.Type default \ + --EnvConf.0.Config \ + --EnvConf.0.Secret \ + --LogEnable 0 \ + --SecurityGroupIds sg-1zwhplpi \ + --EnvironmentId en-dpxydze5 \ + --Service.ServicePortMappingList.0.Type CLUSTER \ + --Service.ServicePortMappingList.0.ServiceName k8s-svc-test \ + --Service.ServicePortMappingList.0.ClusterIp 172.16.56.122 \ + --Service.ServicePortMappingList.0.ExternalIp 10.xx.xx.xx \ + --Service.ServicePortMappingList.0.ExternalDomain ext.domain.com \ + --Service.ServicePortMappingList.0.SubnetId subnet-xxx \ + --Service.ServicePortMappingList.0.VpcId vpc-xxx \ + --Service.ServicePortMappingList.0.LoadBalanceId 10.xx.xx.xx \ + --Service.ServicePortMappingList.0.Yaml apiVersion: xxxxx \ + --Service.ServicePortMappingList.0.Ports 8080 \ + --Service.ServicePortMappingList.0.PortMappingItemList.0.Port 8080 \ + --Service.ServicePortMappingList.0.PortMappingItemList.0.TargetPort 8080 \ + --Service.ServicePortMappingList.0.PortMappingItemList.0.Protocol TCP \ --Service.EnableRegistryNextDeploy 0 \ --Service.FlushAll True \ - --Service.ServicePortMappingList.0.ClusterIp 172.16.207.15 \ - --Service.ServicePortMappingList.0.ExternalDomain \ - --Service.ServicePortMappingList.0.ExternalIp \ - --Service.ServicePortMappingList.0.LoadBalanceId \ - --Service.ServicePortMappingList.0.PortMappingItemList.0.Port 8201 \ - --Service.ServicePortMappingList.0.PortMappingItemList.0.Protocol TCP \ - --Service.ServicePortMappingList.0.PortMappingItemList.0.TargetPort 8201 \ - --Service.ServicePortMappingList.0.Ports 8201 \ - --Service.ServicePortMappingList.0.ServiceName pk-test-clb-2 \ - --Service.ServicePortMappingList.0.SubnetId \ - --Service.ServicePortMappingList.0.Type CLUSTER \ - --Service.ServicePortMappingList.0.VpcId \ - --Service.ServicePortMappingList.0.Yaml apiVersion: v1 -kind: Service -metadata: - creationTimestamp: '2024-10-25T10:52:08Z' - finalizers: [] - labels: - tem-application-id: app-5vaz8x85 - tem-internal: 'false' - tem-service: pk-test-clb-2 - managedFields: - - apiVersion: v1 - fieldsType: FieldsV1 - fieldsV1: {} - manager: okhttp - operation: Update - time: '2024-10-25T10:52:08Z' - name: pk-test-clb-2 - namespace: default - ownerReferences: [] - resourceVersion: '24527383012' - selfLink: /api/v1/namespaces/default/services/pk-test-clb-2 - uid: 205ee301-8743-46ac-bc6f-d757eeab27bb -spec: - type: ClusterIP - clusterIP: 172.16.207.15 - clusterIPs: - - 172.16.207.15 - externalIPs: [] - ipFamilies: [] - loadBalancerSourceRanges: [] - ports: - - name: pk-test-clb-2-port-tcp-8201-8201 - port: 8201 - protocol: TCP - targetPort: - kind: 0 - intVal: 8201 - selector: - tem-service: app0925 - sessionAffinity: None - topologyKeys: [] -status: - conditions: [] - loadBalancer: - ingress: [] - \ - --TcrInstanceId tcr-cwnk7hmb \ - --UseRegistryDefaultConfig False + --UseRegistryDefaultConfig False \ + --EnableTracing 0 \ + --SettingConfs.0.ConfigDataName cfg-test-1 \ + --SettingConfs.0.MountedPath /data \ + --SettingConfs.0.SecretDataName secret-name \ + --DeployStrategyConf.TotalBatchCount 1 \ + --DeployStrategyConf.BetaBatchNum 0 \ + --DeployStrategyConf.DeployStrategyType 3 \ + --DeployStrategyConf.MinAvailable 1 \ + --DeployStrategyConf.Force True \ + --DeployStrategyConf.BatchInterval 0 \ + --PostStart /bin/sh +-c +curl localhost:8080/postStart \ + --PreStop /bin/sh +-c +wget --server-response --spider -S --no-verbose --header="Content-Type:application/json" --post-data='{"serverName":"api-basic"}' "http://localhost:9900/actuator/stopmsg" +sleep 30s ``` Output: diff --git a/tccli/examples/tem/v20210701/DescribeApplicationAutoscalerList.md b/tccli/examples/tem/v20210701/DescribeApplicationAutoscalerList.md index 67785d4f50..3155d4fada 100644 --- a/tccli/examples/tem/v20210701/DescribeApplicationAutoscalerList.md +++ b/tccli/examples/tem/v20210701/DescribeApplicationAutoscalerList.md @@ -17,42 +17,99 @@ Output: "Response": { "Result": [ { + "AutoscalerId": "scaler-3j2o6ypg", + "AutoscalerName": "elastic-test", "MinReplicas": 0, - "MaxReplicas": 0, + "MaxReplicas": 4, + "CreateDate": "2024-12-05 11:10:19", + "ModifyDate": "2024-12-20 17:00:23", + "EnableDate": "2024-12-20 17:00:23", + "Description": "这是一个描述", + "Enabled": true, "HorizontalAutoscaler": [ { "MinReplicas": 0, - "MaxReplicas": 0, - "Metrics": "abc", + "MaxReplicas": 4, + "Metrics": "CPU", "Threshold": 0, - "Enabled": true, - "DoubleThreshold": 0 + "DoubleThreshold": 60, + "Enabled": true + } + ], + "CronHorizontalAutoscaler": [] + }, + { + "AutoscalerId": "scaler-b5q33njo", + "AutoscalerName": "pk-test-clb", + "MinReplicas": 0, + "MaxReplicas": 4, + "CreateDate": "2024-10-25 16:36:10", + "ModifyDate": "2024-11-29 10:35:52", + "EnableDate": "2024-11-29 10:35:52", + "Description": "这是一个描述", + "Enabled": false, + "HorizontalAutoscaler": [ + { + "MinReplicas": 0, + "MaxReplicas": 4, + "Metrics": "CPU", + "Threshold": 0, + "DoubleThreshold": 50, + "Enabled": true } ], "CronHorizontalAutoscaler": [ { - "Name": "abc", - "Period": "abc", + "Name": "pk-test", + "Period": "* * *", "Schedules": [ { - "StartAt": "abc", - "TargetReplicas": 0 + "StartAt": "02:00", + "TargetReplicas": 1 } ], - "Enabled": true, + "Enabled": false, "Priority": 0 } + ] + }, + { + "AutoscalerId": "scaler-ojr3nlj9", + "AutoscalerName": "pk-test-1", + "MinReplicas": 1, + "MaxReplicas": 3, + "CreateDate": "2024-12-19 23:38:45", + "ModifyDate": "2024-12-19 23:38:45", + "EnableDate": null, + "Description": "", + "Enabled": false, + "HorizontalAutoscaler": [ + { + "MinReplicas": 1, + "MaxReplicas": 3, + "Metrics": "CPU", + "Threshold": 0, + "DoubleThreshold": 50, + "Enabled": true + } ], - "AutoscalerId": "abc", - "AutoscalerName": "abc", - "Description": "abc", - "CreateDate": "abc", - "ModifyDate": "abc", - "EnableDate": "abc", - "Enabled": true + "CronHorizontalAutoscaler": [ + { + "Name": "policy-test", + "Period": "* * *", + "Schedules": [ + { + "StartAt": "00:00", + "TargetReplicas": 1 + } + ], + "Enabled": true, + "Priority": 0 + } + ] } ], - "RequestId": "abc" + "RequestId": "c1d58f12-420f-464c-ac3e-f4f6a77284b0" } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeApplicationInfo.md b/tccli/examples/tem/v20210701/DescribeApplicationInfo.md index babe5aac0e..4764cdbb74 100644 --- a/tccli/examples/tem/v20210701/DescribeApplicationInfo.md +++ b/tccli/examples/tem/v20210701/DescribeApplicationInfo.md @@ -15,351 +15,466 @@ Output: ``` { "Response": { + "RequestId": "b86d4065-771d-485c-9130-8914fe5fd1bc", "Result": { - "VersionId": "abc", - "ApplicationId": "abc", - "DeployMode": "abc", - "JdkVersion": "abc", - "Description": "abc", - "DeployVersion": "abc", - "PublishMode": "abc", - "JvmOpts": "abc", - "InitPodNum": 0, - "CpuSpec": 0, - "MemorySpec": 0, - "ImgRepo": "abc", - "ImgName": "abc", - "ImgVersion": "abc", - "EsInfo": { - "MinAliveInstances": 0, - "MaxAliveInstances": 0, - "EsStrategy": 0, - "VersionId": "abc", - "Threshold": 1 - }, + "AppId": "1305738457", + "SubAccountUin": "100000799529", + "Uin": "100019051593", + "Region": "ap-shanghai", + "VersionId": "revision-jorxnl6j", + "VersionName": "20241202165113", + "ApplicationId": "app-5vaz8x85", + "Vpc": "vpc-e3ay8qku", + "SubnetId": "subnet-kctzw7nj,subnet-8indzsuv,subnet-qau65gm1", + "DeployMode": "JAR", + "JdkVersion": "KONA:11", + "Description": "", + "DeployVersion": "20241202165113", + "GroupId": "group-job6vv75", + "PublishMode": "", + "InitPodNum": 3, + "CpuSpec": 1, + "MemorySpec": 2, + "ImgRepo": "", + "ImgName": "tem-100019051593-sfuw/app0925", + "ImgVersion": "20241202165113", + "EsInfo": null, "EnvConf": [ { - "Key": "abc", - "Value": "abc", - "Type": "abc", - "Config": "abc", - "Secret": "abc" - } - ], - "StorageConfs": [ + "Key": "TEM_APM_TOKEN", + "Value": "DBaxEudGGxxOFmAYNBuq", + "Type": "reserved", + "Config": "", + "Secret": "" + }, + { + "Key": "TEM_APM_COLLECTOR_SKYWALKING", + "Value": "pl.ap-shanghai.apm.tencentcs.com:11800", + "Type": "reserved", + "Config": "", + "Secret": "" + }, + { + "Key": "TEM_APM_COLLECTOR_JAEGER", + "Value": "pl.ap-shanghai.apm.tencentcs.com:14250", + "Type": "reserved", + "Config": "", + "Secret": "" + }, + { + "Key": "TEM_APM_COLLECTOR_OPENTELEMETRY", + "Value": "pl.ap-shanghai.apm.tencentcs.com:4317", + "Type": "reserved", + "Config": "", + "Secret": "" + }, + { + "Key": "TEM_APM_INSTANCE_ID", + "Value": "apm-JcXK7eNzw", + "Type": "reserved", + "Config": "", + "Secret": "" + }, { - "StorageVolName": "abc", - "StorageVolPath": "abc", - "StorageVolIp": "abc" + "Key": "PROMETHEUS_INSTANCE_ID", + "Value": "prom-hdiellob", + "Type": "reserved", + "Config": "", + "Secret": "" + }, + { + "Key": "PROMETHEUS_TOKEN", + "Value": ";F1Lh7zVs-LFhT&+3dRqUA5bhdl", + "Type": "reserved", + "Config": "", + "Secret": "" + }, + { + "Key": "PROMETHEUS_REMOTE_WRITE_URL", + "Value": "http://10.0.30.147:9090/api/v1/prom/write", + "Type": "reserved", + "Config": "", + "Secret": "" + }, + { + "Key": "PROMETHEUS_REMOTE_READ_URL", + "Value": "http://10.0.30.147:9090/api/v1/read", + "Type": "reserved", + "Config": "", + "Secret": "" + }, + { + "Key": "PROMETHEUS_PUSH_GATEWAY_ADDR", + "Value": "10.0.30.147:9090", + "Type": "reserved", + "Config": "", + "Secret": "" + }, + { + "Key": "PROMETHEUS_HTTP_API", + "Value": "http://10.0.30.147:9090/api/v1", + "Type": "reserved", + "Config": "", + "Secret": "" + }, + { + "Key": "PROMETHEUS_GRAFANA_ADDR", + "Value": "", + "Type": "reserved", + "Config": "", + "Secret": "" } ], - "Status": "abc", - "Vpc": "abc", - "SubnetId": "abc", - "CreateDate": "abc", - "ModifyDate": "abc", - "StorageMountConfs": [ + "SettingConfs": [ { - "VolumeName": "abc", - "MountPath": "abc" + "ConfigDataName": "pk-test-1", + "SecretDataName": "", + "MountedPath": "/data", + "Data": [ + { + "Key": "name", + "Value": "value", + "Type": "", + "Config": "", + "Secret": "" + } + ] } ], - "VersionName": "abc", - "LogOutputConf": { - "OutputType": "abc", - "ClsLogsetName": "abc", - "ClsLogTopicId": "abc", - "ClsLogsetId": "abc", - "ClsLogTopicName": "abc" - }, - "ApplicationName": "abc", - "ApplicationDescription": "abc", - "EnvironmentName": "abc", - "EnvironmentId": "abc", - "PublicDomain": "abc", - "EnablePublicAccess": true, - "CurrentInstances": 0, - "ExpectedInstances": 0, - "CodingLanguage": "abc", - "PkgName": "abc", - "EsEnable": 0, - "EsStrategy": 0, - "ImageTag": "abc", - "LogEnable": 0, - "MinAliveInstances": "abc", - "SecurityGroupIds": [ - "abc" - ], - "ImageCommand": "abc", - "ImageArgs": [ - "abc" - ], - "UseRegistryDefaultConfig": true, + "LogConfs": [], + "LogOutputConf": null, + "PostStart": "/bin/sh\n-c\ncurl localhost:8080/postStart", + "PostStartEncoded": "", + "PreStop": "/bin/sh\n-c\nwget --server-response --spider -S --no-verbose --header=\"Content-Type:application/json\" --post-data='{\"serverName\":\"api-basic\"}' \"http://localhost:9900/actuator/stopmsg\"\nsleep 30s", + "PreStopEncoded": "", + "StorageConfs": [], + "StorageMountConfs": [], + "JvmOpts": "-Xms128m -XX:MetaspaceSize=128m", "Service": { - "Name": "abc", - "Ports": [ - 0 - ], - "Yaml": "abc", - "ApplicationName": "abc", - "VersionName": "abc", - "ClusterIp": [ - "abc" - ], - "ExternalIp": "abc", - "Type": "abc", - "SubnetId": "abc", - "LoadBalanceId": "abc", - "PortMappings": [ - { - "Port": 0, - "TargetPort": 0, - "Protocol": "abc", - "ServiceName": "abc" - } - ], + "PortMappings": [], + "LoadBalanceId": "", + "SubnetId": "", + "Type": "", + "Name": "", + "ApplicationName": "app0925", + "ClusterIp": [], + "ExternalIp": "", + "ExternalDomain": "", + "VersionName": "", + "Ports": [], + "Yaml": "", + "ApplicationId": "app-5vaz8x85", "ServicePortMappingList": [ { - "Type": "abc", - "ServiceName": "abc", - "ClusterIp": "abc", - "ExternalIp": "abc", - "SubnetId": "abc", - "VpcId": "abc", - "LoadBalanceId": "abc", - "Yaml": "abc", + "Type": "CLUSTER", + "ServiceName": "k8s-svc-test", + "ClusterIp": "172.16.56.122", + "ExternalIp": "", + "ExternalDomain": "", + "SubnetId": "", + "VpcId": "", + "LoadBalanceId": "", + "Yaml": "apiVersion: xxxx", "Ports": [ - 0 + 8080 ], "PortMappingItemList": [ { - "Port": 0, - "TargetPort": 0, - "Protocol": "abc" + "Port": 8080, + "TargetPort": 8080, + "Protocol": "TCP" } + ] + }, + { + "Type": "CLUSTER", + "ServiceName": "pk-svc", + "ClusterIp": "172.16.52.35", + "ExternalIp": "", + "ExternalDomain": "", + "SubnetId": "", + "VpcId": "", + "LoadBalanceId": "", + "Yaml": "apiVersion: xxxx", + "Ports": [ + 8080 ], - "ExternalDomain": "abc" + "PortMappingItemList": [ + { + "Port": 8080, + "TargetPort": 8080, + "Protocol": "TCP" + } + ] } ], - "FlushAll": true, + "FlushAll": false, "EnableRegistryNextDeploy": 0, - "ApplicationId": "abc", - "AllIpDone": true, - "ExternalDomain": "abc" + "AllIpDone": true }, - "SettingConfs": [ - { - "ConfigDataName": "abc", - "MountedPath": "abc", - "Data": [ - { - "Key": "abc", - "Value": "abc", - "Type": "abc", - "Config": "abc", - "Secret": "abc" - } - ], - "SecretDataName": "abc" - } - ], - "LogConfs": [ - "abc" + "Liveness": null, + "Readiness": null, + "StartupProbe": null, + "EsEnable": null, + "EnableTracing": 0, + "EnableRegistry": 0, + "EnableTracingReport": 0, + "EnableMetrics": 0, + "EnablePrometheusConf": null, + "ApmInstanceId": "", + "LogEnable": null, + "RepoType": 3, + "CreateDate": "2024-09-25 11:36:11", + "ModifyDate": "2024-12-20 17:00:16", + "MinAliveInstances": "", + "ImageTag": "20241202165113", + "SecurityGroupIds": [ + "sg-1zwhplpi" ], - "PostStart": "abc", - "PreStop": "abc", - "Liveness": { - "Type": "abc", - "Protocol": "abc", - "Path": "abc", - "Exec": "abc", - "Port": 0, - "InitialDelaySeconds": 0, - "TimeoutSeconds": 0, - "PeriodSeconds": 0 - }, - "Readiness": { - "Type": "abc", - "Protocol": "abc", - "Path": "abc", - "Exec": "abc", - "Port": 0, - "InitialDelaySeconds": 0, - "TimeoutSeconds": 0, - "PeriodSeconds": 0 - }, - "HorizontalAutoscaler": [ + "EsStrategy": null, + "AutoscalerList": [ { + "AutoscalerId": "scaler-3j2o6ypg", + "AutoscalerName": "elastic-test", "MinReplicas": 0, - "MaxReplicas": 0, - "Metrics": "abc", - "Threshold": 0, + "MaxReplicas": 4, + "CreateDate": "2024-12-05 11:10:19", + "ModifyDate": "2024-12-20 17:00:23", + "EnableDate": "2024-12-20 17:00:23", + "Description": "", "Enabled": true, - "DoubleThreshold": 0 - } - ], - "CronHorizontalAutoscaler": [ - { - "Name": "abc", - "Period": "abc", - "Schedules": [ + "HorizontalAutoscaler": [ { - "StartAt": "abc", - "TargetReplicas": 0 + "MinReplicas": 0, + "MaxReplicas": 4, + "Metrics": "CPU", + "Threshold": 0, + "DoubleThreshold": 60, + "Enabled": true } ], - "Enabled": true, - "Priority": 0 - } - ], - "Zones": [ - "abc" - ], - "LastDeployDate": "abc", - "LastDeploySuccessDate": "abc", - "NodeInfos": [ - { - "Name": "abc", - "Zone": "abc", - "SubnetId": "abc", - "AvailableIpCount": "abc", - "Cidr": "abc" - } - ], - "ImageType": 0, - "EnableTracing": 1, - "EnableTracingReport": 1, - "RepoType": 1, - "BatchDeployStatus": "abc", - "ApmInstanceId": "abc", - "WorkloadInfo": { - "ClusterId": "abc", - "ApplicationName": "abc", - "VersionName": "abc", - "ReadyReplicas": 0, - "Replicas": 0, - "UpdatedReplicas": 0, - "UpdatedReadyReplicas": 0, - "UpdateRevision": "abc", - "CurrentRevision": "abc" - }, - "SpeedUp": true, - "StartupProbe": { - "Type": "abc", - "Protocol": "abc", - "Path": "abc", - "Exec": "abc", - "Port": 0, - "InitialDelaySeconds": 0, - "TimeoutSeconds": 0, - "PeriodSeconds": 0 - }, - "OsFlavour": "abc", - "RepoServer": "abc", - "UnderDeploying": true, - "EnablePrometheusConf": { - "Port": 0, - "Path": "abc" - }, - "StoppedManually": true, - "TcrInstanceId": "abc", - "EnableMetrics": 0, - "AppId": "abc", - "SubAccountUin": "abc", - "Uin": "abc", - "Region": "abc", - "GroupId": "abc", - "EnableRegistry": 0, - "AutoscalerList": [ + "CronHorizontalAutoscaler": [] + }, { + "AutoscalerId": "scaler-b5q33njo", + "AutoscalerName": "pk-test-clb", "MinReplicas": 0, - "MaxReplicas": 0, + "MaxReplicas": 4, + "CreateDate": "2024-10-25 16:36:10", + "ModifyDate": "2024-11-29 10:35:52", + "EnableDate": "2024-11-29 10:35:52", + "Description": "", + "Enabled": false, "HorizontalAutoscaler": [ { "MinReplicas": 0, - "MaxReplicas": 0, - "Metrics": "abc", + "MaxReplicas": 4, + "Metrics": "CPU", "Threshold": 0, - "Enabled": true, - "DoubleThreshold": 0 + "DoubleThreshold": 50, + "Enabled": true } ], "CronHorizontalAutoscaler": [ { - "Name": "abc", - "Period": "abc", + "Name": "pk-test", + "Period": "* * *", "Schedules": [ { - "StartAt": "abc", - "TargetReplicas": 0 + "StartAt": "02:00", + "TargetReplicas": 1 } ], - "Enabled": true, + "Enabled": false, "Priority": 0 } + ] + }, + { + "AutoscalerId": "scaler-ojr3nlj9", + "AutoscalerName": "pk-test-1", + "MinReplicas": 1, + "MaxReplicas": 3, + "CreateDate": "2024-12-19 23:38:45", + "ModifyDate": "2024-12-19 23:38:45", + "EnableDate": null, + "Description": "", + "Enabled": false, + "HorizontalAutoscaler": [ + { + "MinReplicas": 1, + "MaxReplicas": 3, + "Metrics": "CPU", + "Threshold": 0, + "DoubleThreshold": 50, + "Enabled": true + } ], - "AutoscalerId": "abc", - "AutoscalerName": "abc", - "Description": "abc", - "CreateDate": "abc", - "ModifyDate": "abc", - "EnableDate": "abc", - "Enabled": true + "CronHorizontalAutoscaler": [ + { + "Name": "policy-test", + "Period": "* * *", + "Schedules": [ + { + "StartAt": "00:00", + "TargetReplicas": 1 + } + ], + "Enabled": true, + "Priority": 0 + } + ] + } + ], + "ApplicationName": "app0925", + "ApplicationDescription": "preStop-test", + "EnvironmentName": "tt", + "EnvironmentId": "en-dpxydze5", + "RepoServer": "tem-sh-custom-registry-prd-01.tencentcloudcr.com", + "PublicDomain": "", + "EnablePublicAccess": null, + "Modifier": "100019051593", + "Creator": "100019051593", + "CurrentInstances": 1, + "ExpectedInstances": 3, + "Status": "abnormal", + "UnderDeploying": true, + "BatchDeployStatus": "", + "CodingLanguage": "JAVA", + "ImageType": 1, + "ImageCommand": "", + "ImageArgs": null, + "UseRegistryDefaultConfig": false, + "DeployStrategyConf": null, + "Zones": [ + "ap-shanghai-2" + ], + "LastDeployDate": "2024-12-20 17:00:17", + "LastDeploySuccessDate": "2024-12-20 17:00:17", + "NodeInfos": [ + { + "Name": "eklet-subnet-kctzw7nj-711231", + "Zone": "ap-shanghai-2", + "SubnetId": "subnet-kctzw7nj", + "AvailableIpCount": "243", + "Cidr": "10.0.10.0-24" + }, + { + "Name": "eklet-subnet-8indzsuv-457482", + "Zone": "ap-shanghai-2", + "SubnetId": "subnet-8indzsuv", + "AvailableIpCount": "226", + "Cidr": "10.0.30.0-24" + }, + { + "Name": "eklet-subnet-qau65gm1-638453", + "Zone": "ap-shanghai-2", + "SubnetId": "subnet-qau65gm1", + "AvailableIpCount": "246", + "Cidr": "10.0.20.0-24" } ], - "Modifier": "abc", - "Creator": "abc", - "DeployStrategyConf": { - "TotalBatchCount": 0, - "BetaBatchNum": 0, - "DeployStrategyType": 0, - "BatchInterval": 0, - "MinAvailable": 0, - "Force": true + "WorkloadInfo": { + "ApplicationName": "app0925", + "ClusterId": "cls-kotuimb9", + "VersionName": "20241202165113", + "ReadyReplicas": 1, + "Replicas": 3, + "UpdatedReplicas": 2, + "UpdatedReadyReplicas": 0, + "UpdateRevision": "app0925-574b65c5f7", + "CurrentRevision": "app0925-77969b5b49" }, "PodList": { "Offset": 0, - "Limit": 0, - "TotalCount": 0, - "RequestId": "abc", + "Limit": 3, + "TotalCount": 3, "PodList": [ { - "Webshell": "abc", - "PodId": "abc", - "Status": "abc", - "CreateTime": "abc", - "PodIp": "abc", - "Zone": "abc", - "DeployVersion": "abc", + "Zone": "ap-shanghai-2", + "NodeInfo": { + "Name": "eklet-subnet-kctzw7nj-711231", + "Zone": "ap-shanghai-2", + "SubnetId": "subnet-kctzw7nj", + "AvailableIpCount": "243", + "Cidr": "10.0.10.0-24" + }, + "DeployVersion": "", + "RestartCount": 0, + "Ready": false, + "StartTime": "2024-12-20T09:01:01Z", + "ContainerState": "waiting", + "Unhealthy": null, + "UnhealthyWarningMsg": "", + "VersionId": "revision-jorxnl6j", + "ApplicationName": "app0925", + "Status": "CrashLoopBackOff", + "CreateTime": "2024-12-20T09:00:23Z", + "PodIp": "10.0.10.220", + "Webshell": "https://tkecache.cloud.tencent.com/xxxx", + "PodId": "app0925-4sbct" + }, + { + "Zone": "ap-shanghai-2", + "NodeInfo": { + "Name": "eklet-subnet-qau65gm1-638453", + "Zone": "ap-shanghai-2", + "SubnetId": "subnet-qau65gm1", + "AvailableIpCount": "246", + "Cidr": "10.0.20.0-24" + }, + "DeployVersion": "", "RestartCount": 0, - "Ready": true, - "ContainerState": "abc", + "Ready": false, + "StartTime": "2024-12-20T09:01:11Z", + "ContainerState": "waiting", + "Unhealthy": null, + "UnhealthyWarningMsg": "", + "VersionId": "revision-jorxnl6j", + "ApplicationName": "app0925", + "Status": "CrashLoopBackOff", + "CreateTime": "2024-12-20T09:00:23Z", + "PodIp": "10.0.20.37", + "Webshell": "https://tkecache.cloud.tencent.com/xxxx", + "PodId": "app0925-s4vpj" + }, + { + "Zone": "ap-shanghai-2", "NodeInfo": { - "Name": "abc", - "Zone": "abc", - "SubnetId": "abc", - "AvailableIpCount": "abc", - "Cidr": "abc" + "Name": "eklet-subnet-8indzsuv-457482", + "Zone": "ap-shanghai-2", + "SubnetId": "subnet-8indzsuv", + "AvailableIpCount": "226", + "Cidr": "10.0.30.0-24" }, - "StartTime": "abc", - "Unhealthy": true, - "UnhealthyWarningMsg": "abc", - "VersionId": "abc", - "ApplicationName": "abc" + "DeployVersion": "", + "RestartCount": 0, + "Ready": true, + "StartTime": "2024-12-19T03:12:44Z", + "ContainerState": "running", + "Unhealthy": null, + "UnhealthyWarningMsg": "", + "VersionId": "revision-57moqvm5", + "ApplicationName": "app0925", + "Status": "Running", + "CreateTime": "2024-12-19T03:11:32Z", + "PodIp": "10.0.30.158", + "Webshell": "https://tkecache.cloud.tencent.com/qcloud/xxxx", + "PodId": "app0925-jt5bn" } - ] + ], + "RequestId": "csdse233-xxx-xxx-xxx" }, - "ConfEdited": true, - "Tags": [ - { - "TagKey": "abc", - "TagValue": "abc" - } - ], - "PreStopEncoded": "abc", - "PostStartEncoded": "abc" - }, - "RequestId": "abc" + "ConfEdited": null, + "SpeedUp": true, + "OsFlavour": "ALPINE", + "StoppedManually": false, + "TcrInstanceId": "tcr-d8g5il2x", + "Tags": [], + "PkgName": "tem/pkg/1305738457/app-5vaz8x85/1733129495394/K8sEventDemo-1.0.jar", + "HorizontalAutoscaler": [], + "CronHorizontalAutoscaler": [] + } } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeApplicationPods.md b/tccli/examples/tem/v20210701/DescribeApplicationPods.md index b08536063c..506c1b3933 100644 --- a/tccli/examples/tem/v20210701/DescribeApplicationPods.md +++ b/tccli/examples/tem/v20210701/DescribeApplicationPods.md @@ -19,39 +19,87 @@ Output: ``` { "Response": { + "RequestId": "0f09d0d3-3414-48ba-b8cc-e1c543b1fc1a", "Result": { "Offset": 0, - "Limit": 0, - "TotalCount": 0, - "RequestId": "abc", + "Limit": 3, + "TotalCount": 3, "PodList": [ { - "Webshell": "https://xxx-xxx-xxxx", - "PodId": "abc", - "Status": "abc", - "CreateTime": "abc", - "PodIp": "abc", - "Zone": "abc", - "DeployVersion": "abc", + "Zone": "ap-shanghai-2", + "NodeInfo": { + "Name": "eklet-subnet-kctzw7nj-711231", + "Zone": "ap-shanghai-2", + "SubnetId": "subnet-kctzw7nj", + "AvailableIpCount": "243", + "Cidr": "10.0.10.0-24" + }, + "DeployVersion": "20241202165113", "RestartCount": 0, - "Ready": true, - "ContainerState": "abc", + "Ready": false, + "StartTime": "2024-12-20T09:01:01Z", + "ContainerState": "waiting", + "Unhealthy": null, + "UnhealthyWarningMsg": "", + "VersionId": "revision-jorxnl6j", + "ApplicationName": "app0925", + "Status": "CrashLoopBackOff", + "CreateTime": "2024-12-20 17:00:23", + "Webshell": "https://tkecache.cloud.tencent.com/xxx", + "PodId": "app0925-4sbct", + "PodIp": "10.0.10.220" + }, + { + "Zone": "ap-shanghai-2", + "NodeInfo": { + "Name": "eklet-subnet-qau65gm1-638453", + "Zone": "ap-shanghai-2", + "SubnetId": "subnet-qau65gm1", + "AvailableIpCount": "246", + "Cidr": "10.0.20.0-24" + }, + "DeployVersion": "20241202165113", + "RestartCount": 0, + "Ready": false, + "StartTime": "2024-12-20T09:01:11Z", + "ContainerState": "waiting", + "Unhealthy": null, + "UnhealthyWarningMsg": "", + "VersionId": "revision-jorxnl6j", + "ApplicationName": "app0925", + "Status": "CrashLoopBackOff", + "CreateTime": "2024-12-20 17:00:23", + "Webshell": "https://tkecache.cloud.tencent.com/xxx", + "PodId": "app0925-s4vpj", + "PodIp": "10.0.20.37" + }, + { + "Zone": "ap-shanghai-2", "NodeInfo": { - "Name": "abc", - "Zone": "abc", - "SubnetId": "abc", - "AvailableIpCount": "abc", - "Cidr": "abc" + "Name": "eklet-subnet-8indzsuv-457482", + "Zone": "ap-shanghai-2", + "SubnetId": "subnet-8indzsuv", + "AvailableIpCount": "226", + "Cidr": "10.0.30.0-24" }, - "StartTime": "abc", - "Unhealthy": true, - "UnhealthyWarningMsg": "abc", - "VersionId": "abc", - "ApplicationName": "abc" + "DeployVersion": "20241202165113", + "RestartCount": 0, + "Ready": true, + "StartTime": "2024-12-19T03:12:44Z", + "ContainerState": "running", + "Unhealthy": null, + "UnhealthyWarningMsg": "", + "VersionId": "revision-57moqvm5", + "ApplicationName": "app0925", + "Status": "Running", + "CreateTime": "2024-12-19 11:11:32", + "Webshell": "https://tkecache.cloud.tencent.com/xxx", + "PodId": "app0925-jt5bn", + "PodIp": "10.0.30.158" } - ] - }, - "RequestId": "xxx-xxx-xxx" + ], + "RequestId": "0f09d0d3-xxx-xxx-xxx" + } } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeApplicationServiceList.md b/tccli/examples/tem/v20210701/DescribeApplicationServiceList.md index d6db98ebfc..05f8d9bce4 100644 --- a/tccli/examples/tem/v20210701/DescribeApplicationServiceList.md +++ b/tccli/examples/tem/v20210701/DescribeApplicationServiceList.md @@ -15,59 +15,69 @@ Output: ``` { "Response": { + "RequestId": "7003cb9f-0932-4cba-b15a-21788df3a8fb", "Result": { - "Name": "abc", - "Ports": [ - 0 - ], - "Yaml": "abc", - "ApplicationName": "abc", - "VersionName": "abc", - "ClusterIp": [ - "abc" - ], - "ExternalIp": "xx-xx-xx-xx", - "Type": "abc", - "SubnetId": "abc", - "LoadBalanceId": "VPC", - "PortMappings": [ - { - "Port": 0, - "TargetPort": 0, - "Protocol": "abc", - "ServiceName": "abc" - } - ], + "PortMappings": [], + "LoadBalanceId": "", + "SubnetId": "", + "Type": "", + "Name": "", + "ApplicationName": "app0925", + "ClusterIp": [], + "ExternalIp": "", + "ExternalDomain": "", + "VersionName": "", + "Ports": [], + "Yaml": "", + "ApplicationId": "app-5vaz8x85", "ServicePortMappingList": [ { - "Type": "abc", - "ServiceName": "abc", - "ClusterIp": "abc", - "ExternalIp": "abc", - "SubnetId": "abc", - "VpcId": "abc", - "LoadBalanceId": "abc", - "Yaml": "abc", + "Type": "CLUSTER", + "ServiceName": "k8s-svc-test", + "ClusterIp": "172.16.56.122", + "ExternalIp": "", + "ExternalDomain": "", + "SubnetId": "", + "VpcId": "", + "LoadBalanceId": "", + "Yaml": "apiVersion: xxx", "Ports": [ - 0 + 8080 ], "PortMappingItemList": [ { - "Port": 0, - "TargetPort": 0, - "Protocol": "abc" + "Port": 8080, + "TargetPort": 8080, + "Protocol": "TCP" } + ] + }, + { + "Type": "CLUSTER", + "ServiceName": "pk-svc", + "ClusterIp": "172.16.52.35", + "ExternalIp": "", + "ExternalDomain": "", + "SubnetId": "", + "VpcId": "", + "LoadBalanceId": "", + "Yaml": "apiVersion: xxx", + "Ports": [ + 8080 ], - "ExternalDomain": "abc" + "PortMappingItemList": [ + { + "Port": 8080, + "TargetPort": 8080, + "Protocol": "TCP" + } + ] } ], - "FlushAll": true, + "FlushAll": false, "EnableRegistryNextDeploy": 0, - "ApplicationId": "abc", - "AllIpDone": true, - "ExternalDomain": "abc" - }, - "RequestId": "abc" + "AllIpDone": true + } } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeApplicationsStatus.md b/tccli/examples/tem/v20210701/DescribeApplicationsStatus.md index c377787ef5..31fb594c19 100644 --- a/tccli/examples/tem/v20210701/DescribeApplicationsStatus.md +++ b/tccli/examples/tem/v20210701/DescribeApplicationsStatus.md @@ -14,89 +14,157 @@ Output: ``` { "Response": { + "RequestId": "dda3b8c7-b536-4842-92a2-6756688a337e", "Result": [ { - "VersionName": "abc", - "Status": "abc", - "EnableEs": 0, - "CurrentInstances": 0, - "VersionId": "abc", - "LogOutputConf": { - "OutputType": "abc", - "ClsLogsetName": "abc", - "ClsLogTopicId": "abc", - "ClsLogsetId": "abc", - "ClsLogTopicName": "abc" - }, - "ExpectedInstances": 0, - "DeployMode": "abc", - "BuildTaskId": "abc", - "EnvironmentId": "abc", - "EnvironmentName": "abc", - "ApplicationId": "abc", - "ApplicationName": "abc", - "UnderDeploying": true, - "BatchDeployStatus": "abc", + "VersionName": "bj", + "VersionId": "revision-jbzmeq7j", + "Status": "normal", + "BatchDeployStatus": "", + "EnableEs": -1, + "LogOutputConf": null, + "ExpectedInstances": 1, + "CurrentInstances": 1, + "DeployMode": "JAR", + "BuildTaskId": "build-5enzamz5", + "EnvironmentId": "en-dpxydml5", + "EnvironmentName": "bugfix-bj", + "ApplicationId": "app-5vaz8x85", + "ApplicationName": "app0925", "Zones": [ - "abc" + "ap-beijing-3" ], "NodeInfos": [ { - "Name": "abc", - "Zone": "abc", - "SubnetId": "abc", - "AvailableIpCount": "abc", - "Cidr": "abc" + "Name": "eklet-subnet-1ebj4rp9-766511", + "Zone": "ap-beijing-3", + "SubnetId": "subnet-1ebj4rp9", + "AvailableIpCount": "232", + "Cidr": "10.0.0.0-24" } ], "PodList": { - "Offset": 0, - "Limit": 0, - "TotalCount": 0, - "RequestId": "abc", + "Offset": -1, + "Limit": -1, + "TotalCount": 1, "PodList": [ { - "Webshell": "abc", - "PodId": "abc", - "Status": "abc", - "CreateTime": "abc", - "PodIp": "abc", - "Zone": "abc", - "DeployVersion": "abc", + "Zone": "ap-beijing-3", + "NodeInfo": { + "Name": "eklet-subnet-1ebj4rp9-766511", + "Zone": "ap-beijing-3", + "SubnetId": "subnet-1ebj4rp9", + "AvailableIpCount": "232", + "Cidr": "10.0.0.0-24" + }, + "DeployVersion": "", "RestartCount": 0, "Ready": true, - "ContainerState": "abc", + "StartTime": "2024-09-25T03:39:59Z", + "ContainerState": "running", + "Unhealthy": null, + "UnhealthyWarningMsg": "", + "VersionId": "revision-jbzmeq7j", + "ApplicationName": "app0925", + "Status": "Running", + "CreateTime": "2024-09-25T03:39:08Z", + "Webshell": "https://tkecache.cloud.tencent.com/xxx", + "PodId": "app0925-p728w", + "PodIp": "10.0.0.7" + } + ], + "RequestId": "" + }, + "WorkloadInfo": { + "ApplicationName": "app0925", + "ClusterId": "cls-1trz6x5l", + "VersionName": "bj", + "ReadyReplicas": 1, + "Replicas": 1, + "UpdatedReplicas": 1, + "UpdatedReadyReplicas": 1, + "UpdateRevision": "app0925-868b68987", + "CurrentRevision": "app0925-868b68987" + }, + "CreateDate": null, + "UnderDeploying": false, + "RegionId": "8" + }, + { + "VersionName": "hello-world", + "VersionId": "revision-jordnl7j", + "Status": "normal", + "BatchDeployStatus": "", + "EnableEs": -1, + "LogOutputConf": null, + "ExpectedInstances": 1, + "CurrentInstances": 1, + "DeployMode": "IMAGE", + "BuildTaskId": "", + "EnvironmentId": "en-dpxydml5", + "EnvironmentName": "bugfix-bj", + "ApplicationId": "app-57477ag5", + "ApplicationName": "bugfix-test", + "Zones": [ + "ap-beijing-3" + ], + "NodeInfos": [ + { + "Name": "eklet-subnet-1ebj4rp9-766511", + "Zone": "ap-beijing-3", + "SubnetId": "subnet-1ebj4rp9", + "AvailableIpCount": "232", + "Cidr": "10.0.0.0-24" + } + ], + "PodList": { + "Offset": -1, + "Limit": -1, + "TotalCount": 1, + "PodList": [ + { + "Zone": "ap-beijing-3", "NodeInfo": { - "Name": "abc", - "Zone": "abc", - "SubnetId": "abc", - "AvailableIpCount": "abc", - "Cidr": "abc" + "Name": "eklet-subnet-1ebj4rp9-766511", + "Zone": "ap-beijing-3", + "SubnetId": "subnet-1ebj4rp9", + "AvailableIpCount": "232", + "Cidr": "10.0.0.0-24" }, - "StartTime": "abc", - "Unhealthy": true, - "UnhealthyWarningMsg": "abc", - "VersionId": "abc", - "ApplicationName": "abc" + "DeployVersion": "", + "RestartCount": 0, + "Ready": true, + "StartTime": "2024-08-05T08:15:26Z", + "ContainerState": "running", + "Unhealthy": null, + "UnhealthyWarningMsg": "", + "VersionId": "revision-jordnl7j", + "ApplicationName": "bugfix-test", + "Status": "Running", + "CreateTime": "2024-08-05T08:14:28Z", + "Webshell": "https://tkecache.cloud.tencent.com/xxx", + "PodId": "bugfix-test-lvn56", + "PodIp": "10.0.0.16" } - ] + ], + "RequestId": "" }, "WorkloadInfo": { - "ClusterId": "abc", - "ApplicationName": "abc", - "VersionName": "abc", - "ReadyReplicas": 0, - "Replicas": 0, - "UpdatedReplicas": 0, - "UpdatedReadyReplicas": 0, - "UpdateRevision": "abc", - "CurrentRevision": "abc" + "ApplicationName": "bugfix-test", + "ClusterId": "cls-1trz6x5l", + "VersionName": "hello-world", + "ReadyReplicas": 1, + "Replicas": 1, + "UpdatedReplicas": 1, + "UpdatedReadyReplicas": 1, + "UpdateRevision": "bugfix-test-648f6b456d", + "CurrentRevision": "bugfix-test-648f6b456d" }, - "CreateDate": "abc", - "RegionId": "abc" + "CreateDate": null, + "UnderDeploying": false, + "RegionId": "8" } - ], - "RequestId": "abc" + ] } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeConfigData.md b/tccli/examples/tem/v20210701/DescribeConfigData.md index c16a0b7984..e41ff5d70f 100644 --- a/tccli/examples/tem/v20210701/DescribeConfigData.md +++ b/tccli/examples/tem/v20210701/DescribeConfigData.md @@ -15,128 +15,21 @@ Output: ``` { "Response": { + "RequestId": "8b94500c-06cf-42cf-a228-dfea478c3239", "Result": { - "Name": "abc", - "CreateTime": "abc", - "RelatedApplications": [ - { - "ApplicationId": "abc", - "ApplicationName": "abc", - "Description": "abc", - "EnvironmentId": "abc", - "CreateDate": "2020-09-22 00:00:00", - "ModifyDate": "2020-09-22 00:00:00", - "Modifier": "abc", - "Creator": "abc", - "RepoType": 0, - "InstanceId": "abc", - "RepoName": "abc", - "CodingLanguage": "abc", - "DeployMode": "abc", - "EnvironmentName": "abc", - "ActiveVersions": [ - { - "VersionName": "abc", - "Status": "abc", - "EnableEs": 0, - "CurrentInstances": 0, - "VersionId": "abc", - "LogOutputConf": { - "OutputType": "abc", - "ClsLogsetName": "abc", - "ClsLogTopicId": "abc", - "ClsLogsetId": "abc", - "ClsLogTopicName": "abc" - }, - "ExpectedInstances": 0, - "DeployMode": "abc", - "BuildTaskId": "abc", - "EnvironmentId": "abc", - "EnvironmentName": "abc", - "ApplicationId": "abc", - "ApplicationName": "abc", - "UnderDeploying": true, - "BatchDeployStatus": "abc", - "Zones": [ - "abc" - ], - "NodeInfos": [ - { - "Name": "abc", - "Zone": "abc", - "SubnetId": "abc", - "AvailableIpCount": "abc", - "Cidr": "abc" - } - ], - "PodList": { - "Offset": 0, - "Limit": 0, - "TotalCount": 0, - "RequestId": "abc", - "PodList": [ - { - "Webshell": "abc", - "PodId": "abc", - "Status": "abc", - "CreateTime": "abc", - "PodIp": "abc", - "Zone": "abc", - "DeployVersion": "abc", - "RestartCount": 0, - "Ready": true, - "ContainerState": "abc", - "NodeInfo": { - "Name": "abc", - "Zone": "abc", - "SubnetId": "abc", - "AvailableIpCount": "abc", - "Cidr": "abc" - }, - "StartTime": "abc", - "Unhealthy": true, - "UnhealthyWarningMsg": "abc", - "VersionId": "abc", - "ApplicationName": "abc" - } - ] - }, - "WorkloadInfo": { - "ClusterId": "abc", - "ApplicationName": "abc", - "VersionName": "abc", - "ReadyReplicas": 0, - "Replicas": 0, - "UpdatedReplicas": 0, - "UpdatedReadyReplicas": 0, - "UpdateRevision": "abc", - "CurrentRevision": "abc" - }, - "CreateDate": "abc", - "RegionId": "abc" - } - ], - "EnableTracing": 1, - "Tags": [ - { - "TagKey": "abc", - "TagValue": "abc" - } - ], - "HasAuthority": true - } - ], + "Name": "config-test", + "CreateTime": "2024-12-19 23:55:05", + "RelatedApplications": [], "Data": [ { - "Key": "abc", - "Value": "abc", - "Type": "abc", - "Config": "abc", - "Secret": "abc" + "Key": "key-xxx", + "Value": "val-xxx", + "Type": "", + "Config": "", + "Secret": "" } ] - }, - "RequestId": "abc" + } } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeConfigDataList.md b/tccli/examples/tem/v20210701/DescribeConfigDataList.md index 6f3f56a801..f0615fb94c 100644 --- a/tccli/examples/tem/v20210701/DescribeConfigDataList.md +++ b/tccli/examples/tem/v20210701/DescribeConfigDataList.md @@ -16,134 +16,41 @@ Output: ``` { "Response": { + "RequestId": "8b94500c-06cf-42cf-a228-dfea478c3239", "Result": { "Records": [ { - "Name": "abc", - "CreateTime": "abc", - "RelatedApplications": [ + "Name": "config-test", + "CreateTime": "2024-12-19 23:55:05", + "RelatedApplications": [], + "Data": [ { - "ApplicationId": "abc", - "ApplicationName": "abc", - "Description": "abc", - "EnvironmentId": "abc", - "CreateDate": "2020-09-22 00:00:00", - "ModifyDate": "2020-09-22 00:00:00", - "Modifier": "abc", - "Creator": "abc", - "RepoType": 0, - "InstanceId": "abc", - "RepoName": "abc", - "CodingLanguage": "abc", - "DeployMode": "abc", - "EnvironmentName": "abc", - "ActiveVersions": [ - { - "VersionName": "abc", - "Status": "abc", - "EnableEs": 0, - "CurrentInstances": 0, - "VersionId": "abc", - "LogOutputConf": { - "OutputType": "abc", - "ClsLogsetName": "abc", - "ClsLogTopicId": "abc", - "ClsLogsetId": "abc", - "ClsLogTopicName": "abc" - }, - "ExpectedInstances": 0, - "DeployMode": "abc", - "BuildTaskId": "abc", - "EnvironmentId": "abc", - "EnvironmentName": "abc", - "ApplicationId": "abc", - "ApplicationName": "abc", - "UnderDeploying": true, - "BatchDeployStatus": "abc", - "Zones": [ - "abc" - ], - "NodeInfos": [ - { - "Name": "abc", - "Zone": "abc", - "SubnetId": "abc", - "AvailableIpCount": "abc", - "Cidr": "abc" - } - ], - "PodList": { - "Offset": 0, - "Limit": 0, - "TotalCount": 0, - "RequestId": "abc", - "PodList": [ - { - "Webshell": "abc", - "PodId": "abc", - "Status": "abc", - "CreateTime": "abc", - "PodIp": "abc", - "Zone": "abc", - "DeployVersion": "abc", - "RestartCount": 0, - "Ready": true, - "ContainerState": "abc", - "NodeInfo": { - "Name": "abc", - "Zone": "abc", - "SubnetId": "abc", - "AvailableIpCount": "abc", - "Cidr": "abc" - }, - "StartTime": "abc", - "Unhealthy": true, - "UnhealthyWarningMsg": "abc", - "VersionId": "abc", - "ApplicationName": "abc" - } - ] - }, - "WorkloadInfo": { - "ClusterId": "abc", - "ApplicationName": "abc", - "VersionName": "abc", - "ReadyReplicas": 0, - "Replicas": 0, - "UpdatedReplicas": 0, - "UpdatedReadyReplicas": 0, - "UpdateRevision": "abc", - "CurrentRevision": "abc" - }, - "CreateDate": "abc", - "RegionId": "abc" - } - ], - "EnableTracing": 1, - "Tags": [ - { - "TagKey": "abc", - "TagValue": "abc" - } - ], - "HasAuthority": true + "Key": "key-xxx", + "Value": "val-xxx", + "Type": "", + "Config": "", + "Secret": "" } - ], + ] + }, + { + "Name": "pk-test", + "CreateTime": "2024-12-19 11:04:13", + "RelatedApplications": [], "Data": [ { - "Key": "abc", - "Value": "abc", - "Type": "abc", - "Config": "abc", - "Secret": "abc" + "Key": "name", + "Value": "pk", + "Type": "", + "Config": "", + "Secret": "" } ] } ], - "ContinueToken": "abc", - "RemainingCount": 0 - }, - "RequestId": "abc" + "RemainingCount": null, + "ContinueToken": "" + } } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeDeployApplicationDetail.md b/tccli/examples/tem/v20210701/DescribeDeployApplicationDetail.md index 15b07597a6..a3ecbda6af 100644 --- a/tccli/examples/tem/v20210701/DescribeDeployApplicationDetail.md +++ b/tccli/examples/tem/v20210701/DescribeDeployApplicationDetail.md @@ -15,108 +15,95 @@ Output: ``` { "Response": { + "RequestId": "7559e31e-4e32-476d-93f2-db6bcbab530a", "Result": { "DeployStrategyConf": { - "TotalBatchCount": 0, + "TotalBatchCount": 1, "BetaBatchNum": 0, - "DeployStrategyType": 0, + "DeployStrategyType": 3, "BatchInterval": 0, - "MinAvailable": 0, + "MinAvailable": 1, "Force": true }, - "StartTime": "abc", - "EndTime": "abc", - "Status": "abc", - "BetaBatchDetail": { - "OldPodList": { - "PodId": "abc", - "PodStatus": [ - "abc" - ], - "PodVersion": "abc", - "CreateTime": "abc", - "Zone": "abc", - "Webshell": "abc", - "Status": "abc" - }, - "NewPodList": { - "PodId": "abc", - "PodStatus": [ - "abc" - ], - "PodVersion": "abc", - "CreateTime": "abc", - "Zone": "abc", - "Webshell": "abc", - "Status": "abc" - }, - "BatchStatus": "abc", - "PodNum": 0, - "BatchIndex": 0, - "OldPods": [ - { - "PodId": "abc", - "PodStatus": [ - "abc" - ], - "PodVersion": "abc", - "CreateTime": "abc", - "Zone": "abc", - "Webshell": "abc", - "Status": "abc" - } - ], - "NextBatchStartTime": 0 - }, + "StartTime": "2024-12-20 17:00:17", + "EndTime": "", + "Status": "Error", + "CurrentBatchStatus": "Finish", + "ErrorMessage": "", + "BetaBatchDetail": null, "OtherBatchDetail": [ { - "BatchStatus": "abc", - "PodNum": 0, + "OldPods": [], + "NewPods": [ + { + "PodId": "app0925-4sbct", + "PodVersion": "", + "CreateTime": "2024-12-20 17:00:23", + "Zone": "ap-shanghai-2", + "Webshell": "https://tkecache.cloud.tencent.com/xxx", + "Status": "CrashLoopBackOff", + "PodStatus": [ + "CrashLoopBackOff" + ] + }, + { + "PodId": "app0925-s4vpj", + "PodVersion": "", + "CreateTime": "2024-12-20 17:00:23", + "Zone": "ap-shanghai-2", + "Webshell": "https://tkecache.cloud.tencent.com/xxx", + "Status": "CrashLoopBackOff", + "PodStatus": [ + "CrashLoopBackOff" + ] + } + ], + "BatchStatus": "Finish", + "PodNum": 3, "BatchIndex": 0, - "NextBatchStartTime": 0 + "NextBatchStartTime": 0, + "OldPodList": null, + "NewPodList": null } ], "OldVersionPodList": { "Offset": 0, - "Limit": 0, - "TotalCount": 0, - "RequestId": "abc", + "Limit": 1, + "TotalCount": 1, "PodList": [ { - "Webshell": "abc", - "PodId": "abc", - "Status": "abc", - "CreateTime": "abc", - "PodIp": "abc", - "Zone": "abc", - "DeployVersion": "abc", - "RestartCount": 0, - "Ready": true, - "ContainerState": "abc", + "Zone": "ap-shanghai-2", "NodeInfo": { - "Name": "abc", - "Zone": "abc", - "SubnetId": "abc", - "AvailableIpCount": "abc", - "Cidr": "abc" + "Name": "eklet-subnet-8indzsuv-457482", + "Zone": "ap-shanghai-2", + "SubnetId": "subnet-8indzsuv", + "AvailableIpCount": "226", + "Cidr": "10.0.30.0-24" }, - "StartTime": "abc", - "Unhealthy": true, - "UnhealthyWarningMsg": "abc", - "VersionId": "abc", - "ApplicationName": "abc" + "DeployVersion": "20241202165113", + "RestartCount": 0, + "Ready": true, + "StartTime": "2024-12-19T03:12:44Z", + "ContainerState": "running", + "Unhealthy": null, + "UnhealthyWarningMsg": "", + "VersionId": "revision-57moqvm5", + "ApplicationName": "app0925", + "Status": "Running", + "CreateTime": "2024-12-19 11:11:32", + "Webshell": "https://tkecache.cloud.tencent.com/xxx", + "PodId": "app0925-jt5bn", + "PodIp": "10.0.30.158" } - ] + ], + "RequestId": "" }, "CurrentBatchIndex": 0, - "ErrorMessage": "abc", - "CurrentBatchStatus": "abc", - "NewDeployVersion": "abc", - "OldDeployVersion": "abc", - "NewVersionPackageInfo": "abc", - "NextBatchStartTime": 0 - }, - "RequestId": "abc-xxx-xxx" + "NewVersionPackageInfo": "K8sEventDemo-1.0.jar", + "NewDeployVersion": "20241202165113", + "OldDeployVersion": "20241202165113", + "NextBatchStartTime": null + } } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeEnvironment.md b/tccli/examples/tem/v20210701/DescribeEnvironment.md index d1b8a543cc..b1179f37c4 100644 --- a/tccli/examples/tem/v20210701/DescribeEnvironment.md +++ b/tccli/examples/tem/v20210701/DescribeEnvironment.md @@ -14,28 +14,23 @@ Output: ``` { "Response": { + "RequestId": "85435f86-a454-4bf8-8e8c-074a51f55bb2", "Result": { - "EnvironmentId": "en-xxxxxx", - "NamespaceName": "abc", - "Region": "ap-shanghai", - "VpcId": "vpc-xxxxxx", + "EnvironmentId": "en-l5mmxey5", + "EnvironmentName": "bugfix-gz", + "Region": "ap-guangzhou", + "VpcId": "vpc-9xcgo41t", "SubnetIds": [ - "subnet-xxxxxx" + "subnet-orcy48cy" ], - "Description": "abc", - "CreatedDate": "abc", - "EnvironmentName": "abc", - "ApmInstanceId": "abc", + "Description": "这是一个描述", + "CreatedDate": "2024-07-01 17:48:35", + "ApmInstanceId": "", "Locked": 0, - "Tags": [ - { - "TagKey": "abc", - "TagValue": "abc" - } - ], - "EnvType": "abc" - }, - "RequestId": "abc-xxx-xxx" + "NamespaceName": "", + "Tags": [], + "EnvType": "prod" + } } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeEnvironmentStatus.md b/tccli/examples/tem/v20210701/DescribeEnvironmentStatus.md index ca720df23c..ac4ec94547 100644 --- a/tccli/examples/tem/v20210701/DescribeEnvironmentStatus.md +++ b/tccli/examples/tem/v20210701/DescribeEnvironmentStatus.md @@ -17,7 +17,7 @@ Output: "Result": [ { "EnvironmentId": "en-xxxxxx", - "EnvironmentName": "abc", + "EnvironmentName": "en-name-xxx", "ClusterId": "cls-xxxxxx", "ClusterStatus": "running", "EnvironmentStartingStatus": { @@ -32,7 +32,7 @@ Output: } } ], - "RequestId": "abc" + "RequestId": "1se3sd-xxx-xxx-xxx" } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeEnvironments.md b/tccli/examples/tem/v20210701/DescribeEnvironments.md index 606bcb74a2..ddebd43862 100644 --- a/tccli/examples/tem/v20210701/DescribeEnvironments.md +++ b/tccli/examples/tem/v20210701/DescribeEnvironments.md @@ -11,47 +11,42 @@ Output: ``` { "Response": { + "RequestId": "a438e9af-34a0-47d8-bdfc-fc42f652ad6f", "Result": { + "Pages": 1, "Records": [ { "EnvironmentId": "en-xxxxxx", - "Channel": "0", - "EnvironmentName": "abc", - "Region": "ap-shanghai", - "Description": "abc", - "Status": 0, - "Vpc": "vpc-xxxxxx", - "CreateDate": "abc", - "ModifyDate": "abc", - "Modifier": "abc", - "Creator": "abc", + "AppId": "130573xxx", "ApplicationNum": 0, "RunInstancesNum": 0, - "SubnetId": "abc", - "ClusterStatus": "abc", - "EnableTswTraceService": true, + "Uin": "10001905xxx", + "SubAccountUin": "100000799xxx", + "EnvironmentName": "test-cluster", + "Region": "ap-guangzhou", + "RegionId": "1", + "Description": "", + "ClusterId": "cls-qtqz9mxx", + "ClusterStatus": "NORMAL", + "Vpc": "vpc-3le4yaxx", + "SubnetId": "subnet-pm9fq4xx", + "CreateDate": "2024-11-07 16:57:21", + "ModifyDate": "2024-11-07 16:57:21", + "Modifier": "100019051593", + "Creator": "100019051593", "Locked": 0, - "AppId": "abc", - "Uin": "abc", - "SubAccountUin": "abc", - "ClusterId": "abc", - "Tags": [ - { - "TagKey": "abc", - "TagValue": "abc" - } - ], - "HasAuthority": true, - "EnvType": "abc", - "RegionId": "abc" + "Channel": "", + "Status": 1, + "EnableTswTraceService": false, + "Tags": [], + "EnvType": "prod", + "HasAuthority": true } ], - "Total": 0, - "Size": 0, - "Pages": 0, - "Current": 0 - }, - "RequestId": "abc" + "Total": 1, + "Size": 20, + "Current": 1 + } } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeIngress.md b/tccli/examples/tem/v20210701/DescribeIngress.md index 6b96894bf0..710392e33f 100644 --- a/tccli/examples/tem/v20210701/DescribeIngress.md +++ b/tccli/examples/tem/v20210701/DescribeIngress.md @@ -18,23 +18,23 @@ Output: "Response": { "Result": { "EnvironmentId": "en-xxxxxx", - "AddressIPVersion": "abc", - "IngressName": "abc-xxx", + "AddressIPVersion": "IPV4", + "IngressName": "ingress-name-xxx", "Rules": [ { - "Host": "abc", + "Host": "11.xx.xx.xx", "Http": { "Paths": [ { - "Path": "abc", + "Path": "/path", "Backend": { - "ServiceName": "abc", - "ServicePort": 0 + "ServiceName": "svc-name-xxx", + "ServicePort": 8080 } } ] }, - "Protocol": "abc" + "Protocol": "TCP" } ], "ClbId": "lb-xxx", @@ -42,20 +42,20 @@ Output: "Tls": [ { "Hosts": [ - "abc" + "11.xx.xx.xx" ], - "SecretName": "abc", - "CertificateId": "abc" + "SecretName": "secret-name-xxx", + "CertificateId": "certId-xxx" } ], - "ClusterId": "abc", - "Vip": "abc", - "CreateTime": "abc", + "ClusterId": "cls-xxxxxx", + "Vip": "11.xx.xx.xx", + "CreateTime": "2024-12-04 20:46:29", "Mixed": true, - "RewriteType": "abc", - "Domain": "abc" + "RewriteType": "AUTO", + "Domain": "" }, - "RequestId": "abc-xxx-xxx" + "RequestId": "abc-xxx-xxx-xxx" } } ``` diff --git a/tccli/examples/tem/v20210701/DescribeIngresses.md b/tccli/examples/tem/v20210701/DescribeIngresses.md index 2b508fca07..537acbcefb 100644 --- a/tccli/examples/tem/v20210701/DescribeIngresses.md +++ b/tccli/examples/tem/v20210701/DescribeIngresses.md @@ -19,20 +19,20 @@ Output: "RequestId": "81f74023-563c-437d-abf7-8139449ef178", "Result": [ { - "ClusterId": "abc", - "EnvironmentId": "abc", - "IngressName": "abc", + "ClusterId": "cls-xxxxxx", + "EnvironmentId": "en-xxxxxx", + "IngressName": "ingress-name-xxx", "ClusterNamespace": "default", "AddressIPVersion": "IPV4", "ClbId": "clb-xxxx", - "Vip": "abc", + "Vip": "10.xx.xx.xx", "Rules": [ { "Host": "", "Http": { "Paths": [ { - "Path": "/", + "Path": "/path", "Backend": { "ServiceName": "kubernetes", "ServicePort": 443 @@ -47,13 +47,13 @@ Output: "Hosts": [ "xxx.com" ], - "SecretName": "xxx" + "SecretName": "secret-name-xxx" } ], - "CreateTime": "abc", + "CreateTime": "2024-12-04 20:46:29", "Mixed": true, - "RewriteType": "abc", - "Domain": "abc" + "RewriteType": "AUTO", + "Domain": "xxx.xxx.com" } ] } diff --git a/tccli/examples/tem/v20210701/DescribeLogConfig.md b/tccli/examples/tem/v20210701/DescribeLogConfig.md index 1b8faaebda..37ff6c453d 100644 --- a/tccli/examples/tem/v20210701/DescribeLogConfig.md +++ b/tccli/examples/tem/v20210701/DescribeLogConfig.md @@ -7,7 +7,7 @@ Input: ``` tccli tem DescribeLogConfig --cli-unfold-argument \ --EnvironmentId en-xxxxxx \ - --Name abc \ + --Name log-name-xxx \ --ApplicationId app-xxxxxx ``` @@ -15,40 +15,34 @@ Output: ``` { "Response": { + "RequestId": "e6fedfb8-1bc9-414d-b69b-5e24fdda6416", "Result": { - "Name": "abc", - "InputType": "abc", - "LogsetId": "abc", - "TopicId": "abc", - "LogType": "abc", - "BeginningRegex": "abc", - "LogPath": "abc", - "FilePattern": "abc", - "CreateDate": "abc", - "ModifyDate": "abc", - "ApplicationId": "abc", - "ApplicationName": "abc", + "Name": "log-name-xxx", + "ApplicationName": "app-name-xxx", + "ApplicationId": "", + "InputType": "container_stdout", + "TopicId": "3ae33b64-d3d1-4a2c-96ff-a2e044dcexxx", + "LogsetId": "5bf3beeb-1f64-40f9-9672-b596248d7xxx", + "LogType": "minimalist_log", + "BeginningRegex": "", "ExtractRule": { - "BeginningRegex": "abc", - "Keys": [ - "abc" - ], - "FilterKeys": [ - "abc" - ], - "FilterRegex": [ - "abc" - ], - "LogRegex": "abc", - "TimeKey": "abc", - "TimeFormat": "abc", - "UnMatchUpload": "abc", - "UnMatchedKey": "abc", - "Backtracking": "abc", - "Delimiter": "abc" - } - }, - "RequestId": "abc" + "Backtracking": "-1", + "BeginningRegex": "", + "Delimiter": "", + "FilterKeys": [], + "FilterRegex": [], + "Keys": [], + "LogRegex": "", + "TimeFormat": "", + "TimeKey": "", + "UnMatchUpload": "false", + "UnMatchedKey": "" + }, + "LogPath": "", + "FilePattern": "", + "CreateDate": "2022-05-28T18:02:55.000+08:00", + "ModifyDate": "2022-05-28T18:02:56.000+08:00" + } } } ``` diff --git a/tccli/examples/tem/v20210701/DescribePagedLogConfigList.md b/tccli/examples/tem/v20210701/DescribePagedLogConfigList.md index 9f6e4c5bb1..028345cebc 100644 --- a/tccli/examples/tem/v20210701/DescribePagedLogConfigList.md +++ b/tccli/examples/tem/v20210701/DescribePagedLogConfigList.md @@ -8,8 +8,8 @@ Input: tccli tem DescribePagedLogConfigList --cli-unfold-argument \ --EnvironmentId en-xxxxxx \ --ApplicationId app-xxxxxx \ - --ApplicationName abc \ - --Name abc \ + --ApplicationName name-xxx \ + --Name name-xxx \ --Limit 0 \ --ContinueToken some-token-value ``` @@ -44,7 +44,7 @@ Output: "InputType": "container_stdout", "LogPath": "", "LogType": "", - "LogsetId": "7a126551-62d1-4e12-b426-84bd5b2fdbca", + "LogsetId": "7a126551-62d1-4e12-b426-84bd5b2fdxxx", "ModifyDate": "2024-10-31T15:25:08.000+08:00", "Name": "test", "TopicId": "6c69fdb7-5e4c-4e52-8437-32c2c729b85a" diff --git a/tccli/examples/tem/v20210701/DescribeRelatedIngresses.md b/tccli/examples/tem/v20210701/DescribeRelatedIngresses.md index a2afa1e20c..315e3b9012 100644 --- a/tccli/examples/tem/v20210701/DescribeRelatedIngresses.md +++ b/tccli/examples/tem/v20210701/DescribeRelatedIngresses.md @@ -19,13 +19,13 @@ Output: "RequestId": "81f74023-563c-437d-abf7-8139449ef178", "Result": [ { - "ClusterId": "abc", - "IngressName": "abc", + "ClusterId": "cls-xxxxxx", + "IngressName": "ingress-name-xxx", "ClusterNamespace": "default", "EnvironmentId": "en-xxxxxx", "AddressIPVersion": "IPV4", "ClbId": "clb-xxxx", - "Vip": "abc", + "Vip": "10.xx.xx.xx", "Mixed": true, "Rules": [ { @@ -33,9 +33,9 @@ Output: "Http": { "Paths": [ { - "Path": "/", + "Path": "/path", "Backend": { - "ServiceName": "kubernetes", + "ServiceName": "svc-name-xxx", "ServicePort": 443 } } @@ -48,12 +48,12 @@ Output: "Hosts": [ "xxx.com" ], - "SecretName": "xxx" + "SecretName": "secret-name-xxx" } ], - "CreateTime": "abc", - "RewriteType": "abc", - "Domain": "abc" + "CreateTime": "2024-12-04 20:46:29", + "RewriteType": "AUTO", + "Domain": "xxx.xxx.com" } ] } diff --git a/tccli/examples/tem/v20210701/DestroyLogConfig.md b/tccli/examples/tem/v20210701/DestroyLogConfig.md index 439cde2264..890706e9d5 100644 --- a/tccli/examples/tem/v20210701/DestroyLogConfig.md +++ b/tccli/examples/tem/v20210701/DestroyLogConfig.md @@ -7,7 +7,7 @@ Input: ``` tccli tem DestroyLogConfig --cli-unfold-argument \ --EnvironmentId en-xxxxxx \ - --Name abc \ + --Name name-xxx \ --ApplicationId app-xxxxxx ``` diff --git a/tccli/examples/tem/v20210701/ModifyApplicationAutoscaler.md b/tccli/examples/tem/v20210701/ModifyApplicationAutoscaler.md index ea12f13e9f..81f5bfa443 100644 --- a/tccli/examples/tem/v20210701/ModifyApplicationAutoscaler.md +++ b/tccli/examples/tem/v20210701/ModifyApplicationAutoscaler.md @@ -7,30 +7,24 @@ Input: ``` tccli tem ModifyApplicationAutoscaler --cli-unfold-argument \ --ApplicationId app-xxxxxx \ - --SourceChannel 0 \ --EnvironmentId en-xxxxxx \ --AutoscalerId scaler-xxxxxx \ --Autoscaler.MinReplicas 0 \ - --Autoscaler.MaxReplicas 0 \ + --Autoscaler.MaxReplicas 4 \ + --Autoscaler.AutoscalerName pk-test-clb \ + --Autoscaler.Description \ + --Autoscaler.Enabled False \ --Autoscaler.HorizontalAutoscaler.0.MinReplicas 0 \ - --Autoscaler.HorizontalAutoscaler.0.MaxReplicas 0 \ - --Autoscaler.HorizontalAutoscaler.0.Metrics abc \ - --Autoscaler.HorizontalAutoscaler.0.Threshold 0 \ + --Autoscaler.HorizontalAutoscaler.0.MaxReplicas 4 \ + --Autoscaler.HorizontalAutoscaler.0.Metrics CPU \ + --Autoscaler.HorizontalAutoscaler.0.DoubleThreshold 50 \ --Autoscaler.HorizontalAutoscaler.0.Enabled True \ - --Autoscaler.HorizontalAutoscaler.0.DoubleThreshold 0 \ - --Autoscaler.CronHorizontalAutoscaler.0.Name abc \ - --Autoscaler.CronHorizontalAutoscaler.0.Period abc \ - --Autoscaler.CronHorizontalAutoscaler.0.Schedules.0.StartAt abc \ - --Autoscaler.CronHorizontalAutoscaler.0.Schedules.0.TargetReplicas 0 \ - --Autoscaler.CronHorizontalAutoscaler.0.Enabled True \ - --Autoscaler.CronHorizontalAutoscaler.0.Priority 0 \ - --Autoscaler.AutoscalerId abc \ - --Autoscaler.AutoscalerName abc \ - --Autoscaler.Description abc \ - --Autoscaler.CreateDate abc \ - --Autoscaler.ModifyDate abc \ - --Autoscaler.EnableDate abc \ - --Autoscaler.Enabled True + --Autoscaler.CronHorizontalAutoscaler.0.Name pk-test \ + --Autoscaler.CronHorizontalAutoscaler.0.Period * * * \ + --Autoscaler.CronHorizontalAutoscaler.0.Schedules.0.StartAt 02:00 \ + --Autoscaler.CronHorizontalAutoscaler.0.Schedules.0.TargetReplicas 1 \ + --Autoscaler.CronHorizontalAutoscaler.0.Enabled False \ + --Autoscaler.CronHorizontalAutoscaler.0.Priority 0 ``` Output: @@ -38,7 +32,7 @@ Output: { "Response": { "Result": true, - "RequestId": "abc" + "RequestId": "abbd6b63-xxx-xxx-xxx" } } ``` diff --git a/tccli/examples/tem/v20210701/ModifyApplicationInfo.md b/tccli/examples/tem/v20210701/ModifyApplicationInfo.md index b6d8bfcca7..0fcab1ed35 100644 --- a/tccli/examples/tem/v20210701/ModifyApplicationInfo.md +++ b/tccli/examples/tem/v20210701/ModifyApplicationInfo.md @@ -8,7 +8,7 @@ Input: tccli tem ModifyApplicationInfo --cli-unfold-argument \ --SourceChannel 0 \ --ApplicationId app-xxxxxx \ - --Description test \ + --Description 这是一个描述 \ --EnableTracing 1 ``` @@ -17,7 +17,7 @@ Output: { "Response": { "Result": true, - "RequestId": "true" + "RequestId": "1dew34d-xxx-xxx-xxx" } } ``` diff --git a/tccli/examples/tem/v20210701/ModifyApplicationService.md b/tccli/examples/tem/v20210701/ModifyApplicationService.md index 4f82818bf4..d32d7e0cd2 100644 --- a/tccli/examples/tem/v20210701/ModifyApplicationService.md +++ b/tccli/examples/tem/v20210701/ModifyApplicationService.md @@ -9,51 +9,51 @@ tccli tem ModifyApplicationService --cli-unfold-argument \ --ApplicationId app-xxxxxx \ --SourceChannel 0 \ --EnvironmentId en-xxxxxx \ - --Service.Name abc \ - --Service.Ports 0 \ - --Service.Yaml abc \ - --Service.ApplicationName abc \ - --Service.VersionName abc \ - --Service.ClusterIp abc \ - --Service.ExternalIp abc \ - --Service.Type abc \ - --Service.SubnetId abc \ - --Service.LoadBalanceId abc \ - --Service.PortMappings.0.Port 0 \ - --Service.PortMappings.0.TargetPort 0 \ - --Service.PortMappings.0.Protocol abc \ - --Service.PortMappings.0.ServiceName abc \ - --Service.ServicePortMappingList.0.Type abc \ - --Service.ServicePortMappingList.0.ServiceName abc \ - --Service.ServicePortMappingList.0.ClusterIp abc \ - --Service.ServicePortMappingList.0.ExternalIp abc \ - --Service.ServicePortMappingList.0.SubnetId abc \ - --Service.ServicePortMappingList.0.VpcId abc \ - --Service.ServicePortMappingList.0.LoadBalanceId abc \ - --Service.ServicePortMappingList.0.Yaml abc \ - --Service.ServicePortMappingList.0.Ports 0 \ - --Service.ServicePortMappingList.0.PortMappingItemList.0.Port 0 \ - --Service.ServicePortMappingList.0.PortMappingItemList.0.TargetPort 0 \ - --Service.ServicePortMappingList.0.PortMappingItemList.0.Protocol abc \ - --Service.ServicePortMappingList.0.ExternalDomain abc \ + --Service.Name svc-name-xxx \ + --Service.Ports 8080 \ + --Service.Yaml apiVersion: xxx \ + --Service.ApplicationName app-name-xxx \ + --Service.VersionName ver-name-xxx \ + --Service.ClusterIp 11.xx.xx.xx \ + --Service.ExternalIp 10.xx.xx.xx \ + --Service.Type CLUSTER \ + --Service.SubnetId subnet-xxx \ + --Service.LoadBalanceId lb-xxxxxx \ + --Service.PortMappings.0.Port 8080 \ + --Service.PortMappings.0.TargetPort 8080 \ + --Service.PortMappings.0.Protocol TCP \ + --Service.PortMappings.0.ServiceName svc-name-xxx \ + --Service.ServicePortMappingList.0.Type CLUSTER \ + --Service.ServicePortMappingList.0.ServiceName svc-name-xxx \ + --Service.ServicePortMappingList.0.ClusterIp 11.xx.xx.xx \ + --Service.ServicePortMappingList.0.ExternalIp 10.xx.xx.xx \ + --Service.ServicePortMappingList.0.SubnetId subnet-xxxxxx \ + --Service.ServicePortMappingList.0.VpcId vpc-xxxxxx \ + --Service.ServicePortMappingList.0.LoadBalanceId lb-xxxxxx \ + --Service.ServicePortMappingList.0.Yaml apiVersion: xxx \ + --Service.ServicePortMappingList.0.Ports 8080 \ + --Service.ServicePortMappingList.0.PortMappingItemList.0.Port 8080 \ + --Service.ServicePortMappingList.0.PortMappingItemList.0.TargetPort 8080 \ + --Service.ServicePortMappingList.0.PortMappingItemList.0.Protocol TCP \ + --Service.ServicePortMappingList.0.ExternalDomain ext.com.xxx \ --Service.FlushAll True \ --Service.EnableRegistryNextDeploy 0 \ - --Service.ApplicationId abc \ + --Service.ApplicationId app-xxxxxx \ --Service.AllIpDone True \ - --Service.ExternalDomain abc \ - --Data.Type abc \ - --Data.ServiceName abc \ - --Data.ClusterIp abc \ - --Data.ExternalIp abc \ - --Data.SubnetId abc \ - --Data.VpcId abc \ - --Data.LoadBalanceId abc \ - --Data.Yaml abc \ - --Data.Ports 0 \ - --Data.PortMappingItemList.0.Port 0 \ - --Data.PortMappingItemList.0.TargetPort 0 \ - --Data.PortMappingItemList.0.Protocol abc \ - --Data.ExternalDomain abc + --Service.ExternalDomain ext.com.xxx \ + --Data.Type CLUSTER \ + --Data.ServiceName svc-name-xxx \ + --Data.ClusterIp 11.xx.xx.xx \ + --Data.ExternalIp 10.xx.xx.xx \ + --Data.SubnetId subnet-xxxxxx \ + --Data.VpcId vpc-xxxxxx \ + --Data.LoadBalanceId lb-xxxxxx \ + --Data.Yaml apiVersion: xxx \ + --Data.Ports 8080 \ + --Data.PortMappingItemList.0.Port 8080 \ + --Data.PortMappingItemList.0.TargetPort 8080 \ + --Data.PortMappingItemList.0.Protocol TCP \ + --Data.ExternalDomain ext.com.xxx ``` Output: @@ -61,7 +61,7 @@ Output: { "Response": { "Result": true, - "RequestId": "xxx" + "RequestId": "asdc122-xxx-xxx-xxx" } } ``` diff --git a/tccli/examples/tem/v20210701/ModifyConfigData.md b/tccli/examples/tem/v20210701/ModifyConfigData.md index a0a828bb86..05771f3cca 100644 --- a/tccli/examples/tem/v20210701/ModifyConfigData.md +++ b/tccli/examples/tem/v20210701/ModifyConfigData.md @@ -7,13 +7,13 @@ Input: ``` tccli tem ModifyConfigData --cli-unfold-argument \ --EnvironmentId en-xxxxxx \ - --Name abc \ + --Name config-test \ --SourceChannel 0 \ - --Data.0.Key abc \ - --Data.0.Value abc \ - --Data.0.Type abc \ - --Data.0.Config abc \ - --Data.0.Secret abc + --Data.0.Key key-xxx \ + --Data.0.Value val-xxx \ + --Data.0.Type \ + --Data.0.Config \ + --Data.0.Secret ``` Output: diff --git a/tccli/examples/tem/v20210701/ModifyEnvironment.md b/tccli/examples/tem/v20210701/ModifyEnvironment.md index d24da49b58..473cb2e763 100644 --- a/tccli/examples/tem/v20210701/ModifyEnvironment.md +++ b/tccli/examples/tem/v20210701/ModifyEnvironment.md @@ -7,7 +7,7 @@ Input: ``` tccli tem ModifyEnvironment --cli-unfold-argument \ --EnvironmentName name-xxx \ - --Description 描述 \ + --Description 这是一个描述 \ --EnvironmentId en-xxxxxx \ --SubnetIds subnet-xxxxxx \ --SourceChannel 0 \ diff --git a/tccli/examples/tem/v20210701/ModifyLogConfig.md b/tccli/examples/tem/v20210701/ModifyLogConfig.md index 532234eaf9..169e655a85 100644 --- a/tccli/examples/tem/v20210701/ModifyLogConfig.md +++ b/tccli/examples/tem/v20210701/ModifyLogConfig.md @@ -7,7 +7,7 @@ Input: ``` tccli tem ModifyLogConfig --cli-unfold-argument \ --EnvironmentId en-xxxxxx \ - --Name abc \ + --Name name-xxx \ --Data.LogsetId 7a126551-62d1-4e12-b426-84bd5b2fdbca \ --Data.TopicId 6c69fdb7-5e4c-4e52-8437-32c2c729b85a \ --Data.InputType container_stdout \ diff --git a/tccli/examples/tem/v20210701/RollingUpdateApplicationByVersion.md b/tccli/examples/tem/v20210701/RollingUpdateApplicationByVersion.md index 5479f6e114..81f08107d3 100644 --- a/tccli/examples/tem/v20210701/RollingUpdateApplicationByVersion.md +++ b/tccli/examples/tem/v20210701/RollingUpdateApplicationByVersion.md @@ -10,7 +10,7 @@ tccli tem RollingUpdateApplicationByVersion --cli-unfold-argument \ --EnvironmentId en-xxxxxx \ --DeployVersion v1 \ --PackageName test.jar \ - --From test \ + --From IntelliJ \ --DeployStrategyType 0 \ --TotalBatchCount 0 \ --BatchInterval 0 \ diff --git a/tccli/examples/tke/v20180525/CreateBackupStorageLocation.md b/tccli/examples/tke/v20180525/CreateBackupStorageLocation.md index c8c92452b6..c724d4226b 100644 --- a/tccli/examples/tke/v20180525/CreateBackupStorageLocation.md +++ b/tccli/examples/tke/v20180525/CreateBackupStorageLocation.md @@ -7,17 +7,17 @@ Input: ``` tccli tke CreateBackupStorageLocation --cli-unfold-argument \ --StorageRegion ap-guangzhou \ + --Bucket tke-backup-test \ + --Name tke-storage-backup \ --Provider tencentcloud \ - --Bucket tke-backup-xxx \ - --Path \ - --Name test-registry-1 + --Path tke ``` Output: ``` { "Response": { - "RequestId": "4bef4bc7-edf2-4de6-a2e1-684bfc37185f" + "RequestId": "6b4cf747-ecfb-42ae-a1fb-a0132353c80b" } } ``` diff --git a/tccli/examples/tke/v20180525/DeleteAddon.md b/tccli/examples/tke/v20180525/DeleteAddon.md index 7d9b5b2af9..685d6da0a6 100644 --- a/tccli/examples/tke/v20180525/DeleteAddon.md +++ b/tccli/examples/tke/v20180525/DeleteAddon.md @@ -6,15 +6,15 @@ Input: ``` tccli tke DeleteAddon --cli-unfold-argument \ - --ClusterId cls-123deabc \ - --AddonName cbs + --ClusterId cls-kihzth22 \ + --AddonName nvidia-gpu ``` Output: ``` { "Response": { - "RequestId": "abc" + "RequestId": "0edfedeb-47cd-41b1-bab9-79dcc88d4e66" } } ``` diff --git a/tccli/examples/tke/v20180525/DeleteBackupStorageLocation.md b/tccli/examples/tke/v20180525/DeleteBackupStorageLocation.md index 4183552e46..be24c5e256 100644 --- a/tccli/examples/tke/v20180525/DeleteBackupStorageLocation.md +++ b/tccli/examples/tke/v20180525/DeleteBackupStorageLocation.md @@ -6,14 +6,14 @@ Input: ``` tccli tke DeleteBackupStorageLocation --cli-unfold-argument \ - --Name abc + --Name tke-storage-backup ``` Output: ``` { "Response": { - "RequestId": "0878bad3-d0aa-4886-beac-7f4d450d55fa" + "RequestId": "ebc80be1-c6a7-4c1f-870e-74eba8471969" } } ``` diff --git a/tccli/examples/tke/v20180525/DescribeAddon.md b/tccli/examples/tke/v20180525/DescribeAddon.md index ebf73411b4..be2f699170 100644 --- a/tccli/examples/tke/v20180525/DescribeAddon.md +++ b/tccli/examples/tke/v20180525/DescribeAddon.md @@ -6,7 +6,7 @@ Input: ``` tccli tke DescribeAddon --cli-unfold-argument \ - --ClusterId cls-123deabc \ + --ClusterId cls-kihzth22 \ --AddonName cbs ``` @@ -17,11 +17,14 @@ Output: "Addons": [ { "AddonName": "cbs", - "AddonVersion": "1.1.0", - "RawValues": "" + "AddonVersion": "1.1.7", + "CreateTime": "2024-12-23T13:06:44Z", + "Phase": "Succeeded", + "RawValues": "e30=", + "Reason": "" } ], - "RequestId": "abc" + "RequestId": "7eb2cf94-6cc3-40d0-8843-3ac1314e61e5" } } ``` diff --git a/tccli/examples/tke/v20180525/DescribeAddonValues.md b/tccli/examples/tke/v20180525/DescribeAddonValues.md index e2e7285853..ecd4e59157 100644 --- a/tccli/examples/tke/v20180525/DescribeAddonValues.md +++ b/tccli/examples/tke/v20180525/DescribeAddonValues.md @@ -6,17 +6,17 @@ Input: ``` tccli tke DescribeAddonValues --cli-unfold-argument \ - --ClusterId cls-123deabc \ - --AddonName eniipamd + --ClusterId cls-kihzth22 \ + --AddonName nvidia-gpu ``` Output: ``` { "Response": { - "Values": "", - "DefaultValues": "", - "RequestId": "eac6b301-a322-493a-8e36-83b295459397" + "DefaultValues": "{\"config\":{\"disablehealthchecks\":\"\",\"waituvm\":false},\"exporter\":{\"tag\":\"v1.0.18\"},\"global\":{\"cluster\":{\"appid\":1255429800,\"clustertype\":\"MANAGED_CLUSTER\",\"id\":\"cls-kihzth22\",\"kubeminor\":\"30.0\",\"kubeversion\":\"1.30.0-tke.2\",\"longregion\":\"ap-guangzhou\",\"region\":\"gz\",\"subuin\":100040133055,\"type\":\"tke\",\"uin\":100002743387},\"image\":{\"host\":\"ccr.ccs.tencentyun.com\"}},\"plugin\":{\"tag\":\"v0.14.3\"},\"pluginInit\":{\"tag\":\"v1.0\"}}", + "RequestId": "4fb715e9-8233-4f82-9730-afe743ea89a7", + "Values": "{\"config\":{\"disablehealthchecks\":\"\",\"waituvm\":false},\"exporter\":{\"tag\":\"v1.0.18\"},\"global\":{\"cluster\":{\"appid\":1255429800,\"clustertype\":\"MANAGED_CLUSTER\",\"id\":\"cls-kihzth22\",\"kubeminor\":\"30.0\",\"kubeversion\":\"1.30.0-tke.2\",\"longregion\":\"ap-guangzhou\",\"region\":\"gz\",\"subuin\":100040133055,\"type\":\"tke\",\"uin\":100002743387},\"image\":{\"host\":\"ccr.ccs.tencentyun.com\"}},\"plugin\":{\"tag\":\"v0.14.3\"},\"pluginInit\":{\"tag\":\"v1.0\"}}" } } ``` diff --git a/tccli/examples/tke/v20180525/GetTkeAppChartList.md b/tccli/examples/tke/v20180525/GetTkeAppChartList.md index cc28a7d41c..2850a8027c 100644 --- a/tccli/examples/tke/v20180525/GetTkeAppChartList.md +++ b/tccli/examples/tke/v20180525/GetTkeAppChartList.md @@ -1,18 +1,27 @@ -**Example 1: 获取TKE支持的AppChart列表** +**Example 1: 获取EKS支持的网络 AppChart列表** -获取TKE支持的AppChart列表 +获取EKS支持的网络 AppChart列表 Input: ``` -tccli tke GetTkeAppChartList --cli-unfold-argument ``` +tccli tke GetTkeAppChartList --cli-unfold-argument \ + --Kind network \ + --ClusterType eks +``` Output: ``` { "Response": { - "RequestId": "bbe22a77-0366-442d-97ef-b7bc59fa0520", - "AppCharts": [] + "AppCharts": [ + { + "Label": "{\"amd64\":\"true\",\"eks\":\"true\",\"kind\":\"network\",\"network\":\"true\",\"tke\":\"true\"}", + "LatestVersion": "1.5.1", + "Name": "ingressnginx" + } + ], + "RequestId": "566fdd07-fa79-4dc1-8d22-78907dedd607" } } ``` diff --git a/tccli/examples/tke/v20180525/InstallAddon.md b/tccli/examples/tke/v20180525/InstallAddon.md index a0955266cc..b081c406b9 100644 --- a/tccli/examples/tke/v20180525/InstallAddon.md +++ b/tccli/examples/tke/v20180525/InstallAddon.md @@ -1,20 +1,179 @@ -**Example 1: 安装addon** +**Example 1: 安装cbs组件** -为目标集群安装一个addon +用户安装cbs组件时支持通过RawValues配置自定义参数,比如设置容忍调度,可以将 {"tolerations":[{"effect":"NoExecute","key":"gpu-not-ready","operator":"Equal","tolerationSeconds":300,"value":"true"},{"key":"ip-not-ready","operator":"Exists"}]} 进行base64编码后放入到 RawValues 参数中。cbs组件支持的自定义配置参数说明如下: +``` +{ + "tolerations": [ + { + "effect": "string, 效果,例如:NoExecute", + "key": "string,标签值,例如:gpu-not-ready", + "operator": "string,操作符,例如:Equal", + "tolerationSeconds": "int,容忍时间(秒),例如:300", + "value": "string,标签值,例如:true" + }, + { + "key": "string,标签值,例如:ip-not-ready", + "operator": "string,操作符,例如:Exists" + } + ] +} +``` + +Input: + +``` +tccli tke InstallAddon --cli-unfold-argument \ + --ClusterId cls-12345678 \ + --AddonName cbs \ + --RawValues eyJ0b2xlcmF0aW9ucyI6W3siZWZmZWN0IjoiTm9FeGVjdXRlIiwia2V5IjoiZ3B1LW5vdC1yZWFkeSIsIm9wZXJhdG9yIjoiRXF1YWwiLCJ0b2xlcmF0aW9uU2Vjb25kcyI6MzAwLCJ2YWx1ZSI6InRydWUifSx7ImtleSI6ImlwLW5vdC1yZWFkeSIsIm9wZXJhdG9yIjoiRXhpc3RzIn1dfQ== +``` + +Output: +``` +{ + "Response": { + "RequestId": "b583f05e-d4f4-4963-8082-b651605hg432" + } +} +``` + +**Example 2: 安装eniipamd组件** + +用户安装eniipamd组件时支持通过RawValues配置自定义参数,比如添加安全组,可以将 {"vpcCni":{"securityGroups":{"securityGroups":["sg-12345678"]}}} 进行base64编码后放入到 RawValues 参数中。eniipamd组件支持的自定义配置参数说明如下: +``` +{ + "clusterId": "string, 集群ID, 例如:cls-12345678", + "vpcCni": { + "vpcId": "string, VPC的ID, 例如:vpc-12345678", + "enableVpcCni": "bool, 是否启用VPC CNI, 例如:true", + "routeEni": { + "ipMinWarmTarget": "int, 新增节点共享网卡辅助IP的最小预绑定值, 例如:5", + "ipMaxWarmTarget": "int, 新增节点共享网卡辅助IP的最大预绑定值, 例如:5" + }, + "ipam": { + "subnetIds": "array, 用于IP地址分配的Pod子网ID列表, 例如:[\"subnet-12345678\"]" + }, + "securityGroups": { + "enableSecurityGroups": "bool, 是否启用安全组, 例如:true", + "securityGroups": [ + "string, 安全组ID, 例如:sg-12345678" + ] + } + }, + "agent": { + "kubeClient": { + "masterAddr": "string, kubeClient主节点地址, 例如: 169.254.128.54:60002" + } + } +} +``` + +Input: + +``` +tccli tke InstallAddon --cli-unfold-argument \ + --ClusterId cls-12345678 \ + --AddonName eniipamd \ + --RawValues eyJ2cGNDbmkiOnsic2VjdXJpdHlHcm91cHMiOnsic2VjdXJpdHlHcm91cHMiOlsic2ctMTIzNDU2NzgiXX19fQ== +``` + +Output: +``` +{ + "Response": { + "RequestId": "b583f05e-d4f4-4963-8082-b651605jh275" + } +} +``` + +**Example 3: 安装tke-log-agent组件** + +用户安装tke-log-agent组件时支持通过RawValues配置自定义参数,比如设置启用kafkalistener,可以将 {"kafkalistener":{"enabled":true}} 进行base64编码后放入到 RawValues 参数中。tke-log-agent 组件支持的自定义配置参数说明如下: +``` +{ + "global": { + "clsHost": "string, cls服务域名,例如:ap-chengdu.cls.tencentyun.com", + "cluster": { + "clustertype": "string,集群管理类型,例如:MANAGED_CLUSTER 或 INDEPENDENT_CLUSTER", + "kubeminor": "string,集群版本,例如:minor 30.0", + "kubeversion": "string,集群k8s版本,例如:1.30.0", + "type": "string,集群类型,例如:tke 或 eks" + }, + "clusterID": "string,集群ID,例如:cls-12345678", + "hostNetwork": "bool,是否使用hostNetwork,例如:false", + "localRegion": "string,集群所在地域,例如:ap-chengdu", + "registry": "string,镜像仓库,例如:ccr.ccs.tencentyun.com", + "sources": "string,鉴权方式,例如:norm" + }, + "kafkalistener": { + "enabled": "bool,是否启用kafkalistener,例如:true", + }, + "logAgent": { + "enabled": "bool,是否启用logAgent,例如:true", + }, + "loglistener": { + "enabled": "bool,是否启用loglistener", + }, + "provisioner": { + "replicaCount": "int,cls-provisioner副本数,例如:2", + "sources": "string,cls-provisioner鉴权方式,例如:norm" + } +} +``` Input: ``` tccli tke InstallAddon --cli-unfold-argument \ --ClusterId cls-123deabc \ - --AddonName cbs + --AddonName tke-log-agent \ + --RawValues eyJrYWZrYWxpc3RlbmVyIjp7ImVuYWJsZWQiOnRydWV9fQ== +``` + +Output: +``` +{ + "Response": { + "RequestId": "b583f05e-d4f4-4963-8082-b651605ca427" + } +} +``` + +**Example 4: 安装tcr组件** + +用户可以通过 RawValues 参数制定组件需要的配置参数,比如 imagePullSecretsCrs。 tcr 组件支持的配置参数示例如下: +``` +{ + "global": { + "imagePullSecretsCrs": [ + { + "name": "string,imagePullSecretsCr 的名称,例如:tcr-12345678-public", + "namespaces": "string,免密功能作用范围,例如:* 表示所有命名空间", + "serviceAccounts": "string,免密功能作用范围,例如:* 表示所有k8s服务账户", + "type": "string,必须为 docker", + "dockerUsername": "string,镜像仓库登录用户名", + "dockerPassword": "string,镜像仓库登录密码", + "dockerServer": "string,镜像仓库服务器地址" + } + ] + } +} +``` + +Input: + +``` +tccli tke InstallAddon --cli-unfold-argument \ + --ClusterId cls-12345678 \ + --AddonName tcr \ + --RawValues eyJnbG9iYWwiOnsiaW1hZ2VQdWxsU2VjcmV0c0NycyI6W3sibmFtZSI6InRjci1kZzI4NGltcS1wdWJsaWMiLCJuYW1lc3BhY2VzIjoiKiIsInNlcnZpY2VBY2NvdW50cyI6IioiLCJ0eXBlIjoiZG9ja2VyIiwiZG9ja2VyVXNlcm5hbWUiOiIxMDAwMTQzNjQ4MjIiLCJkb2NrZXJQYXNzd29yZCI6IjEyMzQ1Njc4IiwiZG9ja2VyU2VydmVyIjoibmljb2thbmctdGNyLWd6LnRlbmNlbnRjbG91ZGNyLmNvbSJ9XX19 ``` Output: ``` { "Response": { - "RequestId": "abc" + "RequestId": "b583f05e-d4f4-4963-8082-b651605ca765" } } ``` diff --git a/tccli/examples/tke/v20180525/UpdateAddon.md b/tccli/examples/tke/v20180525/UpdateAddon.md index 339541f328..ad344d0a83 100644 --- a/tccli/examples/tke/v20180525/UpdateAddon.md +++ b/tccli/examples/tke/v20180525/UpdateAddon.md @@ -1,14 +1,42 @@ -**Example 1: 更新一个addon** +**Example 1: 更新eniipamd组件参数** -获取一个addon的版本和参数 +用户可以通过RawValues参数更新eniipamd组件支持的自定义配置参数,比如清空已配置的安全组,可以将 {"vpcCni":{"securityGroups":{"securityGroups":[]}}} 进行base64编码后放入到 RawValues 参数中。eniipamd组件支持的自定义配置参数说明如下: +``` +{ + "clusterId": "string, 集群ID, 例如:cls-12345678", + "vpcCni": { + "vpcId": "string, VPC的ID, 例如:vpc-12345678", + "enableVpcCni": "bool, 是否启用VPC CNI, 例如:true", + "routeEni": { + "ipMinWarmTarget": "int, 新增节点共享网卡辅助IP的最小预绑定值, 例如:5", + "ipMaxWarmTarget": "int, 新增节点共享网卡辅助IP的最大预绑定值, 例如:5" + }, + "ipam": { + "subnetIds": "array, 用于IP地址分配的Pod子网ID列表, 例如:[\"subnet-12345678\"]" + }, + "securityGroups": { + "enableSecurityGroups": "bool, 是否启用安全组, 例如:true", + "securityGroups": [ + "string, 安全组ID, 例如:sg-12345678" + ] + } + }, + "agent": { + "kubeClient": { + "masterAddr": "string, kubeClient主节点地址, 例如: 169.254.128.54:60002" + } + } +} +``` Input: ``` tccli tke UpdateAddon --cli-unfold-argument \ - --ClusterId cls-123deabc \ - --AddonName cbs \ - --AddonVersion 1.1.0 + --ClusterId cls-12345678 \ + --AddonName eniipamd \ + --RawValues eyJ2cGNDbmkiOnsic2VjdXJpdHlHcm91cHMiOnsic2VjdXJpdHlHcm91cHMiOltdfX19 \ + --UpdateStrategy merge ``` Output: @@ -20,3 +48,97 @@ Output: } ``` +**Example 2: 更新cbs组件参数** + +用户可以通过RawValues参数更新cbs组件支持的自定义配置参数,比如修改容忍调度设置,可以将 {"tolerations":[{"effect":"NoExecute","key":"gpu-not-ready","operator":"Equal","tolerationSeconds":300,"value":"true"},{"key":"ip-not-ready","operator":"Exists"}]} 进行base64编码后放入到 RawValues 参数中。cbs组件支持的自定义配置参数说明如下: +``` +{ + "tolerations": [ + { + "effect": "string,效果,例如:NoExecute", + "key": "string,标签值,例如:gpu-not-ready", + "operator": "string,操作符,例如:Equal", + "tolerationSeconds": "int,容忍时间(秒),例如:300", + "value": "string,标签值,例如:true" + }, + { + "key": "string,标签值,例如:ip-not-ready", + "operator": "string,操作符,例如:Exists" + } + ] +} +``` + +Input: + +``` +tccli tke UpdateAddon --cli-unfold-argument \ + --ClusterId cls-12345678 \ + --AddonName cbs \ + --RawValues eyJ0b2xlcmF0aW9ucyI6W3siZWZmZWN0IjoiTm9FeGVjdXRlIiwia2V5IjoiZ3B1LW5vdC1yZWFkeSIsIm9wZXJhdG9yIjoiRXF1YWwiLCJ0b2xlcmF0aW9uU2Vjb25kcyI6MzAwLCJ2YWx1ZSI6InRydWUifSx7ImtleSI6ImlwLW5vdC1yZWFkeSIsIm9wZXJhdG9yIjoiRXhpc3RzIn1dfQ== \ + --UpdateStrategy merge +``` + +Output: +``` +{ + "Response": { + "RequestId": "f55aaa93-c681-47c9-860a-59ae16af648" + } +} +``` + +**Example 3: 更新tke-log-agent组件参数** + +用户可以通过RawValues参数更新tke-log-agent组件支持的自定义配置参数,比如设置启用kafkalistener,可以将 {"kafkalistener":{"enabled":true}} 进行base64编码后放入到 RawValues 参数中。tke-log-agent 组件支持的自定义配置参数说明如下: +``` +{ + "global": { + "clsHost": "string, cls服务域名,例如:ap-chengdu.cls.tencentyun.com", + "cluster": { + "clustertype": "string,集群管理类型,例如:MANAGED_CLUSTER 或 INDEPENDENT_CLUSTER", + "kubeminor": "string,集群版本,例如:minor 30.0", + "kubeversion": "string,集群k8s版本,例如:1.30.0", + "type": "string,集群类型,例如:tke 或 eks" + }, + "clusterID": "string,集群ID,例如:cls-12345678", + "hostNetwork": "bool,是否使用hostNetwork,例如:false", + "localRegion": "string,集群所在地域,例如:ap-chengdu", + "registry": "string,镜像仓库,例如:ccr.ccs.tencentyun.com", + "sources": "string,鉴权方式,例如:norm" + }, + "kafkalistener": { + "enabled": "bool,是否启用kafkalistener,例如:true", + }, + "logAgent": { + "enabled": "bool,是否启用logAgent,例如:true", + }, + "loglistener": { + "enabled": "bool,是否启用loglistener", + }, + "provisioner": { + "replicaCount": "int,cls-provisioner副本数,例如:2", + "sources": "string,cls-provisioner鉴权方式,例如:norm" + } +} +``` + +Input: + +``` +tccli tke UpdateAddon --cli-unfold-argument \ + --ClusterId cls-12345678 \ + --AddonName tke-log-agent \ + --RawValues eyJrYWZrYWxpc3RlbmVyIjp7ImVuYWJsZWQiOnRydWV9fQ== \ + --UpdateStrategy merge +``` + +Output: +``` +{ + "Response": { + "RequestId": "f55aaa93-c681-47c9-860a-59ae16ajgf1" + } +} +``` + diff --git a/tccli/examples/trro/v20220325/GetLicenses.md b/tccli/examples/trro/v20220325/GetLicenses.md index efb9f168fa..8432447916 100644 --- a/tccli/examples/trro/v20220325/GetLicenses.md +++ b/tccli/examples/trro/v20220325/GetLicenses.md @@ -39,7 +39,7 @@ Output: } ], "TotalCount": 3, - "RequestId": "xxx" + "RequestId": "33086049-513e-561c-8bce-484e18244613" } } ``` diff --git a/tccli/examples/tse/v20201207/CreateGovernanceInstances.md b/tccli/examples/tse/v20201207/CreateGovernanceInstances.md index 763105bb8f..06e5ac8e53 100644 --- a/tccli/examples/tse/v20201207/CreateGovernanceInstances.md +++ b/tccli/examples/tse/v20201207/CreateGovernanceInstances.md @@ -6,16 +6,16 @@ Input: ``` tccli tse CreateGovernanceInstances --cli-unfold-argument \ - --InstanceId abc \ - --GovernanceInstances.0.Service abc \ - --GovernanceInstances.0.Namespace abc \ + --InstanceId ins-id \ + --GovernanceInstances.0.Service service \ + --GovernanceInstances.0.Namespace namespace \ --GovernanceInstances.0.Weight 1 \ --GovernanceInstances.0.Healthy True \ --GovernanceInstances.0.Isolate True \ - --GovernanceInstances.0.Host abc \ + --GovernanceInstances.0.Host 127.0.0.1 \ --GovernanceInstances.0.Port 1 \ - --GovernanceInstances.0.Protocol abc \ - --GovernanceInstances.0.InstanceVersion abc \ + --GovernanceInstances.0.Protocol tcp \ + --GovernanceInstances.0.InstanceVersion prod \ --GovernanceInstances.0.EnableHealthCheck True \ --GovernanceInstances.0.Ttl 1 ``` @@ -25,7 +25,7 @@ Output: { "Response": { "Result": true, - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/CreateGovernanceNamespaces.md b/tccli/examples/tse/v20201207/CreateGovernanceNamespaces.md index 2c2937da7b..bd3c91bb24 100644 --- a/tccli/examples/tse/v20201207/CreateGovernanceNamespaces.md +++ b/tccli/examples/tse/v20201207/CreateGovernanceNamespaces.md @@ -6,13 +6,14 @@ Input: ``` tccli tse CreateGovernanceNamespaces --cli-unfold-argument \ - --InstanceId abc \ - --GovernanceNamespaces.0.Name abc \ - --GovernanceNamespaces.0.Comment abc \ - --GovernanceNamespaces.0.UserIds abc \ - --GovernanceNamespaces.0.GroupIds abc \ - --GovernanceNamespaces.0.RemoveUserIds abc \ - --GovernanceNamespaces.0.RemoveGroupIds abc + --InstanceId ins-id \ + --GovernanceNamespaces.0.Name name \ + --GovernanceNamespaces.0.Comment comment \ + --GovernanceNamespaces.0.UserIds 101 \ + --GovernanceNamespaces.0.GroupIds groupa \ + --GovernanceNamespaces.0.RemoveUserIds 101 \ + --GovernanceNamespaces.0.RemoveGroupIds groupa \ + --GovernanceNamespaces.0.ServiceExportTo json ``` Output: @@ -20,7 +21,7 @@ Output: { "Response": { "Result": true, - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/CreateGovernanceServices.md b/tccli/examples/tse/v20201207/CreateGovernanceServices.md index c9a046aac6..886d7fd1c8 100644 --- a/tccli/examples/tse/v20201207/CreateGovernanceServices.md +++ b/tccli/examples/tse/v20201207/CreateGovernanceServices.md @@ -6,18 +6,18 @@ Input: ``` tccli tse CreateGovernanceServices --cli-unfold-argument \ - --InstanceId abc \ - --GovernanceServices.0.Name abc \ - --GovernanceServices.0.Namespace abc \ - --GovernanceServices.0.Comment abc \ - --GovernanceServices.0.Metadatas.0.Key abc \ - --GovernanceServices.0.Metadatas.0.Value abc \ - --GovernanceServices.0.Department abc \ - --GovernanceServices.0.Business abc \ - --GovernanceServices.0.UserIds abc \ - --GovernanceServices.0.GroupIds abc \ - --GovernanceServices.0.RemoveUserIds abc \ - --GovernanceServices.0.RemoveGroupIds abc + --InstanceId ins-id \ + --GovernanceServices.0.Name name \ + --GovernanceServices.0.Namespace namespace \ + --GovernanceServices.0.Comment comment \ + --GovernanceServices.0.Metadatas.0.Key key \ + --GovernanceServices.0.Metadatas.0.Value value \ + --GovernanceServices.0.Department dev \ + --GovernanceServices.0.Business web \ + --GovernanceServices.0.UserIds 101 \ + --GovernanceServices.0.GroupIds groupa \ + --GovernanceServices.0.RemoveUserIds 101 \ + --GovernanceServices.0.RemoveGroupIds groupa ``` Output: @@ -25,7 +25,7 @@ Output: { "Response": { "Result": true, - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/DeleteGovernanceAliases.md b/tccli/examples/tse/v20201207/DeleteGovernanceAliases.md index 9f55772648..6909ae3cfc 100644 --- a/tccli/examples/tse/v20201207/DeleteGovernanceAliases.md +++ b/tccli/examples/tse/v20201207/DeleteGovernanceAliases.md @@ -6,11 +6,11 @@ Input: ``` tccli tse DeleteGovernanceAliases --cli-unfold-argument \ - --InstanceId abc \ - --GovernanceAliases.0.Alias abc \ - --GovernanceAliases.0.AliasNamespace abc \ - --GovernanceAliases.0.Service abc \ - --GovernanceAliases.0.Namespace abc + --InstanceId ins-id \ + --GovernanceAliases.0.Alias alias \ + --GovernanceAliases.0.AliasNamespace alias-namespace \ + --GovernanceAliases.0.Service service \ + --GovernanceAliases.0.Namespace namespace ``` Output: @@ -18,7 +18,7 @@ Output: { "Response": { "Result": true, - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/DeleteGovernanceInstances.md b/tccli/examples/tse/v20201207/DeleteGovernanceInstances.md index 1f384d1da2..bc99eab679 100644 --- a/tccli/examples/tse/v20201207/DeleteGovernanceInstances.md +++ b/tccli/examples/tse/v20201207/DeleteGovernanceInstances.md @@ -6,12 +6,12 @@ Input: ``` tccli tse DeleteGovernanceInstances --cli-unfold-argument \ - --InstanceId abc \ - --GovernanceInstances.0.Service abc \ - --GovernanceInstances.0.Namespace abc \ - --GovernanceInstances.0.Host abc \ + --InstanceId ins-id \ + --GovernanceInstances.0.Service service \ + --GovernanceInstances.0.Namespace namespace \ + --GovernanceInstances.0.Host 127.0.0.1 \ --GovernanceInstances.0.Port 1 \ - --GovernanceInstances.0.Id abc + --GovernanceInstances.0.Id id ``` Output: @@ -19,7 +19,7 @@ Output: { "Response": { "Result": true, - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/DeleteGovernanceInstancesByHost.md b/tccli/examples/tse/v20201207/DeleteGovernanceInstancesByHost.md index 3f85d0ef54..7e8d382389 100644 --- a/tccli/examples/tse/v20201207/DeleteGovernanceInstancesByHost.md +++ b/tccli/examples/tse/v20201207/DeleteGovernanceInstancesByHost.md @@ -6,10 +6,10 @@ Input: ``` tccli tse DeleteGovernanceInstancesByHost --cli-unfold-argument \ - --InstanceId abc \ - --GovernanceInstances.0.Service abc \ - --GovernanceInstances.0.Namespace abc \ - --GovernanceInstances.0.Host abc + --InstanceId ins-id \ + --GovernanceInstances.0.Service service \ + --GovernanceInstances.0.Namespace namespace \ + --GovernanceInstances.0.Host 127.0.0.1 ``` Output: @@ -17,7 +17,7 @@ Output: { "Response": { "Result": true, - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/DeleteGovernanceNamespaces.md b/tccli/examples/tse/v20201207/DeleteGovernanceNamespaces.md index 6b26c03c15..0ef2fa31c6 100644 --- a/tccli/examples/tse/v20201207/DeleteGovernanceNamespaces.md +++ b/tccli/examples/tse/v20201207/DeleteGovernanceNamespaces.md @@ -6,8 +6,8 @@ Input: ``` tccli tse DeleteGovernanceNamespaces --cli-unfold-argument \ - --InstanceId abc \ - --GovernanceNamespaces.0.Name abc + --InstanceId ins-id \ + --GovernanceNamespaces.0.Name name ``` Output: @@ -15,7 +15,7 @@ Output: { "Response": { "Result": true, - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/DeleteGovernanceServices.md b/tccli/examples/tse/v20201207/DeleteGovernanceServices.md index 153bb9a128..c8ae208c5e 100644 --- a/tccli/examples/tse/v20201207/DeleteGovernanceServices.md +++ b/tccli/examples/tse/v20201207/DeleteGovernanceServices.md @@ -6,9 +6,9 @@ Input: ``` tccli tse DeleteGovernanceServices --cli-unfold-argument \ - --InstanceId abc \ - --GovernanceServices.0.Name abc \ - --GovernanceServices.0.Namespace abc + --InstanceId ins-id \ + --GovernanceServices.0.Name name \ + --GovernanceServices.0.Namespace namespace ``` Output: @@ -16,7 +16,7 @@ Output: { "Response": { "Result": true, - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/DescribeConfigFile.md b/tccli/examples/tse/v20201207/DescribeConfigFile.md index 6e46b76dcd..8dc83c1f0d 100644 --- a/tccli/examples/tse/v20201207/DescribeConfigFile.md +++ b/tccli/examples/tse/v20201207/DescribeConfigFile.md @@ -6,10 +6,10 @@ Input: ``` tccli tse DescribeConfigFile --cli-unfold-argument \ - --InstanceId abc \ - --Namespace abc \ - --Group abc \ - --Name abc + --InstanceId ins-id \ + --Namespace namespace \ + --Group group \ + --Name name ``` Output: @@ -18,27 +18,27 @@ Output: "Response": { "ConfigFile": { "Id": 1, - "Name": "abc", - "Namespace": "abc", - "Group": "abc", - "Content": "abc", - "Format": "abc", - "Comment": "abc", - "Status": "abc", + "Name": "name", + "Namespace": "namespace", + "Group": "group", + "Content": "content", + "Format": "yaml", + "Comment": "comment", + "Status": "status", "Tags": [ { - "Key": "abc", - "Value": "abc" + "Key": "key", + "Value": "value" } ], - "CreateTime": "abc", - "CreateBy": "abc", - "ModifyTime": "abc", - "ModifyBy": "abc", - "ReleaseTime": "abc", - "ReleaseBy": "abc" + "CreateTime": "2024-10-08 10:00:00", + "CreateBy": "user", + "ModifyTime": "2024-10-08 10:00:00", + "ModifyBy": "user", + "ReleaseTime": "2024-10-08 10:00:00", + "ReleaseBy": "user" }, - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/DescribeConfigFileReleaseHistories.md b/tccli/examples/tse/v20201207/DescribeConfigFileReleaseHistories.md index f9b60c7468..85e558b4d6 100644 --- a/tccli/examples/tse/v20201207/DescribeConfigFileReleaseHistories.md +++ b/tccli/examples/tse/v20201207/DescribeConfigFileReleaseHistories.md @@ -6,7 +6,7 @@ Input: ``` tccli tse DescribeConfigFileReleaseHistories --cli-unfold-argument \ - --InstanceId abc \ + --InstanceId ins-id \ --Namespace Polaris \ --Group group-test-jayhjxu \ --Name config-file-test \ @@ -106,10 +106,10 @@ Input: ``` tccli tse DescribeConfigFileReleaseHistories --cli-unfold-argument \ - --InstanceId abc \ - --Namespace abc \ - --Group abc \ - --Name abc \ + --InstanceId ins-id \ + --Namespace namespace \ + --Group group \ + --Name name \ --EndId 3 \ --Limit 1 \ --Offset 1 diff --git a/tccli/examples/tse/v20201207/DescribeGovernanceAliases.md b/tccli/examples/tse/v20201207/DescribeGovernanceAliases.md index bb5efe4e73..6d0215c46b 100644 --- a/tccli/examples/tse/v20201207/DescribeGovernanceAliases.md +++ b/tccli/examples/tse/v20201207/DescribeGovernanceAliases.md @@ -6,14 +6,14 @@ Input: ``` tccli tse DescribeGovernanceAliases --cli-unfold-argument \ - --Service abc \ - --Namespace abc \ - --Alias abc \ - --AliasNamespace abc \ - --Comment abc \ + --Service service \ + --Namespace namespace \ + --Alias alias \ + --AliasNamespace alias-namespace \ + --Comment comment \ --Offset 1 \ --Limit 1 \ - --InstanceId abc + --InstanceId ins-id ``` Output: @@ -23,18 +23,18 @@ Output: "TotalCount": 1, "Content": [ { - "Alias": "abc", - "AliasNamespace": "abc", - "Service": "abc", - "Namespace": "abc", - "Comment": "abc", - "CreateTime": "abc", - "ModifyTime": "abc", - "Id": "abc", + "Alias": "alias", + "AliasNamespace": "alias-namespace", + "Service": "service", + "Namespace": "namespace", + "Comment": "comment", + "CreateTime": "2024-10-08 10:00:00", + "ModifyTime": "2024-10-08 10:00:00", + "Id": "id", "Editable": true } ], - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/DescribeGovernanceNamespaces.md b/tccli/examples/tse/v20201207/DescribeGovernanceNamespaces.md index c08f18cc84..d924bcc8d6 100644 --- a/tccli/examples/tse/v20201207/DescribeGovernanceNamespaces.md +++ b/tccli/examples/tse/v20201207/DescribeGovernanceNamespaces.md @@ -6,10 +6,10 @@ Input: ``` tccli tse DescribeGovernanceNamespaces --cli-unfold-argument \ - --Name abc \ + --Name name \ --Offset 1 \ --Limit 1 \ - --InstanceId abc + --InstanceId ins-id ``` Output: @@ -19,18 +19,18 @@ Output: "TotalCount": 1, "Content": [ { - "Name": "abc", - "Comment": "abc", - "CreateTime": "abc", - "ModifyTime": "abc", + "Name": "name", + "Comment": "comment", + "CreateTime": "2024-10-08 10:00:00", + "ModifyTime": "2024-10-08 10:00:00", "TotalServiceCount": 0, "TotalHealthInstanceCount": 0, "TotalInstanceCount": 0, - "Id": "abc", + "Id": "id", "Editable": true } ], - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/DescribeGovernanceServices.md b/tccli/examples/tse/v20201207/DescribeGovernanceServices.md index e311fbb36b..1071f57fdb 100644 --- a/tccli/examples/tse/v20201207/DescribeGovernanceServices.md +++ b/tccli/examples/tse/v20201207/DescribeGovernanceServices.md @@ -14,41 +14,41 @@ Output: "TotalCount": 1, "Content": [ { - "Name": "abc", - "Namespace": "abc", + "Name": "name", + "Namespace": "namespace", "Metadatas": [ { - "Key": "abc", - "Value": "abc" + "Key": "key", + "Value": "value" } ], - "Comment": "abc", - "CreateTime": "abc", - "ModifyTime": "abc", - "Department": "abc", - "Business": "abc", + "Comment": "comment", + "CreateTime": "2024-10-08 10:00:00", + "ModifyTime": "2024-10-08 10:00:00", + "Department": "dev", + "Business": "web", "HealthyInstanceCount": 1, "TotalInstanceCount": 1, - "Id": "abc", + "Id": "id", "Editable": true, "UserIds": [ - "abc" + "101" ], "GroupIds": [ - "abc" + "groupa" ], "RemoveUserIds": [ - "abc" + "12345678" ], "RemoveGroupIds": [ - "abc" + "101" ], "ExportTo": [ - "abc" + "json" ] } ], - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/DescribeInstanceTagInfos.md b/tccli/examples/tse/v20201207/DescribeInstanceTagInfos.md index 3595ed8f8a..859878be4f 100644 --- a/tccli/examples/tse/v20201207/DescribeInstanceTagInfos.md +++ b/tccli/examples/tse/v20201207/DescribeInstanceTagInfos.md @@ -6,7 +6,7 @@ Input: ``` tccli tse DescribeInstanceTagInfos --cli-unfold-argument \ - --InstanceId abc + --InstanceId instance-id ``` Output: diff --git a/tccli/examples/tse/v20201207/DescribeSREInstances.md b/tccli/examples/tse/v20201207/DescribeSREInstances.md index 99e794b811..a41e5027e9 100644 --- a/tccli/examples/tse/v20201207/DescribeSREInstances.md +++ b/tccli/examples/tse/v20201207/DescribeSREInstances.md @@ -18,7 +18,7 @@ Output: "Content": [ { "InstanceId": "ins-a123456", - "Name": "test", + "Name": "instance-name", "Edition": "1.8.6", "Status": "creating", "SpecId": "spec-id", diff --git a/tccli/examples/tse/v20201207/ModifyConfigFiles.md b/tccli/examples/tse/v20201207/ModifyConfigFiles.md index 77901d106e..2a85d9fbdf 100644 --- a/tccli/examples/tse/v20201207/ModifyConfigFiles.md +++ b/tccli/examples/tse/v20201207/ModifyConfigFiles.md @@ -6,23 +6,23 @@ Input: ``` tccli tse ModifyConfigFiles --cli-unfold-argument \ - --InstanceId abc \ + --InstanceId ins-id \ --ConfigFile.Id 1 \ - --ConfigFile.Name abc \ - --ConfigFile.Namespace abc \ - --ConfigFile.Group abc \ - --ConfigFile.Content abc \ - --ConfigFile.Format abc \ - --ConfigFile.Comment abc \ - --ConfigFile.Status abc \ - --ConfigFile.Tags.0.Key abc \ - --ConfigFile.Tags.0.Value abc \ - --ConfigFile.CreateTime abc \ - --ConfigFile.CreateBy abc \ - --ConfigFile.ModifyTime abc \ - --ConfigFile.ModifyBy abc \ - --ConfigFile.ReleaseTime abc \ - --ConfigFile.ReleaseBy abc + --ConfigFile.Name name \ + --ConfigFile.Namespace namespace \ + --ConfigFile.Group group \ + --ConfigFile.Content content \ + --ConfigFile.Format yaml \ + --ConfigFile.Comment comment \ + --ConfigFile.Status status \ + --ConfigFile.Tags.0.Key key \ + --ConfigFile.Tags.0.Value value \ + --ConfigFile.CreateTime 2024-10-08 10:00:00 \ + --ConfigFile.CreateBy user \ + --ConfigFile.ModifyTime 2024-10-08 10:00:00 \ + --ConfigFile.ModifyBy user \ + --ConfigFile.ReleaseTime 2024-10-08 10:00:00 \ + --ConfigFile.ReleaseBy user ``` Output: @@ -30,7 +30,7 @@ Output: { "Response": { "Result": true, - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tse/v20201207/ModifyGovernanceNamespaces.md b/tccli/examples/tse/v20201207/ModifyGovernanceNamespaces.md index 7fdd00622b..8f3c209b83 100644 --- a/tccli/examples/tse/v20201207/ModifyGovernanceNamespaces.md +++ b/tccli/examples/tse/v20201207/ModifyGovernanceNamespaces.md @@ -6,13 +6,13 @@ Input: ``` tccli tse ModifyGovernanceNamespaces --cli-unfold-argument \ - --InstanceId abc \ - --GovernanceNamespaces.0.Name abc \ - --GovernanceNamespaces.0.Comment abc \ - --GovernanceNamespaces.0.UserIds abc \ - --GovernanceNamespaces.0.GroupIds abc \ - --GovernanceNamespaces.0.RemoveUserIds abc \ - --GovernanceNamespaces.0.RemoveGroupIds abc + --InstanceId ins-id \ + --GovernanceNamespaces.0.Name name \ + --GovernanceNamespaces.0.Comment coment \ + --GovernanceNamespaces.0.UserIds 101 \ + --GovernanceNamespaces.0.GroupIds groupa \ + --GovernanceNamespaces.0.RemoveUserIds 101 \ + --GovernanceNamespaces.0.RemoveGroupIds groupa ``` Output: @@ -20,7 +20,7 @@ Output: { "Response": { "Result": true, - "RequestId": "abc" + "RequestId": "req-id" } } ``` diff --git a/tccli/examples/tsf/v20180326/BindApiGroup.md b/tccli/examples/tsf/v20180326/BindApiGroup.md index d986fd4568..2b3fefadea 100644 --- a/tccli/examples/tsf/v20180326/BindApiGroup.md +++ b/tccli/examples/tsf/v20180326/BindApiGroup.md @@ -6,15 +6,15 @@ Input: ``` tccli tsf BindApiGroup --cli-unfold-argument \ - --GroupGatewayList.0.GatewayDeployGroupId group-sdy268 \ - --GroupGatewayList.0.GroupId grp-s2gf2a8 + --GroupGatewayList.0.GatewayDeployGroupId group-yo99lney \ + --GroupGatewayList.0.GroupId grp-djvzrdih ``` Output: ``` { "Response": { - "RequestId": "5d996e05507e42d5970cd2e25ed5267a", + "RequestId": "5714c887-aa81-4347-864c-2ea5cb078d63", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/CreateAllGatewayApiAsync.md b/tccli/examples/tsf/v20180326/CreateAllGatewayApiAsync.md index d32f025a5b..9e0ea58cab 100644 --- a/tccli/examples/tsf/v20180326/CreateAllGatewayApiAsync.md +++ b/tccli/examples/tsf/v20180326/CreateAllGatewayApiAsync.md @@ -6,15 +6,16 @@ Input: ``` tccli tsf CreateAllGatewayApiAsync --cli-unfold-argument \ - --GroupId grp-5yk7oor1 \ - --MicroserviceId ms-2vz549vp + --GroupId grp-notmqbpe \ + --MicroserviceId ms-y5w8n5e9 \ + --NamespaceId namespace-v3gw3lna ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "2471e0f2-59f2-4bc0-bc2b-4cbe457247b9", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/CreateApiGroup.md b/tccli/examples/tsf/v20180326/CreateApiGroup.md index c7724303d4..0e642d22bd 100644 --- a/tccli/examples/tsf/v20180326/CreateApiGroup.md +++ b/tccli/examples/tsf/v20180326/CreateApiGroup.md @@ -6,10 +6,12 @@ Input: ``` tccli tsf CreateApiGroup --cli-unfold-argument \ - --GroupName zuul_test_group \ - --GroupContext %2Fuser \ + --GroupName grp_user \ + --GroupContext /grp_user \ --AuthType none \ - --Description test \ + --Description This is desc \ + --GroupType ms \ + --GatewayInstanceId gw-ins-szesmg28 \ --NamespaceNameKey TSF-NamespaceName \ --ServiceNameKey TSF-ServiceName \ --NamespaceNameKeyPosition path \ @@ -20,8 +22,8 @@ Output: ``` { "Response": { - "RequestId": "5d996e05507e42d5970cd2e25ed5267a", - "Result": "grp-57at58po" + "RequestId": "156db4f2-9d4e-48bc-87eb-539a46919107", + "Result": "grp-rzn41l1w" } } ``` diff --git a/tccli/examples/tsf/v20180326/CreateApiRateLimitRule.md b/tccli/examples/tsf/v20180326/CreateApiRateLimitRule.md index a46302fb2d..04057e0b21 100644 --- a/tccli/examples/tsf/v20180326/CreateApiRateLimitRule.md +++ b/tccli/examples/tsf/v20180326/CreateApiRateLimitRule.md @@ -6,15 +6,16 @@ Input: ``` tccli tsf CreateApiRateLimitRule --cli-unfold-argument \ - --ApiId api-uk1098lc1 \ - --MaxQps 100 + --ApiId api-8c7538te \ + --UsableStatus enabled \ + --MaxQps 10000 ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "af8bda56-e2f3-440f-a05c-25d63bdc397e", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/CreateConfig.md b/tccli/examples/tsf/v20180326/CreateConfig.md index 4ea2743c6d..91ac48de93 100644 --- a/tccli/examples/tsf/v20180326/CreateConfig.md +++ b/tccli/examples/tsf/v20180326/CreateConfig.md @@ -6,17 +6,21 @@ Input: ``` tccli tsf CreateConfig --cli-unfold-argument \ - --ApplicationId application-gyq2xry5 \ - --ConfigName test_openapi_config \ - --ConfigVersion v1.0 \ - --ConfigValue 'api.invok.limit: 5000' + --ConfigName config_app \ + --ConfigVersion v1 \ + --ConfigVersionDesc This is desc \ + --ConfigValue config: enabled \ + --ApplicationId application-5yr26r9a \ + --ConfigType application \ + --EncodeWithBase64 True \ + --ProgramIdList program-6a79x94v ``` Output: ``` { "Response": { - "RequestId": "8007ea57-6d26-43db-aa75-ad72cb3669ca", + "RequestId": "fa979523-5509-4073-89b8-65c2bf86ff9a", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/CreateConfigTemplate.md b/tccli/examples/tsf/v20180326/CreateConfigTemplate.md index 84712b908c..e426bc2ecc 100644 --- a/tccli/examples/tsf/v20180326/CreateConfigTemplate.md +++ b/tccli/examples/tsf/v20180326/CreateConfigTemplate.md @@ -6,26 +6,18 @@ Input: ``` tccli tsf CreateConfigTemplate --cli-unfold-argument \ - --ConfigTemplateName 配置1 \ - --ConfigTemplateDesc 11111111111 \ + --ConfigTemplateName config_temp_app \ + --ConfigTemplateDesc This is desc \ --ConfigTemplateType Ribbon \ - --ConfigTemplateValue '#请求处理超时时间 -ribbon.ReadTimeout: 5000 -#请求连接超时时间 -ribbon.ConnectTimeout: 2000 -#同一实例最大重试次数,不包括首次调用 -ribbon.MaxAutoRetries: 0 -#重试其他实例的最大重试次数,不包括首次所选的server -ribbon.MaxAutoRetriesNextServer: 1 -#是否对所有操作请求都进行重试 -ribbon.OkToRetryOnAllOperations: false' + --ConfigTemplateValue #请求处理超时时间\nribbon.ReadTimeout: 5000\n#请求连接超时时间\nribbon.ConnectTimeout: 2000\n#同一实例最大重试次数,不包括首次调用\nribbon.MaxAutoRetries: 0\n#重试其他实例的最大重试次数,不包括首次所选的server\nribbon.MaxAutoRetriesNextServer: 1\n#是否对所有操作请求都进行重试\nribbon.OkToRetryOnAllOperations: false\n \ + --ProgramIdList program-6a79x94v ``` Output: ``` { "Response": { - "RequestId": "841f10d8-24e7-471b-ad8a-b401d9dcbe70", + "RequestId": "829c771a-2e0f-4858-8d5a-3f63ddf2f739", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/CreateConfigTemplateWithDetailResp.md b/tccli/examples/tsf/v20180326/CreateConfigTemplateWithDetailResp.md index 309719b602..b785c5ae59 100644 --- a/tccli/examples/tsf/v20180326/CreateConfigTemplateWithDetailResp.md +++ b/tccli/examples/tsf/v20180326/CreateConfigTemplateWithDetailResp.md @@ -6,27 +6,27 @@ Input: ``` tccli tsf CreateConfigTemplateWithDetailResp --cli-unfold-argument \ - --ConfigTemplateName abc \ - --ConfigTemplateDesc abc \ - --ConfigTemplateType abc \ - --ConfigTemplateValue abc \ - --ProgramIdList abc + --ConfigTemplateName config_temp \ + --ConfigTemplateDesc This is desc \ + --ConfigTemplateType Ribbon \ + --ConfigTemplateValue #请求处理超时时间\\nribbon.ReadTimeout: 5000\\n#请求连接超时时间\\nribbon.ConnectTimeout: 2000\\n#同一实例最大重试次数,不包括首次调用\\nribbon.MaxAutoRetries: 0\\n#重试其他实例的最大重试次数,不包括首次所选的server\\nribbon.MaxAutoRetriesNextServer: 1\\n#是否对所有操作请求都进行重试\\nribbon.OkToRetryOnAllOperations: false\\n \ + --ProgramIdList program-6a79x94v ``` Output: ``` { "Response": { + "RequestId": "6d940d10-9545-4481-bbc2-eb0d6016f069", "Result": { - "ConfigTemplateId": "abc", - "ConfigTemplateName": "abc", - "ConfigTemplateDesc": "abc", - "ConfigTemplateType": "abc", - "ConfigTemplateValue": "abc", - "CreateTime": "abc", - "UpdateTime": "abc" - }, - "RequestId": "xxxxxxxxxxx" + "ConfigTemplateDesc": "This is desc", + "ConfigTemplateId": "dcfg_temp-ymw5o65v", + "ConfigTemplateName": "config_temp", + "ConfigTemplateType": "Ribbon", + "ConfigTemplateValue": "#请求处理超时时间\\\\nribbon.ReadTimeout: 5000\\\\n#请求连接超时时间\\\\nribbon.ConnectTimeout: 2000\\\\n#同一实例最大重试次数,不包括首次调用\\\\nribbon.MaxAutoRetries: 0\\\\n#重试其他实例的最大重试次数,不包括首次所选的server\\\\nribbon.MaxAutoRetriesNextServer: 1\\\\n#是否对所有操作请求都进行重试\\\\nribbon.OkToRetryOnAllOperations: false\\\\n", + "CreateTime": null, + "UpdateTime": null + } } } ``` diff --git a/tccli/examples/tsf/v20180326/CreateFileConfig.md b/tccli/examples/tsf/v20180326/CreateFileConfig.md index 705ebc205f..c6dd7c281f 100644 --- a/tccli/examples/tsf/v20180326/CreateFileConfig.md +++ b/tccli/examples/tsf/v20180326/CreateFileConfig.md @@ -6,21 +6,24 @@ Input: ``` tccli tsf CreateFileConfig --cli-unfold-argument \ - --ApplicationId application-dapbkdgy \ - --ConfigName war-config \ - --ConfigVersion 1 \ - --ConfigFileName update \ + --ConfigName config_app \ + --ConfigVersion v1 \ + --ConfigVersionDesc This is desc \ + --ConfigFileName conf.txt \ + --ConfigFileValue config=enabled \ --ConfigFileCode utf-8 \ - --ConfigPostCmd /usr/bin/bash \ - --ConfigFileValue workdir \ - --ConfigFilePath /root + --ApplicationId application-5yr26r9a \ + --ConfigFilePath /root \ + --ConfigPostCmd sh start.sh \ + --EncodeWithBase64 True \ + --ProgramIdList program-6a79x94v ``` Output: ``` { "Response": { - "RequestId": "3063d6c8-9801-4ed0-b306-be14b89f6133", + "RequestId": "880b83c3-1018-4922-ab11-1822d5d5981d", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/CreateGatewayApi.md b/tccli/examples/tsf/v20180326/CreateGatewayApi.md index 40d78ec4bc..38307b9946 100644 --- a/tccli/examples/tsf/v20180326/CreateGatewayApi.md +++ b/tccli/examples/tsf/v20180326/CreateGatewayApi.md @@ -6,19 +6,22 @@ Input: ``` tccli tsf CreateGatewayApi --cli-unfold-argument \ - --GroupId grp-5yk7oor1 \ - --ApiList.0.NamespaceId ns-do1n280j \ - --ApiList.0.MicroserviceId ms-sf26d1gf1 \ - --ApiList.0.Path /user/find \ - --ApiList.0.Method POST \ - --ApiList.0.PathMapping /user/find + --GroupId grp-djvzrdih \ + --ApiList.0.NamespaceId namespace-external \ + --ApiList.0.MicroserviceId ms-external \ + --ApiList.0.Path /echo_user \ + --ApiList.0.Method GET \ + --ApiList.0.PathMapping /echo_user \ + --ApiList.0.Host http://www.qq.com \ + --ApiList.0.Description This is desc \ + --ProgramIdList program-6a79x94v ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "e521be92-af1e-4d1c-bcd9-31bfe1ff0859", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/CreateMicroservice.md b/tccli/examples/tsf/v20180326/CreateMicroservice.md index 696292dd14..9e8fc59d28 100644 --- a/tccli/examples/tsf/v20180326/CreateMicroservice.md +++ b/tccli/examples/tsf/v20180326/CreateMicroservice.md @@ -6,15 +6,16 @@ Input: ``` tccli tsf CreateMicroservice --cli-unfold-argument \ - --NamespaceId namespace-xxxxxxx \ - --MicroserviceName consumer-demo1 + --NamespaceId namespace-v3gw3lna \ + --MicroserviceName provider-app \ + --MicroserviceDesc This is desc ``` Output: ``` { "Response": { - "RequestId": "2bb5b35d-cdad-45a0-96ce-bc48abe98cc7", + "RequestId": "f0c42921-ff15-4718-a296-20403124f81b", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/CreatePathRewritesWithDetailResp.md b/tccli/examples/tsf/v20180326/CreatePathRewritesWithDetailResp.md index 69b98f7150..f796d93e63 100644 --- a/tccli/examples/tsf/v20180326/CreatePathRewritesWithDetailResp.md +++ b/tccli/examples/tsf/v20180326/CreatePathRewritesWithDetailResp.md @@ -6,21 +6,21 @@ Input: ``` tccli tsf CreatePathRewritesWithDetailResp --cli-unfold-argument \ - --PathRewrites.0.GatewayGroupId abc \ - --PathRewrites.0.Regex abc \ - --PathRewrites.0.Replacement abc \ - --PathRewrites.0.Blocked abc \ - --PathRewrites.0.Order 0 + --PathRewrites.0.GatewayGroupId group-ldap5yok \ + --PathRewrites.0.Regex /consumer \ + --PathRewrites.0.Replacement /provider \ + --PathRewrites.0.Blocked N \ + --PathRewrites.0.Order 1 ``` Output: ``` { "Response": { + "RequestId": "29e9b18a-2886-4582-bc14-fdb56aa49c8c", "Result": [ - "abc" - ], - "RequestId": "abc" + "rewrite-py5r7b6v" + ] } } ``` diff --git a/tccli/examples/tsf/v20180326/CreatePublicConfig.md b/tccli/examples/tsf/v20180326/CreatePublicConfig.md index 5bf3e5f778..7d0700226d 100644 --- a/tccli/examples/tsf/v20180326/CreatePublicConfig.md +++ b/tccli/examples/tsf/v20180326/CreatePublicConfig.md @@ -6,16 +6,20 @@ Input: ``` tccli tsf CreatePublicConfig --cli-unfold-argument \ - --ConfigName testconfig \ - --ConfigVersion 1.3 \ - --ConfigValue tsf.inventory.password.encrypt2:%20ENC(3M7wGw2XtFc5Y+rxOgNBLrm2spUtgodjIxa+7F3XcAo + --ConfigName config_pub_app \ + --ConfigVersion v1 \ + --ConfigVersionDesc This is desc \ + --ConfigValue config: enabled \ + --ConfigType public \ + --EncodeWithBase64 True \ + --ProgramIdList program-6a79x94v ``` Output: ``` { "Response": { - "RequestId": "3d600e1f-87c3-4aa6-afa5-a4f8330fa181", + "RequestId": "a1563762-2470-42d0-a35f-6a03a05d2457", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/DeleteApiGroup.md b/tccli/examples/tsf/v20180326/DeleteApiGroup.md index acd31c2664..37b6dc2c72 100644 --- a/tccli/examples/tsf/v20180326/DeleteApiGroup.md +++ b/tccli/examples/tsf/v20180326/DeleteApiGroup.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf DeleteApiGroup --cli-unfold-argument \ - --GroupId grp-5yk7oor1 + --GroupId grp-glt0lr13 ``` Output: ``` { "Response": { - "RequestId": "5d996e05507e42d5970cd2e25ed5267a", + "RequestId": "444e5ead-5dd2-4df5-bfc6-fce580cb0a31", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/DeleteConfig.md b/tccli/examples/tsf/v20180326/DeleteConfig.md index 4e6925b2ed..18f9e1044e 100644 --- a/tccli/examples/tsf/v20180326/DeleteConfig.md +++ b/tccli/examples/tsf/v20180326/DeleteConfig.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf DeleteConfig --cli-unfold-argument \ - --ConfigId dcfg-gvkgdjyo + --ConfigId dcfg-a7rl7w4v ``` Output: ``` { "Response": { - "RequestId": "aa19a76d-340f-4ed3-a8d7-b4c12a62ee3e", + "RequestId": "b1ec0d59-5901-4265-9a4c-9c0489a2cbcd", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/DeleteFileConfig.md b/tccli/examples/tsf/v20180326/DeleteFileConfig.md index ea6fc5236a..c8e38b1893 100644 --- a/tccli/examples/tsf/v20180326/DeleteFileConfig.md +++ b/tccli/examples/tsf/v20180326/DeleteFileConfig.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf DeleteFileConfig --cli-unfold-argument \ - --ConfigId dcfg-f-6yol6nyl + --ConfigId dcfg-f-aeonjd6y ``` Output: ``` { "Response": { - "RequestId": "36c611a9-86d4-4e15-9400-e779682c408e", + "RequestId": "db1b2acf-5cd5-4249-9c20-c08a79948019", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/DeleteGatewayApi.md b/tccli/examples/tsf/v20180326/DeleteGatewayApi.md index 44a27f8ccb..55b867168f 100644 --- a/tccli/examples/tsf/v20180326/DeleteGatewayApi.md +++ b/tccli/examples/tsf/v20180326/DeleteGatewayApi.md @@ -6,15 +6,15 @@ Input: ``` tccli tsf DeleteGatewayApi --cli-unfold-argument \ - --GroupId grp-5yk7oor1 \ - --ApiIdList api-d5970cd2 api-d5970cd3 + --GroupId grp-notmqbpe \ + --ApiList api-8c7538te ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "d54416e7-d75b-4fdd-860b-612f465db1f4", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/DeleteLane.md b/tccli/examples/tsf/v20180326/DeleteLane.md index b5a5561ca5..9eed789fda 100644 --- a/tccli/examples/tsf/v20180326/DeleteLane.md +++ b/tccli/examples/tsf/v20180326/DeleteLane.md @@ -6,15 +6,15 @@ Input: ``` tccli tsf DeleteLane --cli-unfold-argument \ - --LaneId lane-6ymrl42a + --LaneId lane-y9o6w958 ``` Output: ``` { "Response": { - "Result": true, - "RequestId": "abc" + "RequestId": "40bb8670-043a-478c-b85f-157b1f552d56", + "Result": true } } ``` diff --git a/tccli/examples/tsf/v20180326/DeleteMicroservice.md b/tccli/examples/tsf/v20180326/DeleteMicroservice.md index 29d6b8d160..70ea6dcbaf 100644 --- a/tccli/examples/tsf/v20180326/DeleteMicroservice.md +++ b/tccli/examples/tsf/v20180326/DeleteMicroservice.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf DeleteMicroservice --cli-unfold-argument \ - --MicroserviceId ms-xxxxxxx + --MicroserviceId ms-vzg9kzj3 ``` Output: ``` { "Response": { - "RequestId": "97f5554f-8d66-4eac-802d-2f36dc2a7124", + "RequestId": "ea8639e6-a455-49f7-84f2-ae6d0a9b05b1", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/DeletePathRewrites.md b/tccli/examples/tsf/v20180326/DeletePathRewrites.md index 49f5b0cce1..a0396a9e07 100644 --- a/tccli/examples/tsf/v20180326/DeletePathRewrites.md +++ b/tccli/examples/tsf/v20180326/DeletePathRewrites.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf DeletePathRewrites --cli-unfold-argument \ - --PathRewriteIds rewrite-l6ymbvgd rewrite-s7j2kkh39 + --PathRewriteIds rewrite-qv3rrlnv ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "ded2dfb4-4eea-4eea-970c-ace085804bf3", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/DeletePublicConfig.md b/tccli/examples/tsf/v20180326/DeletePublicConfig.md index 7ca659ff46..c424bf721d 100644 --- a/tccli/examples/tsf/v20180326/DeletePublicConfig.md +++ b/tccli/examples/tsf/v20180326/DeletePublicConfig.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf DeletePublicConfig --cli-unfold-argument \ - --ConfigId dcfg-p-zvwgl6y8 + --ConfigId dcfg-p-vzk36rov ``` Output: ``` { "Response": { - "RequestId": "839449d1-9ea3-45a8-94b9-4f9beecb8a45", + "RequestId": "32ea862f-ecbc-477a-9edd-0c8597f881f1", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/DeleteUnitRule.md b/tccli/examples/tsf/v20180326/DeleteUnitRule.md index 45ee79c108..3307de93e9 100644 --- a/tccli/examples/tsf/v20180326/DeleteUnitRule.md +++ b/tccli/examples/tsf/v20180326/DeleteUnitRule.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf DeleteUnitRule --cli-unfold-argument \ - --Id rule-ins-afsfas + --Id unit-rl-cgd3l6jo ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "27dbfb99-0406-4279-8a3a-2f3523236d6c", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/DescribeApiDetail.md b/tccli/examples/tsf/v20180326/DescribeApiDetail.md index d7803de60b..2f7631ae7b 100644 --- a/tccli/examples/tsf/v20180326/DescribeApiDetail.md +++ b/tccli/examples/tsf/v20180326/DescribeApiDetail.md @@ -6,127 +6,60 @@ Input: ``` tccli tsf DescribeApiDetail --cli-unfold-argument \ - --MicroserviceId ms-2vzprpyp \ - --Path /facade/supplier/test \ - --Method POST \ - --ApplicationId application-gvkw2ejv \ - --PkgVersion jenkins-prod-supplier-1 + --MicroserviceId ms-y5w8n5e9 \ + --Path /user-feign \ + --Method GET \ + --PkgVersion 20210625192924 \ + --ApplicationId application-yn3zdj9v ``` Output: ``` { "Response": { - "RequestId": "b8427f00-c974-47b1-9827-978cdb043b9d", + "RequestId": "93c8e28a-196e-46a3-b903-b74ddcf7ce26", "Result": { - "Request": [ - { - "Name": "supplierId", - "Type": "string", - "Description": "supplierId", - "Required": true, - "In": "query" - } - ], - "Response": [ - { - "Name": "Res«Supplier»", - "Type": "#/Definitions/Res«Supplier»", - "Description": "OK" - } - ], + "CanRun": true, "Definitions": [ { - "Name": "Supplier", + "Name": "", "Properties": [ { - "Name": "abbrName", - "Type": "string" - }, - { - "Name": "coordinatesSystem", - "Type": "integer(int32)" - }, - { - "Name": "createTime", - "Type": "string(date-time)" - }, - { - "Name": "id", - "Type": "string" - }, - { - "Name": "invoiceLineNum", - "Type": "integer(int32)" - }, - { - "Name": "invoiceMaxFee", - "Type": "integer(int64)" - }, - { - "Name": "invoiceMinFee", - "Type": "integer(int64)" - }, - { - "Name": "invoiceType", - "Type": "integer(int32)" - }, - { - "Name": "isActive", - "Type": "integer(int32)" - }, - { - "Name": "isTripEnable", - "Type": "integer(int32)" - }, - { - "Name": "logo", - "Type": "string" - }, - { - "Name": "name", - "Type": "string" - }, - { - "Name": "priceRuleUrl", - "Type": "string" - }, - { - "Name": "servicePhone", - "Type": "string" - }, - { - "Name": "signKey", - "Type": "string" - }, - { - "Name": "updateTime", - "Type": "string(date-time)" + "Description": "", + "Name": "", + "Type": "" } ] + } + ], + "Description": "feignMeshUser", + "Request": [ + { + "DefaultValue": null, + "Description": "tagName", + "In": "query", + "Name": "tagName", + "Required": false, + "Type": "string" }, { - "Name": "Res«Supplier»", - "Properties": [ - { - "Name": "code", - "Type": "integer(int32)" - }, - { - "Name": "data", - "Type": "#/Definitions/Supplier" - }, - { - "Name": "errmsg", - "Type": "string" - }, - { - "Name": "success", - "Type": "boolean" - } - ] + "DefaultValue": null, + "Description": "tagValue", + "In": "query", + "Name": "tagValue", + "Required": false, + "Type": "string" } - ] + ], + "RequestContentType": null, + "Response": [ + { + "Description": "OK", + "Name": "_RESPONSE", + "Type": "string" + } + ], + "Status": 1 } } } diff --git a/tccli/examples/tsf/v20180326/DescribeConfig.md b/tccli/examples/tsf/v20180326/DescribeConfig.md index d904f90ae3..7b2a4eb3fb 100644 --- a/tccli/examples/tsf/v20180326/DescribeConfig.md +++ b/tccli/examples/tsf/v20180326/DescribeConfig.md @@ -6,27 +6,27 @@ Input: ``` tccli tsf DescribeConfig --cli-unfold-argument \ - --ConfigId dcfg-qabr26yl + --ConfigId dcfg-vzk36owv ``` Output: ``` { "Response": { - "RequestId": "2e68ea83-3799-4fb0-ba9b-ab8be2488d98", + "RequestId": "60bd18bd-50bb-4e4c-af76-8f1c938b103a", "Result": { - "ConfigId": "dcfg-qabr26yl", - "ConfigName": "test_pay_center", - "ConfigVersion": "0.0.9", - "ConfigVersionDesc": "默认100元", - "ConfigValue": "facade:\r\n white-list:\r\n - 10.3.1.34\r\n - 10.3.1.32\r\n - 212.64.13.188\r\n - 172.16.0.192\r\norder:\r\n amount:\r\n min: 1\r\n wxScoreMin: 1\r\n wxScoreMax: 20000 \r\n enterpriseAmount: 10000 \r\n refundAmountMax: 1000000 ", - "CreationTime": "2019-05-28 20:23:35", - "LastUpdateTime": null, - "ConfigVersionCount": null, - "ApplicationId": "application-6ym9pbag", - "ApplicationName": "test_pay_center", - "DeleteFlag": false, - "ConfigType": null + "ApplicationId": "application-5yr26r9a", + "ApplicationName": "amp-consumer", + "ConfigId": "dcfg-vzk36owv", + "ConfigName": "config_app", + "ConfigType": "application", + "ConfigValue": "config: enabled", + "ConfigVersion": "v1", + "ConfigVersionCount": 1, + "ConfigVersionDesc": "This is desc", + "CreationTime": "2024-12-24 18:04:02", + "DeleteFlag": true, + "LastUpdateTime": "2024-12-24 18:04:02" } } } diff --git a/tccli/examples/tsf/v20180326/DescribeConfigReleaseLogs.md b/tccli/examples/tsf/v20180326/DescribeConfigReleaseLogs.md index 03d2f8f6c2..d54392494b 100644 --- a/tccli/examples/tsf/v20180326/DescribeConfigReleaseLogs.md +++ b/tccli/examples/tsf/v20180326/DescribeConfigReleaseLogs.md @@ -6,76 +6,42 @@ Input: ``` tccli tsf DescribeConfigReleaseLogs --cli-unfold-argument \ + --GroupId group-aln2284v \ --Offset 0 \ - --Limit 20 + --Limit 10 \ + --NamespaceId namespace-vj3z3zgy \ + --ClusterId cluster-yne99jdy ``` Output: ``` { "Response": { - "RequestId": "cd8be98a-c557-43ef-bece-069f014bb2dd", + "RequestId": "66410802-5243-4b39-8823-21843a2bf669", "Result": { - "TotalCount": 3, "Content": [ { - "ConfigReleaseLogId": "dcfgrl-6ymq4b5v", - "ConfigId": "dcfg-6a79x94v", - "ConfigName": "[配置项已被删除]", - "ConfigVersion": "[配置项已被删除]", - "GroupId": "group-mae5orra", - "GroupName": "[部署组已被删除]", - "NamespaceId": null, - "NamespaceName": null, - "ClusterId": null, - "ClusterName": null, - "ReleaseTime": "2019-05-28 09:41:40", - "ReleaseDesc": null, + "ClusterId": "cluster-yne99jdy", + "ClusterName": "cluster-app", + "ConfigId": "dcfg-yo82mmra", + "ConfigName": "app-config", + "ConfigReleaseLogId": "dcfgrl-yq75nn3a", + "ConfigVersion": "v3", + "GroupId": "group-aln2284v", + "GroupName": "group-provider-1", + "LastConfigId": "dcfg-yo82mmra", + "LastConfigName": "config_app", + "LastConfigVersion": "v1", + "NamespaceId": "namespace-vw8oox6v", + "NamespaceName": "cluster-jolyonzheng_default", + "ReleaseDesc": "This is desc", "ReleaseStatus": "S", - "LastConfigId": null, - "LastConfigName": null, - "LastConfigVersion": null, - "RollbackFlag": false - }, - { - "ConfigReleaseLogId": "dcfgrl-ba228ppa", - "ConfigId": "dcfg-6a79x94v", - "ConfigName": "[配置项已被删除]", - "ConfigVersion": "[配置项已被删除]", - "GroupId": "group-mae5orra", - "GroupName": "[部署组已被删除]", - "NamespaceId": null, - "NamespaceName": null, - "ClusterId": null, - "ClusterName": null, - "ReleaseTime": "2019-05-28 09:36:52", - "ReleaseDesc": "删除配置项", - "ReleaseStatus": "DS", - "LastConfigId": "dcfg-6a79x94v", - "LastConfigName": "[配置项已被删除]", - "LastConfigVersion": "[配置项已被删除]", - "RollbackFlag": false - }, - { - "ConfigReleaseLogId": "dcfgrl-evjjbjlv", - "ConfigId": "dcfg-6a79x94v", - "ConfigName": "[配置项已被删除]", - "ConfigVersion": "[配置项已被删除]", - "GroupId": "group-mae5orra", - "GroupName": "[部署组已被删除]", - "NamespaceId": null, - "NamespaceName": null, - "ClusterId": null, - "ClusterName": null, - "ReleaseTime": "2019-05-28 09:30:55", - "ReleaseDesc": null, - "ReleaseStatus": "S", - "LastConfigId": null, - "LastConfigName": null, - "LastConfigVersion": null, + "ReleaseTime": "2024-12-24 15:57:15", + "ReleasedConfigCenter": "SHARE", "RollbackFlag": false } - ] + ], + "TotalCount": 6 } } } diff --git a/tccli/examples/tsf/v20180326/DescribeConfigReleases.md b/tccli/examples/tsf/v20180326/DescribeConfigReleases.md index 232fba336d..124d6fa1e3 100644 --- a/tccli/examples/tsf/v20180326/DescribeConfigReleases.md +++ b/tccli/examples/tsf/v20180326/DescribeConfigReleases.md @@ -6,17 +6,50 @@ Input: ``` tccli tsf DescribeConfigReleases --cli-unfold-argument \ - --ConfigId dcfg-zvw6kxa8 + --ConfigName app-config \ + --GroupId group-aln2284v \ + --NamespaceId namespace-vw8oox6v \ + --ClusterId cluster-yne99jdy \ + --Limit 10 \ + --Offset 0 \ + --ConfigId dcfg-yo82mmra \ + --ApplicationId application-a7rwwz4v ``` Output: ``` { "Response": { - "RequestId": "2cee7c95-08aa-45fa-9a1c-7016b7b1fcbf", + "RequestId": "16fa1e0b-d3e8-4b1f-b15f-e1d01966acb7", "Result": { - "TotalCount": 0, - "Content": [] + "Content": [ + { + "ApplicationId": "application-a7rwwz4v", + "ClusterId": "cluster-yne99jdy", + "ClusterName": "cluster-app", + "ConfigCenters": [ + { + "ConfigCenterInstanceId": null, + "ConfigCenterInstanceName": null, + "ConfigType": "SHARE", + "CurrentVersion": null, + "RegionId": null, + "TargetVersion": null + } + ], + "ConfigId": "dcfg-yo82mmra", + "ConfigName": "app-config", + "ConfigReleaseId": "dcfgr-yxd366ov", + "ConfigVersion": "v3", + "GroupId": "group-aln2284v", + "GroupName": "group-provider", + "NamespaceId": "namespace-vw8oox6v", + "NamespaceName": "cluster-app_default", + "ReleaseDesc": "This is desc", + "ReleaseTime": "2024-12-24 15:57:15" + } + ], + "TotalCount": 1 } } } diff --git a/tccli/examples/tsf/v20180326/DescribeConfigSummary.md b/tccli/examples/tsf/v20180326/DescribeConfigSummary.md index 02446c03d9..df48ee63e8 100644 --- a/tccli/examples/tsf/v20180326/DescribeConfigSummary.md +++ b/tccli/examples/tsf/v20180326/DescribeConfigSummary.md @@ -6,62 +6,40 @@ Input: ``` tccli tsf DescribeConfigSummary --cli-unfold-argument \ + --ApplicationId application-5yr26r9a \ + --SearchWord config_app \ --Offset 0 \ - --Limit 20 \ - --SearchWord driver + --Limit 10 \ + --OrderBy creation_time \ + --OrderType 1 \ + --ConfigTagList config_app-application-5yr26r9a \ + --DisableProgramAuthCheck True \ + --ConfigIdList dcfg-vzk36owv ``` Output: ``` { "Response": { - "RequestId": "2b151339-278f-47ed-b5fe-a86273a203de", + "RequestId": "0e8d31d3-e16a-4070-9248-cce94db7fae5", "Result": { - "TotalCount": 3, "Content": [ { - "ConfigId": null, - "ConfigName": "dev-driverapi-config", - "ConfigVersion": null, - "ConfigVersionDesc": null, - "ConfigValue": null, - "CreationTime": null, - "LastUpdateTime": "2019-04-16 12:38:45", - "ConfigVersionCount": 2, - "ApplicationId": "application-maegorqv", - "ApplicationName": "gactravel_dev_driverapi", - "DeleteFlag": null, - "ConfigType": null - }, - { - "ConfigId": null, - "ConfigName": "ruqi_travel_driverapi", - "ConfigVersion": null, - "ConfigVersionDesc": null, + "ApplicationId": "application-5yr26r9a", + "ApplicationName": "amp-consumer", + "ConfigId": "dcfg-vzk36owv", + "ConfigName": "config_app", + "ConfigType": null, "ConfigValue": null, - "CreationTime": null, - "LastUpdateTime": "2019-04-16 12:29:55", - "ConfigVersionCount": 3, - "ApplicationId": "application-ov6mxrka", - "ApplicationName": "ruqi_travel_driverapi", - "DeleteFlag": null, - "ConfigType": null - }, - { - "ConfigId": null, - "ConfigName": "test-driverapi-config", "ConfigVersion": null, + "ConfigVersionCount": 1, "ConfigVersionDesc": null, - "ConfigValue": null, "CreationTime": null, - "LastUpdateTime": "2019-04-23 11:16:26", - "ConfigVersionCount": 2, - "ApplicationId": "application-jy9w6lka", - "ApplicationName": "ruqitest_travel_driverapi", "DeleteFlag": null, - "ConfigType": null + "LastUpdateTime": "2024-12-24 18:04:02" } - ] + ], + "TotalCount": 1 } } } diff --git a/tccli/examples/tsf/v20180326/DescribeDeliveryConfig.md b/tccli/examples/tsf/v20180326/DescribeDeliveryConfig.md index 61a0a9cf95..2a0aa8cd01 100644 --- a/tccli/examples/tsf/v20180326/DescribeDeliveryConfig.md +++ b/tccli/examples/tsf/v20180326/DescribeDeliveryConfig.md @@ -6,15 +6,41 @@ Input: ``` tccli tsf DescribeDeliveryConfig --cli-unfold-argument \ - --ConfigId dddd + --ConfigId config-kl29sh7n ``` Output: ``` { "Response": { - "RequestId": "e64dc152-b874-4b91-9301-e9b290f1ffbb", - "Result": true + "RequestId": "00b0009f-80ad-41fd-8bb8-f430d12f3911", + "Result": { + "CollectPath": [ + "" + ], + "ConfigId": "send-data-to-kafka-nalj8bgy", + "ConfigName": "rtest222", + "CustomRule": null, + "EnableAuth": false, + "EnableGlobalLineRule": false, + "KafkaAddress": null, + "KafkaInfos": [ + { + "CustomRule": "", + "LineRule": "", + "Path": [ + "/test/1.log" + ], + "Topic": "test" + } + ], + "KafkaVIp": "127.0.1:9200", + "KafkaVPort": null, + "LineRule": "default", + "Password": null, + "Topic": "", + "Username": null + } } } ``` diff --git a/tccli/examples/tsf/v20180326/DescribeDeliveryConfigByGroupId.md b/tccli/examples/tsf/v20180326/DescribeDeliveryConfigByGroupId.md index 70ee4c7351..bf0dafb707 100644 --- a/tccli/examples/tsf/v20180326/DescribeDeliveryConfigByGroupId.md +++ b/tccli/examples/tsf/v20180326/DescribeDeliveryConfigByGroupId.md @@ -6,7 +6,7 @@ Input: ``` tccli tsf DescribeDeliveryConfigByGroupId --cli-unfold-argument \ - --GroupId dddd + --GroupId group-ab958z6y ``` Output: @@ -14,10 +14,10 @@ Output: { "Response": { "Result": { - "ConfigId": "abc", - "ConfigName": "abc" + "ConfigId": "apm-busi-log-cfg-ab958z6y", + "ConfigName": "log-demo" }, - "RequestId": "abc" + "RequestId": "96561cf1-738a-47d6-943b-dec7ebbccabe" } } ``` diff --git a/tccli/examples/tsf/v20180326/DescribeDownloadInfo.md b/tccli/examples/tsf/v20180326/DescribeDownloadInfo.md index 46117b0668..6d3c1bfd29 100644 --- a/tccli/examples/tsf/v20180326/DescribeDownloadInfo.md +++ b/tccli/examples/tsf/v20180326/DescribeDownloadInfo.md @@ -21,7 +21,7 @@ Output: "Path": "/1111111111/application-xxxxxxxx/201905291xxxxx/travel-passenger-xxx-1.0-SNAPSHOT.jar", "Credentials": { "SessionToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", - "TmpAppId": "123456789", + "TmpAppId": "apm-6a79x94v", "TmpSecretId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "TmpSecretKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "ExpiredTime": 1559120000, diff --git a/tccli/examples/tsf/v20180326/DescribeEnabledUnitRule.md b/tccli/examples/tsf/v20180326/DescribeEnabledUnitRule.md index de164e864a..811c73a3a0 100644 --- a/tccli/examples/tsf/v20180326/DescribeEnabledUnitRule.md +++ b/tccli/examples/tsf/v20180326/DescribeEnabledUnitRule.md @@ -13,40 +13,40 @@ Output: ``` { "Response": { - "RequestId": "480c7535-a008-4851-8a36-2d921893ea1e", + "RequestId": "b378cebf-7ee2-4105-9ea0-58413051ea8e", "Result": { - "CreatedTime": "2023-01-17 11:41:36", - "Description": "sssase", + "CreatedTime": "2024-12-25 11:46:00", + "Description": "this is desc", "GatewayInstanceId": "gw-ins-szesmg28", - "Id": "unit-rl-2kdqa2my", - "Name": "test", + "Id": "unit-rl-u0643wrg", + "Name": "rule_app", "Status": "enabled", "UnitRuleItemList": [ { - "CreatedTime": "2023-02-10 16:36:12", - "Description": "gsshhshs", - "DestNamespaceId": "namespace-vk5blxnv", - "DestNamespaceName": "heihuli-global_default", - "Id": "unit-item-04futugp", + "CreatedTime": "2024-12-25 11:46:00", + "Description": "this is desc", + "DestNamespaceId": "namespace-aem6w6nv", + "DestNamespaceName": "heihuli-c_default", + "Id": "unit-item-vnj5nf3m", "ItemIndex": 1, - "Name": "Rule1", + "Name": "rule_user", "Priority": 0, "Relationship": "AND", - "UnitRuleId": "unit-rl-2kdqa2my", + "UnitRuleId": "unit-rl-u0643wrg", "UnitRuleTagList": [ { - "Id": "unit-tag-s2v06uy5", - "TagField": "test", + "Id": "unit-tag-8p9bpwh4", + "TagField": "user", "TagOperator": "IN", "TagType": "U", - "TagValue": "test222", - "UnitRuleItemId": "unit-item-04futugp" + "TagValue": "1", + "UnitRuleItemId": "unit-item-vnj5nf3m" } ], - "UpdatedTime": "2023-02-10 16:36:12" + "UpdatedTime": "2024-12-25 11:46:00" } ], - "UpdatedTime": "2023-02-23 17:42:23" + "UpdatedTime": "2024-12-25 11:50:01" } } } diff --git a/tccli/examples/tsf/v20180326/DescribeFileConfigReleases.md b/tccli/examples/tsf/v20180326/DescribeFileConfigReleases.md index e7d1976def..381025fd37 100644 --- a/tccli/examples/tsf/v20180326/DescribeFileConfigReleases.md +++ b/tccli/examples/tsf/v20180326/DescribeFileConfigReleases.md @@ -6,17 +6,39 @@ Input: ``` tccli tsf DescribeFileConfigReleases --cli-unfold-argument \ - --ConfigId dcfg-f-mae7g3v3 + --ConfigId dcfg-f-v3qqrkdy \ + --ConfigName conf_app \ + --GroupId group-vj3n6lzy \ + --NamespaceId namespace-ygo3djma \ + --ClusterId cls-f6bk82xc \ + --ApplicationId application-vw8ljmwv \ + --Offset 0 \ + --Limit 10 ``` Output: ``` { "Response": { - "RequestId": "6e6cc542-bc3a-4030-a9c8-8742e070e5d0", + "RequestId": "5620eba9-1673-4b3c-b375-591910b0fbc0", "Result": { - "TotalCount": 0, - "Content": [] + "Content": [ + { + "ClusterId": "cls-f6bk82xc", + "ClusterName": "cluster-container-jolyonzheng", + "ConfigId": "dcfg-f-v3qqrkdy", + "ConfigName": "conf_app", + "ConfigReleaseId": "dcfgr-f-vkjjw7ny", + "ConfigVersion": "2", + "GroupId": "group-vj3n6lzy", + "GroupName": "group-provider", + "NamespaceId": "namespace-ygo3djma", + "NamespaceName": "cluster-container-jolyonzheng_default", + "ReleaseDesc": "This is desc", + "ReleaseTime": "2024-11-28 20:49:57" + } + ], + "TotalCount": 1 } } } diff --git a/tccli/examples/tsf/v20180326/DescribeGroupRelease.md b/tccli/examples/tsf/v20180326/DescribeGroupRelease.md index aae7c57ed2..9e0a9d4a92 100644 --- a/tccli/examples/tsf/v20180326/DescribeGroupRelease.md +++ b/tccli/examples/tsf/v20180326/DescribeGroupRelease.md @@ -6,35 +6,90 @@ Input: ``` tccli tsf DescribeGroupRelease --cli-unfold-argument \ - --GroupId group-xxxxxx + --GroupId group-v6q747py ``` Output: ``` { "Response": { - "RequestId": "c033faca-041a-4357-a96d-xxxxxxxx", + "RequestId": "81d75b7e-8bec-47fd-bc65-c99bb24f569e", "Result": { - "PackageName": "consumer-demo-1.25.0-Greenwich-SNAPSHOT.jar", - "PackageVersion": "1.25.0", - "PackageId": "pkg-xxxxxx", + "ConfigReleaseList": [ + { + "ApplicationId": "application-vzoebl8a", + "ClusterId": "cls-i3v5y09e", + "ClusterName": "cls-app", + "ConfigCenters": [ + { + "ConfigCenterInstanceId": null, + "ConfigCenterInstanceName": null, + "ConfigType": "SHARE", + "CurrentVersion": null, + "RegionId": null, + "TargetVersion": null + } + ], + "ConfigId": "dcfg-a7rl7w4v", + "ConfigName": "conf-app", + "ConfigReleaseId": "dcfgr-ymw5965v", + "ConfigVersion": "v1", + "GroupId": "group-v6q747py", + "GroupName": "cloud-provider", + "NamespaceId": "namespace-vj3z3zgy", + "NamespaceName": "ns_default", + "ReleaseDesc": null, + "ReleaseTime": "2024-12-24 18:36:03" + } + ], + "FileConfigReleaseList": [ + { + "ClusterId": "cls-i3v5y09e", + "ClusterName": "cls-app", + "ConfigId": "dcfg-f-aeonjd6y", + "ConfigName": "config_app", + "ConfigReleaseId": "dcfgr-f-y84omela", + "ConfigVersion": "v1", + "GroupId": "group-v6q747py", + "GroupName": "cloud-provider", + "NamespaceId": "namespace-vj3z3zgy", + "NamespaceName": "ns_default", + "ReleaseDesc": null, + "ReleaseTime": "2024-12-24 18:37:50" + } + ], + "PackageId": "pkg-9198307d", + "PackageName": "msgw-zuul1-1.29.20-Hoxton-Higher-RELEASE.jar", + "PackageVersion": "20241223010307", "PublicConfigReleaseList": [ { - "ConfigReleaseId": "dcfgr-xxxxxx", - "ConfigId": "dcfg-p-xxxxxx", - "ConfigName": "n1", + "ApplicationId": null, + "ClusterId": null, + "ClusterName": null, + "ConfigCenters": [ + { + "ConfigCenterInstanceId": null, + "ConfigCenterInstanceName": null, + "ConfigType": "SHARE", + "CurrentVersion": null, + "RegionId": null, + "TargetVersion": null + } + ], + "ConfigId": "dcfg-p-vzk36rov", + "ConfigName": "config_pub_app", + "ConfigReleaseId": "dcfgr-yne579dy", "ConfigVersion": "v1", - "ReleaseTime": "2021-08-10 10:xx:xx", - "GroupId": "group-6a79x94v", - "GroupName": "group-mock", - "NamespaceId": "namespace-xxxxxxxx", - "NamespaceName": "default", - "ClusterId": "cls-6a79x94v", - "ClusterName": "cls-mock", - "ReleaseDesc": "this is a desc", - "ApplicationId": "application-6a79x94v" + "GroupId": null, + "GroupName": null, + "NamespaceId": "namespace-vj3z3zgy", + "NamespaceName": "ns_default", + "ReleaseDesc": null, + "ReleaseTime": "2024-12-24 18:36:54" } - ] + ], + "RepoName": "tsf_100011910000/app-provider", + "TagName": "20241212161801" } } } diff --git a/tccli/examples/tsf/v20180326/DescribeMicroservices.md b/tccli/examples/tsf/v20180326/DescribeMicroservices.md index 9b031ecc38..577f031998 100644 --- a/tccli/examples/tsf/v20180326/DescribeMicroservices.md +++ b/tccli/examples/tsf/v20180326/DescribeMicroservices.md @@ -6,30 +6,36 @@ Input: ``` tccli tsf DescribeMicroservices --cli-unfold-argument \ + --SearchWord consumer \ + --NamespaceId namespace-v6b2exey \ + --OrderBy create_time \ + --OrderType 1 \ --Offset 0 \ - --Limit 1 \ - --NamespaceId namespace-xxxxxxx \ - --SearchWord ms-xxxxxxx + --Limit 10 \ + --Status single_online \ + --MicroserviceIdList ms-yqwbbpxl \ + --MicroserviceNameList consumer-demo ``` Output: ``` { "Response": { - "RequestId": "3eab4695-2d7e-4f78-a8d2-ea93bab87dfd", + "RequestId": "31c18b1c-4e2e-4cb1-8b82-de820d178f12", "Result": { - "TotalCount": 1, "Content": [ { - "MicroserviceId": "ms-xxxxxxx", - "NamespaceId": "namespace-xxxxxxx", + "CreateTime": null, + "CriticalInstanceCount": 0, + "MicroserviceDesc": "", + "MicroserviceId": "ms-yqwbbpxl", "MicroserviceName": "consumer-demo", - "MicroserviceDesc": null, - "CreateTime": 1553673084000, - "UpdateTime": 1553673084000, - "RunInstanceCount": 1 + "NamespaceId": "namespace-v6b2exey", + "RunInstanceCount": 1, + "UpdateTime": null } - ] + ], + "TotalCount": 1 } } } diff --git a/tccli/examples/tsf/v20180326/DescribeMsApiList.md b/tccli/examples/tsf/v20180326/DescribeMsApiList.md index f581dee8a5..ade54ba76f 100644 --- a/tccli/examples/tsf/v20180326/DescribeMsApiList.md +++ b/tccli/examples/tsf/v20180326/DescribeMsApiList.md @@ -6,40 +6,27 @@ Input: ``` tccli tsf DescribeMsApiList --cli-unfold-argument \ - --Offset 0 \ - --Limit 20 \ - --MicroserviceId ms-opy5kjy4 + --MicroserviceId ms-y5w8n5e9 \ + --SearchWord echo-feign-url \ + --Limit 10 \ + --Offset 0 ``` Output: ``` { "Response": { - "RequestId": "056cc966-4963-4506-ac4c-c4e7209a41e3", + "RequestId": "17a35767-819f-4683-bc3f-5430e6d4513f", "Result": { - "TotalCount": 4, "Content": [ { - "Path": "/echo-async-rest/{str}", + "Description": "", "Method": "GET", - "Description": "(无)" - }, - { - "Path": "/echo-rest/{str}", - "Method": "GET", - "Description": "(无)" - }, - { - "Path": "/user-feign", - "Method": "GET", - "Description": "(无)" - }, - { - "Path": "/echo-feign/{str}", - "Method": "GET", - "Description": "(无)" + "Path": "/echo-feign-url/{str}", + "Status": 1 } - ] + ], + "TotalCount": 1 } } } diff --git a/tccli/examples/tsf/v20180326/DescribePluginInstances.md b/tccli/examples/tsf/v20180326/DescribePluginInstances.md index a4c144e984..2fc9756a72 100644 --- a/tccli/examples/tsf/v20180326/DescribePluginInstances.md +++ b/tccli/examples/tsf/v20180326/DescribePluginInstances.md @@ -6,30 +6,32 @@ Input: ``` tccli tsf DescribePluginInstances --cli-unfold-argument \ - --ScopeValue grp-83wrlmav \ - --Bound true \ + --ScopeValue grp-v446jrhc \ + --Bound True \ --Offset 0 \ - --Limit 10 + --Limit 10 \ + --Type QQMiniProgramLogin \ + --SearchWord pgnName ``` Output: ``` { "Response": { - "RequestId": "fa153f44-22b6-4ea3-86ef-6e257d440f26", + "RequestId": "b6b81196-b506-4758-a2ea-80ee688cf3b3", "Result": { - "TotalCount": 1, "Content": [ { - "Id": "pgn-33pk2soi", - "Name": "Tag认证插件", - "Type": "Tag", - "Description": "this is description", - "CreatedTime": "2019-11-02 15:43:09", - "UpdatedTime": "2019-11-02 17:30:51", - "Status": "drafted" + "CreatedTime": "2023-11-28 16:11:28", + "Description": "This is desc", + "Id": "pgn-if8otbfp", + "Name": "pgnName", + "Status": "released", + "Type": "QQMiniProgramLogin", + "UpdatedTime": "2023-11-28 16:11:27" } - ] + ], + "TotalCount": 1 } } } diff --git a/tccli/examples/tsf/v20180326/DescribePublicConfig.md b/tccli/examples/tsf/v20180326/DescribePublicConfig.md index d0c6ec064e..6535a07d69 100644 --- a/tccli/examples/tsf/v20180326/DescribePublicConfig.md +++ b/tccli/examples/tsf/v20180326/DescribePublicConfig.md @@ -6,27 +6,27 @@ Input: ``` tccli tsf DescribePublicConfig --cli-unfold-argument \ - --ConfigId dcfg-p-5yrl4z2y + --ConfigId dcfg-p-vkj5dnky ``` Output: ``` { "Response": { - "RequestId": "0fd83b45-ec19-45ad-9874-dbda7c4e84e6", + "RequestId": "8a143a46-4f13-4c9e-b536-9225ab88a55e", "Result": { - "ConfigId": "dcfg-p-5yrl4z2y", - "ConfigName": "test-config", - "ConfigVersion": "1.3", - "ConfigVersionDesc": "", - "ConfigValue": "tsf.inventory.password.encrypt2: ENC(3M7wGw2XtFc5Y+rxOgNBLrm2spUtgodjIxa+7F3XcAo=)\r\ntsf.inventory.password.encrypt1: ENC(3M7wGw2XtFc5Y+rxOgNBLrm2spUtgodjIxa+7F3XcAo=)\r\n", - "CreationTime": "2019-05-29 11:23:28", - "LastUpdateTime": null, - "ConfigVersionCount": null, "ApplicationId": null, "ApplicationName": null, + "ConfigId": "dcfg-p-vkj5dnky", + "ConfigName": "app-config", + "ConfigType": null, + "ConfigValue": "config: enabled", + "ConfigVersion": "v1", + "ConfigVersionCount": null, + "ConfigVersionDesc": "This is desc", + "CreationTime": "2024-12-20 19:16:10", "DeleteFlag": true, - "ConfigType": null + "LastUpdateTime": null } } } diff --git a/tccli/examples/tsf/v20180326/DescribePublicConfigReleaseLogs.md b/tccli/examples/tsf/v20180326/DescribePublicConfigReleaseLogs.md index 80285f25e1..c1f5a2b662 100644 --- a/tccli/examples/tsf/v20180326/DescribePublicConfigReleaseLogs.md +++ b/tccli/examples/tsf/v20180326/DescribePublicConfigReleaseLogs.md @@ -6,18 +6,58 @@ Input: ``` tccli tsf DescribePublicConfigReleaseLogs --cli-unfold-argument \ + --NamespaceId namespace-vj3z3zgy \ --Offset 0 \ - --Limit 20 + --Limit 10 ``` Output: ``` { "Response": { - "RequestId": "5748271c-3579-4f40-95b9-5f7b87f27388", + "RequestId": "168aec4c-c3fe-4abd-911b-ca9634e137dd", "Result": { - "TotalCount": 0, - "Content": [] + "Content": [ + { + "ClusterId": null, + "ClusterName": null, + "ConfigId": "dcfg-p-vzk36rov", + "ConfigName": "[配置项已被删除]", + "ConfigReleaseLogId": "dcfgrl-yrm5jx9v", + "ConfigVersion": "[配置项已被删除]", + "GroupId": null, + "GroupName": null, + "LastConfigId": "dcfg-p-vzk36rov", + "LastConfigName": "[配置项已被删除]", + "LastConfigVersion": "[配置项已被删除]", + "NamespaceId": "namespace-vj3z3zgy", + "NamespaceName": "ns_default", + "ReleaseDesc": "删除配置项", + "ReleaseStatus": "DS", + "ReleaseTime": "2024-12-24 20:30:37", + "RollbackFlag": false + }, + { + "ClusterId": null, + "ClusterName": null, + "ConfigId": "dcfg-p-vzk36rov", + "ConfigName": "[配置项已被删除]", + "ConfigReleaseLogId": "dcfgrl-vw83po6v", + "ConfigVersion": "[配置项已被删除]", + "GroupId": null, + "GroupName": null, + "LastConfigId": null, + "LastConfigName": null, + "LastConfigVersion": null, + "NamespaceId": "namespace-vj3z3zgy", + "NamespaceName": "ns_default", + "ReleaseDesc": null, + "ReleaseStatus": "S", + "ReleaseTime": "2024-12-24 18:36:54", + "RollbackFlag": false + } + ], + "TotalCount": 2 } } } diff --git a/tccli/examples/tsf/v20180326/DescribePublicConfigReleases.md b/tccli/examples/tsf/v20180326/DescribePublicConfigReleases.md index e05e1828c8..0af311e5b6 100644 --- a/tccli/examples/tsf/v20180326/DescribePublicConfigReleases.md +++ b/tccli/examples/tsf/v20180326/DescribePublicConfigReleases.md @@ -6,34 +6,47 @@ Input: ``` tccli tsf DescribePublicConfigReleases --cli-unfold-argument \ + --ConfigName configName \ + --NamespaceId namespace-yxoqm4ky \ + --Limit 10 \ --Offset 0 \ - --Limit 20 \ - --ConfigName ebs-demo + --ConfigId dcfg-p-v6kxdlpy ``` Output: ``` { "Response": { - "RequestId": "69d073be-25d1-4ba8-b1eb-92cdc21ad4ea", + "RequestId": "2435f045-963a-43da-a29b-581eb28069c0", "Result": { - "TotalCount": 1, "Content": [ { - "ConfigReleaseId": "dcfgr-gyqpwbpa", - "ConfigId": "dcfg-p-gvkwzpjv", - "ConfigName": "ebs-demo", - "ConfigVersion": "3.0", - "ReleaseTime": "2019-05-16 14:24:32", - "GroupId": null, - "GroupName": null, - "NamespaceId": "namespace-6yooxgdy", - "NamespaceName": "ebs-demo", + "ApplicationId": null, "ClusterId": null, "ClusterName": null, - "ReleaseDesc": null + "ConfigCenters": [ + { + "ConfigCenterInstanceId": null, + "ConfigCenterInstanceName": null, + "ConfigType": "SHARE", + "CurrentVersion": null, + "RegionId": null, + "TargetVersion": null + } + ], + "ConfigId": "dcfg-p-v6kxdlpy", + "ConfigName": "configName", + "ConfigReleaseId": "dcfgr-y446nlby", + "ConfigVersion": "1", + "GroupId": null, + "GroupName": null, + "NamespaceId": "namespace-yxoqm4ky", + "NamespaceName": "ns_default", + "ReleaseDesc": null, + "ReleaseTime": "2024-09-11 17:27:59" } - ] + ], + "TotalCount": 1 } } } diff --git a/tccli/examples/tsf/v20180326/DescribePublicConfigSummary.md b/tccli/examples/tsf/v20180326/DescribePublicConfigSummary.md index c5a0f3abf6..6b09ab6724 100644 --- a/tccli/examples/tsf/v20180326/DescribePublicConfigSummary.md +++ b/tccli/examples/tsf/v20180326/DescribePublicConfigSummary.md @@ -6,47 +6,39 @@ Input: ``` tccli tsf DescribePublicConfigSummary --cli-unfold-argument \ + --SearchWord app \ --Offset 0 \ - --Limit 20 + --Limit 10 \ + --OrderBy creation_time \ + --OrderType 1 \ + --ConfigTagList app-config \ + --DisableProgramAuthCheck True \ + --ConfigIdList dcfg-p-vkj5dnky ``` Output: ``` { "Response": { - "RequestId": "cc75758b-a2e3-4ded-a97a-c541817b4efe", + "RequestId": "d6da2add-172a-4a4d-8f30-8abca66e314f", "Result": { - "TotalCount": 2, "Content": [ { - "ConfigId": null, - "ConfigName": "global", - "ConfigVersion": null, - "ConfigVersionDesc": null, - "ConfigValue": null, - "CreationTime": null, - "LastUpdateTime": "2019-05-24 20:39:12", - "ConfigVersionCount": 6, "ApplicationId": null, "ApplicationName": null, - "DeleteFlag": null, - "ConfigType": null - }, - { - "ConfigId": null, - "ConfigName": "tsf", + "ConfigId": "dcfg-p-vkj5dnky", + "ConfigName": "app-config", + "ConfigType": null, + "ConfigValue": null, "ConfigVersion": null, + "ConfigVersionCount": 1, "ConfigVersionDesc": null, - "ConfigValue": null, "CreationTime": null, - "LastUpdateTime": "2019-05-21 14:50:13", - "ConfigVersionCount": 4, - "ApplicationId": null, - "ApplicationName": null, "DeleteFlag": null, - "ConfigType": null + "LastUpdateTime": "2024-12-20 19:16:10" } - ] + ], + "TotalCount": 1 } } } diff --git a/tccli/examples/tsf/v20180326/DescribeReleasedConfig.md b/tccli/examples/tsf/v20180326/DescribeReleasedConfig.md index 6f778fbaf1..f24be458d4 100644 --- a/tccli/examples/tsf/v20180326/DescribeReleasedConfig.md +++ b/tccli/examples/tsf/v20180326/DescribeReleasedConfig.md @@ -6,15 +6,15 @@ Input: ``` tccli tsf DescribeReleasedConfig --cli-unfold-argument \ - --GroupId group-qv382dy7 + --GroupId group-jy9re3gy ``` Output: ``` { "Response": { - "RequestId": "2f65737d-7707-43b7-b024-b8aff844ab8f", - "Result": "spring:\n servlet:\n multipart:\n max-file-size: 100MB\n max-request-size: 100MB\n jackson:\n serialization:\n write-dates-as-timestamps: true\n data:\n mongodb:\n uri: mongodb://commentuser:9xa#Lkp6sT@10.10.11.13:27017/comment\n dubbo:\n registry:\n protocol: dubbo\n address: tsfconsul://169.254.0.77:8000\n datasource:\n url: jdbc:mysql:replication://10.10.2.148:3306,10.10.2.148:3306,10.10.2.148:3306/rrmj2?roundRobinLoadBalance=true\n username: rrtvappuser\n " + "RequestId": "6ec73c01-a942-4c6c-9630-b25e53745a43", + "Result": "config: enabled\n" } } ``` diff --git a/tccli/examples/tsf/v20180326/DisableUnitRoute.md b/tccli/examples/tsf/v20180326/DisableUnitRoute.md index e88689174a..17d963d96c 100644 --- a/tccli/examples/tsf/v20180326/DisableUnitRoute.md +++ b/tccli/examples/tsf/v20180326/DisableUnitRoute.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf DisableUnitRoute --cli-unfold-argument \ - --Id gw-ins-l6ymbvgd + --Id gw-ins-szesmg28 ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "6e650435-e3b2-472d-af7a-5d5452db8bf3", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/DisableUnitRule.md b/tccli/examples/tsf/v20180326/DisableUnitRule.md index 19cf2e3b95..e72ff0fb65 100644 --- a/tccli/examples/tsf/v20180326/DisableUnitRule.md +++ b/tccli/examples/tsf/v20180326/DisableUnitRule.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf DisableUnitRule --cli-unfold-argument \ - --Id gw-ins-afsfas + --Id unit-rl-u0643wrg ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "2a814838-8198-4943-9d97-04bc7ede98a9", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/DraftApiGroup.md b/tccli/examples/tsf/v20180326/DraftApiGroup.md index 2af7c66038..781013a5f6 100644 --- a/tccli/examples/tsf/v20180326/DraftApiGroup.md +++ b/tccli/examples/tsf/v20180326/DraftApiGroup.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf DraftApiGroup --cli-unfold-argument \ - --GroupId grp-5yk7oor1 + --GroupId grp-d45mlt3o ``` Output: ``` { "Response": { - "RequestId": "5d996e05507e42d5970cd2e25ed5267a", + "RequestId": "5024ce23-0ac6-4ca3-9061-e1c4666c9c0d", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/EnableLaneRule.md b/tccli/examples/tsf/v20180326/EnableLaneRule.md index 6a7301ca3a..6c58159237 100644 --- a/tccli/examples/tsf/v20180326/EnableLaneRule.md +++ b/tccli/examples/tsf/v20180326/EnableLaneRule.md @@ -6,15 +6,15 @@ Input: ``` tccli tsf EnableLaneRule --cli-unfold-argument \ - --RuleId lane-r-fdjsklafjdsa + --RuleId lane-r-yqg4kmbd ``` Output: ``` { "Response": { - "Result": true, - "RequestId": "abc" + "RequestId": "265f638d-1998-494b-a794-1abe86d5eecc", + "Result": true } } ``` diff --git a/tccli/examples/tsf/v20180326/EnableUnitRoute.md b/tccli/examples/tsf/v20180326/EnableUnitRoute.md index fdff1d2a53..7a4decfb20 100644 --- a/tccli/examples/tsf/v20180326/EnableUnitRoute.md +++ b/tccli/examples/tsf/v20180326/EnableUnitRoute.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf EnableUnitRoute --cli-unfold-argument \ - --Id gw-ins-l6ymbvgd + --Id gw-ins-szesmg28 ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "e81e7880-ad81-4e97-b3e2-01901f913e35", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/EnableUnitRule.md b/tccli/examples/tsf/v20180326/EnableUnitRule.md index f7f190db3f..7db1009b68 100644 --- a/tccli/examples/tsf/v20180326/EnableUnitRule.md +++ b/tccli/examples/tsf/v20180326/EnableUnitRule.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf EnableUnitRule --cli-unfold-argument \ - --Id gw-ins-afsfas + --Id unit-rl-u0643wrg ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "dc5fd463-2889-4c5c-b662-98a70a149b95", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/ModifyLane.md b/tccli/examples/tsf/v20180326/ModifyLane.md index e5209fd8f2..bf8843d115 100644 --- a/tccli/examples/tsf/v20180326/ModifyLane.md +++ b/tccli/examples/tsf/v20180326/ModifyLane.md @@ -6,17 +6,17 @@ Input: ``` tccli tsf ModifyLane --cli-unfold-argument \ - --LaneId 1 \ - --LaneName 1 \ - --Remark 1 + --LaneId lane-ap62k7ol \ + --LaneName rule_app \ + --Remark This is desc ``` Output: ``` { "Response": { - "Result": true, - "RequestId": "abc" + "RequestId": "3ad3847e-b102-4b45-8f90-bb64112cc27f", + "Result": true } } ``` diff --git a/tccli/examples/tsf/v20180326/ModifyMicroservice.md b/tccli/examples/tsf/v20180326/ModifyMicroservice.md index 09b970c00c..de6064038b 100644 --- a/tccli/examples/tsf/v20180326/ModifyMicroservice.md +++ b/tccli/examples/tsf/v20180326/ModifyMicroservice.md @@ -6,14 +6,15 @@ Input: ``` tccli tsf ModifyMicroservice --cli-unfold-argument \ - --MicroserviceId ms-xxxxxxx + --MicroserviceId ms-yd8dr5bx \ + --MicroserviceDesc This is desc ``` Output: ``` { "Response": { - "RequestId": "4304b189-8663-453d-8863-1f238f6c4fb0", + "RequestId": "414386f9-834d-42ce-af55-532202e82031", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/ModifyPathRewrite.md b/tccli/examples/tsf/v20180326/ModifyPathRewrite.md index c4cc74f913..9fb4cabdb0 100644 --- a/tccli/examples/tsf/v20180326/ModifyPathRewrite.md +++ b/tccli/examples/tsf/v20180326/ModifyPathRewrite.md @@ -6,15 +6,18 @@ Input: ``` tccli tsf ModifyPathRewrite --cli-unfold-argument \ - --PathRewriteId rewrite-l6ymbvgd \ - --Order 100 + --PathRewriteId rewrite-ba22pbpa \ + --Regex /consumer \ + --Replacement /provider \ + --Blocked N \ + --Order 1 ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "6b194892-2c0a-41d3-93e1-e4b293b0fde8", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/ReleaseApiGroup.md b/tccli/examples/tsf/v20180326/ReleaseApiGroup.md index 6aa741f97d..e9359814ed 100644 --- a/tccli/examples/tsf/v20180326/ReleaseApiGroup.md +++ b/tccli/examples/tsf/v20180326/ReleaseApiGroup.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf ReleaseApiGroup --cli-unfold-argument \ - --GroupId grp-5yk7oor1 + --GroupId grp-d45mlt3o ``` Output: ``` { "Response": { - "RequestId": "5d996e05507e42d5970cd2e25ed5267a", + "RequestId": "b6608391-3bb1-4c83-9ecb-9c935bea46c5", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/ReleaseConfig.md b/tccli/examples/tsf/v20180326/ReleaseConfig.md index 8f7b7b0c0b..cc107a6357 100644 --- a/tccli/examples/tsf/v20180326/ReleaseConfig.md +++ b/tccli/examples/tsf/v20180326/ReleaseConfig.md @@ -6,15 +6,16 @@ Input: ``` tccli tsf ReleaseConfig --cli-unfold-argument \ - --ConfigId dcfg-zvw6kxa8 \ - --GroupId group-nalqbgvq + --ConfigId dcfg-vzk36owv \ + --GroupId group-9yn684ev \ + --ReleaseDesc This is desc ``` Output: ``` { "Response": { - "RequestId": "36ccafba-c8ab-4d15-a4f1-4cfd2070d1d3", + "RequestId": "10320d7c-65ed-4ddd-bf21-6f33b23fed73", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/ReleaseConfigWithDetailResp.md b/tccli/examples/tsf/v20180326/ReleaseConfigWithDetailResp.md index 66a58d7d29..9903b98ca6 100644 --- a/tccli/examples/tsf/v20180326/ReleaseConfigWithDetailResp.md +++ b/tccli/examples/tsf/v20180326/ReleaseConfigWithDetailResp.md @@ -6,31 +6,32 @@ Input: ``` tccli tsf ReleaseConfigWithDetailResp --cli-unfold-argument \ - --ConfigId configId-xxxxxxx \ - --GroupId gourp-xxxxxx \ - --ReleaseDesc demo config realse + --ConfigId dcfg-yo82mmra \ + --GroupId group-aln2284v \ + --ReleaseDesc This is desc ``` Output: ``` { "Response": { + "RequestId": "1892e2c1-9223-4979-bf25-1935c7eeed12", "Result": { - "ConfigReleaseId": "dcfgr-xxxxxx", - "ConfigId": "null", - "ConfigName": "null", - "ConfigVersion": "null", - "ReleaseTime": "null", - "GroupId": "null", - "GroupName": "null", - "NamespaceId": "null", - "NamespaceName": "null", - "ClusterId": "null", - "ClusterName": "null", - "ReleaseDesc": "null", - "ApplicationId": "null" - }, - "RequestId": "36ccafba-c8ab-4d15-a4f1-4cfd2070d1d3" + "ApplicationId": null, + "ClusterId": null, + "ClusterName": null, + "ConfigCenters": null, + "ConfigId": null, + "ConfigName": null, + "ConfigReleaseId": "dcfgr-yxd366ov", + "ConfigVersion": null, + "GroupId": null, + "GroupName": null, + "NamespaceId": null, + "NamespaceName": null, + "ReleaseDesc": null, + "ReleaseTime": null + } } } ``` diff --git a/tccli/examples/tsf/v20180326/ReleasePublicConfig.md b/tccli/examples/tsf/v20180326/ReleasePublicConfig.md index 6d85e1e377..95c2429bdf 100644 --- a/tccli/examples/tsf/v20180326/ReleasePublicConfig.md +++ b/tccli/examples/tsf/v20180326/ReleasePublicConfig.md @@ -6,15 +6,16 @@ Input: ``` tccli tsf ReleasePublicConfig --cli-unfold-argument \ - --ConfigId dcfg-p-4y46okga \ - --NamespaceId namespace-ov6l235v + --ConfigId dcfg-p-vkj5dnky \ + --NamespaceId namespace-vw46q85y \ + --ReleaseDesc This is desc ``` Output: ``` { "Response": { - "RequestId": "5a20177f-0949-4e38-8c71-d77159586c04", + "RequestId": "d60fcd87-e9d0-475c-89f5-1e76a035d404", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/RevocationConfig.md b/tccli/examples/tsf/v20180326/RevocationConfig.md index ff0235aa6a..4de0e1e4cf 100644 --- a/tccli/examples/tsf/v20180326/RevocationConfig.md +++ b/tccli/examples/tsf/v20180326/RevocationConfig.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf RevocationConfig --cli-unfold-argument \ - --ConfigReleaseId dcfgr-jy9no5ka + --ConfigReleaseId dcfgr-y84o2xla ``` Output: ``` { "Response": { - "RequestId": "64e5494d-ae5d-4114-abe7-c34d8719415e", + "RequestId": "f860eb0c-7a37-48e4-ba23-f246f5e93e41", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/RevocationPublicConfig.md b/tccli/examples/tsf/v20180326/RevocationPublicConfig.md index 0a097a5cf1..ec706712d3 100644 --- a/tccli/examples/tsf/v20180326/RevocationPublicConfig.md +++ b/tccli/examples/tsf/v20180326/RevocationPublicConfig.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf RevocationPublicConfig --cli-unfold-argument \ - --ConfigReleaseId dcfgr-oydloz5a + --ConfigReleaseId dcfgr-a7rldd9v ``` Output: ``` { "Response": { - "RequestId": "14650572-a12a-4cb0-b2f9-2ff8ee0abae2", + "RequestId": "9385599f-d33a-4d36-a1c6-8ab6ac79d8df", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/RevokeFileConfig.md b/tccli/examples/tsf/v20180326/RevokeFileConfig.md index f730bc0cc5..96a08de141 100644 --- a/tccli/examples/tsf/v20180326/RevokeFileConfig.md +++ b/tccli/examples/tsf/v20180326/RevokeFileConfig.md @@ -6,14 +6,14 @@ Input: ``` tccli tsf RevokeFileConfig --cli-unfold-argument \ - --ConfigReleaseId dcfgr-f-dapp63ao + --ConfigReleaseId dcfgr-f-aeon99ry ``` Output: ``` { "Response": { - "RequestId": "3641f31a-a1ac-4733-8430-efe9f4c9f1d7", + "RequestId": "f5788a08-6f8c-4c64-8c7c-89abf3f35c86", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/UnbindApiGroup.md b/tccli/examples/tsf/v20180326/UnbindApiGroup.md index fe1f7f91c3..0237be9741 100644 --- a/tccli/examples/tsf/v20180326/UnbindApiGroup.md +++ b/tccli/examples/tsf/v20180326/UnbindApiGroup.md @@ -6,15 +6,15 @@ Input: ``` tccli tsf UnbindApiGroup --cli-unfold-argument \ - --GroupGatewayList.0.GatewayDeployGroupId group-qabo8xyl \ - --GroupGatewayList.0.GroupId grp-i54lzdrq + --GroupGatewayList.0.GatewayDeployGroupId group-yo99lney \ + --GroupGatewayList.0.GroupId grp-notmqbpe ``` Output: ``` { "Response": { - "RequestId": "5d996e05507e42d5970cd2e25ed5267a", + "RequestId": "e602a33a-7ddd-44ad-b55b-790afb4eac25", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/UpdateApiGroup.md b/tccli/examples/tsf/v20180326/UpdateApiGroup.md index 002fe4e033..9f61e2f10d 100644 --- a/tccli/examples/tsf/v20180326/UpdateApiGroup.md +++ b/tccli/examples/tsf/v20180326/UpdateApiGroup.md @@ -6,15 +6,22 @@ Input: ``` tccli tsf UpdateApiGroup --cli-unfold-argument \ - --GroupName new-name \ - --GroupId grp-grp-5yk7oor1 + --GroupId grp-notmqbpe \ + --GroupName grp_app \ + --Description This is desc \ + --AuthType none \ + --GroupContext /grp_app \ + --NamespaceNameKey TSF-NamespaceName \ + --ServiceNameKey TSF-ServiceName \ + --NamespaceNameKeyPosition path \ + --ServiceNameKeyPosition path ``` Output: ``` { "Response": { - "RequestId": "5d996e05507e42d5970cd2e25ed5267a", + "RequestId": "9bcb4936-f3e5-4fdc-acd8-71fd041429e8", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/UpdateApiRateLimitRule.md b/tccli/examples/tsf/v20180326/UpdateApiRateLimitRule.md index 19594ef3d3..872fa67e5a 100644 --- a/tccli/examples/tsf/v20180326/UpdateApiRateLimitRule.md +++ b/tccli/examples/tsf/v20180326/UpdateApiRateLimitRule.md @@ -6,17 +6,17 @@ Input: ``` tccli tsf UpdateApiRateLimitRule --cli-unfold-argument \ - --RuleId rule-d5970cd2 \ + --RuleId rule-8qlpdumd \ --UsableStatus enabled \ - --MaxQps 1000 + --MaxQps 2000 ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", - "Result": false + "RequestId": "ebba8f15-b795-4bdc-b881-049e33ef3fcb", + "Result": true } } ``` diff --git a/tccli/examples/tsf/v20180326/UpdateApiRateLimitRules.md b/tccli/examples/tsf/v20180326/UpdateApiRateLimitRules.md index 60079b63d2..f9c0762f88 100644 --- a/tccli/examples/tsf/v20180326/UpdateApiRateLimitRules.md +++ b/tccli/examples/tsf/v20180326/UpdateApiRateLimitRules.md @@ -6,7 +6,7 @@ Input: ``` tccli tsf UpdateApiRateLimitRules --cli-unfold-argument \ - --ApiIds api-d5970cd api-d5971cd \ + --ApiIds api-b1sd366q \ --UsableStatus enabled \ --MaxQps 1000 ``` @@ -15,7 +15,7 @@ Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "94bddd45-fd4c-4192-aea2-5eeb5b74d5b6", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/UpdateApiTimeouts.md b/tccli/examples/tsf/v20180326/UpdateApiTimeouts.md index 0692d128ab..9a0fb0725a 100644 --- a/tccli/examples/tsf/v20180326/UpdateApiTimeouts.md +++ b/tccli/examples/tsf/v20180326/UpdateApiTimeouts.md @@ -6,16 +6,16 @@ Input: ``` tccli tsf UpdateApiTimeouts --cli-unfold-argument \ - --ApiIds api-d5970cd api-d5971cd \ + --ApiIds api-tnvxy4ta \ --UsableStatus enabled \ - --Timeout 10000 + --Timeout 2000 ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "30356074-f0ce-46a3-86fd-30da5fcf336e", "Result": true } } diff --git a/tccli/examples/tsf/v20180326/UpdateGatewayApi.md b/tccli/examples/tsf/v20180326/UpdateGatewayApi.md index 8f0bc54210..84bc4f3ba1 100644 --- a/tccli/examples/tsf/v20180326/UpdateGatewayApi.md +++ b/tccli/examples/tsf/v20180326/UpdateGatewayApi.md @@ -6,17 +6,19 @@ Input: ``` tccli tsf UpdateGatewayApi --cli-unfold-argument \ - --ApiId api-5yk7oor1 \ - --Path /user/find \ - --Method POST \ - --PathMapping /user/find + --ApiId api-zwua4plw \ + --Path /echo-user \ + --Method GET \ + --PathMapping /echo-user \ + --Host http://www.qq.com \ + --Description this is desc ``` Output: ``` { "Response": { - "RequestId": "5d996e5507e42d5970cd2e25ed5267a", + "RequestId": "c17753d4-a08b-4d4a-b8f5-a4160ff02c6d", "Result": true } } diff --git a/tccli/examples/vpc/v20170312/CreateCustomerGateway.md b/tccli/examples/vpc/v20170312/CreateCustomerGateway.md index aced7db09d..e618483d52 100644 --- a/tccli/examples/vpc/v20170312/CreateCustomerGateway.md +++ b/tccli/examples/vpc/v20170312/CreateCustomerGateway.md @@ -18,9 +18,10 @@ Output: "Response": { "CustomerGateway": { "CustomerGatewayId": "cgw-mgp33pll", - "IpAddress": "58.211.1.12", - "CustomerGatewayName": "test-cgw", - "CreatedTime": "2018-04-18 10:00:00" + "CustomerGatewayName": "cgw-name", + "IpAddress": "58.21.1.12", + "CreatedTime": "2023-05-29 11:28:45", + "BgpAsn": 141 }, "RequestId": "5bd98433-263a-47b6-9a1c-84aa613a8ff6" } diff --git a/tccli/examples/vpc/v20170312/DownloadVpnGatewaySslClientCert.md b/tccli/examples/vpc/v20170312/DownloadVpnGatewaySslClientCert.md index 1a4a078346..b73acaa5dc 100644 --- a/tccli/examples/vpc/v20170312/DownloadVpnGatewaySslClientCert.md +++ b/tccli/examples/vpc/v20170312/DownloadVpnGatewaySslClientCert.md @@ -13,18 +13,18 @@ Output: ``` { "Response": { - "SslClientConfigsSet": "abc", + "SslClientConfigsSet": "{\"SslVpnClientConfiguration\": \"-config-\"......}", "SslClientConfig": [ { - "SslVpnClientConfiguration": "abc", - "SslVpnRootCert": "abc", - "SslVpnKey": "abc", - "SslVpnCert": "abc", - "SslVpnClientId": "abc" + "SslVpnClientConfiguration": "config...", + "SslVpnRootCert": "CERTIFICATE...", + "SslVpnKey": "PRIVATE KEY...", + "SslVpnCert": "CERTIFICATE...", + "SslVpnClientId": "vpnc-axa315c" } ], "Authenticated": 1, - "RequestId": "abc" + "RequestId": "8e08f027-048b-41e8-ac99-77e954ca15c5" } } ``` diff --git a/tccli/examples/vpc/v20170312/InquiryPriceAllocateAddresses.md b/tccli/examples/vpc/v20170312/InquiryPriceAllocateAddresses.md new file mode 100644 index 0000000000..d0048ccd53 --- /dev/null +++ b/tccli/examples/vpc/v20170312/InquiryPriceAllocateAddresses.md @@ -0,0 +1,87 @@ +**Example 1: 小时流量计费模式弹性公网IP询价** + +小时流量计费模式弹性公网IP询价。 + +Input: + +``` +tccli vpc InquiryPriceAllocateAddresses --cli-unfold-argument \ + --AddressType EIP \ + --InternetMaxBandwidthOut 1 \ + --InternetChargeType TRAFFIC_POSTPAID_BY_HOUR +``` + +Output: +``` +{ + "Response": { + "Price": { + "AddressPrice": { + "ChargeUnit": "HOUR", + "UnitPrice": 0.8, + "DiscountPrice": 0.8 + } + }, + "RequestId": "90d508a8-9ee8-4220-9c8e-9faeedce3ab4" + } +} +``` + +**Example 2: 小时带宽计费模式弹性公网IP询价** + +小时带宽计费模式弹性公网IP询价。 + +Input: + +``` +tccli vpc InquiryPriceAllocateAddresses --cli-unfold-argument \ + --AddressType EIP \ + --InternetMaxBandwidthOut 1 \ + --InternetChargeType BANDWIDTH_POSTPAID_BY_HOUR +``` + +Output: +``` +{ + "Response": { + "Price": { + "AddressPrice": { + "UnitPrice": 0.063, + "DiscountPrice": 0.063, + "ChargeUnit": "HOUR" + } + }, + "RequestId": "ebc826be-ec1a-4522-b08f-8da3fe5adedc" + } +} +``` + +**Example 3: 包月带宽计费模式弹性公网IP询价** + +包月带宽计费模式弹性公网IP询价。 + +Input: + +``` +tccli vpc InquiryPriceAllocateAddresses --cli-unfold-argument \ + --AddressChargePrepaid.Period 1 \ + --AddressType EIP \ + --InternetChargeType BANDWIDTH_PREPAID_BY_MONTH \ + --InternetMaxBandwidthOut 1 +``` + +Output: +``` +{ + "Response": { + "Price": { + "AddressPrice": { + "OriginalPrice": 20, + "DiscountPrice": 20 + } + }, + "RequestId": "136605f0-ca35-4d22-9b77-e053168fa25f" + } +} +``` + diff --git a/tccli/examples/vpc/v20170312/InquiryPriceModifyAddressesBandwidth.md b/tccli/examples/vpc/v20170312/InquiryPriceModifyAddressesBandwidth.md new file mode 100644 index 0000000000..42a8205a2c --- /dev/null +++ b/tccli/examples/vpc/v20170312/InquiryPriceModifyAddressesBandwidth.md @@ -0,0 +1,83 @@ +**Example 1: 小时流量EIP修改带宽询价** + +小时流量EIP修改带宽询价。 + +Input: + +``` +tccli vpc InquiryPriceModifyAddressesBandwidth --cli-unfold-argument \ + --InternetMaxBandwidthOut 2 \ + --AddressIds eip-hxlqja90 +``` + +Output: +``` +{ + "Response": { + "Price": { + "AddressPrice": { + "UnitPrice": 0.8, + "DiscountPrice": 0.8, + "ChargeUnit": "HOUR" + } + }, + "RequestId": "7daad6af-50de-4df5-8238-0d76c7be62e1" + } +} +``` + +**Example 2: 小时带宽EIP修改带宽询价** + +小时带宽EIP修改带宽询价。 + +Input: + +``` +tccli vpc InquiryPriceModifyAddressesBandwidth --cli-unfold-argument \ + --AddressIds eip-3hwtklhj \ + --InternetMaxBandwidthOut 5 +``` + +Output: +``` +{ + "Response": { + "Price": { + "AddressPrice": { + "UnitPrice": 0.315, + "DiscountPrice": 0.315, + "ChargeUnit": "HOUR" + } + }, + "RequestId": "db071565-27cb-482a-a3fe-1c7bba77e4a9" + } +} +``` + +**Example 3: 包月带宽EIP调整带宽询价** + +包月带宽EIP调整带宽询价。 + +Input: + +``` +tccli vpc InquiryPriceModifyAddressesBandwidth --cli-unfold-argument \ + --AddressIds eip-iu4ml5pp \ + --InternetMaxBandwidthOut 5 +``` + +Output: +``` +{ + "Response": { + "Price": { + "AddressPrice": { + "OriginalPrice": 95, + "DiscountPrice": 95 + } + }, + "RequestId": "ddf8edf2-0457-4ba7-b2ab-e66e98823cc6" + } +} +``` + diff --git a/tccli/examples/vpc/v20170312/InquiryPriceRenewAddresses.md b/tccli/examples/vpc/v20170312/InquiryPriceRenewAddresses.md new file mode 100644 index 0000000000..4a71596f13 --- /dev/null +++ b/tccli/examples/vpc/v20170312/InquiryPriceRenewAddresses.md @@ -0,0 +1,27 @@ +**Example 1: 包月带宽计费模式EIP续费询价** + + + +Input: + +``` +tccli vpc InquiryPriceRenewAddresses --cli-unfold-argument \ + --AddressIds eip-iu4ml5pp \ + --AddressChargePrepaid.Period 12 +``` + +Output: +``` +{ + "Response": { + "Price": { + "AddressPrice": { + "OriginalPrice": 240, + "DiscountPrice": 240 + } + }, + "RequestId": "84658acc-bdb9-4a3e-a37a-84a2e0c14e44" + } +} +``` + diff --git a/tccli/examples/vpc/v20170312/InquiryPriceRenewVpnGateway.md b/tccli/examples/vpc/v20170312/InquiryPriceRenewVpnGateway.md index 4600e8490c..67a295b7a3 100644 --- a/tccli/examples/vpc/v20170312/InquiryPriceRenewVpnGateway.md +++ b/tccli/examples/vpc/v20170312/InquiryPriceRenewVpnGateway.md @@ -1,14 +1,14 @@ **Example 1: 包年包月网关续费网关询价输入** - +包年包月网关续费网关询价输入 Input: ``` tccli vpc InquiryPriceRenewVpnGateway --cli-unfold-argument \ - --Version 2017-03-12 \ - --VpnGatewayId vpngw-lazly92z \ - --InstanceChargePrepaid.Period 2 + --VpnGatewayId vpngw-abcxa123z \ + --InstanceChargePrepaid.Period 1 \ + --InstanceChargePrepaid.RenewFlag NOTIFY_AND_AUTO_RENEW ``` Output: @@ -17,8 +17,16 @@ Output: "Response": { "Price": { "InstancePrice": { - "OriginalPrice": 760.0, - "DiscountPrice": 760.0 + "OriginalPrice": 380.0, + "DiscountPrice": 177.4, + "UnitPrice": 0.0, + "ChargeUnit": "" + }, + "BandwidthPrice": { + "OriginalPrice": 0.0, + "DiscountPrice": 0.0, + "UnitPrice": 0.0, + "ChargeUnit": "" } }, "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b" diff --git a/tccli/examples/vpc/v20170312/ModifyVpnConnectionAttribute.md b/tccli/examples/vpc/v20170312/ModifyVpnConnectionAttribute.md index a221246767..22462ad421 100644 --- a/tccli/examples/vpc/v20170312/ModifyVpnConnectionAttribute.md +++ b/tccli/examples/vpc/v20170312/ModifyVpnConnectionAttribute.md @@ -8,7 +8,7 @@ Input: tccli vpc ModifyVpnConnectionAttribute --cli-unfold-argument \ --VpnConnectionName test-abc \ --VpnConnectionId vpnx-abc123x \ - --PreShareKey 123 \ + --PreShareKey qwer12ty \ --EnableHealthCheck false ``` diff --git a/tccli/examples/vpc/v20170312/RenewVpnGateway.md b/tccli/examples/vpc/v20170312/RenewVpnGateway.md index d1ff9ba7a6..ebbab76a4c 100644 --- a/tccli/examples/vpc/v20170312/RenewVpnGateway.md +++ b/tccli/examples/vpc/v20170312/RenewVpnGateway.md @@ -1,14 +1,14 @@ **Example 1: 续费VPN网关** - +续费VPN网关 Input: ``` tccli vpc RenewVpnGateway --cli-unfold-argument \ - --Version 2017-03-12 \ --VpnGatewayId vpngw-lazly92z \ - --InstanceChargePrepaid.Period 2 + --InstanceChargePrepaid.Period 1 \ + --InstanceChargePrepaid.RenewFlag NOTIFY_AND_AUTO_RENEW ``` Output: diff --git a/tccli/examples/waf/v20180125/CreateAreaBanRule.md b/tccli/examples/waf/v20180125/CreateAreaBanRule.md new file mode 100644 index 0000000000..82b2ac8a7d --- /dev/null +++ b/tccli/examples/waf/v20180125/CreateAreaBanRule.md @@ -0,0 +1,31 @@ +**Example 1: 添加地域封禁规则** + + + +Input: + +``` +tccli waf CreateAreaBanRule --cli-unfold-argument \ + --Domain www.testwaf.com \ + --Areas.0.Country 中国 \ + --Areas.0.Region 广东 \ + --Areas.0.City 深圳 \ + --JobType CronJob \ + --JobDateTime.Timed.0.StartDateTime 1711618518 \ + --JobDateTime.Timed.0.EndDateTime 1711918518 \ + --JobDateTime.Cron.0.WDays 2 \ + --JobDateTime.Cron.0.StartTime 12:11 \ + --JobDateTime.Cron.0.EndTime 21:00 \ + --JobDateTime.TimeTZone UTC+8 \ + --Lang cn +``` + +Output: +``` +{ + "Response": { + "RequestId": "9b02bf9e-c89c-42c3-9ae1-685f968fa02d" + } +} +``` + diff --git a/tccli/examples/waf/v20180125/DescribeAreaBanRule.md b/tccli/examples/waf/v20180125/DescribeAreaBanRule.md new file mode 100644 index 0000000000..bb8d0d6660 --- /dev/null +++ b/tccli/examples/waf/v20180125/DescribeAreaBanRule.md @@ -0,0 +1,43 @@ +**Example 1: 获取地域封禁规则** + + + +Input: + +``` +tccli waf DescribeAreaBanRule --cli-unfold-argument \ + --Domain www.testwaf.com +``` + +Output: +``` +{ + "Response": { + "Data": { + "Status": 1, + "Source": "custom", + "Areas": [ + { + "Country": "中国", + "Region": "广东", + "City": "深圳" + } + ], + "JobType": "Timed", + "JobDateTime": { + "Timed": [ + { + "StartDateTime": 1711618518, + "EndDateTime": 1711919518 + } + ], + "Cron": [], + "TimeTZone": "UTC+8" + }, + "Lang": "cn" + }, + "RequestId": "9b02bf9e-c89c-42c3-9ae1-685f968fa02d" + } +} +``` + diff --git a/tccli/examples/waf/v20180125/ModifyAreaBanRule.md b/tccli/examples/waf/v20180125/ModifyAreaBanRule.md new file mode 100644 index 0000000000..637ed5c0a6 --- /dev/null +++ b/tccli/examples/waf/v20180125/ModifyAreaBanRule.md @@ -0,0 +1,30 @@ +**Example 1: 编辑地域封禁规则** + + + +Input: + +``` +tccli waf ModifyAreaBanRule --cli-unfold-argument \ + --Domain www.testwaf.com \ + --Areas.0.Country 中国 \ + --Areas.0.Region 广东 \ + --Areas.0.City 深圳 \ + --JobType CronJob \ + --JobDateTime.Timed.0.StartDateTime 1711618518 \ + --JobDateTime.Timed.0.EndDateTime 1711918518 \ + --JobDateTime.Cron.0.WDays 2 \ + --JobDateTime.Cron.0.StartTime 12:11 \ + --JobDateTime.Cron.0.EndTime 21:00 \ + --JobDateTime.TimeTZone UTC+8 +``` + +Output: +``` +{ + "Response": { + "RequestId": "9b02bf9e-c89c-42c3-9ae1-685f968fa02d" + } +} +``` + diff --git a/tccli/examples/waf/v20180125/ModifyProtectionStatus.md b/tccli/examples/waf/v20180125/ModifyProtectionStatus.md index 65feba4e6f..c18cb5508d 100644 --- a/tccli/examples/waf/v20180125/ModifyProtectionStatus.md +++ b/tccli/examples/waf/v20180125/ModifyProtectionStatus.md @@ -1,4 +1,4 @@ -**Example 1: waf斯巴达-waf开关** +**Example 1: 关闭WAF开关** diff --git a/tccli/services/apm/v20210622/api.json b/tccli/services/apm/v20210622/api.json index e61a4afab7..a5aa371e42 100644 --- a/tccli/services/apm/v20210622/api.json +++ b/tccli/services/apm/v20210622/api.json @@ -1,16 +1,16 @@ { "actions": { "CreateApmInstance": { - "document": "业务购买APM实例,调用该接口创建", + "document": "业务购买 APM 业务系统,调用该接口创建", "input": "CreateApmInstanceRequest", - "name": "创建APM实例", + "name": "创建APM业务系统", "output": "CreateApmInstanceResponse", "status": "online" }, "DescribeApmAgent": { - "document": "获取APM Agent信息", + "document": "获取 APM Agent信息", "input": "DescribeApmAgentRequest", - "name": "获取APM Agent信息", + "name": "获取 APM Agent信息", "output": "DescribeApmAgentResponse", "status": "online" }, @@ -50,9 +50,9 @@ "status": "online" }, "DescribeServiceOverview": { - "document": "服务概览数据拉取", + "document": "应用概览数据拉取", "input": "DescribeServiceOverviewRequest", - "name": "获取服务概览数据", + "name": "获取应用概览数据", "output": "DescribeServiceOverviewResponse", "status": "online" }, @@ -64,9 +64,9 @@ "status": "online" }, "ModifyApmInstance": { - "document": "修改APM实例接口", + "document": "修改APM业务系统接口", "input": "ModifyApmInstanceRequest", - "name": "修改APM实例", + "name": "修改APM业务系统", "output": "ModifyApmInstanceResponse", "status": "online" }, @@ -78,9 +78,9 @@ "status": "online" }, "TerminateApmInstance": { - "document": "apm销毁实例", + "document": "销毁 APM 业务系统", "input": "TerminateApmInstanceRequest", - "name": "销毁实例", + "name": "销毁业务系统", "output": "TerminateApmInstanceResponse", "status": "online" } @@ -135,7 +135,7 @@ { "disabled": false, "document": "Value值定义\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxxx", + "example": "cloudmonitor", "member": "string", "name": "Value", "output_required": true, @@ -709,7 +709,7 @@ { "disabled": false, "document": "日志主题ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxxxxx", + "example": "cls-acv12b", "member": "string", "name": "LogTopicID", "output_required": true, @@ -739,7 +739,7 @@ { "disabled": false, "document": "CLS日志集 | ES集群ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxx", + "example": "cls-v1241nb", "member": "string", "name": "LogSet", "output_required": true, @@ -829,7 +829,7 @@ { "disabled": false, "document": "dashboard ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxxxxx", + "example": "dashboard-vcav134", "member": "string", "name": "DashboardTopicID", "output_required": false, @@ -916,7 +916,7 @@ "members": [ { "disabled": false, - "document": "实例名", + "document": "业务系统名", "example": "云监控-测试", "member": "string", "name": "Name", @@ -925,7 +925,7 @@ }, { "disabled": false, - "document": "实例描述信息", + "document": "业务系统描述信息", "example": "实例描述", "member": "string", "name": "Description", @@ -944,7 +944,7 @@ { "disabled": false, "document": "标签列表", - "example": "[]", + "example": "[{ \t\t\"Key\": \"appid\", \t\t\"Value\": \"123123422\" \t}]", "member": "ApmTag", "name": "Tags", "required": false, @@ -952,7 +952,7 @@ }, { "disabled": false, - "document": "实例上报额度值,默认赋值为0表示不限制上报额度", + "document": "业务系统上报额度值,默认赋值为0表示不限制上报额度", "example": "100000000", "member": "uint64", "name": "SpanDailyCounters", @@ -961,7 +961,7 @@ }, { "disabled": false, - "document": "实例的计费模式", + "document": "业务系统的计费模式", "example": "1", "member": "int64", "name": "PayMode", @@ -985,8 +985,8 @@ "members": [ { "disabled": false, - "document": "实例ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "Lcmm7a3kl", + "document": "业务系统ID\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "apm-CVfliqa8U", "member": "string", "name": "InstanceId", "output_required": true, @@ -1007,8 +1007,8 @@ "members": [ { "disabled": false, - "document": "实例ID", - "example": "jYm6_leMg", + "document": "业务系统ID", + "example": "apm-CVfliqa8U", "member": "string", "name": "InstanceId", "required": true, @@ -1178,7 +1178,7 @@ { "disabled": false, "document": "应用配置项", - "example": "{\"InstanceKey\":\"apm-059oXBfTL\",\"ServiceName\":\"profile-service\",\"IgnoreOperationName\":\"\",\"IgnoreException\":\"\",\"ErrorCodeFilter\":\"\",\"EventEnable\":false,\"UrlConvergenceSwitch\":1,\"UrlConvergenceThreshold\":500,\"UrlConvergence\":\"RPCServer/market.MarketService2/(.*?)\",\"UrlExclude\":\"\",\"IsRelatedLog\":0,\"LogSource\":\"CLS\",\"LogSet\":\"\",\"LogTopicID\":\"\",\"SnapshotEnable\":true,\"SnapshotTimeout\":2000,\"AgentEnable\":true,\"InstrumentList\":[{\"Name\":\"dubbo\",\"Enable\":true},{\"Name\":\"googlehttpclient\",\"Enable\":true},{\"Name\":\"grpc\",\"Enable\":true},{\"Name\":\"httpclient3\",\"Enable\":true},{\"Name\":\"httpclient4\",\"Enable\":true},{\"Name\":\"hystrix\",\"Enable\":true},{\"Name\":\"lettuce\",\"Enable\":true},{\"Name\":\"mongodb\",\"Enable\":true},{\"Name\":\"mybatis\",\"Enable\":true},{\"Name\":\"mysql\",\"Enable\":true},{\"Name\":\"okhttp\",\"Enable\":true},{\"Name\":\"redis\",\"Enable\":true},{\"Name\":\"rxjava\",\"Enable\":true},{\"Name\":\"spring-webmvc\",\"Enable\":true},{\"Name\":\"tomcat\",\"Enable\":true}],\"TraceSquash\":true}", + "example": "无", "member": "ApmApplicationConfigView", "name": "ApmApplicationConfigView", "output_required": false, @@ -1200,7 +1200,7 @@ { "disabled": false, "document": "需要查询的指标名称,不可自定义输入,[详情请见。](https://cloud.tencent.com/document/product/248/101681)", - "example": "\"service_request_count\"、“service_duration”", + "example": "[\"request_count\"、“duration”]", "member": "string", "name": "Metrics", "required": true, @@ -1227,7 +1227,7 @@ { "disabled": false, "document": "要过滤的维度信息,不同视图有对应的指标维度,[详情请见。](https://cloud.tencent.com/document/product/248/101681)", - "example": "{ \"Key\": \"service.name\", \"Value\": \"java-order-service\" } { \"Key", + "example": "无", "member": "GeneralFilter", "name": "Filters", "required": true, @@ -1236,7 +1236,7 @@ { "disabled": false, "document": "聚合维度,不同视图有对应的指标维度,[详情请见。](https://cloud.tencent.com/document/product/248/101681)", - "example": "\"service.name\"、\"span.kind\"", + "example": "[\"service.name\"、\"span.kind\"]", "member": "string", "name": "GroupBy", "required": false, @@ -1272,7 +1272,7 @@ { "disabled": false, "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\"", + "example": "{ \t\"Key\": \"duration\", \"Value\": \"desc\"", "member": "OrderBy", "name": "OrderBy", "required": false, @@ -1296,7 +1296,7 @@ { "disabled": false, "document": "指标结果集\n注意:此字段可能返回 null,表示取不到有效值。", - "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\" } }", + "example": "无", "member": "Line", "name": "Records", "output_required": true, @@ -1336,7 +1336,7 @@ { "disabled": false, "document": "排序", - "example": "{}", + "example": "{ \"Key\": \"startTime\", \"Value\": \"desc\" }", "member": "OrderBy", "name": "OrderBy", "required": false, @@ -1353,8 +1353,8 @@ }, { "disabled": false, - "document": "实例名", - "example": "52Dpv13GR", + "document": "业务系统ID", + "example": "apm-CVfliqa8U", "member": "string", "name": "InstanceId", "required": false, @@ -1363,7 +1363,7 @@ { "disabled": false, "document": "通用过滤参数", - "example": "{}", + "example": "{ \"Key\": \"service.name\", \"Type\": \"=\", \"Value\": \"java-order-service\" }", "member": "Filter", "name": "Filters", "required": false, @@ -1399,17 +1399,17 @@ "example": "200", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "Span分页列表", - "example": "{}", + "example": "无", "member": "Span", "name": "Spans", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1463,8 +1463,8 @@ }, { "disabled": false, - "document": "实例ID", - "example": "52Dpv13GR", + "document": "业务系统ID", + "example": "apm-CVfliqa8U", "member": "string", "name": "InstanceId", "required": false, @@ -1560,7 +1560,7 @@ { "disabled": false, "document": "指标结果集\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[{\"Fields\":[{\"LastPeriodValue\":[{\"Key\":\"abc\",\"Value\":0}],\"CompareVal\":\"abc\",\"Unit\":\"s\",\"Value\":691.42,\"Key\":\"ab\",\"CompareVals\":[{\"Value\":\"v1\",\"Key\":\"k1\"},{\"Key\":\"k2\",\"Value\":\"v2\"}]}],\"Tags\":[{\"Value\":\"v1\",\"Key\":\"k1\"}]}]", + "example": "无", "member": "ApmMetricRecord", "name": "Records", "output_required": true, @@ -1610,7 +1610,7 @@ { "disabled": false, "document": "聚合维度", - "example": "无", + "example": "service.name", "member": "string", "name": "GroupBy", "required": true, @@ -1627,8 +1627,8 @@ }, { "disabled": false, - "document": "实例ID", - "example": "52Dpv13GR", + "document": "业务系统ID", + "example": "apm-52Dpv13GR", "member": "string", "name": "InstanceId", "required": false, @@ -1682,7 +1682,7 @@ "example": "无", "member": "ApmMetricRecord", "name": "Records", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -1709,8 +1709,8 @@ }, { "disabled": false, - "document": "实例ID", - "example": "52Dpv13GR", + "document": "业务系统ID", + "example": "apm-52Dpv13GR", "member": "string", "name": "InstanceId", "required": false, @@ -1719,7 +1719,7 @@ { "disabled": false, "document": "结束时间", - "example": "1111", + "example": "1734415200", "member": "int64", "name": "EndTime", "required": false, @@ -1737,7 +1737,7 @@ { "disabled": false, "document": "开始时间", - "example": "1111", + "example": "1734400800", "member": "int64", "name": "StartTime", "required": false, @@ -1940,8 +1940,8 @@ "members": [ { "disabled": false, - "document": "实例ID", - "example": "6Dxp7Nd0B", + "document": "业务系统ID", + "example": "apm-6Dxp7Nd0B", "member": "string", "name": "InstanceId", "required": true, @@ -1949,7 +1949,7 @@ }, { "disabled": false, - "document": "实例名", + "document": "业务系统名", "example": "云监控-测试", "member": "string", "name": "Name", @@ -1967,8 +1967,8 @@ }, { "disabled": false, - "document": "实例详情", - "example": "无", + "document": "业务系统详情", + "example": "云监控-测试用的业务系统", "member": "string", "name": "Description", "required": false, @@ -1994,7 +1994,7 @@ }, { "disabled": false, - "document": "实例上报额度", + "document": "业务系统上报额度", "example": "10000000", "member": "uint64", "name": "SpanDailyCounters", @@ -2058,7 +2058,7 @@ { "disabled": false, "document": "CLS日志主题ID | ES 索引名", - "example": "xxxxx", + "example": "cls-1c1cac", "member": "string", "name": "LogTopicID", "required": false, @@ -2067,7 +2067,7 @@ { "disabled": false, "document": "CLS日志集 | ES集群ID", - "example": "xxxxx", + "example": "cls-av2q1f1", "member": "string", "name": "LogSet", "required": false, @@ -2085,7 +2085,7 @@ { "disabled": false, "document": "用户自定义展示标签列表", - "example": "无", + "example": "[\"oneTag\"]", "member": "string", "name": "CustomShowTags", "required": false, @@ -2130,7 +2130,7 @@ { "disabled": false, "document": "dashboard ID", - "example": "xxxxx", + "example": "dashboard-agv1br13b", "member": "string", "name": "DashboardTopicID", "required": false, @@ -2184,7 +2184,7 @@ { "disabled": false, "document": "需要修改的字段key value分别指定字段名、字段值\n[具体字段请见](https://cloud.tencent.com/document/product/248/111241)", - "example": "\"Tags\":[{\"Key\":\"UrlConvergence\",\"Value\":\"RPCServer/market.MarketServiceleetcode9(.*?)\"},{\"Key\":\"UrlConvergenceThreshold\",\"Value\":\"600\"},{\"Key\":\"UrlConvergenceSwitch\",\"Value\":\"1\"},{\"Key\":\"AgentEnable\",\"Value\":\"true\"}]\t", + "example": "无", "member": "ApmTag", "name": "Tags", "required": true, @@ -2193,7 +2193,7 @@ { "disabled": false, "document": "需要修改配置的应用列表名称\t", - "example": "\"ServiceNames\":[\"stock-service\",\"profile-service28\",\"profile-service08\"],\t", + "example": "[\"stock-service\",\"profile-service28\",\"profile-service08\"]", "member": "string", "name": "ServiceNames", "required": false, @@ -2260,28 +2260,25 @@ "member": "string", "name": "MetricName", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "同比,已弃用,不建议使用", - "example": "YearOnYear", + "example": "CompareByYesterday", "member": "string", "name": "Compare", "required": false, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "同比,支持多种同比方式", - "example": "无", + "example": "CompareByYesterday", "member": "string", "name": "Compares", "required": false, - "type": "list", - "value_allowed_null": false + "type": "list" } ], "usage": "in" @@ -2553,8 +2550,8 @@ "members": [ { "disabled": false, - "document": "实例ID", - "example": "6Dxp7Nd0B", + "document": "业务系统ID", + "example": "apm-CVfliqa8U", "member": "string", "name": "InstanceId", "required": true, diff --git a/tccli/services/apm/v20210622/examples.json b/tccli/services/apm/v20210622/examples.json index b24ae988e8..eece916718 100644 --- a/tccli/services/apm/v20210622/examples.json +++ b/tccli/services/apm/v20210622/examples.json @@ -2,10 +2,10 @@ "actions": { "CreateApmInstance": [ { - "document": "创建APM实例", - "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApmInstance\n<公共请求参数>\n\n{\n \"Name\": \"云监控-测试\",\n \"Description\": \"测试环境\",\n \"Tags\": [\n {\n \"Key\": \"appid\",\n \"Value\": \"123123422\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"InstanceId\": \"sSBebnOhf\",\n \"RequestId\": \"49fktc24elkfi4a1mkyir-9t2pt2stlx\"\n }\n}", - "title": "创建APM实例" + "document": "创建 APM 业务系统", + "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApmInstance\n<公共请求参数>\n\n{\n \"Name\": \"可观测-测试\",\n \"Description\": \"测试环境\",\n \"Tags\": [\n {\n \"Key\": \"appid\",\n \"Value\": \"123123422\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"InstanceId\": \"apm-CVfliqa8U\",\n \"RequestId\": \"49fktc24elkfi4a1mkyir-9t2pt2stlx\"\n }\n}", + "title": "创建 APM 业务系统" } ], "DescribeApmAgent": [ @@ -13,7 +13,7 @@ "document": "", "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeApmAgent\n<公共请求参数>\n\n{\n \"InstanceId\": \"jYm6_leMg\"\n}", "output": "{\n \"Response\": {\n \"ApmAgent\": {\n \"CollectorURL\": \"http://127.0.0.1:8080\",\n \"AgentDownloadURL\": \"https://agent.tapm.tencentyun.com/DownloadAgent\",\n \"Token\": \"14dac76ca10f4610f727ca68528758b43980251387493706d18988fa7d0621b7\",\n \"PublicCollectorURL\": \"http://127.0.0.1:8080\",\n \"InnerCollectorURL\": \"http://127.0.0.1:8080\",\n \"PrivateLinkCollectorURL\": \"http://127.0.0.1:8080\"\n },\n \"RequestId\": \"mzltx5whme-zl7je3p16tk5fwtb7ht61\"\n }\n}", - "title": "获取Apm Agent信息" + "title": "获取 APM Agent信息" } ], "DescribeApmInstances": [ @@ -34,25 +34,25 @@ ], "DescribeGeneralMetricData": [ { - "document": "该示例查询实例为 apm-059oXBfTL,按照 service.name(服务名)、span.kind(客户端/服务端视角)为维度过滤,以 service.name(服务名)、span.kind(客户端/服务端视角)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 request_count(请求数量)、error_request_count(错误请求数量)、duration_avg(平均响应时间)、slow_request_count(慢请求数量)、duration_p50(耗时 p50)的指标数据。", + "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-059oXBfTL,按照 service.name(服务名)、span.kind(客户端/服务端视角)为维度过滤,以 service.name(服务名)、span.kind(客户端/服务端视角)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 request_count(请求数量)、error_request_count(错误请求数量)、duration_avg(平均响应时间)、slow_request_count(慢请求数量)、duration_p50(耗时 p50)的指标数据。", + "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-059oXBfTL,按照 service.name(服务名)为维度过滤,以 service.name(服务名)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 error_request_count(错误请求数量)、duration_avg(平均响应时间)的指标数据。", + "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-059oXBfTL,按照 db.instance(数据库名称)为维度过滤,以 service.name(服务名)、db.statement(执行语句)为维度进行聚合,查找开始时间-终止时间内 top5 的 duration_avg(耗时(ms))的指标数据。", + "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(耗时时间)指标数据示例" @@ -61,37 +61,37 @@ "DescribeGeneralSpanList": [ { "document": "根据traceId列表批量查询span,Filters查询参数中将Type设置为in,将traceId列表通过,隔开。", - "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralSpanList\n<公共请求参数>\n\n{\n \"OrderBy\": {\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n },\n \"Filters\": [\n {\n \"Key\": \"traceID\",\n \"Type\": \"in\",\n \"Value\": \"663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac\"\n }\n ],\n \"Limit\": 0,\n \"Offset\": 10,\n \"InstanceId\": \"52Dpv13GR\",\n \"BusinessName\": \"tdmq\"\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"RequestId\": \"xx\",\n \"Spans\": [\n {\n \"TraceID\": \"xx\",\n \"Logs\": [\n {\n \"Timestamp\": 0,\n \"Fields\": [\n {\n \"Type\": \"xx\",\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ]\n }\n ],\n \"Tags\": [\n {\n \"Type\": \"xx\",\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ],\n \"Process\": {\n \"ServiceName\": \"xx\",\n \"Tags\": [\n {\n \"Type\": \"xx\",\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ]\n },\n \"Timestamp\": 0,\n \"OperationName\": \"xx\",\n \"References\": [\n {\n \"RefType\": \"xx\",\n \"SpanID\": \"xx\",\n \"TraceID\": \"xx\"\n }\n ],\n \"StartTime\": 0,\n \"Duration\": 0,\n \"SpanID\": \"xx\",\n \"StartTimeMillis\": 0\n }\n ]\n }\n}", + "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralSpanList\n<公共请求参数>\n\n{\n \"OrderBy\": {\n \"Value\": \"startTime\",\n \"Key\": \"desc\"\n },\n \"Filters\": [\n {\n \"Key\": \"traceID\",\n \"Type\": \"in\",\n \"Value\": \"663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac\"\n }\n ],\n \"Limit\": 0,\n \"Offset\": 10,\n \"InstanceId\": \"52Dpv13GR\",\n \"BusinessName\": \"tdmq\"\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"RequestId\": \"test-test-test\",\n \"Spans\": [\n {\n \"TraceID\": \"663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac\",\n \"Logs\": [\n {\n \"Timestamp\": 0,\n \"Fields\": [\n {\n \"Type\": \"service.name\",\n \"Value\": \"=\",\n \"Key\": \"java-order-service\"\n }\n ]\n }\n ],\n \"Tags\": [\n {\n \"Type\": \"service.name\",\n \"Value\": \"=\",\n \"Key\": \"java-order-service\"\n }\n ],\n \"Process\": {\n \"ServiceName\": \"java-order-service\",\n \"Tags\": [\n {\n \"Type\": \"service.name\",\n \"Value\": \"=\",\n \"Key\": \"java-order-service\"\n }\n ]\n },\n \"Timestamp\": 0,\n \"OperationName\": \"/test\",\n \"References\": [\n {\n \"RefType\": \"1\",\n \"SpanID\": \"4q6549c49aaa\",\n \"TraceID\": \"663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac\"\n }\n ],\n \"StartTime\": 0,\n \"Duration\": 0,\n \"SpanID\": \"1q23w1q32165\",\n \"StartTimeMillis\": 0\n }\n ]\n }\n}", "title": "通用查询调用链列表" }, { "document": "指定tag过滤条件拿到span列表。", - "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralSpanList\n<公共请求参数>\n\n{\n \"OrderBy\": {\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n },\n \"Filters\": [\n {\n \"Key\": \"pulsar:sub_name\",\n \"Type\": \"=\",\n \"Value\": \"participants\"\n }\n ],\n \"Limit\": 0,\n \"Offset\": 10,\n \"InstanceId\": \"52Dpv13GR\",\n \"BusinessName\": \"tdmq\",\n \"StartTime\": 1621923035\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"RequestId\": \"xx\",\n \"Spans\": [\n {\n \"TraceID\": \"xx\",\n \"Logs\": [\n {\n \"Timestamp\": 0,\n \"Fields\": [\n {\n \"Type\": \"xx\",\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ]\n }\n ],\n \"Tags\": [\n {\n \"Type\": \"xx\",\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ],\n \"Process\": {\n \"ServiceName\": \"xx\",\n \"Tags\": [\n {\n \"Type\": \"xx\",\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ]\n },\n \"Timestamp\": 0,\n \"OperationName\": \"xx\",\n \"References\": [\n {\n \"RefType\": \"xx\",\n \"SpanID\": \"xx\",\n \"TraceID\": \"xx\"\n }\n ],\n \"StartTime\": 0,\n \"Duration\": 0,\n \"SpanID\": \"xx\",\n \"StartTimeMillis\": 0\n }\n ]\n }\n}", + "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGeneralSpanList\n<公共请求参数>\n\n{\n \"OrderBy\": {\n \"Value\": \"startTime\",\n \"Key\": \"desce\"\n },\n \"Filters\": [\n {\n \"Key\": \"pulsar:sub_name\",\n \"Type\": \"=\",\n \"Value\": \"participants\"\n }\n ],\n \"Limit\": 0,\n \"Offset\": 10,\n \"InstanceId\": \"52Dpv13GR\",\n \"BusinessName\": \"tdmq\",\n \"StartTime\": 1621923035\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"RequestId\": \"test-test-test\",\n \"Spans\": [\n {\n \"TraceID\": \"663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac\",\n \"Logs\": [\n {\n \"Timestamp\": 0,\n \"Fields\": [\n {\n \"Type\": \"test\",\n \"Value\": \"=\",\n \"Key\": \"test1\"\n }\n ]\n }\n ],\n \"Tags\": [\n {\n \"Type\": \"=\",\n \"Value\": \"java-order-service\",\n \"Key\": \"service.name\"\n }\n ],\n \"Process\": {\n \"ServiceName\": \"java-order-service\",\n \"Tags\": [\n {\n \"Type\": \"test\",\n \"Value\": \"=\",\n \"Key\": \"test2\"\n }\n ]\n },\n \"Timestamp\": 0,\n \"OperationName\": \"/test\",\n \"References\": [\n {\n \"RefType\": \"1\",\n \"SpanID\": \"qertuytw\",\n \"TraceID\": \"663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac\"\n }\n ],\n \"StartTime\": 0,\n \"Duration\": 0,\n \"SpanID\": \"xasfvava\",\n \"StartTimeMillis\": 0\n }\n ]\n }\n}", "title": "通用查询调用链列表2" } ], "DescribeMetricRecords": [ { - "document": "场景一", + "document": "场景1", "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMetricRecords\n<公共请求参数>\n\n{\n \"OrderBy\": {\n \"Key\": \"service_duration_avg\",\n \"Value\": \"DESC\"\n },\n \"Filters\": [\n {\n \"Type\": \"=\",\n \"Key\": \"span.kind\",\n \"Value\": \"server\"\n }\n ],\n \"InstanceId\": \"apm-6xYKFXYxo\",\n \"BusinessName\": \"taw\",\n \"Metrics\": [\n {\n \"Compare\": \"1\",\n \"Compares\": [\n \"CompareByYesterday\",\n \"CompareByLastWeek\"\n ],\n \"MetricName\": \"qps\"\n }\n ],\n \"Limit\": \"10\",\n \"StartTime\": \"1618361193\",\n \"Offset\": \"22\",\n \"EndTime\": \"1618677137\",\n \"PageIndex\": 1,\n \"PageSize\": 10,\n \"GroupBy\": [\n \"service.instance\"\n ]\n}", - "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Fields\": [\n {\n \"CompareVal\": \"abc\",\n \"CompareVals\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Value\": 0,\n \"Unit\": \"abc\",\n \"Key\": \"abc\",\n \"LastPeriodValue\": [\n {\n \"Key\": \"abc\",\n \"Value\": 0\n }\n ]\n }\n ],\n \"Tags\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ]\n }\n ],\n \"TotalCount\": 0,\n \"RequestId\": \"abc\"\n }\n}", - "title": "请求参数实例" + "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Fields\": [\n {\n \"CompareVal\": \"\",\n \"CompareVals\": [\n {\n \"Key\": \"CompareByYesterday\",\n \"Value\": \"1%\"\n }\n ],\n \"Value\": 0,\n \"Unit\": \"\",\n \"Key\": \"service_duration_avg\",\n \"LastPeriodValue\": [\n {\n \"Key\": \"CompareByYesterday\",\n \"Value\": 71308388\n }\n ]\n }\n ],\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"java-order-demo\"\n }\n ]\n }\n ],\n \"TotalCount\": 0,\n \"RequestId\": \"test-test-test\"\n }\n}", + "title": "请求参数示例" }, { "document": "场景2", "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMetricRecords\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"span.kind\",\n \"Type\": \"in\",\n \"Value\": \"server,consumer\"\n }\n ],\n \"Metrics\": [\n {\n \"MetricName\": \"duration_avg\",\n \"Compares\": [\n \"CompareByYesterday\",\n \"CompareByLastWeek\"\n ]\n }\n ],\n \"GroupBy\": [\n \"service.instance\"\n ],\n \"Limit\": 10,\n \"Offset\": 1,\n \"StartTime\": 1618361193,\n \"EndTime\": 1618677137,\n \"OrderBy\": {\n \"Key\": \"duration_avg\",\n \"Value\": \"DESC\"\n }\n}", - "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Fields\": [\n {\n \"LastPeriodValue\": [\n {\n \"Key\": \"abc\",\n \"Value\": 0\n }\n ],\n \"CompareVal\": \"abc\",\n \"Unit\": \"s\",\n \"Value\": 691.42,\n \"Key\": \"ab\",\n \"CompareVals\": [\n {\n \"Value\": \"v1\",\n \"Key\": \"k1\"\n },\n {\n \"Key\": \"k2\",\n \"Value\": \"v2\"\n }\n ]\n }\n ],\n \"Tags\": [\n {\n \"Value\": \"v1\",\n \"Key\": \"k1\"\n }\n ]\n }\n ],\n \"RequestId\": \"re\",\n \"TotalCount\": 0\n }\n}", + "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Fields\": [\n {\n \"LastPeriodValue\": [\n {\n \"Key\": \"CompareByYesterday\",\n \"Value\": 71308388\n }\n ],\n \"CompareVal\": \"CompareByYesterday\",\n \"Unit\": \"s\",\n \"Value\": 691.42,\n \"Key\": \"duration_avg\",\n \"CompareVals\": [\n {\n \"Value\": \"CompareByYesterday\",\n \"Key\": \"2%\"\n },\n {\n \"Key\": \"CompareByLastWeek\",\n \"Value\": \"-1%\"\n }\n ]\n }\n ],\n \"Tags\": [\n {\n \"Value\": \"service.name\",\n \"Key\": \"java-order-demo\"\n }\n ]\n }\n ],\n \"RequestId\": \"test-test-test\",\n \"TotalCount\": 0\n }\n}", "title": "通用指标列表接口" } ], "DescribeServiceOverview": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeServiceOverview\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Key\": \"span.kind\",\n \"Type\": \"=\",\n \"Value\": \"SPAN_KIND_SERVER\"\n }\n ],\n \"Metrics\": [\n {\n \"MetricName\": \"service_duration_avg\",\n \"Compare\": 1\n },\n {\n \"MetricName\": \"request_count_sum\"\n }\n ],\n \"GroupBy\": [\n \"operation\",\n \"service.component\"\n ],\n \"Limit\": 10,\n \"Offset\": 1,\n \"StartTime\": 1618361193,\n \"EndTime\": 1618677137,\n \"OrderBy\": {\n \"Key\": \"service_duration_avg\",\n \"Value\": \"DESC\"\n }\n}", - "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Tags\": [\n {\n \"Key\": \"operation\",\n \"Value\": \"/DescribeAlarmList\"\n },\n {\n \"Key\": \"service.component\",\n \"Value\": \"HTTP\"\n }\n ],\n \"Fields\": [\n {\n \"Key\": \"service_duration_avg\",\n \"Value\": 0.02383373177662466,\n \"CompareVal\": -0.004148131882911392\n },\n {\n \"Key\": \"request_count_sum\",\n \"Value\": 31184,\n \"CompareVal\": 0\n }\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"operation\",\n \"Value\": \"/collector.CollectorService/PostSpans\"\n },\n {\n \"Key\": \"service.component\",\n \"Value\": \"gRPC\"\n }\n ],\n \"Fields\": [\n {\n \"Key\": \"service_duration_avg\",\n \"Value\": 18.811467216411906,\n \"CompareVal\": 0.17306355798699288\n },\n {\n \"Key\": \"request_count_sum\",\n \"Value\": 4986,\n \"CompareVal\": 0\n }\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"operation\",\n \"Value\": \"/notify.Notify/SendAlert\"\n },\n {\n \"Key\": \"service.component\",\n \"Value\": \"gRPC\"\n }\n ],\n \"Fields\": [\n {\n \"Key\": \"service_duration_avg\",\n \"Value\": 9.486143798828124,\n \"CompareVal\": 0.4454246545216073\n },\n {\n \"Key\": \"request_count_sum\",\n \"Value\": 4111,\n \"CompareVal\": 0\n }\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"operation\",\n \"Value\": \"HTTP GET\"\n },\n {\n \"Key\": \"service.component\",\n \"Value\": \"net/http\"\n }\n ],\n \"Fields\": [\n {\n \"Key\": \"service_duration_avg\",\n \"Value\": 14.46367618133845,\n \"CompareVal\": 1\n },\n {\n \"Key\": \"request_count_sum\",\n \"Value\": 8345,\n \"CompareVal\": 0\n }\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"operation\",\n \"Value\": \"HTTP POST\"\n },\n {\n \"Key\": \"service.component\",\n \"Value\": \"net/http\"\n }\n ],\n \"Fields\": [\n {\n \"Key\": \"service_duration_avg\",\n \"Value\": 12.396896973135917,\n \"CompareVal\": 0.1693196368191666\n },\n {\n \"Key\": \"request_count_sum\",\n \"Value\": 15094,\n \"CompareVal\": 0\n }\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"operation\",\n \"Value\": \"http_server_root\"\n },\n {\n \"Key\": \"service.component\",\n \"Value\": \"net/http\"\n }\n ],\n \"Fields\": [\n {\n \"Key\": \"service_duration_avg\",\n \"Value\": 68.29158163921177,\n \"CompareVal\": -0.05762747632987753\n },\n {\n \"Key\": \"request_count_sum\",\n \"Value\": 104642033,\n \"CompareVal\": 0\n }\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"service.component\",\n \"Value\": \"httpserverv3\"\n },\n {\n \"Key\": \"operation\",\n \"Value\": \"Ping\"\n }\n ],\n \"Fields\": [\n {\n \"Key\": \"service_duration_avg\",\n \"Value\": 0.4196629148780232,\n \"CompareVal\": 1\n },\n {\n \"Key\": \"request_count_sum\",\n \"Value\": 10182,\n \"CompareVal\": 0\n }\n ]\n },\n {\n \"Tags\": [\n {\n \"Key\": \"operation\",\n \"Value\": \"microServer_cdbwan\"\n },\n {\n \"Key\": \"service.component\",\n \"Value\": \"httpserverv3\"\n }\n ],\n \"Fields\": [\n {\n \"Key\": \"service_duration_avg\",\n \"Value\": 3.6889778198423007,\n \"CompareVal\": 0.15496546525321617\n },\n {\n \"Key\": \"request_count_sum\",\n \"Value\": 191205,\n \"CompareVal\": 0\n }\n ]\n }\n ],\n \"RequestId\": \"fyy3-g7ujmxbouxshy3plmkmhlnmdbfh\"\n }\n}", - "title": "获取服务概览数据" + "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeServiceOverview\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Type\": \"=\",\n \"Key\": \"span.kind\",\n \"Value\": \"client\"\n }\n ],\n \"InstanceId\": \"apm-059oXBfTL\",\n \"Metrics\": [\n {\n \"Compare\": \"CompareByYesterday\",\n \"MetricName\": \"service_request_count_sum\"\n }\n ],\n \"GroupBy\": [\n \"service.name\"\n ]\n}", + "output": "{\n \"Response\": {\n \"Records\": [\n {\n \"Fields\": [\n {\n \"CompareVal\": \"\",\n \"CompareVals\": [\n {\n \"Key\": \"CompareByYesterday\",\n \"Value\": \"-1.6%\"\n },\n {\n \"Key\": \"CompareByLastWeek\",\n \"Value\": \"-0.8%\"\n }\n ],\n \"Key\": \"service_request_count_sum\",\n \"LastPeriodValue\": [\n {\n \"Key\": \"CompareByYesterday\",\n \"Value\": 125\n },\n {\n \"Key\": \"CompareByLastWeek\",\n \"Value\": 124\n }\n ],\n \"Unit\": \"\",\n \"Value\": 126\n }\n ],\n \"Tags\": [\n {\n \"Key\": \"service.name\",\n \"Value\": \"ot-java-delivery-service\"\n }\n ]\n }\n ],\n \"RequestId\": \"c7a656fe-971c-47cc-8dc4-ae76630e4761\"\n }\n}", + "title": "获取应用概览数据" } ], "DescribeTagValues": [ @@ -104,9 +104,9 @@ ], "ModifyApmInstance": [ { - "document": "修改APM Instance参数", - "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyApmInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"Tags\": [],\n \"Description\": \"abc\",\n \"TraceDuration\": 0,\n \"Name\": \"abc\",\n \"OpenBilling\": true,\n \"SpanDailyCounters\": 1,\n \"ErrRateThreshold\": 5,\n \"SampleRate\": 50,\n \"ErrorSample\": 1,\n \"SlowRequestSavedThreshold\": 500,\n \"IsRelatedLog\": 0,\n \"LogRegion\": \"\",\n \"LogTopicID\": \"\",\n \"LogSet\": \"\",\n \"LogSource\": \"\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}", + "document": "修改 APM 业务系统参数", + "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyApmInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"apm-CVfliqa8U\",\n \"Tags\": [],\n \"Description\": \"测试业务系统\",\n \"TraceDuration\": 0,\n \"Name\": \"测试业务系统\",\n \"OpenBilling\": true,\n \"SpanDailyCounters\": 1,\n \"ErrRateThreshold\": 5,\n \"SampleRate\": 50,\n \"ErrorSample\": 1,\n \"SlowRequestSavedThreshold\": 500,\n \"IsRelatedLog\": 0,\n \"LogRegion\": \"\",\n \"LogTopicID\": \"\",\n \"LogSet\": \"\",\n \"LogSource\": \"\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"test-test-test\"\n }\n}", "title": "成功事例" } ], @@ -120,10 +120,10 @@ ], "TerminateApmInstance": [ { - "document": "销毁apm实例", - "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TerminateApmInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"6Dxp7Nd0B\"\n}", + "document": "销毁 APM 业务系统", + "input": "POST / HTTP/1.1\nHost: apm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TerminateApmInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"apm-CVfliqa8U\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"9cnw2qyy-tqjmp6knytyi8dkzvd7fl9v\"\n }\n}", - "title": "销毁apm实例" + "title": "销毁 APM 业务系统" } ] }, diff --git a/tccli/services/autoscaling/v20180419/api.json b/tccli/services/autoscaling/v20180419/api.json index ea9e4539ed..f5238a465f 100644 --- a/tccli/services/autoscaling/v20180419/api.json +++ b/tccli/services/autoscaling/v20180419/api.json @@ -7115,7 +7115,7 @@ }, { "disabled": false, - "document": "自动更新实例标签。默认取值为 false,配置后如伸缩组标签发生更新,会同步更新(同步更新仅支持新增、修改标签,暂不支持删除标签)伸缩组内运行中状态实例的标签,同步更新非立即生效,存在一定延迟。", + "document": "自动更新实例标签。默认取值为 False,配置后如伸缩组标签发生更新,会同步更新(同步更新仅支持新增、修改标签,暂不支持删除标签)伸缩组内运行中状态实例的标签,同步更新非立即生效,存在一定延迟。", "example": "False", "member": "bool", "name": "AutoUpdateInstanceTags", @@ -7123,6 +7123,17 @@ "required": false, "type": "bool", "value_allowed_null": false + }, + { + "disabled": false, + "document": "期望实例数同步最大最小值。默认值为 False。该参数仅对修改伸缩组接口未传入期望数的场景生效。\n<li>True: 修改最大值或最小值时,如与当前期望数存在冲突,则同步调整期望数。例如修改时传入最小值 2,当前期望数为 1,则同步调整期望数为 2。</li>\n<li>False: 修改最大值或最小值时,如与当前期望数存在冲突,报错提示不允许修改。</li>", + "example": "False", + "member": "bool", + "name": "DesiredCapacitySyncWithMaxMinSize", + "output_required": true, + "required": false, + "type": "bool", + "value_allowed_null": false } ], "usage": "both" diff --git a/tccli/services/batch/v20170312/api.json b/tccli/services/batch/v20170312/api.json index d534f55cfc..172b34196e 100644 --- a/tccli/services/batch/v20170312/api.json +++ b/tccli/services/batch/v20170312/api.json @@ -4331,50 +4331,50 @@ { "disabled": false, "document": "本地磁盘类型。", - "example": "", + "example": "LOCAL_BASIC", "member": "string", "name": "Type", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "本地磁盘属性。", - "example": "", + "example": "ROOT", "member": "string", "name": "PartitionType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "本地磁盘最小值。", - "example": "", + "example": "10", "member": "int64", "name": "MinSize", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "本地磁盘最大值。", - "example": "", + "example": "20", "member": "int64", "name": "MaxSize", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "购买时本地盘是否为必选。取值范围:<br><li>REQUIRED:表示必选<br><li>OPTIONAL:表示可选。", - "example": "", + "document": "购买时本地盘是否为必选。取值范围:<br><li>REQUIRED:表示必选</li><li>OPTIONAL:表示可选。</li>", + "example": "REQUIRED", "member": "string", "name": "Required", - "required": true, + "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 97884984f9..93c3dfb27b 100644 --- a/tccli/services/billing/v20180709/api.json +++ b/tccli/services/billing/v20180709/api.json @@ -15691,6 +15691,26 @@ "output_required": true, "type": "list", "value_allowed_null": false + }, + { + "disabled": false, + "document": "使用说明/批次备注", + "example": "不限使用", + "member": "string", + "name": "PolicyRemark", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "发券时间", + "example": "2017-03-08 15:25:20", + "member": "string", + "name": "CreateTime", + "output_required": false, + "type": "string", + "value_allowed_null": false } ], "usage": "out" diff --git a/tccli/services/cam/v20190116/api.json b/tccli/services/cam/v20190116/api.json index a1d248f74a..7709cd77ed 100644 --- a/tccli/services/cam/v20190116/api.json +++ b/tccli/services/cam/v20190116/api.json @@ -4159,7 +4159,7 @@ { "disabled": false, "document": "子用户备注\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "test", + "example": "Jack", "member": "string", "name": "Remark", "output_required": true, diff --git a/tccli/services/car/v20220110/api.json b/tccli/services/car/v20220110/api.json index 0bfc42c66a..382a28c4b6 100644 --- a/tccli/services/car/v20220110/api.json +++ b/tccli/services/car/v20220110/api.json @@ -210,7 +210,7 @@ { "disabled": false, "document": "唯一用户身份标识,由业务方自定义,平台不予理解。(可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成;在用户重连时应保持UserId不变)", - "example": "abc", + "example": "639d069e-a13a-437a-a10b-64a33ecb8e78", "member": "string", "name": "UserId", "required": true, diff --git a/tccli/services/car/v20220110/examples.json b/tccli/services/car/v20220110/examples.json index c3f41d96cc..cac1b729e8 100644 --- a/tccli/services/car/v20220110/examples.json +++ b/tccli/services/car/v20220110/examples.json @@ -19,7 +19,7 @@ "DestroySession": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: car.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DestroySession\n<公共请求参数>\n\n{\n \"UserId\": \"abc\"\n}", + "input": "POST / HTTP/1.1\nHost: car.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DestroySession\n<公共请求参数>\n\n{\n \"UserId\": \"639d069e-a13a-437a-a10b-64a33ecb8e78\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"fcf4146f-64d3-496c-88dc-d12f832de313\"\n }\n}", "title": "DestroySession示例" } @@ -35,8 +35,8 @@ "StartPublishStreamWithURL": [ { "document": "开始云端推流到指定URL示例", - "input": "POST / HTTP/1.1\nHost: car.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishStreamWithURL\n<公共请求参数>\n\n{\n \"UserId\": \"abc\",\n \"PublishStreamURL\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: car.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishStreamWithURL\n<公共请求参数>\n\n{\n \"UserId\": \"user_id\",\n \"PublishStreamURL\": \"rtmp://1.1.1.1:1935/live/my_live\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"25b6f399-bd7c-4e5e-99a3-9a6f4b11e1b7\"\n }\n}", "title": "开始云端推流到指定URL示例" } ], diff --git a/tccli/services/cdb/v20170320/api.json b/tccli/services/cdb/v20170320/api.json index 74873a6336..c5e45874d6 100644 --- a/tccli/services/cdb/v20170320/api.json +++ b/tccli/services/cdb/v20170320/api.json @@ -512,7 +512,7 @@ "status": "online" }, "DescribeDBInstances": { - "document": "本接口(DescribeDBInstances)用于查询云数据库实例列表,支持通过项目 ID、实例 ID、访问地址、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。", + "document": "本接口(DescribeDBInstances)用于查询云数据库实例列表,支持通过项目 ID、实例 ID、访问地址、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。", "input": "DescribeDBInstancesRequest", "name": "查询实例列表", "output": "DescribeDBInstancesResponse", @@ -1631,13 +1631,13 @@ "members": [ { "disabled": false, - "document": "异步任务ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "异步任务ID", "example": "a6040589-3b098df5-b551d9e5-81c6bfdc", "member": "string", "name": "AsyncRequestId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -1704,13 +1704,13 @@ "members": [ { "disabled": false, - "document": "异步任务ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "123-123-123", + "document": "异步任务ID", + "example": "a6040589-3b098df5-b551d9e5-81c6bfdc", "member": "string", "name": "AsyncRequestId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -1819,23 +1819,23 @@ "members": [ { "disabled": false, - "document": "返回的聚合桶信息集\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "返回的聚合桶信息集", "example": "[{\"AggregationField\": \"host\",\"Buckets\": [{\"Count\": 3,\"Key\": \"100.122.76.176\"},{\"Count\": 2,\"Key\": \"9.71.156.179\"}]}]", "member": "AuditLogAggregationResult", "name": "Items", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "扫描的日志条数\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "扫描的日志条数", "example": "100", "member": "int64", "name": "TotalCount", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -1971,43 +1971,43 @@ "members": [ { "disabled": false, - "document": "项目ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "项目ID", "example": "23414", "member": "int64", "name": "ProjectId", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "标签信息\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "标签信息", "example": "[{\"TagKey\": \"created-by\",\"TagValue\": \"andy\"}]", "member": "TagInfoUnit", "name": "TagList", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "数据库内核类型\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库内核类型", "example": "MYSQL", "member": "string", "name": "DbType", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "数据库内核版本\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库内核版本", "example": "5.7", "member": "string", "name": "DbVersion", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -2137,63 +2137,63 @@ }, { "disabled": false, - "document": "扫描行数。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "扫描行数。", "example": "1", "member": "int64", "name": "CheckRows", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "cpu执行时间,微秒。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "cpu执行时间,微秒。", "example": "289.474", "member": "float", "name": "CpuTime", "output_required": true, "type": "float", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "IO等待时间,微秒。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "IO等待时间,微秒。", "example": "100", "member": "uint64", "name": "IoWaitTime", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "锁等待时间,微秒。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "锁等待时间,微秒。", "example": "57", "member": "uint64", "name": "LockWaitTime", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "开始时间,与timestamp构成一个精确到纳秒的时间。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "开始时间,与timestamp构成一个精确到纳秒的时间。", "example": "106483229", "member": "uint64", "name": "NsTime", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "事物持续时间,微秒。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "事物持续时间,微秒。", "example": "100", "member": "uint64", "name": "TrxLivingTime", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -2223,23 +2223,23 @@ "members": [ { "disabled": false, - "document": "聚合维度\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "聚合维度", "example": "host", "member": "string", "name": "AggregationField", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "聚合桶的结果集\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "聚合桶的结果集", "example": "[{\"Key\": \"10.0.0.8\",\"Count\": \"10\"}]", "member": "Bucket", "name": "Buckets", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -2279,33 +2279,33 @@ }, { "disabled": false, - "document": "文件大小,单位为 KB。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "文件大小,单位为 KB。", "example": "1", "member": "int64", "name": "FileSize", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "审计日志下载地址。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "https://gz-audit-125****829.cos.ap-guangzhou.myqcloud.com/130****106_cdb-3g****ath_1730****60_37****68.csv?q-sign-algorithm=sh***", + "document": "审计日志下载地址。", + "example": "https://gz-audit-125****829.cos.ap-guangzhou.myqcloud.com/130****106_cdb-3_37****68.csv?q-sign-algorithm=sh***", "member": "string", "name": "DownloadUrl", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "错误信息。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "错误信息。", + "example": "error msg", "member": "string", "name": "ErrMsg", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -2571,23 +2571,23 @@ }, { "disabled": false, - "document": "审计规则名称。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "审计规则名称。", "example": "allrule", "member": "string", "name": "RuleName", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "数据库实例名称\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库实例名称", "example": "cdb463333", "member": "string", "name": "InstanceName", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -2673,14 +2673,14 @@ "members": [ { "disabled": false, - "document": "单条审计规则。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "单条审计规则。", "example": "[{\"Type\": \"sqlType\",\"INC\": \"employees\",\"Value\": [\"employees\"]}]", "member": "RuleFilters", "name": "RuleFilters", "output_required": true, "required": false, "type": "list", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -2720,13 +2720,13 @@ }, { "disabled": false, - "document": "规则模板描述。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "规则模板描述。", "example": "dd_yif", "member": "string", "name": "Description", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -3045,7 +3045,7 @@ { "disabled": false, "document": "异地备份详细信息", - "example": "[{\"SubBackupId\": \"145\",\"Region\": \"ap-guangzhou\",\"Status\": \"SUCCESS\",\"StartTime\": \"2024-03-17 02:00:37\",\"FinishTime\": \"2024-03-17 03:00:37\",\"Url\": \"https://******\"}]", + "example": "[{\"SubBackupId\": \"145\",\"Region\": \"ap-guangzhou\",\"Status\": \"SUCCESS\"}]", "member": "RemoteBackupInfo", "name": "RemoteInfo", "output_required": true, @@ -3074,18 +3074,18 @@ }, { "disabled": false, - "document": "备份文件是否加密, on-加密, off-未加密\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "备份文件是否加密, on-加密, off-未加密", "example": "on", "member": "string", "name": "EncryptionFlag", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, "document": "备份GTID点位", - "example": "无", + "example": "9da61900-5431-11ed-8b94-0c42a123d04:1-51847587", "member": "string", "name": "ExecutedGTIDSet", "output_required": false, @@ -3419,13 +3419,13 @@ "members": [ { "disabled": false, - "document": "无\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "无", "example": "10.0.0.8", "member": "string", "name": "Key", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -3433,7 +3433,7 @@ "example": "26", "member": "uint64", "name": "Count", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -3505,7 +3505,7 @@ "example": "1000", "member": "int64", "name": "Memory", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -3515,7 +3515,7 @@ "example": "1", "member": "int64", "name": "Cpu", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -3525,7 +3525,7 @@ "example": "50", "member": "int64", "name": "VolumeMin", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -3535,7 +3535,7 @@ "example": "3000", "member": "int64", "name": "VolumeMax", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -3545,7 +3545,7 @@ "example": "5", "member": "int64", "name": "VolumeStep", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -3555,7 +3555,7 @@ "example": "6000", "member": "int64", "name": "Iops", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -3565,7 +3565,7 @@ "example": "***", "member": "string", "name": "Info", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -3575,19 +3575,19 @@ "example": "0", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "实例类型,可能的取值范围有:UNIVERSAL (通用型), EXCLUSIVE (独享型), BASIC (基础型), BASIC_V2 (基础型v2)\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例类型,可能的取值范围有:UNIVERSAL (通用型), EXCLUSIVE (独享型), BASIC (基础型), BASIC_V2 (基础型v2)", "example": "UNIVERSAL", "member": "string", "name": "DeviceType", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -3595,7 +3595,7 @@ "example": "InnoDB", "member": "string", "name": "EngineType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -3605,7 +3605,7 @@ "example": "1", "member": "int64", "name": "Id", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -4440,14 +4440,14 @@ }, { "disabled": false, - "document": "节点状态。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "节点状态。", "example": "normal", "member": "string", "name": "Status", "output_required": true, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -4481,47 +4481,47 @@ "members": [ { "disabled": false, - "document": "数据库名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库名", "example": "db1", "member": "string", "name": "Database", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "数据库表名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库表名", "example": "andy_table1", "member": "string", "name": "Table", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "数据库列名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库列名", "example": "user_email_address", "member": "string", "name": "Column", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "权限信息\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "权限信息", "example": "[\"SELECT\",\"INSERT\"]", "member": "string", "name": "Privileges", "output_required": true, "required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -4980,13 +4980,13 @@ "members": [ { "disabled": false, - "document": "生成的规则模板ID。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "生成的规则模板ID。", "example": "cdb-art-l1mlbo59", "member": "string", "name": "RuleTemplateId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -5261,13 +5261,13 @@ "members": [ { "disabled": false, - "document": "异步任务ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "异步任务ID", "example": "a6040589-3b098df5-b551d9e5-81c6bfdc", "member": "string", "name": "AsyncRequestId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -5361,13 +5361,13 @@ "members": [ { "disabled": false, - "document": "异步任务ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "异步任务ID", "example": "a6040589-3b098df5-b551d9e5-81c6bfdc", "member": "string", "name": "AsyncRequestId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -6853,53 +6853,53 @@ "members": [ { "disabled": false, - "document": "设备\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "设备", + "example": "CUSTOM", "member": "string", "name": "Device", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "类型", + "example": "cdb", "member": "string", "name": "Type", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "设备类型\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "设备类型", "example": "UNIVERSAL", "member": "string", "name": "DeviceType", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "内存\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "内存", "example": "4000", "member": "uint64", "name": "Memory", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "核数\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "核数", "example": "2", "member": "uint64", "name": "Cpu", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -6909,23 +6909,23 @@ "members": [ { "disabled": false, - "document": "切换时间,格式为:2017-09-03 01:34:31\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "切换时间,格式为:2017-09-03 01:34:31", "example": "2024-09-03 01:34:31", "member": "datetime", "name": "SwitchTime", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "切换类型,可能的返回值为:TRANSFER - 数据迁移;MASTER2SLAVE - 主备切换;RECOVERY - 主从恢复\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "切换类型,可能的返回值为:TRANSFER - 数据迁移;MASTER2SLAVE - 主备切换;RECOVERY - 主从恢复", "example": "MASTER2SLAVE", "member": "string", "name": "SwitchType", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -6935,25 +6935,25 @@ "members": [ { "disabled": false, - "document": "权限信息\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "权限信息", "example": "[\"CREATE\",\"DROP\"]", "member": "string", "name": "Privileges", "output_required": true, "required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "数据库名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库名", "example": "db1", "member": "string", "name": "Database", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -7417,23 +7417,23 @@ }, { "disabled": false, - "document": "置放群组亲和性策略,目前仅支持策略1,即在物理机纬度打散实例的分布。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "置放群组亲和性策略,目前仅支持策略1,即在物理机纬度打散实例的分布。", "example": "1", "member": "string", "name": "Affinity", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "置放群组亲和性策略1中,同台物理机上同个置放群组实例的限制个数。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "置放群组亲和性策略1中,同台物理机上同个置放群组实例的限制个数。", "example": "3", "member": "int64", "name": "LimitNum", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -7447,13 +7447,13 @@ }, { "disabled": false, - "document": "置放群组物理机型属性。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "置放群组物理机型属性。", "example": "TS85", "member": "string", "name": "DevClass", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -7647,23 +7647,23 @@ "members": [ { "disabled": false, - "document": "任务执行结果。可能的取值:INITIAL - 初始化,RUNNING - 运行中,SUCCESS - 执行成功,FAILED - 执行失败,KILLED - 已终止,REMOVED - 已删除,PAUSED - 终止中。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "任务执行结果。可能的取值:INITIAL - 初始化,RUNNING - 运行中,SUCCESS - 执行成功,FAILED - 执行失败,KILLED - 已终止,REMOVED - 已删除,PAUSED - 终止中。", "example": "SUCCESS", "member": "string", "name": "Status", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "任务执行信息描述。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "任务执行信息描述。", "example": "删除库表成功", "member": "string", "name": "Info", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -7694,13 +7694,13 @@ "members": [ { "disabled": false, - "document": "审计日志保存时长。目前支持的值包括:[0,7,30,180,365,1095,1825]。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "审计日志保存时长。目前支持的值包括:[0,7,30,180,365,1095,1825]。", "example": "365", "member": "int64", "name": "LogExpireDay", - "required": true, + "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -7708,7 +7708,7 @@ "example": "\"storage\"", "member": "string", "name": "LogType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -7718,19 +7718,19 @@ "example": "\"false\"", "member": "string", "name": "IsClosing", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, - "document": "审计服务开通时间。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "审计服务开通时间。", "example": "\"2021-07-13 11:34:35“", "member": "string", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -7881,13 +7881,13 @@ }, { "disabled": false, - "document": "审计日志文件详情。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "审计日志文件详情。", "example": "[{\"FileName\": \"shenji_andy\", \"CreateTime\": \"2024-03-20 17:09:13\",\"Status\": success}]", "member": "AuditLogFile", "name": "Items", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -8092,13 +8092,13 @@ }, { "disabled": false, - "document": "审计策略详情。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[{\"PolicyId\": \"cdbpolicy-asdfqwer\",\"Status\": \"running\",\"InstanceId\": \"cdb-qwerasdf\",\"InstanceName\": \"andy1\",\"CreateTime\": \"2019-03-20 17:09:13\",\"ModifyTime\": \"2019-03-20 17:09:13\",\"PolicyName\": \"audit_policy_1\",\"RuleId\": \"cdbrule-asdfqwer\",\"RuleName\": \"audit1\"}]", + "document": "审计策略详情。", + "example": "[{\"PolicyId\": \"cdbpolicy-asdfqwer\",\"Status\": \"running\",\"InstanceId\": \"cdb-qwerasdf\"}]", "member": "AuditPolicy", "name": "Items", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -8276,13 +8276,13 @@ }, { "disabled": false, - "document": "规则模板详细信息列表。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[\"CreateAt\": \"2022-12-06 00:54:01\",\"Description\": \"all_template_des\",\"RuleFilters\": [{\"Compare\": \"INC\",\"Type\": \"sqlType\",\"Value\": [\"ALTER\"]},{\"Compare\": \"EQS\",\"Type\": \"host\",\"Value\": [\"10.0.0.2\"]},{\"Compare\": \"NEQ\",\"Type\": \"user\",\"Value\": [\"lue\"},{\"Compare\": \"INC\",\"Type\": \"dbName\",\"Value\": [\"lue\"]}],\"RuleTemplateId\": \"cdb-art-lcpm4as3\",\"RuleTemplateName\": \"template_1\"}]", + "document": "规则模板详细信息列表。", + "example": "[\"Description\": \"all_template_des\",\"RuleFilters\": [{\"Compare\": \"INC\"}],\"RuleTemplateId\": \"cdb-art-lcpm4as3\"}]", "member": "AuditRuleTemplateInfo", "name": "Items", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -8784,33 +8784,33 @@ }, { "disabled": false, - "document": "用户在当前地域的异地备份总容量。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "用户在当前地域的异地备份总容量。", "example": "1000", "member": "int64", "name": "RemoteBackupVolume", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "归档备份容量,包含数据备份以及日志备份。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "归档备份容量,包含数据备份以及日志备份。", "example": "1", "member": "int64", "name": "BackupArchiveVolume", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "标准存储备份容量,包含数据备份以及日志备份。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "标准存储备份容量,包含数据备份以及日志备份。", "example": "1", "member": "int64", "name": "BackupStandbyVolume", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -9195,23 +9195,23 @@ "members": [ { "disabled": false, - "document": "代理组数量\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "代理组数量", "example": "1", "member": "uint64", "name": "Count", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "代理组信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[{\"ConnectionPoolLimit\": 5,\"ProxyAddress\": [{\"AutoAddRo\": true,\"ConnectionPool\": false,\"Desc\": \"\",\"FailOver\": true,\"IsKickOut\": false,\"MaxDelay\": 0,\"MinCount\": 0,\"ProxyAddressId\": \"proxyaddr-kti9m7d6\",\"AccessMode\": \"balance\",\"ProxyAllocation\": [{\"ProxyInstance\": [{\"InstanceId\": \"cdb-nuxj5ndd\",\"InstanceName\": \"andydb\",\"InstanceType\": \"1\",\"Region\": \"ap-nanjing\",\"Status\": 1,\"Weight\": 0,\"Zone\": \"ap-nanjing-1\"}],\"Region\": \"ap-nanjing\",\"Zone\": \"ap-nanjing-1\"}],\"ReadOnly\": false,\"TransSplit\": false,\"UniqSubnetId\": \"subnet-ijehnd\",\"UniqVpcId\": \"vpc-jnhekd\",\"VPort\": 3306,\"Vip\": \"10.0.0.0\",\"WeightMode\": \"custom\"}],\"ProxyGroupId\": \"proxy-mfxftest\",\"ProxyNode\": [{\"Cpu\": 2,\"Mem\": 4000,\"ProxyId\": \"proxynode-2u0c1tv1\",\"Region\": \"ap-nanjing\",\"Status\": \"online\",\"Zone\": \"ap-nanjing-1\",\"Connection\": 1}],\"ProxyVersion\": \"1.3.7\",\"Status\": \"online\",\"SupportCreateProxyAddress\": false,\"SupportUpgradeProxyMysqlVersion\": \"20211030\",\"SupportUpgradeProxyVersion\": \"1.3.7\",\"TaskStatus\": \"ProxyModifyAddress\"}]", + "document": "代理组信息", + "example": "无", "member": "ProxyGroupInfo", "name": "ProxyInfos", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -9407,7 +9407,7 @@ { "disabled": false, "document": "实例 ID 。", - "example": "cdb-test", + "example": "cdb-xxdasd", "member": "string", "name": "InstanceId", "required": true, @@ -9421,30 +9421,33 @@ "members": [ { "disabled": false, - "document": "策略类型。可选值 auto、manual。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "策略类型。可选值 auto、manual。", "example": "auto", "member": "string", "name": "Type", + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "手动扩容的 CPU 。Type为 manual 时有效。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "手动扩容的 CPU 。Type为 manual 时有效。", "example": "4", "member": "string", "name": "ExpandCpu", + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { - "disabled": false, - "document": "自动扩容策略。Type 为 auto 时有效\n注意:此字段可能返回 null,表示取不到有效值。", + "disabled": true, + "document": "自动扩容策略。Type 为 auto 时有效", "example": "略", "member": "string", "name": "AutoStrategy", + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -9632,7 +9635,7 @@ "example": "4", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -9642,7 +9645,7 @@ "example": "无", "member": "ImportRecord", "name": "Items", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -9866,33 +9869,33 @@ }, { "disabled": false, - "document": "加密使用的密钥 ID 。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "加密使用的密钥 ID 。", "example": "***-CDB", "member": "string", "name": "KeyId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "密钥所在地域。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "密钥所在地域。", "example": "ap-guangzhou", "member": "string", "name": "KeyRegion", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "当前 CDB 后端服务使用的 KMS 服务的默认地域。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "当前 CDB 后端服务使用的 KMS 服务的默认地域。", "example": "ap-shanghai", "member": "string", "name": "DefaultKmsRegion", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -10030,7 +10033,7 @@ { "disabled": false, "document": "实例的内网 IP 地址。", - "example": "\"\"", + "example": "[\"172.1.1.1\"]", "member": "string", "name": "Vips", "required": false, @@ -10066,7 +10069,7 @@ { "disabled": false, "document": "安全组 ID。当使用安全组 ID 为过滤条件时,需指定 WithSecurityGroup 参数为 1。", - "example": "\"\"", + "example": "sg-ajr1jzgj", "member": "string", "name": "SecurityGroupId", "required": false, @@ -10084,7 +10087,7 @@ { "disabled": false, "document": "实例名称。", - "example": "\"\"", + "example": "[\"cdb27418\"]", "member": "string", "name": "InstanceNames", "required": false, @@ -10092,7 +10095,7 @@ }, { "disabled": false, - "document": "实例任务状态,可能取值:<br>0 - 没有任务<br>1 - 升级中<br>2 - 数据导入中<br>3 - 开放Slave中<br>4 - 外网访问开通中<br>5 - 批量操作执行中<br>6 - 回档中<br>7 - 外网访问关闭中<br>8 - 密码修改中<br>9 - 实例名修改中<br>10 - 重启中<br>12 - 自建迁移中<br>13 - 删除库表中<br>14 - 灾备实例创建同步中<br>15 - 升级待切换<br>16 - 升级切换中<br>17 - 升级切换完成<br>19 - 参数设置待执行", + "document": "实例任务状态,可能取值:<br>0 - 没有任务<br>1 - 升级中<br>2 - 数据导入中<br>3 - 开放Slave中<br>4 - 外网访问开通中<br>5 - 批量操作执行中<br>6 - 回档中<br>7 - 外网访问关闭中<br>8 - 密码修改中<br>9 - 实例名修改中<br>10 - 重启中<br>12 - 自建迁移中<br>13 - 删除库表中<br>14 - 灾备实例创建同步中<br>15 - 升级待切换<br>16 - 升级切换中<br>17 - 升级切换完成<br>19 - 参数设置待执行<br>34 - 原地升级待执行", "example": "0", "member": "uint64", "name": "TaskStatus", @@ -10102,7 +10105,7 @@ { "disabled": false, "document": "实例数据库引擎版本,可能取值:5.1、5.5、5.6 和 5.7。", - "example": "\"5.6\"", + "example": "[\"5.7\",\"8.0\"]", "member": "string", "name": "EngineVersions", "required": false, @@ -10147,7 +10150,7 @@ { "disabled": false, "document": "返回结果集排序的字段,目前支持:\"InstanceId\",\"InstanceName\",\"CreateTime\",\"DeadlineTime\"。", - "example": "\"\"", + "example": "InstanceId", "member": "string", "name": "OrderBy", "required": false, @@ -10183,7 +10186,7 @@ { "disabled": false, "document": "独享集群 ID。", - "example": "\"\"", + "example": "cdb-g2ql0j11", "member": "string", "name": "ExClusterId", "required": false, @@ -10192,7 +10195,7 @@ { "disabled": false, "document": "实例 ID。", - "example": "[\"cdb-70zdmgg1\\r\\n\"]", + "example": "[\"cdb-70zdmgg1\"]", "member": "string", "name": "InstanceIds", "required": false, @@ -10237,7 +10240,7 @@ { "disabled": false, "document": "置放群组ID列表。", - "example": "\"\"", + "example": "[\"\"]", "member": "string", "name": "DeployGroupIds", "required": false, @@ -10255,7 +10258,7 @@ { "disabled": false, "document": "金融围拢 ID 。", - "example": "[\"cage-test\"]", + "example": "[\"cage-dhges\"]", "member": "string", "name": "CageIds", "required": false, @@ -10290,8 +10293,8 @@ }, { "disabled": false, - "document": "标签键值", - "example": "无", + "document": "标签键值\n请注意,创建中的实例无法查询到标签。", + "example": "[{\"TagKey\": \"name\",\"TagValue\": \"zhang\"}]", "member": "Tag", "name": "Tags", "required": false, @@ -10327,7 +10330,7 @@ { "disabled": false, "document": "是否获取集群版实例节点信息,可填:true或false", - "example": "无", + "example": "false", "member": "bool", "name": "QueryClusterInfo", "required": false, @@ -10352,7 +10355,7 @@ { "disabled": false, "document": "实例详细信息列表。", - "example": "无", + "example": "[{}]", "member": "InstanceInfo", "name": "Items", "output_required": true, @@ -11013,13 +11016,13 @@ }, { "disabled": false, - "document": "返回列表。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[{\"DeployGroupId\": \"ps-7t11vrwf\",\"DeployGroupName\": \"andy\", \"CreateTime\": \"2024-10-30 11:26:00\",\"Quota\": 50,\"Affinity\": \"1\",\"LimitNum\": \"1\",\"Description\": \"置放群组一区\",\"DevClass\": \"TS85\"}]", + "document": "返回列表。", + "example": "无", "member": "DeployGroupInfo", "name": "Items", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -11190,13 +11193,13 @@ }, { "disabled": false, - "document": "返回的记录。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "返回的记录。", "example": "[{\"Content\": \"show master status\",\"Timestamp\": 1585142640}]", "member": "ErrlogItem", "name": "Items", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -11309,13 +11312,13 @@ }, { "disabled": false, - "document": "事件信息。查询不到信息时,Items为null。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[{\"EventName\": \"PlannedSwitch\",\"EventStatus\": \"1\",\"InstanceId\": \"cdb-fbd5agyt\",\"NodeId\": \"\",\"OccurTime\": \"2024-11-25 14:46:42\"}]", + "document": "事件信息。查询不到信息时,Items为null。", + "example": "无", "member": "InstEventInfo", "name": "Items", "output_required": false, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -11757,7 +11760,7 @@ { "disabled": false, "document": "参数详情", - "example": "[]", + "example": "无", "member": "ParameterDetail", "name": "Items", "output_required": true, @@ -11786,13 +11789,13 @@ }, { "disabled": false, - "document": "参数模板引擎。支持值包括:\"InnoDB\",\"RocksDB\"。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "参数模板引擎。支持值包括:\"InnoDB\",\"RocksDB\"。", "example": "InnoDB", "member": "string", "name": "EngineType", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -11854,17 +11857,17 @@ "example": "1", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "参数模板详情。", - "example": "无", + "example": "[{\"TemplateId\": 2333,\"Name\": \"andy_5.7\",\"Description\": \"一区参数\",\"EngineVersion\": \"5.7\",\"TemplateType\": \"HIGH_STABILITY\", \"EngineType\": \"InnoDB\"}]", "member": "ParamTemplateInfo", "name": "Items", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -11962,33 +11965,33 @@ "members": [ { "disabled": false, - "document": "代理配置数\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "代理配置数", "example": "10", "member": "uint64", "name": "Count", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "代理配置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{\"Device\": \"Z3\",\"Type\": \"高可用版本\",\"DeviceType\": \"custom\",\"Memory\": 4000,\"Cpu\": 2,\"VolumeMin\": 10,\"VolumeMax\": 500,\"VolumeStep\": 5,\"SupportZone\": [\"ap-beijing-3\"]}", + "document": "代理配置", + "example": "无", "member": "CustomConfig", "name": "CustomConf", "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "权重限制\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{\"LessThan\": 2000,\"Weight\": 1}", + "document": "权重限制", + "example": "{\"LessThan\":2000,\"Weight\":1}", "member": "Rule", "name": "WeightRule", "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -12019,103 +12022,103 @@ "members": [ { "disabled": false, - "document": "支持最大代理版本\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "支持最大代理版本", "example": "1.3.1", "member": "string", "name": "ProxyVersion", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否支持连接池\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否支持连接池", "example": "true", "member": "bool", "name": "SupportPool", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "连接池最小值\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "连接池最小值", "example": "1", "member": "uint64", "name": "PoolMin", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "连接池最大值\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "连接池最大值", "example": "10", "member": "uint64", "name": "PoolMax", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否支持事务拆分\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否支持事务拆分", "example": "true", "member": "bool", "name": "SupportTransSplit", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "支持连接池的最小代理版本\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "支持连接池的最小代理版本", "example": "1.1.1", "member": "string", "name": "SupportPoolMinVersion", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "支持事务拆分的最小代理版本\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "支持事务拆分的最小代理版本", "example": "1.3.1", "member": "string", "name": "SupportTransSplitMinVersion", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否支持设置只读\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否支持设置只读", "example": "true", "member": "bool", "name": "SupportReadOnly", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否自动均衡负载\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否自动均衡负载", "example": "true", "member": "bool", "name": "SupportAutoLoadBalance", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否支持接入模式\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否支持接入模式", "example": "true", "member": "bool", "name": "SupportAccessMode", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -12412,19 +12415,19 @@ "example": "2", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "回档任务详情。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "回档任务详情。", "example": "无", "member": "RollbackTask", "name": "Items", - "required": true, + "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -12620,13 +12623,13 @@ }, { "disabled": false, - "document": "查询到的记录。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[{\"Database\": \"1231231\",\"LockTime\": 1,\"Md5\": \"23123123\",\"QueryTime\": 100,\"RowsExamined\": 0,\"RowsSent\": 0,\"SqlTemplate\": \"show master status111111\",\"SqlText\": \"update order_logistics set logistics_status = 205 where logistics_id in ( select `logistics_id` from `order_info` where order_no in('15706082880074381752','15706082880074381751'))\",\"Timestamp\": 1585**2640,\"UserHost\": \"localhost\",\"UserName\": \"march\"}]", + "document": "查询到的记录。", + "example": "无", "member": "SlowLogItem", "name": "Items", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -13225,7 +13228,7 @@ { "disabled": false, "document": "实例CPU监控数据", - "example": "无", + "example": "[20,30]", "member": "int64", "name": "Load", "output_required": true, @@ -13453,7 +13456,7 @@ "example": "1", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -13463,7 +13466,7 @@ "example": "ap-beijing-3", "member": "string", "name": "Zone", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -13473,7 +13476,7 @@ "example": "cdb-***", "member": "string", "name": "InstanceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -13483,7 +13486,7 @@ "example": "ap-beijing", "member": "string", "name": "Region", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -13493,7 +13496,7 @@ "example": "2", "member": "int64", "name": "SyncStatus", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -13503,7 +13506,7 @@ "example": "******", "member": "string", "name": "InstanceName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -13513,7 +13516,7 @@ "example": "2", "member": "int64", "name": "InstanceType", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -13525,23 +13528,23 @@ "members": [ { "disabled": false, - "document": "错误发生时间。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "错误发生时间。", "example": "1585142640 ", "member": "uint64", "name": "Timestamp", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "错误详情\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "错误详情", "example": "show master status", "member": "string", "name": "Content", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -13551,133 +13554,133 @@ "members": [ { "disabled": false, - "document": "状态值\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "状态值", "example": "3", "member": "int64", "name": "Status", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "状态值\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "状态值", "example": "1", "member": "int64", "name": "Code", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "执行时间\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "执行时间", "example": "0", "member": "int64", "name": "CostTime", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例ID", "example": "cdb-c1nl9rpv", "member": "string", "name": "InstanceId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "后端任务ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "后端任务ID", "example": "1649290", "member": "string", "name": "WorkId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "导入文件名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "导入文件名", "example": "monkey_1501490864.sql", "member": "string", "name": "FileName", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "执行进度\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "执行进度", "example": "5", "member": "int64", "name": "Process", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "任务创建时间\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "任务创建时间", "example": "2017-11-09 14:26:31", "member": "datetime", "name": "CreateTime", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "文件大小\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "文件大小", "example": "12", "member": "string", "name": "FileSize", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "任务执行信息\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "任务执行信息", "example": "lock_inst.cgi: 某些实例id不存在对应的实例记录", "member": "string", "name": "Message", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "任务ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "任务ID", "example": "16242", "member": "int64", "name": "JobId", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "导入库表名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "导入库表名", "example": "abdy_table", "member": "string", "name": "DbName", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "异步任务的请求ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "异步任务的请求ID", "example": "a4788d0a-df23758a-ac961e5a-af414d33", "member": "string", "name": "AsyncRequestId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -13904,13 +13907,13 @@ }, { "disabled": false, - "document": "节点ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "节点ID", "example": "dbn-it3iv15s", "member": "string", "name": "NodeId", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -13973,123 +13976,123 @@ }, { "disabled": false, - "document": "任务状态。0-无任务;1-审计开启中,2-审计关闭中。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "任务状态。0-无任务;1-审计开启中,2-审计关闭中。", "example": "0", "member": "uint64", "name": "AuditTask", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "日志保留时长。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "日志保留时长。", "example": "30", "member": "uint64", "name": "LogExpireDay", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "高频存储时长。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "高频存储时长。", "example": "7", "member": "uint64", "name": "HighLogExpireDay", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "低频存储时长。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "低频存储时长。", "example": "23", "member": "uint64", "name": "LowLogExpireDay", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "日志存储量。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "日志存储量。", "example": "173749.248", "member": "float", "name": "BillingAmount", "output_required": true, "type": "float", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "高频存储量。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "高频存储量。", "example": "45639.68", "member": "float", "name": "HighRealStorage", "output_required": true, "type": "float", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "低频存储量。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "低频存储量。", "example": "128109.568", "member": "float", "name": "LowRealStorage", "output_required": true, "type": "float", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否为全审计。true-表示全审计。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否为全审计。true-表示全审计。", "example": "true", "member": "bool", "name": "AuditAll", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "审计开通时间。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "审计开通时间。", "example": "2022-10-12 11:41:42", "member": "string", "name": "CreateAt", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例相关信息\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例相关信息", "example": "[{\"ProjectId\": \"23414\",\"TagList\": [{\"TagKey\": \"created-by\",\"TagValue\": \"andy\"}],\"DbType\": \"MYSQL\",\"DbVersion\": \"5.7\"}]", "member": "AuditInstanceInfo", "name": "InstanceInfo", "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "总存储量。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "总存储量。", "example": "173749.248", "member": "float", "name": "RealStorage", "output_required": true, "type": "float", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否包含审计策略\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否包含审计策略", "example": "false", "member": "bool", "name": "OldRule", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -14110,7 +14113,7 @@ { "disabled": false, "document": "外网状态,可能的返回值为:0-未开通外网;1-已开通外网;2-已关闭外网", - "example": "0", + "example": "2", "member": "int64", "name": "WanStatus", "output_required": true, @@ -14139,13 +14142,13 @@ }, { "disabled": false, - "document": "只读vip信息。单独开通只读实例访问的只读实例才有该字段\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{}", + "document": "只读vip信息。单独开通只读实例访问的只读实例才有该字段", + "example": "{\"RoVip\":\"10.1.1.1\",\"RoVport\":3306,\"RoVpcId\":2123412,\"RoSubnetId\":123412,\"RoVipStatus\":2}", "member": "RoVipInfo", "name": "RoVipInfo", "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -14179,13 +14182,13 @@ }, { "disabled": false, - "document": "备机信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{}", + "document": "备机信息", + "example": "{\"First\":{\"Vport\":3306,\"Vip\":\"10.1.1.1\",\"Region\":\"ap-guangzhou\",\"Zone\":\"ap-guangzhou-1\"}}", "member": "SlaveInfo", "name": "SlaveInfo", "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -14220,7 +14223,7 @@ { "disabled": false, "document": "数据复制方式。0 - 异步复制;1 - 半同步复制;2 - 强同步复制", - "example": "0", + "example": "1", "member": "int64", "name": "ProtectMode", "output_required": true, @@ -14229,13 +14232,13 @@ }, { "disabled": false, - "document": "只读组详细信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "document": "只读组详细信息", + "example": "[{\"RoGroupId\":\"cdbrg-92zkeaq2\"}]", "member": "RoGroup", "name": "RoGroups", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -14260,7 +14263,7 @@ { "disabled": false, "document": "项目 ID", - "example": "0", + "example": "12451", "member": "int64", "name": "ProjectId", "output_required": true, @@ -14290,7 +14293,7 @@ { "disabled": false, "document": "可用区部署方式。可能的值为:0 - 单可用区;1 - 多可用区", - "example": "0", + "example": "1", "member": "int64", "name": "DeployMode", "output_required": true, @@ -14300,7 +14303,7 @@ { "disabled": false, "document": "实例任务状态。0 - 没有任务 ,1 - 升级中,2 - 数据导入中,3 - 开放Slave中,4 - 外网访问开通中,5 - 批量操作执行中,6 - 回档中,7 - 外网访问关闭中,8 - 密码修改中,9 - 实例名修改中,10 - 重启中,12 - 自建迁移中,13 - 删除库表中,14 - 灾备实例创建同步中,15 - 升级待切换,16 - 升级切换中,17 - 升级切换完成", - "example": "0", + "example": "1", "member": "int64", "name": "TaskStatus", "output_required": true, @@ -14309,13 +14312,13 @@ }, { "disabled": false, - "document": "主实例详细信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{}", + "document": "主实例详细信息", + "example": "{\"InstanceId\":\"cdb-xxx\"}", "member": "MasterInfo", "name": "MasterInfo", "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -14349,18 +14352,18 @@ }, { "disabled": false, - "document": "灾备实例详细信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "document": "灾备实例详细信息", + "example": "{\"InstanceId\":\"cdb-xxx\"}", "member": "DrInfo", "name": "DrInfo", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, "document": "外网域名", - "example": "''", + "example": "gz-cdb-******.sql.tencentcdb.com", "member": "string", "name": "WanDomain", "output_required": true, @@ -14370,7 +14373,7 @@ { "disabled": false, "document": "外网端口号", - "example": "0", + "example": "25640", "member": "int64", "name": "WanPort", "output_required": true, @@ -14450,7 +14453,7 @@ { "disabled": false, "document": "物理 ID", - "example": "''", + "example": "phyxxx", "member": "string", "name": "PhysicalId", "output_required": true, @@ -14489,33 +14492,33 @@ }, { "disabled": false, - "document": "物理机型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "‘’", + "document": "物理机型", + "example": "VSWEQ", "member": "string", "name": "DeviceClass", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "置放群组 ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "‘’", + "document": "置放群组 ID", + "example": "andy", "member": "string", "name": "DeployGroupId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "可用区 ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "可用区 ID", "example": "800003", "member": "int64", "name": "ZoneId", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -14529,33 +14532,33 @@ }, { "disabled": false, - "document": "标签列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "document": "标签列表", + "example": "[{\"TagKey\":\"tag\",\"TagValue\":\"value\"}]", "member": "TagInfoItem", "name": "TagList", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "引擎类型\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "引擎类型", "example": "InnoDB", "member": "string", "name": "EngineType", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "最大延迟阈值\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "最大延迟阈值", "example": "1", "member": "int64", "name": "MaxDelayTime", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -14569,23 +14572,23 @@ }, { "disabled": false, - "document": "当前扩容的CPU核心数。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "当前扩容的CPU核心数。", + "example": "2", "member": "int64", "name": "ExpandCpu", "output_required": false, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例集群版节点信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "实例集群版节点信息", + "example": "[{\"NodeId\":\"node\"}]", "member": "ClusterInfo", "name": "ClusterInfo", "output_required": false, "type": "list", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -14595,23 +14598,23 @@ "members": [ { "disabled": false, - "document": "实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同", "example": "cdb-c1nl9rpv", "member": "string", "name": "InstanceId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "预期重启时间\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "预期重启时间", "example": "360", "member": "int64", "name": "TimeInSeconds", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -14621,43 +14624,43 @@ "members": [ { "disabled": false, - "document": "查询数据库错误码\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "查询数据库错误码", "example": "0", "member": "int64", "name": "Code", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "查询数据库错误信息\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "查询数据库错误信息", "example": "ok", "member": "string", "name": "Message", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例ID列表,单个实例Id的格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例ID列表,单个实例Id的格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同", "example": "cdb-fix44sxh", "member": "string", "name": "InstanceId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "可回档时间范围\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "可回档时间范围", "example": "[{\"Begin\": \"2024-08-21 02:06:20\",\"End\": \"2024-08-25 17:52:05\"}]", "member": "RollbackTimeRange", "name": "Times", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -14682,13 +14685,13 @@ "members": [ { "disabled": false, - "document": "异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。(该返回字段目前已废弃,可以通过 DescribeDBInstances 接口查询实例的隔离状态)\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。(该返回字段目前已废弃,可以通过 DescribeDBInstances 接口查询实例的隔离状态)", "example": "e48eb1e9-0ca0ecae-c0dac9c7-60d12864", "member": "string", "name": "AsyncRequestId", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -14756,43 +14759,43 @@ "members": [ { "disabled": false, - "document": "模板ID。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "模板ID。", "example": "cdb-art-8qx2kcr7", "member": "string", "name": "RuleTemplateId", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "规则模板名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "规则模板名", "example": "test_rule", "member": "string", "name": "RuleTemplateName", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "告警等级。1-低风险,2-中风险,3-高风险。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "告警等级。1-低风险,2-中风险,3-高风险。", "example": "2", "member": "string", "name": "AlarmLevel", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "规则模板变更状态:0-未变更;1-已变更;2-已删除\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "规则模板变更状态:0-未变更;1-已变更;2-已删除", "example": "1", "member": "int64", "name": "RuleTemplateStatus", "output_required": false, "type": "int", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -14899,7 +14902,7 @@ { "disabled": false, "document": "实例长ID", - "example": "''", + "example": "1241asdd-qwed1-213-dad", "member": "string", "name": "ResourceId", "output_required": true, @@ -15009,7 +15012,7 @@ { "disabled": false, "document": "独享集群ID", - "example": "''", + "example": "andy", "member": "string", "name": "ExClusterId", "output_required": true, @@ -16522,7 +16525,7 @@ { "disabled": false, "document": "进行基础网络转 VPC 网络和 VPC 网络下的子网变更时,原网络中旧IP的回收时间,单位为小时,取值范围为0-168,默认值为24小时。", - "example": "12", + "example": "24", "member": "int64", "name": "ReleaseDuration", "required": false, @@ -16545,13 +16548,13 @@ "members": [ { "disabled": false, - "document": "异步任务ID。(该返回字段目前已废弃)\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "异步任务ID。(该返回字段目前已废弃)", "example": "d2baf2fb-cbae62df-7dd0d736-9cbd3e31", "member": "string", "name": "AsyncRequestId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -17034,13 +17037,13 @@ "members": [ { "disabled": false, - "document": "异步任务 ID。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "异步任务 ID。", "example": "dadaddasda-23adcasdasd-asdaasc", "member": "string", "name": "AsyncRequestId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -17645,13 +17648,13 @@ }, { "disabled": false, - "document": "参数模板引擎\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "参数模板引擎", "example": "InnoDB", "member": "string", "name": "EngineType", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -17766,7 +17769,7 @@ { "disabled": false, "document": "参数的可选枚举值。如果为非枚举参数,则为空", - "example": "[]", + "example": "[\"yes\",\"no\"]", "member": "string", "name": "EnumValue", "output_required": true, @@ -17795,13 +17798,13 @@ }, { "disabled": false, - "document": "参数是否不支持修改\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "参数是否不支持修改", "example": "false", "member": "bool", "name": "IsNotSupportEdit", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -17861,113 +17864,113 @@ }, { "disabled": false, - "document": "权重分配模式;\n系统自动分配:\"system\", 自定义:\"custom\"\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "权重分配模式;\n系统自动分配:\"system\", 自定义:\"custom\"", "example": "system", "member": "string", "name": "WeightMode", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否开启延迟剔除,取值:\"true\" | \"false\"\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否开启延迟剔除,取值:\"true\" | \"false\"", "example": "true", "member": "bool", "name": "IsKickOut", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "最小保留数量,最小取值:0\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "最小保留数量,最小取值:0", "example": "2", "member": "uint64", "name": "MinCount", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "延迟剔除阈值,最小取值:0\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "延迟剔除阈值,最小取值:0", "example": "10", "member": "uint64", "name": "MaxDelay", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否自动添加RO,取值:\"true\" | \"false\"\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否自动添加RO,取值:\"true\" | \"false\"", "example": "true", "member": "bool", "name": "AutoAddRo", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否是只读,取值:\"true\" | \"false\"\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否是只读,取值:\"true\" | \"false\"", "example": "false", "member": "bool", "name": "ReadOnly", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否开启事务分离\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否开启事务分离", "example": "true", "member": "bool", "name": "TransSplit", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否开启故障转移\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否开启故障转移", "example": "true", "member": "bool", "name": "FailOver", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否开启连接池\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否开启连接池", "example": "true", "member": "bool", "name": "ConnectionPool", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "描述\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "描述", "example": "代理一区", "member": "string", "name": "Desc", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例读权重分配\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[{\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\",\"ProxyInstance\": [{\"InstanceId\": \"cdb-aykuksx3\",\"InstanceName\": \"cdb37262\",\"InstanceType\": \"1\",\"Status\": \"1\",\"Weight\": \"100\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\",\"InstNodeId\": \"cbn-ehjshe\",\"InstNodeRole\": \"master\"}]}]", + "document": "实例读权重分配", + "example": "[{\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\",\"ProxyInstance\": [{\"InstanceId\": \"cdb-aykuksx3\"}]}]", "member": "ProxyAllocation", "name": "ProxyAllocation", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -18046,93 +18049,93 @@ }, { "disabled": false, - "document": "代理版本\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "代理版本", "example": "1.2.1", "member": "string", "name": "ProxyVersion", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "代理支持升级版本\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "代理支持升级版本", "example": "1.3.1", "member": "string", "name": "SupportUpgradeProxyVersion", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "代理状态\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "代理状态", "example": "online", "member": "string", "name": "Status", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "代理任务状态\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "代理任务状态", "example": "upgrade", "member": "string", "name": "TaskStatus", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "代理组节点信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[{\"ProxyId\": \"proxynode-ehnjshe\",\"Cpu\": \"2\",\"Mem\": \"4000\",\"Status\": \"online\",\"Zone\": \"ap-guangzhou-1\",\"Region\": \"ap-guangzhou\",\"Connection\": \"100\"}]", + "document": "代理组节点信息", + "example": "无", "member": "ProxyNode", "name": "ProxyNode", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "代理组地址信息\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "代理组地址信息", "example": "无", "member": "ProxyAddress", "name": "ProxyAddress", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "连接池阈值\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "连接池阈值", "example": "10", "member": "uint64", "name": "ConnectionPoolLimit", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "支持创建地址\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "支持创建地址", "example": "true", "member": "bool", "name": "SupportCreateProxyAddress", "output_required": true, "type": "bool", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "支持升级代理版本所需的cdb版本\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "支持升级代理版本所需的cdb版本", "example": "20210330", "member": "string", "name": "SupportUpgradeProxyMysqlVersion", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -18142,80 +18145,80 @@ "members": [ { "disabled": false, - "document": "实例ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例ID", "example": "cdb-aykuksx3", "member": "string", "name": "InstanceId", "output_required": true, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例名称\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例名称", "example": "cdb3874", "member": "string", "name": "InstanceName", "output_required": true, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例类型:1 master 主实例; 2 ro 只读实例; 3 dr 灾备实例; 4 sdr 小灾备实例\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例类型:1 master 主实例; 2 ro 只读实例; 3 dr 灾备实例; 4 sdr 小灾备实例", "example": "1", "member": "int64", "name": "InstanceType", "output_required": true, "required": false, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例状态,可能的返回值:0-创建中;1-运行中;4-隔离中;5-已隔离\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例状态,可能的返回值:0-创建中;1-运行中;4-隔离中;5-已隔离", "example": "1", "member": "int64", "name": "Status", "output_required": true, "required": false, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "只读权重,如果权重为系统自动分配,改值不生效,只代表是否启用该实例\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "只读权重,如果权重为系统自动分配,改值不生效,只代表是否启用该实例", "example": "100", "member": "uint64", "name": "Weight", "output_required": true, "required": false, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例所属地域\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例所属地域", "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例所属可用区\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例所属可用区", "example": "ap-guangzhou-1", "member": "string", "name": "Zone", "output_required": true, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -18247,73 +18250,73 @@ "members": [ { "disabled": false, - "document": "代理节点ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "代理节点ID", "example": "proxynode-tets", "member": "string", "name": "ProxyId", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "CPU核数\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "CPU核数", "example": "4", "member": "uint64", "name": "Cpu", - "required": true, + "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "内存大小\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "内存大小", "example": "100", "member": "uint64", "name": "Mem", - "required": true, + "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "节点状态\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "节点状态", "example": "online", "member": "string", "name": "Status", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "代理节点可用区\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "代理节点可用区", "example": "ap-guangzhou-1", "member": "string", "name": "Zone", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "代理节点地域\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "代理节点地域", "example": "ap-guangzhou", "member": "string", "name": "Region", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "连接数\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "连接数", "example": "100", "member": "uint64", "name": "Connection", - "required": true, + "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -18494,7 +18497,7 @@ { "disabled": false, "document": "实例解隔离操作的错误信息。", - "example": "无", + "example": "message", "member": "string", "name": "Message", "output_required": true, @@ -18873,7 +18876,7 @@ { "disabled": false, "document": "只读组中的只读实例详情。", - "example": "[]", + "example": "无", "member": "RoInstanceInfo", "name": "RoInstances", "output_required": true, @@ -18905,58 +18908,58 @@ }, { "disabled": false, - "document": "私有网络 ID。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "私有网络 ID。", "example": "vpc-ja6ts123", "member": "string", "name": "UniqVpcId", "output_required": true, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "子网 ID。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "子网 ID。", "example": "subnet-njh2bc99", "member": "string", "name": "UniqSubnetId", "output_required": true, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "只读组所在的地域。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "只读组所在的地域。", "example": "ap-beijing", "member": "string", "name": "RoGroupRegion", "output_required": true, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "只读组所在的可用区。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "只读组所在的可用区。", "example": "ap-beijing-3", "member": "string", "name": "RoGroupZone", "output_required": true, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "延迟复制时间。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "延迟复制时间。", "example": "1000", "member": "int64", "name": "DelayReplicationTime", "output_required": true, "required": false, "type": "int", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -19264,7 +19267,7 @@ { "disabled": false, "document": "RO实例到期时间,时间格式:yyyy-mm-dd hh:mm:ss,如实例为按量计费模式,则此字段值为0000-00-00 00:00:00", - "example": "‘’", + "example": "2024-09-09 16:40:30", "member": "string", "name": "DeadlineTime", "output_required": true, @@ -19291,53 +19294,53 @@ "members": [ { "disabled": false, - "document": "只读vip状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "只读vip状态", + "example": "2", "member": "int64", "name": "RoVipStatus", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "只读vip的子网\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "subnet-8i2pdj11", + "document": "只读vip的子网", + "example": "2132421", "member": "int64", "name": "RoSubnetId", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "只读vip的私有网络\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "vpc-1dhhbc11", + "document": "只读vip的私有网络", + "example": "13421234", "member": "int64", "name": "RoVpcId", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "只读vip的端口号\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "只读vip的端口号", "example": "3306", "member": "int64", "name": "RoVport", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "只读vip\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "只读vip", "example": "10.1.1.1", "member": "string", "name": "RoVip", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -19371,25 +19374,25 @@ "members": [ { "disabled": false, - "document": "回档前的原数据库名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "回档前的原数据库名", "example": "db1", "member": "string", "name": "DatabaseName", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "回档后的新数据库名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "回档后的新数据库名", "example": "dbnew", "member": "string", "name": "NewDatabaseName", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -19399,14 +19402,14 @@ "members": [ { "disabled": false, - "document": "云数据库实例ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "云数据库实例ID", "example": "cdb-aeti0q11", "member": "string", "name": "InstanceId", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -19432,25 +19435,25 @@ }, { "disabled": false, - "document": "待回档的数据库信息,表示整库回档\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "待回档的数据库信息,表示整库回档", "example": "[{\"DatabaseName\": \"db1\",\"NewDatabaseName\": \"db2\"}]", "member": "RollbackDBName", "name": "Databases", "output_required": true, "required": false, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "待回档的数据库表信息,表示按表回档\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "待回档的数据库表信息,表示按表回档", "example": "[{\"Database\": \"db1\",\"Table\": [{\"TableName\": \"andytable1\",\"NewTableName\": \"andytable2\"}]}]", "member": "RollbackTables", "name": "Tables", "output_required": true, "required": false, "type": "list", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -19460,25 +19463,25 @@ "members": [ { "disabled": false, - "document": "回档前的原数据库表名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "回档前的原数据库表名", "example": "table1", "member": "string", "name": "TableName", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "回档后的新数据库表名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "回档后的新数据库表名", "example": "table2", "member": "string", "name": "NewTableName", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -19488,25 +19491,25 @@ "members": [ { "disabled": false, - "document": "数据库名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库名", "example": "db1", "member": "string", "name": "Database", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "数据库表详情\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库表详情", "example": "[{\"TableName\": \"table1\",\"NewTableName\": \"table2\"}]", "member": "RollbackTableName", "name": "Table", "output_required": true, "required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -19566,13 +19569,13 @@ }, { "disabled": false, - "document": "回档任务详情。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[{\"InstanceId\": \"cdb-qwer1234\",\"Strategy\": \"full\",\"RollbackTime\": \"2020-04-22 10:00:57\",\"Databases\": [],\"Tables\": [{\"Table\": [{\"TableName\": \"sbtest1\",\"NewTableName\": \"sbtest1_bak\"},{\"TableName\": \"sbtest2\",\"NewTableName\": \"sbtest2_bak\"}],\"Database\": \"dbtest_bak\"}]}]", + "document": "回档任务详情。", + "example": "无", "member": "RollbackInstancesInfo", "name": "Detail", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -19582,23 +19585,23 @@ "members": [ { "disabled": false, - "document": "实例可回档开始时间,时间格式:2016-10-29 01:06:04\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例可回档开始时间,时间格式:2016-10-29 01:06:04", "example": "2024-10-29 01:06:04", "member": "string", "name": "Begin", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例可回档结束时间,时间格式:2016-11-02 11:44:47\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例可回档结束时间,时间格式:2016-11-02 11:44:47", "example": "2024-10-30 01:06:04", "member": "string", "name": "End", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -19608,23 +19611,23 @@ "members": [ { "disabled": false, - "document": "划分上限\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "划分上限", "example": "100", "member": "uint64", "name": "LessThan", - "required": true, + "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "权重\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "权重", "example": "5", "member": "uint64", "name": "Weight", - "required": true, + "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -19802,73 +19805,73 @@ "members": [ { "disabled": false, - "document": "项目ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "项目ID", "example": "0", "member": "int64", "name": "ProjectId", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "创建时间,时间格式:yyyy-mm-dd hh:mm:ss\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "创建时间,时间格式:yyyy-mm-dd hh:mm:ss", "example": "2024-04-13 15:00:06", "member": "string", "name": "CreateTime", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "入站规则\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "document": "入站规则", + "example": "无", "member": "Inbound", "name": "Inbound", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "出站规则\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "document": "出站规则", + "example": "无", "member": "Outbound", "name": "Outbound", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "安全组ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "安全组ID", "example": "sg-**", "member": "string", "name": "SecurityGroupId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "安全组名称\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "安全组名称", "example": "cdb", "member": "string", "name": "SecurityGroupName", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "安全组备注\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "安全组备注", "example": "cdb安全组", "member": "string", "name": "SecurityGroupRemark", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -19878,23 +19881,23 @@ "members": [ { "disabled": false, - "document": "从库复制方式,可能的返回值:aysnc-异步,semisync-半同步\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "从库复制方式,可能的返回值:aysnc-异步,semisync-半同步", "example": "aysnc", "member": "string", "name": "ReplicationMode", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "从库可用区的正式名称,如ap-shanghai-1\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "从库可用区的正式名称,如ap-shanghai-1", "example": "ap-shanghai-1", "member": "string", "name": "Zone", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -19914,13 +19917,13 @@ }, { "disabled": false, - "document": "第二备机信息\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "第二备机信息", "example": "{\"Vport\": 3306,\"Vip\": \"10.1.0.1\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\"}", "member": "SlaveInstanceInfo", "name": "Second", "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -20042,113 +20045,113 @@ "members": [ { "disabled": false, - "document": "Sql的执行时间。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "Sql的执行时间。", "example": "1637894492", "member": "uint64", "name": "Timestamp", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "Sql的执行时长(秒)。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "Sql的执行时长(秒)。", "example": "0.1", "member": "float", "name": "QueryTime", "output_required": true, "type": "float", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "Sql语句。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "Sql语句。", "example": "select * from test", "member": "string", "name": "SqlText", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "客户端地址。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "客户端地址。", "example": "127.0.0.1", "member": "string", "name": "UserHost", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "用户名。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "用户名。", "example": "test_user", "member": "string", "name": "UserName", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "数据库名。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库名。", "example": "test_db", "member": "string", "name": "Database", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "锁时长(秒)。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "锁时长(秒)。", "example": "0.11", "member": "float", "name": "LockTime", "output_required": true, "type": "float", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "扫描行数。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "扫描行数。", "example": "100", "member": "int64", "name": "RowsExamined", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "结果集行数。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "结果集行数。", "example": "1", "member": "int64", "name": "RowsSent", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "Sql模板。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "Sql模板。", "example": "select * from test", "member": "string", "name": "SqlTemplate", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "Sql语句的md5。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "Sql语句的md5。", "example": "2casbjhk1ty", "member": "string", "name": "Md5", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -20340,13 +20343,13 @@ "members": [ { "disabled": false, - "document": "异步任务 ID。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "异步任务 ID。", "example": "a6040589-3b098df5-b551d9e5-81c6bfdc", "member": "string", "name": "AsyncRequestId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -20441,13 +20444,13 @@ "members": [ { "disabled": false, - "document": "异步任务 ID。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "异步任务 ID。", "example": "a6040589-3b098df5-b551d9e5-81c6bfdc", "member": "string", "name": "AsyncRequestId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -20719,36 +20722,36 @@ "members": [ { "disabled": false, - "document": "数据库名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库名", "example": "db1", "member": "string", "name": "Database", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "数据库表名\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "数据库表名", "example": "table1", "member": "string", "name": "Table", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "权限信息\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "权限信息", "example": "[{\"Table\": \"user\",\"Privileges\": [\"SELECT\",\"INSERT\"],\"Database\": \"mysql\"}]", "member": "string", "name": "Privileges", "output_required": true, "required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -20812,25 +20815,25 @@ "members": [ { "disabled": false, - "document": "标签键\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "标签键", "example": "‘’", "member": "string", "name": "TagKey", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "标签值\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "标签值", "example": "‘’", "member": "string", "name": "TagValue", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -20929,7 +20932,7 @@ { "disabled": false, "document": "错误信息。", - "example": "无", + "example": "error msg", "member": "string", "name": "Message", "output_required": true, @@ -20998,13 +21001,13 @@ }, { "disabled": false, - "document": "任务关联的实例 ID。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "任务关联的实例 ID。", "example": "[\"cdb-3gj2ya11\",\"cdb-3gj2ya22\"]", "member": "string", "name": "InstanceIds", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -21085,13 +21088,13 @@ "members": [ { "disabled": false, - "document": "异步处理ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "8XoY7Q4d3SdrWmAkLH27Mo", + "document": "异步处理ID", + "example": "8155d27a-079a2580-19593e48-f1af5042", "member": "string", "name": "AsyncRequestId", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -21435,23 +21438,23 @@ "members": [ { "disabled": false, - "document": "文件所有分片数\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "文件所有分片数", "example": "100", "member": "int64", "name": "AllSliceNum", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "已完成分片数\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "已完成分片数", "example": "50", "member": "int64", "name": "CompleteNum", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -21507,47 +21510,47 @@ "members": [ { "disabled": false, - "document": "可用区部署方式,可能的值为:0-单可用区;1-多可用区\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "可用区部署方式,可能的值为:0-单可用区;1-多可用区", "example": "[0,1]", "member": "int64", "name": "DeployMode", "output_required": true, "required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "主实例所在的可用区\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "主实例所在的可用区", "example": "[\"ap-shanghai-1\"]", "member": "string", "name": "MasterZone", "output_required": true, "required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例为多可用区部署时,备库1所在的可用区\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例为多可用区部署时,备库1所在的可用区", "example": "[\"ap-shanghai-2\"]", "member": "string", "name": "SlaveZone", "output_required": true, "required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例为多可用区部署时,备库2所在的可用区\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例为多可用区部署时,备库2所在的可用区", "example": "[\"ap-shanghai-2\"]", "member": "string", "name": "BackupZone", "output_required": true, "required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" diff --git a/tccli/services/cdb/v20170320/examples.json b/tccli/services/cdb/v20170320/examples.json index 775b0839c7..a7c10c30bf 100644 --- a/tccli/services/cdb/v20170320/examples.json +++ b/tccli/services/cdb/v20170320/examples.json @@ -143,7 +143,7 @@ "CreateAuditRuleTemplate": [ { "document": "无", - "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAuditRuleTemplate\n<公共请求参数>\n\n{\n \"RuleFilters\": [\n {\n \"Type\": \"host\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"100.122.76.176\",\n \"10.0.0.9\"\n ]\n },\n {\n \"Type\": \"user\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"wy\",\n \"test\"\n ]\n },\n {\n \"Type\": \"sqlType\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"Update\",\n \"Delete\"\n ]\n }\n ],\n \"RuleTemplateName\": \"andy\",\n \"Description\": \"用于测试的规则模板\"\n}", + "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAuditRuleTemplate\n<公共请求参数>\n\n{\n \"RuleFilters\": [\n {\n \"Type\": \"host\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"100.122.76.176\",\n \"10.0.0.9\"\n ]\n },\n {\n \"Type\": \"user\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"wy\"\n ]\n },\n {\n \"Type\": \"sqlType\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"Update\",\n \"Delete\"\n ]\n }\n ],\n \"RuleTemplateName\": \"andy\",\n \"Description\": \"用于测试的规则模板\"\n}", "output": "{\n \"Response\": {\n \"RuleTemplateId\": \"cdb-rt-ws23fwu8\",\n \"RequestId\": \"43-12121-812w1221213-62usf9093\"\n }\n}", "title": "创建审计规则模板" } @@ -388,7 +388,7 @@ { "document": "", "input": "https://cdb.tencentcloudapi.com/?Action=DescribeAuditLogFiles\n&InstanceId=cdb-qwerasdf\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"TotalCount\": 1,\n \"Items\": [\n {\n \"FileName\": \"andy.txt\",\n \"Status\": \"running\",\n \"CreateTime\": \"2019-03-20 17:09:13\",\n \"FileSize\": 3,\n \"DownloadUrl\": \"http://xxxxxx\"\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"TotalCount\": 1,\n \"Items\": [\n {\n \"FileName\": \"andy.txt\",\n \"Status\": \"running\",\n \"CreateTime\": \"2019-03-20 17:09:13\",\n \"FileSize\": 3,\n \"DownloadUrl\": \"http://xxxxxx\",\n \"ErrMsg\": \"\"\n }\n ]\n }\n}", "title": "查询审计日志文件" } ], @@ -551,8 +551,8 @@ "DescribeCpuExpandStrategy": [ { "document": "用于查询实例的弹性扩容配置。", - "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCpuExpandStrategy\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"Type\": \"abc\",\n \"ExpandCpu\": \"abc\",\n \"AutoStrategy\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCpuExpandStrategy\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdb-sad1dsfa\"\n}", + "output": "{\n \"Response\": {\n \"Type\": \"auto\",\n \"ExpandCpu\": \"4\",\n \"AutoStrategy\": \"auto\",\n \"RequestId\": \"dasdqw13-dasdhd3-123v-1234-v432\"\n }\n}", "title": "查询实例的弹性扩容配置" } ], @@ -568,7 +568,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDBImportRecords\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdb-7r8h0h61\",\n \"EndTime\": \"2017-08-24 15:03:01\",\n \"StartTime\": \"2016-01-01 00:00:01\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"TotalCount\": \"4\",\n \"Items\": [\n {\n \"Status\": 3,\n \"Code\": 1,\n \"CostTime\": 0,\n \"InstanceId\": \"e318ecb8-863f-11e7-85a5-80fb06afab26\",\n \"WorkId\": \"1649290\",\n \"FileName\": \"monkey_1501490864.sql\",\n \"Process\": 5,\n \"CreateTime\": \"2017-11-09 14:26:31\",\n \"FileSize\": 12,\n \"Message\": \"lock_inst.cgi: 某些实例id不存在对应的实例记录\",\n \"JobId\": 16242,\n \"DbName\": \"test\",\n \"AsyncRequestId\": \"a4788d0a-df23758a-ac961e5a-af414d33\"\n },\n {\n \"Status\": 3,\n \"Code\": 1,\n \"CostTime\": 0,\n \"InstanceId\": \"e318ecb8-863f-11e7-85a5-80fb06afab26\",\n \"WorkId\": \"1545387\",\n \"FileName\": \"monkey_1501490864.sql\",\n \"Process\": 5,\n \"CreateTime\": \"2017-10-18 21:18:26\",\n \"FileSize\": \"12\",\n \"Message\": \"lock_inst.cgi: 某些实例id不存在对应的实例记录\",\n \"JobId\": 16223,\n \"DbName\": \"\",\n \"AsyncRequestId\": \"198e97de-972b1971-fb0ce76a-08ca054e\"\n },\n {\n \"Status\": 3,\n \"Code\": 1,\n \"CostTime\": 0,\n \"InstanceId\": \"e318ecb8-863f-11e7-85a5-80fb06afab26\",\n \"WorkId\": \"1545171\",\n \"FileName\": \"monkey_1501490864.sql\",\n \"Process\": 5,\n \"CreateTime\": \"2017-10-18 20:12:07\",\n \"FileSize\": \"2\",\n \"Message\": \"lock_inst.cgi: 某些实例id不存在对应的实例记录\",\n \"JobId\": 16222,\n \"DbName\": \"test\",\n \"AsyncRequestId\": \"9706dfbf-0d1bc6df-5f18f4e1-bb86f2f4\"\n },\n {\n \"Status\": 3,\n \"Code\": 1,\n \"CostTime\": 0,\n \"InstanceId\": \"e318ecb8-863f-11e7-85a5-80fb06afab26\",\n \"WorkId\": \"2228867\",\n \"FileName\": \"monkey_1501490864.sql\",\n \"Process\": 5,\n \"CreateTime\": \"2017-10-18 17:53:54\",\n \"FileSize\": \"12\",\n \"Message\": \"lock_inst.cgi: 某些实例id不存在对应的实例记录\",\n \"JobId\": 16209,\n \"DbName\": \"\",\n \"AsyncRequestId\": \"e8713d1e-10628d32-74682eef-d0855c1a\"\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"TotalCount\": \"4\",\n \"Items\": [\n {\n \"Status\": 3,\n \"Code\": 1,\n \"CostTime\": 0,\n \"InstanceId\": \"e318ecb8-863f-11e7-85a5-80fb06afab26\",\n \"WorkId\": \"1649290\",\n \"FileName\": \"monkey_1501490864.sql\",\n \"Process\": 5,\n \"CreateTime\": \"2017-11-09 14:26:31\",\n \"FileSize\": \"12\",\n \"Message\": \"lock_inst.cgi: 某些实例id不存在对应的实例记录\",\n \"JobId\": 16242,\n \"DbName\": \"db1\",\n \"AsyncRequestId\": \"a4788d0a-df23758a-ac961e5a-af414d33\"\n },\n {\n \"Status\": 3,\n \"Code\": 1,\n \"CostTime\": 0,\n \"InstanceId\": \"e318ecb8-863f-11e7-85a5-80fb06afab26\",\n \"WorkId\": \"1545387\",\n \"FileName\": \"monkey_1501490864.sql\",\n \"Process\": 5,\n \"CreateTime\": \"2017-10-18 21:18:26\",\n \"FileSize\": \"12\",\n \"Message\": \"lock_inst.cgi: 某些实例id不存在对应的实例记录\",\n \"JobId\": 16223,\n \"DbName\": \"\",\n \"AsyncRequestId\": \"198e97de-972b1971-fb0ce76a-08ca054e\"\n },\n {\n \"Status\": 3,\n \"Code\": 1,\n \"CostTime\": 0,\n \"InstanceId\": \"e318ecb8-863f-11e7-85a5-80fb06afab26\",\n \"WorkId\": \"1545171\",\n \"FileName\": \"monkey_1501490864.sql\",\n \"Process\": 5,\n \"CreateTime\": \"2017-10-18 20:12:07\",\n \"FileSize\": \"2\",\n \"Message\": \"lock_inst.cgi: 某些实例id不存在对应的实例记录\",\n \"JobId\": 16222,\n \"DbName\": \"db1\",\n \"AsyncRequestId\": \"9706dfbf-0d1bc6df-5f18f4e1-bb86f2f4\"\n },\n {\n \"Status\": 3,\n \"Code\": 1,\n \"CostTime\": 0,\n \"InstanceId\": \"e318ecb8-863f-11e7-85a5-80fb06afab26\",\n \"WorkId\": \"2228867\",\n \"FileName\": \"monkey_1501490864.sql\",\n \"Process\": 5,\n \"CreateTime\": \"2017-10-18 17:53:54\",\n \"FileSize\": \"12\",\n \"Message\": \"lock_inst.cgi: 某些实例id不存在对应的实例记录\",\n \"JobId\": 16209,\n \"DbName\": \"\",\n \"AsyncRequestId\": \"e8713d1e-10628d32-74682eef-d0855c1a\"\n }\n ]\n }\n}", "title": "查询数据库导入任务记录" } ], @@ -624,7 +624,7 @@ { "document": "查询实例列表", "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDBInstances\n<公共请求参数>\n\n{\n \"InstanceIds\": [\n \"cdb-70zdmgg1\"\n ]\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"97939db3-ef94-4a60-9b64-2a1f4e2f1ea3\",\n \"Items\": [\n {\n \"WanStatus\": 0,\n \"Zone\": \"100001\",\n \"WanPort\": 0,\n \"DiskType\": \"test\",\n \"RoVipInfo\": {\n \"RoVport\": 0,\n \"RoVpcId\": 0,\n \"RoVipStatus\": 0,\n \"RoVip\": \"192.168.1.1\",\n \"RoSubnetId\": 0\n },\n \"Memory\": 1000,\n \"EngineType\": \"InnoDB\",\n \"Status\": 1,\n \"VpcId\": 511512,\n \"SlaveInfo\": {\n \"Second\": {\n \"Vport\": 0,\n \"Vip\": \"test\",\n \"Region\": \"ap-guangzhou\",\n \"Zone\": \"ap-guangzhou-1\"\n },\n \"First\": {\n \"Vport\": 0,\n \"Vip\": \"test\",\n \"Region\": \"ap-guangzhou\",\n \"Zone\": \"ap-guangzhou-1\"\n }\n },\n \"InstanceId\": \"cdn-abc\",\n \"PhysicalId\": \"test\",\n \"Volume\": 50,\n \"AutoRenew\": 0,\n \"ProtectMode\": 0,\n \"CdbError\": 0,\n \"DeviceClass\": \"test\",\n \"MasterInfo\": {\n \"Status\": 0,\n \"VpcId\": 0,\n \"Zone\": \"100001\",\n \"ExClusterName\": \"test\",\n \"InstanceId\": \"test\",\n \"ResourceId\": \"test\",\n \"Region\": \"ap-guangzhou\",\n \"RegionId\": 0,\n \"ZoneId\": 0,\n \"Volume\": 0,\n \"DeviceType\": \"test\",\n \"Memory\": 0,\n \"SubnetId\": 0,\n \"Qps\": 0,\n \"TaskStatus\": 0,\n \"InstanceName\": \"test\",\n \"InstanceType\": 0,\n \"ExClusterId\": \"test\"\n },\n \"DeployGroupId\": \"test\",\n \"InstanceNodes\": 2,\n \"RoGroups\": [\n {\n \"RoOfflineDelay\": 0,\n \"RoGroupMode\": \"test\",\n \"RoGroupZone\": \"test\",\n \"MinRoInGroup\": 1,\n \"DelayReplicationTime\": 0,\n \"RoGroupId\": \"test\",\n \"RoMaxDelayTime\": 1,\n \"RoGroupName\": \"test\",\n \"Weight\": 0,\n \"UniqVpcId\": \"test\",\n \"RoInstances\": [\n {\n \"Zone\": \"test\",\n \"MasterInstanceId\": \"test\",\n \"Memory\": 1000,\n \"Status\": 1,\n \"VpcId\": 511512,\n \"InstanceId\": \"test\",\n \"Volume\": 50,\n \"OfflineTime\": \"test\",\n \"SubnetId\": 115839,\n \"HourFeeStatus\": 1,\n \"RoStatus\": \"test\",\n \"Region\": \"test\",\n \"DeadlineTime\": \"test\",\n \"TaskStatus\": 0,\n \"DeviceType\": \"test\",\n \"EngineVersion\": \"test\",\n \"InstanceName\": \"test\",\n \"Weight\": 0,\n \"PayType\": 1,\n \"InstanceType\": 3,\n \"Vip\": \"test\",\n \"Qps\": 1000,\n \"Vport\": 3306\n }\n ],\n \"Vip\": \"test\",\n \"UniqSubnetId\": \"test\",\n \"RoGroupRegion\": \"test\",\n \"Vport\": 3306,\n \"WeightMode\": \"test\"\n },\n {\n \"RoOfflineDelay\": 0,\n \"RoGroupMode\": \"test\",\n \"RoGroupZone\": \"test\",\n \"MinRoInGroup\": 1,\n \"DelayReplicationTime\": 0,\n \"RoGroupId\": \"test\",\n \"RoMaxDelayTime\": 1,\n \"RoGroupName\": \"test\",\n \"UniqVpcId\": \"test\",\n \"Weight\": 0,\n \"RoInstances\": [\n {\n \"Zone\": \"test\",\n \"MasterInstanceId\": \"test\",\n \"Memory\": 1000,\n \"Status\": 1,\n \"VpcId\": 511512,\n \"InstanceId\": \"test\",\n \"Volume\": 25,\n \"OfflineTime\": \"test\",\n \"SubnetId\": 115839,\n \"HourFeeStatus\": 1,\n \"RoStatus\": \"test\",\n \"Region\": \"test\",\n \"DeadlineTime\": \"test\",\n \"TaskStatus\": 0,\n \"DeviceType\": \"test\",\n \"EngineVersion\": \"test\",\n \"InstanceName\": \"test\",\n \"Weight\": 0,\n \"PayType\": 1,\n \"InstanceType\": 3,\n \"Vip\": \"test\",\n \"Qps\": 1000,\n \"Vport\": 3306\n }\n ],\n \"Vip\": \"test\",\n \"UniqSubnetId\": \"test\",\n \"RoGroupRegion\": \"test\",\n \"Vport\": 3306,\n \"WeightMode\": \"test\"\n }\n ],\n \"ProjectId\": 0,\n \"DeadlineTime\": \"2020-09-22 00:00:00\",\n \"DeployMode\": 0,\n \"TaskStatus\": 0,\n \"SubnetId\": 115839,\n \"DeviceType\": \"test\",\n \"EngineVersion\": \"test\",\n \"MaxDelayTime\": 0,\n \"InstanceName\": \"test\",\n \"Cpu\": 8,\n \"DrInfo\": [\n {\n \"Status\": 0,\n \"Zone\": \"test\",\n \"InstanceId\": \"test\",\n \"Region\": \"test\",\n \"SyncStatus\": 0,\n \"InstanceName\": \"test\",\n \"InstanceType\": 0\n }\n ],\n \"UniqVpcId\": \"test\",\n \"WanDomain\": \"test\",\n \"InitFlag\": 1,\n \"PayType\": 1,\n \"InstanceType\": 1,\n \"Vip\": \"test\",\n \"UniqSubnetId\": \"test\",\n \"Region\": \"test\",\n \"Qps\": 0,\n \"Vport\": 3306,\n \"TagList\": [\n {\n \"TagKey\": \"test\",\n \"TagValue\": \"test\"\n }\n ],\n \"CreateTime\": \"test\",\n \"ZoneId\": 720001,\n \"ZoneName\": \"test\"\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"97939db3-ef94-4a60-9b64-2a1f4e2f1ea3\",\n \"Items\": [\n {\n \"WanStatus\": 0,\n \"Zone\": \"100001\",\n \"WanPort\": 0,\n \"DiskType\": \"CLOUD_SSD\",\n \"RoVipInfo\": {\n \"RoVport\": 0,\n \"RoVpcId\": 0,\n \"RoVipStatus\": 0,\n \"RoVip\": \"192.168.1.1\",\n \"RoSubnetId\": 0\n },\n \"Memory\": 1000,\n \"EngineType\": \"InnoDB\",\n \"Status\": 1,\n \"VpcId\": 511512,\n \"SlaveInfo\": {\n \"Second\": {\n \"Vport\": 0,\n \"Vip\": \"172.1.1.1\",\n \"Region\": \"ap-guangzhou\",\n \"Zone\": \"ap-guangzhou-1\"\n },\n \"First\": {\n \"Vport\": 0,\n \"Vip\": \"17.1.1.1\",\n \"Region\": \"ap-guangzhou\",\n \"Zone\": \"ap-guangzhou-1\"\n }\n },\n \"InstanceId\": \"cdn-ahend\",\n \"PhysicalId\": \"136527\",\n \"Volume\": 50,\n \"AutoRenew\": 0,\n \"ProtectMode\": 0,\n \"CdbError\": 0,\n \"DeviceClass\": \"20\",\n \"MasterInfo\": {\n \"Status\": 1,\n \"VpcId\": 0,\n \"Zone\": \"100001\",\n \"ExClusterName\": \"andy\",\n \"InstanceId\": \"cdb-hsyhend\",\n \"ResourceId\": \"\",\n \"Region\": \"ap-guangzhou\",\n \"RegionId\": 0,\n \"ZoneId\": 0,\n \"Volume\": 0,\n \"DeviceType\": \"UNIVERSAL\",\n \"Memory\": 0,\n \"SubnetId\": 0,\n \"Qps\": 0,\n \"TaskStatus\": 0,\n \"InstanceName\": \"cdb342\",\n \"InstanceType\": 0,\n \"ExClusterId\": \"cdb-3ho6jddd\"\n },\n \"DeployGroupId\": \"ps-7t11vrwf\",\n \"InstanceNodes\": 2,\n \"RoGroups\": [\n {\n \"RoOfflineDelay\": 0,\n \"RoGroupMode\": \"alone\",\n \"RoGroupZone\": \"800003\",\n \"MinRoInGroup\": 1,\n \"DelayReplicationTime\": 0,\n \"RoGroupId\": \"cdbrg-92zkeaq2\",\n \"RoMaxDelayTime\": 1,\n \"RoGroupName\": \"cdbro2\",\n \"Weight\": 0,\n \"UniqVpcId\": \"vpc-ja6ts123\",\n \"RoInstances\": [\n {\n \"Zone\": \"ap-guangzhou-3\",\n \"MasterInstanceId\": \"cdb-fapcrp1q\",\n \"Memory\": 1000,\n \"Status\": 1,\n \"VpcId\": 511512,\n \"InstanceId\": \"cdb-hendhs\",\n \"Volume\": 50,\n \"OfflineTime\": \"2024-09-09 16:40:31\",\n \"SubnetId\": 115839,\n \"HourFeeStatus\": 1,\n \"RoStatus\": \"online\",\n \"Region\": \"ap-guangzhou\",\n \"DeadlineTime\": \"2024-12-29 08:37:33\",\n \"TaskStatus\": 0,\n \"DeviceType\": \"UNIVERSAL\",\n \"EngineVersion\": \"5.7\",\n \"InstanceName\": \"cdbro732\",\n \"Weight\": 0,\n \"PayType\": 1,\n \"InstanceType\": 3,\n \"Vip\": \"127.0.0.1\",\n \"Qps\": 1000,\n \"Vport\": 3306\n }\n ],\n \"Vip\": \"10.89.90.66\",\n \"UniqSubnetId\": \"subnet-njh2bc99\",\n \"RoGroupRegion\": \"ap-guangzhou\",\n \"Vport\": 3306,\n \"WeightMode\": \"system\"\n },\n {\n \"RoOfflineDelay\": 0,\n \"RoGroupMode\": \"alone\",\n \"RoGroupZone\": \"ap-guangzhou\",\n \"MinRoInGroup\": 1,\n \"DelayReplicationTime\": 0,\n \"RoGroupId\": \"cdbrg-92zkeaq4\",\n \"RoMaxDelayTime\": 1,\n \"RoGroupName\": \"andy6\",\n \"UniqVpcId\": \"vpc-ja6ts453\",\n \"Weight\": 0,\n \"RoInstances\": [\n {\n \"Zone\": \"ap-guangzhou-4\",\n \"MasterInstanceId\": \"cdb-fapcrp12\",\n \"Memory\": 1000,\n \"Status\": 1,\n \"VpcId\": 511512,\n \"InstanceId\": \"cdbro-c1nl9rpv\",\n \"Volume\": 25,\n \"OfflineTime\": \"2024-09-09 16:40:30\",\n \"SubnetId\": 115839,\n \"HourFeeStatus\": 1,\n \"RoStatus\": \"online\",\n \"Region\": \"ap-guangzhou\",\n \"DeadlineTime\": \"2024-12-29 08:37:33\",\n \"TaskStatus\": 0,\n \"DeviceType\": \"UNIVERSAL\",\n \"EngineVersion\": \"5.7\",\n \"InstanceName\": \"cdbro7\",\n \"Weight\": 0,\n \"PayType\": 1,\n \"InstanceType\": 3,\n \"Vip\": \"127.0.0.1\",\n \"Qps\": 1000,\n \"Vport\": 3306\n }\n ],\n \"Vip\": \"12.1.1.1\",\n \"UniqSubnetId\": \"subnet-njh2bc11\",\n \"RoGroupRegion\": \"ap-guangzhou\",\n \"Vport\": 3306,\n \"WeightMode\": \"system\"\n }\n ],\n \"ProjectId\": 0,\n \"DeadlineTime\": \"2020-09-22 00:00:00\",\n \"DeployMode\": 0,\n \"TaskStatus\": 0,\n \"SubnetId\": 115839,\n \"DeviceType\": \"EXCLUSIVE\",\n \"EngineVersion\": \"5.7\",\n \"MaxDelayTime\": 0,\n \"InstanceName\": \"cdbandy\",\n \"Cpu\": 8,\n \"DrInfo\": [\n {\n \"Status\": 0,\n \"Zone\": \"ap-beijing-3\",\n \"InstanceId\": \"cdb-hegns\",\n \"Region\": \"ap-beijing\",\n \"SyncStatus\": 0,\n \"InstanceName\": \"andydr\",\n \"InstanceType\": 0\n }\n ],\n \"UniqVpcId\": \"vpc-5v8wn9m1\",\n \"WanDomain\": \"gz-cdb-******.sql.tencentcdb.com\",\n \"InitFlag\": 1,\n \"PayType\": 1,\n \"InstanceType\": 1,\n \"Vip\": \"13.1.1.1\",\n \"UniqSubnetId\": \"subnet-1typ0s7d\",\n \"Region\": \"ap-beijing\",\n \"Qps\": 0,\n \"Vport\": 3306,\n \"TagList\": [\n {\n \"TagKey\": \"name\",\n \"TagValue\": \"andy\"\n }\n ],\n \"CreateTime\": \"2023-08-29 08:37:33\",\n \"ZoneId\": 720001,\n \"ZoneName\": \"北京三区\"\n }\n ]\n }\n}", "title": "查询实例列表" } ], @@ -670,7 +670,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDatabases\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdb-f35wr6wj\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"DatabaseList\": [\n {\n \"CharacterSet\": \"UTF8\",\n \"DatabaseName\": \"test\"\n }\n ],\n \"TotalCount\": 7,\n \"Items\": [\n \"information_schema\",\n \"mysql\",\n \"performance_schema\",\n \"test\",\n \"trsf1\",\n \"trsf2\",\n \"trsf3\"\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"DatabaseList\": [\n {\n \"CharacterSet\": \"UTF8\",\n \"DatabaseName\": \"db1\"\n }\n ],\n \"TotalCount\": 7,\n \"Items\": [\n \"information_schema\",\n \"mysql\",\n \"performance_schema\",\n \"trsf1\",\n \"trsf2\",\n \"trsf3\"\n ]\n }\n}", "title": "查询数据库" } ], @@ -766,7 +766,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeParamTemplates\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"RequestId\": \"756bb037-a44a-4b4f-abe0-6efd34a6c792\",\n \"TotalCount\": 1,\n \"Items\": [\n {\n \"TemplateId\": 2333,\n \"Name\": \"test\",\n \"Description\": \"test\",\n \"EngineVersion\": \"5.7\",\n \"TemplateType\": \"HIGH_STABILITY\"\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Items\": [\n {\n \"TemplateId\": 2333,\n \"Name\": \"andy\",\n \"Description\": \"5.7\",\n \"EngineVersion\": \"5.7\",\n \"TemplateType\": \"HIGH_STABILITY\",\n \"EngineType\": \"InnoDB\"\n }\n ],\n \"RequestId\": \"756bb037-a44a-4b4f-abe0-6efd34a6c792\"\n }\n}", "title": "查询参数模板列表" } ], @@ -1101,7 +1101,7 @@ "ModifyDBInstanceVipVport": [ { "document": "", - "input": "https://cdb.tencentcloudapi.com/?Action=ModifyDBInstanceVipVport\n&InstanceId=cdb-f35wr6wj\n&DstIp=10.0.1.1\n&DstPort=1025\n&UniqVpcId=11357\n&UniqSubnetId=23789\n&ReleaseDuration=12\n&<公共请求参数>", + "input": "https://cdb.tencentcloudapi.com/?Action=ModifyDBInstanceVipVport\n&InstanceId=cdb-f35wr6wj\n&DstIp=10.0.1.1\n&DstPort=1025\n&UniqVpcId=11357\n&UniqSubnetId=23789\n&ReleaseDuration=24\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"AsyncRequestId\": \"d2baf2fb-cbae62df-7dd0d736-9cbd3e31\"\n }\n}", "title": "修改云数据库实例的IP和端口号" } diff --git a/tccli/services/cdwdoris/v20211228/api.json b/tccli/services/cdwdoris/v20211228/api.json index c651c9deeb..858f8ee6eb 100644 --- a/tccli/services/cdwdoris/v20211228/api.json +++ b/tccli/services/cdwdoris/v20211228/api.json @@ -2854,6 +2854,16 @@ "type": "string", "value_allowed_null": true }, + { + "disabled": false, + "document": "是否包含CN节点", + "example": "true", + "member": "bool", + "name": "HasCN", + "output_required": false, + "type": "bool", + "value_allowed_null": false + }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", "member": "string", @@ -5461,6 +5471,26 @@ "output_required": false, "type": "int", "value_allowed_null": true + }, + { + "disabled": false, + "document": "监控模式 0: 老监控 1:新监控\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "0", + "member": "int64", + "name": "MonitorMode", + "output_required": false, + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "cn节点信息", + "example": "无", + "member": "NodesSummary", + "name": "CNSummary", + "output_required": false, + "type": "object", + "value_allowed_null": false } ], "usage": "out" @@ -5587,6 +5617,16 @@ "output_required": false, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "创建时间", + "example": "2024-12-16 12:23:11", + "member": "string", + "name": "CreateTime", + "output_required": false, + "type": "string", + "value_allowed_null": false } ], "usage": "out" diff --git a/tccli/services/cfg/v20210820/api.json b/tccli/services/cfg/v20210820/api.json index ffae91040c..a856fa6b1f 100644 --- a/tccli/services/cfg/v20210820/api.json +++ b/tccli/services/cfg/v20210820/api.json @@ -1836,6 +1836,17 @@ "required": false, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "字段类型 0:str 1:list", + "example": "0", + "member": "int64", + "name": "Type", + "output_required": false, + "required": false, + "type": "int", + "value_allowed_null": false } ], "usage": "both" diff --git a/tccli/services/chdfs/v20201112/api.json b/tccli/services/chdfs/v20201112/api.json index b3275f83dd..01f13eee87 100644 --- a/tccli/services/chdfs/v20201112/api.json +++ b/tccli/services/chdfs/v20201112/api.json @@ -1090,7 +1090,7 @@ "example": "无", "member": "FileSystem", "name": "FileSystems", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1850,7 +1850,7 @@ "example": "f14mrrxxxxxx-C1Yv", "member": "string", "name": "MountPointId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1860,7 +1860,7 @@ "example": "mp-test", "member": "string", "name": "MountPointName", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1870,7 +1870,7 @@ "example": "f14mrrxxxxxx", "member": "string", "name": "FileSystemId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1880,7 +1880,7 @@ "example": "1", "member": "uint64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -1890,17 +1890,17 @@ "example": "2024-12-25T19:15:28+08:00", "member": "datetime_iso", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "绑定的权限组ID列表", - "example": "无", + "example": "[\"ag-pushxxxx\"]", "member": "string", "name": "AccessGroupIds", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -2051,7 +2051,7 @@ { "disabled": false, "document": "标签键", - "example": "无", + "example": "key-test", "member": "string", "name": "Key", "output_required": true, @@ -2062,7 +2062,7 @@ { "disabled": false, "document": "标签值", - "example": "无", + "example": "val-test", "member": "string", "name": "Value", "output_required": true, diff --git a/tccli/services/chdfs/v20201112/examples.json b/tccli/services/chdfs/v20201112/examples.json index 6820334bb9..833413c8d6 100644 --- a/tccli/services/chdfs/v20201112/examples.json +++ b/tccli/services/chdfs/v20201112/examples.json @@ -132,7 +132,7 @@ { "document": "查看文件系统列表", "input": "https://chdfs.tencentcloudapi.com/?Action=DescribeFileSystems\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"FileSystems\": [\n {\n \"AppId\": 1251006373,\n \"FileSystemName\": \"test\",\n \"Description\": \"\",\n \"Region\": \"ap-guangzhou\",\n \"FileSystemId\": \"f4mnvilzmdd\",\n \"CreateTime\": \"2019-07-30T17:03:20+08:00\",\n \"BlockSize\": 4194304,\n \"CapacityQuota\": 1073741824,\n \"SuperUsers\": [\n \"hadoop\"\n ],\n \"PosixAcl\": true,\n \"Status\": 2,\n \"EnableRanger\": false,\n \"RangerServiceAddresses\": [\n \"127.0.0.1:8080\"\n ]\n }\n ],\n \"RequestId\": \"a6d1c90a-a86a-45e2-b031-0de50f1ffc35\"\n }\n}", + "output": "{\n \"Response\": {\n \"FileSystems\": [\n {\n \"AppId\": 1251006373,\n \"FileSystemName\": \"fs-test\",\n \"Description\": \"\",\n \"Region\": \"ap-guangzhou\",\n \"FileSystemId\": \"f4mnvilxxxx\",\n \"CreateTime\": \"2019-07-30T17:03:20+08:00\",\n \"BlockSize\": 4194304,\n \"CapacityQuota\": 1073741824,\n \"SuperUsers\": [\n \"hadoop\"\n ],\n \"PosixAcl\": true,\n \"Status\": 2,\n \"EnableRanger\": false,\n \"RangerServiceAddresses\": [\n \"127.0.0.1:8080\"\n ]\n }\n ],\n \"RequestId\": \"a6d1c90a-a86a-45e2-b031-0de50f1ffc35\"\n }\n}", "title": "查看文件系统列表" } ], diff --git a/tccli/services/cls/v20201016/api.json b/tccli/services/cls/v20201016/api.json index e14cfbdf59..4fab80c192 100644 --- a/tccli/services/cls/v20201016/api.json +++ b/tccli/services/cls/v20201016/api.json @@ -14747,7 +14747,7 @@ }, { "disabled": false, - "document": "- 要检索分析的日志主题列表,最大支持20个日志主题。\n- 检索单个日志主题时请使用TopicId。\n- TopicId 和 Topics 不能同时使用,在一次请求中有且只能选择一个。", + "document": "- 要检索分析的日志主题列表,最大支持50个日志主题。\n- 检索单个日志主题时请使用TopicId。\n- TopicId 和 Topics 不能同时使用,在一次请求中有且只能选择一个。", "example": "无", "member": "MultiTopicSearchInformation", "name": "Topics", diff --git a/tccli/services/cmq/v20190304/api.json b/tccli/services/cmq/v20190304/api.json index c202c668c7..23d84139fa 100644 --- a/tccli/services/cmq/v20190304/api.json +++ b/tccli/services/cmq/v20190304/api.json @@ -1,18 +1,18 @@ { "actions": { "ClearQueue": { - "document": "清除queue中的所有消息", + "document": "下线老cmq云API 3.0 无调用量接口\n\n清除queue中的所有消息", "input": "ClearQueueRequest", "name": "清空消息队列中的消息", "output": "ClearQueueResponse", - "status": "online" + "status": "deprecated" }, "ClearSubscriptionFilterTags": { - "document": "清空订阅者消息标签", + "document": "下线老cmq云API 3.0 无调用量接口\n\n清空订阅者消息标签", "input": "ClearSubscriptionFilterTagsRequest", "name": "清空订阅者消息标签", "output": "ClearSubscriptionFilterTagsResponse", - "status": "online" + "status": "deprecated" }, "CreateQueue": { "document": "创建队列接口\n", @@ -22,11 +22,11 @@ "status": "online" }, "CreateSubscribe": { - "document": "创建订阅接口", + "document": "下线老cmq云API 3.0 无调用量接口\n\n创建订阅接口", "input": "CreateSubscribeRequest", "name": "创建订阅接口", "output": "CreateSubscribeResponse", - "status": "online" + "status": "deprecated" }, "CreateTopic": { "document": "创建主题", @@ -43,25 +43,25 @@ "status": "online" }, "DeleteSubscribe": { - "document": "删除订阅", + "document": "下线老cmq云API 3.0 无调用量接口\n\n删除订阅", "input": "DeleteSubscribeRequest", "name": "删除订阅", "output": "DeleteSubscribeResponse", - "status": "online" + "status": "deprecated" }, "DeleteTopic": { - "document": "删除主题", + "document": "下线老cmq云API 3.0 无调用量接口\n\n删除主题", "input": "DeleteTopicRequest", "name": "删除主题", "output": "DeleteTopicResponse", - "status": "online" + "status": "deprecated" }, "DescribeDeadLetterSourceQueues": { - "document": "枚举死信队列源队列", + "document": "下线老cmq云API 3.0 无调用量接口\n\n枚举死信队列源队列", "input": "DescribeDeadLetterSourceQueuesRequest", "name": "枚举死信队列源队列", "output": "DescribeDeadLetterSourceQueuesResponse", - "status": "online" + "status": "deprecated" }, "DescribeQueueDetail": { "document": "枚举队列列表", @@ -92,32 +92,32 @@ "status": "online" }, "ModifySubscriptionAttribute": { - "document": "修改订阅属性", + "document": "下线老cmq云API 3.0 无调用量接口\n\n修改订阅属性", "input": "ModifySubscriptionAttributeRequest", "name": "修改订阅属性", "output": "ModifySubscriptionAttributeResponse", - "status": "online" + "status": "deprecated" }, "ModifyTopicAttribute": { - "document": "修改主题属性", + "document": "下线老cmq云API 3.0 无调用量接口\n\n修改主题属性", "input": "ModifyTopicAttributeRequest", "name": "修改主题属性", "output": "ModifyTopicAttributeResponse", - "status": "online" + "status": "deprecated" }, "RewindQueue": { - "document": "回溯队列", + "document": "下线老cmq云API 3.0 无调用量接口\n\n回溯队列", "input": "RewindQueueRequest", "name": "回溯队列", "output": "RewindQueueResponse", - "status": "online" + "status": "deprecated" }, "UnbindDeadLetter": { - "document": "解绑死信队列", + "document": "下线老cmq云API 3.0 无调用量接口\n\n解绑死信队列", "input": "UnbindDeadLetterRequest", "name": "解绑死信队列", "output": "UnbindDeadLetterResponse", - "status": "online" + "status": "deprecated" } }, "metadata": { @@ -1608,122 +1608,122 @@ "members": [ { "disabled": false, - "document": "订阅名字,在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "document": "该订阅待投递的消息数。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "10", + "member": "uint64", + "name": "MsgCount", + "output_required": true, + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "表示订阅接收消息的过滤策略。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "key", "member": "string", - "name": "SubscriptionName", - "required": true, - "type": "string", + "name": "BindingKey", + "output_required": true, + "type": "list", "value_allowed_null": true }, { "disabled": false, - "document": "订阅 ID。订阅 ID 在拉取监控数据时会用到。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "document": "接收通知的 endpoint,根据协议 protocol 区分:对于 HTTP,endpoint 必须以http://开头,host 可以是域名或 IP;对于 queue,则填 queueName。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "test-queue", "member": "string", - "name": "SubscriptionId", - "required": true, + "name": "Endpoint", + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "订阅拥有者的 APPID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "12321889", "member": "uint64", "name": "TopicOwner", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, - "document": "该订阅待投递的消息数。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", - "member": "uint64", - "name": "MsgCount", - "required": true, - "type": "int", + "document": "向 endpoint 推送消息出现错误时,CMQ 推送服务器的重试策略。取值有:\n(1)BACKOFF_RETRY,退避重试。每隔一定时间重试一次,重试够一定次数后,就把该消息丢弃,继续推送下一条消息;\n(2)EXPONENTIAL_DECAY_RETRY,指数衰退重试。每次重试的间隔是指数递增的,例如开始 1s,后面是 2s,4s,8s...由于 Topic 消息的周期是一天,所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "BACKOFF_RETRY", + "member": "string", + "name": "NotifyStrategy", + "output_required": true, + "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "最后一次修改订阅属性的时间。返回 Unix 时间戳,精确到秒。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", - "member": "uint64", - "name": "LastModifyTime", - "required": true, - "type": "int", + "document": "推送内容的格式。取值:(1)JSON;(2)SIMPLIFIED,即 raw 格式。如果 protocol 是 queue,则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP,两个值均可以,默认值是 JSON。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "JSON", + "member": "string", + "name": "NotifyContentFormat", + "output_required": true, + "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "订阅的创建时间。返回 Unix 时间戳,精确到秒。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "document": "最后一次修改订阅属性的时间。返回 Unix 时间戳,精确到秒。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "17177728999", "member": "uint64", - "name": "CreateTime", - "required": true, + "name": "LastModifyTime", + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, - "document": "表示订阅接收消息的过滤策略。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "document": "描述用户创建订阅时选择的过滤策略:\nfilterType = 1表示用户使用 filterTag 标签过滤\nfilterType = 2表示用户使用 bindingKey 过滤。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "tag1", "member": "string", - "name": "BindingKey", - "required": true, + "name": "FilterTags", + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, - "document": "接收通知的 endpoint,根据协议 protocol 区分:对于 HTTP,endpoint 必须以http://开头,host 可以是域名或 IP;对于 queue,则填 queueName。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "document": "订阅名字,在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "test-sub", "member": "string", - "name": "Endpoint", - "required": true, + "name": "SubscriptionName", + "output_required": true, "type": "string", "value_allowed_null": true }, - { - "disabled": false, - "document": "描述用户创建订阅时选择的过滤策略:\nfilterType = 1表示用户使用 filterTag 标签过滤\nfilterType = 2表示用户使用 bindingKey 过滤。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", - "member": "string", - "name": "FilterTags", - "required": true, - "type": "list", - "value_allowed_null": true - }, { "disabled": false, "document": "订阅的协议,目前支持两种协议:HTTP、queue。使用 HTTP 协议,用户需自己搭建接受消息的 Web Server。使用 queue,消息会自动推送到 CMQ queue,用户可以并发地拉取消息。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "queue", "member": "string", "name": "Protocol", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "向 endpoint 推送消息出现错误时,CMQ 推送服务器的重试策略。取值有:\n(1)BACKOFF_RETRY,退避重试。每隔一定时间重试一次,重试够一定次数后,就把该消息丢弃,继续推送下一条消息;\n(2)EXPONENTIAL_DECAY_RETRY,指数衰退重试。每次重试的间隔是指数递增的,例如开始 1s,后面是 2s,4s,8s...由于 Topic 消息的周期是一天,所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "document": "订阅 ID。订阅 ID 在拉取监控数据时会用到。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "sub-ayenghj", "member": "string", - "name": "NotifyStrategy", - "required": true, + "name": "SubscriptionId", + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "推送内容的格式。取值:(1)JSON;(2)SIMPLIFIED,即 raw 格式。如果 protocol 是 queue,则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP,两个值均可以,默认值是 JSON。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", - "member": "string", - "name": "NotifyContentFormat", - "required": true, - "type": "string", + "document": "订阅的创建时间。返回 Unix 时间戳,精确到秒。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "17177728999", + "member": "uint64", + "name": "CreateTime", + "output_required": true, + "type": "int", "value_allowed_null": true } ], diff --git a/tccli/services/cvm/cvm_client.py b/tccli/services/cvm/cvm_client.py index 14c9a9199b..089c749022 100644 --- a/tccli/services/cvm/cvm_client.py +++ b/tccli/services/cvm/cvm_client.py @@ -485,7 +485,7 @@ def doDescribeDisasterRecoverGroupQuota(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeReservedInstances(args, parsed_globals): +def doDescribeTaskInfo(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -514,11 +514,11 @@ def doDescribeReservedInstances(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeReservedInstancesRequest() + model = models.DescribeTaskInfoRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribeReservedInstances(model) + rsp = client.DescribeTaskInfo(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -693,58 +693,6 @@ def doResetInstancesType(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeReservedInstancesConfigInfos(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.CvmClient(cred, g_param[OptionsDefine.Region], profile) - client._sdkVersion += ("_CLI_" + __version__) - models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeReservedInstancesConfigInfosRequest() - model.from_json_string(json.dumps(args)) - start_time = time.time() - while True: - rsp = client.DescribeReservedInstancesConfigInfos(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 doDescribeInstanceFamilyConfigs(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -797,58 +745,6 @@ def doDescribeInstanceFamilyConfigs(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doInquirePricePurchaseReservedInstancesOffering(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.CvmClient(cred, g_param[OptionsDefine.Region], profile) - client._sdkVersion += ("_CLI_" + __version__) - models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.InquirePricePurchaseReservedInstancesOfferingRequest() - model.from_json_string(json.dumps(args)) - start_time = time.time() - while True: - rsp = client.InquirePricePurchaseReservedInstancesOffering(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 doSyncImages(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -1317,58 +1213,6 @@ def doDescribeImageSharePermission(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeRegions(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.CvmClient(cred, g_param[OptionsDefine.Region], profile) - client._sdkVersion += ("_CLI_" + __version__) - models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeRegionsRequest() - model.from_json_string(json.dumps(args)) - start_time = time.time() - while True: - rsp = client.DescribeRegions(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 doDescribeInstancesModification(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -1837,7 +1681,7 @@ def doDescribeInstancesOperationLimit(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDeleteLaunchTemplateVersions(args, parsed_globals): +def doStopInstances(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -1866,11 +1710,11 @@ def doDeleteLaunchTemplateVersions(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DeleteLaunchTemplateVersionsRequest() + model = models.StopInstancesRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DeleteLaunchTemplateVersions(model) + rsp = client.StopInstances(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -1889,7 +1733,7 @@ def doDeleteLaunchTemplateVersions(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doStopInstances(args, parsed_globals): +def doDescribeRegions(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -1918,11 +1762,11 @@ def doStopInstances(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.StopInstancesRequest() + model = models.DescribeRegionsRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.StopInstances(model) + rsp = client.DescribeRegions(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -2773,58 +2617,6 @@ def doInquiryPriceResetInstance(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doPurchaseReservedInstancesOffering(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.CvmClient(cred, g_param[OptionsDefine.Region], profile) - client._sdkVersion += ("_CLI_" + __version__) - models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.PurchaseReservedInstancesOfferingRequest() - model.from_json_string(json.dumps(args)) - start_time = time.time() - while True: - rsp = client.PurchaseReservedInstancesOffering(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 doModifyInstancesRenewFlag(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -3501,59 +3293,7 @@ def doDescribeKeyPairs(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeTaskInfo(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.CvmClient(cred, g_param[OptionsDefine.Region], profile) - client._sdkVersion += ("_CLI_" + __version__) - models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeTaskInfoRequest() - model.from_json_string(json.dumps(args)) - start_time = time.time() - while True: - rsp = client.DescribeTaskInfo(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 doDescribeReservedInstancesOfferings(args, parsed_globals): +def doInquiryPriceModifyInstancesChargeType(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -3582,11 +3322,11 @@ def doDescribeReservedInstancesOfferings(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeReservedInstancesOfferingsRequest() + model = models.InquiryPriceModifyInstancesChargeTypeRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribeReservedInstancesOfferings(model) + rsp = client.InquiryPriceModifyInstancesChargeType(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -3605,7 +3345,7 @@ def doDescribeReservedInstancesOfferings(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doInquiryPriceModifyInstancesChargeType(args, parsed_globals): +def doDescribeInternetChargeTypeConfigs(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -3634,11 +3374,11 @@ def doInquiryPriceModifyInstancesChargeType(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.InquiryPriceModifyInstancesChargeTypeRequest() + model = models.DescribeInternetChargeTypeConfigsRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.InquiryPriceModifyInstancesChargeType(model) + rsp = client.DescribeInternetChargeTypeConfigs(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -3657,7 +3397,7 @@ def doInquiryPriceModifyInstancesChargeType(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeInternetChargeTypeConfigs(args, parsed_globals): +def doRebootInstances(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -3686,11 +3426,11 @@ def doDescribeInternetChargeTypeConfigs(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeInternetChargeTypeConfigsRequest() + model = models.RebootInstancesRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribeInternetChargeTypeConfigs(model) + rsp = client.RebootInstances(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -3709,7 +3449,7 @@ def doDescribeInternetChargeTypeConfigs(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doRebootInstances(args, parsed_globals): +def doInquiryPriceRenewHosts(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -3738,11 +3478,11 @@ def doRebootInstances(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.RebootInstancesRequest() + model = models.InquiryPriceRenewHostsRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.RebootInstances(model) + rsp = client.InquiryPriceRenewHosts(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -3761,7 +3501,7 @@ def doRebootInstances(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doInquiryPriceRenewHosts(args, parsed_globals): +def doDescribeImageFromFamily(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -3790,11 +3530,11 @@ def doInquiryPriceRenewHosts(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.InquiryPriceRenewHostsRequest() + model = models.DescribeImageFromFamilyRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.InquiryPriceRenewHosts(model) + rsp = client.DescribeImageFromFamily(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -3813,7 +3553,7 @@ def doInquiryPriceRenewHosts(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeImageFromFamily(args, parsed_globals): +def doModifyHpcClusterAttribute(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -3842,11 +3582,11 @@ def doDescribeImageFromFamily(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeImageFromFamilyRequest() + model = models.ModifyHpcClusterAttributeRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribeImageFromFamily(model) + rsp = client.ModifyHpcClusterAttribute(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -3865,7 +3605,7 @@ def doDescribeImageFromFamily(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doModifyHpcClusterAttribute(args, parsed_globals): +def doModifyKeyPairAttribute(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -3894,11 +3634,11 @@ def doModifyHpcClusterAttribute(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.ModifyHpcClusterAttributeRequest() + model = models.ModifyKeyPairAttributeRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.ModifyHpcClusterAttribute(model) + rsp = client.ModifyKeyPairAttribute(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -3917,7 +3657,7 @@ def doModifyHpcClusterAttribute(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doModifyKeyPairAttribute(args, parsed_globals): +def doModifyHostsAttribute(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -3946,11 +3686,11 @@ def doModifyKeyPairAttribute(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.ModifyKeyPairAttributeRequest() + model = models.ModifyHostsAttributeRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.ModifyKeyPairAttribute(model) + rsp = client.ModifyHostsAttribute(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -3969,7 +3709,7 @@ def doModifyKeyPairAttribute(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doModifyHostsAttribute(args, parsed_globals): +def doDescribeImages(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -3998,11 +3738,11 @@ def doModifyHostsAttribute(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.ModifyHostsAttributeRequest() + model = models.DescribeImagesRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.ModifyHostsAttribute(model) + rsp = client.DescribeImages(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -4021,7 +3761,7 @@ def doModifyHostsAttribute(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeImages(args, parsed_globals): +def doCreateDisasterRecoverGroup(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -4050,11 +3790,11 @@ def doDescribeImages(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeImagesRequest() + model = models.CreateDisasterRecoverGroupRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribeImages(model) + rsp = client.CreateDisasterRecoverGroup(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -4073,7 +3813,7 @@ def doDescribeImages(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doCreateDisasterRecoverGroup(args, parsed_globals): +def doDescribeInstances(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -4102,11 +3842,11 @@ def doCreateDisasterRecoverGroup(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.CreateDisasterRecoverGroupRequest() + model = models.DescribeInstancesRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.CreateDisasterRecoverGroup(model) + rsp = client.DescribeInstances(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -4125,7 +3865,7 @@ def doCreateDisasterRecoverGroup(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeInstances(args, parsed_globals): +def doDescribeLaunchTemplateVersions(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -4154,11 +3894,11 @@ def doDescribeInstances(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeInstancesRequest() + model = models.DescribeLaunchTemplateVersionsRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribeInstances(model) + rsp = client.DescribeLaunchTemplateVersions(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -4177,7 +3917,7 @@ def doDescribeInstances(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeLaunchTemplateVersions(args, parsed_globals): +def doDescribeInstanceInternetBandwidthConfigs(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -4206,11 +3946,11 @@ def doDescribeLaunchTemplateVersions(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeLaunchTemplateVersionsRequest() + model = models.DescribeInstanceInternetBandwidthConfigsRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribeLaunchTemplateVersions(model) + rsp = client.DescribeInstanceInternetBandwidthConfigs(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -4229,7 +3969,7 @@ def doDescribeLaunchTemplateVersions(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeInstanceInternetBandwidthConfigs(args, parsed_globals): +def doInquiryPriceTerminateInstances(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -4258,11 +3998,11 @@ def doDescribeInstanceInternetBandwidthConfigs(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeInstanceInternetBandwidthConfigsRequest() + model = models.InquiryPriceTerminateInstancesRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribeInstanceInternetBandwidthConfigs(model) + rsp = client.InquiryPriceTerminateInstances(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -4281,7 +4021,7 @@ def doDescribeInstanceInternetBandwidthConfigs(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doInquiryPriceTerminateInstances(args, parsed_globals): +def doDeleteImages(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -4310,11 +4050,11 @@ def doInquiryPriceTerminateInstances(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.InquiryPriceTerminateInstancesRequest() + model = models.DeleteImagesRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.InquiryPriceTerminateInstances(model) + rsp = client.DeleteImages(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -4333,7 +4073,7 @@ def doInquiryPriceTerminateInstances(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDeleteImages(args, parsed_globals): +def doDeleteLaunchTemplateVersions(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -4362,11 +4102,11 @@ def doDeleteImages(args, parsed_globals): client = mod.CvmClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DeleteImagesRequest() + model = models.DeleteLaunchTemplateVersionsRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DeleteImages(model) + rsp = client.DeleteLaunchTemplateVersions(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -5289,13 +5029,11 @@ def doDescribeChcHosts(args, parsed_globals): "DeleteLaunchTemplate": doDeleteLaunchTemplate, "ModifyInstancesVpcAttribute": doModifyInstancesVpcAttribute, "DescribeDisasterRecoverGroupQuota": doDescribeDisasterRecoverGroupQuota, - "DescribeReservedInstances": doDescribeReservedInstances, + "DescribeTaskInfo": doDescribeTaskInfo, "CreateImage": doCreateImage, "ConfigureChcAssistVpc": doConfigureChcAssistVpc, "ResetInstancesType": doResetInstancesType, - "DescribeReservedInstancesConfigInfos": doDescribeReservedInstancesConfigInfos, "DescribeInstanceFamilyConfigs": doDescribeInstanceFamilyConfigs, - "InquirePricePurchaseReservedInstancesOffering": doInquirePricePurchaseReservedInstancesOffering, "SyncImages": doSyncImages, "ImportImage": doImportImage, "DescribeZoneInstanceConfigInfos": doDescribeZoneInstanceConfigInfos, @@ -5305,7 +5043,6 @@ def doDescribeChcHosts(args, parsed_globals): "DisassociateSecurityGroups": doDisassociateSecurityGroups, "RemoveChcDeployVpc": doRemoveChcDeployVpc, "DescribeImageSharePermission": doDescribeImageSharePermission, - "DescribeRegions": doDescribeRegions, "DescribeInstancesModification": doDescribeInstancesModification, "CreateKeyPair": doCreateKeyPair, "AssociateInstancesKeyPairs": doAssociateInstancesKeyPairs, @@ -5315,8 +5052,8 @@ def doDescribeChcHosts(args, parsed_globals): "ModifyDisasterRecoverGroupAttribute": doModifyDisasterRecoverGroupAttribute, "DescribeHpcClusters": doDescribeHpcClusters, "DescribeInstancesOperationLimit": doDescribeInstancesOperationLimit, - "DeleteLaunchTemplateVersions": doDeleteLaunchTemplateVersions, "StopInstances": doStopInstances, + "DescribeRegions": doDescribeRegions, "DescribeImportImageOs": doDescribeImportImageOs, "DeleteHpcClusters": doDeleteHpcClusters, "InquiryPriceRenewInstances": doInquiryPriceRenewInstances, @@ -5333,7 +5070,6 @@ def doDescribeChcHosts(args, parsed_globals): "DescribeInstancesActionTimer": doDescribeInstancesActionTimer, "InquiryPriceResizeInstanceDisks": doInquiryPriceResizeInstanceDisks, "InquiryPriceResetInstance": doInquiryPriceResetInstance, - "PurchaseReservedInstancesOffering": doPurchaseReservedInstancesOffering, "ModifyInstancesRenewFlag": doModifyInstancesRenewFlag, "ResetInstance": doResetInstance, "StartInstances": doStartInstances, @@ -5347,8 +5083,6 @@ def doDescribeChcHosts(args, parsed_globals): "DescribeInstanceVncUrl": doDescribeInstanceVncUrl, "ModifyInstancesProject": doModifyInstancesProject, "DescribeKeyPairs": doDescribeKeyPairs, - "DescribeTaskInfo": doDescribeTaskInfo, - "DescribeReservedInstancesOfferings": doDescribeReservedInstancesOfferings, "InquiryPriceModifyInstancesChargeType": doInquiryPriceModifyInstancesChargeType, "DescribeInternetChargeTypeConfigs": doDescribeInternetChargeTypeConfigs, "RebootInstances": doRebootInstances, @@ -5364,6 +5098,7 @@ def doDescribeChcHosts(args, parsed_globals): "DescribeInstanceInternetBandwidthConfigs": doDescribeInstanceInternetBandwidthConfigs, "InquiryPriceTerminateInstances": doInquiryPriceTerminateInstances, "DeleteImages": doDeleteImages, + "DeleteLaunchTemplateVersions": doDeleteLaunchTemplateVersions, "ResetInstancesPassword": doResetInstancesPassword, "ResizeInstanceDisks": doResizeInstanceDisks, "DescribeZones": doDescribeZones, diff --git a/tccli/services/cvm/v20170312/api.json b/tccli/services/cvm/v20170312/api.json index c831d2a175..3e1cce4cbb 100644 --- a/tccli/services/cvm/v20170312/api.json +++ b/tccli/services/cvm/v20170312/api.json @@ -315,27 +315,6 @@ "output": "DescribeRegionsResponse", "status": "online" }, - "DescribeReservedInstances": { - "document": "本接口(DescribeReservedInstances)可提供列出用户已购买的预留实例", - "input": "DescribeReservedInstancesRequest", - "name": "列出已购买的预留实例", - "output": "DescribeReservedInstancesResponse", - "status": "online" - }, - "DescribeReservedInstancesConfigInfos": { - "document": "本接口(DescribeReservedInstancesConfigInfos)供用户列出可购买预留实例机型配置。预留实例当前只针对国际站白名单用户开放。", - "input": "DescribeReservedInstancesConfigInfosRequest", - "name": "查询预留实例机型配置参数", - "output": "DescribeReservedInstancesConfigInfosResponse", - "status": "online" - }, - "DescribeReservedInstancesOfferings": { - "document": "本接口(DescribeReservedInstancesOfferings)供用户列出可购买的预留实例配置", - "input": "DescribeReservedInstancesOfferingsRequest", - "name": "列出可购买的预留实例配置", - "output": "DescribeReservedInstancesOfferingsResponse", - "status": "online" - }, "DescribeTaskInfo": { "document": "本接口 (DescribeTaskInfo) 用于查询云服务器维修任务列表及详细信息。\n\n- 可以根据实例ID、实例名称或任务状态等信息来查询维修任务列表。过滤信息详情可参考入参说明。\n- 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的维修任务列表。", "input": "DescribeTaskInfoRequest", @@ -413,13 +392,6 @@ "output": "ImportKeyPairResponse", "status": "online" }, - "InquirePricePurchaseReservedInstancesOffering": { - "document": "本接口(InquirePricePurchaseReservedInstancesOffering)用于创建预留实例询价。本接口仅允许针对购买限制范围内的预留实例配置进行询价。预留实例当前只针对国际站白名单用户开放。", - "input": "InquirePricePurchaseReservedInstancesOfferingRequest", - "name": "创建预留实例询价", - "output": "InquirePricePurchaseReservedInstancesOfferingResponse", - "status": "online" - }, "InquiryPriceModifyInstancesChargeType": { "document": "本接口 (InquiryPriceModifyInstancesChargeType) 用于切换实例的计费模式询价。\n\n\n* 关机不收费的实例、`批量计算型BC1`和`批量计算型BS1`机型族的实例、设置定时销毁的实例、竞价实例不支持该操作。", "input": "InquiryPriceModifyInstancesChargeTypeRequest", @@ -588,13 +560,6 @@ "output": "ProgramFpgaImageResponse", "status": "online" }, - "PurchaseReservedInstancesOffering": { - "document": "本接口(PurchaseReservedInstancesOffering)用于用户购买一个或者多个指定配置的预留实例", - "input": "PurchaseReservedInstancesOfferingRequest", - "name": "购买预留实例", - "output": "PurchaseReservedInstancesOfferingResponse", - "status": "online" - }, "RebootInstances": { "document": "本接口 (RebootInstances) 用于重启实例。\n\n* 只有状态为`RUNNING`的实例才可以进行此操作。\n* 接口调用成功时,实例会进入`REBOOTING`状态;重启实例成功时,实例会进入`RUNNING`状态。\n* 支持强制重启。强制重启的效果等同于关闭物理计算机的电源开关再重新启动。强制重启可能会导致数据丢失或文件系统损坏,请仅在服务器不能正常重启时使用。\n* 支持批量操作,每次请求批量实例的上限为100。\n* 实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。", "input": "RebootInstancesRequest", @@ -1067,7 +1032,52 @@ }, "ChcDeployExtraConfig": { "document": "chc部署网络minos引导配置。", - "members": [], + "members": [ + { + "disabled": false, + "document": "minos类型。是使用腾讯云的minios,还是客户自己的minios。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "public", + "member": "string", + "name": "MiniOsType", + "output_required": true, + "required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "服务器的架构和启动方式。取值为x86_legacy, arm_uefi。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "x86_legacy", + "member": "string", + "name": "BootType", + "output_required": true, + "required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "PXE使用的引导文件。默认为pxelinux.0。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "pxelinux.0", + "member": "string", + "name": "BootFile", + "output_required": true, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "tftp服务器的ip地址。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "169.254.68.10", + "member": "string", + "name": "NextServerAddress", + "output_required": true, + "required": false, + "type": "string", + "value_allowed_null": true + } + ], "usage": "both" }, "ChcHost": { @@ -1079,7 +1089,7 @@ "example": "chc-1a2b3c4d", "member": "string", "name": "ChcId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1089,7 +1099,7 @@ "example": "托管服务器1", "member": "string", "name": "InstanceName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1099,7 +1109,7 @@ "example": "sn34asdfabd", "member": "string", "name": "SerialNumber", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1109,7 +1119,7 @@ "example": "ONLINE", "member": "string", "name": "InstanceState", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1119,27 +1129,27 @@ "example": "CHC_HS1", "member": "string", "name": "DeviceType", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "所属可用区", - "example": "NA", + "example": "无", "member": "Placement", "name": "Placement", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, { "disabled": false, "document": "带外网络。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "NA", + "example": "无", "member": "VirtualPrivateCloud", "name": "BmcVirtualPrivateCloud", - "required": false, + "output_required": true, "type": "object", "value_allowed_null": true }, @@ -1149,7 +1159,7 @@ "example": "10.12.10.34", "member": "string", "name": "BmcIp", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -1159,17 +1169,17 @@ "example": "[\"sg-1a2b34af\"]", "member": "string", "name": "BmcSecurityGroupIds", - "required": false, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "部署网络。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "NA", + "example": "无", "member": "VirtualPrivateCloud", "name": "DeployVirtualPrivateCloud", - "required": false, + "output_required": true, "type": "object", "value_allowed_null": true }, @@ -1179,7 +1189,7 @@ "example": "10.12.10.34", "member": "string", "name": "DeployIp", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -1189,7 +1199,7 @@ "example": "[\"sg-1a2b34af\"]", "member": "string", "name": "DeploySecurityGroupIds", - "required": false, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -1199,7 +1209,7 @@ "example": "ins-34as43at", "member": "string", "name": "CvmInstanceId", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -1209,7 +1219,7 @@ "example": "2020-03-10T02:43:51Z", "member": "string", "name": "CreatedTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1219,7 +1229,7 @@ "example": "128C 22GB 2424GB", "member": "string", "name": "HardwareDescription", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -1229,7 +1239,7 @@ "example": "128", "member": "int64", "name": "CPU", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -1239,7 +1249,7 @@ "example": "22", "member": "int64", "name": "Memory", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -1249,7 +1259,7 @@ "example": "无", "member": "string", "name": "Disk", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -1259,7 +1269,7 @@ "example": "51:94:20:9C:B1:CB", "member": "string", "name": "BmcMAC", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -1269,7 +1279,7 @@ "example": "51:94:20:9C:B1:CB", "member": "string", "name": "DeployMAC", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -1279,19 +1289,169 @@ "example": "HOSTING", "member": "string", "name": "TenantType", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "chc dhcp选项,用于minios调试\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "chc dhcp选项,用于minios调试。\n注意:此字段可能返回 null,表示取不到有效值。", "example": "无", "member": "ChcDeployExtraConfig", "name": "DeployExtraConfig", - "required": false, + "output_required": true, "type": "object", "value_allowed_null": true + }, + { + "disabled": false, + "document": "GPU型号。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "2 * NVIDIA P40", + "member": "string", + "name": "Gpu", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "网卡型号。主要指RDMA网卡。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "ConnectX-5", + "member": "string", + "name": "NetworkCard", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "是否是预定义机型。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "true", + "member": "bool", + "name": "IsPredefinedType", + "output_required": false, + "type": "bool", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "CHC云主机机型。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "CHCS5.128C256M", + "member": "string", + "name": "ChcInstanceType", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "CHC云主机机型簇。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "CHCS5", + "member": "string", + "name": "ChcInstanceFamily", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "CHC云主机机型簇名称。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "标准型CHCS5", + "member": "string", + "name": "ChcInstanceFamilyName", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "转售客户的AppId。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "12510001001", + "member": "string", + "name": "ResaleAppId", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "转售客户的账号ID。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "100002300442", + "member": "string", + "name": "ResaleAccountId", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "售卖状态。<br/>\n<ul>\n<li>NOT_FOR_SALE:不可售卖</li>\n<li>AVAILABLE: 可售卖</li>\n<li>SOLD: 已售卖</li>\n</ul>\n\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "SOLD", + "member": "string", + "name": "SaleStatus", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "CHC物理服务器关联的标签列表。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "Tag", + "name": "Tags", + "output_required": false, + "type": "list", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "最近操作", + "example": "ChcPrepare", + "member": "string", + "name": "LatestOperation", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "最近操作错误码", + "example": "IpmiFailed", + "member": "string", + "name": "LatestOperationErrorCode", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "最近操作错误详情和建议项", + "example": "执行IPMI命令失败:1、账号能够拥有远程执行IPMI命令权限;2、在BIOS中设置允许LAN执行IPMI命令。", + "member": "string", + "name": "LatestOperationErrorMsg", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "最近操作名称", + "example": "带外检查失败", + "member": "string", + "name": "LatestOperationName", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "最近操作状态", + "example": "FAILED", + "member": "string", + "name": "LatestOperationState", + "output_required": false, + "type": "string", + "value_allowed_null": false } ], "usage": "out" @@ -1347,7 +1507,7 @@ { "disabled": false, "document": "带外网络信息。", - "example": "NA", + "example": "无", "member": "VirtualPrivateCloud", "name": "BmcVirtualPrivateCloud", "required": true, @@ -1365,7 +1525,7 @@ { "disabled": false, "document": "部署网络信息。", - "example": "NA", + "example": "无", "member": "VirtualPrivateCloud", "name": "DeployVirtualPrivateCloud", "required": false, @@ -1379,6 +1539,15 @@ "name": "DeploySecurityGroupIds", "required": false, "type": "list" + }, + { + "disabled": false, + "document": "部署网络的附加参数,用于指定minios类型、bios引导模式等", + "example": "无", + "member": "ChcDeployExtraConfig", + "name": "ChcDeployExtraConfig", + "required": false, + "type": "object" } ], "type": "object" @@ -1410,7 +1579,7 @@ { "disabled": false, "document": "部署网络信息。", - "example": "NA", + "example": "无", "member": "VirtualPrivateCloud", "name": "DeployVirtualPrivateCloud", "required": true, @@ -1424,6 +1593,15 @@ "name": "DeploySecurityGroupIds", "required": false, "type": "list" + }, + { + "disabled": false, + "document": "部署所需要的dhcp选项参数", + "example": "无", + "member": "ChcDeployExtraConfig", + "name": "ChcDeployExtraConfig", + "required": false, + "type": "object" } ], "type": "object" @@ -1904,7 +2082,7 @@ { "disabled": false, "document": "实例所在的位置。通过该参数可以指定实例所属可用区,所属项目,所属宿主机(在专用宿主机上创建子机时指定)等属性。", - "example": "{ \"Zone\": \"ap-guangzhou-6\" }", + "example": "无", "member": "Placement", "name": "Placement", "required": true, @@ -1940,7 +2118,7 @@ { "disabled": false, "document": "实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。", - "example": "{ \"DiskSize\": 50 }", + "example": "无", "member": "SystemDisk", "name": "SystemDisk", "required": false, @@ -1949,7 +2127,7 @@ { "disabled": false, "document": "实例数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。", - "example": "[ { \"DiskSize\": 50, \"DiskType\": \"CLOUD_PREMIUM\" } ]", + "example": "无", "member": "DataDisk", "name": "DataDisks", "required": false, @@ -1958,7 +2136,7 @@ { "disabled": false, "document": "私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。若不指定该参数,则默认使用基础网络。若在此参数中指定了私有网络IP,即表示每个实例的主网卡IP;同时,InstanceCount参数必须与私有网络IP的个数一致且不能大于20。", - "example": "{ \"VpcId\": \"vpc-rhfaxx31\", \"SubnetId\": \"subnet-x7vxgqe\" }", + "example": "无", "member": "VirtualPrivateCloud", "name": "VirtualPrivateCloud", "required": false, @@ -1967,7 +2145,7 @@ { "disabled": false, "document": "公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。", - "example": "{ \"PublicIpAssigned\": \"false\" }", + "example": "无", "member": "InternetAccessible", "name": "InternetAccessible", "required": false, @@ -1994,7 +2172,7 @@ { "disabled": false, "document": "实例登录设置。通过该参数可以设置实例的登录方式为密钥或保持镜像的原始登录设置。", - "example": "{ \"KeyIds\": [ \"skey-9tzxxb4j\" ] }", + "example": "无", "member": "LoginSettings", "name": "LoginSettings", "required": false, @@ -2012,7 +2190,7 @@ { "disabled": false, "document": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认公共镜像开启云监控、云安全服务;自定义镜像与镜像市场镜像默认不开启云监控,云安全服务,而使用镜像里保留的服务。", - "example": "{ \"SecurityService\": { \"Enabled\": \"true\" } }", + "example": "无", "member": "EnhancedService", "name": "EnhancedService", "required": false, @@ -2039,7 +2217,7 @@ { "disabled": false, "document": "定时任务。通过该参数可以为实例指定定时任务,目前仅支持定时销毁。", - "example": "{ \"TimerAction\": \"TerminateInstances\", \"ActionTime\": \"2024-05-29T11:26:40Z\t\" }", + "example": "无", "member": "ActionTimer", "name": "ActionTimer", "required": false, @@ -2057,7 +2235,7 @@ { "disabled": false, "document": "标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例,当前仅支持绑定标签到云服务器实例。", - "example": "[ { \"ResourceType\": \"instance\", \"Tags\": [ { \"Key\": \"myTag\", \"Value\": \"cloud\" } ] } ]", + "example": "无", "member": "TagSpecification", "name": "TagSpecification", "required": false, @@ -2066,7 +2244,7 @@ { "disabled": false, "document": "实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。", - "example": "{ \"SpotOptions\": { \"MaxPrice\": \"1000\" } }", + "example": "无", "member": "InstanceMarketOptionsRequest", "name": "InstanceMarketOptions", "required": false, @@ -2120,7 +2298,7 @@ { "disabled": false, "document": "预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", - "example": "{ \"Period\": 36, \"RenewFlag\": \"NOTIFY_AND_AUTO_RENEW\" }", + "example": "无", "member": "InstanceChargePrepaid", "name": "InstanceChargePrepaid", "required": false, @@ -2881,8 +3059,8 @@ }, { "disabled": false, - "document": "<li><strong>zone</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>可用区</strong>】进行过滤。可用区形如:ap-guangzhou-1。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:<a href=\"https://cloud.tencent.com/document/product/213/6091\">可用区列表</a></p>\n<li><strong>instance-name</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>实例名称</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n<li><strong>instance-state</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>实例状态</strong>】进行过滤。状态类型详见[实例状态表](https://cloud.tencent.com/document/api/213/15753#InstanceStatus)</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n<li><strong>device-type</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>设备类型</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n<li><strong>vpc-id</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>私有网络唯一ID</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n<li><strong>subnet-id</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>私有子网唯一ID</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>", - "example": "NA", + "document": "<li><strong>zone</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>可用区</strong>】进行过滤。可用区形如:ap-guangzhou-1。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:<a href=\"https://cloud.tencent.com/document/product/213/6091\">可用区列表</a></p>\n<li><strong>instance-name</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>实例名称</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n<li><strong>instance-state</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>实例状态</strong>】进行过滤。状态类型详见[实例状态表](https://cloud.tencent.com/document/api/213/15753#InstanceStatus)</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n<li><strong>device-type</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>设备类型</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n<li><strong>vpc-id</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>私有网络唯一ID</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n<li><strong>subnet-id</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>私有子网唯一ID</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n<li><strong>sn</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>设备SN</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>", + "example": "无", "member": "Filter", "name": "Filters", "required": false, @@ -2918,15 +3096,17 @@ "example": "5", "member": "int64", "name": "TotalCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "返回的实例列表", - "example": "NA", + "example": "无", "member": "ChcHost", "name": "ChcHostSet", + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -3262,7 +3442,7 @@ { "disabled": false, "document": "镜像信息,没有可用镜像是返回为空\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{ \"ImageId\": \"img-3s7ggx0j\", \"OsName\": \"Ubuntu Server 20.04 LTS 64bit\", \"ImageType\": \"PRIVATE_IMAGE\", \"CreatedTime\": \"2024-11-13T16:24:26Z\", \"ImageName\": \"test-image-1\", \"ImageDescription\": \"\", \"ImageSize\": 50, \"Architecture\": \"x86_64\", \"ImageState\": \"NORMAL\", \"Platform\": \"Ubuntu\", \"ImageCreator\": \"200038031997\", \"ImageSource\": \"CREATE_IMAGE\", \"SyncPercent\": null, \"IsSupportCloudinit\": true, \"SnapshotSet\": [ { \"SnapshotId\": \"snap-4lp2php6\", \"DiskUsage\": \"SYSTEM_DISK\", \"DiskSize\": 50 } ], \"ImageFamily\": \"test-family\", \"ImageDeprecated\": false, \"Tags\": [], \"LicenseType\": \"TencentCloud\" }", + "example": "无", "member": "Image", "name": "Image", "output_required": false, @@ -3439,6 +3619,7 @@ "example": "无", "member": "ImageOsList", "name": "ImportImageOsListSupported", + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -3448,6 +3629,7 @@ "example": "无", "member": "OsVersion", "name": "ImportImageOsVersionSet", + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -3796,7 +3978,7 @@ { "disabled": false, "document": "<li><strong>zone</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>可用区</strong>】进行过滤。可用区例如:ap-guangzhou-1。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:<a href=\"https://cloud.tencent.com/document/product/213/6091\">可用区列表</a></p> <li><strong>project-id</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>项目ID</strong>】进行过滤,可通过调用[DescribeProjects](https://cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看;也可以调用[AddProject](https://cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID例如:1002189。</p><p style=\"padding-left: 30px;\">类型:Integer</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>host-id</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>[CDH](https://cloud.tencent.com/document/product/416) ID</strong>】进行过滤。[CDH](https://cloud.tencent.com/document/product/416) ID例如:host-xxxxxxxx。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>dedicated-cluster-id</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>[CDC](https://cloud.tencent.com/document/product/1346) ID</strong>】进行过滤。[CDC](https://cloud.tencent.com/document/product/1346) ID例如:cluster-xxxxxxx。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>vpc-id</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>VPC ID</strong>】进行过滤。VPC ID例如:vpc-xxxxxxxx。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>subnet-id</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>子网ID</strong>】进行过滤。子网ID例如:subnet-xxxxxxxx。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>instance-id</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>实例ID</strong>】进行过滤。实例ID例如:ins-xxxxxxxx。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>uuid</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>实例UUID</strong>】进行过滤。实例UUID例如:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>security-group-id</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>安全组ID</strong>】进行过滤。安全组ID例如: sg-8jlk3f3r。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>instance-name</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>实例名称</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>instance-charge-type</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>实例计费模式</strong>】进行过滤。(PREPAID:表示预付费,即包年包月 | POSTPAID_BY_HOUR:表示后付费,即按量计费 | CDHPAID:表示[CDH](https://cloud.tencent.com/document/product/416)付费,即只对[CDH](https://cloud.tencent.com/document/product/416)计费,不对[CDH](https://cloud.tencent.com/document/product/416)上的实例计费。)</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>instance-state</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>实例状态</strong>】进行过滤。状态类型详见[实例状态表](https://cloud.tencent.com/document/api/213/15753#InstanceStatus)</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>private-ip-address</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>实例主网卡的内网IP</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>public-ip-address</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>实例主网卡的公网IP</strong>】进行过滤,包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>ipv6-address</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>实例的IPv6地址</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>tag-key</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>标签键</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>tag-value</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>标签值</strong>】进行过滤。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> <li><strong>tag:tag-key</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>标签键值对</strong>】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><li><strong>creation-start-time</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>实例创建起始时间</strong>】进行过滤。例如:2023-06-01 00:00:00。\n</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n<li><strong>creation-end-time</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>实例创建截止时间</strong>】进行过滤。例如:2023-06-01 00:00:00。\n</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p> 每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。", - "example": "[ { \"Name\": \"zone\", \"Values\": [ \"ap-guangzhou-6\" ] } ] ", + "example": "无", "member": "Filter", "name": "Filters", "required": false, @@ -3839,7 +4021,7 @@ { "disabled": false, "document": "实例详细信息列表。", - "example": "[ { \"RenewFlag\": \"NOTIFY_AND_MANUAL_RENEW\", \"Uuid\": \"e85f1388-0422-401d-8e50-bef540e78c18\", \"InstanceState\": \"RUNNING\", \"DisableApiTermination\": false, \"LatestOperationErrorMsg\": \"\", \"DefaultLoginPort\": 22, \"LicenseType\": \"TencentCloud\", \"DefaultLoginUser\": \"root\", \"LatestOperationState\": \"SUCCESS\", \"IPv6Addresses\": [ \"2001:0db8:86a3:08d3:1319:8a2e:0370:7344\" ], \"DedicatedClusterId\": \"\", \"RestrictState\": \"PROTECTIVELY_ISOLATED\", \"ExpiredTime\": \"2020-09-22T00:00:00+00:00\", \"DisasterRecoverGroupId\": \"\", \"Memory\": 1, \"CreatedTime\": \"2020-09-22T00:00:00+00:00\", \"CPU\": 1, \"RdmaIpAddresses\": [], \"CamRoleName\": \"\", \"PublicIpAddresses\": [ \"123.207.11.190\" ], \"Tags\": [ { \"Value\": \"test\", \"Key\": \"test\" } ], \"InstanceId\": \"ins-xlsyru2j\", \"ImageId\": \"img-8toqc6s3\", \"StopChargingMode\": \"NOT_APPLICABLE\", \"InstanceChargeType\": \"POSTPAID_BY_HOUR\", \"InstanceType\": \"S2.SMALL2\", \"SystemDisk\": { \"DiskSize\": 50, \"DiskId\": \"disk-czsodtl1\", \"DiskType\": \"CLOUD_SSD\" }, \"Placement\": { \"ProjectId\": 1174660, \"HostIds\": [], \"Zone\": \"ap-guangzhou-2\", \"HostIps\": [] }, \"PrivateIpAddresses\": [ \"172.16.32.78\" ], \"OsName\": \"CentOS 7.4 64bit\", \"SecurityGroupIds\": [ \"sg-p1ezv4wz\" ], \"InstanceName\": \"test\", \"IsolatedSource\": \"NOTISOLATED\", \"VirtualPrivateCloud\": { \"SubnetId\": \"subnet-mv4sn55k\", \"AsVpcGateway\": false, \"Ipv6AddressCount\": 1, \"VpcId\": \"vpc-m0xxxtxj\", \"PrivateIpAddresses\": [ \"172.10.3.59\" ] }, \"LatestOperationRequestId\": \"c7dexxx-061d-4ace-8caf-6ad8e5a2f29a\", \"InternetAccessible\": { \"PublicIpAssigned\": true, \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\", \"InternetMaxBandwidthOut\": 1 }, \"HpcClusterId\": \"\", \"LatestOperation\": \"ResetInstancesType\" } ]", + "example": "无", "member": "Instance", "name": "InstanceSet", "output_required": true, @@ -4232,205 +4414,6 @@ ], "type": "object" }, - "DescribeReservedInstancesConfigInfosRequest": { - "document": "DescribeReservedInstancesConfigInfos请求参数结构体", - "members": [ - { - "disabled": false, - "document": "zone\n按照预留实例计费可购买的可用区进行过滤。形如:ap-guangzhou-1。\n类型:String\n必选:否\n可选项:各地域可用区列表\n\nproduct-description\n按照预留实例计费的平台描述(即操作系统)进行过滤。形如:linux。\n类型:String\n必选:否\n可选项:linux\n\nduration\n按照预留实例计费有效期,即预留实例计费购买时长进行过滤。形如:31536000。\n类型:Integer\n计量单位:秒\n必选:否\n可选项:31536000 (1年)", - "example": "无", - "member": "Filter", - "name": "Filters", - "required": false, - "type": "list" - } - ], - "type": "object" - }, - "DescribeReservedInstancesConfigInfosResponse": { - "document": "DescribeReservedInstancesConfigInfos返回参数结构体", - "members": [ - { - "disabled": false, - "document": "预留实例静态配置信息列表。", - "example": "无", - "member": "ReservedInstanceConfigInfoItem", - "name": "ReservedInstanceConfigInfos", - "output_required": true, - "type": "list", - "value_allowed_null": false - }, - { - "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", - "member": "string", - "name": "RequestId", - "type": "string" - } - ], - "type": "object" - }, - "DescribeReservedInstancesOfferingsRequest": { - "document": "DescribeReservedInstancesOfferings请求参数结构体", - "members": [ - { - "disabled": false, - "document": "试运行, 默认为 false。", - "example": "False", - "member": "bool", - "name": "DryRun", - "required": false, - "type": "bool" - }, - { - "disabled": false, - "document": "偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", - "example": "10", - "member": "int64", - "name": "Offset", - "required": false, - "type": "int" - }, - { - "disabled": false, - "document": "返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", - "example": "10", - "member": "int64", - "name": "Limit", - "required": false, - "type": "int" - }, - { - "disabled": false, - "document": "以最大有效期作为过滤参数。\n计量单位: 秒\n默认为 94608000。", - "example": "10", - "member": "int64", - "name": "MaxDuration", - "required": false, - "type": "int" - }, - { - "disabled": false, - "document": "以最小有效期作为过滤参数。\n计量单位: 秒\n默认为 2592000。", - "example": "10", - "member": "int64", - "name": "MinDuration", - "required": false, - "type": "int" - }, - { - "disabled": false, - "document": "<li><strong>zone</strong></li>\n<p style=\"padding-left: 30px;\">按照预留实例计费可购买的【<strong>可用区</strong>】进行过滤。形如:ap-guangzhou-1。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:<a href=\"https://cloud.tencent.com/document/product/213/6091\">可用区列表</a></p>\n<li><strong>duration</strong></li>\n<p style=\"padding-left: 30px;\">按照预留实例计费【<strong>有效期</strong>】即预留实例计费购买时长进行过滤。形如:31536000。</p><p style=\"padding-left: 30px;\">类型:Integer</p><p style=\"padding-left: 30px;\">计量单位:秒</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:31536000 (1年) | 94608000(3年)</p>\n<li><strong>instance-type</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>预留实例计费类型</strong>】进行过滤。形如:S3.MEDIUM4。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:<a href=\"https://cloud.tencent.com/document/product/213/11518\">预留实例计费类型列表</a></p>\n<li><strong>offering-type</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>付款类型</strong>】进行过滤。形如:All Upfront (预付全部费用)。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:All Upfront (预付全部费用)</p>\n<li><strong>product-description</strong></li>\n<p style=\"padding-left: 30px;\">按照预留实例计费的【<strong>平台描述</strong>】(即操作系统)进行过滤。形如:linux。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:linux</p>\n<li><strong>reserved-instances-offering-id</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>预留实例计费配置ID</strong>】进行过滤。形如:650c138f-ae7e-4750-952a-96841d6e9fc1。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。", - "example": "无", - "member": "Filter", - "name": "Filters", - "required": false, - "type": "list" - } - ], - "type": "object" - }, - "DescribeReservedInstancesOfferingsResponse": { - "document": "DescribeReservedInstancesOfferings返回参数结构体", - "members": [ - { - "disabled": false, - "document": "符合条件的预留实例计费数量。", - "example": "4", - "member": "int64", - "name": "TotalCount", - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "符合条件的预留实例计费列表。", - "example": "无", - "member": "ReservedInstancesOffering", - "name": "ReservedInstancesOfferingsSet", - "type": "list", - "value_allowed_null": false - }, - { - "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", - "member": "string", - "name": "RequestId", - "type": "string" - } - ], - "type": "object" - }, - "DescribeReservedInstancesRequest": { - "document": "DescribeReservedInstances请求参数结构体", - "members": [ - { - "disabled": false, - "document": "试运行。默认为 false。", - "example": "false", - "member": "bool", - "name": "DryRun", - "required": false, - "type": "bool" - }, - { - "disabled": false, - "document": "偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", - "example": "0", - "member": "int64", - "name": "Offset", - "required": false, - "type": "int" - }, - { - "disabled": false, - "document": "返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", - "example": "1", - "member": "int64", - "name": "Limit", - "required": false, - "type": "int" - }, - { - "disabled": false, - "document": "<li><strong>zone</strong></li>\n<p style=\"padding-left: 30px;\">按照预留实例计费可购买的【<strong>可用区</strong>】进行过滤。形如:ap-guangzhou-1。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:<a href=\"https://cloud.tencent.com/document/product/213/6091\">可用区列表</a></p>\n<li><strong>duration</strong></li>\n<p style=\"padding-left: 30px;\">按照预留实例计费【<strong>有效期</strong>】即预留实例计费购买时长进行过滤。形如:31536000。</p><p style=\"padding-left: 30px;\">类型:Integer</p><p style=\"padding-left: 30px;\">计量单位:秒</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:31536000 (1年) | 94608000(3年)</p>\n<li><strong>instance-type</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>预留实例规格</strong>】进行过滤。形如:S3.MEDIUM4。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:<a href=\"https://cloud.tencent.com/document/product/213/11518\">预留实例规格列表</a></p>\n<li><strong>instance-family</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>预留实例类型</strong>】进行过滤。形如:S3。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:<a href=\"https://cloud.tencent.com/document/product/213/11518\">预留实例类型列表</a></p>\n<li><strong>offering-type</strong></li>\n<li><strong>offering-type</strong></li>\n<p style=\"padding-left: 30px;\">按照【<strong>付款类型</strong>】进行过滤。形如:All Upfront (全预付)。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:All Upfront (全预付) | Partial Upfront (部分预付) | No Upfront (零预付)</p>\n<li><strong>product-description</strong></li>\n<p style=\"padding-left: 30px;\">按照预留实例计费的【<strong>平台描述</strong>】(即操作系统)进行过滤。形如:linux。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:linux</p>\n<li><strong>reserved-instances-id</strong></li>\n<p style=\"padding-left: 30px;\">按照已购买【<strong>预留实例计费ID</strong>】进行过滤。形如:650c138f-ae7e-4750-952a-96841d6e9fc1。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p>\n<li><strong>state</strong></li>\n<p style=\"padding-left: 30px;\">按照已购买【<strong>预留实例计费状态</strong>】进行过滤。形如:active。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">可选项:active (已创建) | pending (等待被创建) | retired (过期)</p>\n每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。", - "example": "无", - "member": "Filter", - "name": "Filters", - "required": false, - "type": "list" - } - ], - "type": "object" - }, - "DescribeReservedInstancesResponse": { - "document": "DescribeReservedInstances返回参数结构体", - "members": [ - { - "disabled": false, - "document": "符合条件的预留实例计费数量。", - "example": "1", - "member": "int64", - "name": "TotalCount", - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "符合条件的预留实例计费列表。", - "example": "无", - "member": "ReservedInstances", - "name": "ReservedInstancesSet", - "type": "list", - "value_allowed_null": false - }, - { - "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", - "member": "string", - "name": "RequestId", - "type": "string" - } - ], - "type": "object" - }, "DescribeTaskInfoRequest": { "document": "DescribeTaskInfo请求参数结构体", "members": [ @@ -4625,7 +4608,7 @@ { "disabled": false, "document": "可用区数量。", - "example": "无", + "example": "1", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -4999,7 +4982,7 @@ { "disabled": false, "document": "镜像ID列表", - "example": "无", + "example": "img-72n9mi0y", "member": "string", "name": "ImageIds", "required": false, @@ -5026,7 +5009,7 @@ { "disabled": false, "document": "是否只导出系统盘", - "example": "True", + "example": "true", "member": "bool", "name": "OnlyExportRootDisk", "required": false, @@ -5035,7 +5018,7 @@ { "disabled": false, "document": "检测镜像是否支持导出", - "example": "True", + "example": "true", "member": "bool", "name": "DryRun", "required": false, @@ -5059,7 +5042,7 @@ { "disabled": false, "document": "导出镜像任务ID", - "example": "无", + "example": "124578", "member": "uint64", "name": "TaskId", "output_required": true, @@ -5069,7 +5052,7 @@ { "disabled": false, "document": "导出镜像的COS文件名列表", - "example": "无", + "example": "/img-9a0eg8mt.tar", "member": "string", "name": "CosPaths", "output_required": true, @@ -5442,7 +5425,7 @@ { "disabled": false, "document": "CDH owner\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "123456", + "example": "12300021", "member": "string", "name": "ExclusiveOwner", "output_required": false, @@ -5458,7 +5441,7 @@ { "disabled": false, "document": "高性能计算集群ID", - "example": "无", + "example": "hpc-07b1c", "member": "string", "name": "HpcClusterId", "output_required": true, @@ -5468,7 +5451,7 @@ { "disabled": false, "document": "高性能计算集群名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "myCluster", "member": "string", "name": "Name", "output_required": true, @@ -5478,7 +5461,7 @@ { "disabled": false, "document": "高性能计算集群备注\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "H20", "member": "string", "name": "Remark", "output_required": true, @@ -5488,7 +5471,7 @@ { "disabled": false, "document": "集群下设备容量", - "example": "无", + "example": "1600", "member": "uint64", "name": "CvmQuotaTotal", "output_required": true, @@ -5498,7 +5481,7 @@ { "disabled": false, "document": "集群所在可用区", - "example": "无", + "example": "ap-guangzhou-2", "member": "string", "name": "Zone", "output_required": true, @@ -5508,7 +5491,7 @@ { "disabled": false, "document": "集群当前已有设备量", - "example": "无", + "example": "1", "member": "uint64", "name": "CurrentNum", "output_required": true, @@ -5518,7 +5501,7 @@ { "disabled": false, "document": "集群创建时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2023-10-05T14:30:00Z", "member": "datetime_iso", "name": "CreateTime", "output_required": true, @@ -5528,7 +5511,7 @@ { "disabled": false, "document": "集群内实例ID列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"ins-xxxxx\"]", "member": "string", "name": "InstanceIds", "output_required": true, @@ -5538,7 +5521,7 @@ { "disabled": false, "document": "高性能计算集群类型。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "STANDARD", "member": "string", "name": "HpcClusterType", "output_required": false, @@ -5548,7 +5531,7 @@ { "disabled": false, "document": "高性能计算集群对应的业务场景标识,当前只支持CDC。\t\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cluster-1f6vxxx", "member": "string", "name": "HpcClusterBusinessId", "output_required": false, @@ -5604,7 +5587,7 @@ { "disabled": false, "document": "镜像名称", - "example": "test", + "example": "myImg", "member": "string", "name": "ImageName", "output_required": true, @@ -5614,7 +5597,7 @@ { "disabled": false, "document": "镜像描述", - "example": "test", + "example": "tencentcloud", "member": "string", "name": "ImageDescription", "output_required": true, @@ -5664,7 +5647,7 @@ { "disabled": false, "document": "镜像创建者", - "example": "xxx", + "example": "tencentcloud", "member": "string", "name": "ImageCreator", "output_required": true, @@ -5684,7 +5667,7 @@ { "disabled": false, "document": "同步百分比\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "null", + "example": "60", "member": "int64", "name": "SyncPercent", "output_required": true, @@ -5704,7 +5687,7 @@ { "disabled": false, "document": "镜像关联的快照信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "无", "member": "Snapshot", "name": "SnapshotSet", "output_required": true, @@ -5714,7 +5697,7 @@ { "disabled": false, "document": "镜像关联的标签列表。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "无", "member": "Tag", "name": "Tags", "output_required": true, @@ -5760,20 +5743,20 @@ { "disabled": false, "document": "支持的Windows操作系统。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "NA", + "example": "Windows Server 2019", "member": "string", "name": "Windows", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "支持的Linux操作系统\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "NA", + "example": "CentOS", "member": "string", "name": "Linux", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -6066,65 +6049,56 @@ ], "type": "object" }, - "InquirePricePurchaseReservedInstancesOfferingRequest": { - "document": "InquirePricePurchaseReservedInstancesOffering请求参数结构体", + "InquiryPriceModifyInstancesChargeTypeRequest": { + "document": "InquiryPriceModifyInstancesChargeType请求参数结构体", "members": [ { "disabled": false, - "document": "购买预留实例计费数量", - "example": "1", - "member": "uint64", - "name": "InstanceCount", + "document": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", + "example": "[\"ins-r8hr2upy\"]", + "member": "string", + "name": "InstanceIds", "required": true, - "type": "int" + "type": "list" }, { "disabled": false, - "document": "预留实例计费配置ID", - "example": "无", + "document": "修改后的实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。<br><li>PREPAID:预付费,即包年包月。</li><li>POSTPAID_BY_HOUR:后付费,即按量付费。</li>", + "example": "PREPAID", "member": "string", - "name": "ReservedInstancesOfferingId", + "name": "InstanceChargeType", "required": true, "type": "string" }, { "disabled": false, - "document": "试运行", - "example": "false", - "member": "bool", - "name": "DryRun", - "required": false, - "type": "bool" - }, - { - "disabled": false, - "document": "用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。<br>更多详细信息请参阅:如何保证幂等性", + "document": "预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。<dx-alert infotype=\"explain\" title=\"\">若指定修改后实例的付费模式为预付费则该参数必传。</dx-alert>", "example": "无", - "member": "string", - "name": "ClientToken", + "member": "InstanceChargePrepaid", + "name": "InstanceChargePrepaid", "required": false, - "type": "string" + "type": "object" }, { "disabled": false, - "document": "预留实例显示名称。<br><li>不指定实例显示名称则默认显示‘未命名’。</li><li>最多支持60个字符(包含模式串)。</li>", - "example": "myReservedInstance", - "member": "string", - "name": "ReservedInstanceName", + "document": "是否同时切换弹性数据云盘计费模式。取值范围:<br><li>true:表示切换弹性数据云盘计费模式</li><li>false:表示不切换弹性数据云盘计费模式</li><br>默认取值:false。", + "example": "false", + "member": "bool", + "name": "ModifyPortableDataDisk", "required": false, - "type": "string" + "type": "bool" } ], "type": "object" }, - "InquirePricePurchaseReservedInstancesOfferingResponse": { - "document": "InquirePricePurchaseReservedInstancesOffering返回参数结构体", + "InquiryPriceModifyInstancesChargeTypeResponse": { + "document": "InquiryPriceModifyInstancesChargeType返回参数结构体", "members": [ { "disabled": false, - "document": "该参数表示对应配置预留实例的价格。", + "document": "该参数表示对应配置实例转换计费模式的价格。", "example": "无", - "member": "ReservedInstancePrice", + "member": "Price", "name": "Price", "output_required": true, "type": "object", @@ -6139,79 +6113,15 @@ ], "type": "object" }, - "InquiryPriceModifyInstancesChargeTypeRequest": { - "document": "InquiryPriceModifyInstancesChargeType请求参数结构体", + "InquiryPriceRenewHostsRequest": { + "document": "InquiryPriceRenewHosts请求参数结构体", "members": [ { "disabled": false, - "document": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", - "example": "[\"ins-r8hr2upy\"]", + "document": "一个或多个待操作的`CDH`实例`ID`。可通过[`DescribeHosts`](https://cloud.tencent.com/document/api/213/16474)接口返回值中的`HostId`获取。每次请求批量实例的上限为100。", + "example": "[\"host-xxxxxxxx\"]", "member": "string", - "name": "InstanceIds", - "required": true, - "type": "list" - }, - { - "disabled": false, - "document": "修改后的实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。<br><li>PREPAID:预付费,即包年包月。</li><li>POSTPAID_BY_HOUR:后付费,即按量付费。</li>", - "example": "PREPAID", - "member": "string", - "name": "InstanceChargeType", - "required": true, - "type": "string" - }, - { - "disabled": false, - "document": "预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。<dx-alert infotype=\"explain\" title=\"\">若指定修改后实例的付费模式为预付费则该参数必传。</dx-alert>", - "example": "无", - "member": "InstanceChargePrepaid", - "name": "InstanceChargePrepaid", - "required": false, - "type": "object" - }, - { - "disabled": false, - "document": "是否同时切换弹性数据云盘计费模式。取值范围:<br><li>true:表示切换弹性数据云盘计费模式</li><li>false:表示不切换弹性数据云盘计费模式</li><br>默认取值:false。", - "example": "false", - "member": "bool", - "name": "ModifyPortableDataDisk", - "required": false, - "type": "bool" - } - ], - "type": "object" - }, - "InquiryPriceModifyInstancesChargeTypeResponse": { - "document": "InquiryPriceModifyInstancesChargeType返回参数结构体", - "members": [ - { - "disabled": false, - "document": "该参数表示对应配置实例转换计费模式的价格。", - "example": "无", - "member": "Price", - "name": "Price", - "output_required": true, - "type": "object", - "value_allowed_null": false - }, - { - "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", - "member": "string", - "name": "RequestId", - "type": "string" - } - ], - "type": "object" - }, - "InquiryPriceRenewHostsRequest": { - "document": "InquiryPriceRenewHosts请求参数结构体", - "members": [ - { - "disabled": false, - "document": "一个或多个待操作的`CDH`实例`ID`。可通过[`DescribeHosts`](https://cloud.tencent.com/document/api/213/16474)接口返回值中的`HostId`获取。每次请求批量实例的上限为100。", - "example": "[\"host-xxxxxxxx\"]", - "member": "string", - "name": "HostIds", + "name": "HostIds", "required": true, "type": "list" }, @@ -6227,7 +6137,7 @@ { "disabled": false, "document": "是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.false(默认):发送正常请求,通过检查后直接创建实例", - "example": "无", + "example": "false", "member": "bool", "name": "DryRun", "required": false, @@ -6611,7 +6521,7 @@ { "disabled": false, "document": "实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。", - "example": "无", + "example": "{ \"DiskSize\": 50 }", "member": "SystemDisk", "name": "SystemDisk", "required": false, @@ -6692,7 +6602,7 @@ { "disabled": false, "document": "用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。", - "example": "无", + "example": "a521b4e4-c903-4d37-9de6-8906e3ad8eb7", "member": "string", "name": "ClientToken", "required": false, @@ -7100,7 +7010,7 @@ { "disabled": false, "document": "分散置放群组ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "null", + "example": "ps-l7sdunxx", "member": "string", "name": "DisasterRecoverGroupId", "output_required": true, @@ -7110,7 +7020,7 @@ { "disabled": false, "document": "实例的IPv6地址。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "null", + "example": "[\"xx.xxxxx.xxx\"]", "member": "string", "name": "IPv6Addresses", "output_required": true, @@ -7120,7 +7030,7 @@ { "disabled": false, "document": "CAM角色名。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "null", + "example": "admin", "member": "string", "name": "CamRoleName", "output_required": true, @@ -7130,7 +7040,7 @@ { "disabled": false, "document": "高性能计算集群`ID`。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "null", + "example": "hpc-4dxxetpt", "member": "string", "name": "HpcClusterId", "output_required": true, @@ -7140,7 +7050,7 @@ { "disabled": false, "document": "高性能计算集群`IP`列表。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "null", + "example": "[\"xx.xxxxx.xxx\"]", "member": "string", "name": "RdmaIpAddresses", "output_required": true, @@ -7236,7 +7146,7 @@ { "disabled": false, "document": "购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "Period", "output_required": true, @@ -7247,7 +7157,7 @@ { "disabled": false, "document": "自动续费标识。取值范围:<br><li>NOTIFY_AND_AUTO_RENEW:通知过期且自动续费</li><br><li>NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费</li><br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费</li><br><br>默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "DISABLE_NOTIFY_AND_MANUAL_RENEW", "member": "string", "name": "RenewFlag", "output_required": true, @@ -7264,20 +7174,20 @@ { "disabled": false, "document": "机型族名称的中文全称。", - "example": "", + "example": "高IO型I1", "member": "string", "name": "InstanceFamilyName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "机型族名称的英文简称。", - "example": "", + "example": "I1", "member": "string", "name": "InstanceFamily", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -7290,9 +7200,10 @@ { "disabled": false, "document": "竞价相关选项\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0.12", "member": "SpotMarketOptions", "name": "SpotOptions", + "output_required": true, "required": true, "type": "object", "value_allowed_null": true @@ -7300,9 +7211,10 @@ { "disabled": false, "document": "市场选项类型,当前只支持取值:spot\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "spot", "member": "string", "name": "MarketType", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -7352,7 +7264,7 @@ { "disabled": false, "document": "实例`ID`。", - "example": "无", + "example": "ins-g4c6xxxx", "member": "string", "name": "InstanceId", "output_required": true, @@ -7362,7 +7274,7 @@ { "disabled": false, "document": "实例状态。取值范围:<br><li>PENDING:表示创建中<br></li><li>LAUNCH_FAILED:表示创建失败<br></li><li>RUNNING:表示运行中<br></li><li>STOPPED:表示关机<br></li><li>STARTING:表示开机中<br></li><li>STOPPING:表示关机中<br></li><li>REBOOTING:表示重启中<br></li><li>SHUTDOWN:表示停止待销毁<br></li><li>TERMINATING:表示销毁中<br></li><li>ENTER_RESCUE_MODE:表示进入救援模式<br></li><li>RESCUE_MODE:表示在救援模式中<br></li><li>EXIT_RESCUE_MODE:表示退出救援模式<br></li><li>ENTER_SERVICE_LIVE_MIGRATE:表示进入在线服务迁移<br></li><li>SERVICE_LIVE_MIGRATE:表示在线服务迁移中<br></li><li>EXIT_SERVICE_LIVE_MIGRATE:表示退出在线服务迁移。<br></li>", - "example": "无", + "example": "RUNNING", "member": "string", "name": "InstanceState", "output_required": true, @@ -7378,7 +7290,7 @@ { "disabled": false, "document": "可用区。", - "example": "无", + "example": "ap-guangzhou-2", "member": "string", "name": "Zone", "output_required": true, @@ -7388,7 +7300,7 @@ { "disabled": false, "document": "实例机型。", - "example": "无", + "example": "S5.LARGE4", "member": "string", "name": "InstanceType", "output_required": true, @@ -7398,7 +7310,7 @@ { "disabled": false, "document": "实例机型系列。", - "example": "无", + "example": "S5", "member": "string", "name": "InstanceFamily", "output_required": true, @@ -7408,7 +7320,7 @@ { "disabled": false, "document": "GPU核数,单位:核。", - "example": "无", + "example": "1", "member": "int64", "name": "GPU", "output_required": true, @@ -7418,7 +7330,7 @@ { "disabled": false, "document": "CPU核数,单位:核。", - "example": "无", + "example": "4", "member": "int64", "name": "CPU", "output_required": true, @@ -7428,7 +7340,7 @@ { "disabled": false, "document": "内存容量,单位:`GB`。", - "example": "无", + "example": "4", "member": "int64", "name": "Memory", "output_required": true, @@ -7438,7 +7350,7 @@ { "disabled": false, "document": "FPGA核数,单位:核。", - "example": "无", + "example": "1", "member": "int64", "name": "FPGA", "output_required": true, @@ -7448,7 +7360,7 @@ { "disabled": false, "document": "实例机型映射的物理GPU卡数,单位:卡。vGPU卡型小于1,直通卡型大于等于1。vGPU是通过分片虚拟化技术,将物理GPU卡重新划分,同一块GPU卡经虚拟化分割后可分配至不同的实例使用。直通卡型会将GPU设备直接挂载给实例使用。", - "example": "无", + "example": "1.0", "member": "float", "name": "GpuCount", "output_required": true, @@ -7500,7 +7412,7 @@ { "disabled": false, "document": "可用区。", - "example": "无", + "example": "ap-guangzhou-2", "member": "string", "name": "Zone", "output_required": true, @@ -7510,7 +7422,7 @@ { "disabled": false, "document": "实例机型。", - "example": "无", + "example": "S5.LARGE4", "member": "string", "name": "InstanceType", "output_required": true, @@ -7520,7 +7432,7 @@ { "disabled": false, "document": "实例计费模式。取值范围: <br><li>PREPAID:表示预付费,即包年包月<br></li>POSTPAID_BY_HOUR:表示后付费,即按量计费<br><li>CDHPAID:表示[专用宿主机](https://cloud.tencent.com/document/product/416)付费,即只对`专用宿主机`计费,不对`专用宿主机`上的实例计费。<br></li>`SPOTPAID`:表示竞价实例付费。", - "example": "无", + "example": "PREPAID", "member": "string", "name": "InstanceChargeType", "output_required": true, @@ -7530,7 +7442,7 @@ { "disabled": false, "document": "网卡类型,例如:25代表25G网卡", - "example": "无", + "example": "25", "member": "int64", "name": "NetworkCard", "output_required": true, @@ -7550,7 +7462,7 @@ { "disabled": false, "document": "实例的CPU核数,单位:核。", - "example": "无", + "example": "4", "member": "int64", "name": "Cpu", "output_required": true, @@ -7560,7 +7472,7 @@ { "disabled": false, "document": "实例内存容量,单位:`GB`。", - "example": "无", + "example": "4", "member": "int64", "name": "Memory", "output_required": true, @@ -7570,7 +7482,7 @@ { "disabled": false, "document": "实例机型系列。", - "example": "无", + "example": "S5", "member": "string", "name": "InstanceFamily", "output_required": true, @@ -7580,7 +7492,7 @@ { "disabled": false, "document": "机型名称。", - "example": "无", + "example": "标准型S5", "member": "string", "name": "TypeName", "output_required": true, @@ -7600,7 +7512,7 @@ { "disabled": false, "document": "实例是否售卖。取值范围: <br><li>SELL:表示实例可购买<br></li>SOLD_OUT:表示实例已售罄。", - "example": "无", + "example": "SELL", "member": "string", "name": "Status", "output_required": true, @@ -7620,7 +7532,7 @@ { "disabled": false, "document": "售罄原因。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ResourcesSoldOut.SpecifiedInstanceType", "member": "string", "name": "SoldOutReason", "output_required": true, @@ -7630,7 +7542,7 @@ { "disabled": false, "document": "内网带宽,单位Gbps。", - "example": "无", + "example": "10.0", "member": "float", "name": "InstanceBandwidth", "output_required": true, @@ -7640,7 +7552,7 @@ { "disabled": false, "document": "网络收发包能力,单位万PPS。", - "example": "无", + "example": "80", "member": "int64", "name": "InstancePps", "output_required": true, @@ -7650,7 +7562,7 @@ { "disabled": false, "document": "本地存储块数量。", - "example": "无", + "example": "10", "member": "int64", "name": "StorageBlockAmount", "output_required": true, @@ -7660,7 +7572,7 @@ { "disabled": false, "document": "处理器型号。", - "example": "无", + "example": "Intel Xeon Cascade Lake 8255C", "member": "string", "name": "CpuType", "output_required": true, @@ -7670,7 +7582,7 @@ { "disabled": false, "document": "实例的GPU数量。", - "example": "无", + "example": "1", "member": "int64", "name": "Gpu", "output_required": true, @@ -7680,7 +7592,7 @@ { "disabled": false, "document": "实例的FPGA数量。", - "example": "无", + "example": "1", "member": "int64", "name": "Fpga", "output_required": true, @@ -7690,7 +7602,7 @@ { "disabled": false, "document": "实例备注信息。", - "example": "无", + "example": "搭载1 块 11176 GB SATA HDD 本地硬盘", "member": "string", "name": "Remark", "output_required": true, @@ -7700,7 +7612,7 @@ { "disabled": false, "document": "实例机型映射的物理GPU卡数,单位:卡。vGPU卡型小于1,直通卡型大于等于1。vGPU是通过分片虚拟化技术,将物理GPU卡重新划分,同一块GPU卡经虚拟化分割后可分配至不同的实例使用。直通卡型会将GPU设备直接挂载给实例使用。", - "example": "无", + "example": "1.0", "member": "float", "name": "GpuCount", "output_required": true, @@ -7710,7 +7622,7 @@ { "disabled": false, "document": "实例的CPU主频信息", - "example": "无", + "example": "-/3.1GHz", "member": "string", "name": "Frequency", "output_required": true, @@ -7720,7 +7632,7 @@ { "disabled": false, "document": "描述库存情况。取值范围:\n<li> EnoughStock:表示对应库存非常充足</li> \n<li>NormalStock:表示对应库存供应有保障</li>\n<li> UnderStock:表示对应库存即将售罄</li> \n<li>WithoutStock:表示对应库存已经售罄</li>\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "EnoughStock", "member": "string", "name": "StatusCategory", "output_required": true, @@ -7736,7 +7648,7 @@ { "disabled": false, "document": "网络计费类型。取值范围:<br><li>BANDWIDTH_PREPAID:预付费按带宽结算</li><li>TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费</li><li>BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费</li><li>BANDWIDTH_PACKAGE:带宽包用户</li>默认取值:非带宽包用户默认与子机付费类型保持一致,比如子机付费类型为预付费,网络计费类型默认为预付费;子机付费类型为后付费,网络计费类型默认为后付费。", - "example": "无", + "example": "BANDWIDTH_PREPAID", "member": "string", "name": "InternetChargeType", "output_required": true, @@ -7747,7 +7659,7 @@ { "disabled": false, "document": "公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/12523)。", - "example": "无", + "example": "10", "member": "int64", "name": "InternetMaxBandwidthOut", "output_required": true, @@ -7769,7 +7681,7 @@ { "disabled": false, "document": "带宽包ID。可通过[`DescribeBandwidthPackages`](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。该参数仅在RunInstances接口中作为入参使用。", - "example": "无", + "example": "bwp-h1ro", "member": "string", "name": "BandwidthPackageId", "output_required": false, @@ -7786,30 +7698,30 @@ { "disabled": false, "document": "开始时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。", - "example": "", + "example": "2023-10-05T14:30:00Z", "member": "datetime_iso", "name": "StartTime", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "结束时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。", - "example": "", + "example": "2023-11-05T14:30:00Z", "member": "datetime_iso", "name": "EndTime", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "实例带宽信息。", - "example": "", + "example": "无", "member": "InternetAccessible", "name": "InternetAccessible", - "required": false, + "output_required": true, "type": "object", "value_allowed_null": false } @@ -7821,21 +7733,25 @@ "members": [ { "disabled": false, - "document": "网络计费模式。", - "example": "", + "document": "网络计费模式。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "TRAFFIC_POSTPAID_BY_HOUR", "member": "string", "name": "InternetChargeType", + "output_required": true, "required": false, - "type": "string" + "type": "string", + "value_allowed_null": true }, { "disabled": false, - "document": "网络计费模式描述信息。", - "example": "", + "document": "网络计费模式描述信息。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "postpaid monthly", "member": "string", "name": "Description", + "output_required": true, "required": false, - "type": "string" + "type": "string", + "value_allowed_null": true } ], "usage": "both" @@ -8072,7 +7988,7 @@ { "disabled": false, "document": "密钥对描述信息。", - "example": "test", + "example": "mySkey", "member": "string", "name": "Description", "output_required": false, @@ -8082,7 +7998,7 @@ { "disabled": false, "document": "密钥对的纯文本公钥。", - "example": "xxx", + "example": "q29u65hu", "member": "string", "name": "PublicKey", "output_required": false, @@ -8092,7 +8008,7 @@ { "disabled": false, "document": "密钥对的纯文本私钥。腾讯云不会保管私钥,请用户自行妥善保存。", - "example": "xxx", + "example": "q29u65hu", "member": "string", "name": "PrivateKey", "output_required": false, @@ -8102,7 +8018,7 @@ { "disabled": false, "document": "密钥关联的实例`ID`列表。", - "example": "[]", + "example": "无", "member": "string", "name": "AssociatedInstanceIds", "output_required": false, @@ -8122,7 +8038,7 @@ { "disabled": false, "document": "密钥关联的标签列表。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "无", "member": "Tag", "name": "Tags", "output_required": false, @@ -8214,7 +8130,7 @@ { "disabled": false, "document": "创建该模板的用户UIN。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "123456", + "example": "1230000", "member": "string", "name": "CreatedBy", "output_required": true, @@ -8562,50 +8478,50 @@ { "disabled": false, "document": "本地磁盘类型。", - "example": "", + "example": "LOCAL_BASIC", "member": "string", "name": "Type", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "本地磁盘属性。", - "example": "", + "example": "ROOT", "member": "string", "name": "PartitionType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "本地磁盘最小值。", - "example": "", + "example": "10", "member": "int64", "name": "MinSize", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "本地磁盘最大值。", - "example": "", + "example": "20", "member": "int64", "name": "MaxSize", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "购买时本地盘是否为必选。取值范围:<br><li>REQUIRED:表示必选<br><li>OPTIONAL:表示可选。", - "example": "", + "document": "购买时本地盘是否为必选。取值范围:<br><li>REQUIRED:表示必选</li><li>OPTIONAL:表示可选。</li>", + "example": "REQUIRED", "member": "string", "name": "Required", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -8640,7 +8556,7 @@ { "disabled": false, "document": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。取值范围:<li>true:表示保持镜像的登录设置</li><li>false:表示不保持镜像的登录设置</li>默认取值:false。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "abc", + "example": "true", "member": "string", "name": "KeepImageLogin", "output_required": false, @@ -9376,41 +9292,41 @@ "members": [ { "disabled": false, - "document": "实例操作。取值范围:<br><li>`INSTANCE_DEGRADE`:降配操作<br><li>`INTERNET_CHARGE_TYPE_CHANGE`:修改网络带宽计费模式", - "example": "", + "document": "实例操作。取值范围:<br><li>`INSTANCE_DEGRADE`:降配操作</li><li>`INTERNET_CHARGE_TYPE_CHANGE`:修改网络带宽计费模式</li>", + "example": "INSTANCE_DEGRADE", "member": "string", "name": "Operation", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "实例ID。", - "example": "", + "example": "ins-xxxxx", "member": "string", "name": "InstanceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "当前已使用次数,如果返回值为-1表示该操作无次数限制。", - "example": "", + "example": "1", "member": "int64", "name": "CurrentCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "操作次数最高额度,如果返回值为-1表示该操作无次数限制,如果返回值为0表示不支持调整配置。", - "example": "", + "example": "5", "member": "int64", "name": "LimitCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -9423,30 +9339,30 @@ { "disabled": false, "document": "操作系统类型", - "example": "", + "example": "CentOS", "member": "string", "name": "OsName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "支持的操作系统版本", - "example": "", + "example": "[\"9\"]", "member": "string", "name": "OsVersions", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "支持的操作系统架构", - "example": "", + "example": "x86_64", "member": "string", "name": "Architecture", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -9685,69 +9601,42 @@ ], "type": "object" }, - "PurchaseReservedInstancesOfferingRequest": { - "document": "PurchaseReservedInstancesOffering请求参数结构体", + "RebootInstancesRequest": { + "document": "RebootInstances请求参数结构体", "members": [ { "disabled": false, - "document": "购买预留实例计费数量", - "example": "1", - "member": "int64", - "name": "InstanceCount", - "required": true, - "type": "int" - }, - { - "disabled": false, - "document": "预留实例计费配置ID", - "example": "无", + "document": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", + "example": "[\"ins-r8hr2upy\",\"ins-5d8a23rs\"]", "member": "string", - "name": "ReservedInstancesOfferingId", + "name": "InstanceIds", "required": true, - "type": "string" + "type": "list" }, { "disabled": false, - "document": "试运行", - "example": "无", + "document": "本参数已弃用,推荐使用StopType,不可以与参数StopType同时使用。表示是否在正常重启失败后选择强制重启实例。取值范围:<br><li>true:表示在正常重启失败后进行强制重启<br><li>false:表示在正常重启失败后不进行强制重启<br><br>默认取值:false。", + "example": "false", "member": "bool", - "name": "DryRun", + "name": "ForceReboot", "required": false, "type": "bool" }, { "disabled": false, - "document": "用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。<br>更多详细信息请参阅:如何保证幂等性", - "example": "无", - "member": "string", - "name": "ClientToken", - "required": false, - "type": "string" - }, - { - "disabled": false, - "document": "预留实例显示名称。<br><li>不指定实例显示名称则默认显示‘未命名’。</li><li>最多支持60个字符(包含模式串)。</li>", - "example": "test", + "document": "关机类型。取值范围:<br><li>SOFT:表示软关机<br><li>HARD:表示硬关机<br><li>SOFT_FIRST:表示优先软关机,失败再执行硬关机<br><br>默认取值:SOFT。", + "example": "SOFT", "member": "string", - "name": "ReservedInstanceName", + "name": "StopType", "required": false, "type": "string" } ], "type": "object" }, - "PurchaseReservedInstancesOfferingResponse": { - "document": "PurchaseReservedInstancesOffering返回参数结构体", + "RebootInstancesResponse": { + "document": "RebootInstances返回参数结构体", "members": [ - { - "disabled": false, - "document": "已购买预留实例计费ID", - "example": "ri-rxfkvm5i", - "member": "string", - "name": "ReservedInstanceId", - "type": "string", - "value_allowed_null": false - }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", "member": "string", @@ -9757,80 +9646,38 @@ ], "type": "object" }, - "RebootInstancesRequest": { - "document": "RebootInstances请求参数结构体", + "RegionInfo": { + "document": "地域信息", "members": [ { "disabled": false, - "document": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", - "example": "[\"ins-r8hr2upy\",\"ins-5d8a23rs\"]", + "document": "地域名称,例如,ap-guangzhou\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "ap-guangzhou", "member": "string", - "name": "InstanceIds", - "required": true, - "type": "list" + "name": "Region", + "output_required": true, + "type": "string", + "value_allowed_null": true }, { "disabled": false, - "document": "本参数已弃用,推荐使用StopType,不可以与参数StopType同时使用。表示是否在正常重启失败后选择强制重启实例。取值范围:<br><li>true:表示在正常重启失败后进行强制重启<br><li>false:表示在正常重启失败后不进行强制重启<br><br>默认取值:false。", - "example": "false", - "member": "bool", - "name": "ForceReboot", - "required": false, - "type": "bool" - }, - { - "disabled": false, - "document": "关机类型。取值范围:<br><li>SOFT:表示软关机<br><li>HARD:表示硬关机<br><li>SOFT_FIRST:表示优先软关机,失败再执行硬关机<br><br>默认取值:SOFT。", - "example": "SOFT", - "member": "string", - "name": "StopType", - "required": false, - "type": "string" - } - ], - "type": "object" - }, - "RebootInstancesResponse": { - "document": "RebootInstances返回参数结构体", - "members": [ - { - "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", - "member": "string", - "name": "RequestId", - "type": "string" - } - ], - "type": "object" - }, - "RegionInfo": { - "document": "地域信息", - "members": [ - { - "disabled": false, - "document": "地域名称,例如,ap-guangzhou", - "example": "", - "member": "string", - "name": "Region", - "required": true, - "type": "string" - }, - { - "disabled": false, - "document": "地域描述,例如,华南地区(广州)", - "example": "", + "document": "地域描述,例如,华南地区(广州)\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "华南地区(广州)", "member": "string", "name": "RegionName", - "required": true, - "type": "string" + "output_required": true, + "type": "string", + "value_allowed_null": true }, { "disabled": false, - "document": "地域是否可用状态", - "example": "", + "document": "地域是否可用状态\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "AVAILABLE", "member": "string", "name": "RegionState", - "required": true, - "type": "string" + "output_required": true, + "type": "string", + "value_allowed_null": true } ], "usage": "out" @@ -9948,7 +9795,7 @@ }, { "disabled": false, - "document": "是否续费弹性数据盘。取值范围:<br><li>true:表示续费包年包月实例同时续费其挂载的弹性数据盘<br><li>false:表示续费包年包月实例同时不再续费其挂载的弹性数据盘<br><br>默认取值:true。", + "document": "是否续费弹性数据盘。取值范围:<br><li>true:表示续费包年包月实例同时续费其挂载的弹性数据盘</li><li>false:表示续费包年包月实例同时不再续费其挂载的弹性数据盘</li><br>默认取值:true。", "example": "false", "member": "bool", "name": "RenewPortableDataDisk", @@ -10036,895 +9883,263 @@ { "disabled": false, "document": "已完成授权的维修任务ID。", - "example": "rep-xxxxxxxx", - "member": "string", - "name": "TaskId", - "output_required": true, - "type": "string", - "value_allowed_null": false - }, - { - "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", - "member": "string", - "name": "RequestId", - "type": "string" - } - ], - "type": "object" - }, - "RepairTaskInfo": { - "document": "描述维修任务的相关信息", - "members": [ - { - "disabled": false, - "document": "维修任务ID", - "example": "rep-xxxxxxxx", - "member": "string", - "name": "TaskId", - "output_required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "实例ID", - "example": "ins-xxxxxxxx", - "member": "string", - "name": "InstanceId", - "output_required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "实例名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "test", - "member": "string", - "name": "Alias", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "任务类型ID,与任务类型中文名的对应关系如下:\n\n- `101`:实例运行隐患\n- `102`:实例运行异常\n- `103`:实例硬盘异常\n- `104`:实例网络连接异常\n- `105`:实例运行预警\n- `106`:实例硬盘预警\n- `107`:实例维护升级\n\n各任务类型的具体含义,可参考 [维修任务分类](https://cloud.tencent.com/document/product/213/67789#.E7.BB.B4.E4.BF.AE.E4.BB.BB.E5.8A.A1.E5.88.86.E7.B1.BB)。", - "example": "101", - "member": "uint64", - "name": "TaskTypeId", - "output_required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "任务类型中文名", - "example": "实例运行隐患", - "member": "string", - "name": "TaskTypeName", - "output_required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "任务状态ID,与任务状态中文名的对应关系如下:\n\n- `1`:待授权\n- `2`:处理中\n- `3`:已结束\n- `4`:已预约\n- `5`:已取消\n- `6`:已避免\n\n各任务状态的具体含义,可参考 [任务状态](https://cloud.tencent.com/document/product/213/67789#.E4.BB.BB.E5.8A.A1.E7.8A.B6.E6.80.81)。", - "example": "1", - "member": "uint64", - "name": "TaskStatus", - "output_required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "设备状态ID,与设备状态中文名的对应关系如下:\n\n- `1`:故障中\n- `2`:处理中\n- `3`:正常\n- `4`:已预约\n- `5`:已取消\n- `6`:已避免", - "example": "1", - "member": "uint64", - "name": "DeviceStatus", - "output_required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "操作状态ID,与操作状态中文名的对应关系如下:\n\n- `1`:未授权\n- `2`:已授权\n- `3`:已处理\n- `4`:已预约\n- `5`:已取消\n- `6`:已避免", - "example": "1", - "member": "uint64", - "name": "OperateStatus", - "output_required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "任务创建时间", - "example": "2017-01-01 12:00:00", - "member": "datetime", - "name": "CreateTime", - "output_required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "任务授权时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "2017-01-03 12:00:00", - "member": "datetime", - "name": "AuthTime", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "任务结束时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "2017-01-03 14:00:00", - "member": "datetime", - "name": "EndTime", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "任务详情\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "监控到您的云服务器存在隐患,可能导致云服务器高负载或宕机。为尽快修复隐患,需要您授权我们在线迁移。感谢您的支持与理解。", - "member": "string", - "name": "TaskDetail", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "ap-guangzhou-7", - "member": "string", - "name": "Zone", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "地域\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "ap-guangzhou", - "member": "string", - "name": "Region", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "所在私有网络ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "vpc-xxxxxxxx", - "member": "string", - "name": "VpcId", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "所在私有网络名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "Default-VPC", - "member": "string", - "name": "VpcName", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "所在子网ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "subnet-xxxxxxxx", - "member": "string", - "name": "SubnetId", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "所在子网名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "Default-Subnet", - "member": "string", - "name": "SubnetName", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "实例公网IP\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "11.22.33.44", - "member": "string", - "name": "WanIp", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "实例内网IP\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "10.10.1.9", - "member": "string", - "name": "LanIp", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "产品类型,支持取值:\n\n- `CVM`:云服务器\n- `CDH`:专用宿主机\n- `CPM2.0`:裸金属云服务器\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "CVM", - "member": "string", - "name": "Product", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "任务子类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "NA", - "member": "string", - "name": "TaskSubType", - "output_required": true, - "type": "string", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "任务授权类型", - "example": "1", - "member": "uint64", - "name": "AuthType", - "output_required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "授权渠道,支持取值:\n\n- `Waiting_auth`:待授权\n- `Customer_auth`:客户操作授权\n- `System_mandatory_auth`:系统默认授权\n- `Pre_policy_auth`:预置策略授权", - "example": "Customer_auth", - "member": "string", - "name": "AuthSource", - "output_required": true, - "type": "string", - "value_allowed_null": false - } - ], - "usage": "out" - }, - "ReservedInstanceConfigInfoItem": { - "document": "预留实例静态配置信息。预留实例当前只针对国际站白名单用户开放。", - "members": [ - { - "disabled": false, - "document": "实例规格。", - "example": "", - "member": "string", - "name": "Type", - "required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "实例规格名称。", - "example": "", - "member": "string", - "name": "TypeName", - "required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "优先级。", - "example": "", - "member": "int64", - "name": "Order", - "required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "实例族信息列表。", - "example": "", - "member": "ReservedInstanceFamilyItem", - "name": "InstanceFamilies", - "required": true, - "type": "list", - "value_allowed_null": false - } - ], - "usage": "out" - }, - "ReservedInstanceFamilyItem": { - "document": "预留实例相关实例族信息。预留实例当前只针对国际站白名单用户开放。", - "members": [ - { - "disabled": false, - "document": "实例族。", - "example": "", - "member": "string", - "name": "InstanceFamily", - "required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "优先级。", - "example": "", - "member": "int64", - "name": "Order", - "required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "实例类型信息列表。", - "example": "", - "member": "ReservedInstanceTypeItem", - "name": "InstanceTypes", - "required": true, - "type": "list", - "value_allowed_null": false - } - ], - "usage": "out" - }, - "ReservedInstancePrice": { - "document": "预留实例相关价格信息。预留实例当前只针对国际站白名单用户开放。", - "members": [ - { - "disabled": false, - "document": "预支合计费用的原价,单位:元。", - "example": "无", - "member": "float", - "name": "OriginalFixedPrice", - "output_required": true, - "type": "float", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "预支合计费用的折扣价,单位:元。", - "example": "无", - "member": "float", - "name": "DiscountFixedPrice", - "output_required": true, - "type": "float", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "后续合计费用的原价,单位:元/小时", - "example": "无", - "member": "float", - "name": "OriginalUsagePrice", - "output_required": true, - "type": "float", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "后续合计费用的折扣价,单位:元/小时", - "example": "无", - "member": "float", - "name": "DiscountUsagePrice", - "output_required": true, - "type": "float", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "预支费用的折扣,如20.0代表2折。 注意:此字段可能返回 null,表示取不到有效值。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", - "member": "float", - "name": "FixedPriceDiscount", - "output_required": false, - "type": "float", - "value_allowed_null": true - }, - { - "disabled": false, - "document": "后续费用的折扣,如20.0代表2折。 注意:此字段可能返回 null,表示取不到有效值。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", - "member": "float", - "name": "UsagePriceDiscount", - "output_required": false, - "type": "float", - "value_allowed_null": true - } - ], - "usage": "out" - }, - "ReservedInstancePriceItem": { - "document": "基于付费类型的预留实例相关价格信息。预留实例当前只针对国际站白名单用户开放。", - "members": [ - { - "disabled": false, - "document": "付费类型,如:\"All Upfront\",\"Partial Upfront\",\"No Upfront\"", - "example": "All Upfront", - "member": "string", - "name": "OfferingType", - "output_required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "预支合计费用,单位:元。", - "example": "100.00", - "member": "float", - "name": "FixedPrice", - "output_required": true, - "type": "float", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "后续合计费用,单位:元/小时", - "example": "0.09", - "member": "float", - "name": "UsagePrice", - "output_required": true, - "type": "float", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "预留实例配置ID", - "example": "无", - "member": "string", - "name": "ReservedInstancesOfferingId", - "output_required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "预留实例计费可购买的可用区。", - "example": "ap-guangzhou-6", - "member": "string", - "name": "Zone", - "output_required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "预留实例计费【有效期】即预留实例计费购买时长。形如:31536000。\n计量单位:秒", - "example": "31536000", - "member": "uint64", - "name": "Duration", - "output_required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "预留实例计费的平台描述(即操作系统)。形如:Linux。\n返回项: Linux 。", - "example": "Linux", - "member": "string", - "name": "ProductDescription", - "output_required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "预支合计费用,单位:元。", - "example": "无", - "member": "float", - "name": "DiscountUsagePrice", - "output_required": false, - "type": "float", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "后续合计费用的折扣价,单位:元/小时", - "example": "无", - "member": "float", - "name": "DiscountFixedPrice", - "output_required": false, - "type": "float", - "value_allowed_null": false - } - ], - "usage": "out" - }, - "ReservedInstanceTypeItem": { - "document": "预留实例类型信息。预留实例当前只针对国际站白名单用户开放。", - "members": [ - { - "disabled": false, - "document": "实例类型。", - "example": "", - "member": "string", - "name": "InstanceType", - "required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "CPU核数。", - "example": "", - "member": "uint64", - "name": "Cpu", - "required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "内存大小。", - "example": "", - "member": "uint64", - "name": "Memory", - "required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "GPU数量。", - "example": "", - "member": "uint64", - "name": "Gpu", - "required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "FPGA数量。", - "example": "", - "member": "uint64", - "name": "Fpga", - "required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "本地存储块数量。", - "example": "", - "member": "uint64", - "name": "StorageBlock", - "required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "网卡数。", - "example": "", - "member": "uint64", - "name": "NetworkCard", - "required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "最大带宽。", - "example": "", - "member": "float", - "name": "MaxBandwidth", - "required": true, - "type": "float", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "主频。", - "example": "", - "member": "string", - "name": "Frequency", - "required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "CPU型号名称。", - "example": "", - "member": "string", - "name": "CpuModelName", - "required": true, - "type": "string", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "包转发率。", - "example": "", - "member": "uint64", - "name": "Pps", - "required": true, - "type": "int", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "外部信息。", - "example": "", - "member": "Externals", - "name": "Externals", - "required": true, - "type": "object", - "value_allowed_null": false - }, - { - "disabled": false, - "document": "备注信息。", - "example": "", + "example": "rep-xxxxxxxx", "member": "string", - "name": "Remark", - "required": true, + "name": "TaskId", + "output_required": true, "type": "string", "value_allowed_null": false }, { - "disabled": false, - "document": "预留实例配置价格信息。", - "example": "", - "member": "ReservedInstancePriceItem", - "name": "Prices", - "required": true, - "type": "list", - "value_allowed_null": false + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" } ], - "usage": "out" + "type": "object" }, - "ReservedInstances": { - "document": "描述用户已购买预留实例计费信息", + "RepairTaskInfo": { + "document": "描述维修任务的相关信息", "members": [ { "disabled": false, - "document": "(此字段已废弃,建议使用字段:ReservedInstanceId)已购买的预留实例计费ID。形如:ri-rtbh4han。", - "example": "ri-rtbh4han", + "document": "维修任务ID", + "example": "rep-xxxxxxxx", "member": "string", - "name": "ReservedInstancesId", - "required": true, + "name": "TaskId", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, - "document": "预留实例计费的规格。形如:S3.MEDIUM4。\n返回项:<a href=\"https://cloud.tencent.com/document/product/213/11518\">预留实例计费规格列表</a>", - "example": "S3.MEDIUM4", + "document": "实例ID", + "example": "ins-xxxxxxxx", "member": "string", - "name": "InstanceType", - "required": true, + "name": "InstanceId", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, - "document": "预留实例计费可购买的可用区。形如:ap-guangzhou-1。\n返回项:<a href=\"https://cloud.tencent.com/document/product/213/6091\">可用区列表</a>", - "example": "ap-guangzhou-1", + "document": "实例名称\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "myTask", "member": "string", - "name": "Zone", - "required": true, + "name": "Alias", + "output_required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "预留实例计费开始时间。形如:1949-10-01 00:00:00", - "example": "2020-10-01 00:00:00", - "member": "datetime", - "name": "StartTime", - "required": true, - "type": "string", + "document": "任务类型ID,与任务类型中文名的对应关系如下:\n\n- `101`:实例运行隐患\n- `102`:实例运行异常\n- `103`:实例硬盘异常\n- `104`:实例网络连接异常\n- `105`:实例运行预警\n- `106`:实例硬盘预警\n- `107`:实例维护升级\n\n各任务类型的具体含义,可参考 [维修任务分类](https://cloud.tencent.com/document/product/213/67789#.E7.BB.B4.E4.BF.AE.E4.BB.BB.E5.8A.A1.E5.88.86.E7.B1.BB)。", + "example": "101", + "member": "uint64", + "name": "TaskTypeId", + "output_required": true, + "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "预留实例计费到期时间。形如:1949-10-01 00:00:00", - "example": "2021-10-01 00:00:00", - "member": "datetime", - "name": "EndTime", - "required": true, + "document": "任务类型中文名", + "example": "实例运行隐患", + "member": "string", + "name": "TaskTypeName", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, - "document": "预留实例计费【有效期】即预留实例计费购买时长。形如:31536000。\n计量单位:秒。", - "example": "31536000", - "member": "int64", - "name": "Duration", - "required": true, + "document": "任务状态ID,与任务状态中文名的对应关系如下:\n\n- `1`:待授权\n- `2`:处理中\n- `3`:已结束\n- `4`:已预约\n- `5`:已取消\n- `6`:已避免\n\n各任务状态的具体含义,可参考 [任务状态](https://cloud.tencent.com/document/product/213/67789#.E4.BB.BB.E5.8A.A1.E7.8A.B6.E6.80.81)。", + "example": "1", + "member": "uint64", + "name": "TaskStatus", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "已购买的预留实例计费个数。形如:10。", - "example": "10", - "member": "int64", - "name": "InstanceCount", - "required": true, + "document": "设备状态ID,与设备状态中文名的对应关系如下:\n\n- `1`:故障中\n- `2`:处理中\n- `3`:正常\n- `4`:已预约\n- `5`:已取消\n- `6`:已避免", + "example": "1", + "member": "uint64", + "name": "DeviceStatus", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "描述预留实例计费的平台描述(即操作系统)。形如:linux。\n返回项: linux 。", - "example": "linux", - "member": "string", - "name": "ProductDescription", - "required": true, - "type": "string", + "document": "操作状态ID,与操作状态中文名的对应关系如下:\n\n- `1`:未授权\n- `2`:已授权\n- `3`:已处理\n- `4`:已预约\n- `5`:已取消\n- `6`:已避免", + "example": "1", + "member": "uint64", + "name": "OperateStatus", + "output_required": true, + "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "预留实例计费购买的状态。形如:active\n返回项: active (以创建) | pending (等待被创建) | retired (过期)。", - "example": "active", - "member": "string", - "name": "State", - "required": true, + "document": "任务创建时间", + "example": "2017-01-01 12:00:00", + "member": "datetime", + "name": "CreateTime", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, - "document": "可购买的预留实例计费类型的结算货币,使用ISO 4217标准货币代码。形如:USD。\n返回项:USD(美元)。", - "example": "USD", - "member": "string", - "name": "CurrencyCode", - "required": true, + "document": "任务授权时间\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "2017-01-03 12:00:00", + "member": "datetime", + "name": "AuthTime", + "output_required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "预留实例计费的付款类型。形如:All Upfront。\n返回项: All Upfront (预付全部费用)。", - "example": "All Upfront", - "member": "string", - "name": "OfferingType", - "required": true, + "document": "任务结束时间\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "2017-01-03 14:00:00", + "member": "datetime", + "name": "EndTime", + "output_required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "预留实例计费的类型。形如:S3。\n返回项:<a href=\"https://cloud.tencent.com/document/product/213/11518\">预留实例计费类型列表</a>", - "example": "S3", + "document": "任务详情\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "监控到您的云服务器存在隐患,可能导致云服务器高负载或宕机。为尽快修复隐患,需要您授权我们在线迁移。感谢您的支持与理解。", "member": "string", - "name": "InstanceFamily", - "required": true, + "name": "TaskDetail", + "output_required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "已购买的预留实例计费ID。形如:ri-rtbh4han。", - "example": "ri-rtbh4han", + "document": "可用区\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "ap-guangzhou-7", "member": "string", - "name": "ReservedInstanceId", - "required": true, + "name": "Zone", + "output_required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "预留实例显示名称。形如:riname-01", - "example": "riname-01", + "document": "地域\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "ap-guangzhou", "member": "string", - "name": "ReservedInstanceName", - "required": true, + "name": "Region", + "output_required": true, "type": "string", - "value_allowed_null": false - } - ], - "usage": "out" - }, - "ReservedInstancesOffering": { - "document": "描述可购买预留实例计费信息", - "members": [ + "value_allowed_null": true + }, { "disabled": false, - "document": "预留实例计费可购买的可用区。形如:ap-guangzhou-1。\n返回项:<a href=\"https://cloud.tencent.com/document/product/213/6091\">可用区列表</a>", - "example": "", + "document": "所在私有网络ID\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "vpc-xxxxxxxx", "member": "string", - "name": "Zone", - "required": true, + "name": "VpcId", + "output_required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "可购买的预留实例计费类型的结算货币,使用ISO 4217标准货币代码。\n返回项:USD(美元)。", - "example": "", + "document": "所在私有网络名称\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "Default-VPC", "member": "string", - "name": "CurrencyCode", - "required": true, + "name": "VpcName", + "output_required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "预留实例计费【有效期】即预留实例计费购买时长。形如:31536000。\n计量单位:秒", - "example": "", - "member": "int64", - "name": "Duration", - "required": true, - "type": "int", - "value_allowed_null": false + "document": "所在子网ID\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "subnet-xxxxxxxx", + "member": "string", + "name": "SubnetId", + "output_required": true, + "type": "string", + "value_allowed_null": true }, { "disabled": false, - "document": "预留实例计费的购买价格。形如:4000.0。\n计量单位:与 currencyCode 一致,目前支持 USD(美元)", - "example": "", - "member": "float", - "name": "FixedPrice", - "required": true, - "type": "float", - "value_allowed_null": false + "document": "所在子网名称\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "Default-Subnet", + "member": "string", + "name": "SubnetName", + "output_required": true, + "type": "string", + "value_allowed_null": true }, { "disabled": false, - "document": "预留实例计费的实例类型。形如:S3.MEDIUM4。\n返回项:<a href=\"https://cloud.tencent.com/product/cvm/instances\">预留实例计费类型列表</a>", - "example": "", + "document": "实例公网IP\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "11.22.33.44", "member": "string", - "name": "InstanceType", - "required": true, + "name": "WanIp", + "output_required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "预留实例计费的付款类型。形如:All Upfront。\n返回项: All Upfront (预付全部费用)。", - "example": "", + "document": "实例内网IP\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "10.10.1.9", "member": "string", - "name": "OfferingType", - "required": true, + "name": "LanIp", + "output_required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "可购买的预留实例计费配置ID。形如:650c138f-ae7e-4750-952a-96841d6e9fc1。", - "example": "", + "document": "产品类型,支持取值:\n\n- `CVM`:云服务器\n- `CDH`:专用宿主机\n- `CPM2.0`:裸金属云服务器\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "CVM", "member": "string", - "name": "ReservedInstancesOfferingId", - "required": true, + "name": "Product", + "output_required": true, "type": "string", - "value_allowed_null": false + "value_allowed_null": true }, { "disabled": false, - "document": "预留实例计费的平台描述(即操作系统)。形如:linux。\n返回项: linux 。", - "example": "", + "document": "任务子类型\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "unconfirmed", "member": "string", - "name": "ProductDescription", - "required": true, + "name": "TaskSubType", + "output_required": true, "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "任务授权类型", + "example": "1", + "member": "uint64", + "name": "AuthType", + "output_required": true, + "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "扣除预付费之后的使用价格 (按小时计费)。形如:0.0。\n目前,因为只支持 All Upfront 付款类型,所以默认为 0元/小时。\n计量单位:元/小时,货币单位与 currencyCode 一致,目前支持 USD(美元)", - "example": "", - "member": "float", - "name": "UsagePrice", - "required": true, - "type": "float", + "document": "授权渠道,支持取值:\n\n- `Waiting_auth`:待授权\n- `Customer_auth`:客户操作授权\n- `System_mandatory_auth`:系统默认授权\n- `Pre_policy_auth`:预置策略授权", + "example": "Customer_auth", + "member": "string", + "name": "AuthSource", + "output_required": true, + "type": "string", "value_allowed_null": false } ], @@ -11142,7 +10357,7 @@ }, { "disabled": false, - "document": "是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机。取值范围:<br><li>true:表示在正常关机失败后进行强制关机<br><li>false:表示在正常关机失败后不进行强制关机<br><br>默认取值:false。<br><br>强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏,请仅在服务器不能正常关机时使用。", + "document": "是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机。取值范围:<br><li>true:表示在正常关机失败后进行强制关机</li><br><li>false:表示在正常关机失败后不进行强制关机</li><br><br>默认取值:false。<br><br>强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏,请仅在服务器不能正常关机时使用。", "example": "false", "member": "bool", "name": "ForceStop", @@ -11573,20 +10788,20 @@ { "disabled": false, "document": "镜像分享时间", - "example": "无", + "example": "2023-10-05T14:30:00Z", "member": "datetime_iso", "name": "CreatedTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "镜像分享的账户ID", - "example": "无", + "example": "2700036", "member": "string", "name": "AccountId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -11599,30 +10814,30 @@ { "disabled": false, "document": "快照Id。", - "example": "", + "example": "snap-2y1v", "member": "string", "name": "SnapshotId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "创建此快照的云硬盘类型。取值范围:\nSYSTEM_DISK:系统盘\nDATA_DISK:数据盘。", - "example": "", + "example": "SYSTEM_DISK", "member": "string", "name": "DiskUsage", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "创建此快照的云硬盘大小,单位GB。", - "example": "", + "example": "50", "member": "int64", "name": "DiskSize", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -11635,7 +10850,7 @@ { "disabled": false, "document": "竞价出价\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0.01", "member": "string", "name": "MaxPrice", "output_required": false, @@ -11646,7 +10861,7 @@ { "disabled": false, "document": "竞价请求类型,当前仅支持类型:one-time\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "one-time", "member": "string", "name": "SpotInstanceType", "output_required": false, @@ -11790,7 +11005,7 @@ { "disabled": false, "document": "HDD本地存储类型,值为:LOCAL_PRO.\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "LOCAL_PRO", "member": "string", "name": "Type", "output_required": true, @@ -11801,7 +11016,7 @@ { "disabled": false, "document": "HDD本地存储的最小容量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "100", "member": "int64", "name": "MinSize", "output_required": true, @@ -11812,7 +11027,7 @@ { "disabled": false, "document": "HDD本地存储的最大容量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "200", "member": "int64", "name": "MaxSize", "output_required": true, @@ -11946,7 +11161,7 @@ { "disabled": false, "document": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围:<br>\n<li>LOCAL_BASIC:本地硬盘</li>\n<li>LOCAL_SSD:本地SSD硬盘</li>\n<li>CLOUD_BASIC:普通云硬盘</li>\n<li>CLOUD_SSD:SSD云硬盘</li>\n<li>CLOUD_PREMIUM:高性能云硬盘</li>\n<li>CLOUD_BSSD:通用性SSD云硬盘</li>\n<li>CLOUD_HSSD:增强型SSD云硬盘</li>\n<li>CLOUD_TSSD:极速型SSD云硬盘</li><br>\n默认取值:当前有库存的硬盘类型。", - "example": "无", + "example": "CLOUD_HSSD", "member": "string", "name": "DiskType", "output_required": true, @@ -11957,7 +11172,7 @@ { "disabled": false, "document": "系统盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID。暂时不支持该参数。\n该参数目前仅用于`DescribeInstances`等查询类接口的返回参数,不可用于`RunInstances`等写接口的入参。", - "example": "无", + "example": "disk-xyzw1234", "member": "string", "name": "DiskId", "output_required": true, @@ -11968,7 +11183,7 @@ { "disabled": false, "document": "系统盘大小,单位:GB。默认值为 50", - "example": "无", + "example": "50", "member": "int64", "name": "DiskSize", "output_required": true, @@ -11979,7 +11194,7 @@ { "disabled": false, "document": "所属的独享集群ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cdc-xxxxxx", "member": "string", "name": "CdcId", "output_required": false, @@ -12007,9 +11222,10 @@ { "disabled": false, "document": "标签键", - "example": "无", + "example": "myKey", "member": "string", "name": "Key", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -12017,9 +11233,10 @@ { "disabled": false, "document": "标签值", - "example": "无", + "example": "myValue", "member": "string", "name": "Value", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false diff --git a/tccli/services/cvm/v20170312/examples.json b/tccli/services/cvm/v20170312/examples.json index d912e0c517..9981a75423 100644 --- a/tccli/services/cvm/v20170312/examples.json +++ b/tccli/services/cvm/v20170312/examples.json @@ -82,8 +82,8 @@ ], "CreateLaunchTemplate": [ { - "document": "只传必传的Zone、镜像ID和启动模板ID,其他均采用系统默认值,具体配置如下:实例所在位置为广州二区,镜像ID为:img-pmqg1cw7,实例启动模板名称:test", - "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLaunchTemplate\n<公共请求参数>\n\n{\n \"LaunchTemplateName\": \"test\",\n \"Placement\": {\n \"Zone\": \"ap-guangzhou-2\"\n },\n \"ImageId\": \"img-pmqg1cw7\"\n}", + "document": "只传必传的Zone、镜像ID和启动模板ID,其他均采用系统默认值,具体配置如下:实例所在位置为广州二区,镜像ID为:img-pmqg1cw7,实例启动模板名称:myTemplate", + "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLaunchTemplate\n<公共请求参数>\n\n{\n \"LaunchTemplateName\": \"myTemplate\",\n \"Placement\": {\n \"Zone\": \"ap-guangzhou-2\"\n },\n \"ImageId\": \"img-pmqg1cw7\"\n}", "output": "{\n \"Response\": {\n \"LaunchTemplateId\": \"lt-lobxe2yo\",\n \"RequestId\": \"9b4ad85f-1657-4445-111d-3c0a9fbec309\"\n }\n}", "title": "使用最简单参数创建实例启动模板" } @@ -178,7 +178,7 @@ { "document": "根据CHC物理服务器ID查看实例", "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeChcHosts\n<公共请求参数>\n\n{\n \"ChcIds\": [\n \"chc-1a2b3c4d\"\n ]\n}", - "output": "{\n \"Response\": {\n \"ChcHostSet\": [\n {\n \"ChcId\": \"chc-1a2b3c4d\",\n \"InstanceName\": \"托管服务器\",\n \"SerialNumber\": \"sn34asdfabd\",\n \"InstanceState\": \"RUNNING\",\n \"DeviceType\": \"CHC_HS1\",\n \"Placement\": {\n \"Zone\": \"ap-guangzhou-2\"\n },\n \"BmcVirtualPrivateCloud\": {\n \"SubnetId\": \"subnet-a2676p0e\",\n \"VpcId\": \"vpc-g7wzcv7n\"\n },\n \"BmcIp\": \"10.12.10.34\",\n \"BmcSecurityGroupIds\": [\n \"sg-1a2b3c4d\"\n ],\n \"DeployVirtualPrivateCloud\": {\n \"SubnetId\": \"subnet-a26734fs\",\n \"VpcId\": \"vpc-g7wz234f\"\n },\n \"DeployIp\": \"10.12.20.34\",\n \"DeploySecurityGroupIds\": [\n \"sg-1a2b34af\"\n ],\n \"CvmInstanceId\": \"ins-1a2bafst\",\n \"CreatedTime\": \"2020-03-10T02:43:51Z\",\n \"HardwareDescription\": \"50C 128G 12*4T\",\n \"Memory\": 128,\n \"DeployMAC\": \"52:54:00:68:CC:00\",\n \"BmcMAC\": \"52:54:00:68:CC:01\",\n \"Disk\": \"12*4T\",\n \"CPU\": 50\n }\n ],\n \"TotalCount\": 2,\n \"RequestId\": \"62DDFFC6-FDB5-44F7-20A6-59152E3D129A\"\n }\n}", + "output": "{\n \"Response\": {\n \"ChcHostSet\": [\n {\n \"BmcIp\": \"10.0.0.17\",\n \"BmcMAC\": \"52:54:00:71:B5:A1\",\n \"BmcSecurityGroupIds\": [\n \"sg-8l03md6z\"\n ],\n \"BmcVirtualPrivateCloud\": {\n \"SubnetId\": \"subnet-hmpeps7u\",\n \"VpcId\": \"vpc-b9y7wgix\",\n \"AsVpcGateway\": false,\n \"Ipv6AddressCount\": 0,\n \"PrivateIpAddresses\": [\n \"10.10.2.4\"\n ]\n },\n \"CPU\": 64,\n \"ChcId\": \"chc-1a2b3c4d\",\n \"ChcInstanceFamily\": \"CHCS5\",\n \"ChcInstanceFamilyName\": \"高性能计算型CHCS5\",\n \"ChcInstanceType\": \"CHCS5.128C384M\",\n \"CreatedTime\": \"2024-07-19 16:41:20\",\n \"CvmInstanceId\": \"\",\n \"DeployExtraConfig\": {\n \"BootFile\": \"pxelinux.0\",\n \"BootType\": \"x86_uefi\",\n \"MiniOsType\": \"public\",\n \"NextServerAddress\": \"169.254.68.10\"\n },\n \"DeployIp\": \"172.16.0.17\",\n \"DeployMAC\": \"52:54:00:41:8D:7B\",\n \"DeploySecurityGroupIds\": [\n \"sg-8l03md6z\"\n ],\n \"DeployVirtualPrivateCloud\": {\n \"SubnetId\": \"subnet-pad8nabc\",\n \"VpcId\": \"vpc-gbgzjb6r\",\n \"AsVpcGateway\": false,\n \"Ipv6AddressCount\": 0,\n \"PrivateIpAddresses\": [\n \"10.10.2.4\"\n ]\n },\n \"DeviceType\": \"CHCS5\",\n \"Disk\": \"480GB*2/3.84TB*12\",\n \"Gpu\": \"\",\n \"HardwareDescription\": \"64核 256GB 480GB*2/3.84TB*12\",\n \"InstanceName\": \"vlan502\",\n \"InstanceState\": \"PREPARED\",\n \"IsPredefinedType\": true,\n \"Memory\": 256,\n \"NetworkCard\": \"\",\n \"Placement\": {\n \"Zone\": \"ap-guangzhou-2\",\n \"ProjectId\": 0\n },\n \"ResaleAccountId\": \"\",\n \"ResaleAppId\": \"\",\n \"SaleStatus\": \"NOT_FOR_SALE\",\n \"SerialNumber\": \"7DF112345678\",\n \"Tags\": [\n {\n \"Key\": \"test\",\n \"Value\": \"test22\"\n }\n ],\n \"TenantType\": \"HOSTING\"\n }\n ],\n \"RequestId\": \"d2ab63c0-576f-44c4-b6c1-f519fb58654b\",\n \"TotalCount\": 1\n }\n}", "title": "查看CHC物理服务器实例" } ], @@ -218,7 +218,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeImageFromFamily\n<公共请求参数>\n\n{\n \"ImageFamily\": \"business-daily-update\"\n}", - "output": "{\n \"Response\": {\n \"Image\": {\n \"ImageId\": \"abc\",\n \"OsName\": \"abc\",\n \"ImageType\": \"abc\",\n \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n \"ImageName\": \"abc\",\n \"ImageDescription\": \"abc\",\n \"ImageSize\": 0,\n \"Architecture\": \"abc\",\n \"ImageState\": \"abc\",\n \"Platform\": \"abc\",\n \"ImageCreator\": \"abc\",\n \"ImageSource\": \"abc\",\n \"SyncPercent\": 0,\n \"IsSupportCloudinit\": true,\n \"SnapshotSet\": [\n {\n \"SnapshotId\": \"abc\",\n \"DiskUsage\": \"abc\",\n \"DiskSize\": 0\n }\n ],\n \"Tags\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"LicenseType\": \"abc\",\n \"ImageFamily\": \"business-daily-update\",\n \"ImageDeprecated\": false\n },\n \"RequestId\": \"5908394c-5b3f-42e0-a537-8410553890a5\"\n }\n}", + "output": "{\n \"Response\": {\n \"Image\": {\n \"ImageId\": \"img-xxx\",\n \"OsName\": \"Xserver\",\n \"ImageType\": \"PRIVATE_IMAGE\",\n \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n \"ImageName\": \"myImg\",\n \"ImageDescription\": \"\",\n \"ImageSize\": 0,\n \"Architecture\": \"x86_64\",\n \"ImageState\": \"NORMAL\",\n \"Platform\": \"Windows\",\n \"ImageCreator\": \"tencent\",\n \"ImageSource\": \"CREATE_IMAGE\",\n \"SyncPercent\": 0,\n \"IsSupportCloudinit\": true,\n \"SnapshotSet\": [\n {\n \"SnapshotId\": \"snap-nbxxx56\",\n \"DiskUsage\": \"SYSTEM_DISK\",\n \"DiskSize\": 0\n }\n ],\n \"Tags\": [\n {\n \"Key\": \"myKey\",\n \"Value\": \"myValue\"\n }\n ],\n \"LicenseType\": \"TencentCloud\",\n \"ImageFamily\": \"business-daily-update\",\n \"ImageDeprecated\": false\n },\n \"RequestId\": \"5908394c-5b3f-42e0-a537-8410553890a5\"\n }\n}", "title": "查看镜像族列表" } ], @@ -256,7 +256,7 @@ { "document": "查询导入镜像支持的操作系统配置信息", "input": "https://cvm.tencentcloudapi.com/?Action=DescribeImportImageOs\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"ImportImageOsListSupported\": {\n \"Linux\": [\n \"CentOS\",\n \"Ubuntu\",\n \"Debian\",\n \"OpenSUSE\",\n \"SUSE\",\n \"CoreOS\",\n \"FreeBSD\",\n \"Other Linux\"\n ],\n \"Windows\": [\n \"Windows Server 2008\",\n \"Windows Server 2012\",\n \"Windows Server 2016\"\n ]\n },\n \"ImportImageOsVersionSet\": [\n {\n \"OsName\": \"Windows Server 2008\",\n \"OsVersions\": [\n \"-\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Windows Server 2012\",\n \"OsVersions\": [\n \"-\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Windows Server 2016\",\n \"OsVersions\": [\n \"-\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"CentOS\",\n \"OsVersions\": [\n \"5\",\n \"6\",\n \"7\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"CoreOS\",\n \"OsVersions\": [\n \"7\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Debian\",\n \"OsVersions\": [\n \"6\",\n \"7\",\n \"8\",\n \"9\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"FreeBSD\",\n \"OsVersions\": [\n \"10\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Redhat\",\n \"OsVersions\": [\n \"5\",\n \"6\",\n \"7\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"OpenSUSE\",\n \"OsVersions\": [\n \"11\",\n \"12\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"SUSE\",\n \"OsVersions\": [\n \"10\",\n \"11\",\n \"12\",\n \"13\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Ubuntu\",\n \"OsVersions\": [\n \"10\",\n \"12\",\n \"14\",\n \"16\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Other Linux\",\n \"OsVersions\": [\n \"-\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n }\n ],\n \"RequestId\": \"32064a8f-8d3f-4670-8d4f-60123ca97042\"\n }\n}", + "output": "{\n \"Response\": {\n \"ImportImageOsListSupported\": {\n \"Linux\": [\n \"CentOS\",\n \"Ubuntu\",\n \"Debian\",\n \"OpenSUSE\",\n \"SUSE\",\n \"CoreOS\",\n \"FreeBSD\",\n \"Other Linux\"\n ],\n \"Windows\": [\n \"Windows Server 2008\",\n \"Windows Server 2012\",\n \"Windows Server 2016\"\n ]\n },\n \"ImportImageOsVersionSet\": [\n {\n \"OsName\": \"Windows Server 2008\",\n \"OsVersions\": [\n \"9\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Windows Server 2012\",\n \"OsVersions\": [\n \"9\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Windows Server 2016\",\n \"OsVersions\": [\n \"9\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"CentOS\",\n \"OsVersions\": [\n \"5\",\n \"6\",\n \"7\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"CoreOS\",\n \"OsVersions\": [\n \"7\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Debian\",\n \"OsVersions\": [\n \"6\",\n \"7\",\n \"8\",\n \"9\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"FreeBSD\",\n \"OsVersions\": [\n \"10\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Redhat\",\n \"OsVersions\": [\n \"5\",\n \"6\",\n \"7\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"OpenSUSE\",\n \"OsVersions\": [\n \"11\",\n \"12\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"SUSE\",\n \"OsVersions\": [\n \"10\",\n \"11\",\n \"12\",\n \"13\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Ubuntu\",\n \"OsVersions\": [\n \"10\",\n \"12\",\n \"14\",\n \"16\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n },\n {\n \"OsName\": \"Other Linux\",\n \"OsVersions\": [\n \"8\"\n ],\n \"Architecture\": [\n \"x86_64\",\n \"i386\"\n ]\n }\n ],\n \"RequestId\": \"32064a8f-8d3f-4670-8d4f-60123ca97042\"\n }\n}", "title": "查询导入镜像支持的操作系统配置信息" } ], @@ -296,7 +296,7 @@ { "document": "查看在广州一区或广州二区的实例信息,限制返回结果最多为一项", "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstances\n<公共请求参数>\n\n{\n \"Limit\": \"1\",\n \"Filters\": [\n {\n \"Values\": [\n \"ap-guangzhou-2\",\n \"ap-guangzhou-1\"\n ],\n \"Name\": \"zone\"\n }\n ],\n \"Offset\": \"0\"\n}", - "output": "{\n \"Response\": {\n \"InstanceSet\": [\n {\n \"RenewFlag\": \"NOTIFY_AND_MANUAL_RENEW\",\n \"Uuid\": \"e85f1388-0422-410d-8e50-bef540e78c18\",\n \"InstanceState\": \"RUNNING\",\n \"DisableApiTermination\": false,\n \"LatestOperationErrorMsg\": \"\",\n \"DefaultLoginPort\": 22,\n \"LicenseType\": \"TencentCloud\",\n \"DefaultLoginUser\": \"root\",\n \"LatestOperationState\": \"SUCCESS\",\n \"LoginSettings\": {\n \"Password\": \"123qwe!@#QWE\",\n \"KeyIds\": [\n \"skey-b4vakk62\"\n ]\n },\n \"IPv6Addresses\": [\n \"2001:0db8:86a3:08d3:1319:8a2e:0370:7344\"\n ],\n \"DedicatedClusterId\": \"\",\n \"RestrictState\": \"PROTECTIVELY_ISOLATED\",\n \"ExpiredTime\": \"2020-09-22T00:00:00+00:00\",\n \"DisasterRecoverGroupId\": \"\",\n \"Memory\": 1,\n \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n \"CPU\": 1,\n \"RdmaIpAddresses\": [],\n \"CamRoleName\": \"\",\n \"PublicIpAddresses\": [\n \"123.207.11.190\"\n ],\n \"Tags\": [\n {\n \"Value\": \"test\",\n \"Key\": \"test\"\n }\n ],\n \"InstanceId\": \"ins-xlsyru2j\",\n \"ImageId\": \"img-8toqc6s3\",\n \"StopChargingMode\": \"NOT_APPLICABLE\",\n \"InstanceChargeType\": \"POSTPAID_BY_HOUR\",\n \"InstanceType\": \"S2.SMALL2\",\n \"SystemDisk\": {\n \"DiskSize\": 50,\n \"CdcId\": \"cdc-xxxxxxxx\",\n \"DiskId\": \"disk-czsodtl1\",\n \"DiskType\": \"CLOUD_SSD\"\n },\n \"Placement\": {\n \"HostId\": \"host-h3m57oik\",\n \"ProjectId\": 1174660,\n \"HostIds\": [],\n \"Zone\": \"ap-guangzhou-1\"\n },\n \"PrivateIpAddresses\": [\n \"172.16.32.78\"\n ],\n \"OsName\": \"CentOS 7.4 64bit\",\n \"SecurityGroupIds\": [\n \"sg-p1ezv4wz\"\n ],\n \"InstanceName\": \"test\",\n \"DataDisks\": [\n {\n \"DeleteWithInstance\": true,\n \"Encrypt\": true,\n \"CdcId\": \"cdc-xxxxxxxx\",\n \"DiskType\": \"CLOUD_SSD\",\n \"ThroughputPerformance\": 0,\n \"KmsKeyId\": null,\n \"DiskSize\": 50,\n \"SnapshotId\": null,\n \"DiskId\": \"disk-bzsodtn1\"\n }\n ],\n \"IsolatedSource\": \"NOTISOLATED\",\n \"VirtualPrivateCloud\": {\n \"SubnetId\": \"subnet-mv4sn55k\",\n \"AsVpcGateway\": false,\n \"Ipv6AddressCount\": 1,\n \"VpcId\": \"vpc-m0cnatxj\",\n \"PrivateIpAddresses\": [\n \"172.16.3.59\"\n ]\n },\n \"LatestOperationRequestId\": \"c7de1287-061d-4ace-8caf-6ad8e5a2f29a\",\n \"InternetAccessible\": {\n \"PublicIpAssigned\": true,\n \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\",\n \"InternetMaxBandwidthOut\": 1\n },\n \"HpcClusterId\": \"\",\n \"LatestOperation\": \"ResetInstancesType\"\n }\n ],\n \"TotalCount\": 2,\n \"RequestId\": \"d655191e-a39d-43d2-8349-8c3f2bf4b327\"\n }\n}", + "output": "{\n \"Response\": {\n \"InstanceSet\": [\n {\n \"RenewFlag\": \"NOTIFY_AND_MANUAL_RENEW\",\n \"Uuid\": \"e85f1388-0422-410d-8e50-bef540e78c18\",\n \"InstanceState\": \"RUNNING\",\n \"DisableApiTermination\": false,\n \"LatestOperationErrorMsg\": \"\",\n \"DefaultLoginPort\": 22,\n \"LicenseType\": \"TencentCloud\",\n \"DefaultLoginUser\": \"root\",\n \"LatestOperationState\": \"SUCCESS\",\n \"LoginSettings\": {\n \"Password\": \"123qwe!@#QWE\",\n \"KeyIds\": [\n \"skey-b4vakk62\"\n ]\n },\n \"IPv6Addresses\": [\n \"2001:0db8:86a3:08d3:1319:8a2e:0370:7344\"\n ],\n \"DedicatedClusterId\": \"\",\n \"RestrictState\": \"PROTECTIVELY_ISOLATED\",\n \"ExpiredTime\": \"2020-09-22T00:00:00+00:00\",\n \"DisasterRecoverGroupId\": \"\",\n \"Memory\": 1,\n \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n \"CPU\": 1,\n \"RdmaIpAddresses\": [],\n \"CamRoleName\": \"\",\n \"PublicIpAddresses\": [\n \"123.207.11.190\"\n ],\n \"Tags\": [\n {\n \"Value\": \"myKey\",\n \"Key\": \"myValue\"\n }\n ],\n \"InstanceId\": \"ins-xlsyru2j\",\n \"ImageId\": \"img-8toqc6s3\",\n \"StopChargingMode\": \"NOT_APPLICABLE\",\n \"InstanceChargeType\": \"POSTPAID_BY_HOUR\",\n \"InstanceType\": \"S2.SMALL2\",\n \"SystemDisk\": {\n \"DiskSize\": 50,\n \"CdcId\": \"cdc-xxxxxxxx\",\n \"DiskId\": \"disk-czsodtl1\",\n \"DiskType\": \"CLOUD_SSD\"\n },\n \"Placement\": {\n \"HostId\": \"host-h3m57oik\",\n \"ProjectId\": 1174660,\n \"HostIds\": [],\n \"Zone\": \"ap-guangzhou-1\"\n },\n \"PrivateIpAddresses\": [\n \"172.16.32.78\"\n ],\n \"OsName\": \"CentOS 7.4 64bit\",\n \"SecurityGroupIds\": [\n \"sg-p1ezv4wz\"\n ],\n \"InstanceName\": \"myInstance\",\n \"DataDisks\": [\n {\n \"DeleteWithInstance\": true,\n \"Encrypt\": true,\n \"CdcId\": \"cdc-xxxxxxxx\",\n \"DiskType\": \"CLOUD_SSD\",\n \"ThroughputPerformance\": 0,\n \"KmsKeyId\": null,\n \"DiskSize\": 50,\n \"SnapshotId\": null,\n \"DiskId\": \"disk-bzsodtn1\"\n }\n ],\n \"IsolatedSource\": \"NOTISOLATED\",\n \"VirtualPrivateCloud\": {\n \"SubnetId\": \"subnet-mv4sn55k\",\n \"AsVpcGateway\": false,\n \"Ipv6AddressCount\": 1,\n \"VpcId\": \"vpc-m0cnatxj\",\n \"PrivateIpAddresses\": [\n \"172.16.3.59\"\n ]\n },\n \"LatestOperationRequestId\": \"c7de1287-061d-4ace-8caf-6ad8e5a2f29a\",\n \"InternetAccessible\": {\n \"PublicIpAssigned\": true,\n \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\",\n \"InternetMaxBandwidthOut\": 1\n },\n \"HpcClusterId\": \"\",\n \"LatestOperation\": \"ResetInstancesType\"\n }\n ],\n \"TotalCount\": 2,\n \"RequestId\": \"d655191e-a39d-43d2-8349-8c3f2bf4b327\"\n }\n}", "title": "查看实例列表" }, { @@ -308,7 +308,7 @@ { "document": "当对实例发起 StopInstances 后,通过 DescribeInstances 可以查询到实例的 LatestOperation 为 StopInstances,LatestOperationState 为 OPERATING。", "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstances\n<公共请求参数>\n\n{\n \"Limit\": \"1\",\n \"Filters\": [\n {\n \"Values\": [\n \"ap-guangzhou-2\",\n \"ap-guangzhou-1\"\n ],\n \"Name\": \"zone\"\n }\n ],\n \"Offset\": \"0\"\n}", - "output": "{\n \"Response\": {\n \"InstanceSet\": [\n {\n \"RenewFlag\": \"NOTIFY_AND_MANUAL_RENEW\",\n \"Uuid\": \"e85f1388-0422-410d-8e50-bef540e78c18\",\n \"InstanceState\": \"RUNNING\",\n \"DisableApiTermination\": false,\n \"LatestOperationErrorMsg\": \"\",\n \"DefaultLoginPort\": 22,\n \"LicenseType\": \"TencentCloud\",\n \"DefaultLoginUser\": \"root\",\n \"LatestOperationState\": \"OPERATING\",\n \"LoginSettings\": {\n \"Password\": \"123qwe!@#QWE\",\n \"KeepImageLogin\": \"False\",\n \"KeyIds\": [\n \"skey-b4vakk62\"\n ]\n },\n \"IPv6Addresses\": [\n \"2001:0db8:86a3:08d3:1319:8a2e:0370:7344\"\n ],\n \"RestrictState\": \"PROTECTIVELY_ISOLATED\",\n \"ExpiredTime\": \"2020-09-22T00:00:00+00:00\",\n \"DisasterRecoverGroupId\": \"ps-xxxxxxxx\",\n \"Memory\": 1,\n \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n \"CPU\": 1,\n \"RdmaIpAddresses\": [],\n \"CamRoleName\": \"\",\n \"DedicatedClusterId\": \"\",\n \"PublicIpAddresses\": [\n \"123.207.11.190\"\n ],\n \"Tags\": [\n {\n \"Value\": \"test\",\n \"Key\": \"test\"\n }\n ],\n \"InstanceId\": \"ins-xlsyru2j\",\n \"ImageId\": \"img-8toqc6s3\",\n \"StopChargingMode\": \"NOT_APPLICABLE\",\n \"InstanceChargeType\": \"POSTPAID_BY_HOUR\",\n \"InstanceType\": \"S2.SMALL2\",\n \"SystemDisk\": {\n \"DiskSize\": 50,\n \"CdcId\": \"cdc-xxxxxxxx\",\n \"DiskId\": \"disk-czsodtl1\",\n \"DiskType\": \"CLOUD_SSD\"\n },\n \"Placement\": {\n \"HostId\": \"host-h3m57oik\",\n \"ProjectId\": 1174660,\n \"HostIds\": [],\n \"Zone\": \"ap-guangzhou-1\"\n },\n \"PrivateIpAddresses\": [\n \"172.16.32.78\"\n ],\n \"OsName\": \"CentOS 7.4 64bit\",\n \"SecurityGroupIds\": [\n \"sg-p1ezv4wz\"\n ],\n \"InstanceName\": \"test\",\n \"DataDisks\": [\n {\n \"DeleteWithInstance\": true,\n \"Encrypt\": true,\n \"CdcId\": \"cdc-xxxxxxxx\",\n \"DiskType\": \"CLOUD_SSD\",\n \"ThroughputPerformance\": 0,\n \"KmsKeyId\": null,\n \"DiskSize\": 50,\n \"SnapshotId\": null,\n \"DiskId\": \"disk-bzsodtn1\"\n }\n ],\n \"IsolatedSource\": \"NOTISOLATED\",\n \"VirtualPrivateCloud\": {\n \"SubnetId\": \"subnet-mv4sn55k\",\n \"AsVpcGateway\": false,\n \"Ipv6AddressCount\": 1,\n \"VpcId\": \"vpc-m0cnatxj\",\n \"PrivateIpAddresses\": [\n \"172.16.3.59\"\n ]\n },\n \"LatestOperationRequestId\": \"c7de1287-061d-4ace-8caf-6ad8e5a2f29a\",\n \"InternetAccessible\": {\n \"PublicIpAssigned\": true,\n \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\",\n \"InternetMaxBandwidthOut\": 1\n },\n \"HpcClusterId\": \"\",\n \"LatestOperation\": \"StopInstances\"\n }\n ],\n \"TotalCount\": 2,\n \"RequestId\": \"d655191e-a39d-43d2-8349-8c3f2bf4b327\"\n }\n}", + "output": "{\n \"Response\": {\n \"InstanceSet\": [\n {\n \"RenewFlag\": \"NOTIFY_AND_MANUAL_RENEW\",\n \"Uuid\": \"e85f1388-0422-410d-8e50-bef540e78c18\",\n \"InstanceState\": \"RUNNING\",\n \"DisableApiTermination\": false,\n \"LatestOperationErrorMsg\": \"\",\n \"DefaultLoginPort\": 22,\n \"LicenseType\": \"TencentCloud\",\n \"DefaultLoginUser\": \"root\",\n \"LatestOperationState\": \"OPERATING\",\n \"LoginSettings\": {\n \"Password\": \"123qwe!@#QWE\",\n \"KeepImageLogin\": \"False\",\n \"KeyIds\": [\n \"skey-b4vakk62\"\n ]\n },\n \"IPv6Addresses\": [\n \"2001:0db8:86a3:08d3:1319:8a2e:0370:7344\"\n ],\n \"RestrictState\": \"PROTECTIVELY_ISOLATED\",\n \"ExpiredTime\": \"2020-09-22T00:00:00+00:00\",\n \"DisasterRecoverGroupId\": \"ps-xxxxxxxx\",\n \"Memory\": 1,\n \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n \"CPU\": 1,\n \"RdmaIpAddresses\": [],\n \"CamRoleName\": \"\",\n \"DedicatedClusterId\": \"\",\n \"PublicIpAddresses\": [\n \"123.207.11.190\"\n ],\n \"Tags\": [\n {\n \"Value\": \"myKey\",\n \"Key\": \"myValue\"\n }\n ],\n \"InstanceId\": \"ins-xlsyru2j\",\n \"ImageId\": \"img-8toqc6s3\",\n \"StopChargingMode\": \"NOT_APPLICABLE\",\n \"InstanceChargeType\": \"POSTPAID_BY_HOUR\",\n \"InstanceType\": \"S2.SMALL2\",\n \"SystemDisk\": {\n \"DiskSize\": 50,\n \"CdcId\": \"cdc-xxxxxxxx\",\n \"DiskId\": \"disk-czsodtl1\",\n \"DiskType\": \"CLOUD_SSD\"\n },\n \"Placement\": {\n \"HostId\": \"host-h3m57oik\",\n \"ProjectId\": 1174660,\n \"HostIds\": [],\n \"Zone\": \"ap-guangzhou-1\"\n },\n \"PrivateIpAddresses\": [\n \"172.16.32.78\"\n ],\n \"OsName\": \"CentOS 7.4 64bit\",\n \"SecurityGroupIds\": [\n \"sg-p1ezv4wz\"\n ],\n \"InstanceName\": \"myInstance\",\n \"DataDisks\": [\n {\n \"DeleteWithInstance\": true,\n \"Encrypt\": true,\n \"CdcId\": \"cdc-xxxxxxxx\",\n \"DiskType\": \"CLOUD_SSD\",\n \"ThroughputPerformance\": 0,\n \"KmsKeyId\": null,\n \"DiskSize\": 50,\n \"SnapshotId\": null,\n \"DiskId\": \"disk-bzsodtn1\"\n }\n ],\n \"IsolatedSource\": \"NOTISOLATED\",\n \"VirtualPrivateCloud\": {\n \"SubnetId\": \"subnet-mv4sn55k\",\n \"AsVpcGateway\": false,\n \"Ipv6AddressCount\": 1,\n \"VpcId\": \"vpc-m0cnatxj\",\n \"PrivateIpAddresses\": [\n \"172.16.3.59\"\n ]\n },\n \"LatestOperationRequestId\": \"c7de1287-061d-4ace-8caf-6ad8e5a2f29a\",\n \"InternetAccessible\": {\n \"PublicIpAssigned\": true,\n \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\",\n \"InternetMaxBandwidthOut\": 1\n },\n \"HpcClusterId\": \"\",\n \"LatestOperation\": \"StopInstances\"\n }\n ],\n \"TotalCount\": 2,\n \"RequestId\": \"d655191e-a39d-43d2-8349-8c3f2bf4b327\"\n }\n}", "title": "查询实例的最新操作情况" } ], @@ -384,30 +384,6 @@ "title": "请求例子" } ], - "DescribeReservedInstances": [ - { - "document": "列出已购买预留实例计费", - "input": "https://cvm.tencentcloudapi.com/?Action=DescribeReservedInstances\n&Filters.0.Name=zone\n&Filters.0.Values.0=ap-guangzhou-1\n&Limit=1\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ReservedInstancesSet\": [\n {\n \"ReservedInstanceId\": \"ri-rtbh4han\",\n \"ReservedInstancesId\": \"ri-rtbh4han\",\n \"ReservedInstanceName\": \"riname-01\",\n \"InstanceType\": \"S3.16XLARGE256\",\n \"InstanceFamily\": \"S3\",\n \"Zone\": \"ap-guangzhou-1\",\n \"StartTime\": \"0000-00-00 00:00:00\",\n \"EndTime\": \"0000-00-00 00:00:00\",\n \"Duration\": 31536000,\n \"InstanceCount\": 1,\n \"ProductDescription\": \"linux\",\n \"State\": \"active\",\n \"CurrencyCode\": \"USD\",\n \"OfferingType\": \"All Upfront\"\n }\n ],\n \"RequestId\": \"9cb3dd3d-5717-47c4-bf3b-05c7ddb4655b\"\n }\n}", - "title": "列出已购买预留实例计费" - } - ], - "DescribeReservedInstancesConfigInfos": [ - { - "document": "查询预留实例机型配置", - "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeReservedInstancesConfigInfos\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Name\": \"zone\",\n \"Values\": [\n \"ap-guangzhou-1\"\n ]\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"ReservedInstanceConfigInfos\": [\n {\n \"Type\": \"C\",\n \"TypeName\": \"计算型\",\n \"Order\": 0,\n \"InstanceFamilies\": [\n {\n \"InstanceFamily\": \"abc\",\n \"Order\": 402,\n \"InstanceTypes\": [\n {\n \"InstanceType\": \"C3.LARGE8\",\n \"Cpu\": 4,\n \"Memory\": 8,\n \"Gpu\": 0,\n \"Fpga\": 0,\n \"StorageBlock\": 0,\n \"NetworkCard\": 0,\n \"MaxBandwidth\": 0,\n \"Frequency\": \"2.5\",\n \"CpuModelName\": \"Intel Xeon Skylake 6146\",\n \"Pps\": 60,\n \"Externals\": {\n \"ReleaseAddress\": true,\n \"UnsupportNetworks\": [],\n \"StorageBlockAttr\": {\n \"Type\": \"\",\n \"MinSize\": 0,\n \"MaxSize\": 0\n }\n },\n \"Remark\": \"\",\n \"Prices\": [\n {\n \"ReservedInstancesOfferingId\": \"d81353d7-fe7d-43d0-a361-fb5633a9a7e5\",\n \"OfferingType\": \"No Upfront\",\n \"FixedPrice\": 0,\n \"UsagePrice\": 2.99,\n \"Duration\": 1,\n \"Zone\": \"ap-guangzhou-1\",\n \"ProductDescription\": \"\"\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"RequestId\": \"87eccd3e-9e7a-4b42-be3a-87eccd3e\"\n }\n}", - "title": "查询预留实例机型配置" - } - ], - "DescribeReservedInstancesOfferings": [ - { - "document": "列出可购买预留实例计费", - "input": "https://cvm.tencentcloudapi.com/?Action=DescribeReservedInstancesOfferings\r\n&Filters.0.Name=zone\r\n&Filters.0.Values.0=ap-guangzhou-1\r\n&Offset=0\r\n&Limit=1\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ReservedInstancesOfferingsSet\": [\n {\n \"Zone\": \"ap-guangzhou-1\",\n \"CurrencyCode\": \"USD\",\n \"Duration\": 31536000,\n \"FixedPrice\": 4000.0,\n \"InstanceType\": \"S3.MEDIUM4\",\n \"OfferingType\": \"All Upfront\",\n \"ReservedInstancesOfferingId\": \"noew0342-324f-f3ab-9uut-wrlnth53dcee\",\n \"ProductDescription\": \"linux\",\n \"UsagePrice\": 0.0\n }\n ],\n \"RequestId\": \"b813c959-cc89-41d5-9cc4-ceb7d853dcaa\"\n }\n}", - "title": "列出可购买预留实例计费" - } - ], "DescribeTaskInfo": [ { "document": "根据以下条件,查询并获取维修任务返回列表:\n\n- 任务的创建时间在 `2023-03-01 00:00:00` ~ `2023-04-01 00:00:00` 范围内。\n- 任务当前的状态为`待授权`。\n- 返回的任务列表按照`CreateTime`创建时间降序返回,偏移量为`0`,最多返回`20`条数据。", @@ -502,14 +478,6 @@ "title": "导入密钥对" } ], - "InquirePricePurchaseReservedInstancesOffering": [ - { - "document": "", - "input": "https://cvm.tencentcloudapi.com/?Action=InquirePricePurchaseReservedInstancesOffering\n&InstanceCount=2\n&ReservedInstancesOfferingId=noew0342-324f-f3ab-9uut-wrlnth53dcee\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Price\": {\n \"OriginalFixedPrice\": 100.99,\n \"DiscountFixedPrice\": 100.99,\n \"OriginalUsagePrice\": 1.99,\n \"DiscountUsagePrice\": 1.99,\n \"FixedPriceDiscount\": 60,\n \"UsagePriceDiscount\": 60\n },\n \"RequestId\": \"b333ddb8-4aed-4def-a0d9-617043c2614e\"\n }\n}", - "title": "创建预留实例询价" - } - ], "InquiryPriceModifyInstancesChargeType": [ { "document": "本示例用于切换一个实例的计费模式询价。", @@ -582,7 +550,7 @@ { "document": "实例所在位置为上海二区,付费模式为按小时后付费,镜像ID为:img-pmqg1cw7,选择机型为:64C256G标准型(S5.16XLARGE256),50G大小高性能云系统盘,挂载100G大小高性能云数据盘,私有网络,公网付费模式为流量按小时后付费,外网带宽上限10Mbps,分配公网IP,实例命名为QCLOUD-TEST,设置登录密码未Qcloud@TestApi123++,安装云监控云安全,购买数量为1台。", "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquiryPriceRunInstances\n<公共请求参数>\n\n{\n \"SystemDisk\": {\n \"DiskSize\": 50,\n \"DiskType\": \"CLOUD_PREMIUM\"\n },\n \"InstanceCount\": 1,\n \"Placement\": {\n \"Zone\": \"ap-shanghai-2\"\n },\n \"LoginSettings\": {\n \"Password\": \"Qcloud@TestApi123++\"\n },\n \"ImageId\": \"img-pmqg1cw7\",\n \"InstanceChargeType\": \"POSTPAID_BY_HOUR\",\n \"EnhancedService\": {\n \"SecurityService\": {\n \"Enabled\": true\n },\n \"MonitorService\": {\n \"Enabled\": true\n }\n },\n \"InternetAccessible\": {\n \"PublicIpAssigned\": true,\n \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\",\n \"InternetMaxBandwidthOut\": \"10\"\n },\n \"InstanceName\": \"QCLOUD-TEST\",\n \"InstanceType\": \"S5.16XLARGE256\",\n \"DataDisks\": [\n {\n \"DiskSize\": 100,\n \"DiskType\": \"CLOUD_PREMIUM\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Price\": {\n \"InstancePrice\": {\n \"DiscountPrice\": 0.0,\n \"OriginalPriceThreeYear\": 0.0,\n \"DiscountOneYear\": 0.0,\n \"UnitPrice\": 16.09,\n \"UnitPriceThirdStep\": 16.09,\n \"OriginalPriceFiveYear\": 0.0,\n \"Discount\": 0.0,\n \"DiscountFiveYear\": 0.0,\n \"UnitPriceDiscountThirdStep\": 3.33,\n \"UnitPriceSecondStep\": 16.09,\n \"OriginalPrice\": 0.0,\n \"DiscountThreeYear\": 0.0,\n \"UnitPriceDiscountSecondStep\": 3.33,\n \"UnitPriceDiscount\": 3.33,\n \"DiscountPriceFiveYear\": 0.0,\n \"OriginalPriceOneYear\": 0.0,\n \"ChargeUnit\": \"HOUR\",\n \"DiscountPriceThreeYear\": 0.0,\n \"DiscountPriceOneYear\": 0.0\n },\n \"BandwidthPrice\": {\n \"DiscountPrice\": 0.0,\n \"OriginalPriceThreeYear\": 0.0,\n \"DiscountOneYear\": 0.0,\n \"UnitPrice\": 0.8,\n \"UnitPriceThirdStep\": 0.0,\n \"OriginalPriceFiveYear\": 0.0,\n \"Discount\": 0.0,\n \"DiscountFiveYear\": 0.0,\n \"UnitPriceDiscountThirdStep\": 0.0,\n \"UnitPriceSecondStep\": 0.0,\n \"OriginalPrice\": 0.0,\n \"DiscountThreeYear\": 0.0,\n \"UnitPriceDiscountSecondStep\": 0.0,\n \"UnitPriceDiscount\": 0.52,\n \"DiscountPriceFiveYear\": 0.0,\n \"OriginalPriceOneYear\": 0.0,\n \"ChargeUnit\": \"xx\",\n \"DiscountPriceThreeYear\": 0.0,\n \"DiscountPriceOneYear\": 0.0\n }\n },\n \"RequestId\": \"65b9edac-bca6-496b-a404-29f503b32495\"\n }\n}", + "output": "{\n \"Response\": {\n \"Price\": {\n \"InstancePrice\": {\n \"DiscountPrice\": 0.0,\n \"OriginalPriceThreeYear\": 0.0,\n \"DiscountOneYear\": 0.0,\n \"UnitPrice\": 16.09,\n \"UnitPriceThirdStep\": 16.09,\n \"OriginalPriceFiveYear\": 0.0,\n \"Discount\": 0.0,\n \"DiscountFiveYear\": 0.0,\n \"UnitPriceDiscountThirdStep\": 3.33,\n \"UnitPriceSecondStep\": 16.09,\n \"OriginalPrice\": 0.0,\n \"DiscountThreeYear\": 0.0,\n \"UnitPriceDiscountSecondStep\": 3.33,\n \"UnitPriceDiscount\": 3.33,\n \"DiscountPriceFiveYear\": 0.0,\n \"OriginalPriceOneYear\": 0.0,\n \"ChargeUnit\": \"HOUR\",\n \"DiscountPriceThreeYear\": 0.0,\n \"DiscountPriceOneYear\": 0.0\n },\n \"BandwidthPrice\": {\n \"DiscountPrice\": 0.0,\n \"OriginalPriceThreeYear\": 0.0,\n \"DiscountOneYear\": 0.0,\n \"UnitPrice\": 0.8,\n \"UnitPriceThirdStep\": 0.0,\n \"OriginalPriceFiveYear\": 0.0,\n \"Discount\": 0.0,\n \"DiscountFiveYear\": 0.0,\n \"UnitPriceDiscountThirdStep\": 0.0,\n \"UnitPriceSecondStep\": 0.0,\n \"OriginalPrice\": 0.0,\n \"DiscountThreeYear\": 0.0,\n \"UnitPriceDiscountSecondStep\": 0.0,\n \"UnitPriceDiscount\": 0.52,\n \"DiscountPriceFiveYear\": 0.0,\n \"OriginalPriceOneYear\": 0.0,\n \"ChargeUnit\": \"HOUR\",\n \"DiscountPriceThreeYear\": 0.0,\n \"DiscountPriceOneYear\": 0.0\n }\n },\n \"RequestId\": \"65b9edac-bca6-496b-a404-29f503b32495\"\n }\n}", "title": "按小时后付费实例购买询价" } ], @@ -726,14 +694,6 @@ "title": "在线烧录FPGA镜像" } ], - "PurchaseReservedInstancesOffering": [ - { - "document": "购买预留实例计费", - "input": "https://cvm.tencentcloudapi.com/?Action=PurchaseReservedInstancesOffering\r\n&InstanceCount=2\r\n&ReservedInstancesOfferingId=noew0342-324f-f3ab-9uut-wrlnth53dcee\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"ReservedInstanceId\": \"13d8e599-b8dc-4e8a-80b4-7dce9eb27043\",\n \"RequestId\": \"b333ddb8-4aed-4def-a0d9-617043c2614e\"\n }\n}", - "title": "购买预留实例计费" - } - ], "RebootInstances": [ { "document": "本示例用于重启两个实例。", diff --git a/tccli/services/cwp/cwp_client.py b/tccli/services/cwp/cwp_client.py index 8fff4c7e4b..276adfc2af 100644 --- a/tccli/services/cwp/cwp_client.py +++ b/tccli/services/cwp/cwp_client.py @@ -15201,58 +15201,6 @@ def doAddLoginWhiteLists(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeIndexList(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.CwpClient(cred, g_param[OptionsDefine.Region], profile) - client._sdkVersion += ("_CLI_" + __version__) - models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeIndexListRequest() - model.from_json_string(json.dumps(args)) - start_time = time.time() - while True: - rsp = client.DescribeIndexList(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 doExportProtectDirList(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -27360,7 +27308,6 @@ def doDescribeAssetMachineTagTop(args, parsed_globals): "DescribeUsualLoginPlaces": doDescribeUsualLoginPlaces, "ExportFileTamperEvents": doExportFileTamperEvents, "AddLoginWhiteLists": doAddLoginWhiteLists, - "DescribeIndexList": doDescribeIndexList, "ExportProtectDirList": doExportProtectDirList, "ExportTasks": doExportTasks, "ExportIgnoreRuleEffectHostList": doExportIgnoreRuleEffectHostList, diff --git a/tccli/services/cwp/v20180228/api.json b/tccli/services/cwp/v20180228/api.json index eadca78b27..787e15fcb5 100644 --- a/tccli/services/cwp/v20180228/api.json +++ b/tccli/services/cwp/v20180228/api.json @@ -1400,13 +1400,6 @@ "output": "DescribeImportMachineInfoResponse", "status": "online" }, - "DescribeIndexList": { - "document": "接口已废弃\n\n获取索引列表", - "input": "DescribeIndexListRequest", - "name": "获取索引列表", - "output": "DescribeIndexListResponse", - "status": "deprecated" - }, "DescribeJavaMemShellInfo": { "document": "查询java内存马事件详细信息", "input": "DescribeJavaMemShellInfoRequest", @@ -25920,33 +25913,6 @@ ], "type": "object" }, - "DescribeIndexListRequest": { - "document": "DescribeIndexList请求参数结构体", - "members": [], - "type": "object" - }, - "DescribeIndexListResponse": { - "document": "DescribeIndexList返回参数结构体", - "members": [ - { - "disabled": false, - "document": "ES 索引信息", - "example": "xxx", - "member": "string", - "name": "Data", - "required": true, - "type": "string", - "value_allowed_null": false - }, - { - "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", - "member": "string", - "name": "RequestId", - "type": "string" - } - ], - "type": "object" - }, "DescribeJavaMemShellInfoRequest": { "document": "DescribeJavaMemShellInfo请求参数结构体", "members": [ diff --git a/tccli/services/cwp/v20180228/examples.json b/tccli/services/cwp/v20180228/examples.json index 57d523e904..44aba56c6a 100644 --- a/tccli/services/cwp/v20180228/examples.json +++ b/tccli/services/cwp/v20180228/examples.json @@ -1606,14 +1606,6 @@ "title": "查询批量导入机器信息" } ], - "DescribeIndexList": [ - { - "document": "", - "input": "https://cwp.tencentcloudapi.com/?Action=DescribeIndexList\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Data\": \"{\\\"indexSort\\\":{\\\"资产管理\\\":[\\\"userlog-asset_component\\\"],\\\"入侵检测\\\":[\\\"userlog-malware\\\"],\\\"网络防御\\\":[\\\"userlog-network_attack\\\"]},\\\"indexArr\\\":[\\\"userlog-asset_component\\\",\\\"userlog-malware\\\",\\\"userlog-network_attack\\\"],\\\"fieldArr\\\":[{\\\"quuid\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_index\\\":{\\\"_index\\\":{\\\"type\\\":\\\"_index\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_feature\\\":{\\\"_feature\\\":{\\\"type\\\":\\\"_feature\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"hostip\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"user_name\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"modify_time\\\":{\\\"date\\\":{\\\"type\\\":\\\"date\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"pid\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"proc_tree\\\":{\\\"text\\\":{\\\"type\\\":\\\"text\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"uuid\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"dst_ip\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"parent_proc_path\\\":{\\\"text\\\":{\\\"type\\\":\\\"text\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"_ignored\\\":{\\\"_ignored\\\":{\\\"type\\\":\\\"_ignored\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"process_name\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"id\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"full_path\\\":{\\\"text\\\":{\\\"type\\\":\\\"text\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"_version\\\":{\\\"_version\\\":{\\\"type\\\":\\\"_version\\\",\\\"searchable\\\":false,\\\"aggregatable\\\":false}},\\\"_routing\\\":{\\\"_routing\\\":{\\\"type\\\":\\\"_routing\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"user_group\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"create_time\\\":{\\\"date\\\":{\\\"type\\\":\\\"date\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_type\\\":{\\\"_type\\\":{\\\"type\\\":\\\"_type\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"ppid\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"find_time\\\":{\\\"date\\\":{\\\"type\\\":\\\"date\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_seq_no\\\":{\\\"_seq_no\\\":{\\\"type\\\":\\\"_seq_no\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"parent_proc_group\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"parent_proc_user\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"cmd_line\\\":{\\\"text\\\":{\\\"type\\\":\\\"text\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"_field_names\\\":{\\\"_field_names\\\":{\\\"type\\\":\\\"_field_names\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"parent_proc_name\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"appid\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"dst_port\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_source\\\":{\\\"_source\\\":{\\\"type\\\":\\\"_source\\\",\\\"searchable\\\":false,\\\"aggregatable\\\":false}},\\\"_id\\\":{\\\"_id\\\":{\\\"type\\\":\\\"_id\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"status\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}}},{\\\"_index\\\":{\\\"_index\\\":{\\\"type\\\":\\\"_index\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"hostip\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_feature\\\":{\\\"_feature\\\":{\\\"type\\\":\\\"_feature\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"modify_time\\\":{\\\"date\\\":{\\\"type\\\":\\\"date\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"filemodifiertime\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"filesize\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"uuid\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_ignored\\\":{\\\"_ignored\\\":{\\\"type\\\":\\\"_ignored\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"virusname\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"filepath\\\":{\\\"text\\\":{\\\"type\\\":\\\"text\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"id\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_version\\\":{\\\"_version\\\":{\\\"type\\\":\\\"_version\\\",\\\"searchable\\\":false,\\\"aggregatable\\\":false}},\\\"_routing\\\":{\\\"_routing\\\":{\\\"type\\\":\\\"_routing\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"create_time\\\":{\\\"date\\\":{\\\"type\\\":\\\"date\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_type\\\":{\\\"_type\\\":{\\\"type\\\":\\\"_type\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"fileaccesstime\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"pathmd5\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"bwtype\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_seq_no\\\":{\\\"_seq_no\\\":{\\\"type\\\":\\\"_seq_no\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_field_names\\\":{\\\"_field_names\\\":{\\\"type\\\":\\\"_field_names\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"filecreatetime\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"appid\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_source\\\":{\\\"_source\\\":{\\\"type\\\":\\\"_source\\\",\\\"searchable\\\":false,\\\"aggregatable\\\":false}},\\\"_id\\\":{\\\"_id\\\":{\\\"type\\\":\\\"_id\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"status\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"md5\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}}},{\\\"_routing\\\":{\\\"_routing\\\":{\\\"type\\\":\\\"_routing\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"component_id\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"quuid\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_index\\\":{\\\"_index\\\":{\\\"type\\\":\\\"_index\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"create_time\\\":{\\\"date\\\":{\\\"type\\\":\\\"date\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_feature\\\":{\\\"_feature\\\":{\\\"type\\\":\\\"_feature\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"hostip\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"modify_time\\\":{\\\"date\\\":{\\\"type\\\":\\\"date\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_type\\\":{\\\"_type\\\":{\\\"type\\\":\\\"_type\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"remark\\\":{\\\"text\\\":{\\\"type\\\":\\\"text\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"type\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"uuid\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"version\\\":{\\\"keyword\\\":{\\\"type\\\":\\\"keyword\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_ignored\\\":{\\\"_ignored\\\":{\\\"type\\\":\\\"_ignored\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"_seq_no\\\":{\\\"_seq_no\\\":{\\\"type\\\":\\\"_seq_no\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"path\\\":{\\\"text\\\":{\\\"type\\\":\\\"text\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"_field_names\\\":{\\\"_field_names\\\":{\\\"type\\\":\\\"_field_names\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":false}},\\\"appid\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_source\\\":{\\\"_source\\\":{\\\"type\\\":\\\"_source\\\",\\\"searchable\\\":false,\\\"aggregatable\\\":false}},\\\"_id\\\":{\\\"_id\\\":{\\\"type\\\":\\\"_id\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"id\\\":{\\\"long\\\":{\\\"type\\\":\\\"long\\\",\\\"searchable\\\":true,\\\"aggregatable\\\":true}},\\\"_version\\\":{\\\"_version\\\":{\\\"type\\\":\\\"_version\\\",\\\"searchable\\\":false,\\\"aggregatable\\\":false}}}]}\",\n \"RequestId\": \"49082d4a-71b4-4e32-9ca1-b33872a4a63a\"\n }\n}", - "title": "获取索引列表" - } - ], "DescribeJavaMemShellInfo": [ { "document": "", diff --git a/tccli/services/cynosdb/v20190107/api.json b/tccli/services/cynosdb/v20190107/api.json index 84dda2f1d8..f5252034e5 100644 --- a/tccli/services/cynosdb/v20190107/api.json +++ b/tccli/services/cynosdb/v20190107/api.json @@ -162,7 +162,7 @@ "status": "online" }, "DeleteAuditLogFile": { - "document": "本接口(DeleteAuditLogFile)用于删除云数据库实例的审计日志文件。", + "document": "本接口(DeleteAuditLogFile)用于删除云数据库实例的审计日志文件。", "input": "DeleteAuditLogFileRequest", "name": "删除审计日志文件", "output": "DeleteAuditLogFileResponse", @@ -239,7 +239,7 @@ "status": "online" }, "DescribeAuditLogs": { - "document": "本接口(DescribeAuditLogs)用于查询数据库审计日志。", + "document": "本接口(DescribeAuditLogs)用于查询数据库审计日志。", "input": "DescribeAuditLogsRequest", "name": "查询数据库审计日志", "output": "DescribeAuditLogsResponse", @@ -463,7 +463,7 @@ "status": "online" }, "DescribeIsolatedInstances": { - "document": "本接口(DescribeIsolatedInstances)用于查询回收站实例列表。", + "document": "本接口(DescribeIsolatedInstances)用于查询回收站实例列表。", "input": "DescribeIsolatedInstancesRequest", "name": "查询回收站实例列表", "output": "DescribeIsolatedInstancesResponse", @@ -1109,14 +1109,14 @@ }, { "disabled": false, - "document": "不支持从可用区的原因\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "不支持从可用区的原因", + "example": "cluster has proxy, does not support slave zone", "member": "string", "name": "NonsupportSlaveZoneReason", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -1131,58 +1131,58 @@ }, { "disabled": false, - "document": "不支持RO实例的原因\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "不支持RO实例的原因", + "example": "cynos version must be greater or equal than 3.1.2", "member": "string", "name": "NonsupportRoReason", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否支持手动发起快照备份\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否支持手动发起快照备份", "example": "yes", "member": "string", "name": "IsSupportManualSnapshot", "output_required": true, "required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否支持透明数据加密\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否支持透明数据加密", "example": "yes", "member": "string", "name": "IsSupportTransparentDataEncryption", "output_required": false, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "不支持透明数据加密原因\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "不支持透明数据加密原因", + "example": "mysql version 5.7 , >=2.1.12; Other versions are not supported", "member": "string", "name": "NoSupportTransparentDataEncryptionReason", "output_required": false, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "是否支持手动发起逻辑备份\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "是否支持手动发起逻辑备份", + "example": "yes", "member": "string", "name": "IsSupportManualLogic", "output_required": false, "required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "both" @@ -1193,60 +1193,60 @@ { "disabled": false, "document": "数据库账号名", - "example": "xxx", + "example": "andy", "member": "string", "name": "AccountName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "数据库账号描述", - "example": "xxx", + "example": "andyuse", "member": "string", "name": "Description", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "创建时间", - "example": "xxx", + "example": "2024-11-21 11:58:25", "member": "datetime", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "更新时间", - "example": "xxx", + "example": "2024-11-25 17:11:03", "member": "datetime", "name": "UpdateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "主机", - "example": "xxx", + "example": "%", "member": "string", "name": "Host", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "用户最大连接数", - "example": "0", + "example": "3000", "member": "int64", "name": "MaxUserConnections", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -1606,7 +1606,7 @@ { "disabled": false, "document": "IP地址", - "example": "无", + "example": "172.2.1.1", "member": "string", "name": "IP", "output_required": true, @@ -1616,7 +1616,7 @@ { "disabled": false, "document": "端口", - "example": "无", + "example": "3306", "member": "int64", "name": "Port", "output_required": true, @@ -1769,7 +1769,7 @@ { "disabled": false, "document": "表名称。", - "example": "1234", + "example": "andy_table1", "member": "string", "name": "TableName", "output_required": true, @@ -1809,7 +1809,7 @@ { "disabled": false, "document": "SQL语句。", - "example": "无", + "example": "ALTER TABLE ***", "member": "string", "name": "Sql", "output_required": true, @@ -1819,7 +1819,7 @@ { "disabled": false, "document": "客户端地址。", - "example": "无", + "example": "192.168.0.1", "member": "string", "name": "Host", "output_required": true, @@ -1839,7 +1839,7 @@ { "disabled": false, "document": "执行时间,微秒。", - "example": "12345678", + "example": "2000", "member": "int64", "name": "ExecTime", "output_required": true, @@ -1849,7 +1849,7 @@ { "disabled": false, "document": "时间。", - "example": "无", + "example": "2024-06-08 14:29:25", "member": "string", "name": "Timestamp", "output_required": true, @@ -1899,7 +1899,7 @@ { "disabled": false, "document": "IO等待时间,微秒。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "11", + "example": "1000", "member": "int64", "name": "IoWaitTime", "output_required": false, @@ -1918,7 +1918,7 @@ }, { "disabled": false, - "document": "事物持续等待时间,微秒。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "事务持续等待时间,微秒。\n注意:此字段可能返回 null,表示取不到有效值。", "example": "1092", "member": "int64", "name": "TrxLivingTime", @@ -1939,7 +1939,7 @@ { "disabled": false, "document": "日志命中规则模板的基本信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[{\"RuleTemplateId\": \"\tcynosdb-art-ns0u376\",\"RuleTemplateName\": \"andy_rule\",\"AlarmLevel\": \"2\",\"RuleTemplateStatus\": \"1\"}]", "member": "LogRuleTemplateInfo", "name": "TemplateInfo", "output_required": false, @@ -1949,7 +1949,7 @@ { "disabled": false, "document": "事务ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "13365", "member": "int64", "name": "TrxId", "output_required": false, @@ -1968,7 +1968,7 @@ "example": "FileName", "member": "string", "name": "FileName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1978,7 +1978,7 @@ "example": "2019-03-20 17:09:13", "member": "string", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1988,39 +1988,39 @@ "example": "creating", "member": "string", "name": "Status", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, - "document": "文件大小,单位为 KB。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1234", + "document": "文件大小,单位为 KB。", + "example": "2048", "member": "int64", "name": "FileSize", - "required": true, + "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "审计日志下载地址。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "审计日志下载地址。", "example": "DownloadUrl", "member": "string", "name": "DownloadUrl", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "错误信息。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "错误信息。", "example": "ErrMsg", "member": "string", "name": "ErrMsg", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -2035,8 +2035,7 @@ "member": "string", "name": "Host", "required": false, - "type": "list", - "value_allowed_null": false + "type": "list" }, { "disabled": false, @@ -2045,8 +2044,7 @@ "member": "string", "name": "User", "required": false, - "type": "list", - "value_allowed_null": false + "type": "list" }, { "disabled": false, @@ -2055,8 +2053,7 @@ "member": "string", "name": "DBName", "required": false, - "type": "list", - "value_allowed_null": false + "type": "list" }, { "disabled": false, @@ -2065,8 +2062,7 @@ "member": "string", "name": "TableName", "required": false, - "type": "list", - "value_allowed_null": false + "type": "list" }, { "disabled": false, @@ -2075,18 +2071,16 @@ "member": "string", "name": "PolicyName", "required": false, - "type": "list", - "value_allowed_null": false + "type": "list" }, { "disabled": false, "document": "SQL 语句。支持模糊匹配。", - "example": "无", + "example": "ALTER TABLE", "member": "string", "name": "Sql", "required": false, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, @@ -2095,8 +2089,7 @@ "member": "string", "name": "SqlType", "required": false, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, @@ -2105,8 +2098,7 @@ "member": "int64", "name": "ExecTime", "required": false, - "type": "int", - "value_allowed_null": false + "type": "int" }, { "disabled": false, @@ -2115,8 +2107,7 @@ "member": "int64", "name": "AffectRows", "required": false, - "type": "int", - "value_allowed_null": false + "type": "int" }, { "disabled": false, @@ -2125,8 +2116,7 @@ "member": "string", "name": "SqlTypes", "required": false, - "type": "list", - "value_allowed_null": false + "type": "list" }, { "disabled": false, @@ -2135,8 +2125,7 @@ "member": "string", "name": "Sqls", "required": false, - "type": "list", - "value_allowed_null": false + "type": "list" }, { "disabled": false, @@ -2145,8 +2134,7 @@ "member": "uint64", "name": "SentRows", "required": false, - "type": "int", - "value_allowed_null": false + "type": "int" }, { "disabled": false, @@ -2155,8 +2143,7 @@ "member": "string", "name": "ThreadId", "required": false, - "type": "list", - "value_allowed_null": false + "type": "list" } ], "usage": "in" @@ -2290,7 +2277,7 @@ { "disabled": false, "document": "快照文件ID,已废弃,请使用BackupId", - "example": "无", + "example": "17623", "member": "uint64", "name": "SnapshotId", "output_required": true, @@ -2416,30 +2403,30 @@ { "disabled": false, "document": "集群ID", - "example": "”cynosdbmysql-xxx\"", + "example": "cynosdbmysql-j9i41hfv", "member": "string", "name": "ClusterId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "实例ID列表", - "example": "[\"cynosdbmysql-ins-xxx\"]]", + "example": "[\"cynosdbmysql-ins-4vdteifv\"]", "member": "string", "name": "InstanceIds", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "订单ID", - "example": "\"xxx\"", + "example": "1000000001111", "member": "string", "name": "DealName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -2545,7 +2532,7 @@ { "disabled": false, "document": "binlog异地地域备份是否开启\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ON", "member": "string", "name": "BinlogCrossRegionsEnable", "output_required": false, @@ -2639,7 +2626,7 @@ { "disabled": false, "document": "用户appid", - "example": "123", + "example": "13347**48", "member": "int64", "name": "AppId", "output_required": true, @@ -2649,7 +2636,7 @@ { "disabled": false, "document": "集群id", - "example": "cynosdbmysql-xxx", + "example": "cynosdbmysql-j9i41hfv", "member": "string", "name": "ClusterId", "output_required": true, @@ -2659,7 +2646,7 @@ { "disabled": false, "document": "地域\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": false, @@ -2689,7 +2676,7 @@ { "disabled": false, "document": "任务失败信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "error", "member": "string", "name": "ErrMsg", "output_required": true, @@ -2709,7 +2696,7 @@ { "disabled": false, "document": "任务输入信息", - "example": "xx", + "example": "{\\\"AppId\\\":251232125,\\\"uin\\\":\\\"700000433509\\\",...\\\"}", "member": "string", "name": "Input", "output_required": true, @@ -2849,7 +2836,7 @@ { "disabled": false, "document": "集群名称", - "example": "xx", + "example": "cynosdbmysql-j9i41hfv", "member": "string", "name": "ClusterName", "output_required": true, @@ -2859,7 +2846,7 @@ { "disabled": false, "document": "实例名称", - "example": "xx", + "example": "cynosdbmysql-ins-4vdtei33", "member": "string", "name": "InstanceName", "output_required": true, @@ -3084,7 +3071,7 @@ { "disabled": false, "document": "日志主题id", - "example": "test", + "example": "8c392615-b4c0-4f70-b07d-1fb5cd688f60", "member": "string", "name": "TopicId", "required": false, @@ -3093,7 +3080,7 @@ { "disabled": false, "document": "日志主题name", - "example": "test", + "example": "cloud_lala_topic", "member": "string", "name": "TopicName", "required": false, @@ -3102,7 +3089,7 @@ { "disabled": false, "document": "日志集id", - "example": "test", + "example": "95a03fb4-395b-4ce7-802b-4ce10c7431dd", "member": "string", "name": "GroupId", "required": false, @@ -3111,7 +3098,7 @@ { "disabled": false, "document": "日志集name", - "example": "test", + "example": "cloud_haha_logset", "member": "string", "name": "GroupName", "required": false, @@ -3366,7 +3353,7 @@ { "disabled": false, "document": "实例ID", - "example": "无", + "example": "cynosdbmysql-ins-4vdteifv", "member": "string", "name": "InstanceId", "output_required": true, @@ -3376,7 +3363,7 @@ { "disabled": false, "document": "实例名称", - "example": "无", + "example": "cynosdbmysql-ins-4vdteifv", "member": "string", "name": "InstanceName", "output_required": true, @@ -3386,7 +3373,7 @@ { "disabled": false, "document": "引擎类型", - "example": "无", + "example": "rw", "member": "string", "name": "InstanceType", "output_required": true, @@ -3396,7 +3383,7 @@ { "disabled": false, "document": "实例状态", - "example": "无", + "example": "running", "member": "string", "name": "InstanceStatus", "output_required": true, @@ -3406,7 +3393,7 @@ { "disabled": false, "document": "实例状态描述", - "example": "无", + "example": "运行中", "member": "string", "name": "InstanceStatusDesc", "output_required": true, @@ -3416,7 +3403,7 @@ { "disabled": false, "document": "cpu核数", - "example": "无", + "example": "1", "member": "int64", "name": "InstanceCpu", "output_required": true, @@ -3426,7 +3413,7 @@ { "disabled": false, "document": "内存", - "example": "无", + "example": "2", "member": "int64", "name": "InstanceMemory", "output_required": true, @@ -3436,7 +3423,7 @@ { "disabled": false, "document": "硬盘", - "example": "无", + "example": "50", "member": "int64", "name": "InstanceStorage", "output_required": true, @@ -3446,7 +3433,7 @@ { "disabled": false, "document": "实例角色", - "example": "无", + "example": "master", "member": "string", "name": "InstanceRole", "output_required": true, @@ -3476,7 +3463,7 @@ { "disabled": false, "document": "可以执行的时间,枚举值:[\"Mon\",\"Tue\",\"Wed\",\"Thu\",\"Fri\", \"Sat\", \"Sun\"]\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"Mon\"\t", + "example": "Mon", "member": "string", "name": "MaintainWeekDays", "output_required": false, @@ -3486,7 +3473,7 @@ { "disabled": false, "document": "serverless实例子状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "pause", "member": "string", "name": "ServerlessStatus", "output_required": false, @@ -3506,7 +3493,7 @@ { "disabled": false, "document": "实例机器类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "exclusive", "member": "string", "name": "InstanceDeviceType", "output_required": false, @@ -3516,7 +3503,7 @@ { "disabled": false, "document": "实例存储类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "CLOUD_TCS", "member": "string", "name": "InstanceStorageType", "output_required": false, @@ -3526,7 +3513,7 @@ { "disabled": false, "document": "数据库类型", - "example": "无", + "example": "normal", "member": "string", "name": "DbMode", "output_required": false, @@ -3542,80 +3529,80 @@ { "disabled": false, "document": "参数名称", - "example": "无", + "example": "back_log", "member": "string", "name": "ParamName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "当前值", - "example": "无", + "example": "1024", "member": "string", "name": "CurrentValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "修改后的值", - "example": "无", + "example": "1025", "member": "string", "name": "UpdateValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "修改状态", - "example": "无", + "example": "success", "member": "string", "name": "Status", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "创建时间", - "example": "无", + "example": "2020-09-22T00:00:00+00:00", "member": "datetime_iso", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "更新时间", - "example": "无", + "example": "2021-09-22T00:00:00+00:00", "member": "datetime_iso", "name": "UpdateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "集群ID", - "example": "cynosdbmysql-xxx", + "example": "cynosdbmysql-mwg712eh", "member": "string", "name": "ClusterId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "实例ID", - "example": "cynosdbmysql-ins-xxx", + "example": "cynosdbmysql-ins-m6f0hkdb", "member": "string", "name": "InstanceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -3867,7 +3854,7 @@ { "disabled": false, "document": "审计规则。", - "example": "无", + "example": "[{\"Type\": \"sqlType\",\"Compare\": \"INC\",\"Value\": \"UPDATE\"}]", "member": "RuleFilters", "name": "RuleFilters", "required": true, @@ -3876,7 +3863,7 @@ { "disabled": false, "document": "规则模板名称。", - "example": "这是规则模板名称", + "example": "andy", "member": "string", "name": "RuleTemplateName", "required": true, @@ -3885,7 +3872,7 @@ { "disabled": false, "document": "规则模板描述。", - "example": "规则模板自白。", + "example": "andy模板", "member": "string", "name": "Description", "required": false, @@ -4013,7 +4000,7 @@ { "disabled": false, "document": "实例id", - "example": "无", + "example": "cynosdbmysql-ins-ifq10f11", "member": "string", "name": "InstanceId", "required": true, @@ -4031,7 +4018,7 @@ { "disabled": false, "document": "日志类型", - "example": "无", + "example": "slow", "member": "string", "name": "LogType", "required": false, @@ -4040,7 +4027,7 @@ { "disabled": false, "document": "是否维护时间运行", - "example": "无", + "example": "no", "member": "string", "name": "IsInMaintainPeriod", "required": false, @@ -4055,7 +4042,7 @@ { "disabled": false, "document": "异步任务id", - "example": "123456", + "example": "148728", "member": "int64", "name": "TaskId", "output_required": true, @@ -4149,7 +4136,7 @@ { "disabled": false, "document": "实例CPU", - "example": "", + "example": "1", "member": "int64", "name": "Cpu", "output_required": true, @@ -4159,7 +4146,7 @@ { "disabled": false, "document": "实例内存", - "example": "", + "example": "2", "member": "int64", "name": "Memory", "output_required": true, @@ -4169,7 +4156,7 @@ { "disabled": false, "document": "集群存储上限", - "example": "", + "example": "3000", "member": "int64", "name": "StorageLimit", "output_required": true, @@ -5190,7 +5177,7 @@ { "disabled": false, "document": "目标地域的备份任务ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1234", + "example": "182736", "member": "string", "name": "BackupId", "output_required": false, @@ -5282,7 +5269,7 @@ { "disabled": false, "document": "集群ID", - "example": "cynosmysql-xxxxxxxx", + "example": "cynosmysql-8sj2h3bx", "member": "string", "name": "ClusterId", "output_required": true, @@ -5293,7 +5280,7 @@ { "disabled": false, "document": "实例数", - "example": "1", + "example": "2", "member": "int64", "name": "InstanceNum", "output_required": true, @@ -5304,7 +5291,7 @@ { "disabled": false, "document": "用户uin\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "111111", + "example": "700000433509", "member": "string", "name": "Uin", "output_required": true, @@ -5326,7 +5313,7 @@ { "disabled": false, "document": "用户appid\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "111111", + "example": "251232125", "member": "int64", "name": "AppId", "output_required": true, @@ -5381,7 +5368,7 @@ { "disabled": false, "document": "集群读写vip\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1.1.1.1", + "example": "13.117.3.128", "member": "string", "name": "Vip", "output_required": true, @@ -5403,7 +5390,7 @@ { "disabled": false, "document": "项目id\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "0", + "example": "18263", "member": "int64", "name": "ProjectID", "output_required": true, @@ -5414,7 +5401,7 @@ { "disabled": false, "document": "私有网络ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "vpc-xxxxxxxx", + "example": "vpc-rhfuibtt", "member": "string", "name": "VpcId", "output_required": true, @@ -5425,7 +5412,7 @@ { "disabled": false, "document": "子网ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "subnet-xxxxxxxx", + "example": "subnet-87qviva4", "member": "string", "name": "SubnetId", "output_required": true, @@ -5535,7 +5522,7 @@ { "disabled": false, "document": "集群存储为预付费时的存储ID,用于预付费存储变配\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "cynosmysql-xxxxxxxx", + "example": "cynosmysql-8sj2h3bx", "member": "string", "name": "StorageId", "output_required": true, @@ -5590,7 +5577,7 @@ { "disabled": false, "document": "物理可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-singapore-3", "member": "string", "name": "PhysicalZone", "output_required": true, @@ -5601,7 +5588,7 @@ { "disabled": false, "document": "主可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-singapore-3", "member": "string", "name": "MasterZone", "output_required": true, @@ -5612,7 +5599,7 @@ { "disabled": false, "document": "是否有从可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "yes", "member": "string", "name": "HasSlaveZone", "output_required": true, @@ -5623,7 +5610,7 @@ { "disabled": false, "document": "从可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-singapore-4", "member": "string", "name": "SlaveZones", "output_required": true, @@ -5634,7 +5621,7 @@ { "disabled": false, "document": "商业类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "bus_a", "member": "string", "name": "BusinessType", "output_required": true, @@ -5645,7 +5632,7 @@ { "disabled": false, "document": "是否冻结\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no", "member": "string", "name": "IsFreeze", "output_required": true, @@ -5656,7 +5643,7 @@ { "disabled": false, "document": "订单来源\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "lhdb", "member": "string", "name": "OrderSource", "output_required": true, @@ -5695,7 +5682,7 @@ { "disabled": false, "document": "集群ID", - "example": "cynosdbmysql-xxx", + "example": "cynosdbmysql-8sj2h3bx", "member": "string", "name": "ClusterId", "output_required": true, @@ -5705,7 +5692,7 @@ { "disabled": false, "document": "集群名称", - "example": "cynosdbmysql-xxx", + "example": "cynosdbmysql-8sj2h3bx", "member": "string", "name": "ClusterName", "output_required": true, @@ -5775,7 +5762,7 @@ { "disabled": false, "document": "存储Id\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "123", + "example": "cynosdbmysql-8sj2h3bx", "member": "string", "name": "StorageId", "output_required": true, @@ -5785,7 +5772,7 @@ { "disabled": false, "document": "存储大小,单位为G\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "10", + "example": "200", "member": "int64", "name": "Storage", "output_required": true, @@ -5795,7 +5782,7 @@ { "disabled": false, "document": "最大存储规格,单位为G\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "10", + "example": "3000", "member": "int64", "name": "MaxStorageSize", "output_required": true, @@ -5805,7 +5792,7 @@ { "disabled": false, "document": "最小存储规格,单位为G\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "5", + "example": "10", "member": "int64", "name": "MinStorageSize", "output_required": true, @@ -5835,7 +5822,7 @@ { "disabled": false, "document": "vpc唯一id", - "example": "vpc-xxx", + "example": "vpc-4pbgx2ld", "member": "string", "name": "VpcId", "output_required": true, @@ -5855,7 +5842,7 @@ { "disabled": false, "document": "子网ID", - "example": "subnet-xxx", + "example": "subnet-a2emqb1d", "member": "string", "name": "SubnetId", "output_required": true, @@ -5875,7 +5862,7 @@ { "disabled": false, "document": "创建时间", - "example": "\"2021-05-25 19:23:31\"", + "example": "2021-05-25 19:23:31", "member": "string", "name": "CreateTime", "output_required": true, @@ -5935,7 +5922,7 @@ { "disabled": false, "document": "vip地址", - "example": "127.0.0.1", + "example": "10.36.173.27", "member": "string", "name": "Vip", "output_required": true, @@ -5985,7 +5972,7 @@ { "disabled": false, "document": "商业类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "bus_a", "member": "string", "name": "BusinessType", "output_required": true, @@ -6065,7 +6052,7 @@ { "disabled": false, "document": "到期时间", - "example": "\"2021-05-25 19:23:31\"", + "example": "2021-05-25 19:23:31", "member": "string", "name": "PeriodEndTime", "output_required": true, @@ -6075,7 +6062,7 @@ { "disabled": false, "document": "项目id", - "example": "0", + "example": "1623", "member": "int64", "name": "ProjectID", "output_required": true, @@ -6095,7 +6082,7 @@ { "disabled": false, "document": "Proxy状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "running", "member": "string", "name": "ProxyStatus", "output_required": true, @@ -6135,7 +6122,7 @@ { "disabled": false, "document": "是否打开密码复杂度\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "yes", "member": "string", "name": "IsOpenPasswordComplexity", "output_required": true, @@ -6175,7 +6162,7 @@ { "disabled": false, "document": "节点网络类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "whole_rdma", "member": "string", "name": "NetworkType", "output_required": false, @@ -6200,33 +6187,33 @@ "members": [ { "disabled": false, - "document": "日志时间戳\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "日志时间戳", "example": "0", "member": "int64", "name": "Timestamp", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "日志等级\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "日志等级", "example": "note", "member": "string", "name": "Level", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "日志内容\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "Aborted connection 562579 to db: 'unconnected' user: 'unauthenticated' host: '169.214.18.1' (Got an error reading communication packets)", + "document": "日志内容", + "example": "Aborted connection 5*9 to db: 'db1' user: 'andy' host: '169.214.18.1' (Got an error reading communication packets)", "member": "string", "name": "Content", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -6527,7 +6514,7 @@ { "disabled": false, "document": "网络类型", - "example": "无", + "example": "1", "member": "int64", "name": "NetType", "output_required": true, @@ -6537,7 +6524,7 @@ { "disabled": false, "document": "外网域名", - "example": "无", + "example": "cynosdbpg-bzkxxrmt.wan.domain.com", "member": "string", "name": "WanDomain", "output_required": true, @@ -6567,7 +6554,7 @@ { "disabled": false, "document": "外网状态", - "example": "无", + "example": "running", "member": "string", "name": "WanStatus", "output_required": true, @@ -6577,7 +6564,7 @@ { "disabled": false, "document": "实例销毁时间", - "example": "无", + "example": "2024-01-04 00:09:10", "member": "string", "name": "DestroyTime", "output_required": true, @@ -6667,7 +6654,7 @@ { "disabled": false, "document": "物理区", - "example": "无", + "example": "ap-guangzhou-3", "member": "string", "name": "PhysicalZone", "output_required": true, @@ -6677,7 +6664,7 @@ { "disabled": false, "document": "商业类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "bus_a", "member": "string", "name": "BusinessType", "output_required": true, @@ -6717,7 +6704,7 @@ { "disabled": false, "document": "主可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-guangzhou-3", "member": "string", "name": "MasterZone", "output_required": true, @@ -6727,7 +6714,7 @@ { "disabled": false, "document": "备可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-guangzhou-4", "member": "string", "name": "SlaveZones", "output_required": true, @@ -6777,7 +6764,7 @@ { "disabled": false, "document": "实例机器类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "exclusive", "member": "string", "name": "DeviceType", "output_required": false, @@ -6787,7 +6774,7 @@ { "disabled": false, "document": "实例存储类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "CLOUD_TCS/CLOUD_HSSD", "member": "string", "name": "InstanceStorageType", "output_required": false, @@ -6803,7 +6790,7 @@ { "disabled": false, "document": "用户Uin", - "example": "无", + "example": "1000***499845", "member": "string", "name": "Uin", "output_required": true, @@ -6813,7 +6800,7 @@ { "disabled": false, "document": "用户AppId", - "example": "无", + "example": "12510**243", "member": "int64", "name": "AppId", "output_required": true, @@ -6823,7 +6810,7 @@ { "disabled": false, "document": "集群ID", - "example": "无", + "example": "cynosdbmysql-5ne6bjyx", "member": "string", "name": "ClusterId", "output_required": true, @@ -6833,7 +6820,7 @@ { "disabled": false, "document": "集群名称", - "example": "无", + "example": "cynosdbmysql-5ne6bjyx", "member": "string", "name": "ClusterName", "output_required": true, @@ -6843,7 +6830,7 @@ { "disabled": false, "document": "实例ID", - "example": "无", + "example": "cynosdbmysql-ins-bzkxxrmt", "member": "string", "name": "InstanceId", "output_required": true, @@ -6853,7 +6840,7 @@ { "disabled": false, "document": "实例名称", - "example": "无", + "example": "cynosdbmysql-ins-bzkxxrmt", "member": "string", "name": "InstanceName", "output_required": true, @@ -6863,7 +6850,7 @@ { "disabled": false, "document": "项目ID", - "example": "无", + "example": "0", "member": "int64", "name": "ProjectId", "output_required": true, @@ -6873,7 +6860,7 @@ { "disabled": false, "document": "地域", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, @@ -6883,7 +6870,7 @@ { "disabled": false, "document": "可用区", - "example": "无", + "example": "ap-guangzhou-3", "member": "string", "name": "Zone", "output_required": true, @@ -6893,7 +6880,7 @@ { "disabled": false, "document": "实例状态", - "example": "无", + "example": "running", "member": "string", "name": "Status", "output_required": true, @@ -6903,7 +6890,7 @@ { "disabled": false, "document": "实例状态中文描述", - "example": "无", + "example": "运行中", "member": "string", "name": "StatusDesc", "output_required": true, @@ -6913,7 +6900,7 @@ { "disabled": false, "document": "serverless实例状态, 可能值:\nresume\npause", - "example": "无", + "example": "resume", "member": "string", "name": "ServerlessStatus", "output_required": true, @@ -6923,7 +6910,7 @@ { "disabled": false, "document": "数据库类型", - "example": "无", + "example": "MYSQL", "member": "string", "name": "DbType", "output_required": true, @@ -6933,7 +6920,7 @@ { "disabled": false, "document": "数据库版本", - "example": "无", + "example": "5.7", "member": "string", "name": "DbVersion", "output_required": true, @@ -6943,7 +6930,7 @@ { "disabled": false, "document": "Cpu,单位:核", - "example": "无", + "example": "2", "member": "int64", "name": "Cpu", "output_required": true, @@ -6953,7 +6940,7 @@ { "disabled": false, "document": "内存,单位:GB", - "example": "无", + "example": "4", "member": "int64", "name": "Memory", "output_required": true, @@ -6963,7 +6950,7 @@ { "disabled": false, "document": "存储量,单位:GB", - "example": "无", + "example": "100", "member": "int64", "name": "Storage", "output_required": true, @@ -6973,7 +6960,7 @@ { "disabled": false, "document": "实例类型", - "example": "无", + "example": "rw", "member": "string", "name": "InstanceType", "output_required": true, @@ -6983,7 +6970,7 @@ { "disabled": false, "document": "实例当前角色", - "example": "无", + "example": "master", "member": "string", "name": "InstanceRole", "output_required": true, @@ -6993,7 +6980,7 @@ { "disabled": false, "document": "更新时间", - "example": "无", + "example": "2024-06-20 19:12:54", "member": "datetime", "name": "UpdateTime", "output_required": true, @@ -7003,7 +6990,7 @@ { "disabled": false, "document": "创建时间", - "example": "无", + "example": "2024-05-20 19:12:54", "member": "datetime", "name": "CreateTime", "output_required": true, @@ -7013,7 +7000,7 @@ { "disabled": false, "document": "付费模式", - "example": "无", + "example": "0", "member": "int64", "name": "PayMode", "output_required": true, @@ -7023,7 +7010,7 @@ { "disabled": false, "document": "实例过期时间", - "example": "无", + "example": "2024-07-20 19:17:16", "member": "datetime", "name": "PeriodEndTime", "output_required": true, @@ -7033,7 +7020,7 @@ { "disabled": false, "document": "网络类型", - "example": "无", + "example": "1", "member": "int64", "name": "NetType", "output_required": true, @@ -7043,7 +7030,7 @@ { "disabled": false, "document": "VPC网络ID", - "example": "无", + "example": "vpc-1ptuei0b", "member": "string", "name": "VpcId", "output_required": true, @@ -7053,7 +7040,7 @@ { "disabled": false, "document": "子网ID", - "example": "无", + "example": "subnet-1tmw9t4o", "member": "string", "name": "SubnetId", "output_required": true, @@ -7063,7 +7050,7 @@ { "disabled": false, "document": "实例内网IP", - "example": "无", + "example": "10.0.1.2", "member": "string", "name": "Vip", "output_required": true, @@ -7073,7 +7060,7 @@ { "disabled": false, "document": "实例内网端口", - "example": "无", + "example": "5432", "member": "int64", "name": "Vport", "output_required": true, @@ -7083,7 +7070,7 @@ { "disabled": false, "document": "实例外网域名", - "example": "无", + "example": "cynosdbpg-bzkxxrmt.wan.domain.com", "member": "string", "name": "WanDomain", "output_required": true, @@ -7093,7 +7080,7 @@ { "disabled": false, "document": "字符集", - "example": "无", + "example": "utf8", "member": "string", "name": "Charset", "output_required": true, @@ -7103,7 +7090,7 @@ { "disabled": false, "document": "Cynos内核版本", - "example": "无", + "example": "2.0.12", "member": "string", "name": "CynosVersion", "output_required": true, @@ -7113,7 +7100,7 @@ { "disabled": false, "document": "续费标志", - "example": "无", + "example": "0", "member": "int64", "name": "RenewFlag", "output_required": true, @@ -7123,7 +7110,7 @@ { "disabled": false, "document": "serverless实例cpu下限", - "example": "无", + "example": "1.0", "member": "float", "name": "MinCpu", "output_required": true, @@ -7133,7 +7120,7 @@ { "disabled": false, "document": "serverless实例cpu上限", - "example": "无", + "example": "2.0", "member": "float", "name": "MaxCpu", "output_required": true, @@ -7142,13 +7129,13 @@ }, { "disabled": false, - "document": "Db类型:<li>NORMAL</li><li>SERVERLESS</li>\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "Db类型:<li>NORMAL</li><li>SERVERLESS</li>", "example": "NORMAL", "member": "string", "name": "DbMode", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -7218,7 +7205,7 @@ }, { "disabled": false, - "document": "实例组类型。ha-ha组;ro-只读组", + "document": "实例组(网络)类型。ha-ha组;ro-只读组;proxy-代理;singleRo-只读实例独占", "example": "无", "member": "string", "name": "Type", @@ -7835,7 +7822,7 @@ { "disabled": false, "document": "实例ID", - "example": "cynosdbmysql-ins-xx", + "example": "cynosdbmysql-ins-4vdteidd", "member": "string", "name": "InstanceId", "required": true, @@ -7844,7 +7831,7 @@ { "disabled": false, "document": "审计日志文件名称。", - "example": "\"test.csv\"", + "example": "\"andy.csv\"", "member": "string", "name": "FileName", "required": true, @@ -8105,7 +8092,7 @@ { "disabled": false, "document": "账号信息", - "example": "无", + "example": "{\"AccountName\": \"andy\",\"Host\": \"%\"}", "member": "InputAccount", "name": "Account", "required": true, @@ -8120,7 +8107,7 @@ { "disabled": false, "document": "权限语句\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": " [\"GRANT CREATE, ALTER ON *.* TO 'andy'@'%'\",\"GRANT DROP, EXECUTE ON `andy1`.* TO 'andy'@'%'\",\"GRANT UPDATE, SHOW VIEW ON `andy2`.`user1` TO 'andy'@'%'\"]", "member": "string", "name": "PrivilegeStatements", "output_required": true, @@ -8130,7 +8117,7 @@ { "disabled": false, "document": "全局权限\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"CREATE\",\"ALTER\"]", "member": "string", "name": "GlobalPrivileges", "output_required": true, @@ -8140,7 +8127,7 @@ { "disabled": false, "document": "数据库权限\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[{\"Db\": \"db1\",\"Privileges\": [\"DROP\",\"EXECUTE\"]}]", "member": "DatabasePrivileges", "name": "DatabasePrivileges", "output_required": true, @@ -8150,7 +8137,7 @@ { "disabled": false, "document": "数据库表权限\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[{\"Db\": \"db1\",\"Privileges\": [\"UPDATE\",\"SHOW VIEW\"],\"TableName\": \"user1\"}]", "member": "TablePrivileges", "name": "TablePrivileges", "output_required": true, @@ -8172,7 +8159,7 @@ { "disabled": false, "document": "集群id", - "example": "cynosmysql-xxxxxxxx", + "example": "cynosdbmysql-j9i41hfv", "member": "string", "name": "ClusterId", "required": true, @@ -8199,7 +8186,7 @@ { "disabled": false, "document": "数据库名,为*时,忽略Type/TableName, 表示修改用户全局权限;", - "example": "testDb", + "example": "Db1", "member": "string", "name": "Db", "required": true, @@ -8217,7 +8204,7 @@ { "disabled": false, "document": "当Type=\"table\"时,用来指定表名", - "example": "testTable", + "example": "Table1", "member": "string", "name": "TableName", "required": false, @@ -8511,7 +8498,7 @@ "members": [ { "disabled": false, - "document": "实例ID", + "document": "实例 ID。", "example": "cynosdbmysql-ins-xx", "member": "string", "name": "InstanceId", @@ -8574,7 +8561,7 @@ }, { "disabled": false, - "document": "分页偏移量。", + "document": "分页偏移量。\n说明:Limit 和 Offset 的取值之和需小于等于65536。", "example": "0", "member": "int64", "name": "Offset", @@ -9029,7 +9016,7 @@ { "disabled": false, "document": "是否跨地域备份", - "example": "无", + "example": "yes", "member": "string", "name": "IsCrossRegionsBackup", "required": false, @@ -9054,7 +9041,7 @@ { "disabled": false, "document": "备份文件列表", - "example": "无", + "example": "[{ \"BackupId\": 1951161,\"BackupMethod\": \"auto\",\"BackupName\": \"\",\"BackupStatus\": \"success\",\"BackupType\": \"logic\",\"FileName\": \"20241114022138\",\"FileSize\": 1715049,\"FinishTime\": \"2024-11-14 02:22:20\",\"SnapShotType\": \"full\",\"SnapshotId\": 1951161,\"SnapshotTime\": \"2024-11-14 02:21:38\",\"StartTime\": \"2024-11-14 02:21:38\"}]", "member": "BackupFileInfo", "name": "BackupList", "output_required": true, @@ -10884,7 +10871,7 @@ { "disabled": false, "document": "搜索条件,若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。", - "example": "无", + "example": "[{\"Names\": \"ProjectId\",\"Values\": \"andy\",\"ExactMatch\": \"1\",\"Name\": \"172\",\"Operator\": \"27627162\"}]", "member": "QueryFilter", "name": "Filters", "required": false, @@ -10918,7 +10905,7 @@ { "disabled": false, "document": "实例列表", - "example": "无", + "example": "[ { \"AppId\": 1311111346, \"BusinessType\": \"\", \"ClusterId\": \"cynosdbmysql-grhvkwd\", \"ClusterName\": \"cynosdbmysql-grhvkwd\", \"Cpu\": 2, \"CreateTime\": \"2024-12-03 14:03:58\", \"CynosVersion\": \"2.1.13.001\", \"DbMode\": \"NORMAL\", \"DbType\": \"MYSQL\", \"DbVersion\": \"5.7\", \"DestroyDeadlineText\": \"<7 天\", \"DestroyTime\": \"2024-12-30 19:51:33\", \"DeviceType\": \"exclusive\", \"InstanceAbility\": { \"IsSupportForceRestart\": \"no\", \"NonsupportForceRestartReason\": \"NoForcedRestartAllowed\" }, \"InstanceId\": \"cynosdbmysql-ins-crl6j3l\", \"InstanceIndexMode\": \"onlyRowIndex\", \"InstanceName\": \"cynosdbmysql-ins-crl6j3l\", \"InstanceNetInfo\": [ { \"InstanceGroupId\": \"cynosdbmysql-grp-r7hmdx4\", \"InstanceGroupType\": \"ha\", \"NetType\": 1, \"SubnetId\": \"subnet-oiz56c8\", \"Vip\": \"172.0.0.2\", \"VpcId\": \"vpc-gy34uq2\", \"Vport\": 3306, \"WanDomain\": \"\", \"WanIP\": \"\", \"WanPort\": 0, \"WanStatus\": \"init\" } ], \"InstanceRole\": \"master\", \"InstanceStorageType\": \"\", \"InstanceType\": \"rw\", \"IsFreeze\": \"no\", \"IsolateTime\": \"2024-12-23 19:51:33\", \"MasterZone\": \"ap-chongqing-1\", \"MaxCpu\": 0, \"Memory\": 4, \"MinCpu\": 0, \"NetType\": 1, \"PayMode\": 1, \"PeriodEndTime\": \"2024-12-23 19:51:24\", \"PhysicalZone\": \"ap-chongqing-1\", \"ProcessingTask\": \"\", \"ProjectId\": 0, \"Region\": \"ap-chongqing\", \"RenewFlag\": 1, \"ResourcePackages\": null, \"ResourceTags\": null, \"ServerlessStatus\": \"\", \"SlaveZones\": [], \"Status\": \"isolated\", \"StatusDesc\": \"已隔离\", \"Storage\": 10, \"StorageId\": \"cynosdbmysql-grhvkwd\", \"StoragePayMode\": 1, \"SubnetId\": \"subnet-oiz56c8\", \"Tasks\": [], \"Uin\": \"100011147054\", \"UpdateTime\": \"2024-12-23 19:51:33\", \"Vip\": \"172.0.0.2\", \"VpcId\": \"vpc-gy34uq2\", \"Vport\": 3306, \"WanDomain\": \"\", \"WanIP\": \"\", \"WanPort\": 0, \"WanStatus\": \"init\", \"Zone\": \"ap-chongqing-1\" }, { \"AppId\": 1311111346, \"BusinessType\": \"\", \"ClusterId\": \"cynosdbmysql-grhvkwd\", \"ClusterName\": \"cynosdbmysql-grhvkwd\", \"Cpu\": 2, \"CreateTime\": \"2024-12-03 14:03:58\", \"CynosVersion\": \"2.1.13.001\", \"DbMode\": \"NORMAL\", \"DbType\": \"MYSQL\", \"DbVersion\": \"5.7\", \"DestroyDeadlineText\": \"<7 天\", \"DestroyTime\": \"2024-12-30 19:51:33\", \"DeviceType\": \"exclusive\", \"InstanceAbility\": { \"IsSupportForceRestart\": \"no\", \"NonsupportForceRestartReason\": \"NoForcedRestartAllowed\" }, \"InstanceId\": \"cynosdbmysql-ins-6t9ynb7\", \"InstanceIndexMode\": \"onlyRowIndex\", \"InstanceName\": \"cynosdbmysql-ins-6t9ynb7\", \"InstanceNetInfo\": [ { \"InstanceGroupId\": \"cynosdbmysql-grp-08o6vj0\", \"InstanceGroupType\": \"singleRo\", \"NetType\": 1, \"SubnetId\": \"subnet-oiz56c8\", \"Vip\": \"172.0.0.7\", \"VpcId\": \"vpc-gy34uq2\", \"Vport\": 3306, \"WanDomain\": \"\", \"WanIP\": \"\", \"WanPort\": 0, \"WanStatus\": \"init\" } ], \"InstanceRole\": \"ro\", \"InstanceStorageType\": \"\", \"InstanceType\": \"ro\", \"IsFreeze\": \"no\", \"IsolateTime\": \"2024-12-23 19:51:33\", \"MasterZone\": \"ap-chongqing-1\", \"MaxCpu\": 0, \"Memory\": 4, \"MinCpu\": 0, \"NetType\": 1, \"PayMode\": 1, \"PeriodEndTime\": \"2024-12-23 19:51:24\", \"PhysicalZone\": \"ap-chongqing-1\", \"ProcessingTask\": \"\", \"ProjectId\": 0, \"Region\": \"ap-chongqing\", \"RenewFlag\": 1, \"ResourcePackages\": null, \"ResourceTags\": null, \"ServerlessStatus\": \"\", \"SlaveZones\": [], \"Status\": \"isolated\", \"StatusDesc\": \"已隔离\", \"Storage\": 10, \"StorageId\": \"cynosdbmysql-grhvkwd\", \"StoragePayMode\": 1, \"SubnetId\": \"subnet-oiz56c8\", \"Tasks\": [], \"Uin\": \"100011147054\", \"UpdateTime\": \"2024-12-23 19:51:33\", \"Vip\": \"172.0.0.7\", \"VpcId\": \"vpc-gy34uq2\", \"Vport\": 3306, \"WanDomain\": \"\", \"WanIP\": \"\", \"WanPort\": 0, \"WanStatus\": \"init\", \"Zone\": \"ap-chongqing-1\" } ]", "member": "CynosdbInstance", "name": "InstanceSet", "output_required": true, @@ -11148,7 +11135,7 @@ { "disabled": false, "document": "查询的模板对应的产品类型", - "example": "无", + "example": "[\"cynosdb\"]", "member": "string", "name": "Products", "required": false, @@ -11157,7 +11144,7 @@ { "disabled": false, "document": "模板类型", - "example": "无", + "example": "[\"NORMAL_HIGH_STABILITY\"]", "member": "string", "name": "TemplateTypes", "required": false, @@ -11166,7 +11153,7 @@ { "disabled": false, "document": "版本类型", - "example": "无", + "example": "[\"InnoDB\"]", "member": "string", "name": "EngineTypes", "required": false, @@ -12751,7 +12738,7 @@ { "disabled": false, "document": "账号信息", - "example": "无", + "example": "{\"AccountName\": \"andy\",\"Host\": \"%\"}", "member": "InputAccount", "name": "Account", "required": true, @@ -12769,7 +12756,7 @@ { "disabled": false, "document": "数据库表信息", - "example": "无", + "example": "[{\"TableName\": \"tb-tb1\",\"Db\": \"db-db1\"}]", "member": "DbTable", "name": "DbTables", "required": true, @@ -13657,7 +13644,7 @@ { "disabled": false, "document": "私有网络IP\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "123.123.123.1", + "example": "172.1.1.1", "member": "string", "name": "Vip", "output_required": true, @@ -13667,7 +13654,7 @@ { "disabled": false, "document": "私有网络端口\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1234", + "example": "3306", "member": "int64", "name": "Vport", "output_required": true, @@ -13697,7 +13684,7 @@ { "disabled": false, "document": "外网端口\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "12345", + "example": "5433", "member": "int64", "name": "WanPort", "output_required": true, @@ -13907,7 +13894,7 @@ { "disabled": false, "document": "退款订单号(预付费资源返回,如果需要同步订单状态,请使用计费产品的DescribeDealsByCond同步订单状态)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[\"134\"]", + "example": "[\"20241226054077125855171\"]", "member": "string", "name": "DealNames", "output_required": true, @@ -14022,7 +14009,7 @@ { "disabled": false, "document": "规则模板名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "test_rule", + "example": "andy_rule", "member": "string", "name": "RuleTemplateName", "output_required": false, @@ -14130,7 +14117,7 @@ { "disabled": false, "document": "备份类型。snapshot-快照备份", - "example": "无", + "example": "snapshot", "member": "string", "name": "BackupType", "output_required": true, @@ -14140,7 +14127,7 @@ { "disabled": false, "document": "备份方式。auto-自动备份,manual-手动", - "example": "无", + "example": "manual", "member": "string", "name": "BackupMethod", "output_required": true, @@ -14150,7 +14137,7 @@ { "disabled": false, "document": "备份时间", - "example": "无", + "example": "2023-11-03 15:27:22", "member": "string", "name": "SnapshotTime", "output_required": true, @@ -14300,7 +14287,7 @@ { "disabled": false, "document": "账号信息", - "example": "无", + "example": "{\"AccountName\": \"andy\",\"Host\": \"%\"}", "member": "InputAccount", "name": "Account", "required": true, @@ -14309,7 +14296,7 @@ { "disabled": false, "document": "数据库表权限数组,当前仅支持参数:max_user_connections,max_user_connections不能大于10240", - "example": "无", + "example": "[{\"ParamName\":\"max_user_connections\",\"ParamValue\":\"400\"}]", "member": "AccountParam", "name": "AccountParams", "required": true, @@ -14345,7 +14332,7 @@ { "disabled": false, "document": "账号信息", - "example": "无", + "example": "{\"AccountName\": \"andy\",\"Host\": \"%\"}", "member": "InputAccount", "name": "Account", "required": true, @@ -14507,7 +14494,7 @@ { "disabled": false, "document": "规则审计。", - "example": "无", + "example": "[\"RuleFilters\": [{\"Type\": \"sqlType\",\"Compare\": \"INC\",\"Value\": \"UPDATE\"}]]", "member": "AuditRuleFilters", "name": "AuditRuleFilters", "required": false, @@ -14516,7 +14503,7 @@ { "disabled": false, "document": "规则模板ID。", - "example": "无", + "example": "[\"cynosdb-art-c1jo4111\"]", "member": "string", "name": "RuleTemplateIds", "required": false, @@ -15188,7 +15175,7 @@ { "disabled": false, "document": "修改前版本", - "example": "", + "example": "3.1.11", "member": "string", "name": "OldVersion", "output_required": true, @@ -15198,7 +15185,7 @@ { "disabled": false, "document": "修改后版本", - "example": "", + "example": "3.1.13", "member": "string", "name": "NewVersion", "output_required": true, @@ -15208,7 +15195,7 @@ { "disabled": false, "document": "升级方式", - "example": "", + "example": "upgradeInMaintain", "member": "string", "name": "UpgradeType", "output_required": true, @@ -15224,7 +15211,7 @@ { "disabled": false, "document": "变配后CPU", - "example": "无", + "example": "2", "member": "int64", "name": "Cpu", "output_required": true, @@ -15234,7 +15221,7 @@ { "disabled": false, "document": "变配后内存", - "example": "无", + "example": "4", "member": "int64", "name": "Memory", "output_required": true, @@ -15244,7 +15231,7 @@ { "disabled": false, "document": "变配后存储上限", - "example": "无", + "example": "156000", "member": "int64", "name": "StorageLimit", "output_required": true, @@ -15254,7 +15241,7 @@ { "disabled": false, "document": "变配前CPU", - "example": "无", + "example": "1", "member": "int64", "name": "OldCpu", "output_required": true, @@ -15264,7 +15251,7 @@ { "disabled": false, "document": "变配前内存", - "example": "无", + "example": "2", "member": "int64", "name": "OldMemory", "output_required": true, @@ -15274,7 +15261,7 @@ { "disabled": false, "document": "变配前存储上限", - "example": "无", + "example": "100000", "member": "int64", "name": "OldStorageLimit", "output_required": true, @@ -15284,7 +15271,7 @@ { "disabled": false, "document": "变配前实例机器类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "exclusive", "member": "string", "name": "OldDeviceType", "output_required": false, @@ -15294,7 +15281,7 @@ { "disabled": false, "document": "变配后实例机器类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "exclusive", "member": "string", "name": "DeviceType", "output_required": false, @@ -15304,7 +15291,7 @@ { "disabled": false, "document": "升级方式。升级完成后切换或维护时间内切换", - "example": "无", + "example": "upgradeInMaintain", "member": "string", "name": "UpgradeType", "output_required": true, @@ -16300,7 +16287,7 @@ { "disabled": false, "document": "子网ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "subnet-cnhsb8iu", "member": "string", "name": "UniqSubnetId", "output_required": true, @@ -16311,7 +16298,7 @@ { "disabled": false, "document": "私有网络ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "vpc-iskx6ygc", "member": "string", "name": "UniqVpcId", "output_required": true, @@ -16322,7 +16309,7 @@ { "disabled": false, "document": "描述信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "andyvpc", "member": "string", "name": "Description", "output_required": true, @@ -16333,7 +16320,7 @@ { "disabled": false, "document": "外网IP\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "3.45.1.9", "member": "string", "name": "WanIP", "output_required": true, @@ -16344,7 +16331,7 @@ { "disabled": false, "document": "外网状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "init", "member": "string", "name": "WanStatus", "output_required": true, @@ -16355,7 +16342,7 @@ { "disabled": false, "document": "实例组ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cynosdbpg-grp-sbh6ywhs", "member": "string", "name": "InstanceGroupId", "output_required": true, @@ -16434,7 +16421,7 @@ { "disabled": false, "document": "任务类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "taskAutoBackup", "member": "string", "name": "TaskType", "output_required": true, @@ -16445,7 +16432,7 @@ { "disabled": false, "document": "任务状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "processing", "member": "string", "name": "TaskStatus", "output_required": true, @@ -16456,7 +16443,7 @@ { "disabled": false, "document": "任务ID(集群ID|实例组ID|实例ID)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cynosdbmysql-sgvwu2is", "member": "string", "name": "ObjectId", "output_required": true, @@ -16467,7 +16454,7 @@ { "disabled": false, "document": "任务类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "taskObjTypeCluster", "member": "string", "name": "ObjectType", "output_required": true, @@ -16567,30 +16554,30 @@ { "disabled": false, "document": "IP\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "172.1.1.1", "member": "string", "name": "Vip", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "端口\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "3306", "member": "int64", "name": "Vport", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "期望执行回收时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "24", "member": "string", "name": "ReturnTime", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -17158,7 +17145,7 @@ { "disabled": false, "document": "AppId账户ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "123456789", + "example": "13376**563", "member": "int64", "name": "AppId", "output_required": true, @@ -17228,7 +17215,7 @@ { "disabled": false, "document": "扩展信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{\\\"ClusterId\\\":\\\"cynosdbmysql-i58mvikj\\\",\\\"RequestId\\\":\\\"1724306460000666497_c7bedc2d-3454-4fe9-9768-335a9901f10f\\\"}", "member": "string", "name": "ExtendInfo", "output_required": true, @@ -17358,7 +17345,7 @@ { "disabled": false, "document": "参数的可选枚举值。如果为非枚举值,则为空\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"ON\",\"OFF\"]", "member": "string", "name": "EnumValue", "output_required": true, @@ -17388,7 +17375,7 @@ { "disabled": false, "document": "匹配目标值,当multiVal时,各个key用,分割", - "example": "无", + "example": "sql", "member": "string", "name": "MatchValue", "output_required": true, @@ -17408,7 +17395,7 @@ { "disabled": false, "document": "参数设置为公式时,Func返回设置的公式内容\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{MIN(DBInitMemory/%d*%d,%d)},1000,4194304,134217728", "member": "string", "name": "Func", "output_required": true, @@ -17428,7 +17415,7 @@ { "disabled": false, "document": "支持公式的参数的默认公式样式\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{MAX(DBInitCpu/%d,%d)},2,4", + "example": "{MIN(DBInitMemory/%d*%d,%d)},1000,4194304,134217728", "member": "string", "name": "FuncPattern", "output_required": true, @@ -17444,7 +17431,7 @@ { "disabled": false, "document": "当前值", - "example": "无", + "example": "1", "member": "string", "name": "CurrentValue", "output_required": true, @@ -17454,7 +17441,7 @@ { "disabled": false, "document": "默认值", - "example": "无", + "example": "1", "member": "string", "name": "Default", "output_required": true, @@ -17464,7 +17451,7 @@ { "disabled": false, "document": "参数为enum/string/bool时,可选值列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"ON\",\"OFF\"]", "member": "string", "name": "EnumValue", "output_required": true, @@ -17474,7 +17461,7 @@ { "disabled": false, "document": "参数类型为float/integer时的最大值", - "example": "无", + "example": "65535", "member": "string", "name": "Max", "output_required": true, @@ -17484,7 +17471,7 @@ { "disabled": false, "document": "参数类型为float/integer时的最小值", - "example": "无", + "example": "1", "member": "string", "name": "Min", "output_required": true, @@ -17494,7 +17481,7 @@ { "disabled": false, "document": "参数名称", - "example": "无", + "example": "auto_increment_increment", "member": "string", "name": "ParamName", "output_required": true, @@ -17504,7 +17491,7 @@ { "disabled": false, "document": "是否需要重启生效", - "example": "无", + "example": "false", "member": "int64", "name": "NeedReboot", "output_required": true, @@ -17514,7 +17501,7 @@ { "disabled": false, "document": "参数类型:integer/float/string/enum/bool", - "example": "无", + "example": "integer", "member": "string", "name": "ParamType", "output_required": true, @@ -17524,7 +17511,7 @@ { "disabled": false, "document": "匹配类型,multiVal, regex在参数类型是string时使用", - "example": "无", + "example": "regex", "member": "string", "name": "MatchType", "output_required": true, @@ -17534,7 +17521,7 @@ { "disabled": false, "document": "匹配目标值,当multiVal时,各个key用;分割", - "example": "无", + "example": "sql", "member": "string", "name": "MatchValue", "output_required": true, @@ -17544,7 +17531,7 @@ { "disabled": false, "document": "参数描述", - "example": "无", + "example": "Controls the interval between successive column values.", "member": "string", "name": "Description", "output_required": true, @@ -17554,7 +17541,7 @@ { "disabled": false, "document": "是否为全局参数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "IsGlobal", "output_required": true, @@ -17574,7 +17561,7 @@ { "disabled": false, "document": "是否为函数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "false", "member": "bool", "name": "IsFunc", "output_required": true, @@ -17584,7 +17571,7 @@ { "disabled": false, "document": "函数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{MIN(DBInitMemory/%d*%d,%d)},4000,32768,2097152", "member": "string", "name": "Func", "output_required": true, @@ -17594,7 +17581,7 @@ { "disabled": false, "document": "支持公式的参数的默认公式样式\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{MIN(DBInitMemory/%d*%d,%d)},4000,32768,2097152", "member": "string", "name": "FuncPattern", "output_required": false, @@ -17643,7 +17630,7 @@ { "disabled": false, "document": "当前值", - "example": "无", + "example": "1", "member": "string", "name": "CurrentValue", "output_required": true, @@ -17653,7 +17640,7 @@ { "disabled": false, "document": "默认值", - "example": "无", + "example": "1", "member": "string", "name": "Default", "output_required": true, @@ -17663,7 +17650,7 @@ { "disabled": false, "document": "参数的可选枚举值。如果为非枚举值,则为空", - "example": "无", + "example": "[\"ON\",\"OFF\"]", "member": "string", "name": "EnumValue", "output_required": true, @@ -17673,7 +17660,7 @@ { "disabled": false, "document": "1:全局参数,0:非全局参数", - "example": "无", + "example": "1", "member": "int64", "name": "IsGlobal", "output_required": true, @@ -17683,7 +17670,7 @@ { "disabled": false, "document": "最大值", - "example": "无", + "example": "65535", "member": "string", "name": "Max", "output_required": true, @@ -17693,7 +17680,7 @@ { "disabled": false, "document": "最小值", - "example": "无", + "example": "1", "member": "string", "name": "Min", "output_required": true, @@ -17703,7 +17690,7 @@ { "disabled": false, "document": "修改参数后,是否需要重启数据库以使参数生效。0-不需要重启,1-需要重启。", - "example": "无", + "example": "0", "member": "int64", "name": "NeedReboot", "output_required": true, @@ -17713,7 +17700,7 @@ { "disabled": false, "document": "参数名称", - "example": "无", + "example": "auto_increment_increment", "member": "string", "name": "ParamName", "output_required": true, @@ -17723,7 +17710,7 @@ { "disabled": false, "document": "参数类型:integer,enum,float,string,func", - "example": "无", + "example": "integer", "member": "string", "name": "ParamType", "output_required": true, @@ -17733,7 +17720,7 @@ { "disabled": false, "document": "参数描述", - "example": "无", + "example": "Controls the interval between successive column values.", "member": "string", "name": "Description", "output_required": true, @@ -17743,7 +17730,7 @@ { "disabled": false, "document": "类型是否为公式\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "false", "member": "bool", "name": "IsFunc", "output_required": true, @@ -17753,7 +17740,7 @@ { "disabled": false, "document": "参数配置公式\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{MIN(DBInitMemory/%d*%d,%d)},4000,32768,2097152", "member": "string", "name": "Func", "output_required": true, @@ -17763,7 +17750,7 @@ { "disabled": false, "document": "支持公式的参数的默认公式样式\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{MIN(DBInitMemory/%d*%d,%d)},4000,32768,2097152", "member": "string", "name": "FuncPattern", "output_required": true, @@ -17779,7 +17766,7 @@ { "disabled": false, "document": "参数名字\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "binlog_cache_size", "member": "string", "name": "ParamName", "output_required": false, @@ -17789,7 +17776,7 @@ { "disabled": false, "document": "参数新值\n\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "32780", "member": "string", "name": "NewValue", "output_required": false, @@ -17799,7 +17786,7 @@ { "disabled": false, "document": "参数旧值\n\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "32768", "member": "string", "name": "OldValue", "output_required": false, @@ -17809,7 +17796,7 @@ { "disabled": false, "document": "参数公式\n\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{MIN(DBInitMemory/%d*%d,%d)},4000,32768,2097152", "member": "string", "name": "ValueFunction", "output_required": false, @@ -18062,90 +18049,90 @@ { "disabled": false, "document": "数据库代理组ID", - "example": "无", + "example": "cynosdbmysql-proxy-mdhg55su", "member": "string", "name": "ProxyGroupId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "数据库代理组节点个数", - "example": "0", + "example": "3", "member": "int64", "name": "ProxyNodeCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "数据库代理组状态", - "example": "无", + "example": "running", "member": "string", "name": "Status", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "地域", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "可用区", - "example": "无", + "example": "ap-guangzhou-2", "member": "string", "name": "Zone", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "当前代理版本", - "example": "无", + "example": "1.3.11", "member": "string", "name": "CurrentProxyVersion", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "集群ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cynosdbmysql-i2weamox", "member": "string", "name": "ClusterId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "用户AppId\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1772344699", "member": "int64", "name": "AppId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "读写节点开通数据库代理\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "yes", "member": "string", "name": "OpenRw", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -18224,9 +18211,10 @@ { "disabled": false, "document": "一致性类型 eventual-最终一致性,global-全局一致性,session-会话一致性", - "example": "无", + "example": "eventual", "member": "string", "name": "ConsistencyType", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -18234,9 +18222,10 @@ { "disabled": false, "document": "一致性超时时间", - "example": "无", + "example": "0", "member": "int64", "name": "ConsistencyTimeOut", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -18244,9 +18233,10 @@ { "disabled": false, "document": "权重模式 system-系统分配,custom-自定义", - "example": "无", + "example": "system", "member": "string", "name": "WeightMode", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -18254,9 +18244,10 @@ { "disabled": false, "document": "是否开启故障转移", - "example": "无", + "example": "no", "member": "string", "name": "FailOver", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -18264,9 +18255,10 @@ { "disabled": false, "document": "是否自动添加只读实例,yes-是,no-不自动添加", - "example": "无", + "example": "no", "member": "string", "name": "AutoAddRo", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -18277,6 +18269,7 @@ "example": "无", "member": "ProxyInstanceWeight", "name": "InstanceWeights", + "output_required": true, "required": false, "type": "list", "value_allowed_null": false @@ -18284,9 +18277,10 @@ { "disabled": false, "document": "是否开通读写节点,yse-是,no-否\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "yes", "member": "string", "name": "OpenRw", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -18294,9 +18288,10 @@ { "disabled": false, "document": "读写属性,可选值:READWRITE,READONLY", - "example": "无", + "example": "READONLY", "member": "string", "name": "RwType", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -18304,9 +18299,10 @@ { "disabled": false, "document": "事务拆分", - "example": "无", + "example": "false", "member": "bool", "name": "TransSplit", + "output_required": true, "required": false, "type": "bool", "value_allowed_null": false @@ -18314,9 +18310,10 @@ { "disabled": false, "document": "连接模式,可选值:balance,nearby", - "example": "无", + "example": "balance", "member": "string", "name": "AccessMode", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -18358,7 +18355,7 @@ { "disabled": false, "document": "数据库代理节点ID", - "example": "无", + "example": "cynosdbmysql-proxyNode-pv4hg4na", "member": "string", "name": "ProxyNodeId", "output_required": true, @@ -18368,7 +18365,7 @@ { "disabled": false, "document": "节点当前连接数, DescribeProxyNodes接口此字段值不返回", - "example": "无", + "example": "157", "member": "int64", "name": "ProxyNodeConnections", "output_required": true, @@ -18378,7 +18375,7 @@ { "disabled": false, "document": "数据库代理节点cpu", - "example": "无", + "example": "2", "member": "int64", "name": "Cpu", "output_required": true, @@ -18388,7 +18385,7 @@ { "disabled": false, "document": "数据库代理节点内存", - "example": "无", + "example": "4000", "member": "int64", "name": "Mem", "output_required": true, @@ -18398,7 +18395,7 @@ { "disabled": false, "document": "数据库代理节点状态", - "example": "无", + "example": "running", "member": "string", "name": "Status", "output_required": true, @@ -18408,7 +18405,7 @@ { "disabled": false, "document": "数据库代理组ID", - "example": "无", + "example": "cynosdbmysql-proxy-mdhg57su", "member": "string", "name": "ProxyGroupId", "output_required": true, @@ -18418,7 +18415,7 @@ { "disabled": false, "document": "集群ID", - "example": "无", + "example": "cynosdbmysql-i2weamox", "member": "string", "name": "ClusterId", "output_required": true, @@ -18428,7 +18425,7 @@ { "disabled": false, "document": "用户AppID", - "example": "无", + "example": "1772344699", "member": "int64", "name": "AppId", "output_required": true, @@ -18438,7 +18435,7 @@ { "disabled": false, "document": "地域", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, @@ -18448,7 +18445,7 @@ { "disabled": false, "document": "可用区", - "example": "无", + "example": "ap-guangzhou-6", "member": "string", "name": "Zone", "output_required": true, @@ -18458,7 +18455,7 @@ { "disabled": false, "document": "数据库代理节点名字", - "example": "无", + "example": "cynosdbmysql-proxyNode-q52v1wp4", "member": "string", "name": "OssProxyNodeName", "output_required": true, @@ -18474,20 +18471,20 @@ { "disabled": false, "document": "数据库代理cpu核数", - "example": "无", + "example": "2", "member": "int64", "name": "Cpu", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "数据库代理内存", - "example": "无", + "example": "4000", "member": "int64", "name": "Mem", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -18550,7 +18547,7 @@ { "disabled": false, "document": "搜索字段,目前支持:\"InstanceId\", \"ProjectId\", \"InstanceName\", \"Vip\"", - "example": "\"projectId\"", + "example": "[\"projectId\"]", "member": "string", "name": "Names", "required": true, @@ -18559,7 +18556,7 @@ { "disabled": false, "document": "搜索字符串", - "example": "\"xxx\"", + "example": "[\"1723\"]", "member": "string", "name": "Values", "required": true, @@ -18577,7 +18574,7 @@ { "disabled": false, "document": "搜索字段", - "example": "\"123\"", + "example": "projectId", "member": "string", "name": "Name", "required": false, @@ -18586,7 +18583,7 @@ { "disabled": false, "document": "操作符", - "example": "无", + "example": "1000****4352", "member": "string", "name": "Operator", "required": false, @@ -18601,32 +18598,29 @@ { "disabled": false, "document": "搜索字段,目前支持:\"InstanceId\", \"ProjectId\", \"InstanceName\", \"Vip\"", - "example": "无", + "example": "[\"status\"]", "member": "string", "name": "Names", "required": true, - "type": "list", - "value_allowed_null": false + "type": "list" }, { "disabled": false, "document": "搜索字符串", - "example": "无", + "example": "[\"running\"]", "member": "string", "name": "Values", "required": true, - "type": "list", - "value_allowed_null": false + "type": "list" }, { "disabled": false, "document": "是否精确匹配", - "example": "无", + "example": "true", "member": "bool", "name": "ExactMatch", "required": false, - "type": "bool", - "value_allowed_null": false + "type": "bool" } ], "usage": "in" @@ -19056,7 +19050,7 @@ { "disabled": false, "document": "账号信息", - "example": "无", + "example": "{\"AccountName\": \"andy\",\"Host\": \"%\"}", "member": "InputAccount", "name": "Account", "required": true, @@ -19074,7 +19068,7 @@ { "disabled": false, "document": "数据库表信息", - "example": "无", + "example": "[{\"Db\": \"db1\",\"TableName\": \"tb1\"}]", "member": "DbTable", "name": "DbTables", "required": true, @@ -19146,7 +19140,7 @@ { "disabled": false, "document": "回档数据库列表", - "example": "无", + "example": "[{\"OldDatabase\": \"db1\",\"NewDatabase\": \"dbnew\"}]", "member": "RollbackDatabase", "name": "RollbackDatabases", "required": false, @@ -19155,7 +19149,7 @@ { "disabled": false, "document": "回档数据库表列表", - "example": "无", + "example": "[{\"Database\": \"db1\",\"Tables\": [{\"OldTable\": \"tb1\",\"NewTable\": \"tbnew\"}]}]", "member": "RollbackTable", "name": "RollbackTables", "required": false, @@ -19179,7 +19173,7 @@ { "disabled": false, "document": "任务流ID", - "example": "123", + "example": "147283", "member": "int64", "name": "FlowId", "output_required": true, @@ -19231,7 +19225,7 @@ { "disabled": false, "document": "原集群id", - "example": "cynosdbmysql-xx", + "example": "cynosdbmysql-j9i41hfv", "member": "string", "name": "OriginalClusterId", "output_required": true, @@ -19241,7 +19235,7 @@ { "disabled": false, "document": "原集群名", - "example": "test", + "example": "cynosdbmysql-j9i41hfv", "member": "string", "name": "OriginalClusterName", "output_required": true, @@ -19321,7 +19315,7 @@ { "disabled": false, "document": "备份文件名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cynosdbmysql-oaj6te97_20240610111357", "member": "string", "name": "BackupFileName", "output_required": true, @@ -19375,7 +19369,7 @@ { "disabled": false, "document": "集群ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cynoadbmysql-ydtwlxig", "member": "string", "name": "ClusterId", "output_required": false, @@ -19385,7 +19379,7 @@ { "disabled": false, "document": "集群名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cynoadbmysql-ydtwlxig", "member": "string", "name": "ClusterName", "output_required": false, @@ -19395,7 +19389,7 @@ { "disabled": false, "document": "vpc信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "vpc-4pbgx2fv", "member": "string", "name": "UniqVpcId", "output_required": false, @@ -19405,7 +19399,7 @@ { "disabled": false, "document": "子网信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "subnet-a2emqbdd", "member": "string", "name": "UniqSubnetId", "output_required": false, @@ -19415,7 +19409,7 @@ { "disabled": false, "document": "vip信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "172.1.1.1", "member": "string", "name": "Vip", "output_required": false, @@ -19425,7 +19419,7 @@ { "disabled": false, "document": "vport信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "3306", "member": "int64", "name": "Vport", "output_required": false, @@ -19435,7 +19429,7 @@ { "disabled": false, "document": "实例ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cynosdbmysql-ins-twpmnatl", "member": "string", "name": "InstanceId", "output_required": false, @@ -19445,7 +19439,7 @@ { "disabled": false, "document": "实例名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cynosdbmysql-ins-twpmnatl", "member": "string", "name": "InstanceName", "output_required": false, @@ -19455,7 +19449,7 @@ { "disabled": false, "document": "状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "success", "member": "string", "name": "Status", "output_required": false, @@ -19465,7 +19459,7 @@ { "disabled": false, "document": "cpu大小\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2", "member": "int64", "name": "Cpu", "output_required": false, @@ -19475,7 +19469,7 @@ { "disabled": false, "document": "内存大小\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "4", "member": "int64", "name": "Mem", "output_required": false, @@ -19485,7 +19479,7 @@ { "disabled": false, "document": "存储大小\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "100", "member": "int64", "name": "StorageLimit", "output_required": false, @@ -19501,7 +19495,7 @@ { "disabled": false, "document": "是否可以交换vip\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsVipSwitchable", "output_required": false, @@ -19511,7 +19505,7 @@ { "disabled": false, "document": "vip可交换时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "upgradeInMaintain", "member": "string", "name": "VipSwitchableTime", "output_required": false, @@ -19541,7 +19535,7 @@ { "disabled": false, "document": "当前步骤\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "importingData", "member": "string", "name": "CurrentStep", "output_required": false, @@ -19551,7 +19545,7 @@ { "disabled": false, "document": "当前步骤进度\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "98", "member": "int64", "name": "CurrentStepProgress", "output_required": false, @@ -19561,7 +19555,7 @@ { "disabled": false, "document": "当前步骤剩余时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "500", "member": "string", "name": "CurrentStepRemainingTime", "output_required": false, @@ -19577,7 +19571,7 @@ { "disabled": false, "document": "实例组ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cynosdbmysql-grp-ywnxpisy", "member": "string", "name": "InstanceGroupId", "output_required": false, @@ -19587,7 +19581,7 @@ { "disabled": false, "document": "vpc信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "vpc-4pbgx2dd", "member": "string", "name": "UniqVpcId", "output_required": false, @@ -19597,7 +19591,7 @@ { "disabled": false, "document": "子网信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "subnet-a2emqbfv", "member": "string", "name": "UniqSubnetId", "output_required": false, @@ -19607,7 +19601,7 @@ { "disabled": false, "document": "vip信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "172.1.1.1", "member": "string", "name": "Vip", "output_required": false, @@ -19617,7 +19611,7 @@ { "disabled": false, "document": "vport信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "3306", "member": "int64", "name": "Vport", "output_required": false, @@ -19689,20 +19683,20 @@ { "disabled": false, "document": "开始时间", - "example": "无", + "example": "2024-01-13 02:12:05", "member": "string", "name": "TimeRangeStart", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "结束时间", - "example": "无", + "example": "2024-01-20 02:12:05", "member": "string", "name": "TimeRangeEnd", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -19724,7 +19718,7 @@ { "disabled": false, "document": "回档时,传入源集群ID,用于查找源poolId", - "example": "cynosdbmysql-xxxxxxxx", + "example": "cynosdbmysql-gs629njx", "member": "string", "name": "OriginalClusterId", "required": true, @@ -19787,7 +19781,7 @@ { "disabled": false, "document": "集群创建需要绑定的tag数组信息", - "example": "无", + "example": "[{\"TagKey\":\"PayMode\",\"TagValue\":\"PayMode0\"},{\"TagKey\":\"StoragePayMode\",\"TagValue\":\"StoragePayMode0\"}]", "member": "Tag", "name": "ResourceTags", "required": false, @@ -19841,7 +19835,7 @@ { "disabled": false, "document": "安全组id数组", - "example": "无", + "example": "[\"sg-ikto3761\",\"sg-ikto52u1\"]", "member": "string", "name": "SecurityGroupIds", "required": false, @@ -19850,7 +19844,7 @@ { "disabled": false, "document": "告警策略Id数组", - "example": "无", + "example": "[\"policy-8hbxwvxe\",\"policy-3bs6vxe4\"]", "member": "string", "name": "AlarmPolicyIds", "required": false, @@ -19859,7 +19853,7 @@ { "disabled": false, "document": "参数数组,暂时支持character_set_server (utf8|latin1|gbk|utf8mb4) ,lower_case_table_names,1-大小写不敏感,0-大小写敏感", - "example": "无", + "example": "[{\"CurrentValue\":\"utf8mb4\",\"ParamName\":\"character_set_server\"},{\"CurrentValue\":\"1\",\"ParamName\":\"lower_case_table_names\"}]", "member": "ParamItem", "name": "ClusterParams", "required": false, @@ -19877,7 +19871,7 @@ { "disabled": false, "document": "实例初始化配置信息,主要用于购买集群时选不同规格实例", - "example": "无", + "example": "[{\"Cpu\":1,\"InstanceCount\":1,\"InstanceType\":\"rw\",\"Memory\":1}]", "member": "InstanceInitInfo", "name": "InstanceInitInfos", "required": false, @@ -19886,7 +19880,7 @@ { "disabled": false, "document": "0-下单并支付 1-下单", - "example": "无", + "example": "0", "member": "int64", "name": "DealMode", "required": false, @@ -19895,7 +19889,7 @@ { "disabled": false, "document": "计算节点付费模式:0-按量计费,1-预付费", - "example": "无", + "example": "0", "member": "int64", "name": "PayMode", "required": false, @@ -19904,7 +19898,7 @@ { "disabled": false, "document": "时间", - "example": "无", + "example": "12", "member": "int64", "name": "TimeSpan", "required": false, @@ -19913,7 +19907,7 @@ { "disabled": false, "document": "单位", - "example": "无", + "example": "m", "member": "string", "name": "TimeUnit", "required": false, @@ -19922,7 +19916,7 @@ { "disabled": false, "document": "回档库信息", - "example": "无", + "example": "[{\"NewDatabase\":\"db2\",\"OldDatabase\":\"db1\"}]", "member": "RollbackDatabase", "name": "RollbackDatabases", "required": false, @@ -19931,7 +19925,7 @@ { "disabled": false, "document": "回档表信息", - "example": "无", + "example": "[{\"Database\":\"db1\",\"Tables\":[{\"OldTable\":\"table1\",\"newTable\":\"table2\"}]}]", "member": "RollbackTable", "name": "RollbackTables", "required": false, @@ -19940,7 +19934,7 @@ { "disabled": false, "document": "原ro实例信息", - "example": "无", + "example": "[\"cynosdbmysql-ins-7xbwg29x\"]", "member": "string", "name": "OriginalROInstanceList", "required": false, @@ -19995,7 +19989,7 @@ { "disabled": false, "document": "大订单号\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[\"xxx\"]", + "example": "[\"20241226519077105329731\"]", "member": "string", "name": "BigDealIds", "output_required": true, @@ -20324,7 +20318,7 @@ { "disabled": false, "document": "是否为全链路RDMA可用区", - "example": "无", + "example": "1", "member": "string", "name": "IsWholeRdmaZone", "output_required": true, @@ -20621,7 +20615,7 @@ { "disabled": false, "document": "可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-guangzhou-6", "member": "string", "name": "Zone", "output_required": false, @@ -20631,7 +20625,7 @@ { "disabled": false, "document": "存储量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "StockCount", "output_required": false, @@ -20641,7 +20635,7 @@ { "disabled": false, "document": "是否包含库存\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "HasStock", "output_required": false, @@ -20713,7 +20707,7 @@ { "disabled": false, "document": "可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-guangzhou-3", "member": "string", "name": "Zone", "output_required": false, @@ -20775,7 +20769,7 @@ { "disabled": false, "document": "执行时间戳", - "example": "无", + "example": "1655891555", "member": "int64", "name": "Timestamp", "output_required": true, @@ -20785,7 +20779,7 @@ { "disabled": false, "document": "执行时长,单位秒", - "example": "无", + "example": "11.00011", "member": "float", "name": "QueryTime", "output_required": true, @@ -20795,7 +20789,7 @@ { "disabled": false, "document": "sql语句", - "example": "无", + "example": "SELECT sleep(11) LIMIT 11 offset 0", "member": "string", "name": "SqlText", "output_required": true, @@ -20805,7 +20799,7 @@ { "disabled": false, "document": "客户端host", - "example": "无", + "example": "11.186.190.10", "member": "string", "name": "UserHost", "output_required": true, @@ -20815,7 +20809,7 @@ { "disabled": false, "document": "用户名", - "example": "无", + "example": "root", "member": "string", "name": "UserName", "output_required": true, @@ -20825,7 +20819,7 @@ { "disabled": false, "document": "数据库名", - "example": "无", + "example": "information_schema", "member": "string", "name": "Database", "output_required": true, @@ -20835,7 +20829,7 @@ { "disabled": false, "document": "锁时长,单位秒", - "example": "无", + "example": "0", "member": "float", "name": "LockTime", "output_required": true, @@ -20845,7 +20839,7 @@ { "disabled": false, "document": "扫描行数", - "example": "无", + "example": "0", "member": "int64", "name": "RowsExamined", "output_required": true, @@ -20855,7 +20849,7 @@ { "disabled": false, "document": "返回行数", - "example": "无", + "example": "0", "member": "int64", "name": "RowsSent", "output_required": true, @@ -20865,7 +20859,7 @@ { "disabled": false, "document": "sql模板", - "example": "无", + "example": "select sleep(?) limit ? offset ?;", "member": "string", "name": "SqlTemplate", "output_required": true, @@ -20875,7 +20869,7 @@ { "disabled": false, "document": "sql语句md5", - "example": "无", + "example": "267171214708E27C", "member": "string", "name": "SqlMd5", "output_required": true, @@ -20885,7 +20879,7 @@ { "disabled": false, "document": "远程读取次数\n数据库内核版本大于3.1.12\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "0", + "example": "10", "member": "int64", "name": "SyncReadCountRemote", "output_required": false, @@ -20895,7 +20889,7 @@ { "disabled": false, "document": "远程读取的字节数\n数据库内核版本大于3.1.12\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "0", + "example": "1024", "member": "int64", "name": "SyncReadBytesRemote", "output_required": false, @@ -20905,7 +20899,7 @@ { "disabled": false, "document": "远程读取所花费的时间(微秒)\n数据库内核版本大于3.1.12\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "0", + "example": "100", "member": "int64", "name": "SyncReadTimeRemote", "output_required": false, @@ -20915,7 +20909,7 @@ { "disabled": false, "document": "远程写入次数\n数据库内核版本大于3.1.12\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "0", + "example": "10", "member": "int64", "name": "SyncWriteCountRemote", "output_required": false, @@ -20925,7 +20919,7 @@ { "disabled": false, "document": "远程写入的字节数。\n数据库内核版本大于3.1.12\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "0", + "example": "1024", "member": "int64", "name": "SyncWriteBytesRemote", "output_required": false, @@ -20935,7 +20929,7 @@ { "disabled": false, "document": "远程写入所花费的时间(微秒)。\n数据库内核版本大于3.1.12\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "0", + "example": "100", "member": "int64", "name": "SyncWriteTimeRemote", "output_required": false, @@ -20945,7 +20939,7 @@ { "disabled": false, "document": "事务提交延迟(微秒)\n数据库内核版本大于3.1.12\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "0", + "example": "100", "member": "int64", "name": "TrxCommitDelay", "output_required": false, @@ -21043,7 +21037,7 @@ { "disabled": false, "document": "日志类型", - "example": "无", + "example": "slow", "member": "string", "name": "LogType", "required": false, @@ -21052,7 +21046,7 @@ { "disabled": false, "document": "是否维护时间运行", - "example": "无", + "example": "yes", "member": "string", "name": "IsInMaintainPeriod", "required": false, @@ -21067,7 +21061,7 @@ { "disabled": false, "document": "异步任务id\n", - "example": "123456", + "example": "14728472", "member": "int64", "name": "TaskId", "output_required": false, @@ -21089,7 +21083,7 @@ { "disabled": false, "document": "状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "OFF", "member": "string", "name": "Status", "output_required": true, diff --git a/tccli/services/cynosdb/v20190107/examples.json b/tccli/services/cynosdb/v20190107/examples.json index 5e512b53f1..ff71687e61 100644 --- a/tccli/services/cynosdb/v20190107/examples.json +++ b/tccli/services/cynosdb/v20190107/examples.json @@ -107,7 +107,7 @@ "CreateAuditRuleTemplate": [ { "document": "创建审计规则模板", - "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAuditRuleTemplate\n<公共请求参数>\n\n{\n \"RuleFilters\": [\n {\n \"Type\": \"host\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"100.122.76.176\",\n \"10.0.0.9\"\n ]\n },\n {\n \"Type\": \"user\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"wy\",\n \"test\"\n ]\n },\n {\n \"Type\": \"sqlType\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"Update\",\n \"Delete\"\n ]\n }\n ],\n \"RuleTemplateName\": \"test\",\n \"Description\": \"用于测试的规则模板\"\n}", + "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAuditRuleTemplate\n<公共请求参数>\n\n{\n \"RuleFilters\": [\n {\n \"Type\": \"host\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"100.122.76.176\",\n \"10.0.0.9\"\n ]\n },\n {\n \"Type\": \"user\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"wy\",\n \"andy\"\n ]\n },\n {\n \"Type\": \"sqlType\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"Update\",\n \"Delete\"\n ]\n }\n ],\n \"RuleTemplateName\": \"andy\",\n \"Description\": \"andy模板\"\n}", "output": "{\n \"Response\": {\n \"RuleTemplateId\": \"cynosdb-rt-ws23fwu8\",\n \"RequestId\": \"43-12121-812w1221213-62usf9093\"\n }\n}", "title": "创建审计规则模板" } @@ -124,7 +124,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCLSDelivery\n<公共请求参数>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-o971o62r\",\n \"CLSInfoList\": [\n {\n \"TopicId\": \"38b86342-7cb0-4776-9ebd-ff1830035da1\",\n \"TopicOperation\": \"reuse\",\n \"GroupId\": \"17de6e2a-efd0-4fc2-ba2e-8845bd4f9895\",\n \"Region\": \"ap-guangzhou\",\n \"GroupOperation\": \"reuse\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"TaskId\": 123456,\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\"\n }\n}", + "output": "{\n \"Response\": {\n \"TaskId\": 148728,\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\"\n }\n}", "title": "创建日志投递" } ], @@ -193,7 +193,7 @@ "DeleteAuditLogFile": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteAuditLogFile\n<公共请求参数>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-qwerasdf\",\n \"FileName\": \"aaa\"\n}", + "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteAuditLogFile\n<公共请求参数>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-qwerasdf\",\n \"FileName\": \"andy.csv\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}", "title": "删除审计日志文件" } @@ -241,15 +241,15 @@ "DescribeAccountAllGrantPrivileges": [ { "document": "查询账号所有可授予权限", - "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAccountAllGrantPrivileges\n<公共请求参数>\n\n{\n \"Account\": {\n \"Host\": \"%\",\n \"AccountName\": \"test\"\n },\n \"ClusterId\": \"cynosdbmysql-xxxxxxxx\"\n}", - "output": "{\n \"Response\": {\n \"DatabasePrivileges\": [\n {\n \"Db\": \"test1\",\n \"Privileges\": [\n \"DROP\",\n \"EXECUTE\"\n ]\n }\n ],\n \"GlobalPrivileges\": [\n \"CREATE\",\n \"ALTER\"\n ],\n \"PrivilegeStatements\": [\n \"GRANT CREATE, ALTER ON *.* TO 'test'@'%'\",\n \"GRANT DROP, EXECUTE ON `test1`.* TO 'test'@'%'\",\n \"GRANT UPDATE, SHOW VIEW ON `test1`.`user1` TO 'test'@'%'\"\n ],\n \"RequestId\": \"46bf5c40-3fc1-4030-ab84-a66355ae25ab\",\n \"TablePrivileges\": [\n {\n \"Db\": \"test1\",\n \"Privileges\": [\n \"UPDATE\",\n \"SHOW VIEW\"\n ],\n \"TableName\": \"user1\"\n }\n ]\n }\n}", + "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAccountAllGrantPrivileges\n<公共请求参数>\n\n{\n \"Account\": {\n \"Host\": \"%\",\n \"AccountName\": \"andy\"\n },\n \"ClusterId\": \"cynosdbmysql-j9i41hfv\"\n}", + "output": "{\n \"Response\": {\n \"DatabasePrivileges\": [\n {\n \"Db\": \"db1\",\n \"Privileges\": [\n \"DROP\",\n \"EXECUTE\"\n ]\n }\n ],\n \"GlobalPrivileges\": [\n \"CREATE\",\n \"ALTER\"\n ],\n \"PrivilegeStatements\": [\n \"GRANT CREATE, ALTER ON *.* TO 'test'@'%'\",\n \"GRANT DROP, EXECUTE ON `db1`.* TO 'andy'@'%'\",\n \"GRANT UPDATE, SHOW VIEW ON `db1`.`user1` TO 'andy'@'%'\"\n ],\n \"RequestId\": \"46bf5c40-3fc1-4030-ab84-a66355ae25ab\",\n \"TablePrivileges\": [\n {\n \"Db\": \"andy1\",\n \"Privileges\": [\n \"UPDATE\",\n \"SHOW VIEW\"\n ],\n \"TableName\": \"user1\"\n }\n ]\n }\n}", "title": "查询账号所有可授予权限" } ], "DescribeAccountPrivileges": [ { "document": "查询账号已有权限", - "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAccountPrivileges\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxx\",\n \"AccountName\": \"test\",\n \"Host\": \"1.1.1.1\",\n \"Db\": \"testDb\",\n \"Type\": \"table\",\n \"TableName\": \"testTable\"\n}", + "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAccountPrivileges\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxx\",\n \"AccountName\": \"andy\",\n \"Host\": \"1.1.1.1\",\n \"Db\": \"Db1\",\n \"Type\": \"table\",\n \"TableName\": \"Table1\"\n}", "output": "{\n \"Response\": {\n \"Privileges\": [\n \"select\",\n \"update\",\n \"delete\",\n \"create\",\n \"drop\",\n \"references\",\n \"index\",\n \"alter\",\n \"show_db\",\n \"create_tmp_table\",\n \"lock_tables\",\n \"execute\",\n \"create_view\",\n \"show_view\",\n \"create_routine\",\n \"alter_routine\",\n \"event\",\n \"trigger\"\n ],\n \"RequestId\": \"167350\"\n }\n}", "title": "查询账号已有权限" } @@ -282,7 +282,7 @@ { "document": "查询审计日志", "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAuditLogs\n<公共请求参数>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-qwerasdf\",\n \"StartTime\": \"2017-07-12 10:29:20\",\n \"EndTime\": \"2017-07-13 10:29:20\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"TotalCount\": \"1\",\n \"Items\": [\n {\n \"PolicyName\": \"sys_default\",\n \"ExecTime\": 0,\n \"Timestamp\": \"2023-06-26 10:32:36.000\",\n \"AffectRows\": 0,\n \"ThreadId\": 0,\n \"TableName\": \"\",\n \"ErrCode\": 0,\n \"Host\": \"10.0.0.1\",\n \"SentRows\": 0,\n \"User\": \"test\",\n \"Sql\": \"SELECT * FROM test LIMIT 1;\",\n \"SqlType\": \"SELECT\",\n \"InstanceName\": \"test\",\n \"DBName\": \"test_db\"\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"TotalCount\": \"1\",\n \"Items\": [\n {\n \"PolicyName\": \"sys_default\",\n \"ExecTime\": 0,\n \"Timestamp\": \"2023-06-26 10:32:36.000\",\n \"AffectRows\": 0,\n \"ThreadId\": 0,\n \"TableName\": \"\",\n \"ErrCode\": 0,\n \"Host\": \"10.0.0.1\",\n \"SentRows\": 0,\n \"User\": \"andy\",\n \"Sql\": \"SELECT * FROM test LIMIT 1;\",\n \"SqlType\": \"SELECT\",\n \"InstanceName\": \"cynosdbandy\",\n \"DBName\": \"db1\"\n }\n ]\n }\n}", "title": "查询审计日志" }, { @@ -421,8 +421,8 @@ "DescribeClusterInstanceGrps": [ { "document": "查询实例组网络信息. 该接口已废弃,推荐使用DescribeClusterInstanceGroups", - "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterInstanceGrps\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-oib3wx0i\"\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"InstanceGrpInfoList\": [\n {\n \"AppId\": 0,\n \"ClusterId\": \"abc\",\n \"CreatedTime\": \"2020-09-22 00:00:00\",\n \"DeletedTime\": \"2020-09-22 00:00:00\",\n \"InstanceGrpId\": \"abc\",\n \"Status\": \"abc\",\n \"Type\": \"abc\",\n \"UpdatedTime\": \"2020-09-22 00:00:00\",\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\",\n \"InstanceSet\": [\n {\n \"Uin\": \"abc\",\n \"AppId\": 0,\n \"ClusterId\": \"abc\",\n \"ClusterName\": \"abc\",\n \"InstanceId\": \"abc\",\n \"InstanceName\": \"abc\",\n \"ProjectId\": 0,\n \"Region\": \"abc\",\n \"Zone\": \"abc\",\n \"Status\": \"abc\",\n \"StatusDesc\": \"abc\",\n \"DbMode\": \"abc\",\n \"DbType\": \"abc\",\n \"DbVersion\": \"abc\",\n \"Cpu\": 0,\n \"Memory\": 0,\n \"Storage\": 0,\n \"InstanceType\": \"abc\",\n \"InstanceRole\": \"abc\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2020-09-22 00:00:00\",\n \"DestroyDeadlineText\": \"abc\",\n \"IsolateTime\": \"2020-09-22 00:00:00\",\n \"NetType\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\",\n \"DestroyTime\": \"abc\",\n \"CynosVersion\": \"abc\",\n \"ProcessingTask\": \"abc\",\n \"RenewFlag\": 0,\n \"MinCpu\": 0,\n \"MaxCpu\": 0,\n \"ServerlessStatus\": \"abc\",\n \"StorageId\": \"abc\",\n \"StoragePayMode\": 0,\n \"PhysicalZone\": \"abc\",\n \"BusinessType\": \"abc\",\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ],\n \"IsFreeze\": \"abc\",\n \"ResourceTags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"MasterZone\": \"abc\",\n \"SlaveZones\": [\n \"abc\"\n ],\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupType\": \"abc\",\n \"InstanceGroupId\": \"abc\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"NetType\": 0,\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\"\n }\n ],\n \"ResourcePackages\": [\n {\n \"PackageId\": \"abc\",\n \"PackageType\": \"abc\"\n }\n ],\n \"InstanceIndexMode\": \"abc\"\n }\n ],\n \"UniqVpcId\": \"abc\",\n \"UniqSubnetId\": \"abc\",\n \"OldAddrInfo\": {\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"ReturnTime\": \"abc\"\n },\n \"ProcessingTasks\": [\n \"abc\"\n ],\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ],\n \"NetServiceId\": 0\n }\n ],\n \"InstanceGroupInfoList\": [\n {\n \"AppId\": 0,\n \"ClusterId\": \"abc\",\n \"CreatedTime\": \"abc\",\n \"DeletedTime\": \"abc\",\n \"InstanceGroupId\": \"abc\",\n \"Status\": \"abc\",\n \"Type\": \"abc\",\n \"UpdatedTime\": \"abc\",\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\",\n \"InstanceSet\": [\n {\n \"Uin\": \"abc\",\n \"AppId\": 0,\n \"ClusterId\": \"abc\",\n \"ClusterName\": \"abc\",\n \"InstanceId\": \"abc\",\n \"InstanceName\": \"abc\",\n \"ProjectId\": 0,\n \"Region\": \"abc\",\n \"Zone\": \"abc\",\n \"Status\": \"abc\",\n \"StatusDesc\": \"abc\",\n \"DbMode\": \"abc\",\n \"DbType\": \"abc\",\n \"DbVersion\": \"abc\",\n \"Cpu\": 0,\n \"Memory\": 0,\n \"Storage\": 0,\n \"InstanceType\": \"abc\",\n \"InstanceRole\": \"abc\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2020-09-22 00:00:00\",\n \"DestroyDeadlineText\": \"abc\",\n \"IsolateTime\": \"2020-09-22 00:00:00\",\n \"NetType\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\",\n \"DestroyTime\": \"abc\",\n \"CynosVersion\": \"abc\",\n \"ProcessingTask\": \"abc\",\n \"RenewFlag\": 0,\n \"MinCpu\": 0,\n \"MaxCpu\": 0,\n \"ServerlessStatus\": \"abc\",\n \"StorageId\": \"abc\",\n \"StoragePayMode\": 0,\n \"PhysicalZone\": \"abc\",\n \"BusinessType\": \"abc\",\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ],\n \"IsFreeze\": \"abc\",\n \"ResourceTags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"MasterZone\": \"abc\",\n \"SlaveZones\": [\n \"abc\"\n ],\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupType\": \"abc\",\n \"InstanceGroupId\": \"abc\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"NetType\": 0,\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\"\n }\n ],\n \"ResourcePackages\": [\n {\n \"PackageId\": \"abc\",\n \"PackageType\": \"abc\"\n }\n ],\n \"InstanceIndexMode\": \"abc\"\n }\n ],\n \"UniqVpcId\": \"abc\",\n \"UniqSubnetId\": \"abc\",\n \"OldAddrInfo\": {\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"ReturnTime\": \"abc\"\n },\n \"ProcessingTasks\": [\n \"abc\"\n ],\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ],\n \"NetServiceId\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterInstanceGrps\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-grhvkwd\"\n}", + "output": "{\n \"Response\": {\n \"InstanceGroupInfoList\": [\n {\n \"AppId\": 1312008346,\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"CreatedTime\": \"2024-12-03 14:03:58\",\n \"DeletedTime\": \"0001-01-01 00:00:00\",\n \"InstanceGroupId\": \"cynosdbmysql-grp-r7hmdx4\",\n \"InstanceSet\": [\n {\n \"AppId\": 1312008346,\n \"BusinessType\": \"\",\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"ClusterName\": \"cynosdbmysql-grhvkwd\",\n \"Cpu\": 2,\n \"CreateTime\": \"2024-12-03 14:03:58\",\n \"CynosVersion\": \"2.1.13.001\",\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\n \"DestroyDeadlineText\": \"\",\n \"DestroyTime\": \"\",\n \"DeviceType\": \"exclusive\",\n \"InstanceAbility\": {\n \"IsSupportForceRestart\": \"no\",\n \"NonsupportForceRestartReason\": \"NoForcedRestartAllowed\"\n },\n \"InstanceId\": \"cynosdbmysql-ins-crl6j3l\",\n \"InstanceIndexMode\": \"onlyRowIndex\",\n \"InstanceName\": \"cynosdbmysql-ins-crl6j3l\",\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupId\": \"cynosdbmysql-grp-r7hmdx4\",\n \"InstanceGroupType\": \"ha\",\n \"NetType\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Vip\": \"172.0.0.2\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n }\n ],\n \"InstanceRole\": \"master\",\n \"InstanceStorageType\": \"\",\n \"InstanceType\": \"rw\",\n \"IsFreeze\": \"no\",\n \"IsolateTime\": \"0001-01-01 00:00:00\",\n \"MasterZone\": \"ap-chongqing-1\",\n \"MaxCpu\": 0,\n \"Memory\": 4,\n \"MinCpu\": 0,\n \"NetType\": 1,\n \"PayMode\": 1,\n \"PeriodEndTime\": \"2025-01-03 14:04:40\",\n \"PhysicalZone\": \"ap-chongqing-1\",\n \"ProcessingTask\": \"\",\n \"ProjectId\": 0,\n \"Region\": \"ap-chongqing\",\n \"RenewFlag\": 1,\n \"ResourcePackages\": null,\n \"ResourceTags\": null,\n \"ServerlessStatus\": \"\",\n \"SlaveZones\": [],\n \"Status\": \"running\",\n \"StatusDesc\": \"运行中\",\n \"Storage\": 10,\n \"StorageId\": \"cynosdbmysql-grhvkwd\",\n \"StoragePayMode\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Tasks\": [],\n \"Uin\": \"100021117054\",\n \"UpdateTime\": \"2024-12-03 14:04:40\",\n \"Vip\": \"172.0.0.12\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\",\n \"Zone\": \"ap-chongqing-1\"\n }\n ],\n \"NetServiceId\": 53990,\n \"OldAddrInfo\": {\n \"ReturnTime\": \"\",\n \"Vip\": \"\",\n \"Vport\": 0\n },\n \"ProcessingTasks\": [],\n \"Status\": \"running\",\n \"Tasks\": [],\n \"Type\": \"ha\",\n \"UniqSubnetId\": \"subnet-oiz56c8\",\n \"UniqVpcId\": \"vpc-gy34uq2\",\n \"UpdatedTime\": \"2024-12-03 14:04:40\",\n \"Vip\": \"172.0.0.12\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n },\n {\n \"AppId\": 1310008346,\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"CreatedTime\": \"2024-12-03 14:03:58\",\n \"DeletedTime\": \"0001-01-01 00:00:00\",\n \"InstanceGroupId\": \"cynosdbmysql-grp-08o6vjh\",\n \"InstanceSet\": [\n {\n \"AppId\": 1310008346,\n \"BusinessType\": \"\",\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"ClusterName\": \"cynosdbmysql-grhvkwd\",\n \"Cpu\": 2,\n \"CreateTime\": \"2024-12-03 14:03:58\",\n \"CynosVersion\": \"2.1.13.001\",\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\n \"DestroyDeadlineText\": \"\",\n \"DestroyTime\": \"\",\n \"DeviceType\": \"exclusive\",\n \"InstanceAbility\": {\n \"IsSupportForceRestart\": \"no\",\n \"NonsupportForceRestartReason\": \"NoForcedRestartAllowed\"\n },\n \"InstanceId\": \"cynosdbmysql-ins-6t9ynb7\",\n \"InstanceIndexMode\": \"onlyRowIndex\",\n \"InstanceName\": \"cynosdbmysql-ins-6t9ynb7\",\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupId\": \"cynosdbmysql-grp-08o6vj0\",\n \"InstanceGroupType\": \"singleRo\",\n \"NetType\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Vip\": \"172.0.0.7\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n }\n ],\n \"InstanceRole\": \"ro\",\n \"InstanceStorageType\": \"\",\n \"InstanceType\": \"ro\",\n \"IsFreeze\": \"no\",\n \"IsolateTime\": \"0001-01-01 00:00:00\",\n \"MasterZone\": \"ap-chongqing-1\",\n \"MaxCpu\": 0,\n \"Memory\": 4,\n \"MinCpu\": 0,\n \"NetType\": 1,\n \"PayMode\": 1,\n \"PeriodEndTime\": \"2025-01-03 14:04:40\",\n \"PhysicalZone\": \"ap-chongqing-1\",\n \"ProcessingTask\": \"\",\n \"ProjectId\": 0,\n \"Region\": \"ap-chongqing\",\n \"RenewFlag\": 1,\n \"ResourcePackages\": null,\n \"ResourceTags\": null,\n \"ServerlessStatus\": \"\",\n \"SlaveZones\": [],\n \"Status\": \"running\",\n \"StatusDesc\": \"运行中\",\n \"Storage\": 10,\n \"StorageId\": \"cynosdbmysql-grhvkwd\",\n \"StoragePayMode\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Tasks\": [],\n \"Uin\": \"100021117054\",\n \"UpdateTime\": \"2024-12-09 15:18:23\",\n \"Vip\": \"172.0.0.7\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\",\n \"Zone\": \"ap-chongqing-1\"\n }\n ],\n \"NetServiceId\": 53991,\n \"OldAddrInfo\": {\n \"ReturnTime\": \"\",\n \"Vip\": \"\",\n \"Vport\": 0\n },\n \"ProcessingTasks\": [],\n \"Status\": \"running\",\n \"Tasks\": [],\n \"Type\": \"singleRo\",\n \"UniqSubnetId\": \"subnet-oiz56c8\",\n \"UniqVpcId\": \"vpc-gy34uq2\",\n \"UpdatedTime\": \"2024-12-03 14:04:40\",\n \"Vip\": \"172.0.0.7\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n }\n ],\n \"RequestId\": \"c32019ab-0d57-4b3d-80ea-5f52c12b523f\",\n \"TotalCount\": 2\n }\n}", "title": "查询实例组(废弃)" } ], @@ -550,7 +550,7 @@ { "document": "", "input": "https://cynosdb.tencentcloudapi.com/?Action=DescribeIsolatedInstances\n&Limit=20\n&Offset=0\n&Filters.0.Names.0=InstanceId\n&Filters.0.Values.0=cynosdbpg-ins-bzkxxrmt\n&DbType=MYSQL\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"InstanceSet\": [\n {\n \"Uin\": \"abc\",\n \"AppId\": 0,\n \"ClusterId\": \"abc\",\n \"ClusterName\": \"abc\",\n \"InstanceId\": \"abc\",\n \"InstanceName\": \"abc\",\n \"ProjectId\": 0,\n \"Region\": \"abc\",\n \"Zone\": \"abc\",\n \"Status\": \"abc\",\n \"StatusDesc\": \"abc\",\n \"DbMode\": \"abc\",\n \"DbType\": \"abc\",\n \"DbVersion\": \"abc\",\n \"Cpu\": 0,\n \"Memory\": 0,\n \"Storage\": 0,\n \"InstanceType\": \"abc\",\n \"InstanceRole\": \"abc\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2020-09-22 00:00:00\",\n \"DestroyDeadlineText\": \"abc\",\n \"IsolateTime\": \"2020-09-22 00:00:00\",\n \"NetType\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\",\n \"DestroyTime\": \"abc\",\n \"CynosVersion\": \"abc\",\n \"ProcessingTask\": \"abc\",\n \"RenewFlag\": 0,\n \"MinCpu\": 0,\n \"MaxCpu\": 0,\n \"ServerlessStatus\": \"abc\",\n \"StorageId\": \"abc\",\n \"StoragePayMode\": 0,\n \"PhysicalZone\": \"abc\",\n \"BusinessType\": \"abc\",\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ],\n \"IsFreeze\": \"abc\",\n \"ResourceTags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"MasterZone\": \"abc\",\n \"SlaveZones\": [\n \"abc\"\n ],\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupType\": \"abc\",\n \"InstanceGroupId\": \"abc\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"NetType\": 0,\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\"\n }\n ],\n \"ResourcePackages\": [\n {\n \"PackageId\": \"abc\",\n \"PackageType\": \"abc\",\n \"DeductionPriority\": 0\n }\n ],\n \"InstanceIndexMode\": \"abc\",\n \"InstanceAbility\": {\n \"IsSupportForceRestart\": \"abc\",\n \"NonsupportForceRestartReason\": \"abc\"\n },\n \"DeviceType\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"InstanceSet\": [\n {\n \"AppId\": 1311111346,\n \"BusinessType\": \"\",\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"ClusterName\": \"cynosdbmysql-grhvkwd\",\n \"Cpu\": 2,\n \"CreateTime\": \"2024-12-03 14:03:58\",\n \"CynosVersion\": \"2.1.13.001\",\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\n \"DestroyDeadlineText\": \"<7 天\",\n \"DestroyTime\": \"2024-12-30 19:51:33\",\n \"DeviceType\": \"exclusive\",\n \"InstanceAbility\": {\n \"IsSupportForceRestart\": \"no\",\n \"NonsupportForceRestartReason\": \"NoForcedRestartAllowed\"\n },\n \"InstanceId\": \"cynosdbmysql-ins-crl6j3l\",\n \"InstanceIndexMode\": \"onlyRowIndex\",\n \"InstanceName\": \"cynosdbmysql-ins-crl6j3l\",\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupId\": \"cynosdbmysql-grp-r7hmdx4\",\n \"InstanceGroupType\": \"ha\",\n \"NetType\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Vip\": \"172.0.0.2\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n }\n ],\n \"InstanceRole\": \"master\",\n \"InstanceStorageType\": \"\",\n \"InstanceType\": \"rw\",\n \"IsFreeze\": \"no\",\n \"IsolateTime\": \"2024-12-23 19:51:33\",\n \"MasterZone\": \"ap-chongqing-1\",\n \"MaxCpu\": 0,\n \"Memory\": 4,\n \"MinCpu\": 0,\n \"NetType\": 1,\n \"PayMode\": 1,\n \"PeriodEndTime\": \"2024-12-23 19:51:24\",\n \"PhysicalZone\": \"ap-chongqing-1\",\n \"ProcessingTask\": \"\",\n \"ProjectId\": 0,\n \"Region\": \"ap-chongqing\",\n \"RenewFlag\": 1,\n \"ResourcePackages\": null,\n \"ResourceTags\": null,\n \"ServerlessStatus\": \"\",\n \"SlaveZones\": [],\n \"Status\": \"isolated\",\n \"StatusDesc\": \"已隔离\",\n \"Storage\": 10,\n \"StorageId\": \"cynosdbmysql-grhvkwd\",\n \"StoragePayMode\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Tasks\": [],\n \"Uin\": \"100011147054\",\n \"UpdateTime\": \"2024-12-23 19:51:33\",\n \"Vip\": \"172.0.0.2\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\",\n \"Zone\": \"ap-chongqing-1\"\n },\n {\n \"AppId\": 1311111346,\n \"BusinessType\": \"\",\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"ClusterName\": \"cynosdbmysql-grhvkwd\",\n \"Cpu\": 2,\n \"CreateTime\": \"2024-12-03 14:03:58\",\n \"CynosVersion\": \"2.1.13.001\",\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\n \"DestroyDeadlineText\": \"<7 天\",\n \"DestroyTime\": \"2024-12-30 19:51:33\",\n \"DeviceType\": \"exclusive\",\n \"InstanceAbility\": {\n \"IsSupportForceRestart\": \"no\",\n \"NonsupportForceRestartReason\": \"NoForcedRestartAllowed\"\n },\n \"InstanceId\": \"cynosdbmysql-ins-6t9ynb7\",\n \"InstanceIndexMode\": \"onlyRowIndex\",\n \"InstanceName\": \"cynosdbmysql-ins-6t9ynb7\",\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupId\": \"cynosdbmysql-grp-08o6vj0\",\n \"InstanceGroupType\": \"singleRo\",\n \"NetType\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Vip\": \"172.0.0.7\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n }\n ],\n \"InstanceRole\": \"ro\",\n \"InstanceStorageType\": \"\",\n \"InstanceType\": \"ro\",\n \"IsFreeze\": \"no\",\n \"IsolateTime\": \"2024-12-23 19:51:33\",\n \"MasterZone\": \"ap-chongqing-1\",\n \"MaxCpu\": 0,\n \"Memory\": 4,\n \"MinCpu\": 0,\n \"NetType\": 1,\n \"PayMode\": 1,\n \"PeriodEndTime\": \"2024-12-23 19:51:24\",\n \"PhysicalZone\": \"ap-chongqing-1\",\n \"ProcessingTask\": \"\",\n \"ProjectId\": 0,\n \"Region\": \"ap-chongqing\",\n \"RenewFlag\": 1,\n \"ResourcePackages\": null,\n \"ResourceTags\": null,\n \"ServerlessStatus\": \"\",\n \"SlaveZones\": [],\n \"Status\": \"isolated\",\n \"StatusDesc\": \"已隔离\",\n \"Storage\": 10,\n \"StorageId\": \"cynosdbmysql-grhvkwd\",\n \"StoragePayMode\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Tasks\": [],\n \"Uin\": \"100011147054\",\n \"UpdateTime\": \"2024-12-23 19:51:33\",\n \"Vip\": \"172.0.0.7\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\",\n \"Zone\": \"ap-chongqing-1\"\n }\n ],\n \"RequestId\": \"8f291dbc-3840-40f9-aa39-841437c247fb\",\n \"TotalCount\": 2\n }\n}", "title": "查询回收站实例列表" } ], @@ -574,7 +574,7 @@ { "document": "参数板列表", "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeParamTemplates\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"TotalCount\": 2,\n \"RequestId\": \"fc791b35-d5e5-4e08-859d-1c095e783199\",\n \"Items\": [\n {\n \"TemplateDescription\": \"API测试\",\n \"TemplateName\": \"API测试\",\n \"Id\": 27,\n \"EngineVersion\": \"5.7\",\n \"ParamInfoSet\": [\n {\n \"CurrentValue\": \"12\",\n \"Description\": \"API测试\",\n \"Min\": \"10\",\n \"Default\": \"10\",\n \"Max\": \"10000\",\n \"ParamType\": \"integer\",\n \"EnumValue\": [\n \"test\"\n ],\n \"ParamName\": \"param1\",\n \"NeedReboot\": 0\n }\n ],\n \"DbMode\": \"NORMAL\"\n },\n {\n \"TemplateName\": \"API测试\",\n \"TemplateDescription\": \"API测试\",\n \"Id\": 28,\n \"EngineVersion\": \"5.7\",\n \"ParamInfoSet\": [\n {\n \"CurrentValue\": \"12\",\n \"Description\": \"API测试\",\n \"Min\": \"10\",\n \"Default\": \"10\",\n \"Max\": \"10000\",\n \"ParamType\": \"integer\",\n \"EnumValue\": [\n \"21\",\n \"22\"\n ],\n \"ParamName\": \"param2\",\n \"NeedReboot\": 0\n }\n ],\n \"DbMode\": \"NORMAL\"\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 2,\n \"RequestId\": \"fc791b35-d5e5-4e08-859d-1c095e783199\",\n \"Items\": [\n {\n \"TemplateDescription\": \"API测试\",\n \"TemplateName\": \"API测试\",\n \"Id\": 27,\n \"EngineVersion\": \"5.7\",\n \"ParamInfoSet\": [\n {\n \"CurrentValue\": \"12\",\n \"Description\": \"API测试\",\n \"Min\": \"10\",\n \"Default\": \"10\",\n \"Max\": \"10000\",\n \"ParamType\": \"integer\",\n \"EnumValue\": [\n \"ON\",\n \"OFF\"\n ],\n \"ParamName\": \"param1\",\n \"NeedReboot\": 0\n }\n ],\n \"DbMode\": \"NORMAL\"\n },\n {\n \"TemplateName\": \"API测试\",\n \"TemplateDescription\": \"API测试\",\n \"Id\": 28,\n \"EngineVersion\": \"5.7\",\n \"ParamInfoSet\": [\n {\n \"CurrentValue\": \"12\",\n \"Description\": \"API测试\",\n \"Min\": \"10\",\n \"Default\": \"10\",\n \"Max\": \"10000\",\n \"ParamType\": \"integer\",\n \"EnumValue\": [\n \"21\",\n \"22\"\n ],\n \"ParamName\": \"param2\",\n \"NeedReboot\": 0\n }\n ],\n \"DbMode\": \"NORMAL\"\n }\n ]\n }\n}", "title": "参数板列表" } ], @@ -731,8 +731,8 @@ "GrantAccountPrivileges": [ { "document": "批量授权账号权限", - "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GrantAccountPrivileges\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxxxx\",\n \"DbTablePrivileges\": [\n \"ALTER\",\n \"DROP\"\n ],\n \"Account\": {\n \"AccountName\": \"test\",\n \"Host\": \"%\"\n },\n \"DbTables\": [\n {\n \"Db\": \"test1\",\n \"TableName\": \"user1\"\n },\n {\n \"Db\": \"test2\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"147706\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GrantAccountPrivileges\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-j9i41hdd\",\n \"DbTablePrivileges\": [\n \"ALTER\",\n \"DROP\"\n ],\n \"Account\": {\n \"AccountName\": \"andy\",\n \"Host\": \"%\"\n },\n \"DbTables\": [\n {\n \"Db\": \"db1\",\n \"TableName\": \"user1\"\n },\n {\n \"Db\": \"db2\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\"\n }\n}", "title": "批量授权账号权限" } ], @@ -764,7 +764,7 @@ { "document": "隔离集群", "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: IsolateCluster\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-bzxxrmtq\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": 123,\n \"DealNames\": [\n \"123\"\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\",\n \"FlowId\": 147284,\n \"DealNames\": [\n \"20241226054077125855171\"\n ]\n }\n}", "title": "隔离集群" } ], @@ -795,16 +795,16 @@ "ModifyAccountParams": [ { "document": "修改账号配置", - "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAccountParams\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxxxx\",\n \"Account\": {\n \"AccountName\": \"test\",\n \"Host\": \"%\"\n },\n \"AccountParams\": [\n {\n \"ParamName\": \"max_user_connections\",\n \"ParamValue\": \"400\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"147706\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAccountParams\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxxxx\",\n \"Account\": {\n \"AccountName\": \"andy\",\n \"Host\": \"%\"\n },\n \"AccountParams\": [\n {\n \"ParamName\": \"max_user_connections\",\n \"ParamValue\": \"400\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\"\n }\n}", "title": "修改账号配置" } ], "ModifyAccountPrivileges": [ { "document": "修改账号库表权限", - "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAccountPrivileges\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxxx\",\n \"Account\": {\n \"AccountName\": \"test\",\n \"Host\": \"1.1.1.1\"\n },\n \"GlobalPrivileges\": [\n \"CREATE\"\n ],\n \"DatabasePrivileges\": [\n {\n \"Db\": \"testDb\",\n \"Privileges\": [\n \"DELETE\"\n ]\n }\n ],\n \"TablePrivileges\": [\n {\n \"Db\": \"testDb\",\n \"TableName\": \"testTable\",\n \"Privileges\": [\n \"DROP\"\n ]\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"147706\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAccountPrivileges\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxxx\",\n \"Account\": {\n \"AccountName\": \"andy\",\n \"Host\": \"1.1.1.1\"\n },\n \"GlobalPrivileges\": [\n \"CREATE\"\n ],\n \"DatabasePrivileges\": [\n {\n \"Db\": \"testDb\",\n \"Privileges\": [\n \"DELETE\"\n ]\n }\n ],\n \"TablePrivileges\": [\n {\n \"Db\": \"testDb\",\n \"TableName\": \"testTable\",\n \"Privileges\": [\n \"DROP\"\n ]\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\"\n }\n}", "title": "修改账号库表权限" } ], @@ -1050,7 +1050,7 @@ { "document": "任何场景", "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: OpenClusterReadOnlyInstanceGroupAccess\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-abcd1234\",\n \"Port\": \"3306\",\n \"SecurityGroupIds\": [\n \"SecurityGroupIds1\",\n \"SecurityGroupIds2\"\n ]\n}", - "output": "{\n \"Response\": {\n \"FlowId\": \"12345\",\n \"RequestId\": \"qwertyuiop\"\n }\n}", + "output": "{\n \"Response\": {\n \"FlowId\": \"147287\",\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\"\n }\n}", "title": "ex:" } ], @@ -1145,16 +1145,16 @@ "RevokeAccountPrivileges": [ { "document": "批量回收账号权限", - "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RevokeAccountPrivileges\n<公共请求参数>\n\n{\n \"Account\": {\n \"Host\": \"%\",\n \"AccountName\": \"test\"\n },\n \"DbTablePrivileges\": [\n \"ALTER\"\n ],\n \"ClusterId\": \"cynosdbmysql-xxxxxxxx\",\n \"DbTables\": [\n {\n \"TableName\": \"test-table\",\n \"Db\": \"test-db\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"147706\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RevokeAccountPrivileges\n<公共请求参数>\n\n{\n \"Account\": {\n \"Host\": \"%\",\n \"AccountName\": \"andy\"\n },\n \"DbTablePrivileges\": [\n \"ALTER\"\n ],\n \"ClusterId\": \"cynosdbmysql-j9i41hkf\",\n \"DbTables\": [\n {\n \"TableName\": \"andy-table\",\n \"Db\": \"andy-db\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\"\n }\n}", "title": "批量回收账号权限" } ], "RollBackCluster": [ { "document": "集群回档", - "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RollBackCluster\n<公共请求参数>\n\n{\n \"RollbackId\": 1,\n \"ClusterId\": \"cynosdbmysql-xxxxxxxx\",\n \"ExpectTimeThresh\": 1,\n \"RollbackStrategy\": \"snapRollback\",\n \"RollbackTables\": [\n {\n \"Tables\": [\n {\n \"OldTable\": \"old_table\",\n \"NewTable\": \"new_table\"\n }\n ],\n \"Database\": \"old_db1\"\n }\n ],\n \"ExpectTime\": \"2022-01-20 00:00:00\",\n \"RollbackDatabases\": [\n {\n \"NewDatabase\": \"new_db2\",\n \"OldDatabase\": \"old_db2\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"123\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RollBackCluster\n<公共请求参数>\n\n{\n \"RollbackId\": 1,\n \"ClusterId\": \"cynosdbmysql-j9i41hff\",\n \"ExpectTimeThresh\": 1,\n \"RollbackStrategy\": \"snapRollback\",\n \"RollbackTables\": [\n {\n \"Tables\": [\n {\n \"OldTable\": \"old_table\",\n \"NewTable\": \"new_table\"\n }\n ],\n \"Database\": \"old_db1\"\n }\n ],\n \"ExpectTime\": \"2022-01-20 00:00:00\",\n \"RollbackDatabases\": [\n {\n \"NewDatabase\": \"new_db2\",\n \"OldDatabase\": \"old_db2\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\",\n \"FlowId\": \"147283\"\n }\n}", "title": "集群回档" } ], diff --git a/tccli/services/dbbrain/v20191016/api.json b/tccli/services/dbbrain/v20191016/api.json index 1f8f596add..2c7ac0b2ec 100644 --- a/tccli/services/dbbrain/v20191016/api.json +++ b/tccli/services/dbbrain/v20191016/api.json @@ -362,9 +362,10 @@ { "disabled": false, "document": "异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "123456", + "example": "129543473", "member": "int64", "name": "AsyncRequestId", + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -842,6 +843,7 @@ "example": "健康巡检", "member": "string", "name": "DiagItem", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -851,6 +853,7 @@ "example": "数据库快照", "member": "string", "name": "DiagType", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -860,15 +863,17 @@ "example": "5", "member": "int64", "name": "EventId", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "事件详情。", - "example": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"慢会话详情\"}},[{\"Layout\":\"vertical\",\"DataType\":\"table\",\"Data\":{\"Names\":[\"Schema\",{\"Type\":\"sql\",\"Name\":\"SqlText\"}],\"Data\":[{\"Schema\":\"demo\",\"SqlText\":\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\"}]}}]]", + "example": "[{\"DataType\":\"title\"}]", "member": "string", "name": "Explanation", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -878,15 +883,17 @@ "example": "数据库健康检查,发现1个问题", "member": "string", "name": "Outline", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "诊断出的问题。", - "example": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"会话快照\"}},{\"DataType\":\"title\",\"Data\":{\"Name\":\"事务快照\"}},{\"DataType\":\"title\",\"Data\":{\"Name\":\"Innodb状态快照\"}}]", + "example": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"会话快照\"}}]", "member": "string", "name": "Problem", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -896,6 +903,7 @@ "example": "4", "member": "int64", "name": "Severity", + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -905,15 +913,17 @@ "example": "2019-11-06 12:05:40", "member": "datetime", "name": "StartTime", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "建议。", - "example": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"SQL优化\"}},[{\"DataType\":\"sqlAdvice\",\"Data\":{\"Advices\":[{\"TableName\":\"t1\",\"TableSchema\":\"demo\",\"Keys\":[{\"SqlText\":\"alter table `demo`.`t1` add index index_0(`c_time`);\"}]}],\"Comments\":[],\"Schema\":\"demo\",\"SqlPlan\":{\"Before\":[{\"Format\":\"Table\",\"Data\":{\"Names\":[\"id\",\"select_type\",\"table\",\"partitions\",\"type\",\"possible_keys\",\"key\",\"key_len\",\"ref\",\"rows\",\"filtered\",\"Extra\"],\"Data\":[[1,\"SIMPLE\",\"t2\",null,\"ALL\",null,null,null,null,161663,100,null],[1,\"SIMPLE\",\"t1\",null,\"ALL\",null,null,null,null,655801,3.33,null]]}}],\"After\":[{\"Format\":\"Table\",\"Data\":{\"Names\":[\"id\",\"select_type\",\"table\",\"partitions\",\"type\",\"possible_keys\",\"key\",\"key_len\",\"ref\",\"rows\",\"filtered\",\"Extra\"],\"Data\":[[1,\"SIMPLE\",\"t2\",null,\"ALL\",null,null,null,null,161663,100,null],[1,\"SIMPLE\",\"t1\",null,\"ALL\",\"index_0\",null,null,null,655801,33.33,null]]}}]},\"SqlText\":\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\",\"Tables\":[{\"TableName\":\"t1\",\"TableSchema\":\"demo\",\"TableDDL\":\"CREATE TABLE `t1` (\\n `id` int NOT NULL AUTO_INCREMENT,\\n `c_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,\\n `name` varchar(32) DEFAULT NULL,\\n `age` int NOT NULL DEFAULT '0',\\n PRIMARY KEY (`id`)\\n) ENGINE=InnoDB AUTO_INCREMENT=786393 DEFAULT CHARSET=utf8mb3\"},{\"TableName\":\"t2\",\"TableSchema\":\"demo\",\"TableDDL\":\"CREATE TABLE `t2` (\\n `id` int NOT NULL AUTO_INCREMENT,\\n `c_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,\\n `name` varchar(32) DEFAULT NULL,\\n `age` int NOT NULL DEFAULT '0',\\n PRIMARY KEY (`id`)\\n) ENGINE=InnoDB AUTO_INCREMENT=1507180 DEFAULT CHARSET=utf8mb3\"}],\"Cost\":{\"Before\":1.060202269597E10,\"After\":1.060202269597E10,\"Ratio\":0}}}]]", + "example": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"SQL优化\"}}]", "member": "string", "name": "Suggestions", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -923,6 +933,7 @@ "example": "innodb_rows_read_per_qps", "member": "string", "name": "Metric", + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -932,6 +943,7 @@ "example": "2019-11-06 12:05:50", "member": "datetime", "name": "EndTime", + "output_required": true, "type": "string", "value_allowed_null": false }, diff --git a/tccli/services/dbbrain/v20191016/examples.json b/tccli/services/dbbrain/v20191016/examples.json index e23d3e6cb1..e9704563be 100644 --- a/tccli/services/dbbrain/v20191016/examples.json +++ b/tccli/services/dbbrain/v20191016/examples.json @@ -11,7 +11,7 @@ "CreateDBDiagReportTask": [ { "document": "创建健康报告, 发送邮件。", - "input": "https://dbbrain.tencentcloudapi.com/?Action=CreateDBDiagReportTask\n&InstanceId=test\n&StartTime=2019-01-01T00:00:00+08:00\n&EndTime=2019-01-02T00:00:00+08:00\n&SendMailFlag=1\n&ContactPerson.0=1\n&ContactGroup.0=1\n&<公共请求参数>", + "input": "https://dbbrain.tencentcloudapi.com/?Action=CreateDBDiagReportTask\n&InstanceId=cdb-test1234\n&StartTime=2019-01-01T00:00:00+08:00\n&EndTime=2019-01-02T00:00:00+08:00\n&SendMailFlag=1\n&ContactPerson.0=1\n&ContactGroup.0=1\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"AsyncRequestId\": 129632,\n \"RequestId\": \"77db16d7-bbe8-48a7-868b-ed776a96f1ab\"\n }\n}", "title": "创建健康报告, 发送邮件(可选)" } @@ -75,8 +75,8 @@ "DescribeDBDiagEvent": [ { "document": "获取诊断事件详情。", - "input": "https://dbbrain.tencentcloudapi.com/?Action=DescribeDBDiagEvent\n&InstanceId=test\n&EventId=5\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Suggestions\": \"[]\",\n \"DiagType\": \"数据库快照\",\n \"EndTime\": \"2019-11-06 12:05:50\",\n \"RequestId\": \"78cf7bb1-0608-11ea-a9ef-2736f0f7f829\",\n \"Explanation\": \"[]\",\n \"StartTime\": \"2019-11-06 12:05:40\",\n \"Severity\": 4,\n \"EventId\": 5,\n \"Outline\": \"数据库健康检查,发现1个问题\",\n \"Problem\": \"[{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"会话快照\\\"}},{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"事务快照\\\"}},{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"Innodb状态快照\\\"}}]\",\n \"Metric\": \"\",\n \"DiagItem\": \"健康巡检\"\n }\n}", + "input": "https://dbbrain.tencentcloudapi.com/?Action=DescribeDBDiagEvent\n&InstanceId=cdb-test1234\n&EventId=5\n&<公共请求参数>", + "output": "{\n \"Response\": {\n \"Suggestions\": \"[{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"SQL优化\\\"}},[{\\\"DataType\\\":\\\"sqlAdvice\\\",\\\"Data\\\":{\\\"Advices\\\":[{\\\"TableName\\\":\\\"t1\\\",\\\"TableSchema\\\":\\\"demo\\\",\\\"Keys\\\":[{\\\"SqlText\\\":\\\"alter table `demo`.`t1` add index index_0(`c_time`);\\\"}]}],\\\"Comments\\\":[],\\\"Schema\\\":\\\"demo\\\",\\\"SqlPlan\\\":{},\\\"SqlText\\\":\\\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\\\",\\\"Tables\\\":[{\\\"TableName\\\":\\\"t1\\\",\\\"TableSchema\\\":\\\"demo\\\",\\\"TableDDL\\\":\\\"CREATE TABLE `t1` (\\\\n `id` int NOT NULL AUTO_INCREMENT,\\\\n `c_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,\\\\n `name` varchar(32) DEFAULT NULL,\\\\n `age` int NOT NULL DEFAULT '0',\\\\n PRIMARY KEY (`id`)\\\\n) ENGINE=InnoDB AUTO_INCREMENT=786393 DEFAULT CHARSET=utf8mb3\\\"}],\\\"Cost\\\":{\\\"Before\\\":1.060202269597E10,\\\"After\\\":1.060202269597E10,\\\"Ratio\\\":0}}}]]\",\n \"DiagType\": \"数据库快照\",\n \"EndTime\": \"2019-11-06 12:05:50\",\n \"RequestId\": \"78cf7bb1-0608-11ea-a9ef-2736f0f7f829\",\n \"Explanation\": \"[{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"慢会话详情\\\"}},[{\\\"Layout\\\":\\\"vertical\\\",\\\"DataType\\\":\\\"table\\\",\\\"Data\\\":{\\\"Names\\\":[\\\"Schema\\\",{\\\"Type\\\":\\\"sql\\\",\\\"Name\\\":\\\"SqlText\\\"}],\\\"Data\\\":[{\\\"Schema\\\":\\\"demo\\\",\\\"SqlText\\\":\\\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\\\"}]}}]]\",\n \"StartTime\": \"2019-11-06 12:05:40\",\n \"Severity\": 4,\n \"EventId\": 5,\n \"Outline\": \"数据库健康检查,发现1个问题\",\n \"Problem\": \"[{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"会话快照\\\"}},{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"事务快照\\\"}},{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"Innodb状态快照\\\"}}]\",\n \"Metric\": \"\",\n \"DiagItem\": \"健康巡检\"\n }\n}", "title": "获取诊断事件详情" } ], @@ -210,13 +210,13 @@ { "document": "获取SQL优化建议。", "input": "https://dbbrain.tencentcloudapi.com/?Action=DescribeUserSqlAdvice\n&InstanceId=cdb-c1nl9rpv\n&SqlText=select * from t1 where id in ( ? )\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"e2a51350-8c9f-11eb-bc0f-c9f5ab88d057\",\n \"Advices\": \"[{\\\"TableName\\\": \\\"t1\\\", \\\"TableSchema\\\": \\\"test\\\", \\\"Keys\\\": [{\\\"SqlText\\\": \\\"alter table `test`.`t1` add index index_0(`id`);\\\"}]}]\",\n \"Comments\": \"[\\\"Failed to parse SQL statement\\\"]\",\n \"Schema\": \"demo_db\",\n \"Tables\": \"[{\\\"TableName\\\": \\\"t1\\\", \\\"TableSchema\\\": \\\"test\\\", \\\"TableDDL\\\": \\\"CREATE TABLE `test` (\\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\\\"}]\",\n \"SqlText\": \"select * from t1 where id in ( ? )\",\n \"SqlPlan\": \"{\\\"Before\\\": [{\\\"Format\\\": \\\"Table\\\", \\\"Data\\\": {\\\"Names\\\": [\\\"id\\\", \\\"select_type\\\", \\\"table\\\", \\\"partitions\\\", \\\"type\\\", \\\"possible_keys\\\", \\\"key\\\", \\\"key_len\\\", \\\"ref\\\", \\\"rows\\\", \\\"filtered\\\", \\\"Extra\\\"], \\\"Data\\\": [ [1, \\\"SIMPLE\\\", \\\"t1\\\", null, \\\"ALL\\\", null, null, null, null, 1530, 10, \\\"Using where\\\" ]]}}], \\\"After\\\": [{ \\\"Format\\\": \\\"Table\\\", \\\"Data\\\": {\\\"Names\\\": [\\\"id\\\", \\\"select_type\\\", \\\"table\\\", \\\"partitions\\\", \\\"type\\\", \\\"possible_keys\\\", \\\"key\\\", \\\"key_len\\\", \\\"ref\\\", \\\"rows\\\", \\\"filtered\\\", \\\"Extra\\\"], \\\"Data\\\": [[1, \\\"SIMPLE\\\", \\\"t1\\\", null, \\\"ref\\\", \\\"index_0\\\", \\\"index_0\\\", 1056, \\\"const\\\", 51, 100.00, null]]}}]}\",\n \"Cost\": \"{\\\"Before\\\": 0.1, \\\"After\\\": 0.03, \\\"Ratio\\\": 90.61}\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"e2a51350-8c9f-11eb-bc0f-c9f5ab88d057\",\n \"Advices\": \"[{\\\"TableName\\\": \\\"t1\\\", \\\"TableSchema\\\": \\\"demo_db\\\", \\\"Keys\\\": [{\\\"SqlText\\\": \\\"alter table `test`.`t1` add index index_0(`id`);\\\"}]}]\",\n \"Comments\": \"[\\\"Failed to parse SQL statement\\\"]\",\n \"Schema\": \"demo_db\",\n \"Tables\": \"[{\\\"TableName\\\": \\\"t1\\\", \\\"TableSchema\\\": \\\"demo_db\\\", \\\"TableDDL\\\": \\\"CREATE TABLE `test` (\\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\\\"}]\",\n \"SqlText\": \"select * from t1 where id in ( ? )\",\n \"SqlPlan\": \"{\\\"Before\\\": [{\\\"Format\\\": \\\"Table\\\", \\\"Data\\\": {\\\"Names\\\": [\\\"id\\\", \\\"select_type\\\", \\\"table\\\", \\\"partitions\\\", \\\"type\\\", \\\"possible_keys\\\", \\\"key\\\", \\\"key_len\\\", \\\"ref\\\", \\\"rows\\\", \\\"filtered\\\", \\\"Extra\\\"], \\\"Data\\\": [ [1, \\\"SIMPLE\\\", \\\"t1\\\", null, \\\"ALL\\\", null, null, null, null, 1530, 10, \\\"Using where\\\" ]]}}], \\\"After\\\": [{ \\\"Format\\\": \\\"Table\\\", \\\"Data\\\": {\\\"Names\\\": [\\\"id\\\", \\\"select_type\\\", \\\"table\\\", \\\"partitions\\\", \\\"type\\\", \\\"possible_keys\\\", \\\"key\\\", \\\"key_len\\\", \\\"ref\\\", \\\"rows\\\", \\\"filtered\\\", \\\"Extra\\\"], \\\"Data\\\": [[1, \\\"SIMPLE\\\", \\\"t1\\\", null, \\\"ref\\\", \\\"index_0\\\", \\\"index_0\\\", 1056, \\\"const\\\", 51, 100.00, null]]}}]}\",\n \"Cost\": \"{\\\"Before\\\": 0.1, \\\"After\\\": 0.03, \\\"Ratio\\\": 90.61}\"\n }\n}", "title": "获取SQL优化建议" }, { "document": "获取无需优化SQL的优化建议。", "input": "https://dbbrain.tencentcloudapi.com/?Action=DescribeUserSqlAdvice\n&InstanceId=cdb-c1nl9rpv\n&SqlText=select * from t1 where id = ?\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"e2a51350-8c9f-11eb-bc0f-c9f5ab88d057\",\n \"Advices\": \"\",\n \"Comments\": \"\",\n \"Schema\": \"test\",\n \"Tables\": \"[{\\\"TableName\\\": \\\"t1\\\", \\\"TableSchema\\\": \\\"test\\\", \\\"TableDDL\\\": \\\"CREATE TABLE `test` (\\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\\\"}]\",\n \"SqlText\": \"select * from t1 where id in ( ? )\",\n \"SqlPlan\": \"\",\n \"Cost\": \"\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"e2a51350-8c9f-11eb-bc0f-c9f5ab88d057\",\n \"Advices\": \"\",\n \"Comments\": \"\",\n \"Schema\": \"demo_db\",\n \"Tables\": \"[{\\\"TableName\\\": \\\"t1\\\", \\\"TableSchema\\\": \\\"demo_db\\\", \\\"TableDDL\\\": \\\"CREATE TABLE `test` (\\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\\\"}]\",\n \"SqlText\": \"select * from t1 where id in ( ? )\",\n \"SqlPlan\": \"\",\n \"Cost\": \"\"\n }\n}", "title": "获取无需优化SQL的优化建议" } ], diff --git a/tccli/services/dbbrain/v20210527/api.json b/tccli/services/dbbrain/v20210527/api.json index af37cd0912..77423f03c0 100644 --- a/tccli/services/dbbrain/v20210527/api.json +++ b/tccli/services/dbbrain/v20210527/api.json @@ -1434,7 +1434,7 @@ "example": "129542924", "member": "int64", "name": "AsyncRequestId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -1732,10 +1732,10 @@ { "disabled": false, "document": "创建 kill 会话任务返回的异步任务 id", - "example": "123456", + "example": "14672492", "member": "int64", "name": "AsyncRequestId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -2704,7 +2704,7 @@ "example": "健康巡检", "member": "string", "name": "DiagItem", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -2714,7 +2714,7 @@ "example": "数据库快照", "member": "string", "name": "DiagType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -2724,17 +2724,17 @@ "example": "5", "member": "int64", "name": "EventId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "诊断事件详情,若无附加解释信息则输出为空。", - "example": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"慢会话详情\"}},[{\"Layout\":\"vertical\",\"DataType\":\"table\",\"Data\":{\"Names\":[\"Schema\",{\"Type\":\"sql\",\"Name\":\"SqlText\"}],\"Data\":[{\"Schema\":\"demo\",\"SqlText\":\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\"}]}}]]", + "example": "[{\"DataType\":\"title\"}]", "member": "string", "name": "Explanation", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -2744,17 +2744,17 @@ "example": "数据库健康检查,发现1个问题", "member": "string", "name": "Outline", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "诊断出的问题。", - "example": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"会话快照\"}},{\"DataType\":\"title\",\"Data\":{\"Name\":\"事务快照\"}},{\"DataType\":\"title\",\"Data\":{\"Name\":\"Innodb状态快照\"}}]", + "example": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"会话快照\"}}]", "member": "string", "name": "Problem", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -2764,7 +2764,7 @@ "example": "4", "member": "int64", "name": "Severity", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -2774,17 +2774,17 @@ "example": "2019-11-06 12:05:40", "member": "datetime", "name": "StartTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "诊断建议,若无建议则输出为空。", - "example": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"SQL优化\"}},[{\"DataType\":\"sqlAdvice\",\"Data\":{\"Advices\":[{\"TableName\":\"t1\",\"TableSchema\":\"demo\",\"Keys\":[{\"SqlText\":\"alter table `demo`.`t1` add index index_0(`c_time`);\"}]}],\"Comments\":[],\"Schema\":\"demo\",\"SqlPlan\":{\"Before\":[{\"Format\":\"Table\",\"Data\":{\"Names\":[\"id\",\"select_type\",\"table\",\"partitions\",\"type\",\"possible_keys\",\"key\",\"key_len\",\"ref\",\"rows\",\"filtered\",\"Extra\"],\"Data\":[[1,\"SIMPLE\",\"t2\",null,\"ALL\",null,null,null,null,161663,100,null],[1,\"SIMPLE\",\"t1\",null,\"ALL\",null,null,null,null,655801,3.33,null]]}}],\"After\":[{\"Format\":\"Table\",\"Data\":{\"Names\":[\"id\",\"select_type\",\"table\",\"partitions\",\"type\",\"possible_keys\",\"key\",\"key_len\",\"ref\",\"rows\",\"filtered\",\"Extra\"],\"Data\":[[1,\"SIMPLE\",\"t2\",null,\"ALL\",null,null,null,null,161663,100,null],[1,\"SIMPLE\",\"t1\",null,\"ALL\",\"index_0\",null,null,null,655801,33.33,null]]}}]},\"SqlText\":\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\",\"Tables\":[{\"TableName\":\"t1\",\"TableSchema\":\"demo\",\"TableDDL\":\"CREATE TABLE `t1` (\\n `id` int NOT NULL AUTO_INCREMENT,\\n `c_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,\\n `name` varchar(32) DEFAULT NULL,\\n `age` int NOT NULL DEFAULT '0',\\n PRIMARY KEY (`id`)\\n) ENGINE=InnoDB AUTO_INCREMENT=786393 DEFAULT CHARSET=utf8mb3\"},{\"TableName\":\"t2\",\"TableSchema\":\"demo\",\"TableDDL\":\"CREATE TABLE `t2` (\\n `id` int NOT NULL AUTO_INCREMENT,\\n `c_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,\\n `name` varchar(32) DEFAULT NULL,\\n `age` int NOT NULL DEFAULT '0',\\n PRIMARY KEY (`id`)\\n) ENGINE=InnoDB AUTO_INCREMENT=1507180 DEFAULT CHARSET=utf8mb3\"}],\"Cost\":{\"Before\":1.060202269597E10,\"After\":1.060202269597E10,\"Ratio\":0}}}]]", + "example": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"SQL优化\"}}]", "member": "string", "name": "Suggestions", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -2794,7 +2794,7 @@ "example": "innodb_rows_read_per_qps", "member": "string", "name": "Metric", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -2804,7 +2804,7 @@ "example": "2019-11-06 12:05:50", "member": "datetime", "name": "EndTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -4570,7 +4570,7 @@ { "disabled": false, "document": "实例 ID 。", - "example": "test", + "example": "cdb-test1234", "member": "string", "name": "InstanceId", "required": true, @@ -8573,7 +8573,7 @@ "example": "0.00008", "member": "float", "name": "LockTime", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8583,7 +8583,7 @@ "example": "0.000096", "member": "float", "name": "LockTimeMax", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8593,17 +8593,17 @@ "example": "0.000041", "member": "float", "name": "LockTimeMin", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, { "disabled": false, "document": "总扫描行数", - "example": "584832", + "example": "584833", "member": "int64", "name": "RowsExamined", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -8613,7 +8613,7 @@ "example": "101782", "member": "int64", "name": "RowsExaminedMax", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -8623,7 +8623,7 @@ "example": "584832", "member": "int64", "name": "RowsExaminedMin", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -8633,7 +8633,7 @@ "example": "0.513363", "member": "float", "name": "QueryTime", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8643,7 +8643,7 @@ "example": "0.765213", "member": "float", "name": "QueryTimeMax", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8653,7 +8653,7 @@ "example": "0.629921", "member": "float", "name": "QueryTimeMin", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8663,7 +8663,7 @@ "example": "292416", "member": "int64", "name": "RowsSent", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -8673,7 +8673,7 @@ "example": "292416", "member": "int64", "name": "RowsSentMax", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -8683,7 +8683,7 @@ "example": "292416", "member": "int64", "name": "RowsSentMin", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -8693,7 +8693,7 @@ "example": "37", "member": "int64", "name": "ExecTimes", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -8703,7 +8703,7 @@ "example": "select * from t;", "member": "string", "name": "SqlTemplate", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -8713,7 +8713,7 @@ "example": "SELECT * FROM t;", "member": "string", "name": "SqlText", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -8723,7 +8723,7 @@ "example": "test_center", "member": "string", "name": "Schema", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -8733,7 +8733,7 @@ "example": "2.44", "member": "float", "name": "QueryTimeRatio", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8743,7 +8743,7 @@ "example": "1.92", "member": "float", "name": "LockTimeRatio", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8753,7 +8753,7 @@ "example": "2.3", "member": "float", "name": "RowsExaminedRatio", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8763,7 +8763,7 @@ "example": "18.67", "member": "float", "name": "RowsSentRatio", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8773,7 +8773,7 @@ "example": "0.513363", "member": "float", "name": "QueryTimeAvg", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8783,7 +8783,7 @@ "example": "26518.0", "member": "float", "name": "RowsSentAvg", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8793,7 +8793,7 @@ "example": "0.000096", "member": "float", "name": "LockTimeAvg", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8803,7 +8803,7 @@ "example": "584832.0", "member": "float", "name": "RowsExaminedAvg", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": false }, @@ -8813,7 +8813,7 @@ "example": "AD7651E51E8C6FBA", "member": "string", "name": "Md5", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } diff --git a/tccli/services/dbbrain/v20210527/examples.json b/tccli/services/dbbrain/v20210527/examples.json index ffe6145dbc..9294f61742 100644 --- a/tccli/services/dbbrain/v20210527/examples.json +++ b/tccli/services/dbbrain/v20210527/examples.json @@ -35,7 +35,7 @@ "CreateDBDiagReportTask": [ { "document": "", - "input": "https://dbbrain.tencentcloudapi.com/?Action=CreateDBDiagReportTask\n&InstanceId=test\n&StartTime=2019-01-01T00:00:00+08:00\n&EndTime=2019-01-02T00:00:00+08:00\n&SendMailFlag=1\n&ContactPerson.0=1\n&ContactGroup.0=1\n&<公共请求参数>", + "input": "https://dbbrain.tencentcloudapi.com/?Action=CreateDBDiagReportTask\n&InstanceId=cdb-test1234\n&StartTime=2019-01-01T00:00:00+08:00\n&EndTime=2019-01-02T00:00:00+08:00\n&SendMailFlag=1\n&ContactPerson.0=1\n&ContactGroup.0=1\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"AsyncRequestId\": 129632,\n \"RequestId\": \"77db16d7-bbe8-48a7-868b-ed776a96f1ab\"\n }\n}", "title": "创建健康报告, 发送邮件(可选)" } @@ -68,7 +68,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: dbbrain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateProxySessionKillTask\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdb-8jawylhf\",\n \"Product\": \"redis\"\n}", - "output": "{\n \"Response\": {\n \"AsyncRequestId\": 123456,\n \"RequestId\": \"xx\"\n }\n}", + "output": "{\n \"Response\": {\n \"AsyncRequestId\": 14672492,\n \"RequestId\": \"17351ed0-c126-11ef-9567-2ff75b8b0530\"\n }\n}", "title": "根据实例 id 创建终止所有代理节点会话连接的异步任务" } ], @@ -147,7 +147,7 @@ "DescribeAlarmTemplate": [ { "document": "查询通知模板示例", - "input": "POST / HTTP/1.1\nHost: dbbrain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAlarmTemplate\n<公共请求参数>\n\n{\n \"TemplateNameRegexp\": \"test\",\n \"Limit\": 50,\n \"Offset\": 0\n}", + "input": "POST / HTTP/1.1\nHost: dbbrain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAlarmTemplate\n<公共请求参数>\n\n{\n \"TemplateNameRegexp\": \"demoTemplate\",\n \"Limit\": 50,\n \"Offset\": 0\n}", "output": "{\n \"Response\": {\n \"ProfileList\": [],\n \"RequestId\": \"5c2ad5eb-784b-4ff4-8860-17f75f4e5c1f\",\n \"TotalCount\": 0\n }\n}", "title": "查询通知模板示例" } @@ -187,8 +187,8 @@ "DescribeDBDiagEvent": [ { "document": "", - "input": "https://dbbrain.tencentcloudapi.com/?Action=DescribeDBDiagEvent\n&InstanceId=test\n&EventId=5\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Suggestions\": \"[]\",\n \"DiagType\": \"数据库快照\",\n \"EndTime\": \"2019-11-06 12:05:50\",\n \"RequestId\": \"78cf7bb1-0608-11ea-a9ef-2736f0f7f829\",\n \"Explanation\": \"[]\",\n \"StartTime\": \"2019-11-06 12:05:40\",\n \"Severity\": 4,\n \"EventId\": 5,\n \"Outline\": \"数据库健康检查,发现1个问题\",\n \"Problem\": \"[{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"会话快照\\\"}},{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"事务快照\\\"}},{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"Innodb状态快照\\\"}}]\",\n \"Metric\": \"\",\n \"DiagItem\": \"健康巡检\"\n }\n}", + "input": "https://dbbrain.tencentcloudapi.com/?Action=DescribeDBDiagEvent\n&InstanceId=cdb-test1234\n&EventId=5\n&<公共请求参数>", + "output": "{\n \"Response\": {\n \"Suggestions\": \"[{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"SQL优化\\\"}},[{\\\"DataType\\\":\\\"sqlAdvice\\\",\\\"Data\\\":{\\\"Advices\\\":[{\\\"TableName\\\":\\\"t1\\\",\\\"TableSchema\\\":\\\"demo\\\",\\\"Keys\\\":[{\\\"SqlText\\\":\\\"alter table `demo`.`t1` add index index_0(`c_time`);\\\"}]}],\\\"Comments\\\":[],\\\"Schema\\\":\\\"demo\\\",\\\"SqlPlan\\\":{},\\\"SqlText\\\":\\\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\\\",\\\"Tables\\\":[{\\\"TableName\\\":\\\"t1\\\",\\\"TableSchema\\\":\\\"demo\\\",\\\"TableDDL\\\":\\\"CREATE TABLE `t1` (\\\\n `id` int NOT NULL AUTO_INCREMENT,\\\\n `c_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,\\\\n `name` varchar(32) DEFAULT NULL,\\\\n `age` int NOT NULL DEFAULT '0',\\\\n PRIMARY KEY (`id`)\\\\n) ENGINE=InnoDB AUTO_INCREMENT=786393 DEFAULT CHARSET=utf8mb3\\\"}],\\\"Cost\\\":{\\\"Before\\\":1.060202269597E10,\\\"After\\\":1.060202269597E10,\\\"Ratio\\\":0}}}]]\",\n \"DiagType\": \"数据库快照\",\n \"EndTime\": \"2019-11-06 12:05:50\",\n \"RequestId\": \"78cf7bb1-0608-11ea-a9ef-2736f0f7f829\",\n \"Explanation\": \"[{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"慢会话详情\\\"}},[{\\\"Layout\\\":\\\"vertical\\\",\\\"DataType\\\":\\\"table\\\",\\\"Data\\\":{\\\"Names\\\":[\\\"Schema\\\",{\\\"Type\\\":\\\"sql\\\",\\\"Name\\\":\\\"SqlText\\\"}],\\\"Data\\\":[{\\\"Schema\\\":\\\"demo\\\",\\\"SqlText\\\":\\\"select t1.*, t2.* from t1, t2 where t1.c_time = t2.c_time and t1.name > t2.name order by t2.name limit 10\\\"}]}}]]\",\n \"StartTime\": \"2019-11-06 12:05:40\",\n \"Severity\": 4,\n \"EventId\": 5,\n \"Outline\": \"数据库健康检查,发现1个问题\",\n \"Problem\": \"[{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"会话快照\\\"}},{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"事务快照\\\"}},{\\\"DataType\\\":\\\"title\\\",\\\"Data\\\":{\\\"Name\\\":\\\"Innodb状态快照\\\"}}]\",\n \"Metric\": \"\",\n \"DiagItem\": \"健康巡检\"\n }\n}", "title": "获取诊断事件详情" } ], @@ -355,8 +355,8 @@ "DescribeSlowLogTopSqls": [ { "document": "按照Sql模板+schema的聚合方式,统计排序指定时间段内的top慢sql。", - "input": "https://dbbrain.tencentcloudapi.com/?Action=DescribeSlowLogTopSqls\n&InstanceId=test\n&SortBy=QueryTime\n&OrderBy=ASC\n&Limit=10\n&Offset=0\n&StartTime=2019-01-01 00:00:00\n&EndTime=2019-01-01 01:00:00\n&SchemaList.0.Schema=dbName\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"ed279d8b-a9d9-48d6-9429-e0fde000994a\",\n \"TotalCount\": 1,\n \"Rows\": [\n {\n \"QueryTimeMin\": 0.0,\n \"LockTimeMin\": 0.0,\n \"QueryTimeMax\": 14.086705,\n \"QueryTimeRatio\": 0.0,\n \"RowsSentRatio\": 0.0,\n \"RowsSentMax\": 0,\n \"RowsExaminedMin\": 0,\n \"RowsSentMin\": 0,\n \"SqlText\": \"select * from user where name='sz'\",\n \"Schema\": \"test\",\n \"LockTimeMax\": 0.0,\n \"LockTimeRatio\": 0.0,\n \"ExecTimes\": 2,\n \"LockTimeAvg\": 0.0,\n \"RowsExamined\": 0,\n \"RowsSentAvg\": 0.0,\n \"QueryTime\": 28.17341,\n \"RowsExaminedAvg\": 0.0,\n \"RowsExaminedMax\": 0,\n \"RowsSent\": 0,\n \"RowsExaminedRatio\": 0.0,\n \"QueryTimeAvg\": 0.0,\n \"SqlTemplate\": \"select * from user where name=?\",\n \"LockTime\": 0.0,\n \"Md5\": \"2323847233\"\n }\n ]\n }\n}", + "input": "https://dbbrain.tencentcloudapi.com/?Action=DescribeSlowLogTopSqls\n&InstanceId=cdb-test1234\n&SortBy=QueryTime\n&OrderBy=ASC\n&Limit=10\n&Offset=0\n&StartTime=2019-01-01 00:00:00\n&EndTime=2019-01-01 01:00:00\n&SchemaList.0.Schema=dbName\n&<公共请求参数>", + "output": "{\n \"Response\": {\n \"RequestId\": \"ed279d8b-a9d9-48d6-9429-e0fde000994a\",\n \"TotalCount\": 1,\n \"Rows\": [\n {\n \"QueryTimeMin\": 0.0,\n \"LockTimeMin\": 0.0,\n \"QueryTimeMax\": 14.086705,\n \"QueryTimeRatio\": 0.0,\n \"RowsSentRatio\": 0.0,\n \"RowsSentMax\": 0,\n \"RowsExaminedMin\": 0,\n \"RowsSentMin\": 0,\n \"SqlText\": \"select * from user where name='sz'\",\n \"Schema\": \"dbName\",\n \"LockTimeMax\": 0.0,\n \"LockTimeRatio\": 0.0,\n \"ExecTimes\": 2,\n \"LockTimeAvg\": 0.0,\n \"RowsExamined\": 0,\n \"RowsSentAvg\": 0.0,\n \"QueryTime\": 28.17341,\n \"RowsExaminedAvg\": 0.0,\n \"RowsExaminedMax\": 0,\n \"RowsSent\": 0,\n \"RowsExaminedRatio\": 0.0,\n \"QueryTimeAvg\": 0.0,\n \"SqlTemplate\": \"select * from user where name=?\",\n \"LockTime\": 0.0,\n \"Md5\": \"2323847233\"\n }\n ]\n }\n}", "title": "获取慢SQL模板列表 " } ], @@ -434,7 +434,7 @@ { "document": "", "input": "https://dbbrain.tencentcloudapi.com/?Action=DescribeUserSqlAdvice\n&InstanceId=cdb-c1nl9rpv\n&SqlText=select * from t1 where id = ?\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"e2a51350-8c9f-11eb-bc0f-c9f5ab88d057\",\n \"Advices\": \"\",\n \"Comments\": \"\",\n \"Schema\": \"test\",\n \"Tables\": \"[{\\\"TableName\\\": \\\"t1\\\", \\\"TableSchema\\\": \\\"test\\\", \\\"TableDDL\\\": \\\"CREATE TABLE `test` (\\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\\\"}]\",\n \"SqlText\": \"select * from t1 where id in ( ? )\",\n \"SqlPlan\": \"\",\n \"Cost\": \"\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"e2a51350-8c9f-11eb-bc0f-c9f5ab88d057\",\n \"Advices\": \"\",\n \"Comments\": \"\",\n \"Schema\": \"demo_db\",\n \"Tables\": \"[{\\\"TableName\\\": \\\"t1\\\", \\\"TableSchema\\\": \\\"demo_db\\\", \\\"TableDDL\\\": \\\"CREATE TABLE `test` (\\n `id` varchar(36) NOT NULL) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC\\\"}]\",\n \"SqlText\": \"select * from t1 where id in ( ? )\",\n \"SqlPlan\": \"\",\n \"Cost\": \"\"\n }\n}", "title": "获取无需优化SQL的优化建议" } ], diff --git a/tccli/services/dts/v20180330/api.json b/tccli/services/dts/v20180330/api.json index 02a1e2743b..ffcf0a19c0 100644 --- a/tccli/services/dts/v20180330/api.json +++ b/tccli/services/dts/v20180330/api.json @@ -424,7 +424,7 @@ { "disabled": false, "document": "需要迁移的源数据库表信息,用json格式的字符串描述。当MigrateOption.MigrateObject配置为2(指定库表迁移)时必填。\n对于database-table两级结构的数据库:\n[{\"Database\":\"db1\",\"Table\":[\"table1\",\"table2\"]},{\"Database\":\"db2\"}]\n对于database-schema-table三级结构:\n[{\"Database\":\"db1\",\"Schema\":\"s1\",\"Table\":[\"table1\",\"table2\"]},{\"Database\":\"db1\",\"Schema\":\"s2\",\"Table\":[\"table1\",\"table2\"]},{\"Database\":\"db2\",\"Schema\":\"s1\",\"Table\":[\"table1\",\"table2\"]},{\"Database\":\"db3\"},{\"Database\":\"db4\",\"Schema\":\"s1\"}]", - "example": "无", + "example": "[{\"Database\":\"db1\",\"Table\":[\"table1\",\"table2\"]},{\"Database\":\"db2\"}]", "member": "string", "name": "DatabaseInfo", "required": false, @@ -469,7 +469,7 @@ "example": "dts-1kl0iy0v", "member": "string", "name": "JobId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -737,7 +737,7 @@ { "disabled": false, "document": "数据迁移任务名称", - "example": "无", + "example": "dts-job1", "member": "string", "name": "JobName", "required": false, @@ -800,7 +800,7 @@ "example": "2", "member": "uint64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -810,7 +810,7 @@ "example": "无", "member": "MigrateJobInfo", "name": "JobList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1506,17 +1506,17 @@ "example": "dts-75sekyal", "member": "string", "name": "JobId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "数据迁移任务名称", - "example": "test", + "example": "dts-75sekyal", "member": "string", "name": "JobName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1526,7 +1526,7 @@ "example": "{\"ConsistencyParams\":{\"SelectRowsPerTable\":0,\"TablesSelectAll\":0", "member": "MigrateOption", "name": "MigrateOption", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -1536,7 +1536,7 @@ "example": "mysql", "member": "string", "name": "SrcDatabaseType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1546,7 +1546,7 @@ "example": "cdb", "member": "string", "name": "SrcAccessType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1556,7 +1556,7 @@ "example": "{\"AccessKey\":\"\",\"CcnId\":\"\",\"CvmInstanceId\":\"\",\"EngineVersion\":\"\"", "member": "SrcInfo", "name": "SrcInfo", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -1566,7 +1566,7 @@ "example": "mysql", "member": "string", "name": "DstDatabaseType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1576,7 +1576,7 @@ "example": "cdb", "member": "string", "name": "DstAccessType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1586,17 +1586,17 @@ "example": "{\"CcnId\":\"\",\"CvmInstanceId\":\"\",\"InstanceId\":\"crs-eciqrvyo\",\"Ip\":", "member": "DstInfo", "name": "DstInfo", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, { "disabled": false, "document": "需要迁移的源数据库表信息,如果需要迁移的是整个实例,该字段为[]", - "example": "\"\"", + "example": "[{\"Database\":\"db1\",\"Table\":[\"table1\",\"table2\"]},{\"Database\":\"db2\"}]", "member": "string", "name": "DatabaseInfo", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1606,7 +1606,7 @@ "example": "2022-04-14 16:35:23", "member": "datetime", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1616,7 +1616,7 @@ "example": "2022-04-14 16:48:33", "member": "datetime", "name": "StartTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1626,17 +1626,17 @@ "example": "2022-04-14 16:48:33", "member": "datetime", "name": "EndTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, - "document": "任务状态,取值为:1-创建中(Creating),3-校验中(Checking)4-校验通过(CheckPass),5-校验不通过(CheckNotPass),7-任务运行(Running),8-准备完成(ReadyComplete),9-任务成功(Success),10-任务失败(Failed),11-撤销中(Stopping),12-完成中(Completing)", + "document": "任务状态,取值为:1-创建中(Creating),3-校验中(Checking)4-校验通过(CheckPass),5-校验不通过(CheckNotPass),7-任务运行(Running),8-准备完成(ReadyComplete),9-任务成功(Success),10-任务失败(Failed),11-撤销中(Stopping),12-完成中(Completing),23-未知状态(Unknown)", "example": "6", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -1646,27 +1646,27 @@ "example": "{\"CurrentStepProgress\":\"0\",\"MasterSlaveDistance\":-1,\"Progress\":\"", "member": "MigrateDetailInfo", "name": "Detail", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, { "disabled": false, "document": "任务错误信息提示,当任务发生错误时,不为null或者空值", - "example": " []", + "example": "无", "member": "ErrorInfo", "name": "ErrorInfo", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "标签\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "无", "member": "TagItem", "name": "Tags", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -1676,7 +1676,7 @@ "example": "[{\"AccessKey\":\"\",\"CcnId\":\"\",\"CvmInstanceId\":\"\",\"EngineVersion\":\"", "member": "SrcInfo", "name": "SrcInfoMulti", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -1848,7 +1848,7 @@ { "disabled": false, "document": "数据迁移任务名称", - "example": "test", + "example": "dts-75sekyal", "member": "string", "name": "JobName", "required": false, @@ -1902,7 +1902,7 @@ { "disabled": false, "document": "当选择'指定库表'迁移的时候, 需要设置待迁移的源数据库表信息,用符合json数组格式的字符串描述, 如下所例。\n\n对于database-table两级结构的数据库:\n[{\"Database\":\"db1\",\"Table\":[\"table1\",\"table2\"]},{\"Database\":\"db2\"}]\n对于database-schema-table三级结构:\n[{\"Database\":\"db1\",\"Schema\":\"s1\",\"Table\":[\"table1\",\"table2\"]},{\"Database\":\"db1\",\"Schema\":\"s2\",\"Table\":[\"table1\",\"table2\"]},{\"Database\":\"db2\",\"Schema\":\"s1\",\"Table\":[\"table1\",\"table2\"]},{\"Database\":\"db3\"},{\"Database\":\"db4\",\"Schema\":\"s1\"}]\n\n如果是'整个实例'的迁移模式,不需设置该字段", - "example": "无", + "example": "[{\"Database\":\"db1\",\"Table\":[\"table1\",\"table2\"]},{\"Database\":\"db2\"}]", "member": "string", "name": "DatabaseInfo", "required": false, diff --git a/tccli/services/dts/v20180330/examples.json b/tccli/services/dts/v20180330/examples.json index bffec74453..bb1f141cd4 100644 --- a/tccli/services/dts/v20180330/examples.json +++ b/tccli/services/dts/v20180330/examples.json @@ -27,19 +27,19 @@ "CreateMigrateJob": [ { "document": "将用户通过专线接入的mysql实例, 全量+增量迁移迁移到腾讯云上海地域的cdb-d0dqi8nv实例上. 其中源实例的接入地域为广州.", - "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateMigrateJob\n<公共请求参数>\n\n{\n \"JobName\": \"设置为一个方便辨识的名称\",\n \"SrcDatabaseType\": \"mysql\",\n \"SrcAccessType\": \"dcg\",\n \"SrcInfo\": {\n \"Supplier\": \"others\",\n \"UniqDcgId\": \"dcg-cyrjcc09\",\n \"VpcId\": \"vpc-72jblfaa\",\n \"SubnetId\": \"subnet-7raec42a\",\n \"Ip\": \"192.168.120.136\",\n \"Region\": \"ap-guangzhou\",\n \"User\": \"root\",\n \"Password\": \"yourPassword\",\n \"Port\": 3306\n },\n \"DstDatabaseType\": \"mysql\",\n \"DstAccessType\": \"cdb\",\n \"DstInfo\": {\n \"InstanceId\": \"cdb-d0dqi8nv\",\n \"Region\": \"ap-shanghai\",\n \"ReadOnly\": 0,\n \"User\": \"root\",\n \"Password\": \"yourPassword\"\n },\n \"DatabaseInfo\": \"[{\\\"Database\\\":\\\"test\\\",\\\"Table\\\":[\\\"user\\\",\\\"log\\\"]}]\",\n \"Tags\": [\n {\n \"TagKey\": \"负责人\",\n \"TagValue\": \"bob\"\n }\n ],\n \"MigrateOption\": {\n \"ExternParams\": \"{}\",\n \"MigrateObject\": 1,\n \"RunMode\": 1,\n \"ExpectTime\": \"2020-09-22 00:00:00\",\n \"ConsistencyType\": 2,\n \"MigrateType\": 2,\n \"IsOverrideRoot\": 0\n }\n}", + "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateMigrateJob\n<公共请求参数>\n\n{\n \"JobName\": \"设置为一个方便辨识的名称\",\n \"SrcDatabaseType\": \"mysql\",\n \"SrcAccessType\": \"dcg\",\n \"SrcInfo\": {\n \"Supplier\": \"others\",\n \"UniqDcgId\": \"dcg-cyrjcc09\",\n \"VpcId\": \"vpc-72jblfaa\",\n \"SubnetId\": \"subnet-7raec42a\",\n \"Ip\": \"192.168.120.136\",\n \"Region\": \"ap-guangzhou\",\n \"User\": \"root\",\n \"Password\": \"yourPassword\",\n \"Port\": 3306\n },\n \"DstDatabaseType\": \"mysql\",\n \"DstAccessType\": \"cdb\",\n \"DstInfo\": {\n \"InstanceId\": \"cdb-d0dqi8nv\",\n \"Region\": \"ap-shanghai\",\n \"ReadOnly\": 0,\n \"User\": \"root\",\n \"Password\": \"yourPassword\"\n },\n \"DatabaseInfo\": \"\",\n \"Tags\": [\n {\n \"TagKey\": \"负责人\",\n \"TagValue\": \"bob\"\n }\n ],\n \"MigrateOption\": {\n \"ExternParams\": \"\",\n \"MigrateObject\": 1,\n \"RunMode\": 1,\n \"ExpectTime\": \"2020-09-22 00:00:00\",\n \"ConsistencyType\": 2,\n \"MigrateType\": 2,\n \"IsOverrideRoot\": 0\n }\n}", "output": "{\n \"Response\": {\n \"JobId\": \"dts-o3s1vxsp\",\n \"RequestId\": \"915bc42a-714f-4faa-915b-a51cc09f5714\"\n }\n}", "title": "创建专线数据迁移任务" }, { "document": "从腾讯云mysql实例结构迁移到腾讯云另一个mysql实例,选择部分库表做,不做数据一致性检查。", - "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateMigrateJob\n<公共请求参数>\n\n{\n \"JobName\": \"设置为一个方便辨识的名称\",\n \"SrcDatabaseType\": \"mysql\",\n \"SrcAccessType\": \"cdb\",\n \"SrcInfo\": {\n \"Supplier\": \"others\",\n \"InstanceId\": \"cdb-ieow93923\",\n \"User\": \"root\",\n \"Password\": \"yourPassword\"\n },\n \"DstDatabaseType\": \"mysql\",\n \"DstAccessType\": \"cdb\",\n \"DstInfo\": {\n \"InstanceId\": \"cdb-e78e0nnv\",\n \"Region\": \"ap-shanghai\",\n \"ReadOnly\": 0,\n \"User\": \"root\",\n \"Password\": \"yourPassword\"\n },\n \"DatabaseInfo\": \"[]\",\n \"Tags\": [\n {\n \"TagKey\": \"负责人\",\n \"TagValue\": \"bob\"\n }\n ],\n \"MigrateOption\": {\n \"ExternParams\": \"{}\",\n \"MigrateObject\": 1,\n \"RunMode\": 1,\n \"ExpectTime\": \"2020-09-22 00:00:00\",\n \"ConsistencyType\": 5,\n \"MigrateType\": 2,\n \"IsOverrideRoot\": 0\n }\n}", + "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateMigrateJob\n<公共请求参数>\n\n{\n \"JobName\": \"设置为一个方便辨识的名称\",\n \"SrcDatabaseType\": \"mysql\",\n \"SrcAccessType\": \"cdb\",\n \"SrcInfo\": {\n \"Supplier\": \"others\",\n \"InstanceId\": \"cdb-ieow93923\",\n \"User\": \"root\",\n \"Password\": \"yourPassword\"\n },\n \"DstDatabaseType\": \"mysql\",\n \"DstAccessType\": \"cdb\",\n \"DstInfo\": {\n \"InstanceId\": \"cdb-e78e0nnv\",\n \"Region\": \"ap-shanghai\",\n \"ReadOnly\": 0,\n \"User\": \"root\",\n \"Password\": \"yourPassword\"\n },\n \"DatabaseInfo\": \"\",\n \"Tags\": [\n {\n \"TagKey\": \"负责人\",\n \"TagValue\": \"bob\"\n }\n ],\n \"MigrateOption\": {\n \"ExternParams\": \"\",\n \"MigrateObject\": 1,\n \"RunMode\": 1,\n \"ExpectTime\": \"2020-09-22 00:00:00\",\n \"ConsistencyType\": 5,\n \"MigrateType\": 2,\n \"IsOverrideRoot\": 0\n }\n}", "output": "{\n \"Response\": {\n \"JobId\": \"dts-46i7easd\",\n \"RequestId\": \"bc94c57b-9d69-11e9-84cb-256e968056b0\"\n }\n}", "title": "创建云数据库迁移任务" }, { "document": "将用户的mysql公网实例数据, 采用全量方式迁移到腾讯云上海地域的cdb-e78e0nnv实例上. 其中源实例的接入地域为广州. 数据一致性检查做全量检测.", - "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateMigrateJob\n<公共请求参数>\n\n{\n \"JobName\": \"设置为一个方便辨识的名称\",\n \"SrcDatabaseType\": \"mysql\",\n \"SrcAccessType\": \"extranet\",\n \"SrcInfo\": {\n \"Supplier\": \"others\",\n \"Ip\": \"14.17.22.36\",\n \"Region\": \"ap-guangzhou\",\n \"User\": \"root\",\n \"Password\": \"yourPassword\",\n \"Port\": 3306\n },\n \"DstDatabaseType\": \"mysql\",\n \"DstAccessType\": \"cdb\",\n \"DstInfo\": {\n \"InstanceId\": \"cdb-e78e0nnv\",\n \"Region\": \"ap-shanghai\",\n \"ReadOnly\": 0,\n \"User\": \"root\",\n \"Password\": \"yourPassword\"\n },\n \"DatabaseInfo\": \"[]\",\n \"Tags\": [\n {\n \"TagKey\": \"负责人\",\n \"TagValue\": \"bob\"\n }\n ],\n \"MigrateOption\": {\n \"ExternParams\": \"{}\",\n \"MigrateObject\": 1,\n \"RunMode\": 1,\n \"ExpectTime\": \"2020-09-22 00:00:00\",\n \"ConsistencyType\": 2,\n \"MigrateType\": 2,\n \"IsOverrideRoot\": 0\n }\n}", + "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateMigrateJob\n<公共请求参数>\n\n{\n \"JobName\": \"设置为一个方便辨识的名称\",\n \"SrcDatabaseType\": \"mysql\",\n \"SrcAccessType\": \"extranet\",\n \"SrcInfo\": {\n \"Supplier\": \"others\",\n \"Ip\": \"14.17.22.36\",\n \"Region\": \"ap-guangzhou\",\n \"User\": \"root\",\n \"Password\": \"yourPassword\",\n \"Port\": 3306\n },\n \"DstDatabaseType\": \"mysql\",\n \"DstAccessType\": \"cdb\",\n \"DstInfo\": {\n \"InstanceId\": \"cdb-e78e0nnv\",\n \"Region\": \"ap-shanghai\",\n \"ReadOnly\": 0,\n \"User\": \"root\",\n \"Password\": \"yourPassword\"\n },\n \"DatabaseInfo\": \"\",\n \"Tags\": [\n {\n \"TagKey\": \"负责人\",\n \"TagValue\": \"bob\"\n }\n ],\n \"MigrateOption\": {\n \"ExternParams\": \"\",\n \"MigrateObject\": 1,\n \"RunMode\": 1,\n \"ExpectTime\": \"2020-09-22 00:00:00\",\n \"ConsistencyType\": 2,\n \"MigrateType\": 2,\n \"IsOverrideRoot\": 0\n }\n}", "output": "{\n \"Response\": {\n \"JobId\": \"dts-1kl0iy0v\",\n \"RequestId\": \"2201c42a-714f-4faa-915b-a51cc09f5cec\"\n }\n}", "title": "创建公网数据迁移任务" } @@ -86,7 +86,7 @@ { "document": "", "input": "https://dts.tencentcloudapi.com/?Action=DescribeMigrateJobs\n&Order=CreateTime\n&OrderSeq=DESC\n&Offset=0\n&Limit=2\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"JobList\": [\n {\n \"JobId\": \"dts-1kl0iy0v\",\n \"JobName\": \"userdts\",\n \"MigrateOption\": {\n \"RunMode\": 1,\n \"ExpectTime\": \"0000-00-00 00:00:00\",\n \"MigrateType\": 2,\n \"MigrateObject\": 2,\n \"ConsistencyType\": 5,\n \"IsOverrideRoot\": 0,\n \"ExternParams\": \"[]\",\n \"ConsistencyParams\": {\n \"SelectRowsPerTable\": 0,\n \"TablesSelectAll\": 0,\n \"TablesSelectCount\": 0\n }\n },\n \"SrcAccessType\": \"extranet\",\n \"SrcDatabaseType\": \"mysql\",\n \"SrcInfo\": {\n \"AccessKey\": \"\",\n \"Ip\": \"9.18.84.24\",\n \"Port\": 10304,\n \"User\": \"root\",\n \"Password\": \"\",\n \"RdsInstanceId\": \"\",\n \"CvmInstanceId\": \"\",\n \"UniqDcgId\": \"\",\n \"SubnetId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"InstanceId\": \"\",\n \"Region\": \"ap-guangzhou\",\n \"VpcId\": \"\"\n },\n \"DstAccessType\": \"cdb\",\n \"DstDatabaseType\": \"mysql\",\n \"DstInfo\": {\n \"InstanceId\": \"cdb-l78e0nbv\",\n \"Ip\": \"\",\n \"Port\": 0,\n \"Region\": \"ap-shanghai\",\n \"ReadOnly\": 0\n },\n \"Tags\": [\n {\n \"TagKey\": \"负责人\",\n \"TagValue\": \"alice\"\n }\n ],\n \"Detail\": {\n \"StepAll\": 0,\n \"StepNow\": 0,\n \"Progress\": \"0\",\n \"CurrentStepProgress\": \"0\",\n \"MasterSlaveDistance\": 0,\n \"SecondsBehindMaster\": 0,\n \"StepInfo\": []\n },\n \"Status\": 1,\n \"DatabaseInfo\": \"[]\",\n \"CreateTime\": \"2018-05-24 15:06:03\",\n \"StartTime\": \"0000-00-00 00:00:00\",\n \"EndTime\": \"0000-00-00 00:00:00\",\n \"ErrorInfo\": []\n }\n ],\n \"RequestId\": \"c032aab5-b56a-428d-9cf7-e5f324ee408b\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"JobList\": [\n {\n \"JobId\": \"dts-1kl0iy0v\",\n \"JobName\": \"userdts\",\n \"MigrateOption\": {\n \"RunMode\": 1,\n \"ExpectTime\": \"0000-00-00 00:00:00\",\n \"MigrateType\": 2,\n \"MigrateObject\": 2,\n \"ConsistencyType\": 5,\n \"IsOverrideRoot\": 0,\n \"ExternParams\": \"\",\n \"ConsistencyParams\": {\n \"SelectRowsPerTable\": 0,\n \"TablesSelectAll\": 0,\n \"TablesSelectCount\": 0\n }\n },\n \"SrcAccessType\": \"extranet\",\n \"SrcDatabaseType\": \"mysql\",\n \"SrcInfo\": {\n \"AccessKey\": \"\",\n \"Ip\": \"9.18.84.24\",\n \"Port\": 10304,\n \"User\": \"root\",\n \"Password\": \"\",\n \"RdsInstanceId\": \"\",\n \"CvmInstanceId\": \"\",\n \"UniqDcgId\": \"\",\n \"SubnetId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"InstanceId\": \"\",\n \"Region\": \"ap-guangzhou\",\n \"VpcId\": \"\",\n \"CcnId\": \"\",\n \"EngineVersion\": \"\",\n \"Supplier\": \"\"\n },\n \"DstAccessType\": \"cdb\",\n \"DstDatabaseType\": \"mysql\",\n \"DstInfo\": {\n \"InstanceId\": \"cdb-l78e0nbv\",\n \"Ip\": \"\",\n \"Port\": 0,\n \"Region\": \"ap-shanghai\",\n \"ReadOnly\": 0,\n \"User\": \"\",\n \"Password\": \"\"\n },\n \"Tags\": [\n {\n \"TagKey\": \"负责人\",\n \"TagValue\": \"alice\"\n }\n ],\n \"Detail\": {\n \"StepAll\": 0,\n \"StepNow\": 0,\n \"Progress\": \"0\",\n \"CurrentStepProgress\": \"0\",\n \"MasterSlaveDistance\": 0,\n \"SecondsBehindMaster\": 0,\n \"StepInfo\": []\n },\n \"Status\": 1,\n \"DatabaseInfo\": \"\",\n \"CreateTime\": \"2018-05-24 15:06:03\",\n \"StartTime\": \"0000-00-00 00:00:00\",\n \"EndTime\": \"0000-00-00 00:00:00\",\n \"ErrorInfo\": [],\n \"SrcInfoMulti\": []\n }\n ],\n \"RequestId\": \"c032aab5-b56a-428d-9cf7-e5f324ee408b\"\n }\n}", "title": "查询数据迁移任务" } ], diff --git a/tccli/services/dts/v20211206/api.json b/tccli/services/dts/v20211206/api.json index 15d48dc41d..07c4b82046 100644 --- a/tccli/services/dts/v20211206/api.json +++ b/tccli/services/dts/v20211206/api.json @@ -1172,7 +1172,7 @@ { "disabled": false, "document": "对比任务名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "test", + "example": "compare", "member": "string", "name": "TaskName", "output_required": true, @@ -1485,7 +1485,7 @@ { "disabled": false, "document": "同步任务名称", - "example": "test", + "example": "sync-werwfs23", "member": "string", "name": "JobName", "required": false, @@ -4909,7 +4909,7 @@ { "disabled": false, "document": "同步任务名", - "example": "test", + "example": "sync-n3gh7md9", "member": "string", "name": "JobName", "required": false, @@ -6776,7 +6776,7 @@ "example": "3", "member": "uint64", "name": "StepAll", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -6786,7 +6786,7 @@ "example": "3", "member": "uint64", "name": "StepNow", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -6796,7 +6796,7 @@ "example": "0", "member": "int64", "name": "MasterSlaveDistance", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -6806,7 +6806,7 @@ "example": "0", "member": "int64", "name": "SecondsBehindMaster", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -6816,7 +6816,7 @@ "example": "[]", "member": "StepDetailInfo", "name": "StepInfo", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -9998,7 +9998,7 @@ { "disabled": false, "document": "支持的所有操作\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[\"view\",\"configure\",\"check\",\"start\",\"stop\",\"resume\",\"pause\",\"continue\",\"limitRate\",\"resize\",\"isolate\",\"offline\",\"recover\",\"postPay2prePay\",\"configureOptObj\",\"checkOptObj\",\"startOptObj\",\"createCmpTask\"]", + "example": "[\"pause\",\"stop\",\"limitRate\",\"view\",\"resize\",\"isolate\",\"postPay2prePay\",\"configureOptObj\"]", "member": "string", "name": "AllActions", "output_required": true, @@ -10275,6 +10275,16 @@ "type": "string", "value_allowed_null": true }, + { + "disabled": false, + "document": "动态修改对象,修改任务的状态等\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "Normal", + "member": "string", + "name": "OptObjStatus", + "output_required": true, + "type": "string", + "value_allowed_null": true + }, { "disabled": false, "document": "自动重试时间段设置\n注意:此字段可能返回 null,表示取不到有效值。", diff --git a/tccli/services/dts/v20211206/examples.json b/tccli/services/dts/v20211206/examples.json index 43fd72629d..5994ff03b8 100644 --- a/tccli/services/dts/v20211206/examples.json +++ b/tccli/services/dts/v20211206/examples.json @@ -146,7 +146,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCompareReport\n<公共请求参数>\n\n{\n \"JobId\": \"dts-amm1jw5q\",\n \"CompareTaskId\": \"dts-amm1jw5q-cmp-bmuum7jk\"\n}", - "output": "{\n \"Response\": {\n \"Abstract\": {\n \"Options\": {\n \"Method\": \"abc\",\n \"SampleRate\": 0,\n \"ThreadCount\": 0\n },\n \"Objects\": {\n \"ObjectMode\": \"abc\",\n \"ObjectItems\": [\n {\n \"DbName\": \"abc\",\n \"SchemaName\": \"abc\",\n \"DbMode\": \"abc\",\n \"TableMode\": \"abc\",\n \"Tables\": [\n {\n \"TableName\": \"abc\",\n \"ColumnMode\": \"abc\",\n \"Columns\": [\n {\n \"ColumnName\": \"abc\"\n }\n ]\n }\n ],\n \"ViewMode\": \"abc\",\n \"Views\": [\n {\n \"ViewName\": \"abc\"\n }\n ]\n }\n ],\n \"AdvancedObjects\": [\n \"abc\"\n ]\n },\n \"Conclusion\": \"abc\",\n \"Status\": \"abc\",\n \"TotalTables\": 1,\n \"CheckedTables\": 1,\n \"DifferentTables\": 1,\n \"SkippedTables\": 1,\n \"NearlyTableCount\": 1,\n \"DifferentRows\": 1,\n \"SrcSampleRows\": 1,\n \"DstSampleRows\": 1,\n \"StartedAt\": \"abc\",\n \"FinishedAt\": \"abc\"\n },\n \"Detail\": {\n \"Difference\": {\n \"TotalCount\": 1,\n \"Items\": [\n {\n \"Db\": \"abc\",\n \"Table\": \"abc\",\n \"Chunk\": 0,\n \"SrcItem\": \"abc\",\n \"DstItem\": \"abc\",\n \"IndexName\": \"abc\",\n \"LowerBoundary\": \"abc\",\n \"UpperBoundary\": \"abc\",\n \"CostTime\": 0,\n \"FinishedAt\": \"abc\"\n }\n ]\n },\n \"Skipped\": {\n \"TotalCount\": 1,\n \"Items\": [\n {\n \"Db\": \"abc\",\n \"Table\": \"abc\",\n \"Reason\": \"abc\"\n }\n ]\n }\n },\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"Abstract\": {\n \"CheckedTables\": 1,\n \"Conclusion\": \"same\",\n \"DifferentRows\": 0,\n \"DifferentTables\": 0,\n \"DstSampleRows\": 0,\n \"FinishedAt\": \"2024-12-20 19:07:20\",\n \"NearlyTableCount\": 1,\n \"Objects\": {\n \"AdvancedObjects\": [],\n \"ObjectItems\": [\n {\n \"DbMode\": \"partial\",\n \"DbName\": \"db_1\",\n \"SchemaName\": \"\",\n \"TableMode\": \"partial\",\n \"Tables\": [\n {\n \"ColumnMode\": \"all\",\n \"Columns\": [],\n \"TableName\": \"tb_1\"\n }\n ],\n \"ViewMode\": \"partial\",\n \"Views\": null\n }\n ],\n \"ObjectMode\": \"partial\"\n },\n \"Options\": {\n \"Method\": \"dataCheck\",\n \"SampleRate\": 100,\n \"ThreadCount\": 1\n },\n \"SkippedTables\": 0,\n \"SrcSampleRows\": 0,\n \"StartedAt\": \"2024-12-20 19:04:03\",\n \"Status\": \"success\",\n \"TotalTables\": 1\n },\n \"Detail\": {\n \"Difference\": {\n \"Items\": [],\n \"TotalCount\": 0\n },\n \"DifferenceAdvancedObjects\": {\n \"Items\": null,\n \"TotalCount\": 0\n },\n \"DifferenceData\": {\n \"Items\": null,\n \"TotalCount\": 0\n },\n \"DifferenceRow\": {\n \"Items\": null,\n \"TotalCount\": 0\n },\n \"Skipped\": {\n \"Items\": [],\n \"TotalCount\": 0\n }\n },\n \"RequestId\": \"a3365b29-2042-4565-9206-8df9e2af1a17\"\n }\n}", "title": "查询一致性校验任务详情" } ], @@ -186,7 +186,7 @@ { "document": "查询某个迁移任务详情", "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigrationDetail\n<公共请求参数>\n\n{\n \"JobId\": \"dts-amm1jw5q\"\n}", - "output": "{\n \"Response\": {\n \"Action\": {\n \"AllAction\": [\n \"view\",\n \"modify\",\n \"check\",\n \"start\",\n \"configure\",\n \"stop\",\n \"complete\",\n \"resume\",\n \"createCmpTask\",\n \"isolate\",\n \"offline\",\n \"resize\",\n \"recover\"\n ],\n \"AllowedAction\": [\n \"view\",\n \"stop\",\n \"complete\",\n \"createCmpTask\",\n \"view\",\n \"isolate\",\n \"resize\"\n ]\n },\n \"CheckStepInfo\": {\n \"EndAt\": \"2022-07-11 17:19:25\",\n \"Progress\": {\n \"Message\": \"success\",\n \"Percent\": 100,\n \"Status\": \"success\",\n \"StepAll\": 12,\n \"Steps\": [\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"ConnectDBCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"连接DB检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"VersionCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"版本检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"SrcPrivilegeCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"源实例权限检查\",\n \"StepNo\": 0,\n \"Warnings\": [\n {\n \"HelpDoc\": \"\",\n \"Message\": \"您的授权情况:GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, PROCESS, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, REPLICATION SLAVE, REPLICATION CLIENT, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER, CREATE TABLESPACE ON *.* TO 'root'@'%' WITH GRANT OPTION。 源端账号权限范围大于要求的账号权限范围,腾讯云DTS不会使用超过必要的权限,请按照最小化原则给与授权: https://cloud.tencent.com/document/product/571/58700\",\n \"Solution\": \"\"\n }\n ]\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"SimpleParamCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"部分实例参数检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"DstPrivilegeCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"目标实例权限检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"DstEmptyCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"目标实例内容冲突检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"DstSpaceCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"目标实例空间检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"BinlogParamCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"binlog参数检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"ConstraintCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"外键依赖检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"ConstraintRefCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"外键部分库表依赖检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"ViewCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"视图检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"WarningParamCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"警告项检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 0,\n \"StartTime\": \"\",\n \"Status\": \"skipped\",\n \"StepId\": \"OptimizeCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"周边检查\",\n \"StepNo\": 0,\n \"Warnings\": [\n {\n \"HelpDoc\": \"\",\n \"Message\": \"skipped\",\n \"Solution\": \"\"\n }\n ]\n }\n ],\n \"StepNow\": 12\n },\n \"StartAt\": \"2022-07-11 17:18:57\"\n },\n \"CompareTask\": {\n \"CompareTaskId\": \"dts-amm1jw5q-cmp-bmuum7jk\",\n \"Status\": \"consistent\"\n },\n \"CreateTime\": \"2022-07-11 16:20:49\",\n \"DstInfo\": {\n \"AccessType\": \"cdb\",\n \"DatabaseType\": \"mysql\",\n \"ExtraAttr\": [],\n \"Info\": [\n {\n \"Account\": \"\",\n \"AccountMode\": \"\",\n \"AccountRole\": \"\",\n \"CcnGwId\": \"\",\n \"CvmInstanceId\": \"\",\n \"DbKernel\": \"\",\n \"EngineVersion\": \"\",\n \"Host\": \"\",\n \"InstanceId\": \"cdb-o7uph0cj\",\n \"Password\": \"xxx\",\n \"Port\": 0,\n \"Role\": \"\",\n \"SubnetId\": \"\",\n \"TmpSecretId\": \"\",\n \"TmpSecretKey\": \"\",\n \"TmpToken\": \"\",\n \"UniqDcgId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"User\": \"root\",\n \"VpcId\": \"\"\n }\n ],\n \"NodeType\": \"simple\",\n \"Region\": \"ap-guangzhou\",\n \"Supplier\": \"\"\n },\n \"EndTime\": \"0000-00-00 00:00:00\",\n \"ErrorInfo\": [],\n \"ExpectRunTime\": \"2022-07-11 17:16:50\",\n \"JobId\": \"dts-amm1jw5q\",\n \"JobName\": \"test_config_api\",\n \"BriefMsg\": \"\",\n \"MigrateOption\": {\n \"Consistency\": {\n \"Mode\": \"full\"\n },\n \"DatabaseTable\": {\n \"Databases\": [\n {\n \"DBMode\": \"partial\",\n \"DbName\": \"big100\",\n \"EventMode\": \"\",\n \"FunctionMode\": \"\",\n \"NewDbName\": \"\",\n \"NewSchemaName\": \"\",\n \"ProcedureMode\": \"\",\n \"RoleMode\": \"\",\n \"Roles\": [],\n \"SchemaMode\": \"\",\n \"SchemaName\": \"\",\n \"TableMode\": \"partial\",\n \"Tables\": [\n {\n \"NewTableName\": \"\",\n \"TableEditMode\": \"\",\n \"TableName\": \"sbtest1\",\n \"TmpTables\": []\n },\n {\n \"NewTableName\": \"new_sbtest10\",\n \"TableEditMode\": \"rename\",\n \"TableName\": \"sbtest10\",\n \"TmpTables\": []\n },\n {\n \"NewTableName\": \"\",\n \"TableEditMode\": \"\",\n \"TableName\": \"sbtest100\",\n \"TmpTables\": []\n }\n ],\n \"TriggerMode\": \"\",\n \"ViewMode\": \"none\",\n \"Views\": []\n },\n {\n \"DBMode\": \"all\",\n \"DbName\": \"db1\",\n \"EventMode\": \"\",\n \"FunctionMode\": \"\",\n \"NewDbName\": \"\",\n \"NewSchemaName\": \"\",\n \"ProcedureMode\": \"\",\n \"RoleMode\": \"\",\n \"Roles\": [],\n \"SchemaMode\": \"\",\n \"SchemaName\": \"\",\n \"TableMode\": \"\",\n \"Tables\": [],\n \"TriggerMode\": \"\",\n \"ViewMode\": \"\",\n \"Views\": []\n }\n ],\n \"AdvancedObjects\": [\n \"function\"\n ],\n \"ObjectMode\": \"partial\"\n },\n \"ExtraAttr\": [],\n \"IsMigrateAccount\": false,\n \"IsDstReadOnly\": false,\n \"IsOverrideRoot\": false,\n \"MigrateType\": \"fullAndIncrement\"\n },\n \"RequestId\": \"ac300ff0-00f2-11ed-b005-4930e69d89c2\",\n \"RunMode\": \"immediate\",\n \"SrcInfo\": {\n \"AccessType\": \"intranet\",\n \"DatabaseType\": \"mysql\",\n \"ExtraAttr\": [],\n \"Info\": [\n {\n \"Account\": \"\",\n \"AccountMode\": \"\",\n \"AccountRole\": \"\",\n \"CcnGwId\": \"\",\n \"CvmInstanceId\": \"\",\n \"DbKernel\": \"\",\n \"EngineVersion\": \"5.7\",\n \"Host\": \"9.123.456.789\",\n \"InstanceId\": \"\",\n \"Password\": \"xxx\",\n \"Port\": 31035,\n \"Role\": \"\",\n \"SubnetId\": \"\",\n \"TmpSecretId\": \"\",\n \"TmpSecretKey\": \"\",\n \"TmpToken\": \"\",\n \"UniqDcgId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"User\": \"root\",\n \"VpcId\": \"\"\n }\n ],\n \"NodeType\": \"simple\",\n \"Region\": \"ap-guangzhou\",\n \"Supplier\": \"\"\n },\n \"StartTime\": \"2022-07-11 17:20:56\",\n \"Status\": \"readyComplete\",\n \"StepInfo\": {\n \"MasterSlaveDistance\": 0,\n \"SecondsBehindMaster\": 0,\n \"StepAll\": 3,\n \"StepInfo\": [\n {\n \"StepMessage\": \"\",\n \"Percent\": 100,\n \"Errors\": [],\n \"StartTime\": \"2022-07-11 17:21:59\",\n \"Status\": \"finished\",\n \"StepId\": \"dumper\",\n \"StepName\": \"源库导出\",\n \"StepNo\": 1,\n \"Warnings\": []\n },\n {\n \"StepMessage\": \"\",\n \"Percent\": 100,\n \"Errors\": [],\n \"StartTime\": \"2022-07-11 17:22:43\",\n \"Status\": \"finished\",\n \"StepId\": \"loader\",\n \"StepName\": \"数据导入\",\n \"StepNo\": 2,\n \"Warnings\": []\n },\n {\n \"StepMessage\": \"\",\n \"Percent\": 100,\n \"Errors\": [],\n \"StartTime\": \"2022-07-11 17:23:26\",\n \"Status\": \"running\",\n \"StepId\": \"sinker\",\n \"StepName\": \"同步增量\",\n \"StepNo\": 3,\n \"Warnings\": []\n }\n ],\n \"StepNow\": 3\n },\n \"Tags\": [],\n \"TradeInfo\": {\n \"BillingType\": \"billing\",\n \"DealName\": \"20220711715001047929481\",\n \"ExpireTime\": \"0000-00-00 00:00:00\",\n \"InstanceClass\": \"xlarge\",\n \"IsolateReason\": \"\",\n \"LastDealName\": \"\",\n \"OfflineReason\": \"\",\n \"PayType\": \"postpay\",\n \"TradeStatus\": \"normal\",\n \"OfflineTime\": \"\",\n \"IsolateTime\": \"\"\n },\n \"UpdateTime\": \"2022-07-11 19:53:03\",\n \"DumperResumeCtrl\": \"no\"\n }\n}", + "output": "{\n \"Response\": {\n \"Action\": {\n \"AllAction\": [\n \"view\",\n \"modify\",\n \"check\",\n \"start\",\n \"configure\",\n \"stop\",\n \"complete\",\n \"resume\",\n \"createCmpTask\",\n \"isolate\",\n \"offline\",\n \"resize\",\n \"recover\"\n ],\n \"AllowedAction\": [\n \"view\",\n \"stop\",\n \"complete\",\n \"createCmpTask\",\n \"view\",\n \"isolate\",\n \"resize\"\n ]\n },\n \"CheckStepInfo\": {\n \"EndAt\": \"2022-07-11 17:19:25\",\n \"Progress\": {\n \"Message\": \"success\",\n \"Percent\": 100,\n \"Status\": \"success\",\n \"StepAll\": 12,\n \"Steps\": [\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"ConnectDBCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"连接DB检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"VersionCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"版本检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"SrcPrivilegeCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"源实例权限检查\",\n \"StepNo\": 0,\n \"Warnings\": [\n {\n \"HelpDoc\": \"\",\n \"Message\": \"您的授权情况:GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, PROCESS, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, REPLICATION SLAVE, REPLICATION CLIENT, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER, CREATE TABLESPACE ON *.* TO 'root'@'%' WITH GRANT OPTION。 源端账号权限范围大于要求的账号权限范围,腾讯云DTS不会使用超过必要的权限,请按照最小化原则给与授权: https://cloud.tencent.com/document/product/571/58700\",\n \"Solution\": \"\"\n }\n ]\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"SimpleParamCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"部分实例参数检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"DstPrivilegeCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"目标实例权限检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"DstEmptyCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"目标实例内容冲突检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"DstSpaceCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"目标实例空间检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"BinlogParamCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"binlog参数检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"ConstraintCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"外键依赖检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"ConstraintRefCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"外键部分库表依赖检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"ViewCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"视图检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"StartTime\": \"\",\n \"Status\": \"finished\",\n \"StepId\": \"WarningParamCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"警告项检查\",\n \"StepNo\": 0,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 0,\n \"StartTime\": \"\",\n \"Status\": \"skipped\",\n \"StepId\": \"OptimizeCheck\",\n \"StepMessage\": \"\",\n \"StepName\": \"周边检查\",\n \"StepNo\": 0,\n \"Warnings\": [\n {\n \"HelpDoc\": \"\",\n \"Message\": \"skipped\",\n \"Solution\": \"\"\n }\n ]\n }\n ],\n \"StepNow\": 12\n },\n \"StartAt\": \"2022-07-11 17:18:57\"\n },\n \"CompareTask\": {\n \"CompareTaskId\": \"dts-amm1jw5q-cmp-bmuum7jk\",\n \"Status\": \"consistent\"\n },\n \"CreateTime\": \"2022-07-11 16:20:49\",\n \"DstInfo\": {\n \"AccessType\": \"cdb\",\n \"DatabaseType\": \"mysql\",\n \"ExtraAttr\": [],\n \"Info\": [\n {\n \"Account\": \"\",\n \"AccountMode\": \"\",\n \"AccountRole\": \"\",\n \"CcnGwId\": \"\",\n \"CvmInstanceId\": \"\",\n \"DbKernel\": \"\",\n \"EngineVersion\": \"\",\n \"Host\": \"\",\n \"InstanceId\": \"cdb-o7uph0cj\",\n \"Password\": \"Abc_123456789\",\n \"Port\": 0,\n \"Role\": \"\",\n \"SubnetId\": \"\",\n \"TmpSecretId\": \"\",\n \"TmpSecretKey\": \"\",\n \"TmpToken\": \"\",\n \"UniqDcgId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"User\": \"root\",\n \"VpcId\": \"\"\n }\n ],\n \"NodeType\": \"simple\",\n \"Region\": \"ap-guangzhou\",\n \"Supplier\": \"\"\n },\n \"EndTime\": \"0000-00-00 00:00:00\",\n \"ErrorInfo\": [],\n \"ExpectRunTime\": \"2022-07-11 17:16:50\",\n \"JobId\": \"dts-amm1jw5q\",\n \"JobName\": \"test_config_api\",\n \"BriefMsg\": \"\",\n \"MigrateOption\": {\n \"Consistency\": {\n \"Mode\": \"full\"\n },\n \"DatabaseTable\": {\n \"Databases\": [\n {\n \"DBMode\": \"partial\",\n \"DbName\": \"big100\",\n \"EventMode\": \"\",\n \"FunctionMode\": \"\",\n \"NewDbName\": \"\",\n \"NewSchemaName\": \"\",\n \"ProcedureMode\": \"\",\n \"RoleMode\": \"\",\n \"Roles\": [],\n \"SchemaMode\": \"\",\n \"SchemaName\": \"\",\n \"TableMode\": \"partial\",\n \"Tables\": [\n {\n \"NewTableName\": \"\",\n \"TableEditMode\": \"\",\n \"TableName\": \"sbtest1\",\n \"TmpTables\": []\n },\n {\n \"NewTableName\": \"new_sbtest10\",\n \"TableEditMode\": \"rename\",\n \"TableName\": \"sbtest10\",\n \"TmpTables\": []\n },\n {\n \"NewTableName\": \"\",\n \"TableEditMode\": \"\",\n \"TableName\": \"sbtest100\",\n \"TmpTables\": []\n }\n ],\n \"TriggerMode\": \"\",\n \"ViewMode\": \"none\",\n \"Views\": []\n },\n {\n \"DBMode\": \"all\",\n \"DbName\": \"db1\",\n \"EventMode\": \"\",\n \"FunctionMode\": \"\",\n \"NewDbName\": \"\",\n \"NewSchemaName\": \"\",\n \"ProcedureMode\": \"\",\n \"RoleMode\": \"\",\n \"Roles\": [],\n \"SchemaMode\": \"\",\n \"SchemaName\": \"\",\n \"TableMode\": \"\",\n \"Tables\": [],\n \"TriggerMode\": \"\",\n \"ViewMode\": \"\",\n \"Views\": []\n }\n ],\n \"AdvancedObjects\": [\n \"function\"\n ],\n \"ObjectMode\": \"partial\"\n },\n \"ExtraAttr\": [],\n \"IsMigrateAccount\": false,\n \"IsDstReadOnly\": false,\n \"IsOverrideRoot\": false,\n \"MigrateType\": \"fullAndIncrement\"\n },\n \"RequestId\": \"ac300ff0-00f2-11ed-b005-4930e69d89c2\",\n \"RunMode\": \"immediate\",\n \"SrcInfo\": {\n \"AccessType\": \"intranet\",\n \"DatabaseType\": \"mysql\",\n \"ExtraAttr\": [],\n \"Info\": [\n {\n \"Account\": \"\",\n \"AccountMode\": \"\",\n \"AccountRole\": \"\",\n \"CcnGwId\": \"\",\n \"CvmInstanceId\": \"\",\n \"DbKernel\": \"\",\n \"EngineVersion\": \"5.7\",\n \"Host\": \"9.123.456.789\",\n \"InstanceId\": \"\",\n \"Password\": \"Abc_123456789\",\n \"Port\": 31035,\n \"Role\": \"\",\n \"SubnetId\": \"\",\n \"TmpSecretId\": \"\",\n \"TmpSecretKey\": \"\",\n \"TmpToken\": \"\",\n \"UniqDcgId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"User\": \"root\",\n \"VpcId\": \"\"\n }\n ],\n \"NodeType\": \"simple\",\n \"Region\": \"ap-guangzhou\",\n \"Supplier\": \"\"\n },\n \"StartTime\": \"2022-07-11 17:20:56\",\n \"Status\": \"readyComplete\",\n \"StepInfo\": {\n \"MasterSlaveDistance\": 0,\n \"SecondsBehindMaster\": 0,\n \"StepAll\": 3,\n \"StepInfo\": [\n {\n \"StepMessage\": \"\",\n \"Percent\": 100,\n \"Errors\": [],\n \"StartTime\": \"2022-07-11 17:21:59\",\n \"Status\": \"finished\",\n \"StepId\": \"dumper\",\n \"StepName\": \"源库导出\",\n \"StepNo\": 1,\n \"Warnings\": []\n },\n {\n \"StepMessage\": \"\",\n \"Percent\": 100,\n \"Errors\": [],\n \"StartTime\": \"2022-07-11 17:22:43\",\n \"Status\": \"finished\",\n \"StepId\": \"loader\",\n \"StepName\": \"数据导入\",\n \"StepNo\": 2,\n \"Warnings\": []\n },\n {\n \"StepMessage\": \"\",\n \"Percent\": 100,\n \"Errors\": [],\n \"StartTime\": \"2022-07-11 17:23:26\",\n \"Status\": \"running\",\n \"StepId\": \"sinker\",\n \"StepName\": \"同步增量\",\n \"StepNo\": 3,\n \"Warnings\": []\n }\n ],\n \"StepNow\": 3\n },\n \"Tags\": [],\n \"TradeInfo\": {\n \"BillingType\": \"billing\",\n \"DealName\": \"20220711715001047929481\",\n \"ExpireTime\": \"0000-00-00 00:00:00\",\n \"InstanceClass\": \"xlarge\",\n \"IsolateReason\": \"\",\n \"LastDealName\": \"\",\n \"OfflineReason\": \"\",\n \"PayType\": \"postpay\",\n \"TradeStatus\": \"normal\",\n \"OfflineTime\": \"\",\n \"IsolateTime\": \"\"\n },\n \"UpdateTime\": \"2022-07-11 19:53:03\",\n \"DumperResumeCtrl\": \"no\"\n }\n}", "title": "查询某个迁移任务详情" } ], @@ -250,7 +250,7 @@ { "document": "查询同步任务列表", "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSyncJobs\n<公共请求参数>\n\n{\n \"JobId\": \"sync-bkm3mppi\"\n}", - "output": "{\n \"Response\": {\n \"JobList\": [\n {\n \"Actions\": [\n \"pause\",\n \"stop\",\n \"limitRate\",\n \"view\",\n \"resize\",\n \"isolate\",\n \"postPay2prePay\",\n \"configureOptObj\"\n ],\n \"AllActions\": [\n \"view\",\n \"configure\",\n \"check\",\n \"start\",\n \"stop\",\n \"resume\",\n \"pause\",\n \"continue\",\n \"limitRate\",\n \"resize\",\n \"isolate\",\n \"offline\",\n \"recover\",\n \"postPay2prePay\",\n \"configureOptObj\",\n \"checkOptObj\",\n \"startOptObj\",\n \"createCmpTask\"\n ],\n \"AutoRenew\": 0,\n \"AutoRetryTimeRangeMinutes\": 0,\n \"CreateTime\": \"2023-12-18 20:55:27\",\n \"Detail\": {\n \"CauseOfCompareDisable\": \"当前任务开启了DML过滤()。\",\n \"CurrentStepProgress\": 0,\n \"ErrInfo\": {\n \"Message\": \"\",\n \"Reason\": \"\",\n \"Solution\": \"\"\n },\n \"MasterSlaveDistance\": 0,\n \"Message\": \"\",\n \"Progress\": -1,\n \"SecondsBehindMaster\": 0,\n \"StepAll\": 4,\n \"StepInfos\": [\n {\n \"Errors\": null,\n \"Progress\": -1,\n \"StartTime\": \"2023-12-20 17:03:39\",\n \"Status\": \"finished\",\n \"StepId\": \"schema-init\",\n \"StepName\": \"增量库表初始化\",\n \"StepNo\": 1,\n \"Warnings\": []\n },\n {\n \"Errors\": null,\n \"Progress\": -1,\n \"StartTime\": \"2023-12-20 17:03:49\",\n \"Status\": \"finished\",\n \"StepId\": \"dumper\",\n \"StepName\": \"全量导出\",\n \"StepNo\": 2,\n \"Warnings\": []\n },\n {\n \"Errors\": null,\n \"Progress\": -1,\n \"StartTime\": \"2023-12-20 17:07:50\",\n \"Status\": \"finished\",\n \"StepId\": \"loader\",\n \"StepName\": \"全量导入\",\n \"StepNo\": 3,\n \"Warnings\": []\n },\n {\n \"Errors\": null,\n \"Progress\": -1,\n \"StartTime\": \"2023-12-20 17:16:49\",\n \"Status\": \"running\",\n \"StepId\": \"sinker\",\n \"StepName\": \"同步增量\",\n \"StepNo\": 4,\n \"Warnings\": []\n }\n ],\n \"StepNow\": 4\n },\n \"DstAccessType\": \"noProxy\",\n \"DstDatabaseType\": \"mysql\",\n \"DstInfo\": {\n \"Account\": \"\",\n \"AccountMode\": \"\",\n \"AccountRole\": \"\",\n \"CcnId\": \"\",\n \"CcnOwnerUin\": \"\",\n \"CvmInstanceId\": \"\",\n \"DatabaseNetEnv\": \"\",\n \"DbKernel\": \"\",\n \"DbName\": \"\",\n \"EncryptConn\": \"\",\n \"EngineVersion\": \"\",\n \"InstanceId\": \"\",\n \"Ip\": \"11.141.232.156\",\n \"Password\": \"\",\n \"Port\": 3306,\n \"Region\": \"ap-guangzhou\",\n \"Role\": \"\",\n \"RoleExternalId\": \"\",\n \"SubnetId\": \"\",\n \"Supplier\": \"\",\n \"TmpSecretId\": \"\",\n \"TmpSecretKey\": \"\",\n \"TmpToken\": \"\",\n \"UniqDcgId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"User\": \"root\",\n \"VpcId\": \"\"\n },\n \"DstInfos\": {\n \"AccessType\": \"\",\n \"DatabaseType\": \"\",\n \"Info\": null,\n \"Region\": \"\"\n },\n \"DstNodeType\": \"single\",\n \"DstRegion\": \"ap-qingyuan\",\n \"DumperResumeCtrl\": \"yes\",\n \"EndTime\": \"0000-00-00 00:00:00\",\n \"ExpectRunTime\": \"0000-00-00 00:00:00\",\n \"ExpireTime\": \"0000-00-00 00:00:00\",\n \"InstanceClass\": \"medium\",\n \"JobId\": \"sync-09vy1os1\",\n \"JobName\": \"roger_test\",\n \"Objects\": {\n \"Databases\": [\n {\n \"DbMode\": \"All\",\n \"DbName\": \"db_big\",\n \"EventMode\": \"\",\n \"FunctionMode\": \"\",\n \"NewDbName\": \"\",\n \"NewSchemaName\": \"\",\n \"ProcedureMode\": \"\",\n \"SchemaName\": \"\",\n \"TableMode\": \"All\",\n \"TriggerMode\": \"\",\n \"ViewMode\": \"All\"\n }\n ],\n \"Mode\": \"Partial\",\n \"OnlineDDL\": {\n \"Status\": \"\"\n }\n },\n \"OfflineTime\": \"0000-00-00 00:00:00\",\n \"Options\": {\n \"AddAdditionalColumn\": false,\n \"AutoRetryTimeRangeMinutes\": 0,\n \"ConflictHandleOption\": {\n \"ConditionColumn\": \"\",\n \"ConditionOperator\": \"\",\n \"ConditionOrderInSrcAndDst\": \"\"\n },\n \"ConflictHandleType\": \"Cover\",\n \"DdlOptions\": null,\n \"DealOfExistSameTable\": \"ExecuteAfterIgnore\",\n \"FilterBeginCommit\": false,\n \"FilterCheckpoint\": false,\n \"InitType\": \"Full\",\n \"KafkaOption\": {\n \"DDLTopicName\": \"\",\n \"DataType\": \"\",\n \"TopicRules\": [],\n \"TopicType\": \"\"\n },\n \"OpTypes\": null,\n \"RateLimitOption\": {\n \"CurrentDumpRps\": 0,\n \"CurrentDumpThread\": 8,\n \"CurrentLoadRps\": 0,\n \"CurrentLoadThread\": 8,\n \"CurrentSinkerThread\": 32,\n \"DefaultDumpRps\": 0,\n \"DefaultDumpThread\": 8,\n \"DefaultLoadRps\": 0,\n \"DefaultLoadThread\": 8,\n \"DefaultSinkerThread\": 32,\n \"HasUserSetRateLimit\": \"no\"\n },\n \"StartPosition\": \"\"\n },\n \"PayMode\": \"PostPay\",\n \"RunMode\": \"Immediate\",\n \"Specification\": \"\",\n \"SrcAccessType\": \"noProxy\",\n \"SrcDatabaseType\": \"mysql\",\n \"SrcInfo\": {\n \"Account\": \"\",\n \"AccountMode\": \"\",\n \"AccountRole\": \"\",\n \"CcnId\": \"\",\n \"CcnOwnerUin\": \"\",\n \"CvmInstanceId\": \"\",\n \"DatabaseNetEnv\": \"\",\n \"DbKernel\": \"\",\n \"DbName\": \"\",\n \"EncryptConn\": \"\",\n \"EngineVersion\": \"\",\n \"InstanceId\": \"\",\n \"Ip\": \"11.141.232.195\",\n \"Password\": \"\",\n \"Port\": 3306,\n \"Region\": \"ap-guangzhou\",\n \"Role\": \"\",\n \"RoleExternalId\": \"\",\n \"SubnetId\": \"\",\n \"Supplier\": \"\",\n \"TmpSecretId\": \"\",\n \"TmpSecretKey\": \"\",\n \"TmpToken\": \"\",\n \"UniqDcgId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"User\": \"root\",\n \"VpcId\": \"\"\n },\n \"SrcInfos\": {\n \"AccessType\": \"\",\n \"DatabaseType\": \"\",\n \"Info\": null,\n \"Region\": \"\"\n },\n \"SrcNodeType\": \"single\",\n \"SrcRegion\": \"ap-qingyuan\",\n \"StartTime\": \"2023-12-19 15:54:18\",\n \"Status\": \"Running\",\n \"Tags\": [],\n \"TradeStatus\": \"Normal\"\n }\n ],\n \"RequestId\": \"268b0711-a3b2-4692-8c91-88d743bc8b9f\",\n \"TotalCount\": 1\n }\n}", + "output": "{\n \"Response\": {\n \"JobList\": [\n {\n \"Actions\": [\n \"pause\",\n \"stop\",\n \"limitRate\",\n \"view\",\n \"resize\",\n \"isolate\",\n \"postPay2prePay\",\n \"configureOptObj\"\n ],\n \"AllActions\": [\n \"view\",\n \"configure\",\n \"check\",\n \"start\",\n \"stop\",\n \"resume\",\n \"pause\",\n \"continue\",\n \"limitRate\",\n \"resize\",\n \"isolate\",\n \"offline\",\n \"recover\",\n \"postPay2prePay\",\n \"configureOptObj\",\n \"checkOptObj\",\n \"startOptObj\",\n \"createCmpTask\"\n ],\n \"AutoRenew\": 0,\n \"AutoRetryTimeRangeMinutes\": 0,\n \"CreateTime\": \"2023-12-18 20:55:27\",\n \"Detail\": {\n \"CauseOfCompareDisable\": \"当前任务开启了DML过滤()。\",\n \"CurrentStepProgress\": 0,\n \"ErrInfo\": {\n \"Message\": \"\",\n \"Reason\": \"\",\n \"Solution\": \"\"\n },\n \"MasterSlaveDistance\": 0,\n \"Message\": \"\",\n \"Progress\": -1,\n \"SecondsBehindMaster\": 0,\n \"StepAll\": 4,\n \"StepInfos\": [\n {\n \"Errors\": null,\n \"Progress\": -1,\n \"StartTime\": \"2023-12-20 17:03:39\",\n \"Status\": \"finished\",\n \"StepId\": \"schema-init\",\n \"StepName\": \"增量库表初始化\",\n \"StepNo\": 1,\n \"Warnings\": []\n },\n {\n \"Errors\": null,\n \"Progress\": -1,\n \"StartTime\": \"2023-12-20 17:03:49\",\n \"Status\": \"finished\",\n \"StepId\": \"dumper\",\n \"StepName\": \"全量导出\",\n \"StepNo\": 2,\n \"Warnings\": []\n },\n {\n \"Errors\": null,\n \"Progress\": -1,\n \"StartTime\": \"2023-12-20 17:07:50\",\n \"Status\": \"finished\",\n \"StepId\": \"loader\",\n \"StepName\": \"全量导入\",\n \"StepNo\": 3,\n \"Warnings\": []\n },\n {\n \"Errors\": null,\n \"Progress\": -1,\n \"StartTime\": \"2023-12-20 17:16:49\",\n \"Status\": \"running\",\n \"StepId\": \"sinker\",\n \"StepName\": \"同步增量\",\n \"StepNo\": 4,\n \"Warnings\": []\n }\n ],\n \"StepNow\": 4\n },\n \"DstAccessType\": \"noProxy\",\n \"DstDatabaseType\": \"mysql\",\n \"DstInfo\": {\n \"Account\": \"\",\n \"AccountMode\": \"\",\n \"AccountRole\": \"\",\n \"CcnId\": \"\",\n \"CcnOwnerUin\": \"\",\n \"CvmInstanceId\": \"\",\n \"DatabaseNetEnv\": \"\",\n \"DbKernel\": \"\",\n \"DbName\": \"\",\n \"EncryptConn\": \"\",\n \"EngineVersion\": \"\",\n \"InstanceId\": \"\",\n \"Ip\": \"11.141.232.156\",\n \"Password\": \"\",\n \"Port\": 3306,\n \"Region\": \"ap-guangzhou\",\n \"Role\": \"\",\n \"RoleExternalId\": \"\",\n \"SubnetId\": \"\",\n \"Supplier\": \"\",\n \"TmpSecretId\": \"\",\n \"TmpSecretKey\": \"\",\n \"TmpToken\": \"\",\n \"UniqDcgId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"User\": \"root\",\n \"VpcId\": \"\"\n },\n \"DstInfos\": {\n \"AccessType\": \"\",\n \"DatabaseType\": \"\",\n \"Info\": null,\n \"Region\": \"\"\n },\n \"DstNodeType\": \"single\",\n \"DstRegion\": \"ap-qingyuan\",\n \"DumperResumeCtrl\": \"yes\",\n \"EndTime\": \"0000-00-00 00:00:00\",\n \"ExpectRunTime\": \"0000-00-00 00:00:00\",\n \"ExpireTime\": \"0000-00-00 00:00:00\",\n \"InstanceClass\": \"medium\",\n \"JobId\": \"sync-09vy1os1\",\n \"JobName\": \"roger_test\",\n \"Objects\": {\n \"Databases\": [\n {\n \"DbMode\": \"All\",\n \"DbName\": \"db_big\",\n \"EventMode\": \"\",\n \"FunctionMode\": \"\",\n \"NewDbName\": \"\",\n \"NewSchemaName\": \"\",\n \"ProcedureMode\": \"\",\n \"SchemaName\": \"\",\n \"TableMode\": \"All\",\n \"TriggerMode\": \"\",\n \"ViewMode\": \"All\"\n }\n ],\n \"Mode\": \"Partial\",\n \"OnlineDDL\": {\n \"Status\": \"\"\n }\n },\n \"OfflineTime\": \"0000-00-00 00:00:00\",\n \"OptObjStatus\": \"Normal\",\n \"Options\": {\n \"AddAdditionalColumn\": false,\n \"AutoRetryTimeRangeMinutes\": 0,\n \"ConflictHandleOption\": {\n \"ConditionColumn\": \"\",\n \"ConditionOperator\": \"\",\n \"ConditionOrderInSrcAndDst\": \"\"\n },\n \"ConflictHandleType\": \"Cover\",\n \"DdlOptions\": null,\n \"DealOfExistSameTable\": \"ExecuteAfterIgnore\",\n \"FilterBeginCommit\": false,\n \"FilterCheckpoint\": false,\n \"InitType\": \"Full\",\n \"KafkaOption\": {\n \"DDLTopicName\": \"\",\n \"DataType\": \"\",\n \"TopicRules\": [],\n \"TopicType\": \"\"\n },\n \"OpTypes\": null,\n \"RateLimitOption\": {\n \"CurrentDumpRps\": 0,\n \"CurrentDumpThread\": 8,\n \"CurrentLoadRps\": 0,\n \"CurrentLoadThread\": 8,\n \"CurrentSinkerThread\": 32,\n \"DefaultDumpRps\": 0,\n \"DefaultDumpThread\": 8,\n \"DefaultLoadRps\": 0,\n \"DefaultLoadThread\": 8,\n \"DefaultSinkerThread\": 32,\n \"HasUserSetRateLimit\": \"no\"\n },\n \"StartPosition\": \"\"\n },\n \"PayMode\": \"PostPay\",\n \"RunMode\": \"Immediate\",\n \"Specification\": \"\",\n \"SrcAccessType\": \"noProxy\",\n \"SrcDatabaseType\": \"mysql\",\n \"SrcInfo\": {\n \"Account\": \"\",\n \"AccountMode\": \"\",\n \"AccountRole\": \"\",\n \"CcnId\": \"\",\n \"CcnOwnerUin\": \"\",\n \"CvmInstanceId\": \"\",\n \"DatabaseNetEnv\": \"\",\n \"DbKernel\": \"\",\n \"DbName\": \"\",\n \"EncryptConn\": \"\",\n \"EngineVersion\": \"\",\n \"InstanceId\": \"\",\n \"Ip\": \"11.141.232.195\",\n \"Password\": \"\",\n \"Port\": 3306,\n \"Region\": \"ap-guangzhou\",\n \"Role\": \"\",\n \"RoleExternalId\": \"\",\n \"SubnetId\": \"\",\n \"Supplier\": \"\",\n \"TmpSecretId\": \"\",\n \"TmpSecretKey\": \"\",\n \"TmpToken\": \"\",\n \"UniqDcgId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"User\": \"root\",\n \"VpcId\": \"\"\n },\n \"SrcInfos\": {\n \"AccessType\": \"\",\n \"DatabaseType\": \"\",\n \"Info\": null,\n \"Region\": \"\"\n },\n \"SrcNodeType\": \"single\",\n \"SrcRegion\": \"ap-qingyuan\",\n \"StartTime\": \"2023-12-19 15:54:18\",\n \"Status\": \"Running\",\n \"Tags\": [],\n \"TradeStatus\": \"Normal\"\n }\n ],\n \"RequestId\": \"268b0711-a3b2-4692-8c91-88d743bc8b9f\",\n \"TotalCount\": 1\n }\n}", "title": "查询同步任务列表" } ], @@ -369,8 +369,8 @@ "ModifyMigrationJob": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyMigrationJob\n<公共请求参数>\n\n{\n \"JobId\": \"abc\",\n \"JobName\": \"abc\",\n \"RunMode\": \"abc\",\n \"ExpectRunTime\": \"abc\",\n \"MigrateOption\": {\n \"MigrateType\": \"abc\",\n \"Consistency\": {\n \"Mode\": \"abc\"\n },\n \"DatabaseTable\": {\n \"ObjectMode\": \"abc\",\n \"Databases\": [\n {\n \"DbName\": \"abc\",\n \"NewDbName\": \"abc\",\n \"SchemaName\": \"abc\",\n \"NewSchemaName\": \"abc\",\n \"DBMode\": \"abc\",\n \"SchemaMode\": \"abc\",\n \"TableMode\": \"abc\",\n \"Tables\": [\n {\n \"TableName\": \"abc\",\n \"NewTableName\": \"abc\",\n \"TmpTables\": [\n \"abc\"\n ],\n \"TableEditMode\": \"abc\"\n }\n ],\n \"ViewMode\": \"abc\",\n \"Views\": [\n {\n \"ViewName\": \"abc\",\n \"NewViewName\": \"abc\"\n }\n ],\n \"RoleMode\": \"abc\",\n \"Roles\": [\n {\n \"RoleName\": \"abc\",\n \"NewRoleName\": \"abc\"\n }\n ],\n \"FunctionMode\": \"abc\",\n \"TriggerMode\": \"abc\",\n \"EventMode\": \"abc\",\n \"ProcedureMode\": \"abc\",\n \"Functions\": [\n \"abc\"\n ],\n \"Procedures\": [\n \"abc\"\n ],\n \"Events\": [\n \"abc\"\n ],\n \"Triggers\": [\n \"abc\"\n ]\n }\n ],\n \"AdvancedObjects\": [\n \"abc\"\n ]\n },\n \"IsMigrateAccount\": true,\n \"IsOverrideRoot\": true,\n \"IsDstReadOnly\": true,\n \"ExtraAttr\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ]\n },\n \"SrcInfo\": {\n \"Supplier\": \"abc\",\n \"Region\": \"abc\",\n \"AccessType\": \"abc\",\n \"DatabaseType\": \"abc\",\n \"NodeType\": \"abc\",\n \"Info\": [\n {\n \"Role\": \"abc\",\n \"DbKernel\": \"abc\",\n \"Host\": \"abc\",\n \"Port\": 1,\n \"User\": \"abc\",\n \"Password\": \"abc\",\n \"CvmInstanceId\": \"abc\",\n \"UniqVpnGwId\": \"abc\",\n \"UniqDcgId\": \"abc\",\n \"InstanceId\": \"abc\",\n \"CcnGwId\": \"abc\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"EngineVersion\": \"abc\",\n \"Account\": \"abc\",\n \"AccountRole\": \"abc\",\n \"AccountMode\": \"abc\",\n \"TmpSecretId\": \"abc\",\n \"TmpSecretKey\": \"abc\",\n \"TmpToken\": \"abc\"\n }\n ],\n \"ExtraAttr\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"DatabaseNetEnv\": \"abc\"\n },\n \"DstInfo\": {\n \"Supplier\": \"abc\",\n \"Region\": \"abc\",\n \"AccessType\": \"abc\",\n \"DatabaseType\": \"abc\",\n \"NodeType\": \"abc\",\n \"Info\": [\n {\n \"Role\": \"abc\",\n \"DbKernel\": \"abc\",\n \"Host\": \"abc\",\n \"Port\": 1,\n \"User\": \"abc\",\n \"Password\": \"abc\",\n \"CvmInstanceId\": \"abc\",\n \"UniqVpnGwId\": \"abc\",\n \"UniqDcgId\": \"abc\",\n \"InstanceId\": \"abc\",\n \"CcnGwId\": \"abc\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"EngineVersion\": \"abc\",\n \"Account\": \"abc\",\n \"AccountRole\": \"abc\",\n \"AccountMode\": \"abc\",\n \"TmpSecretId\": \"abc\",\n \"TmpSecretKey\": \"abc\",\n \"TmpToken\": \"abc\"\n }\n ],\n \"ExtraAttr\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"DatabaseNetEnv\": \"abc\"\n },\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"AutoRetryTimeRangeMinutes\": 0\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyMigrationJob\n<公共请求参数>\n\n{\n \"JobId\": \"dts-efyc7e7l\",\n \"JobName\": \"dts-efyc7e7l\",\n \"RunMode\": \"immediate\",\n \"ExpectRunTime\": \"2024-12-20 19:01:07\",\n \"MigrateOption\": {\n \"MigrateType\": \"fullAndIncrement\",\n \"Consistency\": {\n \"Mode\": \"full\"\n },\n \"DatabaseTable\": {\n \"ObjectMode\": \"partial\",\n \"Databases\": [\n {\n \"DbName\": \"db_1\",\n \"NewDbName\": \"\",\n \"SchemaName\": \"\",\n \"NewSchemaName\": \"\",\n \"DBMode\": \"partial\",\n \"SchemaMode\": \"\",\n \"TableMode\": \"partial\",\n \"Tables\": [\n {\n \"TableName\": \"tb_1\",\n \"NewTableName\": \"\",\n \"TmpTables\": [],\n \"TableEditMode\": \"\"\n }\n ],\n \"ViewMode\": \"partial\",\n \"Views\": [\n {\n \"ViewName\": \"view_tb_1\",\n \"NewViewName\": \"\"\n }\n ],\n \"RoleMode\": \"\",\n \"Roles\": [],\n \"FunctionMode\": \"\",\n \"TriggerMode\": \"\",\n \"EventMode\": \"\",\n \"ProcedureMode\": \"\",\n \"Functions\": [],\n \"Procedures\": [],\n \"Events\": [],\n \"Triggers\": []\n }\n ],\n \"AdvancedObjects\": []\n },\n \"IsMigrateAccount\": true,\n \"IsOverrideRoot\": true,\n \"IsDstReadOnly\": true,\n \"ExtraAttr\": []\n },\n \"SrcInfo\": {\n \"Supplier\": \"\",\n \"Region\": \"ap-qingyuan\",\n \"AccessType\": \"cdb\",\n \"DatabaseType\": \"mysql\",\n \"NodeType\": \"\",\n \"Info\": [\n {\n \"Role\": \"\",\n \"DbKernel\": \"\",\n \"Host\": \"\",\n \"Port\": 0,\n \"User\": \"tencent\",\n \"Password\": \"tencent***\",\n \"CvmInstanceId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"UniqDcgId\": \"\",\n \"InstanceId\": \"cdb-4gp2nzqy\",\n \"CcnGwId\": \"\",\n \"VpcId\": \"\",\n \"SubnetId\": \"\",\n \"EngineVersion\": \"8.0\",\n \"Account\": \"\",\n \"AccountRole\": \"\",\n \"AccountMode\": \"\",\n \"TmpSecretId\": \"\",\n \"TmpSecretKey\": \"\",\n \"TmpToken\": \"\"\n }\n ],\n \"ExtraAttr\": [],\n \"DatabaseNetEnv\": \"\"\n },\n \"DstInfo\": {\n \"Supplier\": \"\",\n \"Region\": \"ap-qingyuan\",\n \"AccessType\": \"cdb\",\n \"DatabaseType\": \"mysql\",\n \"NodeType\": \"\",\n \"Info\": [\n {\n \"Role\": \"\",\n \"DbKernel\": \"\",\n \"Host\": \"\",\n \"Port\": 0,\n \"User\": \"tencent\",\n \"Password\": \"tencent***\",\n \"CvmInstanceId\": \"\",\n \"UniqVpnGwId\": \"\",\n \"UniqDcgId\": \"\",\n \"InstanceId\": \"cdb-4gp2nzqy\",\n \"CcnGwId\": \"\",\n \"VpcId\": \"\",\n \"SubnetId\": \"\",\n \"EngineVersion\": \"8.0\",\n \"Account\": \"\",\n \"AccountRole\": \"\",\n \"AccountMode\": \"\",\n \"TmpSecretId\": \"\",\n \"TmpSecretKey\": \"\",\n \"TmpToken\": \"\"\n }\n ],\n \"ExtraAttr\": [],\n \"DatabaseNetEnv\": \"\"\n },\n \"Tags\": [],\n \"AutoRetryTimeRangeMinutes\": 0\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"a3365b29-2042-4565-9206-8df9e2af1a17\"\n }\n}", "title": "配置迁移任务" } ], diff --git a/tccli/services/ecm/v20190719/api.json b/tccli/services/ecm/v20190719/api.json index 257cb85f68..1b7aba15fe 100644 --- a/tccli/services/ecm/v20190719/api.json +++ b/tccli/services/ecm/v20190719/api.json @@ -659,7 +659,7 @@ "status": "online" }, "ModifyAddressesBandwidth": { - "document": "调整弹性公网IP带宽\n", + "document": "调整弹性公网IP带宽", "input": "ModifyAddressesBandwidthRequest", "name": "调整弹性公网IP带宽", "output": "ModifyAddressesBandwidthResponse", @@ -1217,7 +1217,7 @@ { "disabled": false, "document": "ECM 地域", - "example": "无", + "example": "ap-xian-ecm", "member": "string", "name": "EcmRegion", "required": true, @@ -1226,7 +1226,7 @@ { "disabled": false, "document": "EIP数量。默认值:1。", - "example": "无", + "example": "1", "member": "uint64", "name": "AddressCount", "required": false, @@ -1235,7 +1235,7 @@ { "disabled": false, "document": "CMCC:中国移动\nCTCC:中国电信\nCUCC:中国联通", - "example": "无", + "example": "CTCC", "member": "string", "name": "InternetServiceProvider", "required": false, @@ -1244,7 +1244,7 @@ { "disabled": false, "document": "1 Mbps 至 5000 Mbps,默认值:1 Mbps。", - "example": "无", + "example": "1", "member": "uint64", "name": "InternetMaxBandwidthOut", "required": false, @@ -1262,7 +1262,7 @@ { "disabled": false, "document": "要绑定的实例 ID。", - "example": "无", + "example": "ins-11112222", "member": "string", "name": "InstanceId", "required": false, @@ -1271,7 +1271,7 @@ { "disabled": false, "document": "要绑定的弹性网卡 ID。 弹性网卡 ID 形如:eni-11112222。NetworkInterfaceId 与 InstanceId 不可同时指定。弹性网卡 ID 可通过DescribeNetworkInterfaces接口返回值中的networkInterfaceId获取。", - "example": "无", + "example": "eni-11112222", "member": "string", "name": "NetworkInterfaceId", "required": false, @@ -1280,7 +1280,7 @@ { "disabled": false, "document": "要绑定的内网 IP。如果指定了 NetworkInterfaceId 则也必须指定 PrivateIpAddress ,表示将 EIP 绑定到指定弹性网卡的指定内网 IP 上。同时要确保指定的 PrivateIpAddress 是指定的 NetworkInterfaceId 上的一个内网 IP。指定弹性网卡的内网 IP 可通过DescribeNetworkInterfaces接口返回值中的privateIpAddress获取。", - "example": "无", + "example": "10.0.0.13", "member": "string", "name": "PrivateIpAddress", "required": false, @@ -1295,20 +1295,20 @@ { "disabled": false, "document": "申请到的 EIP 的唯一 ID 列表。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"eip-11112222\"]", "member": "string", "name": "AddressSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。", - "example": "无", + "example": "1234567", "member": "string", "name": "TaskId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1802,7 +1802,7 @@ { "disabled": false, "document": "ECM 地域", - "example": "", + "example": "ap-chongqing-ecm2", "member": "string", "name": "EcmRegion", "required": true, @@ -1811,7 +1811,7 @@ { "disabled": false, "document": "标识 EIP 的唯一 ID。EIP 唯一 ID 形如:eip-11112222。", - "example": "", + "example": "eip-aihfuscm", "member": "string", "name": "AddressId", "required": true, @@ -1820,7 +1820,7 @@ { "disabled": false, "document": "要绑定的实例 ID。", - "example": "", + "example": "ins-jfaukmsn", "member": "string", "name": "InstanceId", "required": false, @@ -1829,7 +1829,7 @@ { "disabled": false, "document": "要绑定的弹性网卡 ID。 弹性网卡 ID 形如:eni-11112222。NetworkInterfaceId 与 InstanceId 不可同时指定。弹性网卡 ID 可通过DescribeNetworkInterfaces接口返回值中的networkInterfaceId获取。", - "example": "", + "example": "eni-ea173k1x", "member": "string", "name": "NetworkInterfaceId", "required": false, @@ -1838,7 +1838,7 @@ { "disabled": false, "document": "要绑定的内网 IP。如果指定了 NetworkInterfaceId 则也必须指定 PrivateIpAddress ,表示将 EIP 绑定到指定弹性网卡的指定内网 IP 上。同时要确保指定的 PrivateIpAddress 是指定的 NetworkInterfaceId 上的一个内网 IP。指定弹性网卡的内网 IP 可通过DescribeNetworkInterfaces接口返回值中的privateIpAddress获取。", - "example": "", + "example": "10.0.2.27", "member": "string", "name": "PrivateIpAddress", "required": false, @@ -1853,9 +1853,10 @@ { "disabled": false, "document": "异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。", - "example": "", + "example": "202869021", "member": "string", "name": "TaskId", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -4004,7 +4005,7 @@ { "disabled": false, "document": "ECM 地域", - "example": "", + "example": "ap-hangzhou-ecm", "member": "string", "name": "EcmRegion", "required": true, @@ -4019,9 +4020,10 @@ { "disabled": false, "document": "账户 EIP 配额信息。", - "example": "", + "example": "无", "member": "EipQuota", "name": "QuotaSet", + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -4040,7 +4042,7 @@ { "disabled": false, "document": "ECM 地域", - "example": "", + "example": "ap-chongqing-ecm2", "member": "string", "name": "EcmRegion", "required": true, @@ -4049,7 +4051,7 @@ { "disabled": false, "document": "标识 EIP 的唯一 ID 列表。EIP 唯一 ID 形如:eip-11112222。参数不支持同时指定AddressIds和Filters。", - "example": "", + "example": "[\"eip-aihfuscm\"]", "member": "string", "name": "AddressIds", "required": false, @@ -4058,7 +4060,7 @@ { "disabled": false, "document": "每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定AddressIds和Filters。详细的过滤条件如下:\naddress-id - String - 是否必填:否 - (过滤条件)按照 EIP 的唯一 ID 过滤。EIP 唯一 ID 形如:eip-11112222。\naddress-name - String - 是否必填:否 - (过滤条件)按照 EIP 名称过滤。不支持模糊过滤。\naddress-ip - String - 是否必填:否 - (过滤条件)按照 EIP 的 IP 地址过滤。\naddress-status - String - 是否必填:否 - (过滤条件)按照 EIP 的状态过滤。取值范围:详见EIP状态列表。\ninstance-id - String - 是否必填:否 - (过滤条件)按照 EIP 绑定的实例 ID 过滤。实例 ID 形如:ins-11112222。\nprivate-ip-address - String - 是否必填:否 - (过滤条件)按照 EIP 绑定的内网 IP 过滤。\nnetwork-interface-id - String - 是否必填:否 - (过滤条件)按照 EIP 绑定的弹性网卡 ID 过滤。弹性网卡 ID 形如:eni-11112222。\nis-arrears - String - 是否必填:否 - (过滤条件)按照 EIP 是否欠费进行过滤。(TRUE:EIP 处于欠费状态|FALSE:EIP 费用状态正常)", - "example": "", + "example": "无", "member": "Filter", "name": "Filters", "required": false, @@ -4067,7 +4069,7 @@ { "disabled": false, "document": "偏移量,默认为0。", - "example": "", + "example": "0", "member": "uint64", "name": "Offset", "required": false, @@ -4076,7 +4078,7 @@ { "disabled": false, "document": "返回数量,默认为20,最大值为100。", - "example": "", + "example": "20", "member": "uint64", "name": "Limit", "required": false, @@ -4091,18 +4093,20 @@ { "disabled": false, "document": "符合条件的 EIP 数量。", - "example": "", + "example": "1", "member": "uint64", "name": "TotalCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "EIP 详细信息列表。", - "example": "", + "example": "无", "member": "Address", "name": "AddressSet", + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -6597,7 +6601,7 @@ { "disabled": false, "document": "ECM 地域", - "example": "", + "example": "ap-hangzhou-ecm", "member": "string", "name": "EcmRegion", "required": true, @@ -6606,7 +6610,7 @@ { "disabled": false, "document": "标识 EIP 的唯一 ID。EIP 唯一 ID 形如:eip-11112222。", - "example": "", + "example": "eip-aihfuscm", "member": "string", "name": "AddressId", "required": true, @@ -6615,7 +6619,7 @@ { "disabled": false, "document": "表示解绑 EIP 之后是否分配普通公网 IP。取值范围:\nTRUE:表示解绑 EIP 之后分配普通公网 IP。\nFALSE:表示解绑 EIP 之后不分配普通公网 IP。\n默认取值:FALSE。\n\n只有满足以下条件时才能指定该参数:\n只有在解绑主网卡的主内网 IP 上的 EIP 时才能指定该参数。\n解绑 EIP 后重新分配普通公网 IP 操作一个账号每天最多操作 10 次;详情可通过 DescribeAddressQuota 接口获取。", - "example": "", + "example": "false", "member": "bool", "name": "ReallocateNormalPublicIp", "required": false, @@ -6630,9 +6634,10 @@ { "disabled": false, "document": "异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。", - "example": "", + "example": "954361", "member": "string", "name": "TaskId", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -9512,7 +9517,7 @@ { "disabled": false, "document": "ECM 地域", - "example": "", + "example": "ap-chongqing-ecm2", "member": "string", "name": "EcmRegion", "required": true, @@ -9521,7 +9526,7 @@ { "disabled": false, "document": "标识 EIP 的唯一 ID。EIP 唯一 ID 形如:eip-11112222。", - "example": "", + "example": "eip-48d9e6ff", "member": "string", "name": "AddressId", "required": true, @@ -9530,7 +9535,7 @@ { "disabled": false, "document": "修改后的 EIP 名称。长度上限为20个字符。", - "example": "", + "example": "demo", "member": "string", "name": "AddressName", "required": false, @@ -9539,7 +9544,7 @@ { "disabled": false, "document": "设定EIP是否直通,\"TRUE\"表示直通,\"FALSE\"表示非直通。注意该参数仅对EIP直通功能可见的用户可以设定。", - "example": "", + "example": "false", "member": "string", "name": "EipDirectConnection", "required": false, @@ -9566,7 +9571,7 @@ { "disabled": false, "document": "ECM 地域", - "example": "", + "example": "ap-chongqing-ecm2", "member": "string", "name": "EcmRegion", "required": true, @@ -9575,7 +9580,7 @@ { "disabled": false, "document": "EIP唯一标识ID,形如'eip-xxxxxxx'", - "example": "", + "example": "[\"eip-85de31gh\"]", "member": "string", "name": "AddressIds", "required": true, @@ -9584,7 +9589,7 @@ { "disabled": false, "document": "调整带宽目标值", - "example": "", + "example": "10", "member": "uint64", "name": "InternetMaxBandwidthOut", "required": true, @@ -9599,9 +9604,10 @@ { "disabled": false, "document": "异步任务TaskId。", - "example": "", + "example": "1268459", "member": "string", "name": "TaskId", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -9863,7 +9869,7 @@ { "disabled": false, "document": "IPV6地址。Ipv6Addresses和Ipv6AddressId必须且只能传一个", - "example": "无", + "example": "[\"2402:4e00:1000:200:0:8d8a:60b7:87f8\"]", "member": "Ipv6Address", "name": "Ipv6Addresses", "required": false, @@ -9872,7 +9878,7 @@ { "disabled": false, "document": "IPV6地址对应的唯一ID,形如eip-xxxxxxxx。Ipv6Addresses和Ipv6AddressId必须且只能传一个", - "example": "无", + "example": "[\"eip-265fg963\"]", "member": "string", "name": "Ipv6AddressIds", "required": false, @@ -12470,7 +12476,7 @@ { "disabled": false, "document": "ECM 地域", - "example": "", + "example": "ap-chongqing-ecm2", "member": "string", "name": "EcmRegion", "required": true, @@ -12479,7 +12485,7 @@ { "disabled": false, "document": "标识 EIP 的唯一 ID 列表。", - "example": "", + "example": "[\"eip-fg5896sc\"]", "member": "string", "name": "AddressIds", "required": true, @@ -12494,9 +12500,10 @@ { "disabled": false, "document": "异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。", - "example": "", + "example": "7456321", "member": "string", "name": "TaskId", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12524,7 +12531,7 @@ { "disabled": false, "document": "IPV6地址。Ipv6Addresses和Ipv6AddressIds必须且只能传一个。", - "example": "无", + "example": "[\"2402:4e00:1000:200:0:8d8a:60b7:87f8\"]", "member": "string", "name": "Ipv6Addresses", "required": false, @@ -12533,7 +12540,7 @@ { "disabled": false, "document": "IPV6地址对应的唯一ID,形如eip-xxxxxxxx。Ipv6Addresses和Ipv6AddressIds必须且只能传一个。", - "example": "无", + "example": "[\"eip-1534fc12\"]", "member": "string", "name": "Ipv6AddressIds", "required": false, @@ -12548,10 +12555,10 @@ { "disabled": false, "document": "异步任务TaskId。", - "example": "无", + "example": "3568421", "member": "string", "name": "TaskId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, diff --git a/tccli/services/ecm/v20190719/examples.json b/tccli/services/ecm/v20190719/examples.json index 952759f796..b6a99774d7 100644 --- a/tccli/services/ecm/v20190719/examples.json +++ b/tccli/services/ecm/v20190719/examples.json @@ -4,7 +4,7 @@ { "document": "", "input": "https://ecm.tencentcloudapi.com/?Action=AllocateAddresses\n&AddressCount=1\n&InternetServiceProvider=CTCC\n&EcmRegion=ap-hangzhou-ecm\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"AddressSet\": [\n \"eip-11112222\"\n ],\n \"TaskId\": \"123\",\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}", + "output": "{\n \"Response\": {\n \"AddressSet\": [\n \"eip-11112222\"\n ],\n \"TaskId\": \"202869021\",\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}", "title": "创建EIP" } ], @@ -60,7 +60,7 @@ { "document": "实例主网卡无外网IP条件下,将EIP绑定到实例主网卡", "input": "https://ecm.tencentcloudapi.com/?Action=AssociateAddress\n&AddressId=eip-11112222\n&InstanceId=ins-11221122\n&EcmRegion=ap-hangzhou-ecm\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TaskId\": \"123\",\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"TaskId\": \"202869021\",\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "绑定EIP到实例上" } ], @@ -378,7 +378,7 @@ { "document": "", "input": "https://ecm.tencentcloudapi.com/?Action=DescribeAddresses\r\n&AddressIds.0=eip-11221122\r\n&EcmRegion=ap-hangzhou-ecm\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"AddressSet\": [\n {\n \"AddressId\": \"eip-11221122\",\n \"AddressName\": \"test\",\n \"AddressIp\": \"123.121.34.33\",\n \"AddressStatus\": \"BINDED\",\n \"InstanceId\": \"ins-11221122\",\n \"NetworkInterfaceId\": null,\n \"PrivateAddressIp\": null,\n \"IsArrears\": false,\n \"IsBlocked\": false,\n \"CreatedTime\": \"2020-01-12T07:52:00Z\"\n }\n ],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"AddressSet\": [\n {\n \"AddressId\": \"eip-11221122\",\n \"AddressName\": \"demo\",\n \"AddressIp\": \"123.121.34.33\",\n \"AddressStatus\": \"BINDED\",\n \"AddressType\": \"EIP\",\n \"InstanceId\": \"ins-11221122\",\n \"NetworkInterfaceId\": \"eni-2regnhmp\",\n \"PrivateAddressIp\": \"10.212.0.26\",\n \"IsArrears\": false,\n \"IsBlocked\": false,\n \"IsEipDirectConnection\": true,\n \"CascadeRelease\": false,\n \"CreatedTime\": \"2024-12-03T02:19:31Z\",\n \"Bandwidth\": 2048,\n \"PayMode\": \"BANDWIDTH_PACKAGE\",\n \"InternetServiceProvider\": \"CUCC\"\n }\n ],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "使用AddressIds查询EIP" } ], @@ -726,7 +726,7 @@ { "document": "", "input": "https://ecm.tencentcloudapi.com/?Action=DisassociateAddress\n&AddressId=eip-11112222\n&EcmRegion=ap-hangzhou-ecm\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TaskId\": \"123\",\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"TaskId\": \"824963\",\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "解绑 EIP" } ], @@ -804,7 +804,7 @@ { "document": "", "input": "https://ecm.tencentcloudapi.com/?Action=ModifyAddressesBandwidth\n&InternetMaxBandwidthOut=1000\n&AddressIds.0=eip-11112222\n&EcmRegion=ap-hangzhou-ecm\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TaskId\": \"123\",\n \"RequestId\": \"24cfceab-3492-482c-b86f-27f598b1b044\"\n }\n}", + "output": "{\n \"Response\": {\n \"TaskId\": \"3594621\",\n \"RequestId\": \"24cfceab-3492-482c-b86f-27f598b1b044\"\n }\n}", "title": "调整EIP带宽" } ], @@ -1012,7 +1012,7 @@ { "document": "", "input": "https://ecm.tencentcloudapi.com/?Action=ReleaseAddresses\r\n&AddressIds.0=eip-11112222\r\n&EcmRegion=ap-hangzhou-ecm\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TaskId\": \"123\",\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}", + "output": "{\n \"Response\": {\n \"TaskId\": \"4569821\",\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}", "title": "释放弹性公网IP" } ], @@ -1028,7 +1028,7 @@ { "document": "", "input": "https://ecm.tencentcloudapi.com/?Action=ReleaseIpv6AddressesBandwidth\n&EcmRegion=ap-xian-ecm\n&Ipv6Addresses.0=2402:4e00:1000:200:0:8d8a:60b7:87f8\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TaskId\": 202869021,\n \"RequestId\": \"aac03e7b-3c91-4970-b2bc-c20f0c6bdd38\"\n }\n}", + "output": "{\n \"Response\": {\n \"TaskId\": \"2568423\",\n \"RequestId\": \"aac03e7b-3c91-4970-b2bc-c20f0c6bdd38\"\n }\n}", "title": "释放弹性公网IPv6地址带宽" } ], diff --git a/tccli/services/emr/emr_client.py b/tccli/services/emr/emr_client.py index 42c32dfc0a..37ab5e89eb 100644 --- a/tccli/services/emr/emr_client.py +++ b/tccli/services/emr/emr_client.py @@ -797,6 +797,162 @@ def doScaleOutInstance(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doAttachDisks(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.EmrClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.AttachDisksRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.AttachDisks(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 doSetNodeResourceConfigDefault(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.EmrClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.SetNodeResourceConfigDefaultRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.SetNodeResourceConfigDefault(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 doDescribeSLInstance(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.EmrClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.DescribeSLInstanceRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.DescribeSLInstance(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 doDescribeStarRocksQueryInfo(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -1421,6 +1577,58 @@ def doDeleteUserManagerUserList(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doDeleteNodeResourceConfig(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.EmrClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.DeleteNodeResourceConfigRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.DeleteNodeResourceConfig(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 doTerminateSLInstance(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -2097,6 +2305,58 @@ def doModifyResourceScheduler(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doDescribeNodeResourceConfigFast(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.EmrClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.DescribeNodeResourceConfigFastRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.DescribeNodeResourceConfigFast(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 doDescribeResourceScheduleDiffDetail(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -2149,7 +2409,7 @@ def doDescribeResourceScheduleDiffDetail(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeSLInstance(args, parsed_globals): +def doSyncPodState(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -2178,11 +2438,11 @@ def doDescribeSLInstance(args, parsed_globals): client = mod.EmrClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeSLInstanceRequest() + model = models.SyncPodStateRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribeSLInstance(model) + rsp = client.SyncPodState(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -2305,6 +2565,58 @@ def doCreateInstance(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doModifyResource(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.EmrClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.ModifyResourceRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.ModifyResource(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 doInquiryPriceCreateInstance(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -2461,7 +2773,7 @@ def doDescribeResourceSchedule(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeYarnScheduleHistory(args, parsed_globals): +def doResizeDataDisks(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -2490,11 +2802,11 @@ def doDescribeYarnScheduleHistory(args, parsed_globals): client = mod.EmrClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeYarnScheduleHistoryRequest() + model = models.ResizeDataDisksRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribeYarnScheduleHistory(model) + rsp = client.ResizeDataDisks(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -2669,7 +2981,7 @@ def doStartStopServiceOrMonitor(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doSyncPodState(args, parsed_globals): +def doAddNodeResourceConfig(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -2698,11 +3010,11 @@ def doSyncPodState(args, parsed_globals): client = mod.EmrClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.SyncPodStateRequest() + model = models.AddNodeResourceConfigRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.SyncPodState(model) + rsp = client.AddNodeResourceConfig(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -2877,6 +3189,58 @@ def doModifySLInstance(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doDescribeNodeDataDisks(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.EmrClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.DescribeNodeDataDisksRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.DescribeNodeDataDisks(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 doDescribeAutoScaleStrategies(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -3085,7 +3449,7 @@ def doDescribeClusterNodes(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribeTrinoQueryInfo(args, parsed_globals): +def doDescribeYarnScheduleHistory(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -3114,11 +3478,11 @@ def doDescribeTrinoQueryInfo(args, parsed_globals): client = mod.EmrClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribeTrinoQueryInfoRequest() + model = models.DescribeYarnScheduleHistoryRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribeTrinoQueryInfo(model) + rsp = client.DescribeYarnScheduleHistory(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -3189,6 +3553,58 @@ def doDescribeInstancesList(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doDescribeTrinoQueryInfo(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.EmrClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.DescribeTrinoQueryInfoRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.DescribeTrinoQueryInfo(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 doModifyResourcePools(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -3345,6 +3761,58 @@ def doDescribeEmrOverviewMetrics(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doModifyInstanceBasic(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.EmrClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.ModifyInstanceBasicRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.ModifyInstanceBasic(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 doModifyPodNum(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -3527,6 +3995,9 @@ def doRunJobFlow(args, parsed_globals): "DescribeAutoScaleRecords": doDescribeAutoScaleRecords, "DescribeCvmQuota": doDescribeCvmQuota, "ScaleOutInstance": doScaleOutInstance, + "AttachDisks": doAttachDisks, + "SetNodeResourceConfigDefault": doSetNodeResourceConfigDefault, + "DescribeSLInstance": doDescribeSLInstance, "DescribeStarRocksQueryInfo": doDescribeStarRocksQueryInfo, "DescribeHBaseTableOverview": doDescribeHBaseTableOverview, "AddMetricScaleStrategy": doAddMetricScaleStrategy, @@ -3539,6 +4010,7 @@ def doRunJobFlow(args, parsed_globals): "DescribeUsersForUserManager": doDescribeUsersForUserManager, "ModifyUserManagerPwd": doModifyUserManagerPwd, "DeleteUserManagerUserList": doDeleteUserManagerUserList, + "DeleteNodeResourceConfig": doDeleteNodeResourceConfig, "TerminateSLInstance": doTerminateSLInstance, "AddUsersForUserManager": doAddUsersForUserManager, "ModifyAutoRenewFlag": doModifyAutoRenewFlag, @@ -3552,30 +4024,35 @@ def doRunJobFlow(args, parsed_globals): "DescribeInstanceRenewNodes": doDescribeInstanceRenewNodes, "DescribeHDFSStorageInfo": doDescribeHDFSStorageInfo, "ModifyResourceScheduler": doModifyResourceScheduler, + "DescribeNodeResourceConfigFast": doDescribeNodeResourceConfigFast, "DescribeResourceScheduleDiffDetail": doDescribeResourceScheduleDiffDetail, - "DescribeSLInstance": doDescribeSLInstance, + "SyncPodState": doSyncPodState, "DescribeSparkQueries": doDescribeSparkQueries, "CreateInstance": doCreateInstance, + "ModifyResource": doModifyResource, "InquiryPriceCreateInstance": doInquiryPriceCreateInstance, "InquirePriceRenewEmr": doInquirePriceRenewEmr, "DescribeResourceSchedule": doDescribeResourceSchedule, - "DescribeYarnScheduleHistory": doDescribeYarnScheduleHistory, + "ResizeDataDisks": doResizeDataDisks, "ModifyResourceScheduleConfig": doModifyResourceScheduleConfig, "DescribeHiveQueries": doDescribeHiveQueries, "StartStopServiceOrMonitor": doStartStopServiceOrMonitor, - "SyncPodState": doSyncPodState, + "AddNodeResourceConfig": doAddNodeResourceConfig, "ModifyGlobalConfig": doModifyGlobalConfig, "TerminateInstance": doTerminateInstance, "ModifySLInstance": doModifySLInstance, + "DescribeNodeDataDisks": doDescribeNodeDataDisks, "DescribeAutoScaleStrategies": doDescribeAutoScaleStrategies, "DescribeGlobalConfig": doDescribeGlobalConfig, "DescribeAutoScaleGroupGlobalConf": doDescribeAutoScaleGroupGlobalConf, "DescribeClusterNodes": doDescribeClusterNodes, - "DescribeTrinoQueryInfo": doDescribeTrinoQueryInfo, + "DescribeYarnScheduleHistory": doDescribeYarnScheduleHistory, "DescribeInstancesList": doDescribeInstancesList, + "DescribeTrinoQueryInfo": doDescribeTrinoQueryInfo, "ModifyResourcePools": doModifyResourcePools, "DescribeInsightList": doDescribeInsightList, "DescribeEmrOverviewMetrics": doDescribeEmrOverviewMetrics, + "ModifyInstanceBasic": doModifyInstanceBasic, "ModifyPodNum": doModifyPodNum, "ScaleOutCluster": doScaleOutCluster, "RunJobFlow": doRunJobFlow, diff --git a/tccli/services/emr/v20190103/api.json b/tccli/services/emr/v20190103/api.json index b0fcfd403d..9188132968 100644 --- a/tccli/services/emr/v20190103/api.json +++ b/tccli/services/emr/v20190103/api.json @@ -7,6 +7,13 @@ "output": "AddMetricScaleStrategyResponse", "status": "online" }, + "AddNodeResourceConfig": { + "document": "增加当前集群的节点规格配置", + "input": "AddNodeResourceConfigRequest", + "name": "增加节点规格配置", + "output": "AddNodeResourceConfigResponse", + "status": "online" + }, "AddUsersForUserManager": { "document": "该接口支持安装了OpenLdap组件的集群。\n新增用户列表(用户管理)。", "input": "AddUsersForUserManagerRequest", @@ -14,6 +21,13 @@ "output": "AddUsersForUserManagerResponse", "status": "online" }, + "AttachDisks": { + "document": "云盘挂载", + "input": "AttachDisksRequest", + "name": "云盘挂载", + "output": "AttachDisksResponse", + "status": "online" + }, "CreateCloudInstance": { "document": "创建EMR容器集群实例", "input": "CreateCloudInstanceRequest", @@ -49,6 +63,13 @@ "output": "DeleteAutoScaleStrategyResponse", "status": "online" }, + "DeleteNodeResourceConfig": { + "document": "删除当前集群的节点规格配置", + "input": "DeleteNodeResourceConfigRequest", + "name": "删除节点规格配置", + "output": "DeleteNodeResourceConfigResponse", + "status": "online" + }, "DeleteUserManagerUserList": { "document": "删除用户列表(用户管理)", "input": "DeleteUserManagerUserListRequest", @@ -196,6 +217,20 @@ "output": "DescribeKyuubiQueryInfoResponse", "status": "online" }, + "DescribeNodeDataDisks": { + "document": "查询节点数据盘信息", + "input": "DescribeNodeDataDisksRequest", + "name": "查询节点数据盘信息", + "output": "DescribeNodeDataDisksResponse", + "status": "online" + }, + "DescribeNodeResourceConfigFast": { + "document": "快速获取当前集群的节点规格配置", + "input": "DescribeNodeResourceConfigFastRequest", + "name": "快速获取节点规格配置", + "output": "DescribeNodeResourceConfigFastResponse", + "status": "online" + }, "DescribeResourceSchedule": { "document": "查询YARN资源调度数据信息。已废弃,请使用`DescribeYarnQueue`去查询队列信息。", "input": "DescribeResourceScheduleRequest", @@ -336,6 +371,13 @@ "output": "ModifyGlobalConfigResponse", "status": "online" }, + "ModifyInstanceBasic": { + "document": "修改集群名称", + "input": "ModifyInstanceBasicRequest", + "name": "修改集群名称", + "output": "ModifyInstanceBasicResponse", + "status": "online" + }, "ModifyPodNum": { "document": "调整Pod数量", "input": "ModifyPodNumRequest", @@ -343,6 +385,13 @@ "output": "ModifyPodNumResponse", "status": "online" }, + "ModifyResource": { + "document": "变配实例", + "input": "ModifyResourceRequest", + "name": "变配实例", + "output": "ModifyResourceResponse", + "status": "online" + }, "ModifyResourcePools": { "document": "刷新YARN的动态资源池。已废弃,请使用`DeployYarnConf`", "input": "ModifyResourcePoolsRequest", @@ -406,6 +455,13 @@ "output": "ResetYarnConfigResponse", "status": "online" }, + "ResizeDataDisks": { + "document": "云盘扩容", + "input": "ResizeDataDisksRequest", + "name": "云盘扩容", + "output": "ResizeDataDisksResponse", + "status": "online" + }, "RunJobFlow": { "document": "创建流程作业", "input": "RunJobFlowRequest", @@ -427,6 +483,13 @@ "output": "ScaleOutInstanceResponse", "status": "online" }, + "SetNodeResourceConfigDefault": { + "document": "设置当前集群的某个节点规格配置为默认或取消默认", + "input": "SetNodeResourceConfigDefaultRequest", + "name": "设置节点规格配置默认属性", + "output": "SetNodeResourceConfigDefaultResponse", + "status": "online" + }, "StartStopServiceOrMonitor": { "document": "用于启停服务 重启服务等功能", "input": "StartStopServiceOrMonitorRequest", @@ -531,6 +594,114 @@ ], "type": "object" }, + "AddNodeResourceConfigRequest": { + "document": "AddNodeResourceConfig请求参数结构体", + "members": [ + { + "disabled": false, + "document": "集群实例Id", + "example": "emr-examples", + "member": "string", + "name": "InstanceId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "节点类型 CORE TASK ROUTER", + "example": "CORE", + "member": "string", + "name": "ResourceType", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "资源详情", + "example": "无", + "member": "Resource", + "name": "ResourceConfig", + "required": true, + "type": "object" + }, + { + "disabled": false, + "document": "付费模式", + "example": "1", + "member": "int64", + "name": "PayMode", + "required": true, + "type": "int" + }, + { + "disabled": false, + "document": "是否默认配置,DEFAULT,BACKUP,不填默认不是默认配置", + "example": "无", + "member": "string", + "name": "IsDefault", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "地域ID", + "example": "100002", + "member": "int64", + "name": "ZoneId", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "添加多个规格时,第1个规格详情在ResourceConfig参数,第2-n个在MultipleResourceConfig参数", + "example": "无", + "member": "Resource", + "name": "MultipleResourceConfig", + "required": false, + "type": "list" + }, + { + "disabled": false, + "document": "类型为ComputeResource和EMR以及默认,默认为EMR", + "example": "ComputeResource", + "member": "string", + "name": "ResourceBaseType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "计算资源id", + "example": "emr-cr-xxxxx", + "member": "string", + "name": "ComputeResourceId", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "硬件类型", + "example": "HOST", + "member": "string", + "name": "HardwareResourceType", + "required": false, + "type": "string" + } + ], + "type": "object" + }, + "AddNodeResourceConfigResponse": { + "document": "AddNodeResourceConfig返回参数结构体", + "members": [ + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "AddUsersForUserManagerRequest": { "document": "AddUsersForUserManager请求参数结构体", "members": [ @@ -787,6 +958,97 @@ ], "usage": "both" }, + "AttachDisksRequest": { + "document": "AttachDisks请求参数结构体", + "members": [ + { + "disabled": false, + "document": "EMR集群实例ID", + "example": "emr-xxxxxxx", + "member": "string", + "name": "InstanceId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "需要挂载的云盘ID", + "example": "[disk-xxx1, disk-xxx2]", + "member": "string", + "name": "DiskIds", + "required": false, + "type": "list" + }, + { + "disabled": false, + "document": "挂载模式,取值范围:\nAUTO_RENEW:自动续费\nALIGN_DEADLINE:自动对其到期时间", + "example": "AUTO_RENEW", + "member": "string", + "name": "AlignType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "需要挂载的cvm节点id列表", + "example": "[ins-dfsi3u4s, ins-eidsii3u]", + "member": "string", + "name": "CvmInstanceIds", + "required": false, + "type": "list" + }, + { + "disabled": false, + "document": "是否是新购云盘进行挂载", + "example": "true", + "member": "bool", + "name": "CreateDisk", + "required": false, + "type": "bool" + }, + { + "disabled": false, + "document": "新购云盘规格", + "example": "无", + "member": "NodeSpecDiskV2", + "name": "DiskSpec", + "required": false, + "type": "object" + }, + { + "disabled": false, + "document": "可选参数,不传该参数则仅执行挂载操作。传入True时,会在挂载成功后将云硬盘设置为随云主机销毁模式,仅对按量计费云硬盘有效。", + "example": "true", + "member": "bool", + "name": "DeleteWithInstance", + "required": false, + "type": "bool" + } + ], + "type": "object" + }, + "AttachDisksResponse": { + "document": "AttachDisks返回参数结构体", + "members": [ + { + "disabled": false, + "document": "流程id\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "1", + "member": "int64", + "name": "FlowId", + "output_required": false, + "type": "int", + "value_allowed_null": true + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "AutoScaleRecord": { "document": "弹性扩缩容记录", "members": [ @@ -960,7 +1222,7 @@ { "disabled": false, "document": "集群实例ID。", - "example": "123", + "example": "emr-123", "member": "int64", "name": "ClusterId", "output_required": true, @@ -1004,7 +1266,7 @@ { "disabled": false, "document": "下次能可扩容时间。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "123", + "example": "1726015182", "member": "uint64", "name": "NextTimeCanScale", "output_required": true, @@ -1070,7 +1332,7 @@ { "disabled": false, "document": "伸缩组名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "test", + "example": "GroupName-test", "member": "string", "name": "GroupName", "output_required": false, @@ -1103,7 +1365,7 @@ { "disabled": false, "document": "并行伸缩 0关闭;1开启\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "Parallel", "output_required": false, @@ -1161,6 +1423,162 @@ ], "usage": "both" }, + "CBSInstance": { + "document": "CBS实例信息", + "members": [ + { + "disabled": false, + "document": "云硬盘ID\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "disk-jcih4wxx", + "member": "string", + "name": "DiskId", + "required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "云硬盘类型\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "SYSTEM_DISK", + "member": "string", + "name": "DiskUsage", + "required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "云硬盘名称\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "emr-core1_系统盘", + "member": "string", + "name": "DiskName", + "required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "云硬盘大小\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "50", + "member": "int64", + "name": "DiskSize", + "required": true, + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "云盘介质类型\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "CLOUD_PREMIUM", + "member": "string", + "name": "DiskType", + "required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "是否跟随实例删除\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "true", + "member": "bool", + "name": "DeleteWithInstance", + "required": true, + "type": "bool", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "云硬盘收费类型\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "PREPAID", + "member": "string", + "name": "DiskChargeType", + "required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "云硬盘运行状态\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "ATTACHED", + "member": "string", + "name": "DiskState", + "required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "是否自动续费\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "DISABLE_NOTIFY_AND_MANUAL_RENEW", + "member": "string", + "name": "RenewFlag", + "required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "到期时间\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "2021-07-24 11:37:30", + "member": "string", + "name": "DeadlineTime", + "required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "云盘是否挂载到云主机上\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "true", + "member": "bool", + "name": "Attached", + "required": true, + "type": "bool", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "当前时间距离盘到期的天数\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "10", + "member": "int64", + "name": "DifferDaysOfDeadline", + "required": true, + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "该云盘当前被挂载到的CVM实例InstanceId\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "[ins-1111111,ins-2222222]", + "member": "string", + "name": "InstanceIdList", + "required": true, + "type": "list", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "云硬盘挂载的云主机ID\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "cbs-xxxxxxxx", + "member": "string", + "name": "InstanceId", + "required": true, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "云盘是否为共享型云盘。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "true", + "member": "bool", + "name": "Shareable", + "required": true, + "type": "bool", + "value_allowed_null": true + } + ], + "usage": "out" + }, "CLBSetting": { "document": "容器集群Pod服务CLB设置", "members": [ @@ -3448,6 +3866,69 @@ ], "type": "object" }, + "DeleteNodeResourceConfigRequest": { + "document": "DeleteNodeResourceConfig请求参数结构体", + "members": [ + { + "disabled": false, + "document": "集群实例Id", + "example": "无", + "member": "string", + "name": "InstanceId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "节点配置Id", + "example": "无", + "member": "uint64", + "name": "ResourceConfigId", + "required": true, + "type": "int" + }, + { + "disabled": false, + "document": "节点类型 CORE TASK ROUTER", + "example": "无", + "member": "string", + "name": "ResourceType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "类型为ComputeResource和EMR以及默认,默认为EMR", + "example": "ComputeResource", + "member": "string", + "name": "ResourceBaseType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "计算资源id", + "example": "emr-cr-xxxxx", + "member": "string", + "name": "ComputeResourceId", + "required": false, + "type": "string" + } + ], + "type": "object" + }, + "DeleteNodeResourceConfigResponse": { + "document": "DeleteNodeResourceConfig返回参数结构体", + "members": [ + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "DeleteUserManagerUserListRequest": { "document": "DeleteUserManagerUserList请求参数结构体", "members": [ @@ -5281,7 +5762,180 @@ "type": "string" } ], - "type": "object" + "type": "object" + }, + "DescribeNodeDataDisksRequest": { + "document": "DescribeNodeDataDisks请求参数结构体", + "members": [ + { + "disabled": false, + "document": "EMR集群实例ID", + "example": "emr-xxx", + "member": "string", + "name": "InstanceId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "节点CVM实例Id列表", + "example": "[ins-xxx,inx-xxx]", + "member": "string", + "name": "CvmInstanceIds", + "required": true, + "type": "list" + } + ], + "type": "object" + }, + "DescribeNodeDataDisksResponse": { + "document": "DescribeNodeDataDisks返回参数结构体", + "members": [ + { + "disabled": false, + "document": "总数量", + "example": "3", + "member": "int64", + "name": "TotalCount", + "required": true, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "云盘列表\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "CBSInstance", + "name": "CBSList", + "required": true, + "type": "list", + "value_allowed_null": true + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, + "DescribeNodeResourceConfigFastRequest": { + "document": "DescribeNodeResourceConfigFast请求参数结构体", + "members": [ + { + "disabled": false, + "document": "集群实例Id", + "example": "无", + "member": "string", + "name": "InstanceId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "节点类型 CORE TASK ROUTER ALL", + "example": "无", + "member": "string", + "name": "ResourceType", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "计费类型", + "example": "无", + "member": "int64", + "name": "PayMode", + "required": true, + "type": "int" + }, + { + "disabled": false, + "document": "可用区ID", + "example": "无", + "member": "int64", + "name": "ZoneId", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "类型为ComputeResource和EMR以及默认,默认为EMR", + "example": "ComputeResource", + "member": "string", + "name": "ResourceBaseType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "计算资源id", + "example": "emr-cr-xxxxx", + "member": "string", + "name": "ComputeResourceId", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "硬件类型", + "example": "HOST", + "member": "string", + "name": "HardwareResourceType", + "required": false, + "type": "string" + } + ], + "type": "object" + }, + "DescribeNodeResourceConfigFastResponse": { + "document": "DescribeNodeResourceConfigFast返回参数结构体", + "members": [ + { + "disabled": false, + "document": "DescribeResourceConfig接口返回值", + "example": "无", + "member": "DescribeResourceConfig", + "name": "Data", + "output_required": true, + "type": "list", + "value_allowed_null": false + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, + "DescribeResourceConfig": { + "document": "DescribeResourceConfig接口出参", + "members": [ + { + "disabled": false, + "document": "规格管理类型", + "example": "", + "member": "string", + "name": "ResourceType", + "required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "规格管理数据", + "example": "", + "member": "NodeResource", + "name": "ResourceData", + "required": true, + "type": "list", + "value_allowed_null": false + } + ], + "usage": "out" }, "DescribeResourceScheduleDiffDetailRequest": { "document": "DescribeResourceScheduleDiffDetail请求参数结构体", @@ -6468,7 +7122,7 @@ { "disabled": false, "document": "变化项的个数", - "example": "无", + "example": "1", "member": "uint64", "name": "Count", "output_required": false, @@ -6574,7 +7228,7 @@ { "disabled": false, "document": "当前所在位置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "当前所在位置", "member": "string", "name": "InEffectIndex", "output_required": false, @@ -6584,7 +7238,7 @@ { "disabled": false, "document": "待生效的位置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "待生效的位置", "member": "string", "name": "PendingEffectIndex", "output_required": false, @@ -6594,7 +7248,7 @@ { "disabled": false, "document": "计划模式名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "计划模式名称", "member": "string", "name": "PlanName", "output_required": false, @@ -6666,7 +7320,7 @@ { "disabled": false, "document": "数据盘类型,创建EMR容器集群实例可选\n<li> SSD云盘: CLOUD_SSD</li>\n<li>高效云盘: CLOUD_PREMIUM</li>\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "CLOUD_SSD", "member": "string", "name": "DiskType", "output_required": false, @@ -6677,7 +7331,7 @@ { "disabled": false, "document": "单块大小GB\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "70", "member": "int64", "name": "DiskCapacity", "output_required": false, @@ -6688,7 +7342,7 @@ { "disabled": false, "document": "数据盘数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "DiskNumber", "output_required": false, @@ -6779,7 +7433,7 @@ { "disabled": false, "document": "数据容量,单位为GB\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "70", "member": "int64", "name": "DiskSize", "output_required": true, @@ -6790,7 +7444,7 @@ { "disabled": false, "document": "额外性能\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "100", "member": "int64", "name": "ExtraPerformance", "output_required": false, @@ -6807,7 +7461,7 @@ { "disabled": false, "document": "时间戳\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "123", + "example": "1733799099153", "member": "string", "name": "Timestamp", "output_required": false, @@ -7413,7 +8067,7 @@ { "disabled": false, "document": "自定义应用角色。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"123\"", + "example": "\"Role_test\"", "member": "string", "name": "ApplicationRole", "output_required": true, @@ -7870,7 +8524,7 @@ { "disabled": false, "document": "当前伸缩组扩容出来的节点数量。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "CurrentNodes", "output_required": false, @@ -7881,7 +8535,7 @@ { "disabled": false, "document": "当前伸缩组扩容出来的后付费节点数量。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "CurrentPostPaidNodes", "output_required": false, @@ -7892,7 +8546,7 @@ { "disabled": false, "document": "当前伸缩组扩容出来的竞价实例节点数量。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "CurrentSpotPaidNodes", "output_required": false, @@ -9302,14 +9956,15 @@ "usage": "both" }, "InstanceChargePrepaid": { - "document": "实例预付费参数,只有在付费类型为PREPAID时生效。\n", + "document": "实例预付费参数,只有在付费类型为PREPAID时生效。", "members": [ { "disabled": false, "document": "包年包月时间,默认为1,单位:月。\n取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10,11, 12, 24, 36, 48, 60。", - "example": "无", + "example": "1", "member": "int64", "name": "Period", + "output_required": true, "required": true, "type": "int", "value_allowed_null": false @@ -9317,9 +9972,10 @@ { "disabled": false, "document": "是否自动续费,默认为否。\n<li>true:是</li>\n<li>false:否</li>", - "example": "无", + "example": "false", "member": "bool", "name": "RenewFlag", + "output_required": true, "required": true, "type": "bool", "value_allowed_null": false @@ -9762,7 +10418,7 @@ { "disabled": false, "document": "指标处理方法,1表示MAX,2表示MIN,3表示AVG。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "ProcessMethod", "output_required": true, @@ -9773,7 +10429,7 @@ { "disabled": false, "document": "规则优先级,添加时无效,默认为自增。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "Priority", "output_required": true, @@ -9784,7 +10440,7 @@ { "disabled": false, "document": "规则状态,1表示启动,3表示禁用。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "StrategyStatus", "output_required": true, @@ -9795,7 +10451,7 @@ { "disabled": false, "document": "规则扩容指定 yarn node label\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "label_test", "member": "string", "name": "YarnNodeLabel", "output_required": true, @@ -9806,7 +10462,7 @@ { "disabled": false, "document": "规则生效的有效时间", - "example": "无", + "example": "{\"Category\":1,\"StartDay\":\"2024-12-24\",\"EndDay\":\"2024-12-24\",\"StartTime\":\"00:00:00\",\"EndTime\":\"23:59:59\"}", "member": "string", "name": "PeriodValid", "output_required": true, @@ -9850,7 +10506,7 @@ { "disabled": false, "document": "预设配置组\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "\"{\\\"HDFS-3.2.2\\\":-1,\\\"YARN-3.2.2\\\":-1}", "member": "string", "name": "ConfigGroupAssigned", "output_required": true, @@ -9889,7 +10545,7 @@ { "disabled": false, "document": "规则统计周期,提供1min,3min,5min。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "300", "member": "int64", "name": "StatisticPeriod", "output_required": false, @@ -9900,7 +10556,7 @@ { "disabled": false, "document": "触发次数,当连续触发超过TriggerThreshold次后才开始扩缩容。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "TriggerThreshold", "output_required": false, @@ -9911,7 +10567,7 @@ { "disabled": false, "document": "扩缩容负载指标。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "AvailableVCores#root", "member": "string", "name": "LoadMetrics", "output_required": false, @@ -9922,7 +10578,7 @@ { "disabled": false, "document": "规则元数据记录ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "MetricId", "output_required": false, @@ -9966,22 +10622,20 @@ { "disabled": false, "document": "实例登录密码,8-16个字符,包含大写字母、小写字母、数字和特殊字符四种,特殊符号仅支持!@%^*,密码第一位不能为特殊字符", - "example": "无", + "example": "Password_test", "member": "string", "name": "Password", "required": false, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "密钥ID。关联密钥后,就可以通过对应的私钥来访问实例;PublicKeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取", - "example": "无", + "example": "PublicKeyId_test", "member": "string", "name": "PublicKeyId", "required": false, - "type": "string", - "value_allowed_null": false + "type": "string" } ], "usage": "in" @@ -10203,6 +10857,60 @@ ], "type": "object" }, + "ModifyInstanceBasicRequest": { + "document": "ModifyInstanceBasic请求参数结构体", + "members": [ + { + "disabled": false, + "document": "集群实例ID", + "example": "无", + "member": "string", + "name": "InstanceId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "集群名称", + "example": "无", + "member": "string", + "name": "ClusterName", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "用来标注修改计算资源", + "example": "ComputeResource", + "member": "string", + "name": "ResourceBaseType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "需要修改的计算资源id,与ResourceBaseType 配合使用", + "example": "emr-cr-xxxxx", + "member": "string", + "name": "ComputeResourceId", + "required": false, + "type": "string" + } + ], + "type": "object" + }, + "ModifyInstanceBasicResponse": { + "document": "ModifyInstanceBasic返回参数结构体", + "members": [ + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "ModifyPodNumRequest": { "document": "ModifyPodNum请求参数结构体", "members": [ @@ -10333,6 +11041,97 @@ ], "type": "object" }, + "ModifyResourceRequest": { + "document": "ModifyResource请求参数结构体", + "members": [ + { + "disabled": false, + "document": "实例ID", + "example": "emr-3ap64zl6", + "member": "string", + "name": "InstanceId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "计费类型", + "example": "0", + "member": "uint64", + "name": "PayMode", + "required": true, + "type": "int" + }, + { + "disabled": false, + "document": "变配CPU", + "example": "无", + "member": "int64", + "name": "NewCpu", + "required": true, + "type": "int" + }, + { + "disabled": false, + "document": "变配内存", + "example": "32", + "member": "int64", + "name": "NewMem", + "required": true, + "type": "int" + }, + { + "disabled": false, + "document": "Token", + "example": "无", + "member": "string", + "name": "ClientToken", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "变配机器规格", + "example": "无", + "member": "string", + "name": "InstanceType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "节点ID列表", + "example": "[\"emr-vm-xxx\",\"emr-vm-xxx\"]", + "member": "string", + "name": "ResourceIdList", + "required": false, + "type": "list" + } + ], + "type": "object" + }, + "ModifyResourceResponse": { + "document": "ModifyResource返回参数结构体", + "members": [ + { + "disabled": false, + "document": "流程traceId\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "afddlfjaldf", + "member": "string", + "name": "TraceId", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "ModifyResourceScheduleConfigRequest": { "document": "ModifyResourceScheduleConfig请求参数结构体", "members": [ @@ -10477,7 +11276,7 @@ { "disabled": false, "document": "资源前缀", - "example": "无", + "example": "emr-instance", "member": "string", "name": "ResourcePrefix", "required": true, @@ -10878,7 +11677,7 @@ { "disabled": false, "document": "该类型云盘个数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "Count", "output_required": true, @@ -10888,8 +11687,8 @@ }, { "disabled": false, - "document": "磁盘类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "磁盘类型\n1 :本地盘\n2 :云硬盘\n3 : 本地SSD\n4 : 云SSD\n5 : 高效云盘\n6 : 增强型SSD云硬盘\n11 : 吞吐型云硬盘\n12 : 极速型SSD云硬盘\n13 : 通用型SSD云硬盘\n14 : 大数据型云硬盘\n15 : 高IO型云硬盘\n16 : 远端SSD盘\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "4", "member": "int64", "name": "Type", "output_required": true, @@ -10900,7 +11699,7 @@ { "disabled": false, "document": "磁盘大小\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "100 GB", + "example": "200 GB", "member": "string", "name": "Size", "output_required": false, @@ -10910,8 +11709,8 @@ }, { "disabled": false, - "document": "云盘大小\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "云盘大小,单位b\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "214748364800", "member": "int64", "name": "Volume", "output_required": true, @@ -11608,47 +12407,123 @@ "member": "int64", "name": "TradeVersion", "output_required": true, - "type": "int", + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "各组件状态,Zookeeper:STARTED,ResourceManager:STARTED,STARTED已启动,STOPED已停止\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "string", + "name": "ServicesStatus", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "备注\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "string", + "name": "Remark", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "共享集群id\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "string", + "name": "SharedClusterId", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "共享集群id描述\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "string", + "name": "SharedClusterIdDesc", + "output_required": false, + "type": "string", + "value_allowed_null": true + } + ], + "usage": "out" + }, + "NodeResource": { + "document": "规格管理,规格类型描述", + "members": [ + { + "disabled": false, + "document": "配置Id", + "example": "无", + "member": "uint64", + "name": "ResourceConfigId", + "output_required": true, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "Resource\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "Resource", + "name": "Resource", + "output_required": true, + "type": "object", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "创建时间\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "string", + "name": "CreateTime", + "output_required": true, + "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "各组件状态,Zookeeper:STARTED,ResourceManager:STARTED,STARTED已启动,STOPED已停止\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "更新时间\n注意:此字段可能返回 null,表示取不到有效值。", "example": "无", "member": "string", - "name": "ServicesStatus", - "output_required": false, + "name": "UpdateTime", + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "备注\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否默认配置,DEFAULT,BACKUP\n注意:此字段可能返回 null,表示取不到有效值。", "example": "无", "member": "string", - "name": "Remark", - "output_required": false, + "name": "IsDefault", + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "共享集群id\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "该类型剩余\n注意:此字段可能返回 null,表示取不到有效值。", "example": "无", - "member": "string", - "name": "SharedClusterId", - "output_required": false, - "type": "string", + "member": "uint64", + "name": "MaxResourceNum", + "output_required": true, + "type": "int", "value_allowed_null": true }, { "disabled": false, - "document": "共享集群id描述\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "支持的包销时长\n注意:此字段可能返回 null,表示取不到有效值。", "example": "无", - "member": "string", - "name": "SharedClusterIdDesc", + "member": "int64", + "name": "PrepaidUnderwritePeriods", "output_required": false, - "type": "string", + "type": "list", "value_allowed_null": true } ], @@ -11783,6 +12658,56 @@ ], "usage": "both" }, + "NodeSpecDiskV2": { + "document": "节点磁盘类型", + "members": [ + { + "disabled": false, + "document": "数量\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "1", + "member": "int64", + "name": "Count", + "output_required": true, + "required": false, + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "名字\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "高效云盘", + "member": "string", + "name": "Name", + "output_required": true, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "磁盘类型\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "CLOUD_SSD", + "member": "string", + "name": "DiskType", + "output_required": true, + "required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "指定磁盘大小\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "1000", + "member": "int64", + "name": "DefaultDiskSize", + "output_required": true, + "required": false, + "type": "int", + "value_allowed_null": true + } + ], + "usage": "both" + }, "NotRepeatStrategy": { "document": "弹性扩缩容执行一次规则上下文", "members": [ @@ -12058,47 +12983,47 @@ "example": "node", "member": "string", "name": "InstanceType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "单价(原价)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0.52", "member": "float", "name": "Price", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": true }, { "disabled": false, "document": "单价(折扣价)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0.34", "member": "float", "name": "RealCost", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": true }, { "disabled": false, "document": "总价(折扣价)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0.34", "member": "float", "name": "RealTotalCost", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": true }, { "disabled": false, "document": "折扣\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "7.5", + "example": "6.6", "member": "float", "name": "Policy", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": true }, @@ -12108,7 +13033,7 @@ "example": "1", "member": "int64", "name": "GoodsNum", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true } @@ -12211,32 +13136,29 @@ { "disabled": false, "document": "TKE或EKS集群ID", - "example": "\"\"", + "example": "emr-test", "member": "string", "name": "InstanceId", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "自定义权限\n如:\n{\n \"apiVersion\": \"v1\",\n \"clusters\": [\n {\n \"cluster\": {\n \"certificate-authority-data\": \"xxxxxx==\",\n \"server\": \"https://xxxxx.com\"\n },\n \"name\": \"cls-xxxxx\"\n }\n ],\n \"contexts\": [\n {\n \"context\": {\n \"cluster\": \"cls-xxxxx\",\n \"user\": \"100014xxxxx\"\n },\n \"name\": \"cls-a44yhcxxxxxxxxxx\"\n }\n ],\n \"current-context\": \"cls-a4xxxx-context-default\",\n \"kind\": \"Config\",\n \"preferences\": {},\n \"users\": [\n {\n \"name\": \"100014xxxxx\",\n \"user\": {\n \"client-certificate-data\": \"xxxxxx\",\n \"client-key-data\": \"xxxxxx\"\n }\n }\n ]\n}", - "example": "\"\"", + "example": "{ \"apiVersion\": \"v1\", \"clusters\": [ { \"cluster\": { \"certificate-authority-data\": \"xxxxxx==\", \"server\": \"https://xxxxx.com\" }, \"name\": \"cls-xxxxx\" } ], \"contexts\": [ { \"context\": { \"cluster\": \"cls-xxxxx\", \"user\": \"100014xxxxx\" }, \"name\": \"cls-a44yhcxxxxxxxxxx\" } ], \"current-context\": \"cls-a4xxxx-context-default\", \"kind\": \"Config\", \"preferences\": {}, \"users\": [ { \"name\": \"100014xxxxx\", \"user\": { \"client-certificate-data\": \"xxxxxx\", \"client-key-data\": \"xxxxxx\" } } ] }", "member": "string", "name": "Config", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "自定义参数\n如:\n{\n \"apiVersion\": \"apps/v1\",\n \"kind\": \"Deployment\",\n \"metadata\": {\n \"name\": \"test-deployment\",\n \"labels\": {\n \"app\": \"test\"\n }\n },\n \"spec\": {\n \"replicas\": 3,\n \"selector\": {\n \"matchLabels\": {\n \"app\": \"test-app\"\n }\n },\n \"template\": {\n \"metadata\": {\n \"annotations\": {\n \"your-organization.com/department-v1\": \"test-example-v1\",\n \"your-organization.com/department-v2\": \"test-example-v2\"\n },\n \"labels\": {\n \"app\": \"test-app\",\n \"environment\": \"production\"\n }\n },\n \"spec\": {\n \"nodeSelector\": {\n \"your-organization/node-test\": \"test-node\"\n },\n \"containers\": [\n {\n \"name\": \"nginx\",\n \"image\": \"nginx:1.14.2\",\n \"ports\": [\n {\n \"containerPort\": 80\n }\n ]\n }\n ],\n \"affinity\": {\n \"nodeAffinity\": {\n \"requiredDuringSchedulingIgnoredDuringExecution\": {\n \"nodeSelectorTerms\": [\n {\n \"matchExpressions\": [\n {\n \"key\": \"disk-type\",\n \"operator\": \"In\",\n \"values\": [\n \"ssd\",\n \"sas\"\n ]\n },\n {\n \"key\": \"cpu-num\",\n \"operator\": \"Gt\",\n \"values\": [\n \"6\"\n ]\n }\n ]\n }\n ]\n }\n }\n }\n }\n }\n }\n }", - "example": "\"\"", + "example": "{ \"apiVersion\": \"apps/v1\", \"kind\": \"Deployment\", \"metadata\": { \"name\": \"test-deployment\", \"labels\": { \"app\": \"test\" } }, \"spec\": { \"replicas\": 3, \"selector\": { \"matchLabels\": { \"app\": \"test-app\" } }, \"template\": { \"metadata\": { \"annotations\": { \"your-organization.com/department-v1\": \"test-example-v1\", \"your-organization.com/department-v2\": \"test-example-v2\" }, \"labels\": { \"app\": \"test-app\", \"environment\": \"production\" } }, \"spec\": { \"nodeSelector\": { \"your-organization/node-test\": \"test-node\" }, \"containers\": [ { \"name\": \"nginx\", \"image\": \"nginx:1.14.2\", \"ports\": [ { \"containerPort\": 80 } ] } ], \"affinity\": { \"nodeAffinity\": { \"requiredDuringSchedulingIgnoredDuringExecution\": { \"nodeSelectorTerms\": [ { \"matchExpressions\": [ { \"key\": \"disk-type\", \"operator\": \"In\", \"values\": [ \"ssd\", \"sas\" ] }, { \"key\": \"cpu-num\", \"operator\": \"Gt\", \"values\": [ \"6\" ] } ] } ] } } } } } } }", "member": "string", "name": "Parameter", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" } ], "usage": "in" @@ -12368,7 +13290,7 @@ { "disabled": false, "document": "pod name\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "podname_test", "member": "string", "name": "PodName", "output_required": true, @@ -12467,9 +13389,10 @@ { "disabled": false, "document": "外部资源提供者的标识符,例如\"cls-a1cd23fa\"。", - "example": "\"\"", + "example": "cls-a1cd23fa", "member": "string", "name": "ResourceProviderIdentifier", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -12477,9 +13400,10 @@ { "disabled": false, "document": "外部资源提供者类型,例如\"tke\",当前仅支持\"tke\"。", - "example": "\"\"", + "example": "tke", "member": "string", "name": "ResourceProviderType", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -12487,9 +13411,10 @@ { "disabled": false, "document": "资源的用途,即节点类型,当前仅支持\"TASK\"。", - "example": "\"\"", + "example": "Task", "member": "string", "name": "NodeType", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -12500,6 +13425,7 @@ "example": "0", "member": "uint64", "name": "Cpu", + "output_required": true, "required": true, "type": "int", "value_allowed_null": false @@ -12510,6 +13436,7 @@ "example": "0", "member": "uint64", "name": "Memory", + "output_required": true, "required": true, "type": "int", "value_allowed_null": false @@ -12517,9 +13444,10 @@ { "disabled": false, "document": "资源对宿主机的挂载点,指定的挂载点对应了宿主机的路径,该挂载点在Pod中作为数据存储目录使用。弃用", - "example": "[]", + "example": "[\"/data\"]", "member": "string", "name": "DataVolumes", + "output_required": true, "required": false, "type": "list", "value_allowed_null": false @@ -12527,9 +13455,10 @@ { "disabled": false, "document": "Eks集群-CPU类型,当前支持\"intel\"和\"amd\"", - "example": "\"\"", + "example": "intel", "member": "string", "name": "CpuType", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -12537,9 +13466,10 @@ { "disabled": false, "document": "Pod节点数据目录挂载信息。", - "example": "[]", + "example": "[\"/data\"]", "member": "PodVolume", "name": "PodVolumes", + "output_required": true, "required": false, "type": "list", "value_allowed_null": false @@ -12550,6 +13480,7 @@ "example": "0", "member": "uint64", "name": "IsDynamicSpec", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -12560,6 +13491,7 @@ "example": "无", "member": "DynamicPodSpec", "name": "DynamicPodSpec", + "output_required": true, "required": false, "type": "object", "value_allowed_null": true @@ -12567,9 +13499,10 @@ { "disabled": false, "document": "代表vpc网络唯一id\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "vpc-xxtt67hg", "member": "string", "name": "VpcId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -12577,9 +13510,10 @@ { "disabled": false, "document": "代表vpc子网唯一id\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "sub-yiu78vg7", "member": "string", "name": "SubnetId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -12590,6 +13524,7 @@ "example": "无", "member": "string", "name": "PodName", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -12740,7 +13675,7 @@ { "disabled": false, "document": "执行脚本参数", - "example": "无", + "example": "test", "member": "string", "name": "Args", "required": false, @@ -12767,7 +13702,7 @@ { "disabled": false, "document": "COS的Domain数据,已废弃", - "example": "xxxx", + "example": "Domain_test", "member": "string", "name": "Domain", "required": false, @@ -12794,7 +13729,7 @@ { "disabled": false, "document": "脚本文件名,已废弃", - "example": "无", + "example": "test_file", "member": "string", "name": "CosFileName", "required": false, @@ -12812,7 +13747,7 @@ { "disabled": false, "document": "cos的SecretId", - "example": "xxxx", + "example": "CosSecretId_test", "member": "string", "name": "CosSecretId", "required": false, @@ -12821,7 +13756,7 @@ { "disabled": false, "document": "Cos的SecretKey", - "example": "xxxxx", + "example": "CosSecretKey_test", "member": "string", "name": "CosSecretKey", "required": false, @@ -12830,7 +13765,7 @@ { "disabled": false, "document": "cos的appid,已废弃", - "example": "xxxxxx", + "example": "41345531", "member": "string", "name": "AppId", "required": false, @@ -12839,7 +13774,7 @@ { "disabled": false, "document": "备注", - "example": "无", + "example": "remark_test", "member": "string", "name": "Remark", "required": false, @@ -13123,7 +14058,7 @@ "example": "0", "member": "int64", "name": "UsedQuota", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -13133,7 +14068,7 @@ "example": "0", "member": "int64", "name": "RemainingQuota", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -13143,17 +14078,17 @@ "example": "0", "member": "int64", "name": "TotalQuota", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "100002", "member": "string", "name": "Zone", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -13394,6 +14329,70 @@ ], "type": "object" }, + "ResizeDataDisksRequest": { + "document": "ResizeDataDisks请求参数结构体", + "members": [ + { + "disabled": false, + "document": "EMR集群实例ID", + "example": "emr-xxxxxxx", + "member": "string", + "name": "InstanceId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "需要扩容的云盘ID", + "example": "[disk-xxx1, disk-xxx2]", + "member": "string", + "name": "DiskIds", + "required": true, + "type": "list" + }, + { + "disabled": false, + "document": "需要扩充的容量值,容量值需要大于原容量,并且为10的整数倍", + "example": "300", + "member": "int64", + "name": "DiskSize", + "required": true, + "type": "int" + }, + { + "disabled": false, + "document": "需要扩容的节点ID列表", + "example": "[ins-xxx1,ins-xxx2]", + "member": "string", + "name": "CvmInstanceIds", + "required": true, + "type": "list" + } + ], + "type": "object" + }, + "ResizeDataDisksResponse": { + "document": "ResizeDataDisks返回参数结构体", + "members": [ + { + "disabled": false, + "document": "流程Id\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "10", + "member": "int64", + "name": "FlowId", + "output_required": false, + "type": "int", + "value_allowed_null": true + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "Resource": { "document": "资源详情", "members": [ @@ -13403,16 +14402,18 @@ "example": "CVM.SA2", "member": "string", "name": "Spec", + "output_required": true, "required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, - "document": "存储类型\n取值范围:\n<li>4:表示云SSD。</li>\n<li>5:表示高效云盘。</li>\n<li>6:表示增强型SSD云硬盘。</li>\n<li>11:表示吞吐型云硬盘。</li>\n<li>12:表示极速型SSD云硬盘。</li>\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "存储类型\n取值范围:\n<li>4:表示云SSD。</li>\n<li>5:表示高效云盘。</li>\n<li>6:表示增强型SSD云硬盘。</li>\n<li>11:表示吞吐型云硬盘。</li>\n<li>12:表示极速型SSD云硬盘。</li>:创建时该类型无效,会根据数据盘类型和节点类型自动判断\n注意:此字段可能返回 null,表示取不到有效值。", "example": "5", "member": "int64", "name": "StorageType", + "output_required": true, "required": true, "type": "int", "value_allowed_null": true @@ -13423,6 +14424,7 @@ "example": "LOUD_PREMIUM", "member": "string", "name": "DiskType", + "output_required": true, "required": true, "type": "string", "value_allowed_null": true @@ -13433,6 +14435,7 @@ "example": "131072", "member": "int64", "name": "MemSize", + "output_required": true, "required": true, "type": "int", "value_allowed_null": true @@ -13443,6 +14446,7 @@ "example": "2", "member": "int64", "name": "Cpu", + "output_required": true, "required": true, "type": "int", "value_allowed_null": true @@ -13453,6 +14457,7 @@ "example": "300", "member": "int64", "name": "DiskSize", + "output_required": true, "required": true, "type": "int", "value_allowed_null": true @@ -13463,6 +14468,7 @@ "example": "0", "member": "int64", "name": "RootSize", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -13473,6 +14479,7 @@ "example": "无", "member": "MultiDisk", "name": "MultiDisks", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -13483,6 +14490,7 @@ "example": "无", "member": "Tag", "name": "Tags", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -13493,6 +14501,7 @@ "example": "S2.MEDIUM8", "member": "string", "name": "InstanceType", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -13503,6 +14512,7 @@ "example": "1", "member": "uint64", "name": "LocalDiskNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -13513,6 +14523,7 @@ "example": "2", "member": "uint64", "name": "DiskNum", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -14606,22 +15617,20 @@ { "disabled": false, "document": "扩容节点类型取值范围:\n <li>MASTER</li>\n <li>TASK</li>\n <li>CORE</li>\n <li>ROUTER</li>", - "example": "无", + "example": "MASTER", "member": "string", "name": "NodeFlag", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "扩容节点数量", - "example": "无", + "example": "5", "member": "uint64", "name": "NodeCount", "required": true, - "type": "int", - "value_allowed_null": false + "type": "int" } ], "usage": "in" @@ -14685,7 +15694,7 @@ "example": "重启", "member": "string", "name": "Step", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -14695,17 +15704,17 @@ "example": "10%", "member": "string", "name": "Progress", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "失败信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "进程正在扩容中", "member": "string", "name": "FailReason", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -14715,7 +15724,7 @@ "example": "39986", "member": "uint64", "name": "JobId", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true } @@ -14731,47 +15740,47 @@ "example": "capacity", "member": "string", "name": "SchedulerName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "操作类型", - "example": "无", + "example": "OperatorName_test", "member": "string", "name": "OperatorName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "开始时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "CreateTime_test", "member": "string", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "结束时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "EndTime_test", "member": "string", "name": "EndTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2", "member": "int64", "name": "State", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -14781,7 +15790,7 @@ "example": "无", "member": "SchedulerTaskDetail", "name": "Details", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -14803,7 +15812,7 @@ { "disabled": false, "document": "引导脚步执行时机范围\n<li>resourceAfter:节点初始化后</li>\n<li>clusterAfter:集群启动后</li>\n<li>clusterBefore:集群启动前</li>", - "example": "无", + "example": "resourceAfter", "member": "string", "name": "ExecutionMoment", "required": true, @@ -14812,7 +15821,7 @@ { "disabled": false, "document": "执行脚本参数,参数格式请遵循标准Shell规范", - "example": "无", + "example": "test", "member": "string", "name": "Args", "required": false, @@ -14821,7 +15830,7 @@ { "disabled": false, "document": "脚本文件名", - "example": "无", + "example": "name_test", "member": "string", "name": "CosFileName", "required": false, @@ -14830,7 +15839,7 @@ { "disabled": false, "document": "备注", - "example": "无", + "example": "remark_test", "member": "string", "name": "Remark", "required": false, @@ -14845,7 +15854,7 @@ { "disabled": false, "document": "支持搜索的类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ipv4", "member": "string", "name": "SearchType", "output_required": false, @@ -14856,7 +15865,7 @@ { "disabled": false, "document": "支持搜索的值\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "127.0.0.1", "member": "string", "name": "SearchValue", "output_required": false, @@ -14959,7 +15968,7 @@ { "disabled": false, "document": "进程端口信息", - "example": " \"\"", + "example": " port_test", "member": "string", "name": "PortsInfo", "output_required": true, @@ -15019,7 +16028,7 @@ { "disabled": false, "document": "进程探测信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "无", "member": "ServiceProcessFunctionInfo", "name": "ServiceDetectionInfo", "output_required": true, @@ -15039,7 +16048,7 @@ { "disabled": false, "document": "进程健康状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "无", "member": "HealthStatus", "name": "HealthStatus", "output_required": true, @@ -15069,7 +16078,7 @@ { "disabled": false, "document": "测试环境api强校验,现网没有,emrcc接口返回有。不加会报错\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "”“", + "example": "无", "member": "string", "name": "HAState", "output_required": true, @@ -15079,7 +16088,7 @@ { "disabled": false, "document": "NameService名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "name_test", "member": "string", "name": "NameService", "output_required": true, @@ -15089,7 +16098,7 @@ { "disabled": false, "document": "是否支持联邦\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "false", "member": "bool", "name": "IsFederation", "output_required": true, @@ -15115,7 +16124,7 @@ { "disabled": false, "document": "探测告警级别\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "DetectAlert", "member": "string", "name": "DetectAlert", "output_required": true, @@ -15155,7 +16164,7 @@ { "disabled": false, "document": "探测功能描述\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "DetectFunctionKey", "member": "string", "name": "DetectFunctionKey", "output_required": true, @@ -15165,7 +16174,7 @@ { "disabled": false, "document": "探测功能结果\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "DetectFunctionValue", "member": "string", "name": "DetectFunctionValue", "output_required": true, @@ -15175,7 +16184,7 @@ { "disabled": false, "document": "探测结果\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "DetectTime", "member": "string", "name": "DetectTime", "output_required": true, @@ -15185,6 +16194,78 @@ ], "usage": "out" }, + "SetNodeResourceConfigDefaultRequest": { + "document": "SetNodeResourceConfigDefault请求参数结构体", + "members": [ + { + "disabled": false, + "document": "集群实例Id", + "example": "无", + "member": "string", + "name": "InstanceId", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "配置Id", + "example": "无", + "member": "uint64", + "name": "ResourceConfigId", + "required": true, + "type": "int" + }, + { + "disabled": false, + "document": "规格节点类型 CORE TASK ROUTER", + "example": "无", + "member": "string", + "name": "ResourceType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "类型为ComputeResource和EMR以及默认,默认为EMR", + "example": "ComputeResource", + "member": "string", + "name": "ResourceBaseType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "计算资源id", + "example": "emr-cr-xxx", + "member": "string", + "name": "ComputeResourceId", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "硬件类型", + "example": "HOST", + "member": "string", + "name": "HardwareResourceType", + "required": false, + "type": "string" + } + ], + "type": "object" + }, + "SetNodeResourceConfigDefaultResponse": { + "document": "SetNodeResourceConfigDefault返回参数结构体", + "members": [ + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "ShortNodeInfo": { "document": "节点信息", "members": [ @@ -15398,8 +16479,8 @@ "members": [ { "disabled": false, - "document": "步骤id", - "example": "无", + "document": "步骤", + "example": "resizeDisk", "member": "string", "name": "Stage", "output_required": true, @@ -15409,7 +16490,7 @@ { "disabled": false, "document": "步骤名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "扩容云盘", "member": "string", "name": "Name", "output_required": true, @@ -15419,7 +16500,7 @@ { "disabled": false, "document": "是否展示", - "example": "无", + "example": "true", "member": "bool", "name": "IsShow", "output_required": true, @@ -15429,7 +16510,7 @@ { "disabled": false, "document": "是否子流程", - "example": "无", + "example": "false", "member": "bool", "name": "IsSubFlow", "output_required": true, @@ -15439,7 +16520,7 @@ { "disabled": false, "document": "子流程标签\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "tag_test", "member": "string", "name": "SubFlowFlag", "output_required": true, @@ -15449,7 +16530,7 @@ { "disabled": false, "document": "步骤运行状态:0:未开始 1:进行中 2:已完成 3:部分完成 -1:失败", - "example": "无", + "example": "2", "member": "int64", "name": "Status", "output_required": true, @@ -15459,7 +16540,7 @@ { "disabled": false, "document": "步骤运行状态描述\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "已完成", "member": "string", "name": "Desc", "output_required": true, @@ -15469,7 +16550,7 @@ { "disabled": false, "document": "运行进度\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "float", "name": "Progress", "output_required": true, @@ -15479,7 +16560,7 @@ { "disabled": false, "document": "开始时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2024-12-26 14:49:20", "member": "datetime", "name": "Starttime", "output_required": true, @@ -15489,7 +16570,7 @@ { "disabled": false, "document": "结束时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2024-12-26 14:49:24", "member": "datetime", "name": "Endtime", "output_required": true, @@ -15499,7 +16580,7 @@ { "disabled": false, "document": "是否有详情信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "false", "member": "bool", "name": "HadWoodDetail", "output_required": true, @@ -15509,7 +16590,7 @@ { "disabled": false, "document": "Wood子流程Id\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "uint64", "name": "WoodJobId", "output_required": true, @@ -15519,7 +16600,7 @@ { "disabled": false, "document": "多语言版本Key\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "resizeDisk", "member": "string", "name": "LanguageKey", "output_required": true, @@ -15529,7 +16610,7 @@ { "disabled": false, "document": "如果stage失败,失败原因\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "\"FailedReason\"", "member": "string", "name": "FailedReason", "output_required": true, @@ -15539,7 +16620,7 @@ { "disabled": false, "document": "步骤耗时\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "耗时4秒", "member": "string", "name": "TimeConsuming", "output_required": true, @@ -16898,8 +17979,7 @@ "member": "string", "name": "UserName", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, @@ -16908,18 +17988,16 @@ "member": "string", "name": "UserGroup", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "密码", - "example": "123456", + "example": "PassWord_123", "member": "string", "name": "PassWord", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, @@ -16928,8 +18006,7 @@ "member": "string", "name": "ReMark", "required": false, - "type": "string", - "value_allowed_null": false + "type": "string" } ], "usage": "in" @@ -17132,7 +18209,7 @@ "example": "application_1686032366242_0014", "member": "string", "name": "Id", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -17142,7 +18219,7 @@ "example": "hadoop", "member": "string", "name": "User", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -17152,7 +18229,7 @@ "example": "HIVE-b67d086c-462b-492e-a5d1-8ecb81cea369", "member": "string", "name": "Name", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -17162,7 +18239,7 @@ "example": "root.default", "member": "string", "name": "Queue", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -17172,7 +18249,7 @@ "example": "TEZ", "member": "string", "name": "ApplicationType", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -17182,7 +18259,7 @@ "example": "6h12min", "member": "string", "name": "ElapsedTime", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -17192,7 +18269,7 @@ "example": "FINISHED", "member": "string", "name": "State", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -17202,7 +18279,7 @@ "example": "SUCCEEDED", "member": "string", "name": "FinalStatus", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -17212,7 +18289,7 @@ "example": "100", "member": "int64", "name": "Progress", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -17222,7 +18299,7 @@ "example": "1686101465000", "member": "int64", "name": "StartedTime", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -17232,7 +18309,7 @@ "example": "1686101465000", "member": "int64", "name": "FinishedTime", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -17242,7 +18319,7 @@ "example": "-1", "member": "int64", "name": "AllocatedMB", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -17252,7 +18329,7 @@ "example": "-1", "member": "int64", "name": "AllocatedVCores", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -17262,7 +18339,7 @@ "example": "-1", "member": "int64", "name": "RunningContainers", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -17272,7 +18349,7 @@ "example": "692611", "member": "int64", "name": "MemorySeconds", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -17282,337 +18359,337 @@ "example": "338", "member": "int64", "name": "VCoreSeconds", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "队列资源占比\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "float", "name": "QueueUsagePercentage", - "required": false, + "output_required": true, "type": "float", "value_allowed_null": true }, { "disabled": false, "document": "集群资源占比\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "float", "name": "ClusterUsagePercentage", - "required": false, + "output_required": true, "type": "float", "value_allowed_null": true }, { "disabled": false, "document": "预占用的内存\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "PreemptedResourceMB", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "预占用的VCore\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "PreemptedResourceVCores", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "预占的非应用程序主节点容器数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "NumNonAMContainerPreempted", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "AM预占用的容器数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "NumAMContainerPreempted", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Map总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "MapsTotal", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "完成的Map数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "MapsCompleted", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Reduce总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "ReducesTotal", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "完成的Reduce数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "ReducesCompleted", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "平均Map时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "4437", "member": "int64", "name": "AvgMapTime", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "平均Reduce时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "AvgReduceTime", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "平均Shuffle时间毫秒\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "AvgShuffleTime", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "平均Merge时间毫秒\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "AvgMergeTime", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "失败的Reduce执行次数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "FailedReduceAttempts", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Kill的Reduce执行次数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "KilledReduceAttempts", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "成功的Reduce执行次数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "SuccessfulReduceAttempts", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "失败的Map执行次数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "FailedMapAttempts", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Kill的Map执行次数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "KilledMapAttempts", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "成功的Map执行次数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "SuccessfulMapAttempts", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "GC毫秒\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "96", "member": "int64", "name": "GcTimeMillis", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Map使用的VCore毫秒\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "4168", "member": "int64", "name": "VCoreMillisMaps", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Map使用的内存毫秒\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "4268032", "member": "int64", "name": "MbMillisMaps", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Reduce使用的VCore毫秒\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "VCoreMillisReduces", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Reduce使用的内存毫秒\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "MbMillisReduces", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "启动Map的总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "TotalLaunchedMaps", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "启动Reduce的总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "TotalLaunchedReduces", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Map输入记录数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "MapInputRecords", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Map输出记录数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "MapOutputRecords", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Reduce输入记录数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "ReduceInputRecords", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "Reduce输出记录数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "ReduceOutputRecords", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "HDFS写入字节数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "HDFSBytesWritten", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "HDFS读取字节数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "13986", "member": "int64", "name": "HDFSBytesRead", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true } diff --git a/tccli/services/emr/v20190103/examples.json b/tccli/services/emr/v20190103/examples.json index c52f2b94be..0467484bac 100644 --- a/tccli/services/emr/v20190103/examples.json +++ b/tccli/services/emr/v20190103/examples.json @@ -8,6 +8,14 @@ "title": "添加扩缩容规则成功示例" } ], + "AddNodeResourceConfig": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddNodeResourceConfig\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ResourceType\": \"abc\",\n \"IsDefault\": \"abc\",\n \"ResourceConfig\": {\n \"Spec\": \"abc\",\n \"StorageType\": 0,\n \"DiskType\": \"abc\",\n \"RootSize\": 0,\n \"MemSize\": 0,\n \"Cpu\": 0,\n \"DiskSize\": 0,\n \"MultiDisks\": [\n {\n \"DiskType\": \"abc\",\n \"Volume\": 0,\n \"Count\": 0\n }\n ],\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"InstanceType\": \"abc\",\n \"LocalDiskNum\": 1,\n \"DiskNum\": 1\n },\n \"PayMode\": 0,\n \"ZoneId\": 0,\n \"MultipleResourceConfig\": [\n {\n \"Spec\": \"abc\",\n \"StorageType\": 0,\n \"DiskType\": \"abc\",\n \"RootSize\": 0,\n \"MemSize\": 0,\n \"Cpu\": 0,\n \"DiskSize\": 0,\n \"MultiDisks\": [\n {\n \"DiskType\": \"abc\",\n \"Volume\": 0,\n \"Count\": 0\n }\n ],\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"InstanceType\": \"abc\",\n \"LocalDiskNum\": 1,\n \"DiskNum\": 1\n }\n ],\n \"ResourceBaseType\": \"abc\",\n \"ComputeResourceId\": \"abc\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"f0f11d21-6d0d-4f73-9177-8ae4ec456068\"\n }\n}", + "title": "增加当前集群的节点规格配置" + } + ], "AddUsersForUserManager": [ { "document": "", @@ -16,6 +24,14 @@ "title": "test" } ], + "AttachDisks": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AttachDisks\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-xxxx\",\n \"DiskIds\": [\n \"disk-xxx1\",\n \"disk-xxx2\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"95eb9120-0883-407c-aa5a-43b4e2c250d1\"\n }\n}", + "title": "云盘挂载" + } + ], "CreateCloudInstance": [ { "document": "创建EMR容器实例", @@ -56,6 +72,14 @@ "title": "删除弹性扩缩容规则示例" } ], + "DeleteNodeResourceConfig": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteNodeResourceConfig\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ResourceType\": \"abc\",\n \"ResourceConfigId\": 1,\n \"ResourceBaseType\": \"abc\",\n \"ComputeResourceId\": \"abc\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"8c2ff02e-5f38-494a-8d2d-68a7dec6efcd\"\n }\n}", + "title": "输入输出例子" + } + ], "DeleteUserManagerUserList": [ { "document": "test", @@ -224,6 +248,22 @@ "title": "DescribeKyuubiQueryInfo" } ], + "DescribeNodeDataDisks": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeNodeDataDisks\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-xxxxxxx\",\n \"CvmInstanceIds\": [\n \"ins-xxxxxxxx\"\n ]\n}", + "output": "{\n \"Response\": {\n \"CBSList\": [\n {\n \"DeleteWithInstance\": true,\n \"DiskChargeType\": \"POSTPAID_BY_HOUR\",\n \"DiskId\": \"disk-xxxxxxxx\",\n \"DiskName\": \"未命名_1\",\n \"DiskSize\": 100,\n \"DiskState\": \"ATTACHED\",\n \"DiskType\": \"CLOUD_SSD\",\n \"DiskUsage\": \"DATA_DISK\",\n \"DeadlineTime\": \"\"\n },\n {\n \"DeleteWithInstance\": true,\n \"DiskChargeType\": \"POSTPAID_BY_HOUR\",\n \"DiskId\": \"disk-xxxxxxxx\",\n \"DiskName\": \"未命名_0\",\n \"DiskSize\": 50,\n \"DiskState\": \"ATTACHED\",\n \"DiskType\": \"CLOUD_SSD\",\n \"DiskUsage\": \"SYSTEM_DISK\",\n \"DeadlineTime\": \"\"\n }\n ],\n \"RequestId\": \"9dd6b795-aed5-4a09-b493-f460c1f1a0c5\",\n \"TotalCount\": 2\n }\n}", + "title": "查询节点数据盘信息" + } + ], + "DescribeNodeResourceConfigFast": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeNodeResourceConfigFast\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-laoxdz4n\",\n \"ResourceType\": \"ALL\",\n \"PayMode\": 0\n}", + "output": "{\n \"Response\": {\n \"Data\": [\n {\n \"ResourceData\": [\n {\n \"CreateTime\": \"2024-03-25 17:52:23\",\n \"IsDefault\": \"DEFAULT\",\n \"MaxResourceNum\": 0,\n \"Resource\": {\n \"Cpu\": 4,\n \"DiskNum\": 1,\n \"DiskSize\": 200,\n \"DiskType\": \"CLOUD_SSD\",\n \"InstanceType\": \"SA2.LARGE8\",\n \"LocalDiskNum\": 0,\n \"MemSize\": 8192,\n \"MultiDisks\": [],\n \"RootSize\": 70,\n \"Spec\": \"CVM.SA2\",\n \"StorageType\": 4,\n \"Tags\": null\n },\n \"ResourceConfigId\": 20332,\n \"UpdateTime\": \"2024-03-25 17:52:23\"\n }\n ],\n \"ResourceType\": \"CORE\"\n },\n {\n \"ResourceData\": [\n {\n \"CreateTime\": \"2024-04-08 15:13:04\",\n \"IsDefault\": \"DEFAULT\",\n \"MaxResourceNum\": 0,\n \"Resource\": {\n \"Cpu\": 8,\n \"DiskNum\": 1,\n \"DiskSize\": 200,\n \"DiskType\": \"CLOUD_HSSD\",\n \"InstanceType\": \"S6.2XLARGE32\",\n \"LocalDiskNum\": 0,\n \"MemSize\": 32768,\n \"MultiDisks\": [],\n \"RootSize\": 70,\n \"Spec\": \"CVM.S6\",\n \"StorageType\": 6,\n \"Tags\": null\n },\n \"ResourceConfigId\": 20560,\n \"UpdateTime\": \"2024-04-08 15:13:04\"\n }\n ],\n \"ResourceType\": \"TASK\"\n },\n {\n \"ResourceData\": [\n {\n \"CreateTime\": \"2024-04-08 22:04:42\",\n \"IsDefault\": \"DEFAULT\",\n \"MaxResourceNum\": 0,\n \"Resource\": {\n \"Cpu\": 4,\n \"DiskNum\": 1,\n \"DiskSize\": 200,\n \"DiskType\": \"CLOUD_HSSD\",\n \"InstanceType\": \"SA2.LARGE8\",\n \"LocalDiskNum\": 0,\n \"MemSize\": 8192,\n \"MultiDisks\": [],\n \"RootSize\": 70,\n \"Spec\": \"CVM.SA2\",\n \"StorageType\": 6,\n \"Tags\": null\n },\n \"ResourceConfigId\": 20563,\n \"UpdateTime\": \"2024-04-08 22:04:42\"\n }\n ],\n \"ResourceType\": \"ROUTER\"\n }\n ],\n \"RequestId\": \"638ef562-a954-4963-ae70-b54c2dd2bf94\"\n }\n}", + "title": "DescribeNodeResourceConfigFast示例" + } + ], "DescribeResourceSchedule": [ { "document": "", @@ -384,6 +424,14 @@ "title": "修改YARN资源调度的全局配置" } ], + "ModifyInstanceBasic": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstanceBasic\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ClusterName\": \"abc\",\n \"ResourceBaseType\": \"abc\",\n \"ComputeResourceId\": \"abc\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}", + "title": "ModifyInstanceBasic" + } + ], "ModifyPodNum": [ { "document": "调整容器集群Pod数量", @@ -392,6 +440,14 @@ "title": "调整容器集群Pod数量" } ], + "ModifyResource": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyResource\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-3ap64zl6\",\n \"PayMode\": \"0\",\n \"NewCpu\": \"8\",\n \"NewMem\": \"32\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"ef0a7e45-2f47-4379-bbc8-9594f51cb95f\"\n }\n}", + "title": "变配实例" + } + ], "ModifyResourcePools": [ { "document": "", @@ -464,6 +520,14 @@ "title": "yarn资源调度-重置" } ], + "ResizeDataDisks": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResizeDataDisks\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-xxxx\",\n \"CvmInstanceIds\": [\n \"ins-xx\"\n ],\n \"DiskIds\": [\n \"disk-xxx1\",\n \"disk-xxx2\"\n ],\n \"DiskSize\": 500\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"95eb9120-0883-407c-aa5a-43b4e2c250d1\"\n }\n}", + "title": "云盘扩容" + } + ], "RunJobFlow": [ { "document": "", @@ -488,6 +552,14 @@ "title": "集群扩容" } ], + "SetNodeResourceConfigDefault": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetNodeResourceConfigDefault\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ResourceType\": \"abc\",\n \"ResourceConfigId\": 1,\n \"ResourceBaseType\": \"abc\",\n \"ComputeResourceId\": \"abc\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"8c2ff02e-5f38-494a-8d2d-68a7dec6efcd\"\n }\n}", + "title": "输出输入参数" + } + ], "StartStopServiceOrMonitor": [ { "document": "启停服务接口", diff --git a/tccli/services/ess/v20201111/api.json b/tccli/services/ess/v20201111/api.json index a28c8f09b6..062abd0398 100644 --- a/tccli/services/ess/v20201111/api.json +++ b/tccli/services/ess/v20201111/api.json @@ -1077,6 +1077,15 @@ "name": "FlowReadLimit", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "禁止在签署过程中添加签署日期控件\n <br/>前置条件:文件发起合同时,指定SignBeanTag=1(可以在签署过程中添加签署控件):\n<ul>\n<li> 默认值:false,在开启:签署过程中添加签署控件时,添加签署控件会默认自带签署日期控件</li>\n<li> 可选值:true,在开启:签署过程中添加签署控件时,添加签署控件不会自带签署日期控件</li>\n</ul>", + "example": "false", + "member": "bool", + "name": "ForbidAddSignDate", + "required": false, + "type": "bool" } ], "usage": "in" @@ -6232,7 +6241,7 @@ "member": "CcInfo", "name": "CcInfos", "required": false, - "type": "object" + "type": "list" }, { "disabled": false, @@ -8980,7 +8989,7 @@ }, { "disabled": false, - "document": "搜索条件,本字段用于指定模板Id进行查询。\n- Key:template-id Values:需要查询的模板Id列表\n- Key:template-name Values:需要查询的模板名称列表\n", + "document": "搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。\n<ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href=\"https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png\" target=\"_blank\">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href=\"https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png\" target=\"_blank\">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href=\"https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png\" target=\"_blank\">模板名称</a>列表。</li></ul>", "example": "Filters", "member": "Filter", "name": "Filters", @@ -9007,7 +9016,7 @@ }, { "disabled": false, - "document": "指定查询的应用号,指定后查询该应用号下的模板列表。\n\n注:`1.ApplicationId为空时,查询所有应用下的模板列表。`", + "document": "通过指定[第三方应用的应用号(ApplicationId)](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png),您可以查询<a href=\"https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png\" target=\"_blank\">【应用模板库管理】</a>中某个第三方应用下的模板。\n\n<p><strong>注意事项:</strong></p>\n<ul><li>当 <strong>ApplicationId</strong> 为空时(默认),系统将查询<a href=\"https://qcloudimg.tencent-cloud.cn/raw/376943a1d472393dd5388592f2e85ee5.png\" target=\"_blank\">平台企业的所有模板</a>(自建应用使用的模板)。</li><li>当 <strong>ApplicationId</strong> 不为空时,系统将从<a href=\"https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png\" target=\"_blank\">【应用模板库管理】</a>中查询该特定应用下的模板(分享给第三方应用子企业的模板)。</li></ul>", "example": "无", "member": "string", "name": "ApplicationId", @@ -9043,7 +9052,7 @@ }, { "disabled": false, - "document": "是否获取模板预览链接", + "document": "是否获取模板预览链接。\n\n<ul><li><strong>false</strong>:不获取(默认)</li><li><strong>true</strong>:需要获取</li></ul>\n设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。", "example": "无", "member": "bool", "name": "WithPreviewUrl", diff --git a/tccli/services/essbasic/v20210526/api.json b/tccli/services/essbasic/v20210526/api.json index 216122134a..85523f0494 100644 --- a/tccli/services/essbasic/v20210526/api.json +++ b/tccli/services/essbasic/v20210526/api.json @@ -761,6 +761,15 @@ "name": "FlowReadLimit", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "禁止在签署过程中添加签署日期控件\n <br/>前置条件:文件发起合同时,指定SignBeanTag=1(可以在签署过程中添加签署控件):\n<ul>\n<li> 默认值:false,在开启:签署过程中添加签署控件时,添加签署控件会默认自带签署日期控件</li>\n<li> 可选值:true,在开启:签署过程中添加签署控件时,添加签署控件不会自带签署日期控件</li>\n</ul>", + "example": "false", + "member": "bool", + "name": "ForbidAddSignDate", + "required": false, + "type": "bool" } ], "usage": "in" @@ -1982,7 +1991,7 @@ }, { "disabled": false, - "document": "签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。\n\n在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。\n\n参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。", + "document": "<font color=\"red\">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。 \n\n参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。", "example": "无", "member": "string", "name": "UrlUseEnv", @@ -7903,7 +7912,7 @@ }, { "disabled": false, - "document": "签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。\n\n在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。\n\n参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。\n\n", + "document": "<font color=\"red\">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。 \n\n参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。", "example": "无", "member": "string", "name": "UrlUseEnv", diff --git a/tccli/services/essbasic/v20210526/examples.json b/tccli/services/essbasic/v20210526/examples.json index 01095e2c32..a5127c68d3 100644 --- a/tccli/services/essbasic/v20210526/examples.json +++ b/tccli/services/essbasic/v20210526/examples.json @@ -176,6 +176,12 @@ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchSignUrl\n<公共请求参数>\n\n{\n \"OpenId\": \"test_open_id\",\n \"OrganizationOpenId\": \"test_org_open_id\",\n \"Name\": \"\",\n \"NotifyType\": \"SMS\",\n \"Mobile\": \"\",\n \"OrganizationName\": \"\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"FlowIds\": [\n \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n \"yDR1AUUgygj******uO4zjE8gTG7xvgH\"\n ]\n}", "output": "{\n \"Response\": {\n \"ExpiredTime\": 1684899114,\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n \"SignUrl\": \"https://ess.url.cn/FuP**Swc\",\n \"MiniAppPath\": \"pages/guide/index?shortKey=FuP3**wc\"\n }\n}", "title": "生成子客经办人小程序批量签署链接" + }, + { + "document": "按照合同发起时候返回的合同信息生成批量签署链接,通过FlowIds参数对用户可以批签的合同进行限制,并指定批量领取的动态签署方,预设了平台子客企业OpenId后进入领取链接只能以该平台子客企业企业身份去领取并签署合同", + "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"FlowIds\": [\n \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n \"yDR1AUUgygj******uO4zjE8gTG7xvgH\"\n ],\n \"FlowBatchUrlInfo\": {\n \"FlowBatchApproverInfos\": [\n {\n \"FlowId\": \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n \"RecipientId\": \"yDC5yUUckpwexozwUuoHfkTwB00zdfLo\"\n },\n {\n \"FlowId\": \"yDR1AUUgygj******uO4zjE8gTG7xvgH\",\n \"RecipientId\": \"yDCY3UUckp7tpp8rUEGRbNoRjQJ7t9bd\"\n }\n ]\n },\n \"OrganizationOpenId\": \"test_org_open_id\"\n}", + "output": "{\n \"Response\": {\n \"ExpiredTime\": 1735801457,\n \"MiniAppPath\": \"pages/guide/index?shortKey=yDCYSUx7LAQNwHZxaR93\",\n \"RequestId\": \"s1735196657684290155\",\n \"SignUrl\": \"https://essurl.cn/exssUH2TNe\"\n }\n}", + "title": "生成动态签署人批量领取链接-并且预设平台子客企业OpenId" } ], "ChannelCreateBoundFlows": [ @@ -1052,6 +1058,12 @@ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSignUrls\n<公共请求参数>\n\n{\n \"FlowIds\": [\n \"yDwhGUUfe5g******CX8ZwTiSg8gISocy\"\n ],\n \"RecipientIds\": [\n \"yDwJDUUckpkv98zbUEF1GNmv6ln4ga9W\"\n ],\n \"OrganizationOpenId\": \"dian_zi_qian\",\n \"GenerateType\": \"RECIPIENT\",\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"1000***8062\",\n \"ProxyOperator\": {\n \"OpenId\": \"yDR3L****eTdCt5TVx\"\n },\n \"AppId\": \"125***319\"\n },\n \"Endpoint\": \"\"\n}", "output": "{\n \"Response\": {\n \"ErrorMessages\": [],\n \"RequestId\": \"s1696937862717144539\",\n \"SignUrlInfos\": [\n {\n \"ApproverType\": \"\",\n \"CustomUserId\": \"\",\n \"Deadline\": 0,\n \"FlowGroupId\": \"\",\n \"FlowId\": \"yDwhGUUfe5g******CX8ZwTiSg8gISocy\",\n \"IdCardNumber\": \"\",\n \"Mobile\": \"\",\n \"Name\": \"\",\n \"OpenId\": \"\",\n \"OrganizationName\": \"\",\n \"SignId\": \"\",\n \"SignOrder\": 0,\n \"SignQrcodeUrl\": \"https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06dcbe2797f**************69ee4e24cd976dd8376dbd41c6ff227c803c4c561c\",\n \"SignUrl\": \"https://test.essurl.cn/gGI***nZC\"\n }\n ]\n }\n}", "title": "获取动态签署人补充链接, 并且预设平台子客企业OpenId" + }, + { + "document": "获取动态签署人补充链接,创建合同组时未指定具体签署人,可获取链接后推送给指定的人进行补充\n注: \n`1.参数GenerateType需传值为RECIPIENT` \n`2.需指定对应的合同组FlowGroupUrlInfo签署方角色编号(即RecipientId)` \n`3.通过参数OrganizationOpenId 指定要以那个平台子企业身份进行补充` \n", + "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSignUrls\n<公共请求参数>\n\n{\n \"FlowGroupId\": \"yDCVAUUckpwa592pUxoLjOlRVS9Zgusf\",\n \"FlowGroupUrlInfo\": {\n \"FlowGroupApproverInfos\": [\n {\n \"FlowId\": \"yDCVAUUckpwa59rcUxoLjOlEctyesTzj\",\n \"RecipientId\": \"yDCVAUUckpwa59riUxoLjOluu9cf6B3s\"\n },\n {\n \"FlowId\": \"yDCVAUUckpwa592dUxoLjOl8StWKvg9K\",\n \"RecipientId\": \"yDCVAUUckpwa59r6UxoLjOlCC6ZHk7rL\"\n }\n ]\n },\n \"GenerateType\": \"RECIPIENT\",\n \"OrganizationOpenId\": \"dian_zi_qian\",\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"1000***8062\",\n \"ProxyOperator\": {\n \"OpenId\": \"yDR3L****eTdCt5TVx\"\n },\n \"AppId\": \"125***319\"\n }\n}", + "output": "{\n \"Response\": {\n \"ErrorMessages\": [],\n \"RequestId\": \"s1735197391369377331\",\n \"SignUrlInfos\": [\n {\n \"ApproverType\": \"\",\n \"CustomUserId\": \"\",\n \"Deadline\": 0,\n \"FlowGroupId\": \"\",\n \"FlowId\": \"yDCVAUUckpwa592pUxoLjOlRVS9Zgusf\",\n \"IdCardNumber\": \"\",\n \"Mobile\": \"\",\n \"Name\": \"\",\n \"OpenId\": \"\",\n \"OrganizationName\": \"\",\n \"SignId\": \"\",\n \"SignOrder\": 0,\n \"SignQrcodeUrl\": \"https://file.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06d80c4246fb57d8a524d6bfe32b7434ba9f1xxxxxx1dc3aff08c747a658df2039a153bf6256b31d292522a4231\",\n \"SignUrl\": \"https://essurl.cn/pazAUBJ4vi\"\n }\n ]\n }\n}", + "title": "获取合同组动态签署人补充链接, 并且预设平台子客企业OpenId" } ], "DeleteOrganizationAuthorizations": [ diff --git a/tccli/services/faceid/v20180301/api.json b/tccli/services/faceid/v20180301/api.json index 140fc0962a..28b88203ef 100644 --- a/tccli/services/faceid/v20180301/api.json +++ b/tccli/services/faceid/v20180301/api.json @@ -4601,7 +4601,7 @@ }, { "disabled": false, - "document": "类型。\n- 取值范围:\n01:身份证。 \n03 :中国护照。\n04 :军官证。\n05 :武警证。\n06:港澳通行证 。\n07 :台胞证 。\n08:外国护照 。\n09 :士兵证。\n09 :临时身份证。\n11:户口本 。\n12 :警官证 。\n13:外国人永久居留证。\n14:港澳台居民居住证。\n15:回乡证。\n16:大陆居民来往台湾通行证。\n99:其他证件。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "类型。\n- 取值范围:\n01:身份证。 \n03 :中国护照。\n04 :军官证。\n05 :武警证。\n06:港澳通行证 。\n07 :台胞证 。\n08:外国护照 。\n09 :士兵证。\n10 :临时身份证。\n11:户口本 。\n12 :警官证 。\n13:外国人永久居留证。\n14:港澳台居民居住证。\n15:回乡证。\n16:大陆居民来往台湾通行证。\n99:其他证件。\n注意:此字段可能返回 null,表示取不到有效值。", "example": "01", "member": "string", "name": "IdType", @@ -4661,8 +4661,8 @@ }, { "disabled": false, - "document": "旅行证件类的核验结果。\n- JSON格式如下:\n{\"result_issuer \":\"签发者证书合法性验证结果 \",\"result_pape r\":\"证件安全对象合法性验证 结果 \",\"result_data\" :\"防数据篡改验证结果 \",\"result_chip\" :\"防证书件芯片被复制验证结果\"} 。\n- 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{\"result_issuer \":\"签发者证书合法性验证结果 \",\"result_pape r\":\"证件安全对象合法性验证 结果 \",\"result_data\" :\"防数据篡改验证结果 \",\"result_chip\" :\"防证书件芯片被复制验证结果\"} ", + "document": "旅行证件类的核验结果。\n- JSON格式如下:\n{\"result_issuer \":\"签发者证书合法性验证结果 \",\"result_pape r\":\"证件安全对象合法性验证结果 \",\"result_data\" :\"防数据篡改验证结果 \",\"result_chip\" :\"防证书件芯片被复制验证结果\"} 。\n- 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", "member": "string", "name": "CheckMRTD", "output_required": true, diff --git a/tccli/services/gaap/v20180529/api.json b/tccli/services/gaap/v20180529/api.json index 253f000402..d1333ebe70 100644 --- a/tccli/services/gaap/v20180529/api.json +++ b/tccli/services/gaap/v20180529/api.json @@ -1061,7 +1061,7 @@ "example": "rs-123456", "member": "string", "name": "RealServerId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1071,7 +1071,7 @@ "example": "192.168.1.1", "member": "string", "name": "RealServerIP", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1081,7 +1081,7 @@ "example": "1", "member": "int64", "name": "RealServerWeight", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -1091,7 +1091,7 @@ "example": "1", "member": "int64", "name": "RealServerStatus", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -1101,17 +1101,17 @@ "example": "443", "member": "int64", "name": "RealServerPort", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "当源站为域名时,域名被解析成一个或者多个IP,该字段表示其中异常的IP列表。状态异常,但该字段为空时,表示域名解析异常。", - "example": "[]", + "example": "[\"127.0.0.1\"]", "member": "string", "name": "DownIPList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1121,7 +1121,7 @@ "example": "master", "member": "string", "name": "RealServerFailoverRole", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -1516,7 +1516,7 @@ { "disabled": false, "document": "如果在通道组下创建通道,需要填写通道组的ID", - "example": "\"\"", + "example": "lg-b4c3d2a1", "member": "string", "name": "GroupId", "required": false, @@ -1589,7 +1589,7 @@ { "disabled": false, "document": "(旧参数,请切换到ProxyIds)通道的实例ID。", - "example": "xx", + "example": "[\"link-w34r23rf\"]", "member": "string", "name": "InstanceIds", "required": false, @@ -1598,7 +1598,7 @@ { "disabled": false, "document": "用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。\n更多详细信息请参阅:如何保证幂等性。", - "example": "xx", + "example": "qwe3e43242f424", "member": "string", "name": "ClientToken", "required": false, @@ -1622,20 +1622,20 @@ { "disabled": false, "document": "非运行状态下的通道实例ID列表,不可开启。", - "example": "[]", + "example": "[\"link-l3h5l2\"]", "member": "string", "name": "InvalidStatusInstanceSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "开启操作失败的通道实例ID列表。", - "example": "[]", + "example": "[\"link-l3h5l2\"]", "member": "string", "name": "OperationFailedInstanceSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1669,20 +1669,20 @@ { "disabled": false, "document": "非运行状态下的通道实例ID列表,不可开启。", - "example": "[]", + "example": "[\"lg-3j2l5l43\"]", "member": "string", "name": "InvalidStatusInstanceSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "开启操作失败的通道实例ID列表。", - "example": "[]", + "example": "[\"lg-3j2l5l43\"]", "member": "string", "name": "OperationFailedInstanceSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1710,7 +1710,7 @@ { "disabled": false, "document": "安全组策略ID。操作通道组时须填此参数。", - "example": "xx", + "example": "policy-lwe3456l", "member": "string", "name": "PolicyId", "required": false, @@ -1832,7 +1832,7 @@ { "disabled": false, "document": "证书内容。采用url编码。其中:\n当证书类型为基础认证配置时,该参数填写用户名/密码对。格式:“用户名:密码”,例如:root:FSGdT。其中密码使用htpasswd或者openssl,例如:openssl passwd -crypt 123456。\n当证书类型为CA/SSL证书时,该参数填写证书内容,格式为pem。", - "example": "%0A-----BEGIN%20CERTIFICATE-----%0AMIIFmDCCBICgAwIBAgIQC6TGAPV%2B4MO7NIhlkkKFljANBgkqhkiG9w0BAQsFADBy%0AMQswCQYDVQQGEwJDTjElMCMGA1UEChMcVHJ1c3RBc2lhIFRlY2hub2xvZ2llcywg%0ASW5jLjEdMBsGA1UECxMURG9tYWluIFZhbGlkYXRlZCBTU0wxHTAbBgNVBAMTFFRy%0AdXN0QXNpYSBUTFMgUlNBIENBMB4XDTE5MDQwMjAwMDAwMFoXDTIwMDQwMTEyMDAw%0AMFowGTEXMBUGA1UEAxMObGFnYW1lZnQwMS54eXowggEiMA0GCSqGSIb3DQEBAQUA%0AA4IBDwAwggEKAoIBAQCuSgglfAksbFSrvWp6cEFr8ulTWEND2KvXf6cCs3kBBCzE%0AMLhCw4792LMFY0%2BFE7a0j7i5nJ9%2BQvhX7GRiu1P9flyge0eUCOBOAtVCn0dvhbLy%0A7efWsmH3kp/owWXnZXeb/k5R1FvojCiV968MxMC%2B2Y7ejz5qMm5XlQPn3xQOEj2h%0AQmHwQ9XwO8qRsIuCD1oNrsXsyXuEhA2zkEvcgtYP35zPsXfjbBaBg7Iw3o0j3jXj%0AgdhD2Q2OzH05jDn3hDhSnej1jbWuGmDEOO%2Bu6W/xqnCOhBMjWLnuW2aUddiBiqsH%0A8BQK/Ge6HUp%2BmMdkdNAw5FN6ztIPzP6GFb0OOLitAgMBAAGjggKBMIICfTAfBgNV%0AHSMEGDAWgBR/05nzoEcOMQBWViKOt8ye3coBijAdBgNVHQ4EFgQUqYL1l3uFqYHC%0A2mJcZC26nLHtkjYwLQYDVR0RBCYwJIIObGFnYW1lZnQwMS54eXqCEnd3dy5sYWdh%0AbWVmdDAxLnh5ejAOBgNVHQ8BAf8EBAMCBaAwHQYDVR0lBBYwFAYIKwYBBQUHAwEG%0ACCsGAQUFBwMCMEwGA1UdIARFMEMwNwYJYIZIAYb9bAECMCowKAYIKwYBBQUHAgEW%0AHGh0dHBzOi8vd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwCAYGZ4EMAQIBMH0GCCsGAQUF%0ABwEBBHEwbzAhBggrBgEFBQcwAYYVaHR0cDovL29jc3AuZGNvY3NwLmNuMEoGCCsG%0AAQUFBzAChj5odHRwOi8vY2FjZXJ0cy5kaWdpdGFsY2VydHZhbGlkYXRpb24uY29t%0AL1RydXN0QXNpYVRMU1JTQUNBLmNydDAJBgNVHRMEAjAAMIIBAwYKKwYBBAHWeQIE%0AAgSB9ASB8QDvAHUAu9nfvB%2BKcbWTlCOXqpJ7RzhXlQqrUugakJZkNo4e0YUAAAFp%0A3cON9gAABAMARjBEAiABFpvdLsJKm6zxh5wLS6uN5%2BTnX8bXD5bj7CPVC4Kg/wIg%0AB%2BBzdsZL0UmuvbNAYkr8W53bJKhEgoHJ0RdSyoF5yZAAdgCHdb/nWXz4jEOZX73z%0Abv9WjUdWNv9KtWDBtOr/XqCDDwAAAWndw47mAAAEAwBHMEUCIQC%2BDdvaJ2kKvsVv%0AiivLe4W/YFa/K64HdnyOdHksEl9pSAIgTqLXfw6Tc7d%2BgiKMtt%2B6P/xdrvjGt5Du%0Aokvgu70INuQwDQYJKoZIhvcNAQELBQADggEBAHxewHgySBS5UoO6l/IcU95baR/O%0AYGLcCpgEbWj4MigIZcrkHsD7RddRDoyM/3hxKyzs3Dkes4wHTQDWnyrNuXdn8aNV%0AJAhrh/0yzAe3/UTJ/%2BSRoMg1K6rHWORmLa52d9u3Ei%2B1BF2qLi5L2tTmLrSQJXzB%0ANSIFd40x1mZLp9uqhcB9kcwwkHSFUtLjFwUSN6Zjn9FStlq06ezjgnVv2tP9/HoP%0AKWiRgRFDgqj8%2BROJPQvfuO2xdWoxYUmuMcx1o6IiSVn2F48ood029cyT%2Bt3TaYpb%0AhVI9JuYnHW9kN69xPNzamJVCdu4i/1ELvcr0p/wQf9ax63XsgX4YYhdYgMQ%3D%0A-----END%20CERTIFICATE-----%0A-----BEGIN%20CERTIFICATE-----%0AMIIErjCCA5agAwIBAgIQBYAmfwbylVM0jhwYWl7uLjANBgkqhkiG9w0BAQsFADBh%0AMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3%0Ad3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBD%0AQTAeFw0xNzEyMDgxMjI4MjZaFw0yNzEyMDgxMjI4MjZaMHIxCzAJBgNVBAYTAkNO%0AMSUwIwYDVQQKExxUcnVzdEFzaWEgVGVjaG5vbG9naWVzLCBJbmMuMR0wGwYDVQQL%0AExREb21haW4gVmFsaWRhdGVkIFNTTDEdMBsGA1UEAxMUVHJ1c3RBc2lhIFRMUyBS%0AU0EgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCgWa9X%2Bph%2BwAm8%0AYh1Fk1MjKbQ5QwBOOKVaZR/OfCh%2BF6f93u7vZHGcUU/lvVGgUQnbzJhR1UV2epJa%0Ae%2Bm7cxnXIKdD0/VS9btAgwJszGFvwoqXeaCqFoP71wPmXjjUwLT70%2BqvX4hdyYfO%0AJcjeTz5QKtg8zQwxaK9x4JT9CoOmoVdVhEBAiD3DwR5fFgOHDwwGxdJWVBvktnoA%0AzjdTLXDdbSVC5jZ0u8oq9BiTDv7jAlsB5F8aZgvSZDOQeFrwaOTbKWSEInEhnchK%0AZTD1dz6aBlk1xGEI5PZWAnVAba/ofH33ktymaTDsE6xRDnW97pDkimCRak6CEbfe%0A3dXw6OV5AgMBAAGjggFPMIIBSzAdBgNVHQ4EFgQUf9OZ86BHDjEAVlYijrfMnt3K%0AAYowHwYDVR0jBBgwFoAUA95QNVbRTLtm8KPiGxvDl7I90VUwDgYDVR0PAQH/BAQD%0AAgGGMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjASBgNVHRMBAf8ECDAG%0AAQH/AgEAMDQGCCsGAQUFBwEBBCgwJjAkBggrBgEFBQcwAYYYaHR0cDovL29jc3Au%0AZGlnaWNlcnQuY29tMEIGA1UdHwQ7MDkwN6A1oDOGMWh0dHA6Ly9jcmwzLmRpZ2lj%0AZXJ0LmNvbS9EaWdpQ2VydEdsb2JhbFJvb3RDQS5jcmwwTAYDVR0gBEUwQzA3Bglg%0AhkgBhv1sAQIwKjAoBggrBgEFBQcCARYcaHR0cHM6Ly93d3cuZGlnaWNlcnQuY29t%0AL0NQUzAIBgZngQwBAgEwDQYJKoZIhvcNAQELBQADggEBAK3dVOj5dlv4MzK2i233%0AlDYvyJ3slFY2X2HKTYGte8nbK6i5/fsDImMYihAkp6VaNY/en8WZ5qcrQPVLuJrJ%0ADSXT04NnMeZOQDUoj/NHAmdfCBB/h1bZ5OGK6Sf1h5Yx/5wR4f3TUoPgGlnU7EuP%0AISLNdMRiDrXntcImDAiRvkh5GJuH4YCVE6XEntqaNIgGkRwxKSgnU3Id3iuFbW9F%0AUQ9Qqtb1GX91AJ7i4153TikGgYCdwYkBURD8gSVe8OAco6IfZOYt/TEwii1Ivi1C%0AqnuUlWpsF1LdQNIdfbW3TSe0BhQa7ifbVIfvPWHYOu3rkg1ZeMo6XRU9B4n5VyJY%0ARmE%3D%0A-----END%20CERTIFICATE-----%0A", + "example": "%0A-----BEGIN%20CERTIFICATE-----%0AMIIFmDC.....ARmE%3D%0A-----END%20CERTIFICATE-----%0A", "member": "string", "name": "CertificateContent", "required": true, @@ -1841,7 +1841,7 @@ { "disabled": false, "document": "证书名称", - "example": "xxx", + "example": "cert-xl2hh434", "member": "string", "name": "CertificateAlias", "required": false, @@ -2032,7 +2032,7 @@ { "disabled": false, "document": "服务器证书,用于客户端与GAAP的HTTPS的交互。", - "example": "abc", + "example": "cert-j3l3l4l5", "member": "string", "name": "CertificateId", "required": false, @@ -2041,7 +2041,7 @@ { "disabled": false, "document": "客户端CA证书,用于客户端与GAAP的HTTPS的交互。\n仅当采用双向认证的方式时,需要设置该字段或PolyClientCertificateIds字段。", - "example": "xx", + "example": "cert-j3l3l4l5", "member": "string", "name": "ClientCertificateId", "required": false, @@ -2050,7 +2050,7 @@ { "disabled": false, "document": "客户端CA证书,用于客户端与GAAP的HTTPS的交互。\n仅当采用双向认证的方式时,需要设置该字段或ClientCertificateId字段。", - "example": "xx", + "example": "[\"\"cert-j3l3l4l5\"]", "member": "string", "name": "PolyClientCertificateIds", "required": false, @@ -2313,7 +2313,7 @@ { "disabled": false, "document": "通道组ID,与ProxyId不能同时设置,对应为通道组创建监听器", - "example": "xx", + "example": "lg-123456", "member": "string", "name": "GroupId", "required": false, @@ -2331,7 +2331,7 @@ "example": "listener-o0f3at99", "member": "string", "name": "ListenerId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -2404,7 +2404,7 @@ { "disabled": false, "document": "客户端CA单证书ID,仅当双向认证时设置该参数或PolyClientCertificateIds参数", - "example": "xx", + "example": "cert-12345", "member": "string", "name": "ClientCertificateId", "required": false, @@ -2413,7 +2413,7 @@ { "disabled": false, "document": "新的客户端多CA证书ID,仅当双向认证时设置该参数或设置ClientCertificateId参数", - "example": "[]", + "example": "[\"cert-123456\"]", "member": "string", "name": "PolyClientCertificateIds", "required": false, @@ -2422,7 +2422,7 @@ { "disabled": false, "document": "通道组ID,与ProxyId之间只能设置一个。表示创建通道组的监听器。", - "example": "xx", + "example": "lg-12345", "member": "string", "name": "GroupId", "required": false, @@ -2449,7 +2449,7 @@ "example": "listener-o0f3at99", "member": "string", "name": "ListenerId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -2514,7 +2514,7 @@ { "disabled": false, "document": "通道组别名", - "example": "test", + "example": "group_name", "member": "string", "name": "GroupName", "required": true, @@ -2614,7 +2614,7 @@ { "disabled": false, "document": "通道名称。", - "example": "test", + "example": "proxy_name", "member": "string", "name": "ProxyName", "required": true, @@ -2659,7 +2659,7 @@ { "disabled": false, "document": "用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。\n更多详细信息请参阅:如何保证幂等性。", - "example": "\"\"", + "example": "\"SFGRETH235FDSFG534SFDDS\"", "member": "string", "name": "ClientToken", "required": false, @@ -2840,7 +2840,7 @@ { "disabled": false, "document": "回源Host。加速通道转发到源站的host,不设置该参数时,使用默认的host设置,即客户端发起的http请求的host。", - "example": "无", + "example": "www.baidu.com", "member": "string", "name": "ForwardHost", "required": false, @@ -2885,7 +2885,7 @@ "example": "rule-qws4fmyl", "member": "string", "name": "RuleId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -2922,7 +2922,7 @@ { "disabled": false, "document": "通道组ID", - "example": "xx", + "example": "lg-123456", "member": "string", "name": "GroupId", "required": false, @@ -2937,10 +2937,10 @@ { "disabled": false, "document": "安全策略ID", - "example": "pl-xxxx", + "example": "pl-123456", "member": "string", "name": "PolicyId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -3349,7 +3349,7 @@ { "disabled": false, "document": "需要删除的证书ID。", - "example": "xxxx", + "example": "cert-afdsf2345", "member": "string", "name": "CertificateId", "required": true, @@ -3571,7 +3571,7 @@ { "disabled": false, "document": "删除操作失败的监听器ID列表", - "example": "[]", + "example": "[\"listener-o0f3at99\"]", "member": "string", "name": "OperationFailedListenerSet", "output_required": true, @@ -3591,7 +3591,7 @@ { "disabled": false, "document": "无效的监听器ID列表,如:监听器不存在,监听器对应实例不匹配", - "example": "[]", + "example": "[\"listener-o0f3at99\"]", "member": "string", "name": "InvalidStatusListenerSet", "output_required": true, @@ -4564,7 +4564,7 @@ { "disabled": false, "document": "过滤条件,按照监听器名称进行精确查询", - "example": "test", + "example": "listener_name", "member": "string", "name": "ListenerName", "required": false, @@ -4656,7 +4656,7 @@ { "disabled": false, "document": "通道组ID。ListenerId、ProxyId、GroupId须至少填写一个,且ProxyId与GroupId至多只能填写其中一个。", - "example": "xx", + "example": "lg-12345", "member": "string", "name": "GroupId", "required": false, @@ -4665,7 +4665,7 @@ { "disabled": false, "document": "过滤条件,根据监听器ID进行精确查询。ListenerId、ProxyId、GroupId须至少填写一个,且ProxyId与GroupId至多只能填写其中一个。", - "example": "xx", + "example": "listener-12345", "member": "string", "name": "ListenerId", "required": false, @@ -4674,7 +4674,7 @@ { "disabled": false, "document": "过滤条件,根据监听器名称进行精确查询。", - "example": "xx", + "example": "listener-name", "member": "string", "name": "ListenerName", "required": false, @@ -4710,7 +4710,7 @@ { "disabled": false, "document": "过滤条件,支持按照端口或监听器名称进行模糊查询", - "example": "xx", + "example": "listener-search-name", "member": "string", "name": "SearchValue", "required": false, @@ -4906,7 +4906,7 @@ { "disabled": false, "document": "(旧参数,请切换到ProxyIds)按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。", - "example": "无", + "example": "proxy-123456", "member": "string", "name": "InstanceIds", "required": false, @@ -4933,7 +4933,7 @@ { "disabled": false, "document": "过滤条件。 \n每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。 \nProjectId - String - 是否必填:否 -(过滤条件)按照项目ID过滤。 \nAccessRegion - String - 是否必填:否 - (过滤条件)按照接入地域过滤。 \nRealServerRegion - String - 是否必填:否 - (过滤条件)按照源站地域过滤。\nGroupId - String - 是否必填:否 - (过滤条件)按照通道组ID过滤。\nIPAddressVersion - String - 是否必填:否 - (过滤条件)按照IP版本过滤。\nPackageType - String - 是否必填:否 - (过滤条件)按照通道套餐类型过滤。", - "example": "无", + "example": "{\"Name\":\"filter_name\",\"Value\":\"filter_values\"}", "member": "Filter", "name": "Filters", "required": false, @@ -4942,7 +4942,7 @@ { "disabled": false, "document": "(新参数,替代InstanceIds)按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。", - "example": "[]", + "example": "[\"proxy-123456\"]", "member": "string", "name": "ProxyIds", "required": false, @@ -4951,7 +4951,7 @@ { "disabled": false, "document": "标签列表,当存在该字段时,拉取对应标签下的资源列表。\n最多支持5个标签,当存在两个或两个以上的标签时,满足其中任意一个标签时,通道会被拉取出来。", - "example": "无", + "example": "{\"TagKey\":\"tag_key\",\"TagValue\":\"tag_values\"}", "member": "TagPair", "name": "TagSet", "required": false, @@ -5035,7 +5035,7 @@ { "disabled": false, "document": "(旧参数,请切换到ProxyIds)通道ID列表。", - "example": "xx", + "example": "link-1234abcd", "member": "string", "name": "InstanceIds", "required": false, @@ -5044,7 +5044,7 @@ { "disabled": false, "document": "(新参数)通道ID列表。", - "example": "[\"link-1234abcd\\r\\n\"]", + "example": "[\"link-1234abcd\"]", "member": "string", "name": "ProxyIds", "required": false, @@ -5062,7 +5062,7 @@ "example": "无", "member": "ProxyStatus", "name": "InstanceStatusSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -5165,7 +5165,7 @@ { "disabled": false, "document": "通道组ID。", - "example": "lg", + "example": "lg-123456", "member": "string", "name": "GroupId", "required": true, @@ -5458,7 +5458,7 @@ { "disabled": false, "document": "L7层规则ID", - "example": "xx", + "example": "rule-jlfw45jl", "member": "string", "name": "RuleId", "required": false, @@ -5512,7 +5512,7 @@ "example": "无", "member": "StatisticsDataInfo", "name": "StatisticsData", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -5522,7 +5522,7 @@ "example": "无", "member": "MetricStatisticsInfo", "name": "RsStatisticsData", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -5633,7 +5633,7 @@ { "disabled": false, "document": "源站ID列表", - "example": "[\"rs-4ftghy6\\n\"]", + "example": "[\"rs-4ftghy6\"]", "member": "string", "name": "RealServerIds", "required": true, @@ -5651,7 +5651,7 @@ "example": "1", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -5661,7 +5661,7 @@ "example": "无", "member": "RealServerStatus", "name": "RealServerStatusSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -5756,7 +5756,7 @@ { "disabled": false, "document": "标签键。", - "example": "testkey", + "example": "tag_key", "member": "string", "name": "TagKey", "required": true, @@ -5765,7 +5765,7 @@ { "disabled": false, "document": "标签值。", - "example": "test", + "example": "tag_value", "member": "string", "name": "TagValue", "required": true, @@ -5792,7 +5792,7 @@ "example": "1", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -5802,7 +5802,7 @@ "example": "无", "member": "TagResourceInfo", "name": "ResourceSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -5906,7 +5906,7 @@ { "disabled": false, "document": "规则ID列表。最多支持10个规则。", - "example": "[\"rule-3bsuu01r\\n\"]", + "example": "[\"rule-3bsuu01r\"]", "member": "string", "name": "RuleIds", "required": true, @@ -6142,7 +6142,7 @@ { "disabled": false, "document": "过滤条件,根据监听器名称精确查询", - "example": "test", + "example": "listener_name", "member": "string", "name": "ListenerName", "required": false, @@ -6234,7 +6234,7 @@ { "disabled": false, "document": "任务ID,值为异步接口返回的RequestId,此参数不能传空值。", - "example": "无", + "example": "hjl-23432-hflkdsjafklj", "member": "string", "name": "TaskId", "required": false, @@ -6249,7 +6249,7 @@ { "disabled": false, "document": "任务状态:RUNNING,FAIL,SUCCESS", - "example": "无", + "example": "RUNNING", "member": "string", "name": "Status", "output_required": false, @@ -6259,7 +6259,7 @@ { "disabled": false, "document": "任务ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "hlkj34532hnlkh-543654hlkjhgkjghkj", "member": "string", "name": "TaskId", "output_required": false, @@ -6434,7 +6434,7 @@ { "disabled": false, "document": "(新参数)通道实例ID列表。", - "example": "[\"link-11112222\\r\\n\",\"link-11113333\\r\\n\"]", + "example": "[\"link-11112222\",\"link-11113333\"]", "member": "string", "name": "ProxyIds", "required": false, @@ -6459,7 +6459,7 @@ { "disabled": false, "document": "销毁操作失败的通道实例ID列表。", - "example": "[]", + "example": "[\"link-11112222\"]", "member": "string", "name": "OperationFailedInstanceSet", "output_required": true, @@ -6559,40 +6559,40 @@ { "disabled": false, "document": "域名ID", - "example": "xx", + "example": "dm-12345", "member": "string", "name": "DomainId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "完整域名记录", - "example": "xx", + "example": "www.test.com", "member": "string", "name": "FullDomain", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "别名", - "example": "xx", + "example": "domai-alias", "member": "string", "name": "Alias", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "类型", - "example": "xx", + "example": "IP", "member": "string", "name": "Type", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -6602,7 +6602,7 @@ "example": "1", "member": "uint64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -6612,7 +6612,7 @@ "example": "0", "member": "int64", "name": "ProjectId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -6622,7 +6622,7 @@ "example": "127.0.0.1", "member": "string", "name": "DefaultValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -6632,37 +6632,37 @@ "example": "2", "member": "uint64", "name": "ProxyCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "创建时间,使用UNIX时间戳", - "example": "123456", + "example": "1716065151", "member": "uint64", "name": "CreateTime", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "更新时间,使用UNIX时间戳\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "123456", + "example": "1716065151", "member": "uint64", "name": "UpdateTime", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "标签列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "[{\"TagKey\":\"tag-key\", \"TagValue\":\"tag-value\"}]", "member": "TagPair", "name": "TagSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -6672,7 +6672,7 @@ "example": "RECOVER", "member": "string", "name": "BanStatus", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -6847,7 +6847,7 @@ { "disabled": false, "document": "转发规则域名。", - "example": "xx", + "example": "www.domain.com", "member": "string", "name": "Domain", "output_required": true, @@ -6857,7 +6857,7 @@ { "disabled": false, "document": "该域名对应的转发规则列表。", - "example": "[]", + "example": "无", "member": "RuleInfo", "name": "RuleSet", "output_required": true, @@ -6867,7 +6867,7 @@ { "disabled": false, "document": "该域名对应的服务器证书ID,值为default时,表示使用默认证书(监听器配置的证书)。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "cert-12345", "member": "string", "name": "CertificateId", "output_required": true, @@ -6877,7 +6877,7 @@ { "disabled": false, "document": "该域名对应服务器证书名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "cert-alias", "member": "string", "name": "CertificateAlias", "output_required": true, @@ -6887,7 +6887,7 @@ { "disabled": false, "document": "该域名对应的客户端证书ID,值为default时,表示使用默认证书(监听器配置的证书)。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "cert-54321", "member": "string", "name": "ClientCertificateId", "output_required": true, @@ -6897,7 +6897,7 @@ { "disabled": false, "document": "该域名对应客户端证书名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "cert-alias", "member": "string", "name": "ClientCertificateAlias", "output_required": true, @@ -6907,7 +6907,7 @@ { "disabled": false, "document": "该域名对应基础认证配置ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "base-auth", "member": "string", "name": "BasicAuthConfId", "output_required": true, @@ -6927,7 +6927,7 @@ { "disabled": false, "document": "该域名对应基础认证配置名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "base-alias", "member": "string", "name": "BasicAuthConfAlias", "output_required": true, @@ -6937,7 +6937,7 @@ { "disabled": false, "document": "该域名对应源站认证证书ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "cert-12345", "member": "string", "name": "RealServerCertificateId", "output_required": true, @@ -6957,7 +6957,7 @@ { "disabled": false, "document": "该域名对应源站认证证书名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "cert-12345", "member": "string", "name": "RealServerCertificateAlias", "output_required": true, @@ -6967,7 +6967,7 @@ { "disabled": false, "document": "该域名对应通道认证证书ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "cert-12345", "member": "string", "name": "GaapCertificateId", "output_required": true, @@ -6987,7 +6987,7 @@ { "disabled": false, "document": "该域名对应通道认证证书名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "cert-alias", "member": "string", "name": "GaapCertificateAlias", "output_required": true, @@ -6997,7 +6997,7 @@ { "disabled": false, "document": "源站认证域名。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "www.domain.com", "member": "string", "name": "RealServerCertificateDomain", "output_required": true, @@ -7120,22 +7120,20 @@ { "disabled": false, "document": "过滤条件", - "example": "无", + "example": "name", "member": "string", "name": "Name", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "过滤值", - "example": "无", + "example": "value", "member": "string", "name": "Values", "required": true, - "type": "list", - "value_allowed_null": false + "type": "list" } ], "usage": "in" @@ -7324,7 +7322,7 @@ { "disabled": false, "document": "监听器名称", - "example": "test", + "example": "listener-name", "member": "string", "name": "ListenerName", "output_required": true, @@ -7582,7 +7580,7 @@ { "disabled": false, "document": "(旧参数,请切换到RealServerRegion)源站区域名称。", - "example": "\"\"", + "example": "GuangZhou", "member": "string", "name": "DestRegion", "required": false, @@ -7679,7 +7677,7 @@ { "disabled": false, "document": "通道带宽费用梯度价格。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "70", "member": "BandwidthPriceGradient", "name": "BandwidthUnitPrice", "output_required": true, @@ -7699,7 +7697,7 @@ { "disabled": false, "document": "价格使用的货币,支持人民币,美元等。", - "example": "xx", + "example": "USD", "member": "string", "name": "Currency", "output_required": true, @@ -7842,7 +7840,7 @@ { "disabled": false, "document": "证书名字。长度不超过50个字符。", - "example": "test", + "example": "cert-name", "member": "string", "name": "CertificateAlias", "required": false, @@ -7905,7 +7903,7 @@ { "disabled": false, "document": "新的多客户端证书ID列表。其中:\n仅当采用双向认证方式时,需要设置该参数或ClientCertificateId参数。", - "example": "[]", + "example": "[\"cert-abcdefgh\"]", "member": "string", "name": "PolyClientCertificateIds", "required": false, @@ -7968,7 +7966,7 @@ { "disabled": false, "document": "客户端CA证书ID,仅适用于version3.0的通道。其中:\n不带该字段和PolyClientCertificateIds时,表示使用原证书;\n携带该字段时并且ClientCertificateId=default,表示使用监听器证书;\n其他情况,使用该ClientCertificateId或PolyClientCertificateIds指定的证书。", - "example": "xx", + "example": "cert-ljfdslajjl", "member": "string", "name": "ClientCertificateId", "required": false, @@ -7977,7 +7975,7 @@ { "disabled": false, "document": "客户端CA证书ID,仅适用于version3.0的通道。其中:\n不带该字段和ClientCertificateId时,表示使用原证书;\n携带该字段时并且ClientCertificateId=default,表示使用监听器证书;\n其他情况,使用该ClientCertificateId或PolyClientCertificateIds指定的证书。", - "example": "[\"xx\"]", + "example": "[\"cert-ljfdslajjl\"]", "member": "string", "name": "PolyClientCertificateIds", "required": false, @@ -8031,7 +8029,7 @@ { "disabled": false, "document": "别名", - "example": "test", + "example": "domain-name", "member": "string", "name": "Alias", "required": false, @@ -8292,7 +8290,7 @@ { "disabled": false, "document": "(旧参数,请切换到ProxyIds)一个或多个待操作的通道ID。", - "example": "[]", + "example": "[\"link-sfsa\"]", "member": "string", "name": "InstanceIds", "required": false, @@ -8301,7 +8299,7 @@ { "disabled": false, "document": "通道名称。可任意命名,但不得超过32个字符。", - "example": "test", + "example": "proxy-name", "member": "string", "name": "ProxyName", "required": false, @@ -8310,7 +8308,7 @@ { "disabled": false, "document": "用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。\n更多详细信息请参阅:如何保证幂等性。", - "example": "xx", + "example": "hjkhkljhjkl34534gfdsgfd", "member": "string", "name": "ClientToken", "required": false, @@ -8319,7 +8317,7 @@ { "disabled": false, "document": "(新参数)一个或多个待操作的通道ID。", - "example": "[\"link-11112222\\n\",\"link-11113333\\n\"]", + "example": "[\"link-11112222\",\"link-11113333\"]", "member": "string", "name": "ProxyIds", "required": false, @@ -8346,7 +8344,7 @@ { "disabled": false, "document": "需要修改到的项目ID。", - "example": "12345", + "example": "1", "member": "int64", "name": "ProjectId", "required": true, @@ -8355,7 +8353,7 @@ { "disabled": false, "document": "(旧参数,请切换到ProxyIds)一个或多个待操作的通道ID。", - "example": "[]", + "example": "[\"link-11112222\"]", "member": "string", "name": "InstanceIds", "required": false, @@ -8373,7 +8371,7 @@ { "disabled": false, "document": "(新参数)一个或多个待操作的通道ID。", - "example": "[\"link-11112222\\n\",\"link-11113333\\n\"]", + "example": "[\"link-11112222\",\"link-11113333\"]", "member": "string", "name": "ProxyIds", "required": false, @@ -8400,7 +8398,7 @@ { "disabled": false, "document": "(旧参数,请切换到ProxyId)通道的实例ID。", - "example": "[]", + "example": "link-4ftf12sb", "member": "string", "name": "InstanceId", "required": false, @@ -8427,7 +8425,7 @@ { "disabled": false, "document": "用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。\n更多详细信息请参阅:如何保证幂等性。", - "example": "xx", + "example": "fdeg3453gfdsg", "member": "string", "name": "ClientToken", "required": false, @@ -8589,7 +8587,7 @@ { "disabled": false, "document": "健康检查配置参数", - "example": "无", + "example": "{\"Path\":\"/check_path\"}", "member": "RuleCheckParams", "name": "CheckParams", "required": false, @@ -8598,7 +8596,7 @@ { "disabled": false, "document": "转发规则路径", - "example": "/", + "example": "/path", "member": "string", "name": "Path", "required": false, @@ -8616,7 +8614,7 @@ { "disabled": false, "document": "回源Host。加速通道转发到源站的请求中携带的host。\n当ForwardHost=default时,使用规则的域名,其他情况为该字段所设置的值。", - "example": "xx", + "example": "www.baidu.com", "member": "string", "name": "ForwardHost", "required": false, @@ -9030,20 +9028,20 @@ { "disabled": false, "document": "国家名", - "example": "", + "example": "中国大陆-华北", "member": "string", "name": "NationCountryName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "国家内部编码", - "example": "", + "example": "101001", "member": "string", "name": "NationCountryInnerCode", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -9082,7 +9080,7 @@ { "disabled": false, "document": "(旧参数,请切换到ProxyIds)通道的实例ID列表。", - "example": "[]", + "example": "[\"link-11112222\",\"link-11113333\"]", "member": "string", "name": "InstanceIds", "required": false, @@ -9091,7 +9089,7 @@ { "disabled": false, "document": "用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。\n更多详细信息请参阅:如何保证幂等性。", - "example": "xx", + "example": "dfasfdsa454356", "member": "string", "name": "ClientToken", "required": false, @@ -9100,7 +9098,7 @@ { "disabled": false, "document": "(新参数)通道的实例ID列表。", - "example": "[\"link-11112222\\n\",\"link-11113333\\n\"]", + "example": "[\"link-11112222\",\"link-11113333\"]", "member": "string", "name": "ProxyIds", "required": false, @@ -9115,20 +9113,20 @@ { "disabled": false, "document": "非关闭状态下的通道实例ID列表,不可开启。", - "example": "[]", + "example": "[\"link-11112222\",\"link-11113333\"]", "member": "string", "name": "InvalidStatusInstanceSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "开启操作失败的通道实例ID列表。", - "example": "[]", + "example": "[\"link-11112222\",\"link-11113333\"]", "member": "string", "name": "OperationFailedInstanceSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -9162,20 +9160,20 @@ { "disabled": false, "document": "非关闭状态下的通道实例ID列表,不可开启。", - "example": "[]", + "example": "[\"lg-11112222\"]", "member": "string", "name": "InvalidStatusInstanceSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "开启操作失败的通道实例ID列表。", - "example": "[]", + "example": "[\"lg-11112222\"]", "member": "string", "name": "OperationFailedInstanceSet", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -9240,60 +9238,60 @@ { "disabled": false, "document": "地域ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "\"NorthChina\"", "member": "string", "name": "RegionId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "地域名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "\"NorthChina\"", "member": "string", "name": "RegionName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "通道ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "\"link-xxxxx\"", "member": "string", "name": "ProxyId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "通道接入ip\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "\"1.1.1.1\"", "member": "string", "name": "Vip", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "三网通道VIP列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "无", "member": "IPDetail", "name": "VipList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "接入点IDC类型。ec或dc\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "\"DC\"", "member": "string", "name": "SourceRegionIdcType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -9306,7 +9304,7 @@ { "disabled": false, "document": "创建时间", - "example": "1234", + "example": "1735182500", "member": "int64", "name": "CreateTime", "output_required": true, @@ -9416,7 +9414,7 @@ { "disabled": false, "document": "通道组ID", - "example": "\"\"", + "example": "lg-123456", "member": "string", "name": "GroupId", "output_required": true, @@ -9426,7 +9424,7 @@ { "disabled": false, "document": "标签列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "[{\"TagKey\":\"tag_key\"}, {\"TagValue\":\"tag_value\"}]", "member": "TagPair", "name": "TagSet", "output_required": true, @@ -9436,7 +9434,7 @@ { "disabled": false, "document": "安全策略ID,当设置了安全策略时,存在该字段。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "gsp-123456", "member": "string", "name": "PolicyId", "output_required": true, @@ -9542,7 +9540,7 @@ { "disabled": false, "document": "通道组名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"test\"", + "example": "\"group-name\"", "member": "string", "name": "GroupName", "output_required": true, @@ -9602,7 +9600,7 @@ { "disabled": false, "document": "创建时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "12345", + "example": "1716065151", "member": "uint64", "name": "CreateTime", "output_required": true, @@ -10667,70 +10665,70 @@ { "disabled": false, "document": "策略:允许(ACCEPT)或拒绝(DROP)", - "example": "", + "example": "DROP", "member": "string", "name": "Action", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "请求来源Ip或Ip段", - "example": "", + "example": "113.16.26.77", "member": "string", "name": "SourceCidr", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "规则别名", - "example": "", + "example": "测试规则", "member": "string", "name": "AliasName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "目标端口范围\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "9300", "member": "string", "name": "DestPortRange", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "规则ID", - "example": "", + "example": "sr-ruia8hnh", "member": "string", "name": "RuleId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "要匹配的协议类型(TCP/UDP)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "TCP", "member": "string", "name": "Protocol", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "安全策略ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "sp-lar36ifx", "member": "string", "name": "PolicyId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -10788,7 +10786,7 @@ { "disabled": false, "document": "基础认证配置ID,从证书管理页获取。", - "example": "xxx", + "example": "conf-fdsajl234", "member": "string", "name": "BasicAuthConfId", "required": false, @@ -10797,7 +10795,7 @@ { "disabled": false, "document": "通道SSL证书ID,从证书管理页获取。", - "example": "xxx", + "example": "cert-sfjdslj23423", "member": "string", "name": "GaapCertificateId", "required": false, @@ -10806,7 +10804,7 @@ { "disabled": false, "document": "源站CA证书ID,从证书管理页获取。源站认证时,填写该参数或RealServerCertificateId参数", - "example": "xx", + "example": "cert-sfjdslj23423", "member": "string", "name": "RealServerCertificateId", "required": false, @@ -10815,7 +10813,7 @@ { "disabled": false, "document": "该字段已废弃,请使用创建规则和修改规则中的SNI功能。", - "example": "xx", + "example": "cert-sfjdslj23423", "member": "string", "name": "RealServerCertificateDomain", "required": false, @@ -10824,7 +10822,7 @@ { "disabled": false, "document": "多源站CA证书ID,从证书管理页获取。源站认证时,填写该参数或RealServerCertificateId参数", - "example": "[]", + "example": "[“cert-sfjdslj23423”]", "member": "string", "name": "PolyRealServerCertificateIds", "required": false, diff --git a/tccli/services/gaap/v20180529/examples.json b/tccli/services/gaap/v20180529/examples.json index 5a48f9594a..dbb9ee238a 100644 --- a/tccli/services/gaap/v20180529/examples.json +++ b/tccli/services/gaap/v20180529/examples.json @@ -73,13 +73,13 @@ "CreateCertificate": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCertificate\n<公共请求参数>\n\n{\n \"CertificateType\": \"2\",\n \"CertificateAlias\": \"xxx\",\n \"CertificateKey\": \"%0A-----BEGIN%20RSA%20PRIVATE%20KEY-----%0Axxxxxxxxxxx%0A-----END%20RSA%20PRIVATE%20KEY-----%0A\",\n \"CertificateContent\": \"%0A-----BEGIN%20CERTIFICATE-----%0AMIIFmDCCBICgAwIBAgIQC6TGAPV%2B4MO7NIhlkkKFljANBgkqhkiG9w0BAQsFADBy%0AMQswCQYDVQQGEwJDTjElMCMGA1UEChMcVHJ1c3RBc2lhIFRlY2hub2xvZ2llcywg%0ASW5jLjEdMBsGA1UECxMURG9tYWluIFZhbGlkYXRlZCBTU0wxHTAbBgNVBAMTFFRy%0AdXN0QXNpYSBUTFMgUlNBIENBMB4XDTE5MDQwMjAwMDAwMFoXDTIwMDQwMTEyMDAw%0AMFowGTEXMBUGA1UEAxMObGFnYW1lZnQwMS54eXowggEiMA0GCSqGSIb3DQEBAQUA%0AA4IBDwAwggEKAoIBAQCuSgglfAksbFSrvWp6cEFr8ulTWEND2KvXf6cCs3kBBCzE%0AMLhCw4792LMFY0%2BFE7a0j7i5nJ9%2BQvhX7GRiu1P9flyge0eUCOBOAtVCn0dvhbLy%0A7efWsmH3kp/owWXnZXeb/k5R1FvojCiV968MxMC%2B2Y7ejz5qMm5XlQPn3xQOEj2h%0AQmHwQ9XwO8qRsIuCD1oNrsXsyXuEhA2zkEvcgtYP35zPsXfjbBaBg7Iw3o0j3jXj%0AgdhD2Q2OzH05jDn3hDhSnej1jbWuGmDEOO%2Bu6W/xqnCOhBMjWLnuW2aUddiBiqsH%0A8BQK/Ge6HUp%2BmMdkdNAw5FN6ztIPzP6GFb0OOLitAgMBAAGjggKBMIICfTAfBgNV%0AHSMEGDAWgBR/05nzoEcOMQBWViKOt8ye3coBijAdBgNVHQ4EFgQUqYL1l3uFqYHC%0A2mJcZC26nLHtkjYwLQYDVR0RBCYwJIIObGFnYW1lZnQwMS54eXqCEnd3dy5sYWdh%0AbWVmdDAxLnh5ejAOBgNVHQ8BAf8EBAMCBaAwHQYDVR0lBBYwFAYIKwYBBQUHAwEG%0ACCsGAQUFBwMCMEwGA1UdIARFMEMwNwYJYIZIAYb9bAECMCowKAYIKwYBBQUHAgEW%0AHGh0dHBzOi8vd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwCAYGZ4EMAQIBMH0GCCsGAQUF%0ABwEBBHEwbzAhBggrBgEFBQcwAYYVaHR0cDovL29jc3AuZGNvY3NwLmNuMEoGCCsG%0AAQUFBzAChj5odHRwOi8vY2FjZXJ0cy5kaWdpdGFsY2VydHZhbGlkYXRpb24uY29t%0AL1RydXN0QXNpYVRMU1JTQUNBLmNydDAJBgNVHRMEAjAAMIIBAwYKKwYBBAHWeQIE%0AAgSB9ASB8QDvAHUAu9nfvB%2BKcbWTlCOXqpJ7RzhXlQqrUugakJZkNo4e0YUAAAFp%0A3cON9gAABAMARjBEAiABFpvdLsJKm6zxh5wLS6uN5%2BTnX8bXD5bj7CPVC4Kg/wIg%0AB%2BBzdsZL0UmuvbNAYkr8W53bJKhEgoHJ0RdSyoF5yZAAdgCHdb/nWXz4jEOZX73z%0Abv9WjUdWNv9KtWDBtOr/XqCDDwAAAWndw47mAAAEAwBHMEUCIQC%2BDdvaJ2kKvsVv%0AiivLe4W/YFa/K64HdnyOdHksEl9pSAIgTqLXfw6Tc7d%2BgiKMtt%2B6P/xdrvjGt5Du%0Aokvgu70INuQwDQYJKoZIhvcNAQELBQADggEBAHxewHgySBS5UoO6l/IcU95baR/O%0AYGLcCpgEbWj4MigIZcrkHsD7RddRDoyM/3hxKyzs3Dkes4wHTQDWnyrNuXdn8aNV%0AJAhrh/0yzAe3/UTJ/%2BSRoMg1K6rHWORmLa52d9u3Ei%2B1BF2qLi5L2tTmLrSQJXzB%0ANSIFd40x1mZLp9uqhcB9kcwwkHSFUtLjFwUSN6Zjn9FStlq06ezjgnVv2tP9/HoP%0AKWiRgRFDgqj8%2BROJPQvfuO2xdWoxYUmuMcx1o6IiSVn2F48ood029cyT%2Bt3TaYpb%0AhVI9JuYnHW9kN69xPNzamJVCdu4i/1ELvcr0p/wQf9ax63XsgX4YYhdYgMQ%3D%0A-----END%20CERTIFICATE-----%0A-----BEGIN%20CERTIFICATE-----%0AMIIErjCCA5agAwIBAgIQBYAmfwbylVM0jhwYWl7uLjANBgkqhkiG9w0BAQsFADBh%0AMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3%0Ad3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBD%0AQTAeFw0xNzEyMDgxMjI4MjZaFw0yNzEyMDgxMjI4MjZaMHIxCzAJBgNVBAYTAkNO%0AMSUwIwYDVQQKExxUcnVzdEFzaWEgVGVjaG5vbG9naWVzLCBJbmMuMR0wGwYDVQQL%0AExREb21haW4gVmFsaWRhdGVkIFNTTDEdMBsGA1UEAxMUVHJ1c3RBc2lhIFRMUyBS%0AU0EgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCgWa9X%2Bph%2BwAm8%0AYh1Fk1MjKbQ5QwBOOKVaZR/OfCh%2BF6f93u7vZHGcUU/lvVGgUQnbzJhR1UV2epJa%0Ae%2Bm7cxnXIKdD0/VS9btAgwJszGFvwoqXeaCqFoP71wPmXjjUwLT70%2BqvX4hdyYfO%0AJcjeTz5QKtg8zQwxaK9x4JT9CoOmoVdVhEBAiD3DwR5fFgOHDwwGxdJWVBvktnoA%0AzjdTLXDdbSVC5jZ0u8oq9BiTDv7jAlsB5F8aZgvSZDOQeFrwaOTbKWSEInEhnchK%0AZTD1dz6aBlk1xGEI5PZWAnVAba/ofH33ktymaTDsE6xRDnW97pDkimCRak6CEbfe%0A3dXw6OV5AgMBAAGjggFPMIIBSzAdBgNVHQ4EFgQUf9OZ86BHDjEAVlYijrfMnt3K%0AAYowHwYDVR0jBBgwFoAUA95QNVbRTLtm8KPiGxvDl7I90VUwDgYDVR0PAQH/BAQD%0AAgGGMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjASBgNVHRMBAf8ECDAG%0AAQH/AgEAMDQGCCsGAQUFBwEBBCgwJjAkBggrBgEFBQcwAYYYaHR0cDovL29jc3Au%0AZGlnaWNlcnQuY29tMEIGA1UdHwQ7MDkwN6A1oDOGMWh0dHA6Ly9jcmwzLmRpZ2lj%0AZXJ0LmNvbS9EaWdpQ2VydEdsb2JhbFJvb3RDQS5jcmwwTAYDVR0gBEUwQzA3Bglg%0AhkgBhv1sAQIwKjAoBggrBgEFBQcCARYcaHR0cHM6Ly93d3cuZGlnaWNlcnQuY29t%0AL0NQUzAIBgZngQwBAgEwDQYJKoZIhvcNAQELBQADggEBAK3dVOj5dlv4MzK2i233%0AlDYvyJ3slFY2X2HKTYGte8nbK6i5/fsDImMYihAkp6VaNY/en8WZ5qcrQPVLuJrJ%0ADSXT04NnMeZOQDUoj/NHAmdfCBB/h1bZ5OGK6Sf1h5Yx/5wR4f3TUoPgGlnU7EuP%0AISLNdMRiDrXntcImDAiRvkh5GJuH4YCVE6XEntqaNIgGkRwxKSgnU3Id3iuFbW9F%0AUQ9Qqtb1GX91AJ7i4153TikGgYCdwYkBURD8gSVe8OAco6IfZOYt/TEwii1Ivi1C%0AqnuUlWpsF1LdQNIdfbW3TSe0BhQa7ifbVIfvPWHYOu3rkg1ZeMo6XRU9B4n5VyJY%0ARmE%3D%0A-----END%20CERTIFICATE-----%0A\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"c7bfcad5-3f20-472f-9afc-13a66faebad8\",\n \"CertificateId\": \"cert-xxx\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCertificate\n<公共请求参数>\n\n{\n \"CertificateType\": \"2\",\n \"CertificateAlias\": \"cert-alias\",\n \"CertificateKey\": \"%0A-----BEGIN%20RSA%20PRIVATE%20KEY-----%0Axxxxxxxxxxx%0A-----END%20RSA%20PRIVATE%20KEY-----%0A\",\n \"CertificateContent\": \"%0A-----BEGIN%20CERTIFICATE-----%0AMIIFmDIUJIJL.......C%0A-----END%20CERTIFICATE-----%0A\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"c7bfcad5-3f20-472f-9afc-13a66faebad8\",\n \"CertificateId\": \"cert-jlwr6865\"\n }\n}", "title": "创建证书" }, { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCertificate\n<公共请求参数>\n\n{\n \"CertificateType\": 2,\n \"CertificateAlias\": \"123\",\n \"CertificateKey\": \"-----BEGIN RSA PRIVATE KEY-----\\nMIIEowIBAAKCAQEAn7CUY5bRNtt/YVT9BBDtfyqmF09KXzI+BCrIvrGDrjxRdIsT\\nHs0xZL5EbZXt7uc5leXJ47RnVAQtNMCOuqeYtFWNMzGydVchMkImBHEsATE+ukqs\\n7qUSmbg/BjlOD4hmPNmNz6eljrwMXxNxP0D0BdDMuy+JPLxDp/Hp/Sr3rngL6cbu\\nAvfhnN/l+HvII79KC9D6w8uIyRoAqybaLrP9P+6yXaBFKzdc7o/LanHEAUaxY/Pb\\ndP+3HFGNu5DiUHopFHzjl5Kr2GCWDL9N5VMI36H4UF40wvrjna1BWc8em5zVzais\\nLbj5pZMRTX2KpMfdDluiT/hzPHs1Ex4h0HGUQwIDAQABAoIBAF7K3BsN8N1GiKPH\\nZnYecky1jWhy2ewOj/+7QfTovQkVpyiuUchL99EcnNQMVvQk7+sKP8DaWyflXsxc\\nrZ0hVaVez3WfP5cmBH+oApdKctu2Vs0Q/Pygopz7YPYZ2DuiNUZTwjmNA9rpx9I8\\nYVIyBWjaXF2VRzr1apfsI4D0G5jFm/ugJqeflnJmyV/ZNix1uJvelN2LvxeH/PN5\\nk6IZ14IoKe7PdwlUjy306rwWnej89ofbXmVkzNB87C1Z0rHE4UWaOUu2q5B8Rn8j\\nh+2I8dXwQSXPdbxv6RWFfdcyBci0Y9N7ucmS3zWI+ymQn0sR11Nhv0fOomymUO2+\\nNa02DbkCgYEAzoPxzdaXgda1bMIQrg+M4hZrUeQiy9FA4hJyNqwZsiO3YLA9fZrQ\\nw7ITNCcl5vEEsADz3WqWtx2ZdsFQkvv3z4DNbfeLb6NHHNcnNi4WgdxA1MG8726T\\nTazZHSxY4cZfLdzXU5/Y5AAfhCcBNpU/pGLYPpkhQOB2k3NH7C4jJX0CgYEAxfRC\\nYs1VSRq8j7auV0k3aCOSLaPv9gF+m8sg1zVdV1Emy36/WRetmuXSPonS0Nie7MBl\\nsRwmWgOQZgiTryNKQfnlhMlz2b/ZiaoU1pGVdcKN/aWKBma/KWf9mIx1WyGZdpaH\\ns7zgEqSWjF0ZMB0UljW6m8NUtghjfClO9VcNzL8CgYBRq8CvBNS6Fm19a2opTCEN\\nMIyUwEI6lLCyN1VP5dPrrVBSPqCy0c0J95y8nVbR9DNEX7wRrpuYI26TlnQFDPy9\\n5VRYzvMn3Uy8TSJGvQdNqAtDmLLdhb9fkqHydZ1Y/JibjKDjg23FDX9pRfum2HNo\\n0WZvqyOJgruiKI8jCkQACQKBgDGeHwG67BSt4fO3240/aebte5d7Dwu/pieQy8OF\\nucbILYw2UeoX+EjqMD/CthfpJDS9qP+yyZ4oZIpevf3ZP6S36aLWB/bdkr5h5mU+\\nCpOA16xrUOR33pSXX0ZcdpIIIvpJkuwnfJbPsHiwYT7hGybngsXGOTaDdcRKamMu\\nlePrAoGBAJVaQpEyDwgppuAcv9KTUtiIOLRke/pd0WO20wTkZqMiIfiKjDpASq5c\\nrEzq0M6qYpnmj87wwFpZLLJvMUa9w5KjUpJ+hqBNYywe5/d6laaISFdtYfjoNuLw\\n4BZI/XcA3ZiqzpPqYWBODrEcnCRZKH4C71c7yyATwQL2iWRHoJkY\\n-----END RSA PRIVATE KEY-----\",\n \"CertificateContent\": \"-----BEGIN CERTIFICATE-----\\nMIIDkTCCAnkCCQDOEdu7vXp33jANBgkqhkiG9w0BAQUFADCBhjELMAkGA1UEBhMC\\nQ04xEjAQBgNVBAgMCUd1YW5nRG9uZzELMAkGA1UEBwwCU1oxEDAOBgNVBAoMB3Rl\\nbmNlbnQxDTALBgNVBAsMBGNzaWcxFjAUBgNVBAMMDWNhLmNtMTAwMS5jb20xHTAb\\nBgkqhkiG9w0BCQEWDmNhQHRlbmNlbnQuY29tMB4XDTE5MDcyOTEyMjI1MFoXDTI5\\nMDcyNjEyMjI1MFowgY0xCzAJBgNVBAYTAkNOMRIwEAYDVQQIDAlHdWFuZ0Rvbmcx\\nCzAJBgNVBAcMAlNaMRAwDgYDVQQKDAd0ZW5jZW50MQ0wCwYDVQQLDARjc2lnMRow\\nGAYDVQQDDBF3d3cuY2hyaXN0ZXN0LmNvbTEgMB4GCSqGSIb3DQEJARYRY2hyaXNA\\ndGVuY2VudC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfsJRj\\nltE2239hVP0EEO1/KqYXT0pfMj4EKsi+sYOuPFF0ixMezTFkvkRtle3u5zmV5cnj\\ntGdUBC00wI66p5i0VY0zMbJ1VyEyQiYEcSwBMT66SqzupRKZuD8GOU4PiGY82Y3P\\np6WOvAxfE3E/QPQF0My7L4k8vEOn8en9KveueAvpxu4C9+Gc3+X4e8gjv0oL0PrD\\ny4jJGgCrJtous/0/7rJdoEUrN1zuj8tqccQBRrFj89t0/7ccUY27kOJQeikUfOOX\\nkqvYYJYMv03lUwjfofhQXjTC+uOdrUFZzx6bnNXNqKwtuPmlkxFNfYqkx90OW6JP\\n+HM8ezUTHiHQcZRDAgMBAAEwDQYJKoZIhvcNAQEFBQADggEBAGKJdazyji4aSAAk\\ndcH9/he1RhfkdkBinNQspYWrl7n3+YfX2aCBwkHDTnUUA+HIpUtaWekRqRGHXaKg\\nMjSKOHW715VVR3CMekIRkhQkBMmicaC2YRTpJNOOkehAqeszytDXoICgDc34zkmy\\nVBPRYckYnXE8gwmew1Ogg8PxeC2WgNAQtm/GXmdfe8Wtoy88Ugz8NSV//lIkQJkM\\nzc7+GvWbIsfP7i7Cz8pIMNuJsfrVerbDpbpSSXr6lvTfeCbh9Sq43jpJTbhg2BoU\\nSpnKCvccuOEJnGOwb9WyZ/vrO2JG2RUdglpKh6l5c4+33yOgPqEcGnqMqsDDjAct\\nGjxzvQ4\"\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCertificate\n<公共请求参数>\n\n{\n \"CertificateType\": 2,\n \"CertificateAlias\": \"cert-alias\",\n \"CertificateKey\": \"-----BEGIN RSA PRIVATE KEY-----\\nMIIEowIBAAKCAQEAn7CUY5bRNtt/YVT9BBDtfyqmF09KXzI+BCrIvrGDrjxRdIsT\\nHs0xZL5EbZXt7uc5leXJ47RnVAQtNMCOuqeYtFWNMzGydVchMkImBHEsATE+ukqs\\n7qUSmbg/BjlOD4hmPNmNz6eljrwMXxNxP0D0BdDMuy+JPLxDp/Hp/Sr3rngL6cbu\\nAvfhnN/l+HvII79KC9D6w8uIyRoAqybaLrP9P+6yXaBFKzdc7o/LanHEAUaxY/Pb\\ndP+3HFGNu5DiUHopFHzjl5Kr2GCWDL9N5VMI36H4UF40wvrjna1BWc8em5zVzais\\nLbj5pZMRTX2KpMfdDluiT/hzPHs1Ex4h0HGUQwIDAQABAoIBAF7K3BsN8N1GiKPH\\nZnYecky1jWhy2ewOj/+7QfTovQkVpyiuUchL99EcnNQMVvQk7+sKP8DaWyflXsxc\\nrZ0hVaVez3WfP5cmBH+oApdKctu2Vs0Q/Pygopz7YPYZ2DuiNUZTwjmNA9rpx9I8\\nYVIyBWjaXF2VRzr1apfsI4D0G5jFm/ugJqeflnJmyV/ZNix1uJvelN2LvxeH/PN5\\nk6IZ14IoKe7PdwlUjy306rwWnej89ofbXmVkzNB87C1Z0rHE4UWaOUu2q5B8Rn8j\\nh+2I8dXwQSXPdbxv6RWFfdcyBci0Y9N7ucmS3zWI+ymQn0sR11Nhv0fOomymUO2+\\nNa02DbkCgYEAzoPxzdaXgda1bMIQrg+M4hZrUeQiy9FA4hJyNqwZsiO3YLA9fZrQ\\nw7ITNCcl5vEEsADz3WqWtx2ZdsFQkvv3z4DNbfeLb6NHHNcnNi4WgdxA1MG8726T\\nTazZHSxY4cZfLdzXU5/Y5AAfhCcBNpU/pGLYPpkhQOB2k3NH7C4jJX0CgYEAxfRC\\nYs1VSRq8j7auV0k3aCOSLaPv9gF+m8sg1zVdV1Emy36/WRetmuXSPonS0Nie7MBl\\nsRwmWgOQZgiTryNKQfnlhMlz2b/ZiaoU1pGVdcKN/aWKBma/KWf9mIx1WyGZdpaH\\ns7zgEqSWjF0ZMB0UljW6m8NUtghjfClO9VcNzL8CgYBRq8CvBNS6Fm19a2opTCEN\\nMIyUwEI6lLCyN1VP5dPrrVBSPqCy0c0J95y8nVbR9DNEX7wRrpuYI26TlnQFDPy9\\n5VRYzvMn3Uy8TSJGvQdNqAtDmLLdhb9fkqHydZ1Y/JibjKDjg23FDX9pRfum2HNo\\n0WZvqyOJgruiKI8jCkQACQKBgDGeHwG67BSt4fO3240/aebte5d7Dwu/pieQy8OF\\nucbILYw2UeoX+EjqMD/CthfpJDS9qP+yyZ4oZIpevf3ZP6S36aLWB/bdkr5h5mU+\\nCpOA16xrUOR33pSXX0ZcdpIIIvpJkuwnfJbPsHiwYT7hGybngsXGOTaDdcRKamMu\\nlePrAoGBAJVaQpEyDwgppuAcv9KTUtiIOLRke/pd0WO20wTkZqMiIfiKjDpASq5c\\nrEzq0M6qYpnmj87wwFpZLLJvMUa9w5KjUpJ+hqBNYywe5/d6laaISFdtYfjoNuLw\\n4BZI/XcA3ZiqzpPqYWBODrEcnCRZKH4C71c7yyATwQL2iWRHoJkY\\n-----END RSA PRIVATE KEY-----\",\n \"CertificateContent\": \"-----BEGIN CERTIFICATE-----\\nMIIDkTCCAnkCCQDOEdu7vXp33jANBgkqhkiG9w0BAQUFADCBhjELMAkGA1UEBhMC\\nQ04xEjAQBgNVBAgMCUd1YW5nRG9uZzELMAkGA1UEBwwCU1oxEDAOBgNVBAoMB3Rl\\nbmNlbnQxDTALBgNVBAsMBGNzaWcxFjAUBgNVBAMMDWNhLmNtMTAwMS5jb20xHTAb\\nBgkqhkiG9w0BCQEWDmNhQHRlbmNlbnQuY29tMB4XDTE5MDcyOTEyMjI1MFoXDTI5\\nMDcyNjEyMjI1MFowgY0xCzAJBgNVBAYTAkNOMRIwEAYDVQQIDAlHdWFuZ0Rvbmcx\\nCzAJBgNVBAcMAlNaMRAwDgYDVQQKDAd0ZW5jZW50MQ0wCwYDVQQLDARjc2lnMRow\\nGAYDVQQDDBF3d3cuY2hyaXN0ZXN0LmNvbTEgMB4GCSqGSIb3DQEJARYRY2hyaXNA\\ndGVuY2VudC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfsJRj\\nltE2239hVP0EEO1/KqYXT0pfMj4EKsi+sYOuPFF0ixMezTFkvkRtle3u5zmV5cnj\\ntGdUBC00wI66p5i0VY0zMbJ1VyEyQiYEcSwBMT66SqzupRKZuD8GOU4PiGY82Y3P\\np6WOvAxfE3E/QPQF0My7L4k8vEOn8en9KveueAvpxu4C9+Gc3+X4e8gjv0oL0PrD\\ny4jJGgCrJtous/0/7rJdoEUrN1zuj8tqccQBRrFj89t0/7ccUY27kOJQeikUfOOX\\nkqvYYJYMv03lUwjfofhQXjTC+uOdrUFZzx6bnNXNqKwtuPmlkxFNfYqkx90OW6JP\\n+HM8ezUTHiHQcZRDAgMBAAEwDQYJKoZIhvcNAQEFBQADggEBAGKJdazyji4aSAAk\\ndcH9/he1RhfkdkBinNQspYWrl7n3+YfX2aCBwkHDTnUUA+HIpUtaWekRqRGHXaKg\\nMjSKOHW715VVR3CMekIRkhQkBMmicaC2YRTpJNOOkehAqeszytDXoICgDc34zkmy\\nVBPRYckYnXE8gwmew1Ogg8PxeC2WgNAQtm/GXmdfe8Wtoy88Ugz8NSV//lIkQJkM\\nzc7+GvWbIsfP7i7Cz8pIMNuJsfrVerbDpbpSSXr6lvTfeCbh9Sq43jpJTbhg2BoU\\nSpnKCvccuOEJnGOwb9WyZ/vrO2JG2RUdglpKh6l5c4+33yOgPqEcGnqMqsDDjAct\\nGjxzvQ4\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"bdef4308-69b2-4941-aeeb-9612f2c0cb2a\",\n \"CertificateId\": \"cert-li3tu2id\"\n }\n}", "title": "添加服务器ssl证书" } @@ -95,7 +95,7 @@ "CreateDomain": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDomain\n<公共请求参数>\n\n{\n \"Domain\": \"a.a.com\",\n \"CertificateId\": \"abc\",\n \"ListenerId\": \"0\"\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDomain\n<公共请求参数>\n\n{\n \"Domain\": \"a.a.com\",\n \"CertificateId\": \"cert-lal2lslf\",\n \"ListenerId\": \"0\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"c7bfcad5-3f20-472f-9afc-13a66faebad8\"\n }\n}", "title": "CreateDomain" } @@ -157,7 +157,7 @@ "CreateProxy": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateProxy\n<公共请求参数>\n\n{\n \"ProjectId\": 0,\n \"ProxyName\": \"test\",\n \"AccessRegion\": \"Hongkong\",\n \"Bandwidth\": 10,\n \"Concurrent\": 2,\n \"RealServerRegion\": \"Shanghai\",\n \"TagSet\": [],\n \"BillingType\": 1,\n \"IPAddressVersion\": \"IPv4\",\n \"NetworkType\": \"normal\",\n \"PackageType\": \"Thunder\",\n \"Http3Supported\": 0\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateProxy\n<公共请求参数>\n\n{\n \"ProjectId\": 0,\n \"ProxyName\": \"proxy-name\",\n \"AccessRegion\": \"Hongkong\",\n \"Bandwidth\": 10,\n \"Concurrent\": 2,\n \"RealServerRegion\": \"Shanghai\",\n \"TagSet\": [],\n \"BillingType\": 1,\n \"IPAddressVersion\": \"IPv4\",\n \"NetworkType\": \"normal\",\n \"PackageType\": \"Thunder\",\n \"Http3Supported\": 0\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"db2dd9d4-ba60-48a2-a9ed-cd18c6e58dd0\",\n \"InstanceId\": \"link-nphqtout\"\n }\n}", "title": "创建通道2" } @@ -165,7 +165,7 @@ "CreateProxyGroup": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateProxyGroup\n<公共请求参数>\n\n{\n \"ProjectId\": \"0\",\n \"RealServerRegion\": \"EastChina\",\n \"GroupName\": \"test\"\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateProxyGroup\n<公共请求参数>\n\n{\n \"ProjectId\": \"0\",\n \"RealServerRegion\": \"EastChina\",\n \"GroupName\": \"group-name\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"19a021f8-dff3-4890-8e7a-ed5054e22e49\",\n \"GroupId\": \"lg-negxun2x\"\n }\n}", "title": "创建通道组" }, @@ -227,7 +227,7 @@ "DeleteCertificate": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCertificate\n<公共请求参数>\n\n{\n \"CertificateId\": \"xxxx\"\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCertificate\n<公共请求参数>\n\n{\n \"CertificateId\": \"cert-l2l4l545\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"c7bfcad5-3f20-472f-9afc-13a66faebad8\"\n }\n}", "title": "删除证书" } @@ -316,8 +316,8 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAccessRegions\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"AccessRegionSet\": [\n {\n \"RegionId\": \"abc\",\n \"RegionName\": \"abc\",\n \"RegionArea\": \"abc\",\n \"RegionAreaName\": \"abc\",\n \"IDCType\": \"abc\",\n \"FeatureBitmap\": 1,\n \"SupportFeature\": {\n \"NetworkType\": [\n \"abc\"\n ]\n }\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", - "title": "示例" + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"AccessRegionSet\": [\n {\n \"RegionId\": \"NorthChina\",\n \"RegionName\": \"中国大陆-华北\",\n \"RegionArea\": \"NorthChina\",\n \"RegionAreaName\": \"中国大陆-华北\",\n \"IDCType\": \"dc\",\n \"FeatureBitmap\": 1,\n \"SupportFeature\": {\n \"NetworkType\": [\n \"normal\"\n ]\n }\n }\n ],\n \"RequestId\": \"209e95b9-488d-4a58-bc86-810859577af3\"\n }\n}", + "title": "查询加速区域" } ], "DescribeAccessRegionsByDestRegion": [ @@ -332,7 +332,7 @@ { "document": " ", "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAuthSignature\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"250de15a-35fa-4f3b-9924-25c2b9d9bb1e\"\n }\n}", "title": "查询签名信息" } ], @@ -356,7 +356,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCertificates\n<公共请求参数>\n\n{\n \"CertificateType\": 2,\n \"Limit\": 1,\n \"Offset\": 0\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"35d85baa-eeb8-4eb5-96a9-b6d27f4ff92c\",\n \"CertificateSet\": [\n {\n \"CertificateId\": \"cert-8k1l0pat\",\n \"SubjectCN\": \"lagameft01.xyz\",\n \"CertificateAlias\": \"test\",\n \"CertificateName\": \"test\",\n \"BeginTime\": 1554134400,\n \"CertificateType\": 2,\n \"EndTime\": 1585713600,\n \"CreateTime\": 1564557014,\n \"IssuerCN\": \"TrustAsia TLS RSA CA\"\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"35d85baa-eeb8-4eb5-96a9-b6d27f4ff92c\",\n \"CertificateSet\": [\n {\n \"CertificateId\": \"cert-8k1l0pat\",\n \"SubjectCN\": \"lagameft01.xyz\",\n \"CertificateAlias\": \"alias-name\",\n \"CertificateName\": \"cert-name\",\n \"BeginTime\": 1554134400,\n \"CertificateType\": 2,\n \"EndTime\": 1585713600,\n \"CreateTime\": 1564557014,\n \"IssuerCN\": \"TrustAsia TLS RSA CA\"\n }\n ]\n }\n}", "title": "查询服务器证书信息" } ], @@ -428,7 +428,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGlobalDomains\n<公共请求参数>\n\n{\n \"ProjectId\": 0,\n \"Limit\": 112,\n \"Offset\": 0\n}", - "output": "{\n \"Response\": {\n \"Domains\": [\n {\n \"DomainId\": \"dm-00ye8ek7\",\n \"FullDomain\": \"gd-qbsrvjtf.gaapqcloud.com.cn\",\n \"Alias\": \"abc\",\n \"Type\": \"IP\",\n \"Status\": 0,\n \"ProjectId\": 0,\n \"DefaultValue\": \"192.168.1.2\",\n \"ProxyCount\": 1,\n \"CreateTime\": 1662216195,\n \"UpdateTime\": 1662216195,\n \"TagSet\": [\n {\n \"TagKey\": \"project\",\n \"TagValue\": \"abc\"\n }\n ],\n \"BanStatus\": \"RECOVER\"\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"90955c1c-ef70-40b4-bf3f-74409cf24d60\"\n }\n}", + "output": "{\n \"Response\": {\n \"Domains\": [\n {\n \"DomainId\": \"dm-00ye8ek7\",\n \"FullDomain\": \"gd-qbsrvjtf.gaapqcloud.com.cn\",\n \"Alias\": \"alias-name\",\n \"Type\": \"IP\",\n \"Status\": 0,\n \"ProjectId\": 0,\n \"DefaultValue\": \"192.168.1.2\",\n \"ProxyCount\": 1,\n \"CreateTime\": 1662216195,\n \"UpdateTime\": 1662216195,\n \"TagSet\": [\n {\n \"TagKey\": \"project\",\n \"TagValue\": \"tag-value\"\n }\n ],\n \"BanStatus\": \"RECOVER\"\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"90955c1c-ef70-40b4-bf3f-74409cf24d60\"\n }\n}", "title": "查询域名列表" } ], @@ -452,7 +452,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: xxx.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeHTTPListeners\n<公共请求参数>\n\n{\n \"ProxyId\": \"link-pl5ee4db\",\n \"Limit\": \"20\",\n \"Offset\": \"0\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"3c48a850-4559-4132-8113-d075a235da2d\",\n \"TotalCount\": 1,\n \"ListenerSet\": [\n {\n \"ListenerId\": \"listener-kuwra6qh\",\n \"ListenerName\": \"test\",\n \"Port\": 80,\n \"CreateTime\": 1729568991,\n \"Protocol\": \"HTTP\",\n \"ListenerStatus\": 1,\n \"ProxyId\": \"link-pl5ee4db\",\n \"GroupId\": null\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"3c48a850-4559-4132-8113-d075a235da2d\",\n \"TotalCount\": 1,\n \"ListenerSet\": [\n {\n \"ListenerId\": \"listener-kuwra6qh\",\n \"ListenerName\": \"listener-name\",\n \"Port\": 80,\n \"CreateTime\": 1729568991,\n \"Protocol\": \"HTTP\",\n \"ListenerStatus\": 1,\n \"ProxyId\": \"link-pl5ee4db\",\n \"GroupId\": null\n }\n ]\n }\n}", "title": "查询HTTP监听器信息" } ], @@ -460,7 +460,7 @@ { "document": "查询HTTPS监听器信息", "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeHTTPSListeners\n<公共请求参数>\n\n{\n \"ProxyId\": \"link-n9ha8jzl\",\n \"Limit\": 20,\n \"Offset\": 0\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ListenerSet\": [\n {\n \"ListenerId\": \"abc\",\n \"ListenerName\": \"abc\",\n \"Port\": 1,\n \"Protocol\": \"abc\",\n \"ListenerStatus\": 1,\n \"CertificateId\": \"abc\",\n \"ForwardProtocol\": \"abc\",\n \"CreateTime\": 1,\n \"CertificateAlias\": \"abc\",\n \"ClientCertificateId\": \"abc\",\n \"AuthType\": 0,\n \"ClientCertificateAlias\": \"abc\",\n \"PolyClientCertificateAliasInfo\": [\n {\n \"CertificateId\": \"abc\",\n \"CertificateAlias\": \"abc\"\n }\n ],\n \"Http3Supported\": 0,\n \"ProxyId\": \"abc\",\n \"GroupId\": \"abc\",\n \"TLSSupportVersion\": [\n \"abc\"\n ],\n \"TLSCiphers\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ListenerSet\": [\n {\n \"ListenerId\": \"listener-12345\",\n \"ListenerName\": \"listener-name\",\n \"Port\": 1,\n \"Protocol\": \"TCP\",\n \"ListenerStatus\": 1,\n \"CertificateId\": \"cert-12345\",\n \"ForwardProtocol\": \"TCP\",\n \"CreateTime\": 1,\n \"CertificateAlias\": \"alias-name\",\n \"ClientCertificateId\": \"cert-54321\",\n \"AuthType\": 0,\n \"ClientCertificateAlias\": \"alias-name\",\n \"PolyClientCertificateAliasInfo\": [\n {\n \"CertificateId\": \"cert-12345\",\n \"CertificateAlias\": \"cert-alias\"\n }\n ],\n \"Http3Supported\": 0,\n \"ProxyId\": \"link-12345\",\n \"GroupId\": \"lg-12345\",\n \"TLSSupportVersion\": [\n \"TLSv1.1\"\n ],\n \"TLSCiphers\": \"GAAP_TLS_CIPHERS_WIDE\"\n }\n ],\n \"RequestId\": \"209e95b9-488d-4a58-bc86-810859577af3\"\n }\n}", "title": "查询HTTPS监听器信息" } ], @@ -508,21 +508,15 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProxyDetail\n<公共请求参数>\n\n{\n \"ProxyId\": \"link-4qlu8i3j\"\n}", - "output": "{\n \"Response\": {\n \"ProxyDetail\": {\n \"InstanceId\": \"link-4qlu8i3j\",\n \"CreateTime\": 1728542120,\n \"ProjectId\": 1323575,\n \"ProxyName\": \"test-proxy\",\n \"AccessRegion\": \"Beijing\",\n \"RealServerRegion\": \"Shanghai\",\n \"Bandwidth\": 10,\n \"Concurrent\": 2,\n \"Status\": \"RUNNING\",\n \"Domain\": \"link-4qlu8i3j.gaapqcloud.com.cn\",\n \"IP\": \"43.137.75.190\",\n \"Version\": \"3.0\",\n \"ProxyId\": \"link-4qlu8i3j\",\n \"Scalarable\": 1,\n \"SupportProtocols\": [\n \"TCP\",\n \"UDP\"\n ],\n \"GroupId\": null,\n \"PolicyId\": \"sp-e6on5s9d\",\n \"AccessRegionInfo\": {\n \"RegionId\": \"Beijing\",\n \"RegionName\": \"北京(原中国大陆-华北大区)\",\n \"RegionArea\": \"NorthChina\",\n \"RegionAreaName\": \"NorthChina\",\n \"IDCType\": \"dc\",\n \"FeatureBitmap\": 79,\n \"SupportFeature\": null\n },\n \"RealServerRegionInfo\": {\n \"RegionId\": \"Shanghai\",\n \"RegionName\": \"上海(原中国大陆-华东大区)\",\n \"RegionArea\": \"EastChina\",\n \"RegionAreaName\": \"EastChina\",\n \"IDCType\": \"dc\",\n \"FeatureBitmap\": 79,\n \"SupportFeature\": null\n },\n \"ForwardIP\": \"124.222.42.242;118.25.142.34;\",\n \"TagSet\": [\n {\n \"TagKey\": \"test\",\n \"TagValue\": \"10\"\n }\n ],\n \"SupportSecurity\": 1,\n \"BillingType\": 1,\n \"RelatedGlobalDomains\": [],\n \"ModifyConfigTime\": 1728542120,\n \"ProxyType\": 100,\n \"ClientIPMethod\": [\n 0,\n 1\n ],\n \"IPAddressVersion\": \"IPv4\",\n \"NetworkType\": \"normal\",\n \"PackageType\": \"Thunder\",\n \"BanStatus\": \"RECOVER\",\n \"IPList\": [\n {\n \"IP\": \"43.137.75.190\",\n \"Provider\": \"BGP\",\n \"Bandwidth\": 10\n }\n ],\n \"Http3Supported\": 1,\n \"InBanBlacklist\": 0,\n \"FeatureBitmap\": 71,\n \"IsAutoScaleProxy\": 0,\n \"IsSupportTLSChoice\": 1\n },\n \"RequestId\": \"8d5cae87-74ac-4122-98e8-3aab1f7040b9\"\n }\n}", + "output": "{\n \"Response\": {\n \"ProxyDetail\": {\n \"InstanceId\": \"link-4qlu8i3j\",\n \"CreateTime\": 1728542120,\n \"ProjectId\": 1323575,\n \"ProxyName\": \"test-proxy\",\n \"AccessRegion\": \"Beijing\",\n \"RealServerRegion\": \"Shanghai\",\n \"Bandwidth\": 10,\n \"Concurrent\": 2,\n \"Status\": \"RUNNING\",\n \"Domain\": \"link-4qlu8i3j.gaapqcloud.com.cn\",\n \"IP\": \"43.137.75.190\",\n \"Version\": \"3.0\",\n \"ProxyId\": \"link-4qlu8i3j\",\n \"Scalarable\": 1,\n \"SupportProtocols\": [\n \"TCP\",\n \"UDP\"\n ],\n \"GroupId\": null,\n \"PolicyId\": \"sp-e6on5s9d\",\n \"AccessRegionInfo\": {\n \"RegionId\": \"Beijing\",\n \"RegionName\": \"北京(原中国大陆-华北大区)\",\n \"RegionArea\": \"NorthChina\",\n \"RegionAreaName\": \"NorthChina\",\n \"IDCType\": \"dc\",\n \"FeatureBitmap\": 79,\n \"SupportFeature\": null\n },\n \"RealServerRegionInfo\": {\n \"RegionId\": \"Shanghai\",\n \"RegionName\": \"上海(原中国大陆-华东大区)\",\n \"RegionArea\": \"EastChina\",\n \"RegionAreaName\": \"EastChina\",\n \"IDCType\": \"dc\",\n \"FeatureBitmap\": 79,\n \"SupportFeature\": null\n },\n \"ForwardIP\": \"124.222.42.242;118.25.142.34;\",\n \"TagSet\": [\n {\n \"TagKey\": \"tag-key\",\n \"TagValue\": \"10\"\n }\n ],\n \"SupportSecurity\": 1,\n \"BillingType\": 1,\n \"RelatedGlobalDomains\": [],\n \"ModifyConfigTime\": 1728542120,\n \"ProxyType\": 100,\n \"ClientIPMethod\": [\n 0,\n 1\n ],\n \"IPAddressVersion\": \"IPv4\",\n \"NetworkType\": \"normal\",\n \"PackageType\": \"Thunder\",\n \"BanStatus\": \"RECOVER\",\n \"IPList\": [\n {\n \"IP\": \"43.137.75.190\",\n \"Provider\": \"BGP\",\n \"Bandwidth\": 10\n }\n ],\n \"Http3Supported\": 1,\n \"InBanBlacklist\": 0,\n \"FeatureBitmap\": 71,\n \"IsAutoScaleProxy\": 0,\n \"IsSupportTLSChoice\": 1\n },\n \"RequestId\": \"8d5cae87-74ac-4122-98e8-3aab1f7040b9\"\n }\n}", "title": "查询通道详情" - }, - { - "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProxyDetail\n<公共请求参数>\n\n{\n \"ProxyId\": \"link-4m6fx36h\"\n}", - "output": "{\n \"Response\": {\n \"ProxyDetail\": {\n \"InstanceId\": \"abc\",\n \"CreateTime\": 1,\n \"ProjectId\": 0,\n \"ProxyName\": \"abc\",\n \"AccessRegion\": \"abc\",\n \"RealServerRegion\": \"abc\",\n \"Bandwidth\": 0,\n \"Concurrent\": 0,\n \"Status\": \"abc\",\n \"Domain\": \"abc\",\n \"IP\": \"abc\",\n \"Version\": \"abc\",\n \"ProxyId\": \"abc\",\n \"Scalarable\": 0,\n \"SupportProtocols\": [\n \"abc\"\n ],\n \"GroupId\": \"abc\",\n \"PolicyId\": \"abc\",\n \"AccessRegionInfo\": {\n \"RegionId\": \"abc\",\n \"RegionName\": \"abc\",\n \"RegionArea\": \"abc\",\n \"RegionAreaName\": \"abc\",\n \"IDCType\": \"abc\",\n \"FeatureBitmap\": 1,\n \"SupportFeature\": {\n \"NetworkType\": [\n \"abc\"\n ]\n }\n },\n \"RealServerRegionInfo\": {\n \"RegionId\": \"abc\",\n \"RegionName\": \"abc\",\n \"RegionArea\": \"abc\",\n \"RegionAreaName\": \"abc\",\n \"IDCType\": \"abc\",\n \"FeatureBitmap\": 1,\n \"SupportFeature\": {\n \"NetworkType\": [\n \"abc\"\n ]\n }\n },\n \"ForwardIP\": \"abc\",\n \"TagSet\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"SupportSecurity\": 0,\n \"BillingType\": 0,\n \"RelatedGlobalDomains\": [\n \"abc\"\n ],\n \"ModifyConfigTime\": 1,\n \"ProxyType\": 1,\n \"ClientIPMethod\": [\n 0\n ],\n \"IPAddressVersion\": \"abc\",\n \"NetworkType\": \"abc\",\n \"PackageType\": \"abc\",\n \"BanStatus\": \"abc\",\n \"IPList\": [\n {\n \"IP\": \"abc\",\n \"Provider\": \"abc\",\n \"Bandwidth\": 0\n }\n ],\n \"Http3Supported\": 0,\n \"InBanBlacklist\": 0,\n \"FeatureBitmap\": 0,\n \"IsAutoScaleProxy\": 0,\n \"IsSupportTLSChoice\": 0\n },\n \"RequestId\": \"abc\"\n }\n}", - "title": "查询通道详情2" } ], "DescribeProxyGroupDetails": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProxyGroupDetails\n<公共请求参数>\n\n{\n \"GroupId\": \"lg\"\n}", - "output": "{\n \"Response\": {\n \"ProxyGroupDetail\": {\n \"CreateTime\": 0,\n \"ProjectId\": 0,\n \"ProxyNum\": 0,\n \"Status\": 0,\n \"OwnerUin\": \"abc\",\n \"CreateUin\": \"abc\",\n \"GroupName\": \"abc\",\n \"DnsDefaultIp\": \"abc\",\n \"Domain\": \"abc\",\n \"RealServerRegionInfo\": {\n \"RegionId\": \"abc\",\n \"RegionName\": \"abc\",\n \"RegionArea\": \"abc\",\n \"RegionAreaName\": \"abc\",\n \"IDCType\": \"abc\",\n \"FeatureBitmap\": 1,\n \"SupportFeature\": {\n \"NetworkType\": [\n \"abc\"\n ]\n }\n },\n \"IsOldGroup\": true,\n \"GroupId\": \"abc\",\n \"TagSet\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"PolicyId\": \"abc\",\n \"Version\": \"abc\",\n \"ClientIPMethod\": [\n 0\n ],\n \"IPAddressVersion\": \"abc\",\n \"PackageType\": \"abc\",\n \"Http3Supported\": 0,\n \"FeatureBitmap\": 0,\n \"IsSupportTLSChoice\": 1\n },\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProxyGroupDetails\n<公共请求参数>\n\n{\n \"GroupId\": \"lg-123456\"\n}", + "output": "{\n \"Response\": {\n \"ProxyGroupDetail\": {\n \"CreateTime\": 0,\n \"ProjectId\": 0,\n \"ProxyNum\": 0,\n \"Status\": 0,\n \"OwnerUin\": \"12345678\",\n \"CreateUin\": \"12345678\",\n \"GroupName\": \"grup-name\",\n \"DnsDefaultIp\": \"127.0.0.1\",\n \"Domain\": \"www.domain.com\",\n \"PolicyId\": \"gsp-123456\",\n \"RealServerRegionInfo\": {\n \"RegionId\": \"Beijing\",\n \"RegionName\": \"BEIJING\",\n \"RegionArea\": \"NorthChina\",\n \"RegionAreaName\": \"NorthChina\",\n \"IDCType\": \"dc\",\n \"FeatureBitmap\": 1,\n \"SupportFeature\": {\n \"NetworkType\": [\n \"normal\"\n ]\n }\n },\n \"IsOldGroup\": true,\n \"GroupId\": \"lg-123456\",\n \"TagSet\": [\n {\n \"TagKey\": \"tag_key\",\n \"TagValue\": \"tag_value\"\n }\n ],\n \"Version\": \"3.0\",\n \"ClientIPMethod\": [\n 0\n ],\n \"IPAddressVersion\": \"IPv4\",\n \"PackageType\": \"BGP\",\n \"Http3Supported\": 0,\n \"FeatureBitmap\": 0,\n \"IsSupportTLSChoice\": 1\n },\n \"RequestId\": \"bf46572b-700d-4797-831c-7fcf8232358a\"\n }\n}", "title": "查询通道组详情" } ], @@ -554,7 +548,7 @@ { "document": "查询已绑定源站健康检查统计数据", "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRealServerStatistics\n<公共请求参数>\n\n{\n \"WithinTime\": \"3\",\n \"RealServerId\": \"rs-rfgt56hy\",\n \"ListenerId\": \"listener-gucvb6d\"\n}", - "output": "{\n \"Response\": {\n \"RsStatisticsData\": [\n {\n \"MetricData\": [\n {\n \"Data\": 0.0,\n \"Time\": 1\n },\n {\n \"Data\": 0.0,\n \"Time\": 1\n }\n ],\n \"MetricName\": \"xx\"\n },\n {\n \"MetricData\": [\n {\n \"Data\": 0.0,\n \"Time\": 1\n },\n {\n \"Data\": 0.0,\n \"Time\": 1\n }\n ],\n \"MetricName\": \"xx\"\n }\n ],\n \"RequestId\": \"xx\",\n \"StatisticsData\": [\n {\n \"Data\": 0.0,\n \"Time\": 1\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RsStatisticsData\": [\n {\n \"MetricData\": [\n {\n \"Data\": 0.0,\n \"Time\": 1\n },\n {\n \"Data\": 0.0,\n \"Time\": 1\n }\n ],\n \"MetricName\": \"bandwidth\"\n },\n {\n \"MetricData\": [\n {\n \"Data\": 0.0,\n \"Time\": 1\n },\n {\n \"Data\": 0.0,\n \"Time\": 1\n }\n ],\n \"MetricName\": \"bandwidth\"\n }\n ],\n \"RequestId\": \"hlkjlk4-5435jlk-kjl\",\n \"StatisticsData\": [\n {\n \"Data\": 0.0,\n \"Time\": 1\n }\n ]\n }\n}", "title": "查询已绑定源站健康检查统计数据" } ], @@ -570,7 +564,7 @@ { "document": "查询源站绑定状态", "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRealServersStatus\n<公共请求参数>\n\n{\n \"RealServerIds\": [\n \"rs-4ftghy6\"\n ]\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"xx\",\n \"RealServerStatusSet\": [\n {\n \"ProxyId\": \"xx\",\n \"BindStatus\": 0,\n \"RealServerId\": \"xx\",\n \"GroupId\": \"xx\"\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"dad2a717-3c7d-444d-8f98-0cca9c897ff3\",\n \"RealServerStatusSet\": [\n {\n \"ProxyId\": \"link-123456\",\n \"BindStatus\": 0,\n \"RealServerId\": \"rs-123456\",\n \"GroupId\": \"lg-123456\"\n }\n ]\n }\n}", "title": "查询源站绑定状态" } ], @@ -585,7 +579,7 @@ "DescribeResourcesByTag": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeResourcesByTag\n<公共请求参数>\n\n{\n \"ResourceType\": \"Proxy\",\n \"TagKey\": \"testkey\",\n \"TagValue\": \"test\"\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeResourcesByTag\n<公共请求参数>\n\n{\n \"ResourceType\": \"Proxy\",\n \"TagKey\": \"tag-key\",\n \"TagValue\": \"tag-value\"\n}", "output": "{\n \"Response\": {\n \"ResourceSet\": [\n {\n \"ResourceType\": \"Proxy\",\n \"ResourceId\": \"link-12345678\"\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"5c680029-66b2-4be8-9630-7bd316ce70dd\"\n }\n}", "title": "根据标签拉取资源列表" } @@ -610,7 +604,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRulesByRuleIds\n<公共请求参数>\n\n{\n \"RuleIds\": [\n \"rule-gsy1amjd\"\n ]\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"6f02eb84-5d95-4a1c-b79d-beedfae5fb5e\",\n \"RuleSet\": [\n {\n \"BindStatus\": 1,\n \"CheckParams\": {\n \"ConnectTimeout\": 2,\n \"DelayLoop\": 30,\n \"Domain\": \"baidu.com\",\n \"Method\": \"HEAD\",\n \"Path\": \"/\",\n \"StatusCode\": [\n 100,\n 200,\n 300,\n 400,\n 500\n ]\n },\n \"Domain\": \"baidu.com\",\n \"ForcedRedirect\": null,\n \"ForwardHost\": \"baidu.com\",\n \"HealthCheck\": 0,\n \"ListenerId\": \"listener-qjm2tftd\",\n \"Path\": \"/\",\n \"RealServerSet\": [\n {\n \"DownIPList\": [],\n \"RealServerFailoverRole\": \"\",\n \"RealServerIP\": \"2.5.73.1\",\n \"RealServerId\": \"rs-5y1674pn\",\n \"RealServerPort\": 6363,\n \"RealServerStatus\": 0,\n \"RealServerWeight\": 1\n }\n ],\n \"RealServerType\": \"IP\",\n \"RuleId\": \"rule-gsy1amjd\",\n \"RuleStatus\": 0,\n \"Scheduler\": \"rr\",\n \"ServerNameIndication\": \"\",\n \"ServerNameIndicationSwitch\": \"OFF\"\n }\n ],\n \"TotalCount\": 1\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"6f02eb84-5d95-4a1c-b79d-beedfae5fb5e\",\n \"RuleSet\": [\n {\n \"BindStatus\": 1,\n \"CheckParams\": {\n \"ConnectTimeout\": 2,\n \"DelayLoop\": 30,\n \"Domain\": \"baidu.com\",\n \"Method\": \"HEAD\",\n \"Path\": \"/path\",\n \"StatusCode\": [\n 100,\n 200,\n 300,\n 400,\n 500\n ]\n },\n \"Domain\": \"baidu.com\",\n \"ForcedRedirect\": null,\n \"ForwardHost\": \"baidu.com\",\n \"HealthCheck\": 0,\n \"ListenerId\": \"listener-qjm2tftd\",\n \"Path\": \"/path\",\n \"RealServerSet\": [\n {\n \"DownIPList\": [],\n \"RealServerFailoverRole\": \"\",\n \"RealServerIP\": \"2.5.73.1\",\n \"RealServerId\": \"rs-5y1674pn\",\n \"RealServerPort\": 6363,\n \"RealServerStatus\": 0,\n \"RealServerWeight\": 1\n }\n ],\n \"RealServerType\": \"IP\",\n \"RuleId\": \"rule-gsy1amjd\",\n \"RuleStatus\": 0,\n \"Scheduler\": \"rr\",\n \"ServerNameIndication\": \"\",\n \"ServerNameIndicationSwitch\": \"OFF\"\n }\n ],\n \"TotalCount\": 1\n }\n}", "title": "根据规则ID拉取规则信息列表" } ], @@ -634,7 +628,7 @@ { "document": "查询TCP监听器列表", "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTCPListeners\n<公共请求参数>\n\n{\n \"ProxyId\": \"link-hwera8lq\",\n \"ListenerId\": \"listener-gkzl9e7t\"\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ListenerSet\": [\n {\n \"HealthyThreshold\": 1,\n \"BindStatus\": 1,\n \"SessionPersist\": 1,\n \"RealServerType\": \"IP\",\n \"Protocol\": \"TCP\",\n \"ConnectTimeout\": 1,\n \"RealServerPort\": 1,\n \"HealthCheck\": 1,\n \"ListenerId\": \"listener-gkzl9e7t\",\n \"UnhealthyThreshold\": 1,\n \"ListenerStatus\": 1,\n \"ListenerName\": \"test\",\n \"Scheduler\": \"rr\",\n \"ClientIPMethod\": 1,\n \"FailoverSwitch\": 1,\n \"RealServerSet\": [\n {\n \"RealServerStatus\": 1,\n \"RealServerPort\": 4800,\n \"RealServerId\": \"rs-l694mxlf\",\n \"DownIPList\": [\n \"192.168.1.2:4800\"\n ],\n \"RealServerFailoverRole\": \"\",\n \"RealServerWeight\": 1,\n \"RealServerIP\": \"192.168.1.2\"\n }\n ],\n \"CreateTime\": 1,\n \"Port\": 1,\n \"DelayLoop\": 1,\n \"ProxyId\": \"link-hwera8lq\",\n \"GroupId\": \"\"\n }\n ],\n \"RequestId\": \"dad2a717-3c7d-444d-8f98-0cca9c897ff3\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ListenerSet\": [\n {\n \"HealthyThreshold\": 1,\n \"BindStatus\": 1,\n \"SessionPersist\": 1,\n \"RealServerType\": \"IP\",\n \"Protocol\": \"TCP\",\n \"ConnectTimeout\": 1,\n \"RealServerPort\": 1,\n \"HealthCheck\": 1,\n \"ListenerId\": \"listener-gkzl9e7t\",\n \"UnhealthyThreshold\": 1,\n \"ListenerStatus\": 1,\n \"ListenerName\": \"listener-name\",\n \"Scheduler\": \"rr\",\n \"ClientIPMethod\": 1,\n \"FailoverSwitch\": 1,\n \"RealServerSet\": [\n {\n \"RealServerStatus\": 1,\n \"RealServerPort\": 4800,\n \"RealServerId\": \"rs-l694mxlf\",\n \"DownIPList\": [\n \"192.168.1.2:4800\"\n ],\n \"RealServerFailoverRole\": \"\",\n \"RealServerWeight\": 1,\n \"RealServerIP\": \"192.168.1.2\"\n }\n ],\n \"CreateTime\": 1,\n \"Port\": 1,\n \"DelayLoop\": 1,\n \"ProxyId\": \"link-hwera8lq\",\n \"GroupId\": \"\"\n }\n ],\n \"RequestId\": \"dad2a717-3c7d-444d-8f98-0cca9c897ff3\"\n }\n}", "title": "查询TCP监听器列表" } ], @@ -650,7 +644,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUDPListeners\n<公共请求参数>\n\n{\n \"ProxyId\": \"link-hwera8lq\",\n \"ListenerId\": \"listener-pbsgn7ej\"\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ListenerSet\": [\n {\n \"RecvContext\": \"123\",\n \"RealServerType\": \"IP\",\n \"CheckPort\": 4000,\n \"ListenerId\": \"listener-pbsgn7ej\",\n \"ContextType\": \"TEXT\",\n \"ListenerName\": \"test\",\n \"Port\": 2000,\n \"BindStatus\": 1,\n \"FailoverSwitch\": 0,\n \"CheckType\": \"PORT\",\n \"Scheduler\": \"rr\",\n \"RealServerSet\": [\n {\n \"RealServerStatus\": 0,\n \"RealServerPort\": 5000,\n \"RealServerId\": \"rs-l694mxlf\",\n \"RealServerFailoverRole\": \"master\",\n \"DownIPList\": [\n \"192.168.1.2:5000\"\n ],\n \"RealServerWeight\": 1,\n \"RealServerIP\": \"192.168.1.2\"\n }\n ],\n \"SessionPersist\": 1,\n \"ConnectTimeout\": 2,\n \"SendContext\": \"123\",\n \"HealthCheck\": 1,\n \"HealthyThreshold\": 1,\n \"DelayLoop\": 1,\n \"ListenerStatus\": 0,\n \"Protocol\": \"UDP\",\n \"RealServerPort\": 5000,\n \"UnhealthyThreshold\": 5,\n \"ProxyId\": \"link-nd8l04ev\",\n \"GroupId\": \"\",\n \"CreateTime\": 1723131641\n }\n ],\n \"RequestId\": \"dad2a717-3c7d-444d-8f98-0cca9c897ff3\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ListenerSet\": [\n {\n \"RecvContext\": \"recv_contenxt\",\n \"RealServerType\": \"IP\",\n \"CheckPort\": 4000,\n \"ListenerId\": \"listener-pbsgn7ej\",\n \"ContextType\": \"TEXT\",\n \"ListenerName\": \"listener-name\",\n \"Port\": 2000,\n \"BindStatus\": 1,\n \"FailoverSwitch\": 0,\n \"CheckType\": \"PORT\",\n \"Scheduler\": \"rr\",\n \"RealServerSet\": [\n {\n \"RealServerStatus\": 0,\n \"RealServerPort\": 5000,\n \"RealServerId\": \"rs-l694mxlf\",\n \"RealServerFailoverRole\": \"master\",\n \"DownIPList\": [\n \"192.168.1.2:5000\"\n ],\n \"RealServerWeight\": 1,\n \"RealServerIP\": \"192.168.1.2\"\n }\n ],\n \"SessionPersist\": 1,\n \"ConnectTimeout\": 2,\n \"SendContext\": \"send_context\",\n \"HealthCheck\": 1,\n \"HealthyThreshold\": 1,\n \"DelayLoop\": 1,\n \"ListenerStatus\": 0,\n \"Protocol\": \"UDP\",\n \"RealServerPort\": 5000,\n \"UnhealthyThreshold\": 5,\n \"ProxyId\": \"link-nd8l04ev\",\n \"GroupId\": \"\",\n \"CreateTime\": 1723131641\n }\n ],\n \"RequestId\": \"dad2a717-3c7d-444d-8f98-0cca9c897ff3\"\n }\n}", "title": "查询UDP监听器列表" } ], @@ -697,7 +691,7 @@ "ModifyCertificateAttributes": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCertificateAttributes\n<公共请求参数>\n\n{\n \"CertificateId\": \"cert-kj5pa5lj\",\n \"CertificateAlias\": \"test\"\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCertificateAttributes\n<公共请求参数>\n\n{\n \"CertificateId\": \"cert-kj5pa5lj\",\n \"CertificateAlias\": \"cert-alias\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"c7bfcad5-3f20-472f-9afc-13a66faebad8\"\n }\n}", "title": "修改证书属性" } @@ -713,7 +707,7 @@ "ModifyGlobalDomainAttribute": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyGlobalDomainAttribute\n<公共请求参数>\n\n{\n \"ProjectId\": 0,\n \"DefaultValue\": \"1.1.1.1\",\n \"DomainId\": \"dm-00ye8ek7\",\n \"Alias\": \"test\"\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyGlobalDomainAttribute\n<公共请求参数>\n\n{\n \"ProjectId\": 0,\n \"DefaultValue\": \"1.1.1.1\",\n \"DomainId\": \"dm-00ye8ek7\",\n \"Alias\": \"alias-name\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"19a021f8-dff3-4890-8e7a-ed5054e22e49\"\n }\n}", "title": "修改域名属性" } @@ -735,7 +729,7 @@ "ModifyGroupDomainConfig": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyGroupDomainConfig\n<公共请求参数>\n\n{\n \"DefaultDnsIp\": \"1.1.1.1\",\n \"GroupId\": \"lg-b7h4d02f\",\n \"AccessRegionList\": [\n {\n \"RegionId\": \"111\"\n }\n ]\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyGroupDomainConfig\n<公共请求参数>\n\n{\n \"DefaultDnsIp\": \"1.1.1.1\",\n \"GroupId\": \"lg-b7h4d02f\",\n \"AccessRegionList\": [\n {\n \"RegionId\": \"Beijing\"\n }\n ]\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"74b5f95c-e976-4f78-b2ee-aad49eb844c4\"\n }\n}", "title": "配置通道组就近接入域名" } @@ -759,7 +753,7 @@ "ModifyProxiesAttribute": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyProxiesAttribute\n<公共请求参数>\n\n{\n \"ProxyName\": \"test\",\n \"ProxyIds\": [\n \"link-11113333\",\n \"link-11112222\"\n ]\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyProxiesAttribute\n<公共请求参数>\n\n{\n \"ProxyName\": \"link-name\",\n \"ProxyIds\": [\n \"link-11113333\",\n \"link-11112222\"\n ]\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"04d1af8f-5c76-4053-acbc-62bdf0541c15\"\n }\n}", "title": "修改通道的属性" } @@ -783,7 +777,7 @@ "ModifyProxyGroupAttribute": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyProxyGroupAttribute\n<公共请求参数>\n\n{\n \"GroupName\": \"test\",\n \"GroupId\": \"lg-pheemncl\"\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyProxyGroupAttribute\n<公共请求参数>\n\n{\n \"GroupName\": \"group-name\",\n \"GroupId\": \"lg-pheemncl\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"e26d0984-af79-4403-8c51-11d075b7c1e8\"\n }\n}", "title": "修改通道组名" }, @@ -805,7 +799,7 @@ "ModifyRuleAttribute": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRuleAttribute\n<公共请求参数>\n\n{\n \"ListenerId\": \"listener-0s9kb7qt\",\n \"RuleId\": \"rule-o8aq26zj\",\n \"Path\": \"/\",\n \"ForwardHost\": \"www.baidu.com\",\n \"ForcedRedirect\": \"\",\n \"Scheduler\": \"rr\",\n \"HealthCheck\": 1,\n \"CheckParams\": {\n \"ConnectTimeout\": 2,\n \"DelayLoop\": 30,\n \"FailedThreshold\": 5,\n \"BlockInter\": 600,\n \"Path\": \"/\",\n \"Method\": \"HEAD\",\n \"StatusCode\": [\n 100,\n 200,\n 300,\n 400,\n 500\n ],\n \"FailedCountInter\": 60,\n \"Domain\": \"www.baidu.com\"\n },\n \"ServerNameIndicationSwitch\": \"ON\",\n \"ServerNameIndication\": \"www.baidu.com\"\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRuleAttribute\n<公共请求参数>\n\n{\n \"ListenerId\": \"listener-0s9kb7qt\",\n \"RuleId\": \"rule-o8aq26zj\",\n \"Path\": \"/path\",\n \"ForwardHost\": \"www.baidu.com\",\n \"ForcedRedirect\": \"\",\n \"Scheduler\": \"rr\",\n \"HealthCheck\": 1,\n \"CheckParams\": {\n \"ConnectTimeout\": 2,\n \"DelayLoop\": 30,\n \"FailedThreshold\": 5,\n \"BlockInter\": 600,\n \"Path\": \"/path\",\n \"Method\": \"HEAD\",\n \"StatusCode\": [\n 100,\n 200,\n 300,\n 400,\n 500\n ],\n \"FailedCountInter\": 60,\n \"Domain\": \"www.baidu.com\"\n },\n \"ServerNameIndicationSwitch\": \"ON\",\n \"ServerNameIndication\": \"www.baidu.com\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"c7bfcad5-3f20-472f-9afc-13a66faebad8\"\n }\n}", "title": "修改转发规则信息" } @@ -877,8 +871,8 @@ "SetTlsVersion": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetTlsVersion\n<公共请求参数>\n\n{\n \"ListenerId\": \"abc\",\n \"TLSSupportVersion\": [\n \"TLSv1.2\"\n ],\n \"TLSCiphers\": \"GAAP_TLS_CIPHERS_GENERAL\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"wqdcasdca-da-wedqfc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetTlsVersion\n<公共请求参数>\n\n{\n \"ListenerId\": \"lgl-123456\",\n \"TLSSupportVersion\": [\n \"TLSv1.2\"\n ],\n \"TLSCiphers\": \"GAAP_TLS_CIPHERS_GENERAL\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"dad2a717-3c7d-444d-8f98-0cca9c897ff3\"\n }\n}", "title": "setTls示例" } ] diff --git a/tccli/services/gs/v20191118/api.json b/tccli/services/gs/v20191118/api.json index 181378029f..f93757d7b2 100644 --- a/tccli/services/gs/v20191118/api.json +++ b/tccli/services/gs/v20191118/api.json @@ -221,7 +221,7 @@ { "disabled": false, "document": "游戏相关参数", - "example": "{}", + "example": "{\"Key\": \"Value\"}", "member": "string", "name": "GameContext", "required": false, @@ -395,7 +395,7 @@ { "disabled": false, "document": "唯一用户身份标识,由业务方自定义,平台不予理解。(可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成;在用户重连时应保持UserId不变)", - "example": "123123", + "example": "639d069e-a13a-437a-a10b-64a33ecb8e79", "member": "string", "name": "UserId", "required": true, @@ -503,7 +503,7 @@ { "disabled": false, "document": "唯一用户身份标识,由业务方自定义,平台不予理解。(可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成;在用户重连时应保持UserId不变)", - "example": "123123", + "example": "639d069e-a13a-437a-a10b-64a33ecb8e79", "member": "string", "name": "UserId", "required": true, diff --git a/tccli/services/gs/v20191118/examples.json b/tccli/services/gs/v20191118/examples.json index bd3583924f..e7bc78ae5e 100644 --- a/tccli/services/gs/v20191118/examples.json +++ b/tccli/services/gs/v20191118/examples.json @@ -4,7 +4,7 @@ { "document": "锁定实例后,创建会话,以连接实例", "input": "POST / HTTP/1.1\nHost: gs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSession\n<公共请求参数>\n\n{\n \"GameRegion\": \"字符串型\",\n \"GameId\": \"字符串型\",\n \"UserId\": \"字符串型\",\n \"ClientSession\": \"字符串型\"\n}", - "output": "{\n \"Response\": {\n \"RoleNumber\": \"1\",\n \"ServerSession\": \"abc\",\n \"Role\": \"Player\",\n \"RequestId\": \"req123\"\n }\n}", + "output": "{\n \"Response\": {\n \"RoleNumber\": \"1\",\n \"ServerSession\": \"e30=\",\n \"Role\": \"Player\",\n \"RequestId\": \"req123\"\n }\n}", "title": "CreateSession示例" } ], @@ -27,7 +27,7 @@ "StartPublishStream": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishStream\n<公共请求参数>\n\n{\n \"UserId\": \"123123\",\n \"PublishUrl\": \"rtmp://live.stream.com/publish\"\n}", + "input": "POST / HTTP/1.1\nHost: gs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishStream\n<公共请求参数>\n\n{\n \"UserId\": \"639d069e-a13a-437a-a10b-64a33ecb8e79\",\n \"PublishUrl\": \"rtmp://live.stream.com/publish\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"4eb17e58-68da-4e9a-b298-0894723c9022\"\n }\n}", "title": "开始云端推流" } @@ -51,7 +51,7 @@ "StopPublishStream": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: gs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StopPublishStream\n<公共请求参数>\n\n{\n \"UserId\": \"123123\"\n}", + "input": "POST / HTTP/1.1\nHost: gs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StopPublishStream\n<公共请求参数>\n\n{\n \"UserId\": \"639d069e-a13a-437a-a10b-64a33ecb8e79\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"4eb17e58-68da-4e9a-b298-0894723c9022\"\n }\n}", "title": "停止云端推流" } diff --git a/tccli/services/iai/iai_client.py b/tccli/services/iai/iai_client.py index 1fca26794e..2c8a2eef13 100644 --- a/tccli/services/iai/iai_client.py +++ b/tccli/services/iai/iai_client.py @@ -1163,6 +1163,58 @@ def doGetUpgradeGroupFaceModelVersionJobList(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doDetectFaceSimilarity(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.IaiClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.DetectFaceSimilarityRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.DetectFaceSimilarity(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 doGetGroupInfo(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -1874,6 +1926,7 @@ def doDeleteFace(args, parsed_globals): "CreatePerson": doCreatePerson, "CompareMaskFace": doCompareMaskFace, "GetUpgradeGroupFaceModelVersionJobList": doGetUpgradeGroupFaceModelVersionJobList, + "DetectFaceSimilarity": doDetectFaceSimilarity, "GetGroupInfo": doGetGroupInfo, "DetectFace": doDetectFace, "GetPersonList": doGetPersonList, diff --git a/tccli/services/iai/v20200303/api.json b/tccli/services/iai/v20200303/api.json index 75c90c984f..552987aff7 100644 --- a/tccli/services/iai/v20200303/api.json +++ b/tccli/services/iai/v20200303/api.json @@ -98,6 +98,13 @@ "output": "DetectFaceAttributesResponse", "status": "online" }, + "DetectFaceSimilarity": { + "document": "对两张图片中的人脸进行相似度比对,返回人脸相似度分数。\n\n若您需要判断 “此人是否是某人”,即验证某张图片中的人是否是已知身份的某人,如常见的人脸登录场景,建议使用[人脸验证](https://www.tencentcloud.com/document/product/1059/36972)或[人员验证](https://www.tencentcloud.com/document/product/1059/36971)接口。\n\n> \n- 公共参数中的签名方式请使用V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。", + "input": "DetectFaceSimilarityRequest", + "name": "人脸相似度检测", + "output": "DetectFaceSimilarityResponse", + "status": "online" + }, "DetectLiveFace": { "document": "用于对用户上传的静态图片进行人脸活体检测。与动态活体检测的区别是:静态活体检测中,用户不需要通过唇语或摇头眨眼等动作来识别。\n\n静态活体检测适用于手机自拍的场景,或对防攻击要求不高的场景。如果对活体检测有更高安全性要求,请使用[人脸核身·云智慧眼](https://cloud.tencent.com/product/faceid)产品。\n\n> \n- 图片的宽高比请接近3:4,不符合宽高比的图片返回的分值不具备参考意义。本接口适用于类手机自拍场景,非类手机自拍照返回的分值不具备参考意义。\n\n>\n- 使用过程中建议正对摄像头,不要距离太远,使面部可以完整地显示在识别的框内,识别过程中不要移动设备或遮挡面部。不要选择光线过强或过弱的环境进行面部识别,识别时不要添加任何滤镜。\n\n> \n- 公共参数中的签名方式请使用V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。", "input": "DetectLiveFaceRequest", @@ -1727,6 +1734,79 @@ ], "type": "object" }, + "DetectFaceSimilarityRequest": { + "document": "DetectFaceSimilarity请求参数结构体", + "members": [ + { + "disabled": false, + "document": "A 图片 base64 数据。\n- base64 编码后大小不可超过5M。\n- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。\n- 若图片中包含多张人脸,只选取其中置信度最高的人脸。\n- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。", + "example": "/9j/4AAQSkZJRg.....s97n//2Q==", + "member": "string", + "name": "ImageA", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "B 图片 base64 数据。\n- base64 编码后大小不可超过5M。\n- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。\n- 若图片中包含多张人脸,只选取其中置信度最高的人脸。\n- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。", + "example": "/9j/4AAQSkZJRg.....s97n//2Q==", + "member": "string", + "name": "ImageB", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "A 图片的 Url。\n- 对应图片 base64 编码后大小不可超过5M。\n- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。\n- A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 \n- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 \n- 非腾讯云存储的Url速度和稳定性可能受一定影响。\n- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。\n- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。", + "example": "http://test.image.myqcloud.com/testA.jpg", + "member": "string", + "name": "UrlA", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "B 图片的 Url 。\n- 对应图片 base64 编码后大小不可超过5M。\n- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。\n- B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 \n- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 \n- 非腾讯云存储的Url速度和稳定性可能受一定影响。\n- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。\n- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。", + "example": "http://test.image.myqcloud.com/testB.jpg", + "member": "string", + "name": "UrlB", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "图片质量控制。 \n- 取值范围:\n0: 不进行控制; \n1: 较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况; \n2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况; \n3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况; \n4: 很高的质量要求,各个维度均为最好或最多,在某一维度上存在轻微问题; \n默认 0。 \n\n- 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。", + "example": "0", + "member": "uint64", + "name": "QualityControl", + "required": false, + "type": "int" + } + ], + "type": "object" + }, + "DetectFaceSimilarityResponse": { + "document": "DetectFaceSimilarity返回参数结构体", + "members": [ + { + "disabled": false, + "document": "取值范围 [0.00, 100.00]。\n推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。", + "example": "0.999", + "member": "float", + "name": "Score", + "output_required": true, + "type": "float", + "value_allowed_null": false + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "DetectLiveFaceAccurateRequest": { "document": "DetectLiveFaceAccurate请求参数结构体", "members": [ diff --git a/tccli/services/iai/v20200303/examples.json b/tccli/services/iai/v20200303/examples.json index 59ee243bb7..2ff181fe40 100644 --- a/tccli/services/iai/v20200303/examples.json +++ b/tccli/services/iai/v20200303/examples.json @@ -214,6 +214,20 @@ "title": "人脸检测与属性分析失败示例" } ], + "DetectFaceSimilarity": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CompareFace\n<公共请求参数>\n\n{\n \"UrlA\": \"http://test.image.myqcloud.com/testA.jpg\",\n \"UrlB\": \"http://test.image.myqcloud.com/testB.jpg\"\n}", + "output": "{\n \"Response\": {\n \"Score\": 0.999,\n \"RequestId\": \"a8eb4545-a154-4f86-9510-57a8be9cae0c\"\n }\n}", + "title": "人脸相似度检测接口成功示例" + }, + { + "document": "", + "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CompareFace\n<公共请求参数>\n\n{\n \"UrlA\": \"http://test.image.myqcloud.com/testA.jpg\",\n \"UrlB\": \"http://test.image.myqcloud.com/testB.jpg\"\n}", + "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.FaceQualityNotQualified\",\n \"Message\": \"人脸图片质量不符要求。\"\n },\n \"RequestId\": \"788270e8-91b7-4c59-bd00-1af257b1e482\"\n }\n}", + "title": "人脸相似度检测接口异常示例" + } + ], "DetectLiveFace": [ { "document": "", diff --git a/tccli/services/iotexplorer/v20190423/api.json b/tccli/services/iotexplorer/v20190423/api.json index 29905235df..67da26d691 100644 --- a/tccli/services/iotexplorer/v20190423/api.json +++ b/tccli/services/iotexplorer/v20190423/api.json @@ -13766,6 +13766,16 @@ "output_required": false, "type": "int", "value_allowed_null": true + }, + { + "disabled": false, + "document": "类型", + "example": "1", + "member": "int64", + "name": "PkgType", + "output_required": false, + "type": "int", + "value_allowed_null": false } ], "usage": "out" diff --git a/tccli/services/keewidb/v20220308/api.json b/tccli/services/keewidb/v20220308/api.json index 39a7154c9d..166b000824 100644 --- a/tccli/services/keewidb/v20220308/api.json +++ b/tccli/services/keewidb/v20220308/api.json @@ -328,7 +328,7 @@ "example": "\"2022-03-24 11:52:20\"", "member": "string", "name": "StartTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -338,27 +338,27 @@ "example": "\"999b6b89c60-f01a-11eb-9d37-7d65897b5c22\"", "member": "string", "name": "BackupId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, - "document": "备份类型。<ul><li>1:手动备份,指根据业务运维排障需求,立即执行备份任务的操作。</li> <li>0:自动备份,指根据自动备份策略定时自动发起的备份任务。</li></ul>", + "document": "备份类型。<ul><li>1:手动备份,指根据业务运维排障需求,立即执行备份任务的操作。</li> <li>0:自动备份,指根据自动备份策略定时自动发起的备份任务。</li><li>2:生成RDB,指根据业务需求,发起的生成文件为rdb类型的备份任务。</li></ul>", "example": "\"1\"", "member": "string", "name": "BackupType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "备份的备注信息.", - "example": "\"\"", + "example": "备份测试", "member": "string", "name": "Remark", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -368,7 +368,7 @@ "example": "2", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -378,7 +378,7 @@ "example": "0", "member": "int64", "name": "Locked", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -585,7 +585,7 @@ { "disabled": false, "document": "本次备份的备注信息。", - "example": "xxx", + "example": "备份test", "member": "string", "name": "Remark", "required": false, @@ -612,7 +612,7 @@ "example": "6954227", "member": "int64", "name": "TaskId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -2502,80 +2502,80 @@ { "disabled": false, "document": "策略,ACCEPT或者DROP。", - "example": "无", + "example": "ACCEPT", "member": "string", "name": "Action", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "地址组id代表的地址集合。", - "example": "无", + "example": "set", "member": "string", "name": "AddressModule", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "来源Ip或Ip段,例如192.168.0.0/16。", - "example": "无", + "example": "0.0.0.0/0", "member": "string", "name": "CidrIp", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "描述。", - "example": "无", + "example": "XX上云安全组默认入站规则", "member": "string", "name": "Desc", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "网络协议,支持udp、tcp等。", - "example": "无", + "example": "ALL", "member": "string", "name": "IpProtocol", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "端口。", - "example": "无", + "example": "ALL", "member": "string", "name": "PortRange", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "服务组id代表的协议和端口集合。", - "example": "无", + "example": "keewidb", "member": "string", "name": "ServiceModule", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "安全组id代表的地址集合。", - "example": "无", + "example": "set", "member": "string", "name": "Id", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -2694,7 +2694,7 @@ { "disabled": false, "document": "用户的Appid。", - "example": "12345", + "example": "121100000", "member": "int64", "name": "Appid", "output_required": true, @@ -2834,7 +2834,7 @@ { "disabled": false, "document": "存储引擎。", - "example": "无", + "example": "TendisV2_Storage", "member": "string", "name": "Engine", "output_required": true, @@ -2914,7 +2914,7 @@ { "disabled": false, "document": "反亲和性标签", - "example": "无", + "example": "anti-affinity: \"true\"", "member": "string", "name": "Tags", "output_required": true, @@ -3064,7 +3064,7 @@ { "disabled": false, "document": "内部参数,用户可忽略。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "member": "string", "name": "Vip6", "output_required": true, @@ -3074,7 +3074,7 @@ { "disabled": false, "document": "内部参数,用户可忽略。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "内部参数,用户可忽略。", "member": "string", "name": "RemainBandwidthDuration", "output_required": true, @@ -3200,100 +3200,100 @@ { "disabled": false, "document": "参数名", - "example": "无", + "example": "cluster-node-timeout", "member": "string", "name": "ParamName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数类型:integer", - "example": "无", + "example": "integer", "member": "string", "name": "ValueType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "修改后是否需要重启:true,false", - "example": "无", + "example": "false", "member": "string", "name": "NeedRestart", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数默认值", - "example": "无", + "example": "15000", "member": "string", "name": "DefaultValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "当前运行参数值", - "example": "无", + "example": "15000", "member": "string", "name": "CurrentValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数说明", - "example": "无", + "example": "集群模式下当节点在指定时间内(毫秒)不可达则被认为处于失败状态", "member": "string", "name": "Tips", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数最小值", - "example": "无", + "example": "15000", "member": "string", "name": "Min", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数最大值", - "example": "无", + "example": "120000", "member": "string", "name": "Max", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数状态, 1: 修改中, 2:修改完成", - "example": "无", + "example": "2", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "参数单位\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ms", "member": "string", "name": "Unit", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -3306,80 +3306,80 @@ { "disabled": false, "document": "参数名", - "example": "无", + "example": "cluster-node-timeout", "member": "string", "name": "ParamName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数类型:multi", - "example": "无", + "example": "integer", "member": "string", "name": "ValueType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "修改后是否需要重启:true,false", - "example": "无", + "example": "true", "member": "string", "name": "NeedRestart", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数默认值", - "example": "无", + "example": "15000", "member": "string", "name": "DefaultValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "当前运行参数值", - "example": "无", + "example": "15000", "member": "string", "name": "CurrentValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数说明", - "example": "无", + "example": "Cluster node timeout is the amount of milliseconds a node must be unreachable for it to be considered in failure state", "member": "string", "name": "Tips", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数说明", - "example": "无", + "example": "[\"12000\",\"15000\"]", "member": "string", "name": "EnumValue", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "参数状态, 1: 修改中, 2:修改完成", - "example": "无", + "example": "1", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -3418,22 +3418,20 @@ { "disabled": false, "document": "设置参数的名字", - "example": "无", + "example": "cluster-node-timeout", "member": "string", "name": "Key", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "设置参数的值", - "example": "无", + "example": "15000", "member": "string", "name": "Value", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" } ], "usage": "in" @@ -3444,50 +3442,50 @@ { "disabled": false, "document": "参数名称", - "example": "无", + "example": "cluster-node-timeout", "member": "string", "name": "ParamName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "修改前值", - "example": "无", + "example": "15000", "member": "string", "name": "PreValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "修改后值", - "example": "无", + "example": "16000", "member": "string", "name": "NewValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "状态:1-参数配置修改中;2-参数配置修改成功;3-参数配置修改失败", - "example": "无", + "example": "2", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "修改时间", - "example": "无", + "example": "2024-12-02 10:52:47", "member": "string", "name": "ModifyTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -3500,50 +3498,50 @@ { "disabled": false, "document": "慢查询耗时", - "example": "无", + "example": "524", "member": "int64", "name": "Duration", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "客户端地址", - "example": "无", + "example": "218.89.**.**", "member": "string", "name": "Client", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "命令", - "example": "无", + "example": "zremrangebyscore", "member": "string", "name": "Command", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "详细命令行信息", - "example": "无", + "example": "zremrangebyscore myzset 2 3", "member": "string", "name": "CommandLine", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "执行时间", - "example": "无", + "example": "2024-12-24 18:43:11", "member": "string", "name": "ExecuteTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -3582,80 +3580,80 @@ { "disabled": false, "document": "参数名", - "example": "无", + "example": "slowlog-max-len", "member": "string", "name": "ParamName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数类型:text", - "example": "无", + "example": "text", "member": "string", "name": "ValueType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "修改后是否需要重启:true,false", - "example": "无", + "example": "true", "member": "string", "name": "NeedRestart", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数默认值", - "example": "无", + "example": "128", "member": "string", "name": "DefaultValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "当前运行参数值", - "example": "无", + "example": "128", "member": "string", "name": "CurrentValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数说明", - "example": "无", + "example": "Cluster node timeout is the amount of milliseconds a node must be unreachable for it to be considered in failure state", "member": "string", "name": "Tips", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "参数可取值", - "example": "无", + "example": "0-1024", "member": "string", "name": "TextValue", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "参数状态, 1: 修改中, 2:修改完成", - "example": "无", + "example": "2", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -4231,80 +4229,80 @@ { "disabled": false, "document": "策略,ACCEPT或者DROP。", - "example": "无", + "example": "DROP", "member": "string", "name": "Action", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "地址组id代表的地址集合。", - "example": "无", + "example": "set", "member": "string", "name": "AddressModule", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "来源Ip或Ip段,例如192.168.0.0/16。", - "example": "无", + "example": "9.9.0.0/16", "member": "string", "name": "CidrIp", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "描述。", - "example": "无", + "example": "**上云安全组默认入站规则", "member": "string", "name": "Desc", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "网络协议,支持udp、tcp等。", - "example": "无", + "example": "ALL", "member": "string", "name": "IpProtocol", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "端口。", - "example": "无", + "example": "6379", "member": "string", "name": "PortRange", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "服务组id代表的协议和端口集合。", - "example": "无", + "example": "keewidb", "member": "string", "name": "ServiceModule", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "安全组id代表的地址集合。", - "example": "无", + "example": "set", "member": "string", "name": "Id", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -4413,10 +4411,10 @@ { "disabled": false, "document": "节点ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "c70aa82ff684f36f8fe8b7c61cb77e568**********", "member": "string", "name": "NodeId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -4576,40 +4574,40 @@ { "disabled": false, "document": "节点 ID。", - "example": "无", + "example": "125101", "member": "int64", "name": "GroupId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "节点组的名称,主节点为空。", - "example": "无", + "example": "ng-1", "member": "string", "name": "GroupName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "节点的可用区ID,比如ap-guangzhou-1。", - "example": "无", + "example": "ap-guangzhou-1", "member": "string", "name": "ZoneId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "节点组角色。<ul><li>master:为主节点。</li><li>replica:为副本节点。</li></ul>", - "example": "无", + "example": "master", "member": "string", "name": "Role", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -4619,7 +4617,7 @@ "example": "无", "member": "KeeWiDBNode", "name": "KeeWiDBNodes", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -4713,50 +4711,50 @@ { "disabled": false, "document": "创建时间,时间格式:yyyy-mm-dd hh:mm:ss。", - "example": "无", + "example": "2019-09-05 14:52:30", "member": "string", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "项目ID。", - "example": "无", + "example": "11100", "member": "uint64", "name": "ProjectId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "安全组ID。", - "example": "无", + "example": "sg-ep0g9***", "member": "string", "name": "SecurityGroupId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "安全组名称。", - "example": "无", + "example": "安全组名称-放开外网", "member": "string", "name": "SecurityGroupName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "安全组备注。", - "example": "无", + "example": "禁止使用-有安全风险", "member": "string", "name": "SecurityGroupRemark", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -4766,7 +4764,7 @@ "example": "无", "member": "Outbound", "name": "Outbound", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -4776,7 +4774,7 @@ "example": "无", "member": "Inbound", "name": "Inbound", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -4819,7 +4817,7 @@ "example": "16481", "member": "int64", "name": "TaskId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -4829,17 +4827,17 @@ "example": "2022-03-12 15:06:23", "member": "string", "name": "StartTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "任务类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "FLOW_BACKUPINSTANCE", "member": "string", "name": "TaskType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -4849,7 +4847,7 @@ "example": "实例1", "member": "string", "name": "InstanceName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -4859,7 +4857,7 @@ "example": "kee-4hyqewjs", "member": "string", "name": "InstanceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -4869,7 +4867,7 @@ "example": "0", "member": "int64", "name": "ProjectId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -4879,7 +4877,7 @@ "example": "0", "member": "float", "name": "Progress", - "required": true, + "output_required": true, "type": "float", "value_allowed_null": true }, @@ -4889,7 +4887,7 @@ "example": "2022-03-12 15:08:23", "member": "string", "name": "EndTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -4899,7 +4897,7 @@ "example": "0", "member": "int64", "name": "Result", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -4909,7 +4907,7 @@ "example": "10112432xxx", "member": "string", "name": "OperatorUin", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -4922,50 +4920,50 @@ { "disabled": false, "document": "执行时间", - "example": "无", + "example": "2024-12-25 13:43:08", "member": "string", "name": "ExecuteTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "慢查询耗时(毫秒)", - "example": "无", + "example": "197", "member": "int64", "name": "Duration", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "命令", - "example": "无", + "example": "ZADD", "member": "string", "name": "Command", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "详细命令行信息", - "example": "无", + "example": "ZADD students 95 \"Alice\"", "member": "string", "name": "CommandLine", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "节点ID", - "example": "无", + "example": "6fd96ca18603e1fd05c48ec6f99a69cc89******", "member": "string", "name": "Node", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -4978,20 +4976,20 @@ { "disabled": false, "document": "订单号ID,调用云API时使用此ID\t", - "example": "无", + "example": "192314****", "member": "string", "name": "DealId", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "长订单ID,反馈订单问题给官方客服使用此ID\t", - "example": "无", + "example": "2024112**", "member": "string", "name": "DealName", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -5001,7 +4999,7 @@ "example": "100002", "member": "int64", "name": "ZoneId", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -5011,47 +5009,47 @@ "example": "1", "member": "int64", "name": "GoodsNum", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "创建用户uin", - "example": "无", + "example": "10001464****", "member": "string", "name": "Creater", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "订单创建时间", - "example": "无", + "example": "2024-11-25 18:12:34", "member": "string", "name": "CreatTime", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "订单超时时间", - "example": "无", + "example": "2024-12-10 18:12:34", "member": "string", "name": "OverdueTime", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "订单完成时间", - "example": "无", + "example": "2024-11-25 18:30:34", "member": "string", "name": "EndTime", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -5061,37 +5059,37 @@ "example": "4", "member": "int64", "name": "Status", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "订单状态描述", - "example": "无", + "example": "发货中", "member": "string", "name": "Description", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "订单实际总价,单位:分", - "example": "无", + "example": "1039", "member": "float", "name": "Price", - "required": false, + "output_required": true, "type": "float", "value_allowed_null": false }, { "disabled": false, "document": "实例ID", - "example": "无", + "example": "100035***,100036***", "member": "string", "name": "InstanceIds", - "required": false, + "output_required": true, "type": "list", "value_allowed_null": false } diff --git a/tccli/services/live/v20180801/api.json b/tccli/services/live/v20180801/api.json index a68b6293bb..19e5413962 100644 --- a/tccli/services/live/v20180801/api.json +++ b/tccli/services/live/v20180801/api.json @@ -1792,7 +1792,7 @@ { "disabled": false, "document": "水印ID。", - "example": "123", + "example": "854214", "member": "uint64", "name": "WatermarkId", "output_required": true, @@ -1814,7 +1814,7 @@ { "disabled": false, "document": "要验证的域名。", - "example": "xxx.com", + "example": "foodscloud.com", "member": "string", "name": "DomainName", "required": true, @@ -1838,30 +1838,30 @@ { "disabled": false, "document": "验证内容。\nVerifyType 传 dnsCheck 时,为要配的 TXT 记录值。\nVerifyType 传 fileCheck 时,为文件内容。", - "example": "无", + "example": "cssauth_b2fe08b85b975844fd7ff34", "member": "string", "name": "Content", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "域名验证状态。\n>=0 为已验证归属。\n<0 未验证归属权。", - "example": "无", + "example": "4", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "DomainName 对应的主域名。\n同一主域名下的所有域名只需成功验证一次,后续均无需再验证。", - "example": "无", + "example": "foodscloud.com", "member": "string", "name": "MainDomain", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -3971,7 +3971,7 @@ { "disabled": false, "document": "导播台ID", - "example": "1001", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -4469,7 +4469,7 @@ { "disabled": false, "document": "描述信息。\n长度上限:1024字节。\n仅支持中文、英文、数字、_、-。", - "example": "test", + "example": "callback", "member": "string", "name": "Description", "required": false, @@ -4478,7 +4478,7 @@ { "disabled": false, "document": "开播回调 URL,\n相关协议文档:[事件消息通知](/document/product/267/32744)。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "StreamBeginNotifyUrl", "required": false, @@ -4487,7 +4487,7 @@ { "disabled": false, "document": "断流回调 URL,\n相关协议文档:[事件消息通知](/document/product/267/32744)。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "StreamEndNotifyUrl", "required": false, @@ -4496,7 +4496,7 @@ { "disabled": false, "document": "录制文件回调 URL,\n相关协议文档:[事件消息通知](/document/product/267/32744)。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "RecordNotifyUrl", "required": false, @@ -4505,7 +4505,7 @@ { "disabled": false, "document": "录制状态回调 URL ,\n相关协议文档:[事件消息通知](/document/product/267/32744)。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "RecordStatusNotifyUrl", "required": false, @@ -4514,7 +4514,7 @@ { "disabled": false, "document": "截图回调 URL,\n相关协议文档:[事件消息通知](/document/product/267/32744)。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "SnapshotNotifyUrl", "required": false, @@ -4523,7 +4523,7 @@ { "disabled": false, "document": "鉴黄回调 URL ,\n相关协议文档:[事件消息通知](/document/product/267/32741)。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "PornCensorshipNotifyUrl", "required": false, @@ -4559,7 +4559,7 @@ { "disabled": false, "document": "音频审核回调 URL。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "AudioAuditNotifyUrl", "required": false, @@ -4605,7 +4605,7 @@ { "disabled": false, "document": "模板 ID。", - "example": "123", + "example": "8945241", "member": "int64", "name": "TemplateId", "required": true, @@ -4713,7 +4713,7 @@ "example": "1000", "member": "int64", "name": "TemplateId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -5120,7 +5120,7 @@ { "disabled": false, "document": "模板 ID。", - "example": "123", + "example": "47526", "member": "int64", "name": "TemplateId", "required": true, @@ -5138,7 +5138,7 @@ { "disabled": false, "document": "流名称。\n注:如果本参数设置为非空字符串,规则将只对此推流起作用。", - "example": "s", + "example": "stream1", "member": "string", "name": "StreamName", "required": false, @@ -5174,7 +5174,7 @@ { "disabled": false, "document": "描述信息。", - "example": "test", + "example": "录制规则", "member": "string", "name": "Description", "required": false, @@ -5364,7 +5364,7 @@ { "disabled": false, "document": "Cos 应用 ID。", - "example": "123", + "example": "9654125", "member": "int64", "name": "CosAppId", "required": true, @@ -5445,7 +5445,7 @@ { "disabled": false, "document": "Cos 文件名称。\n如不传,实际按默认值\n{StreamID}-screenshot-{Hour}-{Minute}-{Second}-{Width}x{Height}{Ext}\n生效", - "example": "abc", + "example": "{StreamID}-screenshot-{Hour}-{Minute}-{Second}-{Width}x{Height}{Ext}", "member": "string", "name": "CosFileName", "required": false, @@ -5463,6 +5463,7 @@ "example": "1000", "member": "int64", "name": "TemplateId", + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -5594,6 +5595,24 @@ "name": "AiQualityControl", "required": false, "type": "int" + }, + { + "disabled": false, + "document": "导播台监播对应的导播台场次id。", + "example": "\"101\"", + "member": "string", + "name": "CasterId", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "拉流转推监播任务对应的拉流转推场次id", + "example": "“xxxx”", + "member": "string", + "name": "PullPushTaskId", + "required": false, + "type": "string" } ], "type": "object" @@ -5603,13 +5622,13 @@ "members": [ { "disabled": false, - "document": "监播任务ID。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "监播任务ID。", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "member": "string", "name": "MonitorId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -5653,7 +5672,7 @@ { "disabled": false, "document": "模板 ID。", - "example": "123", + "example": "458925", "member": "int64", "name": "TemplateId", "required": true, @@ -5825,7 +5844,7 @@ { "disabled": false, "document": "模板名称,例: 900p 仅支持字母和数字的组合。\n长度限制:\n 标准转码:1-10个字符\n 极速高清转码:3-10个字符", - "example": "无", + "example": "900p", "member": "string", "name": "TemplateName", "required": true, @@ -5834,7 +5853,7 @@ { "disabled": false, "document": "视频码率。范围:0kbps - 8000kbps。\n0为保持原始码率。\n注: 转码模板有码率唯一要求,最终保存的码率可能与输入码率有所差别。", - "example": "无", + "example": "0", "member": "int64", "name": "VideoBitrate", "required": true, @@ -5843,7 +5862,7 @@ { "disabled": false, "document": "音频编码:aac,默认aac。\n注意:当前该参数未生效,待后续支持!", - "example": "无", + "example": "aac", "member": "string", "name": "Acodec", "required": false, @@ -5852,7 +5871,7 @@ { "disabled": false, "document": "音频码率,默认0。\n范围:0-500。", - "example": "无", + "example": "0", "member": "int64", "name": "AudioBitrate", "required": false, @@ -5861,7 +5880,7 @@ { "disabled": false, "document": "视频编码:h264/h265/origin,默认origin。\n\norigin: 保持原始编码格式", - "example": "无", + "example": "h264", "member": "string", "name": "Vcodec", "required": false, @@ -5870,7 +5889,7 @@ { "disabled": false, "document": "模板描述。", - "example": "无", + "example": "transcode", "member": "string", "name": "Description", "required": false, @@ -5879,7 +5898,7 @@ { "disabled": false, "document": "是否保留视频,0:否,1:是。默认1。", - "example": "无", + "example": "0", "member": "int64", "name": "NeedVideo", "required": false, @@ -5888,7 +5907,7 @@ { "disabled": false, "document": "宽,默认0。\n范围[0-3000]\n数值必须是2的倍数,0是原始宽度", - "example": "无", + "example": "0", "member": "int64", "name": "Width", "required": false, @@ -5897,7 +5916,7 @@ { "disabled": false, "document": "是否保留音频,0:否,1:是。默认1。", - "example": "无", + "example": "0", "member": "int64", "name": "NeedAudio", "required": false, @@ -5906,7 +5925,7 @@ { "disabled": false, "document": "高,默认0。\n范围[0-3000]\n数值必须是2的倍数,0是原始高度。\n极速高清模板(AiTransCode = 1 的时候)必须传。", - "example": "无", + "example": "0", "member": "int64", "name": "Height", "required": false, @@ -5915,7 +5934,7 @@ { "disabled": false, "document": "帧率,默认0。\n范围0-60fps", - "example": "无", + "example": "0", "member": "int64", "name": "Fps", "required": false, @@ -5924,7 +5943,7 @@ { "disabled": false, "document": "关键帧间隔,单位:秒。\n默认原始的间隔\n范围2-6", - "example": "无", + "example": "2", "member": "int64", "name": "Gop", "required": false, @@ -5933,7 +5952,7 @@ { "disabled": false, "document": "旋转角度,默认0。\n可取值:0,90,180,270", - "example": "无", + "example": "0", "member": "int64", "name": "Rotate", "required": false, @@ -5942,7 +5961,7 @@ { "disabled": false, "document": "编码质量:\nbaseline/main/high。默认baseline", - "example": "无", + "example": "baseline", "member": "string", "name": "Profile", "required": false, @@ -5951,7 +5970,7 @@ { "disabled": false, "document": "当设置的码率>原始码率时,是否以原始码率为准。\n0:否, 1:是\n默认 0。", - "example": "无", + "example": "0", "member": "int64", "name": "BitrateToOrig", "required": false, @@ -5960,7 +5979,7 @@ { "disabled": false, "document": "当设置的高度>原始高度时,是否以原始高度为准。\n0:否, 1:是\n默认 0。", - "example": "无", + "example": "0", "member": "int64", "name": "HeightToOrig", "required": false, @@ -5969,7 +5988,7 @@ { "disabled": false, "document": "当设置的帧率>原始帧率时,是否以原始帧率为准。\n0:否, 1:是\n默认 0。", - "example": "无", + "example": "0", "member": "int64", "name": "FpsToOrig", "required": false, @@ -5978,7 +5997,7 @@ { "disabled": false, "document": "是否是极速高清模板,0:否,1:是。默认0。", - "example": "无", + "example": "0", "member": "int64", "name": "AiTransCode", "required": false, @@ -5987,7 +6006,7 @@ { "disabled": false, "document": "极速高清视频码率压缩比。\n极速高清目标码率=VideoBitrate * (1-AdaptBitratePercent)\n\n取值范围:0.0到0.5", - "example": "无", + "example": "0.0", "member": "float", "name": "AdaptBitratePercent", "required": false, @@ -5996,7 +6015,7 @@ { "disabled": false, "document": "是否以短边作为高度,0:否,1:是。默认0。", - "example": "无", + "example": "0", "member": "int64", "name": "ShortEdgeAsHeight", "required": false, @@ -6029,7 +6048,7 @@ { "disabled": false, "document": "模板Id。", - "example": "无", + "example": "459625", "member": "int64", "name": "TemplateId", "output_required": true, @@ -6250,7 +6269,7 @@ { "disabled": false, "document": "扩展字段,暂无定义。默认为空。", - "example": "\"\"", + "example": "extension", "member": "string", "name": "Extension", "required": false, @@ -6350,7 +6369,7 @@ { "disabled": false, "document": "扩展字段,暂无定义。默认为空。", - "example": "\"\"", + "example": "extension", "member": "string", "name": "Extension", "required": false, @@ -6519,7 +6538,7 @@ { "disabled": false, "document": "导播台ID", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -6555,7 +6574,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -6591,7 +6610,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -6627,7 +6646,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -6663,7 +6682,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -6699,7 +6718,7 @@ { "disabled": false, "document": "待删除的导播台ID", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -7311,7 +7330,7 @@ { "disabled": false, "document": "水印 ID。\n在添加水印接口 [AddLiveWatermark](/document/product/267/30154) 调用返回值中获取水印 ID。\n或DescribeLiveWatermarks接口返回的水印ID。", - "example": "", + "example": "43527", "member": "int64", "name": "WatermarkId", "required": true, @@ -7884,7 +7903,7 @@ { "disabled": false, "document": "导播台ID", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -7898,43 +7917,43 @@ "members": [ { "disabled": false, - "document": "导播台状态\n0:停止状态,无预监,无主监 \n1:无预监,有主监 \n2:有预监,无主监 \n3:有预监,有主监\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "导播台状态\n0:停止状态,无预监,无主监 \n1:无预监,有主监 \n2:有预监,无主监 \n3:有预监,有主监", "example": "1", "member": "uint64", "name": "Status", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "预监使用的展示参数。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "预监使用的展示参数。", "example": "无", "member": "CasterDisplayInfo", "name": "PvwDisplayInfo", "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "主监使用的展示参数。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "主监使用的展示参数。", "example": "无", "member": "CasterDisplayInfo", "name": "PgmDisplayInfo", "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "启动直播的时间,值为unix时间戳。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "启动直播的时间,值为unix时间戳。", "example": "1670309219", "member": "uint64", "name": "StartLiveTime", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -7951,7 +7970,7 @@ { "disabled": false, "document": "导播台ID", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -7988,7 +8007,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -8029,13 +8048,13 @@ "members": [ { "disabled": false, - "document": "用户对应的导播台简要信息列表\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "用户对应的导播台简要信息列表", "example": "无", "member": "CasterBriefInfo", "name": "CasterList", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -8052,7 +8071,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -8066,13 +8085,13 @@ "members": [ { "disabled": false, - "document": "导播台的水印信息列表。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "导播台的水印信息列表。", "example": "无", "member": "CasterMarkPicInfo", "name": "MarkPicInfos", "output_required": false, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -8089,7 +8108,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -8103,13 +8122,13 @@ "members": [ { "disabled": false, - "document": "导播台的文本信息列表。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "导播台的文本信息列表。", "example": "无", "member": "CasterMarkWordInfo", "name": "MarkWordInfos", "output_required": false, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -8126,7 +8145,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -8140,13 +8159,13 @@ "members": [ { "disabled": false, - "document": "导播台的推流信息列表。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "导播台的推流信息列表。", "example": "无", "member": "CasterOutputInfo", "name": "OutputInfos", "output_required": false, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -8163,7 +8182,7 @@ { "disabled": false, "document": "导播台ID", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -8195,23 +8214,23 @@ "members": [ { "disabled": false, - "document": "播放url。\n当导播台不存在预监或主监时,若请求预监或主监的播放地址,该字段为空。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "播放url。\n当导播台不存在预监或主监时,若请求预监或主监的播放地址,该字段为空。", "example": "http://www.example/live/test.flv", "member": "string", "name": "PlayUrl", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "webrtc协议播放地址。\n当导播台不存在预监或主监时,若请求预监或主监的webrtc播放地址,该字段为空。\n注:webrtc协议播放地址需配合腾讯云快直播播放sdk方可使用。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "webrtc协议播放地址。\n当导播台不存在预监或主监时,若请求预监或主监的webrtc播放地址,该字段为空。\n注:webrtc协议播放地址需配合腾讯云快直播播放sdk方可使用。", "example": "webrtc://webrtc.domain.com/live/test", "member": "string", "name": "WebRTCPlayUrl", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -8228,7 +8247,7 @@ { "disabled": false, "document": "需查询的导播台ID", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -8265,7 +8284,7 @@ { "disabled": false, "document": "导播台ID", - "example": "10", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -8279,13 +8298,13 @@ "members": [ { "disabled": false, - "document": "转场信息列表\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "转场信息列表", "example": "无", "member": "TransitionTypeInfo", "name": "TransitionTypes", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -8664,7 +8683,7 @@ "example": "无", "member": "CallBackTemplateInfo", "name": "Template", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -8691,7 +8710,7 @@ "example": "无", "member": "CallBackTemplateInfo", "name": "Templates", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -8725,7 +8744,7 @@ { "disabled": false, "document": "证书信息。", - "example": "{}", + "example": "无", "member": "CertInfo", "name": "CertInfo", "output_required": true, @@ -8752,7 +8771,7 @@ { "disabled": false, "document": "证书信息列表。", - "example": "{}", + "example": "无", "member": "CertInfo", "name": "CertInfoSet", "output_required": true, @@ -8801,7 +8820,7 @@ { "disabled": false, "document": "要搜索的域名字符串。", - "example": "无", + "example": "pull", "member": "string", "name": "DomainSearch", "required": false, @@ -8810,7 +8829,7 @@ { "disabled": false, "document": "记录行的位置,从0开始。默认0。", - "example": "无", + "example": "0", "member": "int64", "name": "Offset", "required": false, @@ -8819,7 +8838,7 @@ { "disabled": false, "document": "记录行的最大数目。默认50。\n若不传,则最多返回50条数据。", - "example": "无", + "example": "10", "member": "int64", "name": "Length", "required": false, @@ -8828,7 +8847,7 @@ { "disabled": false, "document": "要查询的单个域名。", - "example": "无", + "example": "pull.sdzgxx.cn", "member": "string", "name": "DomainName", "required": false, @@ -8837,7 +8856,7 @@ { "disabled": false, "document": "可取值:\nExpireTimeAsc:证书过期时间升序。\nExpireTimeDesc:证书过期时间降序。", - "example": "无", + "example": "ExpireTimeAsc", "member": "string", "name": "OrderBy", "required": false, @@ -8855,7 +8874,7 @@ "example": "无", "member": "LiveDomainCertBindings", "name": "LiveDomainCertBindings", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -8865,7 +8884,7 @@ "example": "122", "member": "int64", "name": "TotalNum", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -8884,7 +8903,7 @@ { "disabled": false, "document": "播放域名。", - "example": "", + "example": "5000.liveplay.com", "member": "string", "name": "DomainName", "required": true, @@ -8899,9 +8918,10 @@ { "disabled": false, "document": "证书信息。", - "example": "", + "example": "无", "member": "DomainCertInfo", "name": "DomainCertInfo", + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -9044,7 +9064,7 @@ { "disabled": false, "document": "域名。", - "example": "", + "example": "domain.com", "member": "string", "name": "DomainName", "required": true, @@ -9058,12 +9078,13 @@ "members": [ { "disabled": false, - "document": "域名信息。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "document": "域名信息。", + "example": "无", "member": "DomainInfo", "name": "DomainInfo", + "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -9159,7 +9180,7 @@ { "disabled": false, "document": "域名详细信息列表。", - "example": "无", + "example": "[{\"Name\":\"mudu.tv\",\"GroupName\":null,\"Type\":1,\"Status\":1,\"PlayType\":1,\"IsDelayLive\":0}]", "member": "DomainInfo", "name": "DomainList", "output_required": true, @@ -9168,23 +9189,23 @@ }, { "disabled": false, - "document": "可继续添加域名数量。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "可继续添加域名数量。", "example": "77", "member": "int64", "name": "CreateLimitCount", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "启用的播放域名加速区域统计,数组元素分别为:中国大陆(境内),全球地区,国际/港澳台(境外)域名数量。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "启用的播放域名加速区域统计,数组元素分别为:中国大陆(境内),全球地区,国际/港澳台(境外)域名数量。", "example": "[1,0,3]", "member": "int64", "name": "PlayTypeCount", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -9428,23 +9449,23 @@ "members": [ { "disabled": false, - "document": "套餐包信息。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "document": "套餐包信息。", + "example": "无", "member": "LivePackageInfo", "name": "LivePackageInfoList", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "套餐包当前计费方式:\n-1: 无计费方式或获取失败\n0: 无计费方式\n201: 月结带宽\n202: 月结流量\n203: 日结带宽\n204: 日结流量\n205: 日结时长\n206: 月结时长\n304: 日结流量。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "套餐包当前计费方式:\n-1: 无计费方式或获取失败\n0: 无计费方式\n201: 月结带宽\n202: 月结流量\n203: 日结带宽\n204: 日结流量\n205: 日结时长\n206: 月结时长\n304: 日结流量。", "example": "201", "member": "int64", "name": "PackageBillMode", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -9488,13 +9509,13 @@ }, { "disabled": false, - "document": "当请求参数 PackageType = 0 时生效,逗号分隔,从第一个到最后一个分别表示:\n标准直播,中国大陆(境内全地区)计费方式。\n标准直播,国际/港澳台(境外多地区)计费方式。\n快直播,中国大陆(境内全地区)计费方式。\n快直播,国际/港澳台(境外多地区)计费方式。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "当请求参数 PackageType = 0 时生效,逗号分隔,从第一个到最后一个分别表示:\n标准直播,中国大陆(境内全地区)计费方式。\n标准直播,国际/港澳台(境外多地区)计费方式。\n快直播,中国大陆(境内全地区)计费方式。\n快直播,国际/港澳台(境外多地区)计费方式。", "example": "201,201,204,204", "member": "string", "name": "FluxPackageBillMode", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -9565,7 +9586,7 @@ "example": "无", "member": "RuleInfo", "name": "Rules", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -9602,7 +9623,7 @@ "example": "无", "member": "PadTemplate", "name": "Template", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -9629,7 +9650,7 @@ "example": "无", "member": "PadTemplate", "name": "Templates", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -9648,7 +9669,7 @@ { "disabled": false, "document": "域名。", - "example": "", + "example": "a.elementtest.org", "member": "string", "name": "DomainName", "required": true, @@ -9663,9 +9684,10 @@ { "disabled": false, "document": "播放鉴权key信息。", - "example": "", + "example": "{\"DomainName\":\"pull.xiangdongshow.com\",\"Enable\":0,\"AuthKey\":\"\",\"AuthBackKey\":\"\",\"AuthDelta\":0}}", "member": "PlayAuthKeyInfo", "name": "PlayAuthKeyInfo", + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -9721,7 +9743,7 @@ { "disabled": false, "document": "任务 ID。 \n来源:调用 CreateLivePullStreamTask 接口时返回。\n不填默认查询所有任务,按更新时间倒序排序。", - "example": "123", + "example": "956321", "member": "string", "name": "TaskId", "required": false, @@ -9748,7 +9770,7 @@ { "disabled": false, "document": "使用指定任务 ID 查询任务信息。\n注意:仅供使用指定 ID 创建的任务查询。", - "example": "无", + "example": "myspecifytaskid", "member": "string", "name": "SpecifyTaskId", "required": false, @@ -9835,7 +9857,7 @@ { "disabled": false, "document": "推流域名。", - "example": "", + "example": "pull.show.com", "member": "string", "name": "DomainName", "required": true, @@ -9850,9 +9872,10 @@ { "disabled": false, "document": "推流鉴权key信息。", - "example": "", + "example": "{\"DomainName\":\"push.record.xiangdongshow.com\",\"Enable\":1,\"AuthDelta\":0}}", "member": "PushAuthKeyInfo", "name": "PushAuthKeyInfo", + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -9916,7 +9939,7 @@ "example": "无", "member": "RecordTemplateInfo", "name": "Template", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -9953,7 +9976,7 @@ "example": "无", "member": "RecordTemplateInfo", "name": "Templates", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -9999,7 +10022,7 @@ { "disabled": false, "document": "模板 ID。\n调用 [CreateLiveSnapshotTemplate](/document/product/267/32624) 时返回的模板 ID。", - "example": "", + "example": "865421", "member": "int64", "name": "TemplateId", "required": true, @@ -10014,9 +10037,10 @@ { "disabled": false, "document": "截图模板信息。", - "example": "", + "example": "无", "member": "SnapshotTemplateInfo", "name": "Template", + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -10043,7 +10067,7 @@ "example": "无", "member": "SnapshotTemplateInfo", "name": "Templates", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -10243,21 +10267,23 @@ "members": [ { "disabled": false, - "document": "账号下的直播流监播任务个数。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "账号下的直播流监播任务个数。", "example": "7", "member": "uint64", "name": "TotalNum", + "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "直播流监播任务列表\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "直播流监播任务列表", "example": "无", "member": "LiveStreamMonitorInfo", "name": "LiveStreamMonitors", + "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -10288,12 +10314,13 @@ "members": [ { "disabled": false, - "document": "直播监播任务相关信息。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "直播监播任务相关信息。", "example": "无", "member": "LiveStreamMonitorInfo", "name": "LiveStreamMonitor", + "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -10775,7 +10802,7 @@ "example": "无", "member": "RuleInfo", "name": "Rules", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -10802,7 +10829,7 @@ "example": "无", "member": "TimeShiftTemplate", "name": "Templates", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -11043,7 +11070,7 @@ { "disabled": false, "document": "要筛选的模板ID数组。", - "example": "无", + "example": "365245", "member": "int64", "name": "TemplateIds", "required": false, @@ -11052,7 +11079,7 @@ { "disabled": false, "document": "要筛选的域名数组。", - "example": "无", + "example": "tc.videosolar.com", "member": "string", "name": "DomainNames", "required": false, @@ -11067,10 +11094,10 @@ { "disabled": false, "document": "转码规则列表。", - "example": "无", + "example": "[{\"TemplateId\":369918,\"DomainName\":\"tc.videosolar.com\"}]", "member": "RuleInfo", "name": "Rules", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -11107,7 +11134,7 @@ "example": "无", "member": "TemplateInfo", "name": "Template", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -11291,7 +11318,7 @@ { "disabled": false, "document": "水印名称", - "example": "无", + "example": "watermaker", "member": "string", "name": "Name", "required": false, @@ -11465,6 +11492,7 @@ "example": "无", "member": "LogInfo", "name": "LogInfoList", + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -11474,6 +11502,7 @@ "example": "1", "member": "uint64", "name": "TotalNum", + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -11506,21 +11535,23 @@ "members": [ { "disabled": false, - "document": "媒体处理结果信息。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "媒体处理结果信息。", "example": "无", "member": "MPSResult", "name": "MPSResult", + "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "媒体诊断结果信息。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "媒体诊断结果信息。", "example": "无", "member": "DiagnoseResult", "name": "DiagnoseResult", + "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -12599,7 +12630,7 @@ "example": "RF1bV9tRVVEW=", "member": "string", "name": "ScrollToken", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12609,7 +12640,7 @@ "example": "无", "member": "ScreenshotTask", "name": "TaskList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -12905,7 +12936,7 @@ { "disabled": false, "document": "推流域名。", - "example": "无", + "example": "push.domain.com", "member": "string", "name": "Domain", "required": true, @@ -12914,7 +12945,7 @@ { "disabled": false, "document": "推流路径。", - "example": "无", + "example": "push/path", "member": "string", "name": "AppName", "required": true, @@ -12923,7 +12954,7 @@ { "disabled": false, "document": "流名称。", - "example": "无", + "example": "stream", "member": "string", "name": "StreamName", "required": true, @@ -12932,7 +12963,7 @@ { "disabled": false, "document": "查询范围起始时间,Unix 时间戳。", - "example": "无", + "example": "45622563", "member": "int64", "name": "StartTime", "required": true, @@ -12941,7 +12972,7 @@ { "disabled": false, "document": "查询范围终止时间,Unix 时间戳。 ", - "example": "无", + "example": "45628563", "member": "int64", "name": "EndTime", "required": true, @@ -12950,7 +12981,7 @@ { "disabled": false, "document": "推流域名所属组,没有域名组或者域名组为空字符串可不填。", - "example": "无", + "example": "75362", "member": "string", "name": "DomainGroup", "required": false, @@ -12959,7 +12990,7 @@ { "disabled": false, "document": "转码模板ID,转码模板ID为0可不填。", - "example": "无", + "example": "5625623", "member": "uint64", "name": "TransCodeId", "required": false, @@ -12973,12 +13004,13 @@ "members": [ { "disabled": false, - "document": "时移录制会话数组。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "时移录制会话数组。", "example": "无", "member": "TimeShiftRecord", "name": "RecordList", + "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -13013,7 +13045,7 @@ { "disabled": false, "document": "流名称。", - "example": "无", + "example": "streamname", "member": "string", "name": "StreamName", "required": false, @@ -13022,7 +13054,7 @@ { "disabled": false, "document": "推流域名。", - "example": "无", + "example": "push.domain.com", "member": "string", "name": "Domain", "required": false, @@ -13031,7 +13063,7 @@ { "disabled": false, "document": "推流域名所属域名组。", - "example": "无", + "example": "domaingroup", "member": "string", "name": "DomainGroup", "required": false, @@ -13067,17 +13099,19 @@ "example": "500", "member": "int64", "name": "TotalSize", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, - "document": "流列表。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "流列表。", "example": "无", "member": "TimeShiftStreamInfo", "name": "StreamList", + "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -14819,6 +14853,28 @@ "required": false, "type": "int", "value_allowed_null": true + }, + { + "disabled": false, + "document": "导播台监播对应的导播台场次id", + "example": "\"101\"", + "member": "string", + "name": "CasterId", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "拉流转推监播对应的拉流转推任务id", + "example": "\"xxxx\"", + "member": "string", + "name": "PullPushTaskId", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": false } ], "usage": "both" @@ -14832,6 +14888,7 @@ "example": "ExampleStreamName", "member": "string", "name": "InputStreamName", + "output_required": true, "required": true, "type": "string", "value_allowed_null": true @@ -14842,6 +14899,7 @@ "example": "ExampleDomain", "member": "string", "name": "InputDomain", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -14852,6 +14910,7 @@ "example": "Live", "member": "string", "name": "InputApp", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -14862,6 +14921,7 @@ "example": "rtmp://ExampleDomain/Live/ExampleStreamName", "member": "string", "name": "InputUrl", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -14872,9 +14932,32 @@ "example": "Input1", "member": "string", "name": "Description", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "导播台输入源索引(10000 pvw, 10001 pgm, 其余代表输入下标)", + "example": "1", + "member": "uint64", + "name": "CasterInputIndex", + "output_required": false, + "required": false, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "该输入源是否正在监播", + "example": "True", + "member": "bool", + "name": "NeedMonitor", + "output_required": false, + "required": false, + "type": "bool", + "value_allowed_null": false } ], "usage": "both" @@ -15012,21 +15095,31 @@ "members": [ { "disabled": false, - "document": "智能语音识别结果\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "智能语音识别结果。\n注意:此字段可能返回 null,表示取不到有效值。", "example": "无", "member": "string", "name": "AiAsrResults", - "required": false, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, - "document": "智能文字识别结果\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "智能文字识别结果。\n注意:此字段可能返回 null,表示取不到有效值。", "example": "无", "member": "string", "name": "AiOcrResults", - "required": false, + "output_required": true, + "type": "list", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "内容质检结果。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "string", + "name": "StreamQuaCtrlResults", + "output_required": true, "type": "list", "value_allowed_null": true } @@ -15054,7 +15147,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -15110,7 +15203,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -15146,7 +15239,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -15182,7 +15275,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -15218,7 +15311,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -15254,7 +15347,7 @@ { "disabled": false, "document": "导播台ID", - "example": "10", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -15263,7 +15356,7 @@ { "disabled": false, "document": "导播台名称", - "example": "examp;e", + "example": "example", "member": "string", "name": "CasterName", "required": false, @@ -15317,7 +15410,7 @@ { "disabled": false, "document": "导播台转场类型。 \n默认为空。 \n允许使用通过DescribeCasterTransitionTypes接口中查询到的转场类型。", - "example": "123", + "example": "heart", "member": "string", "name": "TransitionType", "required": false, @@ -15425,7 +15518,7 @@ { "disabled": false, "document": "描述信息。", - "example": "test", + "example": "callback", "member": "string", "name": "Description", "required": false, @@ -15434,7 +15527,7 @@ { "disabled": false, "document": "开播回调 URL。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "StreamBeginNotifyUrl", "required": false, @@ -15443,7 +15536,7 @@ { "disabled": false, "document": "断流回调 URL。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "StreamEndNotifyUrl", "required": false, @@ -15452,7 +15545,7 @@ { "disabled": false, "document": "录制文件回调 URL。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "RecordNotifyUrl", "required": false, @@ -15461,7 +15554,7 @@ { "disabled": false, "document": "录制状态回调 URL 。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "RecordStatusNotifyUrl", "required": false, @@ -15470,7 +15563,7 @@ { "disabled": false, "document": "截图回调 URL。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "SnapshotNotifyUrl", "required": false, @@ -15479,7 +15572,7 @@ { "disabled": false, "document": "鉴黄回调 URL。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "PornCensorshipNotifyUrl", "required": false, @@ -15506,7 +15599,7 @@ { "disabled": false, "document": "音频审核回调 URL。", - "example": "无", + "example": "http://domain.com/path", "member": "string", "name": "AudioAuditNotifyUrl", "required": false, @@ -15542,7 +15635,7 @@ { "disabled": false, "document": "腾讯云ssl的证书Id。\n见 https://cloud.tencent.com/document/api/400/41665", - "example": "无", + "example": "Kf2ymCv", "member": "string", "name": "CloudCertId", "required": false, @@ -15551,7 +15644,7 @@ { "disabled": false, "document": "证书公钥。\nCloudCertId和公钥私钥对二选一,若CloudCertId将会舍弃公钥和私钥参数,否则将自动先把公钥私钥对上传至ssl新建证书,并使用上传成功后返回的CloudCertId。", - "example": "无", + "example": "NXpT4oZAQ0JLclP1I9EbV8daGk9j86hd1oWJlmGMuz-Qc", "member": "string", "name": "CertificatePublicKey", "required": false, @@ -15560,7 +15653,7 @@ { "disabled": false, "document": "证书私钥。\nCloudCertId和公钥私钥对二选一,若传CloudCertId将会舍弃公钥和私钥参数,否则将自动先把公钥私钥对上传至ssl新建证书,并使用上传成功后返回的CloudCertId。", - "example": "无", + "example": "lb7KhNmJL8wS7XXIZeFreu353WIeYtQX8xz4OOLwWR2pwamXsH5rLGVSVSDMnpjhd6q7RMbxJeNyByL3WpytvXgA1bn4w", "member": "string", "name": "CertificatePrivateKey", "required": false, @@ -15569,7 +15662,7 @@ { "disabled": false, "document": "上传至ssl证书中心的备注信息,只有新建证书时有效。传CloudCertId时会忽略。", - "example": "无", + "example": "Kf2ymCv", "member": "string", "name": "CertificateAlias", "required": false, @@ -15587,19 +15680,19 @@ "example": "无", "member": "string", "name": "MismatchedDomainNames", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, - "document": "操作失败的域名及错误码,错误信息,包括MismatchedDomainNames中的域名。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "操作失败的域名及错误码,错误信息,包括MismatchedDomainNames中的域名。", "example": "无", "member": "BatchDomainOperateErrors", "name": "Errors", - "required": true, + "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -15760,7 +15853,7 @@ { "disabled": false, "document": "播放域名。", - "example": "", + "example": "push.record.com", "member": "string", "name": "DomainName", "required": true, @@ -15769,7 +15862,7 @@ { "disabled": false, "document": "是否启用,0:关闭,1:启用。\n不传表示不修改当前值。", - "example": "", + "example": "1", "member": "int64", "name": "Enable", "required": false, @@ -15778,7 +15871,7 @@ { "disabled": false, "document": "鉴权key。\n不传表示不修改当前值。", - "example": "", + "example": "AKID0QJ82oYdLJIgAQlb", "member": "string", "name": "AuthKey", "required": false, @@ -15787,7 +15880,7 @@ { "disabled": false, "document": "有效时间,单位:秒。\n不传表示不修改当前值。", - "example": "", + "example": "6000", "member": "uint64", "name": "AuthDelta", "required": false, @@ -15796,7 +15889,7 @@ { "disabled": false, "document": "鉴权备用key。\n不传表示不修改当前值。", - "example": "", + "example": "PUl5VIKKFB1KazNB", "member": "string", "name": "AuthBackKey", "required": false, @@ -16066,7 +16159,7 @@ { "disabled": false, "document": "推流域名。", - "example": "无", + "example": "aaa.elementtest.org", "member": "string", "name": "DomainName", "required": true, @@ -16075,7 +16168,7 @@ { "disabled": false, "document": "是否启用,0:关闭,1:启用。\n不传表示不修改当前值。", - "example": "无", + "example": "1", "member": "int64", "name": "Enable", "required": false, @@ -16084,7 +16177,7 @@ { "disabled": false, "document": "主鉴权key。\n不传表示不修改当前值。", - "example": "无", + "example": "714cc271251e714cc271251e", "member": "string", "name": "MasterAuthKey", "required": false, @@ -16093,7 +16186,7 @@ { "disabled": false, "document": "备鉴权key。\n不传表示不修改当前值。", - "example": "无", + "example": "888cc271251e714cc271251e", "member": "string", "name": "BackupAuthKey", "required": false, @@ -16102,7 +16195,7 @@ { "disabled": false, "document": "有效时间,单位:秒。", - "example": "无", + "example": "6000", "member": "uint64", "name": "AuthDelta", "required": false, @@ -16147,7 +16240,7 @@ { "disabled": false, "document": "描述信息。", - "example": "test", + "example": "record", "member": "string", "name": "Description", "required": false, @@ -16255,7 +16348,7 @@ { "disabled": false, "document": "Cos 应用 ID。\n**注:此参数现在须必选。**", - "example": "123", + "example": "854625", "member": "int64", "name": "CosAppId", "required": true, @@ -16372,7 +16465,7 @@ { "disabled": false, "document": "监播任务ID。", - "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "example": "caster-124", "member": "string", "name": "MonitorId", "required": true, @@ -16381,7 +16474,7 @@ { "disabled": false, "document": "监播任务的名称。长度128字节以内(一个汉字两个字节)。", - "example": "ExampleMonitorName", + "example": "ExampleStreamMonitor", "member": "string", "name": "MonitorName", "required": false, @@ -16390,7 +16483,7 @@ { "disabled": false, "document": "监播任务输出信息。", - "example": "无", + "example": "{\"OutputDomain\":\"pull-live.jgangwang.cn\",\"OutputStreamHeight\":1080,\"OutputStreamWidth\":1920}", "member": "LiveStreamMonitorOutputInfo", "name": "OutputInfo", "required": false, @@ -16399,7 +16492,7 @@ { "disabled": false, "document": "待监播的输入流信息。", - "example": "无", + "example": "[{\"InputApp\":\"live\",\"InputDomain\":\"tpush.ztimelive.com\",\"InputStreamName\":\"nioday\"}]", "member": "LiveStreamMonitorInputInfo", "name": "InputList", "required": false, @@ -16408,7 +16501,7 @@ { "disabled": false, "document": "监播事件通知策略。", - "example": "无", + "example": "{\"CallbackUrl\":\"\",\"NotifyPolicyType\":0}", "member": "LiveStreamMonitorNotifyPolicy", "name": "NotifyPolicy", "required": false, @@ -16642,7 +16735,7 @@ { "disabled": false, "document": "模板描述。", - "example": "test", + "example": "transcode", "member": "string", "name": "Description", "required": false, @@ -17572,7 +17665,7 @@ { "disabled": false, "document": "拉流任务Id。", - "example": "12345", + "example": "564214", "member": "string", "name": "TaskId", "output_required": true, @@ -17742,7 +17835,7 @@ { "disabled": false, "document": "选择需要回调的事件:\nTaskStart:任务启动回调,\nTaskExit:任务停止回调,\nVodSourceFileStart:从点播源文件开始拉流回调,\nVodSourceFileFinish:从点播源文件拉流结束回调,\nResetTaskConfig:任务更新回调。", - "example": "无", + "example": "[\"TaskStart\"]", "member": "string", "name": "CallbackEvents", "output_required": true, @@ -17752,7 +17845,7 @@ { "disabled": false, "document": "注意:该信息暂不返回。\n最后一次回调信息。", - "example": "无", + "example": "null", "member": "string", "name": "CallbackInfo", "output_required": true, @@ -17762,7 +17855,7 @@ { "disabled": false, "document": "注意:该信息暂不返回。\n错误信息。", - "example": "无", + "example": "null", "member": "string", "name": "ErrorInfo", "output_required": true, @@ -17842,7 +17935,7 @@ { "disabled": false, "document": "录制模板 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "123", + "example": "8452", "member": "string", "name": "RecordTemplateId", "output_required": true, @@ -18843,7 +18936,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -19310,7 +19403,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -19337,7 +19430,7 @@ { "disabled": false, "document": "导播台ID。", - "example": "1234", + "example": "63501", "member": "uint64", "name": "CasterId", "required": true, @@ -20399,9 +20492,10 @@ { "disabled": false, "document": "模板名称。", - "example": "test", + "example": "mytemplate", "member": "string", "name": "TemplateName", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -20412,6 +20506,7 @@ "example": "6000", "member": "uint64", "name": "Duration", + "output_required": true, "required": true, "type": "int", "value_allowed_null": false @@ -20422,6 +20517,7 @@ "example": "5", "member": "uint64", "name": "ItemDuration", + "output_required": true, "required": true, "type": "int", "value_allowed_null": false @@ -20432,6 +20528,7 @@ "example": "1", "member": "uint64", "name": "TemplateId", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -20439,9 +20536,10 @@ { "disabled": false, "document": "模板描述。", - "example": "test", + "example": "模板", "member": "string", "name": "Description", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -20452,6 +20550,7 @@ "example": "Mainland", "member": "string", "name": "Area", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -20462,6 +20561,7 @@ "example": "false", "member": "bool", "name": "RemoveWatermark", + "output_required": true, "required": false, "type": "bool", "value_allowed_null": false @@ -20472,6 +20572,7 @@ "example": "[1]", "member": "uint64", "name": "TranscodeTemplateIds", + "output_required": true, "required": false, "type": "list", "value_allowed_null": false @@ -20827,7 +20928,7 @@ { "disabled": false, "document": "水印 ID。\n在添加水印接口 [AddLiveWatermark](/document/product/267/30154) 调用返回值中获取水印 ID。", - "example": "123", + "example": "452356", "member": "int64", "name": "WatermarkId", "required": true, diff --git a/tccli/services/live/v20180801/examples.json b/tccli/services/live/v20180801/examples.json index 384b6e45dc..8642546041 100644 --- a/tccli/services/live/v20180801/examples.json +++ b/tccli/services/live/v20180801/examples.json @@ -99,7 +99,7 @@ "CreateCasterInputPushUrl": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCasterInputPushUrl\n<公共请求参数>\n\n{\n \"InputIndex\": \"1\",\n \"CasterId\": \"1234\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCasterInputPushUrl\n<公共请求参数>\n\n{\n \"InputIndex\": 1,\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"PushUrl\": \"rtmp://www.example.com/live/caster_example_stream_id?example_param=example\",\n \"RequestId\": \"c8b02a52-1062-4d6d-9837-54d48b17e8f9\"\n }\n}", "title": "请求示例" } @@ -159,7 +159,7 @@ "CreateLiveCallbackTemplate": [ { "document": "请求示例", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLiveCallbackTemplate\n<公共请求参数>\n\n{\n \"StreamBeginNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=streamBegin\",\n \"StreamEndNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=streamEnd\",\n \"TemplateName\": \"testName\",\n \"RecordNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=record\",\n \"SnapshotNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=snapshot\",\n \"PornCensorshipNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=porn\",\n \"CallbackKey\": \"adasda131312\",\n \"Description\": \"test\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLiveCallbackTemplate\n<公共请求参数>\n\n{\n \"StreamBeginNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=streamBegin\",\n \"StreamEndNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=streamEnd\",\n \"TemplateName\": \"testName\",\n \"RecordNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=record\",\n \"SnapshotNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=snapshot\",\n \"PornCensorshipNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=porn\",\n \"CallbackKey\": \"adasda131312\",\n \"Description\": \"回调模板\"\n}", "output": "{\n \"Response\": {\n \"TemplateId\": 1000,\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -175,7 +175,7 @@ "CreateLivePadTemplate": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLivePadTemplate\n<公共请求参数>\n\n{\n \"Url\": \"xx\",\n \"WaitDuration\": 1,\n \"Description\": \"xx\",\n \"MaxDuration\": 1,\n \"TemplateName\": \"xx\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLivePadTemplate\n<公共请求参数>\n\n{\n \"Url\": \"http://domain.com/app/name\",\n \"WaitDuration\": 1,\n \"Description\": \"pad\",\n \"MaxDuration\": 1,\n \"TemplateName\": \"name\"\n}", "output": "{\n \"Response\": {\n \"TemplateId\": 1000,\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -183,7 +183,7 @@ "CreateLivePullStreamTask": [ { "document": "用于创建直播拉流任务。", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLivePullStreamTask\n<公共请求参数>\n\n{\n \"SourceType\": \"PullLivePushLive\",\n \"DomainName\": \"5000.livepush.myqcloud.com\",\n \"SourceUrls\": [\n \"rtmp://5000.liveplay.myqcloud.com/live/stream1\"\n ],\n \"StreamName\": \"test\",\n \"AppName\": \"live\",\n \"StartTime\": \"2019-12-16T11:02:00Z\",\n \"Operator\": \"vinson\",\n \"EndTime\": \"2019-12-17T12:02:00Z\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLivePullStreamTask\n<公共请求参数>\n\n{\n \"SourceType\": \"PullLivePushLive\",\n \"DomainName\": \"5000.livepush.myqcloud.com\",\n \"SourceUrls\": [\n \"rtmp://5000.liveplay.myqcloud.com/live/stream1\"\n ],\n \"StreamName\": \"stream1\",\n \"AppName\": \"live\",\n \"StartTime\": \"2019-12-16T11:02:00Z\",\n \"Operator\": \"vinson\",\n \"EndTime\": \"2019-12-17T12:02:00Z\"\n}", "output": "{\n \"Response\": {\n \"TaskId\": \"10000\",\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -219,7 +219,7 @@ }, { "document": "", - "input": "https://live.tencentcloudapi.com/?Action=CreateLiveRecordTemplate\n&TemplateName=templat\n&Description=test\n&FlvParam.Enable=0\n&FlvParam.RecordInterval=1800\n&FlvParam.StorageTime=600\n&HlsParam.Enable=1\n&HlsParam.RecordInterval=1800\n&HlsParam.StorageTime=600\n&<公共请求参数>", + "input": "https://live.tencentcloudapi.com/?Action=CreateLiveRecordTemplate\n&TemplateName=templat\n&Description=录制规则\n&FlvParam.Enable=0\n&FlvParam.RecordInterval=1800\n&FlvParam.StorageTime=600\n&HlsParam.Enable=1\n&HlsParam.RecordInterval=1800\n&HlsParam.StorageTime=600\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"TemplateId\": 1000,\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -235,7 +235,7 @@ "CreateLiveSnapshotTemplate": [ { "document": "创建 直播截图&鉴黄 模板。", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLiveSnapshotTemplate\n<公共请求参数>\n\n{\n \"CosRegion\": \"beijing\",\n \"Description\": \"testDesc\",\n \"SnapshotInterval\": \"10\",\n \"PornFlag\": \"0\",\n \"CosBucket\": \"bucket\",\n \"TemplateName\": \"testName\",\n \"Height\": \"250\",\n \"CosAppId\": \"123\",\n \"Width\": \"250\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLiveSnapshotTemplate\n<公共请求参数>\n\n{\n \"CosRegion\": \"beijing\",\n \"Description\": \"testDesc\",\n \"SnapshotInterval\": \"10\",\n \"PornFlag\": \"0\",\n \"CosBucket\": \"bucket\",\n \"TemplateName\": \"testName\",\n \"Height\": \"250\",\n \"CosAppId\": \"8954511\",\n \"Width\": \"250\"\n}", "output": "{\n \"Response\": {\n \"TemplateId\": 1000,\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -259,8 +259,8 @@ "CreateLiveTimeShiftTemplate": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLiveTimeShiftTemplate\n<公共请求参数>\n\n{\n \"TemplateName\": \"abc\",\n \"Description\": \"abc\",\n \"Area\": \"abc\",\n \"Duration\": 1,\n \"ItemDuration\": 1,\n \"RemoveWatermark\": true,\n \"TranscodeTemplateIds\": [\n 0\n ]\n}", - "output": "{\n \"Response\": {\n \"TemplateId\": 0,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLiveTimeShiftTemplate\n<公共请求参数>\n\n{\n \"TemplateName\": \"name\",\n \"Description\": \"timeshift\",\n \"Area\": \"0\",\n \"Duration\": 1,\n \"ItemDuration\": 1,\n \"RemoveWatermark\": true,\n \"TranscodeTemplateIds\": [\n 0\n ]\n}", + "output": "{\n \"Response\": {\n \"TemplateId\": 0,\n \"RequestId\": \"3fefec28-3f95-4055-8a22-714cc271251e\"\n }\n}", "title": "请求示例" } ], @@ -275,7 +275,7 @@ "CreateLiveTranscodeTemplate": [ { "document": "CreateLiveTranscodeTemplate 例子。", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLiveTranscodeTemplate\n<公共请求参数>\n\n{\n \"Profile\": \"main\",\n \"AudioBitrate\": \"500\",\n \"Rotate\": \"0\",\n \"Description\": \"test\",\n \"TemplateName\": \"900m\",\n \"VideoBitrate\": \"900\",\n \"Vcodec\": \"h264\",\n \"Height\": \"250\",\n \"Width\": \"250\",\n \"NeedAudio\": \"1\",\n \"FpsToOrig\": \"0\",\n \"Fps\": \"30\",\n \"BitrateToOrig\": \"0\",\n \"HeightToOrig\": \"0\",\n \"NeedVideo\": \"1\",\n \"Gop\": \"3\",\n \"Acodec\": \"aac\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLiveTranscodeTemplate\n<公共请求参数>\n\n{\n \"Profile\": \"main\",\n \"AudioBitrate\": \"500\",\n \"Rotate\": \"0\",\n \"Description\": \"transcode\",\n \"TemplateName\": \"900m\",\n \"VideoBitrate\": \"900\",\n \"Vcodec\": \"h264\",\n \"Height\": \"250\",\n \"Width\": \"250\",\n \"NeedAudio\": \"1\",\n \"FpsToOrig\": \"0\",\n \"Fps\": \"30\",\n \"BitrateToOrig\": \"0\",\n \"HeightToOrig\": \"0\",\n \"NeedVideo\": \"1\",\n \"Gop\": \"3\",\n \"Acodec\": \"aac\"\n}", "output": "{\n \"Response\": {\n \"TemplateId\": 1000,\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -315,15 +315,15 @@ "DeleteCaster": [ { "document": "删除导播台", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCaster\n<公共请求参数>\n\n{\n \"CasterId\": \"1234\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCaster\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } ], "DeleteCasterInputInfo": [ { - "document": "删除导播台1234的输入源1。", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCasterInputInfo\n<公共请求参数>\n\n{\n \"InputIndex\": \"1\",\n \"CasterId\": \"1234\"\n}", + "document": "删除导播台63501的输入源1。", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCasterInputInfo\n<公共请求参数>\n\n{\n \"InputIndex\": 1,\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -331,7 +331,7 @@ "DeleteCasterLayoutInfo": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCasterLayoutInfo\n<公共请求参数>\n\n{\n \"CasterId\": \"1234\",\n \"LayoutIndex\": \"1\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCasterLayoutInfo\n<公共请求参数>\n\n{\n \"CasterId\": 63501,\n \"LayoutIndex\": \"1\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -339,7 +339,7 @@ "DeleteCasterMarkPicInfo": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCasterMarkPicInfo\n<公共请求参数>\n\n{\n \"CasterId\": 1234,\n \"MarkPicIndex\": 1\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCasterMarkPicInfo\n<公共请求参数>\n\n{\n \"CasterId\": 63501,\n \"MarkPicIndex\": 1\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -347,7 +347,7 @@ "DeleteCasterMarkWordInfo": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCasterMarkWordInfo\n<公共请求参数>\n\n{\n \"MarkWordIndex\": 1,\n \"CasterId\": 1234\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCasterMarkWordInfo\n<公共请求参数>\n\n{\n \"MarkWordIndex\": 1,\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -355,7 +355,7 @@ "DeleteCasterOutputInfo": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCasterOutputInfo\n<公共请求参数>\n\n{\n \"OutputIndex\": 1,\n \"CasterId\": \"1234\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCasterOutputInfo\n<公共请求参数>\n\n{\n \"OutputIndex\": 1,\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求删除Index为1的推流配置" } @@ -387,7 +387,7 @@ "DeleteLivePadRule": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteLivePadRule\n<公共请求参数>\n\n{\n \"TemplateId\": 1,\n \"DomainName\": \"xx\",\n \"StreamName\": \"xx\",\n \"AppName\": \"xx\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteLivePadRule\n<公共请求参数>\n\n{\n \"TemplateId\": 1,\n \"DomainName\": \"domain.com\",\n \"StreamName\": \"streamname\",\n \"AppName\": \"appname\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -459,7 +459,7 @@ "DeleteLiveTimeShiftRule": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteLiveTimeShiftRule\n<公共请求参数>\n\n{\n \"DomainName\": \"xx\",\n \"StreamName\": \"xx\",\n \"AppName\": \"xx\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteLiveTimeShiftRule\n<公共请求参数>\n\n{\n \"DomainName\": \"domain.com\",\n \"StreamName\": \"streamname\",\n \"AppName\": \"appname\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -491,7 +491,7 @@ "DeleteLiveWatermark": [ { "document": "", - "input": "https://live.tencentcloudapi.com/?Action=DeleteLiveWatermark\r\n&WatermarkId=123\r\n&<公共请求参数>", + "input": "https://live.tencentcloudapi.com/?Action=DeleteLiveWatermark\n&WatermarkId=43527\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -571,15 +571,15 @@ "DescribeCaster": [ { "document": "当需要查询一个导播台的信息时,可以按如下调用。", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCaster\n<公共请求参数>\n\n{\n \"CasterId\": \"1234\"\n}", - "output": "{\n \"Response\": {\n \"CasterInfo\": {\n \"CasterId\": 1234,\n \"CasterName\": \"example\",\n \"StartLiveTime\": 0,\n \"Description\": \"\",\n \"CreateTime\": 1603158528,\n \"Status\": 0,\n \"ExpireTime\": -1,\n \"DelayTime\": 0,\n \"PgmWidth\": 0,\n \"PgmHeight\": 0,\n \"PgmFps\": 0,\n \"PgmBitRate\": 0,\n \"PgmAudioBitRate\": 256,\n \"FeeType\": 0,\n \"RecordTemplateId\": 0,\n \"RecordStatus\": 0,\n \"RecordTaskId\": \"\"\n },\n \"RequestId\": \"bebdd4e4-4087-411b-ab2e-3692dcfba4c3\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCaster\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", + "output": "{\n \"Response\": {\n \"CasterInfo\": {\n \"CasterId\": 63501,\n \"CasterName\": \"example\",\n \"StartLiveTime\": 0,\n \"Description\": \"\",\n \"CreateTime\": 1603158528,\n \"Status\": 0,\n \"ExpireTime\": -1,\n \"DelayTime\": 0,\n \"PgmWidth\": 0,\n \"PgmHeight\": 0,\n \"PgmFps\": 0,\n \"PgmBitRate\": 0,\n \"PgmAudioBitRate\": 256,\n \"FeeType\": 0,\n \"RecordTemplateId\": 0,\n \"RecordStatus\": 0,\n \"RecordTaskId\": \"\"\n },\n \"RequestId\": \"bebdd4e4-4087-411b-ab2e-3692dcfba4c3\"\n }\n}", "title": "请求示例" } ], "DescribeCasterDisplayInfo": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterDisplayInfo\n<公共请求参数>\n\n{\n \"CasterId\": 130\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterDisplayInfo\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"PvwDisplayInfo\": {\n \"LayoutIndex\": 0,\n \"MarkPicIndexList\": [],\n \"MarkWordIndexList\": [],\n \"TransitionType\": \"\",\n \"AudioIndexList\": []\n },\n \"PgmDisplayInfo\": {\n \"LayoutIndex\": 0,\n \"MarkPicIndexList\": [],\n \"MarkWordIndexList\": [],\n \"TransitionType\": \"\",\n \"AudioIndexList\": []\n },\n \"Status\": 0,\n \"RequestId\": \"uuid\",\n \"StartLiveTime\": 1670309219\n }\n}", "title": "查询导播台展示信息" } @@ -587,7 +587,7 @@ "DescribeCasterInputInfos": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterInputInfos\n<公共请求参数>\n\n{\n \"CasterId\": \"1234\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterInputInfos\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"InputInfos\": [\n {\n \"InputIndex\": 1,\n \"InputType\": 1,\n \"InputUrl\": \"\",\n \"Description\": \"点播\",\n \"PullPushEnable\": true,\n \"LoopEnable\": true,\n \"LoopNumber\": -1,\n \"Volume\": 100,\n \"InputUrls\": [\n \"https://www.example.com/vod.mp4\"\n ]\n }\n ],\n \"RequestId\": \"f505e243-8f0e-4d50-a212-bba4effe7bee\"\n }\n}", "title": "查询输入源列表" } @@ -595,7 +595,7 @@ "DescribeCasterLayoutInfos": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterLayoutInfos\n<公共请求参数>\n\n{\n \"CasterId\": 1234\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterLayoutInfos\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"LayoutInfos\": [\n {\n \"LayoutIndex\": 1,\n \"InputIndexList\": \"1|2\",\n \"LayoutTemplateId\": 20,\n \"LayoutWidth\": 1280,\n \"LayoutHeight\": 720,\n \"LayoutParams\": [\n {\n \"LayerId\": 1,\n \"LayerWidth\": 0.5,\n \"LayerHeight\": 1,\n \"LayerLocationX\": 0,\n \"LayerLocationY\": 0,\n \"UsePortraitSegment\": false\n },\n {\n \"LayerId\": 2,\n \"LayerWidth\": 0.5,\n \"LayerHeight\": 1,\n \"LayerLocationX\": 0.5,\n \"LayerLocationY\": 0,\n \"UsePortraitSegment\": false\n }\n ]\n }\n ],\n \"RequestId\": \"203cd886-18d8-4f42-a9b4-141c182bc920\"\n }\n}", "title": "查询导播台的布局列表" } @@ -604,14 +604,14 @@ { "document": "获取某个账号下的所有导播台列表", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterList\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\",\n \"CasterList\": [\n {\n \"CasterId\": 10,\n \"CasterName\": \"example\",\n \"StartBillingTime\": 0,\n \"StopBillingTime\": 1731964027,\n \"Description\": \"\",\n \"CreateTime\": 1603158528,\n \"Status\": 0,\n \"ExpireTime\": -1,\n \"FeeType\": 0\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\",\n \"CasterList\": [\n {\n \"CasterId\": 63501,\n \"CasterName\": \"example\",\n \"StartBillingTime\": 0,\n \"StopBillingTime\": 1731964027,\n \"Description\": \"\",\n \"CreateTime\": 1603158528,\n \"Status\": 0,\n \"ExpireTime\": -1,\n \"FeeType\": 0\n }\n ]\n }\n}", "title": "请求示例" } ], "DescribeCasterMarkPicInfos": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterMarkPicInfos\n<公共请求参数>\n\n{\n \"CasterId\": 1234\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterMarkPicInfos\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"MarkPicInfos\": [\n {\n \"MarkPicIndex\": 1,\n \"MarkPicId\": 0,\n \"MarkPicUrl\": \"https://www.example.com/pic/example.jpg\",\n \"MarkPicWidth\": 0.2,\n \"MarkPicHeight\": 0.2,\n \"MarkPicLocationX\": 0,\n \"MarkPicLocationY\": 0.3,\n \"Description\": \"\",\n \"IsEqualProportion\": false\n }\n ],\n \"RequestId\": \"4b154257-a7ba-4371-91f2-40f44ee83f5c\"\n }\n}", "title": "查询导播台的水印列表" } @@ -619,7 +619,7 @@ "DescribeCasterMarkWordInfos": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterMarkWordInfos\n<公共请求参数>\n\n{\n \"CasterId\": 1234\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterMarkWordInfos\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"MarkWordInfos\": [\n {\n \"MarkWordIndex\": 1,\n \"MarkWordText\": \"example mark word\",\n \"MarkWordFontSize\": 52,\n \"MarkWordFontColor\": \"0xd0021b\",\n \"MarkWordFontType\": 1,\n \"MarkWordLocationX\": 0,\n \"MarkWordLocationY\": 0.5,\n \"MarkWordRollEnable\": false,\n \"MarkWordRollDirection\": 0,\n \"MarkWordRollOnceTime\": 5,\n \"MarkWordRollStartLocationX\": 0,\n \"MarkWordRollEndLocationX\": 0.3\n }\n ],\n \"RequestId\": \"d4040a52-8d42-4a76-8f28-ded6b3fa9a6e\"\n }\n}", "title": "查询导播台文本列表" } @@ -627,7 +627,7 @@ "DescribeCasterOutputInfos": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterOutputInfos\n<公共请求参数>\n\n{\n \"CasterId\": 1234\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterOutputInfos\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"OutputInfos\": [\n {\n \"OutputIndex\": 0,\n \"OutputType\": 1,\n \"OutputUrl\": \"rtmp://example.tlive.com/live/example_stream_id\",\n \"Description\": \"\",\n \"OutputStreamId\": \"example_stream_id\",\n \"OutputDomainName\": \"example.tlive.com\",\n \"OutputAppName\": \"live\",\n \"OutputParam\": \"\"\n }\n ],\n \"RequestId\": \"a25094ea-f516-420a-81d0-5f5c54a9e823\"\n }\n}", "title": "查询某个导播台的推流信息列表" } @@ -635,7 +635,7 @@ "DescribeCasterPlayUrl": [ { "document": "获取某个输入或者预监、主监的播放地址", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterPlayUrl\n<公共请求参数>\n\n{\n \"PlayUrlType\": \"1\",\n \"CasterId\": \"10\",\n \"PlayUrlIndex\": \"1\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterPlayUrl\n<公共请求参数>\n\n{\n \"PlayUrlType\": 1,\n \"CasterId\": 63501,\n \"PlayUrlIndex\": 1\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\",\n \"PlayUrl\": \"http://domain/live/test.flv\",\n \"WebRTCPlayUrl\": \"webrtc://webrtc.domain.com/live/test\"\n }\n}", "title": "请求示例" } @@ -643,7 +643,7 @@ "DescribeCasterTransitionTypes": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterTransitionTypes\n<公共请求参数>\n\n{\n \"CasterId\": \"10\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCasterTransitionTypes\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\",\n \"TransitionTypes\": [\n {\n \"Index\": 1,\n \"SourceUrl\": \"http://www.example.com/url/example\",\n \"TransitionType\": \"heart\"\n }\n ]\n }\n}", "title": "请求示例" } @@ -676,7 +676,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDeliverLogDownList\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"LogInfoList\": [\n {\n \"LogName\": \"abc\",\n \"LogUrl\": \"abc\",\n \"LogTime\": \"abc\",\n \"FileSize\": 0\n }\n ],\n \"TotalNum\": 1,\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"LogInfoList\": [\n {\n \"LogName\": \"mylog\",\n \"LogUrl\": \"https://livelog-down.cdn.qcloud.com/20220804/11/202208041125-pul\",\n \"LogTime\": \"2022-02-09T12:36:42Z\",\n \"FileSize\": 0\n }\n ],\n \"TotalNum\": 1,\n \"RequestId\": \"1047d0dc-6dc8-4898-a7f3-03726a822b0e\"\n }\n}", "title": "请求示例" } ], @@ -708,7 +708,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveCallbackTemplate\n&TemplateId=1000\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Template\": {\n \"TemplateId\": 1000,\n \"TemplateName\": \"testName\",\n \"Description\": \"test\",\n \"StreamBeginNotifyUrl\": \"http://www.qq.com/api/notify?action=streamBegin\",\n \"StreamEndNotifyUrl\": \"http://www.qq.com/api/notify?action=streamEnd\",\n \"StreamMixNotifyUrl\": \"\",\n \"RecordNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"SnapshotNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"PornCensorshipNotifyUrl\": \"http://www.qq.com/api/notify?action=porn\",\n \"CallbackKey\": \"adasdasda1312312\"\n },\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"Template\": {\n \"TemplateId\": 1000,\n \"TemplateName\": \"testName\",\n \"Description\": \"回调模板\",\n \"StreamBeginNotifyUrl\": \"http://www.qq.com/api/notify?action=streamBegin\",\n \"StreamEndNotifyUrl\": \"http://www.qq.com/api/notify?action=streamEnd\",\n \"StreamMixNotifyUrl\": \"\",\n \"RecordNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"SnapshotNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"AudioAuditNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"PushExceptionNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"PornCensorshipNotifyUrl\": \"http://www.qq.com/api/notify?action=porn\",\n \"CallbackKey\": \"adasdasda1312312\"\n },\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } ], @@ -716,7 +716,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveCallbackTemplates\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": 1000,\n \"TemplateName\": \"testName\",\n \"Description\": \"test\",\n \"StreamBeginNotifyUrl\": \"http://www.qq.com/api/notify?action=streamBegin\",\n \"StreamEndNotifyUrl\": \"http://www.qq.com/api/notify?action=streamEnd\",\n \"StreamMixNotifyUrl\": \"\",\n \"RecordNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"SnapshotNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"PornCensorshipNotifyUrl\": \"http://www.qq.com/api/notify?action=porn\",\n \"CallbackKey\": \"adafas1412423432\"\n }\n ],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": 1000,\n \"TemplateName\": \"testName\",\n \"Description\": \"回调模版\",\n \"StreamBeginNotifyUrl\": \"http://www.qq.com/api/notify?action=streamBegin\",\n \"StreamEndNotifyUrl\": \"http://www.qq.com/api/notify?action=streamEnd\",\n \"StreamMixNotifyUrl\": \"\",\n \"RecordNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"SnapshotNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"AudioAuditNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"PushExceptionNotifyUrl\": \"http://www.qq.com/api/notify?action=record\",\n \"PornCensorshipNotifyUrl\": \"http://www.qq.com/api/notify?action=porn\",\n \"CallbackKey\": \"adafas1412423432\"\n }\n ],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } ], @@ -724,7 +724,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveCert\r\n&CertId=1000\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"CertInfo\": {\n \"CertId\": 1000,\n \"CertName\": \"testName\",\n \"Description\": \"testDesc\",\n \"CreateTime\": \"2018-11-30T15:50:12Z\",\n \"HttpsCrt\": \"xxx\",\n \"CertType\": 0,\n \"CertExpireTime\": \"2018-12-30T15:50:12Z\",\n \"DomainList\": [\n \"5000.livepush.play.com\"\n ]\n },\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"CertInfo\": {\n \"CertId\": 1000,\n \"CertName\": \"testName\",\n \"Description\": \"testDesc\",\n \"CreateTime\": \"2018-11-30T15:50:12Z\",\n \"HttpsCrt\": \"gfdsfsdfdsfdsfdsfsdfsd\",\n \"CertType\": 0,\n \"CertExpireTime\": \"2018-12-30T15:50:12Z\",\n \"DomainList\": [\n \"5000.livepush.play.com\"\n ]\n },\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "获取证书详情" } ], @@ -732,7 +732,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveCerts\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"CertInfoSet\": [\n {\n \"CertId\": 1000,\n \"CertName\": \"testName\",\n \"Description\": \"testDesc\",\n \"CreateTime\": \"2018-11-30T15:50:12Z\",\n \"HttpsCrt\": \"xxx\",\n \"CertType\": 0,\n \"CertExpireTime\": \"2018-12-30T15:50:12Z\",\n \"DomainList\": [\n \"5000.livepush.play.com\"\n ]\n }\n ],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"CertInfoSet\": [\n {\n \"CertId\": 1000,\n \"CertName\": \"testName\",\n \"Description\": \"testDesc\",\n \"CreateTime\": \"2018-11-30T15:50:12Z\",\n \"HttpsCrt\": \"dfdsfdsfdsfsdfsd\",\n \"CertType\": 0,\n \"CertExpireTime\": \"2018-12-30T15:50:12Z\",\n \"DomainList\": [\n \"5000.livepush.play.com\"\n ]\n }\n ],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } ], @@ -748,15 +748,15 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveDomain\n&DomainName=yourdomain.test.com\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\",\n \"DomainInfo\": {\n \"Name\": \"abc.com\",\n \"Type\": 1,\n \"Status\": 1,\n \"CreateTime\": \"2018-08-29 10:00:00\",\n \"BCName\": 1,\n \"TargetDomain\": \"yourdomain.test2.com\",\n \"CurrentCName\": \"yourdomain.test.com\",\n \"IsDelayLive\": 0,\n \"RentTag\": 0,\n \"RentExpireTime\": \"0000-00-00 00:00:00\"\n }\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"6dad49b1-6a37-4288-9068-0be2ab6ce19b\",\n \"DomainInfo\": {\n \"Name\": \"push.livhub.net\",\n \"Type\": 0,\n \"Status\": 1,\n \"PlayType\": 1,\n \"IsDelayLive\": 0,\n \"IsMiniProgramLive\": 0,\n \"CreateTime\": \"2023-10-30 14:01:48\",\n \"BCName\": 1,\n \"CurrentCName\": \"push.livhub.net.tlivepush.com.\",\n \"TargetDomain\": \"push.livhub.net.tlivepush.com\",\n \"RentTag\": 0,\n \"RentExpireTime\": \"78894\"\n }\n }\n}", "title": "请求示例" } ], "DescribeLiveDomainCert": [ { "document": "", - "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveDomainCert\r\n&DomainName=5000.livepush.myqcloud.com\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"DomainCertInfo\": {\n \"CertId\": 1000,\n \"CertName\": \"testName\",\n \"Description\": \"testDesc\",\n \"CreateTime\": \"2018-11-30T15:50:12Z\",\n \"HttpsCrt\": \"xxx\",\n \"CertType\": 0,\n \"CertExpireTime\": \"2018-12-30T15:50:12Z\",\n \"DomainName\": \"5000.livepush.play.com\",\n \"Status\": 1\n },\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveDomainCert\n&DomainName=5000.liveplay.myqcloud.com\n&<公共请求参数>", + "output": "{\n \"Response\": {\n \"DomainCertInfo\": {\n \"CertId\": 1000,\n \"CertName\": \"testName\",\n \"Description\": \"testDesc\",\n \"CreateTime\": \"2018-11-30T15:50:12Z\",\n \"HttpsCrt\": \"fsgfdsfsdfdsfd\",\n \"CertType\": 0,\n \"CertExpireTime\": \"2018-12-30T15:50:12Z\",\n \"DomainName\": \"5000.livepush.play.com\",\n \"Status\": 1,\n \"CertDomains\": [\n \"*.play.com\"\n ],\n \"CloudCertId\": \"sfrsfvdf\"\n },\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } ], @@ -812,7 +812,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLivePackageInfo\n&PackageType=0\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"LivePackageInfoList\": [\n {\n \"Id\": \"abc\",\n \"Total\": 0,\n \"Used\": 0,\n \"Left\": 0,\n \"BuyTime\": \"abc\",\n \"ExpireTime\": \"abc\",\n \"Type\": 0,\n \"Status\": 0,\n \"WillRenew\": 0,\n \"RenewalResult\": 0\n }\n ],\n \"PackageBillMode\": 0,\n \"TotalPage\": 0,\n \"TotalNum\": 0,\n \"PageNum\": 0,\n \"PageSize\": 0,\n \"FluxPackageBillMode\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"53fc3618-4152-4e12-a1e6-3805e647a602\",\n \"LivePackageInfoList\": [\n {\n \"Id\": \"281975\",\n \"Type\": 0,\n \"Status\": 1,\n \"Total\": 500000000000,\n \"Used\": 2365271265,\n \"Left\": 497634728735,\n \"BuyTime\": \"2024-07-16 18:46:08\",\n \"ExpireTime\": \"2025-07-16 18:46:08\",\n \"WillRenew\": 0,\n \"RenewalResult\": 0\n },\n {\n \"Id\": \"272177\",\n \"Type\": 0,\n \"Status\": 4,\n \"Total\": 500000000000,\n \"Used\": 500000000000,\n \"Left\": 0,\n \"BuyTime\": \"2023-12-05 10:17:04\",\n \"ExpireTime\": \"2024-12-05 10:17:04\",\n \"WillRenew\": 0,\n \"RenewalResult\": 0\n },\n {\n \"Id\": \"265480\",\n \"Type\": 0,\n \"Status\": 4,\n \"Total\": 100000000000,\n \"Used\": 100000000000,\n \"Left\": 0,\n \"BuyTime\": \"2023-07-14 14:14:30\",\n \"ExpireTime\": \"2024-07-14 14:14:30\",\n \"WillRenew\": 0,\n \"RenewalResult\": 0\n },\n {\n \"Id\": \"242917\",\n \"Type\": 0,\n \"Status\": 4,\n \"Total\": 1000000000000,\n \"Used\": 1000000000000,\n \"Left\": 0,\n \"BuyTime\": \"2022-09-30 10:01:19\",\n \"ExpireTime\": \"2023-09-30 10:01:19\",\n \"WillRenew\": 0,\n \"RenewalResult\": 0\n },\n {\n \"Id\": \"224805\",\n \"Type\": 0,\n \"Status\": 4,\n \"Total\": 100000000000,\n \"Used\": 100000000000,\n \"Left\": 0,\n \"BuyTime\": \"2022-04-01 10:13:27\",\n \"ExpireTime\": \"2023-04-01 10:13:27\",\n \"WillRenew\": 0,\n \"RenewalResult\": 0\n },\n {\n \"Id\": \"224804\",\n \"Type\": 0,\n \"Status\": 4,\n \"Total\": 100000000000,\n \"Used\": 100000000000,\n \"Left\": 0,\n \"BuyTime\": \"2022-04-01 10:13:27\",\n \"ExpireTime\": \"2023-04-01 10:13:27\",\n \"WillRenew\": 0,\n \"RenewalResult\": 0\n },\n {\n \"Id\": \"210034\",\n \"Type\": 0,\n \"Status\": 4,\n \"Total\": 100000000000,\n \"Used\": 100000000000,\n \"Left\": 0,\n \"BuyTime\": \"2021-11-16 16:48:39\",\n \"ExpireTime\": \"2022-11-16 16:48:39\",\n \"WillRenew\": 0,\n \"RenewalResult\": 0\n },\n {\n \"Id\": \"174007\",\n \"Type\": 0,\n \"Status\": 4,\n \"Total\": 100000000000,\n \"Used\": 100000000000,\n \"Left\": 0,\n \"BuyTime\": \"2021-03-19 16:21:52\",\n \"ExpireTime\": \"2022-03-19 16:21:52\",\n \"WillRenew\": 0,\n \"RenewalResult\": 0\n },\n {\n \"Id\": \"138556\",\n \"Type\": 0,\n \"Status\": 4,\n \"Total\": 20000000000,\n \"Used\": 20000000000,\n \"Left\": 0,\n \"BuyTime\": \"2020-09-09 12:45:48\",\n \"ExpireTime\": \"2021-09-09 12:45:48\",\n \"WillRenew\": 0,\n \"RenewalResult\": 0\n }\n ],\n \"PackageBillMode\": 204,\n \"FluxPackageBillMode\": \"204,204,204,204,-1,-1\",\n \"TotalPage\": 1,\n \"TotalNum\": 9,\n \"PageNum\": 1,\n \"PageSize\": 100\n }\n}", "title": "查询直播套餐包信息" } ], @@ -828,7 +828,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLivePadRules\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"Rules\": [\n {\n \"UpdateTime\": \"xx\",\n \"AppName\": \"xx\",\n \"DomainName\": \"xx\",\n \"StreamName\": \"xx\",\n \"TemplateId\": 1000,\n \"CreateTime\": \"xx\"\n }\n ],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"Rules\": [],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } ], @@ -836,7 +836,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLivePadTemplate\n<公共请求参数>\n\n{\n \"TemplateId\": 1\n}", - "output": "{\n \"Response\": {\n \"Template\": {\n \"UpdateTime\": \"xx\",\n \"Description\": \"xx\",\n \"TemplateName\": \"xx\",\n \"Url\": \"xx\",\n \"TemplateId\": 1,\n \"CreateTime\": \"xx\",\n \"WaitDuration\": 1,\n \"MaxDuration\": 1\n },\n \"RequestId\": \"xx\"\n }\n}", + "output": "{\n \"Response\": {\n \"Template\": {\n \"UpdateTime\": \"2020-01-01 08:00:00\",\n \"Description\": \"template\",\n \"TemplateName\": \"mytemplate\",\n \"Url\": \"https://test.com/a.mp4\",\n \"TemplateId\": 1,\n \"CreateTime\": \"2020-01-01 08:00:00\",\n \"WaitDuration\": 1,\n \"MaxDuration\": 1,\n \"Type\": 1\n },\n \"RequestId\": \"3fefec28-3f95-4055-8a22-714cc271251e\"\n }\n}", "title": "请求示例" } ], @@ -844,7 +844,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLivePadTemplates\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"UpdateTime\": \"xx\",\n \"Description\": \"xx\",\n \"TemplateName\": \"xx\",\n \"Url\": \"xx\",\n \"TemplateId\": 1,\n \"CreateTime\": \"xx\",\n \"WaitDuration\": 1,\n \"MaxDuration\": 1\n }\n ],\n \"RequestId\": \"xx\"\n }\n}", + "output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"UpdateTime\": \"2020-01-01 08:00:00\",\n \"Description\": \"template\",\n \"TemplateName\": \"mytemplate\",\n \"Url\": \"https://test.com/a.mp4\",\n \"TemplateId\": 1,\n \"CreateTime\": \"2020-01-01 08:00:00\",\n \"WaitDuration\": 1,\n \"MaxDuration\": 1,\n \"Type\": 1\n }\n ],\n \"RequestId\": \"1047d0dc-6dc8-4898-a7f3-03726a822b0e\"\n }\n}", "title": "请求示例" } ], @@ -852,7 +852,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLivePlayAuthKey\r\n&DomainName=5000.livepush.myqcloud.com\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"PlayAuthKeyInfo\": {\n \"DomainName\": \"5000.livepush.myqcloud.com\",\n \"Enable\": 1,\n \"AuthKey\": \"xxxx\",\n \"AuthDelta\": 300,\n \"AuthBackKey\": \"xxx\"\n },\n \"RequestId\": \"8e50cdb5-56dc-408b-89b0-31818958d424\"\n }\n}", + "output": "{\n \"Response\": {\n \"PlayAuthKeyInfo\": {\n \"DomainName\": \"5000.livepush.myqcloud.com\",\n \"Enable\": 1,\n \"AuthKey\": \"AKID0QJ82oYdLJ\",\n \"AuthDelta\": 300,\n \"AuthBackKey\": \"lbPUl5VIKKFB1KazNB\"\n },\n \"RequestId\": \"8e50cdb5-56dc-408b-89b0-31818958d424\"\n }\n}", "title": "请求示例" } ], @@ -867,8 +867,8 @@ "DescribeLivePullStreamTasks": [ { "document": "查询直播拉流任务。", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLivePullStreamTasks\n<公共请求参数>\n\n{\n \"TaskId\": \"123\"\n}", - "output": "{\n \"Response\": {\n \"TaskInfos\": [\n {\n \"AppName\": \"live\",\n \"Region\": \"ap-beijing\",\n \"CallbackInfo\": \"\",\n \"CallbackEvents\": [\n \"TaskStart\",\n \"TaskExit\"\n ],\n \"CallbackUrl\": \"\",\n \"CreateBy\": \"yourname\",\n \"DomainName\": \"yourdomain.com\",\n \"EndTime\": \"2020-04-25T00:30:00Z\",\n \"ErrorInfo\": \"\",\n \"BackupToUrl\": \"\",\n \"RecordTemplateId\": \"\",\n \"PushArgs\": \"txsecret=7cbb8f382a21e8d2f6cd8098100d3b8e&txtime=5ea0450d\",\n \"SourceType\": \"PullLivePushLive\",\n \"SourceUrls\": [\n \"http://yourdomain/live/test.flv\"\n ],\n \"StartTime\": \"2020-04-20T00:30:00Z\",\n \"Status\": \"enable\",\n \"StreamName\": \"teststream\",\n \"Comment\": \"abc\",\n \"TaskId\": \"10054\",\n \"UpdateBy\": \"\",\n \"UpdateTime\": \"2020-04-23T05:07:43Z\",\n \"CreateTime\": \"2020-04-20T05:07:43Z\",\n \"VodLoopTimes\": -1,\n \"VodRefreshType\": \"ImmediateNewSource\",\n \"VodLocalMode\": 0,\n \"BackupSourceType\": \"\",\n \"BackupSourceUrl\": \"\",\n \"WatermarkList\": [],\n \"RecentPullInfo\": {\n \"FileUrl\": \"http://yourdomain/live/test.flv\",\n \"OffsetTime\": 95,\n \"LoopedTimes\": 0,\n \"ReportTime\": \"2020-04-23T08:20:39Z\"\n }\n }\n ],\n \"PageNum\": 1,\n \"PageSize\": 10,\n \"TotalNum\": 1,\n \"TotalPage\": 1,\n \"LimitTaskNum\": 20,\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLivePullStreamTasks\n<公共请求参数>\n\n{\n \"TaskId\": \"9654231\"\n}", + "output": "{\n \"Response\": {\n \"TaskInfos\": [\n {\n \"AppName\": \"live\",\n \"Region\": \"ap-beijing\",\n \"CallbackInfo\": \"\",\n \"CallbackEvents\": [\n \"TaskStart\",\n \"TaskExit\"\n ],\n \"CallbackUrl\": \"\",\n \"CreateBy\": \"yourname\",\n \"DomainName\": \"yourdomain.com\",\n \"EndTime\": \"2020-04-25T00:30:00Z\",\n \"ErrorInfo\": \"\",\n \"BackupToUrl\": \"\",\n \"RecordTemplateId\": \"\",\n \"PushArgs\": \"txsecret=7cbb8f382a21e8d2f6cd8098100d3b8e&txtime=5ea0450d\",\n \"SourceType\": \"PullLivePushLive\",\n \"SourceUrls\": [\n \"http://yourdomain/live/test.flv\"\n ],\n \"StartTime\": \"2020-04-20T00:30:00Z\",\n \"Status\": \"enable\",\n \"StreamName\": \"teststream\",\n \"Comment\": \"重要活动\",\n \"TaskId\": \"10054\",\n \"UpdateBy\": \"\",\n \"UpdateTime\": \"2020-04-23T05:07:43Z\",\n \"CreateTime\": \"2020-04-20T05:07:43Z\",\n \"VodLoopTimes\": -1,\n \"VodRefreshType\": \"ImmediateNewSource\",\n \"VodLocalMode\": 0,\n \"BackupSourceType\": \"\",\n \"BackupSourceUrl\": \"\",\n \"WatermarkList\": [],\n \"RecentPullInfo\": {\n \"FileUrl\": \"http://yourdomain/live/test.flv\",\n \"OffsetTime\": 95,\n \"LoopedTimes\": 0,\n \"ReportTime\": \"2020-04-23T08:20:39Z\"\n }\n }\n ],\n \"PageNum\": 1,\n \"PageSize\": 10,\n \"TotalNum\": 1,\n \"TotalPage\": 1,\n \"LimitTaskNum\": 20,\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } ], @@ -876,7 +876,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLivePushAuthKey\r\n&DomainName=5000.livepush.myqcloud.com\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"PushAuthKeyInfo\": {\n \"DomainName\": \"5000.livepush.myqcloud.com\",\n \"Enable\": 1,\n \"MasterAuthKey\": \"xxxx\",\n \"BackupAuthKey\": \"xxxx\",\n \"AuthDelta\": 300\n },\n \"RequestId\": \"8e50cdb5-56dc-408b-89b0-31818958d424\"\n }\n}", + "output": "{\n \"Response\": {\n \"PushAuthKeyInfo\": {\n \"DomainName\": \"5000.livepush.myqcloud.com\",\n \"Enable\": 1,\n \"MasterAuthKey\": \"PUl5VIKKFB1KazNB\",\n \"BackupAuthKey\": \"AKID0QJ82oYdLJIgA\",\n \"AuthDelta\": 300\n },\n \"RequestId\": \"8e50cdb5-56dc-408b-89b0-31818958d424\"\n }\n}", "title": "请求示例" } ], @@ -892,7 +892,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveRecordTemplate\n&TemplateId=10000\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Template\": {\n \"TemplateId\": 1000,\n \"Mp4Param\": {\n \"ClassId\": 0,\n \"StorageMode\": \"xx\",\n \"StorageTime\": 0,\n \"VodSubAppId\": 0,\n \"VodFileName\": \"xx\",\n \"Enable\": 0,\n \"RecordInterval\": 0,\n \"Procedure\": \"xx\"\n },\n \"AacParam\": {\n \"ClassId\": 0,\n \"StorageMode\": \"xx\",\n \"StorageTime\": 0,\n \"VodSubAppId\": 0,\n \"VodFileName\": \"xx\",\n \"Enable\": 0,\n \"RecordInterval\": 0,\n \"Procedure\": \"xx\"\n },\n \"Mp3Param\": {\n \"ClassId\": 0,\n \"StorageMode\": \"xx\",\n \"StorageTime\": 0,\n \"VodSubAppId\": 0,\n \"VodFileName\": \"xx\",\n \"Enable\": 0,\n \"RecordInterval\": 0,\n \"Procedure\": \"xx\"\n },\n \"TemplateName\": \"testName\",\n \"Description\": \"test\",\n \"FlvParam\": {\n \"Enable\": 1,\n \"RecordInterval\": 1800,\n \"StorageTime\": 600\n },\n \"HlsParam\": {\n \"Enable\": 0,\n \"RecordInterval\": 1800,\n \"StorageTime\": 600\n },\n \"IsDelayLive\": 0,\n \"HlsSpecialParam\": {\n \"FlowContinueDuration\": 60\n }\n },\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"3fefec28-3f95-4055-8a22-714cc271251e\",\n \"Template\": {\n \"AacParam\": {\n \"ClassId\": null,\n \"CosBucketName\": \"\",\n \"CosBucketPath\": \"\",\n \"CosBucketRegion\": \"\",\n \"Enable\": 0,\n \"Procedure\": \"\",\n \"RecordInterval\": 1800,\n \"StorageMode\": \"normal\",\n \"StorageTime\": 0,\n \"VodFileName\": \"\",\n \"VodSubAppId\": 251006352\n },\n \"CosStore\": 0,\n \"Description\": \"\",\n \"FlvParam\": {\n \"ClassId\": null,\n \"CosBucketName\": \"\",\n \"CosBucketPath\": \"\",\n \"CosBucketRegion\": \"\",\n \"Enable\": 1,\n \"Procedure\": \"\",\n \"RecordInterval\": 1800,\n \"StorageMode\": \"normal\",\n \"StorageTime\": 123,\n \"VodFileName\": \"\",\n \"VodSubAppId\": 251006352\n },\n \"FlvSpecialParam\": {\n \"UploadInRecording\": true\n },\n \"HlsParam\": {\n \"ClassId\": null,\n \"CosBucketName\": \"\",\n \"CosBucketPath\": \"\",\n \"CosBucketRegion\": \"\",\n \"Enable\": 0,\n \"Procedure\": \"\",\n \"RecordInterval\": 1800,\n \"StorageMode\": \"normal\",\n \"StorageTime\": 0,\n \"VodFileName\": \"\",\n \"VodSubAppId\": 251006352\n },\n \"HlsSpecialParam\": {\n \"FlowContinueDuration\": 0\n },\n \"IsDelayLive\": 0,\n \"Mp3Param\": {\n \"ClassId\": null,\n \"CosBucketName\": \"\",\n \"CosBucketPath\": \"\",\n \"CosBucketRegion\": \"\",\n \"Enable\": 0,\n \"Procedure\": \"\",\n \"RecordInterval\": 1800,\n \"StorageMode\": \"normal\",\n \"StorageTime\": 0,\n \"VodFileName\": \"\",\n \"VodSubAppId\": 251006352\n },\n \"Mp4Param\": {\n \"ClassId\": null,\n \"CosBucketName\": \"\",\n \"CosBucketPath\": \"\",\n \"CosBucketRegion\": \"\",\n \"Enable\": 0,\n \"Procedure\": \"\",\n \"RecordInterval\": 1800,\n \"StorageMode\": \"normal\",\n \"StorageTime\": 0,\n \"VodFileName\": \"\",\n \"VodSubAppId\": 251006352\n },\n \"RemoveWatermark\": true,\n \"TemplateId\": 1370613,\n \"TemplateName\": \"victor0001\"\n }\n }\n}", "title": "请求示例" } ], @@ -900,7 +900,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveRecordTemplates\n&IsDelayLive=1\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": 1000,\n \"TemplateName\": \"testName\",\n \"IsDelayLive\": 1,\n \"Description\": \"test\",\n \"FlvParam\": {\n \"Enable\": 0,\n \"RecordInterval\": 1800,\n \"StorageTime\": 6000,\n \"VodSubAppId\": 123456\n },\n \"Mp4Param\": {\n \"ClassId\": 0,\n \"StorageMode\": \"xx\",\n \"StorageTime\": 0,\n \"VodSubAppId\": 0,\n \"VodFileName\": \"xx\",\n \"Enable\": 0,\n \"RecordInterval\": 0,\n \"Procedure\": \"xx\"\n },\n \"AacParam\": {\n \"ClassId\": 0,\n \"StorageMode\": \"xx\",\n \"StorageTime\": 0,\n \"VodSubAppId\": 0,\n \"VodFileName\": \"xx\",\n \"Enable\": 0,\n \"RecordInterval\": 0,\n \"Procedure\": \"xx\"\n },\n \"Mp3Param\": {\n \"ClassId\": 0,\n \"StorageMode\": \"xx\",\n \"StorageTime\": 0,\n \"VodSubAppId\": 0,\n \"VodFileName\": \"xx\",\n \"Enable\": 0,\n \"RecordInterval\": 0,\n \"Procedure\": \"xx\"\n },\n \"HlsParam\": {\n \"Enable\": 1,\n \"RecordInterval\": 1800,\n \"StorageTime\": 600,\n \"VodSubAppId\": 123456\n },\n \"HlsSpecialParam\": {\n \"FlowContinueDuration\": 60\n }\n }\n ],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"bc76b15f-734f-4bb5-9b0d-b3a1ecd5444d\",\n \"Templates\": [\n {\n \"AacParam\": {\n \"ClassId\": 0,\n \"CosBucketName\": \"\",\n \"CosBucketPath\": \"\",\n \"CosBucketRegion\": \"\",\n \"Enable\": 0,\n \"Procedure\": \"\",\n \"RecordInterval\": 1800,\n \"StorageMode\": \"normal\",\n \"StorageTime\": 0,\n \"VodFileName\": \"\",\n \"VodSubAppId\": 251006352\n },\n \"CosStore\": 0,\n \"Description\": \"\",\n \"FlvParam\": {\n \"ClassId\": null,\n \"CosBucketName\": \"\",\n \"CosBucketPath\": \"\",\n \"CosBucketRegion\": \"\",\n \"Enable\": 1,\n \"Procedure\": \"\",\n \"RecordInterval\": 1800,\n \"StorageMode\": \"normal\",\n \"StorageTime\": 4572,\n \"VodFileName\": \"\",\n \"VodSubAppId\": 251006352\n },\n \"FlvSpecialParam\": {\n \"UploadInRecording\": true\n },\n \"HlsParam\": {\n \"ClassId\": 0,\n \"CosBucketName\": \"\",\n \"CosBucketPath\": \"\",\n \"CosBucketRegion\": \"\",\n \"Enable\": 0,\n \"Procedure\": \"\",\n \"RecordInterval\": 1800,\n \"StorageMode\": \"normal\",\n \"StorageTime\": 0,\n \"VodFileName\": \"\",\n \"VodSubAppId\": 251006352\n },\n \"HlsSpecialParam\": {\n \"FlowContinueDuration\": 0\n },\n \"IsDelayLive\": 0,\n \"Mp3Param\": {\n \"ClassId\": null,\n \"CosBucketName\": \"\",\n \"CosBucketPath\": \"\",\n \"CosBucketRegion\": \"\",\n \"Enable\": 0,\n \"Procedure\": \"\",\n \"RecordInterval\": 1800,\n \"StorageMode\": \"normal\",\n \"StorageTime\": 0,\n \"VodFileName\": \"\",\n \"VodSubAppId\": 251006352\n },\n \"Mp4Param\": {\n \"ClassId\": 0,\n \"CosBucketName\": \"\",\n \"CosBucketPath\": \"\",\n \"CosBucketRegion\": \"\",\n \"Enable\": 0,\n \"Procedure\": \"\",\n \"RecordInterval\": 1800,\n \"StorageMode\": \"normal\",\n \"StorageTime\": 0,\n \"VodFileName\": \"\",\n \"VodSubAppId\": 251006352\n },\n \"RemoveWatermark\": true,\n \"TemplateId\": 1370613,\n \"TemplateName\": \"victor0001\"\n }\n ]\n }\n}", "title": "请求示例" } ], @@ -916,7 +916,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveSnapshotTemplate\r\n&TemplateId=1000\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Template\": {\n \"TemplateId\": 1000,\n \"TemplateName\": \"testName\",\n \"Description\": \"test\",\n \"SnapshotInterval\": 10,\n \"Width\": 250,\n \"Height\": 250,\n \"PornFlag\": 0,\n \"CosAppId\": 123,\n \"CosBucket\": \"bucket\",\n \"CosRegion\": \"beijing\"\n },\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"Template\": {\n \"TemplateId\": 1000,\n \"TemplateName\": \"testName\",\n \"Description\": \"active_template\",\n \"SnapshotInterval\": 10,\n \"Width\": 250,\n \"Height\": 250,\n \"PornFlag\": 0,\n \"CosAppId\": 934258,\n \"CosBucket\": \"bucket\",\n \"CosRegion\": \"beijing\",\n \"CosPrefix\": \"live\",\n \"CosFileName\": \"myfilename\"\n },\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } ], @@ -924,7 +924,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveSnapshotTemplates\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": 1000,\n \"TemplateName\": \"testName\",\n \"Description\": \"test\",\n \"SnapshotInterval\": 10,\n \"Width\": 250,\n \"Height\": 250,\n \"PornFlag\": 0,\n \"CosAppId\": 123,\n \"CosBucket\": \"bucket\",\n \"CosRegion\": \"beijing\",\n \"CosPrefix\": \"xx\",\n \"CosFileName\": \"xx\"\n }\n ],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": 1000,\n \"TemplateName\": \"testName\",\n \"Description\": \"template\",\n \"SnapshotInterval\": 10,\n \"Width\": 250,\n \"Height\": 250,\n \"PornFlag\": 0,\n \"CosAppId\": 85421,\n \"CosBucket\": \"bucket\",\n \"CosRegion\": \"beijing\",\n \"CosPrefix\": \"live\",\n \"CosFileName\": \"myfilename\"\n }\n ],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } ], @@ -940,7 +940,7 @@ { "document": "查询某个监播场次,返回该场次的基本配置信息。", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLiveStreamMonitor\n<公共请求参数>\n\n{\n \"MonitorId\": \"1bd5af00-5be5-4e4d-aa75-340ba0f35586\"\n}", - "output": "{\n \"Response\": {\n \"LiveStreamMonitor\": {\n \"MonitorId\": \"1bd5af00-5be5-4e4d-aa75-340ba0f35586\",\n \"MonitorName\": \"example_monitor_name\",\n \"OutputInfo\": {\n \"OutputStreamName\": \"example_output_stream_name\",\n \"OutputStreamWidth\": 1920,\n \"OutputStreamHeight\": 1080,\n \"OutputDomain\": \"\",\n \"OutputApp\": \"\"\n },\n \"InputList\": [\n {\n \"InputStreamName\": \"example_stream_name\",\n \"InputDomain\": \"\",\n \"InputApp\": \"\",\n \"InputUrl\": \"\",\n \"Description\": \"\"\n }\n ],\n \"Status\": 1,\n \"CreateTime\": 1640694582,\n \"UpdateTime\": 1640591812,\n \"NotifyPolicy\": {\n \"NotifyPolicyType\": 1,\n \"CallbackUrl\": \"xx\"\n },\n \"AudibleInputIndexList\": [\n 1\n ],\n \"AiAsrInputIndexList\": [\n 1\n ],\n \"CheckStreamBroken\": 1,\n \"CheckStreamLowFrameRate\": 1,\n \"AsrLanguage\": 1,\n \"OcrLanguage\": 1\n },\n \"RequestId\": \"\"\n }\n}", + "output": "{\n \"Response\": {\n \"LiveStreamMonitor\": {\n \"MonitorId\": \"1bd5af00-5be5-4e4d-aa75-340ba0f35586\",\n \"MonitorName\": \"example_monitor_name\",\n \"OutputInfo\": {\n \"OutputStreamName\": \"example_output_stream_name\",\n \"OutputStreamWidth\": 1920,\n \"OutputStreamHeight\": 1080,\n \"OutputDomain\": \"\",\n \"OutputApp\": \"\"\n },\n \"InputList\": [\n {\n \"InputStreamName\": \"example_stream_name\",\n \"InputDomain\": \"\",\n \"InputApp\": \"\",\n \"InputUrl\": \"\",\n \"Description\": \"\"\n }\n ],\n \"Status\": 1,\n \"CreateTime\": 1640694582,\n \"UpdateTime\": 1640591812,\n \"NotifyPolicy\": {\n \"NotifyPolicyType\": 1,\n \"CallbackUrl\": \"http://my.callback.com/recv/interface\"\n },\n \"AudibleInputIndexList\": [\n 1\n ],\n \"AiAsrInputIndexList\": [\n 1\n ],\n \"CheckStreamBroken\": 1,\n \"CheckStreamLowFrameRate\": 1,\n \"AsrLanguage\": 1,\n \"OcrLanguage\": 1,\n \"AiFormatDiagnose\": 1,\n \"AiQualityControl\": 1,\n \"AllowMonitorReport\": 1,\n \"AiOcrInputIndexList\": [\n 1\n ],\n \"StartTime\": 1735190919,\n \"StopTime\": 1735190919\n },\n \"RequestId\": \"\"\n }\n}", "title": "查询某个监播任务配置" } ], @@ -948,7 +948,7 @@ { "document": "返回所有监播场次列表,包含各监播场次的基本信息", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLiveStreamMonitorList\n<公共请求参数>\n\n{\n \"Index\": 0,\n \"Count\": 1\n}", - "output": "{\n \"Response\": {\n \"LiveStreamMonitors\": [\n {\n \"MonitorId\": \"1bd5af00-5be5-4e4d-aa75-340ba0f35586\",\n \"MonitorName\": \"\",\n \"OutputInfo\": {\n \"OutputStreamName\": \"example_output_stream_name\",\n \"OutputStreamWidth\": 1920,\n \"OutputStreamHeight\": 1080,\n \"OutputDomain\": \"\",\n \"OutputApp\": \"\"\n },\n \"Status\": 1,\n \"StartTime\": 1640694582,\n \"StopTime\": 1640591812,\n \"InputList\": [\n {\n \"InputStreamName\": \"example_stream_name\",\n \"Description\": \"\",\n \"InputDomain\": \"\",\n \"InputApp\": \"\",\n \"InputUrl\": \"\"\n }\n ]\n }\n ],\n \"TotalNum\": 7,\n \"RequestId\": \"3f3fd3ae-23a1-44dc-94d6-35380052b4f4\"\n }\n}", + "output": "{\n \"Response\": {\n \"LiveStreamMonitors\": [\n {\n \"MonitorId\": \"1bd5af00-5be5-4e4d-aa75-340ba0f35586\",\n \"MonitorName\": \"\",\n \"OutputInfo\": {\n \"OutputStreamName\": \"example_output_stream_name\",\n \"OutputStreamWidth\": 1920,\n \"OutputStreamHeight\": 1080,\n \"OutputDomain\": \"\",\n \"OutputApp\": \"\"\n },\n \"Status\": 1,\n \"StartTime\": 1640694582,\n \"StopTime\": 1640591812,\n \"InputList\": [\n {\n \"InputStreamName\": \"example_stream_name\",\n \"Description\": \"\",\n \"InputDomain\": \"\",\n \"InputApp\": \"\",\n \"InputUrl\": \"\"\n }\n ],\n \"CheckStreamBroken\": 1,\n \"AsrLanguage\": 1,\n \"UpdateTime\": 1640694582,\n \"OcrLanguage\": 1,\n \"NotifyPolicy\": {\n \"CallbackUrl\": \"www.baidu.com\",\n \"NotifyPolicyType\": 0\n },\n \"CreateTime\": 1640694582,\n \"AiAsrInputIndexList\": [\n 1\n ],\n \"AiFormatDiagnose\": 1,\n \"AiOcrInputIndexList\": [\n 1\n ],\n \"CheckStreamLowFrameRate\": 1,\n \"AudibleInputIndexList\": [\n 1\n ],\n \"AllowMonitorReport\": 1,\n \"AiQualityControl\": 1\n }\n ],\n \"TotalNum\": 7,\n \"RequestId\": \"3f3fd3ae-23a1-44dc-94d6-35380052b4f4\"\n }\n}", "title": "查询所有的直播流监播任务" } ], @@ -996,7 +996,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLiveTimeShiftRules\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"Rules\": [\n {\n \"UpdateTime\": \"xx\",\n \"AppName\": \"xx\",\n \"DomainName\": \"xx\",\n \"StreamName\": \"xx\",\n \"TemplateId\": 1000,\n \"CreateTime\": \"xx\"\n }\n ],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"Rules\": [],\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } ], @@ -1004,7 +1004,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLiveTimeShiftTemplates\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"Description\": \"xx\",\n \"TranscodeTemplateIds\": [\n 1\n ],\n \"RemoveWatermark\": true,\n \"Area\": 1,\n \"ItemDuration\": 1,\n \"TemplateId\": 1,\n \"Duration\": 1,\n \"TemplateName\": 1\n }\n ],\n \"RequestId\": \"xx\"\n }\n}", + "output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"Description\": \"timeshift\",\n \"TranscodeTemplateIds\": [\n 1\n ],\n \"RemoveWatermark\": true,\n \"Area\": \"1\",\n \"ItemDuration\": 1,\n \"TemplateId\": 1,\n \"Duration\": 1,\n \"TemplateName\": \"1\"\n }\n ],\n \"RequestId\": \"3fefec28-3f95-4055-8a22-714cc271251e\"\n }\n}", "title": "请求示例" } ], @@ -1036,7 +1036,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveTranscodeTemplate\n&TemplateId=1000\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Template\": {\n \"Profile\": \"xx\",\n \"AudioBitrate\": 15,\n \"Rotate\": 0,\n \"BitrateToOrig\": 0,\n \"TemplateName\": \"xx\",\n \"VideoBitrate\": 30,\n \"ShortEdgeAsHeight\": 0,\n \"Vcodec\": \"xx\",\n \"AdaptBitratePercent\": 0.0,\n \"AiTransCode\": 0,\n \"Height\": 250,\n \"Width\": 250,\n \"NeedAudio\": 1,\n \"FpsToOrig\": 0,\n \"Fps\": 30,\n \"TemplateId\": 1000,\n \"Description\": \"xx\",\n \"HeightToOrig\": 0,\n \"NeedVideo\": 1,\n \"Gop\": 3,\n \"Acodec\": \"xx\"\n },\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", + "output": "{\n \"Response\": {\n \"Template\": {\n \"Profile\": \"baseline\",\n \"AudioBitrate\": 15,\n \"Rotate\": 0,\n \"BitrateToOrig\": 0,\n \"TemplateName\": \"mytemplate\",\n \"VideoBitrate\": 30,\n \"ShortEdgeAsHeight\": 0,\n \"Vcodec\": \"h264\",\n \"AdaptBitratePercent\": 0.0,\n \"AiTransCode\": 0,\n \"Height\": 250,\n \"Width\": 250,\n \"NeedAudio\": 1,\n \"FpsToOrig\": 0,\n \"Fps\": 30,\n \"TemplateId\": 1000,\n \"Description\": \"desc\",\n \"HeightToOrig\": 0,\n \"NeedVideo\": 1,\n \"Gop\": 3,\n \"Acodec\": \"aac\",\n \"DRMTracks\": \"AUDIO\",\n \"DRMType\": \"widevine\"\n },\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } ], @@ -1076,7 +1076,7 @@ { "document": "", "input": "https://live.tencentcloudapi.com/?Action=DescribeLiveWatermarks\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"TotalNum\": 1,\n \"WatermarkList\": [\n {\n \"WatermarkId\": 0,\n \"PictureUrl\": \"abc\",\n \"XPosition\": 0,\n \"YPosition\": 0,\n \"WatermarkName\": \"abc\",\n \"Status\": 0,\n \"CreateTime\": \"abc\",\n \"Width\": 0,\n \"Height\": 0,\n \"BackgroundWidth\": 0,\n \"BackgroundHeight\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalNum\": 1,\n \"WatermarkList\": [\n {\n \"WatermarkId\": 0,\n \"PictureUrl\": \"http://wechatapppro.file.myqcloud.com/app1vg363qr9722/image/2024-12-05/app1vg363qr9722_watermark.png\",\n \"XPosition\": 0,\n \"YPosition\": 0,\n \"WatermarkName\": \"wechatapppro\",\n \"Status\": 0,\n \"CreateTime\": \"2024-12-05\",\n \"Width\": 0,\n \"Height\": 0,\n \"BackgroundWidth\": 0,\n \"BackgroundHeight\": 0\n }\n ],\n \"RequestId\": \"98ceb7f4-61bd-473c-9381-59a0ed0c25b7\"\n }\n}", "title": "请求示例" } ], @@ -1092,7 +1092,7 @@ { "document": "批量获取日志URL。", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLogDownloadList\n<公共请求参数>\n\n{\n \"EndTime\": \"2019-03-12 12:00:00\",\n \"StartTime\": \"2019-03-12 00:00:00\",\n \"PlayDomains\": [\n \"5000.liveplay.com\"\n ]\n}", - "output": "{\n \"Response\": {\n \"LogInfoList\": [\n {\n \"LogName\": \"test\",\n \"LogUrl\": \"http://test.log.com\",\n \"LogTime\": \"2019-03-13 00:00:00\",\n \"FileSize\": 1000\n }\n ],\n \"TotalNum\": 1,\n \"RequestId\": \"8e50cdb5-56dc-408b-89b0-31818958d424\"\n }\n}", + "output": "{\n \"Response\": {\n \"LogInfoList\": [\n {\n \"LogName\": \"mylivelog\",\n \"LogUrl\": \"http://test.log.com\",\n \"LogTime\": \"2019-03-13 00:00:00\",\n \"FileSize\": 1000\n }\n ],\n \"TotalNum\": 1,\n \"RequestId\": \"8e50cdb5-56dc-408b-89b0-31818958d424\"\n }\n}", "title": "请求示例" } ], @@ -1100,7 +1100,7 @@ { "document": "调用该接口,返回7天内所有报告信息", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMonitorReport\n<公共请求参数>\n\n{\n \"MonitorId\": \"1bd5af00-5be5-4e4d-aa75-340ba0f35586\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"\",\n \"MPSResult\": {\n \"AiAsrResults\": [],\n \"AiOcrResults\": []\n },\n \"DiagnoseResult\": {\n \"StreamBrokenResults\": []\n }\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"\",\n \"MPSResult\": {\n \"AiAsrResults\": [],\n \"AiOcrResults\": [],\n \"StreamQuaCtrlResults\": []\n },\n \"DiagnoseResult\": {\n \"StreamBrokenResults\": [],\n \"StreamFormatResults\": [],\n \"LowFrameRateResults\": []\n }\n }\n}", "title": "查询某个监播报告" } ], @@ -1212,7 +1212,7 @@ { "document": "查询时移流录制详情", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTimeShiftRecordDetail\n<公共请求参数>\n\n{\n \"Domain\": \"5000.live.push.com\",\n \"AppName\": \"live\",\n \"StreamName\": \"livetest\",\n \"StartTime\": 1668064484,\n \"EndTime\": 1668064584,\n \"DomainGroup\": \"\",\n \"TransCodeId\": 330587\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"xxx\",\n \"RecordList\": [\n {\n \"Sid\": \"xxx\",\n \"StartTime\": 1668064484,\n \"EndTime\": 1668064584\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"27b51725-321e-4347-8906-4e1d94b5a373\",\n \"RecordList\": [\n {\n \"Sid\": \"2980018187870252785\",\n \"StartTime\": 1668064484,\n \"EndTime\": 1668064584\n }\n ]\n }\n}", "title": "DescribeTimeShiftRecordDetail" } ], @@ -1220,7 +1220,7 @@ { "document": "查询时移流列表", "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTimeShiftStreamList\n<公共请求参数>\n\n{\n \"StartTime\": 1668064484,\n \"EndTime\": 1668074484\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"xxx\",\n \"TotalSize\": 100,\n \"StreamList\": [\n {\n \"DomainGroup\": \"\",\n \"Domain\": \"5000.live.push.com\",\n \"AppName\": \"live\",\n \"StreamName\": \"livetest\",\n \"StartTime\": 1668064484,\n \"EndTime\": 1668064584,\n \"Duration\": 604800,\n \"TransCodeId\": 330587,\n \"StreamType\": 2\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"27b51725-321e-4347-8906-4e1d94b5a373\",\n \"TotalSize\": 100,\n \"StreamList\": [\n {\n \"DomainGroup\": \"\",\n \"Domain\": \"5000.live.push.com\",\n \"AppName\": \"live\",\n \"StreamName\": \"livetest\",\n \"StartTime\": 1668064484,\n \"EndTime\": 1668064584,\n \"Duration\": 604800,\n \"TransCodeId\": 330587,\n \"StreamType\": 2\n }\n ]\n }\n}", "title": "DescribeTimeShiftStreamList" } ], @@ -1299,7 +1299,7 @@ "ModifyCaster": [ { "document": "请求修改导播台信息", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCaster\n<公共请求参数>\n\n{\n \"RecordStatus\": \"1\",\n \"RecordTemplateId\": \"1\",\n \"CasterId\": \"10\",\n \"CasterName\": \"Modify Caster\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCaster\n<公共请求参数>\n\n{\n \"RecordStatus\": \"1\",\n \"RecordTemplateId\": \"1\",\n \"CasterId\": 63501,\n \"CasterName\": \"Modify Caster\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1307,7 +1307,7 @@ "ModifyCasterInputInfo": [ { "document": "将Index为1的输入源修改为一个导播台推流地址", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCasterInputInfo\n<公共请求参数>\n\n{\n \"InputInfo\": {\n \"Description\": \"modify example\",\n \"InputIndex\": \"1\",\n \"InputType\": \"0\",\n \"InputUrl\": \"rtmp://caster.push.example.com/live/example\"\n },\n \"CasterId\": \"10\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCasterInputInfo\n<公共请求参数>\n\n{\n \"InputInfo\": {\n \"Description\": \"modify example\",\n \"InputIndex\": \"1\",\n \"InputType\": \"0\",\n \"InputUrl\": \"rtmp://caster.push.example.com/live/example\"\n },\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\",\n \"InputPlayUrl\": \"http://play.example.com/live/example_stream_id\",\n \"InputWebRTCPlayUrl\": \"webrtc://webrtc.play.example.com/live/example_stream_id\"\n }\n}", "title": "请求示例" } @@ -1315,7 +1315,7 @@ "ModifyCasterLayoutInfo": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCasterLayoutInfo\n<公共请求参数>\n\n{\n \"LayoutInfo\": {\n \"LayoutIndex\": \"1\",\n \"InputIndexList\": \"2|3\",\n \"LayoutTemplateId\": \"20\"\n },\n \"CasterId\": \"1234\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCasterLayoutInfo\n<公共请求参数>\n\n{\n \"LayoutInfo\": {\n \"LayoutIndex\": \"1\",\n \"InputIndexList\": \"2|3\",\n \"LayoutTemplateId\": \"20\"\n },\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "修改模版20的布局使用的布局为输入2,输入3" } @@ -1323,7 +1323,7 @@ "ModifyCasterMarkPicInfo": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCasterMarkPicInfo\n<公共请求参数>\n\n{\n \"MarkPicInfo\": {\n \"MarkPicIndex\": 1,\n \"MarkPicHeight\": 0.3,\n \"MarkPicId\": 0,\n \"MarkPicLocationX\": 0.2,\n \"MarkPicLocationY\": 0.2,\n \"MarkPicWidth\": 0.3\n },\n \"CasterId\": 1234\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCasterMarkPicInfo\n<公共请求参数>\n\n{\n \"MarkPicInfo\": {\n \"MarkPicIndex\": 1,\n \"MarkPicHeight\": 0.3,\n \"MarkPicId\": 0,\n \"MarkPicLocationX\": 0.2,\n \"MarkPicLocationY\": 0.2,\n \"MarkPicWidth\": 0.3\n },\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1331,7 +1331,7 @@ "ModifyCasterMarkWordInfo": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCasterMarkWordInfo\n<公共请求参数>\n\n{\n \"CasterId\": 1234,\n \"MarkWordInfo\": {\n \"MarkWordIndex\": 1,\n \"MarkWordFontSize\": 18,\n \"MarkWordText\": \"Modify example\",\n \"MarkWordFontColor\": \"0x000033\",\n \"MarkWordLocationY\": 0.15,\n \"MarkWordLocationX\": 0.15,\n \"MarkWordFontType\": 2\n }\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCasterMarkWordInfo\n<公共请求参数>\n\n{\n \"CasterId\": 63501,\n \"MarkWordInfo\": {\n \"MarkWordIndex\": 1,\n \"MarkWordFontSize\": 18,\n \"MarkWordText\": \"Modify example\",\n \"MarkWordFontColor\": \"0x000033\",\n \"MarkWordLocationY\": 0.15,\n \"MarkWordLocationX\": 0.15,\n \"MarkWordFontType\": 2\n }\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1339,7 +1339,7 @@ "ModifyCasterOutputInfo": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCasterOutputInfo\n<公共请求参数>\n\n{\n \"CasterId\": \"1234\",\n \"OutputInfo\": {\n \"OutputIndex\": 1,\n \"OutputUrl\": \"rtmp://another.third.push.domain/live/another_stream_id\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCasterOutputInfo\n<公共请求参数>\n\n{\n \"CasterId\": 63501,\n \"OutputInfo\": {\n \"OutputIndex\": 1,\n \"OutputUrl\": \"rtmp://another.third.push.domain/live/another_stream_id\"\n }\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "修改Index为1的推流信息" } @@ -1347,7 +1347,7 @@ "ModifyLiveCallbackTemplate": [ { "document": "请求示例", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLiveCallbackTemplate\n<公共请求参数>\n\n{\n \"StreamBeginNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=streamBegin\",\n \"StreamEndNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=streamEnd\",\n \"TemplateName\": \"testName\",\n \"RecordNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=record\",\n \"SnapshotNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=snapshot\",\n \"TemplateId\": \"1000\",\n \"PornCensorshipNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=porn\",\n \"CallbackKey\": \"adasdas23432423\",\n \"Description\": \"test\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLiveCallbackTemplate\n<公共请求参数>\n\n{\n \"StreamBeginNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=streamBegin\",\n \"StreamEndNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=streamEnd\",\n \"TemplateName\": \"testName\",\n \"RecordNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=record\",\n \"SnapshotNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=snapshot\",\n \"TemplateId\": \"1000\",\n \"PornCensorshipNotifyUrl\": \"http://www.yourdomain.com/api/notify?action=porn\",\n \"CallbackKey\": \"adasdas23432423\",\n \"Description\": \"回调模板\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1371,7 +1371,7 @@ "ModifyLivePadTemplate": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLivePadTemplate\n<公共请求参数>\n\n{\n \"Description\": \"xx\",\n \"TemplateName\": \"xx\",\n \"Url\": \"xx\",\n \"WaitDuration\": 1,\n \"TemplateId\": 1,\n \"MaxDuration\": 1\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLivePadTemplate\n<公共请求参数>\n\n{\n \"Description\": \"padtemplate\",\n \"TemplateName\": \"mytemplate\",\n \"Url\": \"http://mypad.file.com/pad/file.mp4\",\n \"WaitDuration\": 1,\n \"TemplateId\": 1,\n \"MaxDuration\": 1\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1379,7 +1379,7 @@ "ModifyLivePlayAuthKey": [ { "document": "", - "input": "https://live.tencentcloudapi.com/?Action=ModifyLivePlayAuthKey\r\n&DomainName=5000.livepush.myqcloud.com\r\n&Enable=0\r\n&AuthKey=xxxx\r\n&AuthDelta=300\r\n&AuthBackKey=xxxx\r\n&<公共请求参数>", + "input": "https://live.tencentcloudapi.com/?Action=ModifyLivePlayAuthKey\n&DomainName=5000.livepush.myqcloud.com\n&Enable=0\n&AuthKey=AKID0QJ82oYdLJ\n&AuthDelta=300\n&AuthBackKey=IgAQlbPUl5VIKKFB1KazNB\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1411,7 +1411,7 @@ "ModifyLiveRecordTemplate": [ { "document": "", - "input": "https://live.tencentcloudapi.com/?Action=ModifyLiveRecordTemplate\n&TemplateName=templat\n&Description=test\n&FlvParam.Enable=1\n&FlvParam.RecordInterval=1800\n&FlvParam.StorageTime=700\n&TemplateId=1000\n&<公共请求参数>", + "input": "https://live.tencentcloudapi.com/?Action=ModifyLiveRecordTemplate\n&TemplateName=templat\n&Description=record\n&FlvParam.Enable=1\n&FlvParam.RecordInterval=1800\n&FlvParam.StorageTime=700\n&TemplateId=1000\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1419,15 +1419,15 @@ "ModifyLiveSnapshotTemplate": [ { "document": "更新截图鉴黄模板配置。", - "input": "{\n \"TemplateId\": 0,\n \"TemplateName\": \"xx\",\n \"Description\": \"xx\",\n \"SnapshotInterval\": 0,\n \"Width\": 0,\n \"Height\": 0,\n \"PornFlag\": 0,\n \"CosAppId\": 0,\n \"CosBucket\": \"xx\",\n \"CosRegion\": \"xx\",\n \"CosPrefix\": \"xx\",\n \"CosFileName\": \"xx\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"xx\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLiveSnapshotTemplate\n<公共请求参数>\n\n{\n \"TemplateId\": 0,\n \"TemplateName\": \"mytemplate\",\n \"Description\": \"模板\",\n \"SnapshotInterval\": 0,\n \"Width\": 0,\n \"Height\": 0,\n \"PornFlag\": 0,\n \"CosAppId\": 0,\n \"CosBucket\": \"sfjjsidexample\",\n \"CosRegion\": \"ap-beijing\",\n \"CosPrefix\": \"live\",\n \"CosFileName\": \"myfilename\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"1047d0dc-6dc8-4898-a7f3-03726a822b0e\"\n }\n}", "title": "ModifyLiveSnapshotTemplate" } ], "ModifyLiveStreamMonitor": [ { "document": "用户修改监播场次配置参数。", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLiveStreamMonitor\n<公共请求参数>\n\n{\n \"MonitorId\": \"abc\",\n \"MonitorName\": \"abc\",\n \"OutputInfo\": {\n \"OutputStreamName\": \"abc\",\n \"OutputStreamWidth\": 1,\n \"OutputStreamHeight\": 1,\n \"OutputDomain\": \"abc\",\n \"OutputApp\": \"abc\"\n },\n \"InputList\": [\n {\n \"InputStreamName\": \"abc\",\n \"InputDomain\": \"abc\",\n \"InputApp\": \"abc\",\n \"InputUrl\": \"abc\",\n \"Description\": \"abc\"\n }\n ],\n \"NotifyPolicy\": {\n \"NotifyPolicyType\": 1,\n \"CallbackUrl\": \"abc\"\n },\n \"AsrLanguage\": 1,\n \"OcrLanguage\": 1,\n \"AiAsrInputIndexList\": [\n 1\n ],\n \"AiOcrInputIndexList\": [\n 1\n ],\n \"CheckStreamBroken\": 1,\n \"CheckStreamLowFrameRate\": 1,\n \"AllowMonitorReport\": 1\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLiveStreamMonitor\n<公共请求参数>\n\n{\n \"MonitorId\": \"caster-124\",\n \"MonitorName\": \"caster-124\",\n \"OutputInfo\": {\n \"OutputStreamName\": \"stream1\",\n \"OutputStreamWidth\": 1,\n \"OutputStreamHeight\": 1,\n \"OutputDomain\": \"\",\n \"OutputApp\": \"live\"\n },\n \"InputList\": [\n {\n \"InputStreamName\": \"stream2\",\n \"InputDomain\": \"live.monitor.push.com\",\n \"InputApp\": \"live\",\n \"InputUrl\": \"rtmp://live.monitor.push.com/live/stream1\",\n \"Description\": \"stream 1\"\n }\n ],\n \"NotifyPolicy\": {\n \"NotifyPolicyType\": 1,\n \"CallbackUrl\": \"www.baidu.com\"\n },\n \"AsrLanguage\": 1,\n \"OcrLanguage\": 1,\n \"AiAsrInputIndexList\": [\n 1\n ],\n \"AiOcrInputIndexList\": [\n 1\n ],\n \"CheckStreamBroken\": 1,\n \"CheckStreamLowFrameRate\": 1,\n \"AllowMonitorReport\": 1\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"ff29075a-ef7a-4742-9268-f7a1980dafc5\"\n }\n}", "title": "修改直播流监播任务" } @@ -1435,7 +1435,7 @@ "ModifyLiveTimeShiftTemplate": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLiveTimeShiftTemplate\n<公共请求参数>\n\n{\n \"Description\": \"xx\",\n \"TranscodeTemplateIds\": [\n 0\n ],\n \"RemoveWatermark\": true,\n \"TemplateName\": \"xx\",\n \"ItemDuration\": 1,\n \"TemplateId\": 1,\n \"Duration\": 1,\n \"Area\": \"xx\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLiveTimeShiftTemplate\n<公共请求参数>\n\n{\n \"TemplateId\": 1,\n \"TemplateName\": \"timeshift\",\n \"Description\": \"timeshift\",\n \"Duration\": 1,\n \"ItemDuration\": 1,\n \"RemoveWatermark\": true,\n \"TranscodeTemplateIds\": [\n 0\n ],\n \"Area\": \"0\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1443,7 +1443,7 @@ "ModifyLiveTranscodeTemplate": [ { "document": "ModifyLiveTranscodeTemplate 例子。", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLiveTranscodeTemplate\n<公共请求参数>\n\n{\n \"Profile\": \"main\",\n \"AudioBitrate\": \"600\",\n \"Rotate\": \"0\",\n \"Description\": \"test\",\n \"VideoBitrate\": \"1500\",\n \"Vcodec\": \"h265\",\n \"Height\": \"240\",\n \"Width\": \"250\",\n \"NeedAudio\": \"1\",\n \"FpsToOrig\": \"0\",\n \"Fps\": \"30\",\n \"TemplateId\": \"1001\",\n \"BitrateToOrig\": \"0\",\n \"HeightToOrig\": \"0\",\n \"NeedVideo\": \"1\",\n \"Gop\": \"3\",\n \"Acodec\": \"aac\"\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLiveTranscodeTemplate\n<公共请求参数>\n\n{\n \"Profile\": \"main\",\n \"AudioBitrate\": \"600\",\n \"Rotate\": \"0\",\n \"Description\": \"transcode\",\n \"VideoBitrate\": \"1500\",\n \"Vcodec\": \"h265\",\n \"Height\": \"240\",\n \"Width\": \"250\",\n \"NeedAudio\": \"1\",\n \"FpsToOrig\": \"0\",\n \"Fps\": \"30\",\n \"TemplateId\": \"1001\",\n \"BitrateToOrig\": \"0\",\n \"HeightToOrig\": \"0\",\n \"NeedVideo\": \"1\",\n \"Gop\": \"3\",\n \"Acodec\": \"aac\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1467,7 +1467,7 @@ "ReleaseCaster": [ { "document": "释放导播台", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ReleaseCaster\n<公共请求参数>\n\n{\n \"CasterId\": 1234\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ReleaseCaster\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1507,7 +1507,7 @@ "StopCasterPgm": [ { "document": "停止主监任务", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StopCasterPgm\n<公共请求参数>\n\n{\n \"CasterId\": 1234\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StopCasterPgm\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1515,7 +1515,7 @@ "StopCasterPvw": [ { "document": "停止预监任务", - "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StopCasterPvw\n<公共请求参数>\n\n{\n \"CasterId\": 1234\n}", + "input": "POST / HTTP/1.1\nHost: live.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StopCasterPvw\n<公共请求参数>\n\n{\n \"CasterId\": 63501\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } @@ -1579,7 +1579,7 @@ "UpdateLiveWatermark": [ { "document": "更新水印", - "input": "https://live.tencentcloudapi.com/?Action=UpdateLiveWatermark\n&WatermarkId=123\n&PictureUrl=http://watermark-10005041.cos.myqcloud.com/1251830167/watermark_img_Alogo.png\n&XPosition=80\n&YPosition=10\n&WatermarkName=logo\n&<公共请求参数>", + "input": "https://live.tencentcloudapi.com/?Action=UpdateLiveWatermark\n&WatermarkId=452356\n&PictureUrl=http://watermark-10005041.cos.myqcloud.com/1251830167/watermark_img_Alogo.png\n&XPosition=80\n&YPosition=10\n&WatermarkName=logo\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}", "title": "请求示例" } diff --git a/tccli/services/mna/v20210119/api.json b/tccli/services/mna/v20210119/api.json index 15f9f7eab1..2770f5622e 100644 --- a/tccli/services/mna/v20210119/api.json +++ b/tccli/services/mna/v20210119/api.json @@ -43,11 +43,11 @@ "status": "online" }, "CreateQos": { - "document": "移动网络发起Qos加速过程", + "document": "产品下线\n\n移动网络发起Qos加速过程", "input": "CreateQosRequest", "name": "发起Qos加速过程", "output": "CreateQosResponse", - "status": "online" + "status": "deprecated" }, "DeleteDevice": { "document": "删除设备信息", @@ -71,18 +71,18 @@ "status": "online" }, "DeleteQos": { - "document": "移动网络停止Qos加速过程", + "document": "产品下线\n\n移动网络停止Qos加速过程", "input": "DeleteQosRequest", "name": "停止Qos加速过程", "output": "DeleteQosResponse", - "status": "online" + "status": "deprecated" }, "DescribeQos": { - "document": "获取Qos加速状态", + "document": "产品下线\n\n获取Qos加速状态", "input": "DescribeQosRequest", "name": "获取Qos加速状态", "output": "DescribeQosResponse", - "status": "online" + "status": "deprecated" }, "GetDevice": { "document": "通过指定设备的ID查找设备详细信息", @@ -301,7 +301,7 @@ { "disabled": false, "document": "厂商名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxx", + "example": "vendor1", "member": "string", "name": "Vendor", "output_required": true, @@ -312,7 +312,7 @@ { "disabled": false, "document": "设备SN序列号", - "example": "xxx", + "example": "AN", "member": "string", "name": "SN", "output_required": true, @@ -323,7 +323,7 @@ { "disabled": false, "document": "设备名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxx", + "example": "mna-w795bzezug", "member": "string", "name": "DeviceName", "output_required": true, @@ -334,7 +334,7 @@ { "disabled": false, "document": "备注\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxx", + "example": "test", "member": "string", "name": "Description", "output_required": true, @@ -378,7 +378,7 @@ { "disabled": false, "document": "设备分组ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxx", + "example": "cliGrp-xf8rboasbh", "member": "string", "name": "GroupId", "output_required": false, @@ -389,7 +389,7 @@ { "disabled": false, "document": "设备分组名称,预留参数,需要分组时传入GroupId\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxx", + "example": "group-name", "member": "string", "name": "GroupName", "output_required": false, @@ -411,7 +411,7 @@ { "disabled": false, "document": "激活后的设备ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "mna-xxxxxx", + "example": "mna-w795bzezug", "member": "string", "name": "DeviceId", "output_required": false, @@ -1187,7 +1187,7 @@ { "disabled": false, "document": "设备唯一ID", - "example": "\"mna-xxx\"", + "example": "\"mna-2x2tllhb18\"", "member": "string", "name": "DeviceId", "output_required": true, @@ -1197,7 +1197,7 @@ { "disabled": false, "document": "设备名称", - "example": "\"xxx\"", + "example": "\"mna-2x2tllhb18\"", "member": "string", "name": "DeviceName", "output_required": true, @@ -1227,7 +1227,7 @@ { "disabled": false, "document": "设备的备注", - "example": "\"xxx\"", + "example": "\"test\"", "member": "string", "name": "Remark", "output_required": true, @@ -1267,7 +1267,7 @@ { "disabled": false, "document": "设备分组ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"xxx\"", + "example": "\"cliGrp-xf8rboasbh\"", "member": "string", "name": "GroupId", "output_required": true, @@ -1277,7 +1277,7 @@ { "disabled": false, "document": "设备分组名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"xxx\"", + "example": "\"cliGrp-xf8rboasbh\"", "member": "string", "name": "GroupName", "output_required": true, @@ -1297,7 +1297,7 @@ { "disabled": false, "document": "设备sn\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"123\"", + "example": "\"AN\"", "member": "string", "name": "Sn", "output_required": false, @@ -1307,7 +1307,7 @@ { "disabled": false, "document": "厂商\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"abc\"", + "example": "\"vendor\"", "member": "string", "name": "Vendor", "output_required": false, diff --git a/tccli/services/mps/v20190612/api.json b/tccli/services/mps/v20190612/api.json index 5bebe5b189..fa6c703aa4 100644 --- a/tccli/services/mps/v20190612/api.json +++ b/tccli/services/mps/v20190612/api.json @@ -26241,6 +26241,46 @@ "output_required": false, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "直播拆条用,音频url。", + "example": "无", + "member": "string", + "name": "AudioUrl", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "直播拆条用,音频对应起始时间戳;", + "example": "3.438", + "member": "float", + "name": "AudioBeginTime", + "output_required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "直播拆条用,音频对应结束时间戳。", + "example": "7.438", + "member": "float", + "name": "AudioEndTime", + "output_required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "直播拆条用,人物位置参考信息用于横转竖。", + "example": "无", + "member": "string", + "name": "PersonPositionUrl", + "output_required": false, + "type": "string", + "value_allowed_null": false } ], "usage": "out" diff --git a/tccli/services/oceanus/v20190422/api.json b/tccli/services/oceanus/v20190422/api.json index 86f5f084f2..38477338fc 100644 --- a/tccli/services/oceanus/v20190422/api.json +++ b/tccli/services/oceanus/v20190422/api.json @@ -908,6 +908,46 @@ "output_required": false, "type": "int", "value_allowed_null": false + }, + { + "disabled": false, + "document": "总的CPU", + "example": "0", + "member": "float", + "name": "TotalCpu", + "output_required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "总的内存", + "example": "0", + "member": "float", + "name": "TotalMem", + "output_required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "运行的CPU", + "example": "0", + "member": "float", + "name": "RunningCpu", + "output_required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "运行的内存", + "example": "0", + "member": "float", + "name": "RunningMem", + "output_required": false, + "type": "float", + "value_allowed_null": false } ], "usage": "out" @@ -1124,6 +1164,46 @@ "output_required": false, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "TotalCpu", + "example": "0", + "member": "float", + "name": "TotalCpu", + "output_required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "TotalMem", + "example": "0", + "member": "float", + "name": "TotalMem", + "output_required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "RunningCpu", + "example": "0", + "member": "float", + "name": "RunningCpu", + "output_required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "RunningMem", + "example": "0", + "member": "float", + "name": "RunningMem", + "output_required": false, + "type": "float", + "value_allowed_null": false } ], "usage": "out" @@ -1934,6 +2014,42 @@ "name": "FlinkVersion", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "JobManager cpu", + "example": "1", + "member": "float", + "name": "JobManagerCpu", + "required": false, + "type": "float" + }, + { + "disabled": false, + "document": "JobManager 内存", + "example": "1", + "member": "float", + "name": "JobManagerMem", + "required": false, + "type": "float" + }, + { + "disabled": false, + "document": "TaskManager cpu", + "example": "1", + "member": "float", + "name": "TaskManagerCpu", + "required": false, + "type": "float" + }, + { + "disabled": false, + "document": "TaskManager 内存", + "example": "1", + "member": "float", + "name": "TaskManagerMem", + "required": false, + "type": "float" } ], "type": "object" @@ -2601,7 +2717,7 @@ "example": "true", "member": "bool", "name": "Delete", - "required": true, + "output_required": true, "type": "bool", "value_allowed_null": false }, @@ -3654,6 +3770,15 @@ "name": "WorkSpaceId", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "资源类型,0=用户,1系统connector,2=用户自定义connector", + "example": "1", + "member": "uint64", + "name": "SystemResource", + "required": false, + "type": "int" } ], "type": "object" @@ -3746,6 +3871,15 @@ "name": "FlinkVersion", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "空间", + "example": "space-123qew", + "member": "string", + "name": "WorkSpaceId", + "required": false, + "type": "string" } ], "type": "object" @@ -4860,6 +4994,56 @@ "output_required": false, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "jm使用cpu数目\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "1", + "member": "float", + "name": "JobManagerCpu", + "output_required": false, + "type": "float", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "jm使用内存数目\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "1", + "member": "float", + "name": "JobManagerMem", + "output_required": false, + "type": "float", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "tm使用cpu数\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "2", + "member": "float", + "name": "TaskManagerCpu", + "output_required": false, + "type": "float", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "tm使用mem数\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "2", + "member": "float", + "name": "TaskManagerMem", + "output_required": false, + "type": "float", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "运行中配置\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "无", + "member": "JobConfig", + "name": "JobConfigItem", + "output_required": false, + "type": "object", + "value_allowed_null": true } ], "usage": "out" @@ -5472,7 +5656,7 @@ { "disabled": false, "document": "使用内存数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无1", + "example": "1", "member": "float", "name": "RunningMem", "output_required": false, @@ -6072,7 +6256,7 @@ "example": "\"test\"", "member": "string", "name": "ResourceId", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -6082,7 +6266,7 @@ "example": "\"test\"", "member": "string", "name": "Name", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -6092,7 +6276,7 @@ "example": "0", "member": "uint64", "name": "ResourceType", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -6102,7 +6286,7 @@ "example": "0", "member": "ResourceLoc", "name": "ResourceLoc", - "required": false, + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -6112,7 +6296,7 @@ "example": "\"test\"", "member": "string", "name": "Region", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -6122,7 +6306,7 @@ "example": "0", "member": "uint64", "name": "AppId", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -6132,7 +6316,7 @@ "example": "\"test\"", "member": "string", "name": "OwnerUin", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -6142,7 +6326,7 @@ "example": "\"test\"", "member": "string", "name": "CreatorUin", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -6152,7 +6336,7 @@ "example": "\"test\"", "member": "string", "name": "CreateTime", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -6162,7 +6346,7 @@ "example": "\"test\"", "member": "string", "name": "UpdateTime", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -6172,7 +6356,7 @@ "example": "0", "member": "int64", "name": "LatestResourceConfigVersion", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -6182,7 +6366,7 @@ "example": "\"test\"", "member": "string", "name": "Remark", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -6192,7 +6376,7 @@ "example": "0", "member": "int64", "name": "VersionCount", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -6202,19 +6386,19 @@ "example": "0", "member": "int64", "name": "RefJobCount", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, - "document": "作业运行状态\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "作业运行状态", "example": "0", "member": "int64", "name": "IsJobRun", - "required": false, + "output_required": false, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -6222,7 +6406,7 @@ "example": "\"test\"", "member": "string", "name": "FileName", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -6232,7 +6416,7 @@ "example": "0", "member": "int64", "name": "WorkSpaceId", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -6242,9 +6426,79 @@ "example": "无", "member": "RefJobStatusCountItem", "name": "RefJobStatusCountSet", - "required": false, + "output_required": true, "type": "list", "value_allowed_null": true + }, + { + "disabled": false, + "document": "连接器名称", + "example": "mysql", + "member": "string", + "name": "Connector", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "连接器版本", + "example": "1.1", + "member": "string", + "name": "ConnectorVersion", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "连接方式", + "example": "1", + "member": "string", + "name": "ConnectionMethod", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "connector关联的资源id", + "example": "\"test\"", + "member": "string", + "name": "RelatedResourceId", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "图标", + "example": "\"test\"", + "member": "string", + "name": "Icon", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "连接器中文名", + "example": "\"Kafka\"", + "member": "string", + "name": "ConnectorName", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "连接器官网链接", + "example": "\"test\"", + "member": "string", + "name": "ConnectorUrl", + "output_required": false, + "type": "string", + "value_allowed_null": false } ], "usage": "out" @@ -6353,52 +6607,62 @@ { "disabled": false, "document": "资源id", - "example": "", + "example": "无", "member": "string", "name": "ResourceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "资源版本,-1表示使用最新版本", - "example": "", + "example": "无", "member": "int64", "name": "Version", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "资源名称", - "example": "", + "example": "无", "member": "string", "name": "Name", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "1: 主资源", - "example": "", + "example": "无", "member": "int64", "name": "Type", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "1: 系统内置资源", - "example": "", + "example": "无", "member": "int64", "name": "SystemProvide", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false + }, + { + "disabled": false, + "document": "Connector", + "example": "kafka", + "member": "string", + "name": "Connector", + "output_required": false, + "type": "string", + "value_allowed_null": false } ], "usage": "out" @@ -7209,6 +7473,26 @@ "output_required": false, "type": "list", "value_allowed_null": true + }, + { + "disabled": false, + "document": "Cpu", + "example": "0", + "member": "float", + "name": "Cpu", + "output_required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "Mem", + "example": "0", + "member": "float", + "name": "Mem", + "output_required": false, + "type": "float", + "value_allowed_null": false } ], "usage": "out" @@ -7368,6 +7652,50 @@ "required": false, "type": "float", "value_allowed_null": true + }, + { + "disabled": false, + "document": "总的CPU", + "example": "0", + "member": "float", + "name": "TotalCpu", + "output_required": false, + "required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "总的内存", + "example": "0", + "member": "float", + "name": "TotalMem", + "output_required": false, + "required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "运行的CPU", + "example": "0", + "member": "float", + "name": "RunningCpu", + "output_required": false, + "required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "运行的内存", + "example": "0", + "member": "float", + "name": "RunningMem", + "output_required": false, + "required": false, + "type": "float", + "value_allowed_null": false } ], "usage": "both" @@ -7407,7 +7735,7 @@ "example": "resource-9ds0xim0", "member": "string", "name": "ResourceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -7417,7 +7745,7 @@ "example": "SampleProgram", "member": "string", "name": "Name", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -7427,7 +7755,7 @@ "example": "1", "member": "int64", "name": "ResourceType", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -7437,7 +7765,7 @@ "example": "我的测试程序包", "member": "string", "name": "Remark", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -7447,7 +7775,7 @@ "example": "ap-guangzhou", "member": "string", "name": "Region", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -7457,7 +7785,17 @@ "example": "2", "member": "int64", "name": "LatestResourceConfigVersion", - "required": true, + "output_required": true, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "1 是系统提供资源 2 用户提供CONNECTOR", + "example": "1", + "member": "int64", + "name": "SystemProvide", + "output_required": false, "type": "int", "value_allowed_null": false } @@ -7534,7 +7872,7 @@ { "disabled": false, "document": "作业名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxx", + "example": "sql1", "member": "string", "name": "Name", "output_required": true, @@ -7570,6 +7908,36 @@ "output_required": true, "type": "int", "value_allowed_null": true + }, + { + "disabled": false, + "document": "0:代表没开启调优任务,1:开启智能调优,2:代表定时调优\n\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "1", + "member": "int64", + "name": "ScalingType", + "output_required": false, + "type": "int", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "RunningCpu", + "example": "0", + "member": "float", + "name": "RunningCpu", + "output_required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "RunningMem", + "example": "0", + "member": "float", + "name": "RunningMem", + "output_required": false, + "type": "float", + "value_allowed_null": false } ], "usage": "out" diff --git a/tccli/services/oceanus/v20190422/examples.json b/tccli/services/oceanus/v20190422/examples.json index 79dd3b7e02..98927a1df6 100644 --- a/tccli/services/oceanus/v20190422/examples.json +++ b/tccli/services/oceanus/v20190422/examples.json @@ -122,7 +122,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: oceanus.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteWorkSpace\n<公共请求参数>\n\n{\n \"WorkSpaceId\": \"space-1327\"\n}", - "output": "{\n \"Response\": {\n \"Delete\": true,\n \"RequestId\": \"xx\"\n }\n}", + "output": "{\n \"Response\": {\n \"Delete\": true,\n \"RequestId\": \"a123\"\n }\n}", "title": "删除空间" } ], diff --git a/tccli/services/ocr/v20181119/api.json b/tccli/services/ocr/v20181119/api.json index d1ff146e52..264cd88abd 100644 --- a/tccli/services/ocr/v20181119/api.json +++ b/tccli/services/ocr/v20181119/api.json @@ -19143,6 +19143,56 @@ "output_required": true, "type": "string", "value_allowed_null": false + }, + { + "disabled": false, + "document": "价税合计(大写)前符号", + "example": "无", + "member": "string", + "name": "TotalCnMark", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "价税合计(小写)前字样", + "example": "无", + "member": "string", + "name": "TotalMark", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "合计金额前字样", + "example": "无", + "member": "string", + "name": "PretaxAmountMark", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "合计税额前字样", + "example": "无", + "member": "string", + "name": "TaxMark", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "是否有公司印章(0:没有,1:有)", + "example": "1", + "member": "int64", + "name": "CompanySealMark", + "output_required": true, + "type": "int", + "value_allowed_null": false } ], "usage": "out" diff --git a/tccli/services/sqlserver/v20180328/api.json b/tccli/services/sqlserver/v20180328/api.json index d8d404ad9a..d778588ae9 100644 --- a/tccli/services/sqlserver/v20180328/api.json +++ b/tccli/services/sqlserver/v20180328/api.json @@ -463,7 +463,7 @@ "status": "online" }, "DescribeInstanceTradeParameter": { - "document": "本接口(DescribeInstanceTradeParameter)用于查询实例的计费参数,当前接口默认返回创建实例时需要的计费参数。内部接口用于活动页售卖场景。", + "document": "本接口(DescribeInstanceTradeParameter)用于查询实例的计费参数", "input": "DescribeInstanceTradeParameterRequest", "name": "查询实例的计费参数", "output": "DescribeInstanceTradeParameterResponse", @@ -1059,7 +1059,7 @@ { "disabled": false, "document": "实例密码", - "example": "无", + "example": "Zh22448899", "member": "string", "name": "Password", "required": false, @@ -1068,7 +1068,7 @@ { "disabled": false, "document": "DB权限列表", - "example": "无", + "example": "[{\"DBName\": \"db1\",\"Privilege\": \"ReadOnly\"}]", "member": "DBPrivilege", "name": "DBPrivileges", "required": false, @@ -1077,7 +1077,7 @@ { "disabled": false, "document": "账号备注信息", - "example": "无", + "example": "andy", "member": "string", "name": "Remark", "required": false, @@ -1118,6 +1118,15 @@ "name": "IsCam", "required": false, "type": "bool" + }, + { + "disabled": false, + "document": "加密密钥版本号,0表示不使用加密", + "example": "0", + "member": "int64", + "name": "EncryptedVersion", + "required": false, + "type": "int" } ], "usage": "in" @@ -1264,22 +1273,29 @@ { "disabled": false, "document": "用户名", - "example": "", + "example": "andy", "member": "string", "name": "UserName", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "密码", - "example": "", + "example": "Zh22448899", "member": "string", "name": "Password", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" + }, + { + "disabled": false, + "document": "加密密钥版本号,0表示不使用加密", + "example": "0", + "member": "int64", + "name": "EncryptedVersion", + "required": false, + "type": "int" } ], "usage": "in" @@ -1884,13 +1900,13 @@ "members": [ { "disabled": false, - "document": "检查项目名称,CK_CPU-变配后CPU风险检查;CK_MASTER_STORAGE-只读副本变配下,只读副本磁盘空间不小于主实例空间检查;CK_MEMORY-变配后内存风险检查;CK_STORAGE-变配后磁盘空间风险检查;CK_UPGRATE-变配是否需要迁移检查;\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "检查项目名称,CK_CPU-变配后CPU风险检查;CK_MASTER_STORAGE-只读副本变配下,只读副本磁盘空间不小于主实例空间检查;CK_MEMORY-变配后内存风险检查;CK_STORAGE-变配后磁盘空间风险检查;CK_UPGRATE-变配是否需要迁移检查;", "example": "CK_CPU", "member": "string", "name": "CheckName", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -1898,7 +1914,7 @@ "example": "0", "member": "string", "name": "CurrentValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1908,7 +1924,7 @@ "example": "0", "member": "int64", "name": "Passed", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -1918,7 +1934,7 @@ "example": "0", "member": "int64", "name": "IsAffect", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -1928,7 +1944,7 @@ "example": "0", "member": "string", "name": "Msg", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1938,7 +1954,7 @@ "example": "0", "member": "int64", "name": "MsgCode", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -2702,23 +2718,23 @@ }, { "disabled": false, - "document": "流程ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "流程ID", "example": "100546", "member": "int64", "name": "FlowId", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例ID集合\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例ID集合", "example": "mssqlbi-bej23trh", "member": "string", "name": "InstanceIdSet", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -4458,7 +4474,7 @@ { "disabled": false, "document": "实例所在私有网络ID,基础网络时为 0", - "example": "12345", + "example": "3834195", "member": "int64", "name": "VpcId", "output_required": true, @@ -4607,7 +4623,7 @@ }, { "disabled": false, - "document": "实例高可用, 1-双机高可用,2-单机,3-跨可用区,4-集群跨可用区,5-集群,9-自研机房", + "document": "实例高可用, 1-双机高可用,2-单机,3-跨可用区,4-集群跨可用区,5-集群,6-多节点集群,7-多节点集群跨可用区,9-自研机房", "example": "1", "member": "int64", "name": "Model", @@ -4727,48 +4743,48 @@ }, { "disabled": false, - "document": "实例隔离操作\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "实例隔离操作", "example": "User", "member": "string", "name": "IsolateOperator", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "发布订阅标识,SUB-订阅实例,PUB-发布实例,空值-没有发布订阅的普通实例\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "发布订阅标识,SUB-订阅实例,PUB-发布实例,空值-没有发布订阅的普通实例", "example": "SUB", "member": "string", "name": "SubFlag", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "只读标识,RO-只读实例,MASTER-有RO实例的主实例,空值-没有只读组的非RO实例\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "只读标识,RO-只读实例,MASTER-有RO实例的主实例,空值-没有只读组的非RO实例", "example": "MASTER", "member": "string", "name": "ROFlag", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "容灾类型,MIRROR-镜像,ALWAYSON-AlwaysOn, SINGLE-单例\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "容灾类型,MIRROR-镜像,ALWAYSON-AlwaysOn, SINGLE-单例", "example": "MIRROR", "member": "string", "name": "HAFlag", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, "document": "实例绑定的标签列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "0", + "example": "['Tag1']", "member": "ResourceTag", "name": "ResourceTags", "output_required": true, @@ -4777,23 +4793,23 @@ }, { "disabled": false, - "document": "备份模式,master_pkg-主节点打包备份(默认) ;master_no_pkg-主节点不打包备份;slave_pkg-从节点打包备份(always on集群有效);slave_no_pkg-从节点不打包备份(always on集群有效);只读副本对该值无效。\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "备份模式,master_pkg-主节点打包备份(默认) ;master_no_pkg-主节点不打包备份;slave_pkg-从节点打包备份(always on集群有效);slave_no_pkg-从节点不打包备份(always on集群有效);只读副本对该值无效。", "example": "master_pkg", "member": "string", "name": "BackupModel", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "实例备份信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "test", + "document": "实例备份信息", + "example": "instance note", "member": "string", "name": "InstanceNote", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -4827,7 +4843,7 @@ }, { "disabled": false, - "document": "实例类型 HA-高可用 RO-只读实例 SI-基础版 BI-商业智能服务", + "document": "实例类型 HA-高可用,RO-只读实例,SI-基础版,BI-商业智能服务,cvmHA-云盘高可用,cvmRO-云盘只读实例,MultiHA-多节点,cvmMultiHA-云盘多节点\n", "example": "HA", "member": "string", "name": "InstanceType", @@ -4917,33 +4933,43 @@ }, { "disabled": false, - "document": "备可用区信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{}", + "document": "双节点实例备可用区信息", + "example": "[{\"SlaveZone\": \"ap-guangzhou-1\",\"SlaveZoneName\": \"广州一区\",\"DrInstanceId\": \"mssqldr-9ji781\"}]", "member": "SlaveZones", "name": "SlaveZones", "output_required": true, "type": "object", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "架构标识,SINGLE-单节点 DOUBLE-双节点\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "架构标识,SINGLE-单节点 DOUBLE-双节点", "example": "DOUBLE", "member": "string", "name": "Architecture", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "类型标识,EXCLUSIVE-独享型,SHARED-共享型\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "类型标识,EXCLUSIVE-独享型,SHARED-共享型", "example": "EXCLUSIVE", "member": "string", "name": "Style", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false + }, + { + "disabled": false, + "document": "多节点实例备可用区信息", + "example": "[{\"SlaveZone\": \"ap-guangzhou-2\",\"SlaveZoneName\": \"广州二区\",\"DrInstanceId\": \"mssqldr-9ji782\"}]", + "member": "SlaveZones", + "name": "MultiSlaveZones", + "output_required": true, + "type": "list", + "value_allowed_null": false } ], "usage": "out" @@ -5363,13 +5389,13 @@ }, { "disabled": false, - "document": "是否全文启用 0:否 1:是\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否全文启用 0:否 1:是", "example": "0", "member": "string", "name": "IsFullTextEnabled", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -6150,7 +6176,7 @@ { "disabled": false, "document": "内网下载地址,对于单库备份文件只返回第一条记录的内网下载地址;单库备份文件需要通过DescribeBackupFiles接口获取全部记录的下载地址", - "example": "https://cosback-appid.cos.ap-guangzhou.myqcloud.com/appid%2fsqlserver%2fmssql-mgq355n0%2fbackup%2fautoed_instance_58037_20200728011545.bak.tar?sign=q-sign-algorithm%3dsha1%26q-ak%3d*************************%3b1596177266%26q-key-time%3d1596176966%3b1596177266%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3d3ea8139b631fa13d54b2c03313cbf3850d1e0c2c", + "example": "https://cosback-appid.cos.ap-guangzhou.myqcloud.com/autoed_ins1545.bak.tar?sign=%3d3ea813", "member": "string", "name": "InternalAddr", "output_required": true, @@ -6160,7 +6186,7 @@ { "disabled": false, "document": "外网下载地址,对于单库备份文件只返回第一条记录的外网下载地址;单库备份文件需要通过DescribeBackupFiles接口获取全部记录的下载地址", - "example": "https://cosback-appid.cos.ap-guangzhou.myqcloud.com/appid%2fsqlserver%2fmssql-mgq355n0%2fbackup%2fautoed_instance_58037_20200728011545.bak.tar?sign=q-sign-algorithm%3dsha1%26q-ak%3d*************************%26q-sign-time%3d1596176966%3b1596177266%26q-key-time%3d1596176966%3b1596177266%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3d3ea8139b631fa13d54b2c03313cbf3850d1e0c2c", + "example": "https://cosback-appid.cos.ap-guangzhou.myqcloud.com/autoed_ins1545.bak.tar?sign=%3d3ea813", "member": "string", "name": "ExternalAddr", "output_required": true, @@ -8840,13 +8866,13 @@ "members": [ { "disabled": false, - "document": "计费参数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": " \"{\\\"uin\\\":\\\"2919041563\\\",\\\"ownerUin\\\":\\\"2919041563\\\",\\\"resInfo\\\":[{\\\"goodsCategoryId\\\":1025890,\\\"goodsNum\\\":1,\\\"payMode\\\":1,\\\"regionId\\\":1,\\\"zoneId\\\":100006,\\\"goodsDetail\\\":{\\\"pid\\\":1019180,\\\"productCode\\\":\\\"p_sqlserver\\\",\\\"subProductCode\\\":\\\"sp_sqlserver_dual_exclusive_cloud\\\",\\\"timeSpan\\\":1,\\\"timeUnit\\\":\\\"m\\\",\\\"goodsSubType\\\":\\\"sp_sqlserver_dual_exclusive_cloud\\\",\\\"sv_sqlserver_cpu_dual_exclusive_cloud_enterprise\\\":2,\\\"sv_sqlserver_cpu_dual_exclusive_cloud_standard\\\":0,\\\"sv_sqlserver_mem_dual_exclusive_cloud_enterprise\\\":4,\\\"sv_sqlserver_mem_dual_exclusive_cloud_standard\\\":0,\\\"sv_sqlserver_disk_dual_enhancedssd\\\":0,\\\"sv_sqlserver_disk_dual_fastssd\\\":0,\\\"sv_sqlserver_disk_dual_universalssd\\\":200},\\\"platform\\\":1}]}\\n\"", + "document": "计费参数", + "example": "\"{\\\"uin\\\":\\\"29\\\",\\\"ownerUin\\\":\\\"29\\\",\\\"resInfo\\\":[]}\\n\"", "member": "string", "name": "Parameter", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -9121,7 +9147,7 @@ }, { "disabled": false, - "document": "购买实例的类型 HA-高可用型(包括双机高可用,alwaysOn集群),RO-只读副本型,SI-单节点型,BI-商业智能服务,cvmHA-新版高可用,cvmRO-新版只读", + "document": "购买实例的类型 HA-高可用型(包括双机高可用,alwaysOn集群),RO-只读副本型,SI-单节点型,BI-商业智能服务,cvmHA-新版高可用,cvmRO-新版只读,MultiHA-多节点,cvmMultiHA-云盘多节点", "example": "cvmHA", "member": "string", "name": "InstanceType", @@ -9257,7 +9283,7 @@ { "disabled": false, "document": "新建实例绑定的标签集合", - "example": "无", + "example": "[resource tag]", "member": "ResourceTag", "name": "ResourceTags", "required": false, @@ -9280,6 +9306,24 @@ "name": "Collation", "required": false, "type": "string" + }, + { + "disabled": false, + "document": "是否多节点架构,默认值为false", + "example": "false", + "member": "bool", + "name": "MultiNodes", + "required": false, + "type": "bool" + }, + { + "disabled": false, + "document": "备节点可用区,默认为空。如果是多节点架构时必传,并且当MultiZones=true时备节点可用区不能全部相同。备机可用区集合最小为2个,最大不超过5个。", + "example": "[\"ap-guangzhou-1\"]", + "member": "string", + "name": "DrZones", + "required": false, + "type": "list" } ], "type": "object" @@ -9289,13 +9333,13 @@ "members": [ { "disabled": false, - "document": "计费参数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "document": "计费参数", + "example": "\"{\\\"uin\\\":\\\"29\\\",\\\"ownerUin\\\":\\\"29\\\",\\\"resInfo\\\":[]}\\n\"", "member": "string", "name": "Parameter", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", @@ -9801,18 +9845,20 @@ { "disabled": false, "document": "配置地域分的个数", - "example": "", + "example": "1", "member": "int64", "name": "TotalCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "规格信息数组", - "example": "", + "example": "[{\"Info\":[{\"CPU\":1,\"MachineType\":\"TS85\"}],\"RegionId\":1,\"ZoneId\":100002}]", "member": "ProductSpec", "name": "SpecInfoList", + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -11631,63 +11677,103 @@ "members": [ { "disabled": false, - "document": "备机状态,enable-运行中,disable-不可用\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "备机资源ID", + "example": "mssqldr-bh89a1", + "member": "string", + "name": "DrInstanceId", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "备机可用区", + "example": "ap-guangzhou-3", + "member": "string", + "name": "Zone", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "备机状态\nDR_CREATING-备机创建中\nDR_RUNNING-备机运行中\nDR_UNAVAILABLE-备机不可用\nDR_ISOLATED-备机已隔离\nDR_RECYCLING-备机回收中\nDR_RECYCLED-备机已回收\nDR_JOB_RUNNING-备机执行任务中\nDR_OFFLINE-备机已下线\nDR_FAIL_OVER-备机只读故障转移中", "example": "enable", "member": "string", "name": "SlaveStatus", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "备机可读状态,enable-已开启,disable-已关闭\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "备机可读状态,enable-已开启,disable-已关闭", "example": "enable", "member": "string", "name": "ReadableStatus", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "备机只读vip\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "备机只读vip", "example": "127.0.0.1", "member": "string", "name": "Vip", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "备机只读端口\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "备机只读端口", "example": "1433", "member": "int64", "name": "VPort", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "备机所在私有网络ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "备机所在私有网络ID", "example": "vpc-nhu89aj", "member": "string", "name": "UniqVpcId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "备机所在私有网络子网ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "备机所在私有网络子网ID", "example": "sub-87ahua", "member": "string", "name": "UniqSubnetId", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false + }, + { + "disabled": false, + "document": "备机只读权重", + "example": "0", + "member": "uint64", + "name": "RoWeight", + "output_required": true, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "备机只读模式,BalancedReadOnly-多备一读模式,SingleReadOnly-一备一读模式", + "example": "BalancedReadOnly", + "member": "string", + "name": "ReadMode", + "output_required": true, + "type": "string", + "value_allowed_null": false } ], "usage": "out" @@ -12728,19 +12814,19 @@ "example": "mssql-incremental-migration-kp7bgv8p", "member": "string", "name": "MigrationId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, - "document": "备份导入名称,增量导入任务该字段为空\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "备份导入名称,增量导入任务该字段为空", "example": "MigrationName", "member": "string", "name": "MigrationName", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -12748,7 +12834,7 @@ "example": "251006279", "member": "uint64", "name": "AppId", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -12758,7 +12844,7 @@ "example": "ap-guangzhou", "member": "string", "name": "Region", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12768,7 +12854,7 @@ "example": "mssql-rdc0gajn", "member": "string", "name": "InstanceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12778,7 +12864,7 @@ "example": "FULL_LOG", "member": "string", "name": "RecoveryType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12788,7 +12874,7 @@ "example": "COS_UPLOAD", "member": "string", "name": "UploadType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12798,7 +12884,7 @@ "example": "db_cvm_1_20200927204209_2log2_2noreconvery2.bak", "member": "string", "name": "BackupFiles", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -12808,7 +12894,7 @@ "example": "2", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -12818,7 +12904,7 @@ "example": "2020-09-27 20:44:59", "member": "string", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12828,7 +12914,7 @@ "example": "0000-00-00 00:00:00", "member": "string", "name": "StartTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12838,7 +12924,7 @@ "example": "0000-00-00 00:00:00", "member": "string", "name": "EndTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12848,7 +12934,7 @@ "example": "Message", "member": "string", "name": "Message", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -12858,7 +12944,7 @@ "example": "Detail", "member": "MigrationDetail", "name": "Detail", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -12868,27 +12954,27 @@ "example": "Action", "member": "MigrationAction", "name": "Action", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": false }, { "disabled": false, - "document": "是否是最终恢复,全量导入任务该字段为空\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "是否是最终恢复,全量导入任务该字段为空", "example": "NO", "member": "string", "name": "IsRecovery", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, "document": "重命名的数据库名称集合\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "[\"renameDB\"]", "member": "DBRenameRes", "name": "DBRename", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -12956,13 +13042,13 @@ }, { "disabled": false, - "document": "步骤信息,null表示还未开始迁移\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "步骤信息,null表示还未开始迁移", "example": "[{\"StepNo\": \"1\",\"StepName\": \"back up datebase\",\"StepId\": \"ConnectDBCheck\",\"Status\": \"1\"}]", "member": "MigrationStep", "name": "StepInfo", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -13074,7 +13160,7 @@ { "disabled": false, "document": "修改备注的账户信息", - "example": "无", + "example": "[{\"Remark\":\"备注\",\"UserName\":\"userName\"}]", "member": "AccountRemark", "name": "Accounts", "required": true, @@ -14977,13 +15063,13 @@ }, { "disabled": false, - "document": "旧IP保留时间小时数\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "旧IP保留时间小时数", "example": "1", "member": "int64", "name": "OldIpRetainTime", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -15228,43 +15314,43 @@ "members": [ { "disabled": false, - "document": "包年包月参考价格,单位-分\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "包年包月参考价格,单位-分", "example": "1", "member": "uint64", "name": "PrepaidPrice", - "required": true, + "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "包年包月价格单位,M-月\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "包年包月价格单位,M-月", "example": "M", "member": "string", "name": "PrepaidPriceUnit", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "按量付费价格,单位-分\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "按量付费价格,单位-分", "example": "1", "member": "uint64", "name": "PostpaidPrice", - "required": true, + "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "按量付费价格单位,H-小时\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "按量付费价格单位,H-小时", "example": "H", "member": "string", "name": "PostpaidPriceUnit", - "required": true, + "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -16654,33 +16740,33 @@ "members": [ { "disabled": false, - "document": "SSL加密状态,\nenable-已开启\ndisable-未开启\nenable_doing-开启中\ndisable_doing-关闭中\nrenew_doing-更新中\nwait_doing-等待维护时间内执行\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "SSL加密状态,\nenable-已开启\ndisable-未开启\nenable_doing-开启中\ndisable_doing-关闭中\nrenew_doing-更新中\nwait_doing-等待维护时间内执行", "example": "disable", "member": "string", "name": "Encryption", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "SSL证书有效期,时间格式 YYYY-MM-DD HH:MM:SS\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "SSL证书有效期,时间格式 YYYY-MM-DD HH:MM:SS", "example": "2023-10-01 12:00:00", "member": "string", "name": "SSLValidityPeriod", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "SSL证书有效性,0-无效,1-有效\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "SSL证书有效性,0-无效,1-有效", "example": "0", "member": "uint64", "name": "SSLValidity", "output_required": false, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -16695,7 +16781,7 @@ { "disabled": false, "document": "KMS中购买的用户主密钥ID(CMK)", - "example": "asdafga", + "example": "38b504ae-877a-11ef-8a41-*****", "member": "string", "name": "CMKId", "output_required": false, @@ -16871,7 +16957,7 @@ "example": "ap-guangzhou-1", "member": "string", "name": "SlaveZone", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -16881,7 +16967,17 @@ "example": "广州一区", "member": "string", "name": "SlaveZoneName", - "required": true, + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "备机资源ID", + "example": "mssqldr-9ji781", + "member": "string", + "name": "DrInstanceId", + "output_required": false, "type": "string", "value_allowed_null": false } @@ -16944,7 +17040,7 @@ { "disabled": false, "document": "内网下载地址", - "example": "https://sqlserver-bucket-gz-1258415541.cos.ap-guangzhou.myqcloud.com/1251966477%2fsqlserver%2fmssql-9aajrcn7%2fslow%2fTRACE_20201105201000.trc?sign=q-sign-algorithm%3dsha1%26q-ak%3d***********************%26q-sign-time%3d1604580096%3b1604580996%26q-key-time%3d1604580096%3b1604580996%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3d583b4db2ec94fa10e55da9b95e1e3d8943eaa386", + "example": "https://sqlserver-bucket-gz-1258415541.cos.ap-guangzhou.myqcloud.com/1251966477%2fsqlserver", "member": "string", "name": "InternalAddr", "output_required": true, @@ -16954,7 +17050,7 @@ { "disabled": false, "document": "外网下载地址", - "example": "https://sqlserver-bucket-gz-1258415541.cos.ap-guangzhou.myqcloud.com/1251966477%2fsqlserver%2fmssql-9aajrcn7%2fslow%2fTRACE_20201105201000.trc?sign=q-sign-algorithm%3dsha1%26q-ak%3d**************************%26q-sign-time%3d1604580096%3b1604580996%26q-key-time%3d1604580096%3b1604580996%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3d583b4db2ec94fa10e55da9b95e1e3d8943eaa386", + "example": "https://sqlserver-bucket-gz-1258415541.cos.ap-guangzhou.myqcloud.com/1251966477%2fsqlserver", "member": "string", "name": "ExternalAddr", "output_required": true, @@ -16963,13 +17059,13 @@ }, { "disabled": false, - "document": "状态(1成功 2失败)\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "状态(1成功 2失败)", "example": "1", "member": "int64", "name": "Status", "output_required": true, "type": "int", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -17185,13 +17281,13 @@ }, { "disabled": false, - "document": "此规格对应的按量计费Pid列表\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "此规格对应的按量计费Pid列表", "example": "[10908]", "member": "int64", "name": "PostPid", "output_required": true, "type": "list", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, @@ -17786,53 +17882,53 @@ "members": [ { "disabled": false, - "document": "切换事件ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "切换事件ID", "example": "f39bc24b76d1c5d3ce60f0dcb9e0bd79", "member": "string", "name": "EventId", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "切换模式 0-系统自动切换,1-手动切换\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "切换模式 0-系统自动切换,1-手动切换", "example": "0", "member": "uint64", "name": "SwitchType", "output_required": false, "type": "int", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "切换开始时间\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "切换开始时间", "example": "2023-01-01 00:00:00", "member": "string", "name": "StartTime", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "切换结束时间\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "切换结束时间", "example": "2023-01-01 00:00:00", "member": "string", "name": "EndTime", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, - "document": "机器故障导致自动切换\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "机器故障导致自动切换", "example": "AUTO", "member": "string", "name": "Reason", "output_required": false, "type": "string", - "value_allowed_null": true + "value_allowed_null": false } ], "usage": "out" @@ -17862,18 +17958,18 @@ }, { "disabled": false, - "document": "开通TDE加密时引用的其他主账号ID\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "开通TDE加密时引用的其他主账号ID", "example": "1000****6845", "member": "string", "name": "QuoteUin", "output_required": true, "type": "string", - "value_allowed_null": true + "value_allowed_null": false }, { "disabled": false, "document": "KMS中购买的用户主密钥ID(CMK)", - "example": "sdfadfa", + "example": "38b504ae-877a-11ef-8a41-*******", "member": "string", "name": "CMKId", "output_required": false, diff --git a/tccli/services/sqlserver/v20180328/examples.json b/tccli/services/sqlserver/v20180328/examples.json index 683128bdce..7ee5af2bd7 100644 --- a/tccli/services/sqlserver/v20180328/examples.json +++ b/tccli/services/sqlserver/v20180328/examples.json @@ -612,7 +612,7 @@ { "document": "", "input": "https://sqlserver.tencentcloudapi.com/?Action=DescribeProductSpec\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"eaf9efa1-3d73-45f9-97f5-f0ea26040b93\",\n \"SpecInfoList\": [\n {\n \"Info\": [\n {\n \"CPU\": 1,\n \"MachineType\": \"TS85\",\n \"MachineTypeName\": \"高IO\",\n \"MaxStorage\": 3000,\n \"Memory\": 2000000,\n \"MinStorage\": 10,\n \"PayModeStatus\": \"ALL\",\n \"Pid\": 10908,\n \"PostPid\": [\n 10908\n ],\n \"QPS\": 2100,\n \"SpecId\": 15,\n \"SuitInfo\": \"独立用户数上百人的小型应用\",\n \"Version\": \"2008R2\",\n \"VersionName\": \"SQL Server 2008 Enterprise\"\n },\n {\n \"CPU\": 1,\n \"MachineType\": \"TS85\",\n \"MachineTypeName\": \"高IO\",\n \"MaxStorage\": 3000,\n \"Memory\": 2000000,\n \"MinStorage\": 10,\n \"PayModeStatus\": \"ALL\",\n \"Pid\": 10908,\n \"PostPid\": [\n 10908\n ],\n \"QPS\": 2100,\n \"SpecId\": 15,\n \"SuitInfo\": \"独立用户数上百人的小型应用\",\n \"Version\": \"2012SP3\",\n \"VersionName\": \"SQL Server 2012 Enterprise\"\n },\n {\n \"CPU\": 1,\n \"MachineType\": \"TS85\",\n \"MachineTypeName\": \"高IO\",\n \"MaxStorage\": 3000,\n \"Memory\": 2000000,\n \"MinStorage\": 10,\n \"PayModeStatus\": \"ALL\",\n \"Pid\": 10908,\n \"PostPid\": [\n 10908\n ],\n \"QPS\": 2100,\n \"SpecId\": 15,\n \"SuitInfo\": \"独立用户数上百人的小型应用\",\n \"Version\": \"2016SP1\",\n \"VersionName\": \"SQL Server 2016 Enterprise\"\n }\n ],\n \"RegionId\": 1,\n \"ZoneId\": 100002\n }\n ],\n \"TotalCount\": 1\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"eaf9efa1-3d73-45f9-97f5-f0ea26040b93\",\n \"SpecInfoList\": [\n {\n \"Info\": [\n {\n \"CPU\": 1,\n \"MachineType\": \"TS85\",\n \"MachineTypeName\": \"高IO\",\n \"MaxStorage\": 3000,\n \"Memory\": 2000000,\n \"MinStorage\": 10,\n \"PayModeStatus\": \"ALL\",\n \"Pid\": 10908,\n \"PostPid\": [\n 10908\n ],\n \"QPS\": 2100,\n \"SpecId\": 15,\n \"SuitInfo\": \"独立用户数上百人的小型应用\",\n \"Version\": \"2008R2\",\n \"VersionName\": \"SQL Server 2008 Enterprise\",\n \"InstanceType\": \"HA\",\n \"MultiZonesStatus\": \"ALL\"\n },\n {\n \"CPU\": 1,\n \"MachineType\": \"TS85\",\n \"MachineTypeName\": \"高IO\",\n \"MaxStorage\": 3000,\n \"Memory\": 2000000,\n \"MinStorage\": 10,\n \"PayModeStatus\": \"ALL\",\n \"Pid\": 10908,\n \"PostPid\": [\n 10908\n ],\n \"QPS\": 2100,\n \"SpecId\": 15,\n \"SuitInfo\": \"独立用户数上百人的小型应用\",\n \"Version\": \"2012SP3\",\n \"VersionName\": \"SQL Server 2012 Enterprise\",\n \"InstanceType\": \"HA\",\n \"MultiZonesStatus\": \"ALL\"\n },\n {\n \"CPU\": 1,\n \"MachineType\": \"TS85\",\n \"MachineTypeName\": \"高IO\",\n \"MaxStorage\": 3000,\n \"Memory\": 2000000,\n \"MinStorage\": 10,\n \"PayModeStatus\": \"ALL\",\n \"Pid\": 10908,\n \"PostPid\": [\n 10908\n ],\n \"QPS\": 2100,\n \"SpecId\": 15,\n \"SuitInfo\": \"独立用户数上百人的小型应用\",\n \"Version\": \"2016SP1\",\n \"VersionName\": \"SQL Server 2016 Enterprise\",\n \"InstanceType\": \"HA\",\n \"MultiZonesStatus\": \"ALL\"\n }\n ],\n \"RegionId\": 1,\n \"ZoneId\": 100002\n }\n ],\n \"TotalCount\": 1\n }\n}", "title": "查询全地域售卖规格配置" } ], @@ -803,7 +803,7 @@ "ModifyAccountRemark": [ { "document": "", - "input": "https://sqlserver.tencentcloudapi.com/?Action=ModifyAccountRemark\n&InstanceId=mssql-j8kv137v\n&Accounts.0.UserName=test\n&Accounts.0.Remark=testRemark\n&<公共请求参数>", + "input": "https://sqlserver.tencentcloudapi.com/?Action=ModifyAccountRemark\n&InstanceId=mssql-j8kv137v\n&Accounts.0.UserName=usetName\n&Accounts.0.Remark=userRemark\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3\"\n }\n}", "title": "修改账户备注" } diff --git a/tccli/services/ssl/v20191205/api.json b/tccli/services/ssl/v20191205/api.json index f7d1fd2b46..9384027fc7 100644 --- a/tccli/services/ssl/v20191205/api.json +++ b/tccli/services/ssl/v20191205/api.json @@ -434,50 +434,50 @@ { "disabled": false, "document": "实例ID", - "example": "无", + "example": "svc-******", "member": "string", "name": "ServiceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "实例名称", - "example": "无", + "example": "hannafeta", "member": "string", "name": "ServiceName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "域名", - "example": "无", + "example": "www", "member": "string", "name": "Domain", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "hehs**hes", "member": "string", "name": "CertId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "使用协议", - "example": "无", + "example": "https", "member": "string", "name": "Protocol", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -490,7 +490,7 @@ { "disabled": false, "document": "地域", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, @@ -510,7 +510,7 @@ { "disabled": false, "document": "该地域下apigateway实例总数\t", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -520,7 +520,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no service", "member": "string", "name": "Error", "output_required": true, @@ -536,7 +536,7 @@ { "disabled": false, "document": "验证方式:DNS_AUTO = 自动DNS验证,DNS = 手动DNS验证,FILE = 文件验证。", - "example": "无", + "example": "DNS_AUTO", "member": "string", "name": "DvAuthMethod", "required": true, @@ -545,7 +545,7 @@ { "disabled": false, "document": "域名。", - "example": "无", + "example": "www.xxxxx.com", "member": "string", "name": "DomainName", "required": true, @@ -554,7 +554,7 @@ { "disabled": false, "document": "项目 ID。", - "example": "无", + "example": "37482", "member": "uint64", "name": "ProjectId", "required": false, @@ -563,7 +563,7 @@ { "disabled": false, "document": "证书类型,目前仅支持类型83。83 = TrustAsia C1 DV Free。", - "example": "无", + "example": "83", "member": "string", "name": "PackageType", "required": false, @@ -572,7 +572,7 @@ { "disabled": false, "document": "邮箱。", - "example": "无", + "example": "xxxxxx@qq.com", "member": "string", "name": "ContactEmail", "required": false, @@ -581,7 +581,7 @@ { "disabled": false, "document": "手机。", - "example": "无", + "example": "188******778", "member": "string", "name": "ContactPhone", "required": false, @@ -590,7 +590,7 @@ { "disabled": false, "document": "有效期,默认3个月,目前仅支持3个月。", - "example": "无", + "example": "3", "member": "string", "name": "ValidityPeriod", "required": false, @@ -599,7 +599,7 @@ { "disabled": false, "document": "加密算法,支持 RSA及ECC。", - "example": "无", + "example": "RSA", "member": "string", "name": "CsrEncryptAlgo", "required": false, @@ -608,7 +608,7 @@ { "disabled": false, "document": "密钥对参数,RSA仅支持2048。ECC仅支持prime256v1。加密算法选择ECC时,此参数必填", - "example": "无", + "example": "2048", "member": "string", "name": "CsrKeyParameter", "required": false, @@ -617,7 +617,7 @@ { "disabled": false, "document": "CSR 的加密密码。", - "example": "无", + "example": "******", "member": "string", "name": "CsrKeyPassword", "required": false, @@ -626,7 +626,7 @@ { "disabled": false, "document": "备注名称。", - "example": "无", + "example": "******", "member": "string", "name": "Alias", "required": false, @@ -635,7 +635,7 @@ { "disabled": false, "document": "原证书 ID,用于重新申请。", - "example": "无", + "example": "heyxs**hs", "member": "string", "name": "OldCertificateId", "required": false, @@ -644,7 +644,7 @@ { "disabled": false, "document": "权益包ID,用于免费证书扩容包使用", - "example": "无", + "example": "pid****xsj", "member": "string", "name": "PackageId", "required": false, @@ -653,7 +653,7 @@ { "disabled": false, "document": "签发后是否删除自动域名验证记录, 默认为否;仅域名为DNS_AUTO验证类型支持传参", - "example": "无", + "example": "true", "member": "bool", "name": "DeleteDnsAutoRecord", "required": false, @@ -662,7 +662,7 @@ { "disabled": false, "document": "域名数组(多域名证书可以上传)。\t", - "example": "无", + "example": "[\"www.**.com\"]", "member": "string", "name": "DnsNames", "required": false, @@ -677,7 +677,7 @@ { "disabled": false, "document": "证书 ID。", - "example": "无", + "example": "hey**je", "member": "string", "name": "CertificateId", "output_required": true, @@ -725,7 +725,7 @@ { "disabled": false, "document": "地域\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, @@ -735,7 +735,7 @@ { "disabled": false, "document": "关联资源总数", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -745,7 +745,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no result", "member": "string", "name": "Error", "output_required": true, @@ -787,7 +787,7 @@ { "disabled": false, "document": "地域\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, @@ -807,7 +807,7 @@ { "disabled": false, "document": "地域下总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "TotalCount", "output_required": false, @@ -817,7 +817,7 @@ { "disabled": false, "document": "错误信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "Error", "output_required": false, @@ -907,7 +907,7 @@ { "disabled": false, "document": "域名", - "example": "无", + "example": "www.***.com", "member": "string", "name": "Domain", "output_required": true, @@ -917,7 +917,7 @@ { "disabled": false, "document": "已部署证书ID", - "example": "无", + "example": "heys**ejj", "member": "string", "name": "CertId", "output_required": true, @@ -927,7 +927,7 @@ { "disabled": false, "document": "域名状态", - "example": "无", + "example": "enable", "member": "string", "name": "Status", "output_required": true, @@ -937,7 +937,7 @@ { "disabled": false, "document": "域名计费状态", - "example": "无", + "example": "on", "member": "string", "name": "HttpsBillingSwitch", "output_required": true, @@ -953,7 +953,7 @@ { "disabled": false, "document": "该地域下CDN域名总数\t", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -973,7 +973,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no result", "member": "string", "name": "Error", "output_required": true, @@ -1011,7 +1011,7 @@ { "disabled": false, "document": "证书指纹", - "example": "无", + "example": "881be953a4fd8cab401409b530ee75d1bd171075", "member": "string", "name": "Fingerprint", "output_required": false, @@ -1022,7 +1022,7 @@ { "disabled": false, "document": "证书有效期开始时间", - "example": "无", + "example": "2020-09-08 20:00:00", "member": "string", "name": "ValidFrom", "output_required": false, @@ -1033,7 +1033,7 @@ { "disabled": false, "document": "证书有效期结束时间", - "example": "无", + "example": "2020-12-09 20:00:00", "member": "string", "name": "ValidTo", "output_required": false, @@ -1078,7 +1078,7 @@ { "disabled": false, "document": "证书ID", - "example": "无", + "example": "heysh**he", "member": "string", "name": "CertId", "output_required": true, @@ -1088,7 +1088,7 @@ { "disabled": false, "document": "证书绑定的域名", - "example": "无", + "example": "www.***.com", "member": "string", "name": "DnsNames", "output_required": true, @@ -1098,7 +1098,7 @@ { "disabled": false, "document": "根证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "hesy**nnn", "member": "string", "name": "CertCaId", "output_required": false, @@ -1108,7 +1108,7 @@ { "disabled": false, "document": "证书认证模式:UNIDIRECTIONAL单向认证,MUTUAL双向认证\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "UNIDIRECTIONAL", "member": "string", "name": "SSLMode", "output_required": false, @@ -1124,7 +1124,7 @@ { "disabled": false, "document": "证书可配置域名数量。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "string", "name": "DomainNumber", "output_required": true, @@ -1134,7 +1134,7 @@ { "disabled": false, "document": "原始证书 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "heysh**h", "member": "string", "name": "OriginCertificateId", "output_required": true, @@ -1144,7 +1144,7 @@ { "disabled": false, "document": "重颁发证书原始 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "etsvs**he", "member": "string", "name": "ReplacedBy", "output_required": true, @@ -1154,7 +1154,7 @@ { "disabled": false, "document": "重颁发证书新 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "vsgev**hs", "member": "string", "name": "ReplacedFor", "output_required": true, @@ -1164,7 +1164,7 @@ { "disabled": false, "document": "新订单证书 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "eyrud**jjs", "member": "string", "name": "RenewOrder", "output_required": true, @@ -1174,7 +1174,7 @@ { "disabled": false, "document": "是否是国密证书\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "SMCert", "output_required": true, @@ -1184,7 +1184,7 @@ { "disabled": false, "document": "公司类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "CompanyType", "output_required": true, @@ -1200,7 +1200,7 @@ { "disabled": false, "document": "用户 UIN。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "815836472", "member": "string", "name": "OwnerUin", "output_required": true, @@ -1210,7 +1210,7 @@ { "disabled": false, "document": "项目 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "27383", "member": "string", "name": "ProjectId", "output_required": true, @@ -1220,7 +1220,7 @@ { "disabled": false, "document": "证书来源。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "upload", "member": "string", "name": "From", "output_required": true, @@ -1230,7 +1230,7 @@ { "disabled": false, "document": "证书套餐类型:\n2 = TrustAsia TLS RSA CA,3 = SecureSite 增强型企业版(EV Pro), 4 = SecureSite 增强型(EV), 5 = SecureSite 企业型专业版(OV Pro), 6 = SecureSite 企业型(OV), 7 = SecureSite 企业型(OV)通配符, 8 = Geotrust 增强型(EV), 9 = Geotrust 企业型(OV), 10 = Geotrust 企业型(OV)通配符, 11 = TrustAsia 域名型多域名 SSL 证书, 12 = TrustAsia 域名型(DV)通配符, 13 = TrustAsia 企业型通配符(OV)SSL 证书(D3), 14 = TrustAsia 企业型(OV)SSL 证书(D3), 15 = TrustAsia 企业型多域名 (OV)SSL 证书(D3), 16 = TrustAsia 增强型 (EV)SSL 证书(D3), 17 = TrustAsia 增强型多域名(EV)SSL 证书(D3), 18 = GlobalSign 企业型(OV)SSL 证书, 19 = GlobalSign 企业型通配符 (OV)SSL 证书, 20 = GlobalSign 增强型 (EV)SSL 证书, 21 = TrustAsia 企业型通配符多域名(OV)SSL 证书(D3), 22 = GlobalSign 企业型多域名(OV)SSL 证书, 23 = GlobalSign 企业型通配符多域名(OV)SSL 证书, 24 = GlobalSign 增强型多域名(EV)SSL 证书,25 = Wotrus 域名型证书,26 = Wotrus 域名型多域名证书,27 = Wotrus 域名型通配符证书,28 = Wotrus 企业型证书,29 = Wotrus 企业型多域名证书,30 = Wotrus 企业型通配符证书,31 = Wotrus 增强型证书,32 = Wotrus 增强型多域名证书,33 = Wotrus 国密域名型证书,34 = Wotrus 国密域名型多域名证书,35 = Wotrus 国密域名型通配符证书,37 = Wotrus 国密企业型证书,38 = Wotrus 国密企业型多域名证书,39 = Wotrus 国密企业型通配符证书,40 = Wotrus 国密增强型证书,41 = Wotrus 国密增强型多域名证书,42 = TrustAsia 域名型通配符多域名证书,43 = DNSPod-企业型(OV)SSL证书,44 = DNSPod-企业型(OV)通配符SSL证书,45 = DNSPod-企业型(OV)多域名SSL证书, 46 = DNSPod-增强型(EV)SSL证书,47 = DNSPod-增强型(EV)多域名SSL证书,48 = DNSPod-域名型(DV)SSL证书,49 = DNSPod-域名型(DV)通配符SSL证书,50 = DNSPod-域名型(DV)多域名SSL证书,51 = DNSPod(国密)-企业型(OV)SSL证书,52 = DNSPod(国密)-企业型(OV)通配符SSL证书,53 = DNSPod(国密)-企业型(OV)多域名SSL证书,54 = DNSPod(国密)-域名型(DV)SSL证书,55 = DNSPod(国密)-域名型(DV)通配符SSL证书, 56 = DNSPod(国密)-域名型(DV)多域名SSL证书,57 = SecureSite 企业型专业版多域名(OV Pro),58 = SecureSite 企业型多域名(OV),59 = SecureSite 增强型专业版多域名(EV Pro),60 = SecureSite 增强型多域名(EV),61 = Geotrust 增强型多域名(EV)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2", "member": "string", "name": "PackageType", "output_required": true, @@ -1240,7 +1240,7 @@ { "disabled": false, "document": "证书类型:CA = 客户端证书,SVR = 服务器证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "CA", "member": "string", "name": "CertificateType", "output_required": true, @@ -1250,7 +1250,7 @@ { "disabled": false, "document": "颁发者。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "Wosign", "member": "string", "name": "ProductZhName", "output_required": true, @@ -1260,7 +1260,7 @@ { "disabled": false, "document": "主域名。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "www.***.com", "member": "string", "name": "Domain", "output_required": true, @@ -1270,7 +1270,7 @@ { "disabled": false, "document": "备注名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "hello", "member": "string", "name": "Alias", "output_required": true, @@ -1280,7 +1280,7 @@ { "disabled": false, "document": "状态。0:审核中,1:已通过,2:审核失败,3:已过期,4:验证方式为 DNS_AUTO 类型的证书, 已添加DNS记录,5:企业证书,待提交,6:订单取消中,7:已取消,8:已提交资料, 待上传确认函,9:证书吊销中,10:已吊销,11:重颁发中,12:待上传吊销确认函,13:免费证书待提交资料状态,14:已退款,\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "uint64", "name": "Status", "output_required": true, @@ -1300,7 +1300,7 @@ { "disabled": false, "document": "漏洞扫描状态:INACTIVE = 未开启,ACTIVE = 已开启\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "INACTIVE", "member": "string", "name": "VulnerabilityStatus", "output_required": true, @@ -1310,7 +1310,7 @@ { "disabled": false, "document": "状态信息。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "wait-issue", "member": "string", "name": "StatusMsg", "output_required": true, @@ -1320,7 +1320,7 @@ { "disabled": false, "document": "验证类型:DNS_AUTO = 自动DNS验证,DNS = 手动DNS验证,FILE = 文件验证,EMAIL = 邮件验证。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "DNS_AUTO", "member": "string", "name": "VerifyType", "output_required": true, @@ -1330,7 +1330,7 @@ { "disabled": false, "document": "证书生效时间。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-18 20:00:00", "member": "string", "name": "CertBeginTime", "output_required": true, @@ -1340,7 +1340,7 @@ { "disabled": false, "document": "证书过期时间。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2019-09-18 20:00:00", "member": "string", "name": "CertEndTime", "output_required": true, @@ -1350,7 +1350,7 @@ { "disabled": false, "document": "证书有效期,单位(月)。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "string", "name": "ValidityPeriod", "output_required": true, @@ -1360,7 +1360,7 @@ { "disabled": false, "document": "创建时间。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-18 20:00:00", "member": "string", "name": "InsertTime", "output_required": true, @@ -1370,7 +1370,7 @@ { "disabled": false, "document": "证书 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "heys**he", "member": "string", "name": "CertificateId", "output_required": true, @@ -1380,7 +1380,7 @@ { "disabled": false, "document": "证书包含的多个域名(包含主域名)。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"www.hey**.com\"]", "member": "string", "name": "SubjectAltName", "output_required": true, @@ -1390,7 +1390,7 @@ { "disabled": false, "document": "证书类型名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "rustAsia TLS RSA CA", "member": "string", "name": "PackageTypeName", "output_required": true, @@ -1400,7 +1400,7 @@ { "disabled": false, "document": "状态名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "证书已颁发", "member": "string", "name": "StatusName", "output_required": true, @@ -1410,7 +1410,7 @@ { "disabled": false, "document": "是否为 VIP 客户。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsVip", "output_required": true, @@ -1420,7 +1420,7 @@ { "disabled": false, "document": "是否为 DV 版证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsDv", "output_required": true, @@ -1430,7 +1430,7 @@ { "disabled": false, "document": "是否为泛域名证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsWildcard", "output_required": true, @@ -1440,7 +1440,7 @@ { "disabled": false, "document": "是否启用了漏洞扫描功能。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsVulnerability", "output_required": true, @@ -1450,7 +1450,7 @@ { "disabled": false, "document": "是否可续费。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "RenewAble", "output_required": true, @@ -1470,7 +1470,7 @@ { "disabled": false, "document": "关联的云资源,暂不可用\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"clb\"]", "member": "string", "name": "BoundResource", "output_required": true, @@ -1480,7 +1480,7 @@ { "disabled": false, "document": "是否可部署。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "Deployable", "output_required": true, @@ -1500,7 +1500,7 @@ { "disabled": false, "document": "是否已忽略到期通知\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsIgnore", "output_required": true, @@ -1510,7 +1510,7 @@ { "disabled": false, "document": "是否国密证书\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsSM", "output_required": true, @@ -1520,7 +1520,7 @@ { "disabled": false, "document": "证书算法\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "RSA", "member": "string", "name": "EncryptAlgorithm", "output_required": true, @@ -1530,7 +1530,7 @@ { "disabled": false, "document": "上传CA证书的加密算法\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"RSA\"]", "member": "string", "name": "CAEncryptAlgorithms", "output_required": true, @@ -1540,7 +1540,7 @@ { "disabled": false, "document": "上传CA证书的过期时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"2018-09-18 20:00:00\"]", "member": "string", "name": "CAEndTimes", "output_required": true, @@ -1550,7 +1550,7 @@ { "disabled": false, "document": "上传CA证书的通用名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"RootCa\"]", "member": "string", "name": "CACommonNames", "output_required": true, @@ -1570,7 +1570,7 @@ { "disabled": false, "document": "是否自动续费\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "AutoRenewFlag", "output_required": true, @@ -1580,7 +1580,7 @@ { "disabled": false, "document": "托管状态,0,托管中,5,资源替换中, 10, 托管完成, -1未托管 \n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "HostingStatus", "output_required": true, @@ -1590,7 +1590,7 @@ { "disabled": false, "document": "托管完成时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-18 20:00:00", "member": "string", "name": "HostingCompleteTime", "output_required": true, @@ -1600,7 +1600,7 @@ { "disabled": false, "document": "托管新证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "gegsh**hs", "member": "string", "name": "HostingRenewCertId", "output_required": true, @@ -1610,7 +1610,7 @@ { "disabled": false, "document": "存在的续费证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "he**hehs", "member": "string", "name": "HasRenewOrder", "output_required": true, @@ -1620,7 +1620,7 @@ { "disabled": false, "document": "重颁发证书原证书是否删除\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "ReplaceOriCertIsDelete", "output_required": true, @@ -1630,7 +1630,7 @@ { "disabled": false, "document": "是否即将过期, 证书即将到期的30天内为即将过期\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsExpiring", "output_required": true, @@ -1640,7 +1640,7 @@ { "disabled": false, "document": "DV证书添加验证截止时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-18 20:00:00", "member": "string", "name": "DVAuthDeadline", "output_required": true, @@ -1650,7 +1650,7 @@ { "disabled": false, "document": "域名验证通过时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-18 20:00:00", "member": "string", "name": "ValidationPassedTime", "output_required": true, @@ -1660,7 +1660,7 @@ { "disabled": false, "document": "证书关联的多域名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"www.***.com\"]", "member": "string", "name": "CertSANs", "output_required": true, @@ -1670,7 +1670,7 @@ { "disabled": false, "document": "域名验证驳回信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no right", "member": "string", "name": "AwaitingValidationMsg", "output_required": true, @@ -1680,7 +1680,7 @@ { "disabled": false, "document": "是否允许下载\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "AllowDownload", "output_required": true, @@ -1690,7 +1690,7 @@ { "disabled": false, "document": "证书域名是否全部在DNSPOD托管解析\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsDNSPODResolve", "output_required": true, @@ -1700,7 +1700,7 @@ { "disabled": false, "document": "是否是权益点购买的证书\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsPackage", "output_required": true, @@ -1710,7 +1710,7 @@ { "disabled": false, "document": "是否存在私钥密码\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "KeyPasswordCustomFlag", "output_required": true, @@ -1730,7 +1730,7 @@ { "disabled": false, "document": "证书吊销完成时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-18 20:00:00", "member": "string", "name": "CertRevokedTime", "output_required": false, @@ -1740,7 +1740,7 @@ { "disabled": false, "document": "托管资源类型列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"clb\"]", "member": "string", "name": "HostingResourceTypes", "output_required": false, @@ -1766,7 +1766,7 @@ { "disabled": false, "document": "待检查的证书链", - "example": "无", + "example": "hehys**hsh", "member": "string", "name": "CertificateChain", "required": true, @@ -1860,20 +1860,20 @@ { "disabled": false, "document": "CLB实例ID", - "example": "无", + "example": "lb-*****", "member": "string", "name": "LoadBalancerId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "CLB实例名称", - "example": "无", + "example": "zrhclb", "member": "string", "name": "LoadBalancerName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1883,7 +1883,7 @@ "example": "无", "member": "ClbListener", "name": "Listeners", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -1896,7 +1896,7 @@ { "disabled": false, "document": "地域", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, @@ -1916,7 +1916,7 @@ { "disabled": false, "document": "该地域下Clb实例总数", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -1926,7 +1926,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "Error", "output_required": true, @@ -1942,40 +1942,40 @@ { "disabled": false, "document": "监听器ID", - "example": "无", + "example": "lbl-*****", "member": "string", "name": "ListenerId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "监听器名称", - "example": "无", + "example": "zrh", "member": "string", "name": "ListenerName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "是否开启SNI,1为开启,0为关闭", - "example": "无", + "example": "1", "member": "uint64", "name": "SniSwitch", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "监听器协议类型, HTTPS|TCP_SSL", - "example": "无", + "example": "HTTPS", "member": "string", "name": "Protocol", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -1985,7 +1985,7 @@ "example": "无", "member": "Certificate", "name": "Certificate", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": true }, @@ -1995,17 +1995,17 @@ "example": "无", "member": "ClbListenerRule", "name": "Rules", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "不匹配域名列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"www.****.com\"]", "member": "string", "name": "NoMatchDomains", - "required": false, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -2018,7 +2018,7 @@ { "disabled": false, "document": "规则ID", - "example": "无", + "example": "loc-fcyk****", "member": "string", "name": "LocationId", "output_required": true, @@ -2028,7 +2028,7 @@ { "disabled": false, "document": "规则绑定的域名", - "example": "无", + "example": "www.****.com", "member": "string", "name": "Domain", "output_required": true, @@ -2038,7 +2038,7 @@ { "disabled": false, "document": "规则是否匹配待绑定证书的域名", - "example": "无", + "example": "true", "member": "bool", "name": "IsMatch", "output_required": true, @@ -2058,7 +2058,7 @@ { "disabled": false, "document": "不匹配域名列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"www.***.com\"]", "member": "string", "name": "NoMatchDomains", "output_required": true, @@ -2068,7 +2068,7 @@ { "disabled": false, "document": "规则绑定的路径\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "/url", "member": "string", "name": "Url", "output_required": false, @@ -2108,7 +2108,7 @@ { "disabled": false, "document": "CA机构侧订单号。", - "example": "无", + "example": "hehuxsnsn**jjemxk", "member": "string", "name": "OrderId", "output_required": true, @@ -2118,7 +2118,7 @@ { "disabled": false, "document": "证书状态:0 = 审核中,1 = 已通过,2 = 审核失败,3 = 已过期,4 = 已添加DNS记录,5 = 企业证书,待提交,6 = 订单取消中,7 = 已取消,8 = 已提交资料, 待上传确认函,9 = 证书吊销中,10 = 已吊销,11 = 重颁发中,12 = 待上传吊销确认函,13 = 免费证书待提交资料。", - "example": "无", + "example": "0", "member": "uint64", "name": "Status", "output_required": true, @@ -2140,7 +2140,7 @@ { "disabled": false, "document": "公司名称", - "example": "无", + "example": "Tencent", "member": "string", "name": "CompanyName", "output_required": true, @@ -2150,7 +2150,7 @@ { "disabled": false, "document": "公司ID", - "example": "无", + "example": "178283", "member": "int64", "name": "CompanyId", "output_required": true, @@ -2160,7 +2160,7 @@ { "disabled": false, "document": "公司所在国家", - "example": "无", + "example": "China", "member": "string", "name": "CompanyCountry", "output_required": true, @@ -2170,7 +2170,7 @@ { "disabled": false, "document": "公司所在省份", - "example": "无", + "example": "Guangdong", "member": "string", "name": "CompanyProvince", "output_required": true, @@ -2180,7 +2180,7 @@ { "disabled": false, "document": "公司所在城市", - "example": "无", + "example": "Shenzhen", "member": "string", "name": "CompanyCity", "output_required": true, @@ -2190,7 +2190,7 @@ { "disabled": false, "document": "公司所在详细地址", - "example": "无", + "example": "Binhai****", "member": "string", "name": "CompanyAddress", "output_required": true, @@ -2200,7 +2200,7 @@ { "disabled": false, "document": "公司电话", - "example": "无", + "example": "27384893", "member": "string", "name": "CompanyPhone", "output_required": true, @@ -2210,7 +2210,7 @@ { "disabled": false, "document": "类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "string", "name": "IdType", "output_required": true, @@ -2220,7 +2220,7 @@ { "disabled": false, "document": "ID号\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "178383", "member": "string", "name": "IdNumber", "output_required": true, @@ -2283,50 +2283,50 @@ { "disabled": false, "document": "域名", - "example": "无", + "example": "www.***.com", "member": "string", "name": "Domain", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "已绑定的证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "heysy**hshw", "member": "string", "name": "CertId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "ENABLED: 域名上线状态\nDISABLED:域名下线状态", - "example": "无", + "example": "ENABLED", "member": "string", "name": "Status", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "存储桶名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cos-*****", "member": "string", "name": "Bucket", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "存储桶地域\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -2339,7 +2339,7 @@ { "disabled": false, "document": "证书ID列表,总数不能超过100", - "example": "无", + "example": "[\"heyxsh**jjs\"]", "member": "string", "name": "CertificateIds", "required": true, @@ -2348,7 +2348,7 @@ { "disabled": false, "document": "是否使用缓存, 1使用缓存,0不使用缓存; 默认为1使用缓存; 若当前证书ID存在半小时已完成的任务, 则使用缓存的情况下, 会读取半小时内离当前时间最近的查询结果", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": true, @@ -2385,7 +2385,7 @@ { "disabled": false, "document": "证书产品PID。", - "example": "无", + "example": "100078", "member": "uint64", "name": "ProductPid", "required": true, @@ -2394,7 +2394,7 @@ { "disabled": false, "document": "要消耗的权益包ID。", - "example": "无", + "example": "pid-82****92", "member": "string", "name": "PackageIds", "required": true, @@ -2403,7 +2403,7 @@ { "disabled": false, "document": "证书域名数量。", - "example": "无", + "example": "4", "member": "string", "name": "DomainCount", "required": true, @@ -2412,7 +2412,7 @@ { "disabled": false, "document": "多年期证书年限。", - "example": "无", + "example": "2", "member": "uint64", "name": "Period", "required": true, @@ -2421,7 +2421,7 @@ { "disabled": false, "document": "要续费的原证书ID(续费时填写)。", - "example": "无", + "example": "heh**hsh", "member": "string", "name": "OldCertificateId", "required": false, @@ -2430,7 +2430,7 @@ { "disabled": false, "document": "续费时CSR生成方式(original、upload、online)。", - "example": "无", + "example": "original", "member": "string", "name": "RenewGenCsrMethod", "required": false, @@ -2439,7 +2439,7 @@ { "disabled": false, "document": "续费时选择上传CSR时填写CSR。", - "example": "无", + "example": "CSR", "member": "string", "name": "RenewCsr", "required": false, @@ -2448,7 +2448,7 @@ { "disabled": false, "document": "续费证书CSR的算法类型。", - "example": "无", + "example": "online", "member": "string", "name": "RenewAlgorithmType", "required": false, @@ -2457,7 +2457,7 @@ { "disabled": false, "document": "续费证书CSR的算法参数。", - "example": "无", + "example": "RSA", "member": "string", "name": "RenewAlgorithmParam", "required": false, @@ -2466,7 +2466,7 @@ { "disabled": false, "document": "项目ID。", - "example": "无", + "example": "6737992", "member": "uint64", "name": "ProjectId", "required": false, @@ -2484,7 +2484,7 @@ { "disabled": false, "document": "续费证书的私钥密码。", - "example": "无", + "example": "hehy**hwhwh", "member": "string", "name": "RenewKeyPass", "required": false, @@ -2502,7 +2502,7 @@ { "disabled": false, "document": "批量购买证书数量。", - "example": "无", + "example": "2", "member": "uint64", "name": "CertificateCount", "required": false, @@ -2511,7 +2511,7 @@ { "disabled": false, "document": "预填写的管理人ID。", - "example": "无", + "example": "197382", "member": "uint64", "name": "ManagerId", "required": false, @@ -2520,7 +2520,7 @@ { "disabled": false, "document": "预填写的公司ID。", - "example": "无", + "example": "6782", "member": "uint64", "name": "CompanyId", "required": false, @@ -2529,7 +2529,7 @@ { "disabled": false, "document": "验证方式", - "example": "无", + "example": "DNS", "member": "string", "name": "VerifyType", "required": false, @@ -2538,7 +2538,7 @@ { "disabled": false, "document": "询价参数", - "example": "无", + "example": "hes**hw", "member": "string", "name": "PriceKey", "required": false, @@ -2553,7 +2553,7 @@ { "disabled": false, "document": "证书ID。", - "example": "无", + "example": "hes**hww", "member": "string", "name": "CertificateId", "output_required": true, @@ -2563,7 +2563,7 @@ { "disabled": false, "document": "批量购买证书时返回多个证书ID。", - "example": "无", + "example": "[\"heh*jwj\",\"hehsj\"]", "member": "string", "name": "CertificateIds", "output_required": true, @@ -2668,50 +2668,50 @@ { "disabled": false, "document": "域名", - "example": "无", + "example": "www.hr**.com", "member": "string", "name": "Domain", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "实例ID", - "example": "无", + "example": "ddos-****", "member": "string", "name": "InstanceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "协议类型", - "example": "无", + "example": "https", "member": "string", "name": "Protocol", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "www.***.com", "member": "string", "name": "CertId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "转发端口", - "example": "无", + "example": "80", "member": "string", "name": "VirtualPort", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -2724,7 +2724,7 @@ { "disabled": false, "document": "该地域下ddos域名总数\t", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -2744,7 +2744,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "Error", "output_required": true, @@ -2769,7 +2769,7 @@ { "disabled": false, "document": "删除时是否检查证书关联了云资源。默认不检查。如选择检查(需要授权服务角色SSL_QCSLinkedRoleInReplaceLoadCertificate)删除将变成异步,接口会返回异步任务ID。需使用DescribeDeleteCertificatesTaskResult接口查询删除是否成功。", - "example": "无", + "example": "true", "member": "bool", "name": "IsCheckResource", "required": false, @@ -2816,7 +2816,7 @@ { "disabled": false, "document": "要删除的证书ID。单次最多100个", - "example": "无", + "example": "[\"jej**hh\",\"jhshx\"]", "member": "string", "name": "CertificateIds", "required": true, @@ -2825,7 +2825,7 @@ { "disabled": false, "document": "删除时是否检查证书关联了云资源。默认不检查。如需要检查关联云资源 (需授权服务角色SSL_QCSLinkedRoleInReplaceLoadCertificate),完成授权后,删除将变成异步任务,接口会返回异步任务ID。需搭配 DescribeDeleteCertificatesTaskResult接口使用,查询删除任务是否成功。", - "example": "无", + "example": "true", "member": "bool", "name": "IsSync", "required": false, @@ -2840,7 +2840,7 @@ { "disabled": false, "document": "成功的ID", - "example": "无", + "example": "786263", "member": "string", "name": "Success", "output_required": true, @@ -2882,7 +2882,7 @@ { "disabled": false, "document": "管理人ID", - "example": "无", + "example": "677838", "member": "int64", "name": "ManagerId", "required": true, @@ -2897,7 +2897,7 @@ { "disabled": false, "document": "管理人ID", - "example": "无", + "example": "7377", "member": "int64", "name": "ManagerId", "output_required": true, @@ -2919,7 +2919,7 @@ { "disabled": false, "document": "任务ID", - "example": "无", + "example": "188939", "member": "string", "name": "TaskId", "output_required": true, @@ -2929,7 +2929,7 @@ { "disabled": false, "document": "证书ID", - "example": "无", + "example": "hesg**heh", "member": "string", "name": "CertId", "output_required": true, @@ -2939,7 +2939,7 @@ { "disabled": false, "document": "异步查询结果: 0表示任务进行中、 1表示任务成功、 2表示任务失败、3表示未授权服务角色导致任务失败、4表示有未解绑的云资源导致任务失败、5表示查询关联云资源超时导致任务失败", - "example": "无", + "example": "0", "member": "uint64", "name": "Status", "output_required": true, @@ -2949,7 +2949,7 @@ { "disabled": false, "document": "错误信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "Error", "output_required": true, @@ -2959,7 +2959,7 @@ { "disabled": false, "document": "当前结果缓存时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "CacheTime", "output_required": true, @@ -2969,7 +2969,7 @@ { "disabled": false, "document": "包含的域名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"www.**.com\"]", "member": "string", "name": "Domains", "output_required": true, @@ -3012,7 +3012,7 @@ { "disabled": false, "document": "部署云资源状态:\n云直播:\n-1:域名未关联证书。\n1: 域名https已开启。\n0: 域名https已关闭。", - "example": "无", + "example": "0", "member": "int64", "name": "Status", "required": false, @@ -3021,7 +3021,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -3036,7 +3036,7 @@ { "disabled": false, "document": "云资源部署任务ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "773682", "member": "uint64", "name": "DeployRecordId", "output_required": true, @@ -3046,7 +3046,7 @@ { "disabled": false, "document": "部署状态,1表示部署成功,0表示部署失败", - "example": "无", + "example": "1", "member": "int64", "name": "DeployStatus", "output_required": true, @@ -3119,7 +3119,7 @@ { "disabled": false, "document": "回滚部署记录ID", - "example": "无", + "example": "773637", "member": "int64", "name": "DeployRecordId", "output_required": true, @@ -3141,7 +3141,7 @@ { "disabled": false, "document": "部署记录详情ID", - "example": "无", + "example": "17990", "member": "uint64", "name": "Id", "output_required": true, @@ -3151,7 +3151,7 @@ { "disabled": false, "document": "部署证书ID", - "example": "无", + "example": "heysh**nens", "member": "string", "name": "CertId", "output_required": true, @@ -3161,7 +3161,7 @@ { "disabled": false, "document": "原绑定证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ehy**nsn", "member": "string", "name": "OldCertId", "output_required": true, @@ -3171,7 +3171,7 @@ { "disabled": false, "document": "部署实例ID", - "example": "无", + "example": "lb-****", "member": "string", "name": "InstanceId", "output_required": true, @@ -3181,7 +3181,7 @@ { "disabled": false, "document": "部署实例名称", - "example": "无", + "example": "zrh", "member": "string", "name": "InstanceName", "output_required": true, @@ -3191,7 +3191,7 @@ { "disabled": false, "document": "部署监听器ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "lbl-****", "member": "string", "name": "ListenerId", "output_required": true, @@ -3201,7 +3201,7 @@ { "disabled": false, "document": "部署域名列表", - "example": "无", + "example": "[\"www.**.com\"]", "member": "string", "name": "Domains", "output_required": true, @@ -3211,7 +3211,7 @@ { "disabled": false, "document": "部署监听器协议\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "https", "member": "string", "name": "Protocol", "output_required": true, @@ -3221,7 +3221,7 @@ { "disabled": false, "document": "部署状态", - "example": "无", + "example": "1", "member": "int64", "name": "Status", "output_required": true, @@ -3231,7 +3231,7 @@ { "disabled": false, "document": "部署错误信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no domain", "member": "string", "name": "ErrorMsg", "output_required": true, @@ -3241,7 +3241,7 @@ { "disabled": false, "document": "部署记录详情创建时间", - "example": "无", + "example": "2028-09-08 23:00:00", "member": "string", "name": "CreateTime", "output_required": true, @@ -3251,7 +3251,7 @@ { "disabled": false, "document": "部署记录详情最后一次更新时间", - "example": "无", + "example": "2028-09-08 24:00:00", "member": "string", "name": "UpdateTime", "output_required": true, @@ -3261,7 +3261,7 @@ { "disabled": false, "document": "部署监听器名称", - "example": "无", + "example": "zrh", "member": "string", "name": "ListenerName", "output_required": true, @@ -3271,7 +3271,7 @@ { "disabled": false, "document": "是否开启SNI", - "example": "无", + "example": "0", "member": "int64", "name": "SniSwitch", "output_required": true, @@ -3281,7 +3281,7 @@ { "disabled": false, "document": "COS存储桶名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cos-****", "member": "string", "name": "Bucket", "output_required": true, @@ -3291,7 +3291,7 @@ { "disabled": false, "document": "命名空间名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "zrhname", "member": "string", "name": "Namespace", "output_required": true, @@ -3301,7 +3301,7 @@ { "disabled": false, "document": "secret名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "testSc", "member": "string", "name": "SecretName", "output_required": true, @@ -3311,7 +3311,7 @@ { "disabled": false, "document": "端口\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "90", "member": "int64", "name": "Port", "output_required": true, @@ -3321,7 +3321,7 @@ { "disabled": false, "document": "TCB环境ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "tcb-****", "member": "string", "name": "EnvId", "output_required": false, @@ -3331,7 +3331,7 @@ { "disabled": false, "document": "部署的TCB类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "tcb", "member": "string", "name": "TCBType", "output_required": false, @@ -3351,7 +3351,7 @@ { "disabled": false, "document": "部署CLB监听器的Url\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[\"/test1\",\"/test2\"]", + "example": "[\"/zrh1\",\"/zrh2\"]", "member": "string", "name": "Url", "output_required": false, @@ -3367,70 +3367,70 @@ { "disabled": false, "document": "部署记录ID", - "example": "无", + "example": "1783883", "member": "uint64", "name": "Id", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "部署证书ID", - "example": "无", + "example": "jejeus**he", "member": "string", "name": "CertId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "部署资源类型", - "example": "无", + "example": "CLB", "member": "string", "name": "ResourceType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "部署地域", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "部署状态", - "example": "无", + "example": "1", "member": "uint64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "部署时间", - "example": "无", + "example": "2018-09-18 20:00:00", "member": "string", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "最近一次更新时间", - "example": "无", + "example": "2018-09-19 20:00:00", "member": "string", "name": "UpdateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -3498,8 +3498,8 @@ "members": [ { "disabled": false, - "document": "任务ID,根据任务ID查询绑定云资源结果", - "example": "无", + "document": "任务ID,根据CreateCertificateBindResourceSyncTask得到的任务ID查询绑定云资源结果", + "example": "178883", "member": "string", "name": "TaskId", "required": true, @@ -3508,7 +3508,7 @@ { "disabled": false, "document": "每页展示数量, 默认10,最大值100; 分页总数为云资源地域下实例总数, 即第一页会拉群每个云资源的地域下面Limit数量实例", - "example": "无", + "example": "0", "member": "string", "name": "Limit", "required": false, @@ -3517,7 +3517,7 @@ { "disabled": false, "document": "当前偏移量", - "example": "无", + "example": "10", "member": "string", "name": "Offset", "required": false, @@ -3526,7 +3526,7 @@ { "disabled": false, "document": "查询资源类型的结果详情, 不传则查询所有", - "example": "无", + "example": "[\"clb\"]", "member": "string", "name": "ResourceTypes", "required": false, @@ -3535,7 +3535,7 @@ { "disabled": false, "document": "查询地域列表的数据,CLB、TKE、WAF、APIGATEWAY、TCB支持地域查询, 其他资源类型不支持", - "example": "无", + "example": "[\"ap-guangzhou\"]", "member": "string", "name": "Regions", "required": false, @@ -3650,7 +3650,7 @@ { "disabled": false, "document": "关联云资源异步查询结果: 0表示查询中, 1表示查询成功。 2表示查询异常; 若状态为1,则查看BindResourceResult结果;若状态为2,则查看Error原因", - "example": "无", + "example": "0", "member": "uint64", "name": "Status", "output_required": true, @@ -3660,7 +3660,7 @@ { "disabled": false, "document": "当前结果缓存时间", - "example": "无", + "example": "2018-09-08 20:00:00", "member": "string", "name": "CacheTime", "output_required": true, @@ -3702,7 +3702,7 @@ { "disabled": false, "document": "任务ID,根据CreateCertificateBindResourceSyncTask得到的任务ID查询绑定云资源结果, 最大支持100个", - "example": "无", + "example": "[\"1783883\"]", "member": "string", "name": "TaskIds", "required": true, @@ -3754,7 +3754,7 @@ { "disabled": false, "document": "用户 UIN。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "818****6472", "member": "string", "name": "OwnerUin", "output_required": true, @@ -3764,7 +3764,7 @@ { "disabled": false, "document": "项目 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "string", "name": "ProjectId", "output_required": true, @@ -3774,7 +3774,7 @@ { "disabled": false, "document": "证书来源:trustasia = 亚洲诚信,upload = 用户上传。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "trustasia", "member": "string", "name": "From", "output_required": true, @@ -3784,7 +3784,7 @@ { "disabled": false, "document": "证书类型:CA = 客户端证书,SVR = 服务器证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "SVR", "member": "string", "name": "CertificateType", "output_required": true, @@ -3794,7 +3794,7 @@ { "disabled": false, "document": "证书套餐类型:null = 用户上传证书(没有套餐类型),1 = GeoTrust DV SSL CA - G3, 2 = TrustAsia TLS RSA CA, 3 = SecureSite 增强型企业版(EV Pro), 4 = SecureSite 增强型(EV), 5 = SecureSite 企业型专业版(OV Pro), 6 = SecureSite 企业型(OV), 7 = SecureSite 企业型(OV)通配符, 8 = Geotrust 增强型(EV), 9 = Geotrust 企业型(OV), 10 = Geotrust 企业型(OV)通配符, 11 = TrustAsia 域名型多域名 SSL 证书, 12 = TrustAsia 域名型(DV)通配符, 13 = TrustAsia 企业型通配符(OV)SSL 证书(D3), 14 = TrustAsia 企业型(OV)SSL 证书(D3), 15 = TrustAsia 企业型多域名 (OV)SSL 证书(D3), 16 = TrustAsia 增强型 (EV)SSL 证书(D3), 17 = TrustAsia 增强型多域名(EV)SSL 证书(D3), 18 = GlobalSign 企业型(OV)SSL 证书, 19 = GlobalSign 企业型通配符 (OV)SSL 证书, 20 = GlobalSign 增强型 (EV)SSL 证书, 21 = TrustAsia 企业型通配符多域名(OV)SSL 证书(D3), 22 = GlobalSign 企业型多域名(OV)SSL 证书, 23 = GlobalSign 企业型通配符多域名(OV)SSL 证书, 24 = GlobalSign 增强型多域名(EV)SSL 证书,25 = Wotrus 域名型证书,26 = Wotrus 域名型多域名证书,27 = Wotrus 域名型通配符证书,28 = Wotrus 企业型证书,29 = Wotrus 企业型多域名证书,30 = Wotrus 企业型通配符证书,31 = Wotrus 增强型证书,32 = Wotrus 增强型多域名证书,33 = DNSPod 国密域名型证书,34 = DNSPod 国密域名型多域名证书,35 = DNSPod 国密域名型通配符证书,37 = DNSPod 国密企业型证书,38 = DNSPod 国密企业型多域名证书,39 = DNSPod 国密企业型通配符证书,40 = DNSPod 国密增强型证书,41 = DNSPod 国密增强型多域名证书,42 = TrustAsia 域名型通配符多域名证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "83", "member": "string", "name": "PackageType", "output_required": true, @@ -3804,7 +3804,7 @@ { "disabled": false, "document": "颁发者。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "TrustAsia C1 DV Free", "member": "string", "name": "ProductZhName", "output_required": true, @@ -3814,7 +3814,7 @@ { "disabled": false, "document": "域名。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "nin*****ang.online", "member": "string", "name": "Domain", "output_required": true, @@ -3824,7 +3824,7 @@ { "disabled": false, "document": "备注名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "helllo", "member": "string", "name": "Alias", "output_required": true, @@ -3834,7 +3834,7 @@ { "disabled": false, "document": "证书状态:0 = 审核中,1 = 已通过,2 = 审核失败,3 = 已过期,4 = 已添加DNS记录,5 = 企业证书,待提交,6 = 订单取消中,7 = 已取消,8 = 已提交资料, 待上传确认函,9 = 证书吊销中,10 = 已吊销,11 = 重颁发中,12 = 待上传吊销确认函,13 = 免费证书待提交资料。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "uint64", "name": "Status", "output_required": true, @@ -3844,7 +3844,7 @@ { "disabled": false, "document": "状态信息。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "CA-REVIEWING", "member": "string", "name": "StatusMsg", "output_required": true, @@ -3854,7 +3854,7 @@ { "disabled": false, "document": "验证类型:DNS_AUTO = 自动DNS验证,DNS = 手动DNS验证,FILE = 文件验证,EMAIL = 邮件验证。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "DNS", "member": "string", "name": "VerifyType", "output_required": true, @@ -3864,7 +3864,7 @@ { "disabled": false, "document": "漏洞扫描状态。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "INACTIVE", "member": "string", "name": "VulnerabilityStatus", "output_required": true, @@ -3874,7 +3874,7 @@ { "disabled": false, "document": "证书生效时间。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2024-12-03 08:00:00", "member": "datetime", "name": "CertBeginTime", "output_required": true, @@ -3884,7 +3884,7 @@ { "disabled": false, "document": "证书失效时间。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2025-01-03 07:59:59", "member": "datetime", "name": "CertEndTime", "output_required": true, @@ -3894,7 +3894,7 @@ { "disabled": false, "document": "证书有效期:单位(月)。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "3", "member": "string", "name": "ValidityPeriod", "output_required": true, @@ -3904,7 +3904,7 @@ { "disabled": false, "document": "申请时间。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2024-12-03 19:38:47", "member": "datetime", "name": "InsertTime", "output_required": true, @@ -3914,7 +3914,7 @@ { "disabled": false, "document": "订单 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "hehys****jsj", "member": "string", "name": "OrderId", "output_required": true, @@ -3934,7 +3934,7 @@ { "disabled": false, "document": "证书私钥\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "-----BEGIN RSA PRIVATE KEY----***", "member": "string", "name": "CertificatePrivateKey", "output_required": true, @@ -3944,7 +3944,7 @@ { "disabled": false, "document": "证书公钥(即证书内容)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "-----BEGIN CERTIFICATE-----***", "member": "string", "name": "CertificatePublicKey", "output_required": true, @@ -3964,7 +3964,7 @@ { "disabled": false, "document": "漏洞扫描评估报告。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no problem", "member": "string", "name": "VulnerabilityReport", "output_required": true, @@ -3974,7 +3974,7 @@ { "disabled": false, "document": "证书 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "hehys****hhe", "member": "string", "name": "CertificateId", "output_required": true, @@ -3984,7 +3984,7 @@ { "disabled": false, "document": "证书类型名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "TrustAsia C1 DV Free", "member": "string", "name": "TypeName", "output_required": true, @@ -3994,7 +3994,7 @@ { "disabled": false, "document": "状态描述。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "已颁发", "member": "string", "name": "StatusName", "output_required": true, @@ -4004,7 +4004,7 @@ { "disabled": false, "document": "证书包含的多个域名(不包含主域名,主域名使用Domain字段)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"www.ninghhuang.online\"]", "member": "string", "name": "SubjectAltName", "output_required": true, @@ -4014,7 +4014,7 @@ { "disabled": false, "document": "是否为付费证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsVip", "output_required": true, @@ -4024,7 +4024,7 @@ { "disabled": false, "document": "是否为泛域名证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "false", "member": "bool", "name": "IsWildcard", "output_required": true, @@ -4034,7 +4034,7 @@ { "disabled": false, "document": "是否为 DV 版证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsDv", "output_required": true, @@ -4044,7 +4044,7 @@ { "disabled": false, "document": "是否启用了漏洞扫描功能。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsVulnerability", "output_required": true, @@ -4064,7 +4064,7 @@ { "disabled": false, "document": "是否可续费。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "RenewAble", "output_required": true, @@ -4074,7 +4074,7 @@ { "disabled": false, "document": "是否可部署。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "Deployable", "output_required": true, @@ -4104,7 +4104,7 @@ { "disabled": false, "document": "国密加密证书\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "-----BEGIN CERTIFICATE-", "member": "string", "name": "EncryptCert", "output_required": true, @@ -4114,7 +4114,7 @@ { "disabled": false, "document": "国密加密私钥\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "----BEGIN RSA PRIVATE KEY----***", "member": "string", "name": "EncryptPrivateKey", "output_required": true, @@ -4124,7 +4124,7 @@ { "disabled": false, "document": "签名证书 SHA1指纹\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "5894DA009D7B378A96D168A56B1EC4E2D8065A8D", "member": "string", "name": "CertFingerprint", "output_required": true, @@ -4134,7 +4134,7 @@ { "disabled": false, "document": "加密证书 SHA1指纹 (国密证书特有)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "5894DA009D7B378A96D168A56", "member": "string", "name": "EncryptCertFingerprint", "output_required": true, @@ -4144,7 +4144,7 @@ { "disabled": false, "document": "证书算法\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "RSA 2048", "member": "string", "name": "EncryptAlgorithm", "output_required": true, @@ -4186,7 +4186,7 @@ { "disabled": false, "document": "偏移量,默认为0。", - "example": "无", + "example": "0", "member": "uint64", "name": "Offset", "required": false, @@ -4195,7 +4195,7 @@ { "disabled": false, "document": "请求日志数量,默认为20。", - "example": "无", + "example": "10", "member": "uint64", "name": "Limit", "required": false, @@ -4204,7 +4204,7 @@ { "disabled": false, "document": "开始时间,默认15天前。", - "example": "无", + "example": "2024-11-27 00:00:00", "member": "datetime", "name": "StartTime", "required": false, @@ -4213,7 +4213,7 @@ { "disabled": false, "document": "结束时间,默认现在时间。", - "example": "无", + "example": "2024-12-26 23:59:59", "member": "datetime", "name": "EndTime", "required": false, @@ -4228,7 +4228,7 @@ { "disabled": false, "document": "当前查询条件日志总数。", - "example": "无", + "example": "10", "member": "uint64", "name": "AllTotal", "output_required": true, @@ -4238,7 +4238,7 @@ { "disabled": false, "document": "本次请求返回的日志数量。", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -4270,7 +4270,7 @@ { "disabled": false, "document": "证书 ID。", - "example": "无", + "example": "heysh**hh", "member": "string", "name": "CertificateId", "required": true, @@ -4285,7 +4285,7 @@ { "disabled": false, "document": "用户 UIN。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "278389292", "member": "string", "name": "OwnerUin", "output_required": true, @@ -4295,7 +4295,7 @@ { "disabled": false, "document": "项目 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "7388392", "member": "string", "name": "ProjectId", "output_required": true, @@ -4305,7 +4305,7 @@ { "disabled": false, "document": "证书来源:trustasia = 亚洲诚信,upload = 用户上传。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "upload", "member": "string", "name": "From", "output_required": true, @@ -4315,7 +4315,7 @@ { "disabled": false, "document": "证书类型:CA = 客户端证书,SVR = 服务器证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "CA", "member": "string", "name": "CertificateType", "output_required": true, @@ -4325,7 +4325,7 @@ { "disabled": false, "document": "证书套餐类型: 2 = TrustAsia TLS RSA CA,3 = SecureSite 增强型企业版(EV Pro), 4 = SecureSite 增强型(EV), 5 = SecureSite 企业型专业版(OV Pro), 6 = SecureSite 企业型(OV), 7 = SecureSite 企业型(OV)通配符, 8 = Geotrust 增强型(EV), 9 = Geotrust 企业型(OV), 10 = Geotrust 企业型(OV)通配符, 11 = TrustAsia 域名型多域名 SSL 证书, 12 = TrustAsia 域名型(DV)通配符, 13 = TrustAsia 企业型通配符(OV)SSL 证书(D3), 14 = TrustAsia 企业型(OV)SSL 证书(D3), 15 = TrustAsia 企业型多域名 (OV)SSL 证书(D3), 16 = TrustAsia 增强型 (EV)SSL 证书(D3), 17 = TrustAsia 增强型多域名(EV)SSL 证书(D3), 18 = GlobalSign 企业型(OV)SSL 证书, 19 = GlobalSign 企业型通配符 (OV)SSL 证书, 20 = GlobalSign 增强型 (EV)SSL 证书, 21 = TrustAsia 企业型通配符多域名(OV)SSL 证书(D3), 22 = GlobalSign 企业型多域名(OV)SSL 证书, 23 = GlobalSign 企业型通配符多域名(OV)SSL 证书, 24 = GlobalSign 增强型多域名(EV)SSL 证书,25 = Wotrus 域名型证书,26 = Wotrus 域名型多域名证书,27 = Wotrus 域名型通配符证书,28 = Wotrus 企业型证书,29 = Wotrus 企业型多域名证书,30 = Wotrus 企业型通配符证书,31 = Wotrus 增强型证书,32 = Wotrus 增强型多域名证书,33 = Wotrus 国密域名型证书,34 = Wotrus 国密域名型多域名证书,35 = Wotrus 国密域名型通配符证书,37 = Wotrus 国密企业型证书,38 = Wotrus 国密企业型多域名证书,39 = Wotrus 国密企业型通配符证书,40 = Wotrus 国密增强型证书,41 = Wotrus 国密增强型多域名证书,42 = TrustAsia 域名型通配符多域名证书,43 = DNSPod-企业型(OV)SSL证书,44 = DNSPod-企业型(OV)通配符SSL证书,45 = DNSPod-企业型(OV)多域名SSL证书, 46 = DNSPod-增强型(EV)SSL证书,47 = DNSPod-增强型(EV)多域名SSL证书,48 = DNSPod-域名型(DV)SSL证书,49 = DNSPod-域名型(DV)通配符SSL证书,50 = DNSPod-域名型(DV)多域名SSL证书,51 = DNSPod(国密)-企业型(OV)SSL证书,52 = DNSPod(国密)-企业型(OV)通配符SSL证书,53 = DNSPod(国密)-企业型(OV)多域名SSL证书,54 = DNSPod(国密)-域名型(DV)SSL证书,55 = DNSPod(国密)-域名型(DV)通配符SSL证书, 56 = DNSPod(国密)-域名型(DV)多域名SSL证书,57 = SecureSite 企业型专业版多域名(OV Pro),58 = SecureSite 企业型多域名(OV),59 = SecureSite 增强型专业版多域名(EV Pro),60 = SecureSite 增强型多域名(EV),61 = Geotrust 增强型多域名(EV)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2", "member": "string", "name": "PackageType", "output_required": true, @@ -4335,7 +4335,7 @@ { "disabled": false, "document": "证书颁发者名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "TrustAsia C1 DV Free", "member": "string", "name": "ProductZhName", "output_required": true, @@ -4345,7 +4345,7 @@ { "disabled": false, "document": "域名。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "www.**.com", "member": "string", "name": "Domain", "output_required": true, @@ -4355,7 +4355,7 @@ { "disabled": false, "document": "备注名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "hello", "member": "string", "name": "Alias", "output_required": true, @@ -4365,7 +4365,7 @@ { "disabled": false, "document": "证书状态:0 = 审核中,1 = 已通过,2 = 审核失败,3 = 已过期,4 = 已添加DNS记录,5 = 企业证书,待提交,6 = 订单取消中,7 = 已取消,8 = 已提交资料, 待上传确认函,9 = 证书吊销中,10 = 已吊销,11 = 重颁发中,12 = 待上传吊销确认函。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "uint64", "name": "Status", "output_required": true, @@ -4375,7 +4375,7 @@ { "disabled": false, "document": "状态信息。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "CA-REVIEWING", "member": "string", "name": "StatusMsg", "output_required": true, @@ -4385,7 +4385,7 @@ { "disabled": false, "document": "验证类型:DNS_AUTO = 自动DNS验证,DNS = 手动DNS验证,FILE = 文件验证,EMAIL = 邮件验证。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "DNS_AUTO", "member": "string", "name": "VerifyType", "output_required": true, @@ -4395,7 +4395,7 @@ { "disabled": false, "document": "漏洞扫描状态。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "INACTIVE", "member": "string", "name": "VulnerabilityStatus", "output_required": true, @@ -4405,7 +4405,7 @@ { "disabled": false, "document": "证书生效时间。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2024-11-27 08:00:00", "member": "string", "name": "CertBeginTime", "output_required": true, @@ -4415,7 +4415,7 @@ { "disabled": false, "document": "证书失效时间。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2025-02-26 07:59:59", "member": "string", "name": "CertEndTime", "output_required": true, @@ -4425,7 +4425,7 @@ { "disabled": false, "document": "证书有效期:单位(月)。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "3", "member": "string", "name": "ValidityPeriod", "output_required": true, @@ -4435,7 +4435,7 @@ { "disabled": false, "document": "申请时间。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2024-11-27 17:44:36", "member": "string", "name": "InsertTime", "output_required": true, @@ -4445,7 +4445,7 @@ { "disabled": false, "document": "订单 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "HyJ4b85G_mZOLxSuw", "member": "string", "name": "OrderId", "output_required": true, @@ -4475,7 +4475,7 @@ { "disabled": false, "document": "漏洞扫描评估报告。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no problem", "member": "string", "name": "VulnerabilityReport", "output_required": true, @@ -4485,7 +4485,7 @@ { "disabled": false, "document": "证书 ID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "heysh**he", "member": "string", "name": "CertificateId", "output_required": true, @@ -4495,7 +4495,7 @@ { "disabled": false, "document": "证书类型名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "TrustAsia C1 DV Free", "member": "string", "name": "PackageTypeName", "output_required": true, @@ -4505,7 +4505,7 @@ { "disabled": false, "document": "状态描述。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "已颁发", "member": "string", "name": "StatusName", "output_required": true, @@ -4515,7 +4515,7 @@ { "disabled": false, "document": "证书包含的多个域名(包含主域名)。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"www.****.online\"]", "member": "string", "name": "SubjectAltName", "output_required": true, @@ -4525,7 +4525,7 @@ { "disabled": false, "document": "是否为 VIP 客户。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsVip", "output_required": true, @@ -4535,7 +4535,7 @@ { "disabled": false, "document": "是否为泛域名证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsWildcard", "output_required": true, @@ -4545,7 +4545,7 @@ { "disabled": false, "document": "是否为 DV 版证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsDv", "output_required": true, @@ -4555,7 +4555,7 @@ { "disabled": false, "document": "是否启用了漏洞扫描功能。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "IsVulnerability", "output_required": true, @@ -4565,7 +4565,7 @@ { "disabled": false, "document": "是否可重颁发证书。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "RenewAble", "output_required": true, @@ -4585,7 +4585,7 @@ { "disabled": false, "document": "是否可部署。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "Deployable", "output_required": true, @@ -4605,7 +4605,7 @@ { "disabled": false, "document": "CA证书的所有加密方式\t\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"RSA\"]", "member": "string", "name": "CAEncryptAlgorithms", "output_required": true, @@ -4615,7 +4615,7 @@ { "disabled": false, "document": "CA证书的所有通用名称\t\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"TrustAsia C1 DV Free\"]", "member": "string", "name": "CACommonNames", "output_required": true, @@ -4625,7 +4625,7 @@ { "disabled": false, "document": "CA证书所有的到期时间\t\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"2024-11-27 17:44:36\"]", "member": "string", "name": "CAEndTimes", "output_required": true, @@ -4774,7 +4774,7 @@ { "disabled": false, "document": "是否可托管,可选值:1 = 可托管,0 = 不可托管。", - "example": "无", + "example": "1", "member": "uint64", "name": "Hostable", "required": false, @@ -4792,7 +4792,7 @@ { "disabled": false, "document": "是否筛选等待签发的证书,传1是筛选,0和null不筛选", - "example": "无", + "example": "1", "member": "int64", "name": "IsPendingIssue", "required": false, @@ -4817,7 +4817,7 @@ { "disabled": false, "document": "列表。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "无", "member": "Certificates", "name": "Certificates", "output_required": true, @@ -4857,7 +4857,7 @@ { "disabled": false, "document": "公司ID", - "example": "无", + "example": "17633", "member": "int64", "name": "CompanyId", "required": false, @@ -4941,7 +4941,7 @@ { "disabled": false, "document": "证书ID", - "example": "无", + "example": "[\"hehysh\"]", "member": "string", "name": "CertificateIds", "required": true, @@ -4950,7 +4950,7 @@ { "disabled": false, "document": "资源类型:clb,cdn,live,waf,antiddos", - "example": "无", + "example": "clb", "member": "string", "name": "ResourceType", "required": true, @@ -5043,7 +5043,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "heh**jjj", "member": "string", "name": "CertificateId", "required": false, @@ -5052,7 +5052,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -5070,7 +5070,7 @@ { "disabled": false, "document": "部署资源类型apigateway", - "example": "无", + "example": "clb", "member": "string", "name": "ResourceType", "required": false, @@ -5079,7 +5079,7 @@ { "disabled": false, "document": "已部署的证书ID", - "example": "无", + "example": "heyy**jjs", "member": "string", "name": "OldCertificateId", "required": false, @@ -5088,7 +5088,7 @@ { "disabled": false, "document": "每页数量,默认10。\t", - "example": "\"10\"", + "example": "10", "member": "uint64", "name": "Limit", "required": false, @@ -5097,7 +5097,7 @@ { "disabled": false, "document": "分页偏移量,从0开始。\t", - "example": "\"0\"", + "example": "0", "member": "string", "name": "Offset", "required": false, @@ -5122,7 +5122,7 @@ { "disabled": false, "document": "总数,如取不到值返回0", - "example": "无", + "example": "10", "member": "int64", "name": "TotalCount", "output_required": true, @@ -5144,7 +5144,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "heys*jj", "member": "string", "name": "CertificateId", "required": false, @@ -5153,7 +5153,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -5171,7 +5171,7 @@ { "disabled": false, "document": "部署资源类型cdn", - "example": "无", + "example": "cdn", "member": "string", "name": "ResourceType", "required": false, @@ -5180,7 +5180,7 @@ { "disabled": false, "document": "原证书ID", - "example": "无", + "example": "hshe**jsjs", "member": "string", "name": "OldCertificateId", "required": false, @@ -5207,7 +5207,7 @@ { "disabled": false, "document": "是否异步,0表示否,1表示是,默认为0", - "example": "无", + "example": "1", "member": "int64", "name": "AsyncCache", "required": false, @@ -5232,7 +5232,7 @@ { "disabled": false, "document": "CDN域名总数,如取不到值返回0\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -5242,7 +5242,7 @@ { "disabled": false, "document": "异步刷新总数,如取不到值返回0\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "AsyncTotalNum", "output_required": true, @@ -5252,7 +5252,7 @@ { "disabled": false, "document": "异步刷新当前执行数,如取不到值返回0\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "AsyncOffset", "output_required": true, @@ -5262,7 +5262,7 @@ { "disabled": false, "document": "当前缓存读取时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "string", "name": "AsyncCacheTime", "output_required": true, @@ -5302,7 +5302,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "heys**hhs", "member": "string", "name": "CertificateId", "required": false, @@ -5311,7 +5311,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -5329,7 +5329,7 @@ { "disabled": false, "document": "是否异步缓存,0表示否,1表示是", - "example": "无", + "example": "0", "member": "int64", "name": "AsyncCache", "required": false, @@ -5338,7 +5338,7 @@ { "disabled": false, "document": "原证书ID", - "example": "无", + "example": "hhehs**hh", "member": "string", "name": "OldCertificateId", "required": false, @@ -5353,7 +5353,7 @@ { "disabled": false, "document": "总数,取不到值返回0\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -5373,7 +5373,7 @@ { "disabled": false, "document": "异步刷新总数,取不到值返回0\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "AsyncTotalNum", "output_required": true, @@ -5383,7 +5383,7 @@ { "disabled": false, "document": "异步刷新当前执行数,取不到值返回0\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "AsyncOffset", "output_required": true, @@ -5393,7 +5393,7 @@ { "disabled": false, "document": "当前缓存读取时间,去不到值返回空\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "string", "name": "AsyncCacheTime", "output_required": true, @@ -5415,7 +5415,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "heysy**hsj", "member": "string", "name": "CertificateId", "required": false, @@ -5424,7 +5424,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -5442,7 +5442,7 @@ { "disabled": false, "document": "部署资源类型 cos", - "example": "无", + "example": "cos", "member": "string", "name": "ResourceType", "required": false, @@ -5451,7 +5451,7 @@ { "disabled": false, "document": "原证书ID\t", - "example": "无", + "example": "heys**hhj", "member": "string", "name": "OldCertificateId", "required": false, @@ -5460,7 +5460,7 @@ { "disabled": false, "document": "分页偏移量,从0开始。", - "example": "无", + "example": "0", "member": "int64", "name": "Offset", "required": false, @@ -5469,7 +5469,7 @@ { "disabled": false, "document": "每页数量,默认10。\t", - "example": "无", + "example": "10", "member": "int64", "name": "Limit", "required": false, @@ -5478,7 +5478,7 @@ { "disabled": false, "document": "是否异步,0表示否,1表示是", - "example": "无", + "example": "0", "member": "int64", "name": "AsyncCache", "required": false, @@ -5503,7 +5503,7 @@ { "disabled": false, "document": "总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "TotalCount", "output_required": true, @@ -5513,7 +5513,7 @@ { "disabled": false, "document": "异步刷新总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "AsyncTotalNum", "output_required": true, @@ -5523,7 +5523,7 @@ { "disabled": false, "document": "异步刷新当前执行数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "AsyncOffset", "output_required": true, @@ -5533,7 +5533,7 @@ { "disabled": false, "document": "当前缓存读取时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "string", "name": "AsyncCacheTime", "output_required": true, @@ -5555,7 +5555,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "heysy**heh", "member": "string", "name": "CertificateId", "required": false, @@ -5564,7 +5564,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -5582,7 +5582,7 @@ { "disabled": false, "document": "部署资源类型ddos", - "example": "无", + "example": "ddos", "member": "string", "name": "ResourceType", "required": false, @@ -5591,7 +5591,7 @@ { "disabled": false, "document": "已部署的证书ID", - "example": "无", + "example": "heys*he", "member": "string", "name": "OldCertificateId", "required": false, @@ -5600,7 +5600,7 @@ { "disabled": false, "document": "分页偏移量,从0开始。\t", - "example": "无", + "example": "0", "member": "uint64", "name": "Offset", "required": false, @@ -5609,7 +5609,7 @@ { "disabled": false, "document": "每页数量,默认10。\t", - "example": "无", + "example": "10", "member": "uint64", "name": "Limit", "required": false, @@ -5634,7 +5634,7 @@ { "disabled": false, "document": "总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -5656,7 +5656,7 @@ { "disabled": false, "document": "部署记录ID", - "example": "无", + "example": "17993", "member": "string", "name": "DeployRecordId", "required": true, @@ -5689,7 +5689,7 @@ { "disabled": false, "document": "总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "TotalCount", "output_required": true, @@ -5709,7 +5709,7 @@ { "disabled": false, "document": "成功总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "SuccessTotalCount", "output_required": true, @@ -5719,7 +5719,7 @@ { "disabled": false, "document": "失败总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "FailedTotalCount", "output_required": true, @@ -5729,7 +5729,7 @@ { "disabled": false, "document": "部署中总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "RunningTotalCount", "output_required": true, @@ -5751,7 +5751,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "heh**hs", "member": "string", "name": "CertificateId", "required": true, @@ -5793,7 +5793,7 @@ { "disabled": false, "document": "总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -5825,7 +5825,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "ejuh**hj", "member": "string", "name": "CertificateId", "required": false, @@ -5834,7 +5834,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -5852,7 +5852,7 @@ { "disabled": false, "document": "部署资源类型 lighthouse", - "example": "无", + "example": "lighthouse", "member": "string", "name": "ResourceType", "required": false, @@ -5867,7 +5867,7 @@ { "disabled": false, "document": "Lighthouse实例列表,如取不到返回空数组\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "无", "member": "LighthouseInstanceDetail", "name": "InstanceList", "output_required": true, @@ -5877,7 +5877,7 @@ { "disabled": false, "document": "总数,如取不到返回0\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "0", + "example": "10", "member": "int64", "name": "TotalCount", "output_required": true, @@ -5899,7 +5899,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "heys**hesh", "member": "string", "name": "CertificateId", "required": false, @@ -5908,7 +5908,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -5926,7 +5926,7 @@ { "disabled": true, "document": "部署资源类型", - "example": "无", + "example": "live", "member": "string", "name": "ResourceType", "required": false, @@ -5935,7 +5935,7 @@ { "disabled": false, "document": "已部署的证书ID", - "example": "无", + "example": "heys**hsh", "member": "string", "name": "OldCertificateId", "required": false, @@ -5972,7 +5972,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "hye**hsh", "member": "string", "name": "CertificateId", "required": true, @@ -5981,7 +5981,7 @@ { "disabled": false, "document": "部署资源类型", - "example": "无", + "example": "teo", "member": "string", "name": "ResourceType", "required": true, @@ -5990,7 +5990,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -6008,7 +6008,7 @@ { "disabled": false, "document": "已部署的证书ID", - "example": "无", + "example": "heys**ks", "member": "string", "name": "OldCertificateId", "required": false, @@ -6017,7 +6017,7 @@ { "disabled": false, "document": "分页偏移量,从0开始。", - "example": "无", + "example": "0", "member": "uint64", "name": "Offset", "required": false, @@ -6026,7 +6026,7 @@ { "disabled": false, "document": "每页数量,默认10。\t", - "example": "无", + "example": "10", "member": "uint64", "name": "Limit", "required": false, @@ -6034,8 +6034,8 @@ }, { "disabled": false, - "document": "是否异步", - "example": "无", + "document": "是否异步,1表示是,0表示否,默认为0", + "example": "1", "member": "int64", "name": "AsyncCache", "required": false, @@ -6049,7 +6049,7 @@ "members": [ { "disabled": false, - "document": "teo实例列表\n注意:此字段可能返回 null,表示取不到有效值。", + "document": "teo实例列表,如取不到值返回空数组\n注意:此字段可能返回 null,表示取不到有效值。", "example": "无", "member": "TeoInstanceDetail", "name": "InstanceList", @@ -6060,7 +6060,7 @@ { "disabled": false, "document": "总数", - "example": "无", + "example": "1", "member": "int64", "name": "TotalCount", "output_required": true, @@ -6100,7 +6100,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "heyst**hj", "member": "string", "name": "CertificateId", "required": false, @@ -6109,7 +6109,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -6127,7 +6127,7 @@ { "disabled": false, "document": "是否异步缓存,0表示否,1表示是,默认为0", - "example": "无", + "example": "0", "member": "int64", "name": "AsyncCache", "required": false, @@ -6136,7 +6136,7 @@ { "disabled": false, "document": "原证书ID", - "example": "无", + "example": "ehys**heh", "member": "string", "name": "OldCertificateId", "required": false, @@ -6151,7 +6151,7 @@ { "disabled": false, "document": "总数,取不到值返回0\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -6171,7 +6171,7 @@ { "disabled": false, "document": "异步刷新总数,取不到值返回0\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "AsyncTotalNum", "output_required": true, @@ -6181,7 +6181,7 @@ { "disabled": false, "document": "异步刷新当前执行数,取不到值返回0\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "AsyncOffset", "output_required": true, @@ -6191,7 +6191,7 @@ { "disabled": false, "document": "当前缓存读取时间\t\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "string", "name": "AsyncCacheTime", "output_required": true, @@ -6213,7 +6213,7 @@ { "disabled": false, "document": "一键更新记录ID,从接口UpdateCertificateInstance获得", - "example": "无", + "example": "177999", "member": "string", "name": "DeployRecordId", "required": true, @@ -6222,7 +6222,7 @@ { "disabled": false, "document": "每页数量,默认10。", - "example": "\"10\"", + "example": "10", "member": "string", "name": "Limit", "required": false, @@ -6231,7 +6231,7 @@ { "disabled": false, "document": "分页偏移量,从0开始。", - "example": "\"0\"", + "example": "0", "member": "string", "name": "Offset", "required": false, @@ -6256,7 +6256,7 @@ { "disabled": false, "document": "证书部署记录列表,如果取不到值返回空数组\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "无", "member": "UpdateRecordDetails", "name": "RecordDetailList", "output_required": true, @@ -6326,7 +6326,7 @@ { "disabled": false, "document": "新证书ID", - "example": "无", + "example": "heys**hehs", "member": "string", "name": "CertificateId", "required": false, @@ -6335,7 +6335,7 @@ { "disabled": false, "document": "原证书ID", - "example": "无", + "example": "egts**hehsy", "member": "string", "name": "OldCertificateId", "required": false, @@ -6350,7 +6350,7 @@ { "disabled": false, "document": "总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -6382,7 +6382,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "heyst**hs", "member": "string", "name": "CertificateId", "required": false, @@ -6391,7 +6391,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -6409,7 +6409,7 @@ { "disabled": true, "document": "部署资源类型 vod", - "example": "无", + "example": "vod", "member": "string", "name": "ResourceType", "required": false, @@ -6418,7 +6418,7 @@ { "disabled": false, "document": "已部署的证书ID", - "example": "无", + "example": "ehsy**heh", "member": "string", "name": "OldCertificateId", "required": false, @@ -6443,7 +6443,7 @@ { "disabled": false, "document": "总数,如果取不到值返回0\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "TotalCount", "output_required": true, @@ -6465,7 +6465,7 @@ { "disabled": false, "document": "待部署的证书ID", - "example": "无", + "example": "heys**heh", "member": "string", "name": "CertificateId", "required": false, @@ -6474,7 +6474,7 @@ { "disabled": false, "document": "是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时", - "example": "无", + "example": "1", "member": "uint64", "name": "IsCache", "required": false, @@ -6492,7 +6492,7 @@ { "disabled": true, "document": "部署资源类型,如waf", - "example": "无", + "example": "waf", "member": "string", "name": "ResourceType", "required": false, @@ -6501,7 +6501,7 @@ { "disabled": false, "document": "已部署的证书ID", - "example": "无", + "example": "getst**heh", "member": "string", "name": "OldCertificateId", "required": false, @@ -6538,7 +6538,7 @@ { "disabled": false, "document": "管理人ID,可以从describeManagers接口获得", - "example": "无", + "example": "17939", "member": "int64", "name": "ManagerId", "required": true, @@ -6547,7 +6547,7 @@ { "disabled": true, "document": "分页每页数量", - "example": "无", + "example": "0", "member": "int64", "name": "Limit", "required": false, @@ -6556,7 +6556,7 @@ { "disabled": true, "document": "分页偏移量", - "example": "无", + "example": "10", "member": "int64", "name": "Offset", "required": false, @@ -6571,7 +6571,7 @@ { "disabled": false, "document": "状态: audit: 审核中 ok: 审核通过 invalid: 失效 expiring: 即将过期 expired: 已过期", - "example": "无", + "example": "ok", "member": "string", "name": "Status", "output_required": true, @@ -6581,7 +6581,7 @@ { "disabled": false, "document": "管理人姓名", - "example": "无", + "example": "luke", "member": "string", "name": "ManagerFirstName", "output_required": true, @@ -6591,7 +6591,7 @@ { "disabled": false, "document": "管理人邮箱", - "example": "无", + "example": "666@qq.com", "member": "string", "name": "ManagerMail", "output_required": true, @@ -6601,7 +6601,7 @@ { "disabled": false, "document": "联系人姓名", - "example": "无", + "example": "luke", "member": "string", "name": "ContactFirstName", "output_required": true, @@ -6611,7 +6611,7 @@ { "disabled": false, "document": "管理人姓名", - "example": "无", + "example": "luke", "member": "string", "name": "ManagerLastName", "output_required": true, @@ -6621,7 +6621,7 @@ { "disabled": false, "document": "联系人职位", - "example": "无", + "example": "boss", "member": "string", "name": "ContactPosition", "output_required": true, @@ -6631,7 +6631,7 @@ { "disabled": false, "document": "管理人职位", - "example": "无", + "example": "boss", "member": "string", "name": "ManagerPosition", "output_required": true, @@ -6641,7 +6641,7 @@ { "disabled": false, "document": "核验通过时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2017-09-05 00:00:00", "member": "string", "name": "VerifyTime", "output_required": true, @@ -6651,7 +6651,7 @@ { "disabled": false, "document": "创建时间", - "example": "无", + "example": "2017-09-04 00:00:00", "member": "string", "name": "CreateTime", "output_required": true, @@ -6661,7 +6661,7 @@ { "disabled": false, "document": "核验过期时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2017-09-09 00:00:00", "member": "string", "name": "ExpireTime", "output_required": true, @@ -6671,7 +6671,7 @@ { "disabled": false, "document": "联系人姓名", - "example": "无", + "example": "luke", "member": "string", "name": "ContactLastName", "output_required": true, @@ -6681,7 +6681,7 @@ { "disabled": false, "document": "管理人电话", - "example": "无", + "example": "188666", "member": "string", "name": "ManagerPhone", "output_required": true, @@ -6691,7 +6691,7 @@ { "disabled": false, "document": "联系人电话", - "example": "无", + "example": "188666", "member": "string", "name": "ContactPhone", "output_required": true, @@ -6701,7 +6701,7 @@ { "disabled": false, "document": "联系人邮箱", - "example": "无", + "example": "666@qq.com", "member": "string", "name": "ContactMail", "output_required": true, @@ -6711,7 +6711,7 @@ { "disabled": false, "document": "管理人所属部门", - "example": "无", + "example": "it", "member": "string", "name": "ManagerDepartment", "output_required": true, @@ -6731,7 +6731,7 @@ { "disabled": false, "document": "管理人公司ID", - "example": "无", + "example": "187383", "member": "int64", "name": "CompanyId", "output_required": true, @@ -6741,7 +6741,7 @@ { "disabled": false, "document": "管理人ID", - "example": "无", + "example": "17838", "member": "int64", "name": "ManagerId", "output_required": true, @@ -6874,7 +6874,7 @@ { "disabled": false, "document": "偏移量,默认0。", - "example": "无", + "example": "0", "member": "uint64", "name": "Offset", "required": false, @@ -6883,7 +6883,7 @@ { "disabled": false, "document": "限制数目,默认20。", - "example": "无", + "example": "20", "member": "uint64", "name": "Limit", "required": false, @@ -6892,7 +6892,7 @@ { "disabled": false, "document": "按状态筛选。", - "example": "无", + "example": "enable", "member": "string", "name": "Status", "required": false, @@ -6901,7 +6901,7 @@ { "disabled": false, "document": "按过期时间升序或降序排列。", - "example": "无", + "example": "2019-09-08 20:00:00", "member": "string", "name": "ExpireTime", "required": false, @@ -6910,7 +6910,7 @@ { "disabled": false, "document": "按权益包ID搜索。", - "example": "无", + "example": "pid-100**777", "member": "string", "name": "PackageId", "required": false, @@ -6919,7 +6919,7 @@ { "disabled": false, "document": "按权益包类型搜索。", - "example": "无", + "example": "ssl", "member": "string", "name": "Type", "required": false, @@ -6928,7 +6928,7 @@ { "disabled": false, "document": "子产品编号", - "example": "无", + "example": "10078", "member": "int64", "name": "Pid", "required": false, @@ -6953,7 +6953,7 @@ { "disabled": false, "document": "总条数。", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -6963,7 +6963,7 @@ { "disabled": false, "document": "权益点总余额。", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalBalance", "output_required": true, @@ -6988,7 +6988,7 @@ "example": "qq.com", "member": "string", "name": "Domain", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -6998,7 +6998,7 @@ "example": "DNS", "member": "string", "name": "VerifyType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -7008,7 +7008,7 @@ "example": "1", "member": "int64", "name": "LocalCheck", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -7018,27 +7018,27 @@ "example": "1", "member": "int64", "name": "CaCheck", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "检查失败原因。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "fail", "member": "string", "name": "LocalCheckFailReason", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "检查到的值。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"www.**.com\"]", "member": "string", "name": "CheckValue", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, @@ -7048,7 +7048,7 @@ "example": "false", "member": "bool", "name": "Frequently", - "required": true, + "output_required": true, "type": "bool", "value_allowed_null": false }, @@ -7058,7 +7058,7 @@ "example": "false", "member": "bool", "name": "Issued", - "required": true, + "output_required": true, "type": "bool", "value_allowed_null": false } @@ -7184,7 +7184,7 @@ { "disabled": false, "document": "DV 认证密钥。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "_895b7ee8eb1662e895c90a649c01bc2e.ning****g.online", "member": "string", "name": "DvAuthKey", "output_required": true, @@ -7194,7 +7194,7 @@ { "disabled": false, "document": "DV 认证值。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "f0923331a7c7598def3fe522dbaab630.7bbc2a79620205e7edf2e3f8028f08dc.cmcdt3ax6qhp87.trust-provider.com", "member": "string", "name": "DvAuthValue", "output_required": true, @@ -7204,7 +7204,7 @@ { "disabled": false, "document": "DV 认证值域名。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ning****ng.online", "member": "string", "name": "DvAuthDomain", "output_required": true, @@ -7214,7 +7214,7 @@ { "disabled": false, "document": "DV 认证值路径。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "/path", "member": "string", "name": "DvAuthPath", "output_required": true, @@ -7224,7 +7224,7 @@ { "disabled": false, "document": "DV 认证子域名,\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "_895b7ee8eb1662e895c90a649c01bc2e", "member": "string", "name": "DvAuthSubDomain", "output_required": true, @@ -7234,7 +7234,7 @@ { "disabled": false, "document": "DV 认证类型。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "CNAME", "member": "string", "name": "DvAuthVerifyType", "output_required": true, @@ -7250,7 +7250,7 @@ { "disabled": false, "document": "异常错误码\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "FailedOperation.AutoRenewCertificateTypeInvalid", "member": "string", "name": "Code", "output_required": true, @@ -7260,7 +7260,7 @@ { "disabled": false, "document": "异常错误信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "证书类型不支持自动续费", "member": "string", "name": "Message", "output_required": true, @@ -7302,7 +7302,7 @@ { "disabled": false, "document": "网关证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "api-gate-***", "member": "string", "name": "Id", "output_required": false, @@ -7312,7 +7312,7 @@ { "disabled": false, "document": "网关证书名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "zrh", "member": "string", "name": "Name", "output_required": false, @@ -7322,7 +7322,7 @@ { "disabled": false, "document": "绑定域名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "www.***.com", "member": "string", "name": "BindDomains", "output_required": false, @@ -7332,7 +7332,7 @@ { "disabled": false, "document": "证书来源\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "upload", "member": "string", "name": "CertSource", "output_required": false, @@ -7342,7 +7342,7 @@ { "disabled": false, "document": "当前绑定的SSL证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "heysh**he", "member": "string", "name": "CertId", "output_required": false, @@ -7358,7 +7358,7 @@ { "disabled": false, "document": "托管资源替换时间, 默认为证书过期前30天存在续费证书则替换\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "15", "member": "int64", "name": "ReplaceTime", "output_required": false, @@ -7369,7 +7369,7 @@ { "disabled": false, "document": "托管发送消息类型:0,托管开始前消息提醒(没有续费证书也会收到该提示消息); 1, 托管开始消息提醒(存在续费证书才会收到消息提醒); 2, 托管资源替换失败消息提醒; 3 托管资源替换成功消息提醒\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "MessageTypes", "output_required": false, @@ -7380,7 +7380,7 @@ { "disabled": false, "document": "资源替换开始时间", - "example": "无", + "example": "12:00:00", "member": "string", "name": "ReplaceStartTime", "output_required": false, @@ -7391,7 +7391,7 @@ { "disabled": false, "document": "资源替换结束时间", - "example": "无", + "example": "23:00:00", "member": "string", "name": "ReplaceEndTime", "output_required": false, @@ -7408,40 +7408,40 @@ { "disabled": false, "document": "实例ID", - "example": "asfgas", + "example": "lh-*****", "member": "string", "name": "InstanceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "实例名称", - "example": "gsehsd", + "example": "zrh-self", "member": "string", "name": "InstanceName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "IP地址", - "example": "无", + "example": "[\"192.0.9.1\"]", "member": "string", "name": "IP", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "可选择域名", - "example": "无", + "example": "[\"www.h**.com\"]", "member": "string", "name": "Domain", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -7454,30 +7454,30 @@ { "disabled": false, "document": "域名", - "example": "无", + "example": "ww.***.com", "member": "string", "name": "Domain", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "已绑定的证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "heysh**h", "member": "string", "name": "CertId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "-1:域名未关联证书。\n1: 域名https已开启。\n0: 域名https已关闭。", - "example": "无", + "example": "-1", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -7490,7 +7490,7 @@ { "disabled": false, "document": "该地域下live实例总数\t", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -7510,7 +7510,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "Error", "output_required": true, @@ -7526,7 +7526,7 @@ { "disabled": false, "document": "状态: audit: 审核中 ok: 审核通过 invalid: 失效 expiring: 即将过期 expired: 已过期", - "example": "无", + "example": "audit", "member": "string", "name": "Status", "output_required": true, @@ -7536,7 +7536,7 @@ { "disabled": false, "document": "管理人姓名", - "example": "无", + "example": "luke", "member": "string", "name": "ManagerFirstName", "output_required": true, @@ -7546,7 +7546,7 @@ { "disabled": false, "document": "管理人姓名", - "example": "无", + "example": "sky", "member": "string", "name": "ManagerLastName", "output_required": true, @@ -7556,7 +7556,7 @@ { "disabled": false, "document": "管理人职位", - "example": "无", + "example": "Waibao", "member": "string", "name": "ManagerPosition", "output_required": true, @@ -7566,7 +7566,7 @@ { "disabled": false, "document": "管理人电话", - "example": "无", + "example": "188**77373", "member": "string", "name": "ManagerPhone", "output_required": true, @@ -7576,7 +7576,7 @@ { "disabled": false, "document": "管理人邮箱", - "example": "无", + "example": "173**@qq.com", "member": "string", "name": "ManagerMail", "output_required": true, @@ -7586,7 +7586,7 @@ { "disabled": false, "document": "管理人所属部门", - "example": "无", + "example": "IT", "member": "string", "name": "ManagerDepartment", "output_required": true, @@ -7596,7 +7596,7 @@ { "disabled": false, "document": "创建时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-10 00:00:00", "member": "string", "name": "CreateTime", "output_required": true, @@ -7606,7 +7606,7 @@ { "disabled": false, "document": "管理人域名数量", - "example": "无", + "example": "10", "member": "int64", "name": "DomainCount", "output_required": true, @@ -7616,7 +7616,7 @@ { "disabled": false, "document": "管理人证书数量", - "example": "无", + "example": "1", "member": "int64", "name": "CertCount", "output_required": true, @@ -7626,7 +7626,7 @@ { "disabled": false, "document": "管理人ID", - "example": "无", + "example": "17777", "member": "int64", "name": "ManagerId", "output_required": true, @@ -7636,7 +7636,7 @@ { "disabled": false, "document": "审核有效到期时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2019-09-10 00:00:00", "member": "string", "name": "ExpireTime", "output_required": true, @@ -7646,7 +7646,7 @@ { "disabled": false, "document": "最近一次提交审核时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-10 00:00:00", "member": "string", "name": "SubmitAuditTime", "output_required": true, @@ -7656,7 +7656,7 @@ { "disabled": false, "document": "审核通过时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-10 00:00:00", "member": "string", "name": "VerifyTime", "output_required": true, @@ -7692,7 +7692,7 @@ { "disabled": false, "document": "审核类型,枚举值:ov,ev,cs,ev_cs\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ov", "member": "string", "name": "Type", "output_required": true, @@ -7702,7 +7702,7 @@ { "disabled": false, "document": "审核状态,枚举值:pending,completed,invalid,submitted,expiring,expired\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "pending", "member": "string", "name": "Status", "output_required": true, @@ -7712,7 +7712,7 @@ { "disabled": false, "document": "创建时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-10 20:00:00", "member": "string", "name": "CreateTime", "output_required": true, @@ -7722,7 +7722,7 @@ { "disabled": false, "document": "过期时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2019-09-10 20:00:00", "member": "string", "name": "ExpireTime", "output_required": true, @@ -7784,7 +7784,7 @@ { "disabled": false, "document": "需要修改所属项目的证书 ID 集合,最多100个证书。", - "example": "无", + "example": "[\"he**heys\"]", "member": "string", "name": "CertificateIdList", "required": true, @@ -7793,7 +7793,7 @@ { "disabled": false, "document": "项目 ID。", - "example": "无", + "example": "10778", "member": "uint64", "name": "ProjectId", "required": true, @@ -7808,7 +7808,7 @@ { "disabled": false, "document": "修改所属项目成功的证书集合。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"he**heys\"]", "member": "string", "name": "SuccessCertificates", "output_required": true, @@ -7818,7 +7818,7 @@ { "disabled": false, "document": "修改所属项目失败的证书集合。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"he**hhys\"]", "member": "string", "name": "FailCertificates", "output_required": true, @@ -7840,7 +7840,7 @@ { "disabled": false, "document": "证书ID。", - "example": "无", + "example": "heys**sjd", "member": "string", "name": "CertificateId", "required": true, @@ -7855,7 +7855,7 @@ { "disabled": false, "document": "证书ID。", - "example": "无", + "example": "hwys**hhs", "member": "string", "name": "CertificateId", "output_required": true, @@ -7901,7 +7901,7 @@ { "disabled": false, "document": "证书ID列表", - "example": "无", + "example": "[\"heysh**hejs\"]", "member": "string", "name": "CertificateIds", "output_required": true, @@ -7923,7 +7923,7 @@ { "disabled": false, "document": "操作证书动作。", - "example": "无", + "example": "revoke", "member": "string", "name": "Action", "output_required": true, @@ -7933,7 +7933,7 @@ { "disabled": false, "document": "操作时间。", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "datetime", "name": "CreatedOn", "output_required": true, @@ -7943,7 +7943,7 @@ { "disabled": false, "document": "主账号\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "18777374", "member": "string", "name": "Uin", "output_required": false, @@ -7953,7 +7953,7 @@ { "disabled": false, "document": "子账号\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "19993484", "member": "string", "name": "SubAccountUin", "output_required": false, @@ -7963,7 +7963,7 @@ { "disabled": false, "document": "证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "heysh*8he", "member": "string", "name": "CertId", "output_required": false, @@ -7973,7 +7973,7 @@ { "disabled": false, "document": "操作\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "revoke", "member": "string", "name": "Type", "output_required": false, @@ -7989,100 +7989,100 @@ { "disabled": false, "document": "权益包ID。", - "example": "无", + "example": "pid-*****", "member": "string", "name": "PackageId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "权益包内权益点总量。", - "example": "无", + "example": "10", "member": "uint64", "name": "Total", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "权益包内权益点余量。", - "example": "无", + "example": "10", "member": "uint64", "name": "Balance", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "权益包名称。", - "example": "无", + "example": "zrh权益包", "member": "string", "name": "Type", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "权益点是转入时,来源信息。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1784894993", "member": "uint64", "name": "SourceUin", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "权益点状态。", - "example": "无", + "example": "used", "member": "string", "name": "Status", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "过期时间。", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "ExpireTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "更新时间。", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "UpdateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "生成时间。", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "来源类型。", - "example": "无", + "example": "source", "member": "string", "name": "SourceType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -8092,7 +8092,7 @@ "example": "无", "member": "PackageTransferOutInfo", "name": "TransferOutInfos", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -8105,100 +8105,100 @@ { "disabled": false, "document": "权益包ID。", - "example": "无", + "example": "pid-****", "member": "string", "name": "PackageId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "转移码。", - "example": "无", + "example": "trans-****", "member": "string", "name": "TransferCode", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "本次转移点数。", - "example": "无", + "example": "1", "member": "uint64", "name": "TransferCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "转入的PackageID。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "pid-****", "member": "string", "name": "ReceivePackageId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "本次转移过期时间。", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "ExpireTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "本次转移生成时间。", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "本次转移更新时间。", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "UpdateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "转移状态。", - "example": "无", + "example": "done", "member": "string", "name": "TransferStatus", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "接收者uin。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "18747373", "member": "uint64", "name": "ReceiverUin", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "接收时间。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "ReceiveTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -8214,7 +8214,7 @@ "example": "1", "member": "int64", "name": "TotalPeriod", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -8224,17 +8224,17 @@ "example": "1", "member": "int64", "name": "NowPeriod", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "证书预审核管理人ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "187377", "member": "string", "name": "ManagerId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -8313,7 +8313,7 @@ { "disabled": false, "document": "证书 ID。", - "example": "无", + "example": "heysh**heh", "member": "string", "name": "CertificateId", "required": true, @@ -8322,7 +8322,7 @@ { "disabled": false, "document": "验证类型:DNS_AUTO = 自动DNS验证(仅支持在腾讯云解析且解析状态正常的域名使用该验证类型),DNS = 手动DNS验证,FILE = 文件验证。", - "example": "无", + "example": "DNS", "member": "string", "name": "ValidType", "required": true, @@ -8331,7 +8331,7 @@ { "disabled": false, "document": "类型,默认 Original。可选项:Original = 原证书 CSR,Upload = 手动上传,Online = 在线生成。", - "example": "无", + "example": "Upload", "member": "string", "name": "CsrType", "required": false, @@ -8340,7 +8340,7 @@ { "disabled": false, "document": "CSR 内容。", - "example": "无", + "example": "hye***jsj", "member": "string", "name": "CsrContent", "required": false, @@ -8349,7 +8349,7 @@ { "disabled": false, "document": "KEY 密码。", - "example": "无", + "example": "password", "member": "string", "name": "CsrkeyPassword", "required": false, @@ -8358,7 +8358,7 @@ { "disabled": false, "document": "重颁发原因。", - "example": "无", + "example": "do not want", "member": "string", "name": "Reason", "required": false, @@ -8367,7 +8367,7 @@ { "disabled": false, "document": "CSR加密方式,可选:RSA、ECC、SM2\n(CsrType为Online才可选), 默认为RSA", - "example": "无", + "example": "RSA", "member": "string", "name": "CertCSREncryptAlgo", "required": false, @@ -8376,7 +8376,7 @@ { "disabled": false, "document": "CSR加密参数,CsrEncryptAlgo为RSA时, 可选2048、4096等默认为2048;CsrEncryptAlgo为ECC时,可选prime256v1,secp384r1等,默认为prime256v1; ", - "example": "无", + "example": "2048", "member": "string", "name": "CertCSRKeyParameter", "required": false, @@ -8391,7 +8391,7 @@ { "disabled": false, "document": "证书 ID。", - "example": "无", + "example": "het**hehs", "member": "string", "name": "CertificateId", "output_required": true, @@ -8413,22 +8413,20 @@ { "disabled": false, "document": "云资源类型", - "example": "无", + "example": "clb", "member": "string", "name": "ResourceType", "required": false, - "type": "string", - "value_allowed_null": true + "type": "string" }, { "disabled": false, "document": "地域列表", - "example": "无", + "example": "[\"ap-guangzhou\"]", "member": "string", "name": "Regions", "required": false, - "type": "list", - "value_allowed_null": true + "type": "list" } ], "usage": "in" @@ -8439,7 +8437,7 @@ { "disabled": false, "document": "证书 ID。", - "example": "无", + "example": "hey**hes", "member": "string", "name": "CertificateId", "required": true, @@ -8448,7 +8446,7 @@ { "disabled": false, "document": "吊销证书原因。", - "example": "无", + "example": "do not want", "member": "string", "name": "Reason", "required": false, @@ -8567,7 +8565,7 @@ { "disabled": false, "document": "管理人ID", - "example": "无", + "example": "17839", "member": "int64", "name": "ManagerId", "required": true, @@ -8582,7 +8580,7 @@ { "disabled": false, "document": "管理人ID", - "example": "无", + "example": "17839", "member": "int64", "name": "ManagerId", "output_required": true, @@ -8604,7 +8602,7 @@ { "disabled": false, "document": "证书 ID。", - "example": "无", + "example": "heysh**hehs", "member": "string", "name": "CertificateId", "required": true, @@ -8613,7 +8611,7 @@ { "disabled": false, "document": "CSR 生成方式:online = 在线生成, parse = 手动上传。", - "example": "无", + "example": "online", "member": "string", "name": "CsrType", "required": false, @@ -8622,7 +8620,7 @@ { "disabled": false, "document": "上传的 CSR 内容。", - "example": "无", + "example": "hey*******jjsj", "member": "string", "name": "CsrContent", "required": false, @@ -8631,7 +8629,7 @@ { "disabled": false, "document": "绑定证书的域名。", - "example": "无", + "example": "www.hh***.com", "member": "string", "name": "CertificateDomain", "required": false, @@ -8640,7 +8638,7 @@ { "disabled": false, "document": "上传的域名数组(多域名证书可以上传)。", - "example": "无", + "example": "[\"www.hh***.com\"]", "member": "string", "name": "DomainList", "required": false, @@ -8649,7 +8647,7 @@ { "disabled": false, "document": "私钥密码(非必填)。", - "example": "无", + "example": "password", "member": "string", "name": "KeyPassword", "required": false, @@ -8658,7 +8656,7 @@ { "disabled": false, "document": "公司名称。", - "example": "无", + "example": "Tencent", "member": "string", "name": "OrganizationName", "required": false, @@ -8667,7 +8665,7 @@ { "disabled": false, "document": "部门名称。", - "example": "无", + "example": "IT", "member": "string", "name": "OrganizationDivision", "required": false, @@ -8676,7 +8674,7 @@ { "disabled": false, "document": "公司详细地址。", - "example": "无", + "example": "Shenzhen", "member": "string", "name": "OrganizationAddress", "required": false, @@ -8685,7 +8683,7 @@ { "disabled": false, "document": "国家名称,如中国:CN 。", - "example": "无", + "example": "China", "member": "string", "name": "OrganizationCountry", "required": false, @@ -8694,7 +8692,7 @@ { "disabled": false, "document": "公司所在城市。", - "example": "无", + "example": "Shenzhen", "member": "string", "name": "OrganizationCity", "required": false, @@ -8703,7 +8701,7 @@ { "disabled": false, "document": "公司所在省份。", - "example": "无", + "example": "Guangdong", "member": "string", "name": "OrganizationRegion", "required": false, @@ -8712,7 +8710,7 @@ { "disabled": false, "document": "公司邮编。", - "example": "无", + "example": "137000", "member": "string", "name": "PostalCode", "required": false, @@ -8721,7 +8719,7 @@ { "disabled": false, "document": "公司座机区号。", - "example": "无", + "example": "021", "member": "string", "name": "PhoneAreaCode", "required": false, @@ -8730,7 +8728,7 @@ { "disabled": false, "document": "公司座机号码。", - "example": "无", + "example": "021-1382344", "member": "string", "name": "PhoneNumber", "required": false, @@ -8739,7 +8737,7 @@ { "disabled": false, "document": "证书验证方式。验证类型:DNS_AUTO = 自动DNS验证(仅支持在腾讯云解析且解析状态正常的域名使用该验证类型),DNS = 手动DNS验证,FILE = 文件验证。", - "example": "无", + "example": "DNS", "member": "string", "name": "VerifyType", "required": false, @@ -8748,7 +8746,7 @@ { "disabled": false, "document": "管理人名。", - "example": "无", + "example": "Luke", "member": "string", "name": "AdminFirstName", "required": false, @@ -8757,7 +8755,7 @@ { "disabled": false, "document": "管理人姓。", - "example": "无", + "example": "SKy", "member": "string", "name": "AdminLastName", "required": false, @@ -8766,7 +8764,7 @@ { "disabled": false, "document": "管理人手机号码。", - "example": "无", + "example": "183****663", "member": "string", "name": "AdminPhoneNum", "required": false, @@ -8775,7 +8773,7 @@ { "disabled": false, "document": "管理人邮箱地址。", - "example": "无", + "example": "hhhy@qq.com", "member": "string", "name": "AdminEmail", "required": false, @@ -8784,7 +8782,7 @@ { "disabled": false, "document": "管理人职位。", - "example": "无", + "example": "IT", "member": "string", "name": "AdminPosition", "required": false, @@ -8793,7 +8791,7 @@ { "disabled": false, "document": "联系人名。", - "example": "无", + "example": "Luke", "member": "string", "name": "ContactFirstName", "required": false, @@ -8802,7 +8800,7 @@ { "disabled": false, "document": "联系人姓。", - "example": "无", + "example": "SKy", "member": "string", "name": "ContactLastName", "required": false, @@ -8811,7 +8809,7 @@ { "disabled": false, "document": "联系人邮箱地址。", - "example": "无", + "example": "hhhy@qq.com", "member": "string", "name": "ContactEmail", "required": false, @@ -8820,7 +8818,7 @@ { "disabled": false, "document": "联系人手机号码。", - "example": "无", + "example": "183****663", "member": "string", "name": "ContactNumber", "required": false, @@ -8829,7 +8827,7 @@ { "disabled": false, "document": "联系人职位。", - "example": "无", + "example": "IT", "member": "string", "name": "ContactPosition", "required": false, @@ -8838,7 +8836,7 @@ { "disabled": false, "document": "是否DV证书。默认false", - "example": "无", + "example": "fasle", "member": "bool", "name": "IsDV", "required": false, @@ -8875,7 +8873,7 @@ { "disabled": false, "document": "CSR 类型,(online = 在线生成CSR,parse = 粘贴 CSR)。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "online", "member": "string", "name": "CsrType", "output_required": true, @@ -8886,7 +8884,7 @@ { "disabled": false, "document": "CSR 内容。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "content******", "member": "string", "name": "CsrContent", "output_required": true, @@ -8897,7 +8895,7 @@ { "disabled": false, "document": "域名信息。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "www.q**.com", "member": "string", "name": "CertificateDomain", "output_required": true, @@ -8908,7 +8906,7 @@ { "disabled": false, "document": "DNS 信息。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"www.***.com\"]", "member": "string", "name": "DomainList", "output_required": true, @@ -8919,7 +8917,7 @@ { "disabled": false, "document": "私钥密码。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "password", "member": "string", "name": "KeyPassword", "output_required": true, @@ -8930,7 +8928,7 @@ { "disabled": false, "document": "企业或单位名称。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "Tencent", "member": "string", "name": "OrganizationName", "output_required": true, @@ -8941,7 +8939,7 @@ { "disabled": false, "document": "部门。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "It", "member": "string", "name": "OrganizationDivision", "output_required": true, @@ -8952,7 +8950,7 @@ { "disabled": false, "document": "地址。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "Shenzhen", "member": "string", "name": "OrganizationAddress", "output_required": true, @@ -8963,7 +8961,7 @@ { "disabled": false, "document": "国家。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "China", "member": "string", "name": "OrganizationCountry", "output_required": true, @@ -8974,7 +8972,7 @@ { "disabled": false, "document": "市。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "Shenzhen", "member": "string", "name": "OrganizationCity", "output_required": true, @@ -8985,7 +8983,7 @@ { "disabled": false, "document": "省。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "Guangdong", "member": "string", "name": "OrganizationRegion", "output_required": true, @@ -8996,7 +8994,7 @@ { "disabled": false, "document": "邮政编码。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "137000", "member": "string", "name": "PostalCode", "output_required": true, @@ -9007,7 +9005,7 @@ { "disabled": false, "document": "座机区号。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "021", "member": "string", "name": "PhoneAreaCode", "output_required": true, @@ -9018,7 +9016,7 @@ { "disabled": false, "document": "座机号码。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "021-6367***", "member": "string", "name": "PhoneNumber", "output_required": true, @@ -9029,7 +9027,7 @@ { "disabled": false, "document": "管理员名。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "luke", "member": "string", "name": "AdminFirstName", "output_required": true, @@ -9040,7 +9038,7 @@ { "disabled": false, "document": "管理员姓。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "sky", "member": "string", "name": "AdminLastName", "output_required": true, @@ -9051,7 +9049,7 @@ { "disabled": false, "document": "管理员电话号码。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1886**63636", "member": "string", "name": "AdminPhoneNum", "output_required": true, @@ -9062,7 +9060,7 @@ { "disabled": false, "document": "管理员邮箱地址。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ttt**@qq.com", "member": "string", "name": "AdminEmail", "output_required": true, @@ -9073,7 +9071,7 @@ { "disabled": false, "document": "管理员职位。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "boss", "member": "string", "name": "AdminPosition", "output_required": true, @@ -9084,7 +9082,7 @@ { "disabled": false, "document": "联系人名。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "luke", "member": "string", "name": "ContactFirstName", "output_required": true, @@ -9095,7 +9093,7 @@ { "disabled": false, "document": "联系人姓。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "sky", "member": "string", "name": "ContactLastName", "output_required": true, @@ -9106,7 +9104,7 @@ { "disabled": false, "document": "联系人电话号码。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "188**777372", "member": "string", "name": "ContactNumber", "output_required": true, @@ -9117,7 +9115,7 @@ { "disabled": false, "document": "联系人邮箱地址,\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ttt**@qq.com", "member": "string", "name": "ContactEmail", "output_required": true, @@ -9128,7 +9126,7 @@ { "disabled": false, "document": "联系人职位。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "Waibao", "member": "string", "name": "ContactPosition", "output_required": true, @@ -9139,7 +9137,7 @@ { "disabled": false, "document": "验证类型。\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "DNS", "member": "string", "name": "VerifyType", "output_required": true, @@ -9156,7 +9154,7 @@ { "disabled": false, "document": "是否可以下载nginx可用格式", - "example": "无", + "example": "true", "member": "bool", "name": "NGINX", "output_required": true, @@ -9166,7 +9164,7 @@ { "disabled": false, "document": "是否可以下载apache可用格式", - "example": "无", + "example": "true", "member": "bool", "name": "APACHE", "output_required": true, @@ -9176,7 +9174,7 @@ { "disabled": false, "document": "是否可以下载tomcat可用格式", - "example": "无", + "example": "true", "member": "bool", "name": "TOMCAT", "output_required": true, @@ -9186,7 +9184,7 @@ { "disabled": false, "document": "是否可以下载iis可用格式", - "example": "无", + "example": "true", "member": "bool", "name": "IIS", "output_required": true, @@ -9196,7 +9194,7 @@ { "disabled": false, "document": "是否可以下载JKS可用格式", - "example": "无", + "example": "true", "member": "bool", "name": "JKS", "output_required": true, @@ -9206,7 +9204,7 @@ { "disabled": false, "document": "是否可以下载其他格式", - "example": "无", + "example": "true", "member": "bool", "name": "OTHER", "output_required": true, @@ -9216,7 +9214,7 @@ { "disabled": false, "document": "是否可以下载根证书", - "example": "无", + "example": "true", "member": "bool", "name": "ROOT", "output_required": true, @@ -9232,7 +9230,7 @@ { "disabled": false, "document": "任务ID", - "example": "无", + "example": "1763773", "member": "string", "name": "TaskId", "output_required": true, @@ -9252,7 +9250,7 @@ { "disabled": false, "document": "关联云资源异步查询结果: 0表示查询中, 1表示查询成功。 2表示查询异常; 若状态为1,则查看BindResourceResult结果;若状态为2,则查看Error原因", - "example": "无", + "example": "0", "member": "uint64", "name": "Status", "output_required": true, @@ -9272,7 +9270,7 @@ { "disabled": false, "document": "当前结果缓存时间", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "CacheTime", "output_required": true, @@ -9288,7 +9286,7 @@ { "disabled": false, "document": "域名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "www.he**.com", "member": "string", "name": "Domain", "output_required": false, @@ -9298,7 +9296,7 @@ { "disabled": false, "document": "状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "Status", "output_required": false, @@ -9308,7 +9306,7 @@ { "disabled": false, "document": "统一域名状态\n\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "UnionStatus", "output_required": false, @@ -9318,7 +9316,7 @@ { "disabled": false, "document": "是否被抢占, 被抢占表示域名被其他环境绑定了,需要解绑或者重新绑定。\n\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "bool", "name": "IsPreempted", "output_required": false, @@ -9328,7 +9326,7 @@ { "disabled": false, "document": "icp黑名单封禁状态,0-未封禁,1-封禁\n\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "ICPStatus", "output_required": false, @@ -9338,7 +9336,7 @@ { "disabled": false, "document": "已绑定证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "heyhs*8he", "member": "string", "name": "OldCertificateId", "output_required": false, @@ -9380,7 +9378,7 @@ { "disabled": false, "document": "唯一ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "tcb-****", "member": "string", "name": "ID", "output_required": false, @@ -9390,7 +9388,7 @@ { "disabled": false, "document": "来源\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "original", "member": "string", "name": "Source", "output_required": false, @@ -9400,7 +9398,7 @@ { "disabled": false, "document": "名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "zrh", "member": "string", "name": "Name", "output_required": false, @@ -9410,7 +9408,7 @@ { "disabled": false, "document": "状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "normal", "member": "string", "name": "Status", "output_required": false, @@ -9462,7 +9460,7 @@ { "disabled": false, "document": "域名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "www.**.com", "member": "string", "name": "Domain", "output_required": false, @@ -9472,7 +9470,7 @@ { "disabled": false, "document": "状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "normal", "member": "string", "name": "Status", "output_required": false, @@ -9482,7 +9480,7 @@ { "disabled": false, "document": "解析状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "normal", "member": "string", "name": "DNSStatus", "output_required": false, @@ -9492,7 +9490,7 @@ { "disabled": false, "document": "已绑定证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "heys*8he", "member": "string", "name": "OldCertificateId", "output_required": false, @@ -9518,7 +9516,7 @@ { "disabled": false, "document": "数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10", "member": "int64", "name": "TotalCount", "output_required": false, @@ -9534,7 +9532,7 @@ { "disabled": false, "document": "地域", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, @@ -9554,7 +9552,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "Error", "output_required": true, @@ -9570,7 +9568,7 @@ { "disabled": false, "document": "网关ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "gateway-2ae9****", "member": "string", "name": "GatewayId", "output_required": false, @@ -9580,7 +9578,7 @@ { "disabled": false, "document": "网关名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "zrh-gateway", "member": "string", "name": "GatewayName", "output_required": false, @@ -9616,7 +9614,7 @@ { "disabled": false, "document": "该地域下TSE实例总数\t", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -9626,7 +9624,7 @@ { "disabled": false, "document": "地域\t", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, @@ -9636,7 +9634,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "Error", "output_required": true, @@ -9678,40 +9676,40 @@ { "disabled": false, "document": "域名", - "example": "无", + "example": "www.***.com", "member": "string", "name": "Host", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "证书ID", - "example": "无", + "example": "ejs**eb", "member": "string", "name": "CertId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "区域ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "zone-******", "member": "string", "name": "ZoneId", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "域名状态", - "example": "无", + "example": "enable", "member": "string", "name": "Status", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -9734,7 +9732,7 @@ { "disabled": false, "document": "edgeone实例总数\t", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -9744,7 +9742,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "Error", "output_required": true, @@ -9760,30 +9758,30 @@ { "disabled": false, "document": "ingress名称", - "example": "无", + "example": "ingress-***", "member": "string", "name": "IngressName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "tls域名列表", - "example": "无", + "example": "[\"hhh**.com\"]", "member": "string", "name": "TlsDomains", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "ingress域名列表", - "example": "无", + "example": "[\"hhh**.com\"]", "member": "string", "name": "Domains", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -9796,7 +9794,7 @@ { "disabled": false, "document": "集群ID", - "example": "无", + "example": "cls-lqet***", "member": "string", "name": "ClusterId", "output_required": true, @@ -9806,7 +9804,7 @@ { "disabled": false, "document": "集群名称", - "example": "无", + "example": "zrh", "member": "string", "name": "ClusterName", "output_required": true, @@ -9826,7 +9824,7 @@ { "disabled": false, "document": "集群类型", - "example": "无", + "example": "MANAGED_CLUSTER", "member": "string", "name": "ClusterType", "output_required": true, @@ -9836,7 +9834,7 @@ { "disabled": false, "document": "集群版本", - "example": "无", + "example": "1.26.1", "member": "string", "name": "ClusterVersion", "output_required": true, @@ -9852,7 +9850,7 @@ { "disabled": false, "document": "地域", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, @@ -9872,7 +9870,7 @@ { "disabled": false, "document": "该地域下tke实例总数\t", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -9882,7 +9880,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "Error", "output_required": true, @@ -9898,10 +9896,10 @@ { "disabled": false, "document": "namespace名称", - "example": "无", + "example": "tke-zrh", "member": "string", "name": "Name", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -9911,7 +9909,7 @@ "example": "无", "member": "TkeSecretDetail", "name": "SecretList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -9924,20 +9922,20 @@ { "disabled": false, "document": "secret名称", - "example": "无", + "example": "secret-***", "member": "string", "name": "Name", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "证书ID", - "example": "无", + "example": "heys**he", "member": "string", "name": "CertId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -9947,17 +9945,17 @@ "example": "无", "member": "TkeIngressDetail", "name": "IngressList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "和新证书不匹配的域名列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"www.h**m.com\"]", "member": "string", "name": "NoMatchDomains", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -9970,7 +9968,7 @@ { "disabled": false, "document": "一键更新原证书ID, 查询绑定该证书的云资源然后进行证书更新", - "example": "无", + "example": "hey**shje", "member": "string", "name": "OldCertificateId", "required": true, @@ -9979,7 +9977,7 @@ { "disabled": false, "document": "需要部署的资源类型,参数值可选(小写):clb、cdn、waf、live、ddos、teo、apigateway、vod、tke、tcb、tse、cos", - "example": "无", + "example": "[\"clb\",\"tke\"]", "member": "string", "name": "ResourceTypes", "required": true, @@ -9988,7 +9986,7 @@ { "disabled": false, "document": "一键更新新证书ID,不传则证书公钥和私钥必传", - "example": "无", + "example": "hey**shje", "member": "string", "name": "CertificateId", "required": false, @@ -9997,7 +9995,7 @@ { "disabled": true, "document": "需要部署的地域列表(废弃)", - "example": "无", + "example": "[\"guangzhou\"]", "member": "string", "name": "Regions", "required": false, @@ -10015,7 +10013,7 @@ { "disabled": false, "document": "证书公钥, 若上传证书公钥, 则CertificateId不用传", - "example": "无", + "example": "-----BEGIN CERTIFICATE----****", "member": "string", "name": "CertificatePublicKey", "required": false, @@ -10024,7 +10022,7 @@ { "disabled": false, "document": "证书私钥,若上传证书公钥, 则CertificateId不用传", - "example": "无", + "example": "-----BEGIN RSA PRIVATE KEY----***", "member": "string", "name": "CertificatePrivateKey", "required": false, @@ -10033,7 +10031,7 @@ { "disabled": false, "document": "旧证书是否忽略到期提醒 0:不忽略通知。1:忽略通知,忽略OldCertificateId到期提醒", - "example": "无", + "example": "1", "member": "uint64", "name": "ExpiringNotificationSwitch", "required": false, @@ -10042,7 +10040,7 @@ { "disabled": false, "document": "相同的证书是否允许重复上传,若选择上传证书, 则可以配置该参数", - "example": "无", + "example": "true", "member": "bool", "name": "Repeatable", "required": false, @@ -10051,7 +10049,7 @@ { "disabled": false, "document": "是否允许下载,若选择上传证书, 则可以配置该参数", - "example": "无", + "example": "true", "member": "bool", "name": "AllowDownload", "required": false, @@ -10069,7 +10067,7 @@ { "disabled": false, "document": "项目 ID,若选择上传证书, 则可以配置该参数", - "example": "无", + "example": "1788", "member": "uint64", "name": "ProjectId", "required": false, @@ -10084,7 +10082,7 @@ { "disabled": false, "document": "云资源部署任务ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "17636", "member": "uint64", "name": "DeployRecordId", "output_required": true, @@ -10094,7 +10092,7 @@ { "disabled": false, "document": "部署状态,1表示部署成功,0表示部署失败", - "example": "无", + "example": "1", "member": "int64", "name": "DeployStatus", "output_required": true, @@ -10177,7 +10175,7 @@ { "disabled": false, "document": "回滚部署记录ID", - "example": "无", + "example": "778392", "member": "int64", "name": "DeployRecordId", "output_required": true, @@ -10199,7 +10197,7 @@ { "disabled": false, "document": "详情记录id", - "example": "无", + "example": "178383", "member": "uint64", "name": "Id", "output_required": true, @@ -10209,7 +10207,7 @@ { "disabled": false, "document": "新证书ID", - "example": "无", + "example": "heysh**heh", "member": "string", "name": "CertId", "output_required": true, @@ -10219,7 +10217,7 @@ { "disabled": false, "document": "旧证书ID", - "example": "无", + "example": "hens*8hsh", "member": "string", "name": "OldCertId", "output_required": true, @@ -10229,7 +10227,7 @@ { "disabled": false, "document": "部署域名列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"www.hhh**.com\"]", "member": "string", "name": "Domains", "output_required": true, @@ -10239,7 +10237,7 @@ { "disabled": false, "document": "部署资源类型", - "example": "无", + "example": "CLB", "member": "string", "name": "ResourceType", "output_required": true, @@ -10249,7 +10247,7 @@ { "disabled": false, "document": "部署地域\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, @@ -10259,7 +10257,7 @@ { "disabled": false, "document": "部署状态", - "example": "无", + "example": "1", "member": "uint64", "name": "Status", "output_required": true, @@ -10269,7 +10267,7 @@ { "disabled": false, "document": "部署错误信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "ErrorMsg", "output_required": true, @@ -10279,7 +10277,7 @@ { "disabled": false, "document": "部署时间", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "CreateTime", "output_required": true, @@ -10289,7 +10287,7 @@ { "disabled": false, "document": "最后一次更新时间", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "UpdateTime", "output_required": true, @@ -10299,7 +10297,7 @@ { "disabled": false, "document": "部署实例ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cls-*****", "member": "string", "name": "InstanceId", "output_required": true, @@ -10309,7 +10307,7 @@ { "disabled": false, "document": "部署实例名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "zrh", "member": "string", "name": "InstanceName", "output_required": true, @@ -10319,7 +10317,7 @@ { "disabled": false, "document": "部署监听器ID(CLB专用)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "lbl-****", "member": "string", "name": "ListenerId", "output_required": true, @@ -10329,7 +10327,7 @@ { "disabled": false, "document": "部署监听器名称(CLB专用)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "zrh", "member": "string", "name": "ListenerName", "output_required": true, @@ -10339,7 +10337,7 @@ { "disabled": false, "document": "协议\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "https", "member": "string", "name": "Protocol", "output_required": true, @@ -10349,7 +10347,7 @@ { "disabled": false, "document": "是否开启SNI(CLB专用)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "uint64", "name": "SniSwitch", "output_required": true, @@ -10359,7 +10357,7 @@ { "disabled": false, "document": "bucket名称(COS专用)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cos-****", "member": "string", "name": "Bucket", "output_required": true, @@ -10369,7 +10367,7 @@ { "disabled": false, "document": "端口\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "90", "member": "int64", "name": "Port", "output_required": true, @@ -10379,7 +10377,7 @@ { "disabled": false, "document": "命名空间(TKE专用)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "tke-***", "member": "string", "name": "Namespace", "output_required": true, @@ -10389,7 +10387,7 @@ { "disabled": false, "document": "secret名称(TKE专用)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "secret-***", "member": "string", "name": "SecretName", "output_required": true, @@ -10399,7 +10397,7 @@ { "disabled": false, "document": "环境ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "lowcode-1gvf5xts7*****", "member": "string", "name": "EnvId", "output_required": false, @@ -10409,7 +10407,7 @@ { "disabled": false, "document": "TCB部署类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "product", "member": "string", "name": "TCBType", "output_required": false, @@ -10419,7 +10417,7 @@ { "disabled": false, "document": "监听器Url(clb专属)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "/zrh", "member": "string", "name": "Url", "output_required": false, @@ -10435,10 +10433,10 @@ { "disabled": false, "document": "部署资源类型", - "example": "无", + "example": "CLB", "member": "string", "name": "ResourceType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -10448,17 +10446,17 @@ "example": "无", "member": "UpdateRecordDetail", "name": "List", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "该部署资源总数", - "example": "无", + "example": "10", "member": "int64", "name": "TotalCount", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -10471,80 +10469,80 @@ { "disabled": false, "document": "记录ID", - "example": "无", + "example": "178837", "member": "uint64", "name": "Id", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "新证书ID", - "example": "无", + "example": "hey**heh", "member": "string", "name": "CertId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "原证书ID", - "example": "无", + "example": "hesy*8he", "member": "string", "name": "OldCertId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "部署资源类型列表", - "example": "无", + "example": "[\"CLB\"]", "member": "string", "name": "ResourceTypes", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "部署地域列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"ap-guangzhou\"]", "member": "string", "name": "Regions", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "部署状态", - "example": "无", + "example": "0", "member": "uint64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "部署时间", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "最后一次更新时间", - "example": "无", + "example": "2018-09-10 12:00:00", "member": "string", "name": "UpdateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false } @@ -10557,7 +10555,7 @@ { "disabled": false, "document": "资源类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "CLB", "member": "string", "name": "ResourceType", "output_required": true, @@ -10577,7 +10575,7 @@ { "disabled": false, "document": "异步更新进度状态:0, 待处理, 1 已处理, 3 处理中\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0", "member": "int64", "name": "Status", "output_required": true, @@ -10593,7 +10591,7 @@ { "disabled": false, "document": "资源类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "地域", + "example": "ap-guangzhou", "member": "string", "name": "Region", "output_required": true, @@ -10603,7 +10601,7 @@ { "disabled": false, "document": "总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "总数", + "example": "2", "member": "int64", "name": "TotalCount", "output_required": true, @@ -10613,7 +10611,7 @@ { "disabled": false, "document": "执行完成数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "偏移量", + "example": "2", "member": "int64", "name": "OffsetCount", "output_required": true, @@ -10623,7 +10621,7 @@ { "disabled": false, "document": "异步更新进度状态:0, 待处理, 1 已处理, 3 处理中\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "Status", "output_required": true, @@ -10639,7 +10637,7 @@ { "disabled": false, "document": "证书内容。", - "example": "无", + "example": "-----BEGIN CERTIFICATE----****", "member": "string", "name": "CertificatePublicKey", "required": true, @@ -10648,7 +10646,7 @@ { "disabled": false, "document": "私钥内容,证书类型为 SVR 时必填,为 CA 时可不填。", - "example": "无", + "example": "-----BEGIN RSA PRIVATE KEY-----", "member": "string", "name": "CertificatePrivateKey", "required": false, @@ -10657,7 +10655,7 @@ { "disabled": false, "document": "证书类型,默认 SVR。CA = CA证书,SVR = 服务器证书。", - "example": "无", + "example": "SVR", "member": "string", "name": "CertificateType", "required": false, @@ -10666,7 +10664,7 @@ { "disabled": false, "document": "备注名称。", - "example": "无", + "example": "hello", "member": "string", "name": "Alias", "required": false, @@ -10675,7 +10673,7 @@ { "disabled": false, "document": "项目 ID。", - "example": "无", + "example": "175666", "member": "uint64", "name": "ProjectId", "required": false, @@ -10684,7 +10682,7 @@ { "disabled": false, "document": "证书用途/证书来源。“CLB,CDN,WAF,LIVE,DDOS”", - "example": "无", + "example": "CLB", "member": "string", "name": "CertificateUse", "required": false, @@ -10717,7 +10715,7 @@ { "disabled": false, "document": "证书 ID。", - "example": "无", + "example": "heyy**hehs", "member": "string", "name": "CertificateId", "output_required": true, @@ -10727,7 +10725,7 @@ { "disabled": false, "document": "重复证书的ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "heys**jsk", "member": "string", "name": "RepeatCertId", "output_required": true, @@ -10871,7 +10869,7 @@ { "disabled": false, "document": "该地域下vod实例总数\t", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -10881,7 +10879,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "Error", "output_required": true, @@ -10960,7 +10958,7 @@ { "disabled": false, "document": "域名", - "example": "无", + "example": "www.hy**.com", "member": "string", "name": "Domain", "output_required": true, @@ -10970,7 +10968,7 @@ { "disabled": false, "document": "证书ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "hey*hhs", "member": "string", "name": "CertId", "output_required": true, @@ -10980,7 +10978,7 @@ { "disabled": false, "document": "是否保持长连接,1是,0 否\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "uint64", "name": "Keepalive", "output_required": true, @@ -10996,7 +10994,7 @@ { "disabled": false, "document": "地域", - "example": "无", + "example": "ap-guanzhou", "member": "string", "name": "Region", "output_required": true, @@ -11016,7 +11014,7 @@ { "disabled": false, "document": "该地域下waf实例总数\t", - "example": "无", + "example": "10", "member": "uint64", "name": "TotalCount", "output_required": true, @@ -11026,7 +11024,7 @@ { "disabled": false, "document": "是否查询异常\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "no region", "member": "string", "name": "Error", "output_required": true, diff --git a/tccli/services/ssl/v20191205/examples.json b/tccli/services/ssl/v20191205/examples.json index eb1c357f1c..0fc07443e9 100644 --- a/tccli/services/ssl/v20191205/examples.json +++ b/tccli/services/ssl/v20191205/examples.json @@ -151,8 +151,8 @@ "DescribeCertificateBindResourceTaskDetail": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: ssl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCertificateBindResourceTaskDetail\n<公共请求参数>\n\n{\n \"TaskId\": \"abc\",\n \"Limit\": \"abc\",\n \"Offset\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"CLB\": [\n {\n \"Region\": \"abc\",\n \"InstanceList\": [\n {\n \"LoadBalancerId\": \"abc\",\n \"LoadBalancerName\": \"abc\",\n \"Listeners\": [\n {\n \"ListenerId\": \"abc\",\n \"ListenerName\": \"abc\",\n \"SniSwitch\": 1,\n \"Protocol\": \"abc\",\n \"Certificate\": {\n \"CertId\": \"abc\",\n \"DnsNames\": [\n \"abc\"\n ],\n \"CertCaId\": \"abc\",\n \"SSLMode\": \"abc\"\n },\n \"Rules\": [\n {\n \"LocationId\": \"abc\",\n \"Domain\": \"abc\",\n \"IsMatch\": true,\n \"Certificate\": {\n \"CertId\": \"abc\",\n \"DnsNames\": [\n \"abc\"\n ],\n \"CertCaId\": \"abc\",\n \"SSLMode\": \"abc\"\n },\n \"NoMatchDomains\": [\n \"abc\"\n ]\n }\n ],\n \"NoMatchDomains\": [\n \"abc\"\n ]\n }\n ]\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"CDN\": [\n {\n \"TotalCount\": 1,\n \"InstanceList\": [\n {\n \"Domain\": \"abc\",\n \"CertId\": \"abc\",\n \"Status\": \"abc\",\n \"HttpsBillingSwitch\": \"abc\"\n }\n ],\n \"Error\": \"\"\n }\n ],\n \"WAF\": [\n {\n \"Region\": \"abc\",\n \"InstanceList\": [\n {\n \"Domain\": \"abc\",\n \"CertId\": \"abc\",\n \"Keepalive\": 1\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"DDOS\": [\n {\n \"TotalCount\": 1,\n \"InstanceList\": [\n {\n \"Domain\": \"abc\",\n \"InstanceId\": \"abc\",\n \"Protocol\": \"abc\",\n \"CertId\": \"abc\",\n \"VirtualPort\": \"abc\"\n }\n ],\n \"Error\": \"\"\n }\n ],\n \"LIVE\": [\n {\n \"TotalCount\": 1,\n \"InstanceList\": [\n {\n \"Domain\": \"abc\",\n \"CertId\": \"abc\",\n \"Status\": 0\n }\n ],\n \"Error\": \"\"\n }\n ],\n \"VOD\": [\n {\n \"InstanceList\": [\n {\n \"Domain\": \"abc\",\n \"CertId\": \"abc\"\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"TKE\": [\n {\n \"Region\": \"abc\",\n \"InstanceList\": [\n {\n \"ClusterId\": \"abc\",\n \"ClusterName\": \"abc\",\n \"NamespaceList\": [\n {\n \"Name\": \"abc\",\n \"SecretList\": [\n {\n \"Name\": \"abc\",\n \"CertId\": \"abc\",\n \"IngressList\": [\n {\n \"IngressName\": \"abc\",\n \"TlsDomains\": [\n \"abc\"\n ],\n \"Domains\": [\n \"abc\"\n ]\n }\n ],\n \"NoMatchDomains\": [\n \"abc\"\n ]\n }\n ]\n }\n ],\n \"ClusterType\": \"abc\",\n \"ClusterVersion\": \"abc\"\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"APIGATEWAY\": [\n {\n \"Region\": \"abc\",\n \"InstanceList\": [\n {\n \"ServiceId\": \"abc\",\n \"ServiceName\": \"abc\",\n \"Domain\": \"abc\",\n \"CertId\": \"abc\",\n \"Protocol\": \"abc\"\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"TCB\": [\n {\n \"Region\": \"abc\",\n \"Error\": \"\",\n \"Environments\": [\n {\n \"Environment\": {\n \"ID\": \"abc\",\n \"Source\": \"abc\",\n \"Name\": \"abc\",\n \"Status\": \"abc\"\n },\n \"AccessService\": {\n \"InstanceList\": [\n {\n \"Domain\": \"abc\",\n \"Status\": 0,\n \"UnionStatus\": 0,\n \"IsPreempted\": true,\n \"ICPStatus\": 0,\n \"OldCertificateId\": \"abc\"\n }\n ],\n \"TotalCount\": 0\n },\n \"HostService\": {\n \"InstanceList\": [\n {\n \"Domain\": \"abc\",\n \"Status\": \"abc\",\n \"DNSStatus\": \"abc\",\n \"OldCertificateId\": \"abc\"\n }\n ],\n \"TotalCount\": 0\n }\n }\n ]\n }\n ],\n \"TEO\": [\n {\n \"InstanceList\": [\n {\n \"Host\": \"abc\",\n \"CertId\": \"abc\",\n \"ZoneId\": \"abc\",\n \"Status\": \"abc\"\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"Status\": 1,\n \"CacheTime\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: ssl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCertificateBindResourceTaskDetail\n<公共请求参数>\n\n{\n \"TaskId\": \"758439\",\n \"Limit\": \"0\",\n \"Offset\": \"10\"\n}", + "output": "{\n \"Response\": {\n \"CLB\": [\n {\n \"Region\": \"ap-guangzhou\",\n \"InstanceList\": [\n {\n \"LoadBalancerId\": \"lb-*****\",\n \"LoadBalancerName\": \"test\",\n \"Listeners\": [\n {\n \"ListenerId\": \"lbl-*****\",\n \"ListenerName\": \"test\",\n \"SniSwitch\": 1,\n \"Protocol\": \"https\",\n \"Certificate\": {\n \"CertId\": \"T***jdj\",\n \"DnsNames\": [\n \"www.test.com\"\n ],\n \"CertCaId\": \"T***jdj\",\n \"SSLMode\": \"mutual\"\n },\n \"Rules\": [\n {\n \"LocationId\": \"/test\",\n \"Domain\": \"www.test.com\",\n \"IsMatch\": true,\n \"Certificate\": {\n \"CertId\": \"hr***jdj\",\n \"DnsNames\": [\n \"www.test.com\"\n ],\n \"CertCaId\": \"hr***jdj\",\n \"SSLMode\": \"mutual\"\n },\n \"NoMatchDomains\": [\n \"www.test2.com\"\n ]\n }\n ],\n \"NoMatchDomains\": [\n \"www.test2.com\"\n ]\n }\n ]\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"CDN\": [\n {\n \"TotalCount\": 1,\n \"InstanceList\": [\n {\n \"Domain\": \"www.test.com\",\n \"CertId\": \"T***jdj\",\n \"Status\": \"online\",\n \"HttpsBillingSwitch\": \"on\"\n }\n ],\n \"Error\": \"\"\n }\n ],\n \"WAF\": [\n {\n \"Region\": \"ap-guangzhou\",\n \"InstanceList\": [\n {\n \"Domain\": \"www.test.com\",\n \"CertId\": \"T***jdj\",\n \"Keepalive\": 1\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"DDOS\": [\n {\n \"TotalCount\": 1,\n \"InstanceList\": [\n {\n \"Domain\": \"www.test.com\",\n \"InstanceId\": \"ddos-*****\",\n \"Protocol\": \"https\",\n \"CertId\": \"T***jdj\",\n \"VirtualPort\": \"443\"\n }\n ],\n \"Error\": \"\"\n }\n ],\n \"LIVE\": [\n {\n \"TotalCount\": 1,\n \"InstanceList\": [\n {\n \"Domain\": \"www.test.com\",\n \"CertId\": \"T***jdj\",\n \"Status\": 0\n }\n ],\n \"Error\": \"\"\n }\n ],\n \"VOD\": [\n {\n \"InstanceList\": [\n {\n \"Domain\": \"www.test.com\",\n \"CertId\": \"T***jdj\"\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"TKE\": [\n {\n \"Region\": \"ap-guangzhou\",\n \"InstanceList\": [\n {\n \"ClusterId\": \"test\",\n \"ClusterName\": \"test\",\n \"NamespaceList\": [\n {\n \"Name\": \"test\",\n \"SecretList\": [\n {\n \"Name\": \"test\",\n \"CertId\": \"T***jdj\",\n \"IngressList\": [\n {\n \"IngressName\": \"test\",\n \"TlsDomains\": [\n \"www.test.com\"\n ],\n \"Domains\": [\n \"www.test.com\"\n ]\n }\n ],\n \"NoMatchDomains\": [\n \"www.test2.com\"\n ]\n }\n ]\n }\n ],\n \"ClusterType\": \"tke\",\n \"ClusterVersion\": \"1.16\"\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"APIGATEWAY\": [\n {\n \"Region\": \"ap-guangzhou\",\n \"InstanceList\": [\n {\n \"ServiceId\": \"service-*****\",\n \"ServiceName\": \"test\",\n \"Domain\": \"www.test.com\",\n \"CertId\": \"T***jdj\",\n \"Protocol\": \"https\"\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"TCB\": [\n {\n \"Region\": \"ap-guangzhou\",\n \"Error\": \"\",\n \"Environments\": [\n {\n \"Environment\": {\n \"ID\": \"TCB-*****\",\n \"Source\": \"cdn\",\n \"Name\": \"test-*****\",\n \"Status\": \"online\"\n },\n \"AccessService\": {\n \"InstanceList\": [\n {\n \"Domain\": \"www.test.com\",\n \"Status\": 0,\n \"UnionStatus\": 0,\n \"IsPreempted\": true,\n \"ICPStatus\": 0,\n \"OldCertificateId\": \"jd***jdj\"\n }\n ],\n \"TotalCount\": 0\n },\n \"HostService\": {\n \"InstanceList\": [\n {\n \"Domain\": \"www.test.com\",\n \"Status\": \"online\",\n \"DNSStatus\": \"online\",\n \"OldCertificateId\": \"jd***jdj\"\n }\n ],\n \"TotalCount\": 0\n }\n }\n ]\n }\n ],\n \"TEO\": [\n {\n \"InstanceList\": [\n {\n \"Host\": \"www.test.com\",\n \"CertId\": \"T***jdj\",\n \"ZoneId\": \"zone-*****\",\n \"Status\": \"online\"\n }\n ],\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ],\n \"Status\": 1,\n \"CacheTime\": \"2023-10-12 12:00:00\",\n \"RequestId\": \"14727a68-3b90-4408-99c9-dea6d7de9456\"\n }\n}", "title": "证书关联云资源详情" } ], @@ -160,7 +160,7 @@ { "document": "仅返回总数", "input": "POST / HTTP/1.1\nHost: ssl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCertificateBindResourceTaskResult\n<公共请求参数>\n\n{\n \"TaskIds\": [\n \"748599\"\n ]\n}", - "output": "{\n \"Response\": {\n \"SyncTaskBindResourceResult\": [\n {\n \"TaskId\": \"748599\",\n \"BindResourceResult\": [\n {\n \"ResourceType\": \"clb\",\n \"BindResourceRegionResult\": [\n {\n \"Region\": \"ap-guangzhou\",\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ]\n }\n ],\n \"Status\": 1,\n \"Error\": null,\n \"CacheTime\": \"2023-10-12 12:00:00\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"SyncTaskBindResourceResult\": [\n {\n \"TaskId\": \"748599\",\n \"BindResourceResult\": [\n {\n \"ResourceType\": \"clb\",\n \"BindResourceRegionResult\": [\n {\n \"Region\": \"ap-guangzhou\",\n \"TotalCount\": 1,\n \"Error\": \"\"\n }\n ]\n }\n ],\n \"Status\": 1,\n \"Error\": null,\n \"CacheTime\": \"2023-10-12 12:00:00\"\n }\n ],\n \"RequestId\": \"d9aa752b-dbd8-49c9-958f-75c051eddfe2\"\n }\n}", "title": "查询证书关联云资源结果 " } ], @@ -277,8 +277,8 @@ "DescribeHostDeployRecordDetail": [ { "document": "查询证书云资源部署记录详情列表", - "input": "POST / HTTP/1.1\nHost: ssl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeHostDeployRecordDetail\n<公共请求参数>\n\n{\n \"DeployRecordId\": \"1\"\n}", - "output": "{\n \"Response\": {\n \"FailedTotalCount\": 1,\n \"SuccessTotalCount\": 1,\n \"TotalCount\": 1,\n \"RequestId\": \"xx111\",\n \"RunningTotalCount\": 1,\n \"DeployRecordDetailList\": [\n {\n \"Status\": 1,\n \"Bucket\": \"test-1302189209\",\n \"UpdateTime\": \"xx1\",\n \"CertId\": \"xx1\",\n \"Protocol\": \"xx1\",\n \"InstanceId\": \"xx1\",\n \"ErrorMsg\": \"xx1\",\n \"ListenerId\": \"xx1\",\n \"CreateTime\": \"xaax\",\n \"OldCertId\": \"xaax\",\n \"EnvId\": \"ssl-xx\",\n \"TCBType\": \"HostService\",\n \"Region\": \"ap-shanghai\",\n \"SniSwitch\": 1,\n \"SecretName\": \"asdasd\",\n \"ListenerName\": \"asdasd\",\n \"Port\": \"123\",\n \"Namespace\": \"asdasd\",\n \"Domains\": [\n \"xx1\"\n ],\n \"InstanceName\": \"xx2\",\n \"Id\": 1\n }\n ]\n }\n}", + "input": "POST / HTTP/1.1\nHost: ssl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeHostDeployRecordDetail\n<公共请求参数>\n\n{\n \"DeployRecordId\": \"74889\"\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"SuccessTotalCount\": 1,\n \"FailedTotalCount\": 0,\n \"RunningTotalCount\": 0,\n \"DeployRecordDetailList\": [\n {\n \"Id\": 182241,\n \"CertId\": \"Fvu**OA\",\n \"OldCertId\": \"FxG***jc\",\n \"Status\": 1,\n \"ErrorMsg\": \"\",\n \"CreateTime\": \"2024-06-26T11:36:33.000000Z\",\n \"UpdateTime\": \"2024-06-26T11:37:40.000000Z\",\n \"InstanceId\": \"lb-jaj**fy\",\n \"InstanceName\": \"zrhtest2\",\n \"ListenerId\": \"lbl-fx***3l2\",\n \"ListenerName\": \"zrhtest7\",\n \"Domains\": [\n \"ni***uang.online\"\n ],\n \"Protocol\": \"HTTPS\",\n \"SniSwitch\": 1,\n \"Bucket\": \"\",\n \"Namespace\": \"\",\n \"SecretName\": \"\",\n \"EnvId\": \"\",\n \"TCBType\": \"\",\n \"Region\": \"\",\n \"Port\": 0,\n \"Url\": [\n \"/zrh1\",\n \"/zrh2\"\n ]\n }\n ],\n \"RequestId\": \"14727a68-3b90-4408-99c9-dea6d7de9456\"\n }\n}", "title": "查询证书云资源部署记录详情列表" } ], @@ -301,8 +301,8 @@ "DescribeHostTeoInstanceList": [ { "document": "获取EdgeOne网关实例列表", - "input": "POST / HTTP/1.1\nHost: ssl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeHostTeoInstanceList\n<公共请求参数>\n\n{\n \"CertificateId\": \"abc\",\n \"IsCache\": 1,\n \"Filters\": [\n {\n \"FilterKey\": \"abc\",\n \"FilterValue\": \"abc\"\n }\n ],\n \"ResourceType\": \"abc\",\n \"OldCertificateId\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"InstanceList\": [\n {\n \"Host\": \"abc\",\n \"CertId\": \"abc\",\n \"ZoneId\": \"abc\",\n \"Status\": \"abc\"\n }\n ],\n \"TotalCount\": 0,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: ssl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeHostTeoInstanceList\n<公共请求参数>\n\n{\n \"CertificateId\": \"YT****j\",\n \"IsCache\": 1,\n \"Filters\": [\n {\n \"FilterKey\": \"domainMatch\",\n \"FilterValue\": \"1\"\n }\n ],\n \"ResourceType\": \"teo\",\n \"OldCertificateId\": \"k****j\"\n}", + "output": "{\n \"Response\": {\n \"InstanceList\": [\n {\n \"Host\": \"www.zrh.com\",\n \"CertId\": \"jk****L\",\n \"ZoneId\": \"zone-*****\",\n \"Status\": \"online\"\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"14727a68-3b90-4408-99c9-dea6d7de9456\"\n }\n}", "title": "获取EdgeOne实例列表" } ], @@ -318,7 +318,7 @@ { "document": "查询证书云资源更新记录列表", "input": "POST / HTTP/1.1\nHost: ssl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeHostUpdateRecord\n<公共请求参数>\n\n{\n \"OldCertificateId\": \"zYrIXwpu\"\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"DeployRecordList\": [\n {\n \"Id\": 73839,\n \"CertId\": \"jdjenhss\",\n \"OldCertId\": \"zYrIXwpu\",\n \"ResourceTypes\": [\n \"clb\"\n ],\n \"Regions\": [\n \"ap-guangzhou\"\n ],\n \"Status\": 1,\n \"CreateTime\": \"2023-12-18 12:00:00\",\n \"UpdateTime\": \"2023-12-18 12:11:00\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"DeployRecordList\": [\n {\n \"Id\": 73839,\n \"CertId\": \"jdjenhss\",\n \"OldCertId\": \"zYrIXwpu\",\n \"ResourceTypes\": [\n \"clb\"\n ],\n \"Regions\": [\n \"ap-guangzhou\"\n ],\n \"Status\": 1,\n \"CreateTime\": \"2023-12-18 12:00:00\",\n \"UpdateTime\": \"2023-12-18 12:11:00\"\n }\n ],\n \"RequestId\": \"d9aa752b-dbd8-49c9-958f-75c051eddfe2\"\n }\n}", "title": "查询证书云资源更新记录列表" } ], diff --git a/tccli/services/tbaas/v20180416/api.json b/tccli/services/tbaas/v20180416/api.json index c0d4c64bfa..7db2b8f79c 100644 --- a/tccli/services/tbaas/v20180416/api.json +++ b/tccli/services/tbaas/v20180416/api.json @@ -38,14 +38,14 @@ "GetBlockList": { "document": "查看当前网络下的所有区块列表,分页展示", "input": "GetBlockListRequest", - "name": "查询区块列表", + "name": "查询fabric的区块列表", "output": "GetBlockListResponse", "status": "online" }, "GetBlockTransactionListForUser": { - "document": "获取区块内的交易列表", + "document": "获取区块内交易列表", "input": "GetBlockTransactionListForUserRequest", - "name": "获取区块内的交易列表", + "name": "获取区块内交易列表", "output": "GetBlockTransactionListForUserResponse", "status": "online" }, @@ -78,9 +78,9 @@ "status": "online" }, "GetTransactionDetailForUser": { - "document": "获取交易详情", + "document": "获取交易的详情", "input": "GetTransactionDetailForUserRequest", - "name": "获取交易详情", + "name": "获取交易的详情", "output": "GetTransactionDetailForUserResponse", "status": "online" }, @@ -235,7 +235,7 @@ { "disabled": false, "document": "模块名,固定字段:cert_mng", - "example": "", + "example": "cert_mng", "member": "string", "name": "Module", "required": true, @@ -244,7 +244,7 @@ { "disabled": false, "document": "操作名,固定字段:cert_apply_for_user", - "example": "", + "example": "cert_apply_for_user", "member": "string", "name": "Operation", "required": true, @@ -253,7 +253,7 @@ { "disabled": false, "document": "区块链网络ID,可在区块链网络详情或列表中获取", - "example": "", + "example": "251005746bckuobc41mpu", "member": "string", "name": "ClusterId", "required": true, @@ -262,7 +262,7 @@ { "disabled": false, "document": "申请证书的组织名称,可以在组织管理列表中获取当前组织的名称", - "example": "", + "example": "youtuOrg", "member": "string", "name": "GroupName", "required": true, @@ -271,7 +271,7 @@ { "disabled": false, "document": "用户证书标识,用于标识用户证书,要求由纯小写字母组成,长度小于10", - "example": "", + "example": "usercert", "member": "string", "name": "UserIdentity", "required": true, @@ -280,7 +280,7 @@ { "disabled": false, "document": "证书申请实体,使用腾讯云账号实名认证的名称", - "example": "", + "example": "优图SDK", "member": "string", "name": "Applicant", "required": true, @@ -289,7 +289,7 @@ { "disabled": false, "document": "证件号码。如果腾讯云账号对应的实名认证类型为企业认证,填入“0”;如果腾讯云账号对应的实名认证类型为个人认证,填入个人身份证号码", - "example": "", + "example": "3452***321", "member": "string", "name": "IdentityNum", "required": true, @@ -298,7 +298,7 @@ { "disabled": false, "document": "csr p10证书文件。需要用户根据文档生成证书的CSR文件", - "example": "", + "example": "-----BEGINCERTIFICATEREQUEST-----", "member": "string", "name": "CsrData", "required": true, @@ -307,7 +307,7 @@ { "disabled": false, "document": "证书备注信息", - "example": "", + "example": "user", "member": "string", "name": "Notes", "required": false, @@ -322,18 +322,20 @@ { "disabled": false, "document": "证书ID", - "example": "", + "example": "172634", "member": "uint64", "name": "CertId", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "证书DN", - "example": "", + "example": "C=CN,ST=ShenZhen,L=4ShenZhen,O=org1,OU=client,CN=kylouse@org1.bcdk3eis17qe@client", "member": "string", "name": "CertDn", + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -603,7 +605,7 @@ { "disabled": false, "document": "区块Hash", - "example": "abc", + "example": "90af8cff95cfc2b9caeafc9d53bc04a699ef47e381143d66e5d03548deab1aa5 ", "member": "string", "name": "BlockHash", "output_required": false, @@ -613,7 +615,7 @@ { "disabled": false, "document": "前置区块Hash", - "example": "abc", + "example": "1d40d9c1fc8929c0b5ba4048f6a756543695664976cec7c8ac76e587587dfa01", "member": "string", "name": "PreBlockHash", "output_required": false, @@ -633,7 +635,7 @@ { "disabled": false, "document": "区块中交易列表", - "example": "[]", + "example": "无", "member": "Transaction", "name": "TransactionList", "output_required": false, @@ -938,7 +940,7 @@ { "disabled": false, "document": "模块名称,固定字段:block", - "example": "", + "example": "block", "member": "string", "name": "Module", "required": true, @@ -947,7 +949,7 @@ { "disabled": false, "document": "操作名称,固定字段:block_list", - "example": "", + "example": "block_list", "member": "string", "name": "Operation", "required": true, @@ -956,7 +958,7 @@ { "disabled": false, "document": "通道ID,固定字段:0", - "example": "", + "example": "12", "member": "uint64", "name": "ChannelId", "required": true, @@ -965,7 +967,7 @@ { "disabled": false, "document": "组织ID,固定字段:0", - "example": "", + "example": "32", "member": "uint64", "name": "GroupId", "required": true, @@ -974,7 +976,7 @@ { "disabled": false, "document": "需要查询的通道名称,可在通道详情或列表中获取", - "example": "", + "example": "factch", "member": "string", "name": "ChannelName", "required": true, @@ -983,7 +985,7 @@ { "disabled": false, "document": "调用接口的组织名称,可以在组织管理列表中获取当前组织的名称", - "example": "", + "example": "liulanOrg", "member": "string", "name": "GroupName", "required": true, @@ -992,7 +994,7 @@ { "disabled": false, "document": "区块链网络ID,可在区块链网络详情或列表中获取", - "example": "", + "example": "251005746bc0f03q8u93j", "member": "string", "name": "ClusterId", "required": true, @@ -1001,7 +1003,7 @@ { "disabled": false, "document": "需要获取的起始交易偏移", - "example": "", + "example": "0", "member": "uint64", "name": "Offset", "required": false, @@ -1010,7 +1012,7 @@ { "disabled": false, "document": "需要获取的交易数量", - "example": "", + "example": "10", "member": "uint64", "name": "Limit", "required": false, @@ -1025,18 +1027,20 @@ { "disabled": false, "document": "区块数量", - "example": "", + "example": "6", "member": "uint64", "name": "TotalCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "区块列表", - "example": "", + "example": "无", "member": "Block", "name": "BlockList", + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1055,7 +1059,7 @@ { "disabled": false, "document": "模块名,固定字段:transaction", - "example": "", + "example": "transaction", "member": "string", "name": "Module", "required": true, @@ -1064,7 +1068,7 @@ { "disabled": false, "document": "操作名,固定字段:block_transaction_list_for_user", - "example": "", + "example": "block_transaction_list_for_user", "member": "string", "name": "Operation", "required": true, @@ -1073,7 +1077,7 @@ { "disabled": false, "document": "区块链网络ID,可在区块链网络详情或列表中获取", - "example": "", + "example": "251005746bcdk3eis17qe", "member": "string", "name": "ClusterId", "required": true, @@ -1082,7 +1086,7 @@ { "disabled": false, "document": "参与交易的组织名称,可以在组织管理列表中获取当前组织的名称", - "example": "", + "example": "org1", "member": "string", "name": "GroupName", "required": true, @@ -1091,7 +1095,7 @@ { "disabled": false, "document": "业务所属通道名称,可在通道详情或列表中获取", - "example": "", + "example": "fronttest3", "member": "string", "name": "ChannelName", "required": true, @@ -1100,7 +1104,7 @@ { "disabled": false, "document": "区块ID,通过GetInvokeTx接口可以获取交易所在的区块ID", - "example": "", + "example": "2", "member": "uint64", "name": "BlockId", "required": true, @@ -1109,7 +1113,7 @@ { "disabled": false, "document": "查询的交易列表起始偏移地址", - "example": "", + "example": "0", "member": "uint64", "name": "Offset", "required": false, @@ -1118,7 +1122,7 @@ { "disabled": false, "document": "查询的交易列表数量", - "example": "", + "example": "10", "member": "uint64", "name": "Limit", "required": false, @@ -1133,18 +1137,20 @@ { "disabled": false, "document": "交易总数量", - "example": "", + "example": "1", "member": "uint64", "name": "TotalCount", + "required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "交易列表", - "example": "", + "example": "无", "member": "TransactionItem", "name": "TransactionList", + "required": true, "type": "list", "value_allowed_null": false }, @@ -1163,7 +1169,7 @@ { "disabled": false, "document": "模块名称,固定字段:cluster_mng", - "example": "", + "example": "cluster_mng", "member": "string", "name": "Module", "required": true, @@ -1172,7 +1178,7 @@ { "disabled": false, "document": "操作名称,固定字段:cluster_summary", - "example": "", + "example": "cluster_summary", "member": "string", "name": "Operation", "required": true, @@ -1181,7 +1187,7 @@ { "disabled": false, "document": "区块链网络ID,可在区块链网络详情或列表中获取", - "example": "", + "example": "251005746bc0f03q8u93j", "member": "string", "name": "ClusterId", "required": true, @@ -1190,7 +1196,7 @@ { "disabled": false, "document": "组织ID,固定字段:0", - "example": "", + "example": "12", "member": "uint64", "name": "GroupId", "required": true, @@ -1199,7 +1205,7 @@ { "disabled": false, "document": "调用接口的组织名称,可以在组织管理列表中获取当前组织的名称", - "example": "", + "example": "liulanOrg", "member": "string", "name": "GroupName", "required": true, @@ -1214,135 +1220,150 @@ { "disabled": false, "document": "网络通道总数量", - "example": "", + "example": "1", "member": "uint64", "name": "TotalChannelCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "当前组织创建的通道数量", - "example": "", + "example": "1", "member": "uint64", "name": "MyChannelCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "当前组织加入的通道数量", - "example": "", + "example": "1", "member": "uint64", "name": "JoinChannelCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "网络节点总数量", - "example": "", + "example": "2", "member": "uint64", "name": "TotalPeerCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "当前组织创建的节点数量", - "example": "", + "example": "2", "member": "uint64", "name": "MyPeerCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "其他组织创建的节点数量", - "example": "", + "example": "0", "member": "uint64", "name": "OrderCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "网络组织总数量", - "example": "", + "example": "1", "member": "uint64", "name": "TotalGroupCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "当前组织创建的组织数量", - "example": "", + "example": "1", "member": "uint64", "name": "MyGroupCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "网络智能合约总数量", - "example": "", + "example": "1", "member": "uint64", "name": "TotalChaincodeCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "最近7天发起的智能合约数量", - "example": "", + "example": "1", "member": "uint64", "name": "RecentChaincodeCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "当前组织发起的智能合约数量", - "example": "", + "example": "1", "member": "uint64", "name": "MyChaincodeCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "当前组织的证书总数量", - "example": "", + "example": "8", "member": "uint64", "name": "TotalCertCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "颁发给当前组织的证书数量", - "example": "", + "example": "4", "member": "uint64", "name": "TlsCertCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "网络背书节点证书数量", - "example": "", + "example": "2", "member": "uint64", "name": "PeerCertCount", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "当前组织业务证书数量", - "example": "", + "example": "2", "member": "uint64", "name": "ClientCertCount", + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -1733,7 +1754,7 @@ { "disabled": false, "document": "模块名,固定字段:transaction", - "example": "", + "example": "transaction", "member": "string", "name": "Module", "required": true, @@ -1742,7 +1763,7 @@ { "disabled": false, "document": "操作名,固定字段:transaction_detail_for_user", - "example": "", + "example": "transaction_detail_for_user", "member": "string", "name": "Operation", "required": true, @@ -1751,7 +1772,7 @@ { "disabled": false, "document": "区块链网络ID,可在区块链网络详情或列表中获取", - "example": "", + "example": "251005746bcd6xjfka7pi", "member": "string", "name": "ClusterId", "required": true, @@ -1760,7 +1781,7 @@ { "disabled": false, "document": "参与交易的组织名称,可以在组织管理列表中获取当前组织的名称", - "example": "", + "example": "org2", "member": "string", "name": "GroupName", "required": true, @@ -1769,7 +1790,7 @@ { "disabled": false, "document": "业务所属通道名称,可在通道详情或列表中获取", - "example": "", + "example": "factch", "member": "string", "name": "ChannelName", "required": true, @@ -1778,7 +1799,7 @@ { "disabled": false, "document": "区块ID,通过GetInvokeTx接口可以获取交易所在的区块ID", - "example": "", + "example": "1", "member": "uint64", "name": "BlockId", "required": true, @@ -1787,7 +1808,7 @@ { "disabled": false, "document": "交易ID,需要查询的详情的交易ID", - "example": "", + "example": "42c562517707bf53f08fe6e5a1cf5f50c784352ff0d8166e77514ebe518bd6c0", "member": "string", "name": "TransactionId", "required": true, @@ -1802,117 +1823,130 @@ { "disabled": false, "document": "交易ID", - "example": "", + "example": "42c562517707bf53f08fe6e5a1cf5f50c784352ff0d8166e77514ebe518bd6c0", "member": "string", "name": "TransactionId", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "交易hash", - "example": "", + "example": "42c562517707bf53f08fe6e5a1cf5f50c784352ff0d8166e77514ebe518bd6c0", "member": "string", "name": "TransactionHash", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "创建交易的组织名", - "example": "", + "example": "org2", "member": "string", "name": "CreateOrgName", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "交易类型(普通交易和配置交易)", - "example": "", + "example": "CONFIG", "member": "string", "name": "TransactionType", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "交易状态", - "example": "", + "example": "VALID", "member": "string", "name": "TransactionStatus", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "交易创建时间", - "example": "", + "example": "2019-10-28 18:48:28", "member": "string", "name": "CreateTime", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "交易数据", - "example": "", + "example": "eyJjaGFpbmNvZGVfc3BlYyI6eyJ0aW1lb3V0IjowLCJ0eXBlIjoiVU5ERUZJTkVEIn19", "member": "string", "name": "TransactionData", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "交易所在区块号", - "example": "", + "example": "1", "member": "uint64", "name": "BlockId", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "交易所在区块哈希", - "example": "", + "example": "a0f1bd5819e1e664873c3d903d005f9f24661986c2c4c541a185f613fdeaff52", "member": "string", "name": "BlockHash", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "交易所在区块高度", - "example": "", + "example": "1", "member": "uint64", "name": "BlockHeight", + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "通道名称", - "example": "", + "example": "factch", "member": "string", "name": "ChannelName", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "交易所在合约名称", - "example": "", + "example": "fact", "member": "string", "name": "ContractName", + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "背书组织列表", - "example": "", + "example": "无", "member": "EndorserGroup", "name": "EndorserOrgList", + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1949,7 +1983,7 @@ { "disabled": false, "document": "合约名称,可在合约管理中获取", - "example": "test", + "example": "fact", "member": "string", "name": "ContractName", "required": true, @@ -1994,6 +2028,7 @@ "example": "无", "member": "ChainMakerContractResult", "name": "Result", + "output_required": true, "type": "object", "value_allowed_null": true }, @@ -2457,7 +2492,7 @@ { "disabled": false, "document": "合约名称,可在合约管理中获取", - "example": "test", + "example": "fact", "member": "string", "name": "ContractName", "required": true, @@ -2493,6 +2528,7 @@ "example": "无", "member": "ChainMakerContractResult", "name": "Result", + "output_required": true, "type": "object", "value_allowed_null": true }, diff --git a/tccli/services/tbaas/v20180416/examples.json b/tccli/services/tbaas/v20180416/examples.json index 8741b03355..e3793aeee2 100644 --- a/tccli/services/tbaas/v20180416/examples.json +++ b/tccli/services/tbaas/v20180416/examples.json @@ -11,7 +11,7 @@ "ApplyUserCert": [ { "document": "", - "input": "https://tbaas.tencentcloudapi.com/?Action=ApplyUserCert\n&Module=cert_mng\n&Operation=cert_apply_for_user\n&ClusterId=251005746bckuobc41mpu\n&GroupName=youtuOrg\n&UserIdentity=kyloz\n&Applicant=优图SDK\n&IdentityNum=123\n&CsrData=-----BEGINCERTIFICATEREQUEST-----\nMIIBSTCB8AIBADCBjTELMAkGA1UEBhMCQ04xEjAQBgNVBAgMCUd1YW5nWmhvdTER\nMA8GA1UEBwwIU2hlblpoZW4xFDASBgNVBAoMC2V4YW1wbGUuY29tMQ8wDQYDVQQL\nDAZjbGllbnQxMDAuBgNVBAMMJ0FkbWluLm9yZzJAb3JnMi5leGFtcGxlLmNvbSx0\neXBlPWNsaWVudDBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABMIrWeLZjivbTLwy\nz+JMfmZjPEJ8x4H8a/CnqBIwcCaJjg5cMqOi+VyFHkCM9Sv4MFOqPAK7rE62m9XF\ns4B8hfKgADAKBggqhkjOPQQDAgNIADBFAiEAtl/h0DHfRJl170U6OGpCkN34jX0a\nGGGSHbFu2KxLUHsCIAFxXa6UsQOf93vT0FQldeBodbVCbNhM8/jtVqfZ/lhB\n-----ENDCERTIFICATEREQUEST-----\n&Notes=test\n&<公共请求参数>", + "input": "https://tbaas.tencentcloudapi.com/?Action=ApplyUserCert\n&Module=cert_mng\n&Operation=cert_apply_for_user\n&ClusterId=251005746bckuobc41mpu\n&GroupName=youtuOrg\n&UserIdentity=kyloz\n&Applicant=优图SDK\n&IdentityNum=3503******2342\n&CsrData=-----BEGINCERTIFICATEREQUEST-----\nMIIBSTCB8AIBADCBjTELMAkGA1UEBhMCQ04xEjAQBgNVBAgMCUd1YW5nWmhvdTER\nMA8GA1UEBwwIU2hlblpoZW4xFDASBgNVBAoMC2V4YW1wbGUuY29tMQ8wDQYDVQQL\nDAZjbGllbnQxMDAuBgNVBAMMJ0FkbWluLm9yZzJAb3JnMi5leGFtcGxlLmNvbSx0\neXBlPWNsaWVudDBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABMIrWeLZjivbTLwy\nz+JMfmZjPEJ8x4H8a/CnqBIwcCaJjg5cMqOi+VyFHkCM9Sv4MFOqPAK7rE62m9XF\ns4B8hfKgADAKBggqhkjOPQQDAgNIADBFAiEAtl/h0DHfRJl170U6OGpCkN34jX0a\nGGGSHbFu2KxLUHsCIAFxXa6UsQOf93vT0FQldeBodbVCbNhM8/jtVqfZ/lhB\n-----ENDCERTIFICATEREQUEST-----\n&Notes=fact\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"CertDn\": \"C=CN,ST=ShenZhen,L=4ShenZhen,O=org1,OU=client,CN=kylouse@org1.bcdk3eis17qe@client\",\n \"CertId\": 172634,\n \"RequestId\": \"16824370-6058-4f38-a32d-c19b1eaefaee\"\n }\n}", "title": "用户证书申请" } @@ -20,7 +20,7 @@ { "document": "DescribeFabricBlock", "input": "POST / HTTP/1.1\nHost: tbaas.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFabricBlock\n<公共请求参数>\n\n{\n \"ClusterId\": \"fabric-65z42qi150\",\n \"ChannelId\": \"channel-9xej4d\",\n \"BlockHeight\": 4\n}", - "output": "{\n \"Response\": {\n \"BlockHash\": \"e0421ecc20340425a2cf01808469b2523651f8100da92a0287b3769115e57370\",\n \"BlockHeight\": 4,\n \"CreateTimestamp\": \"2023-08-05 07:44:04\",\n \"PreBlockHash\": \"f69b2b5a1884e5bbb077a3025378e2210b83bbada23b5c17045b0bf537a53bd0\",\n \"ProposerOrg\": \"区块链测试机构pettychen\",\n \"RequestId\": \"a6288649-01c0-4d8f-bdd4-ba02163d0721\",\n \"TransactionList\": [\n {\n \"BlockHeight\": 4,\n \"ChaincodeName\": \"_lifecycle\",\n \"CreateTime\": \"2023-08-05 15:44:04\",\n \"Sender\": \"区块链测试机构pettychen\",\n \"TxId\": \"03389f4a5af1883347ecdb15471e70abf3a8e6cf5b6648dc789674af7930e229\"\n }\n ],\n \"TxCount\": 1\n }\n}", + "output": "{\n \"Response\": {\n \"BlockHash\": \"e0421ecc20340425a2cf01808469b2523651f8100da92a0287b3769115e57370\",\n \"BlockHeight\": 4,\n \"CreateTimestamp\": \"2023-08-05 07:44:04\",\n \"PreBlockHash\": \"f69b2b5a1884e5bbb077a3025378e2210b83bbada23b5c17045b0bf537a53bd0\",\n \"ProposerOrg\": \"区块链测试机构pettychen\",\n \"RequestId\": \"a6288649-01c0-4d8f-bdd4-ba02163d0721\",\n \"TransactionList\": [\n {\n \"BlockHeight\": 4,\n \"ChaincodeName\": \"_lifecycle\",\n \"CreateTime\": \"2023-08-05 15:44:04\",\n \"Sender\": \"区块链测试机构\",\n \"TxId\": \"03389f4a5af1883347ecdb15471e70abf3a8e6cf5b6648dc789674af7930e229\"\n }\n ],\n \"TxCount\": 1\n }\n}", "title": "DescribeFabricBlock" } ], @@ -59,8 +59,8 @@ "GetClusterSummary": [ { "document": "", - "input": "https://tbaas.tencentcloudapi.com/?Action=GetClusterSummary\n&Module=cluster_mng\n&Operation=cluster_summary\n&ClusterId=251005746bc0f03q8u93j\n&GroupId=0\n&GroupName=liulanOrg\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"ClientCertCount\": 2,\n \"JoinChannelCount\": 1,\n \"MyChaincodeCount\": 1,\n \"MyChannelCount\": 1,\n \"MyGroupCount\": 1,\n \"MyPeerCount\": 2,\n \"PeerCertCount\": 2,\n \"RecentChaincodeCount\": 1,\n \"RequestId\": \"8646a1d8-bae3-4b41-8732-06b8c004eaa5\",\n \"TlsCertCount\": 4,\n \"TotalCertCount\": 8,\n \"TotalChaincodeCount\": 1,\n \"TotalChannelCount\": 1,\n \"TotalGroupCount\": 1,\n \"TotalPeerCount\": 2\n }\n}", + "input": "https://tbaas.tencentcloudapi.com/?Action=GetClusterSummary\n&Module=cluster_mng\n&Operation=cluster_summary\n&ClusterId=251005746bc0f03q8u93j\n&GroupId=12\n&GroupName=liulanOrg\n&<公共请求参数>", + "output": "{\n \"Response\": {\n \"MyPeerCount\": 1,\n \"ClientCertCount\": 1,\n \"TotalChaincodeCount\": 1,\n \"TotalChannelCount\": 1,\n \"TlsCertCount\": 1,\n \"OrderCount\": 1,\n \"RecentChaincodeCount\": 1,\n \"PeerCertCount\": 1,\n \"MyChaincodeCount\": 1,\n \"RequestId\": \"aeae4ed4-a4ce-4ffd-9826-1aae7669bb7c\",\n \"TotalCertCount\": 1,\n \"MyGroupCount\": 1,\n \"MyChannelCount\": 1,\n \"TotalGroupCount\": 1,\n \"JoinChannelCount\": 1,\n \"TotalPeerCount\": 1\n }\n}", "title": "GetClusterSummary" } ], @@ -92,7 +92,7 @@ { "document": "", "input": "https://tbaas.tencentcloudapi.com/?Action=GetTransactionDetailForUser\n&Module=transaction\n&Operation=transaction_detail_for_user\n&ClusterId=251005746bcd6xjfka7pi\n&GroupName=org2\n&ChannelName=tyler\n&BlockId=0\n&TransactionId=42c562517707bf53f08fe6e5a1cf5f50c784352ff0d8166e77514ebe518bd6c0\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"BlockHash\": \"a0f1bd5819e1e664873c3d903d005f9f24661986c2c4c541a185f613fdeaff52\",\n \"BlockHeight\": 1,\n \"BlockId\": 0,\n \"ChannelName\": \"tyler\",\n \"ContractName\": \"\",\n \"CreateOrgName\": \"org2\",\n \"CreateTime\": \"2019-10-28 18:48:28\",\n \"EndorserOrgList\": [\n {\n \"EndorserGroupName\": \"org2\",\n \"EndorserPeerList\": [\n \"Admin.org2.bcd6xjfka7pi\"\n ]\n }\n ],\n \"RequestId\": \"a13c4aed-ba4a-4357-850a-66707d7d5e74\",\n \"TransactionData\": \"\\\"\\\"\",\n \"TransactionHash\": \"\",\n \"TransactionId\": \"42c562517707bf53f08fe6e5a1cf5f50c784352ff0d8166e77514ebe518bd6c0\",\n \"TransactionStatus\": \"VALID\",\n \"TransactionType\": \"CONFIG\"\n }\n}", + "output": "{\n \"Response\": {\n \"BlockHash\": \"a0f1bd5819e1e664873c3d903d005f9f24661986c2c4c541a185f613fdeaff52\",\n \"BlockHeight\": 1,\n \"BlockId\": 0,\n \"ChannelName\": \"tyler\",\n \"ContractName\": \"fact\",\n \"CreateOrgName\": \"org2\",\n \"CreateTime\": \"2019-10-28 18:48:28\",\n \"EndorserOrgList\": [\n {\n \"EndorserGroupName\": \"org2\",\n \"EndorserPeerList\": [\n \"Admin.org2.bcd6xjfka7pi\"\n ]\n }\n ],\n \"RequestId\": \"a13c4aed-ba4a-4357-850a-66707d7d5e74\",\n \"TransactionData\": \"{\\\"chaincode_spec\\\":{\\\"timeout\\\":0,\\\"type\\\":\\\"UNDEFINED\\\"}}\",\n \"TransactionHash\": \"42c562517707bf53f08fe6e5a1cf5f50c784352ff0d8166e77514ebe518bd6c0\",\n \"TransactionId\": \"42c562517707bf53f08fe6e5a1cf5f50c784352ff0d8166e77514ebe518bd6c0\",\n \"TransactionStatus\": \"VALID\",\n \"TransactionType\": \"CONFIG\"\n }\n}", "title": "获取交易详情" } ], @@ -113,7 +113,7 @@ "InvokeChainMakerContract": [ { "document": "调用长安链合约执行交易", - "input": "POST / HTTP/1.1\nHost: tbaas.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InvokeChainMakerContract\n<公共请求参数>\n\n{\n \"ChainId\": \"chain_dcwtt\",\n \"FuncParam\": \"{\\\"time\\\":\\\"2021-07-26\\\",\\\"file_hash\\\":\\\"123456\\\",\\\"file_name\\\":\\\"test.jpg\\\"}\",\n \"ClusterId\": \"chainmaker-j1juwsmndn\",\n \"FuncName\": \"save\",\n \"AsyncFlag\": \"0\",\n \"ContractName\": \"test\"\n}", + "input": "POST / HTTP/1.1\nHost: tbaas.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InvokeChainMakerContract\n<公共请求参数>\n\n{\n \"ChainId\": \"chain_dcwtt\",\n \"FuncParam\": \"{\\\"time\\\":\\\"2021-07-26\\\",\\\"file_hash\\\":\\\"123456\\\",\\\"file_name\\\":\\\"test.jpg\\\"}\",\n \"ClusterId\": \"chainmaker-j1juwsmndn\",\n \"FuncName\": \"save\",\n \"AsyncFlag\": \"0\",\n \"ContractName\": \"fact\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"2974e7ac-72e2-49c3-ae39-bc2bc6a7330b\",\n \"Result\": {\n \"Code\": 0,\n \"CodeMessage\": \"OK\",\n \"Message\": \"\",\n \"TxId\": \"963b8210f10e45e6ab6fe5cd37ba7f6719db5948a38c494ca9137fa2b8c9033d\",\n \"GasUsed\": 9573483,\n \"Result\": \"b2s=\"\n }\n }\n}", "title": "调用长安链合约执行交易" } @@ -153,7 +153,7 @@ "QueryChainMakerContract": [ { "document": "调用长安链合约查询", - "input": "POST / HTTP/1.1\nHost: tbaas.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: QueryChainMakerContract\n<公共请求参数>\n\n{\n \"ChainId\": \"chain_dcwtt\",\n \"ClusterId\": \"chainmaker-j1juwsmndn\",\n \"ContractName\": \"test\",\n \"FuncParam\": \"{\\\"file_hash\\\":\\\"1234567\\\"}\",\n \"FuncName\": \"find_by_file_hash\"\n}", + "input": "POST / HTTP/1.1\nHost: tbaas.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: QueryChainMakerContract\n<公共请求参数>\n\n{\n \"ChainId\": \"chain_dcwtt\",\n \"ClusterId\": \"chainmaker-j1juwsmndn\",\n \"ContractName\": \"fact\",\n \"FuncParam\": \"{\\\"file_hash\\\":\\\"1234567\\\"}\",\n \"FuncName\": \"find_by_file_hash\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"fac6ef5a-7637-4a75-a2d3-0f7d87b5b8b5\",\n \"Result\": {\n \"Code\": 0,\n \"CodeMessage\": \"OK\",\n \"Message\": \"\",\n \"TxId\": \"3ae794a658af4a219f849f5891d7a390eae524de4d614339ace2411059aaa19c\",\n \"GasUsed\": 6100540,\n \"Result\": \"b2s=\"\n }\n }\n}", "title": "调用长安链合约查询" } diff --git a/tccli/services/tcb/v20180608/api.json b/tccli/services/tcb/v20180608/api.json index b7778be0cb..338cc6df9f 100644 --- a/tccli/services/tcb/v20180608/api.json +++ b/tccli/services/tcb/v20180608/api.json @@ -3142,7 +3142,7 @@ { "disabled": false, "document": "环境变量", - "example": "[]", + "example": "[{\"key\":\"value\"}]", "member": "KVPair", "name": "Parameters", "required": false, @@ -3160,7 +3160,7 @@ { "disabled": false, "document": "rc.json的内容", - "example": "{}", + "example": "{\"key\":\"value\"}", "member": "string", "name": "RcJson", "required": false, @@ -3169,7 +3169,7 @@ { "disabled": false, "document": "插件配置内容", - "example": "{}", + "example": "{\"key\":\"value\"}", "member": "string", "name": "AddonConfig", "required": false, @@ -3187,7 +3187,7 @@ { "disabled": false, "document": "网络配置", - "example": "{}", + "example": "{\"key\":\"value\"}", "member": "string", "name": "NetworkConfig", "required": false, @@ -3232,7 +3232,7 @@ "example": "envcool-212i1i21", "member": "string", "name": "EnvId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5350,7 +5350,7 @@ { "disabled": false, "document": "环境id", - "example": "xx", + "example": "env-asdasfa", "member": "string", "name": "EnvId", "required": true, @@ -5359,7 +5359,7 @@ { "disabled": false, "document": "服务名", - "example": "xx", + "example": "service-name", "member": "string", "name": "ServiceName", "required": true, @@ -5368,7 +5368,7 @@ { "disabled": false, "document": "build类型,枚举值有: cloudbaserun, framework-ci", - "example": "xx", + "example": "cloudbaserun", "member": "string", "name": "CIBusiness", "required": false, @@ -5377,7 +5377,7 @@ { "disabled": false, "document": "服务版本", - "example": "xx", + "example": "service-name-0.1", "member": "string", "name": "ServiceVersion", "required": false, @@ -5401,7 +5401,7 @@ { "disabled": false, "document": "上传url", - "example": "xxx", + "example": "http://uploadurl", "member": "string", "name": "UploadUrl", "output_required": true, @@ -5411,7 +5411,7 @@ { "disabled": false, "document": "上传header", - "example": "xxx", + "example": "[{\"key\":\"value\"}]", "member": "KVPair", "name": "UploadHeaders", "output_required": true, @@ -5421,7 +5421,7 @@ { "disabled": false, "document": "包名", - "example": "xxx", + "example": "packageName", "member": "string", "name": "PackageName", "output_required": true, @@ -5431,7 +5431,7 @@ { "disabled": false, "document": "包版本", - "example": "xxx", + "example": "0.0.1", "member": "string", "name": "PackageVersion", "output_required": true, @@ -5441,7 +5441,7 @@ { "disabled": false, "document": "下载链接\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "http://downloadurl", "member": "string", "name": "DownloadUrl", "output_required": true, @@ -5451,7 +5451,7 @@ { "disabled": false, "document": "下载Httpheader\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xx", + "example": "[{\"key\":\"value\"}]", "member": "KVPair", "name": "DownloadHeaders", "output_required": true, @@ -5593,7 +5593,7 @@ { "disabled": false, "document": "项目名称", - "example": "xx", + "example": "projectName", "member": "string", "name": "ProjectName", "required": true, @@ -5644,7 +5644,7 @@ { "disabled": false, "document": "版本列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "0.0.1", "member": "CloudBaseProjectVersion", "name": "ProjectVersions", "output_required": true, @@ -5654,7 +5654,7 @@ { "disabled": false, "document": "总个数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "uint64", "name": "TotalCount", "output_required": true, diff --git a/tccli/services/tcb/v20180608/examples.json b/tccli/services/tcb/v20180608/examples.json index f032267915..5a2d2b2fb2 100644 --- a/tccli/services/tcb/v20180608/examples.json +++ b/tccli/services/tcb/v20180608/examples.json @@ -27,7 +27,7 @@ "CreateAndDeployCloudBaseProject": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tcb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAndDeployCloudBaseProject\n<公共请求参数>\n\n{\n \"EnvId\": \"xx\",\n \"Name\": \"xx\",\n \"Parameters\": [\n {\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ],\n \"Tags\": [\n null\n ],\n \"RcJson\": \"xx\",\n \"FreeQuota\": \"xx\",\n \"NetworkConfig\": \"xx\",\n \"RepoUrl\": \"xx\",\n \"Source\": {\n \"CodingPackageVersion\": \"xx\",\n \"WorkDir\": \"xx\",\n \"Name\": \"xx\",\n \"Url\": \"xx\",\n \"ProjectId\": 0,\n \"RawCode\": \"xx\",\n \"Branch\": \"xx\",\n \"ProjectName\": \"xx\",\n \"Type\": \"xx\",\n \"CodingPackageName\": \"xx\"\n },\n \"AddonConfig\": \"xx\",\n \"AutoDeployOnCodeChange\": true,\n \"EnvAlias\": \"xx\",\n \"Type\": \"xx\"\n}", + "input": "POST / HTTP/1.1\nHost: tcb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAndDeployCloudBaseProject\n<公共请求参数>\n\n{\n \"EnvId\": \"env-absdsasda\",\n \"Name\": \"name\",\n \"Parameters\": [\n {\n \"Value\": \"value\",\n \"Key\": \"key\"\n }\n ],\n \"Tags\": [\n \"tag1\"\n ],\n \"RcJson\": \"{\\\"key\\\":\\\"value\\\"}\",\n \"FreeQuota\": \"quota\",\n \"NetworkConfig\": \"{\\\"key\\\":\\\"value\\\"}\",\n \"RepoUrl\": \"http://repourl\",\n \"Source\": {\n \"CodingPackageVersion\": \"version\",\n \"WorkDir\": \"dir\",\n \"Name\": \"name\",\n \"Url\": \"http://url\",\n \"ProjectId\": 0,\n \"RawCode\": \"rawCode\",\n \"Branch\": \"branch\",\n \"ProjectName\": \"projectName\",\n \"Type\": \"type\",\n \"CodingPackageName\": \"packageName\"\n },\n \"AddonConfig\": \"{\\\"key\\\":\\\"value\\\"}\",\n \"AutoDeployOnCodeChange\": true,\n \"EnvAlias\": \"env\",\n \"Type\": \"pre\"\n}", "output": "{\n \"Response\": {\n \"EnvId\": \"lowcode-7ggmm27y1d0633a9\",\n \"RequestId\": \"00b9517e-7ba6-4b41-b0c3-4d50c64cef62\"\n }\n}", "title": "创建云开发项目" } @@ -224,7 +224,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: tcb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudBaseProjectVersionList\n<公共请求参数>\n\n{\n \"EnvId\": \"lowcode-abc\",\n \"PageNum\": 1,\n \"PageSize\": 10,\n \"ProjectName\": \"project\"\n}", - "output": "{\n \"Response\": {\n \"ProjectVersions\": [\n {\n \"Name\": \"abc\",\n \"Sam\": \"abc\",\n \"Source\": {\n \"Type\": \"abc\",\n \"Url\": \"abc\",\n \"Name\": \"abc\",\n \"WorkDir\": \"abc\",\n \"CodingPackageName\": \"abc\",\n \"CodingPackageVersion\": \"abc\",\n \"RawCode\": \"abc\",\n \"Branch\": \"abc\",\n \"ProjectId\": 0,\n \"ProjectName\": \"abc\"\n },\n \"CreateTime\": 0,\n \"UpdateTime\": 0,\n \"Status\": \"abc\",\n \"Parameters\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Type\": \"abc\",\n \"CIId\": \"abc\",\n \"CDId\": \"abc\",\n \"EnvId\": \"abc\",\n \"VersionNum\": 0,\n \"FailReason\": \"abc\",\n \"RcJson\": \"abc\",\n \"AddonConfig\": \"abc\",\n \"Tags\": [\n \"abc\"\n ],\n \"NetworkConfig\": \"abc\",\n \"ExtensionId\": \"abc\",\n \"FailType\": \"abc\",\n \"RepoUrl\": \"abc\",\n \"AutoDeployOnCodeChange\": true,\n \"BuildPercent\": 0,\n \"Uin\": \"abc\",\n \"BuildFinishTime\": \"abc\",\n \"DeployFinishTime\": \"abc\",\n \"BuildId\": \"abc\",\n \"SourceUrl\": \"abc\",\n \"FailReasonShort\": \"abc\",\n \"FirstInitRepo\": \"abc\"\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"ProjectVersions\": [\n {\n \"Name\": \"name\",\n \"Sam\": \"sam\",\n \"Source\": {\n \"Type\": \"type\",\n \"Url\": \"http://url\",\n \"Name\": \"name\",\n \"WorkDir\": \"dir\",\n \"CodingPackageName\": \"projectName\",\n \"CodingPackageVersion\": \"0.0.1\",\n \"RawCode\": \"rawcode\",\n \"Branch\": \"branch\",\n \"ProjectId\": 0,\n \"ProjectName\": \"projectName\"\n },\n \"CreateTime\": 0,\n \"UpdateTime\": 0,\n \"Status\": \"success\",\n \"Parameters\": [\n {\n \"Key\": \"key\",\n \"Value\": \"value\"\n }\n ],\n \"Type\": \"type\",\n \"CIId\": \"ciid\",\n \"CDId\": \"cdid\",\n \"EnvId\": \"env-asdf\",\n \"VersionNum\": 0,\n \"FailReason\": \"failed with reason\",\n \"RcJson\": \"{\\\"key\\\":\\\"value\\\"}\",\n \"AddonConfig\": \"{\\\"key\\\":\\\"value\\\"}\",\n \"Tags\": [\n \"tag\"\n ],\n \"NetworkConfig\": \"{\\\"key\\\":\\\"value\\\"}\",\n \"ExtensionId\": \"extensionid\",\n \"FailType\": \"system\",\n \"RepoUrl\": \"http://repourl\",\n \"AutoDeployOnCodeChange\": true,\n \"BuildPercent\": 0,\n \"Uin\": \"10000101123\",\n \"BuildFinishTime\": \"2024-12-26 14:00:00\",\n \"DeployFinishTime\": \"2024-12-26 14:05:00\",\n \"BuildId\": \"buildid\",\n \"SourceUrl\": \"http://sourceurl\",\n \"FailReasonShort\": \"failed with something\",\n \"FirstInitRepo\": \"http://firstinitrepo\"\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"asdasfas-hfgd-skdj-shaksldiaosu\"\n }\n}", "title": "查询云项目部署版本列表" } ], diff --git a/tccli/services/tcm/v20210413/api.json b/tccli/services/tcm/v20210413/api.json index 9e688ce377..2226a13702 100644 --- a/tccli/services/tcm/v20210413/api.json +++ b/tccli/services/tcm/v20210413/api.json @@ -577,7 +577,7 @@ { "disabled": false, "document": "Mesh名称", - "example": "无", + "example": "test", "member": "string", "name": "DisplayName", "required": true, @@ -640,7 +640,7 @@ "example": "mesh-xxxxxxxx", "member": "string", "name": "MeshId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -825,7 +825,7 @@ { "disabled": false, "document": "mesh名字", - "example": "无", + "example": "test", "member": "string", "name": "MeshId", "required": true, @@ -840,7 +840,7 @@ { "disabled": false, "document": "访问日志输出路径。默认 /dev/stdout", - "example": "xxx", + "example": "/dev/stdout", "member": "string", "name": "File", "output_required": true, @@ -900,7 +900,7 @@ { "disabled": false, "document": "GRPC第三方服务器地址", - "example": "无", + "example": "x.x.x.x", "member": "string", "name": "Address", "output_required": true, @@ -2196,7 +2196,7 @@ { "disabled": false, "document": "GRPC第三方服务器地址", - "example": "xxx", + "example": "x.x.x.x", "member": "string", "name": "Address", "required": false, diff --git a/tccli/services/tcm/v20210413/examples.json b/tccli/services/tcm/v20210413/examples.json index e98c567b6d..c9f5eadd5b 100644 --- a/tccli/services/tcm/v20210413/examples.json +++ b/tccli/services/tcm/v20210413/examples.json @@ -20,7 +20,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: tcm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAccessLogConfig\n<公共请求参数>\n\n{\n \"MeshId\": \"\\\"mesh-test\\\"\"\n}", - "output": "{\n \"Response\": {\n \"File\": \"abc\",\n \"Format\": \"abc\",\n \"Encoding\": \"abc\",\n \"SelectedRange\": {\n \"Items\": [\n {\n \"Namespace\": \"abc\",\n \"ClusterName\": \"abc\",\n \"ItemName\": \"abc\",\n \"Gateways\": [\n \"abc\"\n ]\n }\n ],\n \"All\": true\n },\n \"Template\": \"abc\",\n \"CLS\": {\n \"Enable\": true,\n \"LogSet\": \"abc\",\n \"Topic\": \"abc\",\n \"NeedDelete\": true,\n \"Region\": \"abc\"\n },\n \"Address\": \"abc\",\n \"EnableServer\": true,\n \"EnableStdout\": true,\n \"Enable\": true,\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"File\": \"/dev/stdout\",\n \"Format\": \"{xxx: xxx}\",\n \"Encoding\": \"JSON\",\n \"SelectedRange\": {\n \"Items\": [\n {\n \"Namespace\": \"test\",\n \"ClusterName\": \"cls-xxxxxxxx\",\n \"ItemName\": \"test\",\n \"Gateways\": [\n \"test\"\n ]\n }\n ],\n \"All\": true\n },\n \"Template\": \"test\",\n \"CLS\": {\n \"Enable\": true,\n \"LogSet\": \"test\",\n \"Topic\": \"test\",\n \"NeedDelete\": true,\n \"Region\": \"sh\"\n },\n \"Address\": \"x.x.x.x\",\n \"EnableServer\": true,\n \"EnableStdout\": true,\n \"Enable\": true,\n \"RequestId\": \"xxxxxxxxxxxxxxxxxxx\"\n }\n}", "title": "获取Mesh访问日志配置" } ], diff --git a/tccli/services/tcr/v20190924/api.json b/tccli/services/tcr/v20190924/api.json index 3e5d57df09..11e25b73bf 100644 --- a/tccli/services/tcr/v20190924/api.json +++ b/tccli/services/tcr/v20190924/api.json @@ -8338,42 +8338,47 @@ { "disabled": false, "document": "同步规则名称", - "example": "", + "example": "无", "member": "string", "name": "Name", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "目标命名空间", - "example": "", + "example": "无", "member": "string", "name": "DestNamespace", "required": true, - "type": "string", - "value_allowed_null": false + "type": "string" }, { "disabled": false, "document": "是否覆盖", - "example": "", + "example": "无", "member": "bool", "name": "Override", "required": true, - "type": "bool", - "value_allowed_null": false + "type": "bool" }, { "disabled": false, "document": "同步过滤条件", - "example": "", + "example": "无", "member": "ReplicationFilter", "name": "Filters", "required": true, - "type": "list", - "value_allowed_null": false + "type": "list" + }, + { + "disabled": false, + "document": "是否同步删除事件", + "example": "无", + "member": "bool", + "name": "Deletion", + "required": false, + "type": "bool" } ], "usage": "in" diff --git a/tccli/services/tdmq/v20200217/api.json b/tccli/services/tdmq/v20200217/api.json index e48c79716b..34c582e49c 100644 --- a/tccli/services/tdmq/v20200217/api.json +++ b/tccli/services/tdmq/v20200217/api.json @@ -4771,6 +4771,15 @@ "name": "MsgTTL", "required": false, "type": "int" + }, + { + "disabled": false, + "document": "不传默认是原生策略,DefaultPolicy表示当订阅下达到最大未确认消息数 5000 时,服务端将不再向当前订阅下的所有消费者推送消息,DynamicPolicy表示动态调整订阅下的最大未确认消息数,具体配额是在 5000 和消费者数量*20之间取最大值。每个消费者默认最大 unack 消息数为 20,超过该限制时仅影响该消费者,不影响其他消费者。", + "example": "DefaultPolicy", + "member": "string", + "name": "UnackPolicy", + "required": false, + "type": "string" } ], "type": "object" @@ -14030,6 +14039,15 @@ "name": "MsgTTL", "required": false, "type": "int" + }, + { + "disabled": false, + "document": "不传默认是原生策略,DefaultPolicy表示当订阅下达到最大未确认消息数 5000 时,服务端将不再向当前订阅下的所有消费者推送消息,DynamicPolicy表示动态调整订阅下的最大未确认消息数,具体配额是在 5000 和消费者数量*20之间取最大值。每个消费者默认最大 unack 消息数为 20,超过该限制时仅影响该消费者,不影响其他消费者。", + "example": "DefaultPolicy", + "member": "string", + "name": "UnackPolicy", + "required": false, + "type": "string" } ], "type": "object" diff --git a/tccli/services/tem/v20210701/api.json b/tccli/services/tem/v20210701/api.json index 53900e93ea..6a8a57943b 100644 --- a/tccli/services/tem/v20210701/api.json +++ b/tccli/services/tem/v20210701/api.json @@ -295,11 +295,11 @@ "status": "online" }, "ModifyIngress": { - "document": "创建或者更新 Ingress 规则", + "document": "此接口没有被使用了\n\n创建或者更新 Ingress 规则", "input": "ModifyIngressRequest", "name": "创建或者更新 Ingress 规则", "output": "ModifyIngressResponse", - "status": "online" + "status": "deprecated" }, "ModifyLogConfig": { "document": "编辑日志收集配置", @@ -430,7 +430,7 @@ { "disabled": false, "document": "弹性伸缩描述\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "描述", + "example": "这是一个描述", "member": "string", "name": "Description", "output_required": true, @@ -491,10 +491,10 @@ { "disabled": false, "document": "配置名称", - "example": "xxx", + "example": "name-xxx", "member": "string", "name": "Name", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -504,27 +504,27 @@ "example": "2012-12-10 09:00:00", "member": "string", "name": "CreateTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "关联的服务列表", - "example": "[]", + "example": "无", "member": "TemService", "name": "RelatedApplications", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "配置条目", - "example": "[]", + "example": "无", "member": "Pair", "name": "Data", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -751,7 +751,7 @@ { "disabled": false, "document": "绑定镜像仓库名", - "example": "tem-test/repo_te", + "example": "tem-test/repo_xxx", "member": "string", "name": "RepoName", "required": false, @@ -769,7 +769,7 @@ { "disabled": false, "document": "应用所在子网", - "example": "['s1', 's2']", + "example": "[\"subnet-xxxxxx\"]", "member": "string", "name": "SubnetList", "required": false, @@ -778,7 +778,7 @@ { "disabled": false, "document": "编程语言 \n- JAVA\n- OTHER", - "example": "1", + "example": "JAVA", "member": "string", "name": "CodingLanguage", "required": false, @@ -787,7 +787,7 @@ { "disabled": false, "document": "部署方式 \n- IMAGE\n- JAR\n- WAR", - "example": "1", + "example": "IMAGE", "member": "string", "name": "DeployMode", "required": false, @@ -805,7 +805,7 @@ { "disabled": false, "document": "使用默认镜像服务额外参数", - "example": "{}", + "example": "无", "member": "UseDefaultRepoParameters", "name": "UseDefaultImageServiceParameters", "required": false, @@ -814,7 +814,7 @@ { "disabled": false, "document": "标签", - "example": "1", + "example": "无", "member": "Tag", "name": "Tags", "required": false, @@ -828,8 +828,8 @@ "members": [ { "disabled": false, - "document": "服务code", - "example": "service-3gn56p6v", + "document": "应用ID", + "example": "app-xxxxxx", "member": "string", "name": "Result", "output_required": true, @@ -869,7 +869,7 @@ { "disabled": false, "document": "访问方式详情", - "example": "{}", + "example": "{\"ServiceName\":\"k8s-svc-test\",\"PortMappingItemList\":[{\"Port\":8080,\"TargetPort\":8080,\"Protocol\":\"TCP\"}],\"Type\":\"CLUSTER\"}", "member": "ServicePortMapping", "name": "Service", "required": true, @@ -933,7 +933,7 @@ { "disabled": false, "document": "配置信息", - "example": "[]", + "example": "[{\"Key\":\"key-xxx\",\"Value\":\"val-xxx\"}]", "member": "Pair", "name": "Data", "required": true, @@ -1124,7 +1124,7 @@ { "disabled": false, "document": "环境类型:test、pre、prod。默认值:prod", - "example": "test", + "example": "prod", "member": "string", "name": "EnvType", "required": false, @@ -1296,7 +1296,7 @@ { "disabled": false, "document": "导出规则", - "example": "{}", + "example": "{\"FilterKeys\":[],\"FilterRegex\":[],\"UnMatchUpload\":\"true\",\"UnMatchedKey\":\"LogParseFailure\"}", "member": "LogConfigExtractRule", "name": "ExtractRule", "required": false, @@ -1378,7 +1378,7 @@ { "disabled": false, "document": "设置 resource 的额外配置", - "example": "{}", + "example": "resource-cfg-xxx", "member": "string", "name": "ResourceConfig", "required": false, @@ -1816,7 +1816,7 @@ { "disabled": false, "document": "版本描述信息", - "example": "1", + "example": "version-desc", "member": "string", "name": "VersionDesc", "required": false, @@ -1825,7 +1825,7 @@ { "disabled": false, "document": "启动参数", - "example": "1", + "example": "-Xms128m -XX:MetaspaceSize=128m", "member": "string", "name": "JvmOpts", "required": false, @@ -1969,7 +1969,7 @@ { "disabled": false, "document": "挂载配置信息", - "example": "[]", + "example": "[{\"ConfigDataName\":\"cfg-test-1\",\"MountedPath\":\"/data\",\"SecretDataName\":\"\"}]", "member": "MountedSettingConf", "name": "SettingConfs", "required": false, @@ -2104,7 +2104,7 @@ { "disabled": false, "document": "metrics业务指标监控配置", - "example": "{}", + "example": "{\"Port\":9090,\"Path:\"/data\"}", "member": "EnablePrometheusConf", "name": "EnablePrometheusConf", "required": false, @@ -2158,7 +2158,7 @@ { "disabled": false, "document": "启动后执行的脚本,base64 编码", - "example": "无", + "example": "post-start-encoded-xxx", "member": "string", "name": "PostStartEncoded", "required": false, @@ -2167,7 +2167,7 @@ { "disabled": false, "document": "停止前执行的脚本,base64 编码", - "example": "无", + "example": "pre-stop-encoded-xxx", "member": "string", "name": "PreStopEncoded", "required": false, @@ -2834,20 +2834,20 @@ { "disabled": false, "document": "记录", - "example": "[]", + "example": "无", "member": "ConfigData", "name": "Records", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "分页游标,用以查询下一页\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxx", + "example": "token-xxx", "member": "string", "name": "ContinueToken", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -2857,7 +2857,7 @@ "example": "22", "member": "int64", "name": "RemainingCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true } @@ -2912,7 +2912,7 @@ { "disabled": false, "document": "配置列表", - "example": "[]", + "example": "{\"Records\":[{\"Name\":\"config-test\",\"CreateTime\":\"2024-12-19 23:55:05\",\"RelatedApplications\":[],\"Data\":[{\"Key\":\"key-xxx\",\"Value\":\"val-xxx\",\"Type\":\"\",\"Config\":\"\",\"Secret\":\"\"}]},{\"Name\":\"pk-test\",\"CreateTime\":\"2024-12-19 11:04:13\",\"RelatedApplications\":[],\"Data\":[{\"Key\":\"name\",\"Value\":\"pk\",\"Type\":\"\",\"Config\":\"\",\"Secret\":\"\"}]}],\"RemainingCount\":null,\"ContinueToken\":\"\"}", "member": "DescribeConfigDataListPage", "name": "Result", "output_required": true, @@ -2967,7 +2967,7 @@ { "disabled": false, "document": "配置", - "example": "[]", + "example": "{\"Name\":\"config-test\",\"CreateTime\":\"2024-12-19 23:55:05\",\"RelatedApplications\":[],\"Data\":[{\"Key\":\"key-xxx\",\"Value\":\"val-xxx\",\"Type\":\"\",\"Config\":\"\",\"Secret\":\"\"}]}", "member": "ConfigData", "name": "Result", "output_required": true, @@ -3022,7 +3022,7 @@ { "disabled": false, "document": "分批发布结果详情", - "example": "{}", + "example": "{\"DeployStrategyConf\":{\"TotalBatchCount\":1,\"BetaBatchNum\":0,\"DeployStrategyType\":3,\"BatchInterval\":0,\"MinAvailable\":1,\"Force\":true},\"StartTime\":\"2024-12-20 17:00:17\",\"EndTime\":\"\",\"Status\":\"Error\",\"CurrentBatchStatus\":\"Finish\",\"ErrorMessage\":\"\",\"BetaBatchDetail\":null,\"OtherBatchDetail\":[{\"OldPods\":[],\"NewPods\":[{\"PodId\":\"app0925-4sbct\",\"PodVersion\":\"\",\"CreateTime\":\"2024-12-20 17:00:23\",\"Zone\":\"ap-shanghai-2\",\"Webshell\":\"https://tkecache.cloud.tencent.com/xxx\",\"Status\":\"CrashLoopBackOff\",\"PodStatus\":[\"CrashLoopBackOff\"]},{\"PodId\":\"app0925-s4vpj\",\"PodVersion\":\"\",\"CreateTime\":\"2024-12-20 17:00:23\",\"Zone\":\"ap-shanghai-2\",\"Webshell\":\"https://tkecache.cloud.tencent.com/xxx\",\"Status\":\"CrashLoopBackOff\",\"PodStatus\":[\"CrashLoopBackOff\"]}],\"BatchStatus\":\"Finish\",\"PodNum\":3,\"BatchIndex\":0,\"NextBatchStartTime\":0,\"OldPodList\":null,\"NewPodList\":null}],\"OldVersionPodList\":{\"Offset\":0,\"Limit\":1,\"TotalCount\":1,\"PodList\":[{\"Zone\":\"ap-shanghai-2\",\"NodeInfo\":{\"Name\":\"eklet-subnet-8indzsuv-457482\",\"Zone\":\"ap-shanghai-2\",\"SubnetId\":\"subnet-8indzsuv\",\"AvailableIpCount\":\"226\",\"Cidr\":\"10.0.30.0-24\"},\"DeployVersion\":\"20241202165113\",\"RestartCount\":0,\"Ready\":true,\"StartTime\":\"2024-12-19T03:12:44Z\",\"ContainerState\":\"running\",\"Unhealthy\":null,\"UnhealthyWarningMsg\":\"\",\"VersionId\":\"revision-57moqvm5\",\"ApplicationName\":\"app0925\",\"Status\":\"Running\",\"CreateTime\":\"2024-12-19 11:11:32\",\"Webshell\":\"https://tkecache.cloud.tencent.com/xxx\",\"PodId\":\"app0925-jt5bn\",\"PodIp\":\"10.0.30.158\"}],\"RequestId\":\"\"},\"CurrentBatchIndex\":0,\"NewVersionPackageInfo\":\"K8sEventDemo-1.0.jar\",\"NewDeployVersion\":\"20241202165113\",\"OldDeployVersion\":\"20241202165113\",\"NextBatchStartTime\":null}", "member": "TemDeployApplicationDetailInfo", "name": "Result", "output_required": true, @@ -3068,7 +3068,7 @@ { "disabled": false, "document": "环境信息", - "example": "{}", + "example": "{\"EnvironmentId\":\"en-l5mmxey5\",\"EnvironmentName\":\"bugfix-gz\",\"Region\":\"ap-guangzhou\",\"VpcId\":\"vpc-9xcgo41t\",\"SubnetIds\":[\"subnet-orcy48cy\"],\"Description\":\"\",\"CreatedDate\":\"2024-07-01 17:48:35\",\"ApmInstanceId\":\"\",\"Locked\":0,\"NamespaceName\":\"\",\"Tags\":[],\"EnvType\":\"prod\"}", "member": "NamespaceInfo", "name": "Result", "output_required": true, @@ -3172,7 +3172,7 @@ { "disabled": false, "document": "排序字段", - "example": "{}", + "example": "{\"Key\":\"UpdateTime\",\"Type\":1}", "member": "SortType", "name": "SortInfo", "required": false, @@ -3181,7 +3181,7 @@ { "disabled": false, "document": "环境id", - "example": "aa", + "example": "en-xxxxxx", "member": "string", "name": "EnvironmentId", "required": false, @@ -3324,7 +3324,7 @@ { "disabled": false, "document": "ingress 数组\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "[{\"ClusterId\":\"cls-9lxt9ic2\",\"EnvironmentId\":\"en-xxxxxx\",\"IngressName\":\"ingress-name-xxx\",\"ClusterNamespace\":\"default\",\"AddressIPVersion\":\"IPV4\",\"ClbId\":\"clb-xxxx\",\"Vip\":\"10.10.10.10\",\"Rules\":[{\"Host\":\"\",\"Http\":{\"Paths\":[{\"Path\":\"/path\",\"Backend\":{\"ServiceName\":\"kubernetes\",\"ServicePort\":443}}]}}],\"Tls\":[{\"Hosts\":[\"xxx.com\"],\"SecretName\":\"secret-name-xxx\"}],\"ClusterId\":\"cls-xxxxxx\",\"Vip\":\"10.xx.xx.xx\",\"CreateTime\":\"2024-12-04 20:46:29\",\"Mixed\":true,\"RewriteType\":\"AUTO\",\"Domain\":\"xxx.xxx.com\"}]", "member": "IngressInfo", "name": "Result", "output_required": true, @@ -3379,7 +3379,7 @@ { "disabled": false, "document": "配置", - "example": "[]", + "example": "{\"Name\":\"log-name-xxx\",\"ApplicationName\":\"app-name-xxx\",\"ApplicationId\":\"\",\"InputType\":\"container_stdout\",\"TopicId\":\"3ae33b64-d3d1-4a2c-96ff-a2e044dcexxx\",\"LogsetId\":\"5bf3beeb-1f64-40f9-9672-b596248d7xxx\",\"LogType\":\"minimalist_log\",\"BeginningRegex\":\"\",\"ExtractRule\":{\"Backtracking\":\"-1\",\"BeginningRegex\":\"\",\"Delimiter\":\"\",\"FilterKeys\":[],\"FilterRegex\":[],\"Keys\":[],\"LogRegex\":\"\",\"TimeFormat\":\"\",\"TimeKey\":\"\",\"UnMatchUpload\":\"false\",\"UnMatchedKey\":\"\"},\"LogPath\":\"\",\"FilePattern\":\"\",\"CreateDate\":\"2022-05-28T18:02:55.000+08:00\",\"ModifyDate\":\"2022-05-28T18:02:56.000+08:00\"}", "member": "LogConfig", "name": "Result", "output_required": true, @@ -3419,7 +3419,7 @@ { "disabled": false, "document": "应用名", - "example": "abc", + "example": "app-name-xxx", "member": "string", "name": "ApplicationName", "required": false, @@ -3428,7 +3428,7 @@ { "disabled": false, "document": "规则名", - "example": "abc", + "example": "rule-name", "member": "string", "name": "Name", "required": false, @@ -3461,7 +3461,7 @@ { "disabled": false, "document": "日志收集配置列表", - "example": "{}", + "example": "{\"Records\":[{\"Name\":\"demo-test\",\"ApplicationName\":\"app0925\",\"ApplicationId\":\"app-5vaz8xxx\",\"InputType\":\"container_stdout\",\"TopicId\":\"dbebda3e-0a9a-4888-9d5c-642bf2ffa183\",\"LogsetId\":\"4d43fac5-fc0a-42bf-92a9-ef5b5b245e6a\",\"LogType\":\"json_log\",\"BeginningRegex\":\"\",\"ExtractRule\":{\"Backtracking\":\"\",\"BeginningRegex\":\"\",\"Delimiter\":\"\",\"FilterKeys\":[],\"FilterRegex\":[],\"Keys\":[],\"LogRegex\":\"\",\"TimeFormat\":\"\",\"TimeKey\":\"\",\"UnMatchUpload\":\"true\",\"UnMatchedKey\":\"LogParseFailure\"},\"LogPath\":\"\",\"FilePattern\":\"\",\"CreateDate\":\"2024-10-18T11:37:44.000+08:00\",\"ModifyDate\":\"2024-10-18T11:37:45.000+08:00\"},{\"Name\":\"pk-test-cam-14\",\"ApplicationName\":\"app0925\",\"ApplicationId\":\"app-5vaz8xxx\",\"InputType\":\"container_stdout\",\"TopicId\":\"dbebda3e-0a9a-4888-9d5c-642bf2ffa183\",\"LogsetId\":\"4d43fac5-fc0a-42bf-92a9-ef5b5b245e6a\",\"LogType\":\"json_log\",\"BeginningRegex\":\"\",\"ExtractRule\":{\"Backtracking\":\"\",\"BeginningRegex\":\"\",\"Delimiter\":\"\",\"FilterKeys\":[],\"FilterRegex\":[],\"Keys\":[],\"LogRegex\":\"\",\"TimeFormat\":\"\",\"TimeKey\":\"\",\"UnMatchUpload\":\"false\",\"UnMatchedKey\":\"\"},\"LogPath\":\"\",\"FilePattern\":\"\",\"CreateDate\":\"2024-10-30T16:46:41.000+08:00\",\"ModifyDate\":\"2024-10-30T16:46:42.000+08:00\"}],\"ContinueToken\":\"\"}", "member": "LogConfigListPage", "name": "Result", "output_required": true, @@ -3501,7 +3501,7 @@ { "disabled": false, "document": "应用 ID", - "example": "svc-xxxx", + "example": "app-xxxxxx", "member": "string", "name": "ApplicationId", "required": true, @@ -3525,7 +3525,7 @@ { "disabled": false, "document": "ingress 数组\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "[{\"ClusterId\":\"cls-9lxt9ic2\",\"EnvironmentId\":\"en-xxxxxx\",\"IngressName\":\"ingress-name-xxx\",\"ClusterNamespace\":\"default\",\"AddressIPVersion\":\"IPV4\",\"ClbId\":\"clb-xxxx\",\"Vip\":\"10.10.10.10\",\"Rules\":[{\"Host\":\"\",\"Http\":{\"Paths\":[{\"Path\":\"/path\",\"Backend\":{\"ServiceName\":\"kubernetes\",\"ServicePort\":443}}]}}],\"Tls\":[{\"Hosts\":[\"xxx.com\"],\"SecretName\":\"secret-name-xxx\"}],\"ClusterId\":\"cls-xxxxxx\",\"Vip\":\"10.xx.xx.xx\",\"CreateTime\":\"2024-12-04 20:46:29\",\"Mixed\":true,\"RewriteType\":\"AUTO\",\"Domain\":\"xxx.xxx.com\"}]", "member": "IngressInfo", "name": "Result", "output_required": true, @@ -3547,55 +3547,60 @@ { "disabled": false, "document": "分页下标", - "example": "1", + "example": "0", "member": "int64", "name": "Offset", - "required": true, + "output_required": true, + "required": false, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "单页条数", - "example": "11", + "example": "10", "member": "int64", "name": "Limit", - "required": true, + "output_required": true, + "required": false, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "总数", - "example": "111", + "example": "1", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, + "required": false, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "请求id", - "example": "ssss", + "example": "1ce4bb30-202a-403a-8552-1a38b21xxxx", "member": "string", "name": "RequestId", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "条目", - "example": "{name:key}", + "example": "[{\"ApplicationName\":\"app0925\",\"Webshell\":\"https://tkecache.cloud.tencent.com/xxxxxx\",\"PodId\":\"app0925-xxxxxx\"}]", "member": "RunVersionPod", "name": "PodList", - "required": true, + "output_required": true, + "required": false, "type": "list", "value_allowed_null": false } ], - "usage": "out" + "usage": "both" }, "DestroyConfigDataRequest": { "document": "DestroyConfigData请求参数结构体", @@ -3823,9 +3828,10 @@ { "disabled": false, "document": "service name", - "example": "xxx", + "example": "name-xxx", "member": "string", "name": "Name", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -3833,9 +3839,10 @@ { "disabled": false, "document": "可用端口", - "example": "[1,2]", + "example": "[8080]", "member": "int64", "name": "Ports", + "output_required": true, "required": false, "type": "list", "value_allowed_null": false @@ -3843,9 +3850,10 @@ { "disabled": false, "document": "yaml 内容", - "example": "1", + "example": "apiVersion: v1-xxxxxx", "member": "string", "name": "Yaml", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -3853,9 +3861,10 @@ { "disabled": false, "document": "服务名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxx", + "example": "app-name-xxx", "member": "string", "name": "ApplicationName", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -3863,9 +3872,10 @@ { "disabled": false, "document": "版本名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxxx", + "example": "version-xxxx", "member": "string", "name": "VersionName", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -3873,9 +3883,10 @@ { "disabled": false, "document": "内网ip\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "172.xx.xx.xx", "member": "string", "name": "ClusterIp", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -3883,9 +3894,10 @@ { "disabled": false, "document": "外网ip\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "10.xx.xx.xx", "member": "string", "name": "ExternalIp", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -3893,9 +3905,10 @@ { "disabled": false, "document": "访问类型,可选值:\n- EXTERNAL(公网访问)\n- VPC(vpc内访问)\n- CLUSTER(集群内访问)\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "VPC", "member": "string", "name": "Type", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -3903,9 +3916,10 @@ { "disabled": false, "document": "子网ID,只在类型为vpc访问时才有值\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "subnet-xxxxxx", "member": "string", "name": "SubnetId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -3913,9 +3927,10 @@ { "disabled": false, "document": "负载均衡ID,只在外网访问和vpc内访问才有值,默认自动创建\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "10.xx.xx.xx", "member": "string", "name": "LoadBalanceId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -3923,9 +3938,10 @@ { "disabled": false, "document": "端口映射\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "PortMapping", "name": "PortMappings", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -3933,9 +3949,10 @@ { "disabled": false, "document": "每种类型访问配置详情\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[{\"name\":\"test\"}]", + "example": "无", "member": "ServicePortMapping", "name": "ServicePortMappingList", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -3946,6 +3963,7 @@ "example": "true", "member": "bool", "name": "FlushAll", + "output_required": true, "required": false, "type": "bool", "value_allowed_null": true @@ -3953,9 +3971,10 @@ { "disabled": false, "document": "1: 下次部署自动注入注册中心信息;0:不注入\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "0", "member": "int64", "name": "EnableRegistryNextDeploy", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -3963,9 +3982,10 @@ { "disabled": false, "document": "返回应用id\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "app-123", + "example": "app-xxxxxx", "member": "string", "name": "ApplicationId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -3976,6 +3996,7 @@ "example": "false", "member": "bool", "name": "AllIpDone", + "output_required": true, "required": false, "type": "bool", "value_allowed_null": true @@ -3986,6 +4007,7 @@ "example": "lb-xxxx.com", "member": "string", "name": "ExternalDomain", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -4212,6 +4234,7 @@ "example": "HttpGet", "member": "string", "name": "Type", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -4222,6 +4245,7 @@ "example": "HTTP", "member": "string", "name": "Protocol", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -4232,6 +4256,7 @@ "example": "/xxx", "member": "string", "name": "Path", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -4239,9 +4264,10 @@ { "disabled": false, "document": "仅当健康检查类型为 Exec 时有效,表示执行的脚本内容", - "example": "xxxx", + "example": "shell cmd", "member": "string", "name": "Exec", + "output_required": true, "required": false, "type": "string", "value_allowed_null": false @@ -4252,6 +4278,7 @@ "example": "80", "member": "int64", "name": "Port", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -4262,6 +4289,7 @@ "example": "0", "member": "int64", "name": "InitialDelaySeconds", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -4272,6 +4300,7 @@ "example": "1", "member": "int64", "name": "TimeoutSeconds", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -4282,6 +4311,7 @@ "example": "10", "member": "int64", "name": "PeriodSeconds", + "output_required": true, "required": false, "type": "int", "value_allowed_null": false @@ -4707,7 +4737,7 @@ { "disabled": false, "document": "首行正则表达式,当 LogType 为多行全文、多行正则时生效\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "abc", + "example": "^ERROR", "member": "string", "name": "BeginningRegex", "output_required": true, @@ -4784,7 +4814,7 @@ { "disabled": false, "document": "导出规则\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{ \"FilterKeys\": [], \"FilterRegex\": [], \"UnMatchUpload\": \"true\", \"UnMatchedKey\": \"LogParseFailure\" }", + "example": "无", "member": "LogConfigExtractRule", "name": "ExtractRule", "output_required": true, @@ -4801,9 +4831,10 @@ { "disabled": false, "document": "首行正则表达式\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "*", + "example": "^ERROR", "member": "string", "name": "BeginningRegex", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -4814,6 +4845,7 @@ "example": "[\"k1\", \"k2\"]", "member": "string", "name": "Keys", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -4824,6 +4856,7 @@ "example": "[\"k1\"]", "member": "string", "name": "FilterKeys", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -4834,6 +4867,7 @@ "example": "[\"v1*\"]", "member": "string", "name": "FilterRegex", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -4841,9 +4875,10 @@ { "disabled": false, "document": "日志正则表达式\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "*", + "example": "^Info", "member": "string", "name": "LogRegex", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -4854,6 +4889,7 @@ "example": "time", "member": "string", "name": "TimeKey", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -4864,6 +4900,7 @@ "example": "%Y-%m-%d %H:%M:%S", "member": "string", "name": "TimeFormat", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -4874,6 +4911,7 @@ "example": "true", "member": "string", "name": "UnMatchUpload", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -4884,6 +4922,7 @@ "example": "LogParseFailure", "member": "string", "name": "UnMatchedKey", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -4891,9 +4930,10 @@ { "disabled": false, "document": "tracking\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "tracking-xxx", "member": "string", "name": "Backtracking", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -4901,9 +4941,10 @@ { "disabled": false, "document": "分隔符\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": ":", "member": "string", "name": "Delimiter", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -4917,20 +4958,20 @@ { "disabled": false, "document": "记录\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "无", "member": "LogConfig", "name": "Records", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "翻页游标\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxxx", + "example": "token-xxx", "member": "string", "name": "ContinueToken", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -5050,7 +5091,7 @@ { "disabled": false, "document": "是否成功\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "true", "member": "bool", "name": "Result", "output_required": true, @@ -5227,7 +5268,7 @@ { "disabled": false, "document": "全量访问方式设置", - "example": "{}", + "example": "{\"ServicePortMappingList\":[{\"Type\":\"CLUSTER\",\"ServiceName\":\"k8s-svc-test\",\"ClusterIp\":\"172.16.56.122\",\"ExternalIp\":\"10.xx.xx.xx\",\"ExternalDomain\":\"ext.domain.com\",\"SubnetId\":\"subnet-xxx\",\"VpcId\":\"vpc-xxx\",\"LoadBalanceId\":\"10.xx.xx.xx\",\"Yaml\":\"apiVersion: xxxxx\",\"Ports\":[8080],\"PortMappingItemList\":[{\"Port\":8080,\"TargetPort\":8080,\"Protocol\":\"TCP\"}]}],\"EnableRegistryNextDeploy\":0,\"FlushAll\":true}", "member": "EksService", "name": "Service", "required": false, @@ -5236,7 +5277,7 @@ { "disabled": false, "document": "单条访问方式设置", - "example": "{}", + "example": "{\"Type\":\"CLUSTER\",\"ServiceName\":\"k8s-svc-test\",\"ClusterIp\":\"172.16.56.122\",\"ExternalIp\":\"10.xx.xx.xx\",\"ExternalDomain\":\"ext.domain.com\",\"SubnetId\":\"subnet-xxx\",\"VpcId\":\"vpc-xxx\",\"LoadBalanceId\":\"10.xx.xx.xx\",\"Yaml\":\"apiVersion: xxxxx\",\"Ports\":[8080],\"PortMappingItemList\":[{\"Port\":8080,\"TargetPort\":8080,\"Protocol\":\"TCP\"}]}", "member": "ServicePortMapping", "name": "Data", "required": false, @@ -5291,7 +5332,7 @@ { "disabled": false, "document": "配置信息", - "example": "[]", + "example": "[{\"Key\":\"key-xxx\",\"Value\":\"val-xxx\",\"Type\":\"\",\"Config\":\"\",\"Secret\":\"\"}]", "member": "Pair", "name": "Data", "required": true, @@ -5391,7 +5432,7 @@ { "disabled": false, "document": "环境类型:test、pre、prod", - "example": "test", + "example": "prod", "member": "string", "name": "EnvType", "required": false, @@ -5492,7 +5533,7 @@ { "disabled": false, "document": "日志收集配置信息", - "example": "[]", + "example": "{\"LogsetId\":\"4d43fac5-fc0a-42bf-92a9-ef5b5b245e6a\",\"TopicId\":\"dbebda3e-0a9a-4888-9d5c-642bf2ffa183\",\"InputType\":\"container_stdout\",\"LogType\":\"json_log\",\"ExtractRule\":{\"FilterKeys\":[],\"FilterRegex\":[],\"UnMatchUpload\":\"true\",\"UnMatchedKey\":\"LogParseFailure\"}}", "member": "LogConfig", "name": "Data", "required": true, @@ -5591,17 +5632,17 @@ "example": "env-xxx", "member": "string", "name": "EnvironmentId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "名字(已弃用)", - "example": "test", + "example": "name-test", "member": "string", "name": "NamespaceName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -5611,17 +5652,17 @@ "example": "ap-shanghai", "member": "string", "name": "Region", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "vpc id", - "example": "vpc-xxx", + "example": "vpc-k1ae4nhe", "member": "string", "name": "VpcId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -5631,17 +5672,17 @@ "example": "[\"subnet-xxx\"]", "member": "string", "name": "SubnetIds", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, { "disabled": false, "document": "描述", - "example": "xxx", + "example": "这是一个描述", "member": "string", "name": "Description", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -5651,7 +5692,7 @@ "example": "2012-08-08", "member": "string", "name": "CreatedDate", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -5661,7 +5702,7 @@ "example": "1", "member": "string", "name": "EnvironmentName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5671,7 +5712,7 @@ "example": "instance-xxx", "member": "string", "name": "ApmInstanceId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -5681,7 +5722,7 @@ "example": "1", "member": "int64", "name": "Locked", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, @@ -5691,17 +5732,17 @@ "example": "1", "member": "Tag", "name": "Tags", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "环境类型:test、pre、prod\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "test", + "example": "prod", "member": "string", "name": "EnvType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -5836,55 +5877,60 @@ { "disabled": false, "document": "node名字", - "example": "1", + "example": "eklet-subnet-kctzw7nj-xxxxx", "member": "string", "name": "Name", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "node可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "ap-shanghai-1", "member": "string", "name": "Zone", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "node子网ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "subnet-xxxxxx", "member": "string", "name": "SubnetId", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "可用IP数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "128", "member": "string", "name": "AvailableIpCount", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "cidr块\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "10.0.10.0-24", "member": "string", "name": "Cidr", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true } ], - "usage": "out" + "usage": "both" }, "Pair": { "document": "键值对", @@ -6385,20 +6431,22 @@ { "disabled": false, "document": "shell地址", - "example": "sss", + "example": "https://tkecache.cloud.tencent.com/xxxx", "member": "string", "name": "Webshell", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "pod的id", - "example": "aaa", + "example": "pod-jt5bn", "member": "string", "name": "PodId", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": false }, @@ -6408,7 +6456,8 @@ "example": "Running", "member": "string", "name": "Status", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": false }, @@ -6418,7 +6467,8 @@ "example": "2010-11-11 22:21:11", "member": "string", "name": "CreateTime", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": false }, @@ -6428,122 +6478,134 @@ "example": "127.0.0.1", "member": "string", "name": "PodIp", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "ap-shanghai-1", "member": "string", "name": "Zone", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "部署版本\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "20241202165113", "member": "string", "name": "DeployVersion", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "重启次数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "2", "member": "int64", "name": "RestartCount", - "required": true, + "output_required": true, + "required": false, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "pod是否就绪\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "true", "member": "bool", "name": "Ready", - "required": true, + "output_required": true, + "required": false, "type": "bool", "value_allowed_null": true }, { "disabled": false, "document": "容器状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "running", "member": "string", "name": "ContainerState", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "实例所在节点信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "NodeInfo", "name": "NodeInfo", - "required": true, + "output_required": true, + "required": false, "type": "object", "value_allowed_null": true }, { "disabled": false, "document": "启动时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "2024-12-20T09:01:01Z", "member": "string", "name": "StartTime", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "是否健康\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "true", "member": "bool", "name": "Unhealthy", - "required": true, + "output_required": true, + "required": false, "type": "bool", "value_allowed_null": true }, { "disabled": false, "document": "不健康时的提示信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "message", "member": "string", "name": "UnhealthyWarningMsg", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "版本ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "revision-xxxxxx", "member": "string", "name": "VersionId", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "应用名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "app-name-xxx", "member": "string", "name": "ApplicationName", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true } ], - "usage": "out" + "usage": "both" }, "ServicePage": { "document": "服务分页", @@ -7373,50 +7435,50 @@ { "disabled": false, "document": "环境id", - "example": "1", + "example": "en-xxxxxx", "member": "string", "name": "EnvironmentId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "渠道", - "example": "1", + "example": "0", "member": "string", "name": "Channel", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "环境名称", - "example": "1", + "example": "en-name-xxx", "member": "string", "name": "EnvironmentName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "区域名称", - "example": "1", + "example": "ap-shanghai", "member": "string", "name": "Region", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "环境描述\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "这是一个描述", "member": "string", "name": "Description", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -7426,97 +7488,97 @@ "example": "1", "member": "int64", "name": "Status", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "vpc网络", - "example": "1", + "example": "vpc-xxxxxx", "member": "string", "name": "Vpc", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "创建时间", - "example": "1", + "example": "2024-10-29 18:53:24", "member": "string", "name": "CreateDate", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "修改时间", - "example": "1", + "example": "2024-10-29 18:53:24", "member": "string", "name": "ModifyDate", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "修改人", - "example": "1", + "example": "10001xxxxx", "member": "string", "name": "Modifier", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "创建人", - "example": "1", + "example": "10001xxxxx", "member": "string", "name": "Creator", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "应用数", - "example": "1", + "example": "2", "member": "int64", "name": "ApplicationNum", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "运行实例数", - "example": "1", + "example": "2", "member": "int64", "name": "RunInstancesNum", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "子网络", - "example": "1", + "example": "subnet-xxxxxx", "member": "string", "name": "SubnetId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "环境集群 status", - "example": "1", + "example": "NORMAL", "member": "string", "name": "ClusterStatus", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -7526,7 +7588,7 @@ "example": "true", "member": "bool", "name": "EnableTswTraceService", - "required": true, + "output_required": true, "type": "bool", "value_allowed_null": false }, @@ -7536,77 +7598,77 @@ "example": "1", "member": "int64", "name": "Locked", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "用户AppId\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "1305xxxxxx", "member": "string", "name": "AppId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "用户Uin\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "100019xxxxxx", "member": "string", "name": "Uin", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "用户SubAccountUin\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "100039xxxxxx", "member": "string", "name": "SubAccountUin", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "集群ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "cls-xxxxxx", "member": "string", "name": "ClusterId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "标签\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "Tag", "name": "Tags", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "资源是否有权限\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "false", "member": "bool", "name": "HasAuthority", - "required": true, + "output_required": true, "type": "bool", "value_allowed_null": true }, { "disabled": false, "document": "环境类型: test、pre、prod\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "test", + "example": "prod", "member": "string", "name": "EnvType", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -7616,7 +7678,7 @@ "example": "4", "member": "string", "name": "RegionId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -7815,9 +7877,10 @@ { "disabled": false, "document": "主键", - "example": "1", + "example": "revision-xxxxxx", "member": "string", "name": "VersionId", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7825,9 +7888,10 @@ { "disabled": false, "document": "服务id", - "example": "1", + "example": "app-xxxxxx", "member": "string", "name": "ApplicationId", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7835,9 +7899,10 @@ { "disabled": false, "document": "部署方式", - "example": "1", + "example": "JAR", "member": "string", "name": "DeployMode", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7845,9 +7910,10 @@ { "disabled": false, "document": "jdk版本", - "example": "1", + "example": "KONA:11", "member": "string", "name": "JdkVersion", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7855,9 +7921,10 @@ { "disabled": false, "document": "描述", - "example": "1", + "example": "这是一个描述", "member": "string", "name": "Description", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7865,9 +7932,10 @@ { "disabled": false, "document": "部署版本", - "example": "1", + "example": "20241016164535", "member": "string", "name": "DeployVersion", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7875,9 +7943,10 @@ { "disabled": false, "document": "发布方式", - "example": "1", + "example": "RollingUpdate", "member": "string", "name": "PublishMode", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7885,9 +7954,10 @@ { "disabled": false, "document": "启动参数", - "example": "1", + "example": "-Xms128m -XX:MetaspaceSize=128m", "member": "string", "name": "JvmOpts", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7895,9 +7965,10 @@ { "disabled": false, "document": "初始实例", - "example": "1", + "example": "2", "member": "int64", "name": "InitPodNum", + "output_required": true, "required": true, "type": "int", "value_allowed_null": false @@ -7905,9 +7976,10 @@ { "disabled": false, "document": "cpu规格", - "example": "1", + "example": "2", "member": "float", "name": "CpuSpec", + "output_required": true, "required": true, "type": "float", "value_allowed_null": false @@ -7915,9 +7987,10 @@ { "disabled": false, "document": "内存规格", - "example": "1", + "example": "4", "member": "float", "name": "MemorySpec", + "output_required": true, "required": true, "type": "float", "value_allowed_null": false @@ -7925,9 +7998,10 @@ { "disabled": false, "document": "镜像路径", - "example": "1", + "example": "img-repo-xxx", "member": "string", "name": "ImgRepo", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7935,9 +8009,10 @@ { "disabled": false, "document": "镜像名称", - "example": "1", + "example": "tem-xxxx/image-name", "member": "string", "name": "ImgName", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7945,9 +8020,10 @@ { "disabled": false, "document": "镜像版本", - "example": "1", + "example": "20241016164535", "member": "string", "name": "ImgVersion", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7955,9 +8031,10 @@ { "disabled": false, "document": "弹性配置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "EsInfo", "name": "EsInfo", + "output_required": true, "required": true, "type": "object", "value_allowed_null": true @@ -7965,9 +8042,10 @@ { "disabled": false, "document": "环境配置", - "example": "1", + "example": "无", "member": "Pair", "name": "EnvConf", + "output_required": true, "required": true, "type": "list", "value_allowed_null": false @@ -7975,9 +8053,10 @@ { "disabled": false, "document": "存储配置", - "example": "1", + "example": "无", "member": "StorageConf", "name": "StorageConfs", + "output_required": true, "required": true, "type": "list", "value_allowed_null": false @@ -7985,9 +8064,10 @@ { "disabled": false, "document": "运行状态", - "example": "1", + "example": "normal", "member": "string", "name": "Status", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -7995,9 +8075,10 @@ { "disabled": false, "document": "私有网络", - "example": "1", + "example": "vpc-xxxxxx", "member": "string", "name": "Vpc", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -8005,9 +8086,10 @@ { "disabled": false, "document": "子网网络", - "example": "1", + "example": "subnet-xxxxxx", "member": "string", "name": "SubnetId", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -8015,9 +8097,10 @@ { "disabled": false, "document": "创建时间", - "example": "1", + "example": "2024-10-16 16:45:17", "member": "string", "name": "CreateDate", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -8025,9 +8108,10 @@ { "disabled": false, "document": "修改时间", - "example": "1", + "example": "2024-10-16 16:45:17", "member": "string", "name": "ModifyDate", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -8038,6 +8122,7 @@ "example": "无", "member": "StorageMountConf", "name": "StorageMountConfs", + "output_required": true, "required": true, "type": "list", "value_allowed_null": true @@ -8045,9 +8130,10 @@ { "disabled": false, "document": "版本名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "version-name-xxx", "member": "string", "name": "VersionName", + "output_required": true, "required": true, "type": "string", "value_allowed_null": true @@ -8055,9 +8141,10 @@ { "disabled": false, "document": "日志输出配置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "LogOutputConf", "name": "LogOutputConf", + "output_required": true, "required": false, "type": "object", "value_allowed_null": true @@ -8065,9 +8152,10 @@ { "disabled": false, "document": "服务名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "app-name-xxx", "member": "string", "name": "ApplicationName", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8075,9 +8163,10 @@ { "disabled": false, "document": "服务描述\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "这是一个描述", "member": "string", "name": "ApplicationDescription", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8085,9 +8174,10 @@ { "disabled": false, "document": "环境名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "env-name-xxx", "member": "string", "name": "EnvironmentName", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8095,9 +8185,10 @@ { "disabled": false, "document": "环境ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "en-xxxxxx", "member": "string", "name": "EnvironmentId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8105,9 +8196,10 @@ { "disabled": false, "document": "公网地址\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "pub-domain-xxx.com", "member": "string", "name": "PublicDomain", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8118,6 +8210,7 @@ "example": "true", "member": "bool", "name": "EnablePublicAccess", + "output_required": true, "required": false, "type": "bool", "value_allowed_null": true @@ -8125,9 +8218,10 @@ { "disabled": false, "document": "现有的实例\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "2", "member": "int64", "name": "CurrentInstances", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -8135,9 +8229,10 @@ { "disabled": false, "document": "期望的实例\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "2", "member": "int64", "name": "ExpectedInstances", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -8145,9 +8240,10 @@ { "disabled": false, "document": "编程语言\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "JAVA", "member": "string", "name": "CodingLanguage", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8155,9 +8251,10 @@ { "disabled": false, "document": "程序包名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "tem/pkg/xxx/app-xxx/xxxxx/helloworld.jar", "member": "string", "name": "PkgName", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8168,6 +8265,7 @@ "example": "0", "member": "int64", "name": "EsEnable", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -8178,6 +8276,7 @@ "example": "0", "member": "int64", "name": "EsStrategy", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -8185,9 +8284,10 @@ { "disabled": false, "document": "镜像tag\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "20241016164535", "member": "string", "name": "ImageTag", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8198,6 +8298,7 @@ "example": "0", "member": "int64", "name": "LogEnable", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -8205,9 +8306,10 @@ { "disabled": false, "document": "最小实例数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "2", "member": "string", "name": "MinAliveInstances", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8215,9 +8317,10 @@ { "disabled": false, "document": "安全组\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "sg-xxxxxx", "member": "string", "name": "SecurityGroupIds", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -8228,6 +8331,7 @@ "example": "ls", "member": "string", "name": "ImageCommand", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8238,6 +8342,7 @@ "example": "[\"-c\", \"100\"]", "member": "string", "name": "ImageArgs", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -8245,9 +8350,10 @@ { "disabled": false, "document": "是否使用默认注册中心配置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "false", "member": "bool", "name": "UseRegistryDefaultConfig", + "output_required": true, "required": false, "type": "bool", "value_allowed_null": true @@ -8255,9 +8361,10 @@ { "disabled": false, "document": "eks 访问设置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "EksService", "name": "Service", + "output_required": true, "required": false, "type": "object", "value_allowed_null": true @@ -8265,9 +8372,10 @@ { "disabled": false, "document": "挂载配置信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "[]", + "example": "无", "member": "MountedSettingConf", "name": "SettingConfs", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -8275,9 +8383,10 @@ { "disabled": false, "document": "log path数组信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "[\"/path\"]", "member": "string", "name": "LogConfs", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -8285,9 +8394,10 @@ { "disabled": false, "document": "启动后立即执行的脚本\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "post-start-shell-xxx", "member": "string", "name": "PostStart", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8295,9 +8405,10 @@ { "disabled": false, "document": "停止前执行的脚本\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "pre-stop-shell-xxx", "member": "string", "name": "PreStop", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8305,9 +8416,10 @@ { "disabled": false, "document": "存活探针配置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "HealthCheckConfig", "name": "Liveness", + "output_required": true, "required": false, "type": "object", "value_allowed_null": true @@ -8315,9 +8427,10 @@ { "disabled": false, "document": "就绪探针配置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "HealthCheckConfig", "name": "Readiness", + "output_required": true, "required": false, "type": "object", "value_allowed_null": true @@ -8325,9 +8438,10 @@ { "disabled": false, "document": "弹性策略\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "HorizontalAutoscaler", "name": "HorizontalAutoscaler", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -8335,9 +8449,10 @@ { "disabled": false, "document": "定时弹性策略\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "CronHorizontalAutoscaler", "name": "CronHorizontalAutoscaler", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -8345,9 +8460,10 @@ { "disabled": false, "document": "应用实际可用区\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "[\"ap-shanghai-2\"]", "member": "string", "name": "Zones", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -8355,9 +8471,10 @@ { "disabled": false, "document": "最新部署时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "2024-12-09 10:40:31", "member": "string", "name": "LastDeployDate", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8365,9 +8482,10 @@ { "disabled": false, "document": "最新部署成功时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "LastDeploySuccessDate", "member": "string", "name": "LastDeploySuccessDate", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8375,9 +8493,10 @@ { "disabled": false, "document": "应用所在node信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "NodeInfo", "name": "NodeInfos", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -8385,9 +8504,10 @@ { "disabled": false, "document": "image类型 -0 为demo -1为正常image\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "0", "member": "int64", "name": "ImageType", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -8398,6 +8518,7 @@ "example": "1", "member": "uint64", "name": "EnableTracing", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -8408,6 +8529,7 @@ "example": "1", "member": "uint64", "name": "EnableTracingReport", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -8418,6 +8540,7 @@ "example": "2", "member": "uint64", "name": "RepoType", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -8428,6 +8551,7 @@ "example": "batch_updating", "member": "string", "name": "BatchDeployStatus", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8438,6 +8562,7 @@ "example": "apm-xxx", "member": "string", "name": "ApmInstanceId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8445,9 +8570,10 @@ { "disabled": false, "document": "工作负载信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{}", + "example": "无", "member": "WorkloadInfo", "name": "WorkloadInfo", + "output_required": true, "required": false, "type": "object", "value_allowed_null": true @@ -8458,6 +8584,7 @@ "example": "true", "member": "bool", "name": "SpeedUp", + "output_required": true, "required": false, "type": "bool", "value_allowed_null": true @@ -8465,9 +8592,10 @@ { "disabled": false, "document": "启动检测探针配置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "HealthCheckConfig", "name": "StartupProbe", + "output_required": true, "required": false, "type": "object", "value_allowed_null": true @@ -8475,9 +8603,10 @@ { "disabled": false, "document": "操作系统版本,可选参数:\n- ALPINE\n- CENTOS\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "ALPINE", "member": "string", "name": "OsFlavour", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8485,9 +8614,10 @@ { "disabled": false, "document": "镜像仓库server\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "tem-sh-custom-xxxxxx.tencentcloudcr.com", "member": "string", "name": "RepoServer", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8498,6 +8628,7 @@ "example": "true", "member": "bool", "name": "UnderDeploying", + "output_required": true, "required": false, "type": "bool", "value_allowed_null": true @@ -8505,9 +8636,10 @@ { "disabled": false, "document": "监控业务指标监控\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{}", + "example": "{\"Port\":9090,\"Path:\"/data\"}", "member": "EnablePrometheusConf", "name": "EnablePrometheusConf", + "output_required": true, "required": false, "type": "object", "value_allowed_null": true @@ -8515,9 +8647,10 @@ { "disabled": false, "document": "是否为手动停止\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "true", "member": "bool", "name": "StoppedManually", + "output_required": true, "required": false, "type": "bool", "value_allowed_null": true @@ -8525,9 +8658,10 @@ { "disabled": false, "document": "tcr实例ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "tcr-xxxxxx", "member": "string", "name": "TcrInstanceId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8538,6 +8672,7 @@ "example": "1", "member": "int64", "name": "EnableMetrics", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -8545,9 +8680,10 @@ { "disabled": false, "document": "用户AppId\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "130xxxxxx", "member": "string", "name": "AppId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8555,9 +8691,10 @@ { "disabled": false, "document": "用户SubAccountUin\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "10000xxxxx", "member": "string", "name": "SubAccountUin", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8565,9 +8702,10 @@ { "disabled": false, "document": "用户Uin\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "10001xxxxx", "member": "string", "name": "Uin", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8575,9 +8713,10 @@ { "disabled": false, "document": "地域\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "ap-shanghai", "member": "string", "name": "Region", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8585,9 +8724,10 @@ { "disabled": false, "document": "应用分组ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "group-xxxxxx", "member": "string", "name": "GroupId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8598,6 +8738,7 @@ "example": "1", "member": "int64", "name": "EnableRegistry", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -8605,9 +8746,10 @@ { "disabled": false, "document": "弹性伸缩数组\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "Autoscaler", "name": "AutoscalerList", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -8615,9 +8757,10 @@ { "disabled": false, "document": "修改人\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "100019xxxxxx", "member": "string", "name": "Modifier", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8625,9 +8768,10 @@ { "disabled": false, "document": "创建人\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "100019xxxxxx", "member": "string", "name": "Creator", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8635,9 +8779,10 @@ { "disabled": false, "document": "部署策略\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "DeployStrategyConf", "name": "DeployStrategyConf", + "output_required": true, "required": false, "type": "object", "value_allowed_null": true @@ -8645,9 +8790,10 @@ { "disabled": false, "document": "实例列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "DescribeRunPodPage", "name": "PodList", + "output_required": true, "required": false, "type": "object", "value_allowed_null": true @@ -8655,9 +8801,10 @@ { "disabled": false, "document": "发布时配置是否有修改\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "true", "member": "bool", "name": "ConfEdited", + "output_required": true, "required": false, "type": "bool", "value_allowed_null": true @@ -8665,9 +8812,10 @@ { "disabled": false, "document": "标签\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "无", "member": "Tag", "name": "Tags", + "output_required": true, "required": false, "type": "list", "value_allowed_null": true @@ -8675,9 +8823,10 @@ { "disabled": false, "document": "是否编码\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "PreStopEncoded-xxx", "member": "string", "name": "PreStopEncoded", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8685,9 +8834,10 @@ { "disabled": false, "document": "是否编码\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "\"\"", + "example": "PostStartEncoded-xxx", "member": "string", "name": "PostStartEncoded", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -8701,7 +8851,7 @@ { "disabled": false, "document": "企业版实例名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "test", + "example": "tcr-demo-xxx", "member": "string", "name": "EnterpriseInstanceName", "output_required": true, @@ -8743,27 +8893,30 @@ "example": "cls-xxx", "member": "string", "name": "ClusterId", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "应用名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "xxx", + "example": "appName-xxx", "member": "string", "name": "ApplicationName", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "版本名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "version-name-xxx", "member": "string", "name": "VersionName", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, @@ -8773,17 +8926,19 @@ "example": "1", "member": "int64", "name": "ReadyReplicas", - "required": true, + "output_required": true, + "required": false, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "实例数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "2", "member": "int64", "name": "Replicas", - "required": true, + "output_required": true, + "required": false, "type": "int", "value_allowed_null": true }, @@ -8793,7 +8948,8 @@ "example": "1", "member": "int64", "name": "UpdatedReplicas", - "required": true, + "output_required": true, + "required": false, "type": "int", "value_allowed_null": true }, @@ -8803,32 +8959,35 @@ "example": "1", "member": "int64", "name": "UpdatedReadyReplicas", - "required": true, + "output_required": true, + "required": false, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "更新版本\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "revision-xxxxxx", "member": "string", "name": "UpdateRevision", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "当前版本\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "revision-xxxxxx", "member": "string", "name": "CurrentRevision", - "required": true, + "output_required": true, + "required": false, "type": "string", "value_allowed_null": true } ], - "usage": "out" + "usage": "both" } }, "version": "1.0" diff --git a/tccli/services/tem/v20210701/examples.json b/tccli/services/tem/v20210701/examples.json index 73e8f97384..e3c9cceefc 100644 --- a/tccli/services/tem/v20210701/examples.json +++ b/tccli/services/tem/v20210701/examples.json @@ -3,15 +3,15 @@ "CreateApplication": [ { "document": "创建应用", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApplication\n<公共请求参数>\n\n{\n \"ApplicationName\": \"abc\",\n \"Description\": \"abc\",\n \"UseDefaultImageService\": 0,\n \"RepoType\": 0,\n \"InstanceId\": \"abc\",\n \"RepoServer\": \"abc\",\n \"RepoName\": \"abc\",\n \"SourceChannel\": 0,\n \"SubnetList\": [\n \"abc\"\n ],\n \"CodingLanguage\": \"abc\",\n \"DeployMode\": \"abc\",\n \"EnableTracing\": 0,\n \"UseDefaultImageServiceParameters\": {\n \"EnterpriseInstanceName\": \"abc\",\n \"EnterpriseInstanceChargeType\": 0,\n \"EnterpriseInstanceType\": \"abc\"\n },\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApplication\n<公共请求参数>\n\n{\n \"ApplicationName\": \"tem-app\",\n \"Description\": \"这是一个描述\",\n \"CodingLanguage\": \"JAVA\",\n \"RepoType\": 3\n}", + "output": "{\n \"Response\": {\n \"Result\": \"57d58b44-ee28-4db6-acba-c1cb0cxxx\",\n \"RequestId\": \"app-xxxxxx\"\n }\n}", "title": "创建应用" } ], "CreateApplicationAutoscaler": [ { "document": "创建弹性伸缩策略组合", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApplicationAutoscaler\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-xxxxxx\",\n \"SourceChannel\": 0,\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Autoscaler\": {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 0,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 0,\n \"Metrics\": \"abc\",\n \"Threshold\": 0,\n \"Enabled\": true,\n \"DoubleThreshold\": 0\n }\n ],\n \"CronHorizontalAutoscaler\": [\n {\n \"Name\": \"abc\",\n \"Period\": \"abc\",\n \"Schedules\": [\n {\n \"StartAt\": \"abc\",\n \"TargetReplicas\": 0\n }\n ],\n \"Enabled\": true,\n \"Priority\": 0\n }\n ],\n \"AutoscalerId\": \"abc\",\n \"AutoscalerName\": \"abc\",\n \"Description\": \"abc\",\n \"CreateDate\": \"abc\",\n \"ModifyDate\": \"abc\",\n \"EnableDate\": \"abc\",\n \"Enabled\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApplicationAutoscaler\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-xxxxxx\",\n \"SourceChannel\": 0,\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Autoscaler\": {\n \"MinReplicas\": 1,\n \"MaxReplicas\": 3,\n \"AutoscalerName\": \"pk-test-1\",\n \"Description\": \"这是一个描述\",\n \"Enabled\": false,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 1,\n \"MaxReplicas\": 3,\n \"Metrics\": \"CPU\",\n \"DoubleThreshold\": 50,\n \"Enabled\": true\n }\n ],\n \"CronHorizontalAutoscaler\": [\n {\n \"Name\": \"policy-test\",\n \"Period\": \"* * *\",\n \"Schedules\": [\n {\n \"StartAt\": \"00:00\",\n \"TargetReplicas\": 1\n }\n ],\n \"Enabled\": true,\n \"Priority\": 0\n }\n ]\n }\n}", "output": "{\n \"Response\": {\n \"Result\": \"scaler-xxxxxx\",\n \"RequestId\": \"ab-xx\"\n }\n}", "title": "创建弹性伸缩策略组合" } @@ -19,7 +19,7 @@ "CreateApplicationService": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApplicationService\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-xxxxxx\",\n \"SourceChannel\": 0,\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Service\": {\n \"Type\": \"VPC\",\n \"ServiceName\": \"abc\",\n \"ClusterIp\": \"abc\",\n \"ExternalIp\": \"abc\",\n \"SubnetId\": \"abc\",\n \"VpcId\": \"abc\",\n \"LoadBalanceId\": \"abc\",\n \"Yaml\": \"abc\",\n \"Ports\": [\n 0\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 0,\n \"TargetPort\": 0,\n \"Protocol\": \"abc\"\n }\n ],\n \"ExternalDomain\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApplicationService\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-xxxxxx\",\n \"SourceChannel\": 0,\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Service\": {\n \"Type\": \"VPC\",\n \"ServiceName\": \"svc-name-xxx\",\n \"ClusterIp\": \"10.xx.xx.xx\",\n \"ExternalIp\": \"10.xx.xx.xx\",\n \"SubnetId\": \"subnet-xxxxxx\",\n \"VpcId\": \"vpc-xxxxxx\",\n \"LoadBalanceId\": \"10.xx.xx.xx\",\n \"Yaml\": \"yaml-apiVersion-xxx\",\n \"Ports\": [\n 0\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 8080,\n \"TargetPort\": 8080,\n \"Protocol\": \"TCP\"\n }\n ],\n \"ExternalDomain\": \"ext.domain.xxx\"\n }\n}", "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"xx-xxx-xxx\"\n }\n}", "title": "新增访问方式" } @@ -27,7 +27,7 @@ "CreateConfigData": [ { "document": "创建配置", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConfigData\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Name\": \"abc\",\n \"SourceChannel\": 0,\n \"Data\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\",\n \"Type\": \"abc\",\n \"Config\": \"abc\",\n \"Secret\": \"abc\"\n }\n ]\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConfigData\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Name\": \"config-name-xxx\",\n \"SourceChannel\": 0,\n \"Data\": [\n {\n \"Key\": \"key-xxx\",\n \"Value\": \"val-xxx\"\n }\n ]\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": true\n }\n}", "title": "创建配置" } @@ -43,15 +43,15 @@ "CreateEnvironment": [ { "document": "创建环境", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateEnvironment\n<公共请求参数>\n\n{\n \"EnvironmentName\": \"name-xxx\",\n \"Description\": \"描述\",\n \"K8sVersion\": \"1.69.1\",\n \"SubnetIds\": [\n \"subnet-xxx\"\n ],\n \"EnableTswTraceService\": true,\n \"SourceChannel\": 0,\n \"Vpc\": \"vpc-xxx\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": \"env-xxxx\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateEnvironment\n<公共请求参数>\n\n{\n \"EnvironmentName\": \"name-xxx\",\n \"Description\": \"这是一个描述\",\n \"K8sVersion\": \"1.69.1\",\n \"SubnetIds\": [\n \"subnet-xxx\"\n ],\n \"EnableTswTraceService\": true,\n \"SourceChannel\": 0,\n \"Vpc\": \"vpc-1n5javez\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": \"en-xxxx\"\n }\n}", "title": "创建环境" } ], "CreateLogConfig": [ { "document": "创建日志收集配置", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLogConfig\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"ApplicationId\": \"app-xxxxxx\",\n \"Name\": \"abc\",\n \"LogsetId\": \"abc-xxx\",\n \"TopicId\": \"abc-xxxxx\",\n \"InputType\": \"container_stdout\",\n \"LogType\": \"json_log\",\n \"BeginningRegex\": \"abc\",\n \"LogPath\": \"/abc\",\n \"FilePattern\": \"abc\",\n \"ExtractRule\": {\n \"BeginningRegex\": \"abc\",\n \"Keys\": [\n \"abc\"\n ],\n \"FilterKeys\": [\n \"abc\"\n ],\n \"FilterRegex\": [\n \"abc\"\n ],\n \"LogRegex\": \"abc\",\n \"TimeKey\": \"abc\",\n \"TimeFormat\": \"abc\",\n \"UnMatchUpload\": \"abc\",\n \"UnMatchedKey\": \"abc\",\n \"Backtracking\": \"abc\",\n \"Delimiter\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLogConfig\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-dpxydze5\",\n \"ApplicationId\": \"app-5vaz8x85\",\n \"LogsetId\": \"7a126551-62d1-4e12-b426-84bd5b2fdbca\",\n \"TopicId\": \"6c69fdb7-5e4c-4e52-8437-32c2c729b85a\",\n \"InputType\": \"container_stdout\",\n \"LogType\": \"json_log\",\n \"Name\": \"log-cfg-xxx\",\n \"ExtractRule\": {\n \"FilterKeys\": [],\n \"FilterRegex\": [],\n \"UnMatchUpload\": \"true\",\n \"UnMatchedKey\": \"LogParseFailure\"\n }\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": true\n }\n}", "title": "创建日志收集配置" } @@ -59,7 +59,7 @@ "CreateResource": [ { "document": "绑定云资源", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateResource\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"ResourceType\": \"CFS\",\n \"ResourceId\": \"resource-xxxxxx\",\n \"SourceChannel\": 0,\n \"ResourceFrom\": \"test\",\n \"ResourceConfig\": \"abc\"\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateResource\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"ResourceType\": \"CFS\",\n \"ResourceId\": \"resource-xxxxxx\",\n \"SourceChannel\": 0,\n \"ResourceFrom\": \"existing\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": true\n }\n}", "title": "绑定云资源" } @@ -99,7 +99,7 @@ "DeployApplication": [ { "document": "应用部署", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeployApplication\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-5vaz8x85\",\n \"ConfEdited\": false,\n \"CpuSpec\": 1,\n \"DeployMode\": \"IMAGE\",\n \"DeployStrategyConf\": {\n \"BatchInterval\": 0,\n \"BetaBatchNum\": 0,\n \"DeployStrategyType\": 0,\n \"Force\": false,\n \"MinAvailable\": 1,\n \"TotalBatchCount\": 1\n },\n \"DeployVersion\": \"hello-world\",\n \"EnableTracing\": 0,\n \"EnvConf\": [],\n \"EnvironmentId\": \"en-dpxydze5\",\n \"ImgRepo\": \"tem_demo/tem_demo\",\n \"InitPodNum\": 1,\n \"JvmOpts\": \"\",\n \"LogEnable\": 0,\n \"MemorySpec\": 2,\n \"PostStart\": \"\",\n \"PreStop\": \"\",\n \"RepoServer\": \"ccr.ccs.tencentyun.com\",\n \"RepoType\": 4,\n \"SecurityGroupIds\": [\n \"\"\n ],\n \"Service\": {\n \"EnableRegistryNextDeploy\": 0,\n \"FlushAll\": true,\n \"ServicePortMappingList\": [\n {\n \"ClusterIp\": \"172.16.207.15\",\n \"ExternalDomain\": \"\",\n \"ExternalIp\": \"\",\n \"LoadBalanceId\": \"\",\n \"PortMappingItemList\": [\n {\n \"Port\": 8201,\n \"Protocol\": \"TCP\",\n \"TargetPort\": 8201\n }\n ],\n \"Ports\": [\n 8201\n ],\n \"ServiceName\": \"pk-test-clb-2\",\n \"SubnetId\": \"\",\n \"Type\": \"CLUSTER\",\n \"VpcId\": \"\",\n \"Yaml\": \"apiVersion: v1\\nkind: Service\\nmetadata:\\n creationTimestamp: '2024-10-25T10:52:08Z'\\n finalizers: []\\n labels:\\n tem-application-id: app-5vaz8x85\\n tem-internal: 'false'\\n tem-service: pk-test-clb-2\\n managedFields:\\n - apiVersion: v1\\n fieldsType: FieldsV1\\n fieldsV1: {}\\n manager: okhttp\\n operation: Update\\n time: '2024-10-25T10:52:08Z'\\n name: pk-test-clb-2\\n namespace: default\\n ownerReferences: []\\n resourceVersion: '24527383012'\\n selfLink: /api/v1/namespaces/default/services/pk-test-clb-2\\n uid: 205ee301-8743-46ac-bc6f-d757eeab27bb\\nspec:\\n type: ClusterIP\\n clusterIP: 172.16.207.15\\n clusterIPs:\\n - 172.16.207.15\\n externalIPs: []\\n ipFamilies: []\\n loadBalancerSourceRanges: []\\n ports:\\n - name: pk-test-clb-2-port-tcp-8201-8201\\n port: 8201\\n protocol: TCP\\n targetPort:\\n kind: 0\\n intVal: 8201\\n selector:\\n tem-service: app0925\\n sessionAffinity: None\\n topologyKeys: []\\nstatus:\\n conditions: []\\n loadBalancer:\\n ingress: []\\n\"\n }\n ]\n },\n \"SettingConfs\": [],\n \"StorageConfs\": [],\n \"StorageMountConfs\": [],\n \"TcrInstanceId\": \"tcr-cwnk7hmb\",\n \"UseRegistryDefaultConfig\": false\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeployApplication\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-5vaz8x85\",\n \"ConfEdited\": false,\n \"DeployMode\": \"JAR\",\n \"JdkVersion\": \"KONA:11\",\n \"PkgName\": \"tem/pkg/130xxxx/app-5vaz8x85/1733xxxx/K8sDemo-1.0.jar\",\n \"SpeedUp\": true,\n \"OsFlavour\": \"ALPINE\",\n \"DeployVersion\": \"20241202165113\",\n \"JvmOpts\": \"-Xms128m -XX:MetaspaceSize=128m\",\n \"InitPodNum\": 3,\n \"CpuSpec\": 1,\n \"MemorySpec\": 2,\n \"EnvConf\": [\n {\n \"Key\": \"key\",\n \"Value\": \"val\",\n \"Type\": \"default\",\n \"Config\": \"\",\n \"Secret\": \"\"\n }\n ],\n \"LogEnable\": 0,\n \"StorageConfs\": [],\n \"StorageMountConfs\": [],\n \"SecurityGroupIds\": [\n \"sg-1zwhplpi\"\n ],\n \"EnvironmentId\": \"en-dpxydze5\",\n \"Service\": {\n \"ServicePortMappingList\": [\n {\n \"Type\": \"CLUSTER\",\n \"ServiceName\": \"k8s-svc-test\",\n \"ClusterIp\": \"172.16.56.122\",\n \"ExternalIp\": \"10.xx.xx.xx\",\n \"ExternalDomain\": \"ext.domain.com\",\n \"SubnetId\": \"subnet-xxx\",\n \"VpcId\": \"vpc-xxx\",\n \"LoadBalanceId\": \"10.xx.xx.xx\",\n \"Yaml\": \"apiVersion: xxxxx\",\n \"Ports\": [\n 8080\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 8080,\n \"TargetPort\": 8080,\n \"Protocol\": \"TCP\"\n }\n ]\n }\n ],\n \"EnableRegistryNextDeploy\": 0,\n \"FlushAll\": true\n },\n \"UseRegistryDefaultConfig\": false,\n \"EnableTracing\": 0,\n \"SettingConfs\": [\n {\n \"ConfigDataName\": \"cfg-test-1\",\n \"MountedPath\": \"/data\",\n \"SecretDataName\": \"secret-name\"\n }\n ],\n \"DeployStrategyConf\": {\n \"TotalBatchCount\": 1,\n \"BetaBatchNum\": 0,\n \"DeployStrategyType\": 3,\n \"MinAvailable\": 1,\n \"Force\": true,\n \"BatchInterval\": 0\n },\n \"PostStart\": \"/bin/sh\\n-c\\ncurl localhost:8080/postStart\",\n \"PreStop\": \"/bin/sh\\n-c\\nwget --server-response --spider -S --no-verbose --header=\\\"Content-Type:application/json\\\" --post-data='{\\\"serverName\\\":\\\"api-basic\\\"}' \\\"http://localhost:9900/actuator/stopmsg\\\"\\nsleep 30s\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": \"revision-xxxxxx\"\n }\n}", "title": "应用部署" } @@ -108,7 +108,7 @@ { "document": "获取应用弹性策略组合", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeApplicationAutoscalerList\n<公共请求参数>\n\n{\n \"SourceChannel\": 0,\n \"ApplicationId\": \"app-xxxxxx\",\n \"EnvironmentId\": \"en-xxxxxx\"\n}", - "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 0,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 0,\n \"Metrics\": \"abc\",\n \"Threshold\": 0,\n \"Enabled\": true,\n \"DoubleThreshold\": 0\n }\n ],\n \"CronHorizontalAutoscaler\": [\n {\n \"Name\": \"abc\",\n \"Period\": \"abc\",\n \"Schedules\": [\n {\n \"StartAt\": \"abc\",\n \"TargetReplicas\": 0\n }\n ],\n \"Enabled\": true,\n \"Priority\": 0\n }\n ],\n \"AutoscalerId\": \"abc\",\n \"AutoscalerName\": \"abc\",\n \"Description\": \"abc\",\n \"CreateDate\": \"abc\",\n \"ModifyDate\": \"abc\",\n \"EnableDate\": \"abc\",\n \"Enabled\": true\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"AutoscalerId\": \"scaler-3j2o6ypg\",\n \"AutoscalerName\": \"elastic-test\",\n \"MinReplicas\": 0,\n \"MaxReplicas\": 4,\n \"CreateDate\": \"2024-12-05 11:10:19\",\n \"ModifyDate\": \"2024-12-20 17:00:23\",\n \"EnableDate\": \"2024-12-20 17:00:23\",\n \"Description\": \"这是一个描述\",\n \"Enabled\": true,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 4,\n \"Metrics\": \"CPU\",\n \"Threshold\": 0,\n \"DoubleThreshold\": 60,\n \"Enabled\": true\n }\n ],\n \"CronHorizontalAutoscaler\": []\n },\n {\n \"AutoscalerId\": \"scaler-b5q33njo\",\n \"AutoscalerName\": \"pk-test-clb\",\n \"MinReplicas\": 0,\n \"MaxReplicas\": 4,\n \"CreateDate\": \"2024-10-25 16:36:10\",\n \"ModifyDate\": \"2024-11-29 10:35:52\",\n \"EnableDate\": \"2024-11-29 10:35:52\",\n \"Description\": \"这是一个描述\",\n \"Enabled\": false,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 4,\n \"Metrics\": \"CPU\",\n \"Threshold\": 0,\n \"DoubleThreshold\": 50,\n \"Enabled\": true\n }\n ],\n \"CronHorizontalAutoscaler\": [\n {\n \"Name\": \"pk-test\",\n \"Period\": \"* * *\",\n \"Schedules\": [\n {\n \"StartAt\": \"02:00\",\n \"TargetReplicas\": 1\n }\n ],\n \"Enabled\": false,\n \"Priority\": 0\n }\n ]\n },\n {\n \"AutoscalerId\": \"scaler-ojr3nlj9\",\n \"AutoscalerName\": \"pk-test-1\",\n \"MinReplicas\": 1,\n \"MaxReplicas\": 3,\n \"CreateDate\": \"2024-12-19 23:38:45\",\n \"ModifyDate\": \"2024-12-19 23:38:45\",\n \"EnableDate\": null,\n \"Description\": \"\",\n \"Enabled\": false,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 1,\n \"MaxReplicas\": 3,\n \"Metrics\": \"CPU\",\n \"Threshold\": 0,\n \"DoubleThreshold\": 50,\n \"Enabled\": true\n }\n ],\n \"CronHorizontalAutoscaler\": [\n {\n \"Name\": \"policy-test\",\n \"Period\": \"* * *\",\n \"Schedules\": [\n {\n \"StartAt\": \"00:00\",\n \"TargetReplicas\": 1\n }\n ],\n \"Enabled\": true,\n \"Priority\": 0\n }\n ]\n }\n ],\n \"RequestId\": \"c1d58f12-420f-464c-ac3e-f4f6a77284b0\"\n }\n}", "title": "获取应用弹性策略组合" } ], @@ -116,7 +116,7 @@ { "document": "服务基本信息查看", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeApplicationInfo\n<公共请求参数>\n\n{\n \"SourceChannel\": 0,\n \"ApplicationId\": \"app-xxxxxx\",\n \"EnvironmentId\": \"en-xxxxxx\"\n}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"VersionId\": \"abc\",\n \"ApplicationId\": \"abc\",\n \"DeployMode\": \"abc\",\n \"JdkVersion\": \"abc\",\n \"Description\": \"abc\",\n \"DeployVersion\": \"abc\",\n \"PublishMode\": \"abc\",\n \"JvmOpts\": \"abc\",\n \"InitPodNum\": 0,\n \"CpuSpec\": 0,\n \"MemorySpec\": 0,\n \"ImgRepo\": \"abc\",\n \"ImgName\": \"abc\",\n \"ImgVersion\": \"abc\",\n \"EsInfo\": {\n \"MinAliveInstances\": 0,\n \"MaxAliveInstances\": 0,\n \"EsStrategy\": 0,\n \"VersionId\": \"abc\",\n \"Threshold\": 1\n },\n \"EnvConf\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\",\n \"Type\": \"abc\",\n \"Config\": \"abc\",\n \"Secret\": \"abc\"\n }\n ],\n \"StorageConfs\": [\n {\n \"StorageVolName\": \"abc\",\n \"StorageVolPath\": \"abc\",\n \"StorageVolIp\": \"abc\"\n }\n ],\n \"Status\": \"abc\",\n \"Vpc\": \"abc\",\n \"SubnetId\": \"abc\",\n \"CreateDate\": \"abc\",\n \"ModifyDate\": \"abc\",\n \"StorageMountConfs\": [\n {\n \"VolumeName\": \"abc\",\n \"MountPath\": \"abc\"\n }\n ],\n \"VersionName\": \"abc\",\n \"LogOutputConf\": {\n \"OutputType\": \"abc\",\n \"ClsLogsetName\": \"abc\",\n \"ClsLogTopicId\": \"abc\",\n \"ClsLogsetId\": \"abc\",\n \"ClsLogTopicName\": \"abc\"\n },\n \"ApplicationName\": \"abc\",\n \"ApplicationDescription\": \"abc\",\n \"EnvironmentName\": \"abc\",\n \"EnvironmentId\": \"abc\",\n \"PublicDomain\": \"abc\",\n \"EnablePublicAccess\": true,\n \"CurrentInstances\": 0,\n \"ExpectedInstances\": 0,\n \"CodingLanguage\": \"abc\",\n \"PkgName\": \"abc\",\n \"EsEnable\": 0,\n \"EsStrategy\": 0,\n \"ImageTag\": \"abc\",\n \"LogEnable\": 0,\n \"MinAliveInstances\": \"abc\",\n \"SecurityGroupIds\": [\n \"abc\"\n ],\n \"ImageCommand\": \"abc\",\n \"ImageArgs\": [\n \"abc\"\n ],\n \"UseRegistryDefaultConfig\": true,\n \"Service\": {\n \"Name\": \"abc\",\n \"Ports\": [\n 0\n ],\n \"Yaml\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"VersionName\": \"abc\",\n \"ClusterIp\": [\n \"abc\"\n ],\n \"ExternalIp\": \"abc\",\n \"Type\": \"abc\",\n \"SubnetId\": \"abc\",\n \"LoadBalanceId\": \"abc\",\n \"PortMappings\": [\n {\n \"Port\": 0,\n \"TargetPort\": 0,\n \"Protocol\": \"abc\",\n \"ServiceName\": \"abc\"\n }\n ],\n \"ServicePortMappingList\": [\n {\n \"Type\": \"abc\",\n \"ServiceName\": \"abc\",\n \"ClusterIp\": \"abc\",\n \"ExternalIp\": \"abc\",\n \"SubnetId\": \"abc\",\n \"VpcId\": \"abc\",\n \"LoadBalanceId\": \"abc\",\n \"Yaml\": \"abc\",\n \"Ports\": [\n 0\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 0,\n \"TargetPort\": 0,\n \"Protocol\": \"abc\"\n }\n ],\n \"ExternalDomain\": \"abc\"\n }\n ],\n \"FlushAll\": true,\n \"EnableRegistryNextDeploy\": 0,\n \"ApplicationId\": \"abc\",\n \"AllIpDone\": true,\n \"ExternalDomain\": \"abc\"\n },\n \"SettingConfs\": [\n {\n \"ConfigDataName\": \"abc\",\n \"MountedPath\": \"abc\",\n \"Data\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\",\n \"Type\": \"abc\",\n \"Config\": \"abc\",\n \"Secret\": \"abc\"\n }\n ],\n \"SecretDataName\": \"abc\"\n }\n ],\n \"LogConfs\": [\n \"abc\"\n ],\n \"PostStart\": \"abc\",\n \"PreStop\": \"abc\",\n \"Liveness\": {\n \"Type\": \"abc\",\n \"Protocol\": \"abc\",\n \"Path\": \"abc\",\n \"Exec\": \"abc\",\n \"Port\": 0,\n \"InitialDelaySeconds\": 0,\n \"TimeoutSeconds\": 0,\n \"PeriodSeconds\": 0\n },\n \"Readiness\": {\n \"Type\": \"abc\",\n \"Protocol\": \"abc\",\n \"Path\": \"abc\",\n \"Exec\": \"abc\",\n \"Port\": 0,\n \"InitialDelaySeconds\": 0,\n \"TimeoutSeconds\": 0,\n \"PeriodSeconds\": 0\n },\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 0,\n \"Metrics\": \"abc\",\n \"Threshold\": 0,\n \"Enabled\": true,\n \"DoubleThreshold\": 0\n }\n ],\n \"CronHorizontalAutoscaler\": [\n {\n \"Name\": \"abc\",\n \"Period\": \"abc\",\n \"Schedules\": [\n {\n \"StartAt\": \"abc\",\n \"TargetReplicas\": 0\n }\n ],\n \"Enabled\": true,\n \"Priority\": 0\n }\n ],\n \"Zones\": [\n \"abc\"\n ],\n \"LastDeployDate\": \"abc\",\n \"LastDeploySuccessDate\": \"abc\",\n \"NodeInfos\": [\n {\n \"Name\": \"abc\",\n \"Zone\": \"abc\",\n \"SubnetId\": \"abc\",\n \"AvailableIpCount\": \"abc\",\n \"Cidr\": \"abc\"\n }\n ],\n \"ImageType\": 0,\n \"EnableTracing\": 1,\n \"EnableTracingReport\": 1,\n \"RepoType\": 1,\n \"BatchDeployStatus\": \"abc\",\n \"ApmInstanceId\": \"abc\",\n \"WorkloadInfo\": {\n \"ClusterId\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"VersionName\": \"abc\",\n \"ReadyReplicas\": 0,\n \"Replicas\": 0,\n \"UpdatedReplicas\": 0,\n \"UpdatedReadyReplicas\": 0,\n \"UpdateRevision\": \"abc\",\n \"CurrentRevision\": \"abc\"\n },\n \"SpeedUp\": true,\n \"StartupProbe\": {\n \"Type\": \"abc\",\n \"Protocol\": \"abc\",\n \"Path\": \"abc\",\n \"Exec\": \"abc\",\n \"Port\": 0,\n \"InitialDelaySeconds\": 0,\n \"TimeoutSeconds\": 0,\n \"PeriodSeconds\": 0\n },\n \"OsFlavour\": \"abc\",\n \"RepoServer\": \"abc\",\n \"UnderDeploying\": true,\n \"EnablePrometheusConf\": {\n \"Port\": 0,\n \"Path\": \"abc\"\n },\n \"StoppedManually\": true,\n \"TcrInstanceId\": \"abc\",\n \"EnableMetrics\": 0,\n \"AppId\": \"abc\",\n \"SubAccountUin\": \"abc\",\n \"Uin\": \"abc\",\n \"Region\": \"abc\",\n \"GroupId\": \"abc\",\n \"EnableRegistry\": 0,\n \"AutoscalerList\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 0,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 0,\n \"Metrics\": \"abc\",\n \"Threshold\": 0,\n \"Enabled\": true,\n \"DoubleThreshold\": 0\n }\n ],\n \"CronHorizontalAutoscaler\": [\n {\n \"Name\": \"abc\",\n \"Period\": \"abc\",\n \"Schedules\": [\n {\n \"StartAt\": \"abc\",\n \"TargetReplicas\": 0\n }\n ],\n \"Enabled\": true,\n \"Priority\": 0\n }\n ],\n \"AutoscalerId\": \"abc\",\n \"AutoscalerName\": \"abc\",\n \"Description\": \"abc\",\n \"CreateDate\": \"abc\",\n \"ModifyDate\": \"abc\",\n \"EnableDate\": \"abc\",\n \"Enabled\": true\n }\n ],\n \"Modifier\": \"abc\",\n \"Creator\": \"abc\",\n \"DeployStrategyConf\": {\n \"TotalBatchCount\": 0,\n \"BetaBatchNum\": 0,\n \"DeployStrategyType\": 0,\n \"BatchInterval\": 0,\n \"MinAvailable\": 0,\n \"Force\": true\n },\n \"PodList\": {\n \"Offset\": 0,\n \"Limit\": 0,\n \"TotalCount\": 0,\n \"RequestId\": \"abc\",\n \"PodList\": [\n {\n \"Webshell\": \"abc\",\n \"PodId\": \"abc\",\n \"Status\": \"abc\",\n \"CreateTime\": \"abc\",\n \"PodIp\": \"abc\",\n \"Zone\": \"abc\",\n \"DeployVersion\": \"abc\",\n \"RestartCount\": 0,\n \"Ready\": true,\n \"ContainerState\": \"abc\",\n \"NodeInfo\": {\n \"Name\": \"abc\",\n \"Zone\": \"abc\",\n \"SubnetId\": \"abc\",\n \"AvailableIpCount\": \"abc\",\n \"Cidr\": \"abc\"\n },\n \"StartTime\": \"abc\",\n \"Unhealthy\": true,\n \"UnhealthyWarningMsg\": \"abc\",\n \"VersionId\": \"abc\",\n \"ApplicationName\": \"abc\"\n }\n ]\n },\n \"ConfEdited\": true,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"PreStopEncoded\": \"abc\",\n \"PostStartEncoded\": \"abc\"\n },\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"b86d4065-771d-485c-9130-8914fe5fd1bc\",\n \"Result\": {\n \"AppId\": \"1305738457\",\n \"SubAccountUin\": \"100000799529\",\n \"Uin\": \"100019051593\",\n \"Region\": \"ap-shanghai\",\n \"VersionId\": \"revision-jorxnl6j\",\n \"VersionName\": \"20241202165113\",\n \"ApplicationId\": \"app-5vaz8x85\",\n \"Vpc\": \"vpc-e3ay8qku\",\n \"SubnetId\": \"subnet-kctzw7nj,subnet-8indzsuv,subnet-qau65gm1\",\n \"DeployMode\": \"JAR\",\n \"JdkVersion\": \"KONA:11\",\n \"Description\": \"\",\n \"DeployVersion\": \"20241202165113\",\n \"GroupId\": \"group-job6vv75\",\n \"PublishMode\": \"\",\n \"InitPodNum\": 3,\n \"CpuSpec\": 1,\n \"MemorySpec\": 2,\n \"ImgRepo\": \"\",\n \"ImgName\": \"tem-100019051593-sfuw/app0925\",\n \"ImgVersion\": \"20241202165113\",\n \"EsInfo\": null,\n \"EnvConf\": [\n {\n \"Key\": \"TEM_APM_TOKEN\",\n \"Value\": \"DBaxEudGGxxOFmAYNBuq\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n },\n {\n \"Key\": \"TEM_APM_COLLECTOR_SKYWALKING\",\n \"Value\": \"pl.ap-shanghai.apm.tencentcs.com:11800\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n },\n {\n \"Key\": \"TEM_APM_COLLECTOR_JAEGER\",\n \"Value\": \"pl.ap-shanghai.apm.tencentcs.com:14250\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n },\n {\n \"Key\": \"TEM_APM_COLLECTOR_OPENTELEMETRY\",\n \"Value\": \"pl.ap-shanghai.apm.tencentcs.com:4317\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n },\n {\n \"Key\": \"TEM_APM_INSTANCE_ID\",\n \"Value\": \"apm-JcXK7eNzw\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n },\n {\n \"Key\": \"PROMETHEUS_INSTANCE_ID\",\n \"Value\": \"prom-hdiellob\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n },\n {\n \"Key\": \"PROMETHEUS_TOKEN\",\n \"Value\": \";F1Lh7zVs-LFhT&+3dRqUA5bhdl\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n },\n {\n \"Key\": \"PROMETHEUS_REMOTE_WRITE_URL\",\n \"Value\": \"http://10.0.30.147:9090/api/v1/prom/write\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n },\n {\n \"Key\": \"PROMETHEUS_REMOTE_READ_URL\",\n \"Value\": \"http://10.0.30.147:9090/api/v1/read\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n },\n {\n \"Key\": \"PROMETHEUS_PUSH_GATEWAY_ADDR\",\n \"Value\": \"10.0.30.147:9090\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n },\n {\n \"Key\": \"PROMETHEUS_HTTP_API\",\n \"Value\": \"http://10.0.30.147:9090/api/v1\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n },\n {\n \"Key\": \"PROMETHEUS_GRAFANA_ADDR\",\n \"Value\": \"\",\n \"Type\": \"reserved\",\n \"Config\": \"\",\n \"Secret\": \"\"\n }\n ],\n \"SettingConfs\": [\n {\n \"ConfigDataName\": \"pk-test-1\",\n \"SecretDataName\": \"\",\n \"MountedPath\": \"/data\",\n \"Data\": [\n {\n \"Key\": \"name\",\n \"Value\": \"value\",\n \"Type\": \"\",\n \"Config\": \"\",\n \"Secret\": \"\"\n }\n ]\n }\n ],\n \"LogConfs\": [],\n \"LogOutputConf\": null,\n \"PostStart\": \"/bin/sh\\n-c\\ncurl localhost:8080/postStart\",\n \"PostStartEncoded\": \"\",\n \"PreStop\": \"/bin/sh\\n-c\\nwget --server-response --spider -S --no-verbose --header=\\\"Content-Type:application/json\\\" --post-data='{\\\"serverName\\\":\\\"api-basic\\\"}' \\\"http://localhost:9900/actuator/stopmsg\\\"\\nsleep 30s\",\n \"PreStopEncoded\": \"\",\n \"StorageConfs\": [],\n \"StorageMountConfs\": [],\n \"JvmOpts\": \"-Xms128m -XX:MetaspaceSize=128m\",\n \"Service\": {\n \"PortMappings\": [],\n \"LoadBalanceId\": \"\",\n \"SubnetId\": \"\",\n \"Type\": \"\",\n \"Name\": \"\",\n \"ApplicationName\": \"app0925\",\n \"ClusterIp\": [],\n \"ExternalIp\": \"\",\n \"ExternalDomain\": \"\",\n \"VersionName\": \"\",\n \"Ports\": [],\n \"Yaml\": \"\",\n \"ApplicationId\": \"app-5vaz8x85\",\n \"ServicePortMappingList\": [\n {\n \"Type\": \"CLUSTER\",\n \"ServiceName\": \"k8s-svc-test\",\n \"ClusterIp\": \"172.16.56.122\",\n \"ExternalIp\": \"\",\n \"ExternalDomain\": \"\",\n \"SubnetId\": \"\",\n \"VpcId\": \"\",\n \"LoadBalanceId\": \"\",\n \"Yaml\": \"apiVersion: xxxx\",\n \"Ports\": [\n 8080\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 8080,\n \"TargetPort\": 8080,\n \"Protocol\": \"TCP\"\n }\n ]\n },\n {\n \"Type\": \"CLUSTER\",\n \"ServiceName\": \"pk-svc\",\n \"ClusterIp\": \"172.16.52.35\",\n \"ExternalIp\": \"\",\n \"ExternalDomain\": \"\",\n \"SubnetId\": \"\",\n \"VpcId\": \"\",\n \"LoadBalanceId\": \"\",\n \"Yaml\": \"apiVersion: xxxx\",\n \"Ports\": [\n 8080\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 8080,\n \"TargetPort\": 8080,\n \"Protocol\": \"TCP\"\n }\n ]\n }\n ],\n \"FlushAll\": false,\n \"EnableRegistryNextDeploy\": 0,\n \"AllIpDone\": true\n },\n \"Liveness\": null,\n \"Readiness\": null,\n \"StartupProbe\": null,\n \"EsEnable\": null,\n \"EnableTracing\": 0,\n \"EnableRegistry\": 0,\n \"EnableTracingReport\": 0,\n \"EnableMetrics\": 0,\n \"EnablePrometheusConf\": null,\n \"ApmInstanceId\": \"\",\n \"LogEnable\": null,\n \"RepoType\": 3,\n \"CreateDate\": \"2024-09-25 11:36:11\",\n \"ModifyDate\": \"2024-12-20 17:00:16\",\n \"MinAliveInstances\": \"\",\n \"ImageTag\": \"20241202165113\",\n \"SecurityGroupIds\": [\n \"sg-1zwhplpi\"\n ],\n \"EsStrategy\": null,\n \"AutoscalerList\": [\n {\n \"AutoscalerId\": \"scaler-3j2o6ypg\",\n \"AutoscalerName\": \"elastic-test\",\n \"MinReplicas\": 0,\n \"MaxReplicas\": 4,\n \"CreateDate\": \"2024-12-05 11:10:19\",\n \"ModifyDate\": \"2024-12-20 17:00:23\",\n \"EnableDate\": \"2024-12-20 17:00:23\",\n \"Description\": \"\",\n \"Enabled\": true,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 4,\n \"Metrics\": \"CPU\",\n \"Threshold\": 0,\n \"DoubleThreshold\": 60,\n \"Enabled\": true\n }\n ],\n \"CronHorizontalAutoscaler\": []\n },\n {\n \"AutoscalerId\": \"scaler-b5q33njo\",\n \"AutoscalerName\": \"pk-test-clb\",\n \"MinReplicas\": 0,\n \"MaxReplicas\": 4,\n \"CreateDate\": \"2024-10-25 16:36:10\",\n \"ModifyDate\": \"2024-11-29 10:35:52\",\n \"EnableDate\": \"2024-11-29 10:35:52\",\n \"Description\": \"\",\n \"Enabled\": false,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 4,\n \"Metrics\": \"CPU\",\n \"Threshold\": 0,\n \"DoubleThreshold\": 50,\n \"Enabled\": true\n }\n ],\n \"CronHorizontalAutoscaler\": [\n {\n \"Name\": \"pk-test\",\n \"Period\": \"* * *\",\n \"Schedules\": [\n {\n \"StartAt\": \"02:00\",\n \"TargetReplicas\": 1\n }\n ],\n \"Enabled\": false,\n \"Priority\": 0\n }\n ]\n },\n {\n \"AutoscalerId\": \"scaler-ojr3nlj9\",\n \"AutoscalerName\": \"pk-test-1\",\n \"MinReplicas\": 1,\n \"MaxReplicas\": 3,\n \"CreateDate\": \"2024-12-19 23:38:45\",\n \"ModifyDate\": \"2024-12-19 23:38:45\",\n \"EnableDate\": null,\n \"Description\": \"\",\n \"Enabled\": false,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 1,\n \"MaxReplicas\": 3,\n \"Metrics\": \"CPU\",\n \"Threshold\": 0,\n \"DoubleThreshold\": 50,\n \"Enabled\": true\n }\n ],\n \"CronHorizontalAutoscaler\": [\n {\n \"Name\": \"policy-test\",\n \"Period\": \"* * *\",\n \"Schedules\": [\n {\n \"StartAt\": \"00:00\",\n \"TargetReplicas\": 1\n }\n ],\n \"Enabled\": true,\n \"Priority\": 0\n }\n ]\n }\n ],\n \"ApplicationName\": \"app0925\",\n \"ApplicationDescription\": \"preStop-test\",\n \"EnvironmentName\": \"tt\",\n \"EnvironmentId\": \"en-dpxydze5\",\n \"RepoServer\": \"tem-sh-custom-registry-prd-01.tencentcloudcr.com\",\n \"PublicDomain\": \"\",\n \"EnablePublicAccess\": null,\n \"Modifier\": \"100019051593\",\n \"Creator\": \"100019051593\",\n \"CurrentInstances\": 1,\n \"ExpectedInstances\": 3,\n \"Status\": \"abnormal\",\n \"UnderDeploying\": true,\n \"BatchDeployStatus\": \"\",\n \"CodingLanguage\": \"JAVA\",\n \"ImageType\": 1,\n \"ImageCommand\": \"\",\n \"ImageArgs\": null,\n \"UseRegistryDefaultConfig\": false,\n \"DeployStrategyConf\": null,\n \"Zones\": [\n \"ap-shanghai-2\"\n ],\n \"LastDeployDate\": \"2024-12-20 17:00:17\",\n \"LastDeploySuccessDate\": \"2024-12-20 17:00:17\",\n \"NodeInfos\": [\n {\n \"Name\": \"eklet-subnet-kctzw7nj-711231\",\n \"Zone\": \"ap-shanghai-2\",\n \"SubnetId\": \"subnet-kctzw7nj\",\n \"AvailableIpCount\": \"243\",\n \"Cidr\": \"10.0.10.0-24\"\n },\n {\n \"Name\": \"eklet-subnet-8indzsuv-457482\",\n \"Zone\": \"ap-shanghai-2\",\n \"SubnetId\": \"subnet-8indzsuv\",\n \"AvailableIpCount\": \"226\",\n \"Cidr\": \"10.0.30.0-24\"\n },\n {\n \"Name\": \"eklet-subnet-qau65gm1-638453\",\n \"Zone\": \"ap-shanghai-2\",\n \"SubnetId\": \"subnet-qau65gm1\",\n \"AvailableIpCount\": \"246\",\n \"Cidr\": \"10.0.20.0-24\"\n }\n ],\n \"WorkloadInfo\": {\n \"ApplicationName\": \"app0925\",\n \"ClusterId\": \"cls-kotuimb9\",\n \"VersionName\": \"20241202165113\",\n \"ReadyReplicas\": 1,\n \"Replicas\": 3,\n \"UpdatedReplicas\": 2,\n \"UpdatedReadyReplicas\": 0,\n \"UpdateRevision\": \"app0925-574b65c5f7\",\n \"CurrentRevision\": \"app0925-77969b5b49\"\n },\n \"PodList\": {\n \"Offset\": 0,\n \"Limit\": 3,\n \"TotalCount\": 3,\n \"PodList\": [\n {\n \"Zone\": \"ap-shanghai-2\",\n \"NodeInfo\": {\n \"Name\": \"eklet-subnet-kctzw7nj-711231\",\n \"Zone\": \"ap-shanghai-2\",\n \"SubnetId\": \"subnet-kctzw7nj\",\n \"AvailableIpCount\": \"243\",\n \"Cidr\": \"10.0.10.0-24\"\n },\n \"DeployVersion\": \"\",\n \"RestartCount\": 0,\n \"Ready\": false,\n \"StartTime\": \"2024-12-20T09:01:01Z\",\n \"ContainerState\": \"waiting\",\n \"Unhealthy\": null,\n \"UnhealthyWarningMsg\": \"\",\n \"VersionId\": \"revision-jorxnl6j\",\n \"ApplicationName\": \"app0925\",\n \"Status\": \"CrashLoopBackOff\",\n \"CreateTime\": \"2024-12-20T09:00:23Z\",\n \"PodIp\": \"10.0.10.220\",\n \"Webshell\": \"https://tkecache.cloud.tencent.com/xxxx\",\n \"PodId\": \"app0925-4sbct\"\n },\n {\n \"Zone\": \"ap-shanghai-2\",\n \"NodeInfo\": {\n \"Name\": \"eklet-subnet-qau65gm1-638453\",\n \"Zone\": \"ap-shanghai-2\",\n \"SubnetId\": \"subnet-qau65gm1\",\n \"AvailableIpCount\": \"246\",\n \"Cidr\": \"10.0.20.0-24\"\n },\n \"DeployVersion\": \"\",\n \"RestartCount\": 0,\n \"Ready\": false,\n \"StartTime\": \"2024-12-20T09:01:11Z\",\n \"ContainerState\": \"waiting\",\n \"Unhealthy\": null,\n \"UnhealthyWarningMsg\": \"\",\n \"VersionId\": \"revision-jorxnl6j\",\n \"ApplicationName\": \"app0925\",\n \"Status\": \"CrashLoopBackOff\",\n \"CreateTime\": \"2024-12-20T09:00:23Z\",\n \"PodIp\": \"10.0.20.37\",\n \"Webshell\": \"https://tkecache.cloud.tencent.com/xxxx\",\n \"PodId\": \"app0925-s4vpj\"\n },\n {\n \"Zone\": \"ap-shanghai-2\",\n \"NodeInfo\": {\n \"Name\": \"eklet-subnet-8indzsuv-457482\",\n \"Zone\": \"ap-shanghai-2\",\n \"SubnetId\": \"subnet-8indzsuv\",\n \"AvailableIpCount\": \"226\",\n \"Cidr\": \"10.0.30.0-24\"\n },\n \"DeployVersion\": \"\",\n \"RestartCount\": 0,\n \"Ready\": true,\n \"StartTime\": \"2024-12-19T03:12:44Z\",\n \"ContainerState\": \"running\",\n \"Unhealthy\": null,\n \"UnhealthyWarningMsg\": \"\",\n \"VersionId\": \"revision-57moqvm5\",\n \"ApplicationName\": \"app0925\",\n \"Status\": \"Running\",\n \"CreateTime\": \"2024-12-19T03:11:32Z\",\n \"PodIp\": \"10.0.30.158\",\n \"Webshell\": \"https://tkecache.cloud.tencent.com/qcloud/xxxx\",\n \"PodId\": \"app0925-jt5bn\"\n }\n ],\n \"RequestId\": \"csdse233-xxx-xxx-xxx\"\n },\n \"ConfEdited\": null,\n \"SpeedUp\": true,\n \"OsFlavour\": \"ALPINE\",\n \"StoppedManually\": false,\n \"TcrInstanceId\": \"tcr-d8g5il2x\",\n \"Tags\": [],\n \"PkgName\": \"tem/pkg/1305738457/app-5vaz8x85/1733129495394/K8sEventDemo-1.0.jar\",\n \"HorizontalAutoscaler\": [],\n \"CronHorizontalAutoscaler\": []\n }\n }\n}", "title": "服务基本信息查看" } ], @@ -124,7 +124,7 @@ { "document": "获取应用实例列表", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeApplicationPods\n<公共请求参数>\n\n{\n \"Status\": \"Running\",\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Offset\": 0,\n \"SourceChannel\": 0,\n \"Limit\": 20,\n \"PodName\": \"pod-name-xxx\",\n \"ApplicationId\": \"app-xxxxxx\"\n}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"Offset\": 0,\n \"Limit\": 0,\n \"TotalCount\": 0,\n \"RequestId\": \"abc\",\n \"PodList\": [\n {\n \"Webshell\": \"https://xxx-xxx-xxxx\",\n \"PodId\": \"abc\",\n \"Status\": \"abc\",\n \"CreateTime\": \"abc\",\n \"PodIp\": \"abc\",\n \"Zone\": \"abc\",\n \"DeployVersion\": \"abc\",\n \"RestartCount\": 0,\n \"Ready\": true,\n \"ContainerState\": \"abc\",\n \"NodeInfo\": {\n \"Name\": \"abc\",\n \"Zone\": \"abc\",\n \"SubnetId\": \"abc\",\n \"AvailableIpCount\": \"abc\",\n \"Cidr\": \"abc\"\n },\n \"StartTime\": \"abc\",\n \"Unhealthy\": true,\n \"UnhealthyWarningMsg\": \"abc\",\n \"VersionId\": \"abc\",\n \"ApplicationName\": \"abc\"\n }\n ]\n },\n \"RequestId\": \"xxx-xxx-xxx\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"0f09d0d3-3414-48ba-b8cc-e1c543b1fc1a\",\n \"Result\": {\n \"Offset\": 0,\n \"Limit\": 3,\n \"TotalCount\": 3,\n \"PodList\": [\n {\n \"Zone\": \"ap-shanghai-2\",\n \"NodeInfo\": {\n \"Name\": \"eklet-subnet-kctzw7nj-711231\",\n \"Zone\": \"ap-shanghai-2\",\n \"SubnetId\": \"subnet-kctzw7nj\",\n \"AvailableIpCount\": \"243\",\n \"Cidr\": \"10.0.10.0-24\"\n },\n \"DeployVersion\": \"20241202165113\",\n \"RestartCount\": 0,\n \"Ready\": false,\n \"StartTime\": \"2024-12-20T09:01:01Z\",\n \"ContainerState\": \"waiting\",\n \"Unhealthy\": null,\n \"UnhealthyWarningMsg\": \"\",\n \"VersionId\": \"revision-jorxnl6j\",\n \"ApplicationName\": \"app0925\",\n \"Status\": \"CrashLoopBackOff\",\n \"CreateTime\": \"2024-12-20 17:00:23\",\n \"Webshell\": \"https://tkecache.cloud.tencent.com/xxx\",\n \"PodId\": \"app0925-4sbct\",\n \"PodIp\": \"10.0.10.220\"\n },\n {\n \"Zone\": \"ap-shanghai-2\",\n \"NodeInfo\": {\n \"Name\": \"eklet-subnet-qau65gm1-638453\",\n \"Zone\": \"ap-shanghai-2\",\n \"SubnetId\": \"subnet-qau65gm1\",\n \"AvailableIpCount\": \"246\",\n \"Cidr\": \"10.0.20.0-24\"\n },\n \"DeployVersion\": \"20241202165113\",\n \"RestartCount\": 0,\n \"Ready\": false,\n \"StartTime\": \"2024-12-20T09:01:11Z\",\n \"ContainerState\": \"waiting\",\n \"Unhealthy\": null,\n \"UnhealthyWarningMsg\": \"\",\n \"VersionId\": \"revision-jorxnl6j\",\n \"ApplicationName\": \"app0925\",\n \"Status\": \"CrashLoopBackOff\",\n \"CreateTime\": \"2024-12-20 17:00:23\",\n \"Webshell\": \"https://tkecache.cloud.tencent.com/xxx\",\n \"PodId\": \"app0925-s4vpj\",\n \"PodIp\": \"10.0.20.37\"\n },\n {\n \"Zone\": \"ap-shanghai-2\",\n \"NodeInfo\": {\n \"Name\": \"eklet-subnet-8indzsuv-457482\",\n \"Zone\": \"ap-shanghai-2\",\n \"SubnetId\": \"subnet-8indzsuv\",\n \"AvailableIpCount\": \"226\",\n \"Cidr\": \"10.0.30.0-24\"\n },\n \"DeployVersion\": \"20241202165113\",\n \"RestartCount\": 0,\n \"Ready\": true,\n \"StartTime\": \"2024-12-19T03:12:44Z\",\n \"ContainerState\": \"running\",\n \"Unhealthy\": null,\n \"UnhealthyWarningMsg\": \"\",\n \"VersionId\": \"revision-57moqvm5\",\n \"ApplicationName\": \"app0925\",\n \"Status\": \"Running\",\n \"CreateTime\": \"2024-12-19 11:11:32\",\n \"Webshell\": \"https://tkecache.cloud.tencent.com/xxx\",\n \"PodId\": \"app0925-jt5bn\",\n \"PodIp\": \"10.0.30.158\"\n }\n ],\n \"RequestId\": \"0f09d0d3-xxx-xxx-xxx\"\n }\n }\n}", "title": "获取应用实例列表" } ], @@ -132,7 +132,7 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeApplicationServiceList\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"ApplicationId\": \"app-xxxxxx\",\n \"SourceChannel\": 0\n}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"Name\": \"abc\",\n \"Ports\": [\n 0\n ],\n \"Yaml\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"VersionName\": \"abc\",\n \"ClusterIp\": [\n \"abc\"\n ],\n \"ExternalIp\": \"xx-xx-xx-xx\",\n \"Type\": \"abc\",\n \"SubnetId\": \"abc\",\n \"LoadBalanceId\": \"VPC\",\n \"PortMappings\": [\n {\n \"Port\": 0,\n \"TargetPort\": 0,\n \"Protocol\": \"abc\",\n \"ServiceName\": \"abc\"\n }\n ],\n \"ServicePortMappingList\": [\n {\n \"Type\": \"abc\",\n \"ServiceName\": \"abc\",\n \"ClusterIp\": \"abc\",\n \"ExternalIp\": \"abc\",\n \"SubnetId\": \"abc\",\n \"VpcId\": \"abc\",\n \"LoadBalanceId\": \"abc\",\n \"Yaml\": \"abc\",\n \"Ports\": [\n 0\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 0,\n \"TargetPort\": 0,\n \"Protocol\": \"abc\"\n }\n ],\n \"ExternalDomain\": \"abc\"\n }\n ],\n \"FlushAll\": true,\n \"EnableRegistryNextDeploy\": 0,\n \"ApplicationId\": \"abc\",\n \"AllIpDone\": true,\n \"ExternalDomain\": \"abc\"\n },\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"7003cb9f-0932-4cba-b15a-21788df3a8fb\",\n \"Result\": {\n \"PortMappings\": [],\n \"LoadBalanceId\": \"\",\n \"SubnetId\": \"\",\n \"Type\": \"\",\n \"Name\": \"\",\n \"ApplicationName\": \"app0925\",\n \"ClusterIp\": [],\n \"ExternalIp\": \"\",\n \"ExternalDomain\": \"\",\n \"VersionName\": \"\",\n \"Ports\": [],\n \"Yaml\": \"\",\n \"ApplicationId\": \"app-5vaz8x85\",\n \"ServicePortMappingList\": [\n {\n \"Type\": \"CLUSTER\",\n \"ServiceName\": \"k8s-svc-test\",\n \"ClusterIp\": \"172.16.56.122\",\n \"ExternalIp\": \"\",\n \"ExternalDomain\": \"\",\n \"SubnetId\": \"\",\n \"VpcId\": \"\",\n \"LoadBalanceId\": \"\",\n \"Yaml\": \"apiVersion: xxx\",\n \"Ports\": [\n 8080\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 8080,\n \"TargetPort\": 8080,\n \"Protocol\": \"TCP\"\n }\n ]\n },\n {\n \"Type\": \"CLUSTER\",\n \"ServiceName\": \"pk-svc\",\n \"ClusterIp\": \"172.16.52.35\",\n \"ExternalIp\": \"\",\n \"ExternalDomain\": \"\",\n \"SubnetId\": \"\",\n \"VpcId\": \"\",\n \"LoadBalanceId\": \"\",\n \"Yaml\": \"apiVersion: xxx\",\n \"Ports\": [\n 8080\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 8080,\n \"TargetPort\": 8080,\n \"Protocol\": \"TCP\"\n }\n ]\n }\n ],\n \"FlushAll\": false,\n \"EnableRegistryNextDeploy\": 0,\n \"AllIpDone\": true\n }\n }\n}", "title": "查询应用访问方式列表" } ], @@ -148,7 +148,7 @@ { "document": "单环境下所有应用状态查看", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeApplicationsStatus\n<公共请求参数>\n\n{\n \"SourceChannel\": 0,\n \"EnvironmentId\": \"en-xxxxxx\"\n}", - "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"VersionName\": \"abc\",\n \"Status\": \"abc\",\n \"EnableEs\": 0,\n \"CurrentInstances\": 0,\n \"VersionId\": \"abc\",\n \"LogOutputConf\": {\n \"OutputType\": \"abc\",\n \"ClsLogsetName\": \"abc\",\n \"ClsLogTopicId\": \"abc\",\n \"ClsLogsetId\": \"abc\",\n \"ClsLogTopicName\": \"abc\"\n },\n \"ExpectedInstances\": 0,\n \"DeployMode\": \"abc\",\n \"BuildTaskId\": \"abc\",\n \"EnvironmentId\": \"abc\",\n \"EnvironmentName\": \"abc\",\n \"ApplicationId\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"UnderDeploying\": true,\n \"BatchDeployStatus\": \"abc\",\n \"Zones\": [\n \"abc\"\n ],\n \"NodeInfos\": [\n {\n \"Name\": \"abc\",\n \"Zone\": \"abc\",\n \"SubnetId\": \"abc\",\n \"AvailableIpCount\": \"abc\",\n \"Cidr\": \"abc\"\n }\n ],\n \"PodList\": {\n \"Offset\": 0,\n \"Limit\": 0,\n \"TotalCount\": 0,\n \"RequestId\": \"abc\",\n \"PodList\": [\n {\n \"Webshell\": \"abc\",\n \"PodId\": \"abc\",\n \"Status\": \"abc\",\n \"CreateTime\": \"abc\",\n \"PodIp\": \"abc\",\n \"Zone\": \"abc\",\n \"DeployVersion\": \"abc\",\n \"RestartCount\": 0,\n \"Ready\": true,\n \"ContainerState\": \"abc\",\n \"NodeInfo\": {\n \"Name\": \"abc\",\n \"Zone\": \"abc\",\n \"SubnetId\": \"abc\",\n \"AvailableIpCount\": \"abc\",\n \"Cidr\": \"abc\"\n },\n \"StartTime\": \"abc\",\n \"Unhealthy\": true,\n \"UnhealthyWarningMsg\": \"abc\",\n \"VersionId\": \"abc\",\n \"ApplicationName\": \"abc\"\n }\n ]\n },\n \"WorkloadInfo\": {\n \"ClusterId\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"VersionName\": \"abc\",\n \"ReadyReplicas\": 0,\n \"Replicas\": 0,\n \"UpdatedReplicas\": 0,\n \"UpdatedReadyReplicas\": 0,\n \"UpdateRevision\": \"abc\",\n \"CurrentRevision\": \"abc\"\n },\n \"CreateDate\": \"abc\",\n \"RegionId\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"dda3b8c7-b536-4842-92a2-6756688a337e\",\n \"Result\": [\n {\n \"VersionName\": \"bj\",\n \"VersionId\": \"revision-jbzmeq7j\",\n \"Status\": \"normal\",\n \"BatchDeployStatus\": \"\",\n \"EnableEs\": -1,\n \"LogOutputConf\": null,\n \"ExpectedInstances\": 1,\n \"CurrentInstances\": 1,\n \"DeployMode\": \"JAR\",\n \"BuildTaskId\": \"build-5enzamz5\",\n \"EnvironmentId\": \"en-dpxydml5\",\n \"EnvironmentName\": \"bugfix-bj\",\n \"ApplicationId\": \"app-5vaz8x85\",\n \"ApplicationName\": \"app0925\",\n \"Zones\": [\n \"ap-beijing-3\"\n ],\n \"NodeInfos\": [\n {\n \"Name\": \"eklet-subnet-1ebj4rp9-766511\",\n \"Zone\": \"ap-beijing-3\",\n \"SubnetId\": \"subnet-1ebj4rp9\",\n \"AvailableIpCount\": \"232\",\n \"Cidr\": \"10.0.0.0-24\"\n }\n ],\n \"PodList\": {\n \"Offset\": -1,\n \"Limit\": -1,\n \"TotalCount\": 1,\n \"PodList\": [\n {\n \"Zone\": \"ap-beijing-3\",\n \"NodeInfo\": {\n \"Name\": \"eklet-subnet-1ebj4rp9-766511\",\n \"Zone\": \"ap-beijing-3\",\n \"SubnetId\": \"subnet-1ebj4rp9\",\n \"AvailableIpCount\": \"232\",\n \"Cidr\": \"10.0.0.0-24\"\n },\n \"DeployVersion\": \"\",\n \"RestartCount\": 0,\n \"Ready\": true,\n \"StartTime\": \"2024-09-25T03:39:59Z\",\n \"ContainerState\": \"running\",\n \"Unhealthy\": null,\n \"UnhealthyWarningMsg\": \"\",\n \"VersionId\": \"revision-jbzmeq7j\",\n \"ApplicationName\": \"app0925\",\n \"Status\": \"Running\",\n \"CreateTime\": \"2024-09-25T03:39:08Z\",\n \"Webshell\": \"https://tkecache.cloud.tencent.com/xxx\",\n \"PodId\": \"app0925-p728w\",\n \"PodIp\": \"10.0.0.7\"\n }\n ],\n \"RequestId\": \"\"\n },\n \"WorkloadInfo\": {\n \"ApplicationName\": \"app0925\",\n \"ClusterId\": \"cls-1trz6x5l\",\n \"VersionName\": \"bj\",\n \"ReadyReplicas\": 1,\n \"Replicas\": 1,\n \"UpdatedReplicas\": 1,\n \"UpdatedReadyReplicas\": 1,\n \"UpdateRevision\": \"app0925-868b68987\",\n \"CurrentRevision\": \"app0925-868b68987\"\n },\n \"CreateDate\": null,\n \"UnderDeploying\": false,\n \"RegionId\": \"8\"\n },\n {\n \"VersionName\": \"hello-world\",\n \"VersionId\": \"revision-jordnl7j\",\n \"Status\": \"normal\",\n \"BatchDeployStatus\": \"\",\n \"EnableEs\": -1,\n \"LogOutputConf\": null,\n \"ExpectedInstances\": 1,\n \"CurrentInstances\": 1,\n \"DeployMode\": \"IMAGE\",\n \"BuildTaskId\": \"\",\n \"EnvironmentId\": \"en-dpxydml5\",\n \"EnvironmentName\": \"bugfix-bj\",\n \"ApplicationId\": \"app-57477ag5\",\n \"ApplicationName\": \"bugfix-test\",\n \"Zones\": [\n \"ap-beijing-3\"\n ],\n \"NodeInfos\": [\n {\n \"Name\": \"eklet-subnet-1ebj4rp9-766511\",\n \"Zone\": \"ap-beijing-3\",\n \"SubnetId\": \"subnet-1ebj4rp9\",\n \"AvailableIpCount\": \"232\",\n \"Cidr\": \"10.0.0.0-24\"\n }\n ],\n \"PodList\": {\n \"Offset\": -1,\n \"Limit\": -1,\n \"TotalCount\": 1,\n \"PodList\": [\n {\n \"Zone\": \"ap-beijing-3\",\n \"NodeInfo\": {\n \"Name\": \"eklet-subnet-1ebj4rp9-766511\",\n \"Zone\": \"ap-beijing-3\",\n \"SubnetId\": \"subnet-1ebj4rp9\",\n \"AvailableIpCount\": \"232\",\n \"Cidr\": \"10.0.0.0-24\"\n },\n \"DeployVersion\": \"\",\n \"RestartCount\": 0,\n \"Ready\": true,\n \"StartTime\": \"2024-08-05T08:15:26Z\",\n \"ContainerState\": \"running\",\n \"Unhealthy\": null,\n \"UnhealthyWarningMsg\": \"\",\n \"VersionId\": \"revision-jordnl7j\",\n \"ApplicationName\": \"bugfix-test\",\n \"Status\": \"Running\",\n \"CreateTime\": \"2024-08-05T08:14:28Z\",\n \"Webshell\": \"https://tkecache.cloud.tencent.com/xxx\",\n \"PodId\": \"bugfix-test-lvn56\",\n \"PodIp\": \"10.0.0.16\"\n }\n ],\n \"RequestId\": \"\"\n },\n \"WorkloadInfo\": {\n \"ApplicationName\": \"bugfix-test\",\n \"ClusterId\": \"cls-1trz6x5l\",\n \"VersionName\": \"hello-world\",\n \"ReadyReplicas\": 1,\n \"Replicas\": 1,\n \"UpdatedReplicas\": 1,\n \"UpdatedReadyReplicas\": 1,\n \"UpdateRevision\": \"bugfix-test-648f6b456d\",\n \"CurrentRevision\": \"bugfix-test-648f6b456d\"\n },\n \"CreateDate\": null,\n \"UnderDeploying\": false,\n \"RegionId\": \"8\"\n }\n ]\n }\n}", "title": "单环境下所有应用状态查看" } ], @@ -156,7 +156,7 @@ { "document": "查询配置详情", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigData\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Name\": \"abc-xxxx\",\n \"SourceChannel\": 0\n}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"Name\": \"abc\",\n \"CreateTime\": \"abc\",\n \"RelatedApplications\": [\n {\n \"ApplicationId\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"Description\": \"abc\",\n \"EnvironmentId\": \"abc\",\n \"CreateDate\": \"2020-09-22 00:00:00\",\n \"ModifyDate\": \"2020-09-22 00:00:00\",\n \"Modifier\": \"abc\",\n \"Creator\": \"abc\",\n \"RepoType\": 0,\n \"InstanceId\": \"abc\",\n \"RepoName\": \"abc\",\n \"CodingLanguage\": \"abc\",\n \"DeployMode\": \"abc\",\n \"EnvironmentName\": \"abc\",\n \"ActiveVersions\": [\n {\n \"VersionName\": \"abc\",\n \"Status\": \"abc\",\n \"EnableEs\": 0,\n \"CurrentInstances\": 0,\n \"VersionId\": \"abc\",\n \"LogOutputConf\": {\n \"OutputType\": \"abc\",\n \"ClsLogsetName\": \"abc\",\n \"ClsLogTopicId\": \"abc\",\n \"ClsLogsetId\": \"abc\",\n \"ClsLogTopicName\": \"abc\"\n },\n \"ExpectedInstances\": 0,\n \"DeployMode\": \"abc\",\n \"BuildTaskId\": \"abc\",\n \"EnvironmentId\": \"abc\",\n \"EnvironmentName\": \"abc\",\n \"ApplicationId\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"UnderDeploying\": true,\n \"BatchDeployStatus\": \"abc\",\n \"Zones\": [\n \"abc\"\n ],\n \"NodeInfos\": [\n {\n \"Name\": \"abc\",\n \"Zone\": \"abc\",\n \"SubnetId\": \"abc\",\n \"AvailableIpCount\": \"abc\",\n \"Cidr\": \"abc\"\n }\n ],\n \"PodList\": {\n \"Offset\": 0,\n \"Limit\": 0,\n \"TotalCount\": 0,\n \"RequestId\": \"abc\",\n \"PodList\": [\n {\n \"Webshell\": \"abc\",\n \"PodId\": \"abc\",\n \"Status\": \"abc\",\n \"CreateTime\": \"abc\",\n \"PodIp\": \"abc\",\n \"Zone\": \"abc\",\n \"DeployVersion\": \"abc\",\n \"RestartCount\": 0,\n \"Ready\": true,\n \"ContainerState\": \"abc\",\n \"NodeInfo\": {\n \"Name\": \"abc\",\n \"Zone\": \"abc\",\n \"SubnetId\": \"abc\",\n \"AvailableIpCount\": \"abc\",\n \"Cidr\": \"abc\"\n },\n \"StartTime\": \"abc\",\n \"Unhealthy\": true,\n \"UnhealthyWarningMsg\": \"abc\",\n \"VersionId\": \"abc\",\n \"ApplicationName\": \"abc\"\n }\n ]\n },\n \"WorkloadInfo\": {\n \"ClusterId\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"VersionName\": \"abc\",\n \"ReadyReplicas\": 0,\n \"Replicas\": 0,\n \"UpdatedReplicas\": 0,\n \"UpdatedReadyReplicas\": 0,\n \"UpdateRevision\": \"abc\",\n \"CurrentRevision\": \"abc\"\n },\n \"CreateDate\": \"abc\",\n \"RegionId\": \"abc\"\n }\n ],\n \"EnableTracing\": 1,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"HasAuthority\": true\n }\n ],\n \"Data\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\",\n \"Type\": \"abc\",\n \"Config\": \"abc\",\n \"Secret\": \"abc\"\n }\n ]\n },\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"8b94500c-06cf-42cf-a228-dfea478c3239\",\n \"Result\": {\n \"Name\": \"config-test\",\n \"CreateTime\": \"2024-12-19 23:55:05\",\n \"RelatedApplications\": [],\n \"Data\": [\n {\n \"Key\": \"key-xxx\",\n \"Value\": \"val-xxx\",\n \"Type\": \"\",\n \"Config\": \"\",\n \"Secret\": \"\"\n }\n ]\n }\n }\n}", "title": "查询配置详情" } ], @@ -164,7 +164,7 @@ { "document": "查询配置列表", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigDataList\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"ContinueToken\": \"token-xxxxxx\",\n \"Limit\": 0,\n \"SourceChannel\": 0\n}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"Records\": [\n {\n \"Name\": \"abc\",\n \"CreateTime\": \"abc\",\n \"RelatedApplications\": [\n {\n \"ApplicationId\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"Description\": \"abc\",\n \"EnvironmentId\": \"abc\",\n \"CreateDate\": \"2020-09-22 00:00:00\",\n \"ModifyDate\": \"2020-09-22 00:00:00\",\n \"Modifier\": \"abc\",\n \"Creator\": \"abc\",\n \"RepoType\": 0,\n \"InstanceId\": \"abc\",\n \"RepoName\": \"abc\",\n \"CodingLanguage\": \"abc\",\n \"DeployMode\": \"abc\",\n \"EnvironmentName\": \"abc\",\n \"ActiveVersions\": [\n {\n \"VersionName\": \"abc\",\n \"Status\": \"abc\",\n \"EnableEs\": 0,\n \"CurrentInstances\": 0,\n \"VersionId\": \"abc\",\n \"LogOutputConf\": {\n \"OutputType\": \"abc\",\n \"ClsLogsetName\": \"abc\",\n \"ClsLogTopicId\": \"abc\",\n \"ClsLogsetId\": \"abc\",\n \"ClsLogTopicName\": \"abc\"\n },\n \"ExpectedInstances\": 0,\n \"DeployMode\": \"abc\",\n \"BuildTaskId\": \"abc\",\n \"EnvironmentId\": \"abc\",\n \"EnvironmentName\": \"abc\",\n \"ApplicationId\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"UnderDeploying\": true,\n \"BatchDeployStatus\": \"abc\",\n \"Zones\": [\n \"abc\"\n ],\n \"NodeInfos\": [\n {\n \"Name\": \"abc\",\n \"Zone\": \"abc\",\n \"SubnetId\": \"abc\",\n \"AvailableIpCount\": \"abc\",\n \"Cidr\": \"abc\"\n }\n ],\n \"PodList\": {\n \"Offset\": 0,\n \"Limit\": 0,\n \"TotalCount\": 0,\n \"RequestId\": \"abc\",\n \"PodList\": [\n {\n \"Webshell\": \"abc\",\n \"PodId\": \"abc\",\n \"Status\": \"abc\",\n \"CreateTime\": \"abc\",\n \"PodIp\": \"abc\",\n \"Zone\": \"abc\",\n \"DeployVersion\": \"abc\",\n \"RestartCount\": 0,\n \"Ready\": true,\n \"ContainerState\": \"abc\",\n \"NodeInfo\": {\n \"Name\": \"abc\",\n \"Zone\": \"abc\",\n \"SubnetId\": \"abc\",\n \"AvailableIpCount\": \"abc\",\n \"Cidr\": \"abc\"\n },\n \"StartTime\": \"abc\",\n \"Unhealthy\": true,\n \"UnhealthyWarningMsg\": \"abc\",\n \"VersionId\": \"abc\",\n \"ApplicationName\": \"abc\"\n }\n ]\n },\n \"WorkloadInfo\": {\n \"ClusterId\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"VersionName\": \"abc\",\n \"ReadyReplicas\": 0,\n \"Replicas\": 0,\n \"UpdatedReplicas\": 0,\n \"UpdatedReadyReplicas\": 0,\n \"UpdateRevision\": \"abc\",\n \"CurrentRevision\": \"abc\"\n },\n \"CreateDate\": \"abc\",\n \"RegionId\": \"abc\"\n }\n ],\n \"EnableTracing\": 1,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"HasAuthority\": true\n }\n ],\n \"Data\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\",\n \"Type\": \"abc\",\n \"Config\": \"abc\",\n \"Secret\": \"abc\"\n }\n ]\n }\n ],\n \"ContinueToken\": \"abc\",\n \"RemainingCount\": 0\n },\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"8b94500c-06cf-42cf-a228-dfea478c3239\",\n \"Result\": {\n \"Records\": [\n {\n \"Name\": \"config-test\",\n \"CreateTime\": \"2024-12-19 23:55:05\",\n \"RelatedApplications\": [],\n \"Data\": [\n {\n \"Key\": \"key-xxx\",\n \"Value\": \"val-xxx\",\n \"Type\": \"\",\n \"Config\": \"\",\n \"Secret\": \"\"\n }\n ]\n },\n {\n \"Name\": \"pk-test\",\n \"CreateTime\": \"2024-12-19 11:04:13\",\n \"RelatedApplications\": [],\n \"Data\": [\n {\n \"Key\": \"name\",\n \"Value\": \"pk\",\n \"Type\": \"\",\n \"Config\": \"\",\n \"Secret\": \"\"\n }\n ]\n }\n ],\n \"RemainingCount\": null,\n \"ContinueToken\": \"\"\n }\n }\n}", "title": "查询配置列表" } ], @@ -172,7 +172,7 @@ { "document": "获取分批发布详情", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDeployApplicationDetail\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-xxxxxx\",\n \"EnvironmentId\": \"en-xxxxxx\",\n \"VersionId\": \"version-xxx\"\n}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"DeployStrategyConf\": {\n \"TotalBatchCount\": 0,\n \"BetaBatchNum\": 0,\n \"DeployStrategyType\": 0,\n \"BatchInterval\": 0,\n \"MinAvailable\": 0,\n \"Force\": true\n },\n \"StartTime\": \"abc\",\n \"EndTime\": \"abc\",\n \"Status\": \"abc\",\n \"BetaBatchDetail\": {\n \"OldPodList\": {\n \"PodId\": \"abc\",\n \"PodStatus\": [\n \"abc\"\n ],\n \"PodVersion\": \"abc\",\n \"CreateTime\": \"abc\",\n \"Zone\": \"abc\",\n \"Webshell\": \"abc\",\n \"Status\": \"abc\"\n },\n \"NewPodList\": {\n \"PodId\": \"abc\",\n \"PodStatus\": [\n \"abc\"\n ],\n \"PodVersion\": \"abc\",\n \"CreateTime\": \"abc\",\n \"Zone\": \"abc\",\n \"Webshell\": \"abc\",\n \"Status\": \"abc\"\n },\n \"BatchStatus\": \"abc\",\n \"PodNum\": 0,\n \"BatchIndex\": 0,\n \"OldPods\": [\n {\n \"PodId\": \"abc\",\n \"PodStatus\": [\n \"abc\"\n ],\n \"PodVersion\": \"abc\",\n \"CreateTime\": \"abc\",\n \"Zone\": \"abc\",\n \"Webshell\": \"abc\",\n \"Status\": \"abc\"\n }\n ],\n \"NextBatchStartTime\": 0\n },\n \"OtherBatchDetail\": [\n {\n \"BatchStatus\": \"abc\",\n \"PodNum\": 0,\n \"BatchIndex\": 0,\n \"NextBatchStartTime\": 0\n }\n ],\n \"OldVersionPodList\": {\n \"Offset\": 0,\n \"Limit\": 0,\n \"TotalCount\": 0,\n \"RequestId\": \"abc\",\n \"PodList\": [\n {\n \"Webshell\": \"abc\",\n \"PodId\": \"abc\",\n \"Status\": \"abc\",\n \"CreateTime\": \"abc\",\n \"PodIp\": \"abc\",\n \"Zone\": \"abc\",\n \"DeployVersion\": \"abc\",\n \"RestartCount\": 0,\n \"Ready\": true,\n \"ContainerState\": \"abc\",\n \"NodeInfo\": {\n \"Name\": \"abc\",\n \"Zone\": \"abc\",\n \"SubnetId\": \"abc\",\n \"AvailableIpCount\": \"abc\",\n \"Cidr\": \"abc\"\n },\n \"StartTime\": \"abc\",\n \"Unhealthy\": true,\n \"UnhealthyWarningMsg\": \"abc\",\n \"VersionId\": \"abc\",\n \"ApplicationName\": \"abc\"\n }\n ]\n },\n \"CurrentBatchIndex\": 0,\n \"ErrorMessage\": \"abc\",\n \"CurrentBatchStatus\": \"abc\",\n \"NewDeployVersion\": \"abc\",\n \"OldDeployVersion\": \"abc\",\n \"NewVersionPackageInfo\": \"abc\",\n \"NextBatchStartTime\": 0\n },\n \"RequestId\": \"abc-xxx-xxx\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"7559e31e-4e32-476d-93f2-db6bcbab530a\",\n \"Result\": {\n \"DeployStrategyConf\": {\n \"TotalBatchCount\": 1,\n \"BetaBatchNum\": 0,\n \"DeployStrategyType\": 3,\n \"BatchInterval\": 0,\n \"MinAvailable\": 1,\n \"Force\": true\n },\n \"StartTime\": \"2024-12-20 17:00:17\",\n \"EndTime\": \"\",\n \"Status\": \"Error\",\n \"CurrentBatchStatus\": \"Finish\",\n \"ErrorMessage\": \"\",\n \"BetaBatchDetail\": null,\n \"OtherBatchDetail\": [\n {\n \"OldPods\": [],\n \"NewPods\": [\n {\n \"PodId\": \"app0925-4sbct\",\n \"PodVersion\": \"\",\n \"CreateTime\": \"2024-12-20 17:00:23\",\n \"Zone\": \"ap-shanghai-2\",\n \"Webshell\": \"https://tkecache.cloud.tencent.com/xxx\",\n \"Status\": \"CrashLoopBackOff\",\n \"PodStatus\": [\n \"CrashLoopBackOff\"\n ]\n },\n {\n \"PodId\": \"app0925-s4vpj\",\n \"PodVersion\": \"\",\n \"CreateTime\": \"2024-12-20 17:00:23\",\n \"Zone\": \"ap-shanghai-2\",\n \"Webshell\": \"https://tkecache.cloud.tencent.com/xxx\",\n \"Status\": \"CrashLoopBackOff\",\n \"PodStatus\": [\n \"CrashLoopBackOff\"\n ]\n }\n ],\n \"BatchStatus\": \"Finish\",\n \"PodNum\": 3,\n \"BatchIndex\": 0,\n \"NextBatchStartTime\": 0,\n \"OldPodList\": null,\n \"NewPodList\": null\n }\n ],\n \"OldVersionPodList\": {\n \"Offset\": 0,\n \"Limit\": 1,\n \"TotalCount\": 1,\n \"PodList\": [\n {\n \"Zone\": \"ap-shanghai-2\",\n \"NodeInfo\": {\n \"Name\": \"eklet-subnet-8indzsuv-457482\",\n \"Zone\": \"ap-shanghai-2\",\n \"SubnetId\": \"subnet-8indzsuv\",\n \"AvailableIpCount\": \"226\",\n \"Cidr\": \"10.0.30.0-24\"\n },\n \"DeployVersion\": \"20241202165113\",\n \"RestartCount\": 0,\n \"Ready\": true,\n \"StartTime\": \"2024-12-19T03:12:44Z\",\n \"ContainerState\": \"running\",\n \"Unhealthy\": null,\n \"UnhealthyWarningMsg\": \"\",\n \"VersionId\": \"revision-57moqvm5\",\n \"ApplicationName\": \"app0925\",\n \"Status\": \"Running\",\n \"CreateTime\": \"2024-12-19 11:11:32\",\n \"Webshell\": \"https://tkecache.cloud.tencent.com/xxx\",\n \"PodId\": \"app0925-jt5bn\",\n \"PodIp\": \"10.0.30.158\"\n }\n ],\n \"RequestId\": \"\"\n },\n \"CurrentBatchIndex\": 0,\n \"NewVersionPackageInfo\": \"K8sEventDemo-1.0.jar\",\n \"NewDeployVersion\": \"20241202165113\",\n \"OldDeployVersion\": \"20241202165113\",\n \"NextBatchStartTime\": null\n }\n }\n}", "title": "获取分批发布详情" } ], @@ -180,7 +180,7 @@ { "document": "获取环境状态", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeEnvironment\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"SourceChannel\": 0\n}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"EnvironmentId\": \"en-xxxxxx\",\n \"NamespaceName\": \"abc\",\n \"Region\": \"ap-shanghai\",\n \"VpcId\": \"vpc-xxxxxx\",\n \"SubnetIds\": [\n \"subnet-xxxxxx\"\n ],\n \"Description\": \"abc\",\n \"CreatedDate\": \"abc\",\n \"EnvironmentName\": \"abc\",\n \"ApmInstanceId\": \"abc\",\n \"Locked\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"EnvType\": \"abc\"\n },\n \"RequestId\": \"abc-xxx-xxx\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"85435f86-a454-4bf8-8e8c-074a51f55bb2\",\n \"Result\": {\n \"EnvironmentId\": \"en-l5mmxey5\",\n \"EnvironmentName\": \"bugfix-gz\",\n \"Region\": \"ap-guangzhou\",\n \"VpcId\": \"vpc-9xcgo41t\",\n \"SubnetIds\": [\n \"subnet-orcy48cy\"\n ],\n \"Description\": \"这是一个描述\",\n \"CreatedDate\": \"2024-07-01 17:48:35\",\n \"ApmInstanceId\": \"\",\n \"Locked\": 0,\n \"NamespaceName\": \"\",\n \"Tags\": [],\n \"EnvType\": \"prod\"\n }\n }\n}", "title": "获取环境状态" } ], @@ -188,7 +188,7 @@ { "document": "获取环境状态", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeEnvironmentStatus\n<公共请求参数>\n\n{\n \"EnvironmentIds\": [\n \"en-xxxxxx\"\n ],\n \"SourceChannel\": 0\n}", - "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"EnvironmentId\": \"en-xxxxxx\",\n \"EnvironmentName\": \"abc\",\n \"ClusterId\": \"cls-xxxxxx\",\n \"ClusterStatus\": \"running\",\n \"EnvironmentStartingStatus\": {\n \"ApplicationNumNeedToStart\": 0,\n \"StartedApplicationNum\": 0,\n \"StartFailedApplicationNum\": 0\n },\n \"EnvironmentStoppingStatus\": {\n \"ApplicationNumNeedToStop\": 0,\n \"StoppedApplicationNum\": 0,\n \"StopFailedApplicationNum\": 0\n }\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"EnvironmentId\": \"en-xxxxxx\",\n \"EnvironmentName\": \"en-name-xxx\",\n \"ClusterId\": \"cls-xxxxxx\",\n \"ClusterStatus\": \"running\",\n \"EnvironmentStartingStatus\": {\n \"ApplicationNumNeedToStart\": 0,\n \"StartedApplicationNum\": 0,\n \"StartFailedApplicationNum\": 0\n },\n \"EnvironmentStoppingStatus\": {\n \"ApplicationNumNeedToStop\": 0,\n \"StoppedApplicationNum\": 0,\n \"StopFailedApplicationNum\": 0\n }\n }\n ],\n \"RequestId\": \"1se3sd-xxx-xxx-xxx\"\n }\n}", "title": "获取环境状态" } ], @@ -196,7 +196,7 @@ { "document": "获取环境列表", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeEnvironments\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"Records\": [\n {\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Channel\": \"0\",\n \"EnvironmentName\": \"abc\",\n \"Region\": \"ap-shanghai\",\n \"Description\": \"abc\",\n \"Status\": 0,\n \"Vpc\": \"vpc-xxxxxx\",\n \"CreateDate\": \"abc\",\n \"ModifyDate\": \"abc\",\n \"Modifier\": \"abc\",\n \"Creator\": \"abc\",\n \"ApplicationNum\": 0,\n \"RunInstancesNum\": 0,\n \"SubnetId\": \"abc\",\n \"ClusterStatus\": \"abc\",\n \"EnableTswTraceService\": true,\n \"Locked\": 0,\n \"AppId\": \"abc\",\n \"Uin\": \"abc\",\n \"SubAccountUin\": \"abc\",\n \"ClusterId\": \"abc\",\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"HasAuthority\": true,\n \"EnvType\": \"abc\",\n \"RegionId\": \"abc\"\n }\n ],\n \"Total\": 0,\n \"Size\": 0,\n \"Pages\": 0,\n \"Current\": 0\n },\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"a438e9af-34a0-47d8-bdfc-fc42f652ad6f\",\n \"Result\": {\n \"Pages\": 1,\n \"Records\": [\n {\n \"EnvironmentId\": \"en-xxxxxx\",\n \"AppId\": \"130573xxx\",\n \"ApplicationNum\": 0,\n \"RunInstancesNum\": 0,\n \"Uin\": \"10001905xxx\",\n \"SubAccountUin\": \"100000799xxx\",\n \"EnvironmentName\": \"test-cluster\",\n \"Region\": \"ap-guangzhou\",\n \"RegionId\": \"1\",\n \"Description\": \"\",\n \"ClusterId\": \"cls-qtqz9mxx\",\n \"ClusterStatus\": \"NORMAL\",\n \"Vpc\": \"vpc-3le4yaxx\",\n \"SubnetId\": \"subnet-pm9fq4xx\",\n \"CreateDate\": \"2024-11-07 16:57:21\",\n \"ModifyDate\": \"2024-11-07 16:57:21\",\n \"Modifier\": \"100019051593\",\n \"Creator\": \"100019051593\",\n \"Locked\": 0,\n \"Channel\": \"\",\n \"Status\": 1,\n \"EnableTswTraceService\": false,\n \"Tags\": [],\n \"EnvType\": \"prod\",\n \"HasAuthority\": true\n }\n ],\n \"Total\": 1,\n \"Size\": 20,\n \"Current\": 1\n }\n }\n}", "title": "获取环境列表" } ], @@ -204,7 +204,7 @@ { "document": "查询 Ingress 规则", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeIngress\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"ClusterNamespace\": \"default\",\n \"SourceChannel\": 0,\n \"IngressName\": \"name-xxx\"\n}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"EnvironmentId\": \"en-xxxxxx\",\n \"AddressIPVersion\": \"abc\",\n \"IngressName\": \"abc-xxx\",\n \"Rules\": [\n {\n \"Host\": \"abc\",\n \"Http\": {\n \"Paths\": [\n {\n \"Path\": \"abc\",\n \"Backend\": {\n \"ServiceName\": \"abc\",\n \"ServicePort\": 0\n }\n }\n ]\n },\n \"Protocol\": \"abc\"\n }\n ],\n \"ClbId\": \"lb-xxx\",\n \"ClusterNamespace\": \"default\",\n \"Tls\": [\n {\n \"Hosts\": [\n \"abc\"\n ],\n \"SecretName\": \"abc\",\n \"CertificateId\": \"abc\"\n }\n ],\n \"ClusterId\": \"abc\",\n \"Vip\": \"abc\",\n \"CreateTime\": \"abc\",\n \"Mixed\": true,\n \"RewriteType\": \"abc\",\n \"Domain\": \"abc\"\n },\n \"RequestId\": \"abc-xxx-xxx\"\n }\n}", + "output": "{\n \"Response\": {\n \"Result\": {\n \"EnvironmentId\": \"en-xxxxxx\",\n \"AddressIPVersion\": \"IPV4\",\n \"IngressName\": \"ingress-name-xxx\",\n \"Rules\": [\n {\n \"Host\": \"11.xx.xx.xx\",\n \"Http\": {\n \"Paths\": [\n {\n \"Path\": \"/path\",\n \"Backend\": {\n \"ServiceName\": \"svc-name-xxx\",\n \"ServicePort\": 8080\n }\n }\n ]\n },\n \"Protocol\": \"TCP\"\n }\n ],\n \"ClbId\": \"lb-xxx\",\n \"ClusterNamespace\": \"default\",\n \"Tls\": [\n {\n \"Hosts\": [\n \"11.xx.xx.xx\"\n ],\n \"SecretName\": \"secret-name-xxx\",\n \"CertificateId\": \"certId-xxx\"\n }\n ],\n \"ClusterId\": \"cls-xxxxxx\",\n \"Vip\": \"11.xx.xx.xx\",\n \"CreateTime\": \"2024-12-04 20:46:29\",\n \"Mixed\": true,\n \"RewriteType\": \"AUTO\",\n \"Domain\": \"\"\n },\n \"RequestId\": \"abc-xxx-xxx-xxx\"\n }\n}", "title": "查询 Ingress 规则" } ], @@ -212,23 +212,23 @@ { "document": "查询 Ingress 规则列表", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeIngresses\n<公共请求参数>\n\n{\n \"ClusterNamespace\": \"default\",\n \"EnvironmentId\": \"en-xxxxxx\",\n \"IngressNames\": [\n \"ingress-name\"\n ],\n \"SourceChannel\": 0\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": [\n {\n \"ClusterId\": \"abc\",\n \"EnvironmentId\": \"abc\",\n \"IngressName\": \"abc\",\n \"ClusterNamespace\": \"default\",\n \"AddressIPVersion\": \"IPV4\",\n \"ClbId\": \"clb-xxxx\",\n \"Vip\": \"abc\",\n \"Rules\": [\n {\n \"Host\": \"\",\n \"Http\": {\n \"Paths\": [\n {\n \"Path\": \"/\",\n \"Backend\": {\n \"ServiceName\": \"kubernetes\",\n \"ServicePort\": 443\n }\n }\n ]\n }\n }\n ],\n \"Tls\": [\n {\n \"Hosts\": [\n \"xxx.com\"\n ],\n \"SecretName\": \"xxx\"\n }\n ],\n \"CreateTime\": \"abc\",\n \"Mixed\": true,\n \"RewriteType\": \"abc\",\n \"Domain\": \"abc\"\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": [\n {\n \"ClusterId\": \"cls-xxxxxx\",\n \"EnvironmentId\": \"en-xxxxxx\",\n \"IngressName\": \"ingress-name-xxx\",\n \"ClusterNamespace\": \"default\",\n \"AddressIPVersion\": \"IPV4\",\n \"ClbId\": \"clb-xxxx\",\n \"Vip\": \"10.xx.xx.xx\",\n \"Rules\": [\n {\n \"Host\": \"\",\n \"Http\": {\n \"Paths\": [\n {\n \"Path\": \"/path\",\n \"Backend\": {\n \"ServiceName\": \"kubernetes\",\n \"ServicePort\": 443\n }\n }\n ]\n }\n }\n ],\n \"Tls\": [\n {\n \"Hosts\": [\n \"xxx.com\"\n ],\n \"SecretName\": \"secret-name-xxx\"\n }\n ],\n \"CreateTime\": \"2024-12-04 20:46:29\",\n \"Mixed\": true,\n \"RewriteType\": \"AUTO\",\n \"Domain\": \"xxx.xxx.com\"\n }\n ]\n }\n}", "title": "查询 Ingress 规则列表" } ], "DescribeLogConfig": [ { "document": "查询日志收集配置详情", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLogConfig\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Name\": \"abc\",\n \"ApplicationId\": \"app-xxxxxx\"\n}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"Name\": \"abc\",\n \"InputType\": \"abc\",\n \"LogsetId\": \"abc\",\n \"TopicId\": \"abc\",\n \"LogType\": \"abc\",\n \"BeginningRegex\": \"abc\",\n \"LogPath\": \"abc\",\n \"FilePattern\": \"abc\",\n \"CreateDate\": \"abc\",\n \"ModifyDate\": \"abc\",\n \"ApplicationId\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"ExtractRule\": {\n \"BeginningRegex\": \"abc\",\n \"Keys\": [\n \"abc\"\n ],\n \"FilterKeys\": [\n \"abc\"\n ],\n \"FilterRegex\": [\n \"abc\"\n ],\n \"LogRegex\": \"abc\",\n \"TimeKey\": \"abc\",\n \"TimeFormat\": \"abc\",\n \"UnMatchUpload\": \"abc\",\n \"UnMatchedKey\": \"abc\",\n \"Backtracking\": \"abc\",\n \"Delimiter\": \"abc\"\n }\n },\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLogConfig\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Name\": \"log-name-xxx\",\n \"ApplicationId\": \"app-xxxxxx\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"e6fedfb8-1bc9-414d-b69b-5e24fdda6416\",\n \"Result\": {\n \"Name\": \"log-name-xxx\",\n \"ApplicationName\": \"app-name-xxx\",\n \"ApplicationId\": \"\",\n \"InputType\": \"container_stdout\",\n \"TopicId\": \"3ae33b64-d3d1-4a2c-96ff-a2e044dcexxx\",\n \"LogsetId\": \"5bf3beeb-1f64-40f9-9672-b596248d7xxx\",\n \"LogType\": \"minimalist_log\",\n \"BeginningRegex\": \"\",\n \"ExtractRule\": {\n \"Backtracking\": \"-1\",\n \"BeginningRegex\": \"\",\n \"Delimiter\": \"\",\n \"FilterKeys\": [],\n \"FilterRegex\": [],\n \"Keys\": [],\n \"LogRegex\": \"\",\n \"TimeFormat\": \"\",\n \"TimeKey\": \"\",\n \"UnMatchUpload\": \"false\",\n \"UnMatchedKey\": \"\"\n },\n \"LogPath\": \"\",\n \"FilePattern\": \"\",\n \"CreateDate\": \"2022-05-28T18:02:55.000+08:00\",\n \"ModifyDate\": \"2022-05-28T18:02:56.000+08:00\"\n }\n }\n}", "title": "查询日志收集配置详情" } ], "DescribePagedLogConfigList": [ { "document": "查询分页的日志收集配置列表", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePagedLogConfigList\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"ApplicationId\": \"app-xxxxxx\",\n \"ApplicationName\": \"abc\",\n \"Name\": \"abc\",\n \"Limit\": 0,\n \"ContinueToken\": \"some-token-value\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"0793bb3c-6de8-4816-9ab0-5f006cf7656c\",\n \"Result\": {\n \"ContinueToken\": \"\",\n \"Records\": [\n {\n \"ApplicationId\": \"app-5vaz8x85\",\n \"ApplicationName\": \"app0925\",\n \"BeginningRegex\": \"\",\n \"CreateDate\": \"2024-10-31T15:25:07.000+08:00\",\n \"ExtractRule\": {\n \"Backtracking\": \"\",\n \"BeginningRegex\": \"\",\n \"Delimiter\": \"\",\n \"FilterKeys\": [],\n \"FilterRegex\": [],\n \"Keys\": [],\n \"LogRegex\": \"\",\n \"TimeFormat\": \"\",\n \"TimeKey\": \"\",\n \"UnMatchUpload\": \"true\",\n \"UnMatchedKey\": \"LogParseFailure\"\n },\n \"FilePattern\": \"\",\n \"InputType\": \"container_stdout\",\n \"LogPath\": \"\",\n \"LogType\": \"\",\n \"LogsetId\": \"7a126551-62d1-4e12-b426-84bd5b2fdbca\",\n \"ModifyDate\": \"2024-10-31T15:25:08.000+08:00\",\n \"Name\": \"test\",\n \"TopicId\": \"6c69fdb7-5e4c-4e52-8437-32c2c729b85a\"\n }\n ]\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePagedLogConfigList\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"ApplicationId\": \"app-xxxxxx\",\n \"ApplicationName\": \"name-xxx\",\n \"Name\": \"name-xxx\",\n \"Limit\": 0,\n \"ContinueToken\": \"some-token-value\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"0793bb3c-6de8-4816-9ab0-5f006cf7656c\",\n \"Result\": {\n \"ContinueToken\": \"\",\n \"Records\": [\n {\n \"ApplicationId\": \"app-5vaz8x85\",\n \"ApplicationName\": \"app0925\",\n \"BeginningRegex\": \"\",\n \"CreateDate\": \"2024-10-31T15:25:07.000+08:00\",\n \"ExtractRule\": {\n \"Backtracking\": \"\",\n \"BeginningRegex\": \"\",\n \"Delimiter\": \"\",\n \"FilterKeys\": [],\n \"FilterRegex\": [],\n \"Keys\": [],\n \"LogRegex\": \"\",\n \"TimeFormat\": \"\",\n \"TimeKey\": \"\",\n \"UnMatchUpload\": \"true\",\n \"UnMatchedKey\": \"LogParseFailure\"\n },\n \"FilePattern\": \"\",\n \"InputType\": \"container_stdout\",\n \"LogPath\": \"\",\n \"LogType\": \"\",\n \"LogsetId\": \"7a126551-62d1-4e12-b426-84bd5b2fdxxx\",\n \"ModifyDate\": \"2024-10-31T15:25:08.000+08:00\",\n \"Name\": \"test\",\n \"TopicId\": \"6c69fdb7-5e4c-4e52-8437-32c2c729b85a\"\n }\n ]\n }\n }\n}", "title": "查询分页的日志收集配置列表" } ], @@ -236,7 +236,7 @@ { "document": "查询应用关联的 Ingress 规则列表", "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRelatedIngresses\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"ClusterNamespace\": \"default\",\n \"ApplicationId\": \"app-xxxxxx\",\n \"SourceChannel\": 0\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": [\n {\n \"ClusterId\": \"abc\",\n \"IngressName\": \"abc\",\n \"ClusterNamespace\": \"default\",\n \"EnvironmentId\": \"en-xxxxxx\",\n \"AddressIPVersion\": \"IPV4\",\n \"ClbId\": \"clb-xxxx\",\n \"Vip\": \"abc\",\n \"Mixed\": true,\n \"Rules\": [\n {\n \"Host\": \"\",\n \"Http\": {\n \"Paths\": [\n {\n \"Path\": \"/\",\n \"Backend\": {\n \"ServiceName\": \"kubernetes\",\n \"ServicePort\": 443\n }\n }\n ]\n }\n }\n ],\n \"Tls\": [\n {\n \"Hosts\": [\n \"xxx.com\"\n ],\n \"SecretName\": \"xxx\"\n }\n ],\n \"CreateTime\": \"abc\",\n \"RewriteType\": \"abc\",\n \"Domain\": \"abc\"\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": [\n {\n \"ClusterId\": \"cls-xxxxxx\",\n \"IngressName\": \"ingress-name-xxx\",\n \"ClusterNamespace\": \"default\",\n \"EnvironmentId\": \"en-xxxxxx\",\n \"AddressIPVersion\": \"IPV4\",\n \"ClbId\": \"clb-xxxx\",\n \"Vip\": \"10.xx.xx.xx\",\n \"Mixed\": true,\n \"Rules\": [\n {\n \"Host\": \"\",\n \"Http\": {\n \"Paths\": [\n {\n \"Path\": \"/path\",\n \"Backend\": {\n \"ServiceName\": \"svc-name-xxx\",\n \"ServicePort\": 443\n }\n }\n ]\n }\n }\n ],\n \"Tls\": [\n {\n \"Hosts\": [\n \"xxx.com\"\n ],\n \"SecretName\": \"secret-name-xxx\"\n }\n ],\n \"CreateTime\": \"2024-12-04 20:46:29\",\n \"RewriteType\": \"AUTO\",\n \"Domain\": \"xxx.xxx.com\"\n }\n ]\n }\n}", "title": "查询应用关联的 Ingress 规则列表" } ], @@ -259,7 +259,7 @@ "DestroyLogConfig": [ { "document": "销毁日志收集配置", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DestroyLogConfig\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Name\": \"abc\",\n \"ApplicationId\": \"app-xxxxxx\"\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DestroyLogConfig\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Name\": \"name-xxx\",\n \"ApplicationId\": \"app-xxxxxx\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": true\n }\n}", "title": "销毁日志收集配置" } @@ -291,16 +291,16 @@ "ModifyApplicationAutoscaler": [ { "document": "修改弹性伸缩策略组合", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyApplicationAutoscaler\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-xxxxxx\",\n \"SourceChannel\": 0,\n \"EnvironmentId\": \"en-xxxxxx\",\n \"AutoscalerId\": \"scaler-xxxxxx\",\n \"Autoscaler\": {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 0,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 0,\n \"Metrics\": \"abc\",\n \"Threshold\": 0,\n \"Enabled\": true,\n \"DoubleThreshold\": 0\n }\n ],\n \"CronHorizontalAutoscaler\": [\n {\n \"Name\": \"abc\",\n \"Period\": \"abc\",\n \"Schedules\": [\n {\n \"StartAt\": \"abc\",\n \"TargetReplicas\": 0\n }\n ],\n \"Enabled\": true,\n \"Priority\": 0\n }\n ],\n \"AutoscalerId\": \"abc\",\n \"AutoscalerName\": \"abc\",\n \"Description\": \"abc\",\n \"CreateDate\": \"abc\",\n \"ModifyDate\": \"abc\",\n \"EnableDate\": \"abc\",\n \"Enabled\": true\n }\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyApplicationAutoscaler\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-xxxxxx\",\n \"EnvironmentId\": \"en-xxxxxx\",\n \"AutoscalerId\": \"scaler-xxxxxx\",\n \"Autoscaler\": {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 4,\n \"AutoscalerName\": \"pk-test-clb\",\n \"Description\": \"\",\n \"Enabled\": false,\n \"HorizontalAutoscaler\": [\n {\n \"MinReplicas\": 0,\n \"MaxReplicas\": 4,\n \"Metrics\": \"CPU\",\n \"DoubleThreshold\": 50,\n \"Enabled\": true\n }\n ],\n \"CronHorizontalAutoscaler\": [\n {\n \"Name\": \"pk-test\",\n \"Period\": \"* * *\",\n \"Schedules\": [\n {\n \"StartAt\": \"02:00\",\n \"TargetReplicas\": 1\n }\n ],\n \"Enabled\": false,\n \"Priority\": 0\n }\n ]\n }\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abbd6b63-xxx-xxx-xxx\"\n }\n}", "title": "修改弹性伸缩策略组合" } ], "ModifyApplicationInfo": [ { "document": "修改应用基本信息", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyApplicationInfo\n<公共请求参数>\n\n{\n \"SourceChannel\": 0,\n \"ApplicationId\": \"app-xxxxxx\",\n \"Description\": \"test\",\n \"EnableTracing\": 1\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"true\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyApplicationInfo\n<公共请求参数>\n\n{\n \"SourceChannel\": 0,\n \"ApplicationId\": \"app-xxxxxx\",\n \"Description\": \"这是一个描述\",\n \"EnableTracing\": 1\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"1dew34d-xxx-xxx-xxx\"\n }\n}", "title": "修改应用基本信息" } ], @@ -315,15 +315,15 @@ "ModifyApplicationService": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyApplicationService\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-xxxxxx\",\n \"SourceChannel\": 0,\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Service\": {\n \"Name\": \"abc\",\n \"Ports\": [\n 0\n ],\n \"Yaml\": \"abc\",\n \"ApplicationName\": \"abc\",\n \"VersionName\": \"abc\",\n \"ClusterIp\": [\n \"abc\"\n ],\n \"ExternalIp\": \"abc\",\n \"Type\": \"abc\",\n \"SubnetId\": \"abc\",\n \"LoadBalanceId\": \"abc\",\n \"PortMappings\": [\n {\n \"Port\": 0,\n \"TargetPort\": 0,\n \"Protocol\": \"abc\",\n \"ServiceName\": \"abc\"\n }\n ],\n \"ServicePortMappingList\": [\n {\n \"Type\": \"abc\",\n \"ServiceName\": \"abc\",\n \"ClusterIp\": \"abc\",\n \"ExternalIp\": \"abc\",\n \"SubnetId\": \"abc\",\n \"VpcId\": \"abc\",\n \"LoadBalanceId\": \"abc\",\n \"Yaml\": \"abc\",\n \"Ports\": [\n 0\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 0,\n \"TargetPort\": 0,\n \"Protocol\": \"abc\"\n }\n ],\n \"ExternalDomain\": \"abc\"\n }\n ],\n \"FlushAll\": true,\n \"EnableRegistryNextDeploy\": 0,\n \"ApplicationId\": \"abc\",\n \"AllIpDone\": true,\n \"ExternalDomain\": \"abc\"\n },\n \"Data\": {\n \"Type\": \"abc\",\n \"ServiceName\": \"abc\",\n \"ClusterIp\": \"abc\",\n \"ExternalIp\": \"abc\",\n \"SubnetId\": \"abc\",\n \"VpcId\": \"abc\",\n \"LoadBalanceId\": \"abc\",\n \"Yaml\": \"abc\",\n \"Ports\": [\n 0\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 0,\n \"TargetPort\": 0,\n \"Protocol\": \"abc\"\n }\n ],\n \"ExternalDomain\": \"abc\"\n }\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"xxx\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyApplicationService\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-xxxxxx\",\n \"SourceChannel\": 0,\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Service\": {\n \"Name\": \"svc-name-xxx\",\n \"Ports\": [\n 8080\n ],\n \"Yaml\": \"apiVersion: xxx\",\n \"ApplicationName\": \"app-name-xxx\",\n \"VersionName\": \"ver-name-xxx\",\n \"ClusterIp\": [\n \"11.xx.xx.xx\"\n ],\n \"ExternalIp\": \"10.xx.xx.xx\",\n \"Type\": \"CLUSTER\",\n \"SubnetId\": \"subnet-xxx\",\n \"LoadBalanceId\": \"lb-xxxxxx\",\n \"PortMappings\": [\n {\n \"Port\": 8080,\n \"TargetPort\": 8080,\n \"Protocol\": \"TCP\",\n \"ServiceName\": \"svc-name-xxx\"\n }\n ],\n \"ServicePortMappingList\": [\n {\n \"Type\": \"CLUSTER\",\n \"ServiceName\": \"svc-name-xxx\",\n \"ClusterIp\": \"11.xx.xx.xx\",\n \"ExternalIp\": \"10.xx.xx.xx\",\n \"SubnetId\": \"subnet-xxxxxx\",\n \"VpcId\": \"vpc-xxxxxx\",\n \"LoadBalanceId\": \"lb-xxxxxx\",\n \"Yaml\": \"apiVersion: xxx\",\n \"Ports\": [\n 8080\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 8080,\n \"TargetPort\": 8080,\n \"Protocol\": \"TCP\"\n }\n ],\n \"ExternalDomain\": \"ext.com.xxx\"\n }\n ],\n \"FlushAll\": true,\n \"EnableRegistryNextDeploy\": 0,\n \"ApplicationId\": \"app-xxxxxx\",\n \"AllIpDone\": true,\n \"ExternalDomain\": \"ext.com.xxx\"\n },\n \"Data\": {\n \"Type\": \"CLUSTER\",\n \"ServiceName\": \"svc-name-xxx\",\n \"ClusterIp\": \"11.xx.xx.xx\",\n \"ExternalIp\": \"10.xx.xx.xx\",\n \"SubnetId\": \"subnet-xxxxxx\",\n \"VpcId\": \"vpc-xxxxxx\",\n \"LoadBalanceId\": \"lb-xxxxxx\",\n \"Yaml\": \"apiVersion: xxx\",\n \"Ports\": [\n 8080\n ],\n \"PortMappingItemList\": [\n {\n \"Port\": 8080,\n \"TargetPort\": 8080,\n \"Protocol\": \"TCP\"\n }\n ],\n \"ExternalDomain\": \"ext.com.xxx\"\n }\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"asdc122-xxx-xxx-xxx\"\n }\n}", "title": "修改服务访问方式列表" } ], "ModifyConfigData": [ { "document": "编辑配置", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConfigData\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Name\": \"abc\",\n \"SourceChannel\": 0,\n \"Data\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\",\n \"Type\": \"abc\",\n \"Config\": \"abc\",\n \"Secret\": \"abc\"\n }\n ]\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConfigData\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Name\": \"config-test\",\n \"SourceChannel\": 0,\n \"Data\": [\n {\n \"Key\": \"key-xxx\",\n \"Value\": \"val-xxx\",\n \"Type\": \"\",\n \"Config\": \"\",\n \"Secret\": \"\"\n }\n ]\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": true\n }\n}", "title": "编辑配置" } @@ -331,7 +331,7 @@ "ModifyEnvironment": [ { "document": "编辑环境", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyEnvironment\n<公共请求参数>\n\n{\n \"EnvironmentName\": \"name-xxx\",\n \"Description\": \"描述\",\n \"EnvironmentId\": \"en-xxxxxx\",\n \"SubnetIds\": [\n \"subnet-xxxxxx\"\n ],\n \"SourceChannel\": 0,\n \"Vpc\": \"vpc-xxxxxx\"\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyEnvironment\n<公共请求参数>\n\n{\n \"EnvironmentName\": \"name-xxx\",\n \"Description\": \"这是一个描述\",\n \"EnvironmentId\": \"en-xxxxxx\",\n \"SubnetIds\": [\n \"subnet-xxxxxx\"\n ],\n \"SourceChannel\": 0,\n \"Vpc\": \"vpc-xxxxxx\"\n}", "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"xxx-xxx-xxx\"\n }\n}", "title": "编辑环境" } @@ -347,7 +347,7 @@ "ModifyLogConfig": [ { "document": "编辑日志收集配置", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLogConfig\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Name\": \"abc\",\n \"Data\": {\n \"LogsetId\": \"7a126551-62d1-4e12-b426-84bd5b2fdbca\",\n \"TopicId\": \"6c69fdb7-5e4c-4e52-8437-32c2c729b85a\",\n \"InputType\": \"container_stdout\",\n \"LogType\": \"json_log\",\n \"ExtractRule\": {\n \"FilterKeys\": [],\n \"FilterRegex\": [],\n \"UnMatchUpload\": \"true\",\n \"UnMatchedKey\": \"LogParseFailure\"\n }\n },\n \"ApplicationId\": \"app-xxxxxx\"\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLogConfig\n<公共请求参数>\n\n{\n \"EnvironmentId\": \"en-xxxxxx\",\n \"Name\": \"name-xxx\",\n \"Data\": {\n \"LogsetId\": \"7a126551-62d1-4e12-b426-84bd5b2fdbca\",\n \"TopicId\": \"6c69fdb7-5e4c-4e52-8437-32c2c729b85a\",\n \"InputType\": \"container_stdout\",\n \"LogType\": \"json_log\",\n \"ExtractRule\": {\n \"FilterKeys\": [],\n \"FilterRegex\": [],\n \"UnMatchUpload\": \"true\",\n \"UnMatchedKey\": \"LogParseFailure\"\n }\n },\n \"ApplicationId\": \"app-xxxxxx\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": true\n }\n}", "title": "编辑日志收集配置" } @@ -387,7 +387,7 @@ "RollingUpdateApplicationByVersion": [ { "document": "应用部署", - "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RollingUpdateApplicationByVersion\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-xxxxxx\",\n \"EnvironmentId\": \"en-xxxxxx\",\n \"DeployVersion\": \"v1\",\n \"PackageName\": \"test.jar\",\n \"From\": \"test\",\n \"DeployStrategyType\": \"0\",\n \"TotalBatchCount\": 0,\n \"BatchInterval\": 0,\n \"BetaBatchNum\": 0,\n \"MinAvailable\": 0,\n \"Force\": true\n}", + "input": "POST / HTTP/1.1\nHost: tem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RollingUpdateApplicationByVersion\n<公共请求参数>\n\n{\n \"ApplicationId\": \"app-xxxxxx\",\n \"EnvironmentId\": \"en-xxxxxx\",\n \"DeployVersion\": \"v1\",\n \"PackageName\": \"test.jar\",\n \"From\": \"IntelliJ\",\n \"DeployStrategyType\": \"0\",\n \"TotalBatchCount\": 0,\n \"BatchInterval\": 0,\n \"BetaBatchNum\": 0,\n \"MinAvailable\": 0,\n \"Force\": true\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"81f74023-563c-437d-abf7-8139449ef178\",\n \"Result\": \"revision-xxx\"\n }\n}", "title": "应用部署" }, diff --git a/tccli/services/tke/v20180525/api.json b/tccli/services/tke/v20180525/api.json index e04b9955ae..5000003a0d 100644 --- a/tccli/services/tke/v20180525/api.json +++ b/tccli/services/tke/v20180525/api.json @@ -1938,40 +1938,40 @@ { "disabled": false, "document": "addon名称", - "example": "无", + "example": "cbs", "member": "string", "name": "AddonName", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "addon的版本", - "example": "无", + "example": "1.1.8", "member": "string", "name": "AddonVersion", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "addon的参数,是一个json格式的base64转码后的字符串\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "e30=", "member": "string", "name": "RawValues", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "addon的状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "Succeeded", "member": "string", "name": "Phase", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true }, @@ -1981,9 +1981,19 @@ "example": "无", "member": "string", "name": "Reason", - "required": false, + "output_required": true, "type": "string", "value_allowed_null": true + }, + { + "disabled": false, + "document": "addon的创建时间", + "example": "2024-12-26T09:10:58Z", + "member": "string", + "name": "CreateTime", + "output_required": true, + "type": "string", + "value_allowed_null": false } ], "usage": "out" @@ -4483,7 +4493,7 @@ { "disabled": false, "document": "对象存储桶名称,如果是COS必须是tke-backup前缀开头", - "example": "tke-backup-xxx", + "example": "tke-backup-test", "member": "string", "name": "Bucket", "required": true, @@ -4492,7 +4502,7 @@ { "disabled": false, "document": "备份仓库名称", - "example": "test", + "example": "tke-storage-backup", "member": "string", "name": "Name", "required": true, @@ -4510,7 +4520,7 @@ { "disabled": false, "document": "对象存储桶路径", - "example": "test", + "example": "tke", "member": "string", "name": "Path", "required": false, @@ -7083,7 +7093,7 @@ { "disabled": false, "document": "集群ID", - "example": "无", + "example": "cls-kihzth22", "member": "string", "name": "ClusterId", "required": true, @@ -7092,7 +7102,7 @@ { "disabled": false, "document": "addon名称", - "example": "无", + "example": "nvidia-gpu", "member": "string", "name": "AddonName", "required": true, @@ -7119,7 +7129,7 @@ { "disabled": false, "document": "备份仓库名称", - "example": "test", + "example": "tke-storage-backup", "member": "string", "name": "Name", "required": true, @@ -8266,7 +8276,7 @@ { "disabled": false, "document": "集群ID", - "example": "无", + "example": "cls-kihzth22", "member": "string", "name": "ClusterId", "required": true, @@ -8275,7 +8285,7 @@ { "disabled": false, "document": "addon名称(不传时会返回集群下全部的addon)", - "example": "无", + "example": "cbs", "member": "string", "name": "AddonName", "required": false, @@ -8293,6 +8303,7 @@ "example": "无", "member": "Addon", "name": "Addons", + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -8311,7 +8322,7 @@ { "disabled": false, "document": "集群ID", - "example": "无", + "example": "cls-kihzth22", "member": "string", "name": "ClusterId", "required": true, @@ -8320,7 +8331,7 @@ { "disabled": false, "document": "addon名称", - "example": "无", + "example": "nvidia-gpu", "member": "string", "name": "AddonName", "required": true, @@ -8334,7 +8345,7 @@ "members": [ { "disabled": false, - "document": "参数列表,如果addon已安装,会使用已设置的参数做渲染,是一个json格式的字符串", + "document": "参数列表,如果addon已安装,会使用已设置的参数和chart里的默认参数做渲染,是一个json格式的字符串,未安装addon时返回为空值。", "example": "无", "member": "string", "name": "Values", @@ -8344,7 +8355,7 @@ }, { "disabled": false, - "document": "addon支持的参数列表,使用默认值,是一个json格式的字符串", + "document": "addon支持的参数列表,值为chart的默认值,是一个json格式的字符串。", "example": "无", "member": "string", "name": "DefaultValues", @@ -14482,7 +14493,7 @@ { "disabled": false, "document": "集群ID", - "example": "xxx", + "example": "cls-2r8kckml", "member": "string", "name": "ClusterId", "required": true, @@ -16689,7 +16700,7 @@ { "disabled": false, "document": "app类型,取值log,scheduler,network,storage,monitor,dns,image,other,invisible", - "example": "无", + "example": "network", "member": "string", "name": "Kind", "required": false, @@ -16707,7 +16718,7 @@ { "disabled": false, "document": "集群类型,取值tke、eks", - "example": "无", + "example": "eks", "member": "string", "name": "ClusterType", "required": false, @@ -17174,8 +17185,8 @@ "members": [ { "disabled": false, - "document": "集群ID", - "example": "无", + "document": "集群ID(仅支持标准tke集群)", + "example": "cls-12345678", "member": "string", "name": "ClusterId", "required": true, @@ -17184,7 +17195,7 @@ { "disabled": false, "document": "addon名称", - "example": "无", + "example": "cbs", "member": "string", "name": "AddonName", "required": true, @@ -24723,50 +24734,50 @@ { "disabled": false, "document": "集群ID", - "example": "无", + "example": "cls-a0pa8wse", "member": "string", "name": "ClusterId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "审计开关的详细信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{\"Enable\":false,\"LogsetId\":\"\",\"TopicId\":\"\",\"TopicRegion\":\"\",\"UpgradeAble\":false,\"Version\":\"\"}", "member": "SwitchInfo", "name": "Audit", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": true }, { "disabled": false, "document": "事件开关的详细信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{\"Enable\":false,\"LogsetId\":\"\",\"TopicId\":\"\",\"TopicRegion\":\"\",\"UpgradeAble\":false,\"Version\":\"\"}", "member": "SwitchInfo", "name": "Event", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": true }, { "disabled": false, "document": "普通日志的详细信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{\"Enable\":true,\"LogsetId\":\"\",\"TopicId\":\"\",\"TopicRegion\":\"\",\"UpgradeAble\":true,\"Version\":\"1.1.17\"}", "member": "SwitchInfo", "name": "Log", - "required": true, + "output_required": true, "type": "object", "value_allowed_null": true }, { "disabled": false, "document": "master 日志详细信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{\"Enable\":false,\"LogsetId\":\"\",\"TopicId\":\"\",\"TopicRegion\":\"\",\"UpgradeAble\":false,\"Version\":\"\"}", "member": "SwitchInfo", "name": "MasterLog", - "required": false, + "output_required": true, "type": "object", "value_allowed_null": true } @@ -25257,7 +25268,7 @@ { "disabled": false, "document": "集群ID", - "example": "cls-123deabc", + "example": "cls-12345678", "member": "string", "name": "ClusterId", "required": true, @@ -25284,7 +25295,7 @@ { "disabled": false, "document": "addon的参数,是一个json格式的base64转码后的字符串(addon参数由DescribeAddonValues获取,不传RawValues时AddonVersion必传))", - "example": "WyJyZWdpc3RyeS5hZGRyZXNzPWh0dHBzOi8vY2NyLmNjcy50ZW5jZW50eXVuLmNvbSIsImFnZW50LmRvd25sb2FkUmF0ZT0yMDk3MTUyMCIsImt1YmV2ZXJzaW9uPTEuMjYuMSIsInJlcGxpY2FzPTIiXQ==", + "example": "eyJ2cGNDbmkiOnsic2VjdXJpdHlHcm91cHMiOnsic2VjdXJpdHlHcm91cHMiOltdfX19", "member": "string", "name": "RawValues", "required": false, diff --git a/tccli/services/tke/v20180525/examples.json b/tccli/services/tke/v20180525/examples.json index 27923efb9b..02e8910803 100644 --- a/tccli/services/tke/v20180525/examples.json +++ b/tccli/services/tke/v20180525/examples.json @@ -67,8 +67,8 @@ "CreateBackupStorageLocation": [ { "document": "创建TKE存储仓库", - "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBackupStorageLocation\n<公共请求参数>\n\n{\n \"StorageRegion\": \"ap-guangzhou\",\n \"Provider\": \"tencentcloud\",\n \"Bucket\": \"tke-backup-xxx\",\n \"Path\": \"\",\n \"Name\": \"test-registry-1\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"4bef4bc7-edf2-4de6-a2e1-684bfc37185f\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBackupStorageLocation\n<公共请求参数>\n\n{\n \"StorageRegion\": \"ap-guangzhou\",\n \"Bucket\": \"tke-backup-test\",\n \"Name\": \"tke-storage-backup\",\n \"Provider\": \"tencentcloud\",\n \"Path\": \"tke\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"6b4cf747-ecfb-42ae-a1fb-a0132353c80b\"\n }\n}", "title": "创建TKE存储仓库" } ], @@ -331,16 +331,16 @@ "DeleteAddon": [ { "document": "删除一个addon", - "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-123deabc\",\n \"AddonName\": \"cbs\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-kihzth22\",\n \"AddonName\": \"nvidia-gpu\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"0edfedeb-47cd-41b1-bab9-79dcc88d4e66\"\n }\n}", "title": "删除addon" } ], "DeleteBackupStorageLocation": [ { "document": "删除备份仓库,注意,此接口不会清理备份仓库底层存储数据", - "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteBackupStorageLocation\n<公共请求参数>\n\n{\n \"Name\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"0878bad3-d0aa-4886-beac-7f4d450d55fa\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteBackupStorageLocation\n<公共请求参数>\n\n{\n \"Name\": \"tke-storage-backup\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"ebc80be1-c6a7-4c1f-870e-74eba8471969\"\n }\n}", "title": "删除备份仓库" } ], @@ -583,16 +583,16 @@ "DescribeAddon": [ { "document": "获取一个或多个addon列表", - "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-123deabc\",\n \"AddonName\": \"cbs\"\n}", - "output": "{\n \"Response\": {\n \"Addons\": [\n {\n \"AddonName\": \"cbs\",\n \"AddonVersion\": \"1.1.0\",\n \"RawValues\": \"\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-kihzth22\",\n \"AddonName\": \"cbs\"\n}", + "output": "{\n \"Response\": {\n \"Addons\": [\n {\n \"AddonName\": \"cbs\",\n \"AddonVersion\": \"1.1.7\",\n \"CreateTime\": \"2024-12-23T13:06:44Z\",\n \"Phase\": \"Succeeded\",\n \"RawValues\": \"e30=\",\n \"Reason\": \"\"\n }\n ],\n \"RequestId\": \"7eb2cf94-6cc3-40d0-8843-3ac1314e61e5\"\n }\n}", "title": "获取addon列表" } ], "DescribeAddonValues": [ { "document": "获取一个addon的参数", - "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAddonValues\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-123deabc\",\n \"AddonName\": \"eniipamd\"\n}", - "output": "{\n \"Response\": {\n \"Values\": \"\",\n \"DefaultValues\": \"\",\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAddonValues\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-kihzth22\",\n \"AddonName\": \"nvidia-gpu\"\n}", + "output": "{\n \"Response\": {\n \"DefaultValues\": \"{\\\"config\\\":{\\\"disablehealthchecks\\\":\\\"\\\",\\\"waituvm\\\":false},\\\"exporter\\\":{\\\"tag\\\":\\\"v1.0.18\\\"},\\\"global\\\":{\\\"cluster\\\":{\\\"appid\\\":1255429800,\\\"clustertype\\\":\\\"MANAGED_CLUSTER\\\",\\\"id\\\":\\\"cls-kihzth22\\\",\\\"kubeminor\\\":\\\"30.0\\\",\\\"kubeversion\\\":\\\"1.30.0-tke.2\\\",\\\"longregion\\\":\\\"ap-guangzhou\\\",\\\"region\\\":\\\"gz\\\",\\\"subuin\\\":100040133055,\\\"type\\\":\\\"tke\\\",\\\"uin\\\":100002743387},\\\"image\\\":{\\\"host\\\":\\\"ccr.ccs.tencentyun.com\\\"}},\\\"plugin\\\":{\\\"tag\\\":\\\"v0.14.3\\\"},\\\"pluginInit\\\":{\\\"tag\\\":\\\"v1.0\\\"}}\",\n \"RequestId\": \"4fb715e9-8233-4f82-9730-afe743ea89a7\",\n \"Values\": \"{\\\"config\\\":{\\\"disablehealthchecks\\\":\\\"\\\",\\\"waituvm\\\":false},\\\"exporter\\\":{\\\"tag\\\":\\\"v1.0.18\\\"},\\\"global\\\":{\\\"cluster\\\":{\\\"appid\\\":1255429800,\\\"clustertype\\\":\\\"MANAGED_CLUSTER\\\",\\\"id\\\":\\\"cls-kihzth22\\\",\\\"kubeminor\\\":\\\"30.0\\\",\\\"kubeversion\\\":\\\"1.30.0-tke.2\\\",\\\"longregion\\\":\\\"ap-guangzhou\\\",\\\"region\\\":\\\"gz\\\",\\\"subuin\\\":100040133055,\\\"type\\\":\\\"tke\\\",\\\"uin\\\":100002743387},\\\"image\\\":{\\\"host\\\":\\\"ccr.ccs.tencentyun.com\\\"}},\\\"plugin\\\":{\\\"tag\\\":\\\"v0.14.3\\\"},\\\"pluginInit\\\":{\\\"tag\\\":\\\"v1.0\\\"}}\"\n }\n}", "title": "获取addon的参数" } ], @@ -1530,10 +1530,10 @@ ], "GetTkeAppChartList": [ { - "document": "获取TKE支持的AppChart列表", - "input": "https://tke.tencentcloudapi.com/?Action=GetTkeAppChartList\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"bbe22a77-0366-442d-97ef-b7bc59fa0520\",\n \"AppCharts\": []\n }\n}", - "title": "获取TKE支持的AppChart列表" + "document": "获取EKS支持的网络 AppChart列表", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetTkeAppChartList\n<公共请求参数>\n\n{\n \"Kind\": \"network\",\n \"ClusterType\": \"eks\"\n}", + "output": "{\n \"Response\": {\n \"AppCharts\": [\n {\n \"Label\": \"{\\\"amd64\\\":\\\"true\\\",\\\"eks\\\":\\\"true\\\",\\\"kind\\\":\\\"network\\\",\\\"network\\\":\\\"true\\\",\\\"tke\\\":\\\"true\\\"}\",\n \"LatestVersion\": \"1.5.1\",\n \"Name\": \"ingressnginx\"\n }\n ],\n \"RequestId\": \"566fdd07-fa79-4dc1-8d22-78907dedd607\"\n }\n}", + "title": "获取EKS支持的网络 AppChart列表" } ], "GetUpgradeInstanceProgress": [ @@ -1546,10 +1546,28 @@ ], "InstallAddon": [ { - "document": "为目标集群安装一个addon", - "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InstallAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-123deabc\",\n \"AddonName\": \"cbs\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}", - "title": "安装addon" + "document": "用户安装cbs组件时支持通过RawValues配置自定义参数,比如设置容忍调度,可以将 {\"tolerations\":[{\"effect\":\"NoExecute\",\"key\":\"gpu-not-ready\",\"operator\":\"Equal\",\"tolerationSeconds\":300,\"value\":\"true\"},{\"key\":\"ip-not-ready\",\"operator\":\"Exists\"}]} 进行base64编码后放入到 RawValues 参数中。cbs组件支持的自定义配置参数说明如下:\n```\n{\n \"tolerations\": [\n {\n \"effect\": \"string, 效果,例如:NoExecute\",\n \"key\": \"string,标签值,例如:gpu-not-ready\",\n \"operator\": \"string,操作符,例如:Equal\",\n \"tolerationSeconds\": \"int,容忍时间(秒),例如:300\",\n \"value\": \"string,标签值,例如:true\"\n },\n {\n \"key\": \"string,标签值,例如:ip-not-ready\",\n \"operator\": \"string,操作符,例如:Exists\"\n }\n ]\n}\n```", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InstallAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-12345678\",\n \"AddonName\": \"cbs\",\n \"RawValues\": \"eyJ0b2xlcmF0aW9ucyI6W3siZWZmZWN0IjoiTm9FeGVjdXRlIiwia2V5IjoiZ3B1LW5vdC1yZWFkeSIsIm9wZXJhdG9yIjoiRXF1YWwiLCJ0b2xlcmF0aW9uU2Vjb25kcyI6MzAwLCJ2YWx1ZSI6InRydWUifSx7ImtleSI6ImlwLW5vdC1yZWFkeSIsIm9wZXJhdG9yIjoiRXhpc3RzIn1dfQ==\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"b583f05e-d4f4-4963-8082-b651605hg432\"\n }\n}", + "title": "安装cbs组件" + }, + { + "document": "用户安装eniipamd组件时支持通过RawValues配置自定义参数,比如添加安全组,可以将 {\"vpcCni\":{\"securityGroups\":{\"securityGroups\":[\"sg-12345678\"]}}} 进行base64编码后放入到 RawValues 参数中。eniipamd组件支持的自定义配置参数说明如下:\n```\n{\n \"clusterId\": \"string, 集群ID, 例如:cls-12345678\",\n \"vpcCni\": {\n \"vpcId\": \"string, VPC的ID, 例如:vpc-12345678\",\n \"enableVpcCni\": \"bool, 是否启用VPC CNI, 例如:true\",\n \"routeEni\": {\n \"ipMinWarmTarget\": \"int, 新增节点共享网卡辅助IP的最小预绑定值, 例如:5\",\n \"ipMaxWarmTarget\": \"int, 新增节点共享网卡辅助IP的最大预绑定值, 例如:5\"\n },\n \"ipam\": {\n \"subnetIds\": \"array, 用于IP地址分配的Pod子网ID列表, 例如:[\\\"subnet-12345678\\\"]\"\n }, \n \"securityGroups\": {\n \"enableSecurityGroups\": \"bool, 是否启用安全组, 例如:true\",\n \"securityGroups\": [\n \"string, 安全组ID, 例如:sg-12345678\"\n ]\n }\n },\n \"agent\": {\n \"kubeClient\": {\n \"masterAddr\": \"string, kubeClient主节点地址, 例如: 169.254.128.54:60002\"\n }\n }\n}\n```", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InstallAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-12345678\",\n \"AddonName\": \"eniipamd\",\n \"RawValues\": \"eyJ2cGNDbmkiOnsic2VjdXJpdHlHcm91cHMiOnsic2VjdXJpdHlHcm91cHMiOlsic2ctMTIzNDU2NzgiXX19fQ==\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"b583f05e-d4f4-4963-8082-b651605jh275\"\n }\n}", + "title": "安装eniipamd组件" + }, + { + "document": "用户安装tke-log-agent组件时支持通过RawValues配置自定义参数,比如设置启用kafkalistener,可以将 {\"kafkalistener\":{\"enabled\":true}} 进行base64编码后放入到 RawValues 参数中。tke-log-agent 组件支持的自定义配置参数说明如下:\n```\n{\n \"global\": {\n \"clsHost\": \"string, cls服务域名,例如:ap-chengdu.cls.tencentyun.com\",\n \"cluster\": {\n \"clustertype\": \"string,集群管理类型,例如:MANAGED_CLUSTER 或 INDEPENDENT_CLUSTER\",\n \"kubeminor\": \"string,集群版本,例如:minor 30.0\",\n \"kubeversion\": \"string,集群k8s版本,例如:1.30.0\",\n \"type\": \"string,集群类型,例如:tke 或 eks\"\n },\n \"clusterID\": \"string,集群ID,例如:cls-12345678\",\n \"hostNetwork\": \"bool,是否使用hostNetwork,例如:false\",\n \"localRegion\": \"string,集群所在地域,例如:ap-chengdu\",\n \"registry\": \"string,镜像仓库,例如:ccr.ccs.tencentyun.com\",\n \"sources\": \"string,鉴权方式,例如:norm\"\n },\n \"kafkalistener\": {\n \"enabled\": \"bool,是否启用kafkalistener,例如:true\",\n },\n \"logAgent\": {\n \"enabled\": \"bool,是否启用logAgent,例如:true\",\n },\n \"loglistener\": {\n \"enabled\": \"bool,是否启用loglistener\",\n },\n \"provisioner\": {\n \"replicaCount\": \"int,cls-provisioner副本数,例如:2\",\n \"sources\": \"string,cls-provisioner鉴权方式,例如:norm\"\n }\n}\n```", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InstallAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-123deabc\",\n \"AddonName\": \"tke-log-agent\",\n \"RawValues\": \"eyJrYWZrYWxpc3RlbmVyIjp7ImVuYWJsZWQiOnRydWV9fQ==\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"b583f05e-d4f4-4963-8082-b651605ca427\"\n }\n}", + "title": "安装tke-log-agent组件" + }, + { + "document": "用户可以通过 RawValues 参数制定组件需要的配置参数,比如 imagePullSecretsCrs。 tcr 组件支持的配置参数示例如下:\n```\n{\n \"global\": {\n \"imagePullSecretsCrs\": [\n {\n \"name\": \"string,imagePullSecretsCr 的名称,例如:tcr-12345678-public\",\n \"namespaces\": \"string,免密功能作用范围,例如:* 表示所有命名空间\",\n \"serviceAccounts\": \"string,免密功能作用范围,例如:* 表示所有k8s服务账户\",\n \"type\": \"string,必须为 docker\",\n \"dockerUsername\": \"string,镜像仓库登录用户名\",\n \"dockerPassword\": \"string,镜像仓库登录密码\",\n \"dockerServer\": \"string,镜像仓库服务器地址\"\n }\n ]\n }\n}\n```", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InstallAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-12345678\",\n \"AddonName\": \"tcr\",\n \"RawValues\": \"eyJnbG9iYWwiOnsiaW1hZ2VQdWxsU2VjcmV0c0NycyI6W3sibmFtZSI6InRjci1kZzI4NGltcS1wdWJsaWMiLCJuYW1lc3BhY2VzIjoiKiIsInNlcnZpY2VBY2NvdW50cyI6IioiLCJ0eXBlIjoiZG9ja2VyIiwiZG9ja2VyVXNlcm5hbWUiOiIxMDAwMTQzNjQ4MjIiLCJkb2NrZXJQYXNzd29yZCI6IjEyMzQ1Njc4IiwiZG9ja2VyU2VydmVyIjoibmljb2thbmctdGNyLWd6LnRlbmNlbnRjbG91ZGNyLmNvbSJ9XX19\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"b583f05e-d4f4-4963-8082-b651605ca765\"\n }\n}", + "title": "安装tcr组件" } ], "InstallEdgeLogAgent": [ @@ -1902,10 +1920,22 @@ ], "UpdateAddon": [ { - "document": "获取一个addon的版本和参数", - "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-123deabc\",\n \"AddonName\": \"cbs\",\n \"AddonVersion\": \"1.1.0\"\n}", + "document": "用户可以通过RawValues参数更新eniipamd组件支持的自定义配置参数,比如清空已配置的安全组,可以将 {\"vpcCni\":{\"securityGroups\":{\"securityGroups\":[]}}} 进行base64编码后放入到 RawValues 参数中。eniipamd组件支持的自定义配置参数说明如下:\n```\n{\n \"clusterId\": \"string, 集群ID, 例如:cls-12345678\",\n \"vpcCni\": {\n \"vpcId\": \"string, VPC的ID, 例如:vpc-12345678\",\n \"enableVpcCni\": \"bool, 是否启用VPC CNI, 例如:true\",\n \"routeEni\": {\n \"ipMinWarmTarget\": \"int, 新增节点共享网卡辅助IP的最小预绑定值, 例如:5\",\n \"ipMaxWarmTarget\": \"int, 新增节点共享网卡辅助IP的最大预绑定值, 例如:5\"\n },\n \"ipam\": {\n \"subnetIds\": \"array, 用于IP地址分配的Pod子网ID列表, 例如:[\\\"subnet-12345678\\\"]\"\n }, \n \t\"securityGroups\": {\n \"enableSecurityGroups\": \"bool, 是否启用安全组, 例如:true\",\n \"securityGroups\": [\n \"string, 安全组ID, 例如:sg-12345678\"\n ]\n }\n },\n \"agent\": {\n \"kubeClient\": {\n \"masterAddr\": \"string, kubeClient主节点地址, 例如: 169.254.128.54:60002\"\n }\n }\n}\n```", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-12345678\",\n \"AddonName\": \"eniipamd\",\n \"RawValues\": \"eyJ2cGNDbmkiOnsic2VjdXJpdHlHcm91cHMiOnsic2VjdXJpdHlHcm91cHMiOltdfX19\",\n \"UpdateStrategy\": \"merge\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"f55aaa93-c681-47c9-860a-59ae16ade268\"\n }\n}", - "title": "更新一个addon" + "title": "更新eniipamd组件参数" + }, + { + "document": "用户可以通过RawValues参数更新cbs组件支持的自定义配置参数,比如修改容忍调度设置,可以将 {\"tolerations\":[{\"effect\":\"NoExecute\",\"key\":\"gpu-not-ready\",\"operator\":\"Equal\",\"tolerationSeconds\":300,\"value\":\"true\"},{\"key\":\"ip-not-ready\",\"operator\":\"Exists\"}]} 进行base64编码后放入到 RawValues 参数中。cbs组件支持的自定义配置参数说明如下:\n```\n{\n \"tolerations\": [\n {\n \"effect\": \"string,效果,例如:NoExecute\",\n \"key\": \"string,标签值,例如:gpu-not-ready\",\n \"operator\": \"string,操作符,例如:Equal\",\n \"tolerationSeconds\": \"int,容忍时间(秒),例如:300\",\n \"value\": \"string,标签值,例如:true\"\n },\n {\n \"key\": \"string,标签值,例如:ip-not-ready\",\n \"operator\": \"string,操作符,例如:Exists\"\n }\n ]\n}\n```", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-12345678\",\n \"AddonName\": \"cbs\",\n \"RawValues\": \"eyJ0b2xlcmF0aW9ucyI6W3siZWZmZWN0IjoiTm9FeGVjdXRlIiwia2V5IjoiZ3B1LW5vdC1yZWFkeSIsIm9wZXJhdG9yIjoiRXF1YWwiLCJ0b2xlcmF0aW9uU2Vjb25kcyI6MzAwLCJ2YWx1ZSI6InRydWUifSx7ImtleSI6ImlwLW5vdC1yZWFkeSIsIm9wZXJhdG9yIjoiRXhpc3RzIn1dfQ==\",\n \"UpdateStrategy\": \"merge\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"f55aaa93-c681-47c9-860a-59ae16af648\"\n }\n}", + "title": "更新cbs组件参数" + }, + { + "document": "用户可以通过RawValues参数更新tke-log-agent组件支持的自定义配置参数,比如设置启用kafkalistener,可以将 {\"kafkalistener\":{\"enabled\":true}} 进行base64编码后放入到 RawValues 参数中。tke-log-agent 组件支持的自定义配置参数说明如下:\n```\n{\n \"global\": {\n \"clsHost\": \"string, cls服务域名,例如:ap-chengdu.cls.tencentyun.com\",\n \"cluster\": {\n \"clustertype\": \"string,集群管理类型,例如:MANAGED_CLUSTER 或 INDEPENDENT_CLUSTER\",\n \"kubeminor\": \"string,集群版本,例如:minor 30.0\",\n \"kubeversion\": \"string,集群k8s版本,例如:1.30.0\",\n \"type\": \"string,集群类型,例如:tke 或 eks\"\n },\n \"clusterID\": \"string,集群ID,例如:cls-12345678\",\n \"hostNetwork\": \"bool,是否使用hostNetwork,例如:false\",\n \"localRegion\": \"string,集群所在地域,例如:ap-chengdu\",\n \"registry\": \"string,镜像仓库,例如:ccr.ccs.tencentyun.com\",\n \"sources\": \"string,鉴权方式,例如:norm\"\n },\n \"kafkalistener\": {\n \"enabled\": \"bool,是否启用kafkalistener,例如:true\",\n },\n \"logAgent\": {\n \"enabled\": \"bool,是否启用logAgent,例如:true\",\n },\n \"loglistener\": {\n \"enabled\": \"bool,是否启用loglistener\",\n },\n \"provisioner\": {\n \"replicaCount\": \"int,cls-provisioner副本数,例如:2\",\n \"sources\": \"string,cls-provisioner鉴权方式,例如:norm\"\n }\n}\n```", + "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateAddon\n<公共请求参数>\n\n{\n \"ClusterId\": \"cls-12345678\",\n \"AddonName\": \"tke-log-agent\",\n \"RawValues\": \"eyJrYWZrYWxpc3RlbmVyIjp7ImVuYWJsZWQiOnRydWV9fQ==\",\n \"UpdateStrategy\": \"merge\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"f55aaa93-c681-47c9-860a-59ae16ajgf1\"\n }\n}", + "title": "更新tke-log-agent组件参数" } ], "UpdateClusterKubeconfig": [ diff --git a/tccli/services/trro/v20220325/api.json b/tccli/services/trro/v20220325/api.json index cc0924f1e4..7b3e02a841 100644 --- a/tccli/services/trro/v20220325/api.json +++ b/tccli/services/trro/v20220325/api.json @@ -285,7 +285,7 @@ { "disabled": false, "document": "设备id", - "example": "\"xxx\"", + "example": "\"trro_dev\"", "member": "string", "name": "DeviceId", "required": true, @@ -294,7 +294,7 @@ { "disabled": false, "document": "项目ID", - "example": "\"xxx\"", + "example": "\"m82k5408n123phvb\"", "member": "string", "name": "ProjectId", "required": true, @@ -691,7 +691,7 @@ { "disabled": false, "document": "项目ID", - "example": "xxx", + "example": "m82k5408n123phvb", "member": "string", "name": "ProjectId", "required": true, @@ -718,7 +718,7 @@ { "disabled": false, "document": "设备ID", - "example": "xx", + "example": "trro_dev", "member": "string", "name": "DeviceId", "required": false, @@ -754,7 +754,7 @@ "example": "100", "member": "uint64", "name": "Total", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -764,7 +764,7 @@ "example": "无", "member": "SessionInfo", "name": "DeviceSessionList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -774,7 +774,7 @@ "example": "10", "member": "uint64", "name": "Num", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -820,7 +820,7 @@ { "disabled": false, "document": "模糊匹配关键字,不填默认不进行模糊匹配", - "example": "test", + "example": "trro", "member": "string", "name": "SearchWords", "required": false, @@ -856,7 +856,7 @@ "example": "black", "member": "string", "name": "PolicyMode", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, @@ -866,7 +866,7 @@ "example": "true", "member": "bool", "name": "PolicyEnabled", - "required": true, + "output_required": true, "type": "bool", "value_allowed_null": false }, @@ -876,7 +876,7 @@ "example": "无", "member": "PolicyInfo", "name": "PolicyInfo", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -886,7 +886,7 @@ "example": "1", "member": "int64", "name": "Num", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -896,7 +896,7 @@ "example": "10", "member": "int64", "name": "Total", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -1048,7 +1048,7 @@ { "disabled": false, "document": "项目ID", - "example": "xxx", + "example": "m82k5408n123phvb", "member": "string", "name": "ProjectId", "required": true, @@ -1075,7 +1075,7 @@ { "disabled": false, "document": "设备ID,支持过滤远端设备或现场设备", - "example": "xx", + "example": "trro_dev1", "member": "string", "name": "DeviceId", "required": false, @@ -1111,7 +1111,7 @@ "example": "100", "member": "uint64", "name": "Total", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -1121,7 +1121,7 @@ "example": "无", "member": "RecentSessionInfo", "name": "RecentSessionList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false }, @@ -1131,7 +1131,7 @@ "example": "10", "member": "uint64", "name": "Num", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, @@ -1553,7 +1553,7 @@ { "disabled": false, "document": "项目 ID", - "example": "\"xxx\"", + "example": "m82k5408n123phvb", "member": "string", "name": "ProjectId", "required": false, @@ -1562,7 +1562,7 @@ { "disabled": false, "document": "设备ID", - "example": "\"xxx\"", + "example": "trro_dev", "member": "string", "name": "DeviceId", "required": false, @@ -1587,7 +1587,7 @@ { "disabled": false, "document": "列表数量", - "example": "无", + "example": "10", "member": "int64", "name": "TotalCount", "output_required": true, @@ -1676,7 +1676,7 @@ { "disabled": false, "document": "页码", - "example": "无", + "example": "1", "member": "int64", "name": "PageNum", "required": true, @@ -1685,7 +1685,7 @@ { "disabled": false, "document": "页面数量", - "example": "无", + "example": "10", "member": "int64", "name": "PageSize", "required": true, @@ -1694,7 +1694,7 @@ { "disabled": false, "document": "projectId", - "example": "xxx", + "example": "m82k5408n123phvb", "member": "string", "name": "ProjectId", "required": false, @@ -1703,7 +1703,7 @@ { "disabled": false, "document": "DeviceId", - "example": "xxx", + "example": "trro_dev", "member": "string", "name": "DeviceId", "required": false, @@ -1930,7 +1930,7 @@ { "disabled": false, "document": "添加关联失败的现场设备ID列表", - "example": "无", + "example": "[\"trro_dev1\"]", "member": "string", "name": "FailedInsertIds", "output_required": false, @@ -1940,7 +1940,7 @@ { "disabled": false, "document": "解除关联失败的现场设备ID列表", - "example": "无", + "example": "[\"trro_dev2\"]", "member": "string", "name": "FailedDeleteIds", "output_required": false, diff --git a/tccli/services/trro/v20220325/examples.json b/tccli/services/trro/v20220325/examples.json index 17270e36ac..a91555b9b0 100644 --- a/tccli/services/trro/v20220325/examples.json +++ b/tccli/services/trro/v20220325/examples.json @@ -156,7 +156,7 @@ { "document": "查询用户购买的license列表以及设备绑定情况", "input": "POST / HTTP/1.1\nHost: trro.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetLicenses\n<公共请求参数>\n\n{\n \"PageNum\": 1,\n \"PageSize\": 20\n}", - "output": "{\n \"Response\": {\n \"Licenses\": [\n {\n \"Status\": 0,\n \"Duration\": \"86400\",\n \"ExpireTime\": \"1686362610\",\n \"RemainDay\": 82,\n \"Count\": 2,\n \"LicenseIds\": [\n \"trro-2e24a74a-67ea-1732-076d-75bf772529a\",\n \"trro-2e24a74a-67ea-1732-073d-75bf772579a\"\n ]\n },\n {\n \"Status\": 0,\n \"Duration\": \"186400\",\n \"ExpireTime\": \"1689386610\",\n \"RemainDay\": 117,\n \"LicenseIds\": [\n \"trro-2e24a74a-67ea-1732-076d-75bf772529a\",\n \"trro-2e24a74a-67ea-1732-073d-75bf772579a\"\n ],\n \"Count\": 2\n }\n ],\n \"TotalCount\": 3,\n \"RequestId\": \"xxx\"\n }\n}", + "output": "{\n \"Response\": {\n \"Licenses\": [\n {\n \"Status\": 0,\n \"Duration\": \"86400\",\n \"ExpireTime\": \"1686362610\",\n \"RemainDay\": 82,\n \"Count\": 2,\n \"LicenseIds\": [\n \"trro-2e24a74a-67ea-1732-076d-75bf772529a\",\n \"trro-2e24a74a-67ea-1732-073d-75bf772579a\"\n ]\n },\n {\n \"Status\": 0,\n \"Duration\": \"186400\",\n \"ExpireTime\": \"1689386610\",\n \"RemainDay\": 117,\n \"LicenseIds\": [\n \"trro-2e24a74a-67ea-1732-076d-75bf772529a\",\n \"trro-2e24a74a-67ea-1732-073d-75bf772579a\"\n ],\n \"Count\": 2\n }\n ],\n \"TotalCount\": 3,\n \"RequestId\": \"33086049-513e-561c-8bce-484e18244613\"\n }\n}", "title": "license列表" } ], diff --git a/tccli/services/tse/v20201207/api.json b/tccli/services/tse/v20201207/api.json index cc2aa805bb..1e496d3627 100644 --- a/tccli/services/tse/v20201207/api.json +++ b/tccli/services/tse/v20201207/api.json @@ -4510,7 +4510,7 @@ { "disabled": false, "document": "是否创建成功", - "example": "无", + "example": "true", "member": "bool", "name": "Result", "output_required": true, @@ -4520,7 +4520,7 @@ { "disabled": false, "document": "创建的配置文件Id\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "file-id", "member": "string", "name": "ConfigFileId", "output_required": false, @@ -6103,7 +6103,7 @@ { "disabled": false, "document": "删除服务结果。", - "example": "无", + "example": "true", "member": "bool", "name": "Result", "output_required": true, @@ -7600,7 +7600,7 @@ { "disabled": false, "document": "命名空间", - "example": "无", + "example": "namespace", "member": "string", "name": "Namespace", "required": false, @@ -7609,7 +7609,7 @@ { "disabled": false, "document": "组", - "example": "无", + "example": "group", "member": "string", "name": "Group", "required": false, @@ -7618,7 +7618,7 @@ { "disabled": false, "document": "名称", - "example": "无", + "example": "a.yaml", "member": "string", "name": "Name", "required": false, @@ -7627,7 +7627,7 @@ { "disabled": false, "document": "发布历史记录id,用于分页优化,一般指定 EndId,就不用指定 Offset,否则分页可能不连续", - "example": "无", + "example": "end-id", "member": "uint64", "name": "EndId", "required": false, @@ -8029,7 +8029,7 @@ { "disabled": false, "document": "配置文件Id", - "example": "无", + "example": "file-id", "member": "string", "name": "Id", "required": false, @@ -8212,7 +8212,7 @@ { "disabled": false, "document": "配置文件ID", - "example": "无", + "example": "file-id", "member": "string", "name": "Id", "required": false, @@ -8566,6 +8566,15 @@ "required": false, "type": "string" }, + { + "disabled": false, + "document": "是否开启同步到全局注册中心\t", + "example": "false", + "member": "string", + "name": "SyncToGlobalRegistry", + "required": false, + "type": "string" + }, { "disabled": false, "document": "偏移量,默认为0。", @@ -8895,6 +8904,15 @@ "name": "OnlyExistHealthyInstance", "required": false, "type": "bool" + }, + { + "disabled": false, + "document": "是否开启同步到全局注册中心\t", + "example": "false", + "member": "string", + "name": "SyncToGlobalRegistry", + "required": false, + "type": "string" } ], "type": "object" @@ -11354,6 +11372,16 @@ "output_required": false, "type": "list", "value_allowed_null": true + }, + { + "disabled": false, + "document": "该命名空间下的服务对哪些命名空间可见\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "[Namespace-1,Namespace-2]", + "member": "string", + "name": "ServiceExportTo", + "output_required": false, + "type": "list", + "value_allowed_null": true } ], "usage": "out" @@ -11414,6 +11442,15 @@ "name": "RemoveGroupIds", "required": false, "type": "list" + }, + { + "disabled": false, + "document": "该命名空间下的服务对哪些命名空间下可见,\n1、为空或者不填写,表示仅当前命名空间可见\n2、列表内容仅一个元素,且为字符 *,表示所有命名空间可见(包括新增)\n3、列表内容为部份命名空间名称,则只对这些命名空间下可见", + "example": "[Namespace-1, Namespace-2]", + "member": "string", + "name": "ServiceExportTo", + "required": false, + "type": "list" } ], "usage": "in" diff --git a/tccli/services/tse/v20201207/examples.json b/tccli/services/tse/v20201207/examples.json index 4d91913deb..50643314dc 100644 --- a/tccli/services/tse/v20201207/examples.json +++ b/tccli/services/tse/v20201207/examples.json @@ -123,24 +123,24 @@ "CreateGovernanceInstances": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateGovernanceInstances\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"GovernanceInstances\": [\n {\n \"Service\": \"abc\",\n \"Namespace\": \"abc\",\n \"Weight\": 1,\n \"Healthy\": true,\n \"Isolate\": true,\n \"Host\": \"abc\",\n \"Port\": 1,\n \"Protocol\": \"abc\",\n \"InstanceVersion\": \"abc\",\n \"EnableHealthCheck\": true,\n \"Ttl\": 1\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateGovernanceInstances\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"GovernanceInstances\": [\n {\n \"Service\": \"service\",\n \"Namespace\": \"namespace\",\n \"Weight\": 1,\n \"Healthy\": true,\n \"Isolate\": true,\n \"Host\": \"127.0.0.1\",\n \"Port\": 1,\n \"Protocol\": \"tcp\",\n \"InstanceVersion\": \"prod\",\n \"EnableHealthCheck\": true,\n \"Ttl\": 1\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"req-id\"\n }\n}", "title": "创建服务实例" } ], "CreateGovernanceNamespaces": [ { "document": "创建治理中心命名空间", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateGovernanceNamespaces\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"GovernanceNamespaces\": [\n {\n \"Name\": \"abc\",\n \"Comment\": \"abc\",\n \"UserIds\": [\n \"abc\"\n ],\n \"GroupIds\": [\n \"abc\"\n ],\n \"RemoveUserIds\": [\n \"abc\"\n ],\n \"RemoveGroupIds\": [\n \"abc\"\n ]\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateGovernanceNamespaces\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"GovernanceNamespaces\": [\n {\n \"Name\": \"name\",\n \"Comment\": \"comment\",\n \"UserIds\": [\n \"101\"\n ],\n \"GroupIds\": [\n \"groupa\"\n ],\n \"RemoveUserIds\": [\n \"101\"\n ],\n \"RemoveGroupIds\": [\n \"groupa\"\n ],\n \"ServiceExportTo\": [\n \"json\"\n ]\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"req-id\"\n }\n}", "title": "创建治理中心命名空间" } ], "CreateGovernanceServices": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateGovernanceServices\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"GovernanceServices\": [\n {\n \"Name\": \"abc\",\n \"Namespace\": \"abc\",\n \"Comment\": \"abc\",\n \"Metadatas\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Department\": \"abc\",\n \"Business\": \"abc\",\n \"UserIds\": [\n \"abc\"\n ],\n \"GroupIds\": [\n \"abc\"\n ],\n \"RemoveUserIds\": [\n \"abc\"\n ],\n \"RemoveGroupIds\": [\n \"abc\"\n ]\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateGovernanceServices\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"GovernanceServices\": [\n {\n \"Name\": \"name\",\n \"Namespace\": \"namespace\",\n \"Comment\": \"comment\",\n \"Metadatas\": [\n {\n \"Key\": \"key\",\n \"Value\": \"value\"\n }\n ],\n \"Department\": \"dev\",\n \"Business\": \"web\",\n \"UserIds\": [\n \"101\"\n ],\n \"GroupIds\": [\n \"groupa\"\n ],\n \"RemoveUserIds\": [\n \"101\"\n ],\n \"RemoveGroupIds\": [\n \"groupa\"\n ]\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"req-id\"\n }\n}", "title": "创建治理中心服务" } ], @@ -283,40 +283,40 @@ "DeleteGovernanceAliases": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGovernanceAliases\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"GovernanceAliases\": [\n {\n \"Alias\": \"abc\",\n \"AliasNamespace\": \"abc\",\n \"Service\": \"abc\",\n \"Namespace\": \"abc\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGovernanceAliases\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"GovernanceAliases\": [\n {\n \"Alias\": \"alias\",\n \"AliasNamespace\": \"alias-namespace\",\n \"Service\": \"service\",\n \"Namespace\": \"namespace\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"req-id\"\n }\n}", "title": "删除治理中心服务别名" } ], "DeleteGovernanceInstances": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGovernanceInstances\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"GovernanceInstances\": [\n {\n \"Service\": \"abc\",\n \"Namespace\": \"abc\",\n \"Host\": \"abc\",\n \"Port\": 1,\n \"Id\": \"abc\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGovernanceInstances\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"GovernanceInstances\": [\n {\n \"Service\": \"service\",\n \"Namespace\": \"namespace\",\n \"Host\": \"127.0.0.1\",\n \"Port\": 1,\n \"Id\": \"id\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"req-id\"\n }\n}", "title": "删除服务实例" } ], "DeleteGovernanceInstancesByHost": [ { "document": "根据HOST删除治理中心某个服务下的实例", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGovernanceInstancesByHost\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"GovernanceInstances\": [\n {\n \"Service\": \"abc\",\n \"Namespace\": \"abc\",\n \"Host\": \"abc\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGovernanceInstancesByHost\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"GovernanceInstances\": [\n {\n \"Service\": \"service\",\n \"Namespace\": \"namespace\",\n \"Host\": \"127.0.0.1\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"req-id\"\n }\n}", "title": "根据HOST删除治理中心某个服务下的实例" } ], "DeleteGovernanceNamespaces": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGovernanceNamespaces\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"GovernanceNamespaces\": [\n {\n \"Name\": \"abc\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGovernanceNamespaces\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"GovernanceNamespaces\": [\n {\n \"Name\": \"name\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"req-id\"\n }\n}", "title": "删除治理中心命名空间" } ], "DeleteGovernanceServices": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGovernanceServices\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"GovernanceServices\": [\n {\n \"Name\": \"abc\",\n \"Namespace\": \"abc\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGovernanceServices\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"GovernanceServices\": [\n {\n \"Name\": \"name\",\n \"Namespace\": \"namespace\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"req-id\"\n }\n}", "title": "删除治理中心服务" } ], @@ -475,8 +475,8 @@ "DescribeConfigFile": [ { "document": "查询单个配置文件详细", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigFile\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"Namespace\": \"abc\",\n \"Group\": \"abc\",\n \"Name\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"ConfigFile\": {\n \"Id\": 1,\n \"Name\": \"abc\",\n \"Namespace\": \"abc\",\n \"Group\": \"abc\",\n \"Content\": \"abc\",\n \"Format\": \"abc\",\n \"Comment\": \"abc\",\n \"Status\": \"abc\",\n \"Tags\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"CreateTime\": \"abc\",\n \"CreateBy\": \"abc\",\n \"ModifyTime\": \"abc\",\n \"ModifyBy\": \"abc\",\n \"ReleaseTime\": \"abc\",\n \"ReleaseBy\": \"abc\"\n },\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigFile\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"Namespace\": \"namespace\",\n \"Group\": \"group\",\n \"Name\": \"name\"\n}", + "output": "{\n \"Response\": {\n \"ConfigFile\": {\n \"Id\": 1,\n \"Name\": \"name\",\n \"Namespace\": \"namespace\",\n \"Group\": \"group\",\n \"Content\": \"content\",\n \"Format\": \"yaml\",\n \"Comment\": \"comment\",\n \"Status\": \"status\",\n \"Tags\": [\n {\n \"Key\": \"key\",\n \"Value\": \"value\"\n }\n ],\n \"CreateTime\": \"2024-10-08 10:00:00\",\n \"CreateBy\": \"user\",\n \"ModifyTime\": \"2024-10-08 10:00:00\",\n \"ModifyBy\": \"user\",\n \"ReleaseTime\": \"2024-10-08 10:00:00\",\n \"ReleaseBy\": \"user\"\n },\n \"RequestId\": \"req-id\"\n }\n}", "title": "查询单个配置文件详细" } ], @@ -499,13 +499,13 @@ "DescribeConfigFileReleaseHistories": [ { "document": "查询配置文件发布历史记录-不指定EndId", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigFileReleaseHistories\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"Namespace\": \"Polaris\",\n \"Group\": \"group-test-jayhjxu\",\n \"Name\": \"config-file-test\",\n \"Limit\": 10,\n \"Offset\": 0\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigFileReleaseHistories\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"Namespace\": \"Polaris\",\n \"Group\": \"group-test-jayhjxu\",\n \"Name\": \"config-file-test\",\n \"Limit\": 10,\n \"Offset\": 0\n}", "output": "{\n \"Response\": {\n \"ConfigFileReleaseHistories\": [\n {\n \"Id\": 5,\n \"Name\": \"config-file-test\",\n \"Namespace\": \"Polaris\",\n \"Group\": \"group-test-jayhjxu\",\n \"FileName\": \"\",\n \"Content\": \"test for ModifyConfigFiles\",\n \"Format\": \"text\",\n \"Comment\": \"\",\n \"Md5\": \"9dafe0dd6604b83bb2a40cae654872fa\",\n \"Type\": \"normal\",\n \"Status\": \"success\",\n \"Tags\": [],\n \"CreateTime\": \"\",\n \"CreateBy\": \"\",\n \"ModifyTime\": \"\",\n \"ModifyBy\": \"\"\n },\n {\n \"Id\": 4,\n \"Name\": \"ConfigFileReleases test\",\n \"Namespace\": \"Polaris\",\n \"Group\": \"group-test-jayhjxu\",\n \"FileName\": \"\",\n \"Content\": \"test for CreateConfigFile\",\n \"Format\": \"text\",\n \"Comment\": \"test for 1\",\n \"Md5\": \"4df12e4b1cd8d029a5a233596869fc66\",\n \"Type\": \"normal\",\n \"Status\": \"success\",\n \"Tags\": [],\n \"CreateTime\": \"\",\n \"CreateBy\": \"\",\n \"ModifyTime\": \"\",\n \"ModifyBy\": \"\"\n },\n {\n \"Id\": 3,\n \"Name\": \"ConfigFileReleases test\",\n \"Namespace\": \"Polaris\",\n \"Group\": \"group-test-jayhjxu\",\n \"FileName\": \"\",\n \"Content\": \"\",\n \"Format\": \"text\",\n \"Comment\": \"\",\n \"Md5\": \"\",\n \"Type\": \"delete\",\n \"Status\": \"success\",\n \"Tags\": [],\n \"CreateTime\": \"\",\n \"CreateBy\": \"\",\n \"ModifyTime\": \"\",\n \"ModifyBy\": \"\"\n },\n {\n \"Id\": 2,\n \"Name\": \"ConfigFileReleases test\",\n \"Namespace\": \"Polaris\",\n \"Group\": \"group-test-jayhjxu\",\n \"FileName\": \"\",\n \"Content\": \"test for CreateConfigFile\",\n \"Format\": \"text\",\n \"Comment\": \"test for 1\",\n \"Md5\": \"4df12e4b1cd8d029a5a233596869fc66\",\n \"Type\": \"normal\",\n \"Status\": \"success\",\n \"Tags\": [],\n \"CreateTime\": \"\",\n \"CreateBy\": \"\",\n \"ModifyTime\": \"\",\n \"ModifyBy\": \"\"\n }\n ],\n \"RequestId\": \"jayhjxu-test-DescribeConfigFileRelease--ssss\",\n \"TotalCount\": 4\n }\n}", "title": "查询配置文件发布历史记录-不指定EndId" }, { "document": "指定EndId用于优化分页-指定EndId用于优化分页", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigFileReleaseHistories\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"Namespace\": \"abc\",\n \"Group\": \"abc\",\n \"Name\": \"abc\",\n \"EndId\": 3,\n \"Limit\": 1,\n \"Offset\": 1\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigFileReleaseHistories\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"Namespace\": \"namespace\",\n \"Group\": \"group\",\n \"Name\": \"name\",\n \"EndId\": 3,\n \"Limit\": 1,\n \"Offset\": 1\n}", "output": "{\n \"Response\": {\n \"ConfigFileReleaseHistories\": [\n {\n \"Id\": 2,\n \"Name\": \"ConfigFileReleases test\",\n \"Namespace\": \"Polaris\",\n \"Group\": \"group-test-jayhjxu\",\n \"FileName\": \"\",\n \"Content\": \"test for CreateConfigFile\",\n \"Format\": \"text\",\n \"Comment\": \"test for 1\",\n \"Md5\": \"4df12e4b1cd8d029a5a233596869fc66\",\n \"Type\": \"normal\",\n \"Status\": \"success\",\n \"Tags\": [],\n \"CreateTime\": \"\",\n \"CreateBy\": \"\",\n \"ModifyTime\": \"\",\n \"ModifyBy\": \"\"\n }\n ],\n \"RequestId\": \"jayhjxu-test-DescribeConfigFileRelease--ssss\",\n \"TotalCount\": 1\n }\n}", "title": "指定EndId用于优化分页-指定EndId用于优化分页" } @@ -545,8 +545,8 @@ "DescribeGovernanceAliases": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGovernanceAliases\n<公共请求参数>\n\n{\n \"Service\": \"abc\",\n \"Namespace\": \"abc\",\n \"Alias\": \"abc\",\n \"AliasNamespace\": \"abc\",\n \"Comment\": \"abc\",\n \"Offset\": 1,\n \"Limit\": 1,\n \"InstanceId\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Content\": [\n {\n \"Alias\": \"abc\",\n \"AliasNamespace\": \"abc\",\n \"Service\": \"abc\",\n \"Namespace\": \"abc\",\n \"Comment\": \"abc\",\n \"CreateTime\": \"abc\",\n \"ModifyTime\": \"abc\",\n \"Id\": \"abc\",\n \"Editable\": true\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGovernanceAliases\n<公共请求参数>\n\n{\n \"Service\": \"service\",\n \"Namespace\": \"namespace\",\n \"Alias\": \"alias\",\n \"AliasNamespace\": \"alias-namespace\",\n \"Comment\": \"comment\",\n \"Offset\": 1,\n \"Limit\": 1,\n \"InstanceId\": \"ins-id\"\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Content\": [\n {\n \"Alias\": \"alias\",\n \"AliasNamespace\": \"alias-namespace\",\n \"Service\": \"service\",\n \"Namespace\": \"namespace\",\n \"Comment\": \"comment\",\n \"CreateTime\": \"2024-10-08 10:00:00\",\n \"ModifyTime\": \"2024-10-08 10:00:00\",\n \"Id\": \"id\",\n \"Editable\": true\n }\n ],\n \"RequestId\": \"req-id\"\n }\n}", "title": "查询治理中心服务别名" } ], @@ -561,8 +561,8 @@ "DescribeGovernanceNamespaces": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGovernanceNamespaces\n<公共请求参数>\n\n{\n \"Name\": \"abc\",\n \"Offset\": 1,\n \"Limit\": 1,\n \"InstanceId\": \"abc\"\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Content\": [\n {\n \"Name\": \"abc\",\n \"Comment\": \"abc\",\n \"CreateTime\": \"abc\",\n \"ModifyTime\": \"abc\",\n \"TotalServiceCount\": 0,\n \"TotalHealthInstanceCount\": 0,\n \"TotalInstanceCount\": 0,\n \"Id\": \"abc\",\n \"Editable\": true\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGovernanceNamespaces\n<公共请求参数>\n\n{\n \"Name\": \"name\",\n \"Offset\": 1,\n \"Limit\": 1,\n \"InstanceId\": \"ins-id\"\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Content\": [\n {\n \"Name\": \"name\",\n \"Comment\": \"comment\",\n \"CreateTime\": \"2024-10-08 10:00:00\",\n \"ModifyTime\": \"2024-10-08 10:00:00\",\n \"TotalServiceCount\": 0,\n \"TotalHealthInstanceCount\": 0,\n \"TotalInstanceCount\": 0,\n \"Id\": \"id\",\n \"Editable\": true\n }\n ],\n \"RequestId\": \"req-id\"\n }\n}", "title": "查询治理中心命名空间列表" } ], @@ -586,14 +586,14 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGovernanceServices\n<公共请求参数>\n\n{}", - "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Content\": [\n {\n \"Name\": \"abc\",\n \"Namespace\": \"abc\",\n \"Metadatas\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Comment\": \"abc\",\n \"CreateTime\": \"abc\",\n \"ModifyTime\": \"abc\",\n \"Department\": \"abc\",\n \"Business\": \"abc\",\n \"HealthyInstanceCount\": 1,\n \"TotalInstanceCount\": 1,\n \"Id\": \"abc\",\n \"Editable\": true,\n \"UserIds\": [\n \"abc\"\n ],\n \"GroupIds\": [\n \"abc\"\n ],\n \"RemoveUserIds\": [\n \"abc\"\n ],\n \"RemoveGroupIds\": [\n \"abc\"\n ],\n \"ExportTo\": [\n \"abc\"\n ]\n }\n ],\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Content\": [\n {\n \"Name\": \"name\",\n \"Namespace\": \"namespace\",\n \"Metadatas\": [\n {\n \"Key\": \"key\",\n \"Value\": \"value\"\n }\n ],\n \"Comment\": \"comment\",\n \"CreateTime\": \"2024-10-08 10:00:00\",\n \"ModifyTime\": \"2024-10-08 10:00:00\",\n \"Department\": \"dev\",\n \"Business\": \"web\",\n \"HealthyInstanceCount\": 1,\n \"TotalInstanceCount\": 1,\n \"Id\": \"id\",\n \"Editable\": true,\n \"UserIds\": [\n \"101\"\n ],\n \"GroupIds\": [\n \"groupa\"\n ],\n \"RemoveUserIds\": [\n \"12345678\"\n ],\n \"RemoveGroupIds\": [\n \"101\"\n ],\n \"ExportTo\": [\n \"json\"\n ]\n }\n ],\n \"RequestId\": \"req-id\"\n }\n}", "title": "查询治理中心服务列表" } ], "DescribeInstanceTagInfos": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceTagInfos\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\"\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceTagInfos\n<公共请求参数>\n\n{\n \"InstanceId\": \"instance-id\"\n}", "output": "{\n \"Response\": {\n \"InstanceId\": \"ins-id\",\n \"TagInfos\": [\n {\n \"TagKey\": \"tag-key\",\n \"TagValue\": \"tag-value\"\n }\n ],\n \"RequestId\": \"req-id\"\n }\n}", "title": "查看实例标签信息" } @@ -666,7 +666,7 @@ { "document": "用于查询引擎实例列表", "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSREInstances\n<公共请求参数>\n\n{\n \"Limit\": 10,\n \"Offset\": 0\n}", - "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"Content\": [\n {\n \"InstanceId\": \"ins-a123456\",\n \"Name\": \"test\",\n \"Edition\": \"1.8.6\",\n \"Status\": \"creating\",\n \"SpecId\": \"spec-id\",\n \"Replica\": 0,\n \"Type\": \"nacos\",\n \"VpcId\": \"vpc-id\",\n \"SubnetIds\": [\n \"subnet-id\"\n ],\n \"EnableStorage\": true,\n \"StorageType\": \"SSD\",\n \"StorageCapacity\": 0,\n \"Paymode\": \"POSTPAID\",\n \"EKSClusterID\": \"cluster-id\",\n \"CreateTime\": \"2021-04-08 10:00:00\",\n \"EnvInfos\": [\n {\n \"EnvName\": \"dev\",\n \"VpcInfos\": [\n {\n \"VpcId\": \"vpc-id\",\n \"SubnetId\": \"subnet-id\",\n \"IntranetAddress\": \"10.0.0.1\"\n }\n ],\n \"Status\": \"running\",\n \"StorageCapacity\": 0,\n \"AdminServiceIp\": \"10.0.0.1\",\n \"ConfigServiceIp\": \"10.0.0.2\",\n \"EnableConfigInternet\": true,\n \"ConfigInternetServiceIp\": \"10.0.0.3\",\n \"SpecId\": \"spec-id\",\n \"EnvReplica\": 0,\n \"RunningCount\": 0,\n \"AliasEnvName\": \"dev-alias\",\n \"EnvDesc\": \"env-desc\",\n \"ClientBandWidth\": 1,\n \"EnableConfigIntranet\": true\n }\n ],\n \"EngineRegion\": \"ap-guangzhou\",\n \"EnableInternet\": true,\n \"VpcInfos\": [\n {\n \"VpcId\": \"vpc-id\",\n \"SubnetId\": \"subnet-id\",\n \"IntranetAddress\": \"10.0.0.1\"\n }\n ],\n \"ServiceGovernanceInfos\": [\n {\n \"EngineRegion\": \"ap-guangzhou\",\n \"BoundK8SInfos\": [\n {\n \"BoundClusterId\": \"cluster-id\",\n \"BoundClusterType\": \"tke\",\n \"SyncMode\": \"demand\",\n \"BindRegion\": \"ap-guangzhou\"\n }\n ],\n \"VpcInfos\": [\n {\n \"VpcId\": \"vpc-id\",\n \"SubnetId\": \"subnet-id\",\n \"IntranetAddress\": \"10.0.0.1\"\n }\n ],\n \"PgwVpcInfos\": [],\n \"LimiterVpcInfos\": [],\n \"AuthOpen\": true,\n \"Features\": [\n \"limit\"\n ],\n \"MainPassword\": \"password\",\n \"CLSTopics\": [\n {\n \"LogSetId\": \"log-id\",\n \"LogSetName\": \"log-name\",\n \"TopicId\": \"topic-id\",\n \"TopicName\": \"topic-name\"\n }\n ]\n }\n ],\n \"Tags\": [\n {\n \"Key\": \"tag-key\",\n \"Value\": \"tag-value\"\n }\n ],\n \"EnableConsoleInternet\": true,\n \"EnableConsoleIntranet\": true,\n \"ConfigInfoVisible\": true,\n \"ConsoleDefaultPwd\": \"password\",\n \"TradeType\": 0,\n \"AutoRenewFlag\": 0,\n \"CurDeadline\": \"2024-10-08 10:00:00\",\n \"IsolateTime\": \"2024-10-08 12:00:00\",\n \"RegionInfos\": [\n {\n \"EngineRegion\": \"ap-guangzhou\",\n \"Replica\": 0,\n \"SpecId\": \"spec-id\",\n \"EnableClientInternet\": true,\n \"MainRegion\": true,\n \"ConsoleIntranetVpcInfos\": [\n {\n \"VpcId\": \"vpc-id\",\n \"SubnetId\": \"subnet-id\",\n \"IntranetAddress\": \"10.0.0.1\"\n }\n ],\n \"IntranetVpcInfos\": [\n {\n \"VpcId\": \"vpc-id\",\n \"SubnetId\": \"subnet-id\",\n \"IntranetAddress\": \"10.0.0.1\"\n }\n ]\n }\n ],\n \"EKSType\": \"public\",\n \"FeatureVersion\": \"STANDARD\",\n \"EnableClientIntranet\": true,\n \"StorageOption\": [\n {\n \"Name\": \"snap\",\n \"Type\": \"SSD\",\n \"Capacity\": 50\n }\n ]\n }\n ],\n \"RequestId\": \"req-id\"\n }\n}", + "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"Content\": [\n {\n \"InstanceId\": \"ins-a123456\",\n \"Name\": \"instance-name\",\n \"Edition\": \"1.8.6\",\n \"Status\": \"creating\",\n \"SpecId\": \"spec-id\",\n \"Replica\": 0,\n \"Type\": \"nacos\",\n \"VpcId\": \"vpc-id\",\n \"SubnetIds\": [\n \"subnet-id\"\n ],\n \"EnableStorage\": true,\n \"StorageType\": \"SSD\",\n \"StorageCapacity\": 0,\n \"Paymode\": \"POSTPAID\",\n \"EKSClusterID\": \"cluster-id\",\n \"CreateTime\": \"2021-04-08 10:00:00\",\n \"EnvInfos\": [\n {\n \"EnvName\": \"dev\",\n \"VpcInfos\": [\n {\n \"VpcId\": \"vpc-id\",\n \"SubnetId\": \"subnet-id\",\n \"IntranetAddress\": \"10.0.0.1\"\n }\n ],\n \"Status\": \"running\",\n \"StorageCapacity\": 0,\n \"AdminServiceIp\": \"10.0.0.1\",\n \"ConfigServiceIp\": \"10.0.0.2\",\n \"EnableConfigInternet\": true,\n \"ConfigInternetServiceIp\": \"10.0.0.3\",\n \"SpecId\": \"spec-id\",\n \"EnvReplica\": 0,\n \"RunningCount\": 0,\n \"AliasEnvName\": \"dev-alias\",\n \"EnvDesc\": \"env-desc\",\n \"ClientBandWidth\": 1,\n \"EnableConfigIntranet\": true\n }\n ],\n \"EngineRegion\": \"ap-guangzhou\",\n \"EnableInternet\": true,\n \"VpcInfos\": [\n {\n \"VpcId\": \"vpc-id\",\n \"SubnetId\": \"subnet-id\",\n \"IntranetAddress\": \"10.0.0.1\"\n }\n ],\n \"ServiceGovernanceInfos\": [\n {\n \"EngineRegion\": \"ap-guangzhou\",\n \"BoundK8SInfos\": [\n {\n \"BoundClusterId\": \"cluster-id\",\n \"BoundClusterType\": \"tke\",\n \"SyncMode\": \"demand\",\n \"BindRegion\": \"ap-guangzhou\"\n }\n ],\n \"VpcInfos\": [\n {\n \"VpcId\": \"vpc-id\",\n \"SubnetId\": \"subnet-id\",\n \"IntranetAddress\": \"10.0.0.1\"\n }\n ],\n \"PgwVpcInfos\": [],\n \"LimiterVpcInfos\": [],\n \"AuthOpen\": true,\n \"Features\": [\n \"limit\"\n ],\n \"MainPassword\": \"password\",\n \"CLSTopics\": [\n {\n \"LogSetId\": \"log-id\",\n \"LogSetName\": \"log-name\",\n \"TopicId\": \"topic-id\",\n \"TopicName\": \"topic-name\"\n }\n ]\n }\n ],\n \"Tags\": [\n {\n \"Key\": \"tag-key\",\n \"Value\": \"tag-value\"\n }\n ],\n \"EnableConsoleInternet\": true,\n \"EnableConsoleIntranet\": true,\n \"ConfigInfoVisible\": true,\n \"ConsoleDefaultPwd\": \"password\",\n \"TradeType\": 0,\n \"AutoRenewFlag\": 0,\n \"CurDeadline\": \"2024-10-08 10:00:00\",\n \"IsolateTime\": \"2024-10-08 12:00:00\",\n \"RegionInfos\": [\n {\n \"EngineRegion\": \"ap-guangzhou\",\n \"Replica\": 0,\n \"SpecId\": \"spec-id\",\n \"EnableClientInternet\": true,\n \"MainRegion\": true,\n \"ConsoleIntranetVpcInfos\": [\n {\n \"VpcId\": \"vpc-id\",\n \"SubnetId\": \"subnet-id\",\n \"IntranetAddress\": \"10.0.0.1\"\n }\n ],\n \"IntranetVpcInfos\": [\n {\n \"VpcId\": \"vpc-id\",\n \"SubnetId\": \"subnet-id\",\n \"IntranetAddress\": \"10.0.0.1\"\n }\n ]\n }\n ],\n \"EKSType\": \"public\",\n \"FeatureVersion\": \"STANDARD\",\n \"EnableClientIntranet\": true,\n \"StorageOption\": [\n {\n \"Name\": \"snap\",\n \"Type\": \"SSD\",\n \"Capacity\": 50\n }\n ]\n }\n ],\n \"RequestId\": \"req-id\"\n }\n}", "title": "查询引擎实例列表" } ], @@ -785,8 +785,8 @@ "ModifyConfigFiles": [ { "document": "修改配置文件", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConfigFiles\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ConfigFile\": {\n \"Id\": 1,\n \"Name\": \"abc\",\n \"Namespace\": \"abc\",\n \"Group\": \"abc\",\n \"Content\": \"abc\",\n \"Format\": \"abc\",\n \"Comment\": \"abc\",\n \"Status\": \"abc\",\n \"Tags\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"CreateTime\": \"abc\",\n \"CreateBy\": \"abc\",\n \"ModifyTime\": \"abc\",\n \"ModifyBy\": \"abc\",\n \"ReleaseTime\": \"abc\",\n \"ReleaseBy\": \"abc\"\n }\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConfigFiles\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"ConfigFile\": {\n \"Id\": 1,\n \"Name\": \"name\",\n \"Namespace\": \"namespace\",\n \"Group\": \"group\",\n \"Content\": \"content\",\n \"Format\": \"yaml\",\n \"Comment\": \"comment\",\n \"Status\": \"status\",\n \"Tags\": [\n {\n \"Key\": \"key\",\n \"Value\": \"value\"\n }\n ],\n \"CreateTime\": \"2024-10-08 10:00:00\",\n \"CreateBy\": \"user\",\n \"ModifyTime\": \"2024-10-08 10:00:00\",\n \"ModifyBy\": \"user\",\n \"ReleaseTime\": \"2024-10-08 10:00:00\",\n \"ReleaseBy\": \"user\"\n }\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"req-id\"\n }\n}", "title": "修改配置文件" } ], @@ -817,8 +817,8 @@ "ModifyGovernanceNamespaces": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyGovernanceNamespaces\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"GovernanceNamespaces\": [\n {\n \"Name\": \"abc\",\n \"Comment\": \"abc\",\n \"UserIds\": [\n \"abc\"\n ],\n \"GroupIds\": [\n \"abc\"\n ],\n \"RemoveUserIds\": [\n \"abc\"\n ],\n \"RemoveGroupIds\": [\n \"abc\"\n ]\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyGovernanceNamespaces\n<公共请求参数>\n\n{\n \"InstanceId\": \"ins-id\",\n \"GovernanceNamespaces\": [\n {\n \"Name\": \"name\",\n \"Comment\": \"coment\",\n \"UserIds\": [\n \"101\"\n ],\n \"GroupIds\": [\n \"groupa\"\n ],\n \"RemoveUserIds\": [\n \"101\"\n ],\n \"RemoveGroupIds\": [\n \"groupa\"\n ]\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"req-id\"\n }\n}", "title": "修改治理中心命名空间" } ], diff --git a/tccli/services/tsf/v20180326/api.json b/tccli/services/tsf/v20180326/api.json index 555f5f34b2..8c1c91d8f6 100644 --- a/tccli/services/tsf/v20180326/api.json +++ b/tccli/services/tsf/v20180326/api.json @@ -3222,7 +3222,7 @@ { "disabled": false, "document": "配置项id", - "example": "dddd", + "example": "send-data-to-kafka-6a79x94v", "member": "string", "name": "ConfigId", "required": true, @@ -3249,7 +3249,7 @@ { "disabled": false, "document": "命名空间id", - "example": "namespace-xxxx", + "example": "namespace-6a79x94v", "member": "string", "name": "NamespaceId", "required": false, @@ -3258,7 +3258,7 @@ { "disabled": false, "document": "集群id", - "example": "cls-xxxx", + "example": "cls-6a79x94v", "member": "string", "name": "ClusterId", "required": false, @@ -3267,7 +3267,7 @@ { "disabled": false, "document": "模糊搜索关键词", - "example": "xxx", + "example": "config-template", "member": "string", "name": "SearchWord", "required": false, @@ -3285,7 +3285,7 @@ "example": "1", "member": "bool", "name": "Result", - "required": true, + "output_required": true, "type": "bool", "value_allowed_null": true }, @@ -3343,7 +3343,7 @@ { "disabled": false, "document": "分组绑定网关列表", - "example": "", + "example": "[{\"GatewayDeployGroupId\":\"group-yo99lney\",\"GroupId\":\"grp-djvzrdih\"}]", "member": "GatewayGroupIds", "name": "GroupGatewayList", "required": true, @@ -3358,7 +3358,7 @@ { "disabled": false, "document": "返回结果,成功失败", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -6771,7 +6771,7 @@ { "disabled": false, "document": "API分组ID", - "example": "无", + "example": "grp-notmqbpe", "member": "string", "name": "GroupId", "required": true, @@ -6780,7 +6780,7 @@ { "disabled": false, "document": "微服务ID", - "example": "无", + "example": "ms-y5w8n5e9", "member": "string", "name": "MicroserviceId", "required": true, @@ -6789,7 +6789,7 @@ { "disabled": false, "document": "命名空间ID", - "example": "无", + "example": "namespace-v3gw3lna", "member": "string", "name": "NamespaceId", "required": false, @@ -6804,7 +6804,7 @@ { "disabled": false, "document": "是否成功", - "example": "无", + "example": "true", "member": "bool", "name": "Result", "output_required": true, @@ -6826,7 +6826,7 @@ { "disabled": false, "document": "分组名称, 不能包含中文", - "example": "zuul_test_group", + "example": "grp_user", "member": "string", "name": "GroupName", "required": true, @@ -6835,7 +6835,7 @@ { "disabled": false, "document": "分组上下文", - "example": "%2Fuser", + "example": "/grp_user", "member": "string", "name": "GroupContext", "required": true, @@ -6871,7 +6871,7 @@ { "disabled": false, "document": "网关实体ID", - "example": "gw-ins-anrptnkf", + "example": "gw-ins-szesmg28", "member": "string", "name": "GatewayInstanceId", "required": false, @@ -6922,7 +6922,7 @@ { "disabled": false, "document": "API分组ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "grp-57at58po", + "example": "grp-rzn41l1w", "member": "string", "name": "Result", "output_required": true, @@ -6944,7 +6944,7 @@ { "disabled": false, "document": "Api Id", - "example": "", + "example": "api-8c7538te", "member": "string", "name": "ApiId", "required": true, @@ -6953,7 +6953,7 @@ { "disabled": false, "document": "qps值", - "example": "", + "example": "10000", "member": "uint64", "name": "MaxQps", "required": true, @@ -6962,7 +6962,7 @@ { "disabled": false, "document": "开启/禁用,enabled/disabled, 不传默认开启", - "example": "", + "example": "enabled", "member": "string", "name": "UsableStatus", "required": false, @@ -6977,7 +6977,7 @@ { "disabled": false, "document": "是否成功", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -7405,7 +7405,7 @@ { "disabled": false, "document": "配置项名称", - "example": "test_openapi_config", + "example": "config_app", "member": "string", "name": "ConfigName", "required": true, @@ -7414,7 +7414,7 @@ { "disabled": false, "document": "配置项版本", - "example": "v1.0", + "example": "v1", "member": "string", "name": "ConfigVersion", "required": true, @@ -7423,7 +7423,7 @@ { "disabled": false, "document": "配置项值", - "example": "api.invok.limit: 5000", + "example": "config: enabled", "member": "string", "name": "ConfigValue", "required": true, @@ -7432,7 +7432,7 @@ { "disabled": false, "document": "应用ID", - "example": "application-gyq2xry5", + "example": "application-5yr26r9a", "member": "string", "name": "ApplicationId", "required": true, @@ -7441,7 +7441,7 @@ { "disabled": false, "document": "配置项版本描述", - "example": "无", + "example": "This is desc", "member": "string", "name": "ConfigVersionDesc", "required": false, @@ -7450,7 +7450,7 @@ { "disabled": false, "document": "配置项值类型", - "example": "无", + "example": "application", "member": "string", "name": "ConfigType", "required": false, @@ -7459,7 +7459,7 @@ { "disabled": false, "document": "Base64编码的配置项", - "example": "无", + "example": "true", "member": "bool", "name": "EncodeWithBase64", "required": false, @@ -7468,7 +7468,7 @@ { "disabled": false, "document": "无", - "example": "无", + "example": "[\"program-6a79x94v\"]", "member": "string", "name": "ProgramIdList", "required": false, @@ -7483,7 +7483,7 @@ { "disabled": false, "document": "true:创建成功;false:创建失败\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "true", "member": "bool", "name": "Result", "required": true, @@ -7505,7 +7505,7 @@ { "disabled": false, "document": "配置模板名称", - "example": "配置1", + "example": "config_temp_app", "member": "string", "name": "ConfigTemplateName", "required": true, @@ -7523,7 +7523,7 @@ { "disabled": false, "document": "配置模板数据", - "example": "#请求处理超时时间ribbon.ReadTimeout: 5000#请求连接超时时间ribbon.ConnectTimeout: 2000#同一实例最大重试次数,不包括首次调用ribbon.MaxAutoRetries: 0#重试其他实例的最大重试次数,不包括首次所选的serverribbon.MaxAutoRetriesNextServer: 1#是否对所有操作请求都进行重试ribbon.OkToRetryOnAllOperations: false", + "example": "#请求处理超时时间\\nribbon.ReadTimeout: 5000\\n#请求连接超时时间\\nribbon.ConnectTimeout: 2000\\n#同一实例最大重试次数,不包括首次调用\\nribbon.MaxAutoRetries: 0\\n#重试其他实例的最大重试次数,不包括首次所选的server\\nribbon.MaxAutoRetriesNextServer: 1\\n#是否对所有操作请求都进行重试\\nribbon.OkToRetryOnAllOperations: false\\n", "member": "string", "name": "ConfigTemplateValue", "required": true, @@ -7532,7 +7532,7 @@ { "disabled": false, "document": "配置模板描述", - "example": "11111111111", + "example": "This is desc", "member": "string", "name": "ConfigTemplateDesc", "required": false, @@ -7541,7 +7541,7 @@ { "disabled": false, "document": "无", - "example": "无", + "example": "[\"program-6a79x94v\"]", "member": "string", "name": "ProgramIdList", "required": false, @@ -7556,7 +7556,7 @@ { "disabled": false, "document": "true:创建成功;false:创建失败", - "example": "1", + "example": "true", "member": "bool", "name": "Result", "required": true, @@ -7578,7 +7578,7 @@ { "disabled": false, "document": "配置模板名称", - "example": "配置1", + "example": "config_app", "member": "string", "name": "ConfigTemplateName", "required": true, @@ -7629,7 +7629,7 @@ { "disabled": false, "document": "创建成功,返回 ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{\"ConfigTemplateDesc\":null,\"ConfigTemplateId\":\"dcfg_temp-aln5d3wv\",\"ConfigTemplateName\":\"test\",\"ConfigTemplateType\":\"Ribbon\",\"ConfigTemplateValue\":\"#请求处理超时时间\",\"CreateTime\":null,\"UpdateTime\":null}", + "example": "{\"ConfigTemplateId\":\"dcfg_temp-ym1v\",\"ConfigTemplateName\":\"ct\",\"ConfigTemplateType\":\"Ribbon\",\"ConfigTemplateValue\":\"time: 2000\"}", "member": "ConfigTemplate", "name": "Result", "output_required": true, @@ -7994,7 +7994,7 @@ { "disabled": false, "document": "配置项名称", - "example": "consumer-config", + "example": "config_app", "member": "string", "name": "ConfigName", "required": true, @@ -8003,7 +8003,7 @@ { "disabled": false, "document": "配置项版本", - "example": "1", + "example": "v1", "member": "string", "name": "ConfigVersion", "required": true, @@ -8012,7 +8012,7 @@ { "disabled": false, "document": "配置项文件名", - "example": "update", + "example": "conf.txt", "member": "string", "name": "ConfigFileName", "required": true, @@ -8021,7 +8021,7 @@ { "disabled": false, "document": "配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)", - "example": "workdir", + "example": "config=enabled", "member": "string", "name": "ConfigFileValue", "required": true, @@ -8030,7 +8030,7 @@ { "disabled": false, "document": "配置项关联应用ID", - "example": "application-dapbkdgy", + "example": "application-5yr26r9a", "member": "string", "name": "ApplicationId", "required": true, @@ -8048,7 +8048,7 @@ { "disabled": false, "document": "配置项版本描述", - "example": "first", + "example": "This is desc", "member": "string", "name": "ConfigVersionDesc", "required": false, @@ -8066,7 +8066,7 @@ { "disabled": false, "document": "后置命令", - "example": "/usr/bin/bash", + "example": "sh start.sh", "member": "string", "name": "ConfigPostCmd", "required": false, @@ -8084,7 +8084,7 @@ { "disabled": false, "document": "无", - "example": "无", + "example": "[\"program-6a79x94v\"]", "member": "string", "name": "ProgramIdList", "required": false, @@ -8099,7 +8099,7 @@ { "disabled": false, "document": "true:创建成功;false:创建失败\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "true", "member": "bool", "name": "Result", "required": true, @@ -8247,7 +8247,7 @@ { "disabled": false, "document": "API 分组ID", - "example": "grp-5yk7oor1", + "example": "grp-djvzrdih", "member": "string", "name": "GroupId", "required": true, @@ -8256,7 +8256,7 @@ { "disabled": false, "document": "Api信息", - "example": "无", + "example": "[{\"NamespaceId\":\"namespace-external\",\"MicroserviceId\":\"ms-external\",\"Path\":\"/echo_user\",\"Method\":\"GET\",\"PathMapping\":\"/echo_user\",\"Host\":\"http://www.qq.com\",\"Description\":\"This is desc\",\"RpcExt\":\"{\\\"shortServiceName\\\":\\\"personservice\\\",\\\"interfaceName\\\":\\\"com.tencent.tsf.atom.example.alibaba.dubbo.PersonService\\\",\\\"methodName\\\":\\\"complexCondition\\\",\\\"parameterTypes\\\":\\\"byte,short,int,long,float,double,boolean,char,java.lang.Integer,java.util.List<java.lang.Integer>,java.util.List<java.lang.Object>,java.util.List,java.util.Collection<java.lang.Integer>,java.lang.Integer[],java.lang.Object\\\",\\\"group\\\":null,\\\"version\\\":\\\"1.0\\\",\\\"loadbalance\\\":null,\\\"retries\\\":null,\\\"timeout\\\":null,\\\"protocol\\\":\\\"dubbo\\\",\\\"url\\\":null}\",\"RpcType\":\"http\",\"Md5\":\"1fd35524030bebc48e0f51a3a7fe6737\"}]", "member": "ApiInfo", "name": "ApiList", "required": true, @@ -8265,7 +8265,7 @@ { "disabled": false, "document": "无", - "example": "无", + "example": "[\"program-6a79x94v\"]", "member": "string", "name": "ProgramIdList", "required": false, @@ -8280,7 +8280,7 @@ { "disabled": false, "document": "是否成功", - "example": "1", + "example": "true", "member": "bool", "name": "Result", "required": true, @@ -8548,7 +8548,7 @@ { "disabled": false, "document": "命名空间ID", - "example": "", + "example": "namespace-v3gw3lna", "member": "string", "name": "NamespaceId", "required": true, @@ -8557,7 +8557,7 @@ { "disabled": false, "document": "微服务名称", - "example": "", + "example": "provider-app", "member": "string", "name": "MicroserviceName", "required": true, @@ -8566,7 +8566,7 @@ { "disabled": false, "document": "微服务描述信息", - "example": "", + "example": "This is desc", "member": "string", "name": "MicroserviceDesc", "required": false, @@ -8581,7 +8581,7 @@ { "disabled": false, "document": "新增微服务是否成功。\ntrue:操作成功。\nfalse:操作失败。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -8803,7 +8803,7 @@ { "disabled": false, "document": "路径重写列表", - "example": "无", + "example": "[{\"GatewayGroupId\":\"group-ldap5yok\",\"Regex\":\"/consumer\",\"Replacement\":\"/provider\",\"Blocked\":\"N\",\"Order\":1}]", "member": "PathRewriteCreateObject", "name": "PathRewrites", "required": true, @@ -8818,7 +8818,7 @@ { "disabled": false, "document": "返回路径重写规则 ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[\"rewrite-py5r7b6v\"]", "member": "string", "name": "Result", "type": "list", @@ -8894,7 +8894,7 @@ { "disabled": false, "document": "配置项名称", - "example": "testconfig", + "example": "config_pub_app", "member": "string", "name": "ConfigName", "required": true, @@ -8903,7 +8903,7 @@ { "disabled": false, "document": "配置项版本", - "example": "1.3", + "example": "v1", "member": "string", "name": "ConfigVersion", "required": true, @@ -8912,7 +8912,7 @@ { "disabled": false, "document": "配置项值,总是接收yaml格式的内容", - "example": "无", + "example": "config: enabled", "member": "string", "name": "ConfigValue", "required": true, @@ -8921,7 +8921,7 @@ { "disabled": false, "document": "配置项版本描述", - "example": "无", + "example": "This is desc", "member": "string", "name": "ConfigVersionDesc", "required": false, @@ -8930,7 +8930,7 @@ { "disabled": false, "document": "配置项类型", - "example": "无", + "example": "public", "member": "string", "name": "ConfigType", "required": false, @@ -8939,7 +8939,7 @@ { "disabled": false, "document": "Base64编码的配置项", - "example": "无", + "example": "true", "member": "bool", "name": "EncodeWithBase64", "required": false, @@ -8948,7 +8948,7 @@ { "disabled": false, "document": "无", - "example": "无", + "example": "[\"program-6a79x94v\"]", "member": "string", "name": "ProgramIdList", "required": false, @@ -8963,7 +8963,7 @@ { "disabled": false, "document": "true:创建成功;false:创建失败\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "1", + "example": "true", "member": "bool", "name": "Result", "required": true, @@ -9700,7 +9700,7 @@ { "disabled": false, "document": "API 分组ID", - "example": "", + "example": "grp-glt0lr13", "member": "string", "name": "GroupId", "required": true, @@ -9715,7 +9715,7 @@ { "disabled": false, "document": "成功失败", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -9864,7 +9864,7 @@ { "disabled": false, "document": "配置项ID", - "example": "", + "example": "dcfg-a7rl7w4v", "member": "string", "name": "ConfigId", "required": true, @@ -9879,7 +9879,7 @@ { "disabled": false, "document": "true:删除成功;false:删除失败", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -9974,7 +9974,7 @@ { "disabled": false, "document": "文件配置项ID", - "example": "", + "example": "dcfg-f-aeonjd6y", "member": "string", "name": "ConfigId", "required": true, @@ -9989,7 +9989,7 @@ { "disabled": false, "document": "删除结果\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -10010,7 +10010,7 @@ { "disabled": false, "document": "分组ID", - "example": "", + "example": "grp-notmqbpe", "member": "string", "name": "GroupId", "required": true, @@ -10019,7 +10019,7 @@ { "disabled": false, "document": "Api ID 数组", - "example": "", + "example": "[\"api-8c7538te\"]", "member": "string", "name": "ApiList", "required": true, @@ -10034,7 +10034,7 @@ { "disabled": false, "document": "是否成功", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -10162,7 +10162,7 @@ { "disabled": false, "document": "泳道Idl", - "example": "无", + "example": "lane-y9o6w958", "member": "string", "name": "LaneId", "required": true, @@ -10177,7 +10177,7 @@ { "disabled": false, "document": "删除成功: true / 删除失败: false", - "example": "无", + "example": "true", "member": "bool", "name": "Result", "output_required": true, @@ -10236,7 +10236,7 @@ { "disabled": false, "document": "微服务ID", - "example": "", + "example": "ms-vzg9kzj3", "member": "string", "name": "MicroserviceId", "required": true, @@ -10251,7 +10251,7 @@ { "disabled": false, "document": "删除微服务是否成功。\ntrue:操作成功。\nfalse:操作失败。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -10318,7 +10318,7 @@ { "disabled": false, "document": "路径重写规则IDs", - "example": "", + "example": "[\"rewrite-qv3rrlnv\"]", "member": "string", "name": "PathRewriteIds", "required": true, @@ -10333,7 +10333,7 @@ { "disabled": false, "document": "true/false", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -10408,7 +10408,7 @@ { "disabled": false, "document": "配置项ID", - "example": "", + "example": "dcfg-p-vzk36rov", "member": "string", "name": "ConfigId", "required": true, @@ -10423,7 +10423,7 @@ { "disabled": false, "document": "true:删除成功;false:删除失败\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -10599,7 +10599,7 @@ { "disabled": false, "document": "规则ID", - "example": "", + "example": "unit-rl-cgd3l6jo", "member": "string", "name": "Id", "required": true, @@ -10614,7 +10614,7 @@ { "disabled": false, "document": "是否成功\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -11471,7 +11471,7 @@ { "disabled": false, "document": "微服务id", - "example": "", + "example": "ms-y5w8n5e9", "member": "string", "name": "MicroserviceId", "required": true, @@ -11480,7 +11480,7 @@ { "disabled": false, "document": "请求路径", - "example": "", + "example": "/user-feign", "member": "string", "name": "Path", "required": true, @@ -11489,7 +11489,7 @@ { "disabled": false, "document": "请求方法", - "example": "", + "example": "GET", "member": "string", "name": "Method", "required": true, @@ -11498,7 +11498,7 @@ { "disabled": false, "document": "包版本", - "example": "", + "example": "20210625192924", "member": "string", "name": "PkgVersion", "required": true, @@ -11507,7 +11507,7 @@ { "disabled": false, "document": "应用ID", - "example": "", + "example": "application-yn3zdj9v", "member": "string", "name": "ApplicationId", "required": true, @@ -11522,7 +11522,7 @@ { "disabled": false, "document": "API 详情", - "example": "", + "example": "{\"CanRun\":true,\"Definitions\":[{\"Name\":\"\",\"Properties\":[{\"Description\":\"\",\"Name\":\"\",\"Type\":\"\"}]}],\"Description\":\"feignMeshUser\",\"MsgwApiType\":\"Normal\",\"Request\":[{\"DefaultValue\":null,\"Description\":\"tagName\",\"In\":\"query\",\"Name\":\"tagName\",\"Required\":false,\"Type\":\"string\"},{\"DefaultValue\":null,\"Description\":\"tagValue\",\"In\":\"query\",\"Name\":\"tagValue\",\"Required\":false,\"Type\":\"string\"}],\"RequestContentType\":null,\"Response\":[{\"Description\":\"OK\",\"Name\":\"_RESPONSE\",\"Type\":\"string\"}],\"Status\":1}", "member": "ApiDetailResponse", "name": "Result", "type": "object", @@ -12355,7 +12355,7 @@ { "disabled": false, "document": "部署组ID,不传入时查询全量", - "example": "", + "example": "group-aln2284v", "member": "string", "name": "GroupId", "required": false, @@ -12364,7 +12364,7 @@ { "disabled": false, "document": "偏移量,默认为0", - "example": "", + "example": "0", "member": "int64", "name": "Offset", "required": false, @@ -12373,7 +12373,7 @@ { "disabled": false, "document": "每页条数,默认为20", - "example": "", + "example": "10", "member": "int64", "name": "Limit", "required": false, @@ -12382,7 +12382,7 @@ { "disabled": false, "document": "命名空间ID,不传入时查询全量", - "example": "", + "example": "namespace-vj3z3zgy", "member": "string", "name": "NamespaceId", "required": false, @@ -12391,7 +12391,7 @@ { "disabled": false, "document": "集群ID,不传入时查询全量", - "example": "", + "example": "cluster-yne99jdy", "member": "string", "name": "ClusterId", "required": false, @@ -12400,7 +12400,7 @@ { "disabled": false, "document": "应用ID,不传入时查询全量", - "example": "", + "example": "application-l6ymbvgd", "member": "string", "name": "ApplicationId", "required": false, @@ -12415,7 +12415,7 @@ { "disabled": false, "document": "分页的配置项发布历史列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "{\"Content\":[{\"ClusterId\":\"cluster-yne99jdy\",\"ClusterName\":\"cluster-jolyonzheng\",\"ConfigId\":\"dcfg-yo82mmra\",\"ConfigName\":\"jolyonzheng-config\",\"ConfigReleaseLogId\":\"dcfgrl-yq75nn3a\",\"ConfigVersion\":\"v3\",\"GroupId\":\"group-aln2284v\",\"GroupName\":\"group-provider-1\",\"LastConfigId\":null,\"LastConfigName\":null,\"LastConfigVersion\":null,\"NamespaceId\":\"namespace-vw8oox6v\",\"NamespaceName\":\"cluster-jolyonzheng_default\",\"ReleaseDesc\":\"This is desc\",\"ReleaseStatus\":\"S\",\"ReleaseTime\":\"2024-12-24 15:57:15\",\"ReleasedConfigCenter\":\"SHARE\",\"RollbackFlag\":false},{\"ClusterId\":\"cluster-yne99jdy\",\"ClusterName\":\"cluster-jolyonzheng\",\"ConfigId\":\"dcfg-yo82mmra\",\"ConfigName\":\"jolyonzheng-config\",\"ConfigReleaseLogId\":\"dcfgrl-ydrjmmma\",\"ConfigVersion\":\"v3\",\"GroupId\":\"group-aln2284v\",\"GroupName\":\"group-provider-1\",\"LastConfigId\":\"dcfg-yo82mmra\",\"LastConfigName\":\"jolyonzheng-config\",\"LastConfigVersion\":\"v3\",\"NamespaceId\":\"namespace-vw8oox6v\",\"NamespaceName\":\"cluster-jolyonzheng_default\",\"ReleaseDesc\":\"删除配置项\",\"ReleaseStatus\":\"DS\",\"ReleaseTime\":\"2024-12-24 15:57:10\",\"ReleasedConfigCenter\":\"SHARE\",\"RollbackFlag\":true},{\"ClusterId\":\"cluster-yne99jdy\",\"ClusterName\":\"cluster-jolyonzheng\",\"ConfigId\":\"dcfg-yo82mmra\",\"ConfigName\":\"jolyonzheng-config\",\"ConfigReleaseLogId\":\"dcfgrl-ap95jj5v\",\"ConfigVersion\":\"v3\",\"GroupId\":\"group-aln2284v\",\"GroupName\":\"group-provider-1\",\"LastConfigId\":\"dcfg-abo7mowy\",\"LastConfigName\":\"jolyonzheng-config\",\"LastConfigVersion\":\"v2\",\"NamespaceId\":\"namespace-vw8oox6v\",\"NamespaceName\":\"cluster-jolyonzheng_default\",\"ReleaseDesc\":null,\"ReleaseStatus\":\"S\",\"ReleaseTime\":\"2024-12-24 15:56:35\",\"ReleasedConfigCenter\":\"SHARE\",\"RollbackFlag\":true},{\"ClusterId\":\"cluster-yne99jdy\",\"ClusterName\":\"cluster-jolyonzheng\",\"ConfigId\":\"dcfg-abo7mowy\",\"ConfigName\":\"jolyonzheng-config\",\"ConfigReleaseLogId\":\"dcfgrl-v628r2py\",\"ConfigVersion\":\"v2\",\"GroupId\":\"group-aln2284v\",\"GroupName\":\"group-provider-1\",\"LastConfigId\":\"dcfg-vzk3lk8v\",\"LastConfigName\":\"jolyonzheng-config\",\"LastConfigVersion\":\"v1\",\"NamespaceId\":\"namespace-vw8oox6v\",\"NamespaceName\":\"cluster-jolyonzheng_default\",\"ReleaseDesc\":\"This is desc\",\"ReleaseStatus\":\"RS\",\"ReleaseTime\":\"2024-12-23 17:24:24\",\"ReleasedConfigCenter\":\"SHARE\",\"RollbackFlag\":false},{\"ClusterId\":\"cluster-yne99jdy\",\"ClusterName\":\"cluster-jolyonzheng\",\"ConfigId\":\"dcfg-vzk3lk8v\",\"ConfigName\":\"jolyonzheng-config\",\"ConfigReleaseLogId\":\"dcfgrl-a2qj3qoa\",\"ConfigVersion\":\"v1\",\"GroupId\":\"group-aln2284v\",\"GroupName\":\"group-provider-1\",\"LastConfigId\":\"dcfg-abo7mowy\",\"LastConfigName\":\"jolyonzheng-config\",\"LastConfigVersion\":\"v2\",\"NamespaceId\":\"namespace-vw8oox6v\",\"NamespaceName\":\"cluster-jolyonzheng_default\",\"ReleaseDesc\":null,\"ReleaseStatus\":\"S\",\"ReleaseTime\":\"2024-12-23 17:23:46\",\"ReleasedConfigCenter\":\"SHARE\",\"RollbackFlag\":true},{\"ClusterId\":\"cluster-yne99jdy\",\"ClusterName\":\"cluster-jolyonzheng\",\"ConfigId\":\"dcfg-abo7mowy\",\"ConfigName\":\"jolyonzheng-config\",\"ConfigReleaseLogId\":\"dcfgrl-y44wg4qy\",\"ConfigVersion\":\"v2\",\"GroupId\":\"group-aln2284v\",\"GroupName\":\"group-provider-1\",\"LastConfigId\":null,\"LastConfigName\":null,\"LastConfigVersion\":null,\"NamespaceId\":\"namespace-vw8oox6v\",\"NamespaceName\":\"cluster-jolyonzheng_default\",\"ReleaseDesc\":null,\"ReleaseStatus\":\"S\",\"ReleaseTime\":\"2024-12-23 17:23:37\",\"ReleasedConfigCenter\":\"SHARE\",\"RollbackFlag\":false}],\"TotalCount\":6}", "member": "TsfPageConfigReleaseLog", "name": "Result", "type": "object", @@ -12436,7 +12436,7 @@ { "disabled": false, "document": "配置项名称,不传入时查询全量", - "example": "无", + "example": "configName", "member": "string", "name": "ConfigName", "required": false, @@ -12445,7 +12445,7 @@ { "disabled": false, "document": "部署组ID,不传入时查询全量", - "example": "无", + "example": "group-aln2284v", "member": "string", "name": "GroupId", "required": false, @@ -12454,7 +12454,7 @@ { "disabled": false, "document": "命名空间ID,不传入时查询全量", - "example": "无", + "example": "namespace-vw8oox6v", "member": "string", "name": "NamespaceId", "required": false, @@ -12463,7 +12463,7 @@ { "disabled": false, "document": "集群ID,不传入时查询全量", - "example": "无", + "example": "cluster-yne99jdy", "member": "string", "name": "ClusterId", "required": false, @@ -12472,7 +12472,7 @@ { "disabled": false, "document": "每页条数", - "example": "无", + "example": "10", "member": "int64", "name": "Limit", "required": false, @@ -12481,7 +12481,7 @@ { "disabled": false, "document": "偏移量", - "example": "无", + "example": "0", "member": "int64", "name": "Offset", "required": false, @@ -12490,7 +12490,7 @@ { "disabled": false, "document": "配置ID,不传入时查询全量", - "example": "无", + "example": "dcfg-yo82mmra", "member": "string", "name": "ConfigId", "required": false, @@ -12499,7 +12499,7 @@ { "disabled": false, "document": "应用ID,不传入时查询全量", - "example": "无", + "example": "application-a7rwwz4v", "member": "string", "name": "ApplicationId", "required": false, @@ -12514,7 +12514,7 @@ { "disabled": false, "document": "分页的配置发布信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{\"Content\":[{\"ApplicationId\":\"application-a7rwwz4v\",\"ClusterId\":\"cluster-yne99jdy\",\"ClusterName\":\"cluster-jolyonzheng\",\"ConfigCenters\":[{\"ConfigCenterInstanceId\":null,\"ConfigCenterInstanceName\":null,\"ConfigType\":\"SHARE\",\"CurrentVersion\":null,\"RegionId\":null,\"TargetVersion\":null}],\"ConfigId\":\"dcfg-yo82mmra\",\"ConfigName\":\"jolyonzheng-config\",\"ConfigReleaseId\":\"dcfgr-yxd366ov\",\"ConfigVersion\":\"v3\",\"DualStatus\":\"DUAL_STATUS_WRITE_REGISTRATION_OFF\",\"GroupId\":\"group-aln2284v\",\"GroupName\":\"group-provider-1\",\"NamespaceId\":\"namespace-vw8oox6v\",\"NamespaceName\":\"cluster-jolyonzheng_default\",\"ReleaseDesc\":\"This is desc\",\"ReleaseTime\":\"2024-12-24 15:57:15\"}],\"TotalCount\":1}", "member": "TsfPageConfigRelease", "name": "Result", "output_required": true, @@ -12536,7 +12536,7 @@ { "disabled": false, "document": "配置项ID", - "example": "", + "example": "dcfg-vzk36owv", "member": "string", "name": "ConfigId", "required": true, @@ -12551,7 +12551,7 @@ { "disabled": false, "document": "配置项\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "{\"ApplicationId\":\"application-5yr26r9a\",\"ApplicationName\":\"amp-consumer\",\"ConfigId\":\"dcfg-vzk36owv\",\"ConfigName\":\"config_app\",\"ConfigType\":null,\"ConfigValue\":\"config: enabled\",\"ConfigVersion\":\"v1\",\"ConfigVersionCount\":null,\"ConfigVersionDesc\":\"This is desc\",\"CreationTime\":\"2024-12-24 18:04:02\",\"DeleteFlag\":true,\"LastUpdateTime\":null}", "member": "Config", "name": "Result", "type": "object", @@ -12572,7 +12572,7 @@ { "disabled": false, "document": "应用ID,不传入时查询全量", - "example": "application-xxx", + "example": "application-5yr26r9a", "member": "string", "name": "ApplicationId", "required": false, @@ -12581,7 +12581,7 @@ { "disabled": false, "document": "查询关键字,模糊查询:应用名称,配置项名称,不传入时查询全量", - "example": "driver", + "example": "config_app", "member": "string", "name": "SearchWord", "required": false, @@ -12599,7 +12599,7 @@ { "disabled": false, "document": "每页条数,默认为20", - "example": "20", + "example": "10", "member": "int64", "name": "Limit", "required": false, @@ -12608,7 +12608,7 @@ { "disabled": false, "document": "按时间排序:creation_time;按名称排序:config_name", - "example": "config_name", + "example": "creation_time", "member": "string", "name": "OrderBy", "required": false, @@ -12626,7 +12626,7 @@ { "disabled": false, "document": "无", - "example": "无", + "example": "[\"config_app-application-5yr26r9a\"]", "member": "string", "name": "ConfigTagList", "required": false, @@ -12635,7 +12635,7 @@ { "disabled": false, "document": "无", - "example": "无", + "example": "true", "member": "bool", "name": "DisableProgramAuthCheck", "required": false, @@ -12644,7 +12644,7 @@ { "disabled": false, "document": "无", - "example": "无", + "example": "[\"dcfg-vzk36owv\"]", "member": "string", "name": "ConfigIdList", "required": false, @@ -12659,7 +12659,7 @@ { "disabled": false, "document": "配置项分页对象", - "example": "无", + "example": "{\"Content\":[{\"ApplicationId\":\"application-5yr26r9a\",\"ApplicationName\":\"amp-consumer\",\"ConfigId\":\"dcfg-vzk36owv\",\"ConfigName\":\"config_app\",\"ConfigType\":null,\"ConfigValue\":null,\"ConfigVersion\":null,\"ConfigVersionCount\":1,\"ConfigVersionDesc\":null,\"CreationTime\":null,\"DeleteFlag\":null,\"LastUpdateTime\":\"2024-12-24 18:04:02\"}],\"TotalCount\":1}", "member": "TsfPageConfig", "name": "Result", "required": true, @@ -13175,7 +13175,7 @@ { "disabled": false, "document": "部署组id", - "example": "group-xxxxxxx", + "example": "group-ab958z6y", "member": "string", "name": "GroupId", "required": true, @@ -13212,7 +13212,7 @@ { "disabled": false, "document": "投递配置id", - "example": "", + "example": "config-2k8sh4s", "member": "string", "name": "ConfigId", "required": true, @@ -13227,9 +13227,10 @@ { "disabled": false, "document": "投递kafka配置", - "example": "", + "example": "无", "member": "KafkaDeliveryConfig", "name": "Result", + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -13321,7 +13322,7 @@ { "disabled": false, "document": "应用ID", - "example": "", + "example": "application-6a79x94v", "member": "string", "name": "ApplicationId", "required": true, @@ -13330,7 +13331,7 @@ { "disabled": false, "document": "程序包ID", - "example": "", + "example": "pkg-6a79x94v", "member": "string", "name": "PkgId", "required": true, @@ -13339,7 +13340,7 @@ { "disabled": false, "document": "程序包仓库ID", - "example": "", + "example": "application-6a79x94v", "member": "string", "name": "RepositoryId", "required": false, @@ -13348,7 +13349,7 @@ { "disabled": false, "document": "程序包仓库类型", - "example": "", + "example": "tcr", "member": "string", "name": "RepositoryType", "required": false, @@ -13363,9 +13364,10 @@ { "disabled": false, "document": "COS鉴权信息", - "example": "", + "example": "无", "member": "CosDownloadInfo", "name": "Result", + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -13399,7 +13401,7 @@ { "disabled": false, "document": "单元化规则对象\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "{\"CreatedTime\":\"2023-01-17 11:41:36\",\"Description\":\"sssase\",\"GatewayInstanceId\":\"gw-ins-szesmg28\",\"Id\":\"unit-rl-2kdqa2my\",\"Name\":\"test\",\"Status\":\"enabled\",\"UnitRuleItemList\":[{\"CreatedTime\":\"2023-02-10 16:36:12\",\"Description\":\"gsshhshs\",\"DestNamespaceId\":\"namespace-vk5blxnv\",\"DestNamespaceName\":\"heihuli-global_default\",\"Id\":\"unit-item-04futugp\",\"ItemIndex\":1,\"Name\":\"Rule1\",\"Priority\":0,\"Relationship\":\"AND\",\"UnitRuleId\":\"unit-rl-2kdqa2my\",\"UnitRuleTagList\":[{\"CreatedTime\":\"2023-02-10 16:36:12\",\"Id\":\"unit-tag-s2v06uy5\",\"ItemIndex\":1,\"TagField\":\"test\",\"TagOperator\":\"IN\",\"TagType\":\"U\",\"TagValue\":\"test222\",\"UnitRuleItemId\":\"unit-item-04futugp\",\"UpdatedTime\":\"2023-02-10 16:36:12\"},{\"CreatedTime\":\"2023-02-10 16:36:12\",\"Id\":\"unit-tag-jjzz18sp\",\"ItemIndex\":2,\"TagField\":\"xhhshshs\",\"TagOperator\":\"NOT_EQUAL\",\"TagType\":\"U\",\"TagValue\":\"shehhehhdd\",\"UnitRuleItemId\":\"unit-item-04futugp\",\"UpdatedTime\":\"2023-02-10 16:36:12\"}],\"UpdatedTime\":\"2023-02-10 16:36:12\"}],\"UpdatedTime\":\"2023-02-23 17:42:23\"}", + "example": "{\"GatewayInstanceId\":\"gw-ins-szesmg28\",\"Name\":\"rule_app\",\"UnitRuleItemList\":[{\"Name\":\"rule_user\",\"UnitRuleTagList\":[]}]}", "member": "UnitRule", "name": "Result", "type": "object", @@ -13420,7 +13422,7 @@ { "disabled": false, "document": "配置项ID", - "example": "无", + "example": "dcfg-f-v3qqrkdy", "member": "string", "name": "ConfigId", "required": false, @@ -13429,7 +13431,7 @@ { "disabled": false, "document": "配置项名称", - "example": "无", + "example": "conf_app", "member": "string", "name": "ConfigName", "required": false, @@ -13438,7 +13440,7 @@ { "disabled": false, "document": "部署组ID", - "example": "无", + "example": "group-vj3n6lzy", "member": "string", "name": "GroupId", "required": false, @@ -13447,7 +13449,7 @@ { "disabled": false, "document": "命名空间ID", - "example": "无", + "example": "namespace-ygo3djma", "member": "string", "name": "NamespaceId", "required": false, @@ -13456,7 +13458,7 @@ { "disabled": false, "document": "集群ID", - "example": "无", + "example": "cls-f6bk82xc", "member": "string", "name": "ClusterId", "required": false, @@ -13465,7 +13467,7 @@ { "disabled": false, "document": "应用ID", - "example": "无", + "example": "application-vw8ljmwv", "member": "string", "name": "ApplicationId", "required": false, @@ -13474,7 +13476,7 @@ { "disabled": false, "document": "偏移量", - "example": "无", + "example": "0", "member": "int64", "name": "Offset", "required": false, @@ -13483,7 +13485,7 @@ { "disabled": false, "document": "每页条数", - "example": "无", + "example": "10", "member": "int64", "name": "Limit", "required": false, @@ -13498,7 +13500,7 @@ { "disabled": false, "document": "配置项发布信息列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{\"Content\":[{\"ApplicationId\":\"application-vw8ljmwv\",\"ClusterId\":\"cls-f6bk82xc\",\"ClusterName\":\"cluster-container-jolyonzheng\",\"ConfigId\":\"dcfg-f-v3qqrkdy\",\"ConfigName\":\"conf_app\",\"ConfigReleaseId\":\"dcfgr-f-vkjjw7ny\",\"ConfigVersion\":\"2\",\"GroupId\":\"group-vj3n6lzy\",\"GroupName\":\"group-provider\",\"NamespaceId\":\"namespace-ygo3djma\",\"NamespaceName\":\"cluster-container-jolyonzheng_default\",\"ReleaseDesc\":\"This is desc\",\"ReleaseTime\":\"2024-11-28 20:49:57\"}],\"TotalCount\":1}", "member": "TsfPageFileConfigRelease", "name": "Result", "output_required": true, @@ -14095,7 +14097,7 @@ { "disabled": false, "document": "部署组ID", - "example": "group-6a79x94v", + "example": "group-v6q747py", "member": "string", "name": "GroupId", "required": true, @@ -14110,7 +14112,7 @@ { "disabled": false, "document": "部署组发布的相关信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{\"ConfigReleaseList\":[{\"ApplicationId\":\"application-vzoebl8a\",\"ClusterId\":\"cls-i3v5y09e\",\"ClusterName\":\"cls-app\",\"ConfigCenters\":[{\"ConfigCenterInstanceId\":null,\"ConfigCenterInstanceName\":null,\"ConfigType\":\"SHARE\",\"CurrentVersion\":null,\"RegionId\":null,\"TargetVersion\":null}],\"ConfigId\":\"dcfg-a7rl7w4v\",\"ConfigName\":\"conf-app\",\"ConfigReleaseId\":\"dcfgr-ymw5965v\",\"ConfigVersion\":\"v1\",\"DualStatus\":\"DUAL_STATUS_WRITE_REGISTRATION_OFF\",\"GroupId\":\"group-v6q747py\",\"GroupName\":\"cloud-provider\",\"NamespaceId\":\"namespace-vj3z3zgy\",\"NamespaceName\":\"ns_default\",\"ReleaseDesc\":null,\"ReleaseTime\":\"2024-12-24 18:36:03\"}],\"FileConfigReleaseList\":[{\"ApplicationId\":\"application-vzoebl8a\",\"ClusterId\":\"cls-i3v5y09e\",\"ClusterName\":\"cls-app\",\"ConfigId\":\"dcfg-f-aeonjd6y\",\"ConfigName\":\"config_app\",\"ConfigReleaseId\":\"dcfgr-f-y84omela\",\"ConfigVersion\":\"v1\",\"GroupId\":\"group-v6q747py\",\"GroupName\":\"cloud-provider\",\"NamespaceId\":\"namespace-vj3z3zgy\",\"NamespaceName\":\"ns_default\",\"ReleaseDesc\":null,\"ReleaseTime\":\"2024-12-24 18:37:50\"}],\"PackageId\":null,\"PackageName\":null,\"PackageVersion\":null,\"PublicConfigReleaseList\":[{\"ApplicationId\":null,\"ClusterId\":null,\"ClusterName\":null,\"ConfigCenters\":[{\"ConfigCenterInstanceId\":null,\"ConfigCenterInstanceName\":null,\"ConfigType\":\"SHARE\",\"CurrentVersion\":null,\"RegionId\":null,\"TargetVersion\":null}],\"ConfigId\":\"dcfg-p-vzk36rov\",\"ConfigName\":\"config_pub_app\",\"ConfigReleaseId\":\"dcfgr-yne579dy\",\"ConfigVersion\":\"v1\",\"DualStatus\":\"DUAL_STATUS_WRITE_REGISTRATION_OFF\",\"GroupId\":null,\"GroupName\":null,\"NamespaceId\":\"namespace-vj3z3zgy\",\"NamespaceName\":\"ns_default\",\"ReleaseDesc\":null,\"ReleaseTime\":\"2024-12-24 18:36:54\"}],\"RepoName\":\"tsf_100011910000/app-provider\",\"TagName\":\"20241212161801\"}", "member": "GroupRelease", "name": "Result", "output_required": true, @@ -15478,7 +15480,7 @@ { "disabled": false, "document": "命名空间ID", - "example": "namespace-xxxxxxx", + "example": "namespace-v6b2exey", "member": "string", "name": "NamespaceId", "required": true, @@ -15487,7 +15489,7 @@ { "disabled": false, "document": "搜索字段", - "example": "ms-xxxxxxx", + "example": "serviceName", "member": "string", "name": "SearchWord", "required": false, @@ -15496,7 +15498,7 @@ { "disabled": false, "document": "排序字段", - "example": "无", + "example": "create_time", "member": "string", "name": "OrderBy", "required": false, @@ -15505,7 +15507,7 @@ { "disabled": false, "document": "排序类型", - "example": "无", + "example": "1", "member": "int64", "name": "OrderType", "required": false, @@ -15523,7 +15525,7 @@ { "disabled": false, "document": "分页个数", - "example": "1", + "example": "10", "member": "int64", "name": "Limit", "required": false, @@ -15532,7 +15534,7 @@ { "disabled": false, "document": "状态过滤,online、offline、single_online", - "example": "[\"online\"]", + "example": "[\"single_online\"]", "member": "string", "name": "Status", "required": false, @@ -15541,7 +15543,7 @@ { "disabled": false, "document": "IdList", - "example": "[\"ms-xxx\"]", + "example": "[\"ms-yqwbbpxl\"]", "member": "string", "name": "MicroserviceIdList", "required": false, @@ -15550,7 +15552,7 @@ { "disabled": false, "document": "搜索的服务名列表", - "example": "[\"provider\"]", + "example": "[\"consumer-demo\"]", "member": "string", "name": "MicroserviceNameList", "required": false, @@ -15574,7 +15576,7 @@ { "disabled": false, "document": "微服务分页列表信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{\"Content\":[{\"CreateTime\":null,\"CriticalInstanceCount\":0,\"MicroserviceDesc\":\"\",\"MicroserviceId\":\"ms-yqwbbpxl\",\"MicroserviceName\":\"consumer-demo\",\"NamespaceId\":\"namespace-v6b2exey\",\"RunInstanceCount\":1,\"UpdateTime\":null}],\"TotalCount\":1}", "member": "TsfPageMicroservice", "name": "Result", "output_required": true, @@ -15596,7 +15598,7 @@ { "disabled": false, "document": "微服务ID", - "example": "", + "example": "ms-y5w8n5e9", "member": "string", "name": "MicroserviceId", "required": true, @@ -15605,7 +15607,7 @@ { "disabled": false, "document": "搜索关键字", - "example": "", + "example": "echo-feign-url", "member": "string", "name": "SearchWord", "required": false, @@ -15614,7 +15616,7 @@ { "disabled": false, "document": "每页的数量", - "example": "", + "example": "10", "member": "int64", "name": "Limit", "required": false, @@ -15623,7 +15625,7 @@ { "disabled": false, "document": "翻页偏移量", - "example": "", + "example": "0", "member": "int64", "name": "Offset", "required": false, @@ -15638,7 +15640,7 @@ { "disabled": false, "document": "相应结果", - "example": "", + "example": "{\"Content\":[{\"Description\":\"\",\"Method\":\"GET\",\"MsgwApiType\":null,\"Path\":\"/echo-feign-url/{str}\",\"RpcType\":\"http\",\"Status\":1}],\"TotalCount\":1}", "member": "TsfApiListResponse", "name": "Result", "type": "object", @@ -15940,7 +15942,7 @@ { "disabled": false, "document": "分组或者API的ID", - "example": "grp-83wrlmav", + "example": "grp-v446jrhc", "member": "string", "name": "ScopeValue", "required": true, @@ -15958,7 +15960,7 @@ { "disabled": false, "document": "每页展示的条数", - "example": "20", + "example": "10", "member": "int64", "name": "Limit", "required": true, @@ -15976,7 +15978,7 @@ { "disabled": false, "document": "插件类型", - "example": "无", + "example": "QQMiniProgramLogin", "member": "string", "name": "Type", "required": false, @@ -15985,7 +15987,7 @@ { "disabled": false, "document": "搜索关键字", - "example": "无", + "example": "pgnName", "member": "string", "name": "SearchWord", "required": false, @@ -16000,7 +16002,7 @@ { "disabled": false, "document": "插件信息列表", - "example": "无", + "example": "{\"Content\":[{\"CreatedTime\":\"2023-11-28 16:11:28\",\"Description\":\"This is desc\",\"Id\":\"pgn-if8otbfp\",\"Name\":\"pgn-qq\",\"Status\":\"released\",\"Type\":\"QQMiniProgramLogin\",\"UpdatedTime\":\"2023-11-28 16:11:27\"}],\"TotalCount\":1}", "member": "TsfPageGatewayPlugin", "name": "Result", "output_required": true, @@ -16159,7 +16161,7 @@ { "disabled": false, "document": "命名空间ID,不传入时查询全量", - "example": "", + "example": "namespace-vj3z3zgy", "member": "string", "name": "NamespaceId", "required": false, @@ -16168,7 +16170,7 @@ { "disabled": false, "document": "偏移量,默认为0", - "example": "", + "example": "0", "member": "int64", "name": "Offset", "required": false, @@ -16177,7 +16179,7 @@ { "disabled": false, "document": "每页条数,默认为20", - "example": "", + "example": "10", "member": "int64", "name": "Limit", "required": false, @@ -16192,7 +16194,7 @@ { "disabled": false, "document": "分页后的公共配置项发布历史列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "{\"Content\":[{\"ClusterId\":null,\"ClusterName\":null,\"ConfigId\":\"dcfg-p-vzk36rov\",\"ConfigName\":\"[配置项已被删除]\",\"ConfigReleaseLogId\":\"dcfgrl-yrm5jx9v\",\"ConfigVersion\":\"[配置项已被删除]\",\"GroupId\":null,\"GroupName\":null,\"LastConfigId\":\"dcfg-p-vzk36rov\",\"LastConfigName\":\"[配置项已被删除]\",\"LastConfigVersion\":\"[配置项已被删除]\",\"NamespaceId\":\"namespace-vj3z3zgy\",\"NamespaceName\":\"jelly-test_default\",\"ReleaseDesc\":\"删除配置项\",\"ReleaseStatus\":\"DS\",\"ReleaseTime\":\"2024-12-24 20:30:37\",\"RollbackFlag\":false},{\"ClusterId\":null,\"ClusterName\":null,\"ConfigId\":\"dcfg-p-vzk36rov\",\"ConfigName\":\"[配置项已被删除]\",\"ConfigReleaseLogId\":\"dcfgrl-vw83po6v\",\"ConfigVersion\":\"[配置项已被删除]\",\"GroupId\":null,\"GroupName\":null,\"LastConfigId\":null,\"LastConfigName\":null,\"LastConfigVersion\":null,\"NamespaceId\":\"namespace-vj3z3zgy\",\"NamespaceName\":\"jelly-test_default\",\"ReleaseDesc\":null,\"ReleaseStatus\":\"S\",\"ReleaseTime\":\"2024-12-24 18:36:54\",\"RollbackFlag\":false}],\"TotalCount\":2}", "member": "TsfPageConfigReleaseLog", "name": "Result", "type": "object", @@ -16213,7 +16215,7 @@ { "disabled": false, "document": "配置项名称,不传入时查询全量", - "example": "", + "example": "configName", "member": "string", "name": "ConfigName", "required": false, @@ -16222,7 +16224,7 @@ { "disabled": false, "document": "命名空间ID,不传入时查询全量", - "example": "", + "example": "namespace-yxoqm4ky", "member": "string", "name": "NamespaceId", "required": false, @@ -16231,7 +16233,7 @@ { "disabled": false, "document": "每页条数", - "example": "", + "example": "10", "member": "int64", "name": "Limit", "required": false, @@ -16240,7 +16242,7 @@ { "disabled": false, "document": "偏移量", - "example": "", + "example": "0", "member": "int64", "name": "Offset", "required": false, @@ -16249,7 +16251,7 @@ { "disabled": false, "document": "配置项ID,不传入时查询全量", - "example": "", + "example": "dcfg-p-v6kxdlpy", "member": "string", "name": "ConfigId", "required": false, @@ -16264,7 +16266,7 @@ { "disabled": false, "document": "公共配置发布信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "{\"Content\":[{\"ApplicationId\":null,\"ClusterId\":null,\"ClusterName\":null,\"ConfigCenters\":[{\"ConfigCenterInstanceId\":null,\"ConfigCenterInstanceName\":null,\"ConfigType\":\"SHARE\",\"CurrentVersion\":null,\"RegionId\":null,\"TargetVersion\":null}],\"ConfigId\":\"dcfg-p-v6kxdlpy\",\"ConfigName\":\"skye-name\",\"ConfigReleaseId\":\"dcfgr-y446nlby\",\"ConfigVersion\":\"1\",\"DualStatus\":\"DUAL_STATUS_WRITE_REGISTRATION_OFF\",\"GroupId\":null,\"GroupName\":null,\"NamespaceId\":\"namespace-yxoqm4ky\",\"NamespaceName\":\"skye-test_default\",\"ReleaseDesc\":null,\"ReleaseTime\":\"2024-09-11 17:27:59\"}],\"TotalCount\":1}", "member": "TsfPageConfigRelease", "name": "Result", "type": "object", @@ -16285,7 +16287,7 @@ { "disabled": false, "document": "需要查询的配置项ID", - "example": "", + "example": "dcfg-p-vkj5dnky", "member": "string", "name": "ConfigId", "required": true, @@ -16300,7 +16302,7 @@ { "disabled": false, "document": "全局配置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "{\"ApplicationId\":null,\"ApplicationName\":null,\"ConfigId\":\"dcfg-p-vkj5dnky\",\"ConfigName\":\"app-config\",\"ConfigType\":null,\"ConfigValue\":\"config: enabled\",\"ConfigVersion\":\"v1\",\"ConfigVersionCount\":null,\"ConfigVersionDesc\":\"This is desc\",\"CreationTime\":\"2024-12-20 19:16:10\",\"DeleteFlag\":true,\"LastUpdateTime\":null}", "member": "Config", "name": "Result", "type": "object", @@ -16321,7 +16323,7 @@ { "disabled": false, "document": "查询关键字,模糊查询:配置项名称,不传入时查询全量", - "example": "null", + "example": "configName", "member": "string", "name": "SearchWord", "required": false, @@ -16348,7 +16350,7 @@ { "disabled": false, "document": "按时间排序:creation_time;按名称排序:config_name", - "example": "config_name", + "example": "creation_time", "member": "string", "name": "OrderBy", "required": false, @@ -16366,7 +16368,7 @@ { "disabled": false, "document": "无", - "example": "无", + "example": "[\"app-config\"]", "member": "string", "name": "ConfigTagList", "required": false, @@ -16375,7 +16377,7 @@ { "disabled": false, "document": "无", - "example": "无", + "example": "true", "member": "bool", "name": "DisableProgramAuthCheck", "required": false, @@ -16384,7 +16386,7 @@ { "disabled": false, "document": "无", - "example": "无", + "example": "[\"dcfg-p-vkj5dnky\"]", "member": "string", "name": "ConfigIdList", "required": false, @@ -16399,7 +16401,7 @@ { "disabled": false, "document": "分页的全局配置统计信息列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{\"Content\":[{\"ApplicationId\":null,\"ApplicationName\":null,\"ConfigId\":\"dcfg-p-vkj5dnky\",\"ConfigName\":\"app-config\",\"ConfigType\":null,\"ConfigValue\":null,\"ConfigVersion\":null,\"ConfigVersionCount\":1,\"ConfigVersionDesc\":null,\"CreationTime\":null,\"DeleteFlag\":null,\"LastUpdateTime\":\"2024-12-20 19:16:10\"}],\"TotalCount\":1}", "member": "TsfPageConfig", "name": "Result", "required": true, @@ -16503,7 +16505,7 @@ { "disabled": false, "document": "部署组ID", - "example": "", + "example": "group-jy9re3gy", "member": "string", "name": "GroupId", "required": true, @@ -16518,7 +16520,7 @@ { "disabled": false, "document": "已发布的配置内容\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "config: enabled", "member": "string", "name": "Result", "type": "string", @@ -18068,7 +18070,7 @@ { "disabled": false, "document": "网关实体ID", - "example": "", + "example": "gw-ins-szesmg28", "member": "string", "name": "Id", "required": true, @@ -18083,7 +18085,7 @@ { "disabled": false, "document": "返回结果,成功失败\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -18104,7 +18106,7 @@ { "disabled": false, "document": "规则ID", - "example": "", + "example": "unit-rl-u0643wrg", "member": "string", "name": "Id", "required": true, @@ -18119,7 +18121,7 @@ { "disabled": false, "document": "是否成功\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -18186,7 +18188,7 @@ { "disabled": false, "document": "配置项id", - "example": "", + "example": "apm-busi-log-cfg-6a79x94v", "member": "string", "name": "ConfigId", "required": true, @@ -18195,7 +18197,7 @@ { "disabled": false, "document": "部署组id", - "example": "", + "example": "[\"group-6a79x94v\"]", "member": "string", "name": "GroupIds", "required": false, @@ -18210,9 +18212,10 @@ { "disabled": false, "document": "解除绑定是否成功\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "true", "member": "bool", "name": "Result", + "output_required": true, "type": "bool", "value_allowed_null": true }, @@ -18231,7 +18234,7 @@ { "disabled": false, "document": "Api 分组ID", - "example": "", + "example": "grp-d45mlt3o", "member": "string", "name": "GroupId", "required": true, @@ -18246,7 +18249,7 @@ { "disabled": false, "document": "true: 成功, false: 失败", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -18317,7 +18320,7 @@ { "disabled": false, "document": "泳道规则ID", - "example": "无", + "example": "lane-r-yqg4kmbd", "member": "string", "name": "RuleId", "required": true, @@ -18332,7 +18335,7 @@ { "disabled": false, "document": "操作状态。成功:true,失败:false\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "true", "member": "bool", "name": "Result", "output_required": true, @@ -18428,7 +18431,7 @@ { "disabled": false, "document": "网关实体ID", - "example": "", + "example": "gw-ins-szesmg28", "member": "string", "name": "Id", "required": true, @@ -18443,7 +18446,7 @@ { "disabled": false, "document": "返回结果,成功失败\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -18464,7 +18467,7 @@ { "disabled": false, "document": "规则ID", - "example": "", + "example": "unit-rl-u0643wrg", "member": "string", "name": "Id", "required": true, @@ -18479,7 +18482,7 @@ { "disabled": false, "document": "是否成功\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -20054,80 +20057,80 @@ { "disabled": false, "document": "程序包ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "pkg-9198307d", "member": "string", "name": "PackageId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "程序包名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "msgw-zuul1-1.29.20-Hoxton-Higher-RELEASE.jar", "member": "string", "name": "PackageName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "程序包版本\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "20241223010307", "member": "string", "name": "PackageVersion", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "镜像名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "tsf_100011910000/app-provider", "member": "string", "name": "RepoName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "镜像版本\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "20241212161801", "member": "string", "name": "TagName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "已发布的全局配置列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[{\"ApplicationId\":null,\"ClusterId\":null,\"ClusterName\":null,\"ConfigCenters\":[{\"ConfigCenterInstanceId\":null,\"ConfigCenterInstanceName\":null,\"ConfigType\":\"SHARE\",\"CurrentVersion\":null,\"RegionId\":null,\"TargetVersion\":null}],\"ConfigId\":\"dcfg-p-vzk36rov\",\"ConfigName\":\"config_pub_app\",\"ConfigReleaseId\":\"dcfgr-yne579dy\",\"ConfigVersion\":\"v1\",\"DualStatus\":\"DUAL_STATUS_WRITE_REGISTRATION_OFF\",\"GroupId\":null,\"GroupName\":null,\"NamespaceId\":\"namespace-vj3z3zgy\",\"NamespaceName\":\"jelly-test_default\",\"ReleaseDesc\":null,\"ReleaseTime\":\"2024-12-24 18:36:54\"}]", "member": "ConfigRelease", "name": "PublicConfigReleaseList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "已发布的应用配置列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[{\"ApplicationId\":\"application-vzoebl8a\",\"ClusterId\":\"cls-i3v5y09e\",\"ClusterName\":\"jelly-test\",\"ConfigCenters\":[{\"ConfigCenterInstanceId\":null,\"ConfigCenterInstanceName\":null,\"ConfigType\":\"SHARE\",\"CurrentVersion\":null,\"RegionId\":null,\"TargetVersion\":null}],\"ConfigId\":\"dcfg-a7rl7w4v\",\"ConfigName\":\"conf1\",\"ConfigReleaseId\":\"dcfgr-ymw5965v\",\"ConfigVersion\":\"v1\",\"DualStatus\":\"DUAL_STATUS_WRITE_REGISTRATION_OFF\",\"GroupId\":\"group-v6q747py\",\"GroupName\":\"cloud-provider\",\"NamespaceId\":\"namespace-vj3z3zgy\",\"NamespaceName\":\"jelly-test_default\",\"ReleaseDesc\":null,\"ReleaseTime\":\"2024-12-24 18:36:03\"}]", "member": "ConfigRelease", "name": "ConfigReleaseList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "已发布的文件配置列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "[{\"ApplicationId\":\"application-vzoebl8a\",\"ClusterId\":\"cls-i3v5y09e\",\"ClusterName\":\"jelly-test\",\"ConfigId\":\"dcfg-f-aeonjd6y\",\"ConfigName\":\"config_app\",\"ConfigReleaseId\":\"dcfgr-f-y84omela\",\"ConfigVersion\":\"v1\",\"GroupId\":\"group-v6q747py\",\"GroupName\":\"cloud-provider\",\"NamespaceId\":\"namespace-vj3z3zgy\",\"NamespaceName\":\"jelly-test_default\",\"ReleaseDesc\":null,\"ReleaseTime\":\"2024-12-24 18:37:50\"}]", "member": "FileConfigRelease", "name": "FileConfigReleaseList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -20938,7 +20941,7 @@ { "disabled": false, "document": "机器实例ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ins-0xdahvt2", "member": "string", "name": "InstanceId", "output_required": true, @@ -20949,7 +20952,7 @@ { "disabled": false, "document": "机器名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cvm_app", "member": "string", "name": "InstanceName", "output_required": true, @@ -20960,7 +20963,7 @@ { "disabled": false, "document": "机器内网地址IP\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10.0.0.12", "member": "string", "name": "LanIp", "output_required": true, @@ -20971,7 +20974,7 @@ { "disabled": false, "document": "机器外网地址IP\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "10.0.0.1", "member": "string", "name": "WanIp", "output_required": true, @@ -20982,7 +20985,7 @@ { "disabled": false, "document": "机器描述信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "This is desc", "member": "string", "name": "InstanceDesc", "output_required": true, @@ -20993,7 +20996,7 @@ { "disabled": false, "document": "集群ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cls-i3v5y09e", "member": "string", "name": "ClusterId", "output_required": true, @@ -21004,7 +21007,7 @@ { "disabled": false, "document": "集群名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "cls_app", "member": "string", "name": "ClusterName", "output_required": true, @@ -21015,7 +21018,7 @@ { "disabled": false, "document": "VM的状态 虚机:虚机的状态 容器:Pod所在虚机的状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "Running", "member": "string", "name": "InstanceStatus", "output_required": true, @@ -21026,7 +21029,7 @@ { "disabled": false, "document": "VM的可使用状态 虚机:虚机是否能够作为资源使用 容器:虚机是否能够作为资源部署POD\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "Running", "member": "string", "name": "InstanceAvailableStatus", "output_required": true, @@ -21037,7 +21040,7 @@ { "disabled": false, "document": "服务下的服务实例的状态 虚机:应用是否可用 + Agent状态 容器:Pod状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "Running", "member": "string", "name": "ServiceInstanceStatus", "output_required": true, @@ -21048,7 +21051,7 @@ { "disabled": false, "document": "标识此instance是否已添加在tsf中\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "CountInTsf", "output_required": true, @@ -21059,7 +21062,7 @@ { "disabled": false, "document": "机器所属部署组ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "group-xoydmy26", "member": "string", "name": "GroupId", "output_required": true, @@ -21070,7 +21073,7 @@ { "disabled": false, "document": "机器所属应用ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "application-l6ymbvgd", "member": "string", "name": "ApplicationId", "output_required": true, @@ -21081,7 +21084,7 @@ { "disabled": false, "document": "机器所属应用名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "app_provider", "member": "string", "name": "ApplicationName", "output_required": true, @@ -21092,7 +21095,7 @@ { "disabled": false, "document": "机器实例在CVM的创建时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2024-12-16 11:28:01", "member": "string", "name": "InstanceCreatedTime", "output_required": true, @@ -21103,7 +21106,7 @@ { "disabled": false, "document": "机器实例在CVM的过期时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2024-12-16 11:28:01", "member": "string", "name": "InstanceExpiredTime", "output_required": true, @@ -21114,7 +21117,7 @@ { "disabled": false, "document": "机器实例在CVM的计费模式\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "PREPAID", "member": "string", "name": "InstanceChargeType", "output_required": true, @@ -21125,7 +21128,7 @@ { "disabled": false, "document": "机器实例总CPU信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1.9", "member": "float", "name": "InstanceTotalCpu", "output_required": true, @@ -21136,7 +21139,7 @@ { "disabled": false, "document": "机器实例总内存信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2.4473", "member": "float", "name": "InstanceTotalMem", "output_required": true, @@ -21147,7 +21150,7 @@ { "disabled": false, "document": "机器实例使用的CPU信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1.16", "member": "float", "name": "InstanceUsedCpu", "output_required": true, @@ -21158,7 +21161,7 @@ { "disabled": false, "document": "机器实例使用的内存信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1.45", "member": "float", "name": "InstanceUsedMem", "output_required": true, @@ -21169,7 +21172,7 @@ { "disabled": false, "document": "机器实例Limit CPU信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1.5", "member": "float", "name": "InstanceLimitCpu", "output_required": true, @@ -21180,7 +21183,7 @@ { "disabled": false, "document": "机器实例Limit 内存信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2.5", "member": "float", "name": "InstanceLimitMem", "output_required": true, @@ -21191,7 +21194,7 @@ { "disabled": false, "document": "包版本\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "v1", "member": "string", "name": "InstancePkgVersion", "output_required": true, @@ -21202,7 +21205,7 @@ { "disabled": false, "document": "集群类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "C", "member": "string", "name": "ClusterType", "output_required": true, @@ -21213,7 +21216,7 @@ { "disabled": false, "document": "机器实例业务状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "NORMAL", "member": "string", "name": "RestrictState", "output_required": true, @@ -21224,7 +21227,7 @@ { "disabled": false, "document": "更新时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "2024-12-16 11:28:01", "member": "string", "name": "UpdateTime", "output_required": true, @@ -21235,7 +21238,7 @@ { "disabled": false, "document": "实例执行状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "1", "member": "int64", "name": "OperationState", "output_required": true, @@ -21246,7 +21249,7 @@ { "disabled": false, "document": "NamespaceId Ns ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "namespace-96a79v5b", "member": "string", "name": "NamespaceId", "output_required": true, @@ -21257,7 +21260,7 @@ { "disabled": false, "document": "InstanceZoneId 可用区ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "zone-57at58po", "member": "string", "name": "InstanceZoneId", "output_required": true, @@ -21268,7 +21271,7 @@ { "disabled": false, "document": "InstanceImportMode 导入模式\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "M", "member": "string", "name": "InstanceImportMode", "output_required": true, @@ -21279,7 +21282,7 @@ { "disabled": false, "document": "ApplicationType应用类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "C", "member": "string", "name": "ApplicationType", "output_required": true, @@ -21290,7 +21293,7 @@ { "disabled": false, "document": "ApplicationResourceType 资源类型\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "DEF", "member": "string", "name": "ApplicationResourceType", "output_required": true, @@ -21301,7 +21304,7 @@ { "disabled": false, "document": "sidecar状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "up", "member": "string", "name": "ServiceSidecarStatus", "output_required": true, @@ -21312,7 +21315,7 @@ { "disabled": false, "document": "部署组名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "group_app", "member": "string", "name": "GroupName", "output_required": true, @@ -21323,7 +21326,7 @@ { "disabled": false, "document": "NS名\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ns_app", "member": "string", "name": "NamespaceName", "output_required": true, @@ -21334,7 +21337,7 @@ { "disabled": false, "document": "健康检查原因\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "This is desc", "member": "string", "name": "Reason", "output_required": true, @@ -21345,7 +21348,7 @@ { "disabled": false, "document": "agent版本\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "v1", "member": "string", "name": "AgentVersion", "output_required": true, @@ -21356,7 +21359,7 @@ { "disabled": false, "document": "容器母机实例ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "ins-fl5gwz2e", "member": "string", "name": "NodeInstanceId", "output_required": true, @@ -22266,100 +22269,100 @@ { "disabled": false, "document": "泳道规则ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "lane-r-by8n9xyk", "member": "string", "name": "RuleId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "泳道规则名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "rule_app", "member": "string", "name": "RuleName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "优先级\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "1", "member": "int64", "name": "Priority", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "备注\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "This is desc", "member": "string", "name": "Remark", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "泳道规则标签列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "[{\"Id\":\"unit-tag-vmhijoic\",\"UnitRuleItemId\":\"unit-item-ghpuh9rn\",\"TagType\":\"U\",\"TagField\":\"user\",\"TagOperator\":\"IN\",\"TagValue\":\"1\",\"ItemIndex\":1,\"CreatedTime\":\"2024-12-23 11:14:17\",\"UpdatedTime\":\"2024-12-23 11:14:17\"}]", "member": "LaneRuleTag", "name": "RuleTagList", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true }, { "disabled": false, "document": "泳道规则标签关系\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "RELEATION_AND", "member": "string", "name": "RuleTagRelationship", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "泳道ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "lane-zvw7xxy8", "member": "string", "name": "LaneId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "开启状态\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "0", "member": "bool", "name": "Enable", - "required": true, + "output_required": true, "type": "bool", "value_allowed_null": true }, { "disabled": false, "document": "创建时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "1732784732000", "member": "int64", "name": "CreateTime", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "更新时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "1732784732000", "member": "int64", "name": "UpdateTime", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true } @@ -22455,20 +22458,20 @@ { "disabled": false, "document": "总数", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "泳道规则列表", - "example": "", + "example": "[{\"RuleId\":\"lane-r-v6ewp385\",\"RuleName\":\"rule_app\",\"Priority\":1,\"Remark\":\"This is desc\",\"RuleTagList\":null,\"RuleTagRelationship\":\"RELEATION_AND\",\"LaneId\":\"lane-ynmlnwm4\",\"Enable\":true,\"CreateTime\":1725509095000,\"UpdateTime\":1727167548000}]", "member": "LaneRule", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -22753,9 +22756,10 @@ { "disabled": false, "document": "微服务ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "ms-vzge6mz8", "member": "string", "name": "MicroserviceId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -22763,9 +22767,10 @@ { "disabled": false, "document": "微服务名称\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "consumer-demo", "member": "string", "name": "MicroserviceName", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -22773,9 +22778,10 @@ { "disabled": false, "document": "微服务描述\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "This is desc", "member": "string", "name": "MicroserviceDesc", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -22783,9 +22789,10 @@ { "disabled": false, "document": "创建时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "1732784732000", "member": "int64", "name": "CreateTime", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -22793,9 +22800,10 @@ { "disabled": false, "document": "更新时间\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "1732784732000", "member": "int64", "name": "UpdateTime", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -22803,9 +22811,10 @@ { "disabled": false, "document": "命名空间ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "namespace-96a79v5b", "member": "string", "name": "NamespaceId", + "output_required": true, "required": false, "type": "string", "value_allowed_null": true @@ -22813,9 +22822,10 @@ { "disabled": false, "document": "微服务的运行实例数目\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "1", "member": "int64", "name": "RunInstanceCount", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -22823,9 +22833,10 @@ { "disabled": false, "document": "微服务的离线实例数目\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "1", "member": "int64", "name": "CriticalInstanceCount", + "output_required": true, "required": false, "type": "int", "value_allowed_null": true @@ -23222,7 +23233,7 @@ { "disabled": false, "document": "泳道ID", - "example": "无", + "example": "lane-ap62k7ol", "member": "string", "name": "LaneId", "required": true, @@ -23231,7 +23242,7 @@ { "disabled": false, "document": "泳道名称", - "example": "无", + "example": "rule_app", "member": "string", "name": "LaneName", "required": true, @@ -23240,7 +23251,7 @@ { "disabled": false, "document": "备注", - "example": "无", + "example": "This is desc", "member": "string", "name": "Remark", "required": true, @@ -23255,7 +23266,7 @@ { "disabled": false, "document": "更新成功: true / 更新失败: false", - "example": "无", + "example": "true", "member": "bool", "name": "Result", "output_required": true, @@ -23368,7 +23379,7 @@ { "disabled": false, "document": "微服务 ID", - "example": "", + "example": "ms-yd8dr5bx", "member": "string", "name": "MicroserviceId", "required": true, @@ -23377,7 +23388,7 @@ { "disabled": false, "document": "微服务备注信息", - "example": "", + "example": "This is desc", "member": "string", "name": "MicroserviceDesc", "required": true, @@ -23392,7 +23403,7 @@ { "disabled": false, "document": "修改微服务详情是否成功。\ntrue:操作成功。\nfalse:操作失败。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -23477,7 +23488,7 @@ { "disabled": false, "document": "路径重写规则ID", - "example": "", + "example": "rewrite-ba22pbpa", "member": "string", "name": "PathRewriteId", "required": true, @@ -23486,7 +23497,7 @@ { "disabled": false, "document": "正则表达式", - "example": "", + "example": "/consumer", "member": "string", "name": "Regex", "required": false, @@ -23495,7 +23506,7 @@ { "disabled": false, "document": "替换的内容", - "example": "", + "example": "/provider", "member": "string", "name": "Replacement", "required": false, @@ -23504,7 +23515,7 @@ { "disabled": false, "document": "是否屏蔽映射后路径,Y: 是 N: 否", - "example": "", + "example": "N", "member": "string", "name": "Blocked", "required": false, @@ -23513,7 +23524,7 @@ { "disabled": false, "document": "规则顺序,越小优先级越高", - "example": "", + "example": "1", "member": "int64", "name": "Order", "required": false, @@ -23528,7 +23539,7 @@ { "disabled": false, "document": "true/false", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -23803,7 +23814,7 @@ { "disabled": false, "document": "应用ID", - "example": "", + "example": "application-6a79x94v", "member": "string", "name": "ApplicationId", "required": true, @@ -23812,7 +23823,7 @@ { "disabled": false, "document": "调用DescribeUploadInfo接口时返回的软件包ID", - "example": "", + "example": "pkg-6a79x94v", "member": "string", "name": "PkgId", "required": true, @@ -23821,7 +23832,7 @@ { "disabled": false, "document": "COS返回上传结果(默认为0:成功,其他值表示失败)", - "example": "", + "example": "0", "member": "int64", "name": "Result", "required": true, @@ -23830,7 +23841,7 @@ { "disabled": false, "document": "程序包MD5", - "example": "", + "example": "bsij82y9sdnowxohwosjxxxxxxxxxxxxxxxxxxxx", "member": "string", "name": "Md5", "required": true, @@ -23839,7 +23850,7 @@ { "disabled": false, "document": "程序包大小(单位字节)", - "example": "", + "example": "2048", "member": "uint64", "name": "Size", "required": false, @@ -23848,7 +23859,7 @@ { "disabled": false, "document": "程序包仓库类型", - "example": "", + "example": "personal", "member": "string", "name": "RepositoryType", "required": false, @@ -23857,7 +23868,7 @@ { "disabled": false, "document": "程序包仓库id", - "example": "", + "example": "application-6a79x94v", "member": "string", "name": "RepositoryId", "required": false, @@ -23884,60 +23895,60 @@ { "disabled": false, "document": "近24小时调用数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "13412691", "member": "string", "name": "InvocationCountOfDay", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "总调用数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "13412691", "member": "string", "name": "InvocationCount", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "近24小时调用错误数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "292635", "member": "string", "name": "ErrorCountOfDay", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "总调用错误数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "292635", "member": "string", "name": "ErrorCount", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "近24小时调用成功率\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "0.97", "member": "string", "name": "SuccessRatioOfDay", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "总调用成功率\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "0.97", "member": "string", "name": "SuccessRatio", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -24679,60 +24690,60 @@ { "disabled": false, "document": "路径重写规则ID", - "example": "", + "example": "rewrite-96a79v5b", "member": "string", "name": "PathRewriteId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "网关部署组ID", - "example": "", + "example": "group-nalbg4vq", "member": "string", "name": "GatewayGroupId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "正则表达式", - "example": "", + "example": "/echo/(.*)", "member": "string", "name": "Regex", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "替换的内容", - "example": "", + "example": "/gw/provider-demo/echo/$1", "member": "string", "name": "Replacement", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "是否屏蔽映射后路径,Y: 是 N: 否", - "example": "", + "example": "N", "member": "string", "name": "Blocked", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "规则顺序,越小优先级越高", - "example": "", + "example": "1", "member": "int64", "name": "Order", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -24796,20 +24807,20 @@ { "disabled": false, "document": "总记录数", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "路径重写规则列表", - "example": "", + "example": "[{\"PathRewriteId\":\"rewrite-qab42qxv\",\"GatewayGroupId\":\"group-yd3b588a\",\"Regex\":\"/provider_user\",\"Replacement\":\"/consumer_user\",\"Blocked\":\"N\",\"Order\":1}]", "member": "PathRewrite", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -25205,30 +25216,30 @@ { "disabled": false, "document": "属性名称", - "example": "", + "example": "tagName", "member": "string", "name": "Name", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "属性类型", - "example": "", + "example": "string", "member": "string", "name": "Type", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "属性描述\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "tagName", "member": "string", "name": "Description", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -25302,40 +25313,40 @@ { "disabled": false, "document": "最大值\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "295.6", "member": "string", "name": "MaxValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "最小值\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "9.77", "member": "string", "name": "MinValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "五分位值\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "12.51", "member": "string", "name": "FifthPositionValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true }, { "disabled": false, "document": "九分位值\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "15.18", "member": "string", "name": "NinthPositionValue", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": true } @@ -25577,7 +25588,7 @@ { "disabled": false, "document": "Api 分组ID", - "example": "", + "example": "grp-d45mlt3o", "member": "string", "name": "GroupId", "required": true, @@ -25592,7 +25603,7 @@ { "disabled": false, "document": "成功/失败", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -25613,7 +25624,7 @@ { "disabled": false, "document": "配置ID", - "example": "", + "example": "dcfg-vzk36owv", "member": "string", "name": "ConfigId", "required": true, @@ -25622,7 +25633,7 @@ { "disabled": false, "document": "部署组ID", - "example": "", + "example": "group-9yn684ev", "member": "string", "name": "GroupId", "required": true, @@ -25631,7 +25642,7 @@ { "disabled": false, "document": "发布描述", - "example": "", + "example": "This is desc", "member": "string", "name": "ReleaseDesc", "required": false, @@ -25646,7 +25657,7 @@ { "disabled": false, "document": "true:发布成功;false:发布失败", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -25667,7 +25678,7 @@ { "disabled": false, "document": "配置ID", - "example": "无", + "example": "dcfg-yo82mmra", "member": "string", "name": "ConfigId", "required": true, @@ -25676,7 +25687,7 @@ { "disabled": false, "document": "部署组ID", - "example": "无", + "example": "group-aln2284v", "member": "string", "name": "GroupId", "required": true, @@ -25685,7 +25696,7 @@ { "disabled": false, "document": "发布描述", - "example": "w", + "example": "This is desc", "member": "string", "name": "ReleaseDesc", "required": false, @@ -25700,7 +25711,7 @@ { "disabled": false, "document": "配置项发布 ID\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "无", + "example": "{\"ApplicationId\":null,\"ClusterId\":null,\"ClusterName\":null,\"ConfigCenters\":null,\"ConfigId\":null,\"ConfigName\":null,\"ConfigReleaseId\":\"dcfgr-yxd366ov\",\"ConfigVersion\":null,\"DualStatus\":null,\"GroupId\":null,\"GroupName\":null,\"NamespaceId\":null,\"NamespaceName\":null,\"ReleaseDesc\":null,\"ReleaseTime\":null}", "member": "ConfigRelease", "name": "Result", "type": "object", @@ -25776,7 +25787,7 @@ { "disabled": false, "document": "配置ID", - "example": "", + "example": "dcfg-p-vkj5dnky", "member": "string", "name": "ConfigId", "required": true, @@ -25785,7 +25796,7 @@ { "disabled": false, "document": "命名空间ID", - "example": "", + "example": "namespace-vw46q85y", "member": "string", "name": "NamespaceId", "required": true, @@ -25794,7 +25805,7 @@ { "disabled": false, "document": "发布描述", - "example": "", + "example": "This is desc", "member": "string", "name": "ReleaseDesc", "required": false, @@ -25809,7 +25820,7 @@ { "disabled": false, "document": "true:发布成功;false:发布失败\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -26201,7 +26212,7 @@ { "disabled": false, "document": "配置项发布ID", - "example": "", + "example": "dcfgr-y84o2xla", "member": "string", "name": "ConfigReleaseId", "required": true, @@ -26216,7 +26227,7 @@ { "disabled": false, "document": "true:回滚成功;false:回滚失败", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -26237,7 +26248,7 @@ { "disabled": false, "document": "配置项发布ID", - "example": "", + "example": "dcfgr-a7rldd9v", "member": "string", "name": "ConfigReleaseId", "required": true, @@ -26252,7 +26263,7 @@ { "disabled": false, "document": "true:撤销成功;false:撤销失败\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -26273,7 +26284,7 @@ { "disabled": false, "document": "配置项发布ID", - "example": "", + "example": "dcfgr-f-aeon99ry", "member": "string", "name": "ConfigReleaseId", "required": true, @@ -26288,7 +26299,7 @@ { "disabled": false, "document": "撤回结果\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -26869,9 +26880,10 @@ { "disabled": false, "document": "服务名", - "example": "", + "example": "java-demo", "member": "string", "name": "Name", + "output_required": true, "required": true, "type": "string", "value_allowed_null": false @@ -26879,9 +26891,10 @@ { "disabled": false, "document": "端口信息列表", - "example": "", + "example": "无", "member": "Ports", "name": "Ports", + "output_required": true, "required": true, "type": "list", "value_allowed_null": false @@ -26889,9 +26902,10 @@ { "disabled": false, "document": "健康检查配置\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "无", "member": "HealthCheckConfig", "name": "HealthCheck", + "output_required": true, "required": false, "type": "object", "value_allowed_null": true @@ -28901,20 +28915,20 @@ { "disabled": false, "document": "数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "API 列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "[{\"Path\":\"/echo-feign/{str}\",\"Method\":\"GET\",\"Description\":\"This is desc\",\"Status\":1,\"MsgwApiType\":null,\"RpcType\":\"http\"}]", "member": "MsApiArray", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -29036,20 +29050,20 @@ { "disabled": false, "document": "总记录数", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "API分组信息", - "example": "", + "example": "[{\"GroupId\":\"grp-nb08ur29\",\"GatewayInstanceId\":\"gw-ins-b09khqjq\",\"GatewayInstanceType\":null,\"GroupName\":\"grp_app\",\"GroupContext\":\"/grp_app\",\"Status\":\"released\",\"AuthType\":\"none\",\"AclMode\":\"none\",\"Description\":\"\",\"CreatedTime\":\"2024-12-23 01:29:13\",\"UpdatedTime\":\"2024-12-23 01:30:03\",\"GroupType\":\"ms\",\"NamespaceNameKey\":null,\"ServiceNameKey\":null,\"NamespaceNameKeyPosition\":\"path\",\"ServiceNameKeyPosition\":\"path\",\"BindedGatewayDeployGroups\":[{\"DeployGroupId\":\"group-yd3b588a\",\"DeployGroupName\":\"zuul-1\",\"ApplicationId\":\"application-ydopqnxa\",\"ApplicationName\":\"app-gw\",\"ApplicationType\":\"V\",\"GroupStatus\":null,\"ClusterType\":\"V\"}],\"ApiCount\":15,\"ClusterId\":null,\"ClusterName\":null,\"ClusterType\":null,\"GatewayInstanceIdList\":null}]", "member": "ApiGroupInfo", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -29222,20 +29236,20 @@ { "disabled": false, "document": "TsfPageConfig", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "配置项列表", - "example": "", + "example": "[{\"ConfigId\":\"dcfg-vzk3lk8v\",\"ConfigName\":\"jolyonzheng-config\",\"ConfigVersion\":null,\"ConfigVersionDesc\":null,\"ConfigValue\":null,\"CreationTime\":null,\"LastUpdateTime\":\"2024-12-23 17:24:24\",\"ConfigVersionCount\":2,\"ApplicationId\":\"application-a7rwwz4v\",\"ApplicationName\":\"app-jolyonzheng\",\"DeleteFlag\":null,\"ConfigType\":null}]", "member": "Config", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -29248,20 +29262,20 @@ { "disabled": false, "document": "总条数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "配置项发布信息数组\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "[{\"ConfigReleaseId\":\"dcfgr-y5qe2qpy\",\"ConfigId\":\"dcfg-abo7mowy\",\"ConfigName\":\"jolyonzheng-config\",\"ConfigVersion\":\"v2\",\"ReleaseTime\":\"2024-12-23 17:24:24\",\"GroupId\":\"group-aln2284v\",\"GroupName\":\"group-provider\",\"NamespaceId\":\"namespace-vw8oox6v\",\"NamespaceName\":\"cluster-jolyonzheng_default\",\"ClusterId\":\"cluster-yne99jdy\",\"ClusterName\":\"cluster-jolyonzheng\",\"ReleaseDesc\":\"This is desc\",\"ApplicationId\":\"application-a7rwwz4v\",\"ConfigCenters\":[{\"ConfigType\":\"SHARE\",\"ConfigCenterInstanceId\":null,\"ConfigCenterInstanceName\":null,\"RegionId\":null,\"CurrentVersion\":null,\"TargetVersion\":null}],\"DualStatus\":\"DUAL_STATUS_WRITE_REGISTRATION_OFF\"}]", "member": "ConfigRelease", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -29274,20 +29288,20 @@ { "disabled": false, "document": "总条数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "配置项发布日志数组\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "[{\"ConfigReleaseLogId\":\"dcfgrl-v628r2py\",\"ConfigId\":\"dcfg-abo7mowy\",\"ConfigName\":\"jolyonzheng-config\",\"ConfigVersion\":\"v2\",\"GroupId\":\"group-aln2284v\",\"GroupName\":\"group-provider\",\"NamespaceId\":\"namespace-vw8oox6v\",\"NamespaceName\":\"cluster-jolyonzheng_default\",\"ClusterId\":\"cluster-yne99jdy\",\"ClusterName\":\"cluster-jolyonzheng\",\"ReleaseTime\":\"2024-12-23 17:24:24\",\"ReleaseDesc\":\"This is desc\",\"ReleaseStatus\":\"RS\",\"LastConfigId\":\"dcfg-vzk3lk8v\",\"LastConfigName\":\"jolyonzheng-config\",\"LastConfigVersion\":\"v1\",\"RollbackFlag\":false,\"ReleasedConfigCenter\":\"SHARE\"}]", "member": "ConfigReleaseLog", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -29352,20 +29366,20 @@ { "disabled": false, "document": "总数目\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "文件配置数组\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "[{\"ConfigId\":\"dcfg-f-yq75blda\",\"ConfigName\":\"app_config\",\"ConfigVersion\":null,\"ConfigVersionDesc\":null,\"ConfigFileName\":\"config.txt\",\"ConfigFileCode\":\"UTF-8\",\"ConfigFileValue\":null,\"ConfigFilePath\":\"/root/app\",\"ConfigPostCmd\":\"\",\"CreationTime\":null,\"LastUpdateTime\":\"2024-12-20 17:49:05\",\"ConfigVersionCount\":1,\"ApplicationId\":\"application-yx8m24ga\",\"ApplicationName\":\"app_provider\",\"DeleteFlag\":null,\"ConfigFileValueLength\":0}]", "member": "FileConfig", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -29378,20 +29392,20 @@ { "disabled": false, "document": "数量\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "[{\"ConfigReleaseId\":\"dcfgr-f-vkjjw7ny\",\"ConfigId\":\"dcfg-f-v3qqrkdy\",\"ConfigName\":\"config_app\",\"ConfigVersion\":\"2\",\"ReleaseDesc\":null,\"ReleaseTime\":\"2024-11-28 20:49:57\",\"GroupId\":\"group-vj3n6lzy\",\"GroupName\":\"group-provider\",\"NamespaceId\":\"namespace-ygo3djma\",\"NamespaceName\":\"cluster-container_default\",\"ClusterId\":\"cls-f6bk82xc\",\"ClusterName\":\"cluster-container\",\"ApplicationId\":\"application-vw8ljmwv\"}]", "member": "FileConfigRelease", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -29404,20 +29418,20 @@ { "disabled": false, "document": "记录总数", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "记录实体列表", - "example": "", + "example": "[{\"DeployGroupId\":\"group-yd3b588a\",\"DeployGroupName\":\"zuul\",\"ApplicationId\":\"application-ydopqnxa\",\"ApplicationName\":\"app-gw\",\"ApplicationType\":\"V\",\"GroupStatus\":\"Running\",\"ClusterType\":\"V\"}]", "member": "GatewayDeployGroup", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -29430,20 +29444,20 @@ { "disabled": false, "document": "记录总数\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "100", "member": "uint64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "记录实体列表\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "[{\"Id\":\"pgn-iuyb0s7c\",\"Name\":\"asd\",\"Type\":\"OAuth\",\"Description\":\"This is desc\",\"CreatedTime\":\"2024-08-06 16:01:41\",\"UpdatedTime\":\"2024-08-06 16:01:41\",\"Status\":\"released\"}]", "member": "GatewayPlugin", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -29482,20 +29496,20 @@ { "disabled": false, "document": "微服务总数目\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "微服务列表信息\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "[{\"MicroserviceId\":\"ms-vzge6mz8\",\"NamespaceId\":\"namespace-v6b2exey\",\"MicroserviceName\":\"consumer-demo\",\"MicroserviceDesc\":\"This is desc\",\"CreateTime\":null,\"UpdateTime\":null,\"RunInstanceCount\":1,\"CriticalInstanceCount\":0}]", "member": "Microservice", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -29508,20 +29522,20 @@ { "disabled": false, "document": "微服务实例总数目\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": true }, { "disabled": false, "document": "微服务实例列表内容\n注意:此字段可能返回 null,表示取不到有效值。", - "example": "", + "example": "[{\"InstanceId\":\"ins-52kc9krs\",\"InstanceName\":\"未命名\",\"Port\":\"18083\",\"LanIp\":\"10.0.0.3\",\"LanIpv6\":null,\"WanIp\":\"119.29.224.177\",\"ApplicationId\":\"application-5yr26r9a\",\"ApplicationName\":\"app-consumer\",\"GroupId\":\"group-ydk2ewxv\",\"GroupName\":\"app-group\",\"NamespaceId\":null,\"NamespaceName\":null,\"ClusterId\":\"cluster-a2dqmgwv\",\"ClusterName\":\"cls_app\",\"ClusterType\":\"V\",\"InstanceStatus\":null,\"InstanceAvailableStatus\":null,\"ServiceInstanceStatus\":\"Running\",\"HealthCheckUrl\":null,\"ApplicationPackageVersion\":\"20200416204358\",\"ApplicationType\":\"V\",\"HiddenStatus\":\"unhidden\",\"LastHeartbeatTime\":1735026251,\"RegistrationTime\":1730702851,\"RegistrationId\":\"ins-52kc9krs\",\"ServiceStatus\":\"passing\",\"AppMicroServiceType\":\"N\",\"MetaJson\":\"H4sIAAAAAAAAAGXPQWuDMBTA8e+ScwMxrVZ3E5tKoI0hZoPuIpkLTmw1aLW6se8+V0Mvfdf/j8d7P0Cm+yzk/ECjUNKEZXQHXoAy5lzm6lo2NXSnFnttoMDqbiNBFijpkczU2a7RFmHfdSyIRfLKlzVF2/QGTp8V1rdxsJ2yVLIwIgsp6w66uMqDqu0sYOGRpPwhanXRnVG5hoP3gfWopycnT/z/lB3Z28RFEmdvRKTzoXPACCO0cTyMNmvXt0aQeKnKwKJXdfH91fS2vSfs/huaxwO/f4osuQQmAQAA\"}]", "member": "MsInstance", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": true } @@ -29679,25 +29693,25 @@ "usage": "out" }, "TsfPageUnitRule": { - "document": "单元化规则翻页对象\n", + "document": "单元化规则翻页对象", "members": [ { "disabled": false, "document": "记录总数", - "example": "", + "example": "100", "member": "int64", "name": "TotalCount", - "required": true, + "output_required": true, "type": "int", "value_allowed_null": false }, { "disabled": false, "document": "记录实体列表", - "example": "", + "example": "[{\"Id\":\"unit-rl-cgd3l6jo\",\"GatewayInstanceId\":\"gw-ins-szesmg28\",\"Status\":\"disabled\",\"Name\":\"user_unit\",\"Description\":\"This is desc\",\"UnitRuleItemList\":[{\"Id\":\"unit-item-sm6u53ou\",\"UnitRuleId\":\"unit-rl-cgd3l6jo\",\"Relationship\":\"AND\",\"DestNamespaceId\":\"namespace-vk5blxnv\",\"DestNamespaceName\":\"global_default\",\"Name\":\"unit_provider\",\"Priority\":1,\"Description\":\"This is desc\",\"ItemIndex\":1,\"UnitRuleTagList\":[],\"CreatedTime\":\"2024-12-23 17:31:27\",\"UpdatedTime\":\"2024-12-23 17:31:27\"}],\"CreatedTime\":\"2024-12-23 11:14:17\",\"UpdatedTime\":\"2024-12-23 17:31:27\"}]", "member": "UnitRule", "name": "Content", - "required": true, + "output_required": true, "type": "list", "value_allowed_null": false } @@ -29762,7 +29776,7 @@ { "disabled": false, "document": "分组网关id列表", - "example": "", + "example": "[{\"GatewayDeployGroupId\":\"group-yo99lney\",\"GroupId\":\"grp-notmqbpe\"}]", "member": "GatewayGroupIds", "name": "GroupGatewayList", "required": true, @@ -29777,7 +29791,7 @@ { "disabled": false, "document": "返回结果,成功失败", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -30174,7 +30188,7 @@ { "disabled": false, "document": "Api 分组ID", - "example": "grp-grp-5yk7oor1", + "example": "grp-notmqbpe", "member": "string", "name": "GroupId", "required": true, @@ -30183,7 +30197,7 @@ { "disabled": false, "document": "Api 分组名称", - "example": "new-name", + "example": "grp_app", "member": "string", "name": "GroupName", "required": false, @@ -30192,7 +30206,7 @@ { "disabled": false, "document": "Api 分组描述", - "example": "test", + "example": "This is desc", "member": "string", "name": "Description", "required": false, @@ -30210,7 +30224,7 @@ { "disabled": false, "document": "分组上下文", - "example": "/user", + "example": "/grp_app", "member": "string", "name": "GroupContext", "required": false, @@ -30283,7 +30297,7 @@ { "disabled": false, "document": "限流规则ID", - "example": "", + "example": "rule-8qlpdumd", "member": "string", "name": "RuleId", "required": true, @@ -30292,7 +30306,7 @@ { "disabled": false, "document": "开启/禁用,enabled/disabled", - "example": "", + "example": "enabled", "member": "string", "name": "UsableStatus", "required": true, @@ -30301,7 +30315,7 @@ { "disabled": false, "document": "qps值,开启限流规则时,必填", - "example": "", + "example": "2000", "member": "int64", "name": "MaxQps", "required": false, @@ -30316,7 +30330,7 @@ { "disabled": false, "document": "是否成功", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -30337,7 +30351,7 @@ { "disabled": false, "document": "API ID 列表", - "example": "", + "example": "[\"api-b1sd366q\"]", "member": "string", "name": "ApiIds", "required": true, @@ -30346,7 +30360,7 @@ { "disabled": false, "document": "开启/禁用,enabled/disabled", - "example": "", + "example": "enabled", "member": "string", "name": "UsableStatus", "required": true, @@ -30355,7 +30369,7 @@ { "disabled": false, "document": "QPS值。开启限流规则时,必填", - "example": "", + "example": "1000", "member": "int64", "name": "MaxQps", "required": false, @@ -30370,7 +30384,7 @@ { "disabled": false, "document": "是否成功", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", @@ -30391,7 +30405,7 @@ { "disabled": false, "document": "API ID 列表", - "example": "无", + "example": "[\"api-tnvxy4ta\"]", "member": "string", "name": "ApiIds", "required": true, @@ -30400,7 +30414,7 @@ { "disabled": false, "document": "开启/禁用,enabled/disabled", - "example": "无", + "example": "enabled", "member": "string", "name": "UsableStatus", "required": true, @@ -30409,7 +30423,7 @@ { "disabled": false, "document": "超时时间,单位毫秒,开启API超时时,必填", - "example": "无", + "example": "2000", "member": "int64", "name": "Timeout", "required": false, @@ -30424,10 +30438,10 @@ { "disabled": false, "document": "是否成功", - "example": "无", + "example": "true", "member": "bool", "name": "Result", - "required": true, + "output_required": true, "type": "bool", "value_allowed_null": false }, @@ -30519,7 +30533,7 @@ { "disabled": false, "document": "API ID", - "example": "", + "example": "api-zwua4plw", "member": "string", "name": "ApiId", "required": true, @@ -30528,7 +30542,7 @@ { "disabled": false, "document": "API 路径", - "example": "", + "example": "/echo-user", "member": "string", "name": "Path", "required": false, @@ -30537,7 +30551,7 @@ { "disabled": false, "document": "Api 请求方法", - "example": "", + "example": "GET", "member": "string", "name": "Method", "required": false, @@ -30546,7 +30560,7 @@ { "disabled": false, "document": "请求映射", - "example": "", + "example": "/echo-user", "member": "string", "name": "PathMapping", "required": false, @@ -30555,7 +30569,7 @@ { "disabled": false, "document": "api所在服务host", - "example": "", + "example": "http://www.qq.com", "member": "string", "name": "Host", "required": false, @@ -30564,7 +30578,7 @@ { "disabled": false, "document": "api描述信息", - "example": "", + "example": "this is desc", "member": "string", "name": "Description", "required": false, @@ -30579,7 +30593,7 @@ { "disabled": false, "document": "返回结果,成功失败", - "example": "", + "example": "true", "member": "bool", "name": "Result", "type": "bool", diff --git a/tccli/services/tsf/v20180326/examples.json b/tccli/services/tsf/v20180326/examples.json index 2c1194a68a..770ee7b709 100644 --- a/tccli/services/tsf/v20180326/examples.json +++ b/tccli/services/tsf/v20180326/examples.json @@ -35,8 +35,8 @@ "BindApiGroup": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=BindApiGroup\n&GroupGatewayList.0.GatewayDeployGroupId=group-sdy268\n&GroupGatewayList.0.GroupId=grp-s2gf2a8\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e05507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BindApiGroup\n<公共请求参数>\n\n{\n \"GroupGatewayList\": [\n {\n \"GatewayDeployGroupId\": \"group-yo99lney\",\n \"GroupId\": \"grp-djvzrdih\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"5714c887-aa81-4347-864c-2ea5cb078d63\",\n \"Result\": true\n }\n}", "title": "网关与API分组批量绑定" } ], @@ -67,24 +67,24 @@ "CreateAllGatewayApiAsync": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=CreateAllGatewayApiAsync\n&GroupId=grp-5yk7oor1\n&MicroserviceId=ms-2vz549vp\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAllGatewayApiAsync\n<公共请求参数>\n\n{\n \"GroupId\": \"grp-notmqbpe\",\n \"MicroserviceId\": \"ms-y5w8n5e9\",\n \"NamespaceId\": \"namespace-v3gw3lna\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"2471e0f2-59f2-4bc0-bc2b-4cbe457247b9\",\n \"Result\": true\n }\n}", "title": "一键导入微服务的网关分组API" } ], "CreateApiGroup": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApiGroup\n<公共请求参数>\n\n{\n \"GroupName\": \"zuul_test_group\",\n \"GroupContext\": \"%2Fuser\",\n \"AuthType\": \"none\",\n \"Description\": \"test\",\n \"NamespaceNameKey\": \"TSF-NamespaceName\",\n \"ServiceNameKey\": \"TSF-ServiceName\",\n \"NamespaceNameKeyPosition\": \"path\",\n \"ServiceNameKeyPosition\": \"path\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e05507e42d5970cd2e25ed5267a\",\n \"Result\": \"grp-57at58po\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApiGroup\n<公共请求参数>\n\n{\n \"GroupName\": \"grp_user\",\n \"GroupContext\": \"/grp_user\",\n \"AuthType\": \"none\",\n \"Description\": \"This is desc\",\n \"GroupType\": \"ms\",\n \"GatewayInstanceId\": \"gw-ins-szesmg28\",\n \"NamespaceNameKey\": \"TSF-NamespaceName\",\n \"ServiceNameKey\": \"TSF-ServiceName\",\n \"NamespaceNameKeyPosition\": \"path\",\n \"ServiceNameKeyPosition\": \"path\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"156db4f2-9d4e-48bc-87eb-539a46919107\",\n \"Result\": \"grp-rzn41l1w\"\n }\n}", "title": "创建API分组" } ], "CreateApiRateLimitRule": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=CreateApiRateLimitRule\n&ApiId=api-uk1098lc1\n&MaxQps=100\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApiRateLimitRule\n<公共请求参数>\n\n{\n \"ApiId\": \"api-8c7538te\",\n \"UsableStatus\": \"enabled\",\n \"MaxQps\": 10000\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"af8bda56-e2f3-440f-a05c-25d63bdc397e\",\n \"Result\": true\n }\n}", "title": "创建API限流规则" } ], @@ -115,24 +115,24 @@ "CreateConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=CreateConfig\n&ApplicationId=application-gyq2xry5\n&ConfigName=test_openapi_config\n&ConfigVersion=v1.0\n&ConfigValue=api.invok.limit: 5000\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"8007ea57-6d26-43db-aa75-ad72cb3669ca\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConfig\n<公共请求参数>\n\n{\n \"ConfigName\": \"config_app\",\n \"ConfigVersion\": \"v1\",\n \"ConfigVersionDesc\": \"This is desc\",\n \"ConfigValue\": \"config: enabled\",\n \"ApplicationId\": \"application-5yr26r9a\",\n \"ConfigType\": \"application\",\n \"EncodeWithBase64\": true,\n \"ProgramIdList\": [\n \"program-6a79x94v\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"fa979523-5509-4073-89b8-65c2bf86ff9a\",\n \"Result\": true\n }\n}", "title": "创建配置项" } ], "CreateConfigTemplate": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=CreateConfigTemplate\n&ConfigTemplateName=配置1\n&ConfigTemplateDesc=11111111111\n&ConfigTemplateType=Ribbon\n&ConfigTemplateValue=#请求处理超时时间\nribbon.ReadTimeout: 5000\n#请求连接超时时间\nribbon.ConnectTimeout: 2000\n#同一实例最大重试次数,不包括首次调用\nribbon.MaxAutoRetries: 0\n#重试其他实例的最大重试次数,不包括首次所选的server\nribbon.MaxAutoRetriesNextServer: 1\n#是否对所有操作请求都进行重试\nribbon.OkToRetryOnAllOperations: false\n\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"841f10d8-24e7-471b-ad8a-b401d9dcbe70\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConfigTemplate\n<公共请求参数>\n\n{\n \"ConfigTemplateName\": \"config_temp_app\",\n \"ConfigTemplateDesc\": \"This is desc\",\n \"ConfigTemplateType\": \"Ribbon\",\n \"ConfigTemplateValue\": \"#请求处理超时时间\\\\nribbon.ReadTimeout: 5000\\\\n#请求连接超时时间\\\\nribbon.ConnectTimeout: 2000\\\\n#同一实例最大重试次数,不包括首次调用\\\\nribbon.MaxAutoRetries: 0\\\\n#重试其他实例的最大重试次数,不包括首次所选的server\\\\nribbon.MaxAutoRetriesNextServer: 1\\\\n#是否对所有操作请求都进行重试\\\\nribbon.OkToRetryOnAllOperations: false\\\\n\",\n \"ProgramIdList\": [\n \"program-6a79x94v\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"829c771a-2e0f-4858-8d5a-3f63ddf2f739\",\n \"Result\": true\n }\n}", "title": "配置模板创建" } ], "CreateConfigTemplateWithDetailResp": [ { "document": "创建配置模板", - "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConfigTemplateWithDetailResp\n<公共请求参数>\n\n{\n \"ConfigTemplateName\": \"abc\",\n \"ConfigTemplateDesc\": \"abc\",\n \"ConfigTemplateType\": \"abc\",\n \"ConfigTemplateValue\": \"abc\",\n \"ProgramIdList\": [\n \"abc\"\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"ConfigTemplateId\": \"abc\",\n \"ConfigTemplateName\": \"abc\",\n \"ConfigTemplateDesc\": \"abc\",\n \"ConfigTemplateType\": \"abc\",\n \"ConfigTemplateValue\": \"abc\",\n \"CreateTime\": \"abc\",\n \"UpdateTime\": \"abc\"\n },\n \"RequestId\": \"xxxxxxxxxxx\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConfigTemplateWithDetailResp\n<公共请求参数>\n\n{\n \"ConfigTemplateName\": \"config_temp\",\n \"ConfigTemplateDesc\": \"This is desc\",\n \"ConfigTemplateType\": \"Ribbon\",\n \"ConfigTemplateValue\": \"#请求处理超时时间\\\\\\\\nribbon.ReadTimeout: 5000\\\\\\\\n#请求连接超时时间\\\\\\\\nribbon.ConnectTimeout: 2000\\\\\\\\n#同一实例最大重试次数,不包括首次调用\\\\\\\\nribbon.MaxAutoRetries: 0\\\\\\\\n#重试其他实例的最大重试次数,不包括首次所选的server\\\\\\\\nribbon.MaxAutoRetriesNextServer: 1\\\\\\\\n#是否对所有操作请求都进行重试\\\\\\\\nribbon.OkToRetryOnAllOperations: false\\\\\\\\n\",\n \"ProgramIdList\": [\n \"program-6a79x94v\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"6d940d10-9545-4481-bbc2-eb0d6016f069\",\n \"Result\": {\n \"ConfigTemplateDesc\": \"This is desc\",\n \"ConfigTemplateId\": \"dcfg_temp-ymw5o65v\",\n \"ConfigTemplateName\": \"config_temp\",\n \"ConfigTemplateType\": \"Ribbon\",\n \"ConfigTemplateValue\": \"#请求处理超时时间\\\\\\\\nribbon.ReadTimeout: 5000\\\\\\\\n#请求连接超时时间\\\\\\\\nribbon.ConnectTimeout: 2000\\\\\\\\n#同一实例最大重试次数,不包括首次调用\\\\\\\\nribbon.MaxAutoRetries: 0\\\\\\\\n#重试其他实例的最大重试次数,不包括首次所选的server\\\\\\\\nribbon.MaxAutoRetriesNextServer: 1\\\\\\\\n#是否对所有操作请求都进行重试\\\\\\\\nribbon.OkToRetryOnAllOperations: false\\\\\\\\n\",\n \"CreateTime\": null,\n \"UpdateTime\": null\n }\n }\n}", "title": "创建配置模板" } ], @@ -155,8 +155,8 @@ "CreateFileConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=CreateFileConfig\n&ApplicationId=application-dapbkdgy\n&ConfigName=war-config\n&ConfigVersion=1\n&ConfigFileName=update\n&ConfigFileCode=utf-8\n&ConfigPostCmd=/usr/bin/bash\n&ConfigFileValue=workdir\n&ConfigFilePath=/root\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"3063d6c8-9801-4ed0-b306-be14b89f6133\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFileConfig\n<公共请求参数>\n\n{\n \"ConfigName\": \"config_app\",\n \"ConfigVersion\": \"v1\",\n \"ConfigVersionDesc\": \"This is desc\",\n \"ConfigFileName\": \"conf.txt\",\n \"ConfigFileValue\": \"config=enabled\",\n \"ConfigFileCode\": \"utf-8\",\n \"ApplicationId\": \"application-5yr26r9a\",\n \"ConfigFilePath\": \"/root\",\n \"ConfigPostCmd\": \"sh start.sh\",\n \"EncodeWithBase64\": true,\n \"ProgramIdList\": [\n \"program-6a79x94v\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"880b83c3-1018-4922-ab11-1822d5d5981d\",\n \"Result\": true\n }\n}", "title": "创建文件配置项" } ], @@ -171,8 +171,8 @@ "CreateGatewayApi": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=CreateGatewayApi\n&GroupId=grp-5yk7oor1\n&ApiList.0.NamespaceId=ns-do1n280j\n&ApiList.0.MicroserviceId=ms-sf26d1gf1\n&ApiList.0.Path=/user/find\n&ApiList.0.Method=POST\n&ApiList.0.PathMapping=/user/find\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateGatewayApi\n<公共请求参数>\n\n{\n \"GroupId\": \"grp-djvzrdih\",\n \"ApiList\": [\n {\n \"NamespaceId\": \"namespace-external\",\n \"MicroserviceId\": \"ms-external\",\n \"Path\": \"/echo_user\",\n \"Method\": \"GET\",\n \"PathMapping\": \"/echo_user\",\n \"Host\": \"http://www.qq.com\",\n \"Description\": \"This is desc\"\n }\n ],\n \"ProgramIdList\": [\n \"program-6a79x94v\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"e521be92-af1e-4d1c-bcd9-31bfe1ff0859\",\n \"Result\": true\n }\n}", "title": "批量导入API至api分组" } ], @@ -203,8 +203,8 @@ "CreateMicroservice": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=CreateMicroservice\r\n&NamespaceId=namespace-xxxxxxx\r\n&MicroserviceName=consumer-demo1\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"2bb5b35d-cdad-45a0-96ce-bc48abe98cc7\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateMicroservice\n<公共请求参数>\n\n{\n \"NamespaceId\": \"namespace-v3gw3lna\",\n \"MicroserviceName\": \"provider-app\",\n \"MicroserviceDesc\": \"This is desc\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"f0c42921-ff15-4718-a296-20403124f81b\",\n \"Result\": true\n }\n}", "title": "创建微服务示例" } ], @@ -235,8 +235,8 @@ "CreatePathRewritesWithDetailResp": [ { "document": "创建路径重写规则", - "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePathRewritesWithDetailResp\n<公共请求参数>\n\n{\n \"PathRewrites\": [\n {\n \"GatewayGroupId\": \"abc\",\n \"Regex\": \"abc\",\n \"Replacement\": \"abc\",\n \"Blocked\": \"abc\",\n \"Order\": 0\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"Result\": [\n \"abc\"\n ],\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePathRewritesWithDetailResp\n<公共请求参数>\n\n{\n \"PathRewrites\": [\n {\n \"GatewayGroupId\": \"group-ldap5yok\",\n \"Regex\": \"/consumer\",\n \"Replacement\": \"/provider\",\n \"Blocked\": \"N\",\n \"Order\": 1\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"29e9b18a-2886-4582-bc14-fdb56aa49c8c\",\n \"Result\": [\n \"rewrite-py5r7b6v\"\n ]\n }\n}", "title": "批量创建路径重写" } ], @@ -251,8 +251,8 @@ "CreatePublicConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=CreatePublicConfig\n&ConfigName=testconfig\n&ConfigVersion=1.3\n&ConfigValue=tsf.inventory.password.encrypt2:%20ENC(3M7wGw2XtFc5Y+rxOgNBLrm2spUtgodjIxa+7F3XcAo=)\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"3d600e1f-87c3-4aa6-afa5-a4f8330fa181\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePublicConfig\n<公共请求参数>\n\n{\n \"ConfigName\": \"config_pub_app\",\n \"ConfigVersion\": \"v1\",\n \"ConfigVersionDesc\": \"This is desc\",\n \"ConfigValue\": \"config: enabled\",\n \"ConfigType\": \"public\",\n \"EncodeWithBase64\": true,\n \"ProgramIdList\": [\n \"program-6a79x94v\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"a1563762-2470-42d0-a35f-6a03a05d2457\",\n \"Result\": true\n }\n}", "title": "创建公共配置项" } ], @@ -315,8 +315,8 @@ "DeleteApiGroup": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DeleteApiGroup\n&GroupId=grp-5yk7oor1\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e05507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteApiGroup\n<公共请求参数>\n\n{\n \"GroupId\": \"grp-glt0lr13\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"444e5ead-5dd2-4df5-bfc6-fce580cb0a31\",\n \"Result\": true\n }\n}", "title": "删除Api分组" } ], @@ -347,8 +347,8 @@ "DeleteConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DeleteConfig\n&ConfigId=dcfg-gvkgdjyo\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"aa19a76d-340f-4ed3-a8d7-b4c12a62ee3e\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteConfig\n<公共请求参数>\n\n{\n \"ConfigId\": \"dcfg-a7rl7w4v\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"b1ec0d59-5901-4265-9a4c-9c0489a2cbcd\",\n \"Result\": true\n }\n}", "title": "删除配置项" } ], @@ -371,16 +371,16 @@ "DeleteFileConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DeleteFileConfig\r\n&ConfigId=dcfg-f-6yol6nyl\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"36c611a9-86d4-4e15-9400-e779682c408e\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteFileConfig\n<公共请求参数>\n\n{\n \"ConfigId\": \"dcfg-f-aeonjd6y\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"db1b2acf-5cd5-4249-9c20-c08a79948019\",\n \"Result\": true\n }\n}", "title": "删除文件配置项" } ], "DeleteGatewayApi": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DeleteGatewayApi\r\n&GroupId=grp-5yk7oor1\r\n&ApiIdList.0=api-d5970cd2\r\n&ApiIdList.1=api-d5970cd3\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGatewayApi\n<公共请求参数>\n\n{\n \"GroupId\": \"grp-notmqbpe\",\n \"ApiList\": [\n \"api-8c7538te\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"d54416e7-d75b-4fdd-860b-612f465db1f4\",\n \"Result\": true\n }\n}", "title": "批量删除API" } ], @@ -403,8 +403,8 @@ "DeleteLane": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DeleteLane\r\n&LaneId=lane-6ymrl42a\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteLane\n<公共请求参数>\n\n{\n \"LaneId\": \"lane-y9o6w958\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"40bb8670-043a-478c-b85f-157b1f552d56\",\n \"Result\": true\n }\n}", "title": "删除泳道" } ], @@ -419,8 +419,8 @@ "DeleteMicroservice": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DeleteMicroservice\r\n&MicroserviceId=ms-xxxxxxx\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"97f5554f-8d66-4eac-802d-2f36dc2a7124\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteMicroservice\n<公共请求参数>\n\n{\n \"MicroserviceId\": \"ms-vzg9kzj3\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"ea8639e6-a455-49f7-84f2-ae6d0a9b05b1\",\n \"Result\": true\n }\n}", "title": "删除微服务示例" } ], @@ -435,8 +435,8 @@ "DeletePathRewrites": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DeletePathRewrites\n&PathRewriteIds.0=rewrite-l6ymbvgd\n&PathRewriteIds.1=rewrite-s7j2kkh39\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeletePathRewrites\n<公共请求参数>\n\n{\n \"PathRewriteIds\": [\n \"rewrite-qv3rrlnv\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"ded2dfb4-4eea-4eea-970c-ace085804bf3\",\n \"Result\": true\n }\n}", "title": "删除路径重写" } ], @@ -451,8 +451,8 @@ "DeletePublicConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DeletePublicConfig\n&ConfigId=dcfg-p-zvwgl6y8\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"839449d1-9ea3-45a8-94b9-4f9beecb8a45\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeletePublicConfig\n<公共请求参数>\n\n{\n \"ConfigId\": \"dcfg-p-vzk36rov\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"32ea862f-ecbc-477a-9edd-0c8597f881f1\",\n \"Result\": true\n }\n}", "title": "删除公共配置项" } ], @@ -491,8 +491,8 @@ "DeleteUnitRule": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DeleteUnitRule\n&Id=rule-ins-afsfas\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteUnitRule\n<公共请求参数>\n\n{\n \"Id\": \"unit-rl-cgd3l6jo\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"27dbfb99-0406-4279-8a3a-2f3523236d6c\",\n \"Result\": true\n }\n}", "title": "删除单元化规则" } ], @@ -515,8 +515,8 @@ "DescribeApiDetail": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeApiDetail\r\n&MicroserviceId=ms-2vzprpyp\r\n&Path=/facade/supplier/test\r\n&Method=POST\r\n&ApplicationId=application-gvkw2ejv\r\n&PkgVersion=jenkins-prod-supplier-1\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"b8427f00-c974-47b1-9827-978cdb043b9d\",\n \"Result\": {\n \"Request\": [\n {\n \"Name\": \"supplierId\",\n \"Type\": \"string\",\n \"Description\": \"supplierId\",\n \"Required\": true,\n \"In\": \"query\"\n }\n ],\n \"Response\": [\n {\n \"Name\": \"Res«Supplier»\",\n \"Type\": \"#/Definitions/Res«Supplier»\",\n \"Description\": \"OK\"\n }\n ],\n \"Definitions\": [\n {\n \"Name\": \"Supplier\",\n \"Properties\": [\n {\n \"Name\": \"abbrName\",\n \"Type\": \"string\"\n },\n {\n \"Name\": \"coordinatesSystem\",\n \"Type\": \"integer(int32)\"\n },\n {\n \"Name\": \"createTime\",\n \"Type\": \"string(date-time)\"\n },\n {\n \"Name\": \"id\",\n \"Type\": \"string\"\n },\n {\n \"Name\": \"invoiceLineNum\",\n \"Type\": \"integer(int32)\"\n },\n {\n \"Name\": \"invoiceMaxFee\",\n \"Type\": \"integer(int64)\"\n },\n {\n \"Name\": \"invoiceMinFee\",\n \"Type\": \"integer(int64)\"\n },\n {\n \"Name\": \"invoiceType\",\n \"Type\": \"integer(int32)\"\n },\n {\n \"Name\": \"isActive\",\n \"Type\": \"integer(int32)\"\n },\n {\n \"Name\": \"isTripEnable\",\n \"Type\": \"integer(int32)\"\n },\n {\n \"Name\": \"logo\",\n \"Type\": \"string\"\n },\n {\n \"Name\": \"name\",\n \"Type\": \"string\"\n },\n {\n \"Name\": \"priceRuleUrl\",\n \"Type\": \"string\"\n },\n {\n \"Name\": \"servicePhone\",\n \"Type\": \"string\"\n },\n {\n \"Name\": \"signKey\",\n \"Type\": \"string\"\n },\n {\n \"Name\": \"updateTime\",\n \"Type\": \"string(date-time)\"\n }\n ]\n },\n {\n \"Name\": \"Res«Supplier»\",\n \"Properties\": [\n {\n \"Name\": \"code\",\n \"Type\": \"integer(int32)\"\n },\n {\n \"Name\": \"data\",\n \"Type\": \"#/Definitions/Supplier\"\n },\n {\n \"Name\": \"errmsg\",\n \"Type\": \"string\"\n },\n {\n \"Name\": \"success\",\n \"Type\": \"boolean\"\n }\n ]\n }\n ]\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeApiDetail\n<公共请求参数>\n\n{\n \"MicroserviceId\": \"ms-y5w8n5e9\",\n \"Path\": \"/user-feign\",\n \"Method\": \"GET\",\n \"PkgVersion\": \"20210625192924\",\n \"ApplicationId\": \"application-yn3zdj9v\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"93c8e28a-196e-46a3-b903-b74ddcf7ce26\",\n \"Result\": {\n \"CanRun\": true,\n \"Definitions\": [\n {\n \"Name\": \"\",\n \"Properties\": [\n {\n \"Description\": \"\",\n \"Name\": \"\",\n \"Type\": \"\"\n }\n ]\n }\n ],\n \"Description\": \"feignMeshUser\",\n \"Request\": [\n {\n \"DefaultValue\": null,\n \"Description\": \"tagName\",\n \"In\": \"query\",\n \"Name\": \"tagName\",\n \"Required\": false,\n \"Type\": \"string\"\n },\n {\n \"DefaultValue\": null,\n \"Description\": \"tagValue\",\n \"In\": \"query\",\n \"Name\": \"tagValue\",\n \"Required\": false,\n \"Type\": \"string\"\n }\n ],\n \"RequestContentType\": null,\n \"Response\": [\n {\n \"Description\": \"OK\",\n \"Name\": \"_RESPONSE\",\n \"Type\": \"string\"\n }\n ],\n \"Status\": 1\n }\n }\n}", "title": "查询API详情" } ], @@ -627,32 +627,32 @@ "DescribeConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeConfig\r\n&ConfigId=dcfg-qabr26yl\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"2e68ea83-3799-4fb0-ba9b-ab8be2488d98\",\n \"Result\": {\n \"ConfigId\": \"dcfg-qabr26yl\",\n \"ConfigName\": \"test_pay_center\",\n \"ConfigVersion\": \"0.0.9\",\n \"ConfigVersionDesc\": \"默认100元\",\n \"ConfigValue\": \"facade:\\r\\n white-list:\\r\\n - 10.3.1.34\\r\\n - 10.3.1.32\\r\\n - 212.64.13.188\\r\\n - 172.16.0.192\\r\\norder:\\r\\n amount:\\r\\n min: 1\\r\\n wxScoreMin: 1\\r\\n wxScoreMax: 20000 \\r\\n enterpriseAmount: 10000 \\r\\n refundAmountMax: 1000000 \",\n \"CreationTime\": \"2019-05-28 20:23:35\",\n \"LastUpdateTime\": null,\n \"ConfigVersionCount\": null,\n \"ApplicationId\": \"application-6ym9pbag\",\n \"ApplicationName\": \"test_pay_center\",\n \"DeleteFlag\": false,\n \"ConfigType\": null\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfig\n<公共请求参数>\n\n{\n \"ConfigId\": \"dcfg-vzk36owv\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"60bd18bd-50bb-4e4c-af76-8f1c938b103a\",\n \"Result\": {\n \"ApplicationId\": \"application-5yr26r9a\",\n \"ApplicationName\": \"amp-consumer\",\n \"ConfigId\": \"dcfg-vzk36owv\",\n \"ConfigName\": \"config_app\",\n \"ConfigType\": \"application\",\n \"ConfigValue\": \"config: enabled\",\n \"ConfigVersion\": \"v1\",\n \"ConfigVersionCount\": 1,\n \"ConfigVersionDesc\": \"This is desc\",\n \"CreationTime\": \"2024-12-24 18:04:02\",\n \"DeleteFlag\": true,\n \"LastUpdateTime\": \"2024-12-24 18:04:02\"\n }\n }\n}", "title": "查询配置" } ], "DescribeConfigReleaseLogs": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeConfigReleaseLogs\r\n&Offset=0\r\n&Limit=20\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"cd8be98a-c557-43ef-bece-069f014bb2dd\",\n \"Result\": {\n \"TotalCount\": 3,\n \"Content\": [\n {\n \"ConfigReleaseLogId\": \"dcfgrl-6ymq4b5v\",\n \"ConfigId\": \"dcfg-6a79x94v\",\n \"ConfigName\": \"[配置项已被删除]\",\n \"ConfigVersion\": \"[配置项已被删除]\",\n \"GroupId\": \"group-mae5orra\",\n \"GroupName\": \"[部署组已被删除]\",\n \"NamespaceId\": null,\n \"NamespaceName\": null,\n \"ClusterId\": null,\n \"ClusterName\": null,\n \"ReleaseTime\": \"2019-05-28 09:41:40\",\n \"ReleaseDesc\": null,\n \"ReleaseStatus\": \"S\",\n \"LastConfigId\": null,\n \"LastConfigName\": null,\n \"LastConfigVersion\": null,\n \"RollbackFlag\": false\n },\n {\n \"ConfigReleaseLogId\": \"dcfgrl-ba228ppa\",\n \"ConfigId\": \"dcfg-6a79x94v\",\n \"ConfigName\": \"[配置项已被删除]\",\n \"ConfigVersion\": \"[配置项已被删除]\",\n \"GroupId\": \"group-mae5orra\",\n \"GroupName\": \"[部署组已被删除]\",\n \"NamespaceId\": null,\n \"NamespaceName\": null,\n \"ClusterId\": null,\n \"ClusterName\": null,\n \"ReleaseTime\": \"2019-05-28 09:36:52\",\n \"ReleaseDesc\": \"删除配置项\",\n \"ReleaseStatus\": \"DS\",\n \"LastConfigId\": \"dcfg-6a79x94v\",\n \"LastConfigName\": \"[配置项已被删除]\",\n \"LastConfigVersion\": \"[配置项已被删除]\",\n \"RollbackFlag\": false\n },\n {\n \"ConfigReleaseLogId\": \"dcfgrl-evjjbjlv\",\n \"ConfigId\": \"dcfg-6a79x94v\",\n \"ConfigName\": \"[配置项已被删除]\",\n \"ConfigVersion\": \"[配置项已被删除]\",\n \"GroupId\": \"group-mae5orra\",\n \"GroupName\": \"[部署组已被删除]\",\n \"NamespaceId\": null,\n \"NamespaceName\": null,\n \"ClusterId\": null,\n \"ClusterName\": null,\n \"ReleaseTime\": \"2019-05-28 09:30:55\",\n \"ReleaseDesc\": null,\n \"ReleaseStatus\": \"S\",\n \"LastConfigId\": null,\n \"LastConfigName\": null,\n \"LastConfigVersion\": null,\n \"RollbackFlag\": false\n }\n ]\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigReleaseLogs\n<公共请求参数>\n\n{\n \"GroupId\": \"group-aln2284v\",\n \"Offset\": 0,\n \"Limit\": 10,\n \"NamespaceId\": \"namespace-vj3z3zgy\",\n \"ClusterId\": \"cluster-yne99jdy\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"66410802-5243-4b39-8823-21843a2bf669\",\n \"Result\": {\n \"Content\": [\n {\n \"ClusterId\": \"cluster-yne99jdy\",\n \"ClusterName\": \"cluster-app\",\n \"ConfigId\": \"dcfg-yo82mmra\",\n \"ConfigName\": \"app-config\",\n \"ConfigReleaseLogId\": \"dcfgrl-yq75nn3a\",\n \"ConfigVersion\": \"v3\",\n \"GroupId\": \"group-aln2284v\",\n \"GroupName\": \"group-provider-1\",\n \"LastConfigId\": \"dcfg-yo82mmra\",\n \"LastConfigName\": \"config_app\",\n \"LastConfigVersion\": \"v1\",\n \"NamespaceId\": \"namespace-vw8oox6v\",\n \"NamespaceName\": \"cluster-jolyonzheng_default\",\n \"ReleaseDesc\": \"This is desc\",\n \"ReleaseStatus\": \"S\",\n \"ReleaseTime\": \"2024-12-24 15:57:15\",\n \"ReleasedConfigCenter\": \"SHARE\",\n \"RollbackFlag\": false\n }\n ],\n \"TotalCount\": 6\n }\n }\n}", "title": "查询配置发布历史" } ], "DescribeConfigReleases": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeConfigReleases\r\n&ConfigId=dcfg-zvw6kxa8\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"2cee7c95-08aa-45fa-9a1c-7016b7b1fcbf\",\n \"Result\": {\n \"TotalCount\": 0,\n \"Content\": []\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigReleases\n<公共请求参数>\n\n{\n \"ConfigName\": \"app-config\",\n \"GroupId\": \"group-aln2284v\",\n \"NamespaceId\": \"namespace-vw8oox6v\",\n \"ClusterId\": \"cluster-yne99jdy\",\n \"Limit\": 10,\n \"Offset\": 0,\n \"ConfigId\": \"dcfg-yo82mmra\",\n \"ApplicationId\": \"application-a7rwwz4v\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"16fa1e0b-d3e8-4b1f-b15f-e1d01966acb7\",\n \"Result\": {\n \"Content\": [\n {\n \"ApplicationId\": \"application-a7rwwz4v\",\n \"ClusterId\": \"cluster-yne99jdy\",\n \"ClusterName\": \"cluster-app\",\n \"ConfigCenters\": [\n {\n \"ConfigCenterInstanceId\": null,\n \"ConfigCenterInstanceName\": null,\n \"ConfigType\": \"SHARE\",\n \"CurrentVersion\": null,\n \"RegionId\": null,\n \"TargetVersion\": null\n }\n ],\n \"ConfigId\": \"dcfg-yo82mmra\",\n \"ConfigName\": \"app-config\",\n \"ConfigReleaseId\": \"dcfgr-yxd366ov\",\n \"ConfigVersion\": \"v3\",\n \"GroupId\": \"group-aln2284v\",\n \"GroupName\": \"group-provider\",\n \"NamespaceId\": \"namespace-vw8oox6v\",\n \"NamespaceName\": \"cluster-app_default\",\n \"ReleaseDesc\": \"This is desc\",\n \"ReleaseTime\": \"2024-12-24 15:57:15\"\n }\n ],\n \"TotalCount\": 1\n }\n }\n}", "title": "查询配置发布信息" } ], "DescribeConfigSummary": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeConfigSummary\n&Offset=0\n&Limit=20\n&SearchWord=driver\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"2b151339-278f-47ed-b5fe-a86273a203de\",\n \"Result\": {\n \"TotalCount\": 3,\n \"Content\": [\n {\n \"ConfigId\": null,\n \"ConfigName\": \"dev-driverapi-config\",\n \"ConfigVersion\": null,\n \"ConfigVersionDesc\": null,\n \"ConfigValue\": null,\n \"CreationTime\": null,\n \"LastUpdateTime\": \"2019-04-16 12:38:45\",\n \"ConfigVersionCount\": 2,\n \"ApplicationId\": \"application-maegorqv\",\n \"ApplicationName\": \"gactravel_dev_driverapi\",\n \"DeleteFlag\": null,\n \"ConfigType\": null\n },\n {\n \"ConfigId\": null,\n \"ConfigName\": \"ruqi_travel_driverapi\",\n \"ConfigVersion\": null,\n \"ConfigVersionDesc\": null,\n \"ConfigValue\": null,\n \"CreationTime\": null,\n \"LastUpdateTime\": \"2019-04-16 12:29:55\",\n \"ConfigVersionCount\": 3,\n \"ApplicationId\": \"application-ov6mxrka\",\n \"ApplicationName\": \"ruqi_travel_driverapi\",\n \"DeleteFlag\": null,\n \"ConfigType\": null\n },\n {\n \"ConfigId\": null,\n \"ConfigName\": \"test-driverapi-config\",\n \"ConfigVersion\": null,\n \"ConfigVersionDesc\": null,\n \"ConfigValue\": null,\n \"CreationTime\": null,\n \"LastUpdateTime\": \"2019-04-23 11:16:26\",\n \"ConfigVersionCount\": 2,\n \"ApplicationId\": \"application-jy9w6lka\",\n \"ApplicationName\": \"ruqitest_travel_driverapi\",\n \"DeleteFlag\": null,\n \"ConfigType\": null\n }\n ]\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigSummary\n<公共请求参数>\n\n{\n \"ApplicationId\": \"application-5yr26r9a\",\n \"SearchWord\": \"config_app\",\n \"Offset\": 0,\n \"Limit\": 10,\n \"OrderBy\": \"creation_time\",\n \"OrderType\": 1,\n \"ConfigTagList\": [\n \"config_app-application-5yr26r9a\"\n ],\n \"DisableProgramAuthCheck\": true,\n \"ConfigIdList\": [\n \"dcfg-vzk36owv\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"0e8d31d3-e16a-4070-9248-cce94db7fae5\",\n \"Result\": {\n \"Content\": [\n {\n \"ApplicationId\": \"application-5yr26r9a\",\n \"ApplicationName\": \"amp-consumer\",\n \"ConfigId\": \"dcfg-vzk36owv\",\n \"ConfigName\": \"config_app\",\n \"ConfigType\": null,\n \"ConfigValue\": null,\n \"ConfigVersion\": null,\n \"ConfigVersionCount\": 1,\n \"ConfigVersionDesc\": null,\n \"CreationTime\": null,\n \"DeleteFlag\": null,\n \"LastUpdateTime\": \"2024-12-24 18:04:02\"\n }\n ],\n \"TotalCount\": 1\n }\n }\n}", "title": "查询配置汇总列表" } ], @@ -723,16 +723,16 @@ "DescribeDeliveryConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeDeliveryConfig\r\n&ConfigId=dddd\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"e64dc152-b874-4b91-9301-e9b290f1ffbb\",\n \"Result\": true\n }\n}", + "input": "https://tsf.tencentcloudapi.com/?Action=DescribeDeliveryConfig\n&ConfigId=config-kl29sh7n\n&<公共请求参数>", + "output": "{\n \"Response\": {\n \"RequestId\": \"00b0009f-80ad-41fd-8bb8-f430d12f3911\",\n \"Result\": {\n \"CollectPath\": [\n \"\"\n ],\n \"ConfigId\": \"send-data-to-kafka-nalj8bgy\",\n \"ConfigName\": \"rtest222\",\n \"CustomRule\": null,\n \"EnableAuth\": false,\n \"EnableGlobalLineRule\": false,\n \"KafkaAddress\": null,\n \"KafkaInfos\": [\n {\n \"CustomRule\": \"\",\n \"LineRule\": \"\",\n \"Path\": [\n \"/test/1.log\"\n ],\n \"Topic\": \"test\"\n }\n ],\n \"KafkaVIp\": \"127.0.1:9200\",\n \"KafkaVPort\": null,\n \"LineRule\": \"default\",\n \"Password\": null,\n \"Topic\": \"\",\n \"Username\": null\n }\n }\n}", "title": "获取单个投递项配置" } ], "DescribeDeliveryConfigByGroupId": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeDeliveryConfigByGroupId\r\n&GroupId=dddd\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Result\": {\n \"ConfigId\": \"abc\",\n \"ConfigName\": \"abc\"\n },\n \"RequestId\": \"abc\"\n }\n}", + "input": "https://tsf.tencentcloudapi.com/?Action=DescribeDeliveryConfigByGroupId\n&GroupId=group-ab958z6y\n&<公共请求参数>", + "output": "{\n \"Response\": {\n \"Result\": {\n \"ConfigId\": \"apm-busi-log-cfg-ab958z6y\",\n \"ConfigName\": \"log-demo\"\n },\n \"RequestId\": \"96561cf1-738a-47d6-943b-dec7ebbccabe\"\n }\n}", "title": "用部署组id获取绑定信息" } ], @@ -748,7 +748,7 @@ { "document": "获取应用application-zxxxxxxx下程序包id为pkg-xxxxxxx的下载信息", "input": "https://tsf.tencentcloudapi.com/?Action=DescribeDownloadInfo\r\n&ApplicationId=application-zxxxxxxx\r\n&PkgId=pkg-xxxxxxx\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"2e9885d9-xxxx-xxxx-xxxx-59621dd82a5b\",\n \"Result\": {\n \"Bucket\": \"tsf-gz-123456789\",\n \"Region\": \"ap-guangzhou\",\n \"Path\": \"/1111111111/application-xxxxxxxx/201905291xxxxx/travel-passenger-xxx-1.0-SNAPSHOT.jar\",\n \"Credentials\": {\n \"SessionToken\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"TmpAppId\": \"123456789\",\n \"TmpSecretId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"TmpSecretKey\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"ExpiredTime\": 1559120000,\n \"Domain\": \"cos.ap-guangzhou.myqcloud.com\"\n }\n }\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"2e9885d9-xxxx-xxxx-xxxx-59621dd82a5b\",\n \"Result\": {\n \"Bucket\": \"tsf-gz-123456789\",\n \"Region\": \"ap-guangzhou\",\n \"Path\": \"/1111111111/application-xxxxxxxx/201905291xxxxx/travel-passenger-xxx-1.0-SNAPSHOT.jar\",\n \"Credentials\": {\n \"SessionToken\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"TmpAppId\": \"apm-6a79x94v\",\n \"TmpSecretId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"TmpSecretKey\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"ExpiredTime\": 1559120000,\n \"Domain\": \"cos.ap-guangzhou.myqcloud.com\"\n }\n }\n }\n}", "title": "获取下载程序包信息" } ], @@ -756,15 +756,15 @@ { "document": "", "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeEnabledUnitRule\n<公共请求参数>\n\n{\n \"GatewayInstanceId\": \"gw-ins-szesmg28\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"480c7535-a008-4851-8a36-2d921893ea1e\",\n \"Result\": {\n \"CreatedTime\": \"2023-01-17 11:41:36\",\n \"Description\": \"sssase\",\n \"GatewayInstanceId\": \"gw-ins-szesmg28\",\n \"Id\": \"unit-rl-2kdqa2my\",\n \"Name\": \"test\",\n \"Status\": \"enabled\",\n \"UnitRuleItemList\": [\n {\n \"CreatedTime\": \"2023-02-10 16:36:12\",\n \"Description\": \"gsshhshs\",\n \"DestNamespaceId\": \"namespace-vk5blxnv\",\n \"DestNamespaceName\": \"heihuli-global_default\",\n \"Id\": \"unit-item-04futugp\",\n \"ItemIndex\": 1,\n \"Name\": \"Rule1\",\n \"Priority\": 0,\n \"Relationship\": \"AND\",\n \"UnitRuleId\": \"unit-rl-2kdqa2my\",\n \"UnitRuleTagList\": [\n {\n \"Id\": \"unit-tag-s2v06uy5\",\n \"TagField\": \"test\",\n \"TagOperator\": \"IN\",\n \"TagType\": \"U\",\n \"TagValue\": \"test222\",\n \"UnitRuleItemId\": \"unit-item-04futugp\"\n }\n ],\n \"UpdatedTime\": \"2023-02-10 16:36:12\"\n }\n ],\n \"UpdatedTime\": \"2023-02-23 17:42:23\"\n }\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"b378cebf-7ee2-4105-9ea0-58413051ea8e\",\n \"Result\": {\n \"CreatedTime\": \"2024-12-25 11:46:00\",\n \"Description\": \"this is desc\",\n \"GatewayInstanceId\": \"gw-ins-szesmg28\",\n \"Id\": \"unit-rl-u0643wrg\",\n \"Name\": \"rule_app\",\n \"Status\": \"enabled\",\n \"UnitRuleItemList\": [\n {\n \"CreatedTime\": \"2024-12-25 11:46:00\",\n \"Description\": \"this is desc\",\n \"DestNamespaceId\": \"namespace-aem6w6nv\",\n \"DestNamespaceName\": \"heihuli-c_default\",\n \"Id\": \"unit-item-vnj5nf3m\",\n \"ItemIndex\": 1,\n \"Name\": \"rule_user\",\n \"Priority\": 0,\n \"Relationship\": \"AND\",\n \"UnitRuleId\": \"unit-rl-u0643wrg\",\n \"UnitRuleTagList\": [\n {\n \"Id\": \"unit-tag-8p9bpwh4\",\n \"TagField\": \"user\",\n \"TagOperator\": \"IN\",\n \"TagType\": \"U\",\n \"TagValue\": \"1\",\n \"UnitRuleItemId\": \"unit-item-vnj5nf3m\"\n }\n ],\n \"UpdatedTime\": \"2024-12-25 11:46:00\"\n }\n ],\n \"UpdatedTime\": \"2024-12-25 11:50:01\"\n }\n }\n}", "title": "查询生效的单元化规则" } ], "DescribeFileConfigReleases": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeFileConfigReleases\r\n&ConfigId=dcfg-f-mae7g3v3\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"6e6cc542-bc3a-4030-a9c8-8742e070e5d0\",\n \"Result\": {\n \"TotalCount\": 0,\n \"Content\": []\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFileConfigReleases\n<公共请求参数>\n\n{\n \"ConfigId\": \"dcfg-f-v3qqrkdy\",\n \"ConfigName\": \"conf_app\",\n \"GroupId\": \"group-vj3n6lzy\",\n \"NamespaceId\": \"namespace-ygo3djma\",\n \"ClusterId\": \"cls-f6bk82xc\",\n \"ApplicationId\": \"application-vw8ljmwv\",\n \"Offset\": 0,\n \"Limit\": 10\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"5620eba9-1673-4b3c-b375-591910b0fbc0\",\n \"Result\": {\n \"Content\": [\n {\n \"ClusterId\": \"cls-f6bk82xc\",\n \"ClusterName\": \"cluster-container-jolyonzheng\",\n \"ConfigId\": \"dcfg-f-v3qqrkdy\",\n \"ConfigName\": \"conf_app\",\n \"ConfigReleaseId\": \"dcfgr-f-vkjjw7ny\",\n \"ConfigVersion\": \"2\",\n \"GroupId\": \"group-vj3n6lzy\",\n \"GroupName\": \"group-provider\",\n \"NamespaceId\": \"namespace-ygo3djma\",\n \"NamespaceName\": \"cluster-container-jolyonzheng_default\",\n \"ReleaseDesc\": \"This is desc\",\n \"ReleaseTime\": \"2024-11-28 20:49:57\"\n }\n ],\n \"TotalCount\": 1\n }\n }\n}", "title": "查询文件配置项发布信息" } ], @@ -859,8 +859,8 @@ "DescribeGroupRelease": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeGroupRelease\n&GroupId=group-xxxxxx\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"c033faca-041a-4357-a96d-xxxxxxxx\",\n \"Result\": {\n \"PackageName\": \"consumer-demo-1.25.0-Greenwich-SNAPSHOT.jar\",\n \"PackageVersion\": \"1.25.0\",\n \"PackageId\": \"pkg-xxxxxx\",\n \"PublicConfigReleaseList\": [\n {\n \"ConfigReleaseId\": \"dcfgr-xxxxxx\",\n \"ConfigId\": \"dcfg-p-xxxxxx\",\n \"ConfigName\": \"n1\",\n \"ConfigVersion\": \"v1\",\n \"ReleaseTime\": \"2021-08-10 10:xx:xx\",\n \"GroupId\": \"group-6a79x94v\",\n \"GroupName\": \"group-mock\",\n \"NamespaceId\": \"namespace-xxxxxxxx\",\n \"NamespaceName\": \"default\",\n \"ClusterId\": \"cls-6a79x94v\",\n \"ClusterName\": \"cls-mock\",\n \"ReleaseDesc\": \"this is a desc\",\n \"ApplicationId\": \"application-6a79x94v\"\n }\n ]\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGroupRelease\n<公共请求参数>\n\n{\n \"GroupId\": \"group-v6q747py\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"81d75b7e-8bec-47fd-bc65-c99bb24f569e\",\n \"Result\": {\n \"ConfigReleaseList\": [\n {\n \"ApplicationId\": \"application-vzoebl8a\",\n \"ClusterId\": \"cls-i3v5y09e\",\n \"ClusterName\": \"cls-app\",\n \"ConfigCenters\": [\n {\n \"ConfigCenterInstanceId\": null,\n \"ConfigCenterInstanceName\": null,\n \"ConfigType\": \"SHARE\",\n \"CurrentVersion\": null,\n \"RegionId\": null,\n \"TargetVersion\": null\n }\n ],\n \"ConfigId\": \"dcfg-a7rl7w4v\",\n \"ConfigName\": \"conf-app\",\n \"ConfigReleaseId\": \"dcfgr-ymw5965v\",\n \"ConfigVersion\": \"v1\",\n \"GroupId\": \"group-v6q747py\",\n \"GroupName\": \"cloud-provider\",\n \"NamespaceId\": \"namespace-vj3z3zgy\",\n \"NamespaceName\": \"ns_default\",\n \"ReleaseDesc\": null,\n \"ReleaseTime\": \"2024-12-24 18:36:03\"\n }\n ],\n \"FileConfigReleaseList\": [\n {\n \"ClusterId\": \"cls-i3v5y09e\",\n \"ClusterName\": \"cls-app\",\n \"ConfigId\": \"dcfg-f-aeonjd6y\",\n \"ConfigName\": \"config_app\",\n \"ConfigReleaseId\": \"dcfgr-f-y84omela\",\n \"ConfigVersion\": \"v1\",\n \"GroupId\": \"group-v6q747py\",\n \"GroupName\": \"cloud-provider\",\n \"NamespaceId\": \"namespace-vj3z3zgy\",\n \"NamespaceName\": \"ns_default\",\n \"ReleaseDesc\": null,\n \"ReleaseTime\": \"2024-12-24 18:37:50\"\n }\n ],\n \"PackageId\": \"pkg-9198307d\",\n \"PackageName\": \"msgw-zuul1-1.29.20-Hoxton-Higher-RELEASE.jar\",\n \"PackageVersion\": \"20241223010307\",\n \"PublicConfigReleaseList\": [\n {\n \"ApplicationId\": null,\n \"ClusterId\": null,\n \"ClusterName\": null,\n \"ConfigCenters\": [\n {\n \"ConfigCenterInstanceId\": null,\n \"ConfigCenterInstanceName\": null,\n \"ConfigType\": \"SHARE\",\n \"CurrentVersion\": null,\n \"RegionId\": null,\n \"TargetVersion\": null\n }\n ],\n \"ConfigId\": \"dcfg-p-vzk36rov\",\n \"ConfigName\": \"config_pub_app\",\n \"ConfigReleaseId\": \"dcfgr-yne579dy\",\n \"ConfigVersion\": \"v1\",\n \"GroupId\": null,\n \"GroupName\": null,\n \"NamespaceId\": \"namespace-vj3z3zgy\",\n \"NamespaceName\": \"ns_default\",\n \"ReleaseDesc\": null,\n \"ReleaseTime\": \"2024-12-24 18:36:54\"\n }\n ],\n \"RepoName\": \"tsf_100011910000/app-provider\",\n \"TagName\": \"20241212161801\"\n }\n }\n}", "title": "查询部署组发布的相关信息" } ], @@ -987,16 +987,16 @@ "DescribeMicroservices": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeMicroservices\n&Offset=0\n&Limit=1\n&NamespaceId=namespace-xxxxxxx\n&SearchWord=ms-xxxxxxx\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"3eab4695-2d7e-4f78-a8d2-ea93bab87dfd\",\n \"Result\": {\n \"TotalCount\": 1,\n \"Content\": [\n {\n \"MicroserviceId\": \"ms-xxxxxxx\",\n \"NamespaceId\": \"namespace-xxxxxxx\",\n \"MicroserviceName\": \"consumer-demo\",\n \"MicroserviceDesc\": null,\n \"CreateTime\": 1553673084000,\n \"UpdateTime\": 1553673084000,\n \"RunInstanceCount\": 1\n }\n ]\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMicroservices\n<公共请求参数>\n\n{\n \"SearchWord\": \"consumer\",\n \"NamespaceId\": \"namespace-v6b2exey\",\n \"OrderBy\": \"create_time\",\n \"OrderType\": 1,\n \"Offset\": 0,\n \"Limit\": 10,\n \"Status\": [\n \"single_online\"\n ],\n \"MicroserviceIdList\": [\n \"ms-yqwbbpxl\"\n ],\n \"MicroserviceNameList\": [\n \"consumer-demo\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"31c18b1c-4e2e-4cb1-8b82-de820d178f12\",\n \"Result\": {\n \"Content\": [\n {\n \"CreateTime\": null,\n \"CriticalInstanceCount\": 0,\n \"MicroserviceDesc\": \"\",\n \"MicroserviceId\": \"ms-yqwbbpxl\",\n \"MicroserviceName\": \"consumer-demo\",\n \"NamespaceId\": \"namespace-v6b2exey\",\n \"RunInstanceCount\": 1,\n \"UpdateTime\": null\n }\n ],\n \"TotalCount\": 1\n }\n }\n}", "title": "获取微服务列表" } ], "DescribeMsApiList": [ { "document": "查询微服务API列表", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeMsApiList\r\n&Offset=0\r\n&Limit=20\r\n&MicroserviceId=ms-opy5kjy4\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"056cc966-4963-4506-ac4c-c4e7209a41e3\",\n \"Result\": {\n \"TotalCount\": 4,\n \"Content\": [\n {\n \"Path\": \"/echo-async-rest/{str}\",\n \"Method\": \"GET\",\n \"Description\": \"(无)\"\n },\n {\n \"Path\": \"/echo-rest/{str}\",\n \"Method\": \"GET\",\n \"Description\": \"(无)\"\n },\n {\n \"Path\": \"/user-feign\",\n \"Method\": \"GET\",\n \"Description\": \"(无)\"\n },\n {\n \"Path\": \"/echo-feign/{str}\",\n \"Method\": \"GET\",\n \"Description\": \"(无)\"\n }\n ]\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMsApiList\n<公共请求参数>\n\n{\n \"MicroserviceId\": \"ms-y5w8n5e9\",\n \"SearchWord\": \"echo-feign-url\",\n \"Limit\": 10,\n \"Offset\": 0\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"17a35767-819f-4683-bc3f-5430e6d4513f\",\n \"Result\": {\n \"Content\": [\n {\n \"Description\": \"\",\n \"Method\": \"GET\",\n \"Path\": \"/echo-feign-url/{str}\",\n \"Status\": 1\n }\n ],\n \"TotalCount\": 1\n }\n }\n}", "title": "查询服务API列表" } ], @@ -1035,8 +1035,8 @@ "DescribePluginInstances": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribePluginInstances\n&ScopeValue=grp-83wrlmav\n&Bound=true\n&Offset=0\n&Limit=10\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"fa153f44-22b6-4ea3-86ef-6e257d440f26\",\n \"Result\": {\n \"TotalCount\": 1,\n \"Content\": [\n {\n \"Id\": \"pgn-33pk2soi\",\n \"Name\": \"Tag认证插件\",\n \"Type\": \"Tag\",\n \"Description\": \"this is description\",\n \"CreatedTime\": \"2019-11-02 15:43:09\",\n \"UpdatedTime\": \"2019-11-02 17:30:51\",\n \"Status\": \"drafted\"\n }\n ]\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePluginInstances\n<公共请求参数>\n\n{\n \"ScopeValue\": \"grp-v446jrhc\",\n \"Bound\": true,\n \"Offset\": 0,\n \"Limit\": 10,\n \"Type\": \"QQMiniProgramLogin\",\n \"SearchWord\": \"pgnName\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"b6b81196-b506-4758-a2ea-80ee688cf3b3\",\n \"Result\": {\n \"Content\": [\n {\n \"CreatedTime\": \"2023-11-28 16:11:28\",\n \"Description\": \"This is desc\",\n \"Id\": \"pgn-if8otbfp\",\n \"Name\": \"pgnName\",\n \"Status\": \"released\",\n \"Type\": \"QQMiniProgramLogin\",\n \"UpdatedTime\": \"2023-11-28 16:11:27\"\n }\n ],\n \"TotalCount\": 1\n }\n }\n}", "title": "查询分组已绑定的插件列表" } ], @@ -1059,32 +1059,32 @@ "DescribePublicConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribePublicConfig\r\n&ConfigId=dcfg-p-5yrl4z2y\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"0fd83b45-ec19-45ad-9874-dbda7c4e84e6\",\n \"Result\": {\n \"ConfigId\": \"dcfg-p-5yrl4z2y\",\n \"ConfigName\": \"test-config\",\n \"ConfigVersion\": \"1.3\",\n \"ConfigVersionDesc\": \"\",\n \"ConfigValue\": \"tsf.inventory.password.encrypt2: ENC(3M7wGw2XtFc5Y+rxOgNBLrm2spUtgodjIxa+7F3XcAo=)\\r\\ntsf.inventory.password.encrypt1: ENC(3M7wGw2XtFc5Y+rxOgNBLrm2spUtgodjIxa+7F3XcAo=)\\r\\n\",\n \"CreationTime\": \"2019-05-29 11:23:28\",\n \"LastUpdateTime\": null,\n \"ConfigVersionCount\": null,\n \"ApplicationId\": null,\n \"ApplicationName\": null,\n \"DeleteFlag\": true,\n \"ConfigType\": null\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePublicConfig\n<公共请求参数>\n\n{\n \"ConfigId\": \"dcfg-p-vkj5dnky\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"8a143a46-4f13-4c9e-b536-9225ab88a55e\",\n \"Result\": {\n \"ApplicationId\": null,\n \"ApplicationName\": null,\n \"ConfigId\": \"dcfg-p-vkj5dnky\",\n \"ConfigName\": \"app-config\",\n \"ConfigType\": null,\n \"ConfigValue\": \"config: enabled\",\n \"ConfigVersion\": \"v1\",\n \"ConfigVersionCount\": null,\n \"ConfigVersionDesc\": \"This is desc\",\n \"CreationTime\": \"2024-12-20 19:16:10\",\n \"DeleteFlag\": true,\n \"LastUpdateTime\": null\n }\n }\n}", "title": "查询公共配置(单条)" } ], "DescribePublicConfigReleaseLogs": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribePublicConfigReleaseLogs\r\n&Offset=0\r\n&Limit=20\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5748271c-3579-4f40-95b9-5f7b87f27388\",\n \"Result\": {\n \"TotalCount\": 0,\n \"Content\": []\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePublicConfigReleaseLogs\n<公共请求参数>\n\n{\n \"NamespaceId\": \"namespace-vj3z3zgy\",\n \"Offset\": 0,\n \"Limit\": 10\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"168aec4c-c3fe-4abd-911b-ca9634e137dd\",\n \"Result\": {\n \"Content\": [\n {\n \"ClusterId\": null,\n \"ClusterName\": null,\n \"ConfigId\": \"dcfg-p-vzk36rov\",\n \"ConfigName\": \"[配置项已被删除]\",\n \"ConfigReleaseLogId\": \"dcfgrl-yrm5jx9v\",\n \"ConfigVersion\": \"[配置项已被删除]\",\n \"GroupId\": null,\n \"GroupName\": null,\n \"LastConfigId\": \"dcfg-p-vzk36rov\",\n \"LastConfigName\": \"[配置项已被删除]\",\n \"LastConfigVersion\": \"[配置项已被删除]\",\n \"NamespaceId\": \"namespace-vj3z3zgy\",\n \"NamespaceName\": \"ns_default\",\n \"ReleaseDesc\": \"删除配置项\",\n \"ReleaseStatus\": \"DS\",\n \"ReleaseTime\": \"2024-12-24 20:30:37\",\n \"RollbackFlag\": false\n },\n {\n \"ClusterId\": null,\n \"ClusterName\": null,\n \"ConfigId\": \"dcfg-p-vzk36rov\",\n \"ConfigName\": \"[配置项已被删除]\",\n \"ConfigReleaseLogId\": \"dcfgrl-vw83po6v\",\n \"ConfigVersion\": \"[配置项已被删除]\",\n \"GroupId\": null,\n \"GroupName\": null,\n \"LastConfigId\": null,\n \"LastConfigName\": null,\n \"LastConfigVersion\": null,\n \"NamespaceId\": \"namespace-vj3z3zgy\",\n \"NamespaceName\": \"ns_default\",\n \"ReleaseDesc\": null,\n \"ReleaseStatus\": \"S\",\n \"ReleaseTime\": \"2024-12-24 18:36:54\",\n \"RollbackFlag\": false\n }\n ],\n \"TotalCount\": 2\n }\n }\n}", "title": "查询公共配置发布历史" } ], "DescribePublicConfigReleases": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribePublicConfigReleases\r\n&Offset=0\r\n&Limit=20\r\n&ConfigName=ebs-demo\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"69d073be-25d1-4ba8-b1eb-92cdc21ad4ea\",\n \"Result\": {\n \"TotalCount\": 1,\n \"Content\": [\n {\n \"ConfigReleaseId\": \"dcfgr-gyqpwbpa\",\n \"ConfigId\": \"dcfg-p-gvkwzpjv\",\n \"ConfigName\": \"ebs-demo\",\n \"ConfigVersion\": \"3.0\",\n \"ReleaseTime\": \"2019-05-16 14:24:32\",\n \"GroupId\": null,\n \"GroupName\": null,\n \"NamespaceId\": \"namespace-6yooxgdy\",\n \"NamespaceName\": \"ebs-demo\",\n \"ClusterId\": null,\n \"ClusterName\": null,\n \"ReleaseDesc\": null\n }\n ]\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePublicConfigReleases\n<公共请求参数>\n\n{\n \"ConfigName\": \"configName\",\n \"NamespaceId\": \"namespace-yxoqm4ky\",\n \"Limit\": 10,\n \"Offset\": 0,\n \"ConfigId\": \"dcfg-p-v6kxdlpy\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"2435f045-963a-43da-a29b-581eb28069c0\",\n \"Result\": {\n \"Content\": [\n {\n \"ApplicationId\": null,\n \"ClusterId\": null,\n \"ClusterName\": null,\n \"ConfigCenters\": [\n {\n \"ConfigCenterInstanceId\": null,\n \"ConfigCenterInstanceName\": null,\n \"ConfigType\": \"SHARE\",\n \"CurrentVersion\": null,\n \"RegionId\": null,\n \"TargetVersion\": null\n }\n ],\n \"ConfigId\": \"dcfg-p-v6kxdlpy\",\n \"ConfigName\": \"configName\",\n \"ConfigReleaseId\": \"dcfgr-y446nlby\",\n \"ConfigVersion\": \"1\",\n \"GroupId\": null,\n \"GroupName\": null,\n \"NamespaceId\": \"namespace-yxoqm4ky\",\n \"NamespaceName\": \"ns_default\",\n \"ReleaseDesc\": null,\n \"ReleaseTime\": \"2024-09-11 17:27:59\"\n }\n ],\n \"TotalCount\": 1\n }\n }\n}", "title": "查询公共配置发布信息" } ], "DescribePublicConfigSummary": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribePublicConfigSummary\n&Offset=0\n&Limit=20\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"cc75758b-a2e3-4ded-a97a-c541817b4efe\",\n \"Result\": {\n \"TotalCount\": 2,\n \"Content\": [\n {\n \"ConfigId\": null,\n \"ConfigName\": \"global\",\n \"ConfigVersion\": null,\n \"ConfigVersionDesc\": null,\n \"ConfigValue\": null,\n \"CreationTime\": null,\n \"LastUpdateTime\": \"2019-05-24 20:39:12\",\n \"ConfigVersionCount\": 6,\n \"ApplicationId\": null,\n \"ApplicationName\": null,\n \"DeleteFlag\": null,\n \"ConfigType\": null\n },\n {\n \"ConfigId\": null,\n \"ConfigName\": \"tsf\",\n \"ConfigVersion\": null,\n \"ConfigVersionDesc\": null,\n \"ConfigValue\": null,\n \"CreationTime\": null,\n \"LastUpdateTime\": \"2019-05-21 14:50:13\",\n \"ConfigVersionCount\": 4,\n \"ApplicationId\": null,\n \"ApplicationName\": null,\n \"DeleteFlag\": null,\n \"ConfigType\": null\n }\n ]\n }\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePublicConfigSummary\n<公共请求参数>\n\n{\n \"SearchWord\": \"app\",\n \"Offset\": 0,\n \"Limit\": 10,\n \"OrderBy\": \"creation_time\",\n \"OrderType\": 1,\n \"ConfigTagList\": [\n \"app-config\"\n ],\n \"DisableProgramAuthCheck\": true,\n \"ConfigIdList\": [\n \"dcfg-p-vkj5dnky\"\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"d6da2add-172a-4a4d-8f30-8abca66e314f\",\n \"Result\": {\n \"Content\": [\n {\n \"ApplicationId\": null,\n \"ApplicationName\": null,\n \"ConfigId\": \"dcfg-p-vkj5dnky\",\n \"ConfigName\": \"app-config\",\n \"ConfigType\": null,\n \"ConfigValue\": null,\n \"ConfigVersion\": null,\n \"ConfigVersionCount\": 1,\n \"ConfigVersionDesc\": null,\n \"CreationTime\": null,\n \"DeleteFlag\": null,\n \"LastUpdateTime\": \"2024-12-20 19:16:10\"\n }\n ],\n \"TotalCount\": 1\n }\n }\n}", "title": "查询公共配置汇总列表" } ], @@ -1099,8 +1099,8 @@ "DescribeReleasedConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DescribeReleasedConfig\r\n&GroupId=group-qv382dy7\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"2f65737d-7707-43b7-b024-b8aff844ab8f\",\n \"Result\": \"spring:\\n servlet:\\n multipart:\\n max-file-size: 100MB\\n max-request-size: 100MB\\n jackson:\\n serialization:\\n write-dates-as-timestamps: true\\n data:\\n mongodb:\\n uri: mongodb://commentuser:9xa#Lkp6sT@10.10.11.13:27017/comment\\n dubbo:\\n registry:\\n protocol: dubbo\\n address: tsfconsul://169.254.0.77:8000\\n datasource:\\n url: jdbc:mysql:replication://10.10.2.148:3306,10.10.2.148:3306,10.10.2.148:3306/rrmj2?roundRobinLoadBalance=true\\n username: rrtvappuser\\n \"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeReleasedConfig\n<公共请求参数>\n\n{\n \"GroupId\": \"group-jy9re3gy\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"6ec73c01-a942-4c6c-9630-b25e53745a43\",\n \"Result\": \"config: enabled\\n\"\n }\n}", "title": "查询group发布的配置" } ], @@ -1275,16 +1275,16 @@ "DisableUnitRoute": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DisableUnitRoute\n&Id=gw-ins-l6ymbvgd\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DisableUnitRoute\n<公共请求参数>\n\n{\n \"Id\": \"gw-ins-szesmg28\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"6e650435-e3b2-472d-af7a-5d5452db8bf3\",\n \"Result\": true\n }\n}", "title": "禁用单元化路由" } ], "DisableUnitRule": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DisableUnitRule\n&Id=gw-ins-afsfas\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DisableUnitRule\n<公共请求参数>\n\n{\n \"Id\": \"unit-rl-u0643wrg\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"2a814838-8198-4943-9d97-04bc7ede98a9\",\n \"Result\": true\n }\n}", "title": "禁用单元化规则" } ], @@ -1307,16 +1307,16 @@ "DraftApiGroup": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=DraftApiGroup\n&GroupId=grp-5yk7oor1\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e05507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DraftApiGroup\n<公共请求参数>\n\n{\n \"GroupId\": \"grp-d45mlt3o\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"5024ce23-0ac6-4ca3-9061-e1c4666c9c0d\",\n \"Result\": true\n }\n}", "title": "下线Api分组" } ], "EnableLaneRule": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=EnableLaneRule\r\n&RuleId=lane-r-fdjsklafjdsa\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: EnableLaneRule\n<公共请求参数>\n\n{\n \"RuleId\": \"lane-r-yqg4kmbd\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"265f638d-1998-494b-a794-1abe86d5eecc\",\n \"Result\": true\n }\n}", "title": "启用泳道规则" } ], @@ -1339,16 +1339,16 @@ "EnableUnitRoute": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=EnableUnitRoute\n&Id=gw-ins-l6ymbvgd\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: EnableUnitRoute\n<公共请求参数>\n\n{\n \"Id\": \"gw-ins-szesmg28\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"e81e7880-ad81-4e97-b3e2-01901f913e35\",\n \"Result\": true\n }\n}", "title": "启用单元化路由" } ], "EnableUnitRule": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=EnableUnitRule\n&Id=gw-ins-afsfas\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: EnableUnitRule\n<公共请求参数>\n\n{\n \"Id\": \"unit-rl-u0643wrg\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"dc5fd463-2889-4c5c-b662-98a70a149b95\",\n \"Result\": true\n }\n}", "title": "创建单元化规则" } ], @@ -1419,8 +1419,8 @@ "ModifyLane": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=ModifyLane\r\n&LaneId=1\r\n&LaneName=1\r\n&Remark=1\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"abc\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyLane\n<公共请求参数>\n\n{\n \"LaneId\": \"lane-ap62k7ol\",\n \"LaneName\": \"rule_app\",\n \"Remark\": \"This is desc\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"3ad3847e-b102-4b45-8f90-bb64112cc27f\",\n \"Result\": true\n }\n}", "title": "更新泳道信息" } ], @@ -1435,8 +1435,8 @@ "ModifyMicroservice": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=ModifyMicroservice\r\n&MicroserviceId=ms-xxxxxxx\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"4304b189-8663-453d-8863-1f238f6c4fb0\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyMicroservice\n<公共请求参数>\n\n{\n \"MicroserviceId\": \"ms-yd8dr5bx\",\n \"MicroserviceDesc\": \"This is desc\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"414386f9-834d-42ce-af55-532202e82031\",\n \"Result\": true\n }\n}", "title": "修改微服务详情" } ], @@ -1451,8 +1451,8 @@ "ModifyPathRewrite": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=ModifyPathRewrite\n&PathRewriteId=rewrite-l6ymbvgd\n&Order=100\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyPathRewrite\n<公共请求参数>\n\n{\n \"PathRewriteId\": \"rewrite-ba22pbpa\",\n \"Regex\": \"/consumer\",\n \"Replacement\": \"/provider\",\n \"Blocked\": \"N\",\n \"Order\": 1\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"6b194892-2c0a-41d3-93e1-e4b293b0fde8\",\n \"Result\": true\n }\n}", "title": "修改路径重写顺序" } ], @@ -1531,24 +1531,24 @@ "ReleaseApiGroup": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=ReleaseApiGroup\n&GroupId=grp-5yk7oor1\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e05507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ReleaseApiGroup\n<公共请求参数>\n\n{\n \"GroupId\": \"grp-d45mlt3o\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"b6608391-3bb1-4c83-9ecb-9c935bea46c5\",\n \"Result\": true\n }\n}", "title": "发布Api分组" } ], "ReleaseConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=ReleaseConfig\n&ConfigId=dcfg-zvw6kxa8\n&GroupId=group-nalqbgvq\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"36ccafba-c8ab-4d15-a4f1-4cfd2070d1d3\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ReleaseConfig\n<公共请求参数>\n\n{\n \"ConfigId\": \"dcfg-vzk36owv\",\n \"GroupId\": \"group-9yn684ev\",\n \"ReleaseDesc\": \"This is desc\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"10320d7c-65ed-4ddd-bf21-6f33b23fed73\",\n \"Result\": true\n }\n}", "title": "发布配置" } ], "ReleaseConfigWithDetailResp": [ { "document": "将一个应用配置项发布到指定的应用部署组", - "input": "POST / HTTP/1.1\nHost: xxx.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: actionName\n<公共请求参数>\n\n{\n \"ConfigId\": \"configId-xxxxxxx\",\n \"GroupId\": \"gourp-xxxxxx\",\n \"ReleaseDesc\": \"demo config realse\"\n}", - "output": "{\n \"Response\": {\n \"Result\": {\n \"ConfigReleaseId\": \"dcfgr-xxxxxx\",\n \"ConfigId\": \"null\",\n \"ConfigName\": \"null\",\n \"ConfigVersion\": \"null\",\n \"ReleaseTime\": \"null\",\n \"GroupId\": \"null\",\n \"GroupName\": \"null\",\n \"NamespaceId\": \"null\",\n \"NamespaceName\": \"null\",\n \"ClusterId\": \"null\",\n \"ClusterName\": \"null\",\n \"ReleaseDesc\": \"null\",\n \"ApplicationId\": \"null\"\n },\n \"RequestId\": \"36ccafba-c8ab-4d15-a4f1-4cfd2070d1d3\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ReleaseConfigWithDetailResp\n<公共请求参数>\n\n{\n \"ConfigId\": \"dcfg-yo82mmra\",\n \"GroupId\": \"group-aln2284v\",\n \"ReleaseDesc\": \"This is desc\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"1892e2c1-9223-4979-bf25-1935c7eeed12\",\n \"Result\": {\n \"ApplicationId\": null,\n \"ClusterId\": null,\n \"ClusterName\": null,\n \"ConfigCenters\": null,\n \"ConfigId\": null,\n \"ConfigName\": null,\n \"ConfigReleaseId\": \"dcfgr-yxd366ov\",\n \"ConfigVersion\": null,\n \"GroupId\": null,\n \"GroupName\": null,\n \"NamespaceId\": null,\n \"NamespaceName\": null,\n \"ReleaseDesc\": null,\n \"ReleaseTime\": null\n }\n }\n}", "title": "发布配置" } ], @@ -1563,8 +1563,8 @@ "ReleasePublicConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=ReleasePublicConfig\n&ConfigId=dcfg-p-4y46okga\n&NamespaceId=namespace-ov6l235v\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5a20177f-0949-4e38-8c71-d77159586c04\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ReleasePublicConfig\n<公共请求参数>\n\n{\n \"ConfigId\": \"dcfg-p-vkj5dnky\",\n \"NamespaceId\": \"namespace-vw46q85y\",\n \"ReleaseDesc\": \"This is desc\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"d60fcd87-e9d0-475c-89f5-1e76a035d404\",\n \"Result\": true\n }\n}", "title": "发布公共配置" } ], @@ -1579,24 +1579,24 @@ "RevocationConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=RevocationConfig\r\n&ConfigReleaseId=dcfgr-jy9no5ka\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"64e5494d-ae5d-4114-abe7-c34d8719415e\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RevocationConfig\n<公共请求参数>\n\n{\n \"ConfigReleaseId\": \"dcfgr-y84o2xla\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"f860eb0c-7a37-48e4-ba23-f246f5e93e41\",\n \"Result\": true\n }\n}", "title": "撤回已发布的配置" } ], "RevocationPublicConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=RevocationPublicConfig\r\n&ConfigReleaseId=dcfgr-oydloz5a\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"14650572-a12a-4cb0-b2f9-2ff8ee0abae2\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RevocationPublicConfig\n<公共请求参数>\n\n{\n \"ConfigReleaseId\": \"dcfgr-a7rldd9v\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"9385599f-d33a-4d36-a1c6-8ab6ac79d8df\",\n \"Result\": true\n }\n}", "title": "撤回已发布的公共配置" } ], "RevokeFileConfig": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=RevokeFileConfig\r\n&ConfigReleaseId=dcfgr-f-dapp63ao\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"3641f31a-a1ac-4733-8430-efe9f4c9f1d7\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RevokeFileConfig\n<公共请求参数>\n\n{\n \"ConfigReleaseId\": \"dcfgr-f-aeon99ry\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"f5788a08-6f8c-4c64-8c7c-89abf3f35c86\",\n \"Result\": true\n }\n}", "title": "撤回已发布的文件配置" } ], @@ -1699,40 +1699,40 @@ "UnbindApiGroup": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=UnbindApiGroup\n&GroupGatewayList.0.GatewayDeployGroupId=group-qabo8xyl\n&GroupGatewayList.0.GroupId=grp-i54lzdrq\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e05507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UnbindApiGroup\n<公共请求参数>\n\n{\n \"GroupGatewayList\": [\n {\n \"GatewayDeployGroupId\": \"group-yo99lney\",\n \"GroupId\": \"grp-notmqbpe\"\n }\n ]\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"e602a33a-7ddd-44ad-b55b-790afb4eac25\",\n \"Result\": true\n }\n}", "title": "API分组批量与网关解绑" } ], "UpdateApiGroup": [ { "document": "", - "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateApiGroup\n<公共请求参数>\n\n{\n \"GroupName\": \"new-name\",\n \"GroupId\": \"grp-grp-5yk7oor1\"\n}", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e05507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateApiGroup\n<公共请求参数>\n\n{\n \"GroupId\": \"grp-notmqbpe\",\n \"GroupName\": \"grp_app\",\n \"Description\": \"This is desc\",\n \"AuthType\": \"none\",\n \"GroupContext\": \"/grp_app\",\n \"NamespaceNameKey\": \"TSF-NamespaceName\",\n \"ServiceNameKey\": \"TSF-ServiceName\",\n \"NamespaceNameKeyPosition\": \"path\",\n \"ServiceNameKeyPosition\": \"path\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"9bcb4936-f3e5-4fdc-acd8-71fd041429e8\",\n \"Result\": true\n }\n}", "title": "更新Api分组" } ], "UpdateApiRateLimitRule": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=UpdateApiRateLimitRule\n&RuleId=rule-d5970cd2\n&UsableStatus=enabled\n&MaxQps=1000\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": false\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateApiRateLimitRule\n<公共请求参数>\n\n{\n \"RuleId\": \"rule-8qlpdumd\",\n \"UsableStatus\": \"enabled\",\n \"MaxQps\": 2000\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"ebba8f15-b795-4bdc-b881-049e33ef3fcb\",\n \"Result\": true\n }\n}", "title": "更新API限流规则" } ], "UpdateApiRateLimitRules": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=UpdateApiRateLimitRules\n&ApiIds.0=api-d5970cd\n&ApiIds.1=api-d5971cd\n&UsableStatus=enabled\n&MaxQps=1000\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateApiRateLimitRules\n<公共请求参数>\n\n{\n \"ApiIds\": [\n \"api-b1sd366q\"\n ],\n \"UsableStatus\": \"enabled\",\n \"MaxQps\": 1000\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"94bddd45-fd4c-4192-aea2-5eeb5b74d5b6\",\n \"Result\": true\n }\n}", "title": "批量更新API限流规则" } ], "UpdateApiTimeouts": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=UpdateApiTimeouts\n&ApiIds.0=api-d5970cd\n&ApiIds.1=api-d5971cd\n&UsableStatus=enabled\n&Timeout=10000\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateApiTimeouts\n<公共请求参数>\n\n{\n \"ApiIds\": [\n \"api-tnvxy4ta\"\n ],\n \"UsableStatus\": \"enabled\",\n \"Timeout\": 2000\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"30356074-f0ce-46a3-86fd-30da5fcf336e\",\n \"Result\": true\n }\n}", "title": "批量更新API超时" } ], @@ -1747,8 +1747,8 @@ "UpdateGatewayApi": [ { "document": "", - "input": "https://tsf.tencentcloudapi.com/?Action=UpdateGatewayApi\n&ApiId=api-5yk7oor1\n&Path=/user/find\n&Method=POST\n&PathMapping=/user/find\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"RequestId\": \"5d996e5507e42d5970cd2e25ed5267a\",\n \"Result\": true\n }\n}", + "input": "POST / HTTP/1.1\nHost: tsf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateGatewayApi\n<公共请求参数>\n\n{\n \"ApiId\": \"api-zwua4plw\",\n \"Path\": \"/echo-user\",\n \"Method\": \"GET\",\n \"PathMapping\": \"/echo-user\",\n \"Host\": \"http://www.qq.com\",\n \"Description\": \"this is desc\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"c17753d4-a08b-4d4a-b8f5-a4160ff02c6d\",\n \"Result\": true\n }\n}", "title": "更改API" } ], diff --git a/tccli/services/tts/v20190823/api.json b/tccli/services/tts/v20190823/api.json index e3bac086d9..b5bf08ce4e 100644 --- a/tccli/services/tts/v20190823/api.json +++ b/tccli/services/tts/v20190823/api.json @@ -52,7 +52,7 @@ }, { "disabled": false, - "document": "语速,范围:[-2,2],分别对应不同语速:<li>-2代表0.6倍</li><li>-1代表0.8倍</li><li>0代表1.0倍(默认)</li><li>1代表1.2倍</li><li>2代表1.5倍</li>如果需要更细化的语速,可以保留小数点后 2 位,例如0.5/1.25/2.81等。<br>参数值与实际语速转换,可参考[代码示例](https://sdk-1300466766.cos.ap-shanghai.myqcloud.com/sample/speed_sample.tar.gz)", + "document": "语速,范围:[-2,6],分别对应不同语速:<li>-2代表0.6倍</li><li>-1代表0.8倍</li><li>0代表1.0倍(默认)</li><li>1代表1.2倍</li><li>2代表1.5倍</li><li>6代表2.5倍</li>如果需要更细化的语速,可以保留小数点后 2 位,例如0.5/1.25/2.81等。<br>参数值与实际语速转换,可参考[代码示例](https://sdk-1300466766.cos.ap-shanghai.myqcloud.com/sample/speed_sample.tar.gz)", "example": "1", "member": "float", "name": "Speed", diff --git a/tccli/services/vpc/v20170312/api.json b/tccli/services/vpc/v20170312/api.json index 9c82408b9f..aed76c85e2 100644 --- a/tccli/services/vpc/v20170312/api.json +++ b/tccli/services/vpc/v20170312/api.json @@ -1911,6 +1911,13 @@ "output": "InquirePriceCreateDirectConnectGatewayResponse", "status": "online" }, + "InquiryPriceAllocateAddresses": { + "document": "本接口(InquiryPriceAllocateAddresses)用于新购弹性公网IP询价。", + "input": "InquiryPriceAllocateAddressesRequest", + "name": "弹性公网IP新购询价", + "output": "InquiryPriceAllocateAddressesResponse", + "status": "online" + }, "InquiryPriceCreateVpnGateway": { "document": "本接口(InquiryPriceCreateVpnGateway)用于创建VPN网关询价。", "input": "InquiryPriceCreateVpnGatewayRequest", @@ -1918,6 +1925,20 @@ "output": "InquiryPriceCreateVpnGatewayResponse", "status": "online" }, + "InquiryPriceModifyAddressesBandwidth": { + "document": "EIP修改带宽询价", + "input": "InquiryPriceModifyAddressesBandwidthRequest", + "name": "弹性公网IP调整带宽询价", + "output": "InquiryPriceModifyAddressesBandwidthResponse", + "status": "online" + }, + "InquiryPriceRenewAddresses": { + "document": "本接口(InquiryPriceRenewAddresses)用于续费预付费弹性公网IP询价。", + "input": "InquiryPriceRenewAddressesRequest", + "name": "弹性公网IP续费询价", + "output": "InquiryPriceRenewAddressesResponse", + "status": "online" + }, "InquiryPriceRenewVpnGateway": { "document": "本接口(InquiryPriceRenewVpnGateway)用于续费VPN网关询价。目前仅支持IPSEC类型网关的询价。", "input": "InquiryPriceRenewVpnGatewayRequest", @@ -7586,7 +7607,7 @@ { "disabled": false, "document": "指定绑定的标签列表,例如:[{\"Key\": \"city\", \"Value\": \"shanghai\"}]", - "example": "无", + "example": "[{\"Key\": \"name\", \"Value\": \"123\"}]", "member": "Tag", "name": "Tags", "required": false, @@ -7595,7 +7616,7 @@ { "disabled": false, "document": "BGP ASN。ASN取值范围为1- 4294967295,其中139341、45090和58835不可用。", - "example": "无", + "example": "51613", "member": "int64", "name": "BgpAsn", "required": false, @@ -7613,6 +7634,7 @@ "example": "无", "member": "CustomerGateway", "name": "CustomerGateway", + "output_required": true, "type": "object", "value_allowed_null": false }, @@ -11309,50 +11331,50 @@ { "disabled": false, "document": "用户网关唯一ID", - "example": "无", + "example": "cgw-021cr501", "member": "string", "name": "CustomerGatewayId", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "网关名称", - "example": "无", + "example": "对端网关-1", "member": "string", "name": "CustomerGatewayName", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "公网地址", - "example": "无", + "example": "12.31.451.4", "member": "string", "name": "IpAddress", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "创建时间", - "example": "无", + "example": "2024-11-15 10:33:22", "member": "string", "name": "CreatedTime", - "required": true, + "output_required": true, "type": "string", "value_allowed_null": false }, { "disabled": false, "document": "BGP ASN。", - "example": "无", + "example": "2731", "member": "uint64", "name": "BgpAsn", - "required": false, + "output_required": true, "type": "int", "value_allowed_null": false } @@ -13171,7 +13193,7 @@ { "disabled": false, "document": "异步任务ID。", - "example": "123", + "example": "15415", "member": "uint64", "name": "TaskId", "output_required": true, @@ -20101,7 +20123,7 @@ { "disabled": false, "document": "过滤条件,参数不支持同时指定SslVpnClientIds和Filters。\n<li>vpc-id - String - (过滤条件)VPC实例ID形如:vpc-f49l6u0z。</li>\n<li>vpn-gateway-id - String - (过滤条件)VPN实例ID形如:vpngw-5aluhh9t。</li>\n<li>ssl-vpn-server-id - String - (过滤条件)SSL-VPN-SERVER实例ID形如:vpns-1j2w6xpx。</li>\n<li>ssl-vpn-client-id - String - (过滤条件)SSL-VPN-CLIENT实例ID形如:vpnc-3rlxp4nd。</li>\n<li>ssl-vpn-client-name - String - (过滤条件)SSL-VPN-CLIENT实例名称。</li>", - "example": "无", + "example": "[{\"Name\":\"vpc-id\",\"Values\":[\"vpc-xxxxxxxx\"]}]", "member": "Filter", "name": "Filters", "required": false, @@ -20128,7 +20150,7 @@ { "disabled": false, "document": "SSL-VPN-CLIENT实例ID。形如:\t\nvpns-1jww3xpx。每次请求的实例的上限为100。参数不支持同时指定SslVpnClientIds和Filters。", - "example": "无", + "example": "['vpnc-mgp33pll']", "member": "string", "name": "SslVpnClientIds", "required": false, @@ -20137,7 +20159,7 @@ { "disabled": false, "document": "VPN门户网站使用。默认是False。", - "example": "无", + "example": "True", "member": "bool", "name": "IsVpnPortal", "required": false, @@ -21308,7 +21330,7 @@ { "disabled": false, "document": "异步任务实例ID。", - "example": "1234", + "example": "678123", "member": "uint64", "name": "TaskId", "output_required": true, @@ -21701,7 +21723,7 @@ { "disabled": false, "document": "SAML Token(SAML令牌)。", - "example": "无", + "example": "TGYICwnqislmIMHCRgaCumpW8XdgOR3Qz", "member": "string", "name": "SamlToken", "required": false, @@ -21710,7 +21732,7 @@ { "disabled": false, "document": "VPN门户网站使用。默认False", - "example": "无", + "example": "False", "member": "bool", "name": "IsVpnPortal", "required": false, @@ -21734,7 +21756,7 @@ { "disabled": false, "document": "SSL-VPN 客户端配置。", - "example": "无", + "example": "\"{\\\"SslVpnClientConfiguration\\\": \\\"-config-\\\"...}\"", "member": "string", "name": "SslClientConfigsSet", "output_required": true, @@ -21744,7 +21766,7 @@ { "disabled": false, "document": "SSL-VPN 客户端配置。", - "example": "无", + "example": "[{\"SslVpnClientConfiguration\": \"config...\",\"SslVpnRootCert\": \"CERTIFICATE...\",...}]", "member": "SslClientConfig", "name": "SslClientConfig", "output_required": true, @@ -22007,7 +22029,7 @@ { "disabled": false, "document": "异步任务实例ID。", - "example": "1234", + "example": "678123", "member": "uint64", "name": "TaskId", "output_required": true, @@ -23593,6 +23615,70 @@ ], "type": "object" }, + "InquiryPriceAllocateAddressesRequest": { + "document": "InquiryPriceAllocateAddresses请求参数结构体", + "members": [ + { + "disabled": false, + "document": "EIP计费方式。\n<ul style=\"margin:0\"><li>账号为标准账户类型的用户,可选值:<ul>\n<li>BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费</li>\n<li>BANDWIDTH_PREPAID_BY_MONTH:包月按带宽预付费</li>\n<li>TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费</li></ul>默认值:TRAFFIC_POSTPAID_BY_HOUR。</li>\n</ul>", + "example": "TRAFFIC_POSTPAID_BY_HOUR", + "member": "string", + "name": "InternetChargeType", + "required": false, + "type": "string" + }, + { + "disabled": false, + "document": "EIP出带宽上限,单位:Mbps。\n<ul style=\"margin:0\"><li>账号为标准账户类型的用户,可选值范围取决于EIP计费方式:<ul>\n<li>BANDWIDTH_POSTPAID_BY_HOUR:1 Mbps 至 100 Mbps</li>\n<li>BANDWIDTH_PREPAID_BY_MONTH:1 Mbps 至 200 Mbps</li>\n<li>TRAFFIC_POSTPAID_BY_HOUR:1 Mbps 至 100 Mbps</li></ul>默认值:1 Mbps。</li>\n<li>账号为传统账户类型的用户,EIP出带宽上限取决于与其绑定的实例的公网出带宽上限,无需传递此参数。</li></ul>", + "example": "1", + "member": "int64", + "name": "InternetMaxBandwidthOut", + "required": false, + "type": "int" + }, + { + "disabled": false, + "document": "包月按带宽预付费EIP的计费参数。EIP为包月按带宽预付费时,该参数必传,其余场景不需传递", + "example": "无", + "member": "AddressChargePrepaid", + "name": "AddressChargePrepaid", + "required": false, + "type": "object" + }, + { + "disabled": false, + "document": "EIP类型。默认值:EIP。\n\n<ul style=\"margin:0\"><li>精品IP,可选值:<ul><li>HighQualityEIP:精品IP</li></ul>注意:仅部分地域支持精品IP。</li></ul><ul style=\"margin:0\">\n <li>高防IP,可选值:<ul>\n <li>AntiDDoSEIP:高防IP</li>\n </ul>\n </li>\n </ul>", + "example": "EIP", + "member": "string", + "name": "AddressType", + "required": false, + "type": "string" + } + ], + "type": "object" + }, + "InquiryPriceAllocateAddressesResponse": { + "document": "InquiryPriceAllocateAddresses返回参数结构体", + "members": [ + { + "disabled": false, + "document": "弹性公网IP价格", + "example": "无", + "member": "InternetPrice", + "name": "Price", + "output_required": true, + "type": "object", + "value_allowed_null": false + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "InquiryPriceCreateVpnGatewayRequest": { "document": "InquiryPriceCreateVpnGateway请求参数结构体", "members": [ @@ -23666,13 +23752,105 @@ ], "type": "object" }, + "InquiryPriceModifyAddressesBandwidthRequest": { + "document": "InquiryPriceModifyAddressesBandwidth请求参数结构体", + "members": [ + { + "disabled": false, + "document": "EIP唯一ID", + "example": "eip-e7yggyi0", + "member": "string", + "name": "AddressIds", + "required": true, + "type": "list" + }, + { + "disabled": false, + "document": "新带宽值", + "example": "1", + "member": "int64", + "name": "InternetMaxBandwidthOut", + "required": true, + "type": "int" + } + ], + "type": "object" + }, + "InquiryPriceModifyAddressesBandwidthResponse": { + "document": "InquiryPriceModifyAddressesBandwidth返回参数结构体", + "members": [ + { + "disabled": false, + "document": "弹性公网IP调整带宽询价结果", + "example": "Price", + "member": "InternetPrice", + "name": "Price", + "output_required": true, + "type": "object", + "value_allowed_null": false + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, + "InquiryPriceRenewAddressesRequest": { + "document": "InquiryPriceRenewAddresses请求参数结构体", + "members": [ + { + "disabled": false, + "document": "续费资源实例ID。", + "example": "eip-test1234", + "member": "string", + "name": "AddressIds", + "required": true, + "type": "list" + }, + { + "disabled": false, + "document": "包月按带宽预付费EIP的计费参数。EIP为包月按带宽预付费时,该参数必传,其余场景不需传递。", + "example": "12", + "member": "AddressChargePrepaid", + "name": "AddressChargePrepaid", + "required": true, + "type": "object" + } + ], + "type": "object" + }, + "InquiryPriceRenewAddressesResponse": { + "document": "InquiryPriceRenewAddresses返回参数结构体", + "members": [ + { + "disabled": false, + "document": "弹性公网IP续费价格。", + "example": "无", + "member": "InternetPrice", + "name": "Price", + "output_required": true, + "type": "object", + "value_allowed_null": false + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "InquiryPriceRenewVpnGatewayRequest": { "document": "InquiryPriceRenewVpnGateway请求参数结构体", "members": [ { "disabled": false, "document": "VPN网关实例ID。", - "example": "", + "example": "vpngw-ac13cgez", "member": "string", "name": "VpnGatewayId", "required": true, @@ -23681,7 +23859,7 @@ { "disabled": false, "document": "预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", - "example": "", + "example": "{'Period': 36}", "member": "InstanceChargePrepaid", "name": "InstanceChargePrepaid", "required": true, @@ -23696,9 +23874,10 @@ { "disabled": false, "document": "商品价格。", - "example": "", + "example": "无", "member": "Price", "name": "Price", + "output_required": true, "type": "object" }, { @@ -23905,6 +24084,68 @@ ], "usage": "out" }, + "InternetPrice": { + "document": "公网询价出参", + "members": [ + { + "disabled": false, + "document": "公网IP询价详细参数。", + "example": "无", + "member": "InternetPriceDetail", + "name": "AddressPrice", + "output_required": true, + "type": "object", + "value_allowed_null": false + } + ], + "usage": "out" + }, + "InternetPriceDetail": { + "document": "公网IP询价出参", + "members": [ + { + "disabled": false, + "document": "付费单价,单位:元,仅后付费价格查询返回。", + "example": "80", + "member": "float", + "name": "UnitPrice", + "output_required": false, + "type": "float", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "折扣后的价格,单位:元。\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "80", + "member": "float", + "name": "DiscountPrice", + "output_required": false, + "type": "float", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "计价单元,可取值范围:<ul> <li>HOUR:表示计价单元是按每小时来计算。当前涉及该计价单元的场景有:流量按小时后付费(TRAFFIC_POSTPAID_BY_HOUR)、带宽按小时后付费(BANDWIDTH_POSTPAID_BY_HOUR)。</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。", + "example": "HOUR", + "member": "string", + "name": "ChargeUnit", + "output_required": false, + "type": "string", + "value_allowed_null": true + }, + { + "disabled": false, + "document": "原价,单位:元,仅预付费价格查询返回。", + "example": "80", + "member": "float", + "name": "OriginalPrice", + "output_required": false, + "type": "float", + "value_allowed_null": false + } + ], + "usage": "out" + }, "Ip6Rule": { "document": "IPV6转换规则", "members": [ @@ -26452,7 +26693,7 @@ { "disabled": false, "document": "网络ACL五元组规则集。NetworkAclEntrySet和NetworkAclQuintupleSet只能输入一个。", - "example": "[]", + "example": "{ \"Ingress\": [ { \"Protocol\": \"TCP\", \"Description\": \"TCP TEST\", \"SourcePort\": \"80\", \"SourceCidr\": \"192.168.0.0/24\", \"DestinationPort\": \"8080\", \"DestinationCidr\": \"10.0.0.0/24\", \"Action\": \"ACCEPT\", \"Priority\": 1 } ] }", "member": "NetworkAclQuintupleEntries", "name": "NetworkAclQuintupleSet", "required": false, @@ -27628,7 +27869,7 @@ { "disabled": false, "document": "SPD策略组,例如:{\"10.0.0.5/24\":[\"172.123.10.5/16\"]},10.0.0.5/24是vpc内网段,172.123.10.5/16是IDC网段。用户指定VPC内哪些网段可以和您IDC中哪些网段通信。", - "example": "无", + "example": "[{'LocalCidrBlock': '10.40.1.12/24','RemoteCidrBlock': ['172.123.10.5/16', '10.7.10.0/16']}]", "member": "SecurityPolicyDatabase", "name": "SecurityPolicyDatabases", "required": false, @@ -27637,7 +27878,7 @@ { "disabled": false, "document": "IKE配置(Internet Key Exchange,因特网密钥交换),IKE具有一套自我保护机制,用户配置网络安全协议。", - "example": "无", + "example": "{'LocalIdentity': 'ADDRESS','LocalAddress': 'dddd'}", "member": "IKEOptionsSpecification", "name": "IKEOptionsSpecification", "required": false, @@ -27646,7 +27887,7 @@ { "disabled": false, "document": "IPSec配置,腾讯云提供IPSec安全会话设置。", - "example": "无", + "example": "{'IPSECSaLifetimeSeconds': 7200}", "member": "IPSECOptionsSpecification", "name": "IPSECOptionsSpecification", "required": false, @@ -27655,7 +27896,7 @@ { "disabled": false, "document": "是否启用通道健康检查,默认为False。", - "example": "无", + "example": "False", "member": "bool", "name": "EnableHealthCheck", "required": false, @@ -27664,7 +27905,7 @@ { "disabled": false, "document": "本端通道探测IP。", - "example": "无", + "example": "169.254.128.1", "member": "string", "name": "HealthCheckLocalIp", "required": false, @@ -27673,7 +27914,7 @@ { "disabled": false, "document": "对端通道探测IP。", - "example": "无", + "example": "169.254.128.2", "member": "string", "name": "HealthCheckRemoteIp", "required": false, @@ -27727,7 +27968,7 @@ { "disabled": false, "document": "健康检查配置", - "example": "无", + "example": "{'ProbeType': 'NQA','ProbeInterval': 30,'ProbeThreshold': 10,'ProbeTimeout': 60}", "member": "HealthCheckConfig", "name": "HealthCheckConfig", "required": false, @@ -28026,7 +28267,7 @@ { "disabled": false, "document": "SAML-DATA", - "example": "无", + "example": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGlu", "member": "string", "name": "SamlData", "required": false, @@ -28041,7 +28282,7 @@ { "disabled": false, "document": "异步任务TASKID", - "example": "123", + "example": "5671", "member": "int64", "name": "TaskId", "output_required": true, @@ -30545,7 +30786,7 @@ { "disabled": false, "document": "VPN网关实例ID。", - "example": "", + "example": "vpngw-cxkeaff3", "member": "string", "name": "VpnGatewayId", "required": true, @@ -30554,7 +30795,7 @@ { "disabled": false, "document": "预付费计费模式。", - "example": "", + "example": "{ 'Period': 1, 'RenewFlag': 'NOTIFY_AND_MANUAL_RENEW' }", "member": "InstanceChargePrepaid", "name": "InstanceChargePrepaid", "required": true, diff --git a/tccli/services/vpc/v20170312/examples.json b/tccli/services/vpc/v20170312/examples.json index 547ef97d05..d55383960f 100644 --- a/tccli/services/vpc/v20170312/examples.json +++ b/tccli/services/vpc/v20170312/examples.json @@ -390,7 +390,7 @@ { "document": "创建对端网关", "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCustomerGateway\n<公共请求参数>\n\n{\n \"IpAddress\": \"58.211.1.12\",\n \"CustomerGatewayName\": \"test-cgw\",\n \"Tags\": [\n {\n \"Value\": \"shanghai\",\n \"Key\": \"city\"\n }\n ]\n}", - "output": "{\n \"Response\": {\n \"CustomerGateway\": {\n \"CustomerGatewayId\": \"cgw-mgp33pll\",\n \"IpAddress\": \"58.211.1.12\",\n \"CustomerGatewayName\": \"test-cgw\",\n \"CreatedTime\": \"2018-04-18 10:00:00\"\n },\n \"RequestId\": \"5bd98433-263a-47b6-9a1c-84aa613a8ff6\"\n }\n}", + "output": "{\n \"Response\": {\n \"CustomerGateway\": {\n \"CustomerGatewayId\": \"cgw-mgp33pll\",\n \"CustomerGatewayName\": \"cgw-name\",\n \"IpAddress\": \"58.21.1.12\",\n \"CreatedTime\": \"2023-05-29 11:28:45\",\n \"BgpAsn\": 141\n },\n \"RequestId\": \"5bd98433-263a-47b6-9a1c-84aa613a8ff6\"\n }\n}", "title": "创建对端网关" } ], @@ -2396,7 +2396,7 @@ { "document": "下载SSL-VPN-CLIENT配置", "input": "https://vpc.tencentcloudapi.com/?Action=DownloadVpnGatewaySslClientCert\n&SslVpnClientId=vpnc--84tby4k2\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"SslClientConfigsSet\": \"abc\",\n \"SslClientConfig\": [\n {\n \"SslVpnClientConfiguration\": \"abc\",\n \"SslVpnRootCert\": \"abc\",\n \"SslVpnKey\": \"abc\",\n \"SslVpnCert\": \"abc\",\n \"SslVpnClientId\": \"abc\"\n }\n ],\n \"Authenticated\": 1,\n \"RequestId\": \"abc\"\n }\n}", + "output": "{\n \"Response\": {\n \"SslClientConfigsSet\": \"{\\\"SslVpnClientConfiguration\\\": \\\"-config-\\\"......}\",\n \"SslClientConfig\": [\n {\n \"SslVpnClientConfiguration\": \"config...\",\n \"SslVpnRootCert\": \"CERTIFICATE...\",\n \"SslVpnKey\": \"PRIVATE KEY...\",\n \"SslVpnCert\": \"CERTIFICATE...\",\n \"SslVpnClientId\": \"vpnc-axa315c\"\n }\n ],\n \"Authenticated\": 1,\n \"RequestId\": \"8e08f027-048b-41e8-ac99-77e954ca15c5\"\n }\n}", "title": "下载SSL-VPN-CLIENT配置" } ], @@ -2508,6 +2508,26 @@ "title": "创建专线网关询价输入" } ], + "InquiryPriceAllocateAddresses": [ + { + "document": "小时流量计费模式弹性公网IP询价。", + "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquiryPriceAllocateAddresses\n<公共请求参数>\n\n{\n \"AddressType\": \"EIP\",\n \"InternetMaxBandwidthOut\": \"1\",\n \"InternetChargeType\": \"TRAFFIC_POSTPAID_BY_HOUR\"\n}", + "output": "{\n \"Response\": {\n \"Price\": {\n \"AddressPrice\": {\n \"ChargeUnit\": \"HOUR\",\n \"UnitPrice\": 0.8,\n \"DiscountPrice\": 0.8\n }\n },\n \"RequestId\": \"90d508a8-9ee8-4220-9c8e-9faeedce3ab4\"\n }\n}", + "title": "小时流量计费模式弹性公网IP询价" + }, + { + "document": "小时带宽计费模式弹性公网IP询价。", + "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquiryPriceAllocateAddresses\n<公共请求参数>\n\n{\n \"AddressType\": \"EIP\",\n \"InternetMaxBandwidthOut\": \"1\",\n \"InternetChargeType\": \"BANDWIDTH_POSTPAID_BY_HOUR\"\n}", + "output": "{\n \"Response\": {\n \"Price\": {\n \"AddressPrice\": {\n \"UnitPrice\": 0.063,\n \"DiscountPrice\": 0.063,\n \"ChargeUnit\": \"HOUR\"\n }\n },\n \"RequestId\": \"ebc826be-ec1a-4522-b08f-8da3fe5adedc\"\n }\n}", + "title": "小时带宽计费模式弹性公网IP询价" + }, + { + "document": "包月带宽计费模式弹性公网IP询价。", + "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquiryPriceAllocateAddresses\n<公共请求参数>\n\n{\n \"AddressChargePrepaid\": {\n \"Period\": 1\n },\n \"AddressType\": \"EIP\",\n \"InternetChargeType\": \"BANDWIDTH_PREPAID_BY_MONTH\",\n \"InternetMaxBandwidthOut\": 1\n}", + "output": "{\n \"Response\": {\n \"Price\": {\n \"AddressPrice\": {\n \"OriginalPrice\": 20,\n \"DiscountPrice\": 20\n }\n },\n \"RequestId\": \"136605f0-ca35-4d22-9b77-e053168fa25f\"\n }\n}", + "title": "包月带宽计费模式弹性公网IP询价" + } + ], "InquiryPriceCreateVpnGateway": [ { "document": "包年包月询价时输入", @@ -2522,11 +2542,39 @@ "title": "按量计费询价输入" } ], - "InquiryPriceRenewVpnGateway": [ + "InquiryPriceModifyAddressesBandwidth": [ + { + "document": "小时流量EIP修改带宽询价。", + "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquiryPriceModifyAddressesBandwidth\n<公共请求参数>\n\n{\n \"InternetMaxBandwidthOut\": \"2\",\n \"AddressIds\": [\n \"eip-hxlqja90\"\n ]\n}", + "output": "{\n \"Response\": {\n \"Price\": {\n \"AddressPrice\": {\n \"UnitPrice\": 0.8,\n \"DiscountPrice\": 0.8,\n \"ChargeUnit\": \"HOUR\"\n }\n },\n \"RequestId\": \"7daad6af-50de-4df5-8238-0d76c7be62e1\"\n }\n}", + "title": "小时流量EIP修改带宽询价" + }, + { + "document": "小时带宽EIP修改带宽询价。", + "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquiryPriceModifyAddressesBandwidth\n<公共请求参数>\n\n{\n \"AddressIds\": [\n \"eip-3hwtklhj\"\n ],\n \"InternetMaxBandwidthOut\": 5\n}", + "output": "{\n \"Response\": {\n \"Price\": {\n \"AddressPrice\": {\n \"UnitPrice\": 0.315,\n \"DiscountPrice\": 0.315,\n \"ChargeUnit\": \"HOUR\"\n }\n },\n \"RequestId\": \"db071565-27cb-482a-a3fe-1c7bba77e4a9\"\n }\n}", + "title": "小时带宽EIP修改带宽询价" + }, + { + "document": "包月带宽EIP调整带宽询价。", + "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquiryPriceModifyAddressesBandwidth\n<公共请求参数>\n\n{\n \"AddressIds\": [\n \"eip-iu4ml5pp\"\n ],\n \"InternetMaxBandwidthOut\": 5\n}", + "output": "{\n \"Response\": {\n \"Price\": {\n \"AddressPrice\": {\n \"OriginalPrice\": 95,\n \"DiscountPrice\": 95\n }\n },\n \"RequestId\": \"ddf8edf2-0457-4ba7-b2ab-e66e98823cc6\"\n }\n}", + "title": "包月带宽EIP调整带宽询价" + } + ], + "InquiryPriceRenewAddresses": [ { "document": "", - "input": "https://vpc.tencentcloudapi.com/?Action=InquiryPriceRenewVpnGateway\r\n&Version=2017-03-12\r\n&VpnGatewayId=vpngw-lazly92z\r\n&InstanceChargePrepaid.Period=2\r\n&<公共请求参数>", - "output": "{\n \"Response\": {\n \"Price\": {\n \"InstancePrice\": {\n \"OriginalPrice\": 760.0,\n \"DiscountPrice\": 760.0\n }\n },\n \"RequestId\": \"74883e1b-5901-46de-ae1e-d6e2cf591c5b\"\n }\n}", + "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquiryPriceRenewAddresses\n<公共请求参数>\n\n{\n \"AddressIds\": [\n \"eip-iu4ml5pp\"\n ],\n \"AddressChargePrepaid\": {\n \"Period\": 12\n }\n}", + "output": "{\n \"Response\": {\n \"Price\": {\n \"AddressPrice\": {\n \"OriginalPrice\": 240,\n \"DiscountPrice\": 240\n }\n },\n \"RequestId\": \"84658acc-bdb9-4a3e-a37a-84a2e0c14e44\"\n }\n}", + "title": "包月带宽计费模式EIP续费询价" + } + ], + "InquiryPriceRenewVpnGateway": [ + { + "document": "包年包月网关续费网关询价输入", + "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquiryPriceRenewVpnGateway\n<公共请求参数>\n\n{\n \"VpnGatewayId\": \"vpngw-abcxa123z\",\n \"InstanceChargePrepaid\": {\n \"Period\": 1,\n \"RenewFlag\": \"NOTIFY_AND_AUTO_RENEW\"\n }\n}", + "output": "{\n \"Response\": {\n \"Price\": {\n \"InstancePrice\": {\n \"OriginalPrice\": 380.0,\n \"DiscountPrice\": 177.4,\n \"UnitPrice\": 0.0,\n \"ChargeUnit\": \"\"\n },\n \"BandwidthPrice\": {\n \"OriginalPrice\": 0.0,\n \"DiscountPrice\": 0.0,\n \"UnitPrice\": 0.0,\n \"ChargeUnit\": \"\"\n }\n },\n \"RequestId\": \"74883e1b-5901-46de-ae1e-d6e2cf591c5b\"\n }\n}", "title": "包年包月网关续费网关询价输入" } ], @@ -3101,7 +3149,7 @@ "ModifyVpnConnectionAttribute": [ { "document": "修改VPN通道", - "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyVpnConnectionAttribute\n<公共请求参数>\n\n{\n \"VpnConnectionName\": \"test-abc\",\n \"VpnConnectionId\": \"vpnx-abc123x\",\n \"PreShareKey\": \"123\",\n \"EnableHealthCheck\": \"false\"\n}", + "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyVpnConnectionAttribute\n<公共请求参数>\n\n{\n \"VpnConnectionName\": \"test-abc\",\n \"VpnConnectionId\": \"vpnx-abc123x\",\n \"PreShareKey\": \"qwer12ty\",\n \"EnableHealthCheck\": \"false\"\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"b6c8a8c4-ba39-49ca-9b21-66247b7e3ad3\"\n }\n}", "title": "修改VPN通道" } @@ -3240,8 +3288,8 @@ ], "RenewVpnGateway": [ { - "document": "", - "input": "https://vpc.tencentcloudapi.com/?Action=RenewVpnGateway\r\n&Version=2017-03-12\r\n&VpnGatewayId=vpngw-lazly92z\r\n&InstanceChargePrepaid.Period=2\r\n&<公共请求参数>", + "document": "续费VPN网关", + "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RenewVpnGateway\n<公共请求参数>\n\n{\n \"VpnGatewayId\": \"vpngw-lazly92z\",\n \"InstanceChargePrepaid\": {\n \"Period\": 1,\n \"RenewFlag\": \"NOTIFY_AND_AUTO_RENEW\"\n }\n}", "output": "{\n \"Response\": {\n \"RequestId\": \"74883e1b-5901-46de-ae1e-d6e2cf591c5b\"\n }\n}", "title": "续费VPN网关" } diff --git a/tccli/services/vpc/vpc_client.py b/tccli/services/vpc/vpc_client.py index 384f893aeb..6bd46aba38 100644 --- a/tccli/services/vpc/vpc_client.py +++ b/tccli/services/vpc/vpc_client.py @@ -7401,6 +7401,58 @@ def doCreateHighPriorityRouteTable(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doInquiryPriceRenewAddresses(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.VpcClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.InquiryPriceRenewAddressesRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.InquiryPriceRenewAddresses(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 doModifyGatewayFlowQos(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -13017,6 +13069,58 @@ def doCreateServiceTemplate(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doInquiryPriceAllocateAddresses(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.VpcClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.InquiryPriceAllocateAddressesRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.InquiryPriceAllocateAddresses(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 doModifyDirectConnectGatewayAttribute(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -15929,6 +16033,58 @@ def doDescribeVpcs(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doInquiryPriceModifyAddressesBandwidth(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.VpcClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.InquiryPriceModifyAddressesBandwidthRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.InquiryPriceModifyAddressesBandwidth(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 doDescribeHighPriorityRouteTables(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -20138,6 +20294,7 @@ def doCreateVpnGatewayRoutes(args, parsed_globals): "DescribeBandwidthPackageResources": doDescribeBandwidthPackageResources, "DescribeVpcPeeringConnections": doDescribeVpcPeeringConnections, "CreateHighPriorityRouteTable": doCreateHighPriorityRouteTable, + "InquiryPriceRenewAddresses": doInquiryPriceRenewAddresses, "ModifyGatewayFlowQos": doModifyGatewayFlowQos, "DescribeRouteConflicts": doDescribeRouteConflicts, "DownloadCustomerGatewayConfiguration": doDownloadCustomerGatewayConfiguration, @@ -20246,6 +20403,7 @@ def doCreateVpnGatewayRoutes(args, parsed_globals): "DeleteVpcEndPoint": doDeleteVpcEndPoint, "DeleteHighPriorityRoutes": doDeleteHighPriorityRoutes, "CreateServiceTemplate": doCreateServiceTemplate, + "InquiryPriceAllocateAddresses": doInquiryPriceAllocateAddresses, "ModifyDirectConnectGatewayAttribute": doModifyDirectConnectGatewayAttribute, "ModifySubnetAttribute": doModifySubnetAttribute, "DescribeSgSnapshotFileContent": doDescribeSgSnapshotFileContent, @@ -20302,6 +20460,7 @@ def doCreateVpnGatewayRoutes(args, parsed_globals): "DescribeNatGateways": doDescribeNatGateways, "ResetHighPriorityRoutes": doResetHighPriorityRoutes, "DescribeVpcs": doDescribeVpcs, + "InquiryPriceModifyAddressesBandwidth": doInquiryPriceModifyAddressesBandwidth, "DescribeHighPriorityRouteTables": doDescribeHighPriorityRouteTables, "AcceptAttachCcnInstances": doAcceptAttachCcnInstances, "DescribeGatewayFlowQos": doDescribeGatewayFlowQos, diff --git a/tccli/services/waf/v20180125/api.json b/tccli/services/waf/v20180125/api.json index 2418fa6379..8c0f0e419e 100644 --- a/tccli/services/waf/v20180125/api.json +++ b/tccli/services/waf/v20180125/api.json @@ -70,6 +70,13 @@ "output": "CreateAccessExportResponse", "status": "online" }, + "CreateAreaBanRule": { + "document": "添加(编辑)地域封禁中的地域信息", + "input": "CreateAreaBanRuleRequest", + "name": "添加地域封禁规则", + "output": "CreateAreaBanRuleResponse", + "status": "online" + }, "CreateDeals": { "document": "计费资源购买、续费下单接口", "input": "CreateDealsRequest", @@ -252,6 +259,13 @@ "output": "DescribeAreaBanAreasResponse", "status": "online" }, + "DescribeAreaBanRule": { + "document": "获取地域封禁规则配置", + "input": "DescribeAreaBanRuleRequest", + "name": "获取地域封禁规则", + "output": "DescribeAreaBanRuleResponse", + "status": "online" + }, "DescribeAreaBanSupportAreas": { "document": "获取WAF地域封禁支持的地域列表", "input": "DescribeAreaBanSupportAreasRequest", @@ -728,6 +742,13 @@ "output": "ModifyAreaBanAreasResponse", "status": "online" }, + "ModifyAreaBanRule": { + "document": "添加(编辑)地域封禁中的地域信息", + "input": "ModifyAreaBanRuleRequest", + "name": "编辑地域封禁规则", + "output": "ModifyAreaBanRuleResponse", + "status": "online" + }, "ModifyAreaBanStatus": { "document": "修改防护域名的地域封禁状态", "input": "ModifyAreaBanStatusRequest", @@ -890,9 +911,9 @@ "status": "online" }, "ModifyProtectionStatus": { - "document": "获取基础安全防护(WAF开关)状态", + "document": "开启、关闭WAF开关", "input": "ModifyProtectionStatusRequest", - "name": "获取基础安全防护(WAF开关)状态", + "name": "开启、关闭WAF开关", "output": "ModifyProtectionStatusResponse", "status": "online" }, @@ -3010,6 +3031,121 @@ ], "usage": "in" }, + "Area": { + "document": "地域信息", + "members": [ + { + "disabled": false, + "document": "国家,除了标准的国家外还支持国内、国外这两个特殊的标识", + "example": "中国", + "member": "string", + "name": "Country", + "output_required": false, + "required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "省份", + "example": "广州", + "member": "string", + "name": "Region", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "城市", + "example": "深圳", + "member": "string", + "name": "City", + "output_required": false, + "required": false, + "type": "string", + "value_allowed_null": false + } + ], + "usage": "both" + }, + "AreaBanRule": { + "document": "地域封禁规则详情", + "members": [ + { + "disabled": false, + "document": "状态 0:未开启地域封禁、1:开启地域封禁", + "example": "0", + "member": "int64", + "name": "Status", + "output_required": true, + "type": "int", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "数据来源 custom:自定义(默认)、batch:批量防护", + "example": "custom", + "member": "string", + "name": "Source", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "配置的地域列表", + "example": "[{\"Country\":\"中国\",\"Region\":\"广东\",\"City\":\"深圳\"}]", + "member": "Area", + "name": "Areas", + "output_required": true, + "type": "list", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "规则执行的方式,TimedJob为定时执行,CronJob为周期执行", + "example": "TimedJob", + "member": "string", + "name": "JobType", + "output_required": true, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "定时任务配置", + "example": "{ \"Timed\": [ { \"StartDateTime\": 1711618518, \"EndDateTime\": 1711918518 } ], \"Cron\": [ { \"Day\": 12, \"WDay\": 2, \"StartTime\": \"12:11\", \"EndTime\": \"21:00\" } ], \"TimeTZone\": \"UTC+8\" }", + "member": "JobDateTime", + "name": "JobDateTime", + "output_required": true, + "type": "object", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "如果是周期任务类型,那么表示周期的类型,支持 Week:按周、Month:按月", + "example": "Week", + "member": "string", + "name": "CronType", + "output_required": false, + "type": "string", + "value_allowed_null": false + }, + { + "disabled": false, + "document": "地域信息的语言,支持cn、en,默认为中文cn", + "example": "cn", + "member": "string", + "name": "Lang", + "output_required": false, + "type": "string", + "value_allowed_null": false + } + ], + "usage": "out" + }, "AttackLogInfo": { "document": "攻击日志详情", "members": [ @@ -4739,6 +4875,69 @@ ], "type": "object" }, + "CreateAreaBanRuleRequest": { + "document": "CreateAreaBanRule请求参数结构体", + "members": [ + { + "disabled": false, + "document": "需要修改的域名", + "example": "test.com", + "member": "string", + "name": "Domain", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "需要新增的封禁地域", + "example": "[{\"Country\":\"中国\",\"Region\":\"广东\",\"City\":\"深圳\"}]", + "member": "Area", + "name": "Areas", + "required": true, + "type": "list" + }, + { + "disabled": false, + "document": "规则执行的方式,TimedJob为定时执行,CronJob为周期执行", + "example": "TimedJob", + "member": "string", + "name": "JobType", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "定时任务配置", + "example": "{ \"Timed\": [ { \"StartDateTime\": 1711618518, \"EndDateTime\": 1711918518 } ], \"Cron\": [ { \"Day\": 12, \"WDay\": 2, \"StartTime\": \"12:11\", \"EndTime\": \"21:00\" } ], \"TimeTZone\": \"UTC+8\" }", + "member": "JobDateTime", + "name": "JobDateTime", + "required": true, + "type": "object" + }, + { + "disabled": false, + "document": "地域信息的语言,支持cn、en,默认为中文cn", + "example": "cn", + "member": "string", + "name": "Lang", + "required": true, + "type": "string" + } + ], + "type": "object" + }, + "CreateAreaBanRuleResponse": { + "document": "CreateAreaBanRule返回参数结构体", + "members": [ + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "CreateDealsGoods": { "document": "计费下单接口出入参Goods", "members": [ @@ -6293,7 +6492,7 @@ }, { "disabled": false, - "document": "目前支持根据ts排序", + "document": "目前支持根据create_time、modify_time、id排序", "example": "\"ts\"", "member": "string", "name": "By", @@ -6946,6 +7145,43 @@ ], "usage": "out" }, + "DescribeAreaBanRuleRequest": { + "document": "DescribeAreaBanRule请求参数结构体", + "members": [ + { + "disabled": false, + "document": "需要查询的域名", + "example": "www.testwaf.com", + "member": "string", + "name": "Domain", + "required": true, + "type": "string" + } + ], + "type": "object" + }, + "DescribeAreaBanRuleResponse": { + "document": "DescribeAreaBanRule返回参数结构体", + "members": [ + { + "disabled": false, + "document": "规则内容", + "example": "{ \"Status\": 1, \"Source\": \"custom\", \"Areas\": [ { \"Country\": \"中国\", \"Region\": \"广东\", \"City\": \"深圳\" } ], \"JobType\": \"Timed\", \"JobDateTime\": { \"Timed\": [ { \"StartDateTime\": 1711618518, \"EndDateTime\": 1711919518 } ], \"Cron\": [ ], \"TimeTZone\": \"UTC+8\" }, \"Lang\": \"cn\" }", + "member": "AreaBanRule", + "name": "Data", + "output_required": true, + "type": "object", + "value_allowed_null": false + }, + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "DescribeAreaBanSupportAreasRequest": { "document": "DescribeAreaBanSupportAreas请求参数结构体", "members": [], @@ -15970,6 +16206,69 @@ ], "type": "object" }, + "ModifyAreaBanRuleRequest": { + "document": "ModifyAreaBanRule请求参数结构体", + "members": [ + { + "disabled": false, + "document": "需要修改的域名", + "example": "www.qcloudwaf.com", + "member": "string", + "name": "Domain", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "需要新增的封禁地域", + "example": "[{\"Country\":\"中国\",\"Region\":\"广东\",\"City\":\"深圳\"}]", + "member": "Area", + "name": "Areas", + "required": true, + "type": "list" + }, + { + "disabled": false, + "document": "规则执行的方式,TimedJob为定时执行,CronJob为周期执行", + "example": "TimedJob", + "member": "string", + "name": "JobType", + "required": true, + "type": "string" + }, + { + "disabled": false, + "document": "定时任务配置", + "example": "{ \"Timed\": [ { \"StartDateTime\": 1711618518, \"EndDateTime\": 1711918518 } ], \"Cron\": [ { \"Day\": 12, \"WDay\": 2, \"StartTime\": \"12:11\", \"EndTime\": \"21:00\" } ], \"TimeTZone\": \"UTC+8\" }", + "member": "JobDateTime", + "name": "JobDateTime", + "required": true, + "type": "object" + }, + { + "disabled": false, + "document": "地域信息的语言,支持cn、en,默认为中文cn", + "example": "cn", + "member": "string", + "name": "Lang", + "required": false, + "type": "string" + } + ], + "type": "object" + }, + "ModifyAreaBanRuleResponse": { + "document": "ModifyAreaBanRule返回参数结构体", + "members": [ + { + "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。", + "member": "string", + "name": "RequestId", + "type": "string" + } + ], + "type": "object" + }, "ModifyAreaBanStatusRequest": { "document": "ModifyAreaBanStatus请求参数结构体", "members": [ @@ -17595,7 +17894,7 @@ }, { "disabled": false, - "document": "状态", + "document": "1:开启WAF开关,0:关闭WAF开关", "example": "0", "member": "uint64", "name": "Status", diff --git a/tccli/services/waf/v20180125/examples.json b/tccli/services/waf/v20180125/examples.json index b3e23573c7..3cb08eca46 100644 --- a/tccli/services/waf/v20180125/examples.json +++ b/tccli/services/waf/v20180125/examples.json @@ -86,6 +86,14 @@ "title": "创建访问日志导出" } ], + "CreateAreaBanRule": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: waf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBatchAreaBanRule\n<公共请求参数>\n\n{\n \"Domain\": \"www.testwaf.com\",\n \"Areas\": [\n {\n \"Country\": \"中国\",\n \"Region\": \"广东\",\n \"City\": \"深圳\"\n }\n ],\n \"JobType\": \"CronJob\",\n \"JobDateTime\": {\n \"Timed\": [\n {\n \"StartDateTime\": 1711618518,\n \"EndDateTime\": 1711918518\n }\n ],\n \"Cron\": [\n {\n \"Days\": [],\n \"WDays\": [\n 2\n ],\n \"StartTime\": \"12:11\",\n \"EndTime\": \"21:00\"\n }\n ],\n \"TimeTZone\": \"UTC+8\"\n },\n \"Lang\": \"cn\"\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"9b02bf9e-c89c-42c3-9ae1-685f968fa02d\"\n }\n}", + "title": "添加地域封禁规则" + } + ], "CreateDeals": [ { "document": "", @@ -300,6 +308,14 @@ "title": "未设置封禁区域的场景" } ], + "DescribeAreaBanRule": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: waf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSupportAreas\n<公共请求参数>\n\n{\n \"Domain\": \"www.testwaf.com\"\n}", + "output": "{\n \"Response\": {\n \"Data\": {\n \"Status\": 1,\n \"Source\": \"custom\",\n \"Areas\": [\n {\n \"Country\": \"中国\",\n \"Region\": \"广东\",\n \"City\": \"深圳\"\n }\n ],\n \"JobType\": \"Timed\",\n \"JobDateTime\": {\n \"Timed\": [\n {\n \"StartDateTime\": 1711618518,\n \"EndDateTime\": 1711919518\n }\n ],\n \"Cron\": [],\n \"TimeTZone\": \"UTC+8\"\n },\n \"Lang\": \"cn\"\n },\n \"RequestId\": \"9b02bf9e-c89c-42c3-9ae1-685f968fa02d\"\n }\n}", + "title": "获取地域封禁规则" + } + ], "DescribeAreaBanSupportAreas": [ { "document": "", @@ -856,6 +872,14 @@ "title": "ModifyAreaBanAreas" } ], + "ModifyAreaBanRule": [ + { + "document": "", + "input": "POST / HTTP/1.1\nHost: waf.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAreaBanRule\n<公共请求参数>\n\n{\n \"Domain\": \"www.testwaf.com\",\n \"Areas\": [\n {\n \"Country\": \"中国\",\n \"Region\": \"广东\",\n \"City\": \"深圳\"\n }\n ],\n \"JobType\": \"CronJob\",\n \"JobDateTime\": {\n \"Timed\": [\n {\n \"StartDateTime\": 1711618518,\n \"EndDateTime\": 1711918518\n }\n ],\n \"Cron\": [\n {\n \"Days\": [],\n \"WDays\": [\n 2\n ],\n \"StartTime\": \"12:11\",\n \"EndTime\": \"21:00\"\n }\n ],\n \"TimeTZone\": \"UTC+8\"\n }\n}", + "output": "{\n \"Response\": {\n \"RequestId\": \"9b02bf9e-c89c-42c3-9ae1-685f968fa02d\"\n }\n}", + "title": "编辑地域封禁规则" + } + ], "ModifyAreaBanStatus": [ { "document": "", @@ -1057,7 +1081,7 @@ "document": "", "input": "https://waf.tencentcloudapi.com/?Action=ModifyProtectionStatus\r\n&Domain=www.test.com\r\n&Status=0\r\n&<公共请求参数>", "output": "{\n \"Response\": {\n \"RequestId\": \"d680b87a-8c4a-4840-af18-3acb5c9f0e54\"\n }\n}", - "title": "waf斯巴达-waf开关" + "title": "关闭WAF开关" } ], "ModifySpartaProtection": [ diff --git a/tccli/services/waf/waf_client.py b/tccli/services/waf/waf_client.py index 70a99c48a1..f5f461e9d8 100644 --- a/tccli/services/waf/waf_client.py +++ b/tccli/services/waf/waf_client.py @@ -1785,6 +1785,58 @@ def doDeleteAntiInfoLeakRule(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doDescribePeakPoints(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.WafClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.DescribePeakPointsRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.DescribePeakPoints(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 doModifyAreaBanAreas(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -2565,7 +2617,7 @@ def doDescribeAccessFastAnalysis(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) -def doDescribePeakPoints(args, parsed_globals): +def doCreateAreaBanRule(args, parsed_globals): g_param = parse_global_arg(parsed_globals) if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]: @@ -2594,11 +2646,11 @@ def doDescribePeakPoints(args, parsed_globals): client = mod.WafClient(cred, g_param[OptionsDefine.Region], profile) client._sdkVersion += ("_CLI_" + __version__) models = MODELS_MAP[g_param[OptionsDefine.Version]] - model = models.DescribePeakPointsRequest() + model = models.CreateAreaBanRuleRequest() model.from_json_string(json.dumps(args)) start_time = time.time() while True: - rsp = client.DescribePeakPoints(model) + rsp = client.CreateAreaBanRule(model) result = rsp.to_json_string() try: json_obj = json.loads(result) @@ -5789,6 +5841,58 @@ def doGetInstanceQpsLimit(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doDescribeAreaBanRule(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.WafClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.DescribeAreaBanRuleRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.DescribeAreaBanRule(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 doDeleteAccessExport(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -6465,6 +6569,58 @@ def doModifyApiAnalyzeStatus(args, parsed_globals): FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter]) +def doModifyAreaBanRule(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.WafClient(cred, g_param[OptionsDefine.Region], profile) + client._sdkVersion += ("_CLI_" + __version__) + models = MODELS_MAP[g_param[OptionsDefine.Version]] + model = models.ModifyAreaBanRuleRequest() + model.from_json_string(json.dumps(args)) + start_time = time.time() + while True: + rsp = client.ModifyAreaBanRule(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 doDescribeWafAutoDenyStatus(args, parsed_globals): g_param = parse_global_arg(parsed_globals) @@ -7654,6 +7810,7 @@ def doModifyUserLevel(args, parsed_globals): "DescribeWebshellStatus": doDescribeWebshellStatus, "DescribeDomainWhiteRules": doDescribeDomainWhiteRules, "DeleteAntiInfoLeakRule": doDeleteAntiInfoLeakRule, + "DescribePeakPoints": doDescribePeakPoints, "ModifyAreaBanAreas": doModifyAreaBanAreas, "CreateDeals": doCreateDeals, "DescribeAreaBanSupportAreas": doDescribeAreaBanSupportAreas, @@ -7669,7 +7826,7 @@ def doModifyUserLevel(args, parsed_globals): "DescribeVipInfo": doDescribeVipInfo, "DeleteHost": doDeleteHost, "DescribeAccessFastAnalysis": doDescribeAccessFastAnalysis, - "DescribePeakPoints": doDescribePeakPoints, + "CreateAreaBanRule": doCreateAreaBanRule, "ModifyCustomWhiteRule": doModifyCustomWhiteRule, "DescribeCertificateVerifyResult": doDescribeCertificateVerifyResult, "DeleteIpAccessControlV2": doDeleteIpAccessControlV2, @@ -7731,6 +7888,7 @@ def doModifyUserLevel(args, parsed_globals): "ModifyGenerateDeals": doModifyGenerateDeals, "DescribeHostLimit": doDescribeHostLimit, "GetInstanceQpsLimit": doGetInstanceQpsLimit, + "DescribeAreaBanRule": doDescribeAreaBanRule, "DeleteAccessExport": doDeleteAccessExport, "ModifyAntiInfoLeakRuleStatus": doModifyAntiInfoLeakRuleStatus, "DescribeDomainVerifyResult": doDescribeDomainVerifyResult, @@ -7744,6 +7902,7 @@ def doModifyUserLevel(args, parsed_globals): "ModifyInstanceName": doModifyInstanceName, "ModifyModuleStatus": doModifyModuleStatus, "ModifyApiAnalyzeStatus": doModifyApiAnalyzeStatus, + "ModifyAreaBanRule": doModifyAreaBanRule, "DescribeWafAutoDenyStatus": doDescribeWafAutoDenyStatus, "ModifyCustomWhiteRuleStatus": doModifyCustomWhiteRuleStatus, "DescribePorts": doDescribePorts,