atlas api streams getStreamWorkspace En su lugar. Para obtener más información, consulte atlas api streams getStreamWorkspace.Describe una instancia de Atlas Stream Processing para tu proyecto.
Para utilizar este comando, debes autenticarte con una cuenta de usuario, cuenta de servicio o una clave API con el rol de Lectura del proyecto.
Sintaxis
atlas streams instances describe <name> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
Nombre | string | true | Nombre de la instancia del procesador Atlas Streams. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-h, --help | false | ayuda para describir | |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
--projectId | string | false | string hexadecimal que identifica el Proyecto a utilizar. Esta opción anula la configuración en el archivo de configuración o la variable de entorno. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Salida
Si el comando se ejecuta correctamente, el CLI devuelve una salida similar a la siguiente muestra. Los valores entre corchetes representan tus valores.
ID NAME CLOUD REGION <Id> <Name> <DataProcessRegion.CloudProvider> <DataProcessRegion.Region>
Ejemplos
# Return an Atlas Stream Processing instance with a specific name: atlas streams instance describe myProcessor
# Return a JSON-formatted Atlas Stream Processing instance with a specific name: atlas streams instance describe myProcessor --output json