You need to enable JavaScript to run this app.
ByteHouse云数仓版

ByteHouse云数仓版

请输入
  • 文档首页
    • ByteHouse云数仓版开发参考API 参考调用方式
复制全文
我的收藏
API 参考
调用方式
复制全文
我的收藏
调用方式

ByteHouse OpenAPI 使用 Bearer Token 授权，需要用户在 ByteHouse 控制台创建并使用 API Key 作为秘钥。

获取 OpenAPI 地址

在 ByteHouse 云数仓版控制台租户管理 > 连接信息 > 连接工具 页面中，可以获取到 ByteHouse 的 OpenAPI 连接地址，您可按需选择使用私网或公网连接地址。
Image

获取 API Key

在 ByteHouse 云数仓版控制台租户管理 > 连接信息 > API Key页面中，单击 API Key 模块下的新建按钮来创建 API Key。
Image

注意

  • API Key 创建后无法再次查看，建议将秘钥下载到本地保存；
  • 最多可以创建 2 个 API Key；
  • 秘钥需要在 90 天内进行刷新以确保安全性。

获取 API 接口

请参考API 列表获取相应的接口。

注意

由于接口优化，使用Queries-V2接口时，需要在 url 中增加端口号“8123”。
Image

使用示例

具体 API 的调用路径及方法可参考不同模块的接口文档，调用示例如下：

使用Queries-V2接口

使用Queries-V1接口

curl --request POST \
 --url https://{OPENAPI_HOST}:8123/v2/sql/sync \
 --header 'accept: application/json' \
 --header 'authorization: Bearer ${API_KEY}' \
 --header 'content-type: application/json' \
 --data '
{
 "mode": "ansi_sql",
 "query": "select 1"
}
'

curl --request POST \
 --url https://{OPENAPI_HOST}/v1/sql/sync \
 --header 'accept: application/json' \
 --header 'authorization: Bearer ${API_KEY}' \
 --header 'content-type: application/json' \
 --data '
{
 "mode": "ansi_sql",
 "query": "select 1"
}
'
  • POST：表示 ByteHouse OpenAPI 的请求方式。
  • url：指定了访问 OpenAPI 的地址，其中包含了地域等参数。如果使用Queries-V2接口，url中需包含端口号8123。
  • HTTPS：指定了请求通信协议。
最近更新时间：2025.11.06 15:39:53
这个页面对您有帮助吗？
有用
有用
无用
无用