tencentcloud-sdk-nodejs
Version:
2,800 lines (2,795 loc) • 387 kB
TypeScript
/**
* 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<InstanceCLSDeliveryInfo>;
/**
* 唯一请求 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<string>;
}
/**
* DescribeZones请求参数结构体
*/
export interface DescribeZonesRequest {
/**
* 是否包含虚拟区
*/
IncludeVirtualZones?: boolean;
/**
* 是否展示地域下所有可用区，并显示用户每个可用区权限
*/
ShowPermission?: boolean;
}
/**
* 实例参数修改任务详情
*/
export interface BizTaskModifyInstanceParam {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 实例参数修改任务详情
*/
ModifyInstanceParamList?: Array<ModifyParamItem>;
}
/**
* ModifyClusterReadOnly返回参数结构体
*/
export interface ModifyClusterReadOnlyResponse {
/**
* 集群任务ID列表
*/
ClusterTaskIds?: Array<ClusterTaskId>;
/**
* 唯一请求 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<PackageDetail>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLibraDBClusterDataSource请求参数结构体
*/
export interface ModifyLibraDBClusterDataSourceRequest {
/**
* 分析集群ID
*/
ClusterId: string;
/**
* 只读分析引擎实例ID
*/
InstanceId: string;
/**
* 源端信息
*/
SrcInfo?: Array<LibraDBClusterSrcInfo>;
}
/**
* 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<CreateBackupVaultItem>;
}
/**
* DescribeClusterParams返回参数结构体
*/
export interface DescribeClusterParamsResponse {
/**
* 参数个数
*/
TotalCount?: number;
/**
* 实例参数列表
*/
Items?: Array<ParamInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RefundResourcePackage返回参数结构体
*/
export interface RefundResourcePackageResponse {
/**
* 每个物品对应一个dealName，业务需要根据dealName保证发货接口幂等
*/
DealNames?: Array<string>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyInstanceName返回参数结构体
*/
export interface ModifyInstanceNameResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeParamTemplates请求参数结构体
*/
export interface DescribeParamTemplatesRequest {
/**
* 数据库引擎版本号
*/
EngineVersions?: Array<string>;
/**
* 模板名称
*/
TemplateNames?: Array<string>;
/**
* 模板ID
*/
TemplateIds?: Array<number | bigint>;
/**
* 数据库类型，可选值：NORMAL，SERVERLESS
*/
DbModes?: Array<string>;
/**
* 查询偏移量
*/
Offset?: number;
/**
* 查询限制条数
*/
Limit?: number;
/**
* 查询的模板对应的产品类型
*/
Products?: Array<string>;
/**
* 模板类型
*/
TemplateTypes?: Array<string>;
/**
* 版本类型
*/
EngineTypes?: Array<string>;
/**
* 返回结果的排序字段
*/
OrderBy?: string;
/**
* 排序方式（asc、desc）
*/
OrderDirection?: string;
}
/**
* DescribeBackupOverview请求参数结构体
*/
export interface DescribeBackupOverviewRequest {
/**
* 集群id
*/
ClusterId: string;
}
/**
* DescribeAuditInstanceList返回参数结构体
*/
export interface DescribeAuditInstanceListResponse {
/**
* 符合查询条件的实例总数。
*/
TotalCount?: number;
/**
* 审计实例详细信息列表。
注意：此字段可能返回 null，表示取不到有效值。
*/
Items?: Array<InstanceAuditStatus>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeVaultBackupClusterInfo返回参数结构体
*/
export interface DescribeVaultBackupClusterInfoResponse {
/**
* 保险箱信息
*/
ClusterInfos?: Array<DescribeVaultBackupClusterInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSlaveZones返回参数结构体
*/
export interface DescribeSlaveZonesResponse {
/**
* 从可用区
*/
SlaveZones?: Array<string>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProxies返回参数结构体
*/
export interface DescribeProxiesResponse {
/**
* <p>数据库代理组数</p>
*/
TotalCount?: number;
/**
* <p>数据库代理组列表</p>
*/
ProxyGroupInfos?: Array<ProxyGroupInfo>;
/**
* <p>数据库代理节点</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
ProxyNodeInfos?: Array<ProxyNodeInfo>;
/**
* <p>sql自动转发</p>
*/
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<LibraDBClusterSet>;
/**
* 集群数量
*/
TotalCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InquirePriceMultiSpec请求参数结构体
*/
export interface InquirePriceMultiSpecRequest {
/**
* 可用区,每个地域提供最佳实践
*/
Zone: string;
/**
* 实例购买类型，可选值为：PREPAID, POSTPAID, SERVERLESS
*/
InstancePayMode: string;
/**
* 存储购买类型，可选值为：PREPAID, POSTPAID
*/
StoragePayMode: string;
/**
* 商品规格
*/
GoodsSpecs: Array<GoodsSpec>;
}
/**
* 回档RO组信息
*/
export interface RollbackRoGroupInfo {
/**
* 实例组ID
*/
InstanceGroupId?: string;
/**
* vpc信息
*/
UniqVpcId?: string;
/**
* 子网信息
*/
UniqSubnetId?: string;
/**
* vip信息
*/
Vip?: string;
/**
* vport信息
*/
Vport?: number;
}
/**
* CreateClusters返回参数结构体
*/
export interface CreateClustersResponse {
/**
* <p>冻结流水ID</p>
*/
TranId?: string;
/**
* <p>订单号</p>
*/
DealNames?: Array<string>;
/**
* <p>资源ID列表（该字段已不再维护，请使用dealNames字段查询接口DescribeResourcesByDealName获取资源ID）</p>
*/
ResourceIds?: Array<string>;
/**
* <p>集群ID列表（该字段已不再维护，请使用dealNames字段查询接口DescribeResourcesByDealName获取集群ID）</p>
*/
ClusterIds?: Array<string>;
/**
* <p>大订单号</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
BigDealIds?: Array<string>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 访问代理配置
*/
export interface ProxyConfigInfo {
/**
* 数据库代理组节点个数。该参数不再建议使用,建议使用ProxyZones
*/
ProxyCount?: number;
/**
* cpu核数
*/
Cpu?: number;
/**
* 内存
*/
Mem?: number;
/**
* 描述说明
*/
Description?: string;
/**
* 数据库节点信息（该参数与ProxyCount需要任选一个输入）
*/
ProxyZones?: Array<ProxyZone>;
}
/**
* 实例组信息
*/
export interface CynosdbInstanceGrp {
/**
* 用户appId
*/
AppId?: number;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 创建时间
*/
CreatedTime?: string;
/**
* 删除时间
*/
DeletedTime?: string;
/**
* 实例组ID
*/
InstanceGrpId?: string;
/**
* 状态
*/
Status?: string;
/**
* 实例组类型。ha-ha组；ro-只读组
*/
Type?: string;
/**
* 更新时间
*/
UpdatedTime?: string;
/**
* 内网IP
*/
Vip?: string;
/**
* 内网端口
*/
Vport?: number;
/**
* 外网域名
*/
WanDomain?: string;
/**
* 外网ip
*/
WanIP?: string;
/**
* 外网端口
*/
WanPort?: number;
/**
* 外网状态
*/
WanStatus?: string;
/**
* 实例组包含实例信息
*/
InstanceSet?: Array<CynosdbInstance>;
/**
* VPC的ID
注意：此字段可能返回 null，表示取不到有效值。
*/
UniqVpcId?: string;
/**
* 子网ID
注意：此字段可能返回 null，表示取不到有效值。
*/
UniqSubnetId?: string;
/**
* 正在回收IP信息
注意：此字段可能返回 null，表示取不到有效值。
*/
OldAddrInfo?: OldAddrInfo;
/**
* 正在进行的任务
*/
ProcessingTasks?: Array<string>;
/**
* 任务列表
*/
Tasks?: Array<ObjectTask>;
/**
* biz_net_service表id
*/
NetServiceId?: number;
}
/**
* ModifyInstanceParam请求参数结构体
*/
export interface ModifyInstanceParamRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 实例ID
*/
InstanceIds?: Array<string>;
/**
* 集群参数列表，例如 [{ "CurrentValue":"2", "ParamName":"auto_increment_increment"}]
*/
ClusterParamList?: Array<ModifyParamItem>;
/**
* 实例参数列表，例如[{ "CurrentValue":"2", "ParamName":"innodb_stats_transient_sample_pages"}]
*/
InstanceParamList?: Array<ModifyParamItem>;
/**
* yes：在运维时间窗内修改，no：立即执行（默认值）
*/
IsInMaintainPeriod?: string;
}
/**
* ModifyInstanceUpgradeLimitDays返回参数结构体
*/
export interface ModifyInstanceUpgradeLimitDaysResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLibraDBClusters返回参数结构体
*/
export interface CreateLibraDBClustersResponse {
/**
* 预付费总订单号
*/
BigDealIds?: Array<string>;
/**
* 集群ID
*/
ClusterIds?: Array<string>;
/**
* 每个资源对应一个dealName，业务需要根据dealName保证发货接口幂等
*/
DealNames?: Array<string>;
/**
* 冻结流水
*/
TranId?: string;
/**
* 实例id
*/
ResourceIds?: Array<string>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据库表信息
*/
export interface DatabaseTables {
/**
* 数据库名
*/
Database?: string;
/**
* 表名称列表
*/
Tables?: Array<string>;
}
/**
* 用户主机权限
*/
export interface UserHostPrivilege {
/**
* 授权用户
*/
DbUserName: string;
/**
* 客户端ip
*/
DbHost: string;
/**
* 用户权限
*/
DbPrivilege: string;
}
/**
* StopCLSDelivery请求参数结构体
*/
export interface StopCLSDeliveryRequest {
/**
* 实例id
*/
InstanceId: string;
/**
* 日志主题id
*/
CLSTopicIds: Array<string>;
/**
* 日志类型
*/
LogType?: string;
/**
* 是否维护时间运行
*/
IsInMaintainPeriod?: string;
}
/**
* 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;
/**
* 排序字段，取值范围：
<li> CREATETIME：创建时间</li>
<li> PERIODENDTIME：过期时间</li>
*/
OrderBy?: string;
/**
* 排序类型，取值范围：
<li> ASC：升序排序 </li>
<li> DESC：降序排序 </li>
*/
OrderByType?: string;
/**
* 搜索条件，若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
*/
Filters?: Array<QueryFilter>;
}
/**
* DescribeSQLExecutionPlan请求参数结构体
*/
export interface DescribeSQLExecutionPlanRequest {
/**
* <p>集群ID</p>
*/
ClusterId: string;
/**
* <p>实例ID</p>
*/
InstanceId: string;
/**
* <p>SQL模板ID</p>
*/
TemplateID: string;
/**
* <p>计划详情序列号</p>
*/
PlanDetailId: number;
}
/**
* OpenReadOnlyInstanceExclusiveAccess返回参数结构体
*/
export interface OpenReadOnlyInstanceExclusiveAccessResponse {
/**
* 开通流程ID
*/
FlowId?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SearchClusterDatabases返回参数结构体
*/
export interface SearchClusterDatabasesResponse {
/**
* 数据库列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Databases?: Array<string>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateParamTemplate请求参数结构体
*/
export interface CreateParamTemplateRequest {
/**
* 模板名称
*/
TemplateName: string;
/**
* mysql版本号
*/
EngineVersion: string;
/**
* 模板描述
*/
TemplateDescription?: string;
/**
* 可选参数，需要复制的模板ID
*/
TemplateId?: number;
/**
* 数据库类型，可选值：NORMAL（默认值），SERVERLESS
*/
DbMode?: string;
/**
* 参数列表
*/
ParamList?: Array<ParamItem>;
}
/**
* 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<DatabaseTables>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterDetail请求参数结构体
*/
export interface DescribeClusterDetailRequest {
/**
* 集群Id
*/
ClusterId: string;
}
/**
* CopyBackupToVault返回参数结构体
*/
export interface CopyBackupToVaultResponse {
/**
* <p>任务ID</p>
*/
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<ProxyZone>;
/**
* 重新负载均衡
*/
ReloadBalance?: string;
}
/**
* DescribeClusterPeriodScalePolicy返回参数结构体
*/
export interface DescribeClusterPeriodScalePolicyResponse {
/**
* 集群周期弹性策略列表
*/
PolicyList?: Array<ClusterPeriodScalePolicy>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenAIOptimizer请求参数结构体
*/
export interface OpenAIOptimizerRequest {
/**
* <p>集群ID</p>
*/
ClusterId: string;
/**
* <p>实例ID</p>
*/
InstanceId: string;
}
/**
* ModifyBackupName返回参数结构体
*/
export interface ModifyBackupNameResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 备份文件信息
*/
export interface BackupFileInfo {
/**
* <p>快照文件ID，已废弃，请使用BackupId</p>
*/
SnapshotId?: number;
/**
* <p>备份文件名</p>
*/
FileName?: string;
/**
* <p>备份文件大小</p>
*/
FileSize?: number;
/**
* <p>备份开始时间</p>
*/
StartTime?: string;
/**
* <p>备份完成时间</p>
*/
FinishTime?: string;
/**
* <p>备份类型：snapshot，快照备份；logic，逻辑备份</p>
*/
BackupType?: string;
/**
* <p>备份方式：auto，自动备份；manual，手动备份</p>
*/
BackupMethod?: string;
/**
* <p>备份文件状态：success：备份成功；fail：备份失败；creating：备份文件创建中；deleting：备份文件删除中</p>
*/
BackupStatus?: string;
/**
* <p>备份文件时间</p>
*/
SnapshotTime?: string;
/**
* <p>备份ID</p>
*/
BackupId?: number;
/**
* <p>快照类型，可选值：full，全量；increment，增量</p>
*/
SnapShotType?: string;
/**
* <p>备份文件备注</p>
*/
BackupName?: string;
/**
* <p>投递状态</p>
*/
CopyStatus?: string;
/**
* <p>秘钥id</p>
*/
EncryptKeyId?: string;
/**
* <p>秘钥地域</p>
*/
EncryptRegion?: string;
/**
* <p>保险箱信息</p>
*/
VaultInfos?: Array<VaultInfo>;
/**
* <p>备份周期策略</p>
*/
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<ProxyZone>;
/**
* 是否滚动升级
*/
IsRollUpgrade?: string;
/**
* 滚动升级等待时间，单位：秒
*/
RollUpgradeWaitingTime?: number;
}
/**
* DescribeBinlogDownloadUrl返回参数结构体
*/
export interface DescribeBinlogDownloadUrlResponse {
/**
* 下载地址
*/
DownloadUrl?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLibraDBInstanceSpecs返回参数结构体
*/
export interface DescribeLibraDBInstanceSpecsResponse {
/**
* 该地域实例规格信息列表
注意：此字段可能返回 null，表示取不到有效值。
*/
InstanceSpecSet?: Array<RegionInstanceSpecInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 稀疏备份配置
*/
export interface SparseBackupConfig {
/**
* 稀疏备份开关：ON/OFF
*/
SparseBackupSwitch?: string;
/**
* 稀疏备份策略列表（1-3条）
*/
SparseBackupConfigInfos?: Array<SparseBackupConfigInfo>;
}
/**
* 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 {
/**
* <p>用户Uin</p>
*/
Uin?: string;
/**
* <p>用户AppId</p>
*/
AppId?: number;
/**
* <p>集群ID</p>
*/
ClusterId?: string;
/**
* <p>集群名称</p>
*/
ClusterName?: string;
/**
* <p>实例ID</p>
*/
InstanceId?: string;
/**
* <p>实例名称</p>
*/
InstanceName?: string;
/**
* <p>项目ID</p>
*/
ProjectId?: number;
/**
* <p>地域</p>
*/
Region?: string;
/**
* <p>可用区</p>
*/
Zone?: string;
/**
* <p>实例状态</p>
*/
Status?: string;
/**
* <p>实例状态中文描述</p>
*/
StatusDesc?: string;
/**
* <p>实例形态，是否为serverless实例</p>
*/
DbMode?: string;
/**
* <p>数据库类型</p>
*/
DbType?: string;
/**
* <p>数据库版本</p>
*/
DbVersion?: string;
/**
* <p>Cpu，单位：核</p>
*/
Cpu?: number;
/**
* <p>内存，单位：GB</p>
*/
Memory?: number;
/**
* <p>存储量，单位：GB</p>
*/
Storage?: number;
/**
* <p>实例类型</p><p>枚举值：</p><ul><li>rw： 读写实例</li><li>ro： 只读实例</li></ul>
*/
InstanceType?: string;
/**
* <p>实例当前角色</p>
*/
InstanceRole?: string;
/**
* <p>更新时间</p>
*/
UpdateTime?: string;
/**
* <p>创建时间</p>
*/
CreateTime?: string;
/**
* <p>VPC网络ID</p>
*/
VpcId?: string;
/**
* <p>子网ID</p>
*/
SubnetId?: string;
/**
* <p>实例内网IP</p>
*/
Vip?: string;
/**
* <p>实例内网端口</p>
*/
Vport?: number;
/**
* <p>付费模式</p>
*/
PayMode?: number;
/**
* <p>实例过期时间</p>
*/
PeriodEndTime?: string;
/**
* <p>销毁期限</p>
*/
DestroyDeadlineText?: string;
/**
* <p>隔离时间</p>
*/
IsolateTime?: string;
/**
* <p>网络类型</p>
*/
NetType?: number;
/**
* <p>外网域名</p>
*/
WanDomain?: string;
/**
* <p>外网IP</p>
*/
WanIP?: string;
/**
* <p>外网端口</p>
*/
WanPort?: number;
/**
* <p>外网状态</p>
*/
WanStatus?: string;
/**
* <p>实例销毁时间</p>
*/
DestroyTime?: string;
/**
* <p>Cynos内核版本</p>
*/
CynosVersion?: string;
/**
* <p>正在处理的任务</p>
*/
ProcessingTask?: string;
/**
* <p>续费标志</p>
*/
RenewFlag?: number;
/**
* <p>serverless实例cpu下限</p>
*/
MinCpu?: number;
/**
* <p>serverless实例cpu上限</p>
*/
MaxCpu?: number;
/**
* <p>serverless实例状态, 可选值：<br>resume<br>pause</p>
*/
ServerlessStatus?: string;
/**
* <p>预付费存储Id</p>
*/
StorageId?: string;
/**
* <p>存储付费类型</p>
*/
StoragePayMode?: number;
/**
* <p>物理区</p>
*/
PhysicalZone?: string;
/**
* <p>商业类型</p>
*/
BusinessType?: string;
/**
* <p>任务</p>
*/
Tasks?: Array<ObjectTask>;
/**
* <p>是否冻结</p>
*/
IsFreeze?: string;
/**
* <p>资源标签</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceTags?: Array<Tag>;
/**
* <p>主可用区</p>
*/
MasterZone?: string;
/**
* <p>备可用区</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
SlaveZones?: Array<string>;
/**
* <p>实例网络信息</p>
*/
InstanceNetInfo?: Array<InstanceNetInfo>;
/**
* <p>实例绑定资源包信息（此处只返回计算资源包，即packageType=CCU）</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourcePackages?: Array<ResourcePackage>;
/**
* <p>实例索引形态,可选值【mixedRowColumn（行列混存），onlyRowIndex（仅行存）】</p>
*/
InstanceIndexMode?: string;
/**
* <p>当前实例支持的能力</p>
*/
InstanceAbility?: InstanceAbility;
/**
* <p>实例机器类型</p><ol><li>common，通用型。</li><li>exclusive，独享型。</li></ol>
*/
DeviceType?: string;
/**
* <p>实例存储类型</p>
*/
InstanceStorageType?: string;
/**
* <p>未知字段</p>
*/
CynosVersionTag?: string;
/**
* <p>libradb 节点信息</p>
*/
NodeList?: Array<string>;
/**
* <p>全球数据库唯一标识</p>
*/
GdnId?: string;
}
/**
* DescribeClusterPasswordComplexity返回参数结构体
*/
export interface DescribeClusterPasswordComplexityResponse {
/**
* 数据字典参数
*/
ValidatePasswordDictionary?: ParamInfo;
/**
* 密码长度
*/
ValidatePasswordLength?: ParamInfo;
/**
* 大小写敏感字符个数
*/
ValidatePasswordMixedCaseCount?: ParamInfo;
/**
* 数字个数
*/
ValidatePasswordNumberCount?: ParamInfo;
/**
* 密码等级
*/
ValidatePasswordPolicy?: ParamInfo;
/**
* 特殊字符个数
*/
ValidatePasswordSpecialCharCount?: ParamInfo;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAuditRuleWithInstanceIds请求参数结构体
*/
export interface DescribeAuditRuleWithInstanceIdsRequest {
/**
* 实例ID。目前仅支持单个实例的查询。
*/
InstanceIds: Array<string>;
}
/**
* DescribeClusterDatabases返回参数结构体
*/
export interface DescribeClusterDatabasesResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* 分页偏移
*/
Offset?: number;
/**
* 数据库列表
*/
Databases?: Array<string>;
/**
* 分页限制数
*/
Limit?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 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<string>;
/**
* 参数名搜索条件，支持模糊匹配
*/
ParamKeyword?: string;
/**
* 是否为全局参数
*/
IsGlobal?: string;
}
/**
* ModifyBinlogSaveDays请求参数结构体
*/
export interface ModifyBinlogSaveDaysRequest {
/**
* <p>集群ID</p>
*/
ClusterId: string;
/**
* <p>Binlog保留天数</p>
*/
BinlogSaveDays: number;
/**
* <p>跨地域备份保留时间</p><p>单位：天</p>
*/
BinlogCrossRegionSaveDays?: number;
}
/**
* 数据库代理规格
*/
export interface ProxySpec {
/**
* 数据库代理cpu核数
*/
Cpu?: number;
/**
* 数据库代理内存
*/
Mem?: number;
}
/**
* AddInstances返回参数结构体
*/
export interface AddInstancesResponse {
/**
* <p>冻结流水，一次开通一个冻结流水。</p>
*/
TranId?: string;
/**
* <p>付费的订单号。说明：建议您使用 <a href="https://cloud.tencent.com/document/product/1003/52131">DescribeResourcesByDealName</a> 接口查询订单关联实例。</p>
*/
DealNames?: Array<string>;
/**
* <p>发货资源id列表。</p>
* @deprecated
*/
ResourceIds?: Array<string>;
/**
* <p>大订单号</p>
*/
BigDealIds?: Array<string>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSaveBackupClusters返回参数结构体
*/
export interface DescribeSaveBackupClustersResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* 遗留备份信息
*/
SaveBackupClusterInfos?: Array<SaveBackupClusterInfo>;
/**
* 唯一请求 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<string>;
}
/**
* DescribeBinlogListByVault请求参数结构体
*/
export interface DescribeBinlogListByVaultRequest {
/**
* 保险箱ID
*/
VaultId: string;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 备份ID列表
*/
BackupIds?: Array<number | bigint>;
/**
* 备份名称列表
*/
BackupNames?: Array<string>;
/**
* 文件名列表
*/
FileNames?: Array<string>;
/**
* 返回数量，范围: (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<ProxyNodeInfo>;
/**
* 数据库代理连接池信息
*/
ConnectionPool?: ProxyConnectionPoolInfo;
/**
* 数据库代理网络信息
注意：此字段可能返回 null，表示取不到有效值。
*/
NetAddrInfos?: Array<NetAddr>;
/**
* 数据库代理任务集
*/
Tasks?: Array<ObjectTask>;
}
/**
* AssociateSecurityGroups返回参数结构体
*/
export interface AssociateSecurityGroupsResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateProxyEndPoint请求参数结构体
*/
export interface CreateProxyEndPointRequest {
/**
* <p>集群 ID。</p>
*/
ClusterId: string;
/**
* <p>私有网络 ID。</p>
*/
UniqueVpcId: string;
/**
* <p>私有网络子网 ID。</p>
*/
UniqueSubnetId: string;
/**
* <p>连接池类型：SessionConnectionPool（会话级别连接池）。</p>
*/
ConnectionPoolType?: string;
/**
* <p>是否开启连接池。<br>yes：表示开启。<br>no：表示不开启。</p>
*/
OpenConnectionPool?: string;
/**
* <p>连接池阈值：单位（秒），可选范围：0 - 300秒。</p>
*/
ConnectionPoolTimeOut?: number;
/**
* <p>绑定的安全组 ID 数组。</p>
*/
SecurityGroupIds?: Array<string>;
/**
* <p>描述说明。</p>
*/
Description?: string;
/**
* <p>想要绑定的 vip 信息，需与 UniqueVpcId 对应。</p>
*/
Vip?: string;
/**
* <p>权重模式：<br>system：系统分配。<br>custom：自定义。</p>
*/
WeightMode?: string;
/**
* <p>是否自动添加只读实例。<br>yes：表示自动添加只读实例。<br>no：表示不自动添加只读实例。</p>
*/
AutoAddRo?: string;
/**
* <p>是否开启故障转移。<br>yes：表示开启，开启后，当数据库代理出现故障时，连接地址将会路由到主实例。<br>no：表示不开启。<br>说明：<br>仅当 RwType 参数值为 READWRITE 时，才支持设置此项。</p>
*/
FailOver?: string;
/**
* <p>一致性类型：<br>eventual：最终一致性。<br>global：全局一致性。<br>session：会话一致性。<br>说明：<br>仅当 RwType 参数值为 READWRITE 时，才支持设置此项。</p>
*/
ConsistencyType?: string;
/**
* <p>读写属性：<br>READWRITE：表示读写分离。当此参数值为 READWRITE 时，才支持设置 FailOver、ConsistencyType 参数。<br>READONLY：表示只读。</p>
*/
RwType?: string;
/**
* <p>一致性超时时间。取值范围：0 ~ 1000000（微秒）。设置为0时，表示若只读实例出现延迟导致一致性策略不满足时，请求将一直等待。</p>
*/
ConsistencyTimeOut?: number;
/**
* <p>是否开启事务拆分。开启后，在一个事务中拆分读和写到不同的实例上去执行。</p>
*/
TransSplit?: boolean;
/**
* <p>接入模式：<br>nearby：就近访问。<br>balance：均衡分配。</p>
*/
AccessMode?: string;
/**
* <p>实例权重。</p>
*/
InstanceWeights?: Array<ProxyInstanceWeight>;
/**
* <p>负载均衡模式</p><p>枚举值：</p><ul><li>static： 静态负载</li><li>dynamic： 动态负载</li></ul>
*/
LoadBalanceMode?: string;
}
/**
* ModifyBackupDownloadUserRestriction返回参数结构体
*/
export interface ModifyBackupDownloadUserRestrictionResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddLibraDBInstances返回参数结构体
*/
export interface AddLibraDBInstancesResponse {
/**
* 大订单号
注意：此字段可能返回 null，表示取不到有效值。
*/
BigDealIds?: Array<string>;
/**
* 冻结流水，一次开通一个冻结流水。
注意：此字段可能返回 null，表示取不到有效值。
*/
TranId?: string;
/**
* 后付费订单号。
注意：此字段可能返回 null，表示取不到有效值。
*/
DealNames?: Array<string>;
/**
* 发货资源id列表。
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceIds?: Array<string>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 审计规则模板的详情
*/
export interface AuditRuleTemplateInfo {
/**
* 规则模板ID。
*/
RuleTemplateId?: string;
/**
* 规则模板名称。
*/
RuleTemplateName?: string;
/**
* 规则模板的过滤条件
*/
RuleFilters?: Array<RuleFilters>;
/**
* 规则模板描述。
*/
Description?: string;
/**
* 规则模板创建时间。
*/
CreateAt?: string;
/**
* 规则模板修改时间。
*/
UpdateAt?: string;
/**
* 告警等级。1-低风险，2-中风险，3-高风险。
*/
AlarmLevel?: number;
/**
* 告警策略。0-不告警，1-告警。
*/
AlarmPolicy?: number;
/**
* 模板状态。0-无任务 ，1-修改中。
*/
Status?: number;
/**
* 规则模板应用在哪些在实例。
*/
AffectedInstances?: Array<string>;
}
/**
* DescribeParamTemplateDetail请求参数结构体
*/
export interface DescribeParamTemplateDetailRequest {
/**
* 参数模板ID
*/
TemplateId: number;
}
/**
* 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<string>;
}
/**
* AI 优化器任务数据
*/
export interface AIOptimizerTaskData {
/**
* <p>模板ID</p>
*/
TemplateID?: string;
}
/**
* redolog信息
*/
export interface DescribeRedoLogListByVaultItem {
/**
* <p>集群ID</p>
*/
ClusterId?: string;
/**
* <p>集群名称</p>
*/
ClusterName?: string;
/**
* <p>RedoLog文件信息</p>
*/
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<ClusterReadOnlyValue>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceSpecs请求参数结构体
*/
export interface DescribeInstanceSpecsRequest {
/**
* <p>数据库类型，取值范围: </p><li> MYSQL </li>
*/
DbType: string;
/**
* <p>是否需要返回可用区信息</p>
*/
IncludeZoneStocks?: boolean;
/**
* <p>实例机器类型</p>
*/
DeviceType?: string;
/**
* <p>集群级别，可空。例如 P0, P1</p>
*/
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<ProxyNodeInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateIntegrateCluster请求参数结构体
*/
export interface CreateIntegrateClusterRequest {
/**
* 可用区
*/
Zone: string;
/**
* 所属VPC网络ID
*/
VpcId: string;
/**
* 所属子网ID
*/
SubnetId: string;
/**
* 数据库版本，取值范围:
<li> MYSQL可选值：5.7，8.0 </li>
*/
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<Tag>;
/**
* 集群存储计费模式，按量计费：0，包年包月：1。默认按量计费
当DbType为MYSQL时，在集群计算计费模式为后付费（包括DbMode为SERVERLESS）时，存储计费模式仅可为按量计费
回档与克隆均不支持包年包月存储
*/
StoragePayMode?: number;
/**
* 安全组id数组
*/
SecurityGroupIds?: Array<string>;
/**
* 告警策略Id数组
*/
AlarmPolicyIds?: Array<string>;
/**
* 参数数组，暂时支持character_set_server （utf8｜latin1｜gbk｜utf8mb4） ，lower_case_table_names，1-大小写不敏感，0-大小写敏感
*/
ClusterParams?: Array<ParamItem>;
/**
* 交易模式，0-下单且支付，1-下单
*/
DealMode?: number;
/**
* 参数模板ID，可以通过查询参数模板信息DescribeParamTemplates获得参数模板ID
*/
ParamTemplateId?: number;
/**
* 多可用区地址
*/
SlaveZone?: string;
/**
* 实例初始化配置信息，主要用于购买集群时选不同规格实例
*/
InstanceInitInfos?: Array<IntegrateInstanceInfo>;
/**
* 全球数据库唯一标识
*/
GdnId?: string;
/**
* 数据库代理配置
*/
ProxyConfig?: ProxyConfigInfo;
/**
* 是否自动归档
*/
AutoArchive?: string;
/**
* 暂停后的归档处理时间
*/
AutoArchiveDelayHours?: number;
/**
* 加密方法（由加密算法和密钥对版本组成）
*/
EncryptMethod?: string;
/**
* 集成集群配置信息
*/
IntegrateCreateClusterConfig?: IntegrateCreateClusterConfig;
/**
* 存储架构类型。 枚举值：1.0/2.0 默认值：1.0
*/
StorageVersion?: string;
}
/**
* 数据库代理组节点
*/
export interface ProxyNodeInfo {
/**
* <p>数据库代理节点ID</p>
*/
ProxyNodeId?: string;
/**
* <p>节点当前连接数, DescribeProxyNodes接口此字段值不返回</p>
*/
ProxyNodeConnections?: number;
/**
* <p>数据库代理节点cpu</p>
*/
Cpu?: number;
/**
* <p>数据库代理节点内存</p>
*/
Mem?: number;
/**
* <p>数据库代理节点状态</p>
*/
Status?: string;
/**
* <p>数据库代理组ID</p>
*/
ProxyGroupId?: string;
/**
* <p>集群ID</p>
*/
ClusterId?: string;
/**
* <p>用户AppID</p>
*/
AppId?: number;
/**
* <p>地域</p>
*/
Region?: string;
/**
* <p>可用区</p>
*/
Zone?: string;
/**
* <p>数据库代理节点名字</p>
*/
OssProxyNodeName?: string;
/**
* <p>创建时间</p>
*/
CreateTime?: string;
/**
* <p>更新时间</p>
*/
UpdateTime?: string;
}
/**
* DescribeZones返回参数结构体
*/
export interface DescribeZonesResponse {
/**
* 地域信息
*/
RegionSet?: Array<SaleRegion>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GrantAccountPrivileges请求参数结构体
*/
export interface GrantAccountPrivilegesRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 账号信息
*/
Account: InputAccount;
/**
* 数据库表权限码数组
*/
DbTablePrivileges: Array<string>;
/**
* 数据库表信息
*/
DbTables: Array<DbTable>;
}
/**
* ModifyPa