跳至主要内容

使用 Postman 进行编程 API 访问

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

创建帐户​

创建工作区​

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

创建集合​

  • 在左上角菜单中的“探索”下方，单击“导入”： 探索 > 导入

  • 将出现一个模态窗口： API URL 输入

  • Enter the API address: “https://api.clickhouse.cloud/v1” and press 'Enter': Import

  • 通过单击“导入”按钮，选择“Postman 集合”： 集合 > 导入

与 ClickHouse Cloud API 规范进行交互​

  • “ClickHouse Cloud 的 API 规范”现在将出现在“集合”（左侧导航）中。 导入您的 API

  • 单击“ClickHouse Cloud 的 API 规范”。从中间窗格中选择“授权”选项卡： 导入完成

设置授权​

  • 切换下拉菜单以选择“基本身份验证”： 基本身份验证

  • 输入设置 ClickHouse Cloud API 密钥时收到的用户名和密码： 凭据

启用变量​

  • 变量允许在 Postman 中存储和重用值，从而更轻松地进行 API 测试。

设置组织 ID 和服务 ID​

  • 在“集合”中，单击中间窗格中的“变量”选项卡（基本 URL 将由较早的 API 导入设置）
  • 在“baseURL”下方，单击打开的字段“添加新值”，并替换您的组织 ID 和服务 ID： 组织 ID 和服务 ID

测试 ClickHouse Cloud API 功能​

测试“获取可用组织列表”​

  • 在“ClickHouse Cloud 的 OpenAPI 规范”下，展开文件夹 > V1 > 组织
  • 单击“获取可用组织列表”，然后按右侧的蓝色“发送”按钮： 测试检索组织
  • 返回的结果应提供您的组织详细信息，其中“状态”：200。（如果您收到“状态”400，并且没有组织信息，则您的配置不正确）。 状态

测试“获取组织详细信息”​

  • 在 organizationid 文件夹下，导航到“获取组织详细信息”
  • 在参数下的中间框架菜单中，需要一个 organizationid。 测试检索组织详细信息
  • 使用大括号“{{orgid}}”编辑此值（从较早设置此值开始，将出现一个包含该值的菜单）： 提交测试
  • 按“保存”按钮后，按屏幕右上角的蓝色“发送”按钮。 返回值
  • 返回的结果应提供组织详细信息，其中“状态”：200。（如果您收到“状态”400，且没有组织信息，则说明您的配置不正确）。

测试“GET 服务详细信息”​

  • 单击“GET 服务详细信息”
  • 分别用 {{orgid}} 和 {{serviceid}} 编辑 organizationid 和 serviceid 的值。
  • 按“保存”，然后按右侧的蓝色“发送”按钮。 服务列表
  • 返回的结果应提供服务列表及其详细信息，其中“状态”：200。（如果您收到“状态”400，且没有服务信息，则说明您的配置不正确）。