预览新手入门流程

本指南将帮助您启用 Universal Ledger 预览版 API，并开始 在您的 Google Cloud 项目中进行操作。

许可名单加入请求

由于该产品处于预览版阶段，因此您需要完成一些初始的入门步骤才能获得 API 访问权限。 完成后，您就可以启用 API、分配 IAM 角色并开始发送请求。

  1. 确定您的客户或组织 ID

    在入门之前，您的组织需要添加到 API 的内部许可名单中。您需要提供以下其中一项：

    • 您组织的客户 ID，管理员可以按照 查找客户 ID中的说明检索此 ID。 此 ID 通常以“C”开头，后跟一系列字母数字字符。

    • 持有您的组织 ID，其中包含您的 Google Cloud 项目和 资源。如需相关指导，请参阅 获取组织资源 ID。 此 ID 的格式为大型十进制数。

  2. 选择 Google Cloud 项目

    确定或创建您想要与 Google Cloud API 搭配使用的项目。如需了解详情，请参阅创建和管理 项目。确保这些项目存在于第 1 步中的同一客户组织内。

  3. 联系我们

    向 gcul-help@google.com 发送电子邮件，其中包含：

    • 第 1 步中的客户 ID 或组织 ID
    • 第 2 步中的项目 ID 列表

    您的组织和项目成功添加到预览版许可名单后，您将收到一封确认电子邮件。完成此步骤后，您可以继续启用 API。

启用 API

将项目添加到许可名单后，您可以使用 gcloud 启用 Universal Ledger API，并使用特定的 IAM 角色为团队成员分配精细的访问权限。

  1. 使用 gcloud 启用 API

    如需启用 API，请使用 gcloud services enable 命令：

    gcloud services enable universalledger.googleapis.com \
    --project=PROJECT_ID

    将 PROJECT_ID 替换为您要在其中启用 API 的项目的 ID。

    如果您是项目所有者，现在应该能够向 API发送请求。

  2. 使用 IAM 角色设置精细的访问权限

    如需管理组织中其他成员对 Universal Ledger API 的精细访问权限，您可以为他们分配 IAM 角色。API 配置了三个 IAM 角色，每个角色提供不同级别的访问权限：

    • roles/universalledger.viewer：对可用端点和网络的只读访问权限。授予查看端点以及使用端点查询网络的权限。
    • roles/universalledger.editor：对可用端点和网络的完整访问权限。授予查询网络和提交事务的权限。
    • roles/universalledger.admin：对可用端点和网络的完整访问权限。授予查询网络和提交事务的权限。此角色与 Universal Ledger Editor 角色具有相同的权限，但将来可能会发生变化。

    如需为用户添加新的 IAM 角色，请使用 gcloud projects add-iam-policy-binding 命令：

    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member="PRINCIPAL" \
    --role="ROLE"

    替换以下内容：

    • PROJECT_ID：要添加 IAM 政策绑定的项目
    • PRINCIPAL：要向其添加角色的主账号，例如：user:test-user@gmail.com 或 serviceAccount:test123@example.domain.com。
    • ROLE：要分配给主账号的先前描述的角色之一

发送第一个请求

现在，您可以开始使用 API 了！

如需验证之前的配置是否正常运行，请先 使用 gcloud auth application-default login 命令进行身份验证：

gcloud auth application-default login

然后尝试发送 endpoints.list 请求：

curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -X GET "https://universalledger.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/endpoints"

向给定的 Universal Ledger 网络发送请求时，请使用 API 端点，其格式为

https://universalledger.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/endpoints/NETWORK_NAME

完成这些步骤即可验证您对 Universal Ledger API 的访问权限。但是，如需向网络提交事务，您需要先创建一个 Universal Ledger 账号。如需了解后续步骤的提示，请参阅 后续步骤。

可用网络和区域

预览版期间提供两个网络：

  • gcul-pilot-testing：接收包含实验性功能的频繁更新 。这是最常用的网络，用于快速迭代 和测试新的资产类型和产品。
  • gcul-user-testing：更新频率较低 的网络，旨在集成到支付和结算工作流中，处理测试事务和正式事务。仅在有限的用例中应要求提供。

下表总结了每个网络中验证器可用的区域。

区域 gcul-pilot-testing gcul-user-testing
us-central1
us-east1
us-east4
us-east5
us-west1
europe-west2
europe-west3

后续步骤