Recupera una única clave API de modelo de IA para la organización dada.
El subcomando del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.
Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgaimodelapikey.
Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api aiModelApiKeys getOrgModelKey [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--apiKeyId | string | true | El id de la clave de API que se va a recuperar. |
--envelope | envelope | false | Indicador que señala si la Aplicación envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al código de estado. Para remediarlo, establece envelope=true en la query. 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. |
-h, --help | false | ayuda para getOrgModelKey | |
--orgId | /orgs | true | string única de 24dígitos hexadecimales que identifica a la organización que contiene los proyectos. Use el endpoint [/orgs](#etiqueta/Organizations/operación/listOrganizations) para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
-o, --output | string | false | formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto es "JSON". |
--outputFile | 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) |
--bastante | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--versión | string | false | La versión de API a utilizar cuando se va a llamar a la API [opciones: "preview"], por defecto es la última versión o el valor de configuración api_version en los perfiles si está considerado. Este valor configura por defecto en "preview". |
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. |
Ejemplos
atlas api aiModelApiKeys getOrgModelKey --version preview --apiKeyId [apiKeyId] --orgId 4888442a3354817a7320eb61