You need to enable JavaScript to run this app.
ByteHouse Cloud Data Warehouse Version

ByteHouse Cloud Data Warehouse Version

  • Documentation
    • ByteHouse Cloud Data Warehouse VersionUser guideConnect ByteHouseObtain ByteHouse connection information
Copy page
Download PDF
Connect ByteHouse
Obtain ByteHouse connection information
Copy page
Download PDF
Obtain ByteHouse connection information

You can refer to this page to obtain the connection information for the ByteHouse cloud data warehouse Service.

Set IP allowlist

Regions

Public outbound IP

North China 2 (Beijing)

111.62.122.179

East China 2 (Shanghai)

180.184.161.45

South China 1 (Guangzhou)

118.145.156.236

Asia Pacific Southeast (Johor)

101.47.16.154

Step 1: Set default parameter information

The initialization of the connection with ByteHouse always adopts the default virtual warehouse and default roles, so these values cannot be empty.
Before using a driver to connect to ByteHouse, you can confirm and set the following parameter values in Tenant management > Parameter settings. For more parameter settings, see Manage parameters.

  • Default virtual warehouse: Set the default computing resources for this account.
  • Default Write Virtual Warehouse: Set a dedicated write virtual warehouse to improve table write performance.
  • Default database: Set the default database for connections.

Image

Step 2: Set network information

In general, connecting to ByteHouse requires the cluster access address (HOST) and port number (PORT). You can configure and obtain the corresponding connection information for in the network information module of the ByteHouse console.
On the tenant management basic information page at the top of the console, view the network, and confirm that the VPC is linked and the public domain name is bound. If the VPC and public domain name are not bound, refer to the Network information settingsdocumentation to complete the binding configuration.
After completing the binding, you can click to copy the private or public domain name as the cluster access address (HOST) for subsequent parameter configuration. The default port number is 19000. For other commonly used connection methods and their ports, see Cluster Connection Port.

tip

Public domain name and private domain name can satisfy the requirements of regular connection scenarios. To use public or private IP, you can access the console at Tenant management > Basic information > Network informationmodules, click the details button after the private domain name or public domain name to view and copy the corresponding IP address.
Image

Meanwhile, for commonly used connection drivers (JDBC, Python, Golang, ByteHouse-CLI), you can also obtain the connection address string for the relevant connection method on the tenant management> connection information page in the console.
Image

Step 3: Obtain ByteHouse connection string information

You can connect to ByteHouse using an IAM user or database user. The required parameters for the connection are as follows:

Parameters

Connect using IAM user

Connect using database user

{HOST}

Cluster access address. For acquisition method, please refer to Step 2: Set network information.

{PORT}

The default port value is 19000. For other recommended connection methods and their ports, please refer to Cluster Connection Port.

{USERNAME}

Username for logging in to the ByteHouse database.

  • The default user for BytePlus ByteHouse is bytehouse.
  • For ByteHouse not hosted by BytePlus, you need to obtain {USERNAME} information from the platform administrator.

The database user's account is composed by concatenating the ByteHouse account ID or name, database user's name, and environment ID (optional), in the format {accountID_or_accountName}::{username}[::{envID}].

  • {accountID_or_accountName}: Refers to the BytePlus account UID or name. For acquisition method, please refer to Obtain account information below.
  • {username}: Username for logging in to the ByteHouse database account. For acquisition method, please refer to Obtain database user and password below.
  • {envID}: Optional configuration. The environment name where the database is located. For acquisition method, please refer to (Optional) Obtain environment information below. No need to add [] when configuring the Environment ID.
    Examples are as follows:
    • Configure Environment ID: 21xxxxxxxx::demouser::demoenv
    • Without configuring Environment ID: 21xxxxxxxx::demouser

{password}

Set as the API Key of the current account. For how to obtain it, please refer to the following Obtain API key

Database user's password. For how to obtain it, please refer to the following Obtain database user and password.

Obtain API key

After logging in and entering the ByteHouse console, click Tenant management at the top Connection information, create a new API key in the API key module, and save the API key locally for subsequent configuration use.
Image

warning

  • API Key cannot be viewed again after creation. It is recommended to download the key and save it locally.
  • One sub-account can create up to 2 API Keys. If you have already created an API Key, you can use it directly.
  • The key needs to be refreshed within 90 days to ensure security.

Obtain account information

After logging in to the ByteHouse Console, click the profile in the upper right corner to view and copy the account ID or name.
Image

Obtain database user and password

Log in to the ByteHouse Console, then at the top Access control under the User page, view the user list, filter by user category as Database, then view and copy the database username. If a database user has not been created, contact the administrator and refer to Manage Database Accounts for creation.
The database user's password is configured by the administrator. Contact the administrator to obtain the corresponding password. If the password is lost or forgotten, contact the administrator to reset the password. For details, please refer to Reset Password.
Image

(Optional) Obtain environment information

If using the default environment, no configuration is required. To use other environments, specify the environment name. You can log in to the ByteHouse Console, then at the top Tenant management under the Basic informationpage, view the current environment name.
Image

Last updated: 2026.03.31 16:21:56