调用方式概述
最近更新时间：2024.04.29 14:15:58
首次发布时间：2022.08.24 13:53:12
ByteHouse OpenAPI 使用 Bearer Token 授权，需要用户在 ByteHouse 控制台 创建并使用 API Token 作为秘钥。
获取 OpenAPI 地址
火山引擎 ByteHouse 集群节点对应的 OpenAPI 地址如下表，请根据集群所在区域选择对应的连接地址。
区域 Regions | OpenAPI 地址 |
|---|---|
华北2（北京） | https://bytemart-cn-beijing.bytehouse.volcbiz.com |
华东2（上海） | https://bytemart-cn-shanghai.bytehouse.volcbiz.com |
获取 API Token
在 租户管理-连接信息 页面中，单击 Access Token 表单下的”新建“按钮来创建 API Token。
注意
- API Token 创建后无法再次查看，建议将秘钥下载到本地保存；
- 最多可以创建 2 个 API Token；
- 秘钥需要在 90 天内进行刷新以确保安全性。
使用示例
具体 API 的调用路径及方法可参考不同模块的接口文档，以华北2（北京）集群为例，调用示例如下：
curl --request GET \ --url https://bytemart-cn-beijing.bytehouse.volcbiz.com/v1/databases \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ${APIToken}
- GET 表示 ByteHouse OpenAPI 的请求方式
- url 指定了访问 OpenAPI 的地址，其中包含了地域 cn-beijing 和 v1/databases 等参数
- HTTPS 指定了请求通信协议