tenyun

/// <reference types="node" /> import { AxiosPromise, AxiosRequestConfig } from "axios"; /** 集群支持的功能 */ declare interface Ability { /** 是否支持从可用区 */ IsSupportSlaveZone: string; /** 不支持从可用区的原因 */ NonsupportSlaveZoneReason: string; /** 是否支持RO实例 */ IsSupportRo: string; /** 不支持RO实例的原因 */ NonsupportRoReason: string; /** 是否支持手动发起快照备份 */ IsSupportManualSnapshot: string; /** 是否支持透明数据加密 */ IsSupportTransparentDataEncryption?: string; /** 不支持透明数据加密原因 */ NoSupportTransparentDataEncryptionReason?: string; /** 是否支持手动发起逻辑备份 */ IsSupportManualLogic?: string; } /** 数据库账号信息 */ declare interface Account { /** 数据库账号名 */ AccountName?: string; /** 数据库账号描述 */ Description?: string; /** 创建时间 */ CreateTime?: string; /** 更新时间 */ UpdateTime?: string; /** 主机 */ Host?: string; /** 用户最大连接数 */ MaxUserConnections?: number; } /** 账号参数 */ declare interface AccountParam { /** 参数名称，当前仅支持参数：max_user_connections */ ParamName: string; /** 参数值 */ ParamValue: string; } /** 数据库地址 */ declare interface Addr { /** IP地址 */ IP?: string; /** 端口 */ Port?: number; } /** 查询审计实例的过滤条件 */ declare interface AuditInstanceFilters { /** 过滤条件值。支持InstanceId-实例ID，InstanceName-实例名称，ProjectId-项目ID，TagKey-标签键，Tag-标签（以竖线分割，例：Tagkey|Tagvalue）。 */ Name: string; /** true表示精确查找，false表示模糊匹配。 */ ExactMatch: boolean; /** 筛选值 */ Values: string[]; } /** 审计实例详情 */ declare interface AuditInstanceInfo { /** 项目ID */ ProjectId?: number; /** 标签信息 */ TagList?: Tag[]; } /** 审计日志详细信息 */ declare interface AuditLog { /** 影响行数。 */ AffectRows?: number; /** 错误码。 */ ErrCode?: number; /** SQL类型。 */ SqlType?: string; /** 表名称。 */ TableName?: string; /** 实例名称。 */ InstanceName?: string; /** 审计策略名称。 */ PolicyName?: string; /** 数据库名称。 */ DBName?: string; /** SQL语句。 */ Sql?: string; /** 客户端地址。 */ Host?: string; /** 用户名。 */ User?: string; /** 执行时间，微秒。 */ ExecTime?: number; /** 时间。 */ Timestamp?: string; /** 返回行数。 */ SentRows?: number; /** 执行线程ID。 */ ThreadId?: number; /** 扫描行数。 */ CheckRows?: number; /** cpu执行时间，微秒。 */ CpuTime?: number; /** IO等待时间，微秒。 */ IoWaitTime?: number; /** 锁等待时间，微秒。 */ LockWaitTime?: number; /** 事务持续等待时间，微秒。 */ TrxLivingTime?: number; /** 开始时间，与timestamp构成一个精确到纳秒的时间。 */ NsTime?: number; /** 日志命中规则模板的基本信息 */ TemplateInfo?: LogRuleTemplateInfo[]; /** 事务ID */ TrxId?: number; } /** 审计日志文件 */ declare interface AuditLogFile { /** 审计日志文件名称 */ FileName?: string; /** 审计日志文件创建时间。格式为 : "2019-03-20 17:09:13"。 */ CreateTime?: string; /** 文件状态值。可能返回的值为："creating" - 生成中;"failed" - 创建失败;"success" - 已生成; */ Status?: string; /** 文件大小，单位为 KB。 */ FileSize?: number; /** 审计日志下载地址。 */ DownloadUrl?: string; /** 错误信息。 */ ErrMsg?: string; /** 日志下载进度。 */ ProgressRate?: number; } /** 审计日志过滤条件。查询审计日志时，用户过滤返回的审计日志。 */ declare interface AuditLogFilter { /** 客户端地址。 */ Host?: string[]; /** 用户名。 */ User?: string[]; /** 数据库名称。 */ DBName?: string[]; /** 表名称。 */ TableName?: string[]; /** 审计策略名称。 */ PolicyName?: string[]; /** SQL 语句。支持模糊匹配。 */ Sql?: string; /** SQL 类型。目前支持："SELECT", "INSERT", "UPDATE", "DELETE", "CREATE", "DROP", "ALTER", "SET", "REPLACE", "EXECUTE"。 */ SqlType?: string; /** 执行时间。单位为：ms。表示筛选执行时间大于该值的审计日志。 */ ExecTime?: number; /** 影响行数。表示筛选影响行数大于该值的审计日志。 */ AffectRows?: number; /** SQL 类型。支持多个类型同时查询。目前支持："SELECT", "INSERT", "UPDATE", "DELETE", "CREATE", "DROP", "ALTER", "SET", "REPLACE", "EXECUTE"。 */ SqlTypes?: string[]; /** SQL 语句。支持传递多个sql语句。 */ Sqls?: string[]; /** 返回行数。 */ SentRows?: number; /** 线程ID。 */ ThreadId?: string[]; } /** 规则审计的过滤条件 */ declare interface AuditRuleFilters { /** 单条审计规则。 */ RuleFilters: RuleFilters[]; } /** 审计规则模板的详情 */ declare interface AuditRuleTemplateInfo { /** 规则模板ID。 */ RuleTemplateId?: string; /** 规则模板名称。 */ RuleTemplateName?: string; /** 规则模板的过滤条件 */ RuleFilters?: RuleFilters[]; /** 规则模板描述。 */ Description?: string; /** 规则模板创建时间。 */ CreateAt?: string; /** 规则模板修改时间。 */ UpdateAt?: string; /** 告警等级。1-低风险，2-中风险，3-高风险。 */ AlarmLevel?: number; /** 告警策略。0-不告警，1-告警。 */ AlarmPolicy?: number; /** 模板状态。0-无任务，1-修改中。 */ Status?: number; /** 规则模板应用在哪些在实例。 */ AffectedInstances?: string[]; } /** 备份文件信息 */ declare interface BackupFileInfo { /** 快照文件ID，已废弃，请使用BackupId */ SnapshotId?: number; /** 备份文件名 */ FileName?: string; /** 备份文件大小 */ FileSize?: number; /** 备份开始时间 */ StartTime?: string; /** 备份完成时间 */ FinishTime?: string; /** 备份类型：snapshot，快照备份；logic，逻辑备份 */ BackupType?: string; /** 备份方式：auto，自动备份；manual，手动备份 */ BackupMethod?: string; /** 备份文件状态：success：备份成功；fail：备份失败；creating：备份文件创建中；deleting：备份文件删除中 */ BackupStatus?: string; /** 备份文件时间 */ SnapshotTime?: string; /** 备份ID */ BackupId?: number; /** 快照类型，可选值：full，全量；increment，增量 */ SnapShotType?: string; /** 备份文件备注 */ BackupName?: string; } /** 备份下载集群限制参数 */ declare interface BackupLimitClusterRestriction { /** 集群id */ ClusterId?: string; /** 下载限制配置 */ BackupLimitRestriction?: BackupLimitRestriction; } /** 备份下载限制参数 */ declare interface BackupLimitRestriction { /** 限制类型 */ LimitType?: string; /** 该参数仅支持 In，表示 LimitVpc 指定的vpc可以下载。默认为In */ VpcComparisonSymbol?: string; /** In: 指定的ip可以下载； NotIn: 指定的ip不可以下载 */ IpComparisonSymbol?: string; /** 限制下载的vpc设置 */ LimitVpcs?: BackupLimitVpcItem[] | null; /** 限制下载的ip设置 */ LimitIps?: string[] | null; } /** 备份文件限制下载来源VPC设置项 */ declare interface BackupLimitVpcItem { /** 限制下载来源的地域。目前仅支持当前地域 */ Region?: string; /** 限制下载的vpc列表 */ VpcList?: string[]; } /** 计费资源信息 */ declare interface BillingResourceInfo { /** 集群ID */ ClusterId?: string; /** 实例ID列表 */ InstanceIds?: string[]; /** 订单ID */ DealName?: string; } /** 资源包绑定的实例信息 */ declare interface BindInstanceInfo { /** 绑定的集群ID */ InstanceId?: string; /** 绑定的实例所在的地域 */ InstanceRegion?: string; /** 绑定的实例类型 */ InstanceType?: string; /** 绑定集群下的实例ID */ ExtendIds?: string[]; } /** binlog配置信息 */ declare interface BinlogConfigInfo { /** binlog保留时间 */ BinlogSaveDays: number; /** binlog异地地域备份是否开启 */ BinlogCrossRegionsEnable: string; /** binlog异地地域 */ BinlogCrossRegions?: string[] | null; } /** Binlog描述 */ declare interface BinlogItem { /** Binlog文件名称 */ FileName?: string; /** 文件大小，单位：字节 */ FileSize?: number; /** 事务最早时间 */ StartTime?: string; /** 事务最晚时间 */ FinishTime?: string; /** Binlog文件ID */ BinlogId?: number; } /** 任务信息 */ declare interface BizTaskInfo { /** 任务id */ ID?: number; /** 用户appid */ AppId?: number; /** 集群id */ ClusterId?: string; /** 地域 */ Region?: string; /** 任务创建时间 */ CreateTime?: string; /** 延迟执行时间 */ DelayTime?: string; /** 任务失败信息 */ ErrMsg?: string; /** 异步任务流id */ FlowId?: number; /** 任务输入信息 */ Input?: string; /** 实例组id */ InstanceGrpId?: string; /** 实例组id */ InstanceGroupId?: string; /** 实例id */ InstanceId?: string; /** 任务操作对象id */ ObjectId?: string; /** 任务操作对象类型 */ ObjectType?: string; /** 操作者uin */ Operator?: string; /** 任务输出信息 */ Output?: string; /** 任务状态 */ Status?: string; /** 任务类型 */ TaskType?: string; /** 触发本任务的父任务ID */ TriggerTaskId?: number; /** 更新时间 */ UpdateTime?: string; /** 任务开始时间 */ StartTime?: string; /** 任务结束时间 */ EndTime?: string; /** 集群名称 */ ClusterName?: string; /** 实例名称 */ InstanceName?: string; /** 任务进度 */ Process?: number; /** 修改参数任务信息 */ ModifyParamsData?: ModifyParamsData[] | null; /** 创建集群任务信息 */ CreateClustersData?: CreateClustersData; /** 集群回档任务信息 */ RollbackData?: RollbackData; /** 实例变配任务信息 */ ModifyInstanceData?: ModifyInstanceData; /** 手动备份任务信息 */ ManualBackupData?: ManualBackupData | null; /** 修改内核版本任务信息 */ ModifyDbVersionData?: ModifyDbVersionData; /** 集群可用区信息 */ ClusterSlaveData?: ClusterSlaveData; /** 转换集群日志 */ SwitchClusterLogBin?: SwitchClusterLogBin | null; /** 修改实例参数数据 */ ModifyInstanceParamsData?: BizTaskModifyParamsData | null; /** 维护时间 */ TaskMaintainInfo?: TaskMaintainInfo; /** 实例日志投递信息 */ InstanceCLSDeliveryInfos?: InstanceCLSDeliveryInfo[]; /** 任务进度信息 */ TaskProgressInfo?: TaskProgressInfo; /** 全球数据库网络任务 */ GdnTaskInfo?: GdnTaskInfo; } /** 实例参数修改任务详情 */ declare interface BizTaskModifyInstanceParam { /** 实例ID */ InstanceId?: string; /** 实例参数修改任务详情 */ ModifyInstanceParamList?: ModifyParamItem[]; } /** 修改参数任务数据 */ declare interface BizTaskModifyParamsData { /** 集群ID */ ClusterId?: string; /** 集群参数修改数据 */ ClusterParamList?: ModifyParamItem[]; /** 实例参数修改数据 */ ModifyInstanceParams?: BizTaskModifyInstanceParam[]; } /** CLS日志投递配置 */ declare interface CLSInfo { /** 日志主题操作：可选create,reuse。create:新增日志主题，使用TopicName创建日志主题。reuse:使用已有日志主题，使用TopicId指定日志主题。不允许使用已有日志主题且新建日志集的组合。 */ TopicOperation: string; /** 日志集操作：可选create,reuse。create:新增日志集，使用GroupName创建日志集。reuse:使用已有日志集，使用GroupId指定日志集。不允许使用已有日志主题且新建日志集的组合。 */ GroupOperation: string; /** 日志投递地域 */ Region: string; /** 日志主题id */ TopicId?: string; /** 日志主题name */ TopicName?: string; /** 日志集id */ GroupId?: string; /** 日志集name */ GroupName?: string; } /** 集群实例信息 */ declare interface ClusterInstanceDetail { /** 实例ID */ InstanceId?: string; /** 实例名称 */ InstanceName?: string; /** 引擎类型 */ InstanceType?: string; /** 实例状态 */ InstanceStatus?: string; /** 实例状态描述 */ InstanceStatusDesc?: string; /** cpu核数 */ InstanceCpu?: number; /** 内存 */ InstanceMemory?: number; /** 硬盘 */ InstanceStorage?: number; /** 实例角色 */ InstanceRole?: string; /** 执行开始时间(距离0点的秒数) */ MaintainStartTime?: number; /** 持续的时间(单位：秒) */ MaintainDuration?: number; /** 可以执行的时间，枚举值：["Mon","Tue","Wed","Thu","Fri", "Sat", "Sun"] */ MaintainWeekDays?: string[]; /** serverless实例子状态 */ ServerlessStatus?: string; /** 实例任务信息 */ InstanceTasks?: ObjectTask[]; /** 实例机器类型 */ InstanceDeviceType?: string; /** 实例存储类型 */ InstanceStorageType?: string; /** 数据库类型 */ DbMode?: string; /** 节点列表 */ NodeList?: string[]; } /** 参数修改记录 */ declare interface ClusterParamModifyLog { /** 参数名称 */ ParamName?: string; /** 当前值 */ CurrentValue?: string; /** 修改后的值 */ UpdateValue?: string; /** 修改状态 */ Status?: string; /** 创建时间 */ CreateTime?: string; /** 更新时间 */ UpdateTime?: string; /** 集群ID */ ClusterId?: string; /** 实例ID */ InstanceId?: string; } /** 集群只读开关列表 */ declare interface ClusterReadOnlyValue { /** 集群ID */ ClusterId?: string; /** 只读开关值 */ ReadOnlyValue?: string; } /** 集群从可用区信息 */ declare interface ClusterSlaveData { /** 旧主可用区 */ OldMasterZone?: string; /** 旧从可用区 */ OldSlaveZone?: string[] | null; /** 新主可用区 */ NewMasterZone?: string; /** 新从可用区 */ NewSlaveZone?: string[] | null; /** 新从可用区属性 */ NewSlaveZoneAttr?: SlaveZoneAttrItem[]; /** 旧可用区属性 */ OldSlaveZoneAttr?: SlaveZoneAttrItem[]; } /** 集群任务ID */ declare interface ClusterTaskId { /** 集群ID */ ClusterId?: string; /** 任务ID */ TaskId?: string; } /** 创建集群任务信息 */ declare interface CreateClustersData { /** 实例CPU */ Cpu?: number; /** 实例内存 */ Memory?: number; /** 集群存储上限 */ StorageLimit?: number; } /** 跨地域备份各地域备份信息 */ declare interface CrossRegionBackupItem { /** 备份的目标地域 */ CrossRegion?: string; /** 目标地域的备份任务ID */ BackupId?: number; /** 目标地域的备份状态 */ BackupStatus?: string; } /** 集群信息 */ declare interface CynosdbCluster { /** 集群状态，可选值如下:creating: 创建中running:运行中isolating:隔离中isolated:已隔离activating:解隔离中offlining:下线中offlined:已下线deleting:删除中deleted:已删除 */ Status: string; /** 更新时间 */ UpdateTime: string; /** 可用区 */ Zone: string; /** 集群名称 */ ClusterName: string; /** 地域 */ Region: string; /** 数据库版本 */ DbVersion: string; /** 集群ID */ ClusterId: string; /** 实例数 */ InstanceNum: number; /** 用户uin */ Uin: string; /** 引擎类型 */ DbType: string; /** 用户appid */ AppId: number; /** 集群状态描述 */ StatusDesc: string; /** 集群创建时间 */ CreateTime: string; /** 付费模式。0-按量计费，1-包年包月 */ PayMode: number; /** 截止时间 */ PeriodEndTime: string; /** 集群读写vip */ Vip: string; /** 集群读写vport */ Vport: number; /** 项目id */ ProjectID: number; /** 私有网络ID */ VpcId?: string; /** 子网ID */ SubnetId?: string; /** cynos内核版本 */ CynosVersion?: string; /** cynos版本标签 */ CynosVersionTag?: string; /** 存储容量 */ StorageLimit?: number; /** 续费标志 */ RenewFlag?: number; /** 正在处理的任务 */ ProcessingTask?: string; /** 集群的任务数组 */ Tasks?: ObjectTask[]; /** 集群绑定的tag数组 */ ResourceTags?: Tag[]; /** Db类型(NORMAL, SERVERLESS) */ DbMode?: string; /** 当Db类型为SERVERLESS时，serverless集群状态，可选值:resumepause */ ServerlessStatus?: string; /** 集群预付费存储值大小 */ Storage?: number; /** 集群存储为预付费时的存储ID，用于预付费存储变配 */ StorageId?: string; /** 集群存储付费模式。0-按量计费，1-包年包月 */ StoragePayMode?: number; /** 集群计算规格对应的最小存储值 */ MinStorageSize?: number; /** 集群计算规格对应的最大存储值 */ MaxStorageSize?: number; /** 集群网络信息 */ NetAddrs?: NetAddr[]; /** 物理可用区 */ PhysicalZone?: string; /** 主可用区 */ MasterZone?: string; /** 是否有从可用区 */ HasSlaveZone?: string; /** 从可用区 */ SlaveZones?: string[]; /** 商业类型 */ BusinessType?: string; /** 是否冻结 */ IsFreeze?: string; /** 订单来源 */ OrderSource?: string; /** 能力 */ Ability?: Ability; /** 实例绑定资源包信息（此处只返回存储资源包，即packageType=DISK） */ ResourcePackages?: ResourcePackage[]; /** 全球数据库唯一标识 */ GdnId?: string; /** 集群角色。主集群- primary，从集群 - standby，如果 GdnId为空，该字段无效。 */ GdnRole?: string; } /** 集群详情详细信息 */ declare interface CynosdbClusterDetail { /** 集群ID */ ClusterId?: string; /** 集群名称 */ ClusterName?: string; /** 地域 */ Region?: string; /** 可用区 */ Zone?: string; /** 物理可用区 */ PhysicalZone?: string; /** 状态 */ Status?: string; /** 状态描述 */ StatusDesc?: string; /** 当Db类型为SERVERLESS时，serverless集群状态，可选值:resumeresumingpausepausing */ ServerlessStatus?: string; /** 存储Id */ StorageId?: string; /** 存储大小，单位为G */ Storage?: number; /** 最大存储规格，单位为G */ MaxStorageSize?: number; /** 最小存储规格，单位为G */ MinStorageSize?: number; /** 存储付费类型，1为包年包月，0为按量计费 */ StoragePayMode?: number; /** VPC名称 */ VpcName?: string; /** vpc唯一id */ VpcId?: string; /** 子网名称 */ SubnetName?: string; /** 子网ID */ SubnetId?: string; /** 字符集 */ Charset?: string; /** 创建时间 */ CreateTime?: string; /** 数据库类型 */ DbType?: string; /** Db类型：NORMALSERVERLESS */ DbMode?: string; /** 数据库版本 */ DbVersion?: string; /** 存储空间上限 */ StorageLimit?: number; /** 使用容量 */ UsedStorage?: number; /** vip地址 */ Vip?: string; /** vport端口 */ Vport?: number; /** 集群只读实例的vip地址和vport端口 */ RoAddr?: Addr[]; /** 集群支持的功能 */ Ability?: Ability; /** cynos版本 */ CynosVersion?: string; /** 商业类型 */ BusinessType?: string; /** 是否有从可用区 */ HasSlaveZone?: string; /** 是否冻结 */ IsFreeze?: string; /** 任务列表 */ Tasks?: ObjectTask[]; /** 主可用区 */ MasterZone?: string; /** 从可用区列表 */ SlaveZones?: string[]; /** 实例信息 */ InstanceSet?: ClusterInstanceDetail[]; /** 付费模式 */ PayMode?: number; /** 到期时间 */ PeriodEndTime?: string; /** 项目id */ ProjectID?: number; /** 实例绑定的tag数组信息 */ ResourceTags?: Tag[]; /** Proxy状态 */ ProxyStatus?: string; /** binlog开关，可选值：ON, OFF */ LogBin?: string; /** 是否跳过交易 */ IsSkipTrade?: string; /** pitr类型，可选值：normal, redo_pitr */ PitrType?: string; /** 是否打开密码复杂度 */ IsOpenPasswordComplexity?: string; /** 网络类型 */ NetworkStatus?: string; /** 集群绑定的资源包信息 */ ResourcePackages?: ResourcePackage[]; /** 自动续费标识，1为自动续费，0为到期不续 */ RenewFlag?: number; /** 节点网络类型 */ NetworkType?: string; /** 备可用区属性 */ SlaveZoneAttr?: SlaveZoneAttrItem[]; /** 版本标签 */ CynosVersionTag?: string; /** 全球数据库网络唯一标识 */ GdnId?: string; /** 集群在全球数据网络中的角色。主集群- primary从集群 - standby如为空，该字段无效 */ GdnRole?: string; /** 二级存储使用量，单位：G */ UsedArchiveStorage?: number; /** 归档状态，枚举值normal:正常archiving:归档中resuming:恢复中archived :已归档 */ ArchiveStatus?: string; /** 归档进度，百分比。 */ ArchiveProgress?: number; } /** 实例错误日志返回类型 */ declare interface CynosdbErrorLogItem { /** 日志时间戳 */ Timestamp?: number; /** 日志等级 */ Level?: string; /** 日志内容 */ Content?: string; } /** 实例信息 */ declare interface CynosdbInstance { /** 用户Uin */ Uin?: string; /** 用户AppId */ AppId?: number; /** 集群ID */ ClusterId?: string; /** 集群名称 */ ClusterName?: string; /** 实例ID */ InstanceId?: string; /** 实例名称 */ InstanceName?: string; /** 项目ID */ ProjectId?: number; /** 地域 */ Region?: string; /** 可用区 */ Zone?: string; /** 实例状态 */ Status?: string; /** 实例状态中文描述 */ StatusDesc?: string; /** 实例形态，是否为serverless实例 */ DbMode?: string; /** 数据库类型 */ DbType?: string; /** 数据库版本 */ DbVersion?: string; /** Cpu，单位：核 */ Cpu?: number; /** 内存，单位：GB */ Memory?: number; /** 存储量，单位：GB */ Storage?: number; /** 实例类型 */ InstanceType?: string; /** 实例当前角色 */ InstanceRole?: string; /** 更新时间 */ UpdateTime?: string; /** 创建时间 */ CreateTime?: string; /** VPC网络ID */ VpcId?: string; /** 子网ID */ SubnetId?: string; /** 实例内网IP */ Vip?: string; /** 实例内网端口 */ Vport?: number; /** 付费模式 */ PayMode?: number; /** 实例过期时间 */ PeriodEndTime?: string; /** 销毁期限 */ DestroyDeadlineText?: string; /** 隔离时间 */ IsolateTime?: string; /** 网络类型 */ NetType?: number; /** 外网域名 */ WanDomain?: string; /** 外网IP */ WanIP?: string; /** 外网端口 */ WanPort?: number; /** 外网状态 */ WanStatus?: string; /** 实例销毁时间 */ DestroyTime?: string; /** Cynos内核版本 */ CynosVersion?: string; /** 正在处理的任务 */ ProcessingTask?: string; /** 续费标志 */ RenewFlag?: number; /** serverless实例cpu下限 */ MinCpu?: number; /** serverless实例cpu上限 */ MaxCpu?: number; /** serverless实例状态, 可选值：resumepause */ ServerlessStatus?: string; /** 预付费存储Id */ StorageId?: string; /** 存储付费类型 */ StoragePayMode?: number; /** 物理区 */ PhysicalZone?: string; /** 商业类型 */ BusinessType?: string; /** 任务 */ Tasks?: ObjectTask[]; /** 是否冻结 */ IsFreeze?: string; /** 资源标签 */ ResourceTags?: Tag[] | null; /** 主可用区 */ MasterZone?: string; /** 备可用区 */ SlaveZones?: string[] | null; /** 实例网络信息 */ InstanceNetInfo?: InstanceNetInfo[]; /** 实例绑定资源包信息（此处只返回计算资源包，即packageType=CCU） */ ResourcePackages?: ResourcePackage[] | null; /** 实例索引形态,可选值【mixedRowColumn（行列混存），onlyRowIndex（仅行存）】 */ InstanceIndexMode?: string; /** 当前实例支持的能力 */ InstanceAbility?: InstanceAbility; /** 实例机器类型 */ DeviceType?: string; /** 实例存储类型 */ InstanceStorageType?: string; /** 未知字段 */ CynosVersionTag?: string; /** libradb 节点信息 */ NodeList?: string[]; /** 全球数据库唯一标识 */ GdnId?: string; } /** 实例详情 */ declare interface CynosdbInstanceDetail { /** 用户Uin */ Uin?: string; /** 用户AppId */ AppId?: number; /** 集群ID */ ClusterId?: string; /** 集群名称 */ ClusterName?: string; /** 实例ID */ InstanceId?: string; /** 实例名称 */ InstanceName?: string; /** 项目ID */ ProjectId?: number; /** 地域 */ Region?: string; /** 可用区 */ Zone?: string; /** 实例状态 */ Status?: string; /** 实例状态中文描述 */ StatusDesc?: string; /** serverless实例状态, 可能值：resumepause */ ServerlessStatus?: string; /** 数据库类型 */ DbType?: string; /** 数据库版本 */ DbVersion?: string; /** Cpu，单位：核 */ Cpu?: number; /** 内存，单位：GB */ Memory?: number; /** 存储量，单位：GB */ Storage?: number; /** 实例类型 */ InstanceType?: string; /** 实例当前角色 */ InstanceRole?: string; /** 更新时间 */ UpdateTime?: string; /** 创建时间 */ CreateTime?: string; /** 付费模式 */ PayMode?: number; /** 实例过期时间 */ PeriodEndTime?: string; /** 网络类型 */ NetType?: number; /** VPC网络ID */ VpcId?: string; /** 子网ID */ SubnetId?: string; /** 实例内网IP */ Vip?: string; /** 实例内网端口 */ Vport?: number; /** 实例外网域名 */ WanDomain?: string; /** 字符集 */ Charset?: string; /** Cynos内核版本 */ CynosVersion?: string; /** 续费标志 */ RenewFlag?: number; /** serverless实例cpu下限 */ MinCpu?: number; /** serverless实例cpu上限 */ MaxCpu?: number; /** Db类型:NORMALSERVERLESS */ DbMode?: string; } /** 实例组信息 */ declare interface CynosdbInstanceGroup { /** 用户appId */ AppId?: number; /** 集群ID */ ClusterId?: string; /** 创建时间 */ CreatedTime?: string; /** 删除时间 */ DeletedTime?: string; /** 实例组ID */ InstanceGroupId?: string; /** 状态 */ Status?: string; /** 实例组（网络）类型。ha-ha组；ro-只读组；proxy-代理；singleRo-只读实例独占 */ Type?: string; /** 更新时间 */ UpdatedTime?: string; /** 内网IP */ Vip?: string; /** 内网端口 */ Vport?: number; /** 外网域名 */ WanDomain?: string; /** 外网ip */ WanIP?: string; /** 外网端口 */ WanPort?: number; /** 外网状态 */ WanStatus?: string; /** 实例组包含实例信息 */ InstanceSet?: CynosdbInstance[]; /** VPC的ID */ UniqVpcId?: string; /** 子网ID */ UniqSubnetId?: string; /** 正在回收IP信息 */ OldAddrInfo?: OldAddrInfo; /** 正在进行的任务 */ ProcessingTasks?: string[]; /** 任务列表 */ Tasks?: ObjectTask[]; /** biz_net_service表id */ NetServiceId?: number; } /** 实例组信息 */ declare interface CynosdbInstanceGrp { /** 用户appId */ AppId?: number; /** 集群ID */ ClusterId?: string; /** 创建时间 */ CreatedTime?: string; /** 删除时间 */ DeletedTime?: string; /** 实例组ID */ InstanceGrpId?: string; /** 状态 */ Status?: string; /** 实例组类型。ha-ha组；ro-只读组 */ Type?: string; /** 更新时间 */ UpdatedTime?: string; /** 内网IP */ Vip?: string; /** 内网端口 */ Vport?: number; /** 外网域名 */ WanDomain?: string; /** 外网ip */ WanIP?: string; /** 外网端口 */ WanPort?: number; /** 外网状态 */ WanStatus?: string; /** 实例组包含实例信息 */ InstanceSet?: CynosdbInstance[]; /** VPC的ID */ UniqVpcId?: string | null; /** 子网ID */ UniqSubnetId?: string | null; /** 正在回收IP信息 */ OldAddrInfo?: OldAddrInfo | null; /** 正在进行的任务 */ ProcessingTasks?: string[]; /** 任务列表 */ Tasks?: ObjectTask[]; /** biz_net_service表id */ NetServiceId: number; } /** 数据库权限列表 */ declare interface DatabasePrivileges { /** 数据库 */ Db: string; /** 权限列表 */ Privileges: string[]; } /** 数据库表信息 */ declare interface DatabaseTables { /** 数据库名 */ Database?: string; /** 表名称列表 */ Tables?: string[]; } /** 数据库详细信息 */ declare interface DbInfo { /** 数据库名称 */ DbName?: string; /** 字符集类型 */ CharacterSet?: string; /** 数据库状态 */ Status?: string; /** 排序规则 */ CollateRule?: string; /** 数据库备注 */ Description?: string; /** 用户权限 */ UserHostPrivileges?: UserHostPrivilege[]; /** 数据库ID */ DbId?: number; /** 创建时间 */ CreateTime?: string; /** 更新时间 */ UpdateTime?: string; /** 用户appid */ AppId?: number; /** 用户Uin */ Uin?: string; /** 集群Id */ ClusterId?: string; } /** 数据库表 */ declare interface DbTable { /** 数据库名称 */ Db: string; /** 数据库表名称 */ TableName?: string; } /** 日志投递信息 */ declare interface DeliverSummary { /** 投递类型，store（存储类），mq（消息通道） */ DeliverType?: string; /** 投递子类型：cls，ckafka。 */ DeliverSubType?: string; /** 投递者 */ DeliverConsumer?: string; /** 投递者名称 */ DeliverConsumerName?: string; } /** 错误日志导出格式 */ declare interface ErrorLogItemExport { /** 时间 */ Timestamp?: string; /** 日志等级，可选值note, warning，error */ Level?: string; /** 日志内容 */ Content?: string; } /** 交换实例信息 */ declare interface ExchangeInstanceInfo { /** 源实例信息 */ SrcInstanceInfo?: RollbackInstanceInfo; /** 目标实例信息 */ DstInstanceInfo?: RollbackInstanceInfo; } /** 交换RO组信息 */ declare interface ExchangeRoGroupInfo { /** 源RO组信息 */ SrcRoGroupInfo?: RollbackRoGroupInfo; /** 目标RO组信息 */ DstRoGroupInfo?: RollbackRoGroupInfo; } /** 全球数据库任务信息 */ declare interface GdnTaskInfo { /** 全球数据库唯一标识 */ GdnId?: string; /** 全球数据库唯一别名 */ GdnName?: string; /** 主集群ID */ PrimaryClusterId?: string; /** 主集群所在地域 */ PrimaryClusterRegion?: string; /** 从集群所在地域 */ StandbyClusterRegion?: string; /** 从集群ID */ StandbyClusterId?: string; /** 从集群别名 */ StandbyClusterName?: string; } /** 账号，包含accountName和host */ declare interface InputAccount { /** 账号 */ AccountName: string; /** 主机，默认‘%’ */ Host?: string; } /** 实例允许的操作列表 */ declare interface InstanceAbility { /** 实例是否支持强制重启，可选值：yes：支持，no：不支持 */ IsSupportForceRestart?: string; /** 不支持强制重启的原因 */ NonsupportForceRestartReason?: string; } /** 审计日志搜索条件 */ declare interface InstanceAuditLogFilter { /** 过滤项。目前支持以下搜索条件：包含、不包含、包含（分词维度）、不包含（分词维度）: sql - SQL详情；alarmLevel - 告警等级；ruleTemplateId - 规则模板Id等于、不等于、包含、不包含： host - 客户端地址； user - 用户名； dbName - 数据库名称；等于、不等于： sqlType - SQL类型； errCode - 错误码； threadId - 线程ID；范围搜索（时间类型统一为微秒）： execTime - 执行时间； lockWaitTime - 执行时间； ioWaitTime - IO等待时间； trxLivingTime - 事务持续时间； cpuTime - cpu时间； checkRows - 扫描行数； affectRows - 影响行数； sentRows - 返回行数。 */ Type: string; /** 过滤条件。支持以下条件：WINC-包含（分词维度），WEXC-不包含（分词维度）,INC - 包含,EXC - 不包含,EQS - 等于,NEQ - 不等于,RA - 范围。 */ Compare: string; /** 过滤的值。反向查询时，多个值之前是且的关系，正向查询多个值是或的关系。 */ Value: string[]; } /** 实例的审计规则详情。 */ declare interface InstanceAuditRule { /** 实例ID。 */ InstanceId?: string; /** 是否是规则审计。true-规则审计，false-全审计。 */ AuditRule?: boolean; /** 审计规则详情。仅当AuditRule=true时有效。 */ AuditRuleFilters?: AuditRuleFilters[]; /** 是否是审计策略 */ OldRule?: boolean; /** 实例应用的规则模板详情 */ RuleTemplates?: RuleTemplateInfo[]; } /** 实例审计详情信息 */ declare interface InstanceAuditStatus { /** 实例ID。 */ InstanceId?: string; /** 审计状态。ON-表示审计已开启，OFF-表示审计关闭。 */ AuditStatus?: string; /** 日志保留时长。 */ LogExpireDay?: number; /** 高频存储时长。 */ HighLogExpireDay?: number; /** 低频存储时长。 */ LowLogExpireDay?: number; /** 日志存储量。 */ BillingAmount?: number; /** 高频存储量。 */ HighRealStorage?: number; /** 低频存储量。 */ LowRealStorage?: number; /** 是否为全审计。true-表示全审计。 */ AuditAll?: boolean; /** 审计开通时间。 */ CreateAt?: string; /** 实例相关信息。 */ InstanceInfo?: AuditInstanceInfo; /** 总存储量。 */ RealStorage?: number; /** 实例所应用的规则模板。 */ RuleTemplateIds?: string[]; /** 是否开启日志投递：ON，OFF */ Deliver?: string; /** 日志投递类型 */ DeliverSummary?: DeliverSummary[]; } /** 实例日志投递信息 */ declare interface InstanceCLSDeliveryInfo { /** 实例id */ InstanceId?: string; /** 实例name */ InstanceName?: string; /** 日志主题id */ TopicId?: string; /** 日志主题name */ TopicName?: string; /** 日志集id */ GroupId?: string; /** 日志集name */ GroupName?: string; /** 日志投递地域 */ Region?: string; /** 投递状态creating,running,offlining,offlined */ Status?: string; /** 日志类型 */ LogType?: string; } /** 实例初始化配置信息 */ declare interface InstanceInitInfo { /** 实例cpu */ Cpu: number; /** 实例内存 */ Memory: number; /** 实例类型 rw/ro */ InstanceType: string; /** 实例个数,范围[1,15] */ InstanceCount: number; /** Serverless实例个数最小值，范围[1,15] */ MinRoCount?: number; /** Serverless实例个数最大值，范围[1,15] */ MaxRoCount?: number; /** Serverless实例最小规格 */ MinRoCpu?: number; /** Serverless实例最大规格 */ MaxRoCpu?: number; /** 实例机器类型 */ DeviceType?: string; } /** 实例网络信息 */ declare interface InstanceNetInfo { /** 网络类型 */ InstanceGroupType?: string; /** 实例组ID */ InstanceGroupId?: string; /** 私有网络ID */ VpcId?: string; /** 子网ID */ SubnetId?: string; /** 网络类型, 0-基础网络, 1-vpc网络, 2-黑石网络 */ NetType?: number; /** 私有网络IP */ Vip?: string; /** 私有网络端口 */ Vport?: number; /** 外网域名 */ WanDomain?: string; /** 外网IP */ WanIP?: string; /** 外网端口 */ WanPort?: number; /** 外网开启状态 */ WanStatus?: string; } /** 实例参数信息 */ declare interface InstanceParamItem { /** 实例ID */ InstanceId?: string; /** 实例参数列表 */ ParamsItems?: ParamItemDetail[]; } /** 实例可售卖规格详细信息，创建实例时Cpu/Memory确定实例规格，存储可选大小为[MinStorageSize,MaxStorageSize] */ declare interface InstanceSpec { /** 实例CPU，单位：核 */ Cpu?: number; /** 实例内存，单位：GB */ Memory?: number; /** 实例最大可用存储，单位：GB */ MaxStorageSize?: number; /** 实例最小可用存储，单位：GB */ MinStorageSize?: number; /** 是否有库存 */ HasStock?: boolean; /** 机器类型 */ MachineType?: string; /** 最大IOPS */ MaxIops?: number; /** 最大IO带宽 */ MaxIoBandWidth?: number; /** 地域库存信息 */ ZoneStockInfos?: ZoneStockInfo[]; /** 库存数量 */ StockCount?: number; } /** 审计日志命中规则模板的基本信息 */ declare interface LogRuleTemplateInfo { /** 模板ID */ RuleTemplateId?: string; /** 规则模板名 */ RuleTemplateName?: string; /** 告警等级。1-低风险，2-中风险，3-高风险。 */ AlarmLevel?: string; /** 规则模板变更状态：0-未变更；1-已变更；2-已删除 */ RuleTemplateStatus?: number; } /** 逻辑备份配置信息 */ declare interface LogicBackupConfigInfo { /** 是否开启自动逻辑备份 */ LogicBackupEnable?: string; /** 自动逻辑备份开始时间 */ LogicBackupTimeBeg?: number; /** 自动逻辑备份结束时间 */ LogicBackupTimeEnd?: number; /** 自动逻辑备份保留时间 */ LogicReserveDuration?: number; /** 是否开启跨地域逻辑备份 */ LogicCrossRegionsEnable?: string; /** 逻辑备份所跨地域 */ LogicCrossRegions?: string[] | null; } /** 手动备份任务信息 */ declare interface ManualBackupData { /** 备份类型。snapshot-快照备份 */ BackupType?: string; /** 备份方式。auto-自动备份，manual-手动 */ BackupMethod?: string; /** 备份时间 */ SnapshotTime?: string; /** 跨地域备份项详细信息 */ CrossRegionBackupInfos?: CrossRegionBackupItem[] | null; } /** 参数是否可修改的详细信息 */ declare interface ModifiableInfo { /** 参数是否可被修改, 1:可以 0:不可以 */ IsModifiable?: number; } /** 修改数据库内核版本任务信息 */ declare interface ModifyDbVersionData { /** 修改前版本 */ OldVersion?: string; /** 修改后版本 */ NewVersion?: string; /** 升级方式 */ UpgradeType?: string; } /** 实例变配任务信息 */ declare interface ModifyInstanceData { /** 变配后CPU */ Cpu?: number; /** 变配后内存 */ Memory?: number; /** 变配后存储上限 */ StorageLimit?: number; /** 变配前CPU */ OldCpu?: number; /** 变配前内存 */ OldMemory?: number; /** 变配前存储上限 */ OldStorageLimit?: number; /** 变配前实例机器类型 */ OldDeviceType?: string; /** 变配后实例机器类型 */ DeviceType?: string; /** 升级方式。升级完成后切换或维护时间内切换 */ UpgradeType?: string; /** libra节点数量 */ LibraNodeCount?: number; /** 原libra节点数量 */ OldLibraNodeCount?: number; } /** 修改的实例参数信息 */ declare interface ModifyParamItem { /** 参数名 */ ParamName: string; /** 参数当前值 */ CurrentValue: string; /** 参数旧值（只在出参时有用） */ OldValue?: string; /** libra组件类型 */ Component?: string; } /** 修改参数信息 */ declare interface ModifyParamsData { /** 参数名 */ Name?: string; /** 修改前参数值 */ OldValue?: string; /** 修改后参数值 */ CurValue?: string; } /** 系统支持的模块 */ declare interface Module { /** 是否支持，可选值:yes,no */ IsDisable: string; /** 模块名 */ ModuleName: string; } /** 网络信息 */ declare interface NetAddr { /** 内网ip */ Vip?: string; /** 内网端口号 */ Vport?: number; /** 外网域名 */ WanDomain?: string; /** 外网端口号 */ WanPort?: number; /** 网络类型（ro-只读,rw/ha-读写） */ NetType?: string; /** 子网ID */ UniqSubnetId?: string; /** 私有网络ID */ UniqVpcId?: string; /** 描述信息 */ Description?: string; /** 外网IP */ WanIP?: string; /** 外网状态 */ WanStatus?: string; /** 实例组ID */ InstanceGroupId?: string; } /** x08新创建的账号 */ declare interface NewAccount { /** 账户名，包含字母数字_,以字母开头，字母或数字结尾，长度1-30 */ AccountName: string; /** 密码，密码长度范围为8到64个字符 */ AccountPassword: string; /** 主机(%或ipv4地址) */ Host: string; /** 描述 */ Description?: string; /** 用户最大连接数，不能大于10240 */ MaxUserConnections?: number; } /** 任务信息 */ declare interface ObjectTask { /** 任务自增ID */ TaskId?: number; /** 任务类型 */ TaskType?: string; /** 任务状态 */ TaskStatus?: string; /** 任务ID（集群ID|实例组ID|实例ID） */ ObjectId?: string; /** 任务类型 */ ObjectType?: string; } /** 数据库地址 */ declare interface OldAddrInfo { /** IP */ Vip?: string; /** 端口 */ Vport?: number; /** 期望执行回收时间 */ ReturnTime?: string; } /** 资源包 */ declare interface Package { /** AppID */ AppId?: number; /** 资源包唯一ID */ PackageId?: string; /** 资源包名称 */ PackageName?: string; /** 资源包类型CCU-计算资源包，DISK-存储资源包 */ PackageType?: string; /** 资源包使用地域china-中国内地通用，overseas-港澳台及海外通用 */ PackageRegion?: string; /** 资源包状态creating-创建中；using-使用中；expired-已过期；normal_finish-使用完；apply_refund-申请退费中；refund-已退费。 */ Status?: string; /** 资源包总量 */ PackageTotalSpec?: number; /** 资源包已使用量 */ PackageUsedSpec?: number; /** 是否还有库存余量 */ HasQuota?: boolean; /** 绑定实例信息 */ BindInstanceInfos?: BindInstanceInfo[]; /** 生效时间：2022-07-01 00:00:00 */ StartTime?: string; /** 失效时间：2022-08-01 00:00:00 */ ExpireTime?: string; /** 资源包历史绑定（已解绑）实例信息 */ HistoryBindResourceInfos?: BindInstanceInfo[]; } /** 资源包明细说明 */ declare interface PackageDetail { /** AppId账户ID */ AppId?: number; /** 资源包唯一ID */ PackageId?: string; /** 实例ID */ InstanceId?: string; /** 成功抵扣容量 */ SuccessDeductSpec?: number; /** 截止当前，资源包已使用的容量 */ PackageTotalUsedSpec?: number; /** 抵扣开始时间 */ StartTime?: string; /** 抵扣结束时间 */ EndTime?: string; /** 扩展信息 */ ExtendInfo?: string; } /** 资源包抵扣优先级 */ declare interface PackagePriority { /** 需要自定义抵扣优先级的资源包 */ PackageId?: string; /** 自定义的抵扣优先级 */ DeductionPriority?: number; } /** 实例参数详细描述 */ declare interface ParamDetail { /** 参数名称 */ ParamName?: string; /** 参数类型：integer，enum，float，string，func */ ParamType?: string; /** true-支持"func"，false-不支持公式 */ SupportFunc?: boolean; /** 默认值 */ Default?: string; /** 参数描述 */ Description?: string; /** 参数当前值 */ CurrentValue?: string; /** 修改参数后，是否需要重启数据库以使参数生效。0-不需要重启，1-需要重启。 */ NeedReboot?: number; /** 参数容许的最大值 */ Max?: string; /** 参数容许的最小值 */ Min?: string; /** 参数的可选枚举值。如果为非枚举值，则为空 */ EnumValue?: string[]; /** 1：全局参数，0：非全局参数 */ IsGlobal?: number; /** 匹配类型，multiVal */ MatchType?: string; /** 匹配目标值，当multiVal时，各个key用，分割 */ MatchValue?: string; /** true-为公式，false-非公式 */ IsFunc?: boolean; /** 参数设置为公式时，Func返回设置的公式内容 */ Func?: string; /** 参数是否可修改 */ ModifiableInfo?: ModifiableInfo; /** 支持公式的参数的默认公式样式 */ FuncPattern?: string; } /** 参数信息 */ declare interface ParamInfo { /** 当前值 */ CurrentValue?: string; /** 默认值 */ Default?: string; /** 参数为enum/string/bool时，可选值列表 */ EnumValue?: string[]; /** 参数类型为float/integer时的最大值 */ Max?: string; /** 参数类型为float/integer时的最小值 */ Min?: string; /** 参数名称 */ ParamName?: string; /** 是否需要重启生效 */ NeedReboot?: number; /** 参数类型：integer/float/string/enum/bool */ ParamType?: string; /** 匹配类型，multiVal, regex在参数类型是string时使用 */ MatchType?: string; /** 匹配目标值，当multiVal时，各个key用;分割 */ MatchValue?: string; /** 参数描述 */ Description?: string; /** 是否为全局参数 */ IsGlobal?: number; /** 参数是否可修改 */ ModifiableInfo?: ModifiableInfo; /** 是否为函数 */ IsFunc?: boolean; /** 函数 */ Func?: string; /** 支持公式的参数的默认公式样式 */ FuncPattern?: string; } /** 修改参数时，传入参数描述 */ declare interface ParamItem { /** 参数名称 */ ParamName: string; /** 当前值 */ CurrentValue: string; /** 原有值 */ OldValue: string; } /** 实例参数信息 */ declare interface ParamItemDetail { /** 当前值 */ CurrentValue?: string; /** 默认值 */ Default?: string; /** 参数的可选枚举值。如果为非枚举值，则为空 */ EnumValue?: string[]; /** 1：全局参数，0：非全局参数 */ IsGlobal?: number; /** 最大值 */ Max?: string; /** 最小值 */ Min?: string; /** 修改参数后，是否需要重启数据库以使参数生效。0-不需要重启，1-需要重启。 */ NeedReboot?: number; /** 参数名称 */ ParamName?: string; /** 参数类型：integer，enum，float，string，func */ ParamType?: string; /** 参数描述 */ Description?: string; /** 类型是否为公式 */ IsFunc?: boolean; /** 参数配置公式 */ Func?: string; /** 支持公式的参数的默认公式样式 */ FuncPattern?: string; } /** 参数变化信息 */ declare interface ParamItemInfo { /** 参数名字 */ ParamName?: string; /** 参数新值 */ NewValue?: string; /** 参数旧值 */ OldValue?: string; /** 参数公式 */ ValueFunction?: string; } /** 参数模板信息 */ declare interface ParamTemplateListInfo { /** 参数模板ID */ Id?: number; /** 参数模板名称 */ TemplateName?: string; /** 参数模板描述 */ TemplateDescription?: string; /** 引擎版本 */ EngineVersion?: string; /** 数据库类型，可选值：NORMAL，SERVERLESS */ DbMode?: string; /** 参数模板详情 */ ParamInfoSet?: TemplateParamInfo[] | null; } /** 安全组规则 */ declare interface PolicyRule { /** 策略，ACCEPT或者DROP */ Action?: string; /** 来源Ip或Ip段，例如192.168.0.0/16 */ CidrIp?: string; /** 端口 */ PortRange?: string; /** 网络协议，支持udp、tcp等 */ IpProtocol?: string; /** 协议端口ID或者协议端口组ID。 */ ServiceModule?: string; /** IP地址ID或者ID地址组ID。 */ AddressModule?: string; /** id */ Id?: string; /** 描述 */ Desc?: string; } /** 访问代理配置 */ declare interface ProxyConfig { /** 数据库代理组节点个数。该参数不再建议使用,建议使用ProxyZones */ ProxyCount?: number; /** cpu核数 */ Cpu?: number; /** 内存 */ Mem?: number; /** 连接池类型:SessionConnectionPool(会话级别连接池 ) */ ConnectionPoolType?: string; /** 是否开启连接池,yes-开启，no-不开启 */ OpenConnectionPool?: string; /** 连接池阈值:单位（秒） */ ConnectionPoolTimeOut?: number; /** 描述说明 */ Description?: string; /** 数据库节点信息（该参数与ProxyCount需要任选一个输入） */ ProxyZones?: ProxyZone[]; } /** 数据库代理连接池信息 */ declare interface ProxyConnectionPoolInfo { /** 连接池保持阈值：单位（秒） */ ConnectionPoolTimeOut: number; /** 是否开启了连接池 */ OpenConnectionPool?: string; /** 连接池类型：SessionConnectionPool（会话级别连接池） */ ConnectionPoolType?: string; } /** proxy组 */ declare interface ProxyGroup { /** 数据库代理组ID */ ProxyGroupId?: string; /** 数据库代理组节点个数 */ ProxyNodeCount?: number; /** 数据库代理组状态 */ Status?: string; /** 地域 */ Region?: string; /** 可用区 */ Zone?: string; /** 当前代理版本 */ CurrentProxyVersion?: string; /** 集群ID */ ClusterId?: string; /** 用户AppId */ AppId?: number; /** 读写节点开通数据库代理 */ OpenRw?: string; } /** 数据库代理组详细信息 */ declare interface ProxyGroupInfo { /** 数据库代理组 */ ProxyGroup?: ProxyGroup; /** 数据库代理组读写分离信息 */ ProxyGroupRwInfo?: ProxyGroupRwInfo; /** 数据库代理节点信息 */ ProxyNodes?: ProxyNodeInfo[] | null; /** 数据库代理连接池信息 */ ConnectionPool?: ProxyConnectionPoolInfo; /** 数据库代理网络信息 */ NetAddrInfos?: NetAddr[] | null; /** 数据库代理任务集 */ Tasks?: ObjectTask[]; } /** 数据库代理组读写分离信息 */ declare interface ProxyGroupRwInfo { /** 一致性类型 eventual-最终一致性,global-全局一致性,session-会话一致性 */ ConsistencyType?: string; /** 一致性超时时间 */ ConsistencyTimeOut?: number; /** 权重模式 system-系统分配，custom-自定义 */ WeightMode?: string; /** 是否开启故障转移 */ FailOver?: string; /** 是否自动添加只读实例，yes-是，no-不自动添加 */ AutoAddRo?: string; /** 实例权重数组 */ InstanceWeights?: ProxyInstanceWeight[]; /** 是否开通读写节点，yse-是，no-否 */ OpenRw?: string; /** 读写属性，可选值：READWRITE,READONLY */ RwType?: string; /** 事务拆分 */ TransSplit?: boolean; /** 连接模式，可选值：balance，nearby */ AccessMode?: string; } /** 数据库代理，读写分离实例权重 */ declare interface ProxyInstanceWeight { /** 实例Id */ InstanceId: string; /** 实例权重 */ Weight: number; } /** 数据库代理组节点 */ declare interface ProxyNodeInfo { /** 数据库代理节点ID */ ProxyNodeId?: string; /** 节点当前连接数, DescribeProxyNodes接口此字段值不返回 */ ProxyNodeConnections?: number; /** 数据库代理节点cpu */ Cpu?: number; /** 数据库代理节点内存 */ Mem?: number; /** 数据库代理节点状态 */ Status?: string; /** 数据库代理组ID */ ProxyGroupId?: string; /** 集群ID */ ClusterId?: string; /** 用户AppID */ AppId?: number; /** 地域 */ Region?: string; /** 可用区 */ Zone?: string; /** 数据库代理节点名字 */ OssProxyNodeName?: string; } /** 数据库代理规格 */ declare interface ProxySpec { /** 数据库代理cpu核数 */ Cpu?: number; /** 数据库代理内存 */ Mem?: number; } /** TDSQL-C MySQL支持的proxy版本信息 */ declare interface ProxyVersionInfo { /** proxy版本号 */ ProxyVersion?: string; /** 版本描述：GA:稳定版 BETA:尝鲜版，DEPRECATED:过旧， */ ProxyVersionType?: string; } /** proxy节点可用区内个数 */ declare interface ProxyZone { /** proxy节点可用区 */ ProxyNodeZone?: string; /** proxy节点数量 */ ProxyNodeCount?: number; } /** 查询过滤器 */ declare interface QueryFilter { /** 搜索字符串 */ Values: string[]; /** 搜索字段，目前支持："InstanceId", "ProjectId", "InstanceName", "Vip" */ Names: string[]; /** 是否精确匹配 */ ExactMatch?: boolean; /** 搜索字段 */ Name?: string; /** 操作符 */ Operator?: string; } /** 查询参数过滤器 */ declare interface QueryParamFilter { /** 搜索字段，目前支持："InstanceId", "ProjectId", "InstanceName", "Vip" */ Names: string[]; /** 搜索字符串 */ Values: string[]; /** 是否精确匹配 */ ExactMatch?: boolean; } /** 资源包信息 */ declare interface ResourcePackage { /** 资源包的唯一ID */ PackageId?: string; /** 资源包类型：CCU：计算资源包DISK：存储资源包 */ PackageType?: string; /** 当前资源包绑定在当前实例下的抵扣优先级 */ DeductionPriority?: number; } /** 回档任务信息 */ declare interface RollbackData { /** 实例CPU */ Cpu?: number; /** 实例内存 */ Memory?: number; /** 集群存储上限 */ StorageLimit?: number; /** 原集群id */ OriginalClusterId?: string; /** 原集群名 */ OriginalClusterName?: string; /** 回档方式 */ RollbackStrategy?: string; /** 快照时间 */ SnapshotTime?: string; /** 回档到 Serverless 集群时最小 CPU */ MinCpu?: number; /** 回档到 Serverless 集群时最大 CPU */ MaxCpu?: number; /** 快照ID */ SnapShotId?: number; /** 回档数据库 */ RollbackDatabases?: RollbackDatabase[] | null; /** 回档数据表 */ RollbackTables?: RollbackTable[] | null; /** 备份文件名称 */ BackupFileName?: string; /** 回档进程 */ RollbackProcess?: RollbackProcessInfo; } /** 回滚数据库信息 */ declare interface RollbackDatabase { /** 旧数据库名称 */ OldDatabase: string; /** 新数据库名称 */ NewDatabase: string; } /** 回档实例信息 */ declare interface RollbackInstanceInfo { /** 集群ID */ ClusterId?: string; /** 集群名称 */ ClusterName?: string; /** vpc信息 */ UniqVpcId?: string; /** 子网信息 */ UniqSubnetId?: string; /** vip信息 */ Vip?: string; /** vport信息 */ Vport?: number; /** 实例ID */ InstanceId?: string; /** 实例名称 */ InstanceName?: string; /** 状态 */ Status?: string; /** cpu大小 */ Cpu?: number; /** 内存大小 */ Mem?: number; /** 存储大小 */ StorageLimit?: number; } /** 回档进度详情 */ declare interface RollbackProcessInfo { /** 是否可以交换vip */ IsVipSwitchable?: boolean; /** vip可交换时间 */ VipSwitchableTime?: string; /** 交换实例列表 */ ExchangeInstanceInfoList?: ExchangeInstanceInfo[] | null; /** 交换RO组列表 */ ExchangeRoGroupInfoList?: ExchangeRoGroupInfo[] | null; /** 当前步骤 */ CurrentStep?: string; /** 当前步骤进度 */ CurrentStepProgress?: number; /** 当前步骤剩余时间 */ CurrentStepRemainingTime?: string; } /** 回档RO组信息 */ declare interface RollbackRoGroupInfo { /** 实例组ID */ InstanceGroupId?: string; /** vpc信息 */ UniqVpcId?: string; /** 子网信息 */ UniqSubnetId?: string; /** vip信息 */ Vip?: string; /** vport信息 */ Vport?: number; } /** 回档数据库及表 */ declare interface RollbackTable { /** 数据库名称 */ Database: string; /** 数据库表 */ Tables: RollbackTableInfo[]; } /** 回档表信息 */ declare interface RollbackTableInfo { /** 旧表名称 */ OldTable: string; /** 新表名称 */ NewTable: string; } /** 可回档的时间范围 */ declare interface RollbackTimeRange { /** 开始时间 */ TimeRangeStart?: string; /** 结束时间 */ TimeRangeEnd?: string; } /** 审计规则的规则过滤条件 */ declare interface RuleFilters { /** 审计规则过滤条件的参数名称。可选值：host – 客户端 IP；user – 数据库账户；dbName – 数据库名称；sqlType-SQL类型；sql-sql语句；affectRows -影响行数；sentRows-返回行数；checkRows-扫描行数；execTime-执行时间。 */ Type: string; /** 审计规则过滤条件的匹配类型。可选值：INC – 包含；EXC – 不包含；EQS – 等于；NEQ – 不等于；REG-正则；GT-大于；LT-小于。 */ Compare: string; /** 审计规则过滤条件的匹配值。 */ Value: string[]; } /** 规则模板内容 */ declare interface RuleTemplateInfo { /** 规则模板ID。 */ RuleTemplateId?: string; /** 规则模板名称。 */ RuleTemplateName?: string; /** 规则内容。 */ RuleFilters?: RuleFilters[]; /** 告警等级。1-低风险，2-中风险，3-高风险。 */ AlarmLevel?: number; /** 告警策略。0-不告警，1-告警。 */ AlarmPolicy?: number; /** 规则描述。 */ Description?: string; } /** 资源包明细说明 */ declare interface SalePackageSpec { /** 资源包使用地域 */ PackageRegion?: string; /** 资源包类型CCU-计算资源包DISK-存储资源包 */ PackageType?: string; /** 资源包版本base-基础版本，common-通用版本，enterprise-企业版本 */ PackageVersion?: string; /** 当前版本资源包最小资源数，计算资源单位：个；存储资源：GB */ MinPackageSpec?: number; /** 当前版本资源包最大资源数，计算资源单位：个；存储资源：GB */ MaxPackageSpec?: number; /** 资源包有效期，单位:天 */ ExpireDay?: number; } /** 售卖地域信息 */ declare interface SaleRegion { /** 地域英文名 */ Region: string; /** 地域数字ID */ RegionId: number; /** 地域中文名 */ RegionZh: string; /** 可售卖可用区列表 */ ZoneSet: SaleZone[]; /** 引擎类型 */ DbType: string; /** 地域模块支持情况 */ Modules: Module[]; } /** 售卖可用区信息 */ declare interface SaleZone { /** 可用区英文名 */ Zone?: string; /** 可用区数字ID */ ZoneId?: number; /** 可用区中文名 */ ZoneZh?: string; /** 是否支持serverless集群0:不支持1:支持 */ IsSupportServerless?: number; /** 是否支持普通集群0:不支持1:支持 */ IsSupportNormal?: number; /** 物理区 */ PhysicalZone?: string; /** 用户是否有可用区权限 */ HasPermission?: boolean; /** 是否为全链路RDMA可用区 */ IsWholeRdmaZone?: string; /** 当前可用区是否允许新购集群，1:允许，0:不允许 */ IsSupportCreateCluster?: number; } /** 安全组详情 */ declare interface SecurityGroup { /** 项目ID */ ProjectId?: number; /** 创建时间，时间格式：yyyy-mm-dd hh:mm:ss */ CreateTime?: string; /** 入站规则 */ Inbound?: PolicyRule[]; /** 出站规则 */ Outbound?: PolicyRule[]; /** 安全组ID */ SecurityGroupId?: string; /** 安全组名称 */ SecurityGroupName?: string; /** 安全组备注 */ SecurityGroupRemark?: string; } /** serverless规格 */ declare interface ServerlessSpec { /** cpu最小值 */ MinCpu?: number; /** cpu最大值 */ MaxCpu?: number; /** 最大存储空间 */ MaxStorageSize?: number; /** 是否为默认规格 */ IsDefault?: number; /** 是否有库存 */ HasStock?: boolean; /** 库存数量 */ StockCount?: number; /** 可用区库存信息 */ ZoneStockInfos?: ServerlessZoneStockInfo[] | null; } /** serverless类型的可用区库存信息 */ declare interface ServerlessZoneStockInfo { /** 可用区 */ Zone?: string; /** 存储量 */ StockCount?: number; /** 是否包含库存 */ HasStock?: boolean; /** 从可用区库存信息 */ SlaveZoneStockInfos?: SlaveZoneStockInfo[]; } /** 可用区属性项 */ declare interface SlaveZoneAttrItem { /** 可用区 */ Zone?: string; /** binlog同步方式 */ BinlogSyncWay?: string; /** 半同步超时时间，单位ms */ SemiSyncTimeout?: number; } /** 备可用区库存信息 */ declare interface SlaveZoneStockInfo { /** 备可用区 */ SlaveZone?: string; /** 备可用区的库存数量 */ StockCount?: number; /** 备可用区是否有库存 */ HasStock?: boolean; } /** 实例慢查询信息 */ declare interface SlowQueriesItem { /** 执行时间戳 */ Timestamp?: number; /** 执行时长，单位秒 */ QueryTime?: number; /** sql语句 */ SqlText?: string; /** 客户端host */ UserHost?: string; /** 用户名 */ UserName?: string; /** 数据库名 */ Database?: string; /** 锁时长，单位秒 */ LockTime?: number; /** 扫描行数 */ RowsExamined?: number; /** 返回行数 */ RowsSent?: number; /** sql模板 */ SqlTemplate?: string; /** sql语句md5 */ SqlMd5?: string; /** 远程读取次数数据库内核版本大于3.1.12 */ SyncReadCountRemote?: number; /** 远程读取的字节数数据库内核版本大于3.1.12 */ SyncReadBytesRemote?: number; /** 远程读取所花费的时间（微秒）数据库内核版本大于3.1.12 */ SyncReadTimeRemote?: number; /** 远程写入次数数据库内核版本大于3.1.12 */ SyncWriteCountRemote?: number; /** 远程写入的字节数。数据库内核版本大于3.1.12 */ SyncWriteBytesRemote?: number; /** 远程写入所花费的时间（微秒）。数据库内核版本大于3.1.12 */ SyncWriteTimeRemote?: number; /** 事务提交延迟（微秒）数据库内核版本大于3.1.12 */ TrxCommitDelay?: number; } /** 转换集群log bin开关 */ declare interface SwitchClusterLogBin { /** 状态 */ Status?: string; } /** mysql表权限 */ declare interface TablePrivileges { /** 数据库名 */ Db: string; /** 表名 */ TableName: string; /** 权限列表 */ Privileges: string[]; } /** 集群绑定的标签信息，包含标签键TagKey和标签值TagValue */ declare interface Tag { /** 标签键 */ TagKey: string; /** 标签值 */ TagValue: string; } /** TaskMaintainInfo */ declare interface TaskMaintainInfo { /** 执行开始时间(距离0点的秒数) */ MaintainStartTime?: number; /** 持续的时间(单位：秒) */ MaintainDuration?: number; /** 可以执行的时间，枚举值：["Mon","Tue","Wed","Thu","Fri", "Sat", "Sun"] */ MaintainWeekDays?: string[]; } /** 任务进度查询 */ declare interface TaskProgressInfo { /** 当前步骤 */ CurrentStep?: string; /** 当前进度 */ CurrentStepProgress?: number; /** 预估时间 */ CurrentStepRemainingTime?: string; } /** 参数模板详情 */ declare interface TemplateParamInfo { /** 当前值 */ CurrentValue?: string; /** 默认值 */ Default?: string; /** 参数类型为enum时可选的值类型集合 */ EnumValue?: string[]; /** 参数类型为float/integer时的最大值 */ Max?: string; /** 参数类型为float/integer时的最小值 */ Min?: string; /** 参数名称 */ ParamName?: string; /** 是否需要重启 */ NeedReboot?: number; /** 参数描述 */ Description?: string; /** 参数类型，integer/float/string/enum */ ParamType?: string; } /** 计费询价结果 */ declare interface TradePrice { /** 预付费模式下资源总价，不包含优惠，单位:分 */ TotalPrice?: number; /** 总的折扣，100表示100%不打折 */ Discount?: number; /** 预付费模式下的优惠后总价, 单位: 分,例如用户享有折扣 =TotalPrice × Discount */ TotalPriceDiscount?: number; /** 后付费模式下的单位资源价格，不包含优惠，单位:分 */ UnitPrice?: number; /** 优惠后后付费模式下的单位资源价格, 单位: 分,例如用户享有折扣=UnitPricet × Discount */ UnitPriceDiscount?: number; /** 计费价格单位 */ ChargeUnit?: string; } /** 添加实例或者变配实例时同步升级proxy. */ declare interface UpgradeProxy { /** cpu */ Cpu: number; /** memory */ Mem: number; /** 代理节点信息 */ ProxyZones: ProxyZone[]; /** 重新负载均衡 */ ReloadBalance?: string; } /** 用户主机权限 */ declare interface UserHostPrivilege { /** 授权用户 */ DbUserName: string; /** 客户端ip */ DbHost: string; /** 用户权限 */ DbPrivilege: string; } /** 可用区库存信息 */ declare interface ZoneStockInfo { /** 可用区 */ Zone?: string; /** 是否有库存 */ HasStock?: boolean; /** 库存数量 */ StockCount?: number; /** 备可用区库存信息 */ SlaveZoneStockInfos?: SlaveZoneStockInfo[]; } declare interface ActivateInstanceRequest { /** 集群ID */ ClusterId: string; /** 实例 ID 列表，单个实例 ID 格式如：cynosdbmysql-ins-n7ocdslw，与TDSQL-C MySQL数据库控制台页面中显示的实例 ID 相同，可使用查询实例列表接口获取，其值为输出参数中字段 InstanceId 的值。 */ InstanceIdList: string[]; } declare interface ActivateInstanceResponse { /** 任务流id */ FlowId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface AddClusterSlaveZoneRequest { /** 集群ID */ ClusterId: string; /** 从可用区 */ SlaveZone: string; /** binlog同步方式。默认值：async。可选值：sync、semisync、async */ BinlogSyncWay?: string; /** 半同步超时时间，单位ms。为保证业务稳定性，半同步复制存在退化逻辑，当主可用区集群在等待备可用区集群确认事务时若超过该超时时间，复制方式将降为异步复制。最低设置为1000ms，最高支持4294967295ms，默认10000ms。 */ SemiSyncTimeout?: number; } declare interface AddClusterSlaveZoneResponse { /** 异步FlowId */ FlowId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface AddInstancesRequest { /** 集群ID */ ClusterId: string; /** Cpu核数 */ Cpu: number; /** 内存，单位为GB */ Memory: number; /** 新增只读实例数，取值范围为(0,15] */ ReadOnlyCount: number; /** 实例机器类型 */ DeviceType?: string; /** 实例组ID，在已有RO组中新增实例时使用，不传则新增RO组。当前版本不建议传输该值。 */ InstanceGrpId?: string; /** 所属VPC网络ID。 */ VpcId?: string; /** 所属子网ID，如果设置了VpcId，则SubnetId必填。 */ SubnetId?: string; /** 新增RO组时使用的Port，取值范围为[