udb

package
v0.22.21 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 25, 2024 License: Apache-2.0 Imports: 4 Imported by: 5

Documentation

Overview

Package udb include resources of ucloud udb product

See also

for detail.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BackupUDBInstanceBinlogRequest 

type BackupUDBInstanceBinlogRequest struct {
	request.CommonBase

	// 需要备份文件,可通过DescribeUDBInstanceBinlog获得 如果要传入多个文件名，以空格键分割,用单引号包含.
	BackupFile *string `required:"true"`

	// DB备份文件名称
	BackupName *string `required:"false"`

	// DB实例Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`
}

BackupUDBInstanceBinlogRequest is request schema for BackupUDBInstanceBinlog action

type BackupUDBInstanceBinlogResponse 

type BackupUDBInstanceBinlogResponse struct {
	response.CommonBase
}

BackupUDBInstanceBinlogResponse is response schema for BackupUDBInstanceBinlog action

type BackupUDBInstanceErrorLogRequest 

type BackupUDBInstanceErrorLogRequest struct {
	request.CommonBase

	// 备份名称
	BackupName *string `required:"true"`

	// DB实例Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`
}

BackupUDBInstanceErrorLogRequest is request schema for BackupUDBInstanceErrorLog action

type BackupUDBInstanceErrorLogResponse 

type BackupUDBInstanceErrorLogResponse struct {
	response.CommonBase
}

BackupUDBInstanceErrorLogResponse is response schema for BackupUDBInstanceErrorLog action

type BackupUDBInstanceRequest 

type BackupUDBInstanceRequest struct {
	request.CommonBase

	// 使用的备份方式。默认使用逻辑备份（快照备份即物理备份。SSD版本的mysql/mongodb实例支持设置为snapshot，NVMe版本的mysql实例支持设置为xtrabackup）
	BackupMethod *string `required:"false"`

	// 备份名称
	BackupName *string `required:"true"`

	// 备份黑名单列表，以 ; 分隔。注意：只有逻辑备份下备份黑名单才生效，快照备份备份黑名单下无效
	Blacklist *string `required:"false"`

	// DB实例Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// true表示逻辑备份时是使用 --force 参数，false表示不使用 --force 参数。物理备份此参数无效。
	ForceBackup *bool `required:"false"`

	// 是否使用黑名单备份，默认false
	UseBlacklist *bool `required:"false"`
}

BackupUDBInstanceRequest is request schema for BackupUDBInstance action

type BackupUDBInstanceResponse 

type BackupUDBInstanceResponse struct {
	response.CommonBase
}

BackupUDBInstanceResponse is response schema for BackupUDBInstance action

type BackupUDBInstanceSlowLogRequest 

type BackupUDBInstanceSlowLogRequest struct {
	request.CommonBase

	// 备份文件名称
	BackupName *string `required:"true"`

	// 过滤条件:起始时间(时间戳)
	BeginTime *int `required:"true"`

	// DB实例Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// 过滤条件:结束时间(时间戳)
	EndTime *int `required:"true"`
}

BackupUDBInstanceSlowLogRequest is request schema for BackupUDBInstanceSlowLog action

type BackupUDBInstanceSlowLogResponse 

type BackupUDBInstanceSlowLogResponse struct {
	response.CommonBase
}

BackupUDBInstanceSlowLogResponse is response schema for BackupUDBInstanceSlowLog action

type ChangeUDBParamGroupRequest added in v0.21.3 

type ChangeUDBParamGroupRequest struct {
	request.CommonBase

	// DB实例Id
	DBId *string `required:"true"`

	// 参数组Id
	GroupId *string `required:"true"`
}

ChangeUDBParamGroupRequest is request schema for ChangeUDBParamGroup action

type ChangeUDBParamGroupResponse added in v0.21.3 

type ChangeUDBParamGroupResponse struct {
	response.CommonBase
}

ChangeUDBParamGroupResponse is response schema for ChangeUDBParamGroup action

type CheckRecoverUDBInstanceRequest 

type CheckRecoverUDBInstanceRequest struct {
	request.CommonBase

	// 源实例的Id(只支持普通版DB不支持高可用)
	SrcDBId *string `required:"true"`
}

CheckRecoverUDBInstanceRequest is request schema for CheckRecoverUDBInstance action

type CheckRecoverUDBInstanceResponse 

type CheckRecoverUDBInstanceResponse struct {
	response.CommonBase

	// 核查成功返回值为可以回档到的最近时刻,核查失败不返回
	LastestTime int
}

CheckRecoverUDBInstanceResponse is response schema for CheckRecoverUDBInstance action

type CheckUDBInstanceToHAAllowanceRequest 

type CheckUDBInstanceToHAAllowanceRequest struct {
	request.CommonBase

	// 实例的Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`
}

CheckUDBInstanceToHAAllowanceRequest is request schema for CheckUDBInstanceToHAAllowance action

type CheckUDBInstanceToHAAllowanceResponse 

type CheckUDBInstanceToHAAllowanceResponse struct {
	response.CommonBase

	// Yes ，No ，Yes即可以升级，No为不可以升级
	Allowance string
}

CheckUDBInstanceToHAAllowanceResponse is response schema for CheckUDBInstanceToHAAllowance action

type ClearUDBLogRequest 

type ClearUDBLogRequest struct {
	request.CommonBase

	// 删除时间点(至少前一天)之前log，采用时间戳(秒)，默认当 前时间点前一天
	BeforeTime *int `required:"false"`

	// DB实例的id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// 日志类型，10-error（暂不支持）、20-slow（暂不支持 ）、30-binlog
	LogType *int `required:"true"`
}

ClearUDBLogRequest is request schema for ClearUDBLog action

type ClearUDBLogResponse 

type ClearUDBLogResponse struct {
	response.CommonBase
}

ClearUDBLogResponse is response schema for ClearUDBLog action

type ConnNumMap added in v0.21.29 

type ConnNumMap struct {

	// 客户端IP
	Ip string

	// 该Ip连接数
	Num int
}

ConnNumMap - db实例ip和连接数信息

type CreateMongoDBReplicaSetRequest added in v0.21.3 

type CreateMongoDBReplicaSetRequest struct {
	request.CommonBase

	// 管理员密码
	AdminPassword *string `required:"true"`

	// 管理员帐户名，默认root
	AdminUser *string `required:"false"`

	// 备份策略，每周备份数量，默认7次
	BackupCount *int `required:"false"`

	// 备份策略，备份时间间隔，单位小时计，默认24小时
	BackupDuration *int `required:"false"`

	// 备份策略，备份开始时间，单位小时计，默认1点
	BackupTime *int `required:"false"`

	// cpu核数
	CPU *int `required:"false"`

	// Year， Month， Dynamic，Trial，默认: Month
	ChargeType *string `required:"false"`

	// 所属分片集群的ID
	ClusterId *string `required:"false"`

	// CouponId.0 代表第一个代金券id，对于传入多个代金券id，后面为 CouponId.1, CouponId.2 以此类推
	CouponId []string `required:"false"`

	// DB类型id对应的字符串形式 mongodb-3.4,mongodb-3.6,mongodb-4.0
	DBTypeId *string `required:"true"`

	// 磁盘空间(GB), 暂时支持20G - 3000G
	DiskSpace *int `required:"true"`

	// 内存限制(MB)，目前支持以下几档 2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M
	MemoryLimit *int `required:"true"`

	// PrimaryDB实例名称，至少6位
	Name *string `required:"true"`

	// DB实例使用的配置参数组id
	ParamGroupId *int `required:"true"`

	// 端口号
	Port *int `required:"true"`

	// 购买时长(N个月)，默认值1个月。如果为0，代表购买到月底。
	Quantity *int `required:"false"`

	// 子网ID
	SubnetId *string `required:"false"`

	// VPC的ID
	VPCId *string `required:"false"`
}

CreateMongoDBReplicaSetRequest is request schema for CreateMongoDBReplicaSet action

type CreateMongoDBReplicaSetResponse added in v0.21.3 

type CreateMongoDBReplicaSetResponse struct {
	response.CommonBase

	// 返回所有副本集成员的Id
	DBIds []string
}

CreateMongoDBReplicaSetResponse is response schema for CreateMongoDBReplicaSet action

type CreateUDBInstanceByRecoveryRequest 

type CreateUDBInstanceByRecoveryRequest struct {
	request.CommonBase

	// 管理员密码 (指定库表回档到新实例时有效)
	AdminPassword *string `required:"false"`

	// Year， Month， Dynamic，Trial，默认: Dynamic
	ChargeType *string `required:"false"`

	// 使用的代金券id
	CouponId *string `required:"false"`

	// 是否创建使用ipv6 资源， 默认为false， 或者不填， 创建ipv6为true
	EnableIpV6 *bool `required:"false"`

	// 规格类型ID,当SpecificationType为1时有效
	MachineType *string `required:"false"`

	// 实例名称，至少6位
	Name *string `required:"true"`

	// 购买时长，默认值1
	Quantity *int `required:"false"`

	// 恢复到某个时间点的时间戳(UTC时间格式，默认单位秒)
	RecoveryTime *int `required:"true"`

	// 实例计算规格类型，0或不传代表使用内存方式购买，1代表使用内存-cpu可选配比方式购买，需要填写MachineType
	SpecificationType *int `required:"false"`

	// 源实例的Id
	SrcDBId *string `required:"true"`

	// 子网ID
	SubnetId *string `required:"false"`

	// 指定需要恢复的表, 如果指定该字段则回档实例只有指定的表数据，格式为(库名.表名)， 指定多个用逗号隔开，eg: [ udb.test, mysql_school.my_student]
	Tables *string `required:"false"`

	// 专区的Id
	UDBCId *string `required:"false"`

	// 指定是否是否使用SSD，默认使用主库的配置
	UseSSD *bool `required:"false"`

	// VPC的ID
	VPCId *string `required:"false"`
}

CreateUDBInstanceByRecoveryRequest is request schema for CreateUDBInstanceByRecovery action

type CreateUDBInstanceByRecoveryResponse 

type CreateUDBInstanceByRecoveryResponse struct {
	response.CommonBase

	// db实例id
	DBId string
}

CreateUDBInstanceByRecoveryResponse is response schema for CreateUDBInstanceByRecovery action

type CreateUDBInstanceRequest 

type CreateUDBInstanceRequest struct {
	request.CommonBase

	// 管理员密码
	AdminPassword *string `required:"true"`

	// 管理员帐户名，默认root
	AdminUser *string `required:"false"`

	// 备份策略，每周备份数量，默认7次
	BackupCount *int `required:"false"`

	// 备份策略，备份时间间隔，单位小时计，默认24小时
	BackupDuration *int `required:"false"`

	// 备份id，如果指定，则表明从备份恢复实例
	BackupId *int `required:"false"`

	// 备份策略，备份开始时间，单位小时计，默认1点
	BackupTime *int `required:"false"`

	// 跨可用区高可用备库所在可用区，参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
	BackupZone *string `required:"false"`

	// cpu核数，如果db类型为sqlserver，必传参数
	CPU *int `required:"false"`

	// mysql大小写参数, 0 为大小写敏感, 1 为大小写不敏感, 目前只针对mysql8.0有效
	CaseSensitivityParam *int `required:"false"`

	// Year， Month， Dynamic，Trial，默认: Month
	ChargeType *string `required:"false"`

	// 当DB类型(DBTypeId)为mongodb时，需要指定mongo的角色，可选值为configsrv (配置节点)，shardsrv (数据节点)
	ClusterRole *string `required:"false"`

	// 使用的代金券id
	CouponId *string `required:"false"`

	// mysql小版本号，支持指定小版本创建
	DBSubVersion *string `required:"false"`

	// DB类型，mysql/mongodb/postgesql/sqlserver按版本细分 mysql-8.0, mysql-5.5, percona-5.5, mysql-5.6, percona-5.6, mysql-5.7, percona-5.7, mariadb-10.0, postgresql-9.6, postgresql-10.4, postgresql-12.8, postgresql-13.4，mongodb-2.6, mongodb-3.0, mongodb-3.6, mongodb-4.0, sqlserver-2017
	DBTypeId *string `required:"true"`

	// 是否开启异步高可用，默认不填，可置为true
	DisableSemisync *bool `required:"false"`

	// 磁盘空间(GB), 暂时支持20G - 32T
	DiskSpace *int `required:"true"`

	// UDB实例模式类型, 可选值如下: "Normal": 普通版UDB实例 "HA": 高可用版UDB实例 默认是"Normal"
	InstanceMode *string `required:"false"`

	// 【该字段已废弃，请谨慎使用】
	InstanceType *string `required:"false" deprecated:"true"`

	// 规格类型ID,当SpecificationType为1时有效
	MachineType *string `required:"false"`

	// 内存限制(MB)，目前支持以下几档 2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M/128000M/192000M/256000M/320000M
	MemoryLimit *int `required:"false"`

	// 实例名称，至少6位
	Name *string `required:"true"`

	// DB实例使用的配置参数组id
	ParamGroupId *int `required:"true"`

	// 端口号，mysql默认3306，mongodb默认27017，postgresql默认5432
	Port *int `required:"true"`

	// 购买时长，默认值1
	Quantity *int `required:"false"`

	// SSD类型，可选值为"SATA"、“NVMe”，默认为“SATA”
	SSDType *string `required:"false"`

	// 实例计算规格类型，0或不传代表使用内存方式购买，1代表使用内存-cpu可选配比方式购买，需要填写MachineType
	SpecificationType *string `required:"false"`

	// 子网ID
	SubnetId *string `required:"false"`

	// 实例所在的业务组名称
	Tag *string `required:"false"`

	// 【该字段已废弃，请谨慎使用】
	UDBCId *string `required:"false" deprecated:"true"`

	// 【该字段已废弃，请谨慎使用】
	UseSSD *bool `required:"false" deprecated:"true"`

	// VPC的ID
	VPCId *string `required:"false"`
}

CreateUDBInstanceRequest is request schema for CreateUDBInstance action

type CreateUDBInstanceResponse 

type CreateUDBInstanceResponse struct {
	response.CommonBase

	// BD实例id
	DBId string
}

CreateUDBInstanceResponse is response schema for CreateUDBInstance action

type CreateUDBParamGroupRequest 

type CreateUDBParamGroupRequest struct {
	request.CommonBase

	// DB类型id，mysql/mongodb/postgesql按版本细分 1：mysql-5.1，2：mysql-5.5，3：percona-5.5，4：mysql-5.6，5：percona-5.6，6：mysql-5.7，7：percona-5.7，8：mariadb-10.0，9：mongodb-2.4，10：mongodb-2.6，11：mongodb-3.0，12：mongodb-3.2,13：postgresql-9.4，14：postgresql-9.6
	DBTypeId *string `required:"true"`

	// 参数组描述
	Description *string `required:"true"`

	// 新配置参数组名称
	GroupName *string `required:"true"`

	// 是否是地域级别的配置文件，默认是false
	RegionFlag *bool `required:"false"`

	// 源参数组id
	SrcGroupId *int `required:"true"`
}

CreateUDBParamGroupRequest is request schema for CreateUDBParamGroup action

type CreateUDBParamGroupResponse 

type CreateUDBParamGroupResponse struct {
	response.CommonBase

	// 新配置参数组id
	GroupId int
}

CreateUDBParamGroupResponse is response schema for CreateUDBParamGroup action

type CreateUDBReplicationInstanceRequest 

type CreateUDBReplicationInstanceRequest struct {
	request.CommonBase

	// Year， Month， Dynamic，Trial，默认和主库保持一致
	ChargeType *string `required:"false"`

	// 使用的代金券id
	CouponId *string `required:"false"`

	// UDB数据库机型: "Normal": "标准机型" , "SATA_SSD": "SSD机型" , "PCIE_SSD": "SSD高性能机型" , "Normal_Volume": "标准大容量机型", "SATA_SSD_Volume": "SSD大容量机型" , "PCIE_SSD_Volume": "SSD高性能大容量机型", "NVMe_SSD": "快杰机型"
	InstanceType *string `required:"false"`

	// 是否是仲裁节点，默认false，仲裁节点按最小机型创建
	IsArbiter *bool `required:"false"`

	// 实例名称，至少6位
	Name *string `required:"true"`

	// 端口号，默认27017，取值范围3306至65535。
	Port *int `required:"false"`

	// 购买时长，默认默认和主库保持一致
	Quantity *string `required:"false"`

	// primary节点的DBId,该值可以通过DescribeUDBInstance获取
	SrcId *string `required:"true"`

	// 是否使用SSD，默认为true。目前主要可用区、海外机房、新机房只提供SSD资源，非SSD资源不再提供。
	UseSSD *bool `required:"false"`
}

CreateUDBReplicationInstanceRequest is request schema for CreateUDBReplicationInstance action

type CreateUDBReplicationInstanceResponse 

type CreateUDBReplicationInstanceResponse struct {
	response.CommonBase

	// 创建从节点的DBId
	DBId string
}

CreateUDBReplicationInstanceResponse is response schema for CreateUDBReplicationInstance action

type CreateUDBRouteInstanceRequest 

type CreateUDBRouteInstanceRequest struct {
	request.CommonBase

	// Year， Month， Dynamic，Trial，默认: Month
	ChargeType *string `required:"false"`

	// 配置服务器的dbid，允许一个或者三个。
	ConfigsvrId []string `required:"true"`

	// 使用的代金券id
	CouponId *string `required:"false"`

	// DB类型id，mongodb按版本细分有1：mongodb-2.4，2：mongodb-2.6,3：mongodb-3.0，4：mongodb-3.2
	DBTypeId *string `required:"true"`

	// 磁盘空间(GB), 暂时支持20G - 500G
	DiskSpace *int `required:"true"`

	// 内存限制(MB)，目前支持以下几档 600M/1500M/3000M /6000M/15000M/30000M
	MemoryLimit *int `required:"true"`

	// 实例名称，至少6位
	Name *string `required:"true"`

	// DB实例使用的配置参数组id
	ParamGroupId *int `required:"true"`

	// 端口号，mongodb默认27017
	Port *int `required:"true"`

	// 购买时长，默认值1
	Quantity *int `required:"false"`

	// 是否使用SSD，默认为ture
	UseSSD *bool `required:"false"`
}

CreateUDBRouteInstanceRequest is request schema for CreateUDBRouteInstance action

type CreateUDBRouteInstanceResponse 

type CreateUDBRouteInstanceResponse struct {
	response.CommonBase

	// db实例id
	DBId string
}

CreateUDBRouteInstanceResponse is response schema for CreateUDBRouteInstance action

type CreateUDBSlaveRequest 

type CreateUDBSlaveRequest struct {
	request.CommonBase

	// Year， Month， Dynamic，Trial，默认和主库保持一致
	ChargeType *string `required:"false"`

	// 使用的代金券id
	CouponId *string `required:"false"`

	// 设置从库的延时复制时长（单位秒）
	DelaySeconds *int `required:"false"`

	// 磁盘空间(GB), 暂时支持20G - 3000G（API支持，前端暂时只开放内存定制）
	DiskSpace *int `required:"false"`

	// 【该字段已废弃，请谨慎使用】
	InstanceMode *string `required:"false" deprecated:"true"`

	// 【该字段已废弃，请谨慎使用】
	InstanceType *string `required:"false" deprecated:"true"`

	// 使用物理方式创建从库，目前仅限创建快杰从库，默认为false
	IsCreatePhysically *bool `required:"false"`

	// 是否锁主库，默认为true
	IsLock *bool `required:"false"`

	// 规格类型ID,当SpecificationType为1时有效
	MachineType *string `required:"false"`

	// 内存限制(MB)，目前支持以下几档 2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M/128000M/192000M/256000M/320000M
	MemoryLimit *int `required:"false"`

	// 实例名称，至少6位
	Name *string `required:"true"`

	// DB实例使用的配置参数组id，默认和主库保持一致
	ParamGroupId *int `required:"false"`

	// 端口号
	Port *int `required:"false"`

	// 购买时长，默认默认和主库保持一致
	Quantity *int `required:"false"`

	// 仅对主为SSD型实例有效。 可选值"SATA","NVMe"
	SSDType *string `required:"false"`

	// 实例计算规格类型，0或不传代表使用内存方式购买，1代表使用内存-cpu可选配比方式购买，需要填写MachineType
	SpecificationType *int `required:"false"`

	// master实例的DBId,该值可以通过DescribeUDBInstance获取
	SrcId *string `required:"true"`

	// 子网ID（如果不传用默认子网）
	SubnetId *string `required:"false"`

	// 【该字段已废弃，请谨慎使用】
	UseSSD *bool `required:"false" deprecated:"true"`

	// VPCID（如果不传用默认的VPC）
	VPCId *string `required:"false"`
}

CreateUDBSlaveRequest is request schema for CreateUDBSlave action

type CreateUDBSlaveResponse 

type CreateUDBSlaveResponse struct {
	response.CommonBase

	// 创建slave的DBId
	DBId string
}

CreateUDBSlaveResponse is response schema for CreateUDBSlave action

type DeleteUDBBackupRequest 

type DeleteUDBBackupRequest struct {
	request.CommonBase

	//
	BackupId *int `required:"true"`

	//
	BackupZone *string `required:"false"`
}

DeleteUDBBackupRequest is request schema for DeleteUDBBackup action

type DeleteUDBBackupResponse 

type DeleteUDBBackupResponse struct {
	response.CommonBase
}

DeleteUDBBackupResponse is response schema for DeleteUDBBackup action

type DeleteUDBInstanceRequest 

type DeleteUDBInstanceRequest struct {
	request.CommonBase

	// DB实例的id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// 专区ID
	UDBCId *string `required:"false"`
}

DeleteUDBInstanceRequest is request schema for DeleteUDBInstance action

type DeleteUDBInstanceResponse 

type DeleteUDBInstanceResponse struct {
	response.CommonBase
}

DeleteUDBInstanceResponse is response schema for DeleteUDBInstance action

type DeleteUDBLogPackageRequest 

type DeleteUDBLogPackageRequest struct {
	request.CommonBase

	// 日志包id，可通过DescribeUDBLogPackage获得
	BackupId *int `required:"true"`

	// 跨可用区高可用备库所在可用区
	BackupZone *string `required:"false"`
}

DeleteUDBLogPackageRequest is request schema for DeleteUDBLogPackage action

type DeleteUDBLogPackageResponse 

type DeleteUDBLogPackageResponse struct {
	response.CommonBase
}

DeleteUDBLogPackageResponse is response schema for DeleteUDBLogPackage action

type DeleteUDBParamGroupRequest 

type DeleteUDBParamGroupRequest struct {
	request.CommonBase

	// 参数组id,可通过DescribeUDBParamGroup获取
	GroupId *int `required:"true"`

	// 是否属于地域级别
	RegionFlag *bool `required:"false"`
}

DeleteUDBParamGroupRequest is request schema for DeleteUDBParamGroup action

type DeleteUDBParamGroupResponse 

type DeleteUDBParamGroupResponse struct {
	response.CommonBase
}

DeleteUDBParamGroupResponse is response schema for DeleteUDBParamGroup action

type DescribeUDBBackupBlacklistRequest 

type DescribeUDBBackupBlacklistRequest struct {
	request.CommonBase

	// DB实例Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`
}

DescribeUDBBackupBlacklistRequest is request schema for DescribeUDBBackupBlacklist action

type DescribeUDBBackupBlacklistResponse 

type DescribeUDBBackupBlacklistResponse struct {
	response.CommonBase

	// DB的黑名单列表, db.%为指定库 dbname.tablename为指定表
	Blacklist string
}

DescribeUDBBackupBlacklistResponse is response schema for DescribeUDBBackupBlacklist action

type DescribeUDBBackupRequest 

type DescribeUDBBackupRequest struct {
	request.CommonBase

	// 【该字段已废弃，请谨慎使用】
	BackupId *int `required:"false" deprecated:"true"`

	// 备份类型,取值为0或1，0表示自动，1表示手动
	BackupType *int `required:"false"`

	// 过滤条件:起始时间(Unix时间戳)
	BeginTime *int `required:"false"`

	// 如果未指定GroupId，则可选是否选取特定DB类型的配置(sql, nosql, postgresql, sqlserver)
	ClassType *string `required:"false"`

	// DB实例Id，如果指定，则只获取该db的备份信息 该值可以通过DescribeUDBInstance获取
	DBId *string `required:"false"`

	// 过滤条件:结束时间(Unix时间戳)
	EndTime *int `required:"false"`

	// 分页显示的条目数，列表操作则指定
	Limit *int `required:"true"`

	// 分页显示的起始偏移，列表操作则指定
	Offset *int `required:"true"`
}

DescribeUDBBackupRequest is request schema for DescribeUDBBackup action

type DescribeUDBBackupResponse 

type DescribeUDBBackupResponse struct {
	response.CommonBase

	// 备份信息 参照UDBBackupSet
	DataSet []UDBBackupSet

	// 满足条件备份总数，如果指定dbid，则是该db备份总数
	TotalCount int
}

DescribeUDBBackupResponse is response schema for DescribeUDBBackup action

type DescribeUDBBinlogBackupURLRequest 

type DescribeUDBBinlogBackupURLRequest struct {
	request.CommonBase

	// DB实例日志备份ID，可以从DescribeUDBLogPackage结果当中获得
	BackupId *int `required:"true"`

	// DB实例Id
	DBId *string `required:"true"`
}

DescribeUDBBinlogBackupURLRequest is request schema for DescribeUDBBinlogBackupURL action

type DescribeUDBBinlogBackupURLResponse 

type DescribeUDBBinlogBackupURLResponse struct {
	response.CommonBase

	// DB实例备份文件的公网地址
	BackupPath string

	// DB实例备份文件的内网地址
	InnerBackupPath string
}

DescribeUDBBinlogBackupURLResponse is response schema for DescribeUDBBinlogBackupURL action

type DescribeUDBInstanceBackupStateRequest 

type DescribeUDBInstanceBackupStateRequest struct {
	request.CommonBase

	// 备份记录ID
	BackupId *int `required:"true"`

	// 跨可用区高可用备库所在可用区，参见［可用区列表］
	BackupZone *string `required:"false"`
}

DescribeUDBInstanceBackupStateRequest is request schema for DescribeUDBInstanceBackupState action

type DescribeUDBInstanceBackupStateResponse 

type DescribeUDBInstanceBackupStateResponse struct {
	response.CommonBase

	//
	BackupEndTime int

	//
	BackupSize int

	// 备份状态 0 Backuping // 备份中 1 Success // 备份成功 2 Failed // 备份失败 3 Expired // 备份过期
	State string
}

DescribeUDBInstanceBackupStateResponse is response schema for DescribeUDBInstanceBackupState action

type DescribeUDBInstanceBackupURLRequest 

type DescribeUDBInstanceBackupURLRequest struct {
	request.CommonBase

	// DB实例备份ID,该值可以通过DescribeUDBBackup获取
	BackupId *int `required:"true"`

	// DB实例Id,该值可通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// DB响应中URL的过期时间,该值最小默认4小时,最大7天。不填默认为四小时。(单位/秒)
	ValidTime *int `required:"false"`
}

DescribeUDBInstanceBackupURLRequest is request schema for DescribeUDBInstanceBackupURL action

type DescribeUDBInstanceBackupURLResponse 

type DescribeUDBInstanceBackupURLResponse struct {
	response.CommonBase

	// DB实例备份文件公网的地址
	BackupPath string

	// DB实例备份文件内网的地址
	InnerBackupPath string

	// 备份文件的md5值
	MD5 string
}

DescribeUDBInstanceBackupURLResponse is response schema for DescribeUDBInstanceBackupURL action

type DescribeUDBInstanceBinlogBackupStateRequest 

type DescribeUDBInstanceBinlogBackupStateRequest struct {
	request.CommonBase

	// 备份记录ID
	BackupId *int `required:"true"`

	// 跨可用区高可用备库所在可用区
	BackupZone *string `required:"false"`
}

DescribeUDBInstanceBinlogBackupStateRequest is request schema for DescribeUDBInstanceBinlogBackupState action

type DescribeUDBInstanceBinlogBackupStateResponse 

type DescribeUDBInstanceBinlogBackupStateResponse struct {
	response.CommonBase

	// 备份状态 0 Backuping // 备份中 1 Success // 备份成功 2 Failed // 备份失败 3 Expired // 备份过期
	State string
}

DescribeUDBInstanceBinlogBackupStateResponse is response schema for DescribeUDBInstanceBinlogBackupState action

type DescribeUDBInstanceBinlogRequest 

type DescribeUDBInstanceBinlogRequest struct {
	request.CommonBase

	// 过滤条件:起始时间(时间戳)
	BeginTime *int `required:"true"`

	// DB实例Id
	DBId *string `required:"true"`

	// 过滤条件:结束时间(时间戳)
	EndTime *int `required:"true"`
}

DescribeUDBInstanceBinlogRequest is request schema for DescribeUDBInstanceBinlog action

type DescribeUDBInstanceBinlogResponse 

type DescribeUDBInstanceBinlogResponse struct {
	response.CommonBase

	// 获取的Binlog信息列表 UDBInstanceBinlogSet
	DataSet []UDBInstanceBinlogSet
}

DescribeUDBInstanceBinlogResponse is response schema for DescribeUDBInstanceBinlog action

type DescribeUDBInstanceLogRequest added in v0.21.3 

type DescribeUDBInstanceLogRequest struct {
	request.CommonBase

	// 查询的日志开始的时间戳（Unix Timestamp）。对于实时查询，这个参数应该是上次轮询请求时的时间戳，后台会返回从该值到当前时间的日志内容。
	BeginTime *int `required:"true"`

	// 实例ID
	DBId *string `required:"true"`

	// 查询日志的结束时间戳(Unix Timestamp），对于实时查询不传该值，与BeginTime的差值不超过24小时：(EndTime-BeginTime) < 24*60*60
	EndTime *int `required:"true"`

	// 查询日志的类型error：错误日志；slow：慢日志
	LogType *string `required:"true"`
}

DescribeUDBInstanceLogRequest is request schema for DescribeUDBInstanceLog action

type DescribeUDBInstanceLogResponse added in v0.21.3 

type DescribeUDBInstanceLogResponse struct {
	response.CommonBase

	// 查询到的日志内容，一段纯文本
	Log string

	// 此次查询到的日志的下一个时间，用于下一次轮询时的BeginTime参数；如果日志查询结束则返回为空，前端结束查询
	NextTime string
}

DescribeUDBInstanceLogResponse is response schema for DescribeUDBInstanceLog action

type DescribeUDBInstancePriceRequest 

type DescribeUDBInstancePriceRequest struct {
	request.CommonBase

	// CPU个数，如果db类型为sqlserver，则为必填参数
	CPU *int `required:"false"`

	// Year，按年付费； Month，按月付费 Dynamic，按需付费（需开启权限) Trial，试用（需开启权限）默认为月付
	ChargeType *string `required:"false"`

	// 购买DB实例数量,最大数量为10台, 默认为1台
	Count *int `required:"false"`

	// UDB实例的DB版本字符串
	DBTypeId *string `required:"true"`

	// 磁盘空间(GB),暂时支持20(GB) - 3000(GB), 输入不带单位
	DiskSpace *int `required:"true"`

	// 实例的部署类型。可选值为：Normal: 普通单点实例，Slave: 从库实例，HA: 高可用部署实例，默认是Normal
	InstanceMode *string `required:"false"`

	// UDB数据库机型: "SATA_SSD": "SSD机型" , "PCIE_SSD": "SSD高性能机型" , "Normal_Volume": "标准大容量机型", "SATA_SSD_Volume": "SSD大容量机型" , "PCIE_SSD_Volume": "SSD高性能大容量机型", "NVMe_SSD": "快杰机型"
	InstanceType *string `required:"false"`

	// 规格类型ID,当SpecificationType为1时有效
	MachineType *string `required:"false"`

	// 内存限制(MB)，单位为MB.目前支持：2000-96000
	MemoryLimit *int `required:"true"`

	// DB购买多少个"计费时间单位"，默认值为1。比如：买2个月，Quantity就是2。如果计费单位是“按月”，并且Quantity为0，表示“购买到月底”
	Quantity *int `required:"false"`

	// SSD类型，可选值为"SATA"、“NVMe”. 默认为“SATA”
	SSDType *string `required:"false"`

	// 实例计算规格类型，0或不传代表使用内存方式购买，1代表使用内存-cpu可选配比方式购买，需要填写MachineType
	SpecificationType *int `required:"false"`

	// 【该字段已废弃，请谨慎使用】
	UseSSD *bool `required:"false" deprecated:"true"`
}

DescribeUDBInstancePriceRequest is request schema for DescribeUDBInstancePrice action

type DescribeUDBInstancePriceResponse 

type DescribeUDBInstancePriceResponse struct {
	response.CommonBase

	// 价格 参照UDBInstancePriceSet
	DataSet []UDBInstancePriceSet
}

DescribeUDBInstancePriceResponse is response schema for DescribeUDBInstancePrice action

type DescribeUDBInstanceRequest 

type DescribeUDBInstanceRequest struct {
	request.CommonBase

	// DB种类，如果是列表操作，则需要指定,不区分大小写，其取值如下：mysql: SQL；mongo: NOSQL；postgresql: postgresql
	ClassType *string `required:"false"`

	// DB实例id，如果指定则获取单个db实例的描述，否则为列表操作。 指定DBId时无需填写ClassType、Offset、Limit
	DBId *string `required:"false"`

	// 当只获取这个特定DBId的信息时，如果有该选项，那么把这个DBId实例的所有从库信息一起拉取并返回
	IncludeSlaves *bool `required:"false"`

	// 是否查看专区里面DB
	IsInUDBC *bool `required:"false"`

	// 分页显示数量，列表操作时必填
	Limit *int `required:"false"`

	// 分页显示起始偏移位置，列表操作时必填
	Offset *int `required:"false"`

	// 根据 业务组 筛选DB
	Tag *string `required:"false"`

	// IsInUDBC为True,UDBCId为空，说明查看整个可用区的专区的db，如果UDBId不为空则只查看此专区下面的db
	UDBCId *string `required:"false"`

	// 根据VPCId筛选DB
	VPCId *string `required:"false"`
}

DescribeUDBInstanceRequest is request schema for DescribeUDBInstance action

type DescribeUDBInstanceResponse 

type DescribeUDBInstanceResponse struct {
	response.CommonBase

	// DB实例信息列表 UDBInstanceSet
	DataSet []UDBInstanceSet

	// 用户db组的数量，对于 mysql: 主从结对数量，没有slave，则只有master mongodb: 副本集数量
	TotalCount int
}

DescribeUDBInstanceResponse is response schema for DescribeUDBInstance action

type DescribeUDBInstanceStateRequest 

type DescribeUDBInstanceStateRequest struct {
	request.CommonBase

	// 实例的Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`
}

DescribeUDBInstanceStateRequest is request schema for DescribeUDBInstanceState action

type DescribeUDBInstanceStateResponse 

type DescribeUDBInstanceStateResponse struct {
	response.CommonBase

	// DB状态标记 Init：初始化中；Fail：安装失败； Starting：启动中； Running ： 运行 ；Shutdown：关闭中； Shutoff ：已关闭； Delete：已删除； Upgrading：升级中； Promoting： 提升为独库进行中； Recovering： 恢复中； Recover fail：恢复失败。
	State string
}

DescribeUDBInstanceStateResponse is response schema for DescribeUDBInstanceState action

type DescribeUDBInstanceUpgradePriceRequest 

type DescribeUDBInstanceUpgradePriceRequest struct {
	request.CommonBase

	// CPU核数 快杰SQLServer升降级必传
	CPU *int `required:"false"`

	// 实例的Id
	DBId *string `required:"true"`

	// 磁盘空间(GB), 暂时支持20G - 500G
	DiskSpace *int `required:"true"`

	// "SATA_SSD", "NVMe_SSD"
	InstanceType *string `required:"false"`

	// 规格类型ID,当SpecificationType为1时有效
	MachineType *string `required:"false"`

	// 内存限制(MB)
	MemoryLimit *int `required:"true"`

	// 获取指定时间开始后面的升级价格， 不填的话 是默认当前时间
	OrderStartTime *int `required:"false"`

	// "SATA", "NVMe"
	SSDType *string `required:"false"`

	// 实例计算规格类型，0或不传代表使用内存方式购买，1代表使用内存-cpu可选配比方式购买，需要填写MachineType
	SpecificationType *int `required:"false"`

	// 【该字段已废弃，请谨慎使用】
	UseSSD *bool `required:"false" deprecated:"true"`
}

DescribeUDBInstanceUpgradePriceRequest is request schema for DescribeUDBInstanceUpgradePrice action

type DescribeUDBInstanceUpgradePriceResponse 

type DescribeUDBInstanceUpgradePriceResponse struct {
	response.CommonBase

	// 价格，单位为分
	Price int
}

DescribeUDBInstanceUpgradePriceResponse is response schema for DescribeUDBInstanceUpgradePrice action

type DescribeUDBLogBackupURLRequest 

type DescribeUDBLogBackupURLRequest struct {
	request.CommonBase

	// DB实例日志备份ID, 可以从DescribeUDBLogPackage结果当中获得。
	BackupId *int `required:"true"`

	// DB实例Id
	DBId *string `required:"true"`
}

DescribeUDBLogBackupURLRequest is request schema for DescribeUDBLogBackupURL action

type DescribeUDBLogBackupURLResponse 

type DescribeUDBLogBackupURLResponse struct {
	response.CommonBase

	// 备份外网URL
	BackupPath string

	// 备份用户网URL
	UsernetPath string
}

DescribeUDBLogBackupURLResponse is response schema for DescribeUDBLogBackupURL action

type DescribeUDBLogPackageRequest 

type DescribeUDBLogPackageRequest struct {
	request.CommonBase

	// 过滤条件:起始时间(时间戳)
	BeginTime *int `required:"false"`

	// DB实例Id，如果指定，则只获取该db的备份信息; 当Type为2时必填
	DBId *string `required:"false"`

	// 过滤条件:结束时间(时间戳)
	EndTime *int `required:"false"`

	// 分页显示的条目数，列表操作则指定
	Limit *int `required:"true"`

	// 分页显示的起始偏移，列表操作则指定
	Offset *int `required:"true"`

	// 需要列出的备份文件类型，每种类型的值如下： 2 代表 BINLOG_BACKUP； 3 代表 SLOW_QUERY_BACKUP； 4 代表 ERRORLOG_BACKUP；
	Type *int `required:"false"`

	// Types作为Type的补充，支持多值传入，可以获取多个类型的日志记录，如：Types.0=2&Types.1=3
	Types []int `required:"false"`
}

DescribeUDBLogPackageRequest is request schema for DescribeUDBLogPackage action

type DescribeUDBLogPackageResponse 

type DescribeUDBLogPackageResponse struct {
	response.CommonBase

	// 备份信息 参见LogPackageDataSet
	DataSet []LogPackageDataSet

	// 备份总数，如果指定dbid，则是该db备份总数
	TotalCount int
}

DescribeUDBLogPackageResponse is response schema for DescribeUDBLogPackage action

type DescribeUDBParamGroupRequest 

type DescribeUDBParamGroupRequest struct {
	request.CommonBase

	// 如果未指定GroupId，则可选是否选取特定DB类型的配置(sql, nosql, postgresql, sqlserver)
	ClassType *string `required:"false"`

	// 参数组id，如果指定则获取描述，否则是列表操作，需要 指定Offset/Limit
	GroupId *int `required:"false"`

	// 是否选取专区中配置
	IsInUDBC *bool `required:"false"`

	// 分页显示的条目数，列表操作则指定
	Limit *int `required:"true"`

	// 分页显示的起始偏移，列表操作则指定
	Offset *int `required:"true"`

	// 当请求没有填写Zone时，如果指定为true，表示只拉取跨可用区的相关配置文件，否则，拉取所有机房的配置文件（包括每个单可用区和跨可用区）
	RegionFlag *bool `required:"false"`
}

DescribeUDBParamGroupRequest is request schema for DescribeUDBParamGroup action

type DescribeUDBParamGroupResponse 

type DescribeUDBParamGroupResponse struct {
	response.CommonBase

	// 参数组列表 参照UDBParamGroupSet
	DataSet []UDBParamGroupSet

	// 参数组总数，列表操作时才会有该参数
	TotalCount int
}

DescribeUDBParamGroupResponse is response schema for DescribeUDBParamGroup action

type DescribeUDBSplittingInfoRequest added in v0.21.3 

type DescribeUDBSplittingInfoRequest struct {
	request.CommonBase

	// DB实例ID
	MasterDBId *string `required:"true"`
}

DescribeUDBSplittingInfoRequest is request schema for DescribeUDBSplittingInfo action

type DescribeUDBSplittingInfoResponse added in v0.21.3 

type DescribeUDBSplittingInfoResponse struct {
	response.CommonBase

	// 数据库版本
	DBTypeId string

	// 读写分离从库信息
	DataSet []UDBRWSplittingSet

	// 时间阈值
	DelayThreshold int

	// DB实例ID
	MasterDBId string

	// 端口号
	Port int

	// 读写分离IP
	RWIP string

	// 读写分离状态
	RWState string

	// 读写分离策略
	ReadModel string

	// 可用区
	Zone string
}

DescribeUDBSplittingInfoResponse is response schema for DescribeUDBSplittingInfo action

type DescribeUDBTypeRequest 

type DescribeUDBTypeRequest struct {
	request.CommonBase

	// 跨可用区高可用DB的备库所在区域，仅当该可用区支持跨可用区高可用时填入。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
	BackupZone *string `required:"false"`

	// 返回从备份创建实例时，该版本号所支持的备份创建版本。如果没传，则表示不是从备份创建。
	CompatibleWithDBType *string `required:"false"`

	// DB实例类型，如mysql，sqlserver，mongo，postgresql
	DBClusterType *string `required:"false"`

	// 返回从备份创建实例时，该小版本号所支持的备份创建小版本。如果没传，则表示不是从备份创建。
	DBSubVersion *string `required:"false"`

	// 返回支持某种磁盘类型的DB类型，如Normal、SSD、NVMe_SSD。如果没传，则表示任何磁盘类型均可。
	DiskType *string `required:"false"`

	// 返回支持某种实例类型的DB类型。如果没传，则表示任何实例类型均可。normal:单点,ha:高可用,sharded_cluster:分片集群
	InstanceMode *string `required:"false"`
}

DescribeUDBTypeRequest is request schema for DescribeUDBType action

type DescribeUDBTypeResponse 

type DescribeUDBTypeResponse struct {
	response.CommonBase

	// DB类型列表 参数见 UDBTypeSet
	DataSet []UDBTypeSet
}

DescribeUDBTypeResponse is response schema for DescribeUDBType action

type DisableUDBRWSplittingRequest added in v0.21.3 

type DisableUDBRWSplittingRequest struct {
	request.CommonBase

	// DB实例ID（master)
	MasterDBId *string `required:"true"`
}

DisableUDBRWSplittingRequest is request schema for DisableUDBRWSplitting action

type DisableUDBRWSplittingResponse added in v0.21.3 

type DisableUDBRWSplittingResponse struct {
	response.CommonBase
}

DisableUDBRWSplittingResponse is response schema for DisableUDBRWSplitting action

type EditUDBBackupBlacklistRequest 

type EditUDBBackupBlacklistRequest struct {
	request.CommonBase

	// 黑名单，规范示例,指定库mysql.%;test.%; 指定表city.address;
	Blacklist *string `required:"true"`

	// DB实例Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`
}

EditUDBBackupBlacklistRequest is request schema for EditUDBBackupBlacklist action

type EditUDBBackupBlacklistResponse 

type EditUDBBackupBlacklistResponse struct {
	response.CommonBase
}

EditUDBBackupBlacklistResponse is response schema for EditUDBBackupBlacklist action

type EnableUDBRWSplittingRequest added in v0.21.3 

type EnableUDBRWSplittingRequest struct {
	request.CommonBase

	// 备份的可用区。用于创建跨可用区读写分离的一个节点，跨机房的读写分离必须有这个参数
	BackupZone *string `required:"false"`

	// DB实例ID（主库）
	MasterDBId *string `required:"true"`
}

EnableUDBRWSplittingRequest is request schema for EnableUDBRWSplitting action

type EnableUDBRWSplittingResponse added in v0.21.3 

type EnableUDBRWSplittingResponse struct {
	response.CommonBase

	// DB实例ID（主库）
	MasterDBId string

	// 读写分离访问IP
	RWIp string
}

EnableUDBRWSplittingResponse is response schema for EnableUDBRWSplitting action

type ExtractUDBParamGroupRequest added in v0.21.3 

type ExtractUDBParamGroupRequest struct {
	request.CommonBase

	// 配置id
	GroupId *int `required:"true"`

	// 是否跨可用区，RegionFlag为true时表示跨可用区配置文件。如果RegionFlag=true，Zone可以不传，否则Zone必须传。
	RegionFlag *bool `required:"false"`
}

ExtractUDBParamGroupRequest is request schema for ExtractUDBParamGroup action

type ExtractUDBParamGroupResponse added in v0.21.3 

type ExtractUDBParamGroupResponse struct {
	response.CommonBase

	// 配置文件内容
	Content string
}

ExtractUDBParamGroupResponse is response schema for ExtractUDBParamGroup action

type FetchUDBInstanceEarliestRecoverTimeRequest 

type FetchUDBInstanceEarliestRecoverTimeRequest struct {
	request.CommonBase

	// DB实例Id
	DBId *string `required:"true"`
}

