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

package/lib/services/uhadoop/index.d.ts

@@ -16,7 +16,7 @@ export default class UHadoopClient extends Client {
      */
     addUHadoopInstanceNode(request?: AddUHadoopInstanceNodeRequest): Promise<AddUHadoopInstanceNodeResponse>;
     /**
-     * CreateUHadoopInstance - 新建一个uhadoop集群
+     * 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是组件版本
      *
      * See also: https://docs.ucloud.cn/api/uhadoop-api/create_uhadoop_instance
      */
@@ -131,7 +131,7 @@ export interface AddUHadoopInstanceNodeRequest {
 export interface AddUHadoopInstanceNodeResponse {
 }
 /**
- * CreateUHadoopInstance - 新建一个uhadoop集群
+ * 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是组件版本
  */
 export interface CreateUHadoopInstanceRequest {
     /**
@@ -139,7 +139,7 @@ export interface CreateUHadoopInstanceRequest {
      */
     Zone: string;
     /**
-     * 集群机器的登录密码
+     * 集群机器的登录密码,需要输入base64编码后的内容
      */
     Password: string;
     /**
@@ -161,7 +161,7 @@ export interface CreateUHadoopInstanceRequest {
     /**
      * 集群需要安装的组件，格式：组件#版本通过ListUHadoopFrameworkApp接口获取，例如：Spark#3.3.0
      */
-    AppConfig: string[];
+    AppConfigs: string[];
     /**
      * 框架，值为'Hadoop'|'HDFS'|'MR'|'StarRocks'之一,框架，例如Hadoop|MR|HDFS|StarRocks Hadoop框架包含存储与计算服务 MR集群包含计算服务 HDFS只包含存储服务,StarRocks为StarRocks集群
      */
@@ -216,7 +216,7 @@ export interface CreateUHadoopInstanceRequest {
     InstanceName?: string;
 }
 /**
- * CreateUHadoopInstance - 新建一个uhadoop集群
+ * 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是组件版本
  */
 export interface CreateUHadoopInstanceResponse {
     /**

package/lib/services/uhadoop/index.js

@@ -22,7 +22,7 @@ class UHadoopClient extends client_1.default {
         return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
     }
     /**
-     * CreateUHadoopInstance - 新建一个uhadoop集群
+     * 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是组件版本
      *
      * See also: https://docs.ucloud.cn/api/uhadoop-api/create_uhadoop_instance
      */

package/lib/services/ukafka/index.d.ts

@@ -16,7 +16,7 @@ export default class UKafkaClient extends Client {
      */
     addUKafkaInstanceNode(request?: AddUKafkaInstanceNodeRequest): Promise<AddUKafkaInstanceNodeResponse>;
     /**
-     * CreateUKafkaInstance - 创建一个ukafka实例
+     * 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，自定义输入实例名称，只能包含中英文、数字以及- _ .
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/create_ukafka_instance
      */
@@ -34,7 +34,7 @@ export default class UKafkaClient extends Client {
      */
     describeUKafkaConsumer(request?: DescribeUKafkaConsumerRequest): Promise<DescribeUKafkaConsumerResponse>;
     /**
-     * DescribeUKafkaInstance - 获取整个集群的信息
+     * DescribeUKafkaInstance - 获取整个实例的信息。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/describe_ukafka_instance
      */
@@ -46,7 +46,7 @@ export default class UKafkaClient extends Client {
      */
     getUKafkaNodeType(request?: GetUKafkaNodeTypeRequest): Promise<GetUKafkaNodeTypeResponse>;
     /**
-     * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了
+     * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/is_ukafka_topic_name_exist
      */
@@ -64,19 +64,19 @@ export default class UKafkaClient extends Client {
      */
     listUKafkaFrameworkVersion(request?: ListUKafkaFrameworkVersionRequest): Promise<ListUKafkaFrameworkVersionResponse>;
     /**
-     * ListUKafkaInstance - 列举集群信息
+     * ListUKafkaInstance - 获取实例列表信息
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_instance
      */
     listUKafkaInstance(request?: ListUKafkaInstanceRequest): Promise<ListUKafkaInstanceResponse>;
     /**
-     * ListUKafkaTopics - 展示kafka集群上所有topic
+     * ListUKafkaTopics - 获取 kafka 实例 topic  列表信息。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_topics
      */
     listUKafkaTopics(request?: ListUKafkaTopicsRequest): Promise<ListUKafkaTopicsResponse>;
     /**
-     * ModifyUKafkaInstanceType - 规格升降级
+     * ModifyUKafkaInstanceType - 规格升降级，仅升级CPU 和内存
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/modify_ukafka_instance_type
      */
@@ -107,7 +107,7 @@ export interface AddUKafkaInstanceNodeRequest {
     /**
      * 新添加节点数量
      */
-    NodeCount: number;
+    NodeCount: string;
 }
 /**
  * AddUKafkaInstanceNode - 给实例添加节点
@@ -115,7 +115,7 @@ export interface AddUKafkaInstanceNodeRequest {
 export interface AddUKafkaInstanceNodeResponse {
 }
 /**
- * CreateUKafkaInstance - 创建一个ukafka实例
+ * 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，自定义输入实例名称，只能包含中英文、数字以及- _ .
  */
 export interface CreateUKafkaInstanceRequest {
     /**
@@ -147,7 +147,7 @@ export interface CreateUKafkaInstanceRequest {
      */
     DiskSize: number;
     /**
-     * 实例名，可自定义
+     * 实例名，可自定义。只能包含中英文、数字以及- _ .
      */
     InstanceName: string;
     /**
@@ -159,7 +159,7 @@ export interface CreateUKafkaInstanceRequest {
      */
     Quantity?: string;
     /**
-     * 集群节点数量。默认 3 节点
+     * 实例节点数量。默认 3 节点
      */
     NodeCount?: number;
     /**
@@ -180,7 +180,7 @@ export interface CreateUKafkaInstanceRequest {
     IsSecurityEnabled?: string;
 }
 /**
- * CreateUKafkaInstance - 创建一个ukafka实例
+ * 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，自定义输入实例名称，只能包含中英文、数字以及- _ .
  */
 export interface CreateUKafkaInstanceResponse {
     /**
@@ -215,7 +215,7 @@ export interface DescribeUKafkaConsumerRequest {
      */
     Zone: string;
     /**
-     * Kafka 集群 ID
+     * 实例 ID
      */
     ClusterInstanceId: string;
     /**
@@ -242,10 +242,10 @@ export interface DescribeUKafkaConsumerResponse {
     /**
      * 消费者组所订阅 topic 信息
      */
-    Topics?: string;
+    Topics?: string[];
 }
 /**
- * DescribeUKafkaInstance - 获取整个集群的信息
+ * DescribeUKafkaInstance - 获取整个实例的信息。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
  */
 export interface DescribeUKafkaInstanceRequest {
     /**
@@ -258,11 +258,11 @@ export interface DescribeUKafkaInstanceRequest {
     ClusterInstanceId: string;
 }
 /**
- * DescribeUKafkaInstance - 获取整个集群的信息
+ * DescribeUKafkaInstance - 获取整个实例的信息。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
  */
 export interface DescribeUKafkaInstanceResponse {
     /**
-     * 集群信息列表
+     * 实例信息列表
      */
     ClusterSet: {
         /**
@@ -560,18 +560,30 @@ export interface GetUKafkaNodeTypeResponse {
          * 内存大小（单位 MB）
          */
         Memory?: string;
+        /**
+         * 机型最大支持磁盘大小
+         */
+        MaxDiskSize?: number;
+        /**
+         * 机型最小支持磁盘大小
+         */
+        MinDiskSize?: number;
+        /**
+         * 该机型是否支持安全组
+         */
+        IsOpenSecGroup?: boolean;
     }[];
 }
 /**
- * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了
+ * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
  */
 export interface IsUKafkaTopicNameExistRequest {
     /**
-     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
      */
     Zone: string;
     /**
-     * 集群ID
+     * 实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
      */
     ClusterInstanceId: string;
     /**
@@ -580,7 +592,7 @@ export interface IsUKafkaTopicNameExistRequest {
     TopicName: string;
 }
 /**
- * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了
+ * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
  */
 export interface IsUKafkaTopicNameExistResponse {
     /**
@@ -593,11 +605,11 @@ export interface IsUKafkaTopicNameExistResponse {
  */
 export interface ListUKafkaConsumersRequest {
     /**
-     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
      */
     Zone: string;
     /**
-     * Kafka 集群 ID
+     * 实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
      */
     ClusterInstanceId: string;
 }
@@ -621,6 +633,10 @@ export interface ListUKafkaConsumersResponse {
          * 订阅 Topic 数量
          */
         NumOfTopics?: number;
+        /**
+         * 消费者组资源ID
+         */
+        GroupId?: string;
     }[];
 }
 /**
@@ -651,13 +667,13 @@ export interface ListUKafkaFrameworkVersionResponse {
     }[];
 }
 /**
- * ListUKafkaInstance - 列举集群信息
+ * ListUKafkaInstance - 获取实例列表信息
  */
 export interface ListUKafkaInstanceRequest {
     /**
      * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
      */
-    Zone?: string;
+    Zone: string;
     /**
      * 默认为60
      */
@@ -666,10 +682,6 @@ export interface ListUKafkaInstanceRequest {
      * 默认为0
      */
     Offset?: string;
-    /**
-     * 是否过滤删除了的节点，默认为‘true’
-     */
-    Filter?: string;
     /**
      * VPCId
      */
@@ -682,39 +694,116 @@ export interface ListUKafkaInstanceRequest {
      * 业务组 ID
      */
     BusinessId?: string;
-    /**
-     * 实例ID
-     */
-    ClusterInstanceId?: string;
 }
 /**
- * ListUKafkaInstance - 列举集群信息
+ * ListUKafkaInstance - 获取实例列表信息
  */
 export interface ListUKafkaInstanceResponse {
     /**
-     * 信息
+     * 实例信息
      */
-    ClusterSet: string;
+    ClusterSet: {
+        /**
+         * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+         */
+        Zone?: string;
+        /**
+         * 实例id
+         */
+        ClusterInstanceId?: string;
+        /**
+         * 实例名称
+         */
+        ClusterInstanceName?: string;
+        /**
+         * 框架
+         */
+        Framework?: string;
+        /**
+         * Kafka 框架版本
+         */
+        FrameworkVersion?: string;
+        /**
+         * 实例备注
+         */
+        Remark?: string;
+        /**
+         * 实例创建时间戳
+         */
+        CreateTime?: number;
+        /**
+         * 实例运行时间
+         */
+        RunningTime?: number;
+        /**
+         * 实例过期时间
+         */
+        ExpireTime?: number;
+        /**
+         * 是否自动续费
+         */
+        AutoRenew?: string;
+        /**
+         * 付费类型
+         */
+        ChargeType?: string;
+        /**
+         * 实例节点个数
+         */
+        UHostCount?: number;
+        /**
+         * 冗余计数（已废弃）
+         */
+        RedundantCount?: number;
+        /**
+         * 实例当前状态,集群状态："Running"| "Abnormal"| "Creating"| "Deleting"| "CreateFailed"| "DeleteFailed"| "Unavailable"| "Deleted"| "Updating"| "Deploying"| "Migrating"| "ExpandFailed"
+         */
+        State?: string;
+        /**
+         * 实例标记
+         */
+        Tag?: string;
+        /**
+         * 实例机型
+         */
+        InstanceGroupType?: string;
+        /**
+         * 所属 VPC id
+         */
+        VPCId?: string;
+        /**
+         * 所属子网 id
+         */
+        SubnetId?: string;
+        /**
+         * 业务组 ID
+         */
+        BusinessId?: string;
+        /**
+         * 事件状态未读消息（已废弃）
+         */
+        NewMessage?: string;
+    };
     /**
      * 总数
      */
     TotalCount: string;
 }
 /**
- * ListUKafkaTopics - 展示kafka集群上所有topic
+ * ListUKafkaTopics - 获取 kafka 实例 topic  列表信息。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
  */
 export interface ListUKafkaTopicsRequest {
     /**
-     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
      */
     Zone: string;
     /**
-     * 集群资源id
+     * 实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
      */
     ClusterInstanceId: string;
 }
 /**
- * ListUKafkaTopics - 展示kafka集群上所有topic
+ * ListUKafkaTopics - 获取 kafka 实例 topic  列表信息。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
  */
 export interface ListUKafkaTopicsResponse {
     /**
@@ -747,12 +836,12 @@ export interface ListUKafkaTopicsResponse {
         Status?: string;
     }[];
     /**
-     * 列表长度
+     * topic 列表长度
      */
     Length?: number;
 }
 /**
- * ModifyUKafkaInstanceType - 规格升降级
+ * ModifyUKafkaInstanceType - 规格升降级，仅升级CPU 和内存
  */
 export interface ModifyUKafkaInstanceTypeRequest {
     /**
@@ -764,12 +853,12 @@ export interface ModifyUKafkaInstanceTypeRequest {
      */
     InstanceId: string;
     /**
-     * 目标机型，支持的机型可通过GetUKafkaNodeType 接口返回的InstanceTypeSet[].InstanceTypeName
+     * 目标机型，支持的机型可通过GetUKafkaNodeType 接口返回的InstanceTypeSet[].InstanceTypeName。仅升级CPU 和内存
      */
     NodeType: string;
 }
 /**
- * ModifyUKafkaInstanceType - 规格升降级
+ * ModifyUKafkaInstanceType - 规格升降级，仅升级CPU 和内存
  */
 export interface ModifyUKafkaInstanceTypeResponse {
 }

package/lib/services/ukafka/index.js

@@ -22,7 +22,7 @@ class UKafkaClient extends client_1.default {
         return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
     }
     /**
-     * CreateUKafkaInstance - 创建一个ukafka实例
+     * 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，自定义输入实例名称，只能包含中英文、数字以及- _ .
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/create_ukafka_instance
      */
@@ -49,7 +49,7 @@ class UKafkaClient extends client_1.default {
         return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
     }
     /**
-     * DescribeUKafkaInstance - 获取整个集群的信息
+     * DescribeUKafkaInstance - 获取整个实例的信息。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/describe_ukafka_instance
      */
@@ -67,7 +67,7 @@ class UKafkaClient extends client_1.default {
         return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
     }
     /**
-     * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了
+     * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/is_ukafka_topic_name_exist
      */
@@ -94,7 +94,7 @@ class UKafkaClient extends client_1.default {
         return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
     }
     /**
-     * ListUKafkaInstance - 列举集群信息
+     * ListUKafkaInstance - 获取实例列表信息
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_instance
      */
@@ -103,7 +103,7 @@ class UKafkaClient extends client_1.default {
         return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
     }
     /**
-     * ListUKafkaTopics - 展示kafka集群上所有topic
+     * ListUKafkaTopics - 获取 kafka 实例 topic  列表信息。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_topics
      */
@@ -112,7 +112,7 @@ class UKafkaClient extends client_1.default {
         return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
     }
     /**
-     * ModifyUKafkaInstanceType - 规格升降级
+     * ModifyUKafkaInstanceType - 规格升降级，仅升级CPU 和内存
      *
      * See also: https://docs.ucloud.cn/api/ukafka-api/modify_ukafka_instance_type
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ucloud-sdks/ucloud-sdk-js",
   "description": "ucloud-sdk-js",
-  "version": "0.2.9",
+  "version": "0.2.10",
   "author": "oas@ucloud.cn",
   "license": "MIT",
   "private": false,