使用引用

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

配置 TargetServer 以支持 TLS 时，您可以使用引用指定密钥库或信任库。引用是一个包含密钥库或信任库名称的变量，而不是直接指定密钥库或信任库名称。

引用可通过 XML 对象表示，如下所示：

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

使用引用的优势在于，您可以更改引用的值以更改目标服务器使用的密钥库，更改的原因通常是因为当前密钥库中的证书即将过期。

您只能使用密钥库和信任库的引用；而不能使用别名的引用。更改密钥库的引用时，确保证书的别名与旧密钥库中的别名相同。

使用密钥库和信任库的引用方面的限制

如果您有负载均衡器并在负载均衡器上终止 TLS，则无法在目标服务器中使用密钥库和信任库引用。

创建引用

您可以使用 Apigee 界面或 API 创建新的引用。

在 Apigee 界面中创建

如需使用界面创建引用，请执行以下操作：

1. 登录 Apigee 界面。
2. 选择您的组织的名称。
3. 选择 管理 > 环境 > 引用。
4. 选择环境（通常是 prod 或 test）。
5. 选择 + 引用按钮。
6. 在添加引用弹出式窗口中：
   1. 添加引用的名称。
   2. 选择引用（引用的密钥库或信任库）。
   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 界面或 API 来修改现有引用。

在 Apigee 界面中修改

要在界面中修改引用的值，请执行以下操作：

1. 登录 Apigee 界面。
2. 选择您的组织的名称。
3. 选择 管理 > 环境 > 引用。
4. 选择环境（通常是 prod 或 test）。
5. 为引用选择修改按钮。
6. 更新引用以指定新的密钥库或信任库。注意：请确保新密钥库中的别名与旧密钥库中的别名相同。
7. 保存更新。

在 Apigee API 中修改

要更改指向其他密钥库的引用，以确保新密钥库中的别名与旧密钥库中的别名相同，请使用 Update Reference 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/*}