Как проверить статус интеграции и настройки

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

На этой странице рассказывается, как проверить статус и настройки интеграции коннектора API-хаба Apigee Edge в организации Apigee Edge после того, как она будет включена.

Проверка настроек интеграции коннектора API Hub

Чтобы получить настройки интеграции коннектора API для организации, отправьте GET-запрос со следующим запросом:

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

Где:

• ORG_NAME – название вашей организации Apigee Edge.
• OAUTH_TOKEN – токен OAuth, используемый для аутентификации запроса. Подробнее о том, как получить токены OAuth…

Успешный ответ будет выглядеть примерно так:

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

"enabled": true – подтверждение того, что интеграция коннектора API-хаба активирована для организации.

"gatewayId" показывает название ресурса экземпляра, с которым связана организация Apigee Edge.

Как проверить сводный статус

Чтобы получить сводную информацию о статусе, в том числе подробные сведения о ходе загрузки, отправьте запрос GET в Edge Management API:

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

Где:

• ORG_NAME – название вашей организации Apigee Edge.

Успешный консолидированный ответ будет выглядеть примерно так, как показано ниже, с информацией о ходе загрузки прокси и сред. Ниже приведен пример этапа 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
      }
    }
  }
}

Объединенные поля статуса

Как проверить статус загрузки

Вы можете проверить подробный статус отдельного прокси-сервера API или среды, а также группы объектов, отфильтрованных по состоянию, с помощью конечной точки /details и параметров запроса.

Статус определенного товара

Чтобы проверить статус определенного объекта, используйте параметры запроса filter и name. Чтобы вызвать API статуса для прокси-сервера API с названием myproxy в организации acme, выполните следующие действия:

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

Чтобы вызвать API статуса для среды с названием myenv в организации acme, выполните следующие действия:

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

При вызове указанного выше API будет получен вывод в формате JSON, похожий на приведенный ниже (для недавно загруженного прокси-сервера):

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

Подробный статус с информацией о версии

Чтобы получить информацию об отдельной версии прокси-сервера, добавьте в запрос параметр showRevisions=true. В выходных данных будет приведена информация о каждой версии, загруженной для определенного прокси-сервера.

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

При вызове указанного выше API с параметром showrevisions будет получен ответ в формате JSON, похожий на приведенный ниже.

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

Статус загрузки группы

Чтобы получить статус загрузки для группы объектов, используйте фильтры групп с параметром запроса state.

Чтобы узнать статус всех прокси API, которые находятся в состоянии failed в организации acme, вызовите API статуса следующим образом:

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

Чтобы получить подробный список всех сред, для которых в организации acme ожидается загрузка, вызовите API статуса следующим образом:

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

В результате вызова этого API будет возвращена коллекция JSON с отдельными элементами статуса, соответствующими фильтру. Пример:

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

Параметры запроса для получения подробной информации о статусе

В API есть три параметра запроса. В значениях учитывается регистр.

Сочетания параметров для получения подробного статуса

В таблице ниже приведены возможные сочетания параметров, которые можно передать в REST API, чтобы получить подробный статус. NA означает, что параметр будет проигнорирован. NULL – параметр не указан.