Verifica el estado y la configuración de la integración

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

En esta página, se describe cómo verificar el estado y la configuración de la integración del conector del concentrador de APIs de Apigee Edge en tu organización de Apigee Edge después de que se habilita.

Verifica la configuración de la integración del conector del concentrador de APIs

Para recuperar la configuración de la integración del conector del concentrador de APIs de una organización, realiza una solicitud GET para enviar la siguiente solicitud:

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

Donde:

  • ORG_NAME es el nombre de tu organización de Apigee Edge.
  • OAUTH_TOKEN es el token de OAuth que se usa para autenticar la solicitud. Para obtener más información sobre cómo crear un token de OAuth, consulta Obtén los tokens.

Una respuesta correcta se verá de la siguiente manera:

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

"enabled": true confirma que la integración del conector del concentrador de APIs está activada para la organización.

"gatewayId" muestra el nombre del recurso de la instancia a la que está conectada esta organización de Apigee Edge.

Verifica el estado consolidado

Para obtener un estado consolidado que incluya el progreso de carga detallado, realiza una solicitud GET a la API de administración de Edge:

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

Donde:

  • ORG_NAME es el nombre de tu organización de Apigee Edge.

Una respuesta consolidada correcta se verá de la siguiente manera, y mostrará el progreso de carga de los proxies y los entornos. En el siguiente ejemplo, se muestra una 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 estado consolidado

Campo Descripción
phase La fase de procesamiento actual de la organización. Los valores posibles son los siguientes:
  • Queued: La organización se agregó recientemente y está en cola para el procesamiento inicial.
  • Preparing: La organización está en un estado de transferencia directa en el que todos los proxies existentes se suben al concentrador de APIs. Este estado se produce cuando la organización se agrega recientemente y se está preparando.
  • Processing: La organización está en un estado de actualización continua en el que los cambios en los proxies y los entornos se suben continuamente al concentrador de APIs.
lastUpdated La marca de tiempo del último evento que se procesó para esta organización.
components Un mapa que proporciona información detallada sobre los proxies y los entornos que se procesaron. El mapa puede contener las siguientes claves:
  • proxy: Proporciona recuentos detallados de los proxies de API en el sistema Edge que se procesaron y subieron al concentrador de APIs.
  • environment: Proporciona recuentos detallados de los entornos en el sistema Edge que se procesaron y subieron al concentrador de APIs.
progress Los valores dentro de las secciones proxy o environment son los siguientes:
  • totalItems: Es la cantidad total de elementos.
  • pendingItems: Es la cantidad de elementos pendientes de procesamiento.
  • completedItems: Es la cantidad de elementos que se completaron correctamente.
  • failedItems: Es la cantidad de elementos que fallaron durante las cargas.

Verifica el estado de carga detallado

Puedes verificar el estado detallado de un proxy de API o un entorno individual, o un grupo de elementos filtrados por estado, mediante el extremo /details y los parámetros de consulta.

Estado de un elemento específico

Para verificar el estado detallado de un elemento específico, usa los parámetros de consulta filter y name. Para un proxy de API llamado myproxy en la organización acme, llama a la API de estado de la siguiente manera:

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

Para un entorno llamado myenv en la organización acme, llama a la API de estado de la siguiente manera:

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

Si llamas a la API anterior, se generará un resultado JSON similar al siguiente para un proxy que se subió recientemente:

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

Estado detallado con información de revisión

Es posible obtener información sobre la revisión de proxy individual para un proxy determinado si proporcionas un parámetro de consulta adicional showRevisions=true. El resultado que se genera aquí proporcionará detalles sobre cada revisión que se subió para un proxy determinado.

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

Si llamas a la API anterior con el parámetro showrevisions, se generará un resultado JSON similar al siguiente:

{
  "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",
    }  
  ]
}

Estado de carga del grupo

Puedes obtener estados de carga para un grupo de elementos mediante filtros de grupo con el parámetro de consulta state.

Para obtener el estado de todos los proxies de API que están en estado failed en la organización acme, llama a la API de estado de la siguiente manera:

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

Del mismo modo, para obtener una lista detallada de todos los entornos que están pending una carga en la organización acme, llama a la API de estado de la siguiente manera:

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

El resultado de llamar a esta API será una colección JSON de elementos de estado individuales que coincidan con el filtro. Ejemplo:

[
  {
    "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 el estado detallado

La API proporciona tres parámetros de consulta. Los valores distinguen entre mayúsculas y minúsculas.

Parámetro de consulta Valores posibles Descripción
filter proxy, environment Este parámetro de consulta indica que los resultados deben filtrarse por un proxy o un entorno.
state failed, pending, all Este parámetro de consulta indica que los resultados deben filtrarse por estado, además de filter.
name El nombre del elemento específico Este parámetro de consulta indica que los resultados deben filtrarse por nombre, además de filter.
showrevisions true, false Cuando se proporciona este parámetro de consulta, se genera el estado de revisión en el resultado (solo es válido cuando filter=proxy).

Combinaciones de parámetros para el estado detallado

En la siguiente tabla, se explican las posibles combinaciones de parámetros que se pueden pasar a la API de REST para obtener el estado detallado. NA indica que se ignorará el parámetro. NULL indica que no se proporciona el parámetro.

filter state nombre Resultados
proxy all NULL Informa los detalles de estado de todos los proxies.
proxy failed NULL Informa los detalles de estado de todos los proxies que no se pudieron subir.
proxy pending NULL Informa los detalles de estado de todos los proxies que están pendientes de carga o de volver a cargar.
proxy NULL myproxy Informa los detalles de estado de un proxy llamado myproxy.
proxy NON-NULL NON-NULL Informa un error.
environment all NULL Informa los detalles de estado de todos los entornos.
environment failed NULL Informa los detalles de estado de todos los entornos que no se pudieron subir.
environment pending NULL Informa los detalles de estado de todos los entornos que están pendientes de carga o de volver a cargar.
environment NULL myenv Informa los detalles de estado de un entorno llamado myenv.
environment NON-NULL NON-NULL Informa un error.