导航
调用方式
最近更新时间：2024.11.06 13:58:48首次发布时间：2022.08.24 13:53:12
ByteHouse OpenAPI 使用 Bearer Token 授权，需要用户在 ByteHouse 控制台 创建并使用 API Key 作为秘钥。
获取 OpenAPI 地址
在控制台 租户管理-连接信息 页面中，可以获取到 ByteHouse 的 OpenAPI 连接地址（私网或公网）。
获取 API Key
在 租户管理-连接信息 页面中，单击 API Key 表单下的”新建“按钮来创建 API Key。
注意
- API Key 创建后无法再次查看，建议将秘钥下载到本地保存；
- 最多可以创建 2 个 API Key；
- 秘钥需要在 90 天内进行刷新以确保安全性。
获取 API 接口
请参考API 列表获取相应的接口。
注意
由于接口优化，使用Queries-V2接口时，需要在 url 中增加端口号“8123”。
使用示例
具体 API 的调用路径及方法可参考不同模块的接口文档，调用示例如下：
curl --request GET \ --url https://{OPENAPI_HOST}/v1/databases \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ${API_Key}
- GET 表示 ByteHouse OpenAPI 的请求方式
- url 指定了访问 OpenAPI 的地址，其中包含了地域 和 v1/databases 等参数
- HTTPS 指定了请求通信协议
如果使用V2 OpenAPI 接口，请参考下面的调用示例，参数与上述相同：
curl --request GET \ --url https://{OPENAPI_HOST}:8123/v2/databases \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ${API_Key}