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

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

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

Проверка настроек интеграции коннектора API-хаба

Чтобы получить настройки интеграции коннектора 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 запрос к API управления Edge:

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-прокси с именем myproxy в организации acme вызовите API статуса следующим образом:

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

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

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-прокси, находящихся в состоянии сбоя в организации 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 означает, что параметр не предоставлен.