@ucloud-sdks/ucloud-sdk-js 0.0.5 → 0.2.1

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

@@ -15,6 +15,12 @@ export default class UK8SClient extends Client {
      * See also: https://docs.ucloud.cn/api/uk8s-api/add_uk8s_existing_uhost
      */
     addUK8SExistingUHost(request?: AddUK8SExistingUHostRequest): Promise<AddUK8SExistingUHostResponse>;
+    /**
+     * AddUK8SNodeGroup - 添加UK8S节点池
+     *
+     * See also: https://docs.ucloud.cn/api/uk8s-api/add_uk8s_node_group
+     */
+    addUK8SNodeGroup(request?: AddUK8SNodeGroupRequest): Promise<AddUK8SNodeGroupResponse>;
     /**
      * AddUK8SPHostNode - 为UK8S集群添加一台或多台物理云主机类型的节点。
      *
@@ -45,12 +51,24 @@ export default class UK8SClient extends Client {
      * See also: https://docs.ucloud.cn/api/uk8s-api/del_uk8s_cluster_node_v2
      */
     delUK8SClusterNodeV2(request?: DelUK8SClusterNodeV2Request): Promise<DelUK8SClusterNodeV2Response>;
+    /**
+     * DescribeUK8SCluster - 获取集群信息
+     *
+     * See also: https://docs.ucloud.cn/api/uk8s-api/describe_uk8s_cluster
+     */
+    describeUK8SCluster(request?: DescribeUK8SClusterRequest): Promise<DescribeUK8SClusterResponse>;
     /**
      * DescribeUK8SImage - 获取UK8S支持的Node节点操作系统，可基于该操作系统制定自定义镜像
      *
      * See also: https://docs.ucloud.cn/api/uk8s-api/describe_uk8s_image
      */
     describeUK8SImage(request?: DescribeUK8SImageRequest): Promise<DescribeUK8SImageResponse>;
+    /**
+     * DescribeUK8SNode - 用于获取 UK8S 节点详情
+     *
+     * See also: https://docs.ucloud.cn/api/uk8s-api/describe_uk8s_node
+     */
+    describeUK8SNode(request?: DescribeUK8SNodeRequest): Promise<DescribeUK8SNodeResponse>;
     /**
      * ListUK8SClusterNodeV2 - 获取UK8S集群节点信息
      *
@@ -63,6 +81,18 @@ export default class UK8SClient extends Client {
      * See also: https://docs.ucloud.cn/api/uk8s-api/list_uk8s_cluster_v2
      */
     listUK8SClusterV2(request?: ListUK8SClusterV2Request): Promise<ListUK8SClusterV2Response>;
+    /**
+     * ListUK8SNodeGroup - 列出UK8S节点池
+     *
+     * See also: https://docs.ucloud.cn/api/uk8s-api/list_uk8s_node_group
+     */
+    listUK8SNodeGroup(request?: ListUK8SNodeGroupRequest): Promise<ListUK8SNodeGroupResponse>;
+    /**
+     * RemoveUK8SNodeGroup - 删除UK8S节点池
+     *
+     * See also: https://docs.ucloud.cn/api/uk8s-api/remove_uk8s_node_group
+     */
+    removeUK8SNodeGroup(request?: RemoveUK8SNodeGroupRequest): Promise<RemoveUK8SNodeGroupResponse>;
 }
 /**
  * AddUK8SExistingUHost - 将预先创建好的云主机加入到UK8S集群，需要注意的是，该云主机依然会执行重装系统的操作。
@@ -118,6 +148,80 @@ export interface AddUK8SExistingUHostRequest {
  */
 export interface AddUK8SExistingUHostResponse {
 }
