You need to enable JavaScript to run this app.
导航

调用方式概述

最近更新时间2023.08.21 13:02:48

首次发布时间2022.08.24 13:53:12

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

获取集群信息

火山引擎 ByteHouse 集群信息可以根据节点位置参考 支持的地域及可用区 查询。

获取 API Token

帐户详细信息 页面中,单击 Access Token 表单下的”新建“按钮来创建 API Token。
图片

图片

注:API Token 最多创建 2 个,并且创建后无法再次查看,建议将秘钥下载到本地。此外,秘钥需要在 90 天内进行刷新确保安全性。

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

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 指定了请求通信协议