umongodb

type BackupInfo struct {

	// 备份ID
	BackupId string

	// 备份名称
	BackupName string

	// 备份数据大小
	BackupSize int

	// 备份类型
	BackupType string

	// 批次id
	BatchId string

	// 实例ID
	ClusterId string

	// 磁盘大小
	DiskSize int

	// 备份结束时间
	EndTime int

	// 副本类型,ConfigRepl或者DataRepl
	ReplicaType string

	// 备份开始时间
	StartTime int

	// 备份状态
	State string

	// 虚拟节点id
	VirtualClusterId string

	// 可用区
	Zone string
}

type BackupParam struct {

	// 自动备份保存份数
	AutoBackupCopies int

	// 自动备份预期时间范围 (24小时制，精确到分钟，00:00~23:59)
	AutoBackupToggleTime string

	// 自动备份预期周几 (1-7 表示 周一到周末，多个数据用','分割，eg: 3,7)
	AutoBackupToggleWeek string

	// 实例ID
	ClusterId string

	// 是否禁用(false:未禁用;true:禁用)
	Disabled bool

	// 手动备份保存份数
	ManualBackupCopies int
}

type BackupUMongoDBClusterRequest struct {
	request.CommonBase

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

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

type BackupUMongoDBClusterResponse struct {
	response.CommonBase

	// 备份ID
	BackupId string

	// 实例ID
	ClusterId string

	// 错误信息
	Message string
}

type BackupUMongoDBLogRequest struct {
	request.CommonBase

	// 日志开始时间,最早为7x24小时前
	Begin *int `required:"true"`

	// 集群id
	ClusterId *string `required:"true"`

	// 日志结束时间,时间区间不能超过24小时
	End *int `required:"true"`

	// 日志类型:SlowLog,ErrorLog
	LogType *string `required:"true"`

	// 日志包名称
	Name *string `required:"true"`

	// 节点id, 慢日志 mongos 节点不可选
	NodeId *string `required:"true"`
}

type BackupUMongoDBLogResponse struct {
	response.CommonBase
}

type ClusterInfo struct {

	// 集群ID
	ClusterId string

	// 集群类型，ReplicaSet :副本集，SharedCluster：分片集
	ClusterType string

	// 配置节点计算规格
	ConfigComputeType MongodbMachineType

	// Config配置集群节点配置，分片集有效
	ConfigMachineType string

	// Config配置集群节点数量，分片集有效
	ConfigNodeCount int

	// ConfigSrv信息
	ConfigReplicaInfo ReplicaInfo

	// 副本集的访问地址
	ConnectURL string

	// DB实例创建时间
	CreateTime int

	// 跨用区列表
	CrossZones []string

	// 副本集的Mongodb的版本
	DBVersion string

	// 数据节点计算规格
	DataComputeType MongodbMachineType

	// 数据副本信息
	DataReplicaInfos []ReplicaInfo

	// DB实例删除时间
	DeleteTime int

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

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

	// 实例名称
	InstanceName string

	// 计算规格
	MachineTypeId string

	// 路由节点计算规格
	MongosComputeType MongodbMachineType

	// Mongos节点数量，分片集有效
	MongosCount int

	// Mongos节点信息
	MongosInfo []NodeInfo

	// SSL到期时间
	SSLExpirationTime int

	// 分片数量，分片集有效
	ShardCount int

	// 每分片节点数量，分片集有效
	ShardNodeCount int

	// 副本集/分片集群状态标记 Initing：初始化中，InitFailed：安装失败，Starting：启动中，StartFailed：启动失败，Running：运行，Stopping：关闭中，Stopped：已关闭, StopFailed：关闭失败，Deleting：删除中，Deleted：已删除，DeleteFailed：删除失败，Restarting：重启中，RestartFailed：重启失败,Upgrading: 升降级中，UpgradeFailed: 升降级失败,Switching:主备切换中，UpdatingSSL：修改SSL中，UpdateSSLFail：修改SSL失败
	State string

	// 子网ID
	SubnetId string

	// 实例业务组
	Tag string

	// VPC的ID
	VPCId string

	// 可用区
	Zone string

	//
	ZoneId int
}

type ConfigOptions struct {

	// 允许应用类型
	AllowedApplyType string

	// 描述
	Description string

	// 是否前端展示
	EnableDisplay bool

	// 是否可修改
	EnableModify bool

	// 是否需重启
	ForceRestart bool

	// 是否为默认选项
	IsDefaultOption bool

	// mongo版本
	MongodbVersion string

	// 默认值
	OptionDefaultValue string

	// 选项值格式
	OptionFormatType string

	// 配置选项名
	OptionName string

	// 配置选项类型 string,int,bool
	OptionValueType string

	// 配置选项值范围
	OptionValues string
}

type ConfigTemplate struct {

	// 集群类型
	ClusterType string

	// 创建时间
	CreateTime int

	// 删除时间
	DeleteTime int

	// 模板描述
	Description string

	// 修改时间
	ModifyTime int

	// mongo版本
	MongodbVersion string

	// 模板ID
	TemplateId string

	// 模板名称
	TemplateName string

	// 模板类型 UsersTemplate DefaultTemplate
	TemplateType string
}

type ConfigTemplateItem struct {

	// 配置名称
	ConfigName string

	// 配置选项
	ConfigOption ConfigOptions

	// 配置值
	ConfigValue string

	// 创建时间
	CreateTime int

	// itemId
	ItemId string

	// 修改时间
	ModifyTime int

	// 节点类型: DataNode:数据节点 | ConfigSrvNode:配置节点 | MongosNode:路由节点
	NodeType string

	// 模板ID
	TemplateId string
}

type CreateUMongoDBConfigTemplateRequest struct {
	request.CommonBase

	// 基础模板
	BaseTemplateId *string `required:"true"`

	// 集群类型
	ClusterType *string `required:"true"`

	// 模板描述
	Description *string `required:"false"`

	// mongo版本
	MongodbVersion *string `required:"true"`

	// 模板名称
	TemplateName *string `required:"true"`
}

type CreateUMongoDBConfigTemplateResponse struct {
	response.CommonBase

	// 错误信息
	Message string

	// 模板Id
	TemplateId string
}

type CreateUMongoDBReplSetParamLabels struct {

	// 用户资源标签的键值
	Key *string `required:"false"`

	// 用户资源标签值
	Value *string `required:"false"`
}

type CreateUMongoDBReplSetParamSecGroupId struct {

	// 安全组 ID。至多可以同时绑定5个安全组。
	Id *string `required:"false"`

	// 安全组优先级。取值范围[1, 5]
	Priority *int `required:"false"`
}

type CreateUMongoDBReplSetRequest struct {
	request.CommonBase

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

	// 付费方式：Year， Month， Dynamic，Trial，默认: Month
	ChargeType *string `required:"false"`

	// 跨可用区列表
	CrossZones []string `required:"false"`

	// 副本集的Mongodb的版本，例如MongoDB 3.6, MongoDB 4.2
	DBVersion *string `required:"true"`

	// 磁盘空间 (GB)：取值范围 20~32000，仅支持 10 的整数倍
	DiskSpace *int `required:"true"`

	//
	Labels []CreateUMongoDBReplSetParamLabels `required:"false"`

	// mongo服务端口
	ListenPort *int `required:"false"`

	// 机型配置,如 o.mongo2m.medium
	MachineTypeId *string `required:"true"`

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

	// 副本集节点数量：仅支持 3、5、7 奇数节点
	NodeCount *int `required:"true"`

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

	//
	SecGroupId []CreateUMongoDBReplSetParamSecGroupId `required:"false"`

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

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

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

type CreateUMongoDBReplSetResponse struct {
	response.CommonBase
}

type CreateUMongoDBShardedClusterParamLabels struct {

	// 用户资源标签的键值
	Key *string `required:"false"`

	// 用户资源标签值
	Value *string `required:"false"`
}

type CreateUMongoDBShardedClusterParamSecGroupId struct {

	// 安全组 ID。至多可以同时绑定5个安全组。
	Id *string `required:"false"`

	// 安全组优先级。取值范围[1, 5]
	Priority *int `required:"false"`
}

type CreateUMongoDBShardedClusterRequest struct {
	request.CommonBase

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

	// 付费方式：Year， Month， Dynamic，Trial，默认: Month
	ChargeType *string `required:"false"`

	// 副本集的Mongodb的版本，例如MongoDB 3.6, MongoDB 4.2
	DBVersion *string `required:"true"`

	// 数据节点磁盘空间(GB):取值范围 20~32000，仅支持 10 的整数倍
	DiskSpace *int `required:"true"`

	//
	Labels []CreateUMongoDBShardedClusterParamLabels `required:"false"`

	// mongo服务端口
	ListenPort *int `required:"false"`

	// 数据节点机型配置,如 o.mongo2m.medium
	MachineTypeId *string `required:"true"`

	// Mongos节点机型配置
	MongosMachineTypeId *string `required:"false"`

	// Mongos节点数量
	MongosNodeCount *int `required:"true"`

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

	// 每个分片中节点数量
	NodeCount *int `required:"true"`

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

	//
	SecGroupId []CreateUMongoDBShardedClusterParamSecGroupId `required:"false"`

	// 分片数量
	ShardCount *int `required:"true"`

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

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

	// 参数配置模版id
	TemplateId *string `required:"false"`

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

type CreateUMongoDBShardedClusterResponse struct {
	response.CommonBase
}

type DescribeUMongoDBBackupURLRequest struct {
	request.CommonBase

	// 文件备份ID
	BackupId *string `required:"false"`

	// 类型:如 oplog
	Category *string `required:"false"`

	// 集群ID
	ClusterId *string `required:"true"`

	// 打包ID
	PackageId *int `required:"false"`

	// 备份链接过期时间（单位秒）
	ValidTime *int `required:"false"`
}

type DescribeUMongoDBBackupURLResponse struct {
	response.CommonBase

	// 备份文件公网地址
	InternetAddress string

	// 备份文件内网地址
	IntranetAddress string
}

type DescribeUMongoDBInstanceRequest struct {
	request.CommonBase

	// 实例资源ID
	ClusterId *string `required:"true"`

	// 集群类型，ReplicaSet：副本集，SharedCluster：分片集群
	ClusterType *string `required:"false"`
}

type DescribeUMongoDBInstanceResponse struct {
	response.CommonBase

	// 副本集信息
	ClusterInfo ClusterInfo
}

type DiskInfo struct {

	// 磁盘id
	DiskId string

	// 磁盘容量单位GB
	DiskSize int
}

type GetUMongoDBBackupParamRequest struct {
	request.CommonBase

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

type GetUMongoDBBackupParamResponse struct {
	response.CommonBase

	// 备份策略信息
	DataSet BackupParam

	// 错误信息
	Message string
}

type GetUMongoDBCfgTempItemRequest struct {
	request.CommonBase

	// 配置模板Id
	TemplateId *string `required:"true"`
}

type GetUMongoDBCfgTempItemResponse struct {
	response.CommonBase

	// 配置模板项
	DataSet []ConfigTemplateItem

	// 错误信息
	Message string
}

type GetUMongoDBLogRequest struct {
	request.CommonBase

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

	// 集群id
	ClusterId *string `required:"true"`

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

	// 日志类型:SlowLog,ErrorLog
	LogType *string `required:"true"`

	// 节点id, 慢日志 mongos 节点不可选
	NodeId *string `required:"true"`
}

type GetUMongoDBLogResponse struct {
	response.CommonBase

	// 是否已被截断
	IsTruncate bool

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

	// 支持的最大行数
	MaxLine int
}

type GetUMongoDBRecoverTimeRangeRequest struct {
	request.CommonBase

	// 集群id
	ClusterId *string `required:"true"`
}

type GetUMongoDBRecoverTimeRangeResponse struct {
	response.CommonBase

	// 最早可回档时间点
	EarliestTime int

	// 最晚可回档时间点
	LatestTime int
}

type ListUMongoDBBackupRequest struct {
	request.CommonBase

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

type ListUMongoDBBackupResponse struct {
	response.CommonBase

	// 备份列表
	DataSet []BackupInfo

	// 错误信息
	Message string
}

type ListUMongoDBConfigTemplateRequest struct {
	request.CommonBase
}

type ListUMongoDBConfigTemplateResponse struct {
	response.CommonBase

	// 配置模板列表
	DataSet []ConfigTemplate

	// 错误信息
	Message string
}

type ListUMongoDBInstancesRequest struct {
	request.CommonBase

	// 集群ID
	ClusterId *string `required:"false"`
}

type ListUMongoDBInstancesResponse struct {
	response.CommonBase

	// 副本集ID
	DataSet []MongodbInstance

	// 错误信息
	Message string
}

type ListUMongoDBLogPackageRequest struct {
	request.CommonBase

	// 集群id
	ClusterId *string `required:"true"`

	// 节点id
	NodeId *string `required:"false"`
}

type ListUMongoDBLogPackageResponse struct {
	response.CommonBase

	// 列表
	DataSet []PackageInfo
}

type ListUMongoDBMachineSpecRequest struct {
	request.CommonBase

	// 机型,如O
	ClassType *string `required:"false"`

	// 磁盘类型，如CLOUD_RSSD
	DiskType *string `required:"false"`
}

type ListUMongoDBMachineSpecResponse struct {
	response.CommonBase

	// 规格列表
	DataSet []MongodbMachineSpec
}

type ListUMongoDBMachineTypeRequest struct {
	request.CommonBase
}

type ListUMongoDBMachineTypeResponse struct {
	response.CommonBase

	//
	DataSet []MongodbMachineType
}

type ListUMongoDBVersionRequest struct {
	request.CommonBase
}

type ListUMongoDBVersionResponse struct {
	response.CommonBase

	//
	DataSet []MongoDBVersion
}

type ModifyUMongoDBAdminPasswordRequest struct {
	request.CommonBase

	// 集群ID
	ClusterId *string `required:"true"`

	// 集群新密码(密码格式使用BASE64编码)
	Password *string `required:"true"`
}

type ModifyUMongoDBAdminPasswordResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type ModifyUMongoDBAttributeRequest struct {
	request.CommonBase

	// 集群id
	ClusterId *string `required:"true"`

	// 集群新名称(输入长度为6~63位名称)
	Name *string `required:"false"`

	// 集群备注(Name和RemarkName必传其一)
	RemarkName *string `required:"false"`
}

type ModifyUMongoDBAttributeResponse struct {
	response.CommonBase

	// 返回错误信息
	Message string
}

type ModifyUMongoDBBackupParamRequest struct {
	request.CommonBase

	// 自动备份预期开始时间范围(00:00~23:59),默认 5:00~6:00
	AutoBackupToggleTime *string `required:"false"`

	// 自动备份预期星期几(1～7),默认 3,7 (周三，周日)
	AutoBackupToggleWeek *string `required:"false"`

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

	// 是否禁用,true:禁用;false:开启
	Disabled *bool `required:"false"`
}

type ModifyUMongoDBBackupParamResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type MongoDBVersion struct {

	// MongoDB版本
	DBVersion string
}

type MongodbInstance struct {

	// 副本集/分片集群ID
	ClusterId string

	// 集群类型，ReplicaSet :副本集，SharedCluster：分片集
	ClusterType string

	// 副本集/分片集群的访问地址
	ConnectURL string

	// 副本集/分片集群的创建时间
	CreateTime int

	// 跨可用区列表
	CrossZones []string

	// 副本集/分片集群的Mongodb的版本，包括MongoDB-3.6, MongoDB-4.2
	DBVersion string

	// 数据节点计算规格
	DataComputeType MongodbMachineType

	// 数据节点磁盘空间(GB)
	DiskSpace int

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

	// 副本集/分片集IPv6访问地址
	IPv6ConnectURL string

	// 副本集/分片集群实例名称
	Name string

	// 副本集/分片集群状态标记 Initing：初始化中，InitFailed：安装失败，Starting：启动中，StartFailed：启动失败，Running：运行，Stopping：关闭中，Stopped：已关闭, StopFailed：关闭失败，Deleting：删除中，Deleted：已删除，DeleteFailed：删除失败，Restarting：重启中，RestartFailed：重启失败,Upgrading: 升降级中，UpgradeFailed: 升降级失败,Switching:主备切换中
	State string

	// 子网ID
	SubnetId string

	// 业务组
	Tag string

	// VPC的ID
	VPCId string

	// 可用区
	Zone string
}

type MongodbMachineSpec struct {

	// 规格类型;O | N
	ClassType string

	// 计算规格列表
	ComputeType []MongodbMachineType

	// 默认规格
	DefaultMachineType MongodbMachineType

	// 磁盘类型;CLOUD_RSSD | CLOUD_SSD | LOCAL_SSD
	DiskType []string
}

type MongodbMachineType struct {

	// cpu核数
	Cpu int

	// 配置简称  2C4G
	Description string

	// 配置分组，2m , 4m
	Group string

	// 机器类型ID o.mongo2m.medium，o.mongo2m.xlarge
	MachineTypeId string

	// 内存用量(GB)
	Memory int

	// 机器类型，N/O
	UHhostMachineType string
}

type NodeInfo struct {

	// 节点所属副本集ID
	ClusterId string

	// DB实例创建时间
	CreateTime int

	// 副本集的Mongodb的版本
	DBVersion string

	// 数据盘信息
	DataDisk DiskInfo

	// 机型信息
	MachineType string

	// 机型信息ID
	MachineTypeId string

	// 节点ID
	NodeId string

	// 节点角色，Primary/Secondary/Arbiter/Startup等等
	NodeRole string

	// 节点类型
	NodeType string

	// 副本集/分片集群状态标记 Initing：初始化中，InitFailed：安装失败，Starting：启动中，StartFailed：启动失败，Running：运行，Stopping：关闭中，Stopped：已关闭, StopFailed：关闭失败，Deleting：删除中，Deleted：已删除，DeleteFailed：删除失败，Restarting：重启中，RestartFailed：重启失败。
	State string

	// 系统盘信息
	SysDisk DiskInfo

	// 虚拟节点ID
	VirtualClusterId string

	// 可用区
	Zone string

	// 可用区ID
	ZoneId int
}

type PackageInfo struct {

	// 开始时间
	Begin int

	// 集群id
	ClusterId string

	// 创建时间
	CreateTime int

	// 结束时间
	End int

	// 完成时间
	FinishTime int

	// id
	Id int

	// 名称
	Name string

	// 节点id
	NodeId string

	// SlowLog,ErrorLog
	PackageType string

	// 角色
	Role string

	// 大小,单位字节
	Size int

	// Package_Running,Package_Success,Package_Failed,Package_Deleting,Package_Deleted,Package_DeleteFailed
	State string
}

type ReplicaInfo struct {

	// 集群ID
	ClusterId string

	// 副本集创建时间
	CreateTime int

	// 副本集删除时间
	DeleteTime int

	// 隔离组ID
	IsolationGroupId string

	// 机器类型
	MachineType string

	// 机器类型Id
	MachineTypeId string

	// 副本集修改时间
	ModifyTime int

	// 副本集下的节点数量
	NodeCount int

	// 副本集下的节点信息
	NodeInfos []NodeInfo

	// 副本集ID
	ReplicaId string

	// 副本类型,ConfigRepl或者DataRepl
	ReplicaType string

	// 副本集/分片集群状态标记 Initing：初始化中，InitFailed：安装失败，Starting：启动中，StartFailed：启动失败，Running：运行，Stopping：关闭中，Stopped：已关闭, StopFailed：关闭失败，Deleting：删除中，Deleted：已删除，DeleteFailed：删除失败，Restarting：重启中，RestartFailed：重启失败。
	State string
}

type ResizeUMongoDBInstanceRequest struct {
	request.CommonBase

	// 集群资源ID
	ClusterId *string `required:"true"`

	// 集群数据节点磁盘配置
	DiskSpace *int `required:"false"`

	// 集群数据节点机型配置
	MachineTypeId *string `required:"false"`

	// 集群Mongos节点机型配置
	MongosMachineTypeId *string `required:"false"`
}

type ResizeUMongoDBInstanceResponse struct {
	response.CommonBase
}

type RestartUMongoDBClusterRequest struct {
	request.CommonBase

	// 集群ID
	ClusterId *string `required:"true"`
}

type RestartUMongoDBClusterResponse struct {
	response.CommonBase

	// 集群ID
	ClusterId string
}

type StartUMongoDBClusterRequest struct {
	request.CommonBase

	// 集群ID
	ClusterId *string `required:"true"`
}

type StartUMongoDBClusterResponse struct {
	response.CommonBase

	// 集群ID
	ClusterId string

	// 错误信息
	Message string
}

type StopUMongoDBClusterRequest struct {
	request.CommonBase

	// 集群ID
	ClusterId *string `required:"true"`
}

type StopUMongoDBClusterResponse struct {
	response.CommonBase

	// 集群ID
	ClusterId string

	// 错误信息
	Message string
}

type UMongoDBClient struct {
	*ucloud.Client
}