atlas api rateLimiting listRateLimits

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

false

Filtra os conjuntos de pontos de extremidade retornados pelo caminho do ponto de extremidade 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

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.

string

false

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

false

ajuda para listRateLimits

string

false

Um endereço IP para o qual fazer uma solicitação de limites de taxa. Quando esse parâmetro é fornecido, somente os conjuntos de pontos de extremidade 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.

int

false

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

/rateLimits?name=Name1&name=Name2

false

Filtra os conjuntos de pontos de extremidade retornados pelo nome do conjunto de pontos de extremidade 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).

string

false

String única de 24dígitos hexadecimais que identifica a Organização Atlas para a qual é feita a solicitação de limites de taxa. Quando esse parâmetro é fornecido, somente os conjuntos de pontos de extremidade 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 função Somente leitura da organização para a organização especificada.

string

false

formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".

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)

int

false

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

false

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

string

false

Uma string que identifica o Atlas user para solicitação de 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 pontos de extremidade com escopo definido pelo usuário são retornados e os limites retornados são aplicáveis ao usuário especificado. O usuário da solicitação deve ser o mesmo que o usuário especificado.

string

false

versão da API a ser usada ao chamar a 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 padrão é "preview".