Documentation
¶
Overview ¶
Package uclickhouse include resources of ucloud uclickhouse product
See also
- API: https://docs.ucloud.cn/api/uclickhouse-api/index
- Product: https://www.ucloud.cn/site/product/uclickhouse.html
for detail.
Index ¶
- type ClickhouseCluster
- type ClickhouseDataDisk
- type ClickhouseMachineType
- type ClickhouseMachineTypeOption
- type ClickhouseNode
- type ClickhouseVersion
- type CreateUClickhouseClusterParamLabels
- type CreateUClickhouseClusterRequest
- type CreateUClickhouseClusterResponse
- type CreateUClickhouseClusterResponseData
- type DescribeUClickhouseClusterRequest
- type DescribeUClickhouseClusterResponse
- type DescribeUClickhouseClusterResponseData
- type DestroyUClickhouseClusterRequest
- type DestroyUClickhouseClusterResponse
- type ExpandUClickhouseClusterRequest
- type ExpandUClickhouseClusterResponse
- type GetCreateUClickhouseClusterOptionResponseData
- type GetUClickhouseClusterCreateOptionRequest
- type GetUClickhouseClusterCreateOptionResponse
- type ListUClickhouseClusterRequest
- type ListUClickhouseClusterResponse
- type ListUClickhouseClusterResponseData
- type Payment
- type ResizeUClickhouseClusterRequest
- type ResizeUClickhouseClusterResponse
- type RestartUClickhouseClusterServiceRequest
- type RestartUClickhouseClusterServiceResponse
- type UClickhouseClient
- func (c *UClickhouseClient) CreateUClickhouseCluster(req *CreateUClickhouseClusterRequest) (*CreateUClickhouseClusterResponse, error)
- func (c *UClickhouseClient) DescribeUClickhouseCluster(req *DescribeUClickhouseClusterRequest) (*DescribeUClickhouseClusterResponse, error)
- func (c *UClickhouseClient) DestroyUClickhouseCluster(req *DestroyUClickhouseClusterRequest) (*DestroyUClickhouseClusterResponse, error)
- func (c *UClickhouseClient) ExpandUClickhouseCluster(req *ExpandUClickhouseClusterRequest) (*ExpandUClickhouseClusterResponse, error)
- func (c *UClickhouseClient) GetUClickhouseClusterCreateOption(req *GetUClickhouseClusterCreateOptionRequest) (*GetUClickhouseClusterCreateOptionResponse, error)
- func (c *UClickhouseClient) ListUClickhouseCluster(req *ListUClickhouseClusterRequest) (*ListUClickhouseClusterResponse, error)
- func (c *UClickhouseClient) NewCreateUClickhouseClusterRequest() *CreateUClickhouseClusterRequest
- func (c *UClickhouseClient) NewDescribeUClickhouseClusterRequest() *DescribeUClickhouseClusterRequest
- func (c *UClickhouseClient) NewDestroyUClickhouseClusterRequest() *DestroyUClickhouseClusterRequest
- func (c *UClickhouseClient) NewExpandUClickhouseClusterRequest() *ExpandUClickhouseClusterRequest
- func (c *UClickhouseClient) NewGetUClickhouseClusterCreateOptionRequest() *GetUClickhouseClusterCreateOptionRequest
- func (c *UClickhouseClient) NewListUClickhouseClusterRequest() *ListUClickhouseClusterRequest
- func (c *UClickhouseClient) NewResizeUClickhouseClusterRequest() *ResizeUClickhouseClusterRequest
- func (c *UClickhouseClient) NewRestartUClickhouseClusterServiceRequest() *RestartUClickhouseClusterServiceRequest
- func (c *UClickhouseClient) ResizeUClickhouseCluster(req *ResizeUClickhouseClusterRequest) (*ResizeUClickhouseClusterResponse, error)
- func (c *UClickhouseClient) RestartUClickhouseClusterService(req *RestartUClickhouseClusterServiceRequest) (*RestartUClickhouseClusterServiceResponse, error)
- type ZookeeperNode
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClickhouseCluster ¶
type ClickhouseCluster struct {
// Clickhouse数据盘大小
ClickhouseDataDiskSize int
// Clickhouse数据盘类型
ClickhouseDataDiskType string
// Clickhouse机型ID
ClickhouseMachineTypeId string
// Clickhouse机型名称
ClickhouseMachineTypeName string
// Clickhouse节点CPU
ClickhouseNodeCPU int
// Clickhouse内存
ClickhouseNodeMemory int
// 集群版本
ClickhouseVersion string
// 集群ID
ClusterId string
// 集群名称
ClusterName string
// 集群创建时间
CreateTimestamp int
// 实例过期时间
ExpireTimestamp float64
// 实例是否开启备份
IsBackup string
// 实例是否开启安全组
IsSecgroup string
// 实例是否开启冷热分层
IsTieredStorage string
// Zookeeper是否高可用
IsZookeeperHA string
// 机型
MachineType string
// 实例所在可用区
MultiZones []string
// 项目ID
OrganizationId int
// 地域ID
RegionId int
// 副本数
ReplicateCount int
// 分片数
ShardCount int
// 集群状态:CREATING(创建中)、RUNNING(运行中)、RESIZING(变配中)、RESTARTING(重启中)、UPGRADING(升级中)、DESTROYING(销毁中)、DESTROYED(已删除)、CREATE_FAILED(创建失败)、RESTART_FAILED(重启失败)、DESTROY_FAILED(删除失败)、RESIZE_FAILED(变配失败)、BACKUP_RESTORING(备份恢复中)、BACKUP_RESTORE_FAILED(备份恢复失败)、EXPANDING(扩容中)、EXPAND_FAILED(扩容失败)
Status string
// 子网ID
SubnetId string
// 公司ID
TopOrganizationId int
// VPCID
VPCId string
// Zookeeper数据盘大小
ZookeeperDataDiskSize int
// Zookeeper数据盘类型
ZookeeperDataDiskType string
// Zookeeper机型ID
ZookeeperMachineTypeId string
// Zookeeper机型名称
ZookeeperMachineTypeName string
// Zookeeper节点CPU
ZookeeperNodeCPU int
// Zookeeper节点内存
ZookeeperNodeMemory int
// Zookeeper版本
ZookeeperVersion string
}
ClickhouseCluster -
type ClickhouseDataDisk ¶
type ClickhouseDataDisk struct {
// 默认大小,GB
DefaultDataDiskSize int
// 磁盘类型
DiskType string
// 最大值,GB
MaxDiskSize int
// 最小值,GB
MinDiskSize int
// 步长,GB
Step int
}
ClickhouseDataDisk -
type ClickhouseMachineType ¶
type ClickhouseMachineType struct {
// CK机型名称
ClickhouseMachineTypeName string
// CK机型可选项
ClickhouseMachineTypeOptions []ClickhouseMachineTypeOption
// 机型是否支持安全组
IsSecgroupMachineType string
}
ClickhouseMachineType -
type ClickhouseMachineTypeOption ¶
type ClickhouseMachineTypeOption struct {
// CPU大小
CPU int
// Clickhouse机型ID
ClickhouseMachineTypeId string
// 数据盘列表
DataDisks []ClickhouseDataDisk
// 机型
MachineType string
// 内存大小,GB
Memory int
// 允许创建的节点个数
NodeCounts []int
}
ClickhouseMachineTypeOption -
type ClickhouseNode ¶
type ClickhouseNode struct {
// CPU大小
CPU int
// 集群ID
ClusterId string
// 创建时间
CreateTimestamp int
// 数据盘大小,GB
DataDiskSize int
// 数据盘类型
DataDiskType string
// ipv4
IPv4 string
// 机型
MachineType string
// 内存,GB
Memory int
// 节点ID
NodeId string
// 节点名称
NodeName string
// 资源ID
ResourceId string
// 服务状态:RUNNING(运行中)、STARTING(启动中)、STOPPED(已停止)、RESTARTING(重启中)
ServiceStatus string
// 分片组
ShardGroup string
// 系统盘大小,GB
SysDiskSize int
// 系统盘类型
SysDiskType string
// 可用区名称
Zone string
}
ClickhouseNode -
type ClickhouseVersion ¶
ClickhouseVersion -
type CreateUClickhouseClusterParamLabels ¶
type CreateUClickhouseClusterParamLabels struct {
// 标签的key
Key *string `required:"false"`
// 标签的value
Value *string `required:"false"`
}
CreateUClickhouseClusterParamLabels is request schema for complex param
type CreateUClickhouseClusterRequest ¶
type CreateUClickhouseClusterRequest struct {
request.CommonBase
// 集群管理员密码,密码规则:1.密码长度限8-32个字符2.不能包含[A-Z],[a-z],[0-9]和[@#%^*+=_;:,?!&()-]之外的字符3.需要同时包含两项或以上(大写字母/小写字母/数字/特殊符号)
AdminPassword *string `required:"true"`
// 备份任务ID,从备份恢复时,该字段必传,此值为备份任务ID,可以从原集群备份任务列表(ListUClickhouseBackups)获取
BackupId *string `required:"false"`
// 付费类型,枚举值:Year(年付),Month(月付),Dynamic(时付),默认值为Month,月付
ChargeType *string `required:"false"`
// 集群机型,可通过GetUClickhouseClusterCreateOption接口获取具体值
ClickhouseMachineTypeId *string `required:"true"`
// Clickhouse版本,可通过GetUClickhouseClusterCreateOption接口获取具体版本
ClickhouseVersion *string `required:"true"`
// 实例名称名称规则:1.长度为1-50位的字符2.不能包含_,中文,[A-Z],[a-z],[0-9]之外的非法字符,集群名称默认为clickhouse
ClusterName *string `required:"false"`
// 数据盘大小,最小100,步长为50,默认值为100,单位GB
DataDiskSize *int `required:"false"`
// 数据盘类型,可通过GetUClickhouseClusterCreateOption接口获取具体值
DataDiskType *string `required:"true"`
// 是否多可用区,默认为false
IsMultiZone *string `required:"false"`
// 是否开启安全组,true为开启,false为不开启,默认为false,不开启安全组
IsSecGroup *string `required:"false"`
// 是否Zookeeper高可用,true为zookeeper高可用,false为非高可用,默认为true,高可用
IsZookeeperHA *bool `required:"false"`
//
Labels []CreateUClickhouseClusterParamLabels `required:"false"`
// 【数组】可用区名称,IsMultiZone为true时,必传,可通过ListUClickhouseAvailableZone获取支持的可用区
MultiZones []string `required:"false"`
// 购买时长,默认值为1。月付时,此参数传0,代表购买至月末
Quantity *int `required:"false"`
// 副本数量,取值为1或2,1为单副本(非高可用),2为双副本(高可用),默认值为高可用(即为2)
ReplicateCount *int `required:"false"`
// 安全组ID,IsSecGroup为true时,必传
SecGroupIds *string `required:"false"`
// 分片数量,若传递,则至少1个分片,默认值为1
ShardCount *int `required:"false"`
// 子网ID
SubnetId *string `required:"true"`
// VPC ID
VPCId *string `required:"true"`
// Zookeeper数据盘大小,IsZookeeperHA为true时,必传,最小100,步长为50
ZookeeperDataDiskSize *string `required:"false"`
// Zookeeper数据盘类型,IsZookeeperHA为true时,必传,可通过GetUClickhouseClusterCreateOption接口获取具体值
ZookeeperDataDiskType *string `required:"false"`
// Zookeeper机型ID,IsZookeeperHA为true时,必传,可通过GetUClickhouseClusterCreateOption接口获取具体值
ZookeeperMachineTypeId *string `required:"false"`
}
CreateUClickhouseClusterRequest is request schema for CreateUClickhouseCluster action
type CreateUClickhouseClusterResponse ¶
type CreateUClickhouseClusterResponse struct {
response.CommonBase
// 返回数据
Data CreateUClickhouseClusterResponseData
// 返回信息
Message string
}
CreateUClickhouseClusterResponse is response schema for CreateUClickhouseCluster action
type CreateUClickhouseClusterResponseData ¶
type CreateUClickhouseClusterResponseData struct {
// 集群ID
ClusterId string
}
CreateUClickhouseClusterResponseData -
type DescribeUClickhouseClusterRequest ¶
type DescribeUClickhouseClusterRequest struct {
request.CommonBase
// 集群ID
ClusterId *string `required:"true"`
}
DescribeUClickhouseClusterRequest is request schema for DescribeUClickhouseCluster action
type DescribeUClickhouseClusterResponse ¶
type DescribeUClickhouseClusterResponse struct {
response.CommonBase
// 返回数据
Data DescribeUClickhouseClusterResponseData
// 返回信息
Message string
}
DescribeUClickhouseClusterResponse is response schema for DescribeUClickhouseCluster action
type DescribeUClickhouseClusterResponseData ¶
type DescribeUClickhouseClusterResponseData struct {
// Clickhouse节点列表
ClickhouseNodes []ClickhouseNode
// 集群信息
Cluster ClickhouseCluster
// 支付信息
Payment Payment
// Zookeeper节点列表,为空时,说明该集群没有zookeeper集群
ZookeeperNodes []ZookeeperNode
}
DescribeUClickhouseClusterResponseData -
type DestroyUClickhouseClusterRequest ¶
type DestroyUClickhouseClusterRequest struct {
request.CommonBase
// 集群ID
ClusterId *string `required:"true"`
}
DestroyUClickhouseClusterRequest is request schema for DestroyUClickhouseCluster action
type DestroyUClickhouseClusterResponse ¶
type DestroyUClickhouseClusterResponse struct {
response.CommonBase
// 返回信息
Message string
}
DestroyUClickhouseClusterResponse is response schema for DestroyUClickhouseCluster action
type ExpandUClickhouseClusterRequest ¶
type ExpandUClickhouseClusterRequest struct {
request.CommonBase
// 集群ID
ClusterId *string `required:"true"`
// 水平扩容时,选择某一个原节点的ID,用于同步表结构/用户信息。不传递时,表示不同步表结构/用户信息,仅水平扩容节点数量
SyncNodeId *string `required:"false"`
// 扩容后集群的节点数量,集群为高可用时,需要传入偶数个节点
TotalNodeCount *int `required:"true"`
}
ExpandUClickhouseClusterRequest is request schema for ExpandUClickhouseCluster action
type ExpandUClickhouseClusterResponse ¶
type ExpandUClickhouseClusterResponse struct {
response.CommonBase
// 返回信息
Message string
}
ExpandUClickhouseClusterResponse is response schema for ExpandUClickhouseCluster action
type GetCreateUClickhouseClusterOptionResponseData ¶
type GetCreateUClickhouseClusterOptionResponseData struct {
// 支持的CK机型
ClickhouseMachineTypes []ClickhouseMachineType
// 支持的CK版本
ClickhouseVersions []ClickhouseVersion
// 实例可创建的最大节点数量
MaxNodeCount int
// 支持的Zookeeper机型
ZookeeperMachineTypes []ClickhouseMachineType
}
GetCreateUClickhouseClusterOptionResponseData -
type GetUClickhouseClusterCreateOptionRequest ¶
type GetUClickhouseClusterCreateOptionRequest struct {
request.CommonBase
}
GetUClickhouseClusterCreateOptionRequest is request schema for GetUClickhouseClusterCreateOption action
type GetUClickhouseClusterCreateOptionResponse ¶
type GetUClickhouseClusterCreateOptionResponse struct {
response.CommonBase
// 数据
Data GetCreateUClickhouseClusterOptionResponseData
// 返回信息
Message string
}
GetUClickhouseClusterCreateOptionResponse is response schema for GetUClickhouseClusterCreateOption action
type ListUClickhouseClusterRequest ¶
type ListUClickhouseClusterRequest struct {
request.CommonBase
}
ListUClickhouseClusterRequest is request schema for ListUClickhouseCluster action
type ListUClickhouseClusterResponse ¶
type ListUClickhouseClusterResponse struct {
response.CommonBase
// 返回数据
Data ListUClickhouseClusterResponseData
// 返回信息
Message string
}
ListUClickhouseClusterResponse is response schema for ListUClickhouseCluster action
type ListUClickhouseClusterResponseData ¶
type ListUClickhouseClusterResponseData struct {
// 集群列表
Clusters ClickhouseCluster
// 集群总数
TotalCount int
}
ListUClickhouseClusterResponseData -
type Payment ¶
type Payment struct {
// 支付类型
ChargeType string
// 创建时间
CreateTimestamp int
// 过期时间
ExpireTimestamp int
// 原始价格
OriginalPrice int
// 价格
Price int
// 资源ID
ResourceId string
}
Payment -
type ResizeUClickhouseClusterRequest ¶
type ResizeUClickhouseClusterRequest struct {
request.CommonBase
// 集群ID
ClusterId *string `required:"true"`
// 是否为zookeeper节点,为true时表示升级zookeeper节点规格,为false时表示升级clickhouse节点规格,默认为false
IsZooKeeperNode *bool `required:"false"`
// 目标磁盘大小,单位GB,只能扩容,与TargetMachineTypeId不能同时为空
TargetDataDiskSize *int `required:"false"`
// 目标机型ID,可通过GetUClickhouseClusterCreateOption接口获取具体值,与TargetDataDiskSize不能同时为空
TargetMachineTypeId *string `required:"false"`
}
ResizeUClickhouseClusterRequest is request schema for ResizeUClickhouseCluster action
type ResizeUClickhouseClusterResponse ¶
type ResizeUClickhouseClusterResponse struct {
response.CommonBase
// 返回信息
Message string
}
ResizeUClickhouseClusterResponse is response schema for ResizeUClickhouseCluster action
type RestartUClickhouseClusterServiceRequest ¶
type RestartUClickhouseClusterServiceRequest struct {
request.CommonBase
// 集群ID
ClusterId *string `required:"true"`
}
RestartUClickhouseClusterServiceRequest is request schema for RestartUClickhouseClusterService action
type RestartUClickhouseClusterServiceResponse ¶
type RestartUClickhouseClusterServiceResponse struct {
response.CommonBase
// 返回信息
Message string
}
RestartUClickhouseClusterServiceResponse is response schema for RestartUClickhouseClusterService action
type UClickhouseClient ¶
UClickhouseClient is the client of UClickhouse
func NewClient ¶
func NewClient(config *ucloud.Config, credential *auth.Credential) *UClickhouseClient
NewClient will return a instance of UClickhouseClient
func (*UClickhouseClient) CreateUClickhouseCluster ¶
func (c *UClickhouseClient) CreateUClickhouseCluster(req *CreateUClickhouseClusterRequest) (*CreateUClickhouseClusterResponse, error)
API: CreateUClickhouseCluster
创建UClickhouse集群
func (*UClickhouseClient) DescribeUClickhouseCluster ¶
func (c *UClickhouseClient) DescribeUClickhouseCluster(req *DescribeUClickhouseClusterRequest) (*DescribeUClickhouseClusterResponse, error)
API: DescribeUClickhouseCluster
获取集群信息
func (*UClickhouseClient) DestroyUClickhouseCluster ¶
func (c *UClickhouseClient) DestroyUClickhouseCluster(req *DestroyUClickhouseClusterRequest) (*DestroyUClickhouseClusterResponse, error)
API: DestroyUClickhouseCluster
删除CK集群
func (*UClickhouseClient) ExpandUClickhouseCluster ¶
func (c *UClickhouseClient) ExpandUClickhouseCluster(req *ExpandUClickhouseClusterRequest) (*ExpandUClickhouseClusterResponse, error)
API: ExpandUClickhouseCluster
集群水平扩容
func (*UClickhouseClient) GetUClickhouseClusterCreateOption ¶
func (c *UClickhouseClient) GetUClickhouseClusterCreateOption(req *GetUClickhouseClusterCreateOptionRequest) (*GetUClickhouseClusterCreateOptionResponse, error)
API: GetUClickhouseClusterCreateOption
获取Clickhouse的创建配置项
func (*UClickhouseClient) ListUClickhouseCluster ¶
func (c *UClickhouseClient) ListUClickhouseCluster(req *ListUClickhouseClusterRequest) (*ListUClickhouseClusterResponse, error)
API: ListUClickhouseCluster
获取UClickhouse集群列表
func (*UClickhouseClient) NewCreateUClickhouseClusterRequest ¶
func (c *UClickhouseClient) NewCreateUClickhouseClusterRequest() *CreateUClickhouseClusterRequest
NewCreateUClickhouseClusterRequest will create request of CreateUClickhouseCluster action.
func (*UClickhouseClient) NewDescribeUClickhouseClusterRequest ¶
func (c *UClickhouseClient) NewDescribeUClickhouseClusterRequest() *DescribeUClickhouseClusterRequest
NewDescribeUClickhouseClusterRequest will create request of DescribeUClickhouseCluster action.
func (*UClickhouseClient) NewDestroyUClickhouseClusterRequest ¶
func (c *UClickhouseClient) NewDestroyUClickhouseClusterRequest() *DestroyUClickhouseClusterRequest
NewDestroyUClickhouseClusterRequest will create request of DestroyUClickhouseCluster action.
func (*UClickhouseClient) NewExpandUClickhouseClusterRequest ¶
func (c *UClickhouseClient) NewExpandUClickhouseClusterRequest() *ExpandUClickhouseClusterRequest
NewExpandUClickhouseClusterRequest will create request of ExpandUClickhouseCluster action.
func (*UClickhouseClient) NewGetUClickhouseClusterCreateOptionRequest ¶
func (c *UClickhouseClient) NewGetUClickhouseClusterCreateOptionRequest() *GetUClickhouseClusterCreateOptionRequest
NewGetUClickhouseClusterCreateOptionRequest will create request of GetUClickhouseClusterCreateOption action.
func (*UClickhouseClient) NewListUClickhouseClusterRequest ¶
func (c *UClickhouseClient) NewListUClickhouseClusterRequest() *ListUClickhouseClusterRequest
NewListUClickhouseClusterRequest will create request of ListUClickhouseCluster action.
func (*UClickhouseClient) NewResizeUClickhouseClusterRequest ¶
func (c *UClickhouseClient) NewResizeUClickhouseClusterRequest() *ResizeUClickhouseClusterRequest
NewResizeUClickhouseClusterRequest will create request of ResizeUClickhouseCluster action.
func (*UClickhouseClient) NewRestartUClickhouseClusterServiceRequest ¶
func (c *UClickhouseClient) NewRestartUClickhouseClusterServiceRequest() *RestartUClickhouseClusterServiceRequest
NewRestartUClickhouseClusterServiceRequest will create request of RestartUClickhouseClusterService action.
func (*UClickhouseClient) ResizeUClickhouseCluster ¶
func (c *UClickhouseClient) ResizeUClickhouseCluster(req *ResizeUClickhouseClusterRequest) (*ResizeUClickhouseClusterResponse, error)
API: ResizeUClickhouseCluster
集群改配
func (*UClickhouseClient) RestartUClickhouseClusterService ¶
func (c *UClickhouseClient) RestartUClickhouseClusterService(req *RestartUClickhouseClusterServiceRequest) (*RestartUClickhouseClusterServiceResponse, error)
API: RestartUClickhouseClusterService
重启集群的UClickhouse服务
type ZookeeperNode ¶
type ZookeeperNode struct {
// CPU
CPU int
// 集群ID
ClusterId string
// 创建时间
CreateTimestamp int
// 数据盘大小
DataDiskSize int
// 数据盘类型
DataDiskType string
// 机型
MachineType string
// 内存
Memory int
// 节点ID
NodeId string
// 节点名称
NodeName string
// 资源ID
ResourceId string
// 服务状态:RUNNING(运行中)、STARTING(启动中)、STOPPED(已停止)、RESTARTING(重启中)
ServiceStatus string
// 系统盘大小
SysDiskSize int
// 系统盘类型
SysDiskType string
// 可用区名称
Zone string
// zookeeper的myid
ZookeeperMyId string
}
ZookeeperNode -