tccli 3.0.1236.1__py2.py3-none-any.whl → 3.0.1238.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (149) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +3 -0
  3. tccli/services/aca/__init__.py +4 -0
  4. tccli/services/aca/aca_client.py +578 -0
  5. tccli/services/aca/v20210323/api.json +3715 -0
  6. tccli/services/aca/v20210323/examples.json +69 -0
  7. tccli/services/aiart/v20221229/api.json +18 -9
  8. tccli/services/aiart/v20221229/examples.json +2 -2
  9. tccli/services/apm/v20210622/api.json +25 -22
  10. tccli/services/apm/v20210622/examples.json +16 -22
  11. tccli/services/ba/v20200720/api.json +3 -2
  12. tccli/services/batch/v20170312/api.json +641 -566
  13. tccli/services/batch/v20170312/examples.json +7 -7
  14. tccli/services/bi/v20220105/api.json +9 -0
  15. tccli/services/billing/v20180709/api.json +2 -2
  16. tccli/services/bpaas/v20181217/examples.json +1 -1
  17. tccli/services/cam/v20190116/api.json +116 -99
  18. tccli/services/cam/v20190116/examples.json +11 -11
  19. tccli/services/ccc/v20200210/api.json +40 -1
  20. tccli/services/ccc/v20200210/examples.json +1 -1
  21. tccli/services/cdb/cdb_client.py +53 -0
  22. tccli/services/cdb/v20170320/api.json +257 -207
  23. tccli/services/cdb/v20170320/examples.json +18 -10
  24. tccli/services/cdwch/v20200915/api.json +6 -6
  25. tccli/services/cdwdoris/v20211228/api.json +16 -5
  26. tccli/services/cdwdoris/v20211228/examples.json +1 -1
  27. tccli/services/cfg/v20210820/api.json +29 -13
  28. tccli/services/cfg/v20210820/examples.json +1 -1
  29. tccli/services/cfs/v20190719/api.json +84 -84
  30. tccli/services/cfs/v20190719/examples.json +6 -6
  31. tccli/services/chdfs/v20201112/api.json +18 -17
  32. tccli/services/chdfs/v20201112/examples.json +2 -2
  33. tccli/services/clb/v20180317/api.json +184 -162
  34. tccli/services/cloudapp/v20220530/api.json +11 -1
  35. tccli/services/cloudapp/v20220530/examples.json +3 -3
  36. tccli/services/cloudaudit/v20190319/api.json +64 -53
  37. tccli/services/cloudaudit/v20190319/examples.json +5 -5
  38. tccli/services/cls/v20201016/api.json +21 -21
  39. tccli/services/cls/v20201016/examples.json +1 -1
  40. tccli/services/config/v20220802/api.json +2 -0
  41. tccli/services/config/v20220802/examples.json +2 -2
  42. tccli/services/cvm/v20170312/api.json +5 -5
  43. tccli/services/cynosdb/cynosdb_client.py +53 -0
  44. tccli/services/cynosdb/v20190107/api.json +110 -0
  45. tccli/services/cynosdb/v20190107/examples.json +8 -0
  46. tccli/services/dcdb/v20180411/api.json +390 -387
  47. tccli/services/dcdb/v20180411/examples.json +14 -14
  48. tccli/services/dlc/v20210125/api.json +162 -7
  49. tccli/services/dlc/v20210125/examples.json +1 -1
  50. tccli/services/domain/v20180808/api.json +55 -54
  51. tccli/services/domain/v20180808/examples.json +38 -32
  52. tccli/services/dsgc/v20190723/api.json +1796 -1623
  53. tccli/services/dsgc/v20190723/examples.json +217 -211
  54. tccli/services/dts/v20180330/api.json +143 -106
  55. tccli/services/dts/v20211206/api.json +57 -46
  56. tccli/services/dts/v20211206/examples.json +1 -1
  57. tccli/services/ecm/v20190719/api.json +6 -6
  58. tccli/services/emr/v20190103/api.json +80 -20
  59. tccli/services/ess/ess_client.py +118 -12
  60. tccli/services/ess/v20201111/api.json +320 -37
  61. tccli/services/ess/v20201111/examples.json +19 -3
  62. tccli/services/essbasic/essbasic_client.py +167 -8
  63. tccli/services/essbasic/v20210526/api.json +528 -55
  64. tccli/services/essbasic/v20210526/examples.json +46 -16
  65. tccli/services/facefusion/v20220927/api.json +12 -1
  66. tccli/services/fmu/v20191213/api.json +8 -8
  67. tccli/services/gaap/v20180529/api.json +200 -209
  68. tccli/services/gwlb/v20240906/api.json +16 -16
  69. tccli/services/gwlb/v20240906/examples.json +2 -2
  70. tccli/services/hai/v20230812/api.json +1 -1
  71. tccli/services/hunyuan/v20230901/api.json +6 -6
  72. tccli/services/iss/v20230517/api.json +11 -11
  73. tccli/services/iss/v20230517/examples.json +31 -31
  74. tccli/services/keewidb/v20220308/api.json +92 -82
  75. tccli/services/keewidb/v20220308/examples.json +5 -5
  76. tccli/services/lcic/v20220817/api.json +3 -3
  77. tccli/services/lcic/v20220817/examples.json +2 -2
  78. tccli/services/lighthouse/v20200324/api.json +18 -18
  79. tccli/services/lighthouse/v20200324/examples.json +6 -6
  80. tccli/services/live/v20180801/api.json +32 -14
  81. tccli/services/lke/v20231130/examples.json +1 -1
  82. tccli/services/mariadb/v20170312/api.json +285 -263
  83. tccli/services/mariadb/v20170312/examples.json +12 -12
  84. tccli/services/mongodb/v20180408/api.json +52 -40
  85. tccli/services/mongodb/v20180408/examples.json +4 -4
  86. tccli/services/mongodb/v20190725/api.json +119 -109
  87. tccli/services/mongodb/v20190725/examples.json +5 -5
  88. tccli/services/monitor/monitor_client.py +106 -0
  89. tccli/services/monitor/v20180724/api.json +222 -0
  90. tccli/services/monitor/v20180724/examples.json +17 -1
  91. tccli/services/mps/mps_client.py +228 -16
  92. tccli/services/mps/v20190612/api.json +385 -23
  93. tccli/services/mps/v20190612/examples.json +32 -0
  94. tccli/services/mqtt/v20240516/api.json +1 -1
  95. tccli/services/mqtt/v20240516/examples.json +1 -1
  96. tccli/services/msp/v20180319/api.json +2 -2
  97. tccli/services/ocr/v20181119/api.json +11 -1
  98. tccli/services/omics/v20221128/api.json +14 -2
  99. tccli/services/organization/v20210331/api.json +45 -18
  100. tccli/services/privatedns/v20201028/api.json +90 -81
  101. tccli/services/privatedns/v20201028/examples.json +18 -18
  102. tccli/services/pts/v20210728/api.json +8 -0
  103. tccli/services/redis/redis_client.py +106 -0
  104. tccli/services/redis/v20180412/api.json +178 -16
  105. tccli/services/redis/v20180412/examples.json +16 -0
  106. tccli/services/region/v20220627/api.json +5 -3
  107. tccli/services/region/v20220627/examples.json +1 -1
  108. tccli/services/ssl/v20191205/api.json +6 -4
  109. tccli/services/ssl/v20191205/examples.json +1 -1
  110. tccli/services/sts/v20180813/examples.json +1 -1
  111. tccli/services/tag/v20180813/api.json +4 -5
  112. tccli/services/tcb/v20180608/api.json +36 -16
  113. tccli/services/tdid/v20210519/api.json +30 -38
  114. tccli/services/tdid/v20210519/examples.json +5 -5
  115. tccli/services/tdmq/tdmq_client.py +53 -0
  116. tccli/services/tdmq/v20200217/api.json +64 -1
  117. tccli/services/tdmq/v20200217/examples.json +9 -1
  118. tccli/services/teo/teo_client.py +485 -8
  119. tccli/services/teo/v20220901/api.json +837 -39
  120. tccli/services/teo/v20220901/examples.json +108 -0
  121. tccli/services/thpc/v20211109/api.json +32 -34
  122. tccli/services/thpc/v20220401/api.json +31 -33
  123. tccli/services/thpc/v20230321/api.json +55 -57
  124. tccli/services/thpc/v20230321/examples.json +1 -1
  125. tccli/services/tiia/v20190529/api.json +307 -293
  126. tccli/services/tiia/v20190529/examples.json +41 -41
  127. tccli/services/tione/v20211111/api.json +4 -4
  128. tccli/services/tione/v20211111/examples.json +2 -2
  129. tccli/services/tke/v20180525/api.json +1 -1
  130. tccli/services/trocket/trocket_client.py +53 -0
  131. tccli/services/trocket/v20230308/api.json +119 -3
  132. tccli/services/trocket/v20230308/examples.json +14 -0
  133. tccli/services/tse/v20201207/api.json +188 -120
  134. tccli/services/tse/v20201207/examples.json +30 -30
  135. tccli/services/tsf/v20180326/api.json +826 -745
  136. tccli/services/tsf/v20180326/examples.json +99 -111
  137. tccli/services/vclm/v20240523/api.json +1 -1
  138. tccli/services/vdb/v20230616/api.json +80 -80
  139. tccli/services/vdb/v20230616/examples.json +1 -1
  140. tccli/services/vpc/v20170312/api.json +64 -44
  141. tccli/services/vpc/v20170312/examples.json +6 -6
  142. tccli/services/vrs/v20200824/api.json +3 -2
  143. tccli/services/wedata/v20210820/api.json +550 -40
  144. tccli/services/wedata/v20210820/examples.json +10 -4
  145. {tccli-3.0.1236.1.dist-info → tccli-3.0.1238.1.dist-info}/METADATA +2 -2
  146. {tccli-3.0.1236.1.dist-info → tccli-3.0.1238.1.dist-info}/RECORD +149 -145
  147. {tccli-3.0.1236.1.dist-info → tccli-3.0.1238.1.dist-info}/WHEEL +0 -0
  148. {tccli-3.0.1236.1.dist-info → tccli-3.0.1238.1.dist-info}/entry_points.txt +0 -0
  149. {tccli-3.0.1236.1.dist-info → tccli-3.0.1238.1.dist-info}/license_files/LICENSE +0 -0
@@ -577,7 +577,7 @@
577
577
  {
578
578
  "disabled": false,
579
579
  "document": "待升级的实例ID列表。形如:[\"dcdbt-ow728lmc\"],可以通过 DescribeDCDBInstances 查询实例详情获得。",
580
- "example": "[]",
580
+ "example": "[\"tdsqlshard-cq3ndzu7\",\"tdsqlshard-m7xhodc5\"]",
581
581
  "member": "string",
582
582
  "name": "InstanceIds",
583
583
  "required": true,
@@ -595,15 +595,17 @@
595
595
  "example": "[\"tdsqlshard-cq3ndzu7\"]",
596
596
  "member": "string",
597
597
  "name": "SuccessInstanceIds",
598
+ "output_required": true,
598
599
  "type": "list",
599
600
  "value_allowed_null": false
600
601
  },
601
602
  {
602
603
  "disabled": false,
603
604
  "document": "解隔离失败的实例id列表",
604
- "example": "[]",
605
+ "example": "[\"tdsqlshard-m7xhodc5\"]",
605
606
  "member": "string",
606
607
  "name": "FailedInstanceIds",
608
+ "output_required": true,
607
609
  "type": "list",
608
610
  "value_allowed_null": false
609
611
  },
@@ -769,30 +771,30 @@
769
771
  {
770
772
  "disabled": false,
771
773
  "document": "DB节点ID",
772
- "example": "",
774
+ "example": "4ddc0ea18433",
773
775
  "member": "string",
774
776
  "name": "NodeId",
775
- "required": true,
777
+ "output_required": true,
776
778
  "type": "string",
777
779
  "value_allowed_null": false
778
780
  },
779
781
  {
780
782
  "disabled": false,
781
783
  "document": "DB节点角色,取值为master或者slave",
782
- "example": "",
784
+ "example": "master",
783
785
  "member": "string",
784
786
  "name": "Role",
785
- "required": true,
787
+ "output_required": true,
786
788
  "type": "string",
787
789
  "value_allowed_null": false
788
790
  },
789
791
  {
790
792
  "disabled": false,
791
793
  "document": "节点所属分片的分片ID",
792
- "example": "",
794
+ "example": "shard-ffj8mqzn",
793
795
  "member": "string",
794
796
  "name": "ShardId",
795
- "required": true,
797
+ "output_required": true,
796
798
  "type": "string",
797
799
  "value_allowed_null": false
798
800
  }
@@ -933,7 +935,7 @@
933
935
  {
934
936
  "disabled": false,
935
937
  "document": "是否IPv6,默认0",
936
- "example": "",
938
+ "example": "0",
937
939
  "member": "int64",
938
940
  "name": "Ipv6Flag",
939
941
  "required": false,
@@ -951,7 +953,7 @@
951
953
  "example": "3024",
952
954
  "member": "int64",
953
955
  "name": "FlowId",
954
- "required": true,
956
+ "output_required": true,
955
957
  "type": "int",
956
958
  "value_allowed_null": false
957
959
  },
@@ -1038,20 +1040,20 @@
1038
1040
  {
1039
1041
  "disabled": false,
1040
1042
  "document": "约束类型为section时的最小值",
1041
- "example": "",
1043
+ "example": "1",
1042
1044
  "member": "string",
1043
1045
  "name": "Min",
1044
- "required": true,
1046
+ "output_required": true,
1045
1047
  "type": "string",
1046
1048
  "value_allowed_null": false
1047
1049
  },
1048
1050
  {
1049
1051
  "disabled": false,
1050
1052
  "document": "约束类型为section时的最大值",
1051
- "example": "",
1053
+ "example": "65535",
1052
1054
  "member": "string",
1053
1055
  "name": "Max",
1054
- "required": true,
1056
+ "output_required": true,
1055
1057
  "type": "string",
1056
1058
  "value_allowed_null": false
1057
1059
  }
