tencentcloud-sdk-nodejs
Version:
2,711 lines (2,708 loc) • 114 kB
TypeScript
/**
* IsolateHourDBInstance返回参数结构体
*/
export interface IsolateHourDBInstanceResponse {
/**
* 解隔离成功的实例id列表
*/
SuccessInstanceIds?: Array<string>;
/**
* 解隔离失败的实例id列表
*/
FailedInstanceIds?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateDBInstance请求参数结构体
*/
export interface CreateDBInstanceRequest {
/**
* 实例节点可用区分布,可填写多个可用区。
*/
Zones: Array<string>;
/**
* 节点个数大小,可以通过 DescribeDBInstanceSpecs
查询实例规格获得。
*/
NodeCount: number;
/**
* 内存大小,单位:GB,可以通过 DescribeDBInstanceSpecs
查询实例规格获得。
*/
Memory: number;
/**
* 存储空间大小,单位:GB,可以通过 DescribeDBInstanceSpecs
查询实例规格获得不同内存大小对应的磁盘规格下限和上限。
*/
Storage: number;
/**
* 欲购买的时长,单位:月。
*/
Period?: number;
/**
* 欲购买的数量,默认查询购买1个实例的价格。
*/
Count?: number;
/**
* 是否自动使用代金券进行支付,默认不使用。
*/
AutoVoucher?: boolean;
/**
* 代金券ID列表,目前仅支持指定一张代金券。
*/
VoucherIds?: Array<string>;
/**
* 虚拟私有网络 ID,不传表示创建为基础网络
*/
VpcId?: string;
/**
* 虚拟私有网络子网 ID,VpcId 不为空时必填
*/
SubnetId?: string;
/**
* 项目 ID,可以通过查看项目列表获取,不传则关联到默认项目
*/
ProjectId?: number;
/**
* 数据库引擎版本,当前可选:8.0,5.7,10.1。
*/
DbVersionId?: string;
/**
* 实例名称, 可以通过该字段自主的设置实例的名字
*/
InstanceName?: string;
/**
* 安全组ID列表
*/
SecurityGroupIds?: Array<string>;
/**
* 自动续费标志,1:自动续费,2:不自动续费
*/
AutoRenewFlag?: number;
/**
* 是否支持IPv6,0:不支持,1:支持
*/
Ipv6Flag?: number;
/**
* 标签键值对数组
*/
ResourceTags?: Array<ResourceTag>;
/**
* 参数列表。本接口的可选值为:character_set_server(字符集,必传),lower_case_table_names(表名大小写敏感,必传,0 - 敏感;1-不敏感),innodb_page_size(innodb数据页,默认16K),sync_mode(同步模式:0 - 异步; 1 - 强同步;2 - 强同步可退化。默认为强同步可退化)。
*/
InitParams?: Array<DBParamValue>;
/**
* DCN源地域
*/
DcnRegion?: string;
/**
* DCN源实例ID
*/
DcnInstanceId?: string;
/**
* DCN同步模式,0:异步, 1:强同步
*/
DcnSyncMode?: number;
/**
* cpu类型,英特尔:Intel/AMD,海光:Hygon,默认Intel/AMD
*/
CpuType?: string;
}
/**
* DescribeDBTmpInstances请求参数结构体
*/
export interface DescribeDBTmpInstancesRequest {
/**
* 实例ID
*/
InstanceId: string;
}
/**
* DescribeAccountPrivileges返回参数结构体
*/
export interface DescribeAccountPrivilegesResponse {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 权限列表。
*/
Privileges?: Array<string>;
/**
* 数据库账号用户名
*/
UserName?: string;
/**
* 数据库账号Host
*/
Host?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDatabases请求参数结构体
*/
export interface DescribeDatabasesRequest {
/**
* 实例 ID,形如:tdsql-e9tklsgz。
*/
InstanceId: string;
}
/**
* DB参数描述
*/
export interface ParamDesc {
/**
* 参数名字
*/
Param?: string;
/**
* 当前参数值
*/
Value?: string;
/**
* 设置过的值,参数生效后,该值和value一样。
*/
SetValue?: string;
/**
* 系统默认值
*/
Default?: string;
/**
* 参数限制
*/
Constraint?: ParamConstraint;
/**
* 是否有设置过值,false:没有设置过值,true:有设置过值。
*/
HaveSetValue?: boolean;
/**
* 是否需要重启生效,false:不需要重启,
true:需要重启
*/
NeedRestart?: boolean;
}
/**
* DescribeDBParameters请求参数结构体
*/
export interface DescribeDBParametersRequest {
/**
* 实例 ID,形如:tdsql-ow728lmc。
*/
InstanceId: string;
}
/**
* DescribeAccounts请求参数结构体
*/
export interface DescribeAccountsRequest {
/**
* 实例ID,形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
*/
InstanceId: string;
}
/**
* DescribeRenewalPrice返回参数结构体
*/
export interface DescribeRenewalPriceResponse {
/**
* 原价
* 单位:默认为分,若请求参数带有AmountUnit,参考AmountUnit描述
* 币种:国内站为人民币,国际站为美元
*/
OriginalPrice: number;
/**
* 实际价格,受折扣等影响,可能和原价不同
* 单位:默认为分,若请求参数带有AmountUnit,参考AmountUnit描述
* 币种:国内站人民币,国际站美元
*/
Price: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyBackupConfigs请求参数结构体
*/
export interface ModifyBackupConfigsRequest {
/**
* 实例 ID,格式如:tdsql-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* 常规备份存储时长,范围[1, 3650]。
*/
Days?: number;
/**
* 每天备份执行的区间的开始时间,格式 mm:ss,形如 22:00。
*/
StartBackupTime?: string;
/**
* 每天备份执行的区间的结束时间,格式 mm:ss,形如 23:59。
*/
EndBackupTime?: string;
/**
* 执行备份周期,枚举值:Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
*/
WeekDays?: Array<string>;
/**
* 沉降到归档存储时长,-1表示关闭归档设置。
*/
ArchiveDays?: number;
/**
* 超期备份配置。
*/
BackupConfigSet?: Array<NewBackupConfig>;
}
/**
* ModifyInstanceNetwork返回参数结构体
*/
export interface ModifyInstanceNetworkResponse {
/**
* 异步任务ID,根据此FlowId通过DescribeFlow接口查询任务进行状态
*/
FlowId: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateDedicatedClusterDBInstance返回参数结构体
*/
export interface CreateDedicatedClusterDBInstanceResponse {
/**
* 分配资源ID数组
*/
InstanceIds?: Array<string>;
/**
* 流程ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyInstanceVport返回参数结构体
*/
export interface ModifyInstanceVportResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DestroyHourDBInstance请求参数结构体
*/
export interface DestroyHourDBInstanceRequest {
/**
* 实例 ID,格式如:tdsql-avw0207d,与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
}
/**
* ModifyInstanceVip返回参数结构体
*/
export interface ModifyInstanceVipResponse {
/**
* 异步任务流程ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssociateSecurityGroups请求参数结构体
*/
export interface AssociateSecurityGroupsRequest {
/**
* 数据库引擎名称,本接口取值:mariadb。
*/
Product: string;
/**
* 要绑定的安全组ID,类似sg-efil73jd。
*/
SecurityGroupId: string;
/**
* 被绑定的实例ID,类似tdsql-lesecurk,支持指定多个实例。
*/
InstanceIds: Array<string>;
}
/**
* DescribeUpgradePrice请求参数结构体
*/
export interface DescribeUpgradePriceRequest {
/**
* 待升级的实例ID。形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
*/
InstanceId: string;
/**
* 内存大小,单位:GB,可以通过 DescribeDBInstanceSpecs
查询实例规格获得。
*/
Memory: number;
/**
* 存储空间大小,单位:GB,可以通过 DescribeDBInstanceSpecs
查询实例规格获得不同内存大小对应的磁盘规格下限和上限。
*/
Storage: number;
/**
* 新节点数,传0表示节点数不变
*/
NodeCount?: number;
/**
* 价格金额单位,不传默认单位为分,取值:
* pent:分
* microPent:微分
*/
AmountUnit?: string;
}
/**
* 数据库超期备份配置
*/
export interface NewBackupConfig {
/**
* 备份策略是否启用。
*/
EnableBackupPolicy: boolean;
/**
* 超期保留开始日期,早于开始日期的超期备份不保留,格式:yyyy-mm-dd。
*/
BeginDate: string;
/**
* 超期备份保留时长,超出保留时间的超期备份将被删除,可填写1-3650整数。
*/
MaxRetentionDays: number;
/**
* 备份模式,可选择按年月周模式保存
* 按年:annually
* 按月:monthly
* 按周:weekly
*/
Frequency: string;
/**
* Frequency等于weekly时生效。
表示保留特定工作日备份。可选择周一到周日,支持多选,取星期英文:
* 星期一 :Monday
* 星期二 :Tuesday
* 星期三:Wednesday
* 星期四:Thursday
* 星期五:Friday
* 星期六:Saturday
* 星期日:Sunday
*/
WeekDays?: Array<string>;
/**
* 保留备份个数,Frequency等于monthly或weekly时生效。
备份模式选择按月时,可填写1-28整数;
备份模式选择年时,可填写1-336整数。
*/
BackupCount?: number;
}
/**
* FlushBinlog返回参数结构体
*/
export interface FlushBinlogResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeHourDBInstance返回参数结构体
*/
export interface UpgradeHourDBInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBSecurityGroups返回参数结构体
*/
export interface DescribeDBSecurityGroupsResponse {
/**
* 安全组详情。
*/
Groups?: Array<SecurityGroup>;
/**
* 实例VIP。
*/
VIP?: string;
/**
* 实例端口。
*/
VPort?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CancelDcnJob返回参数结构体
*/
export interface CancelDcnJobResponse {
/**
* 流程ID
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFileDownloadUrl请求参数结构体
*/
export interface DescribeFileDownloadUrlRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 不带签名的文件路径
*/
FilePath: string;
}
/**
* DescribeDBInstanceSpecs返回参数结构体
*/
export interface DescribeDBInstanceSpecsResponse {
/**
* 按机型分类的可售卖规格列表
*/
Specs?: Array<InstanceSpec>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DestroyHourDBInstance返回参数结构体
*/
export interface DestroyHourDBInstanceResponse {
/**
* 异步任务的请求 ID,可使用此 ID [查询异步任务的执行结果](https://cloud.tencent.com/document/product/237/16177)。
*/
FlowId?: number;
/**
* 实例 ID,与入参InstanceId一致。
*/
InstanceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBSyncMode返回参数结构体
*/
export interface DescribeDBSyncModeResponse {
/**
* 同步模式:0 异步,1 强同步, 2 强同步可退化
*/
SyncMode: number;
/**
* 是否有修改流程在执行中:1 是, 0 否。
*/
IsModifying: number;
/**
* 当前复制方式,0 异步,1 同步
*/
CurrentSyncMode: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProjectSecurityGroups请求参数结构体
*/
export interface DescribeProjectSecurityGroupsRequest {
/**
* 数据库引擎名称,本接口取值:mariadb。
*/
Product: string;
/**
* 项目ID。
*/
ProjectId?: number;
}
/**
* DescribeDBSlowLogs请求参数结构体
*/
export interface DescribeDBSlowLogsRequest {
/**
* 实例 ID,形如:tdsql-ow728lmc。
*/
InstanceId: string;
/**
* 从结果的第几条数据开始返回
*/
Offset: number;
/**
* 返回的结果条数
*/
Limit: number;
/**
* 查询的起始时间,形如2016-07-23 14:55:20
*/
StartTime: string;
/**
* 查询的结束时间,形如2016-08-22 14:55:20
*/
EndTime?: string;
/**
* 要查询的具体数据库名称
*/
Db?: string;
/**
* 排序指标,取值为query_time_sum或者query_count
*/
OrderBy?: string;
/**
* 排序类型,desc或者asc
*/
OrderByType?: string;
/**
* 是否查询从机的慢查询,0-主机; 1-从机
*/
Slave?: number;
}
/**
* CreateAccount请求参数结构体
*/
export interface CreateAccountRequest {
/**
* 实例 ID,形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
*/
InstanceId: string;
/**
* 账号名,账号名需要1-32个字符,由字母、数字或特殊字符组成;以字母开头;特殊字符为_-
*/
UserName: string;
/**
* 可以登录的主机,与mysql 账号的 host 格式一致,可以支持通配符,例如 %,10.%,10.20.%。
*/
Host: string;
/**
* 账号密码,密码需要 8\~32 个字符,不能以 '/' 开头,并且至少包含字母、数字和特殊字符 ()~!@#$%^&*-+=_|{}[]:<>,.?/ 中的两项
*/
Password?: string;
/**
* 是否创建为只读账号,0:否; 1:只读账号,该账号的sql请求优先选择备机执行,备机延迟时选择主机执行;2:只读账号,优先选择备机执行,备机延迟时操作报错;3:只读账号,优先选择备机执行,忽略备机延迟只读备机;
*/
ReadOnly?: number;
/**
* 账号备注,可以包含中文、英文字符、常见符号和数字,最多256个字符
*/
Description?: string;
/**
* 根据传入时间判断备机不可用
*/
DelayThresh?: number;
/**
* 针对只读账号,设置策略是否固定备机,0:不固定备机,即备机不满足条件与客户端不断开连接,Proxy选择其他可用备机,1:备机不满足条件断开连接,确保一个连接固定备机。
*/
SlaveConst?: number;
/**
* 用户最大连接数限制参数。不传或者传0表示为不限制,对应max_user_connections参数,目前10.1内核版本不支持设置。
*/
MaxUserConnections?: number;
/**
* 使用GetPublicKey返回的RSA2048公钥加密后的密码
*/
EncryptedPassword?: string;
}
/**
* InitDBInstances返回参数结构体
*/
export interface InitDBInstancesResponse {
/**
* 异步任务ID,可通过 DescribeFlow 查询任务状态。
*/
FlowId: number;
/**
* 透传入参。
*/
InstanceIds: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBParameters返回参数结构体
*/
export interface DescribeDBParametersResponse {
/**
* 实例 ID,形如:tdsql-ow728lmc。
*/
InstanceId: string;
/**
* 请求DB的当前参数值
*/
Params: Array<ParamDesc>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* IsolateHourDBInstance请求参数结构体
*/
export interface IsolateHourDBInstanceRequest {
/**
* 实例ID列表
*/
InstanceIds: Array<string>;
}
/**
* IsolateDBInstance返回参数结构体
*/
export interface IsolateDBInstanceResponse {
/**
* 隔离成功实例ID列表。
*/
SuccessInstanceIds?: Array<string>;
/**
* 隔离失败实例ID列表。
*/
FailedInstanceIds?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLogFileRetentionPeriod请求参数结构体
*/
export interface ModifyLogFileRetentionPeriodRequest {
/**
* 实例 ID,形如:tdsql-ow728lmc。
*/
InstanceId: string;
/**
* 保存的天数,不能超过30
*/
Days: number;
}
/**
* DescribeDatabaseTable请求参数结构体
*/
export interface DescribeDatabaseTableRequest {
/**
* 实例 ID,形如:dcdbt-ow7t8lmc。
*/
InstanceId: string;
/**
* 数据库名称,通过 DescribeDatabases 接口获取。
*/
DbName: string;
/**
* 表名称,通过 DescribeDatabaseObjects 接口获取。
*/
Table: string;
}
/**
* ModifyDBInstanceName返回参数结构体
*/
export interface ModifyDBInstanceNameResponse {
/**
* 实例ID
*/
InstanceId: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLogFileRetentionPeriod请求参数结构体
*/
export interface DescribeLogFileRetentionPeriodRequest {
/**
* 实例 ID,形如:tdsql-ow728lmc。
*/
InstanceId: string;
}
/**
* DescribeFlow返回参数结构体
*/
export interface DescribeFlowResponse {
/**
* 流程状态,0:成功,1:失败,2:运行中
*/
Status: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CloneAccount返回参数结构体
*/
export interface CloneAccountResponse {
/**
* 异步任务流程ID。
*/
FlowId: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 分片节点可用区选择
*/
export interface ZoneChooseInfo {
/**
* 主可用区
*/
MasterZone?: ZonesInfo;
/**
* 可选的从可用区
*/
SlaveZones?: Array<ZonesInfo>;
}
/**
* IsolateDedicatedDBInstance请求参数结构体
*/
export interface IsolateDedicatedDBInstanceRequest {
/**
* 实例 Id,形如:tdsql-ow728lmc。
*/
InstanceId: string;
}
/**
* ModifyAccountDescription返回参数结构体
*/
export interface ModifyAccountDescriptionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 标签
*/
export interface Tag {
/**
* 标签键
*/
TagKey?: string;
/**
* 标签值
*/
TagValue?: string;
}
/**
* 参数约束
*/
export interface ParamConstraint {
/**
* 约束类型,如枚举enum,区间section
*/
Type?: string;
/**
* 约束类型为enum时的可选值列表
*/
Enum?: string;
/**
* 约束类型为section时的范围
注意:此字段可能返回 null,表示取不到有效值。
*/
Range?: ConstraintRange;
/**
* 约束类型为string时的可选值列表
*/
String?: string;
}
/**
* ModifyDBInstancesProject返回参数结构体
*/
export interface ModifyDBInstancesProjectResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云数据库实例备份时间配置信息
*/
export interface DBBackupTimeConfig {
/**
* 实例 ID
*/
InstanceId?: string;
/**
* 每天备份执行的区间的开始时间,格式 mm:ss,形如 22:00
*/
StartBackupTime?: string;
/**
* 每天备份执行的区间的结束时间,格式 mm:ss,形如 23:00
*/
EndBackupTime?: string;
}
/**
* ModifyBackupTime请求参数结构体
*/
export interface ModifyBackupTimeRequest {
/**
* 实例ID,形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
*/
InstanceId: string;
/**
* 每天备份执行的区间的开始时间,格式 mm:ss,形如 22:00
*/
StartBackupTime: string;
/**
* 每天备份执行的区间的结束时间,格式 mm:ss,形如 23:59
*/
EndBackupTime: string;
}
/**
* 数据库视图信息
*/
export interface DatabaseView {
/**
* 视图名称
*/
View?: string;
}
/**
* DescribeDBLogFiles请求参数结构体
*/
export interface DescribeDBLogFilesRequest {
/**
* 实例 ID,形如:tdsql-ow728lmc。
*/
InstanceId: string;
/**
* 请求日志类型,取值只能为1、2、3或者4。1-binlog,2-冷备,3-errlog,4-slowlog。
*/
Type: number;
}
/**
* UpgradeDedicatedDBInstance返回参数结构体
*/
export interface UpgradeDedicatedDBInstanceResponse {
/**
* 异步流程Id
*/
FlowId: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述实例的各个DB节点信息
*/
export interface NodeInfo {
/**
* DB节点ID
*/
NodeId?: string;
/**
* DB节点角色,取值为master或者slave
*/
Role?: string;
/**
* 节点所在可用区
*/
Zone?: string;
}
/**
* DescribeOrders返回参数结构体
*/
export interface DescribeOrdersResponse {
/**
* 返回的订单数量。
*/
TotalCount: number;
/**
* 订单信息列表。
*/
Deals: Array<Deal>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifySyncTaskAttribute返回参数结构体
*/
export interface ModifySyncTaskAttributeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DCN详情条目
*/
export interface DcnDetailItem {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 实例名称
*/
InstanceName?: string;
/**
* 实例地域
*/
Region?: string;
/**
* 实例可用区
*/
Zone?: string;
/**
* 实例IP地址
*/
Vip?: string;
/**
* 实例IPv6地址
*/
Vipv6?: string;
/**
* 实例端口
*/
Vport?: number;
/**
* 实例状态
*/
Status?: number;
/**
* 实例状态描述
*/
StatusDesc?: string;
/**
* 实例DCN标志,1-主,2-备
*/
DcnFlag?: number;
/**
* 实例DCN状态,0-无,1-创建中,2-同步中,3-已断开
*/
DcnStatus?: number;
/**
* 实例CPU核数
*/
Cpu?: number;
/**
* 实例内存大小,单位 GB
*/
Memory?: number;
/**
* 实例存储大小,单位 GB
*/
Storage?: number;
/**
* 付费模式
*/
PayMode?: number;
/**
* 实例创建时间,格式为 2006-01-02 15:04:05
*/
CreateTime?: string;
/**
* 实例到期时间,格式为 2006-01-02 15:04:05
*/
PeriodEndTime?: string;
/**
* 1: 主实例(独享型), 2: 主实例, 3: 灾备实例, 4: 灾备实例(独享型)
*/
InstanceType?: number;
/**
* DCN复制的配置信息;对于主实例,此字段为null
注意:此字段可能返回 null,表示取不到有效值。
*/
ReplicaConfig?: DCNReplicaConfig;
/**
* DCN复制的状态;对于主实例,此字段为null
注意:此字段可能返回 null,表示取不到有效值。
*/
ReplicaStatus?: DCNReplicaStatus;
/**
* 是否开启了 kms
*/
EncryptStatus?: number;
/**
* 实例DCN状态描述信息
*/
DcnStatusDesc?: string;
/**
* DCN实例绑定的北极星服务所属的北极星实例Id,若未绑定则为空
*/
PolarisInstanceId?: string;
/**
* DCN实例绑定的北极星服务所属的北极星实例名,若未绑定则为空
*/
PolarisInstanceName?: string;
/**
* DCN实例绑定的北极星服务所属的北极星命名空间,若未绑定则为空
*/
PolarisNamespace?: string;
/**
* DCN实例绑定的北极星服务,若未绑定则为空
*/
PolarisService?: string;
/**
* DCN实例在北极星服务中的状态 0:未开启; 1:已开启; 2:已隔离; 3:切换中
*/
PolarisServiceStatus?: number;
/**
* DCN实例在北极星服务中的状态的描述信息
*/
PolarisServiceStatusDesc?: string;
/**
* 北极星管控地址
*/
PolarisRegion?: string;
/**
* 是否支持DCN切换
*/
IsDcnSwitchSupported?: number;
}
/**
* ResetAccountPassword请求参数结构体
*/
export interface ResetAccountPasswordRequest {
/**
* 实例 ID,形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
*/
InstanceId: string;
/**
* 登录用户名。
*/
UserName: string;
/**
* 用户允许的访问 host,用户名+host唯一确定一个账号。
*/
Host: string;
/**
* 密码需要 8\~32 个字符,不能以 '/' 开头,并且至少包含字母、数字和特殊字符 ()~!@#$%^&*-+=_|{}[]:<>,.?/ 中的两项
*/
Password?: string;
/**
* 使用GetPublicKey返回的RSA2048公钥加密后的密码
*/
EncryptedPassword?: string;
}
/**
* CopyAccountPrivileges返回参数结构体
*/
export interface CopyAccountPrivilegesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DCN的状态信息
*/
export interface DCNReplicaStatus {
/**
* DCN 的运行状态,START为正常运行,STOP为暂停,
*/
Status?: string;
/**
* 当前延迟情况,取备实例的 master 节点的 delay 值
*/
Delay?: number;
}
/**
* CloneAccount请求参数结构体
*/
export interface CloneAccountRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 源用户账户名
*/
SrcUser: string;
/**
* 源用户HOST
*/
SrcHost: string;
/**
* 目的用户账户名
*/
DstUser: string;
/**
* 目的用户HOST
*/
DstHost: string;
/**
* 目的用户账户描述
*/
DstDesc?: string;
}
/**
* DescribePrice请求参数结构体
*/
export interface DescribePriceRequest {
/**
* 欲新购实例的可用区ID。
*/
Zone: string;
/**
* 实例节点个数,可以通过 DescribeDBInstanceSpecs
查询实例规格获得。
*/
NodeCount: number;
/**
* 内存大小,单位:GB,可以通过 DescribeDBInstanceSpecs
查询实例规格获得。
*/
Memory: number;
/**
* 存储空间大小,单位:GB,可以通过 DescribeDBInstanceSpecs
查询实例规格获得不同内存大小对应的磁盘规格下限和上限。
*/
Storage: number;
/**
* 欲购买的时长,单位:月。
*/
Period?: number;
/**
* 欲购买的数量,默认查询购买1个实例的价格。
*/
Count?: number;
/**
* 付费类型。postpaid:按量付费 prepaid:预付费
*/
Paymode?: string;
/**
* 价格金额单位,不传默认单位为分,取值:
* pent:分
* microPent:微分
*/
AmountUnit?: string;
/**
* Cpu类型,如:英特尔:Intel/AMD,海光:Hygon,默认Intel/AMD
*/
CpuType?: string;
}
/**
* 慢查询条目信息
*/
export interface SlowLogData {
/**
* 语句校验和,用于查询详情
*/
CheckSum?: string;
/**
* 数据库名称
*/
Db?: string;
/**
* 抽象的SQL语句
*/
FingerPrint?: string;
/**
* 平均的锁时间
*/
LockTimeAvg?: string;
/**
* 最大锁时间
*/
LockTimeMax?: string;
/**
* 最小锁时间
*/
LockTimeMin?: string;
/**
* 锁时间总和
*/
LockTimeSum?: string;
/**
* 查询次数
*/
QueryCount?: string;
/**
* 平均查询时间
*/
QueryTimeAvg?: string;
/**
* 最大查询时间
*/
QueryTimeMax?: string;
/**
* 最小查询时间
*/
QueryTimeMin?: string;
/**
* 查询时间总和
*/
QueryTimeSum?: string;
/**
* 扫描行数
*/
RowsExaminedSum?: string;
/**
* 发送行数
*/
RowsSentSum?: string;
/**
* 最后执行时间
*/
TsMax?: string;
/**
* 首次执行时间
*/
TsMin?: string;
/**
* 账号
*/
User?: string;
/**
* 样例Sql
*/
ExampleSql?: string;
/**
* 账户的域名
*/
Host?: string;
}
/**
* 修改参数结果
*/
export interface ParamModifyResult {
/**
* 修改参数名字
*/
Param?: string;
/**
* 参数修改结果。0表示修改成功;-1表示修改失败;-2表示该参数值非法
*/
Code?: number;
}
/**
* DescribeDBInstances请求参数结构体
*/
export interface DescribeDBInstancesRequest {
/**
* 按照一个或者多个实例 ID 查询。实例 ID 形如:tdsql-ow728lmc。每次请求的实例的上限为100。
*/
InstanceIds?: Array<string>;
/**
* 搜索的字段名,当前支持的值有:instancename、vip、all。传 instancename 表示按实例名进行搜索;传 vip 表示按内网IP进行搜索;传 all 将会按实例ID、实例名和内网IP进行搜索。
*/
SearchName?: string;
/**
* 搜索的关键字,支持模糊搜索。多个关键字使用换行符('\n')分割。
*/
SearchKey?: string;
/**
* 按项目 ID 查询
*/
ProjectIds?: Array<number | bigint>;
/**
* 是否根据 VPC 网络来搜索
*/
IsFilterVpc?: boolean;
/**
* 私有网络 ID, IsFilterVpc 为 1 时有效
*/
VpcId?: string;
/**
* 私有网络的子网 ID, IsFilterVpc 为 1 时有效
*/
SubnetId?: string;
/**
* 排序字段, projectId, createtime, instancename 三者之一
*/
OrderBy?: string;
/**
* 排序类型, desc 或者 asc
*/
OrderByType?: string;
/**
* 偏移量,默认为 0
*/
Offset?: number;
/**
* 返回数量,默认为 20,最大值为 100。
*/
Limit?: number;
/**
* 按 OriginSerialId 查询
*/
OriginSerialIds?: Array<string>;
/**
* 标识是否使用ExclusterType字段, false不使用,true使用
*/
IsFilterExcluster?: boolean;
/**
* 实例所属独享集群类型。取值范围:1-非独享集群,2-独享集群, 0-全部
*/
ExclusterType?: number;
/**
* 按独享集群ID过滤实例,独享集群ID形如dbdc-4ih6uct9
*/
ExclusterIds?: Array<string>;
/**
* 按标签key查询
*/
TagKeys?: Array<string>;
/**
* 标签
*/
Tags?: Array<Tag>;
/**
* 实例类型过滤,1-独享实例,2-主实例,3-灾备实例,多个按逗号分隔
*/
FilterInstanceType?: string;
/**
* 按照实例状态进行筛选。状态值 -2:已删除; -1:已隔离;0:创建中;1:流程处理中;2:运行中
*/
Status?: Array<number | bigint>;
/**
* 排除实例状态。状态值 -2:已删除; -1:已隔离;0:创建中;1:流程处理中;2:运行中
*/
ExcludeStatus?: Array<number | bigint>;
}
/**
* DescribeDBSecurityGroups请求参数结构体
*/
export interface DescribeDBSecurityGroupsRequest {
/**
* 数据库引擎名称,本接口取值:mariadb。
*/
Product: string;
/**
* 实例ID。
*/
InstanceId: string;
}
/**
* SwitchDBInstanceHA返回参数结构体
*/
export interface SwitchDBInstanceHAResponse {
/**
* 异步流程Id
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSaleInfo请求参数结构体
*/
export declare type DescribeSaleInfoRequest = null;
/**
* DescribeBackupFiles返回参数结构体
*/
export interface DescribeBackupFilesResponse {
/**
* 备份文件列表
*/
Files?: Array<InstanceBackupFileItem>;
/**
* 总条目数
*/
TotalCount?: number;
/**
* 文件下载链接路径前缀
*/
UrlPrefix?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RenewDBInstance请求参数结构体
*/
export interface RenewDBInstanceRequest {
/**
* 待续费的实例ID。形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
*/
InstanceId: string;
/**
* 续费时长,单位:月。
*/
Period: number;
/**
* 是否自动使用代金券进行支付,默认不使用。
*/
AutoVoucher?: boolean;
/**
* 代金券ID列表,目前仅支持指定一张代金券。
*/
VoucherIds?: Array<string>;
}
/**
* CreateTmpInstances请求参数结构体
*/
export interface CreateTmpInstancesRequest {
/**
* 回档实例的ID列表,形如:tdsql-ow728lmc。
*/
InstanceIds: Array<string>;
/**
* 回档时间点
*/
RollbackTime: string;
}
/**
* RestartDBInstances返回参数结构体
*/
export interface RestartDBInstancesResponse {
/**
* 异步任务ID
*/
FlowId: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProjectSecurityGroups返回参数结构体
*/
export interface DescribeProjectSecurityGroupsResponse {
/**
* 安全组详情。
*/
Groups?: Array<SecurityGroup>;
/**
* 安全组总数。
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据库函数信息
*/
export interface DatabaseFunction {
/**
* 函数名称
*/
Func?: string;
}
/**
* 视图权限信息
*/
export interface ViewPrivileges {
/**
* 数据库名
*/
Database: string;
/**
* 数据库视图名
*/
View: string;
/**
* 权限信息
*/
Privileges: Array<string>;
}
/**
* ResetAccountPassword返回参数结构体
*/
export interface ResetAccountPasswordResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBInstanceDetail返回参数结构体
*/
export interface DescribeDBInstanceDetailResponse {
/**
* 实例Id
*/
InstanceId?: string;
/**
* 实例名称
*/
InstanceName?: string;
/**
* 实例状态
*/
Status?: number;
/**
* 实例目前运行状态描述
*/
StatusDesc?: string;
/**
* 内网 IP 地址
*/
Vip?: string;
/**
* 内网端口
*/
Vport?: number;
/**
* 是否临时实例,0为否,非0为是
*/
IsTmp?: number;
/**
* 节点数,2为一主一从,3为一主二从
*/
NodeCount?: number;
/**
* 实例所在地域名称,如 ap-shanghai
*/
Region?: string;
/**
* 实例所在可用区名称,如 ap-shanghai-1
*/
Zone?: string;
/**
* 字符串型的私有网络Id
*/
VpcId?: string;
/**
* 字符串型的私有网络子网Id
*/
SubnetId?: string;
/**
* 外网状态,0-未开通;1-已开通;2-关闭;3-开通中;4-关闭中
*/
WanStatus?: number;
/**
* 外网访问的域名,公网可解析
*/
WanDomain?: string;
/**
* 外网 IP 地址,公网可访问
*/
WanVip?: string;
/**
* 外网端口
*/
WanPort?: number;
/**
* 实例所属项目 Id
*/
ProjectId?: number;
/**
* TDSQL 版本信息
*/
TdsqlVersion?: string;
/**
* 实例内存大小,单位 GB
*/
Memory?: number;
/**
* 实例存储大小,单位 GB
*/
Storage?: number;
/**
* 主可用区,如 ap-shanghai-1
*/
MasterZone?: string;
/**
* 从可用区列表,如 [ap-shanghai-2]
*/
SlaveZones?: Array<string>;
/**
* 自动续费标志:0 否,1 是
*/
AutoRenewFlag?: number;
/**
* 独享集群Id,普通实例为空
*/
ExclusterId?: string;
/**
* 付费模式:prepaid 表示预付费
*/
PayMode?: string;
/**
* 实例创建时间,格式为 2006-01-02 15:04:05
*/
CreateTime?: string;
/**
* 实例是否支持审计
*/
IsAuditSupported?: boolean;
/**
* 实例到期时间,格式为 2006-01-02 15:04:05
*/
PeriodEndTime?: string;
/**
* 机型信息
*/
Machine?: string;
/**
* 存储空间使用率
*/
StorageUsage?: string;
/**
* 日志存储空间大小,单位 GB
*/
LogStorage?: number;
/**
* 是否支持数据加密。1-支持;0-不支持
*/
IsEncryptSupported?: number;
/**
* 内网IPv6
*/
Vip6?: string;
/**
* 实例Cpu核数
*/
Cpu?: number;
/**
* 产品类型ID
*/
Pid?: number;
/**
* 最大QPS
*/
Qps?: number;
/**
* 是否支持IPv6
*/
Ipv6Flag?: number;
/**
* 外网IPv6地址,公网可访问
*/
WanVipv6?: string;
/**
* 外网状态,0-未开通;1-已开通;2-关闭;3-开通中;4-关闭中
*/
WanStatusIpv6?: number;
/**
* 外网IPv6端口
*/
WanPortIpv6?: number;
/**
* 数据库引擎
*/
DbEngine?: string;
/**
* 数据库版本
*/
DbVersion?: string;
/**
* 标签信息
*/
ResourceTags?: Array<ResourceTag>;
/**
* DCN标志,0-无,1-主实例,2-灾备实例
*/
DcnFlag?: number;
/**
* DCN状态,0-无,1-创建中,2-同步中,3-已断开
*/
DcnStatus?: number;
/**
* DCN灾备实例数
*/
DcnDstNum?: number;
/**
* 1: 主实例(独享型), 2: 主实例, 3: 灾备实例, 4: 灾备实例(独享型)
*/
InstanceType?: number;
/**
* 实例的各个DB节点信息
*/
NodesInfo?: Array<NodeInfo>;
/**
* 实例是否支持设置用户连接数限制,内核为10.1暂不支持。
*/
IsMaxUserConnectionsSupported?: boolean;
/**
* 对外显示的数据库版本
*/
DbVersionId?: string;
/**
* 加密状态, 0-未开启,1-已开启
*/
EncryptStatus?: number;
/**
* DCN的配置信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ReplicaConfig?: DCNReplicaConfig;
/**
* DCN的运行状态
注意:此字段可能返回 null,表示取不到有效值。
*/
ReplicaStatus?: DCNReplicaStatus;
/**
* 独享集群类型,0:公有云, 1:金融围笼, 2:CDC集群
*/
ExclusterType?: number;
/**
* VPC就近访问
*/
RsAccessStrategy?: number;
/**
* 尚未回收的网络资源
*/
ReservedNetResources?: Array<ReservedNetResource>;
/**
* 是否支持物理复制
*/
IsPhysicalReplicationSupported?: boolean;
/**
* 是否支持强同步DCN
*/
IsDcnStrongSyncSupported?: number;
/**
* 是否支持DCN切换
*/
IsDcnSwitchSupported?: number;
/**
* proxy版本号
*/
ProxyVersion?: string;
/**
* Cpu类型,如:英特尔:Intel/AMD,海光:Hygon
*/
CpuType?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDatabaseObjects请求参数结构体
*/
export interface DescribeDatabaseObjectsRequest {
/**
* 实例 ID,形如:dcdbt-ow7t8lmc。
*/
InstanceId: string;
/**
* 数据库名称,通过 DescribeDatabases 接口获取。
*/
DbName: string;
}
/**
* CreateDBInstance返回参数结构体
*/
export interface CreateDBInstanceResponse {
/**
* 长订单号。可以据此调用 DescribeOrders
查询订单详细信息,或在支付失败时调用用户账号相关接口进行支付。
*/
DealName?: string;
/**
* 订单对应的实例 ID 列表,如果此处没有返回实例 ID,可以通过订单查询接口获取。还可通过实例查询接口查询实例是否创建完成。
*/
InstanceIds?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRealServerAccessStrategy请求参数结构体
*/
export interface ModifyRealServerAccessStrategyRequest {
/**
* 实例 ID,格式如:tdsql-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
/**
* RS就近模式, 0-无策略, 1-可用区就近访问。
*/
RsAccessStrategy: number;
}
/**
* 可用区信息
*/
export interface ZonesInfo {
/**
* 可用区英文ID
*/
Zone: string;
/**
* 可用区数字ID
*/
ZoneId: number;
/**
* 可用区中文名
*/
ZoneName: string;
/**
* 是否在售
*/
OnSale: boolean;
}
/**
* DescribeBackupTime请求参数结构体
*/
export interface DescribeBackupTimeRequest {
/**
* 实例ID,形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
*/
InstanceIds: Array<string>;
}
/**
* DescribeSaleInfo返回参数结构体
*/
export interface DescribeSaleInfoResponse {
/**
* 可售卖地域信息列表
*/
RegionList: Array<RegionInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TerminateDedicatedDBInstance返回参数结构体
*/
export interface TerminateDedicatedDBInstanceResponse {
/**
* 异步流程Id
*/
FlowId: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDBEncryptAttributes返回参数结构体
*/
export interface ModifyDBEncryptAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBEncryptAttributes返回参数结构体
*/
export interface DescribeDBEncryptAttributesResponse {
/**
* 是否启用加密,1-已开启;0-未开启。
*/
EncryptStatus?: number;
/**
* DEK密钥
*/
CipherText?: string;
/**
* DEK密钥过期日期。
*/
ExpireDate?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeDedicatedDBInstance请求参数结构体
*/
export interface UpgradeDedicatedDBInstanceRequest {
/**
* 待升级的实例ID。形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例获得。
*/
InstanceId: string;
/**
* 内存大小,单位:GB,可以通过 DescribeFenceDBInstanceSpecs
查询实例规格获得。
*/
Memory: number;
/**
* 存储空间大小,单位:GB,可以通过 DescribeFenceDBInstanceSpecs
查询实例规格获得不同内存大小对应的磁盘规格下限和上限。
*/
Storage: number;
/**
* 错过切换时间窗口时,是否自动重试一次,0-否,1-是
*/
SwitchAutoRetry?: number;
/**
* 切换时间窗口开始时间
*/
SwitchStartTime?: string;
/**
* 切换时间窗口结束时间
*/
SwitchEndTime?: string;
}
/**
* DestroyDBInstance请求参数结构体
*/
export interface DestroyDBInstanceRequest {
/**
* 实例 ID,格式如:tdsqlshard-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
}
/**
* 数据库表信息
*/
export interface DatabaseTable {
/**
* 表名
*/
Table?: string;
}
/**
* DescribeDBInstanceDetail请求参数结构体
*/
export interface DescribeDBInstanceDetailRequest {
/**
* 实例Id形如:tdsql-ow728lmc。
*/
InstanceId: string;
}
/**
* DescribeDBEncryptAttributes请求参数结构体
*/
export interface DescribeDBEncryptAttributesRequest {
/**
* 实例Id,形如:tdsql-ow728lmc。
*/
InstanceId: string;
}
/**
* 订单信息
*/
export interface Deal {
/**
* 订单号
*/
DealName: string;
/**
* 所属账号
*/
OwnerUin: string;
/**
* 商品数量
*/
Count: number;
/**
* 关联的流程 Id,可用于查询流程执行状态
*/
FlowId: number;
/**
* 只有创建实例且已完成发货的订单会填充该字段,表示该订单创建的实例的 ID
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceIds: Array<string>;
/**
* 付费模式,0后付费/1预付费
*/
PayMode: number;
}
/**
* GrantAccountPrivileges请求参数结构体
*/
export interface GrantAccountPrivilegesRequest {
/**
* 实例 ID,形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
*/
InstanceId: string;
/**
* 登录用户名。
*/
UserName: string;
/**
* 用户允许的访问 host,用户名+host唯一确定一个账号。
*/
Host: string;
/**
* 数据库名。如果为 \*,表示设置全局权限(即 \*.\*),此时忽略 Type 和 Object 参数。当DbName不为\*时,需要传入参 Type。
*/
DbName: string;
/**
* 全局权限: SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,INDEX,ALTER,CREATE TEMPORARY TABLES,LOCK TABLES,EXECUTE,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE,EVENT,TRIGGER,SHOW DATABASES,REPLICATION CLIENT,REPLICATION SLAVE
库权限: SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,INDEX,ALTER,CREATE TEMPORARY TABLES,LOCK TABLES,EXECUTE,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE,EVENT,TRIGGER
表/视图权限: SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,INDEX,ALTER,CREATE VIEW,SHOW VIEW,TRIGGER
存储过程/函数权限: ALTER ROUTINE,EXECUTE
字段权限: INSERT,REFERENCES,SELECT,UPDATE
*/
Privileges: Array<string>;
/**
* 类型,可以填入 table 、 view 、 proc 、 func 和 \*。当 DbName 为具体数据库名,Type为 \* 时,表示设置该数据库权限(即db.\*),此时忽略 Object 参数
*/
Type?: string;
/**
* 具体的 Type 的名称,例如 Type 为 table 时就是具体的表名。DbName 和 Type 都为具体名称,则 Object 表示具体对象名,不能为 \* 或者为空
*/
Object?: string;
/**
* 当 Type=table 时,ColName 为 \* 表示对表授权,如果为具体字段名,表示对字段授权
*/
ColName?: string;
}
/**
* DescribeBinlogTime请求参数结构体
*/
export interface DescribeBinlogTimeRequest {
/**
* 实例 ID,形如:tdsql-ow728lmc。
*/
InstanceId: string;
}
/**
* CreateDedicatedClusterDBInstance请求参数结构体
*/
export interface CreateDedicatedClusterDBInstanceRequest {
/**
* 分配实例个数
*/
GoodsNum: number;
/**
* 內存大小,单位GB
*/
Memory: number;
/**
* 磁盘大小,单位GB
*/
Storage: number;
/**
* 独享集群集群uuid
*/
ClusterId: string;
/**
* (废弃)可用区
*/
Zone?: string;
/**
* 项目ID
*/
ProjectId?: number;
/**
* (废弃)Pid,可通过获取独享集群售卖配置接口得到
*/
Pid?: number;
/**
* (废弃)机型
*/
Machine?: string;
/**
* 网络Id
*/
VpcId?: string;
/**
* 子网Id
*/
SubnetId?: string;
/**
* db类型,不传默认8.0
*/
DbVersionId?: string;
/**
* (废弃)是否手动指定一组服务器分配, 运维使用
*/
Manual?: number;
/**
* (废弃)DeviceNo参数
*/
DeviceNo?: string;
/**
* 安全组ID
*/
SecurityGroupIds?: Array<string>;
/**
* DCN源实例ID
*/
DcnInstanceId?: string;
/**
* DCN源实例地域名
*/
DcnRegion?: string;
/**
* 自定义实例名称
*/
InstanceName?: string;
/**
* 标签
*/
ResourceTags?: Array<ResourceTag>;
/**
* 支持IPv6标志:1 支持, 0 不支持
*/
Ipv6Flag?: number;
/**
* 参数列表。本接口的可选值为:character_set_server(字符集,必传),lower_case_table_names(表名大小写敏感,必传,0 - 敏感;1-不敏感),innodb_page_size(innodb数据页,默认16K),sync_mode(同步模式:0 - 异步; 1 - 强同步;2 - 强同步可退化。默认为强同步可退化)。
*/
InitParams?: Array<DBParamValue>;
/**
* 实例节点数
*/
NodeNum?: number;
/**
* 指定主节点uuid,不填随机分配
*/
MasterHostId?: string;
/**
* 指定从节点uuid,不填随机分配
*/
SlaveHostIds?: Array<string>;
/**
* 需要回档的源实例ID
*/
RollbackInstanceId?: string;
/**
* 回档时间
*/
RollbackTime?: string;
/**
* DCN同步模式,0:异步, 1:强同步
*/
DcnSyncMode?: number;
}
/**
* SwitchDBInstanceHA请求参数结构体
*/
export interface SwitchDBInstanceHARequest {
/**
* 实例Id,形如 tdsql-ow728lmc
*/
InstanceId: string;
/**
* 指定可用区标识符,具体含义由zoneMode参数决定。
- 当zoneMode为target时表示目标可用区
- 当zoneMode为avoid时表示需避开的故障可用区
*/
Zone: string;
/**
* 可用区模式选择器,定义zone参数的语义类型。
- 默认值:target
- 可选值:target, avoid
*/
ZoneMode?: string;
}
/**
* 云数据库参数信息。
*/
export interface DBParamValue {
/**
* 参数名称
*/
Param: string;
/**
* 参数值
*/
Value: string;
}
/**
* 实例可售卖规格详细信息,创建实例和扩容实例时 Pid+MemSize 唯一确定一种售卖规格,磁盘大小可用区间为[MinDataDisk,MaxDataDisk]
*/
export interface SpecConfigInfo {
/**
* 设备型号
*/
Machine?: string;
/**
* 内存大小,单位 GB
*/
Memory?: number;
/**
* 数据盘规格最小值,单位 GB
*/
MinStorage?: number;
/**
* 数据盘规格最大值,单位 GB
*/
MaxStorage?: number;
/**
* 推荐的使用场景
*/
SuitInfo?: string;
/**
* 最大 Qps 值
*/
Qps?: number;
/**
* 产品类型 Id
*/
Pid?: number;
/**
* 节点个数,2 表示一主一从,3 表示一主二从
*/
NodeCount?: number;
/**
* Cpu核数
*/
Cpu?: number;
}
/**
* 临时实例
*/
export interface TmpInstance {
/**
* 应用ID
*/
AppId?: number;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 实例备注
*/
InstanceRemark?: string;
/**
* 0:非临时实例 ,1:无效临时实例, 2:回档成功的有效临时实例
*/
TempType?: number;
/**
* 实例状态,0:待初始化,1:流程处理中,2:有效状态,-1:已隔离,-2:已下线
*/
Status?: number;
/**
* 实例 ID,形如:tdsql-ow728lmc。
*/
InstanceId?: string;
/**
* 实例虚IP
*/
Vip?: string;
/**
* 实例虚端口
*/
Vport?: number;
/**
* 有效期结束时间
*/
PeriodEndTime?: string;
/**
* 源实例 ID,形如:tdsql-ow728lmc。
*/
SrcInstanceId?: string;
/**
* 实例状态描述
*/
StatusDesc?: string;
/**
* 实例所在地域
*/
Region?: string;
/**
* 实例所在可用区
*/
Zone?: string;
/**
* 实例虚IPv6
*/
Vipv6?: string;
/**
* 实例IPv6标志
*/
Ipv6Flag?: number;
}
/**
* ModifyDBParameters请求参数结构体
*/
export interface ModifyDBParametersRequest {
/**
* 实例 ID,形如:tdsql-ow728lmc。
*/
InstanceId: string;
/**
* 参数列表,每一个元素是Param和Value的组合
*/
Params: Array<DBParamValue>;
}
/**
* DescribeBackupConfigs请求参数结构体
*/
export interface DescribeBackupConfigsRequest {
/**
* 实例 ID,格式如:tdsql-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
*/
InstanceId: string;
}
/**
* ModifyDBInstanceSecurityGroups请求参数结构体
*/
export interface ModifyDBInstanceSecurityGroupsRequest {
/**
* 数据库引擎名称,本接口取值:mariadb。
*/
Product: string;
/**
* 实例ID。
*/
InstanceId: string;
/**
* 要修改的安全组 ID 列表,一个或者多个安全组 ID 组成的数组
*/
SecurityGroupIds: Array<string>;
}
/**
* DescribeDcnDetail请求参数结构体
*/
export interface DescribeDcnDetailRequest {
/**
* 实例ID
*/
InstanceId: string;
}
/**
* DescribeFileDownloadUrl返回参数结构体
*/
export interface DescribeFileDownloadUrlResponse {
/**
* 带签名的下载连接
*/
PreSignedUrl: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDBParameters返回参数结构体
*/
export interface ModifyDBParametersResponse {
/**
* 实例 ID,形如:tdsql-ow728lmc。
*/
InstanceId: string;
/**
* 参数修改结果
*/
Result: Array<ParamModifyResult>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CopyAccountPrivileges请求参数结构体
*/
export interface CopyAccountPrivilegesRequest {
/**
* 实例 ID,形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
*/
InstanceId: string;
/**
* 源用户名
*/
SrcUserName: string;
/**
* 源用户允许的访问 host
*/
SrcHost: string;
/**
* 目的用户名
*/
DstUserName: string;
/**
* 目的用户允许的访问 host
*/
DstHost: string;
/**
* 源账号的 ReadOnly 属性
*/
SrcReadOnly?: string;
/**
* 目的账号的 ReadOnly 属性
*/
DstReadOnly?: string;
}
/**
* 安全组详情
*/
export interface SecurityGroup {
/**
* 项目ID
*/
ProjectId?: number;
/**
* 创建时间,时间格式:yyyy-mm-dd hh:mm:ss
*/
CreateTime?: string;
/**
* 安全组ID
*/
SecurityGroupId?: string;
/**
* 安全组名称
*/
SecurityGroupName?: string;
/**
* 安全组备注
*/
SecurityGroupRemark?: string;
/**
* 入站规则
*/
Inbound?: Array<SecurityGroupBound>;
/**
* 出站规则
*/
Outbound?: Array<SecurityGroupBound>;
}
/**
* DescribeBackupFiles请求参数结构体
*/
export interface DescribeBackupFilesRequest {
/**
* 按实例ID查询
*/
InstanceId?: string;
/**
* 备份类型,Data:数据备份,Binlog:Binlog备份,Errlog:错误日志,Slowlog:慢日志
*/
BackupType?: string;
/**
* 按开始时间查询
*/
StartTime?: string;
/**
* 按结束时间查询
*/
EndTime?: string;
/**
* 分页参数
*/
Limit?: number;
/**
* 分页参数
*/
Offset?: number;
/**
* 排序参数,可选值:Time,Size
*/
OrderBy?: string;
/**
* 排序参数, 可选值:DESC,ASC
*/
OrderType?: string;
}
/**
* OpenDBExtranetAccess返回参数结构体
*/
export interface OpenDBExtranetAccessResponse {
/**
* 异步任务ID,可通过 DescribeFlow 查询任务状态。
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* KillSession请求参数结构体
*/
export interface KillSessionRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 会话ID列表
*/
SessionId: Array<number | bigint>;
}
/**
* TerminateDedicatedDBInstance请求参数结构体
*/
export interface TerminateDedicatedDBInstanceRequest {
/**
* 实例 Id,形如:tdsql-ow728lmc。
*/
InstanceId: string;
}
/**
* DescribeDatabaseObjects返回参数结构体
*/
export interface DescribeDatabaseObjectsResponse {
/**
* 透传入参。
*/
InstanceId?: string;
/**
* 数据库名称。
*/
DbName?: string;
/**
* 表列表。
*/
Tables?: Array<DatabaseTable>;
/**
* 视图列表。
*/
Views?: Array<DatabaseView>;
/**
* 存储过程列表。
*/
Procs?: Array<DatabaseProcedure>;
/**
* 函数列表。
*/
Funcs?: Array<DatabaseFunction>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDBInstanceName请求参数结构体
*/
export interface ModifyDBInstanceNameRequest {
/**
* 待修改的实例 ID。形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
*/
InstanceId: string;
/**
* 新的实例名称。允许的字符为字母、数字、下划线、连字符和中文。
*/
InstanceName: string;
}
/**
* DeleteAccount请求参数结构体
*/
export interface DeleteAccountRequest {
/**
* 实例ID,形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
*/
InstanceId: string;
/**
* 用户名
*/
UserName: string;
/**
* 用户允许的访问 host
*/
Host: string;
}
/**
* DescribeBinlogTime返回参数结构体
*/
export interface DescribeBinlogTimeResponse {
/**
* 开始时间
*/
StartTime?: string;
/**
* 结束时间
*/
EndTime?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBackupConfigs返回参数结构体
*/
export interface DescribeBackupConfigsResponse {
/**
* 实例 ID。
*/
InstanceId?: string;
/**
* 常规备份存储时长,范围[1, 3650]。
*/
Days?: number;
/**
* 每天备份执行的区间的开始时间,格式 mm:ss,形如 22:00。
*/
StartBackupTime?: string;
/**
* 每天备份执行的区间的结束时间,格式 mm:ss,形如 23:59。
*/
EndBackupTime?: string;
/**
* 执行备份周期,枚举值:Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
*/
WeekDays?: Array<string>;
/**
* 沉降到归档存储时长,-1表示关闭归档设置。
*/
ArchiveDays?: number;
/**
* 超期备份配置。
*/
BackupConfigSet?: Array<BackupConfig>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeHourDBInstance请求参数结构体
*/
export interface UpgradeHourDBInstanceRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 内存大小,单位:GB
*/
Memory: number;
/**
* 存储大小,单位:GB
*/
Storage: number;
/**
* 切换开始时间,格式如: "2019-12-12 07:00:00"。开始时间必须在当前时间一个小时以后,3天以内。
*/
SwitchStartTime?: string;
/**
* 切换结束时间, 格式如: "2019-12-12 07:15:00",结束时间必须大于开始时间。
*/
SwitchEndTime?: string;
/**
* 是否自动重试。 0:不自动重试 1:自动重试
*/
SwitchAutoRetry?: number;
/**
* 变更部署时指定的新可用区列表,第1个为主可用区,其余为从可用区
*/
Zones?: Array<string>;
}
/**
* 数据库列信息
*/
export interface TableColumn {
/**
* 列名称
*/
Col?: string;
/**
* 列类型
*/
Type?: string;
}
/**
* CreateTmpInstances返回参数结构体
*/
export interface CreateTmpInstancesResponse {
/**
* 异步任务流程ID。
*/
FlowId: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeDBInstance请求参数结构体
*/
export interface UpgradeDBInstanceRequest {
/**
* 待升级的实例ID。形如:tdsql-ow728lmc