Devolver todos los límites de consultas para una instancia de base de datos federada

Obtener /api/atlas/v1.0/grupos/{ID de grupo}/dataFederation/{nombre del inquilino}/límites

Cuentas de servicio Autorización de resumen

Devuelve los límites de queries para una instancia federada de bases de datos en el Proyecto especificado. Para utilizar este recurso, la Cuenta de servicio solicitante o la API Key debe tener el rol Project Read Only.

Parámetros de ruta

ID de grupo string Requerido

Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".

El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
nombre del inquilino string Requerido

Etiqueta legible por humanos que identifica la instancia de base de datos federada para la que desea recuperar los límites de consulta.

Parámetros de consulta

envolvente booleano

Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON envelope. 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 encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

El valor predeterminado es false.
bonita booleano

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

El valor predeterminado es false.

Impresión bonita

Respuestas

200 aplicación/json

Vale
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- uso actual integer(int64)
  
  Cantidad que indica el uso actual del límite.
- defaultLimit integer(int64)
  
  Valor predeterminado del límite.
- lastModifiedDate cadena(fecha-hora)
  
  Solo se utiliza para límites de federación de datos. Marca de tiempo que indica cuándo se modificó por última vez este límite de uso. Este campo utiliza el formato de marca de tiempo ISO 8601 en UTC.
- límite máximo integer(int64)
  
  Valor máximo del límite.
- Nombre string Requerido
  
  Etiqueta legible por humanos que identifica el límite administrado por el usuario para modificar.
- Política de sobrepasamiento string
  
  Solo se usa para límites de federación de datos. Acción a tomar cuando se excede el límite de uso. Si el límite de uso se establece en CONSULTA, se ignora porque MongoDB Cloud detiene la consulta cuando se excede el límite de uso.
  
  Los valores son BLOCK o BLOCK_AND_KILL.
- nombre del inquilino string
  
  Etiqueta legible que identifica la instancia de base de datos federada. Si se especifica, el límite de uso se aplica únicamente a la instancia de base de datos federada especificada. Si se omite, el límite de uso se aplica a todas las instancias de base de datos federadas del proyecto.
- valor integer(int64) Requerido
  
  Cantidad a establecer como límite.
401 aplicación/json

No autorizado.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.
403 aplicación/json

Forbidden.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.
404 aplicación/json

No se encontró.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.
500 aplicación/json

Error Interno del Servidor.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v1.0/grupos/{ID de grupo}/dataFederation/{Nombre del inquilino}/límites

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/dataFederation/{tenantName}/limits' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Ejemplos de respuestas (200)

[
  {
    "currentUsage": 42,
    "defaultLimit": 42,
    "lastModifiedDate": "2026-05-04T09:42:00Z",
    "maximumLimit": 42,
    "name": "string",
    "overrunPolicy": "BLOCK",
    "tenantName": "string",
    "value": 42
  }
]

Ejemplos de respuestas (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Ejemplos de respuestas (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Ejemplos de respuestas (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Ejemplos de respuestas (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}