/** * CreateDBInstances请求参数结构体 */ export interface CreateDBInstancesRequest { /** *
创建实例区域
*/ Zone: string; /** *字符型vpcid
*/ VpcId: string; /** *字符型subnetid
*/ SubnetId: string; /** *购买规格
*/ SpecCode: string; /** *存储节点磁盘容量,单位GB
*/ Disk: number; /** *存储节点数量
*/ StorageNodeNum: number; /** *存储节点副本数量,最大为5,要求为奇数
*/ Replications: number; /** *创建实例个数,上限为10
*/ InstanceCount: number; /** *全能型副本数量
*/ FullReplications?: number; /** *创建实例版本,默认使用当前最新版本
*/ CreateVersion?: string; /** *实例名称,要求长度1-60,允许包含中文、英文大小写、数字、-、_
*/ InstanceName?: string; /** *标签键值对数组
*/ ResourceTags?: Array初始化实例参数。比如:
character_set_server(字符集,默认为utf8),
lower_case_table_names(表名大小写敏感,0 - 敏感;1-不敏感,默认为0)
时间单位,m:月
*/ TimeUnit?: string; /** *商品的时间大小
*/ TimeSpan?: number; /** *存储节点CPU核数
*/ StorageNodeCpu?: number; /** *存储节点内存大小
*/ StorageNodeMem?: number; /** *付费模式,0表示按需计费/后付费,1表示预付费
*/ PayMode?: string; /** *管控节点数量
*/ MCNum?: number; /** *自定义端口
*/ Vport?: number; /** *多AZ可用区列表
*/ Zones?: Array是否使用优惠卷
*/ AutoVoucher?: boolean; /** *优惠卷列表
*/ VoucherIds?: Array实例架构类型,separate:分离架构;hybrid:对等架构
*/ InstanceType?: string; /** *磁盘类型,CLOUD_HSSD增强型SSD,CLOUD_TCS本地SSD盘
*/ StorageType?: string; /** *AZ模式,1:单AZ,2:多AZ非主AZ,3:多AZ主AZ
*/ AZMode?: number; /** *实例模式
*/ InstanceMode?: string; /** *参数模板id
*/ TemplateId?: string; /** *兼容模式,enum:MySQL,HBase
*/ SQLMode?: string; /** *SVLS 实例的ccu变配配置
入参限制:同时传入 AutoScaleConfigs 时此参数不再生效
*/ AutoScaleConfig?: AutoScalingConfig; /** *绑定安全组列表
*/ SecurityGroupIds?: Arrayroot用户名,当前版本默认为dbaadmin,传值也会重置为dbaadmin
*/ UserName?: string; /** *dbaadmin密码
*/ Password?: string; /** *是否开启透明加密,0:不开启,1:开启
*/ EncryptionEnable?: number; /** *SVLS 实例的自动变配相关限制
入参限制:传入时 AutoScaleConfig 参数不再生效
*/ AutoScaleConfigs?: Array异步任务ID,根据此ID可以调用查询任务接口获取任务状态
*/ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeStandbyDBInstanceRelationDetail返回参数结构体 */ export interface DescribeStandbyDBInstanceRelationDetailResponse { /** * 灾备关系 注意:此字段可能返回 null,表示取不到有效值。 */ RelationInfos?: ArrayZone英文字符串
*/ Zone?: string; /** *Zone中文字符串
*/ ZoneName?: string; /** *是否售卖,1:售卖;0:不售卖
*/ Enable?: number; /** *是否是默认主可用区,0不是,1是
注意:此字段可能返回 null,表示取不到有效值。 */ IsDefaultMaster?: number; /** *可用区可选磁盘类型
注意:此字段可能返回 null,表示取不到有效值。 */ AvailableDiskTypes?: Array是否是独享可用区
*/ SupportTypes?: Array是否支持serverless
*/ IsSupportServerless?: boolean; } /** * 备份方式统计对象,提供给 备份集统计详情 接口 */ export interface BackupMethodStatisticsOutPut { /** *自动备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ AutoBackupSize?: Array手动备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ ManualBackupSize?: Array实例 ID,形如:tdsql3-ow7t8lmc。
*/ InstanceId: string; /** *分页索引
*/ Offset?: number; /** *每页数量
*/ Limit?: number; /** *数据库名称匹配表达式
*/ DatabaseRegexp?: string; } /** * DescribeDBParameters请求参数结构体 */ export interface DescribeDBParametersRequest { /** * 实例 ID,形如:tdsql3-ow728lmc。 */ InstanceId: string; } /** * ModifyInstanceNetwork返回参数结构体 */ export interface ModifyInstanceNetworkResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceSSLStatus返回参数结构体 */ export interface ModifyInstanceSSLStatusResponse { /** *异步流程ID
*/ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBEngines请求参数结构体 */ export type DescribeDBEnginesRequest = null; /** * RestartDBInstances返回参数结构体 */ export interface RestartDBInstancesResponse { /** *异步任务id
*/ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSlowLogs请求参数结构体 */ export interface DescribeSlowLogsRequest { /** * 实例ID */ InstanceId: string; /** * 要检索日志的起始时间 */ StartTime: string; /** * 要检索日志的结束时间 */ EndTime: string; /** * 过滤条件 */ LogFilter?: Array实例ID
*/ InstanceId: string; } /** * 实例列表过滤条件 */ export interface InstanceFilter { /** * 过滤key,支持InstanceId、VpcId、SubnetId、Vip、Vport、Status、InstanceName、TagKey */ Name?: string; /** * 过滤value */ Values?: Array标识符
注意:此字段可能返回 null,表示取不到有效值。 */ ID?: string; /** *查询类型
枚举值:
表名
注意:此字段可能返回 null,表示取不到有效值。 */ Table?: string; /** *分区
注意:此字段可能返回 null,表示取不到有效值。 */ Partitions?: string; /** *访问类型
注意:此字段可能返回 null,表示取不到有效值。 */ Type?: string; /** *可能使用的索引
注意:此字段可能返回 null,表示取不到有效值。 */ PossibleKeys?: string; /** *实际使用的索引
注意:此字段可能返回 null,表示取不到有效值。 */ Key?: string; /** *使用的索引长度
注意:此字段可能返回 null,表示取不到有效值。 */ KeyLen?: string; /** *与索引比较的列或常量
注意:此字段可能返回 null,表示取不到有效值。 */ Ref?: string; /** *估算扫描行数
注意:此字段可能返回 null,表示取不到有效值。 */ Rows?: string; /** *条件过滤后剩余行的估算百分比
注意:此字段可能返回 null,表示取不到有效值。 */ Filtered?: string; /** *附加信息,如 Using index、Using filesort 等
注意:此字段可能返回 null,表示取不到有效值。 */ Extra?: string; } /** * 备份统计对象 */ export interface BackupStatisticsModel { /** *总备份每天平均大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ AverageSizePerDay?: number; /** *数据备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ DataBackupSize?: number; /** *日志备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ LogBackupSize?: number; /** *总备份集个数
注意:此字段可能返回 null,表示取不到有效值。 */ TotalCount?: number; /** *总备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ TotalSize?: number; } /** * ResetUsersPassword请求参数结构体 */ export interface ResetUsersPasswordRequest { /** *实例id
*/ InstanceId: string; /** *重置用户密码列表
*/ Users?: Array备份结束时间
注意:此字段可能返回 null,表示取不到有效值。 */ BackupEndTime?: string; /** *备份方式
注意:此字段可能返回 null,表示取不到有效值。 */ BackupMethod?: string; /** *备份开始时间
注意:此字段可能返回 null,表示取不到有效值。 */ BackupStartTime?: string; /** *引擎类型
注意:此字段可能返回 null,表示取不到有效值。 */ DBType?: string; /** *引擎版本
注意:此字段可能返回 null,表示取不到有效值。 */ DBVersion?: string; /** *是否开启全量备份
注意:此字段可能返回 null,表示取不到有效值。 */ EnableFull?: number; /** *是否开启日志备份
注意:此字段可能返回 null,表示取不到有效值。 */ EnableLog?: number; /** *预计下次备份时间
注意:此字段可能返回 null,表示取不到有效值。 */ ExpectedNextBackupPeriod?: string; /** *全备保留时间
注意:此字段可能返回 null,表示取不到有效值。 */ FullRetentionPeriod?: number; /** *策略ID
注意:此字段可能返回 null,表示取不到有效值。 */ ID?: number; /** *实例ID
注意:此字段可能返回 null,表示取不到有效值。 */ InstanceId?: string; /** *日志保留天数
注意:此字段可能返回 null,表示取不到有效值。 */ LogRetentionPeriod?: number; /** *一周的哪几天进行备份
注意:此字段可能返回 null,表示取不到有效值。 */ PeriodTime?: string; /** *地域
注意:此字段可能返回 null,表示取不到有效值。 */ Region?: string; /** *备份周期类型 0:Weekly
注意:此字段可能返回 null,表示取不到有效值。 */ PeriodType?: number; } /** * ModifyInstanceDataReservedSpace返回参数结构体 */ export interface ModifyInstanceDataReservedSpaceResponse { /** *参数下发 flow 任务 ID(复用 ModifyDBParameters 链路,异步 flow 但秒级生效)
*/ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceSSLStatus请求参数结构体 */ export interface ModifyInstanceSSLStatusRequest { /** *实例ID
*/ InstanceId: string; /** *是否启用SSL
*/ Enabled: boolean; } /** * ResetDbaAdminPrivileges返回参数结构体 */ export interface ResetDbaAdminPrivilegesResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceName返回参数结构体 */ export interface ModifyInstanceNameResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBSBackupStatisticsDetail请求参数结构体 */ export interface DescribeDBSBackupStatisticsDetailRequest { /** *实例ID
*/ InstanceId: string; /** *结束时间
*/ EndTime?: string; /** *开始时间
*/ StartTime?: string; } /** * DescribeDBParameters返回参数结构体 */ export interface DescribeDBParametersResponse { /** * 实例 ID,形如:tdsql3-ow728lmc。 */ InstanceId: string; /** * 请求实例的当前参数值 */ Params: Array规格码
注意:此字段可能返回 null,表示取不到有效值。 */ SpecCode?: string; /** *存储节点CPU核数
*/ StorageNodeCpu?: number; /** *存储节点内存大小
*/ StorageNodeMem?: number; /** *存储节点最大数量
*/ StorageNodeMaxNum?: number; /** *存储节点磁盘大小上限
*/ StorageNodeMaxDisk?: number; /** *存储节点最小数量
*/ StorageNodeMinNum?: number; /** *存储节点磁盘大小下限
*/ StorageNodeMinDisk?: number; /** *磁盘类型,CLOUD_HSSD增强型SSD,CLOUD_TCS本地SSD盘
注意:此字段可能返回 null,表示取不到有效值。 */ StorageType?: string; /** *存储节点默认磁盘大小,用于前端展示
注意:此字段可能返回 null,表示取不到有效值。 */ StorageNodeDefaultDisk?: number; /** *规格支持计费模式列表
*/ InstanceMode?: Array磁盘类型CLOUD_DISK:云盘LOCAL_DISK:本地盘
*/ DiskTypeCategory?: string; } /** * DescribeDBCharsets返回参数结构体 */ export interface DescribeDBCharsetsResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * IsolateDBInstance返回参数结构体 */ export interface IsolateDBInstanceResponse { /** * 隔离成功实例Id列表 */ SuccessInstanceIds?: ArraySSL启用状态
枚举值:
本次实际删除的备份数量
*/ Deleted?: number; /** *是否全部删除成功
*/ IsSuccess?: boolean; /** *需要删除的备份总数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeFlow返回参数结构体 */ export interface DescribeFlowResponse { /** *running表示进行中;success表示成功;paused表示暂停;failed表示失败
*/ Status?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 维护窗口配置 */ export interface MaintenanceWindowInfo { /** * */ StartTime?: number; /** * */ Duration?: number; /** * */ WeekDays?: Array按备份方式统计
注意:此字段可能返回 null,表示取不到有效值。 */ BackupMethodStatistics?: BackupMethodStatisticsOutPut; /** *备份时间
注意:此字段可能返回 null,表示取不到有效值。 */ BackupTime?: Array按备份数据类型统计
注意:此字段可能返回 null,表示取不到有效值。 */ BackupTypeStatistics?: BackupTypeStatisticsModel; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBSBackupSetComment请求参数结构体 */ export interface ModifyDBSBackupSetCommentRequest { /** *实例ID
*/ InstanceId: string; /** *备份集ID,值来自 DescribeDBSBackupSets 接口返回
*/ BackupSetId: number; /** *备份备注
*/ NewBackupName: string; } /** * 参数约束 */ export interface ParamConstraint { /** * 约束类型,如枚举enum,区间section */ Type: string; /** * 约束类型为enum时的可选值列表 注意:此字段可能返回 null,表示取不到有效值。 */ Enum: string; /** * 约束类型为section时的范围 注意:此字段可能返回 null,表示取不到有效值。 */ Range: ConstraintRange; /** * 约束类型为string时的可选值列表 注意:此字段可能返回 null,表示取不到有效值。 */ String: string; } /** * DescribeDBSBackupPolicy返回参数结构体 */ export interface DescribeDBSBackupPolicyResponse { /** *备份策略列表
注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteDBSBackupSets请求参数结构体 */ export interface DeleteDBSBackupSetsRequest { /** *实例ID
*/ InstanceId: string; /** *备份集列表 ,值来自 DescribeDBSBackupSets 接口返回
*/ BackupSetIdList?: Array节点IP信息
注意:此字段可能返回 null,表示取不到有效值。 */ IP?: string; /** *节点类型,如sqlengine,tdstore,mc
注意:此字段可能返回 null,表示取不到有效值。 */ Type?: string; /** *节点唯一标识
注意:此字段可能返回 null,表示取不到有效值。 */ NodeId?: string; /** *节点端口信息
注意:此字段可能返回 null,表示取不到有效值。 */ Port?: number; /** *节点所属可用区
注意:此字段可能返回 null,表示取不到有效值。 */ Zone?: string; /** *节点所属机器ip
注意:此字段可能返回 null,表示取不到有效值。 */ Host?: string; /** *节点日志服务信息
*/ BinlogInfo?: Array节点cpu个数
*/ Cpu?: number; /** *节点mem大小
*/ Mem?: number; /** *节点磁盘大小
*/ DataDisk?: number; } /** * DescribeSpecs返回参数结构体 */ export interface DescribeSpecsResponse { /** *对等节点售卖规格列表
注意:此字段可能返回 null,表示取不到有效值。 */ HybridNodeSpecs?: Arraysvls节点售卖规格列表
*/ ServerlessCcuSpec?: Arrayserverless节点数量配置
*/ ServerlessNodeNumSpec?: ServerlessNodeNumSpec; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBInstanceSecurityGroups返回参数结构体 */ export interface ModifyDBInstanceSecurityGroupsResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBSArchiveLogs返回参数结构体 */ export interface DescribeDBSArchiveLogsResponse { /** *归档日志列表
注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUserPrivileges返回参数结构体 */ export interface ModifyUserPrivilegesResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库引擎信息 */ export interface DBEngineInfo { /** *引擎类型
注意:此字段可能返回 null,表示取不到有效值。 */ Type?: string; /** *引擎版本
注意:此字段可能返回 null,表示取不到有效值。 */ Version?: string; /** *引擎名称
注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** *引擎描述
*/ Description?: string; /** *是否最新版本
注意:此字段可能返回 null,表示取不到有效值。 */ New?: boolean; /** *支持的兼容的模式,以,分隔
*/ SQLMode?: Array是否支持参数模板
*/ IsSupportParamTemplate?: boolean; /** *是否支持Serverless模式
*/ IsSupportServerless?: boolean; } /** * DescribeFlowTypes返回参数结构体 */ export interface DescribeFlowTypesResponse { /** *任务类型信息,供前端下拉筛选使用
*/ FlowTypes?: Array备份集ID
*/ BackupSetId?: number; /** *是否成功
*/ IsSuccess?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 备份集查询的filter */ export interface BackupSetsReqFilter { /** *备份方式,多个值用逗号隔开
枚举值:
备份状态,多个值用逗号隔开,含义说明:等待调度pending, 运行中 running, 成功success,失败 failed
注意:此字段可能返回 null,表示取不到有效值。 */ BackupStatus?: string; /** *备份类型,多个值用逗号隔开,含义说明:全量备份 full
枚举值:
备份触发方式
枚举值:
备份集列表
注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBSCloneInstances请求参数结构体 */ export interface DescribeDBSCloneInstancesRequest { /** *源实例ID
*/ SourceInstanceId: string; /** *引擎类型
*/ DBType?: string; /** *结束创建时间
*/ EndCreateTime?: string; /** *克隆类型: PITR 时间点 BackupSet 备份集
*/ FilterCloneType?: string; /** *查询数量[0,200]
*/ Limit?: number; /** *查询偏移量[0,INF]
*/ Offset?: number; /** *排序字段: CloneTime,CreateTime
*/ OrderBy?: string; /** *排序类型:ASC,DESC
*/ OrderType?: string; /** *开始创建时间
*/ StartCreateTime?: string; } /** * CreateCloneInstance请求参数结构体 */ export interface CreateCloneInstanceRequest { /** *创建实例区域
*/ Zone: string; /** *字符型vpcid
*/ VpcId: string; /** *字符型subnetid
*/ SubnetId: string; /** *购买规格
*/ SpecCode: string; /** *存储节点磁盘容量,单位GB
*/ Disk: number; /** *存储节点数量
*/ StorageNodeNum: number; /** *源实例id
*/ InstanceId: string; /** *实例名称,要求长度1-60,允许包含中文、英文大小写、数字、-、_
*/ InstanceName?: string; /** *标签键值对数组
*/ ResourceTags?: Array备份回档名称
*/ BackupName?: string; /** *存储节点CPU核数
*/ StorageNodeCpu?: number; /** *存储节点内存大小
*/ StorageNodeMem?: number; /** *创建版本
*/ CreateVersion?: string; /** *创建端口号
*/ Vport?: number; /** *恢复时间点
*/ RecoverTime?: string; /** *实例架构类型,separate:分离架构;hybrid:对等架构
*/ InstanceType?: string; /** *磁盘类型,CLOUD_HSSD增强型SSD,CLOUD_TCS本地SSD盘
*/ StorageType?: string; /** *多可用区列表,Zones[0]表示主可用区
*/ Zones?: Array全能型副本数
*/ FullReplications?: number; /** *实例模式,normal:标准型;enhanced:加强型
*/ InstanceMode?: string; /** *安全组id列表
*/ SecurityGroupIds?: Array过滤参数
*/ Filters?: Array最大返回个数,默认为20,上限为100
*/ Limit?: number; /** *偏移量,取Limit整数倍
*/ Offset?: number; /** *指定查询引擎类型
枚举值:
查询Order By字段,支持 StorageNodeNum/CreateTime/CreateVersion
*/ OrderBy?: string; /** *排序方向
枚举值:
默认值:DESC
*/ OrderDirection?: string; } /** * DescribeDBSecurityGroups请求参数结构体 */ export interface DescribeDBSecurityGroupsRequest { /** * 实例ID。 */ InstanceId: string; } /** * 查询售卖接口,region信息返回类型 */ export interface DescribeSaleRegionInfo { /** *Region英文字符串
*/ Region?: string; /** *售卖Zone列表
*/ ZoneList?: ArrayRegion中文字符串
*/ RegionName?: string; /** *是否售卖。1:售卖,0不售卖
*/ Enable?: number; /** *多可用可选数量
注意:此字段可能返回 null,表示取不到有效值。 */ AvailableZoneNum?: number; /** *是否允许使用日志副本
注意:此字段可能返回 null,表示取不到有效值。 */ IsSupportedLogReplica?: boolean; /** *可用区组合
*/ ZoneGroup?: Array是否支持serverless
*/ IsSupportServerless?: boolean; } /** * DescribeSaleInfo请求参数结构体 */ export interface DescribeSaleInfoRequest { /** *灾备主实例地域
*/ SrcRegion?: string; /** *实例id
传入此参数表示返回这个实例所在的地域可用区的售卖信息
*/ InstanceId?: string; /** *指定支持某种类型实例的 sale 信息
枚举值:
默认值:无
当前仅支持指定 serverless,传入其他信息或者不传则默认返回所有售卖地域信息
*/ InstanceType?: string; } /** * DescribeDBSArchiveLogs请求参数结构体 */ export interface DescribeDBSArchiveLogsRequest { /** *实例ID
*/ InstanceId: string; /** *日志记录ID
*/ ArchiveLogId?: number; /** *结束时间
*/ EndTime?: string; /** *备份状态:pending,running,success,failed
*/ FilterStatus?: string; /** *条数限制
*/ Limit?: number; /** *偏移量
*/ Offset?: number; /** *排序字段,枚举:StartTime,EndTime,ExpiredTime,FileSize,BackupDuration
*/ OrderBy?: string; /** *排序方式:ASC:顺序, DESC:倒序
*/ OrderType?: string; /** *开始时间
*/ StartTime?: string; } /** * 数据库函数信息 */ export interface DatabaseFunction { /** * 函数名称 */ Func: string; } /** * CreateUsers返回参数结构体 */ export interface CreateUsersResponse { /** *任务id
*/ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBSBackupPolicy请求参数结构体 */ export interface ModifyDBSBackupPolicyRequest { /** *备份策略
*/ BackupPolicy: BackupPolicyModelInput; /** *实例ID
*/ InstanceId: string; } /** * DescribeDBInstanceDetail返回参数结构体 */ export interface DescribeDBInstanceDetailResponse { /** *实例名称
*/ InstanceName?: string; /** *区域
*/ Zone?: string; /** *字符型vpcid
*/ VpcId?: string; /** *字符型subnetid
*/ SubnetId?: string; /** *创建实例版本
*/ CreateVersion?: string; /** *子网IP
*/ Vip?: string; /** *子网端口
*/ Vport?: number; /** *实例状态
*/ Status?: string; /** *存储节点磁盘容量,单位GB
*/ Disk?: number; /** *存储节点数量
*/ StorageNodeNum?: number; /** *初始化实例参数
*/ InitParams?: Array实例标签信息
*/ ResourceTags?: Array创建时间
*/ CreateTime?: string; /** *更新时间
*/ UpdateTime?: string; /** *存储节点副本数量
*/ Replications?: number; /** *全能型副本数
*/ FullReplications?: number; /** *字符集
*/ CharSet?: string; /** *节点信息
*/ Node?: Array实例所属地域
*/ Region?: string; /** *实例规格
*/ SpecCode?: string; /** *实例ID
*/ InstanceId?: string; /** *实例状态中文描述
*/ StatusDesc?: string; /** *存储节点CPU核数
*/ StorageNodeCpu?: number; /** *存储节点内存大小
*/ StorageNodeMem?: number; /** *续费标志
*/ RenewFlag?: number; /** *付费模式,0后付费,1预付费
*/ PayMode?: string; /** *过期时间
注意:此字段可能返回 null,表示取不到有效值。 */ ExpireAt?: string; /** *隔离时间
注意:此字段可能返回 null,表示取不到有效值。 */ IsolatedAt?: string; /** *实例架构类型,separate:分离架构;hybrid:对等架构
注意:此字段可能返回 null,表示取不到有效值。 */ InstanceType?: string; /** *磁盘类型,CLOUD_HSSD增强型SSD,CLOUD_TCS本地SSD盘
注意:此字段可能返回 null,表示取不到有效值。 */ StorageType?: string; /** *实例节点可用区列表。Zones[0]表示主可用区
*/ Zones?: Array最大节点磁盘使用量
注意:此字段可能返回 null,表示取不到有效值。 */ DiskUsage?: number; /** *binlog是否开启
*/ BinlogStatus?: number; /** *az模式,1: 单AZ 2: 多AZ非主AZ模式 3: 多AZ主AZ模式
*/ AZMode?: number; /** *灾备标志位,1: 无灾备关系;2: 灾备主实例;3: 灾备备实例
*/ StandbyFlag?: number; /** *cdc节点类型
*/ BinlogType?: string; /** *1表示支持,0表示不支持
*/ TimingModifyInstanceFlag?: number; /** *列存节点cpu核数
*/ ColumnarNodeCpu?: number; /** *列存节点mem内存大小
*/ ColumnarNodeMem?: number; /** *列存节点个数
*/ ColumnarNodeNum?: number; /** *列存节点磁盘大小
*/ ColumnarNodeDisk?: number; /** *列存节点磁盘类型
*/ ColumnarNodeStorageType?: string; /** *列存节点规格
*/ ColumnarNodeSpecCode?: string; /** *列存 vip
*/ ColumnarVip?: string; /** *列存 vport
*/ ColumnarVport?: number; /** *实例是否支持列存
*/ IsSupportColumnar?: boolean; /** *实例类型
*/ InstanceCategory?: number; /** *兼容模式
*/ SQLMode?: string; /** *是否支持修改全能型副本数量
*/ IsSwitchFullReplicationsEnable?: boolean; /** *实例类型
*/ InstanceMode?: string; /** *dumper vip
*/ DumperVip?: string; /** *dumper vport
*/ DumperVport?: number; /** *svls实例的ccu变配范围
*/ AutoScaleConfig?: AutoScalingConfig; /** *参数模板id
*/ TemplateId?: string; /** *参数模板名称
*/ TemplateName?: string; /** *实例分析引擎模式
枚举值:
分析引擎实例关系
*/ AnalysisRelationInfos?: Array分析引擎实例信息
Cpu、Memory、Disk复用顶层字段
*/ AnalysisInstanceInfo?: AnalysisInstanceInfo; /** *维护窗口配置
*/ MaintenanceWindow?: MaintenanceWindowInfo; /** *是否开启透明加密,0:未开启;1:已开启
*/ EncryptionEnable?: number; /** *真实使用的kms地域,用于后续调用kms服务
*/ EncryptionKmsRegion?: string; /** *serverless自动变配配置
*/ AutoScaleConfigs?: Array实例 ID,形如:tdsql3-42f40429.
*/ InstanceId: string; /** *数据库名称,通过 DescribeDatabases 接口获取。
*/ DbName: string; /** *分页索引
*/ Offset?: number; /** *每页数量
*/ Limit?: number; /** *数据表名称匹配表达式
*/ TableRegexp?: string; } /** * ModifyMaintenanceWindow请求参数结构体 */ export interface ModifyMaintenanceWindowRequest { /** *实例ID
*/ InstanceId: string; /** *运维窗口开始时间
参数格式:hh:mm:ss
*/ StartTime: string; /** *运维窗口持续时间
取值范围:[1, 3]
单位:时
*/ Duration: number; /** *运维窗口日期
枚举值:
实例ID
*/ InstanceId: string; /** *拟修改的目标保留空间大小
单位:GB
*/ ReservedSpaceGB: number; } /** * DestroyInstances返回参数结构体 */ export interface DestroyInstancesResponse { /** * 解除隔离成功实例Id列表 */ SuccessInstanceIds: Array返回可售卖region信息
*/ RegionList?: Array用户名
*/ UserName?: string; /** *host
*/ Host?: string; /** *明文密码
*/ Password?: string; /** *加密密码
*/ EncryptedPassword?: string; } /** * DeleteUsers返回参数结构体 */ export interface DeleteUsersResponse { /** *任务id
*/ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库表信息 */ export interface DatabaseTable { /** * 表名 */ Table: string; } /** * DescribeDBInstanceDetail请求参数结构体 */ export interface DescribeDBInstanceDetailRequest { /** *实例ID
*/ InstanceId: string; } /** * ModifyAutoRenewFlag返回参数结构体 */ export interface ModifyAutoRenewFlagResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CancelIsolateDBInstances返回参数结构体 */ export interface CancelIsolateDBInstancesResponse { /** * 解除隔离成功实例Id列表 */ SuccessInstanceIds: Array是否成功
*/ IsSuccess?: boolean; /** *消息
*/ Msg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 云数据库参数信息。 */ export interface DBParamValue { /** * 参数名称 */ Param: string; /** * 参数值 */ Value: string; } /** * CreateUsers请求参数结构体 */ export interface CreateUsersRequest { /** *实例id
*/ InstanceId: string; /** *新增用户列表
*/ Users?: Array未加密密码
*/ Password?: string; /** *加密密码
*/ EncryptedPassword?: string; /** *用户描述
*/ Description?: string; } /** * ModifyDBParameters请求参数结构体 */ export interface ModifyDBParametersRequest { /** * 实例 ID,形如:tdsql3-ow728lmc。 */ InstanceId: string; /** * 参数列表,每一个元素是Param和Value的组合 */ Params: Array实例ID
*/ InstanceId: string; } /** * 安全组详情 */ export interface SecurityGroup { /** * 项目ID */ ProjectId?: number; /** * 创建时间,时间格式:yyyy-mm-dd hh:mm:ss */ CreateTime?: string; /** * 安全组ID */ SecurityGroupId?: string; /** * 安全组名称 */ SecurityGroupName?: string; /** * 安全组备注 */ SecurityGroupRemark?: string; /** * 入站规则 */ Inbound?: Array实例id
*/ InstanceId: string; /** *批量删除用户列表
*/ Users?: Array克隆实例ID
注意:此字段可能返回 null,表示取不到有效值。 */ InstanceId?: string; /** *任务ID
注意:此字段可能返回 null,表示取不到有效值。 */ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDatabaseObjects返回参数结构体 */ export interface DescribeDatabaseObjectsResponse { /** *透传入参。
*/ InstanceId?: string; /** *数据库名称。
*/ DbName?: string; /** *表列表。
注意:此字段可能返回 null,表示取不到有效值。 */ Tables?: Array视图列表。
注意:此字段可能返回 null,表示取不到有效值。 */ Views?: Array存储过程列表。
注意:此字段可能返回 null,表示取不到有效值。 */ Procs?: Array函数列表。
注意:此字段可能返回 null,表示取不到有效值。 */ Funcs?: Array实例ID
*/ InstanceId?: string; /** *运维窗口时间范围
*/ MaintenanceWindow?: string; /** *运维窗口天数范围
*/ WeekDays?: Array备份方式统计
注意:此字段可能返回 null,表示取不到有效值。 */ BackupMethodStatistics?: BackupMethodStatisticsModel; /** *总备份集统计
注意:此字段可能返回 null,表示取不到有效值。 */ BackupStatistics?: BackupStatisticsModel; /** *数据备份统计
注意:此字段可能返回 null,表示取不到有效值。 */ DataBackupStatistics?: DataBackupStatisticsModel; /** *日志备份统计
注意:此字段可能返回 null,表示取不到有效值。 */ LogBackupStatistics?: LogBackupStatisticsModel; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 备份方式统计对象,提供给 备份集统计详情 接口 */ export interface BackupTypeStatisticsModel { /** *数据备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ DataBackupSize?: Array日志备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ LogBackupSize?: Array克隆列表
注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例信息类型 */ export interface InstanceInfo { /** *计算节点数量
* @deprecated */ ComputeNodeNum?: number; /** *区域
*/ Zone?: string; /** *创建实例版本
注意:此字段可能返回 null,表示取不到有效值。 */ CreateVersion?: string; /** *初始化实例参数
注意:此字段可能返回 null,表示取不到有效值。 */ InitParams?: Array实例状态:creating、created、initializing、running、modifying、isolating、isolated、destroying、destroyed
*/ Status?: string; /** *实例id
*/ InstanceId?: string; /** *存储节点数量
*/ StorageNodeNum?: number; /** *实例标签信息
注意:此字段可能返回 null,表示取不到有效值。 */ ResourceTags?: Array实例名称
注意:此字段可能返回 null,表示取不到有效值。 */ InstanceName?: string; /** *计算节点cpu核数
* @deprecated */ Cpu?: number; /** *字符型vpcid
*/ VpcId?: string; /** *计算节点mem,单位GB
* @deprecated */ Mem?: number; /** *子网IP
*/ Vip?: string; /** *字符型subnetid
*/ SubnetId?: string; /** *子网端口
*/ Vport?: number; /** *存储节点磁盘容量,单位GB
*/ Disk?: number; /** *实例创建时间
*/ CreateTime?: string; /** *实例所属地域
*/ Region?: string; /** *实例状态中文描述
*/ StatusDesc?: string; /** *管控节点CPU核数
注意:此字段可能返回 null,表示取不到有效值。 * @deprecated */ MCCpu?: number; /** *管控节点CPU大小
注意:此字段可能返回 null,表示取不到有效值。 * @deprecated */ MCMem?: number; /** *计算节点CPU核数
注意:此字段可能返回 null,表示取不到有效值。 * @deprecated */ ComputerNodeCpu?: number; /** *计算节点内存大小
注意:此字段可能返回 null,表示取不到有效值。 * @deprecated */ ComputerNodeMem?: number; /** *存储节点CPU核数
注意:此字段可能返回 null,表示取不到有效值。 */ StorageNodeCpu?: number; /** *存储节点内存大小
注意:此字段可能返回 null,表示取不到有效值。 */ StorageNodeMem?: number; /** *管控节点数量
注意:此字段可能返回 null,表示取不到有效值。 * @deprecated */ MCNum?: number; /** *续费标志
注意:此字段可能返回 null,表示取不到有效值。 */ RenewFlag?: number; /** *付费模式,0按量付费;1包年包月
*/ PayMode?: string; /** *用户标签,inner:内部用户;external:外部用户
注意:此字段可能返回 null,表示取不到有效值。 */ AccountTag?: string; /** *实例架构类型,separate:分离架构;hyper:对等架构
注意:此字段可能返回 null,表示取不到有效值。 */ InstanceType?: string; /** *磁盘类型,CLOUD_HSSD增强型SSD,CLOUD_TCS本地SSD盘
注意:此字段可能返回 null,表示取不到有效值。 */ StorageType?: string; /** *"0000-00-00 00:00:00"
注意:此字段可能返回 null,表示取不到有效值。 */ DestroyedAt?: string; /** *"0000-00-00 00:00:00"
注意:此字段可能返回 null,表示取不到有效值。 */ ExpireAt?: string; /** *"0000-00-00 00:00:00"
注意:此字段可能返回 null,表示取不到有效值。 */ IsolatedAt?: string; /** *"0000-00-00 00:00:00"
注意:此字段可能返回 null,表示取不到有效值。 */ IsolatedFrom?: string; /** *1
注意:此字段可能返回 null,表示取不到有效值。 */ Replications?: number; /** *全能型副本数
*/ FullReplications?: number; /** *账号信息
注意:此字段可能返回 null,表示取不到有效值。 */ AppId?: number; /** *账号信息
注意:此字段可能返回 null,表示取不到有效值。 */ SubAccountUin?: string; /** *账号信息
注意:此字段可能返回 null,表示取不到有效值。 */ Uin?: string; /** *AZ信息
注意:此字段可能返回 null,表示取不到有效值。 */ Zones?: Array实例节点
注意:此字段可能返回 null,表示取不到有效值。 */ Nodes?: Arraybinlog是否打开
*/ BinlogStatus?: number; /** *cdc节点核数
* @deprecated */ CdcNodeCpu?: number; /** *cdc节点内存大小
* @deprecated */ CdcNodeMem?: number; /** *cdc节点数
* @deprecated */ CdcNodeNum?: number; /** *az模式,1: 单AZ 2: 多AZ非主AZ模式 3: 多AZ主AZ模式
注意:此字段可能返回 null,表示取不到有效值。 */ AZMode?: number; /** *灾备标志位,1: 无灾备关系;2: 灾备主实例;3: 灾备备实例
注意:此字段可能返回 null,表示取不到有效值。 */ StandbyFlag?: number; /** *连接的备实例数量(仅当 StandbyFlag == 2 时有效)
注意:此字段可能返回 null,表示取不到有效值。 */ StandbySecondaryNum?: number; /** *列存节点 cpu 核数
*/ ColumnarNodeCpu?: number; /** *列存节点内存大小
*/ ColumnarNodeMem?: number; /** *列存节点数
*/ ColumnarNodeNum?: number; /** *列存节点磁盘容量,单位GB
*/ ColumnarNodeDisk?: number; /** *列存节点磁盘类型
*/ ColumnarNodeStorageType?: string; /** *独享标志位,1: 主实例(独享型), 2: 主实例, 3: 灾备实例, 4: 灾备实例(独享型)
*/ InstanceCategory?: number; /** *dbdc-xxxxx
*/ ExclusiveClusterId?: string; /** *兼容模式
*/ SQLMode?: string; /** *实例模式
*/ InstanceMode?: string; /** *实例发货平台
* @deprecated */ ClusterId?: string; /** *自动扩容配置
*/ AutoScaleConfig?: AutoScalingConfig; /** *分析引擎模式
枚举值:
分析引擎关系信息
*/ AnalysisRelationInfos?: Array分析引擎实例信息
*/ AnalysisInstanceInfo?: AnalysisInstanceInfo; /** *有关该实例的多个自动变配相关配置,ccu、nodecount 值
*/ AutoScaleConfigs?: Array实例ID
*/ InstanceId: string; /** *实例备份集ID
*/ BackupSetId?: number; /** *结束时间
*/ EndTime?: string; /** *过滤条件
*/ FilterBy?: BackupSetsReqFilter; /** *单次查询数量[0,200]
*/ Limit?: number; /** *本次查询偏移[0,INF]
*/ Offset?: number; /** *StartTime,EndTime,ExpiredTime,BackupSetId,BackupDuration
*/ OrderBy?: string; /** *ASC,DESC
*/ OrderType?: string; /** *开始时间
*/ StartTime?: string; } /** * 分析引擎实例信息 */ export interface AnalysisInstanceInfo { /** *副本数
*/ ReplicasNum?: number; } /** * serverless实例的ccu规格 */ export interface ServerlessCcu { /** *ccu最小值
*/ MinCcu?: number; /** *ccu最大值范围
*/ MaxCcu?: Array可用区数
*/ ZoneNum?: number; /** *可用区组合
*/ Zones?: Array支持的类型
*/ SupportTypes?: Array支持的磁盘类型
枚举值:
是否支持serverless
*/ IsSupportServerless?: boolean; } /** * DescribeDBSBackupStatistics请求参数结构体 */ export interface DescribeDBSBackupStatisticsRequest { /** *实例ID
*/ InstanceId: string; /** *结束时间
*/ EndTime?: string; /** *开始时间
*/ StartTime?: string; } /** * DescribeUsers返回参数结构体 */ export interface DescribeUsersResponse { /** * 用户列表 */ Users?: Array平均每个日志备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ AverageSizePerBackup?: number; /** *平均每天日志备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ AverageSizePerDay?: number; /** *日志备份个数
注意:此字段可能返回 null,表示取不到有效值。 */ TotalCount?: number; /** *日志备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ TotalSize?: number; } /** * DescribeUsers请求参数结构体 */ export interface DescribeUsersRequest { /** * 实例ID */ InstanceId: string; } /** * 备份方式统计对象-提供给备份空间统计接口 */ export interface BackupMethodStatisticsModel { /** *自动备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ AutoBackupSize?: number; /** *总备份每天平均大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ AverageSizePerDay?: number; /** *手动备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ ManualBackupSize?: number; /** *总备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。 */ TotalSize?: number; } /** * DescribeDBSBackupPolicy请求参数结构体 */ export interface DescribeDBSBackupPolicyRequest { /** *实例ID
*/ InstanceId: string; } /** * UpgradeInstance返回参数结构体 */ export interface UpgradeInstanceResponse { /** *任务ID
*/ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CancelIsolateDBInstances请求参数结构体 */ export interface CancelIsolateDBInstancesRequest { /** * 需要隔离的实例ID列表 */ InstanceIds: ArraySql的执行时间
注意:此字段可能返回 null,表示取不到有效值。 */ Timestamp?: string; /** *Sql的执行时长(秒)
注意:此字段可能返回 null,表示取不到有效值。 */ QueryTime?: number; /** *Sql语句
注意:此字段可能返回 null,表示取不到有效值。 */ SqlText?: string; /** *客户端地址
注意:此字段可能返回 null,表示取不到有效值。 */ UserHost?: string; /** *用户名
注意:此字段可能返回 null,表示取不到有效值。 */ UserName?: string; /** *数据库名
注意:此字段可能返回 null,表示取不到有效值。 */ Database?: string; /** *锁时长(秒)
注意:此字段可能返回 null,表示取不到有效值。 */ LockTime?: number; /** *扫描行数
注意:此字段可能返回 null,表示取不到有效值。 */ RowsExamined?: number; /** *结果集行数
注意:此字段可能返回 null,表示取不到有效值。 */ RowsSent?: number; /** *事物ID
注意:此字段可能返回 null,表示取不到有效值。 */ TransactionId?: string; /** *rpc耗时
注意:此字段可能返回 null,表示取不到有效值。 */ RpcTime?: number; /** *与存储节点交互rpc耗时
注意:此字段可能返回 null,表示取不到有效值。 */ StorageRpcTime?: number; /** *rpc重试延迟耗时
注意:此字段可能返回 null,表示取不到有效值。 */ RpcRetryDelayTime?: number; /** *node名称
注意:此字段可能返回 null,表示取不到有效值。 */ NodeId?: string; /** *rpc 链路追踪
注意:此字段可能返回 null,表示取不到有效值。 */ RpcTrace?: string; /** *TDStore锁时长
单位:秒
注意:此字段可能返回 null,表示取不到有效值。 */ TDStoreLockTime?: number; /** *全局标识ID
注意:此字段可能返回 null,表示取不到有效值。 */ TraceId?: string; /** *执行计划
注意:此字段可能返回 null,表示取不到有效值。 */ Explain?: Array实例ID
*/ InstanceId: string; /** *存储节点扩容至多少个节点,如果没有变化,传当前节点数
*/ StorageNodeNum: number; /** *可用区列表
*/ Zones?: Arrayaz模式,1: 单AZ 2: 多AZ非主AZ模式 3: 多AZ主AZ模式
*/ AZMode?: number; /** *AZMode传3时,表示主AZ
*/ PrimaryAZ?: string; /** *全能型副本数,取值范围包括1-3
*/ FullReplications?: number; } /** * DescribeDatabases返回参数结构体 */ export interface DescribeDatabasesResponse { /** *透传实例ID
*/ InstanceId?: string; /** *该实例上的数据库列表。
*/ Databases?: Array总数量
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 归档日志对象 */ export interface ArchiveLogModel { /** * 归档日志ID 注意:此字段可能返回 null,表示取不到有效值。 */ ArchiveLogId?: number; /** * 备份耗时 注意:此字段可能返回 null,表示取不到有效值。 */ BackupDuration?: number; /** * 备份集状态 注意:此字段可能返回 null,表示取不到有效值。 */ BackupStatus?: string; /** * 备份结束时间 注意:此字段可能返回 null,表示取不到有效值。 */ EndTime?: string; /** * 错误信息 注意:此字段可能返回 null,表示取不到有效值。 */ ErrorMessage?: string; /** * 过期时间 注意:此字段可能返回 null,表示取不到有效值。 */ ExpiredTime?: string; /** * 备份文件名 注意:此字段可能返回 null,表示取不到有效值。 */ FileName?: string; /** * 备份集文件大小,单位Byte 注意:此字段可能返回 null,表示取不到有效值。 */ FileSize?: number; /** * 实例ID 注意:此字段可能返回 null,表示取不到有效值。 */ InstanceId?: string; /** * 备份开始时间 注意:此字段可能返回 null,表示取不到有效值。 */ StartTime?: string; } /** * 分析引擎关联关系 */ export interface AnalysisRelationInfo { /** *源实例Id
*/ PrimaryInstanceId?: string; /** *分析引擎实例Id
*/ AnalysisInstanceId?: string; /** *分析引擎关系状态
枚举值:
创建时间
*/ CreateAt?: string; /** *更新时间
*/ UpdateAt?: string; } /** * tag参数 */ export interface ResourceTag { /** * 标签键key */ TagKey?: string; /** * 标签值value */ TagValue?: string; } /** * ModifyMaintenanceWindow返回参数结构体 */ export interface ModifyMaintenanceWindowResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Serverless 实例允许调整的 hybrid 节点数量上下限 */ export interface ServerlessNodeNumSpec { /** *最小节点数
*/ MinNodeNum?: number; /** *最大节点数
*/ MaxNodeNum?: number; } /** * IsolateDBInstance请求参数结构体 */ export interface IsolateDBInstanceRequest { /** * 需要隔离的实例ID列表 */ InstanceIds: Array流程ID
*/ FlowId: number; } /** * ModifyDBSBackupSetComment返回参数结构体 */ export interface ModifyDBSBackupSetCommentResponse { /** *是否成功
*/ IsSuccess?: boolean; /** *修改信息
*/ Msg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * serverless实例的资源范围 ResourceType 为 cpu 时表示 ccu 为 nodecount 时表示节点数范围 */ export interface AutoScalingConfig { /** *ccu最小值
注意:此字段可能返回 null,表示取不到有效值。 */ RangeMin: number; /** *ccu最大值
注意:此字段可能返回 null,表示取不到有效值。 */ RangeMax: number; /** *返回的 range 参数对应的资源类型
枚举值:
需要修改的实例列表
*/ InstanceIds: Array1表示开启自动续费,0为关闭自动续费
*/ AutoRenewFlag: number; } /** * ResetUsersPassword返回参数结构体 */ export interface ResetUsersPasswordResponse { /** *任务id
*/ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDBSBackup请求参数结构体 */ export interface CreateDBSBackupRequest { /** *备份方式:physical、snapshot 这个值和DescribeDBSBackupPolicy接口返回的backupMethod保持一致
枚举值:
备份类型:暂时只支持full
*/ BackupType: string; /** *实例ID
*/ InstanceId: string; /** *备份备注
*/ BackupName?: string; } /** * DestroyInstances请求参数结构体 */ export interface DestroyInstancesRequest { /** * 需要隔离的实例ID列表 */ InstanceIds: Array实例ID
*/ InstanceId: string; } /** * DescribeSpecs请求参数结构体 */ export interface DescribeSpecsRequest { /** *全能型副本数,当前支持范围:1-3,默认为3
*/ FullReplications?: number; /** *独享实例
*/ IsExclusiveInstance?: number; } /** * DB参数描述 */ export interface ParamDesc { /** * 参数名字 */ Param: string; /** * 当前参数值 */ Value: string; /** * 设置过的值,参数生效后,该值和value一样。 注意:此字段可能返回 null,表示取不到有效值。 */ SetValue: string; /** * 系统默认值 */ Default: string; /** * 参数限制 注意:此字段可能返回 null,表示取不到有效值。 */ Constraint: ParamConstraint; /** * 是否有设置过值,false:没有设置过值,true:有设置过值。 */ HaveSetValue: boolean; /** * true:需要重启 */ NeedRestart: boolean; /** * 参数描述 注意:此字段可能返回 null,表示取不到有效值。 */ Description: string; } /** * CreateStandbyDBInstance返回参数结构体 */ export interface CreateStandbyDBInstanceResponse { /** *实例 ID
*/ InstanceId?: string; /** *任务ID
*/ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceNetwork请求参数结构体 */ export interface ModifyInstanceNetworkRequest { /** * 实例ID */ InstanceId: string; /** * 希望转到的VPC网络的VpcId */ VpcId: string; /** * 希望转到的VPC网络的子网ID */ SubnetId: string; /** * VIP保留时长,单位小时,取值范围(0~168),0表示立即释放,有一分钟释放延迟。不传此参数,默认24小时释放VIP。 */ VipReleaseDelay?: number; /** * 指定vip变更,不填表示随机vip */ Vip?: string; } /** * 修改备份策略对象 */ export interface BackupPolicyModelInput { /** *备份结束时间
*/ BackupEndTime?: string; /** *备份方式 physical 物理备份 snapshot 快照备份
*/ BackupMethod?: string; /** *备份开始时间
*/ BackupStartTime?: string; /** *是否开启全量备份
*/ EnableFull?: number; /** *是否开启日志备份
*/ EnableLog?: number; /** *全备保留时间,目前只能设置7天
*/ FullRetentionPeriod?: number; /** *实例ID
*/ InstanceId?: string; /** *日志保留天数,目前只能设置保留7天
*/ LogRetentionPeriod?: number; /** *一周的哪几天进行备份
*/ PeriodTime?: string; /** *存储类型:COS,SNAPSHOT
枚举值:返回实例列表信息
*/ Instances?: Array满足条件总数量
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 约束类型值的范围 */ export interface ConstraintRange { /** * 约束类型为section时的最小值 */ Min: string; /** * 约束类型为section时的最大值 */ Max: string; } /** * BreakStandbyDBInstanceRelation请求参数结构体 */ export interface BreakStandbyDBInstanceRelationRequest { /** * 备实例 ID */ InstanceId: string; /** * 是否强制断开 */ IsForce?: boolean; /** * 时延,单位是秒,0不检查 */ SyncDelay?: number; } /** * CreateStandbyDBInstance请求参数结构体 */ export interface CreateStandbyDBInstanceRequest { /** *主实例 id
*/ PrimaryInstanceId: string; /** *创建实例区域
*/ Zone: string; /** *字符型vpcid
*/ VpcId: string; /** *字符型subnetid
*/ SubnetId: string; /** *购买规格
*/ SpecCode: string; /** *存储节点磁盘容量,单位GB
*/ Disk: number; /** *存储节点数量
*/ StorageNodeNum: number; /** *存储节点副本数量,最大为5,要求为奇数
*/ Replications: number; /** *全能型副本数
*/ FullReplications?: number; /** *实例名称,要求长度1-60,允许包含中文、英文大小写、数字、-、_
*/ InstanceName?: string; /** *时间单位,y:年,m:月,d:日
*/ TimeUnit?: string; /** *商品的时间大小
*/ TimeSpan?: number; /** *存储节点CPU核数
*/ StorageNodeCpu?: number; /** *存储节点内存大小
*/ StorageNodeMem?: number; /** *付费模式,0表示按需计费/后付费,1表示预付费
*/ PayMode?: string; /** *自定义端口
*/ Vport?: number; /** *多AZ可用区列表
*/ Zones?: Array是否使用优惠卷
*/ AutoVoucher?: boolean; /** *优惠卷列表
*/ VoucherIds?: Array实例架构类型,19.0.0 起支持 "hybrid""
*/ InstanceType?: string; /** *磁盘类型,CLOUD_HSSD增强型SSD,CLOUD_TCS本地SSD盘
*/ StorageType?: string; /** *标签键值对数组
*/ ResourceTags?: Array主实例地域
*/ PrimaryInstanceRegion?: string; /** *实例模式,normal:标准型;enhanced:加强型
*/ InstanceMode?: string; /** *dbaadmin密码
*/ Password?: string; /** *绑定安全组id列表
*/ SecurityGroupIds?: Array需要重启的实例ID的数组
*/ InstanceIds: Array重启时间,不传表示立即重启
*/ RestartTime?: string; } /** * DescribeDBSAvailableRecoveryTime返回参数结构体 */ export interface DescribeDBSAvailableRecoveryTimeResponse { /** *结束时间
注意:此字段可能返回 null,表示取不到有效值。 */ EndTime?: string; /** *可恢复时间区间
注意:此字段可能返回 null,表示取不到有效值。 */ Intervals?: Array开始时间
注意:此字段可能返回 null,表示取不到有效值。 */ StartTime?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 表级别权限 */ export interface TablePrivileges { /** * DATABASE名 */ Database: string; /** * 表名 */ Table: string; /** * 权限列表 */ Privileges: Array任务类型名称,后续可以对 DescribeFlows 出参中的 FlowName 进行筛选
注意:此字段可能返回 null,表示取不到有效值。 */ FlowName?: string; /** *任务类型中文描述
注意:此字段可能返回 null,表示取不到有效值。 */ FlowDesc?: string; } /** * DescribeDBSAvailableRecoveryTime请求参数结构体 */ export interface DescribeDBSAvailableRecoveryTimeRequest { /** *实例ID
*/ InstanceId: string; } /** * ModifyDBInstanceVPort返回参数结构体 */ export interface ModifyDBInstanceVPortResponse { /** * 返回异步任务FlowId */ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResetDbaAdminPrivileges请求参数结构体 */ export interface ResetDbaAdminPrivilegesRequest { /** *实例id
*/ InstanceId: string; } /** * BreakStandbyDBInstanceRelation返回参数结构体 */ export interface BreakStandbyDBInstanceRelationResponse { /** * 任务 ID */ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceDataReservedSpace返回参数结构体 */ export interface DescribeInstanceDataReservedSpaceResponse { /** *实际保留比例(%,单节点)
*/ ReservedRate?: number; /** *实际保留空间 GB(单节点)
单位:GB
*/ ReservedSpaceGB?: number; /** *用户可用空间 GB(单节点)
单位:GB
*/ UsableSpaceGB?: number; /** *true=旧版本(<21.6.4.0),值取自老参数 tdstore_enter_readonly_threshold;false=新版本
*/ IsLegacy?: boolean; /** *内核版本号
*/ KernelVersion?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpgradeInstance请求参数结构体 */ export interface UpgradeInstanceRequest { /** *实例ID
*/ InstanceId: string; /** *实例规格码
*/ SpecCode: string; /** *存储节点磁盘容量,单位GB
*/ Disk: number; /** *存储节点CPU核数
*/ StorageNodeCpu?: number; /** *存储节点内存大小
*/ StorageNodeMem?: number; /** *磁盘类型,需要修改磁盘类型时传
*/ StorageType?: string; } /** * 备份集对象 */ export interface BackupSetModel { /** * 备份集耗时,单位 sec 注意:此字段可能返回 null,表示取不到有效值。 */ BackupDuration?: number; /** * 备份方式 注意:此字段可能返回 null,表示取不到有效值。 */ BackupMethod?: string; /** * 备份备注名 注意:此字段可能返回 null,表示取不到有效值。 */ BackupName?: string; /** * 备份集进度百分比 注意:此字段可能返回 null,表示取不到有效值。 */ BackupProgress?: number; /** * 备份集ID 注意:此字段可能返回 null,表示取不到有效值。 */ BackupSetId?: number; /** * 备份集状态 注意:此字段可能返回 null,表示取不到有效值。 */ BackupStatus?: string; /** * 备份集类型 注意:此字段可能返回 null,表示取不到有效值。 */ BackupType?: string; /** * 实例版本号 注意:此字段可能返回 null,表示取不到有效值。 */ DBVersion?: string; /** * 备份结束时间 注意:此字段可能返回 null,表示取不到有效值。 */ EndTime?: string; /** * 事务commit结束时间 注意:此字段可能返回 null,表示取不到有效值。 */ EndTrxTime?: string; /** * 错误信息 注意:此字段可能返回 null,表示取不到有效值。 */ ErrorMessage?: string; /** * 备份过期时间 注意:此字段可能返回 null,表示取不到有效值。 */ ExpiredTime?: string; /** * 备份文件名 注意:此字段可能返回 null,表示取不到有效值。 */ FileName?: string; /** * 备份集文件大小,单位Byte 注意:此字段可能返回 null,表示取不到有效值。 */ FileSize?: number; /** * 实例ID 注意:此字段可能返回 null,表示取不到有效值。 */ InstanceId?: string; /** * 备份触发,0 - autobackup, 1 - manual 注意:此字段可能返回 null,表示取不到有效值。 */ ManualBackup?: number; /** * 备份开始时间 注意:此字段可能返回 null,表示取不到有效值。 */ StartTime?: string; } /** * 初始化实例参数 */ export interface InstanceParam { /** * 配置参数key */ Param: string; /** * 配置参数value */ Value: string; } /** * CreateDBInstances返回参数结构体 */ export interface CreateDBInstancesResponse { /** *实例ID
*/ InstanceIds?: Array任务ID
*/ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBInstanceSecurityGroups请求参数结构体 */ export interface ModifyDBInstanceSecurityGroupsRequest { /** * 实例ID。 */ InstanceId: string; /** * 要修改的安全组 ID 列表,一个或者多个安全组 ID 组成的数组。 */ SecurityGroupIds: Array