> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-revert-104359-revert-104251-parquet-single.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# 通过 Postman 以编程方式访问 API
> 本指南将帮助您使用 Postman 测试 ClickHouse Cloud API
export const Image = ({img, alt, size = "lg"}) => {
const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
return ;
};
本指南将帮助你使用 [Postman](https://www.postman.com/product/what-is-postman/) 测试 ClickHouse Cloud API。
你可以直接在 Web 浏览器中使用 Postman 应用程序，也可以将其下载到桌面端。
### 创建账户
* 可在 [https://www.postman.com](https://www.postman.com) 注册免费账户。
### 创建工作区
* 给工作区命名并设置可见性级别。
### 创建集合
* 在左上角菜单中，点击 "Explore" 下方的 "Import"：
* 此时会弹出一个模态窗口：
* 输入 API 地址："[https://api.clickhouse.cloud/v1\"，然后按下](https://api.clickhouse.cloud/v1\"，然后按下) 'Enter'：
* 点击 "Import" 按钮，选择 "Postman Collection"：
### 使用 ClickHouse Cloud API 规范
* “ClickHouse Cloud 的 API 规范”现在会显示在“集合” (左侧导航) 中。
* 点击“ClickHouse Cloud 的 API 规范”。然后在中间面板中选择“Authorization”选项卡：
### 设置授权
* 在下拉菜单中选择“Basic Auth”：
* 输入您在设置 ClickHouse Cloud API keys 时收到的用户名和密码：
### 启用变量
* [变量](https://learning.postman.com/docs/sending-requests/variables/)可用于在 Postman 中存储和重复使用值，从而简化 API 测试。
#### 设置 Organization ID 和 Service ID
* 在“集合”中，点击中间窗格里的“变量”选项卡 (Base URL 已在之前导入 API 时设置) ：
* 在 `baseURL` 下方，点击空白字段“Add new value”，然后填入你的 Organization ID 和 Service ID：
## 测试 ClickHouse Cloud API 的各项功能
### 测试“GET 可用组织列表”
* 在“ClickHouse Cloud 的 OpenAPI 规范”下，展开 > V1 > organizations 文件夹
* 点击“GET 可用组织列表”，然后点击右侧蓝色的“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”按钮。
* 返回结果应显示你的服务列表及其详细信息，且 `"status": 200`。 (如果你收到 `"status"` 400，且没有任何服务信息，则说明你的配置不正确) 。