@ucloud-sdks/ucloud-sdk-js 0.2.9 → 0.2.11

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.
@@ -111,6 +111,15 @@ class UDBClient extends client_1.default {
111
111
  const args = Object.assign({ Action: 'CreateUDBInstanceByRecovery' }, (request || {}));
112
112
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
113
113
  }
114
+ /**
115
+ * CreateUDBMySQLInstance - 创建UDB实例(包括创建mysql NVMe、共享型和O2实例以及从备份恢复实例)
116
+ *
117
+ * See also: https://docs.ucloud.cn/api/udb-api/create_udb_my_sql_instance
118
+ */
119
+ createUDBMySQLInstance(request) {
120
+ const args = Object.assign({ Action: 'CreateUDBMySQLInstance' }, (request || {}));
121
+ return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
122
+ }
114
123
  /**
115
124
  * CreateUDBParamGroup - 从已有配置文件创建新配置文件
116
125
  *
@@ -138,6 +147,15 @@ class UDBClient extends client_1.default {
138
147
  const args = Object.assign({ Action: 'CreateUDBRouteInstance' }, (request || {}));
139
148
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
140
149
  }
150
+ /**
151
+ * CreateUDBSQLServerInstance - 创建UDB实例(包括创建SQLServer实例以及从备份恢复实例)
152
+ *
153
+ * See also: https://docs.ucloud.cn/api/udb-api/create_udb_sql_server_instance
154
+ */
155
+ createUDBSQLServerInstance(request) {
156
+ const args = Object.assign({ Action: 'CreateUDBSQLServerInstance' }, (request || {}));
157
+ return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
158
+ }
141
159
  /**
142
160
  * CreateUDBSlave - 创建UDB实例的slave
143
161
  *
@@ -175,7 +193,7 @@ class UDBClient extends client_1.default {
175
193
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
176
194
  }
177
195
  /**
178
- * DescribeUDBBackup - 列表UDB实例备份信息
196
+ * DescribeUDBBackup - 列表UDB实例备份信息.Zone不填表示多可用区,填代表单可用区
179
197
  *
180
198
  * See also: https://docs.ucloud.cn/api/udb-api/describe_udb_backup
181
199
  */
@@ -193,7 +211,16 @@ class UDBClient extends client_1.default {
193
211
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
194
212
  }
195
213
  /**
196
- * DescribeUDBBinlogBackupURL - 获取UDBBinlog备份地址
214
+ * DescribeUDBBinlogBackup - 列表UDB实例Binlog自动备份信息
215
+ *
216
+ * See also: https://docs.ucloud.cn/api/udb-api/describe_udb_binlog_backup
217
+ */
218
+ describeUDBBinlogBackup(request) {
219
+ const args = Object.assign({ Action: 'DescribeUDBBinlogBackup' }, (request || {}));
220
+ return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
221
+ }
222
+ /**
223
+ * DescribeUDBBinlogBackupURL - 获取UDB的Binlog或者错误日志或者慢查询日志的备份地址
197
224
  *
198
225
  * See also: https://docs.ucloud.cn/api/udb-api/describe_udb_binlog_backup_url
199
226
  */
@@ -283,7 +310,7 @@ class UDBClient extends client_1.default {
283
310
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
284
311
  }
285
312
  /**
286
- * DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址
313
+ * DescribeUDBLogBackupURL - 获取UDB的错误日志或者慢查询日志备份地址
287
314
  *
288
315
  * See also: https://docs.ucloud.cn/api/udb-api/describe_udb_log_backup_url
289
316
  */
@@ -381,6 +408,33 @@ class UDBClient extends client_1.default {
381
408
  const args = Object.assign({ Action: 'GetUDBClientConnNum' }, (request || {}));
382
409
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
383
410
  }
