 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- Constants
- type Client
- func (c *Client) CreateDBInstance(request *CreateDBInstanceRequest) (response *CreateDBInstanceResponse, err error)
- func (c *Client) CreateDBInstanceHour(request *CreateDBInstanceHourRequest) (response *CreateDBInstanceHourResponse, err error)
- func (c *Client) TerminateDBInstance(request *TerminateDBInstanceRequest) (response *TerminateDBInstanceResponse, err error)
- func (c *Client) UpgradeDBInstance(request *UpgradeDBInstanceRequest) (response *UpgradeDBInstanceResponse, err error)
- func (c *Client) UpgradeDBInstanceHour(request *UpgradeDBInstanceHourRequest) (response *UpgradeDBInstanceHourResponse, err error)
 
- type CreateDBInstanceHourRequest
- type CreateDBInstanceHourResponse
- type CreateDBInstanceRequest
- type CreateDBInstanceResponse
- type TerminateDBInstanceRequest
- type TerminateDBInstanceResponse
- type UpgradeDBInstanceHourRequest
- type UpgradeDBInstanceHourResponse
- type UpgradeDBInstanceRequest
- type UpgradeDBInstanceResponse
Constants ¶
      View Source
      
  
const APIVersion = "2018-04-08"
    Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
func NewClient ¶
func NewClient(credential *common.Credential, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) CreateDBInstance ¶
func (c *Client) CreateDBInstance(request *CreateDBInstanceRequest) (response *CreateDBInstanceResponse, err error)
本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。
func (*Client) CreateDBInstanceHour ¶
func (c *Client) CreateDBInstanceHour(request *CreateDBInstanceHourRequest) (response *CreateDBInstanceHourResponse, err error)
本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例(包括主实例、灾备实例和只读实例),可通过传入实例规格、实例类型、MongoDB版本、购买时长和数量等信息创建云数据库实例。
func (*Client) TerminateDBInstance ¶
func (c *Client) TerminateDBInstance(request *TerminateDBInstanceRequest) (response *TerminateDBInstanceResponse, err error)
本接口(TerminateDBInstance)用于销毁按量计费的MongoDB云数据库实例
func (*Client) UpgradeDBInstance ¶
func (c *Client) UpgradeDBInstance(request *UpgradeDBInstanceRequest) (response *UpgradeDBInstanceResponse, err error)
本接口(UpgradeDBInstance)用于升级包年包月的MongoDB云数据库实例,可以扩容内存、存储以及Oplog
func (*Client) UpgradeDBInstanceHour ¶
func (c *Client) UpgradeDBInstanceHour(request *UpgradeDBInstanceHourRequest) (response *UpgradeDBInstanceHourResponse, err error)
本接口(UpgradeDBInstanceHour)用于升级按量计费的MongoDB云数据库实例,可以扩容内存、存储以及oplog
type CreateDBInstanceHourRequest ¶
type CreateDBInstanceHourRequest struct {
	*tchttp.BaseRequest
	// 实例内存大小,单位:GB
	Memory *uint64 `json:"Memory" name:"Memory"`
	// 实例硬盘大小,单位:GB
	Volume *uint64 `json:"Volume" name:"Volume"`
	// 副本集个数,1为单副本集实例,大于1为分片集群实例,最大不超过10
	ReplicateSetNum *uint64 `json:"ReplicateSetNum" name:"ReplicateSetNum"`
	// 每个副本集内从节点个数,目前只支持从节点数为2
	SecondaryNum *uint64 `json:"SecondaryNum" name:"SecondaryNum"`
	// MongoDB引擎版本,值包括:MONGO_2、MONGO_3_MMAP、MONGO_3_WT 、MONGO_3_ROCKS和MONGO_36_WT
	EngineVersion *string `json:"EngineVersion" name:"EngineVersion"`
	// 实例类型,GIO:高IO版;TGIO:高IO万兆
	Machine *string `json:"Machine" name:"Machine"`
	// 实例数量,默认值为1, 最小值1,最大值为10
	GoodsNum *uint64 `json:"GoodsNum" name:"GoodsNum"`
	// 可用区信息,格式如:ap-guangzhou-2
	Zone *string `json:"Zone" name:"Zone"`
	// 实例角色,支持值包括:MASTER-表示主实例,DR-表示灾备实例,RO-表示只读实例
	InstanceRole *string `json:"InstanceRole" name:"InstanceRole"`
	// 实例类型,REPLSET-副本集,SHARD-分片集群
	InstanceType *string `json:"InstanceType" name:"InstanceType"`
	// 数据是否加密,当且仅当引擎版本为MONGO_3_ROCKS,可以选择加密
	Encrypt *uint64 `json:"Encrypt" name:"Encrypt"`
	// 私有网络ID,如果不传则默认选择基础网络
	VpcId *string `json:"VpcId" name:"VpcId"`
	// 私有网络下的子网ID,如果设置了 VpcId,则 SubnetId必填
	SubnetId *string `json:"SubnetId" name:"SubnetId"`
	// 项目ID,不填为默认项目
	ProjectId *int64 `json:"ProjectId" name:"ProjectId"`
	// 安全组参数
	SecurityGroup []*string `json:"SecurityGroup" name:"SecurityGroup" list`
}
    func NewCreateDBInstanceHourRequest ¶
