Obtener el estado de implementación de la política de la organización

OBTENER /api/v1/organizations/{id}/policies/rollout

Informa si todos los proyectos de la organización están ejecutando la última generación de políticas de plataforma, separando los proyectos que la puerta de enlace aún no ha materializado de los proyectos que el plano de datos aún no ha reconocido.

Parámetros de path

  • ID string Requerido

    identificador de la organización

Respuestas

  • Versión de API no compatible o con formato incorrecto, operación no disponible en el contrato publicado seleccionado o representación inaceptable (incluidos parámetros de tipo de medio no compatibles o SSE excluidos). Los fallos de autenticación, autorización y límite de velocidad existentes tienen prioridad.

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

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

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

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.

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

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

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

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.

  • 200

    OK

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • convergieron entero
    • letra muerta entero
    • proyectos rezagados arreglo[objeto]

      LaggingProjects muestrea los proyectos que están por debajo de la última generación, con un límite establecido por policyRolloutLaggingProjectLimit. Truncated indica si la muestra es parcial.

      Ocultar atributos de proyectos rezagados Mostrar atributos de proyectos rezagados Objeto
      • intentos entero
      • letra muerta booleano
      • tipo de fallo string

        FailureKind es una clasificación estable, no la causa directa. El error subyacente puede contener detalles del controlador y la infraestructura, y esta ruta es accesible para cualquier miembro de la organización, por lo que el texto sin procesar permanece en el documento y en los registros para los operadores.

      • Generación entero

        Generation es la última generación de tiempo de ejecución materializada para el proyecto, y ReceivedGeneration es la más reciente que ECP ha reconocido. Se diferencian mientras se está procesando un cambio en el plano de datos.

      • project_id string
      • motivo string
      • generación_recibida entero
    • missing_config entero

      MissingConfig cuenta los proyectos activos sin ninguna configuración de tiempo de ejecución. Esto se espera cuando la organización no tiene políticas (no hay nada que materializar); de lo contrario, es una brecha, por lo que se informa en lugar de integrarse en Converged.

    • org_id string
    • materialización pendiente entero
    • pendiente_de_publicar entero
    • proyectos_total entero

      ProjectsTotal cuenta los proyectos activos de la organización, no sus filas de configuración de tiempo de ejecución, por lo que un proyecto que nunca se ha materializado sigue apareciendo en el denominador.

    • truncado booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • convergieron entero
    • letra muerta entero
    • proyectos rezagados arreglo[objeto]

      LaggingProjects muestrea los proyectos que están por debajo de la última generación, con un límite establecido por policyRolloutLaggingProjectLimit. Truncated indica si la muestra es parcial.

      Ocultar atributos de proyectos rezagados Mostrar atributos de proyectos rezagados Objeto
      • intentos entero
      • letra muerta booleano
      • tipo de fallo string

        FailureKind es una clasificación estable, no la causa directa. El error subyacente puede contener detalles del controlador y la infraestructura, y esta ruta es accesible para cualquier miembro de la organización, por lo que el texto sin procesar permanece en el documento y en los registros para los operadores.

      • Generación entero

        Generation es la última generación de tiempo de ejecución materializada para el proyecto, y ReceivedGeneration es la más reciente que ECP ha reconocido. Se diferencian mientras se está procesando un cambio en el plano de datos.

      • project_id string
      • motivo string
      • generación_recibida entero
    • missing_config entero

      MissingConfig cuenta los proyectos activos sin ninguna configuración de tiempo de ejecución. Esto se espera cuando la organización no tiene políticas (no hay nada que materializar); de lo contrario, es una brecha, por lo que se informa en lugar de integrarse en Converged.

    • org_id string
    • materialización pendiente entero
    • pendiente_de_publicar entero
    • proyectos_total entero

      ProjectsTotal cuenta los proyectos activos de la organización, no sus filas de configuración de tiempo de ejecución, por lo que un proyecto que nunca se ha materializado sigue apareciendo en el denominador.

    • truncado booleano
  • Solicitud incorrecta

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • Forbidden

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • Error interno del servidor

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
GET /api/v1/organizations/{id}/policies/rollout
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/organizations/{id}/policies/rollout' \
 --header "Authorization: $API_KEY"
Ejemplos de respuesta (406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Ejemplos de respuesta (406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Ejemplos de respuesta (200)
{
  "converged": 42,
  "dead_lettered": 42,
  "lagging_projects": [
    {
      "attempts": 42,
      "dead_lettered": true,
      "failure_kind": "string",
      "generation": 42,
      "project_id": "string",
      "reason": "string",
      "received_generation": 42
    }
  ],
  "missing_config": 42,
  "org_id": "string",
  "pending_materialization": 42,
  "pending_publish": 42,
  "projects_total": 42,
  "truncated": true
}
Ejemplos de respuesta (200)
{
  "converged": 42,
  "dead_lettered": 42,
  "lagging_projects": [
    {
      "attempts": 42,
      "dead_lettered": true,
      "failure_kind": "string",
      "generation": 42,
      "project_id": "string",
      "reason": "string",
      "received_generation": 42
    }
  ],
  "missing_config": 42,
  "org_id": "string",
  "pending_materialization": 42,
  "pending_publish": 42,
  "projects_total": 42,
  "truncated": true
}
Ejemplos de respuesta (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (500)
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (500)
{
  "code": "string",
  "error": "string",
  "success": true
}