Метод listShards

Получает список шардов.

HTTP-запрос

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

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера redis, для которого нужно вывести список шардов. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

{
  "shards": [
    {
      "name": "string",
      "clusterId": "string"
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
shards[] object

Список шардов Redis.

shards[].
name
string

Имя шарда Redis. Имя шарда назначается пользователем при создании и не может быть изменено. Длина 1-63 символов.

shards[].
clusterId
string

Идентификатор кластера Redis, к которому принадлежит шард. Этот идентификатор генерирует MDB при создании.

nextPageToken string

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.