models

Documentation

Index

• type Assets
• type AuthConfig
• type AutoSnapshot
• type AzConf
• type ConstraintsConf
• type Features
• type IndexTemplateCron
• type IndexTemplateCronConf
• type Instance
• type InstanceClass
• type InstanceClassDetail
• type InstanceClassSpec
• type InstanceName
• type InstanceNode
• type InstanceSpec
• type InstanceSpecConf
• type InternalEndpoint
• type NodeConf
• type Resource
• type Snapshot
• type Tag

Types

type Assets

type Assets struct {

	/* es实例ID (Optional) */
	InstanceId string `json:"instanceId"`

	/* es实例名称 (Optional) */
	InstanceName string `json:"instanceName"`

	/* es实例版本 (Optional) */
	InstanceVersion string `json:"instanceVersion"`

	/* es http endpoint (Optional) */
	Endpoint string `json:"endpoint"`

	/* 资源信息 (Optional) */
	Resources []Resource `json:"resources"`

	/* es实例是否开启鉴权 (Optional) */
	IsAuth bool `json:"isAuth"`
}

type AuthConfig

type AuthConfig struct {

	/* 是否开启身份验证；true为开启，false为不开启 (Optional) */
	AuthEnabled *bool `json:"authEnabled"`

	/* 用户名. 不可为空，支持数字、大小写字母、英文下划线“_”及中划线“-”，且不超过32字符 (Optional) */
	Username *string `json:"username"`

	/* 密码. 需6到128位，包括大小写字母、数字、和特殊字符（[a-z],[A-Z],[0-9]和[-!@#$%&^*+=_:;,.?]） (Optional) */
	Password *string `json:"password"`
}

type AutoSnapshot

type AutoSnapshot struct {

	/* 是否开启自动备份；true为开启，false为不开启 (Optional) */
	Open *bool `json:"open"`

	/* 自动备份时间，0时区的小时数，[0，24）范围内取整 (Optional) */
	Hour *int `json:"hour"`
}

type AzConf

type AzConf struct {

	/* azId (Optional) */
	AzId string `json:"azId"`

	/* 数据节点 (Optional) */
	DataNode NodeConf `json:"dataNode"`

	/* 专有主节点 (Optional) */
	MasterNode NodeConf `json:"masterNode"`

	/* 协调节点 (Optional) */
	CoordinatingNode NodeConf `json:"coordinatingNode"`
}

type ConstraintsConf

type ConstraintsConf struct {

	/* 磁盘类型，zbs表示SSD云硬盘， local_ssd表示本地SSD盘 (Optional) */
	StorageType string `json:"storageType"`

	/* 是否在售 (Optional) */
	OnSale bool `json:"onSale"`

	/* 规格代码，规格代码详情参见：https://docs.jdcloud.com/cn/jcs-for-elasticsearch/specifications (Optional) */
	ClassCode []string `json:"classCode"`

	/* 节点数最小值 (Optional) */
	MinCount int `json:"minCount"`

	/* 节点数最大值 (Optional) */
	MaxCount int `json:"maxCount"`

	/* 节点数默认值 (Optional) */
	DefaultCount int `json:"defaultCount"`

	/* 节点数步长 (Optional) */
	StepCount int `json:"stepCount"`

	/* 是否包含存储 (Optional) */
	StorageScale bool `json:"storageScale"`

	/* 存储最小值 (Optional) */
	MinStorageGB int `json:"minStorageGB"`

	/* 存储最大值 (Optional) */
	MaxStorageGB int `json:"maxStorageGB"`

	/* 存储默认值 (Optional) */
	DefaultStorageGB int `json:"defaultStorageGB"`

	/* 存储步长 (Optional) */
	StepStorageGB int `json:"stepStorageGB"`
}

type Features

type Features struct {

	/* 是否支持身份验证功能；true为支持，false为不支持 (Optional) */
	Auth bool `json:"auth"`
}

type IndexTemplateCron

type IndexTemplateCron struct {

	/* 任务ID (Optional) */
	TaskID string `json:"taskID"`

	/* 创建时间，遵循ISO8601标准，使用UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ (Optional) */
	CreateTime string `json:"createTime"`

	/* 任务配置信息 (Optional) */
	Settings IndexTemplateCronConf `json:"settings"`
}

