参照の使用

このページの内容は 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 で作成する

UI を使用してリファレンスを作成するには:

Apigee UI にログインします。
組織の名前を選択します。
[Admin] > [Environments] > [References] を選択します。
環境を選択します（通常は prod または test）。
[+ Reference] ボタンを選択します。
[Add Reference] ポップアップで、次の操作を行います。
1. 参照の名前を追加します。
2. [Reference] で、参照先のキーストアまたはトラストストアを選択します。
3. [Add Reference] を選択します。

Apigee 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 で変更する

UI で参照の値を変更するには:

Apigee UI にログインします。
組織の名前を選択します。
[Admin] > [Environments] > [References] を選択します。
環境を選択します（通常は prod または test）。
参照の [Edit] ボタンを選択します。
参照を更新して、新しいキーストアまたはトラストストアを指定します。注意: 新しいキーストアのエイリアスは、古いキーストアのエイリアスと同じ名前にしてください。
更新を保存します。

Apigee API で変更する

別のキーストアを指すように参照を変更し、新しいキーストアのエイリアス名を古いキーストアのエイリアス名と同じにするには、参照の更新 API を使用します。

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