tccli 3.0.1200.1__py2.py3-none-any.whl → 3.0.1201.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +3 -0
  3. tccli/services/autoscaling/v20180419/api.json +33 -5
  4. tccli/services/autoscaling/v20180419/examples.json +3 -3
  5. tccli/services/batch/v20170312/api.json +2 -2
  6. tccli/services/ca/__init__.py +4 -0
  7. tccli/services/ca/ca_client.py +301 -0
  8. tccli/services/ca/v20230228/api.json +264 -0
  9. tccli/services/ca/v20230228/examples.json +41 -0
  10. tccli/services/ccc/ccc_client.py +153 -47
  11. tccli/services/ccc/v20200210/api.json +185 -1
  12. tccli/services/ccc/v20200210/examples.json +17 -1
  13. tccli/services/cdn/v20180606/api.json +30 -1
  14. tccli/services/cdwdoris/v20211228/api.json +5 -1
  15. tccli/services/cvm/cvm_client.py +53 -0
  16. tccli/services/cvm/v20170312/api.json +173 -25
  17. tccli/services/cvm/v20170312/examples.json +9 -1
  18. tccli/services/cynosdb/v20190107/api.json +56 -56
  19. tccli/services/dts/v20211206/api.json +12 -12
  20. tccli/services/emr/v20190103/api.json +9 -0
  21. tccli/services/ess/v20201111/api.json +6 -6
  22. tccli/services/essbasic/v20210526/api.json +1 -1
  23. tccli/services/lcic/v20220817/api.json +1 -1
  24. tccli/services/lighthouse/v20200324/api.json +2 -2
  25. tccli/services/mqtt/v20240516/api.json +1 -1
  26. tccli/services/mrs/v20200910/api.json +71 -1
  27. tccli/services/ocr/v20181119/api.json +10 -0
  28. tccli/services/ses/v20201002/api.json +50 -0
  29. tccli/services/ses/v20201002/examples.json +6 -0
  30. tccli/services/teo/teo_client.py +724 -141
  31. tccli/services/teo/v20220901/api.json +993 -106
  32. tccli/services/teo/v20220901/examples.json +112 -0
  33. tccli/services/tke/v20180525/api.json +7 -4
  34. tccli/services/vpc/v20170312/api.json +1273 -17
  35. tccli/services/vpc/v20170312/examples.json +176 -0
  36. tccli/services/vpc/vpc_client.py +1315 -149
  37. {tccli-3.0.1200.1.dist-info → tccli-3.0.1201.1.dist-info}/METADATA +2 -2
  38. {tccli-3.0.1200.1.dist-info → tccli-3.0.1201.1.dist-info}/RECORD +41 -37
  39. {tccli-3.0.1200.1.dist-info → tccli-3.0.1201.1.dist-info}/WHEEL +0 -0
  40. {tccli-3.0.1200.1.dist-info → tccli-3.0.1201.1.dist-info}/entry_points.txt +0 -0
  41. {tccli-3.0.1200.1.dist-info → tccli-3.0.1201.1.dist-info}/license_files/LICENSE +0 -0
@@ -8,21 +8,21 @@
8
8
  "status": "online"
9
9
  },
10
10
  "AddClusterSlaveZone": {
11
- "document": "开启多可用区部署",
11
+ "document": "本接口(AddClusterSlaveZone)用于对集群开启多可用区部署。",
12
12
  "input": "AddClusterSlaveZoneRequest",
13
13
  "name": "开启多可用区部署",
14
14
  "output": "AddClusterSlaveZoneResponse",
15
15
  "status": "online"
16
16
  },
17
17
  "AddInstances": {
18
- "document": "本接口(AddInstances)用于集群添加实例",
18
+ "document": "本接口(AddInstances)用于集群添加实例。",
19
19
  "input": "AddInstancesRequest",
20
20
  "name": "集群添加实例",
21
21
  "output": "AddInstancesResponse",
22
22
  "status": "online"
23
23
  },
24
24
  "AssociateSecurityGroups": {
25
- "document": "安全组批量绑定云资源",
25
+ "document": "本接口(AssociateSecurityGroups)用于安全组批量绑定云资源。",
26
26
  "input": "AssociateSecurityGroupsRequest",
27
27
  "name": "安全组批量绑定云资源",
28
28
  "output": "AssociateSecurityGroupsResponse",
@@ -43,28 +43,28 @@
43
43
  "status": "online"
44
44
  },
45
45
  "CloseClusterPasswordComplexity": {
46
- "document": "本接口(CloseClusterPasswordComplexity)用于关闭集群密码复杂度",
46
+ "document": "本接口(CloseClusterPasswordComplexity)用于关闭集群密码复杂度。",
47
47
  "input": "CloseClusterPasswordComplexityRequest",
48
48
  "name": "关闭集群密码复杂度",
49
49
  "output": "CloseClusterPasswordComplexityResponse",
50
50
  "status": "online"
51
51
  },
