tccli 3.0.1134.1__py2.py3-none-any.whl → 3.0.1135.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.
tccli/__init__.py CHANGED
@@ -1 +1 @@
1
- __version__ = '3.0.1134.1'
1
+ __version__ = '3.0.1135.1'
@@ -433,6 +433,58 @@ def doIsolateDBInstance(args, parsed_globals):
433
433
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
434
434
 
435
435
 
436
+ def doDescribeRoGroups(args, parsed_globals):
437
+ g_param = parse_global_arg(parsed_globals)
438
+
439
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
440
+ cred = credential.CVMRoleCredential()
441
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
442
+ cred = credential.STSAssumeRoleCredential(
443
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
444
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
445
+ )
446
+ 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):
447
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
448
+ else:
449
+ cred = credential.Credential(
450
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
451
+ )
452
+ http_profile = HttpProfile(
453
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
454
+ reqMethod="POST",
455
+ endpoint=g_param[OptionsDefine.Endpoint],
456
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
457
+ )
458
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
459
+ if g_param[OptionsDefine.Language]:
460
+ profile.language = g_param[OptionsDefine.Language]
461
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
462
+ client = mod.CdbClient(cred, g_param[OptionsDefine.Region], profile)
463
+ client._sdkVersion += ("_CLI_" + __version__)
464
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
465
+ model = models.DescribeRoGroupsRequest()
466
+ model.from_json_string(json.dumps(args))
467
+ start_time = time.time()
468
+ while True:
469
+ rsp = client.DescribeRoGroups(model)
470
+ result = rsp.to_json_string()
471
+ try:
472
+ json_obj = json.loads(result)
473
+ except TypeError as e:
474
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
475
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
476
+ break
477
+ cur_time = time.time()
478
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
479
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
480
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
481
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
482
+ else:
483
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
484
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
485
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
486
+
487
+
436
488
  def doDescribeAccounts(args, parsed_globals):
437
489
  g_param = parse_global_arg(parsed_globals)
438
490
 
@@ -1005,7 +1057,7 @@ def doStopRollback(args, parsed_globals):
1005
1057
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
1006
1058
 
1007
1059
 
1008
- def doDescribeRoGroups(args, parsed_globals):
1060
+ def doDescribeInstanceUpgradeType(args, parsed_globals):
1009
1061
  g_param = parse_global_arg(parsed_globals)
1010
1062
 
1011
1063
  if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
@@ -1034,11 +1086,11 @@ def doDescribeRoGroups(args, parsed_globals):
1034
1086
  client = mod.CdbClient(cred, g_param[OptionsDefine.Region], profile)
1035
1087
  client._sdkVersion += ("_CLI_" + __version__)
1036
1088
  models = MODELS_MAP[g_param[OptionsDefine.Version]]
1037
- model = models.DescribeRoGroupsRequest()
1089
+ model = models.DescribeInstanceUpgradeTypeRequest()
1038
1090
  model.from_json_string(json.dumps(args))
1039
1091
  start_time = time.time()
1040
1092
  while True:
1041
- rsp = client.DescribeRoGroups(model)
1093
+ rsp = client.DescribeInstanceUpgradeType(model)
1042
1094
  result = rsp.to_json_string()
1043
1095
  try:
1044
1096
  json_obj = json.loads(result)
@@ -8564,6 +8616,7 @@ ACTION_MAP = {
8564
8616
  "CreateAuditRuleTemplate": doCreateAuditRuleTemplate,
8565
8617
  "BalanceRoGroupLoad": doBalanceRoGroupLoad,
8566
8618
  "IsolateDBInstance": doIsolateDBInstance,
8619
+ "DescribeRoGroups": doDescribeRoGroups,
8567
8620
  "DescribeAccounts": doDescribeAccounts,
8568
8621
  "ModifyInstanceTag": doModifyInstanceTag,
8569
8622
  "DescribeTimeWindow": doDescribeTimeWindow,
@@ -8575,7 +8628,7 @@ ACTION_MAP = {
8575
8628
  "DescribeCdbZoneConfig": doDescribeCdbZoneConfig,
8576
8629
  "CloseAuditService": doCloseAuditService,
8577
8630
  "StopRollback": doStopRollback,
8578
- "DescribeRoGroups": doDescribeRoGroups,
8631
+ "DescribeInstanceUpgradeType": doDescribeInstanceUpgradeType,
8579
8632
  "OfflineIsolatedInstances": doOfflineIsolatedInstances,
8580
8633
  "CreateAuditLogFile": doCreateAuditLogFile,
8581
8634
  "OpenDBInstanceGTID": doOpenDBInstanceGTID,
@@ -588,6 +588,13 @@
588
588
  "output": "DescribeInstanceParamsResponse",
589
589
  "status": "online"
590
590
  },
591
+ "DescribeInstanceUpgradeType": {
592
+ "document": "本接口(DescribeInstanceUpgradeType)用于查询数据库实例升级类型。",
593
+ "input": "DescribeInstanceUpgradeTypeRequest",
594
+ "name": "查询数据库实例升级类型",
595
+ "output": "DescribeInstanceUpgradeTypeResponse",
596
+ "status": "online"
597
+ },
591
598
  "DescribeLocalBinlogConfig": {
592
599
  "document": "该接口用于查询实例本地binlog保留策略。",
593
600
  "input": "DescribeLocalBinlogConfigRequest",
@@ -4223,6 +4230,30 @@
4223
4230
  ],
4224
4231
  "usage": "both"
4225
4232
  },
