UNPKG

tencentcloud-sdk-nodejs

Version:
2,904 lines (2,889 loc) 233 kB
/** * UpgradeProxyVersion返回参数结构体 */ export interface UpgradeProxyVersionResponse { /** * 异步流程ID */ FlowId?: number; /** * 异步任务id */ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceCLSLogDelivery返回参数结构体 */ export interface DescribeInstanceCLSLogDeliveryResponse { /** * 总数量 */ TotalCount?: number; /** * 实例投递信息 */ InstanceCLSDeliveryInfos?: Array<InstanceCLSDeliveryInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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>; } /** * 实例参数修改任务详情 */ export interface BizTaskModifyInstanceParam { /** * 实例ID */ InstanceId?: string; /** * 实例参数修改任务详情 */ ModifyInstanceParamList?: Array<ModifyParamItem>; } /** * ModifyClusterStorage请求参数结构体 */ export interface ModifyClusterStorageRequest { /** * 集群ID */ ClusterId: string; /** * 集群新存储大小(单位G) */ NewStorageLimit: number; /** * 集群原存储大小(单位G) */ OldStorageLimit: number; /** * 交易模式 0-下单并支付 1-下单 */ DealMode?: number; } /** * DescribeResourcePackageDetail返回参数结构体 */ export interface DescribeResourcePackageDetailResponse { /** * 资源包抵扣总数 */ Total?: number; /** * 资源包明细说明 */ Detail?: Array<PackageDetail>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SearchClusterTables请求参数结构体 */ export interface SearchClusterTablesRequest { /** * 集群id */ ClusterId: string; /** * 数据库名 */ Database?: string; /** * 数据表名 */ Table?: string; /** * 数据表类型: view:只返回 view, base_table: 只返回基本表, all:返回 view 和表 */ TableType?: string; } /** * DescribeMaintainPeriod请求参数结构体 */ export interface DescribeMaintainPeriodRequest { /** * 实例ID */ InstanceId: string; } /** * 账号参数 */ export interface AccountParam { /** * 参数名称,当前仅支持参数:max_user_connections */ ParamName: string; /** * 参数值 */ ParamValue: string; } /** * DescribeClusterDatabaseTables请求参数结构体 */ export interface DescribeClusterDatabaseTablesRequest { /** * 集群id */ ClusterId: string; /** * 数据库名 */ Db: string; /** * 偏移 */ Offset?: number; /** * 个数 */ Limit?: number; /** * 数据表类型。 "view"表示只返回 view,"base_table" 表示只返回基本表,"all" 表示返回 view 和表。默认为 all。 */ TableType?: string; } /** * DescribeClusterParams返回参数结构体 */ export interface DescribeClusterParamsResponse { /** * 参数个数 */ TotalCount?: number; /** * 实例参数列表 */ Items?: Array<ParamInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RefundResourcePackage返回参数结构体 */ export interface RefundResourcePackageResponse { /** * 每个物品对应一个dealName,业务需要根据dealName保证发货接口幂等 */ DealNames?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceName返回参数结构体 */ export interface ModifyInstanceNameResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; } /** * DescribeAuditInstanceList返回参数结构体 */ export interface DescribeAuditInstanceListResponse { /** * 符合查询条件的实例总数。 */ TotalCount?: number; /** * 审计实例详细信息列表。 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array<InstanceAuditStatus>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeProxies返回参数结构体 */ export interface DescribeProxiesResponse { /** * 数据库代理组数 */ TotalCount?: number; /** * 数据库代理组列表 */ ProxyGroupInfos?: Array<ProxyGroupInfo>; /** * 数据库代理节点 注意:此字段可能返回 null,表示取不到有效值。 */ ProxyNodeInfos?: Array<ProxyNodeInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClusterDetailDatabases请求参数结构体 */ export interface DescribeClusterDetailDatabasesRequest { /** * 集群ID */ ClusterId: string; /** * 偏移量,默认0 */ Offset?: number; /** * 返回数量,默认20,最大100 */ Limit?: number; /** * 数据库名称 */ DbName?: string; } /** * 回档RO组信息 */ export interface RollbackRoGroupInfo { /** * 实例组ID */ InstanceGroupId?: string; /** * vpc信息 */ UniqVpcId?: string; /** * 子网信息 */ UniqSubnetId?: string; /** * vip信息 */ Vip?: string; /** * vport信息 */ Vport?: number; } /** * CreateClusters返回参数结构体 */ export interface CreateClustersResponse { /** * 冻结流水ID */ TranId?: string; /** * 订单号 */ DealNames?: Array<string>; /** * 资源ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取资源ID) */ ResourceIds?: Array<string>; /** * 集群ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取集群ID) */ ClusterIds?: Array<string>; /** * 大订单号 注意:此字段可能返回 null,表示取不到有效值。 */ BigDealIds?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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; } /** * 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; } /** * ModifyInstanceUpgradeLimitDays返回参数结构体 */ export interface ModifyInstanceUpgradeLimitDaysResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库表信息 */ export interface DatabaseTables { /** * 数据库名 */ Database?: string; /** * 表名称列表 */ Tables?: Array<string>; } /** * 用户主机权限 */ export interface UserHostPrivilege { /** * 授权用户 */ DbUserName: string; /** * 客户端ip */ DbHost: string; /** * 用户权限 */ DbPrivilege: string; } /** * StopCLSDelivery请求参数结构体 */ export interface StopCLSDeliveryRequest { /** * 实例id */ InstanceId: string; /** * 日志主题id */ CLSTopicIds: Array<string>; /** * 日志类型 */ LogType?: string; /** * 是否维护时间运行 */ IsInMaintainPeriod?: string; } /** * ExportResourcePackageDeductDetails返回参数结构体 */ export interface ExportResourcePackageDeductDetailsResponse { /** * 文件详情 */ FileContent?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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>; } /** * OpenReadOnlyInstanceExclusiveAccess返回参数结构体 */ export interface OpenReadOnlyInstanceExclusiveAccessResponse { /** * 开通流程ID */ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SearchClusterDatabases返回参数结构体 */ export interface SearchClusterDatabasesResponse { /** * 数据库列表 注意:此字段可能返回 null,表示取不到有效值。 */ Databases?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateParamTemplate请求参数结构体 */ export interface CreateParamTemplateRequest { /** * 模板名称 */ TemplateName: string; /** * mysql版本号 */ EngineVersion: string; /** * 模板描述 */ TemplateDescription?: string; /** * 可选参数,需要复制的模板ID */ TemplateId?: number; /** * 数据库类型,可选值:NORMAL(默认值),SERVERLESS */ DbMode?: string; /** * 参数列表 */ ParamList?: Array<ParamItem>; } /** * DescribeClusterDetail请求参数结构体 */ export interface DescribeClusterDetailRequest { /** * 集群Id */ ClusterId: string; } /** * ModifyResourcePackageName请求参数结构体 */ export interface ModifyResourcePackageNameRequest { /** * 资源包唯一ID */ PackageId: string; /** * 自定义的资源包名称,最长支持120个字符 */ PackageName: string; } /** * 添加实例或者变配实例时同步升级proxy. */ export interface UpgradeProxy { /** * cpu */ Cpu: number; /** * memory */ Mem: number; /** * 代理节点信息 */ ProxyZones: Array<ProxyZone>; /** * 重新负载均衡 */ ReloadBalance?: string; } /** * 备份文件信息 */ 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 */ BackupId?: number; /** * 快照类型,可选值:full,全量;increment,增量 */ SnapShotType?: string; /** * 备份文件备注 */ BackupName?: 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>; } /** * DescribeBinlogDownloadUrl返回参数结构体 */ export interface DescribeBinlogDownloadUrlResponse { /** * 下载地址 */ DownloadUrl?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SwitchClusterVpc请求参数结构体 */ export interface SwitchClusterVpcRequest { /** * 集群ID */ ClusterId: string; /** * 字符串vpc id */ UniqVpcId: string; /** * 字符串子网id */ UniqSubnetId: string; /** * 旧地址回收时间 */ OldIpReserveHours: number; } /** * CloseProxy请求参数结构体 */ export interface CloseProxyRequest { /** * 集群ID */ ClusterId: string; /** * 数据库代理组ID */ ProxyGroupId?: string; /** * 是否只关闭读写分离,取值:是 "true","false" */ OnlyCloseRW?: boolean; } /** * 实例信息 */ export interface CynosdbInstance { /** * 用户Uin */ Uin?: string; /** * 用户AppId */ AppId?: number; /** * 集群ID */ ClusterId?: string; /** * 集群名称 */ ClusterName?: string; /** * 实例ID */ InstanceId?: string; /** * 实例名称 */ InstanceName?: string; /** * 项目ID */ ProjectId?: number; /** * 地域 */ Region?: string; /** * 可用区 */ Zone?: string; /** * 实例状态 */ Status?: string; /** * 实例状态中文描述 */ StatusDesc?: string; /** * 实例形态,是否为serverless实例 */ DbMode?: string; /** * 数据库类型 */ DbType?: string; /** * 数据库版本 */ DbVersion?: string; /** * Cpu,单位:核 */ Cpu?: number; /** * 内存,单位:GB */ Memory?: number; /** * 存储量,单位:GB */ Storage?: number; /** * 实例类型 */ InstanceType?: string; /** * 实例当前角色 */ InstanceRole?: string; /** * 更新时间 */ UpdateTime?: string; /** * 创建时间 */ CreateTime?: string; /** * VPC网络ID */ VpcId?: string; /** * 子网ID */ SubnetId?: string; /** * 实例内网IP */ Vip?: string; /** * 实例内网端口 */ Vport?: number; /** * 付费模式 */ PayMode?: number; /** * 实例过期时间 */ PeriodEndTime?: string; /** * 销毁期限 */ DestroyDeadlineText?: string; /** * 隔离时间 */ IsolateTime?: string; /** * 网络类型 */ NetType?: number; /** * 外网域名 */ WanDomain?: string; /** * 外网IP */ WanIP?: string; /** * 外网端口 */ WanPort?: number; /** * 外网状态 */ WanStatus?: string; /** * 实例销毁时间 */ DestroyTime?: string; /** * Cynos内核版本 */ CynosVersion?: string; /** * 正在处理的任务 */ ProcessingTask?: string; /** * 续费标志 */ RenewFlag?: number; /** * serverless实例cpu下限 */ MinCpu?: number; /** * serverless实例cpu上限 */ MaxCpu?: number; /** * serverless实例状态, 可选值: resume pause */ ServerlessStatus?: string; /** * 预付费存储Id */ StorageId?: string; /** * 存储付费类型 */ StoragePayMode?: number; /** * 物理区 */ PhysicalZone?: string; /** * 商业类型 */ BusinessType?: string; /** * 任务 */ Tasks?: Array<ObjectTask>; /** * 是否冻结 */ IsFreeze?: string; /** * 资源标签 注意:此字段可能返回 null,表示取不到有效值。 */ ResourceTags?: Array<Tag>; /** * 主可用区 */ MasterZone?: string; /** * 备可用区 注意:此字段可能返回 null,表示取不到有效值。 */ SlaveZones?: Array<string>; /** * 实例网络信息 */ InstanceNetInfo?: Array<InstanceNetInfo>; /** * 实例绑定资源包信息(此处只返回计算资源包,即packageType=CCU) 注意:此字段可能返回 null,表示取不到有效值。 */ ResourcePackages?: Array<ResourcePackage>; /** * 实例索引形态,可选值【mixedRowColumn(行列混存),onlyRowIndex(仅行存)】 */ InstanceIndexMode?: string; /** * 当前实例支持的能力 */ InstanceAbility?: InstanceAbility; /** * 实例机器类型 */ DeviceType?: string; /** * 实例存储类型 */ InstanceStorageType?: string; } /** * DescribeClusterPasswordComplexity返回参数结构体 */ export interface DescribeClusterPasswordComplexityResponse { /** * 数据字典参数 */ ValidatePasswordDictionary?: ParamInfo; /** * 密码长度 */ ValidatePasswordLength?: ParamInfo; /** * 大小写敏感字符个数 */ ValidatePasswordMixedCaseCount?: ParamInfo; /** * 数字个数 */ ValidatePasswordNumberCount?: ParamInfo; /** * 密码等级 */ ValidatePasswordPolicy?: ParamInfo; /** * 特殊字符个数 */ ValidatePasswordSpecialCharCount?: ParamInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAuditRuleWithInstanceIds请求参数结构体 */ export interface DescribeAuditRuleWithInstanceIdsRequest { /** * 实例ID。目前仅支持单个实例的查询。 */ InstanceIds: Array<string>; } /** * DescribeClusterDatabases返回参数结构体 */ export interface DescribeClusterDatabasesResponse { /** * 总条数 */ TotalCount?: number; /** * 分页偏移 */ Offset?: number; /** * 数据库列表 */ Databases?: Array<string>; /** * 分页限制数 */ Limit?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例变配任务信息 */ export interface ModifyInstanceData { /** * 变配后CPU */ Cpu?: number; /** * 变配后内存 */ Memory?: number; /** * 变配后存储上限 */ StorageLimit?: number; /** * 变配前CPU */ OldCpu?: number; /** * 变配前内存 */ OldMemory?: number; /** * 变配前存储上限 */ OldStorageLimit?: number; /** * 变配前实例机器类型 */ OldDeviceType?: string; /** * 变配后实例机器类型 */ DeviceType?: string; /** * 升级方式。升级完成后切换或维护时间内切换 */ UpgradeType?: string; } /** * DescribeInstanceParams请求参数结构体 */ export interface DescribeInstanceParamsRequest { /** * 集群ID */ ClusterId: string; /** * 实例ID,支持批量查询 */ InstanceIds: Array<string>; /** * 参数名搜索条件,支持模糊匹配 */ ParamKeyword?: string; /** * 是否为全局参数 */ IsGlobal?: string; } /** * ModifyBinlogSaveDays请求参数结构体 */ export interface ModifyBinlogSaveDaysRequest { /** * 集群ID */ ClusterId: string; /** * Binlog保留天数 */ BinlogSaveDays: number; } /** * 数据库代理规格 */ export interface ProxySpec { /** * 数据库代理cpu核数 */ Cpu?: number; /** * 数据库代理内存 */ Mem?: number; } /** * AddInstances返回参数结构体 */ export interface AddInstancesResponse { /** * 冻结流水,一次开通一个冻结流水。 */ TranId?: string; /** * 后付费订单号。 */ DealNames?: Array<string>; /** * 发货资源id列表。 */ ResourceIds?: Array<string>; /** * 大订单号 */ BigDealIds?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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; /** * 远程读取次数 数据库内核版本大于3.1.12 */ SyncReadCountRemote?: number; /** * 远程读取的字节数 数据库内核版本大于3.1.12 */ SyncReadBytesRemote?: number; /** * 远程读取所花费的时间(微秒) 数据库内核版本大于3.1.12 */ SyncReadTimeRemote?: number; /** * 远程写入次数 数据库内核版本大于3.1.12 */ SyncWriteCountRemote?: number; /** * 远程写入的字节数。 数据库内核版本大于3.1.12 */ SyncWriteBytesRemote?: number; /** * 远程写入所花费的时间(微秒)。 数据库内核版本大于3.1.12 */ SyncWriteTimeRemote?: number; /** * 事务提交延迟(微秒) 数据库内核版本大于3.1.12 */ TrxCommitDelay?: number; } /** * 数据库代理组详细信息 */ export interface ProxyGroupInfo { /** * 数据库代理组 */ ProxyGroup?: ProxyGroup; /** * 数据库代理组读写分离信息 */ ProxyGroupRwInfo?: ProxyGroupRwInfo; /** * 数据库代理节点信息 注意:此字段可能返回 null,表示取不到有效值。 */ ProxyNodes?: Array<ProxyNodeInfo>; /** * 数据库代理连接池信息 */ ConnectionPool?: ProxyConnectionPoolInfo; /** * 数据库代理网络信息 注意:此字段可能返回 null,表示取不到有效值。 */ NetAddrInfos?: Array<NetAddr>; /** * 数据库代理任务集 */ Tasks?: Array<ObjectTask>; } /** * AssociateSecurityGroups返回参数结构体 */ export interface AssociateSecurityGroupsResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateProxyEndPoint请求参数结构体 */ export interface CreateProxyEndPointRequest { /** * 集群ID */ ClusterId: string; /** * 私有网络ID,默认与集群私有网络ID保持一致 */ UniqueVpcId: string; /** * 私有网络子网ID,默认与集群子网ID保持一致 */ UniqueSubnetId: string; /** * 连接池类型:SessionConnectionPool(会话级别连接池 ) */ ConnectionPoolType?: string; /** * 是否开启连接池,yes-开启,no-不开启 */ OpenConnectionPool?: string; /** * 连接池阈值:单位(秒) */ ConnectionPoolTimeOut?: number; /** * 绑定的安全组ID数组 */ SecurityGroupIds?: Array<string>; /** * 描述说明 */ Description?: string; /** * 想要绑定的vip信息,需与UniqueVpcId对应。 */ Vip?: string; /** * 权重模式: system-系统分配,custom-自定义 */ WeightMode?: string; /** * 是否自动添加只读实例,yes-是,no-不自动添加 */ AutoAddRo?: string; /** * 是否开启故障转移。 yes:开启 no:不开启。 数据库代理出现故障时,链接地址将会路由到主实例 */ FailOver?: string; /** * 一致性类型: eventual,global,session */ ConsistencyType?: string; /** * 读写属性: READWRITE,READONLY */ RwType?: string; /** * 一致性超时时间。取值范围:0~1000000(微秒),设置0则表示若只读实例出现延迟, 导致一致性策略不满足, 请求将一直等待 */ ConsistencyTimeOut?: number; /** * 是否开启事务拆分。在一个事务中拆分读和写到不同的实例上去执行 */ TransSplit?: boolean; /** * 连接模式: nearby,balance */ AccessMode?: string; /** * 实例权重 */ InstanceWeights?: Array<ProxyInstanceWeight>; } /** * 审计规则模板的详情 */ export interface AuditRuleTemplateInfo { /** * 规则模板ID。 */ RuleTemplateId?: string; /** * 规则模板名称。 */ RuleTemplateName?: string; /** * 规则模板的过滤条件 */ RuleFilters?: Array<RuleFilters>; /** * 规则模板描述。 */ Description?: string; /** * 规则模板创建时间。 */ CreateAt?: string; /** * 规则模板修改时间。 */ UpdateAt?: string; /** * 告警等级。1-低风险,2-中风险,3-高风险。 */ AlarmLevel?: number; /** * 告警策略。0-不告警,1-告警。 */ AlarmPolicy?: number; /** * 模板状态。0-无任务 ,1-修改中。 */ Status?: number; /** * 规则模板应用在哪些在实例。 */ AffectedInstances?: Array<string>; } /** * DescribeParamTemplateDetail请求参数结构体 */ export interface DescribeParamTemplateDetailRequest { /** * 参数模板ID */ TemplateId: number; } /** * ModifyAccountPrivileges请求参数结构体 */ export interface ModifyAccountPrivilegesRequest { /** * 集群id */ ClusterId: string; /** * 账号信息 */ Account: InputAccount; /** * 全局权限数组 */ GlobalPrivileges?: Array<string>; /** * 数据库权限数组 */ DatabasePrivileges?: Array<DatabasePrivileges>; /** * 表权限数组 */ TablePrivileges?: Array<TablePrivileges>; } /** * ExportResourcePackageDeductDetails请求参数结构体 */ export interface ExportResourcePackageDeductDetailsRequest { /** * 需要导出的资源包ID */ PackageId: string; /** * 使用资源包容量的cynos集群ID */ ClusterIds?: Array<string>; /** * 排序字段,目前支持:createTime(资源包被抵扣时间),successDeductSpec(资源包抵扣量) */ OrderBy?: string; /** * 排序类型,支持ASC、DESC、asc、desc */ OrderByType?: string; /** * 开始时间 */ StartTime?: string; /** * 结束时间 */ EndTime?: string; /** * 单次最大导出数据行数,目前最大支持2000行 */ Limit?: string; /** * 偏移量页数 */ Offset?: string; /** * 导出数据格式,目前仅支持csv格式,留作扩展 */ FileType?: string; } /** * StartCLSDelivery返回参数结构体 */ export interface StartCLSDeliveryResponse { /** * 异步任务id */ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 参数变化信息 */ export interface ParamItemInfo { /** * 参数名字 */ ParamName?: string; /** * 参数新值 */ NewValue?: string; /** * 参数旧值 */ OldValue?: string; /** * 参数公式 */ ValueFunction?: string; } /** * UpgradeProxy返回参数结构体 */ export interface UpgradeProxyResponse { /** * 异步流程ID */ FlowId?: number; /** * 异步任务ID */ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceSpecs请求参数结构体 */ export interface DescribeInstanceSpecsRequest { /** * 数据库类型,取值范围: <li> MYSQL </li> */ DbType: string; /** * 是否需要返回可用区信息 */ IncludeZoneStocks?: boolean; /** * 实例机器类型 */ DeviceType?: string; } /** * DescribeProxyNodes返回参数结构体 */ export interface DescribeProxyNodesResponse { /** * 数据库代理节点总数 */ TotalCount?: number; /** * 数据库代理节点列表 */ ProxyNodeInfos?: Array<ProxyNodeInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库代理组节点 */ export interface ProxyNodeInfo { /** * 数据库代理节点ID */ ProxyNodeId?: string; /** * 节点当前连接数, DescribeProxyNodes接口此字段值不返回 */ ProxyNodeConnections?: number; /** * 数据库代理节点cpu */ Cpu?: number; /** * 数据库代理节点内存 */ Mem?: number; /** * 数据库代理节点状态 */ Status?: string; /** * 数据库代理组ID */ ProxyGroupId?: string; /** * 集群ID */ ClusterId?: string; /** * 用户AppID */ AppId?: number; /** * 地域 */ Region?: string; /** * 可用区 */ Zone?: string; /** * 数据库代理节点名字 */ OssProxyNodeName?: string; } /** * DescribeZones返回参数结构体 */ export interface DescribeZonesResponse { /** * 地域信息 */ RegionSet?: Array<SaleRegion>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SearchClusterTables返回参数结构体 */ export interface SearchClusterTablesResponse { /** * 数据表列表 */ Tables?: Array<DatabaseTables>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyParamTemplate请求参数结构体 */ export interface ModifyParamTemplateRequest { /** * 模板ID */ TemplateId: number; /** * 模板名 */ TemplateName?: string; /** * 模板描述 */ TemplateDescription?: string; /** * 参数列表 */ ParamList?: Array<ModifyParamItem>; } /** * OpenAuditService返回参数结构体 */ export interface OpenAuditServiceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeChangedParamsAfterUpgrade返回参数结构体 */ export interface DescribeChangedParamsAfterUpgradeResponse { /** * 参数个数 */ TotalCount?: number; /** * 实例参数列表 */ Items?: Array<ParamItemInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyServerlessStrategy返回参数结构体 */ export interface ModifyServerlessStrategyResponse { /** * 异步流程id */ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库代理组读写分离信息 */ export interface ProxyGroupRwInfo { /** * 一致性类型 eventual-最终一致性,global-全局一致性,session-会话一致性 */ ConsistencyType?: string; /** * 一致性超时时间 */ ConsistencyTimeOut?: number; /** * 权重模式 system-系统分配,custom-自定义 */ WeightMode?: string; /** * 是否开启故障转移 */ FailOver?: string; /** * 是否自动添加只读实例,yes-是,no-不自动添加 */ AutoAddRo?: string; /** * 实例权重数组 */ InstanceWeights?: Array<ProxyInstanceWeight>; /** * 是否开通读写节点,yse-是,no-否 */ OpenRw?: string; /** * 读写属性,可选值:READWRITE,READONLY */ RwType?: string; /** * 事务拆分 */ TransSplit?: boolean; /** * 连接模式,可选值:balance,nearby */ AccessMode?: string; } /** * DescribeProxyNodes请求参数结构体 */ export interface DescribeProxyNodesRequest { /** * 返回数量,默认为 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>; } /** * 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; /** * 分页偏移量。 说明:Limit 和 Offset 的取值之和需小于等于65536。 */ Offset?: number; /** * 过滤条件。多个值之前是且的关系。 */ LogFilter?: Array<InstanceAuditLogFilter>; } /** * InquirePriceCreate返回参数结构体 */ export interface InquirePriceCreateResponse { /** * 实例价格 */ InstancePrice?: TradePrice; /** * 存储价格 */ StoragePrice?: TradePrice; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateClusters请求参数结构体 */ export interface CreateClustersRequest { /** * 可用区 */ Zone: string; /** * 所属VPC网络ID */ VpcId: string; /** * 所属子网ID */ SubnetId: string; /** * 数据库类型,取值范围: <li> MYSQL </li> */ DbType: string; /** * 数据库版本,取值范围: <li> MYSQL可选值:5.7,8.0 </li> */ DbVersion: string; /** * 所属项目ID */ ProjectId?: number; /** * 当DbMode为NORMAL或不填时必选 普通实例Cpu核数 */ Cpu?: number; /** * 当DbMode为NORMAL或不填时必选 普通实例内存,单位GB */ Memory?: number; /** * 该参数无实际意义,已废弃。 存储大小,单位GB。 */ Storage?: number; /** * 集群名称,长度小于64个字符,每个字符取值范围:大/小写字母,数字,特殊符号('-','_','.') */ ClusterName?: string; /** * 账号密码(8-64个字符,包含大小写英文字母、数字和符号~!@#$%^&*_-+=`|\(){}[]:;'<>,.?/中的任意三种) */ AdminPassword?: string; /** * 端口,默认3306,取值范围[0, 65535) */ Port?: number; /** * 计费模式,按量计费:0,包年包月:1。默认按量计费。 */ PayMode?: number; /** * 购买集群数,可选值范围[1,50],默认为1 */ Count?: number; /** * 回档类型: noneRollback:不回档; snapRollback,快照回档; timeRollback,时间点回档 */ RollbackStrategy?: string; /** * 快照回档,表示snapshotId;时间点回档,表示queryId,为0,表示需要判断时间点是否有效 */ RollbackId?: number; /** * 回档时,传入源集群ID,用于查找源poolId */ OriginalClusterId?: string; /** * 时间点回档,指定时间;快照回档,快照时间 */ ExpectTime?: string; /** * 该参数无实际意义,已废弃。 时间点回档,指定时间允许范围 */ ExpectTimeThresh?: number; /** * 普通实例存储上限,单位GB 当DbType为MYSQL,且存储计费模式为预付费时,该参数需不大于cpu与memory对应存储规格上限 */ StorageLimit?: number; /** * 实例数量,数量范围为(0,16] */ InstanceCount?: number; /** * 包年包月购买时长 */ TimeSpan?: number; /** * 包年包月购买时长单位,['s','d','m','y'] */ TimeUnit?: string; /** * 包年包月购买是否自动续费,默认为0。 0标识默认续费方式,1表示自动续费,2表示不自动续费。 */ AutoRenewFlag?: number; /** * 是否自动选择代金券 1是 0否 默认为0 */ AutoVoucher?: number; /** * 实例数量(该参数已不再使用,只做存量兼容处理) */ HaCount?: number; /** * 订单来源 */ OrderSource?: string; /** * 集群创建需要绑定的tag数组信息 */ ResourceTags?: Array<Tag>; /** * Db类型 当DbType为MYSQL时可选(默认NORMAL): <li>NORMAL</li> <li>SERVERLESS</li> */ DbMode?: string; /** * 当DbMode为SERVERLESS时必填 cpu最小值,可选范围参考DescribeServerlessInstanceSpecs接口返回 */ MinCpu?: number; /** * 当DbMode为SERVERLESS时必填: cpu最大值,可选范围参考DescribeServerlessInstanceSpecs接口返回 */ MaxCpu?: number; /** * 当DbMode为SERVERLESS时,指定集群是否自动暂停,可选范围 <li>yes</li> <li>no</li> 默认值:yes */ AutoPause?: string; /** * 当DbMode为SERVERLESS时,指定集群自动暂停的延迟,单位秒,可选范围[600,691200] 默认值:600 */ AutoPauseDelay?: number; /** * 集群存储计费模式,按量计费:0,包年包月:1。默认按量计费 当DbType为MYSQL时,在集群计算计费模式为后付费(包括DbMode为SERVERLESS)时,存储计费模式仅可为按量计费 回档与克隆均不支持包年包月存储 */ StoragePayMode?: number; /** * 安全组id数组 */ SecurityGroupIds?: Array<string>; /** * 告警策略Id数组 */ AlarmPolicyIds?: Array<string>; /** * 参数数组,暂时支持character_set_server (utf8|latin1|gbk|utf8mb4) ,lower_case_table_names,1-大小写不敏感,0-大小写敏感 */ ClusterParams?: Array<ParamItem>; /** * 交易模式,0-下单且支付,1-下单 */ DealMode?: number; /** * 参数模板ID,可以通过查询参数模板信息DescribeParamTemplates获得参数模板ID */ ParamTemplateId?: number; /** * 多可用区地址 */ SlaveZone?: string; /** * 实例初始化配置信息,主要用于购买集群时选不同规格实例 */ InstanceInitInfos?: Array<InstanceInitInfo>; } /** * DescribeClusterParamLogs请求参数结构体 */ export interface DescribeClusterParamLogsRequest { /** * 集群ID */ ClusterId: string; /** * 实例ID列表,用来记录具体操作哪些实例 */ InstanceIds?: Array<string>; /** * 排序字段,定义在回返结果的基于哪个字段进行排序 */ OrderBy?: string; /** * 定义具体的排序规则,限定为desc,asc,DESC,ASC其中之一 */ OrderByType?: string; /** * 返回数量,默认为 20,取值范围为(0,100] */ Limit?: number; /** * 记录偏移量,默认值为0,取值范围为[0,INF) */ Offset?: number; } /** * CloseProxy返回参数结构体 */ export interface CloseProxyResponse { /** * 异步流程ID */ FlowId?: number; /** * 异步任务ID */ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeResourcePackageSaleSpec请求参数结构体 */ export interface DescribeResourcePackageSaleSpecRequest { /** * 实例类型 */ InstanceType: string; /** * 资源包使用地域 china-中国内地通用,overseas-港澳台及海外通用 */ PackageRegion: string; /** * 资源包类型 CCU-计算资源包 DISK-存储资源包 */ PackageType: string; /** * 偏移量 */ Offset?: number; /** * 限制 */ Limit?: number; } /** * UnbindClusterResourcePackages返回参数结构体 */ export interface UnbindClusterResourcePackagesResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RollBackCluster返回参数结构体 */ export interface RollBackClusterResponse { /** * 任务流ID */ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClusterInstanceGrps返回参数结构体 */ export interface DescribeClusterInstanceGrpsResponse { /** * 实例组个数 */ TotalCount?: number; /** * 实例组列表 * @deprecated */ InstanceGrpInfoList?: Array<CynosdbInstanceGrp>; /** * 实例组列表 */ InstanceGroupInfoList?: Array<CynosdbInstanceGroup>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyBackupConfig返回参数结构体 */ export interface ModifyBackupConfigResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyClusterDatabase请求参数结构体 */ export interface ModifyClusterDatabaseRequest { /** * 集群ID */ ClusterId: string; /** * 数据库名 */ DbName: string; /** * 新授权用户主机权限 */ NewUserHostPrivileges?: Array<UserHostPrivilege>; /** * 备注 */ Description?: string; /** * 历史授权用户主机权限 */ OldUserHostPrivileges?: Array<UserHostPrivilege>; } /** * DescribeServerlessStrategy返回参数结构体 */ export interface DescribeServerlessStrategyResponse { /** * cpu负载为 0 时持续多久(秒)发起自动暂停 */ AutoPauseDelay?: number; /** * cpu负载超过当前规格核数时,持续多久(秒)发起自动扩容 */ AutoScaleUpDelay?: number; /** * cpu 负载低于低一级规格核数时,持续多久(秒)发起自动缩容 */ AutoScaleDownDelay?: number; /** * 是否自动暂停,可能值: yes no */ AutoPause?: string; /** * 集群是否允许向上扩容,可选范围<li>yes</li><li>no</li> */ AutoScaleUp?: string; /** * 集群是否允许向下缩容,可选范围<li>yes</li><li>no</li> */ AutoScaleDown?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例日志投递信息 */ export interface InstanceCLSDeliveryInfo { /** * 实例id */ InstanceId?: string; /** * 实例name */ InstanceName?: string; /** * 日志主题id */ TopicId?: string; /** * 日志主题name */ TopicName?: string; /** * 日志集id */ GroupId?: string; /** * 日志集name */ GroupName?: string; /** * 日志投递地域 */ Region?: string; /** * 投递状态creating,running,offlining,offlined */ Status?: string; /** * 日志类型 */ LogType?: string; } /** * ModifyMaintainPeriodConfig返回参数结构体 */ export interface ModifyMaintainPeriodConfigResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DisassociateSecurityGroups请求参数结构体 */ export interface DisassociateSecurityGroupsRequest { /** * 实例组 ID 数组,cynosdbmysql-grp-前缀开头或集群 ID。 说明:要获取集群的实例组 ID,可通过 [查询集群实例组](https://cloud.tencent.com/document/product/1003/103934) 进行。 */ InstanceIds: Array<string>; /** * 要修改的安全组ID列表,一个或者多个安全组ID组成的数组。 */ SecurityGroupIds: Array<string>; /** * 可用区。 说明:请正确输入集群所在的主可用区,若输入非集群所在的主可用区可能显示调用成功,但实际执行会失败。 */ Zone: string; } /** * ModifyBackupName请求参数结构体 */ export interface ModifyBackupNameRequest { /** * 集群ID */ ClusterId: string; /** * 备份文件ID */ BackupId: number; /** * 备注名,长度不能超过60个字符 */ BackupName: string; } /** * 规则审计的过滤条件 */ export interface AuditRuleFilters { /** * 单条审计规则。 */ RuleFilters: Array<RuleFilters>; } /** * DescribeClusterParams请求参数结构体 */ export interface DescribeClusterParamsRequest { /** * 集群ID */ ClusterId: string; /** * 参数名字 */ ParamName?: string; /** * 是否为全局参数 */ IsGlobal?: string; } /** * ModifyAccountHost返回参数结构体 */ export interface ModifyAccountHostResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAccountAllGrantPrivileges请求参数结构体 */ export interface DescribeAccountAllGrantPrivilegesRequest { /** * 集群id */ ClusterId: string; /** * 账号信息 */ Account: InputAccount; } /** * DeleteCLSDelivery请求参数结构体 */ export interface DeleteCLSDeliveryRequest { /** * 实例id */ InstanceId: string; /** * 日志主题id */ CLSTopicIds: Array<string>; /** * 日志类型 */ LogType?: string; /** * 是否维护时间运行 */ IsInMaintainPeriod?: string; } /** * CreateCLSDelivery返回参数结构体 */ export interface CreateCLSDeliveryResponse { /** * 异步任务id */ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeServerlessInstanceSpecs返回参数结构体 */ export interface DescribeServerlessInstanceSpecsResponse { /** * Serverless实例可选规格 */ Specs?: Array<ServerlessSpec>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 手动备份任务信息 */ export interface ManualBackupData { /** * 备份类型。snapshot-快照备份 */ BackupType?: string; /** * 备份方式。auto-自动备份,manual-手动 */ BackupMethod?: string; /** * 备份时间 */ SnapshotTime?: string; /** * 跨地域备份项详细信息 注意:此字段可能返回 null,表示取不到有效值。 */ CrossRegionBackupInfos?: Array<CrossRegionBackupItem>; } /** * DescribeBinlogs请求参数结构体 */ export interface DescribeBinlogsRequest { /** * 集群ID */ ClusterId: string; /** * 开始时间 */ StartTime?: string; /** * 结束时间 */ EndTime?: string; /** * 偏移量 */ Offset?: number; /** * 限制条数 */ Limit?: number; } /** * InquirePriceModify返回参数结构体 */ export interface InquirePriceModifyResponse { /** * 实例价格 */ InstancePrice?: TradePrice; /** * 存储价格 */ StoragePrice?: TradePrice; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 审计日志搜索条件 */ export interface InstanceAuditLogFilter { /** * 过滤项。目前支持以下搜索条件: 包含、不包含、包含(分词维度)、不包含(分词维度): sql - SQL详情;alarmLevel - 告警等级;ruleTemplateId - 规则模板Id 等于、不等于、包含、不包含: host - 客户端地址; user - 用户名; dbName - 数据库名称; 等于、不等于: sqlType - SQL类型; errCode - 错误码; threadId - 线程ID; 范围搜索(时间类型统一为微秒): execTime - 执行时间; lockWaitTime - 执行时间; ioWaitTime - IO等待时间; trxLivingTime - 事务持续时间; cpuTime - cpu时间; checkRows - 扫描行数; affectRows - 影响行数; sentRows - 返回行数。 */ Type: string; /** * 过滤条件。支持以下条件: WINC-包含(分词维度), WEXC-不包含(分词维度), INC - 包含, EXC - 不包含, EQS - 等于, NEQ - 不等于, RA - 范围。 */ Compare: string; /** * 过滤的值。反向查询时,多个值之前是且的关系,正向查询多个值是或的关系。 */ Value: Array<string>; } /** * 备可用区库存信息 */ export interface SlaveZoneStockInfo { /** * 备可用区 */ SlaveZone?: string; /** * 备可用区的库存数量 */ StockCount?: number; /** * 备可用区是否有库存 */ HasStock?: boolean; } /** * 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; } /** * DescribeResourcePackageList返回参数结构体 */ export interface DescribeResourcePackageListResponse { /** * 资源包总数 */ Total?: number; /** * 资源包明细 */ Detail?: Array<Package>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 任务信息 */ export interface ObjectTask { /** * 任务自增ID */ TaskId?: number; /** * 任务类型 */ TaskType?: string; /** * 任务状态 */ TaskStatus?: string; /** * 任务ID(集群ID|实例组ID|实例ID) */ ObjectId?: string; /** * 任务类型 */ ObjectType?: 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; } /** * 创建集群任务信息 */ export interface CreateClustersData { /** * 实例CPU */ Cpu?: number; /** * 实例内存 */ Memory?: number; /** * 集群存储上限 */ StorageLimit?: number; } /** * DescribeProxies请求参数结构体 */ export interface DescribeProxiesRequest { /** * 集群 ID(该参数必传,例如 cynosdbmysql-2u2mh111)。 */ 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>; } /** * 修改的实例参数信息 */ export interface ModifyParamItem { /** * 参数名 */ ParamName: string; /** * 参数当前值 */ CurrentValue: string; /** * 参数旧值(只在出参时有用) */ OldValue?: string; } /** * AssociateSecurityGroups请求参数结构体 */ export interface AssociateSecurityGroupsRequest { /** * 实例组 ID 数组,cynosdbmysql-grp-前缀开头或集群 ID。 说明:要获取集群的实例组 ID,可通过 [查询集群实例组](https://cloud.tencent.com/document/product/1003/103934) 进行。 */ InstanceIds: Array<string>; /** * 要修改的安全组ID列表,一个或者多个安全组Id组成的数组。 */ SecurityGroupIds: Array<string>; /** * 可用区 */ Zone: string; } /** * 参数模板信息 */ export interface ParamTemplateListInfo { /** * 参数模板ID */ Id?: number; /** * 参数模板名称 */ TemplateName?: string; /** * 参数模板描述 */ TemplateDescription?: string; /** * 引擎版本 */ EngineVersion?: string; /** * 数据库类型,可选值:NORMAL,SERVERLESS */ DbMode?: string; /** * 参数模板详情 注意:此字段可能返回 null,表示取不到有效值。 */ ParamInfoSet?: Array<TemplateParamInfo>; } /** * CloseProxyEndPoint请求参数结构体 */ export interface CloseProxyEndPointRequest { /** * 集群ID */ ClusterId: string; /** * 数据库代理组ID */ ProxyGroupId: string; } /** * DescribeBinlogs返回参数结构体 */ export i