- 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-
calm_wait_time
(integer
asint64
) - This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
-
cluster_reboot
(string
; allowed values: [forced
]) - Set to 'forced' to force a reboot as part of the upgrade plan
-
extended_maintenance
(boolean
) - If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
-
move_allocators
(array[
AllocatorMoveRequest
]
) -
move_instances
(array[
InstanceMoveRequest
]
) -
preferred_allocators
(array[
string
)]
- List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
-
reallocate_instances
(boolean
) - If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
-
timeout
(integer
asint64
) - The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
Was this helpful?
Thank you for your feedback.