Recupere uma única chave de API do modelo de IA para a organização fornecida.
O subcomando atlas api é gerado automaticamente a partir da API de administração do MongoDB Atlas e oferece cobertura completa da API de administração. As funcionalidades da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do ponto de extremidade da API fornecido.
Este comando é gerado automaticamente e 1 corresponde:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/ operation-getorgaimodelapikey.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api aiModels getOrgModelKey [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--apiKeyId | string | true | A ID da chave API a ser recuperada. |
--envelope | envelope | false | Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta. |
-h, --help | false | ajuda para getOrgModelKey | |
--orgId | string | true | String exclusiva de 24dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint [/orgs](#tag/Organizations/operation/listOrganizations) para recuperar todas as organizações às quais o usuário autenticado tem acesso. |
-o, --output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--outputFile | string | false | no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip) |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. | |
--version | string | false | versão api a ser usada ao chamar a chamada de api [opções: "preview"], padrão para a versão mais recente ou o valor de configuração dos perfis api_version, se definido. Esse valor é padronizado como "preview". |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Exemplos
atlas api aiModels getOrgModelKey --version preview --apiKeyId [apiKeyId] --orgId 4888442a3354817a7320eb61