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.
PlatformInfo
editPlatformInfo
editInformation about the platform.
Properties
edit-
eula_accepted(boolean, required) - Indicates if the End User License Agreement been accepted
-
phone_home_enabled(boolean, required) - Is the phone-home service, which returns anonymized usage statistics to Elastic, enabled
-
regions(array[RegionInfo], required) - Information on regions
-
services(array[PlatformServiceInfo], required) -
unreachable_regions(array[UnreachableRegionInfo], required) - Information on currently unreachable regions
-
version(string, required) - Platform version
Example
edit{
"eula_accepted" : true,
"phone_home_enabled" : true,
"regions" : [
{
"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"
}
]
}
}
],
"services" : [
{
"image" : [
{
"hash" : "string",
"id" : "string",
"tag" : "string",
"version" : "string"
}
],
"type" : "string"
}
],
"unreachable_regions" : [
{
"region_id" : "string"
}
],
"version" : "string"
}