Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add disable public endpoint #16147

Merged
merged 8 commits into from
Jan 16, 2024
Merged

add disable public endpoint #16147

Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
36ccde7
add disable public endpoint
zhangyangyu Jan 15, 2024
7feac2a
restructure the doc
ran-huang Jan 15, 2024
7ac5fe2
fix
zhangyangyu Jan 15, 2024
d066ddd
Merge branch 'pb' of github.com:pingcap/docs into pb
zhangyangyu Jan 15, 2024
335535d
fix
zhangyangyu Jan 15, 2024
d7a0181
Apply suggestions from code review
zhangyangyu Jan 15, 2024
15b4029
Apply suggestions from code review
ran-huang Jan 16, 2024
d3d8c75
Apply suggestions from code review
zhangyangyu Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion tidb-cloud/connect-via-standard-connection-serverless.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ summary: Learn how to connect to your TiDB Serverless cluster via public endpoin

# Connect to TiDB Serverless via Public Endpoint

This document describes how to connect to your TiDB Serverless cluster via a public endpoint, using a SQL client from your computer.
This document describes how to connect to your TiDB Serverless cluster via a public endpoint, using a SQL client from your computer, as well as how to disable a public endpoint.

## Connect via a public endpoint

> **Tip:**
>
Expand Down Expand Up @@ -34,6 +36,28 @@ To connect to a TiDB Serverless cluster via public endpoint, take the following
>
> When you connect to a TiDB Serverless cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix).

## Disable a public endpoint

If you do not need to use a public endpoint of a TiDB Serverless cluster, you can disable it to prevent connection from the Internet:
zhangyangyu marked this conversation as resolved.
Show resolved Hide resolved

1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page.

2. Click **Networking** in the left navigation bar and click **Disable** in the right pane. A confirmation dialog is displayed.
zhangyangyu marked this conversation as resolved.
Show resolved Hide resolved

3. Click **Disable** in the confirmation dialog.

After disabling, the `Public` entry in the **Endpoint Type** drop-down list in the connect pane is disabled. If users are still trying to access the cluster from public endpoint, an error will be returned.
zhangyangyu marked this conversation as resolved.
Show resolved Hide resolved

> **Note:**
>
> Disabling the public endpoint does not affect existing connections. It only prevents new connections from the Internet.
zhangyangyu marked this conversation as resolved.
Show resolved Hide resolved

You can re-enable the public endpoint after disabling it:

1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page.

2. Click **Networking** in the left navigation bar and click **Enable** in the right pane.
zhangyangyu marked this conversation as resolved.
Show resolved Hide resolved

## What's next

After you have successfully connected to your TiDB cluster, you can [explore SQL statements with TiDB](/basic-sql-operations.md).
Loading