查看整合狀態和設定

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

本頁面說明啟用 Apigee Edge API 中心連接器整合功能後，如何在 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 機構連線的執行個體資源名稱。

查看合併狀態

如要取得包含詳細上傳進度的彙整狀態，請對 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 機構的名稱。

成功的回應會類似以下內容，顯示 Proxy 和環境的上傳進度。以下範例顯示 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：機構處於冷轉移狀態，所有現有 Proxy 都會上傳至 API 中樞。這個狀態表示機構最近才新增，目前正在準備中。
  • Processing：機構處於持續更新狀態，系統會持續將 Proxy 和環境的變更上傳至 API 中心。
lastUpdated 這個機構處理的最後一個事件的時間戳記。
components 地圖：提供已處理的 Proxy 和環境詳細資訊。地圖可包含下列鍵：
  • proxy：詳細列出 Edge 系統中已處理並上傳至 API 中心的 API Proxy 數量。
  • environment：提供 Edge 系統中已處理並上傳至 API 中心的環境詳細計數。
progress proxy 或 environment 區段中的值包括：
  • totalItems：項目總數。
  • pendingItems：待處理的項目數量。
  • completedItems：成功完成的項目數量。
  • failedItems：上傳失敗的項目數量。

查看詳細上傳狀態

您可以使用 /details 端點和查詢參數，檢查個別 API Proxy 或環境的詳細狀態，或是依狀態篩選的一組項目。

特定項目的狀態

如要查看特定項目的詳細狀態，請使用 filter 和 name 查詢參數。如要呼叫機構 acme 中名為 myproxy 的 API Proxy 狀態 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，適用於最近上傳的 Proxy：

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

詳細狀態和修訂資訊

您可以提供額外的查詢參數 showRevisions=true，取得特定 Proxy 修訂版本的相關資訊。這裡產生的輸出內容會提供特定 Proxy 上傳的每個修訂版本詳細資料。

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

使用 showrevisions 參數呼叫上述 API，會產生類似下列內容的 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 Proxy，請呼叫狀態 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 提供三個查詢參數。值會區分大小寫。

查詢參數 可能的值 說明
filter proxy、environment 這個查詢參數表示結果需要依 Proxy 或環境篩選。
state failed、pending、all 這個查詢參數表示除了 filter 之外，還需要依州別篩選結果。
name 特定項目的名稱 這個查詢參數表示除了 filter 之外，結果也需要依名稱篩選。
showrevisions true、false 如果提供這個查詢參數，輸出內容就會產生修訂版本狀態 (僅在 filter=proxy 時有效)。

詳細狀態的參數組合

下表說明可傳遞至 REST API 的參數組合，以便取得詳細狀態。NA 表示系統會忽略該參數。NULL 表示未提供參數。

篩選 州 名稱 結果
proxy all NULL 所有 Proxy 的報表狀態詳細資料。
proxy failed NULL 所有上傳失敗的 Proxy 報告狀態詳細資料。
proxy pending NULL 針對所有待上傳或重新上傳的 Proxy，提供報告狀態詳細資料。
proxy NULL myproxy 回報名為 myproxy 的 Proxy 狀態詳細資料。
proxy NON-NULL NON-NULL 回報錯誤。
environment all NULL 回報所有環境的狀態詳細資料。
environment failed NULL 針對上傳失敗的所有環境，提供報表狀態詳細資料。
environment pending NULL 針對所有待上傳或重新上傳的環境，提供報表狀態詳細資料。
environment NULL myenv 回報名為「myenv」的環境狀態詳細資料。
environment NON-NULL NON-NULL 回報錯誤。