Managed Service for MongoDB API, REST: Cluster.GetShard

Written by

Updated at November 26, 2024

Returns the specified shard.

HTTP request

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

Field

Description

clusterId

string

Required field. ID of the MongoDB cluster that the shard belongs to.
To get the cluster ID use a ClusterService.List request.

shardName

string

Required field. Name of the MongoDB shard to return.
To get the name of the shard use a ClusterService.ListShards request.

HTTP Code: 200 - OK

{
  "name": "string",
  "clusterId": "string"
}

Field

Description

name

string

Name of the shard.

clusterId

string

ID of the cluster that the shard belongs to.