// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT // This file was generated by swaggo/swag package globalserverswagger import ( "bytes" "encoding/json" "strings" "github.com/alecthomas/template" "github.com/swaggo/swag" ) var doc = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { "description": "{{.Description}}", "title": "{{.Title}}", "contact": { "name": "zhangpeijin", "email": "zhangpeijin@pingcap.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/": { "get": { "description": "get service info", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "service" ], "summary": "get service info", "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.GetServiceInfoResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/addons": { "get": { "description": "Lists all addons installed in the cluster with their versions and status", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "upgrade-operation" ], "summary": "List cluster addons", "parameters": [ { "type": "string", "description": "Kubernetes cluster name", "name": "k8sClusterName", "in": "query", "required": true }, { "type": "string", "description": "Cloud region", "name": "region", "in": "query", "required": true }, { "type": "string", "description": "Cloud provider (eks, gke, aks, ack, mock)", "name": "cloudProvider", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ListAddonsResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/alert-auth": { "put": { "description": "Updates basic auth credentials for both alertmanager and kube-prometheus-stack HelmReleases using fail-fast approach", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ops" ], "summary": "update basic auth credentials for alertmanager and kube-prometheus-stack", "parameters": [ { "description": "update basic auth request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.UpdateBasicAuthReq" } } ], "responses": { "200": { "description": "Basic auth credentials updated successfully", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.UpdateBasicAuthResp" } } } ] } }, "500": { "description": "Basic auth update failed (30004)", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/alertrule-template/": { "post": { "description": "modify alertrules template", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "modify alertrules template", "parameters": [ { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "templateID", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ModifyAlertRulesTemplateResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/alertrule-template/{id}": { "get": { "description": "get alertrules template", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "get alertrules template", "parameters": [ { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.QueryAlertRulesTemplateResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "delete": { "description": "delete alertrules template", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "delete alertrules template", "parameters": [ { "type": "string", "name": "id", "in": "query", "required": true }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DeleteAlertRulesTemplateResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/api/v2/global/clusters": { "get": { "description": "list clusters by querying tidb-management-service and o11y regional servers. At least one of tenantIds, projectIds, or clusterIds must be provided. When showInfra=true, clusterIds is required and each cluster row includes an infraClusters array.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "list clusters with metadata", "parameters": [ { "type": "string", "description": "comma-separated tenant IDs; at least one of tenantIds/projectIds/clusterIds is required", "name": "tenantIds", "in": "query" }, { "type": "string", "description": "comma-separated project IDs; at least one of tenantIds/projectIds/clusterIds is required", "name": "projectIds", "in": "query" }, { "type": "string", "description": "comma-separated cluster IDs; at least one of tenantIds/projectIds/clusterIds is required", "name": "clusterIds", "in": "query" }, { "type": "string", "description": "environment: dev, staging, prod", "name": "env", "in": "query", "required": true }, { "type": "boolean", "description": "when true, each cluster row includes an infraClusters array; requires clusterIds to be set", "name": "showInfra", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ListClustersWithMetadataResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/api/v2/observability/alertrule/templates": { "get": { "produces": [ "application/json" ], "tags": [ "AlertRule" ], "summary": "Get alert rule templates", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.OpenAlertRuleTemplateList" } } } ] } } } } }, "/api/v2/observability/alertrule/templates/{template_id}": { "get": { "produces": [ "application/json" ], "tags": [ "AlertRule" ], "summary": "Get alert rule template detail", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true }, { "type": "string", "description": "Template ID", "name": "template_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.OpenAlertRule" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/api/v2/observability/clusters/": { "get": { "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "Query cluster list", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true }, { "type": "string", "description": "Project ID", "name": "projectID", "in": "query" }, { "type": "string", "description": "Application ID", "name": "applicationID", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.OpenClusterListResponse" } } } ] } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "Create an observability cluster", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true }, { "description": "Create request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.OpenCreateClusterRequest" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.OpenObservabilityCluster" } } } ] } }, "409": { "description": "Conflict", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.OpenObservabilityCluster" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/api/v2/observability/clusters/{cluster_id}": { "get": { "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "Get cluster details", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.OpenObservabilityCluster" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } } } }, "delete": { "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "Delete cluster", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.OpenObservabilityCluster" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/api/v2/observability/clusters/{cluster_id}/:pause": { "post": { "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "Pause cluster", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.OpenObservabilityCluster" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/api/v2/observability/clusters/{cluster_id}/:resume": { "post": { "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "Resume cluster", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.OpenObservabilityCluster" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/api/v2/observability/clusters/{cluster_id}/alertrule/": { "get": { "produces": [ "application/json" ], "tags": [ "AlertRule" ], "summary": "Get alert rule template detail", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.OpenAlertRule" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } } } }, "put": { "produces": [ "application/json" ], "tags": [ "AlertRule" ], "summary": "Get alert rule template detail", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "description": "content", "name": "alert_rules", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.OpenAlertRule" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.OpenAlertRule" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/api/v2/observability/clusters/{cluster_id}/{category}/config": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "Update category configuration", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "Module name", "name": "module", "in": "path", "required": true }, { "description": "Configuration", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.OpenModuleConfigRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/api/v2/observability/clusters/{cluster_id}/{category}/status": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "Update category status", "parameters": [ { "type": "string", "description": "Cloud vendor", "name": "x-vendor", "in": "header", "required": true }, { "type": "string", "description": "Region", "name": "x-region", "in": "header", "required": true }, { "type": "string", "description": "Organization ID", "name": "x-org-id", "in": "header", "required": true }, { "type": "string", "description": "Cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "category name", "name": "category", "in": "path", "required": true }, { "description": "Status", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.OpenModuleStatusRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/clusters/": { "get": { "description": "query clusters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "query clusters", "parameters": [ { "type": "string", "name": "applicationID", "in": "query" }, { "type": "string", "name": "bizType", "in": "query" }, { "type": "string", "name": "continueToken", "in": "query" }, { "type": "integer", "name": "limit", "in": "query" }, { "type": "string", "name": "projectID", "in": "query" }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "boolean", "name": "showDeleted", "in": "query" }, { "type": "string", "name": "tenantID", "in": "query" }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.QueryClustersResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "post": { "description": "create a observability cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "create a observability cluster", "parameters": [ { "description": "create request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.CreateClusterReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.CreateClusterResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/clusters/{id}": { "get": { "description": "show detail info of a cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "show detail info of a cluster", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "type": "string", "name": "bizType", "in": "query" }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DetailClusterResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "put": { "description": "update a cluster's muteAlert, ruleTemplateID, or monitorSpecID", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "update a cluster", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "description": "update cluster request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.UpdateClusterReq" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.UpdateClusterResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "delete": { "description": "delete a cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "delete a cluster", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "type": "string", "name": "agentAccessARN", "in": "query" }, { "type": "string", "name": "bizType", "in": "query" }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DeleteClusterResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/clusters/{id}/agent-observed/": { "post": { "description": "modify observed info for monitor agent", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "modify observed info for monitor agent", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "description": "update monitor agent observed info", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.ModifyAgentObservedReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ModifyAgentObservedResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "405": { "description": "Method Not Allowed", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/clusters/{id}/alert/mute": { "put": { "description": "mute alert of a cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "mute alert of a cluster", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.MuteClusterAlertResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/clusters/{id}/alert/unmute": { "put": { "description": "unmute alert of a cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "unmute alert of a cluster", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.UnmuteClusterAlertResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/clusters/{id}/monitor-mode/": { "put": { "description": "adjust spec of monitor share mode", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "adjust spec of monitor share mode", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "description": "update monitor share mode request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.ModifyMonitorModeReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ModifyMonitorModeResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "405": { "description": "Method Not Allowed", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/clusters/{id}/monitor-resource/": { "post": { "description": "adjust spec of monitor resource", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "adjust spec of monitor resource", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "description": "update monitor storage resource", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.ModifyMonitorResourceReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ModifyMonitorResourceResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "405": { "description": "Method Not Allowed", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/clusters/{id}/monitor-spec/": { "put": { "description": "adjust spec of monitor spec", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "adjust spec of monitor spec", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "description": "update monitor spec request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.ModifyMonitorSpecReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ModifyMonitorSpecResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/clusters/{id}/monitor-storage/": { "post": { "description": "adjust spec of monitor storage", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "adjust spec of monitor storage", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "description": "update monitor storage request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.ModifyMonitorStorageReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ModifyMonitorStorageResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "405": { "description": "Method Not Allowed", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/clusters/{id}/pause": { "put": { "description": "pause a cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "pause a cluster", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.PauseClusterResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/clusters/{id}/resume": { "put": { "description": "resume a cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "resume a cluster", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ResumeClusterResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/external/{bizType}/orgs/{tenantID}/byocVcpuPools/observabilityVcpu": { "get": { "description": "proxy an org-scoped observability vCPU range query to regional self-monitoring prometheus", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "external" ], "summary": "get BYOC observability vCPU range metrics", "parameters": [ { "type": "string", "description": "Region id for routing", "name": "x-region-id", "in": "header", "required": true }, { "type": "string", "description": "bizType, e.g. byoc", "name": "bizType", "in": "path", "required": true }, { "type": "string", "description": "tenant id", "name": "tenantID", "in": "path", "required": true }, { "type": "string", "description": "range start, unix seconds", "name": "start", "in": "query", "required": true }, { "type": "string", "description": "range end, unix seconds", "name": "end", "in": "query", "required": true }, { "type": "string", "description": "optional resolution step, default 30s", "name": "step", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/external/{bizType}/orgs/{tenantID}/clusters/{applicationID}/": { "get": { "description": "get cluster info for web console", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "external" ], "summary": "get cluster info for web console", "parameters": [ { "type": "string", "description": "Region id for routing", "name": "x-region-id", "in": "header", "required": true }, { "type": "string", "description": "bizType, for staging, use staging-tidbcloud-nextgen, others, use tidbcloud-nextgen", "name": "bizType", "in": "path", "required": true }, { "type": "string", "description": "tenant id", "name": "tenantID", "in": "path", "required": true }, { "type": "string", "description": "application id", "name": "applicationID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.GetClusterExternalResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/external/{bizType}/orgs/{tenantID}/clusters/{applicationID}/alerts": { "get": { "description": "list all user alerts belongs to specific cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "external" ], "summary": "list cluster alerts for next gen", "parameters": [ { "type": "string", "description": "bizType, for staging, use staging-tidbcloud, others, use tidbcloud", "name": "bizType", "in": "path", "required": true }, { "type": "string", "description": "tenant id", "name": "tenantID", "in": "path", "required": true }, { "type": "string", "description": "application id", "name": "applicationID", "in": "path", "required": true }, { "type": "integer", "description": "endTime of alerts, unix timestamp", "name": "endTime", "in": "query" }, { "type": "integer", "name": "limit", "in": "query" }, { "type": "integer", "name": "page", "in": "query" }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "description": "severity with lowercase, oneof warning, critical", "name": "severity", "in": "query" }, { "type": "integer", "description": "startTime of alerts, unix timestamp", "name": "startTime", "in": "query" }, { "type": "string", "description": "alert state with lowercase, one of active closed all", "name": "status", "in": "query" }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.QueryExternalAlertsResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/external/{bizType}/orgs/{tenantID}/clusters/{applicationID}/monitor-alertrules": { "get": { "description": "query prometheusrules", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "query prometheusrules for next gen", "parameters": [ { "type": "string", "description": "bizType, for staging, use staging-tidbcloud, others, use tidbcloud", "name": "bizType", "in": "path", "required": true }, { "type": "string", "description": "tenant id", "name": "tenantID", "in": "path", "required": true }, { "type": "string", "description": "application id", "name": "applicationID", "in": "path", "required": true }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.QueryAlertRulesByCloudUserResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "put": { "description": "update alert rules", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "update alert rules by cloud user for next gen", "parameters": [ { "type": "string", "description": "bizType, for staging, use staging-tidbcloud, others, use tidbcloud", "name": "bizType", "in": "path", "required": true }, { "type": "string", "description": "tenant id", "name": "tenantID", "in": "path", "required": true }, { "type": "string", "description": "application id", "name": "applicationID", "in": "path", "required": true }, { "description": "update alert rule request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.UpdateAlertRulesByCloudUserReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.UpdateAlertRulesByCloudUserResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/external/{bizType}/orgs/{tenantID}/projects/{projectID}/clusters/{applicationID}/alerts": { "get": { "description": "list all user alerts belongs to specific cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "external" ], "summary": "list cluster alerts", "parameters": [ { "type": "string", "description": "bizType, for staging, use staging-tidbcloud, others, use tidbcloud", "name": "bizType", "in": "path", "required": true }, { "type": "string", "description": "tenant id", "name": "tenantID", "in": "path", "required": true }, { "type": "string", "description": "project id", "name": "projectID", "in": "path", "required": true }, { "type": "string", "description": "application id", "name": "applicationID", "in": "path", "required": true }, { "type": "integer", "description": "endTime of alerts, unix timestamp", "name": "endTime", "in": "query" }, { "type": "integer", "name": "limit", "in": "query" }, { "type": "integer", "name": "page", "in": "query" }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "description": "severity with lowercase, oneof warning, critical", "name": "severity", "in": "query" }, { "type": "integer", "description": "startTime of alerts, unix timestamp", "name": "startTime", "in": "query" }, { "type": "string", "description": "alert state with lowercase, one of active closed all", "name": "status", "in": "query" }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.QueryExternalAlertsResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/external/{bizType}/orgs/{tenantID}/projects/{projectID}/clusters/{applicationID}/monitor-alertrules": { "get": { "description": "query prometheusrules", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "query prometheusrules", "parameters": [ { "type": "string", "description": "bizType, for staging, use staging-tidbcloud, others, use tidbcloud", "name": "bizType", "in": "path", "required": true }, { "type": "string", "description": "tenant id", "name": "tenantID", "in": "path", "required": true }, { "type": "string", "description": "project id", "name": "projectID", "in": "path", "required": true }, { "type": "string", "description": "application id", "name": "applicationID", "in": "path", "required": true }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.QueryAlertRulesByCloudUserResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "put": { "description": "update alert rules", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "update alert rules by cloud user", "parameters": [ { "type": "string", "description": "bizType, for staging, use staging-tidbcloud, others, use tidbcloud", "name": "bizType", "in": "path", "required": true }, { "type": "string", "description": "tenant id", "name": "tenantID", "in": "path", "required": true }, { "type": "string", "description": "project id", "name": "projectID", "in": "path", "required": true }, { "type": "string", "description": "application id", "name": "applicationID", "in": "path", "required": true }, { "description": "update alert rule request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.UpdateAlertRulesByCloudUserReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.UpdateAlertRulesByCloudUserResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/global/clusters/": { "get": { "description": "query clusters globally", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "query clusters globally", "parameters": [ { "type": "string", "name": "applicationID", "in": "query" }, { "type": "string", "name": "bizType", "in": "query" }, { "type": "string", "name": "continueToken", "in": "query" }, { "type": "integer", "name": "limit", "in": "query" }, { "type": "string", "name": "projectID", "in": "query" }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "boolean", "name": "showDeleted", "in": "query" }, { "type": "string", "name": "tenantID", "in": "query" }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.QueryClustersResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/health": { "get": { "description": "get service health", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "service" ], "summary": "get service health", "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.GetServiceHealthResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/helmreleases": { "get": { "description": "Lists all HelmRelease custom resources, optionally filtered by namespace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "helmrelease" ], "summary": "List HelmRelease CRs", "parameters": [ { "type": "string", "description": "namespace to filter by", "name": "namespace", "in": "query" }, { "type": "string", "name": "continueToken", "in": "query" }, { "type": "integer", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ListHelmReleasesResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "post": { "description": "Creates a new HelmRelease custom resource in the specified namespace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "helmrelease" ], "summary": "create a HelmRelease CR", "parameters": [ { "description": "create HelmRelease request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.CreateHelmReleaseReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.CreateHelmReleaseResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/helmreleases/diff": { "post": { "description": "Compares requested HelmRelease desired state with live state and returns drift/adoption guard information", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "helmrelease" ], "summary": "diff a HelmRelease desired state", "parameters": [ { "description": "diff HelmRelease request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.DiffHelmReleaseReq" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DiffHelmReleaseResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/helmreleases/{name}": { "get": { "description": "Retrieves the details of a specific HelmRelease custom resource", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "helmrelease" ], "summary": "get HelmRelease CR details", "parameters": [ { "type": "string", "description": "HelmRelease name", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.GetHelmReleaseResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "put": { "description": "Updates the configuration of an existing HelmRelease custom resource", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "helmrelease" ], "summary": "update HelmRelease CR", "parameters": [ { "type": "string", "description": "HelmRelease name", "name": "name", "in": "path", "required": true }, { "description": "update HelmRelease request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.UpdateHelmReleaseReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.UpdateHelmReleaseResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "delete": { "description": "Deletes a HelmRelease custom resource and triggers the associated Helm uninstall", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "helmrelease" ], "summary": "delete HelmRelease CR", "parameters": [ { "type": "string", "description": "HelmRelease namespace", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "HelmRelease name", "name": "name", "in": "path", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DeleteHelmReleaseResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/integrationtasks/": { "get": { "description": "query integration tasks with filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "integrationtask" ], "summary": "query integration tasks", "parameters": [ { "type": "string", "name": "dataType", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" }, { "type": "string", "name": "pageToken", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.QueryIntegrationTasksResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "post": { "description": "create an integration task for data processing", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "integrationtask" ], "summary": "create an integration task", "parameters": [ { "description": "create request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.CreateIntegrationTaskReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.CreateIntegrationTaskResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/integrationtasks/{id}": { "get": { "description": "show detail info of an integration task", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "integrationtask" ], "summary": "show detail info of an integration task", "parameters": [ { "type": "string", "description": "integration task id", "name": "id", "in": "path", "required": true }, { "type": "string", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DetailIntegrationTaskResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "put": { "description": "update an integration task configuration", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "integrationtask" ], "summary": "update an integration task", "parameters": [ { "type": "string", "description": "integration task id", "name": "id", "in": "path", "required": true }, { "description": "update request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.UpdateIntegrationTaskReq" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.UpdateIntegrationTaskResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "delete": { "description": "delete an integration task", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "integrationtask" ], "summary": "delete an integration task", "parameters": [ { "type": "string", "description": "integration task id", "name": "id", "in": "path", "required": true }, { "type": "string", "name": "id", "in": "query", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DeleteIntegrationTaskResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/internal/clusters/{applicationID}/monitoringPipelines": { "post": { "description": "create an integration task for vector agent data processing", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "integrationtask" ], "summary": "create an integration task (internal)", "parameters": [ { "description": "create request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.CreateIntegrationTaskReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.CreateIntegrationTaskResp" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/internal/monitoringPipelines/{id}": { "get": { "description": "show detail info of an integration task for internal services", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "integrationtask" ], "summary": "show detail info of an integration task (internal)", "parameters": [ { "type": "string", "description": "integration task id", "name": "id", "in": "path", "required": true }, { "type": "string", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DetailIntegrationTaskResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/internal/{bizType}/orgs/{tenantID}/projects/{projectID}/clusters/{applicationID}/alerts": { "get": { "description": "lists all user alerts belongs to specific cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "external" ], "summary": "list cluster external alerts for internal service", "parameters": [ { "type": "string", "description": "bizType, for staging, use staging-tidbcloud, others, use tidbcloud", "name": "bizType", "in": "path", "required": true }, { "type": "string", "description": "tenant id", "name": "tenantID", "in": "path", "required": true }, { "type": "string", "description": "project id", "name": "projectID", "in": "path", "required": true }, { "type": "string", "description": "application id", "name": "applicationID", "in": "path", "required": true }, { "type": "integer", "description": "endTime of alerts, unix timestamp", "name": "endTime", "in": "query" }, { "type": "integer", "name": "limit", "in": "query" }, { "type": "integer", "name": "page", "in": "query" }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "description": "severity with lowercase, oneof warning, critical", "name": "severity", "in": "query" }, { "type": "integer", "description": "startTime of alerts, unix timestamp", "name": "startTime", "in": "query" }, { "type": "string", "description": "alert state with lowercase, one of active closed all", "name": "status", "in": "query" }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.QueryExternalAlertsResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/internal/{bizType}/orgs/{tenantID}/projects/{projectID}/clusters/{applicationID}/monitor-alertrules": { "get": { "description": "query prometheusrules", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "query prometheusrules for internal service", "parameters": [ { "type": "string", "description": "bizType, for staging, use staging-tidbcloud, others, use tidbcloud", "name": "bizType", "in": "path", "required": true }, { "type": "string", "description": "tenant id", "name": "tenantID", "in": "path", "required": true }, { "type": "string", "description": "project id", "name": "projectID", "in": "path", "required": true }, { "type": "string", "description": "application id", "name": "applicationID", "in": "path", "required": true }, { "type": "string", "name": "region", "in": "query", "required": true }, { "type": "string", "name": "vendor", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.QueryAlertRulesByCloudUserResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/nodeGroups": { "get": { "description": "Lists all node groups for a cluster with their Kubernetes versions", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "upgrade-operation" ], "summary": "Get all node groups and their versions", "parameters": [ { "type": "string", "description": "Kubernetes cluster name", "name": "k8sClusterName", "in": "query", "required": true }, { "type": "string", "description": "Cloud region", "name": "region", "in": "query", "required": true }, { "type": "string", "description": "Cloud provider (eks, gke, aks, ack, mock)", "name": "cloudProvider", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.GetNodeGroupsResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/ops/events/alerts/": { "post": { "description": "handle alerts", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ops" ], "summary": "handle alerts", "parameters": [ { "description": " handle alert", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.GlobalHandleAlertReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.GlobalHandleAlertResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/routes": { "get": { "description": "Query regional route information based on vendor, region, tenant ID, and business type. This API returns the DNS address and routing details for the specified logical region.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "globalapi" ], "summary": "Query region routes for logical region routing", "parameters": [ { "type": "string", "description": "Logical region name. If supplied (non-empty), takes precedence over the (X-Org-Id, X-Biz-Type) pair. X-Region-Id is always required.", "name": "X-Logical-Region", "in": "header" }, { "type": "string", "description": "Region ID in the format \u003cvendor\u003e-\u003cregion\u003e, e.g. aws-us-west-2. Always required.", "name": "X-Region-Id", "in": "header", "required": true }, { "type": "string", "description": "Organization/Tenant ID. Required when X-Logical-Region is empty.", "name": "X-Org-Id", "in": "header" }, { "type": "string", "description": "Business type (e.g., tidbcloud, serverless, byoc). Required when X-Logical-Region is empty.", "name": "X-Biz-Type", "in": "header" }, { "type": "string", "description": "Project ID for finer-grained routing (e.g. serverless parent cluster f02-f06).", "name": "X-Project-Id", "in": "header" }, { "type": "string", "description": "Application/Cluster ID (e.g. serverless parent cluster devtier-infra).", "name": "X-Application-Id", "in": "header" } ], "responses": { "200": { "description": "Regional router information including DNS address and logical region details", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/structs.RegionalRouter" } } } ] } }, "400": { "description": "Bad request - missing required parameters", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/upgradeOperations": { "get": { "description": "Lists all cluster upgrade operations with optional filtering", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "upgrade-operation" ], "summary": "List upgrade operations", "parameters": [ { "type": "string", "name": "continueToken", "in": "query" }, { "type": "string", "name": "k8sClusterName", "in": "query" }, { "type": "integer", "name": "limit", "in": "query" }, { "type": "string", "name": "status", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ListClusterUpgradesResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "post": { "description": "Creates a new Kubernetes cluster upgrade operation with step-based execution", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "upgrade-operation" ], "summary": "Create an upgrade operation", "parameters": [ { "description": "create cluster upgrade request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.CreateClusterUpgradeReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.CreateClusterUpgradeResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/upgradeOperations/dry-run": { "post": { "description": "Dry-runs a cluster upgrade request and returns the ClusterUpgradeOperation CR that would be created without actually creating it", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "upgrade-operation" ], "summary": "Dry-run an upgrade operation", "parameters": [ { "description": "create cluster upgrade request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.CreateClusterUpgradeReq" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DryRunClusterUpgradeResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/upgradeOperations/{id}": { "get": { "description": "Retrieves the details of a specific cluster upgrade operation", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "upgrade-operation" ], "summary": "Get upgrade operation details", "parameters": [ { "type": "string", "description": "upgrade operation ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.GetClusterUpgradeResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "delete": { "description": "Deletes/cancels a cluster upgrade operation", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "upgrade-operation" ], "summary": "Delete an upgrade operation", "parameters": [ { "type": "string", "description": "upgrade operation ID", "name": "id", "in": "path", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DeleteClusterUpgradeResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/upgradeOperations/{id}/pause": { "put": { "description": "Pauses a running cluster upgrade operation", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "upgrade-operation" ], "summary": "Pause an upgrade operation", "parameters": [ { "type": "string", "description": "upgrade operation ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.PauseClusterUpgradeResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/upgradeOperations/{id}/resume": { "put": { "description": "Resumes a paused cluster upgrade operation", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "upgrade-operation" ], "summary": "Resume a paused upgrade operation", "parameters": [ { "type": "string", "description": "upgrade operation ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ResumeClusterUpgradeResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/vmclusters": { "get": { "description": "Lists all deployed VictoriaMetrics clusters managed by the Ops API Server", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "vmcluster" ], "summary": "List VM Clusters", "parameters": [ { "type": "integer", "description": "Current page location", "name": "page", "in": "query" }, { "type": "integer", "description": "Number of this request", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.ListVMClustersResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "post": { "description": "Deploys a new VictoriaMetrics cluster by creating a new Helm release", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "vmcluster" ], "summary": "deploy victoriametrics cluster", "parameters": [ { "description": "create VM cluster request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.CreateVMClusterReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.CreateVMClusterResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } }, "/vmclusters/{vmclusterId}": { "get": { "description": "Retrieves the details of a specific VictoriaMetrics cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "vmcluster" ], "summary": "get VM cluster details", "parameters": [ { "type": "string", "description": "VM cluster ID", "name": "vmclusterId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.GetVMClusterResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "put": { "description": "Updates the configuration of an existing VictoriaMetrics cluster by performing a Helm upgrade", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "vmcluster" ], "summary": "change vm cluster", "parameters": [ { "type": "string", "description": "VM cluster ID", "name": "vmclusterId", "in": "path", "required": true }, { "description": "update VM cluster request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.UpdateVMClusterReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.UpdateVMClusterResp" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "delete": { "description": "Deletes a VictoriaMetrics cluster by uninstalling the associated Helm release", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "vmcluster" ], "summary": "Uninstall the VM cluster", "parameters": [ { "type": "string", "description": "VM cluster ID", "name": "vmclusterId", "in": "path", "required": true } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DeleteVMClusterResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } } }, "definitions": { "message.AddonInfo": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "string" } } }, "message.AddonUpgradeConfig": { "type": "object", "required": [ "name", "version" ], "properties": { "configurationValues": { "description": "ConfigurationValues is a string containing the set of configuration values for the add-on.\nValues are validated against the schema returned by DescribeAddonConfiguration.", "type": "string" }, "name": { "type": "string" }, "resolveConflicts": { "description": "ResolveConflicts specifies how to handle field value conflicts if you've changed a value from the AWS EKS default.\nNONE means AWS EKS doesn't change the value (update might fail)\nOVERWRITE means AWS EKS overwrites the changed value back to the default\nPRESERVE means AWS EKS preserves the changed value", "type": "string" }, "serviceAccountRoleArn": { "description": "ServiceAccountRoleArn is the Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.\nThe role must have the IAM permissions required by the add-on.", "type": "string" }, "version": { "type": "string" } } }, "message.BYOCVPCPeering": { "type": "object", "properties": { "dataplaneVpcCIDR": { "type": "string" }, "peeringConnectionID": { "type": "string" } } }, "message.ClusterUpgradeSummary": { "type": "object", "properties": { "beginTime": { "type": "string" }, "cloudProvider": { "type": "string" }, "currentVersion": { "type": "string" }, "endTime": { "type": "string" }, "id": { "type": "string" }, "k8sClusterName": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "targetVersion": { "type": "string" } } }, "message.ClusterWithInfra": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dataPropertyRights": { "type": "integer" }, "dataplaneId": { "type": "string" }, "id": { "type": "string" }, "infraClusters": { "type": "array", "items": { "$ref": "#/definitions/structs.ClusterBaseInfo" } }, "internalReadUri": { "type": "string" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "openReadUri": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "shareMode": { "type": "string" }, "sharedPoolId": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } } }, "message.CreateClusterReq": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "agentAccessARN": { "description": "AgentAccessARN and AgentManagerARN are not needed in the 3-layers architecture\nbecause the AgentEnvironment model defines account and project information\nAgentManagerARN is a pre-defined management role created in each dataplane account for o11y\nAgentAccessARN is a data role: o11y_{{k8s_id}}_access_role created by o11y_regional_server for each k8s\nCompatibility solution: If agentAccessARN and agentManagerARN are passed, use o11y_management_role.\nIf not passed, use the fixed management role and generated access role.\nNote: AgentAccessARN could be changed to agent data role arn during an in-flight request.", "type": "string" }, "agentAccessAccount": { "description": "AgentAccessAccount is used for agent access account, if not set, use agentAccessARN, if set, use agentAccessAccount and agentAccessARN must not set", "type": "string" }, "agentEnvironment": { "description": "describe agent deployment env, e.g VPC, account and provider\nif not set, use Compatibility path", "type": "object", "$ref": "#/definitions/structs.AgentEnvironment" }, "agentManagerARN": { "description": "AgentManagerARN is used for private link service authentication.", "type": "string" }, "agentNextGen": { "description": "AgentNextGen is used for next gen agent, if not set, use old path", "type": "boolean" }, "agentSharedRole": { "description": "only for shared-vpc", "type": "boolean" }, "agentTemplateName": { "description": "agent config template, now not used", "type": "string" }, "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "byocVpcPeering": { "description": "BYOCVPCPeering carries dataplane-specific peering info used by the regional\nserver to ensure routes in the statically provisioned o11y VPC.", "type": "object", "$ref": "#/definitions/message.BYOCVPCPeering" }, "category": { "description": "o11y provided data categories, such as monitoring, logging, topsql, etc.\nThe default value is []string{\"metrics\", \"logs\"}, which will be added to the cluster's CR.\nIf topsql is enabled, add \"topsql\" to it.", "type": "array", "items": { "type": "string" } }, "dataPropertyRights": { "type": "integer" }, "id": { "type": "string" }, "internalReadUri": { "type": "string" }, "keySpaceID": { "type": "string" }, "monitorPromRules": { "type": "object" }, "monitorSpecID": { "description": "only prometheus spec(vmalert use this, wrong ways)", "type": "string" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "observed": { "description": "tidb cluster or other observed component information, for o11y auto scale", "type": "object", "$ref": "#/definitions/structs.Observed" }, "openReadUri": { "type": "string" }, "parentClusterID": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "ruleTemplateID": { "type": "string" }, "seedClusterID": { "description": "A temporary parameter set specifically for the k8s-infra cluster.\nThe purpose is to specify which seed cluster k8s-infra will push the metrics to.\nThis parameter should be deleted in the future when k8s-infra metrics are pushed to its own cluster", "type": "string" }, "shareMode": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } } }, "message.CreateClusterResp": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "agentInfo": { "type": "object", "$ref": "#/definitions/structs.AgentInfo" }, "alertInfo": { "type": "object", "$ref": "#/definitions/structs.AlertInfo" }, "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dataPropertyRights": { "type": "integer" }, "id": { "type": "string" }, "internalReadUri": { "type": "string" }, "lastScaleTime": { "type": "object", "additionalProperties": { "type": "string" } }, "monitorInfo": { "type": "object", "$ref": "#/definitions/structs.MonitorInfo" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "openReadUri": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "shareMode": { "type": "string" }, "status": { "type": "string" }, "storageInfo": { "type": "array", "items": { "$ref": "#/definitions/structs.StorageInfo" } }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } } }, "message.CreateClusterUpgradeReq": { "type": "object", "required": [ "cloudProvider", "k8sClusterName", "region", "targetVersion" ], "properties": { "cloudProvider": { "description": "CloudProvider is the cloud provider type (eks, gke, aks, ack, mock)", "type": "string" }, "clusterAddons": { "description": "ClusterAddons is the list of addons to upgrade", "type": "array", "items": { "$ref": "#/definitions/message.AddonUpgradeConfig" } }, "k8sClusterName": { "description": "K8sClusterName is the name of the target Kubernetes cluster", "type": "string" }, "nodeGroupUpgrades": { "description": "NodeGroupUpgrade configures node group upgrade with node group name and strategy bound together", "type": "array", "items": { "$ref": "#/definitions/message.NodeGroupUpgradeConfig" } }, "region": { "description": "Region is the cloud region where the cluster is located", "type": "string" }, "schedule": { "description": "Schedule is the time to start the upgrade (optional, defaults to now)", "type": "string" }, "targetVersion": { "description": "TargetVersion is the target K8s version to upgrade to", "type": "string" } } }, "message.CreateClusterUpgradeResp": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } } }, "message.CreateHelmReleaseReq": { "type": "object", "required": [ "component", "name", "namespace" ], "properties": { "component": { "description": "Pre-defined component name (e.g., \"loki-ha\", \"kube-prometheus-stack\")", "type": "string" }, "config": { "type": "object", "$ref": "#/definitions/message.HelmReleaseConfig" }, "name": { "description": "Name is the name of the HelmRelease, it will be used as the release name", "type": "string" }, "namespace": { "description": "Namespace is the namespace of the HelmRelease, it will be used as the target namespace", "type": "string" } } }, "message.CreateHelmReleaseResp": { "type": "object", "properties": { "component": { "type": "string" }, "config": { "type": "object", "$ref": "#/definitions/message.HelmReleaseConfig" }, "createTime": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "status": { "type": "object", "$ref": "#/definitions/message.HelmReleaseStatusSummary" } } }, "message.CreateIntegrationTaskReq": { "type": "object", "required": [ "dataType", "displayName" ], "properties": { "accessPrincipal": { "type": "string" }, "dataFormat": { "type": "string", "default": "gzip-csv" }, "dataPrefix": { "description": "DataPrefix is used for object storage destination, representing the prefix of the object key where the data will be stored.\nFor example, if DataPrefix is \"logs/\", the actual object key might be \"logs/cluster1/slowquery-20240101.csv.gz\".", "type": "string" }, "dataType": { "type": "string" }, "displayName": { "type": "string" }, "endTime": { "type": "string" }, "frequency": { "type": "string", "default": "10m" }, "jobType": { "type": "string", "default": "Once" }, "rawLogComponents": { "type": "array", "items": { "type": "string" } }, "startTime": { "type": "string" } } }, "message.CreateIntegrationTaskResp": { "type": "object", "properties": { "accessPrincipal": { "type": "string" }, "clusterID": { "type": "string" }, "createTime": { "type": "string" }, "dataFormat": { "type": "string" }, "dataPrefix": { "type": "string" }, "dataType": { "type": "string" }, "destinationInfo": { "type": "object", "$ref": "#/definitions/message.DestinationInfo" }, "displayName": { "type": "string" }, "endTime": { "type": "string" }, "frequency": { "type": "string" }, "id": { "type": "string" }, "jobType": { "type": "string" }, "name": { "type": "string" }, "rawLogComponents": { "type": "array", "items": { "type": "string" } }, "startTime": { "type": "string" } } }, "message.CreateVMClusterReq": { "type": "object", "required": [ "name", "values" ], "properties": { "name": { "type": "string" }, "values": { "type": "object", "additionalProperties": true } } }, "message.CreateVMClusterResp": { "type": "object", "properties": { "create_time": { "type": "string" }, "endpoints": { "type": "object", "additionalProperties": { "type": "string" } }, "helm_release_info": { "type": "object", "$ref": "#/definitions/message.HelmReleaseInfo" }, "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "values": { "type": "object", "additionalProperties": true } } }, "message.DeleteAlertRulesTemplateReq": { "type": "object", "required": [ "id", "region", "vendor" ], "properties": { "id": { "type": "string" }, "region": { "type": "string" }, "vendor": { "type": "string" } } }, "message.DeleteAlertRulesTemplateResp": { "type": "object", "required": [ "monitorPromRules" ], "properties": { "monitorPromRules": { "type": "object" } } }, "message.DeleteClusterReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "agentAccessARN": { "type": "string" }, "bizType": { "type": "string" }, "region": { "type": "string" }, "vendor": { "type": "string" } } }, "message.DeleteClusterResp": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dataPropertyRights": { "type": "integer" }, "id": { "type": "string" }, "internalReadUri": { "type": "string" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "openReadUri": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "shareMode": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } } }, "message.DeleteClusterUpgradeResp": { "type": "object", "properties": { "message": { "type": "string" } } }, "message.DeleteHelmReleaseResp": { "type": "object", "properties": { "message": { "type": "string" } } }, "message.DeleteIntegrationTaskReq": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "message.DeleteIntegrationTaskResp": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string" } } }, "message.DeleteVMClusterResp": { "type": "object", "properties": { "message": { "type": "string" } } }, "message.DestinationInfo": { "type": "object", "properties": { "accessPoint": { "type": "string" }, "assumeRoleARN": { "type": "string" } } }, "message.DetailClusterReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "bizType": { "type": "string" }, "region": { "type": "string" }, "vendor": { "type": "string" } } }, "message.DetailClusterResp": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "agentInfo": { "type": "object", "$ref": "#/definitions/structs.AgentInfo" }, "alertInfo": { "type": "object", "$ref": "#/definitions/structs.AlertInfo" }, "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dataPropertyRights": { "type": "integer" }, "id": { "type": "string" }, "internalReadUri": { "type": "string" }, "lastScaleTime": { "type": "object", "additionalProperties": { "type": "string" } }, "monitorInfo": { "type": "object", "$ref": "#/definitions/structs.MonitorInfo" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "openReadUri": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "shareMode": { "type": "string" }, "status": { "type": "string" }, "storageInfo": { "type": "array", "items": { "$ref": "#/definitions/structs.StorageInfo" } }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } } }, "message.DetailIntegrationTaskReq": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "message.DetailIntegrationTaskResp": { "type": "object", "properties": { "accessPrincipal": { "type": "string" }, "clusterID": { "type": "string" }, "createTime": { "type": "string" }, "dataFormat": { "type": "string" }, "dataPrefix": { "type": "string" }, "dataType": { "type": "string" }, "destinationInfo": { "type": "object", "$ref": "#/definitions/message.DestinationInfo" }, "displayName": { "type": "string" }, "endTime": { "type": "string" }, "frequency": { "type": "string" }, "id": { "type": "string" }, "jobType": { "type": "string" }, "name": { "type": "string" }, "phase": { "type": "string" }, "rawLogComponents": { "type": "array", "items": { "type": "string" } }, "startTime": { "type": "string" } } }, "message.DiffHelmReleaseReq": { "type": "object", "required": [ "component", "name", "namespace" ], "properties": { "adoptionMode": { "type": "boolean" }, "component": { "type": "string" }, "config": { "type": "object", "$ref": "#/definitions/message.HelmReleaseConfig" }, "name": { "type": "string" }, "namespace": { "type": "string" } } }, "message.DiffHelmReleaseResp": { "type": "object", "properties": { "blockingReasons": { "type": "array", "items": { "type": "string" } }, "component": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "renderedDiff": { "type": "object", "$ref": "#/definitions/message.HelmReleaseRenderedDiff" }, "safeToApply": { "type": "boolean" }, "sourceResolution": { "type": "object", "$ref": "#/definitions/message.HelmReleaseSourceResolution" }, "warnings": { "type": "array", "items": { "type": "string" } } } }, "message.DryRunClusterUpgradeResp": { "type": "object", "properties": { "clusterUpgradeOperation": { "type": "object", "$ref": "#/definitions/v1.ClusterUpgradeOperation" } } }, "message.ExternalAlertConfig": { "type": "object", "properties": { "ruleTemplateID": { "type": "string" } } }, "message.ExternalKeyVisualConfig": { "type": "object", "properties": { "openReadUri": { "type": "string" } } }, "message.ExternalLogsConfig": { "type": "object", "properties": { "openReadUri": { "type": "string" } } }, "message.ExternalMetricsConfig": { "type": "object", "properties": { "openReadUri": { "type": "string" } } }, "message.ExternalSlowQueryConfig": { "type": "object", "properties": { "openReadUri": { "type": "string" } } }, "message.ExternalSqlStatementsConfig": { "type": "object", "properties": { "openReadUri": { "type": "string" } } }, "message.GetClusterExternalResp": { "type": "object", "properties": { "alerts": { "type": "object", "$ref": "#/definitions/message.ExternalAlertConfig" }, "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "id": { "type": "string" }, "keyVisual": { "type": "object", "$ref": "#/definitions/message.ExternalKeyVisualConfig" }, "logs": { "type": "object", "$ref": "#/definitions/message.ExternalLogsConfig" }, "metrics": { "type": "object", "$ref": "#/definitions/message.ExternalMetricsConfig" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "slowQuery": { "type": "object", "$ref": "#/definitions/message.ExternalSlowQueryConfig" }, "sqlStatements": { "type": "object", "$ref": "#/definitions/message.ExternalSqlStatementsConfig" }, "tenantID": { "type": "string" }, "vendor": { "type": "string" } } }, "message.GetClusterUpgradeResp": { "type": "object", "properties": { "beginTime": { "type": "string" }, "cloudProvider": { "type": "string" }, "currentStep": { "type": "object", "$ref": "#/definitions/message.StepStatus" }, "currentVersion": { "type": "string" }, "duration": { "type": "string" }, "endTime": { "type": "string" }, "id": { "type": "string" }, "k8sClusterName": { "type": "string" }, "name": { "type": "string" }, "nextSteps": { "type": "array", "items": { "$ref": "#/definitions/message.StepStatus" } }, "region": { "type": "string" }, "status": { "type": "string" }, "succeededSteps": { "type": "array", "items": { "$ref": "#/definitions/message.StepStatus" } }, "targetVersion": { "type": "string" } } }, "message.GetHelmReleaseResp": { "type": "object", "properties": { "component": { "type": "string" }, "config": { "type": "object", "$ref": "#/definitions/message.HelmReleaseConfig" }, "createTime": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "status": { "type": "object", "$ref": "#/definitions/message.HelmReleaseStatusSummary" }, "updateTime": { "type": "string" } } }, "message.GetNodeGroupsResp": { "type": "object", "properties": { "nodeGroups": { "type": "array", "items": { "$ref": "#/definitions/message.NodeGroupInfo" } } } }, "message.GetServiceHealthResp": { "type": "object", "properties": { "serviceHealth": { "type": "boolean" } } }, "message.GetServiceInfoResp": { "type": "object", "properties": { "availableSpecs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/k8sv1.ResourceRequirements" } }, "serviceName": { "type": "string" } } }, "message.GetVMClusterResp": { "type": "object", "properties": { "create_time": { "type": "string" }, "endpoints": { "type": "object", "additionalProperties": { "type": "string" } }, "helm_release_info": { "type": "object", "$ref": "#/definitions/message.HelmReleaseInfo" }, "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "update_time": { "type": "string" }, "values": { "type": "object", "additionalProperties": true } } }, "message.GlobalHandleAlertReq": { "type": "object", "properties": { "alerts": { "type": "array", "items": { "$ref": "#/definitions/structs.Alert" } }, "commonAnnotations": { "type": "object", "additionalProperties": { "type": "string" } }, "commonLabels": { "type": "object", "additionalProperties": { "type": "string" } }, "externalURL": { "type": "string" }, "groupKey": { "type": "string" }, "groupLabels": { "type": "object", "additionalProperties": { "type": "string" } }, "receiver": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "string" } } }, "message.GlobalHandleAlertResp": { "type": "object" }, "message.HelmReleaseConfig": { "type": "object", "properties": { "dependsOn": { "description": "Names of HelmReleases this depends on", "type": "array", "items": { "type": "string" } }, "expectedDigest": { "description": "Expected chart digest", "type": "string" }, "interval": { "description": "Interval for reconciliation (e.g., \"5m\")", "type": "string" }, "sourceRef": { "description": "Reference to Helm repository", "type": "object", "$ref": "#/definitions/message.HelmReleaseSourceRef" }, "suspend": { "description": "Whether to suspend reconciliation", "type": "boolean" }, "timeout": { "description": "Timeout for operations (e.g., \"5m\")", "type": "string" }, "values": { "description": "Chart values override", "type": "object", "additionalProperties": true }, "version": { "description": "Version of the chart to install", "type": "string" } } }, "message.HelmReleaseConfigSummary": { "type": "object", "properties": { "dependsOn": { "type": "array", "items": { "type": "string" } }, "suspend": { "type": "boolean" }, "targetNamespace": { "type": "string" } } }, "message.HelmReleaseInfo": { "type": "object", "properties": { "chart": { "type": "string" }, "release_name": { "type": "string" }, "release_namespace": { "type": "string" }, "version": { "type": "string" } } }, "message.HelmReleaseRenderedDiff": { "type": "object", "properties": { "changed": { "type": "boolean" }, "output": { "type": "string" }, "resolvedDigest": { "type": "string" } } }, "message.HelmReleaseSourceRef": { "type": "object", "properties": { "kind": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "url": { "type": "string" } } }, "message.HelmReleaseSourceResolution": { "type": "object", "properties": { "chart": { "type": "string" }, "expectedDigest": { "type": "string" }, "resolvedDigest": { "type": "string" }, "sourceKind": { "type": "string" }, "sourceName": { "type": "string" }, "sourceNamespace": { "type": "string" }, "version": { "type": "string" } } }, "message.HelmReleaseStatusSummary": { "type": "object", "properties": { "expectedDigest": { "type": "string" }, "failures": { "type": "integer" }, "helmChart": { "type": "string" }, "lastAppliedRevision": { "type": "string" }, "lastAttemptedRevision": { "type": "string" }, "lastFailureReason": { "type": "string" }, "lastReleaseRevision": { "type": "integer" }, "observedGeneration": { "type": "integer" }, "requestedVersion": { "type": "string" }, "resolvedDigest": { "type": "string" } } }, "message.HelmReleaseSummary": { "type": "object", "properties": { "component": { "type": "string" }, "config": { "type": "object", "$ref": "#/definitions/message.HelmReleaseConfigSummary" }, "createTime": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "status": { "type": "object", "$ref": "#/definitions/message.HelmReleaseStatusSummary" }, "updateTime": { "type": "string" } } }, "message.IntegrationTaskSummary": { "type": "object", "properties": { "accessPrincipal": { "type": "string" }, "createTime": { "type": "string" }, "dataFormat": { "type": "string" }, "dataPrefix": { "type": "string" }, "dataType": { "type": "string" }, "destinationInfo": { "type": "object", "$ref": "#/definitions/message.DestinationInfo" }, "endTime": { "type": "string" }, "frequency": { "type": "string" }, "id": { "type": "string" }, "jobType": { "type": "string" }, "phase": { "type": "string" }, "rawLogComponents": { "type": "array", "items": { "type": "string" } }, "startTime": { "type": "string" } } }, "message.ListAddonsResp": { "type": "object", "properties": { "addons": { "type": "array", "items": { "$ref": "#/definitions/message.AddonInfo" } } } }, "message.ListClusterUpgradesReq": { "type": "object", "properties": { "continueToken": { "type": "string" }, "k8sClusterName": { "type": "string" }, "limit": { "type": "integer" }, "status": { "type": "string" } } }, "message.ListClusterUpgradesResp": { "type": "object", "properties": { "clusterUpgrades": { "type": "array", "items": { "$ref": "#/definitions/message.ClusterUpgradeSummary" } }, "continueToken": { "type": "string" }, "remainingItemCount": { "type": "integer" } } }, "message.ListClustersWithMetadataResp": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/definitions/message.ClusterWithInfra" } }, "partial": { "type": "boolean" } } }, "message.ListHelmReleasesReq": { "type": "object", "properties": { "continueToken": { "type": "string" }, "limit": { "type": "integer" } } }, "message.ListHelmReleasesResp": { "type": "object", "properties": { "continueToken": { "type": "string" }, "helmReleases": { "type": "array", "items": { "$ref": "#/definitions/message.HelmReleaseSummary" } }, "remainingItemCount": { "type": "integer" } } }, "message.ListVMClustersReq": { "type": "object", "properties": { "page": { "description": "Current page location", "type": "integer" }, "pageSize": { "description": "Number of this request", "type": "integer" } } }, "message.ListVMClustersResp": { "type": "object", "properties": { "continueToken": { "type": "string" }, "remainingItemCount": { "type": "integer" }, "vmclusters": { "type": "array", "items": { "$ref": "#/definitions/message.VMClusterSummary" } } } }, "message.ModifyAgentObservedReq": { "type": "object", "required": [ "observed", "region", "vendor" ], "properties": { "observed": { "type": "object", "$ref": "#/definitions/structs.Observed" }, "region": { "type": "string" }, "vendor": { "type": "string" } } }, "message.ModifyAgentObservedResp": { "type": "object" }, "message.ModifyAlertRulesTemplateReq": { "type": "object", "required": [ "monitorPromRules", "region", "templateID", "vendor" ], "properties": { "monitorPromRules": { "type": "object" }, "region": { "type": "string" }, "templateID": { "type": "string" }, "vendor": { "type": "string" } } }, "message.ModifyAlertRulesTemplateResp": { "type": "object" }, "message.ModifyMonitorModeReq": { "type": "object", "required": [ "region", "shareMode", "vendor" ], "properties": { "region": { "type": "string" }, "shareMode": { "type": "string" }, "vendor": { "type": "string" } } }, "message.ModifyMonitorModeResp": { "type": "object" }, "message.ModifyMonitorResourceReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "region": { "type": "string" }, "resourceMeta": { "type": "object", "additionalProperties": { "$ref": "#/definitions/message.ResourceMeta" } }, "resourceType": { "type": "string" }, "vendor": { "type": "string" } } }, "message.ModifyMonitorResourceResp": { "type": "object" }, "message.ModifyMonitorSpecReq": { "type": "object", "required": [ "region", "specID", "vendor" ], "properties": { "region": { "type": "string" }, "specID": { "type": "string" }, "vendor": { "type": "string" } } }, "message.ModifyMonitorSpecResp": { "type": "object" }, "message.ModifyMonitorStorageReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "PVCName": { "type": "string" }, "namespace": { "type": "string" }, "region": { "type": "string" }, "request": { "type": "string" }, "vendor": { "type": "string" } } }, "message.ModifyMonitorStorageResp": { "type": "object" }, "message.MuteClusterAlertReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "region": { "type": "string" }, "vendor": { "type": "string" } } }, "message.MuteClusterAlertResp": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dataPropertyRights": { "type": "integer" }, "id": { "type": "string" }, "internalReadUri": { "type": "string" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "openReadUri": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "shareMode": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } } }, "message.NodeGroupInfo": { "type": "object", "properties": { "id": { "type": "string" }, "launchTemplateId": { "description": "LaunchTemplateId is set for EKS node groups that use a launch template with an ID.", "type": "string" }, "launchTemplateName": { "description": "LaunchTemplateName is set for EKS node groups that use a launch template with a name.", "type": "string" }, "launchTemplateVersion": { "description": "LaunchTemplateVersion is set for EKS node groups that use a launch template.", "type": "string" }, "name": { "type": "string" }, "nodeCount": { "type": "integer" }, "runtimeVersion": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "string" } } }, "message.NodeGroupUpgradeConfig": { "type": "object", "required": [ "nodeGroupName", "requiresVMStorageRollout", "strategy" ], "properties": { "launchTemplateId": { "description": "LaunchTemplateId identifies the EKS launch template to use for the in-place upgrade.", "type": "string" }, "launchTemplateName": { "description": "LaunchTemplateName identifies the EKS launch template when launchTemplateId is not provided.", "type": "string" }, "launchTemplateVersion": { "description": "LaunchTemplateVersion is required for EKS in-place upgrades when the node group's launch template specifies a custom AMI.", "type": "string" }, "newNodeGroupName": { "description": "NewNodeGroupName is the name for the new node group in blue-green upgrade. Optional; if empty, a random 8-char lowercase name is used.", "type": "string" }, "nodeGroupName": { "description": "NodeGroupName is the name of the node group to upgrade", "type": "string" }, "requiresVMStorageRollout": { "description": "RequiresVMStorageRollout indicates if this blue-green node group upgrade should trigger the VMStorage rollout flow", "type": "boolean", "default": false }, "runtimeType": { "description": "RuntimeType is the current Kubernetes runtime type of the node group", "type": "string" }, "strategy": { "description": "Strategy is the upgrade strategy for nodegroups (\"blue-green\" or \"in-place\")", "type": "string" }, "targetRuntimeVersion": { "description": "TargetRuntimeVersion is the target Kubernetes runtime version to upgrade to", "type": "string" }, "vmClusterHelmValues": { "description": "VMClusterHelmValues contains a VMCluster.spec overlay to apply during VMStorage rollout.\nUse an empty object when the rollout should not change VMCluster spec.", "type": "object", "additionalProperties": true }, "vmstorageSTSName": { "description": "VMStorageSTSName is the name of the vmstorage StatefulSet to observe rollout status", "type": "string", "default": "vmstorage-vmcluster" }, "vmstorageSTSNamespace": { "description": "VMStorageSTSNamespace is the namespace of the vmstorage StatefulSet to observe rollout status", "type": "string", "default": "observability" } } }, "message.OpenAlertConfig": { "type": "object", "properties": { "ruleTemplateID": { "type": "string" }, "status": { "type": "string" } } }, "message.OpenAlertRule": { "type": "object" }, "message.OpenAlertRuleTemplate": { "type": "object", "properties": { "desc": { "type": "string" }, "id": { "type": "string" } } }, "message.OpenAlertRuleTemplateList": { "type": "object", "properties": { "templates": { "type": "array", "items": { "$ref": "#/definitions/message.OpenAlertRuleTemplate" } } } }, "message.OpenClusterListResponse": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/definitions/message.OpenObservabilityCluster" } }, "next_page_token": { "type": "string" } } }, "message.OpenCreateClusterRequest": { "type": "object", "required": [ "agentAccessARN", "agentManagerARN", "applicationID", "projectID" ], "properties": { "agentAccessARN": { "type": "string" }, "agentManagerARN": { "type": "string" }, "applicationID": { "type": "string" }, "note": { "type": "string" }, "projectID": { "type": "string" }, "ruleTemplateID": { "type": "string" }, "shareMode": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "message.OpenLogsConfig": { "type": "object", "properties": { "dataRetention": { "type": "integer" }, "status": { "type": "string" } } }, "message.OpenMetricsConfig": { "type": "object", "properties": { "dataRetention": { "type": "integer" }, "queryEndpoint": { "type": "string" }, "status": { "type": "string" } } }, "message.OpenModuleConfigRequest": { "type": "object", "required": [ "retention" ], "properties": { "retention": { "type": "integer" } } }, "message.OpenModuleStatusRequest": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string" } } }, "message.OpenObservabilityCluster": { "type": "object", "properties": { "agentRoleARN": { "type": "string" }, "alerts": { "type": "object", "$ref": "#/definitions/message.OpenAlertConfig" }, "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dnsName": { "type": "string" }, "endpointServiceName": { "type": "string" }, "id": { "type": "string" }, "logs": { "type": "object", "$ref": "#/definitions/message.OpenLogsConfig" }, "metrics": { "type": "object", "$ref": "#/definitions/message.OpenMetricsConfig" }, "note": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "ruleTemplateID": { "type": "string" }, "share_mode": { "type": "string" }, "status": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" } } }, "message.PauseClusterReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "region": { "type": "string" }, "vendor": { "type": "string" } } }, "message.PauseClusterResp": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dataPropertyRights": { "type": "integer" }, "id": { "type": "string" }, "internalReadUri": { "type": "string" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "openReadUri": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "shareMode": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } } }, "message.PauseClusterUpgradeResp": { "type": "object", "properties": { "message": { "type": "string" } } }, "message.QueryAlertRulesByCloudUserResp": { "type": "object", "properties": { "alertRuleList": { "type": "array", "items": { "$ref": "#/definitions/structs.AlertRuleGroup" } } } }, "message.QueryAlertRulesReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "region": { "type": "string" }, "vendor": { "type": "string" } } }, "message.QueryAlertRulesTemplateReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "region": { "type": "string" }, "vendor": { "type": "string" } } }, "message.QueryAlertRulesTemplateResp": { "type": "object", "required": [ "monitorPromRules" ], "properties": { "monitorPromRules": { "type": "object" } } }, "message.QueryClustersReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "continueToken": { "type": "string" }, "limit": { "type": "integer" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "showDeleted": { "type": "boolean" }, "tenantID": { "type": "string" }, "vendor": { "type": "string" } } }, "message.QueryClustersResp": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/definitions/structs.ClusterBaseInfo" } }, "continueToken": { "type": "string" }, "partial": { "type": "boolean" }, "remainingItemCount": { "type": "integer" } } }, "message.QueryExternalAlertsReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "endTime": { "description": "endTime of alerts, unix timestamp", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "region": { "type": "string" }, "severity": { "description": "severity with lowercase, oneof warning, critical", "type": "string" }, "startTime": { "description": "startTime of alerts, unix timestamp", "type": "integer" }, "status": { "description": "alert state with lowercase, one of active closed all", "type": "string" }, "vendor": { "type": "string" } } }, "message.QueryExternalAlertsResp": { "type": "object", "properties": { "alerts": { "type": "array", "items": { "$ref": "#/definitions/structs.UserAlertInfo" } }, "total": { "type": "integer" } } }, "message.QueryIntegrationTasksReq": { "type": "object", "properties": { "dataType": { "type": "string" }, "pageSize": { "type": "integer" }, "pageToken": { "type": "string" } } }, "message.QueryIntegrationTasksResp": { "type": "object", "properties": { "nextPageToken": { "type": "string" }, "pipelines": { "type": "array", "items": { "$ref": "#/definitions/message.IntegrationTaskSummary" } }, "totalSize": { "type": "integer" } } }, "message.ResourceMeta": { "type": "object", "properties": { "PVCName": { "type": "string" }, "namespace": { "type": "string" }, "request": { "type": "string" }, "specID": { "type": "string" } } }, "message.Result": { "type": "object", "properties": { "code": { "description": "http error code", "type": "integer" }, "data": { "description": "The returned content, storage in JSON format", "type": "object" }, "message": { "description": "http error msg", "type": "string" } } }, "message.ResumeClusterReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "region": { "type": "string" }, "vendor": { "type": "string" } } }, "message.ResumeClusterResp": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dataPropertyRights": { "type": "integer" }, "id": { "type": "string" }, "internalReadUri": { "type": "string" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "openReadUri": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "shareMode": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } } }, "message.ResumeClusterUpgradeResp": { "type": "object", "properties": { "message": { "type": "string" } } }, "message.StepStatus": { "type": "object", "properties": { "beginTime": { "type": "string" }, "duration": { "type": "string" }, "endTime": { "type": "string" }, "processor": { "type": "string" }, "status": { "type": "string" } } }, "message.UnmuteClusterAlertReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "region": { "type": "string" }, "vendor": { "type": "string" } } }, "message.UnmuteClusterAlertResp": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dataPropertyRights": { "type": "integer" }, "id": { "type": "string" }, "internalReadUri": { "type": "string" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "openReadUri": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "shareMode": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } } }, "message.UpdateAlertRulesByCloudUserReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "alertRules": { "type": "object", "additionalProperties": { "$ref": "#/definitions/structs.AlertRuleBase" } }, "region": { "type": "string" }, "vendor": { "type": "string" } } }, "message.UpdateAlertRulesByCloudUserResp": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "$ref": "#/definitions/structs.UpdateAlertRule" } } } }, "message.UpdateBasicAuthReq": { "type": "object", "required": [ "password", "username" ], "properties": { "password": { "type": "string" }, "username": { "type": "string" } } }, "message.UpdateBasicAuthResp": { "type": "object" }, "message.UpdateClusterReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "monitorSpecID": { "type": "string" }, "muteAlert": { "type": "boolean" }, "region": { "type": "string" }, "ruleTemplateID": { "type": "string" }, "vendor": { "type": "string" } } }, "message.UpdateClusterResp": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dataPropertyRights": { "type": "integer" }, "id": { "type": "string" }, "internalReadUri": { "type": "string" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "openReadUri": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "shareMode": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } } }, "message.UpdateHelmReleaseReq": { "type": "object", "required": [ "component", "name" ], "properties": { "component": { "description": "Pre-defined component name", "type": "string" }, "config": { "type": "object", "$ref": "#/definitions/message.HelmReleaseConfig" }, "name": { "type": "string" } } }, "message.UpdateHelmReleaseResp": { "type": "object", "properties": { "component": { "type": "string" }, "config": { "type": "object", "$ref": "#/definitions/message.HelmReleaseConfig" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "status": { "type": "object", "$ref": "#/definitions/message.HelmReleaseStatusSummary" }, "updateTime": { "type": "string" } } }, "message.UpdateIntegrationTaskReq": { "type": "object", "required": [ "id" ], "properties": { "dataFormat": { "type": "string" }, "frequency": { "type": "string" }, "id": { "type": "string" } } }, "message.UpdateIntegrationTaskResp": { "type": "object", "properties": { "accessPrincipal": { "type": "string" }, "clusterID": { "type": "string" }, "createTime": { "type": "string" }, "dataFormat": { "type": "string" }, "dataPrefix": { "type": "string" }, "dataType": { "type": "string" }, "destinationInfo": { "type": "object", "$ref": "#/definitions/message.DestinationInfo" }, "displayName": { "type": "string" }, "endTime": { "type": "string" }, "frequency": { "type": "string" }, "id": { "type": "string" }, "jobType": { "type": "string" }, "name": { "type": "string" }, "phase": { "type": "string" }, "rawLogComponents": { "type": "array", "items": { "type": "string" } }, "startTime": { "type": "string" } } }, "message.UpdateVMClusterReq": { "type": "object", "required": [ "id", "values" ], "properties": { "id": { "type": "string" }, "values": { "type": "object", "additionalProperties": true } } }, "message.UpdateVMClusterResp": { "type": "object", "properties": { "endpoints": { "type": "object", "additionalProperties": { "type": "string" } }, "helm_release_info": { "type": "object", "$ref": "#/definitions/message.HelmReleaseInfo" }, "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "update_time": { "type": "string" }, "values": { "type": "object", "additionalProperties": true } } }, "message.VMClusterSummary": { "type": "object", "properties": { "create_time": { "type": "string" }, "endpoints": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "update_time": { "type": "string" } } }, "structs.AWSAgentEnvironment": { "type": "object", "properties": { "account": { "type": "string" }, "nodeSubnetIDs": { "type": "array", "items": { "type": "string" } }, "oidc": { "type": "string" }, "securityGroupID": { "type": "string" }, "vpcID": { "type": "string" } } }, "structs.AgentEnvironment": { "type": "object", "properties": { "aliCloud": { "type": "object", "$ref": "#/definitions/structs.AliCloudAgentEnvironment" }, "aws": { "type": "object", "$ref": "#/definitions/structs.AWSAgentEnvironment" }, "azure": { "type": "object", "$ref": "#/definitions/structs.AzureAgentEnvironment" }, "dataplane": { "type": "object", "$ref": "#/definitions/structs.Dataplane" }, "gcp": { "type": "object", "$ref": "#/definitions/structs.GCPAgentEnvironment" }, "releaseNameSpace": { "type": "string" } } }, "structs.AgentInfo": { "type": "object", "properties": { "roleARN": { "description": "o11y role for agents", "type": "string" } } }, "structs.Alert": { "type": "object", "properties": { "annotations": { "type": "object", "additionalProperties": { "type": "string" } }, "endsAt": { "type": "string" }, "generatorURL": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "startsAt": { "type": "string" }, "status": { "type": "string" } } }, "structs.AlertInfo": { "type": "object", "properties": { "muteAlert": { "type": "boolean" }, "ruleTemplateID": { "type": "string" } } }, "structs.AlertRuleBase": { "type": "object", "properties": { "alertRuleID": { "type": "string" }, "for": { "type": "integer" }, "status": { "type": "string" }, "threshold": { "type": "number" } } }, "structs.AlertRuleDetail": { "type": "object", "properties": { "alert": { "type": "string" }, "alertRuleID": { "type": "string" }, "canEdit": { "type": "string" }, "defaultFor": { "type": "number" }, "defaultThreshold": { "type": "number" }, "for": { "type": "integer" }, "monitorTarget": { "type": "string" }, "operator": { "type": "string" }, "sortID": { "type": "integer" }, "status": { "type": "string" }, "threshold": { "type": "number" } } }, "structs.AlertRuleGroup": { "type": "object", "properties": { "name": { "type": "string" }, "rules": { "type": "array", "items": { "$ref": "#/definitions/structs.AlertRuleDetail" } } } }, "structs.AliCloudAgentEnvironment": { "type": "object", "properties": { "account": { "type": "string" }, "nodeSubnetIDs": { "type": "array", "items": { "type": "string" } }, "oidc": { "type": "string" }, "securityGroupID": { "type": "string" }, "vpcID": { "type": "string" } } }, "structs.AzureAgentEnvironment": { "type": "object", "properties": { "networkName": { "type": "string" }, "oidc": { "description": "AKS OIDC issuer used for creating federated identity", "type": "string" }, "resourceGroup": { "type": "string" }, "subnet": { "description": "Subnet where private endpoint should be created", "type": "string" }, "subscriptionID": { "type": "string" } } }, "structs.ClusterBaseInfo": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dataPropertyRights": { "type": "integer" }, "id": { "type": "string" }, "internalReadUri": { "type": "string" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "openReadUri": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "shareMode": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tenantID": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } } }, "structs.ClusterTopologyType": { "type": "object", "properties": { "pd": { "type": "object", "$ref": "#/definitions/structs.PD" }, "tidb": { "type": "object", "$ref": "#/definitions/structs.TiDB" }, "tiflash": { "type": "object", "$ref": "#/definitions/structs.TiFlash" }, "tikv": { "type": "object", "$ref": "#/definitions/structs.TiKV" } } }, "structs.Dataplane": { "type": "object", "properties": { "clusterCAData": { "description": "+optional", "type": "string" }, "clusterEndpoint": { "description": "+optional", "type": "string" }, "clusterKubeConfig": { "description": "+optional\nbase64-encoded kubeconfig data", "type": "string" }, "clusterName": { "type": "string" } } }, "structs.GCPAgentEnvironment": { "type": "object", "properties": { "gcpProject": { "type": "string" }, "networkName": { "type": "string" }, "subnets": { "type": "array", "items": { "type": "string" } } } }, "structs.MonitorInfo": { "type": "object", "properties": { "dnsName": { "type": "string" }, "endpointServiceName": { "description": "Storage string ` + "`" + `json:\"storage\" form:\"storage\"` + "`" + `", "type": "string" }, "specID": { "type": "string" }, "vmAccountID": { "type": "string" }, "vmProjectID": { "type": "string" } } }, "structs.Observed": { "type": "object", "properties": { "clusterTopology": { "type": "object", "$ref": "#/definitions/structs.ClusterTopologyType" }, "tidbVersion": { "type": "string" } } }, "structs.PD": { "type": "object", "properties": { "replicas": { "type": "integer" } } }, "structs.RegionalRouter": { "type": "object", "properties": { "accessExternalID": { "description": "external id used to access regional, e.g. external id used to access aws api gateway", "type": "string" }, "accessPrincipal": { "description": "principal used to access regional, e.g. aws-role-arn used to access aws api gateway", "type": "string" }, "dataplaneAddress": { "description": "Address of regional data plane.", "type": "string" }, "dnsAddress": { "description": "Address of regional control plane.", "type": "string" }, "logicalRegionName": { "type": "string" }, "primary": { "type": "boolean" } } }, "structs.StorageInfo": { "type": "object", "properties": { "bucketName": { "type": "string" }, "category": { "type": "string" }, "dataARN": { "type": "string" }, "objectPath": { "type": "string" }, "storageAccount": { "description": "Keep the Go field name for compatibility while the public API stays on storageAccount.", "type": "string" } } }, "structs.TiDB": { "type": "object", "properties": { "replicas": { "type": "integer" } } }, "structs.TiFlash": { "type": "object", "properties": { "replicas": { "type": "integer" } } }, "structs.TiKV": { "type": "object", "properties": { "replicas": { "type": "integer" } } }, "structs.UpdateAlertRule": { "type": "object", "properties": { "alertName": { "type": "string" }, "for": { "type": "string" }, "oldFor": { "type": "string" }, "oldStatus": { "type": "string" }, "oldThreshold": { "type": "number" }, "status": { "type": "string" }, "threshold": { "type": "number" } } }, "structs.UserAlertInfo": { "type": "object", "properties": { "activeAt": { "type": "integer" }, "alertName": { "description": "alert name, the description label in alert rule.", "type": "string" }, "changefeed": { "type": "string" }, "duration": { "description": "duration time in seconds, e.g. 1h2m0s", "type": "string" }, "jobID": { "type": "string" }, "message": { "description": "alert message, the message label in alert rule.", "type": "string" }, "ruleName": { "description": "alert rule name, the alert name in alert rule.", "type": "string" }, "severity": { "type": "string" }, "status": { "type": "string" }, "value": { "type": "string" } } }, "v1.ClusterUpgradeOperation": { "type": "object", "properties": { "spec": { "type": "object", "$ref": "#/definitions/v1.ClusterUpgradeOperationSpec" }, "status": { "type": "object", "$ref": "#/definitions/v1.ClusterUpgradeOperationStatus" } } }, "v1.ClusterUpgradeOperationSpec": { "type": "object", "properties": { "cloudProvider": { "description": "+kubebuilder:validation:Required\n+kubebuilder:validation:Enum=eks;gke;aks;ack\nCloudProvider is the cloud provider of the cluster", "type": "string" }, "k8sClusterName": { "description": "+kubebuilder:validation:Required\nK8sClusterName is the name of the target Kubernetes cluster", "type": "string" }, "paused": { "description": "Paused indicates whether the operation is paused", "type": "boolean" }, "region": { "description": "+kubebuilder:validation:Required\nRegion is the cloud region where the cluster is located", "type": "string" }, "schedule": { "description": "+kubebuilder:validation:Required\nSchedule is the scheduled time to start the operation", "type": "string" }, "steps": { "description": "+kubebuilder:validation:Required\nSteps is the ordered list of upgrade steps to execute", "type": "object", "$ref": "#/definitions/v1.UpgradeSteps" }, "targetVersion": { "description": "+kubebuilder:validation:Required\nTargetVersion is the target Kubernetes version to upgrade to", "type": "string" }, "ttlSeconds": { "description": "+optional\nTTLSeconds is the time-to-live after completion before auto-deletion", "type": "string" } } }, "v1.ClusterUpgradeOperationStatus": { "type": "object", "properties": { "beginTime": { "description": "BeginTime is the time when the operation started", "type": "string" }, "currentStep": { "description": "CurrentStep is the step currently being executed", "type": "object", "$ref": "#/definitions/v1.UpgradeStep" }, "duration": { "description": "Duration is the human-readable duration of the operation", "type": "string" }, "endTime": { "description": "EndTime is the time when the operation completed", "type": "string" }, "nextSteps": { "description": "NextSteps is the queue of steps to be executed", "type": "object", "$ref": "#/definitions/v1.UpgradeSteps" }, "phase": { "description": "Phase describes the current phase of the upgrade operation", "type": "string" }, "succeededSteps": { "description": "SucceededSteps is the list of steps that have completed successfully", "type": "object", "$ref": "#/definitions/v1.UpgradeSteps" } } }, "v1.UpgradeStep": { "type": "object", "properties": { "beginTime": { "description": "+optional\nBeginTime is the time when this step started", "type": "string" }, "cloudOperationID": { "description": "+optional\nCloudOperationID stores the cloud provider's async operation ID (e.g. GKE Operation name) for polling.\nUsed when UpgradeNodeGroup returns an operation ID; we poll this to determine completion.", "type": "string" }, "duration": { "description": "+optional\nDuration is the human-readable duration of this step", "type": "string" }, "endTime": { "description": "+optional\nEndTime is the time when this step completed", "type": "string" }, "options": { "description": "+optional\nOptions contains processor-specific parameters", "type": "string" }, "processor": { "description": "+kubebuilder:validation:Required\n+kubebuilder:validation:Enum=upgrade-controlplane;upgrade-cluster-addons;upgrade-node-group\nProcessor is the name of the processor to execute", "type": "string" }, "subStep": { "description": "+optional\nSubStep is the current sub-step within this step (e.g. for blue-green node group: create-nodegroup, wait-ready, cordon, vmstorage-rollout, delete-old-nodegroup).", "type": "string" }, "subStepBeginTime": { "description": "+optional\nSubStepBeginTime is when the current sub-step started.", "type": "string" } } }, "v1.UpgradeSteps": { "type": "array", "items": { "$ref": "#/definitions/v1.UpgradeStep" } } } }` type swaggerInfo struct { Version string Host string BasePath string Schemes []string Title string Description string } // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = swaggerInfo{ Version: "1.0", Host: "localhost:8080", BasePath: "/api/v1/", Schemes: []string{}, Title: "Observability GlobalServer API", Description: "Observability GlobalServer API", } type s struct{} func (s *s) ReadDoc() string { sInfo := SwaggerInfo sInfo.Description = strings.Replace(sInfo.Description, "\n", "\\n", -1) t, err := template.New("swagger_info").Funcs(template.FuncMap{ "marshal": func(v interface{}) string { a, _ := json.Marshal(v) return string(a) }, }).Parse(doc) if err != nil { return doc } var tpl bytes.Buffer if err := t.Execute(&tpl, sInfo); err != nil { return doc } return tpl.String() } func init() { swag.Register(swag.Name, &s{}) }