52
52
  "CloseProxy": {
53
- "document": "关闭数据库代理",
53
+ "document": "本接口(CloseProxy)用于关闭集群的数据库代理服务。",
54
54
  "input": "CloseProxyRequest",
55
55
  "name": "关闭数据库代理",
56
56
  "output": "CloseProxyResponse",
57
57
  "status": "online"
58
58
  },
59
59
  "CloseWan": {
60
- "document": "本接口(CloseWan)用于关闭外网",
60
+ "document": "本接口(CloseWan)用于关闭外网。",
61
61
  "input": "CloseWanRequest",
62
62
  "name": "关闭外网",
63
63
  "output": "CloseWanResponse",
64
64
  "status": "online"
65
65
  },
66
66
  "CopyClusterPasswordComplexity": {
67
- "document": "本接口(CopyClusterPasswordComplexity)用于复制集群密码复杂度",
67
+ "document": "本接口(CopyClusterPasswordComplexity)用于复制集群密码复杂度。",
68
68
  "input": "CopyClusterPasswordComplexityRequest",
69
69
  "name": "复制集群密码复杂度",
70
70
  "output": "CopyClusterPasswordComplexityResponse",
@@ -127,7 +127,7 @@
127
127
  "status": "online"
128
128
  },
129
129
  "CreateProxy": {
130
- "document": "创建数据库代理",
130
+ "document": "本接口(CreateProxy)用于开启集群的数据库代理。",
131
131
  "input": "CreateProxyRequest",
132
132
  "name": "创建数据库代理",
133
133
  "output": "CreateProxyResponse",
@@ -141,7 +141,7 @@
141
141
  "status": "online"
142
142
  },
143
143
  "CreateResourcePackage": {
144
- "document": "新购资源包",
144
+ "document": "本接口(CreateResourcePackage)用于新购资源包。",
145
145
  "input": "CreateResourcePackageRequest",
146
146
  "name": "新购资源包",
147
147
  "output": "CreateResourcePackageResponse",
@@ -169,7 +169,7 @@
169
169
  "status": "online"
170
170
  },
171
171
  "DeleteBackup": {
172
- "document": "为集群删除手动备份,无法删除自动备份",
172
+ "document": "本接口(DeleteBackup)用于为集群删除手动备份,无法删除自动备份。",
173
173
  "input": "DeleteBackupRequest",
174
174
  "name": "删除手动备份",
175
175
  "output": "DeleteBackupResponse",
@@ -183,7 +183,7 @@
183
183
  "status": "online"
184
184
  },
185
185
  "DeleteClusterDatabase": {
186
- "document": "删除数据库",
186
+ "document": "本接口(DeleteClusterDatabase)用于删除数据库。",
187
187
  "input": "DeleteClusterDatabaseRequest",
188
188
  "name": "删除数据库",
189
189
  "output": "DeleteClusterDatabaseResponse",
@@ -197,7 +197,7 @@
197
197
  "status": "online"
198
198
  },
199
199
  "DescribeAccountAllGrantPrivileges": {
200
- "document": "查询账号所有可授予权限",
200
+ "document": "本接口(DescribeAccountAllGrantPrivileges)用于查询账号所有可授予的权限。",
201
201
  "input": "DescribeAccountAllGrantPrivilegesRequest",
202
202
  "name": "查询账号所有可授予权限",
203
203
  "output": "DescribeAccountAllGrantPrivilegesResponse",
@@ -211,7 +211,7 @@
211
211
  "status": "online"
212
212
  },
213
213
  "DescribeAccounts": {
214
- "document": "本接口(DescribeAccounts)用于查询数据库账号列表",
214
+ "document": "本接口(DescribeAccounts)用于查询数据库账号列表。",
215
215
  "input": "DescribeAccountsRequest",
216
216
  "name": "查询数据库账号列表",
217
217
  "output": "DescribeAccountsResponse",
@@ -253,7 +253,7 @@
253
253
  "status": "online"
254
254
  },
255
255
  "DescribeBackupConfig": {
256
- "document": "获取指定集群的备份配置信息,包括全量备份时间段,备份文件保留时间",
256
+ "document": "本接口(DescribeBackupConfig)用于获取指定集群的备份配置信息,包括全量备份时间段、备份文件保留时间。",
257
257
  "input": "DescribeBackupConfigRequest",
258
258
  "name": "查询备份配置信息",
259
259
  "output": "DescribeBackupConfigResponse",
@@ -267,7 +267,7 @@
267
267
  "status": "online"
268
268
  },
269
269
  "DescribeBackupList": {
270
- "document": "查询备份文件列表",
270
+ "document": "本接口(DescribeBackupList)用于查询集群的备份文件列表。",
271
271
  "input": "DescribeBackupListRequest",
272
272
  "name": "查询备份文件列表",
273
273
  "output": "DescribeBackupListResponse",
@@ -302,7 +302,7 @@
302
302
  "status": "online"
303
303
  },