+/**
+ * AddUK8SNodeGroup - 添加UK8S节点池
+ */
+export interface AddUK8SNodeGroupRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone?: string;
+    /**
+     * 节点池名字
+     */
+    NodeGroupName: string;
+    /**
+     * 集群ID
+     */
+    ClusterId: string;
+    /**
+     * 镜像ID
+     */
+    ImageId?: string;
+    /**
+     * 云主机机型。枚举值["N", "C", "G", "O", "OS"]。参考[[api:uhost-api:uhost_type|云主机机型说明]]。
+     */
+    MachineType?: string;
+    /**
+     * 最低cpu平台，枚举值["Intel/Auto", "Intel/IvyBridge", "Intel/Haswell", "Intel/Broadwell", "Intel/Skylake", "Intel/Cascadelake"；"Intel/CascadelakeR"; “Amd/Epyc2”,"Amd/Auto"],默认值是"Intel/Auto"
+     */
+    MinimalCpuPlatform?: string;
+    /**
+     * GPU卡核心数。仅GPU机型支持此字段（可选范围与MachineType+GpuType相关）
+     */
+    CPU?: number;
+    /**
+     * 内存大小。单位：MB
+     */
+    Mem?: number;
+    /**
+     * GPU类型
+     */
+    GpuType?: string;
+    /**
+     * GPU卡核心数
+     */
+    GPU?: number;
+    /**
+     * 磁盘类型
+     */
+    BootDiskType?: string;
+    /**
+     * 数据磁盘大小
+     */
+    DataDiskSize?: number;
+    /**
+     * 磁盘类型
+     */
+    DataDiskType?: string;
+    /**
+     * 业务组
+     */
+    Tag?: string;
+    /**
+     * 计费模式
+     */
+    ChargeType?: string;
+}
+/**
+ * AddUK8SNodeGroup - 添加UK8S节点池
+ */
+export interface AddUK8SNodeGroupResponse {
+    /**
+     * 节点池ID
+     */
+    NodeGroupId: string;
+}
 /**
  * AddUK8SPHostNode - 为UK8S集群添加一台或多台物理云主机类型的节点。
  */
