tccli-intl-en 3.0.1237.1__py2.py3-none-any.whl → 3.0.1282.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (214) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +17 -1
  3. tccli/services/advisor/advisor_client.py +8 -2
  4. tccli/services/aiart/aiart_client.py +4 -1
  5. tccli/services/ams/ams_client.py +16 -4
  6. tccli/services/antiddos/antiddos_client.py +280 -70
  7. tccli/services/apigateway/apigateway_client.py +372 -93
  8. tccli/services/apm/apm_client.py +52 -13
  9. tccli/services/asr/asr_client.py +8 -2
  10. tccli/services/autoscaling/autoscaling_client.py +232 -58
  11. tccli/services/autoscaling/v20180419/api.json +1 -1
  12. tccli/services/batch/batch_client.py +112 -28
  13. tccli/services/bi/bi_client.py +1242 -4
  14. tccli/services/bi/v20220105/api.json +5340 -107
  15. tccli/services/bi/v20220105/examples.json +196 -1
  16. tccli/services/billing/billing_client.py +168 -42
  17. tccli/services/cam/cam_client.py +324 -81
  18. tccli/services/captcha/captcha_client.py +4 -1
  19. tccli/services/car/car_client.py +132 -33
  20. tccli/services/cbs/cbs_client.py +152 -38
  21. tccli/services/ccc/ccc_client.py +732 -98
  22. tccli/services/ccc/v20200210/api.json +1727 -196
  23. tccli/services/ccc/v20200210/examples.json +64 -0
  24. tccli/services/cdb/cdb_client.py +532 -133
  25. tccli/services/cdc/cdc_client.py +80 -20
  26. tccli/services/cdc/v20201214/api.json +2 -2
  27. tccli/services/cdc/v20201214/examples.json +4 -4
  28. tccli/services/cdn/cdn_client.py +176 -44
  29. tccli/services/cdwdoris/cdwdoris_client.py +308 -77
  30. tccli/services/cdwpg/cdwpg_client.py +96 -24
  31. tccli/services/cdz/__init__.py +4 -0
  32. tccli/services/cdz/cdz_client.py +210 -0
  33. tccli/services/cdz/v20221123/api.json +233 -0
  34. tccli/services/cdz/v20221123/examples.json +12 -0
  35. tccli/services/cfg/cfg_client.py +64 -16
  36. tccli/services/cfs/cfs_client.py +156 -39
  37. tccli/services/cfw/cfw_client.py +264 -66
  38. tccli/services/chdfs/chdfs_client.py +116 -29
  39. tccli/services/ciam/ciam_client.py +64 -16
  40. tccli/services/ckafka/ckafka_client.py +575 -77
  41. tccli/services/ckafka/v20190819/api.json +2749 -1470
  42. tccli/services/ckafka/v20190819/examples.json +209 -155
  43. tccli/services/clb/clb_client.py +332 -83
  44. tccli/services/clb/v20180317/api.json +29 -14
  45. tccli/services/cloudaudit/cloudaudit_client.py +72 -18
  46. tccli/services/cls/cls_client.py +348 -87
  47. tccli/services/cmq/cmq_client.py +12 -801
  48. tccli/services/cmq/v20190304/api.json +173 -1367
  49. tccli/services/cmq/v20190304/examples.json +0 -120
  50. tccli/services/config/config_client.py +24 -6
  51. tccli/services/controlcenter/controlcenter_client.py +4 -1
  52. tccli/services/csip/csip_client.py +136 -34
  53. tccli/services/ctsdb/ctsdb_client.py +8 -2
  54. tccli/services/cvm/cvm_client.py +627 -110
  55. tccli/services/cvm/v20170312/api.json +750 -340
  56. tccli/services/cvm/v20170312/examples.json +105 -59
  57. tccli/services/cwp/cwp_client.py +1860 -465
  58. tccli/services/cynosdb/cynosdb_client.py +1749 -439
  59. tccli/services/cynosdb/v20190107/api.json +11763 -7697
  60. tccli/services/cynosdb/v20190107/examples.json +132 -4
  61. tccli/services/dataintegration/dataintegration_client.py +4 -1
  62. tccli/services/dayu/dayu_client.py +412 -103
  63. tccli/services/dbbrain/dbbrain_client.py +168 -42
  64. tccli/services/dc/dc_client.py +72 -18
  65. tccli/services/dcdb/dcdb_client.py +248 -62
  66. tccli/services/dlc/dlc_client.py +756 -111
  67. tccli/services/dlc/v20210125/api.json +637 -13
  68. tccli/services/dlc/v20210125/examples.json +48 -0
  69. tccli/services/dms/dms_client.py +8 -2
  70. tccli/services/dnspod/dnspod_client.py +353 -74
  71. tccli/services/dnspod/v20210323/api.json +196 -0
  72. tccli/services/dnspod/v20210323/examples.json +24 -0
  73. tccli/services/domain/domain_client.py +96 -24
  74. tccli/services/dts/dts_client.py +332 -83
  75. tccli/services/eb/eb_client.py +104 -26
  76. tccli/services/ecdn/ecdn_client.py +60 -15
  77. tccli/services/ecm/ecm_client.py +496 -124
  78. tccli/services/eiam/eiam_client.py +160 -40
  79. tccli/services/emr/emr_client.py +2784 -115
  80. tccli/services/emr/v20190103/api.json +14647 -4756
  81. tccli/services/emr/v20190103/examples.json +408 -40
  82. tccli/services/es/es_client.py +84 -21
  83. tccli/services/facefusion/facefusion_client.py +12 -3
  84. tccli/services/faceid/faceid_client.py +76 -19
  85. tccli/services/faceid/v20180301/api.json +79 -14
  86. tccli/services/faceid/v20180301/examples.json +3 -3
  87. tccli/services/gaap/gaap_client.py +352 -88
  88. tccli/services/gme/gme_client.py +40 -10
  89. tccli/services/gpm/gpm_client.py +72 -18
  90. tccli/services/gse/gse_client.py +88 -22
  91. tccli/services/gwlb/gwlb_client.py +72 -18
  92. tccli/services/iai/iai_client.py +116 -29
  93. tccli/services/iap/iap_client.py +24 -6
  94. tccli/services/ims/ims_client.py +4 -1
  95. tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +168 -42
  96. tccli/services/intlpartnersmgt/v20220928/api.json +11 -11
  97. tccli/services/iotcloud/iotcloud_client.py +80 -20
  98. tccli/services/ip/ip_client.py +24 -6
  99. tccli/services/kms/kms_client.py +272 -68
  100. tccli/services/lcic/lcic_client.py +212 -53
  101. tccli/services/lighthouse/lighthouse_client.py +296 -74
  102. tccli/services/lighthouse/v20200324/api.json +14 -14
  103. tccli/services/lighthouse/v20200324/examples.json +5 -5
  104. tccli/services/live/live_client.py +480 -120
  105. tccli/services/lke/lke_client.py +360 -90
  106. tccli/services/lke/v20231130/api.json +182 -39
  107. tccli/services/lkeap/__init__.py +4 -0
  108. tccli/services/lkeap/lkeap_client.py +546 -0
  109. tccli/services/lkeap/v20240522/api.json +855 -0
  110. tccli/services/lkeap/v20240522/examples.json +72 -0
  111. tccli/services/mariadb/mariadb_client.py +200 -50
  112. tccli/services/mdc/mdc_client.py +72 -18
  113. tccli/services/mdl/mdl_client.py +132 -33
  114. tccli/services/mdl/v20200326/api.json +186 -12
  115. tccli/services/mdl/v20200326/examples.json +16 -16
  116. tccli/services/mdp/mdp_client.py +680 -70
  117. tccli/services/mdp/v20200527/api.json +748 -23
  118. tccli/services/mdp/v20200527/examples.json +143 -79
  119. tccli/services/message/__init__.py +4 -0
  120. tccli/services/message/message_client.py +210 -0
  121. tccli/services/message/v20181225/api.json +72 -0
  122. tccli/services/message/v20181225/examples.json +13 -0
  123. tccli/services/mongodb/mongodb_client.py +340 -29
  124. tccli/services/mongodb/v20190725/api.json +811 -226
  125. tccli/services/mongodb/v20190725/examples.json +54 -22
  126. tccli/services/monitor/monitor_client.py +864 -152
  127. tccli/services/monitor/v20180724/api.json +657 -8
  128. tccli/services/monitor/v20180724/examples.json +152 -4
  129. tccli/services/mps/mps_client.py +592 -92
  130. tccli/services/mps/v20190612/api.json +2931 -399
  131. tccli/services/mps/v20190612/examples.json +64 -14
  132. tccli/services/msp/msp_client.py +28 -7
  133. tccli/services/ocr/ocr_client.py +212 -45
  134. tccli/services/ocr/v20181119/api.json +872 -112
  135. tccli/services/ocr/v20181119/examples.json +12 -4
  136. tccli/services/omics/omics_client.py +80 -20
  137. tccli/services/organization/organization_client.py +464 -116
  138. tccli/services/postgres/postgres_client.py +364 -91
  139. tccli/services/postgres/v20170312/api.json +134 -109
  140. tccli/services/postgres/v20170312/examples.json +14 -14
  141. tccli/services/privatedns/privatedns_client.py +124 -31
  142. tccli/services/pts/pts_client.py +192 -48
  143. tccli/services/quota/__init__.py +4 -0
  144. tccli/services/quota/quota_client.py +434 -0
  145. tccli/services/quota/v20241204/api.json +548 -0
  146. tccli/services/quota/v20241204/examples.json +51 -0
  147. tccli/services/rce/rce_client.py +4 -1
  148. tccli/services/redis/redis_client.py +592 -106
  149. tccli/services/redis/v20180412/api.json +636 -240
  150. tccli/services/redis/v20180412/examples.json +98 -56
  151. tccli/services/region/region_client.py +12 -3
  152. tccli/services/rum/rum_client.py +240 -60
  153. tccli/services/scf/scf_client.py +168 -42
  154. tccli/services/ses/ses_client.py +116 -29
  155. tccli/services/sms/sms_client.py +72 -18
  156. tccli/services/sqlserver/sqlserver_client.py +3772 -387
  157. tccli/services/sqlserver/v20180328/api.json +9760 -3380
  158. tccli/services/sqlserver/v20180328/examples.json +478 -18
  159. tccli/services/ssl/ssl_client.py +152 -38
  160. tccli/services/ssm/ssm_client.py +96 -24
  161. tccli/services/sts/sts_client.py +20 -5
  162. tccli/services/tag/tag_client.py +120 -30
  163. tccli/services/tat/tat_client.py +76 -19
  164. tccli/services/tbaas/tbaas_client.py +16 -4
  165. tccli/services/tcaplusdb/tcaplusdb_client.py +208 -52
  166. tccli/services/tcaplusdb/v20190823/api.json +836 -760
  167. tccli/services/tcaplusdb/v20190823/examples.json +3 -3
  168. tccli/services/tchd/tchd_client.py +4 -1
  169. tccli/services/tcmpp/tcmpp_client.py +416 -104
  170. tccli/services/tcr/tcr_client.py +304 -76
  171. tccli/services/tcsas/tcsas_client.py +236 -59
  172. tccli/services/tcsas/v20250106/api.json +155 -79
  173. tccli/services/tcsas/v20250106/examples.json +3 -3
  174. tccli/services/tcss/tcss_client.py +1320 -330
  175. tccli/services/tdid/tdid_client.py +192 -48
  176. tccli/services/tdmq/tdmq_client.py +376 -94
  177. tccli/services/tem/tem_client.py +224 -56
  178. tccli/services/teo/teo_client.py +1127 -245
  179. tccli/services/teo/v20220901/api.json +382 -58
  180. tccli/services/teo/v20220901/examples.json +24 -0
  181. tccli/services/tione/__init__.py +4 -0
  182. tccli/services/tione/tione_client.py +210 -0
  183. tccli/services/tione/v20211111/api.json +3074 -0
  184. tccli/services/tione/v20211111/examples.json +12 -0
  185. tccli/services/tiw/tiw_client.py +204 -51
  186. tccli/services/tke/tke_client.py +552 -138
  187. tccli/services/tms/tms_client.py +4 -1
  188. tccli/services/tmt/tmt_client.py +4 -1
  189. tccli/services/trabbit/trabbit_client.py +116 -29
  190. tccli/services/trro/trro_client.py +76 -19
  191. tccli/services/trtc/trtc_client.py +420 -55
  192. tccli/services/trtc/v20190722/api.json +685 -23
  193. tccli/services/trtc/v20190722/examples.json +39 -7
  194. tccli/services/tts/tts_client.py +4 -1
  195. tccli/services/vclm/vclm_client.py +8 -2
  196. tccli/services/vm/vm_client.py +16 -4
  197. tccli/services/vod/v20180717/examples.json +1 -1
  198. tccli/services/vod/vod_client.py +716 -179
  199. tccli/services/vpc/v20170312/api.json +970 -75
  200. tccli/services/vpc/v20170312/examples.json +106 -10
  201. tccli/services/vpc/vpc_client.py +1876 -361
  202. tccli/services/waf/v20180125/api.json +1372 -194
  203. tccli/services/waf/v20180125/examples.json +89 -1
  204. tccli/services/waf/waf_client.py +1051 -147
  205. tccli/services/wedata/v20250806/api.json +13644 -0
  206. tccli/services/wedata/v20250806/examples.json +621 -0
  207. tccli/services/wedata/wedata_client.py +5830 -1026
  208. tccli/services/yunjing/yunjing_client.py +284 -71
  209. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/METADATA +4 -7
  210. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/RECORD +214 -192
  211. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/WHEEL +1 -1
  212. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/entry_points.txt +0 -1
  213. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/LICENSE +0 -0
  214. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/top_level.txt +0 -0
tccli/services/tcaplusdb/v20190823/api.json CHANGED
@@ -327,7 +327,7 @@
327
327
  "input": "RollbackTablesRequest",
328
328
  "name": "Rolls back table data",
329
329
  "output": "RollbackTablesResponse",
330
- "status": "online"
330
+ "status": "deprecated"
331
331
  },
332
332
  "SetBackupExpireRule": {
333
333
  "document": "This API is used to add/delete/modify backup expiration policy. `ClusterId` must be a specific cluster ID (appid).",
@@ -380,7 +380,7 @@
380
380
  "example": "10001",
381
381
  "member": "string",
382
382
  "name": "ApplicationId",
383
- "required": true,
383
+ "output_required": true,
384
384
  "type": "string",
385
385
  "value_allowed_null": false
386
386
  },
@@ -390,7 +390,7 @@
390
390
  "example": "0",
391
391
  "member": "int64",
392
392
  "name": "ApplicationType",
393
- "required": true,
393
+ "output_required": true,
394
394
  "type": "int",
395
395
  "value_allowed_null": false
396
396
  },
@@ -400,9 +400,9 @@
400
400
  "example": "0",
401
401
  "member": "int64",
402
402
  "name": "ApplicationStatus",
403
- "required": true,
403
+ "output_required": false,
404
404
  "type": "int",
405
- "value_allowed_null": true
405
+ "value_allowed_null": false
406
406
  },
407
407
  {
408
408
  "disabled": false,
@@ -410,9 +410,9 @@
410
410
  "example": "0",
411
411
  "member": "string",
412
412
  "name": "TaskId",
413
- "required": true,
413
+ "output_required": false,
414
414
  "type": "string",
415
- "value_allowed_null": true
415
+ "value_allowed_null": false
416
416
  },
417
417
  {
418
418
  "disabled": false,
@@ -420,9 +420,9 @@
420
420
  "example": "0",
421
421
  "member": "ErrorInfo",
422
422
  "name": "Error",
423
- "required": true,
423
+ "output_required": false,
424
424
  "type": "object",
425
- "value_allowed_null": true
425
+ "value_allowed_null": false
426
426
  }
427
427
  ],
428
428
  "usage": "out"
@@ -641,7 +641,7 @@
641
641
  {
642
642
  "disabled": false,
643
643
  "document": "ID of the cluster instance where a table resides",
644
- "example": "123",
644
+ "example": "898898",
645
645
  "member": "string",
646
646
  "name": "ClusterId",
647
647
  "required": true,
@@ -650,7 +650,7 @@
650
650
  {
651
651
  "disabled": false,
652
652
  "document": "List of information of tables to be cleared",
653
- "example": "null",
653
+ "example": "{}",
654
654
  "member": "SelectedTableInfoNew",
655
655
  "name": "SelectedTables",
656
656
  "required": true,
@@ -668,15 +668,17 @@
668
668
  "example": "0",
669
669
  "member": "uint64",
670
670
  "name": "TotalCount",
671
+ "output_required": true,
671
672
  "type": "int",
672
673
  "value_allowed_null": false
673
674
  },
674
675
  {
675
676
  "disabled": false,
676
677
  "document": "List of table clearing results",
677
- "example": "null",
678
+ "example": "{}",
678
679
  "member": "TableResultNew",
679
680
  "name": "TableResults",
681
+ "output_required": true,
680
682
  "type": "list",
681
683
  "value_allowed_null": false
682
684
  },
@@ -698,7 +700,7 @@
698
700
  "example": "0",
699
701
  "member": "string",
700
702
  "name": "ClusterName",
701
- "required": true,
703
+ "output_required": true,
702
704
  "type": "string",
703
705
  "value_allowed_null": false
704
706
  },
@@ -708,7 +710,7 @@
708
710
  "example": "0",
709
711
  "member": "string",
710
712
  "name": "ClusterId",
711
- "required": true,
713
+ "output_required": true,
712
714
  "type": "string",
713
715
  "value_allowed_null": false
714
716
  },
@@ -718,7 +720,7 @@
718
720
  "example": "0",
719
721
  "member": "string",
720
722
  "name": "Region",
721
- "required": true,
723
+ "output_required": true,
722
724
  "type": "string",
723
725
  "value_allowed_null": false
724
726
  },
@@ -728,7 +730,7 @@
728
730
  "example": "0",
729
731
  "member": "string",
730
732
  "name": "IdlType",
731
- "required": true,
733
+ "output_required": true,
732
734
  "type": "string",
733
735
  "value_allowed_null": false
734
736
  },
@@ -738,7 +740,7 @@
738
740
  "example": "0",
739
741
  "member": "string",
740
742
  "name": "NetworkType",
741
- "required": true,
743
+ "output_required": true,
742
744
  "type": "string",
743
745
  "value_allowed_null": false
744
746
  },
@@ -748,7 +750,7 @@
748
750
  "example": "0",
749
751
  "member": "string",
750
752
  "name": "VpcId",
751
- "required": true,
753
+ "output_required": true,
752
754
  "type": "string",
753
755
  "value_allowed_null": false
754
756
  },
@@ -758,7 +760,7 @@
758
760
  "example": "0",
759
761
  "member": "string",
760
762
  "name": "SubnetId",
761
- "required": true,
763
+ "output_required": true,
762
764
  "type": "string",
763
765
  "value_allowed_null": false
764
766
  },
@@ -768,7 +770,7 @@
768
770
  "example": "0",
769
771
  "member": "datetime",
770
772
  "name": "CreatedTime",
771
- "required": true,
773
+ "output_required": true,
772
774
  "type": "string",
773
775
  "value_allowed_null": false
774
776
  },
@@ -778,7 +780,7 @@
778
780
  "example": "0",
779
781
  "member": "string",
780
782
  "name": "Password",
781
- "required": true,
783
+ "output_required": true,
782
784
  "type": "string",
783
785
  "value_allowed_null": false
784
786
  },
@@ -788,7 +790,7 @@
788
790
  "example": "0",
789
791
  "member": "string",
790
792
  "name": "PasswordStatus",
791
- "required": true,
793
+ "output_required": true,
792
794
  "type": "string",
793
795
  "value_allowed_null": false
794
796
  },
@@ -798,7 +800,7 @@
798
800
  "example": "0",
799
801
  "member": "string",
800
802
  "name": "ApiAccessId",
801
- "required": true,
803
+ "output_required": true,
802
804
  "type": "string",
803
805
  "value_allowed_null": false
804
806
  },
@@ -808,7 +810,7 @@
808
810
  "example": "0",
809
811
  "member": "string",
810
812
  "name": "ApiAccessIp",
811
- "required": true,
813
+ "output_required": true,
812
814
  "type": "string",
813
815
  "value_allowed_null": false
814
816
  },
@@ -818,99 +820,99 @@
818
820
  "example": "0",
819
821
  "member": "int64",
820
822
  "name": "ApiAccessPort",
821
- "required": true,
823
+ "output_required": true,
822
824
  "type": "int",
823
825
  "value_allowed_null": false
824
826
  },
825
827
  {
826
828
  "disabled": false,
827
- "document": "If `PasswordStatus` is `unmodifiable`, the old password has not expired, and this field will display its expiration time; otherwise, this field will be empty\nNote: this field may return null, indicating that no valid values can be obtained.",
829
+ "document": "If the value of PasswordStatus is unmodifiable, it indicates that the old password has not expired. This field will display the expiration time of the old password; otherwise, the value is null.",
828
830
  "example": "0",
829
831
  "member": "string",
830
832
  "name": "OldPasswordExpireTime",
831
- "required": true,
833
+ "output_required": false,
832
834
  "type": "string",
833
- "value_allowed_null": true
835
+ "value_allowed_null": false
834
836
  },
835
837
  {
836
838
  "disabled": false,
837
- "document": "TcaplusDB SDK connection parameter for accessing IPv6 addresses\nNote: this field may return null, indicating that no valid values can be obtained.",
839
+ "document": "TencentDB for TcaplusDB (TcaplusDB) SDK connection parameters, which are used to access the IPv6 address.",
838
840
  "example": "0",
839
841
  "member": "string",
840
842
  "name": "ApiAccessIpv6",
841
- "required": true,
843
+ "output_required": false,
842
844
  "type": "string",
843
- "value_allowed_null": true
845
+ "value_allowed_null": false
844
846
  },
845
847
  {
846
848
  "disabled": false,
847
- "document": "Cluster type. Valid values: `0` and `1` (shared cluster), `2` (dedicated cluster).\nNote: This field may return null, indicating that no valid values can be obtained.",
849
+ "document": "Cluster type. 0,1: shared cluster; 2: independent cluster.",
848
850
  "example": "0",
849
851
  "member": "int64",
850
852
  "name": "ClusterType",
851
- "required": true,
853
+ "output_required": false,
852
854
  "type": "int",
853
- "value_allowed_null": true
855
+ "value_allowed_null": false
854
856
  },
855
857
  {
856
858
  "disabled": false,
857
- "document": "Cluster status. Valid values: `0` (Running), `1` (Isolated. This status is caused by overdue payments), `2` (To be repossessed. This status is caused when the cluster is actively deleted.),·`3` (To be released. The resources occupied by the table can be released in this status.), `4` (Modifying).\nNote: This field may return null, indicating that no valid values can be obtained.",
859
+ "document": "Cluster status. 0: indicates normal operation; 1: indicates frozen isolation (usually due to arrears); 2: indicates to be recycled (usually when the user proactively triggers deletion); 3: pending release (indicating that resources occupied by this table can be released); 4: changing.",
858
860
  "example": "0",
859
861
  "member": "int64",
860
862
  "name": "ClusterStatus",
861
- "required": true,
863
+ "output_required": false,
862
864
  "type": "int",
863
- "value_allowed_null": true
865
+ "value_allowed_null": false
864
866
  },
865
867
  {
866
868
  "disabled": false,
867
- "document": "Read CU\nNote: this field may return `null`, indicating that no valid values can be obtained.",
869
+ "document": "Read CU.",
868
870
  "example": "0",
869
871
  "member": "int64",
870
872
  "name": "ReadCapacityUnit",
871
- "required": true,
873
+ "output_required": false,
872
874
  "type": "int",
873
- "value_allowed_null": true
875
+ "value_allowed_null": false
874
876
  },
875
877
  {
876
878
  "disabled": false,
877
- "document": "Write CU\nNote: this field may return `null`, indicating that no valid values can be obtained.",
879
+ "document": "Write CU.",
878
880
  "example": "0",
879
881
  "member": "int64",
880
882
  "name": "WriteCapacityUnit",
881
- "required": true,
883
+ "output_required": false,
882
884
  "type": "int",
883
- "value_allowed_null": true
885
+ "value_allowed_null": false
884
886
  },
