// Code generated by swaggo/swag. DO NOT EDIT. package docs import "github.com/swaggo/swag" const docTemplate = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { "description": "{{escape .Description}}", "title": "{{.Title}}", "contact": {}, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/dedicated-clusters/cloud-providers": { "get": { "description": "Fetch info to create dedicated clusters.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "ListDedicatedCloudProviders", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/dedicated.DedicatedCloudProvider" } } } } } }, "/dedicated-clusters/cloud-providers/node-types": { "get": { "description": "This is for fetching info to create cluster.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "ListDedicatedCloudProvidersNodeTypes", "parameters": [ { "type": "string", "description": "Cloud provider types. Choose from: '' (all) | 'aws' | 'gcp' | 'azure' | ... ", "name": "cloud-provider", "in": "query" }, { "type": "string", "description": "Region types. Choose from: '' (all) | 'us-west-2' | ... ", "name": "region", "in": "query" }, { "type": "string", "description": "Instance types: '' (all) | 'tidb' | 'tikv' | 'tiflash' | ... ", "name": "instance-type", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/dedicated.DedicatedCloudProviderNodeType" } } } } } }, "/dedicated-clusters/cloud-providers/regions": { "get": { "description": "Fetches information about cloud provider regions for creating dedicated clusters.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "ListDedicatedCloudProviderRegions", "parameters": [ { "type": "string", "description": "Cloud provider types, choose from: '' (all) | 'aws' | 'gcp' | 'azure' | ... ", "name": "cloud-provider", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/dedicated.DedicatedCloudProviderRegion" } } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters": { "get": { "description": "List all Dedicated Clusters.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "ListDedicatedClusters", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cloud provider types. Choose from: ” (all) | 'aws' | 'gcp' | 'azure' | ...", "name": "cloud-provider", "in": "query" }, { "type": "string", "description": "Region types. Choose from: ” (all) | 'us-west-2' | ...", "name": "region", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/dedicated.DedicatedCluster" } } } } }, "post": { "description": "Create a Dedicated Cluster.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "CreateDedicatedCluster", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "description": "Request body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dedicated.CreateDedicatedClusterRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dedicated.CreateDedicatedClusterResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/cidrs": { "get": { "description": "Retrieves the CIDRs for different providers and regions of a project's dedicated clusters.", "produces": [ "application/json" ], "tags": [ "Network" ], "summary": "GetDedicatedClusterProjectCidrs", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/network.ProjectCidrs" } } } } }, "post": { "description": "Creates a CIDR for a project and provider, with automatic allocation of different CIDRs for different regions.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Network" ], "summary": "CreateDedicatedClusterProjectCidr", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "description": "Request body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/network.ProjectCidrRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/network.StatusResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/private-endpoints": { "get": { "description": "List all Private Endpoints that have been requested to accept (regardless of whether the acceptance is successful or not) in a specific project of an organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Network" ], "summary": "ListDedicatedClusterPrivateEndpoints", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster-id", "in": "query" } ], "responses": { "200": { "description": "Returns the response with the list of Private Endpoints", "schema": { "$ref": "#/definitions/network.ListPrivateEndpointsResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/private-endpoints/{endpoint_id}": { "delete": { "description": "Delete the Private Endpoint connection of a dedicated cluster in a specified project and organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Network" ], "summary": "DeleteDedicatedClusterPrivateEndpoint", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Vpc Endpoint ID", "name": "endpoint_id", "in": "path", "required": true } ], "responses": { "200": { "description": "Returns an empty response if the Private Endpoint connection is deleted successfully" } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/vpc-peerings": { "get": { "description": "List all VPC peerings of a dedicated cluster in a specified project and organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Network" ], "summary": "ListDedicatedClusterVpcPeerings", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true } ], "responses": { "200": { "description": "Returns the response with the list of VPC peerings", "schema": { "$ref": "#/definitions/network.ListVpcPeeringsResponse" } } } }, "post": { "description": "Create a VPC peering connection for a dedicated cluster in a specified project and organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Network" ], "summary": "CreateDedicatedClusterVpcPeering", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "description": "Request body containing the information for creating a VPC peering connection", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/network.CreateVpcPeeringRequest" } } ], "responses": { "200": { "description": "Returns the response with the created VPC peering connection information", "schema": { "$ref": "#/definitions/network.CreateVpcPeeringResponse" } }, "409": { "description": "Returns a conflict response with the existing VPC peering connection information", "schema": { "$ref": "#/definitions/network.CreateVpcPeeringResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/vpc-peerings/{id}": { "delete": { "description": "Deletes a VPC peering connection.", "tags": [ "Network" ], "summary": "DeleteDedicatedClusterVpcPeering", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Peering connection ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK" } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/{cluster_id}": { "get": { "description": "Get detailed information about a Dedicated Cluster.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "GetDedicatedCluster", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dedicated.DedicatedCluster" } } } }, "delete": { "description": "Delete Dedicated Cluster.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "DeleteDedicatedCluster", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dedicated.DeleteDedicatedClusterResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/{cluster_id}/ca-cert-download-url": { "get": { "description": "Get the URL to download the CA certificate of a dedicated cluster.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "GetDedicatedClusterCaCertDownloadUrl", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dedicated.CaCertDownloadUrl" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/{cluster_id}/ip-access-list": { "get": { "description": "Get the list of CIDR addresses that are allowed to connect to the public TiDB address.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "GetDedicatedClusterIPAccessList", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/dedicated.IPAccessListItem" } } } } }, "put": { "description": "Update (overwrite) IP whitelist of a dedicated cluster.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "UpdateDedicatedClusterIPAccessList", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "description": "IP access list", "name": "access_list", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/dedicated.IPAccessRule" } } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dedicated.Status" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/{cluster_id}/pause": { "post": { "description": "Pause a Dedicated Cluster.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "PauseDedicatedCluster", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dedicated.PauseDedicatedClusterResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/{cluster_id}/private-address": { "get": { "description": "Get the private TiDB address within the VPC of a dedicated cluster in a specified project and organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Network" ], "summary": "GetDedicatedClusterPrivateAddress", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "Returns the private TiDB address and port", "schema": { "$ref": "#/definitions/network.GetPrivateAddressResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/{cluster_id}/private-endpoint-services": { "post": { "description": "Create or check the Private Endpoint Service of a dedicated cluster in a specified project and organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Network" ], "summary": "CreateOrCheckDedicatedClusterPrivateEndpointService", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "description": "Create or check the Private Endpoint Service request body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/network.CreatePrivateEndpointServiceRequest" } } ], "responses": { "200": { "description": "Returns the response with the status of the created or checked Private Endpoint Service", "schema": { "$ref": "#/definitions/network.CheckPrivateEndpointServiceResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/{cluster_id}/private-endpoints": { "post": { "description": "Submit the Private Endpoint connection request of a dedicated cluster in a specified project and organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Network" ], "summary": "SubmitDedicatedClusterPrivateEndpoint", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "description": "Submit Private Endpoint request body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/network.SubmitPrivateEndpointRequest" } } ], "responses": { "200": { "description": "Returns the ID of the submitted Private Endpoint", "schema": { "$ref": "#/definitions/network.SubmitPrivateEndpointResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/{cluster_id}/public-address": { "get": { "description": "Get public TiDB address.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "GetDedicatedClusterPublicAddress", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dedicated.PublicAddress" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/{cluster_id}/resume": { "post": { "description": "Resume a Dedicated Cluster.", "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "ResumeDedicatedCluster", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dedicated.ResumeDedicatedClusterResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/dedicated-clusters/{cluster_id}/scale": { "post": { "description": "Scale a Dedicated Cluster.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Dedicated Clusters" ], "summary": "ScaleDedicatedCluster", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "description": "Request body containing the cluster scaling information", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dedicated.ScaleClusterRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dedicated.ScaleClusterResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/operations": { "get": { "description": "List all running LRO operations' status.", "produces": [ "application/json" ], "tags": [ "Long-Running Operations" ], "summary": "ListOperations", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "integer", "description": "Number of pages", "name": "page", "in": "query", "required": true }, { "type": "integer", "description": "Size of a page", "name": "page_size", "in": "query", "required": true }, { "type": "string", "description": "A filter expression that filters resources listed in the response", "name": "filter", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/operation.Operation" } } } } } }, "/orgs/{org_id}/projects/{project_id}/operations/{operation_id}": { "get": { "description": "Get LRO operation status check.", "produces": [ "application/json" ], "tags": [ "Long-Running Operations" ], "summary": "GetOperation", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "LRO ID", "name": "operation_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/operation.OperationResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/serverless": { "get": { "description": "List all Serverless Clusters.", "produces": [ "application/json" ], "tags": [ "Serverless" ], "summary": "ListServerlessClusters", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/serverless.ServerlessCluster" } } } } }, "post": { "description": "Create a Serverless Cluster.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Serverless" ], "summary": "CreateServerlessCluster", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "description": "Request body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/serverless.CreateClusterRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/serverless.CreateClusterResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/serverless/{cluster_id}": { "get": { "description": "Get detailed information about Serverless Cluster.", "produces": [ "application/json" ], "tags": [ "Serverless" ], "summary": "GetServerlessCluster", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/serverless.ServerlessCluster" } } } }, "delete": { "description": "Delete Serverless Cluster.", "produces": [ "application/json" ], "tags": [ "Serverless" ], "summary": "DeleteServerlessCluster", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/serverless.DeleteServerlessClusterResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/serverless/{cluster_id}/public-address": { "get": { "description": "Get public TiDB address.", "produces": [ "application/json" ], "tags": [ "Serverless" ], "summary": "GetServerlessClusterPublicAddress", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/serverless.PublicAddress" } } } } }, "/orgs/{org_id}/projects/{project_id}/serverless/{cluster_id}/spend-limit": { "put": { "description": "Update the Spend Limit of the given Serverless Cluster.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Serverless" ], "summary": "UpdateServerlessClusterSpendLimit", "parameters": [ { "type": "string", "description": "Organization ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "Project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "description": "Spend Limit Update Request", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/serverless.SpendLimitUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/serverless.SpendLimitUpdateResponse" } } } } }, "/serverless/cloud-providers": { "get": { "description": "List the cloud providers that allow the creation of Serverless clusters.", "produces": [ "application/json" ], "tags": [ "Serverless" ], "summary": "ListServerlessCloudProviders", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/serverless.CloudProvider" } } } } } }, "/serverless/cloud-providers/regions": { "get": { "description": "List regions of cloud providers that allow the creation of Serverless clusters.", "produces": [ "application/json" ], "tags": [ "Serverless" ], "summary": "ListServerlessRegions", "parameters": [ { "type": "string", "description": "Cloud provider types - Choose from: '' (all) | 'aws' | 'gcp' | 'azure' | ...", "name": "cloud-provider", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/serverless.CloudRegion" } } } } } } }, "definitions": { "dedicated.CaCertDownloadUrl": { "type": "object", "properties": { "download_url": { "type": "string", "example": "https://tidb-xxx.us-east-1.aws.tidbcloud.com/ca-cert" } } }, "dedicated.CreateDedicatedClusterInstance": { "type": "object", "properties": { "instance_count": { "type": "integer", "example": 3 }, "instance_type": { "type": "string", "example": "tidb" }, "node_storage_size_gi": { "type": "integer", "example": 0 }, "node_type": { "type": "string", "example": "4C8G" } } }, "dedicated.CreateDedicatedClusterRequest": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "cluster_name": { "type": "string", "example": "my-cluster" }, "instances": { "type": "array", "items": { "$ref": "#/definitions/dedicated.CreateDedicatedClusterInstance" } }, "region": { "type": "string", "example": "us-west-2" } } }, "dedicated.CreateDedicatedClusterResponse": { "type": "object", "properties": { "cluster_id": { "type": "string", "example": "123456" }, "cluster_name": { "type": "string", "example": "my-cluster" }, "created_at": { "type": "string", "example": "2022-03-22T20:23:11.285067Z" }, "operation": { "$ref": "#/definitions/operation.Operation" } } }, "dedicated.DedicatedCloudProvider": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "description": { "type": "string", "example": "Amazon Web Services" } } }, "dedicated.DedicatedCloudProviderNodeType": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "description": { "type": "string", "example": "2 vCPU, 4 GiB" }, "instance_type": { "type": "string", "example": "tidb" }, "node_cpu_num": { "type": "integer", "example": 2 }, "node_max_storage_size_gi": { "type": "integer", "example": 0 }, "node_memory_gi": { "type": "integer", "example": 4 }, "node_min_storage_size_gi": { "type": "integer", "example": 0 }, "node_type": { "type": "string", "example": "2C4G" }, "region": { "type": "string", "example": "us-west-2" } } }, "dedicated.DedicatedCloudProviderRegion": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "description": { "type": "string", "example": "US West (Oregon)" }, "region": { "type": "string", "example": "us-west-2" } } }, "dedicated.DedicatedCluster": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "cluster_id": { "type": "string", "example": "123456" }, "cluster_name": { "type": "string", "example": "my-cluster" }, "cluster_version": { "type": "string", "example": "v6.5.0" }, "created_at": { "type": "string", "example": "2022-03-22T20:23:11.285067Z" }, "creator": { "type": "string", "example": "me@pingcap.com" }, "has_set_pwd": { "type": "boolean", "example": true }, "instances": { "type": "array", "items": { "$ref": "#/definitions/dedicated.DedicatedInstance" } }, "region": { "type": "string", "example": "us-west-2" }, "status": { "type": "string", "example": "AVAILABLE" }, "updated_at": { "type": "string", "example": "2022-03-22T20:23:11.285067Z" } } }, "dedicated.DedicatedInstance": { "type": "object", "properties": { "instance_count": { "type": "integer", "example": 3 }, "instance_type": { "type": "string", "example": "tidb" }, "node_storage_size_gi": { "type": "integer", "example": 0 }, "node_type": { "type": "string", "example": "4C8G" } } }, "dedicated.DeleteDedicatedClusterResponse": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "cluster_id": { "type": "string", "example": "123456" }, "cluster_name": { "type": "string", "example": "my-cluster" }, "cluster_version": { "type": "string", "example": "v6.5.0" }, "created_at": { "type": "string", "example": "2022-03-22T20:13:11.285067Z" }, "creator": { "type": "string", "example": "me@pingcap.com" }, "has_set_pwd": { "type": "boolean", "example": true }, "instances": { "type": "array", "items": { "$ref": "#/definitions/dedicated.DedicatedInstance" } }, "operation": { "$ref": "#/definitions/operation.Operation" }, "region": { "type": "string", "example": "us-west-2" }, "status": { "type": "string", "example": "DELETING" }, "updated_at": { "type": "string", "example": "2022-03-22T20:23:11.285067Z" } } }, "dedicated.IPAccessListItem": { "type": "object", "properties": { "cidr": { "type": "string", "example": "0.0.0.0/0" }, "description": { "type": "string", "example": "Allow Access from Anywhere." } } }, "dedicated.IPAccessRule": { "type": "object", "properties": { "cidr": { "type": "string" }, "description": { "type": "string" } } }, "dedicated.PauseDedicatedClusterResponse": { "type": "object", "properties": { "operation": { "$ref": "#/definitions/operation.Operation" } } }, "dedicated.PublicAddress": { "type": "object", "properties": { "port": { "type": "integer", "example": 4000 }, "public_address": { "type": "string", "example": "tidb-xxx.us-east-1.aws.tidbcloud.com" } } }, "dedicated.ResumeDedicatedClusterResponse": { "type": "object", "properties": { "operation": { "$ref": "#/definitions/operation.Operation" } } }, "dedicated.ScaleClusterRequest": { "type": "object", "properties": { "instances": { "type": "array", "items": { "$ref": "#/definitions/dedicated.DedicatedInstance" } } } }, "dedicated.ScaleClusterResponse": { "type": "object", "properties": { "operation": { "$ref": "#/definitions/operation.Operation" } } }, "dedicated.Status": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } } }, "network.AWSPrivateEndpointInfo": { "type": "object", "properties": { "cluster_id": { "type": "string", "example": "1373933076661807113" }, "cluster_name": { "type": "string", "example": "yifan-test-keep-2h" }, "id": { "type": "integer", "example": 1 }, "region_name": { "type": "string", "example": "Oregon (us-west-2)" }, "service_name": { "type": "string", "example": "com.amazonaws.vpce.us-west-2.vpce-svc-0b3cd45936052c59e" }, "service_status": { "type": "string", "example": "ACTIVE" }, "status": { "type": "string", "example": "FAILED" }, "status_message": { "type": "string", "example": "The Vpc Endpoint Id 'vpce-09b49c676e8715bf0' does not exist" }, "vpc_endpoint_id": { "type": "string", "example": "vpce-09b49c676e8715bf0" } } }, "network.AWSPrivateEndpointServiceInfo": { "type": "object", "properties": { "dns_name": { "type": "string", "example": "privatelink-tidb.odxhbtnq69f.clusters.staging.tidb-cloud.com" }, "id": { "type": "integer", "example": 1 }, "port": { "type": "integer", "example": 4000 }, "region_name": { "type": "string", "example": "Oregon (us-west-2)" }, "service_name": { "type": "string", "example": "com.amazonaws.vpce.us-west-2.vpce-svc-0b3cd45936052c59e" }, "service_status": { "type": "string", "example": "ACTIVE" } } }, "network.AWSVpcPeeringInfo": { "type": "object", "properties": { "customer_region": { "type": "string", "example": "Oregon (us-west-2)" }, "customer_vpc_cidr": { "type": "string", "example": "172.31.0.0/16" }, "customer_vpc_id": { "type": "string", "example": "vpc-085f890400d64cd0a" }, "id": { "type": "integer", "example": 1 }, "peering_connection_id": { "type": "string", "example": "pcx-0b440980960d6526f" }, "status": { "type": "string", "example": "pending" } } }, "network.CheckPrivateEndpointServiceResponse": { "type": "object", "properties": { "aws": { "$ref": "#/definitions/network.AWSPrivateEndpointServiceInfo" }, "gcp": { "$ref": "#/definitions/network.GCPPrivateEndpointServiceInfo" } } }, "network.CreateAWSPeeringRequest": { "type": "object", "properties": { "account_id": { "type": "string", "example": "552185537300" }, "region": { "type": "string", "example": "us-west-2" }, "vpc_cidr": { "type": "string", "example": "172.31.0.0/16" }, "vpc_id": { "type": "string", "example": "vpc-085f890400d64cd0a" } } }, "network.CreateGCPPeeringRequest": { "type": "object", "properties": { "network_cidr": { "type": "string", "example": "172.31.0.0/16" }, "network_name": { "type": "string", "example": "gcp-network-name" }, "project_id": { "type": "string", "example": "gcp-project-id" }, "region": { "type": "string", "example": "us-west1" }, "zone": { "type": "string", "example": "us-west1-a" } } }, "network.CreatePrivateEndpointServiceRequest": { "type": "object", "properties": { "provider": { "type": "string", "example": "aws" } } }, "network.CreateVpcPeeringRequest": { "type": "object", "properties": { "aws": { "$ref": "#/definitions/network.CreateAWSPeeringRequest" }, "gcp": { "$ref": "#/definitions/network.CreateGCPPeeringRequest" } } }, "network.CreateVpcPeeringResponse": { "type": "object", "properties": { "aws": { "$ref": "#/definitions/network.CreatedAWSPeeringResponse" }, "gcp": { "$ref": "#/definitions/network.CreatedGCPPeeringResponse" } } }, "network.CreatedAWSPeeringResponse": { "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "peering_connection_id": { "type": "string", "example": "pcx-0b440980960d6526f" } } }, "network.CreatedGCPPeeringResponse": { "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "tidb_cloud_network_name": { "type": "string", "example": "shoot--staging--a1ae7733" }, "tidb_cloud_project_id": { "type": "string", "example": "pingcap-gardener" }, "tidb_cloud_region_name": { "type": "string", "example": " Oregon (us-west1)" }, "tidb_cloud_vpc_cidr": { "type": "string", "example": "172.30.168.0/21" } } }, "network.GCPPrivateEndpointInfo": { "type": "object", "properties": { "cluster_id": { "type": "string", "example": "1373933076661807113" }, "cluster_name": { "type": "string", "example": "yifan-test-keep-2h" }, "connection_id": { "type": "string", "example": "10498320298297858" }, "connection_name": { "type": "string", "example": "promethues-enpoint-a-80b7345b-m" }, "id": { "type": "integer", "example": 1 }, "region_name": { "type": "string", "example": "us-west2" }, "service_attachment_name": { "type": "string", "example": "vpce-09b49c676e8715bf0" }, "service_status": { "type": "string", "example": "ACTIVE" }, "status": { "type": "string", "example": "FAILED" }, "status_message": { "type": "string", "example": "The Vpc Endpoint Id 'vpce-09b49c676e8715bf0' does not exist" } } }, "network.GCPPrivateEndpointServiceInfo": { "type": "object", "properties": { "dns_name": { "type": "string", "example": "privatelink-tidb.odxhbtnq69f.clusters.staging.tidb-cloud.com" }, "id": { "type": "integer", "example": 1 }, "port": { "type": "integer", "example": 4000 }, "region_name": { "type": "string", "example": "us-west2" }, "service_name": { "type": "string", "example": "com.google.vpcendpoints.tidb-cloud.com" }, "service_status": { "type": "string", "example": "ACTIVE" } } }, "network.GCPVpcPeeringInfo": { "type": "object", "properties": { "customer_network_name": { "type": "string", "example": "yifan-test" }, "customer_project_id": { "type": "string", "example": "gcp-autonomous-dev" }, "customer_region": { "type": "string", "example": " Oregon (us-west1)" }, "customer_vpc_cidr": { "type": "string", "example": "10.128.0.0/20" }, "id": { "type": "integer", "example": 1 }, "peering_connection_name": { "type": "string", "example": "gcp-us-west1-yifan-test-networkpeer" }, "status": { "type": "string", "example": "pending" }, "tidb_cloud_network_name": { "type": "string", "example": "shoot--staging--a1ae7733" }, "tidb_cloud_project_id": { "type": "string", "example": "pingcap-gardener" }, "tidb_cloud_region": { "type": "string", "example": " Oregon (us-west1)" }, "tidb_cloud_vpc_cidr": { "type": "string", "example": "172.30.168.0/21" } } }, "network.GetPrivateAddressResponse": { "type": "object", "properties": { "port": { "type": "integer", "example": 4000 }, "private_address": { "type": "string", "example": "tidb-xxx.us-east-1.aws.tidbcloud.com" } } }, "network.ListPrivateEndpointsResponse": { "type": "object", "properties": { "aws": { "type": "array", "items": { "$ref": "#/definitions/network.AWSPrivateEndpointInfo" } }, "gcp": { "type": "array", "items": { "$ref": "#/definitions/network.GCPPrivateEndpointInfo" } } } }, "network.ListVpcPeeringsResponse": { "type": "object", "properties": { "aws": { "type": "array", "items": { "$ref": "#/definitions/network.AWSVpcPeeringInfo" } }, "gcp": { "type": "array", "items": { "$ref": "#/definitions/network.GCPVpcPeeringInfo" } } } }, "network.ProjectCidrRequest": { "type": "object", "properties": { "cidr": { "type": "string", "example": "172.30.0.0/16" }, "provider": { "type": "string", "example": "gcp" } } }, "network.ProjectCidrs": { "type": "object", "properties": { "cidr": { "type": "string", "example": "10.250.0.0/16" }, "provider": { "type": "string", "example": "aws" }, "regions": { "type": "array", "items": { "type": "object", "properties": { "cidr": { "type": "string", "example": "10.250.24.0/21" }, "region": { "type": "string", "example": "us-west-2" }, "region_name": { "type": "string", "example": "Oregon (us-west-2)" } } } } } }, "network.StatusResponse": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } } }, "network.SubmitPrivateEndpointRequest": { "type": "object", "properties": { "endpoint_id": { "type": "string", "example": "projects/gcp-autonomous-prod/regions/us-west1/serviceAttachments/o11y-prod-nginx-nlb-a" }, "provider": { "type": "string", "example": "gcp" } } }, "network.SubmitPrivateEndpointResponse": { "type": "object", "properties": { "id": { "type": "integer", "example": 1 } } }, "operation.Error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "operation.Operation": { "type": "object", "properties": { "created_at": { "type": "string", "example": "2022-03-22T20:13:11.285067Z" }, "ended_at": { "type": "string", "example": "2022-03-22T20:33:11.285067Z" }, "error": { "$ref": "#/definitions/operation.Error" }, "id": { "type": "integer", "example": 123456 }, "progress": { "type": "integer", "example": 100 }, "started_at": { "type": "string", "example": "2022-03-22T20:23:11.285067Z" }, "status": { "type": "string", "example": "DONE" }, "status_message": { "type": "string", "example": "" }, "user": { "type": "string", "example": "user@example.com" } } }, "operation.OperationResponse": { "type": "object", "properties": { "operation": { "$ref": "#/definitions/operation.Operation" } } }, "serverless.CloudProvider": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "description": { "type": "string", "example": "Amazon Web Services" } } }, "serverless.CloudRegion": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "description": { "type": "string", "example": "US West (Oregon)" }, "region": { "type": "string", "example": "us-west-2" } } }, "serverless.CreateClusterRequest": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "cluster_name": { "type": "string", "example": "my-cluster" }, "region": { "type": "string", "example": "us-west-2" }, "spend_limit": { "type": "integer", "example": 0 } } }, "serverless.CreateClusterResponse": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "cluster_id": { "type": "string", "example": "123456" }, "cluster_name": { "type": "string", "example": "my-cluster" }, "cluster_status": { "type": "string", "example": "AVAILABLE" }, "cluster_version": { "type": "string", "example": "v6.1.0" }, "created_at": { "type": "string", "example": "2022-03-22T20:23:11.285067Z" }, "creator": { "type": "string", "example": "me@pingcap.com" }, "free_credits": { "type": "number", "example": 113.86 }, "operation": { "$ref": "#/definitions/operation.Operation" }, "region": { "type": "string", "example": "us-east-1" }, "root_password_set": { "type": "boolean", "example": true }, "spend_limit": { "type": "integer", "example": 1000 }, "updated_at": { "type": "string", "example": "2022-03-22T20:23:11.285067Z" } } }, "serverless.DeleteServerlessClusterResponse": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "cluster_id": { "type": "string", "example": "123456" }, "cluster_name": { "type": "string", "example": "my-cluster" }, "cluster_status": { "type": "string", "example": "AVAILABLE" }, "cluster_version": { "type": "string", "example": "v6.1.0" }, "created_at": { "type": "string", "example": "2022-03-22T20:23:11.285067Z" }, "creator": { "type": "string", "example": "me@pingcap.com" }, "free_credits": { "type": "number", "example": 113.86 }, "operation": { "$ref": "#/definitions/operation.Operation" }, "region": { "type": "string", "example": "us-east-1" }, "root_password_set": { "type": "boolean", "example": true }, "spend_limit": { "type": "integer", "example": 1000 }, "updated_at": { "type": "string", "example": "2022-03-22T20:23:11.285067Z" } } }, "serverless.PublicAddress": { "type": "object", "properties": { "port": { "type": "integer", "example": 4000 }, "public_address": { "type": "string", "example": "tidb-xxx.us-east-1.aws.tidbcloud.com" } } }, "serverless.ServerlessCluster": { "type": "object", "properties": { "cloud_provider": { "type": "string", "example": "aws" }, "cluster_id": { "type": "string", "example": "123456" }, "cluster_name": { "type": "string", "example": "my-cluster" }, "cluster_status": { "type": "string", "example": "AVAILABLE" }, "cluster_version": { "type": "string", "example": "v6.1.0" }, "created_at": { "type": "string", "example": "2022-03-22T20:23:11.285067Z" }, "creator": { "type": "string", "example": "me@pingcap.com" }, "free_credits": { "type": "number", "example": 113.86 }, "region": { "type": "string", "example": "us-east-1" }, "root_password_set": { "type": "boolean", "example": true }, "spend_limit": { "type": "integer", "example": 1000 }, "updated_at": { "type": "string", "example": "2022-03-22T20:23:11.285067Z" } } }, "serverless.SpendLimitUpdateRequest": { "type": "object", "properties": { "spend_limit": { "type": "integer", "example": 1000 } } }, "serverless.SpendLimitUpdateResponse": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } } } } }` // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = &swag.Spec{ Version: "1.0", Host: "", BasePath: "/api/v1", Schemes: []string{}, Title: "TiDB Cloud API", Description: "This API provides a set of endpoints to manage and interact with TiDB Cloud services, including clusters and other related resources.", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, } func init() { swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) }