开始在 Apigee 中使用 gcloud

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

通过 gcloud apigee CLI,您可以执行以下操作:

  • 查看 API 代理
  • 创建和管理 API 产品
  • 部署和取消部署 API 代理,以及查看部署详细信息
  • 查看有关开发者和应用的信息
  • 列出您的环境和组织
  • 管理调用 Apigee API 代理的第三方应用

此外,gcloud beta apigee CLI 还可让您在 Apigee 环境中部署和管理归档。

以下几个部分介绍如何安装、授权和使用 gcloud apigee 和 gcloud beta apigee CLI,以及如何选择性地设置环境变量。

准备工作

确保您满足使用 Apigee 的前提条件,包括安装 Google Cloud SDK。

安装 gcloud beta apigee 组件

如需使用 gcloud beta apigee 命令,您必须安装完整的 gcloud beta 组件,如下所示:

gcloud components install beta

如需确认是否已安装 beta 组件,请输入以下命令:

gcloud components list

您应该会在列表中看到 beta 组件,如下所示:

状态 名称 ID 大小
已安装 gcloud Beta Commands 测试版 < 1 MiB

如需了解详情,请参阅管理 SDK 组件。

授权 gcloud 访问权限

按照授权 Cloud SDK 工具中所述的步骤,授权 gloud CLI 访问权限。

例如,如需使用您的用户账号授权访问权限并执行其他常见 Cloud SDK 设置步骤,请使用以下命令:

gcloud init

按照初始化 Cloud SDK 中的说明,按照提示操作,对账号进行身份验证、授予访问权限以及初始化 Cloud SDK 安装。

或者,如需授权访问权限而不执行任何其他设置,请使用以下命令:

gcloud auth login

按照基于浏览器的授权流程操作,以便对账号进行身份验证并授予访问权限。

如需详细了解如何授权和撤销 gcloud CLI 访问权限,请参阅凭据。

为 gcloud 命令设置环境变量

文档中提供的 Apigee API 和 gcloud CLI 示例使用下表中定义的一个或多个环境变量。

通过在环境中将环境变量预先设置为有意义的值,您可以复制并粘贴示例请求,然后只需做极少的修改或不做更改,即可在自己的环境中执行它们。

环境变量 说明
$API 您的 API 代理的名称。
$APIPRODUCT API 产品的名称。
$APP 应用的 ID。
$DEVELOPER_EMAIL 开发者的电子邮件地址。
$ENV 您的环境名称,例如 test 或 prod。
$ID 资源 ID。
$KEY 使用方密钥
$NAME 您的资源的名称。
$ORG 您的 Apigee 组织。
$REV 您的 API 代理的修订版本号。
$SHAREDFLOW 您的共享流的名称。
$TYPE 资源类型

使用 gcloud CLI

使用 gcloud CLI,如下所示:

gcloud apigee GROUP [GCLOUD_WIDE_FLAG …]

如需详细了解可用的命令组和标志,请参阅 gcloud apigee。

例如,以下命令列出了贵组织中的 API 代理:

gcloud apigee apis list --organization=$ORG

下方提供了 my-org 组织的响应示例:

Using Apigee organization `myorg`
 - hello-world
 - weather-app
 

更多信息

有关详情,请参阅: