{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/objects/shard",
  "title": "Shard object",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/shard/",
  "summary": "An object that represents a database shard",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2024-06-27T07:52:26-07:00",
  "children": [
    {
      "id": "operate/rs/references/rest-api/objects/shard/backup",
      "summary": "Documents the backup object used with Redis Software REST API calls.",
      "title": "Backup object",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/shard/backup/"
    },
    {
      "id": "operate/rs/references/rest-api/objects/shard/loading",
      "summary": "Documents the loading object used with Redis Software REST API calls.",
      "title": "Loading object",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/shard/loading/"
    },
    {
      "id": "operate/rs/references/rest-api/objects/shard/sync",
      "summary": "Documents the sync object used with Redis Software REST API calls.",
      "title": "Sync object",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/shard/sync/"
    }
  ],
  "page_type": "content",
  "content_hash": "472533ff938f2da463b5fe139539d158cc682760370f7477f2df505e1f43c5aa",
  "sections": [
    {
      "id": "content",
      "title": "Content",
      "role": "content",
      "text": "An API object that represents a Redis shard in a database.\n\n| Name | Type/Value | Description |\n|------|------------|-------------|\n| uid | string | Cluster unique ID of shard |\n| assigned_slots | string | Shards hash slot range |\n| backup | [backup](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/shard/backup) object | Current status of scheduled periodic backup process |\n| bdb_uid | integer | The ID of the database this shard belongs to |\n| bigstore_ram_weight | number | Shards RAM distribution weight |\n| detailed_status | 'busy'<br />'down'<br />'importing'<br />'loading'<br />'ok'<br />'timeout'<br />'trimming'<br />'unknown' | A more detailed status of the shard |\n| loading | [loading](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/shard/loading) object | Current status of dump file loading |\n| node_uid | string | The ID of the node this shard is located on |\n| redis_info | redis_info object | A sub-dictionary of the [Redis INFO command](https://redis.io/docs/latest/commands/info) |\n| report_timestamp | string | The time in which the shard's info was collected (read-only) |\n| role | 'master'<br />'slave' | Role of this shard |\n| status | 'active'<br />'inactive'<br />'trimming' | The current status of the shard |\n| sync | [sync](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/shard/sync.md) object | Shard's current sync status and progress |"
    }
  ],
  "examples": []
}