@@ -193,7 +297,7 @@ export interface AddUK8SPHostNodeResponse {
  */
 export interface AddUK8SUHostNodeRequest {
     /**
-     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
      */
     Zone: string;
     /**
@@ -205,7 +309,7 @@ export interface AddUK8SUHostNodeRequest {
      */
     CPU: number;
     /**
-     * 最大创建Node节点数量，取值范围是[1,10]。
+     * 创建Node节点数量，取值范围是[1,50]。
      */
     Count: number;
     /**
@@ -231,7 +335,7 @@ export interface AddUK8SUHostNodeRequest {
     /**
      * 数据磁盘大小，单位GB。默认0。范围 ：[20, 1000]
      */
-    DataDiskSize?: string;
+    DataDiskSize?: number;
     /**
      * 购买时长。默认: 1。按小时购买(Dynamic)时无需此参数。 月付时，此参数传0，代表了购买至月末。
      */
@@ -507,6 +611,331 @@ export interface DelUK8SClusterNodeV2Request {
  */
 export interface DelUK8SClusterNodeV2Response {
 }
+/**
+ * DescribeUK8SCluster - 获取集群信息
+ */
+export interface DescribeUK8SClusterRequest {
+    /**
+     * k8s集群ID
+     */
+    ClusterId: string;
+}
+/**
+ * DescribeUK8SCluster - 获取集群信息
+ */
+export interface DescribeUK8SClusterResponse {
+    /**
+     * 资源名字
+     */
+    ClusterName: string;
+    /**
+     * 集群ID
+     */
+    ClusterId: string;
+    /**
+     * 所属VPC
+     */
+    VPCId: string;
+    /**
+     * 所属子网
+     */
+    SubnetId: string;
+    /**
+     * Pod网段
+     */
+    PodCIDR: string;
+    /**
+     * 服务网段
+     */
+    ServiceCIDR: string;
+    /**
+     * Master 节点数量
+     */
+    MasterCount: number;
+    /**
+     * Master节点配置信息，具体参考UhostInfo。托管版不返回该信息
+     */
+    MasterList?: {
+        /**
+         * 所在机房
+         */
+        Zone: string;
+        /**
+         * 主机名称
+         */
+        Name: string;
+        /**
+         * Cpu数量
+         */
+        CPU: number;
+        /**
+         * 内存
+         */
+        Memory: number;
+        /**
+         * 节点IP信息
+         */
+        IPSet: {
+            /**
+             * 国际: Internation，BGP: Bgp，内网: Private
+             */
+            Type?: string;
+            /**
+             * IP资源ID (内网IP无对应的资源ID)
+             */
+            IPId?: string;
+            /**
+             * IP地址
+             */
+            IP?: string;
+            /**
+             * IP对应的带宽, 单位: Mb (内网IP不显示带宽信息)
+             */
+            Bandwidth?: number;
+            /**
+             * 是否默认的弹性网卡的信息。true: 是默认弹性网卡；其他值：不是。
+             */
+            Default?: string;
+        }[];
+        /**
+         * 节点磁盘信息
+         */
+        DiskSet: {
+            /**
+             * 磁盘类型。系统盘: Boot，数据盘: Data,网络盘：Udisk
+             */
+            Type?: string;
+            /**
+             * 磁盘长ID
+             */
+            DiskId?: string;
+            /**
+             * UDisk名字（仅当磁盘是UDisk时返回）
+             */
+            Name?: string;
+            /**
+             * 磁盘盘符
+             */
+            Drive?: string;
+            /**
+             * 磁盘大小，单位: GB
+             */
+            Size?: number;
+            /**
+             * 备份方案，枚举类型：BASIC_SNAPSHOT,普通快照；DATAARK,方舟。无快照则不返回该字段。
+             */
+            BackupType?: string;
+            /**
+             * 当前主机的IOPS值
+             */
+            IOPS?: number;
+            /**
+             * Yes: 加密 No: 非加密
+             */
+            Encrypted?: string;
+            /**
+             * LOCAL_NOMAL| CLOUD_NORMAL| LOCAL_SSD| CLOUD_SSD|EXCLUSIVE_LOCAL_DISK
+             */
+            DiskType?: string;
+            /**
+             * True| False
+             */
+            IsBoot?: string;
+        }[];
+        /**
+         * 主机ID
+         */
+        NodeId: string;
+        /**
+         * 镜像信息
+         */
+        OsName: string;
+        /**
+         * 创建时间
+         */
+        CreateTime: number;
+        /**
+         * 到期时间
+         */
+        ExpireTime: number;
+        /**
+         * 主机状态
+         */
+        State: string;
+        /**
+         * 节点类型：uhost表示云主机;uphost表示物理云主机
+         */
+        NodeType: string;
+    }[];
+    /**
+     * Node节点配置信息,具体参考UhostInfo
+     */
+    NodeList?: {
+        /**
+         * 所在机房
+         */
+        Zone: string;
+        /**
+         * 主机名称
+         */
+        Name: string;
+        /**
+         * Cpu数量
+         */
+        CPU: number;
+        /**
+         * 内存
+         */
+        Memory: number;
+        /**
+         * 节点IP信息
+         */
+        IPSet: {
+            /**
+             * 国际: Internation，BGP: Bgp，内网: Private
+             */
+            Type?: string;
+            /**
+             * IP资源ID (内网IP无对应的资源ID)
+             */
+            IPId?: string;
+            /**
+             * IP地址
+             */
+            IP?: string;
+            /**
+             * IP对应的带宽, 单位: Mb (内网IP不显示带宽信息)
+             */
+            Bandwidth?: number;
+            /**
+             * 是否默认的弹性网卡的信息。true: 是默认弹性网卡；其他值：不是。
+             */
+            Default?: string;
+        }[];
+        /**
+         * 节点磁盘信息
+         */
+        DiskSet: {
+            /**
+             * 磁盘类型。系统盘: Boot，数据盘: Data,网络盘：Udisk
+             */
+            Type?: string;
+            /**
+             * 磁盘长ID
+             */
+            DiskId?: string;
+            /**
+             * UDisk名字（仅当磁盘是UDisk时返回）
+             */
+            Name?: string;
+            /**
+             * 磁盘盘符
+             */
+            Drive?: string;
+            /**
+             * 磁盘大小，单位: GB
+             */
+            Size?: number;
+            /**
+             * 备份方案，枚举类型：BASIC_SNAPSHOT,普通快照；DATAARK,方舟。无快照则不返回该字段。
+             */
+            BackupType?: string;
+            /**
+             * 当前主机的IOPS值
+             */
+            IOPS?: number;
+            /**
+             * Yes: 加密 No: 非加密
+             */
+            Encrypted?: string;
+            /**
+             * LOCAL_NOMAL| CLOUD_NORMAL| LOCAL_SSD| CLOUD_SSD|EXCLUSIVE_LOCAL_DISK
+             */
+            DiskType?: string;
+            /**
+             * True| False
+             */
+            IsBoot?: string;
+        }[];
+        /**
+         * 主机ID
+         */
+        NodeId: string;
+        /**
+         * 镜像信息
+         */
+        OsName: string;
+        /**
+         * 创建时间
+         */
+        CreateTime: number;
+        /**
+         * 到期时间
+         */
+        ExpireTime: number;
+        /**
+         * 主机状态
+         */
+        State: string;
+        /**
+         * 节点类型：uhost表示云主机;uphost表示物理云主机
+         */
+        NodeType: string;
+    }[];
+    /**
+     * 创建时间
+     */
+    CreateTime?: number;
+    /**
+     * Node节点数量
+     */
+    NodeCount?: number;
+    /**
+     * 集群apiserver地址
+     */
+    ApiServer?: string;
+    /**
+     * 状态
+     */
+    Status?: string;
+    /**
+     * 集群外部apiserver地址
+     */
+    ExternalApiServer?: string;
+    /**
+     * kube-proxy配置
+     */
+    KubeProxy?: {
+        /**
+         * KubeProxy模式，枚举值为[ipvs,iptables]
+         */
+        Mode?: string;
+    };
+    /**
+     * K8S版本
+     */
+    Version?: string;
+    /**
+     * 自定义或者默认的clusterdomain
+     */
+    ClusterDomain?: string;
+    /**
+     * 集群etcd服务证书
+     */
+    EtcdCert?: string;
+    /**
+     * 集群etcd服务密钥
+     */
+    EtcdKey?: string;
+    /**
+     * 集群CA根证书
+     */
+    CACert?: string;
+    /**
+     * Master配置预警：Normal正常；Warning 需要升级；Error    需要紧急升级；
+     */
+    MasterResourceStatus?: string;
+}
 /**
  * DescribeUK8SImage - 获取UK8S支持的Node节点操作系统，可基于该操作系统制定自定义镜像
  */
@@ -563,6 +992,161 @@ export interface DescribeUK8SImageResponse {
         NotSupportGPU: boolean;
     }[];
 }
+/**
+ * DescribeUK8SNode - 用于获取 UK8S 节点详情
+ */
+export interface DescribeUK8SNodeRequest {
+    /**
+     * UK8S 集群 Id
+     */
+    ClusterId: string;
+    /**
+     * K8S 节点IP或者节点ID
+     */
+    Name: string;
+}
+/**
+ * DescribeUK8SNode - 用于获取 UK8S 节点详情
+ */
+export interface DescribeUK8SNodeResponse {
+    /**
+     * 节点名称
+     */
+    Name: string;
+    /**
+     * 字符串数组，每一项是类似 "kubernetes.io/arch=amd64" 的标签
+     */
+    Labels: string[];
+    /**
+     * 字符串数组，每一项是类似 "node.alpha.kubernetes.io/ttl=0" 的注解
+     */
+    Annotations: string[];
+    /**
+     * 时间戳，单位是 秒
+     */
+    CreationTimestamp: number;
+    /**
+     * 字符串，如："UCloud://cn-sh2-02//uk8s-vsc0vgob-n-mpzxc"
+     */
+    ProviderID: string;
+    /**
+     * 内核版本，如："4.19.0-6.el7.ucloud.x86_64"
+     */
+    KernelVersion: string;
+    /**
+     * 操作系统类型，如："CentOS Linux 7 (Core)"
+     */
+    OSImage: string;
+    /**
+     * 容器运行时版本，如："docker://18.9.9"
+     */
+    ContainerRuntimeVersion: string;
+    /**
+     * kubelet 版本
+     */
+    KubeletVersion: string;
+    /**
+     * kubeproxy 版本
+     */
+    KubeProxyVersion: string;
+    /**
+     * 内部 IP 地址
+     */
+    InternalIP: string;
+    /**
+     * 主机名
+     */
+    Hostname: string;
+    /**
+     * 已分配到当前节点的 Pod 数量
+     */
+    AllocatedPodCount: number;
+    /**
+     * 节点允许的可分配 Pod 最大数量
+     */
+    PodCapacity: number;
+    /**
+     * 是否禁止调度
+     */
+    Unschedulable: boolean;
+    /**
+     * 节点 CPU 总量
+     */
+    CPUCapacity: string;
+    /**
+     * 节点内存总量
+     */
+    MemoryCapacity: string;
+    /**
+     * 节点上已分配 Pod 的内存请求量
+     */
+    MemoryRequests: string;
+    /**
+     * 节点上已分配 Pod 的内存请求量占内存总量的比例，如返回值为 "4.5"，则意味着请求量占总量的 4.5%
+     */
+    MemoryRequestsFraction: string;
+    /**
+     * 节点上已分配 Pod 的内存限制量
+     */
+    MemoryLimits: string;
+    /**
+     * 节点上已分配 Pod 的内存限制量占内存总量的比例，如返回值为 "18"，则意味着限制量占总量的 18%
+     */
+    MemoryLimitsFraction: string;
+    /**
+     * 节点上已分配 Pod 的 CPU 请求量
+     */
+    CPURequests: string;
+    /**
+     * 节点上已分配 Pod 的 CPU 请求量占 CPU 总量的比例
+     */
+    CPURequestsFraction: string;
+    /**
+     * 节点上已分配 Pod 的 CPU 限制值
+     */
+    CPULimits: string;
+    /**
+     * 节点上已分配 Pod 的 CPU 限制值占 CPU 总量的比例
+     */
+    CPULimitsFraction: string;
+    /**
+     * 节点状态数组
+     */
+    Conditions: {
+        /**
+         * Condition 类型，如 MemoryPressure、DiskPressure、PIDPressure、Ready
+         */
+        Type?: string;
+        /**
+         * 状态，False、True
+         */
+        Status?: string;
+        /**
+         * 最后一次上报状态的时间
+         */
+        LastProbeTime?: string;
+        /**
+         * 最后一次状态转变时间
+         */
+        LastTransitionTime?: string;
+        /**
+         * 状态变化的原因
+         */
+        Reason?: string;
+        /**
+         * 状态变化的描述信息
+         */
+        Message?: string;
+    }[];
+    /**
+     * 节点上镜像名称数组
+     */
+    ContainerImages: string[];
+    /**
+     * 字符串数组，每一项是类似 "node-role.kubernetes.io/master:NoSchedule" 的污点
+     */
+    Taints?: string[];
+}
 /**
  * ListUK8SClusterNodeV2 - 获取UK8S集群节点信息
  */
@@ -593,7 +1177,7 @@ export interface ListUK8SClusterNodeV2Response {
          */
         NodeRole: string;
         /**
-         * Node的状态
+         * Node的状态：枚举值：初始化："Initializing"；启动中："Starting"；运行："Running"；停止中："Stopping"；停止："Stopped"；待删除："ToBeDeleted"；删除中："Deleting"；异常："Error"；安装失败："Install Fail"；
          */
         NodeStatus: string;
         /**
@@ -648,10 +1232,6 @@ export interface ListUK8SClusterNodeV2Response {
              * IP对应的带宽, 单位: Mb (内网IP不显示带宽信息)
              */
             Bandwidth?: number;
-            /**
-             * 是否默认的弹性网卡的信息。true: 是默认弹性网卡；其他值：不是。
-             */
-            Default?: string;
             /**
              * IP地址对应的VPC ID
              */
@@ -769,6 +1349,10 @@ export interface ListUK8SClusterV2Response {
          * 集群版本
          */
         K8sVersion: string;
+        /**
+         * 创建集群时判断如果为NORESOURCE则为没资源，否则为空
+         */
+        ClusterLogInfo?: string;
         /**
          * 创建时间
          */
@@ -782,8 +1366,105 @@ export interface ListUK8SClusterV2Response {
          */
         ExternalApiServer?: string;
         /**
-         * 状态
+         * 集群状态，枚举值：初始化："INITIALIZING"；启动中："STARTING"；创建失败："CREATEFAILED"；正常运行："RUNNING"；添加节点："ADDNODE"；删除节点："DELNODE"；删除中："DELETING"；删除失败："DELETEFAILED"；错误："ERROR"；升级插件："UPDATE_PLUGIN"；更新插件信息："UPDATE_PLUGIN_INFO"；异常："ABNORMAL"；升级集群中："UPGRADING"；容器运行时切换："CONVERTING"
          */
         Status?: string;
     }[];
 }
+/**
+ * ListUK8SNodeGroup - 列出UK8S节点池
+ */
+export interface ListUK8SNodeGroupRequest {
+    /**
+     * 集群ID
+     */
+    ClusterId: string;
+}
+/**
+ * ListUK8SNodeGroup - 列出UK8S节点池
+ */
+export interface ListUK8SNodeGroupResponse {
+    /**
+     * 节点池列表
+     */
+    NodeGroupList?: {
+        /**
+         * 节点池ID
+         */
+        NodeGroupId?: string;
+        /**
+         * 节点池名字
+         */
+        NodeGroupName?: string;
+        /**
+         * 镜像ID
+         */
+        ImageId?: string;
+        /**
+         * 机型
+         */
+        MachineType?: string;
+        /**
+         * cpu平台
+         */
+        MinimalCpuPlatform?: string;
+        /**
+         * 虚拟CPU核数
+         */
+        CPU?: number;
+        /**
+         * 内存大小
+         */
+        Mem?: number;
+        /**
+         * GPU类型
+         */
+        GpuType?: string;
+        /**
+         * GPU卡核心数
+         */
+        GPU?: number;
+        /**
+         * 系统盘类型
+         */
+        BootDiskType?: string;
+        /**
+         * 数据盘大小
+         */
+        DataDiskSize?: number;
+        /**
+         * 数据盘类型
+         */
+        DataDiskType?: string;
+        /**
+         * 业务组
+         */
+        Tag?: string;
+        /**
+         * 付费方式
+         */
+        ChargeType?: string;
+        /**
+         * 节点id列表
+         */
+        NodeList?: string[];
+    }[];
+}
+/**
+ * RemoveUK8SNodeGroup - 删除UK8S节点池
+ */
+export interface RemoveUK8SNodeGroupRequest {
+    /**
+     * 节点池Id
+     */
+    NodeGroupId: string;
+    /**
+     * 集群id
+     */
+    ClusterId: string;
+}
+/**
+ * RemoveUK8SNodeGroup - 删除UK8S节点池
+ */
+export interface RemoveUK8SNodeGroupResponse {
+}