{ "swagger": "2.0", "info": { "title": "TiDB Cloud Dedicated Open API", "description": "TiDB Cloud Dedicated Open API.", "version": "v1beta1" }, "tags": [ { "name": "ClusterService" }, { "name": "RegionService" }, { "name": "TidbNodeGroupService" }, { "name": "PrivateEndpointConnectionService" }, { "name": "NetworkContainerService" }, { "name": "MaintenanceService" } ], "host": "dedicated.tidbapi.com", "basePath": "/api/v2023//dedicated/v1beta1", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/api/v2023/dedicated/v1beta1/clusters": { "get": { "summary": "List clusters", "operationId": "ClusterService_ListClusters", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1ListClustersResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "regionIds", "description": "If specified, only clusters in the specified regions will be returned.", "in": "query", "required": false, "type": "array" }, { "name": "clusterStates", "description": "If specified, only clusters in the specified states will be returned.\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" }, { "name": "pageSize", "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.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageToken", "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", "required": false, "type": "string" }, { "name": "skip", "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.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ClusterService" ] }, "post": { "summary": "Create a cluster", "operationId": "ClusterService_CreateCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "cluster", "in": "body", "required": true, "schema": { "$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster" } }, { "name": "validateOnly", "description": "if validate_only is true, the request will be validated but not executed.", "in": "query", "required": false, "type": "boolean" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ClusterService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}": { "delete": { "summary": "Delete a cluster", "operationId": "ClusterService_DeleteCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "validateOnly", "description": "if validate_only is true, the request will be validated but not executed.", "in": "query", "required": false, "type": "boolean" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ClusterService" ] }, "get": { "summary": "Get a cluster", "operationId": "ClusterService_GetCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ClusterService" ] }, "patch": { "summary": "Update a cluster", "operationId": "ClusterService_UpdateCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "cluster", "in": "body", "required": true, "schema": { "type": "object", "properties": { "displayName": { "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "The project_id key cannot be updated. If the project_id key is specified, it will be ignored.", "type": "object" }, "tidbNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestTidbNodeSetting" }, "tiflashNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting" }, "tikvNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting" } } } }, { "name": "validateOnly", "description": "if validate_only is true, the request will be validated but not executed.", "in": "query", "required": false, "type": "boolean" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ClusterService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}/nodeInstances": { "get": { "summary": "List node instances", "operationId": "ClusterService_ListNodeInstances", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1ListNodeInstancesResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "componentType", "description": "If specified, only node instances of the specified component type will be returned.", "in": "query", "required": false, "type": "string", "enum": [ "TIKV", "TIDB", "TIFLASH", "PD", "TIPROXY" ] }, { "name": "pageSize", "description": "The maximum number of node instances to return. The service may return fewer than this value.\nIf unspecified, at most X node instances will be returned.\nThe maximum value is X; values above X will be coerced to X.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageToken", "description": "A page token, received from a previous `ListNodeInstances` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListNodeInstances` must match\nthe call that provided the page token.", "in": "query", "required": false, "type": "string" }, { "name": "skip", "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.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ClusterService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}/nodeInstances/{instanceId}": { "get": { "summary": "Get a node instance", "operationId": "ClusterService_GetNodeInstance", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1NodeInstance" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ClusterService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}/tidbNodeGroups": { "get": { "summary": "List TiDB Node Groups", "operationId": "TidbNodeGroupService_ListTidbNodeGroups", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1ListTidbNodeGroupsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "pageSize", "description": "The maximum number of TiDB groups to return. The service may return fewer than this value.\nIf unspecified, at most X TiDB groups will be returned.\nThe maximum value is X; values above X will be coerced to X.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageToken", "description": "A page token, received from a previous `ListTidbNodeGroups` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListTidbNodeGroups` must match\nthe call that provided the page token.", "in": "query", "required": false, "type": "string" }, { "name": "skip", "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.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "TidbNodeGroupService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}/tidbNodeGroups/{privateEndpointConnection.tidbNodeGroupId}/privateEndpointConnections": { "post": { "summary": "Create a private endpoint connection", "operationId": "PrivateEndpointConnectionService_CreatePrivateEndpointConnection", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "privateEndpointConnection.tidbNodeGroupId", "in": "path", "required": true, "type": "string" }, { "name": "privateEndpointConnection", "in": "body", "required": true, "schema": { "type": "object", "properties": { "accountId": { "description": "Only for GCP private service connections. It's GCP project name.", "readOnly": true, "type": "string", "x-nullable": true }, "cloudProvider": { "allOf": [ { "$ref": "#/definitions/v1beta1RegionCloudProvider" } ], "readOnly": true }, "clusterDisplayName": { "readOnly": true, "type": "string" }, "clusterId": { "readOnly": true, "type": "string" }, "endpointId": { "description": "The endpoint ID of the private link connection.\nFor AWS, it's VPC endpoint ID.\nFor GCP, it's private service connect endpoint ID.\nFor Azure, it's private endpoint resource ID.", "type": "string" }, "endpointState": { "allOf": [ { "$ref": "#/definitions/PrivateEndpointConnectionEndpointState" } ], "readOnly": true }, "host": { "readOnly": true, "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "The labels of private link connection. It always contains the `project_id` label.", "readOnly": true, "type": "object" }, "massage": { "readOnly": true, "type": "string" }, "name": { "readOnly": true, "title": "Format: tidbNodeGroups/{tidb_node_group_id}/privateEndpointConnections/{private_endpoint_connection_id}", "type": "string" }, "port": { "format": "int32", "readOnly": true, "type": "integer" }, "privateEndpointConnectionId": { "readOnly": true, "type": "string" }, "privateIpAddress": { "description": "The private IP address of the private endpoint in the user's vNet.\nTiDB Cloud will setup a public DNS record for this private IP address. So the user can use DNS address to connect to the cluster.\nOnly available for Azure clusters.", "type": "string", "x-nullable": true }, "privateLinkServiceName": { "readOnly": true, "type": "string" }, "privateLinkServiceState": { "allOf": [ { "$ref": "#/definitions/v1beta1PrivateLinkServiceState" } ], "readOnly": true }, "regionDisplayName": { "readOnly": true, "type": "string" }, "regionId": { "readOnly": true, "title": "Format: {cloud_provider}-{region_code}", "type": "string" }, "tidbNodeGroupDisplayName": { "readOnly": true, "type": "string" } } } }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "PrivateEndpointConnectionService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}/tidbNodeGroups/{publicEndpointSetting.tidbNodeGroupId}/publicEndpointSetting": { "patch": { "summary": "Update the public endpoint setting of a TiDB Node Group", "operationId": "TidbNodeGroupService_UpdatePublicEndpointSetting", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1PublicEndpointSetting" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "publicEndpointSetting.tidbNodeGroupId", "description": "If set to \"-\", the default TiDB group will be used.", "in": "path", "required": true, "type": "string" }, { "name": "publicEndpointSetting", "in": "body", "required": true, "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "x-nullable": true }, "ipAccessList": { "items": { "$ref": "#/definitions/dedicatedv1beta1PublicEndpointSettingIpAccessList", "type": "object" }, "type": "array" }, "name": { "readOnly": true, "title": "Format: tidbNodeGroups/{tidb_node_group_id}/publicEndpointSetting", "type": "string" } } } }, { "name": "validateOnly", "description": "if validate_only is true, the request will be validated but not executed.", "in": "query", "required": false, "type": "boolean" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "TidbNodeGroupService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}": { "delete": { "summary": "Delete a TiDB Node Group", "operationId": "TidbNodeGroupService_DeleteTidbNodeGroup", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "tidbNodeGroupId", "in": "path", "required": true, "type": "string" }, { "name": "validateOnly", "description": "if validate_only is true, the request will be validated but not executed.", "in": "query", "required": false, "type": "boolean" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "TidbNodeGroupService" ] }, "get": { "summary": "Get a TiDB Node Group", "operationId": "TidbNodeGroupService_GetTidbNodeGroup", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1TidbNodeGroup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "tidbNodeGroupId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "TidbNodeGroupService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections": { "get": { "summary": "List private endpoint connections", "operationId": "PrivateEndpointConnectionService_ListPrivateEndpointConnections", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1ListPrivateEndpointConnectionsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "description": "To list private link connections across different clusters and TiDB groups, set cluster_id to \"-\".", "in": "path", "required": true, "type": "string" }, { "name": "tidbNodeGroupId", "description": "To list private link connections across different clusters and TiDB groups, set tidb_node_group_id to \"-\".", "in": "path", "required": true, "type": "string" }, { "name": "cloudProvider", "description": "If specified, only private link connections of the specified cloud provider will be returned.\n\n - aws: Amazon Web Services.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE\n - gcp: Google Cloud Platform.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE\n - azure: Microsoft Azure.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE", "in": "query", "required": false, "type": "string", "enum": [ "aws", "gcp", "azure" ] }, { "name": "pageSize", "description": "The maximum number of private link connections to return. The service may return fewer than this value.\nIf unspecified, at most X private link connections will be returned.\nThe maximum value is X; values above X will be coerced to X.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageToken", "description": "A page token, received from a previous `ListPrivateLinkConnections` call.\nProvide this to retrieve the subsequent page.", "in": "query", "required": false, "type": "string" }, { "name": "skip", "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.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "PrivateEndpointConnectionService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections/{privateEndpointConnectionId}": { "delete": { "summary": "Delete a private endpoint connection", "operationId": "PrivateEndpointConnectionService_DeletePrivateEndpointConnection", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "tidbNodeGroupId", "in": "path", "required": true, "type": "string" }, { "name": "privateEndpointConnectionId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "PrivateEndpointConnectionService" ] }, "get": { "summary": "Get a private endpoint connection", "operationId": "PrivateEndpointConnectionService_GetPrivateEndpointConnection", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "tidbNodeGroupId", "in": "path", "required": true, "type": "string" }, { "name": "privateEndpointConnectionId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "PrivateEndpointConnectionService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateLinkService": { "get": { "summary": "Get the private link service of a TiDB Node Group", "operationId": "PrivateEndpointConnectionService_GetPrivateLinkService", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1PrivateLinkService" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "tidbNodeGroupId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "PrivateEndpointConnectionService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/publicEndpointSetting": { "get": { "summary": "Get the public endpoint setting of a TiDB Node Group", "operationId": "TidbNodeGroupService_GetPublicEndpointSetting", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1PublicEndpointSetting" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "tidbNodeGroupId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "TidbNodeGroupService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}:pauseCluster": { "post": { "summary": "Pause a cluster", "operationId": "ClusterService_PauseCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1PauseClusterResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ClusterService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}:resetRootPassword": { "post": { "summary": "Reset the root password of a cluster", "operationId": "ClusterService_ResetRootPassword", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1ResetRootPasswordResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ClusterServiceResetRootPasswordBody" } }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ClusterService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{clusterId}:resumeCluster": { "post": { "summary": "Resume a cluster", "operationId": "ClusterService_ResumeCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1ResumeClusterResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ClusterService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{tidbNodeGroup.clusterId}/tidbNodeGroups": { "post": { "summary": "Create a TiDB Node Group", "operationId": "TidbNodeGroupService_CreateTidbNodeGroup", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1TidbNodeGroup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "tidbNodeGroup.clusterId", "description": "The cluster ID of the TiDB group.\nOptional when creating cluster with the default TiDB group.\nRequired when creating non-default TiDB group.", "in": "path", "required": true, "type": "string" }, { "name": "tidbNodeGroup", "in": "body", "required": true, "schema": { "type": "object", "properties": { "displayName": { "description": "The display name of the TiDB group.", "type": "string" }, "endpoints": { "items": { "$ref": "#/definitions/TidbNodeGroupEndpoint", "type": "object" }, "readOnly": true, "type": "array" }, "isDefaultGroup": { "readOnly": true, "type": "boolean" }, "name": { "readOnly": true, "title": "Format: tidbNodeGroups/{tidb_node_group_id}", "type": "string" }, "nodeChangingProgress": { "allOf": [ { "$ref": "#/definitions/ClusterNodeChangingProgress" } ], "readOnly": true }, "nodeCount": { "description": "The number of TiDB nodes in the TiDB group.", "format": "int32", "type": "integer" }, "nodeSpecDisplayName": { "readOnly": true, "type": "string" }, "nodeSpecKey": { "readOnly": true, "type": "string" }, "state": { "allOf": [ { "$ref": "#/definitions/v1beta1TidbNodeGroupState" } ], "readOnly": true }, "tidbNodeGroupId": { "description": "The unique ID of the TiDB group.", "readOnly": true, "type": "string" } } } }, { "name": "validateOnly", "description": "if validate_only is true, the request will be validated but not executed.", "in": "query", "required": false, "type": "boolean" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "TidbNodeGroupService" ] } }, "/api/v2023/dedicated/v1beta1/clusters/{tidbNodeGroup.clusterId}/tidbNodeGroups/{tidbNodeGroup.tidbNodeGroupId}": { "patch": { "summary": "Update a TiDB Node Group", "operationId": "TidbNodeGroupService_UpdateTidbNodeGroup", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1TidbNodeGroup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "tidbNodeGroup.clusterId", "in": "path", "required": true, "type": "string" }, { "name": "tidbNodeGroup.tidbNodeGroupId", "in": "path", "required": true, "type": "string" }, { "name": "tidbNodeGroup", "in": "body", "required": true, "schema": { "type": "object", "properties": { "displayName": { "type": "string" }, "nodeCount": { "format": "int32", "type": "integer" } } } }, { "name": "validateOnly", "description": "if validate_only is true, the request will be validated but not executed.", "in": "query", "required": false, "type": "boolean" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "TidbNodeGroupService" ] } }, "/api/v2023/dedicated/v1beta1/clusters:showNodeQuota": { "get": { "summary": "Show node quota across the caller's organization", "operationId": "ClusterService_ShowNodeQuota", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1ShowNodeQuotaResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ClusterService" ] } }, "/api/v2023/dedicated/v1beta1/maintenanceTasks": { "get": { "summary": "List maintenance tasks", "operationId": "MaintenanceService_ListMaintenanceTasks", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1ListMaintenanceTasksResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "pageSize", "description": "The maximum number of maintenance tasks to return. The service may return fewer than this value.\nIf unspecified, at most X maintenance tasks will be returned.\nThe maximum value is X; values above X will be coerced to X.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageToken", "description": "A page token, received from a previous `ListMaintenanceTasks` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListMaintenanceTasks` must match\nthe call that provided the page token.", "in": "query", "required": false, "type": "string" }, { "name": "skip", "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.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "MaintenanceService" ] } }, "/api/v2023/dedicated/v1beta1/maintenanceTasks/{maintenanceTaskId}": { "get": { "summary": "Get a maintenance task", "operationId": "MaintenanceService_GetMaintenanceTask", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1MaintenanceTask" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "maintenanceTaskId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "MaintenanceService" ] } }, "/api/v2023/dedicated/v1beta1/maintenanceTasks/{maintenanceTaskId}:deferMaintenanceTask": { "post": { "summary": "Defer a maintenance task", "operationId": "MaintenanceService_DeferMaintenanceTask", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1DeferMaintenanceTaskResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "maintenanceTaskId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "MaintenanceService" ] } }, "/api/v2023/dedicated/v1beta1/maintenanceWindows": { "get": { "summary": "List maintenance windows", "operationId": "MaintenanceService_ListMaintenanceWindows", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1ListMaintenanceWindowsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "pageSize", "description": "The maximum number of maintenance windows to return. The service may return fewer than this value.\nIf unspecified, at most X maintenance windows will be returned.\nThe maximum value is X; values above X will be coerced to X.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageToken", "description": "A page token, received from a previous `ListMaintenanceWindows` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListMaintenanceWindows` must match\nthe call that provided the page token.", "in": "query", "required": false, "type": "string" }, { "name": "skip", "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.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "MaintenanceService" ] } }, "/api/v2023/dedicated/v1beta1/maintenanceWindows/{maintenanceWindow.maintenanceWindowId}": { "patch": { "summary": "Update a maintenance window", "operationId": "MaintenanceService_UpdateMaintenanceWindow", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1MaintenanceWindow" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "maintenanceWindow.maintenanceWindowId", "description": "Format: project-{project_id}", "in": "path", "required": true, "type": "string" }, { "name": "maintenanceWindow", "in": "body", "required": true, "schema": { "type": "object", "properties": { "dayHour": { "format": "int32", "type": "integer" }, "hourMinute": { "format": "int32", "type": "integer" }, "weekDay": { "format": "int32", "type": "integer" } } } }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "MaintenanceService" ] } }, "/api/v2023/dedicated/v1beta1/maintenanceWindows/{maintenanceWindowId}": { "get": { "summary": "Get a maintenance window", "operationId": "MaintenanceService_GetMaintenanceWindow", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1MaintenanceWindow" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "maintenanceWindowId", "description": "Format: project-{project_id}", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "MaintenanceService" ] } }, "/api/v2023/dedicated/v1beta1/networkContainers": { "get": { "summary": "List network containers", "operationId": "NetworkContainerService_ListNetworkContainers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1ListNetworkContainersResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "cloudProvider", "description": " - aws: Amazon Web Services.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE\n - gcp: Google Cloud Platform.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE\n - azure: Microsoft Azure.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE", "in": "query", "required": false, "type": "string", "enum": [ "aws", "gcp", "azure" ] }, { "name": "pageSize", "description": "The maximum number of network containers to return. The service may return fewer than this value.\nIf unspecified, at most X network containers will be returned.\nThe maximum value is X; values above X will be coerced to X.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageToken", "description": "A page token, received from a previous `ListNetworkContainers` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListNetworkContainers` must match\nthe call that provided the page token.", "in": "query", "required": false, "type": "string" }, { "name": "skip", "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.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "NetworkContainerService" ] }, "post": { "summary": "Create a network container", "operationId": "NetworkContainerService_CreateNetworkContainer", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1NetworkContainer" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "networkContainer", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1beta1NetworkContainer" } }, { "name": "validateOnly", "in": "query", "required": false, "type": "boolean" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "NetworkContainerService" ] } }, "/api/v2023/dedicated/v1beta1/networkContainers/{networkContainerId}": { "delete": { "summary": "Delete a network container", "operationId": "NetworkContainerService_DeleteNetworkContainer", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "networkContainerId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "NetworkContainerService" ] }, "get": { "summary": "Get a network container", "operationId": "NetworkContainerService_GetNetworkContainer", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1NetworkContainer" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "networkContainerId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "NetworkContainerService" ] } }, "/api/v2023/dedicated/v1beta1/regions": { "get": { "summary": "List regions for creating a cluster", "operationId": "RegionService_ListRegions", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1ListRegionsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "cloudProvider", "description": "If specified, only regions of the specified cloud provider will be returned.", "in": "query", "required": false, "type": "string" }, { "name": "pageSize", "description": "The maximum number of regions to return. The service may return fewer than this value.\nIf unspecified, at most X regions will be returned.\nThe maximum value is X; values above X will be coerced to X.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageToken", "description": "A page token, received from a previous `ListRegions` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListRegions` must match\nthe call that provided the page token.", "in": "query", "required": false, "type": "string" }, { "name": "skip", "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.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "RegionService" ] } }, "/api/v2023/dedicated/v1beta1/regions/{regionId}": { "get": { "summary": "Get a region", "operationId": "RegionService_GetRegion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/commonv1beta1Region" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "regionId", "description": "Format: {cloud_provider}-{region_code}", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "RegionService" ] } }, "/api/v2023/dedicated/v1beta1/regions/{regionId}/componentTypes/{componentType}/nodeSpecs/{nodeSpecKey}": { "get": { "summary": "Get a node spec", "operationId": "RegionService_GetNodeSpec", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1NodeSpec" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "regionId", "description": "Format: {cloud_provider}-{region_code}", "in": "path", "required": true, "type": "string" }, { "name": "componentType", "in": "path", "required": true, "type": "string", "enum": [ "TIKV", "TIDB", "TIFLASH", "PD", "TIPROXY" ] }, { "name": "nodeSpecKey", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "RegionService" ] } }, "/api/v2023/dedicated/v1beta1/regions/{regionId}/nodeSpecs": { "get": { "summary": "List node specs for creating or scaling a cluster", "operationId": "RegionService_ListNodeSpecs", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1ListNodeSpecsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "regionId", "description": "Format: {cloud_provider}-{region_code}", "in": "path", "required": true, "type": "string" }, { "name": "componentType", "description": "If specified, only node specs of the specified component type will be returned.", "in": "query", "required": false, "type": "string", "enum": [ "TIKV", "TIDB", "TIFLASH", "PD", "TIPROXY" ] }, { "name": "pageSize", "description": "The maximum number of node specs to return. The service may return fewer than this value.\nIf unspecified, at most X node specs will be returned.\nThe maximum value is X; values above X will be coerced to X.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageToken", "description": "A page token, received from a previous `ListNodeSpecs` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListNodeSpecs` must match\nthe call that provided the page token.", "in": "query", "required": false, "type": "string" }, { "name": "skip", "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.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "RegionService" ] } }, "/api/v2023/dedicated/v1beta1/regions:showCloudProviders": { "get": { "summary": "Show cloud providers for creating a cluster", "operationId": "RegionService_ShowCloudProviders", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1beta1ShowCloudProvidersResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "RegionService" ] } }, "/api/v2023/dedicated/v1beta1/vpcPeerings": { "get": { "summary": "List VPC peerings", "operationId": "NetworkContainerService_ListVpcPeerings", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1ListVpcPeeringsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "cloudProvider", "description": "If specified, only VPC peerings of the specified cloud provider will be returned.\n\n - aws: Amazon Web Services.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE\n - gcp: Google Cloud Platform.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE\n - azure: Microsoft Azure.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE", "in": "query", "required": false, "type": "string", "enum": [ "aws", "gcp", "azure" ] }, { "name": "pageSize", "description": "The maximum number of VPC peerings to return. The service may return fewer than this value.\nIf unspecified, at most X VPC peerings will be returned.\nThe maximum value is X; values above X will be coerced to X.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageToken", "description": "A page token, received from a previous `ListVpcPeerings` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListVpcPeerings` must match\nthe call that provided the page token.", "in": "query", "required": false, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "NetworkContainerService" ] }, "post": { "summary": "Create a VPC peering", "operationId": "NetworkContainerService_CreateVpcPeering", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1VpcPeering" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "vpcPeering", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dedicatedv1beta1VpcPeering" } }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "NetworkContainerService" ] } }, "/api/v2023/dedicated/v1beta1/vpcPeerings/{vpcPeeringId}": { "delete": { "summary": "Delete a VPC peering", "operationId": "NetworkContainerService_DeleteVpcPeering", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "vpcPeeringId", "description": "Format {cloud_provider}-{random_suffix}", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "NetworkContainerService" ] }, "get": { "summary": "Get a VPC peering", "operationId": "NetworkContainerService_GetVpcPeering", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/dedicatedv1beta1VpcPeering" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "vpcPeeringId", "description": "Format {cloud_provider}-{random_suffix}", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "NetworkContainerService" ] } } }, "definitions": { "ClusterNodeChangingProgress": { "properties": { "matchingNodeSpecNodeCount": { "format": "int32", "readOnly": true, "type": "integer" }, "remainingDeletionNodeCount": { "description": "available if some nodes are deleting.", "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "ClusterServiceResetRootPasswordBody": { "properties": { "rootPassword": { "type": "string" } }, "required": [ "rootPassword" ], "type": "object" }, "ClusterStorageNodeSettingStorageType": { "enum": [ "BASIC", "BASICV2", "OPTIMIZED", "PLUS" ], "title": "- BASIC: default\n - BASICV2: separate raft-log and data storage, only for tikv\n - OPTIMIZED: separate raft-log and data storage, and use high performance storage volume for raft-log, only for tikv\n - PLUS: use high performance storage volume", "type": "string" }, "EndpointConnectionType": { "description": " - PUBLIC: The endpoint is a public endpoint.\n - VPC_PEERING: The endpoint is a VPC peering endpoint.\n - PRIVATE_ENDPOINT: The endpoint is a private link endpoint.", "enum": [ "PUBLIC", "VPC_PEERING", "PRIVATE_ENDPOINT" ], "type": "string" }, "PrivateEndpointConnectionEndpointState": { "enum": [ "PENDING", "ACTIVE", "DELETING", "FAILED" ], "type": "string" }, "ShowNodeQuotaResponseComponentQuota": { "properties": { "componentType": { "$ref": "#/definitions/dedicatedv1beta1ComponentType" }, "quota": { "format": "int32", "type": "integer" } }, "type": "object" }, "TidbNodeGroupEndpoint": { "properties": { "connectionType": { "allOf": [ { "$ref": "#/definitions/EndpointConnectionType" } ], "readOnly": true }, "host": { "description": "When endpoint's type is `PRIVATE_ENDPOINT`, the `host` field behave differently across cloud providers:\nFor AWS clusters, the `host` field is available right after the private link service is ready.\nFor GCP and Azure clusters, the `host` field is available after the user creates a `PrivateEndpointConnection`.", "readOnly": true, "type": "string" }, "port": { "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "UpdateClusterRequestTidbNodeSettingTidbNodeGroup": { "properties": { "nodeCount": { "format": "int32", "type": "integer" }, "tidbNodeGroupId": { "title": "if tidb_node_group_id is empty, it means scale default tidb group", "type": "string" } }, "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 for the region.", "readOnly": true }, "displayName": { "description": "User-friendly display name of the region.", "readOnly": true, "type": "string" }, "name": { "example": "regions/aws-us-west-2", "pattern": "^regions/(aws|gcp|azure)-(.+)$", "title": "The unique name of the region.\nFormat: regions/{region_id}", "type": "string" }, "provider": { "description": "Optional provider name for the region.\nOnly used for serverless cluster.\nDeprecated.", "readOnly": true, "type": "string", "x-nullable": true }, "regionId": { "description": "Format: {cloud_provider}-{region_code}\nRegion code: us-west-2, asia-east1.", "readOnly": true, "type": "string" } }, "type": "object" }, "dedicatedv1beta1ClusterPausePlan": { "properties": { "pauseType": { "$ref": "#/definitions/dedicatedv1beta1ClusterPausePlanType" }, "scheduledResumeTime": { "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" }, "dedicatedv1beta1ListVpcPeeringsResponse": { "properties": { "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 VPC peerings that matched the query.", "format": "int32", "type": "integer" }, "vpcPeerings": { "items": { "$ref": "#/definitions/dedicatedv1beta1VpcPeering", "type": "object" }, "type": "array" } }, "type": "object" }, "dedicatedv1beta1MaintenanceWindow": { "description": "MaintenanceWindow is a singleton resource that represents the maintenance window under a project.", "properties": { "dayHour": { "description": "0-23 in UTC.", "format": "int32", "type": "integer" }, "hourMinute": { "description": "0-59 in UTC.", "format": "int32", "type": "integer" }, "maintenanceWindowId": { "readOnly": true, "title": "Format: project-{project_id}", "type": "string" }, "name": { "readOnly": true, "title": "Format: maintenanceWindows/{maintenance_window_id}", "type": "string" }, "nextMaintenanceDate": { "format": "date-time", "readOnly": true, "type": "string" }, "projectId": { "type": "string" }, "unchangedMaintenanceTasks": { "items": { "$ref": "#/definitions/v1beta1MaintenanceTask", "type": "object" }, "readOnly": true, "type": "array" }, "weekDay": { "description": "0-6, 0 is Sunday.", "format": "int32", "type": "integer" } }, "required": [ "projectId", "weekDay", "dayHour", "hourMinute" ], "type": "object" }, "dedicatedv1beta1NodeSpec": { "properties": { "componentType": { "allOf": [ { "$ref": "#/definitions/dedicatedv1beta1ComponentType" } ], "readOnly": true }, "defaultNodeCount": { "format": "int32", "readOnly": true, "type": "integer" }, "defaultStorageSizeGi": { "format": "int32", "readOnly": true, "type": "integer" }, "displayName": { "readOnly": true, "type": "string" }, "maxStorageSizeGi": { "format": "int32", "readOnly": true, "type": "integer" }, "memorySizeGi": { "format": "int32", "readOnly": true, "type": "integer" }, "minStorageSizeGi": { "format": "int32", "readOnly": true, "type": "integer" }, "name": { "readOnly": true, "title": "Format: regions/{region_id}/componentTypes/{component_type}/nodeSpecs/{node_spec_key}", "type": "string" }, "nodeSpecKey": { "readOnly": true, "type": "string" }, "regionId": { "readOnly": true, "title": "Format: {cloud_provider}-{region_code}", "type": "string" }, "storageTypes": { "items": { "$ref": "#/definitions/ClusterStorageNodeSettingStorageType" }, "readOnly": true, "type": "array" }, "vCpu": { "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "dedicatedv1beta1PauseClusterResponse": { "type": "object" }, "dedicatedv1beta1PrivateLinkService": { "properties": { "availableZones": { "description": "Only available for AWS.\nSame as the `AvailabilityZones` field in response body of\n`github.com/aws/aws-sdk-go-v2/service/ec2.DescribeVpcEndpointServices` method.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "cloudProvider": { "allOf": [ { "$ref": "#/definitions/v1beta1RegionCloudProvider" } ], "readOnly": true }, "name": { "readOnly": true, "title": "Format: tidbNodeGroups/{tidb_node_group_id}/privateLinkService", "type": "string" }, "regionDisplayName": { "readOnly": true, "type": "string" }, "regionId": { "readOnly": true, "title": "Format: {cloud_provider}-{region_code}", "type": "string" }, "serviceDnsName": { "description": "For AWS, it's the fully qualified domain name (FQDN) shared for all private endpoints, despite which VPC the endpoint located in.\nFor GCP, it's the zone name (suffix of FQDN) shared for all private endpoints located in a single VPC network. The format of FQDN is `\u003cendpoint_name\u003e.\u003cservice_dns_name\u003e`.\nFor Azure, it's the zone name shared across public internet. The format of FQDN is `\u003cendpoint_name\u003e-\u003crandom_hash\u003e.\u003cservice_dns_name\u003e`.", "readOnly": true, "type": "string" }, "serviceName": { "description": "For AWS, it's the service name of the Private Link Service.\nFor GCP, it's the resource name of the service attachment.\nFor Azure, it's service resource ID of the Private Link Service.", "readOnly": true, "type": "string" }, "state": { "allOf": [ { "$ref": "#/definitions/v1beta1PrivateLinkServiceState" } ], "readOnly": true }, "tidbNodeGroupId": { "readOnly": true, "type": "string" } }, "type": "object" }, "dedicatedv1beta1PublicEndpointSetting": { "properties": { "enabled": { "type": "boolean", "x-nullable": true }, "ipAccessList": { "items": { "$ref": "#/definitions/dedicatedv1beta1PublicEndpointSettingIpAccessList", "type": "object" }, "type": "array" }, "name": { "readOnly": true, "title": "Format: tidbNodeGroups/{tidb_node_group_id}/publicEndpointSetting", "type": "string" }, "tidbNodeGroupId": { "description": "If set to \"-\", the default TiDB group will be used.", "type": "string" } }, "required": [ "tidbNodeGroupId" ], "type": "object" }, "dedicatedv1beta1PublicEndpointSettingIpAccessList": { "properties": { "cidrNotation": { "type": "string" }, "description": { "type": "string" } }, "required": [ "cidrNotation" ], "type": "object" }, "dedicatedv1beta1ResumeClusterResponse": { "type": "object" }, "dedicatedv1beta1TidbNodeGroup": { "properties": { "clusterId": { "description": "The cluster ID of the TiDB group.\nOptional when creating cluster with the default TiDB group.\nRequired when creating non-default TiDB group.", "type": "string" }, "displayName": { "description": "The display name of the TiDB group.", "type": "string" }, "endpoints": { "items": { "$ref": "#/definitions/TidbNodeGroupEndpoint", "type": "object" }, "readOnly": true, "type": "array" }, "isDefaultGroup": { "readOnly": true, "type": "boolean" }, "name": { "readOnly": true, "title": "Format: tidbNodeGroups/{tidb_node_group_id}", "type": "string" }, "nodeChangingProgress": { "allOf": [ { "$ref": "#/definitions/ClusterNodeChangingProgress" } ], "readOnly": true }, "nodeCount": { "description": "The number of TiDB nodes in the TiDB group.", "format": "int32", "type": "integer" }, "nodeSpecDisplayName": { "readOnly": true, "type": "string" }, "nodeSpecKey": { "readOnly": true, "type": "string" }, "state": { "allOf": [ { "$ref": "#/definitions/v1beta1TidbNodeGroupState" } ], "readOnly": true }, "tidbNodeGroupId": { "description": "The unique ID of the TiDB group.", "readOnly": true, "type": "string" } }, "required": [ "nodeCount" ], "type": "object" }, "dedicatedv1beta1VpcPeering": { "properties": { "awsVpcPeeringConnectionId": { "description": "Only for AWS vpc peerings.", "readOnly": true, "type": "string", "x-nullable": true }, "customerAccountId": { "description": "In AWS, it is the account ID.\nIn GCP, it is the project name.", "type": "string" }, "customerRegionId": { "description": "Format: {cloud_provider}-{region_code}\nFor AWS, it's required.\nFor GCP, it's optional. Since GCP does not require region_id when creating VPC peering.", "type": "string" }, "customerVpcCidr": { "type": "string" }, "customerVpcId": { "description": "In AWS, it is the VPC ID.\nIn GCP, it is the network name.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "The labels of the vpc peering. It always contains the `project_id` label.", "readOnly": true, "type": "object" }, "name": { "readOnly": true, "title": "Format: vpcPeerings/{vpc_peering_id}", "type": "string" }, "state": { "allOf": [ { "$ref": "#/definitions/dedicatedv1beta1VpcPeeringState" } ], "readOnly": true }, "tidbCloudAccountId": { "description": "In AWS, it is the account ID.\nIn GCP, it is the project name.", "readOnly": true, "type": "string" }, "tidbCloudCloudProvider": { "allOf": [ { "$ref": "#/definitions/v1beta1RegionCloudProvider" } ], "readOnly": true }, "tidbCloudRegionId": { "title": "Format: {cloud_provider}-{region_code}", "type": "string" }, "tidbCloudVpcCidr": { "readOnly": true, "type": "string" }, "tidbCloudVpcId": { "description": "In AWS, it is the VPC ID.\nIn GCP, it is the network name.", "readOnly": true, "type": "string" }, "vpcPeeringId": { "readOnly": true, "title": "Format {cloud_provider}-{random_suffix}", "type": "string" } }, "required": [ "tidbCloudRegionId", "customerAccountId", "customerVpcId", "customerVpcCidr" ], "type": "object" }, "dedicatedv1beta1VpcPeeringState": { "enum": [ "PENDING", "FAILED", "ACTIVE" ], "type": "string" }, "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" }, "tidb_cloud_open_apidedicatedv1beta1Cluster": { "description": "Cluster represents a dedicated TiDB cluster.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "OUTPUT_ONLY. The annotations for the cluster.\ntidb.cloud/has-set-password. The annotation for whether the cluster has set password.\ntidb.cloud/available-features. The annotation for the available features of the cluster.", "readOnly": true, "type": "object" }, "cloudProvider": { "allOf": [ { "$ref": "#/definitions/v1beta1RegionCloudProvider" } ], "readOnly": true }, "clusterId": { "description": "The unique ID of the cluster.", "readOnly": true, "type": "string" }, "createTime": { "description": "Timestamp when the cluster was created.", "format": "date-time", "readOnly": true, "type": "string" }, "createdBy": { "description": "The email address or public api key of the creator of the cluster.", "readOnly": true, "type": "string" }, "displayName": { "description": "The display 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": "The labels of the cluster.\nIf there is no \"project_id\" in labels, resource should be in the default project of the creator's organization.", "type": "object" }, "name": { "readOnly": true, "title": "The name of TiDB cluster resource.\nFormat: clusters/{cluster_id}", "type": "string" }, "pausePlan": { "allOf": [ { "$ref": "#/definitions/dedicatedv1beta1ClusterPausePlan" } ], "description": "Pause plan of the cluster.", "readOnly": true }, "port": { "description": "The port of the cluster. This port applies to all network endpoints of the cluster.", "format": "int32", "type": "integer" }, "regionDisplayName": { "readOnly": true, "type": "string" }, "regionId": { "title": "Required. Region where the cluster will be created.\nFormat: {cloud_provider}-{region_code}", "type": "string" }, "rootPassword": { "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.", "readOnly": true }, "tidbNodeSetting": { "$ref": "#/definitions/v1beta1ClusterTidbNodeSetting" }, "tiflashNodeSetting": { "$ref": "#/definitions/v1beta1ClusterStorageNodeSetting" }, "tikvNodeSetting": { "$ref": "#/definitions/v1beta1ClusterStorageNodeSetting" }, "updateTime": { "description": "Timestamp when the cluster was last updated.", "format": "date-time", "readOnly": true, "type": "string" }, "version": { "description": "The TiDB version of the cluster.", "readOnly": true, "type": "string" } }, "required": [ "displayName", "regionId", "tidbNodeSetting", "tikvNodeSetting", "port" ], "type": "object" }, "tidb_cloud_open_apidedicatedv1beta1ListClustersResponse": { "properties": { "clusters": { "items": { "$ref": "#/definitions/tidb_cloud_open_apidedicatedv1beta1Cluster", "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" }, "tidb_cloud_open_apidedicatedv1beta1ListRegionsResponse": { "properties": { "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" }, "regions": { "items": { "$ref": "#/definitions/commonv1beta1Region", "type": "object" }, "type": "array" }, "totalSize": { "description": "The total number of regions that matched the query.", "format": "int32", "type": "integer" } }, "type": "object" }, "v1beta1ClusterStorageNodeSetting": { "properties": { "nodeChangingProgress": { "allOf": [ { "$ref": "#/definitions/ClusterNodeChangingProgress" } ], "readOnly": true }, "nodeCount": { "format": "int32", "type": "integer" }, "nodeSpecDisplayName": { "readOnly": true, "title": "output only", "type": "string" }, "nodeSpecKey": { "type": "string" }, "storageSizeGi": { "format": "int32", "type": "integer" }, "storageType": { "$ref": "#/definitions/ClusterStorageNodeSettingStorageType" } }, "required": [ "nodeCount", "nodeSpecKey", "storageSizeGi", "storageType" ], "type": "object" }, "v1beta1ClusterTidbNodeSetting": { "properties": { "nodeSpecDisplayName": { "readOnly": true, "type": "string" }, "nodeSpecKey": { "type": "string" }, "tidbNodeGroups": { "description": "When creating a cluster, the length of the `tidb_node_groups` should be 1\nand the `node_count` field of `TidbNodeGroup` should be set.", "items": { "$ref": "#/definitions/dedicatedv1beta1TidbNodeGroup", "type": "object" }, "type": "array" } }, "required": [ "nodeSpecKey" ], "type": "object" }, "v1beta1DeferMaintenanceTaskResponse": { "type": "object" }, "v1beta1ListMaintenanceTasksResponse": { "properties": { "maintenanceTasks": { "items": { "$ref": "#/definitions/v1beta1MaintenanceTask", "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 maintenance tasks that matched the query.", "format": "int32", "type": "integer" } }, "type": "object" }, "v1beta1ListMaintenanceWindowsResponse": { "properties": { "maintenanceWindows": { "items": { "$ref": "#/definitions/dedicatedv1beta1MaintenanceWindow", "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 maintenance windows that matched the query.", "format": "int32", "type": "integer" } }, "type": "object" }, "v1beta1ListNetworkContainersResponse": { "properties": { "networkContainers": { "items": { "$ref": "#/definitions/v1beta1NetworkContainer", "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 network containers that matched the query.", "format": "int32", "type": "integer" } }, "type": "object" }, "v1beta1ListNodeInstancesResponse": { "properties": { "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" }, "nodeInstances": { "items": { "$ref": "#/definitions/v1beta1NodeInstance", "type": "object" }, "type": "array" }, "totalSize": { "description": "The total number of node instances that matched the query.", "format": "int32", "type": "integer" } }, "type": "object" }, "v1beta1ListNodeSpecsResponse": { "properties": { "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" }, "nodeSpecs": { "items": { "$ref": "#/definitions/dedicatedv1beta1NodeSpec", "type": "object" }, "type": "array" }, "totalSize": { "description": "The total number of node specs that matched the query.", "format": "int32", "type": "integer" } }, "type": "object" }, "v1beta1ListPrivateEndpointConnectionsResponse": { "properties": { "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" }, "privateEndpointConnections": { "items": { "$ref": "#/definitions/v1beta1PrivateEndpointConnection", "type": "object" }, "type": "array" }, "totalSize": { "description": "The total number of private link connections that matched the query.", "format": "int32", "type": "integer" } }, "type": "object" }, "v1beta1ListTidbNodeGroupsResponse": { "properties": { "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" }, "tidbNodeGroups": { "items": { "$ref": "#/definitions/dedicatedv1beta1TidbNodeGroup", "type": "object" }, "type": "array" }, "totalSize": { "description": "The total number of TiDB groups that matched the query.", "format": "int32", "type": "integer" } }, "type": "object" }, "v1beta1MaintenanceTask": { "properties": { "createTime": { "description": "Timestamp when the task was created.", "format": "date-time", "readOnly": true, "type": "string" }, "deadline": { "description": "Timestamp when the task will be expired.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "readOnly": true, "type": "string" }, "maintenanceTaskId": { "readOnly": true, "type": "string" }, "name": { "readOnly": true, "title": "Format: maintenanceTasks/{maintenance_task_id}", "type": "string" }, "projectId": { "readOnly": true, "type": "string" }, "scheduledApplyTime": { "description": "Timestamp when the task run.", "format": "date-time", "readOnly": true, "type": "string" }, "state": { "allOf": [ { "$ref": "#/definitions/v1beta1MaintenanceTaskState" } ], "readOnly": true } }, "type": "object" }, "v1beta1MaintenanceTaskState": { "enum": [ "PENDING", "RUNNING", "DONE" ], "type": "string" }, "v1beta1NetworkContainer": { "properties": { "cidrNotion": { "type": "string" }, "cloudProvider": { "allOf": [ { "$ref": "#/definitions/v1beta1RegionCloudProvider" } ], "readOnly": true }, "labels": { "additionalProperties": { "type": "string" }, "description": "The labels of the cluster.\nIf there is no \"project_id\" in labels, resource should be in the default project of the creator's organization.", "type": "object" }, "name": { "readOnly": true, "title": "Format: networkContainers/{network_container_id}", "type": "string" }, "networkContainerId": { "readOnly": true, "type": "string" }, "regionId": { "title": "Format: {cloud_provider}-{region_code}", "type": "string" }, "state": { "allOf": [ { "$ref": "#/definitions/v1beta1NetworkContainerState" } ], "readOnly": true } }, "required": [ "regionId", "cidrNotion" ], "type": "object" }, "v1beta1NetworkContainerState": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string" }, "v1beta1NodeInstance": { "properties": { "availabilityZone": { "description": "the availability zone of the instance, e.g. \"us-west1-a\".", "readOnly": true, "type": "string" }, "clusterId": { "readOnly": true, "type": "string" }, "componentType": { "allOf": [ { "$ref": "#/definitions/dedicatedv1beta1ComponentType" } ], "readOnly": true }, "instanceId": { "readOnly": true, "title": "Format for TiDB instances in the default TiDB group: tidb-{index}\nFormat for TiDB instances in non-default TiDB groups: tidb-{index}-{tidb_group_name}\nFormat for other instances: {component_type}-{index}", "type": "string" }, "isDefaultTidbNodeGroup": { "readOnly": true, "type": "boolean", "x-nullable": true }, "memorySizeGi": { "description": "the memory size of the instance, e.g. 8.", "format": "int32", "readOnly": true, "type": "integer" }, "name": { "readOnly": true, "title": "Format: clusters/{cluster_id}/nodeInstances/{instance_id}", "type": "string" }, "state": { "allOf": [ { "$ref": "#/definitions/v1beta1NodeInstanceState" } ], "description": "the state of the instance, e.g. \"Available\".", "readOnly": true }, "storageSizeGi": { "description": "the storage size of the instance, e.g. 100.", "format": "int32", "readOnly": true, "type": "integer" }, "tidbNodeGroupDisplayName": { "readOnly": true, "type": "string", "x-nullable": true }, "tidbNodeGroupId": { "readOnly": true, "type": "string", "x-nullable": true }, "vCpu": { "description": "the cpu size of the instance, e.g. 2.", "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "v1beta1NodeInstanceState": { "enum": [ "CREATING", "AVAILABLE", "DELETING", "UNAVAILABLE" ], "type": "string" }, "v1beta1PrivateEndpointConnection": { "properties": { "accountId": { "description": "Only for GCP private service connections. It's GCP project name.", "readOnly": true, "type": "string", "x-nullable": true }, "cloudProvider": { "allOf": [ { "$ref": "#/definitions/v1beta1RegionCloudProvider" } ], "readOnly": true }, "clusterDisplayName": { "readOnly": true, "type": "string" }, "clusterId": { "readOnly": true, "type": "string" }, "endpointId": { "description": "The endpoint ID of the private link connection.\nFor AWS, it's VPC endpoint ID.\nFor GCP, it's private service connect endpoint ID.\nFor Azure, it's private endpoint resource ID.", "type": "string" }, "endpointState": { "allOf": [ { "$ref": "#/definitions/PrivateEndpointConnectionEndpointState" } ], "readOnly": true }, "host": { "readOnly": true, "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "The labels of private link connection. It always contains the `project_id` label.", "readOnly": true, "type": "object" }, "massage": { "readOnly": true, "type": "string" }, "name": { "readOnly": true, "title": "Format: tidbNodeGroups/{tidb_node_group_id}/privateEndpointConnections/{private_endpoint_connection_id}", "type": "string" }, "port": { "format": "int32", "readOnly": true, "type": "integer" }, "privateEndpointConnectionId": { "readOnly": true, "type": "string" }, "privateIpAddress": { "description": "The private IP address of the private endpoint in the user's vNet.\nTiDB Cloud will setup a public DNS record for this private IP address. So the user can use DNS address to connect to the cluster.\nOnly available for Azure clusters.", "type": "string", "x-nullable": true }, "privateLinkServiceName": { "readOnly": true, "type": "string" }, "privateLinkServiceState": { "allOf": [ { "$ref": "#/definitions/v1beta1PrivateLinkServiceState" } ], "readOnly": true }, "regionDisplayName": { "readOnly": true, "type": "string" }, "regionId": { "readOnly": true, "title": "Format: {cloud_provider}-{region_code}", "type": "string" }, "tidbNodeGroupDisplayName": { "readOnly": true, "type": "string" }, "tidbNodeGroupId": { "type": "string" } }, "required": [ "tidbNodeGroupId", "endpointId" ], "type": "object" }, "v1beta1PrivateLinkServiceState": { "enum": [ "CREATING", "ACTIVE", "DELETING" ], "type": "string" }, "v1beta1RegionCloudProvider": { "description": "Enum of cloud provider names.\n\n - aws: Amazon Web Services.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE\n - gcp: Google Cloud Platform.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE\n - azure: Microsoft Azure.\nbuf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE", "enum": [ "aws", "gcp", "azure" ], "type": "string" }, "v1beta1ResetRootPasswordResponse": { "type": "object" }, "v1beta1ShowCloudProvidersResponse": { "properties": { "cloudProviders": { "items": { "$ref": "#/definitions/v1beta1RegionCloudProvider" }, "type": "array" } }, "type": "object" }, "v1beta1ShowNodeQuotaResponse": { "properties": { "componentQuotas": { "items": { "$ref": "#/definitions/ShowNodeQuotaResponseComponentQuota", "type": "object" }, "type": "array" } }, "type": "object" }, "v1beta1TidbNodeGroupState": { "description": " - ACTIVE: All nodes are ready.\n - MODIFYING: When TiDB group is modifying.\n - PAUSED: When cluster is paused.", "enum": [ "ACTIVE", "MODIFYING", "PAUSED" ], "type": "string" }, "v1beta1UpdateClusterRequestCluster": { "properties": { "clusterId": { "type": "string" }, "displayName": { "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "The project_id key cannot be updated. If the project_id key is specified, it will be ignored.", "type": "object" }, "tidbNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestTidbNodeSetting" }, "tiflashNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting" }, "tikvNodeSetting": { "$ref": "#/definitions/v1beta1UpdateClusterRequestStorageNodeSetting" } }, "required": [ "clusterId" ], "type": "object" }, "v1beta1UpdateClusterRequestStorageNodeSetting": { "properties": { "nodeCount": { "description": "When 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.", "format": "int32", "type": "integer", "x-nullable": true }, "nodeSpecKey": { "type": "string" }, "storageSizeGi": { "format": "int32", "type": "integer" } }, "type": "object" }, "v1beta1UpdateClusterRequestTidbNodeSetting": { "properties": { "nodeSpecKey": { "type": "string" }, "tidbNodeGroups": { "items": { "$ref": "#/definitions/UpdateClusterRequestTidbNodeSettingTidbNodeGroup", "type": "object" }, "type": "array" } }, "type": "object" }, "v1beta1UpdateMaintenanceWindowRequestMaintenanceWindow": { "properties": { "dayHour": { "format": "int32", "type": "integer" }, "hourMinute": { "format": "int32", "type": "integer" }, "maintenanceWindowId": { "title": "Format: project-{project_id}", "type": "string" }, "weekDay": { "format": "int32", "type": "integer" } }, "required": [ "maintenanceWindowId" ], "type": "object" }, "v1beta1UpdateTidbNodeGroupRequestTidbNodeGroup": { "properties": { "clusterId": { "type": "string" }, "displayName": { "type": "string" }, "nodeCount": { "format": "int32", "type": "integer" }, "tidbNodeGroupId": { "type": "string" } }, "required": [ "clusterId", "tidbNodeGroupId" ], "type": "object" } } }