統合のステータスと設定を確認する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご覧ください。 info

このページでは、Apigee Edge 組織で Apigee Edge API Hub コネクタ統合を有効にした後に、そのステータスと設定を確認する方法について説明します。

API Hub コネクタの統合設定を確認する

組織の API Hub コネクタ統合設定を取得するには、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 Hub コネクタ統合が組織で有効になっていることを確認します。

"gatewayId" には、この Apigee Edge 組織が接続されているインスタンス リソース名が表示されます。

統合ステータスの確認

アップロードの詳細な進行状況を含む統合ステータスを取得するには、Edge 管理 API に GET リクエストを送信します。

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
      }
    }
  }
}

統合ステータス フィールド

フィールド 説明
phase 組織の現在の処理フェーズ。有効な値は次のとおりです。
  • Queued: 組織が最近追加され、初期処理のためにキューに登録されています。
  • Preparing: 組織はコールド転送状態にあり、既存のすべてのプロキシが API Hub にアップロードされています。この状態は、組織が最近追加され、準備中である場合に発生します。
  • Processing: 組織は継続的更新状態にあり、プロキシと環境の変更が API Hub に継続的にアップロードされています。
lastUpdated この組織で処理された最後のイベントのタイムスタンプ。
components 処理されたプロキシと環境に関する詳細情報を提供するマップ。マップには次のキーを含めることができます。
  • proxy: Edge システムで処理され、API Hub にアップロードされた API プロキシの詳細な数を提供します。
  • environment: 処理されて API Hub にアップロードされた Edge システム内の環境の詳細な数を提供します。
progress proxy セクションまたは environment セクションの値は次のとおりです。
  • totalItems: アイテムの合計数。
  • pendingItems: 処理待ちのアイテムの数。
  • completedItems: 正常に完了したアイテムの数。
  • failedItems: アップロード中に失敗したアイテムの数。

アップロードの詳細なステータスを確認する

/details エンドポイントとクエリ パラメータを使用すると、個々の API プロキシまたは環境の詳細なステータスや、状態でフィルタされたアイテムのグループを確認できます。

特定のアイテムのステータス

特定アイテムの詳細なステータスを確認するには、filter と name のクエリ パラメータを使用します。組織 acme の myproxy という名前の API プロキシの場合、ステータス API は次のように呼び出します。

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

組織 acme の環境 myenv の場合、ステータス 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 クエリ パラメータでグループ フィルタを使用すると、アイテムのグループのアップロード ステータスを取得できます。

組織 acme で 失敗状態のすべての API プロキシのステータスを取得するには、次のようにステータス 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 には 3 つのクエリ パラメータがあります。値では大文字と小文字が区別されます。

クエリ パラメータ 有効な値 説明
filter proxy、environment このクエリ パラメータは、プロキシまたは環境で結果をフィルタする必要があることを示します。
state failed、pending、all このクエリ パラメータは、filter に加えて、結果を状態でフィルタする必要があることを示します。
name 特定のアイテムの名前 このクエリ パラメータは、filter に加えて名前で結果をフィルタする必要があることを示します。
showrevisions true、false このクエリ パラメータを指定すると、出力にリビジョン ステータスが生成されます（filter=proxy の場合にのみ有効）。

詳細ステータスのパラメータの組み合わせ

次の表に、詳細なステータスを取得するために REST API に渡すことができるパラメータの組み合わせを示します。NA は、パラメータが無視されることを示します。NULL は、パラメータが指定されていないことを示します。

フィルタ state name 結果
proxy all NULL すべてのプロキシのステータスの詳細をレポートします。
proxy failed NULL アップロードに失敗したすべてのプロキシのステータスの詳細をレポートします。
proxy pending NULL アップロードまたは再アップロードが保留中のすべてのプロキシのステータスの詳細をレポートします。
proxy NULL myproxy myproxy という名前のプロキシのステータスの詳細をレポートします。
proxy NON-NULL NON-NULL エラーを報告します。
environment all NULL すべての環境のレポート ステータスの詳細。
environment failed NULL アップロードに失敗したすべての環境のステータスの詳細をレポートします。
environment pending NULL アップロードまたは再アップロードが保留中のすべての環境のステータスの詳細を報告します。
environment NULL myenv myenv という名前の環境のステータスの詳細をレポートします。
environment NON-NULL NON-NULL エラーを報告します。