304
304
  "DescribeChangedParamsAfterUpgrade": {
305
- "document": "本接口(DescribeChangedParamsAfterUpgrade)用于查询升降配运行参数对比",
305
+ "document": "本接口(DescribeChangedParamsAfterUpgrade)用于查询升降配运行参数对比。",
306
306
  "input": "DescribeChangedParamsAfterUpgradeRequest",
307
307
  "name": "升降配运行参数对比",
308
308
  "output": "DescribeChangedParamsAfterUpgradeResponse",
@@ -323,7 +323,7 @@
323
323
  "status": "online"
324
324
  },
325
325
  "DescribeClusterDetailDatabases": {
326
- "document": "查询数据库列表",
326
+ "document": "本接口(DescribeClusterDetailDatabases)用于查询数据库列表。",
327
327
  "input": "DescribeClusterDetailDatabasesRequest",
328
328
  "name": "查询数据库列表",
329
329
  "output": "DescribeClusterDetailDatabasesResponse",
@@ -344,7 +344,7 @@
344
344
  "status": "online"
345
345
  },
346
346
  "DescribeClusterParamLogs": {
347
- "document": "本接口(DescribeClusterParamLogs)查询参数修改记录",
347
+ "document": "本接口(DescribeClusterParamLogs)用于查询参数修改记录。",
348
348
  "input": "DescribeClusterParamLogsRequest",
349
349
  "name": "查询参数修改记录",
350
350
  "output": "DescribeClusterParamLogsResponse",
@@ -379,7 +379,7 @@
379
379
  "status": "online"
380
380
  },
381
381
  "DescribeFlow": {
382
- "document": "本接口(DescribeFlow)用于查询任务流信息",
382
+ "document": "本接口(DescribeFlow)用于查询任务流信息。",
383
383
  "input": "DescribeFlowRequest",
384
384
  "name": "查询任务流信息",
385
385
  "output": "DescribeFlowResponse",
@@ -421,7 +421,7 @@
421
421
  "status": "online"
422
422
  },
423
423
  "DescribeInstanceSpecs": {
424
- "document": "本接口(DescribeInstanceSpecs)用于查询购买页可购买的实例规格",
424
+ "document": "本接口(DescribeInstanceSpecs)用于查询购买页可购买的实例规格。",
425
425
  "input": "DescribeInstanceSpecsRequest",
426
426
  "name": "查询购买页可购买的实例规格",
427
427
  "output": "DescribeInstanceSpecsResponse",
@@ -442,7 +442,7 @@
442
442
  "status": "online"
443
443
  },
444
444
  "DescribeMaintainPeriod": {
445
- "document": "查询实例维护时间窗",
445
+ "document": "本接口(DescribeMaintainPeriod)用于查询实例维护时间窗。",
446
446
  "input": "DescribeMaintainPeriodRequest",
447
447
  "name": "查询实例维护时间窗",
448
448
  "output": "DescribeMaintainPeriodResponse",
@@ -463,7 +463,7 @@
463
463
  "status": "online"
464
464
  },
465
465
  "DescribeProjectSecurityGroups": {
466
- "document": "查询项目安全组信息",
466
+ "document": "本接口(DescribeProjectSecurityGroups)用于查询项目安全组信息。",
467
467
  "input": "DescribeProjectSecurityGroupsRequest",
468
468
  "name": "查询项目安全组信息",
469
469
  "output": "DescribeProjectSecurityGroupsResponse",
@@ -519,7 +519,7 @@
519
519
  "status": "online"
520
520
  },
521
521
  "DescribeRollbackTimeRange": {
522
- "document": "查询回档时间范围",
522
+ "document": "本接口(DescribeRollbackTimeRange)用于查询回档时间范围。",
523
523
  "input": "DescribeRollbackTimeRangeRequest",
524
524
  "name": "查询回档时间范围",
525
525
  "output": "DescribeRollbackTimeRangeResponse",
@@ -554,7 +554,7 @@
554
554
  "status": "online"
555
555
  },
556
556
  "DisassociateSecurityGroups": {
557
- "document": "安全组批量解绑云资源",
557
+ "document": "本接口(DisassociateSecurityGroups)用于安全组批量解绑云资源。",
558
558
  "input": "DisassociateSecurityGroupsRequest",
559
559
  "name": "安全组批量解绑云资源",
560
560
  "output": "DisassociateSecurityGroupsResponse",
@@ -589,7 +589,7 @@
589
589
  "status": "online"
590
590
  },
591
591
  "InquirePriceCreate": {
592
- "document": "查询新购集群价格",
592
+ "document": "本接口(InquirePriceCreate)用于新购集群的价格查询。",
593
593
  "input": "InquirePriceCreateRequest",
594
594
  "name": "新购集群询价",
595
595
  "output": "InquirePriceCreateResponse",
@@ -659,7 +659,7 @@
659
659
  "status": "online"
660
660
  },
661
661
  "ModifyBackupConfig": {
662
- "document": "修改指定集群的备份配置",
662
+ "document": "本接口(ModifyBackupConfig)用于修改指定集群的备份配置。",
663
663
  "input": "ModifyBackupConfigRequest",
664
664
  "name": "修改备份配置",
665
665
  "output": "ModifyBackupConfigResponse",
@@ -687,14 +687,14 @@
687
687
  "status": "online"
688
688
  },
