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

使用 Postman 以编程方式访问 API

本指南将帮助您使用 Postman 测试 ClickHouse Cloud API。 Postman 应用程序既可以在 Web 浏览器中使用，也可以下载到本地桌面运行。

创建账号​

Postman 站点

创建工作区​

  • 为工作区命名并设置可见性级别。
创建工作区

创建一个集合（collection）​

  • 在左上角菜单的 "Explore" 下方点击 "Import"：
Explore > Import
  • 会弹出一个对话框：
API URL entry
Collection > Import

使用 ClickHouse Cloud API 规范进行交互​

  • “API spec for ClickHouse Cloud” 现在会出现在左侧导航中的 “Collections” 下。
Import your API
  • 点击 “API spec for ClickHouse Cloud”。在中间的面板中选择 “Authorization” 选项卡：
Import complete

设置授权​

  • 在下拉菜单中选择 "Basic Auth"：
Basic auth
  • 输入在设置 ClickHouse Cloud API 密钥时获得的用户名和密码：
credentials

启用变量​

  • Variables 可让你在 Postman 中存储并复用值，从而简化 API 测试工作。

设置组织 ID 和 Service ID​

  • 在 "Collection" 中，点击中间面板里的 "Variable" 选项卡（Base URL 已在之前导入 API 时设置）：
  • 在 baseURL 下方点击“Add new value”输入框，并替换为你的组织 ID 和 Service ID：
Organization ID and Service ID

测试 ClickHouse Cloud API 功能​

测试 "GET list of available organizations"​

  • 在 "OpenAPI spec for ClickHouse Cloud" 部分下，展开文件夹 > V1 > organizations
  • 点击 "GET list of available organizations"，然后点击右侧蓝色的 "Send" 按钮：
测试获取组织列表
  • 返回结果中应包含您的组织详情，并带有 "status": 200。（如果您收到 "status": 400 且没有组织信息，说明您的配置不正确）。
状态

测试 "GET organizational details"​

  • 在 organizationid 文件夹下，导航到 "GET organizational details"：
  • 在中间窗口的 Params 选项卡中，需要填写一个 organizationid。
测试获取组织详情
  • 将此值编辑为大括号中的 orgid：{{orgid}}（由于之前已经设置过该值，会出现一个带有该值的菜单）：
提交测试
  • 点击 "Save" 按钮后，点击屏幕右上角的蓝色 "Send" 按钮。
返回值
  • 返回结果中应包含组织详情，并且 "status": 200。（如果收到 "status": 400 且没有组织信息，则说明你的配置不正确）。

测试 “GET service details”​

  • 单击 “GET service details”
  • 将 organizationid 和 serviceid 的值分别编辑为 {{orgid}} 和 {{serviceid}}。
  • 单击 “Save”，然后单击右侧蓝色的 “Send” 按钮。
List of services
  • 返回结果应为您的服务及其详细信息列表，并包含 "status": 200。（如果返回 "status": 400 且没有任何服务信息，则说明您的配置不正确）。