411
+ /**
412
+ * GetUDBInstanceSSLCertURL - 获取SSL证书下载地址
413
+ *
414
+ * See also: https://docs.ucloud.cn/api/udb-api/get_udb_instance_ssl_cert_url
415
+ */
416
+ getUDBInstanceSSLCertURL(request) {
417
+ const args = Object.assign({ Action: 'GetUDBInstanceSSLCertURL' }, (request || {}));
418
+ return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
419
+ }
420
+ /**
421
+ * ListUDBMachineType - 获取UDB云数据库支持的计算规格列表,暂不支持获取跨可用区实例的计算规格,目前支持的数据库品类包括:NVMe版和SSD云盘版MySQL
422
+ *
423
+ * See also: https://docs.ucloud.cn/api/udb-api/list_udb_machine_type
424
+ */
425
+ listUDBMachineType(request) {
426
+ const args = Object.assign({ Action: 'ListUDBMachineType' }, (request || {}));
427
+ return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
428
+ }
429
+ /**
430
+ * ListUDBUserTables - 查看udb实例所有的用户表集合 (只包括引擎为innodb和myisam的表)
431
+ *
432
+ * See also: https://docs.ucloud.cn/api/udb-api/list_udb_user_tables
433
+ */
434
+ listUDBUserTables(request) {
435
+ const args = Object.assign({ Action: 'ListUDBUserTables' }, (request || {}));
436
+ return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
437
+ }
384
438
  /**
385
439
  * ModifyUDBInstanceName - 重命名UDB实例
386
440
  *
@@ -399,6 +453,24 @@ class UDBClient extends client_1.default {
399
453
  const args = Object.assign({ Action: 'ModifyUDBInstancePassword' }, (request || {}));
400
454
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
401
455
  }
456
+ /**
457
+ * ModifyUDBInstanceRemarkName - 修改UDB实例备注信息
458
+ *
459
+ * See also: https://docs.ucloud.cn/api/udb-api/modify_udb_instance_remark_name
460
+ */
461
+ modifyUDBInstanceRemarkName(request) {
462
+ const args = Object.assign({ Action: 'ModifyUDBInstanceRemarkName' }, (request || {}));
463
+ return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
464
+ }
465
+ /**
466
+ * ModifyUDBInstanceSSL - 调整SSL的信息
467
+ *
468
+ * See also: https://docs.ucloud.cn/api/udb-api/modify_udb_instance_ssl
469
+ */
470
+ modifyUDBInstanceSSL(request) {
471
+ const args = Object.assign({ Action: 'ModifyUDBInstanceSSL' }, (request || {}));
472
+ return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
473
+ }
402
474
  /**
403
475
  * PromoteUDBInstanceToHA - 普通db升级为高可用(只针对mysql5.5及以上版本SSD机型的实例) ,对于NVMe机型的单点升级高可用,虽然也能使用该操作再加上SwitchUDBInstanceToHA,但是更建议直接调用新的API接口(UpgradeUDBInstanceToHA)
404
476
  *
@@ -444,6 +516,15 @@ class UDBClient extends client_1.default {
444
516
  const args = Object.assign({ Action: 'RestartUDBInstance' }, (request || {}));
445
517
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
446
518
  }
519
+ /**
520
+ * RollbackUDBInstance - 在原实例回档指定库表
521
+ *
522
+ * See also: https://docs.ucloud.cn/api/udb-api/rollback_udb_instance
523
+ */
524
+ rollbackUDBInstance(request) {
525
+ const args = Object.assign({ Action: 'RollbackUDBInstance' }, (request || {}));
526
+ return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
527
+ }
447
528
  /**
448
529
  * SetUDBRWSplitting - 设置读写分离的模式
449
530
  *
@@ -525,6 +606,15 @@ class UDBClient extends client_1.default {
525
606
  const args = Object.assign({ Action: 'UpgradeUDBInstanceToHA' }, (request || {}));
526
607
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
527
608
  }
609
+ /**
610
+ * UpgradeUDBVersion - 升级db实例版本
611
+ *
612
+ * See also: https://docs.ucloud.cn/api/udb-api/upgrade_udb_version
613
+ */
614
+ upgradeUDBVersion(request) {
615
+ const args = Object.assign({ Action: 'UpgradeUDBVersion' }, (request || {}));
616
+ return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
617
+ }
528
618
  /**
529
619
  * UploadUDBParamGroup - 导入UDB配置
530
620
  *
@@ -16,7 +16,7 @@ export default class UHadoopClient extends Client {
16
16
  */
17
17
  addUHadoopInstanceNode(request?: AddUHadoopInstanceNodeRequest): Promise<AddUHadoopInstanceNodeResponse>;
18
18
  /**
19
- * CreateUHadoopInstance - 新建一个uhadoop集群
19
+ * CreateUHadoopInstance - 创建实例接口。\\ 创建实例前需要按以下步骤准备必要参数:\\ 1.获取Region(地域)和 Zone(可用区),访问链接:https://docs.ucloud.cn/api/summary/regionlist 可以获取所有支持的地域和可用区;\\ 2.FrameworkVersion,访问链接:https://docs.ucloud.cn/api/uhadoop-api/list_uhadoop_framework_app_by_use_case,响应字段的AppConfigSet[N].FrameworkVersion是框架版本是支持的 UHadoop 版本;\\ 3.ChargeType付费类型,可用值:Dynamic为按小时付费,Month为按月付费,Year为按年付费;\\ 4.InstanceGroupConfigs需要获取NodeType机型详情,访问链接:https://docs.ucloud.cn/api/uhadoop-api/get_uhadoop_node_type,响应字段的InstanceTypeSet[N].NodeType是机型名称,响应字段的InstanceTypeSet[N].SuitableRole是机型可用的节点类型;\\ 5.获取DiskSize磁盘大小范围 ,访问链接:https://docs.ucloud.cn/api/uhadoop-api/get_uhadoop_node_type,该接口响应字段的InstanceTypeSet[N].DiskSet[N].DiskMinSize和InstanceTypeSet[N].DiskSet[N].DiskMaxSize是磁盘大小的取值范围;\\ 6.InstanceName,自定义输入实例名称,只能包含中英文、数字以及- _ ;\\7.Password,集群机器的登录密码,需要输入base64编码后的内容;\\8.AppConfigs 集群需要安装的组件,访问链接,https://docs.ucloud.cn/api/uhadoop-api/list_uhadoop_framework_app ,AppConfigSet[N].AppName是组件名称,AppConfigSet[N].AppVersion是组件版本
20
20
  *
21
21
  * See also: https://docs.ucloud.cn/api/uhadoop-api/create_uhadoop_instance
22
22
  */
