/**
* OfflineLibraDBCluster请求参数结构体
*/
export interface OfflineLibraDBClusterRequest {
/**
* 分析集群 ID
*/
ClusterId: string;
}
/**
* DeleteClusterSaveBackup返回参数结构体
*/
export interface DeleteClusterSaveBackupResponse {
/**
* 任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLibraDBClusterDataSource返回参数结构体
*/
export interface ModifyLibraDBClusterDataSourceResponse {
/**
* 异步任务ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeProxyVersion返回参数结构体
*/
export interface UpgradeProxyVersionResponse {
/**
* 异步流程ID
*/
FlowId?: number;
/**
* 异步任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceCLSLogDelivery返回参数结构体
*/
export interface DescribeInstanceCLSLogDeliveryResponse {
/**
* 总数量
*/
TotalCount?: number;
/**
* 实例投递信息
*/
InstanceCLSDeliveryInfos?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* libra实例信息
*/
export interface LibraInstanceSet {
/**
* 数据库模式
*/
DbMode?: string;
/**
* cpu核数
*/
InstanceCpu?: number;
/**
* 实例类型
*/
InstanceDeviceType?: string;
/**
* 组id
*/
InstanceGroupId?: string;
/**
* 实例id
*/
InstanceId?: string;
/**
* 内存
*/
InstanceMemory?: number;
/**
* 实例名称
*/
InstanceName?: string;
/**
* 付费模式
*/
InstancePayMode?: number;
/**
* 付费结束时间
*/
InstancePeriodEndTime?: string;
/**
* 实例角色
*/
InstanceRole?: string;
/**
* 实例状态
*/
InstanceStatus?: string;
/**
* 实例状态描述
*/
InstanceStatusDesc?: string;
/**
* 网络类型
*/
NetType?: string;
/**
* 子网id
*/
UniqSubnetId?: string;
/**
* vpcid
*/
UniqVpcId?: string;
/**
* 虚拟ip
*/
Vip?: string;
/**
* 虚拟端口
*/
Vport?: number;
/**
* 外网区域
*/
WanDomain?: string;
/**
* 外网ip
*/
WanIP?: string;
/**
* 外网port
*/
WanPort?: number;
/**
* 外网状态
*/
WanStatus?: string;
/**
* 硬盘
*/
InstanceStorage?: number;
/**
* 硬盘类型
*/
InstanceStorageType?: 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;
}
/**
* DescribeZones请求参数结构体
*/
export interface DescribeZonesRequest {
/**
* 是否包含虚拟区
*/
IncludeVirtualZones?: boolean;
/**
* 是否展示地域下所有可用区,并显示用户每个可用区权限
*/
ShowPermission?: boolean;
}
/**
* 实例参数修改任务详情
*/
export interface BizTaskModifyInstanceParam {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 实例参数修改任务详情
*/
ModifyInstanceParamList?: Array;
}
/**
* ModifyClusterReadOnly返回参数结构体
*/
export interface ModifyClusterReadOnlyResponse {
/**
* 集群任务ID列表
*/
ClusterTaskIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClusterStorage请求参数结构体
*/
export interface ModifyClusterStorageRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 集群新存储大小(单位G)
*/
NewStorageLimit: number;
/**
* 集群原存储大小(单位G)
*/
OldStorageLimit: number;
/**
* 交易模式 0-下单并支付 1-下单
*/
DealMode?: number;
}
/**
* 集群信息
*/
export interface DescribeVaultBackupClusterInfo {
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* 集群状态
*/
ClusterStatus?: string;
/**
* 集群所在地域
*/
ClusterRegion?: string;
/**
* 集群所在可用区
*/
ClusterZone?: string;
}
/**
* DescribeResourcePackageDetail返回参数结构体
*/
export interface DescribeResourcePackageDetailResponse {
/**
* 资源包抵扣总数
*/
Total?: number;
/**
* 资源包明细说明
*/
Detail?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLibraDBClusterDataSource请求参数结构体
*/
export interface ModifyLibraDBClusterDataSourceRequest {
/**
* 分析集群ID
*/
ClusterId: string;
/**
* 只读分析引擎实例ID
*/
InstanceId: string;
/**
* 源端信息
*/
SrcInfo?: Array;
}
/**
* UpgradeInstance请求参数结构体
*/
export interface UpgradeInstanceRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 数据库CPU
*/
Cpu: number;
/**
* 数据库内存,单位GB
*/
Memory: number;
/**
* 升级类型:upgradeImmediate,upgradeInMaintain
*/
UpgradeType: string;
/**
* 实例机器类型
1. common,通用型。
2. exclusive,独享型。
*/
DeviceType?: string;
/**
* 该参数已废弃
*/
StorageLimit?: number;
/**
* 是否自动选择代金券 1是 0否 默认为0
*/
AutoVoucher?: number;
/**
* 该参数已废弃
*/
DbType?: string;
/**
* 交易模式 0-下单并支付 1-下单
*/
DealMode?: number;
/**
* NormalUpgrade:普通变配,FastUpgrade:极速变配,若变配过程判断会造成闪断,变配流程会终止。
*/
UpgradeMode?: string;
/**
* proxy同步升级
*/
UpgradeProxy?: UpgradeProxy;
}
/**
* 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;
}
/**
* ModifyBackupDownloadRestriction返回参数结构体
*/
export interface ModifyBackupDownloadRestrictionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeClusterVersion返回参数结构体
*/
export interface UpgradeClusterVersionResponse {
/**
* 异步任务id
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 将被删除的备份文件列表
*/
export interface WillDeleteItem {
/**
* 备份文件ID
*/
BackupId?: number;
/**
* 备份文件名称
*/
BackupName?: string;
}
/**
* TransferClusterZone返回参数结构体
*/
export interface TransferClusterZoneResponse {
/**
* 异步任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterDatabaseTables请求参数结构体
*/
export interface DescribeClusterDatabaseTablesRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 数据库名
*/
Db: string;
/**
* 偏移
*/
Offset?: number;
/**
* 个数
*/
Limit?: number;
/**
* 数据表类型。
"view"表示只返回 view,"base_table" 表示只返回基本表,"all" 表示返回 view 和表。默认为 all。
*/
TableType?: string;
}
/**
* ModifyClusterBinlogRedoLogAutoCopyVault请求参数结构体
*/
export interface ModifyClusterBinlogRedoLogAutoCopyVaultRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 自动拷贝保险箱配置列表
*/
AutoCopyVaults?: Array;
}
/**
* DescribeClusterParams返回参数结构体
*/
export interface DescribeClusterParamsResponse {
/**
* 参数个数
*/
TotalCount?: number;
/**
* 实例参数列表
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RefundResourcePackage返回参数结构体
*/
export interface RefundResourcePackageResponse {
/**
* 每个物品对应一个dealName,业务需要根据dealName保证发货接口幂等
*/
DealNames?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyInstanceName返回参数结构体
*/
export interface ModifyInstanceNameResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeParamTemplates请求参数结构体
*/
export interface DescribeParamTemplatesRequest {
/**
* 数据库引擎版本号
*/
EngineVersions?: Array;
/**
* 模板名称
*/
TemplateNames?: Array;
/**
* 模板ID
*/
TemplateIds?: Array;
/**
* 数据库类型,可选值:NORMAL,SERVERLESS
*/
DbModes?: Array;
/**
* 查询偏移量
*/
Offset?: number;
/**
* 查询限制条数
*/
Limit?: number;
/**
* 查询的模板对应的产品类型
*/
Products?: Array;
/**
* 模板类型
*/
TemplateTypes?: Array;
/**
* 版本类型
*/
EngineTypes?: Array;
/**
* 返回结果的排序字段
*/
OrderBy?: string;
/**
* 排序方式(asc、desc)
*/
OrderDirection?: string;
}
/**
* DescribeBackupOverview请求参数结构体
*/
export interface DescribeBackupOverviewRequest {
/**
* 集群id
*/
ClusterId: string;
}
/**
* DescribeAuditInstanceList返回参数结构体
*/
export interface DescribeAuditInstanceListResponse {
/**
* 符合查询条件的实例总数。
*/
TotalCount?: number;
/**
* 审计实例详细信息列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeVaultBackupClusterInfo返回参数结构体
*/
export interface DescribeVaultBackupClusterInfoResponse {
/**
* 保险箱信息
*/
ClusterInfos?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSlaveZones返回参数结构体
*/
export interface DescribeSlaveZonesResponse {
/**
* 从可用区
*/
SlaveZones?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProxies返回参数结构体
*/
export interface DescribeProxiesResponse {
/**
* 数据库代理组数
*/
TotalCount?: number;
/**
* 数据库代理组列表
*/
ProxyGroupInfos?: Array;
/**
* 数据库代理节点
注意:此字段可能返回 null,表示取不到有效值。
*/
ProxyNodeInfos?: Array;
/**
* sql自动转发
*/
ColumnStoreProxyForward?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterDetailDatabases请求参数结构体
*/
export interface DescribeClusterDetailDatabasesRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 偏移量,默认0
*/
Offset?: number;
/**
* 返回数量,默认20,最大100
*/
Limit?: number;
/**
* 数据库名称
*/
DbName?: string;
}
/**
* DescribeLibraDBClusters返回参数结构体
*/
export interface DescribeLibraDBClustersResponse {
/**
* 集群信息
*/
ClusterSet?: Array;
/**
* 集群数量
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InquirePriceMultiSpec请求参数结构体
*/
export interface InquirePriceMultiSpecRequest {
/**
* 可用区,每个地域提供最佳实践
*/
Zone: string;
/**
* 实例购买类型,可选值为:PREPAID, POSTPAID, SERVERLESS
*/
InstancePayMode: string;
/**
* 存储购买类型,可选值为:PREPAID, POSTPAID
*/
StoragePayMode: string;
/**
* 商品规格
*/
GoodsSpecs: Array;
}
/**
* 回档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;
/**
* 资源ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取资源ID)
*/
ResourceIds?: Array;
/**
* 集群ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取集群ID)
*/
ClusterIds?: Array;
/**
* 大订单号
注意:此字段可能返回 null,表示取不到有效值。
*/
BigDealIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 访问代理配置
*/
export interface ProxyConfigInfo {
/**
* 数据库代理组节点个数。该参数不再建议使用,建议使用ProxyZones
*/
ProxyCount?: number;
/**
* cpu核数
*/
Cpu?: number;
/**
* 内存
*/
Mem?: number;
/**
* 描述说明
*/
Description?: string;
/**
* 数据库节点信息(该参数与ProxyCount需要任选一个输入)
*/
ProxyZones?: Array;
}
/**
* 实例组信息
*/
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;
/**
* VPC的ID
注意:此字段可能返回 null,表示取不到有效值。
*/
UniqVpcId?: string;
/**
* 子网ID
注意:此字段可能返回 null,表示取不到有效值。
*/
UniqSubnetId?: string;
/**
* 正在回收IP信息
注意:此字段可能返回 null,表示取不到有效值。
*/
OldAddrInfo?: OldAddrInfo;
/**
* 正在进行的任务
*/
ProcessingTasks?: Array;
/**
* 任务列表
*/
Tasks?: Array;
/**
* biz_net_service表id
*/
NetServiceId?: number;
}
/**
* ModifyInstanceParam请求参数结构体
*/
export interface ModifyInstanceParamRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID
*/
InstanceIds?: Array;
/**
* 集群参数列表,例如 [{ "CurrentValue":"2", "ParamName":"auto_increment_increment"}]
*/
ClusterParamList?: Array;
/**
* 实例参数列表,例如[{ "CurrentValue":"2", "ParamName":"innodb_stats_transient_sample_pages"}]
*/
InstanceParamList?: Array;
/**
* yes:在运维时间窗内修改,no:立即执行(默认值)
*/
IsInMaintainPeriod?: string;
}
/**
* ModifyInstanceUpgradeLimitDays返回参数结构体
*/
export interface ModifyInstanceUpgradeLimitDaysResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLibraDBClusters返回参数结构体
*/
export interface CreateLibraDBClustersResponse {
/**
* 预付费总订单号
*/
BigDealIds?: Array;
/**
* 集群ID
*/
ClusterIds?: Array;
/**
* 每个资源对应一个dealName,业务需要根据dealName保证发货接口幂等
*/
DealNames?: Array;
/**
* 冻结流水
*/
TranId?: string;
/**
* 实例id
*/
ResourceIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据库表信息
*/
export interface DatabaseTables {
/**
* 数据库名
*/
Database?: string;
/**
* 表名称列表
*/
Tables?: Array;
}
/**
* 用户主机权限
*/
export interface UserHostPrivilege {
/**
* 授权用户
*/
DbUserName: string;
/**
* 客户端ip
*/
DbHost: string;
/**
* 用户权限
*/
DbPrivilege: string;
}
/**
* StopCLSDelivery请求参数结构体
*/
export interface StopCLSDeliveryRequest {
/**
* 实例id
*/
InstanceId: string;
/**
* 日志主题id
*/
CLSTopicIds: Array;
/**
* 日志类型
*/
LogType?: string;
/**
* 是否维护时间运行
*/
IsInMaintainPeriod?: string;
}
/**
* OpenWan请求参数结构体
*/
export interface OpenWanRequest {
/**
* 实例组id
* @deprecated
*/
InstanceGrpId?: string;
/**
* 实例ID
*/
InstanceId?: string;
/**
* 实例组id
*/
InstanceGroupId?: 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;
/**
* 排序字段,取值范围:
CREATETIME:创建时间
PERIODENDTIME:过期时间
*/
OrderBy?: string;
/**
* 排序类型,取值范围:
ASC:升序排序
DESC:降序排序
*/
OrderByType?: string;
/**
* 搜索条件,若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
*/
Filters?: Array;
}
/**
* DescribeSQLExecutionPlan请求参数结构体
*/
export interface DescribeSQLExecutionPlanRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID
*/
InstanceId: string;
/**
* SQL模板ID
*/
TemplateID: string;
/**
* 计划详情序列号
*/
PlanDetailId: number;
}
/**
* OpenReadOnlyInstanceExclusiveAccess返回参数结构体
*/
export interface OpenReadOnlyInstanceExclusiveAccessResponse {
/**
* 开通流程ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SearchClusterDatabases返回参数结构体
*/
export interface SearchClusterDatabasesResponse {
/**
* 数据库列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Databases?: Array;
/**
* 唯一请求 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;
}
/**
* DescribeBackupDownloadUserRestriction请求参数结构体
*/
export interface DescribeBackupDownloadUserRestrictionRequest {
/**
* 分页大小
*/
Limit?: number;
/**
* 偏移量
*/
Offset?: number;
/**
* 是否只查询用户级别下载限制,true-是,false-否
*/
OnlyUserRestriction?: boolean;
}
/**
* 备份文件所在地域及ID
*/
export interface BackupRegionAndIds {
/**
* 备份地域
*/
BackupRegion?: string;
/**
* 备份ID
*/
BackupId?: number;
}
/**
* SearchClusterTables返回参数结构体
*/
export interface SearchClusterTablesResponse {
/**
* 数据表列表
*/
Tables?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterDetail请求参数结构体
*/
export interface DescribeClusterDetailRequest {
/**
* 集群Id
*/
ClusterId: string;
}
/**
* CopyBackupToVault返回参数结构体
*/
export interface CopyBackupToVaultResponse {
/**
* 任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyResourcePackageName请求参数结构体
*/
export interface ModifyResourcePackageNameRequest {
/**
* 资源包唯一ID
*/
PackageId: string;
/**
* 自定义的资源包名称,最长支持120个字符
*/
PackageName: string;
}
/**
* 添加实例或者变配实例时同步升级proxy.
*/
export interface UpgradeProxy {
/**
* cpu
*/
Cpu: number;
/**
* memory
*/
Mem: number;
/**
* 代理节点信息
*/
ProxyZones: Array;
/**
* 重新负载均衡
*/
ReloadBalance?: string;
}
/**
* DescribeClusterPeriodScalePolicy返回参数结构体
*/
export interface DescribeClusterPeriodScalePolicyResponse {
/**
* 集群周期弹性策略列表
*/
PolicyList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenAIOptimizer请求参数结构体
*/
export interface OpenAIOptimizerRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID
*/
InstanceId: string;
}
/**
* ModifyBackupName返回参数结构体
*/
export interface ModifyBackupNameResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
/**
* 备份文件所在地域
*/
ExistRegions?: Array;
/**
* 投递状态
*/
CopyStatus?: string;
/**
* 秘钥id
*/
EncryptKeyId?: string;
/**
* 秘钥地域
*/
EncryptRegion?: string;
/**
* 保险箱信息
*/
VaultInfos?: Array;
/**
* 备份周期策略
*/
BackupPeriodStrategy?: 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;
/**
* 是否滚动升级
*/
IsRollUpgrade?: string;
/**
* 滚动升级等待时间,单位:秒
*/
RollUpgradeWaitingTime?: number;
}
/**
* DescribeBinlogDownloadUrl返回参数结构体
*/
export interface DescribeBinlogDownloadUrlResponse {
/**
* 下载地址
*/
DownloadUrl?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLibraDBInstanceSpecs返回参数结构体
*/
export interface DescribeLibraDBInstanceSpecsResponse {
/**
* 该地域实例规格信息列表
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceSpecSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 稀疏备份配置
*/
export interface SparseBackupConfig {
/**
* 稀疏备份开关:ON/OFF
*/
SparseBackupSwitch?: string;
/**
* 稀疏备份策略列表(1-3条)
*/
SparseBackupConfigInfos?: Array;
}
/**
* 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;
}
/**
* CloseSSL请求参数结构体
*/
export interface CloseSSLRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID
*/
InstanceId?: string;
}
/**
* 实例信息
*/
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;
/**
* 是否冻结
*/
IsFreeze?: string;
/**
* 资源标签
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceTags?: Array;
/**
* 读写实例当前所在可用区
*/
MasterZone?: string;
/**
* 备可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
SlaveZones?: Array;
/**
* 实例网络信息
*/
InstanceNetInfo?: Array;
/**
* 实例绑定资源包信息(此处只返回计算资源包,即packageType=CCU)
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourcePackages?: Array;
/**
* 实例索引形态,可选值【mixedRowColumn(行列混存),onlyRowIndex(仅行存)】
*/
InstanceIndexMode?: string;
/**
* 当前实例支持的能力
*/
InstanceAbility?: InstanceAbility;
/**
* 实例机器类型
- common,通用型。
- exclusive,独享型。
*/
DeviceType?: string;
/**
* 实例存储类型
*/
InstanceStorageType?: string;
/**
* 未知字段
*/
CynosVersionTag?: string;
/**
* libradb 节点信息
*/
NodeList?: Array;
/**
* 全球数据库唯一标识
*/
GdnId?: string;
/**
* 实例当前所在可用区
*/
RealZone?: 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;
}
/**
* DescribeClusterDatabases返回参数结构体
*/
export interface DescribeClusterDatabasesResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* 分页偏移
*/
Offset?: number;
/**
* 数据库列表
*/
Databases?: Array;
/**
* 分页限制数
*/
Limit?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLibraDBClusterName请求参数结构体
*/
export interface ModifyLibraDBClusterNameRequest {
/**
* 分析集群 ID
*/
ClusterId: string;
/**
* 集群名称
*/
ClusterName: string;
}
/**
* ResetLibraDBClusterAccountPassword返回参数结构体
*/
export interface ResetLibraDBClusterAccountPasswordResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例变配任务信息
*/
export interface ModifyInstanceData {
/**
* 变配后CPU
*/
Cpu?: number;
/**
* 变配后内存
*/
Memory?: number;
/**
* 变配后存储上限
*/
StorageLimit?: number;
/**
* 变配前CPU
*/
OldCpu?: number;
/**
* 变配前内存
*/
OldMemory?: number;
/**
* 变配前存储上限
*/
OldStorageLimit?: number;
/**
* 变配前实例机器类型
1. common,通用型。
2. exclusive,独享型。
*/
OldDeviceType?: string;
/**
* 变配后实例机器类型
1. common,通用型。
2. exclusive,独享型。
*/
DeviceType?: string;
/**
* 升级方式。升级完成后切换或维护时间内切换
*/
UpgradeType?: string;
/**
* libra节点数量
*/
LibraNodeCount?: number;
/**
* 原libra节点数量
*/
OldLibraNodeCount?: number;
}
/**
* DescribeInstanceParams请求参数结构体
*/
export interface DescribeInstanceParamsRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID,支持批量查询
*/
InstanceIds: Array;
/**
* 参数名搜索条件,支持模糊匹配
*/
ParamKeyword?: string;
/**
* 是否为全局参数
*/
IsGlobal?: string;
}
/**
* ModifyBinlogSaveDays请求参数结构体
*/
export interface ModifyBinlogSaveDaysRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* Binlog保留天数
*/
BinlogSaveDays: number;
/**
* 跨地域备份保留时间
单位:天
*/
BinlogCrossRegionSaveDays?: number;
}
/**
* 数据库代理规格
*/
export interface ProxySpec {
/**
* 数据库代理cpu核数
*/
Cpu?: number;
/**
* 数据库代理内存
*/
Mem?: number;
}
/**
* AddInstances返回参数结构体
*/
export interface AddInstancesResponse {
/**
* 冻结流水,一次开通一个冻结流水。
*/
TranId?: string;
/**
* 付费的订单号。说明:建议您使用 DescribeResourcesByDealName 接口查询订单关联实例。
*/
DealNames?: Array;
/**
* 发货资源id列表。
* @deprecated
*/
ResourceIds?: Array;
/**
* 大订单号
*/
BigDealIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSaveBackupClusters返回参数结构体
*/
export interface DescribeSaveBackupClustersResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* 遗留备份信息
*/
SaveBackupClusterInfos?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 备份下载集群限制参数
*/
export interface BackupLimitClusterRestriction {
/**
* 集群id
*/
ClusterId?: string;
/**
* 下载限制配置
*/
BackupLimitRestriction?: BackupLimitRestriction;
}
/**
* 实例慢查询信息
*/
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 MonthDay {
/**
* 月份信息
*/
Month: number;
/**
* 日期信息
*/
Day: number;
}
/**
* ModifyLibraDBClusterAccountHost返回参数结构体
*/
export interface ModifyLibraDBClusterAccountHostResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIntegrateTask请求参数结构体
*/
export interface DescribeIntegrateTaskRequest {
/**
* 大订单id,大订单id和子订单id必须二选一
*/
BigDealId?: string;
/**
* 订单列表
*/
DealNames?: Array;
}
/**
* DescribeBinlogListByVault请求参数结构体
*/
export interface DescribeBinlogListByVaultRequest {
/**
* 保险箱ID
*/
VaultId: string;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 备份ID列表
*/
BackupIds?: Array;
/**
* 备份名称列表
*/
BackupNames?: Array;
/**
* 文件名列表
*/
FileNames?: Array;
/**
* 返回数量,范围: (0, 100],默认100
*/
Limit?: number;
/**
* 偏移量,范围: [0, INF),默认0
*/
Offset?: number;
/**
* 排序字段,可选值: VaultId, VaultName, BackupSaveSeconds, LockedTime, CreateTime, UpdateTime,默认createTime
*/
OrderBy?: string;
/**
* 排序方式,可选值: desc, asc, DESC, ASC,默认desc
*/
OrderByType?: string;
/**
* 状态
*/
Status?: string;
}
/**
* 安全组规则
*/
export interface PolicyRule {
/**
* 策略,ACCEPT或者DROP
*/
Action?: string;
/**
* 来源Ip或Ip段,例如192.168.0.0/16
*/
CidrIp?: string;
/**
* 端口
*/
PortRange?: string;
/**
* 网络协议,支持udp、tcp等
*/
IpProtocol?: string;
/**
* 协议端口ID或者协议端口组ID。
*/
ServiceModule?: string;
/**
* IP地址ID或者ID地址组ID。
*/
AddressModule?: string;
/**
* id
*/
Id?: string;
/**
* 描述
*/
Desc?: string;
}
/**
* 数据库代理组详细信息
*/
export interface ProxyGroupInfo {
/**
* 数据库代理组
*/
ProxyGroup?: ProxyGroup;
/**
* 数据库代理组读写分离信息
*/
ProxyGroupRwInfo?: ProxyGroupRwInfo;
/**
* 数据库代理节点信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ProxyNodes?: Array;
/**
* 数据库代理连接池信息
*/
ConnectionPool?: ProxyConnectionPoolInfo;
/**
* 数据库代理网络信息
注意:此字段可能返回 null,表示取不到有效值。
*/
NetAddrInfos?: Array;
/**
* 数据库代理任务集
*/
Tasks?: Array;
}
/**
* AssociateSecurityGroups返回参数结构体
*/
export interface AssociateSecurityGroupsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateProxyEndPoint请求参数结构体
*/
export interface CreateProxyEndPointRequest {
/**
* 集群 ID。
*/
ClusterId: string;
/**
* 私有网络 ID。
*/
UniqueVpcId: string;
/**
* 私有网络子网 ID。
*/
UniqueSubnetId: string;
/**
* 连接池类型:SessionConnectionPool(会话级别连接池)。
*/
ConnectionPoolType?: string;
/**
* 是否开启连接池。
yes:表示开启。
no:表示不开启。
*/
OpenConnectionPool?: string;
/**
* 连接池阈值:单位(秒),可选范围:0 - 300秒。
*/
ConnectionPoolTimeOut?: number;
/**
* 绑定的安全组 ID 数组。
*/
SecurityGroupIds?: Array;
/**
* 描述说明。
*/
Description?: string;
/**
* 想要绑定的 vip 信息,需与 UniqueVpcId 对应。
*/
Vip?: string;
/**
* 权重模式:
system:系统分配。
custom:自定义。
*/
WeightMode?: string;
/**
* 是否自动添加只读实例。
yes:表示自动添加只读实例。
no:表示不自动添加只读实例。
*/
AutoAddRo?: string;
/**
* 是否开启故障转移。
yes:表示开启,开启后,当数据库代理出现故障时,连接地址将会路由到主实例。
no:表示不开启。
说明:
仅当 RwType 参数值为 READWRITE 时,才支持设置此项。
*/
FailOver?: string;
/**
* 一致性类型:
eventual:最终一致性。
global:全局一致性。
session:会话一致性。
说明:
仅当 RwType 参数值为 READWRITE 时,才支持设置此项。
*/
ConsistencyType?: string;
/**
* 读写属性:
READWRITE:表示读写分离。当此参数值为 READWRITE 时,才支持设置 FailOver、ConsistencyType 参数。
READONLY:表示只读。
*/
RwType?: string;
/**
* 一致性超时时间。取值范围:0 ~ 1000000(微秒)。设置为0时,表示若只读实例出现延迟导致一致性策略不满足时,请求将一直等待。
*/
ConsistencyTimeOut?: number;
/**
* 是否开启事务拆分。开启后,在一个事务中拆分读和写到不同的实例上去执行。
*/
TransSplit?: boolean;
/**
* 接入模式:
nearby:就近访问。
balance:均衡分配。
*/
AccessMode?: string;
/**
* 实例权重。
*/
InstanceWeights?: Array;
/**
* 负载均衡模式
枚举值:
- static: 静态负载
- dynamic: 动态负载
*/
LoadBalanceMode?: string;
}
/**
* ModifyBackupDownloadUserRestriction返回参数结构体
*/
export interface ModifyBackupDownloadUserRestrictionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddLibraDBInstances返回参数结构体
*/
export interface AddLibraDBInstancesResponse {
/**
* 大订单号
注意:此字段可能返回 null,表示取不到有效值。
*/
BigDealIds?: Array;
/**
* 冻结流水,一次开通一个冻结流水。
注意:此字段可能返回 null,表示取不到有效值。
*/
TranId?: string;
/**
* 后付费订单号。
注意:此字段可能返回 null,表示取不到有效值。
*/
DealNames?: Array;
/**
* 发货资源id列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 审计规则模板的详情
*/
export interface AuditRuleTemplateInfo {
/**
* 规则模板ID。
*/
RuleTemplateId?: string;
/**
* 规则模板名称。
*/
RuleTemplateName?: string;
/**
* 规则模板的过滤条件
*/
RuleFilters?: Array;
/**
* 规则模板描述。
*/
Description?: string;
/**
* 规则模板创建时间。
*/
CreateAt?: string;
/**
* 规则模板修改时间。
*/
UpdateAt?: string;
/**
* 告警等级。1-低风险,2-中风险,3-高风险。
*/
AlarmLevel?: number;
/**
* 告警策略。0-不告警,1-告警。
*/
AlarmPolicy?: number;
/**
* 模板状态。0-无任务 ,1-修改中。
*/
Status?: number;
/**
* 规则模板应用在哪些在实例。
*/
AffectedInstances?: Array;
}
/**
* DescribeParamTemplateDetail请求参数结构体
*/
export interface DescribeParamTemplateDetailRequest {
/**
* 参数模板ID
*/
TemplateId: number;
}
/**
* OpenReadOnlyInstanceExclusiveAccess请求参数结构体
*/
export interface OpenReadOnlyInstanceExclusiveAccessRequest {
/**
* 请使用 [集群信息描述](https://cloud.tencent.com/document/api/1003/48086) 获取 clusterId。
*/
ClusterId: string;
/**
* 请使用 [集群信息描述](https://cloud.tencent.com/document/api/1003/48086) 获取 instanceId。
*/
InstanceId: string;
/**
* 指定的 vpc ID,请使用 [查询私有网络列表](https://cloud.tencent.com/document/api/215/15778) 获取 vpc ID。
*/
VpcId: string;
/**
* 指定的子网 ID,如果设置了 vpc ID,则 SubnetId 必填,请使用 [查询子网列表](https://cloud.tencent.com/document/api/215/15784) 获取 SubnetId。
*/
SubnetId: string;
/**
* 用户自定义的端口。
*/
Port: number;
/**
* 安全组 ID,请使用 [查看安全组](https://cloud.tencent.com/document/api/215/15808) 获取 SecurityGroupId。
*/
SecurityGroupIds?: Array;
}
/**
* AI 优化器任务数据
*/
export interface AIOptimizerTaskData {
/**
* 模板ID
*/
TemplateID?: string;
}
/**
* redolog信息
*/
export interface DescribeRedoLogListByVaultItem {
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* RedoLog文件信息
*/
RedoFileInfo?: RedoLogItem;
}
/**
* 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;
}
/**
* DescribeClusterReadOnly返回参数结构体
*/
export interface DescribeClusterReadOnlyResponse {
/**
* 集群只读开关列表
*/
ClusterReadOnlyValues?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceSpecs请求参数结构体
*/
export interface DescribeInstanceSpecsRequest {
/**
* 数据库类型,取值范围:
MYSQL
*/
DbType: string;
/**
* 是否需要返回可用区信息
*/
IncludeZoneStocks?: boolean;
/**
* 实例机器类型
*/
DeviceType?: string;
/**
* 集群级别,可空。例如 P0, P1
*/
ClusterLevel?: string;
}
/**
* ModifyMaintainPeriodConfig返回参数结构体
*/
export interface ModifyMaintainPeriodConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClusterPeriodScalePolicy返回参数结构体
*/
export interface ModifyClusterPeriodScalePolicyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProxyNodes返回参数结构体
*/
export interface DescribeProxyNodesResponse {
/**
* 数据库代理节点总数
*/
TotalCount?: number;
/**
* 数据库代理节点列表
*/
ProxyNodeInfos?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateIntegrateCluster请求参数结构体
*/
export interface CreateIntegrateClusterRequest {
/**
* 可用区
*/
Zone: string;
/**
* 所属VPC网络ID
*/
VpcId: string;
/**
* 所属子网ID
*/
SubnetId: string;
/**
* 数据库版本,取值范围:
MYSQL可选值:5.7,8.0
*/
DbVersion: string;
/**
* 所属项目ID
*/
ProjectId?: number;
/**
* 集群名称,长度小于64个字符,每个字符取值范围:大/小写字母,数字,特殊符号('-','_','.')
*/
ClusterName?: string;
/**
* 账号密码(8-64个字符,包含大小写英文字母、数字和符号~!@#$%^&*_-+=`|\(){}[]:;'<>,.?/中的任意三种)
*/
AdminPassword?: string;
/**
* 端口,默认3306,取值范围[0, 65535)
*/
Port?: number;
/**
* 计费模式,按量计费:0,包年包月:1。默认按量计费。
*/
PayMode?: number;
/**
* 购买集群数,可选值范围[1,3],默认为1
*/
Count?: number;
/**
* 普通实例存储上限,单位GB
当DbType为MYSQL,且存储计费模式为预付费时,该参数需不大于cpu与memory对应存储规格上限
*/
StorageLimit?: number;
/**
* 包年包月购买时长
*/
TimeSpan?: number;
/**
* 包年包月购买时长单位,['s','d','m','y']
*/
TimeUnit?: string;
/**
* 包年包月购买是否自动续费,默认为0。
0标识默认续费方式,1表示自动续费,2表示不自动续费。
*/
AutoRenewFlag?: number;
/**
* 是否自动选择代金券 1是 0否 默认为0
*/
AutoVoucher?: number;
/**
* 集群创建需要绑定的tag数组信息
*/
ResourceTags?: Array;
/**
* 集群存储计费模式,按量计费:0,包年包月:1。默认按量计费
当DbType为MYSQL时,在集群计算计费模式为后付费(包括DbMode为SERVERLESS)时,存储计费模式仅可为按量计费
回档与克隆均不支持包年包月存储
*/
StoragePayMode?: number;
/**
* 安全组id数组
*/
SecurityGroupIds?: Array;
/**
* 告警策略Id数组
*/
AlarmPolicyIds?: Array;
/**
* 参数数组,暂时支持character_set_server (utf8|latin1|gbk|utf8mb4) ,lower_case_table_names,1-大小写不敏感,0-大小写敏感
*/
ClusterParams?: Array;
/**
* 交易模式,0-下单且支付,1-下单
*/
DealMode?: number;
/**
* 参数模板ID,可以通过查询参数模板信息DescribeParamTemplates获得参数模板ID
*/
ParamTemplateId?: number;
/**
* 多可用区地址
*/
SlaveZone?: string;
/**
* 实例初始化配置信息,主要用于购买集群时选不同规格实例
*/
InstanceInitInfos?: Array;
/**
* 全球数据库唯一标识
*/
GdnId?: string;
/**
* 数据库代理配置
*/
ProxyConfig?: ProxyConfigInfo;
/**
* 是否自动归档
*/
AutoArchive?: string;
/**
* 暂停后的归档处理时间
*/
AutoArchiveDelayHours?: number;
/**
* 加密方法(由加密算法和密钥对版本组成)
*/
EncryptMethod?: string;
/**
* 集成集群配置信息
*/
IntegrateCreateClusterConfig?: IntegrateCreateClusterConfig;
/**
* 存储架构类型。 枚举值:1.0/2.0 默认值:1.0
*/
StorageVersion?: 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;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
}
/**
* DescribeZones返回参数结构体
*/
export interface DescribeZonesResponse {
/**
* 地域信息
*/
RegionSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GrantAccountPrivileges请求参数结构体
*/
export interface GrantAccountPrivilegesRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 账号信息
*/
Account: InputAccount;
/**
* 数据库表权限码数组
*/
DbTablePrivileges: Array;
/**
* 数据库表信息
*/
DbTables: Array;
}
/**
* ModifyParamTemplate请求参数结构体
*/
export interface ModifyParamTemplateRequest {
/**
* 模板ID
*/
TemplateId: number;
/**
* 模板名
*/
TemplateName?: string;
/**
* 模板描述
*/
TemplateDescription?: string;
/**
* 参数列表
*/
ParamList?: Array;
}
/**
* OpenAuditService返回参数结构体
*/
export interface OpenAuditServiceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 快照备份设置
*/
export interface SnapshotBackupConfig {
/**
* 系统自动时间
*/
BackupCustomAutoTime?: boolean;
/**
* 表示全备开始时间,[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;
/**
* 该参数目前不支持修改,无需填写。备份频率,长度为7的数组,分别对应周日到周六的备份方式,full-全量备份,increment-增量备份
*/
BackupWeekDays?: Array;
/**
* 间隔时间
*/
BackupIntervalTime?: number;
/**
* 表示保留备份时长, 单位秒,超过该时间将被清理, 七天表示为3600247=604800,最大为158112000
*/
ReserveDuration?: number;
/**
* 自动数据备份触发策略,periodically:自动周期备份,frequent:高频备份
*/
BackupTriggerStrategy?: string;
/**
* 保险箱信息
*/
AutoCopyVaults?: Array;
}
/**
* DescribeChangedParamsAfterUpgrade返回参数结构体
*/
export interface DescribeChangedParamsAfterUpgradeResponse {
/**
* 参数个数
*/
TotalCount?: number;
/**
* 实例参数列表
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyServerlessStrategy返回参数结构体
*/
export interface ModifyServerlessStrategyResponse {
/**
* 异步流程id
* @deprecated
*/
FlowId?: number;
/**
* 任务id
*/
TaskId?: 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;
/**
* 是否开通读写节点,yse-是,no-否
*/
OpenRw?: string;
/**
* 读写属性,可选值:READWRITE,READONLY
*/
RwType?: string;
/**
* 事务拆分
*/
TransSplit?: boolean;
/**
* 连接模式,可选值:balance,nearby
*/
AccessMode?: string;
/**
* 是否将libra节点当作普通RO节点
*/
ApNodeAsRoNode?: boolean;
/**
* libra节点故障,是否转发给其他节点
*/
ApQueryToOtherNode?: boolean;
/**
* 自动负载
枚举值:
- static: 静态负载
- dynamic: 动态负载
*/
LoadBalanceMode?: string;
}
/**
* DescribeProxyNodes请求参数结构体
*/
export interface DescribeProxyNodesRequest {
/**
* 返回数量,默认为 20,最大值为 100
*/
Limit?: number;
/**
* 记录偏移量,默认值为0
*/
Offset?: number;
/**
* 排序字段,取值范围:
CREATETIME:创建时间
PERIODENDTIME:过期时间
*/
OrderBy?: string;
/**
* 排序类型,取值范围:
ASC:升序排序
DESC:降序排序
*/
OrderByType?: string;
/**
* 搜索条件,若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。目前支持的搜索字段:Status、ProxyNodeId、ClusterId、OssProxyNodeName。
*/
Filters?: Array;
}
/**
* 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;
/**
* 已废弃。
* @deprecated
*/
Filter?: AuditLogFilter;
/**
* 分页参数,单次返回的数据条数。默认值为100,最大值为100。
*/
Limit?: number;
/**
* 分页偏移量。
说明:Limit 和 Offset 的取值之和需小于等于65536。
*/
Offset?: number;
/**
* 过滤条件。多个值之前是且的关系。
*/
LogFilter?: Array;
}
/**
* InquirePriceCreate返回参数结构体
*/
export interface InquirePriceCreateResponse {
/**
* 实例价格
*/
InstancePrice?: TradePrice;
/**
* 存储价格
*/
StoragePrice?: TradePrice;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterReadOnly请求参数结构体
*/
export interface DescribeClusterReadOnlyRequest {
/**
* 集群ID列表
*/
ClusterIds: Array;
}
/**
* DescribeIntegrateTask返回参数结构体
*/
export interface DescribeIntegrateTaskResponse {
/**
* 当前步骤
*/
CurrentStep?: string;
/**
* 当前进度
*/
CurrentProgress?: string;
/**
* 任务状态
*/
TaskStatus?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLibraDBClusters请求参数结构体
*/
export interface CreateLibraDBClustersRequest {
/**
* 数量
*/
Count: number;
/**
* 可用区
*/
Zone: string;
/**
* 实例初始化信息
*/
InstanceInitInfos: Array;
/**
* 用户密码
*/
AdminPassword?: string;
/**
* 是否自动续费
*/
AutoRenewFlag?: number;
/**
* 是否自动选择代金券
*/
AutoVoucher?: number;
/**
* 集群名称
*/
ClusterName?: string;
/**
* 下单模式
*/
DealMode?: string;
/**
* 加密方法
*/
EncryptMethod?: string;
/**
* LibraDBVersion 版本,缺省为最新版本
*/
LibraDBVersion?: string;
/**
* 订单来源
*/
OrderSource?: string;
/**
* 付费模式
*/
PayMode?: number;
/**
* 项目id
*/
ProjectId?: string;
/**
* 安全组
*/
SecurityGroupIds?: Array;
/**
* 时长
*/
TimeSpan?: number;
/**
* 时间单位
*/
TimeUnit?: string;
/**
* 实例创建绑定Tag数组信息
*/
ResourceTags?: Array;
/**
* 集群所在vpcId
*/
VpcId?: string;
/**
* 集群所在SubnetId
*/
SubnetId?: string;
/**
* 端口
*/
Port?: string;
}
/**
* CreateClusters请求参数结构体
*/
export interface CreateClustersRequest {
/**
* 可用区
*/
Zone: string;
/**
* 所属VPC网络ID
*/
VpcId: string;
/**
* 所属子网ID
*/
SubnetId: string;
/**
* 数据库类型
枚举值:
*/
DbType: string;
/**
* 数据库版本
枚举值:
- 5.7: MySQL5.7版本
- 8.0: MySQL8.0版本
*/
DbVersion: string;
/**
* 所属项目ID
*/
ProjectId?: number;
/**
* 当DbMode为NORMAL或不填时必选
普通实例Cpu核数
*/
Cpu?: number;
/**
* 当DbMode为NORMAL或不填时必选
普通实例内存,单位GB
*/
Memory?: number;
/**
* 实例数量
取值范围:[1, 16]
默认值:2
- 取值为2,表示一个 rw 实例 + 一个 ro 实例。
- 传递的 n 表示1个 rw 实例 + n-1个 ro 实例(规格相同)。
- 如需要更精确的集群组成搭配,请使用 InstanceInitInfos。
- 此参数设置的数值适用于预置资源集群,如需设置 Serverless 集群的实例规格及数量,请使用 InstanceInitInfos.N 中的 InstanceInitInfo 结构。
*/
InstanceCount?: number;
/**
* 该参数无实际意义,已废弃。
存储大小,单位GB。
*/
Storage?: number;
/**
* 集群名称,长度小于64个字符,每个字符取值范围:大/小写字母,数字,特殊符号('-','_','.')
*/
ClusterName?: string;
/**
* 账号密码(8-64个字符,包含大小写英文字母、数字和符号~!@#$%^&*_-+=`|(){}[]:;'<>,.?/中的任意三种)
*/
AdminPassword?: string;
/**
* 端口,默认3306,取值范围[0, 65535)
*/
Port?: number;
/**
* 计费模式
枚举值:
默认值:0
*/
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;
/**
* 包年包月购买时长
*/
TimeSpan?: number;
/**
* 包年包月购买时长单位,['s','d','m','y']
*/
TimeUnit?: string;
/**
* 包年包月购买是否自动续费
枚举值:
默认值:0
*/
AutoRenewFlag?: number;
/**
* 是否自动选择代金券 1是 0否 默认为0
枚举值:
默认值:0
*/
AutoVoucher?: number;
/**
* 实例数量(该参数已不再使用,只做存量兼容处理)
*/
HaCount?: number;
/**
* 订单来源
*/
OrderSource?: string;
/**
* 集群创建需要绑定的tag数组信息
*/
ResourceTags?: Array;
/**
* Db类型
枚举值:
- NORMAL: 普通实例
- SERVERLESS: serverless实例
默认值:NORMAL
当DbType为MYSQL时可选(默认NORMAL)
*/
DbMode?: string;
/**
* 当DbMode为SERVERLESS时必填
cpu最小值,可选范围参考DescribeServerlessInstanceSpecs接口返回
*/
MinCpu?: number;
/**
* 当DbMode为SERVERLESS时必填:
cpu最大值,可选范围参考DescribeServerlessInstanceSpecs接口返回
*/
MaxCpu?: number;
/**
* 否自动暂停
枚举值:
默认值:yes
DbMode为SERVERLESS生效
*/
AutoPause?: string;
/**
* 当DbMode为SERVERLESS时,指定集群自动暂停的延迟,单位秒,可选范围[600,691200]
默认值:600
*/
AutoPauseDelay?: number;
/**
* 集群存储计费模式,按量计费:0,包年包月:1。默认按量计费
当DbType为MYSQL时,在集群计算计费模式为后付费(包括DbMode为SERVERLESS)时,存储计费模式仅可为按量计费
回档与克隆均不支持包年包月存储
*/
StoragePayMode?: number;
/**
* 安全组id数组
*/
SecurityGroupIds?: Array;
/**
* 告警策略Id数组
*/
AlarmPolicyIds?: Array;
/**
* 参数数组,暂时支持character_set_server (utf8|latin1|gbk|utf8mb4) ,lower_case_table_names,1-大小写不敏感,0-大小写敏感
*/
ClusterParams?: Array;
/**
* 交易模式
枚举值:
默认值:0
*/
DealMode?: number;
/**
* 参数模板ID,可以通过查询参数模板信息DescribeParamTemplates获得参数模板ID
*/
ParamTemplateId?: number;
/**
* 多可用区地址
*/
SlaveZone?: string;
/**
* 实例初始化配置信息,主要用于购买集群时选不同规格实例
*/
InstanceInitInfos?: Array;
/**
* 全球数据库唯一标识
*/
GdnId?: string;
/**
* 数据库代理配置
*/
ProxyConfig?: ProxyConfig;
/**
* 是否自动归档
枚举值:
默认值:no
仅当前集群主实例为SERVERLESS时,该参数生效
*/
AutoArchive?: string;
/**
* 暂停后的归档处理时间
单位:时
默认值:12
仅当前集群主实例为SERVERLESS时,该参数生效
*/
AutoArchiveDelayHours?: number;
/**
* 集群级别,可空。例如 P0, P1。(可忽略该字段)
*/
ClusterLevel?: string;
/**
* 内核小版本号
*/
CynosVersion?: string;
/**
* 同步方式。可选值:async、semisync、sync。
*/
SyncWay?: string;
/**
* 半同步超时时间,单位ms。为保证业务稳定性,半同步复制存在退化逻辑,当主可用区集群在等待备可用区集群确认事务时若超过该超时时间,复制方式将降为异步复制。
取值范围:[1000, 4294967295]
单位:毫秒
默认值:10000
*/
SemiSyncTimeout?: number;
}
/**
* DescribeLibraDBInstanceSpecs请求参数结构体
*/
export type DescribeLibraDBInstanceSpecsRequest = null;
/**
* DescribeClusterParamLogs请求参数结构体
*/
export interface DescribeClusterParamLogsRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID列表,用来记录具体操作哪些实例
*/
InstanceIds?: Array;
/**
* 排序字段,定义在回返结果的基于哪个字段进行排序
*/
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;
}
/**
* DownloadLibraDBClusterList返回参数结构体
*/
export interface DownloadLibraDBClusterListResponse {
/**
* 分析集群信息
*/
ClusterSet?: Array;
/**
* 总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RollBackCluster返回参数结构体
*/
export interface RollBackClusterResponse {
/**
* 任务流ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenSSL请求参数结构体
*/
export interface OpenSSLRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID
*/
InstanceId?: string;
}
/**
* DescribeVaults请求参数结构体
*/
export interface DescribeVaultsRequest {
/**
* 保险箱ID列表,用于精确筛选
*/
VaultIds?: Array;
/**
* 保险箱名称,用于模糊筛选
*/
VaultName?: string;
/**
* 保险箱状态列表,用于筛选
*/
Status?: Array;
/**
* 每页数量,范围(0,100],默认100
*/
Limit?: number;
/**
* 偏移量,范围[0,+∞),默认0
*/
Offset?: number;
/**
* 排序字段,可选值:VaultId, VaultName, BackupSaveSeconds, LockedTime, CreateTime, UpdateTime
*/
OrderBy?: string;
/**
* 排序方式,可选值:desc, asc, DESC, ASC
*/
OrderByType?: string;
}
/**
* CheckTransferClusterZone返回参数结构体
*/
export interface CheckTransferClusterZoneResponse {
/**
* 是否check成功
*/
CheckStatus?: boolean;
/**
* check失败的原因
*/
CheckMsg?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterInstanceGrps返回参数结构体
*/
export interface DescribeClusterInstanceGrpsResponse {
/**
* 实例组个数
*/
TotalCount?: number;
/**
* 实例组列表
* @deprecated
*/
InstanceGrpInfoList?: Array;
/**
* 实例组列表
*/
InstanceGroupInfoList?: Array;
/**
* 唯一请求 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;
/**
* 备注
*/
Description?: string;
/**
* 历史授权用户主机权限
*/
OldUserHostPrivileges?: Array;
}
/**
* 同步数据对象
*/
export interface MigrateObject {
/**
* 数据库迁移模式
注意:此字段可能返回 null,表示取不到有效值。
*/
MigrateDBMode?: string;
/**
* 数据库信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Databases?: Array;
}
/**
* DescribeResourcePackageDetail请求参数结构体
*/
export interface DescribeResourcePackageDetailRequest {
/**
* 资源包唯一ID
*/
PackageId: string;
/**
* 集群ID
*/
ClusterIds?: Array;
/**
* 开始时间
*/
StartTime?: string;
/**
* 结束时间
*/
EndTime?: string;
/**
* 偏移量
*/
Offset?: string;
/**
* 限制
*/
Limit?: string;
/**
* 实例D
*/
InstanceIds?: Array;
}
/**
* 集群周期弹性策略
*/
export interface ClusterPeriodScalePolicy {
/**
* 策略ID
*/
PolicyId?: string;
/**
* 实例类型。rw-读写类型,ro-只读类型。
*/
InstanceType?: string;
/**
* 弹性下限, 后续废弃, 请使用MinCcu
*/
MinCpu?: number;
/**
* 弹性上限,后续废弃,请使用MaxCcu
*/
MaxCpu?: number;
/**
* 弹性开始时间
*/
ScaleStartTime?: string;
/**
* 弹性结束时间
*/
ScaleEndTime?: string;
/**
* 策略有效起始日期时间
*/
PolicyStartTime?: string;
/**
* 策略有效截止日期时间
*/
PolicyEndTime?: string;
/**
* 周期类型。day-天, week-星期,month-月
*/
PeriodType?: string;
/**
* 在周期内的时间配置。对于week,表示星期几;对于month,表示几号。对于day,此参数不生效。
*/
PeriodConfig?: Array;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 策略状态。normal-正常,expired-过期, deleted-删除
*/
Status?: 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;
}
/**
* InquirePriceMultiSpec返回参数结构体
*/
export interface InquirePriceMultiSpecResponse {
/**
* 商品价格
*/
GoodsPrice?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRedoLogs请求参数结构体
*/
export interface DescribeRedoLogsRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 每页条数
*/
Limit?: number;
/**
* 偏移量
*/
Offset?: number;
/**
* 开始时间
*/
StartTime?: string;
/**
* 结束时间
*/
EndTime?: string;
/**
* redolog文件名
*/
FileNames?: Array;
}
/**
* libra分析集群源数据库信息
*/
export interface LibraDBClusterSrcInfo {
/**
* 源端类型
*/
SrcInstanceType: string;
/**
* 网络类型
*/
AccessType?: string;
/**
* 源端实例ID
*/
SrcInstanceId?: string;
/**
* 源端集群ID
*/
SrcClusterId?: string;
/**
* 地址
*/
IP?: string;
/**
* 端口
*/
Port?: string;
/**
* 用户名
*/
User?: string;
/**
* 密码
*/
Password?: string;
/**
* 源端sql_mode
*/
SqlMode?: string;
/**
* 源端应用id
*/
SrcAppId?: number;
/**
* 源端账号
*/
SrcUin?: string;
/**
* 源端子账号
*/
SrcSubAccountUin?: string;
/**
* 账号
*/
AccountMode?: string;
/**
* 源端实例地域
*/
Region?: string;
/**
* 对源端实例的操作
*/
Operation?: string;
}
/**
* DescribeLibraDBInstanceDetail请求参数结构体
*/
export interface DescribeLibraDBInstanceDetailRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 只读分析引擎实例 ID
*/
InstanceId: string;
}
/**
* DescribeLibraDBClusterAccountAllPrivileges请求参数结构体
*/
export interface DescribeLibraDBClusterAccountAllPrivilegesRequest {
/**
* 分析集群id
*/
ClusterId: string;
/**
* 账号
*/
Account: InputAccount;
}
/**
* DisassociateSecurityGroups请求参数结构体
*/
export interface DisassociateSecurityGroupsRequest {
/**
* 实例组 ID 数组,cynosdbmysql-grp-前缀开头或集群 ID。
说明:要获取集群的实例组 ID,可通过 [查询集群实例组](https://cloud.tencent.com/document/product/1003/103934) 进行。
*/
InstanceIds: Array;
/**
* 要修改的安全组ID列表,一个或者多个安全组ID组成的数组。
*/
SecurityGroupIds: Array;
/**
* 可用区。
说明:请正确输入集群所在的主可用区,若输入非集群所在的主可用区可能显示调用成功,但实际执行会失败。
* @deprecated
*/
Zone?: string;
}
/**
* ModifyBackupName请求参数结构体
*/
export interface ModifyBackupNameRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 备份文件ID
*/
BackupId: number;
/**
* 备注名,长度不能超过60个字符
*/
BackupName: string;
}
/**
* ModifyLibraDBClusterAccountPrivilege返回参数结构体
*/
export interface ModifyLibraDBClusterAccountPrivilegeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 规则审计的过滤条件
*/
export interface AuditRuleFilters {
/**
* 单条审计规则。
*/
RuleFilters: Array;
}
/**
* 稀疏备份配置
*/
export interface SparseBackupConfigRsp {
/**
* 稀疏备份开关:ON/OFF
注意:此字段可能返回 null,表示取不到有效值。
*/
SparseBackupSwitch?: string;
/**
* 稀疏备份策略列表(1-3条)
注意:此字段可能返回 null,表示取不到有效值。
*/
SparseBackupConfigInfos?: Array;
}
/**
* DescribeClusterParams请求参数结构体
*/
export interface DescribeClusterParamsRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 参数名字
*/
ParamName?: string;
/**
* 是否为全局参数
*/
IsGlobal?: string;
}
/**
* 保险箱信息
*/
export interface DescribeVaultsItem {
/**
* 保险箱ID
*/
VaultId?: string;
/**
* 保险箱名称
*/
VaultName?: string;
/**
* 保险箱描述
*/
VaultDescribe?: string;
/**
* 加密密钥ID
*/
KeyId?: string;
/**
* 密钥所在地域
*/
KeyRegion?: string;
/**
* 密钥类型
*/
KeyType?: string;
/**
* 备份文件数量
*/
BackupFileCount?: number;
/**
* 备份文件总大小(字节)
*/
BackupFileSize?: number;
/**
* Binlog文件数量
*/
BinlogFileCount?: number;
/**
* Binlog文件总大小(字节)
*/
BinlogFileSize?: number;
/**
* RedoLog文件数量
*/
RedoLogFileCount?: number;
/**
* RedoLog文件总大小(字节)
*/
RedoLogFileSize?: number;
/**
* 保险箱状态
*/
Status?: string;
/**
* 备份保留时长(秒)
*/
BackupSaveSeconds?: number;
/**
* 锁定时间
*/
LockedTime?: string;
/**
* 关联任务列表
*/
Tasks?: Array;
/**
* 保险箱所在地域
*/
VaultRegion?: string;
/**
* 自动投递关系
*/
AutoCopyConfigs?: Array;
}
/**
* 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;
/**
* 日志类型
*/
LogType?: string;
/**
* 是否维护时间运行
*/
IsInMaintainPeriod?: string;
}
/**
* DescribeLibraDBClusterAccountPrivileges请求参数结构体
*/
export interface DescribeLibraDBClusterAccountPrivilegesRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 账号名
*/
AccountName: string;
/**
* 主机名
*/
Host: string;
/**
* 数据库名
*/
Db: string;
/**
* 类型
*/
Type: string;
/**
* 表名
*/
TableName?: string;
}
/**
* 集成集群proxy地址配置
*/
export interface ProxyEndPointConfigInfo {
/**
* 所属VPC网络ID
*/
UniqueVpcId?: string;
/**
* 所属子网ID
*/
UniqueSubnetId?: string;
/**
* 安全组id数组
*/
SecurityGroupIds?: Array;
/**
* 权重模式: system-系统分配,custom-自定义
*/
WeightMode?: string;
/**
* 是否自动添加只读实例,yes-是,no-不自动添加
*/
AutoAddRo?: string;
/**
* 读写属性: READWRITE,READONLY
*/
RwType?: string;
/**
* 权重信息
*/
InstanceNameWeights?: Array;
}
/**
* CreateCLSDelivery返回参数结构体
*/
export interface CreateCLSDeliveryResponse {
/**
* 异步任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeServerlessInstanceSpecs返回参数结构体
*/
export interface DescribeServerlessInstanceSpecsResponse {
/**
* Serverless实例可选规格
*/
Specs?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 手动备份任务信息
*/
export interface ManualBackupData {
/**
* 备份类型。snapshot-快照备份
*/
BackupType?: string;
/**
* 备份方式。auto-自动备份,manual-手动
*/
BackupMethod?: string;
/**
* 备份时间
*/
SnapshotTime?: string;
/**
* 跨地域备份项详细信息
注意:此字段可能返回 null,表示取不到有效值。
*/
CrossRegionBackupInfos?: Array;
}
/**
* DescribeBinlogs请求参数结构体
*/
export interface DescribeBinlogsRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 开始时间
*/
StartTime?: string;
/**
* 结束时间
*/
EndTime?: string;
/**
* 偏移量
*/
Offset?: number;
/**
* 限制条数,默认值为20
*/
Limit?: number;
}
/**
* DescribeSSLStatus返回参数结构体
*/
export interface DescribeSSLStatusResponse {
/**
* yes-开启,no-关闭
*/
IsOpenSSL?: string;
/**
* 证书下载地址
*/
DownloadUrl?: string;
/**
* 唯一请求 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;
}
/**
* CancelClusterServerlessScalePlan请求参数结构体
*/
export interface CancelClusterServerlessScalePlanRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 计划ID
*/
PlanId: number;
}
/**
* ModifyLibraDBClusterReplicationObject返回参数结构体
*/
export interface ModifyLibraDBClusterReplicationObjectResponse {
/**
* 异步任务ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeProxyVersion请求参数结构体
*/
export interface UpgradeProxyVersionRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 数据库代理当前版本
*/
SrcProxyVersion: string;
/**
* 数据库代理升级版本
*/
DstProxyVersion: string;
/**
* 数据库代理组ID
*/
ProxyGroupId?: string;
/**
* 升级时间 :no(升级完成时)yes(实例维护时间)
*/
IsInMaintainPeriod?: 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;
/**
* 是否开启故障转移,代理出现故障后,连接地址将路由到主实例,取值:"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;
/**
* 是否将libra节点当作普通RO节点
*/
ApNodeAsRoNode?: boolean;
/**
* libra节点故障,是否转发给其他节点
*/
ApQueryToOtherNode?: boolean;
/**
* 负载均衡模式
枚举值:
- static: 静态负载
- dynamic: 动态负载
*/
LoadBalanceMode?: string;
}
/**
* DescribeResourcePackageList返回参数结构体
*/
export interface DescribeResourcePackageListResponse {
/**
* 资源包总数
*/
Total?: number;
/**
* 资源包明细
*/
Detail?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLibraDBInstanceDetail返回参数结构体
*/
export interface DescribeLibraDBInstanceDetailResponse {
/**
* 主账号
注意:此字段可能返回 null,表示取不到有效值。
*/
Uin?: string;
/**
* 账号唯一ID
注意:此字段可能返回 null,表示取不到有效值。
*/
AppId?: number;
/**
* 集群ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterId?: string;
/**
* 集群名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterName?: string;
/**
* 实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId?: string;
/**
* 实例名称
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceName?: string;
/**
* 项目ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ProjectId?: number;
/**
* 地域
注意:此字段可能返回 null,表示取不到有效值。
*/
Region?: string;
/**
* 可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
Zone?: string;
/**
* 实例状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: string;
/**
* 状态描述
注意:此字段可能返回 null,表示取不到有效值。
*/
StatusDesc?: string;
/**
* Libra分析引擎版本
注意:此字段可能返回 null,表示取不到有效值。
*/
LibraDBVersion?: string;
/**
* cpu核数
注意:此字段可能返回 null,表示取不到有效值。
*/
Cpu?: number;
/**
* 内存大小
注意:此字段可能返回 null,表示取不到有效值。
*/
Memory?: number;
/**
* 存储大小
注意:此字段可能返回 null,表示取不到有效值。
*/
Storage?: number;
/**
* 存储类型
注意:此字段可能返回 null,表示取不到有效值。
*/
StorageType?: string;
/**
* 实例类型
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceType?: string;
/**
* 实例角色
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceRole?: string;
/**
* 更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: string;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 售卖方式
注意:此字段可能返回 null,表示取不到有效值。
*/
PayMode?: number;
/**
* 售卖开始时间
注意:此字段可能返回 null,表示取不到有效值。
*/
PeriodStartTime?: string;
/**
* 售卖结束时间
注意:此字段可能返回 null,表示取不到有效值。
*/
PeriodEndTime?: string;
/**
* 续费标识
注意:此字段可能返回 null,表示取不到有效值。
*/
RenewFlag?: number;
/**
* 网络类型
注意:此字段可能返回 null,表示取不到有效值。
*/
NetType?: number;
/**
* 私有网络ID
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId?: string;
/**
* 子网ID
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId?: string;
/**
* 虚拟IP
注意:此字段可能返回 null,表示取不到有效值。
*/
Vip?: string;
/**
* 端口
注意:此字段可能返回 null,表示取不到有效值。
*/
Vport?: number;
/**
* 实例网络信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceNetInfo?: InstanceNetInfo;
/**
* 实例标签信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceTags?: Array;
/**
* 实例节点信息
*/
NodeInfo?: Array;
/**
* 实例节点个数
*/
NodeCount?: number;
/**
* 分析实例升级版本之后信息
注意:此字段可能返回 null,表示取不到有效值。
*/
AnalysisUpgradeVersionInfo?: UpgradeAnalysisInstanceVersionInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceSpecsByOperationType返回参数结构体
*/
export interface DescribeInstanceSpecsByOperationTypeResponse {
/**
* 实例规格信息
*/
InstanceSpecSet?: Array;
/**
* 唯一请求 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;
/**
* 修改后的审计规则。
*/
RuleFilters?: Array;
/**
* 修改后的规则模板名称。
*/
RuleTemplateName?: string;
/**
* 修改后的规则模板描述。
*/
Description?: string;
/**
* 告警等级。1-低风险,2-中风险,3-高风险。
*/
AlarmLevel?: number;
/**
* 告警策略。0-不告警,1-告警。
*/
AlarmPolicy?: number;
}
/**
* 创建集群任务信息
*/
export interface CreateClustersData {
/**
* 实例CPU
*/
Cpu?: number;
/**
* 实例内存
*/
Memory?: number;
/**
* 集群存储上限
*/
StorageLimit?: number;
}
/**
* 遗留备份列表
*/
export interface SaveBackupClusterInfo {
/**
* 遗照备份id
*/
BackupId?: number;
/**
* 集群id
*/
ClusterId?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* 地域
*/
Region?: string;
/**
* 可用区
*/
Zone?: string;
/**
* 备份时间
*/
BackupTime?: string;
/**
* 数据库版本
*/
DbVersion?: string;
/**
* Db类型(NORMAL, SERVERLESS)
*/
DbMode?: string;
/**
* 集群状态
*/
ClusterStatus?: string;
/**
* 任务列表
*/
Tasks?: Array;
}
/**
* DescribeProxies请求参数结构体
*/
export interface DescribeProxiesRequest {
/**
* 集群 ID(该参数必传,例如 cynosdbmysql-2u2mh111)。
*/
ClusterId?: string;
/**
* 返回数量,默认为 20,最大值为 100
*/
Limit?: number;
/**
* 记录偏移量,默认值为0
*/
Offset?: number;
/**
* 排序字段,取值范围:
CREATETIME:创建时间 PERIODENDTIME:过期时间
*/
OrderBy?: string;
/**
* 排序类型,取值范围:
ASC:升序排序 DESC:降序排序
*/
OrderByType?: string;
/**
* 搜索条件,若存在多个 Filter 时,Filter 间的关系为逻辑与(AND)关系。
说明:此参数当前仅支持 Status 和 ProxyGroupId 两种过滤条件。
*/
Filters?: Array;
}
/**
* ModifySnapBackupCrossRegionConfig请求参数结构体
*/
export interface ModifySnapBackupCrossRegionConfigRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 是否开启跨地域快照备份ON/OFF
*/
CrossRegionsEnable?: string;
/**
* 快照备份所跨地域
*/
CrossRegions?: Array;
/**
* 跨地域备份保留时间
单位:天
*/
CrossRegionSaveDays?: number;
}
/**
* 转发实例信息
*/
export interface ForwardInstanceInfo {
/**
* 转发实例id
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId?: string;
/**
* 转发实例地域
注意:此字段可能返回 null,表示取不到有效值。
*/
Region?: string;
}
/**
* 修改的实例参数信息
*/
export interface ModifyParamItem {
/**
* 参数名
*/
ParamName: string;
/**
* 参数当前值
*/
CurrentValue: string;
/**
* 参数旧值(只在出参时有用)
*/
OldValue?: string;
/**
* libra组件类型
*/
Component?: string;
}
/**
* AssociateSecurityGroups请求参数结构体
*/
export interface AssociateSecurityGroupsRequest {
/**
* 实例组 ID 数组,cynosdbmysql-grp-前缀开头或集群 ID。
说明:要获取集群的实例组 ID,可通过 [查询集群实例组](https://cloud.tencent.com/document/product/1003/103934) 进行。
*/
InstanceIds: Array;
/**
* 要修改的安全组ID列表,一个或者多个安全组Id组成的数组。
*/
SecurityGroupIds: Array;
/**
* 可用区
* @deprecated
*/
Zone?: string;
}
/**
* 参数模板信息
*/
export interface ParamTemplateListInfo {
/**
* 参数模板ID
*/
Id?: number;
/**
* 参数模板名称
*/
TemplateName?: string;
/**
* 参数模板描述
*/
TemplateDescription?: string;
/**
* 引擎版本
*/
EngineVersion?: string;
/**
* 数据库类型,可选值:NORMAL,SERVERLESS
*/
DbMode?: string;
/**
* 参数模板详情
注意:此字段可能返回 null,表示取不到有效值。
*/
ParamInfoSet?: Array;
}
/**
* CloseProxyEndPoint请求参数结构体
*/
export interface CloseProxyEndPointRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 数据库代理组ID
*/
ProxyGroupId: string;
}
/**
* libra实例初始化信息
*/
export interface LibraDBInstanceInitInfo {
/**
* cpu
*/
Cpu?: number;
/**
* 内存
*/
Memory?: number;
/**
* 硬盘
*/
StorageSize?: number;
/**
* 存储类型
*/
StorageType?: string;
/**
* 实例类型
*/
InstanceType?: string;
/**
* 实例版本
*/
LibraDBVersion?: string;
/**
* 实例数量
*/
InstanceCount?: number;
/**
* vpc id
*/
VpcId?: string;
/**
* subnet id
*/
SubnetId?: string;
/**
* 端口
*/
Port?: number;
/**
* 购买实例副本数
*/
ReplicasNum?: number;
}
/**
* DescribeBinlogs返回参数结构体
*/
export interface DescribeBinlogsResponse {
/**
* 记录总条数
*/
TotalCount?: number;
/**
* Binlog列表
*/
Binlogs?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenAIOptimizer返回参数结构体
*/
export interface OpenAIOptimizerResponse {
/**
* 任务流id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 审计实例详情
*/
export interface AuditInstanceInfo {
/**
* 项目ID
*/
ProjectId?: number;
/**
* 标签信息
*/
TagList?: Array;
}
/**
* AddClusterSlaveZone返回参数结构体
*/
export interface AddClusterSlaveZoneResponse {
/**
* 异步FlowId
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProxySpecs返回参数结构体
*/
export interface DescribeProxySpecsResponse {
/**
* 数据库代理规格列表
*/
ProxySpecs?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindClusterResourcePackages请求参数结构体
*/
export interface BindClusterResourcePackagesRequest {
/**
* 资源包唯一ID
*/
PackageIds: Array;
/**
* 集群ID
*/
ClusterId: string;
}
/**
* IsolateInstance返回参数结构体
*/
export interface IsolateInstanceResponse {
/**
* 任务流id
*/
FlowId?: number;
/**
* 隔离实例的订单id(预付费实例)
注意:此字段可能返回 null,表示取不到有效值。
*/
DealNames?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CopyClusterPasswordComplexity返回参数结构体
*/
export interface CopyClusterPasswordComplexityResponse {
/**
* 任务流ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterTransparentEncryptInfo请求参数结构体
*/
export interface DescribeClusterTransparentEncryptInfoRequest {
/**
* 集群id
*/
ClusterId: string;
}
/**
* DescribeClusterLevels请求参数结构体
*/
export interface DescribeClusterLevelsRequest {
/**
* 可用区
*/
Zone?: string;
}
/**
* DeleteVaults返回参数结构体
*/
export interface DeleteVaultsResponse {
/**
* 删除任务列表,每个保险箱对应一个任务
*/
VaultTask?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 同步对象详情
*/
export interface MigrateOpt {
/**
* 包含数据库表信息
*/
DatabaseTables?: MigrateObject;
}
/**
* 商品规格
*/
export interface GoodsSpec {
/**
* 商品数量
注意:此字段可能返回 null,表示取不到有效值。
*/
GoodsNum?: number;
/**
* CPU核数,PREPAID与POSTPAID实例类型必传
注意:此字段可能返回 null,表示取不到有效值。
*/
Cpu?: number;
/**
* 内存大小,单位G,PREPAID与POSTPAID实例类型必传
注意:此字段可能返回 null,表示取不到有效值。
*/
Memory?: number;
/**
* Ccu大小,serverless类型必传
注意:此字段可能返回 null,表示取不到有效值。
*/
Ccu?: number;
/**
* 存储大小,PREPAID存储类型必传
注意:此字段可能返回 null,表示取不到有效值。
*/
StorageLimit?: number;
/**
* 购买时长
注意:此字段可能返回 null,表示取不到有效值。
*/
TimeSpan?: number;
/**
* 时长单位
注意:此字段可能返回 null,表示取不到有效值。
*/
TimeUnit?: string;
/**
* 实例机器类型
1. common,通用型。
2. exclusive,独享型。
*/
DeviceType?: string;
}
/**
* DeleteParamTemplate请求参数结构体
*/
export interface DeleteParamTemplateRequest {
/**
* 参数模板ID
*/
TemplateId: number;
}
/**
* DescribeLibraDBClusterAutoMapRule请求参数结构体
*/
export interface DescribeLibraDBClusterAutoMapRuleRequest {
/**
* 分析集群ID
*/
ClusterId: string;
/**
* 分析实例ID
*/
InstanceId: string;
}
/**
* RevokeAccountPrivileges返回参数结构体
*/
export interface RevokeAccountPrivilegesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRedoLogs返回参数结构体
*/
export interface DescribeRedoLogsResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* redo日志信息
*/
RedoLogs?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* serverless规格
*/
export interface ServerlessSpec {
/**
* cpu最小值
*/
MinCpu?: number;
/**
* cpu最大值
*/
MaxCpu?: number;
/**
* 最大存储空间
*/
MaxStorageSize?: number;
/**
* 是否为默认规格
*/
IsDefault?: number;
/**
* 是否有库存
*/
HasStock?: boolean;
/**
* 库存数量
*/
StockCount?: number;
/**
* 可用区库存信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneStockInfos?: Array;
}
/**
* ModifyBackupDownloadRestriction请求参数结构体
*/
export interface ModifyBackupDownloadRestrictionRequest {
/**
* 集群ID
*/
ClusterIds: Array;
/**
* 下载限制类型,NoLimit-不限制,LimitOnlyIntranet-限制内网 ,Customize-自定义
*/
LimitType: string;
/**
* 该参数仅支持 In, 表示 LimitVpc 指定的vpc可以下载。默认为In
*/
VpcComparisonSymbol?: string;
/**
* In: 指定的ip可以下载; NotIn: 指定的ip不可以下载
*/
IpComparisonSymbol?: string;
/**
* 限制下载的vpc设置
*/
LimitVpcs?: Array;
/**
* 限制下载的ip设置
*/
LimitIps?: Array;
}
/**
* DescribeClusterDetailDatabases返回参数结构体
*/
export interface DescribeClusterDetailDatabasesResponse {
/**
* 数据库信息
*/
DbInfos?: Array;
/**
* 总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateParamTemplate返回参数结构体
*/
export interface CreateParamTemplateResponse {
/**
* 模板ID
*/
TemplateId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 日志过滤条件
*/
export interface LogFilter {
/**
* 过滤项。
*/
Type?: string;
/**
* 过滤条件。支持以下条件: WINC-包含(分词维度), WEXC-不包含(分词维度), INC - 包含, EXC - 不包含, EQS - 等于, NEQ - 不等于, RA - 范围。
*/
Compare?: string;
/**
* 过滤的值。反向查询时,多个值之前是且的关系,正向查询多个值是或的关系
*/
Value?: Array;
}
/**
* DescribeAccountAllGrantPrivileges返回参数结构体
*/
export interface DescribeAccountAllGrantPrivilegesResponse {
/**
* 权限语句
*/
PrivilegeStatements?: Array;
/**
* 全局权限
*/
GlobalPrivileges?: Array;
/**
* 数据库权限
*/
DatabasePrivileges?: Array;
/**
* 数据库表权限
*/
TablePrivileges?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 修改数据库内核版本任务信息
*/
export interface ModifyDbVersionData {
/**
* 修改前版本
*/
OldVersion?: string;
/**
* 修改后版本
*/
NewVersion?: string;
/**
* 升级方式
*/
UpgradeType?: string;
}
/**
* 数据库权限列表
*/
export interface DatabasePrivileges {
/**
* 数据库
*/
Db: string;
/**
* 权限列表
*/
Privileges: Array;
}
/**
* DescribeLibraDBClusterTableMapping请求参数结构体
*/
export interface DescribeLibraDBClusterTableMappingRequest {
/**
* 分析集群ID
*/
ClusterId: string;
/**
* 分析引擎实例ID
*/
InstanceId: string;
/**
* 节点ID
*/
NodeId?: string;
/**
* 偏移量
*/
Offset?: number;
/**
* 页面记录限制
*/
Limit?: number;
/**
* 源端schema列表
*/
SrcSchemas?: Array;
/**
* 源端表列表
*/
SrcTableName?: Array;
/**
* 状态列表
*/
StatusList?: Array;
/**
* 映射数据库名称
*/
MapSchemas?: Array;
/**
* 映射表名
*/
MapTableName?: Array;
/**
* 是否查询映射数据库名称不为空的记录
*/
MapSchemaNotEmpty?: boolean;
/**
* 是否查询映射表名不为空的记录
*/
MapTableNameNotEmpty?: boolean;
}
/**
* DescribeSupportProxyVersion请求参数结构体
*/
export interface DescribeSupportProxyVersionRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 数据库代理组ID
*/
ProxyGroupId?: string;
}
/**
* DescribeProxySpecs请求参数结构体
*/
export interface DescribeProxySpecsRequest {
/**
* 集群id
*/
ClusterId?: string;
}
/**
* ResumeServerless请求参数结构体
*/
export interface ResumeServerlessRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* DeleteAuditLogFile返回参数结构体
*/
export interface DeleteAuditLogFileResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例网络信息
*/
export interface InstanceNetInfo {
/**
* 网络类型
*/
InstanceGroupType?: string;
/**
* 实例组ID
*/
InstanceGroupId?: string;
/**
* 私有网络ID
*/
VpcId?: string;
/**
* 子网ID
*/
SubnetId?: string;
/**
* 网络类型, 0-基础网络, 1-vpc网络, 2-黑石网络
*/
NetType?: number;
/**
* 私有网络IP
*/
Vip?: string;
/**
* 私有网络端口
*/
Vport?: number;
/**
* 外网域名
*/
WanDomain?: string;
/**
* 外网IP
*/
WanIP?: string;
/**
* 外网端口
*/
WanPort?: number;
/**
* 外网开启状态
*/
WanStatus?: string;
}
/**
* ModifyClusterDatabase返回参数结构体
*/
export interface ModifyClusterDatabaseResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例参数信息
*/
export interface InstanceParamItem {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 实例参数列表
*/
ParamsItems?: Array;
}
/**
* IsolateLibraDBInstance请求参数结构体
*/
export interface IsolateLibraDBInstanceRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 只读分析引擎实例 ID 列表
*/
InstanceIdList: Array;
/**
* 是否是强制隔离
*/
ForceIsolate?: boolean;
/**
* 隔离原因类型
*/
IsolateReasonTypes?: Array;
/**
* 隔离原因
*/
IsolateReason?: string;
}
/**
* DescribeVaults返回参数结构体
*/
export interface DescribeVaultsResponse {
/**
* 保险箱列表
*/
Vaults?: Array;
/**
* 总数量
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TransferClusterPrepayToPostpay返回参数结构体
*/
export interface TransferClusterPrepayToPostpayResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBSecurityGroups请求参数结构体
*/
export interface DescribeDBSecurityGroupsRequest {
/**
* 实例ID(InstanceId与InstanceGroupId必须任选一个传入)
* @deprecated
*/
InstanceId?: string;
/**
* 实例组 ID,可通过 [DescribeClusterInstanceGroups](https://cloud.tencent.com/document/product/1003/103934) 接口查询。
*/
InstanceGroupId?: string;
}
/**
* 回档任务信息
*/
export interface RollbackData {
/**
* 实例CPU
*/
Cpu?: number;
/**
* 实例内存
*/
Memory?: number;
/**
* 集群存储上限
*/
StorageLimit?: number;
/**
* 原集群id
*/
OriginalClusterId?: string;
/**
* 原集群名
*/
OriginalClusterName?: string;
/**
* 回档方式
*/
RollbackStrategy?: string;
/**
* 快照时间
*/
SnapshotTime?: string;
/**
* 回档到 Serverless 集群时最小 CPU
*/
MinCpu?: number;
/**
* 回档到 Serverless 集群时最大 CPU
*/
MaxCpu?: number;
/**
* 快照ID
*/
SnapShotId?: number;
/**
* 回档数据库
注意:此字段可能返回 null,表示取不到有效值。
*/
RollbackDatabases?: Array;
/**
* 回档数据表
注意:此字段可能返回 null,表示取不到有效值。
*/
RollbackTables?: Array;
/**
* 备份文件名称
*/
BackupFileName?: string;
/**
* 回档进程
*/
RollbackProcess?: RollbackProcessInfo;
}
/**
* UnbindClusterResourcePackages请求参数结构体
*/
export interface UnbindClusterResourcePackagesRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 资源包唯一ID,如果不传,解绑该实例绑定的所有资源包
*/
PackageIds?: Array;
}
/**
* ModifyBackupDownloadUserRestriction请求参数结构体
*/
export interface ModifyBackupDownloadUserRestrictionRequest {
/**
* 下载限制类型,NoLimit-不限制,LimitOnlyIntranet-限制内网 ,Customize-自定义
*/
LimitType: string;
/**
* 该参数仅支持 In, 表示 LimitVpc 指定的vpc可以下载。默认为In
*/
VpcComparisonSymbol?: string;
/**
* In: 指定的ip可以下载; NotIn: 指定的ip不可以下载
*/
IpComparisonSymbol?: string;
/**
* 限制下载的vpc设置
*/
LimitVpcs?: Array;
/**
* 限制下载的ip设置
*/
LimitIps?: Array;
}
/**
* DescribeInstanceParams返回参数结构体
*/
export interface DescribeInstanceParamsResponse {
/**
* 实例参数列表
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* IsolateInstance请求参数结构体
*/
export interface IsolateInstanceRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID数组,例如["cynosdbbmysql-ins-asd","cynosdbmysql-ins-zxc"]
*/
InstanceIdList: Array;
/**
* 该参数已废弃
*/
DbType?: string;
/**
* 实例退还原因类型
*/
IsolateReasonTypes?: Array;
/**
* 实例退还原因补充
*/
IsolateReason?: string;
/**
* 保留备份
*/
SaveBackup?: boolean;
}
/**
* SwitchClusterVpc返回参数结构体
*/
export interface SwitchClusterVpcResponse {
/**
* 异步任务id。
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRedoLogListByVault返回参数结构体
*/
export interface DescribeRedoLogListByVaultResponse {
/**
* 符合条件的RedoLog文件总数
*/
TotalCount?: number;
/**
* RedoLog文件列表
*/
RedoLogList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群绑定的标签信息,包含标签键TagKey和标签值TagValue
*/
export interface Tag {
/**
* 标签键
*/
TagKey: string;
/**
* 标签值
*/
TagValue: string;
}
/**
* 规则模板内容
*/
export interface RuleTemplateInfo {
/**
* 规则模板ID。
*/
RuleTemplateId?: string;
/**
* 规则模板名称。
*/
RuleTemplateName?: string;
/**
* 规则内容。
*/
RuleFilters?: Array;
/**
* 告警等级。1-低风险,2-中风险,3-高风险。
*/
AlarmLevel?: number;
/**
* 告警策略。0-不告警,1-告警。
*/
AlarmPolicy?: number;
/**
* 规则描述。
*/
Description?: string;
}
/**
* StopCLSDelivery返回参数结构体
*/
export interface StopCLSDeliveryResponse {
/**
* 异步任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAuditLogFile返回参数结构体
*/
export interface CreateAuditLogFileResponse {
/**
* 审计日志文件名称。
*/
FileName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* PauseServerless返回参数结构体
*/
export interface PauseServerlessResponse {
/**
* 异步流程ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceDetail返回参数结构体
*/
export interface DescribeInstanceDetailResponse {
/**
* 实例详情
*/
Detail?: CynosdbInstanceDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RestartLibraDBInstance请求参数结构体
*/
export interface RestartLibraDBInstanceRequest {
/**
* 只读分析引擎实例 ID
*/
InstanceId: string;
}
/**
* DeleteAccounts返回参数结构体
*/
export interface DeleteAccountsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RenewLibraDBClusters请求参数结构体
*/
export interface RenewLibraDBClustersRequest {
/**
* 时间间隔
*/
TimeSpan: number;
/**
* 时间单位
*/
TimeUnit: string;
/**
* 分析集群 ID
*/
ClusterId: string;
/**
* 订单模式
*/
DealMode?: number;
}
/**
* DescribeClusterServerlessScalePlans返回参数结构体
*/
export interface DescribeClusterServerlessScalePlansResponse {
/**
* 计划总数
*/
TotalCount?: number;
/**
* 策略列表
*/
ServerlessScalePlans?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateResourcePackage返回参数结构体
*/
export interface CreateResourcePackageResponse {
/**
* 付费总订单号
*/
BigDealIds?: Array;
/**
* 每个物品对应一个dealName,业务需要根据dealName保证发货接口幂等
*/
DealNames?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyBinlogConfig请求参数结构体
*/
export interface ModifyBinlogConfigRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* Binlog配置信息
*/
BinlogConfig: BinlogConfigInfo;
}
/**
* ModifyLibraDBClusterName返回参数结构体
*/
export interface ModifyLibraDBClusterNameResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteLibraDBClusterAccounts请求参数结构体
*/
export interface DeleteLibraDBClusterAccountsRequest {
/**
* 分析集群id
*/
ClusterId: string;
/**
* 账号
*/
Accounts: Array;
}
/**
* SetRenewFlag返回参数结构体
*/
export interface SetRenewFlagResponse {
/**
* 操作成功实例数
*/
Count?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateClusterDatabase返回参数结构体
*/
export interface CreateClusterDatabaseResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRedoLogListByVault请求参数结构体
*/
export interface DescribeRedoLogListByVaultRequest {
/**
* 保险箱ID
*/
VaultId: string;
/**
* 备份ID列表
*/
BackupIds?: Array;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 备份名称列表
*/
BackupNames?: Array;
/**
* 文件名称列表
*/
FileNames?: Array;
/**
* 每页数量,范围(0,100],默认100
*/
Limit?: number;
/**
* 偏移量,范围[0,INF),默认0
*/
Offset?: number;
/**
* 排序字段,可选值:VaultId,VaultName,BackupSaveSeconds,LockedTime,CreateTime,UpdateTime,默认createTime
*/
OrderBy?: string;
/**
* 排序方式,可选值:desc,asc,DESC,ASC,默认desc
*/
OrderByType?: string;
/**
* 状态
*/
Status?: string;
}
/**
* DescribeClusters返回参数结构体
*/
export interface DescribeClustersResponse {
/**
* 集群数
*/
TotalCount?: number;
/**
* 集群列表
*/
ClusterSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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;
/**
* 表示保留备份时长, 单位秒,超过该时间将被清理, 七天表示为3600247=604800
*/
ReserveDuration?: number;
/**
* 备份频率,长度为7的数组,分别对应周一到周日的备份方式,full-全量备份,increment-增量备份
*/
BackupFreq?: Array;
/**
* 备份方式,logic-逻辑备份,snapshot-快照备份
*/
BackupType?: string;
/**
* 跨地域逻辑备份配置修改时间
*/
LogicCrossRegionsConfigUpdateTime?: string;
/**
* 自动逻辑备份配置
*/
LogicBackupConfig?: LogicBackupConfigInfo;
/**
* 二级快照备份配置信息
注意:此字段可能返回 null,表示取不到有效值。
*/
SnapshotSecondaryBackupConfig?: BackupConfigInfo;
/**
* 稀疏备份配置
*/
SparseBackupConfig?: SparseBackupConfigRsp;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 保险箱自动投递关系
*/
export interface AutoCopyConfig {
/**
* 集群id
*/
ClusterId?: string;
/**
* 保险箱ID
*/
VaultId?: string;
/**
* 保险箱地域
*/
VaultRegion?: string;
/**
* 投递类型:binlog, redolog, snapshot, logic
*/
CopyType?: string;
}
/**
* DescribeParamTemplates返回参数结构体
*/
export interface DescribeParamTemplatesResponse {
/**
* 参数模板数量
*/
TotalCount?: number;
/**
* 参数模板信息
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 访问代理配置
*/
export interface ProxyConfig {
/**
* 数据库代理组节点个数。该参数不再建议使用,建议使用ProxyZones
* @deprecated
*/
ProxyCount?: number;
/**
* cpu核数
*/
Cpu?: number;
/**
* 内存
*/
Mem?: number;
/**
* 连接池类型:SessionConnectionPool(会话级别连接池 )
*/
ConnectionPoolType?: string;
/**
* 是否开启连接池,yes-开启,no-不开启
*/
OpenConnectionPool?: string;
/**
* 连接池阈值:单位(秒)
*/
ConnectionPoolTimeOut?: number;
/**
* 描述说明
*/
Description?: string;
/**
* 数据库节点信息(该参数与ProxyCount需要任选一个输入)
*/
ProxyZones?: Array;
}
/**
* 校验项
*/
export interface CheckItem {
/**
* 校验项名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Item?: string;
/**
* 该项的校验结果
注意:此字段可能返回 null,表示取不到有效值。
*/
Result?: string;
/**
* 校验不通过的详细说明和修改建议
注意:此字段可能返回 null,表示取不到有效值。
*/
CurrentValue?: string;
/**
* 校验不通过的详细说明和修改建议
注意:此字段可能返回 null,表示取不到有效值。
*/
ExpectedValue?: string;
}
/**
* 数据库地址
*/
export interface Addr {
/**
* IP地址
*/
IP?: string;
/**
* 端口
*/
Port?: number;
}
/**
* AddServerlessRoInstances请求参数结构体
*/
export interface AddServerlessRoInstancesRequest {
/**
* 集群Id
*/
ClusterId: string;
/**
* ro实例最小规格
*/
MinCpu?: number;
/**
* ro实例最大规格
*/
MaxCpu?: number;
/**
* ro实例名称
*/
InstanceName?: string;
/**
* 所属VPC网络ID
*/
VpcId?: string;
/**
* 所属子网ID,如果设置了VpcId,则SubnetId必填
*/
SubnetId?: string;
/**
* 新增RO组时使用的Port,取值范围为[0,65535)
*/
Port?: number;
/**
* 安全组ID,新建只读实例时可以指定安全组
*/
SecurityGroupIds?: Array;
/**
* 是否自动暂停
枚举值:
*/
AutoPause?: string;
/**
* 自动暂停时间
单位:秒
*/
AutoPauseDelay?: number;
/**
* 实例参数
*/
InstanceParams?: Array;
/**
* 参数模板
*/
ParamTemplateId?: number;
/**
* 新增的只读实例数量
*/
RoCount?: number;
}
/**
* DescribeProjectSecurityGroups请求参数结构体
*/
export interface DescribeProjectSecurityGroupsRequest {
/**
* 项目ID
*/
ProjectId?: number;
/**
* 限制量
*/
Limit?: number;
/**
* 偏移量
*/
Offset?: number;
/**
* 搜索关键字
*/
SearchKey?: string;
}
/**
* serverless类型的可用区库存信息
*/
export interface ServerlessZoneStockInfo {
/**
* 可用区
*/
Zone?: string;
/**
* 存储量
*/
StockCount?: number;
/**
* 是否包含库存
*/
HasStock?: boolean;
/**
* 从可用区库存信息
*/
SlaveZoneStockInfos?: Array;
}
/**
* 数据库详细信息
*/
export interface DbInfo {
/**
* 数据库名称
*/
DbName?: string;
/**
* 字符集类型
*/
CharacterSet?: string;
/**
* 数据库状态
*/
Status?: string;
/**
* 排序规则
*/
CollateRule?: string;
/**
* 数据库备注
*/
Description?: string;
/**
* 用户权限
*/
UserHostPrivileges?: Array;
/**
* 数据库ID
*/
DbId?: number;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 用户appid
*/
AppId?: number;
/**
* 用户Uin
*/
Uin?: string;
/**
* 集群Id
*/
ClusterId?: string;
}
/**
* DescribeBackupDownloadUrl请求参数结构体
*/
export interface DescribeBackupDownloadUrlRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 备份ID
*/
BackupId: number;
/**
* 备份下载来源限制条件
*/
DownloadRestriction?: BackupLimitRestriction;
}
/**
* 实例审计详情信息
*/
export interface InstanceAuditStatus {
/**
* 实例ID。
*/
InstanceId?: string;
/**
* 审计状态。ON-表示审计已开启,OFF-表示审计关闭。
*/
AuditStatus?: string;
/**
* 日志保留时长。
*/
LogExpireDay?: number;
/**
* 高频存储时长。
*/
HighLogExpireDay?: number;
/**
* 低频存储时长。
*/
LowLogExpireDay?: number;
/**
* 日志存储量。
*/
BillingAmount?: number;
/**
* 高频存储量。
*/
HighRealStorage?: number;
/**
* 低频存储量。
*/
LowRealStorage?: number;
/**
* 是否为全审计。true-表示全审计。
*/
AuditAll?: boolean;
/**
* 审计开通时间。
*/
CreateAt?: string;
/**
* 实例相关信息。
*/
InstanceInfo?: AuditInstanceInfo;
/**
* 总存储量。
*/
RealStorage?: number;
/**
* 实例所应用的规则模板。
*/
RuleTemplateIds?: Array;
/**
* 是否开启日志投递:ON,OFF
*/
Deliver?: string;
/**
* 日志投递类型
*/
DeliverSummary?: Array;
}
/**
* CopyClusterPasswordComplexity请求参数结构体
*/
export interface CopyClusterPasswordComplexityRequest {
/**
* 复制集群ID数组,例如["cynosdbmysql-bzxxrmtq","cynosdbmysql-qwer"]
*/
ClusterIds: Array;
/**
* 集群id,例如"cynosdbmysql-bzxxrmtq"
*/
SourceClusterId: string;
}
/**
* DescribeClusterInstanceGroups返回参数结构体
*/
export interface DescribeClusterInstanceGroupsResponse {
/**
* 实例组个数
*/
TotalCount?: number;
/**
* 实例组列表
*/
InstanceGroupInfoList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLibraDBClusterAccounts返回参数结构体
*/
export interface CreateLibraDBClusterAccountsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 同步数据表名称
*/
export interface MigrateTableItem {
/**
* 数据表名称
注意:此字段可能返回 null,表示取不到有效值。
*/
TableName?: string;
}
/**
* CreateProxyEndPoint返回参数结构体
*/
export interface CreateProxyEndPointResponse {
/**
* 异步流程 ID。
*/
FlowId?: number;
/**
* 异步任务 ID。
*/
TaskId?: number;
/**
* 数据库代理组 ID。
*/
ProxyGroupId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSQLExecutionPlan返回参数结构体
*/
export interface DescribeSQLExecutionPlanResponse {
/**
* 执行计划详情
注意:此字段可能返回 null,表示取不到有效值。
*/
PlanDetail?: ExecutionPlanDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 网络信息
*/
export interface NetAddr {
/**
* 内网ip
*/
Vip?: string;
/**
* 内网端口号
*/
Vport?: number;
/**
* 外网域名
*/
WanDomain?: string;
/**
* 外网端口号
*/
WanPort?: number;
/**
* 网络类型(ro-只读,rw/ha-读写)
*/
NetType?: string;
/**
* 子网ID
*/
UniqSubnetId?: string;
/**
* 私有网络ID
*/
UniqVpcId?: string;
/**
* 描述信息
*/
Description?: string;
/**
* 外网IP
*/
WanIP?: string;
/**
* 外网状态
*/
WanStatus?: string;
/**
* 实例组ID
*/
InstanceGroupId?: string;
}
/**
* DescribeClusterStorageAutoExpand请求参数结构体
*/
export interface DescribeClusterStorageAutoExpandRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* DescribeBackupOverview返回参数结构体
*/
export interface DescribeBackupOverviewResponse {
/**
* 备份总容量
*/
BackupTotalVolume?: number;
/**
* 备份快照容量
*/
BackupSnapshotVolume?: number;
/**
* 备份逻辑容量
*/
BackupLogicVolume?: number;
/**
* 日志总容量
*/
LogTotalVolume?: number;
/**
* 日志binlog容量
*/
LogBinlogVolume?: number;
/**
* 日志redolog容量
*/
LogRedoLogVolume?: number;
/**
* 跨地域备份总容量
*/
CrossTotalVolume?: number;
/**
* 跨地域备份容量
*/
CrossRegionBackupVolume?: number;
/**
* 跨地域日志容量
*/
CrossRegionLogVolume?: number;
/**
* 备份容量详情
*/
BackupVolumeInfos?: Array;
/**
* 跨地域备份容量详情
*/
CrossRegionBackupVolumeInfos?: Array;
/**
* 跨地域信息
*/
CrossRegions?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReplayInstanceAuditLog请求参数结构体
*/
export interface ReplayInstanceAuditLogRequest {
/**
* 源集群id
*/
SourceClusterId: string;
/**
* 源实例id
*/
SourceInstanceId: string;
/**
* 目标集群id
目标集群必须为原始集群三天内克隆出的集群。
*/
TargetClusterId: string;
/**
* 目标实例id
*/
TargetInstanceId: string;
/**
* 用户名.需要host为%的用户名
*/
TargetUserName: string;
/**
* 密码
*/
TargetPassword: string;
/**
* 开始时间。时间格式为:yyyy-DD-mm hh:mm:ss
*/
StartTime: string;
/**
* 结束时间。时间格式为:yyyy-DD-mm hh:mm:ss
*/
EndTime: string;
}
/**
* 同步库表对象
*/
export interface MigrateDBItem {
/**
* 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
*/
DbName?: string;
/**
* 数据表迁移模式
注意:此字段可能返回 null,表示取不到有效值。
*/
MigrateTableMode?: string;
/**
* 数据表信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Tables?: Array;
}
/**
* 该地域实例规格信息
*/
export interface RegionInstanceSpecInfo {
/**
* cpu核数
注意:此字段可能返回 null,表示取不到有效值。
*/
Cpu?: number;
/**
* 内存大小
注意:此字段可能返回 null,表示取不到有效值。
*/
Memory?: number;
/**
* 最小存储大小
注意:此字段可能返回 null,表示取不到有效值。
*/
MinStorageSize?: number;
/**
* 最大存储大小
注意:此字段可能返回 null,表示取不到有效值。
*/
MaxStorageSize?: number;
/**
* 是否有库存
注意:此字段可能返回 null,表示取不到有效值。
*/
HasStock?: boolean;
/**
* 实例类型
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceType?: string;
/**
* 存储类型
注意:此字段可能返回 null,表示取不到有效值。
*/
StorageType?: string;
/**
* 最小副本数
注意:此字段可能返回 null,表示取不到有效值。
*/
MinReplicaNum?: number;
/**
* 最大副本数
注意:此字段可能返回 null,表示取不到有效值。
*/
MaxReplicaNum?: number;
/**
* 可用区库存信息列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneStockInfos?: Array;
}
/**
* TransferClusterPrepayToPostpay请求参数结构体
*/
export type TransferClusterPrepayToPostpayRequest = null;
/**
* ModifyAccountPrivileges返回参数结构体
*/
export interface ModifyAccountPrivilegesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InquirePriceCreate请求参数结构体
*/
export interface InquirePriceCreateRequest {
/**
* 可用区,每个地域提供最佳实践
*/
Zone: string;
/**
* 购买计算节点个数
*/
GoodsNum: number;
/**
* 实例购买类型,可选值为:PREPAID, POSTPAID, SERVERLESS
*/
InstancePayMode: string;
/**
* 存储购买类型,可选值为:PREPAID, POSTPAID
*/
StoragePayMode: string;
/**
* 实例设备类型,支持值如下:
- common:表示通用型
- exclusive:表示独享型
*/
DeviceType?: string;
/**
* CPU核数,PREPAID与POSTPAID实例类型必传
*/
Cpu?: number;
/**
* 内存大小,单位G,PREPAID与POSTPAID实例类型必传
*/
Memory?: number;
/**
* Ccu大小,serverless类型必传
*/
Ccu?: number;
/**
* 存储大小,PREPAID存储类型必传
*/
StorageLimit?: number;
/**
* 购买时长,PREPAID购买类型必传
*/
TimeSpan?: number;
/**
* 时长单位,可选值为:m,d。PREPAID购买类型必传
*/
TimeUnit?: string;
/**
* 存储架构类型。 枚举值:1.0/2.0 默认值:1.0
*/
StorageVersion?: string;
/**
* 存储是否跨AZ,2.0存储架构下有效
*/
IsMultiAz?: boolean;
}
/**
* ModifyLibraDBClusterAccountDescription请求参数结构体
*/
export interface ModifyLibraDBClusterAccountDescriptionRequest {
/**
* 分析集群id
*/
ClusterId: string;
/**
* 账号名
*/
AccountName: string;
/**
* 描述
*/
Description: string;
/**
* 主机名
*/
Host?: string;
}
/**
* ModifyAuditService请求参数结构体
*/
export interface ModifyAuditServiceRequest {
/**
* 实例ID。
*/
InstanceId: string;
/**
* 日志保留时长。
*/
LogExpireDay?: number;
/**
* 高频日志保留时长。
*/
HighLogExpireDay?: number;
/**
* 修改实例审计规则为全审计。
*/
AuditAll?: boolean;
/**
* 规则审计。
*/
AuditRuleFilters?: Array;
/**
* 规则模板ID。
*/
RuleTemplateIds?: Array;
}
/**
* DescribeLibraDBClusterDetail返回参数结构体
*/
export interface DescribeLibraDBClusterDetailResponse {
/**
* 集群信息
*/
Detail?: LibraDBClusterDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GrantAccountPrivileges返回参数结构体
*/
export interface GrantAccountPrivilegesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClusterName返回参数结构体
*/
export interface ModifyClusterNameResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 跨地域备份各地域备份信息
*/
export interface CrossRegionBackupItem {
/**
* 备份的目标地域
*/
CrossRegion?: string;
/**
* 目标地域的备份任务ID
*/
BackupId?: number;
/**
* 目标地域的备份状态
*/
BackupStatus?: string;
}
/**
* ExportInstanceSlowQueries请求参数结构体
*/
export interface ExportInstanceSlowQueriesRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 事务开始最早时间
*/
StartTime?: string;
/**
* 事务开始最晚时间
*/
EndTime?: string;
/**
* 限制条数
*/
Limit?: number;
/**
* 偏移量
*/
Offset?: number;
/**
* 用户名
*/
Username?: string;
/**
* 客户端host
*/
Host?: string;
/**
* 数据库名
*/
Database?: string;
/**
* 文件类型,可选值:csv, original
*/
FileType?: string;
/**
* 排序字段,可选值: QueryTime,LockTime,RowsExamined,RowsSent
*/
OrderBy?: string;
/**
* 排序类型,可选值:asc,desc
*/
OrderByType?: string;
}
/**
* RestartLibraDBInstance返回参数结构体
*/
export interface RestartLibraDBInstanceResponse {
/**
* 异步任务id
注意:此字段可能返回 null,表示取不到有效值。
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 修改参数时,传入参数描述
*/
export interface ParamItem {
/**
* 参数名称
*/
ParamName: string;
/**
* 当前值
*/
CurrentValue: string;
/**
* 原有值
*/
OldValue: string;
}
/**
* ResumeServerless返回参数结构体
*/
export interface ResumeServerlessResponse {
/**
* 异步流程ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteBackupVault返回参数结构体
*/
export interface DeleteBackupVaultResponse {
/**
* 任务ID,用于查询任务执行状态
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBackupDownloadUserRestriction返回参数结构体
*/
export interface DescribeBackupDownloadUserRestrictionResponse {
/**
* 集群备份下载限制信息
注意:此字段可能返回 null,表示取不到有效值。
*/
BackupLimitClusterRestrictions?: Array;
/**
* 总条数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 售卖可用区信息
*/
export interface SaleZone {
/**
* 可用区英文名
*/
Zone?: string;
/**
* 可用区数字ID
*/
ZoneId?: number;
/**
* 可用区中文名
*/
ZoneZh?: string;
/**
* 是否支持serverless集群
0:不支持
1:支持
*/
IsSupportServerless?: number;
/**
* 是否支持普通集群
0:不支持
1:支持
*/
IsSupportNormal?: number;
/**
* 物理区
*/
PhysicalZone?: string;
/**
* 用户是否有可用区权限
*/
HasPermission?: boolean;
/**
* 是否为全链路RDMA可用区
*/
IsWholeRdmaZone?: string;
/**
* 当前可用区是否允许新购集群,1:允许,0:不允许
*/
IsSupportCreateCluster?: number;
}
/**
* 实例信息
*/
export interface InstanceSet {
/**
* 数据库模式
*/
DbMode?: string;
/**
* cpu核数
*/
InstanceCpu?: number;
/**
* 实例类型
*/
InstanceDeviceType?: string;
/**
* 实例ID
*/
InstanceId?: string;
/**
* 内存
*/
InstanceMemory?: number;
/**
* 实例名称
*/
InstanceName?: string;
/**
* 实例角色
*/
InstanceRole?: string;
/**
* 实例状态
*/
InstanceStatus?: string;
/**
* 状态描述
*/
InstanceStatusDesc?: string;
/**
* 硬盘
*/
InstanceStorage?: number;
/**
* 硬盘类型
*/
InstanceStorageType?: string;
/**
* 引擎类型
*/
InstanceType?: string;
/**
* 持续的时间
*/
MaintainDuration?: number;
/**
* 执行开始时间(距离0点的秒数)
*/
MaintainStartTime?: number;
/**
* 可以执行的时间,枚举值:["Mon","Tue","Wed","Thu","Fri", "Sat", "Sun"]
*/
MaintainWeekDays?: Array;
/**
* 节点列表
*/
NodeList?: Array;
/**
* 实例任务
*/
InstanceTasks?: Array;
}
/**
* ModifySnapBackupCrossRegionConfig返回参数结构体
*/
export interface ModifySnapBackupCrossRegionConfigResponse {
/**
* 任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SwitchProxyVpc返回参数结构体
*/
export interface SwitchProxyVpcResponse {
/**
* 异步任务id。
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLibraDBForwardConfig返回参数结构体
*/
export interface ModifyLibraDBForwardConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 可用区属性项
*/
export interface SlaveZoneAttrItem {
/**
* 可用区
*/
Zone?: string;
/**
* binlog同步方式
*/
BinlogSyncWay?: string;
/**
* 半同步超时时间,单位ms
*/
SemiSyncTimeout?: number;
}
/**
* OpenWan返回参数结构体
*/
export interface OpenWanResponse {
/**
* 任务流ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 日志投递信息
*/
export interface DeliverSummary {
/**
* 投递类型,store(存储类),mq(消息通道)
*/
DeliverType?: string;
/**
* 投递子类型:cls,ckafka。
*/
DeliverSubType?: string;
/**
* 投递者
*/
DeliverConsumer?: string;
/**
* 投递者名称
*/
DeliverConsumerName?: string;
/**
* 投递异常错误
*/
DeliverError?: string;
}
/**
* DescribeChangedParamsAfterUpgrade请求参数结构体
*/
export interface DescribeChangedParamsAfterUpgradeRequest {
/**
* 集群ID
*/
InstanceId: string;
/**
* 变配后的CPU
*/
DstCpu: number;
/**
* 变配后的MEM,单位G
*/
DstMem: number;
}
/**
* CLS日志投递配置
*/
export interface CLSInfo {
/**
* 日志主题操作:可选create,reuse。
create:新增日志主题,使用TopicName创建日志主题。
reuse:使用已有日志主题,使用TopicId指定日志主题。
不允许使用已有日志主题且新建日志集的组合。
*/
TopicOperation: string;
/**
* 日志集操作:可选create,reuse。
create:新增日志集,使用GroupName创建日志集。
reuse:使用已有日志集,使用GroupId指定日志集。
不允许使用已有日志主题且新建日志集的组合。
*/
GroupOperation: string;
/**
* 日志投递地域
*/
Region: string;
/**
* 日志主题id
*/
TopicId?: string;
/**
* 日志主题name
*/
TopicName?: string;
/**
* 日志集id
*/
GroupId?: string;
/**
* 日志集name
*/
GroupName?: string;
}
/**
* DeleteBackupVault请求参数结构体
*/
export interface DeleteBackupVaultRequest {
/**
* 备份保险箱ID,长度必须大于0
*/
VaultId: string;
/**
* 待删除的备份文件ID列表,不能为空
*/
BackupIds: Array;
}
/**
* 高级映射,自动映射规则
*/
export interface AutoMapRule {
/**
* 源端实例Id
*/
SrcInstanceId: string;
/**
* 源端数据库正则
*/
SrcDatabaseRegex: string;
/**
* 源端表正则
*/
SrcTableRegex: string;
/**
* 目标端数据库正则
*/
DstDatabaseRegex: string;
/**
* 目标端表正则
*/
DstTableRegex: string;
}
/**
* SwitchProxyVpc请求参数结构体
*/
export interface SwitchProxyVpcRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 字符串vpc id
*/
UniqVpcId: string;
/**
* 字符串子网id
*/
UniqSubnetId: string;
/**
* 旧地址回收时间
*/
OldIpReserveHours: number;
/**
* 数据库代理组Id(该参数为必填项,可以通过DescribeProxies接口获得)
*/
ProxyGroupId: string;
}
/**
* RestartInstance返回参数结构体
*/
export interface RestartInstanceResponse {
/**
* 异步任务id
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBinlogSaveDays请求参数结构体
*/
export interface DescribeBinlogSaveDaysRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* DescribeClusterTransparentEncryptInfo返回参数结构体
*/
export interface DescribeClusterTransparentEncryptInfoResponse {
/**
* 加密秘钥id
*/
KeyId?: string;
/**
* 加密秘钥地域
*/
KeyRegion?: string;
/**
* 秘钥类型
*/
KeyType?: string;
/**
* 是否已经开启全局加密
*/
IsOpenGlobalEncryption?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ActivateInstance返回参数结构体
*/
export interface ActivateInstanceResponse {
/**
* 任务流id
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* IsolateCluster请求参数结构体
*/
export interface IsolateClusterRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 该参数已废用
*/
DbType?: string;
/**
* 实例退还原因类型
*/
IsolateReasonTypes?: Array;
/**
* 实例退还原因补充
*/
IsolateReason?: string;
/**
* 保留备份,true-保留(会产生费用)
*/
SaveBackup?: boolean;
}
/**
* AddInstances请求参数结构体
*/
export interface AddInstancesRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* Cpu核数
*/
Cpu: number;
/**
* 内存,单位为GB
*/
Memory: number;
/**
* 新增只读实例数,取值范围为(0,15]
*/
ReadOnlyCount: number;
/**
* 实例机器类型,支持值如下:
- common:表示通用型
- exclusive:表示独享型
*/
DeviceType?: string;
/**
* 实例组ID,在已有RO组中新增实例时使用,不传则新增RO组。当前版本不建议传输该值。
* @deprecated
*/
InstanceGrpId?: string;
/**
* 所属VPC网络ID。
*/
VpcId?: string;
/**
* 所属子网ID,如果设置了VpcId,则SubnetId必填。
*/
SubnetId?: string;
/**
* 新增RO组时使用的Port,取值范围为[0,65535)
*/
Port?: number;
/**
* 实例名称,字符串长度范围为[0,64),取值范围为大小写字母,0-9数字,'_','-','.'
*/
InstanceName?: string;
/**
* 是否自动选择代金券 1是 0否 默认为0
*/
AutoVoucher?: number;
/**
* 数据库类型,取值范围:
MYSQL
*/
DbType?: string;
/**
* 订单来源,字符串长度范围为[0,64)
*/
OrderSource?: string;
/**
* 交易模式 0-下单并支付 1-下单
*/
DealMode?: number;
/**
* 参数模板ID
*/
ParamTemplateId?: number;
/**
* 参数列表,ParamTemplateId 传入时InstanceParams才有效
*/
InstanceParams?: Array;
/**
* 安全组ID,新建只读实例时可以指定安全组。
*/
SecurityGroupIds?: Array;
/**
* proxy同步升级
*/
UpgradeProxy?: UpgradeProxy;
}
/**
* ModifyVault返回参数结构体
*/
export interface ModifyVaultResponse {
/**
* 任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例详情
*/
export interface CynosdbInstanceDetail {
/**
* 用户Uin
*/
Uin?: string;
/**
* 用户AppId
*/
AppId?: number;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* 实例ID
*/
InstanceId?: string;
/**
* 实例名称
*/
InstanceName?: string;
/**
* 项目ID
*/
ProjectId?: number;
/**
* 地域
*/
Region?: string;
/**
* 可用区
*/
Zone?: string;
/**
* 实例状态
creating:创建中
running:运行中
isolating:隔离中
isolated:已隔离
activating:恢复中
offlining:下线中
offlined:已下线
*/
Status?: string;
/**
* 实例状态中文描述
*/
StatusDesc?: string;
/**
* serverless实例状态, 可能值:
resume
pause
*/
ServerlessStatus?: string;
/**
* 数据库类型
*/
DbType?: string;
/**
* 数据库版本
*/
DbVersion?: string;
/**
* Cpu,单位:核
*/
Cpu?: number;
/**
* 内存,单位:GB
*/
Memory?: number;
/**
* 存储量,单位:GB
*/
Storage?: number;
/**
* 实例类型
*/
InstanceType?: string;
/**
* 实例当前角色
*/
InstanceRole?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 付费模式
*/
PayMode?: number;
/**
* 实例过期时间
*/
PeriodEndTime?: string;
/**
* 网络类型
*/
NetType?: number;
/**
* VPC网络ID
*/
VpcId?: string;
/**
* 子网ID
*/
SubnetId?: string;
/**
* 实例内网IP
*/
Vip?: string;
/**
* 实例内网端口
*/
Vport?: number;
/**
* 实例外网域名
*/
WanDomain?: string;
/**
* 字符集
*/
Charset?: string;
/**
* Cynos内核版本
*/
CynosVersion?: string;
/**
* 续费标志
*/
RenewFlag?: number;
/**
* serverless实例cpu下限
*/
MinCpu?: number;
/**
* serverless实例cpu上限
*/
MaxCpu?: number;
/**
* Db类型:
NORMALSERVERLESS
*/
DbMode?: string;
/**
* 集群的读写实例所在可用区
*/
MasterZone?: string;
}
/**
* DescribeBackupDownloadRestriction请求参数结构体
*/
export interface DescribeBackupDownloadRestrictionRequest {
/**
* 集群ID
*/
ClusterIds: Array;
}
/**
* libra集群详情
*/
export interface LibraDBClusterDetail {
/**
* 集群id
*/
ClusterId?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* 地域
*/
Region?: string;
/**
* 状态
*/
Status?: string;
/**
* 状态描述
*/
StatusDesc?: string;
/**
* 存储大小
*/
Storage?: number;
/**
* VPC名称
*/
VpcName?: string;
/**
* vpc唯一id
*/
VpcId?: string;
/**
* 子网名称
*/
SubnetName?: string;
/**
* 子网ID
*/
SubnetId?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 数据库版本
*/
DbVersion?: string;
/**
* 使用容量
*/
UsedStorage?: number;
/**
* vip地址
*/
Vip?: string;
/**
* vport端口
*/
Vport?: number;
/**
* 集群只读实例的vip地址和vport端口
*/
RoAddr?: Array;
/**
* cynos版本
*/
CynosVersion?: string;
/**
* 是否冻结
*/
IsFreeze?: string;
/**
* 任务列表
*/
Tasks?: Array;
/**
* 主可用区
*/
MasterZone?: string;
/**
* 实例集合
*/
InstanceSet?: Array;
/**
* 付费模式
*/
PayMode?: number;
/**
* 到期时间
*/
PeriodEndTime?: string;
/**
* 项目id
*/
ProjectID?: number;
/**
* 自动续费标识
*/
RenewFlag?: number;
/**
* 版本标签
*/
CynosVersionTag?: string;
/**
* 不支持添加ro yes-不支持添加ro, no/null/"" 支持添加ro
*/
NoSupportAddRo?: string;
/**
* 可用区
*/
Zone?: string;
/**
* 物理可用区
*/
PhysicalZone?: string;
/**
* 版本升级灰度信息
注意:此字段可能返回 null,表示取不到有效值。
*/
AnalysisUpgradeVersionInfo?: UpgradeAnalysisInstanceVersionInfo;
}
/**
* 资源包信息
*/
export interface ResourcePackage {
/**
* 资源包的唯一ID
*/
PackageId?: string;
/**
* 资源包类型:CCU:计算资源包
DISK:存储资源包
*/
PackageType?: string;
/**
* 当前资源包绑定在当前实例下的抵扣优先级
*/
DeductionPriority?: number;
}
/**
* DescribeInstanceErrorLogs请求参数结构体
*/
export interface DescribeInstanceErrorLogsRequest {
/**
* 实例Id
*/
InstanceId: string;
/**
* 日志条数限制
*/
Limit?: number;
/**
* 日志条数偏移量
*/
Offset?: number;
/**
* 开始时间
*/
StartTime?: string;
/**
* 结束时间
*/
EndTime?: string;
/**
* 排序字段,有Timestamp枚举值
*/
OrderBy?: string;
/**
* 排序类型,有ASC,DESC枚举值
*/
OrderByType?: string;
/**
* 日志等级,有error、warning、note三种,支持多个等级同时搜索
*/
LogLevels?: Array;
/**
* 关键字,支持模糊搜索
*/
KeyWords?: Array;
}
/**
* DescribeInstanceDetail请求参数结构体
*/
export interface DescribeInstanceDetailRequest {
/**
* 实例ID
*/
InstanceId: string;
}
/**
* 资源包
*/
export interface Package {
/**
* AppID
*/
AppId?: number;
/**
* 资源包唯一ID
*/
PackageId?: string;
/**
* 资源包名称
*/
PackageName?: string;
/**
* 资源包类型
CCU-计算资源包,DISK-存储资源包
*/
PackageType?: string;
/**
* 资源包使用地域
china-中国内地通用,overseas-港澳台及海外通用
*/
PackageRegion?: string;
/**
* 资源包状态
creating-创建中;
using-使用中;
expired-已过期;
normal_finish-使用完;
apply_refund-申请退费中;
refund-已退费。
*/
Status?: string;
/**
* 资源包总量
*/
PackageTotalSpec?: number;
/**
* 资源包已使用量
*/
PackageUsedSpec?: number;
/**
* 是否还有库存余量
*/
HasQuota?: boolean;
/**
* 绑定实例信息
*/
BindInstanceInfos?: Array;
/**
* 生效时间:2022-07-01 00:00:00
*/
StartTime?: string;
/**
* 失效时间:2022-08-01 00:00:00
*/
ExpireTime?: string;
/**
* 资源包历史绑定(已解绑)实例信息
*/
HistoryBindResourceInfos?: Array;
}
/**
* InquirePriceModify返回参数结构体
*/
export interface InquirePriceModifyResponse {
/**
* 实例价格
*/
InstancePrice?: TradePrice;
/**
* 存储价格
*/
StoragePrice?: TradePrice;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteAccounts请求参数结构体
*/
export interface DeleteAccountsRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 账号数组,包含account和host
*/
Accounts?: Array;
}
/**
* OpenClusterTransparentEncrypt请求参数结构体
*/
export interface OpenClusterTransparentEncryptRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 秘钥类型(cloud,custom)
*/
KeyType: string;
/**
* 秘钥Id
*/
KeyId?: string;
/**
* 秘钥地域
*/
KeyRegion?: string;
/**
* 是否开启全局加密
*/
IsOpenGlobalEncryption?: boolean;
}
/**
* ReloadBalanceProxyNode请求参数结构体
*/
export interface ReloadBalanceProxyNodeRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 数据库代理组ID
*/
ProxyGroupId: string;
}
/**
* DescribeAccounts返回参数结构体
*/
export interface DescribeAccountsResponse {
/**
* 数据库账号列表
*/
AccountSet?: Array;
/**
* 账号总数量
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 可回档的时间范围
*/
export interface RollbackTimeRange {
/**
* 开始时间
*/
TimeRangeStart?: string;
/**
* 结束时间
*/
TimeRangeEnd?: string;
}
/**
* CreateClusterDatabase请求参数结构体
*/
export interface CreateClusterDatabaseRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 数据库名
*/
DbName: string;
/**
* 字符集类型
*/
CharacterSet: string;
/**
* 排序规则
*/
CollateRule: string;
/**
* 授权用户主机权限
*/
UserHostPrivileges?: Array;
/**
* 备注
*/
Description?: string;
}
/**
* OfflineInstance请求参数结构体
*/
export interface OfflineInstanceRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID数组
*/
InstanceIdList: Array;
}
/**
* 审计日志详细信息
*/
export interface AuditLog {
/**
* 影响行数。
*/
AffectRows?: number;
/**
* 错误码。
*/
ErrCode?: number;
/**
* SQL类型。
*/
SqlType?: string;
/**
* 表名称。
*/
TableName?: string;
/**
* 实例名称。
*/
InstanceName?: string;
/**
* 审计策略名称。
*/
PolicyName?: string;
/**
* 数据库名称。
*/
DBName?: string;
/**
* SQL语句。
*/
Sql?: string;
/**
* 客户端地址。
*/
Host?: string;
/**
* 用户名。
*/
User?: string;
/**
* 执行时间,微秒。
*/
ExecTime?: number;
/**
* 时间。
*/
Timestamp?: string;
/**
* 返回行数。
*/
SentRows?: number;
/**
* 执行线程ID。
*/
ThreadId?: number;
/**
* 扫描行数。
*/
CheckRows?: number;
/**
* cpu执行时间,微秒。
*/
CpuTime?: number;
/**
* IO等待时间,微秒。
*/
IoWaitTime?: number;
/**
* 锁等待时间,微秒。
*/
LockWaitTime?: number;
/**
* 事务持续等待时间,微秒。
*/
TrxLivingTime?: number;
/**
* 开始时间,与timestamp构成一个精确到纳秒的时间。
*/
NsTime?: number;
/**
* 日志命中规则模板的基本信息
*/
TemplateInfo?: Array;
/**
* 事务ID
*/
TrxId?: number;
/**
* 客户端端口
*/
ClientPort?: number;
}
/**
* CreateProxy返回参数结构体
*/
export interface CreateProxyResponse {
/**
* 异步流程ID
*/
FlowId?: number;
/**
* 异步任务ID
*/
TaskId?: number;
/**
* 数据库代理组ID
*/
ProxyGroupId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 修改参数任务数据
*/
export interface BizTaskModifyParamsData {
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群参数修改数据
*/
ClusterParamList?: Array;
/**
* 实例参数修改数据
*/
ModifyInstanceParams?: Array;
}
/**
* 实例初始化配置信息
*/
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;
/**
* 实例机器类型
- common,通用型。
- exclusive,独享型。
*/
DeviceType?: string;
}
/**
* DescribeAuditLogFiles请求参数结构体
*/
export interface DescribeAuditLogFilesRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 分页大小参数。默认值为 20,最小值为 1,最大值为 100。
*/
Limit?: number;
/**
* 分页偏移量。
*/
Offset?: number;
/**
* 审计日志文件名。
*/
FileName?: string;
}
/**
* OpenClusterTransparentEncrypt返回参数结构体
*/
export interface OpenClusterTransparentEncryptResponse {
/**
* 异步任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyBackupConfig请求参数结构体
*/
export interface ModifyBackupConfigRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 表示全备开始时间,[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;
/**
* 表示保留备份时长, 单位秒,超过该时间将被清理, 七天表示为3600247=604800,最大为158112000
*/
ReserveDuration?: number;
/**
* 该参数目前不支持修改,无需填写。备份频率,长度为7的数组,分别对应周一到周日的备份方式,full-全量备份,increment-增量备份
*/
BackupFreq?: Array;
/**
* 该参数目前不支持修改,无需填写。
*/
BackupType?: string;
/**
* 逻辑备份配置
*/
LogicBackupConfig?: LogicBackupConfigInfo;
/**
* 是否删除自动逻辑备份
*/
DeleteAutoLogicBackup?: boolean;
/**
* 二级快照备份参数
*/
SnapshotSecondaryBackupConfig?: SnapshotBackupConfig;
/**
* 稀疏备份配置
*/
SparseBackupConfig?: SparseBackupConfig;
}
/**
* DisassociateSecurityGroups返回参数结构体
*/
export interface DisassociateSecurityGroupsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterDatabases请求参数结构体
*/
export interface DescribeClusterDatabasesRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 分页偏移
*/
Offset?: number;
/**
* 分页限制数量
*/
Limit?: number;
}
/**
* OfflineLibraDBInstance返回参数结构体
*/
export interface OfflineLibraDBInstanceResponse {
/**
* 任务流id
注意:此字段可能返回 null,表示取不到有效值。
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RenewLibraDBClusters返回参数结构体
*/
export interface RenewLibraDBClustersResponse {
/**
* 预付费总订单号
*/
BigDealIds?: Array;
/**
* 冻结流水
*/
TranId?: string;
/**
* 订单名称
*/
DealNames?: Array;
/**
* 资源id
*/
ResourceIds?: Array;
/**
* 集群id
*/
ClusterIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 保险箱信息
*/
export interface VaultInfo {
/**
* 保险箱id
*/
VaultId?: string;
/**
* 保险箱name
*/
VaultName?: string;
/**
* 保险箱地域
*/
VaultRegion?: string;
/**
* 保险箱状态
*/
VaultStatus?: string;
/**
* 备份保留时间
*/
BackupSaveSeconds?: number;
}
/**
* RemoveClusterSlaveZone请求参数结构体
*/
export interface RemoveClusterSlaveZoneRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 从可用区
*/
SlaveZone: string;
}
/**
* ModifyResourcePackagesDeductionPriority请求参数结构体
*/
export interface ModifyResourcePackagesDeductionPriorityRequest {
/**
* 需要修改优先级的资源包类型,CCU:计算资源包,DISK:存储资源包
*/
PackageType: string;
/**
* 修改后的抵扣优先级对于哪个cynos资源生效
*/
ClusterId: string;
/**
* 资源包抵扣优先级
*/
DeductionPriorities: Array;
}
/**
* OfflineLibraDBInstance请求参数结构体
*/
export interface OfflineLibraDBInstanceRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 只读分析引擎实例 ID 列表
*/
InstanceIdList: Array;
}
/**
* DescribeRollbackTimeRange请求参数结构体
*/
export interface DescribeRollbackTimeRangeRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 保险箱id
*/
VaultId?: string;
/**
* 保险箱地域
*/
VaultRegion?: 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;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLibraDBClusterAccounts请求参数结构体
*/
export interface DescribeLibraDBClusterAccountsRequest {
/**
* 分析集群id
*/
ClusterId: string;
/**
* 账号名
*/
AccountNames?: Array;
/**
* 模糊匹配关键字
*/
AccountRegular?: string;
/**
* 主机名
*/
Hosts?: Array;
/**
* 限制
*/
Limit?: number;
/**
* 偏移
*/
Offset?: number;
}
/**
* 数据库代理,读写分离实例权重
*/
export interface ProxyInstanceWeight {
/**
* 实例Id
*/
InstanceId: string;
/**
* 实例权重
*/
Weight: number;
}
/**
* CreateResourcePackage请求参数结构体
*/
export interface CreateResourcePackageRequest {
/**
* 实例类型,目前固定传cynosdb-serverless
*/
InstanceType: string;
/**
* 资源包使用地域chineseMainland-中国内地通用,overseas-港澳台及海外通用
*/
PackageRegion: string;
/**
* 资源包类型:CCU-计算资源包,DISK-存储资源包
*/
PackageType: string;
/**
* 资源包版本
base-基础版本,common-通用版本,enterprise-企业版本
*/
PackageVersion: string;
/**
* 资源包大小,计算资源单位:个;存储资源:GB
*/
PackageSpec: number;
/**
* 资源包有效期,单位:天
*/
ExpireDay: number;
/**
* 购买资源包个数
*/
PackageCount: number;
/**
* 资源包名称
*/
PackageName?: string;
}
/**
* CloseProxyEndPoint返回参数结构体
*/
export interface CloseProxyEndPointResponse {
/**
* 异步流程ID
*/
FlowId?: number;
/**
* 异步任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBackupConfig请求参数结构体
*/
export interface DescribeBackupConfigRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* 交换实例信息
*/
export interface ExchangeInstanceInfo {
/**
* 源实例信息
*/
SrcInstanceInfo?: RollbackInstanceInfo;
/**
* 目标实例信息
*/
DstInstanceInfo?: RollbackInstanceInfo;
}
/**
* DescribeAccounts请求参数结构体
*/
export interface DescribeAccountsRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 需要过滤的账户列表
*/
AccountNames?: Array;
/**
* 数据库类型,取值范围:
MYSQL
该参数已废用
*/
DbType?: string;
/**
* 需要过滤的账户列表
*/
Hosts?: Array;
/**
* 限制量
*/
Limit?: number;
/**
* 偏移量
*/
Offset?: number;
/**
* 模糊匹配关键字(同时匹配AccountName和AccountHost,返回并集结果,支持正则)
*/
AccountRegular?: string;
}
/**
* DescribeVaultBackupClusterInfo请求参数结构体
*/
export interface DescribeVaultBackupClusterInfoRequest {
/**
* 备份保险箱ID
*/
VaultId: string;
}
/**
* DescribeRollbackTimeRange返回参数结构体
*/
export interface DescribeRollbackTimeRangeResponse {
/**
* 有效回归时间范围开始时间点(已废弃)
*/
TimeRangeStart?: string;
/**
* 有效回归时间范围结束时间点(已废弃)
*/
TimeRangeEnd?: string;
/**
* 可回档时间范围
*/
RollbackTimeRanges?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* binlog备份信息
*/
export interface DescribeBinlogListByVaultItem {
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* Binlog文件信息
*/
BinlogFileInfo?: BinlogItem;
}
/**
* 各地域binlog保留信息
*/
export interface BinlogRegionInfo {
/**
* 备份地域
*/
BackupRegion?: string;
/**
* 备份ID
*/
BackupId?: number;
}
/**
* DescribeClusterServerlessScalePlans请求参数结构体
*/
export interface DescribeClusterServerlessScalePlansRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例列表
*/
InstanceIds?: Array;
/**
* 策略类型. PolicyTypePeriodScale - 周期弹性
*/
PolicyType?: string;
/**
* 计划ID
*/
PlanId?: number;
/**
* 分页数量限制,默认10
*/
Limit?: number;
/**
* 查询偏移,默认0
*/
Offset?: number;
/**
* 按计划预期执行时间为条件查询的开始时间点,包含当前时间
*/
ExpectedStartTime?: string;
/**
* 按计划预期执行时间为条件查询的结束时间点,包含当前时间
*/
ExpectedEndTime?: string;
}
/**
* DescribeAuditLogFiles返回参数结构体
*/
export interface DescribeAuditLogFilesResponse {
/**
* 符合条件的审计日志文件个数。
*/
TotalCount?: number;
/**
* 审计日志文件详情。
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SwitchClusterZone返回参数结构体
*/
export interface SwitchClusterZoneResponse {
/**
* 任务id
*/
TaskId?: number;
/**
* 异步FlowId
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据库代理连接池信息
*/
export interface ProxyConnectionPoolInfo {
/**
* 连接池保持阈值:单位(秒)
*/
ConnectionPoolTimeOut: number;
/**
* 是否开启了连接池
*/
OpenConnectionPool?: string;
/**
* 连接池类型:SessionConnectionPool(会话级别连接池)
*/
ConnectionPoolType?: string;
}
/**
* DescribeClusterPasswordComplexity请求参数结构体
*/
export interface DescribeClusterPasswordComplexityRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* 查询过滤器。用于 DescribeClusterAndInstances 接口的过滤条件。
*/
export interface QueryFilter {
/**
* 字段值列表,与 Names 一一对应。InstanceId/ClusterId 为精确匹配,InstanceName 默认模糊匹配
*/
Values: Array;
/**
* 搜索字段名称列表,仅支持以下 3 个字段(不区分大小写,多个值为 OR 关系):ClusterId(按集群 ID 过滤,精确匹配)、InstanceId(按实例 ID 反查所属集群)、InstanceName(按实例名称反查所属集群,默认 LIKE 模糊匹配,ExactMatch=true 时精确匹配)。InstanceId 与 InstanceName 同时传入时取交集(AND 语义)。
*/
Names?: Array;
/**
* 是否精确匹配。仅对 InstanceName 生效:true 精确匹配,false(默认)LIKE 模糊匹配。
*/
ExactMatch?: boolean;
/**
* 搜索字段名称(单个字段模式,与 Names 二选一)。支持:ClusterId、InstanceId、InstanceName
*/
Name?: string;
/**
* 操作符(预留字段,当前未启用)。可选值:>、>=、!=、=、<、<=
* @deprecated
*/
Operator?: string;
}
/**
* CreateAccounts返回参数结构体
*/
export interface CreateAccountsResponse {
/**
* 任务 ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClusterGlobalEncryption返回参数结构体
*/
export interface ModifyClusterGlobalEncryptionResponse {
/**
* 异步任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CheckTransferClusterZone请求参数结构体
*/
export interface CheckTransferClusterZoneRequest {
/**
* 源集群Id
*/
ClusterId: string;
/**
* 目标可用区
*/
DstZone: string;
/**
* proxy迁移的目标可用区信息
*/
ProxyZones?: Array;
}
/**
* CloseWan返回参数结构体
*/
export interface CloseWanResponse {
/**
* 任务流ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyProxyRwSplit返回参数结构体
*/
export interface ModifyProxyRwSplitResponse {
/**
* 异步FlowId
*/
FlowId?: number;
/**
* 异步任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstances返回参数结构体
*/
export interface DescribeInstancesResponse {
/**
* 实例个数
*/
TotalCount?: number;
/**
* 实例列表
*/
InstanceSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 资源包明细说明
*/
export interface SalePackageSpec {
/**
* 资源包使用地域
*/
PackageRegion?: string;
/**
* 资源包类型
CCU-计算资源包
DISK-存储资源包
*/
PackageType?: string;
/**
* 资源包版本
base-基础版本,common-通用版本,enterprise-企业版本
*/
PackageVersion?: string;
/**
* 当前版本资源包最小资源数,计算资源单位:个;存储资源:GB
*/
MinPackageSpec?: number;
/**
* 当前版本资源包最大资源数,计算资源单位:个;存储资源:GB
*/
MaxPackageSpec?: number;
/**
* 资源包有效期,单位:天
*/
ExpireDay?: number;
}
/**
* 数据库账号信息
*/
export interface Account {
/**
* 数据库账号名
*/
AccountName?: string;
/**
* 主机
*/
Host?: string;
/**
* 数据库账号描述
*/
Description?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 用户最大连接数
*/
MaxUserConnections?: number;
/**
* 是否开启密码轮转(0:关闭;1:开启)
*/
PasswordRotation?: number;
}
/**
* ModifyResourcePackagesDeductionPriority返回参数结构体
*/
export interface ModifyResourcePackagesDeductionPriorityResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CloseWan请求参数结构体
*/
export interface CloseWanRequest {
/**
* 实例组id
* @deprecated
*/
InstanceGrpId?: string;
/**
* 实例组id
*/
InstanceGroupId?: string;
/**
* 实例id
*/
InstanceId?: string;
}
/**
* 审计日志过滤条件。查询审计日志时,用户过滤返回的审计日志。
*/
export interface AuditLogFilter {
/**
* 客户端地址。
*/
Host?: Array;
/**
* 用户名。
*/
User?: Array;
/**
* 数据库名称。
*/
DBName?: Array;
/**
* 表名称。
*/
TableName?: Array;
/**
* 审计策略名称。
*/
PolicyName?: Array;
/**
* 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;
/**
* SQL 语句。支持传递多个sql语句。
*/
Sqls?: Array;
/**
* 返回行数。
*/
SentRows?: number;
/**
* 线程ID。
*/
ThreadId?: Array;
}
/**
* 表映射关系
*/
export interface TableMappingObject {
/**
* 源端实例Id
*/
SrcInstanceId?: string;
/**
* 数据库名称
*/
DatabaseName?: string;
/**
* 表名
*/
TableName?: string;
/**
* 映射数据库名称
*/
MapDatabaseName?: string;
/**
* 映射表名
*/
MapTableName?: string;
/**
* 同步状态
*/
Status?: string;
/**
* 同步进度
*/
Process?: number;
/**
* 延迟
*/
Lag?: number;
/**
* 消息
*/
Message?: string;
/**
* 是否为主表
*/
IsPrimary?: boolean;
/**
* 虚拟列填充值
*/
VirtualColValue?: string;
}
/**
* 商品价格
*/
export interface GoodsPrice {
/**
* 实例价格
注意:此字段可能返回 null,表示取不到有效值。
*/
InstancePrice: TradePrice;
/**
* 存储价格
注意:此字段可能返回 null,表示取不到有效值。
*/
StoragePrice: TradePrice;
/**
* 商品规格
注意:此字段可能返回 null,表示取不到有效值。
*/
GoodsSpec: GoodsSpec;
}
/**
* ModifyResourcePackageClusters请求参数结构体
*/
export interface ModifyResourcePackageClustersRequest {
/**
* 资源包唯一ID
*/
PackageId: string;
/**
* 需要建立绑定关系的集群ID
*/
BindClusterIds?: Array;
/**
* 需要解除绑定关系的集群ID
*/
UnbindClusterIds?: Array;
}
/**
* 审计规则的规则过滤条件
*/
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;
}
/**
* DescribeFlow返回参数结构体
*/
export interface DescribeFlowResponse {
/**
* 任务流状态。0-成功,1-失败,2-处理中
*/
Status?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CalculateBackupSaveSecExpires请求参数结构体
*/
export interface CalculateBackupSaveSecExpiresRequest {
/**
* 备份保险箱ID
*/
VaultId: string;
/**
* 备份保留时长(秒),必须大于0
*/
BackupSaveSeconds?: number;
/**
* 每页数量,范围(0,100],默认10
*/
Limit?: number;
/**
* 偏移量,范围[0,INF),默认0
*/
Offset?: number;
/**
* 排序字段,可选值:VaultId,VaultName,BackupSaveSeconds,LockedTime,CreateTime,UpdateTime,默认endTime
*/
OrderBy?: string;
/**
* 排序方式,可选值:desc,asc,DESC,ASC,默认desc
*/
OrderByType?: string;
}
/**
* ExportInstanceErrorLogs请求参数结构体
*/
export interface ExportInstanceErrorLogsRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 日志最早时间
*/
StartTime?: string;
/**
* 日志最晚时间
*/
EndTime?: string;
/**
* 限制条数
*/
Limit?: number;
/**
* 偏移量
*/
Offset?: number;
/**
* 日志等级
*/
LogLevels?: Array;
/**
* 关键字
*/
KeyWords?: Array;
/**
* 文件类型,可选值:csv, original
*/
FileType?: string;
/**
* 可选值Timestamp
*/
OrderBy?: string;
/**
* 排序类型,ASC 或 DESC。
*/
OrderByType?: string;
}
/**
* 执行计划列表
*/
export interface ExplainRow {
/**
* 查询的序列号
*/
Id?: number;
/**
* 查询的类型,常见值:SIMPLE(简单查询,不含子查询或 UNION)、PRIMARY(最外层查询)、SUBQUERY(子查询中的第一个 SELECT)、DERIVED(派生表/FROM 子句中的子查询)、UNION(UNION 中第二个及之后的 SELECT)、UNION RESULT(UNION 的结果集)。
*/
SelectType?: string;
/**
* 数据表名
*/
Table?: string;
/**
* 查询匹配的分区
*/
Partitions?: string;
/**
* 访问类型(非常重要,衡量查询效率的关键指标),从优到差排列:system > const > eq_ref > ref > fulltext > ref_or_null > index_merge > unique_subquery > index_subquery > range > index > ALL。常见值说明: • system:表只有一行记录(系统表) • const:通过主键或唯一索引匹配一行,常见于 WHERE pk = 1 • eq_ref:连接时使用主键或唯一索引,每个索引值只匹配一行 • ref:使用非唯一索引查找,可能匹配多行 • range:索引范围扫描,如 BETWEEN、>、<、IN • index:全索引扫描(遍历整棵索引树) • ALL:全表扫描(最差,需优化)
*/
Type?: string;
/**
* 查询中可能使用到的索引。为 NULL 表示没有可用索引。
*/
PossibleKeys?: string;
/**
* 实际使用的索引。为 NULL 表示未使用任何索引。
*/
Key?: string;
/**
* 实际使用的索引长度(字节数)。可用来判断联合索引中实际使用了哪几个列。值越短说明使用的索引列越少。
*/
KeyLen?: string;
/**
* 显示哪些列或常量与 key 列中的索引进行比较。常见值:const(常量)、某个列名、func(函数结果)。
*/
Ref?: string;
/**
* 预估要扫描的行数
*/
Rows?: number;
/**
* 表示经过表条件过滤后,剩余行数占 rows 的百分比估算。100% 表示没有额外过滤,值越高越好。
*/
Filtered?: number;
/**
* 附加信息(非常重要),常见值: • Using index:覆盖索引,无需回表(好) • Using where:在存储引擎返回行后再用 WHERE 过滤 • Using temporary:使用了临时表(常见于 GROUP BY/ORDER BY,需优化) • Using filesort:使用了文件排序而非索引排序(需优化) • Using index condition:使用了索引下推(ICP)
*/
Extra?: string;
}
/**
* DescribeLibraDBDataSource请求参数结构体
*/
export interface DescribeLibraDBDataSourceRequest {
/**
* 分析集群ID
*/
ClusterId: string;
/**
* 只读分析引擎实例ID
*/
InstanceId: string;
}
/**
* ActivateInstance请求参数结构体
*/
export interface ActivateInstanceRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例 ID 列表,单个实例 ID 格式如:cynosdbmysql-ins-n7ocdslw,与TDSQL-C MySQL数据库控制台页面中显示的实例 ID 相同,可使用 查询实例列表 接口获取,其值为输出参数中字段 InstanceId 的值。
*/
InstanceIdList: Array;
}
/**
* 执行计划详情
*/
export interface ExecutionPlanDetail {
/**
* 模板ID
*/
TemplateID?: string;
/**
* 数据库名
*/
Db?: string;
/**
* 原始SQL样例
*/
SQLSample?: string;
/**
* 改写后SQL样例
*/
SQLSampleRewritten?: string;
/**
* 优化前执行计划- 列表
*/
TablePlanBefore?: Array;
/**
* 优化后执行计划 - 列表
*/
TablePlanAfter?: Array;
/**
* 优化前树形执行计划
*/
TreePlanBefore?: string;
/**
* 优化后树形执行计划
*/
TreePlanAfter?: string;
/**
* 优化前查询时间
*/
QueryTimeBefore?: number;
/**
* 优化后查询时间
*/
QueryTimeAfter?: number;
/**
* 优化前扫描行数
*/
SQLScanRowsBefore?: number;
/**
* 优化后扫描行数
*/
SQLScanRowsAfter?: number;
}
/**
* DescribeLibraDBClusterTableMapping返回参数结构体
*/
export interface DescribeLibraDBClusterTableMappingResponse {
/**
* 总记录数
*/
TotalCnt?: number;
/**
* 数据库映射信息
*/
TableMappings?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLibraDBForwardConfig请求参数结构体
*/
export interface DescribeLibraDBForwardConfigRequest {
/**
* 只读分析引擎实例id
*/
InstanceId: string;
}
/**
* 实例错误日志返回类型
*/
export interface CynosdbErrorLogItem {
/**
* 日志时间戳
*/
Timestamp?: number;
/**
* 日志等级
*/
Level?: string;
/**
* 日志内容
*/
Content?: string;
}
/**
* ModifyVipVport请求参数结构体
*/
export interface ModifyVipVportRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 实例组id
* @deprecated
*/
InstanceGrpId?: string;
/**
* 实例组id
*/
InstanceGroupId?: string;
/**
* 需要修改的目的ip
*/
Vip?: string;
/**
* 需要修改的目的端口
*/
Vport?: number;
/**
* 数据库类型,取值范围:
MYSQL
*/
DbType?: string;
/**
* 旧ip回收前的保留时间,单位小时,0表示立即回收
*/
OldIpReserveHours?: number;
}
/**
* 实例允许的操作列表
*/
export interface InstanceAbility {
/**
* 实例是否支持强制重启,可选值:yes:支持,no:不支持
*/
IsSupportForceRestart?: string;
/**
* 不支持强制重启的原因
*/
NonsupportForceRestartReason?: string;
}
/**
* ModifyDBInstanceSecurityGroups返回参数结构体
*/
export interface ModifyDBInstanceSecurityGroupsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterParamLogs返回参数结构体
*/
export interface DescribeClusterParamLogsResponse {
/**
* 记录总数
*/
TotalCount?: number;
/**
* 参数修改记录
*/
ClusterParamLogs?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterInstanceGrps请求参数结构体
*/
export interface DescribeClusterInstanceGrpsRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* DescribeResourcesByDealName返回参数结构体
*/
export interface DescribeResourcesByDealNameResponse {
/**
* 计费资源id信息数组
*/
BillingResourceInfos?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAccounts请求参数结构体
*/
export interface CreateAccountsRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 新账户列表
*/
Accounts: Array;
}
/**
* DeleteAuditRuleTemplates请求参数结构体
*/
export interface DeleteAuditRuleTemplatesRequest {
/**
* 审计规则模板ID。
*/
RuleTemplateIds: Array;
}
/**
* ExportInstanceSlowQueries返回参数结构体
*/
export interface ExportInstanceSlowQueriesResponse {
/**
* 慢查询导出内容
*/
FileContent?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SwitchClusterZone请求参数结构体
*/
export interface SwitchClusterZoneRequest {
/**
* 集群Id
*/
ClusterId: string;
/**
* 当前可用区
*/
OldZone: string;
/**
* 要切换到的可用区
*/
NewZone: string;
/**
* 维护期间执行-yes,立即执行-no
*/
IsInMaintainPeriod?: string;
}
/**
* DescribeLibraDBClusterAutoMapRule返回参数结构体
*/
export interface DescribeLibraDBClusterAutoMapRuleResponse {
/**
* 高级映射规则
*/
AutoMapRules?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群支持的功能
*/
export interface Ability {
/**
* 是否支持从可用区
*/
IsSupportSlaveZone: string;
/**
* 不支持从可用区的原因
*/
NonsupportSlaveZoneReason: string;
/**
* 是否支持RO实例
*/
IsSupportRo: string;
/**
* 不支持RO实例的原因
*/
NonsupportRoReason: string;
/**
* 是否支持手动发起快照备份
*/
IsSupportManualSnapshot: string;
/**
* 是否支持透明数据加密
*/
IsSupportTransparentDataEncryption?: string;
/**
* 不支持透明数据加密原因
*/
NoSupportTransparentDataEncryptionReason?: string;
/**
* 是否支持手动发起逻辑备份
*/
IsSupportManualLogic?: string;
/**
* 是否支持开启全局加密
*/
IsSupportGlobalEncryption?: string;
/**
* 不支持全局加密的原因
*/
NoSupportGlobalEncryptionReason?: string;
/**
* 不支持透明加密原因状态码
*/
NoSupportTransparentDataEncryptionReasonCode?: string;
/**
* 不支持全局加密原因状态码
*/
NoSupportGlobalEncryptionReasonCode?: string;
}
/**
* 全球数据库任务信息
*/
export interface GdnTaskInfo {
/**
* 全球数据库唯一标识
*/
GdnId?: string;
/**
* 全球数据库唯一别名
*/
GdnName?: string;
/**
* 主集群ID
*/
PrimaryClusterId?: string;
/**
* 主集群所在地域
*/
PrimaryClusterRegion?: string;
/**
* 从集群所在地域
*/
StandbyClusterRegion?: string;
/**
* 从集群ID
*/
StandbyClusterId?: string;
/**
* 从集群名称
*/
StandbyClusterName?: string;
/**
* 是否已强切
*/
ForceSwitchGdn?: string;
/**
* 返回码
*/
Code?: number;
/**
* 提示信息
*/
Message?: string;
/**
* 是否支持强切
*/
IsSupportForce?: string;
}
/**
* InquirePriceModify请求参数结构体
*/
export interface InquirePriceModifyRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* CPU核数
*/
Cpu?: number;
/**
* 内存大小
*/
Memory?: number;
/**
* 存储大小,存储资源变配:ClusterId,StorageLimit
*/
StorageLimit?: number;
/**
* 实例ID,计算资源变配必传: ClusterId,InstanceId,Cpu,Memory
*/
InstanceId?: string;
/**
* 实例设备类型
*/
DeviceType?: string;
/**
* serverless实例ccu大小
*/
Ccu?: number;
}
/**
* 任务信息
*/
export interface BizTaskInfo {
/**
* 任务id
*/
ID?: number;
/**
* 用户appid
*/
AppId?: number;
/**
* 集群id
*/
ClusterId?: string;
/**
* 地域
*/
Region?: string;
/**
* 任务创建时间
*/
CreateTime?: string;
/**
* 延迟执行时间
*/
DelayTime?: string;
/**
* 任务失败信息
*/
ErrMsg?: string;
/**
* 异步任务流id
*/
FlowId?: number;
/**
* 任务输入信息
*/
Input?: string;
/**
* 实例组id
* @deprecated
*/
InstanceGrpId?: string;
/**
* 实例组id
*/
InstanceGroupId?: string;
/**
* 实例id
*/
InstanceId?: string;
/**
* 任务操作对象id
*/
ObjectId?: string;
/**
* 任务操作对象类型
*/
ObjectType?: string;
/**
* 操作者uin
*/
Operator?: string;
/**
* 任务输出信息
*/
Output?: string;
/**
* 任务状态
*/
Status?: string;
/**
* 任务类型
*/
TaskType?: string;
/**
* 触发本任务的父任务ID
*/
TriggerTaskId?: number;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 任务开始时间
*/
StartTime?: string;
/**
* 任务结束时间
*/
EndTime?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* 实例名称
*/
InstanceName?: string;
/**
* 任务进度
*/
Process?: number;
/**
* 修改参数任务信息
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
ModifyParamsData?: Array;
/**
* 创建集群任务信息
*/
CreateClustersData?: CreateClustersData;
/**
* 集群回档任务信息
*/
RollbackData?: RollbackData;
/**
* 实例变配任务信息
*/
ModifyInstanceData?: ModifyInstanceData;
/**
* 手动备份任务信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ManualBackupData?: ManualBackupData;
/**
* 修改内核版本任务信息
*/
ModifyDbVersionData?: ModifyDbVersionData;
/**
* 集群可用区信息
*/
ClusterSlaveData?: ClusterSlaveData;
/**
* 转换集群日志
注意:此字段可能返回 null,表示取不到有效值。
*/
SwitchClusterLogBin?: SwitchClusterLogBin;
/**
* 修改实例参数数据
注意:此字段可能返回 null,表示取不到有效值。
*/
ModifyInstanceParamsData?: BizTaskModifyParamsData;
/**
* 维护时间
*/
TaskMaintainInfo?: TaskMaintainInfo;
/**
* 实例日志投递信息
*/
InstanceCLSDeliveryInfos?: Array;
/**
* 任务进度信息
*/
TaskProgressInfo?: TaskProgressInfo;
/**
* 全球数据库网络任务
*/
GdnTaskInfo?: GdnTaskInfo;
/**
* 保险箱id
*/
VaultId?: string;
/**
* 保险箱名称
*/
VaultName?: string;
/**
* AI优化器任务信息
*/
AIOptimizerTaskData?: AIOptimizerTaskData;
}
/**
* RemoveClusterSlaveZone返回参数结构体
*/
export interface RemoveClusterSlaveZoneResponse {
/**
* 异步FlowId
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RenewClusters请求参数结构体
*/
export interface RenewClustersRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 续费时长
*/
TimeSpan: number;
/**
* 时间单位 y,m,d,h,i,s
*/
TimeUnit: string;
/**
* 交易模式 0-下单并支付 1-下单
*/
DealMode?: number;
}
/**
* OpenClusterReadOnlyInstanceGroupAccess返回参数结构体
*/
export interface OpenClusterReadOnlyInstanceGroupAccessResponse {
/**
* 开启流程ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AI 优化器状态
*/
export interface AIOptimizerStatus {
/**
* 状态。closing-关闭中,closed-关闭,opening-开启中,training-训练中,trained-训练完成,train_failed-训练失败。
*/
Status?: string;
/**
* 开启时间
*/
OpenTime?: string;
/**
* 训练进度
*/
TrainingProgress?: number;
}
/**
* 查询参数过滤器
*/
export interface QueryParamFilter {
/**
* 搜索字段,目前支持:ProxyGroupId
*/
Names: Array;
/**
* 搜索字符串
*/
Values: Array;
/**
* 是否精确匹配
*/
ExactMatch?: boolean;
}
/**
* 新建账号
*/
export interface NewAccount {
/**
* 账户名,包含字母数字_,以字母开头,字母或数字结尾,长度1-30
*/
AccountName: string;
/**
* 主机(%或ipv4地址)
*/
Host: string;
/**
* 密码,密码长度范围为8到64个字符
*/
AccountPassword: string;
/**
* 是否开启密码轮转(0:关闭;1:开启)
*/
PasswordRotation?: number;
/**
* 描述
*/
Description?: string;
/**
* 用户最大连接数,不能大于10240
*/
MaxUserConnections?: number;
}
/**
* 修改参数信息
*/
export interface ModifyParamsData {
/**
* 参数名
*/
Name?: string;
/**
* 修改前参数值
*/
OldValue?: string;
/**
* 修改后参数值
*/
CurValue?: string;
}
/**
* CreateVault返回参数结构体
*/
export interface CreateVaultResponse {
/**
* 任务ID,用于查询任务执行状态
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 资源包绑定的实例信息
*/
export interface BindInstanceInfo {
/**
* 绑定的集群ID
*/
InstanceId?: string;
/**
* 绑定的实例所在的地域
*/
InstanceRegion?: string;
/**
* 绑定的实例类型
*/
InstanceType?: string;
/**
* 绑定集群下的实例ID
*/
ExtendIds?: Array;
}
/**
* DescribeAuditRuleWithInstanceIds返回参数结构体
*/
export interface DescribeAuditRuleWithInstanceIdsResponse {
/**
* 无
*/
TotalCount?: number;
/**
* 实例审计规则信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SetLibraDBClusterRenewFlag返回参数结构体
*/
export interface SetLibraDBClusterRenewFlagResponse {
/**
* 数量
*/
Count?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SearchClusterDatabases请求参数结构体
*/
export interface SearchClusterDatabasesRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 数据库名
*/
Database?: string;
/**
* 是否精确搜索。
0: 模糊搜索 1:精确搜索
默认为0
*/
MatchType?: number;
}
/**
* ModifyProxyDesc返回参数结构体
*/
export interface ModifyProxyDescResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 分析引擎同步对象
*/
export interface ReplicationObject {
/**
* 源端实例类型
注意:此字段可能返回 null,表示取不到有效值。
*/
SrcInstanceType: string;
/**
* 源端集群Id
注意:此字段可能返回 null,表示取不到有效值。
*/
SrcClusterId?: string;
/**
* 源端实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
SrcInstanceId?: string;
/**
* 复制任务ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ReplicationJobId?: string;
/**
* 同步对象详情
注意:此字段可能返回 null,表示取不到有效值。
*/
MigrateObjects?: MigrateOpt;
}
/**
* CreateIntegrateCluster返回参数结构体
*/
export interface CreateIntegrateClusterResponse {
/**
* 冻结流水ID
*/
TranId?: string;
/**
* 订单号
*/
DealNames?: Array;
/**
* 资源ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取资源ID)
*/
ResourceIds?: Array;
/**
* 集群ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取集群ID)
*/
ClusterIds?: Array;
/**
* 大订单号
注意:此字段可能返回 null,表示取不到有效值。
*/
BigDealIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据库表
*/
export interface DbTable {
/**
* 数据库名称
*/
Db: string;
/**
* 数据库表名称
*/
TableName?: string;
}
/**
* ModifyClusterSlaveZone返回参数结构体
*/
export interface ModifyClusterSlaveZoneResponse {
/**
* 异步FlowId
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RollbackToNewCluster请求参数结构体
*/
export interface RollbackToNewClusterRequest {
/**
* 可用区
*/
Zone: string;
/**
* 回档时,传入源集群ID,用于查找源poolId
*/
OriginalClusterId: string;
/**
* 所属VPC网络ID
*/
UniqVpcId?: string;
/**
* 所属子网ID
*/
UniqSubnetId?: string;
/**
* 集群名称,长度小于64个字符,每个字符取值范围:大/小写字母,数字,特殊符号('-','_','.')
*/
ClusterName?: string;
/**
* 快照回档,表示snapshotId;时间点回档,表示queryId,为0,表示需要判断时间点是否有效
*/
RollbackId?: number;
/**
* 时间点回档,指定时间;快照回档,快照时间
*/
ExpectTime?: string;
/**
* 是否自动选择代金券 1是 0否 默认为0
*/
AutoVoucher?: number;
/**
* 集群创建需要绑定的tag数组信息
*/
ResourceTags?: Array;
/**
* Db类型
当DbType为MYSQL时可选(默认NORMAL):
NORMALSERVERLESS
*/
DbMode?: string;
/**
* 当DbMode为SEVERLESS时必填
cpu最小值,可选范围参考DescribeServerlessInstanceSpecs接口返回
*/
MinCpu?: number;
/**
* 当DbMode为SEVERLESS时必填:
cpu最大值,可选范围参考DescribeServerlessInstanceSpecs接口返回
*/
MaxCpu?: number;
/**
* 当DbMode为SEVERLESS时,指定集群是否自动暂停,可选范围
yesno默认值:yes
*/
AutoPause?: string;
/**
* 当DbMode为SEVERLESS时,指定集群自动暂停的延迟,单位秒,可选范围[600,691200]
默认值:600
*/
AutoPauseDelay?: number;
/**
* 安全组id数组
*/
SecurityGroupIds?: Array;
/**
* 告警策略Id数组
*/
AlarmPolicyIds?: Array;
/**
* 参数数组,暂时支持character_set_server (utf8|latin1|gbk|utf8mb4) ,lower_case_table_names,1-大小写不敏感,0-大小写敏感
*/
ClusterParams?: Array;
/**
* 参数模板ID,可以通过查询参数模板信息DescribeParamTemplates获得参数模板ID
*/
ParamTemplateId?: number;
/**
* 实例初始化配置信息,主要用于购买集群时选不同规格实例
*/
InstanceInitInfos?: Array;
/**
* 0-下单并支付 1-下单
*/
DealMode?: number;
/**
* 计算节点付费模式:0-按量计费,1-预付费
*/
PayMode?: number;
/**
* 时间
*/
TimeSpan?: number;
/**
* 单位
*/
TimeUnit?: string;
/**
* 回档库信息
*/
RollbackDatabases?: Array;
/**
* 回档表信息
*/
RollbackTables?: Array;
/**
* 原ro实例信息
*/
OriginalROInstanceList?: Array;
/**
* 项目id
*/
ProjectId?: number;
/**
* 是否开启归档,可选范围
yesno默认值:yes
*/
AutoArchive?: string;
/**
* 是否从保存备份中恢复
*/
FromSaveBackup?: boolean;
/**
* 同步方式。可选值:async、semisync、sync,默认异步。
*/
SyncWay?: string;
/**
* 半同步超时时间,单位ms。为保证业务稳定性,半同步复制存在退化逻辑,当主可用区集群在等待备可用区集群确认事务时若超过该超时时间,复制方式将降为异步复制。
取值范围:[1000, 4294967295]
单位:毫秒
默认值:10000
*/
SemiSyncTimeout?: number;
/**
* 备可用区
*/
SlaveZone?: string;
}
/**
* Binlog描述
*/
export interface BinlogItem {
/**
* Binlog文件名称
*/
FileName?: string;
/**
* 文件大小,单位:字节
*/
FileSize?: number;
/**
* 事务最早时间
*/
StartTime?: string;
/**
* 事务最晚时间
*/
FinishTime?: string;
/**
* Binlog文件ID
*/
BinlogId?: number;
/**
* binlog所跨地域
*/
CrossRegions?: Array;
/**
* 备份投递状态
*/
CopyStatus?: string;
/**
* 保险箱信息
*/
VaultInfos?: Array;
/**
* 加密秘钥key
*/
EncryptKeyId?: string;
/**
* 加密秘钥地域
*/
EncryptRegion?: string;
/**
* 备份的地域分布信息
*/
ExistRegions?: Array;
}
/**
* ModifyProxyDesc请求参数结构体
*/
export interface ModifyProxyDescRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 数据库代理组ID
*/
ProxyGroupId: string;
/**
* 数据库代理描述
*/
Description: string;
}
/**
* ReloadBalanceProxyNode返回参数结构体
*/
export interface ReloadBalanceProxyNodeResponse {
/**
* 异步流程ID
*/
FlowId?: number;
/**
* 异步任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateVault请求参数结构体
*/
export interface CreateVaultRequest {
/**
* 保险箱名称,长度必须大于0
*/
VaultName: string;
/**
* 备份保留时长(秒),必须大于0
*/
BackupSaveSeconds: number;
/**
* 保险箱描述
*/
VaultDescribe?: string;
/**
* KMS密钥ID,长度0-36字符
*/
KeyId?: string;
/**
* 密钥类型,可选值:cloud(云托管密钥)、custom(自定义密钥)
*/
KeyType?: string;
/**
* 密钥所在地域,长度0-32字符
*/
KeyRegion?: string;
/**
* 锁定时间,格式:YYYY-MM-DD HH:mm:ss
*/
LockedTime?: string;
}
/**
* CloseAuditService返回参数结构体
*/
export interface CloseAuditServiceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 稀疏备份周期信息
*/
export interface SparsePeriodTime {
/**
* 按周:星期几列表,1-7,1=周一,7=周日(仅 weekly 周期使用,最多7个)
*/
WeekDays?: Array;
/**
* 按月:日期列表,1-31(仅 monthly 周期使用,最多7个)
*/
Days?: Array;
/**
* 按年:月日组合列表(仅 yearly 周期使用,最多7个)
*/
MonthDays?: Array;
}
/**
* ModifyParamTemplate返回参数结构体
*/
export interface ModifyParamTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ActivateLibraDBCluster返回参数结构体
*/
export interface ActivateLibraDBClusterResponse {
/**
* flow id
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindClusterResourcePackages返回参数结构体
*/
export interface BindClusterResourcePackagesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 审计日志命中规则模板的基本信息
*/
export interface LogRuleTemplateInfo {
/**
* 模板ID
*/
RuleTemplateId?: string;
/**
* 规则模板名
*/
RuleTemplateName?: string;
/**
* 告警等级。1-低风险,2-中风险,3-高风险。
*/
AlarmLevel?: string;
/**
* 规则模板变更状态:0-未变更;1-已变更;2-已删除
*/
RuleTemplateStatus?: number;
}
/**
* StartCLSDelivery请求参数结构体
*/
export interface StartCLSDeliveryRequest {
/**
* 实例id
*/
InstanceId: string;
/**
* 开通的日志主题id
*/
CLSTopicIds: Array;
/**
* 日志类型
*/
LogType?: string;
/**
* 是否维护时间运行
*/
IsInMaintainPeriod?: string;
}
/**
* libra集群信息
*/
export interface LibraClusterSet {
/**
* 用户id
*/
AppId?: number;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 数据库版本
*/
DbVersion?: string;
/**
* 实例信息
*/
InstanceSet?: Array;
/**
* 付费模式
*/
PayMode?: number;
/**
* 到期时间
*/
PeriodEndTime?: string;
/**
* 项目id
*/
ProjectID?: number;
/**
* 地域
*/
Region?: string;
/**
* 自动续费标识,1为自动续费,0为到期不续
*/
RenewFlag?: number;
/**
* 状态
*/
Status?: string;
/**
* 状态描述
*/
StatusDesc?: string;
/**
* 存储大小
*/
Storage?: number;
/**
* 使用容量
*/
UsedStorage?: number;
/**
* vip地址
*/
Vip?: string;
/**
* vport端口
*/
Vport?: number;
}
/**
* CreateProxy请求参数结构体
*/
export interface CreateProxyRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* cpu核数
*/
Cpu: number;
/**
* 内存
*/
Mem: number;
/**
* 私有网络ID,默认与集群私有网络ID保持一致
*/
UniqueVpcId?: string;
/**
* 私有网络子网ID,默认与集群子网ID保持一致
*/
UniqueSubnetId?: string;
/**
* 数据库代理组节点个数(该参数不再建议使用,建议使用ProxyZones)
*/
ProxyCount?: number;
/**
* 连接池类型:SessionConnectionPool(会话级别连接池 )
*/
ConnectionPoolType?: string;
/**
* 是否开启连接池,yes-开启,no-不开启
*/
OpenConnectionPool?: string;
/**
* 连接池阈值:单位(秒)
*/
ConnectionPoolTimeOut?: number;
/**
* 安全组ID数组
*/
SecurityGroupIds?: Array;
/**
* 描述说明
*/
Description?: string;
/**
* 数据库节点信息(该参数与ProxyCount需要任选一个输入)
*/
ProxyZones?: Array;
}
/**
* DescribeBackupListByVaultItem
*/
export interface DescribeBackupListByVaultItem {
/**
* 集群id
*/
ClusterId?: string;
/**
* 集群name
*/
ClusterName?: string;
/**
* 备份信息
*/
BackupFileInfo?: BackupFileInfo;
}
/**
* DescribeResourcePackageSaleSpec返回参数结构体
*/
export interface DescribeResourcePackageSaleSpecResponse {
/**
* 可售卖资源包规格总数
*/
Total?: number;
/**
* 资源包明细说明
*/
Detail?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenClusterReadOnlyInstanceGroupAccess请求参数结构体
*/
export interface OpenClusterReadOnlyInstanceGroupAccessRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 端口
*/
Port: string;
/**
* 安全组ID
*/
SecurityGroupIds?: Array;
}
/**
* ModifyClusterPeriodScalePolicy请求参数结构体
*/
export interface ModifyClusterPeriodScalePolicyRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 策略ID
*/
PolicyId: string;
/**
* 当天开始弹性时间。格式是小时:分钟
*/
ScaleStartTime?: string;
/**
* 当天结束弹性时间。格式是小时:分钟
*/
ScaleEndTime?: string;
/**
* 策略生效的起始日期时间
*/
PolicyStartTime?: string;
/**
* 策略生效的截止日期时间
*/
PolicyEndTime?: string;
/**
* 周期类型。day-天,week-周,month-月。
*/
PeriodType?: string;
/**
* 周期内的时间列表。针对PeriodType=week, 表示星期几,比如[1,3]表示星期一、星期三。同理,对于PeriodType=month,[1,3,10]表示每月的1、3、10号。PeriodType=day则该字段无效。
*/
PeriodConfig?: Array;
/**
* 弹性规格下限
*/
MinCpu?: number;
/**
* 弹性规格上限
*/
MaxCpu?: number;
}
/**
* 模糊查询过滤器
*/
export interface QuerySimpleFilter {
/**
* 字段名称
*/
Names?: Array;
/**
* 字段值
*/
Values?: Array;
/**
* 模糊匹配,true-是,false否
*/
ExactMatch?: boolean;
}
/**
* DescribeResourcesByDealName请求参数结构体
*/
export interface DescribeResourcesByDealNameRequest {
/**
* 计费订单ID(如果计费还没回调业务发货,可能出现错误码InvalidParameterValue.DealNameNotFound,这种情况需要业务重试DescribeResourcesByDealName接口直到成功)。
DealName与DealNames至少应输入一项,两者都传时以DealName为准。
*/
DealName?: string;
/**
* 计费订单ID列表,可以一次查询若干条订单ID对应资源信息(如果计费还没回调业务发货,可能出现错误码InvalidParameterValue.DealNameNotFound,这种情况需要业务重试DescribeResourcesByDealName接口直到成功)。
DealName与DealNames至少应输入一项,两者都传时以DealName为准。
*/
DealNames?: Array;
}
/**
* DescribeLibraDBClusterAccountPrivileges返回参数结构体
*/
export interface DescribeLibraDBClusterAccountPrivilegesResponse {
/**
* 权限列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Privileges?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAuditInstanceList请求参数结构体
*/
export interface DescribeAuditInstanceListRequest {
/**
* 实例审计开启的状态。1-已开启审计;0-未开启审计。
*/
AuditSwitch?: number;
/**
* 查询实例列表的过滤条件。
*/
Filters?: Array;
/**
* 实例的审计规则模式。1-规则审计;0-全审计。
*/
AuditMode?: number;
/**
* 单次请求返回的数量。默认值为30,最大值为 100。
*/
Limit?: number;
/**
* 偏移量,默认值为 0。
*/
Offset?: number;
}
/**
* DescribeInstanceSlowQueries返回参数结构体
*/
export interface DescribeInstanceSlowQueriesResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* 慢查询记录
*/
SlowQueries?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstances请求参数结构体
*/
export interface DescribeInstancesRequest {
/**
* 返回数量,默认为 20,取值范围为(0,100]
*/
Limit?: number;
/**
* 记录偏移量,默认值为0
*/
Offset?: number;
/**
* 排序字段,取值范围:
CREATETIME:创建时间
PERIODENDTIME:过期时间
*/
OrderBy?: string;
/**
* 排序类型,取值范围:
ASC:升序排序
DESC:降序排序
*/
OrderByType?: string;
/**
* 搜索条件,若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
*/
Filters?: Array;
/**
* 引擎类型:目前支持“MYSQL”
*/
DbType?: string;
/**
* 实例状态, 可选值:
creating 创建中
running 运行中
isolating 隔离中
isolated 已隔离
activating 恢复中
offlining 下线中
offlined 已下线
*/
Status?: string;
/**
* 实例id列表
*/
InstanceIds?: Array;
/**
* 集群类型,取值范围 CYNOSDB:事务集群 LIBRADB:分析集群 ALL:全部 ,缺省为 ALL
*/
ClusterType?: string;
}
/**
* CopyBackupToVault请求参数结构体
*/
export interface CopyBackupToVaultRequest {
/**
* 目标保险箱ID,备份文件将复制到此保险箱
*/
VaultId?: string;
/**
* 备份文件ID列表,支持批量复制多个备份文件
*/
BackupIds?: Array;
}
/**
* CloseClusterPasswordComplexity返回参数结构体
*/
export interface CloseClusterPasswordComplexityResponse {
/**
* 任务流ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBackupDownloadUrl返回参数结构体
*/
export interface DescribeBackupDownloadUrlResponse {
/**
* 备份下载地址
*/
DownloadUrl?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 计费询价结果
*/
export interface TradePrice {
/**
* 预付费模式下资源总价,不包含优惠,单位:分
*/
TotalPrice?: number;
/**
* 总的折扣,100表示100%不打折
*/
Discount?: number;
/**
* 预付费模式下的优惠后总价, 单位: 分,例如用户享有折扣 =TotalPrice × Discount
*/
TotalPriceDiscount?: number;
/**
* 后付费模式下的单位资源价格,不包含优惠,单位:分
*/
UnitPrice?: number;
/**
* 优惠后后付费模式下的单位资源价格, 单位: 分,例如用户享有折扣=UnitPricet × Discount
*/
UnitPriceDiscount?: number;
/**
* 计费价格单位
*/
ChargeUnit?: string;
/**
* 高精度下不包含优惠价格
*/
UnitPriceHighPrecision?: string;
/**
* 高精度下优惠后价格
*/
UnitPriceDiscountHighPrecision?: string;
/**
* 货币单位
*/
AmountUnit?: string;
}
/**
* DescribeBinlogConfig请求参数结构体
*/
export interface DescribeBinlogConfigRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* IsolateLibraDBCluster请求参数结构体
*/
export interface IsolateLibraDBClusterRequest {
/**
* 分析集群 ID
*/
ClusterId: string;
/**
* 隔离原因类型
*/
IsolateReasonTypes?: Array;
/**
* 隔离原因
*/
IsolateReason?: string;
}
/**
* CreateAuditRuleTemplate请求参数结构体
*/
export interface CreateAuditRuleTemplateRequest {
/**
* 审计规则。
*/
RuleFilters: Array;
/**
* 规则模板名称。
*/
RuleTemplateName: string;
/**
* 规则模板描述。
*/
Description?: string;
/**
* 告警等级。1-低风险,2-中风险,3-高风险
*/
AlarmLevel?: number;
/**
* 告警策略。0-不告警,1-告警。
*/
AlarmPolicy?: number;
}
/**
* PauseServerless请求参数结构体
*/
export interface PauseServerlessRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 是否强制暂停,忽略当前的用户链接 0:不强制 1:强制, 默认为1
*/
ForcePause?: number;
}
/**
* DescribeBinlogListByVault返回参数结构体
*/
export interface DescribeBinlogListByVaultResponse {
/**
* 总数量
*/
TotalCount?: number;
/**
* Binlog文件列表
*/
BinlogList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群信息
*/
export interface CynosdbCluster {
/**
* 集群状态, 可选值如下:
creating: 创建中
running:运行中
isolating:隔离中
isolated:已隔离
activating:解隔离中
offlining:下线中
offlined:已下线
deleting:删除中
deleted:已删除
*/
Status: string;
/**
* 更新时间
*/
UpdateTime: string;
/**
* 可用区
*/
Zone: string;
/**
* 集群名称
*/
ClusterName: string;
/**
* 地域
*/
Region: string;
/**
* 数据库版本
*/
DbVersion: string;
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例数
*/
InstanceNum: number;
/**
* 用户uin
*/
Uin: string;
/**
* 引擎类型
*/
DbType: string;
/**
* 用户appid
*/
AppId: number;
/**
* 集群状态描述
*/
StatusDesc: string;
/**
* 集群创建时间
*/
CreateTime: string;
/**
* 付费模式。0-按量计费,1-包年包月
*/
PayMode: number;
/**
* 截止时间
*/
PeriodEndTime: string;
/**
* 集群读写vip
*/
Vip: string;
/**
* 集群读写vport
*/
Vport: number;
/**
* 项目id
*/
ProjectID: number;
/**
* 私有网络ID
*/
VpcId?: string;
/**
* 子网ID
*/
SubnetId?: string;
/**
* cynos内核版本
*/
CynosVersion?: string;
/**
* cynos版本标签
*/
CynosVersionTag?: string;
/**
* 存储容量
*/
StorageLimit?: number;
/**
* 续费标志
*/
RenewFlag?: number;
/**
* 正在处理的任务
*/
ProcessingTask?: string;
/**
* 集群的任务数组
*/
Tasks?: Array;
/**
* 集群绑定的tag数组
*/
ResourceTags?: Array;
/**
* Db类型(NORMAL, SERVERLESS)
*/
DbMode?: string;
/**
* 当Db类型为SERVERLESS时,serverless集群状态,可选值:
resume
pause
*/
ServerlessStatus?: string;
/**
* 集群预付费存储值大小
*/
Storage?: number;
/**
* 集群存储为预付费时的存储ID,用于预付费存储变配
*/
StorageId?: string;
/**
* 集群存储付费模式。0-按量计费,1-包年包月
*/
StoragePayMode?: number;
/**
* 集群计算规格对应的最小存储值
*/
MinStorageSize?: number;
/**
* 集群计算规格对应的最大存储值
*/
MaxStorageSize?: number;
/**
* 集群网络信息
*/
NetAddrs?: Array;
/**
* 物理可用区
*/
PhysicalZone?: string;
/**
* 主可用区
*/
MasterZone?: string;
/**
* 是否有从可用区
*/
HasSlaveZone?: string;
/**
* 从可用区
*/
SlaveZones?: Array;
/**
* 商业类型
*/
BusinessType?: string;
/**
* 是否冻结
*/
IsFreeze?: string;
/**
* 订单来源
*/
OrderSource?: string;
/**
* 能力
*/
Ability?: Ability;
/**
* 实例绑定资源包信息(此处只返回存储资源包,即packageType=DISK)
*/
ResourcePackages?: Array;
/**
* 全球数据库唯一标识
*/
GdnId?: string;
/**
* 集群角色。主集群- primary,从集群 - standby,如果 GdnId为空,该字段无效。
*/
GdnRole?: string;
}
/**
* 数据源项
*/
export interface DataSourceItem {
/**
* 源端实例ID
*/
InstanceId?: string;
/**
* 源端集群ID
*/
ClusterId?: string;
/**
* 源端数据库类型
*/
DBType?: string;
/**
* 源端数据库IP
*/
IP?: string;
/**
* 源端数据库端口
*/
Port?: number;
/**
* 源实例地域
*/
Region?: string;
/**
* 源端实例可用区
*/
Zone?: string;
/**
* 源端主账号uin
*/
SrcUin?: string;
/**
* 账号类型
*/
AccountMode?: string;
/**
* 同步任务状态
*/
ReplicationJobStatus?: string;
}
/**
* OfflineCluster返回参数结构体
*/
export interface OfflineClusterResponse {
/**
* 任务流ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群任务ID
*/
export interface ClusterTaskId {
/**
* 集群ID
*/
ClusterId?: string;
/**
* 任务ID
*/
TaskId?: string;
}
/**
* DeleteLibraDBClusterAccounts返回参数结构体
*/
export interface DeleteLibraDBClusterAccountsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClusterGlobalEncryption请求参数结构体
*/
export interface ModifyClusterGlobalEncryptionRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 开启或关闭全局加密
*/
IsOpenGlobalEncryption?: boolean;
}
/**
* ModifyAccountHost请求参数结构体
*/
export interface ModifyAccountHostRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 新主机
*/
NewHost: string;
/**
* 账号信息
*/
Account: InputAccount;
}
/**
* DescribeFlow请求参数结构体
*/
export interface DescribeFlowRequest {
/**
* 任务流ID
*/
FlowId: number;
}
/**
* DescribeLibraDBDataSource返回参数结构体
*/
export interface DescribeLibraDBDataSourceResponse {
/**
* 源端信息列表
注意:此字段可能返回 null,表示取不到有效值。
*/
DataSourceList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterDatabaseTables返回参数结构体
*/
export interface DescribeClusterDatabaseTablesResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* 分页偏移
*/
Offset?: number;
/**
* 分页限制数量
*/
Limit?: number;
/**
* 数据库表列表
*/
Tables?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAccountPrivileges请求参数结构体
*/
export interface ModifyAccountPrivilegesRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 账号信息
*/
Account: InputAccount;
/**
* 全局权限数组
*/
GlobalPrivileges?: Array;
/**
* 数据库权限数组
*/
DatabasePrivileges?: Array;
/**
* 表权限数组
*/
TablePrivileges?: Array;
}
/**
* CreateBackup请求参数结构体
*/
export interface CreateBackupRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 备份类型, 可选值:logic,逻辑备份;snapshot,物理备份
*/
BackupType?: string;
/**
* 备份的库, 只在 BackupType 为 logic 时有效
*/
BackupDatabases?: Array;
/**
* 备份的表, 只在 BackupType 为 logic 时有效
*/
BackupTables?: Array;
/**
* 备注名
*/
BackupName?: string;
/**
* 投递到保险箱的信息
*/
Vaults?: Array;
}
/**
* redo日志详情
*/
export interface RedoLogItem {
/**
* 文件名
*/
FileName?: string;
/**
* 文件大小
*/
FileSize?: number;
/**
* 备份时间
*/
BackupTime?: string;
/**
* redoLogId
*/
RedoLogId?: number;
/**
* 跨地域信息
*/
RedoCrossRegions?: Array;
/**
* 状态
*/
Status?: string;
/**
* 开始时间
*/
StartTime?: string;
/**
* 完成时间
*/
FinishTime?: string;
/**
* 保险箱信息
*/
VaultInfos?: Array;
/**
* 备份投递状态
*/
CopyStatus?: string;
/**
* 加密秘钥key
*/
EncryptKeyId?: string;
/**
* 加密秘钥地域
*/
EncryptRegion?: string;
}
/**
* CreateCLSDelivery请求参数结构体
*/
export interface CreateCLSDeliveryRequest {
/**
* 实例id
*/
InstanceId: string;
/**
* 日志投递配置
*/
CLSInfoList: Array;
/**
* 日志类型
*/
LogType?: string;
/**
* 是否维护时间运行
*/
IsInMaintainPeriod?: string;
}
/**
* DescribeMaintainPeriod返回参数结构体
*/
export interface DescribeMaintainPeriodResponse {
/**
* 维护week days
*/
MaintainWeekDays?: Array;
/**
* 维护开始时间,单位秒
*/
MaintainStartTime?: number;
/**
* 维护时长,单位秒
*/
MaintainDuration?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBackupList返回参数结构体
*/
export interface DescribeBackupListResponse {
/**
* 总共备份文件个数
*/
TotalCount?: number;
/**
* 备份文件列表
*/
BackupList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeServerlessStrategy返回参数结构体
*/
export interface DescribeServerlessStrategyResponse {
/**
* cpu负载为 0 时持续多久(秒)发起自动暂停
*/
AutoPauseDelay?: number;
/**
* cpu负载超过当前规格核数时,持续多久(秒)发起自动扩容
*/
AutoScaleUpDelay?: number;
/**
* cpu 负载低于低一级规格核数时,持续多久(秒)发起自动缩容
*/
AutoScaleDownDelay?: number;
/**
* 是否自动暂停,可能值:
yes
no
*/
AutoPause?: string;
/**
* 集群是否允许向上扩容,可选范围yesno
*/
AutoScaleUp?: string;
/**
* 集群是否允许向下缩容,可选范围yesno
*/
AutoScaleDown?: string;
/**
* 是否开启归档,可选范围yesno默认值:yes
*/
AutoArchive?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 分析实例版本升级,升级之后用于灰度的连接信息
*/
export interface UpgradeAnalysisInstanceVersionInfo {
/**
* ip
*/
Vip?: string;
/**
* 端口
*/
Vport?: number;
/**
* 版本
*/
EngineVersion?: string;
/**
* 到期时间
*/
ExpiredTime?: number;
}
/**
* ModifyClusterParam请求参数结构体
*/
export interface ModifyClusterParamRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 要修改的参数列表。每一个元素是ParamName、CurrentValue和OldValue的组合。ParamName是参数名称,CurrentValue是当前值,OldValue是之前值且不做校验
*/
ParamList: Array;
/**
* 维护期间执行-yes,立即执行-no
*/
IsInMaintainPeriod?: string;
}
/**
* ModifyClusterReadOnly请求参数结构体
*/
export interface ModifyClusterReadOnlyRequest {
/**
* 集群ID列表
*/
ClusterIds: Array;
/**
* 集群只读开关,可选值:ON,OFF
*/
ReadOnlyOperation: string;
/**
* yes:在运维时间窗内修改,no:立即执行(默认值)
*/
IsInMaintainPeriod?: string;
}
/**
* OfflineInstance返回参数结构体
*/
export interface OfflineInstanceResponse {
/**
* 任务流ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAuditLogFile请求参数结构体
*/
export interface CreateAuditLogFileRequest {
/**
* 实例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;
/**
* 已废弃。
* @deprecated
*/
Filter?: AuditLogFilter;
/**
* 审计日志过滤条件
*/
LogFilter?: Array;
/**
* 审计日志列
*/
ColumnFilter?: Array;
}
/**
* CalculateBackupSaveSecExpires返回参数结构体
*/
export interface CalculateBackupSaveSecExpiresResponse {
/**
* 将被删除的备份文件总数
*/
WillDeleteBackupFileCount?: number;
/**
* 将被删除的备份文件列表
*/
WillDeleteBackupFiles?: Array;
/**
* 将被删除的Binlog文件总数
*/
WillDeleteBinlogFileCount?: number;
/**
* 将被删除的Binlog文件列表
*/
WillDeleteBinlogFiles?: Array;
/**
* 将被删除的Redolog文件总数
*/
WillDeleteRedoLogFileCount?: number;
/**
* 将被删除的Redolog文件列表
*/
WillDeleteRedoLogFiles?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClusterSlaveZone请求参数结构体
*/
export interface ModifyClusterSlaveZoneRequest {
/**
* 集群Id
*/
ClusterId: string;
/**
* 旧从可用区
*/
OldSlaveZone: string;
/**
* 新从可用区
*/
NewSlaveZone: string;
/**
* binlog同步方式。默认值:async。可选值:sync、semisync、async
*/
BinlogSyncWay?: string;
/**
* 半同步超时时间,单位ms。为保证业务稳定性,半同步复制存在退化逻辑,当主可用区集群在等待备可用区集群确认事务时若超过该超时时间,复制方式将降为异步复制。最低设置为1000ms,最高支持4294967295ms,默认10000ms。
*/
SemiSyncTimeout?: number;
}
/**
* DescribeInstanceErrorLogs返回参数结构体
*/
export interface DescribeInstanceErrorLogsResponse {
/**
* 日志条数
*/
TotalCount?: number;
/**
* 错误日志列表
*/
ErrorLogs?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 同步对象列表
*/
export interface Objects {
/**
* 包含数据库表信息
注意:此字段可能返回 null,表示取不到有效值。
*/
DatabaseTables?: MigrateObject;
}
/**
* DescribeSupportProxyVersion返回参数结构体
*/
export interface DescribeSupportProxyVersionResponse {
/**
* 支持的数据库代理版本集合
*/
SupportProxyVersions?: Array;
/**
* 当前proxy版本号
*/
CurrentProxyVersion?: string;
/**
* 代理版本详情
*/
SupportProxyVersionDetail?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLibraDBForwardConfig返回参数结构体
*/
export interface DescribeLibraDBForwardConfigResponse {
/**
* 是否开启转发
*/
ForwardMode?: string;
/**
* 转发列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ForwardList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Libra所售卖的地域库存信息
*/
export interface ZoneStockInfo4Libra {
/**
* 可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
Zone?: string;
/**
* 是否有库存
注意:此字段可能返回 null,表示取不到有效值。
*/
HasStock?: boolean;
}
/**
* DeleteClusterDatabase返回参数结构体
*/
export interface DeleteClusterDatabaseResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群详情详细信息
*/
export interface CynosdbClusterDetail {
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* 地域
*/
Region?: string;
/**
* 集群主可用区
*/
Zone?: string;
/**
* 物理可用区
*/
PhysicalZone?: string;
/**
* 状态,支持的值如下:
- creating:创建中
- running:运行中
- isolating:隔离中
- isolated:已隔离
- activating:从回收站重新恢复
- offlining:下线中
- offlined:已下线
- deleting:删除中
- deleted:已删除
*/
Status?: string;
/**
* 状态描述
*/
StatusDesc?: string;
/**
* 当Db类型为SERVERLESS时,serverless集群状态,可选值:
resume
resuming
pause
pausing
*/
ServerlessStatus?: string;
/**
* 存储Id
*/
StorageId?: string;
/**
* 存储大小,单位为G
*/
Storage?: number;
/**
* 最大存储规格,单位为G
*/
MaxStorageSize?: number;
/**
* 最小存储规格,单位为G
*/
MinStorageSize?: number;
/**
* 存储付费类型,1为包年包月,0为按量计费
*/
StoragePayMode?: number;
/**
* VPC名称
*/
VpcName?: string;
/**
* vpc唯一id
*/
VpcId?: string;
/**
* 子网名称
*/
SubnetName?: string;
/**
* 子网ID
*/
SubnetId?: string;
/**
* 字符集
*/
Charset?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 数据库类型
*/
DbType?: string;
/**
* Db类型:
NORMALSERVERLESS
*/
DbMode?: string;
/**
* 数据库版本
*/
DbVersion?: string;
/**
* 存储空间上限
*/
StorageLimit?: number;
/**
* 使用容量
*/
UsedStorage?: number;
/**
* vip地址
*/
Vip?: string;
/**
* vport端口
*/
Vport?: number;
/**
* 集群只读实例的vip地址和vport端口
*/
RoAddr?: Array;
/**
* 集群支持的功能
*/
Ability?: Ability;
/**
* cynos版本
*/
CynosVersion?: string;
/**
* 商业类型
*/
BusinessType?: string;
/**
* 是否有从可用区
*/
HasSlaveZone?: string;
/**
* 是否冻结
*/
IsFreeze?: string;
/**
* 任务列表
*/
Tasks?: Array;
/**
* 读写实例当前所在可用区
*/
MasterZone?: string;
/**
* 从可用区列表
*/
SlaveZones?: Array;
/**
* 实例信息
*/
InstanceSet?: Array;
/**
* 付费模式
*/
PayMode?: number;
/**
* 到期时间
*/
PeriodEndTime?: string;
/**
* 项目id
*/
ProjectID?: number;
/**
* 实例绑定的tag数组信息
*/
ResourceTags?: Array;
/**
* Proxy状态
*/
ProxyStatus?: string;
/**
* binlog开关,可选值:ON, OFF
*/
LogBin?: string;
/**
* 是否跳过交易
*/
IsSkipTrade?: string;
/**
* pitr类型,可选值:normal, redo_pitr
*/
PitrType?: string;
/**
* 是否打开密码复杂度
*/
IsOpenPasswordComplexity?: string;
/**
* 网络类型
*/
NetworkStatus?: string;
/**
* 集群绑定的资源包信息
*/
ResourcePackages?: Array;
/**
* 自动续费标识,1为自动续费,0为到期不续
*/
RenewFlag?: number;
/**
* 节点网络类型
*/
NetworkType?: string;
/**
* 备可用区属性
*/
SlaveZoneAttr?: Array;
/**
* 版本标签
*/
CynosVersionTag?: string;
/**
* 全球数据库网络唯一标识
*/
GdnId?: string;
/**
* 集群在全球数据网络中的角色。
主集群- primary
从集群 - standby
如为空,该字段无效
*/
GdnRole?: string;
/**
* 二级存储使用量,单位:G
*/
UsedArchiveStorage?: number;
/**
* 归档状态,枚举值
normal:正常archiving:归档中resuming:恢复中archived :已归档
*/
ArchiveStatus?: string;
/**
* 归档进度,百分比。
*/
ArchiveProgress?: number;
/**
* 集群级别。例如 P0, P1
*/
ClusterLevel?: string;
/**
* 是否开启透明加密
*/
IsOpenTDE?: boolean;
/**
* 实例当前所在可用区
*/
RealZone?: string;
/**
* 超限开启状态
枚举值:
默认值:no
*/
StorageOverUse?: string;
/**
* 自动扩容开启状态
枚举值:
默认值:no
*/
StorageAutoExpand?: string;
}
/**
* ActivateLibraDBInstance返回参数结构体
*/
export interface ActivateLibraDBInstanceResponse {
/**
* 任务流id
注意:此字段可能返回 null,表示取不到有效值。
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RestartInstance请求参数结构体
*/
export interface RestartInstanceRequest {
/**
* 实例id
*/
InstanceId: string;
}
/**
* 资源包明细说明
*/
export interface PackageDetail {
/**
* AppId账户ID
*/
AppId?: number;
/**
* 资源包唯一ID
*/
PackageId?: string;
/**
* 实例ID
*/
InstanceId?: string;
/**
* 成功抵扣容量
*/
SuccessDeductSpec?: number;
/**
* 截止当前,资源包已使用的容量
*/
PackageTotalUsedSpec?: number;
/**
* 抵扣开始时间
*/
StartTime?: string;
/**
* 抵扣结束时间
*/
EndTime?: string;
/**
* 扩展信息
*/
ExtendInfo?: string;
}
/**
* 备份文件限制下载来源VPC设置项
*/
export interface BackupLimitVpcItem {
/**
* 限制下载来源的地域。目前仅支持当前地域
*/
Region?: string;
/**
* 限制下载的vpc列表
*/
VpcList?: Array;
}
/**
* DescribeLibraDBClusterAccounts返回参数结构体
*/
export interface DescribeLibraDBClusterAccountsResponse {
/**
* 账号信息
*/
AccountSet?: Array;
/**
* 总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateClusterPeriodScalePolicy返回参数结构体
*/
export interface CreateClusterPeriodScalePolicyResponse {
/**
* 策略ID
*/
PolicyId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAccountPrivileges请求参数结构体
*/
export interface DescribeAccountPrivilegesRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 账户名
*/
AccountName: string;
/**
* 主机
*/
Host: string;
/**
* 数据库名,为*时,忽略Type/TableName, 表示修改用户全局权限;
*/
Db: string;
/**
* 指定数据库下的对象类型,可选"table","*"
*/
Type: string;
/**
* 当Type="table"时,用来指定表名
*/
TableName?: string;
}
/**
* DescribeInstanceSpecsByOperationType请求参数结构体
*/
export interface DescribeInstanceSpecsByOperationTypeRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 操作类型
addROInstance:新增RO实例
modifyInstance:变配
*/
OperationType: string;
/**
* 实例ID,查询变配规格时必传
*/
InstanceId?: string;
/**
* 实例机器类型
*/
DeviceType?: string;
}
/**
* ModifyAccountParams返回参数结构体
*/
export interface ModifyAccountParamsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceSpecs返回参数结构体
*/
export interface DescribeInstanceSpecsResponse {
/**
* 规格信息
*/
InstanceSpecSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群Serveless弹性计划
*/
export interface ClusterServerlessScalePlan {
/**
* 计划ID
*/
PlanId?: number;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 实例对象。具体是实例id或者类型。比如ro-即集群下的所有只读实例。
*/
ObjectInstance?: string;
/**
* 策略ID
*/
PolicyId?: string;
/**
* 策略类型
*/
PolicyType?: string;
/**
* 原规格下限
*/
SourceMinCpu?: number;
/**
* 原规格上限
*/
SourceMaxCpu?: number;
/**
* 原规格下限
*/
TargetMinCpu?: number;
/**
* 原规格上限
*/
TargetMaxCpu?: number;
/**
* 计划状态
*/
Status?: string;
/**
* 弹性任务ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ScaleTaskId?: number;
/**
* 失败原因
注意:此字段可能返回 null,表示取不到有效值。
*/
FailReason?: string;
/**
* 计划预期开始执行时间
*/
ExpectedStartTime?: string;
/**
* 计划预期结束时间
*/
ExpectedEndTime?: string;
/**
* 恢复自动弹性任务
*/
ResetTaskId?: number;
/**
* 恢复自动弹性任务执行方式
*/
ResetType?: string;
/**
* 恢复自动弹性任务执行时间
*/
ResetTime?: string;
}
/**
* OpenSSL返回参数结构体
*/
export interface OpenSSLResponse {
/**
* 任务流ID
*/
FlowId?: number;
/**
* 任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAuditService返回参数结构体
*/
export interface ModifyAuditServiceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterDetail返回参数结构体
*/
export interface DescribeClusterDetailResponse {
/**
* 集群详细信息
*/
Detail?: CynosdbClusterDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceSlowQueries请求参数结构体
*/
export interface DescribeInstanceSlowQueriesRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 事务开始最早时间
*/
StartTime?: string;
/**
* 事务开始最晚时间
*/
EndTime?: string;
/**
* 限制条数
建议控制 limit 大小,当 limit 过大时,由于平台返回结果大小限制,可能会造成截断
*/
Limit?: number;
/**
* 偏移量
*/
Offset?: number;
/**
* 用户名
*/
Username?: string;
/**
* 客户端host
*/
Host?: string;
/**
* 数据库名
*/
Database?: string;
/**
* 排序字段
枚举值:
- QueryTime: 按照 SQL 语句的总执行时长排序
- LockTime: 按照 SQL 语句在等待锁(如表锁、行锁)上消耗的时间排序
- RowsExamined: 按照 SQL 语句在执行过程中扫描的行数排序
- RowsSent: 按照 SQL 语句最终返回给客户端的结果行数排序
- Timestamp: 按照慢查询语句发生的时间戳排序
*/
OrderBy?: string;
/**
* 排序类型,可选值:asc,desc
*/
OrderByType?: string;
/**
* sql语句
*/
SqlText?: string;
}
/**
* ModifyResourcePackageClusters返回参数结构体
*/
export interface ModifyResourcePackageClustersResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 备份使用量信息
*/
export interface BackupVolumeInfo {
/**
* 备份使用量
*/
BackupVolume?: number;
/**
* 备份类型
*/
BackupType?: string;
/**
* 备份方式
*/
BackupMethod?: string;
}
/**
* 账号,包含accountName和host
*/
export interface InputAccount {
/**
* 账号
*/
AccountName: string;
/**
* 主机,默认‘%’
*/
Host?: string;
}
/**
* DescribeSaveBackupClusters请求参数结构体
*/
export interface DescribeSaveBackupClustersRequest {
/**
* 每页条数
*/
Limit: number;
/**
* 偏移量
*/
Offset?: number;
/**
* 检索条件
*/
Filters?: Array;
}
/**
* DescribeLibraDBClusterAccountAllPrivileges返回参数结构体
*/
export interface DescribeLibraDBClusterAccountAllPrivilegesResponse {
/**
* 权限语句
注意:此字段可能返回 null,表示取不到有效值。
*/
PrivilegeStatements?: Array;
/**
* 全局权限
注意:此字段可能返回 null,表示取不到有效值。
*/
GlobalPrivileges?: Array;
/**
* 数据库权限
注意:此字段可能返回 null,表示取不到有效值。
*/
DatabasePrivileges?: Array;
/**
* 表权限
注意:此字段可能返回 null,表示取不到有效值。
*/
TablePrivileges?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RollBackCluster请求参数结构体
*/
export interface RollBackClusterRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 回档策略 timeRollback-按时间点回档 snapRollback-按备份文件回档
*/
RollbackStrategy: string;
/**
* 备份文件ID。
回档策略为按备份文件回档时必填。
*/
RollbackId?: number;
/**
* 期望回档时间。
回档策略为timeRollback按时间点回档时必填。
*/
ExpectTime?: string;
/**
* 期望阈值(已废弃)
*/
ExpectTimeThresh?: number;
/**
* 回档数据库列表
*/
RollbackDatabases?: Array;
/**
* 回档数据库表列表
*/
RollbackTables?: Array;
/**
* 按时间点回档模式,full: 普通; db: 快速; table: 极速 (默认是普通)
*/
RollbackMode?: string;
/**
* 保险箱id
*/
VaultId?: string;
}
/**
* ModifyClusterBinlogRedoLogAutoCopyVault返回参数结构体
*/
export interface ModifyClusterBinlogRedoLogAutoCopyVaultResponse {
/**
* 任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClusterName请求参数结构体
*/
export interface ModifyClusterNameRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 集群名
*/
ClusterName: string;
}
/**
* 实例的审计规则详情。
*/
export interface InstanceAuditRule {
/**
* 实例ID。
*/
InstanceId?: string;
/**
* 是否是规则审计。true-规则审计,false-全审计。
*/
AuditRule?: boolean;
/**
* 审计规则详情。仅当AuditRule=true时有效。
*/
AuditRuleFilters?: Array;
/**
* 是否是审计策略
*/
OldRule?: boolean;
/**
* 实例应用的规则模板详情
*/
RuleTemplates?: Array;
}
/**
* DescribeLibraDBClusterDetail请求参数结构体
*/
export interface DescribeLibraDBClusterDetailRequest {
/**
* 分析集群 ID
*/
ClusterId: string;
/**
* 是否获取更多服务器信息,可选值yes no
*/
GetServerInfo?: string;
}
/**
* 交换RO组信息
*/
export interface ExchangeRoGroupInfo {
/**
* 源RO组信息
*/
SrcRoGroupInfo?: RollbackRoGroupInfo;
/**
* 目标RO组信息
*/
DstRoGroupInfo?: RollbackRoGroupInfo;
}
/**
* IsolateLibraDBInstance返回参数结构体
*/
export interface IsolateLibraDBInstanceResponse {
/**
* 任务流id
注意:此字段可能返回 null,表示取不到有效值。
*/
FlowId?: number;
/**
* 订单号列表
注意:此字段可能返回 null,表示取不到有效值。
*/
DealNames?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteClusterPeriodScalePolicy请求参数结构体
*/
export interface DeleteClusterPeriodScalePolicyRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 策略ID
*/
PolicyId: string;
}
/**
* RefundResourcePackage请求参数结构体
*/
export interface RefundResourcePackageRequest {
/**
* 资源包唯一ID
*/
PackageId: string;
}
/**
* DescribeBinlogDownloadUrl请求参数结构体
*/
export interface DescribeBinlogDownloadUrlRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* Binlog文件ID
*/
BinlogId: number;
/**
* 备份下载来源限制条件
*/
DownloadRestriction?: BackupLimitRestriction;
}
/**
* ModifyInstanceName请求参数结构体
*/
export interface ModifyInstanceNameRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 实例名称
*/
InstanceName: string;
}
/**
* 回档实例信息
*/
export interface RollbackInstanceInfo {
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* vpc信息
*/
UniqVpcId?: string;
/**
* 子网信息
*/
UniqSubnetId?: string;
/**
* vip信息
*/
Vip?: string;
/**
* vport信息
*/
Vport?: number;
/**
* 实例ID
*/
InstanceId?: string;
/**
* 实例名称
*/
InstanceName?: string;
/**
* 状态
*/
Status?: string;
/**
* cpu大小
*/
Cpu?: number;
/**
* 内存大小
*/
Mem?: number;
/**
* 存储大小
*/
StorageLimit?: number;
}
/**
* DescribeClusterPeriodScalePolicy请求参数结构体
*/
export interface DescribeClusterPeriodScalePolicyRequest {
/**
* 集群id
*/
ClusterId: string;
}
/**
* ModifyLibraDBClusterAccountPrivilege请求参数结构体
*/
export interface ModifyLibraDBClusterAccountPrivilegeRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 账号
*/
Account: InputAccount;
/**
* 全局权限
*/
GlobalPrivileges?: Array;
/**
* 数据库权限
*/
DatabasePrivileges?: Array;
/**
* 表权限
*/
TablePrivileges?: Array;
}
/**
* DescribeDBSecurityGroups返回参数结构体
*/
export interface DescribeDBSecurityGroupsResponse {
/**
* 安全组信息
*/
Groups?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteParamTemplate返回参数结构体
*/
export interface DeleteParamTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateClusterPeriodScalePolicy请求参数结构体
*/
export interface CreateClusterPeriodScalePolicyRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例类型。rw读写,ro-只读
*/
InstanceType: string;
/**
* 当天开始弹性时间。格式是小时:分钟
*/
ScaleStartTime: string;
/**
* 当天结束弹性时间。格式是小时:分钟
*/
ScaleEndTime: string;
/**
* 策略生效的起始日期时间
*/
PolicyStartTime: string;
/**
* 策略生效的截止日期时间
*/
PolicyEndTime: string;
/**
* 周期类型。day-天,week-周,month-月。
*/
PeriodType: string;
/**
* 弹性规格下限
*/
MinCpu?: number;
/**
* 弹性规格上限
*/
MaxCpu?: number;
/**
* 周期内的时间列表。针对PeriodType=week, 表示星期几,比如[1,3]表示星期一、星期三。同理,对于PeriodType=month,[1,3,10]表示每月的1、3、10号。PeriodType=day则该字段无效。
*/
PeriodConfig?: Array;
}
/**
* DownloadLibraDBClusterList请求参数结构体
*/
export interface DownloadLibraDBClusterListRequest {
/**
* 限制数
*/
Limit?: number;
/**
* 偏移值
*/
Offset?: number;
/**
* 排序字段
*/
OrderBy?: string;
/**
* 排序方式,desc,asc,DESC,ASC
*/
OrderByType?: string;
/**
* 过滤条件
*/
Filters?: Array;
}
/**
* 集群实例信息
*/
export interface ClusterInstanceDetail {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 实例名称
*/
InstanceName?: string;
/**
* 引擎类型
*/
InstanceType?: string;
/**
* 实例状态
*/
InstanceStatus?: string;
/**
* 实例状态描述
*/
InstanceStatusDesc?: string;
/**
* cpu核数
*/
InstanceCpu?: number;
/**
* 内存
*/
InstanceMemory?: number;
/**
* 硬盘
*/
InstanceStorage?: number;
/**
* 实例角色
*/
InstanceRole?: string;
/**
* 执行开始时间(距离0点的秒数)
*/
MaintainStartTime?: number;
/**
* 持续的时间(单位:秒)
*/
MaintainDuration?: number;
/**
* 可以执行的时间,枚举值:["Mon","Tue","Wed","Thu","Fri", "Sat", "Sun"]
*/
MaintainWeekDays?: Array;
/**
* serverless实例子状态
*/
ServerlessStatus?: string;
/**
* 实例任务信息
*/
InstanceTasks?: Array;
/**
* 实例机器类型
- common,通用型。
- exclusive,独享型。
*/
InstanceDeviceType?: string;
/**
* 实例存储类型
说明:仅当要查询的资源为 LibraDB 时,此参数才会返回值。
*/
InstanceStorageType?: string;
/**
* 数据库类型
*/
DbMode?: string;
/**
* 节点列表
说明:仅当要查询的资源为 LibraDB 时,此参数才会返回值。
*/
NodeList?: Array;
/**
* AI优化器状态
*/
AIOptimizerStatus?: AIOptimizerStatus;
}
/**
* 保险箱信息
*/
export interface CreateBackupVaultItem {
/**
* 保险箱id
注意:此字段可能返回 null,表示取不到有效值。
*/
VaultId?: string;
/**
* 保险箱地域
注意:此字段可能返回 null,表示取不到有效值。
*/
VaultRegion?: string;
}
/**
* 集群从可用区信息
*/
export interface ClusterSlaveData {
/**
* 旧主可用区
*/
OldMasterZone?: string;
/**
* 旧从可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
OldSlaveZone?: Array;
/**
* 新主可用区
*/
NewMasterZone?: string;
/**
* 新从可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
NewSlaveZone?: Array;
/**
* 新从可用区属性
*/
NewSlaveZoneAttr?: Array;
/**
* 旧可用区属性
*/
OldSlaveZoneAttr?: Array;
}
/**
* 数据库地址
*/
export interface OldAddrInfo {
/**
* IP
*/
Vip?: string;
/**
* 端口
*/
Vport?: number;
/**
* 期望执行回收时间
*/
ReturnTime?: string;
}
/**
* DescribeTasks返回参数结构体
*/
export interface DescribeTasksResponse {
/**
* 任务列表总条数
*/
TotalCount?: number;
/**
* 任务列表
*/
TaskList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenClusterPasswordComplexity请求参数结构体
*/
export interface OpenClusterPasswordComplexityRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 密码长度
*/
ValidatePasswordLength: number;
/**
* 大小写字符个数
*/
ValidatePasswordMixedCaseCount: number;
/**
* 特殊字符个数
*/
ValidatePasswordSpecialCharCount: number;
/**
* 数字个数
*/
ValidatePasswordNumberCount: number;
/**
* 密码强度("MEDIUM", "STRONG")
*/
ValidatePasswordPolicy: string;
/**
* 数据字典
*/
ValidatePasswordDictionary?: Array;
}
/**
* DescribeAuditLogs返回参数结构体
*/
export interface DescribeAuditLogsResponse {
/**
* 符合条件的审计日志条数。
*/
TotalCount?: number;
/**
* 审计日志详情。
注意:此字段可能返回 null,表示取不到有效值。
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 资源包抵扣优先级
*/
export interface PackagePriority {
/**
* 需要自定义抵扣优先级的资源包
*/
PackageId?: string;
/**
* 自定义的抵扣优先级
*/
DeductionPriority?: number;
}
/**
* DescribeInstancesWithinSameCluster请求参数结构体
*/
export interface DescribeInstancesWithinSameClusterRequest {
/**
* vpcId
*/
UniqVpcId: string;
/**
* vip
*/
Vip: string;
}
/**
* AddLibraDBInstances请求参数结构体
*/
export interface AddLibraDBInstancesRequest {
/**
* 可用区
*/
Zone: string;
/**
* 集群ID
*/
ClusterId: string;
/**
* Cpu核数
*/
Cpu: number;
/**
* 内存,单位为GB
*/
Mem: number;
/**
* 磁盘大小
*/
StorageSize: number;
/**
* 付费模式
*/
PayMode: number;
/**
* 同步对象列表
*/
Objects: Objects;
/**
* 新增RO组时使用的Port,取值范围为[0,65535)
*/
Port?: number;
/**
* 新增只读实例数,取值范围为(0,15]
*/
GoodsNum?: number;
/**
* 实例名称,字符串长度范围为[0,64),取值范围为大小写字母,0-9数字,'_','-','.'
*/
InstanceName?: string;
/**
* 副本数
*/
ReplicasNum?: number;
/**
* ReplicasNum>1或者ReplicasNum=1且Cpu>=32核的时候取值为'Exclusive',其余场景取值'Common'
*/
InstanceType?: string;
/**
* 磁盘类型
*/
StorageType?: string;
/**
* 是否自动选择代金券 1是 0否 默认为0
*/
AutoVoucher?: number;
/**
* 订单来源,字符串长度范围为[0,64)
*/
OrderSource?: string;
/**
* 交易模式 0-下单并支付 1-下单
*/
DealMode?: number;
/**
* 所属VPC网络ID。
*/
VpcId?: string;
/**
* 所属子网ID,如果设置了VpcId,则SubnetId必填。
*/
SubnetId?: string;
/**
* 安全组ID,新建只读实例时可以指定安全组。
*/
SecurityGroupIds?: Array;
/**
* 分析引擎版本
*/
LibraDBVersion?: string;
/**
* 购买时长,与TimeUnit组合才能生效
*/
TimeSpan?: number;
/**
* 购买时长单位, 与TimeSpan组合生效,可选:日:d,月:m
*/
TimeUnit?: string;
/**
* 源端实例id
*/
SrcInstanceId?: string;
}
/**
* ModifyBinlogConfig返回参数结构体
*/
export interface ModifyBinlogConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAccountDescription返回参数结构体
*/
export interface ModifyAccountDescriptionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SetRenewFlag请求参数结构体
*/
export interface SetRenewFlagRequest {
/**
* 需操作的集群ID
*/
ResourceIds: Array;
/**
* 自动续费标志位,续费标记 0:正常续费 1:自动续费 2:到期不续
*/
AutoRenewFlag: number;
}
/**
* DescribeServerlessInstanceSpecs请求参数结构体
*/
export interface DescribeServerlessInstanceSpecsRequest {
/**
* 可用区
*/
Zone?: string;
/**
* 集群级别
*/
ClusterLevel?: string;
}
/**
* ActivateLibraDBCluster请求参数结构体
*/
export interface ActivateLibraDBClusterRequest {
/**
* 分析集群 ID
*/
ClusterId: string;
}
/**
* proxy组
*/
export interface ProxyGroup {
/**
* 数据库代理组ID
*/
ProxyGroupId?: string;
/**
* 数据库代理组节点个数
*/
ProxyNodeCount?: number;
/**
* 数据库代理组状态
*/
Status?: string;
/**
* 地域
*/
Region?: string;
/**
* 可用区
*/
Zone?: string;
/**
* 当前代理版本
*/
CurrentProxyVersion?: string;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 用户AppId
*/
AppId?: number;
/**
* 读写节点开通数据库代理
*/
OpenRw?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
}
/**
* DescribeLibraDBSlowLogs请求参数结构体
*/
export interface DescribeLibraDBSlowLogsRequest {
/**
* 只读分析引擎实例 ID
*/
InstanceId?: string;
/**
* 开始时间,1753171200。
*/
StartTime?: number;
/**
* 结束时间,1753171200。
*/
EndTime?: number;
/**
* 日志单页条数限制:0-200。
*/
Limit?: string;
/**
* 日志分页,大于0。
*/
Offset?: string;
/**
* 日志排序方式,DESC-降序,ASC-升序。
*/
Order?: string;
/**
* 日志排序条件。
*/
OrderBy?: string;
/**
* 过滤条件。
*/
LogFilter?: Array;
}
/**
* AddClusterSlaveZone请求参数结构体
*/
export interface AddClusterSlaveZoneRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 从可用区
*/
SlaveZone: string;
/**
* binlog同步方式。默认值:async。可选值:sync、semisync、async
*/
BinlogSyncWay?: string;
/**
* 半同步超时时间,单位ms。为保证业务稳定性,半同步复制存在退化逻辑,当主可用区集群在等待备可用区集群确认事务时若超过该超时时间,复制方式将降为异步复制。最低设置为1000ms,最高支持4294967295ms,默认10000ms。
*/
SemiSyncTimeout?: number;
}
/**
* CheckCreateLibraDBInstance请求参数结构体
*/
export interface CheckCreateLibraDBInstanceRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID
*/
InstanceId?: string;
}
/**
* 回滚数据库信息
*/
export interface RollbackDatabase {
/**
* 旧数据库名称
*/
OldDatabase: string;
/**
* 新数据库名称
*/
NewDatabase: string;
}
/**
* DeleteLibraDBCluster请求参数结构体
*/
export interface DeleteLibraDBClusterRequest {
/**
* 分析集群 ID
*/
ClusterId: string;
}
/**
* DescribeTasks请求参数结构体
*/
export interface DescribeTasksRequest {
/**
* 任务开始时间起始值
*/
StartTimeBegin?: string;
/**
* 任务开始时间结束值
*/
StartTimeEnd?: string;
/**
* 过滤条件,支持的搜索字段:"ClusterId"、"ClusterName"、"InstanceId"、"InstanceName"、"Status"、"TaskId"、"TaskType"
*/
Filters?: Array;
/**
* 查询列表长度
*/
Limit?: number;
/**
* 查询列表偏移量
*/
Offset?: number;
}
/**
* ModifyClusterStorage返回参数结构体
*/
export interface ModifyClusterStorageResponse {
/**
* 冻结流水ID
*/
TranId?: string;
/**
* 大订单号
*/
BigDealIds?: Array;
/**
* 订单号
*/
DealNames?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyInstanceUpgradeLimitDays请求参数结构体
*/
export interface ModifyInstanceUpgradeLimitDaysRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID
*/
InstanceId: string;
/**
* 升级限制时间
*/
UpgradeLimitDays: number;
}
/**
* ModifyLibraDBClusterAccountHost请求参数结构体
*/
export interface ModifyLibraDBClusterAccountHostRequest {
/**
* 分析集群id
*/
ClusterId: string;
/**
* 账号信息
*/
Account: InputAccount;
/**
* 主机名
*/
NewHost: string;
}
/**
* CloseClusterPasswordComplexity请求参数结构体
*/
export interface CloseClusterPasswordComplexityRequest {
/**
* 集群ID数组
*/
ClusterIds: Array;
}
/**
* DescribeClusterLevels返回参数结构体
*/
export interface DescribeClusterLevelsResponse {
/**
* 集群类型列表
*/
LevelList?: Array;
/**
* 专区列表
*/
Zones?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIsolatedInstances请求参数结构体
*/
export interface DescribeIsolatedInstancesRequest {
/**
* 返回数量,默认为 20,最大值为 100
*/
Limit?: number;
/**
* 记录偏移量,默认值为0
*/
Offset?: number;
/**
* 排序字段,取值范围:
CREATETIME:创建时间
PERIODENDTIME:过期时间
*/
OrderBy?: string;
/**
* 排序类型,取值范围:
ASC:升序排序
DESC:降序排序
*/
OrderByType?: string;
/**
* 搜索条件,若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
*/
Filters?: Array;
/**
* 引擎类型:目前支持“MYSQL”, “POSTGRESQL”
*/
DbType?: string;
}
/**
* ModifyAccountParams请求参数结构体
*/
export interface ModifyAccountParamsRequest {
/**
* 集群id,不超过32个字符
*/
ClusterId: string;
/**
* 账号信息
*/
Account: InputAccount;
/**
* 数据库表权限数组,当前仅支持参数:max_user_connections,max_user_connections不能大于10240
*/
AccountParams: Array;
}
/**
* ResetAccountPassword请求参数结构体
*/
export interface ResetAccountPasswordRequest {
/**
* 数据库账号名
*/
AccountName: string;
/**
* 数据库账号新密码
*/
AccountPassword: string;
/**
* 集群ID
*/
ClusterId: string;
/**
* 主机,不填默认为"%"
*/
Host?: string;
}
/**
* CheckCreateLibraDBInstance返回参数结构体
*/
export interface CheckCreateLibraDBInstanceResponse {
/**
* 整体校验状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: string;
/**
* 校验项
注意:此字段可能返回 null,表示取不到有效值。
*/
CheckItem?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 审计日志文件
*/
export interface AuditLogFile {
/**
* 审计日志文件名称
*/
FileName?: string;
/**
* 审计日志文件创建时间。格式为 : "2019-03-20 17:09:13"。
*/
CreateTime?: string;
/**
* 文件状态值。可能返回的值为:
"creating" - 生成中;
"failed" - 创建失败;
"success" - 已生成;
*/
Status?: string;
/**
* 文件大小,单位为 KB。
*/
FileSize?: number;
/**
* 审计日志下载地址。
*/
DownloadUrl?: string;
/**
* 错误信息。
*/
ErrMsg?: string;
/**
* 日志下载进度。
*/
ProgressRate?: number;
}
/**
* DescribeAuditRuleTemplates返回参数结构体
*/
export interface DescribeAuditRuleTemplatesResponse {
/**
* 符合查询条件的实例总数。
*/
TotalCount?: number;
/**
* 规则模板详细信息列表。
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteClusterDatabase请求参数结构体
*/
export interface DeleteClusterDatabaseRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 数据库名
*/
DbNames: Array;
}
/**
* proxy节点可用区内个数
*/
export interface ProxyZone {
/**
* proxy节点可用区
*/
ProxyNodeZone?: string;
/**
* proxy节点数量
*/
ProxyNodeCount?: number;
}
/**
* 只读实例地址
*/
export interface RoAddr {
/**
* IP地址
*/
IP?: string;
/**
* 端口
*/
Port?: number;
}
/**
* 集成集群配置
*/
export interface IntegrateCreateClusterConfig {
/**
* binlog保留天数[7,1830]
*/
BinlogSaveDays?: number;
/**
* 备份保留天数[7,1830]
*/
BackupSaveDays?: number;
/**
* 半同步超时时间[1000,4294967295]
*/
SemiSyncTimeout?: number;
/**
* proxy连接地址配置信息
*/
ProxyEndPointConfigs?: Array;
}
/**
* DeleteBackup返回参数结构体
*/
export interface DeleteBackupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProjectSecurityGroups返回参数结构体
*/
export interface DescribeProjectSecurityGroupsResponse {
/**
* 安全组详情
*/
Groups?: Array;
/**
* 总数量
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteLibraDBCluster返回参数结构体
*/
export interface DeleteLibraDBClusterResponse {
/**
* flow id
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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;
/**
* 参数的可选枚举值。如果为非枚举值,则为空
*/
EnumValue?: Array;
/**
* 1:全局参数,0:非全局参数
*/
IsGlobal?: number;
/**
* 匹配类型,multiVal
*/
MatchType?: string;
/**
* 匹配目标值,当multiVal时,各个key用,分割
*/
MatchValue?: string;
/**
* true-为公式,false-非公式
*/
IsFunc?: boolean;
/**
* 参数设置为公式时,Func返回设置的公式内容
*/
Func?: string;
/**
* 参数是否可修改
*/
ModifiableInfo?: ModifiableInfo;
/**
* 支持公式的参数的默认公式样式
*/
FuncPattern?: string;
}
/**
* OfflineCluster请求参数结构体
*/
export interface OfflineClusterRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* ResetAccountPassword返回参数结构体
*/
export interface ResetAccountPasswordResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLibraDBClusterAccounts请求参数结构体
*/
export interface CreateLibraDBClusterAccountsRequest {
/**
* 分析集群id
*/
ClusterId: string;
/**
* 账户信息
*/
Accounts: Array;
/**
* 加密方式
*/
EncryptMethod?: string;
}
/**
* DescribeClusterInstanceGroups请求参数结构体
*/
export interface DescribeClusterInstanceGroupsRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* OpenAuditService请求参数结构体
*/
export interface OpenAuditServiceRequest {
/**
* 实例ID。
*/
InstanceId: string;
/**
* 日志保留时长。
*/
LogExpireDay: number;
/**
* 高频日志保留时长。
*/
HighLogExpireDay?: number;
/**
* 审计规则(废弃)。
* @deprecated
*/
AuditRuleFilters?: Array;
/**
* 规则模板ID。同AuditRuleFilters都不填是全审计。
*/
RuleTemplateIds?: Array;
/**
* 审计类型。true-全审计;默认false-规则审计。
*/
AuditAll?: boolean;
}
/**
* ModifyResourcePackageName返回参数结构体
*/
export interface ModifyResourcePackageNameResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBackupList请求参数结构体
*/
export interface DescribeBackupListRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 返回数量,取值范围(0,100]
*/
Limit?: number;
/**
* 记录偏移量,取值范围[0,INF)
*/
Offset?: number;
/**
* 数据库类型,取值范围:
MYSQL
*/
DbType?: string;
/**
* 备份ID
*/
BackupIds?: Array;
/**
* 备份类型,可选值:snapshot,快照备份; logic,逻辑备份
*/
BackupType?: string;
/**
* 备份方式,可选值:auto,自动备份;manual,手动备份
*/
BackupMethod?: string;
/**
* 快照类型,可选值:full,全量;increment,增量
*/
SnapShotType?: string;
/**
* 备份开始时间
*/
StartTime?: string;
/**
* 备份结束时间
*/
EndTime?: string;
/**
* 备份文件名,模糊查询
*/
FileNames?: Array;
/**
* 备份备注名,模糊查询
*/
BackupNames?: Array;
/**
* 快照备份Id列表
*/
SnapshotIdList?: Array;
/**
* 备份地域
*/
BackupRegion?: string;
/**
* 是否跨地域备份
*/
IsCrossRegionsBackup?: string;
/**
* 需要查询的状态
*/
BackupStatus?: Array;
}
/**
* ModifyAccountDescription请求参数结构体
*/
export interface ModifyAccountDescriptionRequest {
/**
* 数据库账号名
*/
AccountName: string;
/**
* 数据库账号描述信息
*/
Description: string;
/**
* 集群ID
*/
ClusterId: string;
/**
* 主机,默认为"%"
*/
Host?: string;
}
/**
* 实例初始化配置信息
*/
export interface IntegrateInstanceInfo {
/**
* 实例cpu
*/
Cpu: number;
/**
* 实例内存
*/
Memory: number;
/**
* 实例类型 rw/ro
*/
InstanceType: string;
/**
* 实例个数,范围[1,15]
*/
InstanceCount: number;
/**
* 实例机器类型 common-公通用型,exclusive-独享型
*/
DeviceType?: string;
}
/**
* 转换集群log bin开关
*/
export interface SwitchClusterLogBin {
/**
* 状态
*/
Status?: string;
}
/**
* TransferStoragePrepayToPostpay请求参数结构体
*/
export type TransferStoragePrepayToPostpayRequest = null;
/**
* ModifyVault请求参数结构体
*/
export interface ModifyVaultRequest {
/**
* 保险箱ID
*/
VaultId: string;
/**
* 保险箱名称,最大255字符
*/
VaultName?: string;
/**
* 保险箱描述,最大1024字符
*/
VaultDescribe?: string;
/**
* 备份保留时长(秒),范围: (0, 632448000]
*/
BackupSaveSeconds?: number;
/**
* 加密密钥ID,最大36字符
*/
KeyId?: string;
/**
* 密钥类型,可选值: cloud、custom
*/
KeyType?: string;
/**
* 密钥所在地域,最大32字符
*/
KeyRegion?: string;
/**
* 是否锁定保险箱
*/
IsLock?: boolean;
/**
* 锁定到期时间,格式: 2006-01-02 15:04:05,锁定时间距当前最多15天
*/
LockedTime?: string;
/**
* 是否加密
*/
IsEncryption?: boolean;
}
/**
* ExportInstanceErrorLogs返回参数结构体
*/
export interface ExportInstanceErrorLogsResponse {
/**
* 错误日志导出内容
*/
ErrorLogItems?: Array;
/**
* 错误日志字符串
*/
FileContent?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLibraDBClusters请求参数结构体
*/
export interface DescribeLibraDBClustersRequest {
/**
* 限制
*/
Limit?: number;
/**
* 偏置
*/
Offset?: number;
/**
* 排序字段
*/
OrderBy?: string;
/**
* 排序方法
*/
OrderByType?: string;
/**
* 过滤条件
*/
Filters?: Array;
}
/**
* LibraDB 节点信息
*/
export interface LibraDBNodeInfo {
/**
* LibraDB节点ID
*/
NodeId?: string;
/**
* 节点状态
*/
Status?: string;
/**
* 数据同步中
*/
DataStatus?: string;
/**
* CPU核数
*/
Cpu?: number;
/**
* 内存大小,单位 G
*/
Memory?: number;
/**
* 磁盘大小,单位G
*/
Storage?: number;
/**
* 错误信息
*/
Message?: string;
}
/**
* 实例参数信息
*/
export interface ParamItemDetail {
/**
* 当前值
*/
CurrentValue?: string;
/**
* 默认值
*/
Default?: string;
/**
* 参数的可选枚举值。如果为非枚举值,则为空
*/
EnumValue?: Array;
/**
* 1:全局参数,0:非全局参数
*/
IsGlobal?: number;
/**
* 最大值
*/
Max?: string;
/**
* 最小值
*/
Min?: string;
/**
* 修改参数后,是否需要重启数据库以使参数生效。0-不需要重启,1-需要重启。
*/
NeedReboot?: number;
/**
* 参数名称
*/
ParamName?: string;
/**
* 参数类型:integer,enum,float,string,func
*/
ParamType?: string;
/**
* 参数是否可修改
*/
ModifiableInfo?: ModifiableInfo;
/**
* 参数描述
*/
Description?: string;
/**
* 类型是否为公式
*/
IsFunc?: boolean;
/**
* 参数配置公式
*/
Func?: string;
/**
* 支持公式的参数的默认公式样式
*/
FuncPattern?: string;
}
/**
* binlog配置信息
*/
export interface BinlogConfigInfo {
/**
* binlog保留时间
*/
BinlogSaveDays: number;
/**
* binlog异地地域备份是否开启
*/
BinlogCrossRegionsEnable: string;
/**
* binlog异地地域
注意:此字段可能返回 null,表示取不到有效值。
*/
BinlogCrossRegions?: Array;
/**
* 跨地域备份保留时间
单位:天
*/
BinlogCrossRegionSaveDays?: number;
/**
* 保险箱信息
*/
AutoCopyVaults?: Array;
}
/**
* IsolateCluster返回参数结构体
*/
export interface IsolateClusterResponse {
/**
* 任务流ID(后付费或者serverless资源返回,如果需要同步任务状态,请使用DescribeFlow接口)
*/
FlowId?: number;
/**
* 退款订单号(预付费资源返回,如果需要同步订单状态,请使用计费产品的DescribeDealsByCond同步订单状态)
注意:此字段可能返回 null,表示取不到有效值。
*/
DealNames?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RenewClusters返回参数结构体
*/
export interface RenewClustersResponse {
/**
* 预付费总订单号
*/
BigDealIds?: Array;
/**
* 退款订单号
*/
DealNames?: Array;
/**
* 冻结流水,一次开通一个冻结流水
*/
TranId?: string;
/**
* 每个订单号对应的发货资源id列表
*/
ResourceIds?: Array;
/**
* 集群id列表
*/
ClusterIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLibraDBForwardConfig请求参数结构体
*/
export interface ModifyLibraDBForwardConfigRequest {
/**
* 只读分析引擎实例Id
*/
InstanceId: string;
/**
* 转发模式
*/
ForwardMode?: string;
/**
* 转发实例列表
*/
ForwardList?: Array;
}
/**
* 备份设置
*/
export interface BackupConfigInfo {
/**
* 系统自动时间
*/
BackupCustomAutoTime?: boolean;
/**
* 表示全备开始时间,[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;
/**
* 该参数目前不支持修改,无需填写。备份频率,长度为7的数组,分别对应周日到周六的备份方式,full-全量备份,increment-增量备份
注意:此字段可能返回 null,表示取不到有效值。
*/
BackupWeekDays?: Array;
/**
* 间隔时间
*/
BackupIntervalTime?: number;
/**
* 表示保留备份时长, 单位秒,超过该时间将被清理, 七天表示为3600247=604800,最大为158112000
*/
ReserveDuration?: number;
/**
* 跨地域备份开启
yes-开启
no-关闭
*/
CrossRegionsEnable?: string;
/**
* 跨地域备份地域
注意:此字段可能返回 null,表示取不到有效值。
*/
CrossRegions?: Array;
/**
* 跨地域备份保留时间
单位:天
*/
CrossRegionSaveDays?: number;
/**
* 自动数据备份触发策略,periodically:自动周期备份,frequent:高频备份
*/
BackupTriggerStrategy?: string;
/**
* 备份投递关系
*/
AutoCopyVaults?: Array;
}
/**
* 回档表信息
*/
export interface RollbackTableInfo {
/**
* 旧表名称
*/
OldTable: string;
/**
* 新表名称
*/
NewTable: string;
}
/**
* 回档进度详情
*/
export interface RollbackProcessInfo {
/**
* 是否可以交换vip
*/
IsVipSwitchable?: boolean;
/**
* vip可交换时间
*/
VipSwitchableTime?: string;
/**
* 交换实例列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ExchangeInstanceInfoList?: Array;
/**
* 交换RO组列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ExchangeRoGroupInfoList?: Array;
/**
* 当前步骤
*/
CurrentStep?: string;
/**
* 当前步骤进度
*/
CurrentStepProgress?: number;
/**
* 当前步骤剩余时间
*/
CurrentStepRemainingTime?: string;
}
/**
* ModifyVipVport返回参数结构体
*/
export interface ModifyVipVportResponse {
/**
* 异步任务id
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDBInstanceSecurityGroups请求参数结构体
*/
export interface ModifyDBInstanceSecurityGroupsRequest {
/**
* 网络组id(cynosdbmysql-grp-前缀开头)或集群id(例如 cynosdbmysql-xxxxxxxx前缀),当通过实例IP地址三元组(UniqVpcId、Vip、Vport)配置安全组时,该字段必须设置为集群ID(例如 cynosdbmysql-xxxxxxxx前缀)。
*/
InstanceId: string;
/**
* 要修改的安全组ID列表,一个或者多个安全组ID组成的数组。
注意:该入参会全量替换存量已有集合,非增量更新。修改需传入预期的全量集合。
*/
SecurityGroupIds: Array;
/**
* 可用区
*/
Zone?: string;
/**
* 实例所属VPC网络ID,(UniqVpcId、Vip 和 Vport 三个参数需同时指定,用于唯一标识网络实例)
*/
UniqVpcId?: string;
/**
* 实例IP地址,实例IP地址三元组UniqVpcId、Vip 和 Vport) 三个参数需同时指定,用于唯一标识网络实实例
*/
Vip?: string;
/**
* 实例端口,实例IP地址三元组UniqVpcId、Vip 和 Vport) 三个参数需同时指定,用于唯一标识网络实实例
*/
Vport?: number;
}
/**
* CloseAuditService请求参数结构体
*/
export interface CloseAuditServiceRequest {
/**
* 实例ID。
*/
InstanceId: string;
}
/**
* ModifyLibraDBClusterReplicationObject请求参数结构体
*/
export interface ModifyLibraDBClusterReplicationObjectRequest {
/**
* 分析集群ID
*/
ClusterId: string;
/**
* 只读分析引擎实例 ID
*/
InstanceId: string;
/**
* 映射模式
*/
ForceDefaultMapRule?: string;
/**
* 同步对象
*/
Objects?: Array;
/**
* 自动映射规则
*/
AutoMapRules?: Array;
/**
* 是否按照最新映射规则刷新存量映射关系
*/
RefreshMapping?: boolean;
}
/**
* ModifyClusterPasswordComplexity返回参数结构体
*/
export interface ModifyClusterPasswordComplexityResponse {
/**
* 任务流ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeClusterVersion请求参数结构体
*/
export interface UpgradeClusterVersionRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 内核版本
*/
CynosVersion: string;
/**
* 升级时间类型,可选:upgradeImmediate,upgradeInMaintain
*/
UpgradeType: string;
}
/**
* 查询审计实例的过滤条件
*/
export interface AuditInstanceFilters {
/**
* 过滤条件值。支持InstanceId-实例ID,InstanceName-实例名称,ProjectId-项目ID,TagKey-标签键,Tag-标签(以竖线分割,例:Tagkey|Tagvalue)。
*/
Name: string;
/**
* true表示精确查找,false表示模糊匹配。
*/
ExactMatch: boolean;
/**
* 筛选值
*/
Values: Array;
}
/**
* 参数信息
*/
export interface ParamInfo {
/**
* 当前值
*/
CurrentValue?: string;
/**
* 默认值
*/
Default?: string;
/**
* 参数为enum/string/bool时,可选值列表
*/
EnumValue?: Array;
/**
* 参数类型为float/integer时的最大值
*/
Max?: string;
/**
* 参数类型为float/integer时的最小值
*/
Min?: string;
/**
* 参数名称
*/
ParamName?: string;
/**
* 是否需要重启生效
*/
NeedReboot?: number;
/**
* 参数类型:integer/float/string/enum/bool
*/
ParamType?: string;
/**
* 匹配类型,multiVal, regex在参数类型是string时使用
*/
MatchType?: string;
/**
* 匹配目标值,当multiVal时,各个key用;分割
*/
MatchValue?: string;
/**
* 参数描述
*/
Description?: string;
/**
* 是否为全局参数
*/
IsGlobal?: number;
/**
* 参数是否可修改
*/
ModifiableInfo?: ModifiableInfo;
/**
* 是否为函数
*/
IsFunc?: boolean;
/**
* 函数
*/
Func?: string;
/**
* 支持公式的参数的默认公式样式
*/
FuncPattern?: string;
}
/**
* TransferStoragePrepayToPostpay返回参数结构体
*/
export interface TransferStoragePrepayToPostpayResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClusterParam返回参数结构体
*/
export interface ModifyClusterParamResponse {
/**
* 异步请求Id,用于查询结果
*/
AsyncRequestId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 安全组详情
*/
export interface SecurityGroup {
/**
* 项目ID
*/
ProjectId?: number;
/**
* 创建时间,时间格式:yyyy-mm-dd hh:mm:ss
*/
CreateTime?: string;
/**
* 入站规则
*/
Inbound?: Array;
/**
* 出站规则
*/
Outbound?: Array;
/**
* 安全组ID
*/
SecurityGroupId?: string;
/**
* 安全组名称
*/
SecurityGroupName?: string;
/**
* 安全组备注
*/
SecurityGroupRemark?: string;
}
/**
* SetLibraDBClusterRenewFlag请求参数结构体
*/
export interface SetLibraDBClusterRenewFlagRequest {
/**
* 分析集群 ID 列表
*/
ResourceIds?: Array;
/**
* 续费标记 0:正常续费 1:自动续费 2:到期不续
*/
AutoRenewFlag?: number;
}
/**
* ModifyClusterPasswordComplexity请求参数结构体
*/
export interface ModifyClusterPasswordComplexityRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 密码长度
*/
ValidatePasswordLength: number;
/**
* 大小写字符个数
*/
ValidatePasswordMixedCaseCount: number;
/**
* 特殊字符个数
*/
ValidatePasswordSpecialCharCount: number;
/**
* 数字个数
*/
ValidatePasswordNumberCount: number;
/**
* 密码强度("MEDIUM", "STRONG")
*/
ValidatePasswordPolicy: string;
/**
* 数据字典
*/
ValidatePasswordDictionary?: Array;
}
/**
* 稀疏备份策略配置信息
*/
export interface SparseBackupConfigInfo {
/**
* 操作类型:add,modify,remove
*/
OpType: string;
/**
* 配置 ID
*/
ConfigId?: string;
/**
* 周期策略类型:weekly/monthly/yearly
*/
SparsePeriodConfig?: string;
/**
* 周期时间配置
*/
SparsePeriodTime?: SparsePeriodTime;
/**
* 保留天数(7-7320天,最长20年)
*/
SparseBackupSaveDays?: number;
}
/**
* 备份下载限制参数
*/
export interface BackupLimitRestriction {
/**
* 限制类型
*/
LimitType?: string;
/**
* 该参数仅支持 In, 表示 LimitVpc 指定的vpc可以下载。默认为In
*/
VpcComparisonSymbol?: string;
/**
* In: 指定的ip可以下载; NotIn: 指定的ip不可以下载
*/
IpComparisonSymbol?: string;
/**
* 限制下载的vpc设置
注意:此字段可能返回 null,表示取不到有效值。
*/
LimitVpcs?: Array;
/**
* 限制下载的ip设置
注意:此字段可能返回 null,表示取不到有效值。
*/
LimitIps?: Array;
}
/**
* DescribeLibraDBVersion请求参数结构体
*/
export type DescribeLibraDBVersionRequest = null;
/**
* ModifyInstanceParam返回参数结构体
*/
export interface ModifyInstanceParamResponse {
/**
* 任务ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* LibraDB 版本信息
*/
export interface LibraDBVersion {
/**
* 版本号
*/
Version?: string;
/**
* 版本tag
*/
Tag?: string;
/**
* 是否可以使用该版本
*/
HasPermission?: boolean;
}
/**
* DeleteVaults请求参数结构体
*/
export interface DeleteVaultsRequest {
/**
* 待删除的备份保险箱ID列表,不能为空,保险箱内必须已清空所有文件
*/
VaultIds: Array;
}
/**
* 任务进度查询
*/
export interface TaskProgressInfo {
/**
* 当前步骤
*/
CurrentStep?: string;
/**
* 当前进度
*/
CurrentStepProgress?: number;
/**
* 预估时间
*/
CurrentStepRemainingTime?: string;
}
/**
* ResetLibraDBClusterAccountPassword请求参数结构体
*/
export interface ResetLibraDBClusterAccountPasswordRequest {
/**
* 分析集群 ID
*/
ClusterId: string;
/**
* 密码
*/
AccountPassword: string;
/**
* 账号
*/
AccountName: string;
/**
* 加密方式
*/
EncryptMethod?: string;
/**
* 主机
*/
Host?: string;
}
/**
* 参数模板详情
*/
export interface TemplateParamInfo {
/**
* 当前值
*/
CurrentValue?: string;
/**
* 默认值
*/
Default?: string;
/**
* 参数类型为enum时可选的值类型集合
*/
EnumValue?: Array;
/**
* 参数类型为float/integer时的最大值
*/
Max?: string;
/**
* 参数类型为float/integer时的最小值
*/
Min?: string;
/**
* 参数名称
*/
ParamName?: string;
/**
* 是否需要重启
*/
NeedReboot?: number;
/**
* 参数描述
*/
Description?: string;
/**
* 参数类型,integer/float/string/enum
*/
ParamType?: string;
}
/**
* CreateBackup返回参数结构体
*/
export interface CreateBackupResponse {
/**
* 异步任务流ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLibraDBVersion返回参数结构体
*/
export interface DescribeLibraDBVersionResponse {
/**
* 版本列表
*/
VersionList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstancesWithinSameCluster返回参数结构体
*/
export interface DescribeInstancesWithinSameClusterResponse {
/**
* 实例个数
*/
TotalCount?: number;
/**
* 实例ID列表
*/
InstanceIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CancelClusterServerlessScalePlan返回参数结构体
*/
export interface CancelClusterServerlessScalePlanResponse {
/**
* 任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RollbackToNewCluster返回参数结构体
*/
export interface RollbackToNewClusterResponse {
/**
* 冻结流水ID
*/
TranId?: string;
/**
* 订单号
*/
DealNames?: Array;
/**
* 资源ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取资源ID)
*/
ResourceIds?: Array;
/**
* 集群ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取集群ID)
*/
ClusterIds?: Array;
/**
* 大订单号
注意:此字段可能返回 null,表示取不到有效值。
*/
BigDealIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群列表信息
*/
export interface LibraDBClusterSet {
/**
* 用户id
*/
AppId?: number;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* cynos版本
*/
CynosVersion?: string;
/**
* 版本标签
*/
CynosVersionTag?: string;
/**
* 数据库版本
*/
DbVersion?: string;
/**
* 实例数量
*/
InstanceNum?: number;
/**
* 是否冻结
*/
IsFreeze?: string;
/**
* 网络地址
*/
NetAddrs?: Array;
/**
* 付费模式
*/
PayMode?: number;
/**
* 到期时间
*/
PeriodEndTime?: string;
/**
* 项目id
*/
ProjectID?: number;
/**
* 地域
*/
Region?: string;
/**
* 自动续费标识,1为自动续费,0为到期不续
*/
RenewFlag?: number;
/**
* 状态
*/
Status?: string;
/**
* 状态描述
*/
StatusDesc?: string;
/**
* 存储大小,单位为G
*/
Storage?: number;
/**
* 子网ID
*/
SubnetId?: string;
/**
* 任务列表
*/
Tasks?: Array;
/**
* 账户id
*/
Uin?: string;
/**
* vip地址
*/
Vip?: string;
/**
* vpc唯一id
*/
VpcId?: string;
/**
* vport端口
*/
Vport?: number;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 主可用区
*/
MasterZone?: string;
/**
* 物理可用区
*/
PhysicalZone?: string;
/**
* 可用区
*/
Zone?: string;
}
/**
* DeleteClusterSaveBackup请求参数结构体
*/
export interface DeleteClusterSaveBackupRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 保留备份文件ID,推荐使用
*/
SaveBackupId?: number;
}
/**
* DescribeSlaveZones请求参数结构体
*/
export interface DescribeSlaveZonesRequest {
/**
* 可用区
*/
Zone: string;
/**
* 云架集群ID
*/
OssClusterId?: number;
/**
* 存储架构类型。枚举值:1.0/2.0 默认值:1.0
*/
StorageVersion?: string;
}
/**
* ModifyLibraDBClusterAccountDescription返回参数结构体
*/
export interface ModifyLibraDBClusterAccountDescriptionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReplayInstanceAuditLog返回参数结构体
*/
export interface ReplayInstanceAuditLogResponse {
/**
* 任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 计费资源信息
*/
export interface BillingResourceInfo {
/**
* 集群ID
*/
ClusterId?: string;
/**
* 实例ID列表
*/
InstanceIds?: Array;
/**
* 订单ID
*/
DealName?: string;
}
/**
* 实例权重
*/
export interface InstanceNameWeight {
/**
* 实例名称,创建集群中InstanceInitInfo.InstanceName所指定名称
*/
InstanceName?: string;
/**
* 权重
*/
Weight?: number;
}
/**
* DescribeBackupDownloadRestriction返回参数结构体
*/
export interface DescribeBackupDownloadRestrictionResponse {
/**
* 集群备份下载限制
注意:此字段可能返回 null,表示取不到有效值。
*/
BackupLimitClusterRestrictions?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceCLSLogDelivery请求参数结构体
*/
export interface DescribeInstanceCLSLogDeliveryRequest {
/**
* 实例id
*/
InstanceId: string;
/**
* 日志类型
*/
LogType?: string;
}
/**
* UpgradeInstance返回参数结构体
*/
export interface UpgradeInstanceResponse {
/**
* 冻结流水ID
*/
TranId?: string;
/**
* 大订单号
*/
BigDealIds?: Array;
/**
* 订单号
*/
DealNames?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* IsolateLibraDBCluster返回参数结构体
*/
export interface IsolateLibraDBClusterResponse {
/**
* flow id
*/
FlowId?: number;
/**
* 返回订单号
*/
DealNames?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAuditRuleTemplate返回参数结构体
*/
export interface CreateAuditRuleTemplateResponse {
/**
* 生成的规则模板ID。
*/
RuleTemplateId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeResourcePackageList请求参数结构体
*/
export interface DescribeResourcePackageListRequest {
/**
* 资源包唯一ID
*/
PackageId?: Array;
/**
* 资源包名称
*/
PackageName?: Array;
/**
* 资源包类型
CCU-计算资源包,DISK-存储资源包
*/
PackageType?: Array;
/**
* 资源包使用地域
china-中国内地通用,overseas-港澳台及海外通用
*/
PackageRegion?: Array;
/**
* 资源包状态
creating-创建中;
using-使用中;
expired-已过期;
normal_finish-使用完;
apply_refund-申请退费中;
refund-已退费。
*/
Status?: Array;
/**
* 排序条件,支持排序条件:startTime-生效时间,
expireTime-过期时间,packageUsedSpec-使用容量,packageTotalSpec-总存储量。
按照数组顺序排列;
*/
OrderBy?: Array;
/**
* 排序方式,DESC-降序,ASC-升序
*/
OrderDirection?: string;
/**
* 偏移量
*/
Offset?: number;
/**
* 限制
*/
Limit?: number;
}
/**
* TransferClusterZone请求参数结构体
*/
export interface TransferClusterZoneRequest {
/**
* 源集群Id
*/
ClusterId: string;
/**
* 目标可用区
*/
DstZone: string;
/**
* 跨可用区迁移主从数据延迟校验阈值,单位毫秒(ms)
*/
MaxLag: number;
/**
* Immediate:立即执行,InMaintain:时间窗口执行
*/
TransferType: string;
/**
* 多可用区备区
*/
DstSlaveZone?: string;
/**
* proxy迁移的目标可用区信息
*/
ProxyZones?: Array;
}
/**
* CloseSSL返回参数结构体
*/
export interface CloseSSLResponse {
/**
* 流程ID
*/
FlowId?: number;
/**
* 任务id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OfflineLibraDBCluster返回参数结构体
*/
export interface OfflineLibraDBClusterResponse {
/**
* flow id
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RevokeAccountPrivileges请求参数结构体
*/
export interface RevokeAccountPrivilegesRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 账号信息
*/
Account: InputAccount;
/**
* 数据库表权限数组
*/
DbTablePrivileges: Array;
/**
* 数据库表信息
*/
DbTables: Array;
}
/**
* OpenClusterPasswordComplexity返回参数结构体
*/
export interface OpenClusterPasswordComplexityResponse {
/**
* 任务流ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBackupListByVault返回参数结构体
*/
export interface DescribeBackupListByVaultResponse {
/**
* 符合条件的备份文件总数
*/
TotalCount?: number;
/**
* 备份文件列表
*/
BackupList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAuditRuleTemplates请求参数结构体
*/
export interface DescribeAuditRuleTemplatesRequest {
/**
* 规则模板ID。
*/
RuleTemplateIds?: Array;
/**
* 规则模板名称
*/
RuleTemplateNames?: Array;
/**
* 单次请求返回的数量。默认值20。
*/
Limit?: number;
/**
* 偏移量,默认值为 0。
*/
Offset?: number;
/**
* 告警等级。1-低风险,2-中风险,3-高风险。
*/
AlarmLevel?: number;
/**
* 告警策略。0-不告警,1-告警。
*/
AlarmPolicy?: number;
}
/**
* 实例可售卖规格详细信息,创建实例时Cpu/Memory确定实例规格,存储可选大小为[MinStorageSize,MaxStorageSize]
*/
export interface InstanceSpec {
/**
* 实例CPU,单位:核
*/
Cpu?: number;
/**
* 实例内存,单位:GB
*/
Memory?: number;
/**
* 实例最大可用存储,单位:GB
*/
MaxStorageSize?: number;
/**
* 实例最小可用存储,单位:GB
*/
MinStorageSize?: number;
/**
* 是否有库存
*/
HasStock?: boolean;
/**
* 机器类型
*/
MachineType?: string;
/**
* 最大IOPS
*/
MaxIops?: number;
/**
* 最大IO带宽
*/
MaxIoBandWidth?: number;
/**
* 地域库存信息
*/
ZoneStockInfos?: Array;
/**
* 库存数量
*/
StockCount?: number;
/**
* 最大cpu
*/
MaxCpu?: number;
/**
* 最小cpu
*/
MinCpu?: number;
}
/**
* AddServerlessRoInstances返回参数结构体
*/
export interface AddServerlessRoInstancesResponse {
/**
* 冻结流水,一次开通一个冻结流水
注意:此字段可能返回 null,表示取不到有效值。
*/
TranId?: string;
/**
* 后付费订单号
注意:此字段可能返回 null,表示取不到有效值。
*/
DealNames?: Array;
/**
* 发货资源id列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceIds?: Array;
/**
* 大订单号
注意:此字段可能返回 null,表示取不到有效值。
*/
BigDealIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyServerlessStrategy请求参数结构体
*/
export interface ModifyServerlessStrategyRequest {
/**
* serverless集群id
*/
ClusterId: string;
/**
* 集群是否自动暂停,可选范围
yesno
*/
AutoPause?: string;
/**
* 集群自动暂停的延迟,单位秒,可选范围[600,691200],默认600
*/
AutoPauseDelay?: number;
/**
* 该参数暂时无效
*/
AutoScaleUpDelay?: number;
/**
* 该参数暂时无效
*/
AutoScaleDownDelay?: number;
/**
* cpu最小值,可选范围参考DescribeServerlessInstanceSpecs接口返回
*/
MinCpu?: number;
/**
* cpu最大值,可选范围参考DescribeServerlessInstanceSpecs接口返回
*/
MaxCpu?: number;
/**
* 只读实例cpu最小值,可选范围参考DescribeServerlessInstanceSpecs接口返回
*/
MinRoCpu?: number;
/**
* 只读cpu最大值,可选范围参考DescribeServerlessInstanceSpecs接口返回
*/
MaxRoCpu?: number;
/**
* 只读节点最小个数
*/
MinRoCount?: number;
/**
* 只读节点最大个数
*/
MaxRoCount?: number;
/**
* 是否开启归档,可选范围
yesno默认值:yes
*/
AutoArchive?: string;
/**
* 升级类型。 默认值:upgradeImmediate。 可选值: upgradeImmediate:立即完成修改 upgradeInMaintain:在维护时间窗口内完成修改
*/
UpgradeType?: string;
/**
* 新增的只读实例需要绑定的安全组列表。仅仅针对于在这次调整策略过程中新产生的只读实例绑定安全组,存量的实例不绑定。
*/
SecurityGroupIdsForNewRo?: Array;
}
/**
* DescribeBinlogConfig返回参数结构体
*/
export interface DescribeBinlogConfigResponse {
/**
* Binlog跨地域配置更新时间
*/
BinlogCrossRegionsConfigUpdateTime?: string;
/**
* Binlog配置信息
*/
BinlogConfig?: BinlogConfigInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 系统支持的模块
*/
export interface Module {
/**
* 是否支持,可选值:yes,no
*/
IsDisable: string;
/**
* 模块名
*/
ModuleName: string;
}
/**
* 回档数据库及表
*/
export interface RollbackTable {
/**
* 数据库名称
*/
Database: string;
/**
* 数据库表
*/
Tables: Array;
}
/**
* 售卖地域信息
*/
export interface SaleRegion {
/**
* 地域英文名
*/
Region: string;
/**
* 地域数字ID
*/
RegionId: number;
/**
* 地域中文名
*/
RegionZh: string;
/**
* 可售卖可用区列表
*/
ZoneSet: Array;
/**
* 引擎类型
*/
DbType: string;
/**
* 地域模块支持情况
*/
Modules: Array;
}
/**
* DescribeSSLStatus请求参数结构体
*/
export interface DescribeSSLStatusRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID
*/
InstanceId?: string;
}
/**
* TDSQL-C MySQL支持的proxy版本信息
*/
export interface ProxyVersionInfo {
/**
* proxy版本号
*/
ProxyVersion?: string;
/**
* 版本描述:GA:稳定版 BETA:尝鲜版,DEPRECATED:过旧,
*/
ProxyVersionType?: string;
}
/**
* DeleteAuditLogFile请求参数结构体
*/
export interface DeleteAuditLogFileRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 审计日志文件名称。
*/
FileName: string;
}
/**
* DescribeIsolatedInstances返回参数结构体
*/
export interface DescribeIsolatedInstancesResponse {
/**
* 实例个数
*/
TotalCount?: number;
/**
* 实例列表
*/
InstanceSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLibraDBSlowLogs返回参数结构体
*/
export interface DescribeLibraDBSlowLogsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 参数修改记录
*/
export interface ClusterParamModifyLog {
/**
* 参数名称
*/
ParamName?: string;
/**
* 当前值
*/
CurrentValue?: string;
/**
* 修改后的值
*/
UpdateValue?: string;
/**
* 修改状态
*/
Status?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 实例ID
*/
InstanceId?: string;
}
/**
* 逻辑备份配置信息
*/
export interface LogicBackupConfigInfo {
/**
* 是否开启自动逻辑备份
*/
LogicBackupEnable?: string;
/**
* 自动逻辑备份开始时间
*/
LogicBackupTimeBeg?: number;
/**
* 自动逻辑备份结束时间
*/
LogicBackupTimeEnd?: number;
/**
* 自动逻辑备份保留时间