atlas api streams getStreamWorkspace En su lugar. Para obtener más información, consulte flujos de API de Atlas getStreamWorkspace.Describe una instancia de Atlas Stream Processing para tu proyecto.
Para utilizar este comando, debe autenticarse con una cuenta de usuario, una cuenta de servicio o una clave API con la función de solo 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, --ayuda | 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 | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del 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 usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Salida
Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus 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