885
887
  {
886
888
  "disabled": false,
887
- "document": "Disk capacity\nNote: this field may return `null`, indicating that no valid values can be obtained.",
889
+ "document": "Disk capacity.",
888
890
  "example": "0",
889
891
  "member": "int64",
890
892
  "name": "DiskVolume",
891
- "required": true,
893
+ "output_required": false,
892
894
  "type": "int",
893
- "value_allowed_null": true
895
+ "value_allowed_null": false
894
896
  },
895
897
  {
896
898
  "disabled": false,
897
- "document": "Information of the machine at the storage layer (tcapsvr) in a dedicated cluster\nNote: this field may return `null`, indicating that no valid values can be obtained.",
898
- "example": "0",
899
+ "document": "Information about the dedicated server.",
900
+ "example": "无",
899
901
  "member": "ServerDetailInfo",
900
902
  "name": "ServerList",
901
- "required": true,
903
+ "output_required": false,
902
904
  "type": "list",
903
- "value_allowed_null": true
905
+ "value_allowed_null": false
904
906
  },
905
907
  {
906
908
  "disabled": false,
907
- "document": "Information of the machine at the access layer (tcaproxy) in a dedicated cluster\nNote: this field may return `null`, indicating that no valid values can be obtained.",
908
- "example": "0",
909
+ "document": "Information about the dedicated proxy server.",
910
+ "example": "无",
909
911
  "member": "ProxyDetailInfo",
910
912
  "name": "ProxyList",
911
- "required": true,
913
+ "output_required": false,
912
914
  "type": "list",
913
- "value_allowed_null": true
915
+ "value_allowed_null": false
914
916
  },
915
917
  {
916
918
  "disabled": false,
@@ -918,79 +920,99 @@
918
920
  "example": "0",
919
921
  "member": "int64",
920
922
  "name": "Censorship",
921
- "required": true,
923
+ "output_required": true,
922
924
  "type": "int",
923
925
  "value_allowed_null": false
924
926
  },
925
927
  {
926
928
  "disabled": false,
927
- "document": "Approver UIN list\nNote: `null` may be returned for this field, indicating that no valid values can be obtained.",
928
- "example": "0",
929
+ "document": "Approver UIN list.",
930
+ "example": "[\"name\"]",
929
931
  "member": "string",
930
932
  "name": "DbaUins",
931
- "required": true,
933
+ "output_required": false,
932
934
  "type": "list",
933
- "value_allowed_null": true
935
+ "value_allowed_null": false
934
936
  },
935
937
  {
936
938
  "disabled": false,
937
- "document": "Whether data subscription is enabled\nNote: this field may return `null`, indicating that no valid values can be obtained.",
939
+ "document": "Whether data subscription is enabled.",
938
940
  "example": "0",
939
941
  "member": "int64",
940
942
  "name": "DataFlowStatus",
941
- "required": true,
943
+ "output_required": false,
942
944
  "type": "int",
943
- "value_allowed_null": true
945
+ "value_allowed_null": false
944
946
  },
945
947
  {
946
948
  "disabled": false,
947
- "document": "CKafka information when data subscription is enabled\nNote: this field may return `null`, indicating that no valid values can be obtained.",
949
+ "document": "Kafka information for data subscription.",
948
950
  "example": "无",
949
951
  "member": "KafkaInfo",
950
952
  "name": "KafkaInfo",
951
- "required": true,
953
+ "output_required": false,
952
954
  "type": "object",
953
- "value_allowed_null": true
955
+ "value_allowed_null": false
954
956
  },
955
957
  {
956
958
  "disabled": false,
957
- "document": "The number of days after which the cluster Txh backup file will expire and be deleted.\nNote: This field may return `null`, indicating that no valid values can be obtained.",
959
+ "document": "Retention period for the Txh backup file of the cluster before expiration and deletion.",
958
960
  "example": "0",
959
961
  "member": "uint64",
960
962
  "name": "TxhBackupExpireDay",
961
- "required": true,
963
+ "output_required": false,
962
964
  "type": "int",
963
- "value_allowed_null": true
965
+ "value_allowed_null": false
964
966
  },
965
967
  {
966
968
  "disabled": false,
967
- "document": "The number of days after which the cluster Ulog backup file will expire and be deleted.\nNote: This field may return `null`, indicating that no valid values can be obtained.",
969
+ "document": "Retention period for the Ulog backup file of the cluster before expiration and deletion.",
968
970
  "example": "0",
969
971
  "member": "uint64",
970
972
  "name": "UlogBackupExpireDay",
971
- "required": true,
973
+ "output_required": false,
972
974
  "type": "int",
973
- "value_allowed_null": true
975
+ "value_allowed_null": false
974
976
  },
975
977
  {
976
978
  "disabled": false,
977
- "document": "Whether the expiration policy of cluster Ulog backup file is read-only. `0`: Yes; `1`: No.\nNote: This field may return `null`, indicating that no valid values can be obtained.",
979
+ "document": "Whether the expiration policy for the Ulog backup file of the cluster is read-only. 0: UlogBackupExpire is read-only and cannot be modified; 1: UlogBackupExpire can be modified.",
978
980
  "example": "0",
979
981
  "member": "uint64",
980
982
  "name": "IsReadOnlyUlogBackupExpireDay",
981
- "required": true,
983
+ "output_required": false,
982
984
  "type": "int",
983
- "value_allowed_null": true
985
+ "value_allowed_null": false
984
986
  },
985
987
  {
986
988
  "disabled": false,
987
- "document": "restproxy Status\nNote: This field may return null, indicating that no valid values can be obtained.",
989
+ "document": "restproxy status.",
988
990
  "example": "0",
989
991
  "member": "int64",
990
992
  "name": "RestProxyStatus",
991
- "required": true,
993
+ "output_required": false,
992
994
  "type": "int",
993
- "value_allowed_null": true
995
+ "value_allowed_null": false
996
+ },
997
+ {
998
+ "disabled": false,
999
+ "document": "Total number of shards in the cluster.",
1000
+ "example": "0",
1001
+ "member": "int64",
1002
+ "name": "ShardTotalNum",
1003
+ "output_required": false,
1004
+ "type": "int",
1005
+ "value_allowed_null": false
1006
+ },
1007
+ {
1008
+ "disabled": false,
1009
+ "document": "Total number of used shards.",
1010
+ "example": "0",
1011
+ "member": "int64",
1012
+ "name": "ShardUsedNum",
1013
+ "output_required": false,
1014
+ "type": "int",
1015
+ "value_allowed_null": false
994
1016
  }
995
1017
  ],
996
1018
  "usage": "out"
