Obter status de implementação da política da organização

OBTER /api/v1/organizations/{id}/policies/rollout
Autenticação do portador

Informa se cada projeto na organização está executando a geração de política de plataforma mais recente, separando projetos que o gateway ainda não materializou de projetos que o plano de dados ainda não reconheceu.

parâmetros de caminho

  • id string Obrigatório

    ID da organização

Respostas

  • 406

    Versão de API não permitida ou malformada, uma operação indisponível no contrato publicado selecionado ou uma representação inaceitável (incluindo parâmetros de tipo de mídia não suportados ou SSE excluído). Falhas existentes de autenticação, autorização e limite de taxa têm precedência.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.
  • 200

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • convergiu inteiro
    • dead_lettered inteiro
    • lagging_projects array[objeto]

      O LaggingProjects amostra os projetos por trás da última geração, limitados a políticaRolloutLaggingProjectLimit. Truncado informa se a amostra é parcial.

      Ocultar atributos lagging_projects Mostrar atributos lagging_projects objeto
      • tentativas inteiro
      • dead_lettered booleano
      • failure_type string

        O failureKind é uma classificação estável, não a causa bruta. O erro subjacente pode conter detalhes do driver e da infraestrutura e essa rota é acessível a qualquer membro da organização, portanto o texto bruto permanece no documento e nos registros para os operadores.

      • geração inteiro

        Geração é a mais recente geração de tempo de execução materializada para o projeto, e ReceberedGeneration é a mais recente reconhecida pelo ECP. Eles diferem enquanto uma alteração está em andamento no plano de dados.

      • PROJECT_ID string
      • Razão string
      • recebida_geração inteiro
    • missing_config inteiro

      missingconfig conta os projetos ativos sem nenhuma configuração de tempo de execução. Esperado quando a organização não tem políticas (não há nada para materializar); caso contrário, é uma lacuna, e é por isso que é relatada em vez de dobrada na Convergida.

    • org_id string
    • pending_materialization inteiro
    • pending_publish inteiro
    • projetos_total inteiro

      O ProjectsTotal conta os projetos ativos da organização, não suas linhas de configuração de tempo de execução, portanto, um projeto que nunca se materializou ainda aparece no denominador.

    • truncado booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • convergiu inteiro
    • dead_lettered inteiro
    • lagging_projects array[objeto]

      O LaggingProjects amostra os projetos por trás da última geração, limitados a políticaRolloutLaggingProjectLimit. Truncado informa se a amostra é parcial.

      Ocultar atributos lagging_projects Mostrar atributos lagging_projects objeto
      • tentativas inteiro
      • dead_lettered booleano
      • failure_type string

        O failureKind é uma classificação estável, não a causa bruta. O erro subjacente pode conter detalhes do driver e da infraestrutura e essa rota é acessível a qualquer membro da organização, portanto o texto bruto permanece no documento e nos registros para os operadores.

      • geração inteiro

        Geração é a mais recente geração de tempo de execução materializada para o projeto, e ReceberedGeneration é a mais recente reconhecida pelo ECP. Eles diferem enquanto uma alteração está em andamento no plano de dados.

      • PROJECT_ID string
      • Razão string
      • recebida_geração inteiro
    • missing_config inteiro

      missingconfig conta os projetos ativos sem nenhuma configuração de tempo de execução. Esperado quando a organização não tem políticas (não há nada para materializar); caso contrário, é uma lacuna, e é por isso que é relatada em vez de dobrada na Convergida.

    • org_id string
    • pending_materialization inteiro
    • pending_publish inteiro
    • projetos_total inteiro

      O ProjectsTotal conta os projetos ativos da organização, não suas linhas de configuração de tempo de execução, portanto, um projeto que nunca se materializou ainda aparece no denominador.

    • truncado booleano
  • 400

    Solicitação inválida

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 403

    Proibido

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 500

    Erro interno do servidor

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso 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"
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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
}
Exemplos de resposta (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
}
Exemplos de resposta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}