Managed Service for Redis API, gRPC: ClusterService.ListShards
Retrieves a list of shards.
gRPC request
rpc ListShards (ListClusterShardsRequest) returns (ListClusterShardsResponse)
ListClusterShardsRequest
{
"cluster_id": "string",
"page_size": "int64",
"page_token": "string"
}
Field |
Description |
cluster_id |
string Required field. ID of the Redis cluster to list shards in. |
page_size |
int64 The maximum number of results per page to return. If the number of available |
page_token |
string Page token. To get the next page of results, set |
ListClusterShardsResponse
{
"shards": [
{
"name": "string",
"cluster_id": "string"
}
],
"next_page_token": "string"
}
Field |
Description |
shards[] |
List of Redis shards. |
next_page_token |
string This token allows you to get the next page of results for list requests. If the number of results |
Shard
Field |
Description |
name |
string Name of the Redis shard. The shard name is assigned by user at creation time, and cannot be changed. |
cluster_id |
string ID of the Redis cluster the shard belongs to. The ID is assigned by MDB at creation time. |