Managed Service for MongoDB API, gRPC: ClusterService.GetShard

Written by

Updated at November 26, 2024

Returns the specified shard.

gRPC request

rpc GetShard (GetClusterShardRequest) returns (Shard)

{
  "cluster_id": "string",
  "shard_name": "string"
}

Field

Description

cluster_id

string

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

shard_name

string

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

{
  "name": "string",
  "cluster_id": "string"
}

Field

Description

name

string

Name of the shard.

cluster_id

string

ID of the cluster that the shard belongs to.