FetchUDBInstanceEarliestRecoverTimeRequest is request schema for FetchUDBInstanceEarliestRecoverTime action

type FetchUDBInstanceEarliestRecoverTimeResponse 

type FetchUDBInstanceEarliestRecoverTimeResponse struct {
	response.CommonBase

	// 获取最早可回档时间点
	EarliestTime int
}

FetchUDBInstanceEarliestRecoverTimeResponse is response schema for FetchUDBInstanceEarliestRecoverTime action

type GetUDBClientConnNumRequest added in v0.21.29 

type GetUDBClientConnNumRequest struct {
	request.CommonBase

	// DB实例id
	DBId *string `required:"true"`
}

GetUDBClientConnNumRequest is request schema for GetUDBClientConnNum action

type GetUDBClientConnNumResponse added in v0.21.29 

type GetUDBClientConnNumResponse struct {
	response.CommonBase

	// db实例ip和连接数信息
	DataSet []ConnNumMap
}

GetUDBClientConnNumResponse is response schema for GetUDBClientConnNum action

type GetUDBInstanceSSLCertURLRequest added in v0.22.14 

type GetUDBInstanceSSLCertURLRequest struct {
	request.CommonBase

	// 实例ID
	DBId *string `required:"true"`

	// URL的过期时间，该值最小默认1小时，最大7天。（单位/秒）
	ExpireTime *int `required:"false"`
}

GetUDBInstanceSSLCertURLRequest is request schema for GetUDBInstanceSSLCertURL action

type GetUDBInstanceSSLCertURLResponse added in v0.22.14 

type GetUDBInstanceSSLCertURLResponse struct {
	response.CommonBase

	// 内网链接
	InnerUrl string

	// 外网链接
	InternetUrl string
}

GetUDBInstanceSSLCertURLResponse is response schema for GetUDBInstanceSSLCertURL action

type ListUDBMachineTypeRequest added in v0.22.18 

type ListUDBMachineTypeRequest struct {
	request.CommonBase

	// UDB实例模式类型, 可选值如下: "Normal": 普通版UDB实例 "HA": 高可用版UDB实例 默认是"Normal"
	InstanceMode *string `required:"false"`
}

ListUDBMachineTypeRequest is request schema for ListUDBMachineType action

type ListUDBMachineTypeResponse added in v0.22.18 

type ListUDBMachineTypeResponse struct {
	response.CommonBase

	// 计算规格列表
	DataSet []MachineType

	// 默认计算规格
	DefaultMachineType MachineType

	// 接口返回信息
	Message string
}

ListUDBMachineTypeResponse is response schema for ListUDBMachineType action

type ListUDBUserTablesRequest added in v0.22.15 

type ListUDBUserTablesRequest struct {
	request.CommonBase

	// udb实例的ID
	DBId *string `required:"true"`
}

ListUDBUserTablesRequest is request schema for ListUDBUserTables action

type ListUDBUserTablesResponse added in v0.22.15 

type ListUDBUserTablesResponse struct {
	response.CommonBase

	// 用户库表的集合
	Tables []UDBDatabaseData
}

ListUDBUserTablesResponse is response schema for ListUDBUserTables action

type LogPackageDataSet 

type LogPackageDataSet struct {

	// 备份id
	BackupId int

	// 备份名称
	BackupName string

	// 备份文件大小
	BackupSize int

	// 备份时间
	BackupTime int

	// 备份类型，包括2-binlog备份，3-slowlog备份
	BackupType int

	// 跨可用区高可用备库所在可用区
	BackupZone string

	// binlog备份类型 Manual //手动备份 Auto //自动备份
	BinlogType string

	// dbid
	DBId string

	// 对应的db名称
	DBName string

	// 备份状态 Backuping // 备份中 Success // 备份成功 Failed // 备份失败 Expired // 备份过期
	State string

	// 所在可用区
	Zone string
}

LogPackageDataSet - DescribeUDBLogPackage

type MachineType added in v0.22.18 

type MachineType struct {

	// 规格cpu核数
	Cpu int

	// 计算规格描述，格式为"nCmG"，表示n核mG内存实例
	Description string

	// 内存/cpu配比
	Group string

	// 计算规格id, 目前支持CPU和内存比1:2、1:4、1:8三类配比规格;规格的格式为："机型.配比.CPU核数规格"；机型支持o和n两种机型，分别代表快杰NVMe和SSD云盘机型；配比映射关系如下:2m代表CPU内存配比1比2，4m代表CPU内存配比1比4，8m代表CPU内存配比1比8，CPU核数规格射关系如下：small代表1C，medium代表2C，xlarge代表4C，2xlarge代表8C，4xlarge代表16C，8xlarge代表32C，16xlarge代表64C，例如 "o.mysql4m.medium"表示创建快杰NVMe机型2C8G的实例，"o.mysql8m.4xlarge"表示创建快杰NVMe机型16C128G的实例
	ID string

	// 规格内存大小，单位（GB）
	Memory int

	// 内部云主机机型，可选"o/n"
	Os string
}

MachineType - mysql数据库机型

type ModifyUDBInstanceNameRequest 

type ModifyUDBInstanceNameRequest struct {
	request.CommonBase

	// 实例的Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// 实例的新名字, 长度要求为6~63位
	Name *string `required:"true"`
}

ModifyUDBInstanceNameRequest is request schema for ModifyUDBInstanceName action

type ModifyUDBInstanceNameResponse 

type ModifyUDBInstanceNameResponse struct {
	response.CommonBase
}

ModifyUDBInstanceNameResponse is response schema for ModifyUDBInstanceName action

type ModifyUDBInstancePasswordRequest 

type ModifyUDBInstancePasswordRequest struct {
	request.CommonBase

	// sqlserver帐号，仅在sqlserver的情况下填该参数
	AccountName *string `required:"false"`

	// 实例的ID,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// 实例的新密码
	Password *string `required:"true"`
}

ModifyUDBInstancePasswordRequest is request schema for ModifyUDBInstancePassword action

type ModifyUDBInstancePasswordResponse 

type ModifyUDBInstancePasswordResponse struct {
	response.CommonBase
}

ModifyUDBInstancePasswordResponse is response schema for ModifyUDBInstancePassword action

type ModifyUDBInstanceRemarkNameRequest added in v0.22.5 

type ModifyUDBInstanceRemarkNameRequest struct {
	request.CommonBase

	// 实例的Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// 实例的新备注
	Name *string `required:"true"`
}

ModifyUDBInstanceRemarkNameRequest is request schema for ModifyUDBInstanceRemarkName action

type ModifyUDBInstanceRemarkNameResponse added in v0.22.5 

type ModifyUDBInstanceRemarkNameResponse struct {
	response.CommonBase
}

ModifyUDBInstanceRemarkNameResponse is response schema for ModifyUDBInstanceRemarkName action

type ModifyUDBInstanceSSLRequest added in v0.22.14 

type ModifyUDBInstanceSSLRequest struct {
	request.CommonBase

	// 实例ID
	DBId *string `required:"true"`

	// 是否开启SSL 1->关闭 2->开启
	EnableSSL *int `required:"true"`

	// SSL证书有效时间，1-5年，默认为1年
	ValidTime *int `required:"false"`
}

ModifyUDBInstanceSSLRequest is request schema for ModifyUDBInstanceSSL action

type ModifyUDBInstanceSSLResponse added in v0.22.14 

type ModifyUDBInstanceSSLResponse struct {
	response.CommonBase
}

ModifyUDBInstanceSSLResponse is response schema for ModifyUDBInstanceSSL action

type PromoteUDBInstanceToHARequest 

type PromoteUDBInstanceToHARequest struct {
	request.CommonBase

	// 实例的Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// 【该字段已废弃，请谨慎使用】
	IsLock *bool `required:"false" deprecated:"true"`
}

PromoteUDBInstanceToHARequest is request schema for PromoteUDBInstanceToHA action

type PromoteUDBInstanceToHAResponse 

type PromoteUDBInstanceToHAResponse struct {
	response.CommonBase
}

PromoteUDBInstanceToHAResponse is response schema for PromoteUDBInstanceToHA action

type PromoteUDBSlaveRequest 

type PromoteUDBSlaveRequest struct {
	request.CommonBase

	// 实例的Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// 是否强制(如果从库落后可能会禁止提升)，默认false 如果落后情况下，强制提升丢失数据
	IsForce *bool `required:"false"`
}

PromoteUDBSlaveRequest is request schema for PromoteUDBSlave action

type PromoteUDBSlaveResponse 

type PromoteUDBSlaveResponse struct {
	response.CommonBase
}

PromoteUDBSlaveResponse is response schema for PromoteUDBSlave action

type ResizeUDBInstanceRequest 

type ResizeUDBInstanceRequest struct {
	request.CommonBase

	// 使用的代金券id
	CouponId *string `required:"false"`

	// 实例的Id
	DBId *string `required:"true"`

	// 磁盘空间(GB), 暂时支持20G-32T
	DiskSpace *int `required:"true"`

	// UDB实例模式类型, 可选值如下: "Normal": 普通版UDB实例 "HA": 高可用版UDB实例 默认是"Normal"
	InstanceMode *string `required:"false"`

	// UDB数据库机型: "Normal": "标准机型" ,  "SATA_SSD": "SSD机型" , "PCIE_SSD": "SSD高性能机型" ,  "Normal_Volume": "标准大容量机型",  "SATA_SSD_Volume": "SSD大容量机型" ,  "PCIE_SSD_Volume": "SSD高性能大容量机型"，“NVMe_SSD”：“快杰机型”
	InstanceType *string `required:"false"`

	// 规格类型ID,当SpecificationType为1时有效
	MachineType *string `required:"false"`

	// 内存限制(MB)，目前支持以下几档 2000M/4000M/ 6000M/8000M/ 12000M/16000M/ 24000M/32000M/ 48000M/64000M/96000M/128000M/192000M/256000M/320000M。
	MemoryLimit *int `required:"true"`

	// SSD类型，可选值为"SATA"、“NVMe”
	SSDType *string `required:"false"`

	// 实例计算规格类型，0或不传代表使用内存方式购买，1代表使用内存-cpu可选配比方式购买，需要填写MachineType
	SpecificationType *string `required:"false"`

	// DB关闭状态下升降级，升降级后是否启动DB，默认为false
	StartAfterUpgrade *bool `required:"false"`

	// 【该字段已废弃，请谨慎使用】
	UDBCId *string `required:"false" deprecated:"true"`

	// 【该字段已废弃，请谨慎使用】
	UseSSD *bool `required:"false" deprecated:"true"`
}

ResizeUDBInstanceRequest is request schema for ResizeUDBInstance action

type ResizeUDBInstanceResponse 

type ResizeUDBInstanceResponse struct {
	response.CommonBase
}

ResizeUDBInstanceResponse is response schema for ResizeUDBInstance action

type RestartRWSplittingRequest added in v0.21.3 

type RestartRWSplittingRequest struct {
	request.CommonBase

	// 待关闭读写分离中间键ProxyId
	MasterDBId *string `required:"true"`
}

RestartRWSplittingRequest is request schema for RestartRWSplitting action

type RestartRWSplittingResponse added in v0.21.3 

type RestartRWSplittingResponse struct {
	response.CommonBase
}

RestartRWSplittingResponse is response schema for RestartRWSplitting action

type RestartUDBInstanceRequest 

type RestartUDBInstanceRequest struct {
	request.CommonBase

	// 实例的Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`
}

RestartUDBInstanceRequest is request schema for RestartUDBInstance action

type RestartUDBInstanceResponse 

type RestartUDBInstanceResponse struct {
	response.CommonBase
}

RestartUDBInstanceResponse is response schema for RestartUDBInstance action

type RollbackUDBInstanceRequest added in v0.22.6 

type RollbackUDBInstanceRequest struct {
	request.CommonBase

	// 恢复到某个时间点的时间戳(UTC时间格式，默认单位秒)
	RecoveryTime *string `required:"true"`

	// 源实例的Id
	SrcDBId *string `required:"true"`

	// 指定需要恢复的表，格式为(库名.表名)， 指定多个用逗号隔开，eg: [ udb.test, mysql_school.my_student]
	Tables *string `required:"true"`
}

RollbackUDBInstanceRequest is request schema for RollbackUDBInstance action

type RollbackUDBInstanceResponse added in v0.22.6 

type RollbackUDBInstanceResponse struct {
	response.CommonBase

	// 源实例的Id
	DBId string
}

RollbackUDBInstanceResponse is response schema for RollbackUDBInstance action

type SetUDBRWSplittingRequest added in v0.21.3 

type SetUDBRWSplittingRequest struct {
	request.CommonBase

	// DBIds.0 代表UDB主节点， DBIds.1 到DBIds.n 代表1到N个从节点
	DBIds []string `required:"true"`

	// 时间阙值
	DelayThreshold *int `required:"false"`

	// DB实例ID（master)
	MasterDBId *string `required:"true"`

	// 读写分离策略
	ReadModel *string `required:"true"`

	// udb主从节点的只读比例。ReadPercents.0代表主节点的只读比例，ReadPercents.1代表从节点1的读写比例， 以此类推
	ReadPercents []string `required:"false"`
}

SetUDBRWSplittingRequest is request schema for SetUDBRWSplitting action

type SetUDBRWSplittingResponse added in v0.21.3 

type SetUDBRWSplittingResponse struct {
	response.CommonBase
}

SetUDBRWSplittingResponse is response schema for SetUDBRWSplitting action

type StartUDBInstanceRequest 

type StartUDBInstanceRequest struct {
	request.CommonBase

	// 实例的Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`
}

StartUDBInstanceRequest is request schema for StartUDBInstance action

type StartUDBInstanceResponse 

type StartUDBInstanceResponse struct {
	response.CommonBase
}

StartUDBInstanceResponse is response schema for StartUDBInstance action

type StopUDBInstanceRequest 

type StopUDBInstanceRequest struct {
	request.CommonBase

	// 实例的Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// 是否使用强制手段关闭DB，默认是false
	ForceToKill *bool `required:"false"`
}

StopUDBInstanceRequest is request schema for StopUDBInstance action

type StopUDBInstanceResponse 

type StopUDBInstanceResponse struct {
	response.CommonBase
}

StopUDBInstanceResponse is response schema for StopUDBInstance action

type SwitchUDBHAToSentinelRequest added in v0.21.3 

type SwitchUDBHAToSentinelRequest struct {
	request.CommonBase

	// UDB的实例ID
	DBId *string `required:"true"`

	// 是否跳过预检查强制升级。
	ForceSwitch *bool `required:"false"`
}

SwitchUDBHAToSentinelRequest is request schema for SwitchUDBHAToSentinel action

type SwitchUDBHAToSentinelResponse added in v0.21.3 

type SwitchUDBHAToSentinelResponse struct {
	response.CommonBase
}

SwitchUDBHAToSentinelResponse is response schema for SwitchUDBHAToSentinel action

type SwitchUDBInstanceToHARequest 

type SwitchUDBInstanceToHARequest struct {
	request.CommonBase

	// Year， Month， Dynamic，Trial，不填则按现在单点计费执行
	ChargeType *string `required:"false"`

	// 实例的Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`

	// 购买时长，需要和 ChargeType 搭配使用，否则使用单点计费策略的值
	Quantity *string `required:"false"`

	// 业务组
	Tag *string `required:"false"`
}

