IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
AllocatorInfo
editAllocatorInfo
editThe overview information for the allocator.
Properties
edit-
allocator_id(string, required) - Identifier for this allocator
-
build_info(AllocatorBuildInfo) - Build Info of the artifact
-
capacity(AllocatorCapacity, required) - The total and used capacity of the allocator.
-
external_links(array[ExternalHyperlink], required) - External resources related to this allocator.
-
features(array[string, required)] - List of features associated with this allocator. Note this is only present for backwards compatibility purposes and is scheduled for removal in the next major version release.
-
host_ip(string, required) - Host IP of this allocator
-
instances(array[AllocatedInstanceStatus], required) -
metadata(array[MetadataItem], required) - Arbitrary metadata associated with this allocator
-
public_hostname(string, required) - Public hostname of this allocator
-
region(string) - The region that this allocator belongs to. Only populated in SaaS or federated ECE.
-
settings(AllocatorSettings, required) - The settings for the allocator.
-
status(AllocatorHealthStatus, required) - The health status of the allocator.
-
zone_id(string, required) - Identifier of the zone
Example
edit{
"allocator_id" : "string",
"build_info" : {
"commit_hash" : "string",
"version" : "string"
},
"capacity" : {
"memory" : {
"total" : 0,
"used" : 0
}
},
"external_links" : [
{
"id" : "string",
"label" : "string",
"uri" : "string"
}
],
"features" : [
"string"
],
"host_ip" : "string",
"instances" : [
{
"cluster_healthy" : true,
"cluster_id" : "string",
"cluster_name" : "string",
"cluster_type" : "string",
"deployment_id" : "string",
"healthy" : true,
"instance_configuration_id" : "string",
"instance_name" : "string",
"moving" : true,
"node_memory" : 0,
"plans_info" : {
"pending" : true,
"version" : "string",
"zone_count" : 0
}
}
],
"metadata" : [
{
"key" : "string",
"value" : "string"
}
],
"public_hostname" : "string",
"region" : "string",
"settings" : {
"capacity" : 0
},
"status" : {
"connected" : true,
"healthy" : true,
"maintenance_mode" : true,
"maintenance_mode_timestamp" : "2019-01-01T00:00:00Z"
},
"zone_id" : "string"
}