nodes

Get node status by collection

Retrieves status information only for the nodes that host shards for the specified collection (className). Use the output query parameter to control the level of detail.

get/nodes/{className}

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/nodes/{className}
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Path parameters

classNamestring required

The name of the collection (class) for which to retrieve node status.

Query parameters

shardNamestring
outputstring

Controls the verbosity of the output, possible values are: minimal, verbose. Defaults to minimal.

Response

Successfully retrieved the status for nodes relevant to the specified collection.

Changes

No recorded changes to this operation across all 1 revision of this API.