ElasticsearchClusterInfoedit

The top level info object for an Elasticsearch cluster

Propertiesedit

associated_kibana_clusters (array[KibanaSubClusterInfo], required)
cluster_id (string, required)
The id of the cluster
cluster_name (string, required)
The name of the cluster
elasticsearch (ElasticsearchInfo, required)
Information about the Elasticsearch cluster (indices, masters)
elasticsearch_monitoring_info (ElasticsearchMonitoringInfo)
Information about this cluster's ECE-managed XPack Monitoring status
external_links (array[ExternalHyperlink], required)
External resources related to the cluster
healthy (boolean, required)
Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)
links (map[string,Hyperlink])
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
metadata (ClusterMetadataInfo, required)
The cluster metadata stores a combination of public and internal state and configuration for a cluster. The unstructured content is undocumented unless explicitly stated elsewhere in the docs
plan_info (ElasticsearchClusterPlansInfo, required)
Information about the current, pending, and past plans of a cluster
region (string)
The region that this cluster belongs to. Only populated in SaaS or federated ECE.
security (ElasticsearchClusterSecurityInfo)
For 2.x clusters, information about the users and roles. For 5.x, the Kibana management UI should be used
settings (ElasticsearchClusterSettings)
Settings for controlling ECE functionality for an Elasticsearch cluster
snapshots (SnapshotStatusInfo, required)
Information about this cluster's snapshot status (health, etc.)
status (string; allowed values: [initializing, stopping, stopped, rebooting, restarting, reconfiguring, started])
Cluster status
system_alerts (array[ClusterSystemAlert])
List of cluster system alerts
topology (ClusterTopologyInfo, required)
A description of the cluster topology (the different instances/containers making up the cluster, and where they are located

Exampleedit

{
   "associated_kibana_clusters" : [
      {
         "enabled" : true,
         "kibana_id" : "string",
         "links" : {
            "some_property" : {
               "need_elevated_permissions" : true
            }
         }
      }
   ],
   "cluster_id" : "string",
   "cluster_name" : "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
   },
   "metadata" : {
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "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"
                     ],
                     "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_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_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" : {
      "curation" : {
         "specs" : [
            {
               "index_pattern" : "string",
               "trigger_interval_seconds" : 0
            }
         ]
      },
      "dedicated_masters_threshold" : 0,
      "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",
         "repository" : {
            "default" : {},
            "reference" : {
               "repository_name" : "string"
            },
            "static" : {
               "repository_type" : "string",
               "settings" : {}
            }
         },
         "repository_name" : "string",
         "suspended" : [
            "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",
      "scheduled_time" : "2019-01-01T00:00:00Z"
   },
   "status" : "string",
   "system_alerts" : [
      {
         "alert_type" : "string",
         "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
            },
            "healthy" : true,
            "instance_configuration" : {
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "service_id" : "string",
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}