/ /

/ /

Proyectos de API de Atlas createGroup

Crea un proyecto.

El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.

Los proyectos agrupan clústeres en colecciones lógicas que respaldan un entorno de aplicación, una carga de trabajo o ambos. Cada proyecto puede tener sus propios usuarios, equipos, configuraciones de seguridad, etiquetas y alertas. Para usar este recurso, la Cuenta de servicio o API Key que realiza la solicitud debe tener el rol de Lectura y escritura.

Este comando se genera automáticamente y corresponde 1:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroup.

Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.

Sintaxis

Sintaxis del comando

atlas api projects createGroup [options]

opciones

Nombre	Tipo	Requerido	Descripción
--sobre	envolvente	false	Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta.
--file	string	false	Ruta a tu archivo de solicitud de API. Déjalo en blanco para usar la entrada estándar; debes proporcionar una u otra, pero no ambas.
-h, --ayuda		false	ayuda para createGroup
-o, --output	string	false	formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json".
--archivo de salida	string	false	archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip)
--bonito		false	Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
--ID del propietario del proyecto	string	false	string única de 24 dígitos hexadecimales que identifica al usuario de MongoDB nube al que se le otorgará el rol de Propietario del Proyecto en el Proyecto especificado. Si se establece este parámetro, anula el valor por defecto del propietario de la organización más antiguo.
--versión	string	false	Versión de API a utilizar al llamar a la llamada de API [opciones: "2023-01-01"], el valor predeterminado es la última versión o el valor de configuración api_version de los perfiles si está configurado. Este valor predeterminado es "2023-01-01".

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.

Ejemplos

Crea un nuevo proyecto llamado "MongoTube" con una etiqueta de entorno establecida en "e2e"

Crea el archivo a continuación y guárdalo como payload.json

{
  "name": "MongoTube",
  "orgId": "67b715468c10250b968dcb84",
  "tags": [
    {
      "key": "environment",
      "value": "e2e"
    }
  ]
}

Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.

atlas api projects createGroup --version 2023-01-01

Volver

proyectos

eliminarGrupo