4233
+ "ClusterTopology": {
4234
+ "document": "集群版的节点拓扑配置。",
4235
+ "members": [
4236
+ {
4237
+ "disabled": false,
4238
+ "document": "RW 节点拓扑。",
4239
+ "example": "无",
4240
+ "member": "ReadWriteNode",
4241
+ "name": "ReadWriteNode",
4242
+ "required": false,
4243
+ "type": "object"
4244
+ },
4245
+ {
4246
+ "disabled": false,
4247
+ "document": "RO 节点拓扑。",
4248
+ "example": "无",
4249
+ "member": "ReadonlyNode",
4250
+ "name": "ReadOnlyNodes",
4251
+ "required": false,
4252
+ "type": "list"
4253
+ }
4254
+ ],
4255
+ "usage": "in"
4256
+ },
4226
4257
  "ColumnPrivilege": {
4227
4258
  "document": "列权限信息",
4228
4259
  "members": [
@@ -10858,6 +10889,161 @@
10858
10889
  ],
10859
10890
  "type": "object"
10860
10891
  },
10892
+ "DescribeInstanceUpgradeTypeRequest": {
10893
+ "document": "DescribeInstanceUpgradeType请求参数结构体",
10894
+ "members": [
10895
+ {
10896
+ "disabled": false,
10897
+ "document": "实例id",
10898
+ "example": "cdb-xxx",
10899
+ "member": "string",
10900
+ "name": "InstanceId",
10901
+ "required": true,
10902
+ "type": "string"
10903
+ },
10904
+ {
10905
+ "disabled": false,
10906
+ "document": "目标实例cpu",
10907
+ "example": "2",
10908
+ "member": "float",
10909
+ "name": "DstCpu",
10910
+ "required": true,
10911
+ "type": "float"
10912
+ },
10913
+ {
10914
+ "disabled": false,
10915
+ "document": "目标实例内存",
10916
+ "example": "4000",
10917
+ "member": "uint64",
10918
+ "name": "DstMemory",
10919
+ "required": true,
10920
+ "type": "int"
10921
+ },
10922
+ {
10923
+ "disabled": false,
10924
+ "document": "目标实例磁盘",
10925
+ "example": "8000",
10926
+ "member": "uint64",
10927
+ "name": "DstDisk",
10928
+ "required": true,
10929
+ "type": "int"
10930
+ },
10931
+ {
10932
+ "disabled": false,
10933
+ "document": "目标实例版本",
10934
+ "example": "5.7",
10935
+ "member": "string",
10936
+ "name": "DstVersion",
10937
+ "required": false,
10938
+ "type": "string"
10939
+ },
10940
+ {
10941
+ "disabled": false,
10942
+ "document": "目标实例部署模型",
10943
+ "example": "0",
10944
+ "member": "int64",
10945
+ "name": "DstDeployMode",
10946
+ "required": false,
10947
+ "type": "int"
10948
+ },
10949
+ {
10950
+ "disabled": false,
10951
+ "document": "目标实例复制类型",
10952
+ "example": "0",
10953
+ "member": "int64",
10954
+ "name": "DstProtectMode",
10955
+ "required": false,
10956
+ "type": "int"
10957
+ },
10958
+ {
10959
+ "disabled": false,
10960
+ "document": "目标实例备机1可用区",
10961
+ "example": "100001",
10962
+ "member": "int64",
10963
+ "name": "DstSlaveZone",
10964
+ "required": false,
10965
+ "type": "int"
10966
+ },
10967
+ {
10968
+ "disabled": false,
10969
+ "document": "目标实例备机2可用区",
10970
+ "example": "100001",
10971
+ "member": "int64",
10972
+ "name": "DstBackupZone",
10973
+ "required": false,
10974
+ "type": "int"
10975
+ },
10976
+ {
10977
+ "disabled": false,
10978
+ "document": "目标实例类型",
10979
+ "example": "CUSTOM",
10980
+ "member": "string",
10981
+ "name": "DstCdbType",
10982
+ "required": false,
10983
+ "type": "string"
10984
+ },
10985
+ {
10986
+ "disabled": false,
10987
+ "document": "目标实例主可用区",
10988
+ "example": "100001",
10989
+ "member": "int64",
10990
+ "name": "DstZoneId",
10991
+ "required": false,
10992
+ "type": "int"
10993
+ },
10994
+ {
10995
+ "disabled": false,
10996
+ "document": "独享集群CDB实例的节点分布情况",
10997
+ "example": "无",
10998
+ "member": "NodeDistribution",
10999
+ "name": "NodeDistribution",
11000
+ "required": false,
11001
+ "type": "object"
11002
+ },
11003
+ {
11004
+ "disabled": false,
11005
+ "document": "集群版的节点拓扑配置",
11006
+ "example": "无",
11007
+ "member": "ClusterTopology",
11008
+ "name": "ClusterTopology",
11009
+ "required": false,
11010
+ "type": "object"
11011
+ }
11012
+ ],
11013
+ "type": "object"
11014
+ },
11015
+ "DescribeInstanceUpgradeTypeResponse": {
11016
+ "document": "DescribeInstanceUpgradeType返回参数结构体",
11017
+ "members": [
11018
+ {
11019
+ "disabled": false,
11020
+ "document": "实例id",
11021
+ "example": "cdb-xxx",
11022
+ "member": "string",
11023
+ "name": "InstanceId",
11024
+ "output_required": true,
11025
+ "type": "string",
11026
+ "value_allowed_null": false
11027
+ },
11028
+ {
11029
+ "disabled": false,
11030
+ "document": "实例升级类型",
11031
+ "example": "Trsf",
11032
+ "member": "string",
11033
+ "name": "UpgradeType",
11034
+ "output_required": true,
11035
+ "type": "string",
11036
+ "value_allowed_null": false
11037
+ },
11038
+ {
11039
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
11040
+ "member": "string",
11041
+ "name": "RequestId",
11042
+ "type": "string"
11043
+ }
11044
+ ],
11045
+ "type": "object"
11046
+ },
10861
11047
  "DescribeLocalBinlogConfigRequest": {
10862
11048
  "document": "DescribeLocalBinlogConfig请求参数结构体",
10863
11049
  "members": [
@@ -16097,6 +16283,42 @@
16097
16283
  ],
16098
16284
  "type": "object"
16099
16285
  },
16286
+ "NodeDistribution": {
16287
+ "document": "独享集群CDB实例的节点分布情况",
16288
+ "members": [
16289
+ {
16290
+ "disabled": false,
16291
+ "document": "主实例Master节点所在主机ID或者只读实例所在主机ID",
16292
+ "example": "dch-fexbu7pp",
16293
+ "member": "string",
16294
+ "name": "Node",
16295
+ "required": true,
16296
+ "type": "string",
16297
+ "value_allowed_null": false
16298
+ },
16299
+ {
16300
+ "disabled": false,
16301
+ "document": "主实例第一Slave节点所在主机ID",
16302
+ "example": "dch-cawss6q",
16303
+ "member": "string",
16304
+ "name": "SlaveNodeOne",
16305
+ "required": true,
16306
+ "type": "string",
16307
+ "value_allowed_null": false
16308
+ },
16309
+ {
16310
+ "disabled": false,
16311
+ "document": "主实例第二Slave节点所在主机ID",
16312
+ "example": "dch-bsxj39l",
16313
+ "member": "string",
16314
+ "name": "SlaveNodeTwo",
16315
+ "required": true,
16316
+ "type": "string",
16317
+ "value_allowed_null": false
16318
+ }
16319
+ ],
16320
+ "usage": "in"
16321
+ },
16100
16322
  "OfflineIsolatedInstancesRequest": {
16101
16323
  "document": "OfflineIsolatedInstances请求参数结构体",
16102
16324
  "members": [
@@ -17320,6 +17542,54 @@
17320
17542
  ],
17321
17543
  "usage": "in"
17322
17544
  },
17545
+ "ReadWriteNode": {
17546
+ "document": "集群版 RW 节点的配置。",
17547
+ "members": [
17548
+ {
17549
+ "disabled": false,
17550
+ "document": "RW 节点所在可用区。",
17551
+ "example": "ap-guangzhou-4",
17552
+ "member": "string",
17553
+ "name": "Zone",
17554
+ "required": true,
17555
+ "type": "string"
17556
+ },
17557
+ {
17558
+ "disabled": false,
17559
+ "document": "升级集群版实例时,如果要调整只读节点可用区,需要指定节点id。",
17560
+ "example": "dbn-73ktfl1j",
17561
+ "member": "string",
17562
+ "name": "NodeId",
17563
+ "required": false,
17564
+ "type": "string"
17565
+ }
17566
+ ],
17567
+ "usage": "in"
17568
+ },
17569
+ "ReadonlyNode": {
17570
+ "document": "集群版的 RO 节点配置。",
17571
+ "members": [
17572
+ {
17573
+ "disabled": false,
17574
+ "document": "是否分布在随机可用区。传入YES表示随机可用区。否则使用Zone指定的可用区。",
17575
+ "example": "YES",
17576
+ "member": "string",
17577
+ "name": "IsRandomZone",
17578
+ "required": false,
17579
+ "type": "string"
17580
+ },
17581
+ {
17582
+ "disabled": false,
17583
+ "document": "指定该节点分布在哪个可用区。",
17584
+ "example": "无",
17585
+ "member": "string",
17586
+ "name": "Zone",
17587
+ "required": false,
17588
+ "type": "string"
17589
+ }
17590
+ ],
17591
+ "usage": "in"
17592
+ },
17323
17593
  "ReleaseIsolatedDBInstancesRequest": {
17324
17594
  "document": "ReleaseIsolatedDBInstances请求参数结构体",
17325
17595
  "members": [
@@ -714,6 +714,14 @@
714
714
  "title": "查询实例的可设置参数列表"
715
715
  }
716
716
  ],