SwitchUDBInstanceToHARequest is request schema for SwitchUDBInstanceToHA action

type SwitchUDBInstanceToHAResponse 

type SwitchUDBInstanceToHAResponse struct {
	response.CommonBase

	// 切换后高可用db实例的Id
	DBId string
}

SwitchUDBInstanceToHAResponse is response schema for SwitchUDBInstanceToHA action

type TableData added in v0.22.15 

type TableData struct {

	// 表所属的库名称
	DBName string

	// 表的引擎（innodb, myisam）
	Engine string

	// 表名称
	TableName string
}

TableData - 用户表详情

type UDBBackupSet 

type UDBBackupSet struct {

	// 备份完成时间(Unix时间戳)
	BackupEndTime int

	// 备份id
	BackupId int

	// 备份名称
	BackupName string

	// 备份文件大小(字节)
	BackupSize int

	// 备份时间(Unix时间戳)
	BackupTime int

	// 备份类型,取值为0或1,0表示自动，1表示手动
	BackupType int

	// 跨机房高可用备库所在可用区
	BackupZone string

	// dbid
	DBId string

	// 对应的db名称
	DBName string

	// 备份错误信息
	ErrorInfo string

	// 备份文件的MD5值，备份完成后显示，备份中或备份失败时为空,目前只支持Mysql NVMe机型与Mongo
	MD5 string

	// 备份状态 Backuping // 备份中 Success // 备份成功 Failed // 备份失败 Expired // 备份过期
	State string

	// 备份所在可用区
	Zone string
}

UDBBackupSet - DescribeUDBBackup

type UDBClient 

type UDBClient struct {
	*ucloud.Client
}

UDBClient is the client of UDB

func NewClient 

func NewClient(config *ucloud.Config, credential *auth.Credential) *UDBClient

NewClient will return a instance of UDBClient

func (*UDBClient) BackupUDBInstance 

func (c *UDBClient) BackupUDBInstance(req *BackupUDBInstanceRequest) (*BackupUDBInstanceResponse, error)

API: BackupUDBInstance

备份UDB实例

func (*UDBClient) BackupUDBInstanceBinlog 

func (c *UDBClient) BackupUDBInstanceBinlog(req *BackupUDBInstanceBinlogRequest) (*BackupUDBInstanceBinlogResponse, error)

API: BackupUDBInstanceBinlog

备份UDB指定时间段的binlog列表

func (*UDBClient) BackupUDBInstanceErrorLog 

func (c *UDBClient) BackupUDBInstanceErrorLog(req *BackupUDBInstanceErrorLogRequest) (*BackupUDBInstanceErrorLogResponse, error)

API: BackupUDBInstanceErrorLog

备份UDB指定时间段的errorlog

func (*UDBClient) BackupUDBInstanceSlowLog 

func (c *UDBClient) BackupUDBInstanceSlowLog(req *BackupUDBInstanceSlowLogRequest) (*BackupUDBInstanceSlowLogResponse, error)

API: BackupUDBInstanceSlowLog

备份UDB指定时间段的slowlog分析结果

func (*UDBClient) ChangeUDBParamGroup added in v0.21.3 

func (c *UDBClient) ChangeUDBParamGroup(req *ChangeUDBParamGroupRequest) (*ChangeUDBParamGroupResponse, error)

API: ChangeUDBParamGroup

修改配置文件

func (*UDBClient) CheckRecoverUDBInstance 

func (c *UDBClient) CheckRecoverUDBInstance(req *CheckRecoverUDBInstanceRequest) (*CheckRecoverUDBInstanceResponse, error)

API: CheckRecoverUDBInstance

核查db是否可以使用回档功能

func (*UDBClient) CheckUDBInstanceToHAAllowance 

func (c *UDBClient) CheckUDBInstanceToHAAllowance(req *CheckUDBInstanceToHAAllowanceRequest) (*CheckUDBInstanceToHAAllowanceResponse, error)

API: CheckUDBInstanceToHAAllowance

核查db是否可以升级为高可用

func (*UDBClient) ClearUDBLog 

func (c *UDBClient) ClearUDBLog(req *ClearUDBLogRequest) (*ClearUDBLogResponse, error)

API: ClearUDBLog

清除UDB实例的log

func (*UDBClient) CreateMongoDBReplicaSet added in v0.21.3 

func (c *UDBClient) CreateMongoDBReplicaSet(req *CreateMongoDBReplicaSetRequest) (*CreateMongoDBReplicaSetResponse, error)

API: CreateMongoDBReplicaSet

一键创建DB副本集

func (*UDBClient) CreateUDBInstance 

func (c *UDBClient) CreateUDBInstance(req *CreateUDBInstanceRequest) (*CreateUDBInstanceResponse, error)

API: CreateUDBInstance

创建UDB实例（包括创建mysql master节点、mongodb primary/configsvr节点和从备份恢复实例）

func (*UDBClient) CreateUDBInstanceByRecovery 

func (c *UDBClient) CreateUDBInstanceByRecovery(req *CreateUDBInstanceByRecoveryRequest) (*CreateUDBInstanceByRecoveryResponse, error)

API: CreateUDBInstanceByRecovery

创建db，将新创建的db恢复到指定db某个指定时间点

func (*UDBClient) CreateUDBParamGroup 

func (c *UDBClient) CreateUDBParamGroup(req *CreateUDBParamGroupRequest) (*CreateUDBParamGroupResponse, error)

API: CreateUDBParamGroup

从已有配置文件创建新配置文件

func (*UDBClient) CreateUDBReplicationInstance 

func (c *UDBClient) CreateUDBReplicationInstance(req *CreateUDBReplicationInstanceRequest) (*CreateUDBReplicationInstanceResponse, error)

API: CreateUDBReplicationInstance

创建MongoDB的副本节点（包括仲裁）

func (*UDBClient) CreateUDBRouteInstance 

func (c *UDBClient) CreateUDBRouteInstance(req *CreateUDBRouteInstanceRequest) (*CreateUDBRouteInstanceResponse, error)

API: CreateUDBRouteInstance

创建mongos实例

func (*UDBClient) CreateUDBSlave 

func (c *UDBClient) CreateUDBSlave(req *CreateUDBSlaveRequest) (*CreateUDBSlaveResponse, error)

API: CreateUDBSlave

创建UDB实例的slave

func (*UDBClient) DeleteUDBBackup 

func (c *UDBClient) DeleteUDBBackup(req *DeleteUDBBackupRequest) (*DeleteUDBBackupResponse, error)

API: DeleteUDBBackup

func (*UDBClient) DeleteUDBInstance 

func (c *UDBClient) DeleteUDBInstance(req *DeleteUDBInstanceRequest) (*DeleteUDBInstanceResponse, error)

API: DeleteUDBInstance

删除UDB实例

func (*UDBClient) DeleteUDBLogPackage 

func (c *UDBClient) DeleteUDBLogPackage(req *DeleteUDBLogPackageRequest) (*DeleteUDBLogPackageResponse, error)

API: DeleteUDBLogPackage

删除UDB日志包

func (*UDBClient) DeleteUDBParamGroup 

func (c *UDBClient) DeleteUDBParamGroup(req *DeleteUDBParamGroupRequest) (*DeleteUDBParamGroupResponse, error)

API: DeleteUDBParamGroup

删除配置参数组

func (*UDBClient) DescribeUDBBackup 

func (c *UDBClient) DescribeUDBBackup(req *DescribeUDBBackupRequest) (*DescribeUDBBackupResponse, error)

API: DescribeUDBBackup

列表UDB实例备份信息.Zone不填表示多可用区，填代表单可用区

func (*UDBClient) DescribeUDBBackupBlacklist 

func (c *UDBClient) DescribeUDBBackupBlacklist(req *DescribeUDBBackupBlacklistRequest) (*DescribeUDBBackupBlacklistResponse, error)

API: DescribeUDBBackupBlacklist

获取UDB实例的备份黑名单

func (*UDBClient) DescribeUDBBinlogBackupURL 

func (c *UDBClient) DescribeUDBBinlogBackupURL(req *DescribeUDBBinlogBackupURLRequest) (*DescribeUDBBinlogBackupURLResponse, error)

API: DescribeUDBBinlogBackupURL

获取UDB的Binlog或者错误日志或者慢查询日志的备份地址

func (*UDBClient) DescribeUDBInstance 

func (c *UDBClient) DescribeUDBInstance(req *DescribeUDBInstanceRequest) (*DescribeUDBInstanceResponse, error)

API: DescribeUDBInstance

获取UDB实例信息，支持两类操作：（1）指定DBId用于获取该db的信息；（2）指定ClassType、Offset、Limit用于列表操作，查询某一个类型db。

func (*UDBClient) DescribeUDBInstanceBackupState 

func (c *UDBClient) DescribeUDBInstanceBackupState(req *DescribeUDBInstanceBackupStateRequest) (*DescribeUDBInstanceBackupStateResponse, error)

API: DescribeUDBInstanceBackupState

获取UDB实例备份状态

func (*UDBClient) DescribeUDBInstanceBackupURL 

func (c *UDBClient) DescribeUDBInstanceBackupURL(req *DescribeUDBInstanceBackupURLRequest) (*DescribeUDBInstanceBackupURLResponse, error)

API: DescribeUDBInstanceBackupURL

获取UDB备份下载地址

func (*UDBClient) DescribeUDBInstanceBinlog 

func (c *UDBClient) DescribeUDBInstanceBinlog(req *DescribeUDBInstanceBinlogRequest) (*DescribeUDBInstanceBinlogResponse, error)

API: DescribeUDBInstanceBinlog

获取UDB指定时间段的binlog列表

func (*UDBClient) DescribeUDBInstanceBinlogBackupState 

func (c *UDBClient) DescribeUDBInstanceBinlogBackupState(req *DescribeUDBInstanceBinlogBackupStateRequest) (*DescribeUDBInstanceBinlogBackupStateResponse, error)

API: DescribeUDBInstanceBinlogBackupState

获取udb实例备份状态

func (*UDBClient) DescribeUDBInstanceLog added in v0.21.3 

func (c *UDBClient) DescribeUDBInstanceLog(req *DescribeUDBInstanceLogRequest) (*DescribeUDBInstanceLogResponse, error)

API: DescribeUDBInstanceLog

查询某一段时间内UDB的错误日志或慢查询日志

func (*UDBClient) DescribeUDBInstancePrice 

func (c *UDBClient) DescribeUDBInstancePrice(req *DescribeUDBInstancePriceRequest) (*DescribeUDBInstancePriceResponse, error)

API: DescribeUDBInstancePrice

获取UDB实例价格信息

func (*UDBClient) DescribeUDBInstanceState 

func (c *UDBClient) DescribeUDBInstanceState(req *DescribeUDBInstanceStateRequest) (*DescribeUDBInstanceStateResponse, error)

API: DescribeUDBInstanceState

获取UDB实例状态

func (*UDBClient) DescribeUDBInstanceUpgradePrice 

func (c *UDBClient) DescribeUDBInstanceUpgradePrice(req *DescribeUDBInstanceUpgradePriceRequest) (*DescribeUDBInstanceUpgradePriceResponse, error)

API: DescribeUDBInstanceUpgradePrice

获取UDB实例升降级价格信息

func (*UDBClient) DescribeUDBLogBackupURL 

func (c *UDBClient) DescribeUDBLogBackupURL(req *DescribeUDBLogBackupURLRequest) (*DescribeUDBLogBackupURLResponse, error)

API: DescribeUDBLogBackupURL

获取UDB的错误日志或者慢查询日志备份地址

func (*UDBClient) DescribeUDBLogPackage 

func (c *UDBClient) DescribeUDBLogPackage(req *DescribeUDBLogPackageRequest) (*DescribeUDBLogPackageResponse, error)

API: DescribeUDBLogPackage

列表UDB实例binlog或slowlog或errorlog备份信息

func (*UDBClient) DescribeUDBParamGroup 

func (c *UDBClient) DescribeUDBParamGroup(req *DescribeUDBParamGroupRequest) (*DescribeUDBParamGroupResponse, error)

API: DescribeUDBParamGroup

获取参数组详细参数信息

func (*UDBClient) DescribeUDBSplittingInfo added in v0.21.3 

func (c *UDBClient) DescribeUDBSplittingInfo(req *DescribeUDBSplittingInfoRequest) (*DescribeUDBSplittingInfoResponse, error)

API: DescribeUDBSplittingInfo

描述读写分离功能的详细信息

func (*UDBClient) DescribeUDBType 

func (c *UDBClient) DescribeUDBType(req *DescribeUDBTypeRequest) (*DescribeUDBTypeResponse, error)

API: DescribeUDBType

获取UDB支持的类型信息

func (*UDBClient) DisableUDBRWSplitting added in v0.21.3 

func (c *UDBClient) DisableUDBRWSplitting(req *DisableUDBRWSplittingRequest) (*DisableUDBRWSplittingResponse, error)

API: DisableUDBRWSplitting

关闭DB的读写分离功能

func (*UDBClient) EditUDBBackupBlacklist 

func (c *UDBClient) EditUDBBackupBlacklist(req *EditUDBBackupBlacklistRequest) (*EditUDBBackupBlacklistResponse, error)

API: EditUDBBackupBlacklist

编辑UDB实例的备份黑名单

func (*UDBClient) EnableUDBRWSplitting added in v0.21.3 

func (c *UDBClient) EnableUDBRWSplitting(req *EnableUDBRWSplittingRequest) (*EnableUDBRWSplittingResponse, error)

API: EnableUDBRWSplitting

开启DB的读写分离功能

func (*UDBClient) ExtractUDBParamGroup added in v0.21.3 

func (c *UDBClient) ExtractUDBParamGroup(req *ExtractUDBParamGroupRequest) (*ExtractUDBParamGroupResponse, error)

API: ExtractUDBParamGroup

获取配置文件内容

func (*UDBClient) FetchUDBInstanceEarliestRecoverTime 

func (c *UDBClient) FetchUDBInstanceEarliestRecoverTime(req *FetchUDBInstanceEarliestRecoverTimeRequest) (*FetchUDBInstanceEarliestRecoverTimeResponse, error)

API: FetchUDBInstanceEarliestRecoverTime

获取UDB最早可回档的时间点

func (*UDBClient) GetUDBClientConnNum added in v0.21.29 

func (c *UDBClient) GetUDBClientConnNum(req *GetUDBClientConnNumRequest) (*GetUDBClientConnNumResponse, error)

API: GetUDBClientConnNum

输入一个DBID，能够获取客户端来源IP以及对应的连接数

func (*UDBClient) GetUDBInstanceSSLCertURL added in v0.22.14 

func (c *UDBClient) GetUDBInstanceSSLCertURL(req *GetUDBInstanceSSLCertURLRequest) (*GetUDBInstanceSSLCertURLResponse, error)

API: GetUDBInstanceSSLCertURL

获取SSL证书下载地址

func (*UDBClient) ListUDBMachineType added in v0.22.18 

func (c *UDBClient) ListUDBMachineType(req *ListUDBMachineTypeRequest) (*ListUDBMachineTypeResponse, error)

API: ListUDBMachineType

获取UDB云数据库支持的计算规格列表，暂不支持获取跨可用区实例的计算规格，目前支持的数据库品类包括：NVMe版和SSD云盘版MySQL

func (*UDBClient) ListUDBUserTables added in v0.22.15 

