umongodb

package
v0.21.47 Latest Latest
Warning

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

Go to latest
Published: Nov 16, 2022 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package umongodb include resources of ucloud umongodb product

See also

for detail.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BackupInfo

type BackupInfo struct {

	// 备份ID
	BackupId string

	// 备份名称
	BackupName string

	// 备份数据大小
	BackupSize int

	// 备份类型
	BackupType string

	// 实例ID
	ClusterId string

	// 备份结束时间
	EndTime int

	// 备份开始时间
	StartTime int

	// 备份状态
	State string
}

BackupInfo - 备份数据模型

type BackupParam

type BackupParam struct {

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

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

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

	// 实例ID
	ClusterId string

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

BackupParam - 备份策略模型

type BackupUMongoDBClusterRequest

type BackupUMongoDBClusterRequest struct {
	request.CommonBase

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

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

BackupUMongoDBClusterRequest is request schema for BackupUMongoDBCluster action

type BackupUMongoDBClusterResponse

type BackupUMongoDBClusterResponse struct {
	response.CommonBase

	// 备份ID
	BackupId string

	// 实例ID
	ClusterId string

	// 错误信息
	Message string
}

BackupUMongoDBClusterResponse is response schema for BackupUMongoDBCluster action

type ConfigOptions

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
}

ConfigOptions - 配置选项

type ConfigTemplate

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
}

ConfigTemplate - 配置模板

type ConfigTemplateItem

type ConfigTemplateItem struct {

	// 配置名称
	ConfigName string

	// 配置选项
	ConfigOption ConfigOptions

	// 配置值
	ConfigValue string

	// 创建时间
	CreateTime int

	// itemId
	ItemId string

	// 修改时间
	ModifyTime int

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

	// 模板ID
	TemplateId string
}

ConfigTemplateItem - 配置模板项

type CreateUMongoDBConfigTemplateRequest

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"`
}

CreateUMongoDBConfigTemplateRequest is request schema for CreateUMongoDBConfigTemplate action

type CreateUMongoDBConfigTemplateResponse

type CreateUMongoDBConfigTemplateResponse struct {
	response.CommonBase

	// 错误信息
	Message string

	// 模板Id
	TemplateId string
}

CreateUMongoDBConfigTemplateResponse is response schema for CreateUMongoDBConfigTemplate action

type DescribeUMongoDBBackupURLRequest