func NewCreateDBInstanceHourRequest() (request *CreateDBInstanceHourRequest)
func (*CreateDBInstanceHourRequest) FromJsonString ¶
func (r *CreateDBInstanceHourRequest) FromJsonString(s string) error
func (*CreateDBInstanceHourRequest) ToJsonString ¶
func (r *CreateDBInstanceHourRequest) ToJsonString() string
type CreateDBInstanceHourResponse ¶
type CreateDBInstanceHourResponse struct {
	*tchttp.BaseResponse
	Response *struct {
		// 订单ID
		DealId *string `json:"DealId" name:"DealId"`
		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId" name:"RequestId"`
	} `json:"Response"`
}
    func NewCreateDBInstanceHourResponse ¶
func NewCreateDBInstanceHourResponse() (response *CreateDBInstanceHourResponse)
func (*CreateDBInstanceHourResponse) FromJsonString ¶
func (r *CreateDBInstanceHourResponse) FromJsonString(s string) error
func (*CreateDBInstanceHourResponse) ToJsonString ¶
func (r *CreateDBInstanceHourResponse) ToJsonString() string
type CreateDBInstanceRequest ¶
type CreateDBInstanceRequest struct {
	*tchttp.BaseRequest
	// 每个副本集内从节点个数
	SecondaryNum *uint64 `json:"SecondaryNum" name:"SecondaryNum"`
	// 实例内存大小,单位:GB
	Memory *uint64 `json:"Memory" name:"Memory"`
	// 实例硬盘大小,单位:GB
	Volume *uint64 `json:"Volume" name:"Volume"`
	// 版本号,当前仅支持 MONGO_3_WT
	MongoVersion *string `json:"MongoVersion" name:"MongoVersion"`
	// 机器类型,GIO:高IO版;TGIO:高IO万兆
	MachineCode *string `json:"MachineCode" name:"MachineCode"`
	// 实例数量,默认值为1, 最小值1,最大值为10
	GoodsNum *uint64 `json:"GoodsNum" name:"GoodsNum"`
	// 实例所属区域名称,格式如:ap-guangzhou-2
	Zone *string `json:"Zone" name:"Zone"`
	// 时长,购买月数
	TimeSpan *uint64 `json:"TimeSpan" name:"TimeSpan"`
	// 实例密码
	Password *string `json:"Password" name:"Password"`
	// 项目ID,不填为默认项目
	ProjectId *uint64 `json:"ProjectId" name:"ProjectId"`
	// 安全组参数
	SecurityGroup []*string `json:"SecurityGroup" name:"SecurityGroup" list`
	// 私有网络ID,如果不传则默认选择基础网络
	UniqVpcId *string `json:"UniqVpcId" name:"UniqVpcId"`
	// 私有网络下的子网ID,如果设置了 VpcId,则 SubnetId必填
	UniqSubnetId *string `json:"UniqSubnetId" name:"UniqSubnetId"`
}
    func NewCreateDBInstanceRequest ¶
func NewCreateDBInstanceRequest() (request *CreateDBInstanceRequest)
func (*CreateDBInstanceRequest) FromJsonString ¶
func (r *CreateDBInstanceRequest) FromJsonString(s string) error
func (*CreateDBInstanceRequest) ToJsonString ¶
func (r *CreateDBInstanceRequest) ToJsonString() string
type CreateDBInstanceResponse ¶
type CreateDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {
		// 订单ID
		DealId *string `json:"DealId" name:"DealId"`
		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId" name:"RequestId"`
	} `json:"Response"`
}
    func NewCreateDBInstanceResponse ¶
func NewCreateDBInstanceResponse() (response *CreateDBInstanceResponse)
func (*CreateDBInstanceResponse) FromJsonString ¶
func (r *CreateDBInstanceResponse) FromJsonString(s string) error
func (*CreateDBInstanceResponse) ToJsonString ¶
func (r *CreateDBInstanceResponse) ToJsonString() string
type TerminateDBInstanceRequest ¶
type TerminateDBInstanceRequest struct {
	*tchttp.BaseRequest
	// 实例ID,格式如:cmgo-p8vnipr5。
	InstanceId *string `json:"InstanceId" name:"InstanceId"`
}
    func NewTerminateDBInstanceRequest ¶
func NewTerminateDBInstanceRequest() (request *TerminateDBInstanceRequest)
func (*TerminateDBInstanceRequest) FromJsonString ¶
func (r *TerminateDBInstanceRequest) FromJsonString(s string) error
func (*TerminateDBInstanceRequest) ToJsonString ¶
func (r *TerminateDBInstanceRequest) ToJsonString() string
type TerminateDBInstanceResponse ¶
type TerminateDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {
		// 订单ID,表示注销实例成功
		AsyncRequestId *string `json:"AsyncRequestId" name:"AsyncRequestId"`
		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId" name:"RequestId"`
	} `json:"Response"`
}
    func NewTerminateDBInstanceResponse ¶
func NewTerminateDBInstanceResponse() (response *TerminateDBInstanceResponse)
func (*TerminateDBInstanceResponse) FromJsonString ¶
func (r *TerminateDBInstanceResponse) FromJsonString(s string) error
func (*TerminateDBInstanceResponse) ToJsonString ¶
func (r *TerminateDBInstanceResponse) ToJsonString() string
type UpgradeDBInstanceHourRequest ¶
type UpgradeDBInstanceHourRequest struct {
	*tchttp.BaseRequest
	// 实例ID,格式如:cmgo-p8vnipr5
	InstanceId *string `json:"InstanceId" name:"InstanceId"`
	// 升级后的内存大小,单位:GB
	Memory *uint64 `json:"Memory" name:"Memory"`
	// 升级后的硬盘大小,单位:GB
	Volume *uint64 `json:"Volume" name:"Volume"`
	// 升级后oplog的大小,单位:GB,默认为磁盘空间的10%,允许设置的最小值为磁盘的10%,最大值为磁盘的90%
	OplogSize *uint64 `json:"OplogSize" name:"OplogSize"`
}
    func NewUpgradeDBInstanceHourRequest ¶
func NewUpgradeDBInstanceHourRequest() (request *UpgradeDBInstanceHourRequest)
func (*UpgradeDBInstanceHourRequest) FromJsonString ¶
func (r *UpgradeDBInstanceHourRequest) FromJsonString(s string) error
func (*UpgradeDBInstanceHourRequest) ToJsonString ¶
func (r *UpgradeDBInstanceHourRequest) ToJsonString() string
type UpgradeDBInstanceHourResponse ¶
type UpgradeDBInstanceHourResponse struct {
	*tchttp.BaseResponse
	Response *struct {
		// 订单ID
		DealId *string `json:"DealId" name:"DealId"`
		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId" name:"RequestId"`
	} `json:"Response"`
}
    func NewUpgradeDBInstanceHourResponse ¶
func NewUpgradeDBInstanceHourResponse() (response *UpgradeDBInstanceHourResponse)
func (*UpgradeDBInstanceHourResponse) FromJsonString ¶
func (r *UpgradeDBInstanceHourResponse) FromJsonString(s string) error
func (*UpgradeDBInstanceHourResponse) ToJsonString ¶
func (r *UpgradeDBInstanceHourResponse) ToJsonString() string
type UpgradeDBInstanceRequest ¶
type UpgradeDBInstanceRequest struct {
	*tchttp.BaseRequest
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId" name:"InstanceId"`
	// 升级后的内存大小,单位:GB
	Memory *uint64 `json:"Memory" name:"Memory"`
	// 升级后的硬盘大小,单位:GB
	Volume *uint64 `json:"Volume" name:"Volume"`
	// 升级后oplog的大小,单位:GB,默认为磁盘空间的10%,允许设置的最小值为磁盘的10%,最大值为磁盘的90%
	OplogSize *uint64 `json:"OplogSize" name:"OplogSize"`
}
    func NewUpgradeDBInstanceRequest ¶
func NewUpgradeDBInstanceRequest() (request *UpgradeDBInstanceRequest)
func (*UpgradeDBInstanceRequest) FromJsonString ¶
func (r *UpgradeDBInstanceRequest) FromJsonString(s string) error
func (*UpgradeDBInstanceRequest) ToJsonString ¶
func (r *UpgradeDBInstanceRequest) ToJsonString() string
type UpgradeDBInstanceResponse ¶
type UpgradeDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {
		// 订单ID
		DealId *string `json:"DealId" name:"DealId"`
		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId" name:"RequestId"`
	} `json:"Response"`
}
    func NewUpgradeDBInstanceResponse ¶
func NewUpgradeDBInstanceResponse() (response *UpgradeDBInstanceResponse)
func (*UpgradeDBInstanceResponse) FromJsonString ¶
func (r *UpgradeDBInstanceResponse) FromJsonString(s string) error
func (*UpgradeDBInstanceResponse) ToJsonString ¶
func (r *UpgradeDBInstanceResponse) ToJsonString() string
 Click to show internal directories. 
   Click to hide internal directories.