func (c *UDBClient) ListUDBUserTables(req *ListUDBUserTablesRequest) (*ListUDBUserTablesResponse, error)

API: ListUDBUserTables

查看udb实例所有的用户表集合 （只包括引擎为innodb和myisam的表）

func (*UDBClient) ModifyUDBInstanceName 

func (c *UDBClient) ModifyUDBInstanceName(req *ModifyUDBInstanceNameRequest) (*ModifyUDBInstanceNameResponse, error)

API: ModifyUDBInstanceName

重命名UDB实例

func (*UDBClient) ModifyUDBInstancePassword 

func (c *UDBClient) ModifyUDBInstancePassword(req *ModifyUDBInstancePasswordRequest) (*ModifyUDBInstancePasswordResponse, error)

API: ModifyUDBInstancePassword

修改DB实例的管理员密码

func (*UDBClient) ModifyUDBInstanceRemarkName added in v0.22.5 

func (c *UDBClient) ModifyUDBInstanceRemarkName(req *ModifyUDBInstanceRemarkNameRequest) (*ModifyUDBInstanceRemarkNameResponse, error)

API: ModifyUDBInstanceRemarkName

修改UDB实例备注信息

func (*UDBClient) ModifyUDBInstanceSSL added in v0.22.14 

func (c *UDBClient) ModifyUDBInstanceSSL(req *ModifyUDBInstanceSSLRequest) (*ModifyUDBInstanceSSLResponse, error)

API: ModifyUDBInstanceSSL

调整SSL的信息

func (*UDBClient) NewBackupUDBInstanceBinlogRequest 

func (c *UDBClient) NewBackupUDBInstanceBinlogRequest() *BackupUDBInstanceBinlogRequest

NewBackupUDBInstanceBinlogRequest will create request of BackupUDBInstanceBinlog action.

func (*UDBClient) NewBackupUDBInstanceErrorLogRequest 

func (c *UDBClient) NewBackupUDBInstanceErrorLogRequest() *BackupUDBInstanceErrorLogRequest

NewBackupUDBInstanceErrorLogRequest will create request of BackupUDBInstanceErrorLog action.

func (*UDBClient) NewBackupUDBInstanceRequest 

func (c *UDBClient) NewBackupUDBInstanceRequest() *BackupUDBInstanceRequest

NewBackupUDBInstanceRequest will create request of BackupUDBInstance action.

func (*UDBClient) NewBackupUDBInstanceSlowLogRequest 

func (c *UDBClient) NewBackupUDBInstanceSlowLogRequest() *BackupUDBInstanceSlowLogRequest

NewBackupUDBInstanceSlowLogRequest will create request of BackupUDBInstanceSlowLog action.

func (*UDBClient) NewChangeUDBParamGroupRequest added in v0.21.3 

func (c *UDBClient) NewChangeUDBParamGroupRequest() *ChangeUDBParamGroupRequest

NewChangeUDBParamGroupRequest will create request of ChangeUDBParamGroup action.

func (*UDBClient) NewCheckRecoverUDBInstanceRequest 

func (c *UDBClient) NewCheckRecoverUDBInstanceRequest() *CheckRecoverUDBInstanceRequest

NewCheckRecoverUDBInstanceRequest will create request of CheckRecoverUDBInstance action.

func (*UDBClient) NewCheckUDBInstanceToHAAllowanceRequest 

func (c *UDBClient) NewCheckUDBInstanceToHAAllowanceRequest() *CheckUDBInstanceToHAAllowanceRequest

NewCheckUDBInstanceToHAAllowanceRequest will create request of CheckUDBInstanceToHAAllowance action.

func (*UDBClient) NewClearUDBLogRequest 

func (c *UDBClient) NewClearUDBLogRequest() *ClearUDBLogRequest

NewClearUDBLogRequest will create request of ClearUDBLog action.

func (*UDBClient) NewCreateMongoDBReplicaSetRequest added in v0.21.3 

func (c *UDBClient) NewCreateMongoDBReplicaSetRequest() *CreateMongoDBReplicaSetRequest

NewCreateMongoDBReplicaSetRequest will create request of CreateMongoDBReplicaSet action.

func (*UDBClient) NewCreateUDBInstanceByRecoveryRequest 

func (c *UDBClient) NewCreateUDBInstanceByRecoveryRequest() *CreateUDBInstanceByRecoveryRequest

NewCreateUDBInstanceByRecoveryRequest will create request of CreateUDBInstanceByRecovery action.

func (*UDBClient) NewCreateUDBInstanceRequest 

func (c *UDBClient) NewCreateUDBInstanceRequest() *CreateUDBInstanceRequest

NewCreateUDBInstanceRequest will create request of CreateUDBInstance action.

func (*UDBClient) NewCreateUDBParamGroupRequest 

func (c *UDBClient) NewCreateUDBParamGroupRequest() *CreateUDBParamGroupRequest

NewCreateUDBParamGroupRequest will create request of CreateUDBParamGroup action.

func (*UDBClient) NewCreateUDBReplicationInstanceRequest 

func (c *UDBClient) NewCreateUDBReplicationInstanceRequest() *CreateUDBReplicationInstanceRequest

NewCreateUDBReplicationInstanceRequest will create request of CreateUDBReplicationInstance action.

func (*UDBClient) NewCreateUDBRouteInstanceRequest 

func (c *UDBClient) NewCreateUDBRouteInstanceRequest() *CreateUDBRouteInstanceRequest

NewCreateUDBRouteInstanceRequest will create request of CreateUDBRouteInstance action.

func (*UDBClient) NewCreateUDBSlaveRequest 

func (c *UDBClient) NewCreateUDBSlaveRequest() *CreateUDBSlaveRequest

NewCreateUDBSlaveRequest will create request of CreateUDBSlave action.

func (*UDBClient) NewDeleteUDBBackupRequest 

func (c *UDBClient) NewDeleteUDBBackupRequest() *DeleteUDBBackupRequest

NewDeleteUDBBackupRequest will create request of DeleteUDBBackup action.

func (*UDBClient) NewDeleteUDBInstanceRequest 

func (c *UDBClient) NewDeleteUDBInstanceRequest() *DeleteUDBInstanceRequest

NewDeleteUDBInstanceRequest will create request of DeleteUDBInstance action.

func (*UDBClient) NewDeleteUDBLogPackageRequest 

func (c *UDBClient) NewDeleteUDBLogPackageRequest() *DeleteUDBLogPackageRequest

NewDeleteUDBLogPackageRequest will create request of DeleteUDBLogPackage action.

func (*UDBClient) NewDeleteUDBParamGroupRequest 

func (c *UDBClient) NewDeleteUDBParamGroupRequest() *DeleteUDBParamGroupRequest

NewDeleteUDBParamGroupRequest will create request of DeleteUDBParamGroup action.

func (*UDBClient) NewDescribeUDBBackupBlacklistRequest 

func (c *UDBClient) NewDescribeUDBBackupBlacklistRequest() *DescribeUDBBackupBlacklistRequest

NewDescribeUDBBackupBlacklistRequest will create request of DescribeUDBBackupBlacklist action.

func (*UDBClient) NewDescribeUDBBackupRequest 

func (c *UDBClient) NewDescribeUDBBackupRequest() *DescribeUDBBackupRequest

NewDescribeUDBBackupRequest will create request of DescribeUDBBackup action.

func (*UDBClient) NewDescribeUDBBinlogBackupURLRequest 

func (c *UDBClient) NewDescribeUDBBinlogBackupURLRequest() *DescribeUDBBinlogBackupURLRequest

NewDescribeUDBBinlogBackupURLRequest will create request of DescribeUDBBinlogBackupURL action.

func (*UDBClient) NewDescribeUDBInstanceBackupStateRequest 

func (c *UDBClient) NewDescribeUDBInstanceBackupStateRequest() *DescribeUDBInstanceBackupStateRequest

NewDescribeUDBInstanceBackupStateRequest will create request of DescribeUDBInstanceBackupState action.

func (*UDBClient) NewDescribeUDBInstanceBackupURLRequest 

func (c *UDBClient) NewDescribeUDBInstanceBackupURLRequest() *DescribeUDBInstanceBackupURLRequest

NewDescribeUDBInstanceBackupURLRequest will create request of DescribeUDBInstanceBackupURL action.

func (*UDBClient) NewDescribeUDBInstanceBinlogBackupStateRequest 

func (c *UDBClient) NewDescribeUDBInstanceBinlogBackupStateRequest() *DescribeUDBInstanceBinlogBackupStateRequest

NewDescribeUDBInstanceBinlogBackupStateRequest will create request of DescribeUDBInstanceBinlogBackupState action.

func (*UDBClient) NewDescribeUDBInstanceBinlogRequest 

func (c *UDBClient) NewDescribeUDBInstanceBinlogRequest() *DescribeUDBInstanceBinlogRequest

NewDescribeUDBInstanceBinlogRequest will create request of DescribeUDBInstanceBinlog action.

func (*UDBClient) NewDescribeUDBInstanceLogRequest added in v0.21.3 

func (c *UDBClient) NewDescribeUDBInstanceLogRequest() *DescribeUDBInstanceLogRequest

NewDescribeUDBInstanceLogRequest will create request of DescribeUDBInstanceLog action.

func (*UDBClient) NewDescribeUDBInstancePriceRequest 

func (c *UDBClient) NewDescribeUDBInstancePriceRequest() *DescribeUDBInstancePriceRequest

NewDescribeUDBInstancePriceRequest will create request of DescribeUDBInstancePrice action.

func (*UDBClient) NewDescribeUDBInstanceRequest 

func (c *UDBClient) NewDescribeUDBInstanceRequest() *DescribeUDBInstanceRequest

NewDescribeUDBInstanceRequest will create request of DescribeUDBInstance action.

func (*UDBClient) NewDescribeUDBInstanceStateRequest 

func (c *UDBClient) NewDescribeUDBInstanceStateRequest() *DescribeUDBInstanceStateRequest

NewDescribeUDBInstanceStateRequest will create request of DescribeUDBInstanceState action.

func (*UDBClient) NewDescribeUDBInstanceUpgradePriceRequest 

func (c *UDBClient) NewDescribeUDBInstanceUpgradePriceRequest() *DescribeUDBInstanceUpgradePriceRequest

NewDescribeUDBInstanceUpgradePriceRequest will create request of DescribeUDBInstanceUpgradePrice action.

func (*UDBClient) NewDescribeUDBLogBackupURLRequest 

func (c *UDBClient) NewDescribeUDBLogBackupURLRequest() *DescribeUDBLogBackupURLRequest

NewDescribeUDBLogBackupURLRequest will create request of DescribeUDBLogBackupURL action.

func (*UDBClient) NewDescribeUDBLogPackageRequest 

func (c *UDBClient) NewDescribeUDBLogPackageRequest() *DescribeUDBLogPackageRequest

NewDescribeUDBLogPackageRequest will create request of DescribeUDBLogPackage action.

func (*UDBClient) NewDescribeUDBParamGroupRequest 

func (c *UDBClient) NewDescribeUDBParamGroupRequest() *DescribeUDBParamGroupRequest

NewDescribeUDBParamGroupRequest will create request of DescribeUDBParamGroup action.

func (*UDBClient) NewDescribeUDBSplittingInfoRequest added in v0.21.3 

func (c *UDBClient) NewDescribeUDBSplittingInfoRequest() *DescribeUDBSplittingInfoRequest

NewDescribeUDBSplittingInfoRequest will create request of DescribeUDBSplittingInfo action.

func (*UDBClient) NewDescribeUDBTypeRequest 

func (c *UDBClient) NewDescribeUDBTypeRequest() *DescribeUDBTypeRequest

NewDescribeUDBTypeRequest will create request of DescribeUDBType action.

func (*UDBClient) NewDisableUDBRWSplittingRequest added in v0.21.3 

func (c *UDBClient) NewDisableUDBRWSplittingRequest() *DisableUDBRWSplittingRequest

NewDisableUDBRWSplittingRequest will create request of DisableUDBRWSplitting action.

func (*UDBClient) NewEditUDBBackupBlacklistRequest 

func (c *UDBClient) NewEditUDBBackupBlacklistRequest() *EditUDBBackupBlacklistRequest

NewEditUDBBackupBlacklistRequest will create request of EditUDBBackupBlacklist action.

func (*UDBClient) NewEnableUDBRWSplittingRequest added in v0.21.3 

func (c *UDBClient) NewEnableUDBRWSplittingRequest() *EnableUDBRWSplittingRequest

NewEnableUDBRWSplittingRequest will create request of EnableUDBRWSplitting action.

func (*UDBClient) NewExtractUDBParamGroupRequest added in v0.21.3 

func (c *UDBClient) NewExtractUDBParamGroupRequest() *ExtractUDBParamGroupRequest

NewExtractUDBParamGroupRequest will create request of ExtractUDBParamGroup action.

func (*UDBClient) NewFetchUDBInstanceEarliestRecoverTimeRequest 

func (c *UDBClient) NewFetchUDBInstanceEarliestRecoverTimeRequest() *FetchUDBInstanceEarliestRecoverTimeRequest

NewFetchUDBInstanceEarliestRecoverTimeRequest will create request of FetchUDBInstanceEarliestRecoverTime action.

func (*UDBClient) NewGetUDBClientConnNumRequest added in v0.21.29 

func (c *UDBClient) NewGetUDBClientConnNumRequest() *GetUDBClientConnNumRequest

NewGetUDBClientConnNumRequest will create request of GetUDBClientConnNum action.

func (*UDBClient) NewGetUDBInstanceSSLCertURLRequest added in v0.22.14 

func (c *UDBClient) NewGetUDBInstanceSSLCertURLRequest() *GetUDBInstanceSSLCertURLRequest

NewGetUDBInstanceSSLCertURLRequest will create request of GetUDBInstanceSSLCertURL action.

func (*UDBClient) NewListUDBMachineTypeRequest added in v0.22.18 

func (c *UDBClient) NewListUDBMachineTypeRequest() *ListUDBMachineTypeRequest

NewListUDBMachineTypeRequest will create request of ListUDBMachineType action.

func (*UDBClient) NewListUDBUserTablesRequest added in v0.22.15 

func (c *UDBClient) NewListUDBUserTablesRequest() *ListUDBUserTablesRequest

NewListUDBUserTablesRequest will create request of ListUDBUserTables action.

func (*UDBClient) NewModifyUDBInstanceNameRequest 

func (c *UDBClient) NewModifyUDBInstanceNameRequest() *ModifyUDBInstanceNameRequest

NewModifyUDBInstanceNameRequest will create request of ModifyUDBInstanceName action.

func (*UDBClient) NewModifyUDBInstancePasswordRequest 

func (c *UDBClient) NewModifyUDBInstancePasswordRequest() *ModifyUDBInstancePasswordRequest

NewModifyUDBInstancePasswordRequest will create request of ModifyUDBInstancePassword action.

func (*UDBClient) NewModifyUDBInstanceRemarkNameRequest added in v0.22.5 

func (c *UDBClient) NewModifyUDBInstanceRemarkNameRequest() *ModifyUDBInstanceRemarkNameRequest

NewModifyUDBInstanceRemarkNameRequest will create request of ModifyUDBInstanceRemarkName action.

func (*UDBClient) NewModifyUDBInstanceSSLRequest added in v0.22.14 