type DescribeUMongoDBBackupURLRequest struct {
	request.CommonBase

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

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

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

DescribeUMongoDBBackupURLRequest is request schema for DescribeUMongoDBBackupURL action

type DescribeUMongoDBBackupURLResponse

type DescribeUMongoDBBackupURLResponse struct {
	response.CommonBase

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

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

DescribeUMongoDBBackupURLResponse is response schema for DescribeUMongoDBBackupURL action

type GetUMongoDBBackupParamRequest

type GetUMongoDBBackupParamRequest struct {
	request.CommonBase

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

GetUMongoDBBackupParamRequest is request schema for GetUMongoDBBackupParam action

type GetUMongoDBBackupParamResponse

type GetUMongoDBBackupParamResponse struct {
	response.CommonBase

	// 备份策略信息
	DataSet BackupParam

	// 错误信息
	Message string
}

GetUMongoDBBackupParamResponse is response schema for GetUMongoDBBackupParam action

type GetUMongoDBCfgTempItemRequest

type GetUMongoDBCfgTempItemRequest struct {
	request.CommonBase

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

GetUMongoDBCfgTempItemRequest is request schema for GetUMongoDBCfgTempItem action

type GetUMongoDBCfgTempItemResponse

type GetUMongoDBCfgTempItemResponse struct {
	response.CommonBase

	// 配置模板项
	DataSet []ConfigTemplateItem

	// 错误信息
	Message string
}

GetUMongoDBCfgTempItemResponse is response schema for GetUMongoDBCfgTempItem action

type GetUMongoDBRecoverTimeRangeRequest

type GetUMongoDBRecoverTimeRangeRequest struct {
	request.CommonBase

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

GetUMongoDBRecoverTimeRangeRequest is request schema for GetUMongoDBRecoverTimeRange action

type GetUMongoDBRecoverTimeRangeResponse

type GetUMongoDBRecoverTimeRangeResponse struct {
	response.CommonBase

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

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

GetUMongoDBRecoverTimeRangeResponse is response schema for GetUMongoDBRecoverTimeRange action

type ListUMongoDBBackupRequest

type ListUMongoDBBackupRequest struct {
	request.CommonBase

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

ListUMongoDBBackupRequest is request schema for ListUMongoDBBackup action

type ListUMongoDBBackupResponse

type ListUMongoDBBackupResponse struct {
	response.CommonBase

	// 备份列表
	DataSet []BackupInfo

	// 错误信息
	Message string
}

ListUMongoDBBackupResponse is response schema for ListUMongoDBBackup action

type ListUMongoDBConfigTemplateRequest

type ListUMongoDBConfigTemplateRequest struct {
	request.CommonBase
}

ListUMongoDBConfigTemplateRequest is request schema for ListUMongoDBConfigTemplate action

type ListUMongoDBConfigTemplateResponse

type ListUMongoDBConfigTemplateResponse struct {
	response.CommonBase

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

	// 错误信息
	Message string
}

ListUMongoDBConfigTemplateResponse is response schema for ListUMongoDBConfigTemplate action

type ListUMongoDBMachineTypeRequest

type ListUMongoDBMachineTypeRequest struct {
	request.CommonBase
}

ListUMongoDBMachineTypeRequest is request schema for ListUMongoDBMachineType action

type ListUMongoDBMachineTypeResponse

type ListUMongoDBMachineTypeResponse struct {
	response.CommonBase

	//
	DataSet []MongodbMachineType
}

ListUMongoDBMachineTypeResponse is response schema for ListUMongoDBMachineType action

type ListUMongoDBVersionRequest

type ListUMongoDBVersionRequest struct {
	request.CommonBase
}

ListUMongoDBVersionRequest is request schema for ListUMongoDBVersion action

type ListUMongoDBVersionResponse

type ListUMongoDBVersionResponse struct {
	response.CommonBase

	//
	DataSet []MongoDBVersion
}

ListUMongoDBVersionResponse is response schema for ListUMongoDBVersion action

type ModifyUMongoDBAdminPasswordRequest

type ModifyUMongoDBAdminPasswordRequest struct {
	request.CommonBase

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

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

ModifyUMongoDBAdminPasswordRequest is request schema for ModifyUMongoDBAdminPassword action

type ModifyUMongoDBAdminPasswordResponse

type ModifyUMongoDBAdminPasswordResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

ModifyUMongoDBAdminPasswordResponse is response schema for ModifyUMongoDBAdminPassword action

type ModifyUMongoDBAttributeRequest

type ModifyUMongoDBAttributeRequest struct {
	request.CommonBase

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

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

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

ModifyUMongoDBAttributeRequest is request schema for ModifyUMongoDBAttribute action

type ModifyUMongoDBAttributeResponse

type ModifyUMongoDBAttributeResponse struct {
	response.CommonBase

	// 返回错误信息
	Message string
}

ModifyUMongoDBAttributeResponse is response schema for ModifyUMongoDBAttribute action

type ModifyUMongoDBBackupParamRequest

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"`
}

ModifyUMongoDBBackupParamRequest is request schema for ModifyUMongoDBBackupParam action

type ModifyUMongoDBBackupParamResponse

type ModifyUMongoDBBackupParamResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

ModifyUMongoDBBackupParamResponse is response schema for ModifyUMongoDBBackupParam action

type MongoDBVersion

type MongoDBVersion struct {

	// MongoDB版本
	DBVersion string
}

MongoDBVersion -

type MongodbMachineType

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
}

MongodbMachineType -

type RestartUMongoDBClusterRequest

type RestartUMongoDBClusterRequest struct {
	request.CommonBase

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

RestartUMongoDBClusterRequest is request schema for RestartUMongoDBCluster action

type RestartUMongoDBClusterResponse

type RestartUMongoDBClusterResponse struct {
	response.CommonBase

	// 集群ID
	ClusterId string
}

RestartUMongoDBClusterResponse is response schema for RestartUMongoDBCluster action

type StartUMongoDBClusterRequest

type StartUMongoDBClusterRequest struct {
	request.CommonBase

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

StartUMongoDBClusterRequest is request schema for StartUMongoDBCluster action

type StartUMongoDBClusterResponse

type StartUMongoDBClusterResponse struct {
	response.CommonBase

	// 集群ID
	ClusterId string

	// 错误信息
	Message string
}

StartUMongoDBClusterResponse is response schema for StartUMongoDBCluster action

type StopUMongoDBClusterRequest

type StopUMongoDBClusterRequest struct {
	request.CommonBase

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

StopUMongoDBClusterRequest is request schema for StopUMongoDBCluster action

type StopUMongoDBClusterResponse

type StopUMongoDBClusterResponse struct {
	response.CommonBase

	// 集群ID
	ClusterId string

	// 错误信息
	Message string
}

StopUMongoDBClusterResponse is response schema for StopUMongoDBCluster action

type UMongoDBClient

type UMongoDBClient struct {
	*ucloud.Client
}

UMongoDBClient is the client of UMongoDB

func NewClient

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

NewClient will return a instance of UMongoDBClient

func (*UMongoDBClient) BackupUMongoDBCluster

API: BackupUMongoDBCluster

备份集群数据库

func (*UMongoDBClient) CreateUMongoDBConfigTemplate

API: CreateUMongoDBConfigTemplate

创建配置模板

func (*UMongoDBClient) DescribeUMongoDBBackupURL

API: DescribeUMongoDBBackupURL

获取实例备份下载链接

func (*UMongoDBClient) GetUMongoDBBackupParam

API: GetUMongoDBBackupParam

获取实例备份策略

func (*UMongoDBClient) GetUMongoDBCfgTempItem

API: GetUMongoDBCfgTempItem

获取配置模板内容

func (*UMongoDBClient) GetUMongoDBRecoverTimeRange

API: GetUMongoDBRecoverTimeRange

获取UMongoDB可回档时间范围

func (*UMongoDBClient) ListUMongoDBBackup

API: ListUMongoDBBackup

拉取实例备份列表

func (*UMongoDBClient) ListUMongoDBConfigTemplate

API: ListUMongoDBConfigTemplate

拉取配置模板

func (*UMongoDBClient) ListUMongoDBMachineType

API: ListUMongoDBMachineType

获取UmongDB支持机器类型列表

func (*UMongoDBClient) ListUMongoDBVersion

API: ListUMongoDBVersion

获取UMongoDB支持版本列表

func (*UMongoDBClient) ModifyUMongoDBAdminPassword

API: ModifyUMongoDBAdminPassword

修改MongoDB集群root密码

func (*UMongoDBClient) ModifyUMongoDBAttribute

API: ModifyUMongoDBAttribute

修改MongoDB集群名称

func (*UMongoDBClient) ModifyUMongoDBBackupParam

API: ModifyUMongoDBBackupParam

修改实例备份策略

func (*UMongoDBClient) NewBackupUMongoDBClusterRequest

func (c *UMongoDBClient) NewBackupUMongoDBClusterRequest() *BackupUMongoDBClusterRequest

NewBackupUMongoDBClusterRequest will create request of BackupUMongoDBCluster action.

func (*UMongoDBClient) NewCreateUMongoDBConfigTemplateRequest

func (c *UMongoDBClient) NewCreateUMongoDBConfigTemplateRequest() *CreateUMongoDBConfigTemplateRequest

NewCreateUMongoDBConfigTemplateRequest will create request of CreateUMongoDBConfigTemplate action.

func (*UMongoDBClient) NewDescribeUMongoDBBackupURLRequest

func (c *UMongoDBClient) NewDescribeUMongoDBBackupURLRequest() *DescribeUMongoDBBackupURLRequest

NewDescribeUMongoDBBackupURLRequest will create request of DescribeUMongoDBBackupURL action.

func (*UMongoDBClient) NewGetUMongoDBBackupParamRequest

func (c *UMongoDBClient) NewGetUMongoDBBackupParamRequest() *GetUMongoDBBackupParamRequest

NewGetUMongoDBBackupParamRequest will create request of GetUMongoDBBackupParam action.

func (*UMongoDBClient) NewGetUMongoDBCfgTempItemRequest

func (c *UMongoDBClient) NewGetUMongoDBCfgTempItemRequest() *GetUMongoDBCfgTempItemRequest

NewGetUMongoDBCfgTempItemRequest will create request of GetUMongoDBCfgTempItem action.

func (*UMongoDBClient) NewGetUMongoDBRecoverTimeRangeRequest

func (c *UMongoDBClient) NewGetUMongoDBRecoverTimeRangeRequest() *GetUMongoDBRecoverTimeRangeRequest

NewGetUMongoDBRecoverTimeRangeRequest will create request of GetUMongoDBRecoverTimeRange action.

func (*UMongoDBClient) NewListUMongoDBBackupRequest

func (c *UMongoDBClient) NewListUMongoDBBackupRequest() *ListUMongoDBBackupRequest

NewListUMongoDBBackupRequest will create request of ListUMongoDBBackup action.

func (*UMongoDBClient) NewListUMongoDBConfigTemplateRequest

func (c *UMongoDBClient) NewListUMongoDBConfigTemplateRequest() *ListUMongoDBConfigTemplateRequest

NewListUMongoDBConfigTemplateRequest will create request of ListUMongoDBConfigTemplate action.

func (*UMongoDBClient) NewListUMongoDBMachineTypeRequest

func (c *UMongoDBClient) NewListUMongoDBMachineTypeRequest() *ListUMongoDBMachineTypeRequest

NewListUMongoDBMachineTypeRequest will create request of ListUMongoDBMachineType action.

func (*UMongoDBClient) NewListUMongoDBVersionRequest

func (c *UMongoDBClient) NewListUMongoDBVersionRequest() *ListUMongoDBVersionRequest

NewListUMongoDBVersionRequest will create request of ListUMongoDBVersion action.

func (*UMongoDBClient) NewModifyUMongoDBAdminPasswordRequest

func (c *UMongoDBClient) NewModifyUMongoDBAdminPasswordRequest() *ModifyUMongoDBAdminPasswordRequest

NewModifyUMongoDBAdminPasswordRequest will create request of ModifyUMongoDBAdminPassword action.

func (*UMongoDBClient) NewModifyUMongoDBAttributeRequest

func (c *UMongoDBClient) NewModifyUMongoDBAttributeRequest() *ModifyUMongoDBAttributeRequest

NewModifyUMongoDBAttributeRequest will create request of ModifyUMongoDBAttribute action.

func (*UMongoDBClient) NewModifyUMongoDBBackupParamRequest

func (c *UMongoDBClient) NewModifyUMongoDBBackupParamRequest() *ModifyUMongoDBBackupParamRequest

NewModifyUMongoDBBackupParamRequest will create request of ModifyUMongoDBBackupParam action.

func (*UMongoDBClient) NewRestartUMongoDBClusterRequest

func (c *UMongoDBClient) NewRestartUMongoDBClusterRequest() *RestartUMongoDBClusterRequest

NewRestartUMongoDBClusterRequest will create request of RestartUMongoDBCluster action.

func (*UMongoDBClient) NewStartUMongoDBClusterRequest

func (c *UMongoDBClient) NewStartUMongoDBClusterRequest() *StartUMongoDBClusterRequest

NewStartUMongoDBClusterRequest will create request of StartUMongoDBCluster action.

func (*UMongoDBClient) NewStopUMongoDBClusterRequest

func (c *UMongoDBClient) NewStopUMongoDBClusterRequest() *StopUMongoDBClusterRequest

NewStopUMongoDBClusterRequest will create request of StopUMongoDBCluster action.

func (*UMongoDBClient) RestartUMongoDBCluster

API: RestartUMongoDBCluster

重启集群

func (*UMongoDBClient) StartUMongoDBCluster

API: StartUMongoDBCluster

启动集群

func (*UMongoDBClient) StopUMongoDBCluster

API: StopUMongoDBCluster

停止集群

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL