udb

Documentation

Index

• type ChangeUDBParamGroupRequest
• type ChangeUDBParamGroupResponse
• type CheckUDBInstanceAllowanceRequest
• type CheckUDBInstanceAllowanceResponse
• type DescribeUDBInstanceByParamGroupRequest
• type DescribeUDBInstanceByParamGroupResponse
• type ExtractUDBParamGroupRequest
• type ExtractUDBParamGroupResponse
• type UDBClient
  • func NewClient(config *ucloud.Config, credential *auth.Credential) *UDBClient
  • func (c *UDBClient) ChangeUDBParamGroup(req *ChangeUDBParamGroupRequest) (*ChangeUDBParamGroupResponse, error)
  • func (c *UDBClient) CheckUDBInstanceAllowance(req *CheckUDBInstanceAllowanceRequest) (*CheckUDBInstanceAllowanceResponse, error)
  • func (c *UDBClient) DescribeUDBInstanceByParamGroup(req *DescribeUDBInstanceByParamGroupRequest) (*DescribeUDBInstanceByParamGroupResponse, error)
  • func (c *UDBClient) ExtractUDBParamGroup(req *ExtractUDBParamGroupRequest) (*ExtractUDBParamGroupResponse, error)
  • func (c *UDBClient) NewChangeUDBParamGroupRequest() *ChangeUDBParamGroupRequest
  • func (c *UDBClient) NewCheckUDBInstanceAllowanceRequest() *CheckUDBInstanceAllowanceRequest
  • func (c *UDBClient) NewDescribeUDBInstanceByParamGroupRequest() *DescribeUDBInstanceByParamGroupRequest
  • func (c *UDBClient) NewExtractUDBParamGroupRequest() *ExtractUDBParamGroupRequest
• type UDBInstanceByParamGroup

Types

type ChangeUDBParamGroupRequest

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

type ChangeUDBParamGroupResponse struct {
	response.CommonBase
}

ChangeUDBParamGroupResponse is response schema for ChangeUDBParamGroup action

type CheckUDBInstanceAllowanceRequest

type CheckUDBInstanceAllowanceRequest struct {
	request.CommonBase

	// DB种类，分为SQL和NOSQL,取值分别为sql、nosql、postgresql
	ClassType *string `required:"true"`

	// 申请资源的内存限制
	MemoryLimit *int `required:"true"`

	// 申请资源的磁盘空间
	DiskSpace *int `required:"true"`

	// 是否使用SSD资源，true代表使用，false代表不使用
	UseSSD *bool `required:"true"`

	// 资源申请个数,默认为一个
	Count *int `required:"true"`

	// UDB实例的部署模式：可选值为：Normal: 普通单点实例，HA: 高可用部署实例
	InstanceMode *string `required:"true"`

	// SSD类型，可选值为"SATA"、"PCI-E"，如果UseSSD为true ，则需要指定SSD类型
	SSDType *string `required:"false"`

	// 如果是从库创建核查，需要指定SrcId
	SrcId *string `required:"false"`

	// 跨可用区备库所在可用区, 参见 [可用区列表](../summary/regionlist.html)
	BackupZone *string `required:"false"`

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

	// 专区里面DB升降级需要原来DB的信息
	DBId *string `required:"false"`
}

CheckUDBInstanceAllowanceRequest is request schema for CheckUDBInstanceAllowance action

type CheckUDBInstanceAllowanceResponse

type CheckUDBInstanceAllowanceResponse struct {
	response.CommonBase

	// 资源核查部分成功情况下，成功个数
	Count int
}

CheckUDBInstanceAllowanceResponse is response schema for CheckUDBInstanceAllowance action

type DescribeUDBInstanceByParamGroupRequest

type DescribeUDBInstanceByParamGroupRequest struct {
	request.CommonBase

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

	// 是否是跨可用区的配置文件
	RegionFlag *string `required:"false"`
}

DescribeUDBInstanceByParamGroupRequest is request schema for DescribeUDBInstanceByParamGroup action

type DescribeUDBInstanceByParamGroupResponse

type DescribeUDBInstanceByParamGroupResponse struct {
	response.CommonBase

	// DB实例信息列表
	DataSet []UDBInstanceByParamGroup
}

DescribeUDBInstanceByParamGroupResponse is response schema for DescribeUDBInstanceByParamGroup action

type ExtractUDBParamGroupRequest

type ExtractUDBParamGroupRequest struct {
	request.CommonBase

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

	// 是否跨可用区，RegionFlag为true时表示跨可用区配置文件
	RegionFlag *bool `required:"false"`
}

ExtractUDBParamGroupRequest is request schema for ExtractUDBParamGroup action

type ExtractUDBParamGroupResponse

type ExtractUDBParamGroupResponse struct {
	response.CommonBase

	// 配置文件内容
	Content string
}

ExtractUDBParamGroupResponse is response schema for ExtractUDBParamGroup action

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) ChangeUDBParamGroup

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

ChangeUDBParamGroup - 修改配置文件

func (*UDBClient) CheckUDBInstanceAllowance

func (c *UDBClient) CheckUDBInstanceAllowance(req *CheckUDBInstanceAllowanceRequest) (*CheckUDBInstanceAllowanceResponse, error)

CheckUDBInstanceAllowance - 核查UDB资源余量

func (*UDBClient) DescribeUDBInstanceByParamGroup

func (c *UDBClient) DescribeUDBInstanceByParamGroup(req *DescribeUDBInstanceByParamGroupRequest) (*DescribeUDBInstanceByParamGroupResponse, error)

DescribeUDBInstanceByParamGroup - 根据配置文件获取UDB实例信息

func (*UDBClient) ExtractUDBParamGroup

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

ExtractUDBParamGroup - 获取配置文件内容

func (*UDBClient) NewChangeUDBParamGroupRequest

func (c *UDBClient) NewChangeUDBParamGroupRequest() *ChangeUDBParamGroupRequest

NewChangeUDBParamGroupRequest will create request of ChangeUDBParamGroup action.

func (*UDBClient) NewCheckUDBInstanceAllowanceRequest

func (c *UDBClient) NewCheckUDBInstanceAllowanceRequest() *CheckUDBInstanceAllowanceRequest

NewCheckUDBInstanceAllowanceRequest will create request of CheckUDBInstanceAllowance action.

func (*UDBClient) NewDescribeUDBInstanceByParamGroupRequest

func (c *UDBClient) NewDescribeUDBInstanceByParamGroupRequest() *DescribeUDBInstanceByParamGroupRequest

NewDescribeUDBInstanceByParamGroupRequest will create request of DescribeUDBInstanceByParamGroup action.

func (*UDBClient) NewExtractUDBParamGroupRequest

func (c *UDBClient) NewExtractUDBParamGroupRequest() *ExtractUDBParamGroupRequest

NewExtractUDBParamGroupRequest will create request of ExtractUDBParamGroup action.

type UDBInstanceByParamGroup

type UDBInstanceByParamGroup struct {

	// DB实例Id
	DBId string

	// 实例名称
	Name string

	// DB实例虚ip
	VirtualIP string

	// 端口号
	Port string

	// DB状态标记
	State string

	// DB实例创建时间
	CreateTime string

	// DB实例过期时间
	ExpiredTime string

	// DB实例角色
	Role string
}

UDBInstanceByParamGroup - DescribeUDBInstanceByParamGroup

this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn for detail.