689
689
  "ModifyClusterDatabase": {
690
- "document": "修改数据库",
690
+ "document": "本接口(ModifyClusterDatabase)用于修改数据库的账号授权。",
691
691
  "input": "ModifyClusterDatabaseRequest",
692
692
  "name": "修改数据库",
693
693
  "output": "ModifyClusterDatabaseResponse",
694
694
  "status": "online"
695
695
  },
696
696
  "ModifyClusterName": {
697
- "document": "修改集群名称",
697
+ "document": "本接口(ModifyClusterName)用于修改集群名称。",
698
698
  "input": "ModifyClusterNameRequest",
699
699
  "name": "修改集群名称",
700
700
  "output": "ModifyClusterNameResponse",
@@ -708,14 +708,14 @@
708
708
  "status": "online"
709
709
  },
710
710
  "ModifyClusterPasswordComplexity": {
711
- "document": "本接口(ModifyClusterPasswordComplexity)用于修改/开启集群密码复杂度",
711
+ "document": "本接口(ModifyClusterPasswordComplexity)用于修改/开启集群密码复杂度。",
712
712
  "input": "ModifyClusterPasswordComplexityRequest",
713
713
  "name": "修改集群密码复杂度",
714
714
  "output": "ModifyClusterPasswordComplexityResponse",
715
715
  "status": "online"
716
716
  },
717
717
  "ModifyClusterSlaveZone": {
718
- "document": "变更备可用区",
718
+ "document": "本接口(ModifyClusterSlaveZone)用于变更集群的备可用区。",
719
719
  "input": "ModifyClusterSlaveZoneRequest",
720
720
  "name": "变更备可用区",
721
721
  "output": "ModifyClusterSlaveZoneResponse",
@@ -750,14 +750,14 @@
750
750
  "status": "online"
751
751
  },
752
752
  "ModifyInstanceUpgradeLimitDays": {
753
- "document": "修改实例小版本升级限制时间",
753
+ "document": "本接口(ModifyInstanceUpgradeLimitDays)用于修改实例内核小版本的升级限制时间。",
754
754
  "input": "ModifyInstanceUpgradeLimitDaysRequest",
755
755
  "name": "修改实例小版本升级限制时间",
756
756
  "output": "ModifyInstanceUpgradeLimitDaysResponse",
757
757
  "status": "online"
758
758
  },
759
759
  "ModifyMaintainPeriodConfig": {
760
- "document": "修改维护时间配置",
760
+ "document": "本接口(ModifyMaintainPeriodConfig)用于修改维护时间配置。",
761
761
  "input": "ModifyMaintainPeriodConfigRequest",
762
762
  "name": "修改维护时间配置",
763
763
  "output": "ModifyMaintainPeriodConfigResponse",
@@ -820,7 +820,7 @@
820
820
  "status": "online"
821
821
  },
822
822
  "OfflineCluster": {
823
- "document": "销毁集群",
823
+ "document": "本接口(OfflineCluster)用于销毁集群。",
824
824
  "input": "OfflineClusterRequest",
825
825
  "name": "销毁集群",
826
826
  "output": "OfflineClusterResponse",
@@ -841,35 +841,35 @@
841
841
  "status": "online"
842
842
  },
843
843
  "OpenClusterPasswordComplexity": {
844
- "document": "本接口(OpenClusterPasswordComplexity)用于开启自定义密码复杂度功能",
844
+ "document": "本接口(OpenClusterPasswordComplexity)用于开启自定义密码复杂度功能。",
845
845
  "input": "OpenClusterPasswordComplexityRequest",
846
846
  "name": "开启自定义密码复杂度功能",
847
847
  "output": "OpenClusterPasswordComplexityResponse",
848
848
  "status": "online"
849
849
  },
850
850
  "OpenClusterReadOnlyInstanceGroupAccess": {
851
- "document": "开启只读实例组接入",
851
+ "document": "本接口(OpenClusterReadOnlyInstanceGroupAccess)用于开启只读实例组接入。",
852
852
  "input": "OpenClusterReadOnlyInstanceGroupAccessRequest",
853
853
  "name": "开启只读实例组接入",
854
854
  "output": "OpenClusterReadOnlyInstanceGroupAccessResponse",
855
855
  "status": "online"
856
856
  },
857
857
  "OpenReadOnlyInstanceExclusiveAccess": {
858
- "document": "开通只读实例独有访问接入组",
858
+ "document": "本接口(OpenReadOnlyInstanceExclusiveAccess)用于开通只读实例独有访问接入组。",
859
859
  "input": "OpenReadOnlyInstanceExclusiveAccessRequest",
860
- "name": "开通只读实例独有访问接入组。",
860
+ "name": "开通只读实例独有访问接入组",
861
861
  "output": "OpenReadOnlyInstanceExclusiveAccessResponse",
862
862
  "status": "online"
863
863
  },
