Method listShards

Retrieves a list of shards.

HTTP request

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

Path parameters

Parameter Description
clusterId Required. ID of the Redis cluster to list shards in. To get the cluster ID use a list request. The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "shards": [
    {
      "name": "string",
      "clusterId": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
shards[] object

List of Redis shards.

shards[].
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.

shards[].
clusterId
string

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

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.