tencentcloud-sdk-nodejs

/** * DescribeInstanceShards请求参数结构体 */ export interface DescribeInstanceShardsRequest { /** * 集群实例ID */ InstanceId: string; } /** * ScaleOutInstance请求参数结构体 */ export interface ScaleOutInstanceRequest { /** * 实例唯一ID */ InstanceId: string; /** * 节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点 */ Type: string; /** * 调整clickhouse节点数量 */ NodeCount: number; /** * v_cluster分组，新增扩容节点将加入到已选择的v_cluster分组中，提交同步VIP生效. */ ScaleOutCluster?: string; /** * 子网剩余ip数量，用于判断当前实例子网剩余ip数是否能扩容。需要根据实际填写 */ UserSubnetIPNum?: number; /** * 同步元数据节点IP （uip），扩容的时候必填 */ ScaleOutNodeIp?: string; /** * 缩容节点shard的节点IP （uip），其中ha集群需要主副节点ip都传入以逗号分隔，缩容的时候必填 */ ReduceShardInfo?: Array<string>; } /** * ScaleOutInstance返回参数结构体 */ export interface ScaleOutInstanceResponse { /** * 流程ID */ FlowId?: string; /** * 实例ID */ InstanceId?: string; /** * 错误信息 */ ErrorMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstancesNew返回参数结构体 */ export interface DescribeInstancesNewResponse { /** * 实例总数 */ TotalCount?: number; /** * 实例数组 */ InstancesList?: Array<InstanceInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 副可用区详情 */ export interface SecondaryZoneInfo { /** * 副可用区 */ SecondaryZone?: string; /** * 可用区可用的子网id */ SecondarySubnet?: string; /** * 可用区可用的子网可用ip的数量 */ UserIpNum?: string; /** * 可用区可用的子网可用ip的数量 */ SecondaryUserSubnetIPNum?: number; } /** * 数据库权限信息 */ export interface DatabasePrivilegeInfo { /** * 数据库名称 */ DatabaseName: string; /** * 库表权限，SELECT、INSERT_ALL、ALTER、TRUNCATE、DROP_TABLE、CREATE_TABLE、DROP_DATABASE */ DatabasePrivileges?: Array<string>; /** * 库下面的表权限 */ TablePrivilegeList?: Array<TablePrivilegeInfo>; } /** * DescribeInstanceKeyValConfigs请求参数结构体 */ export interface DescribeInstanceKeyValConfigsRequest { /** * 集群实例ID */ InstanceId: string; /** * 搜索的配置项名称 */ SearchConfigName?: string; } /** * DescribeInstanceNodes请求参数结构体 */ export interface DescribeInstanceNodesRequest { /** * 集群实例ID */ InstanceId: string; /** * 集群角色类型，“DATA” 为数据节点、“COMMON” 为 ZooKeeper 节点，默认为 "DATA" 数据节点。 */ NodeRole?: string; /** * 分页参数，第一页为0，第二页为10 */ Offset?: number; /** * 分页参数，分页步长，默认为10 */ Limit?: number; /** * 展现策略，All时显示所有 */ DisplayPolicy?: string; /** * 当true的时候返回所有节点，即Limit无限大 */ ForceAll?: boolean; } /** * 集群计费相关信息 */ export interface Charge { /** * 计费类型，“PREPAID” 预付费，“POSTPAID_BY_HOUR” 后付费 */ ChargeType: string; /** * PREPAID需要传递，是否自动续费，1表示自动续费开启 */ RenewFlag?: number; /** * 预付费需要传递，计费时间长度，多少个月 */ TimeSpan?: number; } /** * DescribeClusterConfigs返回参数结构体 */ export interface DescribeClusterConfigsResponse { /** * 返回实例的配置文件相关的信息 */ ClusterConfList?: Array<ClusterConfigsInfoFromEMR>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ActionAlterCkUser请求参数结构体 */ export interface ActionAlterCkUserRequest { /** * 用户信息 */ UserInfo: CkUserAlterInfo; /** * api接口类型， AddSystemUser新增用户，UpdateSystemUser，修改用户 */ ApiType: string; } /** * DescribeCkSqlApis请求参数结构体 */ export interface DescribeCkSqlApisRequest { /** * 实例id */ InstanceId: string; /** * api接口名称,GetClusters:获取集群cluster列表 GetSystemUsers:获取系统用户列表 CheckNodeCluster: 检查节点是否隶属一个cluster GetClusterDatabases: 获取一个cluster下的数据库列表 GetClusterTables: 获取一个cluster下的数据库表列表 GetPrivilegeUsers: 获取授权的用户列表 GET_USER_CLUSTER_PRIVILEGES:获取用户cluster下的权限 GetUserClusterNewPrivileges:获取用户cluster下的权限 (新版） RevokeClusterUser:解绑cluster用户 DeleteSystemUser:删除系统用户 —— 必须所有cluster先解绑 GetUserOptionMessages:获取用户配置备注信息 GET_USER_CONFIGS:获取用户配置列表 QUOTA、PROFILE、POLICY */ ApiType: string; /** * 集群名称，GET_SYSTEM_USERS，GET_PRIVILEGE_USERS，GET_CLUSTER_DATABASES，GET_CLUSTER_TABLES 必填 */ Cluster?: string; /** * 用户名称，api与user相关的必填 */ UserName?: string; /** * 账户的类型 */ UserType?: string; } /** * 新增或是修改ck用户 */ export interface CkUserAlterInfo { /** * 集群实例id */ InstanceId: string; /** * 用户名 */ UserName: string; /** * base64加密后的密码 */ PassWord: string; /** * 描述 */ Describe?: string; } /** * DescribeBackUpSchedule请求参数结构体 */ export interface DescribeBackUpScheduleRequest { /** * 集群id */ InstanceId: string; } /** * DescribeSpec返回参数结构体 */ export interface DescribeSpecResponse { /** * zookeeper节点规格描述 */ CommonSpec?: Array<ResourceSpec>; /** * 数据节点规格描述 */ DataSpec?: Array<ResourceSpec>; /** * 云盘列表 */ AttachCBSSpec?: Array<DiskSpec>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSpec请求参数结构体 */ export interface DescribeSpecRequest { /** * 地域信息，例如"ap-guangzhou-1" */ Zone: string; /** * 计费类型，PREPAID 包年包月，POSTPAID_BY_HOUR 按量计费 */ PayMode?: string; /** * 是否弹性ck */ IsElastic?: boolean; /** * 是否是购买页面需要的spec */ CaseType?: number; } /** * ScaleCNOutUpInstance返回参数结构体 */ export interface ScaleCNOutUpInstanceResponse { /** * 流程ID */ FlowId?: string; /** * 实例ID */ InstanceId?: string; /** * 错误信息 */ ErrorMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DestroyInstance请求参数结构体 */ export interface DestroyInstanceRequest { /** * 集群id */ InstanceId: string; } /** * ModifyUserNewPrivilege请求参数结构体 */ export interface ModifyUserNewPrivilegeRequest { /** * 实例id */ InstanceId: string; /** * cluster名称 */ Cluster: string; /** * 用户名 */ UserName: string; /** * 是否所有数据库表 */ AllDatabase: boolean; /** * 全局权限 */ GlobalPrivileges?: Array<string>; /** * 数据库表权限 */ DatabasePrivilegeList?: Array<DatabasePrivilegeInfo>; } /** * DescribeBackUpTables返回参数结构体 */ export interface DescribeBackUpTablesResponse { /** * 可备份表列表 */ AvailableTables?: Array<BackupTableContent>; /** * 错误描述 */ ErrorMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用于返回XML格式的配置文件和内容以及其他配置文件有关的信息 */ export interface ClusterConfigsInfoFromEMR { /** * 配置文件名称 */ FileName?: string; /** * 配置文件对应的相关属性信息 */ FileConf?: string; /** * 配置文件对应的其他属性信息 */ KeyConf?: string; /** * 配置文件的内容，base64编码 */ OriParam?: string; /** * 用于表示当前配置文件是不是有过修改后没有重启，提醒用户需要重启 */ NeedRestart?: number; /** * 保存配置文件的路径 */ FilePath?: string; } /** * clickhouse vcluster信息 */ export interface ClusterInfo { /** * vcluster名字 */ ClusterName?: string; /** * 当前cluster的IP列表 */ NodeIps?: Array<string>; } /** * OpenBackUp请求参数结构体 */ export interface OpenBackUpRequest { /** * 集群id */ InstanceId: string; /** * OPEN 或者CLOSE */ OperationType: string; /** * 桶名字 */ CosBucketName: string; } /** * ModifyInstanceKeyValConfigs返回参数结构体 */ export interface ModifyInstanceKeyValConfigsResponse { /** * 错误信息 */ ErrorMsg?: string; /** * ID */ FlowId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 备份表信息 */ export interface BackupTableContent { /** * 数据库 */ Database: string; /** * 表 */ Table: string; /** * 表总字节数 */ TotalBytes: number; /** * 虚拟cluster */ VCluster?: string; /** * 表ip */ Ips?: string; /** * zk路径 */ ZooPath?: string; /** * cvm的ip地址 */ Rip?: string; } /** * OpenBackUp返回参数结构体 */ export interface OpenBackUpResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateInstanceNew返回参数结构体 */ export interface CreateInstanceNewResponse { /** * 流程ID */ FlowId?: string; /** * 实例ID */ InstanceId?: string; /** * 错误信息注意：此字段可能返回 null，表示取不到有效值。 */ ErrorMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 配置文件修改信息 */ export interface ConfigSubmitContext { /** * 配置文件名称 */ FileName: string; /** * 配置文件旧内容，base64编码 */ OldConfValue: string; /** * 配置文件新内容，base64编码 */ NewConfValue: string; /** * 保存配置文件的路径 */ FilePath?: string; } /** * 集群状态抽象后的结构体 */ export interface InstanceStateInfo { /** * 集群状态，例如：Serving */ InstanceState?: string; /** * 集群操作创建时间 */ FlowCreateTime?: string; /** * 集群操作名称 */ FlowName?: string; /** * 集群操作进度 */ FlowProgress?: number; /** * 集群状态描述，例如：运行中 */ InstanceStateDesc?: string; /** * 集群流程错误信息，例如：“创建失败，资源不足” */ FlowMsg?: string; /** * 当前步骤的名称，例如：”购买资源中“ */ ProcessName?: string; /** * 请求id */ RequestId?: string; /** * 流程的二级名称 */ ProcessSubName?: string; } /** * 表权限 */ export interface TablePrivilegeInfo { /** * 表名称 */ TableName: string; /** * 表权限列表 SELECT、INSERT_ALL、ALTER、TRUNCATE、DROP_TABLE 查询、插入、设置、清空表、删除表 */ TablePrivileges: Array<string>; } /** * DescribeInstanceClusters返回参数结构体 */ export interface DescribeInstanceClustersResponse { /** * cluster列表 */ Clusters?: Array<ClusterInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateInstanceNew请求参数结构体 */ export interface CreateInstanceNewRequest { /** * 可用区 */ Zone: string; /** * 是否高可用 */ HaFlag: boolean; /** * 私有网络 */ UserVPCId: string; /** * 子网 */ UserSubnetId: string; /** * 系统版本 */ ProductVersion: string; /** * 计费方式 */ ChargeProperties: Charge; /** * 实例名称 */ InstanceName: string; /** * 数据节点 SpecName从DescribeSpec接口中返回的DataSpec.Name获取 */ DataSpec: NodeSpec; /** * 标签列表（废弃） * @deprecated */ Tags?: Tag; /** * 日志主题ID */ ClsLogSetId?: string; /** * COS桶名称 */ CosBucketName?: string; /** * 是否是裸盘挂载，默认值 0 为未挂载，1 为挂载。 */ MountDiskType?: number; /** * 是否是ZK高可用 */ HAZk?: boolean; /** * ZK节点 SpecName从DescribeSpec接口中返回的CommonSpec.Name（ZK节点）获取 */ CommonSpec?: NodeSpec; /** * 标签列表 */ TagItems?: Array<Tag>; /** * 副可用去信息 */ SecondaryZoneInfo?: Array<SecondaryZoneInfo>; } /** * 实例描述信息 */ export interface InstanceInfo { /** * 集群实例ID, "cdw-xxxx" 字符串类型 */ InstanceId?: string; /** * 集群实例名称 */ InstanceName?: string; /** * 状态, Init 创建中; Serving 运行中； Deleted已销毁；Deleting 销毁中； Modify 集群变更中； */ Status?: string; /** * 版本 */ Version?: string; /** * 地域, ap-guangzhou */ Region?: string; /** * 可用区， ap-guangzhou-3 */ Zone?: string; /** * 私有网络名称 */ VpcId?: string; /** * 子网名称 */ SubnetId?: string; /** * 付费类型，"hour", "prepay" */ PayMode?: string; /** * 创建时间 */ CreateTime?: string; /** * 过期时间 */ ExpireTime?: string; /** * 数据节点描述信息 */ MasterSummary?: NodesSummary; /** * zookeeper节点描述信息 */ CommonSummary?: NodesSummary; /** * 高可用，“true" "false" */ HA?: string; /** * 访问地址，例如 "10.0.0.1:9000" */ AccessInfo?: string; /** * 记录ID，数值型 */ Id?: number; /** * regionId, 表示地域 */ RegionId?: number; /** * 可用区说明，例如 "广州二区" */ ZoneDesc?: string; /** * 错误流程说明信息 */ FlowMsg?: string; /** * 状态描述，例如“运行中”等 */ StatusDesc?: string; /** * 自动续费标记 */ RenewFlag?: boolean; /** * 标签列表 */ Tags?: Array<Tag>; /** * 监控信息 */ Monitor?: string; /** * 是否开通日志 */ HasClsTopic?: boolean; /** * 日志主题ID */ ClsTopicId?: string; /** * 日志集ID */ ClsLogSetId?: string; /** * 是否支持xml配置管理 */ EnableXMLConfig?: number; /** * 区域 */ RegionDesc?: string; /** * 弹性网卡地址 */ Eip?: string; /** * 冷热分层系数 */ CosMoveFactor?: number; /** * external/local/yunti */ Kind?: string; /** * 是否弹性ck */ IsElastic?: boolean; /** * 集群详细状态 */ InstanceStateInfo?: InstanceStateInfo; /** * ZK高可用 */ HAZk?: boolean; /** * 挂载盘,默认0:没有类型；1:裸盘;2:lvm */ MountDiskType?: number; /** * chproxy连接ip */ CHProxyVip?: string; /** * cos buket的名字 */ CosBucketName?: string; /** * 是否可以挂载云盘 */ CanAttachCbs?: boolean; /** * 是否可以挂载云盘阵列 */ CanAttachCbsLvm?: boolean; /** * 是否可以挂载cos */ CanAttachCos?: boolean; /** * 服务信息 */ Components?: Array<ServiceInfo>; /** * 可升级的内核版本 */ UpgradeVersions?: string; /** * ex-index */ EsIndexId?: string; /** * username */ EsIndexUsername?: string; /** * password */ EsIndexPassword?: string; /** * true */ HasEsIndex?: boolean; /** * true */ IsSecondaryZone?: boolean; /** * desc */ SecondaryZoneInfo?: string; /** * 是否clickhouse-keeper */ ClickHouseKeeper?: boolean; /** * 实例扩展信息 */ Details?: InstanceDetail; /** * 安全组白名单 */ IsWhiteSGs?: boolean; /** * 绑定的安全组 */ BindSGs?: Array<string>; /** * 是否开启公网clb */ HasPublicCloudClb?: boolean; } /** * 创建集群时的规格 */ export interface NodeSpec { /** * 规格名称 */ SpecName: string; /** * 数量 */ Count: number; /** * 云盘大小 */ DiskSize: number; } /** * DescribeBackUpJobDetail返回参数结构体 */ export interface DescribeBackUpJobDetailResponse { /** * 备份表详情 */ TableContents?: Array<BackupTableContent>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyClusterConfigs请求参数结构体 */ export interface ModifyClusterConfigsRequest { /** * 集群ID，例如cdwch-xxxx */ InstanceId: string; /** * 配置文件修改信息 */ ModifyConfContext: Array<ConfigSubmitContext>; /** * 修改原因 */ Remark?: string; } /** * ScaleUpInstance请求参数结构体 */ export interface ScaleUpInstanceRequest { /** * 实例唯一ID */ InstanceId: string; /** * 节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点 */ Type: string; /** * clickhouse节点规格。 */ SpecName: string; /** * 是否滚动重启，false为不滚动重启，true为滚动重启 */ ScaleUpEnableRolling: boolean; } /** * 集群分组信息描述 */ export interface GroupInfo { /** * 分组名称 */ GroupName: string; /** * 分片变量名称 */ ShardName: string; /** * 副本变量名称 */ ReplicaName: string; } /** * DescribeInstanceKeyValConfigs返回参数结构体 */ export interface DescribeInstanceKeyValConfigsResponse { /** * 参数列表 */ ConfigItems?: Array<InstanceConfigInfo>; /** * 未配置的参数列表注意：此字段可能返回 null，表示取不到有效值。 */ UnConfigItems?: Array<InstanceConfigInfo>; /** * 配置的多层级参数列表注意：此字段可能返回 null，表示取不到有效值。 */ MapConfigItems?: Array<MapConfigItem>; /** * 错误信息注意：此字段可能返回 null，表示取不到有效值。 */ ErrorMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 服务详细信息描述。 */ export interface ServiceInfo { /** * 服务名称 */ Name?: string; /** * 服务的版本 */ Version?: string; } /** * kv配置，多层级item */ export interface MapConfigItem { /** * key */ ConfKey?: string; /** * 列表 */ Items?: Array<InstanceConfigInfo>; } /** * ModifyClusterConfigs返回参数结构体 */ export interface ModifyClusterConfigsResponse { /** * 流程相关信息 */ FlowId?: number; /** * 错误信息 */ ErrorMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RecoverBackUpJob请求参数结构体 */ export interface RecoverBackUpJobRequest { /** * 集群id */ InstanceId: string; /** * 任务id */ BackUpJobId: number; } /** * 磁盘规格描述 */ export interface DiskSpec { /** * 磁盘类型，例如“CLOUD_SSD", "LOCAL_SSD"等 */ DiskType: string; /** * 磁盘类型说明，例如"云SSD", "本地SSD"等 */ DiskDesc: string; /** * 磁盘最小规格大小，单位G */ MinDiskSize: number; /** * 磁盘最大规格大小，单位G */ MaxDiskSize: number; /** * 磁盘数目 */ DiskCount: number; } /** * DescribeInstancesNew请求参数结构体 */ export interface DescribeInstancesNewRequest { /** * 搜索的集群id名称 */ SearchInstanceId?: string; /** * 搜索的集群name */ SearchInstanceName?: string; /** * 分页参数，第一页为0，第二页为10 */ Offset?: number; /** * 分页参数，分页步长，默认为10 */ Limit?: number; /** * 搜索标签列表 */ SearchTags?: Array<SearchTags>; /** * 信息详细与否 */ IsSimple?: boolean; /** * vip列表 */ Vips?: Array<string>; } /** * DeleteBackUpData返回参数结构体 */ export interface DeleteBackUpDataResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceKeyValConfigs请求参数结构体 */ export interface ModifyInstanceKeyValConfigsRequest { /** * 实例ID */ InstanceId: string; /** * 新增配置列表 */ AddItems?: Array<InstanceConfigItem>; /** * 更新配置列表 */ UpdateItems?: Array<InstanceConfigItem>; /** * 删除配置列表 */ DeleteItems?: InstanceConfigItem; /** * 删除配置列表 */ DelItems?: Array<InstanceConfigItem>; /** * 备注 */ Remark?: string; } /** * DescribeInstanceNodes返回参数结构体 */ export interface DescribeInstanceNodesResponse { /** * 总数 */ TotalCount?: number; /** * 实例节点总数注意：此字段可能返回 null，表示取不到有效值。 */ InstanceNodesList?: Array<InstanceNode>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 标签描述 */ export interface Tag { /** * 标签的键 */ TagKey: string; /** * 标签的值 */ TagValue: string; } /** * 备份任务详情 */ export interface BackUpJobDisplay { /** * 备份任务id */ JobId?: number; /** * 备份任务名 */ Snapshot?: string; /** * 任务类型(元数据),(数据) */ BackUpType?: string; /** * 备份数据量 */ BackUpSize?: number; /** * 任务创建时间 */ BackUpTime?: string; /** * 任务过期时间 */ ExpireTime?: string; /** * 任务状态 */ JobStatus?: string; /** * 处理数据量 */ ProcessSize?: number; /** * 错误原因 */ ErrorReason?: string; } /** * DescribeClusterConfigs请求参数结构体 */ export interface DescribeClusterConfigsRequest { /** * 集群实例ID */ InstanceId: string; } /** * 资源规格描述信息 */ export interface ResourceSpec { /** * 规格名称，例如“SCH1" */ Name?: string; /** * cpu核数 */ Cpu?: number; /** * 内存大小，单位G */ Mem?: number; /** * 分类标记，STANDARD/BIGDATA/HIGHIO分别表示标准型/大数据型/高IO */ Type?: string; /** * 系统盘描述信息 */ SystemDisk?: DiskSpec; /** * 数据盘描述信息 */ DataDisk?: DiskSpec; /** * 最大节点数目限制 */ MaxNodeSize?: number; /** * 是否可用，false代表售罄 */ Available?: boolean; /** * 规格描述信息 */ ComputeSpecDesc?: string; /** * 规格名 */ DisplayName?: string; /** * 库存数 */ InstanceQuota?: number; } /** * 列表页搜索的标记列表 */ export interface SearchTags { /** * 标签的键 */ TagKey?: string; /** * 标签的值 */ TagValue?: string; /** * 1表示只输入标签的键，没有输入值；0表示输入键时且输入值 */ AllValue?: number; } /** * CreateBackUpSchedule返回参数结构体 */ export interface CreateBackUpScheduleResponse { /** * 错误描述 */ ErrorMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * KV配置 */ export interface InstanceConfigItem { /** * key */ ConfKey: string; /** * value */ ConfValue: string; } /** * RecoverBackUpJob返回参数结构体 */ export interface RecoverBackUpJobResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstance返回参数结构体 */ export interface DescribeInstanceResponse { /** * 实例描述信息 */ InstanceInfo?: InstanceInfo; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBackUpJob返回参数结构体 */ export interface DescribeBackUpJobResponse { /** * 任务列表 */ BackUpJobs?: Array<BackUpJobDisplay>; /** * 错误描述 */ ErrorMsg?: string; /** * 数量 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceClusters请求参数结构体 */ export interface DescribeInstanceClustersRequest { /** * 实例ID */ InstanceId: string; } /** * ResizeDisk请求参数结构体 */ export interface ResizeDiskRequest { /** * 实例唯一ID */ InstanceId: string; /** * 节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点 */ Type: string; /** * 磁盘扩容后容量，不能小于原有用量。clickhouse最小200，且为100的整数倍。 zk最小100，且为10的整数倍； */ DiskSize: number; } /** * DescribeInstanceState请求参数结构体 */ export interface DescribeInstanceStateRequest { /** * 集群实例名称 */ InstanceId: string; } /** * 节点角色描述信息 */ export interface NodesSummary { /** * 机型，如 S1 */ Spec?: string; /** * 节点数目 */ NodeSize?: number; /** * cpu核数，单位个 */ Core?: number; /** * 内存大小，单位G */ Memory?: number; /** * 磁盘大小，单位G */ Disk?: number; /** * 磁盘类型 */ DiskType?: string; /** * 磁盘描述 */ DiskDesc?: string; /** * 挂载云盘信息 */ AttachCBSSpec?: AttachCBSSpec; /** * 子产品类型 */ SubProductType?: string; /** * 规格对应的核数 */ SpecCore?: number; /** * 规格对应的内存大小 */ SpecMemory?: number; /** * 磁盘的数量 */ DiskCount?: number; /** * 磁盘的最大大小 */ MaxDiskSize?: number; /** * 是否为加密云盘 */ Encrypt?: number; } /** * DescribeInstanceShards返回参数结构体 */ export interface DescribeInstanceShardsResponse { /** * 实例shard信息 */ InstanceShardsList?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例节点描述信息 */ export interface InstanceNode { /** * IP地址 */ Ip?: string; /** * 机型，如 S1 */ Spec?: string; /** * cpu核数 */ Core?: number; /** * 内存大小 */ Memory?: number; /** * 磁盘类型 */ DiskType?: string; /** * 磁盘大小 */ DiskSize?: number; /** * 所属clickhouse cluster名称 */ Cluster?: string; /** * 节点所属的分组信息 */ NodeGroups?: Array<GroupInfo>; /** * VPC IP */ Rip?: string; /** * ture的时候表示该节点上部署了chproxy进程 */ IsCHProxy?: boolean; /** * 节点状态 */ Status?: string; /** * 节点uuid */ UUID?: string; /** * 区 */ Zone?: string; /** * 区描述 */ ZoneDesc?: string; /** * 真实资源id */ RealResourceId?: string; } /** * 集群配置信息 */ export interface InstanceConfigInfo { /** * 配置项名称 */ ConfKey: string; /** * 配置项内容 */ ConfValue: string; /** * 默认值 */ DefaultValue?: string; /** * 是否需要重启 */ NeedRestart?: boolean; /** * 是否可编辑 */ Editable?: boolean; /** * 配置项解释 */ ConfDesc?: string; /** * 文件名称 */ FileName?: string; /** * 规则名称类型 */ ModifyRuleType?: string; /** * 规则名称内容 */ ModifyRuleValue?: string; /** * 修改人的uin */ Uin?: string; /** * 修改时间 */ ModifyTime?: string; } /** * DescribeBackUpJobDetail请求参数结构体 */ export interface DescribeBackUpJobDetailRequest { /** * 集群id */ InstanceId: string; /** * 任务id */ BackUpJobId: number; } /** * CreateBackUpSchedule请求参数结构体 */ export interface CreateBackUpScheduleRequest { /** * 集群id */ InstanceId: string; /** * 策略类型 meta(元数据) data (表数据) */ ScheduleType: string; /** * 操作类型 create(创建) update(编辑修改) */ OperationType: string; /** * 保留天数例如7 */ RetainDays?: number; /** * 编辑时需要传 */ ScheduleId?: number; /** * 选择的星期逗号分隔，例如 2 代表周二 */ WeekDays?: string; /** * 执行小时 */ ExecuteHour?: number; /** * 备份表列表 */ BackUpTables?: Array<BackupTableContent>; } /** * DeleteBackUpData请求参数结构体 */ export interface DeleteBackUpDataRequest { /** * 集群id */ InstanceId: string; /** * 任务id */ BackUpJobId?: number; /** * 是否删除所有数据 */ IsDeleteAll?: boolean; } /** * DescribeInstance请求参数结构体 */ export interface DescribeInstanceRequest { /** * 集群实例ID */ InstanceId: string; /** * 是否是open api查询 */ IsOpenApi?: boolean; } /** * Instance表detail字段 */ export interface InstanceDetail { /** * 告警策略是否可用 */ EnableAlarmStrategy?: boolean; } /** * ActionAlterCkUser返回参数结构体 */ export interface ActionAlterCkUserResponse { /** * 错误信息注意：此字段可能返回 null，表示取不到有效值。 */ ErrMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 集群内节点的规格磁盘规格描述 */ export interface AttachCBSSpec { /** * 节点磁盘类型，例如“CLOUD_SSD”\"CLOUD_PREMIUM" */ DiskType?: string; /** * 磁盘容量，单位G */ DiskSize?: number; /** * 磁盘总数 */ DiskCount?: number; /** * 描述 */ DiskDesc?: string; } /** * 策略详情 */ export interface ScheduleStrategy { /** * 备份桶名称 */ CosBucketName?: string; /** * 备份保留天数 */ RetainDays?: number; /** * 备份的天 */ WeekDays?: string; /** * 备份小时 */ ExecuteHour?: number; /** * 策略id */ ScheduleId?: number; /** * 下次备份时间 */ NextBackupTime?: string; } /** * DescribeInstanceState返回参数结构体 */ export interface DescribeInstanceStateResponse { /** * 集群状态，例如：Serving */ InstanceState?: string; /** * 集群操作创建时间 */ FlowCreateTime?: string; /** * 集群操作名称 */ FlowName?: string; /** * 集群操作进度 */ FlowProgress?: number; /** * 集群状态描述，例如：运行中 */ InstanceStateDesc?: string; /** * 集群流程错误信息，例如：“创建失败，资源不足” */ FlowMsg?: string; /** * 当前步骤的名称，例如：”购买资源中“ */ ProcessName?: string; /** * 当前步骤的名称，例如：”购买资源中“ */ ProcessSubName?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBackUpTables请求参数结构体 */ export interface DescribeBackUpTablesRequest { /** * 集群id */ InstanceId: string; } /** * DestroyInstance返回参数结构体 */ export interface DestroyInstanceResponse { /** * 作业id */ FlowID?: string; /** * 集群id */ InstanceID?: string; /** * 错误信息 */ ErrorMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResizeDisk返回参数结构体 */ export interface ResizeDiskResponse { /** * 流程ID */ FlowId?: string; /** * 实例ID */ InstanceId?: string; /** * 错误信息 */ ErrorMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBackUpSchedule返回参数结构体 */ export interface DescribeBackUpScheduleResponse { /** * 备份是否开启 */ BackUpOpened?: boolean; /** * 元数据备份策略注意：此字段可能返回 null，表示取不到有效值。 */ MetaStrategy?: ScheduleStrategy; /** * 表数据备份策略注意：此字段可能返回 null，表示取不到有效值。 */ DataStrategy?: ScheduleStrategy; /** * 备份表列表注意：此字段可能返回 null，表示取不到有效值。 */ BackUpContents?: Array<BackupTableContent>; /** * 备份的状态 */ BackUpStatus?: number; /** * 错误信息注意：此字段可能返回 null，表示取不到有效值。 */ ErrorMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ScaleCNOutUpInstance请求参数结构体 */ export interface ScaleCNOutUpInstanceRequest { /** * 实例唯一ID */ InstanceId: string; /** * warehouse名称 */ VirtualCluster: string; /** * 子网id */ UserSubnetID: string; /** * 新的warehouse的个数 */ NewCount: number; /** * 集群的规格2X-Small、X-Small、Small */ NewSpecName: string; } /** * DescribeCkSqlApis返回参数结构体 */ export interface DescribeCkSqlApisResponse { /** * 返回的查询数据，大部分情况是list，也可能是bool */ ReturnData?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBackUpJob请求参数结构体 */ export interface DescribeBackUpJobRequest { /** * 集群id */ InstanceId: string; /** * 分页大小 */ PageSize?: number; /** * 页号 */ PageNum?: number; /** * 开始时间 */ BeginTime?: string; /** * 结束时间 */ EndTime?: string; } /** * ScaleUpInstance返回参数结构体 */ export interface ScaleUpInstanceResponse { /** * 流程ID */ FlowId?: string; /** * 实例ID */ InstanceId?: string; /** * 错误信息 */ ErrorMsg?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUserNewPrivilege返回参数结构体 */ export interface ModifyUserNewPrivilegeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; }