Obtener todos los límites de tasa para todos los conjuntos de endpoints de la API de administración de Atlas v2.
El subcomando del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.
Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operación/operación-listratelimits.
Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api rateLimiting listRateLimits [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--endpointPath | /rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F | false | Filtra los conjuntos de endpoints devueltos según la ruta de endpoint proporcionada. Se pueden proporcionar múltiples rutas, por ejemplo, /rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F. Reemplazar |
--envelope | 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. |
--groupId | 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, solo se devuelven conjuntos de endpoints con ámbito de grupo y los límites devueltos aplican al proyecto especificado. El usuario que realiza la solicitud debe tener el rol de Solo lectura de proyecto para el proyecto especificado. |
-h, --help | false | ayuda para listRateLimits | |
--ipAddress | string | false | Una dirección IP para solicitar límites de tasa. Cuando se proporciona este parámetro, solo se devuelven conjuntos de puntos finales con alcance de IP y los límites devueltos son aplicables 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. |
--itemsPerPage | Int | false | Número de elementos que la respuesta retorna por página. |
--name | /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 usan espacios, reemplace el espacio con su valor codificado en URL ( |
--orgId | 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, solo se devuelven los conjuntos de endpoints con alcance de organización y los límites devueltos son aplicables a la organización especificada. El usuario que realiza la solicitud debe tener el rol de Solo lectura de la organización especificada. |
-o, --output | string | false | formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto es "JSON". |
--outputFile | 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) |
--número de página | Int | false | Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta. |
--bastante | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--userId | string | false | Una string que identifica al Atlas user para solicitar límites de velocidad. La ID puede ser, por ejemplo, la 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 endpoints con alcance de usuario y los límites devueltos son aplicables al usuario especificado. El usuario solicitante debe ser el mismo que el usuario especificado. |
--versión | 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". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api rateLimiting listRateLimits --version preview --endpointPath /api/atlas/v2/clusters --groupId 32b6e34b3d91647abb20e7b8 --ipAddress 127.0.0.1 --name Rate Limits Inspection --orgId 32b6e34b3d91647abb20e7b8 --userId mdb_sa_id_1234567890abcdef12345678