@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
2,702 lines • 255 kB
TypeScript
/**
* 实例任务详情
*/
export interface TaskDetail {
/**
* 错误码。
*/
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。
注意：此字段可能返回 null，表示取不到有效值。
*/
InstanceIds: Array<string>;
/**
* 异步任务的请求 ID。
*/
AsyncRequestId: string;
}
/**
* 可用区售卖配置
*/
export 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: Array<string>;
/**
* 数据复制类型。0-异步复制；1-半同步复制；2-强同步复制
*/
ProtectMode: Array<string>;
/**
* 可用区名称
*/
Zone: string;
/**
* 多可用区信息
*/
ZoneConf: ZoneConf;
/**
* 可支持的灾备可用区信息
*/
DrZone: Array<string>;
/**
* 是否支持跨可用区只读
*/
IsSupportRemoteRo: boolean;
/**
* 可支持的跨可用区只读区信息
*/
RemoteRoZone: Array<string>;
/**
* 独享型可用区状态。可能的返回值为：1-上线；3-停售；4-不展示
*/
ExClusterStatus: number;
/**
* 独享型可支持的跨可用区只读区信息
*/
ExClusterRemoteRoZone: Array<string>;
/**
* 独享型多可用区信息
*/
ExClusterZoneConf: ZoneConf;
/**
* 售卖实例类型数组，其中configIds的值与configs结构体中的id一一对应。
*/
SellType: Array<CdbSellType>;
/**
* 可用区id
*/
ZoneId: number;
/**
* 是否支持ipv6
*/
IsSupportIpv6: boolean;
/**
* 可支持的售卖数据库引擎类型
*/
EngineType: Array<string>;
}
/**
* CreateDBImportJob请求参数结构体
*/
export interface CreateDBImportJobRequest {
/**
* 实例的 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* 云数据库的用户名。
*/
User: string;
/**
* 文件名称。该文件是指用户已上传到腾讯云的文件，仅支持.sql文件。
*/
FileName?: string;
/**
* 云数据库实例 User 账号的密码。
*/
Password?: string;
/**
* 导入的目标数据库名，不传表示不指定数据库。
*/
DbName?: string;
/**
* 腾讯云COS文件链接。 用户需要指定 FileName 或者 CosUrl 其中一个。 COS文件需要是 .sql 文件。
*/
CosUrl?: string;
}
/**
* DescribeDatabases请求参数结构体
*/
export interface DescribeDatabasesRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* 偏移量，最小值为0。
*/
Offset?: number;
/**
* 单次请求数量，默认值为20，最小值为1，最大值为100。
*/
Limit?: number;
/**
* 匹配数据库库名的正则表达式。
*/
DatabaseRegexp?: string;
}
/**
* CreateCdbProxy请求参数结构体
*/
export interface CreateCdbProxyRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 私有网络ID
*/
UniqVpcId: string;
/**
* 私有子网ID
*/
UniqSubnetId: string;
/**
* 节点规格配置
*/
ProxyNodeCustom: Array<ProxyNodeCustom>;
/**
* 安全组
*/
SecurityGroup?: Array<string>;
/**
* 描述
*/
Desc?: string;
/**
* 连接池阈值
*/
ConnectionPoolLimit?: number;
}
/**
* CreateCdbProxy返回参数结构体
*/
export interface CreateCdbProxyResponse {
/**
* 异步任务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
AsyncRequestId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例可回档时间范围
*/
export interface InstanceRollbackRangeTime {
/**
* 查询数据库错误码
*/
Code: number;
/**
* 查询数据库错误信息
*/
Message: string;
/**
* 实例ID列表，单个实例Id的格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同
*/
InstanceId: string;
/**
* 可回档时间范围
*/
Times: Array<RollbackTimeRange>;
}
/**
* DescribeTables返回参数结构体
*/
export interface DescribeTablesResponse {
/**
* 符合查询条件的数据库表总数。
*/
TotalCount: number;
/**
* 返回的数据库表信息。
*/
Items: Array<string>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyBackupDownloadRestriction返回参数结构体
*/
export interface ModifyBackupDownloadRestrictionResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例审计详情信息
*/
export interface InstanceDbAuditStatus {
/**
* 实例ID。
*/
InstanceId?: string;
/**
* 审计状态。ON-表示审计已开启，OFF-表示审计关闭
*/
AuditStatus?: string;
/**
* 任务状态。0-无任务；1-审计开启中，2-审计关闭中。
注意：此字段可能返回 null，表示取不到有效值。
*/
AuditTask?: number;
/**
* 日志保留时长。
注意：此字段可能返回 null，表示取不到有效值。
*/
LogExpireDay?: number;
/**
* 高频存储时长。
注意：此字段可能返回 null，表示取不到有效值。
*/
HighLogExpireDay?: number;
/**
* 低频存储时长。
注意：此字段可能返回 null，表示取不到有效值。
*/
LowLogExpireDay?: number;
/**
* 日志存储量。
注意：此字段可能返回 null，表示取不到有效值。
*/
BillingAmount?: number;
/**
* 高频存储量。
注意：此字段可能返回 null，表示取不到有效值。
*/
HighRealStorage?: number;
/**
* 低频存储量。
注意：此字段可能返回 null，表示取不到有效值。
*/
LowRealStorage?: number;
/**
* 是否为全审计。true-表示全审计。
注意：此字段可能返回 null，表示取不到有效值。
*/
AuditAll?: boolean;
/**
* 审计开通时间。
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateAt?: string;
/**
* 实例相关信息
注意：此字段可能返回 null，表示取不到有效值。
*/
InstanceInfo?: AuditInstanceInfo;
/**
* 总存储量。
注意：此字段可能返回 null，表示取不到有效值。
*/
RealStorage?: number;
/**
* 是否包含审计策略
注意：此字段可能返回 null，表示取不到有效值。
*/
OldRule?: boolean;
/**
* 实例所应用的规则模板。
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleTemplateIds?: Array<string>;
}
/**
* ModifyTimeWindow返回参数结构体
*/
export interface ModifyTimeWindowResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 参数修改记录
*/
export interface ParamRecord {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 参数名称
*/
ParamName?: string;
/**
* 参数修改前的值
*/
OldValue?: string;
/**
* 参数修改后的值
*/
NewValue?: string;
/**
* 参数是否修改成功
* @deprecated
*/
IsSucess?: boolean;
/**
* 修改时间
*/
ModifyTime?: string;
/**
* 参数是否修改成功
*/
IsSuccess?: boolean;
}
/**
* ModifyTimeWindow请求参数结构体
*/
export interface ModifyTimeWindowRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* 修改后的可维护时间段，其中每一个时间段的格式形如：10:00-12:00；起止时间按半个小时对齐；最短半个小时，最长三个小时；最多设置两个时间段；起止时间范围为：[00:00, 24:00]。
*/
TimeRanges: Array<string>;
/**
* 指定修改哪一天的客户时间段，可能的取值为：monday，tuesday，wednesday，thursday，friday，saturday，sunday。如果不指定该值或者为空，则默认一周七天都修改。
*/
Weekdays?: Array<string>;
/**
* 数据延迟阈值，仅对主实例和灾备实例有效，不传默认修改为10
*/
MaxDelayTime?: number;
}
/**
* DescribeRollbackRangeTime请求参数结构体
*/
export interface DescribeRollbackRangeTimeRequest {
/**
* 实例 ID 列表，单个实例 ID 的格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceIds: Array<string>;
/**
* 克隆实例与源实例是否在异地可用区，是:"true"，否:"false"
*/
IsRemoteZone?: string;
/**
* 克隆实例与源实例不在同一地域时需填写克隆实例所在地域，例："ap-guangzhou"
*/
BackupRegion?: string;
}
/**
* DescribeBackupOverview请求参数结构体
*/
export interface DescribeBackupOverviewRequest {
/**
* 需要查询的云数据库产品类型，目前仅支持 "mysql"。
*/
Product: string;
}
/**
* DescribeAuditInstanceList返回参数结构体
*/
export interface DescribeAuditInstanceListResponse {
/**
* 符合查询条件的实例总数。
*/
TotalCount?: number;
/**
* 审计实例详细信息列表。
注意：此字段可能返回 null，表示取不到有效值。
*/
Items?: Array<InstanceDbAuditStatus>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDBInstanceProject返回参数结构体
*/
export interface ModifyDBInstanceProjectResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDataBackupOverview返回参数结构体
*/
export interface DescribeDataBackupOverviewResponse {
/**
* 当前地域的数据备份总容量（包含自动备份和手动备份，单位为字节）。
*/
DataBackupVolume: number;
/**
* 当前地域的数据备份总个数。
*/
DataBackupCount: number;
/**
* 当前地域的自动备份总容量。
*/
AutoBackupVolume: number;
/**
* 当前地域的自动备份总个数。
*/
AutoBackupCount: number;
/**
* 当前地域的手动备份总容量。
*/
ManualBackupVolume: number;
/**
* 当前地域的手动备份总个数。
*/
ManualBackupCount: number;
/**
* 异地备份总容量。
*/
RemoteBackupVolume: number;
/**
* 异地备份总个数。
*/
RemoteBackupCount: number;
/**
* 当前地域归档备份总容量。
*/
DataBackupArchiveVolume: number;
/**
* 当前地域归档备份总个数。
*/
DataBackupArchiveCount: number;
/**
* 当前地域标准存储备份总容量。
*/
DataBackupStandbyVolume: number;
/**
* 当前地域标准存储备份总个数。
*/
DataBackupStandbyCount: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteAuditPolicy请求参数结构体
*/
export interface DeleteAuditPolicyRequest {
/**
* 审计策略 ID。
*/
PolicyId: string;
/**
* 实例 ID。
*/
InstanceId?: string;
}
/**
* 实例备份统计项
*/
export interface BackupSummaryItem {
/**
* 实例ID。
*/
InstanceId: string;
/**
* 该实例自动数据备份的个数。
*/
AutoBackupCount: number;
/**
* 该实例自动数据备份的容量。
*/
AutoBackupVolume: number;
/**
* 该实例手动数据备份的个数。
*/
ManualBackupCount: number;
/**
* 该实例手动数据备份的容量。
*/
ManualBackupVolume: number;
/**
* 该实例总的数据备份（包含自动备份和手动备份）个数。
*/
DataBackupCount: number;
/**
* 该实例总的数据备份容量。
*/
DataBackupVolume: number;
/**
* 该实例日志备份的个数。
*/
BinlogBackupCount: number;
/**
* 该实例日志备份的容量。
*/
BinlogBackupVolume: number;
/**
* 该实例的总备份（包含数据备份和日志备份）占用容量。
*/
BackupVolume: number;
}
/**
* CreateDatabase请求参数结构体
*/
export interface CreateDatabaseRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* 数据库名称。
*/
DBName: string;
/**
* 字符集，可选值：utf8，gbk，latin1，utf8mb4。
*/
CharacterSetName: string;
}
/**
* ModifyInstanceParam请求参数结构体
*/
export interface ModifyInstanceParamRequest {
/**
* 实例短 ID 列表。
*/
InstanceIds: Array<string>;
/**
* 要修改的参数列表。每一个元素是 Name 和 CurrentValue 的组合。Name 是参数名，CurrentValue 是要修改成的值。
*/
ParamList?: Array<Parameter>;
/**
* 模板id，ParamList和TemplateId必须至少传其中之一
*/
TemplateId?: number;
/**
* 执行参数调整任务的方式，默认为 0。支持值包括：0 - 立刻执行，1 - 时间窗执行；当该值为 1 时，每次只能传一个实例（InstanceIds数量为1）
*/
WaitSwitch?: number;
/**
* 参数是否同步到主实例下的只读实例。true 为不同步，false 为同步。默认为 false。
*/
NotSyncRo?: boolean;
/**
* 参数是否同步到主实例下的灾备实例。true 为不同步，false 为同步。默认为 false。
*/
NotSyncDr?: boolean;
}
/**
* CreateParamTemplate请求参数结构体
*/
export interface CreateParamTemplateRequest {
/**
* 参数模板名称。
*/
Name: string;
/**
* 参数模板描述。
*/
Description?: string;
/**
* MySQL 版本号。
*/
EngineVersion?: string;
/**
* 源参数模板 ID。
*/
TemplateId?: number;
/**
* 参数列表。
*/
ParamList?: Array<Parameter>;
/**
* 默认参数模板类型。支持值包括："HIGH_STABILITY" - 高稳定模板，"HIGH_PERFORMANCE" - 高性能模板。
*/
TemplateType?: string;
/**
* 实例引擎类型，默认为"InnoDB"，支持值包括："InnoDB"，"RocksDB"。
*/
EngineType?: string;
}
/**
* 异地备份信息
*/
export interface RemoteBackupInfo {
/**
* 异地备份子任务的ID
*/
SubBackupId?: number;
/**
* 异地备份所在地域
*/
Region?: string;
/**
* 备份任务状态。可能的值有 "SUCCESS": 备份成功， "FAILED": 备份失败， "RUNNING": 备份进行中。
*/
Status?: string;
/**
* 异地备份任务的开始时间
*/
StartTime?: string;
/**
* 异地备份任务的结束时间
*/
FinishTime?: string;
/**
* 下载地址
*/
Url?: string;
}
/**
* DescribeParamTemplateInfo请求参数结构体
*/
export interface DescribeParamTemplateInfoRequest {
/**
* 参数模板 ID。
*/
TemplateId: number;
}
/**
* ModifyCdbProxyAddressVipAndVPort返回参数结构体
*/
export interface ModifyCdbProxyAddressVipAndVPortResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBInstances请求参数结构体
*/
export interface DescribeDBInstancesRequest {
/**
* 项目 ID。
*/
ProjectId?: number;
/**
* 实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
*/
InstanceTypes?: Array<number | bigint>;
/**
* 实例的内网 IP 地址。
*/
Vips?: Array<string>;
/**
* 实例状态，可取值：<br>0 - 创建中<br>1 - 运行中<br>4 - 正在进行隔离操作<br>5 - 已隔离（可在回收站恢复开机）
*/
Status?: Array<number | bigint>;
/**
* 偏移量，默认值为 0。
*/
Offset?: number;
/**
* 单次请求返回的数量，默认值为 20，最大值为 2000。
*/
Limit?: number;
/**
* 安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
*/
SecurityGroupId?: string;
/**
* 付费类型，可取值：0 - 包年包月，1 - 小时计费。
*/
PayTypes?: Array<number | bigint>;
/**
* 实例名称。
*/
InstanceNames?: Array<string>;
/**
* 实例任务状态，可能取值：<br>0 - 没有任务<br>1 - 升级中<br>2 - 数据导入中<br>3 - 开放Slave中<br>4 - 外网访问开通中<br>5 - 批量操作执行中<br>6 - 回档中<br>7 - 外网访问关闭中<br>8 - 密码修改中<br>9 - 实例名修改中<br>10 - 重启中<br>12 - 自建迁移中<br>13 - 删除库表中<br>14 - 灾备实例创建同步中<br>15 - 升级待切换<br>16 - 升级切换中<br>17 - 升级切换完成<br>19 - 参数设置待执行
*/
TaskStatus?: Array<number | bigint>;
/**
* 实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
*/
EngineVersions?: Array<string>;
/**
* 私有网络的 ID。
*/
VpcIds?: Array<number | bigint>;
/**
* 可用区的 ID。
*/
ZoneIds?: Array<number | bigint>;
/**
* 子网 ID。
*/
SubnetIds?: Array<number | bigint>;
/**
* 是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
*/
CdbErrors?: Array<number | bigint>;
/**
* 返回结果集排序的字段，目前支持："InstanceId"，"InstanceName"，"CreateTime"，"DeadlineTime"。
*/
OrderBy?: string;
/**
* 返回结果集排序方式，目前支持："ASC" 或者 "DESC"。
*/
OrderDirection?: string;
/**
* 是否以安全组 ID 为过滤条件。
*/
WithSecurityGroup?: number;
/**
* 是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
*/
WithExCluster?: number;
/**
* 独享集群 ID。
*/
ExClusterId?: string;
/**
* 实例 ID。
*/
InstanceIds?: Array<string>;
/**
* 初始化标记，可取值：0 - 未初始化，1 - 初始化。
*/
InitFlag?: number;
/**
* 是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中， 如果拉取灾备实例， 则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
*/
WithDr?: number;
/**
* 是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
*/
WithRo?: number;
/**
* 是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
*/
WithMaster?: number;
/**
* 置放群组ID列表。
*/
DeployGroupIds?: Array<string>;
/**
* 是否以标签键为过滤条件。
*/
TagKeysForSearch?: Array<string>;
/**
* 金融围拢 ID 。
*/
CageIds?: Array<string>;
/**
* 标签值
*/
TagValues?: Array<string>;
/**
* 私有网络字符型vpcId
*/
UniqueVpcIds?: Array<string>;
/**
* 私有网络字符型subnetId
*/
UniqSubnetIds?: Array<string>;
/**
* 标签键值
*/
Tags?: Array<Tag>;
/**
* 数据库代理 IP 。
*/
ProxyVips?: Array<string>;
/**
* 数据库代理 ID 。
*/
ProxyIds?: Array<string>;
/**
* 数据库引擎类型。
*/
EngineTypes?: Array<string>;
}
/**
* ModifyCdbProxyAddressDesc请求参数结构体
*/
export interface ModifyCdbProxyAddressDescRequest {
/**
* 代理组ID
*/
ProxyGroupId: string;
/**
* 代理组地址ID
*/
ProxyAddressId: string;
/**
* 描述
*/
Desc?: string;
}
/**
* 地域售卖配置
*/
export interface CdbRegionSellConf {
/**
* 地域中文名称
*/
RegionName: string;
/**
* 所属大区
*/
Area: string;
/**
* 是否为默认地域
*/
IsDefaultRegion: number;
/**
* 地域名称
*/
Region: string;
/**
* 地域的可用区售卖配置
*/
RegionConfig: Array<CdbZoneSellConf>;
}
/**
* DescribeRoGroups请求参数结构体
*/
export interface DescribeRoGroupsRequest {
/**
* 实例ID，格式如：cdb-c1nl9rpv或者cdb-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同。
*/
InstanceId: string;
}
/**
* DescribeBackupDecryptionKey请求参数结构体
*/
export interface DescribeBackupDecryptionKeyRequest {
/**
* 实例ID，格式如：cdb-XXXX。与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* 实例的备份ID，可通过DescribeBackups接口查询备份的ID。
*/
BackupId: number;
/**
* 备份类型 data: 数据备份 binlog:日志备份，默认为data
*/
BackupType?: string;
}
/**
* CreateCdbProxyAddress返回参数结构体
*/
export interface CreateCdbProxyAddressResponse {
/**
* 异步任务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
AsyncRequestId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用于回档的数据库表名
*/
export interface RollbackTableName {
/**
* 回档前的原数据库表名
注意：此字段可能返回 null，表示取不到有效值。
*/
TableName: string;
/**
* 回档后的新数据库表名
注意：此字段可能返回 null，表示取不到有效值。
*/
NewTableName: string;
}
/**
* CloseWanService请求参数结构体
*/
export interface CloseWanServiceRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
*/
InstanceId: string;
}
/**
* DescribeAuditConfig请求参数结构体
*/
export interface DescribeAuditConfigRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
}
/**
* CreateRoInstanceIp返回参数结构体
*/
export interface CreateRoInstanceIpResponse {
/**
* 只读实例的私有网络的ID。
*/
RoVpcId: number;
/**
* 只读实例的子网ID。
*/
RoSubnetId: number;
/**
* 只读实例的内网IP地址。
*/
RoVip: string;
/**
* 只读实例的内网端口号。
*/
RoVport: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAuditPolicy返回参数结构体
*/
export interface CreateAuditPolicyResponse {
/**
* 审计策略 ID。
*/
PolicyId: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 审计日志命中规则模板的基本信息
*/
export interface LogRuleTemplateInfo {
/**
* 模板ID。
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleTemplateId?: string;
/**
* 规则模板名
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleTemplateName?: string;
/**
* 告警等级。1-低风险，2-中风险，3-高风险。
注意：此字段可能返回 null，表示取不到有效值。
*/
AlarmLevel?: string;
/**
* 规则模板变更状态：0-未变更；1-已变更；2-已删除
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleTemplateStatus?: number;
}
/**
* DescribeInstanceParamRecords请求参数结构体
*/
export interface DescribeInstanceParamRecordsRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
*/
InstanceId: string;
/**
* 分页偏移量，默认值：0。
*/
Offset?: number;
/**
* 分页大小，默认值：20。
*/
Limit?: number;
}
/**
* StopRollback返回参数结构体
*/
export interface StopRollbackResponse {
/**
* 执行请求的异步任务ID
*/
AsyncRequestId: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCdbProxyAddress请求参数结构体
*/
export interface CreateCdbProxyAddressRequest {
/**
* 代理组ID
*/
ProxyGroupId: string;
/**
* 权重分配模式，
系统自动分配："system"， 自定义："custom"
*/
WeightMode: string;
/**
* 是否开启延迟剔除，取值："true" | "false"
*/
IsKickOut: boolean;
/**
* 最小保留数量，最小取值：0
*/
MinCount: number;
/**
* 延迟剔除阈值，最小取值：0
*/
MaxDelay: number;
/**
* 是否开启故障转移，取值："true" | "false"
*/
FailOver: boolean;
/**
* 是否自动添加RO，取值："true" | "false"
*/
AutoAddRo: boolean;
/**
* 是否是只读，取值："true" | "false"
*/
ReadOnly: boolean;
/**
* 是否开启事务分离，取值："true" | "false"
*/
TransSplit: boolean;
/**
* 读写权重分配
*/
ProxyAllocation: Array<ProxyAllocation>;
/**
* 私有网络ID
*/
UniqVpcId: string;
/**
* 私有子网ID
*/
UniqSubnetId: string;
/**
* 是否开启连接池
*/
ConnectionPool?: boolean;
/**
* 描述
*/
Desc?: string;
/**
* IP地址
*/
Vip?: string;
/**
* 端口
*/
VPort?: number;
/**
* 安全组
*/
SecurityGroup?: Array<string>;
/**
* 连接池类型。可选值 transaction（事务级别连接池），connection（会话级别连接池），ConnectionPool为true时生效。
*/
ConnectionPoolType?: string;
}
/**
* AnalyzeAuditLogs请求参数结构体
*/
export interface AnalyzeAuditLogsRequest {
/**
* 实例ID。
*/
InstanceId: string;
/**
* 要分析的日志开始时间，格式为："2023-02-16 00:00:20"。
*/
StartTime: string;
/**
* 要分析的日志结束时间，格式为："2023-02-16 00:10:20"。
*/
EndTime: string;
/**
* 聚合维度的排序条件。
*/
AggregationConditions: Array<AggregationCondition>;
/**
* 已废弃。该过滤条件下的审计日志结果集作为分析日志。
*/
AuditLogFilter?: AuditLogFilter;
/**
* 该过滤条件下的审计日志结果集作为分析日志。
*/
LogFilter?: Array<InstanceAuditLogFilters>;
}
/**
* ModifyBackupEncryptionStatus返回参数结构体
*/
export interface ModifyBackupEncryptionStatusResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceParams请求参数结构体
*/
export interface DescribeInstanceParamsRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
*/
InstanceId: string;
}
/**
* DescribeUploadedFiles请求参数结构体
*/
export interface DescribeUploadedFilesRequest {
/**
* 文件路径。该字段应填用户主账号的OwnerUin信息。
*/
Path: string;
/**
* 记录偏移量，默认值为0。
*/
Offset?: number;
/**
* 单次请求返回的数量，默认值为20。
*/
Limit?: number;
}
/**
* StopDBImportJob返回参数结构体
*/
export interface StopDBImportJobResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 代理节点权重分布
*/
export interface ProxyAllocation {
/**
* 代理节点所属地域
*/
Region: string;
/**
* 代理节点所属可用区
*/
Zone: string;
/**
* 代理实例分布
*/
ProxyInstance: Array<ProxyInst>;
}
/**
* StopCpuExpand请求参数结构体
*/
export interface StopCpuExpandRequest {
/**
* 实例 ID 。
*/
InstanceId: string;
}
/**
* ModifyDBInstanceName请求参数结构体
*/
export interface ModifyDBInstanceNameRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
*/
InstanceId: string;
/**
* 修改后的实例名称。
*/
InstanceName: string;
}
/**
* tag信息单元
*/
export interface TagInfoUnit {
/**
* 标签键
*/
TagKey: string;
/**
* 标签值
*/
TagValue: string;
}
/**
* ModifyAuditRule返回参数结构体
*/
export interface ModifyAuditRuleResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAuditRules请求参数结构体
*/
export interface DescribeAuditRulesRequest {
/**
* 审计规则 ID。
*/
RuleId?: string;
/**
* 审计规则名称。支持按审计规则名称进行模糊匹配查询。
*/
RuleName?: string;
/**
* 分页大小参数。默认值为 20，最小值为 1，最大值为 100。
*/
Limit?: number;
/**
* 分页偏移量。默认值为0。
*/
Offset?: number;
}
/**
* UpgradeDBInstanceEngineVersion返回参数结构体
*/
export interface UpgradeDBInstanceEngineVersionResponse {
/**
* 异步任务 ID，可使用 [查询异步任务的执行结果](https://cloud.tencent.com/document/api/236/20410) 获取其执行情况。
*/
AsyncRequestId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 结构化的错误日志详情
*/
export interface ErrlogItem {
/**
* 错误发生时间。
注意：此字段可能返回 null，表示取不到有效值。
*/
Timestamp: number;
/**
* 错误详情
注意：此字段可能返回 null，表示取不到有效值。
*/
Content: string;
}
/**
* 代理组详情
*/
export interface ProxyGroupInfo {
/**
* 代理组ID
*/
ProxyGroupId: string;
/**
* 代理版本
注意：此字段可能返回 null，表示取不到有效值。
*/
ProxyVersion: string;
/**
* 代理支持升级版本
注意：此字段可能返回 null，表示取不到有效值。
*/
SupportUpgradeProxyVersion: string;
/**
* 代理状态
注意：此字段可能返回 null，表示取不到有效值。
*/
Status: string;
/**
* 代理任务状态
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskStatus: string;
/**
* 代理组节点信息
注意：此字段可能返回 null，表示取不到有效值。
*/
ProxyNode: Array<ProxyNode>;
/**
* 代理组地址信息
注意：此字段可能返回 null，表示取不到有效值。
*/
ProxyAddress: Array<ProxyAddress>;
/**
* 连接池阈值
注意：此字段可能返回 null，表示取不到有效值。
*/
ConnectionPoolLimit: number;
/**
* 支持创建地址
注意：此字段可能返回 null，表示取不到有效值。
*/
SupportCreateProxyAddress: boolean;
/**
* 支持升级代理版本所需的cdb版本
注意：此字段可能返回 null，表示取不到有效值。
*/
SupportUpgradeProxyMysqlVersion: string;
}
/**
* AssociateSecurityGroups返回参数结构体
*/
export interface AssociateSecurityGroupsResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ECDB第二个从库的配置信息，只有ECDB实例才有这个字段
*/
export interface BackupConfig {
/**
* 第二个从库复制方式，可能的返回值：async-异步，semisync-半同步
*/
ReplicationMode: string;
/**
* 第二个从库可用区的正式名称，如ap-shanghai-1
*/
Zone: string;
/**
* 第二个从库内网IP地址
*/
Vip: string;
/**
* 第二个从库访问端口
*/
Vport: number;
}
/**
* 权重分配规则
*/
export interface Rule {
/**
* 划分上限
注意：此字段可能返回 null，表示取不到有效值。
*/
LessThan: number;
/**
* 权重
注意：此字段可能返回 null，表示取不到有效值。
*/
Weight: number;
}
/**
* 审计策略
*/
export 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;
/**
* 审计规则名称。
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleName: string;
/**
* 数据库实例名称
注意：此字段可能返回 null，表示取不到有效值。
*/
InstanceName: string;
}
/**
* 代理节点
*/
export interface ProxyNode {
/**
* 代理节点ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ProxyId: string;
/**
* CPU核数
注意：此字段可能返回 null，表示取不到有效值。
*/
Cpu: number;
/**
* 内存大小
注意：此字段可能返回 null，表示取不到有效值。
*/
Mem: number;
/**
* 节点状态
注意：此字段可能返回 null，表示取不到有效值。
*/
Status: string;
/**
* 代理节点可用区
注意：此字段可能返回 null，表示取不到有效值。
*/
Zone: string;
/**
* 代理节点地域
注意：此字段可能返回 null，表示取不到有效值。
*/
Region: string;
/**
* 连接数
注意：此字段可能返回 null，表示取不到有效值。
*/
Connection: number;
}
/**
* DescribeCdbZoneConfig返回参数结构体
*/
export interface DescribeCdbZoneConfigResponse {
/**
* 售卖规格和地域信息集合
*/
DataResult?: CdbZoneDataResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTables请求参数结构体
*/
export interface DescribeTablesRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* 数据库的名称。
*/
Database: string;
/**
* 记录偏移量，默认值为0。
*/
Offset?: number;
/**
* 单次请求返回的数量，默认值为20，最大值为2000。
*/
Limit?: number;
/**
* 匹配数据库表名的正则表达式，规则同 MySQL 官网
*/
TableRegexp?: string;
}
/**
* UpgradeDBInstance请求参数结构体
*/
export interface UpgradeDBInstanceRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
*/
InstanceId: string;
/**
* 升级后的内存大小，单位：MB，为保证传入 Memory 值有效，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的内存规格。
*/
Memory: number;
/**
* 升级后的硬盘大小，单位：GB，为保证传入 Volume 值有效，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的硬盘范围。
*/
Volume: number;
/**
* 数据复制方式，支持值包括：0 - 异步复制，1 - 半同步复制，2 - 强同步复制，升级主实例时可指定该参数，升级只读实例或者灾备实例时指定该参数无意义。
*/
ProtectMode?: number;
/**
* 部署模式，默认为 0，支持值包括：0 - 单可用区部署，1 - 多可用区部署，升级主实例时可指定该参数，升级只读实例或者灾备实例时指定该参数无意义。
*/
DeployMode?: number;
/**
* 备库1的可用区信息，默认和实例的 Zone 参数一致，升级主实例为多可用区部署时可指定该参数，升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
*/
SlaveZone?: string;
/**
* 主实例数据库引擎版本，支持值包括：5.5、5.6 和 5.7。
*/
EngineVersion?: string;
/**
* 切换访问新实例的方式，默认为 0。支持值包括：0 - 立刻切换，1 - 时间窗切换；当该值为 1 时，升级过程中，切换访问新实例的流程将会在时间窗内进行，或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。
*/
WaitSwitch?: number;
/**
* 备库 2 的可用区信息，默认为空，升级主实例时可指定该参数，升级只读实例或者灾备实例时指定该参数无意义。
*/
BackupZone?: string;
/**
* 实例类型，默认为 master，支持值包括：master - 表示主实例，dr - 表示灾备实例，ro - 表示只读实例。
*/
InstanceRole?: string;
/**
* 实例隔离类型。支持值包括： "UNIVERSAL" - 通用型实例， "EXCLUSIVE" - 独享型实例， "BASIC" - 基础版实例。
*/
DeviceType?: string;
/**
* 升级后的实例cpu核数，如果不传将根据 Memory 指定的内存值自动填充最小允许规格的cpu值。
*/
Cpu?: number;
/**
* 是否极速变配。0-普通升级，1-极速变配，2 极速优先。选择极速变配会根据资源状况校验是否可以进行极速变配，满足条件则进行极速变配，不满足条件会返回报错信息。
*/
FastUpgrade?: number;
/**
* 延迟阈值。取值范围1~10，默认值为10。
*/
MaxDelayTime?: number;
/**
* 是否跨区迁移。0-普通迁移，1-跨区迁移，默认值为0。该值为1时支持变更实例主节点可用区。
*/
CrossCluster?: number;
/**
* 主节点可用区，该值仅在跨区迁移时生效。仅支持同地域下的可用区进行迁移。
*/
ZoneId?: string;
/**
* 针对跨集群搬迁场景，选择同可用区RO的处理逻辑。together-同可用区RO跟随主实例迁移至目标可用区（默认选项），severally-同可用区RO保持原部署模式、不迁移至目标可用区。
*/
RoTransType?: string;
}
/**
* ModifyParamTemplate请求参数结构体
*/
export interface ModifyParamTemplateRequest {
/**
* 模板 ID。
*/
TemplateId: number;
/**
* 模板名称，长度不超过64。
*/
Name?: string;
/**
* 模板描述，长度不超过255。
*/
Description?: string;
/**
* 参数列表。
*/
ParamList?: Array<Parameter>;
}
/**
* OpenAuditService返回参数结构体
*/
export interface OpenAuditServiceResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBinlogBackupOverview返回参数结构体
*/
export interface DescribeBinlogBackupOverviewResponse {
/**
* 总的日志备份容量，包含异地日志备份（单位为字节）。
*/
BinlogBackupVolume: number;
/**
* 总的日志备份个数，包含异地日志备份。
*/
BinlogBackupCount: number;
/**
* 异地日志备份容量（单位为字节）。
*/
RemoteBinlogVolume: number;
/**
* 异地日志备份个数。
*/
RemoteBinlogCount: number;
/**
* 归档日志备份容量（单位为字节）。
*/
BinlogArchiveVolume: number;
/**
* 归档日志备份个数。
*/
BinlogArchiveCount: number;
/**
* 标准存储日志备份容量（单位为字节）。
*/
BinlogStandbyVolume: number;
/**
* 标准存储日志备份个数。
*/
BinlogStandbyCount: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBInstanceLogToCLS返回参数结构体
*/
export interface DescribeDBInstanceLogToCLSResponse {
/**
* 错误日志投递CLS配置
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrorLog?: LogToCLSConfig;
/**
* 慢日志投递CLS配置
注意：此字段可能返回 null，表示取不到有效值。
*/
SlowLog?: LogToCLSConfig;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SwitchDBInstanceMasterSlave请求参数结构体
*/
export interface SwitchDBInstanceMasterSlaveRequest {
/**
* 实例 ID。
*/
InstanceId: string;
/**
* 目标从实例。可选值："first" - 第一备机；"second" - 第二备机。默认值为 "first"，仅多可用区实例支持设置为 "second"。
*/
DstSlave?: string;
/**
* 是否强制切换。默认为 False。注意，若设置强制切换为 True，实例存在丢失数据的风险，请谨慎使用。
*/
ForceSwitch?: boolean;
/**
* 是否时间窗内切换。默认为 False，即不在时间窗内切换。注意，如果设置了 ForceSwitch 参数为 True，则该参数不生效。
*/
WaitSwitch?: boolean;
}
/**
* ModifyCdbProxyAddressVipAndVPort请求参数结构体
*/
export interface ModifyCdbProxyAddressVipAndVPortRequest {
/**
* 代理组ID
*/
ProxyGroupId: string;
/**
* 代理组地址ID
*/
ProxyAddressId: string;
/**
* 私有网络ID
*/
UniqVpcId: string;
/**
* 私有子网ID
*/
UniqSubnetId: string;
/**
* IP地址
*/
Vip?: string;
/**
* 端口
*/
VPort?: number;
/**
* 旧IP地址回收时间
*/
ReleaseDuration?: number;
}
/**
* ModifyAutoRenewFlag请求参数结构体
*/
export interface ModifyAutoRenewFlagRequest {
/**
* 实例的 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceIds: Array<string>;
/**
* 自动续费标记，可取值的有：0 - 不自动续费，1 - 自动续费。
*/
AutoRenew: number;
}
/**
* DeleteDeployGroups请求参数结构体
*/
export interface DeleteDeployGroupsRequest {
/**
* 要删除的置放群组 ID 列表。
*/
DeployGroupIds: Array<string>;
}
/**
* DescribeAuditConfig返回参数结构体
*/
export interface DescribeAuditConfigResponse {
/**
* 审计日志保存时长。目前支持的值包括：[0，7，30，180，365，1095，1825]。
注意：此字段可能返回 null，表示取不到有效值。
*/
LogExpireDay: number;
/**
* 审计日志存储类型。目前支持的值包括："storage" - 存储型。
*/
LogType: string;
/**
* 是否正在关闭审计。目前支持的值包括："false"-否，"true"-是
*/
IsClosing: string;
/**
* 审计服务开通时间。
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyBackupConfig返回参数结构体
*/
export interface ModifyBackupConfigResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTimeWindow返回参数结构体
*/
export interface DescribeTimeWindowResponse {
/**
* 星期一的可维护时间列表。
*/
Monday: Array<string>;
/**
* 星期二的可维护时间列表。
*/
Tuesday: Array<string>;
/**
* 星期三的可维护时间列表。
*/
Wednesday: Array<string>;
/**
* 星期四的可维护时间列表。
*/
Thursday: Array<string>;
/**
* 星期五的可维护时间列表。
*/
Friday: Array<string>;
/**
* 星期六的可维护时间列表。
*/
Saturday: Array<string>;
/**
* 星期日的可维护时间列表。
*/
Sunday: Array<string>;
/**
* 最大数据延迟阈值
*/
MaxDelayTime: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteAuditPolicy返回参数结构体
*/
export interface DeleteAuditPolicyResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InitDBInstances返回参数结构体
*/
export interface InitDBInstancesResponse {
/**
* 异步任务的请求ID数组，可使用此ID查询异步任务的执行结果
*/
AsyncRequestIds: Array<string>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeParamTemplateInfo返回参数结构体
*/
export interface DescribeParamTemplateInfoResponse {
/**
* 参数模板 ID。
*/
TemplateId?: number;
/**
* 参数模板名称。
*/
Name?: string;
/**
* 参数模板对应实例版本
*/
EngineVersion?: string;
/**
* 参数模板中的参数数量
*/
TotalCount?: number;
/**
* 参数详情
*/
Items?: Array<ParameterDetail>;
/**
* 参数模板描述
*/
Description?: string;
/**
* 参数模板类型。支持值包括："HIGH_STABILITY" - 高稳定模板，"HIGH_PERFORMANCE" - 高性能模板。
*/
TemplateType?: string;
/**
* 参数模板引擎。支持值包括："InnoDB"，"RocksDB"。
注意：此字段可能返回 null，表示取不到有效值。
*/
EngineType?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceParams返回参数结构体
*/
export interface DescribeInstanceParamsResponse {
/**
* 实例的参数总数。
*/
TotalCount: number;
/**
* 参数详情。
*/
Items: Array<ParameterDetail>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteDatabase请求参数结构体
*/
export interface DeleteDatabaseRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* 数据库名称。
*/
DBName: string;
}
/**
* 文件上传描述
*/
export interface UploadInfo {
/**
* 文件所有分片数
*/
AllSliceNum: number;
/**
* 已完成分片数
*/
CompleteNum: number;
}
/**
* DisassociateSecurityGroups请求参数结构体
*/
export interface DisassociateSecurityGroupsRequest {
/**
* 安全组 ID。
*/
SecurityGroupId: string;
/**
* 实例 ID 列表，一个或者多个实例 ID 组成的数组。
*/
InstanceIds: Array<string>;
/**
* 当传入只读实例ID时，默认操作的是对应只读组的安全组。如果需要操作只读实例ID的安全组， 需要将该入参置为True
*/
ForReadonlyInstance?: boolean;
}
/**
* 审计规则的过滤条件
*/
export interface AuditRuleFilters {
/**
* 单条审计规则。
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleFilters?: Array<RuleFilters>;
}
/**
* ModifyLocalBinlogConfig请求参数结构体
*/
export interface ModifyLocalBinlogConfigRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同。
*/
InstanceId: string;
/**
* 本地binlog保留时长，可取值范围：[72,168]，当实例存在灾备实例时，可取值范围：[120,168]。
*/
SaveHours: number;
/**
* 本地binlog空间使用率，可取值范围：[30,50]。
*/
MaxUsage: number;
}
/**
* StartBatchRollback返回参数结构体
*/
export interface StartBatchRollbackResponse {
/**
* 异步任务的请求 ID，可使用此 ID 查询异步任务的执行结果。
*/
AsyncRequestId: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAccountHost返回参数结构体
*/
export interface ModifyAccountHostResponse {
/**
* 异步任务的请求 ID，可使用此 ID 查询异步任务的执行结果。
*/
AsyncRequestId: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRollbackRangeTime返回参数结构体
*/
export interface DescribeRollbackRangeTimeResponse {
/**
* 符合查询条件的实例总数。
*/
TotalCount?: number;
/**
* 返回的参数信息。
*/
Items?: Array<InstanceRollbackRangeTime>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRoGroupInfo请求参数结构体
*/
export interface ModifyRoGroupInfoRequest {
/**
* RO 组的 ID。
*/
RoGroupId: string;
/**
* RO 组的详细信息。
*/
RoGroupInfo?: RoGroupAttr;
/**
* RO 组内实例的权重。若修改 RO 组的权重模式为用户自定义模式（custom），则必须设置该参数，且需要设置每个 RO 实例的权重值。
*/
RoWeightValues?: Array<RoWeightValue>;
/**
* 是否重新均衡 RO 组内的 RO 实例的负载。支持值包括：1 - 重新均衡负载；0 - 不重新均衡负载。默认值为 0。注意，设置为重新均衡负载时，RO 组内 RO 实例会有一次数据库连接瞬断，请确保应用程序能重连数据库。
*/
IsBalanceRoLoad?: number;
/**
* 废弃参数，无意义。
*/
ReplicationDelayTime?: number;
}
/**
* 解隔离任务结果
*/
export interface ReleaseResult {
/**
* 实例 ID。
*/
InstanceId: string;
/**
* 实例解隔离操作的结果值。返回值为0表示成功。
*/
Code: number;
/**
* 实例解隔离操作的错误信息。
*/
Message: string;
}
/**
* CreateAuditLogFile请求参数结构体
*/
export interface CreateAuditLogFileRequest {
/**
* 实例 ID，与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* 开始时间。
*/
StartTime: string;
/**
* 结束时间。
*/
EndTime: string;
/**
* 排序方式。支持值包括："ASC" - 升序，"DESC" - 降序。
*/
Order?: string;
/**
* 排序字段。支持值包括：
"timestamp" - 时间戳；
"affectRows" - 影响行数；
"execTime" - 执行时间。
*/
OrderBy?: string;
/**
* 已废弃。
*/
Filter?: AuditLogFilter;
/**
* 过滤条件。可按设置的过滤条件过滤日志。
*/
LogFilter?: Array<InstanceAuditLogFilters>;
}
/**
* 审计规则
*/
export interface AuditRule {
/**
* 审计规则 Id。
*/
RuleId: string;
/**
* 审计规则创建时间。格式为 : "2019-03-20 17:09:13"。
*/
CreateTime: string;
/**
* 审计规则最后修改时间。格式为 : "2019-03-20 17:09:13"。
*/
ModifyTime: string;
/**
* 审计规则名称。
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleName: string;
/**
* 审计规则描述。
注意：此字段可能返回 null，表示取不到有效值。
*/
Description: string;
/**
* 审计规则过滤条件。
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleFilters: Array<AuditFilter>;
/**
* 是否开启全审计。
*/
AuditAll: boolean;
}
/**
* DescribeBinlogs请求参数结构体
*/
export interface DescribeBinlogsRequest {
/**
* 实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* 偏移量，最小值为0。
*/
Offset?: number;
/**
* 分页大小，默认值为20，最小值为1，最大值为100。
*/
Limit?: number;
/**
* binlog最早开始时间，时间格式：2016-03-17 02:10:37
*/
MinStartTime?: string;
/**
* binlog最晚开始时间，时间格式：2016-03-17 02:10:37
*/
MaxStartTime?: string;
}
/**
* DescribeCdbProxyInfo请求参数结构体
*/
export interface DescribeCdbProxyInfoRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 代理组ID
*/
ProxyGroupId?: string;
}
/**
* 用于回档的数据库名
*/
export interface RollbackDBName {
/**
* 回档前的原数据库名
注意：此字段可能返回 null，表示取不到有效值。
*/
DatabaseName: string;
/**
* 回档后的新数据库名
注意：此字段可能返回 null，表示取不到有效值。
*/
NewDatabaseName: string;
}
/**
* 审计规则的规则过滤条件
*/
export 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: Array<string>;
}
/**
* ModifyAuditRuleTemplates请求参数结构体
*/
export interface ModifyAuditRuleTemplatesRequest {
/**
* 审计规则模板ID。
*/
RuleTemplateIds: Array<string>;
/**
* 修改后的审计规则。
*/
RuleFilters?: Array<RuleFilters>;
/**
* 修改后的规则模板名称。
*/
RuleTemplateName?: string;
/**
* 修改后的规则模板描述。
*/
Description?: string;
/**
* 告警等级。1-低风险，2-中风险，3-高风险。
*/
AlarmLevel?: number;
/**
* 告警策略。0-不告警，1-告警。
*/
AlarmPolicy?: number;
}
/**
* CreateAuditRule返回参数结构体
*/
export interface CreateAuditRuleResponse {
/**
* 审计规则 ID。
*/
RuleId: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRemoteBackupConfig返回参数结构体
*/
export interface ModifyRemoteBackupConfigResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBInstanceInfo返回参数结构体
*/
export interface DescribeDBInstanceInfoResponse {
/**
* 实例 ID 。
*/
InstanceId: string;
/**
* 实例名称。
*/
InstanceName: string;
/**
* 是否开通加密，YES 已开通，NO 未开通。
*/
Encryption: string;
/**
* 加密使用的密钥 ID 。
注意：此字段可能返回 null，表示取不到有效值。
*/
KeyId: string;
/**
* 密钥所在地域。
注意：此字段可能返回 null，表示取不到有效值。
*/
KeyRegion: string;
/**
* 当前 CDB 后端服务使用的 KMS 服务的默认地域。
注意：此字段可能返回 null，表示取不到有效值。
*/
DefaultKmsRegion: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssociateSecurityGroups请求参数结构体
*/
export interface AssociateSecurityGroupsRequest {
/**
* 安全组 ID。
*/
SecurityGroupId: string;
/**
* 实例 ID 列表，一个或者多个实例 ID 组成的数组。
*/
InstanceIds: Array<string>;
/**
* 当传入只读实例ID时，默认操作的是对应只读组的安全组。如果需要操作只读实例ID的安全组， 需要将该入参置为True
*/
ForReadonlyInstance?: boolean;
}
/**
* StartReplication返回参数结构体
*/
export interface StartReplicationResponse {
/**
* 异步任务 ID。
注意：此字段可能返回 null，表示取不到有效值。
*/
AsyncRequestId: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBFeatures返回参数结构体
*/
export interface DescribeDBFeaturesResponse {
/**
* 是否支持数据库审计功能。
*/
IsSupportAudit?: boolean;
/**
* 开启审计是否需要升级内核版本。
*/
AuditNeedUpgrade?: boolean;
/**
* 是否支持数据库加密功能。
*/
IsSupportEncryption?: boolean;
/**
* 开启加密是否需要升级内核版本。
*/
EncryptionNeedUpgrade?: boolean;
/**
* 是否为异地只读实例。
*/
IsRemoteRo?: boolean;
/**
* 主实例所在地域。
*/
MasterRegion?: string;
/**
* 是否支持小版本升级。
*/
IsSupportUpdateSubVersion?: boolean;
/**
* 当前内核版本。
*/
CurrentSubVersion?: string;
/**
* 可供升级的内核版本。
*/
TargetSubVersion?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAuditRule请求参数结构体
*/
export interface ModifyAuditRuleRequest {
/**
* 审计规则 ID。
*/
RuleId: string;
/**
* 审计规则名称。
*/
RuleName?: string;
/**
* 审计规则描述。
*/
Description?: string;
/**
* 审计规则过滤条件。若设置了过滤条件，则不会开启全审计。
*/
RuleFilters?: Array<AuditFilter>;
/**
* 是否开启全审计。支持值包括：false – 不开启全审计，true – 开启全审计。用户未设置审计规则过滤条件时，默认开启全审计。
*/
AuditAll?: boolean;
}
/**
* DescribeBinlogs返回参数结构体
*/
export interface DescribeBinlogsResponse {
/**
* 符合查询条件的日志文件总数。
*/
TotalCount?: number;
/**
* 符合查询条件的二进制日志文件详情。
*/
Items?: Array<BinlogInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRoMinScale请求参数结构体
*/
export interface DescribeRoMinScaleRequest {
/**
* 只读实例ID，格式如：cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同，该参数与MasterInstanceId参数不能同时为空。
*/
RoInstanceId?: string;
/**
* 主实例ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同，该参数与RoInstanceId参数不能同时为空。注意，当传入参数包含RoInstanceId时，返回值为只读实例升级时的最小规格；当传入参数只包含MasterInstanceId时，返回值为只读实例购买时的最小规格。
*/
MasterInstanceId?: string;
}
/**
* DescribeDefaultParams请求参数结构体
*/
export interface DescribeDefaultParamsRequest {
/**
* 引擎版本，目前支持 ["5.1", "5.5", "5.6", "5.7", "8.0"]
*/
EngineVersion?: string;
/**
* 默认参数模板类型。支持值包括："HIGH_STABILITY" - 高稳定模板，"HIGH_PERFORMANCE" - 高性能模板。
*/
TemplateType?: string;
/**
* 参数模板引擎，默认值：InnoDB
*/
EngineType?: string;
}
/**
* 审计实例详情
*/
export interface AuditInstanceInfo {
/**
* 项目ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ProjectId?: number;
/**
* 标签信息
注意：此字段可能返回 null，表示取不到有效值。
*/
TagList?: Array<TagInfoUnit>;
/**
* 数据库内核类型
注意：此字段可能返回 null，表示取不到有效值。
*/
DbType?: string;
/**
* 数据库内核版本
注意：此字段可能返回 null，表示取不到有效值。
*/
DbVersion?: string;
}
/**
* proxy配置
*/
export interface CustomConfig {
/**
* 设备
注意：此字段可能返回 null，表示取不到有效值。
*/
Device: string;
/**
* 类型
注意：此字段可能返回 null，表示取不到有效值。
*/
Type: string;
/**
* 设备类型
注意：此字段可能返回 null，表示取不到有效值。
*/
DeviceType: string;
/**
* 内存
注意：此字段可能返回 null，表示取不到有效值。
*/
Memory: number;
/**
* 核数
注意：此字段可能返回 null，表示取不到有效值。
*/
Cpu: number;
}
/**
* SwitchDBInstanceMasterSlave返回参数结构体
*/
export interface SwitchDBInstanceMasterSlaveResponse {
/**
* 异步任务 ID。
*/
AsyncRequestId: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBackups请求参数结构体
*/
export interface DescribeBackupsRequest {
/**
* 实例ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* 偏移量，最小值为0。
*/
Offset?: number;
/**
* 分页大小，默认值为20，最小值为1，最大值为100。
*/
Limit?: number;
}
/**
* DescribeInstanceParamRecords返回参数结构体
*/
export interface DescribeInstanceParamRecordsResponse {
/**
* 符合条件的记录数。
*/
TotalCount: number;
/**
* 参数修改记录。
*/
Items: Array<ParamRecord>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBInstanceGTID返回参数结构体
*/
export interface DescribeDBInstanceGTIDResponse {
/**
* GTID 是否开通的标记，可能的取值为：0 - 未开通，1 - 已开通。
*/
IsGTIDOpen: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteParamTemplate请求参数结构体
*/
export interface DeleteParamTemplateRequest {
/**
* 参数模板ID。
*/
TemplateId: number;
}
/**
* 灾备实例信息
*/
export interface DrInfo {
/**
* 灾备实例状态
*/
Status: number;
/**
* 可用区信息
*/
Zone: string;
/**
* 实例ID
*/
InstanceId: string;
/**
* 地域信息
*/
Region: string;
/**
* 实例同步状态。可能的返回值为：
0 - 灾备未同步；
1 - 灾备同步中；
2 - 灾备同步成功；
3 - 灾备同步失败；
4 - 灾备同步修复中。
*/
SyncStatus: number;
/**
* 实例名称
*/
InstanceName: string;
/**
* 实例类型
*/
InstanceType: number;
}
/**
* ModifyBackupDownloadRestriction请求参数结构体
*/
export interface ModifyBackupDownloadRestrictionRequest {
/**
* NoLimit 不限制,内外网都可以下载； LimitOnlyIntranet 仅内网可下载； Customize 用户自定义vpc:ip可下载。 只有该值为 Customize 时，才可以设置 LimitVpc 和 LimitIp 。
*/
LimitType: string;
/**
* 该参数仅支持 In， 表示 LimitVpc 指定的vpc可以下载。默认为In。
*/
VpcComparisonSymbol?: string;
/**
* In: 指定的ip可以下载； NotIn: 指定的ip不可以下载。 默认为In。
*/
IpComparisonSymbol?: string;
/**
* 限制下载的vpc设置。
*/
LimitVpc?: Array<BackupLimitVpcItem>;
/**
* 限制下载的ip设置
*/
LimitIp?: Array<string>;
}
/**
* CreateParamTemplate返回参数结构体
*/
export interface CreateParamTemplateResponse {
/**
* 参数模板 ID。
*/
TemplateId: