tencentcloud-sdk-nodejs 4.1.107 → 4.1.109

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.
@@ -37,7 +37,7 @@ export interface PartitionOffset {
37
37
  */
38
38
  export interface DescribeACLRequest {
39
39
  /**
40
- * ckafka集群实例Id
40
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
41
41
  */
42
42
  InstanceId: string;
43
43
  /**
@@ -53,7 +53,7 @@ export interface DescribeACLRequest {
53
53
  */
54
54
  Offset?: number;
55
55
  /**
56
- * 个数限制
56
+ * 个数限制,默认值为50,最大值为50。
57
57
  */
58
58
  Limit?: number;
59
59
  /**
@@ -79,11 +79,11 @@ export interface DescribeTopicSyncReplicaResponse {
79
79
  */
80
80
  export interface FetchMessageByOffsetRequest {
81
81
  /**
82
- * ckafka集群实例Id
82
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
83
83
  */
84
84
  InstanceId: string;
85
85
  /**
86
- * 主题名
86
+ * 主题名,可通过DescribeTopic接口获取。
87
87
  */
88
88
  Topic: string;
89
89
  /**
@@ -116,7 +116,7 @@ export interface DescribeConnectResourceResp {
116
116
  */
117
117
  Type?: string;
118
118
  /**
119
- * 连接源的状态
119
+ * 连接源的状态 枚举值: -1 (创建失败) 、0 (创建中) 、 1 (运行中)、 2 (删除中) 、 4 (删除失败) 、 5 (配置更改中) 、 6 (配置更改失败) 、 7 (异常)
120
120
  */
121
121
  Status?: number;
122
122
  /**
@@ -350,7 +350,7 @@ export interface DtsParam {
350
350
  */
351
351
  export interface CancelAuthorizationTokenRequest {
352
352
  /**
353
- * ckafka集群实例Id
353
+ * ckafka集群实例Id,可通过DescribeInstances接口获取
354
354
  */
355
355
  InstanceId: string;
356
356
  /**
@@ -495,7 +495,7 @@ export interface Region {
495
495
  */
496
496
  export interface CreateAclRuleRequest {
497
497
  /**
498
- * ckafka集群实例Id
498
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
499
499
  */
500
500
  InstanceId: string;
501
501
  /**
@@ -515,11 +515,11 @@ export interface CreateAclRuleRequest {
515
515
  */
516
516
  RuleList: Array<AclRuleInfo>;
517
517
  /**
518
- * 表示前缀匹配的前缀的值
518
+ * 表示前缀匹配的前缀的值 (当PatternType取值为PREFIXED时,此参数必填)
519
519
  */
520
520
  Pattern?: string;
521
521
  /**
522
- * 预设ACL规则是否应用到新增的topic
522
+ * 预设ACL规则是否应用到新增的topic中。默认为0,表示否。取值为1时表示是。
523
523
  */
524
524
  IsApplied?: number;
525
525
  /**
@@ -584,7 +584,7 @@ export interface DescribeTaskStatusRequest {
584
584
  */
585
585
  export interface DescribeAclRuleRequest {
586
586
  /**
587
- * ckafka集群实例Id
587
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
588
588
  */
589
589
  InstanceId: string;
590
590
  /**
@@ -592,11 +592,11 @@ export interface DescribeAclRuleRequest {
592
592
  */
593
593
  RuleName?: string;
594
594
  /**
595
- * ACL规则匹配类型
595
+ * ACL规则匹配类型 (PREFIXED:前缀匹配,PRESET:预设策略)
596
596
  */
597
597
  PatternType?: string;
598
598
  /**
599
- * 是否读取简略的ACL规则
599
+ * 是否读取简略的ACL规则,默认值为false,表示不读取简略的ACL规则。
600
600
  */
601
601
  IsSimplified?: boolean;
602
602
  }
@@ -843,7 +843,7 @@ export interface FetchMessageListByOffsetResponse {
843
843
  */
844
844
  export interface DeleteRouteTriggerTimeRequest {
845
845
  /**
846
- * ckafka集群实例Id
846
+ * ckafka集群实例Id,可通过DescribeInstances接口获取
847
847
  */
848
848
  InstanceId: string;
849
849
  /**
@@ -945,11 +945,11 @@ export interface ModifyInstanceAttributesConfig {
945
945
  */
946
946
  AutoCreateTopicEnable?: boolean;
947
947
  /**
948
- * 可选,如果auto.create.topic.enable设置为true没有设置该值时,默认设置为3
948
+ * 新创建主题的默认分区数,如果AutoCreateTopicEnable设置为true没有设置该值时,默认设置为3
949
949
  */
950
950
  DefaultNumPartitions?: number;
951
951
  /**
952
- * 如果auto.create.topic.enable设置为true没有指定该值时默认设置为2
952
+ * 新创建主题的默认副本数,如果AutoCreateTopicEnable设置为true没有指定该值时默认设置为2
953
953
  */
954
954
  DefaultReplicationFactor?: number;
955
955
  }
@@ -958,7 +958,7 @@ export interface ModifyInstanceAttributesConfig {
958
958
  */
959
959
  export interface AuthorizeTokenRequest {
960
960
  /**
961
- * ckafka集群实例Id
961
+ * ckafka集群实例Id, 可通过DescribeInstances接口获取
962
962
  */
963
963
  InstanceId: string;
964
964
  /**
@@ -1534,11 +1534,11 @@ export interface PrometheusResult {
1534
1534
  */
1535
1535
  export interface ModifyRoutineMaintenanceTaskRequest {
1536
1536
  /**
1537
- * 实例id
1537
+ * ckafka集群实例id,可通过DescribeInstances接口获取
1538
1538
  */
1539
1539
  InstanceId: string;
1540
1540
  /**
1541
- * 自动化运维类别
1541
+ * 自动化运维类别, 类别如下: QUOTA、ANALYSIS、RE_BALANCE、ELASTIC_BANDWIDTH
1542
1542
  */
1543
1543
  MaintenanceType: string;
1544
1544
  /**
@@ -1570,7 +1570,7 @@ export interface ModifyRoutineMaintenanceTaskRequest {
1570
1570
  */
1571
1571
  ExtraConfig?: string;
1572
1572
  /**
1573
- * 任务状态
1573
+ * 任务状态,0 开启,1 关闭
1574
1574
  */
1575
1575
  Status?: number;
1576
1576
  /**
@@ -2159,11 +2159,11 @@ export interface BatchCreateAclResponse {
2159
2159
  */
2160
2160
  export interface DeleteRouteRequest {
2161
2161
  /**
2162
- * ckafka集群实例Id
2162
+ * ckafka集群实例Id,可通过DescribeInstances接口获取
2163
2163
  */
2164
2164
  InstanceId: string;
2165
2165
  /**
2166
- * 路由id
2166
+ * 路由id,可通过DescribeRoute接口获取
2167
2167
  */
2168
2168
  RouteId: number;
2169
2169
  /**
@@ -2171,7 +2171,7 @@ export interface DeleteRouteRequest {
2171
2171
  */
2172
2172
  CallerAppid?: number;
2173
2173
  /**
2174
- * 设置定时删除路由时间,若DeleteRouteTime < now ,设置时间小于当前接口提交时间则立即执行;DeleteRouteTime > now,设置时间大于当前接口提交时间,则按照设置的时间,定时执行删除; 该参数设置提交后,无法撤销!!!
2174
+ * 设置定时删除路由时间,仅类型为公网路由支持定时删除,可选择未来的24小时的任意时间
2175
2175
  */
2176
2176
  DeleteRouteTime?: string;
2177
2177
  }
@@ -2663,7 +2663,7 @@ export interface SecurityGroupRouteResp {
2663
2663
  */
2664
2664
  export interface DeleteAclRequest {
2665
2665
  /**
2666
- * ckafka集群实例Id
2666
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
2667
2667
  */
2668
2668
  InstanceId: string;
2669
2669
  /**
@@ -2687,7 +2687,7 @@ export interface DeleteAclRequest {
2687
2687
  */
2688
2688
  Host?: string;
2689
2689
  /**
2690
- * 用户列表,默认为*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户
2690
+ * 用户列表,默认为User:*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户
2691
2691
  */
2692
2692
  Principal?: string;
2693
2693
  }
@@ -2979,11 +2979,11 @@ export interface TopicMessageHeapRanking {
2979
2979
  */
2980
2980
  ReplicaNum?: number;
2981
2981
  /**
2982
- * Topic 流量
2982
+ * Topic 流量,单位为MB。
2983
2983
  */
2984
2984
  TopicTraffic?: string;
2985
2985
  /**
2986
- * topic消息堆积/占用磁盘
2986
+ * topic消息堆积/占用磁盘,单位为Bytes。
2987
2987
  */
2988
2988
  MessageHeap?: number;
2989
2989
  }
@@ -3009,6 +3009,7 @@ export interface InquireCkafkaPriceRequest {
3009
3009
  Bandwidth?: number;
3010
3010
  /**
3011
3011
  * 实例的硬盘购买类型以及大小 (购买时必填,专业版/高级版询价时磁盘信息必填)
3012
+
3012
3013
  */
3013
3014
  InquiryDiskParam?: InquiryDiskParam;
3014
3015
  /**
@@ -3021,6 +3022,9 @@ export interface InquireCkafkaPriceRequest {
3021
3022
  Topic?: number;
3022
3023
  /**
3023
3024
  * 购买实例分区数, 单位个 (购买时必填,专业版/高级版询价时带宽信息必填)
3025
+ 分区上限 最大值: 40000,步长: 100
3026
+ 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563
3027
+
3024
3028
  */
3025
3029
  Partition?: number;
3026
3030
  /**
@@ -3036,7 +3040,7 @@ export interface InquireCkafkaPriceRequest {
3036
3040
  */
3037
3041
  BillType?: string;
3038
3042
  /**
3039
- * 公网带宽计费模式, 目前只有专业版支持公网带宽 (购买公网带宽时必填)
3043
+ * 公网带宽计费模式, 目前只有专业版支持公网带宽 (购买公网带宽时必填),取值为3的倍数
3040
3044
  */
3041
3045
  PublicNetworkParam?: InquiryPublicNetworkParam;
3042
3046
  /**
@@ -3212,7 +3216,7 @@ export interface DeleteUserResponse {
3212
3216
  */
3213
3217
  export interface CreateAclRequest {
3214
3218
  /**
3215
- * ckafka集群实例Id
3219
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
3216
3220
  */
3217
3221
  InstanceId: string;
3218
3222
  /**
@@ -3531,11 +3535,11 @@ export interface CtsdbConnectParam {
3531
3535
  */
3532
3536
  export interface ModifyInstanceAttributesRequest {
3533
3537
  /**
3534
- * ckafka集群实例Id
3538
+ * ckafka集群实例Id,可通过DescribeInstances接口获取
3535
3539
  */
3536
3540
  InstanceId: string;
3537
3541
  /**
3538
- * 实例日志的最长保留时间,单位分钟,最大90天,0代表不开启日志保留时间回收策略
3542
+ * 实例日志的最长保留时间,单位分钟,最大90天,最小为1min
3539
3543
  */
3540
3544
  MsgRetentionTime?: number;
3541
3545
  /**
@@ -3568,7 +3572,7 @@ export interface ModifyInstanceAttributesRequest {
3568
3572
  */
3569
3573
  MaxMessageByte?: number;
3570
3574
  /**
3571
- * 集群topic默认 unclean.leader.election.enable配置: 1 开启 0 关闭
3575
+ * 是否允许未同步的副本选为 leader: 1 开启 0 关闭
3572
3576
  */
3573
3577
  UncleanLeaderElectionEnable?: number;
3574
3578
  /**
@@ -3704,7 +3708,7 @@ export interface DescribeGroupRequest {
3704
3708
  */
3705
3709
  export interface InstanceScalingDownRequest {
3706
3710
  /**
3707
- * ckafka集群实例Id
3711
+ * ckafka集群实例Id,可通过DescribeInstances接口获取
3708
3712
  */
3709
3713
  InstanceId: string;
3710
3714
  /**
@@ -3713,15 +3717,21 @@ export interface InstanceScalingDownRequest {
3713
3717
  */
3714
3718
  UpgradeStrategy: number;
3715
3719
  /**
3716
- * 磁盘大小 单位 GB
3720
+ * 磁盘大小 单位 GB 最大值为500000,步长100
3721
+ 可以通过以下链接查看规格限制:https://cloud.tencent.com/document/product/597/122562
3722
+
3723
+
3717
3724
  */
3718
3725
  DiskSize?: number;
3719
3726
  /**
3720
3727
  * 峰值带宽 单位 MB/s
3728
+ 可以通过以下链接查看规格限制及对应步长: https://cloud.tencent.com/document/product/597/11745
3721
3729
  */
3722
3730
  BandWidth?: number;
3723
3731
  /**
3724
- * 分区上限
3732
+ * 分区上限 最大值: 40000, 步长: 100
3733
+ 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563
3734
+
3725
3735
  */
3726
3736
  Partition?: number;
3727
3737
  }
@@ -3868,7 +3878,7 @@ export interface PrometheusDTO {
3868
3878
  */
3869
3879
  export interface CreateConsumerRequest {
3870
3880
  /**
3871
- * ckafka集群实例Id
3881
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
3872
3882
  */
3873
3883
  InstanceId: string;
3874
3884
  /**
@@ -3935,7 +3945,7 @@ export interface MqttConnectParam {
3935
3945
  */
3936
3946
  export interface FetchDatahubMessageByOffsetRequest {
3937
3947
  /**
3938
- * 弹性topic名称
3948
+ * 弹性topic名称,可通过DescribeDatahubTopics接口获取。
3939
3949
  */
3940
3950
  Name: string;
3941
3951
  /**
@@ -4145,19 +4155,24 @@ export interface DatahubTopicDTO {
4145
4155
  */
4146
4156
  export interface ModifyInstancePreRequest {
4147
4157
  /**
4148
- * ckafka集群实例Id
4158
+ * ckafka集群实例Id,可通过DescribeInstances接口获取
4149
4159
  */
4150
4160
  InstanceId: string;
4151
4161
  /**
4152
- * 预计磁盘,根据磁盘步长,规格向上调整。
4162
+ * 磁盘大小 单位 GB 最大值为500000,步长100
4163
+ 可以通过以下链接查看规格限制:https://cloud.tencent.com/document/product/597/122562
4164
+
4153
4165
  */
4154
4166
  DiskSize?: number;
4155
4167
  /**
4156
- * 预计带宽,根据带宽步长,规格向上调整。
4168
+ * 峰值带宽 单位 MB/s
4169
+ 可以通过以下链接查看规格限制及对应步长: https://cloud.tencent.com/document/product/597/11745
4170
+
4157
4171
  */
4158
4172
  BandWidth?: number;
4159
4173
  /**
4160
- * 预计分区,根据带宽步长,规格向上调整。
4174
+ * 分区上限 最大值: 40000, 步长: 100
4175
+ 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563
4161
4176
  */
4162
4177
  Partition?: number;
4163
4178
  }
@@ -4196,7 +4211,7 @@ export interface TopicPartitionDO {
4196
4211
  */
4197
4212
  Partition?: number;
4198
4213
  /**
4199
- * Leader 运行状态
4214
+ * Leader 运行状态,0表示正常运行
4200
4215
  */
4201
4216
  LeaderStatus?: number;
4202
4217
  /**
@@ -4497,7 +4512,7 @@ export interface DescribeDatahubTaskRes {
4497
4512
  */
4498
4513
  export interface DescribePrometheusRequest {
4499
4514
  /**
4500
- * ckafka集群实例Id
4515
+ * ckafka集群实例Id,可通过DescribeInstances接口获取
4501
4516
  */
4502
4517
  InstanceId: string;
4503
4518
  }
@@ -4683,11 +4698,11 @@ export interface DropCls {
4683
4698
  */
4684
4699
  export interface DeleteUserRequest {
4685
4700
  /**
4686
- * ckafka集群实例Id
4701
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
4687
4702
  */
4688
4703
  InstanceId: string;
4689
4704
  /**
4690
- * 用户名称
4705
+ * 用户名称,可通过DescribeUser接口获取。
4691
4706
  */
4692
4707
  Name: string;
4693
4708
  }
@@ -5100,7 +5115,7 @@ export interface ZoneInfo {
5100
5115
  */
5101
5116
  ZoneName?: string;
5102
5117
  /**
5103
- * 可用区状态
5118
+ * 可用区状态 枚举示例: 3: 开启,4: 关闭; 可用区状态以SoldOut为准
5104
5119
  */
5105
5120
  ZoneStatus?: number;
5106
5121
  /**
@@ -5139,11 +5154,11 @@ export interface DescribeTopicSubscribeGroupResponse {
5139
5154
  */
5140
5155
  export interface DeleteAclRuleRequest {
5141
5156
  /**
5142
- * 实例id信息
5157
+ * 实例id信息,可通过DescribeInstances接口获取。
5143
5158
  */
5144
5159
  InstanceId: string;
5145
5160
  /**
5146
- * acl规则名称
5161
+ * acl规则名称,可通过DescribeAclRule接口获取。
5147
5162
  */
5148
5163
  RuleName: string;
5149
5164
  }
@@ -5234,7 +5249,7 @@ export interface ModifyConnectResourceRequest {
5234
5249
  */
5235
5250
  export interface CreateTokenRequest {
5236
5251
  /**
5237
- * ckafka集群实例Id
5252
+ * ckafka集群实例Id,可通过DescribeInstances接口获取
5238
5253
  */
5239
5254
  InstanceId: string;
5240
5255
  /**
@@ -5272,7 +5287,7 @@ export interface TdwParam {
5272
5287
  */
5273
5288
  export interface DescribeCvmInfoRequest {
5274
5289
  /**
5275
- * ckafka集群实例Id
5290
+ * ckafka集群实例Id,可通过DescribeInstances接口获取
5276
5291
  */
5277
5292
  InstanceId: string;
5278
5293
  }
@@ -5324,7 +5339,7 @@ export interface BrokerTopicData {
5324
5339
  */
5325
5340
  TopicId?: string;
5326
5341
  /**
5327
- * 主题占用Broker 容量大小
5342
+ * 主题占用Broker 容量大小,单位为Bytes。
5328
5343
  */
5329
5344
  DataSize?: number;
5330
5345
  }
@@ -5342,7 +5357,7 @@ export interface BatchAnalyseParam {
5342
5357
  */
5343
5358
  export interface DeleteInstancePostRequest {
5344
5359
  /**
5345
- * ckafka集群实例Id
5360
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
5346
5361
  */
5347
5362
  InstanceId: string;
5348
5363
  }
@@ -5731,7 +5746,7 @@ export interface ZoneResponse {
5731
5746
  */
5732
5747
  export interface DeleteInstancePreRequest {
5733
5748
  /**
5734
- * ckafka集群实例Id
5749
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
5735
5750
  */
5736
5751
  InstanceId: string;
5737
5752
  }
@@ -5879,7 +5894,7 @@ export interface ModifyInstancePreResponse {
5879
5894
  */
5880
5895
  export interface CreateUserRequest {
5881
5896
  /**
5882
- * ckafka集群实例Id
5897
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
5883
5898
  */
5884
5899
  InstanceId: string;
5885
5900
  /**
@@ -5988,7 +6003,7 @@ export interface CvmAndIpInfo {
5988
6003
  */
5989
6004
  CkafkaInstanceId?: string;
5990
6005
  /**
5991
- * CVM实例ID
6006
+ * CVM实例ID(ins-test )或POD IP(10.0.0.30)
5992
6007
  */
5993
6008
  InstanceId?: string;
5994
6009
  /**
@@ -6278,15 +6293,15 @@ export interface PostgreSQLParam {
6278
6293
  */
6279
6294
  export interface CreateTopicIpWhiteListRequest {
6280
6295
  /**
6281
- * ckafka集群实例Id
6296
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
6282
6297
  */
6283
6298
  InstanceId: string;
6284
6299
  /**
6285
- * 主题名称
6300
+ * 主题名称,可通过DescribeTopic接口获取
6286
6301
  */
6287
6302
  TopicName: string;
6288
6303
  /**
6289
- * ip白名单列表
6304
+ * ip白名单列表,最大值为512,即最大允许传入512个ip。
6290
6305
  */
6291
6306
  IpWhiteList: Array<string>;
6292
6307
  }
@@ -6405,7 +6420,7 @@ export interface ModifyTopicAttributesRequest {
6405
6420
  */
6406
6421
  export interface CreateInstancePreRequest {
6407
6422
  /**
6408
- * ckafka集群实例Name,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
6423
+ * ckafka集群实例Name,是一个不超过 128 个字符的任意字符串。
6409
6424
  */
6410
6425
  InstanceName: string;
6411
6426
  /**
@@ -6429,7 +6444,7 @@ export interface CreateInstancePreRequest {
6429
6444
  */
6430
6445
  SubnetId: string;
6431
6446
  /**
6432
- * 可选。实例日志的最长保留时间,单位分钟,默认为100807天),最大30天,不填默认0,代表不开启日志保留时间回收策略
6447
+ * 可选。实例日志的最长保留时间,单位分钟,不填默认为14401天),可设置范围为1分钟到90天。
6433
6448
  */
6434
6449
  MsgRetentionTime?: number;
6435
6450
  /**
@@ -6441,7 +6456,7 @@ export interface CreateInstancePreRequest {
6441
6456
  */
6442
6457
  RenewFlag?: number;
6443
6458
  /**
6444
- * CKafka版本号[0.10.2、1.1.1、2.4.12.4.22.8.13.2.3], 默认是1.1.1。2.4.1 与 2.4.2 属于同一个版本,传任意一个均可。
6459
+ * CKafka版本号[2.4.1, 2.4.2, 2.8.1, 3.2.3], 默认取值是2.4.1。2.4.1 与 2.4.2 属于同一个版本,传任意一个均可。
6445
6460
  */
6446
6461
  KafkaVersion?: string;
6447
6462
  /**
@@ -6449,15 +6464,15 @@ export interface CreateInstancePreRequest {
6449
6464
  */
6450
6465
  SpecificationsType?: string;
6451
6466
  /**
6452
- * 磁盘大小,如果跟控制台规格配比不相符,则无法创建成功
6467
+ * 磁盘大小,如果跟控制台规格配比不相符,则无法创建成功。默认取值为500,步长设置为100。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122562
6453
6468
  */
6454
6469
  DiskSize?: number;
6455
6470
  /**
6456
- * 实例带宽,单位MB/s; 最小值:20MB/s, 高级版最大值:360MB/s,专业版最大值:100000MB/s 标准版固定带宽规格: 40MB/s, 100MB/s, 150MB/s
6471
+ * 实例带宽,默认值为40,单位MB/s; 最小值:20MB/s, 高级版最大值:360MB/s,专业版最大值:100000MB/s 标准版固定带宽规格: 40MB/s, 100MB/s, 150MB/s。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/11745
6457
6472
  */
6458
6473
  BandWidth?: number;
6459
6474
  /**
6460
- * 分区大小,如果跟控制台规格配比不相符,则无法创建成功
6475
+ * 分区大小,如果跟控制台规格配比不相符,则无法创建成功。默认值为800,步长为100。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122563
6461
6476
  */
6462
6477
  Partition?: number;
6463
6478
  /**
@@ -6629,7 +6644,7 @@ export interface ReplaceParam {
6629
6644
  */
6630
6645
  export interface BatchCreateAclRequest {
6631
6646
  /**
6632
- * ckafka集群实例Id
6647
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
6633
6648
  */
6634
6649
  InstanceId: string;
6635
6650
  /**
@@ -6637,11 +6652,11 @@ export interface BatchCreateAclRequest {
6637
6652
  */
6638
6653
  ResourceType: number;
6639
6654
  /**
6640
- * 资源列表数组
6655
+ * 资源列表数组,可通过DescribeTopic接口获取。
6641
6656
  */
6642
6657
  ResourceNames: Array<string>;
6643
6658
  /**
6644
- * 设置的ACL规则列表
6659
+ * 设置的ACL规则列表,可通过DescribeAclRule接口获取。
6645
6660
  */
6646
6661
  RuleList: Array<AclRuleInfo>;
6647
6662
  }
@@ -6675,15 +6690,15 @@ export interface DescribeConnectResourcesRequest {
6675
6690
  */
6676
6691
  export interface CreatePartitionRequest {
6677
6692
  /**
6678
- * ckafka集群实例Id
6693
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
6679
6694
  */
6680
6695
  InstanceId: string;
6681
6696
  /**
6682
- * 主题名称
6697
+ * 主题名称,可通过DescribeTopic接口获取。
6683
6698
  */
6684
6699
  TopicName: string;
6685
6700
  /**
6686
- * 主题分区个数
6701
+ * 主题分区个数,传入参数为修改后的分区数,而不是增加的分区数,因此传入参数需要大于当前主题分区个数。
6687
6702
  */
6688
6703
  PartitionNum: number;
6689
6704
  }
@@ -6787,27 +6802,27 @@ export interface MySQLConnectParam {
6787
6802
  */
6788
6803
  export interface CreateRouteRequest {
6789
6804
  /**
6790
- * 实例唯一id
6805
+ * ckafka集群实例id,可通过DescribeInstances接口获取
6791
6806
  */
6792
6807
  InstanceId: string;
6793
6808
  /**
6794
- * 路由网络类型(3:vpc路由;7:内部支撑路由)
6809
+ * 路由网络类型(3:vpc路由;7:内部支撑路由;1:公网路由)
6795
6810
  */
6796
6811
  VipType: number;
6797
6812
  /**
6798
- * vpc网络Id
6813
+ * vpc网络Id,当vipType为3时必填
6799
6814
  */
6800
6815
  VpcId?: string;
6801
6816
  /**
6802
- * vpc子网id
6817
+ * vpc子网id,当vipType为3时必填
6803
6818
  */
6804
6819
  SubnetId?: string;
6805
6820
  /**
6806
- * 访问类型:0-plaintext;1-sasl_plaintext;2-ssl;3-sasl_ssl
6821
+ * 访问类型:0-plaintext;1-sasl_plaintext;2-ssl;3-sasl_ssl,默认为0
6807
6822
  */
6808
6823
  AccessType?: number;
6809
6824
  /**
6810
- * 是否需要权限管理
6825
+ * 是否需要权限管理,该字段已废弃
6811
6826
  */
6812
6827
  AuthFlag?: number;
6813
6828
  /**
@@ -6815,7 +6830,7 @@ export interface CreateRouteRequest {
6815
6830
  */
6816
6831
  CallerAppid?: number;
6817
6832
  /**
6818
- * 公网带宽
6833
+ * 公网带宽,公网路由必传,且必选时3的倍数,无默认值
6819
6834
  */
6820
6835
  PublicNetwork?: number;
6821
6836
  /**
@@ -6861,7 +6876,36 @@ export interface SQLServerModifyConnectParam {
6861
6876
  */
6862
6877
  export interface DatahubResource {
6863
6878
  /**
6864
- * 资源类型
6879
+ * 资源类型 type类型如下:
6880
+ KAFKA,
6881
+ EB_ES,
6882
+ EB_COS,
6883
+ EB_CLS,
6884
+ EB_,
6885
+ MONGODB,
6886
+ HTTP,
6887
+ TDW,
6888
+ ES,
6889
+ CLICKHOUSE,
6890
+ DTS,
6891
+ CLS,
6892
+ COS,
6893
+ TOPIC,
6894
+ MYSQL,
6895
+ MQTT,
6896
+ MYSQL_DATA,
6897
+ DORIS,
6898
+ POSTGRESQL,
6899
+ TDSQL_C_POSTGRESQL,
6900
+ TDSQL_POSTGRESQL,
6901
+ WAREHOUSE_POSTGRESQL,
6902
+ TDSQL_C_MYSQL,
6903
+ MARIADB,
6904
+ SQLSERVER,
6905
+ CTSDB,
6906
+ SCF
6907
+
6908
+
6865
6909
  */
6866
6910
  Type: string;
6867
6911
  /**
@@ -7402,11 +7446,11 @@ export interface ClusterInfo {
7402
7446
  */
7403
7447
  export interface DeleteGroupRequest {
7404
7448
  /**
7405
- * ckafka集群实例Id
7449
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
7406
7450
  */
7407
7451
  InstanceId: string;
7408
7452
  /**
7409
- * 消费分组
7453
+ * 消费组名称,可通过DescribeConsumerGroup接口获取。
7410
7454
  */
7411
7455
  Group: string;
7412
7456
  }
@@ -7810,11 +7854,11 @@ export interface Config {
7810
7854
  */
7811
7855
  export interface ModifyPasswordRequest {
7812
7856
  /**
7813
- * 实例Id
7857
+ * 实例Id,可通过DescribeInstances接口获取。
7814
7858
  */
7815
7859
  InstanceId: string;
7816
7860
  /**
7817
- * 用户名称
7861
+ * 用户名称,可通过DescribeUser接口获取。
7818
7862
  */
7819
7863
  Name: string;
7820
7864
  /**
@@ -8126,7 +8170,7 @@ export interface DescribeTopicFlowRankingResponse {
8126
8170
  */
8127
8171
  export interface CreateDatahubTaskRequest {
8128
8172
  /**
8129
- * 任务名称
8173
+ * 任务名称,只能以字母起始,允许包含字母、数字、- 、. 、 下划线且长度不超过64 (、为分割符号规则不包含)
8130
8174
  */
8131
8175
  TaskName: string;
8132
8176
  /**
@@ -8326,15 +8370,15 @@ export interface AclRuleInfo {
8326
8370
  */
8327
8371
  Operation: string;
8328
8372
  /**
8329
- * 权限类型,(DenyAllow)
8373
+ * 权限类型,Deny:拒绝,Allow:允许。
8330
8374
  */
8331
8375
  PermissionType: string;
8332
8376
  /**
8333
- * 默认为\*,表示任何host都可以访问,当前ckafka不支持host为\* 和 ip网段
8377
+ * 表示任何host都可以访问
8334
8378
  */
8335
8379
  Host: string;
8336
8380
  /**
8337
- * 用户列表,默认为User:*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户。传入格式需要带【User:】前缀。例如用户A,传入为User:A。
8381
+ * 用户,User:*表示任何user都可以访问,当前用户只能是用户列表中包含的用户。传入格式需要带【User:】前缀。例如用户A,传入为User:A。
8338
8382
  */
8339
8383
  Principal: string;
8340
8384
  }
@@ -8343,7 +8387,7 @@ export interface AclRuleInfo {
8343
8387
  */
8344
8388
  export interface RenewCkafkaInstanceRequest {
8345
8389
  /**
8346
- * ckafka集群实例Id
8390
+ * ckafka集群实例Id,可通过DescribeInstances接口获取
8347
8391
  */
8348
8392
  InstanceId: string;
8349
8393
  /**
@@ -8411,11 +8455,11 @@ export interface SecondaryAnalyseParam {
8411
8455
  */
8412
8456
  export interface DeleteTopicIpWhiteListRequest {
8413
8457
  /**
8414
- * ckafka集群实例Id
8458
+ * ckafka集群实例Id,可通过DescribeInstances接口获取。
8415
8459
  */
8416
8460
  InstanceId: string;
8417
8461
  /**
8418
- * 主题名
8462
+ * 主题名,可通过DescribeTopic接口获取。
8419
8463
  */
8420
8464
  TopicName: string;
8421
8465
  /**
@@ -8521,7 +8565,7 @@ export interface ModifyDatahubTaskRequest {
8521
8565
  */
8522
8566
  export interface CreatePrometheusRequest {
8523
8567
  /**
8524
- * ckafka集群实例Id
8568
+ * ckafka集群实例Id,可通过DescribeInstances接口获取
8525
8569
  */
8526
8570
  InstanceId: string;
8527
8571
  /**