管理部署

本页面适用于 Apigee 和 Apigee Hybrid。

本文档介绍如何创建和管理 API 部署。另请参阅 API 部署简介。创建部署实体后，您可以将其关联到一个或多个 API 版本。

创建部署

您可以在控制台中或使用 REST API 创建部署实体。

控制台

如需创建新的部署，请执行以下操作：

在 Google Cloud 控制台中，转到 API Hub 页面。
转到 API Hub
点击 API。
使用过滤条件指定关键字以过滤 API 列表。如果需要，请使用搜索查找 API。
点击某个 API 以查看其详细信息。
在部署标签页下，点击添加部署。
在创建部署表单中指定部署详细信息：
- 部署 ID：点击Specify Unique ID（指定唯一 ID）以选择性地为部署提供唯一 ID。如果您省略 ID，API Hub 会为您创建一个 ID。ID 必须为 4-500 个字符，有效字符为 /[A-Z][a-z][0-9]-/.
- 部署名称：（必需）提供部署的显示名称。
- 说明：输入部署的说明。
- 部署类型：选择部署的类型。系统属性中定义了可能的值，您可以在 Manage attributes（管理属性）中修改这些值。
- Resource URI（资源 URI）：（必需）提供运行时资源的 URI。此 URI 可用于管理资源。例如，如果运行时资源是 Apigee API 代理，则此字段包含代理管理界面的 URI。
- 环境：映射到此部署的环境。环境会映射到系统定义的环境属性。
- 文档：输入指向部署文档的链接。
- SLO：为此部署提供 SLO。这会映射到 SLO 系统定义的属性。您可以在 Manage attributes（管理属性）中修改此属性的值。
- 端点：（必需）提供此部署资源在其中监听 API 请求的端点。可以是完整 URI、主机名或 IP 地址的列表。
- Link to a version（关联到版本）：将部署关联到一个或多个 API 版本。
- User defined attributes（用户定义的属性）：用户定义的键值对。您可以在 Manage attributes（管理属性）中添加用户定义的属性。
点击创建。

REST

如需使用创建部署 API 添加新部署，请执行以下操作：

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments?deployment_id=DEPLOYMENT_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME
    }'

替换以下内容：

HUB_PROJECT：API Hub 宿主项目的名称。预配 API Hub 时选择了宿主项目。
HUB_LOCATION：宿主项目的位置。该位置是在预配 API Hub 时选择的。
DEPLOYMENT_ID：（可选）部署的标识符。如果未提供，将使用系统生成的 ID。名称必须是 4-500 个字符的字符串，其中有效字符为 /[a-z][A-Z][0-9]-_/.
DISPLAY_NAME：（必需）部署的显示名称。您可以根据自己所需使用任何名称。
可选属性：除了必需的显示名称之外，您还可以将可选属性和实体附加到部署。REST API 参考文档的部署资源说明中介绍了这些其他项。

将部署关联到 API 版本

一个版本可以有一个或多个与之关联的部署。本部分介绍如何将部署关联到版本。您可以在创建版本时将部署关联到版本，也可以通过修改版本将部署关联到现有版本。请参阅创建 API 版本和修改版本。

如需将部署关联到新版本或现有版本，部署必须已存在。请参阅创建部署。

控制台

如需将部署添加到版本，请执行以下操作：

在 Google Cloud 控制台中，转到 API Hub 页面。
转到 API Hub
点击 API。
使用过滤条件指定关键字以过滤 API 列表。如果需要，请使用搜索查找 API。
选择一个 API。
在版本表中，找到您要修改的版本。
从版本行右侧的“操作”菜单中选择修改，或选择版本，然后点击详情页面中的修改版本。
在 Link to a deployment（关联到部署）下，选择要关联到版本的一个或多个部署，然后点击确定。
点击保存。

REST

将部署添加到版本的示例：

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
  '{
    "deployments": "DEPLOYMENTS"
  }'

请替换以下内容：

HUB_PROJECT：API Hub 宿主项目的名称。预配 API Hub 时选择了宿主项目。
HUB_LOCATION：宿主项目的位置。该位置是在预配 API Hub 时选择的。
API_NAME：包含您要修改的版本的 API 的名称。
VERSION_ID：要修改的版本的唯一 ID。
DEPLOYMENTS：一个或多个部署的完全限定资源名称。例如： "projects/myproject/locations/us-central1/deployments/mydeployment-1, projects/myproject/locations/us-central1/deployments/mydeployment-2"

列出部署

本部分介绍如何列出部署。您可以列出与 API 的所有版本关联的所有部署，或列出与特定版本关联的所有部署。

控制台

如需使用界面列出部署，请执行以下操作：

在 Google Cloud 控制台中，转到 API Hub 页面。
转到 API Hub
点击 API。
使用过滤条件指定关键字以过滤 API 列表。如果需要，请使用搜索查找 API。
点击某个 API 以查看其详细信息。
选择部署标签页以列出与 API 关联的所有部署。
如果要查看与某个版本关联的部署，请在版本标签页中选择该版本。

REST

如需列出所有部署，请使用列出部署 API：

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments"
        -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

替换以下内容：

HUB_PROJECT：API Hub 宿主项目的名称。预配 API Hub 时选择了宿主项目。
HUB_LOCATION：宿主项目的位置。该位置是在预配 API Hub 时选择的。

获取部署详细信息

本部分介绍了如何获取有关 API 部署的详细信息。

控制台

如需查看部署的详细信息，请执行以下操作：

在 Google Cloud 控制台中，转到 API Hub 页面。
转到 API Hub
点击 API。
使用过滤条件指定关键字以过滤 API 列表。如果需要，请使用搜索查找 API。
点击某个 API 以查看其详细信息。
选择部署标签页以列出与 API 关联的所有部署。
选择部署以查看其详情页面。

REST

如需查看部署的详细信息，请使用获取部署详情 API：

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

替换以下内容：

HUB_PROJECT：API Hub 宿主项目的名称。预配 API Hub 时选择了宿主项目。
HUB_LOCATION：宿主项目的位置。该位置是在预配 API Hub 时选择的。
DEPLOYMENT_ID：部署的唯一 ID。

删除 API 部署

本部分介绍如何删除 API 部署。

控制台

如需使用界面删除 API 资源，请执行以下操作：

在 Google Cloud 控制台中，转到 API Hub 页面。
转到 API Hub
点击 API。
使用过滤条件指定关键字以过滤 API 列表。如果需要，请使用搜索查找 API。
点击某个 API 以查看其详细信息。
选择部署标签页以列出与 API 关联的所有部署。
找到您要删除的部署。
从部署的操作菜单中选择删除。

REST

如需从 API Hub 中删除 API 资源，请使用删除部署 API：

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

请替换以下内容：

HUB_PROJECT：API Hub 宿主项目的名称。预配 API Hub 时选择了宿主项目。
HUB_LOCATION：宿主项目的位置。该位置是在预配 API Hub 时选择的。
DEPLOYMENT_ID：要删除的部署的唯一 ID。

修改部署

本部分介绍如何修改部署。

控制台

在 Google Cloud 控制台中，转到 API Hub 页面。
转到 API Hub
点击 API。
使用过滤条件指定关键字以过滤 API 列表。如果需要，请使用搜索查找 API。
点击某个 API 以查看其详细信息。
选择部署标签页以列出与 API 关联的所有部署。
找到要修改的部署。
从部署的“操作”菜单中选择修改，或点击部署，然后点击“部署详情”面板中的修改部署。

REST

如需修改部署，请使用补丁部署 API：

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
      -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
      '{
        DEPLOYMENT_ATTRIBUTES
      {'

替换以下内容：

HUB_PROJECT：API Hub 宿主项目的名称。预配 API Hub 时选择了宿主项目。
HUB_LOCATION：宿主项目的位置。该位置是在预配 API Hub 时选择的。
DEPLOYMENT_ID：要修改的部署的唯一 ID。
DEPLOYMENT_ATTRIBUTES：在请求正文中附加要修改的属性。REST API 参考文档中的部署资源说明介绍了可修改的属性。