atlas api rateLimiting getRateLimit

string

true

El ID del punto final de limitación de velocidad configurado.

envelope

false

Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. 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

Cadena hexadecimal única 24que identifica el proyecto Atlas para el que se solicitan los límites de velocidad. Cuando se proporciona este parámetro, los límites devueltos se aplican al proyecto especificado. El usuario solicitante debe tener el rol de Solo lectura del proyecto.

false

Ayuda para obtener el límite de velocidad

string

false

Dirección IP para la que se solicitarán límites de velocidad. Al proporcionar este parámetro, los límites devueltos se aplicarán a la dirección IP especificada. El usuario solicitante debe tener la misma dirección IP que la proporcionada en la solicitud.

string

false

Cadena hexadecimal única 24que identifica la organización de Atlas para la que se solicitan los límites de velocidad. Cuando se proporciona este parámetro, los límites devueltos se aplican a la organización especificada. El usuario solicitante debe tener el rol de Solo lectura de la organización.

string

false

formato de API preferido, puede ser ["json", go-template] Este valor predeterminado 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 formato prettyprint.

string

false

Una cadena que identifica al usuario de Atlas para el que se solicitan los límites de uso. El ID puede ser, por ejemplo, el ID de cliente de la cuenta de servicio o la clave pública de la API. Cuando se proporciona este parámetro, los límites devueltos se aplican al usuario especificado. El usuario solicitante debe ser el mismo que el usuario especificado.

string

false

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