Returns the details for all clusters in all projects to which you have access.
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.
Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-listclusterdetails.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api clusters listClusterDetails [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--envelope | envelope | false | Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
-h, --help | false | help for listClusterDetails | |
--includeCount | false | Flag that indicates whether the response returns the total number of items (totalCount) in the response. | |
--itemsPerPage | int | false | Number of items that the response returns per page. |
-o, --output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--outputFile | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--pageNum | int | false | Number of the page that displays the current set of the total objects that the response returns. |
--pretty | false | Flag that indicates whether the response body should be in the prettyprint format. | |
--version | string | false | api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01". |
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. |