mongocli atlas serverless watch
On this page
mongocli atlas commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas commands until April 30, 2023.Monitor the status of serverless instance.
Your API Key must have the Project Read Only role to successfully call this resource. This command checks the serverless instance's state periodically until the instance reaches an IDLE state. Once the instance reaches the expected state, the command prints "Instance available." If you run the command in the terminal, it blocks the terminal session until the resource becomes idle. You can interrupt the command's polling at any time with CTRL-C.
Syntax
mongocli atlas serverless watch <instanceName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
instanceName | string | false | Name of the instance to watch. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for watch | |
--projectId | string | false | Project ID to use. Overrides the settings in the configuration file or environment variable. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Profile to use from your configuration file. |
Examples
$ mongocli atlas serverless watch instanceNameSample