Documentation
¶
Overview ¶
Package umongodb include resources of ucloud umongodb product
See also
- API: https://docs.ucloud.cn/api/umongodb-api/index
- Product: https://www.ucloud.cn/site/product/umongodb.html
for detail.
Index ¶
- type BackupInfo
- type BackupParam
- type BackupUMongoDBClusterRequest
- type BackupUMongoDBClusterResponse
- type ClusterInfo
- type ConfigOptions
- type ConfigTemplate
- type ConfigTemplateItem
- type CreateUMongoDBConfigTemplateRequest
- type CreateUMongoDBConfigTemplateResponse
- type CreateUMongoDBReplSetRequest
- type CreateUMongoDBReplSetResponse
- type CreateUMongoDBShardedClusterRequest
- type CreateUMongoDBShardedClusterResponse
- type DescribeUMongoDBBackupURLRequest
- type DescribeUMongoDBBackupURLResponse
- type DescribeUMongoDBInstanceRequest
- type DescribeUMongoDBInstanceResponse
- type DiskInfo
- type GetUMongoDBBackupParamRequest
- type GetUMongoDBBackupParamResponse
- type GetUMongoDBCfgTempItemRequest
- type GetUMongoDBCfgTempItemResponse
- type GetUMongoDBRecoverTimeRangeRequest
- type GetUMongoDBRecoverTimeRangeResponse
- type ListUMongoDBBackupRequest
- type ListUMongoDBBackupResponse
- type ListUMongoDBConfigTemplateRequest
- type ListUMongoDBConfigTemplateResponse
- type ListUMongoDBMachineTypeRequest
- type ListUMongoDBMachineTypeResponse
- type ListUMongoDBVersionRequest
- type ListUMongoDBVersionResponse
- type ModifyUMongoDBAdminPasswordRequest
- type ModifyUMongoDBAdminPasswordResponse
- type ModifyUMongoDBAttributeRequest
- type ModifyUMongoDBAttributeResponse
- type ModifyUMongoDBBackupParamRequest
- type ModifyUMongoDBBackupParamResponse
- type MongoDBVersion
- type MongodbMachineType
- type NodeInfo
- type ReplicaInfo
- type RestartUMongoDBClusterRequest
- type RestartUMongoDBClusterResponse
- type StartUMongoDBClusterRequest
- type StartUMongoDBClusterResponse
- type StopUMongoDBClusterRequest
- type StopUMongoDBClusterResponse
- type UMongoDBClient
- func (c *UMongoDBClient) BackupUMongoDBCluster(req *BackupUMongoDBClusterRequest) (*BackupUMongoDBClusterResponse, error)
- func (c *UMongoDBClient) CreateUMongoDBConfigTemplate(req *CreateUMongoDBConfigTemplateRequest) (*CreateUMongoDBConfigTemplateResponse, error)
- func (c *UMongoDBClient) CreateUMongoDBReplSet(req *CreateUMongoDBReplSetRequest) (*CreateUMongoDBReplSetResponse, error)
- func (c *UMongoDBClient) CreateUMongoDBShardedCluster(req *CreateUMongoDBShardedClusterRequest) (*CreateUMongoDBShardedClusterResponse, error)
- func (c *UMongoDBClient) DescribeUMongoDBBackupURL(req *DescribeUMongoDBBackupURLRequest) (*DescribeUMongoDBBackupURLResponse, error)
- func (c *UMongoDBClient) DescribeUMongoDBInstance(req *DescribeUMongoDBInstanceRequest) (*DescribeUMongoDBInstanceResponse, error)
- func (c *UMongoDBClient) GetUMongoDBBackupParam(req *GetUMongoDBBackupParamRequest) (*GetUMongoDBBackupParamResponse, error)
- func (c *UMongoDBClient) GetUMongoDBCfgTempItem(req *GetUMongoDBCfgTempItemRequest) (*GetUMongoDBCfgTempItemResponse, error)
- func (c *UMongoDBClient) GetUMongoDBRecoverTimeRange(req *GetUMongoDBRecoverTimeRangeRequest) (*GetUMongoDBRecoverTimeRangeResponse, error)
- func (c *UMongoDBClient) ListUMongoDBBackup(req *ListUMongoDBBackupRequest) (*ListUMongoDBBackupResponse, error)
- func (c *UMongoDBClient) ListUMongoDBConfigTemplate(req *ListUMongoDBConfigTemplateRequest) (*ListUMongoDBConfigTemplateResponse, error)
- func (c *UMongoDBClient) ListUMongoDBMachineType(req *ListUMongoDBMachineTypeRequest) (*ListUMongoDBMachineTypeResponse, error)
- func (c *UMongoDBClient) ListUMongoDBVersion(req *ListUMongoDBVersionRequest) (*ListUMongoDBVersionResponse, error)
- func (c *UMongoDBClient) ModifyUMongoDBAdminPassword(req *ModifyUMongoDBAdminPasswordRequest) (*ModifyUMongoDBAdminPasswordResponse, error)
- func (c *UMongoDBClient) ModifyUMongoDBAttribute(req *ModifyUMongoDBAttributeRequest) (*ModifyUMongoDBAttributeResponse, error)
- func (c *UMongoDBClient) ModifyUMongoDBBackupParam(req *ModifyUMongoDBBackupParamRequest) (*ModifyUMongoDBBackupParamResponse, error)
- func (c *UMongoDBClient) NewBackupUMongoDBClusterRequest() *BackupUMongoDBClusterRequest
- func (c *UMongoDBClient) NewCreateUMongoDBConfigTemplateRequest() *CreateUMongoDBConfigTemplateRequest
- func (c *UMongoDBClient) NewCreateUMongoDBReplSetRequest() *CreateUMongoDBReplSetRequest
- func (c *UMongoDBClient) NewCreateUMongoDBShardedClusterRequest() *CreateUMongoDBShardedClusterRequest
- func (c *UMongoDBClient) NewDescribeUMongoDBBackupURLRequest() *DescribeUMongoDBBackupURLRequest
- func (c *UMongoDBClient) NewDescribeUMongoDBInstanceRequest() *DescribeUMongoDBInstanceRequest
- func (c *UMongoDBClient) NewGetUMongoDBBackupParamRequest() *GetUMongoDBBackupParamRequest
- func (c *UMongoDBClient) NewGetUMongoDBCfgTempItemRequest() *GetUMongoDBCfgTempItemRequest
- func (c *UMongoDBClient) NewGetUMongoDBRecoverTimeRangeRequest() *GetUMongoDBRecoverTimeRangeRequest
- func (c *UMongoDBClient) NewListUMongoDBBackupRequest() *ListUMongoDBBackupRequest
- func (c *UMongoDBClient) NewListUMongoDBConfigTemplateRequest() *ListUMongoDBConfigTemplateRequest
- func (c *UMongoDBClient) NewListUMongoDBMachineTypeRequest() *ListUMongoDBMachineTypeRequest
- func (c *UMongoDBClient) NewListUMongoDBVersionRequest() *ListUMongoDBVersionRequest
- func (c *UMongoDBClient) NewModifyUMongoDBAdminPasswordRequest() *ModifyUMongoDBAdminPasswordRequest
- func (c *UMongoDBClient) NewModifyUMongoDBAttributeRequest() *ModifyUMongoDBAttributeRequest
- func (c *UMongoDBClient) NewModifyUMongoDBBackupParamRequest() *ModifyUMongoDBBackupParamRequest
- func (c *UMongoDBClient) NewRestartUMongoDBClusterRequest() *RestartUMongoDBClusterRequest
- func (c *UMongoDBClient) NewStartUMongoDBClusterRequest() *StartUMongoDBClusterRequest
- func (c *UMongoDBClient) NewStopUMongoDBClusterRequest() *StopUMongoDBClusterRequest
- func (c *UMongoDBClient) RestartUMongoDBCluster(req *RestartUMongoDBClusterRequest) (*RestartUMongoDBClusterResponse, error)
- func (c *UMongoDBClient) StartUMongoDBCluster(req *StartUMongoDBClusterRequest) (*StartUMongoDBClusterResponse, error)
- func (c *UMongoDBClient) StopUMongoDBCluster(req *StopUMongoDBClusterRequest) (*StopUMongoDBClusterResponse, error)
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 ClusterInfo ¶ added in v0.21.48
type ClusterInfo struct { // 集群ID ClusterId string // 集群类型,ReplicaSet :副本集,SharedCluster:分片集 ClusterType string // Config配置集群节点配置,分片集有效 ConfigMachineType string // Config配置集群节点数量,分片集有效 ConfigNodeCount int // ConfigSrv信息 ConfigReplicaInfo ReplicaInfo // 副本集的访问地址 ConnectURL string // DB实例创建时间 CreateTime int // 副本集的Mongodb的版本 DBVersion string // 数据副本信息 DataReplicaInfos []ReplicaInfo // DB实例删除时间 DeleteTime int // 磁盘空间(GB), 默认根据配置机型 DiskSpace int // 实例名称 InstanceName string // 计算规格 MachineTypeId string // Mongos节点数量,分片集有效 MongosCount int // Mongos节点信息 MongosInfo []NodeInfo // 分片数量,分片集有效 ShardCount int // 每分片节点数量,分片集有效 ShardNodeCount int // 副本集/分片集群状态标记 Initing:初始化中,InitFailed:安装失败,Starting:启动中,StartFailed:启动失败,Running:运行,Stopping:关闭中,Stopped:已关闭, StopFailed:关闭失败,Deleting:删除中,Deleted:已删除,DeleteFailed:删除失败,Restarting:重启中,RestartFailed:重启失败。 State string // 子网ID SubnetId string // 实例业务组 Tag string // VPC的ID VPCId string // 可用区 Zone string // ZoneId int }
ClusterInfo - 集群信息
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 CreateUMongoDBReplSetRequest ¶ added in v0.21.49
type CreateUMongoDBReplSetRequest 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) DiskSpace *int `required:"true"` // mongo服务端口 ListenPort *int `required:"false"` // 机型配置 MachineTypeId *string `required:"true"` // 副本集实例名称,至少6位 Name *string `required:"true"` // 副本集节点数量 NodeCount *int `required:"true"` // 购买时长,默认值1 Quantity *int `required:"false"` // 子网ID SubnetId *string `required:"false"` // 实例所在的业务组名称 Tag *string `required:"false"` // VPC的ID VPCId *string `required:"false"` }
CreateUMongoDBReplSetRequest is request schema for CreateUMongoDBReplSet action
type CreateUMongoDBReplSetResponse ¶ added in v0.21.49
type CreateUMongoDBReplSetResponse struct {
response.CommonBase
}
CreateUMongoDBReplSetResponse is response schema for CreateUMongoDBReplSet action
type CreateUMongoDBShardedClusterRequest ¶ added in v0.21.49
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) DiskSpace *int `required:"true"` // mongo服务端口 ListenPort *int `required:"false"` // 数据节点机型配置 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"` // 分片数量 ShardCount *int `required:"true"` // 子网ID SubnetId *string `required:"false"` // 实例所在的业务组名称 Tag *string `required:"false"` // 参数配置模版id TemplateId *string `required:"false"` // VPC的ID VPCId *string `required:"false"` }
CreateUMongoDBShardedClusterRequest is request schema for CreateUMongoDBShardedCluster action
type CreateUMongoDBShardedClusterResponse ¶ added in v0.21.49
type CreateUMongoDBShardedClusterResponse struct {
response.CommonBase
}
CreateUMongoDBShardedClusterResponse is response schema for CreateUMongoDBShardedCluster action
type DescribeUMongoDBBackupURLRequest ¶
type DescribeUMongoDBBackupURLRequest struct { request.CommonBase // 文件备份ID BackupId *string `required:"false"` // 集群ID ClusterId *string `required:"true"` // 打包ID PackageId *int `required:"false"` // 备份链接过期时间(单位秒) 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 DescribeUMongoDBInstanceRequest ¶ added in v0.21.48
type DescribeUMongoDBInstanceRequest struct { request.CommonBase // 实例资源ID ClusterId *string `required:"true"` // 集群类型,ReplicaSet:副本集,SharedCluster:分片集群 ClusterType *string `required:"false"` }
DescribeUMongoDBInstanceRequest is request schema for DescribeUMongoDBInstance action
type DescribeUMongoDBInstanceResponse ¶ added in v0.21.48
type DescribeUMongoDBInstanceResponse struct { response.CommonBase // 副本集信息 ClusterInfo ClusterInfo }
DescribeUMongoDBInstanceResponse is response schema for DescribeUMongoDBInstance 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 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 NodeInfo ¶ added in v0.21.48
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 }
NodeInfo - 节点信息
type ReplicaInfo ¶ added in v0.21.48
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 }
ReplicaInfo - 副本集群信息
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 ¶
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 ¶
func (c *UMongoDBClient) BackupUMongoDBCluster(req *BackupUMongoDBClusterRequest) (*BackupUMongoDBClusterResponse, error)
API: BackupUMongoDBCluster
备份集群数据库
func (*UMongoDBClient) CreateUMongoDBConfigTemplate ¶
func (c *UMongoDBClient) CreateUMongoDBConfigTemplate(req *CreateUMongoDBConfigTemplateRequest) (*CreateUMongoDBConfigTemplateResponse, error)
API: CreateUMongoDBConfigTemplate
创建配置模板
func (*UMongoDBClient) CreateUMongoDBReplSet ¶ added in v0.21.49
func (c *UMongoDBClient) CreateUMongoDBReplSet(req *CreateUMongoDBReplSetRequest) (*CreateUMongoDBReplSetResponse, error)
API: CreateUMongoDBReplSet
创建一个Mongodb副本集群
func (*UMongoDBClient) CreateUMongoDBShardedCluster ¶ added in v0.21.49
func (c *UMongoDBClient) CreateUMongoDBShardedCluster(req *CreateUMongoDBShardedClusterRequest) (*CreateUMongoDBShardedClusterResponse, error)
API: CreateUMongoDBShardedCluster
创建一个Mongodb分片集群
func (*UMongoDBClient) DescribeUMongoDBBackupURL ¶
func (c *UMongoDBClient) DescribeUMongoDBBackupURL(req *DescribeUMongoDBBackupURLRequest) (*DescribeUMongoDBBackupURLResponse, error)
API: DescribeUMongoDBBackupURL
获取实例备份下载链接
func (*UMongoDBClient) DescribeUMongoDBInstance ¶ added in v0.21.48
func (c *UMongoDBClient) DescribeUMongoDBInstance(req *DescribeUMongoDBInstanceRequest) (*DescribeUMongoDBInstanceResponse, error)
API: DescribeUMongoDBInstance
描述MongoDB实例
func (*UMongoDBClient) GetUMongoDBBackupParam ¶
func (c *UMongoDBClient) GetUMongoDBBackupParam(req *GetUMongoDBBackupParamRequest) (*GetUMongoDBBackupParamResponse, error)
API: GetUMongoDBBackupParam
获取实例备份策略
func (*UMongoDBClient) GetUMongoDBCfgTempItem ¶
func (c *UMongoDBClient) GetUMongoDBCfgTempItem(req *GetUMongoDBCfgTempItemRequest) (*GetUMongoDBCfgTempItemResponse, error)
API: GetUMongoDBCfgTempItem
获取配置模板内容
func (*UMongoDBClient) GetUMongoDBRecoverTimeRange ¶
func (c *UMongoDBClient) GetUMongoDBRecoverTimeRange(req *GetUMongoDBRecoverTimeRangeRequest) (*GetUMongoDBRecoverTimeRangeResponse, error)
API: GetUMongoDBRecoverTimeRange
获取UMongoDB可回档时间范围
func (*UMongoDBClient) ListUMongoDBBackup ¶
func (c *UMongoDBClient) ListUMongoDBBackup(req *ListUMongoDBBackupRequest) (*ListUMongoDBBackupResponse, error)
API: ListUMongoDBBackup
拉取实例备份列表
func (*UMongoDBClient) ListUMongoDBConfigTemplate ¶
func (c *UMongoDBClient) ListUMongoDBConfigTemplate(req *ListUMongoDBConfigTemplateRequest) (*ListUMongoDBConfigTemplateResponse, error)
API: ListUMongoDBConfigTemplate
拉取配置模板
func (*UMongoDBClient) ListUMongoDBMachineType ¶
func (c *UMongoDBClient) ListUMongoDBMachineType(req *ListUMongoDBMachineTypeRequest) (*ListUMongoDBMachineTypeResponse, error)
API: ListUMongoDBMachineType
获取UmongDB支持机器类型列表
func (*UMongoDBClient) ListUMongoDBVersion ¶
func (c *UMongoDBClient) ListUMongoDBVersion(req *ListUMongoDBVersionRequest) (*ListUMongoDBVersionResponse, error)
API: ListUMongoDBVersion
获取UMongoDB支持版本列表
func (*UMongoDBClient) ModifyUMongoDBAdminPassword ¶
func (c *UMongoDBClient) ModifyUMongoDBAdminPassword(req *ModifyUMongoDBAdminPasswordRequest) (*ModifyUMongoDBAdminPasswordResponse, error)
API: ModifyUMongoDBAdminPassword
修改MongoDB集群root密码
func (*UMongoDBClient) ModifyUMongoDBAttribute ¶
func (c *UMongoDBClient) ModifyUMongoDBAttribute(req *ModifyUMongoDBAttributeRequest) (*ModifyUMongoDBAttributeResponse, error)
API: ModifyUMongoDBAttribute
修改MongoDB集群名称
func (*UMongoDBClient) ModifyUMongoDBBackupParam ¶
func (c *UMongoDBClient) ModifyUMongoDBBackupParam(req *ModifyUMongoDBBackupParamRequest) (*ModifyUMongoDBBackupParamResponse, error)
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) NewCreateUMongoDBReplSetRequest ¶ added in v0.21.49
func (c *UMongoDBClient) NewCreateUMongoDBReplSetRequest() *CreateUMongoDBReplSetRequest
NewCreateUMongoDBReplSetRequest will create request of CreateUMongoDBReplSet action.
func (*UMongoDBClient) NewCreateUMongoDBShardedClusterRequest ¶ added in v0.21.49
func (c *UMongoDBClient) NewCreateUMongoDBShardedClusterRequest() *CreateUMongoDBShardedClusterRequest
NewCreateUMongoDBShardedClusterRequest will create request of CreateUMongoDBShardedCluster action.
func (*UMongoDBClient) NewDescribeUMongoDBBackupURLRequest ¶
func (c *UMongoDBClient) NewDescribeUMongoDBBackupURLRequest() *DescribeUMongoDBBackupURLRequest
NewDescribeUMongoDBBackupURLRequest will create request of DescribeUMongoDBBackupURL action.
func (*UMongoDBClient) NewDescribeUMongoDBInstanceRequest ¶ added in v0.21.48
func (c *UMongoDBClient) NewDescribeUMongoDBInstanceRequest() *DescribeUMongoDBInstanceRequest
NewDescribeUMongoDBInstanceRequest will create request of DescribeUMongoDBInstance 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 ¶
func (c *UMongoDBClient) RestartUMongoDBCluster(req *RestartUMongoDBClusterRequest) (*RestartUMongoDBClusterResponse, error)
API: RestartUMongoDBCluster
重启集群
func (*UMongoDBClient) StartUMongoDBCluster ¶
func (c *UMongoDBClient) StartUMongoDBCluster(req *StartUMongoDBClusterRequest) (*StartUMongoDBClusterResponse, error)
API: StartUMongoDBCluster
启动集群
func (*UMongoDBClient) StopUMongoDBCluster ¶
func (c *UMongoDBClient) StopUMongoDBCluster(req *StopUMongoDBClusterRequest) (*StopUMongoDBClusterResponse, error)
API: StopUMongoDBCluster
停止集群