- 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
- Troubleshooting
- API Reference
- Clusters - Elasticsearch - CRUD
- Clusters - Elasticsearch - CRUD - Configuration
- Set settings overrides (all instances)
- Set settings overrides
- Set cluster name
- Get cluster metadata in raw form
- Set cluster metadata
- Get cluster metadata settings
- Update cluster metadata settings
- Cancel monitoring
- Set monitoring
- Get plan
- Update plan
- Get plan activity
- Cancel pending plan
- Get pending plan
- Clusters - Elasticsearch - Commands
- Clusters - Elasticsearch - Support
- 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
AllocatedInstanceStatusAllocatorCapacityAllocatorCapacityMemoryAllocatorHealthStatusAllocatorInfoAllocatorMetadataItemAllocatorMetadataItemValueAllocatorMetadataItemsAllocatorMoveRequestAllocatorOverviewAllocatorSettingsAllocatorZoneInfoBasicFailedReplyBasicFailedReplyElementBoolQueryChangeSourceInfoClusterCommandResponseClusterCredentialsClusterCrudResponseClusterInstanceDiskInfoClusterInstanceInfoClusterInstanceMemoryInfoClusterMetadataInfoClusterMetadataSettingsClusterPlanStepInfoClusterPlanStepLogMessageInfoClusterSystemAlertClusterTopologyInfoCreateElasticsearchClusterRequestCreateKibanaClusterRequestCreateKibanaInCreateElasticsearchRequestElasticsearchClusterBlockingIssueElementElasticsearchClusterBlockingIssuesElasticsearchClusterInfoElasticsearchClusterInstanceSettingsOverridesElasticsearchClusterPlanElasticsearchClusterPlanInfoElasticsearchClusterPlansInfoElasticsearchClusterRoleElasticsearchClusterSecurityInfoElasticsearchClusterSettingsElasticsearchClusterTopologyElementElasticsearchClusterUserElasticsearchClustersInfoElasticsearchConfigurationElasticsearchHttpUserSettingsElasticsearchInfoElasticsearchMasterElementElasticsearchMasterInfoElasticsearchMonitoringInfoElasticsearchNodeTypeElasticsearchPlanControlConfigurationElasticsearchReplicaElementElasticsearchScriptTypeSettingsElasticsearchScriptingUserSettingsElasticsearchShardElementElasticsearchShardsInfoElasticsearchSystemSettingsElasticsearchUserBundleElasticsearchUserPluginEmptyResponseEnrollmentTokenRequestExternalHyperlinkGrowShrinkStrategyConfigHyperlinkInstanceMoveRequestJSONKibanaClusterInfoKibanaClusterPlanKibanaClusterPlanInfoKibanaClusterPlansInfoKibanaClusterTopologyElementKibanaClustersInfoKibanaConfigurationKibanaPlanControlConfigurationKibanaSubClusterInfoKibanaSystemSettingsListEnrollmentTokenElementListEnrollmentTokenReplyManagedMonitoringSettingsManagedSnapshotSettingsMatchQueryMoveClustersCommandResponseMoveClustersDetailsMoveClustersRequestMoveElasticsearchClusterConfigurationMoveElasticsearchClusterDetailsMoveKibanaClusterConfigurationMoveKibanaClusterDetailsNestedQueryPlanStrategyPlatformInfoPlatformServiceImageInfoPlatformServiceInfoQueryContainerQueryStringQueryRepositoryConfigRepositoryConfigsRequestEnrollmentTokenReplyRestoreSnapshotApiConfigurationRestoreSnapshotConfigurationRestoreSnapshotRepoConfigurationRollingGrowShrinkStrategyConfigRollingStrategyConfigSearchRequestSnapshotRepositoryConfigurationSnapshotStatusInfoStackVersionArchiveProcessingErrorStackVersionArchiveProcessingResultStackVersionConfigStackVersionConfigPostStackVersionConfigsStackVersionElasticsearchConfigStackVersionKibanaConfigStackVersionMetadataStackVersionTemplateFileHashStackVersionTemplateInfoTargetElasticsearchClusterTermQueryTiebreakerTopologyElementTlsPublicCertChainTransientElasticsearchPlanConfigurationTransientKibanaPlanConfiguration
- Script Reference
- Release Notes
- Elastic Cloud Enterprise version 1.1.5
- Elastic Cloud Enterprise version 1.1.4
- Elastic Cloud Enterprise version 1.1.3
- Elastic Cloud Enterprise version 1.1.2
- Elastic Cloud Enterprise version 1.1.1
- Elastic Cloud Enterprise version 1.1.0
- Elastic Cloud Enterprise version 1.0.2
- Elastic Cloud Enterprise version 1.0.1
- Elastic Cloud Enterprise version 1.0.0
- 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-
allocator_id(string) - The id of the allocator on which this instance is running (if the container is started or starting)
-
container_started(boolean, required) - Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)
-
disk(ClusterInstanceDiskInfo, required) - Information about the instance's storage capacity and use
-
healthy(boolean, required) - Whether the instance is healthy (ie started and running)
-
instance_name(string, required) - Whether the instance is healthy (ie started and running)
-
maintenance_mode(boolean, required) - Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)
-
memory(ClusterInstanceMemoryInfo, required) - Information about the instance's memory capacity and use
-
service_id(string) - The service-specific (eg Elasticsearch) id of the node, if available
-
service_roles(array[string)] - List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest
-
service_running(boolean, required) - Whether the service launched inside the container -ie Elasticsearch- is actually running
-
service_version(string) - The version of the service that the instance is running (eg Elasticsearch or Kibana), if available
-
zone(string) - The zone in which this instance is being allocated
Was this helpful?
Thank you for your feedback.