All Products
Search
Document Center

Time Series Database:Connect to the instance

Last Updated:Mar 28, 2026

TSDB supports Virtual Private Cloud (VPC) network and public network connections. You can manage your instances and data through APIs or the front-end console. Each TSDB instance comes with a VPC network endpoint by default. This document describes how to connect your application to a TSDB instance over a VPC network.

For public network connections, see Network connection.

Prerequisites

Before you begin, make sure you have:

  • A TSDB instance

  • An IP address allowlist configured for the instance — the VPC network address is only visible after an allowlist entry is added

Connect over a VPC network

  1. In the console, go to the Instance Details page of your TSDB instance.

  2. In the Basic Information section, locate the VPC Network Address field. If the field shows Set the IP address whitelist instead of an address, click the link and add the IP addresses that need access to this instance. The VPC network address appears automatically after the allowlist is saved.

  3. Copy the VPC network address. The address includes the domain name and the port address.

  4. In your application, use the VPC network address (domain name and port) as the connection endpoint. TSDB is compatible with the OpenTSDB protocol and uses HTTP APIs. After connecting, your application can perform data read/write operations against the instance.

Troubleshooting

Connection timed out

The Connection timed out error occurs when the host running your application is not in the same VPC network as the TSDB instance. To resolve this:

  • Same region: Add the host to the VPC network where the TSDB instance is located.

  • Different region: Use the ClassLink function to create a channel between the classic network and the VPC network.

What's next