{ "swagger": "2.0", "info": { "description": "Clinic Data Proxy and diagnostic service APIs.", "title": "Clinic Data Service API", "contact": {}, "version": "1.0" }, "basePath": "/", "paths": { "/api/v1/orgs/{orgId}/data-proxy/clusters/{clusterId}/ticdc/changefeeds": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "ticdc" ], "summary": "List TiCDC changefeeds", "parameters": [ { "type": "integer", "description": "TiDB Cloud org ID", "name": "orgId", "in": "path", "required": true }, { "type": "integer", "description": "TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ticdc.ListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/api/v1/orgs/{orgId}/data-proxy/clusters/{clusterId}/ticdc/changefeeds/{changefeedId}": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "ticdc" ], "summary": "Get TiCDC changefeed", "parameters": [ { "type": "integer", "description": "TiDB Cloud org ID", "name": "orgId", "in": "path", "required": true }, { "type": "integer", "description": "TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "string", "description": "Changefeed ID", "name": "changefeedId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ticdc.DetailResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/capabilities": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy" ], "summary": "Get Data Proxy capabilities", "operationId": "canonical-get-capabilities", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DataProxyCapabilitiesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/clusters/{clusterId}": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "cluster-metadata" ], "summary": "Get cluster metadata by cluster ID", "parameters": [ { "type": "string", "description": "Opaque TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/clustercontext.Cluster" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "cluster-metadata" ], "summary": "List clusters in a TiDB Cloud org", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "maximum": 1000000, "minimum": 1, "type": "integer", "default": 1, "description": "1-based page", "name": "page", "in": "query" }, { "maximum": 200, "minimum": 1, "type": "integer", "default": 50, "description": "Page size, max 200", "name": "pageSize", "in": "query" }, { "type": "string", "description": "Cluster ID or name contains", "name": "query", "in": "query" }, { "type": "boolean", "default": false, "description": "Include deleted clusters", "name": "showDeleted", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/clustercontext.Page" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "cluster-metadata" ], "summary": "Get org-scoped cluster metadata", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Opaque TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/clustercontext.Cluster" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/activities": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "activity-events" ], "summary": "List cluster activity events", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Opaque TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true }, { "minimum": 0, "type": "integer", "description": "Inclusive window start in Unix seconds", "name": "begin_ts", "in": "query", "required": true }, { "minimum": 0, "type": "integer", "description": "Inclusive window end in Unix seconds", "name": "end_ts", "in": "query", "required": true }, { "type": "string", "description": "Activity catalog", "name": "catalog", "in": "query" }, { "type": "string", "description": "Activity type", "name": "type", "in": "query" }, { "type": "string", "description": "Activity name", "name": "name", "in": "query" }, { "maximum": 8, "minimum": -4, "type": "integer", "default": 0, "description": "Minimum severity", "name": "severity", "in": "query" }, { "maximum": 100, "minimum": 20, "type": "integer", "default": 20, "description": "Page size", "name": "limit", "in": "query" }, { "type": "string", "description": "Opaque ActivityHub pagination cursor", "name": "cursor", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/clinic_internal_api.ActivitiesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/components": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "topology" ], "summary": "List cluster components", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Opaque TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/clinic_internal_api.ResourcePoolComponent" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/continuous-profiling/group-profiles": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-continuous-profiling" ], "summary": "List physical BYOC Continuous Profiling groups", "operationId": "canonical-byoc-continuous-profiling-group-profiles", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true }, { "maximum": 253402300799, "minimum": 1, "type": "integer", "description": "Inclusive window start in positive Unix seconds; O11y rounds down to the minute", "name": "begin_time", "in": "query", "required": true }, { "maximum": 253402300799, "minimum": 1, "type": "integer", "description": "Inclusive window end in positive Unix seconds; minute-rounded span is at most 3 hours", "name": "end_time", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/handlers.byocContinuousProfilingGroupProfile" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/continuous-profiling/group-profiles/{ts}": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Returns JSON null with HTTP 200 when O11y has no group for the requested timestamp.", "produces": [ "application/json" ], "tags": [ "data-proxy-continuous-profiling" ], "summary": "Get a physical BYOC Continuous Profiling group", "operationId": "canonical-byoc-continuous-profiling-group-profile-detail", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true }, { "maximum": 253402300799, "minimum": 1, "type": "integer", "description": "Profiling group timestamp in positive Unix seconds", "name": "ts", "in": "path", "required": true } ], "responses": { "200": { "description": "Group detail, or JSON null when no group exists", "schema": { "$ref": "#/definitions/handlers.byocContinuousProfilingGroupProfileDetail" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/health-check/reports": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "health-check-reports" ], "summary": "List Health Check reports", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Opaque TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true }, { "maximum": 1000000, "minimum": 1, "type": "integer", "default": 1, "description": "One-based page number", "name": "page", "in": "query" }, { "maximum": 100, "minimum": 1, "type": "integer", "default": 20, "description": "Page size", "name": "pageSize", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Report status; repeat to select multiple values", "name": "status", "in": "query" }, { "type": "string", "description": "Inclusive report creation time in RFC3339", "name": "createdFrom", "in": "query" }, { "type": "string", "description": "Inclusive report creation time in RFC3339", "name": "createdTo", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/clinic_internal_api.HealthCheckReportPage" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/health-check/reports/{reportId}": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "health-check-reports" ], "summary": "Get a Health Check report", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Opaque TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "string", "description": "Health Check report ID", "name": "reportId", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Report item name; repeat to fetch a subset", "name": "itemName", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/clinic_internal_api.HealthCheckReport" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/logs/labels": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-logs" ], "summary": "List cluster log labels", "operationId": "canonical-logs-labels", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "clusterId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/logs/labels/{name}/values": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-logs" ], "summary": "List cluster log label values", "operationId": "canonical-logs-label-values", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "string", "description": "Loki label name", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/logs/query-range": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-logs" ], "summary": "Execute a cluster log range query", "operationId": "canonical-logs-query-range", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "string", "description": "LogQL expression", "name": "query", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/logs/series": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-logs" ], "summary": "List matching cluster log streams", "operationId": "canonical-logs-series", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "LogQL stream selectors", "name": "match[]", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/metrics/query": { "get": { "security": [ { "BearerAuth": [] } ], "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "data-proxy-metrics" ], "summary": "Execute a cluster instant metrics query", "operationId": "canonical-metrics-query-get", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "string", "description": "PromQL expression", "name": "query", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } } } }, "post": { "security": [ { "BearerAuth": [] } ], "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "data-proxy-metrics" ], "summary": "Execute a cluster instant metrics query", "operationId": "canonical-metrics-query-post", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "string", "description": "PromQL expression", "name": "query", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/metrics/query-range": { "get": { "security": [ { "BearerAuth": [] } ], "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "data-proxy-metrics" ], "summary": "Execute a cluster range metrics query", "operationId": "canonical-metrics-query-range-get", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "string", "description": "PromQL expression", "name": "query", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } } } }, "post": { "security": [ { "BearerAuth": [] } ], "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "data-proxy-metrics" ], "summary": "Execute a cluster range metrics query", "operationId": "canonical-metrics-query-range-post", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "string", "description": "PromQL expression", "name": "query", "in": "formData", "required": true }, { "type": "string", "description": "Range start", "name": "start", "in": "formData", "required": true }, { "type": "string", "description": "Range end", "name": "end", "in": "formData", "required": true }, { "type": "string", "description": "Query resolution step", "name": "step", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/metrics/series": { "get": { "security": [ { "BearerAuth": [] } ], "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "data-proxy-metrics" ], "summary": "List matching cluster metrics series", "operationId": "canonical-metrics-series-get", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "Series selectors", "name": "match[]", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } } } }, "post": { "security": [ { "BearerAuth": [] } ], "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "data-proxy-metrics" ], "summary": "List matching cluster metrics series", "operationId": "canonical-metrics-series-post", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "Series selectors", "name": "match[]", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/slow-queries": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-slow-queries" ], "summary": "List BYOC slow queries", "operationId": "canonical-byoc-slow-query-list", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Logical BYOC or physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true }, { "minimum": 0, "type": "integer", "description": "Window start in Unix seconds", "name": "begin_time", "in": "query", "required": true }, { "minimum": 0, "type": "integer", "description": "Window end in Unix seconds", "name": "end_time", "in": "query", "required": true }, { "type": "string", "description": "Comma-separated result fields", "name": "fields", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Database filters; repeat the parameter", "name": "db", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "default": 100, "description": "Result limit, 1-1000", "name": "limit", "in": "query" }, { "type": "string", "description": "SQL text filter", "name": "text", "in": "query" }, { "enum": [ "timestamp", "query_time", "memory_max", "total_keys", "process_keys" ], "type": "string", "default": "timestamp", "description": "Sort field", "name": "orderBy", "in": "query" }, { "type": "boolean", "default": false, "description": "Sort descending", "name": "desc", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Plan digest filters; repeat the parameter", "name": "plans", "in": "query" }, { "type": "string", "description": "SQL digest filter", "name": "digest", "in": "query" }, { "type": "boolean", "default": false, "description": "Include internal SQL", "name": "show_internal", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/slow-queries/available-fields": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-slow-queries" ], "summary": "List BYOC slow-query fields", "operationId": "canonical-byoc-slow-query-available-fields", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Logical BYOC or physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/slow-queries/detail": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-slow-queries" ], "summary": "Get BYOC slow-query detail", "operationId": "canonical-byoc-slow-query-detail", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Logical BYOC or physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "string", "description": "SQL digest", "name": "digest", "in": "query", "required": true }, { "type": "number", "description": "Execution timestamp in Unix seconds", "name": "timestamp", "in": "query", "required": true }, { "type": "string", "description": "Unsigned connection ID", "name": "connect_id", "in": "query", "required": true }, { "type": "boolean", "default": false, "description": "Include internal SQL", "name": "show_internal", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/sql-queries": { "post": { "security": [ { "BearerAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "data-proxy-sql" ], "summary": "Execute a cluster SQL query", "operationId": "canonical-create-sql-query", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Numeric warehouse cluster ID", "name": "clusterId", "in": "path", "required": true }, { "description": "SQL query request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CanonicalDataProxyQueryRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DataProxyQueryResult" } }, "400": { "description": "Invalid request; UNKNOWN_FIELD details are returned for unresolved query fields", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/sql-query-batches": { "post": { "security": [ { "BearerAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "data-proxy-sql" ], "summary": "Execute a same-cluster SQL query batch", "operationId": "canonical-create-sql-query-batch", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Numeric warehouse cluster ID", "name": "clusterId", "in": "path", "required": true }, { "description": "SQL query request array", "name": "request", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/dto.CanonicalDataProxyQueryRequest" } } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DataProxyBatchQueryResponse" } }, "400": { "description": "Invalid request; indexed UNKNOWN_FIELD details are returned for unresolved query fields", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/statements": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-statements" ], "summary": "List BYOC SQL Statements", "operationId": "canonical-byoc-statements-list", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Logical BYOC or physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true }, { "maximum": 253402300799, "minimum": 0, "type": "integer", "description": "Window start in Unix seconds; range must not exceed 259500 seconds", "name": "begin_time", "in": "query", "required": true }, { "maximum": 253402300799, "minimum": 0, "type": "integer", "description": "Window end in Unix seconds; range must not exceed 259500 seconds", "name": "end_time", "in": "query", "required": true }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Schema filters; repeat the parameter, at most 64 values", "name": "schemas", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Statement-type filters; repeat the parameter, at most 64 values", "name": "stmt_types", "in": "query" }, { "maxLength": 4096, "type": "string", "description": "SQL text filter, at most 4096 bytes", "name": "text", "in": "query" }, { "maxLength": 4096, "type": "string", "description": "Comma-separated result field names, at most 4096 bytes", "name": "fields", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/statements/available-fields": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-statements" ], "summary": "List BYOC SQL Statement fields", "operationId": "canonical-byoc-statements-available-fields", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Logical BYOC or physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/statements/plan-detail": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-statements" ], "summary": "Get BYOC SQL Statement plan detail", "operationId": "canonical-byoc-statements-plan-detail", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Logical BYOC or physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true }, { "maximum": 253402300799, "minimum": 0, "type": "integer", "description": "Window start in Unix seconds; range must not exceed 259500 seconds", "name": "begin_time", "in": "query", "required": true }, { "maximum": 253402300799, "minimum": 0, "type": "integer", "description": "Window end in Unix seconds; range must not exceed 259500 seconds", "name": "end_time", "in": "query", "required": true }, { "maxLength": 64, "minLength": 64, "type": "string", "description": "SQL digest, exactly 64 hexadecimal characters", "name": "digest", "in": "query", "required": true }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Optional plan digests; omit for all plans, otherwise repeat the parameter (at most 64)", "name": "plans", "in": "query" }, { "maxLength": 256, "type": "string", "description": "Schema filter, at most 256 bytes", "name": "schema_name", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/statements/plans": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-statements" ], "summary": "List BYOC SQL Statement plans", "operationId": "canonical-byoc-statements-plans", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Logical BYOC or physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true }, { "maximum": 253402300799, "minimum": 0, "type": "integer", "description": "Window start in Unix seconds; range must not exceed 259500 seconds", "name": "begin_time", "in": "query", "required": true }, { "maximum": 253402300799, "minimum": 0, "type": "integer", "description": "Window end in Unix seconds; range must not exceed 259500 seconds", "name": "end_time", "in": "query", "required": true }, { "maxLength": 64, "minLength": 64, "type": "string", "description": "SQL digest, exactly 64 hexadecimal characters", "name": "digest", "in": "query", "required": true }, { "maxLength": 256, "type": "string", "description": "Schema filter, at most 256 bytes", "name": "schema_name", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/statements/statement-types": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-statements" ], "summary": "List BYOC SQL Statement types", "operationId": "canonical-byoc-statements-types", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Logical BYOC or physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/table-schemas": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-sql" ], "summary": "List cluster table schemas", "operationId": "canonical-list-table-schemas", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Numeric warehouse cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "string", "description": "Comma-separated standard logical table names", "name": "tables", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.BatchSchemaResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/ticdc/changefeeds": { "get": { "produces": [ "application/json" ], "tags": [ "ticdc" ], "summary": "List TiCDC changefeeds (internal)", "parameters": [ { "type": "integer", "description": "TiDB Cloud org ID", "name": "orgId", "in": "path", "required": true }, { "type": "integer", "description": "TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ticdc.ListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/ticdc/changefeeds/{changefeedId}": { "get": { "produces": [ "application/json" ], "tags": [ "ticdc" ], "summary": "Get TiCDC changefeed (internal)", "parameters": [ { "type": "integer", "description": "TiDB Cloud org ID", "name": "orgId", "in": "path", "required": true }, { "type": "integer", "description": "TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "string", "description": "Changefeed ID", "name": "changefeedId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ticdc.DetailResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/top-ru/summary": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "top-ru" ], "summary": "Get Top RU summary", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Opaque TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "integer", "description": "Inclusive window start in Unix seconds", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "Inclusive window end in Unix seconds", "name": "end", "in": "query", "required": true }, { "type": "integer", "description": "Top N SQL digests", "name": "top", "in": "query", "required": true }, { "type": "string", "description": "Ranking metric: ru, exec_count, or duration", "name": "order_by", "in": "query" }, { "type": "string", "description": "Omit for all users; user= selects empty/NULL user", "name": "user", "in": "query" }, { "type": "string", "description": "O11y data source, normally deltalake", "name": "data_source", "in": "query" }, { "type": "integer", "description": "Trend bucket size in seconds", "name": "step", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/top-ru/summary-plan": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "top-ru" ], "summary": "Get Top RU summary by plan", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Opaque TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "integer", "description": "Inclusive window start in Unix seconds", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "Inclusive window end in Unix seconds", "name": "end", "in": "query", "required": true }, { "type": "integer", "description": "Top N SQL/plan groups", "name": "top", "in": "query", "required": true }, { "type": "string", "description": "Filter to a single SQL digest", "name": "digest", "in": "query" }, { "type": "string", "description": "Ranking metric: ru, exec_count, or duration", "name": "order_by", "in": "query" }, { "type": "string", "description": "Omit for all users; user= selects empty/NULL user", "name": "user", "in": "query" }, { "type": "string", "description": "O11y data source, normally deltalake", "name": "data_source", "in": "query" }, { "type": "integer", "description": "Trend bucket size in seconds", "name": "step", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/top-ru/user-stats": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "top-ru" ], "summary": "Get Top RU user statistics", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Opaque TiDB Cloud cluster ID", "name": "clusterId", "in": "path", "required": true }, { "type": "integer", "description": "Inclusive window start in Unix seconds", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "Inclusive window end in Unix seconds", "name": "end", "in": "query", "required": true }, { "type": "integer", "description": "Top N users; O11y default is 20", "name": "top", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/top-sql/instances": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-top-sql" ], "summary": "List BYOC Top SQL instances", "operationId": "canonical-byoc-top-sql-instances", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Logical BYOC or physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true }, { "maximum": 253402300799, "minimum": 0, "type": "number", "description": "Strict decimal Unix seconds; the start/end span is at most 15 days", "name": "start", "in": "query", "required": true }, { "maximum": 253402300799, "minimum": 0, "type": "number", "description": "Strict decimal Unix seconds; the start/end span is at most 15 days", "name": "end", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handlers.byocTopSQLResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/orgs/{orgId}/clusters/{clusterId}/top-sql/summary": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-top-sql" ], "summary": "Get BYOC Top SQL summary", "operationId": "canonical-byoc-top-sql-summary", "parameters": [ { "type": "string", "description": "TiDB Cloud/DBAAS org ID", "name": "orgId", "in": "path", "required": true }, { "type": "string", "description": "Logical BYOC or physical byoc-host cluster ID", "name": "clusterId", "in": "path", "required": true }, { "maximum": 253402300799, "minimum": 0, "type": "number", "description": "Strict decimal Unix seconds; the start/end span is at most 15 days", "name": "start", "in": "query", "required": true }, { "maximum": 253402300799, "minimum": 0, "type": "number", "description": "Strict decimal Unix seconds; the start/end span is at most 15 days", "name": "end", "in": "query", "required": true }, { "type": "string", "description": "Whole-second Go duration from 1s through 360h; at most 4096 windows", "name": "window", "in": "query", "required": true }, { "maximum": 100, "minimum": 1, "type": "integer", "description": "Top N SQL statements", "name": "top", "in": "query", "required": true }, { "maxLength": 512, "minLength": 1, "type": "string", "description": "Top SQL instance", "name": "instance", "in": "query", "required": true }, { "enum": [ "tidb", "tikv", "pd" ], "type": "string", "description": "Top SQL instance type", "name": "instance_type", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handlers.byocTopSQLResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/system-log-datasources": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-system-logs" ], "summary": "List system-log datasources", "operationId": "canonical-list-system-log-datasources", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handlers.CanonicalSystemLogDatasourcesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/system-log-datasources/{datasourceUID}/logs/labels": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-system-logs" ], "summary": "List system-log labels", "operationId": "canonical-system-logs-labels", "parameters": [ { "type": "string", "description": "System-log datasource UID", "name": "datasourceUID", "in": "path", "required": true }, { "type": "string", "description": "Inclusive range start as a Loki timestamp", "name": "start", "in": "query" }, { "type": "string", "description": "Inclusive range end as a Loki timestamp", "name": "end", "in": "query" }, { "type": "string", "description": "LogQL stream selector", "name": "query", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "499": { "description": "", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/system-log-datasources/{datasourceUID}/logs/labels/{name}/values": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-system-logs" ], "summary": "List system-log label values", "operationId": "canonical-system-logs-label-values", "parameters": [ { "type": "string", "description": "System-log datasource UID", "name": "datasourceUID", "in": "path", "required": true }, { "type": "string", "description": "Loki label name", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "Inclusive range start as a Loki timestamp", "name": "start", "in": "query" }, { "type": "string", "description": "Inclusive range end as a Loki timestamp", "name": "end", "in": "query" }, { "type": "string", "description": "LogQL stream selector", "name": "query", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "499": { "description": "", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/system-log-datasources/{datasourceUID}/logs/query-range": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-system-logs" ], "summary": "Query system logs over a time range", "operationId": "canonical-system-logs-query-range", "parameters": [ { "type": "string", "description": "System-log datasource UID", "name": "datasourceUID", "in": "path", "required": true }, { "type": "string", "description": "LogQL query", "name": "query", "in": "query", "required": true }, { "type": "string", "description": "Inclusive range start as a Loki timestamp", "name": "start", "in": "query" }, { "type": "string", "description": "Inclusive range end as a Loki timestamp", "name": "end", "in": "query" }, { "type": "integer", "description": "Maximum entries; clamped by Data Proxy", "name": "limit", "in": "query" }, { "type": "string", "description": "Query direction: forward or backward", "name": "direction", "in": "query" }, { "type": "string", "description": "Relative lookback duration", "name": "since", "in": "query" }, { "type": "string", "description": "Query resolution step", "name": "step", "in": "query" }, { "type": "string", "description": "Query interval", "name": "interval", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "499": { "description": "", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/api/v1/system-log-datasources/{datasourceUID}/logs/series": { "get": { "security": [ { "BearerAuth": [] } ], "produces": [ "application/json" ], "tags": [ "data-proxy-system-logs" ], "summary": "List system-log series", "operationId": "canonical-system-logs-series", "parameters": [ { "type": "string", "description": "System-log datasource UID", "name": "datasourceUID", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "LogQL stream selectors", "name": "match[]", "in": "query", "required": true }, { "type": "string", "description": "Inclusive range start as a Loki timestamp", "name": "start", "in": "query" }, { "type": "string", "description": "Inclusive range end as a Loki timestamp", "name": "end", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.APIError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.APIError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.APIError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.APIError" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/errors.APIError" } }, "499": { "description": "", "schema": { "$ref": "#/definitions/errors.APIError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/errors.APIError" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/errors.APIError" } }, "504": { "description": "Gateway Timeout", "schema": { "$ref": "#/definitions/errors.APIError" } } } } }, "/data-proxy/metrics/{cluster_id}/api/v1/query": { "get": { "description": "Evaluates an instant query at a single point in time (Prometheus-compatible)", "consumes": [ "application/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "metrics" ], "summary": "Instant query", "parameters": [ { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "PromQL expression", "name": "query", "in": "query", "required": true }, { "type": "string", "description": "Evaluation timestamp (RFC3339 or Unix timestamp)", "name": "time", "in": "query" }, { "type": "string", "description": "Evaluation timeout", "name": "timeout", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } } } } }, "/data-proxy/metrics/{cluster_id}/api/v1/query_range": { "get": { "description": "Evaluates an expression query over a range of time (Prometheus-compatible)", "consumes": [ "application/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "metrics" ], "summary": "Range query", "parameters": [ { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "PromQL expression", "name": "query", "in": "query", "required": true }, { "type": "string", "description": "Start timestamp (RFC3339 or Unix timestamp)", "name": "start", "in": "query", "required": true }, { "type": "string", "description": "End timestamp (RFC3339 or Unix timestamp)", "name": "end", "in": "query", "required": true }, { "type": "string", "description": "Query resolution step width (duration format, e.g., 15s, 1m)", "name": "step", "in": "query", "required": true }, { "type": "string", "description": "Evaluation timeout", "name": "timeout", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } } } } }, "/data-proxy/metrics/{cluster_id}/api/v1/series": { "get": { "description": "Returns the list of time series that match a certain label set (Prometheus-compatible)", "consumes": [ "application/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "metrics" ], "summary": "Series query", "parameters": [ { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "Series selector (at least one required)", "name": "match[]", "in": "query", "required": true }, { "type": "string", "description": "Start timestamp (RFC3339 or Unix timestamp)", "name": "start", "in": "query" }, { "type": "string", "description": "End timestamp (RFC3339 or Unix timestamp)", "name": "end", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/dto.PrometheusResponse" } } } } } }, "definitions": { "clinic_internal_api.ActivitiesResponse": { "type": "object", "properties": { "activities": { "type": "array", "items": { "$ref": "#/definitions/clinic_internal_api.Activity" } }, "cursor": { "type": "string" }, "partial": { "type": "boolean" } } }, "clinic_internal_api.Activity": { "type": "object", "properties": { "activity_id": { "type": "string" }, "application_id": { "type": "string" }, "author": { "type": "string" }, "calibration_time": { "type": "integer" }, "catalog": { "type": "string" }, "concept_id": { "type": "string" }, "context": { "type": "array", "items": { "type": "string" } }, "context_id": { "type": "string" }, "display_name": { "type": "string" }, "name": { "type": "string" }, "payload": {}, "severity": { "type": "integer" }, "source": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "target_id": { "type": "string" }, "type": { "type": "string" } } }, "clinic_internal_api.HealthCheckReport": { "type": "object", "properties": { "clusterId": { "type": "string" }, "createdAt": { "type": "string" }, "errorMessage": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/clinic_internal_api.HealthCheckReportItem" } }, "orgId": { "type": "string" }, "portalOrgId": { "type": "string" }, "reportId": { "type": "string" }, "status": { "type": "string" }, "strategyId": { "type": "string" }, "timeRangeAEnd": { "type": "string" }, "timeRangeAStart": { "type": "string" }, "timeRangeBEnd": { "type": "string" }, "timeRangeBStart": { "type": "string" }, "updatedAt": { "type": "string" } } }, "clinic_internal_api.HealthCheckReportCheckItem": { "type": "object", "properties": { "checkType": { "type": "string" }, "description": { "type": "string" }, "errorMessage": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } } }, "clinic_internal_api.HealthCheckReportItem": { "type": "object", "properties": { "checkType": { "type": "string" }, "content": { "type": "object" }, "description": { "type": "string" }, "errorMessage": { "type": "string" }, "name": { "type": "string" }, "params": { "type": "object" }, "status": { "type": "string" } } }, "clinic_internal_api.HealthCheckReportPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/clinic_internal_api.HealthCheckReportSummary" } }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } } }, "clinic_internal_api.HealthCheckReportSummary": { "type": "object", "properties": { "checkItems": { "type": "array", "items": { "$ref": "#/definitions/clinic_internal_api.HealthCheckReportCheckItem" } }, "clusterId": { "type": "string" }, "createdAt": { "type": "string" }, "errorMessage": { "type": "string" }, "orgId": { "type": "string" }, "portalOrgId": { "type": "string" }, "reportId": { "type": "string" }, "status": { "type": "string" }, "strategyId": { "type": "string" }, "timeRangeAEnd": { "type": "string" }, "timeRangeAStart": { "type": "string" }, "timeRangeBEnd": { "type": "string" }, "timeRangeBStart": { "type": "string" }, "updatedAt": { "type": "string" } } }, "clinic_internal_api.ResourcePoolComponent": { "type": "object", "properties": { "component_type": { "type": "string" }, "cpu": { "type": "integer" }, "id": { "type": "string" }, "image": { "$ref": "#/definitions/clinic_internal_api.ResourcePoolImage" }, "max_node_count": { "type": "integer" }, "memory_gi": { "type": "integer" }, "min_node_count": { "type": "integer" }, "node_count": { "type": "integer" }, "phase": { "type": "string" }, "storages": { "type": "array", "items": { "$ref": "#/definitions/clinic_internal_api.ResourcePoolStorage" } }, "version": { "type": "string" } } }, "clinic_internal_api.ResourcePoolImage": { "type": "object", "properties": { "repo": { "type": "string" }, "tag": { "type": "string" } } }, "clinic_internal_api.ResourcePoolStorage": { "type": "object", "properties": { "iops": { "type": "integer" }, "name": { "type": "string" }, "size_gi": { "type": "integer" }, "throughput_mbs": { "type": "integer" }, "type": { "type": "string" } } }, "clustercontext.Cluster": { "type": "object", "properties": { "clusterId": { "type": "string" }, "createdAt": { "type": "string" }, "deleted": { "type": "boolean" }, "deployType": { "type": "string" }, "deployTypeV2": { "type": "string" }, "diagnosticContext": { "$ref": "#/definitions/clustercontext.DiagnosticContext" }, "name": { "type": "string" }, "orgId": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "string" } } }, "clustercontext.DiagnosticContext": { "type": "object", "properties": { "keyspaceId": { "type": "string" }, "parentId": { "type": "string" }, "projectId": { "type": "string" }, "shootName": { "type": "string" } } }, "clustercontext.Page": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/clustercontext.Cluster" } }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } } }, "dto.BatchSchemaResponse": { "type": "object", "properties": { "count": { "description": "Schema 数量", "type": "integer" }, "schemas": { "description": "Schema 列表", "type": "array", "items": { "$ref": "#/definitions/dto.SchemaResponse" } } } }, "dto.CanonicalDataProxyQueryRequest": { "type": "object", "required": [ "sql" ], "properties": { "sql": { "type": "string", "maxLength": 1048576, "minLength": 1 }, "timeout": { "description": "seconds; zero uses the service default", "type": "integer", "maximum": 1800, "minimum": 0 } } }, "dto.ColumnInfo": { "type": "object", "properties": { "comment": { "description": "列注释", "type": "string" }, "name": { "description": "列名", "type": "string" }, "type": { "description": "数据类型", "type": "string" } } }, "dto.DataProxyBatchQueryResponse": { "type": "object", "properties": { "count": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/dto.DataProxyQueryResult" } } } }, "dto.DataProxyCapabilitiesResponse": { "type": "object", "properties": { "service": { "type": "string" }, "supported_vendors": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } } }, "dto.DataProxyQueryResult": { "type": "object", "properties": { "columns": { "description": "列名", "type": "array", "items": { "type": "string" } }, "metadata": { "description": "元数据", "allOf": [ { "$ref": "#/definitions/dto.DataProxyResultMetadata" } ] }, "rows": { "description": "数据行", "type": "array", "items": { "type": "array", "items": {} } } } }, "dto.DataProxyResultMetadata": { "type": "object", "properties": { "bytesScanned": { "description": "扫描字节数", "type": "integer" }, "engine": { "description": "使用的引擎", "type": "string" }, "engineExecutionTime": { "description": "后端引擎执行时间", "type": "string" }, "executionTime": { "description": "执行时间（格式化为易读形式，如 \"2.3s\"）", "type": "string" }, "queryId": { "description": "查询 ID（MaxCompute 为 InstanceID）", "type": "string" }, "region": { "description": "Region", "type": "string" }, "rowCount": { "description": "查询结果行数", "type": "integer" }, "vendor": { "description": "云厂商", "type": "string" } } }, "dto.MetricsErrorDetails": { "type": "object", "properties": { "retryable": { "type": "boolean" }, "upstreamErrorType": { "type": "string" }, "upstreamStatus": { "type": "integer" } } }, "dto.PartitionDef": { "type": "object", "properties": { "name": { "description": "分区字段名", "type": "string" }, "type": { "description": "分区字段类型", "type": "string" } } }, "dto.PrometheusResponse": { "type": "object", "properties": { "code": { "description": "Stable Clinic error code when classified", "type": "string" }, "data": { "description": "Query result data" }, "details": { "description": "Safe structured error metadata", "allOf": [ { "$ref": "#/definitions/dto.MetricsErrorDetails" } ] }, "error": { "description": "Error message when status is \"error\"", "type": "string" }, "errorType": { "description": "Error type when status is \"error\"", "type": "string" }, "status": { "description": "\"success\" or \"error\"", "type": "string" }, "warnings": { "description": "Optional warnings", "type": "array", "items": { "type": "string" } } } }, "dto.SchemaResponse": { "type": "object", "properties": { "columns": { "description": "列信息列表", "type": "array", "items": { "$ref": "#/definitions/dto.ColumnInfo" } }, "dataSource": { "description": "数据源 URI", "type": "string" }, "database": { "description": "数据库名", "type": "string" }, "is_view": { "description": "是否为 VIEW", "type": "boolean" }, "location": { "description": "表的 S3 存储位置", "type": "string" }, "partitions": { "description": "分区定义列表", "type": "array", "items": { "$ref": "#/definitions/dto.PartitionDef" } }, "table": { "description": "表名", "type": "string" } } }, "errors.APIError": { "type": "object", "properties": { "code": { "type": "string" }, "details": {}, "message": { "type": "string" }, "requestId": { "type": "string" } } }, "handlers.CanonicalSystemLogDatasourcesResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/service.SystemLogsDatasources" }, "status": { "type": "string" } } }, "handlers.byocContinuousProfilingGroupProfile": { "type": "object", "properties": { "component_num": { "type": "object", "additionalProperties": { "type": "integer" } }, "profile_duration_secs": { "type": "integer" }, "state": { "type": "string" }, "ts": { "type": "integer" } } }, "handlers.byocContinuousProfilingGroupProfileDetail": { "type": "object", "properties": { "profile_duration_secs": { "type": "integer" }, "state": { "type": "string" }, "target_profiles": { "type": "array", "items": { "$ref": "#/definitions/handlers.byocContinuousProfilingGroupProfileDetailItem" } }, "ts": { "type": "integer" } } }, "handlers.byocContinuousProfilingGroupProfileDetailItem": { "type": "object", "properties": { "error": { "type": "string" }, "profile_type": { "type": "string" }, "state": { "type": "string" }, "target": { "$ref": "#/definitions/handlers.byocContinuousProfilingGroupProfileDetailTarget" } } }, "handlers.byocContinuousProfilingGroupProfileDetailTarget": { "type": "object", "properties": { "address": { "type": "string" }, "component": { "type": "string" } } }, "handlers.byocTopSQLResponse": { "type": "object", "required": [ "data", "status" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "status": { "type": "string", "minLength": 1 } } }, "service.SystemLogsDatasource": { "type": "object", "properties": { "datasource": { "type": "string" }, "is_default": { "type": "boolean" }, "provider": { "type": "string" }, "region": { "type": "string" }, "uid": { "type": "string" } } }, "service.SystemLogsDatasources": { "type": "object", "properties": { "datasources": { "type": "array", "items": { "$ref": "#/definitions/service.SystemLogsDatasource" } }, "default_datasource": { "type": "string" } } }, "ticdc.Changefeed": { "type": "object", "properties": { "arch": { "type": "string" }, "checkpoint_ts": { "type": "integer" }, "checkpoint_tso": { "type": "string" }, "cluster_type": { "type": "string" }, "created_at": { "type": "integer" }, "display_id": { "type": "string" }, "display_name": { "type": "string" }, "downstream_config": { "type": "object", "additionalProperties": true }, "downstream_type": { "type": "string" }, "id": { "type": "string" }, "network_info": { "$ref": "#/definitions/ticdc.NetworkInfo" }, "rcu": { "type": "string" }, "start_position": { "$ref": "#/definitions/ticdc.StartPosition" }, "status": { "type": "string" }, "table_config": { "$ref": "#/definitions/ticdc.TableConfig" }, "ticdc_cluster": { "$ref": "#/definitions/ticdc.TiCDCCluster" }, "ticdc_cluster_name": { "type": "string" } } }, "ticdc.DetailResponse": { "type": "object", "properties": { "changefeed": { "$ref": "#/definitions/ticdc.Changefeed" } } }, "ticdc.EventFilter": { "type": "object", "properties": { "ignored_delete_value_expression": { "type": "string" }, "ignored_events": { "type": "array", "items": { "type": "string" } }, "ignored_insert_value_expression": { "type": "string" }, "ignored_sql_statements": { "type": "array", "items": { "type": "string" } }, "ignored_update_new_value_expression": { "type": "string" }, "ignored_update_old_value_expression": { "type": "string" }, "table_matchers": { "type": "array", "items": { "type": "string" } } } }, "ticdc.ListResponse": { "type": "object", "properties": { "changefeeds": { "type": "array", "items": { "$ref": "#/definitions/ticdc.Changefeed" } } } }, "ticdc.NetworkInfo": { "type": "object", "properties": { "advertised_pattern_group": { "type": "object", "additionalProperties": { "type": "string" } }, "kafka_id": { "type": "string" }, "network_type": { "type": "string" }, "ports": { "type": "array", "items": { "type": "integer" } }, "private_link_service_name": { "type": "string" }, "sink_endpoint_id": { "type": "string" } } }, "ticdc.StartPosition": { "type": "object", "properties": { "mode": { "type": "string" }, "timestamp": { "type": "string" }, "tso": { "type": "string" } } }, "ticdc.TableConfig": { "type": "object", "properties": { "case_sensitive": { "type": "boolean" }, "event_filters": { "type": "array", "items": { "$ref": "#/definitions/ticdc.EventFilter" } }, "filter_rules": { "type": "array", "items": { "type": "string" } }, "mode": { "type": "string" } } }, "ticdc.TiCDCCluster": { "type": "object", "properties": { "cluster_type": { "type": "string" }, "control_plane_arch": { "type": "string" }, "created_at": { "type": "integer" }, "deploy_type": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "operator_version": { "type": "string" }, "provider_type": { "type": "string" }, "region": { "type": "string" }, "specification_code": { "type": "string" }, "status": { "type": "string" }, "tidb_cluster_id": { "type": "string" }, "version": { "type": "string" } } } }, "securityDefinitions": { "BearerAuth": { "description": "Use `Bearer \u003cclinic-api-key\u003e`.", "type": "apiKey", "name": "Authorization", "in": "header" } } }