Managed Service for Redis API, gRPC: ClusterService.GetShard

Written by

Updated at November 26, 2024

Returns the specified shard.

gRPC request

rpc GetShard (GetClusterShardRequest) returns (Shard)

{
  "cluster_id": "string",
  "shard_name": "string"
}

Field

Description

cluster_id

string

Required field. ID of the Redis cluster the shard belongs to.
To get the cluster ID use a ClusterService.List request.

shard_name

string

Required field. Name of Redis shard to return.
To get the shard name use a ClusterService.ListShards request.

{
  "name": "string",
  "cluster_id": "string"
}

Field

Description

name

string

Name of the Redis shard. The shard name is assigned by user at creation time, and cannot be changed.
1-63 characters long.

cluster_id

string

ID of the Redis cluster the shard belongs to. The ID is assigned by MDB at creation time.