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.
RegionInfo
editRegionInfo
editInformation about a region.
Properties
edit-
allocators(AllocatorsSummary, required) - Information about allocators
-
constructors(ConstructorOverview, required) - Information about constructors
-
container_sets_status(ContainerSetsSummary, required) - Information about container sets
-
coordinators(CoordinatorsSummary, required) - Information about coordinators
-
elasticsearch_clusters_status(ElasticsearchClustersSummary, required) - Information about Elasticsearch clusters
-
kibana_clusters_status(KibanaClustersSummary, required) - Information about Kibana clusters
-
proxies(ProxiesSummary, required) - Information about proxies
-
region_id(string, required) - Identifier of this region
-
resources(PlatformResourcesSummary, required) - Information about resources
-
runners(RunnersSummary, required) - Information about runners
-
zookeeper_states(ZookeeperSummary, required) - Information about the Zookeeper state
Example
edit{
"allocators" : {
"healthy" : true,
"zone_summaries" : [
{
"connected_allocators" : 0,
"connected_capacity" : 0,
"instances" : 0,
"max_available_capacity" : 0,
"total_allocators" : 0,
"zone_id" : "string"
}
]
},
"constructors" : {
"constructors" : [
{
"constructor_id" : "string",
"status" : {
"connected" : true,
"maintenance_mode" : true
}
}
]
},
"container_sets_status" : {
"healthy" : true,
"healthy_container_sets_count" : 0,
"unhealthy_container_sets" : [
{
"container_set_id" : "string",
"containers_created_count" : 0,
"containers_expected_running_count" : 0,
"containers_running_count" : 0,
"containers_started_count" : 0,
"healthy" : true,
"hidden" : true
}
],
"unhealthy_container_sets_count" : 0
},
"coordinators" : {
"coordinators" : [
{
"attributes" : {
"some_property" : "string"
},
"client_port" : 0,
"election_port" : 0,
"leader_port" : 0,
"name" : "string",
"public_hostname" : "string"
}
]
},
"elasticsearch_clusters_status" : {
"healthy" : true,
"healthy_count" : 0,
"unhealthy_clusters_summaries" : [
{
"blocks_healthy" : true,
"cluster_id" : "string",
"healthy" : true,
"hidden" : true,
"instances_healthy" : true,
"master_healthy" : true,
"plan_healthy" : true,
"shards_healthy" : true,
"snapshot_healthy" : true
}
],
"unhealthy_count" : 0
},
"kibana_clusters_status" : {
"healthy" : true,
"healthy_count" : 0,
"unhealthy_clusters_summaries" : [
{
"cluster_id" : "string",
"healthy" : true,
"hidden" : true,
"instances_healthy" : true,
"plan_healthy" : true
}
],
"unhealthy_count" : 0
},
"proxies" : {
"expected_proxies_count" : 0,
"healthy" : true,
"proxies" : [
{
"healthy" : true,
"proxy_id" : "string"
}
],
"proxies_count" : 0
},
"region_id" : "string",
"resources" : {
"account_count" : 0,
"available_count" : 0,
"healthy" : true,
"minimum_available_count" : 0,
"missing_count" : 0,
"used_count" : 0
},
"runners" : {
"connected_capacity" : 0,
"connected_runners" : 0,
"containers_count" : 0,
"healthy" : true,
"max_available_capacity" : 0,
"total_runners" : 0
},
"zookeeper_states" : {
"states" : [
{
"id" : "string",
"state" : "string"
}
]
}
}