{ "basePath": "/api/v2023/clusterManagement/v1beta1", "consumes": [ "application/json" ], "definitions": { "AdvancedModifyDedicatedClusterRequestTidbNodeGroupCreate": { "properties": { "displayName": { "description": "The display name of the TiDB group.", "type": "string" }, "nodeCount": { "description": "The number of TiDB nodes in the TiDB group.", "format": "int32", "type": "integer" }, "nodeSpecKey": { "description": "The node spec key of the TiDB group. For example, `8C32G`.", "example": "8C32G", "type": "string" }, "tiproxySetting": { "allOf": [ { "$ref": "#/definitions/dedicatedv1beta1TidbNodeGroupTiProxySetting" } ], "description": "The TiProxy setting for the TiDB group. If not specified, the default TiProxy setting will be used.", "title": "TiProxySetting" } }, "required": [ "displayName", "nodeCount" ], "type": "object" }, "AdvancedModifyDedicatedClusterRequestTidbNodeGroupUpdate": { "properties": { "nodeCount": { "description": "The number of TiDB nodes in the TiDB group.", "format": "int32", "type": "integer" }, "nodeSpecKey": { "description": "The node spec key of the TiDB group. For example, `8C32G`.", "example": "8C32G", "type": "string" }, "tidbNodeGroupId": { "type": "string" }, "tiproxySetting": { "$ref": "#/definitions/dedicatedv1beta1TidbNodeGroupTiProxySetting" } }, "required": [ "tidbNodeGroupId" ], "type": "object" }, "CheckModificationRisksResponseRisk": { "properties": { "bizCode": { "format": "int64", "type": "string" }, "componentType": { "$ref": "#/definitions/dedicatedv1beta1ComponentType" }, "description": { "type": "string" } }, "type": "object" }, "ClusterClusterType": { "enum": [ "DEDICATED", "SERVERLESS" ], "type": "string" }, "ClusterNodeChangingProgress": { "properties": { "matchingNodeSpecNodeCount": { "description": "The number of nodes that match the specified node spec.", "format": "int32", "readOnly": true, "type": "integer" }, "remainingDeletionNodeCount": { "description": "The number of nodes pending deletion. This value appears only during node deletion operations.", "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "ClusterServiceCheckModificationRisksBody": { "properties": { "cluster": { "properties": { "displayName": { "type": "string" }, "tidbNodeSetting": { "$ref": "#/definitions/v1beta1AdvancedModifyDedicatedClusterRequestTidbNodeSetting" }, "tiflashNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting" }, "tikvNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting" } }, "type": "object" } }, "required": [ "cluster" ], "type": "object" }, "ClusterSpendingLimit": { "description": "Message for spending limit configuration.", "properties": { "monthly": { "description": "The maximum spending limit for the cluster per month, in USD cents.", "format": "int32", "type": "integer" } }, "type": "object" }, "ClusterStorageNodeSettingStorageType": { "description": " - Basic: Data disk: gp3; Raft log disk: none.\n - Standard: Data disk: gp3; Raft log disk: gp3.\n - Performance: Data disk: gp3; Raft log disk: io2.\n - Plus: Data disk: io2; Raft log disk: none.", "enum": [ "Basic", "Standard", "Performance", "Plus" ], "type": "string" }, "EndpointsPrivate": { "description": "Message for private endpoint to securely connect to the cluster.", "properties": { "alicloud": { "allOf": [ { "$ref": "#/definitions/PrivateALICLOUD" } ], "readOnly": true }, "aws": { "allOf": [ { "$ref": "#/definitions/PrivateAWS" } ], "readOnly": true }, "gcp": { "allOf": [ { "$ref": "#/definitions/PrivateGCP" } ], "readOnly": true }, "host": { "description": "The hostname of the private endpoint.", "readOnly": true, "type": "string" }, "port": { "description": "The port number of the private endpoint.", "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "EndpointsPublic": { "description": "Message for public endpoint to connect to the cluster.", "properties": { "authorizedNetworks": { "description": "The list of networks that are allowed to connect to the cluster.", "items": { "$ref": "#/definitions/EndpointsPublicAuthorizedNetwork", "type": "object" }, "type": "array" }, "disabled": { "description": "Indicates whether the public endpoint is disabled.", "type": "boolean" }, "host": { "description": "The hostname of the public endpoint.", "readOnly": true, "type": "string" }, "port": { "format": "int32", "readOnly": true, "title": "The port number of the public endpoint", "type": "integer" } }, "type": "object" }, "EndpointsPublicAuthorizedNetwork": { "properties": { "displayName": { "description": "The display name of the authorized network.", "type": "string" }, "endIpAddress": { "description": "The ending IP address of the authorized network range.", "type": "string" }, "startIpAddress": { "description": "The starting IP address of the authorized network range.", "type": "string" } }, "required": [ "startIpAddress", "endIpAddress", "displayName" ], "type": "object" }, "EstimatePriceResponsePrice": { "properties": { "componentType": { "$ref": "#/definitions/dedicatedv1beta1ComponentType" }, "computeDiscountedPrice": { "format": "double", "type": "number" }, "computeOriginalPrice": { "format": "double", "type": "number" }, "storageDiscountedPrice": { "format": "double", "type": "number" }, "storageOriginalPrice": { "format": "double", "type": "number" } }, "type": "object" }, "PrivateALICLOUD": { "description": "The [Alibaba Cloud PrivateLink](https://www.alibabacloud.com/help/en/privatelink/product-overview/what-is-a-private-network-connection) configuration for private access.", "properties": { "availabilityZone": { "description": "A list of availability zones where the service is available.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "serviceName": { "description": "The Alibaba Cloud service name for private access.", "readOnly": true, "type": "string" } }, "type": "object" }, "PrivateAWS": { "description": "The [AWS PrivateLink](https://aws.amazon.com/privatelink/) configuration details for private access.", "properties": { "availabilityZone": { "description": "A list of availability zones where the service is available.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "serviceName": { "description": "The AWS service name for private access.", "readOnly": true, "type": "string" } }, "type": "object" }, "PrivateGCP": { "description": "Message for GCP Private Service information.", "properties": { "serviceAttachmentName": { "description": "The target GCP service attachment name for private access.", "readOnly": true, "type": "string" } }, "type": "object" }, "bffcluster_managementv1beta1Cluster": { "properties": { "clusterType": { "$ref": "#/definitions/ClusterClusterType" }, "dedicatedCluster": { "$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster" }, "serverlessCluster": { "$ref": "#/definitions/tidb_cloud_open_apiserverlessv1beta1Cluster" } }, "type": "object" }, "bffcluster_managementv1beta1ListClustersResponse": { "properties": { "clusters": { "items": { "$ref": "#/definitions/bffcluster_managementv1beta1Cluster", "type": "object" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", "type": "string" }, "totalSize": { "description": "The total number of clusters that matched the query.", "format": "int32", "type": "integer" } }, "type": "object" }, "cluster_managementv1beta1EstimatePriceRequest": { "properties": { "duration": { "description": "Format: {digits}s\nIf duration is not specified, the default duration is 3600s (1h).", "type": "string" }, "paused": { "description": "If specified, the price will be estimated based on cluster keep paused during the duration interval.", "type": "boolean" }, "projectId": { "description": "If not specified, the project ID of the default project will be used.", "type": "string" }, "promoted": { "title": "[https://pingcap.feishu.cn/wiki/SWfnwtCBZid1bdk5a7FcamQcn5g#share-E8Uddcpw2onjx1xnUVuc9pcanSh](price promotion until 2025/May)", "type": "boolean" }, "regionId": { "title": "Format: {cloud_provider}-{region_code}", "type": "string" }, "tidbNodeSetting": { "$ref": "#/definitions/v1beta1ClusterTidbNodeSetting" }, "tiflashNodeSetting": { "$ref": "#/definitions/v1beta1ClusterStorageNodeSetting" }, "tikvNodeSetting": { "$ref": "#/definitions/v1beta1ClusterStorageNodeSetting" } }, "required": [ "regionId" ], "type": "object" }, "cluster_managementv1beta1EstimatePriceResponse": { "properties": { "prices": { "items": { "$ref": "#/definitions/EstimatePriceResponsePrice", "type": "object" }, "type": "array" } }, "type": "object" }, "commonv1beta1ClusterState": { "description": "Enum of possible states of a cluster.\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.", "enum": [ "CREATING", "DELETING", "ACTIVE", "RESTORING", "MAINTENANCE", "DELETED", "INACTIVE", "UPGRADING", "IMPORTING", "MODIFYING", "PAUSING", "PAUSED", "RESUMING" ], "type": "string" }, "commonv1beta1Region": { "description": "A representation of a region for deploying TiDB clusters.", "properties": { "cloudProvider": { "allOf": [ { "$ref": "#/definitions/v1beta1RegionCloudProvider" } ], "description": "The cloud provider that offers the region.\n\n- `\"aws\"`: Amazon Web Services\n\n- `\"gcp\"`: Google Cloud\n\n- `\"azure\"`: Microsoft Azure\n\n- `\"alicloud\"`: Alibaba Cloud", "example": "aws", "readOnly": true }, "displayName": { "description": "A human-readable name for the region. For example, `Oregon (us-west-2)`.", "example": "Oregon (us-west-2)", "readOnly": true, "type": "string" }, "name": { "description": "The unique name of the region, in the format of `regions/{region_id}`. For example, `regions/aws-us-west-2`.", "example": "regions/aws-us-west-2", "pattern": "^regions/(aws|gcp|azure)-(.+)$", "type": "string" }, "provider": { "description": "**Deprecated.** Use `cloudProvider` instead. The name of the cloud provider. For example, `aws`, `gcp`, `azure`, or `alicloud`.", "example": "aws", "readOnly": true, "title": "Deprecated", "type": "string", "x-nullable": true }, "regionId": { "description": "The unique identifier for the region, in the format of `{cloud_provider}-{region_code}`. For example, `aws-us-west-2`.", "example": "aws-us-west-2", "pattern": "^(aws|gcp|azure|alicloud)-[a-z0-9-]+$", "readOnly": true, "type": "string" }, "servicePlans": { "description": "The service plans available in this region.", "example": [ "Starter", "Essential", "Premium" ], "items": { "$ref": "#/definitions/commonv1beta1ServicePlan" }, "readOnly": true, "title": "ServicePlan", "type": "array" } }, "type": "object" }, "commonv1beta1ServicePlan": { "enum": [ "Starter", "Essential", "Premium", "BYOC" ], "type": "string" }, "dedicatedv1beta1ClusterPausePlan": { "properties": { "pauseType": { "allOf": [ { "$ref": "#/definitions/dedicatedv1beta1ClusterPausePlanType" } ], "description": "The type of the pause plan.\n\n- `\"NORMAL\"`: the default pause plan.\n- `\"DEPRECATE\"`: the legacy pause plan and will be removed in a future release.", "title": "PausePlanType" }, "scheduledResumeTime": { "description": "The scheduled time for the cluster to automatically resume from the `PAUSED` state, in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "pauseType" ], "type": "object" }, "dedicatedv1beta1ClusterPausePlanType": { "enum": [ "NORMAL", "DEPRECATE" ], "title": "- NORMAL: default pause plan\n - DEPRECATE: old pause plan, will be removed", "type": "string" }, "dedicatedv1beta1ComponentType": { "enum": [ "TIKV", "TIDB", "TIFLASH", "PD", "TIPROXY" ], "type": "string" }, "dedicatedv1beta1TidbNodeGroup": { "properties": { "clusterId": { "description": "The ID of the cluster that the TiDB node group belongs to.\n\n- This field is **optional** when creating a cluster with the default TiDB group.\n\n- This field is **required** when creating a non-default TiDB group.", "example": "1", "type": "string" }, "displayName": { "description": "The display name of the TiDB group.", "example": "DefaultGroup", "type": "string" }, "endpoints": { "description": "The endpoints of the TiDB group.", "example": [], "items": { "$ref": "#/definitions/dedicatedv1beta1TidbNodeGroupEndpoint", "type": "object" }, "readOnly": true, "title": "Endpoint", "type": "array" }, "isDefaultGroup": { "description": "Indicates whether this is the default TiDB node group.", "example": false, "readOnly": true, "type": "boolean" }, "name": { "description": "The resource name of the TiDB group, in the format of `tidbNodeGroups/{tidb_node_group_id}`.", "example": "tidbNodeGroups/1", "readOnly": true, "type": "string" }, "nodeChangingProgress": { "allOf": [ { "$ref": "#/definitions/ClusterNodeChangingProgress" } ], "description": "The progress of node configuration changes.", "readOnly": true, "title": "NodeChangingProgress" }, "nodeCount": { "description": "The number of TiDB nodes in the TiDB group. It must be greater than or equal to `1`.", "example": 2, "format": "int32", "minimum": 1, "type": "integer" }, "nodeSpecDisplayName": { "description": "The display name of the node spec of the TiDB group. For example, `8 vCPU, 32 GiB`.", "example": "8 vCPU, 32 GiB", "readOnly": true, "type": "string" }, "nodeSpecKey": { "description": "The node spec key of the TiDB group. For example, `8C32G`.", "example": "8C32G", "type": "string" }, "nodeSpecVersion": { "description": "The version tag of the node spec resource. The performance and price of the component may vary based on the version tag.", "readOnly": true, "type": "string" }, "state": { "allOf": [ { "$ref": "#/definitions/dedicatedv1beta1TidbNodeGroupState" } ], "description": "The current state of the TiDB group.", "example": "ACTIVE", "readOnly": true }, "tidbNodeGroupId": { "description": "The unique ID of the TiDB group.", "example": "1", "readOnly": true, "type": "string" }, "tiproxyNodeChangingProgress": { "allOf": [ { "$ref": "#/definitions/ClusterNodeChangingProgress" } ], "description": "The progress of TiProxy node configuration changes.", "readOnly": true }, "tiproxySetting": { "allOf": [ { "$ref": "#/definitions/dedicatedv1beta1TidbNodeGroupTiProxySetting" } ], "description": "Configures TiProxy settings for this TiDB group. If not specified, the default TiProxy settings is used." } }, "required": [ "nodeCount" ], "type": "object" }, "dedicatedv1beta1TidbNodeGroupEndpoint": { "properties": { "connectionType": { "allOf": [ { "$ref": "#/definitions/v1beta1TidbNodeGroupEndpointConnectionType" } ], "description": "The connection type for TiDB node group endpoints.\n\n- `\"PUBLIC\"`: indicates that the endpoint is accessible over the public network.\n\n- `\"VPC_PEERING\"`: indicates that the endpoint is accessible over [VPC peering](https://docs.pingcap.com/tidbcloud/tidb-cloud-glossary/#vpc-peering).\n\n- `\"PRIVATE_ENDPOINT\"`: indicates that the endpoint is accessible over a private link.", "example": "PRIVATE_ENDPOINT", "readOnly": true }, "host": { "description": "The hostname or IP address of the endpoint. For `PRIVATE_ENDPOINT` connection types, availability varies by cloud provider:\n\n- For clusters deployed on AWS, the `host` field is available after the private link service is ready.\n\n- For clusters deployed on Google Cloud or Azure, the `host` field is available after you create a `PrivateEndpointConnection`.", "readOnly": true, "type": "string" }, "port": { "description": "The port of the endpoint connection.", "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "dedicatedv1beta1TidbNodeGroupState": { "description": " - ACTIVE: Indicates the TiDB group is active and ready for use.\n - MODIFYING: Indicates the TiDB group is being modified.\n - PAUSED: Indicates the TiDB group is paused.", "enum": [ "ACTIVE", "MODIFYING", "PAUSED" ], "type": "string" }, "dedicatedv1beta1TidbNodeGroupTiProxySetting": { "properties": { "nodeCount": { "description": "The number of TiProxy nodes in the TiDB group. If not specified or set to `0`, TiProxy is disabled.", "example": 2, "format": "int32", "type": "integer", "x-nullable": true }, "nodeSpecDisplayName": { "description": "The display name of the TiProxy node spec. For example, `2 vCPU, 4 GiB`.", "example": "2 vCPU, 4 GiB", "readOnly": true, "type": "string" }, "nodeSpecKey": { "description": "The node spec key of the TiProxy nodes in the cluster. For example, `2C4G`.\n\nTo view available node specs, use the [List node specs](#tag/RegionService/operation/RegionService_ListNodeSpecs) endpoint.", "example": "2C4G", "type": "string" }, "nodeSpecVersion": { "readOnly": true, "type": "string" } }, "required": [ "nodeSpecKey" ], "type": "object" }, "googlerpcStatus": { "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "code": { "description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].", "format": "int32", "type": "integer" }, "details": { "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "items": { "$ref": "#/definitions/protobufAny", "type": "object" }, "type": "array" }, "message": { "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.", "type": "string" } }, "type": "object" }, "protobufAny": { "additionalProperties": {}, "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", "properties": { "@type": { "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", "type": "string" } }, "type": "object" }, "serverlessv1beta1ClusterHighAvailabilityType": { "description": "The high availability configuration for the cluster.\n\n- `ZONAL`: high availability within a single availability zone. For more information, see [Zonal high availability architecture](https://docs.pingcap.com/tidbcloud/serverless-high-availability/#zonal-high-availability-architecture).\n- `REGIONAL`: high availability across multiple availability zones within a region. For more information, see [Regional high availability architecture](https://docs.pingcap.com/tidbcloud/serverless-high-availability/#regional-high-availability-architecture).", "enum": [ "ZONAL", "REGIONAL" ], "type": "string" }, "tidb_cloud_open_apidedicatedv1beta1Cluster": { "description": "Cluster represents a dedicated TiDB cluster.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "The annotations for the cluster. The following lists some predefined annotations:\n- `tidb.cloud/has-set-password`: indicates whether the cluster has a root password set.\n- `tidb.cloud/available-features`: lists available features of the cluster.\n- `tidb.cloud/insufficient-vm-resource`: indicates insufficient virtual machine resources during during cluster creation or modification.", "example": { "tidb.cloud/has-set-password": "false" }, "readOnly": true, "title": "map\u003cstring, string\u003e", "type": "object" }, "cloudProvider": { "allOf": [ { "$ref": "#/definitions/v1beta1RegionCloudProvider" } ], "description": "The cloud provider where the cluster is located.\n\n- `\"aws\"`: Amazon Web Services\n\n- `\"gcp\"`: Google Cloud\n\n- `\"azure\"`: Microsoft Azure\n\n- `\"alicloud\"`: Alibaba Cloud", "example": "aws", "readOnly": true, "title": "CloudProvider" }, "clusterId": { "description": "The ID of the cluster.", "example": "1", "readOnly": true, "type": "string" }, "createTime": { "description": "The timestamp when the cluster was created, in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "example": "2023-10-01T12:00:00Z", "format": "date-time", "readOnly": true, "type": "string" }, "createdBy": { "description": "The email address or public API key of the user who create the cluster.", "example": "test@example.com", "readOnly": true, "type": "string" }, "displayName": { "description": "The user-defined name of the cluster.", "example": "foo-bar", "maxLength": 64, "minLength": 4, "pattern": "^[A-Za-z0-9][-A-Za-z0-9]{2,62}[A-Za-z0-9]$", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Key-value pairs used to label the cluster. If the `tidb.cloud/project` label is not specified, the cluster is associated with the default project in the creator's organization. \n\n**Note**: Currently, only the `tidb.cloud/project` label key can be specified when creating a new cluster.", "example": { "tidb.cloud/project": "1" }, "title": "map\u003cstring, string\u003e", "type": "object" }, "name": { "description": "The unique identifier for the TiDB cluster, which is generated by the API and follows the format `clusters/{clusterId}`.", "example": "clusters/1", "readOnly": true, "type": "string" }, "pausePlan": { "allOf": [ { "$ref": "#/definitions/dedicatedv1beta1ClusterPausePlan" } ], "description": "The pause plan configuration of the cluster.", "readOnly": true, "title": "PausePlan" }, "port": { "default": "4000", "description": "The port for cluster connections. All network endpoints in the cluster use this port.", "example": 4000, "format": "int32", "maximum": 65535, "minimum": 1024, "type": "integer" }, "regionDisplayName": { "description": "The display name of the region where the cluster is located. For example, `N. Virginia (us-east-1)`.", "example": "N. Virginia (us-east-1)", "readOnly": true, "type": "string" }, "regionId": { "description": "The region where the cluster is deployed, in the format of `{cloud_provider}-{region_code}`. For example, `aws-us-west-2`.", "example": "aws-us-west-2", "type": "string" }, "rootPassword": { "description": "The root password of the cluster. It must be between 8 and 64 characters long and can contain letters, numbers, and special characters.", "example": "my-shining-password", "maxLength": 64, "minLength": 8, "pattern": "^.{8,64}$", "type": "string" }, "state": { "allOf": [ { "$ref": "#/definitions/commonv1beta1ClusterState" } ], "description": "The current state of the cluster.", "example": "ACTIVE", "readOnly": true }, "tidbNodeSetting": { "allOf": [ { "$ref": "#/definitions/v1beta1ClusterTidbNodeSetting" } ], "description": "The configuration for [TiDB nodes](https://docs.pingcap.com/tidbcloud/tidb-cloud-glossary/#tidb-node) in a TiDB Cloud Dedicated cluster.\n\nTo view available node specs for a specific region and cloud provider, use the [List node specs](#tag/RegionService/operation/RegionService_ListNodeSpecs) endpoint.", "title": "TidbNodeSetting" }, "tiflashNodeSetting": { "allOf": [ { "$ref": "#/definitions/v1beta1ClusterStorageNodeSetting" } ], "description": "The configuration for [TiFlash nodes](https://docs.pingcap.com/tidbcloud/tidb-cloud-glossary/#tiflash-node) in a TiDB Cloud Dedicated cluster. If not set, TiFlash is disabled.\n\nTo view available node specs for a specific region and cloud provider, use the [List node specs](#tag/RegionService/operation/RegionService_ListNodeSpecs) endpoint.", "example": { "nodeCount": 3, "nodeSpecKey": "16C128G", "storageSizeGi": 500, "storageType": "Basic" }, "title": "StorageNodeSetting" }, "tikvNodeSetting": { "allOf": [ { "$ref": "#/definitions/v1beta1ClusterStorageNodeSetting" } ], "description": "The configuration for [TiKV nodes](https://docs.pingcap.com/tidbcloud/tidb-cloud-glossary/#tikv-node) in a TiDB Cloud Dedicated cluster.\n\nTo view available node specs for a specific region and cloud provider, use the [List node specs](#tag/RegionService/operation/RegionService_ListNodeSpecs) endpoint.", "title": "StorageNodeSetting" }, "updateTime": { "description": "The timestamp when the cluster was last updated, in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "example": "2023-10-01T12:00:00Z", "format": "date-time", "readOnly": true, "type": "string" }, "version": { "description": "The TiDB version of the cluster.", "example": "8.5.2", "readOnly": true, "type": "string" } }, "required": [ "displayName", "regionId", "tidbNodeSetting", "tikvNodeSetting", "port" ], "type": "object" }, "tidb_cloud_open_apiserverlessv1beta1Cluster": { "description": "Message for a TiDB Cloud Starter or Essential cluster.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "The annotations for the cluster. The following lists some predefined annotations.\n\n- `tidb.cloud/has-set-password`: indicates whether the cluster has a root password set.\n- `tidb.cloud/available-features`: lists available features of the cluster.", "readOnly": true, "type": "object" }, "auditLogConfig": { "allOf": [ { "$ref": "#/definitions/v1beta1ClusterAuditLogConfig" } ], "description": "The audit log configuration for the cluster." }, "autoScaling": { "allOf": [ { "$ref": "#/definitions/v1beta1ClusterAutoScaling" } ], "description": "The auto-scaling configuration for the cluster." }, "automatedBackupPolicy": { "allOf": [ { "$ref": "#/definitions/v1beta1ClusterAutomatedBackupPolicy" } ], "description": "The schedule and retention rules for automated database backups." }, "clusterId": { "description": "The ID of the cluster.", "readOnly": true, "type": "string" }, "createTime": { "description": "The timestamp when the cluster was created, in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "format": "date-time", "readOnly": true, "type": "string" }, "createdBy": { "description": "The email address of the user who create the cluster.", "readOnly": true, "type": "string" }, "displayName": { "description": "The user-defined name of the cluster.", "example": "foo-bar", "maxLength": 64, "minLength": 4, "pattern": "^[A-Za-z0-9][-A-Za-z0-9]{2,62}[A-Za-z0-9]$", "type": "string" }, "encryptionConfig": { "allOf": [ { "$ref": "#/definitions/v1beta1ClusterEncryptionConfig" } ], "description": "The data encryption settings for the cluster." }, "endpoints": { "allOf": [ { "$ref": "#/definitions/v1beta1ClusterEndpoints" } ], "description": "The connection endpoints for accessing the cluster." }, "highAvailabilityType": { "$ref": "#/definitions/serverlessv1beta1ClusterHighAvailabilityType" }, "labels": { "additionalProperties": { "type": "string" }, "description": "The labels for the cluster.\n\n- `tidb.cloud/organization`: the ID of the organization where the cluster belongs.\n- `tidb.cloud/project`: the ID of the project where the cluster belongs.", "type": "object" }, "name": { "description": "The unique identifier for the TiDB cluster, which is generated by the API and follows the format `clusters/{clusterId}`.", "readOnly": true, "type": "string" }, "region": { "allOf": [ { "$ref": "#/definitions/commonv1beta1Region" } ], "description": "The region where the cluster is deployed." }, "rootPassword": { "description": "The root password of the cluster. It must be between 8 and 64 characters long and can contain letters, numbers, and special characters.", "example": "my-shining-password", "maxLength": 64, "minLength": 8, "pattern": "^.{8,64}$", "type": "string" }, "servicePlan": { "allOf": [ { "$ref": "#/definitions/commonv1beta1ServicePlan" } ], "description": "The plan of the service.\n\n- `Starter`: [TiDB Cloud Starter](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#tidb-cloud-serverless)\n- `Essential`: [TiDB Cloud Essential](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#essential)", "readOnly": true }, "spendingLimit": { "allOf": [ { "$ref": "#/definitions/ClusterSpendingLimit" } ], "description": "The [spending limit](https://docs.pingcap.com/tidbcloud/tidb-cloud-glossary/#spending-limit) for the cluster." }, "state": { "allOf": [ { "$ref": "#/definitions/commonv1beta1ClusterState" } ], "description": "The current state of the cluster.", "readOnly": true }, "updateTime": { "description": "The timestamp when the cluster was last updated, in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "format": "date-time", "readOnly": true, "type": "string" }, "userPrefix": { "description": "The unique prefix automatically generated for SQL usernames on this cluster. TiDB Cloud uses this prefix to distinguish between clusters. For more information, see [User name prefix](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#user-name-prefix).", "readOnly": true, "type": "string" }, "version": { "description": "The TiDB version of the cluster.", "readOnly": true, "type": "string" } }, "required": [ "displayName", "region" ], "type": "object" }, "v1beta1AdvancedModifyDedicatedClusterRequestCluster": { "properties": { "clusterId": { "type": "string" }, "displayName": { "type": "string" }, "tidbNodeSetting": { "$ref": "#/definitions/v1beta1AdvancedModifyDedicatedClusterRequestTidbNodeSetting" }, "tiflashNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting" }, "tikvNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting" } }, "required": [ "clusterId" ], "type": "object" }, "v1beta1AdvancedModifyDedicatedClusterRequestTidbNodeSetting": { "properties": { "createTidbNodeGroups": { "items": { "$ref": "#/definitions/AdvancedModifyDedicatedClusterRequestTidbNodeGroupCreate", "type": "object" }, "type": "array" }, "deleteTidbNodeGroupIds": { "items": { "type": "string" }, "type": "array" }, "nodeSpecKey": { "description": "The homogeneous node spec key for all TiDB nodes in the cluster. If specified, all TiDB nodes across different groups in the cluster will update to the same node spec.", "type": "string" }, "updateTidbNodeGroups": { "items": { "$ref": "#/definitions/AdvancedModifyDedicatedClusterRequestTidbNodeGroupUpdate", "type": "object" }, "type": "array" } }, "type": "object" }, "v1beta1CheckModificationRisksResponse": { "properties": { "risked": { "type": "boolean" }, "risks": { "items": { "$ref": "#/definitions/CheckModificationRisksResponseRisk", "type": "object" }, "type": "array" } }, "type": "object" }, "v1beta1ClusterAuditLogConfig": { "description": "Message for audit log configuration.", "properties": { "enabled": { "description": "Whether audit log is enabled.", "type": "boolean", "x-nullable": true }, "unredacted": { "description": "Whether unredacted the audit log.", "type": "boolean", "x-nullable": true } }, "type": "object" }, "v1beta1ClusterAutoScaling": { "description": "Message for auto scaling configuration.", "properties": { "maxRcu": { "description": "The maximum number of Request Capacity Units (RCUs) for auto-scaling.", "format": "int64", "type": "integer" }, "minRcu": { "description": "The minimum number of Request Capacity Units (RCUs) for auto-scaling.", "format": "int64", "type": "integer" } }, "type": "object" }, "v1beta1ClusterAutomatedBackupPolicy": { "description": "Message for automated backup configuration for a cluster.", "properties": { "retentionDays": { "description": "The number of days to retain automated backups.", "format": "int32", "type": "integer" }, "startTime": { "description": "The UTC time of day in `HH:mm` format when the automated backup starts.", "type": "string" } }, "type": "object" }, "v1beta1ClusterEncryptionConfig": { "description": "Message for encryption settings for a cluster.", "properties": { "enhancedEncryptionEnabled": { "description": "Indicates whether enhanced encryption for cluster data is enabled.", "type": "boolean" } }, "type": "object" }, "v1beta1ClusterEndpoints": { "description": "Message for endpoint information for connecting to a cluster.", "properties": { "private": { "allOf": [ { "$ref": "#/definitions/EndpointsPrivate" } ], "description": "The private endpoint for securely connecting to the cluster. For more information, see [Network](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster-serverless/#network).", "readOnly": true }, "public": { "allOf": [ { "$ref": "#/definitions/EndpointsPublic" } ], "description": "The public endpoint configuration for connecting to the cluster. For more information, see [Network](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster-serverless/#network)." } }, "type": "object" }, "v1beta1ClusterStorageNodeSetting": { "properties": { "nodeChangingProgress": { "allOf": [ { "$ref": "#/definitions/ClusterNodeChangingProgress" } ], "description": "The progress of the node changing.", "readOnly": true, "title": "NodeChangingProgress" }, "nodeCount": { "description": "The number of nodes in the cluster.", "example": 3, "format": "int32", "type": "integer" }, "nodeSpecDisplayName": { "description": "The display name of the node spec. For example, `8 vCPU, 32 GiB`.", "example": "8 vCPU, 32 GiB", "readOnly": true, "type": "string" }, "nodeSpecKey": { "description": "The node spec key of the nodes in the cluster. For example, `8C32G`.", "example": "8C32G", "type": "string" }, "nodeSpecVersion": { "description": "The version tag of the node spec resource. The performance and price of the component may vary based on the version tag.", "example": "v1", "readOnly": true, "type": "string" }, "raftStoreIops": { "description": "The IOPS (input/output operations per second) of the Raft store for the node. If not specified, the default IOPS of Raft store is used. It is recommended to leave it blank to use the default settings for optimal performance.", "example": 3000, "format": "int32", "type": "integer", "x-nullable": true }, "storageSizeGi": { "description": "The storage size of each node in gibibytes (GiB). To view supported storage size ranges, use the [List node specs](#tag/RegionService/operation/RegionService_ListNodeSpecs) or [Get a node spec](#tag/RegionService/operation/RegionService_GetNodeSpec) endpoint.", "example": 500, "format": "int32", "type": "integer" }, "storageType": { "allOf": [ { "$ref": "#/definitions/ClusterStorageNodeSettingStorageType" } ], "description": "The storage type of the node. For more information, see [TiKV node storage types](https://docs.pingcap.com/tidbcloud/size-your-cluster/#tikv-node-storage-types) and [TiFlash node storage types](https://docs.pingcap.com/tidbcloud/size-your-cluster/#tiflash-node-storage-types).", "example": "Standard" } }, "required": [ "nodeCount", "nodeSpecKey", "storageSizeGi" ], "type": "object" }, "v1beta1ClusterTidbNodeSetting": { "properties": { "nodeSpecDisplayName": { "description": "The display name of the node spec. For example, `8 vCPU, 32 GiB`.", "example": "8 vCPU, 32 GiB", "readOnly": true, "type": "string" }, "nodeSpecKey": { "description": "The node spec key of the TiDB nodes in the cluster. For example, `8C32G`. \n\nTo get the node spec available configurations of a specific region for a cloud provider, please refer to [List node specs](#tag/RegionService/operation/RegionService_ListNodeSpecs) API.", "example": "8C32G", "type": "string" }, "nodeSpecVersion": { "description": "The version tag of the node spec resource. The performance and price of the component may vary based on the version tag.", "example": "v1", "readOnly": true, "type": "string" }, "tidbNodeGroups": { "description": "The [TiDB node groups](https://docs.pingcap.com/tidbcloud/tidb-node-group-overview/) in the cluster.\n\nWhen you create a cluster, this array must contain exactly one `TidbNodeGroup` object, and the `nodeCount` field must be set.", "items": { "$ref": "#/definitions/dedicatedv1beta1TidbNodeGroup", "type": "object" }, "title": "TidbNodeGroup", "type": "array" } }, "required": [ "tidbNodeGroups" ], "type": "object" }, "v1beta1RegionCloudProvider": { "description": "Enum of cloud provider names.\n\n - aws: Amazon Web Services.\n - gcp: Google Cloud Platform.\n - azure: Microsoft Azure.\n - alicloud: Alibaba Cloud", "enum": [ "aws", "gcp", "azure", "alicloud" ], "type": "string" }, "v1beta1TidbNodeGroupEndpointConnectionType": { "description": "The connection type for TiDB node group endpoints.\n\n - PUBLIC: Indicates that the endpoint is accessible over the public network.\n - VPC_PEERING: Indicates that the endpoint is accessible over [VPC peering](https://docs.pingcap.com/tidbcloud/tidb-cloud-glossary/#vpc-peering).\n - PRIVATE_ENDPOINT: Indicates that the endpoint is accessible over a private link.", "enum": [ "PUBLIC", "VPC_PEERING", "PRIVATE_ENDPOINT" ], "type": "string" }, "v1beta1UpdateClusterRequestStorageNodeSetting": { "properties": { "nodeCount": { "description": "The number of nodes in the cluster. \nWhen update TiFlash node setting: \n- If the node count is set to 0, the TiFlash node will be removed.\n- If the node count is null, the TiFlash node count won't change.\nFor other components, if the node count is set to 0, server will ignore the node count.", "example": 3, "format": "int32", "type": "integer", "x-nullable": true }, "nodeSpecKey": { "description": "The node spec key of the nodes in the cluster. For example, `8C32G`.", "example": "8C32G", "type": "string" }, "raftStoreIops": { "description": "The IOPS of the raft store for the node. If not set, the default IOPS of raft store will be used.", "example": 3000, "format": "int32", "type": "integer", "x-nullable": true }, "storageSizeGi": { "description": "The storage size of the node in GiB. To get the supported storage size range, please refer to the `NodeSpec` resource.", "example": 500, "format": "int32", "type": "integer" }, "storageType": { "allOf": [ { "$ref": "#/definitions/ClusterStorageNodeSettingStorageType" } ], "description": "The type of storage for the node. Default to `Basic`. For more information, see [TiKV node storage types](https://docs.pingcap.com/tidbcloud/size-your-cluster/#tikv-node-storage-types) and [TiFlash node storage types](https://docs.pingcap.com/tidbcloud/size-your-cluster/#tiflash-node-storage-types).", "example": "Standard" } }, "type": "object" } }, "info": { "description": "TiDB Cloud Console API.", "title": "TiDB Cloud Console API", "version": "v1beta1" }, "paths": { "/api/v2023/clusterManagement/v1beta1/clusters": { "get": { "operationId": "ClusterService_ListClusters", "parameters": [ { "description": "if unspecified, all clusters are returned.", "enum": [ "DEDICATED", "SERVERLESS" ], "in": "query", "name": "clusterType", "required": false, "type": "string" }, { "description": "Only for dedicated clusters.\nIf ture, only clusters annotated with \"tidb.cloud/insufficient-resource\" will be returned.", "in": "query", "name": "onlyResourceInsufficient", "required": false, "type": "boolean" }, { "description": "If specified, only clusters with the specified name will be returned.", "in": "query", "name": "name", "required": false, "type": "string" }, { "description": "The maximum number of clusters to return. The service may return fewer than this value.\nIf unspecified, at most X clusters will be returned.\nThe maximum value is X; values above X will be coerced to X.", "format": "int32", "in": "query", "name": "pageSize", "required": false, "type": "integer" }, { "description": "A page token, received from a previous `ListClusters` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListClusters` must match\nthe call that provided the page token.", "in": "query", "name": "pageToken", "required": false, "type": "string" }, { "description": "The number of individual resources to skip before starting to return results.\nIf the skip value causes the cursor to move past the end of the collection,\nthe response will be 200 OK with an empty result set and no next_page_token.", "format": "int32", "in": "query", "name": "skip", "required": false, "type": "integer" }, { "description": "Organization id", "format": "uint64", "in": "query", "name": "orgId", "required": true, "type": "string" }, { "description": "Project id", "format": "uint64", "in": "query", "name": "projectId", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/bffcluster_managementv1beta1ListClustersResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "tags": [ "ClusterService" ] } }, "/api/v2023/clusterManagement/v1beta1/clusters/{clusterId}": { "get": { "operationId": "ClusterService_GetCluster", "parameters": [ { "in": "path", "name": "clusterId", "required": true, "type": "string" }, { "description": "Organization id", "format": "uint64", "in": "query", "name": "orgId", "required": true, "type": "string" }, { "description": "Project id", "format": "uint64", "in": "query", "name": "projectId", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/bffcluster_managementv1beta1Cluster" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "tags": [ "ClusterService" ] } }, "/api/v2023/clusterManagement/v1beta1/clusters/{clusterId}:checkModificationRisks": { "post": { "operationId": "ClusterService_CheckModificationRisks", "parameters": [ { "in": "path", "name": "clusterId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ClusterServiceCheckModificationRisksBody" } }, { "description": "Organization id", "format": "uint64", "in": "query", "name": "orgId", "required": true, "type": "string" }, { "description": "Project id", "format": "uint64", "in": "query", "name": "projectId", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1CheckModificationRisksResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "summary": "Check if the modification will affect the stability of the cluster", "tags": [ "ClusterService" ] } }, "/api/v2023/clusterManagement/v1beta1/clusters/{clusterId}:dedicatedAdvancedModify": { "post": { "operationId": "ClusterService_AdvancedModifyDedicatedCluster", "parameters": [ { "in": "path", "name": "clusterId", "required": true, "type": "string" }, { "in": "body", "name": "cluster", "required": true, "schema": { "properties": { "displayName": { "type": "string" }, "tidbNodeSetting": { "$ref": "#/definitions/v1beta1AdvancedModifyDedicatedClusterRequestTidbNodeSetting" }, "tiflashNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting" }, "tikvNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting" } }, "required": [ "cluster" ], "type": "object" } }, { "description": "Organization id", "format": "uint64", "in": "query", "name": "orgId", "required": true, "type": "string" }, { "description": "Project id", "format": "uint64", "in": "query", "name": "projectId", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/bffcluster_managementv1beta1Cluster" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "tags": [ "ClusterService" ] } }, "/api/v2023/clusterManagement/v1beta1/clusters:estimatePrice": { "post": { "operationId": "ClusterService_EstimatePrice", "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/cluster_managementv1beta1EstimatePriceRequest" } }, { "description": "Organization id", "format": "uint64", "in": "query", "name": "orgId", "required": true, "type": "string" }, { "description": "Project id", "format": "uint64", "in": "query", "name": "projectId", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/cluster_managementv1beta1EstimatePriceResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "summary": "Estimate the price for the wanted cluster", "tags": [ "ClusterService" ] } } }, "produces": [ "application/json" ], "schemes": [ "https" ], "swagger": "2.0", "tags": [ { "name": "ClusterService" } ] }