// Package docs Code generated by swaggo/swag. DO NOT EDIT package docs import "github.com/swaggo/swag" const docTemplatedefault_server_api = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { "description": "{{escape .Description}}", "title": "{{.Title}}", "contact": {}, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/activityhub/applications/{application_id}/targets/{target_id}/activities": { "get": { "description": "list activities", "consumes": [ "application/json" ], "summary": "list activities", "parameters": [ { "type": "string", "description": "application_id", "name": "application_id", "in": "path", "required": true }, { "type": "string", "description": "target_id", "name": "target_id", "in": "path", "required": true }, { "type": "integer", "description": "begin_ts", "name": "begin_ts", "in": "query", "required": true }, { "type": "integer", "description": "end_ts", "name": "end_ts", "in": "query", "required": true }, { "type": "string", "description": "catalog", "name": "catalog", "in": "query" }, { "type": "string", "description": "type", "name": "type", "in": "query" }, { "type": "string", "description": "name", "name": "name", "in": "query" }, { "type": "integer", "description": "severity", "name": "severity", "in": "query" }, { "type": "integer", "description": "limit", "name": "limit", "in": "query" }, { "type": "string", "description": "coursor for page limit", "name": "cursor", "in": "header" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/activities.QueryActivitiesResponse" } } } } }, "/activityhub/applications/{application_id}/targets/{target_id}/activities/{activity_id}": { "get": { "description": "get activity", "consumes": [ "application/json" ], "summary": "get activity", "parameters": [ { "type": "string", "description": "application_id", "name": "application_id", "in": "path", "required": true }, { "type": "string", "description": "target_id", "name": "target_id", "in": "path", "required": true }, { "type": "string", "description": "activity id", "name": "activity_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/activities.GetActivityResponse" } } } } }, "/activityhub/applications/{application_id}/targets/{target_id}/activitygroups": { "get": { "description": "list activity groups", "consumes": [ "application/json" ], "summary": "list activity groups", "parameters": [ { "type": "string", "description": "application_id", "name": "application_id", "in": "path", "required": true }, { "type": "string", "description": "target_id", "name": "target_id", "in": "path", "required": true }, { "type": "integer", "description": "begin_ts", "name": "begin_ts", "in": "query", "required": true }, { "type": "integer", "description": "end_ts", "name": "end_ts", "in": "query", "required": true }, { "type": "integer", "description": "severity", "name": "severity", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/activities.QueryActivityGroupsResponse" } } } } }, "/activityhub/applications/{application_id}/targets/{target_id}/activitygroups/{context_id}": { "get": { "description": "get activitygroup", "consumes": [ "application/json" ], "summary": "get activitygroup", "parameters": [ { "type": "string", "description": "application_id", "name": "application_id", "in": "path", "required": true }, { "type": "string", "description": "target_id", "name": "target_id", "in": "path", "required": true }, { "type": "string", "description": "context id", "name": "context_id", "in": "path", "required": true }, { "type": "string", "description": "type", "name": "type", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/activities.GetActivityGroupResponse" } } } } }, "/activityhub/applications/{application_id}/targets/{target_id}/contexts/{context_id}": { "post": { "description": "post gitops activity", "summary": "post gitops activity", "parameters": [ { "type": "string", "description": "application_id", "name": "application_id", "in": "path", "required": true }, { "type": "string", "description": "target_id", "name": "target_id", "in": "path", "required": true }, { "type": "string", "description": "context id", "name": "context_id", "in": "path", "required": true }, { "type": "string", "description": "type", "name": "type", "in": "query" }, { "type": "string", "description": "summary", "name": "summary", "in": "query" } ], "responses": { "202": { "description": "Accepted", "schema": { "type": "string" } } } } }, "/activityhub/file/download": { "get": { "description": "download activity file", "produces": [ "application/json" ], "summary": "Download activity file", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "ActivityHub activity id", "name": "activity_id", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } } } } }, "/activityhub/file/view": { "get": { "description": "view activity file", "produces": [ "application/json" ], "summary": "View activity file", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "ActivityHub activity id", "name": "activity_id", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/clinic/api/v1/healthcheck/ai/analyze": { "post": { "description": "AI analyze for health check (internal users only)", "consumes": [ "application/json" ], "tags": [ "HealthCheck" ], "summary": "AI Health Check Analyze", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": true } } } } }, "/clusters/{cid}": { "get": { "description": "Get cluster basic information by cluster id (lightweight direct DB lookup)", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "Get cluster basic info by ID", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cluster.SimpleClusterResponse" } } } } }, "/compute-engine/{oid}/{cid}/comparison": { "get": { "description": "list comparison report", "consumes": [ "application/json" ], "tags": [ "Report" ], "summary": "list comparison report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" }, { "type": "boolean", "description": "if need data", "name": "brief", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/oldreport.ComparisonReportResp" } } } }, "post": { "description": "touch report in on cluster", "consumes": [ "application/json" ], "tags": [ "Report" ], "summary": "Touch New Comparison Report Job", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "description": "comparison report param", "name": "report-param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/oldreport.TouchComparisonReportReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/oldreport.ReportResp" } } } } }, "/compute-engine/{oid}/{cid}/comparison/{rid}": { "get": { "description": "list comparison report", "consumes": [ "application/json" ], "tags": [ "Report" ], "summary": "get comparison report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report id", "name": "rid", "in": "path", "required": true }, { "type": "boolean", "description": "if need data", "name": "brief", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/compute_engine.ComparisonReport" } } } }, "delete": { "description": "delete comparison report", "consumes": [ "application/json" ], "tags": [ "Report" ], "summary": "delete comparison report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report id", "name": "rid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/compute-engine/{oid}/{cid}/health": { "get": { "description": "list health report", "consumes": [ "application/json" ], "tags": [ "HealthReport" ], "summary": "list health report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "integer", "description": "start time", "name": "startTime", "in": "query" }, { "type": "integer", "description": "end time", "name": "endTime", "in": "query" }, { "type": "boolean", "description": "if need data", "name": "brief", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/oldreport.HealthReportResp" } } } }, "post": { "description": "touch Health report in on cluster", "consumes": [ "application/json" ], "tags": [ "HealthReport" ], "summary": "Touch New Health Report Job", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "description": "health report param", "name": "reportParams", "in": "body", "required": true, "schema": { "$ref": "#/definitions/oldreport.HealthReportReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/oldreport.ReportResp" } } } } }, "/compute-engine/{oid}/{cid}/health/{rid}": { "get": { "description": "list health report", "consumes": [ "application/json" ], "tags": [ "HealthReport" ], "summary": "get health report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report id", "name": "rid", "in": "path", "required": true }, { "type": "boolean", "description": "if need data", "name": "brief", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/compute_engine.Report" } } } }, "delete": { "description": "delete health report", "consumes": [ "application/json" ], "tags": [ "HealthReport" ], "summary": "delete health report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report id", "name": "rid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/compute-engine/{oid}/{cid}/healthcheck/result": { "get": { "description": "list health check results for a cluster", "consumes": [ "application/json" ], "tags": [ "HealthCheck" ], "summary": "List Health Check Results", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/healthcheck.ListHealthCheckResultResp" } } } } }, "/compute-engine/{oid}/{cid}/healthcheck/result/{uuid}": { "get": { "description": "get a combined health check report by result uuid (returns all check items for the same report)", "consumes": [ "application/json" ], "tags": [ "HealthCheck" ], "summary": "Get Health Check Result", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "result uuid", "name": "uuid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/healthcheck.HealthCheckCombinedReport" } } } }, "delete": { "description": "delete a health check result", "consumes": [ "application/json" ], "tags": [ "HealthCheck" ], "summary": "Delete Health Check Result", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "result uuid", "name": "uuid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } } }, "/compute-engine/{oid}/{cid}/healthcheck/strategy": { "get": { "description": "list health check strategies for a cluster", "consumes": [ "application/json" ], "tags": [ "HealthCheck" ], "summary": "List Health Check Strategies", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/healthcheck.ListHealthCheckStrategyResp" } } } }, "post": { "description": "create a new health check strategy with check items", "consumes": [ "application/json" ], "tags": [ "HealthCheck" ], "summary": "Create Health Check Strategy", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "description": "health check strategy", "name": "strategy", "in": "body", "required": true, "schema": { "$ref": "#/definitions/healthcheck.HealthCheckStrategyReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/healthcheck.HealthCheckStrategyResp" } } } } }, "/compute-engine/{oid}/{cid}/healthcheck/strategy/{uuid}": { "get": { "description": "get a health check strategy by uuid", "consumes": [ "application/json" ], "tags": [ "HealthCheck" ], "summary": "Get Health Check Strategy", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "strategy uuid", "name": "uuid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/healthcheck.HealthCheckStrategyResp" } } } }, "put": { "description": "update a health check strategy (including items)", "consumes": [ "application/json" ], "tags": [ "HealthCheck" ], "summary": "Update Health Check Strategy", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "strategy uuid", "name": "uuid", "in": "path", "required": true }, { "description": "health check strategy", "name": "strategy", "in": "body", "required": true, "schema": { "$ref": "#/definitions/healthcheck.HealthCheckStrategyReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/healthcheck.HealthCheckStrategyResp" } } } }, "delete": { "description": "delete a health check strategy", "consumes": [ "application/json" ], "tags": [ "HealthCheck" ], "summary": "Delete Health Check Strategy", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "strategy uuid", "name": "uuid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } } }, "/compute-engine/{oid}/{cid}/healthcheck/strategy/{uuid}/trigger": { "post": { "description": "trigger health check for a strategy (runs all enabled items or specified items)", "consumes": [ "application/json" ], "tags": [ "HealthCheck" ], "summary": "Trigger Health Check", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "strategy uuid", "name": "uuid", "in": "path", "required": true }, { "description": "optional item selection and time range override", "name": "trigger", "in": "body", "schema": { "$ref": "#/definitions/healthcheck.TriggerHealthCheckReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/healthcheck.HealthCheckTaskResp" } } } } }, "/compute-engine/{oid}/{cid}/trafficcomparison": { "get": { "description": "list traffic comparison report", "consumes": [ "application/json" ], "tags": [ "Report" ], "summary": "list traffic comparison report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" }, { "type": "boolean", "description": "if need data", "name": "brief", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/oldreport.ListTrafficComparisonReportResp" } } } }, "post": { "description": "touch report in on cluster", "consumes": [ "application/json" ], "tags": [ "Report" ], "summary": "Touch New Traffic Comparison Report Job", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "description": "traffic comparison report param", "name": "report-param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/oldreport.TouchTrafficComparisonReportReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/oldreport.ReportResp" } } } } }, "/compute-engine/{oid}/{cid}/trafficcomparison/{rid}": { "get": { "description": "list traffic comparison report", "consumes": [ "application/json" ], "tags": [ "Report" ], "summary": "get traffic comparison report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report id", "name": "rid", "in": "path", "required": true }, { "type": "boolean", "description": "if need data", "name": "brief", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/oldreport.TrafficComparisonReport" } } } }, "delete": { "description": "delete traffic comparison report", "consumes": [ "application/json" ], "tags": [ "Report" ], "summary": "delete traffic comparison report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report id", "name": "rid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/dashboard/activeqps": { "get": { "description": "list cloud clusters QPS status", "consumes": [ "application/json" ], "tags": [ "GlobalDashboard" ], "summary": "list cloud clusters QPS status", "parameters": [ { "type": "string", "description": "threshold", "name": "threshold", "in": "query", "required": true }, { "type": "string", "description": "search tenant name/id or cluster name/id", "name": "search", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "cluster region filter", "name": "region", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "deploy type filter", "name": "deploy_type", "in": "query" }, { "type": "integer", "description": "begin_ts", "name": "begin_ts", "in": "query", "required": true }, { "type": "integer", "description": "end_ts", "name": "end_ts", "in": "query", "required": true }, { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cloud.ActiveQPSResp" } } } } }, "/dashboard/clusters": { "get": { "description": "list cloud clusters status", "consumes": [ "application/json" ], "tags": [ "GlobalDashboard" ], "summary": "list cloud clusters status", "parameters": [ { "type": "string", "description": "search data from tenant id, tenant name, cluster id and cluster name", "name": "query", "in": "query" }, { "type": "boolean", "description": "show deleted cluster", "name": "show_deleted", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "cluster id", "name": "cluster_id", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "cluster status", "name": "cluster_status", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "cluster version", "name": "cluster_version", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "deploy type", "name": "deploy_type", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "deploy type v2", "name": "deploy_type_v2", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "tenant plan", "name": "tenant_plan", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "control plane", "name": "control_plane", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "cloud provider", "name": "provider", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "cloud region", "name": "region", "in": "query" }, { "type": "string", "description": "sort", "name": "sort", "in": "query" }, { "type": "string", "description": "order", "name": "order", "in": "query" }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" }, { "type": "boolean", "default": false, "description": "include the exact total", "name": "include_total", "in": "query" }, { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cloud.DashboardResp" } } } } }, "/dashboard/clusters2": { "get": { "description": "list cloud clusters status form local db", "consumes": [ "application/json" ], "tags": [ "GlobalDashboard" ], "summary": "list cloud clusters status form local db", "parameters": [ { "type": "string", "description": "search data from tenant id, tenant name, cluster id and cluster name", "name": "query", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "cluster id", "name": "cluster_id", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "cluster status", "name": "cluster_status", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "cluster version", "name": "cluster_version", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "deploy type", "name": "deploy_type", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "deploy type v2", "name": "deploy_type_v2", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "tenant plan", "name": "tenant_plan", "in": "query" }, { "type": "boolean", "description": "show deleted cluster", "name": "show_deleted", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "control plane", "name": "control_plane", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "cloud provider", "name": "provider", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "cloud region", "name": "region", "in": "query" }, { "type": "integer", "description": "created_at timestamp from", "name": "created_ts_from", "in": "query" }, { "type": "integer", "description": "created_at timestamp to", "name": "created_ts_to", "in": "query" }, { "type": "integer", "description": "deleted_at timestamp from", "name": "deleted_ts_from", "in": "query" }, { "type": "integer", "description": "deleted_at timestamp to", "name": "deleted_ts_to", "in": "query" }, { "type": "string", "description": "sort", "name": "sort", "in": "query" }, { "type": "string", "description": "order", "name": "order", "in": "query" }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" }, { "type": "boolean", "default": false, "description": "include the exact total", "name": "include_total", "in": "query" }, { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cloud.DashboardResp" } } } } }, "/dashboard/proxy": { "get": { "description": "proxy dashboard", "consumes": [ "application/json" ], "tags": [ "GlobalDashboard" ], "summary": "proxy dashboard", "parameters": [ { "type": "string", "description": "the proxy host", "name": "host", "in": "query", "required": true }, { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/cloud.DashboardResp" } } } } } }, "/dashboard/regions": { "get": { "description": "list regions", "consumes": [ "application/json" ], "tags": [ "GlobalDashboard" ], "summary": "list regions", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "cloud provdier, default for all providers", "name": "provider", "in": "query" }, { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cloud.RegionsResp" } } } } }, "/data/control_plane/metrics": { "get": { "description": "get the dbaas control plane metrics data", "consumes": [ "application/json" ], "tags": [ "Metric" ], "summary": "Get the dbaas control plane metrics data", "parameters": [ { "type": "string", "description": "the control plane info", "name": "control_plane_info", "in": "header", "required": true }, { "type": "string", "description": "prometheus query", "name": "query", "in": "query", "required": true }, { "type": "integer", "description": "the start timestamp of query data", "name": "start", "in": "query" }, { "type": "integer", "description": "the end timestamp of query data", "name": "end", "in": "query" }, { "type": "string", "description": "prometheus step", "name": "step", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/data/metrics": { "get": { "description": "get the metrics data", "consumes": [ "application/json" ], "tags": [ "Metric" ], "summary": "Get the metrics data", "parameters": [ { "enum": [ "cloud", "op" ], "type": "string", "description": "string enums", "name": "X-OrgType", "in": "header", "required": true }, { "type": "string", "description": "the org id in clinic", "name": "X-OrgID", "in": "header", "required": true }, { "type": "string", "description": "cluster id", "name": "X-ClusterID", "in": "header", "required": true }, { "type": "string", "description": "prometheus query", "name": "query", "in": "query", "required": true }, { "type": "integer", "description": "the start timestamp of query data", "name": "start", "in": "query" }, { "type": "integer", "description": "the end timestamp of query data", "name": "end", "in": "query" }, { "type": "string", "description": "prometheus step", "name": "step", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/diag/flush": { "post": { "description": "call flush api after all parts of file are uploaded", "consumes": [ "multipart/form-data" ], "tags": [ "Upload" ], "summary": "Flush", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "a custom hash combining package’s filename, size and modify time", "name": "uuid", "in": "query", "required": true }, { "type": "string", "description": "an optional issue Jira issue ID this package should be connected to", "name": "issue", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.FlushResponse" } } } } }, "/diag/precreate": { "post": { "description": "precreate", "consumes": [ "multipart/form-data" ], "tags": [ "Upload" ], "summary": "Precreate", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "a custom hash combining package’s filename, size and modify time", "name": "uuid", "in": "query", "required": true }, { "type": "integer", "description": "the size of the file", "name": "length", "in": "query", "required": true }, { "type": "string", "description": "an optional alias of filename", "name": "alias", "in": "query" }, { "type": "string", "description": "actual name of the file", "name": "filename", "in": "query", "required": true }, { "type": "file", "description": "file", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.PreCreateResponse" } } } } }, "/diag/upload": { "post": { "description": "upload file part api", "consumes": [ "application/octet-stream" ], "tags": [ "Upload" ], "summary": "Upload", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "a custom hash combining package’s filename, size and modify time", "name": "uuid", "in": "query", "required": true }, { "type": "integer", "description": "the serial number of the file part", "name": "sequence", "in": "query", "required": true }, { "type": "integer", "description": "the length of the file part", "name": "length", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/internal/clusters/{cluster_id}/cluster-dataurls": { "get": { "description": "Get comprehensive cluster information including data URLs (internal API)", "consumes": [ "application/json" ], "tags": [ "Internal" ], "summary": "Get cluster data URLs", "parameters": [ { "type": "string", "description": "cluster id (cluster_id field, not the primary key id)", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/internal_api.ClusterDataURLsResponse" } } } } }, "/internal/keys": { "get": { "description": "List all API keys for the current internal user", "consumes": [ "application/json" ], "tags": [ "Internal Key" ], "summary": "List internal API keys", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/internal_key.ListKeysResponse" } } } }, "post": { "description": "Create an API key for internal users (internal=true only)", "consumes": [ "application/json" ], "tags": [ "Internal Key" ], "summary": "Create internal API key", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "description": "optional key name and expiration", "name": "body", "in": "body", "schema": { "$ref": "#/definitions/internal_key.CreateKeyRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/internal_key.KeyResponse" } } } } }, "/internal/keys/{id}": { "delete": { "description": "Delete an API key for the current internal user", "consumes": [ "application/json" ], "tags": [ "Internal Key" ], "summary": "Delete internal API key", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "integer", "description": "key id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } } }, "/login/logout": { "post": { "description": "log out", "produces": [ "application/json" ], "tags": [ "OAuth" ], "summary": "Logout", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } } }, "/login/oauth/{name}/info": { "get": { "description": "get oauth config", "produces": [ "application/json" ], "tags": [ "OAuth" ], "summary": "Config the user", "parameters": [ { "enum": [ "internal", "ask_tug", "tidbcloud", "pingkai" ], "type": "string", "description": "string enums", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "the redirect_uri request parameter is used as a callback URL", "name": "redirect_uri", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/login.OAuthInfoResp" } } } } }, "/login/oauth/{name}/validate": { "post": { "description": "set auth header", "consumes": [ "application/json" ], "tags": [ "OAuth" ], "summary": "Validate the user", "parameters": [ { "enum": [ "internal", "ask_tug", "tidbcloud", "pingkai" ], "type": "string", "description": "string enums", "name": "name", "in": "path", "required": true }, { "description": "validation", "name": "validation", "in": "body", "required": true, "schema": { "$ref": "#/definitions/login.Validation" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/login.ValidationResp" } } } } }, "/orgs": { "get": { "description": "list organization", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "List the organizations", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "the organization name", "name": "query", "in": "query" }, { "type": "string", "description": "filter condition, can be all,starred,mine", "name": "filter", "in": "query" }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/org.ListOrganizationsResp" } } } }, "post": { "description": "create organization", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "Create the organization", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "description": "organization", "name": "organization", "in": "body", "required": true, "schema": { "$ref": "#/definitions/org.Organization" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/org.Organization" } } } } }, "/orgs/external/{eid}": { "get": { "description": "get organization by external id", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "Get the organization by external id", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "external id", "name": "eid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/org.Organization" } } } } }, "/orgs/{oid}": { "get": { "description": "get organization", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "Get the organization", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/org.Organization" } } } }, "put": { "description": "update organization", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "Update the organization", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "description": "organization", "name": "organization", "in": "body", "required": true, "schema": { "$ref": "#/definitions/org.UpdateOrganizationReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/org.Organization" } } } }, "delete": { "description": "delete Organization and data", "tags": [ "Organization" ], "summary": "delete Organization", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/orgs/{oid}/clusters": { "get": { "description": "list cluster of the specified organization", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "List clusters", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "string", "description": "the query of cluster", "name": "query", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" }, { "type": "string", "description": "project id", "name": "pid", "in": "query" }, { "type": "boolean", "description": "show deleted cluster", "name": "show_deleted", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cluster.ListClustersResp" } } } }, "post": { "description": "add a cluster", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "Add cluster", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } } }, "/orgs/{oid}/clusters/{cid}": { "get": { "description": "list packages of the specified cluster", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "List info of the specified cluster", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cluster.Cluster" } } } }, "put": { "description": "update cluster information", "tags": [ "Cluster" ], "summary": "update cluster information", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "description": "cluster information", "name": "cluster", "in": "body", "required": true, "schema": { "$ref": "#/definitions/cluster.UpdateClusterReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } }, "delete": { "description": "delete cluster and data", "tags": [ "Cluster" ], "summary": "delete cluster and data", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/orgs/{oid}/clusters/{cid}/dashboard": { "get": { "description": "list dashboard user can access", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "list dashboard user can access", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "integer", "description": "startTime of dashboard show", "name": "startTime", "in": "query" }, { "type": "integer", "description": "endTime of dashboard show", "name": "endTime", "in": "query" }, { "type": "string", "description": "tidb version", "name": "version", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/cluster.DataUrl" } } } } } }, "/orgs/{oid}/clusters/{cid}/dashboard-versions": { "get": { "description": "list available dashboard version", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "list available dashboard version", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/orgs/{oid}/clusters/{cid}/data": { "get": { "description": "get the detail information of the specified timerange in cluster", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "get the detail information of the specified timerange in cluster", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "integer", "description": "start time", "name": "startTime", "in": "query" }, { "type": "integer", "description": "end time", "name": "endTime", "in": "query" }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cluster.DataSummaryResponse" } } } } }, "/orgs/{oid}/clusters/{cid}/data_status": { "get": { "description": "get data status of the specified cluster", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "get data status of the cluster", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "integer", "description": "startTime", "name": "startTime", "in": "query", "required": true }, { "type": "integer", "description": "endTime", "name": "endTime", "in": "query", "required": true }, { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "int enums", "name": "data_type", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.TaskStatusResp" } } } } }, "/orgs/{oid}/clusters/{cid}/defaultconf": { "get": { "description": "list default values of the specified cluster version", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "List default value of current version", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cluster.DefaultConfiguration" } } } } }, "/orgs/{oid}/clusters/{cid}/download/{itemid}": { "get": { "description": "download file", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "download total package", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "item id", "name": "itemid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } } } } }, "/orgs/{oid}/clusters/{cid}/downloadConf/{itemid}": { "get": { "description": "download file", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "download total package", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "item id", "name": "itemid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } } } } }, "/orgs/{oid}/clusters/{cid}/logurl/{itemid}": { "get": { "description": "get log url", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "log url", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "item id", "name": "itemid", "in": "path", "required": true }, { "type": "integer", "description": "startTime of dashboard show", "name": "startTime", "in": "query" }, { "type": "integer", "description": "endTime of dashboard show", "name": "endTime", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cluster.DataUrl" } } } } }, "/orgs/{oid}/clusters/{cid}/metrics": { "get": { "description": "list overview metrics of the specified cluster", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "List metric information of the specified cluster", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cluster.ClusterMetrics" } } } } }, "/orgs/{oid}/clusters/{cid}/plan-replayer/files": { "get": { "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "List Plan Replayer files", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "logical cluster id", "name": "cid", "in": "path", "required": true }, { "type": "integer", "description": "page size, default 100, max 1000", "name": "pageSize", "in": "query" }, { "type": "string", "description": "opaque page token", "name": "pageToken", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/nextgen_client.ListPlanReplayerFilesResponse" } } } } }, "/orgs/{oid}/clusters/{cid}/plan-replayer/files/download-url": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "Generate a Plan Replayer download URL", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "logical cluster id", "name": "cid", "in": "path", "required": true }, { "description": "file name from list response", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/nextgen_client.GeneratePlanReplayerFileDownloadURLRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/nextgen_client.GeneratePlanReplayerFileDownloadURLResponse" } } } } }, "/orgs/{oid}/clusters/{cid}/rebuild": { "put": { "description": "rebuild data for the specified package", "tags": [ "Cluster" ], "summary": "rebuild data for the specified package", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "description": "rebuild", "name": "rebuild", "in": "body", "required": true, "schema": { "$ref": "#/definitions/common.Rebuild" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } } }, "/orgs/{oid}/clusters/{cid}/resource-pool/components": { "get": { "description": "Get resourcePool components for premium, premium reserved, essential v2, byoc, and byoc resource pool clusters", "produces": [ "application/json" ], "tags": [ "ResourcePool" ], "summary": "Get resource pool components", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/view.ResourcePoolComponent" } } } } } }, "/orgs/{oid}/clusters/{cid}/slogans": { "get": { "description": "get cluster slogan", "consumes": [ "application/json" ], "tags": [ "Cluster Slogan" ], "summary": "get cluster slogan", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cluster.SloganRespList" } } } } }, "/orgs/{oid}/clusters/{cid}/slowqueries": { "get": { "description": "get slow log list in cluster", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "get slow log list", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "package id", "name": "itemID", "in": "query", "required": true }, { "type": "integer", "description": "start time", "name": "begin_time", "in": "query" }, { "type": "integer", "description": "end time", "name": "end_time", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "db list", "name": "db", "in": "query" }, { "type": "integer", "description": "limit", "name": "limit", "in": "query" }, { "type": "string", "description": "text", "name": "text", "in": "query" }, { "type": "string", "description": "orderBy", "name": "orderBy", "in": "query" }, { "type": "boolean", "description": "desc", "name": "desc", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "plans", "name": "plans", "in": "query" }, { "type": "string", "description": "digest", "name": "digest", "in": "query" }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/cluster.SlowQueryProfile" } } } } } }, "/orgs/{oid}/clusters/{cid}/slowqueries/{queryid}": { "get": { "description": "get slow log detail in cluster", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "get slow log detail", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "package id", "name": "itemID", "in": "query", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "log id", "name": "queryid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cluster.SlowQueryProfile" } } } } }, "/orgs/{oid}/clusters/{cid}/update_status": { "post": { "description": "update cluster status", "tags": [ "Cluster" ], "summary": "update cluster status", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "description": "cluster information", "name": "cluster", "in": "body", "required": true, "schema": { "$ref": "#/definitions/cluster.UpdateClusterReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } } }, "/orgs/{oid}/clusters/{cid}/{itemid}/meta": { "get": { "description": "meta information of package file", "produces": [ "application/json" ], "tags": [ "Cluster" ], "summary": "meta information of package file", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "item id", "name": "itemid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cluster.FileMeta" } } } } }, "/orgs/{oid}/diag/flush": { "post": { "description": "call flush api after all parts of file are uploaded", "consumes": [ "multipart/form-data" ], "tags": [ "Upload" ], "summary": "Flush", "parameters": [ { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "a custom hash combining package’s filename, size and modify time", "name": "uuid", "in": "query", "required": true }, { "type": "string", "description": "an optional issue Jira issue ID this package should be connected to", "name": "issue", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.FlushResponse" } } } } }, "/orgs/{oid}/diag/precreate": { "post": { "description": "precreate", "consumes": [ "multipart/form-data" ], "tags": [ "Upload" ], "summary": "Precreate", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "a custom hash combining package’s filename, size and modify time", "name": "uuid", "in": "query", "required": true }, { "type": "integer", "description": "the size of the file", "name": "length", "in": "query", "required": true }, { "type": "string", "description": "an optional alias of filename", "name": "alias", "in": "query" }, { "type": "string", "description": "actual name of the file", "name": "filename", "in": "query", "required": true }, { "type": "file", "description": "file", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.PreCreateResponse" } } } } }, "/orgs/{oid}/diag/upload": { "post": { "description": "upload file part api", "consumes": [ "application/octet-stream" ], "tags": [ "Upload" ], "summary": "Upload", "parameters": [ { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "a custom hash combining package’s filename, size and modify time", "name": "uuid", "in": "query", "required": true }, { "type": "integer", "description": "the serial number of the file part", "name": "sequence", "in": "query", "required": true }, { "type": "integer", "description": "the length of the file part", "name": "length", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/orgs/{oid}/keys": { "get": { "description": "list upload key of the user in current organizatioin", "tags": [ "Api Key" ], "summary": "List upload key", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/org.ListApiKeyResponse" } } } }, "post": { "description": "create api key", "consumes": [ "application/json" ], "tags": [ "Api Key" ], "summary": "Create api key", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/org.ApiKeyResponse" } } } } }, "/orgs/{oid}/keys/{id}": { "delete": { "description": "create api key", "consumes": [ "application/json" ], "tags": [ "Api Key" ], "summary": "Delete api key", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "integer", "description": "key id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/org.ApiKeyResponse" } } } } }, "/orgs/{oid}/projects": { "get": { "description": "list projects of the specified organization (only for cloud orgs)", "produces": [ "application/json" ], "tags": [ "Organization" ], "summary": "List projects", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/org.ListProjectsResp" } } } } }, "/orgs/{oid}/roles": { "get": { "description": "list organization roles", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "List the organizations roles", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/org.Role" } } } } } }, "/orgs/{oid}/star": { "post": { "description": "star organization", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "Star the organization", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } }, "delete": { "description": "unstar organization", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "UnStar the organization", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } } }, "/orgs/{oid}/tasks": { "get": { "description": "get organization task list", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "Get the organization task list", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/org.TaskStatus" } } } } } }, "/orgs/{oid}/users": { "get": { "description": "list users of the organization", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "List users", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/org.ListUsersResp" } } } } }, "/orgs/{oid}/users/invite": { "post": { "description": "invite user to join the organization", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "Invite user", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "description": "invite user", "name": "invite", "in": "body", "required": true, "schema": { "$ref": "#/definitions/org.InvitesReq" } }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } } }, "/orgs/{oid}/users/{id}": { "put": { "description": "update user role in organization", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "Update user role in organization", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "integer", "description": "user id", "name": "id", "in": "path", "required": true }, { "description": "user role", "name": "role", "in": "body", "required": true, "schema": { "$ref": "#/definitions/org.Role" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } }, "delete": { "description": "delete user from organization", "consumes": [ "application/json" ], "tags": [ "Organization" ], "summary": "Delete user from organization", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "integer", "description": "user id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } } }, "/reports/statistics": { "get": { "description": "get report statistics", "consumes": [ "application/json" ], "tags": [ "Reports" ], "summary": "get report statistics", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "event name", "name": "event", "in": "query", "required": true }, { "type": "string", "description": "hash value", "name": "hash", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/report.ReportStatistics" } } } } }, "/reports/{oid}/{cid}": { "get": { "description": "list health report", "consumes": [ "application/json" ], "tags": [ "Reports" ], "summary": "list health report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report type", "name": "report_type", "in": "query", "required": true }, { "type": "integer", "description": "the count per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "the page index", "name": "page", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/report.ListReportResponse" } } } }, "post": { "description": "touch report on cluster", "consumes": [ "application/json" ], "tags": [ "Reports" ], "summary": "Touch New Report Job", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report type", "name": "report_type", "in": "query", "required": true }, { "description": "report param", "name": "reportParams", "in": "body", "required": true, "schema": { "$ref": "#/definitions/report.TouchReportRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/report.TouchReportResponse" } } } } }, "/reports/{oid}/{cid}/{rid}": { "get": { "description": "list report", "consumes": [ "application/json" ], "tags": [ "Reports" ], "summary": "get report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report id", "name": "rid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/report.GetReportResponse" } } } }, "put": { "description": "put health report", "consumes": [ "application/json" ], "tags": [ "Reports" ], "summary": "put report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report id", "name": "rid", "in": "path", "required": true }, { "description": "report information", "name": "reportParams", "in": "body", "required": true, "schema": { "$ref": "#/definitions/report.PutReportRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } }, "post": { "description": "delete health report", "consumes": [ "application/json" ], "tags": [ "Reports" ], "summary": "rebuild report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report id", "name": "rid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } }, "delete": { "description": "delete health report", "consumes": [ "application/json" ], "tags": [ "Reports" ], "summary": "delete report", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true }, { "type": "string", "description": "organization id", "name": "oid", "in": "path", "required": true }, { "type": "string", "description": "cluster id", "name": "cid", "in": "path", "required": true }, { "type": "string", "description": "report id", "name": "rid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.SuccessResp" } } } } }, "/user/profile": { "get": { "description": "get profile", "produces": [ "application/json" ], "tags": [ "User" ], "summary": "Get profile", "parameters": [ { "type": "string", "description": "get value from login.ValidationResp response", "name": "x-csrf-token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/user.UserResp" } } } } } }, "definitions": { "activities.ActivityGroup": { "type": "object", "properties": { "activities": { "type": "array", "items": { "$ref": "#/definitions/activityhub_client.Activity" } }, "application_id": { "type": "string" }, "concept_id": { "type": "string" }, "context_id": { "type": "string" }, "name": { "type": "string" }, "rule": { "type": "array", "items": { "type": "string" } }, "severity": { "type": "integer" }, "status": { "type": "string" }, "target_id": { "type": "string" }, "timeout": { "type": "integer" } } }, "activities.GetActivityGroupResponse": { "type": "object", "properties": { "activities": { "type": "array", "items": { "$ref": "#/definitions/activityhub_client.Activity" } }, "application_id": { "type": "string" }, "concept_id": { "type": "string" }, "context_id": { "type": "string" }, "name": { "type": "string" }, "rule": { "type": "array", "items": { "type": "string" } }, "severity": { "type": "integer" }, "status": { "type": "string" }, "target_id": { "type": "string" }, "timeout": { "type": "integer" } } }, "activities.GetActivityResponse": { "type": "object", "properties": { "activity_id": { "type": "string" }, "application_id": { "type": "string" }, "author": { "type": "string" }, "calibration_time": { "type": "integer" }, "catalog": { "type": "string" }, "concept_id": { "type": "string" }, "context": { "type": "array", "items": { "type": "string" } }, "context_id": { "type": "string" }, "display_name": { "type": "string" }, "name": { "type": "string" }, "payload": {}, "severity": { "type": "integer" }, "source": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "target_id": { "type": "string" }, "type": { "type": "string" } } }, "activities.QueryActivitiesResponse": { "type": "object", "properties": { "activities": { "type": "array", "items": { "$ref": "#/definitions/activityhub_client.Activity" } }, "cursor": { "type": "string" }, "partial": { "type": "boolean" } } }, "activities.QueryActivityGroupsResponse": { "type": "object", "properties": { "activity_groups": { "type": "array", "items": { "$ref": "#/definitions/activities.ActivityGroup" } } } }, "activityhub_client.Activity": { "type": "object", "properties": { "activity_id": { "type": "string" }, "application_id": { "type": "string" }, "author": { "type": "string" }, "calibration_time": { "type": "integer" }, "catalog": { "type": "string" }, "concept_id": { "type": "string" }, "context": { "type": "array", "items": { "type": "string" } }, "context_id": { "type": "string" }, "display_name": { "type": "string" }, "name": { "type": "string" }, "payload": {}, "severity": { "type": "integer" }, "source": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "target_id": { "type": "string" }, "type": { "type": "string" } } }, "cloud.ActiveQPSResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/cloud.clusterInfo" } }, "total": { "type": "integer" } } }, "cloud.DashboardResp": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/definitions/view.DashboardItemExternal" } }, "total": { "type": "integer" } } }, "cloud.RegionsResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" } }, "total": { "type": "integer" } } }, "cloud.clusterInfo": { "type": "object", "properties": { "cluster_id": { "type": "string" }, "cluster_name": { "type": "string" }, "deploy_type": { "type": "string" }, "duration": { "type": "number" }, "max_qps": { "type": "number" }, "org_id": { "description": "clinic org_id", "type": "string" }, "region": { "type": "string" }, "report_uuid": { "type": "string" }, "tenant_id": { "type": "string" }, "tenant_name": { "type": "string" }, "timestamp": { "type": "integer" } } }, "cluster.Cluster": { "type": "object", "properties": { "branches": { "type": "array", "items": { "type": "string" } }, "clusterType": { "type": "string" }, "components": { "type": "object", "additionalProperties": { "$ref": "#/definitions/db.ClusterComponent" } }, "controlPlaneArch": { "type": "string" }, "created": { "type": "integer" }, "dataPlaneName": { "type": "string" }, "dataSizeLimit": { "type": "integer" }, "dataSizeUsed": { "description": "Usage by the cluster in bytes", "type": "integer" }, "deployType": { "type": "string" }, "deployTypeV2": { "type": "string" }, "endTime": { "type": "integer" }, "featureGates": { "$ref": "#/definitions/cluster.ClusterFeatureGates" }, "id": { "type": "string" }, "k8sNamespace": { "type": "string" }, "keyspaceID": { "description": "keyspace id for serverless cluster", "type": "integer" }, "keyspaceName": { "description": "keyspace name for serverless cluster", "type": "string" }, "lastestUpdated": { "type": "integer" }, "maxRCU": { "description": "nextgen max rcu", "type": "integer" }, "minRCU": { "description": "nextgen min rcu", "type": "integer" }, "name": { "type": "string" }, "networkName": { "type": "string" }, "note": { "type": "string" }, "parentID": { "description": "nextgen physic cluster id", "type": "string" }, "projectID": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "ruVersion": { "description": "resource unit version from mgmt (Essential/Premium)", "type": "integer" }, "shootName": { "type": "string" }, "spendLimit": { "description": "spend limit for serverless cluster", "type": "integer" }, "startTime": { "type": "integer" }, "status": { "type": "string" }, "topology": { "$ref": "#/definitions/db.Topology" }, "totalOncall": { "type": "integer" }, "totalReport": { "description": "PackageCount int64 ` + "`" + `json:\"package_count\"` + "`" + `", "type": "integer" }, "version": { "type": "string" } } }, "cluster.ClusterFeatureGates": { "type": "object", "properties": { "benchmarkReportEnabled": { "type": "boolean" }, "comparisonReportEnabled": { "type": "boolean" }, "conProfEnabled": { "type": "boolean" }, "logsEnabled": { "type": "boolean" }, "materializedViewEnabled": { "type": "boolean" }, "slowQueryEnabled": { "type": "boolean" }, "slowQueryVisualEnabled": { "type": "boolean" }, "systemCheckReportEnabled": { "type": "boolean" }, "topSQLEnabled": { "type": "boolean" } } }, "cluster.ClusterMetrics": { "type": "object", "properties": { "events": { "type": "integer" }, "maxCpu": { "$ref": "#/definitions/cluster.MetricValue" }, "maxMemory": { "$ref": "#/definitions/cluster.MetricValue" }, "minUpTime": { "$ref": "#/definitions/cluster.MetricValue" }, "reports": { "type": "integer" }, "sla": { "type": "string" }, "storageSize": { "type": "string" } } }, "cluster.DataInfo": { "type": "object", "properties": { "collectors": { "type": "array", "items": { "type": "string" } }, "endTime": { "type": "integer" }, "filename": { "type": "string" }, "haveConfig": { "type": "boolean" }, "haveLog": { "type": "boolean" }, "haveMetric": { "type": "boolean" }, "itemID": { "type": "string" }, "startTime": { "type": "integer" } } }, "cluster.DataSummaryResponse": { "type": "object", "properties": { "dataInfos": { "type": "array", "items": { "$ref": "#/definitions/cluster.DataInfo" } }, "total": { "type": "integer" } } }, "cluster.DataUrl": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "description": "Uid string ` + "`" + `json:\"uid\"` + "`" + `", "type": "string" } } }, "cluster.DefaultConfiguration": { "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/definitions/db.DefaultConfiguration" } } } } }, "cluster.FileMeta": { "type": "object", "properties": { "briefSize": { "type": "string" }, "collectors": { "type": "array", "items": { "type": "string" } }, "filename": { "type": "string" }, "totalSize": { "type": "string" } } }, "cluster.ListClustersResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/cluster.Cluster" } }, "total": { "type": "integer" } } }, "cluster.MetricValue": { "type": "object", "properties": { "component": { "type": "string" }, "value": { "type": "string" } } }, "cluster.SimpleClusterResponse": { "type": "object", "properties": { "clusterId": { "type": "string" }, "createdAt": { "type": "integer" }, "deployType": { "type": "string" }, "deployTypeV2": { "type": "string" }, "name": { "type": "string" }, "orgId": { "type": "integer" }, "projectId": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "status": { "type": "string" }, "tenantId": { "type": "integer" }, "updatedAt": { "type": "integer" }, "version": { "type": "string" } } }, "cluster.SloganResp": { "type": "object", "properties": { "createAt": { "type": "integer" }, "id": { "type": "integer" }, "text": { "type": "string" } } }, "cluster.SloganRespList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/cluster.SloganResp" } }, "total": { "type": "integer" } } }, "cluster.SlowQueryProfile": { "type": "object", "additionalProperties": {} }, "cluster.UpdateClusterReq": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" } } }, "common.FlushResponse": { "type": "object", "properties": { "result": { "type": "string" } } }, "common.PreCreateResponse": { "type": "object", "properties": { "blockbytes": { "type": "integer" }, "sequence": { "type": "integer" } } }, "common.Rebuild": { "type": "object", "properties": { "clusterID": { "type": "string" }, "dataType": { "type": "integer" }, "healthReport": { "description": "if build health report", "type": "boolean" }, "healthReportEndUnix": { "description": "only used when health report is for cluster under cloud org", "type": "integer" }, "healthReportStartUnix": { "description": "only used when health report is for cluster under cloud org", "type": "integer" }, "itemID": { "type": "string" }, "orgID": { "type": "integer" }, "orgType": { "type": "string" } } }, "common.SuccessResp": { "type": "object", "properties": { "status": { "type": "string" } } }, "common.TaskStatus": { "type": "object", "properties": { "endTime": { "type": "integer" }, "itemID": { "type": "string" }, "startTime": { "type": "integer" }, "status": { "type": "integer" }, "taskType": { "type": "integer" } } }, "common.TaskStatusResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/common.TaskStatus" } } } }, "compute_engine.ComparisonReport": { "type": "object", "properties": { "args": { "$ref": "#/definitions/compute_engine.ComparisonReportArgs" }, "created_at": { "type": "integer" }, "data": { "$ref": "#/definitions/compute_engine.ComparisonReportData" }, "hook": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "tags": { "type": "object", "additionalProperties": {} }, "updated_at": { "type": "integer" } } }, "compute_engine.ComparisonReportArgs": { "type": "object", "properties": { "cluster": { "type": "string" }, "org_id": { "type": "string" }, "org_type": { "type": "string" }, "package_id_1": { "type": "array", "items": { "type": "string" } }, "package_id_2": { "type": "array", "items": { "type": "string" } }, "start_ts_1": { "type": "integer" }, "start_ts_2": { "type": "integer" }, "stop_ts_1": { "type": "integer" }, "stop_ts_2": { "type": "integer" } } }, "compute_engine.ComparisonReportData": { "type": "object", "properties": { "businessMetricsComparison": { "type": "array", "items": { "type": "object", "properties": { "subValues": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": { "type": "number" }, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": { "type": "string" }, "t2AverageValue": { "type": "string" } } } } } }, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": { "type": "number" }, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": { "type": "string" }, "t2AverageValue": { "type": "string" } } } } } }, "comparisonTimeRange": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "t1EndTime": { "type": "integer" }, "t1StartTime": { "type": "integer" }, "t2EndTime": { "type": "integer" }, "t2StartTime": { "type": "integer" } } } } } }, "errorMessage": { "type": "string" }, "keyMetricsComparison": { "type": "array", "items": { "type": "object", "properties": { "subValues": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": { "type": "number" }, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": { "type": "string" }, "t2AverageValue": { "type": "string" } } } } } }, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": { "type": "number" }, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": { "type": "string" }, "t2AverageValue": { "type": "string" } } } } } }, "logComparison": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "diff": { "type": "integer" }, "name": { "type": "string" }, "t1Percentage": { "type": "string" }, "t2Percentage": { "type": "string" } } } } } }, "performanceMetricsComparison": { "type": "object", "properties": { "Perf_basic": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": {}, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": {}, "t2AverageValue": {} } } } } }, "Perf_detailed": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": { "type": "number" }, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": { "type": "string" }, "t2AverageValue": { "type": "string" } } } } } }, "Perf_durbytype": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": { "type": "number" }, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": { "type": "string" }, "t2AverageValue": { "type": "string" } } } } } }, "Perf_kvrequest": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": {}, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": {}, "t2AverageValue": {} } } } } }, "Perf_phase": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": { "type": "number" }, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": { "type": "string" }, "t2AverageValue": { "type": "string" } } } } } }, "Perf_sqlexecute": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": {}, "variables": {} } }, "diff": { "type": "number" }, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": { "type": "string" }, "t2AverageValue": { "type": "string" } } } } } }, "Perf_type": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": { "type": "number" }, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": { "type": "string" }, "t2AverageValue": { "type": "string" } } } } } } } }, "resourceMetricsComparison": { "type": "array", "items": { "type": "object", "properties": { "subValues": { "type": "array", "items": { "type": "object", "properties": { "subValues": {}, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": { "type": "number" }, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": { "type": "string" }, "t2AverageValue": { "type": "string" } } } } } }, "values": { "type": "object", "properties": { "components": { "type": "string" }, "description": { "type": "object", "properties": { "key": { "type": "string" }, "variables": {} } }, "diff": { "type": "integer" }, "grafanaLocation": { "type": "string" }, "label": { "type": "string" }, "metrics": { "type": "string" }, "t1AverageValue": { "type": "string" }, "t2AverageValue": { "type": "string" } } } } } } } }, "compute_engine.HealthDataResult": { "type": "object", "properties": { "log": { "$ref": "#/definitions/compute_engine.HealthLogResult" }, "metric": { "$ref": "#/definitions/compute_engine.HealthMetricResult" } } }, "compute_engine.HealthLogAdvice": { "type": "object", "properties": { "category": { "type": "array", "items": { "type": "string" } }, "component": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "string" } }, "content": { "type": "object", "properties": { "key": { "type": "string" }, "variables": { "type": "object", "additionalProperties": {} } } }, "count": { "type": "integer" }, "id": { "type": "integer" }, "instance": { "type": "string" }, "kb": { "type": "string" }, "level": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "compute_engine.HealthLogResult": { "type": "object", "properties": { "advice": { "type": "array", "items": { "$ref": "#/definitions/compute_engine.HealthLogAdvice" } }, "source": { "type": "string" }, "stats": { "$ref": "#/definitions/compute_engine.HealthLogStats" }, "timestamp": { "type": "integer" } } }, "compute_engine.HealthLogStats": { "type": "object", "properties": { "scannedLogs": { "type": "integer" } } }, "compute_engine.HealthMetricAdvice": { "type": "object", "properties": { "category": { "type": "array", "items": { "type": "string" } }, "component": { "type": "string" }, "content": { "type": "object", "properties": { "key": { "type": "string" }, "variables": { "type": "object", "additionalProperties": {} } } }, "id": { "type": "integer" }, "instance": { "type": "string" }, "kb": { "type": "string" }, "level": { "type": "string" }, "name": { "type": "string" }, "qualified": { "type": "boolean" }, "type": { "type": "string" } } }, "compute_engine.HealthMetricResult": { "type": "object", "properties": { "advice": { "type": "array", "items": { "$ref": "#/definitions/compute_engine.HealthMetricAdvice" } }, "source": { "type": "string" }, "stats": { "$ref": "#/definitions/compute_engine.HealthMetricStats" }, "timestamp": { "type": "integer" } } }, "compute_engine.HealthMetricStats": { "type": "object", "properties": { "checkedRules": { "type": "integer" }, "scannedMetrics": { "type": "integer" } } }, "compute_engine.HealthReportArgs": { "type": "object", "properties": { "cluster": { "type": "string" }, "start_ts": { "type": "integer" }, "stop_ts": { "type": "integer" } } }, "compute_engine.Report": { "type": "object", "properties": { "args": { "$ref": "#/definitions/compute_engine.HealthReportArgs" }, "created_at": { "type": "integer" }, "data": { "$ref": "#/definitions/compute_engine.HealthDataResult" }, "hook": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "tags": { "type": "object", "additionalProperties": {} }, "updated_at": { "type": "integer" } } }, "db.ClusterComponent": { "type": "object", "properties": { "TidbGroupId": { "type": "integer" }, "cpuNum": { "type": "integer" }, "memoryGi": { "type": "integer" }, "replicas": { "type": "integer" }, "storageInstanceType": { "type": "string" }, "storageSizeGi": { "type": "integer" }, "storageType": { "description": "StorageType only used for tikv and tiflash", "type": "string" }, "storages": { "type": "object", "additionalProperties": { "$ref": "#/definitions/db.ComponentStorage" } }, "tidbGroupDisplayName": { "type": "string" }, "tidbGroups": { "type": "array", "items": { "$ref": "#/definitions/db.TidbGroup" } }, "tierName": { "type": "string" } } }, "db.ComparisonArg": { "type": "object", "properties": { "endTime1": { "type": "integer" }, "endTime2": { "type": "integer" }, "packageID1": { "type": "array", "items": { "type": "string" } }, "packageID2": { "type": "array", "items": { "type": "string" } }, "startTime1": { "type": "integer" }, "startTime2": { "type": "integer" } } }, "db.ComponentStorage": { "type": "object", "properties": { "additional_iops": { "type": "integer" }, "disk_type": { "type": "string" }, "iops": { "type": "integer" }, "size_gi": { "type": "integer" }, "throughput_mibps": { "type": "integer" }, "volume_type": { "type": "string" } } }, "db.DefaultConfiguration": { "type": "object", "properties": { "defaultValue": { "type": "string" }, "itemName": { "type": "string" }, "valueType": { "type": "string" } } }, "db.TidbGroup": { "type": "object", "properties": { "cpuNum": { "type": "integer" }, "createdAt": { "type": "string" }, "deletedAt": { "type": "string" }, "displayName": { "type": "string" }, "id": { "type": "integer" }, "isDefault": { "type": "boolean" }, "memoryGi": { "type": "integer" }, "replicas": { "type": "integer" }, "tierName": { "type": "string" } } }, "db.Topology": { "type": "object", "properties": { "dmMaster": { "type": "integer" }, "dmWorker": { "type": "integer" }, "pd": { "type": "integer" }, "tidb": { "type": "integer" }, "tiflash": { "type": "integer" }, "tikv": { "type": "integer" } } }, "healthcheck.CheckItem": { "type": "object", "required": [ "checkType", "name" ], "properties": { "checkType": { "description": "sql, metrics, log, etc.", "type": "string" }, "description": { "description": "Item description", "type": "string" }, "enabled": { "description": "Whether this item is enabled", "type": "boolean" }, "errorMsg": { "description": "Error message if failed", "type": "string" }, "failed": { "description": "Whether this item failed during execution", "type": "boolean" }, "name": { "description": "Item name (unique within strategy)", "type": "string" }, "params": { "description": "JSON formatted parameters", "type": "string" } } }, "healthcheck.HealthCheckCombinedReport": { "type": "object", "properties": { "clusterId": { "type": "string" }, "createdAt": { "type": "string" }, "dbaasOrgId": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/healthcheck.HealthCheckItemReport" } }, "status": { "description": "success, partial, failed", "type": "string" }, "strategyUuid": { "type": "string" }, "timeRangeAEnd": { "type": "string" }, "timeRangeAStart": { "type": "string" }, "timeRangeBEnd": { "type": "string" }, "timeRangeBStart": { "type": "string" } } }, "healthcheck.HealthCheckItemReport": { "type": "object", "properties": { "checkType": { "type": "string" }, "content": { "description": "The actual report content from S3", "type": "object" }, "description": { "type": "string" }, "errorMsg": { "type": "string" }, "name": { "type": "string" }, "params": { "type": "object" }, "status": { "description": "success, failed", "type": "string" } } }, "healthcheck.HealthCheckResultResp": { "type": "object", "properties": { "clusterId": { "type": "string" }, "createdAt": { "type": "string" }, "creator": { "type": "string" }, "dbaasOrgId": { "description": "dbaas org id from URL", "type": "string" }, "errorMsg": { "type": "string" }, "itemsToRun": { "description": "Items to run (from strategy)", "type": "array", "items": { "type": "string" } }, "metadata": { "type": "string" }, "status": { "type": "string" }, "strategyUuid": { "type": "string" }, "timeRangeAEnd": { "type": "string" }, "timeRangeAStart": { "type": "string" }, "timeRangeBEnd": { "type": "string" }, "timeRangeBStart": { "type": "string" }, "updatedAt": { "type": "string" }, "uuid": { "type": "string" } } }, "healthcheck.HealthCheckStrategyReq": { "type": "object", "required": [ "name" ], "properties": { "description": { "type": "string" }, "items": { "description": "Check items as structured array", "type": "array", "items": { "$ref": "#/definitions/healthcheck.CheckItem" } }, "name": { "type": "string" }, "scheduleExpr": { "description": "cron expression", "type": "string" }, "scheduleType": { "description": "Schedule configuration", "type": "string" }, "timeRangeAEnd": { "type": "string" }, "timeRangeAStart": { "description": "Default time range for all check items (string format)\nSupported formats:\n- \"now\": current time\n- numeric string (e.g., \"-3600\"): relative time offset in seconds from now\n- time string (e.g., \"2026-01-01T00:00:00Z\"): absolute time\n- \"HH:MM\" (range A only, both ends): a time-of-day inspection window. For\n cron strategies the backend resolves it to the most recent occurrence\n before the trigger, interpreting the clock in the CRON_TZ timezone.", "type": "string" }, "timeRangeBEnd": { "type": "string" }, "timeRangeBStart": { "type": "string" } } }, "healthcheck.HealthCheckStrategyResp": { "type": "object", "properties": { "clusterId": { "type": "string" }, "createdAt": { "type": "string" }, "creator": { "type": "string" }, "creatorId": { "type": "integer" }, "dbaasOrgId": { "description": "dbaas org id from URL", "type": "string" }, "description": { "type": "string" }, "items": { "description": "Check items as structured array", "type": "array", "items": { "$ref": "#/definitions/healthcheck.CheckItem" } }, "lastRunAt": { "type": "string" }, "name": { "type": "string" }, "nextRunAt": { "type": "string" }, "scheduleExpr": { "type": "string" }, "scheduleType": { "type": "string" }, "status": { "type": "string" }, "timeRangeAEnd": { "type": "string" }, "timeRangeAStart": { "type": "string" }, "timeRangeBEnd": { "type": "string" }, "timeRangeBStart": { "type": "string" }, "updatedAt": { "type": "string" }, "uuid": { "type": "string" } } }, "healthcheck.HealthCheckTaskResp": { "type": "object", "properties": { "resultUuid": { "type": "string" } } }, "healthcheck.ListHealthCheckResultResp": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/healthcheck.HealthCheckResultResp" } }, "total": { "type": "integer" } } }, "healthcheck.ListHealthCheckStrategyResp": { "type": "object", "properties": { "strategies": { "type": "array", "items": { "$ref": "#/definitions/healthcheck.HealthCheckStrategyResp" } }, "total": { "type": "integer" } } }, "healthcheck.TriggerHealthCheckReq": { "type": "object", "properties": { "itemNames": { "description": "Optional: specific item names to run (if empty, run all enabled items)", "type": "array", "items": { "type": "string" } }, "timeRangeAEnd": { "type": "string" }, "timeRangeAStart": { "description": "Optional time range override (string format)\nSupported formats:\n- \"now\": current time\n- numeric string (e.g., \"-3600\"): relative time offset in seconds from now\n- time string (e.g., \"2026-01-01T00:00:00Z\"): absolute time", "type": "string" }, "timeRangeBEnd": { "type": "string" }, "timeRangeBStart": { "type": "string" } } }, "internal_api.ClusterDataURLsResponse": { "type": "object", "properties": { "clinicTenantId": { "type": "string" }, "clusterId": { "type": "string" }, "clusterMetricsUrl": { "type": "string" }, "clusterName": { "type": "string" }, "createTime": { "type": "integer" }, "dataPlaneMetricsUrl": { "type": "string" }, "deployType": { "type": "string" }, "deployTypeV2": { "type": "string" }, "logStatsS3Url": { "type": "string" }, "lokiUrl": { "type": "string" }, "orgId": { "type": "string" }, "parentId": { "description": "nextgen physical cluster id, for Premium/Byoc dataplane metrics", "type": "string" }, "projectId": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "slowQueryS3Url": { "type": "string" }, "statementsS3Url": { "type": "string" }, "status": { "type": "string" }, "topsqlS3Url": { "type": "string" } } }, "internal_key.CreateKeyRequest": { "type": "object", "properties": { "expires_in": { "description": "Optional expiration in seconds", "type": "integer" }, "name": { "type": "string" } } }, "internal_key.KeyResponse": { "type": "object", "properties": { "created_at": { "type": "integer" }, "expires_at": { "type": "integer" }, "id": { "type": "integer" }, "key": { "description": "Only returned on creation", "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } } }, "internal_key.ListKeysResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/internal_key.KeyResponse" } }, "total": { "type": "integer" } } }, "login.OAuthInfoResp": { "type": "object", "properties": { "auth_url": { "type": "string" } } }, "login.Validation": { "type": "object", "properties": { "code": { "type": "string" }, "redirect_uri": { "type": "string" }, "state": { "type": "string" } } }, "login.ValidationResp": { "type": "object", "properties": { "session_key": { "type": "string" } } }, "nextgen_client.GeneratePlanReplayerFileDownloadURLRequest": { "type": "object", "properties": { "fileName": { "type": "string" } } }, "nextgen_client.GeneratePlanReplayerFileDownloadURLResponse": { "type": "object", "properties": { "downloadUrl": { "type": "string" }, "expireTime": { "type": "string" } } }, "nextgen_client.ListPlanReplayerFilesResponse": { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/definitions/nextgen_client.PlanReplayerFile" } }, "nextPageToken": { "type": "string" } } }, "nextgen_client.PlanReplayerFile": { "type": "object", "properties": { "fileName": { "type": "string" }, "lastModified": { "type": "string" }, "sizeBytes": { "type": "string" }, "storageUri": { "type": "string" } } }, "oldreport.ComparisonReport": { "type": "object", "properties": { "args": { "$ref": "#/definitions/db.ComparisonArg" }, "createdAt": { "type": "integer" }, "creator": { "type": "string" }, "id": { "type": "integer" }, "status": { "type": "string" } } }, "oldreport.ComparisonReportResp": { "type": "object", "properties": { "reports": { "type": "array", "items": { "$ref": "#/definitions/oldreport.ComparisonReport" } }, "total": { "type": "integer" } } }, "oldreport.HealthData": { "type": "object", "properties": { "createdAt": { "type": "integer" }, "data": { "$ref": "#/definitions/compute_engine.Report" }, "updatedAt": { "type": "integer" } } }, "oldreport.HealthReport": { "type": "object", "properties": { "endTime": { "type": "integer" }, "existed": { "type": "boolean" }, "healthData": { "$ref": "#/definitions/oldreport.HealthData" }, "inRebuild": { "type": "boolean" }, "itemID": { "type": "string" }, "progress": { "type": "integer" }, "startTime": { "type": "integer" }, "status": { "type": "string" } } }, "oldreport.HealthReportReq": { "type": "object", "properties": { "endTime": { "description": "unix seconds, used when the health report is for cluster under cloud org.", "type": "integer" }, "itemID": { "type": "string" }, "startTime": { "description": "unix seconds, used when the health report is for cluster under cloud org.", "type": "integer" } } }, "oldreport.HealthReportResp": { "type": "object", "properties": { "reports": { "type": "array", "items": { "$ref": "#/definitions/oldreport.HealthReport" } } } }, "oldreport.ListTrafficComparisonReportResp": { "type": "object", "properties": { "reports": { "type": "array", "items": { "$ref": "#/definitions/oldreport.TrafficComparisonReport" } }, "total": { "type": "integer" } } }, "oldreport.ReportResp": { "type": "object", "properties": { "taskID": { "type": "string" } } }, "oldreport.TouchComparisonReportReq": { "type": "object", "properties": { "endTime1": { "type": "integer" }, "endTime2": { "type": "integer" }, "packageID1": { "type": "array", "items": { "type": "string" } }, "packageID2": { "type": "array", "items": { "type": "string" } }, "startTime1": { "type": "integer" }, "startTime2": { "type": "integer" } } }, "oldreport.TouchTrafficComparisonReportReq": { "type": "object", "properties": { "clusterID1": { "type": "string" }, "clusterID2": { "type": "string" }, "endTime1": { "type": "integer" }, "endTime2": { "type": "integer" }, "name": { "type": "string" }, "startTime1": { "type": "integer" }, "startTime2": { "type": "integer" } } }, "oldreport.TrafficComparisonReport": { "type": "object", "properties": { "clusterID1": { "type": "string" }, "clusterID2": { "type": "string" }, "createdAt": { "type": "integer" }, "creator": { "type": "string" }, "data": { "$ref": "#/definitions/oldreport.TrafficComparisonReportData" }, "datetimeDiff": { "type": "integer" }, "endTime1": { "type": "integer" }, "endTime2": { "type": "integer" }, "error": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "overAllDiff": { "type": "integer" }, "startTime1": { "type": "integer" }, "startTime2": { "type": "integer" }, "status": { "type": "string" } } }, "oldreport.TrafficComparisonReportData": { "type": "object", "properties": { "metricsDiff": {}, "sqlDiff": {} } }, "org.ApiKeyResponse": { "type": "object", "properties": { "createdTime": { "type": "integer" }, "id": { "type": "integer" }, "key": { "description": "Name string ` + "`" + `json:\"name\"` + "`" + `", "type": "string" } } }, "org.Invite": { "type": "object", "properties": { "role": { "type": "integer" }, "userName": { "type": "string" } } }, "org.InvitesReq": { "type": "object", "properties": { "invites": { "type": "array", "items": { "$ref": "#/definitions/org.Invite" } } } }, "org.ListApiKeyResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/org.ApiKeyResponse" } }, "total": { "type": "integer" } } }, "org.ListOrganizationsResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/org.Organization" } }, "total": { "type": "integer" } } }, "org.ListProjectsResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/org.Project" } }, "total": { "type": "integer" } } }, "org.ListUsersResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/org.User" } }, "total": { "type": "integer" } } }, "org.Organization": { "type": "object", "properties": { "clusterCount": { "type": "integer" }, "description": { "type": "string" }, "emailDomain": { "type": "string" }, "externalID": { "type": "string" }, "id": { "type": "string" }, "isStarred": { "type": "boolean" }, "lastUpdated": { "type": "integer" }, "name": { "type": "string" }, "owner": { "type": "string" }, "roleNames": { "description": "TODO: it should be in new api but UI hope to put in this response", "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } } }, "org.Project": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "org.Role": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "org.TaskStatus": { "type": "object", "properties": { "name": { "type": "string" }, "process": { "type": "integer" }, "size": { "type": "integer" }, "taskType": { "type": "string" } } }, "org.UpdateOrganizationReq": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" } } }, "org.User": { "type": "object", "properties": { "roleName": { "type": "string" }, "userID": { "type": "integer" }, "userName": { "type": "string" } } }, "report.GetReportResponse": { "type": "object", "properties": { "args": {}, "createdAt": { "type": "integer" }, "creator": { "type": "string" }, "data": {}, "progress": { "type": "integer" }, "status": { "type": "string" } } }, "report.ListReportResponse": { "type": "object", "properties": { "reports": { "type": "array", "items": { "$ref": "#/definitions/report.reportOverview" } }, "total": { "type": "integer" } } }, "report.PutReportRequest": { "type": "object", "properties": { "data": {}, "progress": { "type": "integer" }, "status": { "type": "string" } } }, "report.ReportStatistics": { "type": "object", "properties": { "count": { "type": "integer" } } }, "report.TouchReportRequest": { "type": "object", "properties": { "begin_ts": { "description": "these field exist for validate, other field will also pass to compute-engine", "type": "integer" }, "end_ts": { "type": "integer" }, "package_id": { "type": "string" } } }, "report.TouchReportResponse": { "type": "object", "properties": { "report_id": { "description": "Status string ` + "`" + `json:\"status\"` + "`" + `", "type": "string" } } }, "report.reportOverview": { "type": "object", "properties": { "args": {}, "createdAt": { "type": "integer" }, "creator": { "type": "string" }, "progress": { "type": "integer" }, "report_id": { "type": "string" }, "report_type": { "type": "string" }, "status": { "type": "string" } } }, "user.UserResp": { "type": "object", "properties": { "createdAt": { "type": "integer" }, "email": { "type": "string" }, "internal": { "type": "boolean" }, "userName": { "type": "string" } } }, "view.DashboardItemExternal": { "type": "object", "properties": { "clusterCreatedAt": { "type": "integer" }, "clusterDataPlaneName": { "type": "string" }, "clusterDeletedAt": { "type": "integer" }, "clusterDeployType": { "type": "string" }, "clusterDeployTypeV2": { "type": "string" }, "clusterDuration": { "type": "string" }, "clusterID": { "type": "string" }, "clusterK8sNamespace": { "type": "string" }, "clusterName": { "type": "string" }, "clusterNetworkName": { "type": "string" }, "clusterProviderName": { "type": "string" }, "clusterRegionName": { "type": "string" }, "clusterShootName": { "type": "string" }, "clusterStatus": { "type": "string" }, "clusterType": { "type": "string" }, "clusterVersion": { "type": "string" }, "controlPlaneArch": { "type": "string" }, "orgID": { "type": "string" }, "parentID": { "type": "string" }, "projectID": { "type": "string" }, "tenantID": { "type": "string" }, "tenantName": { "type": "string" }, "tenantPlan": { "type": "string" }, "topology": { "$ref": "#/definitions/db.Topology" } } }, "view.ResourcePoolComponent": { "type": "object", "properties": { "component_type": { "type": "string" }, "cpu": { "type": "integer" }, "id": { "description": "id means the component group id", "type": "string" }, "image": { "$ref": "#/definitions/view.ResourcePoolImage" }, "max_node_count": { "type": "integer" }, "memory_gi": { "type": "integer" }, "min_node_count": { "type": "integer" }, "node_count": { "type": "integer" }, "phase": { "type": "string" }, "storages": { "description": "include storage and tikv additional storage", "type": "array", "items": { "$ref": "#/definitions/view.ResourcePoolStorage" } }, "version": { "type": "string" } } }, "view.ResourcePoolImage": { "type": "object", "properties": { "repo": { "type": "string" }, "tag": { "type": "string" } } }, "view.ResourcePoolStorage": { "type": "object", "properties": { "iops": { "description": "the storage iops", "type": "integer" }, "name": { "description": "the storage name", "type": "string" }, "size_gi": { "description": "the storage size", "type": "integer" }, "throughput_mbs": { "description": "the storage throughput", "type": "integer" }, "type": { "description": "the storage type\naws s3/io2 or gcp gcs\nor azure blob", "type": "string" } } } } }` // SwaggerInfodefault_server_api holds exported Swagger Info so clients can modify it var SwaggerInfodefault_server_api = &swag.Spec{ Version: "1.0", Host: "", BasePath: "/clinic/api/v1", Schemes: []string{}, Title: "Clinic Example API", Description: "This is a Clinic server.", InfoInstanceName: "default_server_api", SwaggerTemplate: docTemplatedefault_server_api, LeftDelim: "{{", RightDelim: "}}", } func init() { swag.Register(SwaggerInfodefault_server_api.InstanceName(), SwaggerInfodefault_server_api) }