Menu Docs
Página inicial do Docs
/ /

atlas api rateLimiting listRateLimits

Obtenha todos os limites de taxa para todos os conjuntos de endpoints da API de administração do Atlas v2.

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-listratelimits.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe do comando
atlas api rateLimiting listRateLimits [options]
Nome
Tipo
Obrigatório
Descrição

--endpointPath

/rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F

false

Filtra os conjuntos de endpoints retornados pelo caminho do endpoint fornecido. Vários caminhos podem ser fornecidos, por exemplo /rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F. Substitua /, { e } por seus valores codificados de URL(%2F, %7B e %7D respectivamente).

--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.

--groupId

string

false

String única de 24dígitos hexadecimais que identifica o Projeto Atlas para o qual solicitar limites de taxa. Quando esse parâmetro é fornecido, somente conjuntos de endpoints com escopo de grupo são retornados e os limites retornados são aplicáveis ao projeto especificado. O usuário solicitante deve ter a função "somente leitura" do projeto para o projeto especificado.

-h, --help

false

ajuda para listRateLimits

--ipAddress

string

false

Um endereço IP para o qual solicitar limites de taxa. Quando esse parâmetro é fornecido, somente os conjuntos de endpoints com escopo IP são retornados e os limites retornados são aplicáveis ao endereço IP especificado. O usuário solicitante deve ter o mesmo endereço IP fornecido na solicitação.

--itemsPerPage

int

false

Número de itens que a resposta retorna por página.

--name

/rateLimits?name=Name1&name=Name2

false

Filtra os conjuntos de endpoints retornados pelo nome do conjunto de endpoints fornecido. Vários nomes podem ser fornecidos, por exemplo /rateLimits?name=Name1&name=Name2. Para nomes que usam espaços, substitua o espaço pelo seu valor codificado para URL(%20).

--orgId

string

false

String única de 24dígitos hexadecimais que identifica a Organização Atlas para a qual solicitar limites de taxa. Quando esse parâmetro é fornecido, somente os conjuntos de endpoints com escopo da organização são retornados e os limites retornados são aplicáveis à organização especificada. O usuário solicitante deve ter a role Somente leitura da organização para a organização especificada.

-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)

--pageNum

int

false

Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

--pretty

false

Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

--userId

string

false

Uma string que identifica o usuário do Atlas para solicitar limites de taxa. O ID pode ser, por exemplo, o ID do cliente da conta de serviço ou a chave pública da API. Quando esse parâmetro é fornecido, somente os conjuntos de endpoints com escopo definido pelo usuário são retornados e os limites retornados são aplicáveis ao usuário especificado. O usuário solicitante deve ser o mesmo que o usuário especificado.

--version

string

false

versão api a ser usada ao chamar a chamada api [opções: "2025-03-12", "preview"], padrão para a versão mais recente ou o valor de configuração api_version do perfil, se definido Esse valor é padronizado para "preview ".

Nome
Tipo
Obrigatório
Descrição

-P, --profile

string

false

atlas api rateLimiting listRateLimits --version preview --endpointPath /api/atlas/v2/clusters --groupId 32b6e34b3d91647abb20e7b8 --ipAddress 127.0.0.1 --name Rate Limits Inspection --orgId 32b6e34b3d91647abb20e7b8 --userId mdb_sa_id_1234567890abcdef12345678

Voltar

getRateLimit

Nesta página