REST API for managing TiDB Cloud Dedicated clusters: cluster CRUD, pause/resume, root password reset, node quota, regions and node specs, private endpoint connections, data imports, third-party integrations and changefeeds (change data capture to downstream systems).
{
"swagger": "2.0",
"info": {
"title": "TiDB Cloud Dedicated API",
"description": "*TiDB Cloud API is in beta.*\n\nThis API manages [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#tidb-cloud-dedicated) clusters. For TiDB Cloud Starter or TiDB Cloud Essential instances, use the [TiDB Cloud Starter and Essential API](https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless). For more information about TiDB Cloud API, see [TiDB Cloud API Overview](https://docs.pingcap.com/tidbcloud/api-overview/).\n\n# Overview\n\nThe TiDB Cloud API is a [REST interface](https://en.wikipedia.org/wiki/Representational_state_transfer) that provides you with programmatic access to manage clusters and related resources within TiDB Cloud.\n\nThe API has the following features:\n\n- **JSON entities.** All entities are expressed in JSON.\n- **HTTPS-only.** You can only access the API via HTTPS, ensuring all the data sent over the network is encrypted with TLS.\n- **Key-based access and digest authentication.** Before you access TiDB Cloud API, you must generate an API key. All requests are authenticated through [HTTP Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication), ensuring the API key is never sent over the network.\n\n# Get Started\n\nThis guide helps you make your first API call to TiDB Cloud API. You'll learn how to authenticate a request, build a request, and interpret the response.\n\n## Prerequisites\n\nTo complete this guide, you need to perform the following tasks:\n\n- Create a [TiDB Cloud account](https://tidbcloud.com/free-trial)\n- Install [curl](https://curl.se/)\n\n## Step 1. Create an API key\n\nTo create an API key, log in to your TiDB Cloud console. Navigate to the [**API Keys**](https://tidbcloud.com/org-settings/api-keys) page of your organization, and create an API key.\n\nAn API key contains a public key and a private key. Copy and save them in a secure location. You will need to use the API key later in this guide.\n\nFor more details about creating API keys, refer to [API Key Management](#section/Authentication/API-Key-Management).\n\n## Step 2. Make your first API call\n\n### Build an API call\n\nTiDB Cloud API call consists of the following components:\n\n- **A host**. The host for TiDB Cloud API is <https://dedicated.tidbapi.com>.\n- **An API Key**. The public key and the private key are required for authentication.\n- **A request**. When submitting data to a resource via `POST`, `PATCH`, or `PUT`, you must submit your payload in JSON.\n\nIn this guide, you call the [List clusters](#tag/Cluster/operation/ClusterService_ListClusters) endpoint. For the detailed description of the endpoint, see the [API reference](#tag/Cluster/operation/ClusterService_ListClusters).\n\n### Call an API endpoint\n\nTo get all clusters in your organization, run the following command in your terminal. Remember to change `YOUR_PUBLIC_KEY` to your public key and `YOUR_PRIVATE_KEY` to your private key.\n\n```shell\ncurl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://dedicated.tidbapi.com/v1beta1/clusters'\n```\n\n## Step 3. Check the response\n\nAfter making the API call, if the status code in response is `200` and you see details about all clusters in your organization, your request is successful.\n\n# Authentication\n\nThe TiDB Cloud API uses [HTTP Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication). It protects your private key from being sent over the network. For more details about HTTP Digest Authentication, refer to the [IETF RFC](https://datatracker.ietf.org/doc/html/rfc7616).\n\n## API key overview\n\n- The API key contains a public key and a private key, which act as the username and password required in the HTTP Digest Authentication. The private key only displays upon the key creation.\n- The API key belongs to your organization and acts as the `Organization Owner` role. You can check [permissions of owner](https://docs.pingcap.com/tidbcloud/manage-user-access#configure-member-roles).\n- You must provide the correct API key in every request. Otherwise, TiDB Cloud responds with a `401` error.\n\n## API key management\n\n### Create an API key\n\nOnly the **owner** of an organization can create an API key.\n\nTo create an API key in an organization, perform the following steps:\n\n1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner.\n2. In the left navigation pane, click **Organization Settings** > **API Keys**.\n3. On the **API Keys** page, click **Create API Key**.\n4. Enter a description for your API key.\n5. Configure the role and scope for the API key. For more information about the permissions of a role, see [User roles](https://docs.pingcap.com/tidbcloud/manage-user-access/#user-roles).\n6. Click **Generate API Key**. Copy and save the public key and the private key.\n7. Make sure that you have copied and saved the private key in a secure location. The private key only displays upon the creation. After leaving this page, you will not be able to get the full private key again.\n8. Click **Done**.\n\n### View details of an API key\n\nTo view details of an API key, perform the following steps:\n\n1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner.\n2. In the left navigation pane, click **Organization Settings** > **API Keys**.\n3. You can view the details of the API keys on the page.\n\n### Edit an API key\n\nOnly the **owner** of an organization can modify an API key.\n\nTo edit an API key in an organization, perform the following steps:\n\n1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner.\n2. In the left navigation pane, click **Organization Settings** > **API Keys**.\n3. On the **API Keys** page, click **...** in the API key row that you want to change, and then click **Update Role**.\n4. You can update the description and role of the API key.\n5. Click **Update**.\n\n### Delete an API key\n\nOnly the **owner** of an organization can delete an API key.\n\nTo delete an API key in an organization, perform the following steps:\n\n1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner.\n2. In the left navigation pane, click **Organization Settings** > **API Keys**.\n3. On the **API Keys** page, click **...** in the API key row that you want to delete, and then click **Delete**.\n4. Click **I understand, delete it.**\n\n# Rate Limiting\n\nThe TiDB Cloud API allows up to 100 requests per minute per API key. If you exceed the rate limit, the API returns a `429` error. For more quota, you can [submit a request](https://support.pingcap.com/hc/en-us/requests/new?ticket_form_id=7800003722519) to contact our support team.\n\nEach API request returns the following headers about the limit.\n\n- `X-Ratelimit-Limit-Minute`: The number of requests allowed per minute. It is 100 currently.\n- `X-Ratelimit-Remaining-Minute`: The number of remaining requests in the current minute. When it reaches `0`, the API returns a `429` error and indicates that you exceed the rate limit.\n- `X-Ratelimit-Reset`: The time in seconds at which the current rate limit resets.\n\nIf you exceed the rate limit, an error response returns like this.\n\n```\n> HTTP/2 429\n> date: Fri, 22 Jul 2022 05:28:37 GMT\n> content-type: application/json\n> content-length: 66\n> x-ratelimit-reset: 23\n> x-ratelimit-remaining-minute: 0\n> x-ratelimit-limit-minute: 100\n> x-kong-response-latency: 2\n> server: kong/2.8.1\n\n> {\"details\":[],\"code\":49900007,\"message\":\"The request exceeded the limit of 100 times per apikey per minute. For more quota, please contact us: https://support.pingcap.com/hc/en-us/requests/new?ticket_form_id=7800003722519\"}\n```\n\n# API Changelog\n\nThis changelog lists all changes to the TiDB Cloud API.\n\n<!-- In reverse chronological order -->\n\n## 20260707\n\n- Introduce the following Changefeed endpoints for managing changefeeds:\n\t* [List changefeed RCU options](#tag/Changefeed/operation/ListChangefeedRCUs)\n\t* [List changefeeds](#tag/Changefeed/operation/ListChangefeeds)\n\t* [Create a changefeed](#tag/Changefeed/operation/CreateChangefeed)\n\t* [Get a changefeed](#tag/Changefeed/operation/GetChangefeed)\n\t* [Delete a changefeed](#tag/Changefeed/operation/DeleteChangefeed)\n\t* [Update a changefeed downstream config](#tag/Changefeed/operation/EditChangefeedDownstreamConfig)\n\t* [Pause a changefeed](#tag/Changefeed/operation/PauseChangefeed)\n\t* [Resume a changefeed](#tag/Changefeed/operation/ResumeChangefeed)\n\t* [Scale a changefeed](#tag/Changefeed/operation/ScaleChangefeed)\n\n## 20251028\n\n- Introduce the following TiDB Cloud Dedicated API endpoints for managing third-party monitoring integrations:\n\t* [List integrations](#tag/Integration/operation/IntegrationService_ListIntegrations)\n\t* [Create an integration](#tag/Integration/operation/IntegrationService_CreateIntegration)\n\t* [Delete an integration](#tag/Integration/operation/IntegrationService_DeleteIntegration)\n\n## 20250812\n\n- Initial release of the TiDB Cloud Dedicated API, including the following resources and endpoints:\n\t* Cluster\n\t\t* [List clusters](#tag/Cluster/operation/ClusterService_ListClusters)\n\t\t* [Create a cluster](#tag/Cluster/operation/ClusterService_CreateCluster)\n\t\t* [Get a cluster](#tag/Cluster/operation/ClusterService_GetCluster)\n\t\t* [Delete a cluster](#tag/Cluster/operation/ClusterService_DeleteCluster)\n\t\t* [Update a cluster](#tag/Cluster/operation/ClusterService_UpdateCluster)\n\t\t* [Pause a cluster](#tag/Cluster/operation/ClusterService_PauseCluster)\n\t\t* [Resume a cluster](#tag/Cluster/operation/ClusterService_ResumeCluster)\n\t\t* [Reset the root password of a cluster](#tag/Cluster/operation/ClusterService_ResetRootPassword)\n\t\t* [List node quotas for your organization](#tag/Cluster/operation/ClusterService_ShowNodeQuota)\n\t\t* [Get log redaction policy](#tag/Cluster/operation/ClusterService_GetLogRedactionPolicy)\n\t* Region\n\t\t* [List regions](#tag/Region/operation/RegionService_ListRegions)\n\t\t* [Get a region](#tag/Region/operation/RegionService_GetRegion)\n\t\t* [List cloud providers](#tag/Region/operation/RegionService_ShowCloudProviders)\n\t\t* [List node specs](#tag/Region/operation/RegionService_ListNodeSpecs)\n\t\t* [Get a node spec](#tag/Region/operation/RegionService_GetNodeSpec)\n\t* Private Endpoint Connection\n\t\t* [Get private link service for a TiDB node group](#tag/Private-Endpoint-Connection/operation/PrivateEndpointConnectionService_GetPrivateLinkService)\n\t\t* [Create a private endpoint connection](#tag/Private-Endpoint-Connection/operation/PrivateEndpointConnectionService_CreatePrivateEndpointConnection)\n\t\t* [List private endpoint connections](#tag/Private-Endpoint-Connection/operation/PrivateEndpointConnectionService_ListPrivateEndpointConnections)\n\t\t* [Get a private endpoint connection](#tag/Private-Endpoint-Connection/operation/PrivateEndpointConnectionService_GetPrivateEndpointConnection)\n\t\t* [Delete a private endpoint connection](#tag/Private-Endpoint-Connection/operation/PrivateEndpointConnectionService_DeletePrivateEndpointConnection)\n\t* Import\n\t\t* [List import tasks](#tag/Import/operation/ListImports)\n\t\t* [Create an import task](#tag/Import/operation/CreateImport)\n\t\t* [Get an import task](#tag/Import/operation/GetImport)\n\t\t* [Cancel an import task](#tag/Import/operation/CancelImport)\n\t\n",
"version": "v1beta1"
},
"tags": [
{
"name": "Cluster",
"description": "Create, get, update, delete, pause, resume, reset the root password, and list node quotas of a cluster."
},
{
"name": "Region",
"description": "List regions, get a region, and list cloud providers and node specs of a region."
},
{
"name": "Private Endpoint Connection",
"description": "Get private link service for a TiDB node group, create a private endpoint connection, list private endpoint connections, get a private endpoint connection, and delete a private endpoint connection."
},
{
"name": "Import",
"description": "List import tasks, create an import task, get an import task, and cancel an import task."
},
{
"name": "Integration",
"description": "List integrations, create an integration, and delete an integration."
},
{
"name": "Changefeed",
"description": "List changefeed RCU options, list changefeeds, create a changefeed, get a changefeed, delete a changefeed, update a changefeed downstream config, pause a changefeed, resume a changefeed, and scale a changefeed."
}
],
"x-tagGroups": [
{
"name": "Endpoints",
"tags": [
"Cluster",
"Region",
"Private Endpoint Connection",
"Import",
"Integration",
"Changefeed"
]
}
],
"host": "dedicated.tidbapi.com",
"basePath": "/v1beta1",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/clusters": {
"get": {
"summary": "List clusters",
"description": "Lists all clusters in your organization. You can filter results by project, region, cluster state, or specific cluster IDs.",
"operationId": "ClusterService_ListClusters",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1ListClustersResponse"
}
},
"400": {
"description": "A request field is invalid.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"401": {
"description": "The API key cannot be authenticated.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"403": {
"description": "The API key does not have permission to access the resource.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"429": {
"description": "You have exceed the rate limit.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
}
},
"parameters": [
{
"name": "projectId",
"description": "The ID of the project. If not specified, the project ID of the default project is used.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "clusterIds",
"description": "A list of cluster IDs. If specified, only clusters matching these IDs are returned.",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "regionIds",
"description": "A list of region IDs. If specified, only clusters in these regions are returned.",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "clusterStates",
"description": "A list of cluster states. If specified, only clusters in these states are returned.\n\n`\"UPGRADING\"`, `\"IMPORTING\"`, `\"MODIFYING\"`, `\"PAUSING\"`, `\"PAUSED\"`, and `\"RESUMING\"` states are only available for [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#tidb-cloud-dedicated) clusters.\n\n - CREATING: Cluster is being created.\n - DELETING: Cluster is being deleted.\n - ACTIVE: Cluster is active for use.\n - RESTORING: Cluster data is being restored.\n - MAINTENANCE: Cluster is under maintenance.\n - DELETED: Cluster has been deleted.\n - INACTIVE: Cluster is not active, but not being deleted.\n - UPGRADING: Cluster is being updated.\nOnly for Dedicated Cluster.\n - IMPORTING: Cluster is being imported.\nOnly for Dedicated Cluster.\n - MODIFYING: Cluster is being modified.\nOnly for Dedicated Cluster.\n - PAUSING: Cluster is being paused.\nOnly for Dedicated Cluster.\n - PAUSED: Cluster is paused.\nOnly for Dedicated Cluster.\n - RESUMING: Cluster is resuming.\nOnly for Dedicated Cluster.",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"CREATING",
"DELETING",
"ACTIVE",
"RESTORING",
"MAINTENANCE",
"DELETED",
"INACTIVE",
"UPGRADING",
"IMPORTING",
"MODIFYING",
"PAUSING",
"PAUSED",
"RESUMING"
]
},
"collectionFormat": "multi"
},
{
"name": "pageSize",
"description": "The maximum number of clusters to return. If not specified, at most 10 clusters will be returned. The maximum value is `100`. Values greater than `100` are set to `100`.",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"default": 10,
"minimum": 1,
"maximum": 100
},
{
"name": "pageToken",
"description": "The pagination token received from a previous [List clusters](#tag/Cluster/operation/ClusterService_ListClusters) request. Use this token to retrieve the next page of results.\n\n**Note**: When paginating, all other parameters must match the original request.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "skip",
"description": "The number of clusters to skip before returning results. If the value exceeds the total number of clusters, the response is `200` with an empty list and no `nextPageToken`.",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"tags": [
"Cluster"
],
"x-code-samples": [
{
"lang": "curl",
"label": "curl",
"source": "curl --digest --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --location 'https://dedicated.tidbapi.com/v1beta1/clusters'"
}
]
},
"post": {
"summary": "Create a cluster",
"description": "Creates a new [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#tidb-cloud-dedicated) cluster. Before creating a TiDB Cloud Dedicated cluster, you must set a [Project CIDR on TiDB Cloud console](https://docs.pingcap.com/tidbcloud/set-up-vpc-peering-connections/#prerequisite-set-a-cidr-for-a-region).",
"operationId": "ClusterService_CreateCluster",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster"
}
},
"400": {
"description": "A request field is invalid.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"401": {
"description": "The API key cannot be authenticated.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"403": {
"description": "The API key does not have permission to access the resource.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"429": {
"description": "You have exceed the rate limit.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
}
},
"parameters": [
{
"name": "cluster",
"description": "Required.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster"
}
},
{
"name": "validateOnly",
"description": "If set to `true`, the request is validated but not executed. Defaults to `false`.",
"in": "query",
"required": false,
"type": "boolean"
}
],
"tags": [
"Cluster"
],
"x-code-samples": [
{
"lang": "curl",
"label": "curl",
"source": "curl --digest --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --location 'https://dedicated.tidbapi.com/v1beta1/clusters' --header 'Content-Type: application/json' --data '{\n \"displayName\": \"foo-bar\",\n \"regionId\": \"aws-us-west-2\",\n \"labels\": {\n \"tidb.cloud/project\": \"YOUR_PROJECT_ID\"\n },\n \"tidbNodeSetting\": {\n \"nodeSpecKey\": \"8C32G\",\n \"tidbNodeGroups\": [\n {\n \"nodeCount\": 2\n }\n ]\n },\n \"tikvNodeSetting\": {\n \"nodeCount\": 3,\n \"nodeSpecKey\": \"8C32G\",\n \"storageSizeGi\": 500,\n \"storageType\": \"Standard\"\n }\n}'"
}
]
}
},
"/clusters/{clusterId}": {
"get": {
"summary": "Get a cluster",
"description": "Retrieves details of a specific cluster.",
"operationId": "ClusterService_GetCluster",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster"
}
},
"400": {
"description": "A request field is invalid.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"401": {
"description": "The API key cannot be authenticated.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"403": {
"description": "The API key does not have permission to access the resource.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"429": {
"description": "You have exceed the rate limit.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
}
},
"parameters": [
{
"name": "clusterId",
"description": "The ID of the cluster.",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"Cluster"
],
"x-code-samples": [
{
"lang": "curl",
"label": "curl",
"source": "curl --digest --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --location 'https://dedicated.tidbapi.com/v1beta1/clusters/{clusterId}'"
}
]
},
"delete": {
"summary": "Delete a cluster",
"description": "Deletes a cluster by `clusterId`.",
"operationId": "ClusterService_DeleteCluster",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster"
}
},
"400": {
"description": "A request field is invalid.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"401": {
"description": "The API key cannot be authenticated.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"403": {
"description": "The API key does not have permission to access the resource.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"429": {
"description": "You have exceed the rate limit.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
}
},
"parameters": [
{
"name": "clusterId",
"description": "The ID of the cluster to delete.",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "validateOnly",
"description": "If set to `true`, the request is validated but not executed. Defaults to `false`.",
"in": "query",
"required": false,
"type": "boolean"
}
],
"tags": [
"Cluster"
],
"x-code-samples": [
{
"lang": "curl",
"label": "curl",
"source": "curl --digest --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --location --request DELETE 'https://dedicated.tidbapi.com/v1beta1/clusters/{clusterId}'"
}
]
},
"patch": {
"summary": "Update a cluster",
"description": "Updates the configuration of a specific cluster. You can modify the following fields: `tidbNodeSetting`, `tikvNodeSetting`, `tiflashNodeSetting` and `displayName`.",
"operationId": "ClusterService_UpdateCluster",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster"
}
},
"400": {
"description": "A request field is invalid.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"401": {
"description": "The API key cannot be authenticated.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"403": {
"description": "The API key does not have permission to access the resource.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"429": {
"description": "You have exceed the rate limit.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
}
},
"parameters": [
{
"name": "clusterId",
"description": "The ID of the cluster to update.",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "cluster",
"description": "The updated cluster configuration.",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"tidbNodeSetting": {
"description": "The TiDB node setting for updating a cluster. \n\nTo get the node spec available configurations of a specific region for a cloud provider, refer to [List node specs](#tag/Region/operation/RegionService_ListNodeSpecs) API.",
"allOf": [
{
"$ref": "#/definitions/v1beta1UpdateClusterRequestTidbNodeSetting"
}
]
},
"tikvNodeSetting": {
"description": "The TiKV node setting for updating a cluster. \n\nTo get the node spec available configurations of a specific region for a cloud provider, refer to [List node specs](#tag/Region/operation/RegionService_ListNodeSpecs) API.",
"allOf": [
{
"$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting"
}
]
},
"tiflashNodeSetting": {
"example": {
"nodeCount": 3,
"nodeSpecKey": "16C128G",
"storageSizeGi": 500,
"storageType": "Basic"
},
"description": "The TiFlash node setting for updating a cluster. \n\nTo get the node spec available configurations of a specific region for a cloud provider, refer to [List node specs](#tag/Region/operation/RegionService_ListNodeSpecs) API.",
"allOf": [
{
"$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting"
}
]
},
"displayName": {
"type": "string",
"example": "My Cluster",
"description": "The display name of the cluster."
},
"labels": {
"type": "object",
"example": {},
"additionalProperties": {
"type": "string"
},
"description": "The labels of the cluster. Each label consists of a string key and a string value. \n\n**Note**: Currently, `labels` updates are not supported."
}
},
"title": "The updated cluster configuration."
}
},
{
"name": "validateOnly",
"description": "If set to `true`, the request is validated but not executed. Defaults to `false`.",
"in": "query",
"required": false,
"type": "boolean"
}
],
"tags": [
"Cluster"
],
"x-code-samples": [
{
"lang": "curl",
"label": "curl",
"source": "curl --digest --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --location --request PATCH 'https://dedicated.tidbapi.com/v1beta1/clusters/{clusterId}' --header 'Content-Type: application/json' --data '{\n \"displayName\": \"My Cluster Updated By API\",\n \"tikvNodeSetting\": {\n \"storageSizeGi\": 500\n }\n}'"
}
]
}
},
"/clusters/{clusterId}:pauseCluster": {
"post": {
"summary": "Pause a cluster",
"description": "Pauses a cluster by ID.",
"operationId": "ClusterService_PauseCluster",
"responses": {
"200": {
"
# --- truncated at 32 KB (250 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pingcap/refs/heads/main/openapi/pingcap-tidb-cloud-dedicated-v1beta1-openapi-original.json