参照の使用

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示する。

TLS をサポートするように TargetServer を構成する場合は、参照を使用してキーストアまたはトラストストアを指定します。参照とは、キーストアの名前を格納する変数です。これを使用すれば、キーストアまたはトラストストアの名前を直接指定しなくて済みます。

参照は、次のような XML オブジェクトで表すことができます。

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

通常、現在のキーストア内の証明書は近い将来に期限切れになります。そのため、参照を使用することには、ターゲット サーバーで使用するキーストアを変更する際にその値を変更するだけでよいという利点があります。

参照はキーストアとトラストストアに対してのみ使用できます。エイリアスへの参照は使用できません。キーストアへの参照を変更するときは、証明書のエイリアス名が古いキーストアのものと同じであることを確認してください。

キーストアとトラストストアへの参照の使用に関する制限事項

ロードバランサがあり、ロードバランサで TLS を終端する場合、ターゲット サーバーでキーストアとトラストストアの参照を使用することはできません。

参照を作成する

Apigee UI または API を使用して新しい参照を作成できます。

Apigee UI

Google Cloud コンソールを使用して参照を作成するには:

  1. Google Cloud コンソールで、[管理] > [環境] ページに移動します。

    [環境] に移動

  2. 参照を作成する環境を選択します。

  3. [References] タブをクリックします。

  4. [Create Reference] をクリックします。

  5. [Create Reference] ペインで、次の詳細を入力します。
    • Name: 参照の名前。
    • Keystore: 参照が指すキーストア。

  6. [作成] をクリックします。

API

参照の作成 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

Google Cloud コンソールを使用して参照を変更するには:

  1. Google Cloud コンソールで、[管理] > [環境] ページに移動します。

    [環境] に移動

  2. 参照を変更する環境を選択します。

  3. [References] タブをクリックします。

  4. 表示されたリストで、変更する参照を選択します。

  5. [Actions] > [Edit] をクリックします。

  6. [Edit Reference] ペインで、参照の新しいキーストアを指定します。

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