717
+ "DescribeInstanceUpgradeType": [
718
+ {
719
+ "document": "",
720
+ "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceUpgradeType\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdb-xxxxx\",\n \"DstCpu\": 1,\n \"DstMemory\": 1000,\n \"DstDisk\": 200,\n \"DstVersion\": \"8.0\",\n \"DstProtectMode\": 0,\n \"DstDeployMode\": 0,\n \"DstSlaveZone\": 100003,\n \"DstBackupZone\": 0,\n \"DstCdbType\": \"CUSTOM\"\n}",
721
+ "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"InstanceId\": \"cdb-xxx\",\n \"UpgradeType\": \"Trsf\"\n }\n}",
722
+ "title": "查询数据库实例升级类型"
723
+ }
724
+ ],
717
725
  "DescribeLocalBinlogConfig": [
718
726
  {
719
727
  "document": "",
@@ -7587,7 +7587,7 @@
7587
7587
  "members": [
7588
7588
  {
7589
7589
  "disabled": false,
7590
- "document": "* topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用PreciseSearch参数设置为精确匹配。类型:String。必选:否\n* logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用PreciseSearch参数设置为精确匹配。类型:String。必选:否\n* topicId 按照【日志主题ID】进行过滤。类型:String。必选:否\n* logsetId 按照【日志集ID】进行过滤,可通过调用DescribeLogsets查询已创建的日志集列表或登录控制台进行查看;也可以调用CreateLogset创建新的日志集。类型:String。必选:否\n* tagKey 按照【标签键】进行过滤。类型:String。必选:否\n* tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换,例如tag:exampleKey。类型:String。必选:否\n* storageType 按照【日志主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否\n\n注意:每次请求的Filters的上限为10,Filter.Values的上限为100。",
7590
+ "document": "<ul><li>topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>\n<li>logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>\n<li>topicId 按照【日志主题ID】进行过滤。类型:String。必选:否</li>\n<li>logsetId 按照【日志集ID】进行过滤,可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看;也可以调用 CreateLogset 创建新的日志集。类型:String。必选:否</li>\n<li>tagKey 按照【标签键】进行过滤。类型:String。必选:否</li>\n<li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否</li>\n<li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否</li></ul>\n注意:每次请求的 Filters 的上限为10,Filter.Values 的上限为100。",
7591
7591
  "example": "无",
7592
7592
  "member": "Filter",
7593
7593
  "name": "Filters",
@@ -7614,7 +7614,7 @@
7614
7614
  },
7615
7615
  {
7616
7616
  "disabled": false,
7617
- "document": "控制Filters相关字段是否为精确匹配。\n- 0: 默认值,topicName和logsetName模糊匹配\n- 1: topicName精确匹配\n- 2: logsetName精确匹配\n- 3: topicName和logsetName都精确匹配",
7617
+ "document": "控制Filters相关字段是否为精确匹配。\n<ul><li>0: 默认值,topicName logsetName 模糊匹配</li>\n<li>1: topicName 精确匹配</li>\n<li>2: logsetName精确匹配</li>\n<li>3: topicName 和logsetName 都精确匹配</li></ul>",
7618
7618
  "example": "1",
7619
7619
  "member": "uint64",
7620
7620
  "name": "PreciseSearch",
@@ -7623,7 +7623,7 @@
7623
7623
  },
7624
7624
  {
7625
7625
  "disabled": false,
7626
- "document": "主题类型\n- 0:日志主题,默认值\n- 1:指标主题\n",
7626
+ "document": "主题类型\n<ul><li>0:日志主题,默认值</li>\n<li>1:指标主题</li></ul>",
7627
7627
  "example": "无",
7628
7628
  "member": "uint64",
7629
7629
  "name": "BizType",
@@ -7918,7 +7918,7 @@
7918
7918
  "example": "无",
7919
7919
  "member": "DMSTableInfo",
7920
7920
  "name": "TableList",
7921
- "required": true,
7921
+ "output_required": true,
7922
7922
  "type": "list",
7923
7923
  "value_allowed_null": true
7924
7924
  },
@@ -7928,7 +7928,7 @@
7928
7928
  "example": "1",
7929
7929
  "member": "int64",
7930
7930
  "name": "TotalCount",
7931
- "required": true,
7931
+ "output_required": true,
7932
7932
  "type": "int",
7933
7933
  "value_allowed_null": true
7934
7934
  },
@@ -11600,10 +11600,10 @@
11600
11600
  {
11601
11601
  "disabled": false,
11602
11602
  "document": "状态",
11603
- "example": "",
11603
+ "example": "true",
11604
11604
  "member": "bool",
11605
11605
  "name": "Status",
11606
- "required": true,
11606
+ "output_required": true,
11607
11607
  "type": "bool",
11608
11608
  "value_allowed_null": false
11609
11609
  },
@@ -27,8 +27,8 @@
27
27
  "AlterDMSDatabase": [
28
28
  {
29
29
  "document": "",
30
- "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AlterDMSDatabase\n<公共请求参数>\n\n{\n \"CurrentName\": \"xx\",\n \"SchemaName\": \"xx\",\n \"Location\": \"xx\",\n \"Asset\": {\n \"Description\": \"xx\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"DataVersion\": 1,\n \"BizParams\": [\n {\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ],\n \"OwnerAccount\": \"xx\",\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\",\n \"Catalog\": \"xx\",\n \"Params\": [\n {\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ],\n \"PermValues\": [\n {\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ],\n \"Owner\": \"xx\",\n \"DatasourceId\": 1,\n \"Guid\": \"xx\",\n \"Id\": 1,\n \"Name\": \"xx\"\n }\n}",
31
- "output": "{\n \"Response\": {\n \"RequestId\": \"xx\"\n }\n}",
30
+ "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AlterDMSDatabase\n<公共请求参数>\n\n{\n \"CurrentName\": \"abc\",\n \"SchemaName\": \"abc\",\n \"Location\": \"abc\",\n \"Asset\": {\n \"Id\": 0,\n \"Name\": \"abc\",\n \"Guid\": \"abc\",\n \"Catalog\": \"abc\",\n \"Description\": \"abc\",\n \"Owner\": \"abc\",\n \"OwnerAccount\": \"abc\",\n \"PermValues\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Params\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"BizParams\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"DataVersion\": 0,\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"DatasourceId\": 0\n }\n}",
31
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
32
32
  "title": "DMS元数据更新库"
33
33
  }
34
34
  ],
@@ -449,8 +449,8 @@
449
449
  "DescribeDMSTables": [
450
450
  {
451
451
  "document": "",
452
- "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDMSTables\n<公共请求参数>\n\n{\n \"Name\": \"xx\",\n \"Keyword\": \"xx\",\n \"Pattern\": \"xx\",\n \"Catalog\": \"xx\",\n \"SchemaName\": \"xx\",\n \"Type\": \"xx\",\n \"DbName\": \"xx\"\n}",
453
- "output": "{\n \"Response\": {\n \"TableList\": [\n {\n \"Table\": {\n \"PartitionKeys\": [\n {\n \"Name\": \"xx\",\n \"BizParams\": [\n {\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ],\n \"IsPartition\": true,\n \"Params\": [\n {\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ],\n \"Position\": 0,\n \"Type\": \"xx\",\n \"Description\": \"xx\"\n }\n ],\n \"Sds\": {\n \"OutputFormat\": \"xx\",\n \"SortCols\": {\n \"Col\": \"xx\",\n \"Order\": 0\n },\n \"InputFormat\": \"xx\",\n \"SerdeLib\": \"xx\",\n \"Cols\": [\n {\n \"Name\": \"xx\",\n \"BizParams\": [\n {\n \"Value\": \"xx\",\n \"Key\": \"xx\"\n }\n ],\n \"IsPartition\": true,\n \"Position\": 0,\n \"Type\": \"xx\",\n \"Description\": \"xx\"\n }\n ],\n \"Location\": \"xx\",\n \"NumBuckets\": 0,\n \"Compressed\": true,\n \"SerdeName\": \"xx\",\n \"StoredAsSubDirectories\": true,\n \"BucketCols\": [\n \"xx\"\n ]\n },\n \"RecordCount\": 0,\n \"StructUpdateTime\": \"2020-09-22T00:00:00+00:00\",\n \"Partitions\": [\n {\n \"Sds\": {\n \"OutputFormat\": \"xx\",\n \"SortCols\": {\n \"Col\": \"xx\",\n \"Order\": 0\n },\n \"InputFormat\": \"xx\",\n \"SerdeLib\": \"xx\",\n \"Cols\": [\n {\n \"IsPartition\": true,\n \"Type\": \"xx\",\n \"Description\": \"xx\",\n \"Position\": 0,\n \"Name\": \"xx\"\n }\n ],\n \"Location\": \"xx\",\n \"NumBuckets\": 0,\n \"Compressed\": true,\n \"SerdeName\": \"xx\",\n \"StoredAsSubDirectories\": true,\n \"BucketCols\": [\n \"xx\"\n ]\n },\n \"Name\": \"xx\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"DataVersion\": 0,\n \"RecordCount\": 0,\n \"TableName\": \"xx\",\n \"LastAccessTime\": \"2020-09-22T00:00:00+00:00\",\n \"Values\": [\n \"xx\"\n ],\n \"DatabaseName\": \"xx\",\n \"SchemaName\": \"xx\",\n \"StorageSize\": 0,\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\"\n }\n ],\n \"DataUpdateTime\": \"2020-09-22T00:00:00+00:00\",\n \"ViewOriginalText\": \"xx\",\n \"LifeTime\": 0,\n \"StorageSize\": 0,\n \"ViewExpandedText\": \"xx\",\n \"SchemaName\": \"xx\",\n \"LastAccessTime\": \"2020-09-22T00:00:00+00:00\",\n \"Type\": \"xx\",\n \"DbName\": \"xx\",\n \"Retention\": 0\n },\n \"Asset\": {\n \"Description\": \"xx\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"DataVersion\": 0,\n \"OwnerAccount\": \"xx\",\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\",\n \"Catalog\": \"xx\",\n \"DatasourceId\": 0,\n \"Owner\": \"xx\",\n \"Guid\": \"xx\",\n \"Id\": 0,\n \"Name\": \"xx\"\n }\n }\n ],\n \"TotalCount\": 0,\n \"RequestId\": \"xx\"\n }\n}",
452
+ "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDMSTables\n<公共请求参数>\n\n{\n \"Name\": \"name1\",\n \"Keyword\": \"key\",\n \"Pattern\": \"pattern\",\n \"Catalog\": \"DataLakeCatalog\",\n \"SchemaName\": \"name\",\n \"Type\": \"t1\",\n \"DbName\": \"db1\"\n}",
453
+ "output": "{\n \"Response\": {\n \"TableList\": [\n {\n \"Table\": {\n \"ViewOriginalText\": \"abc\",\n \"ViewExpandedText\": \"abc\",\n \"Retention\": 0,\n \"Columns\": [],\n \"Sds\": {\n \"Location\": \"abc\",\n \"InputFormat\": \"abc\",\n \"OutputFormat\": \"abc\",\n \"NumBuckets\": 0,\n \"Compressed\": true,\n \"StoredAsSubDirectories\": true,\n \"SerdeLib\": \"abc\",\n \"SerdeName\": \"abc\",\n \"BucketCols\": [\n \"abc\"\n ],\n \"SerdeParams\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Params\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"SortCols\": {\n \"Col\": \"abc\",\n \"Order\": 0\n },\n \"Cols\": [\n {\n \"Name\": \"abc\",\n \"Description\": \"abc\",\n \"Type\": \"abc\",\n \"Position\": 0,\n \"Params\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"IsPartition\": true\n }\n ],\n \"SortColumns\": [\n {\n \"Col\": \"abc\",\n \"Order\": 0\n }\n ]\n },\n \"PartitionKeys\": [\n {\n \"Name\": \"abc\",\n \"Description\": \"abc\",\n \"Type\": \"abc\",\n \"Position\": 0,\n \"IsPartition\": true\n }\n ],\n \"Partitions\": [\n {\n \"DatabaseName\": \"abc\",\n \"SchemaName\": \"abc\",\n \"TableName\": \"abc\",\n \"DataVersion\": 0,\n \"Name\": \"abc\",\n \"Params\": [],\n \"Values\": [\n \"abc\"\n ],\n \"StorageSize\": 0,\n \"RecordCount\": 0,\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"LastAccessTime\": \"2020-09-22T00:00:00+00:00\",\n \"Sds\": {\n \"Location\": \"abc\",\n \"InputFormat\": \"abc\",\n \"OutputFormat\": \"abc\",\n \"NumBuckets\": 0,\n \"Compressed\": true,\n \"StoredAsSubDirectories\": true,\n \"SerdeLib\": \"abc\",\n \"SerdeName\": \"abc\",\n \"Params\": [],\n \"SerdeParams\": [],\n \"SortColumns\": [],\n \"BucketCols\": [\n \"abc\"\n ],\n \"SortCols\": {\n \"Col\": \"abc\",\n \"Order\": 0\n },\n \"Cols\": [\n {\n \"Name\": \"abc\",\n \"Description\": \"abc\",\n \"Type\": \"abc\",\n \"Position\": 0,\n \"IsPartition\": true\n }\n ]\n }\n }\n ],\n \"Type\": \"abc\",\n \"DbName\": \"abc\",\n \"SchemaName\": \"abc\",\n \"StorageSize\": 0,\n \"RecordCount\": 0,\n \"LifeTime\": 0,\n \"LastAccessTime\": \"2020-09-22T00:00:00+00:00\",\n \"DataUpdateTime\": \"2020-09-22T00:00:00+00:00\",\n \"StructUpdateTime\": \"2020-09-22T00:00:00+00:00\",\n \"Name\": \"abc\"\n },\n \"Asset\": {\n \"Id\": 0,\n \"Name\": \"abc\",\n \"Guid\": \"abc\",\n \"Catalog\": \"abc\",\n \"Description\": \"abc\",\n \"Owner\": \"abc\",\n \"OwnerAccount\": \"abc\",\n \"DataVersion\": 0,\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"DatasourceId\": 0,\n \"Params\": [],\n \"PermValues\": [],\n \"BizParams\": []\n }\n }\n ],\n \"TotalCount\": 0,\n \"RequestId\": \"abc\"\n }\n}",
454
454
  "title": "DMS查询表列表"
455
455
  }
456
456
  ],
@@ -864,7 +864,7 @@
864
864
  {
865
865
  "document": "",
866
866
  "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DropDMSPartitions\n<公共请求参数>\n\n{\n \"DatabaseName\": \"database-xxxx\",\n \"SchemaName\": \"Schema1\",\n \"TableName\": \"Table1\",\n \"Name\": \"Name1\",\n \"Values\": [\n \"1\",\n \"2\"\n ],\n \"DeleteData\": false\n}",
867
- "output": "{\n \"Response\": {\n \"RequestId\": \"xx\",\n \"Status\": true\n }\n}",
867
+ "output": "{\n \"Response\": {\n \"RequestId\": \"12345-67890-12345-67890\",\n \"Status\": true\n }\n}",
868
868
  "title": "DMS元数据删除分区"
869
869
  }
870
870
  ],
@@ -358,7 +358,7 @@
358
358
  "status": "online"
359
359
  },
