ElasticsearchClustersInfoedit

Information about a set of Elasticsearch clusters.

Propertiesedit

elasticsearch_clusters (array[ElasticsearchClusterInfo], 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

Exampleedit

{
   "elasticsearch_clusters" : [
      {
         "associated_apm_clusters" : [
            {
               "apm_id" : "string",
               "enabled" : true,
               "links" : {
                  "some_property" : {
                     "need_elevated_permissions" : true
                  }
               }
            }
         ],
         "associated_appsearch_clusters" : [
            {
               "app_search_id" : "string",
               "enabled" : true,
               "links" : {
                  "some_property" : null
               }
            }
         ],
         "associated_kibana_clusters" : [
            {
               "enabled" : true,
               "kibana_id" : "string",
               "links" : {
                  "some_property" : null
               }
            }
         ],
         "ccs" : {
            "healthy" : true,
            "remote_clusters" : [
               {
                  "compatible" : true,
                  "id" : "string",
                  "version" : "string"
               }
            ]
         },
         "cluster_id" : "string",
         "cluster_name" : "string",
         "deployment_id" : "string",
         "elasticsearch" : {
            "blocking_issues" : {
               "cluster_level" : [
                  {
                     "description" : "string",
                     "instances" : [
                        "string"
                     ]
                  }
               ],
               "healthy" : true,
               "index_level" : [
                  null
               ]
            },
            "healthy" : true,
            "master_info" : {
               "healthy" : true,
               "instances_with_no_master" : [
                  "string"
               ],
               "masters" : [
                  {
                     "instances" : [
                        "string"
                     ],
                     "master_instance_name" : "string",
                     "master_node_id" : "string"
                  }
               ]
            },
            "shard_info" : {
               "available_shards" : [
                  {
                     "instance_name" : "string",
                     "shard_count" : 0
                  }
               ],
               "healthy" : true,
               "unavailable_replicas" : [
                  {
                     "instance_name" : "string",
                     "replica_count" : 0
                  }
               ],
               "unavailable_shards" : [
                  null
               ]
            }
         },
         "elasticsearch_monitoring_info" : {
            "destination_cluster_ids" : [
               "string"
            ],
            "healthy" : true,
            "last_modified" : "2019-01-01T00:00:00Z",
            "last_update_status" : "string",
            "source_cluster_ids" : [
               "string"
            ]
         },
         "external_links" : [
            {
               "id" : "string",
               "label" : "string",
               "uri" : "string"
            }
         ],
         "healthy" : true,
         "links" : {
            "some_property" : null
         },
         "locked" : true,
         "metadata" : {
            "cloud_id" : "string",
            "endpoint" : "string",
            "last_modified" : "2019-01-01T00:00:00Z",
            "ports" : {
               "http" : 0,
               "https" : 0
            },
            "raw" : {},
            "version" : 0
         },
         "plan_info" : {
            "current" : {
               "attempt_end_time" : "2019-01-01T00:00:00Z",
               "attempt_start_time" : "2019-01-01T00:00:00Z",
               "healthy" : true,
               "plan" : {
                  "cluster_topology" : [
                     {
                        "allocator_filter" : {},
                        "elasticsearch" : {
                           "curation" : {
                              "from_instance_configuration_id" : "string",
                              "to_instance_configuration_id" : "string"
                           },
                           "docker_image" : "string",
                           "enabled_built_in_plugins" : [
                              "string"
                           ],
                           "node_attributes" : {
                              "some_property" : "string"
                           },
                           "system_settings" : {
                              "auto_create_index" : true,
                              "default_shards_per_index" : 0,
                              "destructive_requires_name" : true,
                              "enable_close_index" : true,
                              "monitoring_collection_interval" : 0,
                              "monitoring_history_duration" : "string",
                              "reindex_whitelist" : [
                                 "string"
                              ],
                              "scripting" : {
                                 "expressions_enabled" : true,
                                 "file" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 },
                                 "inline" : null,
                                 "mustache_enabled" : true,
                                 "painless_enabled" : true,
                                 "stored" : null
                              },
                              "use_disk_threshold" : true,
                              "watcher_trigger_engine" : "string"
                           },
                           "user_bundles" : [
                              {
                                 "elasticsearch_version" : "string",
                                 "name" : "string",
                                 "url" : "string"
                              }
                           ],
                           "user_plugins" : [
                              {
                                 "elasticsearch_version" : "string",
                                 "name" : "string",
                                 "url" : "string"
                              }
                           ],
                           "user_settings_json" : {},
                           "user_settings_override_json" : {},
                           "user_settings_override_yaml" : "string",
                           "user_settings_yaml" : "string",
                           "version" : "string"
                        },
                        "instance_configuration_id" : "string",
                        "memory_per_node" : 0,
                        "node_configuration" : "string",
                        "node_count_per_zone" : 0,
                        "node_type" : {
                           "data" : true,
                           "ingest" : true,
                           "master" : true,
                           "ml" : true
                        },
                        "size" : {
                           "resource" : "string",
                           "value" : 0
                        },
                        "zone_count" : 0
                     }
                  ],
                  "deployment_template" : {
                     "id" : "string",
                     "version" : "string"
                  },
                  "elasticsearch" : null,
                  "tiebreaker_override" : true,
                  "tiebreaker_topology" : {
                     "memory_per_node" : 0
                  },
                  "transient" : {
                     "cluster_settings_json" : {},
                     "plan_configuration" : {
                        "calm_wait_time" : 0,
                        "cluster_reboot" : "string",
                        "extended_maintenance" : true,
                        "max_snapshot_age" : 0,
                        "max_snapshot_attempts" : 0,
                        "move_allocators" : [
                           {
                              "allocator_down" : true,
                              "from" : "string",
                              "to" : [
                                 "string"
                              ]
                           }
                        ],
                        "move_instances" : [
                           {
                              "from" : "string",
                              "instance_down" : true,
                              "to" : [
                                 "string"
                              ]
                           }
                        ],
                        "move_only" : true,
                        "override_failsafe" : true,
                        "preferred_allocators" : [
                           "string"
                        ],
                        "reallocate_instances" : true,
                        "skip_data_migration" : true,
                        "skip_post_upgrade_steps" : true,
                        "skip_snapshot" : true,
                        "skip_snapshot_post_major_upgrade" : true,
                        "skip_upgrade_checker" : true,
                        "timeout" : 0
                     },
                     "restore_snapshot" : {
                        "repository_config" : {
                           "raw_settings" : {}
                        },
                        "repository_name" : "string",
                        "restore_payload" : {
                           "indices" : [
                              "string"
                           ],
                           "raw_settings" : {}
                        },
                        "snapshot_name" : "string",
                        "source_cluster_id" : "string",
                        "strategy" : "string"
                     },
                     "strategy" : {
                        "grow_and_shrink" : {},
                        "rolling" : {
                           "allow_inline_resize" : true,
                           "group_by" : "string",
                           "shard_init_wait_time" : 0,
                           "skip_synced_flush" : true
                        },
                        "rolling_grow_and_shrink" : {}
                     }
                  },
                  "zone_count" : 0
               },
               "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",
         "security" : {
            "last_modified" : "2019-01-01T00:00:00Z",
            "roles" : {},
            "users" : [
               {
                  "password_hash" : "string",
                  "username" : "string"
               }
            ],
            "users_roles" : [
               {
                  "roles" : [
                     "string"
                  ],
                  "username" : "string"
               }
            ],
            "version" : 0
         },
         "settings" : {
            "ccs" : {
               "remote_clusters" : {
                  "some_property" : {
                     "cluster_id" : "string",
                     "skip_unavailable" : true
                  }
               }
            },
            "curation" : {
               "specs" : [
                  {
                     "index_pattern" : "string",
                     "trigger_interval_seconds" : 0
                  }
               ]
            },
            "dedicated_masters_threshold" : 0,
            "ip_filtering" : {
               "rulesets" : [
                  "string"
               ]
            },
            "metadata" : {
               "contact_email" : "string",
               "hidden" : true,
               "name" : "string",
               "owner_id" : "string",
               "resources" : {
                  "cpu" : {
                     "boost" : true,
                     "hard_limit" : true
                  }
               },
               "subscription_level" : "string",
               "system_owned" : true
            },
            "monitoring" : {
               "target_cluster_id" : "string"
            },
            "snapshot" : {
               "enabled" : true,
               "interval" : "string",
               "pending_interval" : "string",
               "repository" : {
                  "default" : {},
                  "reference" : {
                     "repository_name" : "string"
                  },
                  "static" : {
                     "repository_type" : "string",
                     "settings" : {}
                  }
               },
               "repository_name" : "string",
               "retention" : {
                  "max_age" : "string",
                  "snapshots" : 0
               },
               "suspended" : [
                  "string"
               ],
               "wait_time_after_snapshotting" : "string"
            }
         },
         "snapshots" : {
            "count" : 0,
            "healthy" : true,
            "latest_end_time" : "2019-01-01T00:00:00Z",
            "latest_status" : "string",
            "latest_successful" : true,
            "latest_successful_end_time" : "2019-01-01T00:00:00Z",
            "recent_success" : true,
            "scheduled_time" : "2019-01-01T00:00:00Z"
         },
         "status" : "string",
         "system_alerts" : [
            {
               "alert_type" : "string",
               "exit_code" : 0,
               "instance_name" : "string",
               "timestamp" : "2019-01-01T00:00:00Z",
               "url" : "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
}