schema

Get the shards status of a collection

Retrieves the status of all shards associated with the specified collection (className). For multi-tenant collections, use the tenant query parameter to retrieve status for a specific tenant's shards.

get/schema/{className}/shards

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/schema/{className}/shards
  • 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) whose shards to query.

Query parameters

tenantstring

The name of the tenant for which to retrieve shard statuses (only applicable for multi-tenant collections).

Response

Shard statuses retrieved successfully.

namestring

Name of the shard

statusstring

Deprecated: value is not consistent in replicated clusters.

per_node_statusobject

Status of the shard on each of its replicas

vectorQueueSizeinteger

Deprecated: value is not consistent in replicated clusters.

Changes

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