Docs Menu
Docs Home
/
MongoDB Atlas
/
MongoDB Command Line Interface
/
Reference
/
Atlas
/
Metrics

mongocli atlas metrics disks list

On this page

  • Syntax
  • Options
  • Output
  • Example

The metrics disks list command lists the available partitions on a specified Atlas host.

You can get the hostnames associated with a particular Atlas project with the process list command.

Syntax

mongocli atlas metrics disks list|ls <hostname>:<port>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]

Note

Use -h or --help to view the command-line help for this command.

Options

Option
Type
Description
Required?
<hostname>:<port>
String
The hostname of the server running the Atlas MongoDB process and the port on which the process listens.
yes
--output, -o
string

Command output format. Valid values are:

  • json for output in JSON format

  • go-template for custom output using the Go template

  • go-template-file for custom output specified using Go template file

If omitted, the command returns output in the default format.

no
--profile, -P
string
Name of the profile where the project ID and the Programmatic API Keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.
no
--projectId
string

Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.

no

Output

The command prints the following fields in the specified format to the terminal if the command succeeds. If the command prints an error, see Troubleshooting for recommended solutions.

The HTTP response returns a JSON document that includes the following objects:

Name
Type
Description
links
document array
One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
partitionName
string
Name of the disk or partition with available metrics.
totalCount
number
The number of results returned.

Example

The following example uses the mongocli atlas metrics disks list command to retrieve available partitions on a host with ID atlas-ap6k8a-shard-00-02.qmljy.mongodb.net, listening on port 27017. The command uses the default profile, where the project ID and the Programmatic API Keys are stored.

mongocli atlas metrics disks list \
  atlas-ap6k8a-shard-00-02.qmljy.mongodb.net:27017 --output json

The previous command produces the following output:

{
     "links": [
             {
                     "rel": "self",
                     "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5dd5a6b6f10fab1d71a58495/processes/atlas-ap6kaa-shard-00-02.qmajy.mongodb.net:27017/disks?pageNum=1\u0026itemsPerPage=100"
             }
     ],
     "results": [
             {
                     "links": [
                             {
                                     "rel": "self",
                                     "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5dd5a6b6f10fab1d71a58495/processes/atlas-ap6kaa-shard-00-02.qmajy.mongodb.net:27017/disks/data"
                             }
                     ],
                     "partitionName": "data"
             }
     ],
     "totalCount": 1
 }

Back

Describe Available Metrics

Next

Networking