type IndexTemplateCronConf

type IndexTemplateCronConf struct {

	/* 索引模板名称  */
	TemplateName string `json:"templateName"`

	/* 任务起始执行时间，遵循ISO8601标准，使用UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ  */
	BeginTime string `json:"beginTime"`

	/* 任务执行频率, day： 每天，week： 每周，month：每月  */
	Cycle string `json:"cycle"`

	/* 索引前缀  */
	IndexPrefix string `json:"indexPrefix"`

	/* 索引后缀格式, "yyyy-MM-dd", "yyyy.MM.dd", "yyyy_MM_dd", "yyyyMMdd", "yyyyww", "yyyy-MM", "yyyy.MM", "yyyy_MM", "yyyyMM"  */
	IndexSuffixFormat string `json:"indexSuffixFormat"`

	/* 提前创建索引天数  */
	AheadOfDay int `json:"aheadOfDay"`

	/* 是否开启自动删除索引  */
	IsAutoDelete bool `json:"isAutoDelete"`

	/* 索引保留天数, 开启自动删除索引后生效  */
	ReserveOfDay int `json:"reserveOfDay"`
}

type Instance

type Instance struct {

	/* 实例ID (Optional) */
	InstanceId string `json:"instanceId"`

	/* 实例名称 (Optional) */
	InstanceName string `json:"instanceName"`

	/* 实例版本，目前支持5.6.9和6.5.4两个版本 (Optional) */
	InstanceVersion string `json:"instanceVersion"`

	/* 实例状态，running：运行，error：错误，creating：创建中，changing：变配中，stop：已停止，processing：处理中 (Optional) */
	InstanceStatus string `json:"instanceStatus"`

	/* 实例的配置信息 (Optional) */
	InstanceClass InstanceClass `json:"instanceClass"`

	/* 创建时间，遵循ISO8601标准，使用UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ (Optional) */
	CreateTime string `json:"createTime"`

	/* AZ信息，各AZ编码详见：https://docs.jdcloud.com/cn/jcs-for-elasticsearch/restrictions (Optional) */
	AzId string `json:"azId"`

	/* 所属VPC的ID (Optional) */
	VpcId string `json:"vpcId"`

	/* 所属子网的ID (Optional) */
	SubnetId string `json:"subnetId"`

	/* 计费信息 (Optional) */
	Charge charge.Charge `json:"charge"`

	/* 内网地址 (Optional) */
	InternalEndpoint InternalEndpoint `json:"internalEndpoint"`

	/* deprecated，见internalEndpoint (Optional) */
	Endpoint string `json:"endpoint"`

	/* kibana地址 (Optional) */
	KibanaUrl string `json:"kibanaUrl"`

	/* head地址 (Optional) */
	HeadUrl string `json:"headUrl"`

	/* 值为v4&v6时支持ipv6和ipv4, 值为空时仅支持ipv4 (Optional) */
	IpVersion string `json:"ipVersion"`

	/* Tag信息 (Optional) */
	Tags []Tag `json:"tags"`

	/* 是否开启了专用主节点，true为开启，false为不开启 (Optional) */
	DedicatedMaster bool `json:"dedicatedMaster"`

	/* 是否开启了协调节点，true为开启，false为不开启 (Optional) */
	Coordinating bool `json:"coordinating"`

	/* kibana floatIp地址 (Optional) */
	KibanaFiUrl string `json:"kibanaFiUrl"`
}

type InstanceClass

