Devuelve el estado de esta aplicación MongoDB

OBTENER /api/atlas/v1.0

Este recurso devuelve información sobre la aplicación MongoDB junto con los metadatos de la clave API.

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • bonito booleano

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

    El valor por defecto es false.

    pretty-print

Respuestas

  • 200 application/json

    OK

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Llave API objeto | nulo Requerido

      Detalles contenidos en una clave API.

      Ocultar atributos de apiKey Mostrar los atributos de apiKey objeto | nulo
      • accessList arreglo[objeto] Requerido

        Lista de direcciones de red a las que se ha concedido acceso a esta API mediante esta clave API.

        Ocultar atributos accessList Mostrar atributos de la lista de acceso Objeto
        • cidrBlock string

          Rango de direcciones IP en notación CIDR (Classless Inter-Domain Routing) que se encuentra en la lista de acceso de este proyecto.

          El formato debe coincidir con el siguiente patrón: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.

        • Dirección IP string Requerido

          Dirección IP incluida en la lista de acceso API.

          El formato debe coincidir con el siguiente patrón: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

      • ID string Requerido

        string única de 24 dígitos hexadecimales que identifica esta clave API de la organización.

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

      • publicKey string Requerido

        llave pública de API establecida para la clave API de la organización especificada.

        La longitud mínima es de 8, la longitud máxima es de 8.

      • Roles arreglo[objeto] Requerido

        Lista que contiene los roles que la clave API debe tener. Todos los roles que proporciones deben ser válidos para el proyecto u organización especificada. Cada solicitud debe incluir al menos un rol válido. El recurso devuelve todos los roles de proyecto y organización asignados al usuario de la nube.

        Hide roles attributes Mostrar atributos de roles Objeto

        Los roles del usuario de MongoDB Cloud y la organización o el proyecto correspondiente al que se aplica ese rol. Cada rol puede aplicarse a una organización o un proyecto, pero no a ambos.

        Roles de claves en la API de MongoDB nube
        • ID del grupo string

          string de dígitos hexadecimales 24-única que identifica el Proyecto al que pertenece este rol. Puedes establecer un valor para este parámetro o orgId, pero no ambos en la misma solicitud.

          La longitud mínima es 24 y la máxima es 24. El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

        • orgId string

          string única de 24dígitos hexadecimales que identifica la organización a la que pertenece este rol. Puede establecer un valor para este parámetro o groupId, pero no ambos en la misma solicitud.

          La longitud mínima es 24 y la máxima es 24. El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

        • nombreDelRol string

          Etiqueta legible por humanos que identifica la colección de privilegios que MongoDB Cloud otorga a una clave API específica, a un usuario de MongoDB Cloud o a un equipo de MongoDB Cloud. Estos roles incluyen roles a nivel de organización y de proyecto.

          Roles de usuario de MongoDB Cloud
    • appName string Requerido

      Etiqueta legible por humanos que identifica el servicio desde el que solicitó esta respuesta.

      El valor es MongoDB Atlas.

    • compilar string Requerido

      Hash único de 40dígitos hexadecimales que identifica el último commit de git fusionado para esta aplicación.

    • regulación booleano Requerido

      Bandera que indica si alguien activó la limitación en este servicio.

  • 401 application/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 500 application/json

    Error interno del servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

GET /api/atlas/v1.0
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuesta (200)
{
  "apiKey": {
    "accessList": [
      {
        "cidrBlock": "string",
        "ipAddress": "string"
      }
    ],
    "id": "32b6e34b3d91647abb20e7b8",
    "publicKey": "string",
    "roles": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "orgId": "32b6e34b3d91647abb20e7b8",
        "roleName": "string"
      }
    ]
  },
  "appName": "MongoDB Atlas",
  "build": "83be55e140f493c88e7f578aae96548dd881587b",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "throttling": true
}
Ejemplos de respuesta (401)
{
  "badRequestDetail": {
    "fields": [
      {
        "description": "string",
        "field": "string"
      }
    ]
  },
  "detail": "string",
  "error": 42,
  "errorCode": "string",
  "parameters": [
    {}
  ],
  "reason": "string"
}
Ejemplos de respuesta (500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}