func (c *UDBClient) NewModifyUDBInstanceSSLRequest() *ModifyUDBInstanceSSLRequest

NewModifyUDBInstanceSSLRequest will create request of ModifyUDBInstanceSSL action.

func (*UDBClient) NewPromoteUDBInstanceToHARequest 

func (c *UDBClient) NewPromoteUDBInstanceToHARequest() *PromoteUDBInstanceToHARequest

NewPromoteUDBInstanceToHARequest will create request of PromoteUDBInstanceToHA action.

func (*UDBClient) NewPromoteUDBSlaveRequest 

func (c *UDBClient) NewPromoteUDBSlaveRequest() *PromoteUDBSlaveRequest

NewPromoteUDBSlaveRequest will create request of PromoteUDBSlave action.

func (*UDBClient) NewResizeUDBInstanceRequest 

func (c *UDBClient) NewResizeUDBInstanceRequest() *ResizeUDBInstanceRequest

NewResizeUDBInstanceRequest will create request of ResizeUDBInstance action.

func (*UDBClient) NewRestartRWSplittingRequest added in v0.21.3 

func (c *UDBClient) NewRestartRWSplittingRequest() *RestartRWSplittingRequest

NewRestartRWSplittingRequest will create request of RestartRWSplitting action.

func (*UDBClient) NewRestartUDBInstanceRequest 

func (c *UDBClient) NewRestartUDBInstanceRequest() *RestartUDBInstanceRequest

NewRestartUDBInstanceRequest will create request of RestartUDBInstance action.

func (*UDBClient) NewRollbackUDBInstanceRequest added in v0.22.6 

func (c *UDBClient) NewRollbackUDBInstanceRequest() *RollbackUDBInstanceRequest

NewRollbackUDBInstanceRequest will create request of RollbackUDBInstance action.

func (*UDBClient) NewSetUDBRWSplittingRequest added in v0.21.3 

func (c *UDBClient) NewSetUDBRWSplittingRequest() *SetUDBRWSplittingRequest

NewSetUDBRWSplittingRequest will create request of SetUDBRWSplitting action.

func (*UDBClient) NewStartUDBInstanceRequest 

func (c *UDBClient) NewStartUDBInstanceRequest() *StartUDBInstanceRequest

NewStartUDBInstanceRequest will create request of StartUDBInstance action.

func (*UDBClient) NewStopUDBInstanceRequest 

func (c *UDBClient) NewStopUDBInstanceRequest() *StopUDBInstanceRequest

NewStopUDBInstanceRequest will create request of StopUDBInstance action.

func (*UDBClient) NewSwitchUDBHAToSentinelRequest added in v0.21.3 

func (c *UDBClient) NewSwitchUDBHAToSentinelRequest() *SwitchUDBHAToSentinelRequest

NewSwitchUDBHAToSentinelRequest will create request of SwitchUDBHAToSentinel action.

func (*UDBClient) NewSwitchUDBInstanceToHARequest 

func (c *UDBClient) NewSwitchUDBInstanceToHARequest() *SwitchUDBInstanceToHARequest

NewSwitchUDBInstanceToHARequest will create request of SwitchUDBInstanceToHA action.

func (*UDBClient) NewUpdateUDBInstanceBackupStrategyRequest 

func (c *UDBClient) NewUpdateUDBInstanceBackupStrategyRequest() *UpdateUDBInstanceBackupStrategyRequest

NewUpdateUDBInstanceBackupStrategyRequest will create request of UpdateUDBInstanceBackupStrategy action.

func (*UDBClient) NewUpdateUDBInstanceSlaveBackupSwitchRequest 

func (c *UDBClient) NewUpdateUDBInstanceSlaveBackupSwitchRequest() *UpdateUDBInstanceSlaveBackupSwitchRequest

NewUpdateUDBInstanceSlaveBackupSwitchRequest will create request of UpdateUDBInstanceSlaveBackupSwitch action.

func (*UDBClient) NewUpdateUDBParamGroupRequest 

func (c *UDBClient) NewUpdateUDBParamGroupRequest() *UpdateUDBParamGroupRequest

NewUpdateUDBParamGroupRequest will create request of UpdateUDBParamGroup action.

func (*UDBClient) NewUpgradeUDBInstanceToHARequest added in v0.21.29 

func (c *UDBClient) NewUpgradeUDBInstanceToHARequest() *UpgradeUDBInstanceToHARequest

NewUpgradeUDBInstanceToHARequest will create request of UpgradeUDBInstanceToHA action.

func (*UDBClient) NewUpgradeUDBVersionRequest added in v0.22.6 

func (c *UDBClient) NewUpgradeUDBVersionRequest() *UpgradeUDBVersionRequest

NewUpgradeUDBVersionRequest will create request of UpgradeUDBVersion action.

func (*UDBClient) NewUploadUDBParamGroupRequest 

func (c *UDBClient) NewUploadUDBParamGroupRequest() *UploadUDBParamGroupRequest

NewUploadUDBParamGroupRequest will create request of UploadUDBParamGroup action.

func (*UDBClient) PromoteUDBInstanceToHA 

func (c *UDBClient) PromoteUDBInstanceToHA(req *PromoteUDBInstanceToHARequest) (*PromoteUDBInstanceToHAResponse, error)

API: PromoteUDBInstanceToHA

普通db升级为高可用(只针对mysql5.5及以上版本SSD机型的实例) ，对于NVMe机型的单点升级高可用，虽然也能使用该操作再加上SwitchUDBInstanceToHA，但是更建议直接调用新的API接口（UpgradeUDBInstanceToHA）

func (*UDBClient) PromoteUDBSlave 

func (c *UDBClient) PromoteUDBSlave(req *PromoteUDBSlaveRequest) (*PromoteUDBSlaveResponse, error)

API: PromoteUDBSlave

从库提升为独立库

func (*UDBClient) ResizeUDBInstance 

func (c *UDBClient) ResizeUDBInstance(req *ResizeUDBInstanceRequest) (*ResizeUDBInstanceResponse, error)

API: ResizeUDBInstance

修改（升级和降级）UDB实例的配置，包括内存和磁盘的配置，对于内存升级无需关闭实例，其他场景需要事先关闭实例。两套参数可以配置升降机：1.配置UseSSD和SSDType 2.配置InstanceType，不需要配置InstanceMode。这两套第二套参数的优先级更高

func (*UDBClient) RestartRWSplitting added in v0.21.3 

func (c *UDBClient) RestartRWSplitting(req *RestartRWSplittingRequest) (*RestartRWSplittingResponse, error)

API: RestartRWSplitting

读写分离中间件重启，对应docker重启，但是ip不变

func (*UDBClient) RestartUDBInstance 

func (c *UDBClient) RestartUDBInstance(req *RestartUDBInstanceRequest) (*RestartUDBInstanceResponse, error)

API: RestartUDBInstance

重启UDB实例

func (*UDBClient) RollbackUDBInstance added in v0.22.6 

func (c *UDBClient) RollbackUDBInstance(req *RollbackUDBInstanceRequest) (*RollbackUDBInstanceResponse, error)

API: RollbackUDBInstance

在原实例回档指定库表

func (*UDBClient) SetUDBRWSplitting added in v0.21.3 

func (c *UDBClient) SetUDBRWSplitting(req *SetUDBRWSplittingRequest) (*SetUDBRWSplittingResponse, error)

API: SetUDBRWSplitting

设置读写分离的模式

func (*UDBClient) StartUDBInstance 

func (c *UDBClient) StartUDBInstance(req *StartUDBInstanceRequest) (*StartUDBInstanceResponse, error)

API: StartUDBInstance

启动UDB实例

func (*UDBClient) StopUDBInstance 

func (c *UDBClient) StopUDBInstance(req *StopUDBInstanceRequest) (*StopUDBInstanceResponse, error)

API: StopUDBInstance

关闭UDB实例

func (*UDBClient) SwitchUDBHAToSentinel added in v0.21.3 

func (c *UDBClient) SwitchUDBHAToSentinel(req *SwitchUDBHAToSentinelRequest) (*SwitchUDBHAToSentinelResponse, error)

API: SwitchUDBHAToSentinel

UDB高可用实例从HAProxy版本升级为Sentinel版本（不带HAProxy）升级耗时5-10秒

func (*UDBClient) SwitchUDBInstanceToHA 

func (c *UDBClient) SwitchUDBInstanceToHA(req *SwitchUDBInstanceToHARequest) (*SwitchUDBInstanceToHAResponse, error)

API: SwitchUDBInstanceToHA

普通UDB切换为高可用(只针对mysql5.5及以上版本SSD机型的实例) ，原db状态为WaitForSwitch时，调用该api； 对于NVMe机型的单点升级高可用，虽然也能使用PromoteUDBInstanceToHA再加上该操作，但是更建议直接调用新的API接口（UpgradeUDBInstanceToHA）

func (*UDBClient) UpdateUDBInstanceBackupStrategy 

func (c *UDBClient) UpdateUDBInstanceBackupStrategy(req *UpdateUDBInstanceBackupStrategyRequest) (*UpdateUDBInstanceBackupStrategyResponse, error)

API: UpdateUDBInstanceBackupStrategy

修改UDB自动备份策略

func (*UDBClient) UpdateUDBInstanceSlaveBackupSwitch 

func (c *UDBClient) UpdateUDBInstanceSlaveBackupSwitch(req *UpdateUDBInstanceSlaveBackupSwitchRequest) (*UpdateUDBInstanceSlaveBackupSwitchResponse, error)

API: UpdateUDBInstanceSlaveBackupSwitch

开启或者关闭UDB从库备份

func (*UDBClient) UpdateUDBParamGroup 

func (c *UDBClient) UpdateUDBParamGroup(req *UpdateUDBParamGroupRequest) (*UpdateUDBParamGroupResponse, error)

API: UpdateUDBParamGroup

更新UDB配置参数项

func (*UDBClient) UpgradeUDBInstanceToHA added in v0.21.29 

func (c *UDBClient) UpgradeUDBInstanceToHA(req *UpgradeUDBInstanceToHARequest) (*UpgradeUDBInstanceToHAResponse, error)

API: UpgradeUDBInstanceToHA

快杰普通db升级为高可用(只针对mysql5.5及以上版本Nvme机型的实例)

func (*UDBClient) UpgradeUDBVersion added in v0.22.6 

func (c *UDBClient) UpgradeUDBVersion(req *UpgradeUDBVersionRequest) (*UpgradeUDBVersionResponse, error)

API: UpgradeUDBVersion

升级db实例版本

func (*UDBClient) UploadUDBParamGroup 

func (c *UDBClient) UploadUDBParamGroup(req *UploadUDBParamGroupRequest) (*UploadUDBParamGroupResponse, error)

API: UploadUDBParamGroup

导入UDB配置

type UDBDatabaseData added in v0.22.15 

type UDBDatabaseData struct {

	// 数据库名称
	DBName string

	// 该库所有的表集合
	TableDataSet []TableData
}

UDBDatabaseData - 某个库的详细信息

type UDBInstanceBinlogSet 

type UDBInstanceBinlogSet struct {

	// Binlog文件生成时间(时间戳)
	BeginTime int

	// Binlog文件结束时间(时间戳)
	EndTime int

	// Binlog文件名
	Name string

	// Binlog文件大小
	Size int
}

UDBInstanceBinlogSet - DescribeUDBInstanceBinlog

type UDBInstancePriceSet 

type UDBInstancePriceSet struct {

	// Year， Month， Dynamic，Trial
	ChargeType string

	// 价格，单位为分
	Price int
}

UDBInstancePriceSet - DescribeUDBInstancePrice

type UDBInstanceSet 

type UDBInstanceSet struct {

	// 管理员帐户名，默认root
	AdminUser string

	// 备份策略，不可修改，开始时间，单位小时计，默认3点
	BackupBeginTime int

	// 备份策略，备份黑名单，mongodb则不适用
	BackupBlacklist string

	// 备份策略，不可修改，备份文件保留的数量，默认7次
	BackupCount int

	// 备份日期标记位。共7位,每一位为一周中一天的备份情况 0表示关闭当天备份,1表示打开当天备份。最右边的一位 为星期天的备份开关，其余从右到左依次为星期一到星期 六的备份配置开关，每周必须至少设置两天备份。 例如：1100000 表示打开星期六和星期五的自动备份功能
	BackupDate string

	// 备份策略，一天内备份时间间隔，单位小时，默认24小时
	BackupDuration int

	// 默认的备份方式，nobackup表示不备份， snapshot 表示使用快照备份，logic 表示使用逻辑备份，xtrabackup表示使用物理备份。
	BackupMethod string

	// 跨可用区高可用备库所在可用区
	BackupZone string

	// CPU核数
	CPU int

	// 0区分大小写, 1不分区
	CaseSensitivityParam int

	// Year， Month， Dynamic，Trial，默认: Dynamic
	ChargeType string

	//
	CluserRole string `deprecated:"true"`

	// 当DB类型为mongodb时，返回该实例所在集群中的角色，包括：mongos、configsrv_sccc、configsrv_csrs、shardsrv_datanode、shardsrv_arbiter，其中congfigsrv分为sccc和csrs两种模式，shardsrv分为datanode和arbiter两种模式
	ClusterRole string

	// DB实例创建时间，采用UTC计时时间戳
	CreateTime int

	// DB实例id
	DBId string

	// mysql实例提供具体小版本信息
	DBSubVersion string

	// DB类型id，mysql/mongodb按版本细分各有一个id 目前id的取值范围为[1,7],数值对应的版本如下： 1：mysql-5.5，2：mysql-5.1，3：percona-5.5 4：mongodb-2.4，5：mongodb-2.6，6：mysql-5.6， 7：percona-5.6
	DBTypeId string

	// DB实例数据文件大小，单位GB
	DataFileSize float64

	// 如果在需要返回从库的场景下，返回该DB实例的所有从库DB实例信息列表。列表中每一个元素的内容同UDBSlaveInstanceSet 。如果这个DB实例没有从库的情况下，此时返回一个空的列表
	DataSet []UDBSlaveInstanceSet

	// 磁盘空间(GB), 默认根据配置机型
	DiskSpace int

	// DB实例磁盘已使用空间，单位GB
	DiskUsedSize float64

	// mysql是否开启了SSL；1->未开启  2->开启
	EnableSSL int

	// DB实例过期时间，采用UTC计时时间戳
	ExpiredTime int

	// 该实例的ipv6地址
	IPv6Address string

	// UDB实例模式类型, 可选值如下: “Normal”： 普通版UDB实例 “HA”: 高可用版UDB实例
	InstanceMode string

	// UDB数据库机型
	InstanceType string

	// UDB数据库机型ID (已弃用)
	InstanceTypeId int

	// DB实例日志文件大小，单位GB
	LogFileSize float64

	// 数据库机型规格
	MachineType string

	// 内存限制(MB)，默认根据配置机型
	MemoryLimit int

	// DB实例修改时间，采用UTC计时时间戳
	ModifyTime int

	// 实例名称，至少6位
	Name string

	// DB实例使用的配置参数组id
	ParamGroupId int

	// 端口号，mysql默认3306，mongodb默认27017
	Port int

	// DB实例角色，mysql区分master/slave，mongodb多种角色
	Role string

	// SSD类型，SATA/PCI-E/NVMe
	SSDType string

	// SSL到期时间
	SSLExpirationTime int

	// 是否使用可选cpu类型规格
	SpecificationType int

	// 对mysql的slave而言是master的DBId，对master则为空， 对mongodb则是副本集id
	SrcDBId string

	// DB状态标记 Init：初始化中，Fail：安装失败，Starting：启动中，Running：运行，Shutdown：关闭中，Shutoff：已关闭，Delete：已删除，Upgrading：升级中，Promoting：提升为独库进行中，Recovering：恢复中，Recover fail：恢复失败, Remakeing:重做中,RemakeFail:重做失败，VersionUpgrading:小版本升级中，VersionUpgradeWaitForSwitch:高可用等待切换，VersionUpgradeFail：小版本升级失败，UpdatingSSL：修改SSL中，UpdateSSLFail：修改SSL失败,MajorVersionUpgrading:小版本升级中，MajorVersionUpgradeWaitForSwitch:高可用等待切换，MajorVersionUpgradeFail
	State string

	// 子网ID
	SubnetId string

	// DB实例系统文件大小，单位GB
	SystemFileSize float64

	// 获取资源其他信息
	Tag string

	// 是否使用SSD
	UseSSD bool

	// 用户转存备份到自己的UFILE配置, 结构参考UFileDataSet
	UserUFileData UFileDataSet

	// VPC的ID
	VPCId string

	// DB实例虚ip
	VirtualIP string

	// DB实例虚ip的mac地址
	VirtualIPMac string

	// DB实例所在可用区
	Zone string
}

