{ "swagger": "2.0", "info": { "description": "Observability RegionalServer API", "title": "Observability RegionalServer API", "contact": { "name": "zhangpeijin", "email": "zhangpeijin@pingcap.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0" }, "host": "localhost:8081", "basePath": "/api/v1/", "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" } } } } }, "/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/logging/": { "post": { "description": "apply log alert rules template", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "apply log alert rules", "parameters": [ { "description": "apply log alert rules request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.ApplyLogAlertRulesReq" } } ], "responses": { "202": { "description": "Accepted", "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": "query alert rule template", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "query alert rule template", "parameters": [ { "type": "string", "description": "template id", "name": "id", "in": "path", "required": true }, { "description": "delete alert rule template", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.QueryAlertRulesTemplateReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.QueryAlertRulesTemplateResp" } } } ] } }, "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" } } } }, "delete": { "description": "delete alert rule template", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "delete alert rule template", "parameters": [ { "type": "string", "description": "template id", "name": "id", "in": "path", "required": true }, { "description": "delete alert rule template", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.DeleteAlertRulesTemplateReq" } } ], "responses": { "202": { "description": "Accepted", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.DeleteAlertRulesTemplateResp" } } } ] } }, "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" } } } } }, "/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}/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}/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" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/message.Result" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/message.Result" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/message.Result" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "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" } } } } }, "/auth/": { "get": { "description": "Routing and authentication for data link APIs", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "auth" ], "summary": "Routing and authentication for data link APIs", "parameters": [ { "type": "string", "name": "apiKey", "in": "query" }, { "type": "string", "name": "applicationID", "in": "query" }, { "type": "string", "name": "bizType", "in": "query" }, { "type": "boolean", "description": "for next-gen api, ignore project in path", "name": "ignoreProject", "in": "query" }, { "type": "string", "name": "path", "in": "query" }, { "type": "string", "name": "tenantID", "in": "query" }, { "type": "boolean", "description": "for next-gen api, use o11yID in path", "name": "useO11yID", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.AuthRouteResp" } } } ] } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/message.Result" } }, "500": { "description": "Internal Server Error", "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.QueryClustersWithStorageResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } }, "post": { "description": "create an observability cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "create an 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" } } } ] } }, "409": { "description": "Conflict", "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", "description": "bizType, for staging, use staging-tidbcloud, others, use tidbcloud", "name": "bizType", "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": { "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 }, { "type": "string", "description": "bizType, for staging, use staging-tidbcloud, others, use tidbcloud", "name": "bizType", "in": "query" }, { "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", "description": "bizType, for staging, use staging-tidbcloud, others, use tidbcloud", "name": "bizType", "in": "query" }, { "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" } }, "405": { "description": "Method Not Allowed", "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}/pause-reconcile": { "put": { "description": "Pause reconciliation of cluster", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cluster" ], "summary": "Pause reconciliation", "parameters": [ { "type": "string", "description": "cluster id", "name": "id", "in": "path", "required": true }, { "description": "pause reconciliation request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.PauseReconcileReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/message.Result" } }, "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}/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}/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": "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" } } } ] } }, "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": [ "external" ], "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": [ "external" ], "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" } } } } }, "/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" } } } } }, "/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 integration task 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" } } } ] } }, "409": { "description": "Conflict", "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", "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 integration task request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.UpdateIntegrationTaskReq" } } ], "responses": { "202": { "description": "Accepted", "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/monitoringPipelines": { "get": { "description": "query integration tasks for internal services", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "integrationtask" ], "summary": "query integration tasks (internal)", "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" } } } } }, "/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" } } } } }, "/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 integration task 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" } } } ] } }, "409": { "description": "Conflict", "schema": { "allOf": [ { "$ref": "#/definitions/message.Result" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.CreateIntegrationTaskResp" } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/message.Result" } } } } } }, "definitions": { "message.ApplyLogAlertRulesReq": { "type": "object", "required": [ "region", "rulesConfig", "vendor" ], "properties": { "region": { "type": "string" }, "rulesConfig": { "type": "object" }, "vendor": { "type": "string" } } }, "message.AuthRouteReq": { "type": "object", "properties": { "apiKey": { "type": "string" }, "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "ignoreProject": { "description": "for next-gen api, ignore project in path", "type": "boolean" }, "path": { "type": "string" }, "tenantID": { "type": "string" }, "useO11yID": { "description": "for next-gen api, use o11yID in path", "type": "boolean" } } }, "message.AuthRouteResp": { "type": "object", "properties": { "vmAccountID": { "type": "integer" }, "vmClusterName": { "type": "string" }, "vmProjectID": { "type": "integer" } } }, "message.BYOCVPCPeering": { "type": "object", "properties": { "dataplaneVpcCIDR": { "type": "string" }, "peeringConnectionID": { "type": "string" } } }, "message.ClusterWithStorageInfo": { "type": "object", "required": [ "applicationID", "bizType", "region", "shareMode", "tenantID", "vendor" ], "properties": { "applicationID": { "type": "string" }, "bizType": { "type": "string" }, "dataPropertyRights": { "type": "integer" }, "diagnosisQueryUri": { "type": "string" }, "id": { "type": "string" }, "internalReadUri": { "type": "string" }, "logQueryUri": { "type": "string" }, "multitenantQueryUri": { "description": "MultitenantQueryUri is an API v1 base URI that already includes encoded query parameters such as extra_filters[].", "type": "string" }, "muteAlert": { "type": "boolean" }, "note": { "type": "string" }, "openReadUri": { "type": "string" }, "projectID": { "type": "string" }, "region": { "type": "string" }, "shareMode": { "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.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.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.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.DeleteIntegrationTaskReq": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "message.DeleteIntegrationTaskResp": { "type": "object", "properties": { "id": { "type": "string" }, "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.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.GetServiceHealthResp": { "type": "object", "properties": { "serviceHealth": { "type": "boolean" } } }, "message.GetServiceInfoResp": { "type": "object", "properties": { "availableSpecs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/k8sv1.ResourceRequirements" } }, "serviceName": { "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.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.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.PauseReconcileReq": { "type": "object", "required": [ "region", "vendor" ], "properties": { "pauseCluster": { "type": "boolean" }, "region": { "type": "string" }, "vendor": { "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.QueryClustersWithStorageResp": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/definitions/message.ClusterWithStorageInfo" } }, "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.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.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.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" } } }, "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.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.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.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" } } } } }