Iniciar una simulación de Interrupción del servicio

publicación /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/outageSimulation

Inicia una simulación de Interrupción del servicio del clúster.

Simulación de interrupción del clúster

Parámetros de path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /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 id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

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

  • Nombre del clúster string Requerido

    Etiqueta legible por humanos que identifica el clúster para experimentar una simulación de Interrupción del servicio.

    El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

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.

    Impresión bonita
aplicación/json

Cuerpo Requerido

Describe la simulación de Interrupción del servicio.

  • outageFilters arreglo[objeto]

    Lista de configuraciones que especifican el tipo de simulación de interrupciones del servicio del clúster.

    At least 1 element.

    Oculta los atributos outageFilters. Mostrar atributos outageFilters Objeto
    • Proveedor de la nube string

      El proveedor de nube de la región que experimenta la simulación de interrupción del servicio.

      Los valores son AWS, GCP o AZURE.

    • Nombre de la región string

      El nombre de la región que se someterá a una simulación de Interrupción del servicio.

    • tipo string

      La clase de interrupción del servicio de clúster que se quiere simular. La clase de falla de clúster que se quiere simular. REGION simula una interrupción del servicio del clúster en una región.

      El valor es REGION.

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Nombre del clúster string

      Etiqueta legible para humanos que identifica el clúster que se somete a la simulación de Interrupción del servicio.

      El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

    • expirationDate string(date-time)

      Fecha y hora en que MongoDB Cloud finaliza la simulación de interrupción. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC. Si no se proporciona, el valor predeterminado es 3 días desde la fecha de inicio.

    • ID del grupo string

      string única de caracteres hexadecimales 24que identifica el Proyecto que contiene el clúster que será sometido a una simulación de Interrupción del servicio.

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

    • ID string

      Cadena de caracteres hexadecimal única de 24que identifica la simulación de Interrupción del servicio.

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

    • outageFilters arreglo[objeto]

      Lista de configuraciones que especifican el tipo de simulación de interrupciones del servicio del clúster.

      At least 1 element.

      Oculta los atributos outageFilters. Mostrar atributos outageFilters Objeto
      • Proveedor de la nube string

        El proveedor de nube de la región que experimenta la simulación de interrupción del servicio.

        Los valores son AWS, GCP o AZURE.

      • Nombre de la región string

        El nombre de la región que se someterá a una simulación de Interrupción del servicio.

      • tipo string

        La clase de interrupción del servicio de clúster que se quiere simular. La clase de falla de clúster que se quiere simular. REGION simula una interrupción del servicio del clúster en una región.

        El valor es REGION.

    • startRequestDate string(date-time)

      Fecha y hora en que MongoDB Cloud inició la simulación de Interrupción del servicio regional. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • Estado string

      Fase de la simulación de la Interrupción del servicio.

      Estado Indicación
      START_REQUESTED El usuario ha solicitado la simulación de una Interrupción del servicio de clúster.
      STARTING MongoDB Nube está iniciando la simulación de una interrupción del servicio de clúster.
      SIMULATING MongoDB Cloud está simulando una interrupción del clúster.
      RECOVERY_REQUESTED El usuario ha solicitado la recuperación de la interrupción simulada.
      RECOVERING MongoDB Cloud está recuperando el clúster de la interrupción del servicio simulada.
      COMPLETE MongoDB Cloud ha completado la simulación de interrupción del clúster.

      Los valores son START_REQUESTED, STARTING, SIMULATING, RECOVERY_REQUESTED, RECOVERING o COMPLETE.

  • 400 aplicación/json

    Solicitud incorrecta.

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

      Detalle de solicitud incorrecta.

      Ocultar 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

      Código de error de aplicación devuelto 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.

  • 401 aplicación/json

    No autorizado.

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

      Detalle de solicitud incorrecta.

      Ocultar 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

      Código de error de aplicación devuelto 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.

  • 403 aplicación/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

      Ocultar 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

      Código de error de aplicación devuelto 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.

  • 404 aplicación/json

    No se encontró.

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

      Detalle de solicitud incorrecta.

      Ocultar 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

      Código de error de aplicación devuelto 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 aplicación/json

    Error interno del servidor.

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

      Detalle de solicitud incorrecta.

      Ocultar 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

      Código de error de aplicación devuelto 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.

POST /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/outageSimulation
curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/outageSimulation' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"outageFilters":[{"cloudProvider":"AWS","regionName":"string","type":"REGION"}]}'
Solicitar ejemplos
{
  "outageFilters": [
    {
      "cloudProvider": "AWS",
      "regionName": "string",
      "type": "REGION"
    }
  ]
}
Ejemplos de respuestas (200)
{
  "clusterName": "string",
  "expirationDate": "2026-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "outageFilters": [
    {
      "cloudProvider": "AWS",
      "regionName": "string",
      "type": "REGION"
    }
  ],
  "startRequestDate": "2026-05-04T09:42:00Z",
  "state": "START_REQUESTED"
}
Ejemplos de respuestas (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
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"
}