Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs
Página inicial do Docs
/
Ferramentas
/
Atlas CLI
Página inicial do Docs
/
Ferramentas
/
Atlas CLI
Página inicial do Docs
/
Ferramentas
/
Atlas CLI

atlas api

Acesse todos os recursos da Administration API do Atlas por meio do Atlas CLI usando o comando 'atlas api <tag> <operationId>'.

Esse recurso simplifica o desenvolvimento de scripts permitindo que você interaja diretamente com qualquer ponto de extremidade da Administration API do Atlas por meio da Atlas CLI.

For more information on - Atlas Administration API see: https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/ - Getting started with the Atlas Administration API: https://www.mongodb.com/pt-br/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access

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.

Sintaxe

Sintaxe do comando
atlas api <tag> <operationId> [options]

Importante

Tanto <tag> quanto <operationId> devem estar em camelCase.

argumentos

Nome
Tipo
Obrigatório
Descrição

<tag>

string

true

The category of Atlas Administration API operations in camelCase. To find and format the tag, check the API documentation URL for the endpoint. It appears after #tag/, but you need to change to camelCase. For the Atlas API documentation, see: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/.

Por exemplo, em https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs, a marcação é Monitoring-and-Logs. No camelCase, é monitoringAndLogs.

<operationId>

string

true

The identifier of the Atlas Administration API endpoint in camelCase. To find the operationId, check the API documentation URL for the endpoint. It appears after operation/. For the Atlas API documentation, see: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/.

Por exemplo, em https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-listclusters, o operationId é listClusters.

Opções de subcomando

Passe o caminho e os parâmetros de query para o ponto de extremidade da API de administração do Atlas como sinalizadores. Por exemplo, se o endpoint for /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}, o comando Atlas CLI será:

atlas api <tag> <operationId> --orgId <ORG_ID> --invoiceId <INVOICE_ID>

Observação

Geralmente, você não precisa especificar --orgId e --projectId, pois eles são originados do seu perfil. Especifique-os apenas se não estiverem definidos em seu perfil.

Se aplicável ao endpoint, passe o corpo da solicitação usando a opção --file ou a entrada padrão (stdin). Por exemplo:

atlas api clusters create --file cluster-config.json

Além disso, as seguintes opções estão disponíveis para todos os endpoints do Atlas Administration API.

Nome
Tipo
Obrigatório
Descrição

--api-version

string

false

Especifique a versão da API de Administração do Atlas para o comando. O padrão é a versão mais recente da API ou o valor que você configurou para api_version em seu perfil.

--out

string

false

Formato de saída. O padrão é json, mas os formatos suportados podem variar de acordo com o endpoint:

  • A maioria dos endpoints gera json. Quando json é compatível, você também pode usar um modelo Go.

  • Alguns endpoints suportam json e csv, permitindo que você use json, csv ou um modelo Go.

  • Alguns endpoints geram dados binários (por exemplo, registros no formato gzip), exigindo a opção --out.

Para determinar os formatos suportados para um endpoint:

-o, --out-file

string

false

Caminho do arquivo para salvar a saída. Por padrão, o resultado é exibido no terminal.

--file

string

false

Caminho de arquivo para o conteúdo do corpo da solicitação, se exigido pela operação. Alternativamente, forneça entrada através da entrada padrão (stdin).

-h, --help

booleano

false

Ajuda para o comando atual.

Opções

Nome
Tipo
Obrigatório
Descrição

-h, --help

false

ajuda para API

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.

Comandos relacionados

Voltar
convite
Próximo
Rastreamento de acesso
Avalie esta página

Nesta página