Verificar o status e as configurações da integração

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Nesta página, descrevemos como verificar o status e as configurações da integração do conector do hub de API do Apigee Edge na sua organização do Apigee Edge depois que ela é ativada.

Verificando as configurações de integração do conector do hub da API

Para recuperar as configurações de integração do conector do hub de API de uma organização, faça uma solicitação GET para enviar o seguinte pedido:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/settings -H "Authorization: Bearer OAUTH_TOKEN"

Em que:

  • ORG_NAME é o nome da sua organização do Apigee Edge.
  • OAUTH_TOKEN é o token do OAuth usado para autenticar a solicitação. Para mais informações sobre como criar um token do OAuth, consulte Receber os tokens.

Uma resposta bem-sucedida será semelhante a esta:

  {
    "enabled": true,
    "gatewayId": "my-gateway-id"
  }

"enabled": true confirma que a integração do conector do hub de API está ativada para a organização.

"gatewayId" mostra o nome do recurso da instância a que esta organização do Apigee Edge está conectada.

Verificando o status consolidado

Para um status consolidado que inclua o progresso detalhado do upload, faça uma solicitação GET à API Edge Management:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/status
  -H "Authorization: Bearer OAUTH_TOKEN

Em que:

  • ORG_NAME é o nome da sua organização do Apigee Edge.

Uma resposta consolidada bem-sucedida será semelhante a esta, mostrando o progresso do upload de proxies e ambientes. O exemplo abaixo mostra uma fase Queued:

{
  "phase": "Preparing",
  "lastUpdated": "2025-09-15T02:23:50.706Z",
  "components": {
    "proxy": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 10,
        "pendingItems": 1,
        "completedItems": 9,
        "failedItems": 0
      }
    },
    "environment": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 5,
        "pendingItems": 0,
        "completedItems": 4,
        "failedItems": 1
      }
    }
  }
}

Campos de status consolidados

Campo Descrição
phase A fase de processamento atual da organização. Os valores possíveis são:
  • Queued: a organização foi adicionada recentemente e está na fila para processamento inicial.
  • Preparing: a organização está em um estado de transferência fria em que todos os proxies atuais estão sendo enviados para o hub de API. Esse estado ocorre quando a organização foi adicionada recentemente e está sendo preparada.
  • Processing: a organização está em um estado de atualização contínua em que as mudanças nos proxies e ambientes são enviadas continuamente para o hub de API.
lastUpdated O carimbo de data/hora do último evento processado para essa organização.
components Um mapa com informações detalhadas sobre os proxies e ambientes processados. O mapa pode conter as seguintes chaves:
  • proxy: fornece contagens detalhadas de proxies de API no sistema do Edge que foram processados e enviados por upload para o hub de API.
  • environment: fornece contagens detalhadas de ambientes no sistema Edge que foram processados e enviados para o hub de APIs.
progress Os valores nas seções proxy ou environment são:
  • totalItems: o número total de itens.
  • pendingItems: o número de itens pendentes de processamento.
  • completedItems: o número de itens concluídos.
  • failedItems: o número de itens que falharam durante os envios.

Verificar o status detalhado do upload

É possível verificar o status detalhado de um proxy de API ou ambiente individual ou de um grupo de itens filtrados por estado usando o endpoint /details e os parâmetros de consulta.

Status de um item específico

Para verificar o status detalhado de um item específico, use os parâmetros de consulta filter e name. Para um proxy de API chamado myproxy na organização acme, chame a API de status da seguinte maneira:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/acme/uapim/status/details?filter=proxy&name=myproxy \
  -H "Authorization: Bearer OAUTH_TOKEN"

Para um ambiente chamado myenv na organização acme, chame a API de status da seguinte maneira:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&name=myenv

Chamar a API acima vai resultar em uma saída JSON semelhante à seguinte para um proxy enviado por upload recentemente:

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
}

Status detalhado com informações de revisão

É possível receber informações sobre a revisão individual de um determinado proxy fornecendo um parâmetro de consulta adicional showRevisions=true. A saída gerada aqui vai fornecer detalhes sobre cada revisão enviada para um determinado proxy.

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&name=myproxy&showRevisions=true

Chamar a API acima com o parâmetro showrevisions vai resultar em uma saída JSON semelhante a esta:

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
  "revisions": [
    {
      "name": "1",
      "status": "Up to date",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
    },  
    {
      "name": "2",
      "status": "Pending upload",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:55.000Z",
    }  
  ]
}

Status do upload de grupo

É possível receber os status de upload de um grupo de itens usando filtros de grupo com o parâmetro de consulta state.

Para o status de todos os proxies de API no estado com falha na organização acme, chame a API de status da seguinte maneira:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&state=failed

Da mesma forma, para receber uma lista detalhada de todos os ambientes pendentes de um upload na organização acme, chame a API de status da seguinte maneira:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&state=pending

O resultado da chamada dessa API será uma coleção JSON de itens de status individuais que correspondem ao filtro. Exemplo:

[
  {
    "name": "myProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:50.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:50.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  },
  {
    "name": "secondProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:51.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:51.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  }
]

Parâmetros de consulta para status detalhado

A API fornece três parâmetros de consulta. Os valores diferenciam maiúsculas de minúsculas.

Parâmetro de consulta Possíveis valores Descrição
filter proxy, environment Esse parâmetro de consulta indica que os resultados precisam ser filtrados por um proxy ou um ambiente.
state failed, pending, all Esse parâmetro de consulta indica que os resultados precisam ser filtrados por estado, além do filter.
name O nome do item específico Esse parâmetro de consulta indica que os resultados precisam ser filtrados por nome, além do filter.
showrevisions true, false Quando fornecido, esse parâmetro de consulta gera o status da revisão na saída (válido apenas quando filter=proxy).

Combinações de parâmetros para status detalhado

A tabela abaixo explica as possíveis combinações de parâmetros que podem ser transmitidas à API REST para receber um status detalhado. NA indica que o parâmetro será ignorado. NULL indica que o parâmetro não foi fornecido.

filtrar estado nome Resultados
proxy all NULL Detalhes do status do relatório para todos os proxies.
proxy failed NULL Detalhes do status do relatório para todos os proxies que não foram enviados.
proxy pending NULL Detalhes do status do relatório para todos os proxies pendentes de upload ou reenvio.
proxy NULL myproxy Relata detalhes do status de um proxy chamado myproxy.
proxy NON-NULL NON-NULL Informa um erro.
environment all NULL Relatar detalhes do status de todos os ambientes.
environment failed NULL Detalhes do status do relatório para todos os ambientes que não foram enviados.
environment pending NULL Detalhes do status do relatório para todos os ambientes pendentes de upload ou reenvio.
environment NULL myenv Detalhes do status do relatório para um ambiente chamado myenv.
environment NON-NULL NON-NULL Informa um erro.