Documentation
¶
Overview ¶
Package ues include resources of ucloud ues product
See also
for detail.
Index ¶
- type AppVersion
- type ClusterInfo
- type ClusterNodeV2Info
- type ClusterV2Info
- type CreateUESInstanceRequest
- type CreateUESInstanceResponse
- type DeleteUESInstanceRequest
- type DeleteUESInstanceResponse
- type DescribeUESInstanceV2Request
- type DescribeUESInstanceV2Response
- type DiskSizeLimitation
- type ExpandUESInstanceRequest
- type ExpandUESInstanceResponse
- type GetUESAppVersionRequest
- type GetUESAppVersionResponse
- type GetUESDiskSizeLimitationRequest
- type GetUESDiskSizeLimitationResponse
- type GetUESNodeConfRequest
- type GetUESNodeConfResponse
- type ListUESInstanceRequest
- type ListUESInstanceResponse
- type NodeConf
- type NodeV2Info
- type ResizeUESInstanceRequest
- type ResizeUESInstanceResponse
- type RestartUESInstanceRequest
- type RestartUESInstanceResponse
- type UESClient
- func (c *UESClient) CreateUESInstance(req *CreateUESInstanceRequest) (*CreateUESInstanceResponse, error)
- func (c *UESClient) DeleteUESInstance(req *DeleteUESInstanceRequest) (*DeleteUESInstanceResponse, error)
- func (c *UESClient) DescribeUESInstanceV2(req *DescribeUESInstanceV2Request) (*DescribeUESInstanceV2Response, error)
- func (c *UESClient) ExpandUESInstance(req *ExpandUESInstanceRequest) (*ExpandUESInstanceResponse, error)
- func (c *UESClient) GetUESAppVersion(req *GetUESAppVersionRequest) (*GetUESAppVersionResponse, error)
- func (c *UESClient) GetUESDiskSizeLimitation(req *GetUESDiskSizeLimitationRequest) (*GetUESDiskSizeLimitationResponse, error)
- func (c *UESClient) GetUESNodeConf(req *GetUESNodeConfRequest) (*GetUESNodeConfResponse, error)
- func (c *UESClient) ListUESInstance(req *ListUESInstanceRequest) (*ListUESInstanceResponse, error)
- func (c *UESClient) NewCreateUESInstanceRequest() *CreateUESInstanceRequest
- func (c *UESClient) NewDeleteUESInstanceRequest() *DeleteUESInstanceRequest
- func (c *UESClient) NewDescribeUESInstanceV2Request() *DescribeUESInstanceV2Request
- func (c *UESClient) NewExpandUESInstanceRequest() *ExpandUESInstanceRequest
- func (c *UESClient) NewGetUESAppVersionRequest() *GetUESAppVersionRequest
- func (c *UESClient) NewGetUESDiskSizeLimitationRequest() *GetUESDiskSizeLimitationRequest
- func (c *UESClient) NewGetUESNodeConfRequest() *GetUESNodeConfRequest
- func (c *UESClient) NewListUESInstanceRequest() *ListUESInstanceRequest
- func (c *UESClient) NewResizeUESInstanceRequest() *ResizeUESInstanceRequest
- func (c *UESClient) NewRestartUESInstanceRequest() *RestartUESInstanceRequest
- func (c *UESClient) ResizeUESInstance(req *ResizeUESInstanceRequest) (*ResizeUESInstanceResponse, error)
- func (c *UESClient) RestartUESInstance(req *RestartUESInstanceRequest) (*RestartUESInstanceResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppVersion ¶
type AppVersion struct {
// 应用名称,默认值为elasticsearch
AppName string
// 应用版本号
AppVersion string
// 是否支持多区部署,默认为false
IsMultiZone bool
}
AppVersion - ES可选版本详情
type ClusterInfo ¶
type ClusterInfo struct {
// 应用名称
AppName string
// 应用服务版本号
AppVersion string
// 项目组ID标识
BusinessId string
// 计费类型,默认为Month
ChargeType string
// 创建时间
CreateTime int
// 失效时间
ExpireTime int
// 实例资源ID
InstanceId string
// 实例名称
InstanceName string
// 是否开启安全组
IsSecGroup bool
// 多可用区
MultiZones []string
// 节点个数,默认为集群大小
NodeCount int
// 是否支持改配
Resizable bool
// 实例运行时长
RunTime int
// 服务版本号(弃用)
ServiceVersion string
// 实例状态
State string
// 子网ID标识
SubnetId string
// 业务组
Tag string
// 服务集群ID标识(弃用)
UESInstanceId string
// 服务集群名称(弃用)
UESInstanceName string
// VPCID标识
VPCId string
// VIP地址信息
Vip string
// 可用区
Zone string
}
ClusterInfo - 集群信息
type ClusterNodeV2Info ¶
type ClusterNodeV2Info struct {
//
ClusterInfo ClusterV2Info
//
NodeInfoList []NodeV2Info
//
RequestId string
}
ClusterNodeV2Info -
type ClusterV2Info ¶
type ClusterV2Info struct {
// 项目组ID标识
BusinessId string
// 地域
Region string
// 服务版本号
ServiceVersion string
// 服务集群状态
State string
// 子网ID标识
SubnetId string
// 服务集群ID标识
UESInstanceId string
// 服务集群名称
UESInstanceName string
// VPCID标识
VPCId string
// Vip
Vip string
// 可用区
Zone string
}
ClusterV2Info - 集群信息
type CreateUESInstanceRequest ¶
type CreateUESInstanceRequest struct {
request.CommonBase
// 应用名称,支持的类型通过GetUESAppVersion AppVersionList[].AppName, 默认为elasticsearch
AppName *string `required:"false"`
// 应用服务版本号,支持的类型通过GetUESAppVersion AppVersionList[].AppVersion
AppVersion *string `required:"true"`
// 业务组ID标识
BusinessId *string `required:"false"`
// 计费类型,默认为Month
ChargeType *string `required:"false"`
// Coordinating节点机型配置,, 支持的机型可通过GetUESNodeConf NodeConfList[].NodeConf, 默认为空
CoordinatingNodeConf *string `required:"false"`
// Coordinating节点磁盘类型
CoordinatingNodeDiskConf *string `required:"false"`
// Coordinating节点数量
CoordinatingNodeSize *int `required:"false"`
// 实例名称
InstanceName *string `required:"true"`
// 是否为多可用区,默认为false
IsMultiZone *bool `required:"false"`
// 是否开启安全组,默认为false
IsSecGroup *bool `required:"false"`
// Kibana节点配置, 支持的机型可通过GetUESNodeConf NodeConfList[].NodeConf
KibanaNodeConf *string `required:"true"`
// Kibana节点磁盘类型
KibanaNodeDiskConf *string `required:"true"`
// 主节点类型标示,支持的机型可通过GetUESNodeConf NodeConfList[].NodeConf, 默认为空
MasterConf *string `required:"false"`
// 多可用区名称,默认空数组 []
MultiZones []string `required:"false"`
// 节点配置标识, 支持的机型可通过GetUESNodeConf NodeConfList[].NodeConf
NodeConf *string `required:"true"`
// 磁盘类型
NodeDiskConf *string `required:"true"`
// 节点磁盘大小,默认为100G
NodeDiskSize *int `required:"false"`
// 节点个数,默认数目为3
NodeSize *int `required:"false"`
// 计费长度,默认为1
Quantity *int `required:"false"`
// 备注,默认为空
Remark *string `required:"false"`
// 安全组ID,开启安全组必填,至多可以同时绑定5个安全组
SecGroupIds []string `required:"false"`
// 服务用户密码,默认为changeme
ServicePasswd *string `required:"false"`
// elasticsearch 服务用户名称,默认为elastic;OpenSearch 服务用户名称,固定为admin
ServiceUserName *string `required:"false"`
// 子网ID标识
SubnetId *string `required:"true"`
// VPCID标识
VPCId *string `required:"true"`
}
CreateUESInstanceRequest is request schema for CreateUESInstance action
type CreateUESInstanceResponse ¶
type CreateUESInstanceResponse struct {
response.CommonBase
// 实例ID
InstanceId string
// 错误信息
Message string
}
CreateUESInstanceResponse is response schema for CreateUESInstance action
type DeleteUESInstanceRequest ¶
type DeleteUESInstanceRequest struct {
request.CommonBase
// 实例ID
InstanceId *string `required:"true"`
}
DeleteUESInstanceRequest is request schema for DeleteUESInstance action
type DeleteUESInstanceResponse ¶
type DeleteUESInstanceResponse struct {
response.CommonBase
// 错误信息
Message string
}
DeleteUESInstanceResponse is response schema for DeleteUESInstance action
type DescribeUESInstanceV2Request ¶
type DescribeUESInstanceV2Request struct {
request.CommonBase
// 集群实例ID
InstanceId *string `required:"true"`
}
DescribeUESInstanceV2Request is request schema for DescribeUESInstanceV2 action
type DescribeUESInstanceV2Response ¶
type DescribeUESInstanceV2Response struct {
response.CommonBase
// 返回结果
Result ClusterNodeV2Info
}
DescribeUESInstanceV2Response is response schema for DescribeUESInstanceV2 action
type DiskSizeLimitation ¶
type DiskSizeLimitation struct {
// 数据盘类别,包含普通云盘|CLOUD_NORMAL、SSD云盘|CLOUD_SSD和RSSD云盘|CLOUD_RSSD。普通本地盘只包含普通本地盘|LOCAL_NORMAL一种。SSD本地盘只包含SSD本地盘|LOCAL_SSD一种。
DiskType string
// 最大值,单位GB
MaxSize int
// 最小值,单位GB
MinSize int
}
DiskSizeLimitation -
type ExpandUESInstanceRequest ¶
type ExpandUESInstanceRequest struct {
request.CommonBase
// 实例ID
InstanceId *string `required:"true"`
// 扩容后对应类型节点的数目
NodeCount *int `required:"true"`
// 节点类型(compute、coordinating)
NodeRole *string `required:"true"`
}
ExpandUESInstanceRequest is request schema for ExpandUESInstance action
type ExpandUESInstanceResponse ¶
type ExpandUESInstanceResponse struct {
response.CommonBase
// 错误信息
Message string
}
ExpandUESInstanceResponse is response schema for ExpandUESInstance action
type GetUESAppVersionRequest ¶
type GetUESAppVersionRequest struct {
request.CommonBase
}
GetUESAppVersionRequest is request schema for GetUESAppVersion action
type GetUESAppVersionResponse ¶
type GetUESAppVersionResponse struct {
response.CommonBase
// 服务应用版本列表
AppVersionList []AppVersion
// 错误信息
Message string
// 服务应用版本个数
TotalCount int
}
GetUESAppVersionResponse is response schema for GetUESAppVersion action
type GetUESDiskSizeLimitationRequest ¶
type GetUESDiskSizeLimitationRequest struct {
request.CommonBase
}
GetUESDiskSizeLimitationRequest is request schema for GetUESDiskSizeLimitation action
type GetUESDiskSizeLimitationResponse ¶
type GetUESDiskSizeLimitationResponse struct {
response.CommonBase
// 各磁盘类型容量限制列表
DiskSizeLimitationSet []DiskSizeLimitation
// 错误信息
Message string
}
GetUESDiskSizeLimitationResponse is response schema for GetUESDiskSizeLimitation action
type GetUESNodeConfRequest ¶
type GetUESNodeConfRequest struct {
request.CommonBase
}
GetUESNodeConfRequest is request schema for GetUESNodeConf action
type GetUESNodeConfResponse ¶
type GetUESNodeConfResponse struct {
response.CommonBase
// 错误信息
Message string
// 服务节点配置信息列表
NodeConfList []NodeConf
// 所有节点配置信息的个数
TotalCount int
}
GetUESNodeConfResponse is response schema for GetUESNodeConf action
type ListUESInstanceRequest ¶
type ListUESInstanceRequest struct {
request.CommonBase
// 返回数据长度, 默认为30
Limit *int `required:"false"`
// 数据偏移量, 默认为0
Offset *int `required:"false"`
}
ListUESInstanceRequest is request schema for ListUESInstance action
type ListUESInstanceResponse ¶
type ListUESInstanceResponse struct {
response.CommonBase
// 实例信息列表
ClusterSet []ClusterInfo
// 错误信息
Message string
// 实例个数
TotalCount int
}
ListUESInstanceResponse is response schema for ListUESInstance action
type NodeConf ¶
type NodeConf struct {
// CPU数量
CPU int
// 磁盘大小,单位为GB
DiskSize int
// 磁盘类型[RSSD|SSD]
DiskType string
// 是否支持安全组[true|false]
IsSecGroup bool
// 内存,单位为GB
Memory int
// 节点配置标识
NodeConf string
}
NodeConf - 节点配置信息详情
type NodeV2Info ¶
type NodeV2Info struct {
// 节点cpu数量
CPU int
// 节点磁盘大小
DiskSize int
// 节点磁盘类型
DiskType string
// 节点内存大小
Memory int
// 节点配置标识
NodeConf string
// 节点IP
NodeIP string
// 节点ID
NodeId string
// 节点名称
NodeName string
// 节点类型
NodeRole string
// 节点状态
NodeState string
}
NodeV2Info - 节点信息详情
type ResizeUESInstanceRequest ¶
type ResizeUESInstanceRequest struct {
request.CommonBase
// 进行改配操作是否强制检查集群健康状态,默认为false
ForceResizing *bool `required:"false"`
// 实例ID
InstanceId *string `required:"true"`
// 改配节点类型,NodeDiskSize为0,基于NodeRole 进行改配
NodeConf *string `required:"false"`
// 改配节点磁盘大小,NodeConf 为空字符串,基于NodeRole 进行改配
NodeDiskSize *int `required:"false"`
// 节点类型(compute、master、coordinating、kibana、dashboard)
NodeRole *string `required:"true"`
}
ResizeUESInstanceRequest is request schema for ResizeUESInstance action
type ResizeUESInstanceResponse ¶
type ResizeUESInstanceResponse struct {
response.CommonBase
// 错误信息
Message string
}
ResizeUESInstanceResponse is response schema for ResizeUESInstance action
type RestartUESInstanceRequest ¶
type RestartUESInstanceRequest struct {
request.CommonBase
// 实例ID
InstanceId *string `required:"true"`
}
RestartUESInstanceRequest is request schema for RestartUESInstance action
type RestartUESInstanceResponse ¶
type RestartUESInstanceResponse struct {
response.CommonBase
// 错误信息
Message string
}
RestartUESInstanceResponse is response schema for RestartUESInstance action
type UESClient ¶
UESClient is the client of UES
func NewClient ¶
func NewClient(config *ucloud.Config, credential *auth.Credential) *UESClient
NewClient will return a instance of UESClient
func (*UESClient) CreateUESInstance ¶
func (c *UESClient) CreateUESInstance(req *CreateUESInstanceRequest) (*CreateUESInstanceResponse, error)
API: CreateUESInstance
创建实例
func (*UESClient) DeleteUESInstance ¶
func (c *UESClient) DeleteUESInstance(req *DeleteUESInstanceRequest) (*DeleteUESInstanceResponse, error)
API: DeleteUESInstance
删除实例
func (*UESClient) DescribeUESInstanceV2 ¶
func (c *UESClient) DescribeUESInstanceV2(req *DescribeUESInstanceV2Request) (*DescribeUESInstanceV2Response, error)
API: DescribeUESInstanceV2
查询指定实例详细信息
func (*UESClient) ExpandUESInstance ¶
func (c *UESClient) ExpandUESInstance(req *ExpandUESInstanceRequest) (*ExpandUESInstanceResponse, error)
API: ExpandUESInstance
扩容实例节点
func (*UESClient) GetUESAppVersion ¶
func (c *UESClient) GetUESAppVersion(req *GetUESAppVersionRequest) (*GetUESAppVersionResponse, error)
API: GetUESAppVersion
获取服务应用版本列表
func (*UESClient) GetUESDiskSizeLimitation ¶
func (c *UESClient) GetUESDiskSizeLimitation(req *GetUESDiskSizeLimitationRequest) (*GetUESDiskSizeLimitationResponse, error)
API: GetUESDiskSizeLimitation
获取磁盘容量限制
func (*UESClient) GetUESNodeConf ¶
func (c *UESClient) GetUESNodeConf(req *GetUESNodeConfRequest) (*GetUESNodeConfResponse, error)
API: GetUESNodeConf
获取节点配置列表
func (*UESClient) ListUESInstance ¶
func (c *UESClient) ListUESInstance(req *ListUESInstanceRequest) (*ListUESInstanceResponse, error)
API: ListUESInstance
获取实例列表
func (*UESClient) NewCreateUESInstanceRequest ¶
func (c *UESClient) NewCreateUESInstanceRequest() *CreateUESInstanceRequest
NewCreateUESInstanceRequest will create request of CreateUESInstance action.
func (*UESClient) NewDeleteUESInstanceRequest ¶
func (c *UESClient) NewDeleteUESInstanceRequest() *DeleteUESInstanceRequest
NewDeleteUESInstanceRequest will create request of DeleteUESInstance action.
func (*UESClient) NewDescribeUESInstanceV2Request ¶
func (c *UESClient) NewDescribeUESInstanceV2Request() *DescribeUESInstanceV2Request
NewDescribeUESInstanceV2Request will create request of DescribeUESInstanceV2 action.
func (*UESClient) NewExpandUESInstanceRequest ¶
func (c *UESClient) NewExpandUESInstanceRequest() *ExpandUESInstanceRequest
NewExpandUESInstanceRequest will create request of ExpandUESInstance action.
func (*UESClient) NewGetUESAppVersionRequest ¶
func (c *UESClient) NewGetUESAppVersionRequest() *GetUESAppVersionRequest
NewGetUESAppVersionRequest will create request of GetUESAppVersion action.
func (*UESClient) NewGetUESDiskSizeLimitationRequest ¶
func (c *UESClient) NewGetUESDiskSizeLimitationRequest() *GetUESDiskSizeLimitationRequest
NewGetUESDiskSizeLimitationRequest will create request of GetUESDiskSizeLimitation action.
func (*UESClient) NewGetUESNodeConfRequest ¶
func (c *UESClient) NewGetUESNodeConfRequest() *GetUESNodeConfRequest
NewGetUESNodeConfRequest will create request of GetUESNodeConf action.
func (*UESClient) NewListUESInstanceRequest ¶
func (c *UESClient) NewListUESInstanceRequest() *ListUESInstanceRequest
NewListUESInstanceRequest will create request of ListUESInstance action.
func (*UESClient) NewResizeUESInstanceRequest ¶
func (c *UESClient) NewResizeUESInstanceRequest() *ResizeUESInstanceRequest
NewResizeUESInstanceRequest will create request of ResizeUESInstance action.
func (*UESClient) NewRestartUESInstanceRequest ¶
func (c *UESClient) NewRestartUESInstanceRequest() *RestartUESInstanceRequest
NewRestartUESInstanceRequest will create request of RestartUESInstance action.
func (*UESClient) ResizeUESInstance ¶
func (c *UESClient) ResizeUESInstance(req *ResizeUESInstanceRequest) (*ResizeUESInstanceResponse, error)
API: ResizeUESInstance
改配实例节点配置
func (*UESClient) RestartUESInstance ¶
func (c *UESClient) RestartUESInstance(req *RestartUESInstanceRequest) (*RestartUESInstanceResponse, error)
API: RestartUESInstance
重启实例