使用參照

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

設定 TargetServer 支援 TLS 時，您可以使用參照指定金鑰儲存區或信任儲存區。參考是包含 KeyStore 或信任儲存區名稱的變數，而不是直接指定 KeyStore 或信任儲存區名稱。

參照可以由 XML 物件表示，如下所示：

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

使用參照的優點是，您可以變更參照的值，藉此變更目標伺服器使用的金鑰儲存區，通常是因為目前金鑰儲存區中的憑證即將到期。

您只能參照金鑰儲存區和信任儲存區，不能參照別名。變更 Keystore 的參照時，請確保憑證的別名與舊 Keystore 中的別名相同。

使用金鑰儲存區和信任儲存區參照的限制

如果您有負載平衡器，並在負載平衡器上終止 TLS，就無法在目標伺服器中使用金鑰儲存區和信任儲存區參照。

建立參考檔案

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

Apigee in Google Cloud console

如要使用 Google Cloud 控制台建立參照，請按照下列步驟操作：

  1. 在 Google Cloud 控制台中，前往「管理」>「環境」頁面。

    前往「環境」

  2. 選取要建立參照的環境。

  3. 按一下「參考資料」分頁標籤。

  4. 按一下「建立參照」。

  5. 在「建立參照」窗格中，輸入下列詳細資料：
    • 名稱：參照的名稱。
    • Keystore：參照指向的金鑰存放區。

  6. 點選「建立」。

傳統版 UI

如要使用 UI 建立參照，請按照下列步驟操作：

  1. 登入 Apigee 使用者介面。
  2. 選取機構名稱。
  3. 依序選取「管理」>「環境」>「參照」。
  4. 選取環境 (通常是 prod 或 test)。
  5. 選取「+ 參考資料」按鈕。
  6. 在「新增參照」彈出式視窗中：
    1. 新增參照的名稱。
    2. 選取「參考資料」，即所參照的 KeyStore 或 TrustStore。
    3. 選取「新增參照」。

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 使用者介面或 API 修改現有參照。

Apigee in Google Cloud console

如要使用 Google Cloud 控制台修改參照，請按照下列步驟操作：

  1. 在 Google Cloud 控制台中，前往「管理」>「環境」頁面。

    前往「環境」

  2. 選取要修改參照的環境。

  3. 按一下「參考資料」分頁標籤。

  4. 在顯示的清單中，選取要修改的參照。

  5. 依序點按 「動作」>「編輯」。

  6. 在「Edit Reference」(編輯參照) 窗格中，更新參照以指定新的金鑰儲存區。

  7. 按一下「更新」。

傳統版 Apigee UI

如要在 UI 中修改參照的值，請按照下列步驟操作：

  1. 登入 Apigee 使用者介面。
  2. 選取機構名稱。
  3. 依序選取「管理」>「環境」>「參照」。
  4. 選取環境 (通常是 prod 或 test)。
  5. 選取參照的「編輯」按鈕。
  6. 更新參照，指定新的金鑰儲存區或信任儲存區。注意： 請確認新金鑰儲存區中的別名與舊金鑰儲存區中的別名名稱相同。
  7. 儲存更新內容。

API

如要變更參照，指向其他金鑰儲存區，並確保新金鑰儲存區中的別名與舊金鑰儲存區中的別名名稱相同，請使用「更新參照」API：

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