[go: up one dir, main page]
跳到主要内容
跳到主要内容

使用 Postman 进行编程 API 访问

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

创建账户​

Postman site

创建工作区​

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

创建集合​

  • 在左上角菜单的“探索”下点击“导入”：
Explore Import">
  • 将出现一个模态框：
API URL entry
Import
  • 点击“导入”按钮选择“Postman 集合”：
Collection Import">

与 ClickHouse Cloud API 规范交互​

  • “ClickHouse Cloud 的 API 规范”现在将在“集合”（左侧导航）中显示。
Import your API
  • 点击“ClickHouse Cloud 的 API 规范。” 在中间窗格中选择“授权”选项卡：
Import complete

设置授权​

  • 切换下拉菜单选择“基本认证”：
Basic auth
  • 输入在设置 ClickHouse Cloud API 密钥时收到的用户名和密码：
credentials

启用变量​

  • 变量 使您能够在 Postman 中存储和重用值，从而使 API 测试更轻松。

设置组织 ID 和服务 ID​

  • 在“集合”中，点击中间窗格的“变量”选项卡（Base URL 将由早期的 API 导入设置）：
  • 在 baseURL 下面，点击开放字段“添加新值”，并替换为您的组织 ID 和服务 ID：
Organization ID and Service ID

测试 ClickHouse Cloud API 功能​

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

  • 在“ClickHouse Cloud 的 OpenAPI 规范”下，展开文件夹 > V1 > organizations
  • 点击“获取可用组织列表”并按右侧的蓝色“发送”按钮：
Test retrieval of organizations
  • 返回的结果应提供您的组织详细信息，并且“status”: 200。（如果您收到“status” 400，且没有组织信息，则说明您的配置不正确）。
Status

测试 “获取组织详情”​

  • 在 organizationid 文件夹下，导航到“获取组织详情”：
  • 在中间框架菜单的 Params 下需要一个 organizationid。
Test retrieval of organization details
  • 用大括号 {{orgid}} 编辑此值（设置此值后，菜单将显示该值）：
Submit test
  • 按“保存”按钮后，按右上角的蓝色“发送”按钮。
Return value
  • 返回的结果应提供您的组织详细信息，并且“status”: 200。（如果您收到“status” 400，且没有组织信息，则说明您的配置不正确）。

测试 “获取服务详情”​

  • 点击“获取服务详情”
  • 用 {{orgid}} 和 {{serviceid}} 分别编辑 organizationid 和 serviceid 的值。
  • 按“保存”，然后在右侧按蓝色“发送”按钮。
List of services
  • 返回的结果应提供您的服务及其详细信息的列表，并且“status”: 200。（如果您收到“status” 400，且没有服务信息，则说明您的配置不正确）。