GET /api/indexadmin/cluster/health

Returns information about the Elasticsearch cluster.

Authorization Roles/Permissions: System Administrator only.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/indexadmin/cluster/health

Back to top

Sample Request

The example below shows a request for health information for the specified Elasticsearch cluster.

Request URL

https://{hostname}/api/indexadmin/cluster/health

Sample request headers

Accept: application/json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json, application/xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Request Parameters

None.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the cluster health.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Date: Fri, 12 Oct 2018 00:52:22 GMT
Content-Type: application/json

Sample response body: application/json

{
  "status":"YELLOW",
  "clusterName":"acmepaymentscorp",
  "indices":{
    "default_discussion":{
      "status":"YELLOW",
      "index":"default_discussion",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_doc":{
      "status":"YELLOW",
      "index":"default_doc",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_apiversion":{
      "status":"YELLOW",
      "index":"default_apiversion",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_api":{
      "status":"YELLOW",
      "index":"default_api",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_alert":{
      "status":"YELLOW",
      "index":"default_alert",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_contractrequest":{
      "status":"YELLOW",
      "index":"default_contractrequest",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_group":{
      "status":"YELLOW",
      "index":"default_group",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_review":{
      "status":"YELLOW",
      "index":"default_review",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_comment":{
      "status":"YELLOW",
      "index":"default_comment",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_business":{
      "status":"YELLOW",
      "index":"default_business",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_user":{
      "status":"YELLOW",
      "index":"default_user",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_metadata":{
      "status":"YELLOW",
      "index":"default_metadata",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_app-version":{
      "status":"YELLOW",
      "index":"default_app-version",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_app":{
      "status":"YELLOW",
      "index":"default_app",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_groupmemberreq":{
      "status":"YELLOW",
      "index":"default_groupmemberreq",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_ticket":{
      "status":"YELLOW",
      "index":"default_ticket",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    },
    "default_resource":{
      "status":"YELLOW",
      "index":"default_resource",
      "numberOfReplicas":1,
      "numberOfShards":2,
      "shards":{
        "0":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":0
        },
        "1":{
          "status":"YELLOW",
          "activeShards":1,
          "relocatingShards":0,
          "initializingShards":0,
          "unassignedShards":1,
          "primaryActive":true,
          "id":1
        }
      },
      "activeShards":2,
      "relocatingShards":0,
      "activePrimaryShards":2,
      "initializingShards":0,
      "unassignedShards":2,
      "fragment":true
    }
  },
  "activeShards":34,
  "relocatingShards":0,
  "activePrimaryShards":34,
  "initializingShards":0,
  "unassignedShards":34,
  "numberOfNodes":1,
  "numberOfDataNodes":1,
  "numberOfPendingTasks":0,
  "numberOfInFlightFetch":0,
  "delayedUnassignedShards":0,
  "timedOut":false,
  "taskMaxWaitingTime":{
    "nanos":0,
    "hours":0,
    "minutes":0,
    "seconds":0,
    "millis":0,
    "days":0,
    "microsFrac":0,
    "millisFrac":0,
    "secondsFrac":0,
    "minutesFrac":0,
    "hoursFrac":0,
    "daysFrac":0,
    "micros":0,
    "stringRep":"0ms"
  },
  "activeShardsPercent":50,
  "fragment":false
}

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Response Body

Name Type Description
Cluster health values String Information about the health of the cluster, in JSON format. Includes values for each index, and for each shard within the index, as well as summary values. See example above.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics