tccli-intl-en 3.0.1282.1__py2.py3-none-any.whl → 3.1.33.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/argument.py +1 -1
- tccli/services/__init__.py +15 -0
- tccli/services/advisor/advisor_client.py +2 -2
- tccli/services/ai3d/__init__.py +4 -0
- tccli/services/ai3d/ai3d_client.py +266 -0
- tccli/services/ai3d/v20250513/api.json +264 -0
- tccli/services/ai3d/v20250513/examples.json +20 -0
- tccli/services/aiart/aiart_client.py +1 -1
- tccli/services/ams/ams_client.py +4 -4
- tccli/services/antiddos/antiddos_client.py +70 -70
- tccli/services/apigateway/apigateway_client.py +93 -93
- tccli/services/apm/apm_client.py +783 -55
- tccli/services/apm/v20210622/api.json +3936 -1145
- tccli/services/apm/v20210622/examples.json +133 -23
- tccli/services/asr/asr_client.py +2 -2
- tccli/services/autoscaling/autoscaling_client.py +58 -58
- tccli/services/autoscaling/v20180419/api.json +77 -27
- tccli/services/batch/batch_client.py +28 -28
- tccli/services/bi/bi_client.py +24 -24
- tccli/services/billing/billing_client.py +42 -42
- tccli/services/cam/cam_client.py +81 -81
- tccli/services/captcha/captcha_client.py +1 -1
- tccli/services/car/car_client.py +33 -33
- tccli/services/cbs/cbs_client.py +38 -38
- tccli/services/ccc/ccc_client.py +70 -70
- tccli/services/ccc/v20200210/api.json +71 -26
- tccli/services/cdb/cdb_client.py +1262 -422
- tccli/services/cdb/v20170320/api.json +2166 -335
- tccli/services/cdb/v20170320/examples.json +126 -6
- tccli/services/cdc/cdc_client.py +20 -20
- tccli/services/cdn/cdn_client.py +44 -44
- tccli/services/cdn/v20180606/api.json +22 -22
- tccli/services/cdn/v20180606/examples.json +1 -1
- tccli/services/cdwdoris/cdwdoris_client.py +77 -77
- tccli/services/cdwpg/cdwpg_client.py +24 -24
- tccli/services/cdz/cdz_client.py +1 -1
- tccli/services/cfg/cfg_client.py +16 -16
- tccli/services/cfs/cfs_client.py +39 -39
- tccli/services/cfw/cfw_client.py +66 -66
- tccli/services/chdfs/chdfs_client.py +29 -29
- tccli/services/ciam/ciam_client.py +16 -16
- tccli/services/ckafka/ckafka_client.py +468 -76
- tccli/services/ckafka/v20190819/api.json +1009 -246
- tccli/services/ckafka/v20190819/examples.json +73 -23
- tccli/services/clb/clb_client.py +720 -384
- tccli/services/clb/v20180317/api.json +2255 -1017
- tccli/services/clb/v20180317/examples.json +184 -124
- tccli/services/cloudaudit/cloudaudit_client.py +18 -18
- tccli/services/cls/cls_client.py +86 -86
- tccli/services/cmq/cmq_client.py +2 -2
- tccli/services/config/config_client.py +6 -6
- tccli/services/controlcenter/controlcenter_client.py +225 -1
- tccli/services/controlcenter/v20230110/api.json +528 -5
- tccli/services/controlcenter/v20230110/examples.json +32 -0
- tccli/services/csip/csip_client.py +34 -34
- tccli/services/ctsdb/ctsdb_client.py +2 -2
- tccli/services/cvm/cvm_client.py +84 -84
- tccli/services/cvm/v20170312/api.json +175 -116
- tccli/services/cvm/v20170312/examples.json +93 -93
- tccli/services/cwp/cwp_client.py +465 -465
- tccli/services/cynosdb/cynosdb_client.py +154 -154
- tccli/services/dataintegration/dataintegration_client.py +1 -1
- tccli/services/dayu/dayu_client.py +103 -103
- tccli/services/dbbrain/dbbrain_client.py +42 -42
- tccli/services/dc/dc_client.py +18 -18
- tccli/services/dcdb/dcdb_client.py +62 -62
- tccli/services/dlc/dlc_client.py +109 -109
- tccli/services/dms/dms_client.py +2 -2
- tccli/services/dnspod/dnspod_client.py +40 -40
- tccli/services/domain/domain_client.py +24 -24
- tccli/services/dts/dts_client.py +83 -83
- tccli/services/eb/eb_client.py +26 -26
- tccli/services/ecdn/ecdn_client.py +15 -15
- tccli/services/ecm/ecm_client.py +124 -124
- tccli/services/eiam/eiam_client.py +40 -40
- tccli/services/emr/emr_client.py +77 -77
- tccli/services/emr/v20190103/api.json +6 -6
- tccli/services/es/es_client.py +21 -21
- tccli/services/facefusion/facefusion_client.py +3 -3
- tccli/services/faceid/faceid_client.py +19 -19
- tccli/services/faceid/v20180301/api.json +124 -46
- tccli/services/gaap/gaap_client.py +88 -88
- tccli/services/gme/gme_client.py +10 -10
- tccli/services/gpm/gpm_client.py +18 -18
- tccli/services/gse/gse_client.py +22 -22
- tccli/services/gwlb/gwlb_client.py +18 -18
- tccli/services/hunyuan/__init__.py +4 -0
- tccli/services/hunyuan/hunyuan_client.py +546 -0
- tccli/services/hunyuan/v20230901/api.json +628 -0
- tccli/services/hunyuan/v20230901/examples.json +60 -0
- tccli/services/iai/iai_client.py +29 -29
- tccli/services/iap/iap_client.py +6 -6
- tccli/services/ims/ims_client.py +1 -1
- tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +42 -42
- tccli/services/iotcloud/iotcloud_client.py +20 -20
- tccli/services/ip/ip_client.py +6 -6
- tccli/services/kms/kms_client.py +68 -68
- tccli/services/kms/v20190118/api.json +80 -3
- tccli/services/kms/v20190118/examples.json +3 -3
- tccli/services/lcic/lcic_client.py +53 -53
- tccli/services/lighthouse/lighthouse_client.py +434 -98
- tccli/services/lighthouse/v20200324/api.json +488 -0
- tccli/services/lighthouse/v20200324/examples.json +54 -0
- tccli/services/live/live_client.py +120 -120
- tccli/services/lke/lke_client.py +90 -90
- tccli/services/lkeap/lkeap_client.py +63 -7
- tccli/services/lkeap/v20240522/api.json +134 -0
- tccli/services/lkeap/v20240522/examples.json +21 -1
- tccli/services/mariadb/mariadb_client.py +50 -50
- tccli/services/mdc/mdc_client.py +18 -18
- tccli/services/mdl/mdl_client.py +225 -57
- tccli/services/mdl/v20200326/api.json +903 -59
- tccli/services/mdl/v20200326/examples.json +24 -0
- tccli/services/mdp/mdp_client.py +62 -62
- tccli/services/mdp/v20200527/api.json +191 -28
- tccli/services/message/message_client.py +1 -1
- tccli/services/mongodb/mongodb_client.py +1081 -129
- tccli/services/mongodb/v20190725/api.json +1798 -141
- tccli/services/mongodb/v20190725/examples.json +136 -0
- tccli/services/monitor/monitor_client.py +149 -149
- tccli/services/monitor/v20180724/api.json +8 -8
- tccli/services/mps/mps_client.py +1118 -278
- tccli/services/mps/v20190612/api.json +2117 -117
- tccli/services/mps/v20190612/examples.json +164 -62
- tccli/services/mqtt/__init__.py +4 -0
- tccli/services/mqtt/mqtt_client.py +1610 -0
- tccli/services/mqtt/v20240516/api.json +3057 -0
- tccli/services/mqtt/v20240516/examples.json +213 -0
- tccli/services/msp/msp_client.py +7 -7
- tccli/services/ocr/ocr_client.py +206 -38
- tccli/services/ocr/v20181119/api.json +726 -83
- tccli/services/ocr/v20181119/examples.json +36 -6
- tccli/services/omics/omics_client.py +20 -20
- tccli/services/organization/organization_client.py +116 -116
- tccli/services/postgres/postgres_client.py +91 -91
- tccli/services/privatedns/privatedns_client.py +31 -31
- tccli/services/pts/pts_client.py +48 -48
- tccli/services/quota/quota_client.py +5 -5
- tccli/services/rce/rce_client.py +1 -1
- tccli/services/redis/redis_client.py +109 -109
- tccli/services/redis/v20180412/api.json +12 -12
- tccli/services/region/region_client.py +3 -3
- tccli/services/rum/rum_client.py +60 -60
- tccli/services/scf/scf_client.py +42 -42
- tccli/services/ses/ses_client.py +29 -29
- tccli/services/smh/__init__.py +4 -0
- tccli/services/smh/smh_client.py +714 -0
- tccli/services/smh/v20210712/api.json +1287 -0
- tccli/services/smh/v20210712/examples.json +85 -0
- tccli/services/sms/sms_client.py +18 -18
- tccli/services/sqlserver/sqlserver_client.py +139 -139
- tccli/services/ssl/ssl_client.py +38 -38
- tccli/services/ssm/ssm_client.py +24 -24
- tccli/services/sts/sts_client.py +5 -5
- tccli/services/tag/tag_client.py +30 -30
- tccli/services/tat/tat_client.py +19 -19
- tccli/services/tbaas/tbaas_client.py +4 -4
- tccli/services/tcaplusdb/tcaplusdb_client.py +52 -52
- tccli/services/tchd/tchd_client.py +1 -1
- tccli/services/tcmpp/tcmpp_client.py +104 -104
- tccli/services/tcr/tcr_client.py +76 -76
- tccli/services/tcsas/tcsas_client.py +2340 -268
- tccli/services/tcsas/v20250106/api.json +8410 -3423
- tccli/services/tcsas/v20250106/examples.json +308 -12
- tccli/services/tcss/tcss_client.py +330 -330
- tccli/services/tdid/tdid_client.py +48 -48
- tccli/services/tdmq/tdmq_client.py +2500 -372
- tccli/services/tdmq/v20200217/api.json +11607 -3958
- tccli/services/tdmq/v20200217/examples.json +562 -264
- tccli/services/tem/tem_client.py +56 -56
- tccli/services/teo/teo_client.py +466 -298
- tccli/services/teo/v20220901/api.json +324 -16
- tccli/services/teo/v20220901/examples.json +64 -22
- tccli/services/tione/tione_client.py +1 -1
- tccli/services/tiw/tiw_client.py +51 -51
- tccli/services/tke/tke_client.py +306 -138
- tccli/services/tke/v20180525/api.json +227 -0
- tccli/services/tke/v20180525/examples.json +24 -0
- tccli/services/tms/tms_client.py +1 -1
- tccli/services/tmt/tmt_client.py +1 -1
- tccli/services/trabbit/trabbit_client.py +29 -29
- tccli/services/trocket/__init__.py +4 -0
- tccli/services/trocket/trocket_client.py +2450 -0
- tccli/services/trocket/v20230308/api.json +6062 -0
- tccli/services/trocket/v20230308/examples.json +339 -0
- tccli/services/trro/trro_client.py +19 -19
- tccli/services/trtc/trtc_client.py +51 -51
- tccli/services/trtc/v20190722/api.json +15 -15
- tccli/services/tts/tts_client.py +1 -1
- tccli/services/vclm/vclm_client.py +2 -2
- tccli/services/vm/vm_client.py +4 -4
- tccli/services/vod/v20180717/api.json +2929 -296
- tccli/services/vod/v20180717/examples.json +40 -6
- tccli/services/vod/vod_client.py +459 -179
- tccli/services/vpc/v20170312/api.json +99 -29
- tccli/services/vpc/v20170312/examples.json +21 -13
- tccli/services/vpc/vpc_client.py +357 -301
- tccli/services/waf/waf_client.py +107 -107
- tccli/services/wedata/wedata_client.py +310 -310
- tccli/services/yunjing/yunjing_client.py +71 -71
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/METADATA +2 -2
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/RECORD +207 -187
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/WHEEL +1 -1
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/LICENSE +0 -0
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/entry_points.txt +0 -0
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/top_level.txt +0 -0
|
@@ -105,6 +105,27 @@
|
|
|
105
105
|
"output": "DeleteAclResponse",
|
|
106
106
|
"status": "online"
|
|
107
107
|
},
|
|
108
|
+
"DeleteAclRule": {
|
|
109
|
+
"document": "This API is used to delete an ACL rule.",
|
|
110
|
+
"input": "DeleteAclRuleRequest",
|
|
111
|
+
"name": "Delete ACL rule",
|
|
112
|
+
"output": "DeleteAclRuleResponse",
|
|
113
|
+
"status": "online"
|
|
114
|
+
},
|
|
115
|
+
"DeleteGroup": {
|
|
116
|
+
"document": "Delete consumer groups.",
|
|
117
|
+
"input": "DeleteGroupRequest",
|
|
118
|
+
"name": "Delete consumer groups.",
|
|
119
|
+
"output": "DeleteGroupResponse",
|
|
120
|
+
"status": "online"
|
|
121
|
+
},
|
|
122
|
+
"DeleteGroupSubscribeTopic": {
|
|
123
|
+
"document": "This API is used to delete topics subscribed by a consumption group. The consumption group status must be Empty.",
|
|
124
|
+
"input": "DeleteGroupSubscribeTopicRequest",
|
|
125
|
+
"name": "Delete the topic subscribed by the consumption group",
|
|
126
|
+
"output": "DeleteGroupSubscribeTopicResponse",
|
|
127
|
+
"status": "online"
|
|
128
|
+
},
|
|
108
129
|
"DeleteInstancePost": {
|
|
109
130
|
"document": "This API is used to delete post-payment instances. It directly performs instance termination by calling API deletion without associating connectors and tasks in pre-check.",
|
|
110
131
|
"input": "DeleteInstancePostRequest",
|
|
@@ -168,11 +189,11 @@
|
|
|
168
189
|
"output": "DescribeAclRuleResponse",
|
|
169
190
|
"status": "online"
|
|
170
191
|
},
|
|
171
|
-
"
|
|
172
|
-
"document": "This API is used to query
|
|
173
|
-
"input": "
|
|
174
|
-
"name": "
|
|
175
|
-
"output": "
|
|
192
|
+
"DescribeCkafkaVersion": {
|
|
193
|
+
"document": "This API is used to query instance version information.",
|
|
194
|
+
"input": "DescribeCkafkaVersionRequest",
|
|
195
|
+
"name": "Query instance version information",
|
|
196
|
+
"output": "DescribeCkafkaVersionResponse",
|
|
176
197
|
"status": "online"
|
|
177
198
|
},
|
|
178
199
|
"DescribeCkafkaZone": {
|
|
@@ -252,6 +273,13 @@
|
|
|
252
273
|
"output": "DescribeInstancesDetailResponse",
|
|
253
274
|
"status": "online"
|
|
254
275
|
},
|
|
276
|
+
"DescribeModifyType": {
|
|
277
|
+
"document": "This API is used to query instance specification change types.",
|
|
278
|
+
"input": "DescribeModifyTypeRequest",
|
|
279
|
+
"name": "Query the instance specification change type",
|
|
280
|
+
"output": "DescribeModifyTypeResponse",
|
|
281
|
+
"status": "online"
|
|
282
|
+
},
|
|
255
283
|
"DescribeRegion": {
|
|
256
284
|
"document": "This API is used to enumerate regions, and can be called only in Guangzhou.",
|
|
257
285
|
"input": "DescribeRegionRequest",
|
|
@@ -364,6 +392,13 @@
|
|
|
364
392
|
"output": "InquireCkafkaPriceResponse",
|
|
365
393
|
"status": "online"
|
|
366
394
|
},
|
|
395
|
+
"InstanceScalingDown": {
|
|
396
|
+
"document": "This API is used to perform downsizing on a pay-as-you-go instance.",
|
|
397
|
+
"input": "InstanceScalingDownRequest",
|
|
398
|
+
"name": "Scale a pay-as-you-go instance",
|
|
399
|
+
"output": "InstanceScalingDownResponse",
|
|
400
|
+
"status": "online"
|
|
401
|
+
},
|
|
367
402
|
"ModifyAclRule": {
|
|
368
403
|
"document": "This API is used to modify ACL policy, currently only support whether to apply preset rules to newly-added topics.",
|
|
369
404
|
"input": "ModifyAclRuleRequest",
|
|
@@ -406,6 +441,13 @@
|
|
|
406
441
|
"output": "ModifyPasswordResponse",
|
|
407
442
|
"status": "online"
|
|
408
443
|
},
|
|
444
|
+
"ModifyRoutineMaintenanceTask": {
|
|
445
|
+
"document": "This API is used to set automated ops attributes.",
|
|
446
|
+
"input": "ModifyRoutineMaintenanceTaskRequest",
|
|
447
|
+
"name": "Set automated ops attributes",
|
|
448
|
+
"output": "ModifyRoutineMaintenanceTaskResponse",
|
|
449
|
+
"status": "online"
|
|
450
|
+
},
|
|
409
451
|
"ModifyTopicAttributes": {
|
|
410
452
|
"document": "This API is used to modify topic attributes.",
|
|
411
453
|
"input": "ModifyTopicAttributesRequest",
|
|
@@ -419,6 +461,13 @@
|
|
|
419
461
|
"name": "Sends messages through the HTTP access layer",
|
|
420
462
|
"output": "SendMessageResponse",
|
|
421
463
|
"status": "online"
|
|
464
|
+
},
|
|
465
|
+
"UpgradeBrokerVersion": {
|
|
466
|
+
"document": "This API is used to upgrade the broker version.",
|
|
467
|
+
"input": "UpgradeBrokerVersionRequest",
|
|
468
|
+
"name": "Upgrade broker version API",
|
|
469
|
+
"output": "UpgradeBrokerVersionResponse",
|
|
470
|
+
"status": "online"
|
|
422
471
|
}
|
|
423
472
|
},
|
|
424
473
|
"metadata": {
|
|
@@ -723,32 +772,6 @@
|
|
|
723
772
|
],
|
|
724
773
|
"usage": "out"
|
|
725
774
|
},
|
|
726
|
-
"AppIdResponse": {
|
|
727
|
-
"document": "`AppId` query result",
|
|
728
|
-
"members": [
|
|
729
|
-
{
|
|
730
|
-
"disabled": false,
|
|
731
|
-
"document": "Number of eligible `AppId`",
|
|
732
|
-
"example": "1",
|
|
733
|
-
"member": "int64",
|
|
734
|
-
"name": "TotalCount",
|
|
735
|
-
"output_required": true,
|
|
736
|
-
"type": "int",
|
|
737
|
-
"value_allowed_null": false
|
|
738
|
-
},
|
|
739
|
-
{
|
|
740
|
-
"disabled": false,
|
|
741
|
-
"document": "Specifies the App Id list that meets the requirements.",
|
|
742
|
-
"example": "[1000000001]",
|
|
743
|
-
"member": "int64",
|
|
744
|
-
"name": "AppIdList",
|
|
745
|
-
"output_required": true,
|
|
746
|
-
"type": "list",
|
|
747
|
-
"value_allowed_null": false
|
|
748
|
-
}
|
|
749
|
-
],
|
|
750
|
-
"usage": "out"
|
|
751
|
-
},
|
|
752
775
|
"Assignment": {
|
|
753
776
|
"document": "Stores the information of partition assigned to this consumer",
|
|
754
777
|
"members": [
|
|
@@ -804,7 +827,7 @@
|
|
|
804
827
|
"members": [
|
|
805
828
|
{
|
|
806
829
|
"disabled": false,
|
|
807
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
830
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
808
831
|
"example": "ckafka-test",
|
|
809
832
|
"member": "string",
|
|
810
833
|
"name": "InstanceId",
|
|
@@ -822,7 +845,7 @@
|
|
|
822
845
|
},
|
|
823
846
|
{
|
|
824
847
|
"disabled": false,
|
|
825
|
-
"document": "Resource list array, obtainable through the DescribeTopic API (https://www.tencentcloud.
|
|
848
|
+
"document": "Resource list array, obtainable through the DescribeTopic API (https://www.tencentcloud.com/document/product/597/40847?from_cn_redirect=1).",
|
|
826
849
|
"example": "[\"test1\",\"test2\"]",
|
|
827
850
|
"member": "string",
|
|
828
851
|
"name": "ResourceNames",
|
|
@@ -831,7 +854,7 @@
|
|
|
831
854
|
},
|
|
832
855
|
{
|
|
833
856
|
"disabled": false,
|
|
834
|
-
"document": "Specifies the set ACL rule list, which can be obtained through the DescribeAclRule API (https://www.tencentcloud.
|
|
857
|
+
"document": "Specifies the set ACL rule list, which can be obtained through the DescribeAclRule API (https://www.tencentcloud.com/document/product/597/89217?from_cn_redirect=1).",
|
|
835
858
|
"example": "无",
|
|
836
859
|
"member": "AclRuleInfo",
|
|
837
860
|
"name": "RuleList",
|
|
@@ -932,7 +955,7 @@
|
|
|
932
955
|
"members": [
|
|
933
956
|
{
|
|
934
957
|
"disabled": false,
|
|
935
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
958
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
936
959
|
"example": "ckafka-test",
|
|
937
960
|
"member": "string",
|
|
938
961
|
"name": "InstanceId",
|
|
@@ -941,7 +964,7 @@
|
|
|
941
964
|
},
|
|
942
965
|
{
|
|
943
966
|
"disabled": false,
|
|
944
|
-
"document": "Specifies the topic attribute list (a maximum of 10 per batch), which can be obtained through the [DescribeTopic](https://www.tencentcloud.
|
|
967
|
+
"document": "Specifies the topic attribute list (a maximum of 10 per batch), which can be obtained through the [DescribeTopic](https://www.tencentcloud.com/document/product/597/40847?from_cn_redirect=1) api.",
|
|
945
968
|
"example": "无",
|
|
946
969
|
"member": "BatchModifyTopicInfo",
|
|
947
970
|
"name": "Topic",
|
|
@@ -1534,7 +1557,7 @@
|
|
|
1534
1557
|
"members": [
|
|
1535
1558
|
{
|
|
1536
1559
|
"disabled": false,
|
|
1537
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
1560
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
1538
1561
|
"example": "ckafka-test",
|
|
1539
1562
|
"member": "string",
|
|
1540
1563
|
"name": "InstanceId",
|
|
@@ -1634,7 +1657,7 @@
|
|
|
1634
1657
|
"members": [
|
|
1635
1658
|
{
|
|
1636
1659
|
"disabled": false,
|
|
1637
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
1660
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
1638
1661
|
"example": "ckafka-test",
|
|
1639
1662
|
"member": "string",
|
|
1640
1663
|
"name": "InstanceId",
|
|
@@ -1734,7 +1757,7 @@
|
|
|
1734
1757
|
"members": [
|
|
1735
1758
|
{
|
|
1736
1759
|
"disabled": false,
|
|
1737
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
1760
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
1738
1761
|
"example": "ckafka-test",
|
|
1739
1762
|
"member": "string",
|
|
1740
1763
|
"name": "InstanceId",
|
|
@@ -1999,7 +2022,7 @@
|
|
|
1999
2022
|
"members": [
|
|
2000
2023
|
{
|
|
2001
2024
|
"disabled": false,
|
|
2002
|
-
"document": "Specifies the ckafka cluster instance
|
|
2025
|
+
"document": "<p>Specifies the Name of the ckafka cluster instance, which is any string with a length not more than 128 characters.</p>.",
|
|
2003
2026
|
"example": "ckafka集群实例Name",
|
|
2004
2027
|
"member": "string",
|
|
2005
2028
|
"name": "InstanceName",
|
|
@@ -2008,7 +2031,7 @@
|
|
|
2008
2031
|
},
|
|
2009
2032
|
{
|
|
2010
2033
|
"disabled": false,
|
|
2011
|
-
"document": "Availability zone. when purchasing a multi-availability zone instance, this parameter specifies the primary az.
|
|
2034
|
+
"document": "<P>Availability zone. when purchasing a multi-availability zone instance, this parameter specifies the primary az. <a href=\"https://www.tencentcloud.com/document/product/597/55246?from_cn_redirect=1\">view availability zones</a></p>.",
|
|
2012
2035
|
"example": "100003",
|
|
2013
2036
|
"member": "int64",
|
|
2014
2037
|
"name": "ZoneId",
|
|
@@ -2017,7 +2040,7 @@
|
|
|
2017
2040
|
},
|
|
2018
2041
|
{
|
|
2019
2042
|
"disabled": false,
|
|
2020
|
-
"document": "
|
|
2043
|
+
"document": "<P>Specifies the prepaid purchase duration, such as \"1m\" (exactly one month). value ranges from 1m to 36m.</p>.",
|
|
2021
2044
|
"example": "1m",
|
|
2022
2045
|
"member": "string",
|
|
2023
2046
|
"name": "Period",
|
|
@@ -2026,7 +2049,7 @@
|
|
|
2026
2049
|
},
|
|
2027
2050
|
{
|
|
2028
2051
|
"disabled": false,
|
|
2029
|
-
"document": "Specifies the standard edition instance specification for the international site. currently only the international site
|
|
2052
|
+
"document": "<P>Specifies the standard edition instance specification for the international site. currently only the standard edition on the international site uses the current field to distinguish specifications, while the domestic site standard edition uses peak bandwidth. fill in 1 for all instances except the international site standard edition. for international site standard edition instances: [entry-level (general)] fill 1; [standard type (standard)] fill 2; [advanced] fill 3; [capacity type (capacity)] fill 4; [advanced type 1 (specialized-1)] fill 5; [advanced type 2 (specialized-2)] fill 6; [advanced type 3 (specialized-3)] fill 7; [advanced type 4 (specialized-4)] fill 8.</p>.",
|
|
2030
2053
|
"example": "1",
|
|
2031
2054
|
"member": "int64",
|
|
2032
2055
|
"name": "InstanceType",
|
|
@@ -2035,7 +2058,7 @@
|
|
|
2035
2058
|
},
|
|
2036
2059
|
{
|
|
2037
2060
|
"disabled": false,
|
|
2038
|
-
"document": "VPC Id
|
|
2061
|
+
"document": "<p>VPC Id.</p>.",
|
|
2039
2062
|
"example": "vpc-test",
|
|
2040
2063
|
"member": "string",
|
|
2041
2064
|
"name": "VpcId",
|
|
@@ -2044,7 +2067,7 @@
|
|
|
2044
2067
|
},
|
|
2045
2068
|
{
|
|
2046
2069
|
"disabled": false,
|
|
2047
|
-
"document": "Subnet
|
|
2070
|
+
"document": "<P>Subnet id.</p>.",
|
|
2048
2071
|
"example": "subnet-test",
|
|
2049
2072
|
"member": "string",
|
|
2050
2073
|
"name": "SubnetId",
|
|
@@ -2053,7 +2076,7 @@
|
|
|
2053
2076
|
},
|
|
2054
2077
|
{
|
|
2055
2078
|
"disabled": false,
|
|
2056
|
-
"document": "Optional. maximum retention time
|
|
2079
|
+
"document": "<P>Optional. specifies the maximum retention time for instance logs, in minutes. default value: 1440 (1 day) when left blank. configurable range: 1 minute to 90 days.</p>.",
|
|
2057
2080
|
"example": "1440",
|
|
2058
2081
|
"member": "int64",
|
|
2059
2082
|
"name": "MsgRetentionTime",
|
|
@@ -2062,7 +2085,7 @@
|
|
|
2062
2085
|
},
|
|
2063
2086
|
{
|
|
2064
2087
|
"disabled": false,
|
|
2065
|
-
"document": "Specifies the cluster Id when creating an instance.",
|
|
2088
|
+
"document": "<p>Specifies the cluster Id when creating an instance. this parameter indicates the cluster Id.</p>.",
|
|
2066
2089
|
"example": "1232",
|
|
2067
2090
|
"member": "int64",
|
|
2068
2091
|
"name": "ClusterId",
|
|
@@ -2071,7 +2094,7 @@
|
|
|
2071
2094
|
},
|
|
2072
2095
|
{
|
|
2073
2096
|
"disabled": false,
|
|
2074
|
-
"document": "Auto-Renewal tag for prepaid services.
|
|
2097
|
+
"document": "<P>Auto-Renewal tag for prepaid services. 0 means default state (not set by the user, i.e. initial state), 1 means auto-renew, 2 means explicitly no auto-renew (set by the user).</p>.",
|
|
2075
2098
|
"example": "0",
|
|
2076
2099
|
"member": "int64",
|
|
2077
2100
|
"name": "RenewFlag",
|
|
@@ -2080,7 +2103,7 @@
|
|
|
2080
2103
|
},
|
|
2081
2104
|
{
|
|
2082
2105
|
"disabled": false,
|
|
2083
|
-
"document": "Specifies the CKafka version number. valid values: 2.4.1, 2.4.2, 2.8.1, 3.2.3. default value 2.4.1. 2.4.1 and 2.4.2 belong to the same version
|
|
2106
|
+
"document": "<p>Specifies the CKafka version number. valid values: 2.4.1, 2.4.2, 2.8.1, 3.2.3. default value is 2.4.1. 2.4.1 and 2.4.2 belong to the same version, any one can be passed.</p>.",
|
|
2084
2107
|
"example": "2.4.2",
|
|
2085
2108
|
"member": "string",
|
|
2086
2109
|
"name": "KafkaVersion",
|
|
@@ -2089,7 +2112,7 @@
|
|
|
2089
2112
|
},
|
|
2090
2113
|
{
|
|
2091
2114
|
"disabled": false,
|
|
2092
|
-
"document": "
|
|
2115
|
+
"document": "<P>Instance type. specifies \"standard\" for standard edition instance (default), \"profession\" for professional edition instance, \"premium\" for advanced edition instance.</p>.",
|
|
2093
2116
|
"example": "profession",
|
|
2094
2117
|
"member": "string",
|
|
2095
2118
|
"name": "SpecificationsType",
|
|
@@ -2098,7 +2121,7 @@
|
|
|
2098
2121
|
},
|
|
2099
2122
|
{
|
|
2100
2123
|
"disabled": false,
|
|
2101
|
-
"document": "Disk size. if it does not match the console specification ratio,
|
|
2124
|
+
"document": "<P>Disk size. if it does not match the console specification ratio, creation cannot succeed. default value is 500. step length is set to 100. can be accessed through the following link to view billing specifications: https://www.tencentcloud.com/document/product/597/122562.?from_cn_redirect=1</p>.",
|
|
2102
2125
|
"example": "800",
|
|
2103
2126
|
"member": "int64",
|
|
2104
2127
|
"name": "DiskSize",
|
|
@@ -2107,7 +2130,7 @@
|
|
|
2107
2130
|
},
|
|
2108
2131
|
{
|
|
2109
2132
|
"disabled": false,
|
|
2110
|
-
"document": "Instance bandwidth
|
|
2133
|
+
"document": "<p>Instance bandwidth, default value is 40, unit MB/s. minimum value: 20MB/s. advanced edition maximum value: 360MB/s. professional edition maximum value: 100000MB/s. standard version fixed bandwidth specifications: 40MB/s, 100MB/s, 150MB/s. billing specifications can be viewed through the following link: https://www.tencentcloud.com/document/product/597/11745.?from_cn_redirect=1</p>.",
|
|
2111
2134
|
"example": "20",
|
|
2112
2135
|
"member": "int64",
|
|
2113
2136
|
"name": "BandWidth",
|
|
@@ -2116,7 +2139,7 @@
|
|
|
2116
2139
|
},
|
|
2117
2140
|
{
|
|
2118
2141
|
"disabled": false,
|
|
2119
|
-
"document": "
|
|
2142
|
+
"document": "<P>Specifies the partition size. if it does not match the console specification ratio, the creation cannot succeed. default value is 800 with a step length of 100. view billing specifications through the following link: https://www.tencentcloud.com/document/product/597/122563.?from_cn_redirect=1</p>.",
|
|
2120
2143
|
"example": "800",
|
|
2121
2144
|
"member": "int64",
|
|
2122
2145
|
"name": "Partition",
|
|
@@ -2125,7 +2148,7 @@
|
|
|
2125
2148
|
},
|
|
2126
2149
|
{
|
|
2127
2150
|
"disabled": false,
|
|
2128
|
-
"document": "Tag
|
|
2151
|
+
"document": "<p>Tag.</p>.",
|
|
2129
2152
|
"example": "无",
|
|
2130
2153
|
"member": "Tag",
|
|
2131
2154
|
"name": "Tags",
|
|
@@ -2134,7 +2157,7 @@
|
|
|
2134
2157
|
},
|
|
2135
2158
|
{
|
|
2136
2159
|
"disabled": false,
|
|
2137
|
-
"document": "Specifies the disk type for
|
|
2160
|
+
"document": "<p>Specifies the instance disk type for pro edition/advanced edition. standard edition instances do not require this field. valid values: \"CLOUD_SSD\" (SSD CLOUD disk), \"CLOUD_BASIC\" (high-performance CLOUD block storage). default value: \"CLOUD_BASIC\".</p>.",
|
|
2138
2161
|
"example": "CLOUD_SSD",
|
|
2139
2162
|
"member": "string",
|
|
2140
2163
|
"name": "DiskType",
|
|
@@ -2143,7 +2166,7 @@
|
|
|
2143
2166
|
},
|
|
2144
2167
|
{
|
|
2145
2168
|
"disabled": false,
|
|
2146
|
-
"document": "Specifies whether to create a cross-
|
|
2169
|
+
"document": "<p>Specifies whether to create a cross-availability zone instance. when the current parameter is true, zoneIds is required.</p>.",
|
|
2147
2170
|
"example": "true",
|
|
2148
2171
|
"member": "bool",
|
|
2149
2172
|
"name": "MultiZoneFlag",
|
|
@@ -2152,7 +2175,7 @@
|
|
|
2152
2175
|
},
|
|
2153
2176
|
{
|
|
2154
2177
|
"disabled": false,
|
|
2155
|
-
"document": "Availability zone list. required item when purchasing
|
|
2178
|
+
"document": "<P>Availability zone list. required item when purchasing multi-availability zone instance.</p>.",
|
|
2156
2179
|
"example": "[100006,100007]",
|
|
2157
2180
|
"member": "int64",
|
|
2158
2181
|
"name": "ZoneIds",
|
|
@@ -2161,7 +2184,7 @@
|
|
|
2161
2184
|
},
|
|
2162
2185
|
{
|
|
2163
2186
|
"disabled": false,
|
|
2164
|
-
"document": "
|
|
2187
|
+
"document": "<p>Specifies the public bandwidth size in Mbps. the free 3 Mbps bandwidth is not included by default. for example, if the total required public network bandwidth is 3 Mbps, input 0 here; if the total required public network bandwidth is 6 Mbps, input 3 here. default value: 0. ensure the input parameter is a multiple of 3.</p>.",
|
|
2165
2188
|
"example": "12",
|
|
2166
2189
|
"member": "int64",
|
|
2167
2190
|
"name": "PublicNetworkMonthly",
|
|
@@ -2170,7 +2193,7 @@
|
|
|
2170
2193
|
},
|
|
2171
2194
|
{
|
|
2172
2195
|
"disabled": false,
|
|
2173
|
-
"document": "
|
|
2196
|
+
"document": "<p>Specifies the number of instances to purchase. optional. default value is 1. when input this parameter, it will create multiple instances with case-sensitive suffixes added to instanceName.</p>.",
|
|
2174
2197
|
"example": "1",
|
|
2175
2198
|
"member": "int64",
|
|
2176
2199
|
"name": "InstanceNum",
|
|
@@ -2179,7 +2202,7 @@
|
|
|
2179
2202
|
},
|
|
2180
2203
|
{
|
|
2181
2204
|
"disabled": false,
|
|
2182
|
-
"document": "
|
|
2205
|
+
"document": "<P>Specifies whether to automatically select voucher. valid values: 1-yes; 0-no. default is 0.</p>.",
|
|
2183
2206
|
"example": "0",
|
|
2184
2207
|
"member": "int64",
|
|
2185
2208
|
"name": "AutoVoucher",
|
|
@@ -2188,12 +2211,21 @@
|
|
|
2188
2211
|
},
|
|
2189
2212
|
{
|
|
2190
2213
|
"disabled": false,
|
|
2191
|
-
"document": "Elastic bandwidth switch
|
|
2214
|
+
"document": "<P>Elastic bandwidth switch 0 disable 1 enable (0 default).</p>.",
|
|
2192
2215
|
"example": "0",
|
|
2193
2216
|
"member": "int64",
|
|
2194
2217
|
"name": "ElasticBandwidthSwitch",
|
|
2195
2218
|
"required": false,
|
|
2196
2219
|
"type": "int"
|
|
2220
|
+
},
|
|
2221
|
+
{
|
|
2222
|
+
"disabled": false,
|
|
2223
|
+
"document": "<p>Specifies the custom certificate Id. this parameter is valid only when SpecificationsType is profession. supports custom certificate capacity.</p><p>can be obtained through the <a href=\"https://www.tencentcloud.com/document/product/400/41673?from_cn_redirect=1\">DescribeCertificateDetail</a> api.</p>.",
|
|
2224
|
+
"example": "TPNd2oBB",
|
|
2225
|
+
"member": "string",
|
|
2226
|
+
"name": "CustomSSLCertId",
|
|
2227
|
+
"required": false,
|
|
2228
|
+
"type": "string"
|
|
2197
2229
|
}
|
|
2198
2230
|
],
|
|
2199
2231
|
"type": "object"
|
|
@@ -2249,7 +2281,7 @@
|
|
|
2249
2281
|
"members": [
|
|
2250
2282
|
{
|
|
2251
2283
|
"disabled": false,
|
|
2252
|
-
"document": "Returned result
|
|
2284
|
+
"document": "<P>Returned result.</p>.",
|
|
2253
2285
|
"example": "无",
|
|
2254
2286
|
"member": "CreateInstancePreResp",
|
|
2255
2287
|
"name": "Result",
|
|
@@ -2271,7 +2303,7 @@
|
|
|
2271
2303
|
"members": [
|
|
2272
2304
|
{
|
|
2273
2305
|
"disabled": false,
|
|
2274
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
2306
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
2275
2307
|
"example": "ckafka-test",
|
|
2276
2308
|
"member": "string",
|
|
2277
2309
|
"name": "InstanceId",
|
|
@@ -2280,7 +2312,7 @@
|
|
|
2280
2312
|
},
|
|
2281
2313
|
{
|
|
2282
2314
|
"disabled": false,
|
|
2283
|
-
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.
|
|
2315
|
+
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.com/document/product/597/40847?from_cn_redirect=1) api.",
|
|
2284
2316
|
"example": "topic-test",
|
|
2285
2317
|
"member": "string",
|
|
2286
2318
|
"name": "TopicName",
|
|
@@ -2326,7 +2358,7 @@
|
|
|
2326
2358
|
"members": [
|
|
2327
2359
|
{
|
|
2328
2360
|
"disabled": false,
|
|
2329
|
-
"document": "VPC Id,
|
|
2361
|
+
"document": "<p>VPC Id, can be obtained through the <a href=\"https://www.tencentcloud.com/document/product/215/15778?from_cn_redirect=1\">DescribeVpcs</a> api.</p>.",
|
|
2330
2362
|
"example": "vpc-test",
|
|
2331
2363
|
"member": "string",
|
|
2332
2364
|
"name": "VpcId",
|
|
@@ -2335,7 +2367,7 @@
|
|
|
2335
2367
|
},
|
|
2336
2368
|
{
|
|
2337
2369
|
"disabled": false,
|
|
2338
|
-
"document": "Subnet Id
|
|
2370
|
+
"document": "<p>Subnet Id, which can be obtained through the <a href=\"https://www.tencentcloud.com/document/product/215/15784?from_cn_redirect=1\">DescribeSubnets</a> api.</p>.",
|
|
2339
2371
|
"example": "subnet-test",
|
|
2340
2372
|
"member": "string",
|
|
2341
2373
|
"name": "SubnetId",
|
|
@@ -2344,7 +2376,7 @@
|
|
|
2344
2376
|
},
|
|
2345
2377
|
{
|
|
2346
2378
|
"disabled": false,
|
|
2347
|
-
"document": "Specifies the cluster instance name of ckafka,
|
|
2379
|
+
"document": "<P>Specifies the cluster instance name of ckafka, with a length not exceeding 128 arbitrary characters.</p>.",
|
|
2348
2380
|
"example": "ckafka测试",
|
|
2349
2381
|
"member": "string",
|
|
2350
2382
|
"name": "InstanceName",
|
|
@@ -2353,7 +2385,7 @@
|
|
|
2353
2385
|
},
|
|
2354
2386
|
{
|
|
2355
2387
|
"disabled": false,
|
|
2356
|
-
"document": "Specifies the standard edition instance specification for the international site. currently only the international site
|
|
2388
|
+
"document": "<P>Specifies the standard edition instance specification for the international site. currently only the standard edition on the international site uses the current field to distinguish specifications, while the domestic site standard edition uses peak bandwidth. fill in 1 for all instances except the international site standard edition. for international site standard edition instances: [entry-level (general)] fill 1; [standard type (standard)] fill 2; [advanced] fill 3; [capacity type (capacity)] fill 4; [advanced type 1 (specialized-1)] fill 5; [advanced type 2 (specialized-2)] fill 6; [advanced type 3 (specialized-3)] fill 7; [advanced type 4 (specialized-4)] fill 8.</p>.",
|
|
2357
2389
|
"example": "1",
|
|
2358
2390
|
"member": "int64",
|
|
2359
2391
|
"name": "InstanceType",
|
|
@@ -2362,7 +2394,7 @@
|
|
|
2362
2394
|
},
|
|
2363
2395
|
{
|
|
2364
2396
|
"disabled": false,
|
|
2365
|
-
"document": "The maximum
|
|
2397
|
+
"document": "<P>The default maximum retention time for instance logs, in minutes. default value: 1440 minutes (1 day) when this parameter is not input. maximum: 30 days. if the message retention time is explicitly set for a topic, the topic retention time takes precedence.</p>.",
|
|
2366
2398
|
"example": "1440",
|
|
2367
2399
|
"member": "int64",
|
|
2368
2400
|
"name": "MsgRetentionTime",
|
|
@@ -2371,7 +2403,7 @@
|
|
|
2371
2403
|
},
|
|
2372
2404
|
{
|
|
2373
2405
|
"disabled": false,
|
|
2374
|
-
"document": "
|
|
2406
|
+
"document": "<p>Specifies the cluster Id when creating an instance. input this parameter to indicate the cluster Id. leave it empty if no cluster is specified.</p>.",
|
|
2375
2407
|
"example": "5914",
|
|
2376
2408
|
"member": "int64",
|
|
2377
2409
|
"name": "ClusterId",
|
|
@@ -2380,7 +2412,7 @@
|
|
|
2380
2412
|
},
|
|
2381
2413
|
{
|
|
2382
2414
|
"disabled": false,
|
|
2383
|
-
"document": "Instance version. currently supports \"2.4.1\", \"2.4.2\", \"2.8.1\", \"3.2.3\". default value \"2.4.1\". \"2.4.1\" and \"2.4.2\" belong to the same version
|
|
2415
|
+
"document": "<P>Instance version. currently supports \"2.4.1\", \"2.4.2\", \"2.8.1\", \"3.2.3\". default value is \"2.4.1\". \"2.4.1\" and \"2.4.2\" belong to the same version, any one can be passed.</p>.",
|
|
2384
2416
|
"example": "2.4.2",
|
|
2385
2417
|
"member": "string",
|
|
2386
2418
|
"name": "KafkaVersion",
|
|
@@ -2389,7 +2421,7 @@
|
|
|
2389
2421
|
},
|
|
2390
2422
|
{
|
|
2391
2423
|
"disabled": false,
|
|
2392
|
-
"document": "Instance type. \"standard\": standard version
|
|
2424
|
+
"document": "<P>Instance type. \"standard\": standard version, \"profession\": professional version. (standard version is only supported on the international site. chinese site currently supports professional version)</p>.",
|
|
2393
2425
|
"example": "profession",
|
|
2394
2426
|
"member": "string",
|
|
2395
2427
|
"name": "SpecificationsType",
|
|
@@ -2398,7 +2430,7 @@
|
|
|
2398
2430
|
},
|
|
2399
2431
|
{
|
|
2400
2432
|
"disabled": false,
|
|
2401
|
-
"document": "Specifies the disk type for
|
|
2433
|
+
"document": "<p>Specifies the instance disk type for pro edition. standard edition instances do not require this field. valid values: \"CLOUD_SSD\" (SSD CLOUD disk), \"CLOUD_BASIC\" (high-performance CLOUD block storage). default value: \"CLOUD_BASIC\".</p>.",
|
|
2402
2434
|
"example": "CLOUD_BASIC",
|
|
2403
2435
|
"member": "string",
|
|
2404
2436
|
"name": "DiskType",
|
|
@@ -2407,7 +2439,7 @@
|
|
|
2407
2439
|
},
|
|
2408
2440
|
{
|
|
2409
2441
|
"disabled": false,
|
|
2410
|
-
"document": "
|
|
2442
|
+
"document": "<p>The peak bandwidth of the instance private network. the default value is 40 MB/s. for standard edition, input the peak bandwidth corresponding to the current instance specifications. note that if the instance created is a pro edition instance, parameter configurations such as peak bandwidth and number of partitions should meet the billing specification of the pro edition. you can view the billing specification through the following link: https://www.tencentcloud.com/document/product/597/11745.?from_cn_redirect=1</p>.",
|
|
2411
2443
|
"example": "20",
|
|
2412
2444
|
"member": "int64",
|
|
2413
2445
|
"name": "BandWidth",
|
|
@@ -2416,7 +2448,7 @@
|
|
|
2416
2448
|
},
|
|
2417
2449
|
{
|
|
2418
2450
|
"disabled": false,
|
|
2419
|
-
"document": "Instance disk size. default value is 500. step length is set to 100. should meet the billing specification of the current instance. can be accessed through the following link: https://www.tencentcloud.
|
|
2451
|
+
"document": "<P>Instance disk size. default value is 500. step length is set to 100. should meet the billing specification of the current instance. can be accessed through the following link to view billing specifications: https://www.tencentcloud.com/document/product/597/122562.?from_cn_redirect=1</p>.",
|
|
2420
2452
|
"example": "200",
|
|
2421
2453
|
"member": "int64",
|
|
2422
2454
|
"name": "DiskSize",
|
|
@@ -2425,7 +2457,7 @@
|
|
|
2425
2457
|
},
|
|
2426
2458
|
{
|
|
2427
2459
|
"disabled": false,
|
|
2428
|
-
"document": "Specifies the maximum number of partitions for the instance, which should meet the billing specification of the current instance. default value is 800 with a step length of 100. the billing specification can be viewed through the following link: https://www.tencentcloud.
|
|
2460
|
+
"document": "<P>Specifies the maximum number of partitions for the instance, which should meet the billing specification of the current instance. default value is 800 with a step length of 100. the billing specification can be viewed through the following link: https://www.tencentcloud.com/document/product/597/122563.?from_cn_redirect=1</p>.",
|
|
2429
2461
|
"example": "400",
|
|
2430
2462
|
"member": "int64",
|
|
2431
2463
|
"name": "Partition",
|
|
@@ -2434,7 +2466,7 @@
|
|
|
2434
2466
|
},
|
|
2435
2467
|
{
|
|
2436
2468
|
"disabled": false,
|
|
2437
|
-
"document": "
|
|
2469
|
+
"document": "<P>Specifies the maximum number of topics for the instance, which should meet the billing specification of the current instance. default value is 800. step length is set to 100.</p>.",
|
|
2438
2470
|
"example": "200",
|
|
2439
2471
|
"member": "int64",
|
|
2440
2472
|
"name": "TopicNum",
|
|
@@ -2443,7 +2475,7 @@
|
|
|
2443
2475
|
},
|
|
2444
2476
|
{
|
|
2445
2477
|
"disabled": false,
|
|
2446
|
-
"document": "Specifies the availability zone
|
|
2478
|
+
"document": "Specifies the availability zone where the instance is located. when creating a multi-az instance, this parameter indicates the availability zone id of the subnet where the default access point is created. ZoneId and ZoneIds cannot be empty at the same time. you can obtain this information through the API <a href=\"https://www.tencentcloud.com/document/product/597/55246?from_cn_redirect=1\">DescribeCkafkaZone</a>.",
|
|
2447
2479
|
"example": "100006",
|
|
2448
2480
|
"member": "int64",
|
|
2449
2481
|
"name": "ZoneId",
|
|
@@ -2452,7 +2484,7 @@
|
|
|
2452
2484
|
},
|
|
2453
2485
|
{
|
|
2454
2486
|
"disabled": false,
|
|
2455
|
-
"document": "
|
|
2487
|
+
"document": "<P>Specifies whether the current instance is a multi-az instance.</p>.",
|
|
2456
2488
|
"example": "true",
|
|
2457
2489
|
"member": "bool",
|
|
2458
2490
|
"name": "MultiZoneFlag",
|
|
@@ -2461,7 +2493,7 @@
|
|
|
2461
2493
|
},
|
|
2462
2494
|
{
|
|
2463
2495
|
"disabled": false,
|
|
2464
|
-
"document": "Specifies the multi-
|
|
2496
|
+
"document": "<p>Specifies the multi-availability zone id list when the instance is a multi-az instance. note the corresponding multi-availability zone for parameter ZoneId must be included in the parameter array. ZoneId and ZoneIds cannot be empty at the same time. obtain through the API <a href=\"https://www.tencentcloud.com/document/product/597/55246?from_cn_redirect=1\">DescribeCkafkaZone</a>.</p>.",
|
|
2465
2497
|
"example": "[100006,100007]",
|
|
2466
2498
|
"member": "int64",
|
|
2467
2499
|
"name": "ZoneIds",
|
|
@@ -2470,7 +2502,7 @@
|
|
|
2470
2502
|
},
|
|
2471
2503
|
{
|
|
2472
2504
|
"disabled": false,
|
|
2473
|
-
"document": "
|
|
2505
|
+
"document": "<p>Specifies the number of instances to purchase. optional. default value is 1. when input this parameter, it will create multiple instances with case-sensitive suffixes added to instanceName.</p>.",
|
|
2474
2506
|
"example": "1",
|
|
2475
2507
|
"member": "int64",
|
|
2476
2508
|
"name": "InstanceNum",
|
|
@@ -2479,7 +2511,7 @@
|
|
|
2479
2511
|
},
|
|
2480
2512
|
{
|
|
2481
2513
|
"disabled": false,
|
|
2482
|
-
"document": "Public
|
|
2514
|
+
"document": "<p>Public bandwidth size in Mbps. the free 3 Mbps bandwidth is not included by default. for example, if the total required public network bandwidth is 3 Mbps, input 0 here; if the total required public network bandwidth is 6 Mbps, input 3 here. ensure the input parameter is a multiple of 3.</p>.",
|
|
2483
2515
|
"example": "12",
|
|
2484
2516
|
"member": "int64",
|
|
2485
2517
|
"name": "PublicNetworkMonthly",
|
|
@@ -2488,7 +2520,7 @@
|
|
|
2488
2520
|
},
|
|
2489
2521
|
{
|
|
2490
2522
|
"disabled": false,
|
|
2491
|
-
"document": "Tag
|
|
2523
|
+
"document": "<p>Tag.</p>.",
|
|
2492
2524
|
"example": "无",
|
|
2493
2525
|
"member": "Tag",
|
|
2494
2526
|
"name": "Tags",
|
|
@@ -2497,12 +2529,21 @@
|
|
|
2497
2529
|
},
|
|
2498
2530
|
{
|
|
2499
2531
|
"disabled": false,
|
|
2500
|
-
"document": "
|
|
2532
|
+
"document": "<P>Specifies the elastic bandwidth switch. 0: disable (default); 1: enable.</p>.",
|
|
2501
2533
|
"example": "0",
|
|
2502
2534
|
"member": "int64",
|
|
2503
2535
|
"name": "ElasticBandwidthSwitch",
|
|
2504
2536
|
"required": false,
|
|
2505
2537
|
"type": "int"
|
|
2538
|
+
},
|
|
2539
|
+
{
|
|
2540
|
+
"disabled": false,
|
|
2541
|
+
"document": "<p>Specifies the custom certificate Id. this parameter is valid only when SpecificationsType is profession. supports custom certificate capacity.</p><p>can be obtained through the <a href=\"https://www.tencentcloud.com/document/product/400/41673?from_cn_redirect=1\">DescribeCertificateDetail</a> api.</p>.",
|
|
2542
|
+
"example": "TTpTQ6QD",
|
|
2543
|
+
"member": "string",
|
|
2544
|
+
"name": "CustomSSLCertId",
|
|
2545
|
+
"required": false,
|
|
2546
|
+
"type": "string"
|
|
2506
2547
|
}
|
|
2507
2548
|
],
|
|
2508
2549
|
"type": "object"
|
|
@@ -2512,7 +2553,7 @@
|
|
|
2512
2553
|
"members": [
|
|
2513
2554
|
{
|
|
2514
2555
|
"disabled": false,
|
|
2515
|
-
"document": "Returned result",
|
|
2556
|
+
"document": "<P>Returned result.</p>.",
|
|
2516
2557
|
"example": "无",
|
|
2517
2558
|
"member": "CreateInstancePostResp",
|
|
2518
2559
|
"name": "Result",
|
|
@@ -2534,7 +2575,7 @@
|
|
|
2534
2575
|
"members": [
|
|
2535
2576
|
{
|
|
2536
2577
|
"disabled": false,
|
|
2537
|
-
"document": "<p>Specifies the ckafka cluster instance id. obtain through the API <a href=\"https://www.tencentcloud.
|
|
2578
|
+
"document": "<p>Specifies the ckafka cluster instance id. obtain through the API <a href=\"https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1\">DescribeInstances</a>.</p>.",
|
|
2538
2579
|
"example": "ckafka-test",
|
|
2539
2580
|
"member": "string",
|
|
2540
2581
|
"name": "InstanceId",
|
|
@@ -2661,7 +2702,7 @@
|
|
|
2661
2702
|
"members": [
|
|
2662
2703
|
{
|
|
2663
2704
|
"disabled": false,
|
|
2664
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
2705
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
2665
2706
|
"example": "ckafka-test",
|
|
2666
2707
|
"member": "string",
|
|
2667
2708
|
"name": "InstanceId",
|
|
@@ -2670,7 +2711,7 @@
|
|
|
2670
2711
|
},
|
|
2671
2712
|
{
|
|
2672
2713
|
"disabled": false,
|
|
2673
|
-
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.
|
|
2714
|
+
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.com/document/product/597/40847?from_cn_redirect=1) api.",
|
|
2674
2715
|
"example": "topic-test",
|
|
2675
2716
|
"member": "string",
|
|
2676
2717
|
"name": "TopicName",
|
|
@@ -2866,6 +2907,15 @@
|
|
|
2866
2907
|
"name": "Tags",
|
|
2867
2908
|
"required": false,
|
|
2868
2909
|
"type": "list"
|
|
2910
|
+
},
|
|
2911
|
+
{
|
|
2912
|
+
"disabled": false,
|
|
2913
|
+
"document": "Time type for message saving. valid values: CreateTime/LogAppendTime.",
|
|
2914
|
+
"example": "LogAppendTime",
|
|
2915
|
+
"member": "string",
|
|
2916
|
+
"name": "LogMsgTimestampType",
|
|
2917
|
+
"required": false,
|
|
2918
|
+
"type": "string"
|
|
2869
2919
|
}
|
|
2870
2920
|
],
|
|
2871
2921
|
"type": "object"
|
|
@@ -2913,7 +2963,7 @@
|
|
|
2913
2963
|
"members": [
|
|
2914
2964
|
{
|
|
2915
2965
|
"disabled": false,
|
|
2916
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
2966
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
2917
2967
|
"example": "ckafka-test",
|
|
2918
2968
|
"member": "string",
|
|
2919
2969
|
"name": "InstanceId",
|
|
@@ -3132,7 +3182,7 @@
|
|
|
3132
3182
|
"members": [
|
|
3133
3183
|
{
|
|
3134
3184
|
"disabled": false,
|
|
3135
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
3185
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
3136
3186
|
"example": "ckafka-test",
|
|
3137
3187
|
"member": "string",
|
|
3138
3188
|
"name": "InstanceId",
|
|
@@ -3218,12 +3268,159 @@
|
|
|
3218
3268
|
],
|
|
3219
3269
|
"type": "object"
|
|
3220
3270
|
},
|
|
3271
|
+
"DeleteAclRuleRequest": {
|
|
3272
|
+
"document": "DeleteAclRule request structure.",
|
|
3273
|
+
"members": [
|
|
3274
|
+
{
|
|
3275
|
+
"disabled": false,
|
|
3276
|
+
"document": "Instance id information. you can obtain it through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
3277
|
+
"example": "ckafka-test",
|
|
3278
|
+
"member": "string",
|
|
3279
|
+
"name": "InstanceId",
|
|
3280
|
+
"required": true,
|
|
3281
|
+
"type": "string"
|
|
3282
|
+
},
|
|
3283
|
+
{
|
|
3284
|
+
"disabled": false,
|
|
3285
|
+
"document": "acl rule name, obtain through the API DescribeAclRule.",
|
|
3286
|
+
"example": "rulename-test",
|
|
3287
|
+
"member": "string",
|
|
3288
|
+
"name": "RuleName",
|
|
3289
|
+
"required": true,
|
|
3290
|
+
"type": "string"
|
|
3291
|
+
}
|
|
3292
|
+
],
|
|
3293
|
+
"type": "object"
|
|
3294
|
+
},
|
|
3295
|
+
"DeleteAclRuleResponse": {
|
|
3296
|
+
"document": "DeleteAclRule response structure.",
|
|
3297
|
+
"members": [
|
|
3298
|
+
{
|
|
3299
|
+
"disabled": false,
|
|
3300
|
+
"document": "Returns the rule ID of the deleted rule.",
|
|
3301
|
+
"example": "1",
|
|
3302
|
+
"member": "int64",
|
|
3303
|
+
"name": "Result",
|
|
3304
|
+
"output_required": true,
|
|
3305
|
+
"type": "int",
|
|
3306
|
+
"value_allowed_null": false
|
|
3307
|
+
},
|
|
3308
|
+
{
|
|
3309
|
+
"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.",
|
|
3310
|
+
"member": "string",
|
|
3311
|
+
"name": "RequestId",
|
|
3312
|
+
"type": "string"
|
|
3313
|
+
}
|
|
3314
|
+
],
|
|
3315
|
+
"type": "object"
|
|
3316
|
+
},
|
|
3317
|
+
"DeleteGroupRequest": {
|
|
3318
|
+
"document": "DeleteGroup request structure.",
|
|
3319
|
+
"members": [
|
|
3320
|
+
{
|
|
3321
|
+
"disabled": false,
|
|
3322
|
+
"document": "The ckafka cluster instance Id. can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
3323
|
+
"example": "ckafka-test",
|
|
3324
|
+
"member": "string",
|
|
3325
|
+
"name": "InstanceId",
|
|
3326
|
+
"required": true,
|
|
3327
|
+
"type": "string"
|
|
3328
|
+
},
|
|
3329
|
+
{
|
|
3330
|
+
"disabled": false,
|
|
3331
|
+
"document": "Consumer group name, which can be obtained through the DescribeConsumerGroup API (https://www.tencentcloud.com/document/product/597/40841?from_cn_redirect=1).",
|
|
3332
|
+
"example": "group-test",
|
|
3333
|
+
"member": "string",
|
|
3334
|
+
"name": "Group",
|
|
3335
|
+
"required": true,
|
|
3336
|
+
"type": "string"
|
|
3337
|
+
}
|
|
3338
|
+
],
|
|
3339
|
+
"type": "object"
|
|
3340
|
+
},
|
|
3341
|
+
"DeleteGroupResponse": {
|
|
3342
|
+
"document": "DeleteGroup response structure.",
|
|
3343
|
+
"members": [
|
|
3344
|
+
{
|
|
3345
|
+
"disabled": false,
|
|
3346
|
+
"document": "Returned results.",
|
|
3347
|
+
"example": "无",
|
|
3348
|
+
"member": "JgwOperateResponse",
|
|
3349
|
+
"name": "Result",
|
|
3350
|
+
"output_required": true,
|
|
3351
|
+
"type": "object",
|
|
3352
|
+
"value_allowed_null": false
|
|
3353
|
+
},
|
|
3354
|
+
{
|
|
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.",
|
|
3356
|
+
"member": "string",
|
|
3357
|
+
"name": "RequestId",
|
|
3358
|
+
"type": "string"
|
|
3359
|
+
}
|
|
3360
|
+
],
|
|
3361
|
+
"type": "object"
|
|
3362
|
+
},
|
|
3363
|
+
"DeleteGroupSubscribeTopicRequest": {
|
|
3364
|
+
"document": "DeleteGroupSubscribeTopic request structure.",
|
|
3365
|
+
"members": [
|
|
3366
|
+
{
|
|
3367
|
+
"disabled": false,
|
|
3368
|
+
"document": "CKafka cluster instance ID.",
|
|
3369
|
+
"example": "ckafka-test",
|
|
3370
|
+
"member": "string",
|
|
3371
|
+
"name": "InstanceId",
|
|
3372
|
+
"required": true,
|
|
3373
|
+
"type": "string"
|
|
3374
|
+
},
|
|
3375
|
+
{
|
|
3376
|
+
"disabled": false,
|
|
3377
|
+
"document": "Consumer group name.",
|
|
3378
|
+
"example": "group-test",
|
|
3379
|
+
"member": "string",
|
|
3380
|
+
"name": "Group",
|
|
3381
|
+
"required": true,
|
|
3382
|
+
"type": "string"
|
|
3383
|
+
},
|
|
3384
|
+
{
|
|
3385
|
+
"disabled": false,
|
|
3386
|
+
"document": "Topic name",
|
|
3387
|
+
"example": "topic-test",
|
|
3388
|
+
"member": "string",
|
|
3389
|
+
"name": "Topic",
|
|
3390
|
+
"required": true,
|
|
3391
|
+
"type": "string"
|
|
3392
|
+
}
|
|
3393
|
+
],
|
|
3394
|
+
"type": "object"
|
|
3395
|
+
},
|
|
3396
|
+
"DeleteGroupSubscribeTopicResponse": {
|
|
3397
|
+
"document": "DeleteGroupSubscribeTopic response structure.",
|
|
3398
|
+
"members": [
|
|
3399
|
+
{
|
|
3400
|
+
"disabled": false,
|
|
3401
|
+
"document": "Returned result.",
|
|
3402
|
+
"example": "{\"ReturnCode\":\"0\",\"ReturnMessage\":\"success\"}",
|
|
3403
|
+
"member": "JgwOperateResponse",
|
|
3404
|
+
"name": "Result",
|
|
3405
|
+
"output_required": true,
|
|
3406
|
+
"type": "object",
|
|
3407
|
+
"value_allowed_null": false
|
|
3408
|
+
},
|
|
3409
|
+
{
|
|
3410
|
+
"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.",
|
|
3411
|
+
"member": "string",
|
|
3412
|
+
"name": "RequestId",
|
|
3413
|
+
"type": "string"
|
|
3414
|
+
}
|
|
3415
|
+
],
|
|
3416
|
+
"type": "object"
|
|
3417
|
+
},
|
|
3221
3418
|
"DeleteInstancePostRequest": {
|
|
3222
3419
|
"document": "DeleteInstancePost request structure.",
|
|
3223
3420
|
"members": [
|
|
3224
3421
|
{
|
|
3225
3422
|
"disabled": false,
|
|
3226
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
3423
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
3227
3424
|
"example": "ckafka-test",
|
|
3228
3425
|
"member": "string",
|
|
3229
3426
|
"name": "InstanceId",
|
|
@@ -3260,7 +3457,7 @@
|
|
|
3260
3457
|
"members": [
|
|
3261
3458
|
{
|
|
3262
3459
|
"disabled": false,
|
|
3263
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
3460
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
3264
3461
|
"example": "ckafka-test",
|
|
3265
3462
|
"member": "string",
|
|
3266
3463
|
"name": "InstanceId",
|
|
@@ -3297,7 +3494,7 @@
|
|
|
3297
3494
|
"members": [
|
|
3298
3495
|
{
|
|
3299
3496
|
"disabled": false,
|
|
3300
|
-
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.
|
|
3497
|
+
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).",
|
|
3301
3498
|
"example": "ckafka-test",
|
|
3302
3499
|
"member": "string",
|
|
3303
3500
|
"name": "InstanceId",
|
|
@@ -3306,7 +3503,7 @@
|
|
|
3306
3503
|
},
|
|
3307
3504
|
{
|
|
3308
3505
|
"disabled": false,
|
|
3309
|
-
"document": "Route id, obtain through the API [DescribeRoute](https://www.tencentcloud.
|
|
3506
|
+
"document": "Route id, obtain through the API [DescribeRoute](https://www.tencentcloud.com/document/product/597/45484?from_cn_redirect=1).",
|
|
3310
3507
|
"example": "301",
|
|
3311
3508
|
"member": "int64",
|
|
3312
3509
|
"name": "RouteId",
|
|
@@ -3361,7 +3558,7 @@
|
|
|
3361
3558
|
"members": [
|
|
3362
3559
|
{
|
|
3363
3560
|
"disabled": false,
|
|
3364
|
-
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.
|
|
3561
|
+
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).",
|
|
3365
3562
|
"example": "ckafka-test",
|
|
3366
3563
|
"member": "string",
|
|
3367
3564
|
"name": "InstanceId",
|
|
@@ -3397,7 +3594,7 @@
|
|
|
3397
3594
|
"members": [
|
|
3398
3595
|
{
|
|
3399
3596
|
"disabled": false,
|
|
3400
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
3597
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
3401
3598
|
"example": "ckafka-test",
|
|
3402
3599
|
"member": "string",
|
|
3403
3600
|
"name": "InstanceId",
|
|
@@ -3406,7 +3603,7 @@
|
|
|
3406
3603
|
},
|
|
3407
3604
|
{
|
|
3408
3605
|
"disabled": false,
|
|
3409
|
-
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.
|
|
3606
|
+
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.com/document/product/597/40847?from_cn_redirect=1) api.",
|
|
3410
3607
|
"example": "topic-test",
|
|
3411
3608
|
"member": "string",
|
|
3412
3609
|
"name": "TopicName",
|
|
@@ -3498,7 +3695,7 @@
|
|
|
3498
3695
|
"members": [
|
|
3499
3696
|
{
|
|
3500
3697
|
"disabled": false,
|
|
3501
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
3698
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
3502
3699
|
"example": "ckafka-test",
|
|
3503
3700
|
"member": "string",
|
|
3504
3701
|
"name": "InstanceId",
|
|
@@ -3507,7 +3704,7 @@
|
|
|
3507
3704
|
},
|
|
3508
3705
|
{
|
|
3509
3706
|
"disabled": false,
|
|
3510
|
-
"document": "Specifies the username, which can be obtained through the [DescribeUser](https://www.tencentcloud.
|
|
3707
|
+
"document": "Specifies the username, which can be obtained through the [DescribeUser](https://www.tencentcloud.com/document/product/597/40855?from_cn_redirect=1) api.",
|
|
3511
3708
|
"example": "name-test",
|
|
3512
3709
|
"member": "string",
|
|
3513
3710
|
"name": "Name",
|
|
@@ -3539,12 +3736,68 @@
|
|
|
3539
3736
|
],
|
|
3540
3737
|
"type": "object"
|
|
3541
3738
|
},
|
|
3739
|
+
"DescModifyType": {
|
|
3740
|
+
"document": "Type query response parameters structure.",
|
|
3741
|
+
"members": [
|
|
3742
|
+
{
|
|
3743
|
+
"disabled": false,
|
|
3744
|
+
"document": "Specifies the renewal type.",
|
|
3745
|
+
"example": "1",
|
|
3746
|
+
"member": "int64",
|
|
3747
|
+
"name": "ModifyType",
|
|
3748
|
+
"required": true,
|
|
3749
|
+
"type": "int",
|
|
3750
|
+
"value_allowed_null": false
|
|
3751
|
+
},
|
|
3752
|
+
{
|
|
3753
|
+
"disabled": false,
|
|
3754
|
+
"document": "Specifies whether to migrate.",
|
|
3755
|
+
"example": "true",
|
|
3756
|
+
"member": "bool",
|
|
3757
|
+
"name": "MigrateFlag",
|
|
3758
|
+
"required": true,
|
|
3759
|
+
"type": "bool",
|
|
3760
|
+
"value_allowed_null": false
|
|
3761
|
+
},
|
|
3762
|
+
{
|
|
3763
|
+
"disabled": false,
|
|
3764
|
+
"document": "Estimated duration of migration in stable mode (seconds).\nNote: This field may return null, indicating that no valid values can be obtained.",
|
|
3765
|
+
"example": "1800",
|
|
3766
|
+
"member": "int64",
|
|
3767
|
+
"name": "MigrateCostTime",
|
|
3768
|
+
"required": true,
|
|
3769
|
+
"type": "int",
|
|
3770
|
+
"value_allowed_null": true
|
|
3771
|
+
},
|
|
3772
|
+
{
|
|
3773
|
+
"disabled": false,
|
|
3774
|
+
"document": "Upgrade mode (1: stable mode, 2: high-speed mode).\nNote: This field may return null, indicating that no valid values can be obtained.",
|
|
3775
|
+
"example": "1",
|
|
3776
|
+
"member": "int64",
|
|
3777
|
+
"name": "UpgradeStrategy",
|
|
3778
|
+
"required": true,
|
|
3779
|
+
"type": "int",
|
|
3780
|
+
"value_allowed_null": true
|
|
3781
|
+
},
|
|
3782
|
+
{
|
|
3783
|
+
"disabled": false,
|
|
3784
|
+
"document": "Indicates the estimated time for migration in high-speed mode, in seconds.\nNote: This field may return null, indicating that no valid values can be obtained.",
|
|
3785
|
+
"example": "1800",
|
|
3786
|
+
"member": "int64",
|
|
3787
|
+
"name": "MigrateCostTimeHighSpeed",
|
|
3788
|
+
"required": true,
|
|
3789
|
+
"type": "int",
|
|
3790
|
+
"value_allowed_null": true
|
|
3791
|
+
}
|
|
3792
|
+
],
|
|
3793
|
+
"usage": "out"
|
|
3794
|
+
},
|
|
3542
3795
|
"DescribeACLRequest": {
|
|
3543
3796
|
"document": "DescribeACL request structure.",
|
|
3544
3797
|
"members": [
|
|
3545
3798
|
{
|
|
3546
3799
|
"disabled": false,
|
|
3547
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
3800
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
3548
3801
|
"example": "ckafka-test",
|
|
3549
3802
|
"member": "string",
|
|
3550
3803
|
"name": "InstanceId",
|
|
@@ -3626,7 +3879,7 @@
|
|
|
3626
3879
|
"members": [
|
|
3627
3880
|
{
|
|
3628
3881
|
"disabled": false,
|
|
3629
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
3882
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
3630
3883
|
"example": "ckafka-test",
|
|
3631
3884
|
"member": "string",
|
|
3632
3885
|
"name": "InstanceId",
|
|
@@ -3685,38 +3938,29 @@
|
|
|
3685
3938
|
],
|
|
3686
3939
|
"type": "object"
|
|
3687
3940
|
},
|
|
3688
|
-
"
|
|
3689
|
-
"document": "
|
|
3941
|
+
"DescribeCkafkaVersionRequest": {
|
|
3942
|
+
"document": "DescribeCkafkaVersion request structure.",
|
|
3690
3943
|
"members": [
|
|
3691
3944
|
{
|
|
3692
3945
|
"disabled": false,
|
|
3693
|
-
"document": "
|
|
3694
|
-
"example": "
|
|
3695
|
-
"member": "
|
|
3696
|
-
"name": "
|
|
3697
|
-
"required":
|
|
3698
|
-
"type": "
|
|
3699
|
-
},
|
|
3700
|
-
{
|
|
3701
|
-
"disabled": false,
|
|
3702
|
-
"document": "Maximum number of users to be queried in this request. Maximum value: 50. Default value: 50",
|
|
3703
|
-
"example": "10",
|
|
3704
|
-
"member": "int64",
|
|
3705
|
-
"name": "Limit",
|
|
3706
|
-
"required": false,
|
|
3707
|
-
"type": "int"
|
|
3946
|
+
"document": "The ckafka cluster instance Id.",
|
|
3947
|
+
"example": "ckafka-test",
|
|
3948
|
+
"member": "string",
|
|
3949
|
+
"name": "InstanceId",
|
|
3950
|
+
"required": true,
|
|
3951
|
+
"type": "string"
|
|
3708
3952
|
}
|
|
3709
3953
|
],
|
|
3710
3954
|
"type": "object"
|
|
3711
3955
|
},
|
|
3712
|
-
"
|
|
3713
|
-
"document": "
|
|
3956
|
+
"DescribeCkafkaVersionResponse": {
|
|
3957
|
+
"document": "DescribeCkafkaVersion response structure.",
|
|
3714
3958
|
"members": [
|
|
3715
3959
|
{
|
|
3716
3960
|
"disabled": false,
|
|
3717
|
-
"document": "
|
|
3718
|
-
"example": "
|
|
3719
|
-
"member": "
|
|
3961
|
+
"document": "Instance version information.",
|
|
3962
|
+
"example": "无",
|
|
3963
|
+
"member": "InstanceVersion",
|
|
3720
3964
|
"name": "Result",
|
|
3721
3965
|
"output_required": true,
|
|
3722
3966
|
"type": "object",
|
|
@@ -3809,7 +4053,7 @@
|
|
|
3809
4053
|
"members": [
|
|
3810
4054
|
{
|
|
3811
4055
|
"disabled": false,
|
|
3812
|
-
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.
|
|
4056
|
+
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).",
|
|
3813
4057
|
"example": "ckafka-test",
|
|
3814
4058
|
"member": "string",
|
|
3815
4059
|
"name": "InstanceId",
|
|
@@ -3882,7 +4126,7 @@
|
|
|
3882
4126
|
"members": [
|
|
3883
4127
|
{
|
|
3884
4128
|
"disabled": false,
|
|
3885
|
-
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.
|
|
4129
|
+
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).",
|
|
3886
4130
|
"example": "ckafka-test",
|
|
3887
4131
|
"member": "string",
|
|
3888
4132
|
"name": "InstanceId",
|
|
@@ -4196,7 +4440,7 @@
|
|
|
4196
4440
|
"members": [
|
|
4197
4441
|
{
|
|
4198
4442
|
"disabled": false,
|
|
4199
|
-
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.
|
|
4443
|
+
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).",
|
|
4200
4444
|
"example": "ckafka-test",
|
|
4201
4445
|
"member": "string",
|
|
4202
4446
|
"name": "InstanceId",
|
|
@@ -4205,7 +4449,7 @@
|
|
|
4205
4449
|
},
|
|
4206
4450
|
{
|
|
4207
4451
|
"disabled": false,
|
|
4208
|
-
"document": "Kafka group list. obtain through the API [DescribeConsumerGroup](https://www.tencentcloud.
|
|
4452
|
+
"document": "Kafka group list. obtain through the API [DescribeConsumerGroup](https://www.tencentcloud.com/document/product/597/40841?from_cn_redirect=1).",
|
|
4209
4453
|
"example": "[\"group-test\"]",
|
|
4210
4454
|
"member": "string",
|
|
4211
4455
|
"name": "GroupList",
|
|
@@ -4397,7 +4641,7 @@
|
|
|
4397
4641
|
"members": [
|
|
4398
4642
|
{
|
|
4399
4643
|
"disabled": false,
|
|
4400
|
-
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.
|
|
4644
|
+
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).",
|
|
4401
4645
|
"example": "ckafka-test",
|
|
4402
4646
|
"member": "string",
|
|
4403
4647
|
"name": "InstanceId",
|
|
@@ -4638,16 +4882,116 @@
|
|
|
4638
4882
|
],
|
|
4639
4883
|
"type": "object"
|
|
4640
4884
|
},
|
|
4641
|
-
"
|
|
4642
|
-
"document": "
|
|
4885
|
+
"DescribeModifyTypeRequest": {
|
|
4886
|
+
"document": "DescribeModifyType request structure.",
|
|
4643
4887
|
"members": [
|
|
4644
4888
|
{
|
|
4645
4889
|
"disabled": false,
|
|
4646
|
-
"document": "
|
|
4647
|
-
"example": "
|
|
4648
|
-
"member": "
|
|
4649
|
-
"name": "
|
|
4650
|
-
"required":
|
|
4890
|
+
"document": "CKafka cluster instance ID.",
|
|
4891
|
+
"example": "ckafka-test",
|
|
4892
|
+
"member": "string",
|
|
4893
|
+
"name": "InstanceId",
|
|
4894
|
+
"required": true,
|
|
4895
|
+
"type": "string"
|
|
4896
|
+
},
|
|
4897
|
+
{
|
|
4898
|
+
"disabled": false,
|
|
4899
|
+
"document": "Specifies the bandwidth after upgrade. measurement unit: mb.",
|
|
4900
|
+
"example": "320",
|
|
4901
|
+
"member": "int64",
|
|
4902
|
+
"name": "BandWidth",
|
|
4903
|
+
"required": true,
|
|
4904
|
+
"type": "int"
|
|
4905
|
+
},
|
|
4906
|
+
{
|
|
4907
|
+
"disabled": false,
|
|
4908
|
+
"document": "Specifies the disk after upgrade, in gb.",
|
|
4909
|
+
"example": "1000",
|
|
4910
|
+
"member": "int64",
|
|
4911
|
+
"name": "DiskSize",
|
|
4912
|
+
"required": true,
|
|
4913
|
+
"type": "int"
|
|
4914
|
+
},
|
|
4915
|
+
{
|
|
4916
|
+
"disabled": false,
|
|
4917
|
+
"document": "Disk type, such as CLOUD_PREMIUM.",
|
|
4918
|
+
"example": "CLOUD_PREMIUM",
|
|
4919
|
+
"member": "string",
|
|
4920
|
+
"name": "DiskType",
|
|
4921
|
+
"required": true,
|
|
4922
|
+
"type": "string"
|
|
4923
|
+
},
|
|
4924
|
+
{
|
|
4925
|
+
"disabled": false,
|
|
4926
|
+
"document": "Number of partitions.",
|
|
4927
|
+
"example": "1200",
|
|
4928
|
+
"member": "int64",
|
|
4929
|
+
"name": "Partition",
|
|
4930
|
+
"required": true,
|
|
4931
|
+
"type": "int"
|
|
4932
|
+
},
|
|
4933
|
+
{
|
|
4934
|
+
"disabled": false,
|
|
4935
|
+
"document": "Number of Topics",
|
|
4936
|
+
"example": "120",
|
|
4937
|
+
"member": "int64",
|
|
4938
|
+
"name": "Topic",
|
|
4939
|
+
"required": true,
|
|
4940
|
+
"type": "int"
|
|
4941
|
+
},
|
|
4942
|
+
{
|
|
4943
|
+
"disabled": false,
|
|
4944
|
+
"document": "Instance type, such as sp_ckafka_profession.",
|
|
4945
|
+
"example": "sp_ckafka_profession",
|
|
4946
|
+
"member": "string",
|
|
4947
|
+
"name": "Type",
|
|
4948
|
+
"required": true,
|
|
4949
|
+
"type": "string"
|
|
4950
|
+
},
|
|
4951
|
+
{
|
|
4952
|
+
"disabled": false,
|
|
4953
|
+
"document": "Configuration change portal.",
|
|
4954
|
+
"example": "OPEN_ELASTIC_BANDWIDTH_ENTRY",
|
|
4955
|
+
"member": "string",
|
|
4956
|
+
"name": "ModifyEntry",
|
|
4957
|
+
"required": false,
|
|
4958
|
+
"type": "string"
|
|
4959
|
+
}
|
|
4960
|
+
],
|
|
4961
|
+
"type": "object"
|
|
4962
|
+
},
|
|
4963
|
+
"DescribeModifyTypeResponse": {
|
|
4964
|
+
"document": "DescribeModifyType response structure.",
|
|
4965
|
+
"members": [
|
|
4966
|
+
{
|
|
4967
|
+
"disabled": false,
|
|
4968
|
+
"document": "Specifies the structure of the returned renewal type.",
|
|
4969
|
+
"example": "{\"ModifyType\":1,\"MigrateFlag\":true,\"MigrateCostTime\":17066}",
|
|
4970
|
+
"member": "DescModifyType",
|
|
4971
|
+
"name": "Result",
|
|
4972
|
+
"output_required": true,
|
|
4973
|
+
"type": "object",
|
|
4974
|
+
"value_allowed_null": false
|
|
4975
|
+
},
|
|
4976
|
+
{
|
|
4977
|
+
"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.",
|
|
4978
|
+
"member": "string",
|
|
4979
|
+
"name": "RequestId",
|
|
4980
|
+
"type": "string"
|
|
4981
|
+
}
|
|
4982
|
+
],
|
|
4983
|
+
"type": "object"
|
|
4984
|
+
},
|
|
4985
|
+
"DescribeRegionRequest": {
|
|
4986
|
+
"document": "DescribeRegion request structure.",
|
|
4987
|
+
"members": [
|
|
4988
|
+
{
|
|
4989
|
+
"disabled": false,
|
|
4990
|
+
"document": "The offset value",
|
|
4991
|
+
"example": "0",
|
|
4992
|
+
"member": "int64",
|
|
4993
|
+
"name": "Offset",
|
|
4994
|
+
"required": false,
|
|
4651
4995
|
"type": "int"
|
|
4652
4996
|
},
|
|
4653
4997
|
{
|
|
@@ -4722,6 +5066,15 @@
|
|
|
4722
5066
|
"name": "RouteId",
|
|
4723
5067
|
"required": false,
|
|
4724
5068
|
"type": "int"
|
|
5069
|
+
},
|
|
5070
|
+
{
|
|
5071
|
+
"disabled": false,
|
|
5072
|
+
"document": "Specifies whether to display the primary route. when true, the routing list will additionally display the primary route information during instance creation (not affected by InternalFlag or UsedFor parameter filtering).\t",
|
|
5073
|
+
"example": "true",
|
|
5074
|
+
"member": "bool",
|
|
5075
|
+
"name": "MainRouteFlag",
|
|
5076
|
+
"required": false,
|
|
5077
|
+
"type": "bool"
|
|
4725
5078
|
}
|
|
4726
5079
|
],
|
|
4727
5080
|
"type": "object"
|
|
@@ -4863,7 +5216,7 @@
|
|
|
4863
5216
|
"members": [
|
|
4864
5217
|
{
|
|
4865
5218
|
"disabled": false,
|
|
4866
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
5219
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
4867
5220
|
"example": "ckafka-test",
|
|
4868
5221
|
"member": "string",
|
|
4869
5222
|
"name": "InstanceId",
|
|
@@ -4872,7 +5225,7 @@
|
|
|
4872
5225
|
},
|
|
4873
5226
|
{
|
|
4874
5227
|
"disabled": false,
|
|
4875
|
-
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.
|
|
5228
|
+
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.com/document/product/597/40847?from_cn_redirect=1) api.",
|
|
4876
5229
|
"example": "topic-test",
|
|
4877
5230
|
"member": "string",
|
|
4878
5231
|
"name": "TopicName",
|
|
@@ -4909,7 +5262,7 @@
|
|
|
4909
5262
|
"members": [
|
|
4910
5263
|
{
|
|
4911
5264
|
"disabled": false,
|
|
4912
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
5265
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
4913
5266
|
"example": "ckafka-test",
|
|
4914
5267
|
"member": "string",
|
|
4915
5268
|
"name": "InstanceId",
|
|
@@ -5009,7 +5362,7 @@
|
|
|
5009
5362
|
"members": [
|
|
5010
5363
|
{
|
|
5011
5364
|
"disabled": false,
|
|
5012
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
5365
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
5013
5366
|
"example": "ckafka-test",
|
|
5014
5367
|
"member": "string",
|
|
5015
5368
|
"name": "InstanceId",
|
|
@@ -5018,7 +5371,7 @@
|
|
|
5018
5371
|
},
|
|
5019
5372
|
{
|
|
5020
5373
|
"disabled": false,
|
|
5021
|
-
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.
|
|
5374
|
+
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.com/document/product/597/40847?from_cn_redirect=1) api.",
|
|
5022
5375
|
"example": "topic-test",
|
|
5023
5376
|
"member": "string",
|
|
5024
5377
|
"name": "TopicName",
|
|
@@ -5511,7 +5864,7 @@
|
|
|
5511
5864
|
"members": [
|
|
5512
5865
|
{
|
|
5513
5866
|
"disabled": false,
|
|
5514
|
-
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.
|
|
5867
|
+
"document": "The ckafka cluster instance Id, which can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
5515
5868
|
"example": "ckafka-test",
|
|
5516
5869
|
"member": "string",
|
|
5517
5870
|
"name": "InstanceId",
|
|
@@ -5520,7 +5873,7 @@
|
|
|
5520
5873
|
},
|
|
5521
5874
|
{
|
|
5522
5875
|
"disabled": false,
|
|
5523
|
-
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.
|
|
5876
|
+
"document": "Specifies the topic name, which can be obtained through the [DescribeTopic](https://www.tencentcloud.com/document/product/597/40847?from_cn_redirect=1) api.",
|
|
5524
5877
|
"example": "topic-test",
|
|
5525
5878
|
"member": "string",
|
|
5526
5879
|
"name": "Topic",
|
|
@@ -6116,7 +6469,7 @@
|
|
|
6116
6469
|
},
|
|
6117
6470
|
{
|
|
6118
6471
|
"disabled": false,
|
|
6119
|
-
"document": "Number of partitions for instance purchase, unit: unit (required when purchased; bandwidth information required for pro edition/advanced edition inquiry).\nPartition upper limit. maximum value of 40000. step length of 100.\nSpecifies the specifications and limits that can be viewed through the following link: https://www.tencentcloud.
|
|
6472
|
+
"document": "Number of partitions for instance purchase, unit: unit (required when purchased; bandwidth information required for pro edition/advanced edition inquiry).\nPartition upper limit. maximum value of 40000. step length of 100.\nSpecifies the specifications and limits that can be viewed through the following link: https://www.tencentcloud.com/document/product/597/122563.?from_cn_redirect=1\n",
|
|
6120
6473
|
"example": "400",
|
|
6121
6474
|
"member": "int64",
|
|
6122
6475
|
"name": "Partition",
|
|
@@ -6616,7 +6969,7 @@
|
|
|
6616
6969
|
"members": [
|
|
6617
6970
|
{
|
|
6618
6971
|
"disabled": false,
|
|
6619
|
-
"document": "
|
|
6972
|
+
"document": "<p>ckafka cluster instance Id.</p>.",
|
|
6620
6973
|
"example": "ckafka-test",
|
|
6621
6974
|
"member": "string",
|
|
6622
6975
|
"name": "InstanceId",
|
|
@@ -6626,7 +6979,7 @@
|
|
|
6626
6979
|
},
|
|
6627
6980
|
{
|
|
6628
6981
|
"disabled": false,
|
|
6629
|
-
"document": "Specifies the Name of the ckafka cluster instance
|
|
6982
|
+
"document": "<p>Specifies the Name of the ckafka cluster instance.</p>.",
|
|
6630
6983
|
"example": "ckafka测试",
|
|
6631
6984
|
"member": "string",
|
|
6632
6985
|
"name": "InstanceName",
|
|
@@ -6636,7 +6989,7 @@
|
|
|
6636
6989
|
},
|
|
6637
6990
|
{
|
|
6638
6991
|
"disabled": false,
|
|
6639
|
-
"document": "VIP list information
|
|
6992
|
+
"document": "<p>Access point VIP list information.</p>.",
|
|
6640
6993
|
"example": "无",
|
|
6641
6994
|
"member": "VipEntity",
|
|
6642
6995
|
"name": "VipList",
|
|
@@ -6646,7 +6999,7 @@
|
|
|
6646
6999
|
},
|
|
6647
7000
|
{
|
|
6648
7001
|
"disabled": false,
|
|
6649
|
-
"document": "Virtual IP",
|
|
7002
|
+
"document": "<p>Virtual IP.</p>.",
|
|
6650
7003
|
"example": "10.0.0.5",
|
|
6651
7004
|
"member": "string",
|
|
6652
7005
|
"name": "Vip",
|
|
@@ -6656,7 +7009,7 @@
|
|
|
6656
7009
|
},
|
|
6657
7010
|
{
|
|
6658
7011
|
"disabled": false,
|
|
6659
|
-
"document": "Virtual port",
|
|
7012
|
+
"document": "<P>Virtual port.</p>.",
|
|
6660
7013
|
"example": "9092",
|
|
6661
7014
|
"member": "string",
|
|
6662
7015
|
"name": "Vport",
|
|
@@ -6666,7 +7019,7 @@
|
|
|
6666
7019
|
},
|
|
6667
7020
|
{
|
|
6668
7021
|
"disabled": false,
|
|
6669
|
-
"document": "
|
|
7022
|
+
"document": "<P>Specifies the instance status. valid values: 0 (creating), 1 (running), 2 (deleting), 3 (deleted), 5 (isolated), 7 (upgrading), -1 (creation failed).</p>.",
|
|
6670
7023
|
"example": "1",
|
|
6671
7024
|
"member": "int64",
|
|
6672
7025
|
"name": "Status",
|
|
@@ -6676,7 +7029,7 @@
|
|
|
6676
7029
|
},
|
|
6677
7030
|
{
|
|
6678
7031
|
"disabled": false,
|
|
6679
|
-
"document": "Instance bandwidth
|
|
7032
|
+
"document": "<p>Instance bandwidth (unit: Mbps).</p>.",
|
|
6680
7033
|
"example": "100",
|
|
6681
7034
|
"member": "int64",
|
|
6682
7035
|
"name": "Bandwidth",
|
|
@@ -6686,7 +7039,7 @@
|
|
|
6686
7039
|
},
|
|
6687
7040
|
{
|
|
6688
7041
|
"disabled": false,
|
|
6689
|
-
"document": "
|
|
7042
|
+
"document": "<p>Specifies the instance storage size in GB.</p>.",
|
|
6690
7043
|
"example": "200",
|
|
6691
7044
|
"member": "int64",
|
|
6692
7045
|
"name": "DiskSize",
|
|
@@ -6696,7 +7049,7 @@
|
|
|
6696
7049
|
},
|
|
6697
7050
|
{
|
|
6698
7051
|
"disabled": false,
|
|
6699
|
-
"document": "
|
|
7052
|
+
"document": "<P>Specifies the availability zone.</p>.",
|
|
6700
7053
|
"example": "100003",
|
|
6701
7054
|
"member": "int64",
|
|
6702
7055
|
"name": "ZoneId",
|
|
@@ -6706,7 +7059,7 @@
|
|
|
6706
7059
|
},
|
|
6707
7060
|
{
|
|
6708
7061
|
"disabled": false,
|
|
6709
|
-
"document": "VPC ID.
|
|
7062
|
+
"document": "<p>VPC ID. being empty indicates a basic network.</p>.",
|
|
6710
7063
|
"example": "vpc-test",
|
|
6711
7064
|
"member": "string",
|
|
6712
7065
|
"name": "VpcId",
|
|
@@ -6716,7 +7069,7 @@
|
|
|
6716
7069
|
},
|
|
6717
7070
|
{
|
|
6718
7071
|
"disabled": false,
|
|
6719
|
-
"document": "
|
|
7072
|
+
"document": "<p>Specifies the subnet ID. being empty indicates the basic network.</p>.",
|
|
6720
7073
|
"example": "subnet-test",
|
|
6721
7074
|
"member": "string",
|
|
6722
7075
|
"name": "SubnetId",
|
|
@@ -6726,7 +7079,7 @@
|
|
|
6726
7079
|
},
|
|
6727
7080
|
{
|
|
6728
7081
|
"disabled": false,
|
|
6729
|
-
"document": "
|
|
7082
|
+
"document": "<P>Specifies the instance health status. valid values: 1 (healthy), 2 (alarm), 3 (abnormal).</p>.",
|
|
6730
7083
|
"example": "1",
|
|
6731
7084
|
"member": "int64",
|
|
6732
7085
|
"name": "Healthy",
|
|
@@ -6736,7 +7089,7 @@
|
|
|
6736
7089
|
},
|
|
6737
7090
|
{
|
|
6738
7091
|
"disabled": false,
|
|
6739
|
-
"document": "Instance health information.
|
|
7092
|
+
"document": "<P>Instance health information. currently shows disk utilization rate. maximum length is 256.</p>.",
|
|
6740
7093
|
"example": "healthy",
|
|
6741
7094
|
"member": "string",
|
|
6742
7095
|
"name": "HealthyMessage",
|
|
@@ -6746,7 +7099,7 @@
|
|
|
6746
7099
|
},
|
|
6747
7100
|
{
|
|
6748
7101
|
"disabled": false,
|
|
6749
|
-
"document": "Creation time",
|
|
7102
|
+
"document": "<P>Creation time.</p>.",
|
|
6750
7103
|
"example": "1564144000",
|
|
6751
7104
|
"member": "uint64",
|
|
6752
7105
|
"name": "CreateTime",
|
|
@@ -6756,7 +7109,7 @@
|
|
|
6756
7109
|
},
|
|
6757
7110
|
{
|
|
6758
7111
|
"disabled": false,
|
|
6759
|
-
"document": "Message retention period in minutes",
|
|
7112
|
+
"document": "<P>Message retention period, in minutes.</p>.",
|
|
6760
7113
|
"example": "4320",
|
|
6761
7114
|
"member": "int64",
|
|
6762
7115
|
"name": "MsgRetentionTime",
|
|
@@ -6766,7 +7119,7 @@
|
|
|
6766
7119
|
},
|
|
6767
7120
|
{
|
|
6768
7121
|
"disabled": false,
|
|
6769
|
-
"document": "
|
|
7122
|
+
"document": "<p>Automatic creation Topic configuration. if this field is empty, it indicates that automatic creation is not enabled.</p>.",
|
|
6770
7123
|
"example": "无",
|
|
6771
7124
|
"member": "InstanceConfigDO",
|
|
6772
7125
|
"name": "Config",
|
|
@@ -6776,7 +7129,7 @@
|
|
|
6776
7129
|
},
|
|
6777
7130
|
{
|
|
6778
7131
|
"disabled": false,
|
|
6779
|
-
"document": "Number of remaining creatable partitions",
|
|
7132
|
+
"document": "<P>Number of remaining creatable partitions.</p>.",
|
|
6780
7133
|
"example": "310",
|
|
6781
7134
|
"member": "int64",
|
|
6782
7135
|
"name": "RemainderPartitions",
|
|
@@ -6786,7 +7139,7 @@
|
|
|
6786
7139
|
},
|
|
6787
7140
|
{
|
|
6788
7141
|
"disabled": false,
|
|
6789
|
-
"document": "Number of remaining creatable topics",
|
|
7142
|
+
"document": "<P>Number of remaining creatable topics.</p>.",
|
|
6790
7143
|
"example": "190",
|
|
6791
7144
|
"member": "int64",
|
|
6792
7145
|
"name": "RemainderTopics",
|
|
@@ -6796,7 +7149,7 @@
|
|
|
6796
7149
|
},
|
|
6797
7150
|
{
|
|
6798
7151
|
"disabled": false,
|
|
6799
|
-
"document": "
|
|
7152
|
+
"document": "<P>Specifies the current number of partitions created.</p>.",
|
|
6800
7153
|
"example": "90",
|
|
6801
7154
|
"member": "int64",
|
|
6802
7155
|
"name": "CreatedPartitions",
|
|
@@ -6806,7 +7159,7 @@
|
|
|
6806
7159
|
},
|
|
6807
7160
|
{
|
|
6808
7161
|
"disabled": false,
|
|
6809
|
-
"document": "
|
|
7162
|
+
"document": "<P>Specifies the current number of topics created.</p>.",
|
|
6810
7163
|
"example": "10",
|
|
6811
7164
|
"member": "int64",
|
|
6812
7165
|
"name": "CreatedTopics",
|
|
@@ -6816,7 +7169,7 @@
|
|
|
6816
7169
|
},
|
|
6817
7170
|
{
|
|
6818
7171
|
"disabled": false,
|
|
6819
|
-
"document": "Tag array",
|
|
7172
|
+
"document": "<P>Tag array.</p>.",
|
|
6820
7173
|
"example": "无",
|
|
6821
7174
|
"member": "Tag",
|
|
6822
7175
|
"name": "Tags",
|
|
@@ -6826,7 +7179,7 @@
|
|
|
6826
7179
|
},
|
|
6827
7180
|
{
|
|
6828
7181
|
"disabled": false,
|
|
6829
|
-
"document": "
|
|
7182
|
+
"document": "<P>Specifies the expiration time.</p>.",
|
|
6830
7183
|
"example": "1566144000",
|
|
6831
7184
|
"member": "uint64",
|
|
6832
7185
|
"name": "ExpireTime",
|
|
@@ -6836,7 +7189,7 @@
|
|
|
6836
7189
|
},
|
|
6837
7190
|
{
|
|
6838
7191
|
"disabled": false,
|
|
6839
|
-
"document": "
|
|
7192
|
+
"document": "<P>Specifies the availability zone list.</p>.",
|
|
6840
7193
|
"example": "[100003,100004]",
|
|
6841
7194
|
"member": "int64",
|
|
6842
7195
|
"name": "ZoneIds",
|
|
@@ -6846,7 +7199,7 @@
|
|
|
6846
7199
|
},
|
|
6847
7200
|
{
|
|
6848
7201
|
"disabled": false,
|
|
6849
|
-
"document": "Specifies the ckafka cluster instance version
|
|
7202
|
+
"document": "<P>Specifies the ckafka cluster instance version.</p>.",
|
|
6850
7203
|
"example": "1.1.1",
|
|
6851
7204
|
"member": "string",
|
|
6852
7205
|
"name": "Version",
|
|
@@ -6856,7 +7209,7 @@
|
|
|
6856
7209
|
},
|
|
6857
7210
|
{
|
|
6858
7211
|
"disabled": false,
|
|
6859
|
-
"document": "
|
|
7212
|
+
"document": "<P>Specifies the maximum number of groups.</p>.",
|
|
6860
7213
|
"example": "500",
|
|
6861
7214
|
"member": "int64",
|
|
6862
7215
|
"name": "MaxGroupNum",
|
|
@@ -6866,7 +7219,7 @@
|
|
|
6866
7219
|
},
|
|
6867
7220
|
{
|
|
6868
7221
|
"disabled": false,
|
|
6869
|
-
"document": "Sale type.
|
|
7222
|
+
"document": "<P>Sale type. 0: standard version; 1: pro edition.</p>.",
|
|
6870
7223
|
"example": "1",
|
|
6871
7224
|
"member": "int64",
|
|
6872
7225
|
"name": "Cvm",
|
|
@@ -6876,7 +7229,7 @@
|
|
|
6876
7229
|
},
|
|
6877
7230
|
{
|
|
6878
7231
|
"disabled": false,
|
|
6879
|
-
"document": "Instance type.
|
|
7232
|
+
"document": "<p>Instance type. enumerates the list: profession: pro edition; standards2: standard version; premium: advanced edition; serverless: serverless edition.</p>.",
|
|
6880
7233
|
"example": "profession",
|
|
6881
7234
|
"member": "string",
|
|
6882
7235
|
"name": "InstanceType",
|
|
@@ -6886,7 +7239,7 @@
|
|
|
6886
7239
|
},
|
|
6887
7240
|
{
|
|
6888
7241
|
"disabled": false,
|
|
6889
|
-
"document": "Indicates the characteristics supported by the instance. FEATURE_SUBNET_ACL
|
|
7242
|
+
"document": "<p>Indicates the characteristics supported by the instance. FEATURE_SUBNET_ACL: indicates that the ACL policy supports setting subnets.</p>.",
|
|
6890
7243
|
"example": "[\"FEATURE_TOPIC_QUOTA\",\"CLOUD_EKS_TSE\",\"CLOUD_EKS_CROS_ZONE\",\"FEATURE_SASL_SCRAM\"]",
|
|
6891
7244
|
"member": "string",
|
|
6892
7245
|
"name": "Features",
|
|
@@ -6896,7 +7249,7 @@
|
|
|
6896
7249
|
},
|
|
6897
7250
|
{
|
|
6898
7251
|
"disabled": false,
|
|
6899
|
-
"document": "Dynamic message retention policy
|
|
7252
|
+
"document": "<P>Dynamic message retention policy.</p>.",
|
|
6900
7253
|
"example": "无",
|
|
6901
7254
|
"member": "DynamicRetentionTime",
|
|
6902
7255
|
"name": "RetentionTimeConfig",
|
|
@@ -6906,7 +7259,7 @@
|
|
|
6906
7259
|
},
|
|
6907
7260
|
{
|
|
6908
7261
|
"disabled": false,
|
|
6909
|
-
"document": "Maximum number of connections
|
|
7262
|
+
"document": "<P>Maximum number of connections.</p>.",
|
|
6910
7263
|
"example": "50000",
|
|
6911
7264
|
"member": "uint64",
|
|
6912
7265
|
"name": "MaxConnection",
|
|
@@ -6916,7 +7269,7 @@
|
|
|
6916
7269
|
},
|
|
6917
7270
|
{
|
|
6918
7271
|
"disabled": false,
|
|
6919
|
-
"document": "Public network bandwidth",
|
|
7272
|
+
"document": "<P>Public network bandwidth.</p>.",
|
|
6920
7273
|
"example": "3",
|
|
6921
7274
|
"member": "int64",
|
|
6922
7275
|
"name": "PublicNetwork",
|
|
@@ -6926,7 +7279,7 @@
|
|
|
6926
7279
|
},
|
|
6927
7280
|
{
|
|
6928
7281
|
"disabled": false,
|
|
6929
|
-
"document": "
|
|
7282
|
+
"document": "<P>Deprecated. no actual meaning.</p>.",
|
|
6930
7283
|
"example": "1566144000",
|
|
6931
7284
|
"member": "string",
|
|
6932
7285
|
"name": "DeleteRouteTimestamp",
|
|
@@ -6936,7 +7289,7 @@
|
|
|
6936
7289
|
},
|
|
6937
7290
|
{
|
|
6938
7291
|
"disabled": false,
|
|
6939
|
-
"document": "Number of remaining creatable partitions
|
|
7292
|
+
"document": "<P>Number of remaining creatable partitions.</p>.",
|
|
6940
7293
|
"example": "310",
|
|
6941
7294
|
"member": "int64",
|
|
6942
7295
|
"name": "RemainingPartitions",
|
|
@@ -6946,7 +7299,7 @@
|
|
|
6946
7299
|
},
|
|
6947
7300
|
{
|
|
6948
7301
|
"disabled": false,
|
|
6949
|
-
"document": "Number of remaining creatable topics
|
|
7302
|
+
"document": "<P>Number of remaining creatable topics.</p>.",
|
|
6950
7303
|
"example": "190",
|
|
6951
7304
|
"member": "int64",
|
|
6952
7305
|
"name": "RemainingTopics",
|
|
@@ -6956,7 +7309,7 @@
|
|
|
6956
7309
|
},
|
|
6957
7310
|
{
|
|
6958
7311
|
"disabled": false,
|
|
6959
|
-
"document": "
|
|
7312
|
+
"document": "<P>Dynamic disk expansion policy.</p>.",
|
|
6960
7313
|
"example": "无",
|
|
6961
7314
|
"member": "DynamicDiskConfig",
|
|
6962
7315
|
"name": "DynamicDiskConfig",
|
|
@@ -6966,7 +7319,27 @@
|
|
|
6966
7319
|
},
|
|
6967
7320
|
{
|
|
6968
7321
|
"disabled": false,
|
|
6969
|
-
"document": "Specifies the
|
|
7322
|
+
"document": "<P>Specifies the system maintenance time.</p>.",
|
|
7323
|
+
"example": "2019-08-19 00:00:00",
|
|
7324
|
+
"member": "string",
|
|
7325
|
+
"name": "SystemMaintenanceTime",
|
|
7326
|
+
"output_required": true,
|
|
7327
|
+
"type": "string",
|
|
7328
|
+
"value_allowed_null": false
|
|
7329
|
+
},
|
|
7330
|
+
{
|
|
7331
|
+
"disabled": false,
|
|
7332
|
+
"document": "<P>Specifies the maximum size of instance level messages.</p>.",
|
|
7333
|
+
"example": "8388608",
|
|
7334
|
+
"member": "uint64",
|
|
7335
|
+
"name": "MaxMessageByte",
|
|
7336
|
+
"output_required": true,
|
|
7337
|
+
"type": "int",
|
|
7338
|
+
"value_allowed_null": false
|
|
7339
|
+
},
|
|
7340
|
+
{
|
|
7341
|
+
"disabled": false,
|
|
7342
|
+
"document": "<p>Specifies the instance billing type. POSTPAID_BY_HOUR: hourly billing; PREPAID: annual/monthly package.</p>.",
|
|
6970
7343
|
"example": "PREPAID",
|
|
6971
7344
|
"member": "string",
|
|
6972
7345
|
"name": "InstanceChargeType",
|
|
@@ -6976,7 +7349,7 @@
|
|
|
6976
7349
|
},
|
|
6977
7350
|
{
|
|
6978
7351
|
"disabled": false,
|
|
6979
|
-
"document": "
|
|
7352
|
+
"document": "<p>Specifies whether to enable the elastic bandwidth allowlist. valid values: 1 (enabled), 0 (disabled).</p>.",
|
|
6980
7353
|
"example": "1",
|
|
6981
7354
|
"member": "int64",
|
|
6982
7355
|
"name": "ElasticBandwidthSwitch",
|
|
@@ -6986,7 +7359,7 @@
|
|
|
6986
7359
|
},
|
|
6987
7360
|
{
|
|
6988
7361
|
"disabled": false,
|
|
6989
|
-
"document": "
|
|
7362
|
+
"document": "<P>Specifies the elastic bandwidth activation status. 1: elastic bandwidth is disabled; 16: enabling elastic bandwidth; 32: elastic bandwidth enabled successfully; 33: disabling elastic bandwidth; 34: elastic bandwidth disabled successfully; 64: failed to enable elastic bandwidth; 65: failed to disable elastic bandwidth.</p>.",
|
|
6990
7363
|
"example": "1",
|
|
6991
7364
|
"member": "int64",
|
|
6992
7365
|
"name": "ElasticBandwidthOpenStatus",
|
|
@@ -6996,7 +7369,7 @@
|
|
|
6996
7369
|
},
|
|
6997
7370
|
{
|
|
6998
7371
|
"disabled": false,
|
|
6999
|
-
"document": "
|
|
7372
|
+
"document": "<p>ClusterType<br />CLOUD_IDC IDC cluster<br />CLOUD_CVM_SHARE CVM shared cluster<br />CLOUD_CVM_YUNTI YUNTI CVM cluster<br />CLOUD_CVM CVM cluster<br />CLOUD_CDC CDC cluster<br />CLOUD_EKS_TSE EKS cluster</p>.",
|
|
7000
7373
|
"example": "CLOUD_CVM",
|
|
7001
7374
|
"member": "string",
|
|
7002
7375
|
"name": "ClusterType",
|
|
@@ -7006,7 +7379,7 @@
|
|
|
7006
7379
|
},
|
|
7007
7380
|
{
|
|
7008
7381
|
"disabled": false,
|
|
7009
|
-
"document": "
|
|
7382
|
+
"document": "<P>Specifies the number of free partitions.</p>.",
|
|
7010
7383
|
"example": "400",
|
|
7011
7384
|
"member": "int64",
|
|
7012
7385
|
"name": "FreePartitionNumber",
|
|
@@ -7016,7 +7389,7 @@
|
|
|
7016
7389
|
},
|
|
7017
7390
|
{
|
|
7018
7391
|
"disabled": false,
|
|
7019
|
-
"document": "Specifies the elastic bandwidth upper limit
|
|
7392
|
+
"document": "<P>Specifies the elastic bandwidth upper limit.</p>.",
|
|
7020
7393
|
"example": "240",
|
|
7021
7394
|
"member": "int64",
|
|
7022
7395
|
"name": "ElasticFloatBandwidth",
|
|
@@ -7026,7 +7399,7 @@
|
|
|
7026
7399
|
},
|
|
7027
7400
|
{
|
|
7028
7401
|
"disabled": false,
|
|
7029
|
-
"document": "ssl custom certificate id. only returned for instance clusters with custom certificates
|
|
7402
|
+
"document": "<p>ssl custom certificate id. only returned for instance clusters with custom certificates.</p>.",
|
|
7030
7403
|
"example": "cert-test",
|
|
7031
7404
|
"member": "string",
|
|
7032
7405
|
"name": "CustomCertId",
|
|
@@ -7036,7 +7409,7 @@
|
|
|
7036
7409
|
},
|
|
7037
7410
|
{
|
|
7038
7411
|
"disabled": false,
|
|
7039
|
-
"document": "
|
|
7412
|
+
"document": "<P>Specifies the default unclean.leader.election.enable configuration for cluster topics. valid values: 1 (enable), 0 (disable).</p>.",
|
|
7040
7413
|
"example": "1",
|
|
7041
7414
|
"member": "int64",
|
|
7042
7415
|
"name": "UncleanLeaderElectionEnable",
|
|
@@ -7046,7 +7419,7 @@
|
|
|
7046
7419
|
},
|
|
7047
7420
|
{
|
|
7048
7421
|
"disabled": false,
|
|
7049
|
-
"document": "
|
|
7422
|
+
"document": "<P>Specifies the instance deletion protection switch. valid values: 1 (enabled), 0 (disabled).</p>.",
|
|
7050
7423
|
"example": "1",
|
|
7051
7424
|
"member": "int64",
|
|
7052
7425
|
"name": "DeleteProtectionEnable",
|
|
@@ -7140,7 +7513,7 @@
|
|
|
7140
7513
|
"members": [
|
|
7141
7514
|
{
|
|
7142
7515
|
"disabled": false,
|
|
7143
|
-
"document": "
|
|
7516
|
+
"document": "<p>ckafka cluster instance Id.</p>.",
|
|
7144
7517
|
"example": "ckafka-test",
|
|
7145
7518
|
"member": "string",
|
|
7146
7519
|
"name": "InstanceId",
|
|
@@ -7150,7 +7523,7 @@
|
|
|
7150
7523
|
},
|
|
7151
7524
|
{
|
|
7152
7525
|
"disabled": false,
|
|
7153
|
-
"document": "
|
|
7526
|
+
"document": "<P>Specifies the name of the ckafka cluster instance.</p>.",
|
|
7154
7527
|
"example": "ckafka测试",
|
|
7155
7528
|
"member": "string",
|
|
7156
7529
|
"name": "InstanceName",
|
|
@@ -7160,7 +7533,7 @@
|
|
|
7160
7533
|
},
|
|
7161
7534
|
{
|
|
7162
7535
|
"disabled": false,
|
|
7163
|
-
"document": "
|
|
7536
|
+
"document": "<P>Specifies the vip information for accessing the instance.</p>.",
|
|
7164
7537
|
"example": "10.0.0.5",
|
|
7165
7538
|
"member": "string",
|
|
7166
7539
|
"name": "Vip",
|
|
@@ -7170,7 +7543,7 @@
|
|
|
7170
7543
|
},
|
|
7171
7544
|
{
|
|
7172
7545
|
"disabled": false,
|
|
7173
|
-
"document": "
|
|
7546
|
+
"document": "<P>Specifies the port information to access the instance.</p>.",
|
|
7174
7547
|
"example": "9092",
|
|
7175
7548
|
"member": "string",
|
|
7176
7549
|
"name": "Vport",
|
|
@@ -7180,8 +7553,8 @@
|
|
|
7180
7553
|
},
|
|
7181
7554
|
{
|
|
7182
7555
|
"disabled": false,
|
|
7183
|
-
"document": "
|
|
7184
|
-
"example": "
|
|
7556
|
+
"document": "<p>Specifies the virtual IP list.</p>.",
|
|
7557
|
+
"example": "无",
|
|
7185
7558
|
"member": "VipEntity",
|
|
7186
7559
|
"name": "VipList",
|
|
7187
7560
|
"output_required": true,
|
|
@@ -7190,7 +7563,7 @@
|
|
|
7190
7563
|
},
|
|
7191
7564
|
{
|
|
7192
7565
|
"disabled": false,
|
|
7193
|
-
"document": "
|
|
7566
|
+
"document": "<P>Specifies the instance status. valid values: 0 (creating), 1 (running), 2 (deleting), 3 (deleted), 5 (isolated), 7 (upgrading), -1 (creation failed).</p>.",
|
|
7194
7567
|
"example": "1",
|
|
7195
7568
|
"member": "int64",
|
|
7196
7569
|
"name": "Status",
|
|
@@ -7200,7 +7573,7 @@
|
|
|
7200
7573
|
},
|
|
7201
7574
|
{
|
|
7202
7575
|
"disabled": false,
|
|
7203
|
-
"document": "
|
|
7576
|
+
"document": "<p>Specifies the instance bandwidth in Mbps.</p>.",
|
|
7204
7577
|
"example": "300",
|
|
7205
7578
|
"member": "int64",
|
|
7206
7579
|
"name": "Bandwidth",
|
|
@@ -7210,7 +7583,7 @@
|
|
|
7210
7583
|
},
|
|
7211
7584
|
{
|
|
7212
7585
|
"disabled": false,
|
|
7213
|
-
"document": "Specifies the ckafka cluster instance
|
|
7586
|
+
"document": "<p>Specifies the disk size of the ckafka cluster instance, in gb.</p>.",
|
|
7214
7587
|
"example": "800",
|
|
7215
7588
|
"member": "int64",
|
|
7216
7589
|
"name": "DiskSize",
|
|
@@ -7220,7 +7593,7 @@
|
|
|
7220
7593
|
},
|
|
7221
7594
|
{
|
|
7222
7595
|
"disabled": false,
|
|
7223
|
-
"document": "
|
|
7596
|
+
"document": "<p>Specifies the available zone ID.</p>.",
|
|
7224
7597
|
"example": "100003",
|
|
7225
7598
|
"member": "int64",
|
|
7226
7599
|
"name": "ZoneId",
|
|
@@ -7230,7 +7603,7 @@
|
|
|
7230
7603
|
},
|
|
7231
7604
|
{
|
|
7232
7605
|
"disabled": false,
|
|
7233
|
-
"document": "vpcId.
|
|
7606
|
+
"document": "<p>vpcId. if empty, indicates a basic network.</p>.",
|
|
7234
7607
|
"example": "vpc-test",
|
|
7235
7608
|
"member": "string",
|
|
7236
7609
|
"name": "VpcId",
|
|
@@ -7240,7 +7613,7 @@
|
|
|
7240
7613
|
},
|
|
7241
7614
|
{
|
|
7242
7615
|
"disabled": false,
|
|
7243
|
-
"document": "Subnet
|
|
7616
|
+
"document": "<P>Subnet id.</p>.",
|
|
7244
7617
|
"example": "subnet-test",
|
|
7245
7618
|
"member": "string",
|
|
7246
7619
|
"name": "SubnetId",
|
|
@@ -7250,7 +7623,7 @@
|
|
|
7250
7623
|
},
|
|
7251
7624
|
{
|
|
7252
7625
|
"disabled": false,
|
|
7253
|
-
"document": "
|
|
7626
|
+
"document": "<P>Specifies whether to renew the instance. int enumeration value: 1 means auto-renew, 2 means explicitly no auto-renew.</p>.",
|
|
7254
7627
|
"example": "1",
|
|
7255
7628
|
"member": "int64",
|
|
7256
7629
|
"name": "RenewFlag",
|
|
@@ -7260,7 +7633,7 @@
|
|
|
7260
7633
|
},
|
|
7261
7634
|
{
|
|
7262
7635
|
"disabled": false,
|
|
7263
|
-
"document": "
|
|
7636
|
+
"document": "<p>Specifies the instance status. valid values: 1 (healthy), 2 (alarm), 3 (instance status exception).</p>.",
|
|
7264
7637
|
"example": "1",
|
|
7265
7638
|
"member": "int64",
|
|
7266
7639
|
"name": "Healthy",
|
|
@@ -7270,7 +7643,7 @@
|
|
|
7270
7643
|
},
|
|
7271
7644
|
{
|
|
7272
7645
|
"disabled": false,
|
|
7273
|
-
"document": "
|
|
7646
|
+
"document": "<P>Specifies the instance status information.</p>.",
|
|
7274
7647
|
"example": "\"健康\"",
|
|
7275
7648
|
"member": "string",
|
|
7276
7649
|
"name": "HealthyMessage",
|
|
@@ -7280,7 +7653,7 @@
|
|
|
7280
7653
|
},
|
|
7281
7654
|
{
|
|
7282
7655
|
"disabled": false,
|
|
7283
|
-
"document": "
|
|
7656
|
+
"document": "<P>Specifies the instance creation time.</p>.",
|
|
7284
7657
|
"example": "1566144000",
|
|
7285
7658
|
"member": "int64",
|
|
7286
7659
|
"name": "CreateTime",
|
|
@@ -7290,7 +7663,7 @@
|
|
|
7290
7663
|
},
|
|
7291
7664
|
{
|
|
7292
7665
|
"disabled": false,
|
|
7293
|
-
"document": "
|
|
7666
|
+
"document": "<P>Specifies the instance expiration time.</p>.",
|
|
7294
7667
|
"example": "1566144000",
|
|
7295
7668
|
"member": "int64",
|
|
7296
7669
|
"name": "ExpireTime",
|
|
@@ -7300,7 +7673,7 @@
|
|
|
7300
7673
|
},
|
|
7301
7674
|
{
|
|
7302
7675
|
"disabled": false,
|
|
7303
|
-
"document": "
|
|
7676
|
+
"document": "<P>Specifies whether it is an internal customer. a value of 1 indicates an internal customer.</p>.",
|
|
7304
7677
|
"example": "1",
|
|
7305
7678
|
"member": "int64",
|
|
7306
7679
|
"name": "IsInternal",
|
|
@@ -7310,7 +7683,7 @@
|
|
|
7310
7683
|
},
|
|
7311
7684
|
{
|
|
7312
7685
|
"disabled": false,
|
|
7313
|
-
"document": "
|
|
7686
|
+
"document": "<p>Specifies the number of topics.</p>.",
|
|
7314
7687
|
"example": "10",
|
|
7315
7688
|
"member": "int64",
|
|
7316
7689
|
"name": "TopicNum",
|
|
@@ -7320,8 +7693,8 @@
|
|
|
7320
7693
|
},
|
|
7321
7694
|
{
|
|
7322
7695
|
"disabled": false,
|
|
7323
|
-
"document": "
|
|
7324
|
-
"example": "
|
|
7696
|
+
"document": "<P>Specifies the identifier tag.</p>.",
|
|
7697
|
+
"example": "无",
|
|
7325
7698
|
"member": "Tag",
|
|
7326
7699
|
"name": "Tags",
|
|
7327
7700
|
"output_required": true,
|
|
@@ -7330,7 +7703,7 @@
|
|
|
7330
7703
|
},
|
|
7331
7704
|
{
|
|
7332
7705
|
"disabled": false,
|
|
7333
|
-
"document": "kafka version information
|
|
7706
|
+
"document": "<p>kafka version information.</p>.",
|
|
7334
7707
|
"example": "1.1.1",
|
|
7335
7708
|
"member": "string",
|
|
7336
7709
|
"name": "Version",
|
|
@@ -7340,7 +7713,7 @@
|
|
|
7340
7713
|
},
|
|
7341
7714
|
{
|
|
7342
7715
|
"disabled": false,
|
|
7343
|
-
"document": "
|
|
7716
|
+
"document": "<P>Specifies the cross-availability zone.</p>.",
|
|
7344
7717
|
"example": "[100003,100004]",
|
|
7345
7718
|
"member": "int64",
|
|
7346
7719
|
"name": "ZoneIds",
|
|
@@ -7350,7 +7723,7 @@
|
|
|
7350
7723
|
},
|
|
7351
7724
|
{
|
|
7352
7725
|
"disabled": false,
|
|
7353
|
-
"document": "ckafka sales type
|
|
7726
|
+
"document": "<P>Specifies the ckafka sales type.</p>.",
|
|
7354
7727
|
"example": "0",
|
|
7355
7728
|
"member": "int64",
|
|
7356
7729
|
"name": "Cvm",
|
|
@@ -7360,7 +7733,7 @@
|
|
|
7360
7733
|
},
|
|
7361
7734
|
{
|
|
7362
7735
|
"disabled": false,
|
|
7363
|
-
"document": "Specifies the cluster instance type
|
|
7736
|
+
"document": "<P>Specifies the ckafka cluster instance type.</p>.",
|
|
7364
7737
|
"example": "profession",
|
|
7365
7738
|
"member": "string",
|
|
7366
7739
|
"name": "InstanceType",
|
|
@@ -7370,7 +7743,7 @@
|
|
|
7370
7743
|
},
|
|
7371
7744
|
{
|
|
7372
7745
|
"disabled": false,
|
|
7373
|
-
"document": "Specifies the ckafka cluster instance
|
|
7746
|
+
"document": "<P>Specifies the disk type of the ckafka cluster instance.</p>.",
|
|
7374
7747
|
"example": "CLOUD_SSD",
|
|
7375
7748
|
"member": "string",
|
|
7376
7749
|
"name": "DiskType",
|
|
@@ -7380,7 +7753,7 @@
|
|
|
7380
7753
|
},
|
|
7381
7754
|
{
|
|
7382
7755
|
"disabled": false,
|
|
7383
|
-
"document": "Maximum number of topics for current specifications
|
|
7756
|
+
"document": "<p>Maximum number of topics for current specifications.</p>.",
|
|
7384
7757
|
"example": "400",
|
|
7385
7758
|
"member": "int64",
|
|
7386
7759
|
"name": "MaxTopicNumber",
|
|
@@ -7390,7 +7763,7 @@
|
|
|
7390
7763
|
},
|
|
7391
7764
|
{
|
|
7392
7765
|
"disabled": false,
|
|
7393
|
-
"document": "
|
|
7766
|
+
"document": "<p>Specifies the maximum number of partitions for current specifications.</p>.",
|
|
7394
7767
|
"example": "800",
|
|
7395
7768
|
"member": "int64",
|
|
7396
7769
|
"name": "MaxPartitionNumber",
|
|
@@ -7400,7 +7773,7 @@
|
|
|
7400
7773
|
},
|
|
7401
7774
|
{
|
|
7402
7775
|
"disabled": false,
|
|
7403
|
-
"document": "
|
|
7776
|
+
"document": "<P>Specifies the planned configuration upgrade time.</p>.",
|
|
7404
7777
|
"example": "0000-00-00 00:00:00",
|
|
7405
7778
|
"member": "string",
|
|
7406
7779
|
"name": "RebalanceTime",
|
|
@@ -7410,7 +7783,7 @@
|
|
|
7410
7783
|
},
|
|
7411
7784
|
{
|
|
7412
7785
|
"disabled": false,
|
|
7413
|
-
"document": "
|
|
7786
|
+
"document": "<P>Current number of partitions of the instance.</p>.",
|
|
7414
7787
|
"example": "30",
|
|
7415
7788
|
"member": "uint64",
|
|
7416
7789
|
"name": "PartitionNumber",
|
|
@@ -7420,7 +7793,7 @@
|
|
|
7420
7793
|
},
|
|
7421
7794
|
{
|
|
7422
7795
|
"disabled": false,
|
|
7423
|
-
"document": "Specifies the public network bandwidth type of the ckafka cluster instance
|
|
7796
|
+
"document": "<P>Specifies the public network bandwidth type of the ckafka cluster instance.</p>.",
|
|
7424
7797
|
"example": "BANDWIDTH_PREPAID",
|
|
7425
7798
|
"member": "string",
|
|
7426
7799
|
"name": "PublicNetworkChargeType",
|
|
@@ -7430,7 +7803,7 @@
|
|
|
7430
7803
|
},
|
|
7431
7804
|
{
|
|
7432
7805
|
"disabled": false,
|
|
7433
|
-
"document": "
|
|
7806
|
+
"document": "<p>Specifies the public network bandwidth. value range: 3Mbps to 999Mbps. only supported in pro edition.</p>.",
|
|
7434
7807
|
"example": "3",
|
|
7435
7808
|
"member": "int64",
|
|
7436
7809
|
"name": "PublicNetwork",
|
|
@@ -7440,7 +7813,7 @@
|
|
|
7440
7813
|
},
|
|
7441
7814
|
{
|
|
7442
7815
|
"disabled": false,
|
|
7443
|
-
"document": "Specifies the underlying cluster type of the ckafka cluster instance
|
|
7816
|
+
"document": "<P>Specifies the underlying cluster type of the ckafka cluster instance.</p>.",
|
|
7444
7817
|
"example": "CLOUD_CVM",
|
|
7445
7818
|
"member": "string",
|
|
7446
7819
|
"name": "ClusterType",
|
|
@@ -7450,7 +7823,7 @@
|
|
|
7450
7823
|
},
|
|
7451
7824
|
{
|
|
7452
7825
|
"disabled": false,
|
|
7453
|
-
"document": "
|
|
7826
|
+
"document": "<P>Specifies the instance feature list.</p>.",
|
|
7454
7827
|
"example": "[\"FEATURE_UPDATE_PROFESSION\"]",
|
|
7455
7828
|
"member": "string",
|
|
7456
7829
|
"name": "Features",
|
|
@@ -7567,6 +7940,145 @@
|
|
|
7567
7940
|
],
|
|
7568
7941
|
"usage": "both"
|
|
7569
7942
|
},
|
|
7943
|
+
"InstanceScalingDownRequest": {
|
|
7944
|
+
"document": "InstanceScalingDown request structure.",
|
|
7945
|
+
"members": [
|
|
7946
|
+
{
|
|
7947
|
+
"disabled": false,
|
|
7948
|
+
"document": "ckafka cluster instance Id. can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
7949
|
+
"example": "ckafka-test",
|
|
7950
|
+
"member": "string",
|
|
7951
|
+
"name": "InstanceId",
|
|
7952
|
+
"required": true,
|
|
7953
|
+
"type": "string"
|
|
7954
|
+
},
|
|
7955
|
+
{
|
|
7956
|
+
"disabled": false,
|
|
7957
|
+
"document": "Shrink mode. 1: stable mode. \n2. specifies high-speed configuration change.",
|
|
7958
|
+
"example": "1",
|
|
7959
|
+
"member": "int64",
|
|
7960
|
+
"name": "UpgradeStrategy",
|
|
7961
|
+
"required": true,
|
|
7962
|
+
"type": "int"
|
|
7963
|
+
},
|
|
7964
|
+
{
|
|
7965
|
+
"disabled": false,
|
|
7966
|
+
"document": "Specifies the disk capacity in GB. value range: maximum value 500000, step length 100.\nThe specifications and limitations can be viewed through the following link: https://www.tencentcloud.com/document/product/597/122562.?from_cn_redirect=1\n\n",
|
|
7967
|
+
"example": "800",
|
|
7968
|
+
"member": "int64",
|
|
7969
|
+
"name": "DiskSize",
|
|
7970
|
+
"required": false,
|
|
7971
|
+
"type": "int"
|
|
7972
|
+
},
|
|
7973
|
+
{
|
|
7974
|
+
"disabled": false,
|
|
7975
|
+
"document": "Peak bandwidth in MB/s.\nSpecifies the url (https://www.tencentcloud.com/document/product/597/11745?from_cn_redirect=1) to view specification limits and corresponding step length.",
|
|
7976
|
+
"example": "60",
|
|
7977
|
+
"member": "int64",
|
|
7978
|
+
"name": "BandWidth",
|
|
7979
|
+
"required": false,
|
|
7980
|
+
"type": "int"
|
|
7981
|
+
},
|
|
7982
|
+
{
|
|
7983
|
+
"disabled": false,
|
|
7984
|
+
"document": "Partition upper limit maximum value of 40000, step length 100.\nSpecification limits can be viewed through the following link: https://www.tencentcloud.com/document/product/597/122563.?from_cn_redirect=1\n",
|
|
7985
|
+
"example": "400",
|
|
7986
|
+
"member": "int64",
|
|
7987
|
+
"name": "Partition",
|
|
7988
|
+
"required": false,
|
|
7989
|
+
"type": "int"
|
|
7990
|
+
}
|
|
7991
|
+
],
|
|
7992
|
+
"type": "object"
|
|
7993
|
+
},
|
|
7994
|
+
"InstanceScalingDownResponse": {
|
|
7995
|
+
"document": "InstanceScalingDown response structure.",
|
|
7996
|
+
"members": [
|
|
7997
|
+
{
|
|
7998
|
+
"disabled": false,
|
|
7999
|
+
"document": "Returned results.",
|
|
8000
|
+
"example": "无",
|
|
8001
|
+
"member": "ScalingDownResp",
|
|
8002
|
+
"name": "Result",
|
|
8003
|
+
"output_required": true,
|
|
8004
|
+
"type": "object",
|
|
8005
|
+
"value_allowed_null": false
|
|
8006
|
+
},
|
|
8007
|
+
{
|
|
8008
|
+
"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.",
|
|
8009
|
+
"member": "string",
|
|
8010
|
+
"name": "RequestId",
|
|
8011
|
+
"type": "string"
|
|
8012
|
+
}
|
|
8013
|
+
],
|
|
8014
|
+
"type": "object"
|
|
8015
|
+
},
|
|
8016
|
+
"InstanceVersion": {
|
|
8017
|
+
"document": "Instance version information.",
|
|
8018
|
+
"members": [
|
|
8019
|
+
{
|
|
8020
|
+
"disabled": false,
|
|
8021
|
+
"document": "CKafka cluster instance version.",
|
|
8022
|
+
"example": "1.1.1",
|
|
8023
|
+
"member": "string",
|
|
8024
|
+
"name": "KafkaVersion",
|
|
8025
|
+
"output_required": true,
|
|
8026
|
+
"type": "string",
|
|
8027
|
+
"value_allowed_null": false
|
|
8028
|
+
},
|
|
8029
|
+
{
|
|
8030
|
+
"disabled": false,
|
|
8031
|
+
"document": "Broker version information.",
|
|
8032
|
+
"example": "1.1.1_1.0.9",
|
|
8033
|
+
"member": "string",
|
|
8034
|
+
"name": "CurBrokerVersion",
|
|
8035
|
+
"output_required": true,
|
|
8036
|
+
"type": "string",
|
|
8037
|
+
"value_allowed_null": false
|
|
8038
|
+
},
|
|
8039
|
+
{
|
|
8040
|
+
"disabled": false,
|
|
8041
|
+
"document": "Latest version information.",
|
|
8042
|
+
"example": "[{\"KafkaVersion\":\"0.10.2\",\"BrokerVersion\":\"v0.10.2.1_r1.2.11\"},{\"KafkaVersion\":\"2.8.1\",\"BrokerVersion\":\"v2.8.1_r1.1.6\"},{\"KafkaVersion\":\"2.4.1\",\"BrokerVersion\":\"v2.4.2_r1.2.4\"},{\"KafkaVersion\":\"1.1.1\",\"BrokerVersion\":\"v1.1.1_r1.1.14\"}]",
|
|
8043
|
+
"member": "LatestBrokerVersion",
|
|
8044
|
+
"name": "LatestBrokerVersion",
|
|
8045
|
+
"output_required": true,
|
|
8046
|
+
"type": "list",
|
|
8047
|
+
"value_allowed_null": false
|
|
8048
|
+
},
|
|
8049
|
+
{
|
|
8050
|
+
"disabled": false,
|
|
8051
|
+
"document": "Whether to allow kernel upgrades across major versions.",
|
|
8052
|
+
"example": "false",
|
|
8053
|
+
"member": "bool",
|
|
8054
|
+
"name": "AllowUpgradeHighVersion",
|
|
8055
|
+
"output_required": false,
|
|
8056
|
+
"type": "bool",
|
|
8057
|
+
"value_allowed_null": false
|
|
8058
|
+
},
|
|
8059
|
+
{
|
|
8060
|
+
"disabled": false,
|
|
8061
|
+
"document": "Major version allowed for upgrades.",
|
|
8062
|
+
"example": "[\"2.8.1\"]",
|
|
8063
|
+
"member": "string",
|
|
8064
|
+
"name": "HighVersionSet",
|
|
8065
|
+
"output_required": false,
|
|
8066
|
+
"type": "list",
|
|
8067
|
+
"value_allowed_null": false
|
|
8068
|
+
},
|
|
8069
|
+
{
|
|
8070
|
+
"disabled": false,
|
|
8071
|
+
"document": "Whether to allow automatic deletion of consumer groups during minor version configuration.",
|
|
8072
|
+
"example": "false",
|
|
8073
|
+
"member": "bool",
|
|
8074
|
+
"name": "AllowAutoDeleteTimestamp",
|
|
8075
|
+
"output_required": false,
|
|
8076
|
+
"type": "bool",
|
|
8077
|
+
"value_allowed_null": false
|
|
8078
|
+
}
|
|
8079
|
+
],
|
|
8080
|
+
"usage": "out"
|
|
8081
|
+
},
|
|
7570
8082
|
"JgwOperateResponse": {
|
|
7571
8083
|
"document": "Returned result value of operation",
|
|
7572
8084
|
"members": [
|
|
@@ -7603,6 +8115,32 @@
|
|
|
7603
8115
|
],
|
|
7604
8116
|
"usage": "out"
|
|
7605
8117
|
},
|
|
8118
|
+
"LatestBrokerVersion": {
|
|
8119
|
+
"document": "List of the latest version information.",
|
|
8120
|
+
"members": [
|
|
8121
|
+
{
|
|
8122
|
+
"disabled": false,
|
|
8123
|
+
"document": "CKafka cluster instance version.",
|
|
8124
|
+
"example": "1.1.1",
|
|
8125
|
+
"member": "string",
|
|
8126
|
+
"name": "KafkaVersion",
|
|
8127
|
+
"output_required": true,
|
|
8128
|
+
"type": "string",
|
|
8129
|
+
"value_allowed_null": false
|
|
8130
|
+
},
|
|
8131
|
+
{
|
|
8132
|
+
"disabled": false,
|
|
8133
|
+
"document": "Broker version number.",
|
|
8134
|
+
"example": "1.1.1_1.0.13",
|
|
8135
|
+
"member": "string",
|
|
8136
|
+
"name": "BrokerVersion",
|
|
8137
|
+
"output_required": true,
|
|
8138
|
+
"type": "string",
|
|
8139
|
+
"value_allowed_null": false
|
|
8140
|
+
}
|
|
8141
|
+
],
|
|
8142
|
+
"usage": "out"
|
|
8143
|
+
},
|
|
7606
8144
|
"ListCvmAndIpInfoRsp": {
|
|
7607
8145
|
"document": "CVM and IP information list.",
|
|
7608
8146
|
"members": [
|
|
@@ -7753,7 +8291,7 @@
|
|
|
7753
8291
|
"members": [
|
|
7754
8292
|
{
|
|
7755
8293
|
"disabled": false,
|
|
7756
|
-
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.
|
|
8294
|
+
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).",
|
|
7757
8295
|
"example": "ckafka-test",
|
|
7758
8296
|
"member": "string",
|
|
7759
8297
|
"name": "InstanceId",
|
|
@@ -7762,7 +8300,7 @@
|
|
|
7762
8300
|
},
|
|
7763
8301
|
{
|
|
7764
8302
|
"disabled": false,
|
|
7765
|
-
"document": "Consumer group name. obtain through the API [DescribeConsumerGroup](https://www.tencentcloud.
|
|
8303
|
+
"document": "Consumer group name. obtain through the API [DescribeConsumerGroup](https://www.tencentcloud.com/document/product/597/40841?from_cn_redirect=1).",
|
|
7766
8304
|
"example": "group-test",
|
|
7767
8305
|
"member": "string",
|
|
7768
8306
|
"name": "Group",
|
|
@@ -7886,7 +8424,7 @@
|
|
|
7886
8424
|
"members": [
|
|
7887
8425
|
{
|
|
7888
8426
|
"disabled": false,
|
|
7889
|
-
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.
|
|
8427
|
+
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).",
|
|
7890
8428
|
"example": "ckafka-test",
|
|
7891
8429
|
"member": "string",
|
|
7892
8430
|
"name": "InstanceId",
|
|
@@ -8013,7 +8551,7 @@
|
|
|
8013
8551
|
"members": [
|
|
8014
8552
|
{
|
|
8015
8553
|
"disabled": false,
|
|
8016
|
-
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.
|
|
8554
|
+
"document": "ckafka cluster instance Id. obtain through the API [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).",
|
|
8017
8555
|
"example": "ckafka-test",
|
|
8018
8556
|
"member": "string",
|
|
8019
8557
|
"name": "InstanceId",
|
|
@@ -8022,7 +8560,7 @@
|
|
|
8022
8560
|
},
|
|
8023
8561
|
{
|
|
8024
8562
|
"disabled": false,
|
|
8025
|
-
"document": "Specifies the disk capacity in GB. value range: 100 to 500000 with a step length of 100.\nSpecification limits can be viewed through the following link: https://www.tencentcloud.
|
|
8563
|
+
"document": "Specifies the disk capacity in GB. value range: 100 to 500000 with a step length of 100.\nSpecification limits can be viewed through the following link: https://www.tencentcloud.com/document/product/597/122562.?from_cn_redirect=1\n",
|
|
8026
8564
|
"example": "800",
|
|
8027
8565
|
"member": "int64",
|
|
8028
8566
|
"name": "DiskSize",
|
|
@@ -8031,7 +8569,7 @@
|
|
|
8031
8569
|
},
|
|
8032
8570
|
{
|
|
8033
8571
|
"disabled": false,
|
|
8034
|
-
"document": "Peak bandwidth in MB/s.\nSpecifies the specification limits and corresponding step length through the following link: https://www.tencentcloud.
|
|
8572
|
+
"document": "Peak bandwidth in MB/s.\nSpecifies the specification limits and corresponding step length through the following link: https://www.tencentcloud.com/document/product/597/11745.?from_cn_redirect=1\n",
|
|
8035
8573
|
"example": "20",
|
|
8036
8574
|
"member": "int64",
|
|
8037
8575
|
"name": "BandWidth",
|
|
@@ -8040,7 +8578,7 @@
|
|
|
8040
8578
|
},
|
|
8041
8579
|
{
|
|
8042
8580
|
"disabled": false,
|
|
8043
|
-
"document": "Partition upper bound. maximum value of 40000. step length of 100.\nSpecifies the specifications and limits that can be viewed through the following link: https://www.tencentcloud.
|
|
8581
|
+
"document": "Partition upper bound. maximum value of 40000. step length of 100.\nSpecifies the specifications and limits that can be viewed through the following link: https://www.tencentcloud.com/document/product/597/122563.?from_cn_redirect=1",
|
|
8044
8582
|
"example": "400",
|
|
8045
8583
|
"member": "int64",
|
|
8046
8584
|
"name": "Partition",
|
|
@@ -8077,7 +8615,7 @@
|
|
|
8077
8615
|
"members": [
|
|
8078
8616
|
{
|
|
8079
8617
|
"disabled": false,
|
|
8080
|
-
"document": "Instance Id. you can obtain it by calling the [DescribeInstances](https://www.tencentcloud.
|
|
8618
|
+
"document": "Instance Id. you can obtain it by calling the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
8081
8619
|
"example": "ckafka-test",
|
|
8082
8620
|
"member": "string",
|
|
8083
8621
|
"name": "InstanceId",
|
|
@@ -8086,7 +8624,7 @@
|
|
|
8086
8624
|
},
|
|
8087
8625
|
{
|
|
8088
8626
|
"disabled": false,
|
|
8089
|
-
"document": "Specifies the username, which can be obtained through the [DescribeUser](https://www.tencentcloud.
|
|
8627
|
+
"document": "Specifies the username, which can be obtained through the [DescribeUser](https://www.tencentcloud.com/document/product/597/40855?from_cn_redirect=1) api.",
|
|
8090
8628
|
"example": "name-test",
|
|
8091
8629
|
"member": "string",
|
|
8092
8630
|
"name": "Name",
|
|
@@ -8136,6 +8674,133 @@
|
|
|
8136
8674
|
],
|
|
8137
8675
|
"type": "object"
|
|
8138
8676
|
},
|
|
8677
|
+
"ModifyRoutineMaintenanceTaskRequest": {
|
|
8678
|
+
"document": "ModifyRoutineMaintenanceTask request structure.",
|
|
8679
|
+
"members": [
|
|
8680
|
+
{
|
|
8681
|
+
"disabled": false,
|
|
8682
|
+
"document": "Specifies the ckafka cluster instance id. can be obtained through the [DescribeInstances](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1) api.",
|
|
8683
|
+
"example": "ckafka-test",
|
|
8684
|
+
"member": "string",
|
|
8685
|
+
"name": "InstanceId",
|
|
8686
|
+
"required": true,
|
|
8687
|
+
"type": "string"
|
|
8688
|
+
},
|
|
8689
|
+
{
|
|
8690
|
+
"disabled": false,
|
|
8691
|
+
"document": "Automated operation and maintenance category. valid values: QUOTA, ANALYSIS, RE_BALANCE, ELASTIC_BANDWIDTH.",
|
|
8692
|
+
"example": "QUOTA",
|
|
8693
|
+
"member": "string",
|
|
8694
|
+
"name": "MaintenanceType",
|
|
8695
|
+
"required": true,
|
|
8696
|
+
"type": "string"
|
|
8697
|
+
},
|
|
8698
|
+
{
|
|
8699
|
+
"disabled": false,
|
|
8700
|
+
"document": "INSTANCE_STORAGE_CAPACITY (automatic disk scale-out)/MESSAGE_RETENTION_PERIOD (dynamic MESSAGE RETENTION policy).",
|
|
8701
|
+
"example": "INSTANCE_STORAGE_CAPACITY",
|
|
8702
|
+
"member": "string",
|
|
8703
|
+
"name": "MaintenanceSubtype",
|
|
8704
|
+
"required": true,
|
|
8705
|
+
"type": "string"
|
|
8706
|
+
},
|
|
8707
|
+
{
|
|
8708
|
+
"disabled": false,
|
|
8709
|
+
"document": "Topic name",
|
|
8710
|
+
"example": "topic-test",
|
|
8711
|
+
"member": "string",
|
|
8712
|
+
"name": "TopicName",
|
|
8713
|
+
"required": false,
|
|
8714
|
+
"type": "string"
|
|
8715
|
+
},
|
|
8716
|
+
{
|
|
8717
|
+
"disabled": false,
|
|
8718
|
+
"document": "Task trigger threshold.",
|
|
8719
|
+
"example": "60",
|
|
8720
|
+
"member": "int64",
|
|
8721
|
+
"name": "ConfigureThreshold",
|
|
8722
|
+
"required": false,
|
|
8723
|
+
"type": "int"
|
|
8724
|
+
},
|
|
8725
|
+
{
|
|
8726
|
+
"disabled": false,
|
|
8727
|
+
"document": "Specifies the step length for task adjustment.",
|
|
8728
|
+
"example": "30",
|
|
8729
|
+
"member": "int64",
|
|
8730
|
+
"name": "ConfigureStepSize",
|
|
8731
|
+
"required": false,
|
|
8732
|
+
"type": "int"
|
|
8733
|
+
},
|
|
8734
|
+
{
|
|
8735
|
+
"disabled": false,
|
|
8736
|
+
"document": "Task adjustment upper limit.",
|
|
8737
|
+
"example": "70",
|
|
8738
|
+
"member": "int64",
|
|
8739
|
+
"name": "ConfigureLimit",
|
|
8740
|
+
"required": false,
|
|
8741
|
+
"type": "int"
|
|
8742
|
+
},
|
|
8743
|
+
{
|
|
8744
|
+
"disabled": false,
|
|
8745
|
+
"document": "Specifies the expected trigger time of the task, storing the offset in seconds from 0 AM of the current day.",
|
|
8746
|
+
"example": "9600",
|
|
8747
|
+
"member": "int64",
|
|
8748
|
+
"name": "PlannedTime",
|
|
8749
|
+
"required": false,
|
|
8750
|
+
"type": "int"
|
|
8751
|
+
},
|
|
8752
|
+
{
|
|
8753
|
+
"disabled": false,
|
|
8754
|
+
"document": "Additional task information.",
|
|
8755
|
+
"example": "{\"key\":\"value\"}",
|
|
8756
|
+
"member": "string",
|
|
8757
|
+
"name": "ExtraConfig",
|
|
8758
|
+
"required": false,
|
|
8759
|
+
"type": "string"
|
|
8760
|
+
},
|
|
8761
|
+
{
|
|
8762
|
+
"disabled": false,
|
|
8763
|
+
"document": "Task status. 0: enabled, 1: disabled.",
|
|
8764
|
+
"example": "1",
|
|
8765
|
+
"member": "int64",
|
|
8766
|
+
"name": "Status",
|
|
8767
|
+
"required": false,
|
|
8768
|
+
"type": "int"
|
|
8769
|
+
},
|
|
8770
|
+
{
|
|
8771
|
+
"disabled": false,
|
|
8772
|
+
"document": "Specifies the day of the week.",
|
|
8773
|
+
"example": "1,2,3,4,5,6,7",
|
|
8774
|
+
"member": "string",
|
|
8775
|
+
"name": "Week",
|
|
8776
|
+
"required": false,
|
|
8777
|
+
"type": "string"
|
|
8778
|
+
}
|
|
8779
|
+
],
|
|
8780
|
+
"type": "object"
|
|
8781
|
+
},
|
|
8782
|
+
"ModifyRoutineMaintenanceTaskResponse": {
|
|
8783
|
+
"document": "ModifyRoutineMaintenanceTask response structure.",
|
|
8784
|
+
"members": [
|
|
8785
|
+
{
|
|
8786
|
+
"disabled": false,
|
|
8787
|
+
"document": "Returned results.",
|
|
8788
|
+
"example": "无",
|
|
8789
|
+
"member": "JgwOperateResponse",
|
|
8790
|
+
"name": "Result",
|
|
8791
|
+
"output_required": true,
|
|
8792
|
+
"type": "object",
|
|
8793
|
+
"value_allowed_null": false
|
|
8794
|
+
},
|
|
8795
|
+
{
|
|
8796
|
+
"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.",
|
|
8797
|
+
"member": "string",
|
|
8798
|
+
"name": "RequestId",
|
|
8799
|
+
"type": "string"
|
|
8800
|
+
}
|
|
8801
|
+
],
|
|
8802
|
+
"type": "object"
|
|
8803
|
+
},
|
|
8139
8804
|
"ModifyTopicAttributesRequest": {
|
|
8140
8805
|
"document": "ModifyTopicAttributes request structure.",
|
|
8141
8806
|
"members": [
|
|
@@ -8300,6 +8965,15 @@
|
|
|
8300
8965
|
"name": "ReplicaNum",
|
|
8301
8966
|
"required": false,
|
|
8302
8967
|
"type": "int"
|
|
8968
|
+
},
|
|
8969
|
+
{
|
|
8970
|
+
"disabled": false,
|
|
8971
|
+
"document": "Specifies the time type for message saving: CreateTime/LogAppendTime.",
|
|
8972
|
+
"example": "LogAppendTime",
|
|
8973
|
+
"member": "string",
|
|
8974
|
+
"name": "LogMsgTimestampType",
|
|
8975
|
+
"required": false,
|
|
8976
|
+
"type": "string"
|
|
8303
8977
|
}
|
|
8304
8978
|
],
|
|
8305
8979
|
"type": "object"
|
|
@@ -8775,6 +9449,22 @@
|
|
|
8775
9449
|
],
|
|
8776
9450
|
"usage": "out"
|
|
8777
9451
|
},
|
|
9452
|
+
"ScalingDownResp": {
|
|
9453
|
+
"document": "Instance downsizing response.",
|
|
9454
|
+
"members": [
|
|
9455
|
+
{
|
|
9456
|
+
"disabled": false,
|
|
9457
|
+
"document": "Order ID list",
|
|
9458
|
+
"example": "[\"20190819000001\"]",
|
|
9459
|
+
"member": "string",
|
|
9460
|
+
"name": "DealNames",
|
|
9461
|
+
"output_required": false,
|
|
9462
|
+
"type": "list",
|
|
9463
|
+
"value_allowed_null": false
|
|
9464
|
+
}
|
|
9465
|
+
],
|
|
9466
|
+
"usage": "out"
|
|
9467
|
+
},
|
|
8778
9468
|
"SecurityGroupRoute": {
|
|
8779
9469
|
"document": "Security group routing information.",
|
|
8780
9470
|
"members": [
|
|
@@ -9618,6 +10308,79 @@
|
|
|
9618
10308
|
],
|
|
9619
10309
|
"usage": "out"
|
|
9620
10310
|
},
|
|
10311
|
+
"UpgradeBrokerVersionRequest": {
|
|
10312
|
+
"document": "UpgradeBrokerVersion request structure.",
|
|
10313
|
+
"members": [
|
|
10314
|
+
{
|
|
10315
|
+
"disabled": false,
|
|
10316
|
+
"document": "The ckafka cluster instance Id.",
|
|
10317
|
+
"example": "ckafka-test",
|
|
10318
|
+
"member": "string",
|
|
10319
|
+
"name": "InstanceId",
|
|
10320
|
+
"required": true,
|
|
10321
|
+
"type": "string"
|
|
10322
|
+
},
|
|
10323
|
+
{
|
|
10324
|
+
"disabled": false,
|
|
10325
|
+
"document": "1. smooth configuration upgrade 2. vertical configuration upgrade.",
|
|
10326
|
+
"example": "1",
|
|
10327
|
+
"member": "int64",
|
|
10328
|
+
"name": "Type",
|
|
10329
|
+
"required": true,
|
|
10330
|
+
"type": "int"
|
|
10331
|
+
},
|
|
10332
|
+
{
|
|
10333
|
+
"disabled": false,
|
|
10334
|
+
"document": "Version number",
|
|
10335
|
+
"example": "v2.8.1_r1.1.7",
|
|
10336
|
+
"member": "string",
|
|
10337
|
+
"name": "SourceVersion",
|
|
10338
|
+
"required": true,
|
|
10339
|
+
"type": "string"
|
|
10340
|
+
},
|
|
10341
|
+
{
|
|
10342
|
+
"disabled": false,
|
|
10343
|
+
"document": "Version number",
|
|
10344
|
+
"example": "v2.8.1_r1.1.8",
|
|
10345
|
+
"member": "string",
|
|
10346
|
+
"name": "TargetVersion",
|
|
10347
|
+
"required": true,
|
|
10348
|
+
"type": "string"
|
|
10349
|
+
},
|
|
10350
|
+
{
|
|
10351
|
+
"disabled": false,
|
|
10352
|
+
"document": "Delay time.",
|
|
10353
|
+
"example": "2020-08-21 11:15:54",
|
|
10354
|
+
"member": "string",
|
|
10355
|
+
"name": "DelayTimeStamp",
|
|
10356
|
+
"required": false,
|
|
10357
|
+
"type": "string"
|
|
10358
|
+
}
|
|
10359
|
+
],
|
|
10360
|
+
"type": "object"
|
|
10361
|
+
},
|
|
10362
|
+
"UpgradeBrokerVersionResponse": {
|
|
10363
|
+
"document": "UpgradeBrokerVersion response structure.",
|
|
10364
|
+
"members": [
|
|
10365
|
+
{
|
|
10366
|
+
"disabled": false,
|
|
10367
|
+
"document": "Upgrade result.",
|
|
10368
|
+
"example": "{\"ReturnCode\":\"0\",\"ReturnMessage\":\"success\"}",
|
|
10369
|
+
"member": "JgwOperateResponse",
|
|
10370
|
+
"name": "Result",
|
|
10371
|
+
"output_required": true,
|
|
10372
|
+
"type": "object",
|
|
10373
|
+
"value_allowed_null": false
|
|
10374
|
+
},
|
|
10375
|
+
{
|
|
10376
|
+
"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.",
|
|
10377
|
+
"member": "string",
|
|
10378
|
+
"name": "RequestId",
|
|
10379
|
+
"type": "string"
|
|
10380
|
+
}
|
|
10381
|
+
],
|
|
10382
|
+
"type": "object"
|
|
10383
|
+
},
|
|
9621
10384
|
"User": {
|
|
9622
10385
|
"document": "User entity",
|
|
9623
10386
|
"members": [
|
|
@@ -9827,7 +10590,7 @@
|
|
|
9827
10590
|
"members": [
|
|
9828
10591
|
{
|
|
9829
10592
|
"disabled": false,
|
|
9830
|
-
"document": "
|
|
10593
|
+
"document": "<P>Specifies the zone list.</p>.",
|
|
9831
10594
|
"example": "无",
|
|
9832
10595
|
"member": "ZoneInfo",
|
|
9833
10596
|
"name": "ZoneList",
|
|
@@ -9837,7 +10600,7 @@
|
|
|
9837
10600
|
},
|
|
9838
10601
|
{
|
|
9839
10602
|
"disabled": false,
|
|
9840
|
-
"document": "Maximum number of instances
|
|
10603
|
+
"document": "<P>Maximum number of instances that can be purchased.</p>.",
|
|
9841
10604
|
"example": "100",
|
|
9842
10605
|
"member": "int64",
|
|
9843
10606
|
"name": "MaxBuyInstanceNum",
|
|
@@ -9847,7 +10610,7 @@
|
|
|
9847
10610
|
},
|
|
9848
10611
|
{
|
|
9849
10612
|
"disabled": false,
|
|
9850
|
-
"document": "Maximum bandwidth in
|
|
10613
|
+
"document": "<p>Maximum purchase bandwidth in Mb/s.</p>.",
|
|
9851
10614
|
"example": "9600",
|
|
9852
10615
|
"member": "int64",
|
|
9853
10616
|
"name": "MaxBandwidth",
|
|
@@ -9857,7 +10620,7 @@
|
|
|
9857
10620
|
},
|
|
9858
10621
|
{
|
|
9859
10622
|
"disabled": false,
|
|
9860
|
-
"document": "
|
|
10623
|
+
"document": "<P>Unit price for postpayment.</p>.",
|
|
9861
10624
|
"example": "无",
|
|
9862
10625
|
"member": "Price",
|
|
9863
10626
|
"name": "UnitPrice",
|
|
@@ -9867,7 +10630,7 @@
|
|
|
9867
10630
|
},
|
|
9868
10631
|
{
|
|
9869
10632
|
"disabled": false,
|
|
9870
|
-
"document": "
|
|
10633
|
+
"document": "<P>Message unit price for postpayment.</p>.",
|
|
9871
10634
|
"example": "无",
|
|
9872
10635
|
"member": "Price",
|
|
9873
10636
|
"name": "MessagePrice",
|
|
@@ -9877,7 +10640,7 @@
|
|
|
9877
10640
|
},
|
|
9878
10641
|
{
|
|
9879
10642
|
"disabled": false,
|
|
9880
|
-
"document": "
|
|
10643
|
+
"document": "<P>User-Exclusive cluster information.</p>.",
|
|
9881
10644
|
"example": "无",
|
|
9882
10645
|
"member": "ClusterInfo",
|
|
9883
10646
|
"name": "ClusterInfo",
|
|
@@ -9887,7 +10650,7 @@
|
|
|
9887
10650
|
},
|
|
9888
10651
|
{
|
|
9889
10652
|
"disabled": false,
|
|
9890
|
-
"document": "
|
|
10653
|
+
"document": "<P>Specifies the standard version configuration to purchase.</p>.",
|
|
9891
10654
|
"example": "{\"standard\":{\"bandwidth\":{\"maximum\":200,\"minimal\":3,\"step\":3}}}",
|
|
9892
10655
|
"member": "string",
|
|
9893
10656
|
"name": "Standard",
|
|
@@ -9897,7 +10660,7 @@
|
|
|
9897
10660
|
},
|
|
9898
10661
|
{
|
|
9899
10662
|
"disabled": false,
|
|
9900
|
-
"document": "
|
|
10663
|
+
"document": "<P>Specifies the purchase of standard version s2 configuration.</p>.",
|
|
9901
10664
|
"example": "{\"InstanceTypeConfigSet\":[],\"maximumTopicPartition\":2500,\"maximumInstanceConsumerGroup\":0}",
|
|
9902
10665
|
"member": "string",
|
|
9903
10666
|
"name": "StandardS2",
|
|
@@ -9907,7 +10670,7 @@
|
|
|
9907
10670
|
},
|
|
9908
10671
|
{
|
|
9909
10672
|
"disabled": false,
|
|
9910
|
-
"document": "Specifies the configuration for purchasing
|
|
10673
|
+
"document": "<P>Specifies the configuration for purchasing professional edition.</p>.",
|
|
9911
10674
|
"example": "{\"BasicEdition\":{\"Bandwidth\":{\"Maximum\":1200,\"Minimal\":20,\"Step\":20},\"DiskCapacity\":{},\"DiskTypes\":[\"SSD\",\"CLOUD_BASIC\"],\"MessageRetention\":{\"Maximum\":2160,\"Minimal\":24,\"Step\":1},\"Partition\":{}}}",
|
|
9912
10675
|
"member": "string",
|
|
9913
10676
|
"name": "Profession",
|
|
@@ -9917,7 +10680,7 @@
|
|
|
9917
10680
|
},
|
|
9918
10681
|
{
|
|
9919
10682
|
"disabled": false,
|
|
9920
|
-
"document": "Purchase physical dedicated edition configuration
|
|
10683
|
+
"document": "<P>Purchase physical dedicated edition configuration.</p>.",
|
|
9921
10684
|
"example": "{\"physicallyExclusive\":{\"bandwidth\":{\"maximum\":200,\"minimal\":3,\"step\":3}}}",
|
|
9922
10685
|
"member": "string",
|
|
9923
10686
|
"name": "Physical",
|
|
@@ -9927,7 +10690,7 @@
|
|
|
9927
10690
|
},
|
|
9928
10691
|
{
|
|
9929
10692
|
"disabled": false,
|
|
9930
|
-
"document": "
|
|
10693
|
+
"document": "<p>Specifies the public network bandwidth. valid values: 3Mbps to 999Mbps. only supported in pro edition. abandoned, meaningless.</p>.",
|
|
9931
10694
|
"example": "[{\\\"Maximum\\\":198,\\\"Minimal\\\":3,\\\"step\\\":3}]",
|
|
9932
10695
|
"member": "string",
|
|
9933
10696
|
"name": "PublicNetwork",
|
|
@@ -9937,7 +10700,7 @@
|
|
|
9937
10700
|
},
|
|
9938
10701
|
{
|
|
9939
10702
|
"disabled": false,
|
|
9940
|
-
"document": "
|
|
10703
|
+
"document": "<P>Public network bandwidth configuration.</p>.",
|
|
9941
10704
|
"example": "{\\\"Maximum\\\":999,\\\"Minimal\\\":198,\\\"step\\\":3,\\\"minimalZoneIds\\\":[100001,100002,200001,300001,400001],\\\"unsupportedRegionId\\\":[54,57,32,78,45,35]}",
|
|
9942
10705
|
"member": "string",
|
|
9943
10706
|
"name": "PublicNetworkLimit",
|
|
@@ -9947,7 +10710,7 @@
|
|
|
9947
10710
|
},
|
|
9948
10711
|
{
|
|
9949
10712
|
"disabled": false,
|
|
9950
|
-
"document": "Request
|
|
10713
|
+
"document": "<p>Request Id.</p>.",
|
|
9951
10714
|
"example": "a85846f2-95bd-454d-8edf-f4cfe618282f",
|
|
9952
10715
|
"member": "string",
|
|
9953
10716
|
"name": "RequestId",
|
|
@@ -9957,7 +10720,7 @@
|
|
|
9957
10720
|
},
|
|
9958
10721
|
{
|
|
9959
10722
|
"disabled": false,
|
|
9960
|
-
"document": "
|
|
10723
|
+
"document": "<P>Specifies the pagination offset.</p>.",
|
|
9961
10724
|
"example": "0",
|
|
9962
10725
|
"member": "int64",
|
|
9963
10726
|
"name": "Offset",
|
|
@@ -9967,7 +10730,7 @@
|
|
|
9967
10730
|
},
|
|
9968
10731
|
{
|
|
9969
10732
|
"disabled": false,
|
|
9970
|
-
"document": "
|
|
10733
|
+
"document": "<P>Specifies the pagination limit.</p>.",
|
|
9971
10734
|
"example": "20",
|
|
9972
10735
|
"member": "int64",
|
|
9973
10736
|
"name": "Limit",
|
|
@@ -9977,7 +10740,7 @@
|
|
|
9977
10740
|
},
|
|
9978
10741
|
{
|
|
9979
10742
|
"disabled": false,
|
|
9980
|
-
"document": "
|
|
10743
|
+
"document": "<P>Specifies whether the tag is mandatory.</p>.",
|
|
9981
10744
|
"example": "false",
|
|
9982
10745
|
"member": "bool",
|
|
9983
10746
|
"name": "ForceCheckTag",
|