跳到主要内容
跳到主要内容

使用 Postman 进行程序化 API 访问

这个指南将帮助您使用 Postman 测试 ClickHouse Cloud API。 Postman 应用程序可以在网络浏览器中使用，也可以下载到桌面。

创建一个帐户​

创建一个工作区​

  • 命名您的工作区并设置可见性级别。

创建一个集合​

  • 在左上角菜单的 "Explore" 下点击 "Import"：
  • 将出现一个模态框：
  • 点击 "Import" 按钮选择 "Postman Collection"：

与 ClickHouse Cloud API 规范交互​

  • 现在将在 "Collections"（左导航）中出现 "ClickHouse Cloud 的 API 规范"。
  • 点击 "ClickHouse Cloud 的 API 规范"。在中间面板中选择 'Authorization' 选项卡：

设置授权​

  • 切换下拉菜单选择 "Basic Auth"：
  • 输入您在设置 ClickHouse Cloud API 密钥时收到的用户名和密码：

启用变量​

  • 变量 允许在 Postman 中存储和重用值，从而简化 API 测试过程。

设置组织 ID 和服务 ID​

  • 在 "Collection" 中，点击中间面板的 "Variable" 选项卡（基本 URL 将由之前的 API 导入进行设置）：
  • 在 baseURL 下面点击打开的字段 "Add new value"，并替换为您的组织 ID 和服务 ID：

测试 ClickHouse Cloud API 功能​

测试 "获取可用组织的列表"​

  • 在 "OpenAPI spec for ClickHouse Cloud" 下，展开文件夹 > V1 > organizations
  • 点击 "GET list of available organizations" 并按右侧的蓝色 "Send" 按钮：
  • 返回的结果应提供您的组织详细信息，并且 "status" 应为 200。（如果您收到 "status" 400 且没有组织信息，则表示您的配置不正确）。

测试 "获取组织详细信息"​

  • 在 organizationid 文件夹下，导航至 "GET organizational details"：
  • 在中间框架菜单的 Params 下，需要一个 organizationid。
  • 将该值编辑为大括号中的 orgid {{orgid}}（由于您之前设置了此值，将会出现一个菜单，该菜单将显示该值）：
  • 按下 "Save" 按钮后，在屏幕右上角按蓝色 "Send" 按钮。
  • 返回的结果应提供您的组织详细信息，并且 "status" 应为 200。（如果您收到 "status" 400 且没有组织信息，则表示您的配置不正确）。

测试 "获取服务详细信息"​

  • 点击 "GET service details"
  • 将 organizationid 和 serviceid 的值编辑为 {{orgid}} 和 {{serviceid}}，分别。
  • 按 "Save"，然后按右侧的蓝色 "Send" 按钮。
  • 返回的结果应提供您的服务及其详细信息的列表，并且 "status" 应为 200。（如果您收到 "status" 400 且没有服务信息，则表示您的配置不正确）。