@@ -1109,7 +1111,7 @@
1109
1111
  {
1110
1112
  "disabled": false,
1111
1113
  "document": "源账号的 ReadOnly 属性",
1112
- "example": "",
1114
+ "example": "0",
1113
1115
  "member": "string",
1114
1116
  "name": "SrcReadOnly",
1115
1117
  "required": false,
@@ -1118,7 +1120,7 @@
1118
1120
  {
1119
1121
  "disabled": false,
1120
1122
  "document": "目的账号的 ReadOnly 属性",
1121
- "example": "",
1123
+ "example": "0",
1122
1124
  "member": "string",
1123
1125
  "name": "DstReadOnly",
1124
1126
  "required": false,
@@ -1356,7 +1358,7 @@
1356
1358
  {
1357
1359
  "disabled": false,
1358
1360
  "document": "项目 ID,可以通过查看项目列表获取,不传则关联到默认项目",
1359
- "example": "",
1361
+ "example": "1077641",
1360
1362
  "member": "int64",
1361
1363
  "name": "ProjectId",
1362
1364
  "required": false,
@@ -1365,7 +1367,7 @@
1365
1367
  {
1366
1368
  "disabled": false,
1367
1369
  "document": "虚拟私有网络 ID,不传或传空表示创建为基础网络",
1368
- "example": "",
1370
+ "example": "vpc-qdiqptn3",
1369
1371
  "member": "string",
1370
1372
  "name": "VpcId",
1371
1373
  "required": false,
@@ -1374,7 +1376,7 @@
1374
1376
  {
1375
1377
  "disabled": false,
1376
1378
  "document": "虚拟私有网络子网 ID,VpcId不为空时必填",
1377
- "example": "",
1379
+ "example": "subnet-0r3bgq4c",
1378
1380
  "member": "string",
1379
1381
  "name": "SubnetId",
1380
1382
  "required": false,
@@ -1401,7 +1403,7 @@
1401
1403
  {
1402
1404
  "disabled": false,
1403
1405
  "document": "代金券ID列表,目前仅支持指定一张代金券。",
1404
- "example": "",
1406
+ "example": "[\"ZRPCQJGMYSYV73IYOTFJD8\"]",
1405
1407
  "member": "string",
1406
1408
  "name": "VoucherIds",
1407
1409
  "required": false,
@@ -1419,7 +1421,7 @@
1419
1421
  {
1420
1422
  "disabled": false,
1421
1423
  "document": "实例名称, 可以通过该字段自主的设置实例的名字",
1422
- "example": "",
1424
+ "example": "tdsql_MySQL",
1423
1425
  "member": "string",
1424
1426
  "name": "InstanceName",
1425
1427
  "required": false,
@@ -1428,7 +1430,7 @@
1428
1430
  {
1429
1431
  "disabled": false,
1430
1432
  "document": "是否支持IPv6,0:不支持,1:支持",
1431
- "example": "",
1433
+ "example": "0",
1432
1434
  "member": "int64",
1433
1435
  "name": "Ipv6Flag",
1434
1436
  "required": false,
@@ -1455,7 +1457,7 @@
1455
1457
  {
1456
1458
  "disabled": false,
1457
1459
  "document": "DCN源地域",
1458
- "example": "",
1460
+ "example": "ap-guangzhou",
1459
1461
  "member": "string",
1460
1462
  "name": "DcnRegion",
1461
1463
  "required": false,
@@ -1464,7 +1466,7 @@
1464
1466
  {
1465
1467
  "disabled": false,
1466
1468
  "document": "DCN源实例ID",
1467
- "example": "",
1469
+ "example": "tdsqlshard-b0wbmr9p",
1468
1470
  "member": "string",
1469
1471
  "name": "DcnInstanceId",
1470
1472
  "required": false,
@@ -1482,7 +1484,7 @@
1482
1484
  {
1483
1485
  "disabled": false,
1484
1486
  "document": "安全组ids,安全组可以传数组形式,兼容之前SecurityGroupId参数",
1485
- "example": "",
1487
+ "example": "[\"sg-5ozc4vtq\"]",
1486
1488
  "member": "string",
1487
1489
  "name": "SecurityGroupIds",
1488
1490
  "required": false,
@@ -1718,7 +1720,7 @@
1718
1720
  {
1719
1721
  "disabled": false,
1720
1722
  "document": "自定义实例名称",
1721
- "example": "xx",
1723
+ "example": "tdsql_mysql",
1722
1724
  "member": "string",
1723
1725
  "name": "InstanceName",
1724
1726
  "required": false,
@@ -1736,7 +1738,7 @@
1736
1738
  {
1737
1739
  "disabled": false,
1738
1740
  "document": "支持IPv6标志:1 支持, 0 不支持",
1739
- "example": "",
1741
+ "example": "0",
1740
1742
  "member": "int64",
1741
1743
  "name": "Ipv6Flag",
1742
1744
  "required": false,
@@ -1945,7 +1947,7 @@
1945
1947
  {
1946
1948
  "disabled": false,
1947
1949
  "document": "安全组id",
1948
- "example": "sg-12345",
1950
+ "example": "sg-egre3rqv",
1949
1951
  "member": "string",
1950
1952
  "name": "SecurityGroupId",
1951
1953
  "required": false,
@@ -2008,7 +2010,7 @@
2008
2010
  {
2009
2011
  "disabled": false,
2010
2012
  "document": "需要回档的源实例ID",
2011
- "example": "",
2013
+ "example": "tdsqlshard-d0uvh7ep",
2012
2014
  "member": "string",
2013
2015
  "name": "RollbackInstanceId",
2014
2016
  "required": false,
@@ -2017,7 +2019,7 @@
2017
2019
  {
2018
2020
  "disabled": false,
2019
2021
  "document": "回档时间,例如“2021-11-22 00:00:00”",
2020
- "example": "",
2022
+ "example": "2024-12-14 12:00:00",
2021
2023
  "member": "string",
2022
2024
  "name": "RollbackTime",
2023
2025
  "required": false,
@@ -2026,7 +2028,7 @@
2026
2028
  {
2027
2029
  "disabled": false,
2028
2030
  "document": "安全组ids,安全组可以传数组形式,兼容之前SecurityGroupId参数",
2029
- "example": "",
2031
+ "example": "[\"sg-grefw6tr\"]",
2030
2032
  "member": "string",
2031
2033
  "name": "SecurityGroupIds",
2032
2034
  "required": false,
@@ -2360,22 +2362,20 @@
2360
2362
  {
2361
2363
  "disabled": false,
2362
2364
  "document": "参数名称",
2363
- "example": "",
2365
+ "example": "autocommit",
2364
2366
  "member": "string",
2365
2367
  "name": "Param",
2366
2368
  "required": true,
2367
- "type": "string",
2368
- "value_allowed_null": false
2369
+ "type": "string"
2369
2370
  },
2370
2371
  {
2371
2372
  "disabled": false,
2372
2373
  "document": "参数值",
2373
- "example": "",
2374
+ "example": "ON",
2374
2375
  "member": "string",
2375
2376
  "name": "Value",
2376
2377
  "required": true,
2377
- "type": "string",
2378
- "value_allowed_null": false
2378
+ "type": "string"
2379
2379
  }
2380
2380
  ],
2381
2381
  "usage": "in"
@@ -2892,250 +2892,250 @@
2892
2892
  {
2893
2893
  "disabled": false,
2894
2894
  "document": "所属实例Id",
2895
- "example": "",
2895
+ "example": "tdsqlshard-ffj8mqzn",
2896
2896
  "member": "string",
2897
2897
  "name": "InstanceId",
2898
- "required": true,
2898
+ "output_required": true,
2899
2899
  "type": "string",
2900
2900
  "value_allowed_null": false
2901
2901
  },
2902
2902
  {
2903
2903
  "disabled": false,
2904
2904
  "document": "分片SQL透传Id,用于将sql透传到指定分片执行",
2905
- "example": "",
2905
+ "example": "set_1732083233_5",
2906
2906
  "member": "string",
2907
2907
  "name": "ShardSerialId",
2908
- "required": true,
2908
+ "output_required": true,
2909
2909
  "type": "string",
2910
2910
  "value_allowed_null": false
2911
2911
  },
2912
2912
  {
2913
2913
  "disabled": false,
2914
2914
  "document": "全局唯一的分片Id",
2915
- "example": "",
2915
+ "example": "shard-fzqabc7d",
2916
2916
  "member": "string",
2917
2917
  "name": "ShardInstanceId",
2918
- "required": true,
2918
+ "output_required": true,
2919
2919
  "type": "string",
2920
2920
  "value_allowed_null": false
2921
2921
  },
2922
2922
  {
2923
2923
  "disabled": false,
2924
2924
  "document": "状态:0 创建中,1 流程处理中, 2 运行中,3 分片未初始化",
2925
- "example": "",
2925
+ "example": "2",
2926
2926
  "member": "int64",
2927
2927
  "name": "Status",
2928
- "required": true,
2928
+ "output_required": true,
2929
2929
  "type": "int",
2930
2930
  "value_allowed_null": false
2931
2931
  },
2932
2932
  {
2933
2933
  "disabled": false,
2934
2934
  "document": "状态中文描述",
2935
- "example": "",
2935
+ "example": "运行中",
2936
2936
  "member": "string",
2937
2937
  "name": "StatusDesc",
2938
- "required": true,
2938
+ "output_required": true,
2939
2939
  "type": "string",
2940
2940
  "value_allowed_null": false
2941
2941
  },
2942
2942
  {
2943
2943
  "disabled": false,
2944
2944
  "document": "创建时间",
2945
- "example": "",
2945
+ "example": "2024-11-20 11:18:30",
2946
2946
  "member": "datetime",
2947
2947
  "name": "CreateTime",
2948
- "required": true,
2948
+ "output_required": true,
2949
2949
  "type": "string",
2950
2950
  "value_allowed_null": false
2951
2951
  },
2952
2952
  {
2953
2953
  "disabled": false,
2954
2954
  "document": "字符串格式的私有网络Id",
2955
- "example": "",
2955
+ "example": "vpc-8tsjqux3",
2956
2956
  "member": "string",
2957
2957
  "name": "VpcId",
2958
- "required": true,
2958
+ "output_required": true,
2959
2959
  "type": "string",
2960
2960
  "value_allowed_null": false
2961
2961
  },
2962
2962
  {
2963
2963
  "disabled": false,
2964
2964
  "document": "字符串格式的私有网络子网Id",
2965
- "example": "",
2965
+ "example": "subnet-7mbqdo2i",
2966
2966
  "member": "string",
2967
2967
  "name": "SubnetId",
2968
- "required": true,
2968
+ "output_required": true,
2969
2969
  "type": "string",
2970
2970
  "value_allowed_null": false
2971
2971
  },
2972
2972
  {
2973
2973
  "disabled": false,
2974
2974
  "document": "项目ID",
2975
- "example": "",
2975
+ "example": "10074",
2976
2976
  "member": "int64",
2977
2977
  "name": "ProjectId",
2978
- "required": true,
2978
+ "output_required": true,
2979
2979
  "type": "int",
2980
2980
  "value_allowed_null": false
2981
2981
  },
2982
2982
  {
2983
2983
  "disabled": false,
2984
2984
  "document": "地域",
2985
- "example": "",
2985
+ "example": "ap-guangzhou",
2986
2986
  "member": "string",
2987
2987
  "name": "Region",
2988
- "required": true,
2988
+ "output_required": true,
2989
2989
  "type": "string",
2990
2990
  "value_allowed_null": false
2991
2991
  },
2992
2992
  {
2993
2993
  "disabled": false,
2994
2994
  "document": "可用区",
2995
- "example": "",
2995
+ "example": "ap-guangzhou-2",
2996
2996
  "member": "string",
2997
2997
  "name": "Zone",
2998
- "required": true,
2998
+ "output_required": true,
2999
2999
  "type": "string",
3000
3000
  "value_allowed_null": false
3001
3001
  },
3002
3002
  {
3003
3003
  "disabled": false,
3004
3004
  "document": "内存大小,单位 GB",
3005
- "example": "",
3005
+ "example": "4",
3006
3006
  "member": "int64",
3007
3007
  "name": "Memory",
3008
- "required": true,
3008
+ "output_required": true,
3009
3009
  "type": "int",
3010
3010
  "value_allowed_null": false
3011
3011
  },
3012
3012
  {
3013
3013
  "disabled": false,
3014
3014
  "document": "存储大小,单位 GB",
3015
- "example": "",
3015
+ "example": "10",
3016
3016
  "member": "int64",
3017
3017
  "name": "Storage",
3018
- "required": true,
3018
+ "output_required": true,
3019
3019
  "type": "int",
3020
3020
  "value_allowed_null": false
3021
3021
  },
3022
3022
  {
3023
3023
  "disabled": false,
3024
3024
  "document": "到期时间",
3025
- "example": "",
3025
+ "example": "0000-00-00 00:00:00",
3026
3026
  "member": "datetime",
3027
3027
  "name": "PeriodEndTime",
3028
- "required": true,
3028
+ "output_required": true,
3029
3029
  "type": "string",
3030
3030
  "value_allowed_null": false
3031
3031
  },
3032
3032
  {
3033
3033
  "disabled": false,
3034
3034
  "document": "节点数,2 为一主一从, 3 为一主二从",
3035
- "example": "",
3035
+ "example": "2",
3036
3036
  "member": "int64",
3037
3037
  "name": "NodeCount",
3038
- "required": true,
3038
+ "output_required": true,
3039
3039
  "type": "int",
3040
3040
  "value_allowed_null": false
3041
3041
  },
3042
3042
  {
3043
3043
  "disabled": false,
3044
3044
  "document": "存储使用率,单位为 %",
3045
- "example": "",
3045
+ "example": "0.003",
3046
3046
  "member": "float",
3047
3047
  "name": "StorageUsage",
3048
- "required": true,
3048
+ "output_required": true,
3049
3049
  "type": "float",
3050
3050
  "value_allowed_null": false
3051
3051
  },
3052
3052
  {
3053
3053
  "disabled": false,
3054
3054
  "document": "内存使用率,单位为 %",
3055
- "example": "",
3055
+ "example": "0.128",
3056
3056
  "member": "float",
3057
3057
  "name": "MemoryUsage",
3058
- "required": true,
3058
+ "output_required": true,
3059
3059
  "type": "float",
3060
3060
  "value_allowed_null": false
3061
3061
  },
3062
3062
  {
3063
3063
  "disabled": false,
3064
3064
  "document": "数字分片Id(过时字段,请勿依赖该值)",
3065
- "example": "",
3065
+ "example": "40889",
3066
3066
  "member": "int64",
3067
3067
  "name": "ShardId",
3068
- "required": true,
3068
+ "output_required": true,
3069
3069
  "type": "int",
3070
3070
  "value_allowed_null": false
3071
3071
  },
3072
3072
  {
3073
3073
  "disabled": false,
3074
3074
  "document": "产品ProductID",
3075
- "example": "",
3075
+ "example": "1001670",
3076
3076
  "member": "int64",
3077
3077
  "name": "Pid",
3078
- "required": true,
3078
+ "output_required": true,
3079
3079
  "type": "int",
3080
3080
  "value_allowed_null": false
3081
3081
  },
3082
3082
  {
3083
3083
  "disabled": false,
3084
3084
  "document": "Proxy版本",
3085
- "example": "",
3085
+ "example": "proxy-22.4.2",
3086
3086
  "member": "string",
3087
3087
  "name": "ProxyVersion",
3088
- "required": true,
3088
+ "output_required": true,
3089
3089
  "type": "string",
3090
3090
  "value_allowed_null": false
3091
3091
  },
3092
3092
  {
3093
3093
  "disabled": false,
3094
3094
  "document": "付费模型\n注意:此字段可能返回 null,表示取不到有效值。",
3095
- "example": "",
3095
+ "example": "postpaid",
3096
3096
  "member": "string",
3097
3097
  "name": "Paymode",
3098
- "required": true,
3098
+ "output_required": true,
3099
3099
  "type": "string",
3100
3100
  "value_allowed_null": true
3101
3101
  },
3102
3102
  {
3103
3103
  "disabled": false,
3104
3104
  "document": "分片的主可用区\n注意:此字段可能返回 null,表示取不到有效值。",
3105
- "example": "",
3105
+ "example": "ap-guangzhou-2",
3106
3106
  "member": "string",
3107
3107
  "name": "ShardMasterZone",
3108
- "required": true,
3108
+ "output_required": true,
3109
3109
  "type": "string",
3110
3110
  "value_allowed_null": true
3111
3111
  },
3112
3112
  {
3113
3113
  "disabled": false,
3114
3114
  "document": "分片的从可用区列表\n注意:此字段可能返回 null,表示取不到有效值。",
3115
- "example": "",
3115
+ "example": "ap-guangzhou-2",
3116
3116
  "member": "string",
3117
3117
  "name": "ShardSlaveZones",
3118
- "required": true,
3118
+ "output_required": true,
3119
3119
  "type": "list",
3120
3120
  "value_allowed_null": true
3121
3121
  },
3122
3122
  {
3123
3123
  "disabled": false,
3124
3124
  "document": "CPU核数",
3125
- "example": "",
3125
+ "example": "2",
3126
3126
  "member": "int64",
3127
3127
  "name": "Cpu",
3128
- "required": true,
3128
+ "output_required": true,
3129
3129
  "type": "int",
3130
3130
  "value_allowed_null": false
3131
3131
  },
3132
3132
  {
3133
3133
  "disabled": false,
3134
3134
  "document": "分片ShardKey的范围(总共64个哈希值),例如: 0-31,32-63",
3135
- "example": "",
3135
+ "example": "32-63",
3136
3136
  "member": "string",
3137
3137
  "name": "Range",
3138
- "required": true,
3138
+ "output_required": true,
3139
3139
  "type": "string",
3140
3140
  "value_allowed_null": false
3141
3141
  }
@@ -3148,10 +3148,10 @@
3148
3148
  {
3149
3149
  "disabled": false,
3150
3150
  "document": "数据库名称",
3151
- "example": "",
3151
+ "example": "aIgo",
3152
3152
  "member": "string",
3153
3153
  "name": "DbName",
3154
- "required": true,
3154
+ "output_required": true,
3155
3155
  "type": "string",
3156
3156
  "value_allowed_null": false
3157
3157
  }
@@ -3164,10 +3164,10 @@
3164
3164
  {
3165
3165
  "disabled": false,
3166
3166
  "document": "函数名称",
3167
- "example": "",
3167
+ "example": "CountProc2",
3168
3168
  "member": "string",
3169
3169
  "name": "Func",
3170
- "required": true,
3170
+ "output_required": true,
3171
3171
  "type": "string",
3172
3172
  "value_allowed_null": false
3173
3173
  }
@@ -3204,10 +3204,10 @@
3204
3204
  {
3205
3205
  "disabled": false,
3206
3206
  "document": "存储过程名称",
3207
- "example": "",
3207
+ "example": "proc_tst",
3208
3208
  "member": "string",
3209
3209
  "name": "Proc",
3210
- "required": true,
3210
+ "output_required": true,
3211
3211
  "type": "string",
3212
3212
  "value_allowed_null": false
3213
3213
  }
@@ -3220,10 +3220,10 @@
3220
3220
  {
3221
3221
  "disabled": false,
3222
3222
  "document": "表名",
3223
- "example": "",
3223
+ "example": "t_preoss",
3224
3224
  "member": "string",
3225
3225
  "name": "Table",
3226
- "required": true,
3226
+ "output_required": true,
3227
3227
  "type": "string",
3228
3228
  "value_allowed_null": false
3229
3229
  }
@@ -3236,10 +3236,10 @@
3236
3236
  {
3237
3237
  "disabled": false,
3238
3238
  "document": "视图名称",
3239
- "example": "",
3239
+ "example": "v_bpmn",
3240
3240
  "member": "string",
3241
3241
  "name": "View",
3242
- "required": true,
3242
+ "output_required": true,
3243
3243
  "type": "string",
3244
3244
  "value_allowed_null": false
3245
3245
  }
@@ -3676,7 +3676,7 @@
3676
3676
  {
3677
3677
  "disabled": false,
3678
3678
  "document": "数据库名。如果为 \\*,表示查询全局权限(即 \\*.\\*),此时忽略 Type 和 Object 参数",
3679
- "example": "*",
3679
+ "example": "product_db",
3680
3680
  "member": "string",
3681
3681
  "name": "DbName",
3682
3682
  "required": true,
@@ -3685,7 +3685,7 @@
3685
3685
  {
3686
3686
  "disabled": false,
3687
3687
  "document": "类型,可以填入 table 、 view 、 proc 、 func 和 \\*。当 DbName 为具体数据库名,Type为 \\* 时,表示查询该数据库权限(即db.\\*),此时忽略 Object 参数",
3688
- "example": "*",
3688
+ "example": "table",
3689
3689
  "member": "string",
3690
3690
  "name": "Type",
3691
3691
  "required": false,
@@ -3694,7 +3694,7 @@
3694
3694
  {
3695
3695
  "disabled": false,
3696
3696
  "document": "具体的 Type 的名称,例如 Type 为 table 时就是具体的表名。DbName 和 Type 都为具体名称,则 Object 表示具体对象名,不能为 \\* 或者为空",
3697
- "example": "*",
3697
+ "example": "prod_user_tbl",
3698
3698
  "member": "string",
3699
3699
  "name": "Object",
3700
3700
  "required": false,
@@ -3703,7 +3703,7 @@
3703
3703
  {
3704
3704
  "disabled": false,
3705
3705
  "document": "当 Type=table 时,ColName 为 \\* 表示查询表的权限,如果为具体字段名,表示查询对应字段的权限",
3706
- "example": "*",
3706
+ "example": "username",
3707
3707
  "member": "string",
3708
3708
  "name": "ColName",
3709
3709
  "required": false,
@@ -3721,7 +3721,7 @@
3721
3721
  "example": "dcdbt-fdpjf5zh",
3722
3722
  "member": "string",
3723
3723
  "name": "InstanceId",
3724
- "required": true,
3724
+ "output_required": true,
3725
3725
  "type": "string",
3726
3726
  "value_allowed_null": false
3727
3727
  },
@@ -3731,7 +3731,7 @@
3731
3731
  "example": "[\"SELECT\",\"UPDATE\"]",
3732
3732
  "member": "string",
3733
3733
  "name": "Privileges",
3734
- "required": true,
3734
+ "output_required": true,
3735
3735
  "type": "list",
3736
3736
  "value_allowed_null": false
3737
3737
  },
@@ -3741,7 +3741,7 @@
3741
3741
  "example": "testuser1",
3742
3742
  "member": "string",
3743
3743
  "name": "UserName",
3744
- "required": true,
3744
+ "output_required": true,
3745
3745
  "type": "string",
3746
3746
  "value_allowed_null": false
3747
3747
  },
@@ -3751,7 +3751,7 @@
3751
3751
  "example": "172.17.%",
3752
3752
  "member": "string",
3753
3753
  "name": "Host",
3754
- "required": true,
3754
+ "output_required": true,
3755
3755
  "type": "string",
3756
3756
  "value_allowed_null": false
3757
3757
  },
@@ -4001,20 +4001,20 @@
4001
4001
  {
4002
4002
  "disabled": false,
4003
4003
  "document": "备份文件列表",
4004
- "example": "",
4004
+ "example": "[{\"BackupType\":\"Data\",\"EndTime\":\"2024-12-20 16:29:07\",\"FileName\":\"cos_xtrabackup+1734683337+20241220+162857+1507806831+xbstream.lz4\",\"FilePath\":\"cos_backup/tdsql/group_1734680376_202786203/set_1734681147_5/xtrabackup/2024-12-20/cos_xtrabackup+1734683337+20241220+162857+1507806831+xbstream.lz4\",\"FileSize\":13930740,\"InstanceId\":\"tdsqlshard-02badqa3\",\"InstanceName\":\"QT4syxfv8.0\",\"InstanceStatus\":2,\"ManualBackup\":0,\"ShardId\":\"shard-fqj08u7f\",\"StartTime\":\"2024-12-20 16:28:57\",\"StorageClass\":\"STANDARD\",\"Url\":\"\"}]",
4005
4005
  "member": "InstanceBackupFileItem",
4006
4006
  "name": "Files",
4007
- "required": true,
4007
+ "output_required": true,
4008
4008
  "type": "list",
4009
4009
  "value_allowed_null": false
4010
4010
  },
4011
4011
  {
4012
4012
  "disabled": false,
4013
4013
  "document": "总条目数",
4014
- "example": "",
4014
+ "example": "1",
4015
4015
  "member": "int64",
4016
4016
  "name": "TotalCount",
4017
- "required": true,
4017
+ "output_required": true,
4018
4018
  "type": "int",
4019
4019
  "value_allowed_null": false
4020
4020
  },
@@ -4051,17 +4051,17 @@
4051
4051
  "example": "0",
4052
4052
  "member": "int64",
4053
4053
  "name": "EncryptStatus",
4054
- "required": true,
4054
+ "output_required": true,
4055
4055
  "type": "int",
4056
4056
  "value_allowed_null": false
4057
4057
  },
4058
4058
  {
4059
4059
  "disabled": false,
4060
4060
  "document": "DEK密钥",
4061
- "example": "",
4061
+ "example": "qucjG3av6P2QKBgQDPd/H5DjzDj0+Gzg39eOeha+mpJ8tPTo7Qc/5kHWoM9qokIbW",
4062
4062
  "member": "string",
4063
4063
  "name": "CipherText",
4064
- "required": true,
4064
+ "output_required": true,
4065
4065
  "type": "string",
4066
4066
  "value_allowed_null": false
4067
4067
  },
@@ -4071,7 +4071,7 @@
4071
4071
  "example": "2019-01-01 10:00:00",
4072
4072
  "member": "string",
4073
4073
  "name": "ExpireDate",
4074
- "required": true,
4074
+ "output_required": true,
4075
4075
  "type": "string",
4076
4076
  "value_allowed_null": false
4077
4077
  },
@@ -4279,27 +4279,27 @@
4279
4279
  "example": "无",
4280
4280
  "member": "SecurityGroup",
4281
4281
  "name": "Groups",
4282
- "required": true,
4282
+ "output_required": true,
4283
4283
  "type": "list",
4284
4284
  "value_allowed_null": false
4285
4285
  },
4286
4286
  {
4287
4287
  "disabled": false,
4288
4288
  "document": "实例VIP\n注意:此字段可能返回 null,表示取不到有效值。",
4289
- "example": "",
4289
+ "example": "172.16.0.11",
4290
4290
  "member": "string",
4291
4291
  "name": "VIP",
4292
- "required": true,
4292
+ "output_required": true,
4293
4293
  "type": "string",
4294
4294
  "value_allowed_null": true
4295
4295
  },
4296
4296
  {
4297
4297
  "disabled": false,
4298
4298
  "document": "实例端口\n注意:此字段可能返回 null,表示取不到有效值。",
4299
- "example": "",
4299
+ "example": "3306",
4300
4300
  "member": "string",
4301
4301
  "name": "VPort",
4302
- "required": true,
4302
+ "output_required": true,
4303
4303
  "type": "string",
4304
4304
  "value_allowed_null": true
4305
4305
  },
@@ -4742,7 +4742,7 @@
4742
4742
  {
4743
4743
  "disabled": false,
4744
4744
  "document": "外网访问的域名,公网可解析",
4745
- "example": "",
4745
+ "example": "gz-tdsqlshard-rlye31jd.sql.tencentcdb.com",
4746
4746
  "member": "string",
4747
4747
  "name": "WanDomain",
4748
4748
  "output_required": true,
@@ -4752,7 +4752,7 @@
4752
4752
  {
4753
4753
  "disabled": false,
4754
4754
  "document": "外网IP地址,公网可访问",
4755
- "example": "",
4755
+ "example": "43.136.248.14",
4756
4756
  "member": "string",
4757
4757
  "name": "WanVip",
4758
4758
  "output_required": true,
@@ -4952,7 +4952,7 @@
4952
4952
  {
4953
4953
  "disabled": false,
4954
4954
  "document": "内网IPv6\n注意:此字段可能返回 null,表示取不到有效值。",
4955
- "example": "",
4955
+ "example": "2402:5e00:1011:2d01:1:90cb:55fa:e4f4",
4956
4956
  "member": "string",
4957
4957
  "name": "Vip6",
4958
4958
  "output_required": true,
@@ -5002,7 +5002,7 @@
5002
5002
  {
5003
5003
  "disabled": false,
5004
5004
  "document": "外网IPv6地址,公网可访问\n注意:此字段可能返回 null,表示取不到有效值。",
5005
- "example": "",
5005
+ "example": "2402:4e00:1012:2c01:1:90cb:55fa:e4d2",
5006
5006
  "member": "string",
5007
5007
  "name": "WanVipv6",
5008
5008
  "output_required": true,
@@ -5258,7 +5258,7 @@
5258
5258
  {
5259
5259
  "disabled": false,
5260
5260
  "document": "搜索的字段名,当前支持的值有:instancename、vip、all。传 instancename 表示按实例名进行搜索;传 vip 表示按内网IP进行搜索;传 all 将会按实例ID、实例名和内网IP进行搜索。",
5261
- "example": "",
5261
+ "example": "instancename",
5262
5262
  "member": "string",
5263
5263
  "name": "SearchName",
5264
5264
  "required": false,
@@ -5267,7 +5267,7 @@
5267
5267
  {
5268
5268
  "disabled": false,
5269
5269
  "document": "搜索的关键字,支持模糊搜索。多个关键字使用换行符('\\n')分割。",
5270
- "example": "",
5270
+ "example": "dcdbt-52s53yyh",
5271
5271
  "member": "string",
5272
5272
  "name": "SearchKey",
5273
5273
  "required": false,
@@ -5276,7 +5276,7 @@
5276
5276
  {
5277
5277
  "disabled": false,
5278
5278
  "document": "按项目 ID 查询",
5279
- "example": "",
5279
+ "example": "[1077640,1077641]",
5280
5280
  "member": "int64",
5281
5281
  "name": "ProjectIds",
5282
5282
  "required": false,
@@ -5285,7 +5285,7 @@
5285
5285
  {
5286
5286
  "disabled": false,
5287
5287
  "document": "是否根据 VPC 网络来搜索",
5288
- "example": "",
5288
+ "example": "true",
5289
5289
  "member": "bool",
5290
5290
  "name": "IsFilterVpc",
5291
5291
  "required": false,
@@ -5294,7 +5294,7 @@
5294
5294
  {
5295
5295
  "disabled": false,
5296
5296
  "document": "私有网络 ID, IsFilterVpc 为 1 时有效",
5297
- "example": "",
5297
+ "example": "vpc-737mtr2f",
5298
5298
  "member": "string",
5299
5299
  "name": "VpcId",
5300
5300
  "required": false,
@@ -5303,7 +5303,7 @@
5303
5303
  {
5304
5304
  "disabled": false,
5305
5305
  "document": "私有网络的子网 ID, IsFilterVpc 为 1 时有效",
5306
- "example": "",
5306
+ "example": "subnet-au6ics6s",
5307
5307
  "member": "string",
5308
5308
  "name": "SubnetId",
5309
5309
  "required": false,
@@ -5312,7 +5312,7 @@
5312
5312
  {
5313
5313
  "disabled": false,
5314
5314
  "document": "排序字段, projectId, createtime, instancename 三者之一",
5315
- "example": "",
5315
+ "example": "createtime",
5316
5316
  "member": "string",
5317
5317
  "name": "OrderBy",
5318
5318
  "required": false,
@@ -5321,7 +5321,7 @@
5321
5321
  {
5322
5322
  "disabled": false,
5323
5323
  "document": "排序类型, desc 或者 asc",
5324
- "example": "",
5324
+ "example": "asc",
5325
5325
  "member": "string",
5326
5326
  "name": "OrderByType",
5327
5327
  "required": false,
@@ -5330,7 +5330,7 @@
5330
5330
  {
5331
5331
  "disabled": false,
5332
5332
  "document": "偏移量,默认为 0",
5333
- "example": "",
5333
+ "example": "0",
5334
5334
  "member": "int64",
5335
5335
  "name": "Offset",
5336
5336
  "required": false,
@@ -5339,7 +5339,7 @@
5339
5339
  {
5340
5340
  "disabled": false,
5341
5341
  "document": "返回数量,默认为 10,最大值为 100。",
5342
- "example": "",
5342
+ "example": "20",
5343
5343
  "member": "int64",
5344
5344
  "name": "Limit",
5345
5345
  "required": false,
@@ -5348,7 +5348,7 @@
5348
5348
  {
5349
5349
  "disabled": false,
5350
5350
  "document": "1非独享集群,2独享集群, 0全部",
5351
- "example": "",
5351
+ "example": "0",
5352
5352
  "member": "int64",
5353
5353
  "name": "ExclusterType",
5354
5354
  "required": false,
@@ -5357,7 +5357,7 @@
5357
5357
  {
5358
5358
  "disabled": false,
5359
5359
  "document": "标识是否使用ExclusterType字段, false不使用,true使用",
5360
- "example": "",
5360
+ "example": "false",
5361
5361
  "member": "bool",
5362
5362
  "name": "IsFilterExcluster",
5363
5363
  "required": false,
@@ -5366,7 +5366,7 @@
5366
5366
  {
5367
5367
  "disabled": false,
5368
5368
  "document": "独享集群ID",
5369
- "example": "",
5369
+ "example": "[\"dbdc-4ih6uct9\"]",
5370
5370
  "member": "string",
5371
5371
  "name": "ExclusterIds",
5372
5372
  "required": false,
@@ -5375,7 +5375,7 @@
5375
5375
  {
5376
5376
  "disabled": false,
5377
5377
  "document": "按标签key查询",
5378
- "example": "",
5378
+ "example": "[\"负责人\", \"备份负责人\"]\t",
5379
5379
  "member": "string",
5380
5380
  "name": "TagKeys",
5381
5381
  "required": false,
@@ -5393,7 +5393,7 @@
5393
5393
  {
5394
5394
  "disabled": false,
5395
5395
  "document": "实例类型过滤,1-独享实例,2-主实例,3-灾备实例,多个按逗号分隔",
5396
- "example": "",
5396
+ "example": "2",
5397
5397
  "member": "string",
5398
5398
  "name": "FilterInstanceType",
5399
5399
  "required": false,
@@ -5401,8 +5401,8 @@
5401
5401
  },
5402
5402
  {
5403
5403
  "disabled": false,
5404
- "document": "按实例状态筛选",
5405
- "example": "",
5404
+ "document": "按实例状态筛选。状态值 -2:已删除; -1:已隔离;0:创建中;1:流程处理中;2:运行中",
5405
+ "example": "[1,2]",
5406
5406
  "member": "int64",
5407
5407
  "name": "Status",
5408
5408
  "required": false,
@@ -5410,8 +5410,8 @@
5410
5410
  },
5411
5411
  {
5412
5412
  "disabled": false,
5413
- "document": "排除实例状态",
5414
- "example": "",
5413
+ "document": "排除实例状态。状态值 -2:已删除; -1:已隔离;0:创建中;1:流程处理中;2:运行中",
5414
+ "example": "[-1,-2]",
5415
5415
  "member": "int64",
5416
5416
  "name": "ExcludeStatus",
5417
5417
  "required": false,
@@ -5678,7 +5678,7 @@
5678
5678
  {
5679
5679
  "disabled": false,
5680
5680
  "document": "分片ID列表。",
5681
- "example": "[]",
5681
+ "example": "[\"shard-5zf65smf\",\"shard-ngbrea6b\"]",
5682
5682
  "member": "string",
5683
5683
  "name": "ShardInstanceIds",
5684
5684
  "required": false,
@@ -5732,7 +5732,7 @@
5732
5732
  "example": "2",
5733
5733
  "member": "int64",
5734
5734
  "name": "TotalCount",
5735
- "required": true,
5735
+ "output_required": true,
5736
5736
  "type": "int",
5737
5737
  "value_allowed_null": false
5738
5738
  },
@@ -5742,7 +5742,7 @@
5742
5742
  "example": "无",
5743
5743
  "member": "DCDBShardInfo",
5744
5744
  "name": "Shards",
5745
- "required": true,
5745
+ "output_required": true,
5746
5746
  "type": "list",
5747
5747
  "value_allowed_null": false
5748
5748
  },
@@ -5752,7 +5752,7 @@
5752
5752
  "example": "0",
5753
5753
  "member": "int64",
5754
5754
  "name": "DcnFlag",
5755
- "required": true,
5755
+ "output_required": true,
5756
5756
  "type": "int",
5757
5757
  "value_allowed_null": true
5758
5758
  },
@@ -5882,7 +5882,7 @@
5882
5882
  {
5883
5883
  "disabled": false,
5884
5884
  "document": "数据库名称,通过 DescribeDatabases 接口获取。",
5885
- "example": "test",
5885
+ "example": "product_db",
5886
5886
  "member": "string",
5887
5887
  "name": "DbName",
5888
5888
  "required": true,
@@ -5900,17 +5900,17 @@
5900
5900
  "example": "dcdbt-52s53yyh",
5901
5901
  "member": "string",
5902
5902
  "name": "InstanceId",
5903
- "required": true,
5903
+ "output_required": true,
5904
5904
  "type": "string",
5905
5905
  "value_allowed_null": false
5906
5906
  },
5907
5907
  {
5908
5908
  "disabled": false,
5909
5909
  "document": "数据库名称。",
5910
- "example": "test",
5910
+ "example": "product_db",
5911
5911
  "member": "string",
5912
5912
  "name": "DbName",
5913
- "required": true,
5913
+ "output_required": true,
5914
5914
  "type": "string",
5915
5915
  "value_allowed_null": false
5916
5916
  },
@@ -5920,7 +5920,7 @@
5920
5920
  "example": "无",
5921
5921
  "member": "DatabaseTable",
5922
5922
  "name": "Tables",
5923
- "required": true,
5923
+ "output_required": true,
5924
5924
  "type": "list",
5925
5925
  "value_allowed_null": false
5926
5926
  },
@@ -5930,7 +5930,7 @@
5930
5930
  "example": "无",
5931
5931
  "member": "DatabaseView",
5932
5932
  "name": "Views",
5933
- "required": true,
5933
+ "output_required": true,
5934
5934
  "type": "list",
5935
5935
  "value_allowed_null": false
5936
5936
  },
@@ -5940,7 +5940,7 @@
5940
5940
  "example": "无",
5941
5941
  "member": "DatabaseProcedure",
5942
5942
  "name": "Procs",
5943
- "required": true,
5943
+ "output_required": true,
5944
5944
  "type": "list",
5945
5945
  "value_allowed_null": false
5946
5946
  },
@@ -5950,7 +5950,7 @@
5950
5950
  "example": "无",
5951
5951
  "member": "DatabaseFunction",
5952
5952
  "name": "Funcs",
5953
- "required": true,
5953
+ "output_required": true,
5954
5954
  "type": "list",
5955
5955
  "value_allowed_null": false
5956
5956
  },
@@ -5978,7 +5978,7 @@
5978
5978
  {
5979
5979
  "disabled": false,
5980
5980
  "document": "数据库名称,通过 DescribeDatabases 接口获取。",
5981
- "example": "test",
5981
+ "example": "product_db",
5982
5982
  "member": "string",
5983
5983
  "name": "DbName",
5984
5984
  "required": true,
@@ -6005,17 +6005,17 @@
6005
6005
  "example": "dcdbt-52s53yyh",
6006
6006
  "member": "string",
6007
6007
  "name": "InstanceId",
6008
- "required": true,
6008
+ "output_required": true,
6009
6009
  "type": "string",
6010
6010
  "value_allowed_null": false
6011
6011
  },
6012
6012
  {
6013
6013
  "disabled": false,
6014
6014
  "document": "数据库名称。",
6015
- "example": "test",
6015
+ "example": "product_db",
6016
6016
  "member": "string",
6017
6017
  "name": "DbName",
6018
- "required": true,
6018
+ "output_required": true,
6019
6019
  "type": "string",
6020
6020
  "value_allowed_null": false
6021
6021
  },
@@ -6025,7 +6025,7 @@
6025
6025
  "example": "persons",
6026
6026
  "member": "string",
6027
6027
  "name": "Table",
6028
- "required": true,
6028
+ "output_required": true,
6029
6029
  "type": "string",
6030
6030
  "value_allowed_null": false
6031
6031
  },
@@ -6035,7 +6035,7 @@
6035
6035
  "example": "无",
6036
6036
  "member": "TableColumn",
6037
6037
  "name": "Cols",
6038
- "required": true,
6038
+ "output_required": true,
6039
6039
  "type": "list",
6040
6040
  "value_allowed_null": false
6041
6041
  },
@@ -6192,7 +6192,7 @@
6192
6192
  {
6193
6193
  "disabled": false,
6194
6194
  "document": "异步请求接口返回的任务流程号。",
6195
- "example": "",
6195
+ "example": "3341",
6196
6196
  "member": "int64",
6197
6197
  "name": "FlowId",
6198
6198
  "required": true,
@@ -6207,10 +6207,10 @@
6207
6207
  {
6208
6208
  "disabled": false,
6209
6209
  "document": "流程状态,0:成功,1:失败,2:运行中",
6210
- "example": "",
6210
+ "example": "2",
6211
6211
  "member": "int64",
6212
6212
  "name": "Status",
6213
- "required": true,
6213
+ "output_required": true,
6214
6214
  "type": "int",
6215
6215
  "value_allowed_null": false
6216
6216
  },
@@ -6350,17 +6350,17 @@
6350
6350
  "example": "无",
6351
6351
  "member": "SecurityGroup",
6352
6352
  "name": "Groups",
6353
- "required": true,
6353
+ "output_required": true,
6354
6354
  "type": "list",
6355
6355
  "value_allowed_null": false
6356
6356
  },
6357
6357
  {
6358
6358
  "disabled": false,
6359
6359
  "document": "安全组个数。",
6360
- "example": "",
6360
+ "example": "1",
6361
6361
  "member": "uint64",
6362
6362
  "name": "Total",
6363
- "required": true,
6363
+ "output_required": true,
6364
6364
  "type": "int",
6365
6365
  "value_allowed_null": false
6366
6366
  },
@@ -6433,7 +6433,7 @@
6433
6433
  {
6434
6434
  "disabled": false,
6435
6435
  "document": "任务的状态列表。0-任务启动中;1-任务运行中;2-任务成功;3-任务失败",
6436
- "example": "",
6436
+ "example": "[1,3]",
6437
6437
  "member": "int64",
6438
6438
  "name": "Statuses",
6439
6439
  "required": false,
@@ -6442,7 +6442,7 @@
6442
6442
  {
6443
6443
  "disabled": false,
6444
6444
  "document": "实例ID列表",
6445
- "example": "",
6445
+ "example": "[\"tdsqlshard-d7tnnu13\"]",
6446
6446
  "member": "string",
6447
6447
  "name": "InstanceIds",
6448
6448
  "required": false,
@@ -6451,7 +6451,7 @@
6451
6451
  {
6452
6452
  "disabled": false,
6453
6453
  "document": "任务类型列表,当前支持的任务类型有:0-回档任务;1-创建实例任务;2-扩容任务;3-迁移任务;4-删除实例任务;5-重启任务",
6454
- "example": "",
6454
+ "example": "[1,2,3]",
6455
6455
  "member": "int64",
6456
6456
  "name": "FlowTypes",
6457
6457
  "required": false,
@@ -6460,7 +6460,7 @@
6460
6460
  {
6461
6461
  "disabled": false,
6462
6462
  "document": "任务的创建时间",
6463
- "example": "",
6463
+ "example": "2024-12-14 16:00:00",
6464
6464
  "member": "string",
6465
6465
  "name": "StartTime",
6466
6466
  "required": false,
@@ -6469,7 +6469,7 @@
6469
6469
  {
6470
6470
  "disabled": false,
6471
6471
  "document": "任务的结束时间",
6472
- "example": "",
6472
+ "example": "2024-12-19 16:00:00",
6473
6473
  "member": "string",
6474
6474
  "name": "EndTime",
6475
6475
  "required": false,
@@ -6478,7 +6478,7 @@
6478
6478
  {
6479
6479
  "disabled": false,
6480
6480
  "document": "任务ID的数组",
6481
- "example": "",
6481
+ "example": "[17122,17124]",
6482
6482
  "member": "int64",
6483
6483
  "name": "UTaskIds",
6484
6484
  "required": false,
@@ -6514,7 +6514,7 @@
6514
6514
  "example": "6",
6515
6515
  "member": "int64",
6516
6516
  "name": "TotalCount",
6517
- "required": true,
6517
+ "output_required": true,
6518
6518
  "type": "int",
6519
6519
  "value_allowed_null": false
6520
6520
  },
@@ -6524,7 +6524,7 @@
6524
6524
  "example": "无",
6525
6525
  "member": "UserTaskInfo",
6526
6526
  "name": "FlowSet",
6527
- "required": true,
6527
+ "output_required": true,
6528
6528
  "type": "list",
6529
6529
  "value_allowed_null": false
6530
6530
  },
@@ -6778,7 +6778,7 @@
6778
6778
  {
6779
6779
  "disabled": false,
6780
6780
  "document": "数据库名。如果为 \\*,表示查询全局权限(即 \\*.\\*),此时忽略 Type 和 Object 参数",
6781
- "example": "*",
6781
+ "example": "product_db",
6782
6782
  "member": "string",
6783
6783
  "name": "DbName",
6784
6784
  "required": true,
@@ -6796,7 +6796,7 @@
6796
6796
  {
6797
6797
  "disabled": false,
6798
6798
  "document": "类型,可以填入 table 和 \\*。当 DbName 为具体数据库名,Type为 \\* 时,表示设置该数据库权限(即db.\\*),此时忽略 Object 参数",
6799
- "example": "*",
6799
+ "example": "table",
6800
6800
  "member": "string",
6801
6801
  "name": "Type",
6802
6802
  "required": false,
@@ -6805,7 +6805,7 @@
6805
6805
  {
6806
6806
  "disabled": false,
6807
6807
  "document": "具体的 Type 的名称,例如 Type 为 table 时就是具体的表名。DbName 和 Type 都为具体名称,则 Object 表示具体对象名,不能为 \\* 或者为空",
6808
- "example": "",
6808
+ "example": "prod_user_tbl",
6809
6809
  "member": "string",
6810
6810
  "name": "Object",
6811
6811
  "required": false,
@@ -6814,7 +6814,7 @@
6814
6814
  {
6815
6815
  "disabled": false,
6816
6816
  "document": "当 Type=table 时,ColName 为 \\* 表示对表授权,如果为具体字段名,表示对字段授权",
6817
- "example": "",
6817
+ "example": "username",
6818
6818
  "member": "string",
6819
6819
  "name": "ColName",
6820
6820
  "required": false,
@@ -7023,7 +7023,7 @@
7023
7023
  {
7024
7024
  "disabled": false,
7025
7025
  "document": "实例 ID,格式如:tdsqlshard-avw0207d,与云数据库控制台页面中显示的实例 ID 相同,可使用 查询实例列表 接口获取,其值为输出参数中字段 InstanceId 的值。",
7026
- "example": "tdsqlshard-avw0207d",
7026
+ "example": "[\"tdsqlshard-pevrkilh\",\"tdsqlshard-0n6swl0t\"]",
7027
7027
  "member": "string",
7028
7028
  "name": "InstanceIds",
7029
7029
  "required": true,
@@ -7038,18 +7038,20 @@
7038
7038
  {
7039
7039
  "disabled": false,
7040
7040
  "document": "隔离成功实例ID列表。",
7041
- "example": "[]",
7041
+ "example": "[\"tdsqlshard-pevrkilh\"]",
7042
7042
  "member": "string",
7043
7043
  "name": "SuccessInstanceIds",
7044
+ "output_required": true,
7044
7045
  "type": "list",
7045
7046
  "value_allowed_null": false
7046
7047
  },
7047
7048
  {
7048
7049
  "disabled": false,
7049
7050
  "document": "隔离失败实例ID列表。",
7050
- "example": "[]",
7051
+ "example": "[\"tdsqlshard-0n6swl0t\"]",
7051
7052
  "member": "string",
7052
7053
  "name": "FailedInstanceIds",
7054
+ "output_required": true,
7053
7055
  "type": "list",
7054
7056
  "value_allowed_null": false
7055
7057
  },
@@ -7095,7 +7097,7 @@
7095
7097
  {
7096
7098
  "disabled": false,
7097
7099
  "document": "待升级的实例ID列表。形如:[\"dcdbt-ow728lmc\"],可以通过 DescribeDCDBInstances 查询实例详情获得。",
7098
- "example": "[\"dcdbt-ow728lmc\"]",
7100
+ "example": "[\"dcdbt-ow728lmc\",\"tdsqlshard-b0uoxwvh\"]",
7099
7101
  "member": "string",
7100
7102
  "name": "InstanceIds",
7101
7103
  "required": true,
@@ -7110,7 +7112,7 @@
7110
7112
  {
7111
7113
  "disabled": false,
7112
7114
  "document": "隔离成功的实例id列表",
7113
- "example": "[]",
7115
+ "example": "[\"dcdbt-ow728lmc\"]",
7114
7116
  "member": "string",
7115
7117
  "name": "SuccessInstanceIds",
7116
7118
  "output_required": true,
@@ -7120,7 +7122,7 @@
7120
7122
  {
7121
7123
  "disabled": false,
7122
7124
  "document": "隔离失败的实例id列表",
7123
- "example": "[]",
7125
+ "example": "[\"tdsqlshard-b0uoxwvh\"]",
7124
7126
  "member": "string",
7125
7127
  "name": "FailedInstanceIds",
7126
7128
  "output_required": true,
@@ -7151,7 +7153,7 @@
7151
7153
  {
7152
7154
  "disabled": false,
7153
7155
  "document": "会话ID列表",
7154
- "example": "[1111,2222]",
7156
+ "example": "[11917970, 11918810]",
7155
7157
  "member": "int64",
7156
7158
  "name": "SessionId",
7157
7159
  "required": true,
@@ -7187,7 +7189,7 @@
7187
7189
  "example": "11",
7188
7190
  "member": "int64",
7189
7191
  "name": "TaskId",
7190
- "required": true,
7192
+ "output_required": true,
7191
7193
  "type": "int",
7192
7194
  "value_allowed_null": false
7193
7195
  },
@@ -7206,40 +7208,40 @@
7206
7208
  {
7207
7209
  "disabled": false,
7208
7210
  "document": "Log最后修改时间",
7209
- "example": "",
7211
+ "example": "15054029",
7210
7212
  "member": "uint64",
7211
7213
  "name": "Mtime",
7212
- "required": true,
7214
+ "output_required": true,
7213
7215
  "type": "int",
7214
7216
  "value_allowed_null": false
7215
7217
  },
7216
7218
  {
7217
7219
  "disabled": false,
7218
7220
  "document": "文件长度",
7219
- "example": "",
7221
+ "example": "1733814880",
7220
7222
  "member": "uint64",
7221
7223
  "name": "Length",
7222
- "required": true,
7224
+ "output_required": true,
7223
7225
  "type": "int",
7224
7226
  "value_allowed_null": false
7225
7227
  },
7226
7228
  {
7227
7229
  "disabled": false,
7228
7230
  "document": "下载Log时用到的统一资源标识符",
7229
- "example": "",
7231
+ "example": "cos_xtrabackup+1733814880+20241210+151440+471405052+xbstream.lz4",
7230
7232
  "member": "string",
7231
7233
  "name": "Uri",
7232
- "required": true,
7234
+ "output_required": true,
7233
7235
  "type": "string",
7234
7236
  "value_allowed_null": false
7235
7237
  },
7236
7238
  {
7237
7239
  "disabled": false,
7238
7240
  "document": "文件名",
7239
- "example": "",
7241
+ "example": "/cos_backup%2Ftdsql%2Fset_1732784236_431669%2Fxtrabackup%2F2024-12-10%2Fcos_xtrabackup%2B1733814880%2B20241210%2B151440%2B471405052%2Bxbstream.lz4?q-sign-algorithm=sha1&q-ak=AKIDxxxx&q-sign-time=1733884388%3B1733885288&q-key-time=1733884388%3B1733885288&q-header-list=host&q-url-param-list=&q-signature=f978b91c6f7031d47fce45bb07b5164b7192b3d9",
7240
7242
  "member": "string",
7241
7243
  "name": "FileName",
7242
- "required": true,
7244
+ "output_required": true,
7243
7245
  "type": "string",
7244
7246
  "value_allowed_null": false
7245
7247
  }
@@ -7261,7 +7263,7 @@
7261
7263
  {
7262
7264
  "disabled": false,
7263
7265
  "document": "账号的名称",
7264
- "example": "test",
7266
+ "example": "user_ops",
7265
7267
  "member": "string",
7266
7268
  "name": "UserName",
7267
7269
  "required": true,
@@ -7360,7 +7362,7 @@
7360
7362
  {
7361
7363
  "disabled": false,
7362
7364
  "document": "实例 ID,格式如:tdsql-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。",
7363
- "example": "",
7365
+ "example": "tdsqlshard-f35wr6wj",
7364
7366
  "member": "string",
7365
7367
  "name": "InstanceId",
7366
7368
  "required": true,
@@ -7378,7 +7380,7 @@
7378
7380
  {
7379
7381
  "disabled": false,
7380
7382
  "document": "全局权限。其中,GlobalPrivileges 中权限的可选值为:\"SELECT\",\"INSERT\",\"UPDATE\",\"DELETE\",\"CREATE\", \"PROCESS\", \"DROP\",\"REFERENCES\",\"INDEX\",\"ALTER\",\"SHOW DATABASES\",\"CREATE TEMPORARY TABLES\",\"LOCK TABLES\",\"EXECUTE\",\"CREATE VIEW\",\"SHOW VIEW\",\"CREATE ROUTINE\",\"ALTER ROUTINE\",\"EVENT\",\"TRIGGER\"。\n注意,不传该参数表示保留现有权限,如需清除,该字段传空数组。",
7381
- "example": "",
7383
+ "example": "[\"SELECT\",\"SHOW DATABASES\"]",
7382
7384
  "member": "string",
7383
7385
  "name": "GlobalPrivileges",
7384
7386
  "required": false,
@@ -7429,9 +7431,10 @@
7429
7431
  {
7430
7432
  "disabled": false,
7431
7433
  "document": "异步任务的请求 ID,可使用此 ID [查询异步任务的执行结果](https://cloud.tencent.com/document/product/237/16177)。",
7432
- "example": "",
7434
+ "example": "162000019",
7433
7435
  "member": "int64",
7434
7436
  "name": "FlowId",
7437
+ "output_required": true,
7435
7438
  "type": "int",
7436
7439
  "value_allowed_null": false
7437
7440
  },
@@ -7896,7 +7899,7 @@
7896
7899
  {
7897
7900
  "disabled": false,
7898
7901
  "document": "IPv6标志",
7899
- "example": "",
7902
+ "example": "0",
7900
7903
  "member": "uint64",
7901
7904
  "name": "Ipv6Flag",
7902
7905
  "required": false,
@@ -7923,7 +7926,7 @@
7923
7926
  "example": "1122",
7924
7927
  "member": "int64",
7925
7928
  "name": "FlowId",
7926
- "required": true,
7929
+ "output_required": true,
7927
7930
  "type": "int",
7928
7931
  "value_allowed_null": false
7929
7932
  },
@@ -7978,7 +7981,7 @@
7978
7981
  {
7979
7982
  "disabled": false,
7980
7983
  "document": "实例 ID,格式如:tdsqlshard-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。",
7981
- "example": "",
7984
+ "example": "tdsqshard-f35wr6wj",
7982
7985
  "member": "string",
7983
7986
  "name": "InstanceId",
7984
7987
  "required": true,
@@ -7987,7 +7990,7 @@
7987
7990
  {
7988
7991
  "disabled": false,
7989
7992
  "document": "RS就近模式, 0-无策略, 1-可用区就近访问。",
7990
- "example": "",
7993
+ "example": "1",
7991
7994
  "member": "int64",
7992
7995
  "name": "RsAccessStrategy",
7993
7996
  "required": true,
@@ -8074,20 +8077,20 @@
8074
8077
  {
8075
8078
  "disabled": false,
8076
8079
  "document": "DB节点ID",
8077
- "example": "",
8080
+ "example": "4ddc0ea18433",
8078
8081
  "member": "string",
8079
8082
  "name": "NodeId",
8080
- "required": true,
8083
+ "output_required": true,
8081
8084
  "type": "string",
8082
8085
  "value_allowed_null": false
8083
8086
  },
8084
8087
  {
8085
8088
  "disabled": false,
8086
8089
  "document": "DB节点角色,取值为master或者slave",
8087
- "example": "",
8090
+ "example": "master",
8088
8091
  "member": "string",
8089
8092
  "name": "Role",
8090
- "required": true,
8093
+ "output_required": true,
8091
8094
  "type": "string",
8092
8095
  "value_allowed_null": false
8093
8096
  }
@@ -8146,40 +8149,40 @@
8146
8149
  {
8147
8150
  "disabled": false,
8148
8151
  "document": "约束类型,如枚举enum,区间section",
8149
- "example": "",
8152
+ "example": "section",
8150
8153
  "member": "string",
8151
8154
  "name": "Type",
8152
- "required": true,
8155
+ "output_required": true,
8153
8156
  "type": "string",
8154
8157
  "value_allowed_null": false
8155
8158
  },
8156
8159
  {
8157
8160
  "disabled": false,
8158
8161
  "document": "约束类型为enum时的可选值列表",
8159
- "example": "",
8162
+ "example": "ALL,OFF,FILTER",
8160
8163
  "member": "string",
8161
8164
  "name": "Enum",
8162
- "required": true,
8165
+ "output_required": true,
8163
8166
  "type": "string",
8164
8167
  "value_allowed_null": false
8165
8168
  },
8166
8169
  {
8167
8170
  "disabled": false,
8168
8171
  "document": "约束类型为section时的范围\n注意:此字段可能返回 null,表示取不到有效值。",
8169
- "example": "",
8172
+ "example": "{\"max\":\"65535\",\"min\":\"1\"}",
8170
8173
  "member": "ConstraintRange",
8171
8174
  "name": "Range",
8172
- "required": true,
8175
+ "output_required": true,
8173
8176
  "type": "object",
8174
8177
  "value_allowed_null": true
8175
8178
  },
8176
8179
  {
8177
8180
  "disabled": false,
8178
8181
  "document": "约束类型为string时的可选值列表",
8179
- "example": "",
8182
+ "example": "REAL_AS_FLOAT,PIPES_AS_CONCAT,ANSI_QUOTES,IGNORE_SPACE,IGNORE_BAD_TABLE_OPTIONS,ONLY_FULL_GROUP_BY,NO_UNSIGNED_SUBTRACTION,NO_DIR_IN_CREATE,NO_KEY_OPTIONS,NO_TABLE_OPTIONS,NO_FIELD_OPTIONS,NO_AUTO_VALUE_ON_ZERO,NO_BACKSLASH_ESCAPES,STRICT_TRANS_TABLES,STRICT_ALL_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ALLOW_INVALID_DATES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,HIGH_NOT_PRECEDENCE,NO_ENGINE_SUBSTITUTION,PAD_CHAR_TO_FULL_LENGTH",
8180
8183
  "member": "string",
8181
8184
  "name": "String",
8182
- "required": true,
8185
+ "output_required": true,
8183
8186
  "type": "string",
8184
8187
  "value_allowed_null": false
8185
8188
  }
@@ -8268,20 +8271,20 @@
8268
8271
  {
8269
8272
  "disabled": false,
8270
8273
  "document": "修改参数名字",
8271
- "example": "",
8274
+ "example": "autocommit",
8272
8275
  "member": "string",
8273
8276
  "name": "Param",
8274
- "required": true,
8277
+ "output_required": true,
8275
8278
  "type": "string",
8276
8279
  "value_allowed_null": false
8277
8280
  },
8278
8281
  {
8279
8282
  "disabled": false,
8280
8283
  "document": "参数修改结果。0表示修改成功;-1表示修改失败;-2表示该参数值非法",
8281
- "example": "",
8284
+ "example": "0",
8282
8285
  "member": "int64",
8283
8286
  "name": "Code",
8284
- "required": true,
8287
+ "output_required": true,
8285
8288
  "type": "int",
8286
8289
  "value_allowed_null": false
8287
8290
  }
@@ -8294,110 +8297,110 @@
8294
8297
  {
8295
8298
  "disabled": false,
8296
8299
  "document": "项目ID",
8297
- "example": "",
8300
+ "example": "1035094",
8298
8301
  "member": "int64",
8299
8302
  "name": "ProjectId",
8300
- "required": true,
8303
+ "output_required": true,
8301
8304
  "type": "int",
8302
8305
  "value_allowed_null": false
8303
8306
  },
8304
8307
  {
8305
8308
  "disabled": false,
8306
8309
  "document": "资源拥有者(主账号)uin",
8307
- "example": "",
8310
+ "example": "70012255787",
8308
8311
  "member": "int64",
8309
8312
  "name": "OwnerUin",
8310
- "required": true,
8313
+ "output_required": true,
8311
8314
  "type": "int",
8312
8315
  "value_allowed_null": false
8313
8316
  },
8314
8317
  {
8315
8318
  "disabled": false,
8316
8319
  "document": "应用Id",
8317
- "example": "",
8320
+ "example": "1280075989",
8318
8321
  "member": "int64",
8319
8322
  "name": "AppId",
8320
- "required": true,
8323
+ "output_required": true,
8321
8324
  "type": "int",
8322
8325
  "value_allowed_null": false
8323
8326
  },
8324
8327
  {
8325
8328
  "disabled": false,
8326
8329
  "document": "项目名称",
8327
- "example": "",
8330
+ "example": "tdsql测试\t",
8328
8331
  "member": "string",
8329
8332
  "name": "Name",
8330
- "required": true,
8333
+ "output_required": true,
8331
8334
  "type": "string",
8332
8335
  "value_allowed_null": false
8333
8336
  },
8334
8337
  {
8335
8338
  "disabled": false,
8336
8339
  "document": "创建者uin",
8337
- "example": "",
8340
+ "example": "70012255787\t",
8338
8341
  "member": "int64",
8339
8342
  "name": "CreatorUin",
8340
- "required": true,
8343
+ "output_required": true,
8341
8344
  "type": "int",
8342
8345
  "value_allowed_null": false
8343
8346
  },
8344
8347
  {
8345
8348
  "disabled": false,
8346
8349
  "document": "来源平台",
8347
- "example": "",
8350
+ "example": "qcloud\t",
8348
8351
  "member": "string",
8349
8352
  "name": "SrcPlat",
8350
- "required": true,
8353
+ "output_required": true,
8351
8354
  "type": "string",
8352
8355
  "value_allowed_null": false
8353
8356
  },
8354
8357
  {
8355
8358
  "disabled": false,
8356
8359
  "document": "来源AppId",
8357
- "example": "",
8360
+ "example": "1280075989",
8358
8361
  "member": "int64",
8359
8362
  "name": "SrcAppId",
8360
- "required": true,
8363
+ "output_required": true,
8361
8364
  "type": "int",
8362
8365
  "value_allowed_null": false
8363
8366
  },
8364
8367
  {
8365
8368
  "disabled": false,
8366
8369
  "document": "项目状态,0正常,-1关闭。默认项目为3",
8367
- "example": "",
8370
+ "example": "0",
8368
8371
  "member": "int64",
8369
8372
  "name": "Status",
8370
- "required": true,
8373
+ "output_required": true,
8371
8374
  "type": "int",
8372
8375
  "value_allowed_null": false
8373
8376
  },
8374
8377
  {
8375
8378
  "disabled": false,
8376
8379
  "document": "创建时间",
8377
- "example": "",
8380
+ "example": "2024-10-11 10:11:12\t",
8378
8381
  "member": "datetime",
8379
8382
  "name": "CreateTime",
8380
- "required": true,
8383
+ "output_required": true,
8381
8384
  "type": "string",
8382
8385
  "value_allowed_null": false
8383
8386
  },
8384
8387
  {
8385
8388
  "disabled": false,
8386
8389
  "document": "是否默认项目,1 是,0 不是",
8387
- "example": "",
8390
+ "example": "0",
8388
8391
  "member": "int64",
8389
8392
  "name": "IsDefault",
8390
- "required": true,
8393
+ "output_required": true,
8391
8394
  "type": "int",
8392
8395
  "value_allowed_null": false
8393
8396
  },
8394
8397
  {
8395
8398
  "disabled": false,
8396
8399
  "document": "描述信息",
8397
- "example": "",
8400
+ "example": "tdsql测试项目\t",
8398
8401
  "member": "string",
8399
8402
  "name": "Info",
8400
- "required": true,
8403
+ "output_required": true,
8401
8404
  "type": "string",
8402
8405
  "value_allowed_null": false
8403
8406
  }
@@ -8410,50 +8413,50 @@
8410
8413
  {
8411
8414
  "disabled": false,
8412
8415
  "document": "地域英文ID",
8413
- "example": "",
8416
+ "example": "ap-guangzhou",
8414
8417
  "member": "string",
8415
8418
  "name": "Region",
8416
- "required": true,
8419
+ "output_required": true,
8417
8420
  "type": "string",
8418
8421
  "value_allowed_null": false
8419
8422
  },
8420
8423
  {
8421
8424
  "disabled": false,
8422
8425
  "document": "地域数字ID",
8423
- "example": "",
8426
+ "example": "1",
8424
8427
  "member": "int64",
8425
8428
  "name": "RegionId",
8426
- "required": true,
8429
+ "output_required": true,
8427
8430
  "type": "int",
8428
8431
  "value_allowed_null": false
8429
8432
  },
8430
8433
  {
8431
8434
  "disabled": false,
8432
8435
  "document": "地域中文名",
8433
- "example": "",
8436
+ "example": "广州",
8434
8437
  "member": "string",
8435
8438
  "name": "RegionName",
8436
- "required": true,
8439
+ "output_required": true,
8437
8440
  "type": "string",
8438
8441
  "value_allowed_null": false
8439
8442
  },
8440
8443
  {
8441
8444
  "disabled": false,
8442
8445
  "document": "可用区列表",
8443
- "example": "",
8446
+ "example": "[{\"Zone\":\"ap-guangzhou-1\",\"ZoneId\":100001,\"ZoneName\":\"广州一区\",\"OnSale\":true},{\"Zone\":\"ap-guangzhou-2\",\"ZoneId\":100002,\"ZoneName\":\"广州二区\",\"OnSale\":true}]",
8444
8447
  "member": "ZonesInfo",
8445
8448
  "name": "ZoneList",
8446
- "required": true,
8449
+ "output_required": true,
8447
8450
  "type": "list",
8448
8451
  "value_allowed_null": false
8449
8452
  },
8450
8453
  {
8451
8454
  "disabled": false,
8452
8455
  "document": "可选择的主可用区和从可用区",
8453
- "example": "",
8456
+ "example": "[{ \"MasterZone\":{ \"Zone\":\"ap-guangzhou-1\", \"ZoneId\":100001, \"ZoneName\":\"广州一区\", \"OnSale\":true }, \"SlaveZones\":[{ \"Zone\":\"ap-guangzhou-1\", \"ZoneId\":100001, \"ZoneName\":\"广州一区\", \"OnSale\":true }, { \"Zone\":\"ap-guangzhou-2\", \"ZoneId\":100002, \"ZoneName\":\"广州二区\", \"OnSale\":true }] }, { \"MasterZone\":{ \"Zone\":\"ap-guangzhou-2\", \"ZoneId\":100002, \"ZoneName\":\"广州二区\", \"OnSale\":true }, \"SlaveZones\":[{ \"Zone\":\"ap-guangzhou-1\", \"ZoneId\":100001, \"ZoneName\":\"广州一区\", \"OnSale\":true }, { \"Zone\":\"ap-guangzhou-2\", \"ZoneId\":100002, \"ZoneName\":\"广州二区\", \"OnSale\":true }] }]",
8454
8457
  "member": "ShardZoneChooseInfo",
8455
8458
  "name": "AvailableChoice",
8456
- "required": true,
8459
+ "output_required": true,
8457
8460
  "type": "list",
8458
8461
  "value_allowed_null": false
8459
8462
  }
@@ -8493,7 +8496,7 @@
8493
8496
  {
8494
8497
  "disabled": false,
8495
8498
  "document": "代金券ID列表,目前仅支持指定一张代金券。",
8496
- "example": "",
8499
+ "example": "[\"ZRPCQJGMYSYV73IYOTFJD8\"]\t",
8497
8500
  "member": "string",
8498
8501
  "name": "VoucherIds",
8499
8502
  "required": false,
@@ -8511,7 +8514,7 @@
8511
8514
  "example": "20171103110253",
8512
8515
  "member": "string",
8513
8516
  "name": "DealName",
8514
- "required": true,
8517
+ "output_required": true,
8515
8518
  "type": "string",
8516
8519
  "value_allowed_null": false
8517
8520
  },
@@ -8677,70 +8680,70 @@
8677
8680
  {
8678
8681
  "disabled": false,
8679
8682
  "document": "项目ID",
8680
- "example": "",
8683
+ "example": "10068",
8681
8684
  "member": "int64",
8682
8685
  "name": "ProjectId",
8683
- "required": true,
8686
+ "output_required": true,
8684
8687
  "type": "int",
8685
8688
  "value_allowed_null": false
8686
8689
  },
8687
8690
  {
8688
8691
  "disabled": false,
8689
8692
  "document": "创建时间,时间格式:yyyy-mm-dd hh:mm:ss",
8690
- "example": "",
8693
+ "example": "2024-11-13 20:20:05\t",
8691
8694
  "member": "string",
8692
8695
  "name": "CreateTime",
8693
- "required": true,
8696
+ "output_required": true,
8694
8697
  "type": "string",
8695
8698
  "value_allowed_null": false
8696
8699
  },
8697
8700
  {
8698
8701
  "disabled": false,
8699
8702
  "document": "安全组ID",
8700
- "example": "",
8703
+ "example": "sg-iry0kj68",
8701
8704
  "member": "string",
8702
8705
  "name": "SecurityGroupId",
8703
- "required": true,
8706
+ "output_required": true,
8704
8707
  "type": "string",
8705
8708
  "value_allowed_null": false
8706
8709
  },
8707
8710
  {
8708
8711
  "disabled": false,
8709
8712
  "document": "安全组名称",
8710
- "example": "",
8713
+ "example": "TDSQL-for-tst",
8711
8714
  "member": "string",
8712
8715
  "name": "SecurityGroupName",
8713
- "required": true,
8716
+ "output_required": true,
8714
8717
  "type": "string",
8715
8718
  "value_allowed_null": false
8716
8719
  },
8717
8720
  {
8718
8721
  "disabled": false,
8719
8722
  "document": "安全组备注",
8720
- "example": "",
8723
+ "example": "自定义",
8721
8724
  "member": "string",
8722
8725
  "name": "SecurityGroupRemark",
8723
- "required": true,
8726
+ "output_required": true,
8724
8727
  "type": "string",
8725
8728
  "value_allowed_null": false
8726
8729
  },
8727
8730
  {
8728
8731
  "disabled": false,
8729
8732
  "document": "入站规则",
8730
- "example": "",
8733
+ "example": "[ { \"Action\": \"ACCEPT\", \"AddressModule\": \"\", \"CidrIp\": \"211.139.*\", \"Desc\": \"\", \"Id\": \"\", \"IpProtocol\": \"tcp\", \"PortRange\": \"80,443\", \"ServiceModule\": \"\" }, { \"Action\": \"ACCEPT\", \"AddressModule\": \"ipm-b0cywwyy\", \"CidrIp\": \"\", \"Desc\": \"成都出口IP\", \"Id\": \"\", \"IpProtocol\": \"tcp\", \"PortRange\": \"80,443\", \"ServiceModule\": \"\" } ]\t",
8731
8734
  "member": "SecurityGroupBound",
8732
8735
  "name": "Inbound",
8733
- "required": true,
8736
+ "output_required": true,
8734
8737
  "type": "list",
8735
8738
  "value_allowed_null": false
8736
8739
  },
8737
8740
  {
8738
8741
  "disabled": false,
8739
8742
  "document": "出站规则",
8740
- "example": "",
8743
+ "example": "[ { \"Action\": \"ACCEPT\", \"AddressModule\": \"\", \"CidrIp\": \"0.0.0.0/0\", \"Desc\": \"\", \"Id\": \"\", \"IpProtocol\": \"ALL\", \"PortRange\": \"ALL\", \"ServiceModule\": \"\" }, { \"Action\": \"ACCEPT\", \"AddressModule\": \"\", \"CidrIp\": \"\", \"Desc\": \"\", \"Id\": \"\", \"IpProtocol\": \"ALL\", \"PortRange\": \"ALL\", \"ServiceModule\": \"\" } ]",
8741
8744
  "member": "SecurityGroupBound",
8742
8745
  "name": "Outbound",
8743
- "required": true,
8746
+ "output_required": true,
8744
8747
  "type": "list",
8745
8748
  "value_allowed_null": false
8746
8749
  }
@@ -8802,7 +8805,7 @@
8802
8805
  "example": "set_1612751240_1",
8803
8806
  "member": "string",
8804
8807
  "name": "ShardSerialId",
8805
- "required": true,
8808
+ "output_required": true,
8806
8809
  "type": "string",
8807
8810
  "value_allowed_null": false
8808
8811
  },
@@ -8812,7 +8815,7 @@
8812
8815
  "example": "shard-lbt0utcz",
8813
8816
  "member": "string",
8814
8817
  "name": "ShardInstanceId",
8815
- "required": true,
8818
+ "output_required": true,
8816
8819
  "type": "string",
8817
8820
  "value_allowed_null": false
8818
8821
  },
@@ -8822,7 +8825,7 @@
8822
8825
  "example": "2",
8823
8826
  "member": "int64",
8824
8827
  "name": "Status",
8825
- "required": true,
8828
+ "output_required": true,
8826
8829
  "type": "int",
8827
8830
  "value_allowed_null": false
8828
8831
  },
@@ -8832,7 +8835,7 @@
8832
8835
  "example": "运行中",
8833
8836
  "member": "string",
8834
8837
  "name": "StatusDesc",
8835
- "required": true,
8838
+ "output_required": true,
8836
8839
  "type": "string",
8837
8840
  "value_allowed_null": false
8838
8841
  },
@@ -8842,7 +8845,7 @@
8842
8845
  "example": "2021-02-08 10:25:08",
8843
8846
  "member": "datetime",
8844
8847
  "name": "CreateTime",
8845
- "required": true,
8848
+ "output_required": true,
8846
8849
  "type": "string",
8847
8850
  "value_allowed_null": false
8848
8851
  },
@@ -8852,7 +8855,7 @@
8852
8855
  "example": "2",
8853
8856
  "member": "int64",
8854
8857
  "name": "Memory",
8855
- "required": true,
8858
+ "output_required": true,
8856
8859
  "type": "int",
8857
8860
  "value_allowed_null": false
8858
8861
  },
@@ -8862,7 +8865,7 @@
8862
8865
  "example": "10",
8863
8866
  "member": "int64",
8864
8867
  "name": "Storage",
8865
- "required": true,
8868
+ "output_required": true,
8866
8869
  "type": "int",
8867
8870
  "value_allowed_null": false
8868
8871
  },
@@ -8872,7 +8875,7 @@
8872
8875
  "example": "8",
8873
8876
  "member": "int64",
8874
8877
  "name": "LogDisk",
8875
- "required": true,
8878
+ "output_required": true,
8876
8879
  "type": "int",
8877
8880
  "value_allowed_null": false
8878
8881
  },
@@ -8882,7 +8885,7 @@
8882
8885
  "example": "3",
8883
8886
  "member": "int64",
8884
8887
  "name": "NodeCount",
8885
- "required": true,
8888
+ "output_required": true,
8886
8889
  "type": "int",
8887
8890
  "value_allowed_null": false
8888
8891
  },
@@ -8892,7 +8895,7 @@
8892
8895
  "example": "0.007",
8893
8896
  "member": "float",
8894
8897
  "name": "StorageUsage",
8895
- "required": true,
8898
+ "output_required": true,
8896
8899
  "type": "float",
8897
8900
  "value_allowed_null": false
8898
8901
  },
@@ -8902,7 +8905,7 @@
8902
8905
  "example": "1.14.63-M-V2R667D003",
8903
8906
  "member": "string",
8904
8907
  "name": "ProxyVersion",
8905
- "required": true,
8908
+ "output_required": true,
8906
8909
  "type": "string",
8907
8910
  "value_allowed_null": false
8908
8911
  },
@@ -8912,7 +8915,7 @@
8912
8915
  "example": "ap-guangzhou-1",
8913
8916
  "member": "string",
8914
8917
  "name": "ShardMasterZone",
8915
- "required": true,
8918
+ "output_required": true,
8916
8919
  "type": "string",
8917
8920
  "value_allowed_null": false
8918
8921
  },
@@ -8922,7 +8925,7 @@
8922
8925
  "example": "[\"ap-guangzhou-1\", \"ap-guangzhou-2\"]",
8923
8926
  "member": "string",
8924
8927
  "name": "ShardSlaveZones",
8925
- "required": true,
8928
+ "output_required": true,
8926
8929
  "type": "list",
8927
8930
  "value_allowed_null": false
8928
8931
  },
@@ -8932,17 +8935,17 @@
8932
8935
  "example": "1",
8933
8936
  "member": "int64",
8934
8937
  "name": "Cpu",
8935
- "required": true,
8938
+ "output_required": true,
8936
8939
  "type": "int",
8937
8940
  "value_allowed_null": false
8938
8941
  },
8939
8942
  {
8940
8943
  "disabled": false,
8941
8944
  "document": "DB节点信息\n注意:此字段可能返回 null,表示取不到有效值。",
8942
- "example": "null",
8945
+ "example": "[{\"NodeId\": \"4ddc0ea18433\", \"Role\": \"master\"}, { \"NodeId\": \"5d51cf1f018c\",\"Role\": \"slave\" }]",
8943
8946
  "member": "NodeInfo",
8944
8947
  "name": "NodesInfo",
8945
- "required": true,
8948
+ "output_required": true,
8946
8949
  "type": "list",
8947
8950
  "value_allowed_null": true
8948
8951
  }
@@ -8955,100 +8958,100 @@
8955
8958
  {
8956
8959
  "disabled": false,
8957
8960
  "document": "分片ID",
8958
- "example": "",
8961
+ "example": "shard-1xb2mmed",
8959
8962
  "member": "string",
8960
8963
  "name": "ShardInstanceId",
8961
- "required": true,
8964
+ "output_required": true,
8962
8965
  "type": "string",
8963
8966
  "value_allowed_null": false
8964
8967
  },
8965
8968
  {
8966
8969
  "disabled": false,
8967
8970
  "document": "分片Set ID",
8968
- "example": "",
8971
+ "example": "set_1734060861_3",
8969
8972
  "member": "string",
8970
8973
  "name": "ShardSerialId",
8971
- "required": true,
8974
+ "output_required": true,
8972
8975
  "type": "string",
8973
8976
  "value_allowed_null": false
8974
8977
  },
8975
8978
  {
8976
8979
  "disabled": false,
8977
8980
  "document": "状态:0 创建中,1 流程处理中, 2 运行中,3 分片未初始化,-2 分片已删除",
8978
- "example": "",
8981
+ "example": "2",
8979
8982
  "member": "int64",
8980
8983
  "name": "Status",
8981
- "required": true,
8984
+ "output_required": true,
8982
8985
  "type": "int",
8983
8986
  "value_allowed_null": false
8984
8987
  },
8985
8988
  {
8986
8989
  "disabled": false,
8987
8990
  "document": "创建时间",
8988
- "example": "",
8991
+ "example": "2024-12-13 11:31:10",
8989
8992
  "member": "string",
8990
8993
  "name": "Createtime",
8991
- "required": true,
8994
+ "output_required": true,
8992
8995
  "type": "string",
8993
8996
  "value_allowed_null": false
8994
8997
  },
8995
8998
  {
8996
8999
  "disabled": false,
8997
9000
  "document": "内存大小,单位 GB",
8998
- "example": "",
9001
+ "example": "2",
8999
9002
  "member": "int64",
9000
9003
  "name": "Memory",
9001
- "required": true,
9004
+ "output_required": true,
9002
9005
  "type": "int",
9003
9006
  "value_allowed_null": false
9004
9007
  },
9005
9008
  {
9006
9009
  "disabled": false,
9007
9010
  "document": "存储大小,单位 GB",
9008
- "example": "",
9011
+ "example": "20",
9009
9012
  "member": "int64",
9010
9013
  "name": "Storage",
9011
- "required": true,
9014
+ "output_required": true,
9012
9015
  "type": "int",
9013
9016
  "value_allowed_null": false
9014
9017
  },
9015
9018
  {
9016
9019
  "disabled": false,
9017
9020
  "document": "分片数字ID",
9018
- "example": "",
9021
+ "example": "17732",
9019
9022
  "member": "int64",
9020
9023
  "name": "ShardId",
9021
- "required": true,
9024
+ "output_required": true,
9022
9025
  "type": "int",
9023
9026
  "value_allowed_null": false
9024
9027
  },
9025
9028
  {
9026
9029
  "disabled": false,
9027
9030
  "document": "节点数,2 为一主一从, 3 为一主二从",
9028
- "example": "",
9031
+ "example": "2",
9029
9032
  "member": "int64",
9030
9033
  "name": "NodeCount",
9031
- "required": true,
9034
+ "output_required": true,
9032
9035
  "type": "int",
9033
9036
  "value_allowed_null": false
9034
9037
  },
9035
9038
  {
9036
9039
  "disabled": false,
9037
9040
  "document": "产品类型 Id(过时字段,请勿依赖该值)",
9038
- "example": "",
9041
+ "example": "1001670",
9039
9042
  "member": "int64",
9040
9043
  "name": "Pid",
9041
- "required": true,
9044
+ "output_required": true,
9042
9045
  "type": "int",
9043
9046
  "value_allowed_null": false
9044
9047
  },
9045
9048
  {
9046
9049
  "disabled": false,
9047
9050
  "document": "Cpu核数",
9048
- "example": "",
9051
+ "example": "1",
9049
9052
  "member": "uint64",
9050
9053
  "name": "Cpu",
9051
- "required": true,
9054
+ "output_required": true,
9052
9055
  "type": "int",
9053
9056
  "value_allowed_null": false
9054
9057
  }
@@ -9061,20 +9064,20 @@
9061
9064
  {
9062
9065
  "disabled": false,
9063
9066
  "document": "主可用区",
9064
- "example": "",
9067
+ "example": "{ \"Zone\":\"ap-guangzhou-1\", \"ZoneId\":100001, \"ZoneName\":\"广州一区\", \"OnSale\":true }",
9065
9068
  "member": "ZonesInfo",
9066
9069
  "name": "MasterZone",
9067
- "required": true,
9070
+ "output_required": true,
9068
9071
  "type": "object",
9069
9072
  "value_allowed_null": false
9070
9073
  },
9071
9074
  {
9072
9075
  "disabled": false,
9073
9076
  "document": "可选的从可用区",
9074
- "example": "",
9077
+ "example": "[{ \"Zone\":\"ap-guangzhou-1\", \"ZoneId\":100001, \"ZoneName\":\"广州一区\", \"OnSale\":true }, { \"Zone\":\"ap-guangzhou-2\", \"ZoneId\":100002, \"ZoneName\":\"广州二区\", \"OnSale\":true }]",
9075
9078
  "member": "ZonesInfo",
9076
9079
  "name": "SlaveZones",
9077
- "required": true,
9080
+ "output_required": true,
9078
9081
  "type": "list",
9079
9082
  "value_allowed_null": false
9080
9083
  }
@@ -9283,20 +9286,20 @@
9283
9286
  {
9284
9287
  "disabled": false,
9285
9288
  "document": "规格机型",
9286
- "example": "",
9289
+ "example": "SH12",
9287
9290
  "member": "string",
9288
9291
  "name": "Machine",
9289
- "required": true,
9292
+ "output_required": true,
9290
9293
  "type": "string",
9291
9294
  "value_allowed_null": false
9292
9295
  },
9293
9296
  {
9294
9297
  "disabled": false,
9295
9298
  "document": "规格列表",
9296
- "example": "",
9299
+ "example": "[{\"Cpu\":1,\"MaxStorage\":3000,\"Memory\":2,\"MinStorage\":10,\"NodeCount\":3,\"Pid\":1001670,\"Qps\":2100,\"SuitInfo\":\"日独立用户数上百人的小型应用\"},{\"Cpu\":1,\"MaxStorage\":3000,\"Memory\":2,\"MinStorage\":10,\"NodeCount\":4,\"Pid\":1001670,\"Qps\":2100,\"SuitInfo\":\"日独立用户数上百人的小型应用\"}]",
9297
9300
  "member": "SpecConfigInfo",
9298
9301
  "name": "SpecConfigInfos",
9299
- "required": true,
9302
+ "output_required": true,
9300
9303
  "type": "list",
9301
9304
  "value_allowed_null": false
9302
9305
  }
@@ -9309,80 +9312,80 @@
9309
9312
  {
9310
9313
  "disabled": false,
9311
9314
  "document": "节点个数,2 表示一主一从,3 表示一主二从",
9312
- "example": "",
9315
+ "example": "1",
9313
9316
  "member": "uint64",
9314
9317
  "name": "NodeCount",
9315
- "required": true,
9318
+ "output_required": true,
9316
9319
  "type": "int",
9317
9320
  "value_allowed_null": false
9318
9321
  },
9319
9322
  {
9320
9323
  "disabled": false,
9321
9324
  "document": "内存大小,单位 GB",
9322
- "example": "",
9325
+ "example": "8",
9323
9326
  "member": "int64",
9324
9327
  "name": "Memory",
9325
- "required": true,
9328
+ "output_required": true,
9326
9329
  "type": "int",
9327
9330
  "value_allowed_null": false
9328
9331
  },
9329
9332
  {
9330
9333
  "disabled": false,
9331
9334
  "document": "数据盘规格最小值,单位 GB",
9332
- "example": "",
9335
+ "example": "10",
9333
9336
  "member": "int64",
9334
9337
  "name": "MinStorage",
9335
- "required": true,
9338
+ "output_required": true,
9336
9339
  "type": "int",
9337
9340
  "value_allowed_null": false
9338
9341
  },
9339
9342
  {
9340
9343
  "disabled": false,
9341
9344
  "document": "数据盘规格最大值,单位 GB",
9342
- "example": "",
9345
+ "example": "3000",
9343
9346
  "member": "int64",
9344
9347
  "name": "MaxStorage",
9345
- "required": true,
9348
+ "output_required": true,
9346
9349
  "type": "int",
9347
9350
  "value_allowed_null": false
9348
9351
  },
9349
9352
  {
9350
9353
  "disabled": false,
9351
9354
  "document": "推荐的使用场景",
9352
- "example": "",
9355
+ "example": "日独立用户数上千人的小型应用",
9353
9356
  "member": "string",
9354
9357
  "name": "SuitInfo",
9355
- "required": true,
9358
+ "output_required": true,
9356
9359
  "type": "string",
9357
9360
  "value_allowed_null": false
9358
9361
  },
9359
9362
  {
9360
9363
  "disabled": false,
9361
9364
  "document": "产品类型 Id",
9362
- "example": "",
9365
+ "example": "1001670",
9363
9366
  "member": "int64",
9364
9367
  "name": "Pid",
9365
- "required": true,
9368
+ "output_required": true,
9366
9369
  "type": "int",
9367
9370
  "value_allowed_null": false
9368
9371
  },
9369
9372
  {
9370
9373
  "disabled": false,
9371
9374
  "document": "最大 Qps 值",
9372
- "example": "",
9375
+ "example": "6500",
9373
9376
  "member": "int64",
9374
9377
  "name": "Qps",
9375
- "required": true,
9378
+ "output_required": true,
9376
9379
  "type": "int",
9377
9380
  "value_allowed_null": false
9378
9381
  },
9379
9382
  {
9380
9383
  "disabled": false,
9381
9384
  "document": "CPU核数",
9382
- "example": "",
9385
+ "example": "4",
9383
9386
  "member": "int64",
9384
9387
  "name": "Cpu",
9385
- "required": true,
9388
+ "output_required": true,
9386
9389
  "type": "int",
9387
9390
  "value_allowed_null": false
9388
9391
  }
@@ -9441,7 +9444,7 @@
9441
9444
  {
9442
9445
  "disabled": false,
9443
9446
  "document": "实例Id,形如 tdsql-ow728lmc。",
9444
- "example": "",
9447
+ "example": "tdsqlshard-b0uoxwvh",
9445
9448
  "member": "string",
9446
9449
  "name": "InstanceId",
9447
9450
  "required": true,
@@ -9450,7 +9453,7 @@
9450
9453
  {
9451
9454
  "disabled": false,
9452
9455
  "document": "切换的目标区域,会自动选择该可用区中延迟最低的节点。",
9453
- "example": "",
9456
+ "example": "ap-guangzhou-3",
9454
9457
  "member": "string",
9455
9458
  "name": "Zone",
9456
9459
  "required": true,
@@ -9474,7 +9477,7 @@
9474
9477
  {
9475
9478
  "disabled": false,
9476
9479
  "document": "异步流程Id",
9477
- "example": "",
9480
+ "example": "145623",
9478
9481
  "member": "uint64",
9479
9482
  "name": "FlowId",
9480
9483
  "output_required": true,
@@ -9496,20 +9499,20 @@
9496
9499
  {
9497
9500
  "disabled": false,
9498
9501
  "document": "列名称",
9499
- "example": "",
9502
+ "example": "name",
9500
9503
  "member": "string",
9501
9504
  "name": "Col",
9502
- "required": true,
9505
+ "output_required": true,
9503
9506
  "type": "string",
9504
9507
  "value_allowed_null": false
9505
9508
  },
9506
9509
  {
9507
9510
  "disabled": false,
9508
9511
  "document": "列类型",
9509
- "example": "",
9512
+ "example": "varchar(256)",
9510
9513
  "member": "string",
9511
9514
  "name": "Type",
9512
- "required": true,
9515
+ "output_required": true,
9513
9516
  "type": "string",
9514
9517
  "value_allowed_null": false
9515
9518
  }
@@ -9616,150 +9619,150 @@
9616
9619
  {
9617
9620
  "disabled": false,
9618
9621
  "document": "应用ID\n注意:此字段可能返回 null,表示取不到有效值。",
9619
- "example": "",
9622
+ "example": "128007987",
9620
9623
  "member": "int64",
9621
9624
  "name": "AppId",
9622
- "required": true,
9625
+ "output_required": true,
9623
9626
  "type": "int",
9624
9627
  "value_allowed_null": true
9625
9628
  },
9626
9629
  {
9627
9630
  "disabled": false,
9628
9631
  "document": "创建时间\n注意:此字段可能返回 null,表示取不到有效值。",
9629
- "example": "",
9632
+ "example": "2024-10-11 10:00:11",
9630
9633
  "member": "datetime",
9631
9634
  "name": "CreateTime",
9632
- "required": true,
9635
+ "output_required": true,
9633
9636
  "type": "string",
9634
9637
  "value_allowed_null": true
9635
9638
  },
9636
9639
  {
9637
9640
  "disabled": false,
9638
9641
  "document": "实例备注\n注意:此字段可能返回 null,表示取不到有效值。",
9639
- "example": "",
9642
+ "example": "tdsqlshard-fortdsql-tst",
9640
9643
  "member": "string",
9641
9644
  "name": "InstanceRemark",
9642
- "required": true,
9645
+ "output_required": true,
9643
9646
  "type": "string",
9644
9647
  "value_allowed_null": true
9645
9648
  },
9646
9649
  {
9647
9650
  "disabled": false,
9648
9651
  "document": "0:非临时实例 ,1:无效临时实例, 2:回档成功的有效临时实例\n注意:此字段可能返回 null,表示取不到有效值。",
9649
- "example": "",
9652
+ "example": "0",
9650
9653
  "member": "int64",
9651
9654
  "name": "TempType",
9652
- "required": true,
9655
+ "output_required": true,
9653
9656
  "type": "int",
9654
9657
  "value_allowed_null": true
9655
9658
  },
9656
9659
  {
9657
9660
  "disabled": false,
9658
9661
  "document": "实例状态,0:待初始化,1:流程处理中,2:有效状态,-1:已隔离,-2:已下线\n注意:此字段可能返回 null,表示取不到有效值。",
9659
- "example": "",
9662
+ "example": "2",
9660
9663
  "member": "int64",
9661
9664
  "name": "Status",
9662
- "required": true,
9665
+ "output_required": true,
9663
9666
  "type": "int",
9664
9667
  "value_allowed_null": true
9665
9668
  },
9666
9669
  {
9667
9670
  "disabled": false,
9668
9671
  "document": "实例 ID,形如:tdsql-ow728lmc。\n注意:此字段可能返回 null,表示取不到有效值。",
9669
- "example": "",
9672
+ "example": "tdsqlshard-fortdsql",
9670
9673
  "member": "string",
9671
9674
  "name": "InstanceId",
9672
- "required": true,
9675
+ "output_required": true,
9673
9676
  "type": "string",
9674
9677
  "value_allowed_null": true
9675
9678
  },
9676
9679
  {
9677
9680
  "disabled": false,
9678
9681
  "document": "实例虚IP\n注意:此字段可能返回 null,表示取不到有效值。",
9679
- "example": "",
9682
+ "example": "10.1.0.1",
9680
9683
  "member": "string",
9681
9684
  "name": "Vip",
9682
- "required": true,
9685
+ "output_required": true,
9683
9686
  "type": "string",
9684
9687
  "value_allowed_null": true
9685
9688
  },
9686
9689
  {
9687
9690
  "disabled": false,
9688
9691
  "document": "实例虚端口\n注意:此字段可能返回 null,表示取不到有效值。",
9689
- "example": "",
9692
+ "example": "3306",
9690
9693
  "member": "int64",
9691
9694
  "name": "Vport",
9692
- "required": true,
9695
+ "output_required": true,
9693
9696
  "type": "int",
9694
9697
  "value_allowed_null": true
9695
9698
  },
9696
9699
  {
9697
9700
  "disabled": false,
9698
9701
  "document": "有效期结束时间\n注意:此字段可能返回 null,表示取不到有效值。",
9699
- "example": "",
9702
+ "example": "2024-12-11 10:00:11",
9700
9703
  "member": "datetime",
9701
9704
  "name": "PeriodEndTime",
9702
- "required": true,
9705
+ "output_required": true,
9703
9706
  "type": "string",
9704
9707
  "value_allowed_null": true
9705
9708
  },
9706
9709
  {
9707
9710
  "disabled": false,
9708
9711
  "document": "源实例 ID,形如:tdsql-ow728lmc。\n注意:此字段可能返回 null,表示取不到有效值。",
9709
- "example": "",
9712
+ "example": "tdsql-srctdsql",
9710
9713
  "member": "string",
9711
9714
  "name": "SrcInstanceId",
9712
- "required": true,
9715
+ "output_required": true,
9713
9716
  "type": "string",
9714
9717
  "value_allowed_null": true
9715
9718
  },
9716
9719
  {
9717
9720
  "disabled": false,
9718
9721
  "document": "实例状态描述\n注意:此字段可能返回 null,表示取不到有效值。",
9719
- "example": "",
9722
+ "example": "2",
9720
9723
  "member": "string",
9721
9724
  "name": "StatusDesc",
9722
- "required": true,
9725
+ "output_required": true,
9723
9726
  "type": "string",
9724
9727
  "value_allowed_null": true
9725
9728
  },
9726
9729
  {
9727
9730
  "disabled": false,
9728
9731
  "document": "实例所在地域\n注意:此字段可能返回 null,表示取不到有效值。",
9729
- "example": "",
9732
+ "example": "ap-guangzhou",
9730
9733
  "member": "string",
9731
9734
  "name": "Region",
9732
- "required": true,
9735
+ "output_required": true,
9733
9736
  "type": "string",
9734
9737
  "value_allowed_null": true
9735
9738
  },
9736
9739
  {
9737
9740
  "disabled": false,
9738
9741
  "document": "实例所在可用区\n注意:此字段可能返回 null,表示取不到有效值。",
9739
- "example": "",
9742
+ "example": "ap-guangzhou-3",
9740
9743
  "member": "string",
9741
9744
  "name": "Zone",
9742
- "required": true,
9745
+ "output_required": true,
9743
9746
  "type": "string",
9744
9747
  "value_allowed_null": true
9745
9748
  },
9746
9749
  {
9747
9750
  "disabled": false,
9748
9751
  "document": "实例虚IPv6\n注意:此字段可能返回 null,表示取不到有效值。",
9749
- "example": "",
9752
+ "example": "2402:4e00:*",
9750
9753
  "member": "string",
9751
9754
  "name": "Vipv6",
9752
- "required": true,
9755
+ "output_required": true,
9753
9756
  "type": "string",
9754
9757
  "value_allowed_null": true
9755
9758
  },
9756
9759
  {
9757
9760
  "disabled": false,
9758
9761
  "document": "实例IPv6标志\n注意:此字段可能返回 null,表示取不到有效值。",
9759
- "example": "",
9762
+ "example": "1",
9760
9763
  "member": "uint64",
9761
9764
  "name": "Ipv6Flag",
9762
- "required": true,
9765
+ "output_required": true,
9763
9766
  "type": "int",
9764
9767
  "value_allowed_null": true
9765
9768
  }
@@ -9826,7 +9829,7 @@
9826
9829
  {
9827
9830
  "disabled": false,
9828
9831
  "document": "代金券ID列表,目前仅支持指定一张代金券。",
9829
- "example": "[]",
9832
+ "example": "[\"ZRPCQJGMYSYV73IYOTFJD8\"]",
9830
9833
  "member": "string",
9831
9834
  "name": "VoucherIds",
9832
9835
  "required": false,
@@ -9835,7 +9838,7 @@
9835
9838
  {
9836
9839
  "disabled": false,
9837
9840
  "document": "变更部署时指定的新可用区列表,第1个为主可用区,其余为从可用区",
9838
- "example": "[]",
9841
+ "example": "[\"ap-guangzhou-3\", \"ap-guangzhou-4\"]",
9839
9842
  "member": "string",
9840
9843
  "name": "Zones",
9841
9844
  "required": false,
@@ -10070,7 +10073,7 @@
10070
10073
  {
10071
10074
  "disabled": false,
10072
10075
  "document": "变更部署时指定的新可用区列表,第1个为主可用区,其余为从可用区",
10073
- "example": "[]",
10076
+ "example": "[\"ap-guangzhou-3\",\"ap-guangzhou-4\"]",
10074
10077
  "member": "string",
10075
10078
  "name": "Zones",
10076
10079
  "required": false,
@@ -10097,110 +10100,110 @@
10097
10100
  {
10098
10101
  "disabled": false,
10099
10102
  "document": "任务ID",
10100
- "example": "",
10103
+ "example": "15985",
10101
10104
  "member": "int64",
10102
10105
  "name": "Id",
10103
- "required": true,
10106
+ "output_required": true,
10104
10107
  "type": "int",
10105
10108
  "value_allowed_null": false
10106
10109
  },
10107
10110
  {
10108
10111
  "disabled": false,
10109
10112
  "document": "用户账户ID",
10110
- "example": "",
10113
+ "example": "1282064859",
10111
10114
  "member": "int64",
10112
10115
  "name": "AppId",
10113
- "required": true,
10116
+ "output_required": true,
10114
10117
  "type": "int",
10115
10118
  "value_allowed_null": false
10116
10119
  },
10117
10120
  {
10118
10121
  "disabled": false,
10119
10122
  "document": "任务状态,0-任务初始化中;1-任务运行中;2-任务成功;3-任务失败",
10120
- "example": "",
10123
+ "example": "2",
10121
10124
  "member": "int64",
10122
10125
  "name": "Status",
10123
- "required": true,
10126
+ "output_required": true,
10124
10127
  "type": "int",
10125
10128
  "value_allowed_null": false
10126
10129
  },
10127
10130
  {
10128
10131
  "disabled": false,
10129
10132
  "document": "任务类型,0-实例回档;1-实例创建;2-实例扩容;3-实例迁移;4-实例删除;5-实例重启",
10130
- "example": "",
10133
+ "example": "6",
10131
10134
  "member": "int64",
10132
10135
  "name": "UserTaskType",
10133
- "required": true,
10136
+ "output_required": true,
10134
10137
  "type": "int",
10135
10138
  "value_allowed_null": false
10136
10139
  },
10137
10140
  {
10138
10141
  "disabled": false,
10139
10142
  "document": "任务创建时间",
10140
- "example": "",
10143
+ "example": "2024-11-08 16:02:53\t",
10141
10144
  "member": "datetime",
10142
10145
  "name": "CreateTime",
10143
- "required": true,
10146
+ "output_required": true,
10144
10147
  "type": "string",
10145
10148
  "value_allowed_null": false
10146
10149
  },
10147
10150
  {
10148
10151
  "disabled": false,
10149
10152
  "document": "任务结束时间",
10150
- "example": "",
10153
+ "example": "2024-11-08 16:02:55\t",
10151
10154
  "member": "datetime",
10152
10155
  "name": "EndTime",
10153
- "required": true,
10156
+ "output_required": true,
10154
10157
  "type": "string",
10155
10158
  "value_allowed_null": false
10156
10159
  },
10157
10160
  {
10158
10161
  "disabled": false,
10159
10162
  "document": "任务错误信息",
10160
- "example": "",
10163
+ "example": "instance status not ok\t",
10161
10164
  "member": "string",
10162
10165
  "name": "ErrMsg",
10163
- "required": true,
10166
+ "output_required": true,
10164
10167
  "type": "string",
10165
10168
  "value_allowed_null": false
10166
10169
  },
10167
10170
  {
10168
10171
  "disabled": false,
10169
10172
  "document": "客户端参数",
10170
- "example": "",
10173
+ "example": "{\"AppId\":1251966477,\"UserType\":1,\"Uin\":\"3374998458\",\"Operator\":\"3374998458\",\"Ids\":[12989],\"RetreatedTime\":\"2019-04-26 14:40:47\"}\t",
10171
10174
  "member": "string",
10172
10175
  "name": "InputData",
10173
- "required": true,
10176
+ "output_required": true,
10174
10177
  "type": "string",
10175
10178
  "value_allowed_null": false
10176
10179
  },
10177
10180
  {
10178
10181
  "disabled": false,
10179
10182
  "document": "实例ID",
10180
- "example": "",
10183
+ "example": "tdsqlshard-ow728lmc\t",
10181
10184
  "member": "string",
10182
10185
  "name": "InstanceId",
10183
- "required": true,
10186
+ "output_required": true,
10184
10187
  "type": "string",
10185
10188
  "value_allowed_null": false
10186
10189
  },
10187
10190
  {
10188
10191
  "disabled": false,
10189
10192
  "document": "实例名称",
10190
- "example": "",
10193
+ "example": "tdsqlshard-ow728lmc-tst\t",
10191
10194
  "member": "string",
10192
10195
  "name": "InstanceName",
10193
- "required": true,
10196
+ "output_required": true,
10194
10197
  "type": "string",
10195
10198
  "value_allowed_null": false
10196
10199
  },
10197
10200
  {
10198
10201
  "disabled": false,
10199
10202
  "document": "地域ID",
10200
- "example": "",
10203
+ "example": "1",
10201
10204
  "member": "int64",
10202
10205
  "name": "RegionId",
10203
- "required": true,
10206
+ "output_required": true,
10204
10207
  "type": "int",
10205
10208
  "value_allowed_null": false
10206
10209
  }