- Elastic Cloud Enterprise - Elastic Cloud on your Infrastructure: other versions:
- What Is Elastic Cloud Enterprise?
- Getting Started
- Configuring Your Installation
- Securing Your Installation
- Monitoring Your Installation
- Administering Your Installation
- Administering Clusters
- Use Cases
- Troubleshooting
- API Reference
- Clusters - Elasticsearch - CRUD
- Clusters - Elasticsearch - CRUD - Configuration
- Clusters - Elasticsearch - Commands
- Clusters - Kibana - CRUD
- Clusters - Kibana - CRUD - Configuration
- Clusters - Kibana - Commands
- Platform
- Platform - Allocators
- Platform - Configuration - Security
- Platform - Configuration - TLS
- Platform - Repository - CRUD
- Stack - CRUD
- Definitions
AllocatedInstanceStatus
AllocatorCapacity
AllocatorCapacityMemory
AllocatorHealthStatus
AllocatorInformation2
AllocatorMoveRequest
AllocatorOverview
AllocatorZoneInformation
BasicFailedReply
BasicFailedReplyElement
ClusterCredentials
ClusterCrudResponse
ClusterInstanceDiskInfo
ClusterInstanceInfo
ClusterInstanceMemoryInfo
ClusterMetadataInfo
ClusterPlanStepInfo
ClusterPlanStepLogMessageInfo
ClusterTopologyInfo
CreateElasticsearchClusterRequest
CreateKibanaClusterRequest
ElasticsearchClusterInfo
ElasticsearchClusterPlan
ElasticsearchClusterPlanInfo
ElasticsearchClusterPlansInfo
ElasticsearchClusterRole
ElasticsearchClusterSecurityInfo
ElasticsearchClusterSettings
ElasticsearchClusterTopologyElement
ElasticsearchClusterUser
ElasticsearchClustersInfo
ElasticsearchConfiguration
ElasticsearchHttpUserSettings
ElasticsearchInfo
ElasticsearchMasterElement
ElasticsearchMasterInfo
ElasticsearchMonitoringInfo
ElasticsearchNodeType
ElasticsearchPlanControlConfiguration
ElasticsearchReplicaElement
ElasticsearchScriptTypeSettings
ElasticsearchScriptingUserSettings
ElasticsearchShardElement
ElasticsearchShardsInfo
ElasticsearchSystemSettings
ElasticsearchUserBundle
ElasticsearchUserPlugin
EmptyResponse
EnrollmentTokenRequest
GrowShrinkStrategyConfig
Hyperlink
InstanceMoveRequest
JSON
KibanaClusterInfo
KibanaClusterPlan
KibanaClusterPlanInfo
KibanaClusterPlansInfo
KibanaClusterTopologyElement
KibanaClustersInfo
KibanaConfiguration
KibanaPlanControlConfiguration
KibanaSubClusterInfo
KibanaSystemSettings
ListEnrollmentTokenElement
ListEnrollmentTokenReply
ManagedMonitoringSettings
ManagedSnapshotSettings
PlanStrategy
PlatformInfo
PlatformServiceImageInfo
PlatformServiceInfo
RepositoryConfig
RepositoryConfigs
RequestEnrollmentTokenReply
RestoreSnapshotApiConfiguration
RestoreSnapshotConfiguration
RestoreSnapshotRepoConfiguration
RollingStrategyConfig
SnapshotRepositoryConfiguration
SnapshotStatusInfo
StackVersionArchiveProcessingError
StackVersionArchiveProcessingResult
StackVersionConfig
StackVersionConfigPost
StackVersionConfigs
StackVersionElasticsearchConfig
StackVersionKibanaConfig
StackVersionTemplateFileHash
StackVersionTemplateInfo
TargetElasticsearchCluster
TiebreakerTopologyElement
TlsPublicCertChain
TransientElasticsearchPlanConfiguration
TransientKibanaPlanConfiguration
- Script Reference
- Release Notes
- About This Product
It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Properties
editProperties
edit-
associated_kibana_clusters
(array[
KibanaSubClusterInfo
]
, required) -
cluster_id
(string
, required) - The id of the cluster
-
cluster_name
(string
, required) - The name of the cluster
-
elasticsearch
(ElasticsearchInfo
, required) - Information about the Elasticsearch cluster (indices, masters)
-
elasticsearch_monitoring_info
(ElasticsearchMonitoringInfo
, required) - Information about this cluster's ECE-managed XPack Monitoring status
-
healthy
(boolean
, required) - Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)
-
links
(map[string,
Hyperlink
]
) - A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
-
metadata
(ClusterMetadataInfo
, required) - The cluster metadata stores a combination of public and internal state and configuration for a cluster. The unstructured content is undocumented unless explicitly stated elsewhere in the docs
-
plan_info
(ElasticsearchClusterPlansInfo
, required) - Information about the current, pending, and past plans of a cluster
-
security
(ElasticsearchClusterSecurityInfo
, required) - For 2.x clusters, information about the users and roles. For 5.x, the Kibana management UI should be used
-
snapshots
(SnapshotStatusInfo
, required) - Information about this cluster's snapshot status (health, etc.)
-
status
(string
; allowed values: [Initializing
,Stopping
,Stopped
,Rebooting
,Restarting
,Reconfiguring
,Started
]) - Cluster status
-
topology
(ClusterTopologyInfo
, required) - A description of the cluster topology (the different instances/containers making up the cluster, and where they are located
Was this helpful?
Thank you for your feedback.