ApmsInfo

edit

A container for information about a set of APM Servers.

Properties

edit
apms (array[ApmInfo], required)
match_count (integer as int32)
If a query is supplied, then the total number of clusters that matched
return_count (integer as int32, required)
The number of clusters actually returned

Example

edit
{
   "apms" : [
      {
         "deployment_id" : "string",
         "elasticsearch_cluster" : {
            "elasticsearch_id" : "string",
            "links" : {
               "some_property" : {
                  "need_elevated_permissions" : true
               }
            }
         },
         "external_links" : [
            {
               "id" : "string",
               "label" : "string",
               "uri" : "string"
            }
         ],
         "healthy" : true,
         "id" : "string",
         "links" : {
            "some_property" : null
         },
         "metadata" : {
            "cloud_id" : "string",
            "endpoint" : "string",
            "last_modified" : "2019-01-01T00:00:00Z",
            "ports" : {
               "http" : 0,
               "https" : 0,
               "transport_passthrough" : 0
            },
            "raw" : {},
            "version" : 0
         },
         "name" : "string",
         "plan_info" : {
            "current" : {
               "attempt_end_time" : "2019-01-01T00:00:00Z",
               "attempt_start_time" : "2019-01-01T00:00:00Z",
               "healthy" : true,
               "plan" : {
                  "apm" : {
                     "docker_image" : "string",
                     "system_settings" : {
                        "debug_enabled" : true,
                        "elasticsearch_password" : "string",
                        "elasticsearch_url" : "string",
                        "elasticsearch_username" : "string",
                        "kibana_url" : "string",
                        "secret_token" : "string"
                     },
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "cluster_topology" : [
                     {
                        "apm" : null,
                        "instance_configuration_id" : "string",
                        "size" : {
                           "resource" : "string",
                           "value" : 0
                        },
                        "zone_count" : 0
                     }
                  ],
                  "transient" : {
                     "plan_configuration" : {
                        "calm_wait_time" : 0,
                        "cluster_reboot" : "string",
                        "extended_maintenance" : true,
                        "move_allocators" : [
                           {
                              "allocator_down" : true,
                              "from" : "string",
                              "to" : [
                                 "string"
                              ]
                           }
                        ],
                        "move_instances" : [
                           {
                              "from" : "string",
                              "instance_down" : true,
                              "to" : [
                                 "string"
                              ]
                           }
                        ],
                        "preferred_allocators" : [
                           "string"
                        ],
                        "reallocate_instances" : true,
                        "timeout" : 0
                     },
                     "strategy" : {
                        "autodetect" : {},
                        "grow_and_shrink" : {},
                        "rolling" : {
                           "allow_inline_resize" : true,
                           "group_by" : "string",
                           "shard_init_wait_time" : 0,
                           "skip_synced_flush" : true
                        },
                        "rolling_grow_and_shrink" : {}
                     }
                  }
               },
               "plan_attempt_id" : "string",
               "plan_attempt_log" : [
                  {
                     "completed" : "2019-01-01T00:00:00Z",
                     "duration_in_millis" : 0,
                     "info_log" : [
                        {
                           "delta_in_millis" : 0,
                           "message" : "string",
                           "stage" : "string",
                           "timestamp" : "2019-01-01T00:00:00Z"
                        }
                     ],
                     "stage" : "string",
                     "started" : "2019-01-01T00:00:00Z",
                     "status" : "string",
                     "step_id" : "string"
                  }
               ],
               "plan_attempt_name" : "string",
               "plan_end_time" : "2019-01-01T00:00:00Z",
               "source" : {
                  "action" : "string",
                  "admin_id" : "string",
                  "date" : "2019-01-01T00:00:00Z",
                  "facilitator" : "string",
                  "remote_addresses" : [
                     "string"
                  ],
                  "user_id" : "string"
               }
            },
            "healthy" : true,
            "history" : [
               null
            ],
            "pending" : null
         },
         "region" : "string",
         "settings" : {
            "metadata" : {
               "contact_email" : "string",
               "hidden" : true,
               "name" : "string",
               "owner_id" : "string",
               "resources" : {
                  "cpu" : {
                     "boost" : true,
                     "hard_limit" : true
                  }
               },
               "subscription_level" : "string",
               "system_owned" : true
            }
         },
         "status" : "string",
         "topology" : {
            "healthy" : true,
            "instances" : [
               {
                  "allocator_id" : "string",
                  "container_started" : true,
                  "disk" : {
                     "disk_space_available" : 0,
                     "disk_space_used" : 0,
                     "storage_multiplier" : 0.1
                  },
                  "healthy" : true,
                  "instance_configuration" : {
                     "id" : "string",
                     "name" : "string",
                     "resource" : "string"
                  },
                  "instance_name" : "string",
                  "maintenance_mode" : true,
                  "memory" : {
                     "instance_capacity" : 0,
                     "instance_capacity_planned" : 0,
                     "memory_pressure" : 0,
                     "native_memory_pressure" : 0
                  },
                  "service_id" : "string",
                  "service_roles" : [
                     "string"
                  ],
                  "service_running" : true,
                  "service_version" : "string",
                  "zone" : "string"
               }
            ]
         }
      }
   ],
   "match_count" : 0,
   "return_count" : 0
}