Managed Service for MongoDB API, REST: Cluster.getShard
Written by
Updated at May 26, 2023
Returns the specified shard.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}/shards/{shardName}
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the MongoDB cluster that the shard belongs to. To get the cluster ID use a list request. The maximum string length in characters is 50. |
shardName | Required. Name of the MongoDB shard to return. To get the name of the shard use a listShards request. The maximum string length in characters is 63. Value must match the regular expression |
Response
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. |