new nav: Create TOC and overview docs for API #21293

qiancai · 2026-01-23T04:07:38Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions (in Chinese).

What is the related PR or file link(s)?

This PR is translated from: Draft: Create TOC and overview docs for API docs#22276
Other reference link(s):

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

api/_index.md

…-api

ti-chi-bot · 2026-01-23T04:20:03Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ti-chi-bot · 2026-01-23T04:37:10Z

@qiancai: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-verify	`a61817d`	link	true	`/test pull-verify`

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Oreoxmt · 2026-01-23T05:51:34Z

/cc @Oreoxmt

Oreoxmt · 2026-01-26T06:20:31Z

api/_index.md

+
+TiDB 提供了多种 API，可用于集群的查询与运维、数据的同步管理、系统的状态监控等多种场景。本文为 [TiDB Cloud](https://docs.pingcap.com/zh/tidbcloud/) 和 [TiDB](https://docs.pingcap.com/zh/tidb/stable/) 中可用的 API 提供了一个概览说明。
+
+## TiDB Cloud API（beta）


Suggested change

## TiDB Cloud API（beta）

## TiDB Cloud API (beta)

Oreoxmt · 2026-01-26T06:25:27Z

TOC-api.md

+
+- [TiProxy API](/api/tiproxy-api-overview.md)
+- [Data Migration API](/api/dm-api-overview.md)
+- [Monitoring API](/api/monitoring-api-overview.md)


Suggested change

- [Monitoring API](/api/monitoring-api-overview.md)

- [监控 API](/api/monitoring-api-overview.md)

Oreoxmt · 2026-01-26T06:53:52Z

api/_index.md

@@ -0,0 +1,30 @@
+---
+title: TiDB API 概览
+summary: 了解 TiDB Cloud 与 TiDB 的 API。


Suggested change

summary: 了解 TiDB Cloud 与 TiDB 的 API。

summary: 了解 TiDB Cloud 和 TiDB 可用的 API。

Oreoxmt · 2026-01-26T06:53:59Z

api/_index.md

+
+# TiDB API 概览
+
+TiDB 提供了多种 API，可用于集群的查询与运维、数据的同步管理、系统的状态监控等多种场景。本文为 [TiDB Cloud](https://docs.pingcap.com/zh/tidbcloud/) 和 [TiDB](https://docs.pingcap.com/zh/tidb/stable/) 中可用的 API 提供了一个概览说明。


Suggested change

TiDB 提供了多种 API，可用于集群的查询与运维、数据的同步管理、系统的状态监控等多种场景。本文为 [TiDB Cloud](https://docs.pingcap.com/zh/tidbcloud/) 和 [TiDB](https://docs.pingcap.com/zh/tidb/stable/) 中可用的 API 提供了一个概览说明。

TiDB 提供了多种 API，可用于查询和运维集群、管理数据同步、监控系统状态等场景。本文介绍 [TiDB Cloud](https://docs.pingcap.com/zh/tidbcloud/) 和 [TiDB](https://docs.pingcap.com/zh/tidb/stable/) 的可用 API。

Oreoxmt · 2026-01-26T06:54:07Z

api/_index.md

+
+[TiDB Cloud API](/api/tidb-cloud-api-overview.md) 是一个 [REST 接口](https://zh.wikipedia.org/wiki/表现层状态转换)。通过该 API，你可以以编程方式访问和操作 TiDB Cloud 中的各类管理资源，例如项目、集群、备份、恢复、导入、账单以及 Data Service。
+
+| API | 说明 |


Suggested change

| API | 说明 |

| API | 描述 |

Oreoxmt · 2026-01-26T06:54:12Z

api/_index.md

+
+TiDB 为相关 TiDB 工具提供了多种 API。通过这些 API，你可以管理集群组件、监控系统状态，并控制数据同步工作流。
+
+| API | 说明 |


Suggested change

| API | 说明 |

| API | 描述 |

Oreoxmt · 2026-01-26T06:54:29Z

api/_index.md

+| --- | --- |
+| [TiProxy API](/tiproxy/tiproxy-api.md) | 获取 TiProxy 配置、健康状况以及监控数据。 |
+| [Data Migration API](/dm/dm-open-api.md) | 管理 DM-master 与 DM-worker 节点、数据源以及数据同步任务。 |
+| [Monitoring API](/tidb-monitoring-api.md) | 获取 TiDB 服务器运行状态、数据表的存储信息以及 TiKV 集群的详细信息。 |


Oreoxmt · 2026-01-26T06:54:35Z

api/_index.md

+| [Data Migration API](/dm/dm-open-api.md) | 管理 DM-master 与 DM-worker 节点、数据源以及数据同步任务。 |
+| [Monitoring API](/tidb-monitoring-api.md) | 获取 TiDB 服务器运行状态、数据表的存储信息以及 TiKV 集群的详细信息。 |
+| [TiCDC API](/ticdc/ticdc-open-api-v2.md) | 查询 TiCDC 节点状态并管理数据同步任务，包括任务的创建、暂停、恢复与更新等操作。 |
+| [TiDB Operator API](<https://github.com/pingcap/tidb-operator/blob/{{{ .tidb-operator-version }}}/docs/api-references/docs.md>) | 管理 Kubernetes 上的 TiDB 集群，包括集群部署、升级、扩缩容、备份与故障切换等操作。 |


Suggested change

| [TiDB Operator API](<https://github.com/pingcap/tidb-operator/blob/{{{ .tidb-operator-version }}}/docs/api-references/docs.md>) | 管理 Kubernetes 上的 TiDB 集群，包括集群部署、升级、扩缩容、备份与故障切换等操作。 |

| [TiDB Operator API](<https://github.com/pingcap/tidb-operator/blob/{{{ .tidb-operator-version }}}/docs/api-references/docs.md>) | 管理 Kubernetes 上的 TiDB 集群，包括集群部署、升级、扩缩容、备份与故障转移等操作。 |

Oreoxmt · 2026-01-26T06:58:38Z

api/dm-api-overview.md

@@ -0,0 +1,18 @@
+---
+title: Data Migration API 概览
+summary: 了解 Data Migration（DM）的 API。


Suggested change

summary: 了解 Data Migration（DM）的 API。

summary: 了解 Data Migration (DM) 的 API。

Oreoxmt · 2026-01-26T06:58:46Z

api/dm-api-overview.md

+
+# Data Migration API 概览
+
+[TiDB Data Migration](/dm/dm-overview.md)（DM）是一款便捷的数据迁移工具，支持从与 MySQL 协议兼容的数据库（例如 MySQL、MariaDB、Aurora MySQL）到 TiDB 的全量数据迁移和增量数据同步。


Suggested change

[TiDB Data Migration](/dm/dm-overview.md)（DM）是一款便捷的数据迁移工具，支持从与 MySQL 协议兼容的数据库（例如 MySQL、MariaDB、Aurora MySQL）到 TiDB 的全量数据迁移和增量数据同步。

[TiDB Data Migration](/dm/dm-overview.md) (DM) 是一款便捷的数据迁移工具，支持从与 MySQL 协议兼容的数据库（例如 MySQL、MariaDB、Aurora MySQL）到 TiDB 的全量数据迁移和增量数据同步。

Oreoxmt · 2026-01-26T07:00:18Z

api/monitoring-api-overview.md

+
+# TiDB 监控 API 概览
+
+TiDB 的监控框架基于 [Prometheus](https://prometheus.io) 和 [Grafana](https://grafana.com/grafana) 这两个开源项目。TiDB 使用 Prometheus 作为监控和性能指标信息存储方案，使用 Grafana 作为可视化组件进行展示，并提供内置的 [TiDB Dashboard](/dashboard/dashboard-intro.md) 图形化界面，用于监控及诊断 TiDB 集群。


Suggested change

TiDB 的监控框架基于 [Prometheus](https://prometheus.io) 和 [Grafana](https://grafana.com/grafana) 这两个开源项目。TiDB 使用 Prometheus 作为监控和性能指标信息存储方案，使用 Grafana 作为可视化组件进行展示，并提供内置的 [TiDB Dashboard](/dashboard/dashboard-intro.md) 图形化界面，用于监控及诊断 TiDB 集群。

TiDB 的监控框架基于 [Prometheus](https://prometheus.io) 和 [Grafana](https://grafana.com/grafana) 这两个开源项目。TiDB 使用 Prometheus 存储监控和性能指标，使用 Grafana 可视化展示这些指标，并提供内置的 [TiDB Dashboard](/dashboard/dashboard-intro.md) 图形化界面，用于监控及诊断 TiDB 集群。

Oreoxmt · 2026-01-26T07:01:26Z

api/tidb-cloud-api-overview.md

+
+该 API 具有以下特性：
+
+- **JSON 实体（JSON entities）**：API 中的所有资源和数据均使用 JSON 格式。


Suggested change

- **JSON 实体（JSON entities）**：API 中的所有资源和数据均使用 JSON 格式。

- **JSON 实体 (JSON entities)**：API 中的所有资源和数据均使用 JSON 格式。

Oreoxmt · 2026-01-26T07:03:34Z

api/tidb-cloud-api-overview.md

+
+TiDB Cloud API 提供以下两个版本：
+
+- [v1beta1](/api/tidb-cloud-api-v1beta1.md)：管理 TiDB Cloud Starter、Essential 与 Dedicated 集群，以及计费、Data Service 与 IAM 资源。


Suggested change

- [v1beta1](/api/tidb-cloud-api-v1beta1.md)：管理 TiDB Cloud Starter、Essential 与 Dedicated 集群，以及计费、Data Service 与 IAM 资源。

- [v1beta1](/api/tidb-cloud-api-v1beta1.md)：管理 TiDB Cloud Starter、Essential 与 Dedicated 集群，以及账单、Data Service 与 IAM 资源。

Oreoxmt · 2026-01-26T07:03:42Z

api/_index.md

+
+| API | 说明 |
+| --- | --- |
+| [v1beta1](/api/tidb-cloud-api-v1beta1.md) | 管理 TiDB Cloud Starter、Essential 与 Dedicated 集群，以及计费、Data Service 与 IAM 资源。 |


Suggested change

| [v1beta1](/api/tidb-cloud-api-v1beta1.md) | 管理 TiDB Cloud Starter、Essential 与 Dedicated 集群，以及计费、Data Service 与 IAM 资源。 |

| [v1beta1](/api/tidb-cloud-api-v1beta1.md) | 管理 TiDB Cloud Starter、Essential 与 Dedicated 集群，以及账单、Data Service 与 IAM 资源。 |

Oreoxmt · 2026-01-26T07:04:55Z

api/tidb-cloud-api-v1beta1.md

+目前，你可以使用以下 v1beta1 API 来管理 TiDB Cloud 中的资源：
+
+- 集群级资源：
+    - [TiDB Cloud Starter 或 Essential Cluster](https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless)：管理 TiDB Cloud Starter 或 Essential 的集群、分支、数据导出任务与数据导入任务。


Suggested change

- [TiDB Cloud Starter 或 Essential Cluster](https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless)：管理 TiDB Cloud Starter 或 Essential 的集群、分支、数据导出任务与数据导入任务。

- [TiDB Cloud Starter 或 Essential 集群](https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless)：管理 TiDB Cloud Starter 或 Essential 的集群、分支、数据导出任务与数据导入任务。

Oreoxmt · 2026-01-26T07:05:03Z

api/tidb-cloud-api-v1beta1.md

+
+- 集群级资源：
+    - [TiDB Cloud Starter 或 Essential Cluster](https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless)：管理 TiDB Cloud Starter 或 Essential 的集群、分支、数据导出任务与数据导入任务。
+    - [TiDB Cloud Dedicated Cluster](https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated)：管理 TiDB Cloud Dedicated 的集群、区域（Region）、Private Endpoint 连接以及数据导入任务。


Suggested change

- [TiDB Cloud Dedicated Cluster](https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated)：管理 TiDB Cloud Dedicated 的集群、区域（Region）、Private Endpoint 连接以及数据导入任务。

- [TiDB Cloud Dedicated 集群](https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated)：管理 TiDB Cloud Dedicated 的集群、区域 (region)、Private Endpoint 连接以及数据导入任务。

Oreoxmt · 2026-01-26T07:05:59Z

api/tidb-cloud-api-v1beta1.md

+    - [TiDB Cloud Starter 或 Essential Cluster](https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless)：管理 TiDB Cloud Starter 或 Essential 的集群、分支、数据导出任务与数据导入任务。
+    - [TiDB Cloud Dedicated Cluster](https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated)：管理 TiDB Cloud Dedicated 的集群、区域（Region）、Private Endpoint 连接以及数据导入任务。
+- 组织或项目级资源：
+    - [Billing](https://docs.pingcap.com/tidbcloud/api/v1beta1/billing)：管理 TiDB Cloud 集群的计费。


Suggested change

- [Billing](https://docs.pingcap.com/tidbcloud/api/v1beta1/billing)：管理 TiDB Cloud 集群的计费。

- [Billing](https://docs.pingcap.com/tidbcloud/api/v1beta1/billing)：管理 TiDB Cloud 集群的账单。

ti-chi-bot · 2026-01-26T07:06:52Z

[LGTM Timeline notifier]

Timeline:

2026-01-26 07:06:52.576491493 +0000 UTC m=+996040.190448349: ☑️ agreed by Oreoxmt.

qiancai added 2 commits January 22, 2026 18:20

add source files in English

aec804c

add translation

dd6bb76

ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 23, 2026

qiancai commented Jan 23, 2026

View reviewed changes

api/_index.md Outdated Show resolved Hide resolved

qiancai added 2 commits January 23, 2026 12:08

Update api/_index.md

7512ba2

add translation

ca4edbe

qiancai added the translation/from-docs This PR is translated from a PR in pingcap/docs. label Jan 23, 2026

ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Jan 23, 2026

qiancai self-assigned this Jan 23, 2026

Merge branch 'add-toc-api' of github.com:qiancai/docs-cn into add-toc…

8719283

…-api

minor updates

a61817d

ti-chi-bot bot requested a review from Oreoxmt January 23, 2026 05:51

qiancai added the type/refactor The issue belongs to a refactor work. label Jan 23, 2026

Oreoxmt reviewed Jan 26, 2026

View reviewed changes

Oreoxmt approved these changes Jan 26, 2026

View reviewed changes

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jan 26, 2026


		TiDB 提供了多种 API，可用于集群的查询与运维、数据的同步管理、系统的状态监控等多种场景。本文为 [TiDB Cloud](https://docs.pingcap.com/zh/tidbcloud/) 和 [TiDB](https://docs.pingcap.com/zh/tidb/stable/) 中可用的 API 提供了一个概览说明。

		## TiDB Cloud API（beta）

	- [Monitoring API](/api/monitoring-api-overview.md)
	- [监控 API](/api/monitoring-api-overview.md)

	summary: 了解 TiDB Cloud 与 TiDB 的 API。
	summary: 了解 TiDB Cloud 和 TiDB 可用的 API。


		# TiDB API 概览

		TiDB 提供了多种 API，可用于集群的查询与运维、数据的同步管理、系统的状态监控等多种场景。本文为 [TiDB Cloud](https://docs.pingcap.com/zh/tidbcloud/) 和 [TiDB](https://docs.pingcap.com/zh/tidb/stable/) 中可用的 API 提供了一个概览说明。

	TiDB 提供了多种 API，可用于集群的查询与运维、数据的同步管理、系统的状态监控等多种场景。本文为 [TiDB Cloud](https://docs.pingcap.com/zh/tidbcloud/) 和 [TiDB](https://docs.pingcap.com/zh/tidb/stable/) 中可用的 API 提供了一个概览说明。
	TiDB 提供了多种 API，可用于查询和运维集群、管理数据同步、监控系统状态等场景。本文介绍 [TiDB Cloud](https://docs.pingcap.com/zh/tidbcloud/) 和 [TiDB](https://docs.pingcap.com/zh/tidb/stable/) 的可用 API。


		[TiDB Cloud API](/api/tidb-cloud-api-overview.md) 是一个 [REST 接口](https://zh.wikipedia.org/wiki/表现层状态转换)。通过该 API，你可以以编程方式访问和操作 TiDB Cloud 中的各类管理资源，例如项目、集群、备份、恢复、导入、账单以及 Data Service。

		\| API \| 说明 \|


		TiDB 为相关 TiDB 工具提供了多种 API。通过这些 API，你可以管理集群组件、监控系统状态，并控制数据同步工作流。

		\| API \| 说明 \|

	\| [Monitoring API](/tidb-monitoring-api.md) \| 获取 TiDB 服务器运行状态、数据表的存储信息以及 TiKV 集群的详细信息。 \|
	\| [监控 API](/tidb-monitoring-api.md) \| 获取 TiDB Server 运行状态、数据表的存储信息以及 TiKV 集群的详细信息。 \|

	\| [TiDB Operator API](<https://github.com/pingcap/tidb-operator/blob/{{{ .tidb-operator-version }}}/docs/api-references/docs.md>) \| 管理 Kubernetes 上的 TiDB 集群，包括集群部署、升级、扩缩容、备份与故障切换等操作。 \|
	\| [TiDB Operator API](<https://github.com/pingcap/tidb-operator/blob/{{{ .tidb-operator-version }}}/docs/api-references/docs.md>) \| 管理 Kubernetes 上的 TiDB 集群，包括集群部署、升级、扩缩容、备份与故障转移等操作。 \|

	summary: 了解 Data Migration（DM）的 API。
	summary: 了解 Data Migration (DM) 的 API。


		# Data Migration API 概览

		[TiDB Data Migration](/dm/dm-overview.md)（DM）是一款便捷的数据迁移工具，支持从与 MySQL 协议兼容的数据库（例如 MySQL、MariaDB、Aurora MySQL）到 TiDB 的全量数据迁移和增量数据同步。


		# TiDB 监控 API 概览

		TiDB 的监控框架基于 [Prometheus](https://prometheus.io) 和 [Grafana](https://grafana.com/grafana) 这两个开源项目。TiDB 使用 Prometheus 作为监控和性能指标信息存储方案，使用 Grafana 作为可视化组件进行展示，并提供内置的 [TiDB Dashboard](/dashboard/dashboard-intro.md) 图形化界面，用于监控及诊断 TiDB 集群。


		该 API 具有以下特性：

		- JSON 实体（JSON entities）：API 中的所有资源和数据均使用 JSON 格式。

	- JSON 实体（JSON entities）：API 中的所有资源和数据均使用 JSON 格式。
	- JSON 实体 (JSON entities)：API 中的所有资源和数据均使用 JSON 格式。


		TiDB Cloud API 提供以下两个版本：

		- [v1beta1](/api/tidb-cloud-api-v1beta1.md)：管理 TiDB Cloud Starter、Essential 与 Dedicated 集群，以及计费、Data Service 与 IAM 资源。

	\| [v1beta1](/api/tidb-cloud-api-v1beta1.md) \| 管理 TiDB Cloud Starter、Essential 与 Dedicated 集群，以及计费、Data Service 与 IAM 资源。 \|
	\| [v1beta1](/api/tidb-cloud-api-v1beta1.md) \| 管理 TiDB Cloud Starter、Essential 与 Dedicated 集群，以及账单、Data Service 与 IAM 资源。 \|

	- [TiDB Cloud Starter 或 Essential Cluster](https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless)：管理 TiDB Cloud Starter 或 Essential 的集群、分支、数据导出任务与数据导入任务。
	- [TiDB Cloud Starter 或 Essential 集群](https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless)：管理 TiDB Cloud Starter 或 Essential 的集群、分支、数据导出任务与数据导入任务。

	- [TiDB Cloud Dedicated Cluster](https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated)：管理 TiDB Cloud Dedicated 的集群、区域（Region）、Private Endpoint 连接以及数据导入任务。
	- [TiDB Cloud Dedicated 集群](https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated)：管理 TiDB Cloud Dedicated 的集群、区域 (region)、Private Endpoint 连接以及数据导入任务。

	- [Billing](https://docs.pingcap.com/tidbcloud/api/v1beta1/billing)：管理 TiDB Cloud 集群的计费。
	- [Billing](https://docs.pingcap.com/tidbcloud/api/v1beta1/billing)：管理 TiDB Cloud 集群的账单。

new nav: Create TOC and overview docs for API #21293

Are you sure you want to change the base?

new nav: Create TOC and overview docs for API #21293

Uh oh!

Conversation

qiancai commented Jan 23, 2026

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

Uh oh!

Uh oh!

ti-chi-bot bot commented Jan 23, 2026

Uh oh!

ti-chi-bot bot commented Jan 23, 2026

Uh oh!

Oreoxmt commented Jan 23, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Oreoxmt Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot bot commented Jan 26, 2026

[LGTM Timeline notifier]

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Oreoxmt Jan 26, 2026 •

edited

Loading