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

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

@@ -0,0 +1,797 @@
+import Client from '../../core/client';
+import { ConfigOptions } from '../../core/config';
+import { CredentialOptions } from '../../core/credential';
+/**
+ * This client is used to call actions of **ukafka** service
+ */
+export default class UKafkaClient extends Client {
+    constructor({ config, credential, }: {
+        config: ConfigOptions;
+        credential: CredentialOptions;
+    });
+    /**
+     * AddUKafkaInstanceNode - 给实例添加节点
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/add_ukafka_instance_node
+     */
+    addUKafkaInstanceNode(request?: AddUKafkaInstanceNodeRequest): Promise<AddUKafkaInstanceNodeResponse>;
+    /**
+     * CreateUKafkaInstance - 创建一个ukafka实例
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/create_ukafka_instance
+     */
+    createUKafkaInstance(request?: CreateUKafkaInstanceRequest): Promise<CreateUKafkaInstanceResponse>;
+    /**
+     * DeleteUKafkaInstance - 删除实例
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/delete_ukafka_instance
+     */
+    deleteUKafkaInstance(request?: DeleteUKafkaInstanceRequest): Promise<DeleteUKafkaInstanceResponse>;
+    /**
+     * DescribeUKafkaConsumer - 获取 Kafka 消费组信息
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/describe_ukafka_consumer
+     */
+    describeUKafkaConsumer(request?: DescribeUKafkaConsumerRequest): Promise<DescribeUKafkaConsumerResponse>;
+    /**
+     * DescribeUKafkaInstance - 获取整个集群的信息
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/describe_ukafka_instance
+     */
+    describeUKafkaInstance(request?: DescribeUKafkaInstanceRequest): Promise<DescribeUKafkaInstanceResponse>;
+    /**
+     * GetUKafkaNodeType - 获取节点机型配置
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/get_ukafka_node_type
+     */
+    getUKafkaNodeType(request?: GetUKafkaNodeTypeRequest): Promise<GetUKafkaNodeTypeResponse>;
+    /**
+     * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/is_ukafka_topic_name_exist
+     */
+    isUKafkaTopicNameExist(request?: IsUKafkaTopicNameExistRequest): Promise<IsUKafkaTopicNameExistResponse>;
+    /**
+     * ListUKafkaConsumers - 列出 Kafka 消费组
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_consumers
+     */
+    listUKafkaConsumers(request?: ListUKafkaConsumersRequest): Promise<ListUKafkaConsumersResponse>;
+    /**
+     * ListUKafkaFrameworkVersion - 列举ukafka框架版本
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_framework_version
+     */
+    listUKafkaFrameworkVersion(request?: ListUKafkaFrameworkVersionRequest): Promise<ListUKafkaFrameworkVersionResponse>;
+    /**
+     * ListUKafkaInstance - 列举集群信息
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_instance
+     */
+    listUKafkaInstance(request?: ListUKafkaInstanceRequest): Promise<ListUKafkaInstanceResponse>;
+    /**
+     * ListUKafkaTopics - 展示kafka集群上所有topic
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/list_ukafka_topics
+     */
+    listUKafkaTopics(request?: ListUKafkaTopicsRequest): Promise<ListUKafkaTopicsResponse>;
+    /**
+     * ModifyUKafkaInstanceType - 规格升降级
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/modify_ukafka_instance_type
+     */
+    modifyUKafkaInstanceType(request?: ModifyUKafkaInstanceTypeRequest): Promise<ModifyUKafkaInstanceTypeResponse>;
+    /**
+     * ResizeUKafkaDisk - 磁盘扩容
+     *
+     * See also: https://docs.ucloud.cn/api/ukafka-api/resize_ukafka_disk
+     */
+    resizeUKafkaDisk(request?: ResizeUKafkaDiskRequest): Promise<ResizeUKafkaDiskResponse>;
+}
+/**
+ * AddUKafkaInstanceNode - 给实例添加节点
+ */
+export interface AddUKafkaInstanceNodeRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * 实例ID
+     */
+    InstanceId: string;
+    /**
+     * 机型，支持的机型可通过GetUKafkaNodeType 接口返回的InstanceTypeSet[].InstanceTypeName
+     */
+    NodeType: string;
+    /**
+     * 新添加节点数量
+     */
+    NodeCount: number;
+}
+/**
+ * AddUKafkaInstanceNode - 给实例添加节点
+ */
+export interface AddUKafkaInstanceNodeResponse {
+}
+/**
+ * CreateUKafkaInstance - 创建一个ukafka实例
+ */
+export interface CreateUKafkaInstanceRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * kafka版本，支持的版本可通过ListUKafkaFrameworkVersion 接口返回字段的FrameworkVersions获取
+     */
+    FrameworkVersion: string;
+    /**
+     * VPCID
+     */
+    VPCId: string;
+    /**
+     * 子网 ID
+     */
+    SubnetId: string;
+    /**
+     * 付费方式
+     */
+    ChargeType: string;
+    /**
+     * 机型，支持的机型可通过GetUKafkaNodeType 接口返回的InstanceTypeSet[].InstanceTypeName
+     */
+    NodeType: string;
+    /**
+     * 数据盘大小。支持范围根据GetUKafkaNodeType 接口返回的InstanceTypeSet[].MaxDiskSize 和MinDiskSize获取
+     */
+    DiskSize: number;
+    /**
+     * 实例名，可自定义
+     */
+    InstanceName: string;
+    /**
+     * 业务组，默认Default
+     */
+    BusinessId?: string;
+    /**
+     * 实例数量，默认 1
+     */
+    Quantity?: string;
+    /**
+     * 集群节点数量。默认 3 节点
+     */
+    NodeCount?: number;
+    /**
+     * kafka 日志保存时间，支持范围[1,240]。默认 72 小时
+     */
+    LogRetentionHours?: string;
+    /**
+     * 磁盘管理方式,支持值：NONE、CLEAN。默认值：NONE
+     */
+    DiskControllerType?: string;
+    /**
+     * 磁盘清理阈值，支持范围[70,90]。DiskControllerType 为CLEAN 时必填。默认值 90
+     */
+    DiskThreshold?: string;
+    /**
+     * 是否开启安全组，支持"true","false"，默认 false
+     */
+    IsSecurityEnabled?: string;
+}
+/**
+ * CreateUKafkaInstance - 创建一个ukafka实例
+ */
+export interface CreateUKafkaInstanceResponse {
+    /**
+     * 实例资源 ID
+     */
+    InstanceId: string;
+}
+/**
+ * DeleteUKafkaInstance - 删除实例
+ */
+export interface DeleteUKafkaInstanceRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * 实例ID
+     */
+    InstanceId: string;
+}
+/**
+ * DeleteUKafkaInstance - 删除实例
+ */
+export interface DeleteUKafkaInstanceResponse {
+}
+/**
+ * DescribeUKafkaConsumer - 获取 Kafka 消费组信息
+ */
+export interface DescribeUKafkaConsumerRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * Kafka 集群 ID
+     */
+    ClusterInstanceId: string;
+    /**
+     * 消费组组名
+     */
+    ConsumerGroup: string;
+    /**
+     * 消费者组类型（同消费者组列表返回的类型值）
+     */
+    Type: string;
+}
+/**
+ * DescribeUKafkaConsumer - 获取 Kafka 消费组信息
+ */
+export interface DescribeUKafkaConsumerResponse {
+    /**
+     * 消费者组组名
+     */
+    GroupName?: string;
+    /**
+     * 消费者组类型
+     */
+    Type?: string;
+    /**
+     * 消费者组所订阅 topic 信息
+     */
+    Topics?: string;
+}
+/**
+ * DescribeUKafkaInstance - 获取整个集群的信息
+ */
+export interface DescribeUKafkaInstanceRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * 实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
+     */
+    ClusterInstanceId: string;
+}
+/**
+ * DescribeUKafkaInstance - 获取整个集群的信息
+ */
+export interface DescribeUKafkaInstanceResponse {
+    /**
+     * 集群信息列表
+     */
+    ClusterSet: {
+        /**
+         * 所属可用区
+         */
+        Zone?: string;
+        /**
+         * 是否开启自动续费
+         */
+        AutoRenew?: string;
+        /**
+         * 业务组 ID
+         */
+        BusinessId?: string;
+        /**
+         * 付费类型
+         */
+        ChargeType?: string;
+        /**
+         * 实例id
+         */
+        ClusterInstanceId?: string;
+        /**
+         * 实例名称
+         */
+        ClusterInstanceName?: string;
+        /**
+         * 实例创建时间
+         */
+        CreateTime?: number;
+        /**
+         * 实例过期时间
+         */
+        ExpireTime?: number;
+        /**
+         * 实例框架
+         */
+        Framework?: string;
+        /**
+         * 实例框架版本
+         */
+        FrameworkVersion?: string;
+        /**
+         * 网络 id（已废弃）
+         */
+        NetworkId?: string;
+        /**
+         * 实例备注
+         */
+        Remark?: string;
+        /**
+         * 实例运行时间
+         */
+        RunningTime?: number;
+        /**
+         * 实例当前状态,实例状态："Running"| "Abnormal"| "Creating"| "Deleting"| "CreateFailed"| "DeleteFailed"| "Unavailable"| "Deleted"| "Updating"| "Deploying"| "Migrating"| "ExpandFailed"
+         */
+        State?: string;
+        /**
+         * 所属子网 id
+         */
+        SubnetId?: string;
+        /**
+         * 实例标记
+         */
+        Tag?: string;
+        /**
+         * 实例节点个数
+         */
+        UHostCount?: number;
+        /**
+         * 节点信息列表
+         */
+        UHostSet?: {
+            /**
+             * broker 访问端点
+             */
+            Endpoints: {
+                /**
+                 * PLAINTEXT 协议访问信息
+                 */
+                PlainText: {
+                    /**
+                     * 访问协议
+                     */
+                    Protocal?: string;
+                    /**
+                     * 访问地址
+                     */
+                    Addr?: string;
+                };
+                /**
+                 * SASL_PLAINTEXT 协议访问信息
+                 */
+                SaslPlainText?: {
+                    /**
+                     * 访问协议
+                     */
+                    Protocal?: string;
+                    /**
+                     * 访问地址
+                     */
+                    Addr?: string;
+                };
+            };
+            /**
+             * broker id
+             */
+            BrokerId?: string;
+            /**
+             * broker 关联topic 信息
+             */
+            BrokerInfo?: {
+                /**
+                 * topic 在 broker 上分布的 partition 数量
+                 */
+                PartitionOnBroker?: string;
+                /**
+                 * topic 在 broker上 partition 列表
+                 */
+                Partitions?: string;
+                /**
+                 * Topic 副本数
+                 */
+                Replication?: number;
+                /**
+                 * topic 名称
+                 */
+                TopicName?: string;
+                /**
+                 * partition 数量
+                 */
+                TotalPartitions?: number;
+            }[];
+            /**
+             * broker 创建信息
+             */
+            CreateTime?: string;
+            /**
+             * broker 域名
+             */
+            DomainName?: string;
+            /**
+             * broker 过期时间
+             */
+            ExpireTime?: number;
+            /**
+             * broker IP 信息
+             */
+            IPSet?: {
+                /**
+                 * IP地址
+                 */
+                IP?: string;
+                /**
+                 * IP类型
+                 */
+                Type?: string;
+            }[];
+            /**
+             * broker 机型信息
+             */
+            InstanceGroupType?: string;
+            /**
+             * kafka 服务端口
+             */
+            KafkaPort?: number;
+            /**
+             * broker 备注信息
+             */
+            Remark?: string;
+            /**
+             * broker 注册资源信息
+             */
+            ResourceId?: string;
+            /**
+             * 安全组 id
+             */
+            SecurityGroupId?: string;
+            /**
+             * broker 当前状态
+             */
+            State?: string;
+            /**
+             * broker 节点配置
+             */
+            UHostConfig?: {
+                /**
+                 * 节点数据盘类型
+                 */
+                DiskType?: string;
+                /**
+                 * 节点系统盘大小（单位G)【删除】
+                 */
+                BootDiskSize?: number;
+                /**
+                 * 节点 CPU 核心数
+                 */
+                CPU?: number;
+                /**
+                 * 节点数据盘大小（单位G)
+                 */
+                DataDiskSize?: number;
+                /**
+                 * 节点内存(单位MB)
+                 */
+                Memory?: number;
+                /**
+                 * 节点内部系统名称【删除】
+                 */
+                OS?: string;
+            };
+            /**
+             * 节点 id
+             */
+            UHostId?: string;
+            /**
+             * 节点名称
+             */
+            UHostName?: string;
+            /**
+             * 节点类型
+             */
+            UHostRole?: string;
+            /**
+             * 节点是否部署 zookeeper
+             */
+            ZooKeeper?: string;
+            /**
+             * zookeeper 服务端口
+             */
+            ZooKeeperPort?: number;
+        }[];
+        /**
+         * 所属 VPC id
+         */
+        VPCId?: string;
+        /**
+         * 可用节点个数
+         */
+        ValidBrokerNum?: number;
+        /**
+         * 是否开启安全组
+         */
+        IsOpenSecgroup?: string;
+    }[];
+}
+/**
+ * GetUKafkaNodeType - 获取节点机型配置
+ */
+export interface GetUKafkaNodeTypeRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * 传参时返回指定机型信息，参数为空时返回所有机型信息
+     */
+    NodeType?: string;
+}
+/**
+ * GetUKafkaNodeType - 获取节点机型配置
+ */
+export interface GetUKafkaNodeTypeResponse {
+    /**
+     * 机型信息列表
+     */
+    NodeTypeSet: {
+        /**
+         * 机型磁盘类型信息
+         */
+        DiskSet?: {
+            /**
+             * 磁盘类型。Boot 表示系统盘，Data 表示数据盘
+             */
+            Type: string;
+            /**
+             * 磁盘大小
+             */
+            Size: string;
+        };
+        /**
+         * CPU核心数
+         */
+        CPU?: number;
+        /**
+         * 磁盘类型。RSSD 表示固态云盘，SSD 表示本地固态盘，COMMON 表示本地 SATA 盘
+         */
+        DiskType?: string;
+        /**
+         * 机型名称
+         */
+        NodeTypeName?: string;
+        /**
+         * 内存大小（单位 MB）
+         */
+        Memory?: string;
+    }[];
+}
+/**
+ * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了
+ */
+export interface IsUKafkaTopicNameExistRequest {
+    /**
+     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     */
+    Zone: string;
+    /**
+     * 集群ID
+     */
+    ClusterInstanceId: string;
+    /**
+     * 待检查的topic名称
+     */
+    TopicName: string;
+}
+/**
+ * IsUKafkaTopicNameExist - 检查一个topic名称是否已经在集群中了
+ */
+export interface IsUKafkaTopicNameExistResponse {
+    /**
+     * 是否已经存在
+     */
+    IsExist: string;
+}
+/**
+ * ListUKafkaConsumers - 列出 Kafka 消费组
+ */
+export interface ListUKafkaConsumersRequest {
+    /**
+     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     */
+    Zone: string;
+    /**
+     * Kafka 集群 ID
+     */
+    ClusterInstanceId: string;
+}
+/**
+ * ListUKafkaConsumers - 列出 Kafka 消费组
+ */
+export interface ListUKafkaConsumersResponse {
+    /**
+     * 消费者组列表
+     */
+    Groups?: {
+        /**
+         * 消费者组组名
+         */
+        GroupName?: string;
+        /**
+         * 消费者组类型
+         */
+        Type?: string;
+        /**
+         * 订阅 Topic 数量
+         */
+        NumOfTopics?: number;
+    }[];
+}
+/**
+ * ListUKafkaFrameworkVersion - 列举ukafka框架版本
+ */
+export interface ListUKafkaFrameworkVersionRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+}
+/**
+ * ListUKafkaFrameworkVersion - 列举ukafka框架版本
+ */
+export interface ListUKafkaFrameworkVersionResponse {
+    /**
+     * kafka版本
+     */
+    FrameworkVersions: {
+        /**
+         * kafka版本
+         */
+        Version?: string;
+        /**
+         * kafka 版本标签。recommend 表示推荐版本，beta 表示公测版本
+         */
+        Label?: string;
+    }[];
+}
+/**
+ * ListUKafkaInstance - 列举集群信息
+ */
+export interface ListUKafkaInstanceRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone?: string;
+    /**
+     * 默认为60
+     */
+    Limit?: string;
+    /**
+     * 默认为0
+     */
+    Offset?: string;
+    /**
+     * 是否过滤删除了的节点，默认为‘true’
+     */
+    Filter?: string;
+    /**
+     * VPCId
+     */
+    VPCId?: string;
+    /**
+     * SubnetId
+     */
+    SubnetId?: string;
+    /**
+     * 业务组 ID
+     */
+    BusinessId?: string;
+    /**
+     * 实例ID
+     */
+    ClusterInstanceId?: string;
+}
+/**
+ * ListUKafkaInstance - 列举集群信息
+ */
+export interface ListUKafkaInstanceResponse {
+    /**
+     * 信息
+     */
+    ClusterSet: string;
+    /**
+     * 总数
+     */
+    TotalCount: string;
+}
+/**
+ * ListUKafkaTopics - 展示kafka集群上所有topic
+ */
+export interface ListUKafkaTopicsRequest {
+    /**
+     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     */
+    Zone: string;
+    /**
+     * 集群资源id
+     */
+    ClusterInstanceId: string;
+}
+/**
+ * ListUKafkaTopics - 展示kafka集群上所有topic
+ */
+export interface ListUKafkaTopicsResponse {
+    /**
+     * topic 信息列表
+     */
+    TopicList: {
+        /**
+         * topic 名称
+         */
+        Topic?: string;
+        /**
+         * 分区数量
+         */
+        NumOfPartition?: number;
+        /**
+         * 占用 broker 数量
+         */
+        NumOfOccupyBroker?: number;
+        /**
+         * 副本数量
+         */
+        NumOfReplica?: number;
+        /**
+         * 落后副本占比
+         */
+        UnderReplicasPer?: number;
+        /**
+         * topic 状态
+         */
+        Status?: string;
+    }[];
+    /**
+     * 列表长度
+     */
+    Length?: number;
+}
+/**
+ * ModifyUKafkaInstanceType - 规格升降级
+ */
+export interface ModifyUKafkaInstanceTypeRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * 实例ID
+     */
+    InstanceId: string;
+    /**
+     * 目标机型，支持的机型可通过GetUKafkaNodeType 接口返回的InstanceTypeSet[].InstanceTypeName
+     */
+    NodeType: string;
+}
+/**
+ * ModifyUKafkaInstanceType - 规格升降级
+ */
+export interface ModifyUKafkaInstanceTypeResponse {
+}
+/**
+ * ResizeUKafkaDisk - 磁盘扩容
+ */
+export interface ResizeUKafkaDiskRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * 实例ID
+     */
+    InstanceId: string;
+    /**
+     * 数据盘大小。支持范围根据GetUKafkaNodeType 接口返回的InstanceTypeSet[].MaxDiskSize 和MinDiskSize获取
+     */
+    DiskSize: number;
+}
+/**
+ * ResizeUKafkaDisk - 磁盘扩容
+ */
+export interface ResizeUKafkaDiskResponse {
+}