atlas api rateLimiting getRateLimit

string

true

A ID do conjunto de pontos de extremidade do limite de taxa.

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 este parâmetro é fornecido, 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 getRateLimit

string

false

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

string

false

String única de 24dígitos hexadecimais que identifica a Organização Atlas para a qual a solicitação de limites de taxa é feita. Quando este parâmetro é fornecido, 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)

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 este parâmetro é fornecido, 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".