atlas api rateLimiting getRateLimit

string

true

El ID del conjunto de endpoints de límite de velocidad.

envelope

false

Indicador que señala si la Aplicación envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al código de estado. Para remediarlo, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

string

false

string única de 24dígitos hexadecimales que identifica el Proyecto Atlas para solicitar límites de frecuencia. Cuando se proporciona este parámetro, los límites devueltos son aplicables al proyecto especificado. El usuario que realiza la solicitud debe tener el rol de Solo lectura de proyecto para el proyecto especificado.

false

ayuda para getRateLimit

string

false

Una dirección IP para solicitar límites de tasa. Cuando se proporciona este parámetro, los límites devueltos se aplican a la dirección IP especificada. El usuario que realiza la solicitud debe tener la misma dirección IP que la proporcionada en la solicitud.

string

false

string única de 24dígitos hexadecimales que identifica a la Organización Atlas para solicitar límites de velocidad. Cuando se proporciona este parámetro, los límites devueltos se aplican a la organización especificada. El usuario que realiza la solicitud debe tener el rol de Solo lectura de la organización especificada.

string

false

formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto es "JSON".

string

false

archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip)

false

Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.

string

false

Una string que identifica al Atlas user para solicitar límites de velocidad. La ID, por ejemplo, puede ser la ID de cliente de la Cuenta de servicio o la llave pública de la API. Cuando este parámetro se proporciona, los límites devueltos se aplican al usuario especificado. El usuario que realiza la solicitud debe ser el mismo que el usuario especificado.

string

false

Versión de la API que se usará al llamar a la API [opciones: "2025-03-12", "preview"], por defecto se utilizará la última versión o el valor de configuración api_version de los perfiles si están definidos. Este valor por defecto es "preview".