Managed Service for MongoDB API, gRPC: ClusterService.ListShards

Field

Description

cluster_id

string

Required field. ID of the MongoDB cluster to list databases in.
To get the cluster ID, use a ClusterService.List request.

The maximum string length in characters is 50.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListClusterShardsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

The maximum value is 1000.

page_token

string

Page token. To get the next page of results, set page_token to the
ListClusterShardsResponse.next_page_token returned by the previous list request.

The maximum string length in characters is 100.

Field

Description

shards[]

Shard

List of MongoDB shards.

next_page_token

string

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

Field

Description

name

string

Name of the shard.

cluster_id

string

ID of the cluster that the shard belongs to.