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
-
external_links(array[ExternalHyperlink], required) - External resources related to the cluster
-
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
-
system_alerts(array[ClusterSystemAlert]) - List of cluster system alerts
-
topology(ClusterTopologyInfo, required) - A description of the cluster topology (the different instances/containers making up the cluster, and where they are located