tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,104 lines (1,968 loc) • 283 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 数据库账号信息 */
declare interface Account {
/** 账号名,可输入1 - 32个字符。 */
User: string;
/** 账号的主机。说明:1. IP 形式,支持填入%。2. 多个主机以分隔符分隔,分隔符支持;,|换行符和空格。 */
Host: string;
}
/** 账号详细信息 */
declare interface AccountInfo {
/** 账号备注信息 */
Notes?: string;
/** 账号的域名 */
Host?: string;
/** 账号的名称 */
User?: string;
/** 账号信息修改时间 */
ModifyTime?: string;
/** 修改密码的时间 */
ModifyPasswordTime?: string;
/** 该值已废弃 */
CreateTime?: string;
/** 用户最大可用实例连接数 */
MaxUserConnections?: number;
/** 用户账号是否开启了密码轮转 */
OpenCam?: boolean;
}
/** 实例地址信息 */
declare interface AddressInfo {
/** 地址的资源id标识。 */
ResourceId?: string;
/** 地址所在的vpc。 */
UniqVpcId?: string;
/** 地址所在的子网。 */
UniqSubnetId?: string;
/** 地址的vip。 */
Vip?: string;
/** 地址的端口。 */
VPort?: number;
/** 外网地址域名。 */
WanDomain?: string;
/** 外网地址端口。 */
WanPort?: number;
}
/** 审计日志聚合条件 */
declare interface AggregationCondition {
/** 聚合字段。目前仅支持host-源IP、user-用户名、dbName-数据库名、sqlType-sql类型。 */
AggregationField: string;
/** 偏移量。 */
Offset?: number;
/** 该聚合字段下要返回聚合桶的数量,最大100。 */
Limit?: number;
}
/** 分析引擎节点信息 */
declare interface AnalysisNodeInfo {
/** 节点ID */
NodeId?: string;
/** 节点状态 */
Status?: string;
/** 数据加载状态 */
DataStatus?: string;
/** cpu核数,单位:核 */
Cpu?: number;
/** 内存大小,单位: MB */
Memory?: number;
/** 磁盘大小,单位:GB */
Storage?: number;
/** 节点所在可用区 */
Zone?: string;
/** 数据同步错误信息 */
Message?: string;
}
/** 审计规则过滤条件 */
declare interface AuditFilter {
/** 过滤条件参数名称。目前支持:SrcIp – 客户端 IP;User – 数据库账户;DB – 数据库名称; */
Type: string;
/** 过滤条件匹配类型。目前支持:INC – 包含;EXC – 不包含;EQ – 等于;NEQ – 不等于; */
Compare: string;
/** 过滤条件匹配值。 */
Value: string;
}
/** 查询审计实例的过滤条件 */
declare interface AuditInstanceFilters {
/** 过滤条件名。支持InstanceId-实例ID,InstanceName-实例名称,ProjectId-项目ID,TagKey-标签键,Tag-标签(以竖线分割,例:Tagkey|Tagvalue)。 */
Name: string | null;
/** true表示精确查找,false表示模糊匹配。 */
ExactMatch: boolean | null;
/** 筛选值 */
Values: string[] | null;
}
/** 审计实例详情 */
declare interface AuditInstanceInfo {
/** 项目ID */
ProjectId?: number;
/** 标签信息 */
TagList?: TagInfoUnit[];
/** 数据库内核类型 */
DbType?: string;
/** 数据库内核版本 */
DbVersion?: string;
}
/** 审计日志详细信息 */
declare interface AuditLog {
/** 影响行数。 */
AffectRows?: number;
/** 错误码。 */
ErrCode?: number;
/** SQL 类型。 */
SqlType?: 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;
/** 开始时间,与timestamp构成一个精确到纳秒的时间。 */
NsTime?: number;
/** 事物持续时间,微秒。 */
TrxLivingTime?: number;
/** 日志命中规则模板的基本信息 */
TemplateInfo?: LogRuleTemplateInfo[];
/** 事务ID */
TrxId?: number;
}
/** 审计日志分析结果 */
declare interface AuditLogAggregationResult {
/** 聚合维度 */
AggregationField?: string;
/** 聚合桶的结果集 */
Buckets?: Bucket[];
}
/** 审计日志文件 */
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;
}
/** 审计日志过滤条件。查询审计日志时,用户过滤返回的审计日志。 */
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[];
/** 影响行数,格式为M-N,例如:10-200 */
AffectRowsSection?: string;
/** 返回行数,格式为M-N,例如:10-200 */
SentRowsSection?: string;
/** 执行时间,格式为M-N,例如:10-200 */
ExecTimeSection?: string;
/** 锁等待时间,格式为M-N,例如:10-200 */
LockWaitTimeSection?: string;
/** IO等待时间,格式为M-N,例如:10-200 */
IoWaitTimeSection?: string;
/** 事务持续时间,格式为M-N,例如:10-200 */
TransactionLivingTimeSection?: string;
/** 线程ID */
ThreadId?: string[];
/** 返回行数。表示筛选返回行数大于该值的审计日志。 */
SentRows?: number;
/** mysql错误码 */
ErrCode?: number[];
}
/** 审计策略 */
declare interface AuditPolicy {
/** 审计策略 ID。 */
PolicyId?: string;
/** 审计策略的状态。可能返回的值为:"creating" - 创建中;"running" - 运行中;"paused" - 暂停中;"failed" - 创建失败。 */
Status?: string;
/** 数据库实例 ID。 */
InstanceId?: string;
/** 审计策略创建时间。格式为 : "2019-03-20 17:09:13"。 */
CreateTime?: string;
/** 审计策略最后修改时间。格式为 : "2019-03-20 17:09:13"。 */
ModifyTime?: string;
/** 审计策略名称。 */
PolicyName?: string;
/** 审计规则 ID。 */
RuleId?: string;
/** 审计规则名称。 */
RuleName?: string;
/** 数据库实例名称 */
InstanceName?: string;
}
/** 审计规则 */
declare interface AuditRule {
/** 审计规则 Id。 */
RuleId?: string;
/** 审计规则创建时间。格式为 : "2019-03-20 17:09:13"。 */
CreateTime?: string;
/** 审计规则最后修改时间。格式为 : "2019-03-20 17:09:13"。 */
ModifyTime?: string;
/** 审计规则名称。 */
RuleName?: string | null;
/** 审计规则描述。 */
Description?: string | null;
/** 审计规则过滤条件。 */
RuleFilters?: AuditFilter[] | null;
/** 是否开启全审计。 */
AuditAll?: boolean;
}
/** 审计规则的过滤条件 */
declare interface AuditRuleFilters {
/** 单条审计规则。 */
RuleFilters?: RuleFilters[];
}
/** 审计规则模板的详情 */
declare interface AuditRuleTemplateInfo {
/** 规则模板ID。 */
RuleTemplateId?: string;
/** 规则模板名称。 */
RuleTemplateName?: string;
/** 规则模板的过滤条件。 */
RuleFilters?: RuleFilters[];
/** 规则模板描述。 */
Description?: string;
/** 规则模板创建时间。 */
CreateAt?: string;
/** 告警等级。1-低风险,2-中风险,3-高风险。 */
AlarmLevel?: number;
/** 告警策略。0-不告警,1-告警。 */
AlarmPolicy?: number;
/** 规则模板应用在哪些在实例。 */
AffectedInstances?: string[];
/** 模板状态。0-无任务 ,1-修改中。 */
Status?: number;
/** 模板更新时间。 */
UpdateAt?: string;
}
/** CPU 弹性扩容的自动扩容策略。 */
declare interface AutoStrategy {
/** 自动扩容阈值,可选值40、50、60、70、80、90,代表 CPU 利用率达到40%、50%、60%、70%、80%、90%时后台进行自动扩容。 */
ExpandThreshold: number;
/** 自动缩容阈值,可选值10、20、30,代表CPU利用率达到10%、20%、30%时后台进行自动缩容 */
ShrinkThreshold: number;
/** 自动扩容观测周期,单位是分钟,可选值1、3、5、10、15、30。后台会按照配置的周期进行扩容判断。 */
ExpandPeriod?: number | null;
/** 自动缩容观测周期,单位是分钟,可选值5、10、15、30。后台会按照配置的周期进行缩容判断。 */
ShrinkPeriod?: number | null;
/** 弹性扩容观测周期(秒级),可取值为:15,30,45,60,180,300,600,900,1800。 */
ExpandSecondPeriod?: number;
/** 缩容观测周期(秒级),可取值为:300、600、900、1800。 */
ShrinkSecondPeriod?: number;
}
/** ECDB第二个从库的配置信息,只有ECDB实例才有这个字段 */
declare interface BackupConfig {
/** 第二个从库复制方式,可能的返回值:async-异步,semisync-半同步 */
ReplicationMode?: string;
/** 第二个从库可用区的正式名称,如ap-shanghai-1 */
Zone?: string;
/** 第二个从库内网IP地址 */
Vip?: string;
/** 第二个从库访问端口 */
Vport?: number;
}
/** 备份详细信息 */
declare interface BackupInfo {
/** 备份文件名 */
Name?: string;
/** 备份文件大小,单位:Byte */
Size?: number;
/** 备份快照时间,时间格式:2016-03-17 02:10:37 */
Date?: string;
/** 下载地址 */
IntranetUrl?: string;
/** 下载地址 */
InternetUrl?: string;
/** 日志具体类型。可能的值有 "logical": 逻辑冷备, "physical": 物理冷备。 */
Type?: string;
/** 备份子任务的ID,删除备份文件时使用 */
BackupId?: number;
/** 备份任务状态。可能的值有 "SUCCESS": 备份成功, "FAILED": 备份失败, "RUNNING": 备份进行中。 */
Status?: string;
/** 备份任务的完成时间 */
FinishTime?: string;
/** (该值将废弃,不建议使用)备份的创建者,可能的值:SYSTEM - 系统创建,Uin - 发起者Uin值。 */
Creator?: string;
/** 备份任务的开始时间 */
StartTime?: string;
/** 备份方法。可能的值有 "full": 全量备份, "partial": 部分备份。 */
Method?: string;
/** 备份方式。可能的值有 "manual": 手动备份, "automatic": 自动备份。 */
Way?: string;
/** 手动备份别名 */
ManualBackupName?: string;
/** 备份保留类型,save_mode_regular - 常规保存备份,save_mode_period - 定期保存备份 */
SaveMode?: string;
/** 本地备份所在地域 */
Region?: string;
/** 异地备份详细信息 */
RemoteInfo?: RemoteBackupInfo[];
/** 存储方式,0-常规存储,1-归档存储,2-标准存储,默认为0 */
CosStorageType?: number;
/** 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。 */
InstanceId?: string;
/** 备份文件是否加密, on-加密, off-未加密 */
EncryptionFlag?: string;
/** 备份GTID点位 */
ExecutedGTIDSet?: string;
/** 备份文件MD5值 */
MD5?: string;
}
/** 创建备份时,指定需要备份的库表信息 */
declare interface BackupItem {
/** 需要备份的库名 */
Db: string;
/** 需要备份的表名。 如果传该参数,表示备份该库中的指定表。如果不传该参数则备份该db库 */
Table?: string;
}
/** 备份文件限制下载来源VPC设置项 */
declare interface BackupLimitVpcItem {
/** 限制下载来源的地域。目前仅支持当前地域。 */
Region: string;
/** 限制下载的vpc列表。 */
VpcList: string[];
}
/** 实例备份统计项 */
declare interface BackupSummaryItem {
/** 实例ID。 */
InstanceId?: string;
/** 该实例自动数据备份的个数。 */
AutoBackupCount?: number;
/** 该实例自动数据备份的容量。 */
AutoBackupVolume?: number;
/** 该实例手动数据备份的个数。 */
ManualBackupCount?: number;
/** 该实例手动数据备份的容量。 */
ManualBackupVolume?: number;
/** 该实例总的数据备份(包含自动备份和手动备份)个数。 */
DataBackupCount?: number;
/** 该实例总的数据备份容量。 */
DataBackupVolume?: number;
/** 该实例日志备份的个数。 */
BinlogBackupCount?: number;
/** 该实例日志备份的容量。 */
BinlogBackupVolume?: number;
/** 该实例的总备份(包含数据备份和日志备份)占用容量。 */
BackupVolume?: number;
}
/** 二进制日志信息 */
declare interface BinlogInfo {
/** binlog 日志备份文件名 */
Name?: string;
/** 备份文件大小,单位:Byte */
Size?: number;
/** 文件存储时间,时间格式:2016-03-17 02:10:37 */
Date?: string;
/** 下载地址说明:此下载地址和参数 InternetUrl 的下载地址一样。 */
IntranetUrl?: string;
/** 下载地址说明:此下载地址和参数 IntranetUrl 的下载地址一样。 */
InternetUrl?: string;
/** 日志具体类型,可能的值有:binlog - 二进制日志 */
Type?: string;
/** binlog 文件起始时间 */
BinlogStartTime?: string;
/** binlog 文件截止时间 */
BinlogFinishTime?: string;
/** 本地binlog文件所在地域 */
Region?: string;
/** 备份任务状态。可能的值有 "SUCCESS": 备份成功, "FAILED": 备份失败, "RUNNING": 备份进行中。 */
Status?: string;
/** binlog异地备份详细信息 */
RemoteInfo?: RemoteBackupInfo[];
/** 存储方式,0-常规存储,1-归档存储,2-标准存储,默认为0 */
CosStorageType?: number;
/** 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。 */
InstanceId?: string;
}
/** 聚合桶的信息 */
declare interface Bucket {
/** 无 */
Key?: string;
/** key值出现的次数。 */
Count?: number;
}
/** 地域售卖配置 */
declare interface CdbRegionSellConf {
/** 地域中文名称 */
RegionName: string;
/** 所属大区 */
Area: string;
/** 是否为默认地域 */
IsDefaultRegion: number;
/** 地域名称 */
Region: string;
/** 地域的可用区售卖配置 */
RegionConfig: CdbZoneSellConf[];
}
/** 售卖配置详情 */
declare interface CdbSellConfig {
/** 内存大小,单位为MB */
Memory?: number;
/** CPU核心数 */
Cpu?: number;
/** 磁盘最小规格,单位为GB */
VolumeMin?: number;
/** 磁盘最大规格,单位为GB */
VolumeMax?: number;
/** 磁盘步长,单位为GB */
VolumeStep?: number;
/** 每秒IO数量 */
Iops?: number;
/** 应用场景描述 */
Info?: string;
/** 状态值,0 表示该规格对外售卖 */
Status?: number;
/** 实例类型,可能的取值范围有:UNIVERSAL (通用型), EXCLUSIVE (独享型), BASIC (基础型), BASIC_V2 (基础型v2) */
DeviceType?: string;
/** 引擎类型描述,可能的取值范围有:Innodb,RocksDB */
EngineType?: string;
/** 售卖规格Id */
Id?: number;
}
/** 售卖实例类型 */
declare interface CdbSellType {
/** 售卖实例名称。Z3是高可用类型对应规格中的DeviceType包含UNIVERSAL,EXCLUSIVE;CVM是基础版类型对应规格中的DeviceType是BASIC;TKE是基础型v2类型对应规格中的DeviceType是BASIC_V2。 */
TypeName: string;
/** 引擎版本号 */
EngineVersion: string[];
/** 售卖规格Id */
ConfigIds: number[];
}
/** 各地域可售卖的规格配置 */
declare interface CdbZoneDataResult {
/** 售卖规格所有集合 */
Configs: CdbSellConfig[];
/** 售卖地域可用区集合 */
Regions: CdbRegionSellConf[];
}
/** 可用区售卖配置 */
declare interface CdbZoneSellConf {
/** 可用区状态。可能的返回值为:1-上线;3-停售;4-不展示 */
Status?: number;
/** 可用区中文名称 */
ZoneName?: string;
/** 实例类型是否为自定义类型 */
IsCustom?: boolean;
/** 是否支持灾备 */
IsSupportDr?: boolean;
/** 是否支持私有网络 */
IsSupportVpc?: boolean;
/** 小时计费实例最大售卖数量 */
HourInstanceSaleMaxNum?: number;
/** 是否为默认可用区 */
IsDefaultZone?: boolean;
/** 是否为黑石区 */
IsBm?: boolean;
/** 支持的付费类型。可能的返回值为:0-包年包月;1-小时计费;2-后付费 */
PayType?: string[];
/** 数据复制类型。0-异步复制;1-半同步复制;2-强同步复制 */
ProtectMode?: string[];
/** 可用区名称 */
Zone?: string;
/** 多可用区信息 */
ZoneConf?: ZoneConf;
/** 可支持的灾备可用区信息 */
DrZone?: string[];
/** 是否支持跨可用区只读 */
IsSupportRemoteRo?: boolean;
/** 可支持的跨可用区只读区信息 */
RemoteRoZone?: string[];
/** 独享型可用区状态。可能的返回值为:1-上线;3-停售;4-不展示 */
ExClusterStatus?: number;
/** 独享型可支持的跨可用区只读区信息 */
ExClusterRemoteRoZone?: string[];
/** 独享型多可用区信息 */
ExClusterZoneConf?: ZoneConf;
/** 售卖实例类型数组,其中configIds的值与configs结构体中的id一一对应。 */
SellType?: CdbSellType[];
/** 可用区id */
ZoneId?: number;
/** 是否支持ipv6 */
IsSupportIpv6?: boolean;
/** 可支持的售卖数据库引擎类型 */
EngineType?: string[];
/** 集群版实例在当前可用区的售卖状态。可能的返回值为:1-上线;3-停售;4-不展示 */
CloudNativeClusterStatus?: number;
/** 集群版或者单节点基础型支持的磁盘类型。 */
DiskTypeConf?: DiskTypeConfigItem[];
}
/** 迁移集群版校验结果 */
declare interface CheckMigrateResult {
/** 校验名称 */
Name?: string;
/** 校验结果,通过为pass,失败为fail */
Status?: string;
/** 校验结果描述 */
Desc?: string;
}
/** 克隆任务记录。 */
declare interface CloneItem {
/** 克隆任务的源实例Id。 */
SrcInstanceId?: string;
/** 克隆任务的新产生实例Id。 */
DstInstanceId?: string;
/** 克隆任务对应的任务列表Id。 */
CloneJobId?: number;
/** 克隆实例使用的策略, 包括以下类型: timepoint:指定时间点回档, backupset: 指定备份文件回档。 */
RollbackStrategy?: string;
/** 克隆实例回档的时间点。 */
RollbackTargetTime?: string;
/** 任务开始时间。 */
StartTime?: string;
/** 任务结束时间。 */
EndTime?: string;
/** 任务状态,包括以下状态:initial,running,wait_complete,success,failed */
TaskStatus?: string;
/** 克隆实例所在地域Id */
NewRegionId?: number;
/** 源实例所在地域Id */
SrcRegionId?: number;
}
/** 集群版节点信息 */
declare interface ClusterInfo {
/** 节点id */
NodeId?: string;
/** 节点类型:主节点,从节点 */
Role?: string;
/** 地域 */
Zone?: string;
}
/** 集群版实例节点信息 */
declare interface ClusterNodeInfo {
/** 节点id。 */
NodeId?: string;
/** 节点的角色。 */
Role?: string;
/** 节点所在可用区。 */
Zone?: string;
/** 节点的权重 */
Weight?: number;
/** 节点状态。 */
Status?: string;
}
/** 集群版的节点拓扑配置。 */
declare interface ClusterTopology {
/** RW 节点拓扑。说明:NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。 */
ReadWriteNode?: ReadWriteNode;
/** RO 节点拓扑。说明:NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。 */
ReadOnlyNodes?: ReadonlyNode[];
}
/** 列权限信息 */
declare interface ColumnPrivilege {
/** 数据库名 */
Database: string;
/** 数据库表名 */
Table: string;
/** 数据库列名 */
Column: string;
/** 权限信息 */
Privileges: string[];
}
/** 通用时间窗 */
declare interface CommonTimeWindow {
/** 周一的时间窗,格式如: 02:00-06:00 */
Monday?: string;
/** 周二的时间窗,格式如: 02:00-06:00 */
Tuesday?: string;
/** 周三的时间窗,格式如: 02:00-06:00 */
Wednesday?: string;
/** 周四的时间窗,格式如: 02:00-06:00 */
Thursday?: string;
/** 周五的时间窗,格式如: 02:00-06:00 */
Friday?: string;
/** 周六的时间窗,格式如: 02:00-06:00 */
Saturday?: string;
/** 周日的时间窗,格式如: 02:00-06:00 */
Sunday?: string;
/** 常规备份保留策略,weekly-按周备份,monthly-按月备份,默认为weekly */
BackupPeriodStrategy?: string;
/** 如果设置为按月备份,需填入每月具体备份日期,相邻备份天数不得超过两天。例[1,4,7,9,11,14,17,19,22,25,28,30,31] */
Days?: number[];
/** 月度备份时间窗,BackupPeriodStrategy为monthly时必填。格式如: 02:00-06:00 */
BackupPeriodTime?: string;
}
/** proxy配置 */
declare interface CustomConfig {
/** 设备 */
Device?: string;
/** 类型 */
Type?: string;
/** 设备类型 */
DeviceType?: string;
/** 内存,单位为MB */
Memory?: number;
/** 核数 */
Cpu?: number;
}
/** 云数据库切换记录 */
declare interface DBSwitchInfo {
/** 切换时间,格式为:2017-09-03 01:34:31 */
SwitchTime?: string;
/** 切换类型,可能的返回值为:TRANSFER - 数据迁移;MASTER2SLAVE - 主备切换;RECOVERY - 主从恢复 */
SwitchType?: string;
}
/** 数据库权限 */
declare interface DatabasePrivilege {
/** 权限信息 */
Privileges: string[];
/** 数据库名 */
Database: string;
}
/** 数据库名以及字符集 */
declare interface DatabasesWithCharacterLists {
/** 数据库名 */
DatabaseName?: string;
/** 字符集类型 */
CharacterSet?: string;
}
/** 置放群组信息 */
declare interface DeployGroupInfo {
/** 置放群组 ID。 */
DeployGroupId?: string;
/** 置放群组名称。 */
DeployGroupName?: string;
/** 创建时间。 */
CreateTime?: string;
/** 置放群组实例配额,表示一个置放群组中可容纳的最大实例数目。 */
Quota?: number;
/** 置放群组亲和性策略,目前仅支持策略1,即在物理机纬度打散实例的分布。 */
Affinity?: string;
/** 置放群组亲和性策略1中,同台物理机上同个置放群组实例的限制个数。 */
LimitNum?: number;
/** 置放群组详细信息。 */
Description?: string;
/** 置放群组物理机型属性。 */
DevClass?: string;
}
/** CPU负载 */
declare interface DeviceCpuInfo {
/** 实例CPU平均使用率 */
Rate?: DeviceCpuRateInfo[];
/** 实例CPU监控数据 */
Load?: number[];
}
/** 实例CPU平均使用率 */
declare interface DeviceCpuRateInfo {
/** Cpu核编号 */
CpuCore?: number;
/** Cpu使用率 */
Rate?: number[];
}
/** 实例磁盘监控数据 */
declare interface DeviceDiskInfo {
/** 平均每秒有百分之几的时间用于IO操作 */
IoRatioPerSec?: number[];
/** 平均每次设备I/O操作的等待时间*100,单位为毫秒。例如:该值为201,表示平均每次I/O操作等待时间为:201/100=2.1毫秒 */
IoWaitTime?: number[];
/** 磁盘平均每秒完成的读操作次数总和*100。例如:该值为2002,表示磁盘平均每秒完成读操作为:2002/100=20.2次 */
Read?: number[];
/** 磁盘平均每秒完成的写操作次数总和*100。例如:该值为30001,表示磁盘平均每秒完成写操作为:30001/100=300.01次 */
Write?: number[];
/** 磁盘空间容量,每两个一组,第一个为已使用容量,第二个为磁盘总容量 */
CapacityRatio?: number[];
}
/** 实例所在物理机内存监控信息 */
declare interface DeviceMemInfo {
/** 总内存大小。free命令中Mem:一行total的值,单位:KB */
Total?: number[];
/** 已使用内存。free命令中Mem:一行used的值,单位:KB */
Used?: number[];
}
/** 实例所在物理机网络监控信息 */
declare interface DeviceNetInfo {
/** tcp连接数 */
Conn?: number[];
/** 网卡入包量,单位:个/秒 */
PackageIn?: number[];
/** 网卡出包量,单位:个/秒 */
PackageOut?: number[];
/** 入流量,单位:kbps */
FlowIn?: number[];
/** 出流量,单位:kbps */
FlowOut?: number[];
}
/** 磁盘售卖类型 */
declare interface DiskTypeConfigItem {
/** 磁盘对应的实例类型。仅支持单节点基础型和集群版。 */
DeviceType?: string;
/** 可以选择的磁盘类型列表。 */
DiskType?: string[];
}
/** 灾备实例信息 */
declare interface DrInfo {
/** 灾备实例状态 */
Status?: number;
/** 可用区信息 */
Zone?: string;
/** 实例ID */
InstanceId?: string;
/** 地域信息 */
Region?: string;
/** 实例同步状态。可能的返回值为:0 - 灾备未同步;1 - 灾备同步中;2 - 灾备同步成功;3 - 灾备同步失败;4 - 灾备同步修复中。 */
SyncStatus?: number;
/** 实例名称 */
InstanceName?: string;
/** 实例类型 */
InstanceType?: number;
}
/** 结构化的错误日志详情 */
declare interface ErrlogItem {
/** 错误发生时间。时间戳,秒级 */
Timestamp?: number;
/** 错误详情 */
Content?: string;
}
/** 单条扩容历史记录 */
declare interface HistoryJob {
/** 操作类型 */
OperationType?: string;
/** 扩容类型 */
ExpandType?: string;
/** 扩容开始时间说明:此项显示的格式是 int 类型的 unix 时间戳 */
StartTime?: number;
/** 扩容结束时间说明:此项显示的格式是 int 类型的 unix 时间戳 */
EndTime?: number;
/** 扩容前核数 */
OldCpu?: number;
/** 扩容后核数 */
NewCpu?: number;
/** 增减的cpu数 */
ExtendCPUNum?: number;
/** extend_failed操作上报 */
Error?: string;
}
/** 导入任务记录 */
declare interface ImportRecord {
/** 状态值。0 - 初始化中,1 - 运行中,2 - 运行成功,3 - 运行失败。 */
Status?: number;
/** 状态值,为负数时任务异常。 */
Code?: number;
/** 执行时间,单位:秒。 */
CostTime?: number;
/** 实例ID */
InstanceId?: string;
/** 后端任务ID */
WorkId?: string;
/** 导入文件名 */
FileName?: string;
/** 执行进度,单位:百分比。 */
Process?: number;
/** 任务创建时间 */
CreateTime?: string;
/** 文件大小,单位:byte。 */
FileSize?: string;
/** 任务执行信息 */
Message?: string;
/** 任务ID */
JobId?: number;
/** 导入库表名 */
DbName?: string;
/** 异步任务的请求ID */
AsyncRequestId?: string;
}
/** 安全组入站规则 */
declare interface Inbound {
/** 策略,ACCEPT 或者 DROP */
Action?: string;
/** 来源 IP 或 IP 段,例如192.168.0.0/16 */
CidrIp?: string;
/** 端口 */
PortRange?: string;
/** 网络协议,支持 UDP、TCP 等 */
IpProtocol?: string;
/** 规则限定的方向,进站规则为 INPUT */
Dir?: string;
/** 地址模块 */
AddressModule?: string;
/** 规则ID,嵌套安全组的规则ID */
Id?: string;
/** 规则描述 */
Desc?: string;
}
/** 实例事件信息 */
declare interface InstEventInfo {
/** 事件名称。 */
EventName?: string;
/** 事件状态。 */
EventStatus?: string;
/** 事件发生时间。 */
OccurTime?: string;
/** 实例ID。 */
InstanceId?: string;
/** 节点ID */
NodeId?: string;
}
/** 审计日志搜索过滤器 */
declare interface InstanceAuditLogFilters {
/** 过滤项。目前支持以下搜索条件:包含、不包含、包含(分词维度)、不包含(分词维度):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 InstanceDbAuditStatus {
/** 实例ID。 */
InstanceId?: string;
/** 审计状态。ON-表示审计已开启,OFF-表示审计关闭 */
AuditStatus?: string;
/** 任务状态。0-无任务;1-审计开启中,2-审计关闭中。 */
AuditTask?: number;
/** 日志保留时长。支持值包括:7 - 一周;30 - 一个月;90 - 三个月;180 - 六个月;365 - 一年;1095 - 三年;1825 - 五年。 */
LogExpireDay?: number;
/** 高频存储时长。支持值包括:3 - 3天;7 - 一周;30 - 一个月;90 - 三个月;180 - 六个月;365 - 一年;1095 - 三年;1825 - 五年。 */
HighLogExpireDay?: number;
/** 低频存储时长。单位:天,等于日志保存时长减去高频存储时长。 */
LowLogExpireDay?: number;
/** 日志存储量(单位:GB)。 */
BillingAmount?: number;
/** 高频存储量(单位:GB)。 */
HighRealStorage?: number;
/** 低频存储量(单位:GB)。 */
LowRealStorage?: number;
/** 是否为全审计。true-表示全审计。 */
AuditAll?: boolean;
/** 审计开通时间。 */
CreateAt?: string;
/** 实例相关信息 */
InstanceInfo?: AuditInstanceInfo;
/** 总存储量(单位:GB)。 */
RealStorage?: number;
/** 是否包含审计策略 */
OldRule?: boolean;
/** 实例所应用的规则模板。 */
RuleTemplateIds?: string[];
}
/** 实例详细信息 */
declare interface InstanceInfo {
/** 外网状态,可能的返回值为:0-未开通外网;1-已开通外网;2-已关闭外网 */
WanStatus?: number;
/** 可用区信息 */
Zone?: string;
/** 初始化标志,可能的返回值为:0-未初始化;1-已初始化 */
InitFlag?: number;
/** 只读vip信息。单独开通只读实例访问的只读实例才有该字段 */
RoVipInfo?: RoVipInfo;
/** 内存容量,单位为 MB */
Memory?: number;
/** 实例状态,可能的返回值:0-创建中;1-运行中;4-正在进行隔离操作;5-已隔离 */
Status?: number;
/** 私有网络 ID,例如:51102 */
VpcId?: number;
/** 备机信息 */
SlaveInfo?: SlaveInfo;
/** 实例 ID */
InstanceId?: string;
/** 硬盘容量,单位为 GB */
Volume?: number;
/** 自动续费标志,可能的返回值:0-未开通自动续费;1-已开通自动续费;2-已关闭自动续费 */
AutoRenew?: number;
/** 数据复制方式。0 - 异步复制;1 - 半同步复制;2 - 强同步复制 */
ProtectMode?: number;
/** 只读组详细信息 */
RoGroups?: RoGroup[];
/** 子网 ID,例如:2333 */
SubnetId?: number;
/** 实例类型,可能的返回值:1-主实例;2-灾备实例;3-只读实例 */
InstanceType?: number;
/** 项目 ID */
ProjectId?: number;
/** 地域信息 */
Region?: string;
/** 实例到期时间 */
DeadlineTime?: string;
/** 可用区部署方式。可能的值为:0 - 单可用区;1 - 多可用区 */
DeployMode?: number;
/** 实例任务状态。0 - 没有任务 ,1 - 升级中,2 - 数据导入中,3 - 开放Slave中,4 - 外网访问开通中,5 - 批量操作执行中,6 - 回档中,7 - 外网访问关闭中,8 - 密码修改中,9 - 实例名修改中,10 - 重启中,12 - 自建迁移中,13 - 删除库表中,14 - 灾备实例创建同步中,15 - 升级待切换,16 - 升级切换中,17 - 升级切换完成 */
TaskStatus?: number;
/** 主实例详细信息 */
MasterInfo?: MasterInfo;
/** 实例类型 */
DeviceType?: string;
/** 内核版本 */
EngineVersion?: string;
/** 实例名称 */
InstanceName?: string;
/** 灾备实例详细信息 */
DrInfo?: DrInfo[];
/** 外网域名 */
WanDomain?: string;
/** 外网端口号 */
WanPort?: number;
/** 付费类型,可能的返回值:0-包年包月;1-按量计费 */
PayType?: number;
/** 实例创建时间 */
CreateTime?: string;
/** 实例 IP */
Vip?: string;
/** 端口号 */
Vport?: number;
/** 磁盘写入是否被锁定(实例数据写入量已经超过磁盘配额)。0 -未被锁定 1 -已被锁定 */
CdbError?: number;
/** 私有网络描述符,例如:“vpc-5v8wn9mg” */
UniqVpcId?: string;
/** 子网描述符,例如:“subnet-1typ0s7d” */
UniqSubnetId?: string;
/** 物理 ID */
PhysicalId?: string;
/** 核心数 */
Cpu?: number;
/** 每秒查询数量 */
Qps?: number;
/** 可用区中文名称 */
ZoneName?: string;
/** 物理机型 */
DeviceClass?: string;
/** 置放群组 ID */
DeployGroupId?: string;
/** 可用区 ID */
ZoneId?: number;
/** 节点数 */
InstanceNodes?: number;
/** 标签列表 */
TagList?: TagInfoItem[];
/** 引擎类型 */
EngineType?: string;
/** 最大延迟阈值 */
MaxDelayTime?: number;
/** 实例磁盘类型,仅云盘版实例才返回该值。可能的值为 CLOUD_SSD:SSD云硬盘, CLOUD_HSSD:增强型SSD云硬盘 */
DiskType?: string;
/** 当前扩容的CPU核心数。 */
ExpandCpu?: number;
/** 实例集群版节点信息 */
ClusterInfo?: ClusterInfo[];
/** 分析引擎节点列表 */
AnalysisNodeInfos?: AnalysisNodeInfo[];
/** 设备带宽,单位G。当DeviceClass不为空时此参数才有效。例:25-表示当前设备带宽为25G;10-表示当前设备带宽为10G。 */
DeviceBandwidth?: number;
}
/** 实例预期重启时间 */
declare interface InstanceRebootTime {
/** 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。 */
InstanceId?: string;
/** 预期重启时间,单位:秒。 */
TimeInSeconds?: number;
}
/** 实例可回档时间范围 */
declare interface InstanceRollbackRangeTime {
/** 查询数据库错误码 */
Code?: number;
/** 查询数据库错误信息 */
Message?: string;
/** 实例ID列表,单个实例Id的格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同 */
InstanceId?: string;
/** 可回档时间范围 */
Times?: RollbackTimeRange[];
}
/** 本地 binlog 保留配置 */
declare interface LocalBinlogConfig {
/** 本地 binlog 保留时长,可取值范围:[6,168]。 */
SaveHours?: number;
/** 本地 binlog 空间使用率,可取值范围:[30,50]。 */
MaxUsage?: number;
}
/** 本地 binlog 保留策略默认配置 */
declare interface LocalBinlogConfigDefault {
/** 本地 binlog 保留时长,可取值范围:[6,168]。 */
SaveHours?: number;
/** 本地 binlog 空间使用率,可取值范围:[30,50]。 */
MaxUsage?: number;
}
/** 审计日志命中规则模板的基本信息 */
declare interface LogRuleTemplateInfo {
/** 模板ID。 */
RuleTemplateId?: string;
/** 规则模板名 */
RuleTemplateName?: string;
/** 告警等级。1-低风险,2-中风险,3-高风险。 */
AlarmLevel?: string;
/** 规则模板变更状态:0-未变更;1-已变更;2-已删除 */
RuleTemplateStatus?: number;
}
/** DB实例慢日志、错误日志投递CLS配置 */
declare interface LogToCLSConfig {
/** 投递状态打开或者关闭 */
Status?: string;
/** CLS日志集ID */
LogSetId?: string;
/** 日志主题ID */
LogTopicId?: string;
/** CLS服务所在地域 */
ClsRegion?: string;
}
/** 主实例信息 */
declare interface MasterInfo {
/** 地域信息 */
Region?: string;
/** 地域ID */
RegionId?: number;
/** 可用区ID */
ZoneId?: number;
/** 可用区信息 */
Zone?: string;
/** 实例ID */
InstanceId?: string;
/** 实例长ID */
ResourceId?: string;
/** 实例状态 */
Status?: number;
/** 实例名称 */
InstanceName?: string;
/** 实例类型 */
InstanceType?: number;
/** 任务状态 */
TaskStatus?: number;
/** 内存容量 */
Memory?: number;
/** 硬盘容量 */
Volume?: number;
/** 实例机型 */
DeviceType?: string;
/** 每秒查询数 */
Qps?: number;
/** 私有网络ID */
VpcId?: number;
/** 子网ID */
SubnetId?: number;
/** 独享集群ID */
ExClusterId?: string;
/** 独享集群名称 */
ExClusterName?: string;
}
/** 一键迁移集群版只读实例信息 */
declare interface MigrateClusterRoInfo {
/** 只读实例名称 */
RoInstanceId?: string;
/** 只读实例CPU核数 */
Cpu?: number;
/** 只读实例内存大小,单位:MB */
Memory?: number;
/** 只读实例硬盘大小,单位:GB */
Volume?: number;
/** 磁盘类型。 CLOUD_SSD: SSD云硬盘; CLOUD_HSSD: 增强型SSD云硬盘 */
DiskType?: string;
/** 可用区 */
Zone?: string;
/** 迁移实例类型。支持值包括: "CLOUD_NATIVE_CLUSTER" - 标准型集群版实例, "CLOUD_NATIVE_CLUSTER_EXCLUSIVE" - 加强型集群版实例。 */
DeviceType?: string;
/** 只读实例所在ro组,例:cdbrg-xxx */
RoGroupId?: string;
/** 实例当前告警策略id数组 */
SrcAlarmPolicyList?: number[];
}
/** 独享集群CDB实例的节点分布情况 */
declare interface NodeDistribution {
/** 主实例Master节点所在主机ID或者只读实例所在主机ID */
Node: string;
/** 主实例第一Slave节点所在主机ID */
SlaveNodeOne: string;
/** 主实例第二Slave节点所在主机ID */
SlaveNodeTwo: string;
}
/** 安全组出站规则 */
declare interface Outbound {
/** 策略,ACCEPT 或者 DROP */
Action?: string;
/** 目的 IP 或 IP 段,例如172.16.0.0/12 */
CidrIp?: string;
/** 端口或者端口范围 */
PortRange?: string;
/** 网络协议,支持 UDP、TCP等 */
IpProtocol?: string;
/** 规则限定的方向,进站规则为 OUTPUT */
Dir?: string;
/** 地址模块 */
AddressModule: string;
/** 规则描述 */
Desc: string;
}
/** 实例参数信息 */
declare interface ParamInfo {
/** 参数名 */
Name: string;
/** 参数值 */
Value: string;
}
/** 参数修改记录 */
declare interface ParamRecord {
/** 实例ID */
InstanceId?: string;
/** 参数名称 */
ParamName?: string;
/** 参数修改前的值 */
OldValue?: string;
/** 参数修改后的值 */
NewValue?: string;
/** 参数是否修改成功 */
IsSucess?: boolean;
/** 修改时间 */
ModifyTime?: string;
/** 参数是否修改成功 */
IsSuccess?: boolean;
}
/** 参数模板信息 */
declare interface ParamTemplateInfo {
/** 参数模板 ID */
TemplateId?: number;
/** 参数模板名称 */
Name?: string;
/** 参数模板描述 */
Description?: string;
/** 实例引擎版本,值为:5.5、5.6、5.7、8.0。 */
EngineVersion?: string;
/** 参数模板类型,值为:HIGH_STABILITY、HIGH_PERFORMANCE。 */
TemplateType?: string;
/** 参数模板引擎,值为:InnoDB、RocksDB。 */
EngineType?: string;
}
/** 数据库实例参数 */
declare interface Parameter {
/** 参数名称 */
Name?: string;
/** 参数值 */
CurrentValue?: string;
}
/** 实例参数的详细描述 */
declare interface ParameterDetail {
/** 参数名称 */
Name?: string;
/** 参数类型:integer,enum,float,string,func */
ParamType?: string;
/** 参数默认值 */
Default?: string;
/** 参数描述 */
Description?: string;
/** 参数当前值 */
CurrentValue?: string;
/** 修改参数后,是否需要重启数据库以使参数生效。可能的值包括:0-不需要重启;1-需要重启 */
NeedReboot?: number;
/** 参数允许的最大值 */
Max?: number;
/** 参数允许的最小值 */
Min?: number;
/** 参数的可选枚举值。如果为非枚举参数,则为空 */
EnumValue?: string[];
/** 参数是公式类型时,该字段有效,表示公式类型最大值 */
MaxFunc?: string;
/** 参数是公式类型时,该字段有效,表示公式类型最小值 */
MinFunc?: string;
/** 参数是否不支持修改 */
IsNotSupportEdit?: boolean;
}
/** 按周期扩容策略中的所选择的周期 */
declare interface PeriodStrategy {
/** 扩容周期 */
TimeCycle?: TImeCycle;
/** 时间间隔 */
TimeInterval?: TimeInterval;
}
/** 数据库代理地址信息 */
declare interface ProxyAddress {
/** 代理组地址ID */
ProxyAddressId?: string;
/** 私有网络ID */
UniqVpcId?: string;
/** 私有子网ID */
UniqSubnetId?: string;
/** IP地址 */
Vip?: string;
/** 端口 */
VPort?: number;
/** 权重分配模式;系统自动分配:"system", 自定义:"custom" */
WeightMode?: string;
/** 是否开启延迟剔除,取值:"true" | "false" */
IsKickOut?: boolean;
/** 最小保留数量,最小取值:0 */
MinCount?: number;
/** 延迟剔除阈值,最小取值:0 */
MaxDelay?: number;
/** 是否自动添加RO,取值:"true" | "false" */
AutoAddRo?: boolean;
/** 是否是只读,取值:"true" | "false" */
ReadOnly?: boolean;
/** 是否开启事务分离 */
TransSplit?: boolean;
/** 是否开启故障转移 */
FailOver?: boolean;
/** 是否开启连接池 */
ConnectionPool?: boolean;
/** 描述 */
Desc?: string;
/** 实例读权重分配 */
ProxyAllocation?: ProxyAllocation[];
/** 接入模式 */
AccessMode?: string;
/** 是否开启自动负载均衡 */
AutoLoadBalance?: boolean;
}
/** 代理节点权重分布 */
declare interface ProxyAllocation {
/** 代理节点所属地域 */
Region: string;
/** 代理节点所属可用区 */
Zone: string;
/** 代理实例分布 */
ProxyInstance: ProxyInst[];
}
/** 代理组详情 */
declare interface ProxyGroupInfo {
/** 代理组ID */
ProxyGroupId?: string;
/** 代理版本 */
ProxyVersion?: string;
/** 代理支持升级版本 */
SupportUpgradeProxyVersion?: string;
/** 代理状态。0 - 初始化中,1 - 在线中,2 - 在线中-读写分离中,3 - 下线,4 - 销毁。 */
Status?: string;
/** 代理任务状态,Upgrading - 升级中,UpgradeTo - 升级待切换,UpgradeSwitching - 升级切换中,ProxyCreateAddress - 配置地址中,ProxyModifyAddress - 修改地址中,ProxyCloseAddress - 关闭地址中。 */
TaskStatus?: string;
/** 代理组节点信息 */
ProxyNode?: ProxyNode[];
/** 代理组地址信息 */
ProxyAddress?: ProxyAddress[];
/** 连接池阈值 */
ConnectionPoolLimit?: number;
/** 支持创建地址 */
SupportCreateProxyAddress?: boolean;
/** 支持升级代理版本所需的cdb版本 */
SupportUpgradeProxyMysqlVersion?: string;
}
/** 代理实例 */
declare interface ProxyInst {
/** 实例ID */
InstanceId?: string;
/** 实例名称 */
InstanceName?: string;
/** 实例类型:1 master 主实例; 2 ro 只读实例; 3 dr 灾备实例; 4 sdr 小灾备实例 */
InstanceType?: number;
/** 实例状态,可能的返回值:0-创建中;1-运行中;4-隔离中;5-已隔离 */
Status?: number;
/** 只读权重,如果权重为系统自动分配,改值不生效,只代表是否启用该实例 */
Weight?: number;
/** 实例所属地域 */
Region?: string;
/** 实例所属可用区 */
Zone?: string;
/** 实例节点ID */
InstNodeId?: string;
/** 节点角色 */
InstNodeRole?: string;
}
/** 代理节点 */
declare interface ProxyNode {
/** 代理节点ID */
ProxyId?: string;
/** CPU核数 */
Cpu?: number;
/** 内存大小,单位为 MB。 */
Mem?: number;
/** 节点状态,0 - 初始化中,1 - 在线中,2 - 下线中,3 - 销毁中,4 - 故障恢复中,5 - 节点故障,6 - 切换中。 */
Status?: string;
/** 代理节点可用区 */
Zone?: string;
/** 代理节点地域 */
Region?: string;
/** 连接数 */
Connection?: number;
}
/** 节点规格配置 */
declare interface ProxyNodeCustom {
/** 节点个数 */
NodeCount: number;
/** CPU核数 */
Cpu: number;
/** 内存大小 */
Mem: number;
/** 地域 */
Region: string;
/** 可用区 */
Zone: string;
}
/** 集群版 RW 节点的配置。 */
declare interface ReadWriteNode {
/** RW 节点所在可用区。 */
Zone: string;
/** 升级集群版实例时,如果要调整只读节点可用区,需要指定节点id。 */
NodeId?: string;
}
/** 集群版的 RO 节点配置。 */
declare interface ReadonlyNode {
/** 是否分布在随机可用区。传入YES表示随机可用区。否则使用Zone指定的可用区。 */
IsRandomZone?: string;
/** 指定该节点分布在哪个可用区。 */
Zone?: string;
/** 升级集群版实例时,如果要调整只读节点可用区,需要指定节点id。 */
NodeId?: string;
}
/** 解隔离任务结果 */
declare interface ReleaseResult {
/** 实例 ID。 */
InstanceId?: string;
/** 实例解隔离操作的结果值。返回值为0表示成功。 */
Code?: number;
/** 实例解隔离操作的错误信息。 */
Message?: string;
}
/** 异地备份信息 */
declare interface RemoteBackupInfo {
/** 异地备份子任务的ID */
SubBackupId?: number;
/** 异地备份所在地域 */
Region?: string;
/** 备份任务状态。可能的值有 "SUCCESS": 备份成功, "FAILED": 备份失败, "RUNNING": 备份进行中。 */
Status?: string;
/** 异地备份任务的开始时间 */
StartTime?: string;
/** 异地备份任务的结束时间 */
FinishTime?: string;
/** 下载地址 */
Url?: string;
}
/** 只读组参数 */
declare interface RoGroup {
/** 只读组模式,可选值为:alone-系统自动分配只读组;allinone-新建只读组;join-使用现有只读组。 */
RoGroupMode: string;
/** 只读组 ID。说明:若此数据结构在购买实例操作中被使用,则当只读组模式选择 join 时,此项为必填。 */
RoGroupId?: string;
/** 只读组名称。 */
RoGroupName?: string;
/** 是否启用延迟超限剔除功能,启用该功能后,只读实例与主实例的延迟超过延迟阈值,只读实例将被隔离。可选值:1-启用;0-不启用。 */
RoOfflineDelay?: number;
/** 延迟阈值。单位:秒。值范围:1-10000,整数。 */
RoMaxDelayTime?: number;
/** 最少实例保留个数,若购买只读实例数量小于设置数量将不做剔除。 */
MinRoInGroup?: number;
/** 读写权重分配模式,可选值:system-系统自动分配;custom-自定义。 */
WeightMode?: string;
/** 该字段已经废弃,无意义。查看只读实例的权重,请查看 RoInstances 字段里的 Weight 值。 */
Weight?: number;
/** 只读组中的只读实例详情。 */
RoInstances?: RoInstanceInfo[];
/** 只读组的内网 IP。 */
Vip?: string;
/** 只读组的内网端口号。 */
Vport?: number;
/** 私有网络 ID。 */
UniqVpcId?: string;
/** 子网 ID。 */
UniqSubnetId?: string;
/** 只读组所在的地域。 */
RoGroupRegion?: string;
/** 只读组所在的可用区。 */
RoGroupZone?: string;
/** 延迟复制时间。单位:秒。值范围:1-259200,整数。 */
DelayReplicationTime?: number;
}
/** RO 组的配置信息 */
declare interface RoGroupAttr {
/** RO 组名称。 */
RoGroupName?: string;
/** RO 实例最大延迟阈值。单位为秒,最小值为 1。范围:[1,10000],整数。注意:RO 组必须设置了开启实例延迟剔除策略,该值才有效。 */
RoMaxDelayTime?: number;
/** 是否开启实例延迟剔除。支持的值包括:1 - 开启;0 - 不开启。注意,若设置开启实例延迟剔除,则必须设置延迟阈值(RoMaxDelayTime)参数。 */
RoOfflineDelay?: number;
/** 最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。默认值为1。注意:若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。 */
MinRoInGroup?: number;
/** 权重模式。支持值包括:"system" - 系统自动分配; "custom" - 用户自定义设置。注意,若设置 "custom" 模式,则必须设置 RO 实例权重配置(RoWeightValues)参数。 */
WeightMode?: string;
/** 延迟复制时间。单位:秒,范围:1 - 259200秒,不传此参数表示不开启实例延迟复制。 */
ReplicationDelayTime?: number;
}
/** RO实例的详细信息 */
declare interface RoInstanceInfo {
/** RO组对应的主实例的ID */
MasterInstanceId?: string;
/** RO实例在RO组内的状态,可能的值:online-在线,offline-下线 */
RoStatus?: string;
/** RO实例在RO组内上一次下线的时间 */
OfflineTime?: string;
/** RO实例在RO组内的权重 */
Weight?: number;
/** RO实例所在区域名称,如ap-shanghai */
Region?: string;
/** RO可用区的正式名称,如ap-shanghai-1 */
Zone?: string;
/** RO实例ID,格式如:cdbro-c1nl9rpv */
InstanceId?: string;
/** RO实例状态,可能返回值:0-创建中,1-运行中,3-异地RO(仅在使用DescribeDBInstances查询主实例信息时,返回值中异地RO的状态恒等于3,其他场景下无此值),4-删除中 */
Status?: number;
/** 实例类型,可能返回值:1-主实例,2-灾备实例,3-只读实例 */
InstanceType?: number;
/** RO实例名称 */
InstanceName?: string;
/** 按量计费状态,可能的取值:1-正常,2-欠费 */
HourFeeStatus?: number;
/** RO实例任务状态,可能返回值:0-没有任务1-升级中2-数据导入中3-开放Slave中4-外网访问开通中5-批量操作执行中6-回档中7-外网访问关闭中8-密码修改中9-实例名修改中10-重启中12-自建迁移中13-删除库表中14-灾备实例创建同步中 */
TaskStatus?: number;
/** RO实例内存大小,单位:MB */
Memory?: number;
/** RO实例硬盘大小,单位:GB */
Volume?: number;
/** 每次查询数量 */
Qps?: number;
/** RO实例的内网IP地址 */
Vip?: string;
/** RO实例访问端口 */
Vport?: number;
/** RO实例所在私有网络ID */
VpcId?: number;
/** RO实例所在私有网络子网ID */
SubnetId?: number;
/** RO实例规格描述,目前可取值 CUSTOM */
DeviceType?: string;
/** RO实例数据库引擎版本,可能返回值:5.1、5.5、5.6、5.7、8.0 */
EngineVersion?: string;
/** RO实例到期时间,时间格式:yyyy-mm-dd hh:mm:ss,如实例为按量计费模式,则此字段值为0000-00-00 00:00:00 */
DeadlineTime?: string;
/** RO实例计费类型,可能返回值:0-包年包月,1-按量计费,2-后付费月结 */
PayType?: number;
/** RO延迟复制状态。 */
ReplicationStatus?: string;
}
/** 只读vip信息 */
declare interface RoVipInfo {
/** 只读vip状态 */
RoVipStatus?: number;
/** 只读vip的子网 */
RoSubnetId?: number;
/** 只读vip的私有网络 */
RoVpcId?: number;
/** 只读vip的端口号 */
RoVport?: number;
/** 只读vip */
RoVip?: string;
}
/** RO 实例的权重值 */
declare interface RoWeightValue {
/** RO 实例 ID。 */
InstanceId: string;
/** 权重值。取值范围为 [0, 100]。 */
Weight: number;
}
/** 用于回档的数据库名 */
declare interface RollbackDBName {
/** 回档前的原数据库名 */
DatabaseName: string;
/** 回档后的新数据库名 */
NewDatabaseName: string;
}
/** 用于回档的实例详情 */
declare interface RollbackInstancesInfo {
/** 云数据库实例 ID。 */
InstanceId: string;
/** 回档策略。可选值为:table、db、full。table - 极速回档模式,仅导入所选中表级别的备份和binlog,如有跨表操作,且关联表未被同时选中,将会导致回档失败,该模式下参数Databases必须为空;db - 快速模式,仅导入所选中库级别的备份和binlog,如有跨库操作,且关联库未被同时选中,将会导致回档失败;full - 普通回档模式,将导入整个实例的备份和 binlog,速度较慢。 */
Strategy: string;
/** 数据库回档时间,时间格式为:yyyy-mm-dd hh:mm:ss。 */
RollbackTime: string;
/** 待回档的数据库信息,表示整库回档。 */
Databases?: RollbackDBName[];
/** 待回档的数据库表信息,表示按表回档。 */
Tables?: RollbackTables[];
}
/** 用于回档的数据库表名 */
declare interface RollbackTableName {
/** 回档前的原数据库表名 */
TableName: string;
/** 回档后的新数据库表名 */
NewTableName: string;
}
/** 用于回档的数据库表详情 */
declare interface RollbackTables {
/** 数据库名 */
Database: string;
/** 数据库表详情 */
Table: RollbackTableName[];
}
/** 回档任务详情 */
declare interface RollbackTask {
/** 任务执行信息描述。 */
Info?: string;
/** 任务执行结果。可能的取值:INITIAL - 初始化,RUNNING - 运行中,SUCCESS - 执行成功,FAILED - 执行失败,KILLED - 已终止,REMOVED - 已删除,PAUSED - 终止中。 */
Status?: string;
/** 任务执行进度。取值范围为[0, 100]。 */
Progress?: number;
/** 任务开始时间。 */
StartTime?: string;
/** 任务结束时间。 */
EndTime?: string;
/** 回档任务详情。 */
Detail?: RollbackInstancesInfo[];
}
/** 可回档时间范围 */
declare interface RollbackTimeRange {
/** 实例可回档开始时间,时间格式:2016-10-29 01:06:04 */
Begin?: string;
/** 实例可回档结束时间,时间格式:2016-11-02 11:44:47 */
End?: string;
}
/** 权重分配规则 */
declare interface Rule {
/** 划分上限 */
LessThan?: number;
/** 权重 */
Weight?: number;
}
/** 审计规则的规则过滤条件 */
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;
/** 审计规则过滤条件的匹配值。sqlType条件的Value需在以下选择"alter", "changeuser", "create", "delete", "drop", "execute", "insert", "login", "logout", "other", "replace", "select", "set", "update"。 */
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 RuleTemplateRecordInfo {
/** 任务ID */
TaskId?: number;
/** 修改前规则模板的详情。 */
ModifyBeforeInfo?: RuleTemplateInfo;
/** 修改后规则模板的详情。 */
ModifyAfterInfo?: RuleTemplateInfo;
/** 影响的实例。 */
AffectedInstances?: string[];
/** 操作人,账号uin。 */
Operator?: string;
/** 变更的时间。 */
UpdateTime?: string;
}
/** 安全组详情 */
declare interface SecurityGroup {
/** 项目ID */
ProjectId?: number;
/** 创建时间,时间格式:yyyy-mm-dd hh:mm:ss */
CreateTime?: string;
/** 入站规则 */
Inbound?: Inbound[];
/** 出站规则 */
Outbound?: Outbound[];
/** 安全组ID */
SecurityGroupId?: string;
/** 安全组名称 */
SecurityGroupName?: string;
/** 安全组备注 */
SecurityGroupRemark?: string;
}
/** 从库的配置信息 */
declare interface SlaveConfig {
/** 从库复制方式,可能的返回值:aysnc-异步,semisync-半同步 */
ReplicationMode?: string;
/** 从库可用区的正式名称,如ap-shanghai-1 */
Zone?: string;
}
/** 备机信息 */
declare interface SlaveInfo {
/** 第一备机信息 */
First?: SlaveInstanceInfo;
/** 第二备机信息 */
Second?: SlaveInstanceInfo;
}
/** 备机信息 */
declare interface SlaveInstanceInfo {
/** 端口号 */
Vport: number;
/** 地域信息 */
Region: string;
/** 虚拟 IP 信息 */
Vip: string;
/** 可用区信息 */
Zone: string;
}
/** 慢查询日志详情 */
declare interface SlowLogInfo {
/** 备份文件名 */
Name?: string;
/** 备份文件大小,单位:Byte */
Size?: number;
/** 备份快照时间,时间格式:2016-03-17 */
Date?: string;
/** 内网下载地址 */
IntranetUrl?: string;
/** 外网下载地址 */
InternetUrl?: string;
/** 日志具体类型,可能的值:slowlog - 慢日志 */
Type?: string;
}
/** 结构化的慢日志详情 */
declare interface SlowLogItem {
/** Sql的执行时间。秒级时间戳。 */
Timestamp?: number;
/** Sql的执行时长(秒)。 */
QueryTime?: number;
/** Sql语句。 */
SqlText?: string;
/** 客户端地址。 */
UserHost?: string;
/** 用户名。 */
UserName?: string;
/** 数据库名。 */
Database?: string;
/** 锁时长(秒)。 */
LockTime?: number;
/** 扫描行数。 */
RowsExamined?: number;
/** 结果集行数。 */
RowsSent?: number;
/** Sql模板。 */
SqlTemplate?: string;
/** Sql语句的md5。 */
Md5?: string;
}
/** sql文件信息 */
declare interface SqlFileInfo {
/** 上传时间 */
UploadTime?: string;
/** 上传进度 */
UploadInfo?: UploadInfo;
/** 文件名 */
FileName?: string;
/** 文件大小,单位为Bytes */
FileSize?: number;
/** 上传是否完成标志,可选值:0 - 未完成,1 - 已完成 */
IsUploadFinished?: number;
/** 文件ID */
FileId?: string;
}
/** 扩容的周期 */
declare interface TImeCycle {
/** 按周期扩容时,是否选择周一扩容。说明:取值 true,表示选择,取值 false,表示不选择。 */
Monday?: boolean;
/** 按周期扩容时,是否选择周二扩容。说明:取值 true,表示选择,取值 false,表示不选择。 */
Tuesday?: boolean;
/** 按周期扩容时,是否选择周三扩容。说明:取值 true,表示选择,取值 false,表示不选择。 */
Wednesday?: boolean;
/** 按周期扩容时,是否选择周四扩容。说明:取值 true,表示选择,取值 false,表示不选择。 */
Thursday?: boolean;
/** 按周期扩容时,是否选择周五扩容。说明:取值 true,表示选择,取值 false,表示不选择。 */
Friday?: boolean;
/** 按周期扩容时,是否选择周六扩容。说明:取值 true,表示选择,取值 false,表示不选择。 */
Saturday?: boolean;
/** 按周期扩容时,是否选择周日扩容。说明:取值 true,表示选择,取值 false,表示不选择。 */
Sunday?: boolean;
}
/** 数据库表权限 */
declare interface TablePrivilege {
/** 数据库名 */
Database: string;
/** 数据库表名 */
Table: string;
/** 权限信息 */
Privileges: string[];
}
/** 标签结构 */
declare interface Tag {
/** 标签键 */
Key: string;
/** 标签值 */
Value: string;
}
/** 标签信息 */
declare interface TagInfo {
/** 标签键 */
TagKey: string;
/** 标签值 */
TagValue: string[];
}
/** 标签信息 */
declare interface TagInfoItem {
/** 标签键 */
TagKey: string;
/** 标签值 */
TagValue: string;
}
/** tag信息单元 */
declare interface TagInfoUnit {
/** 标签键 */
TagKey?: string;
/** 标签值 */
TagValue?: string;
}
/** 实例的标签信息 */
declare interface TagsInfoOfInstance {
/** 实例Id */
InstanceId?: string;
/** 标签信息 */
Tags?: TagInfoUnit[];
}
/** 任务列表中的部分任务支持特定的附加信息 */
declare interface TaskAttachInfo {
/** 升级任务:”FastUpgradeStatus“:表示升级类型。1-原地升级;0-普通升级。 */
AttachKey?: string;
/** 升级任务:”FastUpgradeStatus“:表示升级类型。1-原地升级;0-普通升级。 */
AttachValue?: string;
}
/** 实例任务详情 */
declare interface TaskDetail {
/** 错误码。0代表成功,其他对应不同的报错场景。 */
Code?: number;
/** 错误信息。 */
Message?: string;
/** 实例任务 ID。 */
JobId?: number;
/** 实例任务进度。 */
Progress?: number;
/** 实例任务状态,可能的值包括:"UNDEFINED" - 未定义;"INITIAL" - 初始化;"RUNNING" - 运行中;"SUCCEED" - 执行成功;"FAILED" - 执行失败;"KILLED" - 已终止;"REMOVED" - 已删除;"PAUSED" - 已暂停。"WAITING" - 等待中(可撤销) */
TaskStatus?: string;
/** 实例任务类型,可能的值包括:"ROLLBACK" - 数据库回档;"SQL OPERATION" - SQL操作;"IMPORT DATA" - 数据导入;"MODIFY PARAM" - 参数设置;"INITIAL" - 初始化云数据库实例;"REBOOT" - 重启云数据库实例;"OPEN GTID" - 开启云数据库实例GTID;"UPGRADE RO" - 只读实例升级;"BATCH ROLLBACK" - 数据库批量回档;"UPGRADE MASTER" - 主实例升级;"DROP TABLES" - 删除云数据库库表;"SWITCH DR TO MASTER" - 灾备实例提升为主。 */
TaskType?: string;
/** 实例任务开始时间。 */
StartTime?: string;
/** 实例任务结束时间。 */
EndTime?: string;
/** 任务关联的实例 ID。 */
InstanceIds?: string[];
/** 异步任务的请求 ID。 */
AsyncRequestId?: string;
/** 任务的附加信息。 */
TaskAttachInfo?: TaskAttachInfo[];
}
/** 时间段 */
declare interface TimeInterval {
/** 开始时间。 */
StartTime?: string;
/** 结束时间。 */
EndTime?: string;
}
/** 按时间段扩容策略 */
declare interface TimeIntervalStrategy {
/** 开始扩容时间。说明:此值的格式为 Integer 的时间戳(秒级)。 */
StartTime?: number;
/** 结束扩容时间。说明:此值的格式为 Integer 的时间戳(秒级)。 */
EndTime?: number;
}
/** 5.7升级8.0指定参数的结构 */
declare interface UpgradeEngineVersionParams {
/** 参数名称 */
Name?: string;
/** 参数值 */
Value?: string;
}
/** 文件上传描述 */
declare interface UploadInfo {
/** 文件所有分片数 */
AllSliceNum?: number;
/** 已完成分片数 */
CompleteNum?: number;
}
/** 多可用区信息 */
declare interface ZoneConf {
/** 可用区部署方式,可能的值为:0-单可用区;1-多可用区 */
DeployMode: number[];
/** 主实例所在的可用区 */
MasterZone: string[];
/** 实例为多可用区部署时,备库1所在的可用区 */
SlaveZone: string[];
/** 实例为多可用区部署时,备库2所在的可用区 */
BackupZone: string[];
}
declare interface AddTimeWindowRequest {
/** 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。 */
InstanceId: string;
/** 星期一的可维护时间段,其中每一个时间段的格式形如:10:00-12:00;起始时间按半个小时对齐;最短半个小时,最长三个小时;可设置多个时间段。 一周中应至少设置一天的时间窗。下同。 */
Monday?: string[];
/** 星期二的可维护时间窗口。 一周中应至少设置一天的时间窗。 */
Tuesday?: string[];
/** 星期三的可维护时间窗口。 一周中应至少设置一天的时间窗。 */
Wednesday?: string[];
/** 星期四的可维护时间窗口。 一周中应至少设置一天的时间窗。 */
Thursday?: string[];
/** 星期五的可维护时间窗口。 一周中应至少设置一天的时间窗。 */
Friday?: string[];
/** 星期六的可维护时间窗口。 一周中应至少设置一天的时间窗。 */
Saturday?: string[];
/** 星期日的可维护时间窗口。 一周中应至少设置一天的时间窗。 */
Sunday?: string[];
/** 最大延迟阈值(秒),仅对主实例和灾备实例有效。默认值:10,取值范围:1-10的整数。 */
MaxDelayTime?: number;
}
declare interface AddTimeWindowResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AdjustCdbProxyAddressRequest {
/** 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。 */
ProxyGroupId: string;
/** 权重分配模式,系统自动分配:"system", 自定义:"custom" */
WeightMode: string;
/** 是否开启延迟剔除,取值:"true" | "false" */
IsKickOut: boolean;
/** 最小保留数量,最小取值:0。说明:当 IsKickOut 为 true 时才有效。 */
MinCount: number;
/** 延迟剔除阈值,最小取值:1,取值范围:[1,10000],整数。 */
MaxDelay: number;
/** 是否开启故障转移,取值:"true" | "false" */
FailOver: boolean;
/** 是否自动添加RO,取值:"true" | "false" */
AutoAddRo: boolean;
/** 是否是只读,取值:"true" | "false" */
ReadOnly: boolean;
/** 代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。 */
ProxyAddressId: string;
/** 是否开启事务分离,取值:"true" | "false",默认值 false。 */
TransSplit?: boolean;
/** 是否开启连接池。默认关闭。注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。 */
ConnectionPool?: boolean;
/** 读写权重分配。如果 WeightMode 传的是 system ,则传入的权重不生效,由系统分配默认权重。 */
ProxyAllocation?: ProxyAllocation[];
/** 是否开启自适应负载均衡。默认关闭。 */
AutoLoadBalance?: boolean;
/** 访问模式:nearby - 就近访问,balance - 均衡分配,默认就近访问。 */
AccessMode?: string;
}
declare interface AdjustCdbProxyAddressResponse {
/** 异步任务ID */
AsyncRequestId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AdjustCdbProxyRequest {
/** 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。 */
InstanceId: string;
/** 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。 */
ProxyGroupId: string;
/** 节点规格配置备注:数据库代理支持的节点规格为:2C4000MB、4C8000MB、8C16000MB。示例中参数说明:NodeCount:节点个数Region:节点地域Zone:节点可用区Cpu:单个代理节点核数(单位:核)Mem:单个代理节点内存数(单位:MB) */
ProxyNodeCustom: ProxyNodeCustom[];
/** 重新负载均衡:auto(自动),manual(手动) */
ReloadBalance: string;
/** 升级切换时间:nowTime(升级完成时),timeWindow(维护时间内) */
UpgradeTime: string;
}
declare interface AdjustCdbProxyResponse {
/** 异步任务ID */
AsyncRequestId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AnalyzeAuditLogsRequest {
/** 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。 */
InstanceId: string;
/** 要分析的日志开始时间,格式为:"2023-02-16 00:00:20"。 */
StartTime: string;
/** 要分析的日志结束时间,格式为:"2023-02-16 00:10:20"。 */
EndTime: string;
/** 聚合维度的排序条件。 */
AggregationConditions: AggregationCondition[];
/** 已废弃。 */
AuditLogFilter?: AuditLogFilter;
/** 该过滤条件下的审计日志结果集作为分析日志。 */
LogFilter?: InstanceAuditLogFilters[];
}
declare interface AnalyzeAuditLogsResponse {
/** 返回的聚合桶信息集 */
Items?: AuditLogAggregationResult[];
/** 扫描的日志条数 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AssociateSecurityGroupsRequest {
/** 安全组 ID。可通过 [DescribeDBSecurityGroups](https://cloud.tencent.com/document/api/236/15854) 接口获取。 */
SecurityGroupId: string;
/** 实例 ID 列表,一个或者多个实例 ID 组成的数组。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。 */
InstanceIds: string[];
/** 当传入只读实例ID时,默认操作的是对应只读组的安全组。如果需要操作只读实例ID的安全组, 需要将该入参置为True */
ForReadonlyInstance?: boolean;
}
declare interface AssociateSecurityGroupsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BalanceRoGroupLoadRequest {
/** RO 组的 ID,格式如:cdbrg-c1nl9rpv。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 获取。 */
RoGroupId: string;
}
declare interface BalanceRoGroupLoadResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CheckMigrateClusterRequest {
/** 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。 */
InstanceId: string;
/** 实例 CPU 核数。当 InstanceId 为主实例时必传。 */
Cpu?: number;
/** 实例内存大小,单位:MB。当 InstanceId 为主实例时必传。 */
Memory?: number;
/** 实例硬盘大小,单位:GB。 */
Volume?: number;
/** 磁盘类型。 CLOUD_SSD: SSD 云硬盘; CLOUD_HSSD: 增强型 SSD 云硬盘。 */
DiskType?: string;
/** 云盘版节点拓扑配置。当 InstanceId 为主实例时必传。 */
ClusterTopology?: ClusterTopology;
/** 迁移实例类型。支持值包括: "CLOUD_NATIVE_CLUSTER" - 标准型云盘版实例, "CLOUD_NATIVE_CLUSTER_EXCLUSIVE" - 加强型云盘版实例。 */
DeviceType?: string;
/** 只读实例信息。 */
RoInfo?: MigrateClusterRoInfo[];
}
declare interface CheckMigrateClusterResponse {
/** 校验是否通过,通过为pass,失败为fail */
CheckResult?: string;
/** 校验项 */
Items?: CheckMigrateResult[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CloseAuditServiceRequest {
/** 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。 */
InstanceId: string;
}
declare interface CloseAuditServiceResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CloseCDBProxyRequest {
/*