864
864
  "OpenWan": {
865
- "document": "本接口(OpenWan)用于开通外网",
865
+ "document": "本接口(OpenWan)用于开通外网。",
866
866
  "input": "OpenWanRequest",
867
867
  "name": "开通外网",
868
868
  "output": "OpenWanResponse",
869
869
  "status": "online"
870
870
  },
871
871
  "PauseServerless": {
872
- "document": "暂停serverless集群",
872
+ "document": "本接口(PauseServerless)用于暂停 serverless 集群。",
873
873
  "input": "PauseServerlessRequest",
874
874
  "name": "暂停serverless集群",
875
875
  "output": "PauseServerlessResponse",
@@ -890,7 +890,7 @@
890
890
  "status": "online"
891
891
  },
892
892
  "RemoveClusterSlaveZone": {
893
- "document": "关闭多可用区部署",
893
+ "document": "本接口(RemoveClusterSlaveZone)用于关闭集群多可用区部署。",
894
894
  "input": "RemoveClusterSlaveZoneRequest",
895
895
  "name": "关闭多可用区部署",
896
896
  "output": "RemoveClusterSlaveZoneResponse",
@@ -918,14 +918,14 @@
918
918
  "status": "online"
919
919
  },
920
920
  "ResumeServerless": {
921
- "document": "恢复serverless集群",
921
+ "document": "本接口(ResumeServerless)用于恢复 serverless 集群(启动暂停的集群)。",
922
922
  "input": "ResumeServerlessRequest",
923
923
  "name": "恢复serverless集群",
924
924
  "output": "ResumeServerlessResponse",
925
925
  "status": "online"
926
926
  },
927
927
  "RevokeAccountPrivileges": {
928
- "document": "批量回收账号权限",
928
+ "document": "本接口(RevokeAccountPrivileges)用于批量回收账号权限。",
929
929
  "input": "RevokeAccountPrivilegesRequest",
930
930
  "name": "批量回收账号权限",
931
931
  "output": "RevokeAccountPrivilegesResponse",
@@ -939,14 +939,14 @@
939
939
  "status": "online"
940
940
  },
941
941
  "RollbackToNewCluster": {
942
- "document": "回档到新集群",
942
+ "document": "本接口(RollbackToNewCluster)用于回档到新集群。",
943
943
  "input": "RollbackToNewClusterRequest",
944
944
  "name": "回档到新集群",
945
945
  "output": "RollbackToNewClusterResponse",
946
946
  "status": "online"
947
947
  },
948
948
  "SearchClusterDatabases": {
949
- "document": "本接口(SearchClusterDatabases)搜索集群数据库列表",
949
+ "document": "本接口(SearchClusterDatabases)用于搜索集群数据库列表。",
950
950
  "input": "SearchClusterDatabasesRequest",
951
951
  "name": "搜索集群数据库列表",
952
952
  "output": "SearchClusterDatabasesResponse",
@@ -967,14 +967,14 @@
967
967
  "status": "online"
968
968
  },
969
969
  "StartCLSDelivery": {
970
- "document": "开启日志投递",
970
+ "document": "本接口(StartCLSDelivery)用于开启日志投递功能。",
971
971
  "input": "StartCLSDeliveryRequest",
972
972
  "name": "开启日志投递",
973
973
  "output": "StartCLSDeliveryResponse",
974
974
  "status": "online"
975
975
  },
976
976
  "StopCLSDelivery": {
977
- "document": "停止日志投递",
977
+ "document": "本接口(StopCLSDelivery)用于停止日志投递功能。",
978
978
  "input": "StopCLSDeliveryRequest",
979
979
  "name": "停止日志投递",
980
980
  "output": "StopCLSDeliveryResponse",
@@ -988,7 +988,7 @@
988
988
  "status": "online"
989
989
  },
990
990
  "SwitchClusterZone": {
991
- "document": "主备可用区切换",
991
+ "document": "本接口(SwitchClusterZone)用于切换集群的主备可用区。",
992
992
  "input": "SwitchClusterZoneRequest",
993
993
  "name": "主备可用区切换",
994
994
  "output": "SwitchClusterZoneResponse",
@@ -1009,14 +1009,14 @@
1009
1009
  "status": "online"
1010
1010
  },
1011
1011
  "UpgradeClusterVersion": {
1012
- "document": "更新内核小版本",
1012
+ "document": "本接口(UpgradeClusterVersion)用于更新内核小版本。",
1013
1013
  "input": "UpgradeClusterVersionRequest",
1014
1014
  "name": "更新内核小版本",
1015
1015
  "output": "UpgradeClusterVersionResponse",
1016
1016
  "status": "online"
1017
1017
  },
