Contact UsGet started

Managed Service for MongoDB API, REST: Cluster.ListShards

Written by
Updated at October 17, 2024

Retrieves a list of shards.

HTTP request

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

Path parameters

Field

Description

clusterId

string

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

Query parameters

Field

Description

pageSize

string (int64)

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

pageToken

string

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

Response

HTTP Code: 200 - OK

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

Field

Description

shards[]

Shard

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
is larger than ListClusterShardsRequest.pageSize, use the nextPageToken as the value
for the ListClusterShardsRequest.pageToken parameter in the next list request. Each subsequent
list request will have its own nextPageToken to continue paging through the results.

Shard

Field

Description

name

string

Name of the shard.

clusterId

string

ID of the cluster that the shard belongs to.
Previous
GetShard
Next
AddShard