360
360
  "CreateFlowsByTemplates": {
361
- "document": "接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。\n如若在模板中配置了动态表格, 上传的附件必须为A4大小 \n合同发起人必须在电子签已经进行实名。\n\n### 一. 整体的逻辑如下\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/e193519d4383fa74782a9e19147ef01a/CreateFlowsByTemplates.png)\n\n### 二. 可以作为发起方和签署方的角色列表\n\n<table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl\" target=\"_blank\">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href=\"https://qian.tencent.com/developers/partner/dynamic_signer\" target=\"_blank\">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人,不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href=\"https://qian.tencent.cn/console/company-register\" target=\"_blank\">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>\n\n\n\n\n### 三. 填充模板中定义的填写控件\n模板中配置的<font color=\"red\">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)\n填充的传参示例如下\n\n```\n request.FormFields = [{\n \"ComponentName\": \"项目的名字\",\n \"ComponentValue\": \"休闲山庄\"\n }, {\n \"ComponentName\": \"项目的地址\",\n \"ComponentValue\": \"凤凰山北侧\",\n }, {\n \"ComponentName\": \"范围\",\n \"ComponentValue\": \"凤凰山至107国道\",\n }, {\n \"ComponentName\": \"面积\",\n \"ComponentValue\": \"100亩\",\n }, {\n \"ComponentName\": \"基本情况\",\n \"ComponentValue\": \"完好\",\n }, , {\n \"ComponentName\": \"用途\",\n \"ComponentValue\": \"经营农家乐\",\n }\n ]\n```\n合成后合同样子示例\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)\n\n\n\n### 四. 注意 \n1. 发起合同时候, 作为<font color=\"red\">发起方的第三方子企业A员工的企业和员工必须经过实名</font>, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名\n\n2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明\n\n3. <font color=\"red\">调用接口发起合同成功就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)\n\n4. <font color=\"red\">静默(自动)签署不支持合同签署方存在填写</font>\n\n5. <font color=\"red\">在下一步创建签署链接前,建议等待DocumentFill </font> <a href=\"https://qian.tencent.com/developers/partner/callback_types_file_resources\">PDF合成完成的回调</a>或者睡眠几秒,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。\n\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateTemplates.mp4\" target=\"_blank\">创建模板&设置成本企业自动签署</a><br>",
361
+ "document": "接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。\n如若在模板中配置了动态表格, 上传的附件必须为A4大小 \n合同发起人必须在电子签已经进行实名。\n\n### 一. 整体的逻辑如下\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/e193519d4383fa74782a9e19147ef01a/CreateFlowsByTemplates.png)\n\n### 二. 可以作为发起方和签署方的角色列表\n\n<table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl\" target=\"_blank\">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href=\"https://qian.tencent.com/developers/partner/dynamic_signer\" target=\"_blank\">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人,不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href=\"https://qian.tencent.cn/console/company-register\" target=\"_blank\">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>\n\n\n\n\n### 三. 填充模板中定义的填写控件\n模板中配置的<font color=\"red\">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)\n填充的传参示例如下\n\n```\n request.FormFields = [{\n \"ComponentName\": \"项目的名字\",\n \"ComponentValue\": \"休闲山庄\"\n }, {\n \"ComponentName\": \"项目的地址\",\n \"ComponentValue\": \"凤凰山北侧\",\n }, {\n \"ComponentName\": \"范围\",\n \"ComponentValue\": \"凤凰山至107国道\",\n }, {\n \"ComponentName\": \"面积\",\n \"ComponentValue\": \"100亩\",\n }, {\n \"ComponentName\": \"基本情况\",\n \"ComponentValue\": \"完好\",\n }, , {\n \"ComponentName\": \"用途\",\n \"ComponentValue\": \"经营农家乐\",\n }\n ]\n```\n合成后合同样子示例\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)\n\n\n\n### 四. 注意 \n1. 发起合同时候, 作为<font color=\"red\">发起方的第三方子企业A员工的企业和员工必须经过实名</font>, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名\n\n2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明\n\n3. <font color=\"red\">调用接口发起合同成功就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)\n\n4. <font color=\"red\">静默(自动)签署不支持合同签署方存在填写</font>\n\n5. <font color=\"red\">在下一步创建签署链接前,建议等待DocumentFill </font> <a href=\"https://qian.tencent.com/developers/partner/callback_types_file_resources\">PDF合成完成的回调</a>或者睡眠几秒,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。\n\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateTemplates.mp4\" target=\"_blank\">创建模板&设置成本企业自动签署</a><br>\n2. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateFlowsByTemplates.mp4\" target=\"_blank\">【用模板创建签署流程】编写示例视频教程</a><br>",
362
362
  "input": "CreateFlowsByTemplatesRequest",
363
363
  "name": "用模板创建签署流程",
364
364
  "output": "CreateFlowsByTemplatesResponse",