跳转到主要内容
使用 ClickHouse OpenAPI 可像管理 ClickHouse 服务一样,以编程方式管理您的 Managed Postgres 服务。同一个 API 还公开了一个用于抓取服务指标的 [Prometheus 端点]。如果您已经熟悉 OpenAPI,可直接获取您的 [API 密钥] 并跳转到 Managed Postgres API 参考文档。否则,请继续阅读,快速了解一下。

API 密钥

使用 ClickHouse OpenAPI 需要进行身份验证;有关如何创建 API 密钥,请参阅 [API 密钥]。然后可按如下方式通过 Basic Auth 凭据使用这些密钥:

Organization ID

接下来,你需要用到你的 Organization ID。
  1. 在控制台左下角选择你的组织名称。
  2. 选择 Organization details
  3. 点击 Organization ID 右侧的复制图标,将其直接复制到剪贴板。
现在你可以像这样在请求中使用它:
现在你已经发出了第一个 Postgres API 请求:list API 会列出你的组织中的所有 Postgres 服务器。输出应类似于:

CRUD

下面来了解 Postgres 服务 的生命周期。

创建

首先,使用 create API 创建一个新的实例。请求的 JSON body 需要包含以下属性:
  • name:新 Postgres 服务的名称
  • provider:云提供商的名称
  • region:在提供商网络中部署该 服务的区域
  • size:VM 规格
有关这些属性的可选值,请参阅 create API 文档。此外, 我们将指定使用 Postgres 18,而不是默认的 17:
现在使用这些数据创建一个新实例;请注意,这需要设置 Content-Type 请求头:
成功后,将创建一个新的实例并返回其相关信息, 包括连接数据:

查询

使用响应中的 id 再次查询该服务:
输出将与创建操作返回的 JSON 类似,但请留意 state;当它变为 running 时,服务器即表示已就绪:
现在可以使用 connectionString 属性进行连接,例如通过 psql
输入 \q 退出 psql

更新

patch API 支持通过 RFC 7396 JSON Merge Patch 更新 Managed Postgres 服务的部分属性。对于复杂的部署场景,标签可能尤其有用; 只需在请求中单独发送标签即可:
返回的数据应包括新的标签:
OpenAPI 提供了额外的端点,用于更新 patch API 不支持 的属性。例如,要更新 [Postgres 配置], 请使用 config API
输出会显示更新后的配置,以及一条说明此次更改后果的消息:

删除

使用[删除 API]删除 Postgres 服务。
删除 Postgres 服务会彻底移除该服务及其所有 数据。删除服务前,请务必确认您已完成备份,或已将某个副本提升为主节点。
成功时,响应会返回 200 状态码,例如:

监控

两个兼容 Prometheus 的端点可提供 Managed Postgres 服务的 CPU、内存、I/O、连接 和事务指标:其中一个返回组织内所有服务的指标,另一个返回单个 服务的指标。有关设置,请参阅 [Prometheus 端点] 页面;完整指标列表请参阅 [指标参考]。

Query insights

云控制台中 Query Insights 选项卡背后的按语句粒度的遥测数据也可通过编程方式获取。两个端点公开了某个服务上最慢的 查询模式:一个列出按影响排序的所有模式,另一个返回单个模式及其最近的执行记录。

列出慢查询模式

[慢查询模式 API] 返回指定时间窗口内观测到的最慢查询 模式的聚合指标。必须提供该时间窗口——请传递 from_dateto_date 作为 RFC 3339 时间戳:
结果默认按成本最高的模式优先返回,并按 total_duration 降序排序。可使用 sort_by 按不同的计数指标排序 (例如 p99_durationcall_counttotal_wal_bytes) ,并使用 sort_order 反转排序方向。还可使用 db_namedb_userdb_operationapp 过滤器缩小结果范围,并通过 limitoffset 分页查看。 每个结果都是一个归一化模式,其中字面量已被去除, 耗时以微秒为单位表示:
queryId 是归一化后语句的有符号 64 位哈希值,因此通常为负数。将它原样传回——包括开头的 -——即可获取单个查询模式。

获取慢查询模式

将列表响应中的 queryId 传递给[慢查询模式 API],即可获取该 模式的聚合指标,以及其最近的各次单独执行记录。 标识该模式所需的 db_namedb_userdb_operation 是必填项:
响应在 aggregate 字段下包含与列表端点相同的聚合数据, 另有一个 recentExecutions 数组。每次执行都包含完整的 单次执行计数器——共享和临时块 I/O、CPU 用户态和系统态 时间、并行工作线程、JIT 以及 WAL——也就是 控制台中[详情弹出面板]分项展示的那些相同计数器:
该示例为简洁起见对这两个对象都进行了裁剪;API 返回的是 per-execution counters中记录的完整 计数器 集合。
最后修改于 2026年6月25日