atlas api rateLimiting listRateLimits

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

false

Filtra los conjuntos de puntos finales devueltos por la ruta de punto final proporcionada. Se pueden proporcionar varias rutas, por ejemplo /rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F. Reemplazar /, { y } con sus valores codificados en URL (%2F, %7B y %7D respectivamente).

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, solo se devuelven conjuntos de puntos finales con ámbito de grupo y los límites devueltos son aplicables al proyecto especificado. El usuario solicitante debe tener el rol de Solo lectura del proyecto especificado.

false

Ayuda para listRateLimits

string

false

Dirección IP para la que se solicitarán límites de velocidad. Al proporcionar este parámetro, solo se devolverán conjuntos de puntos finales con ámbito IP y 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.

Int

false

Número de elementos que la respuesta devuelve por página.

/rateLimits?name=Name1&name=Name2

false

Filtra los conjuntos de puntos finales devueltos por el nombre del conjunto de puntos finales proporcionado. Se pueden proporcionar varios nombres, por ejemplo, /rateLimits?name=Name1&name=Name2. Para los nombres que contienen espacios, reemplace el espacio con su valor codificado en URL (%20).

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, solo se devuelven conjuntos de puntos finales con ámbito de organización y los límites devueltos son aplicables 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)

Int

false

Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.

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 velocidad. 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, solo se devuelven conjuntos de puntos finales con ámbito de usuario y 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".