使用參照

本頁適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

設定 TargetServer 以支援 TLS 時,您可以使用參照指定金鑰庫或信任庫。參照是包含 KeyStore 或 TrustStore 名稱的變數,而非直接指定 KeyStore 或 TrustStore 名稱。

參照可以由 XML 物件表示,如下所示:

  <reference>
    <name>ReferenceName</name>
    <description>ReferencDescription</description>
    <resourceType>ReferredResourceType<resourceType>
    <refers>ReferredResource<refers>
  </reference>

使用參照的優點是,您可以變更參照的值,進而變更目標伺服器使用的 KeyStore,通常是因為目前 KeyStore 中的憑證即將到期。

您只能使用金鑰庫和信任庫的參照,無法使用別名的參照。變更參照至 Keystore 的連結時,請確認憑證的別名名稱與舊 Keystore 中的相同。

使用金鑰庫和信任存放區參照項目的限制

如果您有負載平衡器,且在負載平衡器上終止 TLS,則無法在目標伺服器中使用 KeyStore 和 TrustStore 參照。

建立參考檔案

您可以使用 Apigee UI 或 API 建立新的參照。

在 Apigee UI 中建立

如要使用 UI 建立參考檔案,請按照下列步驟操作:

  1. 登入 Apigee UI
  2. 選取貴機構的名稱。
  3. 依序選取「管理」>「環境」>「參照資料」
  4. 選取環境 (通常為 prodtest)。
  5. 選取「+ 參考資料」按鈕。
  6. 在「新增參考資料」彈出式視窗中:
    1. 新增參照的「名稱」
    2. 選取「Reference」,即參照的 KeyStore 或 TrustStore。
    3. 選取「新增參照」

在 Apigee API 中建立

如要使用 Create Reference API 呼叫建立參照,請按照下列步驟操作:

      curl -H "Authorization: Bearer $TOKEN" \
        -X POST \
        -d '{
            "reference": {
              "name": MyReferenceName",
              "resourceType": "KeyStore",
              "refers": "KeyStoreID"
            }
           }' \
        https://apigee.googleapis.com/v1/{parent=organizations/*/environments/*}/references

修改參照

您可以使用 Apigee UI 或 API 修改現有的參照。

在 Apigee UI 中修改

如要修改 UI 中參照的值,請按照下列步驟操作:

  1. 登入 Apigee UI
  2. 選取貴機構的名稱。
  3. 依序選取「管理」>「環境」>「參照資料」
  4. 選取環境 (通常為 prodtest)。
  5. 選取參考資料的「編輯」按鈕。
  6. 更新參照,指定新的 KeyStore 或 TrustStore。注意:請確認新 Keystore 中的別名與舊 Keystore 中的別名相同。
  7. 儲存更新內容。

在 Apigee API 中修改

如要變更參照項目,指向不同的 KeyStore,並確保新 KeyStore 中的別名與舊 KeyStore 中的別名相同,請使用 Update Reference API:

        curl -H "Authorization: Bearer $TOKEN" \
          -X PUT \
          -d '{
              "name": "MyReferenceName",
              "resourceType": "KeyStore",
              "refers": "KeyStoreID"
              }' \
        https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/references/*}