@@ -131,7 +131,7 @@ export interface AddUHadoopInstanceNodeRequest {
131
131
  export interface AddUHadoopInstanceNodeResponse {
132
132
  }
133
133
  /**
134
- * CreateUHadoopInstance - 新建一个uhadoop集群
134
+ * CreateUHadoopInstance - 创建实例接口。\\ 创建实例前需要按以下步骤准备必要参数:\\ 1.获取Region(地域)和 Zone(可用区),访问链接:https://docs.ucloud.cn/api/summary/regionlist 可以获取所有支持的地域和可用区;\\ 2.FrameworkVersion,访问链接:https://docs.ucloud.cn/api/uhadoop-api/list_uhadoop_framework_app_by_use_case,响应字段的AppConfigSet[N].FrameworkVersion是框架版本是支持的 UHadoop 版本;\\ 3.ChargeType付费类型,可用值:Dynamic为按小时付费,Month为按月付费,Year为按年付费;\\ 4.InstanceGroupConfigs需要获取NodeType机型详情,访问链接:https://docs.ucloud.cn/api/uhadoop-api/get_uhadoop_node_type,响应字段的InstanceTypeSet[N].NodeType是机型名称,响应字段的InstanceTypeSet[N].SuitableRole是机型可用的节点类型;\\ 5.获取DiskSize磁盘大小范围 ,访问链接:https://docs.ucloud.cn/api/uhadoop-api/get_uhadoop_node_type,该接口响应字段的InstanceTypeSet[N].DiskSet[N].DiskMinSize和InstanceTypeSet[N].DiskSet[N].DiskMaxSize是磁盘大小的取值范围;\\ 6.InstanceName,自定义输入实例名称,只能包含中英文、数字以及- _ ;\\7.Password,集群机器的登录密码,需要输入base64编码后的内容;\\8.AppConfigs 集群需要安装的组件,访问链接,https://docs.ucloud.cn/api/uhadoop-api/list_uhadoop_framework_app ,AppConfigSet[N].AppName是组件名称,AppConfigSet[N].AppVersion是组件版本
135
135
  */
136
136
  export interface CreateUHadoopInstanceRequest {
137
137
  /**
@@ -139,7 +139,7 @@ export interface CreateUHadoopInstanceRequest {
139
139
  */
140
140
  Zone: string;
141
141
  /**
142
- * 集群机器的登录密码
142
+ * 集群机器的登录密码,需要输入base64编码后的内容
143
143
  */
144
144
  Password: string;
145
145
  /**
@@ -161,7 +161,7 @@ export interface CreateUHadoopInstanceRequest {
161
161
  /**
162
162
  * 集群需要安装的组件,格式:组件#版本通过ListUHadoopFrameworkApp接口获取,例如:Spark#3.3.0
163
163
  */
164
- AppConfig: string[];
164
+ AppConfigs: string[];
165
165
  /**
166
166
  * 框架,值为'Hadoop'|'HDFS'|'MR'|'StarRocks'之一,框架,例如Hadoop|MR|HDFS|StarRocks Hadoop框架包含存储与计算服务 MR集群包含计算服务 HDFS只包含存储服务,StarRocks为StarRocks集群
167
167
  */
@@ -216,7 +216,7 @@ export interface CreateUHadoopInstanceRequest {
216
216
  InstanceName?: string;
217
217
  }
218
218
  /**
219
- * CreateUHadoopInstance - 新建一个uhadoop集群
219
+ * CreateUHadoopInstance - 创建实例接口。\\ 创建实例前需要按以下步骤准备必要参数:\\ 1.获取Region(地域)和 Zone(可用区),访问链接:https://docs.ucloud.cn/api/summary/regionlist 可以获取所有支持的地域和可用区;\\ 2.FrameworkVersion,访问链接:https://docs.ucloud.cn/api/uhadoop-api/list_uhadoop_framework_app_by_use_case,响应字段的AppConfigSet[N].FrameworkVersion是框架版本是支持的 UHadoop 版本;\\ 3.ChargeType付费类型,可用值:Dynamic为按小时付费,Month为按月付费,Year为按年付费;\\ 4.InstanceGroupConfigs需要获取NodeType机型详情,访问链接:https://docs.ucloud.cn/api/uhadoop-api/get_uhadoop_node_type,响应字段的InstanceTypeSet[N].NodeType是机型名称,响应字段的InstanceTypeSet[N].SuitableRole是机型可用的节点类型;\\ 5.获取DiskSize磁盘大小范围 ,访问链接:https://docs.ucloud.cn/api/uhadoop-api/get_uhadoop_node_type,该接口响应字段的InstanceTypeSet[N].DiskSet[N].DiskMinSize和InstanceTypeSet[N].DiskSet[N].DiskMaxSize是磁盘大小的取值范围;\\ 6.InstanceName,自定义输入实例名称,只能包含中英文、数字以及- _ ;\\7.Password,集群机器的登录密码,需要输入base64编码后的内容;\\8.AppConfigs 集群需要安装的组件,访问链接,https://docs.ucloud.cn/api/uhadoop-api/list_uhadoop_framework_app ,AppConfigSet[N].AppName是组件名称,AppConfigSet[N].AppVersion是组件版本
220
220
  */
221
221
  export interface CreateUHadoopInstanceResponse {
222
222
  /**
@@ -22,7 +22,7 @@ class UHadoopClient extends client_1.default {
22
22
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
23
23
  }
24
24
  /**
25
- * CreateUHadoopInstance - 新建一个uhadoop集群
25
+ * CreateUHadoopInstance - 创建实例接口。\\ 创建实例前需要按以下步骤准备必要参数:\\ 1.获取Region(地域)和 Zone(可用区),访问链接:https://docs.ucloud.cn/api/summary/regionlist 可以获取所有支持的地域和可用区;\\ 2.FrameworkVersion,访问链接:https://docs.ucloud.cn/api/uhadoop-api/list_uhadoop_framework_app_by_use_case,响应字段的AppConfigSet[N].FrameworkVersion是框架版本是支持的 UHadoop 版本;\\ 3.ChargeType付费类型,可用值:Dynamic为按小时付费,Month为按月付费,Year为按年付费;\\ 4.InstanceGroupConfigs需要获取NodeType机型详情,访问链接:https://docs.ucloud.cn/api/uhadoop-api/get_uhadoop_node_type,响应字段的InstanceTypeSet[N].NodeType是机型名称,响应字段的InstanceTypeSet[N].SuitableRole是机型可用的节点类型;\\ 5.获取DiskSize磁盘大小范围 ,访问链接:https://docs.ucloud.cn/api/uhadoop-api/get_uhadoop_node_type,该接口响应字段的InstanceTypeSet[N].DiskSet[N].DiskMinSize和InstanceTypeSet[N].DiskSet[N].DiskMaxSize是磁盘大小的取值范围;\\ 6.InstanceName,自定义输入实例名称,只能包含中英文、数字以及- _ ;\\7.Password,集群机器的登录密码,需要输入base64编码后的内容;\\8.AppConfigs 集群需要安装的组件,访问链接,https://docs.ucloud.cn/api/uhadoop-api/list_uhadoop_framework_app ,AppConfigSet[N].AppName是组件名称,AppConfigSet[N].AppVersion是组件版本
26
26
  *
27
27
  * See also: https://docs.ucloud.cn/api/uhadoop-api/create_uhadoop_instance
28
28
  */
@@ -16,7 +16,7 @@ export default class UKafkaClient extends Client {
16
16
  */
17
17
  addUKafkaInstanceNode(request?: AddUKafkaInstanceNodeRequest): Promise<AddUKafkaInstanceNodeResponse>;
18
18
  /**
19
- * CreateUKafkaInstance - 创建一个ukafka实例
19
+ * CreateUKafkaInstance - 创建实例接口。\\ 创建实例前需要按以下步骤准备必要参数:\\ 1.获取Region(地域)和 Zone(可用区),访问链接:https://docs.ucloud.cn/api/summary/regionlist 可以获取所有支持的地域和可用区;\\ 2.获取FrameworkVersion,访问链接:https://docs.ucloud.cn/api/ukafka-api/list_ukafka_framework_version,响应字段的FrameworkVersions[N].Version是支持的 Kafka 版本;\\ 3.ChargeType付费类型,可用值:Dynamic为按小时付费,Month为按月付费,Year为按年付费;\\ 4.获取NodeType机型详情,访问链接:https://docs.ucloud.cn/api/ukafka-api/get_ukafka_node_type,响应字段的NodeTypeSet[N].NodeTypeName是支持的所有机型;\\ 5.获取DiskSize磁盘大小范围 ,访问链接:https://docs.ucloud.cn/api/ukafka-api/get_ukafka_node_type,该接口响应字段的NodeTypeSet[N].MinDiskSize和NodeTypeSet[N].MaxDiskSize是磁盘大小的取值范围;\\ 6.InstanceName,自定义输入实例名称,只能包含中英文、数字以及- _ .
20
20
  *
21
21
  * See also: https://docs.ucloud.cn/api/ukafka-api/create_ukafka_instance
22
22
  */
@@ -34,7 +34,7 @@ export default class UKafkaClient extends Client {
34
34
  */
35
35
  describeUKafkaConsumer(request?: DescribeUKafkaConsumerRequest): Promise<DescribeUKafkaConsumerResponse>;
36
36
  /**
37
- * DescribeUKafkaInstance - 获取整个集群的信息
37
+ * DescribeUKafkaInstance - 获取整个实例的信息。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
38
38
  *
39
39
  * See also: https://docs.ucloud.cn/api/ukafka-api/describe_ukafka_instance
40
40
  */
@@ -46,7 +46,7 @@ export default class UKafkaClient extends Client {
46
46
  */
47
47
  getUKafkaNodeType(request?: GetUKafkaNodeTypeRequest): Promise<GetUKafkaNodeTypeResponse>;
48
48
  /**
49
- * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了
49
+ * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
50
50
  *
51
51
  * See also: https://docs.ucloud.cn/api/ukafka-api/is_ukafka_topic_name_exist
52
52
  */
@@ -64,19 +64,19 @@ export default class UKafkaClient extends Client {
64
64
  */
65
65
  listUKafkaFrameworkVersion(request?: ListUKafkaFrameworkVersionRequest): Promise<ListUKafkaFrameworkVersionResponse>;
66
66
  /**
67
- * ListUKafkaInstance - 列举集群信息
67
+ * ListUKafkaInstance - 获取实例列表信息
68
68
  *
69
69
  * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_instance
70
70
  */
71
71
  listUKafkaInstance(request?: ListUKafkaInstanceRequest): Promise<ListUKafkaInstanceResponse>;
72
72
  /**
73
- * ListUKafkaTopics - 展示kafka集群上所有topic
73
+ * ListUKafkaTopics - 获取 kafka 实例 topic 列表信息。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
74
74
  *
75
75
  * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_topics
76
76
  */
77
77
  listUKafkaTopics(request?: ListUKafkaTopicsRequest): Promise<ListUKafkaTopicsResponse>;
78
78
  /**
79
- * ModifyUKafkaInstanceType - 规格升降级
79
+ * ModifyUKafkaInstanceType - 规格升降级,仅升级CPU 和内存
80
80
  *
81
81
  * See also: https://docs.ucloud.cn/api/ukafka-api/modify_ukafka_instance_type
82
82
  */
@@ -107,7 +107,7 @@ export interface AddUKafkaInstanceNodeRequest {
107
107
  /**
108
108
  * 新添加节点数量
109
109
  */
110
- NodeCount: number;
110
+ NodeCount: string;
111
111
  }
112
112
  /**
113
113
  * AddUKafkaInstanceNode - 给实例添加节点
@@ -115,7 +115,7 @@ export interface AddUKafkaInstanceNodeRequest {
115
115
  export interface AddUKafkaInstanceNodeResponse {
116
116
  }
117
117
  /**
118
- * CreateUKafkaInstance - 创建一个ukafka实例
118
+ * CreateUKafkaInstance - 创建实例接口。\\ 创建实例前需要按以下步骤准备必要参数:\\ 1.获取Region(地域)和 Zone(可用区),访问链接:https://docs.ucloud.cn/api/summary/regionlist 可以获取所有支持的地域和可用区;\\ 2.获取FrameworkVersion,访问链接:https://docs.ucloud.cn/api/ukafka-api/list_ukafka_framework_version,响应字段的FrameworkVersions[N].Version是支持的 Kafka 版本;\\ 3.ChargeType付费类型,可用值:Dynamic为按小时付费,Month为按月付费,Year为按年付费;\\ 4.获取NodeType机型详情,访问链接:https://docs.ucloud.cn/api/ukafka-api/get_ukafka_node_type,响应字段的NodeTypeSet[N].NodeTypeName是支持的所有机型;\\ 5.获取DiskSize磁盘大小范围 ,访问链接:https://docs.ucloud.cn/api/ukafka-api/get_ukafka_node_type,该接口响应字段的NodeTypeSet[N].MinDiskSize和NodeTypeSet[N].MaxDiskSize是磁盘大小的取值范围;\\ 6.InstanceName,自定义输入实例名称,只能包含中英文、数字以及- _ .
119
119
  */
120
120
  export interface CreateUKafkaInstanceRequest {
121
121
  /**
@@ -147,7 +147,7 @@ export interface CreateUKafkaInstanceRequest {
147
147
  */
148
148
  DiskSize: number;
149
149
  /**
150
- * 实例名,可自定义
150
+ * 实例名,可自定义。只能包含中英文、数字以及- _ .
151
151
  */
152
152
  InstanceName: string;
153
153
  /**
@@ -159,7 +159,7 @@ export interface CreateUKafkaInstanceRequest {
159
159
  */
160
160
  Quantity?: string;
161
161
  /**
162
- * 集群节点数量。默认 3 节点
162
+ * 实例节点数量。默认 3 节点
163
163
  */
164
164
  NodeCount?: number;
165
165
  /**
@@ -180,7 +180,7 @@ export interface CreateUKafkaInstanceRequest {
180
180
  IsSecurityEnabled?: string;
181
181
  }
182
182
  /**
183
- * CreateUKafkaInstance - 创建一个ukafka实例
183
+ * CreateUKafkaInstance - 创建实例接口。\\ 创建实例前需要按以下步骤准备必要参数:\\ 1.获取Region(地域)和 Zone(可用区),访问链接:https://docs.ucloud.cn/api/summary/regionlist 可以获取所有支持的地域和可用区;\\ 2.获取FrameworkVersion,访问链接:https://docs.ucloud.cn/api/ukafka-api/list_ukafka_framework_version,响应字段的FrameworkVersions[N].Version是支持的 Kafka 版本;\\ 3.ChargeType付费类型,可用值:Dynamic为按小时付费,Month为按月付费,Year为按年付费;\\ 4.获取NodeType机型详情,访问链接:https://docs.ucloud.cn/api/ukafka-api/get_ukafka_node_type,响应字段的NodeTypeSet[N].NodeTypeName是支持的所有机型;\\ 5.获取DiskSize磁盘大小范围 ,访问链接:https://docs.ucloud.cn/api/ukafka-api/get_ukafka_node_type,该接口响应字段的NodeTypeSet[N].MinDiskSize和NodeTypeSet[N].MaxDiskSize是磁盘大小的取值范围;\\ 6.InstanceName,自定义输入实例名称,只能包含中英文、数字以及- _ .
184
184
  */
185
185
  export interface CreateUKafkaInstanceResponse {
186
186
  /**
@@ -215,7 +215,7 @@ export interface DescribeUKafkaConsumerRequest {
215
215
  */
216
216
  Zone: string;
217
217
  /**
218
- * Kafka 集群 ID
218
+ * 实例 ID
219
219
  */
220
220
  ClusterInstanceId: string;
221
221
  /**
@@ -242,10 +242,10 @@ export interface DescribeUKafkaConsumerResponse {
242
242
  /**
243
243
  * 消费者组所订阅 topic 信息
244
244
  */
245
- Topics?: string;
245
+ Topics?: string[];
246
246
  }
247
247
  /**
248
- * DescribeUKafkaInstance - 获取整个集群的信息
248
+ * DescribeUKafkaInstance - 获取整个实例的信息。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
249
249
  */
250
250
  export interface DescribeUKafkaInstanceRequest {
251
251
  /**
@@ -258,11 +258,11 @@ export interface DescribeUKafkaInstanceRequest {
258
258
  ClusterInstanceId: string;
259
259
  }
260
260
  /**
261
- * DescribeUKafkaInstance - 获取整个集群的信息
261
+ * DescribeUKafkaInstance - 获取整个实例的信息。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
262
262
  */
263
263
  export interface DescribeUKafkaInstanceResponse {
264
264
  /**
265
- * 集群信息列表
265
+ * 实例信息列表
266
266
  */
267
267
  ClusterSet: {
268
268
  /**
@@ -560,18 +560,30 @@ export interface GetUKafkaNodeTypeResponse {
560
560
  * 内存大小(单位 MB)
561
561
  */
562
562
  Memory?: string;
563
+ /**
564
+ * 机型最大支持磁盘大小
565
+ */
566
+ MaxDiskSize?: number;
567
+ /**
568
+ * 机型最小支持磁盘大小
569
+ */
570
+ MinDiskSize?: number;
571
+ /**
572
+ * 该机型是否支持安全组
573
+ */
574
+ IsOpenSecGroup?: boolean;
563
575
  }[];
564
576
  }
565
577
  /**
566
- * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了
578
+ * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
567
579
  */
568
580
  export interface IsUKafkaTopicNameExistRequest {
569
581
  /**
570
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
582
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
571
583
  */
572
584
  Zone: string;
573
585
  /**
574
- * 集群ID
586
+ * 实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
575
587
  */
576
588
  ClusterInstanceId: string;
577
589
  /**
@@ -580,7 +592,7 @@ export interface IsUKafkaTopicNameExistRequest {
580
592
  TopicName: string;
581
593
  }
582
594
  /**
583
- * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了
595
+ * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
584
596
  */
585
597
  export interface IsUKafkaTopicNameExistResponse {
586
598
  /**
@@ -593,11 +605,11 @@ export interface IsUKafkaTopicNameExistResponse {
593
605
  */
594
606
  export interface ListUKafkaConsumersRequest {
595
607
  /**
596
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
608
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
597
609
  */
598
610
  Zone: string;
599
611
  /**
600
- * Kafka 集群 ID
612
+ * 实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
601
613
  */
602
614
  ClusterInstanceId: string;
603
615
  }
@@ -621,6 +633,10 @@ export interface ListUKafkaConsumersResponse {
621
633
  * 订阅 Topic 数量
622
634
  */
623
635
  NumOfTopics?: number;
636
+ /**
637
+ * 消费者组资源ID
638
+ */
639
+ GroupId?: string;
624
640
  }[];
625
641
  }
626
642
  /**
@@ -651,13 +667,13 @@ export interface ListUKafkaFrameworkVersionResponse {
651
667
  }[];
652
668
  }
653
669
  /**
654
- * ListUKafkaInstance - 列举集群信息
670
+ * ListUKafkaInstance - 获取实例列表信息
655
671
  */
656
672
  export interface ListUKafkaInstanceRequest {
657
673
  /**
658
674
  * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
659
675
  */
660
- Zone?: string;
676
+ Zone: string;
661
677
  /**
662
678
  * 默认为60
663
679
  */
@@ -666,10 +682,6 @@ export interface ListUKafkaInstanceRequest {
666
682
  * 默认为0
667
683
  */
668
684
  Offset?: string;
669
- /**
670
- * 是否过滤删除了的节点,默认为‘true’
671
- */
672
- Filter?: string;
673
685
  /**
674
686
  * VPCId
675
687
  */
@@ -682,39 +694,116 @@ export interface ListUKafkaInstanceRequest {
682
694
  * 业务组 ID
683
695
  */
684
696
  BusinessId?: string;
685
- /**
686
- * 实例ID
687
- */
688
- ClusterInstanceId?: string;
689
697
  }
690
698
  /**
691
- * ListUKafkaInstance - 列举集群信息
699
+ * ListUKafkaInstance - 获取实例列表信息
692
700
  */
693
701
  export interface ListUKafkaInstanceResponse {
694
702
  /**
695
- * 信息
703
+ * 实例信息
696
704
  */
697
- ClusterSet: string;
705
+ ClusterSet: {
706
+ /**
707
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
708
+ */
709
+ Zone?: string;
710
+ /**
711
+ * 实例id
712
+ */
713
+ ClusterInstanceId?: string;
714
+ /**
715
+ * 实例名称
716
+ */
717
+ ClusterInstanceName?: string;
718
+ /**
719
+ * 框架
720
+ */
721
+ Framework?: string;
722
+ /**
723
+ * Kafka 框架版本
724
+ */
725
+ FrameworkVersion?: string;
726
+ /**
727
+ * 实例备注
728
+ */
729
+ Remark?: string;
730
+ /**
731
+ * 实例创建时间戳
732
+ */
733
+ CreateTime?: number;
734
+ /**
735
+ * 实例运行时间
736
+ */
737
+ RunningTime?: number;
738
+ /**
739
+ * 实例过期时间
740
+ */
741
+ ExpireTime?: number;
742
+ /**
743
+ * 是否自动续费
744
+ */
745
+ AutoRenew?: string;
746
+ /**
747
+ * 付费类型
748
+ */
749
+ ChargeType?: string;
750
+ /**
751
+ * 实例节点个数
752
+ */
753
+ UHostCount?: number;
754
+ /**
755
+ * 冗余计数(已废弃)
756
+ */
757
+ RedundantCount?: number;
758
+ /**
759
+ * 实例当前状态,集群状态:"Running"| "Abnormal"| "Creating"| "Deleting"| "CreateFailed"| "DeleteFailed"| "Unavailable"| "Deleted"| "Updating"| "Deploying"| "Migrating"| "ExpandFailed"
760
+ */
761
+ State?: string;
762
+ /**
763
+ * 实例标记
764
+ */
765
+ Tag?: string;
766
+ /**
767
+ * 实例机型
768
+ */
769
+ InstanceGroupType?: string;
770
+ /**
771
+ * 所属 VPC id
772
+ */
773
+ VPCId?: string;
774
+ /**
775
+ * 所属子网 id
776
+ */
777
+ SubnetId?: string;
778
+ /**
779
+ * 业务组 ID
780
+ */
781
+ BusinessId?: string;
782
+ /**
783
+ * 事件状态未读消息(已废弃)
784
+ */
785
+ NewMessage?: string;
786
+ };
698
787
  /**
699
788
  * 总数
700
789
  */
701
790
  TotalCount: string;
702
791
  }
703
792
  /**
704
- * ListUKafkaTopics - 展示kafka集群上所有topic
793
+ * ListUKafkaTopics - 获取 kafka 实例 topic 列表信息。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
705
794
  */
706
795
  export interface ListUKafkaTopicsRequest {
707
796
  /**
708
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
797
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
709
798
  */
710
799
  Zone: string;
711
800
  /**
712
- * 集群资源id
801
+ * 实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
713
802
  */
714
803
  ClusterInstanceId: string;
715
804
  }
716
805
  /**
717
- * ListUKafkaTopics - 展示kafka集群上所有topic
806
+ * ListUKafkaTopics - 获取 kafka 实例 topic 列表信息。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
718
807
  */
719
808
  export interface ListUKafkaTopicsResponse {
720
809
  /**
@@ -747,12 +836,12 @@ export interface ListUKafkaTopicsResponse {
747
836
  Status?: string;
748
837
  }[];
749
838
  /**
750
- * 列表长度
839
+ * topic 列表长度
751
840
  */
752
841
  Length?: number;
753
842
  }
754
843
  /**
755
- * ModifyUKafkaInstanceType - 规格升降级
844
+ * ModifyUKafkaInstanceType - 规格升降级,仅升级CPU 和内存
756
845
  */
757
846
  export interface ModifyUKafkaInstanceTypeRequest {
758
847
  /**
@@ -764,12 +853,12 @@ export interface ModifyUKafkaInstanceTypeRequest {
764
853
  */
765
854
  InstanceId: string;
766
855
  /**
767
- * 目标机型,支持的机型可通过GetUKafkaNodeType 接口返回的InstanceTypeSet[].InstanceTypeName
856
+ * 目标机型,支持的机型可通过GetUKafkaNodeType 接口返回的InstanceTypeSet[].InstanceTypeName。仅升级CPU 和内存
768
857
  */
769
858
  NodeType: string;
770
859
  }
771
860
  /**
772
- * ModifyUKafkaInstanceType - 规格升降级
861
+ * ModifyUKafkaInstanceType - 规格升降级,仅升级CPU 和内存
773
862
  */
774
863
  export interface ModifyUKafkaInstanceTypeResponse {
775
864
  }
@@ -22,7 +22,7 @@ class UKafkaClient extends client_1.default {
22
22
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
23
23
  }
24
24
  /**
25
- * CreateUKafkaInstance - 创建一个ukafka实例
25
+ * CreateUKafkaInstance - 创建实例接口。\\ 创建实例前需要按以下步骤准备必要参数:\\ 1.获取Region(地域)和 Zone(可用区),访问链接:https://docs.ucloud.cn/api/summary/regionlist 可以获取所有支持的地域和可用区;\\ 2.获取FrameworkVersion,访问链接:https://docs.ucloud.cn/api/ukafka-api/list_ukafka_framework_version,响应字段的FrameworkVersions[N].Version是支持的 Kafka 版本;\\ 3.ChargeType付费类型,可用值:Dynamic为按小时付费,Month为按月付费,Year为按年付费;\\ 4.获取NodeType机型详情,访问链接:https://docs.ucloud.cn/api/ukafka-api/get_ukafka_node_type,响应字段的NodeTypeSet[N].NodeTypeName是支持的所有机型;\\ 5.获取DiskSize磁盘大小范围 ,访问链接:https://docs.ucloud.cn/api/ukafka-api/get_ukafka_node_type,该接口响应字段的NodeTypeSet[N].MinDiskSize和NodeTypeSet[N].MaxDiskSize是磁盘大小的取值范围;\\ 6.InstanceName,自定义输入实例名称,只能包含中英文、数字以及- _ .
26
26
  *
27
27
  * See also: https://docs.ucloud.cn/api/ukafka-api/create_ukafka_instance
28
28
  */
@@ -49,7 +49,7 @@ class UKafkaClient extends client_1.default {
49
49
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
50
50
  }
51
51
  /**
52
- * DescribeUKafkaInstance - 获取整个集群的信息
52
+ * DescribeUKafkaInstance - 获取整个实例的信息。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
53
53
  *
54
54
  * See also: https://docs.ucloud.cn/api/ukafka-api/describe_ukafka_instance
55
55
  */
@@ -67,7 +67,7 @@ class UKafkaClient extends client_1.default {
67
67
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
68
68
  }
69
69
  /**
70
- * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了
70
+ * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
71
71
  *
72
72
  * See also: https://docs.ucloud.cn/api/ukafka-api/is_ukafka_topic_name_exist
73
73
  */
@@ -94,7 +94,7 @@ class UKafkaClient extends client_1.default {
94
94
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
95
95
  }
96
96
  /**
97
- * ListUKafkaInstance - 列举集群信息
97
+ * ListUKafkaInstance - 获取实例列表信息
98
98
  *
99
99
  * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_instance
100
100
  */
@@ -103,7 +103,7 @@ class UKafkaClient extends client_1.default {
103
103
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
104
104
  }
105
105
  /**
106
- * ListUKafkaTopics - 展示kafka集群上所有topic
106
+ * ListUKafkaTopics - 获取 kafka 实例 topic 列表信息。实例ID,可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
107
107
  *
108
108
  * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_topics
109
109
  */
@@ -112,7 +112,7 @@ class UKafkaClient extends client_1.default {
112
112
  return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
113
113
  }
114
114
  /**
115
- * ModifyUKafkaInstanceType - 规格升降级
115
+ * ModifyUKafkaInstanceType - 规格升降级,仅升级CPU 和内存
116
116
  *
117
117
  * See also: https://docs.ucloud.cn/api/ukafka-api/modify_ukafka_instance_type
118
118
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@ucloud-sdks/ucloud-sdk-js",
3
3
  "description": "ucloud-sdk-js",
4
- "version": "0.2.9",
4
+ "version": "0.2.11",
5
5
  "author": "oas@ucloud.cn",
6
6
  "license": "MIT",
7
7
  "private": false,