Returns the cluster-level sharding state of one sharded cluster, including the balancer state, config server availability, and the configured balancing window.
The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for shardingInsights |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Related Commands
atlas api shardingInsights getClusterShardMetric - Returns the size, load and open alerts of one shard in one sharded cluster.
atlas api shardingInsights getClusterShardingInsights - Returns the cluster-level sharding state of one sharded cluster: the number of shards, the balancer state, the availability of the config servers, and the configured balancing window.
atlas api shardingInsights getShardMetricMeasurements - Returns time series of the requested measurements for one shard of the specified sharded cluster.
atlas api shardingInsights listClusterShardMetrics - Returns the size and load of every shard in one sharded cluster.
atlas api shardingInsights listShardMetricMeasurements - Returns time series of the requested measurements for every shard of the specified sharded cluster, one series per shard and measurement.