Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/
Atlas CLI
/
Comandos

atlas api

Visualização pública: envie comentários em <https://feedback.mongodb.com/forums/930808-atlas-cli>: Acesse todos os recursos da API de administração do Atlas usando o Atlas CLI com a sintaxe: 'atlas API <tag> <operationId>'.

Esse recurso na visualização pública simplifica o desenvolvimento de scripts ao permitir que você interaja diretamente com qualquer endpoint da API de administração do Atlas usando a Atlas CLI.

Para mais informações sobre - API de Administração do Atlas, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/ - Introdução à API de administração do Atlas : https://www.mongodb.com/pt-br/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access

Esse recurso na visualização pública simplifica o desenvolvimento de scripts ao permitir que você interaja diretamente com qualquer endpoint da API de administração do Atlas usando a Atlas CLI.

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

A categoria de operações da API de administração do Atlas no camelCase. Para localizar e formatar a marcação, verifique o URL da documentação da API do endpoint. Aparece depois de #tag/, mas você precisa mudar para camelCase. Para a documentação da API do Atlas, consulte: 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

O identificador do endpoint da API de administração do Atlas no camelCase. Para localizar o operationId, verifique o URL de documentação da API para o endpoint. Aparece depois de operation/. Para a documentação da API do Atlas, consulte: 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/Clusters/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

Nesta página