@@ -1001,7 +1023,7 @@
1001
1023
  {
1002
1024
  "disabled": false,
1003
1025
  "document": "ID of the cluster where the table to be modified resides",
1004
- "example": "",
1026
+ "example": "187676",
1005
1027
  "member": "string",
1006
1028
  "name": "ClusterId",
1007
1029
  "required": true,
@@ -1010,7 +1032,7 @@
1010
1032
  {
1011
1033
  "disabled": false,
1012
1034
  "document": "List of tables to be modified",
1013
- "example": "",
1035
+ "example": "{}",
1014
1036
  "member": "SelectedTableInfoNew",
1015
1037
  "name": "SelectedTables",
1016
1038
  "required": true,
@@ -1019,7 +1041,7 @@
1019
1041
  {
1020
1042
  "disabled": false,
1021
1043
  "document": "Selected list of uploaded IDL files. Either this parameter or `NewIdlFiles` must be selected",
1022
- "example": "",
1044
+ "example": "{}",
1023
1045
  "member": "IdlFileInfo",
1024
1046
  "name": "ExistingIdlFiles",
1025
1047
  "required": false,
@@ -1028,7 +1050,7 @@
1028
1050
  {
1029
1051
  "disabled": false,
1030
1052
  "document": "List of IDL files to be uploaded. Either this parameter or `ExistingIdlFiles` must be selected",
1031
- "example": "",
1053
+ "example": "{}",
1032
1054
  "member": "IdlFileInfo",
1033
1055
  "name": "NewIdlFiles",
1034
1056
  "required": false,
@@ -1043,27 +1065,30 @@
1043
1065
  {
1044
1066
  "disabled": false,
1045
1067
  "document": "Information list of all IDL files uploaded and verified in this request",
1046
- "example": "",
1068
+ "example": "{}",
1047
1069
  "member": "IdlFileInfo",
1048
1070
  "name": "IdlFiles",
1071
+ "output_required": true,
1049
1072
  "type": "list",
1050
1073
  "value_allowed_null": false
1051
1074
  },
1052
1075
  {
1053
1076
  "disabled": false,
1054
1077
  "document": "Number of tables verified to be valid in this request",
1055
- "example": "",
1078
+ "example": "10",
1056
1079
  "member": "uint64",
1057
1080
  "name": "TotalCount",
1081
+ "output_required": true,
1058
1082
  "type": "int",
1059
1083
  "value_allowed_null": false
1060
1084
  },
1061
1085
  {
1062
1086
  "disabled": false,
1063
1087
  "document": "Verification result parsed from the selected table after the IDL description file is read",
1064
- "example": "",
1088
+ "example": "{}",
1065
1089
  "member": "ParsedTableInfoNew",
1066
1090
  "name": "TableInfos",
1091
+ "output_required": true,
1067
1092
  "type": "list",
1068
1093
  "value_allowed_null": false
1069
1094
  },
@@ -1082,80 +1107,88 @@
1082
1107
  {
1083
1108
  "disabled": false,
1084
1109
  "document": "Cluster ID of the source table",
1085
- "example": "",
1110
+ "example": "75685",
1086
1111
  "member": "string",
1087
1112
  "name": "SrcTableClusterId",
1088
- "required": true,
1113
+ "output_required": false,
1114
+ "required": false,
1089
1115
  "type": "string",
1090
1116
  "value_allowed_null": false
1091
1117
  },
1092
1118
  {
1093
1119
  "disabled": false,
1094
1120
  "document": "Table group ID of the source table",
1095
- "example": "",
1121
+ "example": "18755",
1096
1122
  "member": "string",
1097
1123
  "name": "SrcTableGroupId",
1098
- "required": true,
1124
+ "output_required": false,
1125
+ "required": false,
1099
1126
  "type": "string",
1100
1127
  "value_allowed_null": false
1101
1128
  },
1102
1129
  {
1103
1130
  "disabled": false,
1104
1131
  "document": "Source table name",
1105
- "example": "",
1132
+ "example": "srcname",
1106
1133
  "member": "string",
1107
1134
  "name": "SrcTableName",
1108
- "required": true,
1135
+ "output_required": false,
1136
+ "required": false,
1109
1137
  "type": "string",
1110
1138
  "value_allowed_null": false
1111
1139
  },
1112
1140
  {
1113
1141
  "disabled": false,
1114
1142
  "document": "Cluster ID of the target table",
1115
- "example": "",
1143
+ "example": "75685",
1116
1144
  "member": "string",
1117
1145
  "name": "DstTableClusterId",
1118
- "required": true,
1146
+ "output_required": false,
1147
+ "required": false,
1119
1148
  "type": "string",
1120
1149
  "value_allowed_null": false
1121
1150
  },
1122
1151
  {
1123
1152
  "disabled": false,
1124
1153
  "document": "Table group ID of the target table",
1125
- "example": "",
1154
+ "example": "18755",
1126
1155
  "member": "string",
1127
1156
  "name": "DstTableGroupId",
1128
- "required": true,
1157
+ "output_required": false,
1158
+ "required": false,
1129
1159
  "type": "string",
1130
1160
  "value_allowed_null": false
1131
1161
  },
1132
1162
  {
1133
1163
  "disabled": false,
1134
1164
  "document": "Target table name",
1135
- "example": "",
1165
+ "example": "dstname",
1136
1166
  "member": "string",
1137
1167
  "name": "DstTableName",
1138
- "required": true,
1168
+ "output_required": false,
1169
+ "required": false,
1139
1170
  "type": "string",
1140
1171
  "value_allowed_null": false
1141
1172
  },
1142
1173
  {
1143
1174
  "disabled": false,
1144
1175
  "document": "Source table ID",
1145
- "example": "",
1176
+ "example": "tcap-1232",
1146
1177
  "member": "string",
1147
1178
  "name": "SrcTableInstanceId",
1148
- "required": true,
1179
+ "output_required": false,
1180
+ "required": false,
1149
1181
  "type": "string",
1150
1182
  "value_allowed_null": false
1151
1183
  },
1152
1184
  {
1153
1185
  "disabled": false,
1154
1186
  "document": "Target table ID",
1155
- "example": "",
1187
+ "example": "tcap-2586",
1156
1188
  "member": "string",
1157
1189
  "name": "DstTableInstanceId",
1158
- "required": true,
1190
+ "output_required": false,
1191
+ "required": false,
1159
1192
  "type": "string",
1160
1193
  "value_allowed_null": false
1161
1194
  }
@@ -1168,7 +1201,7 @@
1168
1201
  {
1169
1202
  "disabled": false,
1170
1203
  "document": "ID of the cluster where the table to be backed up resides",
1171
- "example": "",
1204
+ "example": "0",
1172
1205
  "member": "string",
1173
1206
  "name": "ClusterId",
1174
1207
  "required": true,
@@ -1177,7 +1210,7 @@
1177
1210
  {
1178
1211
  "disabled": false,
1179
1212
  "document": "Information list of tables to be backed up",
1180
- "example": "",
1213
+ "example": "0",
1181
1214
  "member": "SelectedTableInfoNew",
1182
1215
  "name": "SelectedTables",
1183
1216
  "required": true,
@@ -1186,7 +1219,7 @@
1186
1219
  {
1187
1220
  "disabled": false,
1188
1221
  "document": "Remarks",
1189
- "example": "",
1222
+ "example": "0",
1190
1223
  "member": "string",
1191
1224
  "name": "Remark",
1192
1225
  "required": false,
@@ -1204,9 +1237,9 @@
1204
1237
  "example": "0",
1205
1238
  "member": "string",
1206
1239
  "name": "TaskIds",
1207
- "required": true,
1240
+ "output_required": false,
1208
1241
  "type": "list",
1209
- "value_allowed_null": true
1242
+ "value_allowed_null": false
1210
1243
  },
1211
1244
  {
1212
1245
  "disabled": false,
@@ -1214,9 +1247,9 @@
1214
1247
  "example": "0",
1215
1248
  "member": "string",
1216
1249
  "name": "ApplicationIds",
1217
- "required": true,
1250
+ "output_required": false,
1218
1251
  "type": "list",
1219
- "value_allowed_null": true
1252
+ "value_allowed_null": false
1220
1253
  },
1221
1254
  {
1222
1255
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
@@ -1338,9 +1371,10 @@
1338
1371
  {
1339
1372
  "disabled": false,
1340
1373
  "document": "Cluster ID",
1341
- "example": "",
1374
+ "example": "6179109757",
1342
1375
  "member": "string",
1343
1376
  "name": "ClusterId",
1377
+ "required": true,
1344
1378
  "type": "string",
1345
1379
  "value_allowed_null": false
1346
1380
  },
@@ -1368,7 +1402,7 @@
1368
1402
  {
1369
1403
  "disabled": false,
1370
1404
  "document": "Snapshot list",
1371
- "example": "无",
1405
+ "example": "{}",
1372
1406
  "member": "SnapshotInfo",
1373
1407
  "name": "SelectedTables",
1374
1408
  "required": true,
@@ -1386,17 +1420,17 @@
1386
1420
  "example": "1",
1387
1421
  "member": "uint64",
1388
1422
  "name": "TotalCount",
1389
- "required": true,
1423
+ "output_required": true,
1390
1424
  "type": "int",
1391
1425
  "value_allowed_null": false
1392
1426
  },
1393
1427
  {
1394
1428
  "disabled": false,
1395
1429
  "document": "The result list of snapshots created in batches",
1396
- "example": "无",
1430
+ "example": "{}",
1397
1431
  "member": "SnapshotResult",
1398
1432
  "name": "TableResults",
1399
- "required": true,
1433
+ "output_required": true,
1400
1434
  "type": "list",
1401
1435
  "value_allowed_null": false
1402
1436
  },
@@ -1415,7 +1449,7 @@
1415
1449
  {
1416
1450
  "disabled": false,
1417
1451
  "document": "ID of the cluster where a table group resides",
1418
- "example": "",
1452
+ "example": "18744",
1419
1453
  "member": "string",
1420
1454
  "name": "ClusterId",
1421
1455
  "required": true,
@@ -1424,7 +1458,7 @@
1424
1458
  {
1425
1459
  "disabled": false,
1426
1460
  "document": "Table group name, which can contain up to 32 letters and digits",
1427
- "example": "",
1461
+ "example": "groupname",
1428
1462
  "member": "string",
1429
1463
  "name": "TableGroupName",
1430
1464
  "required": true,
@@ -1433,7 +1467,7 @@
1433
1467
  {
1434
1468
  "disabled": false,
1435
1469
  "document": "Table group ID, which can be customized but must be unique in one cluster. If it is not specified, the auto-increment mode will be used.",
1436
- "example": "",
1470
+ "example": "17565",
1437
1471
  "member": "string",
1438
1472
  "name": "TableGroupId",
1439
1473
  "required": false,
@@ -1442,7 +1476,7 @@
1442
1476
  {
1443
1477
  "disabled": false,
1444
1478
  "document": "Table group tag list",
1445
- "example": "",
1479
+ "example": "{}",
1446
1480
  "member": "TagInfoUnit",
1447
1481
  "name": "ResourceTags",
1448
1482
  "required": false,
@@ -1457,9 +1491,10 @@
1457
1491
  {
1458
1492
  "disabled": false,
1459
1493
  "document": "ID of table group successfully created",
1460
- "example": "",
1494
+ "example": "167556",
1461
1495
  "member": "string",
1462
1496
  "name": "TableGroupId",
1497
+ "output_required": true,
1463
1498
  "type": "string",
1464
1499
  "value_allowed_null": false
1465
1500
  },
@@ -1478,7 +1513,7 @@
1478
1513
  {
1479
1514
  "disabled": false,
1480
1515
  "document": "ID of the cluster where to create a table",
1481
- "example": "",
1516
+ "example": " 123",
1482
1517
  "member": "string",
1483
1518
  "name": "ClusterId",
1484
1519
  "required": true,
@@ -1487,7 +1522,7 @@
1487
1522
  {
1488
1523
  "disabled": false,
1489
1524
  "document": "Table creation IDL file list selected by user",
1490
- "example": "",
1525
+ "example": " {}",
1491
1526
  "member": "IdlFileInfo",
1492
1527
  "name": "IdlFiles",
1493
1528
  "required": true,
@@ -1496,7 +1531,7 @@
1496
1531
  {
1497
1532
  "disabled": false,
1498
1533
  "document": "Information list of tables to be created",
1499
- "example": "",
1534
+ "example": "{}",
1500
1535
  "member": "SelectedTableInfoNew",
1501
1536
  "name": "SelectedTables",
1502
1537
  "required": true,
@@ -1505,7 +1540,7 @@
1505
1540
  {
1506
1541
  "disabled": false,
1507
1542
  "document": "Table tag list",
1508
- "example": "",
1543
+ "example": "{}",
1509
1544
  "member": "TagInfoUnit",
1510
1545
  "name": "ResourceTags",
1511
1546
  "required": false,
@@ -1520,18 +1555,20 @@
1520
1555
  {
1521
1556
  "disabled": false,
1522
1557
  "document": "Number of tables created in batches",
1523
- "example": "",
1558
+ "example": "0",
1524
1559
  "member": "uint64",
1525
1560
  "name": "TotalCount",
1561
+ "output_required": true,
1526
1562
  "type": "int",
1527
1563
  "value_allowed_null": false
1528
1564
  },
1529
1565
  {
1530
1566
  "disabled": false,
1531
1567
  "document": "List of tables created in batches",
1532
- "example": "",
1568
+ "example": "null",
1533
1569
  "member": "TableResultNew",
1534
1570
  "name": "TableResults",
1571
+ "output_required": true,
1535
1572
  "type": "list",
1536
1573
  "value_allowed_null": false
1537
1574
  },
@@ -1577,9 +1614,9 @@
1577
1614
  "example": "1",
1578
1615
  "member": "string",
1579
1616
  "name": "TaskId",
1580
- "required": true,
1617
+ "output_required": false,
1581
1618
  "type": "string",
1582
- "value_allowed_null": true
1619
+ "value_allowed_null": false
1583
1620
  },
1584
1621
  {
1585
1622
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
@@ -1596,7 +1633,7 @@
1596
1633
  {
1597
1634
  "disabled": false,
1598
1635
  "document": "ID of cluster to be deleted",
1599
- "example": "",
1636
+ "example": "18767",
1600
1637
  "member": "string",
1601
1638
  "name": "ClusterId",
1602
1639
  "required": true,
@@ -1611,9 +1648,10 @@
1611
1648
  {
1612
1649
  "disabled": false,
1613
1650
  "document": "Task ID generated by cluster deletion",
1614
- "example": "",
1651
+ "example": "17454",
1615
1652
  "member": "string",
1616
1653
  "name": "TaskId",
1654
+ "output_required": true,
1617
1655
  "type": "string",
1618
1656
  "value_allowed_null": false
1619
1657
  },
@@ -1632,7 +1670,7 @@
1632
1670
  {
1633
1671
  "disabled": false,
1634
1672
  "document": "ID of the cluster where IDL resides",
1635
- "example": "",
1673
+ "example": "187656",
1636
1674
  "member": "string",
1637
1675
  "name": "ClusterId",
1638
1676
  "required": true,
@@ -1641,7 +1679,7 @@
1641
1679
  {
1642
1680
  "disabled": false,
1643
1681
  "document": "List of information of IDL files to be deleted",
1644
- "example": "",
1682
+ "example": "{}",
1645
1683
  "member": "IdlFileInfo",
1646
1684
  "name": "IdlFiles",
1647
1685
  "required": true,
@@ -1656,18 +1694,20 @@
1656
1694
  {
1657
1695
  "disabled": false,
1658
1696
  "document": "Number of returned results",
1659
- "example": "",
1697
+ "example": "10",
1660
1698
  "member": "uint64",
1661
1699
  "name": "TotalCount",
1700
+ "output_required": true,
1662
1701
  "type": "int",
1663
1702
  "value_allowed_null": false
1664
1703
  },
1665
1704
  {
1666
1705
  "disabled": false,
1667
1706
  "document": "Deletion result",
1668
- "example": "",
1707
+ "example": "{}",
1669
1708
  "member": "IdlFileInfoWithoutContent",
1670
1709
  "name": "IdlFileInfos",
1710
+ "output_required": true,
1671
1711
  "type": "list",
1672
1712
  "value_allowed_null": false
1673
1713
  },
@@ -1695,7 +1735,7 @@
1695
1735
  {
1696
1736
  "disabled": false,
1697
1737
  "document": "The list of snapshots to delete",
1698
- "example": "无",
1738
+ "example": "{}",
1699
1739
  "member": "SnapshotInfoNew",
1700
1740
  "name": "SelectedTables",
1701
1741
  "required": true,
@@ -1713,17 +1753,17 @@
1713
1753
  "example": "1",
1714
1754
  "member": "uint64",
1715
1755
  "name": "TotalCount",
1716
- "required": true,
1756
+ "output_required": true,
1717
1757
  "type": "int",
1718
1758
  "value_allowed_null": false
1719
1759
  },
1720
1760
  {
1721
1761
  "disabled": false,
1722
1762
  "document": "The result list of snapshots deleted in batches",
1723
- "example": "无",
1763
+ "example": "{}",
1724
1764
  "member": "SnapshotResult",
1725
1765
  "name": "TableResults",
1726
- "required": true,
1766
+ "output_required": true,
1727
1767
  "type": "list",
1728
1768
  "value_allowed_null": false
1729
1769
  },
@@ -1769,7 +1809,7 @@
1769
1809
  "example": "1",
1770
1810
  "member": "uint64",
1771
1811
  "name": "TotalCount",
1772
- "required": true,
1812
+ "output_required": true,
1773
1813
  "type": "int",
1774
1814
  "value_allowed_null": false
1775
1815
  },
@@ -1779,7 +1819,7 @@
1779
1819
  "example": "无",
1780
1820
  "member": "TableResultNew",
1781
1821
  "name": "TableResults",
1782
- "required": true,
1822
+ "output_required": true,
1783
1823
  "type": "list",
1784
1824
  "value_allowed_null": false
1785
1825
  },
@@ -1798,7 +1838,7 @@
1798
1838
  {
1799
1839
  "disabled": false,
1800
1840
  "document": "ID of the cluster where a table group resides",
1801
- "example": "",
1841
+ "example": "17568",
1802
1842
  "member": "string",
1803
1843
  "name": "ClusterId",
1804
1844
  "required": true,
@@ -1807,7 +1847,7 @@
1807
1847
  {
1808
1848
  "disabled": false,
1809
1849
  "document": "Table group ID",
1810
- "example": "",
1850
+ "example": "14234",
1811
1851
  "member": "string",
1812
1852
  "name": "TableGroupId",
1813
1853
  "required": true,
@@ -1822,9 +1862,10 @@
1822
1862
  {
1823
1863
  "disabled": false,
1824
1864
  "document": "Task ID generated by table group deletion",
1825
- "example": "",
1865
+ "example": "18767865",
1826
1866
  "member": "string",
1827
1867
  "name": "TaskId",
1868
+ "output_required": true,
1828
1869
  "type": "string",
1829
1870
  "value_allowed_null": false
1830
1871
  },
@@ -1843,7 +1884,7 @@
1843
1884
  {
1844
1885
  "disabled": false,
1845
1886
  "document": "ID of the cluster where the table resides",
1846
- "example": "",
1887
+ "example": "897858",
1847
1888
  "member": "string",
1848
1889
  "name": "ClusterId",
1849
1890
  "required": true,
@@ -1852,7 +1893,7 @@
1852
1893
  {
1853
1894
  "disabled": false,
1854
1895
  "document": "The list of tables whose global indexes need to be deleted",
1855
- "example": "",
1896
+ "example": "{}",
1856
1897
  "member": "SelectedTableInfoNew",
1857
1898
  "name": "SelectedTables",
1858
1899
  "required": true,
@@ -1867,18 +1908,20 @@
1867
1908
  {
1868
1909
  "disabled": false,
1869
1910
  "document": "The number of tables whose global indexes are deleted",
1870
- "example": "",
1911
+ "example": "0",
1871
1912
  "member": "uint64",
1872
1913
  "name": "TotalCount",
1914
+ "output_required": true,
1873
1915
  "type": "int",
1874
1916
  "value_allowed_null": false
1875
1917
  },
1876
1918
  {
1877
1919
  "disabled": false,
1878
1920
  "document": "The list of global index deletion results",
1879
- "example": "",
1921
+ "example": "{}",
1880
1922
  "member": "TableResultNew",
1881
1923
  "name": "TableResults",
1924
+ "output_required": true,
1882
1925
  "type": "list",
1883
1926
  "value_allowed_null": false
1884
1927
  },
@@ -1897,7 +1940,7 @@
1897
1940
  {
1898
1941
  "disabled": false,
1899
1942
  "document": "ID of the cluster where the table to be dropped resides",
1900
- "example": "",
1943
+ "example": "8978978",
1901
1944
  "member": "string",
1902
1945
  "name": "ClusterId",
1903
1946
  "required": true,
@@ -1906,7 +1949,7 @@
1906
1949
  {
1907
1950
  "disabled": false,
1908
1951
  "document": "List of information of tables to be dropped",
1909
- "example": "",
1952
+ "example": "{}",
1910
1953
  "member": "SelectedTableInfoNew",
1911
1954
  "name": "SelectedTables",
1912
1955
  "required": true,
@@ -1921,18 +1964,20 @@
1921
1964
  {
1922
1965
  "disabled": false,
1923
1966
  "document": "Number of dropped tables",
1924
- "example": "",
1967
+ "example": "0",
1925
1968
  "member": "uint64",
1926
1969
  "name": "TotalCount",
1970
+ "output_required": true,
1927
1971
  "type": "int",
1928
1972
  "value_allowed_null": false
1929
1973
  },
1930
1974
  {
1931
1975
  "disabled": false,
1932
1976
  "document": "List of details of dropped tables",
1933
- "example": "",
1977
+ "example": "{}",
1934
1978
  "member": "TableResultNew",
1935
1979
  "name": "TableResults",
1980
+ "output_required": true,
1936
1981
  "type": "list",
1937
1982
  "value_allowed_null": false
1938
1983
  },
@@ -1978,7 +2023,7 @@
1978
2023
  {
1979
2024
  "disabled": false,
1980
2025
  "document": "Table group ID used as a filter condition",
1981
- "example": "xx",
2026
+ "example": "7867",
1982
2027
  "member": "string",
1983
2028
  "name": "TableGroupId",
1984
2029
  "required": false,
@@ -1987,7 +2032,7 @@
1987
2032
  {
1988
2033
  "disabled": false,
1989
2034
  "document": "Table name used as a filter condition",
1990
- "example": "xx",
2035
+ "example": "testname",
1991
2036
  "member": "string",
1992
2037
  "name": "TableName",
1993
2038
  "required": false,
@@ -2005,7 +2050,7 @@
2005
2050
  "example": "无",
2006
2051
  "member": "BackupRecords",
2007
2052
  "name": "BackupRecords",
2008
- "required": true,
2053
+ "output_required": true,
2009
2054
  "type": "list",
2010
2055
  "value_allowed_null": false
2011
2056
  },
@@ -2015,7 +2060,7 @@
2015
2060
  "example": "92",
2016
2061
  "member": "int64",
2017
2062
  "name": "TotalCount",
2018
- "required": true,
2063
+ "output_required": true,
2019
2064
  "type": "int",
2020
2065
  "value_allowed_null": false
2021
2066
  },
@@ -2034,7 +2079,7 @@
2034
2079
  {
2035
2080
  "disabled": false,
2036
2081
  "document": "The list of cluster IDs",
2037
- "example": "",
2082
+ "example": "879789",
2038
2083
  "member": "string",
2039
2084
  "name": "ClusterIds",
2040
2085
  "required": true,
@@ -2049,20 +2094,22 @@
2049
2094
  {
2050
2095
  "disabled": false,
2051
2096
  "document": "The information list of cluster tags",
2052
- "example": "",
2097
+ "example": "0",
2053
2098
  "member": "TagsInfoOfCluster",
2054
2099
  "name": "Rows",
2100
+ "output_required": false,
2055
2101
  "type": "list",
2056
- "value_allowed_null": true
2102
+ "value_allowed_null": false
2057
2103
  },
2058
2104
  {
2059
2105
  "disabled": false,
2060
2106
  "document": "The number of returned results",
2061
- "example": "",
2107
+ "example": "0",
2062
2108
  "member": "int64",
2063
2109
  "name": "TotalCount",
2110
+ "output_required": false,
2064
2111
  "type": "int",
2065
- "value_allowed_null": true
2112
+ "value_allowed_null": false
2066
2113
  },
2067
2114
  {
2068
2115
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
@@ -2079,7 +2126,7 @@
2079
2126
  {
2080
2127
  "disabled": false,
2081
2128
  "document": "List of IDs of clusters to be queried",
2082
- "example": "",
2129
+ "example": "10001",
2083
2130
  "member": "string",
2084
2131
  "name": "ClusterIds",
2085
2132
  "required": false,
@@ -2088,7 +2135,7 @@
2088
2135
  {
2089
2136
  "disabled": false,
2090
2137
  "document": "Query filter",
2091
- "example": "",
2138
+ "example": "{}",
2092
2139
  "member": "Filter",
2093
2140
  "name": "Filters",
2094
2141
  "required": false,
@@ -2097,7 +2144,7 @@
2097
2144
  {
2098
2145
  "disabled": false,
2099
2146
  "document": "Query list offset",
2100
- "example": "",
2147
+ "example": "0",
2101
2148
  "member": "int64",
2102
2149
  "name": "Offset",
2103
2150
  "required": false,
@@ -2106,7 +2153,7 @@
2106
2153
  {
2107
2154
  "disabled": false,
2108
2155
  "document": "Number of returned results in query list. Default value: 20",
2109
- "example": "",
2156
+ "example": "0",
2110
2157
  "member": "int64",
2111
2158
  "name": "Limit",
2112
2159
  "required": false,
@@ -2115,7 +2162,7 @@
2115
2162
  {
2116
2163
  "disabled": false,
2117
2164
  "document": "Whether to enable IPv6 address access",
2118
- "example": "",
2165
+ "example": "0",
2119
2166
  "member": "int64",
2120
2167
  "name": "Ipv6Enable",
2121
2168
  "required": false,
@@ -2130,18 +2177,20 @@
2130
2177
  {
2131
2178
  "disabled": false,
2132
2179
  "document": "Number of cluster instances",
2133
- "example": "",
2180
+ "example": "2",
2134
2181
  "member": "int64",
2135
2182
  "name": "TotalCount",
2183
+ "output_required": true,
2136
2184
  "type": "int",
2137
2185
  "value_allowed_null": false
2138
2186
  },
2139
2187
  {
2140
2188
  "disabled": false,
2141
2189
  "document": "Cluster instance list",
2142
- "example": "",
2190
+ "example": "{}",
2143
2191
  "member": "ClusterInfo",
2144
2192
  "name": "Clusters",
2193
+ "output_required": true,
2145
2194
  "type": "list",
2146
2195
  "value_allowed_null": false
2147
2196
  },
@@ -2160,7 +2209,7 @@
2160
2209
  {
2161
2210
  "disabled": false,
2162
2211
  "document": "ID of the cluster where a file resides",
2163
- "example": "",
2212
+ "example": "1876767",
2164
2213
  "member": "string",
2165
2214
  "name": "ClusterId",
2166
2215
  "required": true,
@@ -2169,7 +2218,7 @@
2169
2218
  {
2170
2219
  "disabled": false,
2171
2220
  "document": "ID of the table group where a file resides",
2172
- "example": "",
2221
+ "example": "1214765",
2173
2222
  "member": "string",
2174
2223
  "name": "TableGroupIds",
2175
2224
  "required": false,
@@ -2178,7 +2227,7 @@
2178
2227
  {
2179
2228
  "disabled": false,
2180
2229
  "document": "File ID list",
2181
- "example": "",
2230
+ "example": "testfield",
2182
2231
  "member": "string",
2183
2232
  "name": "IdlFileIds",
2184
2233
  "required": false,
@@ -2187,7 +2236,7 @@
2187
2236
  {
2188
2237
  "disabled": false,
2189
2238
  "document": "Query list offset",
2190
- "example": "",
2239
+ "example": "0",
2191
2240
  "member": "int64",
2192
2241
  "name": "Offset",
2193
2242
  "required": false,
@@ -2196,7 +2245,7 @@
2196
2245
  {
2197
2246
  "disabled": false,
2198
2247
  "document": "Number of returned results in query list",
2199
- "example": "",
2248
+ "example": "10",
2200
2249
  "member": "int64",
2201
2250
  "name": "Limit",
2202
2251
  "required": false,
@@ -2211,18 +2260,20 @@
2211
2260
  {
2212
2261
  "disabled": false,
2213
2262
  "document": "Number of files",
2214
- "example": "",
2263
+ "example": "10",
2215
2264
  "member": "uint64",
2216
2265
  "name": "TotalCount",
2266
+ "output_required": true,
2217
2267
  "type": "int",
2218
2268
  "value_allowed_null": false
2219
2269
  },
2220
2270
  {
2221
2271
  "disabled": false,
2222
2272
  "document": "List of file details",
2223
- "example": "",
2273
+ "example": "{}",
2224
2274
  "member": "IdlFileInfo",
2225
2275
  "name": "IdlFileInfos",
2276
+ "output_required": true,
2226
2277
  "type": "list",
2227
2278
  "value_allowed_null": false
2228
2279
  },
@@ -2241,7 +2292,7 @@
2241
2292
  {
2242
2293
  "disabled": false,
2243
2294
  "document": "If this parameter is not `0`, machines supporting IPv6 will be queried.",
2244
- "example": "",
2295
+ "example": "1",
2245
2296
  "member": "int64",
2246
2297
  "name": "Ipv6Enable",
2247
2298
  "required": false,
@@ -2256,9 +2307,10 @@
2256
2307
  {
2257
2308
  "disabled": false,
2258
2309
  "document": "The list of dedicated machine resources",
2259
- "example": "",
2310
+ "example": "{}",
2260
2311
  "member": "PoolInfo",
2261
2312
  "name": "PoolList",
2313
+ "output_required": true,
2262
2314
  "type": "list",
2263
2315
  "value_allowed_null": false
2264
2316
  },
@@ -2282,18 +2334,20 @@
2282
2334
  {
2283
2335
  "disabled": false,
2284
2336
  "document": "Number of queried AZs",
2285
- "example": "",
2337
+ "example": "10",
2286
2338
  "member": "uint64",
2287
2339
  "name": "TotalCount",
2340
+ "output_required": true,
2288
2341
  "type": "int",
2289
2342
  "value_allowed_null": false
2290
2343
  },
2291
2344
  {
2292
2345
  "disabled": false,
2293
2346
  "document": "List of AZ query results",
2294
- "example": "",
2347
+ "example": "{}",
2295
2348
  "member": "RegionInfo",
2296
2349
  "name": "RegionInfos",
2350
+ "output_required": true,
2297
2351
  "type": "list",
2298
2352
  "value_allowed_null": false
2299
2353
  },
@@ -2348,7 +2402,7 @@
2348
2402
  {
2349
2403
  "disabled": false,
2350
2404
  "document": "The list of snapshots pulled in batches",
2351
- "example": "无",
2405
+ "example": "{}",
2352
2406
  "member": "SelectedTableInfoNew",
2353
2407
  "name": "SelectedTables",
2354
2408
  "required": false,
@@ -2366,17 +2420,17 @@
2366
2420
  "example": "1",
2367
2421
  "member": "uint64",
2368
2422
  "name": "TotalCount",
2369
- "required": true,
2423
+ "output_required": true,
2370
2424
  "type": "int",
2371
2425
  "value_allowed_null": false
2372
2426
  },
2373
2427
  {
2374
2428
  "disabled": false,
2375
2429
  "document": "The result list of snapshots",
2376
- "example": "无",
2430
+ "example": "{}",
2377
2431
  "member": "SnapshotResult",
2378
2432
  "name": "TableResults",
2379
- "required": true,
2433
+ "output_required": true,
2380
2434
  "type": "list",
2381
2435
  "value_allowed_null": false
2382
2436
  },
@@ -2395,7 +2449,7 @@
2395
2449
  {
2396
2450
  "disabled": false,
2397
2451
  "document": "The ID of the cluster where table group tags need to be queried",
2398
- "example": "",
2452
+ "example": "345332",
2399
2453
  "member": "string",
2400
2454
  "name": "ClusterId",
2401
2455
  "required": true,
@@ -2404,7 +2458,7 @@
2404
2458
  {
2405
2459
  "disabled": false,
2406
2460
  "document": "The list of IDs of the table groups whose tags need to be queried",
2407
- "example": "",
2461
+ "example": "435342",
2408
2462
  "member": "string",
2409
2463
  "name": "TableGroupIds",
2410
2464
  "required": true,
@@ -2419,20 +2473,22 @@
2419
2473
  {
2420
2474
  "disabled": false,
2421
2475
  "document": "The information list of table group tags",
2422
- "example": "",
2476
+ "example": "0",
2423
2477
  "member": "TagsInfoOfTableGroup",
2424
2478
  "name": "Rows",
2479
+ "output_required": false,
2425
2480
  "type": "list",
2426
- "value_allowed_null": true
2481
+ "value_allowed_null": false
2427
2482
  },
2428
2483
  {
2429
2484
  "disabled": false,
2430
2485
  "document": "The number of returned results",
2431
- "example": "",
2486
+ "example": "0",
2432
2487
  "member": "int64",
2433
2488
  "name": "TotalCount",
2489
+ "output_required": false,
2434
2490
  "type": "int",
2435
- "value_allowed_null": true
2491
+ "value_allowed_null": false
2436
2492
  },
2437
2493
  {
2438
2494
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
@@ -2449,7 +2505,7 @@
2449
2505
  {
2450
2506
  "disabled": false,
2451
2507
  "document": "ID of the cluster where a table group resides",
2452
- "example": "",
2508
+ "example": "7867686",
2453
2509
  "member": "string",
2454
2510
  "name": "ClusterId",
2455
2511
  "required": true,
@@ -2458,7 +2514,7 @@
2458
2514
  {
2459
2515
  "disabled": false,
2460
2516
  "document": "Table group ID list",
2461
- "example": "",
2517
+ "example": "\"1\"",
2462
2518
  "member": "string",
2463
2519
  "name": "TableGroupIds",
2464
2520
  "required": false,
@@ -2467,7 +2523,7 @@
2467
2523
  {
2468
2524
  "disabled": false,
2469
2525
  "document": "Filter. Valid values: TableGroupName, TableGroupId",
2470
- "example": "",
2526
+ "example": "{}",
2471
2527
  "member": "Filter",
2472
2528
  "name": "Filters",
2473
2529
  "required": false,
@@ -2476,7 +2532,7 @@
2476
2532
  {
2477
2533
  "disabled": false,
2478
2534
  "document": "Query list offset",
2479
- "example": "",
2535
+ "example": "0",
2480
2536
  "member": "int64",
2481
2537
  "name": "Offset",
2482
2538
  "required": false,
@@ -2485,7 +2541,7 @@
2485
2541
  {
2486
2542
  "disabled": false,
2487
2543
  "document": "Number of returned results in query list",
2488
- "example": "",
2544
+ "example": "0",
2489
2545
  "member": "int64",
2490
2546
  "name": "Limit",
2491
2547
  "required": false,
@@ -2500,18 +2556,20 @@
2500
2556
  {
2501
2557
  "disabled": false,
2502
2558
  "document": "Number of table groups",
2503
- "example": "",
2559
+ "example": "0",
2504
2560
  "member": "int64",
2505
2561
  "name": "TotalCount",
2562
+ "output_required": true,
2506
2563
  "type": "int",
2507
2564
  "value_allowed_null": false
2508
2565
  },
2509
2566
  {
2510
2567
  "disabled": false,
2511
2568
  "document": "Table group information list",
2512
- "example": "",
2569
+ "example": "{}",
2513
2570
  "member": "TableGroupInfo",
2514
2571
  "name": "TableGroups",
2572
+ "output_required": true,
2515
2573
  "type": "list",
2516
2574
  "value_allowed_null": false
2517
2575
  },
@@ -2530,7 +2588,7 @@
2530
2588
  {
2531
2589
  "disabled": false,
2532
2590
  "document": "The ID of the cluster where a table resides",
2533
- "example": "",
2591
+ "example": "456546",
2534
2592
  "member": "string",
2535
2593
  "name": "ClusterId",
2536
2594
  "required": true,
@@ -2539,7 +2597,7 @@
2539
2597
  {
2540
2598
  "disabled": false,
2541
2599
  "document": "Table list",
2542
- "example": "",
2600
+ "example": "{}",
2543
2601
  "member": "SelectedTableInfoNew",
2544
2602
  "name": "SelectedTables",
2545
2603
  "required": true,
@@ -2554,18 +2612,20 @@
2554
2612
  {
2555
2613
  "disabled": false,
2556
2614
  "document": "The total number of returned results",
2557
- "example": "",
2615
+ "example": "0",
2558
2616
  "member": "int64",
2559
2617
  "name": "TotalCount",
2618
+ "output_required": true,
2560
2619
  "type": "int",
2561
2620
  "value_allowed_null": false
2562
2621
  },
2563
2622
  {
2564
2623
  "disabled": false,
2565
2624
  "document": "The information list of table tags",
2566
- "example": "",
2625
+ "example": "0",
2567
2626
  "member": "TagsInfoOfTable",
2568
2627
  "name": "Rows",
2628
+ "output_required": true,
2569
2629
  "type": "list",
2570
2630
  "value_allowed_null": false
2571
2631
  },
@@ -2584,7 +2644,7 @@
2584
2644
  {
2585
2645
  "disabled": false,
2586
2646
  "document": "ID of the cluster where the table to be queried resides",
2587
- "example": "",
2647
+ "example": "5456454",
2588
2648
  "member": "string",
2589
2649
  "name": "ClusterId",
2590
2650
  "required": false,
@@ -2593,7 +2653,7 @@
2593
2653
  {
2594
2654
  "disabled": false,
2595
2655
  "document": "List of IDs of the table groups where the table to be queried resides",
2596
- "example": "",
2656
+ "example": "13755",
2597
2657
  "member": "string",
2598
2658
  "name": "TableGroupIds",
2599
2659
  "required": false,
@@ -2602,7 +2662,7 @@
2602
2662
  {
2603
2663
  "disabled": false,
2604
2664
  "document": "Filter. Valid values: TableName, TableInstanceId",
2605
- "example": "",
2665
+ "example": "{}",
2606
2666
  "member": "Filter",
2607
2667
  "name": "Filters",
2608
2668
  "required": false,
@@ -2611,7 +2671,7 @@
2611
2671
  {
2612
2672
  "disabled": false,
2613
2673
  "document": "Query result offset",
2614
- "example": "",
2674
+ "example": "0",
2615
2675
  "member": "int64",
2616
2676
  "name": "Offset",
2617
2677
  "required": false,
@@ -2620,7 +2680,7 @@
2620
2680
  {
2621
2681
  "disabled": false,
2622
2682
  "document": "Number of returned query results",
2623
- "example": "",
2683
+ "example": "0",
2624
2684
  "member": "int64",
2625
2685
  "name": "Limit",
2626
2686
  "required": false,
@@ -2635,18 +2695,20 @@
2635
2695
  {
2636
2696
  "disabled": false,
2637
2697
  "document": "Number of tables",
2638
- "example": "",
2698
+ "example": "0",
2639
2699
  "member": "uint64",
2640
2700
  "name": "TotalCount",
2701
+ "output_required": true,
2641
2702
  "type": "int",
2642
2703
  "value_allowed_null": false
2643
2704
  },
2644
2705
  {
2645
2706
  "disabled": false,
2646
2707
  "document": "Table details result list",
2647
- "example": "",
2708
+ "example": "{}",
2648
2709
  "member": "TableInfoNew",
2649
2710
  "name": "TableInfos",
2711
+ "output_required": true,
2650
2712
  "type": "list",
2651
2713
  "value_allowed_null": false
2652
2714
  },
@@ -2757,7 +2819,7 @@
2757
2819
  {
2758
2820
  "disabled": false,
2759
2821
  "document": "List of IDs of clusters where the tasks to be queried reside",
2760
- "example": "",
2822
+ "example": "176784",
2761
2823
  "member": "string",
2762
2824
  "name": "ClusterIds",
2763
2825
  "required": false,
@@ -2766,7 +2828,7 @@
2766
2828
  {
2767
2829
  "disabled": false,
2768
2830
  "document": "List of IDs of tasks to be queried",
2769
- "example": "",
2831
+ "example": "1345345",
2770
2832
  "member": "string",
2771
2833
  "name": "TaskIds",
2772
2834
  "required": false,
@@ -2775,7 +2837,7 @@
2775
2837
  {
2776
2838
  "disabled": false,
2777
2839
  "document": "Filter. Valid values: Content, TaskType, Operator, Time",
2778
- "example": "",
2840
+ "example": "{}",
2779
2841
  "member": "Filter",
2780
2842
  "name": "Filters",
2781
2843
  "required": false,
@@ -2784,7 +2846,7 @@
2784
2846
  {
2785
2847
  "disabled": false,
2786
2848
  "document": "Query list offset",
2787
- "example": "",
2849
+ "example": "0",
2788
2850
  "member": "int64",
2789
2851
  "name": "Offset",
2790
2852
  "required": false,
@@ -2793,7 +2855,7 @@
2793
2855
  {
2794
2856
  "disabled": false,
2795
2857
  "document": "Number of returned results in query list",
2796
- "example": "",
2858
+ "example": "10",
2797
2859
  "member": "int64",
2798
2860
  "name": "Limit",
2799
2861
  "required": false,
@@ -2808,18 +2870,20 @@
2808
2870
  {
2809
2871
  "disabled": false,
2810
2872
  "document": "Number of tasks",
2811
- "example": "",
2873
+ "example": "10",
2812
2874
  "member": "uint64",
2813
2875
  "name": "TotalCount",
2876
+ "output_required": true,
2814
2877
  "type": "int",
2815
2878
  "value_allowed_null": false
2816
2879
  },
2817
2880
  {
2818
2881
  "disabled": false,
2819
2882
  "document": "List of details of queried tasks",
2820
- "example": "",
2883
+ "example": "{}",
2821
2884
  "member": "TaskInfoNew",
2822
2885
  "name": "TaskInfos",
2886
+ "output_required": true,
2823
2887
  "type": "list",
2824
2888
  "value_allowed_null": false
2825
2889
  },
@@ -2843,9 +2907,10 @@
2843
2907
  {
2844
2908
  "disabled": false,
2845
2909
  "document": "Query result. FALSE: yes, TRUE: no",
2846
- "example": "",
2910
+ "example": "FALSE",
2847
2911
  "member": "string",
2848
2912
  "name": "Result",
2913
+ "output_required": true,
2849
2914
  "type": "string",
2850
2915
  "value_allowed_null": false
2851
2916
  },
@@ -2864,7 +2929,7 @@
2864
2929
  {
2865
2930
  "disabled": false,
2866
2931
  "document": "The value is the same as `appid`.",
2867
- "example": "",
2932
+ "example": "4534634",
2868
2933
  "member": "string",
2869
2934
  "name": "ClusterId",
2870
2935
  "required": true,
@@ -2879,18 +2944,20 @@
2879
2944
  {
2880
2945
  "disabled": false,
2881
2946
  "document": "RestProxy status. Valid values: 0 (disabled), 1 (enabling), 2 (enabled), 3 (disabling).",
2882
- "example": "",
2947
+ "example": "0",
2883
2948
  "member": "uint64",
2884
2949
  "name": "RestProxyStatus",
2950
+ "output_required": true,
2885
2951
  "type": "int",
2886
2952
  "value_allowed_null": false
2887
2953
  },
2888
2954
  {
2889
2955
  "disabled": false,
2890
2956
  "document": "`TaskId` is in the format of `AppInstanceId-taskId`, used to identify tasks of different clusters.",
2891
- "example": "",
2957
+ "example": "34532",
2892
2958
  "member": "string",
2893
2959
  "name": "TaskId",
2960
+ "output_required": true,
2894
2961
  "type": "string",
2895
2962
  "value_allowed_null": false
2896
2963
  },
@@ -2909,7 +2976,7 @@
2909
2976
  {
2910
2977
  "disabled": false,
2911
2978
  "document": "The value is the same as `appid`.",
2912
- "example": "",
2979
+ "example": "5674209986",
2913
2980
  "member": "string",
2914
2981
  "name": "ClusterId",
2915
2982
  "required": true,
@@ -2924,18 +2991,20 @@
2924
2991
  {
2925
2992
  "disabled": false,
2926
2993
  "document": "RestProxy status. Valid values: 0 (disabled), 1 (enabling), 2 (enabled), 3 (disabling).",
2927
- "example": "",
2994
+ "example": "1",
2928
2995
  "member": "uint64",
2929
2996
  "name": "RestProxyStatus",
2997
+ "output_required": true,
2930
2998
  "type": "int",
2931
2999
  "value_allowed_null": false
2932
3000
  },
2933
3001
  {
2934
3002
  "disabled": false,
2935
3003
  "document": "`TaskId` is in the format of `AppInstanceId-taskId`, used to identify tasks of different clusters.",
2936
- "example": "",
3004
+ "example": "838418134-44",
2937
3005
  "member": "string",
2938
3006
  "name": "TaskId",
3007
+ "output_required": true,
2939
3008
  "type": "string",
2940
3009
  "value_allowed_null": false
2941
3010
  },
@@ -2954,20 +3023,20 @@
2954
3023
  {
2955
3024
  "disabled": false,
2956
3025
  "document": "Error code",
2957
- "example": "",
3026
+ "example": "14212",
2958
3027
  "member": "string",
2959
3028
  "name": "Code",
2960
- "required": true,
3029
+ "output_required": true,
2961
3030
  "type": "string",
2962
3031
  "value_allowed_null": false
2963
3032
  },
2964
3033
  {
2965
3034
  "disabled": false,
2966
3035
  "document": "Error message",
2967
- "example": "",
3036
+ "example": "InnerError",
2968
3037
  "member": "string",
2969
3038
  "name": "Message",
2970
- "required": true,
3039
+ "output_required": true,
2971
3040
  "type": "string",
2972
3041
  "value_allowed_null": false
2973
3042
  }
@@ -2980,42 +3049,38 @@
2980
3049
  {
2981
3050
  "disabled": false,
2982
3051
  "document": "Table field name",
2983
- "example": "",
3052
+ "example": "fieldName",
2984
3053
  "member": "string",
2985
3054
  "name": "FieldName",
2986
3055
  "required": true,
2987
- "type": "string",
2988
- "value_allowed_null": false
3056
+ "type": "string"
2989
3057
  },
2990
3058
  {
2991
3059
  "disabled": false,
2992
3060
  "document": "Whether it is a primary key field",
2993
- "example": "",
3061
+ "example": "0",
2994
3062
  "member": "string",
2995
3063
  "name": "IsPrimaryKey",
2996
3064
  "required": true,
2997
- "type": "string",
2998
- "value_allowed_null": false
3065
+ "type": "string"
2999
3066
  },
3000
3067
  {
3001
3068
  "disabled": false,
3002
3069
  "document": "Field type",
3003
- "example": "",
3070
+ "example": "1",
3004
3071
  "member": "string",
3005
3072
  "name": "FieldType",
3006
3073
  "required": false,
3007
- "type": "string",
3008
- "value_allowed_null": false
3074
+ "type": "string"
3009
3075
  },
3010
3076
  {
3011
3077
  "disabled": false,
3012
3078
  "document": "Field length",
3013
- "example": "",
3079
+ "example": "32012",
3014
3080
  "member": "int64",
3015
3081
  "name": "FieldSize",
3016
3082
  "required": false,
3017
- "type": "int",
3018
- "value_allowed_null": false
3083
+ "type": "int"
3019
3084
  }
3020
3085
  ],
3021
3086
  "usage": "in"
@@ -3062,9 +3127,10 @@
3062
3127
  {
3063
3128
  "disabled": false,
3064
3129
  "document": "Filename excluding extension",
3065
- "example": "",
3130
+ "example": "fieldName",
3066
3131
  "member": "string",
3067
3132
  "name": "FileName",
3133
+ "output_required": true,
3068
3134
  "required": true,
3069
3135
  "type": "string",
3070
3136
  "value_allowed_null": false
@@ -3072,9 +3138,10 @@
3072
3138
  {
3073
3139
  "disabled": false,
3074
3140
  "document": "Data interface description language (IDL) type",
3075
- "example": "",
3141
+ "example": "1",
3076
3142
  "member": "string",
3077
3143
  "name": "FileType",
3144
+ "output_required": true,
3078
3145
  "required": true,
3079
3146
  "type": "string",
3080
3147
  "value_allowed_null": false
@@ -3082,9 +3149,10 @@
3082
3149
  {
3083
3150
  "disabled": false,
3084
3151
  "document": "File extension",
3085
- "example": "",
3152
+ "example": "proto",
3086
3153
  "member": "string",
3087
3154
  "name": "FileExtType",
3155
+ "output_required": true,
3088
3156
  "required": true,
3089
3157
  "type": "string",
3090
3158
  "value_allowed_null": false
@@ -3092,9 +3160,10 @@
3092
3160
  {
3093
3161
  "disabled": false,
3094
3162
  "document": "File size in bytes",
3095
- "example": "",
3163
+ "example": "137545",
3096
3164
  "member": "int64",
3097
3165
  "name": "FileSize",
3166
+ "output_required": true,
3098
3167
  "required": true,
3099
3168
  "type": "int",
3100
3169
  "value_allowed_null": false
@@ -3102,22 +3171,24 @@
3102
3171
  {
3103
3172
  "disabled": false,
3104
3173
  "document": "File ID, which is meaningful for files already uploaded\nNote: this field may return null, indicating that no valid values can be obtained.",
3105
- "example": "",
3174
+ "example": "243445",
3106
3175
  "member": "int64",
3107
3176
  "name": "FileId",
3177
+ "output_required": false,
3108
3178
  "required": false,
3109
3179
  "type": "int",
3110
- "value_allowed_null": true
3180
+ "value_allowed_null": false
3111
3181
  },
3112
3182
  {
3113
3183
  "disabled": false,
3114
3184
  "document": "File content, which is meaningful for files to be uploaded in this request\nNote: this field may return null, indicating that no valid values can be obtained.",
3115
- "example": "",
3185
+ "example": "filecontent",
3116
3186
  "member": "string",
3117
3187
  "name": "FileContent",
3188
+ "output_required": false,
3118
3189
  "required": false,
3119
3190
  "type": "string",
3120
- "value_allowed_null": true
3191
+ "value_allowed_null": false
3121
3192
  }
3122
3193
  ],
3123
3194
  "usage": "both"
@@ -3128,62 +3199,62 @@
3128
3199
  {
3129
3200
  "disabled": false,
3130
3201
  "document": "Filename excluding extension\nNote: this field may return null, indicating that no valid values can be obtained.",
3131
- "example": "",
3202
+ "example": "filename",
3132
3203
  "member": "string",
3133
3204
  "name": "FileName",
3134
- "required": true,
3205
+ "output_required": false,
3135
3206
  "type": "string",
3136
- "value_allowed_null": true
3207
+ "value_allowed_null": false
3137
3208
  },
3138
3209
  {
3139
3210
  "disabled": false,
3140
3211
  "document": "Data interface description language (IDL) type\nNote: this field may return null, indicating that no valid values can be obtained.",
3141
- "example": "",
3212
+ "example": "1",
3142
3213
  "member": "string",
3143
3214
  "name": "FileType",
3144
- "required": true,
3215
+ "output_required": false,
3145
3216
  "type": "string",
3146
- "value_allowed_null": true
3217
+ "value_allowed_null": false
3147
3218
  },
3148
3219
  {
3149
3220
  "disabled": false,
3150
3221
  "document": "File extension\nNote: this field may return null, indicating that no valid values can be obtained.",
3151
- "example": "",
3222
+ "example": "proto",
3152
3223
  "member": "string",
3153
3224
  "name": "FileExtType",
3154
- "required": true,
3225
+ "output_required": false,
3155
3226
  "type": "string",
3156
- "value_allowed_null": true
3227
+ "value_allowed_null": false
3157
3228
  },
3158
3229
  {
3159
3230
  "disabled": false,
3160
3231
  "document": "File size in bytes\nNote: this field may return null, indicating that no valid values can be obtained.",
3161
- "example": "",
3232
+ "example": "143534",
3162
3233
  "member": "int64",
3163
3234
  "name": "FileSize",
3164
- "required": true,
3235
+ "output_required": false,
3165
3236
  "type": "int",
3166
- "value_allowed_null": true
3237
+ "value_allowed_null": false
3167
3238
  },
3168
3239
  {
3169
3240
  "disabled": false,
3170
3241
  "document": "File ID\nNote: this field may return null, indicating that no valid values can be obtained.",
3171
- "example": "",
3242
+ "example": "15",
3172
3243
  "member": "int64",
3173
3244
  "name": "FileId",
3174
- "required": true,
3245
+ "output_required": false,
3175
3246
  "type": "int",
3176
- "value_allowed_null": true
3247
+ "value_allowed_null": false
3177
3248
  },
3178
3249
  {
3179
3250
  "disabled": false,
3180
3251
  "document": "Error message\nNote: this field may return null, indicating that no valid values can be obtained.",
3181
- "example": "",
3252
+ "example": "{}",
3182
3253
  "member": "ErrorInfo",
3183
3254
  "name": "Error",
3184
- "required": true,
3255
+ "output_required": false,
3185
3256
  "type": "object",
3186
- "value_allowed_null": true
3257
+ "value_allowed_null": false
3187
3258
  }
3188
3259
  ],
3189
3260
  "usage": "out"
@@ -3194,7 +3265,7 @@
3194
3265
  {
3195
3266
  "disabled": false,
3196
3267
  "document": "The ID of the cluster where the original table (from which the snapshot was created) resides",
3197
- "example": "无",
3268
+ "example": "346673",
3198
3269
  "member": "string",
3199
3270
  "name": "ClusterId",
3200
3271
  "required": true,
@@ -3203,7 +3274,7 @@
3203
3274
  {
3204
3275
  "disabled": false,
3205
3276
  "document": "The information of the snapshot to import",
3206
- "example": "无",
3277
+ "example": "{}",
3207
3278
  "member": "SnapshotInfo",
3208
3279
  "name": "Snapshots",
3209
3280
  "required": true,
@@ -3212,7 +3283,7 @@
3212
3283
  {
3213
3284
  "disabled": false,
3214
3285
  "document": "Whether to import partial data of the snapshot. Valid values: `TRUE` (import partial data), `FALSE` (import all data).",
3215
- "example": "无",
3286
+ "example": "testkey",
3216
3287
  "member": "string",
3217
3288
  "name": "ImportSpecialKey",
3218
3289
  "required": true,
@@ -3221,7 +3292,7 @@
3221
3292
  {
3222
3293
  "disabled": false,
3223
3294
  "document": "Whether to import to the original table. Valid values: `TRUE` (import to the original table), `FALSE` (import to a new table).",
3224
- "example": "无",
3295
+ "example": "testname",
3225
3296
  "member": "string",
3226
3297
  "name": "ImportOriginTable",
3227
3298
  "required": true,
@@ -3230,7 +3301,7 @@
3230
3301
  {
3231
3302
  "disabled": false,
3232
3303
  "document": "The file of the keys of the partial data",
3233
- "example": "无",
3304
+ "example": "{}",
3234
3305
  "member": "KeyFile",
3235
3306
  "name": "KeyFile",
3236
3307
  "required": false,
@@ -3239,7 +3310,7 @@
3239
3310
  {
3240
3311
  "disabled": false,
3241
3312
  "document": "The ID of the table group where the new table resides, which is valid only when `ImportOriginTable` is set to `FALSE`",
3242
- "example": "无",
3313
+ "example": "56336",
3243
3314
  "member": "string",
3244
3315
  "name": "NewTableGroupId",
3245
3316
  "required": false,
@@ -3248,7 +3319,7 @@
3248
3319
  {
3249
3320
  "disabled": false,
3250
3321
  "document": "The name of the new table, which is valid only when `ImportOriginTable` is set to `FALSE`. TcaplusDB will automatically create a table named `NewTableName` of the same structure as that of the original table.",
3251
- "example": "无",
3322
+ "example": "testnewname",
3252
3323
  "member": "string",
3253
3324
  "name": "NewTableName",
3254
3325
  "required": false,
@@ -3263,12 +3334,12 @@
3263
3334
  {
3264
3335
  "disabled": false,
3265
3336
  "document": "`TaskId` is in the format of `AppInstanceId-taskId`, used to identify tasks of different clusters.\nNote: `null` may be returned for this field, indicating that no valid values can be obtained.",
3266
- "example": "无",
3337
+ "example": "11843324",
3267
3338
  "member": "string",
3268
3339
  "name": "TaskId",
3269
- "output_required": true,
3340
+ "output_required": false,
3270
3341
  "type": "string",
3271
- "value_allowed_null": true
3342
+ "value_allowed_null": false
3272
3343
  },
3273
3344
  {
3274
3345
  "disabled": false,
@@ -3276,9 +3347,9 @@
3276
3347
  "example": "0",
3277
3348
  "member": "string",
3278
3349
  "name": "ApplicationId",
3279
- "output_required": true,
3350
+ "output_required": false,
3280
3351
  "type": "string",
3281
- "value_allowed_null": true
3352
+ "value_allowed_null": false
3282
3353
  },
3283
3354
  {
3284
3355
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
@@ -3294,21 +3365,23 @@
3294
3365
  "members": [
3295
3366
  {
3296
3367
  "disabled": false,
3297
- "document": "CKafka address",
3368
+ "document": "Kafka address",
3298
3369
  "example": "ckafka-3azrwxvw.ap-shanghai.ckafka.tencentcloudmq.com:6006",
3299
3370
  "member": "string",
3300
3371
  "name": "Address",
3301
- "required": true,
3372
+ "output_required": false,
3373
+ "required": false,
3302
3374
  "type": "string",
3303
3375
  "value_allowed_null": false
3304
3376
  },
3305
3377
  {
3306
3378
  "disabled": false,
3307
- "document": "CKafka topic",
3379
+ "document": "Kafka topic",
3308
3380
  "example": "tcapstream",
3309
3381
  "member": "string",
3310
3382
  "name": "Topic",
3311
- "required": true,
3383
+ "output_required": false,
3384
+ "required": false,
3312
3385
  "type": "string",
3313
3386
  "value_allowed_null": false
3314
3387
  },
@@ -3318,7 +3391,8 @@
3318
3391
  "example": "ckafka-3azrwxvw#tcaplusDev",
3319
3392
  "member": "string",
3320
3393
  "name": "User",
3321
- "required": true,
3394
+ "output_required": false,
3395
+ "required": false,
3322
3396
  "type": "string",
3323
3397
  "value_allowed_null": false
3324
3398
  },
@@ -3328,7 +3402,8 @@
3328
3402
  "example": "tcaplusDev123321",
3329
3403
  "member": "string",
3330
3404
  "name": "Password",
3331
- "required": true,
3405
+ "output_required": false,
3406
+ "required": false,
3332
3407
  "type": "string",
3333
3408
  "value_allowed_null": false
3334
3409
  },
@@ -3338,7 +3413,8 @@
3338
3413
  "example": "ckafka-l4xpzgpz",
3339
3414
  "member": "string",
3340
3415
  "name": "Instance",
3341
- "required": true,
3416
+ "output_required": false,
3417
+ "required": false,
3342
3418
  "type": "string",
3343
3419
  "value_allowed_null": false
3344
3420
  },
@@ -3348,7 +3424,8 @@
3348
3424
  "example": "0",
3349
3425
  "member": "int64",
3350
3426
  "name": "IsVpc",
3351
- "required": true,
3427
+ "output_required": false,
3428
+ "required": false,
3352
3429
  "type": "int",
3353
3430
  "value_allowed_null": false
3354
3431
  }
@@ -3361,42 +3438,38 @@
3361
3438
  {
3362
3439
  "disabled": false,
3363
3440
  "document": "Key file name",
3364
- "example": "",
3441
+ "example": "filename",
3365
3442
  "member": "string",
3366
3443
  "name": "FileName",
3367
3444
  "required": true,
3368
- "type": "string",
3369
- "value_allowed_null": false
3445
+ "type": "string"
3370
3446
  },
3371
3447
  {
3372
3448
  "disabled": false,
3373
3449
  "document": "Key file extension",
3374
- "example": "",
3450
+ "example": "txt",
3375
3451
  "member": "string",
3376
3452
  "name": "FileExtType",
3377
3453
  "required": true,
3378
- "type": "string",
3379
- "value_allowed_null": false
3454
+ "type": "string"
3380
3455
  },
3381
3456
  {
3382
3457
  "disabled": false,
3383
3458
  "document": "Key file content",
3384
- "example": "",
3459
+ "example": "filecontent",
3385
3460
  "member": "string",
3386
3461
  "name": "FileContent",
3387
3462
  "required": true,
3388
- "type": "string",
3389
- "value_allowed_null": false
3463
+ "type": "string"
3390
3464
  },
3391
3465
  {
3392
3466
  "disabled": false,
3393
3467
  "document": "Key file size",
3394
- "example": "",
3468
+ "example": "154564",
3395
3469
  "member": "int64",
3396
3470
  "name": "FileSize",
3397
3471
  "required": false,
3398
- "type": "int",
3399
- "value_allowed_null": false
3472
+ "type": "int"
3400
3473
  }
3401
3474
  ],
3402
3475
  "usage": "in"
@@ -3407,22 +3480,20 @@
3407
3480
  {
3408
3481
  "disabled": false,
3409
3482
  "document": "Machine type",
3410
- "example": "",
3483
+ "example": "proxy",
3411
3484
  "member": "string",
3412
3485
  "name": "MachineType",
3413
3486
  "required": true,
3414
- "type": "string",
3415
- "value_allowed_null": false
3487
+ "type": "string"
3416
3488
  },
3417
3489
  {
3418
3490
  "disabled": false,
3419
3491
  "document": "Machine quantity",
3420
- "example": "",
3492
+ "example": "100",
3421
3493
  "member": "int64",
3422
3494
  "name": "MachineNum",
3423
3495
  "required": true,
3424
- "type": "int",
3425
- "value_allowed_null": false
3496
+ "type": "int"
3426
3497
  }
3427
3498
  ],
3428
3499
  "usage": "in"
@@ -3436,9 +3507,9 @@
3436
3507
  "example": "0",
3437
3508
  "member": "string",
3438
3509
  "name": "TaskId",
3439
- "required": true,
3510
+ "output_required": false,
3440
3511
  "type": "string",
3441
- "value_allowed_null": true
3512
+ "value_allowed_null": false
3442
3513
  },
3443
3514
  {
3444
3515
  "disabled": false,
@@ -3446,9 +3517,9 @@
3446
3517
  "example": "0",
3447
3518
  "member": "ErrorInfo",
3448
3519
  "name": "Error",
3449
- "required": true,
3520
+ "output_required": false,
3450
3521
  "type": "object",
3451
- "value_allowed_null": true
3522
+ "value_allowed_null": false
3452
3523
  },
3453
3524
  {
3454
3525
  "disabled": false,
@@ -3456,7 +3527,7 @@
3456
3527
  "example": "0",
3457
3528
  "member": "CompareTablesInfo",
3458
3529
  "name": "Table",
3459
- "required": true,
3530
+ "output_required": true,
3460
3531
  "type": "object",
3461
3532
  "value_allowed_null": false
3462
3533
  },
@@ -3466,9 +3537,9 @@
3466
3537
  "example": "0",
3467
3538
  "member": "string",
3468
3539
  "name": "ApplicationId",
3469
- "required": true,
3540
+ "output_required": false,
3470
3541
  "type": "string",
3471
- "value_allowed_null": true
3542
+ "value_allowed_null": false
3472
3543
  }
3473
3544
  ],
3474
3545
  "usage": "out"
@@ -3479,7 +3550,7 @@
3479
3550
  {
3480
3551
  "disabled": false,
3481
3552
  "document": "Tables to be merged",
3482
- "example": "无",
3553
+ "example": "{}",
3483
3554
  "member": "MergeTablesInfo",
3484
3555
  "name": "SelectedTables",
3485
3556
  "required": true,
@@ -3488,7 +3559,7 @@
3488
3559
  {
3489
3560
  "disabled": false,
3490
3561
  "document": "Valid values: `true` (only compare), `false` (compare and merge)",
3491
- "example": "无",
3562
+ "example": "false",
3492
3563
  "member": "bool",
3493
3564
  "name": "IsOnlyCompare",
3494
3565
  "required": true,
@@ -3506,7 +3577,7 @@
3506
3577
  "example": "无",
3507
3578
  "member": "MergeTableResult",
3508
3579
  "name": "Results",
3509
- "required": true,
3580
+ "output_required": true,
3510
3581
  "type": "list",
3511
3582
  "value_allowed_null": false
3512
3583
  },
@@ -3525,22 +3596,20 @@
3525
3596
  {
3526
3597
  "disabled": false,
3527
3598
  "document": "Information of tables to be merged",
3528
- "example": "",
3599
+ "example": "{}",
3529
3600
  "member": "CompareTablesInfo",
3530
3601
  "name": "MergeTables",
3531
3602
  "required": true,
3532
- "type": "object",
3533
- "value_allowed_null": false
3603
+ "type": "object"
3534
3604
  },
3535
3605
  {
3536
3606
  "disabled": false,
3537
3607
  "document": "Whether to check indexes",
3538
- "example": "",
3608
+ "example": "false",
3539
3609
  "member": "bool",
3540
3610
  "name": "CheckIndex",
3541
3611
  "required": true,
3542
- "type": "bool",
3543
- "value_allowed_null": false
3612
+ "type": "bool"
3544
3613
  }
3545
3614
  ],
3546
3615
  "usage": "in"
@@ -3587,7 +3656,7 @@
3587
3656
  "example": "10001",
3588
3657
  "member": "string",
3589
3658
  "name": "ClusterId",
3590
- "required": true,
3659
+ "output_required": true,
3591
3660
  "type": "string",
3592
3661
  "value_allowed_null": false
3593
3662
  },
@@ -3597,9 +3666,9 @@
3597
3666
  "example": "0",
3598
3667
  "member": "string",
3599
3668
  "name": "Uins",
3600
- "required": true,
3669
+ "output_required": false,
3601
3670
  "type": "list",
3602
- "value_allowed_null": true
3671
+ "value_allowed_null": false
3603
3672
  },
3604
3673
  {
3605
3674
  "disabled": false,
@@ -3607,7 +3676,7 @@
3607
3676
  "example": "0",
3608
3677
  "member": "int64",
3609
3678
  "name": "Censorship",
3610
- "required": true,
3679
+ "output_required": true,
3611
3680
  "type": "int",
3612
3681
  "value_allowed_null": false
3613
3682
  },
@@ -3626,7 +3695,7 @@
3626
3695
  {
3627
3696
  "disabled": false,
3628
3697
  "document": "Cluster ID",
3629
- "example": "",
3698
+ "example": "16585",
3630
3699
  "member": "string",
3631
3700
  "name": "ClusterId",
3632
3701
  "required": true,
@@ -3635,7 +3704,7 @@
3635
3704
  {
3636
3705
  "disabled": false,
3637
3706
  "document": "Information of the machines at the storage layer (tcapsvr)",
3638
- "example": "",
3707
+ "example": "{}",
3639
3708
  "member": "MachineInfo",
3640
3709
  "name": "ServerList",
3641
3710
  "required": true,
@@ -3644,7 +3713,7 @@
3644
3713
  {
3645
3714
  "disabled": false,
3646
3715
  "document": "Information of the machines at the access layer (tcaproxy)",
3647
- "example": "",
3716
+ "example": "{}",
3648
3717
  "member": "MachineInfo",
3649
3718
  "name": "ProxyList",
3650
3719
  "required": true,
@@ -3653,7 +3722,7 @@
3653
3722
  {
3654
3723
  "disabled": false,
3655
3724
  "document": "Cluster type. Valid values: `1` (standard), `2` (dedicated)",
3656
- "example": "",
3725
+ "example": "2",
3657
3726
  "member": "int64",
3658
3727
  "name": "ClusterType",
3659
3728
  "required": true,
@@ -3668,9 +3737,10 @@
3668
3737
  {
3669
3738
  "disabled": false,
3670
3739
  "document": "Cluster ID",
3671
- "example": "",
3740
+ "example": "165865",
3672
3741
  "member": "string",
3673
3742
  "name": "ClusterId",
3743
+ "output_required": true,
3674
3744
  "type": "string",
3675
3745
  "value_allowed_null": false
3676
3746
  },
@@ -3689,7 +3759,7 @@
3689
3759
  {
3690
3760
  "disabled": false,
3691
3761
  "document": "ID of the cluster to be renamed",
3692
- "example": "",
3762
+ "example": "1865675",
3693
3763
  "member": "string",
3694
3764
  "name": "ClusterId",
3695
3765
  "required": true,
@@ -3698,7 +3768,7 @@
3698
3768
  {
3699
3769
  "disabled": false,
3700
3770
  "document": "Cluster name to be changed to, which can contain up to 32 letters and digits",
3701
- "example": "",
3771
+ "example": "testname",
3702
3772
  "member": "string",
3703
3773
  "name": "ClusterName",
3704
3774
  "required": true,
@@ -3725,7 +3795,7 @@
3725
3795
  {
3726
3796
  "disabled": false,
3727
3797
  "document": "ID of the cluster for which to modify the password",
3728
- "example": "",
3798
+ "example": "23311894780",
3729
3799
  "member": "string",
3730
3800
  "name": "ClusterId",
3731
3801
  "required": true,
@@ -3734,7 +3804,7 @@
3734
3804
  {
3735
3805
  "disabled": false,
3736
3806
  "document": "Old cluster password",
3737
- "example": "",
3807
+ "example": "canmkdmk1215LM",
3738
3808
  "member": "string",
3739
3809
  "name": "OldPassword",
3740
3810
  "required": true,
@@ -3743,7 +3813,7 @@
3743
3813
  {
3744
3814
  "disabled": false,
3745
3815
  "document": "Expected expiration time of old cluster password",
3746
- "example": "",
3816
+ "example": "2019-08-26%2017%3A25%3A00",
3747
3817
  "member": "datetime",
3748
3818
  "name": "OldPasswordExpireTime",
3749
3819
  "required": true,
@@ -3752,7 +3822,7 @@
3752
3822
  {
3753
3823
  "disabled": false,
3754
3824
  "document": "New cluster password, which must contain lowercase letters (a-z), uppercase letters (A-Z), and digits (0-9).",
3755
- "example": "",
3825
+ "example": "99c59cb345c61063db",
3756
3826
  "member": "string",
3757
3827
  "name": "NewPassword",
3758
3828
  "required": true,
@@ -3761,7 +3831,7 @@
3761
3831
  {
3762
3832
  "disabled": false,
3763
3833
  "document": "Update mode. 1: updates password, 2: updates old password expiration time. Default value: 1",
3764
- "example": "",
3834
+ "example": "1",
3765
3835
  "member": "string",
3766
3836
  "name": "Mode",
3767
3837
  "required": false,
@@ -3788,7 +3858,7 @@
3788
3858
  {
3789
3859
  "disabled": false,
3790
3860
  "document": "The ID of the cluster whose tags need to be modified",
3791
- "example": "",
3861
+ "example": "932312",
3792
3862
  "member": "string",
3793
3863
  "name": "ClusterId",
3794
3864
  "required": true,
@@ -3797,7 +3867,7 @@
3797
3867
  {
3798
3868
  "disabled": false,
3799
3869
  "document": "The list of tags to add or modify",
3800
- "example": "",
3870
+ "example": "{}",
3801
3871
  "member": "TagInfoUnit",
3802
3872
  "name": "ReplaceTags",
3803
3873
  "required": false,
@@ -3806,7 +3876,7 @@
3806
3876
  {
3807
3877
  "disabled": false,
3808
3878
  "document": "Tags to delete",
3809
- "example": "",
3879
+ "example": "{}",
3810
3880
  "member": "TagInfoUnit",
3811
3881
  "name": "DeleteTags",
3812
3882
  "required": false,
@@ -3821,11 +3891,12 @@
3821
3891
  {
3822
3892
  "disabled": false,
3823
3893
  "document": "Task ID",
3824
- "example": "",
3894
+ "example": "898989",
3825
3895
  "member": "string",
3826
3896
  "name": "TaskId",
3897
+ "output_required": false,
3827
3898
  "type": "string",
3828
- "value_allowed_null": true
3899
+ "value_allowed_null": false
3829
3900
  },
3830
3901
  {
3831
3902
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
@@ -3869,7 +3940,7 @@
3869
3940
  "example": "1",
3870
3941
  "member": "uint64",
3871
3942
  "name": "TotalCount",
3872
- "required": true,
3943
+ "output_required": true,
3873
3944
  "type": "int",
3874
3945
  "value_allowed_null": false
3875
3946
  },
@@ -3879,7 +3950,7 @@
3879
3950
  "example": "无",
3880
3951
  "member": "SnapshotResult",
3881
3952
  "name": "TableResults",
3882
- "required": true,
3953
+ "output_required": true,
3883
3954
  "type": "list",
3884
3955
  "value_allowed_null": false
3885
3956
  },
@@ -3898,7 +3969,7 @@
3898
3969
  {
3899
3970
  "disabled": false,
3900
3971
  "document": "ID of the cluster where a table group resides",
3901
- "example": "",
3972
+ "example": "1656785",
3902
3973
  "member": "string",
3903
3974
  "name": "ClusterId",
3904
3975
  "required": true,
@@ -3907,7 +3978,7 @@
3907
3978
  {
3908
3979
  "disabled": false,
3909
3980
  "document": "ID of the table group to be renamed",
3910
- "example": "",
3981
+ "example": "14564",
3911
3982
  "member": "string",
3912
3983
  "name": "TableGroupId",
3913
3984
  "required": true,
@@ -3916,7 +3987,7 @@
3916
3987
  {
3917
3988
  "disabled": false,
3918
3989
  "document": "New table group name, which can contain letters and symbols",
3919
- "example": "",
3990
+ "example": "groupname",
3920
3991
  "member": "string",
3921
3992
  "name": "TableGroupName",
3922
3993
  "required": true,
@@ -3943,7 +4014,7 @@
3943
4014
  {
3944
4015
  "disabled": false,
3945
4016
  "document": "The ID of the cluster where table group tags need to be modified",
3946
- "example": "",
4017
+ "example": "15474",
3947
4018
  "member": "string",
3948
4019
  "name": "ClusterId",
3949
4020
  "required": true,
@@ -3952,7 +4023,7 @@
3952
4023
  {
3953
4024
  "disabled": false,
3954
4025
  "document": "The ID of the table group whose tags need to be modified",
3955
- "example": "",
4026
+ "example": "4545",
3956
4027
  "member": "string",
3957
4028
  "name": "TableGroupId",
3958
4029
  "required": true,
@@ -3961,7 +4032,7 @@
3961
4032
  {
3962
4033
  "disabled": false,
3963
4034
  "document": "The list of tags to add or modify",
3964
- "example": "",
4035
+ "example": "{}",
3965
4036
  "member": "TagInfoUnit",
3966
4037
  "name": "ReplaceTags",
3967
4038
  "required": false,
@@ -3970,7 +4041,7 @@
3970
4041
  {
3971
4042
  "disabled": false,
3972
4043
  "document": "Tags to delete",
3973
- "example": "",
4044
+ "example": "{}",
3974
4045
  "member": "TagInfoUnit",
3975
4046
  "name": "DeleteTags",
3976
4047
  "required": false,
@@ -3985,11 +4056,12 @@
3985
4056
  {
3986
4057
  "disabled": false,
3987
4058
  "document": "Task ID",
3988
- "example": "",
4059
+ "example": "1654564",
3989
4060
  "member": "string",
3990
4061
  "name": "TaskId",
4062
+ "output_required": false,
3991
4063
  "type": "string",
3992
- "value_allowed_null": true
4064
+ "value_allowed_null": false
3993
4065
  },
3994
4066
  {
3995
4067
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
@@ -4006,7 +4078,7 @@
4006
4078
  {
4007
4079
  "disabled": false,
4008
4080
  "document": "ID of the cluster instance where a table resides",
4009
- "example": "",
4081
+ "example": "574845",
4010
4082
  "member": "string",
4011
4083
  "name": "ClusterId",
4012
4084
  "required": true,
@@ -4015,7 +4087,7 @@
4015
4087
  {
4016
4088
  "disabled": false,
4017
4089
  "document": "List of details of selected tables",
4018
- "example": "",
4090
+ "example": "{}",
4019
4091
  "member": "SelectedTableInfoNew",
4020
4092
  "name": "TableMemos",
4021
4093
  "required": true,
@@ -4030,18 +4102,20 @@
4030
4102
  {
4031
4103
  "disabled": false,
4032
4104
  "document": "Number of tables modified for remarks",
4033
- "example": "",
4105
+ "example": "0",
4034
4106
  "member": "uint64",
4035
4107
  "name": "TotalCount",
4108
+ "output_required": true,
4036
4109
  "type": "int",
4037
4110
  "value_allowed_null": false
4038
4111
  },
4039
4112
  {
4040
4113
  "disabled": false,
4041
4114
  "document": "List of table remarks modification results",
4042
- "example": "",
4115
+ "example": "{}",
4043
4116
  "member": "TableResultNew",
4044
4117
  "name": "TableResults",
4118
+ "output_required": true,
4045
4119
  "type": "list",
4046
4120
  "value_allowed_null": false
4047
4121
  },
@@ -4060,7 +4134,7 @@
4060
4134
  {
4061
4135
  "disabled": false,
4062
4136
  "document": "ID of the cluster where the table to be scaled resides",
4063
- "example": "",
4137
+ "example": "675656",
4064
4138
  "member": "string",
4065
4139
  "name": "ClusterId",
4066
4140
  "required": true,
@@ -4069,7 +4143,7 @@
4069
4143
  {
4070
4144
  "disabled": false,
4071
4145
  "document": "List of quotas of tables selected for modification",
4072
- "example": "",
4146
+ "example": "{}",
4073
4147
  "member": "SelectedTableInfoNew",
4074
4148
  "name": "TableQuotas",
4075
4149
  "required": true,
@@ -4084,18 +4158,20 @@
4084
4158
  {
4085
4159
  "disabled": false,
4086
4160
  "document": "Number of scaled tables",
4087
- "example": "",
4161
+ "example": "0",
4088
4162
  "member": "uint64",
4089
4163
  "name": "TotalCount",
4164
+ "output_required": true,
4090
4165
  "type": "int",
4091
4166
  "value_allowed_null": false
4092
4167
  },
4093
4168
  {
4094
4169
  "disabled": false,
4095
4170
  "document": "List of table scaling results",
4096
- "example": "",
4171
+ "example": "null",
4097
4172
  "member": "TableResultNew",
4098
4173
  "name": "TableResults",
4174
+ "output_required": true,
4099
4175
  "type": "list",
4100
4176
  "value_allowed_null": false
4101
4177
  },
@@ -4114,7 +4190,7 @@
4114
4190
  {
4115
4191
  "disabled": false,
4116
4192
  "document": "The ID of the cluster where table tags need to be modified",
4117
- "example": "",
4193
+ "example": "76784564",
4118
4194
  "member": "string",
4119
4195
  "name": "ClusterId",
4120
4196
  "required": true,
@@ -4123,7 +4199,7 @@
4123
4199
  {
4124
4200
  "disabled": false,
4125
4201
  "document": "The list of tables whose tags need to be modified",
4126
- "example": "",
4202
+ "example": "{}",
4127
4203
  "member": "SelectedTableInfoNew",
4128
4204
  "name": "SelectedTables",
4129
4205
  "required": true,
@@ -4132,7 +4208,7 @@
4132
4208
  {
4133
4209
  "disabled": false,
4134
4210
  "document": "The list of tags to add or modify",
4135
- "example": "",
4211
+ "example": "{}",
4136
4212
  "member": "TagInfoUnit",
4137
4213
  "name": "ReplaceTags",
4138
4214
  "required": false,
@@ -4141,7 +4217,7 @@
4141
4217
  {
4142
4218
  "disabled": false,
4143
4219
  "document": "The list of tags to delete",
4144
- "example": "",
4220
+ "example": "{}",
4145
4221
  "member": "TagInfoUnit",
4146
4222
  "name": "DeleteTags",
4147
4223
  "required": false,
@@ -4156,18 +4232,20 @@
4156
4232
  {
4157
4233
  "disabled": false,
4158
4234
  "document": "The total number of returned results",
4159
- "example": "",
4235
+ "example": "0",
4160
4236
  "member": "int64",
4161
4237
  "name": "TotalCount",
4238
+ "output_required": true,
4162
4239
  "type": "int",
4163
4240
  "value_allowed_null": false
4164
4241
  },
4165
4242
  {
4166
4243
  "disabled": false,
4167
4244
  "document": "Returned results",
4168
- "example": "",
4245
+ "example": "null",
4169
4246
  "member": "TableResultNew",
4170
4247
  "name": "TableResults",
4248
+ "output_required": true,
4171
4249
  "type": "list",
4172
4250
  "value_allowed_null": false
4173
4251
  },
@@ -4186,7 +4264,7 @@
4186
4264
  {
4187
4265
  "disabled": false,
4188
4266
  "document": "ID of the cluster where the table to be modified resides",
4189
- "example": "",
4267
+ "example": "565335",
4190
4268
  "member": "string",
4191
4269
  "name": "ClusterId",
4192
4270
  "required": true,
@@ -4195,7 +4273,7 @@
4195
4273
  {
4196
4274
  "disabled": false,
4197
4275
  "document": "Selected table modification IDL files",
4198
- "example": "",
4276
+ "example": "{}",
4199
4277
  "member": "IdlFileInfo",
4200
4278
  "name": "IdlFiles",
4201
4279
  "required": true,
@@ -4204,7 +4282,7 @@
4204
4282
  {
4205
4283
  "disabled": false,
4206
4284
  "document": "List of tables to be modified",
4207
- "example": "",
4285
+ "example": "{}",
4208
4286
  "member": "SelectedTableInfoNew",
4209
4287
  "name": "SelectedTables",
4210
4288
  "required": true,
@@ -4219,18 +4297,20 @@
4219
4297
  {
4220
4298
  "disabled": false,
4221
4299
  "document": "Number of modified tables",
4222
- "example": "",
4300
+ "example": "0",
4223
4301
  "member": "uint64",
4224
4302
  "name": "TotalCount",
4303
+ "output_required": true,
4225
4304
  "type": "int",
4226
4305
  "value_allowed_null": false
4227
4306
  },
4228
4307
  {
4229
4308
  "disabled": false,
4230
4309
  "document": "List of table modification results",
4231
- "example": "",
4310
+ "example": "null",
4232
4311
  "member": "TableResultNew",
4233
4312
  "name": "TableResults",
4313
+ "output_required": true,
4234
4314
  "type": "list",
4235
4315
  "value_allowed_null": false
4236
4316
  },
@@ -4249,182 +4329,182 @@
4249
4329
  {
4250
4330
  "disabled": false,
4251
4331
  "document": "Table description language type. Valid values: PROTO, TDR\nNote: this field may return null, indicating that no valid values can be obtained.",
4252
- "example": "",
4332
+ "example": "1",
4253
4333
  "member": "string",
4254
4334
  "name": "TableIdlType",
4255
- "required": true,
4335
+ "output_required": false,
4256
4336
  "type": "string",
4257
- "value_allowed_null": true
4337
+ "value_allowed_null": false
4258
4338
  },
4259
4339
  {
4260
4340
  "disabled": false,
4261
4341
  "document": "Table instance ID\nNote: this field may return null, indicating that no valid values can be obtained.",
4262
- "example": "",
4342
+ "example": "tcaplus-323",
4263
4343
  "member": "string",
4264
4344
  "name": "TableInstanceId",
4265
- "required": true,
4345
+ "output_required": false,
4266
4346
  "type": "string",
4267
- "value_allowed_null": true
4347
+ "value_allowed_null": false
4268
4348
  },
4269
4349
  {
4270
4350
  "disabled": false,
4271
4351
  "document": "Table name\nNote: this field may return null, indicating that no valid values can be obtained.",
4272
- "example": "",
4352
+ "example": "testname",
4273
4353
  "member": "string",
4274
4354
  "name": "TableName",
4275
- "required": true,
4355
+ "output_required": false,
4276
4356
  "type": "string",
4277
- "value_allowed_null": true
4357
+ "value_allowed_null": false
4278
4358
  },
4279
4359
  {
4280
4360
  "disabled": false,
4281
4361
  "document": "Table data structure type. Valid values: GENERIC, LIST\nNote: this field may return null, indicating that no valid values can be obtained.",
4282
- "example": "",
4362
+ "example": "1",
4283
4363
  "member": "string",
4284
4364
  "name": "TableType",
4285
- "required": true,
4365
+ "output_required": false,
4286
4366
  "type": "string",
4287
- "value_allowed_null": true
4367
+ "value_allowed_null": false
4288
4368
  },
4289
4369
  {
4290
4370
  "disabled": false,
4291
4371
  "document": "Primary key field information\nNote: this field may return null, indicating that no valid values can be obtained.",
4292
- "example": "",
4372
+ "example": "testkey",
4293
4373
  "member": "string",
4294
4374
  "name": "KeyFields",
4295
- "required": true,
4375
+ "output_required": false,
4296
4376
  "type": "string",
4297
- "value_allowed_null": true
4377
+ "value_allowed_null": false
4298
4378
  },
4299
4379
  {
4300
4380
  "disabled": false,
4301
4381
  "document": "Old primary key field information, which is valid during verification of table modification\nNote: this field may return null, indicating that no valid values can be obtained.",
4302
- "example": "",
4382
+ "example": "oldtestkey",
4303
4383
  "member": "string",
4304
4384
  "name": "OldKeyFields",
4305
- "required": true,
4385
+ "output_required": false,
4306
4386
  "type": "string",
4307
- "value_allowed_null": true
4387
+ "value_allowed_null": false
4308
4388
  },
4309
4389
  {
4310
4390
  "disabled": false,
4311
4391
  "document": "Non-primary key field information\nNote: this field may return null, indicating that no valid values can be obtained.",
4312
- "example": "",
4392
+ "example": "valuefield",
4313
4393
  "member": "string",
4314
4394
  "name": "ValueFields",
4315
- "required": true,
4395
+ "output_required": false,
4316
4396
  "type": "string",
4317
- "value_allowed_null": true
4397
+ "value_allowed_null": false
4318
4398
  },
4319
4399
  {
4320
4400
  "disabled": false,
4321
4401
  "document": "Old non-primary key field information, which is valid during verification of table modification\nNote: this field may return null, indicating that no valid values can be obtained.",
4322
- "example": "",
4402
+ "example": "oldvaluefield",
4323
4403
  "member": "string",
4324
4404
  "name": "OldValueFields",
4325
- "required": true,
4405
+ "output_required": false,
4326
4406
  "type": "string",
4327
- "value_allowed_null": true
4407
+ "value_allowed_null": false
4328
4408
  },
4329
4409
  {
4330
4410
  "disabled": false,
4331
4411
  "document": "Table group ID\nNote: this field may return null, indicating that no valid values can be obtained.",
4332
- "example": "",
4412
+ "example": "12414",
4333
4413
  "member": "string",
4334
4414
  "name": "TableGroupId",
4335
- "required": true,
4415
+ "output_required": false,
4336
4416
  "type": "string",
4337
- "value_allowed_null": true
4417
+ "value_allowed_null": false
4338
4418
  },
4339
4419
  {
4340
4420
  "disabled": false,
4341
4421
  "document": "Total size of primary key field\nNote: this field may return null, indicating that no valid values can be obtained.",
4342
- "example": "",
4422
+ "example": "135235",
4343
4423
  "member": "int64",
4344
4424
  "name": "SumKeyFieldSize",
4345
- "required": true,
4425
+ "output_required": false,
4346
4426
  "type": "int",
4347
- "value_allowed_null": true
4427
+ "value_allowed_null": false
4348
4428
  },
4349
4429
  {
4350
4430
  "disabled": false,
4351
4431
  "document": "Total size of non-primary key fields\nNote: this field may return null, indicating that no valid values can be obtained.",
4352
- "example": "",
4432
+ "example": "1325323",
4353
4433
  "member": "int64",
4354
4434
  "name": "SumValueFieldSize",
4355
- "required": true,
4435
+ "output_required": false,
4356
4436
  "type": "int",
4357
- "value_allowed_null": true
4437
+ "value_allowed_null": false
4358
4438
  },
4359
4439
  {
4360
4440
  "disabled": false,
4361
4441
  "document": "Index key set\nNote: this field may return null, indicating that no valid values can be obtained.",
4362
- "example": "",
4442
+ "example": "indexkeyset",
4363
4443
  "member": "string",
4364
4444
  "name": "IndexKeySet",
4365
- "required": true,
4445
+ "output_required": false,
4366
4446
  "type": "string",
4367
- "value_allowed_null": true
4447
+ "value_allowed_null": false
4368
4448
  },
4369
4449
  {
4370
4450
  "disabled": false,
4371
4451
  "document": "Shardkey set\nNote: this field may return null, indicating that no valid values can be obtained.",
4372
- "example": "",
4452
+ "example": "shardingkeyset",
4373
4453
  "member": "string",
4374
4454
  "name": "ShardingKeySet",
4375
- "required": true,
4455
+ "output_required": false,
4376
4456
  "type": "string",
4377
- "value_allowed_null": true
4457
+ "value_allowed_null": false
4378
4458
  },
4379
4459
  {
4380
4460
  "disabled": false,
4381
4461
  "document": "TDR version number\nNote: this field may return null, indicating that no valid values can be obtained.",
4382
- "example": "",
4462
+ "example": "1",
4383
4463
  "member": "int64",
4384
4464
  "name": "TdrVersion",
4385
- "required": true,
4465
+ "output_required": false,
4386
4466
  "type": "int",
4387
- "value_allowed_null": true
4467
+ "value_allowed_null": false
4388
4468
  },
4389
4469
  {
4390
4470
  "disabled": false,
4391
4471
  "document": "Error message\nNote: this field may return null, indicating that no valid values can be obtained.",
4392
- "example": "",
4472
+ "example": "{}",
4393
4473
  "member": "ErrorInfo",
4394
4474
  "name": "Error",
4395
- "required": true,
4475
+ "output_required": false,
4396
4476
  "type": "object",
4397
- "value_allowed_null": true
4477
+ "value_allowed_null": false
4398
4478
  },
4399
4479
  {
4400
4480
  "disabled": false,
4401
4481
  "document": "Number of LIST-type table elements\nNote: this field may return null, indicating that no valid values can be obtained.",
4402
- "example": "",
4482
+ "example": "1024",
4403
4483
  "member": "int64",
4404
4484
  "name": "ListElementNum",
4405
- "required": true,
4485
+ "output_required": false,
4406
4486
  "type": "int",
4407
- "value_allowed_null": true
4487
+ "value_allowed_null": false
4408
4488
  },
4409
4489
  {
4410
4490
  "disabled": false,
4411
4491
  "document": "Number of SORTLIST-type table sort fields\nNote: this field may return null, indicating that no valid values can be obtained.",
4412
- "example": "",
4492
+ "example": "0",
4413
4493
  "member": "int64",
4414
4494
  "name": "SortFieldNum",
4415
- "required": true,
4495
+ "output_required": false,
4416
4496
  "type": "int",
4417
- "value_allowed_null": true
4497
+ "value_allowed_null": false
4418
4498
  },
4419
4499
  {
4420
4500
  "disabled": false,
4421
4501
  "document": "Sort order of SORTLIST-type tables\nNote: this field may return null, indicating that no valid values can be obtained.",
4422
- "example": "",
4502
+ "example": "1",
4423
4503
  "member": "int64",
4424
4504
  "name": "SortRule",
4425
- "required": true,
4505
+ "output_required": false,
4426
4506
  "type": "int",
4427
- "value_allowed_null": true
4507
+ "value_allowed_null": false
4428
4508
  }
4429
4509
  ],
4430
4510
  "usage": "out"
@@ -4435,50 +4515,50 @@
4435
4515
  {
4436
4516
  "disabled": false,
4437
4517
  "document": "Unique ID",
4438
- "example": "",
4518
+ "example": "1",
4439
4519
  "member": "int64",
4440
4520
  "name": "PoolUid",
4441
- "required": true,
4521
+ "output_required": true,
4442
4522
  "type": "int",
4443
4523
  "value_allowed_null": false
4444
4524
  },
4445
4525
  {
4446
4526
  "disabled": false,
4447
4527
  "document": "Whether IPv6 is supported",
4448
- "example": "",
4528
+ "example": "0",
4449
4529
  "member": "int64",
4450
4530
  "name": "Ipv6Enable",
4451
- "required": true,
4531
+ "output_required": true,
4452
4532
  "type": "int",
4453
4533
  "value_allowed_null": false
4454
4534
  },
4455
4535
  {
4456
4536
  "disabled": false,
4457
4537
  "document": "Remaining available cluster resources",
4458
- "example": "",
4538
+ "example": "10",
4459
4539
  "member": "int64",
4460
4540
  "name": "AvailableAppCount",
4461
- "required": true,
4541
+ "output_required": true,
4462
4542
  "type": "int",
4463
4543
  "value_allowed_null": false
4464
4544
  },
4465
4545
  {
4466
4546
  "disabled": false,
4467
4547
  "document": "The list of machines at the storage layer (tcapsvr)",
4468
- "example": "",
4548
+ "example": "{}",
4469
4549
  "member": "ServerMachineInfo",
4470
4550
  "name": "ServerList",
4471
- "required": true,
4551
+ "output_required": true,
4472
4552
  "type": "list",
4473
4553
  "value_allowed_null": false
4474
4554
  },
4475
4555
  {
4476
4556
  "disabled": false,
4477
4557
  "document": "The list of machines at the access layer (tcaproxy)",
4478
- "example": "",
4558
+ "example": "{}",
4479
4559
  "member": "ProxyMachineInfo",
4480
4560
  "name": "ProxyList",
4481
- "required": true,
4561
+ "output_required": true,
4482
4562
  "type": "list",
4483
4563
  "value_allowed_null": false
4484
4564
  }
@@ -4494,7 +4574,7 @@
4494
4574
  "example": "1.2.2.2",
4495
4575
  "member": "string",
4496
4576
  "name": "ProxyUid",
4497
- "required": true,
4577
+ "output_required": true,
4498
4578
  "type": "string",
4499
4579
  "value_allowed_null": false
4500
4580
  },
@@ -4504,7 +4584,7 @@
4504
4584
  "example": "0",
4505
4585
  "member": "string",
4506
4586
  "name": "MachineType",
4507
- "required": true,
4587
+ "output_required": true,
4508
4588
  "type": "string",
4509
4589
  "value_allowed_null": false
4510
4590
  },
@@ -4514,7 +4594,7 @@
4514
4594
  "example": "0",
4515
4595
  "member": "int64",
4516
4596
  "name": "ProcessSpeed",
4517
- "required": true,
4597
+ "output_required": true,
4518
4598
  "type": "int",
4519
4599
  "value_allowed_null": false
4520
4600
  },
@@ -4524,7 +4604,7 @@
4524
4604
  "example": "0",
4525
4605
  "member": "int64",
4526
4606
  "name": "AverageProcessDelay",
4527
- "required": true,
4607
+ "output_required": true,
4528
4608
  "type": "int",
4529
4609
  "value_allowed_null": false
4530
4610
  },
@@ -4534,19 +4614,19 @@
4534
4614
  "example": "0",
4535
4615
  "member": "int64",
4536
4616
  "name": "SlowProcessSpeed",
4537
- "required": true,
4617
+ "output_required": true,
4538
4618
  "type": "int",
4539
4619
  "value_allowed_null": false
4540
4620
  },
4541
4621
  {
4542
4622
  "disabled": false,
4543
- "document": "Version\nNote: This field may return null, indicating that no valid values can be obtained.",
4623
+ "document": "Version.",
4544
4624
  "example": "3.46.0",
4545
4625
  "member": "string",
4546
4626
  "name": "Version",
4547
- "required": true,
4627
+ "output_required": false,
4548
4628
  "type": "string",
4549
- "value_allowed_null": true
4629
+ "value_allowed_null": false
4550
4630
  }
4551
4631
  ],
4552
4632
  "usage": "out"
@@ -4593,7 +4673,7 @@
4593
4673
  {
4594
4674
  "disabled": false,
4595
4675
  "document": "ID of the cluster where a table resides",
4596
- "example": "",
4676
+ "example": "635363",
4597
4677
  "member": "string",
4598
4678
  "name": "ClusterId",
4599
4679
  "required": true,
@@ -4602,7 +4682,7 @@
4602
4682
  {
4603
4683
  "disabled": false,
4604
4684
  "document": "Information of tables to be recovered",
4605
- "example": "",
4685
+ "example": "{}",
4606
4686
  "member": "SelectedTableInfoNew",
4607
4687
  "name": "SelectedTables",
4608
4688
  "required": true,
@@ -4617,18 +4697,20 @@
4617
4697
  {
4618
4698
  "disabled": false,
4619
4699
  "document": "Number of recovered tables",
4620
- "example": "",
4700
+ "example": "0",
4621
4701
  "member": "uint64",
4622
4702
  "name": "TotalCount",
4703
+ "output_required": true,
4623
4704
  "type": "int",
4624
4705
  "value_allowed_null": false
4625
4706
  },
4626
4707
  {
4627
4708
  "disabled": false,
4628
4709
  "document": "List of information of recovered tables",
4629
- "example": "",
4710
+ "example": "null",
4630
4711
  "member": "TableResultNew",
4631
4712
  "name": "TableResults",
4713
+ "output_required": true,
4632
4714
  "type": "list",
4633
4715
  "value_allowed_null": false
4634
4716
  },
@@ -4647,40 +4729,40 @@
4647
4729
  {
4648
4730
  "disabled": false,
4649
4731
  "document": "Region `Ap-code`",
4650
- "example": "",
4732
+ "example": "ap-shanghai",
4651
4733
  "member": "string",
4652
4734
  "name": "RegionName",
4653
- "required": true,
4735
+ "output_required": true,
4654
4736
  "type": "string",
4655
4737
  "value_allowed_null": false
4656
4738
  },
4657
4739
  {
4658
4740
  "disabled": false,
4659
4741
  "document": "Region abbreviation",
4660
- "example": "",
4742
+ "example": "sh",
4661
4743
  "member": "string",
4662
4744
  "name": "RegionAbbr",
4663
- "required": true,
4745
+ "output_required": true,
4664
4746
  "type": "string",
4665
4747
  "value_allowed_null": false
4666
4748
  },
4667
4749
  {
4668
4750
  "disabled": false,
4669
4751
  "document": "Region ID",
4670
- "example": "",
4752
+ "example": "102123",
4671
4753
  "member": "uint64",
4672
4754
  "name": "RegionId",
4673
- "required": true,
4755
+ "output_required": true,
4674
4756
  "type": "int",
4675
4757
  "value_allowed_null": false
4676
4758
  },
4677
4759
  {
4678
4760
  "disabled": false,
4679
4761
  "document": "Whether to support IPv6 address access. Valid values: 0 (support), 1 (not support)",
4680
- "example": "",
4762
+ "example": "0",
4681
4763
  "member": "uint64",
4682
4764
  "name": "Ipv6Enable",
4683
- "required": true,
4765
+ "output_required": true,
4684
4766
  "type": "int",
4685
4767
  "value_allowed_null": false
4686
4768
  }
@@ -4765,142 +4847,128 @@
4765
4847
  {
4766
4848
  "disabled": false,
4767
4849
  "document": "ID of the table group where a table resides",
4768
- "example": "",
4850
+ "example": "1213",
4769
4851
  "member": "string",
4770
4852
  "name": "TableGroupId",
4771
4853
  "required": true,
4772
- "type": "string",
4773
- "value_allowed_null": false
4854
+ "type": "string"
4774
4855
  },
4775
4856
  {
4776
4857
  "disabled": false,
4777
4858
  "document": "Table name",
4778
- "example": "",
4859
+ "example": "testname",
4779
4860
  "member": "string",
4780
4861
  "name": "TableName",
4781
4862
  "required": true,
4782
- "type": "string",
4783
- "value_allowed_null": false
4863
+ "type": "string"
4784
4864
  },
4785
4865
  {
4786
4866
  "disabled": false,
4787
4867
  "document": "Table instance ID",
4788
- "example": "",
4868
+ "example": "tcaplus-21312",
4789
4869
  "member": "string",
4790
4870
  "name": "TableInstanceId",
4791
4871
  "required": false,
4792
- "type": "string",
4793
- "value_allowed_null": false
4872
+ "type": "string"
4794
4873
  },
4795
4874
  {
4796
4875
  "disabled": false,
4797
4876
  "document": "Table description language type. Valid values: PROTO, TDR",
4798
- "example": "",
4877
+ "example": "1",
4799
4878
  "member": "string",
4800
4879
  "name": "TableIdlType",
4801
4880
  "required": false,
4802
- "type": "string",
4803
- "value_allowed_null": false
4881
+ "type": "string"
4804
4882
  },
4805
4883
  {
4806
4884
  "disabled": false,
4807
4885
  "document": "Table data structure type. Valid values: GENERIC, LIST",
4808
- "example": "",
4886
+ "example": "1",
4809
4887
  "member": "string",
4810
4888
  "name": "TableType",
4811
4889
  "required": false,
4812
- "type": "string",
4813
- "value_allowed_null": false
4890
+ "type": "string"
4814
4891
  },
4815
4892
  {
4816
4893
  "disabled": false,
4817
4894
  "document": "Number of LIST-type table elements",
4818
- "example": "",
4895
+ "example": "1024",
4819
4896
  "member": "int64",
4820
4897
  "name": "ListElementNum",
4821
4898
  "required": false,
4822
- "type": "int",
4823
- "value_allowed_null": false
4899
+ "type": "int"
4824
4900
  },
4825
4901
  {
4826
4902
  "disabled": false,
4827
4903
  "document": "Reserved table capacity in GB",
4828
- "example": "",
4904
+ "example": "1",
4829
4905
  "member": "int64",
4830
4906
  "name": "ReservedVolume",
4831
4907
  "required": false,
4832
- "type": "int",
4833
- "value_allowed_null": false
4908
+ "type": "int"
4834
4909
  },
4835
4910
  {
4836
4911
  "disabled": false,
4837
4912
  "document": "Reserved table read QPS",
4838
- "example": "",
4913
+ "example": "1000",
4839
4914
  "member": "int64",
4840
4915
  "name": "ReservedReadQps",
4841
4916
  "required": false,
4842
- "type": "int",
4843
- "value_allowed_null": false
4917
+ "type": "int"
4844
4918
  },
4845
4919
  {
4846
4920
  "disabled": false,
4847
4921
  "document": "Reserved table write QPS",
4848
- "example": "",
4922
+ "example": "1000",
4849
4923
  "member": "int64",
4850
4924
  "name": "ReservedWriteQps",
4851
4925
  "required": false,
4852
- "type": "int",
4853
- "value_allowed_null": false
4926
+ "type": "int"
4854
4927
  },
4855
4928
  {
4856
4929
  "disabled": false,
4857
4930
  "document": "Table remarks",
4858
- "example": "",
4931
+ "example": "memo",
4859
4932
  "member": "string",
4860
4933
  "name": "Memo",
4861
4934
  "required": false,
4862
- "type": "string",
4863
- "value_allowed_null": false
4935
+ "type": "string"
4864
4936
  },
4865
4937
  {
4866
4938
  "disabled": false,
4867
4939
  "document": "Key rollback filename, which is only used for rollback",
4868
- "example": "",
4940
+ "example": "filename",
4869
4941
  "member": "string",
4870
4942
  "name": "FileName",
4871
4943
  "required": false,
4872
- "type": "string",
4873
- "value_allowed_null": false
4944
+ "type": "string"
4874
4945
  },
4875
4946
  {
4876
4947
  "disabled": false,
4877
4948
  "document": "Key rollback file extension, which is only used for rollback",
4878
- "example": "",
4949
+ "example": "txt",
4879
4950
  "member": "string",
4880
4951
  "name": "FileExtType",
4881
4952
  "required": false,
4882
- "type": "string",
4883
- "value_allowed_null": false
4953
+ "type": "string"
4884
4954
  },
4885
4955
  {
4886
4956
  "disabled": false,
4887
4957
  "document": "Key rollback file size, which is only used for rollback",
4888
- "example": "",
4958
+ "example": "10234",
4889
4959
  "member": "int64",
4890
4960
  "name": "FileSize",
4891
4961
  "required": false,
4892
- "type": "int",
4893
- "value_allowed_null": false
4962
+ "type": "int"
4894
4963
  },
4895
4964
  {
4896
4965
  "disabled": false,
4897
4966
  "document": "Key rollback file content, which is only used for rollback",
4898
- "example": "",
4967
+ "example": "filecontent",
4899
4968
  "member": "string",
4900
4969
  "name": "FileContent",
4901
4970
  "required": false,
4902
- "type": "string",
4903
- "value_allowed_null": false
4971
+ "type": "string"
4904
4972
  }
4905
4973
  ],
4906
4974
  "usage": "in"
@@ -5000,7 +5068,7 @@
5000
5068
  "example": "1.2.2.2",
5001
5069
  "member": "string",
5002
5070
  "name": "ServerUid",
5003
- "required": true,
5071
+ "output_required": true,
5004
5072
  "type": "string",
5005
5073
  "value_allowed_null": false
5006
5074
  },
@@ -5010,7 +5078,7 @@
5010
5078
  "example": "master",
5011
5079
  "member": "string",
5012
5080
  "name": "MachineType",
5013
- "required": true,
5081
+ "output_required": true,
5014
5082
  "type": "string",
5015
5083
  "value_allowed_null": false
5016
5084
  },
@@ -5020,7 +5088,7 @@
5020
5088
  "example": "0",
5021
5089
  "member": "int64",
5022
5090
  "name": "MemoryRate",
5023
- "required": true,
5091
+ "output_required": true,
5024
5092
  "type": "int",
5025
5093
  "value_allowed_null": false
5026
5094
  },
@@ -5030,7 +5098,7 @@
5030
5098
  "example": "0",
5031
5099
  "member": "int64",
5032
5100
  "name": "DiskRate",
5033
- "required": true,
5101
+ "output_required": true,
5034
5102
  "type": "int",
5035
5103
  "value_allowed_null": false
5036
5104
  },
@@ -5040,7 +5108,7 @@
5040
5108
  "example": "0",
5041
5109
  "member": "int64",
5042
5110
  "name": "ReadNum",
5043
- "required": true,
5111
+ "output_required": true,
5044
5112
  "type": "int",
5045
5113
  "value_allowed_null": false
5046
5114
  },
@@ -5050,19 +5118,19 @@
5050
5118
  "example": "0",
5051
5119
  "member": "int64",
5052
5120
  "name": "WriteNum",
5053
- "required": true,
5121
+ "output_required": true,
5054
5122
  "type": "int",
5055
5123
  "value_allowed_null": false
5056
5124
  },
5057
5125
  {
5058
5126
  "disabled": false,
5059
- "document": "Version\nNote: This field may return null, indicating that no valid values can be obtained.",
5127
+ "document": "Version.",
5060
5128
  "example": "3.46.0",
5061
5129
  "member": "string",
5062
5130
  "name": "Version",
5063
- "required": true,
5131
+ "output_required": false,
5064
5132
  "type": "string",
5065
- "value_allowed_null": true
5133
+ "value_allowed_null": false
5066
5134
  }
5067
5135
  ],
5068
5136
  "usage": "out"
@@ -5073,20 +5141,20 @@
5073
5141
  {
5074
5142
  "disabled": false,
5075
5143
  "document": "The unique ID of the machine",
5076
- "example": "",
5144
+ "example": "svr-10221",
5077
5145
  "member": "string",
5078
5146
  "name": "ServerUid",
5079
- "required": true,
5147
+ "output_required": true,
5080
5148
  "type": "string",
5081
5149
  "value_allowed_null": false
5082
5150
  },
5083
5151
  {
5084
5152
  "disabled": false,
5085
5153
  "document": "Machine type",
5086
- "example": "",
5154
+ "example": "svr",
5087
5155
  "member": "string",
5088
5156
  "name": "MachineType",
5089
- "required": true,
5157
+ "output_required": true,
5090
5158
  "type": "string",
5091
5159
  "value_allowed_null": false
5092
5160
  }
@@ -5126,9 +5194,9 @@
5126
5194
  "example": "1",
5127
5195
  "member": "string",
5128
5196
  "name": "TaskId",
5129
- "required": true,
5197
+ "output_required": false,
5130
5198
  "type": "string",
5131
- "value_allowed_null": true
5199
+ "value_allowed_null": false
5132
5200
  },
5133
5201
  {
5134
5202
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
@@ -5172,7 +5240,7 @@
5172
5240
  "example": "1",
5173
5241
  "member": "uint64",
5174
5242
  "name": "TotalCount",
5175
- "required": true,
5243
+ "output_required": true,
5176
5244
  "type": "int",
5177
5245
  "value_allowed_null": false
5178
5246
  },
@@ -5182,7 +5250,7 @@
5182
5250
  "example": "无",
5183
5251
  "member": "TableResultNew",
5184
5252
  "name": "TableResults",
5185
- "required": true,
5253
+ "output_required": true,
5186
5254
  "type": "list",
5187
5255
  "value_allowed_null": false
5188
5256
  },
@@ -5201,7 +5269,7 @@
5201
5269
  {
5202
5270
  "disabled": false,
5203
5271
  "document": "ID of the cluster where the table resides",
5204
- "example": "",
5272
+ "example": "5674209986",
5205
5273
  "member": "string",
5206
5274
  "name": "ClusterId",
5207
5275
  "required": true,
@@ -5210,7 +5278,7 @@
5210
5278
  {
5211
5279
  "disabled": false,
5212
5280
  "document": "The list of tables that need to create global indexes",
5213
- "example": "",
5281
+ "example": "无",
5214
5282
  "member": "SelectedTableWithField",
5215
5283
  "name": "SelectedTables",
5216
5284
  "required": true,
@@ -5225,18 +5293,20 @@
5225
5293
  {
5226
5294
  "disabled": false,
5227
5295
  "document": "The number of tables whose global indexes are created",
5228
- "example": "",
5296
+ "example": "1",
5229
5297
  "member": "uint64",
5230
5298
  "name": "TotalCount",
5299
+ "output_required": true,
5231
5300
  "type": "int",
5232
5301
  "value_allowed_null": false
5233
5302
  },
5234
5303
  {
5235
5304
  "disabled": false,
5236
5305
  "document": "The list of global index creation results",
5237
- "example": "",
5306
+ "example": "无",
5238
5307
  "member": "TableResultNew",
5239
5308
  "name": "TableResults",
5309
+ "output_required": true,
5240
5310
  "type": "list",
5241
5311
  "value_allowed_null": false
5242
5312
  },
@@ -5255,9 +5325,10 @@
5255
5325
  {
5256
5326
  "disabled": false,
5257
5327
  "document": "The ID of the table group where the table resides",
5258
- "example": "",
5328
+ "example": "19822",
5259
5329
  "member": "string",
5260
5330
  "name": "TableGroupId",
5331
+ "output_required": true,
5261
5332
  "required": true,
5262
5333
  "type": "string",
5263
5334
  "value_allowed_null": false
@@ -5265,9 +5336,10 @@
5265
5336
  {
5266
5337
  "disabled": false,
5267
5338
  "document": "Table name",
5268
- "example": "",
5339
+ "example": "testname",
5269
5340
  "member": "string",
5270
5341
  "name": "TableName",
5342
+ "output_required": true,
5271
5343
  "required": true,
5272
5344
  "type": "string",
5273
5345
  "value_allowed_null": false
@@ -5275,9 +5347,10 @@
5275
5347
  {
5276
5348
  "disabled": false,
5277
5349
  "document": "Snapshot name",
5278
- "example": "",
5350
+ "example": "snapshotname",
5279
5351
  "member": "string",
5280
5352
  "name": "SnapshotName",
5353
+ "output_required": true,
5281
5354
  "required": true,
5282
5355
  "type": "string",
5283
5356
  "value_allowed_null": false
@@ -5285,9 +5358,10 @@
5285
5358
  {
5286
5359
  "disabled": false,
5287
5360
  "document": "The time of the data from which the snapshot was created",
5288
- "example": "",
5361
+ "example": "2023-10-10 10:10:10",
5289
5362
  "member": "datetime",
5290
5363
  "name": "SnapshotTime",
5364
+ "output_required": true,
5291
5365
  "required": true,
5292
5366
  "type": "string",
5293
5367
  "value_allowed_null": false
@@ -5295,9 +5369,10 @@
5295
5369
  {
5296
5370
  "disabled": false,
5297
5371
  "document": "Snapshot expiration time",
5298
- "example": "",
5372
+ "example": "2023-10-11 10:10:10",
5299
5373
  "member": "datetime",
5300
5374
  "name": "SnapshotDeadTime",
5375
+ "output_required": true,
5301
5376
  "required": true,
5302
5377
  "type": "string",
5303
5378
  "value_allowed_null": false
@@ -5311,42 +5386,38 @@
5311
5386
  {
5312
5387
  "disabled": false,
5313
5388
  "document": "The ID of the table group where the table resides",
5314
- "example": "",
5389
+ "example": "184232",
5315
5390
  "member": "string",
5316
5391
  "name": "TableGroupId",
5317
5392
  "required": true,
5318
- "type": "string",
5319
- "value_allowed_null": false
5393
+ "type": "string"
5320
5394
  },
5321
5395
  {
5322
5396
  "disabled": false,
5323
5397
  "document": "Table name",
5324
- "example": "",
5398
+ "example": "testname",
5325
5399
  "member": "string",
5326
5400
  "name": "TableName",
5327
5401
  "required": true,
5328
- "type": "string",
5329
- "value_allowed_null": false
5402
+ "type": "string"
5330
5403
  },
5331
5404
  {
5332
5405
  "disabled": false,
5333
5406
  "document": "Snapshot name",
5334
- "example": "",
5407
+ "example": "snapshotname",
5335
5408
  "member": "string",
5336
5409
  "name": "SnapshotName",
5337
5410
  "required": true,
5338
- "type": "string",
5339
- "value_allowed_null": false
5411
+ "type": "string"
5340
5412
  },
5341
5413
  {
5342
5414
  "disabled": false,
5343
5415
  "document": "Snapshot expiration time",
5344
- "example": "",
5416
+ "example": "2020-10-10 10:10:10",
5345
5417
  "member": "datetime",
5346
5418
  "name": "SnapshotDeadTime",
5347
5419
  "required": false,
5348
- "type": "string",
5349
- "value_allowed_null": false
5420
+ "type": "string"
5350
5421
  }
5351
5422
  ],
5352
5423
  "usage": "in"
@@ -5357,52 +5428,52 @@
5357
5428
  {
5358
5429
  "disabled": false,
5359
5430
  "document": "The ID of the table group where the table resides\nNote: `null` may be returned for this field, indicating that no valid values can be obtained.",
5360
- "example": "0",
5431
+ "example": "13277",
5361
5432
  "member": "string",
5362
5433
  "name": "TableGroupId",
5363
- "required": true,
5434
+ "output_required": false,
5364
5435
  "type": "string",
5365
- "value_allowed_null": true
5436
+ "value_allowed_null": false
5366
5437
  },
5367
5438
  {
5368
5439
  "disabled": false,
5369
5440
  "document": "Table name\nNote: `null` may be returned for this field, indicating that no valid values can be obtained.",
5370
- "example": "0",
5441
+ "example": "name",
5371
5442
  "member": "string",
5372
5443
  "name": "TableName",
5373
- "required": true,
5444
+ "output_required": false,
5374
5445
  "type": "string",
5375
- "value_allowed_null": true
5446
+ "value_allowed_null": false
5376
5447
  },
5377
5448
  {
5378
5449
  "disabled": false,
5379
5450
  "document": "Task ID, which is valid for the API that creates one task at a time\nNote: `null` may be returned for this field, indicating that no valid values can be obtained.",
5380
- "example": "0",
5451
+ "example": "16756",
5381
5452
  "member": "string",
5382
5453
  "name": "TaskId",
5383
- "required": true,
5454
+ "output_required": false,
5384
5455
  "type": "string",
5385
- "value_allowed_null": true
5456
+ "value_allowed_null": false
5386
5457
  },
5387
5458
  {
5388
5459
  "disabled": false,
5389
5460
  "document": "Error information\nNote: `null` may be returned for this field, indicating that no valid values can be obtained.",
5390
- "example": "0",
5461
+ "example": "{}",
5391
5462
  "member": "ErrorInfo",
5392
5463
  "name": "Error",
5393
- "required": true,
5464
+ "output_required": false,
5394
5465
  "type": "object",
5395
- "value_allowed_null": true
5466
+ "value_allowed_null": false
5396
5467
  },
5397
5468
  {
5398
5469
  "disabled": false,
5399
5470
  "document": "Snapshot name\nNote: `null` may be returned for this field, indicating that no valid values can be obtained.",
5400
- "example": "0",
5471
+ "example": "snapname",
5401
5472
  "member": "string",
5402
5473
  "name": "SnapshotName",
5403
- "required": true,
5474
+ "output_required": false,
5404
5475
  "type": "string",
5405
- "value_allowed_null": true
5476
+ "value_allowed_null": false
5406
5477
  },
5407
5478
  {
5408
5479
  "disabled": false,
@@ -5410,9 +5481,9 @@
5410
5481
  "example": "0",
5411
5482
  "member": "datetime",
5412
5483
  "name": "SnapshotTime",
5413
- "required": true,
5484
+ "output_required": false,
5414
5485
  "type": "string",
5415
- "value_allowed_null": true
5486
+ "value_allowed_null": false
5416
5487
  },
5417
5488
  {
5418
5489
  "disabled": false,
@@ -5420,9 +5491,9 @@
5420
5491
  "example": "0",
5421
5492
  "member": "datetime",
5422
5493
  "name": "SnapshotDeadTime",
5423
- "required": true,
5494
+ "output_required": false,
5424
5495
  "type": "string",
5425
- "value_allowed_null": true
5496
+ "value_allowed_null": false
5426
5497
  },
5427
5498
  {
5428
5499
  "disabled": false,
@@ -5430,19 +5501,19 @@
5430
5501
  "example": "0",
5431
5502
  "member": "datetime",
5432
5503
  "name": "SnapshotCreateTime",
5433
- "required": true,
5504
+ "output_required": false,
5434
5505
  "type": "string",
5435
- "value_allowed_null": true
5506
+ "value_allowed_null": false
5436
5507
  },
5437
5508
  {
5438
5509
  "disabled": false,
5439
5510
  "document": "Snapshot size\nNote: `null` may be returned for this field, indicating that no valid values can be obtained.",
5440
- "example": "0",
5511
+ "example": "35623",
5441
5512
  "member": "uint64",
5442
5513
  "name": "SnapshotSize",
5443
- "required": true,
5514
+ "output_required": false,
5444
5515
  "type": "int",
5445
- "value_allowed_null": true
5516
+ "value_allowed_null": false
5446
5517
  },
5447
5518
  {
5448
5519
  "disabled": false,
@@ -5450,9 +5521,9 @@
5450
5521
  "example": "0",
5451
5522
  "member": "uint64",
5452
5523
  "name": "SnapshotStatus",
5453
- "required": true,
5524
+ "output_required": false,
5454
5525
  "type": "int",
5455
- "value_allowed_null": true
5526
+ "value_allowed_null": false
5456
5527
  }
5457
5528
  ],
5458
5529
  "usage": "out"
@@ -5492,17 +5563,17 @@
5492
5563
  "example": "1",
5493
5564
  "member": "uint64",
5494
5565
  "name": "TargetTableSplitNum",
5495
- "required": true,
5566
+ "output_required": true,
5496
5567
  "type": "int",
5497
5568
  "value_allowed_null": false
5498
5569
  },
5499
5570
  {
5500
5571
  "disabled": false,
5501
5572
  "document": "Prefix of the target cache table name",
5502
- "example": "无",
5573
+ "example": "nameprefix",
5503
5574
  "member": "string",
5504
5575
  "name": "TargetTableNamePrefix",
5505
- "required": true,
5576
+ "output_required": true,
5506
5577
  "type": "list",
5507
5578
  "value_allowed_null": false
5508
5579
  },
@@ -5512,7 +5583,7 @@
5512
5583
  "example": "cdb-70zdmgg1",
5513
5584
  "member": "string",
5514
5585
  "name": "TargetSyncDBInstanceId",
5515
- "required": true,
5586
+ "output_required": true,
5516
5587
  "type": "string",
5517
5588
  "value_allowed_null": false
5518
5589
  },
@@ -5522,7 +5593,7 @@
5522
5593
  "example": "db",
5523
5594
  "member": "string",
5524
5595
  "name": "TargetDatabaseName",
5525
- "required": true,
5596
+ "output_required": true,
5526
5597
  "type": "string",
5527
5598
  "value_allowed_null": false
5528
5599
  },
@@ -5532,7 +5603,7 @@
5532
5603
  "example": "0",
5533
5604
  "member": "int64",
5534
5605
  "name": "Status",
5535
- "required": true,
5606
+ "output_required": true,
5536
5607
  "type": "int",
5537
5608
  "value_allowed_null": false
5538
5609
  },
@@ -5542,7 +5613,7 @@
5542
5613
  "example": "18641706761",
5543
5614
  "member": "string",
5544
5615
  "name": "ClusterId",
5545
- "required": true,
5616
+ "output_required": true,
5546
5617
  "type": "string",
5547
5618
  "value_allowed_null": false
5548
5619
  },
@@ -5552,7 +5623,7 @@
5552
5623
  "example": "1",
5553
5624
  "member": "uint64",
5554
5625
  "name": "TableGroupId",
5555
- "required": true,
5626
+ "output_required": true,
5556
5627
  "type": "int",
5557
5628
  "value_allowed_null": false
5558
5629
  },
@@ -5562,7 +5633,7 @@
5562
5633
  "example": "tablename",
5563
5634
  "member": "string",
5564
5635
  "name": "TableName",
5565
- "required": true,
5636
+ "output_required": true,
5566
5637
  "type": "string",
5567
5638
  "value_allowed_null": false
5568
5639
  },
@@ -5572,27 +5643,27 @@
5572
5643
  "example": "tcaplus-d753f0db",
5573
5644
  "member": "string",
5574
5645
  "name": "TableId",
5575
- "required": true,
5646
+ "output_required": true,
5576
5647
  "type": "string",
5577
5648
  "value_allowed_null": false
5578
5649
  },
5579
5650
  {
5580
5651
  "disabled": false,
5581
5652
  "document": "Mapping from the primary key field of the TcaplusDB table to the field of the target cache table",
5582
- "example": "无",
5653
+ "example": "{}",
5583
5654
  "member": "SyncTableField",
5584
5655
  "name": "KeyFieldMapping",
5585
- "required": true,
5656
+ "output_required": true,
5586
5657
  "type": "list",
5587
5658
  "value_allowed_null": false
5588
5659
  },
5589
5660
  {
5590
5661
  "disabled": false,
5591
5662
  "document": "Mapping of TcaplusDB table field to target cache table field",
5592
- "example": "无",
5663
+ "example": "{}",
5593
5664
  "member": "SyncTableField",
5594
5665
  "name": "ValueFieldMapping",
5595
- "required": true,
5666
+ "output_required": true,
5596
5667
  "type": "list",
5597
5668
  "value_allowed_null": false
5598
5669
  }
@@ -5605,20 +5676,20 @@
5605
5676
  {
5606
5677
  "disabled": false,
5607
5678
  "document": "Table group ID",
5608
- "example": "\"123\"",
5679
+ "example": "28127",
5609
5680
  "member": "string",
5610
5681
  "name": "TableGroupId",
5611
- "required": true,
5682
+ "output_required": true,
5612
5683
  "type": "string",
5613
5684
  "value_allowed_null": false
5614
5685
  },
5615
5686
  {
5616
5687
  "disabled": false,
5617
5688
  "document": "Table group name",
5618
- "example": "\"ZoneName\"",
5689
+ "example": "ZoneName",
5619
5690
  "member": "string",
5620
5691
  "name": "TableGroupName",
5621
- "required": true,
5692
+ "output_required": true,
5622
5693
  "type": "string",
5623
5694
  "value_allowed_null": false
5624
5695
  },
@@ -5628,7 +5699,7 @@
5628
5699
  "example": "20211011",
5629
5700
  "member": "datetime",
5630
5701
  "name": "CreatedTime",
5631
- "required": true,
5702
+ "output_required": true,
5632
5703
  "type": "string",
5633
5704
  "value_allowed_null": false
5634
5705
  },
@@ -5638,7 +5709,7 @@
5638
5709
  "example": "10",
5639
5710
  "member": "uint64",
5640
5711
  "name": "TableCount",
5641
- "required": true,
5712
+ "output_required": true,
5642
5713
  "type": "int",
5643
5714
  "value_allowed_null": false
5644
5715
  },
@@ -5648,7 +5719,7 @@
5648
5719
  "example": "100",
5649
5720
  "member": "uint64",
5650
5721
  "name": "TotalSize",
5651
- "required": true,
5722
+ "output_required": true,
5652
5723
  "type": "int",
5653
5724
  "value_allowed_null": false
5654
5725
  },
@@ -5658,9 +5729,9 @@
5658
5729
  "example": "0",
5659
5730
  "member": "uint64",
5660
5731
  "name": "TxhBackupExpireDay",
5661
- "required": true,
5732
+ "output_required": false,
5662
5733
  "type": "int",
5663
- "value_allowed_null": true
5734
+ "value_allowed_null": false
5664
5735
  },
5665
5736
  {
5666
5737
  "disabled": false,
@@ -5668,7 +5739,7 @@
5668
5739
  "example": "1",
5669
5740
  "member": "uint64",
5670
5741
  "name": "EnableMysql",
5671
- "required": true,
5742
+ "output_required": true,
5672
5743
  "type": "int",
5673
5744
  "value_allowed_null": false
5674
5745
  },
@@ -5678,9 +5749,9 @@
5678
5749
  "example": "0.0.0.0",
5679
5750
  "member": "string",
5680
5751
  "name": "MysqlConnIp",
5681
- "required": true,
5752
+ "output_required": false,
5682
5753
  "type": "string",
5683
- "value_allowed_null": true
5754
+ "value_allowed_null": false
5684
5755
  },
5685
5756
  {
5686
5757
  "disabled": false,
@@ -5688,9 +5759,9 @@
5688
5759
  "example": "3306",
5689
5760
  "member": "uint64",
5690
5761
  "name": "MysqlConnPort",
5691
- "required": true,
5762
+ "output_required": false,
5692
5763
  "type": "int",
5693
- "value_allowed_null": true
5764
+ "value_allowed_null": false
5694
5765
  }
5695
5766
  ],
5696
5767
  "usage": "out"
@@ -5704,9 +5775,9 @@
5704
5775
  "example": "1",
5705
5776
  "member": "string",
5706
5777
  "name": "TableName",
5707
- "required": true,
5778
+ "output_required": false,
5708
5779
  "type": "string",
5709
- "value_allowed_null": true
5780
+ "value_allowed_null": false
5710
5781
  },
5711
5782
  {
5712
5783
  "disabled": false,
@@ -5714,9 +5785,9 @@
5714
5785
  "example": "1",
5715
5786
  "member": "string",
5716
5787
  "name": "TableInstanceId",
5717
- "required": true,
5788
+ "output_required": false,
5718
5789
  "type": "string",
5719
- "value_allowed_null": true
5790
+ "value_allowed_null": false
5720
5791
  },
5721
5792
  {
5722
5793
  "disabled": false,
@@ -5724,9 +5795,9 @@
5724
5795
  "example": "1",
5725
5796
  "member": "string",
5726
5797
  "name": "TableType",
5727
- "required": true,
5798
+ "output_required": false,
5728
5799
  "type": "string",
5729
- "value_allowed_null": true
5800
+ "value_allowed_null": false
5730
5801
  },
5731
5802
  {
5732
5803
  "disabled": false,
@@ -5734,9 +5805,9 @@
5734
5805
  "example": "1",
5735
5806
  "member": "string",
5736
5807
  "name": "TableIdlType",
5737
- "required": true,
5808
+ "output_required": false,
5738
5809
  "type": "string",
5739
- "value_allowed_null": true
5810
+ "value_allowed_null": false
5740
5811
  },
5741
5812
  {
5742
5813
  "disabled": false,
@@ -5744,9 +5815,9 @@
5744
5815
  "example": "1",
5745
5816
  "member": "string",
5746
5817
  "name": "ClusterId",
5747
- "required": true,
5818
+ "output_required": false,
5748
5819
  "type": "string",
5749
- "value_allowed_null": true
5820
+ "value_allowed_null": false
5750
5821
  },
5751
5822
  {
5752
5823
  "disabled": false,
@@ -5754,9 +5825,9 @@
5754
5825
  "example": "1",
5755
5826
  "member": "string",
5756
5827
  "name": "ClusterName",
5757
- "required": true,
5828
+ "output_required": false,
5758
5829
  "type": "string",
5759
- "value_allowed_null": true
5830
+ "value_allowed_null": false
5760
5831
  },
5761
5832
  {
5762
5833
  "disabled": false,
@@ -5764,9 +5835,9 @@
5764
5835
  "example": "1",
5765
5836
  "member": "string",
5766
5837
  "name": "TableGroupId",
5767
- "required": true,
5838
+ "output_required": false,
5768
5839
  "type": "string",
5769
- "value_allowed_null": true
5840
+ "value_allowed_null": false
5770
5841
  },
5771
5842
  {
5772
5843
  "disabled": false,
@@ -5774,9 +5845,9 @@
5774
5845
  "example": "1",
5775
5846
  "member": "string",
5776
5847
  "name": "TableGroupName",
5777
- "required": true,
5848
+ "output_required": false,
5778
5849
  "type": "string",
5779
- "value_allowed_null": true
5850
+ "value_allowed_null": false
5780
5851
  },
5781
5852
  {
5782
5853
  "disabled": false,
@@ -5784,9 +5855,9 @@
5784
5855
  "example": "1",
5785
5856
  "member": "string",
5786
5857
  "name": "KeyStruct",
5787
- "required": true,
5858
+ "output_required": false,
5788
5859
  "type": "string",
5789
- "value_allowed_null": true
5860
+ "value_allowed_null": false
5790
5861
  },
5791
5862
  {
5792
5863
  "disabled": false,
@@ -5794,9 +5865,9 @@
5794
5865
  "example": "1",
5795
5866
  "member": "string",
5796
5867
  "name": "ValueStruct",
5797
- "required": true,
5868
+ "output_required": false,
5798
5869
  "type": "string",
5799
- "value_allowed_null": true
5870
+ "value_allowed_null": false
5800
5871
  },
5801
5872
  {
5802
5873
  "disabled": false,
@@ -5804,9 +5875,9 @@
5804
5875
  "example": "1",
5805
5876
  "member": "string",
5806
5877
  "name": "ShardingKeySet",
5807
- "required": true,
5878
+ "output_required": false,
5808
5879
  "type": "string",
5809
- "value_allowed_null": true
5880
+ "value_allowed_null": false
5810
5881
  },
5811
5882
  {
5812
5883
  "disabled": false,
@@ -5814,9 +5885,9 @@
5814
5885
  "example": "1",
5815
5886
  "member": "string",
5816
5887
  "name": "IndexStruct",
5817
- "required": true,
5888
+ "output_required": false,
5818
5889
  "type": "string",
5819
- "value_allowed_null": true
5890
+ "value_allowed_null": false
5820
5891
  },
5821
5892
  {
5822
5893
  "disabled": false,
@@ -5824,9 +5895,9 @@
5824
5895
  "example": "1",
5825
5896
  "member": "uint64",
5826
5897
  "name": "ListElementNum",
5827
- "required": true,
5898
+ "output_required": false,
5828
5899
  "type": "int",
5829
- "value_allowed_null": true
5900
+ "value_allowed_null": false
5830
5901
  },
5831
5902
  {
5832
5903
  "disabled": false,
@@ -5834,9 +5905,9 @@
5834
5905
  "example": "无",
5835
5906
  "member": "IdlFileInfo",
5836
5907
  "name": "IdlFiles",
5837
- "required": true,
5908
+ "output_required": false,
5838
5909
  "type": "list",
5839
- "value_allowed_null": true
5910
+ "value_allowed_null": false
5840
5911
  },
5841
5912
  {
5842
5913
  "disabled": false,
@@ -5844,9 +5915,9 @@
5844
5915
  "example": "1",
5845
5916
  "member": "int64",
5846
5917
  "name": "ReservedVolume",
5847
- "required": true,
5918
+ "output_required": false,
5848
5919
  "type": "int",
5849
- "value_allowed_null": true
5920
+ "value_allowed_null": false
5850
5921
  },
5851
5922
  {
5852
5923
  "disabled": false,
@@ -5854,9 +5925,9 @@
5854
5925
  "example": "1",
5855
5926
  "member": "int64",
5856
5927
  "name": "ReservedReadQps",
5857
- "required": true,
5928
+ "output_required": false,
5858
5929
  "type": "int",
5859
- "value_allowed_null": true
5930
+ "value_allowed_null": false
5860
5931
  },
5861
5932
  {
5862
5933
  "disabled": false,
@@ -5864,9 +5935,9 @@
5864
5935
  "example": "1",
5865
5936
  "member": "int64",
5866
5937
  "name": "ReservedWriteQps",
5867
- "required": true,
5938
+ "output_required": false,
5868
5939
  "type": "int",
5869
- "value_allowed_null": true
5940
+ "value_allowed_null": false
5870
5941
  },
5871
5942
  {
5872
5943
  "disabled": false,
@@ -5874,9 +5945,9 @@
5874
5945
  "example": "1",
5875
5946
  "member": "int64",
5876
5947
  "name": "TableSize",
5877
- "required": true,
5948
+ "output_required": false,
5878
5949
  "type": "int",
5879
- "value_allowed_null": true
5950
+ "value_allowed_null": false
5880
5951
  },
5881
5952
  {
5882
5953
  "disabled": false,
@@ -5884,9 +5955,9 @@
5884
5955
  "example": "1",
5885
5956
  "member": "string",
5886
5957
  "name": "Status",
5887
- "required": true,
5958
+ "output_required": false,
5888
5959
  "type": "string",
5889
- "value_allowed_null": true
5960
+ "value_allowed_null": false
5890
5961
  },
5891
5962
  {
5892
5963
  "disabled": false,
@@ -5894,9 +5965,9 @@
5894
5965
  "example": "1",
5895
5966
  "member": "string",
5896
5967
  "name": "CreatedTime",
5897
- "required": true,
5968
+ "output_required": false,
5898
5969
  "type": "string",
5899
- "value_allowed_null": true
5970
+ "value_allowed_null": false
5900
5971
  },
5901
5972
  {
5902
5973
  "disabled": false,
@@ -5904,9 +5975,9 @@
5904
5975
  "example": "1",
5905
5976
  "member": "string",
5906
5977
  "name": "UpdatedTime",
5907
- "required": true,
5978
+ "output_required": false,
5908
5979
  "type": "string",
5909
- "value_allowed_null": true
5980
+ "value_allowed_null": false
5910
5981
  },
5911
5982
  {
5912
5983
  "disabled": false,
@@ -5914,9 +5985,9 @@
5914
5985
  "example": "1",
5915
5986
  "member": "string",
5916
5987
  "name": "Memo",
5917
- "required": true,
5988
+ "output_required": false,
5918
5989
  "type": "string",
5919
- "value_allowed_null": true
5990
+ "value_allowed_null": false
5920
5991
  },
5921
5992
  {
5922
5993
  "disabled": false,
@@ -5924,9 +5995,9 @@
5924
5995
  "example": "1",
5925
5996
  "member": "ErrorInfo",
5926
5997
  "name": "Error",
5927
- "required": true,
5998
+ "output_required": false,
5928
5999
  "type": "object",
5929
- "value_allowed_null": true
6000
+ "value_allowed_null": false
5930
6001
  },
5931
6002
  {
5932
6003
  "disabled": false,
@@ -5934,9 +6005,9 @@
5934
6005
  "example": "1",
5935
6006
  "member": "string",
5936
6007
  "name": "ApiAccessId",
5937
- "required": true,
6008
+ "output_required": false,
5938
6009
  "type": "string",
5939
- "value_allowed_null": true
6010
+ "value_allowed_null": false
5940
6011
  },
5941
6012
  {
5942
6013
  "disabled": false,
@@ -5944,9 +6015,9 @@
5944
6015
  "example": "1",
5945
6016
  "member": "int64",
5946
6017
  "name": "SortFieldNum",
5947
- "required": true,
6018
+ "output_required": false,
5948
6019
  "type": "int",
5949
- "value_allowed_null": true
6020
+ "value_allowed_null": false
5950
6021
  },
5951
6022
  {
5952
6023
  "disabled": false,
@@ -5954,9 +6025,9 @@
5954
6025
  "example": "1",
5955
6026
  "member": "int64",
5956
6027
  "name": "SortRule",
5957
- "required": true,
6028
+ "output_required": false,
5958
6029
  "type": "int",
5959
- "value_allowed_null": true
6030
+ "value_allowed_null": false
5960
6031
  },
5961
6032
  {
5962
6033
  "disabled": false,
@@ -5964,9 +6035,9 @@
5964
6035
  "example": "1",
5965
6036
  "member": "string",
5966
6037
  "name": "DbClusterInfoStruct",
5967
- "required": true,
6038
+ "output_required": false,
5968
6039
  "type": "string",
5969
- "value_allowed_null": true
6040
+ "value_allowed_null": false
5970
6041
  },
5971
6042
  {
5972
6043
  "disabled": false,
@@ -5974,9 +6045,9 @@
5974
6045
  "example": "0",
5975
6046
  "member": "uint64",
5976
6047
  "name": "TxhBackupExpireDay",
5977
- "required": true,
6048
+ "output_required": false,
5978
6049
  "type": "int",
5979
- "value_allowed_null": true
6050
+ "value_allowed_null": false
5980
6051
  },
5981
6052
  {
5982
6053
  "disabled": false,
@@ -5984,9 +6055,9 @@
5984
6055
  "example": "无",
5985
6056
  "member": "SyncTableInfo",
5986
6057
  "name": "SyncTableInfo",
5987
- "required": true,
6058
+ "output_required": false,
5988
6059
  "type": "object",
5989
- "value_allowed_null": true
6060
+ "value_allowed_null": false
5990
6061
  }
5991
6062
  ],
5992
6063
  "usage": "out"
@@ -6000,9 +6071,9 @@
6000
6071
  "example": "0",
6001
6072
  "member": "string",
6002
6073
  "name": "TableInstanceId",
6003
- "required": true,
6074
+ "output_required": false,
6004
6075
  "type": "string",
6005
- "value_allowed_null": true
6076
+ "value_allowed_null": false
6006
6077
  },
6007
6078
  {
6008
6079
  "disabled": false,
@@ -6010,9 +6081,9 @@
6010
6081
  "example": "0",
6011
6082
  "member": "string",
6012
6083
  "name": "TaskId",
6013
- "required": true,
6084
+ "output_required": false,
6014
6085
  "type": "string",
6015
- "value_allowed_null": true
6086
+ "value_allowed_null": false
6016
6087
  },
6017
6088
  {
6018
6089
  "disabled": false,
@@ -6020,9 +6091,9 @@
6020
6091
  "example": "0",
6021
6092
  "member": "string",
6022
6093
  "name": "TableName",
6023
- "required": true,
6094
+ "output_required": false,
6024
6095
  "type": "string",
6025
- "value_allowed_null": true
6096
+ "value_allowed_null": false
6026
6097
  },
6027
6098
  {
6028
6099
  "disabled": false,
@@ -6030,9 +6101,9 @@
6030
6101
  "example": "0",
6031
6102
  "member": "string",
6032
6103
  "name": "TableType",
6033
- "required": true,
6104
+ "output_required": false,
6034
6105
  "type": "string",
6035
- "value_allowed_null": true
6106
+ "value_allowed_null": false
6036
6107
  },
6037
6108
  {
6038
6109
  "disabled": false,
@@ -6040,9 +6111,9 @@
6040
6111
  "example": "0",
6041
6112
  "member": "string",
6042
6113
  "name": "TableIdlType",
6043
- "required": true,
6114
+ "output_required": false,
6044
6115
  "type": "string",
6045
- "value_allowed_null": true
6116
+ "value_allowed_null": false
6046
6117
  },
6047
6118
  {
6048
6119
  "disabled": false,
@@ -6050,9 +6121,9 @@
6050
6121
  "example": "0",
6051
6122
  "member": "string",
6052
6123
  "name": "TableGroupId",
6053
- "required": true,
6124
+ "output_required": false,
6054
6125
  "type": "string",
6055
- "value_allowed_null": true
6126
+ "value_allowed_null": false
6056
6127
  },
6057
6128
  {
6058
6129
  "disabled": false,
@@ -6060,9 +6131,9 @@
6060
6131
  "example": "0",
6061
6132
  "member": "ErrorInfo",
6062
6133
  "name": "Error",
6063
- "required": true,
6134
+ "output_required": false,
6064
6135
  "type": "object",
6065
- "value_allowed_null": true
6136
+ "value_allowed_null": false
6066
6137
  },
6067
6138
  {
6068
6139
  "disabled": false,
@@ -6070,9 +6141,9 @@
6070
6141
  "example": "0",
6071
6142
  "member": "string",
6072
6143
  "name": "TaskIds",
6073
- "required": true,
6144
+ "output_required": false,
6074
6145
  "type": "list",
6075
- "value_allowed_null": true
6146
+ "value_allowed_null": false
6076
6147
  },
6077
6148
  {
6078
6149
  "disabled": false,
@@ -6080,9 +6151,9 @@
6080
6151
  "example": "0",
6081
6152
  "member": "string",
6082
6153
  "name": "ApplicationId",
6083
- "required": true,
6154
+ "output_required": false,
6084
6155
  "type": "string",
6085
- "value_allowed_null": true
6156
+ "value_allowed_null": false
6086
6157
  }
6087
6158
  ],
6088
6159
  "usage": "out"
@@ -6093,112 +6164,112 @@
6093
6164
  {
6094
6165
  "disabled": false,
6095
6166
  "document": "Table instance ID in the format of `tcaplus-3be64cbb`\nNote: this field may return null, indicating that no valid values can be obtained.",
6096
- "example": "",
6167
+ "example": "120123",
6097
6168
  "member": "string",
6098
6169
  "name": "TableInstanceId",
6099
- "required": true,
6170
+ "output_required": false,
6100
6171
  "type": "string",
6101
- "value_allowed_null": true
6172
+ "value_allowed_null": false
6102
6173
  },
6103
6174
  {
6104
6175
  "disabled": false,
6105
6176
  "document": "Task ID, which is valid for the API that creates one task\nNote: this field may return null, indicating that no valid values can be obtained.",
6106
- "example": "",
6177
+ "example": "176768",
6107
6178
  "member": "string",
6108
6179
  "name": "TaskId",
6109
- "required": true,
6180
+ "output_required": false,
6110
6181
  "type": "string",
6111
- "value_allowed_null": true
6182
+ "value_allowed_null": false
6112
6183
  },
6113
6184
  {
6114
6185
  "disabled": false,
6115
6186
  "document": "Table name\nNote: this field may return null, indicating that no valid values can be obtained.",
6116
- "example": "",
6187
+ "example": "testname",
6117
6188
  "member": "string",
6118
6189
  "name": "TableName",
6119
- "required": true,
6190
+ "output_required": false,
6120
6191
  "type": "string",
6121
- "value_allowed_null": true
6192
+ "value_allowed_null": false
6122
6193
  },
6123
6194
  {
6124
6195
  "disabled": false,
6125
6196
  "document": "Table data structure type, such as `GENERIC` or `LIST`\nNote: this field may return null, indicating that no valid values can be obtained.",
6126
- "example": "",
6197
+ "example": "1",
6127
6198
  "member": "string",
6128
6199
  "name": "TableType",
6129
- "required": true,
6200
+ "output_required": false,
6130
6201
  "type": "string",
6131
- "value_allowed_null": true
6202
+ "value_allowed_null": false
6132
6203
  },
6133
6204
  {
6134
6205
  "disabled": false,
6135
6206
  "document": "Table data interface description language (IDL) type, such as `PROTO` or `TDR`\nNote: this field may return null, indicating that no valid values can be obtained.",
6136
- "example": "",
6207
+ "example": "1",
6137
6208
  "member": "string",
6138
6209
  "name": "TableIdlType",
6139
- "required": true,
6210
+ "output_required": false,
6140
6211
  "type": "string",
6141
- "value_allowed_null": true
6212
+ "value_allowed_null": false
6142
6213
  },
6143
6214
  {
6144
6215
  "disabled": false,
6145
6216
  "document": "ID of the table group where a table resides\nNote: this field may return null, indicating that no valid values can be obtained.",
6146
- "example": "",
6217
+ "example": "15323",
6147
6218
  "member": "string",
6148
6219
  "name": "TableGroupId",
6149
- "required": true,
6220
+ "output_required": false,
6150
6221
  "type": "string",
6151
- "value_allowed_null": true
6222
+ "value_allowed_null": false
6152
6223
  },
6153
6224
  {
6154
6225
  "disabled": false,
6155
6226
  "document": "Error message\nNote: this field may return null, indicating that no valid values can be obtained.",
6156
- "example": "",
6227
+ "example": "{}",
6157
6228
  "member": "ErrorInfo",
6158
6229
  "name": "Error",
6159
- "required": true,
6230
+ "output_required": false,
6160
6231
  "type": "object",
6161
- "value_allowed_null": true
6232
+ "value_allowed_null": false
6162
6233
  },
6163
6234
  {
6164
6235
  "disabled": false,
6165
6236
  "document": "Task ID list, which is valid for the API that creates multiple tasks\nNote: this field may return null, indicating that no valid values can be obtained.",
6166
- "example": "",
6237
+ "example": "1587678",
6167
6238
  "member": "string",
6168
6239
  "name": "TaskIds",
6169
- "required": true,
6240
+ "output_required": false,
6170
6241
  "type": "list",
6171
- "value_allowed_null": true
6242
+ "value_allowed_null": false
6172
6243
  },
6173
6244
  {
6174
6245
  "disabled": false,
6175
6246
  "document": "ID of uploaded key file\nNote: this field may return null, indicating that no valid values can be obtained.",
6176
- "example": "",
6247
+ "example": "1",
6177
6248
  "member": "string",
6178
6249
  "name": "FileId",
6179
- "required": true,
6250
+ "output_required": false,
6180
6251
  "type": "string",
6181
- "value_allowed_null": true
6252
+ "value_allowed_null": false
6182
6253
  },
6183
6254
  {
6184
6255
  "disabled": false,
6185
6256
  "document": "Number of keys successfully verified\nNote: this field may return null, indicating that no valid values can be obtained.",
6186
- "example": "",
6257
+ "example": "10",
6187
6258
  "member": "uint64",
6188
6259
  "name": "SuccKeyNum",
6189
- "required": true,
6260
+ "output_required": false,
6190
6261
  "type": "int",
6191
- "value_allowed_null": true
6262
+ "value_allowed_null": false
6192
6263
  },
6193
6264
  {
6194
6265
  "disabled": false,
6195
6266
  "document": "Total number of keys contained in key file\nNote: this field may return null, indicating that no valid values can be obtained.",
6196
- "example": "",
6267
+ "example": "10",
6197
6268
  "member": "uint64",
6198
6269
  "name": "TotalKeyNum",
6199
- "required": true,
6270
+ "output_required": false,
6200
6271
  "type": "int",
6201
- "value_allowed_null": true
6272
+ "value_allowed_null": false
6202
6273
  }
6203
6274
  ],
6204
6275
  "usage": "out"
@@ -6209,9 +6280,10 @@
6209
6280
  {
6210
6281
  "disabled": false,
6211
6282
  "document": "Tag key",
6212
- "example": "",
6283
+ "example": "tagkey",
6213
6284
  "member": "string",
6214
6285
  "name": "TagKey",
6286
+ "output_required": true,
6215
6287
  "required": true,
6216
6288
  "type": "string",
6217
6289
  "value_allowed_null": false
@@ -6219,12 +6291,13 @@
6219
6291
  {
6220
6292
  "disabled": false,
6221
6293
  "document": "Tag value",
6222
- "example": "",
6294
+ "example": "tagvalue",
6223
6295
  "member": "string",
6224
6296
  "name": "TagValue",
6297
+ "output_required": false,
6225
6298
  "required": false,
6226
6299
  "type": "string",
6227
- "value_allowed_null": true
6300
+ "value_allowed_null": false
6228
6301
  }
6229
6302
  ],
6230
6303
  "usage": "both"
@@ -6235,32 +6308,32 @@
6235
6308
  {
6236
6309
  "disabled": false,
6237
6310
  "document": "Cluster ID",
6238
- "example": "",
6311
+ "example": "1875657",
6239
6312
  "member": "string",
6240
6313
  "name": "ClusterId",
6241
- "required": true,
6314
+ "output_required": false,
6242
6315
  "type": "string",
6243
- "value_allowed_null": true
6316
+ "value_allowed_null": false
6244
6317
  },
6245
6318
  {
6246
6319
  "disabled": false,
6247
6320
  "document": "Tag information",
6248
- "example": "",
6321
+ "example": "{}",
6249
6322
  "member": "TagInfoUnit",
6250
6323
  "name": "Tags",
6251
- "required": true,
6324
+ "output_required": false,
6252
6325
  "type": "list",
6253
- "value_allowed_null": true
6326
+ "value_allowed_null": false
6254
6327
  },
6255
6328
  {
6256
6329
  "disabled": false,
6257
6330
  "document": "Error message",
6258
- "example": "",
6331
+ "example": "{}",
6259
6332
  "member": "ErrorInfo",
6260
6333
  "name": "Error",
6261
- "required": true,
6334
+ "output_required": false,
6262
6335
  "type": "object",
6263
- "value_allowed_null": true
6336
+ "value_allowed_null": false
6264
6337
  }
6265
6338
  ],
6266
6339
  "usage": "out"
@@ -6271,52 +6344,52 @@
6271
6344
  {
6272
6345
  "disabled": false,
6273
6346
  "document": "Table instance ID",
6274
- "example": "",
6347
+ "example": "tcaplus-2221",
6275
6348
  "member": "string",
6276
6349
  "name": "TableInstanceId",
6277
- "required": true,
6350
+ "output_required": false,
6278
6351
  "type": "string",
6279
- "value_allowed_null": true
6352
+ "value_allowed_null": false
6280
6353
  },
6281
6354
  {
6282
6355
  "disabled": false,
6283
6356
  "document": "Table name",
6284
- "example": "",
6357
+ "example": "testname",
6285
6358
  "member": "string",
6286
6359
  "name": "TableName",
6287
- "required": true,
6360
+ "output_required": false,
6288
6361
  "type": "string",
6289
- "value_allowed_null": true
6362
+ "value_allowed_null": false
6290
6363
  },
6291
6364
  {
6292
6365
  "disabled": false,
6293
6366
  "document": "Table group ID",
6294
- "example": "",
6367
+ "example": "31231",
6295
6368
  "member": "string",
6296
6369
  "name": "TableGroupId",
6297
- "required": true,
6370
+ "output_required": false,
6298
6371
  "type": "string",
6299
- "value_allowed_null": true
6372
+ "value_allowed_null": false
6300
6373
  },
6301
6374
  {
6302
6375
  "disabled": false,
6303
6376
  "document": "Tag information",
6304
- "example": "",
6377
+ "example": "{}",
6305
6378
  "member": "TagInfoUnit",
6306
6379
  "name": "Tags",
6307
- "required": true,
6380
+ "output_required": false,
6308
6381
  "type": "list",
6309
- "value_allowed_null": true
6382
+ "value_allowed_null": false
6310
6383
  },
6311
6384
  {
6312
6385
  "disabled": false,
6313
6386
  "document": "Error message",
6314
- "example": "",
6387
+ "example": "{}",
6315
6388
  "member": "ErrorInfo",
6316
6389
  "name": "Error",
6317
- "required": true,
6390
+ "output_required": false,
6318
6391
  "type": "object",
6319
- "value_allowed_null": true
6392
+ "value_allowed_null": false
6320
6393
  }
6321
6394
  ],
6322
6395
  "usage": "out"
@@ -6327,42 +6400,42 @@
6327
6400
  {
6328
6401
  "disabled": false,
6329
6402
  "document": "Cluster ID",
6330
- "example": "",
6403
+ "example": "189787",
6331
6404
  "member": "string",
6332
6405
  "name": "ClusterId",
6333
- "required": true,
6406
+ "output_required": false,
6334
6407
  "type": "string",
6335
- "value_allowed_null": true
6408
+ "value_allowed_null": false
6336
6409
  },
6337
6410
  {
6338
6411
  "disabled": false,
6339
6412
  "document": "Table group ID",
6340
- "example": "",
6413
+ "example": "176565",
6341
6414
  "member": "string",
6342
6415
  "name": "TableGroupId",
6343
- "required": true,
6416
+ "output_required": false,
6344
6417
  "type": "string",
6345
- "value_allowed_null": true
6418
+ "value_allowed_null": false
6346
6419
  },
6347
6420
  {
6348
6421
  "disabled": false,
6349
6422
  "document": "Tag information",
6350
- "example": "",
6423
+ "example": "{}",
6351
6424
  "member": "TagInfoUnit",
6352
6425
  "name": "Tags",
6353
- "required": true,
6426
+ "output_required": false,
6354
6427
  "type": "list",
6355
- "value_allowed_null": true
6428
+ "value_allowed_null": false
6356
6429
  },
6357
6430
  {
6358
6431
  "disabled": false,
6359
6432
  "document": "Error message",
6360
- "example": "",
6433
+ "example": "{}",
6361
6434
  "member": "ErrorInfo",
6362
6435
  "name": "Error",
6363
- "required": true,
6436
+ "output_required": false,
6364
6437
  "type": "object",
6365
- "value_allowed_null": true
6438
+ "value_allowed_null": false
6366
6439
  }
6367
6440
  ],
6368
6441
  "usage": "out"
@@ -6373,100 +6446,100 @@
6373
6446
  {
6374
6447
  "disabled": false,
6375
6448
  "document": "Task ID",
6376
- "example": "",
6449
+ "example": "1765447",
6377
6450
  "member": "string",
6378
6451
  "name": "TaskId",
6379
- "required": true,
6452
+ "output_required": true,
6380
6453
  "type": "string",
6381
6454
  "value_allowed_null": false
6382
6455
  },
6383
6456
  {
6384
6457
  "disabled": false,
6385
6458
  "document": "Task type",
6386
- "example": "",
6459
+ "example": "1",
6387
6460
  "member": "string",
6388
6461
  "name": "TaskType",
6389
- "required": true,
6462
+ "output_required": true,
6390
6463
  "type": "string",
6391
6464
  "value_allowed_null": false
6392
6465
  },
6393
6466
  {
6394
6467
  "disabled": false,
6395
6468
  "document": "ID of TcaplusDB internal transaction associated with task",
6396
- "example": "",
6469
+ "example": "46563",
6397
6470
  "member": "string",
6398
6471
  "name": "TransId",
6399
- "required": true,
6472
+ "output_required": true,
6400
6473
  "type": "string",
6401
6474
  "value_allowed_null": false
6402
6475
  },
6403
6476
  {
6404
6477
  "disabled": false,
6405
6478
  "document": "ID of the cluster where a task resides",
6406
- "example": "",
6479
+ "example": "1865765",
6407
6480
  "member": "string",
6408
6481
  "name": "ClusterId",
6409
- "required": true,
6482
+ "output_required": true,
6410
6483
  "type": "string",
6411
6484
  "value_allowed_null": false
6412
6485
  },
6413
6486
  {
6414
6487
  "disabled": false,
6415
6488
  "document": "Name of the cluster where a task resides",
6416
- "example": "",
6489
+ "example": "clustername",
6417
6490
  "member": "string",
6418
6491
  "name": "ClusterName",
6419
- "required": true,
6492
+ "output_required": true,
6420
6493
  "type": "string",
6421
6494
  "value_allowed_null": false
6422
6495
  },
6423
6496
  {
6424
6497
  "disabled": false,
6425
6498
  "document": "Task progress",
6426
- "example": "",
6499
+ "example": "100",
6427
6500
  "member": "int64",
6428
6501
  "name": "Progress",
6429
- "required": true,
6502
+ "output_required": true,
6430
6503
  "type": "int",
6431
6504
  "value_allowed_null": false
6432
6505
  },
6433
6506
  {
6434
6507
  "disabled": false,
6435
6508
  "document": "Task creation time",
6436
- "example": "",
6509
+ "example": "20231010",
6437
6510
  "member": "datetime",
6438
6511
  "name": "StartTime",
6439
- "required": true,
6512
+ "output_required": true,
6440
6513
  "type": "string",
6441
6514
  "value_allowed_null": false
6442
6515
  },
6443
6516
  {
6444
6517
  "disabled": false,
6445
6518
  "document": "Task last modified time",
6446
- "example": "",
6519
+ "example": "20231010",
6447
6520
  "member": "datetime",
6448
6521
  "name": "UpdateTime",
6449
- "required": true,
6522
+ "output_required": true,
6450
6523
  "type": "string",
6451
6524
  "value_allowed_null": false
6452
6525
  },
6453
6526
  {
6454
6527
  "disabled": false,
6455
6528
  "document": "Operator",
6456
- "example": "",
6529
+ "example": "operator",
6457
6530
  "member": "string",
6458
6531
  "name": "Operator",
6459
- "required": true,
6532
+ "output_required": true,
6460
6533
  "type": "string",
6461
6534
  "value_allowed_null": false
6462
6535
  },
6463
6536
  {
6464
6537
  "disabled": false,
6465
6538
  "document": "Task details",
6466
- "example": "",
6539
+ "example": "createtable",
6467
6540
  "member": "string",
6468
6541
  "name": "Content",
6469
- "required": true,
6542
+ "output_required": true,
6470
6543
  "type": "string",
6471
6544
  "value_allowed_null": false
6472
6545
  }
@@ -6497,9 +6570,9 @@
6497
6570
  "example": "无",
6498
6571
  "member": "ApplyResult",
6499
6572
  "name": "ApplyResults",
6500
- "required": true,
6573
+ "output_required": false,
6501
6574
  "type": "list",
6502
- "value_allowed_null": true
6575
+ "value_allowed_null": false
6503
6576
  },
6504
6577
  {
6505
6578
  "disabled": false,
@@ -6507,7 +6580,7 @@
6507
6580
  "example": "0",
6508
6581
  "member": "uint64",
6509
6582
  "name": "TotalCount",
6510
- "required": true,
6583
+ "output_required": true,
6511
6584
  "type": "int",
6512
6585
  "value_allowed_null": false
6513
6586
  },
@@ -6526,7 +6599,7 @@
6526
6599
  {
6527
6600
  "disabled": false,
6528
6601
  "document": "ID of the cluster where to create a table",
6529
- "example": "",
6602
+ "example": "176567",
6530
6603
  "member": "string",
6531
6604
  "name": "ClusterId",
6532
6605
  "required": true,
@@ -6535,7 +6608,7 @@
6535
6608
  {
6536
6609
  "disabled": false,
6537
6610
  "document": "ID of the table group where to create a table",
6538
- "example": "",
6611
+ "example": "15452",
6539
6612
  "member": "string",
6540
6613
  "name": "TableGroupId",
6541
6614
  "required": false,
@@ -6544,7 +6617,7 @@
6544
6617
  {
6545
6618
  "disabled": false,
6546
6619
  "document": "List of information of uploaded IDL files. Either this parameter or `NewIdlFiles` must be present",
6547
- "example": "",
6620
+ "example": "{}",
6548
6621
  "member": "IdlFileInfo",
6549
6622
  "name": "ExistingIdlFiles",
6550
6623
  "required": false,
@@ -6553,7 +6626,7 @@
6553
6626
  {
6554
6627
  "disabled": false,
6555
6628
  "document": "List of information of IDL files to be uploaded. Either this parameter or `ExistingIdlFiles` must be present",
6556
- "example": "",
6629
+ "example": "{}",
6557
6630
  "member": "IdlFileInfo",
6558
6631
  "name": "NewIdlFiles",
6559
6632
  "required": false,
@@ -6568,27 +6641,30 @@
6568
6641
  {
6569
6642
  "disabled": false,
6570
6643
  "document": "Information list of all IDL files uploaded and verified in this request",
6571
- "example": "",
6644
+ "example": "{}",
6572
6645
  "member": "IdlFileInfo",
6573
6646
  "name": "IdlFiles",
6647
+ "output_required": true,
6574
6648
  "type": "list",
6575
6649
  "value_allowed_null": false
6576
6650
  },
6577
6651
  {
6578
6652
  "disabled": false,
6579
6653
  "document": "Number of valid tables parsed by reading IDL description file, excluding tables already created",
6580
- "example": "",
6654
+ "example": "2",
6581
6655
  "member": "uint64",
6582
6656
  "name": "TotalCount",
6657
+ "output_required": true,
6583
6658
  "type": "int",
6584
6659
  "value_allowed_null": false
6585
6660
  },
6586
6661
  {
6587
6662
  "disabled": false,
6588
6663
  "document": "List of valid tables parsed by reading IDL description file, excluding tables already created",
6589
- "example": "",
6664
+ "example": "{}",
6590
6665
  "member": "ParsedTableInfoNew",
6591
6666
  "name": "TableInfos",
6667
+ "output_required": true,
6592
6668
  "type": "list",
6593
6669
  "value_allowed_null": false
6594
6670
  },