type InstanceClass struct {

	/* data节点规格代码，规格代码对照关系参见：https://docs.jdcloud.com/cn/jcs-for-elasticsearch/specifications (Optional) */
	NodeClass string `json:"nodeClass"`

	/* data节点cpu核数 (Optional) */
	NodeCpu int `json:"nodeCpu"`

	/* data节点内存单位GB (Optional) */
	NodeMemoryGB int `json:"nodeMemoryGB"`

	/* data节点存储大小单位GB (Optional) */
	NodeDiskGB int `json:"nodeDiskGB"`

	/* data节点存储类型 (Optional) */
	NodeDiskType string `json:"nodeDiskType"`

	/* data节点数量 (Optional) */
	NodeCount int `json:"nodeCount"`

	/* master节点规格代码，规格代码对照关系参见：https://docs.jdcloud.com/cn/jcs-for-elasticsearch/specifications (Optional) */
	MasterClass string `json:"masterClass"`

	/* master节点cpu核数 (Optional) */
	MasterCpu int `json:"masterCpu"`

	/* master节点内存单位GB (Optional) */
	MasterMemoryGB int `json:"masterMemoryGB"`

	/* master节点存储大小单位GB (Optional) */
	MasterDiskGB int `json:"masterDiskGB"`

	/* master节点存储类型 (Optional) */
	MasterDiskType string `json:"masterDiskType"`

	/* master节点数量 (Optional) */
	MasterCount int `json:"masterCount"`

	/* coordinating节点规格代码，规格代码对照关系参见：https://docs.jdcloud.com/cn/jcs-for-elasticsearch/specifications (Optional) */
	CoordinatingClass string `json:"coordinatingClass"`

	/* coordinating节点cpu核数 (Optional) */
	CoordinatingCpu int `json:"coordinatingCpu"`

	/* coordinating节点内存单位GB (Optional) */
	CoordinatingMemoryGB int `json:"coordinatingMemoryGB"`

	/* coordinating节点存储大小单位GB (Optional) */
	CoordinatingDiskGB int `json:"coordinatingDiskGB"`

	/* coordinating节点存储类型 (Optional) */
	CoordinatingDiskType string `json:"coordinatingDiskType"`

	/* coordinating节点数量 (Optional) */
	CoordinatingCount int `json:"coordinatingCount"`
}

type InstanceClassDetail

type InstanceClassDetail struct {

	/* 规格代码，规格代码详情参见：https://docs.jdcloud.com/cn/jcs-for-elasticsearch/specifications (Optional) */
	InstanceClassCode string `json:"instanceClassCode"`

	/* cpu核数 (Optional) */
	Cpu int `json:"cpu"`

	/* 内存单位GB (Optional) */
	MemoryGB int `json:"memoryGB"`

	/* 存储大小单位GB (Optional) */
	DiskGB int `json:"diskGB"`
}

type InstanceClassSpec

type InstanceClassSpec struct {

	/* data节点规格代码，详细规格请参考：https://docs.jdcloud.com/cn/jcs-for-elasticsearch/specifications (Optional) */
	NodeClass *string `json:"nodeClass"`

	/* data节点存储大小，单位GB。单点存储规格范围20-4000GB，只允许输入整数且步长为10GB， (Optional) */
	NodeDiskGB *int `json:"nodeDiskGB"`

	/* data节点存储类型，包括zbs(性能型SSD云盘)、ssd.gp1(通用型SSD云盘)、hdd.std1(容量型HDD云盘)，默认zbs (Optional) */
	NodeDiskType *string `json:"nodeDiskType"`

	/* data节点数量，各region和可用区的节点数量规格限制不完全相同，详情请参考：https://docs.jdcloud.com/cn/jcs-for-elasticsearch/restrictions (Optional) */
	NodeCount *int `json:"nodeCount"`

	/* master节点规格代码，与data节点规格代码一致。 (Optional) */
	MasterClass *string `json:"masterClass"`

	/* master节点存储大小，固定为20GB，不可调整 (Optional) */
	MasterDiskGB *int `json:"masterDiskGB"`

	/* master节点存储类型，默认zbs (Optional) */
	MasterDiskType *string `json:"masterDiskType"`

	/* master节点数量，固定为3，不可调整 (Optional) */
	MasterCount *int `json:"masterCount"`

	/* coordinating节点规格代码，与data节点规格代码一致。 (Optional) */
	CoordinatingClass *string `json:"coordinatingClass"`

	/* coordinating节点存储大小，固定为20GB，不可调整 (Optional) */
	CoordinatingDiskGB *int `json:"coordinatingDiskGB"`

	/* coordinating存储类型，默认zbs (Optional) */
	CoordinatingDiskType *string `json:"coordinatingDiskType"`

	/* coordinating节点数量，各region和可用区的节点数量规格限制不完全相同，详情请参考：https://docs.jdcloud.com/cn/jcs-for-elasticsearch/restrictions (Optional) */
	CoordinatingCount *int `json:"coordinatingCount"`
}

type InstanceName

type InstanceName struct {

	/* 实例ID (Optional) */
	ResourceId string `json:"resourceId"`

	/* 实例名称 (Optional) */
	ResourceName string `json:"resourceName"`
}

type InstanceNode

type InstanceNode struct {

	/* 节点名称 (Optional) */
	NodeName string `json:"nodeName"`
}

type InstanceSpec

type InstanceSpec struct {

	/* 私有网络vpcId  */
	VpcId string `json:"vpcId"`

	/* 子网subnetId  */
	SubnetId string `json:"subnetId"`

	/* es版本，当前支持5.6.9和6.5.4  */
	InstanceVersion string `json:"instanceVersion"`

	/* es集群名称，不可为空，只支持大小写字母、数字、英文下划线或者中划线，以字母开头且不能超过32位  */
	InstanceName string `json:"instanceName"`

	/* 可用区，各可用区编码请参考：https://docs.jdcloud.com/cn/jcs-for-elasticsearch/restrictions  */
	AzId string `json:"azId"`

	/* 规格配置，规格代码请参考：https://docs.jdcloud.com/cn/jcs-for-elasticsearch/specifications  */
	InstanceClass *InstanceClassSpec `json:"instanceClass"`

	/* 是否支持ipv6，支持值为v4&v6,不支持为空 (Optional) */
	IpVersion *string `json:"ipVersion"`

	/* 是否包含专用主节点，默认false (Optional) */
	DedicatedMaster *bool `json:"dedicatedMaster"`

	/* 是否包含协调节点，默认false (Optional) */
	Coordinating *bool `json:"coordinating"`

	/* 自动快照设置。 (Optional) */
	AutoSnapshot *AutoSnapshot `json:"autoSnapshot"`

	/* es数据面身份验证设置信息 (Optional) */
	AuthConfig *AuthConfig `json:"authConfig"`
}

type InstanceSpecConf

type InstanceSpecConf struct {

	/* es版本 (Optional) */
	Version []string `json:"version"`

	/* 规格详情 (Optional) */
	InstanceClassDetail []InstanceClassDetail `json:"instanceClassDetail"`

	/* az的配置 (Optional) */
	AzConf []AzConf `json:"azConf"`
}

type InternalEndpoint

type InternalEndpoint struct {

	/* es http endpoint (Optional) */
	EsHttpEndpoint string `json:"esHttpEndpoint"`

	/* es tcp endpoint (Optional) */
	EsTcpEndpoint []string `json:"esTcpEndpoint"`

	/* kibana endpoint (Optional) */
	KibanaEndpoint string `json:"kibanaEndpoint"`
}

type NodeConf

type NodeConf struct {

	/* 磁盘类型，支持两种：zbs（SSD云硬盘）和local_ssd（本地SSD盘），默认为zbs (Optional) */
	StorageType []string `json:"storageType"`

	/* 限制条件 (Optional) */
	Constraints ConstraintsConf `json:"constraints"`
}

type Resource

type Resource struct {

	/* 资源名称，即节点名称 (Optional) */
	ResName string `json:"resName"`

	/* 节点宿主机IP (Optional) */
	HostIp string `json:"hostIp"`

	/* 节点IP及端口 (Optional) */
	IpPort string `json:"ipPort"`
}

type Snapshot

type Snapshot struct {

	/* 快照ID (Optional) */
	SnapshotId string `json:"snapshotId"`

	/* 快照类型，Auto：自动，Manual：人工 (Optional) */
	Type string `json:"type"`

	/* 创建时间，遵循ISO8601标准，使用UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ (Optional) */
	CreateTime string `json:"createTime"`

	/* 备份的索引 (Optional) */
	Indices []string `json:"indices"`

	/* 快照状态，Available：可用，Unavailable：不可用，Creating：创建中 (Optional) */
	Status string `json:"status"`
}

type Tag

type Tag struct {

	/* 用于标识资源分类的Tag键 (Optional) */
	Key string `json:"key"`

	/* 用于标识资源分类的Tag值 (Optional) */
	Value string `json:"value"`
}