schema

Update a shard status

Updates the status of a specific shard within a collection (e.g., sets it to READY or READONLY). This is typically used after resolving an underlying issue (like disk space) that caused a shard to become non-operational. There is also a convenience function in each client to set the status of all shards of a collection.

put/schema/{className}/shards/{shardName}

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/schema/{className}/shards/{shardName}
  • 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) containing the shard.

shardNamestring required

The name of the shard to update.

Request body

statusstring

Status of the shard

Response

Shard status updated successfully.

statusstring

Status of the shard

Changes

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