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 da API do Apigee Edge na sua organização do Apigee Edge depois que ela é ativada.

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

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

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 OAuth usado para autenticar a solicitação. Para mais informações sobre como criar um token 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 da API está ativada para a organização.

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

Como verificar o status consolidado

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

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 à seguinte, 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

Como verificar o status detalhado do upload

É possível verificar o status detalhado de um proxy de API ou ambiente individual ou 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

A chamada da API acima resultará em uma saída JSON semelhante à seguinte para um proxy que foi enviado 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 de proxy 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 que foi enviada para um determinado proxy.

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

A chamada da API acima com o parâmetro showrevisions resultará em uma saída JSON semelhante à seguinte:

{
  "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 do grupo

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

Para o status de todos os proxies de API que estão em um 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 que estão 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.

Combinações de parâmetros para status detalhado

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