@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
2,941 lines • 185 kB
TypeScript
/**
* 数据库代理规格
*/
export interface ProxySpec {
/**
* 数据库代理cpu核数
*/
Cpu: number;
/**
* 数据库代理内存
*/
Mem: number;
}
/**
* RemoveClusterSlaveZone请求参数结构体
*/
export interface RemoveClusterSlaveZoneRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 从可用区
*/
SlaveZone: string;
}
/**
* ModifyClusterName请求参数结构体
*/
export interface ModifyClusterNameRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 集群名
*/
ClusterName: string;
}
/**
* ModifyProxyRwSplit请求参数结构体
*/
export interface ModifyProxyRwSplitRequest {
/**
* 集群ID,例如cynosdbmysql-asd123
*/
ClusterId: string;
/**
* 数据库代理组ID,例如cynosdbmysql-proxy-qwe123
*/
ProxyGroupId: string;
/**
* 一致性类型;“eventual"-最终一致性, "session"-会话一致性, "global"-全局一致性
*/
ConsistencyType?: string;
/**
* 一致性超时时间。
取值范围:0~1000000(微秒),设置0则表示若只读实例出现延迟, 导致一致性策略不满足, 请求将一直等待。
*/
ConsistencyTimeOut?: string;
/**
* 读写权重分配模式;系统自动分配:"system", 自定义:"custom"
*/
WeightMode?: string;
/**
* 实例只读权重。
该参数必填。
*/
InstanceWeights?: Array<ProxyInstanceWeight>;
/**
* 是否开启故障转移,代理出现故障后,连接地址将路由到主实例,取值:"yes" , "no"
*/
FailOver?: string;
/**
* 是否自动添加只读实例,取值:"yes" , "no"
*/
AutoAddRo?: string;
/**
* 是否打开读写分离。
该参数已废弃,请通过RwType设置读写属性。
*/
OpenRw?: string;
/**
* 读写类型:
READWRITE,READONLY
*/
RwType?: string;
/**
* 事务拆分。
在一个事务中拆分读和写到不同的实例上去执行。
*/
TransSplit?: boolean;
/**
* 连接模式:
nearby,balance
*/
AccessMode?: string;
/**
* 是否打开连接池:
yes,no
*/
OpenConnectionPool?: string;
/**
* 连接池类型:
SessionConnectionPool
*/
ConnectionPoolType?: string;
/**
* 连接池时间。
可选范围:0~300(秒)
*/
ConnectionPoolTimeOut?: number;
}
/**
* DescribeRollbackTimeRange请求参数结构体
*/
export interface DescribeRollbackTimeRangeRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* DescribeResourcePackageList返回参数结构体
*/
export interface DescribeResourcePackageListResponse {
/**
* 资源包总数
*/
Total?: number;
/**
* 资源包明细
注意:此字段可能返回 null,表示取不到有效值。
*/
Detail?: Array<Package>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InquirePriceRenew请求参数结构体
*/
export interface InquirePriceRenewRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 购买时长,与TimeUnit组合才能生效
*/
TimeSpan: number;
/**
* 购买时长单位, 与TimeSpan组合生效,可选:日:d,月:m
*/
TimeUnit: string;
}
/**
* DescribeAccountPrivileges返回参数结构体
*/
export interface DescribeAccountPrivilegesResponse {
/**
* 权限列表,示例值为:["","select","update","delete","create","drop","references","index","alter","show_db","create_tmp_table","lock_tables","execute","create_view","show_view","create_routine","alter_routine","event","trigger"]
*/
Privileges?: Array<string>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例的审计规则详情。
*/
export interface InstanceAuditRule {
/**
* 实例ID。
*/
InstanceId?: string;
/**
* 是否是规则审计。true-规则审计,false-全审计。
注意:此字段可能返回 null,表示取不到有效值。
*/
AuditRule?: boolean;
/**
* 审计规则详情。仅当AuditRule=true时有效。
注意:此字段可能返回 null,表示取不到有效值。
*/
AuditRuleFilters?: Array<AuditRuleFilters>;
/**
* 是否是审计策略
注意:此字段可能返回 null,表示取不到有效值。
*/
OldRule?: boolean;
/**
* 实例应用的规则模板详情
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleTemplates?: Array<RuleTemplateInfo>;
}
/**
* 数据库代理,读写分离实例权重
*/
export interface ProxyInstanceWeight {
/**
* 实例Id
*/
InstanceId: string;
/**
* 实例权重
*/
Weight: number;
}
/**
* CreateResourcePackage请求参数结构体
*/
export interface CreateResourcePackageRequest {
/**
* 实例类型
*/
InstanceType: string;
/**
* 资源包使用地域
china-中国内地通用,overseas-港澳台及海外通用
*/
PackageRegion: string;
/**
* 资源包类型:CCU-计算资源包,DISK-存储资源包
*/
PackageType: string;
/**
* 资源包版本
base-基础版本,common-通用版本,enterprise-企业版本
*/
PackageVersion: string;
/**
* 资源包大小,计算资源单位:万个;存储资源:GB
*/
PackageSpec: number;
/**
* 资源包有效期,单位:天
*/
ExpireDay: number;
/**
* 购买资源包个数
*/
PackageCount: number;
/**
* 资源包名称
*/
PackageName?: string;
}
/**
* DescribeAuditLogs请求参数结构体
*/
export interface DescribeAuditLogsRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 开始时间,格式为:"2017-07-12 10:29:20"。
*/
StartTime: string;
/**
* 结束时间,格式为:"2017-07-12 10:29:20"。
*/
EndTime: string;
/**
* 排序方式。支持值包括:"ASC" - 升序,"DESC" - 降序。
*/
Order?: string;
/**
* 排序字段。支持值包括:
"timestamp" - 时间戳;
"affectRows" - 影响行数;
"execTime" - 执行时间。
*/
OrderBy?: string;
/**
* 已废弃。
*/
Filter?: AuditLogFilter;
/**
* 分页参数,单次返回的数据条数。默认值为100,最大值为100。
*/
Limit?: number;
/**
* 分页偏移量。
*/
Offset?: number;
/**
* 过滤条件。多个值之前是且的关系。
*/
LogFilter?: Array<InstanceAuditLogFilter>;
}
/**
* DescribeBackupConfig请求参数结构体
*/
export interface DescribeBackupConfigRequest {
/**
* 集群ID
*/
ClusterId: 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;
}
/**
* DescribeAccounts请求参数结构体
*/
export interface DescribeAccountsRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 需要过滤的账户列表
*/
AccountNames?: Array<string>;
/**
* 数据库类型,取值范围:
<li> MYSQL </li>
该参数已废用
*/
DbType?: string;
/**
* 需要过滤的账户列表
*/
Hosts?: Array<string>;
/**
* 限制量
*/
Limit?: number;
/**
* 偏移量
*/
Offset?: number;
/**
* 模糊匹配关键字(同时匹配AccountName和AccountHost,返回并集结果,支持正则)
*/
AccountRegular?: string;
}
/**
* ModifyMaintainPeriodConfig请求参数结构体
*/
export interface ModifyMaintainPeriodConfigRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 维护开始时间,单位为秒,如3:00为10800
*/
MaintainStartTime: number;
/**
* 维护持续时间,单位为秒,如1小时为3600
*/
MaintainDuration: number;
/**
* 每周维护日期,日期取值范围[Mon, Tue, Wed, Thu, Fri, Sat, Sun]
*/
MaintainWeekDays: Array<string>;
}
/**
* DescribeRollbackTimeRange返回参数结构体
*/
export interface DescribeRollbackTimeRangeResponse {
/**
* 有效回归时间范围开始时间点(已废弃)
注意:此字段可能返回 null,表示取不到有效值。
*/
TimeRangeStart?: string;
/**
* 有效回归时间范围结束时间点(已废弃)
注意:此字段可能返回 null,表示取不到有效值。
*/
TimeRangeEnd?: string;
/**
* 可回档时间范围
*/
RollbackTimeRanges?: Array<RollbackTimeRange>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 计费资源信息
*/
export interface BillingResourceInfo {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID列表
*/
InstanceIds: Array<string>;
/**
* 订单ID
*/
DealName: string;
}
/**
* DescribeProxies请求参数结构体
*/
export interface DescribeProxiesRequest {
/**
* 集群ID(该参数必传,例如cynosdbmysql-xxxxxx)
*/
ClusterId?: string;
/**
* 返回数量,默认为 20,最大值为 100
*/
Limit?: number;
/**
* 记录偏移量,默认值为0
*/
Offset?: number;
/**
* 排序字段,取值范围:
<li> CREATETIME:创建时间</li>
<li> PERIODENDTIME:过期时间</li>
*/
OrderBy?: string;
/**
* 排序类型,取值范围:
<li> ASC:升序排序 </li>
<li> DESC:降序排序 </li>
*/
OrderByType?: string;
/**
* 搜索条件,若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
*/
Filters?: Array<QueryParamFilter>;
}
/**
* ModifyClusterPasswordComplexity返回参数结构体
*/
export interface ModifyClusterPasswordComplexityResponse {
/**
* 任务流ID
*/
FlowId: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyBackupName返回参数结构体
*/
export interface ModifyBackupNameResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClusterStorage请求参数结构体
*/
export interface ModifyClusterStorageRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 集群新存储大小(单位G)
*/
NewStorageLimit: number;
/**
* 集群原存储大小(单位G)
*/
OldStorageLimit: number;
/**
* 交易模式 0-下单并支付 1-下单
*/
DealMode?: number;
}
/**
* RollBackCluster请求参数结构体
*/
export interface RollBackClusterRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 回档策略 timeRollback-按时间点回档 snapRollback-按备份文件回档
*/
RollbackStrategy: string;
/**
* 备份文件ID。
回档策略为按备份文件回档时必填。
*/
RollbackId: number;
/**
* 期望回档时间。
回档策略为timeRollback按时间点回档时必填。
*/
ExpectTime?: string;
/**
* 期望阈值(已废弃)
*/
ExpectTimeThresh?: number;
/**
* 回档数据库列表
*/
RollbackDatabases?: Array<RollbackDatabase>;
/**
* 回档数据库表列表
*/
RollbackTables?: Array<RollbackTable>;
/**
* 按时间点回档模式,full: 普通; db: 快速; table: 极速 (默认是普通)
*/
RollbackMode?: string;
}
/**
* DescribeAuditLogFiles返回参数结构体
*/
export interface DescribeAuditLogFilesResponse {
/**
* 符合条件的审计日志文件个数。
*/
TotalCount?: number;
/**
* 审计日志文件详情。
*/
Items?: Array<AuditLogFile>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SwitchClusterZone返回参数结构体
*/
export interface SwitchClusterZoneResponse {
/**
* 异步FlowId
*/
FlowId?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据库代理连接池信息
*/
export interface ProxyConnectionPoolInfo {
/**
* 连接池保持阈值:单位(秒)
注意:此字段可能返回 null,表示取不到有效值。
*/
ConnectionPoolTimeOut: number;
/**
* 是否开启了连接池
注意:此字段可能返回 null,表示取不到有效值。
*/
OpenConnectionPool?: string;
/**
* 连接池类型:SessionConnectionPool(会话级别连接池)
注意:此字段可能返回 null,表示取不到有效值。
*/
ConnectionPoolType?: string;
}
/**
* DescribeResourcePackageDetail返回参数结构体
*/
export interface DescribeResourcePackageDetailResponse {
/**
* 资源包抵扣总数
*/
Total?: number;
/**
* 资源包明细说明
*/
Detail?: Array<PackageDetail>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterPasswordComplexity请求参数结构体
*/
export interface DescribeClusterPasswordComplexityRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* AssociateSecurityGroups请求参数结构体
*/
export interface AssociateSecurityGroupsRequest {
/**
* 实例组ID数组
*/
InstanceIds: Array<string>;
/**
* 要修改的安全组ID列表,一个或者多个安全组Id组成的数组。
*/
SecurityGroupIds: Array<string>;
/**
* 可用区
*/
Zone: string;
}
/**
* DescribeBinlogDownloadUrl请求参数结构体
*/
export interface DescribeBinlogDownloadUrlRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* Binlog文件ID
*/
BinlogId: number;
}
/**
* CreateAccounts返回参数结构体
*/
export interface CreateAccountsResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyInstanceName请求参数结构体
*/
export interface ModifyInstanceNameRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 实例名称
*/
InstanceName: string;
}
/**
* SwitchClusterVpc请求参数结构体
*/
export interface SwitchClusterVpcRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 字符串vpc id
*/
UniqVpcId: string;
/**
* 字符串子网id
*/
UniqSubnetId: string;
/**
* 旧地址回收时间
*/
OldIpReserveHours: number;
}
/**
* ModifyClusterDatabase返回参数结构体
*/
export interface ModifyClusterDatabaseResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeClusterVersion返回参数结构体
*/
export interface UpgradeClusterVersionResponse {
/**
* 异步任务id
*/
FlowId?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBSecurityGroups返回参数结构体
*/
export interface DescribeDBSecurityGroupsResponse {
/**
* 安全组信息
*/
Groups?: Array<SecurityGroup>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CloseWan返回参数结构体
*/
export interface CloseWanResponse {
/**
* 任务流ID
*/
FlowId: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 账号参数
*/
export interface AccountParam {
/**
* 参数名称,当前仅支持参数:max_user_connections
*/
ParamName: string;
/**
* 参数值
*/
ParamValue: string;
}
/**
* DescribeBinlogs返回参数结构体
*/
export interface DescribeBinlogsResponse {
/**
* 记录总条数
*/
TotalCount: number;
/**
* Binlog列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Binlogs: Array<BinlogItem>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteParamTemplate返回参数结构体
*/
export interface DeleteParamTemplateResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstances返回参数结构体
*/
export interface DescribeInstancesResponse {
/**
* 实例个数
*/
TotalCount?: number;
/**
* 实例列表
*/
InstanceSet?: Array<CynosdbInstance>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeZones请求参数结构体
*/
export interface DescribeZonesRequest {
/**
* 是否包含虚拟区
*/
IncludeVirtualZones?: boolean;
/**
* 是否展示地域下所有可用区,并显示用户每个可用区权限
*/
ShowPermission?: boolean;
}
/**
* 集群实例信息
*/
export interface ClusterInstanceDetail {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 实例名称
*/
InstanceName?: string;
/**
* 引擎类型
*/
InstanceType?: string;
/**
* 实例状态
*/
InstanceStatus?: string;
/**
* 实例状态描述
*/
InstanceStatusDesc?: string;
/**
* cpu核数
*/
InstanceCpu?: number;
/**
* 内存
*/
InstanceMemory?: number;
/**
* 硬盘
*/
InstanceStorage?: number;
/**
* 实例角色
*/
InstanceRole?: string;
/**
* 执行开始时间(距离0点的秒数)
注意:此字段可能返回 null,表示取不到有效值。
*/
MaintainStartTime?: number;
/**
* 持续的时间(单位:秒)
注意:此字段可能返回 null,表示取不到有效值。
*/
MaintainDuration?: number;
/**
* 可以执行的时间,枚举值:["Mon","Tue","Wed","Thu","Fri", "Sat", "Sun"]
注意:此字段可能返回 null,表示取不到有效值。
*/
MaintainWeekDays?: Array<string>;
/**
* serverless实例子状态
注意:此字段可能返回 null,表示取不到有效值。
*/
ServerlessStatus?: string;
}
/**
* AddClusterSlaveZone返回参数结构体
*/
export interface AddClusterSlaveZoneResponse {
/**
* 异步FlowId
*/
FlowId?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProxySpecs返回参数结构体
*/
export interface DescribeProxySpecsResponse {
/**
* 数据库代理规格列表
*/
ProxySpecs: Array<ProxySpec>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据库地址
*/
export interface OldAddrInfo {
/**
* IP
注意:此字段可能返回 null,表示取不到有效值。
*/
Vip?: string;
/**
* 端口
注意:此字段可能返回 null,表示取不到有效值。
*/
Vport?: number;
/**
* 期望执行回收时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ReturnTime?: string;
}
/**
* ModifyClusterName返回参数结构体
*/
export interface ModifyClusterNameResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例慢查询信息
*/
export 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;
}
/**
* DescribeClusterParams返回参数结构体
*/
export interface DescribeClusterParamsResponse {
/**
* 参数个数
*/
TotalCount?: number;
/**
* 实例参数列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Items?: Array<ParamInfo>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CloseWan请求参数结构体
*/
export interface CloseWanRequest {
/**
* 实例组id
*/
InstanceGrpId: string;
}
/**
* BindClusterResourcePackages请求参数结构体
*/
export interface BindClusterResourcePackagesRequest {
/**
* 资源包唯一ID
*/
PackageIds: Array<string>;
/**
* 集群ID
*/
ClusterId: string;
}
/**
* IsolateInstance返回参数结构体
*/
export interface IsolateInstanceResponse {
/**
* 任务流id
*/
FlowId?: number;
/**
* 隔离实例的订单id(预付费实例)
注意:此字段可能返回 null,表示取不到有效值。
*/
DealNames?: Array<string>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 审计日志过滤条件。查询审计日志时,用户过滤返回的审计日志。
*/
export interface AuditLogFilter {
/**
* 客户端地址。
*/
Host?: Array<string>;
/**
* 用户名。
*/
User?: Array<string>;
/**
* 数据库名称。
*/
DBName?: Array<string>;
/**
* 表名称。
*/
TableName?: Array<string>;
/**
* 审计策略名称。
*/
PolicyName?: Array<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?: Array<string>;
/**
* SQL 语句。支持传递多个sql语句。
*/
Sqls?: Array<string>;
/**
* 返回行数。
*/
SentRows?: number;
/**
* 线程ID。
*/
ThreadId?: Array<string>;
}
/**
* DescribeParamTemplates请求参数结构体
*/
export interface DescribeParamTemplatesRequest {
/**
* 数据库引擎版本号
*/
EngineVersions?: Array<string>;
/**
* 模板名称
*/
TemplateNames?: Array<string>;
/**
* 模板ID
*/
TemplateIds?: Array<number | bigint>;
/**
* 数据库类型,可选值:NORMAL,SERVERLESS
*/
DbModes?: Array<string>;
/**
* 查询偏移量
*/
Offset?: number;
/**
* 查询限制条数
*/
Limit?: number;
/**
* 查询的模板对应的产品类型
*/
Products?: Array<string>;
/**
* 模板类型
*/
TemplateTypes?: Array<string>;
/**
* 版本类型
*/
EngineTypes?: Array<string>;
/**
* 返回结果的排序字段
*/
OrderBy?: string;
/**
* 排序方式(asc、desc)
*/
OrderDirection?: string;
}
/**
* CopyClusterPasswordComplexity返回参数结构体
*/
export interface CopyClusterPasswordComplexityResponse {
/**
* 任务流ID
*/
FlowId?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeProxyVersion请求参数结构体
*/
export interface UpgradeProxyVersionRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 数据库代理当前版本
*/
SrcProxyVersion: string;
/**
* 数据库代理升级版本
*/
DstProxyVersion: string;
/**
* 数据库代理组ID
*/
ProxyGroupId?: string;
/**
* 升级时间 :no(升级完成时)yes(实例维护时间)
*/
IsInMaintainPeriod?: string;
}
/**
* OfflineInstance请求参数结构体
*/
export interface OfflineInstanceRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID数组
*/
InstanceIdList: Array<string>;
}
/**
* DescribeAuditLogs返回参数结构体
*/
export interface DescribeAuditLogsResponse {
/**
* 符合条件的审计日志条数。
*/
TotalCount?: number;
/**
* 审计日志详情。
注意:此字段可能返回 null,表示取不到有效值。
*/
Items?: Array<AuditLog>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceParams请求参数结构体
*/
export interface DescribeInstanceParamsRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID,支持批量查询
*/
InstanceIds: Array<string>;
/**
* 参数名搜索条件,支持模糊匹配
*/
ParamKeyword?: string;
}
/**
* DescribeProxies返回参数结构体
*/
export interface DescribeProxiesResponse {
/**
* 数据库代理组数
*/
TotalCount?: number;
/**
* 数据库代理组列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ProxyGroupInfos?: Array<ProxyGroupInfo>;
/**
* 数据库代理节点
注意:此字段可能返回 null,表示取不到有效值。
*/
ProxyNodeInfos?: Array<ProxyNodeInfo>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyResourcePackageClusters请求参数结构体
*/
export interface ModifyResourcePackageClustersRequest {
/**
* 资源包唯一ID
*/
PackageId: string;
/**
* 需要建立绑定关系的集群ID
*/
BindClusterIds?: Array<string>;
/**
* 需要解除绑定关系的集群ID
*/
UnbindClusterIds?: Array<string>;
}
/**
* DeleteParamTemplate请求参数结构体
*/
export interface DeleteParamTemplateRequest {
/**
* 参数模板ID
*/
TemplateId: number;
}
/**
* 数据库详细信息
*/
export interface DbInfo {
/**
* 数据库名称
*/
DbName?: string;
/**
* 字符集类型
*/
CharacterSet?: string;
/**
* 数据库状态
*/
Status?: string;
/**
* 排序规则
*/
CollateRule?: string;
/**
* 数据库备注
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
/**
* 用户权限
注意:此字段可能返回 null,表示取不到有效值。
*/
UserHostPrivileges?: Array<UserHostPrivilege>;
/**
* 数据库ID
注意:此字段可能返回 null,表示取不到有效值。
*/
DbId?: number;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: string;
/**
* 用户appid
注意:此字段可能返回 null,表示取不到有效值。
*/
AppId?: number;
/**
* 用户Uin
注意:此字段可能返回 null,表示取不到有效值。
*/
Uin?: string;
/**
* 集群Id
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterId?: string;
}
/**
* DescribeFlow返回参数结构体
*/
export interface DescribeFlowResponse {
/**
* 任务流状态。0-成功,1-失败,2-处理中
*/
Status: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例参数详细描述
*/
export 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;
/**
* 参数的可选枚举值。如果为非枚举值,则为空
注意:此字段可能返回 null,表示取不到有效值。
*/
EnumValue: Array<string>;
/**
* 1:全局参数,0:非全局参数
*/
IsGlobal: number;
/**
* 匹配类型,multiVal
*/
MatchType: string;
/**
* 匹配目标值,当multiVal时,各个key用,分割
*/
MatchValue: string;
/**
* true-为公式,false-非公式
注意:此字段可能返回 null,表示取不到有效值。
*/
IsFunc: boolean;
/**
* 参数设置为公式时,Func返回设置的公式内容
注意:此字段可能返回 null,表示取不到有效值。
*/
Func: string;
/**
* 参数是否可修改
注意:此字段可能返回 null,表示取不到有效值。
*/
ModifiableInfo: ModifiableInfo;
}
/**
* DescribeResourcePackageSaleSpec请求参数结构体
*/
export interface DescribeResourcePackageSaleSpecRequest {
/**
* 实例类型
*/
InstanceType: string;
/**
* 资源包使用地域
china-中国内地通用,overseas-港澳台及海外通用
*/
PackageRegion: string;
/**
* 资源包类型
CCU-计算资源包
DISK-存储资源包
*/
PackageType: string;
/**
* 偏移量
*/
Offset?: number;
/**
* 限制
*/
Limit?: number;
}
/**
* ExportInstanceErrorLogs请求参数结构体
*/
export interface ExportInstanceErrorLogsRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 日志最早时间
*/
StartTime?: string;
/**
* 日志最晚时间
*/
EndTime?: string;
/**
* 限制条数
*/
Limit?: number;
/**
* 偏移量
*/
Offset?: number;
/**
* 日志等级
*/
LogLevels?: Array<string>;
/**
* 关键字
*/
KeyWords?: Array<string>;
/**
* 文件类型,可选值:csv, original
*/
FileType?: string;
/**
* 可选值Timestamp
*/
OrderBy?: string;
/**
* ASC或DESC
*/
OrderByType?: string;
}
/**
* SearchClusterTables返回参数结构体
*/
export interface SearchClusterTablesResponse {
/**
* 数据表列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Tables?: Array<DatabaseTables>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBackupConfig返回参数结构体
*/
export interface DescribeBackupConfigResponse {
/**
* 表示全备开始时间,[0-24*3600], 如0:00, 1:00, 2:00 分别为 0,3600, 7200
*/
BackupTimeBeg?: number;
/**
* 表示全备开始时间,[0-24*3600], 如0:00, 1:00, 2:00 分别为 0,3600, 7200
*/
BackupTimeEnd?: number;
/**
* 表示保留备份时长, 单位秒,超过该时间将被清理, 七天表示为3600*24*7=604800
*/
ReserveDuration?: number;
/**
* 备份频率,长度为7的数组,分别对应周一到周日的备份方式,full-全量备份,increment-增量备份
注意:此字段可能返回 null,表示取不到有效值。
*/
BackupFreq?: Array<string>;
/**
* 备份方式,logic-逻辑备份,snapshot-快照备份
注意:此字段可能返回 null,表示取不到有效值。
*/
BackupType?: string;
/**
* 跨地域逻辑备份配置修改时间
注意:此字段可能返回 null,表示取不到有效值。
*/
LogicCrossRegionsConfigUpdateTime?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateClusters返回参数结构体
*/
export interface CreateClustersResponse {
/**
* 冻结流水ID
注意:此字段可能返回 null,表示取不到有效值。
*/
TranId?: string;
/**
* 订单号
注意:此字段可能返回 null,表示取不到有效值。
*/
DealNames?: Array<string>;
/**
* 资源ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取资源ID)
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceIds?: Array<string>;
/**
* 集群ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取集群ID)
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterIds?: Array<string>;
/**
* 大订单号
注意:此字段可能返回 null,表示取不到有效值。
*/
BigDealIds?: Array<string>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SetRenewFlag请求参数结构体
*/
export interface SetRenewFlagRequest {
/**
* 需操作的集群ID
*/
ResourceIds: Array<string>;
/**
* 自动续费标志位,续费标记 0:正常续费 1:自动续费 2:到期不续
*/
AutoRenewFlag: number;
}
/**
* 规则模板内容
*/
export interface RuleTemplateInfo {
/**
* 规则模板ID。
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleTemplateId?: string;
/**
* 规则模板名称。
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleTemplateName?: string;
/**
* 规则内容。
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleFilters?: Array<RuleFilters>;
/**
* 告警等级。1-低风险,2-中风险,3-高风险。
注意:此字段可能返回 null,表示取不到有效值。
*/
AlarmLevel?: number;
/**
* 告警策略。0-不告警,1-告警。
注意:此字段可能返回 null,表示取不到有效值。
*/
AlarmPolicy?: number;
/**
* 规则描述。
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: 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;
/**
* 审计规则过滤条件的匹配值。
*/
Value: Array<string>;
}
/**
* OfflineCluster请求参数结构体
*/
export interface OfflineClusterRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* DescribeClusterDetailDatabases返回参数结构体
*/
export interface DescribeClusterDetailDatabasesResponse {
/**
* 数据库信息
注意:此字段可能返回 null,表示取不到有效值。
*/
DbInfos: Array<DbInfo>;
/**
* 总数
*/
TotalCount: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例组信息
*/
export 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?: Array<CynosdbInstance>;
/**
* VPC的ID
注意:此字段可能返回 null,表示取不到有效值。
*/
UniqVpcId?: string;
/**
* 子网ID
注意:此字段可能返回 null,表示取不到有效值。
*/
UniqSubnetId?: string;
/**
* 正在回收IP信息
注意:此字段可能返回 null,表示取不到有效值。
*/
OldAddrInfo?: OldAddrInfo;
/**
* 正在进行的任务
*/
ProcessingTasks?: Array<string>;
/**
* 任务列表
*/
Tasks?: Array<ObjectTask>;
/**
* biz_net_service表id
*/
NetServiceId: number;
}
/**
* CreateParamTemplate返回参数结构体
*/
export interface CreateParamTemplateResponse {
/**
* 模板ID
*/
TemplateId?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 可用区库存信息
*/
export interface ZoneStockInfo {
/**
* 可用区
*/
Zone?: string;
/**
* 是否有库存
*/
HasStock?: boolean;
/**
* 库存数量
*/
StockCount?: number;
}
/**
* ActivateInstance请求参数结构体
*/
export interface ActivateInstanceRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例 ID 列表,单个实例 ID 格式如:cynosdbmysql-ins-n7ocdslw,与TDSQL-C MySQL数据库控制台页面中显示的实例 ID 相同,可使用 查询实例列表 接口获取,其值为输出参数中字段 InstanceId 的值。
*/
InstanceIdList: Array<string>;
}
/**
* RevokeAccountPrivileges返回参数结构体
*/
export interface RevokeAccountPrivilegesResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据库表信息
*/
export interface DatabaseTables {
/**
* 数据库名
注意:此字段可能返回 null,表示取不到有效值。
*/
Database?: string;
/**
* 表名称列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Tables?: Array<string>;
}
/**
* proxy组
*/
export interface ProxyGroup {
/**
* 数据库代理组ID
*/
ProxyGroupId: string;
/**
* 数据库代理组节点个数
*/
ProxyNodeCount: number;
/**
* 数据库代理组状态
*/
Status: string;
/**
* 地域
*/
Region: string;
/**
* 可用区
*/
Zone: string;
/**
* 当前代理版本
*/
CurrentProxyVersion: string;
/**
* 集群ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterId: string;
/**
* 用户AppId
注意:此字段可能返回 null,表示取不到有效值。
*/
AppId: number;
/**
* 读写节点开通数据库代理
注意:此字段可能返回 null,表示取不到有效值。
*/
OpenRw: string;
}
/**
* AddClusterSlaveZone请求参数结构体
*/
export interface AddClusterSlaveZoneRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 从可用区
*/
SlaveZone: string;
}
/**
* RemoveClusterSlaveZone返回参数结构体
*/
export interface RemoveClusterSlaveZoneResponse {
/**
* 异步FlowId
*/
FlowId?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例错误日志返回类型
*/
export interface CynosdbErrorLogItem {
/**
* 日志时间戳
注意:此字段可能返回 null,表示取不到有效值。
*/
Timestamp?: number;
/**
* 日志等级
注意:此字段可能返回 null,表示取不到有效值。
*/
Level?: string;
/**
* 日志内容
注意:此字段可能返回 null,表示取不到有效值。
*/
Content?: string;
}
/**
* DescribeAccountAllGrantPrivileges返回参数结构体
*/
export interface DescribeAccountAllGrantPrivilegesResponse {
/**
* 权限语句
注意:此字段可能返回 null,表示取不到有效值。
*/
PrivilegeStatements?: Array<string>;
/**
* 全局权限
注意:此字段可能返回 null,表示取不到有效值。
*/
GlobalPrivileges?: Array<string>;
/**
* 数据库权限
注意:此字段可能返回 null,表示取不到有效值。
*/
DatabasePrivileges?: Array<DatabasePrivileges>;
/**
* 数据库表权限
注意:此字段可能返回 null,表示取不到有效值。
*/
TablePrivileges?: Array<TablePrivileges>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 回滚数据库信息
*/
export interface RollbackDatabase {
/**
* 旧数据库名称
*/
OldDatabase: string;
/**
* 新数据库名称
*/
NewDatabase: string;
}
/**
* ModifyVipVport请求参数结构体
*/
export interface ModifyVipVportRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 实例组id
*/
InstanceGrpId: string;
/**
* 需要修改的目的ip
*/
Vip?: string;
/**
* 需要修改的目的端口
*/
Vport?: number;
/**
* 数据库类型,取值范围:
<li> MYSQL </li>
*/
DbType?: string;
/**
* 旧ip回收前的保留时间,单位小时,0表示立即回收
*/
OldIpReserveHours?: number;
}
/**
* 数据库权限列表
*/
export interface DatabasePrivileges {
/**
* 数据库
注意:此字段可能返回 null,表示取不到有效值。
*/
Db: string;
/**
* 权限列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Privileges: Array<string>;
}
/**
* DescribeClusters请求参数结构体
*/
export interface DescribeClustersRequest {
/**
* 引擎类型:目前支持“MYSQL”, “POSTGRESQL”
*/
DbType?: string;
/**
* 返回数量,默认为 20,最大值为 100
*/
Limit?: number;
/**
* 记录偏移量,默认值为0
*/
Offset?: number;
/**
* 排序字段,取值范围:
<li> CREATETIME:创建时间</li>
<li> PERIODENDTIME:过期时间</li>
*/
OrderBy?: string;
/**
* 排序类型,取值范围:
<li> ASC:升序排序 </li>
<li> DESC:降序排序 </li>
*/
OrderByType?: string;
/**
* 搜索条件,若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
*/
Filters?: Array<QueryFilter>;
}
/**
* 修改参数时,传入参数描述
*/
export interface ParamItem {
/**
* 参数名称
*/
ParamName: string;
/**
* 当前值
*/
CurrentValue: string;
/**
* 原有值
*/
OldValue: string;
}
/**
* DescribeSupportProxyVersion请求参数结构体
*/
export interface DescribeSupportProxyVersionRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 数据库代理组ID
*/
ProxyGroupId?: string;
}
/**
* ModifyClusterStorage返回参数结构体
*/
export interface ModifyClusterStorageResponse {
/**
* 冻结流水ID
注意:此字段可能返回 null,表示取不到有效值。
*/
TranId?: string;
/**
* 大订单号
注意:此字段可能返回 null,表示取不到有效值。
*/
BigDealIds?: Array<string>;
/**
* 订单号
注意:此字段可能返回 null,表示取不到有效值。
*/
DealNames?: Array<string>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProxySpecs请求参数结构体
*/
export declare type DescribeProxySpecsRequest = null;
/**
* CloseClusterPasswordComplexity请求参数结构体
*/
export interface CloseClusterPasswordComplexityRequest {
/**
* 集群ID数组
*/
ClusterIds: Array<string>;
}
/**
* ModifyDBInstanceSecurityGroups返回参数结构体
*/
export interface ModifyDBInstanceSecurityGroupsResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteAuditLogFile返回参数结构体
*/
export interface DeleteAuditLogFileResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterParamLogs返回参数结构体
*/
export interface DescribeClusterParamLogsResponse {
/**
* 记录总数
*/
TotalCount?: number;
/**
* 参数修改记录
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterParamLogs?: Array<ClusterParamModifyLog>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterInstanceGrps请求参数结构体
*/
export interface DescribeClusterInstanceGrpsRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* DescribeResourcesByDealName返回参数结构体
*/
export interface DescribeResourcesByDealNameResponse {
/**
* 计费资源id信息数组
*/
BillingResourceInfos?: Array<BillingResourceInfo>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例网络信息
*/
export interface InstanceNetInfo {
/**
* 网络类型
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceGroupType?: string;
/**
* 实例组ID
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceGroupId?: string;
/**
* 私有网络ID
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId?: string;
/**
* 子网ID
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId?: string;
/**
* 网络类型, 0-基础网络, 1-vpc网络, 2-黑石网络
注意:此字段可能返回 null,表示取不到有效值。
*/
NetType?: number;
/**
* 私有网络IP
注意:此字段可能返回 null,表示取不到有效值。
*/
Vip?: string;
/**
* 私有网络端口
注意:此字段可能返回 null,表示取不到有效值。
*/
Vport?: number;
/**
* 外网域名
注意:此字段可能返回 null,表示取不到有效值。
*/
WanDomain?: string;
/**
* 外网IP
注意:此字段可能返回 null,表示取不到有效值。
*/
WanIP?: string;
/**
* 外网端口
注意:此字段可能返回 null,表示取不到有效值。
*/
WanPort?: number;
/**
* 外网开启状态
注意:此字段可能返回 null,表示取不到有效值。
*/
WanStatus?: string;
}
/**
* CreateAccounts请求参数结构体
*/
export interface CreateAccountsRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 新账户列表
*/
Accounts: Array<NewAccount>;
}
/**
* DeleteAuditRuleTemplates请求参数结构体
*/
export interface DeleteAuditRuleTemplatesRequest {
/**
* 审计规则模板ID。
*/
RuleTemplateIds: Array<string>;
}
/**
* DescribeAuditRuleTemplates返回参数结构体
*/
export interface DescribeAuditRuleTemplatesResponse {
/**
* 符合查询条件的实例总数。
*/
TotalCount?: number;
/**
* 规则模板详细信息列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
Items?: Array<AuditRuleTemplateInfo>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 资源包
*/
export interface Package {
/**
* AppID
注意:此字段可能返回 null,表示取不到有效值。
*/
AppId?: number;
/**
* 资源包唯一ID
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageId?: string;
/**
* 资源包名称
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageName?: string;
/**
* 资源包类型
CCU-计算资源包,DISK-存储资源包
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageType?: string;
/**
* 资源包使用地域
china-中国内地通用,overseas-港澳台及海外通用
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageRegion?: string;
/**
* 资源包状态
creating-创建中;
using-使用中;
expired-已过期;
normal_finish-使用完;
apply_refund-申请退费中;
refund-已退费。
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: string;
/**
* 资源包总量
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageTotalSpec?: number;
/**
* 资源包已使用量
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageUsedSpec?: number;
/**
* 是否还有库存余量
注意:此字段可能返回 null,表示取不到有效值。
*/
HasQuota?: boolean;
/**
* 绑定实例信息
注意:此字段可能返回 null,表示取不到有效值。
*/
BindInstanceInfos?: Array<BindInstanceInfo>;
/**
* 生效时间:2022-07-01 00:00:00
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime?: string;
/**
* 失效时间:2022-08-01 00:00:00
注意:此字段可能返回 null,表示取不到有效值。
*/
ExpireTime?: string;
/**
* 资源包历史绑定(已解绑)实例信息
注意:此字段可能返回 null,表示取不到有效值。
*/
HistoryBindResourceInfos?: Array<BindInstanceInfo>;
}
/**
* SwitchClusterZone请求参数结构体
*/
export interface SwitchClusterZoneRequest {
/**
* 集群Id
*/
ClusterId: string;
/**
* 当前可用区
*/
OldZone: string;
/**
* 要切换到的可用区
*/
NewZone: string;
/**
* 维护期间执行-yes,立即执行-no
*/
IsInMaintainPeriod?: string;
}
/**
* 实例参数信息
*/
export interface InstanceParamItem {
/**
* 实例ID
*/
InstanceId: string;
/**
* 实例参数列表
*/
ParamsItems: Array<ParamItemDetail>;
}
/**
* ReloadBalanceProxyNode请求参数结构体
*/
export interface ReloadBalanceProxyNodeRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 数据库代理组ID
*/
ProxyGroupId: string;
}
/**
* DescribeInstanceDetail请求参数结构体
*/
export interface DescribeInstanceDetailRequest {
/**
* 实例ID
*/
InstanceId: string;
}
/**
* proxy节点可用区内个数
*/
export interface ProxyZone {
/**
* proxy节点可用区
*/
ProxyNodeZone?: string;
/**
* proxy节点数量
*/
ProxyNodeCount?: number;
}
/**
* 集群支持的功能
*/
export interface Ability {
/**
* 是否支持从可用区
*/
IsSupportSlaveZone: string;
/**
* 不支持从可用区的原因
注意:此字段可能返回 null,表示取不到有效值。
*/
NonsupportSlaveZoneReason: string;
/**
* 是否支持RO实例
*/
IsSupportRo: string;
/**
* 不支持RO实例的原因
注意:此字段可能返回 null,表示取不到有效值。
*/
NonsupportRoReason: string;
}
/**
* 实例初始化配置信息
*/
export 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;
}
/**
* 资源包明细说明
*/
export interface PackageDetail {
/**
* AppId账户ID
注意:此字段可能返回 null,表示取不到有效值。
*/
AppId?: number;
/**
* 资源包唯一ID
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageId?: string;
/**
* 实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId?: string;
/**
* 成功抵扣容量
注意:此字段可能返回 null,表示取不到有效值。
*/
SuccessDeductSpec?: number;
/**
* 截止当前,资源包已使用的容量
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageTotalUsedSpec?: number;
/**
* 抵扣开始时间
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime?: string;
/**
* 抵扣结束时间
注意:此字段可能返回 null,表示取不到有效值。
*/
EndTime?: string;
/**
* 扩展信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ExtendInfo?: string;
}
/**
* UpgradeInstance请求参数结构体
*/
export interface UpgradeInstanceRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 数据库CPU
*/
Cpu: number;
/**
* 数据库内存,单位GB
*/
Memory: number;
/**
* 升级类型:upgradeImmediate,upgradeInMaintain
*/
UpgradeType: string;
/**
* 该参数已废弃
*/
StorageLimit?: number;
/**
* 是否自动选择代金券 1是 0否 默认为0
*/
AutoVoucher?: number;
/**
* 该参数已废弃
*/
DbType?: string;
/**
* 交易模式 0-下单并支付 1-下单
*/
DealMode?: number;
/**
* NormalUpgrade:普通变配,FastUpgrade:极速变配,若变配过程判断会造成闪断,变配流程会终止。
*/
UpgradeMode?: string;
}
/**
* ModifyMaintainPeriodConfig返回参数结构体
*/
export interface ModifyMaintainPeriodConfigResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* IsolateInstance请求参数结构体
*/
export interface IsolateInstanceRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID数组,例如["cynosdbbmysql-ins-asd","cynosdbmysql-ins-zxc"]
*/
InstanceIdList: Array<string>;
/**
* 该参数已废弃
*/
DbType?: string;
}
/**
* SetRenewFlag返回参数结构体
*/
export interface SetRenewFlagResponse {
/**
* 操作成功实例数
*/
Count?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterDetail请求参数结构体
*/
export interface DescribeClusterDetailRequest {
/**
* 集群Id
*/
ClusterId: string;
}
/**
* SwitchClusterVpc返回参数结构体
*/
export interface SwitchClusterVpcResponse {
/**
* 异步任务id。
*/
FlowId?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SearchClusterTables请求参数结构体
*/
export interface SearchClusterTablesRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 数据库名
*/
Database?: string;
/**
* 数据表名
*/
Table?: string;
/**
* 数据表类型:
view:只返回 view,
base_table: 只返回基本表,
all:返回 view 和表
*/
TableType?: string;
}
/**
* DeleteBackup返回参数结构体
*/
export interface DeleteBackupResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyInstanceParam请求参数结构体
*/
export interface ModifyInstanceParamRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID
*/
InstanceIds?: Array<string>;
/**
* 集群参数列表,例如 [{ "CurrentValue":"2", "ParamName":"auto_increment_increment"}]
*/
ClusterParamList?: Array<ModifyParamItem>;
/**
* 实例参数列表,例如[{ "CurrentValue":"2", "ParamName":"innodb_stats_transient_sample_pages"}]
*/
InstanceParamList?: Array<ModifyParamItem>;
/**
* yes:在运维时间窗内修改,no:立即执行(默认值)
*/
IsInMaintainPeriod?: string;
}
/**
* DescribeProjectSecurityGroups返回参数结构体
*/
export interface DescribeProjectSecurityGroupsResponse {
/**
* 安全组详情
*/
Groups: Array<SecurityGroup>;
/**
* 总数量
*/
Total: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyResourcePackageName请求参数结构体
*/
export interface ModifyResourcePackageNameRequest {
/**
* 资源包唯一ID
*/
PackageId: string;
/**
* 自定义的资源包名称,最长支持120个字符
*/
PackageName: string;
}
/**
* CreateAuditLogFile返回参数结构体
*/
export interface CreateAuditLogFileResponse {
/**
* 审计日志文件名称。
*/
FileName?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenWan返回参数结构体
*/
export interface OpenWanResponse {
/**
* 任务流ID
*/
FlowId: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* PauseServerless返回参数结构体
*/
export interface PauseServerlessResponse {
/**
* 异步流程ID
*/
FlowId: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenClusterReadOnlyInstanceGroupAccess返回参数结构体
*/
export interface OpenClusterReadOnlyInstanceGroupAccessResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAuditRuleWithInstanceIds返回参数结构体
*/
export interface DescribeAuditRuleWithInstanceIdsResponse {
/**
* 无
*/
TotalCount?: number;
/**
* 实例审计规则信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
Items?: Array<InstanceAuditRule>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeProxyVersion返回参数结构体
*/
export interface UpgradeProxyVersionResponse {
/**
* 异步流程ID
*/
FlowId?: number;
/**
* 异步任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ResetAccountPassword返回参数结构体
*/
export interface ResetAccountPasswordResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* x08新创建的账号
*/
export interface NewAccount {
/**
* 账户名,包含字母数字_,以字母开头,字母或数字结尾,长度1-30
*/
AccountName: string;
/**
* 密码,密码长度范围为8到64个字符
*/
AccountPassword: string;
/**
* 主机(%或ipv4地址)
*/
Host: string;
/**
* 描述
*/
Description?: string;
/**
* 用户最大连接数,不能大于10240
*/
MaxUserConnections?: number;
}
/**
* 备份文件信息
*/
export 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
注意:此字段可能返回 null,表示取不到有效值。
*/
BackupId?: number;
/**
* 快照类型,可选值:full,全量;increment,增量
注意:此字段可能返回 null,表示取不到有效值。
*/
SnapShotType?: string;
/**
* 备份文件备注
注意:此字段可能返回 null,表示取不到有效值。
*/
BackupName?: string;
}
/**
* mysql表权限
*/
export interface TablePrivileges {
/**
* 数据库名
注意:此字段可能返回 null,表示取不到有效值。
*/
Db: string;
/**
* 表名
注意:此字段可能返回 null,表示取不到有效值。
*/
TableName: string;
/**
* 权限列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Privileges: Array<string>;
}
/**
* UpgradeProxy请求参数结构体
*/
export interface UpgradeProxyRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* cpu核数
*/
Cpu: number;
/**
* 内存
*/
Mem: number;
/**
* 数据库代理组节点个数
*/
ProxyCount?: number;
/**
* 数据库代理组ID(已废弃)
*/
ProxyGroupId?: string;
/**
* 重新负载均衡:auto(自动),manual(手动)
*/
ReloadBalance?: string;
/**
* 升级时间 :no(升级完成时)yes(实例维护时间)
*/
IsInMaintainPeriod?: string;
/**
* 数据库代理节点信息
*/
ProxyZones?: Array<ProxyZone>;
}
/**
* DescribeClusterDetailDatabases请求参数结构体
*/
export interface DescribeClusterDetailDatab