在 Cloud Code for Cloud Shell 中管理 Cloud API 和 Cloud 客户端库

如需以编程方式访问 Google Cloud 产品和服务，请使用 Cloud API。这些 API 公开了一个简单的 JSON REST 接口。访问 Cloud API 的推荐方法是使用 Cloud 客户端库。

Cloud Code 可让您轻松将适用于 Cloud API 和您所用语言的 Cloud 客户端库添加到您的项目中。在同一视图中，您可以搜索每个 API 的示例，并轻松将示例整合到应用中。

浏览 Cloud API

如需浏览所有可用的 Google Cloud API，请执行以下操作：

1. 点击 Cloud Code，然后展开 Cloud API 部分。

   Cloud API 视图按类别对 Cloud API 进行分组。

2. 如需查看 API 的详细信息，请点击 API 名称。服务等详细信息 客户端库名称、状态、安装说明、文档 和代码示例。

启用 Cloud API

如需使用 API 详细信息页面为项目启用 Cloud API，请按照以下步骤操作：

1. 在 Cloud API 详细信息页面上，选择您要为其启用 Cloud API 的项目。
2. 点击启用 API。 启用 API 后，系统会显示一条消息来确认更改。

将客户端库添加到项目中

除了使用 Cloud Code 浏览和启用 Cloud API 之外，您还可以向项目添加特定语言的客户端库。

如需安装客户端库，请按照 API 详情页面中的说明进行操作 。

使用 API 示例

您可以在 API 浏览器中搜索并使用每个 API 的代码示例。

1. 点击 Cloud Code，然后展开 Cloud API 部分。

2. 如需打开详细信息视图，请点击 API 的名称。

3. 如需查看 API 的代码示例，请点击代码示例。

4. 如需过滤示例列表，请输入要搜索的文本，或者从语言列表中选择编程语言。

5. 如需查看样本，请点击样本名称。您还可以选择将示例复制到剪贴板或查看 GitHub 中的示例。

设置身份验证

在您启用所需的 API 并添加必要的客户端后 您需要对应用进行配置 必须经过身份验证。您的配置取决于您的开发类型和运行所在的平台。

完成身份验证步骤后，您的应用可以进行身份验证并准备好进行部署。

本地开发

Cloud Shell 虚拟机实例使用 Compute Engine 默认服务账号（Google Kubernetes Engine 默认使用的服务账号）作为其默认服务账号。这意味着在使用 在 Cloud Shell 上使用 Cloud Code 使用客户端库时进行额外配置您的应用已通过身份验证，可以本地运行。

使用需要服务账号的 API 进行本地开发

某些 API（例如 Cloud Translation API）需要 拥有适当的权限来对请求进行身份验证如需了解详情，请参阅创建和管理服务账号。

1. 如需打开终端，请依次点击 Terminal（终端）> New Terminal（新建终端）。

2. 创建服务账号以对您的 API 请求进行身份验证：

   gcloud iam service-accounts create \
   SERVICE_ACCOUNT_ID \
   --project PROJECT_ID

   替换以下值：

   • SERVICE_ACCOUNT_ID：服务账号 ID
   • PROJECT_ID：项目 ID

   如需查找这些 ID，请在 Google Cloud 中点击屏幕左上角的导航菜单，将光标悬停在 IAM 和管理上，然后点击服务账号。

   电子邮件列会显示每个服务账号的唯一 SERVICE_ACCOUNT_ID 和 PROJECT_ID，格式如下：

   SERVICE_ACCOUNT_ID@PROJECT_ID.iam.gserviceaccount.com

   例如：服务账号电子邮件地址 [e-mail] 具有以下值：

   • SERVICE_ACCOUNT_ID：my-service-account
   • PROJECT_ID：my-project

3. 为您的服务账号授予适当的角色。以下示例 命令会授予 Cloud Translation API User 角色。要确定 请参阅您正在使用的 Cloud API 的文档。

   gcloud projects \
   add-iam-policy-binding \
   PROJECT_ID \
   --member='serviceAccount:SERVICE_ACCOUNT_ID@PROJECT_ID.iam.gserviceaccount.com' \
   --role='roles/cloudtranslate.user'

4. 创建服务账号密钥：

   gcloud iam service-accounts keys \
   create key.json --iam-account \
   SERVICE_ACCOUNT_ID@PROJECT_ID.iam.gserviceaccount.com

5. 将密钥设置为默认凭据：

   export \
    GOOGLE_APPLICATION_CREDENTIALS=key.json
   

6. 可选：允许用户执行以下操作 模拟服务账号， 运行gcloud iam service-accounts add-iam-policy-binding 命令来授予用户 Service Account User 角色 针对服务账号的 (roles/iam.serviceAccountUser) 权限：

   gcloud iam service-accounts add-iam-policy-binding \
       SERVICE_ACCOUNT_ID@PROJECT_ID.iam.gserviceaccount.com \
       --member="user:USER_EMAIL" \
       --role="roles/iam.serviceAccountUser"

   替换以下值：

   • USER_EMAIL：用户的电子邮件地址

远程开发

GKE

根据您的项目范围，您可以选择在 GKE 上对 Google Cloud 服务进行身份验证的方式：

• （仅限开发）
  注意：GKE 集群服务账号和访问权限范围设置是永久性的；创建集群后，这些设置便无法更改。请指定下方所建议的设置。
  1. 使用以下设置创建 GKE 集群：
     • 确保您使用的是 GKE 默认使用的服务账号、Compute Engine 默认服务账号，并且访问权限范围设置为授予对所有 Cloud API 的完整访问权限（这两种设置均可在节点池 > 安全部分中访问）。由于 Compute Engine 服务账号由部署在节点上的所有工作负载共享，因此此方法会过度预配权限，并且应该仅用于开发。
     • 确保集群上未启用 Workload Identity（在集群 > 安全部分中）。
  2. 为您的服务账号分配必要的角色：
     • 如果您使用的是 Compute Engine 默认服务账号，则可能应用了正确的 IAM 角色。
     • 如需查看您可以向身份授予的 IAM 角色类型和预定义角色列表，请参阅了解角色指南。如需了解授予角色的步骤，请参阅授予、更改和撤消对资源的访问权限。
• （建议用于生产用途）
  1. 使用 Workload Identity 配置 GKE 集群和应用，以对 GKE 上的 Google Cloud 服务进行身份验证。此操作会将您的 Kubernetes 服务账号与您的 Google 服务账号相关联。
  2. 通过在 Kubernetes 部署 YAML 文件中设置 .spec.serviceAccountName 字段，配置 Kubernetes 部署以引用 Kubernetes 服务账号。 如果您使用的是通过 Cloud Code 示例应用创建的应用，则此文件位于 kubernetes-manifests 文件夹下。
  3. 如果您尝试访问的 Google Cloud 服务 需要额外的角色，请针对 Google 服务授予这些角色 您用于开发应用的 Google 账号：
     • 如需查看您可以向身份授予的 IAM 角色类型和预定义角色列表，请参阅了解角色指南。如需了解授予角色的步骤，请参阅授予、更改和撤消对资源的访问权限。

Cloud Run

1. 如需创建新的唯一服务账号来部署 Cloud Run 应用，请导航到“服务账号”页面，然后选择存储密文的项目。

   转到“服务账号”页面

2. 点击创建服务账号。
3. 在创建服务账号对话框中，为服务账号输入一个描述性名称。
4. 将服务账号 ID 更改为一个可识别的唯一值，然后点击创建。
5. 如果您尝试访问的 Google Cloud 服务需要其他角色，请授予角色，点击继续，然后点击完成。
6. 如需将您的服务账号添加到部署配置，请执行以下操作：
   1. 使用 Cloud Code 状态栏选择 Cloud Run: Deploy 命令。
   2. 在 Cloud Run 部署界面的修订版本设置 (Revision Settings) 下的服务账号字段中，指定您的服务账号。
   

Cloud Run

根据您的项目范围，您可以选择在 GKE 上对 Google Cloud 服务进行身份验证的方式：

• （仅限开发）
  注意：GKE 集群服务账号和访问权限范围设置是永久性的；创建集群后，这些设置便无法更改。请指定下方所建议的设置。
  1. 使用以下设置创建 GKE 集群：
     • 请确保您使用的是 GKE 默认使用的服务账号、Compute Engine 默认服务账号，并且访问权限范围设置为授予对所有 Cloud API 的完整访问权限（这两种设置均可在节点池 > 安全部分中访问）。由于 Compute Engine 服务账号由部署在节点上的所有工作负载共享，因此此方法会过度预配权限，并且应该仅用于开发。
     • 确保集群上未启用 Workload Identity（在集群 > 安全部分中）。
  2. 为您的服务账号分配必要的角色：
     • 如果您使用的是 Compute Engine 默认服务账号，则可能应用了正确的 IAM 角色。
     • 如需查看您可以向身份授予的 IAM 角色类型和预定义角色列表，请参阅了解角色指南。如需了解授予角色的步骤，请参阅授予、更改和撤消对资源的访问权限。
• （建议用于生产用途）
  1. 使用 Workload Identity 配置 GKE 集群和应用，以对 GKE 上的 Google Cloud 服务进行身份验证。此操作会将您的 Kubernetes 服务账号与您的 Google 服务账号相关联。
  2. 如需将您的服务账号添加到部署配置，请执行以下操作：
     1. 使用 Cloud Code 状态栏选择 Cloud Run: Deploy 命令。
     2. 在 Cloud Run 部署界面的修订版本设置 (Revision Settings) 下的服务账号字段中，指定您的服务账号。
     
  3. 如果您尝试访问的 Google Cloud 服务需要其他角色，请为您用于开发应用的 Google 服务账号授予角色。
     • 如需查看您可以向身份授予的 IAM 角色类型和预定义角色列表，请参阅了解角色指南。如需了解授予角色的步骤，请参阅授予、更改和撤消对资源的访问权限。

已启用 Secret Manager 权限的远程开发

如果您正在进行远程开发并通过使用服务账号进行身份验证，且您的应用使用密文，则除了 远程开发说明以外，您还需要完成一些其他步骤。以下步骤为您的 Google 服务账号授予访问特定 Secret Manager 密文所需的角色：

1. 点击 Cloud Code，然后展开 Secret Manager 部分。

   

2. 右键点击密文，然后选择在 Cloud 控制台中修改权限。 此操作会在网络浏览器中启动该密文对应的 Secret Manager 配置页面。

   

3. 在 Google Cloud 控制台中，点击权限，然后点击添加。

4. 在新的主账号字段中，输入您的服务账号的名称。

5. 在选择角色字段中，选择 Secret Manager Secret Accessor 角色。

6. 点击保存。

   您的服务账号现在有权访问此特定密文。