Documentation ¶
Index ¶
- type CreateClusterBackupStrategyBody
- type CreateClusterBody
- type CreateClusterDatastoreBody
- type CreateClusterElbWhiteList
- type CreateClusterInstanceNicsBody
- type CreateClusterInstanceVolumeBody
- type CreateClusterLoadBalance
- type CreateClusterPublicEip
- type CreateClusterPublicEipSize
- type CreateClusterPublicIpReq
- type CreateClusterPublicKibanaElbWhiteList
- type CreateClusterPublicKibanaReq
- type CreateClusterReq
- type CreateClusterRequest
- type CreateClusterResp
- type CreateClusterResponse
- type CreateClusterRolesBody
- type CreateClusterTagsBody
- type PayInfoBody
- type RestartClusterReq
- type RestartClusterRequest
- type RestartClusterResponse
- type RollingRestartReq
- type RollingRestartRequest
- type RollingRestartResponse
- type StartAutoCreateSnapshotsReq
- type StartAutoCreateSnapshotsRequest
- type StartAutoCreateSnapshotsResponse
- type StopAutoCreateSnapshotsRequest
- type StopAutoCreateSnapshotsResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateClusterBackupStrategyBody ¶
type CreateClusterBackupStrategyBody struct { // 每天自动创建快照的时间点。只支持整点,后面需加上时区,格式为“HH:mm z”,“HH:mm”表示整点时间,“z”表示时区。比如“00:00 GMT+08:00”、“01:00 GMT+08:00”等。 Period string `json:"period"` // 自动创建的快照的前缀,需要用户自己手动输入。只能包含1~32位小写字母、数字、中划线或者下划线,并且以小写字母开头。 Prefix string `json:"prefix"` // 自动创建快照的保留天数。取值范围:1-90。 Keepday int32 `json:"keepday"` // 备份使用的OBS桶名称。 Bucket *string `json:"bucket,omitempty"` // 快照在OBS桶中的存放路径。 BasePath *string `json:"basePath,omitempty"` // 访问OBS使用的IAM委托名称。 >如果bucket、basePath和agency三个参数同时为空,则系统会自动创建OBS桶和IAM代理,否则使用配置的参数值。 Agency *string `json:"agency,omitempty"` }
开启自动创建快照策略。 当backupStrategy参数配置不为空时,才会开启自动创建快照策略。
func (CreateClusterBackupStrategyBody) String ¶
func (o CreateClusterBackupStrategyBody) String() string
type CreateClusterBody ¶
type CreateClusterBody struct { // 集群名称。4~32个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 Name string `json:"name"` BackupStrategy *CreateClusterBackupStrategyBody `json:"backupStrategy,omitempty"` Roles []CreateClusterRolesBody `json:"roles"` Nics *CreateClusterInstanceNicsBody `json:"nics"` // 企业项目ID。创建集群时,给集群绑定企业项目ID。最大长度36个字符,带\"-\"连字符的UUID格式,或者是字符串\"0\"。\"0\"表示默认企业项目。 关于企业项目ID的获取及企业项目特性的详细信息,请参见[[《企业管理服务用户指南》](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0123692049.html)](tag:hc)[[《企业管理服务用户指南》](https://support.huaweicloud.com/intl/zh-cn/usermanual-em/zh-cn_topic_0123692049.html)](tag:hk)。 EnterpriseProjectId *string `json:"enterprise_project_id,omitempty"` // 集群标签。 关于标签特性的详细信息,请参见[[《标签管理服务介绍》](https://support.huaweicloud.com/productdesc-tms/zh-cn_topic_0071335169.html)](tag:hc)[[《标签管理服务介绍》](https://support.huaweicloud.com/intl/zh-cn/productdesc-tms/zh-cn_topic_0071335169.html)](tag:hk)。 Tags *[]CreateClusterTagsBody `json:"tags,omitempty"` // 可用区。 AvailabilityZone *string `json:"availability_zone,omitempty"` Datastore *CreateClusterDatastoreBody `json:"datastore"` // 是否开启认证,取值范围为true或false。默认关闭认证功能。 - true:表示集群开启认证。 - false:表示集群不开启认证。 >此参数只有6.5.4及之后版本支持。 AuthorityEnable *bool `json:"authorityEnable,omitempty"` // 设置是否进行通信加密。取值范围为true或false。默认关闭通信加密功能。当httpsEnable设置为true时,authorityEnable字段需要设置为true。 - true:表示集群进行通信加密。 - false:表示集群不进行通信加密。 >此参数只有6.5.4及之后版本支持。 HttpsEnable *bool `json:"httpsEnable,omitempty"` // 安全模式下集群管理员admin的密码,只有在创建集群时authorityEnable设置为true时需要设置此参数。 - 参数范围:8~32个字符。 - 参数要求:密码至少包含大写字母,小写字母,数字、特殊字符四类中的三类,其中可输入的特殊字符为:~!@#$%&*()-_=|[{}];:,<.>/? AdminPwd *string `json:"adminPwd,omitempty"` PublicIPReq *CreateClusterPublicIpReq `json:"publicIPReq,omitempty"` LoadBalance *CreateClusterLoadBalance `json:"loadBalance,omitempty"` PublicKibanaReq *CreateClusterPublicKibanaReq `json:"publicKibanaReq,omitempty"` PayInfo *PayInfoBody `json:"payInfo,omitempty"` }
集群对象。
func (CreateClusterBody) String ¶
func (o CreateClusterBody) String() string
type CreateClusterDatastoreBody ¶
type CreateClusterDatastoreBody struct { // CSS集群引擎版本号。详细请参考CSS[支持的集群版本](css_03_0056.xml)。 Version string `json:"version"` // 引擎类型,支持elasticsearch。 Type string `json:"type"` }
引擎类型,目前只支持elasticsearch。
func (CreateClusterDatastoreBody) String ¶
func (o CreateClusterDatastoreBody) String() string
type CreateClusterElbWhiteList ¶
type CreateClusterElbWhiteList struct { // 是否开启公网访问控制。 EnableWhiteList bool `json:"enableWhiteList"` // 公网访问控制白名单。需要添加白名单的网段或ip,以逗号隔开,不可重复。 WhiteList *string `json:"whiteList,omitempty"` }
弹性IP白名单。
func (CreateClusterElbWhiteList) String ¶
func (o CreateClusterElbWhiteList) String() string
type CreateClusterInstanceNicsBody ¶
type CreateClusterInstanceNicsBody struct { // 指定虚拟私有云ID,用于集群网络配置。 VpcId string `json:"vpcId"` // 子网ID(网络ID)。 NetId string `json:"netId"` // 安全组ID。 SecurityGroupId string `json:"securityGroupId"` }
子网信息。
func (CreateClusterInstanceNicsBody) String ¶
func (o CreateClusterInstanceNicsBody) String() string
type CreateClusterInstanceVolumeBody ¶
type CreateClusterInstanceVolumeBody struct { // 卷类型。 - COMMON:普通I/O。 - HIGH:高I/O。 - ULTRAHIGH:超高I/O。 VolumeType string `json:"volume_type"` // 卷大小,必须为大于0且为4和10的公倍数。 单位:GB。 >ess-master节点和ess-client节点默认大小为40G,且不可更改。 Size int32 `json:"size"` }
volume信息。当flavorRef选择的是本地盘规格时不需要填写,本地盘规格可以通过[获取实例规格列表](ListFlavors.xml)中diskrange属性获得。目前支持的本地盘规格有: - ess.spec-i3small - ess.spec-i3medium - ess.spec-i3.8xlarge.8 - ess.spec-ds.xlarge.8 - ess.spec-ds.2xlarge.8 - ess.spec-ds.4xlarge.8
func (CreateClusterInstanceVolumeBody) String ¶
func (o CreateClusterInstanceVolumeBody) String() string
type CreateClusterLoadBalance ¶
type CreateClusterLoadBalance struct { // 是否开启内网域名。 - true: 开启内网域名。 - false: 关闭内网域名。 EndpointWithDnsName bool `json:"endpointWithDnsName"` // 访问控制。 VpcPermissions *[]string `json:"vpcPermissions,omitempty"` }
终端节点服务信息。
func (CreateClusterLoadBalance) String ¶
func (o CreateClusterLoadBalance) String() string
type CreateClusterPublicEip ¶
type CreateClusterPublicEip struct {
BandWidth *CreateClusterPublicEipSize `json:"bandWidth"`
}
公网带宽信息。
func (CreateClusterPublicEip) String ¶
func (o CreateClusterPublicEip) String() string
type CreateClusterPublicEipSize ¶
type CreateClusterPublicEipSize struct { // 带宽大小。 Size int32 `json:"size"` }
设置公网带宽大小。
func (CreateClusterPublicEipSize) String ¶
func (o CreateClusterPublicEipSize) String() string
type CreateClusterPublicIpReq ¶
type CreateClusterPublicIpReq struct { Eip *CreateClusterPublicEip `json:"eip"` ElbWhiteListReq *CreateClusterElbWhiteList `json:"elbWhiteListReq"` // 是否自动绑定弹性公网IP。auto_assign为自动分配,bind_existing为绑定已有IP,需要填写eipId字段。 PublicBindType string `json:"publicBindType"` // 弹性公网IP的ID。 EipId *string `json:"eipId,omitempty"` }
公网访问信息。只有在httpsEnable设置为true时该参数配置生效。
func (CreateClusterPublicIpReq) String ¶
func (o CreateClusterPublicIpReq) String() string
type CreateClusterPublicKibanaElbWhiteList ¶
type CreateClusterPublicKibanaElbWhiteList struct { // 白名单。需要添加白名单的网段或ip,以逗号隔开,不可重复。 WhiteList string `json:"whiteList"` // 是否开启kibana访问控制。 EnableWhiteList bool `json:"enableWhiteList"` }
kibana白名单信息。
func (CreateClusterPublicKibanaElbWhiteList) String ¶
func (o CreateClusterPublicKibanaElbWhiteList) String() string
type CreateClusterPublicKibanaReq ¶
type CreateClusterPublicKibanaReq struct { // 带宽大小。 EipSize int32 `json:"eipSize"` ElbWhiteList *CreateClusterPublicKibanaElbWhiteList `json:"elbWhiteList"` }
Kibana公网访问信息。只有在authorityEnable设置为true时该参数配置生效。
func (CreateClusterPublicKibanaReq) String ¶
func (o CreateClusterPublicKibanaReq) String() string
type CreateClusterReq ¶
type CreateClusterReq struct {
Cluster *CreateClusterBody `json:"cluster"`
}
func (CreateClusterReq) String ¶
func (o CreateClusterReq) String() string
type CreateClusterRequest ¶
type CreateClusterRequest struct {
Body *CreateClusterReq `json:"body,omitempty"`
}
Request Object
func (CreateClusterRequest) String ¶
func (o CreateClusterRequest) String() string
type CreateClusterResp ¶ added in v0.0.92
type CreateClusterResp struct { // 集群ID。 Id *string `json:"id,omitempty"` // 集群名称。 Name *string `json:"name,omitempty"` }
集群对象。若创建的是按需集群,则只返回cluster参数。
func (CreateClusterResp) String ¶ added in v0.0.92
func (o CreateClusterResp) String() string
type CreateClusterResponse ¶
type CreateClusterResponse struct { Cluster *CreateClusterResp `json:"cluster,omitempty"` // 订单号。若创建的是包周期集群,则只返回ordeld参数。 OrderId *string `json:"orderId,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (CreateClusterResponse) String ¶
func (o CreateClusterResponse) String() string
type CreateClusterRolesBody ¶
type CreateClusterRolesBody struct { // 实例规格名称。可以使用[获取实例规格列表](ListFlavors.xml)的name属性确认当前拥有的规格信息。 FlavorRef string `json:"flavorRef"` Volume *CreateClusterInstanceVolumeBody `json:"volume"` // 实例类型(选择实例类型时应至少选择一个ess类型)。例如, - ess-master对应Master节点。 - ess-client对应clinet节点。 - ess-cold对应冷数据节点。 - ess对应数据节点。 Type string `json:"type"` // 实例个数。 - ess节点,选择范围:1~32个节点数量。 - 若同时选择ess和ess-master时,可以选择1~200个节点数量。 - 若同时选择ess和ess-client时,可以选择1~32个节点数量。 - 若同时选择ess和ess-cold时,可以选择1~32个节点数量。 - ess-master节点,选择范围:3~10内的奇数个节点数量。 - ess-client节点,选择范围:1~32个节点数量。 - ess-cold节点,选择范围:1~32个节点数量。 InstanceNum int32 `json:"instanceNum"` }
集群信息。
func (CreateClusterRolesBody) String ¶
func (o CreateClusterRolesBody) String() string
type CreateClusterTagsBody ¶
type CreateClusterTagsBody struct { // 集群标签的key值。可输入的字符串长度为1~36个字符。只能包含数字、字母、中划线\"-\"和下划线\"_\"。 Key string `json:"key"` // 集群标签的value值。可输入的字符串长度为0~43个字符。只能包含数字、字母、中划线\"-\"和下划线\"_\"。 Value string `json:"value"` }
集群标签。 关于标签特性的详细信息,请参见[[《标签管理服务介绍》](https://support.huaweicloud.com/productdesc-tms/zh-cn_topic_0071335169.html)](tag:hc)[[《标签管理服务介绍》](https://support.huaweicloud.com/intl/zh-cn/productdesc-tms/zh-cn_topic_0071335169.html)](tag:hk)。
func (CreateClusterTagsBody) String ¶
func (o CreateClusterTagsBody) String() string
type PayInfoBody ¶ added in v0.0.94
type PayInfoBody struct { // 订购周期类型。 - 2: 包月。 - 3: 包年。 PayModel int32 `json:"payModel"` // 订购周期数。 - 若payModel为2,则有效值为1-9。 - 若payModel为3,则有效值为1-3。 Period int32 `json:"period"` // 是否自动续订,为空时表示不自动续订。 - 1: 自动续订。 - 2:不自动续订(默认)。 IsAutoRenew *int32 `json:"isAutoRenew,omitempty"` // 是否自动支付:下单订购后,是否自动从客户的华为云账户中支付,而不需要客户手动去进行支付。 - 1: 是(会自动选择折扣和优惠券进行优惠,然后自动从客户华为云账户中支付),自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”,等待客户手动支付(手动支付时,客户还可以修改系统自动选择的折扣和优惠券)。 - 2: 否(需要客户手动去支付,客户可以选择折扣和优惠券)。默认值为“0”。 IsAutoPay *int32 `json:"isAutoPay,omitempty"` }
包周期集群相关参数订购包周期集群时使用。
func (PayInfoBody) String ¶ added in v0.0.94
func (o PayInfoBody) String() string
type RestartClusterReq ¶
type RestartClusterReq struct { // 操作角色。参数范围: - node - role Type string `json:"type"` // 操作参数。参数说明: - 当操作角色为node时,value为节点ID,通过[查询集群详情](ShowClusterDetail.xml)获取instances中的id属性。 - 当操作角色为role时,value为节点类型(ess、ess-master、ess-client、ess-cold)的多种不同组合。 Value string `json:"value"` }
func (RestartClusterReq) String ¶
func (o RestartClusterReq) String() string
type RestartClusterRequest ¶
type RestartClusterRequest struct { // 指定重启集群ID。 ClusterId string `json:"cluster_id"` Body *RestartClusterReq `json:"body,omitempty"` }
Request Object
func (RestartClusterRequest) String ¶
func (o RestartClusterRequest) String() string
type RestartClusterResponse ¶
type RestartClusterResponse struct {
HttpStatusCode int `json:"-"`
}
Response Object
func (RestartClusterResponse) String ¶
func (o RestartClusterResponse) String() string
type RollingRestartReq ¶
type RollingRestartReq struct { // 操作角色。type的值只能为role。 Type string `json:"type"` // 实例类型(选择实例类型时至少需要一个数据节点),多个类型使用逗号隔开。例如: - ess-master对应Master节点。 - ess-client对应Client节点。 - ess-cold对应冷数据节点。 - ess对应数据节点。 - all对应所有节点。 Value string `json:"value"` }
func (RollingRestartReq) String ¶
func (o RollingRestartReq) String() string
type RollingRestartRequest ¶
type RollingRestartRequest struct { // 指定重启集群ID。 ClusterId string `json:"cluster_id"` Body *RollingRestartReq `json:"body,omitempty"` }
Request Object
func (RollingRestartRequest) String ¶
func (o RollingRestartRequest) String() string
type RollingRestartResponse ¶
type RollingRestartResponse struct {
HttpStatusCode int `json:"-"`
}
Response Object
func (RollingRestartResponse) String ¶
func (o RollingRestartResponse) String() string
type StartAutoCreateSnapshotsReq ¶
type StartAutoCreateSnapshotsReq struct { // 指定要恢复的索引名称,多个索引用逗号隔开,默认恢复所有索引。支持使用“\\*”匹配多个索引,例如:2018-06\\*,表示恢复名称前缀是2018-06的所有索引的数据。 0~1024个字符,不能包含空格和大写字母,且不能包含\\\"\\\\<|>/?特殊字符。 默认值为\\*,表示恢复所有索引。 Indices *string `json:"indices,omitempty"` // 设置快照保留的天数,范围是1~90。系统在半点时刻会自动删除超过保留天数的快照。 Keepday int32 `json:"keepday"` // 每天创建快照的时刻,只支持整点,后面需加上时区,格式为“HH:mm z”,“HH:mm”表示整点时间,“z”表示时区。比如“00:00 GMT+08:00”、“01:00 GMT+08:00”等。 Period string `json:"period"` // 自动创建的快照名称前缀,需要用户自己手动输入。只能包含1~32位小写字母、数字、中划线或者下划线,并且以小写字母开头。 Prefix string `json:"prefix"` }
func (StartAutoCreateSnapshotsReq) String ¶
func (o StartAutoCreateSnapshotsReq) String() string
type StartAutoCreateSnapshotsRequest ¶
type StartAutoCreateSnapshotsRequest struct { // 快照所属的集群的ID。 ClusterId string `json:"cluster_id"` Body *StartAutoCreateSnapshotsReq `json:"body,omitempty"` }
Request Object
func (StartAutoCreateSnapshotsRequest) String ¶
func (o StartAutoCreateSnapshotsRequest) String() string
type StartAutoCreateSnapshotsResponse ¶
type StartAutoCreateSnapshotsResponse struct {
HttpStatusCode int `json:"-"`
}
Response Object
func (StartAutoCreateSnapshotsResponse) String ¶
func (o StartAutoCreateSnapshotsResponse) String() string
type StopAutoCreateSnapshotsRequest ¶
type StopAutoCreateSnapshotsRequest struct { // 快照所属的集群的ID。 ClusterId string `json:"cluster_id"` }
Request Object
func (StopAutoCreateSnapshotsRequest) String ¶
func (o StopAutoCreateSnapshotsRequest) String() string
type StopAutoCreateSnapshotsResponse ¶
type StopAutoCreateSnapshotsResponse struct {
HttpStatusCode int `json:"-"`
}
Response Object
func (StopAutoCreateSnapshotsResponse) String ¶
func (o StopAutoCreateSnapshotsResponse) String() string
Source Files ¶
- model_create_cluster_backup_strategy_body.go
- model_create_cluster_body.go
- model_create_cluster_datastore_body.go
- model_create_cluster_elb_white_list.go
- model_create_cluster_instance_nics_body.go
- model_create_cluster_instance_volume_body.go
- model_create_cluster_load_balance.go
- model_create_cluster_public_eip.go
- model_create_cluster_public_eip_size.go
- model_create_cluster_public_ip_req.go
- model_create_cluster_public_kibana_elb_white_list.go
- model_create_cluster_public_kibana_req.go
- model_create_cluster_req.go
- model_create_cluster_request.go
- model_create_cluster_resp.go
- model_create_cluster_response.go
- model_create_cluster_roles_body.go
- model_create_cluster_tags_body.go
- model_pay_info_body.go
- model_restart_cluster_req.go
- model_restart_cluster_request.go
- model_restart_cluster_response.go
- model_rolling_restart_req.go
- model_rolling_restart_request.go
- model_rolling_restart_response.go
- model_start_auto_create_snapshots_req.go
- model_start_auto_create_snapshots_request.go
- model_start_auto_create_snapshots_response.go
- model_stop_auto_create_snapshots_request.go
- model_stop_auto_create_snapshots_response.go