UNPKG

tenyun

Version:

Promise based and chained Tencent Cloud OpenAPI client for NodeJS

2,253 lines (2,088 loc) 72.8 kB
/// <reference types="node" /> import { AxiosPromise, AxiosRequestConfig } from "axios"; /** 集群内节点的规格磁盘规格描述 */ declare interface AttachCBSSpec { /** 节点磁盘类型,例如“CLOUD_SSD”\"CLOUD_PREMIUM" */ DiskType?: string; /** 磁盘容量,单位G */ DiskSize?: number; /** 磁盘总数 */ DiskCount?: number; /** 描述 */ DiskDesc?: string; } /** 备份实例详情 */ declare interface BackUpJobDisplay { /** 备份实例id */ JobId?: number; /** 备份实例名 */ Snapshot?: string; /** 备份数据量 */ BackUpSize?: number; /** 备份单副本数据量 */ BackUpSingleSize?: number; /** 实例创建时间 */ BackUpTime?: string; /** 实例过期时间 */ ExpireTime?: string; /** 实例状态 */ JobStatus?: string; /** 0为默认。1时是对远端的doris进行备份,不周期,一次性 */ BackupType?: number; /** 0为默认。1时是立即备份。2时是迁移 */ BackupTimeType?: number; /** 远端doris的连接信息 */ DorisSourceInfo?: DorisSourceInfo; /** 实例状态对应的数值 */ JobStatusNum?: number; /** 备份实例中关于cos的信息 */ BackupCosInfo?: BackupCosInfo; /** 是否使用的自定义桶 */ IsUserDefineBucket?: boolean; /** 错误原因 */ ErrorReason?: string; /** 快照保留策略 */ SnapshotRemainPolicy?: SnapshotRemainPolicy; } /** 备份实例中关于cos的信息 */ declare interface BackupCosInfo { /** 备份文件所在的cos桶 */ CosBucket?: string; /** 备份文件所在的完整cos路径 */ CosPath?: string; /** 备份文件名称 */ SnapShotPath?: string; /** cos桶所在地域 */ Region?: string; } /** 备份任务的进度详情 */ declare interface BackupStatus { /** 备份任务id */ JobId?: number; /** 快照名称 */ SnapshotName?: string; /** 库名 */ DbName?: string; /** 状态 */ State?: string; /** 备份对象 */ BackupObjects?: string; /** 创建时间 */ CreateTime?: string; /** 快照结束时间 */ SnapshotFinishedTime?: string; /** 上传结束时间 */ UploadFinishedTime?: string; /** 结束时间 */ FinishedTime?: string; /** 未完成任务 */ UnfinishedTasks?: string; /** 进度 */ Progress?: string; /** 错误信息 */ TaskErrMsg?: string; /** 状态 */ Status?: string; /** 超时信息 */ Timeout?: number; /** 备份实例id */ BackupJobId?: number; /** 实例对应Snapshot的id */ TaskId?: number; } /** 备份表信息 */ declare interface BackupTableContent { /** 数据库 */ Database: string; /** 表 */ Table: string; /** 表总字节数 */ TotalBytes: number; /** 表单个副本的大小 */ SingleReplicaBytes?: string; /** 备份状态 */ BackupStatus?: number; /** 备份的错误信息 */ BackupErrorMsg?: string; /** 该库表是否绑定降冷策略 */ IsOpenCoolDown?: boolean; } /** 资源组绑定的用户信息,需要username和host信息进行授权 */ declare interface BindUser { /** 用户名 */ UserName?: string; /** 主机信息 */ Host?: string; } /** 集群计费相关信息 */ declare interface ChargeProperties { /** 计费类型,“PREPAID” 预付费,“POSTPAID_BY_HOUR” 后付费 */ ChargeType?: string; /** 是否自动续费,1表示自动续费开启 */ RenewFlag?: number; /** 计费时间长度 */ TimeSpan?: number; /** 计费时间单位,“m”表示月等 */ TimeUnit?: string; } /** 集群的配置文件的修改历史 */ declare interface ClusterConfigsHistory { /** 计算组id */ ComputeGroupId?: string; /** 配置文件名称 */ FileName?: string; /** 修改后的配置文件内容,base64编码 */ NewConfValue?: string; /** 修改前的配置文件内容,base64编码 */ OldConfValue?: string; /** 修改原因 */ Remark?: string; /** 修改时间 */ ModifyTime?: string; /** 修改子账号id */ UserUin?: string; } /** 用于返回XML格式的配置文件和内容以及其他配置文件有关的信息 */ declare interface ClusterConfigsInfoFromEMR { /** 计算组id */ ComputeGroupId?: string; /** 配置文件名称 */ FileName?: string; /** 配置文件对应的相关属性信息 */ FileConf?: string; /** 配置文件对应的其他属性信息 */ KeyConf?: string; /** 配置文件的内容,base64编码 */ OriParam?: string; /** 用于表示当前配置文件是不是有过修改后没有重启,提醒用户需要重启 */ NeedRestart?: number; /** 配置文件路径 */ FilePath?: string; /** 配置文件kv值 */ FileKeyValues?: string | null; /** 配置文件kv值 */ FileKeyValuesNew?: ConfigKeyValue[]; } /** 返回配置的文件内容(key-value) */ declare interface ConfigKeyValue { /** key */ KeyName?: string; /** 值 */ Value?: string; /** 备注 */ Message?: string; /** 1-只读,2-可修改但不可删除,3-可删除 */ Display?: number; /** 0不支持 1支持热更新 */ SupportHotUpdate?: number; } /** 配置文件修改信息 */ declare interface ConfigSubmitContext { /** 配置文件名称 */ FileName: string; /** 配置文件新内容,base64编码 */ NewConfValue: string; /** 配置文件旧内容,base64编码 */ OldConfValue?: string; /** 文件路径 */ FilePath?: string; } /** 冷热分层backend节点信息 */ declare interface CoolDownBackend { /** 字段:Host */ Host?: string; /** 字段:DataUsedCapacity */ DataUsedCapacity?: string; /** 字段:TotalCapacity */ TotalCapacity?: string; /** 字段:RemoteUsedCapacity */ RemoteUsedCapacity?: string; } /** 冷热分层策略 */ declare interface CoolDownPolicyInfo { /** 策略名称 */ PolicyName?: string; /** cooldown_ttl */ CooldownDatetime?: string; /** cooldown_datetime */ CooldownTtl?: string; } /** 冷热分层Table数据信息 */ declare interface CoolDownTableDataInfo { /** 列:DatabaseName */ DatabaseName?: string; /** 列:TableName */ TableName?: string; /** 列:Size */ Size?: string; /** 列:RemoteSize */ RemoteSize?: string; } /** 客户提供cos认证信息。 */ declare interface CosSourceInfo { /** cos认证中的Id */ SecretId?: string; /** cos认证中的key */ SecretKey?: string; /** cos认证中的路径 */ CosPath?: string; } /** 集群规格 */ declare interface CreateInstanceSpec { /** 规格名字 */ SpecName: string; /** 数量 */ Count: number; /** 云盘大小 */ DiskSize: number; } /** 数据库审计 */ declare interface DataBaseAuditRecord { /** 查询用户 */ OsUser?: string; /** 查询ID */ InitialQueryId?: string; /** SQL语句 */ Sql?: string; /** 开始时间 */ QueryStartTime?: string; /** 执行耗时 */ DurationMs?: number; /** 读取行数 */ ReadRows?: number; /** 读取字节数 */ ResultRows?: number; /** 结果字节数 */ ResultBytes?: number; /** 内存 */ MemoryUsage?: number; /** 初始查询IP */ InitialAddress?: string; /** 数据库 */ DbName?: string; /** sql类型 */ SqlType?: string; /** catalog名称 */ Catalog?: string; /** 状态 */ State?: string; /** 是否是查询 */ IsQuery?: boolean; /** 计算组 */ ComputeGroup?: string; } /** 磁盘规格描述 */ declare interface DiskSpec { /** 磁盘类型,例如“CLOUD_SSD", "LOCAL_SSD"等 */ DiskType: string; /** 磁盘类型说明,例如"云SSD", "本地SSD"等 */ DiskDesc: string; /** 磁盘最小规格大小,单位G */ MinDiskSize: number; /** 磁盘最大规格大小,单位G */ MaxDiskSize: number; /** 磁盘数目 */ DiskCount: number; } /** 外部doris集群的连接信息 */ declare interface DorisSourceInfo { /** doris集群的fe的ip */ Host?: string; /** doris集群的fe的端口号 */ Port?: number; /** doris集群的账号 */ User?: string; /** base64编码的doris集群对应用户的密码 */ Password?: string; } /** 前端规则描述 */ declare interface FrontEndRule { /** id序列 */ ID?: number; /** 规则名称 */ Name?: string; /** 详细规则 */ Rule?: string; } /** KV配置 */ declare interface InstanceConfigItem { /** key */ ConfKey: string; /** value */ ConfValue: string; } /** Instance表detail字段 */ declare interface InstanceDetail { /** 告警策略是否可用 */ EnableAlarmStrategy?: boolean; } /** 实例描述信息 */ declare 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节点描述信息 */ CoreSummary?: NodesSummary; /** 高可用,"true" "false" */ HA?: string; /** 高可用类型:0:非高可用1:读高可用2:读写高可用。 */ HaType?: number; /** 访问地址,例如 "10.0.0.1:9000" */ AccessInfo?: string; /** 记录ID,数值型 */ Id?: number; /** regionId, 表示地域 */ RegionId?: number; /** 可用区说明,例如 "广州二区" */ ZoneDesc?: string; /** 错误流程说明信息 */ FlowMsg?: string; /** 状态描述,例如“运行中”等 */ StatusDesc?: string; /** 自动续费标记 */ RenewFlag?: boolean; /** 标签列表 */ Tags?: 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; /** cos桶 */ CosBucketName?: string; /** cbs */ CanAttachCbs?: boolean; /** 小版本 */ BuildVersion?: string; /** 组件信息注:这里返回类型实际为map[string]struct类型,并非显示的string类型,可以参考“示例值”进行数据的解析。 */ Components?: string; /** 判断审计日志表是否有catalog字段 */ IfExistCatalog?: number | null; /** 页面特性,用于前端屏蔽一些页面入口 */ Characteristic?: string[]; /** 超时时间 单位s */ RestartTimeout?: string; /** 内核优雅重启超时时间,如果为-1说明未设置 */ GraceShutdownWaitSeconds?: string; /** 表名大小写是否敏感,0:敏感;1:不敏感,以小写进行比较;2:不敏感,表名改为以小写存储 */ CaseSensitive?: number; /** 用户是否可以绑定安全组 */ IsWhiteSGs?: boolean; /** 已绑定的安全组信息 */ BindSGs?: string[]; /** 是否为多可用区 */ EnableMultiZones?: boolean; /** 用户可用区和子网信息 */ UserNetworkInfos?: string; /** 是否启用冷热分层。0:未开启 1:已开启 */ EnableCoolDown?: number; /** 冷热分层使用COS桶 */ CoolDownBucket?: string; /** 实例扩展信息 */ Details?: InstanceDetail; /** 是否启用DLC 0:关闭 1:开启 */ EnableDlc?: number; /** 账户类型 0:普通用户 1:CAM用户 */ AccountType?: number; /** 监控模式 0: 老监控 1:新监控 */ MonitorMode?: number; /** cn节点信息 */ CNSummary?: NodesSummary; /** 计算组个数 */ ComputeGroupCount?: number; /** 存算分离cos存储数据 */ CosStorageSize?: number; /** 存算分离的指标 当是true 不支持新建计算组 */ IsMasterNonVM?: boolean; } /** 实例节点描述信息 */ declare interface InstanceNode { /** IP地址 */ Ip?: string; /** 机型,如 S1 */ Spec?: string; /** cpu核数 */ Core?: number; /** 内存大小 */ Memory?: number; /** 磁盘类型 */ DiskType?: string; /** 磁盘大小 */ DiskSize?: number; /** 所属clickhouse cluster名称 */ Role?: string; /** 状态 */ Status?: string; /** rip */ Rip?: string; /** FE节点角色 */ FeRole?: string; /** UUID */ UUID?: string; /** 可用区 */ Zone?: string; /** 虚拟可用区 */ VirtualZone?: string; /** 创建时间 */ CreateTime?: string; /** 计算组ID */ ComputeGroupId?: string; } /** 集群操作描述 */ declare interface InstanceOperation { /** 操作名称,例如“create_instance"、“scaleout_instance”等 */ Name?: string; /** 操作结果,“Success"表示成功,”Fail"表示失败 */ Result?: string; /** 操作名称描述,例如“创建”,“修改集群名称”等 */ Desc?: string; /** 操作级别,例如“Critical", "Normal"等 */ Level?: string; /** 操作级别描述,例如“高危”,“一般”等 */ LevelDesc?: string; /** 操作开始时间 */ StartTime?: string; /** 操作结束时间 */ EndTime?: string; /** 操作结果描述,例如“成功”,“失败” */ ResultDesc?: string; /** 操作用户ID */ OperateUin?: string; /** 操作对应的jobid */ JobId?: number; /** 操作明细 */ OperationDetail?: string; /** 计算组id */ ComputerGroupId?: string; } /** 网络信息 */ declare interface NetworkInfo { /** 可用区 */ Zone?: string; /** 子网id */ SubnetId?: string; /** 当前子网可用ip数 */ SubnetIpNum?: number; } /** NodeInfo */ declare interface NodeInfo { /** 用户IP */ Ip?: string; /** 节点状态 */ Status?: number; /** 节点角色名 */ NodeName?: string; /** 组件名 */ ComponentName?: string; /** 节点角色 */ NodeRole?: string; /** 节点上次重启的时间 */ LastRestartTime?: string; /** 节点所在可用区 */ Zone?: string; /** Id */ Id?: string; /** RIP */ RIp?: string; /** 计算组ID */ ComputeGroupId?: string; /** 创建时间 */ CreateTime?: string; /** 虚拟可用区 */ VirtualZone?: string; } /** 节点信息列表 */ declare interface NodeInfos { /** 节点名称 */ NodeName?: string; /** 节点状态 */ Status?: number; /** 节点ip */ Ip?: string; /** 节点角色 */ NodeRole?: string; /** 组件名 */ ComponentName?: string; /** 上一次重启时间 */ LastRestartTime?: string; /** id */ Id?: string; /** 可用区 */ Zone?: string; /** 创建时间 */ CreateTime?: string; /** 计算组id */ ComputeGroupId?: string; /** rip */ RIp?: string; /** 虚拟可用区 */ VirtualZone?: string; } /** 节点角色描述信息 */ declare 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; /** 是否加密 */ Encrypt?: number; /** 最大磁盘 */ MaxDiskSize?: number; } /** 可用区的地域大类描述 */ declare interface RegionAreaInfo { /** 大类地域信息,如"south_china", "east_china"等 */ Name: string; /** 对应Name的描述,例如“华南地区”,“华东地区”等 */ Desc: string; /** 具体地域列表1 */ Regions: RegionInfo[]; } /** 地域描述信息 */ declare interface RegionInfo { /** 地域名称,例如“ap-guangzhou" */ Name?: string; /** 地域描述,例如"广州” */ Desc?: string; /** 地域唯一标记 */ RegionId?: number; /** 地域下所有可用区列表 */ Zones?: ZoneInfo[]; /** 该地域下集群数目 */ Count?: number; /** 0代表是国际站 1代表不是 */ IsInternationalSite?: number; /** 桶 */ Bucket?: string; /** 存算分离集群数 */ SSCCount?: number; /** 是否开通存算分离 */ EnableSSC?: boolean; } /** 资源规格描述信息 */ declare 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; /** cvm库存 */ InstanceQuota?: number; } /** 恢复任务信息 */ declare interface RestoreStatus { /** 恢复任务id */ JobId?: number; /** 恢复任务标签 */ Label?: string; /** 恢复任务时间戳 */ Timestamp?: string; /** 恢复任务所在库 */ DbName?: string; /** 恢复任务状态 */ State?: string; /** 恢复时是否允许导入 */ AllowLoad?: boolean; /** 副本数 */ ReplicationNum?: string; /** 副本数 */ ReplicaAllocation?: string; /** 恢复对象 */ RestoreObjects?: string; /** 创建时间 */ CreateTime?: string; /** 元数据准备时间 */ MetaPreparedTime?: string; /** 快照结束时间 */ SnapshotFinishedTime?: string; /** 下载结束时间 */ DownloadFinishedTime?: string; /** 结束时间 */ FinishedTime?: string; /** 未完成任务 */ UnfinishedTasks?: string; /** 进度 */ Progress?: string; /** 错误信息 */ TaskErrMsg?: string; /** 状态 */ Status?: string; /** 作业超时时间 */ Timeout?: number; /** 是否保持源表中的副本数 */ ReserveReplica?: boolean; /** 是否保持源表中的动态分区 */ ReserveDynamicPartitionEnable?: boolean; /** 备份实例id */ BackupJobId?: number; /** 实例对应snapshot的id */ TaskId?: number; /** 恢复任务id */ ID?: number; } /** 调度信息 */ declare interface ScheduleInfo { /** 生效周期 */ EffectivePeriod?: string; /** 调度类型,不传该参数时为立即执行:Day-天Week-周Month-月Quarter-季度Year-年Once-单次 */ ScheduleType?: string; /** 执行调度的日期。调度类型为周和月时以英文逗号分隔;调度类型为单次时,该值是个日期 */ ScheduleData?: string; /** 执行时间:时 */ ScheduleHour?: number; /** 执行时间:分 */ ScheduleMin?: number; /** 备份粒度:All-全量Database-按库Table-按表 */ BackupScope?: string; /** 备份库:如果是按库备份,则需要该字段,库之间用英文逗号分割 */ BackupDatabase?: string; } /** 列表页搜索的标记列表 */ declare interface SearchTags { /** 标签的键 */ TagKey?: string; /** 标签的值 */ TagValue?: string; /** 1表示只输入标签的键,没有输入值;非1则表示输入键时且输入值 */ AllValue?: number; } /** 慢查询记录 */ declare interface SlowQueryRecord { /** 查询用户 */ OsUser?: string; /** 查询ID */ InitialQueryId?: string; /** SQL语句 */ Sql?: string; /** 开始时间 */ QueryStartTime?: string; /** 执行耗时 */ DurationMs?: number; /** 读取行数 */ ReadRows?: number; /** 读取字节数 */ ResultRows?: number; /** 结果字节数 */ ResultBytes?: number; /** 内存 */ MemoryUsage?: number; /** 初始查询IP */ InitialAddress?: string; /** 数据库名 */ DbName?: string; /** 是否是查询,0:否,1:查询语句 */ IsQuery?: number; /** ResultBytes的MB格式 */ ResultBytesMB?: number; /** MemoryUsage的MB表示 */ MemoryUsageMB?: number; /** DurationMs的秒表示 */ DurationSec?: number; /** 状态 */ State?: string; /** Catalog Name */ CatalogName?: string; /** cpu执行时间 */ CpuTimeMs?: number; /** 计算组 */ ComputeGroup?: string; } /** 备份快照保留策略 */ declare interface SnapshotRemainPolicy { /** 0-不主动删除;1-超过指定时间周期自动删除;2-保留指定数据快照 */ Type?: number; /** 保留快照的时间 */ RemainDays?: number; /** 保留最新快照的数量 */ RemainLatestNum?: number; } /** 标签描述 */ declare interface Tag { /** 标签的键 */ TagKey: string; /** 标签的值 */ TagValue: string; } /** 更新用户权限结构体 */ declare interface UpdateUserPrivileges { /** 是否设置catalog权限 */ IsSetGlobalCatalog?: boolean; } /** 新增或是修改用户 */ declare interface UserInfo { /** 集群实例id */ InstanceId: string; /** 用户名 */ UserName: string; /** 密码 */ PassWord: string; /** 用户链接来自的 IP */ WhiteHost?: string; /** 修改前用户链接来自的 IP */ OldWhiteHost?: string; /** 描述 */ Describe?: string; /** 旧密码 */ OldPwd?: string; /** 绑定的子用户uin */ CamUin?: string; /** ranger group id列表 */ CamRangerGroupIds?: number[]; /** 0: 灵活场景 1: 固定场景 */ ComputeGroupType?: number; } /** 用户绑定资源组信息 */ declare interface UserWorkloadGroup { /** test */ UserName?: string; /** normal */ WorkloadGroupName?: string; } /** 资源组相关配置 */ declare interface WorkloadGroupConfig { /** 资源组名称 */ WorkloadGroupName?: string; /** CPU权重 */ CpuShare?: number; /** 内存限制,所有资源组的内存限制值之和应该小于等于100 */ MemoryLimit?: number; /** 是否允许超配分配 */ EnableMemoryOverCommit?: boolean; /** cpu硬限制 */ CpuHardLimit?: string; } /** 可用区描述信息 */ declare interface ZoneInfo { /** 可用区名称,例如"ap-guangzhou-1" */ Name?: string; /** 可用区描述信息,例如“广州一区” */ Desc?: string; /** 可用区唯一标记 */ ZoneId?: number; /** Encrypted */ Encrypt?: number; /** 是否为主力园区 */ Main?: boolean; /** 0表示未开通容器化,1表示已开通容器化 */ ContainerEnabled?: number; } declare interface ActionAlterUserRequest { /** 用户信息 */ UserInfo: UserInfo; /** api接口类型 */ ApiType: string; /** 用户权限类型 0:普通用户 1:管理员 */ UserPrivilege?: number; /** 计算组列表 */ ComputeGroups?: string[]; /** 集群ID */ InstanceId?: string; } declare interface ActionAlterUserResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CancelBackupJobRequest { /** 集群id */ InstanceId: string; /** 需要取消的备份实例id */ BackUpJobId?: number; } declare interface CancelBackupJobResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CheckCoolDownWorkingVariableConfigCorrectRequest { /** 集群id */ InstanceId?: string; } declare interface CheckCoolDownWorkingVariableConfigCorrectResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateBackUpScheduleRequest { /** 集群id */ InstanceId: string; /** 操作类型 create(创建) update(编辑修改) */ OperationType: string; /** 编辑时需要传 */ ScheduleId?: number; /** 选择的星期 逗号分隔废弃:使用ScheduleInfo */ WeekDays?: string; /** 执行小时废弃:使用ScheduleInfo */ ExecuteHour?: number; /** 备份表列表 */ BackUpTables?: BackupTableContent[]; /** 0为默认。1时是对远端的doris进行备份,不周期,一次性 */ BackupType?: number; /** 远端doris集群的连接信息 */ DorisSourceInfo?: DorisSourceInfo; /** 0为周期备份。1时是立即备份。3时是定时备份。 */ BackupTimeType?: number; /** 0为默认。1时是备份完成后立即恢复 */ RestoreType?: number; /** 0为默认。1时是提供自定义的secret连接cos */ AuthType?: number; /** cos认证的信息 */ CosSourceInfo?: CosSourceInfo; /** 调度任务名 */ ScheduleName?: string; /** 调度信息 */ ScheduleInfo?: ScheduleInfo; /** 更新任务状态:3-暂停,2-删除,1-启动 */ UpdateStatus?: number; /** 当前任务的cos桶信息 */ CosBucket?: string; /** 快照保留策略 */ SnapshotRemainPolicy?: SnapshotRemainPolicy; /** 备份数据所在地域,当前地域应该为空 */ DataRemoteRegion?: string; } declare interface CreateBackUpScheduleResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateCoolDownPolicyRequest { /** 集群id */ InstanceId?: string; /** 策略名称 */ PolicyName?: string; /** cooldown_ttl */ CoolDownTtl?: string; /** cooldown_datetime */ CoolDownDatetime?: string; } declare interface CreateCoolDownPolicyResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateInstanceNewRequest { /** 可用区 */ Zone: string; /** FE规格 */ FeSpec: CreateInstanceSpec; /** BE规格 */ BeSpec: CreateInstanceSpec; /** 是否高可用 */ HaFlag: boolean; /** 用户VPCID */ UserVPCId: string; /** 用户子网ID */ UserSubnetId: string; /** 产品版本号 */ ProductVersion: string; /** 付费类型 */ ChargeProperties: ChargeProperties; /** 实例名字 */ InstanceName: string; /** 数据库密码 */ DorisUserPwd: string; /** 标签列表 */ Tags?: Tag[]; /** 高可用类型:0:非高可用(只有1个FE,FeSpec.CreateInstanceSpec.Count=1),1:读高可用(至少需部署3个FE,FeSpec.CreateInstanceSpec.Count>=3,且为奇数),2:读写高可用(至少需部署5个FE,FeSpec.CreateInstanceSpec.Count>=5,且为奇数)。 */ HaType?: number; /** 表名大小写是否敏感,0:敏感;1:不敏感,以小写进行比较;2:不敏感,表名改为以小写存储 */ CaseSensitive?: number; /** 是否开启多可用区 */ EnableMultiZones?: boolean; /** 开启多可用区后,用户的所有可用区和子网信息 */ UserMultiZoneInfos?: NetworkInfo; /** 开启多可用区后,用户的所有可用区和子网信息 */ UserMultiZoneInfoArr?: NetworkInfo[]; /** 是否存算分离 */ IsSSC?: boolean; /** CU数 */ SSCCU?: number; /** 缓存盘大小 */ CacheDiskSize?: string; /** 缓存盘大小 */ CacheDataDiskSize?: number; } declare interface CreateInstanceNewResponse { /** 流程ID */ FlowId?: string; /** 实例ID */ InstanceId?: string; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateWorkloadGroupRequest { /** 集群id */ InstanceId: string; /** 资源组配置 */ WorkloadGroup?: WorkloadGroupConfig; } declare interface CreateWorkloadGroupResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteBackUpDataRequest { /** 集群id */ InstanceId: string; /** 任务id */ BackUpJobId?: number; /** 是否删除所有实例 */ IsDeleteAll?: boolean; } declare interface DeleteBackUpDataResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteWorkloadGroupRequest { /** 集群id */ InstanceId: string; /** 需要删除的资源组名称 */ WorkloadGroupName?: string; } declare interface DeleteWorkloadGroupResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeAreaRegionRequest { /** 是否是国际站 */ IsInternationalSite?: boolean; } declare interface DescribeAreaRegionResponse { /** 地域列表 */ Items?: RegionAreaInfo[]; /** 前端规则描述 */ FrontEndRules?: FrontEndRule[]; /** 返回可用的白名单名称 */ AvailableWhiteListNames?: string[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBackUpJobDetailRequest { /** 集群id */ InstanceId: string; /** 任务id */ BackUpJobId: number; } declare interface DescribeBackUpJobDetailResponse { /** 备份表详情 */ TableContents?: BackupTableContent[]; /** 错误信息 */ ErrorMsg?: string; /** 是否是未知版本 */ IsUnknownVersion?: boolean; /** 返回对象用字符串表示 */ Msg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBackUpJobRequest { /** 集群id */ InstanceId: string; /** 任务类型:0-不限制,或使用TypeFilters过滤;1-备份恢复(包括周期备份和一次性备份);2-数据迁移(包括跨集群迁移和cos迁移) */ ApplicationType?: number; /** 分页大小 */ PageSize?: number; /** 页号 */ PageNum?: number; /** 开始时间 */ BeginTime?: string; /** 结束时间 */ EndTime?: string; /** jobid的string类型 */ JobIdFiltersStr?: string; } declare interface DescribeBackUpJobResponse { /** 任务列表 */ BackUpJobs?: BackUpJobDisplay[]; /** 错误信息 */ ErrorMsg?: string; /** 总数 */ TotalCount?: number; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBackUpSchedulesRequest { /** 任务类型0-不限制,或使用TypeFilters过滤;1-备份恢复(包括周期备份和一次性备份);2-数据迁移(包括跨集群迁移和cos迁移) */ ApplicationType?: number; } declare interface DescribeBackUpSchedulesResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBackUpTablesRequest { /** 集群id */ InstanceId: string; /** 0为默认。1时是对远端的doris进行备份,不周期,一次性。2时为cos恢复,一次性 */ BackupType?: number; /** 远端doris集群的连接信息 */ DorisSourceInfo?: DorisSourceInfo; /** cos信息 */ CosSourceInfo?: CosSourceInfo; } declare interface DescribeBackUpTablesResponse { /** 可备份表列表 */ AvailableTables?: BackupTableContent[]; /** msg */ Msg?: string; /** 未知version */ IsUnknownVersion?: boolean; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBackUpTaskDetailRequest { /** 集群id */ InstanceId: string; /** 任务id */ BackUpJobId: number; } declare interface DescribeBackUpTaskDetailResponse { /** 备份任务进度详情 */ BackupStatus?: BackupStatus[]; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeClusterConfigsHistoryRequest { /** 集群id名称 */ InstanceId: string; /** 分页参数,第一页为0,第二页为10 */ Offset: number; /** 分页参数,分页步长,默认为10 */ Limit: number; /** 配置修改历史的时间范围开始 */ StartTime: string; /** 配置修改历史的时间范围结束 */ EndTime: string; /** 需要查询的配置文件名称数组,如果为空则查询全部历史记录。目前支持的配置文件名称有:apache_hdfs_broker.conf、be.conf、fe.conf、core-site.xml、hdfs-site.xml、odbcinst.ini */ ConfigFileNames?: string[]; /** 需要查询的计算组列表 */ ComputeGroupIds?: string[]; } declare interface DescribeClusterConfigsHistoryResponse { /** 实例总数 */ TotalCount?: number; /** 配置文件修改历史 */ ClusterConfHistory?: ClusterConfigsHistory[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeClusterConfigsRequest { /** 集群实例ID */ InstanceId: string; /** 0 公有云查询;1青鹅查询,青鹅查询显示所有需要展示的 */ ConfigType?: number; /** 模糊搜索关键字文件 */ FileName?: string; /** 0集群维度 1节点维度 2启动脚本 3计算组维度 */ ClusterConfigType?: number; /** eth0的ip地址 */ IPAddress?: string; /** 计算组id */ ComputeGroupId?: string; } declare interface DescribeClusterConfigsResponse { /** 返回实例的配置文件相关的信息 */ ClusterConfList?: ClusterConfigsInfoFromEMR[]; /** 返回当前内核版本 如果不存在则返回空字符串 */ BuildVersion?: string; /** 错误信息 */ ErrorMsg?: string; /** 是否包含CN节点 */ HasCN?: boolean; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCoolDownBackendsRequest { /** 集群id */ InstanceId?: string; } declare interface DescribeCoolDownBackendsResponse { /** 错误信息 */ ErrorMsg?: string; /** 节点信息列表 */ List?: CoolDownBackend[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCoolDownPoliciesRequest { /** 集群id */ InstanceId?: string; } declare interface DescribeCoolDownPoliciesResponse { /** 错误信息 */ ErrorMsg?: string; /** 冷热分层策略列表 */ List?: CoolDownPolicyInfo[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCoolDownTableDataRequest { /** 集群id */ InstanceId?: string; /** 数据库名称 */ DatabaseName?: string; } declare interface DescribeCoolDownTableDataResponse { /** 错误信息 */ ErrorMsg?: string; /** 冷热分层Table数据列表 */ List?: CoolDownTableDataInfo[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeDatabaseAuditDownloadRequest { /** 实例ID */ InstanceId: string; /** 开始时间 */ StartTime: string; /** 结束时间 */ EndTime: string; /** 分页 */ PageSize: number; /** 分页 */ PageNum: number; /** 排序参数 */ OrderType?: string; /** 用户 */ User?: string; /** 数据库 */ DbName?: string; /** sql类型 */ SqlType?: string; /** sql语句 */ Sql?: string; /** 用户 多选 */ Users?: string[]; /** 数据库 多选 */ DbNames?: string[]; /** sql类型 多选 */ SqlTypes?: string[]; /** catalog名称 (多选) */ Catalogs?: string[]; /** 是否是查询 */ IsQuery?: boolean[]; /** 计算组列表 */ ComputeGroups?: string[]; } declare interface DescribeDatabaseAuditDownloadResponse { /** 日志的cos地址 */ CosUrl?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeDatabaseAuditRecordsRequest { /** 实例ID */ InstanceId: string; /** 开始时间 */ StartTime: string; /** 结束时间 */ EndTime: string; /** 分页 */ PageSize: number; /** 分页 */ PageNum: number; /** 排序参数 */ OrderType?: string; /** 用户 */ User?: string; /** 数据库 */ DbName?: string; /** sql类型 */ SqlType?: string; /** sql语句 */ Sql?: string; /** 用户 (多选) */ Users?: string[]; /** 数据库 (多选) */ DbNames?: string[]; /** sql类型 (多选) */ SqlTypes?: string[]; /** catalog名称(多选) */ Catalogs?: string[]; /** 是否是查询 */ IsQuery?: boolean[]; /** 计算组列表 */ ComputeGroups?: string[]; } declare interface DescribeDatabaseAuditRecordsResponse { /** 总数 */ TotalCount?: number; /** 记录列表 */ SlowQueryRecords?: DataBaseAuditRecord; /** 记录列表 */ Records?: DataBaseAuditRecord[]; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeInstanceNodesInfoRequest { /** 集群id */ InstanceID: string; } declare interface DescribeInstanceNodesInfoResponse { /** Be节点 */ BeNodes?: string[]; /** Fe节点 */ FeNodes?: string[]; /** Fe master节点 */ FeMaster?: string; /** Be节点信息 */ BeNodeInfos?: NodeInfo[]; /** Fe节点信息 */ FeNodeInfos?: NodeInfo[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeInstanceNodesRequest { /** 集群实例ID */ InstanceId: string; /** 集群角色类型,默认为 "data"数据节点 */ NodeRole?: string; /** 分页参数,第一页为0,第二页为10 */ Offset?: number; /** 分页参数,分页步长,默认为10 */ Limit?: number; /** 展现策略,All时显示所有 */ DisplayPolicy?: string; } declare interface DescribeInstanceNodesResponse { /** 总数 */ TotalCount?: number; /** 实例节点总数 */ InstanceNodesList?: InstanceNode[]; /** 节点类型 */ NodeRoles?: string[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeInstanceNodesRoleRequest { /** 实例id */ InstanceId: string; /** 过滤ip */ IpFilter?: string; } declare interface DescribeInstanceNodesRoleResponse { /** 错误码 */ ErrorMsg?: string; /** 节点总数 */ TotalCount?: number; /** 无 */ NodeInfos?: NodeInfos[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeInstanceOperationsRequest { /** 集群ID */ InstanceId: string; /** 分页参数,偏移量,从0开始 */ Offset?: number; /** 分页参数,每页数目,默认为10 */ Limit?: number; /** 开始时间 */ StartTime?: string; /** 结束时间 */ EndTime?: string; /** 计算组ID */ ComputeGroupId?: string; } declare interface DescribeInstanceOperationsResponse { /** 操作记录总数 */ TotalCount?: number; /** 操作记录具体数据 */ Operations?: InstanceOperation[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeInstanceRequest { /** 集群实例ID */ InstanceId: string; } declare interface DescribeInstanceResponse { /** 实例描述信息 */ InstanceInfo?: InstanceInfo; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeInstanceStateRequest { /** 集群实例名称 */ InstanceId: string; } declare interface DescribeInstanceStateResponse { /** 集群状态,例如:Serving */ InstanceState?: string; /** 集群操作创建时间 */ FlowCreateTime?: string; /** 集群操作名称 */ FlowName?: string; /** 集群操作进度 */ FlowProgress?: number; /** 集群状态描述,例如:运行中 */ InstanceStateDesc?: string; /** 集群流程错误信息,例如:“创建失败,资源不足” */ FlowMsg?: string; /** 流程ProcessId */ ProcessId?: string; /** Job名称 */ JobName?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeInstanceUsedSubnetsRequest { /** 集群id */ InstanceId: string; } declare interface DescribeInstanceUsedSubnetsResponse { /** 集群使用的vpc信息 */ VpcId?: string; /** 集群使用的subnet信息 */ UsedSubnets?: string[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeInstancesHealthStateRequest { /** 集群Id */ InstanceID?: string; /** 为空:代表当前appId下所有集群 或者 某个集群Id */ Input?: string; } declare interface DescribeInstancesHealthStateResponse { /** base64编码后的数据,包含了集群的健康信息 */ Data?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeInstancesRequest { /** 搜索的集群id名称 */ SearchInstanceId?: string; /** 搜索的集群name */ SearchInstanceName?: string; /** 分页参数,第一页为0,第二页为10 */ Offset?: number; /** 分页参数,分页步长,默认为10 */ Limit?: number; /** 搜索标签列表,没匹配到则不过滤集群列表 */ SearchTags?: SearchTags[]; /** 0 : 存算一体,1:存算分离,2:ALL */ InstanceType?: number; } declare interface DescribeInstancesResponse { /** 实例总数 */ TotalCount?: number; /** 实例数组 */ InstancesList?: InstanceInfo[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeRestoreTaskDetailRequest { /** 集群id */ InstanceId: string; /** 任务id */ BackUpJobId: number; } declare interface DescribeRestoreTaskDetailResponse { /** 恢复任务进度详情 */ RestoreStatus?: RestoreStatus[]; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeSlowQueryRecordsDownloadRequest { /** 实例ID */ InstanceId: string; /** 慢查询时间 */ QueryDurationMs: number; /** 开始时间 */ StartTime: string; /** 结束时间 */ EndTime: string; /** 排序参数 */ DurationMs?: string; /** 查询sql */ Sql?: string; /** 排序参数 */ ReadRows?: string; /** 排序参数 */ ResultBytes?: string; /** 排序参数 */ MemoryUsage?: string; /** IsQuery条件 */ IsQuery?: number; /** 数据库名称 */ DbName?: string[]; /** catalog名称 */ CatalogName?: string[]; /** 排序字段 */ SortField?: string; /** 排序方式 */ SortOrder?: string; /** user */ UserName?: string; /** 计算组列表 */ ComputeGroups?: string[]; } declare interface DescribeSlowQueryRecordsDownloadResponse { /** cos地址 */ CosUrl?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeSlowQueryRecordsRequest { /** 实例ID */ InstanceId: string; /** 慢查询时间 */ QueryDurationMs: number; /** 开始时间 */ StartTime: string; /** 结束时间 */ EndTime: string; /** 分页 */ PageSize: number; /** 分页 */ PageNum: number; /** 排序参数 */ DurationMs?: string; /** 数据库名称 */ DbName?: string[]; /** 是否是查询,0:否, 1:是 */ IsQuery?: number; /** catalog名称 */ CatalogName?: string[]; /** sql名 */ Sql?: string; /** ReadRows排序字段 */ ReadRows?: string; /** ResultBytes排序字段 */ ResultBytes?: string; /** MemoryUsage排序字段 */ MemoryUsage?: string; /** 排序字段 */ SortField?: string; /** 排序方式 */ SortOrder?: string; /** user */ UserName?: string; /** 计算组列表 */ ComputeGroups?: string[]; } declare interface DescribeSlowQueryRecordsResponse { /** 总数 */ TotalCount?: number; /** 记录列表 */ SlowQueryRecords?: SlowQueryRecord[]; /** 所有数据库名 */ DBNameList?: string[]; /** 所有catalog名 */ CatalogNameList?: string[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeSpecRequest { /** 地域信息,例如"ap-guangzhou-1" */ Zone: string; /** 计费类型,PREPAID 包年包月,POSTPAID_BY_HOUR 按量计费 */ PayMode?: string; /** 多可用区 */ Zones?: string[]; /** 机型名称 */ SpecName?: string; /** 是否存算分离 */ IsSSC?: boolean; } declare interface DescribeSpecResponse { /** fe节点规格描述 */ MasterSpec?: ResourceSpec[]; /** be节点规格描述 */ CoreSpec?: ResourceSpec[]; /** 云盘列表 */ AttachCBSSpec?: DiskSpec[]; /** cn节点列表 */ CNSpec?: ResourceSpec[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeSqlApisRequest { /** 实例id */ InstanceId: string; /** GetUsers:获取用户列表;GetDatabases:获取数据库列表;GetTables:获取数据库表列表;GetUserPrivilegesV2:获取用户下的权限,粒度到表级别;DeleteUser:删除用户;GetCatalog:获取Catalog列表; */ ApiType: string; /** 用户名称 */ UserName?: string; /** 用户链接来自的 IP */ WhiteHost?: string; /** catalog名称 */ Catalog?: string; /** catalog集合 */ Catalogs?: string[]; /** 数据库名 */ DatabaseName?: string; /** 表名 */ TableName?: string; /** 用户名列表 */ UserNames?: string[]; } declare interface DescribeSqlApisResponse { /** 返回的查询数据,大部分情况是list,也可能是bool */ ReturnData?: string; /** 错误消息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeTableListRequest { /** 资源ID,建表所用的TCHouse-D资源ID。 */ InstanceId: string; /** 需要获取表列表的库 */ DbName: string; /** 使用该用户进行操作,该用户需要有对应的权限。如果该TCHouse-D集群使用CAM用户注册内核账户,则不需要填写 */ UserName?: string; /** 用户对应的密码。如果该TCHouse-D集群使用CAM用户注册内核账户,则不需要填写 */ PassWord?: string; /** 查询库所在的数据源,不填则默认为内部数据源(internal)。 */ CatalogName?: string; } declare interface DescribeTableListResponse { /** 表名列表 */ TableNames?: string[]; /** 错误信息 */ Message?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeUserBindWorkloadGroupRequest { /** 集群id */ InstanceId?: string; } declare interface DescribeUserBindWorkloadGroupResponse { /** 用户绑定资源组信息 */ UserBindInfos?: UserWorkloadGroup[]; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeWorkloadGroupRequest { /** 集群id */ InstanceId: string; } declare interface DescribeWorkloadGroupResponse { /** 资源组信息 */ WorkloadGroups?: WorkloadGroupConfig[]; /** 是否开启资源组:开启-open、关闭-close */ Status?: string; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DestroyInstanceRequest { /** 集群ID */ InstanceId: string; } declare interface DestroyInstanceResponse { /** 流程ID */ FlowId?: string; /** 集群ID */ InstanceId?: string; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyClusterConfigsRequest { /** 集群ID,例如cdwch-xxxx */ InstanceId: string; /** 配置文件修改信息 */ ModifyConfContext: ConfigSubmitContext[]; /** 修改原因 */ Remark?: string; } declare interface ModifyClusterConfigsResponse { /** 流程相关信息 */ FlowId?: number; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyCoolDownPolicyRequest { /** 集群id */ InstanceId?: string; /** 策略名称 */ PolicyName?: string; /** cooldown_ttl */ CoolDownTtl?: string; /** cooldown_datetime */ CoolDownDatetime?: string; } declare interface ModifyCoolDownPolicyResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyInstanceKeyValConfigsRequest { /** 实例ID */ InstanceId: string; /** 文件名称 */ FileName: string; /** 新增配置列表 */ AddItems?: InstanceConfigItem[]; /** 更新配置列表 */ UpdateItems?: InstanceConfigItem[]; /** 删除配置列表 */ DelItems?: InstanceConfigItem[]; /** 备注(50字以内) */ Message?: string; /** 热更新列表 */ HotUpdateItems?: InstanceConfigItem[]; /** 删除配置列表 */ DeleteItems?: InstanceConfigItem; /** ip地址 */ IPAddress?: string; } declare interface ModifyInstanceKeyValConfigsResponse { /** 错误信息 */ ErrorMsg?: string; /** ID */ FlowId?: number; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyInstanceRequest { /** 实例Id */ InstanceId: string; /** 新修改的实例名称 */ InstanceName: string; } declare interface ModifyInstanceResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyNodeStatusRequest { /** 集群ID,例如cdwch-xxxx */ InstanceId: string; /** 节点信息 */ NodeInfos: NodeInfos[]; /** 节点操作 */ OperationCode: string; /** 超时时间(秒) */ RestartTimeOut?: string; } declare interface ModifyNodeStatusResponse { /** 流程相关信息 */ FlowId?: number; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifySecurityGroupsRequest { /** 集群id */ InstanceId: string; /** 修改前的安全组信息 */ OldSecurityGroupIds?: string[]; /** 修改后的安全组信息 */ ModifySecurityGroupIds?: string[]; } declare interface ModifySecurityGroupsResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyUserBindWorkloadGroupRequest { /** 集群id */ InstanceId: string; /** 需要绑定资源组的用户信息,如果一个账户拥有多个主机信息,需要将这些信息都传入 */ BindUsers?: BindUser[]; /** 修改前绑定的资源组名称 */ OldWorkloadGroupName?: string; /** 修改后绑定的资源组名称 */ NewWorkloadGroupName?: string; } declare interface ModifyUserBindWorkloadGroupResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyUserPrivilegesV3Request { /** 集群id */ InstanceId: string; /** 用户名 */ UserName: string; /** 用户权限 */ UserPrivileges: UpdateUserPrivileges; /** 用户链接来自的 IP */ WhiteHost?: string; /** 更新类型,默认0,1为更新绑定计算组,2为更新默认计算组 */ UpdateType?: number; /** 需绑定计算组列表 */ UpdateComputeGroups?: string[]; /** 默认计算组 */ DefaultComputeGroup?: string; } declare interface ModifyUserPrivilegesV3Response { /** 错误信息,为空就是没有错误 */ ErrorMsg?: string; /** 集群id */ InstanceId?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyWorkloadGroupRequest { /** 集群id */ InstanceId: string; /** 修改的资源组信息 */ WorkloadGroup?: WorkloadGroupConfig; } declare interface ModifyWorkloadGroupResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyWorkloadGroupStatusRequest { /** 集群id */ InstanceId: string; /** 是否开启资源组:open-开启、close-关闭 */ OperationType?: string; } declare interface ModifyWorkloadGroupStatusResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface OpenCoolDownPolicyRequest { /** 实例id */ InstanceId?: string; /** db名称 */ DatabaseName?: string; /** table名称 */ TableName?: string; /** 操作类型 */ OperationType?: string; /** 逗号分隔 需要带上db的名字 db1.tb1,db1.tb2,db2.tb1 */ BatchOpenCoolDownTables?: string; /** 绑定的时候用 策略名称 */ PolicyName?: string; /** 逗号分隔 p1,p2,p3 */ BatchOpenCoolDownPartitions?: string; } declare interface OpenCoolDownPolicyResponse { /** 错误信息 */ ErrorMsg?: string; /** 返回信息 */ QueryDocument?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface OpenCoolDownRequest { /** 集群id */ InstanceId?: string; } declare interface OpenCoolDownResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface RecoverBackUpJobRequest { /** 集群id */ InstanceId: string; /** 任务id */ BackUpJobId: number; /** 恢复出来的新表副本数 */ ReplicationNum?: number; /** 恢复是否保持源表中的配置,1时表示保留源表中的配置 */ ReserveSourceConfig?: number; /** 0默认 1cos恢复 */ RecoverType?: number; /** CosSourceInfo对象 */ CosSourceInfo?: CosSourceInfo; /** 0默认 1定期执行 */ ScheduleType?: number; /** 年-月-日 时:分:秒 */ NextTime?: string; /** 调度名称 */ ScheduleName?: string; /** create update */ OperationType?: string; /** 恢复粒度:All全量、Database按库、Table按表 */ RecoverScope?: string; /** 恢复库:如果是按库备份,则需要该字段,库之间用","分割 */ RecoverDatabase?: string; /** 1:恢复后,不保留降冷策略,数据变为热数据;2:恢复后,沿用备份表的降冷策略;0:默认值,该版本没有这个配置(2.1版本2.1.8之前;2.0版本2.0.16之前) */ ReserveStoragePolicy?: number; } declare interface RecoverBackUpJobResponse { /** 恢复任务总数量 */ TotalCount?: number; /** 重复的表名 */ DuplicateTables?: string[]; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ReduceInstanceRequest { /** 集群ID */ InstanceId: string; /** 节点列表 */ DelHosts: string[]; /** 角色(MATER/CORE),MASTER 对应 FE,CORE对应BE */ Type: string; /** 缩容后集群高可用类型:0:非高可用,1:读高可用,2:读写高可用。 */ HaType: number; /** 前端鉴权使用 */ CheckAuth?: boolean; } declare interface ReduceInstanceResponse { /** 流程ID */ FlowId?: string; /** 集群ID */ InstanceId?: string; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ResizeDiskRequest { /** 集群ID */ InstanceId: string; /** 角色(MATER/CORE),MASTER 对应 FE,CORE对应BE */ Type: string; /** 云盘大小 */ DiskSize: number; } declare interface ResizeDiskResponse { /** 实例ID */ InstanceId?: string; /** 流程ID */ FlowId?: string; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface RestartClusterForConfigsRequest { /** 集群ID,例如cdwch-xxxx */ InstanceId: string; /** 配置文件名称 */ ConfigName: string; /** grace_restart为优雅滚动重启 不填默认立刻重启 */ OperationType?: string; } declare interface RestartClusterForConfigsResponse { /** 流程相关信息 */ FlowId?: number; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface RestartClusterForNodeRequest { /** 集群ID,例如cdwch-xxxx */ InstanceId: string; /** 配置文件名称 */ ConfigName: string; /** 每次重启的批次 */ BatchSize?: number; /** 重启节点 */ NodeList?: string[]; /** false表示非滚动重启,true表示滚动重启 */ RollingRestart?: boolean; } declare interface RestartClusterForNodeResponse { /** 流程相关信息 */ FlowId?: number; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ScaleOutInstanceRequest { /** 集群ID */ InstanceId: string; /** 角色(MATER/CORE),MASTER 对应 FE,CORE对应BE */ Type: string; /** 节点数量 */ NodeCount: number; /** 扩容后集群高可用类型:0:非高可用,1:读高可用,2:读写高可用。 */ HaType?: number; /** 前端鉴权使用 */ CheckAuth?: boolean; } declare interface ScaleOutInstanceResponse { /** 流程ID */ FlowId?: string; /** 集群ID */ InstanceId?: string; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ScaleUpInstanceRequest { /** 集群ID */ InstanceId: string; /** 节点规格 */ SpecName: string; /** 角色(MASTER/CORE),MASTER 对应 FE,CORE对应BE */ Type: string; /** 前端鉴权使用,后端API调用传false,传true不会执行变配 */ CheckAuth?: boolean; /** 是否滚动重启 */ RollingRestart?: boolean; } declare interface ScaleUpInstanceResponse { /** 流程ID */ FlowId?: string; /** 实例ID */ InstanceId?: string; /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface UpdateCoolDownRequest { /** 集群id */ InstanceId?: string; /** 是否启用 0:不启用 1:启用 */ Enable?: number; /** 用户存放冷热分层数据Cos桶地址 */ Bucket?: string; } declare interface UpdateCoolDownResponse { /** 错误信息 */ ErrorMsg?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } /** {@link Cdwdoris 腾讯云数据仓库 TCHouse-D} */ declare interface Cdwdoris { (): Versions; /** 新增、修改用户接口 {@link ActionAlterUserRequest} {@link ActionAlterUserResponse} */ ActionAlterUser(data: ActionAlterUserRequest, config?: AxiosRequestConfig): AxiosPromise<ActionAlterUserResponse>; /** 取消备份实例 {@link CancelBackupJobRequest} {@link CancelBackupJobResponse} */ CancelBackupJob(data: CancelBackupJobRequest, config?: AxiosRequestConfig): AxiosPromise<CancelBackupJobResponse>; /** 检查冷热分层生效变量和配置是否正确 {@link CheckCoolDownWorkingVariableConfigCorrectRequest} {@link CheckCoolDownWorkingVariableConfigCorrectResponse} */ CheckCoolDownWorkingVariableConfigCorrect(data?: CheckCoolDownWorkingVariableConfigCorrectRequest, config?: AxiosRequestConfig): AxiosPromise<CheckCoolDownWorkingVariableConfigCorrectResponse>; /** 创建或者修改备份策略 {@link CreateBackUpScheduleRequest} {@link CreateBackUpScheduleResponse} */ CreateBackUpSchedule(data: CreateBackUpScheduleRequest, config?: AxiosRequestConfig): AxiosPromise<CreateBackUpScheduleResponse>; /** 创建冷热分层策略 {@link CreateCoolDownPolicyRequest} {@link CreateCoolDownPolicyResponse} */ CreateCoolDownPolicy(data?: CreateCoolDownPolicyRequest, config?: AxiosRequestConfig): AxiosPromise<CreateCoolDownPolicyResponse>; /** 集群创建 {@link CreateInstanceNewRequest} {@link CreateInstanceNewResponse} */ CreateInstanceNew(data: CreateInstanceNewRequest, config?: AxiosRequestConfig): AxiosPromise<CreateInstanceNewResponse>; /** 创建资源组 {@link CreateWorkloadGroupRequest} {@link CreateWorkloadGroupResponse} */ CreateWorkloadGroup(data: CreateWorkloadGroupRequest, config?: AxiosRequestConfig): AxiosPromise<CreateWorkloadGroupResponse>; /** 删除备份实例 {@link DeleteBackUpDataRequest} {@link DeleteBackUpDataResponse} */ DeleteBackUpData(data: DeleteBackUpDataRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteBackUpDataResponse>; /** 删除资源组 {@link DeleteWorkloadGroupRequest} {@link DeleteWorkloadGroupResponse} */ DeleteWorkloadGroup(data: DeleteWorkloadGroupRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteWorkloadGroupResponse>; /** 获取各地域列表 {@link DescribeAreaRegionRequest} {@link DescribeAreaRegionResponse} */ DescribeAreaRegion(data?: DescribeAreaRegionRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeAreaRegionResponse>; /** 查询备份实例列表 {@link DescribeBackUpJobRequest} {@link DescribeBackUpJobResponse} */ DescribeBackUpJob(data: DescribeBackUpJobRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeBackUpJobResponse>; /** 查询备份任务详情 {@link DescribeBackUpJobDetailRequest} {@link DescribeBackUpJobDetailResponse} */ DescribeBackUpJobDetail(data: DescribeBackUpJobDetailRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeBackUpJobDetailResponse>; /** 获取备份、迁移任务 {@link DescribeBackUpSchedulesRequest} {@link DescribeBackUpSchedulesResponse} */ DescribeBackUpSchedules(data?: DescribeBackUpSchedulesRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeBackUpSchedulesResponse>; /** 获取可备份表信息 {@link DescribeBackUpTablesRequest} {@link DescribeBackUpTablesResponse} */ DescribeBackUpTables(data: DescribeBackUpTablesRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeBackUpTablesResponse>; /** 查询备份任务进度详情 {@link DescribeBackUpTaskDetailRequest} {@link DescribeBackUpTaskDetailResponse} */ DescribeBackUpTaskDetail(data: DescribeBackUpTaskDetailRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeBackUpTaskDetailResponse>; /** 获取集群配置文件 {@link DescribeClusterConfigsRequest} {@link DescribeClusterConfigsResponse} */ DescribeClusterConfigs(data: DescribeClusterConfigsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeClusterConfigsResponse>; /** 获取集群配置文件修改历史 {@link DescribeClusterConfigsHistoryRequest} {@link DescribeClusterConfigsHistoryResponse} */ DescribeClusterConfigsHistory(data: DescribeClusterConfigsHistoryRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeClusterConfigsHistoryResponse>; /** 查询冷热分层backend节点信息列表 {@link DescribeCoolDownBackendsRequest} {@link DescribeCoolDownBackendsResponse} */ DescribeCoolDownBackends(data?: DescribeCoolDownBackendsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeCoolDownBackendsResponse>; /** 查询冷热分层策略列表 {@link DescribeCoolDownPoliciesRequest} {@link DescribeCoolDownPoliciesResponse} */ DescribeCoolDownPolicies(data?: DescribeCoolDownPoliciesRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeCoolDownPoliciesResponse>; /** 查询冷热分层Table数据 {@link DescribeCoolDownTableDataRequest} {@link DescribeCoolDownTableDataResponse} */ DescribeCoolDownTableData(data?: DescribeCoolDownTableDataR