--- Title: Shard object alwaysopen: false categories: - docs - operate - rs description: An object that represents a database shard hideListLinks: true linkTitle: shard weight: $weight url: '/operate/rs/7.8/references/rest-api/objects/shard/' --- An API object that represents a Redis shard in a database. | Name | Type/Value | Description | |------|------------|-------------| | uid | string | Cluster unique ID of shard | | assigned_slots | string | Shards hash slot range | | backup | [backup]({{< relref "/operate/rs/7.8/references/rest-api/objects/shard/backup" >}}) object | Current status of scheduled periodic backup process | | bdb_uid | integer | The ID of the database this shard belongs to | | bigstore_ram_weight | number | Shards RAM distribution weight | | detailed_status | 'busy'
'down'
'importing'
'loading'
'ok'
'timeout'
'trimming'
'unknown' | A more detailed status of the shard | | loading | [loading]({{< relref "/operate/rs/7.8/references/rest-api/objects/shard/loading" >}}) object | Current status of dump file loading | | node_uid | string | The ID of the node this shard is located on | | redis_info | redis_info object | A sub-dictionary of the [Redis INFO command]({{< relref "/commands/info" >}}) | | report_timestamp | string | The time in which the shard's info was collected (read-only) | | role | 'master'
'slave' | Role of this shard | | status | 'active'
'inactive'
'trimming' | The current status of the shard | | sync | [sync]({{< relref "/operate/rs/7.8/references/rest-api/objects/shard/sync.md" >}}) object | Shard's current sync status and progress |