Managed Service for Redis API, REST: Cluster.GetShard

Written by

Improved by

Updated at November 26, 2024

Returns the specified shard.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/{clusterId}/shards/{shardName}

Field

Description

clusterId

string

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

shardName

string

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

HTTP Code: 200 - OK

{
  "name": "string",
  "clusterId": "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.

clusterId

string

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