ElasticsearchClusterInfo

The top level info object for an Elasticsearch cluster

Properties

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