Managed Service for MongoDB API, gRPC: ClusterService.ListShards
Retrieves a list of shards.
gRPC request
rpc ListShards (ListClusterShardsRequest) returns (ListClusterShardsResponse)
ListClusterShardsRequest
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string"
}
Field |
Description |
clusterId |
string Required field. ID of the MongoDB cluster to list databases in. |
pageSize |
int64 The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
ListClusterShardsResponse
{
"shards": [
{
"name": "string",
"clusterId": "string"
}
],
"nextPageToken": "string"
}
Field |
Description |
shards[] |
List of MongoDB shards. |
nextPageToken |
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 shard. |
clusterId |
string ID of the cluster that the shard belongs to. |