1018
1018
  "UpgradeInstance": {
1019
- "document": "实例变配",
1019
+ "document": "本接口(UpgradeInstance)用于实例变配。",
1020
1020
  "input": "UpgradeInstanceRequest",
1021
1021
  "name": "实例变配",
1022
1022
  "output": "UpgradeInstanceResponse",
@@ -1571,8 +1571,8 @@
1571
1571
  "members": [
1572
1572
  {
1573
1573
  "disabled": false,
1574
- "document": "实例组ID数组",
1575
- "example": "cynosdbmysql-ins-4senc2fm",
1574
+ "document": "实例组 ID 数组,cynosdbmysql-grp-前缀开头或集群 ID。\n说明:要获取集群的实例组 ID,可通过 [查询集群实例组](https://cloud.tencent.com/document/product/1003/103934) 进行。",
1575
+ "example": "cynosdbmysql-grp-beg2j3v0",
1576
1576
  "member": "string",
1577
1577
  "name": "InstanceIds",
1578
1578
  "required": true,
@@ -11785,8 +11785,8 @@
11785
11785
  "members": [
11786
11786
  {
11787
11787
  "disabled": false,
11788
- "document": "实例组ID数组",
11789
- "example": "cynosdbmysql-ins-4senc2fm",
11788
+ "document": "实例组 ID 数组,cynosdbmysql-grp-前缀开头或集群 ID。\n说明:要获取集群的实例组 ID,可通过 [查询集群实例组](https://cloud.tencent.com/document/product/1003/103934) 进行。",
11789
+ "example": "cynosdbmysql-grp-beg2j3v0",
11790
11790
  "member": "string",
11791
11791
  "name": "InstanceIds",
11792
11792
  "required": true,
@@ -11803,7 +11803,7 @@
11803
11803
  },
11804
11804
  {
11805
11805
  "disabled": false,
11806
- "document": "可用区",
11806
+ "document": "可用区。\n说明:请正确输入集群所在的主可用区,若输入非集群所在的主可用区可能显示调用成功,但实际执行会失败。",
11807
11807
  "example": "ap-guangzhou-3",
11808
11808
  "member": "string",
11809
11809
  "name": "Zone",
@@ -14543,8 +14543,8 @@
14543
14543
  "members": [
14544
14544
  {
14545
14545
  "disabled": false,
14546
- "document": "实例组ID",
14547
- "example": "cynosdbmysql-ins-4senc2fm",
14546
+ "document": "网络组id(cynosdbmysql-grp-前缀开头)或集群id",
14547
+ "example": "cynosdbmysql-grp-4senc2fm",
14548
14548
  "member": "string",
14549
14549
  "name": "InstanceId",
14550
14550
  "required": true,
@@ -2592,7 +2592,7 @@
2592
2592
  },
2593
2593
  {
2594
2594
  "disabled": false,
2595
- "document": "临时密钥Id,可通过 获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195\n注意:此字段可能返回 null,表示取不到有效值。",
2595
+ "document": "临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。\n注意:此字段可能返回 null,表示取不到有效值。",
2596
2596
  "example": "AKID5XXXXX",
2597
2597
  "member": "string",
2598
2598
  "name": "TmpSecretId",
@@ -2603,7 +2603,7 @@
2603
2603
  },
2604
2604
  {
2605
2605
  "disabled": false,
2606
- "document": "临时密钥Key,可通过 获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195\n注意:此字段可能返回 null,表示取不到有效值。",
2606
+ "document": "临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。\n注意:此字段可能返回 null,表示取不到有效值。",
2607
2607
  "example": "2qZDsXXXXX",
2608
2608
  "member": "string",
2609
2609
  "name": "TmpSecretKey",
@@ -2614,7 +2614,7 @@
2614
2614
  },
2615
2615
  {
2616
2616
  "disabled": false,
2617
- "document": "临时Token,可通过 获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195\n注意:此字段可能返回 null,表示取不到有效值。",
2617
+ "document": "临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。\n注意:此字段可能返回 null,表示取不到有效值。",
2618
2618
  "example": "NRUkuXXXXX",
2619
2619
  "member": "string",
2620
2620
  "name": "TmpToken",
@@ -3623,7 +3623,7 @@
3623
3623
  },
3624
3624
  {
3625
3625
  "disabled": false,
3626
- "document": "临时密钥Id,若为跨账号资源此项必填",
3626
+ "document": "临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。",
3627
3627
  "example": "AKIDJXXXXX",
3628
3628
  "member": "string",
3629
3629
  "name": "TmpSecretId",
@@ -3632,7 +3632,7 @@
3632
3632
  },
3633
3633
  {
3634
3634
  "disabled": false,
3635
- "document": "临时密钥Key,若为跨账号资源此项必填",
3635
+ "document": "临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。",
3636
3636
  "example": "vobJwXXXXX",
3637
3637
  "member": "string",
3638
3638
  "name": "TmpSecretKey",
@@ -3641,7 +3641,7 @@
3641
3641
  },
3642
3642
  {
3643
3643
  "disabled": false,
3644
- "document": "临时密钥Token,若为跨账号资源此项必填",
3644
+ "document": "临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。",
3645
3645
  "example": "MvIVqXXXXX",
3646
3646
  "member": "string",
3647
3647
  "name": "TmpToken",
@@ -5820,7 +5820,7 @@
5820
5820
  },
5821
5821
  {
5822
5822
  "disabled": false,
5823
- "document": "临时密钥Id,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,如果为跨账号实例此项必填\n注意:此字段可能返回 null,表示取不到有效值。",
5823
+ "document": "临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。\n注意:此字段可能返回 null,表示取不到有效值。",
5824
5824
  "example": "AKID5XXXXX",
5825
5825
  "member": "string",
5826
5826
  "name": "TmpSecretId",
@@ -5831,7 +5831,7 @@
5831
5831
  },
5832
5832
  {
5833
5833
  "disabled": false,
5834
- "document": "临时密钥Key,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填\n注意:此字段可能返回 null,表示取不到有效值。",
5834
+ "document": "临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。\n注意:此字段可能返回 null,表示取不到有效值。",
5835
5835
  "example": "2qZDXXXXX",
5836
5836
  "member": "string",
5837
5837
  "name": "TmpSecretKey",
@@ -5842,7 +5842,7 @@
5842
5842
  },
5843
5843
  {
5844
5844
  "disabled": false,
5845
- "document": "临时Token,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填\n注意:此字段可能返回 null,表示取不到有效值。",
5845
+ "document": "临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。\n注意:此字段可能返回 null,表示取不到有效值。",
5846
5846
  "example": "JOqqCXXXXX",
5847
5847
  "member": "string",
5848
5848
  "name": "TmpToken",
@@ -6839,7 +6839,7 @@
6839
6839
  },
6840
6840
  {
6841
6841
  "disabled": false,
6842
- "document": "迁移类型,full(全量迁移),structure(结构迁移),fullAndIncrement(全量加增量迁移), 默认为fullAndIncrement\n注意:此字段可能返回 null,表示取不到有效值。",
6842
+ "document": "迁移类型,full(全量迁移),structure(结构迁移),fullAndIncrement(全量加增量迁移), 默认为fullAndIncrement;注意redis,keewidb产品只支持fullAndIncrement类型。\n注意:此字段可能返回 null,表示取不到有效值。",
6843
6843
  "example": "fullAndIncrement",
6844
6844
  "member": "string",
6845
6845
  "name": "MigrateType",
@@ -6861,7 +6861,7 @@
6861
6861
  },
6862
6862
  {
6863
6863
  "disabled": false,
6864
- "document": "是否迁移账号,yes(迁移账号),no(不迁移账号)\n注意:此字段可能返回 null,表示取不到有效值。",
6864
+ "document": "是否迁移账号,true(迁移账号),false(不迁移账号)\n注意:此字段可能返回 null,表示取不到有效值。",
6865
6865
  "example": "false",
6866
6866
  "member": "bool",
6867
6867
  "name": "IsMigrateAccount",
@@ -6894,7 +6894,7 @@
6894
6894
  },
6895
6895
  {
6896
6896
  "disabled": false,
6897
- "document": "其他附加信息,对于特定库可设置额外参数,Redis可定义如下的参数: \n[\"DstWriteMode\":normal, \t目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样,不做额外动作) \t\"IsDstReadOnly\":true, \t是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) \t\"ClientOutputBufferHardLimit\":512, \t从机缓冲区的硬性容量限制(MB) \t\"ClientOutputBufferSoftLimit\":512, \t从机缓冲区的软性容量限制(MB) \t\"ClientOutputBufferPersistTime\":60, 从机缓冲区的软性限制持续时间(秒) \t\"ReplBacklogSize\":512, \t环形缓冲区容量限制(MB) \t\"ReplTimeout\":120,\t\t复制超时时间(秒)]\n注意:此字段可能返回 null,表示取不到有效值。",
6897
+ "document": "其他附加信息,对于特定库可设置额外参数,Redis可定义如下的参数: \n[\"DstWriteMode\":normal, \t目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样,不做额外动作) \t\"IsDstReadOnly\":true, \t是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) \t\"ClientOutputBufferHardLimit\":512, \t从机缓冲区的硬性容量限制(MB) \t\"ClientOutputBufferSoftLimit\":512, \t从机缓冲区的软性容量限制(MB) \t\"ClientOutputBufferPersistTime\":60, 从机缓冲区的软性限制持续时间(秒) \t\"ReplBacklogSize\":512, \t环形缓冲区容量限制(MB) \t\"ReplTimeout\":120,\t\t复制超时时间(秒) \t\"IsExpireKey\":\"true\",过期key自动淘汰]\n注意:此字段可能返回 null,表示取不到有效值。",
6898
6898
  "example": "无",
6899
6899
  "member": "KeyValuePairOption",
6900
6900
  "name": "ExtraAttr",
@@ -4408,6 +4408,15 @@
4408
4408
  "name": "Page",
4409
4409
  "required": true,
4410
4410
  "type": "int"
4411
+ },
4412
+ {
4413
+ "disabled": false,
4414
+ "document": "查询类型,支持HIVE,SPARK,MAPREDUCE,TRINO等类型,默认查询全部",
4415
+ "example": "HIVE",
4416
+ "member": "string",
4417
+ "name": "Type",
4418
+ "required": false,
4419
+ "type": "string"
4411
4420
  }
4412
4421
  ],
4413
4422
  "type": "object"
@@ -435,7 +435,7 @@
435
435
  "status": "online"
436
436
  },
437
437
  "DescribeFlowBriefs": {
438
- "document": "查询流程基础信息\n适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。\n\n注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`",
438
+ "document": "查询流程基础信息,主要用于<font color=\"red\">查询合同的状态</font>信息。可以配合回调通知使用。\n\n注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`",
439
439
  "input": "DescribeFlowBriefsRequest",
440
440
  "name": "查询流程基础信息",
441
441
  "output": "DescribeFlowBriefsResponse",
@@ -4386,7 +4386,7 @@
4386
4386
  "members": [
4387
4387
  {
4388
4388
  "disabled": false,
4389
- "document": "合同流程ID,为32位字符串。\n建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)",
4389
+ "document": "合同流程ID32位字符串。\n\n您可以登录腾讯电子签控制台,在 \"合同\" -> \"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。\n",
4390
4390
  "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
4391
4391
  "member": "string",
4392
4392
  "name": "FlowId",
@@ -4413,7 +4413,7 @@
4413
4413
  },
4414
4414
  {
4415
4415
  "disabled": false,
4416
- "document": "流程签署人列表,其中结构体的ApproverNameApproverMobile和ApproverType必传,企业签署人则需传OrganizationName,其他可不传。\n\n注:\n`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`\n`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`",
4416
+ "document": "流程签署人列表中,结构体的ApproverNameApproverMobile和ApproverType为必传字段。如果是企业签署人,还需传递OrganizationName。\n\n注:\n1. 签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。\n2. 生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。\n\n",
4417
4417
  "example": "无",
4418
4418
  "member": "FlowCreateApprover",
4419
4419
  "name": "FlowApproverInfos",
@@ -4440,7 +4440,7 @@
4440
4440
  },
4441
4441
  {
4442
4442
  "disabled": false,
4443
- "document": "链接类型,支持指定以下类型\n<ul><li>0 : 签署链接 (默认值)</li>\n<li>1 : 预览链接</li></ul>\n注:\n`1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`\n`2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`",
4443
+ "document": "链接类型支持以下指定类型:\n\n<ul><li><b>0</b>: 签署链接(默认值),进入后可以填写或签署合同。</li><li><b>1 </b>: 预览链接,进入后可以预览合同当前的样子。</li></ul>\n\n注:\n\n1. 当指定链接类型为1时,链接为预览链接,打开链接后无法进行签署操作,仅支持预览和查看当前合同状态。\n2. 如需生成发起方预览链接,则签署方信息应传空,即FlowApproverInfos传空或者不传。",
4444
4444
  "example": "0",
4445
4445
  "member": "int64",
4446
4446
  "name": "UrlType",
@@ -8201,7 +8201,7 @@
8201
8201
  },
8202
8202
  {
8203
8203
  "disabled": false,
8204
- "document": "查询的合同流程ID列表最多支持100个流程ID。 \n如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。\n\n可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。\n\n[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
8204
+ "document": "查询的合同流程ID列表最多支持100个流程ID。 \n\n如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。\n\n可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
8205
8205
  "example": "[yDRCLUUgygq2xun5UuO4zjEwg0vjoimj]",
8206
8206
  "member": "string",
8207
8207
  "name": "FlowIds",
@@ -10795,7 +10795,7 @@
10795
10795
  },
10796
10796
  {
10797
10797
  "disabled": false,
10798
- "document": "<b>只有在生成H5签署链接的情形下</b>( 如调用<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowSignUrl\" target=\"_blank\">获取H5签署链接</a>、<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateBatchQuickSignUrl\" target=\"_blank\">获取H5批量签署链接</a>等接口),该配置才会生效。\n\n您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。\n\n注意:\n1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。\n2. 使用视频认证时,<b>合同发起的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。\n3. 签署完成后,可以通过<a href=\"https://qian.tencent.com/developers/companyApis/queryFlows/DescribeSignFaceVideo\" target=\"_blank\">查询签署认证人脸视频</a>获取到当时的视频。",
10798
+ "document": "<b>只有在生成H5签署链接的情形下</b>( 如调用<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowSignUrl\" target=\"_blank\">获取H5签署链接</a>、<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateBatchQuickSignUrl\" target=\"_blank\">获取H5批量签署链接</a>等接口),该配置才会生效。\n\n您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。\n\n注意:\n1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。\n2. 使用视频认证时,<b>生成H5签署链接必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。\n3. 签署完成后,可以通过<a href=\"https://qian.tencent.com/developers/companyApis/queryFlows/DescribeSignFaceVideo\" target=\"_blank\">查询签署认证人脸视频</a>获取到当时的视频。",
10799
10799
  "example": "无",
10800
10800
  "member": "Intention",
10801
10801
  "name": "Intention",