You need to enable JavaScript to run this app.
导航
获取 ByteHouse 连接信息
最近更新时间:2025.06.25 15:55:50首次发布时间:2023.07.27 10:36:23
我的收藏
有用
有用
无用
无用

您可以参考本页获取 ByteHouse 云数仓版服务的连接信息。

设置 IP 白名单

区域 Regions

公网出口 IP

华北2(北京)

111.62.122.179

华东2(上海)

180.184.161.45

华南1(广州)

118.145.156.236

步骤一:设置默认参数信息

与 ByteHouse 的连接初始化始终采用默认的计算组和默认角色,因此这些值不能为空。
在使用驱动程序连接到 ByteHouse 之前,您可通过 租户管理>参数设置 中确认并设置以下参数值。

  • 默认计算组:设置本账户默认使用的计算资源。
  • 默认写计算组:设置专用写计算组以提升表写入性能。
  • 默认数据库:设置默认连接数据库。

Image

步骤二:配置网络信息

一般情况下,连接到 ByteHouse 需要集群的访问地址(HOST)和端口号(PORT),您可通过 ByteHouse 控制台的网络信息模块,配置并获取对应的连接信息。
在控制台顶部租户管理基本信息页面,查看网络,确认已绑定 VPC,并绑定了公网域名。如果未绑定 VPC 和公网域名,需参考设置网络信息文档完成绑定配置。
完成绑定后,可单击复制私网或公网域名,用作集群的访问地址(HOST),用于后续对接参数配置。默认端口号为 19000,其他常用连接方式所使用的端口请参见集群连接端口
Image
同时,对于常用的连接驱动程序(JDBC/Python/Golang/ByteHouse-CLI)等,您也可以在控制台上的租户管理>连接信息页面,获取相关连接方式的连接地址字符串。
Image

步骤三:获取 ByteHouse 连接串信息

您可通过 IAM 用户或数据库用户连接至 ByteHouse,连接所需的参数如下:

参数项

使用 IAM 用户连接

使用数据库用户连接

{HOST}

集群的访问地址。获取方式请参见步骤二:配置网络信息

{PORT}

端口默认值为 19000,其他常用连接方式所使用的端口请参见集群连接端口

{USERNAME}

登录 ByteHouse 数据库的用户名。

  • 火山引擎 ByteHouse 的 User 用户默认为bytehouse
  • 非火山引擎托管的 ByteHouse, 需要与平台管理员获取 {USERNAME} 信息。

数据库用户的账号使用 ByteHouse 账号、数据库用户的名称、环境 ID(可选)拼接而成,格式为{accountID_or_accountName}::{username}[::{envID}]

{password}

设置为当前账户的 API Key,获取方式请参见下文获取 API Key

数据库用户的密码,获取方式请参见下文获取数据库用户及密码

获取 API Key

登录并进入 ByteHouse 控制台后,单击顶部租户管理连接信息,在 API Key 模块新建一个 API key,并将 API Key 保存至本地,用于后续的配置使用。
Image

注意

  • API Key 创建后无法再次查看,建议将秘钥下载到本地保存。
  • 一个子账号最多可以创建 2 个 API Key,如果此前您有已创建好的 API key,也可直接使用已创建好的 API Key。
  • 秘钥需要在 90 天内进行刷新以确保安全性。

获取账号信息

登录并进入 ByteHouse 控制台后,单击右上角个人中心查看并复制账号 ID 或名称。
Image

获取数据库用户及密码

登录并进入 ByteHouse 控制台,在顶部权限管理下的用户页面,查看用户列表,筛选用户类别为数据库的用户,查看并复制数据库用户名。如果尚未创建数据库用户,可联系管理员参考管理数据库用户创建。
数据库用户的密码为管理员配置,可联系管理员获取对应的密码。如果密码丢失或遗忘,可联系管理员重置密码,详情请参考重置密码
Image

(可选)获取环境信息

如果使用 default 环境,可不配置,如需使用其他环境,需指定环境名称。您可登录并进入 ByteHouse 控制台后,在顶部租户管理下的基本信息页面,查看当前环境名称。
Image