UDBInstanceSet - DescribeUDBInstance

type UDBParamGroupSet 

type UDBParamGroupSet struct {

	// DB类型id，mysql/mongodb按版本细分各有一个id 目前id的取值范围为[1,7],数值对应的版本如下 1：mysql-5.5，2：mysql-5.1，3：percona-5.5 4：mongodb-2.4，5：mongodb-2.6，6：mysql-5.6 7：percona-5.6
	DBTypeId string

	// 参数组描述
	Description string

	// 参数组id
	GroupId int

	// 参数组名称
	GroupName string

	// 参数组是否可修改
	Modifiable bool

	// 参数的键值对表 UDBParamMemberSet
	ParamMember []UDBParamMemberSet

	//
	RegionFlag bool

	//
	Zone string
}

UDBParamGroupSet - DescribeUDBParamGroup

type UDBParamMemberSet 

type UDBParamMemberSet struct {

	// 允许的值(根据参数类型，用分隔符表示)
	AllowedVal string

	// 参数值应用类型,取值范围为{0,10,20}，各值代表 意义为0-unknown、10-static、20-dynamic
	ApplyType int

	// 允许值的格式类型，取值范围为{0,10,20}，意义分 别为PVFT_UNKOWN=0,PVFT_RANGE=10, PVFT_ENUM=20
	FormatType int

	// 参数名称
	Key string

	// 是否可更改，默认为false
	Modifiable bool

	// 参数值
	Value string

	// 参数值应用类型，取值范围为{0,10,20,30},各值 代表意义为 0-unknown、10-int、20-string、 30-bool
	ValueType int
}

UDBParamMemberSet - DescribeUDBParamGroup

type UDBRWSplittingSet added in v0.21.3 

type UDBRWSplittingSet struct {

	// DB实例ID
	DBId string

	// 读写分离比重
	ReadWeight int

	// 主库/从库
	Role string

	// DB状态
	State string

	// DBIP
	VirtualIP string
}

UDBRWSplittingSet - 读写分离

type UDBSlaveInstanceSet 

type UDBSlaveInstanceSet struct {

	// 管理员帐户名，默认root
	AdminUser string

	// 备份策略，不可修改，开始时间，单位小时计，默认3点
	BackupBeginTime int

	// 备份策略，备份黑名单，mongodb则不适用
	BackupBlacklist string

	// 备份策略，不可修改，备份文件保留的数量，默认7次
	BackupCount int

	// 备份日期标记位。共7位,每一位为一周中一天的备份情况 0表示关闭当天备份,1表示打开当天备份。最右边的一位 为星期天的备份开关，其余从右到左依次为星期一到星期 六的备份配置开关，每周必须至少设置两天备份。 例如：1100000 表示打开星期六和星期五的自动备份功能
	BackupDate string

	// 备份策略，一天内备份时间间隔，单位小时，默认24小时
	BackupDuration int

	// 0 区分大小写, 1不区分, 只针对mysql8.0
	CaseSensitivityParam int

	// Year， Month， Dynamic，Trial，默认: Dynamic
	ChargeType string

	// 当DB类型为mongodb时，返回该实例所在集群中的角色，包括：mongos、configsrv_sccc、configsrv_csrs、shardsrv_datanode、shardsrv_arbiter，其中congfigsrv分为sccc和csrs两种模式，shardsrv分为datanode和arbiter两种模式
	ClusterRole string

	// DB实例创建时间，采用UTC计时时间戳
	CreateTime int

	// DB实例id
	DBId string

	// DB类型id，mysql/mongodb按版本细分各有一个id 目前id的取值范围为[1,7],数值对应的版本如下： 1：mysql-5.5，2：mysql-5.1，3：percona-5.5 4：mongodb-2.4，5：mongodb-2.6，6：mysql-5.6， 7：percona-5.6
	DBTypeId string

	// DB实例数据文件大小，单位GB
	DataFileSize float64

	// 磁盘空间(GB), 默认根据配置机型
	DiskSpace int

	// DB实例磁盘已使用空间，单位GB
	DiskUsedSize float64

	// DB实例过期时间，采用UTC计时时间戳
	ExpiredTime int

	// UDB实例模式类型, 可选值如下: "Normal": 普通版UDB实例;"HA": 高可用版UDB实例
	InstanceMode string

	// UDB数据库机型
	InstanceType string

	// UDB数据库机型ID
	InstanceTypeId int

	// DB实例日志文件大小，单位GB
	LogFileSize float64

	// 规格类型ID,当SpecificationType为1时有效
	MachineType string

	// 内存限制(MB)，默认根据配置机型
	MemoryLimit int

	// DB实例修改时间，采用UTC计时时间戳
	ModifyTime int

	// 实例名称，至少6位
	Name string

	// DB实例使用的配置参数组id
	ParamGroupId int

	// 端口号，mysql默认3306，mongodb默认27017
	Port int

	// 延时从库时长
	ReplicationDelaySeconds int

	// DB实例角色，mysql区分master/slave，mongodb多种角色
	Role string

	// SSD类型，SATA/PCI-E
	SSDType string

	// 实例计算规格类型，0或不传代表使用内存方式购买，1代表使用内存-cpu可选配比方式购买，需要填写MachineType
	SpecificationType string

	// 对mysql的slave而言是master的DBId，对master则为空， 对mongodb则是副本集id
	SrcDBId string

	// DB状态标记 Init：初始化中，Fail：安装失败，Starting：启动中，Running：运行，Shutdown：关闭中，Shutoff：已关闭，Delete：已删除，Upgrading：升级中，Promoting：提升为独库进行中，Recovering：恢复中，Recover fail：恢复失败,Remakeing:重做中,RemakeFail:重做失败, MajorVersionUpgrading:小版本升级中，MajorVersionUpgradeWaitForSwitch:高可用等待切换，MajorVersionUpgradeFail
	State string

	// 子网ID
	SubnetId string

	// DB实例系统文件大小，单位GB
	SystemFileSize float64

	// 获取资源其他信息
	Tag string

	// 是否使用SSD
	UseSSD bool

	// VPC的ID
	VPCId string

	// DB实例虚ip
	VirtualIP string

	// DB实例虚ip的mac地址
	VirtualIPMac string

	// 可用区
	Zone string
}

UDBSlaveInstanceSet - DescribeUDBSlaveInstance

type UDBTypeSet 

type UDBTypeSet struct {

	// mysql子版本，如mysql-8.0.25,mysql-8.0.16
	DBSubVersion string

	// DB类型id，mysql/mongodb按版本细分各有一个id, 目前id的取值范围为[1,7],数值对应的版本如下： 1：mysql-5.5，2：mysql-5.1，3：percona-5.5 4：mongodb-2.4，5：mongodb-2.6，6：mysql-5.6， 7：percona-5.6
	DBTypeId string
}

UDBTypeSet - DescribeUDBType

type UFileDataSet added in v0.21.3 

type UFileDataSet struct {

	// bucket名称
	Bucket string

	// Ufile的令牌tokenid
	TokenID string
}

UFileDataSet - 增加ufile的描述

type UpdateUDBInstanceBackupStrategyRequest 

type UpdateUDBInstanceBackupStrategyRequest struct {
	request.CommonBase

	// 备份时期标记位。共7位，每一位为一周中一天的备份情况，0表示关闭当天备份，1表示打开当天备份。最右边的一位为星期天的备份开关，其余从右到左依次为星期一到星期六的备份配置开关，每周必须至少设置两天备份。例如：1100000表示打开星期六和星期五的备份功能
	BackupDate *string `required:"false"`

	// 选择默认的备份方式，可选nobackup表示不备份， snapshot 表示使用快照备份，logic 表示使用逻辑备份。需要同时设置BackupDate字段。（快照备份即物理备份。SSD版本的mysql实例支持设置为snapshot，NVMe版本的mysql实例支持设置为xtrabackup）
	BackupMethod *string `required:"false"`

	// 备份的整点时间，范围[0,23]
	BackupTime *int `required:"false"`

	// 远端binlog保存时长(天)
	BinlogRemoteSaveDays *int `required:"false"`

	// 主节点的Id
	DBId *string `required:"true"`

	// 是否开启binlog备份, 默认为未开启
	EnableBinlogBackup *bool `required:"false"`

	// 当导出某些数据遇到问题后，是否强制导出其他剩余数据默认是false需要同时设置BackupDate字段
	ForceDump *bool `required:"false"`

	// 自动备份转存到用户自己的bucket名称，要包含到对应的token id里
	UserBucket *string `required:"false"`

	// 自动备份转存到用户自己的bucket 的tokenid， 需要用户自己自己设置权限
	UserTokenID *string `required:"false"`
}

UpdateUDBInstanceBackupStrategyRequest is request schema for UpdateUDBInstanceBackupStrategy action

type UpdateUDBInstanceBackupStrategyResponse 

type UpdateUDBInstanceBackupStrategyResponse struct {
	response.CommonBase
}

UpdateUDBInstanceBackupStrategyResponse is response schema for UpdateUDBInstanceBackupStrategy action

type UpdateUDBInstanceSlaveBackupSwitchRequest 

type UpdateUDBInstanceSlaveBackupSwitchRequest struct {
	request.CommonBase

	// 从库的备份开关，范围[0,1],0表示从库备份功能关闭,1 表示从库备份开关打开。
	BackupSwitch *int `required:"true"`

	// 主库的Id
	MasterDBId *string `required:"true"`

	// 从库的Id,如果从库备份开关设定为打开，则必须赋值。
	SlaveDBId *string `required:"false"`
}

UpdateUDBInstanceSlaveBackupSwitchRequest is request schema for UpdateUDBInstanceSlaveBackupSwitch action

type UpdateUDBInstanceSlaveBackupSwitchResponse 

type UpdateUDBInstanceSlaveBackupSwitchResponse struct {
	response.CommonBase
}

UpdateUDBInstanceSlaveBackupSwitchResponse is response schema for UpdateUDBInstanceSlaveBackupSwitch action

type UpdateUDBParamGroupRequest 

type UpdateUDBParamGroupRequest struct {
	request.CommonBase

	// 配置文件的描述，不传时认为不修改
	Description *string `required:"false"`

	// 配置参数组id，使用DescribeUDBParamGroup获得
	GroupId *int `required:"true"`

	// 参数名称（与Value配合使用）
	Key *string `required:"false"`

	// 配置文件的名字，不传时认为不修改名字，传了则不能为空
	Name *string `required:"false"`

	// 该配置文件是否是地域级别配置文件，默认是false
	RegionFlag *bool `required:"false"`

	// 参数值（与Key配合使用）
	Value *string `required:"false"`
}

UpdateUDBParamGroupRequest is request schema for UpdateUDBParamGroup action

type UpdateUDBParamGroupResponse 

type UpdateUDBParamGroupResponse struct {
	response.CommonBase
}

UpdateUDBParamGroupResponse is response schema for UpdateUDBParamGroup action

type UpgradeUDBInstanceToHARequest added in v0.21.29 

type UpgradeUDBInstanceToHARequest struct {
	request.CommonBase

	// 实例的Id,该值可以通过DescribeUDBInstance获取
	DBId *string `required:"true"`
}

UpgradeUDBInstanceToHARequest is request schema for UpgradeUDBInstanceToHA action

type UpgradeUDBInstanceToHAResponse added in v0.21.29 

type UpgradeUDBInstanceToHAResponse struct {
	response.CommonBase
}

UpgradeUDBInstanceToHAResponse is response schema for UpgradeUDBInstanceToHA action

type UpgradeUDBVersionRequest added in v0.22.6 

type UpgradeUDBVersionRequest struct {
	request.CommonBase

	// db实例资源id
	DBId *string `required:"true"`

	// db需要升级的小版本
	DBSubVersion *string `required:"true"`

	// 该值为一个unix时间戳，代表开始预期切换实例结束的时间
	SwitchEndTime *int `required:"false"`

	// 该值为一个unix时间戳，代表开始切换实例的时间
	SwitchStartTime *int `required:"false"`

	// 切换类型，可选值为"immediately"和"customize"，分别代表立即切换和自定义切换时间，自定义切换时间需要填写SwitchStartTime和SwitchEndTime
	SwitchType *string `required:"true"`
}

UpgradeUDBVersionRequest is request schema for UpgradeUDBVersion action

type UpgradeUDBVersionResponse added in v0.22.6 

type UpgradeUDBVersionResponse struct {
	response.CommonBase

	// 返回信息
	Message string
}

UpgradeUDBVersionResponse is response schema for UpgradeUDBVersion action

type UploadUDBParamGroupRequest 

type UploadUDBParamGroupRequest struct {
	request.CommonBase

	// 配置内容，导入的配置内容采用base64编码
	Content *string `required:"true"`

	// DB类型id，DB类型id，mysql/mongodb/postgesql按版本细分 1：mysql-5.1，2：mysql-5.5，3：percona-5.5，4：mysql-5.6，5：percona-5.6，6：mysql-5.7，7：percona-5.7，8：mariadb-10.0，9：mongodb-2.4，10：mongodb-2.6，11：mongodb-3.0，12：mongodb-3.2,13：postgresql-9.4，14：postgresql-9.6
	DBTypeId *string `required:"true"`

	// 参数组描述
	Description *string `required:"true"`

	// 配置参数组名称
	GroupName *string `required:"true"`

	// 【该字段已废弃，请谨慎使用】
	ParamGroupTypeId *int `required:"false" deprecated:"true"`

	// 该配置文件是否是地域级别配置文件，默认是false
	RegionFlag *bool `required:"false"`
}

UploadUDBParamGroupRequest is request schema for UploadUDBParamGroup action

type UploadUDBParamGroupResponse 

type UploadUDBParamGroupResponse struct {
	response.CommonBase

	// 配置参数组id
	GroupId int
}

UploadUDBParamGroupResponse is response schema for UploadUDBParamGroup action

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.