{ "swagger": "2.0", "info": { "title": "gRPC for our DBaaS central service", "description": "notably uses gRPC-Gateway with OpenAPI", "version": "0.1" }, "schemes": ["http"], "consumes": ["application/json"], "produces": ["application/json"], "paths": { "/api/v1/message/notice": { "get": { "operationId": "GetGlobalNotice", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetGlobalNoticeResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/exp-whitelist": { "get": { "operationId": "GetExpWhiteList", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetExpWhiteListResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "company_name", "in": "query", "required": false, "type": "string" }, { "name": "project_id", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "email_suffix", "in": "query", "required": false, "type": "string" } ], "tags": ["TenantService"] } }, "/api/v1/audit_log/auth0": { "post": { "operationId": "UpdateAuth0AuditLog", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralAuth0AuditLogReq" } } ], "tags": ["AuditLogService"] } }, "/api/v1/audit_log/payment_method": { "post": { "operationId": "UpdatePaymentMethodAuditLog", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralPaymentMethodAuditLogReq" } } ], "tags": ["AuditLogService"] } }, "/api/v1/org/{company_name}": { "get": { "operationId": "GetOrgByCompanyName", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetOrgByCompanyNameRsp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "company_name", "in": "path", "required": true, "type": "string" } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/cloud_providers/query": { "post": { "summary": "deprecated, use ListCloudProvidersV2 to instead", "operationId": "ListCloudProviders", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCloudProviders" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralListCloudProvidersReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/login-user-roles": { "get": { "operationId": "ListLoginUserRoles", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralListLoginUserRolesRsp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "scope_types", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": ["TenantService"] } }, "/api/v1/metrics/login-metrics": { "post": { "operationId": "LoginMetrics", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralLoginMetricsReq" } } ], "tags": ["MetricsService"] } }, "/api/v1/my-ip": { "get": { "operationId": "GetClientIP", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetClientIPResp" } } }, "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/node_profiles/query": { "post": { "summary": "deprecated, use CalcNodeProfilesV2 to instead", "operationId": "CalcNodeProfiles", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCalcNodeProfilesResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCalcNodeProfilesReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/me": { "get": { "operationId": "GetOrganization", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralOrganization" } } }, "tags": ["TenantService"] } }, "/api/v1/orgs/validate_thirdparty_token": { "post": { "operationId": "ValiadteThirdPartyToken", "description": "Valiadte Token", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralValidateThirdPartyTokenResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralValidateThirdPartyTokenReq" } } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/acception": { "post": { "operationId": "AcceptInvitation", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralAcceptInvitationReq" } } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/auth-method/email-domain": { "get": { "operationId": "GetEmailDomains", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetEmailDomainsRsp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "name", "in": "query", "required": false, "type": "string" } ], "tags": ["OrgAuthMethodService"] } }, "/api/v1/orgs/{org_id}/auth0-user": { "post": { "operationId": "CreateAuth0User", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCreateAuth0UserReq" } } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/bind_third_party": { "post": { "operationId": "OrgBindThirdParty", "description": "Org Bind Third Party", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "third_party_account_provider": { "type": "string" }, "third_party_account_token": { "type": "string" }, "third_party_free_trial": { "type": "boolean" } } } } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/cn-policy": { "post": { "operationId": "AcknowledgeCNPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralAcknowledgeCNPolicyReq" } } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/default-payment": { "put": { "operationId": "UpdateOrgDefaultPayment", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralUpdateOrgDefaultPaymentReq" } } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/org_projects": { "get": { "summary": "return projects in org, not related with user", "operationId": "ListOrgProjects", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralProjects" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "types", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/poc-applications": { "post": { "operationId": "Create POC Application", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCreatePocApplicationResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCreatePocApplicationReq" } } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/projects": { "get": { "operationId": "ListProjects", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralProjects" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "per_page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "types", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": ["TenantService"] }, "post": { "operationId": "CreateProject", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralProjectId" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCreateProjectReq" } } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}": { "delete": { "operationId": "DeleteProject", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["TenantService"] }, "patch": { "operationId": "UpdateProject", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralUpdateProjectReq" } } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/aws_vpc_peerings": { "get": { "operationId": "ListAwsVpcPeerings", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralAwsVpcPeerings" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "region", "in": "query", "required": false, "type": "string" } ], "tags": ["ClusterService"] }, "post": { "operationId": "CreateAWSVpcPeering", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCreateAWSVpcPeeringResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCreateAWSVpcPeeringReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/aws_vpc_peerings/{id}": { "get": { "operationId": "GetAwsVpcPeering", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralAwsVpcPeering" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] }, "delete": { "operationId": "DeleteAwsVpcPeering", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/cidr/regions": { "get": { "operationId": "GetProjectRegionCIDR", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetProjectRegionCIDRResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "provider", "in": "query", "required": false, "type": "string" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/cloud_providers/query": { "post": { "operationId": "ListCloudProvidersV2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCloudProviders" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "is_dev_tier": { "type": "boolean" } }, "required": ["is_dev_tier"] } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/node_profiles/query": { "post": { "operationId": "CalcNodeProfilesV2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCalcNodeProfilesResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "provider": { "type": "string" }, "region": { "type": "string" }, "is_dev_tier": { "type": "boolean" } }, "required": ["provider", "region", "is_dev_tier"] } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/cluster_fee/query": { "post": { "operationId": "CalcClusterFee", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCalcClusterFeeResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCalcClusterFeeReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters": { "get": { "operationId": "ListClusters", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralClusters" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "per_page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "provider", "in": "query", "required": false, "type": "string" }, { "name": "filter.statuses", "in": "query", "required": false, "type": "array", "items": { "type": "string", "enum": [ "NORMAL", "CREATING", "SCALING", "UPGRADING", "UNAVAILABLE", "RECOVERING", "IMPORTING", "PAUSED", "RESUMING", "DELETED", "MAINTAINING", "PAUSING" ] }, "collectionFormat": "multi" }, { "name": "filter.is_serverless", "in": "query", "required": false, "type": "boolean" } ], "tags": ["ClusterService"] }, "post": { "operationId": "CreateCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralClusterId" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralClusterCreateReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/names": { "post": { "operationId": "GenClusterName", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGenClusterNameResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}": { "delete": { "operationId": "DeleteCluster", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] }, "patch": { "operationId": "ChangeClusterName", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralChangeClusterNameReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/audit_log": { "get": { "operationId": "ClusterService_GetAuditLogStatus", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetAuditLogStatusResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] }, "put": { "operationId": "ClusterService_UpdateAuditLogStatus", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralUpdateAuditLogStatusResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralUpdateAuditLogStatusReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/audit_log/access_records": { "get": { "operationId": "ClusterService_GetAuditLogAccessRecords", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetAuditLogAccessRecordsResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] }, "post": { "operationId": "ClusterService_CreateAuditLogAccessRecord", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCreateAuditLogAccessRecordResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCreateAuditLogAccessRecordReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/audit_log/access_records/{id}": { "delete": { "operationId": "ClusterService_DeleteAuditLogAccessRecord", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDeleteAuditLogAccessRecordResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/audit_log/plugin_status": { "post": { "operationId": "ClusterService_CheckAuditLogPluginStatus", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCheckAuditLogPluginStatusResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCheckAuditLogPluginStatusReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/audit_log/precheck": { "post": { "operationId": "ClusterService_PrecheckAuditLogConfig", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralPrecheckAuditLogConfigResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralPrecheckAuditLogConfigReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/components": { "put": { "operationId": "ScaleComponent", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralScaleComponentReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/ca_cert": { "get": { "summary": "GetClusterCACertificate get the CA certitficate of the cluster", "operationId": "GetClusterCACertificate", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetClusterCACertificateResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "type", "in": "query", "required": false, "type": "string", "enum": ["DOWNLOAD_URL", "PEM"], "default": "DOWNLOAD_URL" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/connections": { "get": { "operationId": "GetPrivateEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetPrivateEndpointResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] }, "post": { "operationId": "CreatePrivateEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/password": { "put": { "operationId": "ChangePassword", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralChangePasswordReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/privatelink_endpoints": { "post": { "operationId": "CreatePrivateLinkEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCreatePrivateLinkEndpointResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "privatelink_endpoint", "description": "Only endpoint_name or endpoint_id(DEPRECATED) is required", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralPrivateLinkEndpoint" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/privatelink_endpoints/{endpoint_id}": { "delete": { "operationId": "DeletePrivateLinkEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDefaultResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "endpoint_id", "in": "path", "required": true, "type": "string" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/privatelink_service": { "get": { "operationId": "GetPrivateLinkService", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetPrivateLinkServiceResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] }, "delete": { "operationId": "DeletePrivateLinkService", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDefaultResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] }, "post": { "summary": "PrivateLink Service", "operationId": "CreatePrivateLinkService", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCreatePrivateLinkServiceResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "privatelink_service", "description": "Not required", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralPrivateLinkService" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/password-verify-code": { "post": { "operationId": "SendPasswordVerifyCode", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralSendPasswordVerifyCodeReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/tidb_nodes": { "get": { "operationId": "GetTiDBNodes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralTiDBNodes" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "per_page", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/tiflash_nodes": { "get": { "operationId": "GetTiFlashNodes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralTiFlashNodes" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "per_page", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/tikv_nodes": { "get": { "operationId": "GetTiKVNodes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralTiKVNodes" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "per_page", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/traffic_filter": { "get": { "operationId": "GetTrafficFilter", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralTrafficFilterResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] }, "post": { "operationId": "UpdateTrafficFilter", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "int64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralUpdateTrafficFilterReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/writable": { "patch": { "operationId": "MakeClusterWritable", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralMakeClusterWritableReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{id}": { "get": { "operationId": "GetCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetClusterResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{id}/secondary_cluster_profiles": { "get": { "operationId": "GetSecondaryClusterProfiles", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetSecondaryClusterProfilesResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"], "security": [ { "bearer": [] } ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clustersv2": { "post": { "operationId": "CreateClusterV2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCreateClusterResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCreateClusterReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/pause": { "post": { "operationId": "PauseCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDefaultResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/resume": { "post": { "operationId": "ResumeCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDefaultResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clustersv2/{cluster_id}/components": { "put": { "operationId": "ScaleClusterV2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDefaultResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralScaleClusterReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/cross_account_deployments": { "get": { "operationId": "ListCrossAccountDeployments", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralListCrossAccountDeploymentResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["TenantService"], "security": [ { "bearer": [] } ] }, "post": { "summary": "Cross account deployment", "operationId": "CreateCrossAccountDeployment", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCreateCrossAccountDeploymentResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCreateCrossAccountDeploymentReq" } } ], "tags": ["TenantService"], "security": [ { "bearer": [] } ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/cross_account_deployments/delegation_info": { "get": { "summary": "Give TiDB Cloud delegation info to customers", "operationId": "GetTiDBCloudDelegationInfo", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetTiDBCloudDelegationInfoResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["TenantService"], "security": [ { "bearer": [] } ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/cross_account_deployments/{id}": { "delete": { "operationId": "DeleteCrossAccountDeployment", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDefaultResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["TenantService"], "security": [ { "bearer": [] } ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/gcp_vpc_peerings": { "get": { "operationId": "ListGcpVpcPeerings", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGcpVpcPeerings" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "region", "in": "query", "required": false, "type": "string" } ], "tags": ["ClusterService"] }, "post": { "operationId": "CreateGcpVpcPeering", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCreateGcpVpcPeeringResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCreateGcpVpcPeeringReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/gcp_vpc_peerings/{id}": { "get": { "operationId": "GetGcpVpcPeering", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGcpVpcPeering" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] }, "delete": { "operationId": "DeleteGcpVpcPeering", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/integrations/newrelic/api_key/validate": { "post": { "operationId": "ValidateNewrelicAPIKey", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralIntegrationNewrelicValidateResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralIntegrationNewrelicValidateReq" } } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/metrics_key": { "get": { "operationId": "GetAllMetricsKey", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetAllMetricsKeyResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] }, "post": { "operationId": "CreateMetricsKey", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCreateMetricsKeyResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/metrics_key/{key_id}": { "delete": { "operationId": "DeleteMetricsKey", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "key_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/iam_roles": { "get": { "summary": "IAM roles", "operationId": "ListIamRoles", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralListIamRolesResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["TenantService"], "security": [ { "bearer": [] } ] }, "post": { "summary": "IAM roles", "operationId": "CreateIamRole", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCreateIamRoleResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCreateIamRoleReq" } } ], "tags": ["TenantService"], "security": [ { "bearer": [] } ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/iam_roles/{id}": { "delete": { "operationId": "DeleteIamRole", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDefaultResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["TenantService"], "security": [ { "bearer": [] } ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/privatelink_endpoints": { "get": { "operationId": "ListPrivateLinkEndpoints", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralListPrivateLinkEndpointsResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/integrations": { "get": { "operationId": "ListIntegrations", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralIntegrationListResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "type", "description": "The type field goes to query parameters.", "in": "query", "required": false, "type": "string", "enum": [ "INTEGRATION_TYPE_UNSPECIFIED", "INTEGRATION_TYPE_DATADOG", "INTEGRATION_TYPE_PROMETHEUS", "INTEGRATION_TYPE_NEWRELIC" ], "default": "INTEGRATION_TYPE_UNSPECIFIED" } ], "tags": ["IntegrationService"] }, "delete": { "operationId": "DeleteIntegration", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralIntegrationStatusResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "type", "description": "The type field goes to query parameters.", "in": "query", "required": false, "type": "string", "enum": [ "INTEGRATION_TYPE_UNSPECIFIED", "INTEGRATION_TYPE_DATADOG", "INTEGRATION_TYPE_PROMETHEUS", "INTEGRATION_TYPE_NEWRELIC" ], "default": "INTEGRATION_TYPE_UNSPECIFIED" } ], "tags": ["IntegrationService"] }, "post": { "operationId": "CreateIntegration", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralIntegrationStatusResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralIntegrationCreateReq" } } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/integrations/datadog/api_key/validate": { "post": { "operationId": "ValidateDatadogAPIKey", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralIntegrationDatadogValidateResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralIntegrationDatadogValidateReq" } } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/recycle-bin": { "get": { "operationId": "ListDeletedClusters", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDeletedClusters" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "per_page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "provider", "in": "query", "required": false, "type": "string" }, { "name": "filter.statuses", "in": "query", "required": false, "type": "array", "items": { "type": "string", "enum": [ "NORMAL", "CREATING", "SCALING", "UPGRADING", "UNAVAILABLE", "RECOVERING", "IMPORTING", "PAUSED", "RESUMING", "DELETED", "MAINTAINING", "PAUSING" ] }, "collectionFormat": "multi" }, { "name": "filter.is_serverless", "in": "query", "required": false, "type": "boolean" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/recycle-bin/{cluster_id}": { "get": { "operationId": "GetDeletedCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDeletedCluster" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/traffic_filter": { "get": { "operationId": "GetProjectTrafficFilter", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralTrafficFilterResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["TenantService"] }, "post": { "operationId": "UpdateProjectTrafficFilter", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralUpdateProjectTrafficFilterReq" } } ], "tags": ["TenantService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/user_alert": { "get": { "operationId": "GetUserAlertList", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetUserAlertListResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] }, "post": { "operationId": "SubscribeUserAlert", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralSubscribeUserAlertResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralSubscribeUserAlertReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/user_alert/{user_alert_id}": { "delete": { "operationId": "UnsubscribeUserAlert", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralUnsubscribeUserAlertResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "user_alert_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/{provider}/cidr": { "post": { "operationId": "CreateProjectCIDR", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralProjectCIDR" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "provider", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCreateProjectCIDRReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/{provider}/cidr/validation/query": { "post": { "operationId": "ValidateProjectCIDR", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDefaultResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "provider", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCreateProjectCIDRReq" } } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/{provider}/{region}/cidr": { "get": { "operationId": "GetProjectCIDR", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralProjectCIDR" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "provider", "in": "path", "required": true, "type": "string" }, { "name": "region", "in": "path", "required": true, "type": "string" } ], "tags": ["ClusterService"] } }, "/api/v1/orgs/{org_id}/users/me": { "get": { "operationId": "GetUserProfile", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralUserProfile" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["TenantService"] }, "put": { "operationId": "UpdateUserProfile", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralUpdateUserProfileReq" } } ], "tags": ["TenantService"] } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/users/discounts": { "get": { "operationId": "ListTenantDiscounts", "description": "ListTenantDiscounts", "produces": ["application/json"], "tags": ["DiscountInfo"], "summary": "List Tenant Discount (User portal)", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Discount" } } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/costexplorer/bills_details/year/{year}/month/{month}": { "get": { "operationId": "getBillsDetails", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExplorerDetailsResult" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/costexplorer/monthly_bills/year/{year}/month/{month}/export": { "post": { "operationId": "getMonthlyBillsExport", "consumes": ["application/json"], "produces": ["application/octet-stream"], "summary": "Monthly Bills Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/apiHttpBody" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/costexplorer/monthly_cost/year/{year}/month/{month}": { "get": { "operationId": "GetMonthlyCost", "consumes": ["application/json"], "produces": ["application/json"], "summary": "Cost Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.MonthlycostExplorerResult" } } }, "tags": ["BillingService"] } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/costexplorer/monthly_usage/dataapi/apps/{app_id}/year/{year}/month/{month}": { "get": { "consumes": ["application/json"], "produces": ["application/json"], "operationId": "getDataAPIUsageExplorerMonthly", "summary": "DataAPI usage Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.DataAPIUsageExplore" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/costexplorer/monthly_cost/year/{year}/month/{month}/export": { "post": { "operationId": "ExportMonthBillCSV", "consumes": ["application/json"], "produces": ["application/octet-stream"], "summary": "Cost Explorer Monthly", "tags": ["BillingService"], "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/apiHttpBody" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/invoices": { "get": { "operationId": "ListInvoices", "consumes": ["application/json"], "produces": ["application/json"], "summary": "List Invoices", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "name": "status", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Invoice" } } } }, "tags": ["BillingService"] }, "post": { "consumes": ["application/json"], "produces": ["application/json"], "summary": "Create Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "CreateInvoiceReq", "name": "CreateInvoiceReq", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CreateInvoiceReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/payments/stripe/customer": { "get": { "operationId": "GetCustomerInfo", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["StripePayment"], "summary": "GetCustomerInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.StripeCustomerInfo" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/payments/stripe/invoices": { "get": { "operationId": "ListStripeInvoices", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["StripePayment"], "summary": "ListStripeInvoices", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.StripeInvoice" } } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/payments/stripe/payment_methods": { "get": { "operationId": "ListPaymentMethods", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["StripePayment"], "summary": "ListPaymentMethods", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.StripePaymentMethod" } } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/payments/stripe/payment_methods/{payment_method_id}": { "put": { "operationId": "UpdatePaymentMethod", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["StripePayment"], "summary": "UpdatePaymentMethod", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "payment_method_id", "name": "payment_method_id", "in": "path", "required": true }, { "description": "method", "name": "method", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.StripePaymentMethod" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.StripePaymentMethod" } } } }, "delete": { "operationId": "DeletePaymentMethod", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["StripePayment"], "summary": "DeletePaymentMethod", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "payment_method_id", "name": "payment_method_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/payments/stripe/payment_methods/{payment_method_id}/validate": { "put": { "operationId": "ValidateCreditCard", "description": "credit card validation. if pass, attach the paymentMethod to customer", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["StripePayment"], "summary": "credit card validation, query after s.SetUpIntent, before s.ConfirmIntent", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "payment_method_id", "name": "payment_method_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CardValidateResult" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/payments/stripe/payment_methods/{payment_method_id}/default": { "put": { "operationId": "SetPaymentMethodDefault", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["StripePayment"], "summary": "SetPaymentMethodDefault", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "payment_method_id", "name": "payment_method_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/switch/card/validate/is_allowed": { "get": { "operationId": "AllowCreditCardValidation", "description": "access control of function: credit card validation", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["StripePayment", "Switch"], "summary": "access control", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.SwitchStruct" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/payments/stripe/setup_intent": { "post": { "operationId": "SetupIntent", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["StripePayment"], "summary": "SetupIntent", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SetupIntent" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/payments/stripe/setup_intent/confirm": { "put": { "operationId": "SetupIntentConfirm", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralOrgIdReq" } } ], "tags": ["BillingService"] } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/billing_info": { "get": { "operationId": "GetBillingInfo", "consumes": ["application/json"], "produces": ["application/json"], "summary": "Get BillingInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingInformation" } } } }, "put": { "operationId": "UpdateBillingInfo", "consumes": ["application/json"], "produces": ["application/json"], "summary": "Update BillingInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "BillingInformation", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BillingInformationInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingInformation" } } } } }, "/api_proxy/billing/api/v1/billing/support_plan": { "get": { "operationId": "GetPublicSupportPlan", "consumes": ["application/json"], "produces": ["application/json"], "summary": "Get Public Support Plan", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SupportPlan" } } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/binded_support_plan": { "get": { "operationId": "GetTenantSupportPlan", "consumes": ["application/json"], "produces": ["application/json"], "summary": "Get Tenant Support Plan", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BindedSupportPlan" } } } }, "delete": { "operationId": "CancelTenantSupportPlan", "consumes": ["application/json"], "produces": ["application/json"], "summary": "Cancel Tenant Support Plan", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/binded_support_plan/public": { "post": { "operationId": "TenantBindPublicSupportPlan", "consumes": ["application/json"], "produces": ["application/json"], "summary": "Tenant Bind Public Support Plan", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "BindSupportPlanReq", "name": "BindSupportPlanReq", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BindedSupportPlan" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BindedSupportPlan" } } } }, "delete": { "operationId": "CancelBindedTenantSupportPlan", "consumes": ["application/json"], "produces": ["application/json"], "summary": "CancelBindedTenantSupportPlan", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/credits": { "get": { "operationId": "ListTenantsCredits", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "summary": "List Tenants Credits", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.CreditsPackage" } } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/credits_summary": { "get": { "operationId": "GetTenantsCreditsSummary", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "summary": "Get Tenants Credits Summary", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CreditsSummary" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/contracts/{id}/download": { "get": { "operationId": "DownloadContract", "summary": "Download Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/apiHttpBody" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/cost_quota": { "get": { "consumes": ["application/json"], "produces": ["application/json"], "operationId": "GetTenantCostQuota", "summary": "Get Tenant Cost Quota", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostQuota" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/users/contracts": { "get": { "consumes": ["application/json"], "produces": ["application/json"], "summary": "List User View Contract", "operationId": "ListUserViewContract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "page,default=1,min=1,max=100", "name": "page", "in": "query" }, { "type": "integer", "description": "page_size,default=20,min=1,max=100", "name": "page_size", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ContractsResponse" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/users/contracts/{id}": { "get": { "consumes": ["application/json"], "produces": ["application/json"], "summary": "Get User View Contract", "operationId": "GetUserViewContract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Contract" } } } } }, "/api_proxy/billing/api/v1/billing/tenants/{tenant_id}/users/contracts/{id}/actions/{action}": { "post": { "consumes": ["application/json"], "produces": ["application/json"], "summary": "Operate Contract", "operationId": "OperateContract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "id", "name": "id", "in": "path", "required": true }, { "enum": ["accept", "reject"], "type": "string", "description": "action", "name": "action", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/api/userdebug/v1/{organization}/features": { "get": { "operationId": "getUserDebugFeatureList", "parameters": [ { "name": "organization", "in": "path", "type": "string", "required": true } ], "responses": { "200": { "description": "list of current valid auth codes", "schema": { "$ref": "#/definitions/UserDebugFeatureList" } } } } }, "/api/userdebug/v1/{organization}/authorizations": { "get": { "operationId": "getUserDebugAuthorizationList", "parameters": [ { "name": "organization", "in": "path", "type": "string", "required": true }, { "name": "page", "description": "page number", "in": "query", "type": "integer" }, { "name": "per_page", "description": "items per page", "in": "query", "type": "integer" } ], "responses": { "200": { "description": "list of current valid auth codes", "schema": { "$ref": "#/definitions/UserDebugAuthorizationList" } } } } }, "/api/userdebug/v1/{organization}/{cluster}/authorization": { "get": { "operationId": "getUserDebugAuthorizationStatus", "parameters": [ { "name": "organization", "in": "path", "type": "string", "required": true }, { "name": "cluster", "in": "path", "type": "string", "required": true } ], "responses": { "200": { "description": "current valid auth code", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserDebugAuthorization" } } }, "401": { "description": "the user credentials are not valid", "schema": { "$ref": "#/definitions/UserDebugResponseMessage" } }, "404": { "description": "cluster not found", "schema": { "$ref": "#/definitions/UserDebugResponseMessage" } } } }, "post": { "operationId": "newUserDebugAuthorization", "parameters": [ { "name": "organization", "in": "path", "type": "string", "required": true }, { "name": "cluster", "in": "path", "type": "string", "required": true }, { "name": "expires", "description": "time in hours the auth code shoud be valid", "in": "body", "schema": { "type": "integer" } } ], "responses": { "202": { "description": "new auth code granted" }, "401": { "description": "the user credentials are not valid", "schema": { "$ref": "#/definitions/UserDebugResponseMessage" } }, "404": { "description": "cluster not found", "schema": { "$ref": "#/definitions/UserDebugResponseMessage" } } } }, "delete": { "operationId": "revokeUserDebugAuthorization", "parameters": [ { "name": "organization", "in": "path", "type": "string", "required": true }, { "name": "cluster", "in": "path", "type": "string", "required": true }, { "name": "id", "description": "id of auth code to revoke", "in": "body", "schema": { "type": "string" } } ], "responses": { "200": { "description": "auth code revoked", "schema": { "$ref": "#/definitions/UserDebugResponseMessage" } }, "404": { "description": "auth code not found", "schema": { "$ref": "#/definitions/UserDebugResponseMessage" } } } } }, "/api/userdebug/v1/{organization}/{cluster}/authorization/details/{auth_id}": { "get": { "operationId": "getUserDebugAuthorizationDetail", "parameters": [ { "name": "organization", "in": "path", "type": "string", "required": true }, { "name": "cluster", "in": "path", "type": "string", "required": true }, { "name": "auth_id", "in": "path", "type": "string", "required": true } ], "responses": { "200": { "description": "detail of specified auth code", "schema": { "$ref": "#/definitions/UserDebugAuthorizationDetail" } }, "401": { "description": "the user credentials are not valid", "schema": { "$ref": "#/definitions/UserDebugResponseMessage" } }, "404": { "description": "cluster or auth code not found", "schema": { "$ref": "#/definitions/UserDebugResponseMessage" } } } } }, "/api/userdebug/v1/{organization}/{cluster}/authorization/records": { "get": { "operationId": "getUserDebugAuthorizationRecords", "parameters": [ { "name": "organization", "in": "path", "type": "string", "required": true }, { "name": "cluster", "in": "path", "type": "string", "required": true }, { "name": "page", "description": "page number", "in": "query", "type": "integer" }, { "name": "per_page", "description": "items per page", "in": "query", "type": "integer" } ], "responses": { "200": { "description": "auth records of the cluster", "schema": { "$ref": "#/definitions/UserDebugAuthorizationRecords" } }, "404": { "description": "cluster or auth code not found", "schema": { "$ref": "#/definitions/UserDebugResponseMessage" } } } } }, "/api/userdebug/v1/{organization}/{cluster}/authorization/records/{auth_id}": { "get": { "operationId": "getUserDebugAuthorizationRecordsForAuth", "parameters": [ { "name": "organization", "in": "path", "type": "string", "required": true }, { "name": "cluster", "in": "path", "type": "string", "required": true }, { "name": "auth_id", "in": "path", "type": "string", "required": true }, { "name": "page", "description": "page number", "in": "query", "type": "integer" }, { "name": "per_page", "description": "items per page", "in": "query", "type": "integer" } ], "responses": { "200": { "description": "auth records of the cluster", "schema": { "$ref": "#/definitions/UserDebugAuthorizationRecords" } }, "404": { "description": "cluster or auth code not found", "schema": { "$ref": "#/definitions/UserDebugResponseMessage" } } } } }, "/api/v1/devtier/clusters/{clusterid}": { "post": { "operationId": "setClusterHibernate", "parameters": [ { "name": "clusterid", "in": "path", "type": "string", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/HibernateClusterReq" } } ], "responses": { "200": { "description": "set cluster hibernate state successfully" }, "404": { "description": "cluster not found" } } } }, "/api/v1/devtier/clusters/projects/{project_id}/clusters/{cluster_id}": { "get": { "operationId": "getClusterStatus", "consumes": ["application/json"], "description": "getClusterStatus", "parameters": [ { "description": "project_id", "in": "path", "name": "project_id", "required": true, "type": "string" }, { "description": "cluster_id", "in": "path", "name": "cluster_id", "required": true, "type": "string" } ], "produces": ["application/json"], "responses": { "200": { "description": "OK", "schema": { "type": "string", "example": "hibernated,wakingup,running" } } }, "summary": "GetClusterStatus", "tags": ["ManageHibernatedCluster"] } }, "/api/v1/devtier/playground/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}": { "post": { "operationId": "PlaygroundSQLExecute", "consumes": ["application/json"], "description": "PlaygroundSQLExecute", "parameters": [ { "description": "org_id", "in": "path", "name": "org_id", "required": true, "type": "string" }, { "description": "project_id", "in": "path", "name": "project_id", "required": true, "type": "string" }, { "description": "cluster_id", "in": "path", "name": "cluster_id", "required": true, "type": "string" }, { "description": "requst_body", "in": "body", "required": true, "name": "body", "schema": { "$ref": "#/definitions/PlaygroundSQLReq" } } ], "produces": ["application/json"], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PlaygroundSQLRespSucc" } }, "500": { "description": "ERROR", "schema": { "$ref": "#/definitions/PlaygroundSQLRespFail" } } }, "tags": ["PlaygroundController"] }, "get": { "operationId": "GetClusterPlaygroundStatus", "consumes": ["application/json"], "description": "GetClusterPlaygroundStatus", "parameters": [ { "description": "org_id", "in": "path", "name": "org_id", "required": true, "type": "string" }, { "description": "project_id", "in": "path", "name": "project_id", "required": true, "type": "string" }, { "description": "cluster_id", "in": "path", "name": "cluster_id", "required": true, "type": "string" } ], "produces": ["text/plain"], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "summary": "GetClusterPlaygroundStatus", "tags": ["PlaygroundController"] } }, "/api/v1/serverless/orgs/{org_id}/clusters/{cluster_id}/spend_limits": { "get": { "operationId": "GetClusterSpendLimit", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/serverlessGetClusterSpendLimitsResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ServerlessBillingService"] }, "put": { "operationId": "ChangeSpendLimit", "responses": { "200": { "description": "A successful response.", "schema": { "type": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "spend_limit": { "type": "number", "format": "int32" } }, "required": ["spend_limit"] } } ], "tags": ["ServerlessBillingService"] } }, "/api/v1/serverless/orgs/{org_id}/clusters/{cluster_id}/spend_limits/details": { "get": { "operationId": "GetSpendLimitDetails", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/serverlessGetSpendLimitDetailsResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ServerlessBillingService"] } }, "/api/v1/serverless/orgs/{org_id}/clusters/{cluster_id}/spend_limits/measure": { "get": { "operationId": "GetSpendLimitMeasureDetail", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/serverlessSpendLimitsMeasureResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "spend_limit", "in": "query", "required": false, "type": "number", "format": "int32" }, { "name": "region", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ServerlessBillingService"] }, "post": { "operationId": "PredictionSpendLimitMeasure", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/serverlessSpendLimitsMeasureResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "spend_limit": { "type": "number", "format": "float" } }, "required": ["spend_limit"] } } ], "tags": ["ServerlessBillingService"] } }, "/api/v1/serverless/orgs/{org_id}/spend_limits": { "get": { "operationId": "GetAllSpendLimit", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/serverlessGetAllSpendLimitsResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ServerlessBillingService"] } }, "/api/v1/serverless/orgs/{org_id}/spend_limits/predict": { "get": { "operationId": "PredictSpendLimit", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/serverlessPredictSpendLimitResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "spend_limit", "description": "spend limit in cents", "in": "query", "required": true, "type": "integer", "format": "int64" }, { "name": "region", "in": "query", "required": true, "type": "string" }, { "name": "enhanced_encryption_enabled", "in": "query", "required": false, "type": "boolean" }, { "name": "project_id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": ["ServerlessBillingService"] } }, "/api/v1/serverless/orgs/{org_id}/clusters/{cluster_id}/spend_limits/predict": { "get": { "operationId": "PredictClusterSpendLimit", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/serverlessPredictSpendLimitResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "spend_limit", "description": "spend limit in cents", "in": "query", "required": true, "type": "integer", "format": "int64" }, { "name": "region", "in": "query", "required": true, "type": "string" }, { "name": "enhanced_encryption_enabled", "in": "query", "required": false, "type": "boolean" } ], "tags": ["ServerlessBillingService"] } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/sample/initialize": { "post": { "operationId": "ImportFortuneData", "description": "import fortune500", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "import fortune500", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SampleInitializeRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/schemas/databases": { "get": { "description": "list databases in a cluster", "operationId": "GetDatabaseList", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "list databases", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowDBsRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/schemas/databases/{db_name}/tables": { "get": { "description": "list tables in a database", "operationId": "GetTablesByDbName", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "list tables by database", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "db name", "name": "db_name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowTablesRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/schemas/databases/{db_name}/tables/{table_name}/columns": { "get": { "description": "list columns in a table", "operationId": "GetColumnsByTableName", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "list columns by database and table", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "db name", "name": "db_name", "in": "path", "required": true }, { "type": "string", "description": "table name", "name": "table_name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowColumnsRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/schemas/search": { "get": { "description": "search schema objects by keyword and type(database/table/column)", "operationId": "SearchSchemaInfo", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "search databases/tables/columns", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "database|table|column", "name": "type", "in": "query", "required": true }, { "type": "string", "description": "search keyword", "name": "keyword", "in": "query", "required": true }, { "type": "integer", "description": "max results, default 100, max 1000", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SchemaSearchRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/dbs": { "get": { "operationId": "GetSqlEditorDbList", "description": "GetSqlEditorDbList", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "show db", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowDBsRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/dbs/{db_name}": { "get": { "operationId": "GetSqlEditorTableList", "description": "GetSqlEditorTableList", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "show tables", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "db name", "name": "db_name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowTablesRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/dbs/{db_name}/{table_name}/meta": { "get": { "operationId": "GetDbMeta", "description": "table meta", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "show table meta", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "db name", "name": "db_name", "in": "path", "required": true }, { "type": "string", "description": "table name", "name": "table_name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowTableMetaRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/meta": { "get": { "operationId": "GetAllDbData", "description": "show all db meta", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "show all db meta", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "value: true or false", "name": "isbrief", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ClusterMetaRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/session": { "post": { "operationId": "CreatesSqlEditorSession", "description": "create session result", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "create session", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.SessionParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SessionRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/session/{session_id}": { "delete": { "operationId": "DeleteSqlEditorSession", "description": "close session result", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "close session", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "session ID", "name": "session_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SessionRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/settings": { "get": { "operationId": "GetSqlEditorRowsSetting", "description": "GetSqlEditorRowsSetting", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "show settings", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowSettingsRes" } } } }, "put": { "operationId": "SqlEditorRowsSetting", "description": "SqlEditorRowsSetting", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "update settings", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.SettingsParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.UpdateSettingsRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/sqlfiles": { "get": { "operationId": "GetSqlEditorFiles", "description": "GetSqlEditorFiles", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "list sql file", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListSQLFileRes" } } } }, "post": { "operationId": "CreateSqlEditorFile", "description": "CreateSqlEditorFile", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "create sql file", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.SqlEditorFile" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CreateSQLFileRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/sqlfiles/{sql_file_id}": { "get": { "operationId": "GetSqlEditorFile", "description": "GetSqlEditorFile", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "GetSqlEditorFile", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "integer", "description": "sql file ID", "name": "sql_file_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowSQLFileRes" } } } }, "put": { "operationId": "UpdateSqlEditorFile", "description": "UpdateSqlEditorFile", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "update sql file", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "integer", "description": "sql file ID", "name": "sql_file_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.SqlEditorFile" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.UpdateSQLFileRes" } } } }, "delete": { "operationId": "DeleteSqlEditorFile", "description": "DeleteSqlEditorFile", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "delete sql file", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "integer", "description": "sql file ID", "name": "sql_file_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DeleteSQLFileRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/statements": { "post": { "operationId": "SqlEditorSQLExecute", "description": "SqlEditorSQLExecute", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "execute sql", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.StatementParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.StatementsRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/users": { "get": { "operationId": "GetAIUserSetting", "description": "show user info", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "show user info", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowUserInfoRes" } } } }, "put": { "operationId": "UpdateAIUserSetting", "description": "update user info", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "update user info", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.UserInfoParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.UpdateUserInfoRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/dbs/{db_name}/{table_name}/exist": { "get": { "operationId": "GetIsTableExist", "description": "is table exist", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "is table exist", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "db name", "name": "db_name", "in": "path", "required": true }, { "type": "string", "description": "table_name", "name": "table_name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.IsDBTableExistRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/dataapi/sample": { "get": { "operationId": "GetSampleUrl", "description": "show chat2data sample url", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "show chat2data sample url", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/settings": { "put": { "operationId": "UpdateChat2DataSettings", "description": "update dataapp info", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "update dataapp info", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.DataAppSettingsFormat" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/oplog": { "post": { "operationId": "CreateChat2QueryOplog", "description": "create oplog", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "create oplog", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.SqlEditorOplogParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.BasicRes" } } } } }, "/api/v1/audit/{org_id}/audit_logs": { "get": { "operationId": "getAuditLogs", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["auditlog"], "summary": "query audit log", "parameters": [ { "type": "string", "description": "org id", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "event types", "name": "event_types", "in": "query" }, { "type": "integer", "description": "int", "name": "result", "in": "query" }, { "type": "integer", "description": "time range, started_at", "name": "started_at", "in": "query" }, { "type": "integer", "description": "time range, ended_at", "name": "ended_at", "in": "query" }, { "type": "integer", "description": "operator type", "name": "operator_type", "in": "query" }, { "type": "integer", "description": "operator id", "name": "operator_id", "in": "query" }, { "type": "string", "description": "operator email", "name": "operator_email", "in": "query" }, { "type": "string", "description": "operator ip", "name": "operator_ip", "in": "query" }, { "type": "string", "description": "login method: google/github/auth0", "name": "operator_login_method", "in": "query" }, { "type": "string", "description": "trace id", "name": "trace_id", "in": "query" }, { "type": "integer", "description": "org_id", "name": "org_id", "in": "query" }, { "type": "string", "description": "org name", "name": "org_name", "in": "query" }, { "type": "integer", "description": "project id", "name": "project_id", "in": "query" }, { "type": "string", "description": "project name", "name": "project_name", "in": "query" }, { "type": "integer", "description": "cluster id", "name": "cluster_id", "in": "query" }, { "type": "string", "description": "cluster name", "name": "cluster_name", "in": "query" }, { "type": "integer", "description": "offset, from id, use 0 by default", "name": "from", "in": "query" }, { "type": "integer", "description": "limit, limit size", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/types.QueryAuditLogResp" } } } } }, "/api/v1/audit/event_types": { "get": { "operationId": "getEventTypes", "produces": ["application/json"], "tags": ["auditlog"], "summary": "query event types", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/types.EventTypesResp" } } } } }, "/api/v1/audit/{org_id}/settings": { "put": { "operationId": "updateSettings", "produces": ["application/json"], "tags": ["auditlog"], "summary": "update settings", "parameters": [ { "type": "string", "description": "org id", "name": "org_id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/types.UpdateSettingResp" } } ], "responses": { "200": { "description": "OK" } } }, "get": { "operationId": "getSettings", "produces": ["application/json"], "tags": ["auditlog"], "summary": "query settings", "parameters": [ { "type": "string", "description": "org id", "name": "org_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/types.QuerySettingsResp" } } } } }, "/api/v1/audit/{org_id}/audit_logs/export": { "get": { "operationId": "auditLogsExport", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["auditlog"], "summary": "query audit log", "parameters": [ { "type": "string", "description": "org id", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "event types", "name": "event_types", "in": "query" }, { "type": "integer", "description": "int", "name": "result", "in": "query" }, { "type": "integer", "description": "time range, started_at", "name": "started_at", "in": "query" }, { "type": "integer", "description": "time range, ended_at", "name": "ended_at", "in": "query" }, { "type": "integer", "description": "operator type", "name": "operator_type", "in": "query" }, { "type": "integer", "description": "operator id", "name": "operator_id", "in": "query" }, { "type": "string", "description": "operator email", "name": "operator_email", "in": "query" }, { "type": "string", "description": "operator ip", "name": "operator_ip", "in": "query" }, { "type": "string", "description": "login method: google/github/auth0", "name": "operator_login_method", "in": "query" }, { "type": "string", "description": "trace id", "name": "trace_id", "in": "query" }, { "type": "integer", "description": "org_id", "name": "org_id", "in": "query" }, { "type": "string", "description": "org name", "name": "org_name", "in": "query" }, { "type": "integer", "description": "project id", "name": "project_id", "in": "query" }, { "type": "string", "description": "project name", "name": "project_name", "in": "query" }, { "type": "integer", "description": "cluster id", "name": "cluster_id", "in": "query" }, { "type": "string", "description": "cluster name", "name": "cluster_name", "in": "query" }, { "type": "integer", "description": "offset, from id, use 0 by default", "name": "from", "in": "query" }, { "type": "integer", "description": "limit, limit size", "name": "limit", "in": "query" }, { "type": "string", "description": "format", "name": "format", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "" } } } } } }, "definitions": { "baseBaseResp": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "title": "such as: request_id, trace_id" }, "err_code": { "type": "string", "format": "int64" }, "err_msg": { "type": "string" } } }, "PocQuestionOption": { "type": "object", "properties": { "name": { "type": "string" }, "is_selected": { "type": "boolean" } } }, "googlerpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/definitions/protobufAny" } } } }, "centralValidateThirdPartyTokenReq": { "type": "object", "properties": { "third_party_account_provider": { "type": "string" }, "third_party_account_token": { "type": "string" } } }, "centralValidateThirdPartyTokenResponse": { "type": "object", "properties": { "third_party_account_provider": { "type": "string" }, "third_party_account_code": { "type": "string" }, "third_party_account_code_already_binded": { "type": "boolean" } } }, "protobufAny": { "type": "object", "properties": { "type_url": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `http`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `http` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `http` (or the empty scheme) might be\nused with implementation specific semantics." }, "value": { "type": "string", "format": "byte", "description": "Must be a valid serialized protocol buffer of the above specified type." } }, "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := \u0026pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }" }, "centralGetGlobalNoticeResp": { "type": "object", "properties": { "notice": { "type": "string" }, "level": { "type": "number" }, "base_resp": { "$ref": "#/definitions/baseBaseResp" } } }, "centralGetExpWhiteListResp": { "type": "object", "properties": { "exp_names": { "type": "array", "items": { "type": "string" } }, "base_resp": { "$ref": "#/definitions/baseBaseResp" } } }, "rpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/definitions/protobufAny" } } } }, "runtimeError": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/definitions/protobufAny" } } } }, "apiHttpBody": { "type": "object", "properties": { "content_type": { "type": "string", "description": "The HTTP Content-Type header value specifying the content type of the body." }, "data": { "type": "string", "format": "byte", "description": "The HTTP request/response body as raw binary." }, "extensions": { "type": "array", "items": { "$ref": "#/definitions/protobufAny" }, "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs." } }, "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns\n (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged." }, "CalcClusterFeeRespComponentCost": { "type": "object", "properties": { "component_type": { "$ref": "#/definitions/centralComponentType" }, "compute": { "type": "number", "format": "double" }, "storage": { "type": "number", "format": "double" }, "raw_compute": { "type": "number", "format": "double" }, "raw_storage": { "type": "number", "format": "double" } }, "required": ["component_type", "compute", "storage", "raw_compute", "raw_storage"] }, "ClusterClusterType": { "type": "string", "enum": ["COMMON", "PRIMARY", "SECONDARY"], "default": "COMMON" }, "ClusterCreateProgress": { "type": "string", "enum": [ "INITIALIZING", "PREPARING", "LAUNCHING", "COMPLETED", "BACKUPING", "RESTORING", "REPLICATION_PREPARING", "HIBERNATED" ], "default": "INITIALIZING" }, "ClusterDisplayStatus": { "type": "string", "enum": [ "DISPLAY_UNSPECIFIED", "DISPLAY_CREATING", "DISPLAY_RESTORING", "DISPLAY_AVAILABLE", "DISPLAY_IMPORTING", "DISPLAY_MODIFYING", "DISPLAY_PAUSED", "DISPLAY_RESUMING", "DISPLAY_UNAVAILABLE", "DISPLAY_MAINTAINING", "DISPLAY_PAUSING" ], "default": "DISPLAY_UNSPECIFIED", "title": "Used for UI to display the cluster status" }, "ClusterSecondaryStatus": { "type": "string", "enum": ["HEALTHY", "UNHEALTHY"], "default": "HEALTHY" }, "RegistrationReqConnectionType": { "type": "string", "enum": ["EMAIL", "GOOGLE", "GITHUB", "MICROSOFT"], "default": "EMAIL" }, "centralAcceptInvitationReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "required": ["org_id", "email", "first_name", "last_name"] }, "centralAcknowledgeCNPolicyReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" } }, "required": ["org_id"] }, "centralAuditLogAccessRecord": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "user_expr": { "type": "string" }, "db_expr": { "type": "string" }, "table_expr": { "type": "string" }, "access_type_list": { "type": "array", "items": { "type": "string" } } }, "required": ["id", "user_expr", "db_expr", "table_expr", "access_type_list"] }, "centralAuditLogConfig": { "type": "object", "properties": { "bucket_url": { "type": "string" }, "region": { "type": "string" }, "role_arn": { "type": "string" }, "data_source_type": { "type": "integer", "format": "int64", "title": "1: aws s3\n2: GCS" } }, "required": ["bucket_url", "region", "role_arn", "data_source_type"] }, "centralAwsVpcPeering": { "type": "object", "properties": { "region": { "type": "string" }, "region_name": { "type": "string" }, "private_host_zone": { "type": "string" }, "vpc_peering_id": { "type": "string" }, "vpc_cidr": { "type": "string" }, "tenant_vpc_cidr": { "type": "string" }, "tenant_vpc_id": { "type": "string" }, "status": { "type": "string" }, "id": { "type": "string", "format": "uint64" } }, "required": [ "region", "region_name", "private_host_zone", "vpc_peering_id", "vpc_cidr", "tenant_vpc_cidr", "tenant_vpc_id", "status", "id" ] }, "centralAwsVpcPeerings": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralAwsVpcPeering" } } }, "required": ["total", "items"] }, "centralAuth0AuditLogReq": { "type": "object", "properties": { "operation": { "$ref": "#/definitions/centralAuth0AuditLogReqOperation" }, "is_success": { "type": "boolean" }, "failure_info": { "type": "string" }, "org_id": { "type": "string", "format": "uint64" } }, "required": ["operation", "is_success", "failure_info"] }, "centralAuth0AuditLogReqOperation": { "type": "string", "enum": ["SIGNIN", "SIGNOUT"], "default": "SIGNIN" }, "centralBaseResp": { "type": "object", "properties": { "err_code": { "type": "string", "format": "int64" }, "err_msg": { "type": "string" } } }, "centralCalcClusterFeeReq": { "type": "object", "properties": { "provider": { "type": "string" }, "region": { "type": "string" }, "is_dev_tier": { "type": "boolean", "format": "boolean" }, "components": { "type": "array", "items": { "$ref": "#/definitions/centralClusterComponent" } }, "is_cluster_paused": { "type": "boolean" } }, "required": ["provider", "region", "is_dev_tier", "components"] }, "centralCalcClusterFeeResp": { "type": "object", "properties": { "costs": { "type": "array", "items": { "$ref": "#/definitions/CalcClusterFeeRespComponentCost" } }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["costs", "base_resp"] }, "centralCalcNodeProfilesReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "provider": { "type": "string" }, "region": { "type": "string" }, "is_dev_tier": { "type": "boolean", "format": "boolean" } }, "required": ["project_id", "provider", "region", "is_dev_tier"] }, "centralCalcNodeProfilesResp": { "type": "object", "properties": { "node_profiles": { "type": "array", "items": { "$ref": "#/definitions/centralComponentNodeProfiles" } }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["node_profiles", "base_resp"] }, "centralChangeClusterNameReq": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "cluster_name": { "type": "string" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": ["cluster_id", "cluster_name", "org_id", "project_id"] }, "centralChangePasswordReq": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "password": { "type": "string" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": ["password"] }, "centralCheckAuditLogPluginStatusReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" } }, "required": ["org_id", "project_id", "cluster_id"] }, "centralCheckAuditLogPluginStatusResp": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"] }, "centralCloudProvider": { "type": "object", "properties": { "name": { "type": "string" }, "regions": { "type": "array", "items": { "$ref": "#/definitions/centralRegion" } } }, "required": ["name", "regions"] }, "centralCloudProviders": { "type": "object", "properties": { "cloud_providers": { "type": "array", "items": { "$ref": "#/definitions/centralCloudProvider" } }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["cloud_providers", "base_resp"] }, "centralCluster": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "status": { "$ref": "#/definitions/centralClusterStatus" }, "secondary_status": { "$ref": "#/definitions/ClusterSecondaryStatus" }, "version": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "region_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "created_by": { "$ref": "#/definitions/centralUser" }, "endpoint": { "$ref": "#/definitions/centralEndpoint" }, "vpc_cidr_block": { "type": "string" }, "capacity": { "type": "integer", "format": "int64" }, "cluster_components": { "$ref": "#/definitions/centralClusterComponents" }, "create_progress": { "$ref": "#/definitions/ClusterCreateProgress" }, "prometheus_ready": { "type": "boolean" }, "privateEndpoint": { "$ref": "#/definitions/centralEndpoint" }, "restored": { "type": "boolean" }, "import_id": { "type": "string", "format": "uint64" }, "lastErrors": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/centralLastError" } }, "replications": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/centralReplication" } }, "cluster_type": { "$ref": "#/definitions/ClusterClusterType" }, "write_status": { "$ref": "#/definitions/centralWriteStatus" }, "is_dev_tier": { "type": "boolean" }, "cross_account_deployment_id": { "type": "string", "format": "uint64" }, "display_status": { "$ref": "#/definitions/ClusterDisplayStatus" }, "has_set_pwd": { "type": "boolean", "title": "Used for UI" }, "dev_tier_type": { "$ref": "#/definitions/centralClusterDevTierClusterType" }, "features": { "type": "array", "items": { "$ref": "#/definitions/centralClusterAvailableFeature" }, "title": "Used for UI" }, "autoScaling": { "allOf": [ { "$ref": "#/definitions/centralClusterAutoScaling" } ], "description": "Optional. The auto scaling config for the cluster." } }, "required": [ "id", "name", "status", "secondary_status", "version", "provider", "region", "region_name", "created_at", "created_by", "endpoint", "vpc_cidr_block", "capacity", "cluster_components", "create_progress", "prometheus_ready", "privateEndpoint", "restored", "import_id", "lastErrors", "replications", "cluster_type", "write_status", "is_dev_tier" ] }, "centralClusterAvailableFeature": { "type": "string", "enum": ["DISABLE_PUBLIC_LB", "PRIVATELINK", "DELEGATE_USER", "VECTOR_TYPE", "THREE_LAYER_ARCH"], "default": "DISABLE_PUBLIC_LB", "title": "Available feature for a cluster" }, "centralClusterAutoScaling": { "description": "Message for auto scaling configuration.", "properties": { "maxRcu": { "format": "uint64", "type": "integer" }, "minRcu": { "format": "uint64", "type": "integer" } }, "type": "object" }, "centralClusterComponent": { "type": "object", "properties": { "component_type": { "$ref": "#/definitions/centralComponentType" }, "node_profile_name": { "type": "string" }, "replicas": { "type": "integer", "format": "int32" }, "storage_size_gi": { "type": "integer", "format": "int32" } }, "required": ["component_type", "node_profile_name", "replicas", "storage_size_gi"] }, "centralClusterComponents": { "type": "object", "properties": { "tikv": { "$ref": "#/definitions/centralComponent" }, "tidb": { "$ref": "#/definitions/centralComponent" }, "tiflash": { "$ref": "#/definitions/centralComponent" } }, "required": ["tikv", "tidb", "tiflash"] }, "centralClusterCreateReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "root_password": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "profile_name": { "type": "string" }, "tikv_count": { "type": "integer", "format": "int64" }, "tidb_count": { "type": "integer", "format": "int64" }, "tiflash_count": { "type": "integer", "format": "int64" }, "primary_cluster_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": [ "org_id", "name", "root_password", "provider", "region", "profile_name", "tikv_count", "tidb_count", "tiflash_count", "project_id" ] }, "centralClusterId": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" } }, "required": ["id"] }, "centralDatadogSite": { "type": "string", "enum": [ "DATADOG_SITE_UNSPECIFIED", "DATADOG_SITE_US1", "DATADOG_SITE_US3", "DATADOG_SITE_US5", "DATADOG_SITE_EU1", "DATADOG_SITE_US1_FED", "DATADOG_SITE_AP1" ], "default": "DATADOG_SITE_UNSPECIFIED" }, "dataflowClusterImportId": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "id": { "type": "string", "format": "uint64" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": ["cluster_id", "id", "org_id", "project_id"] }, "centralClusterDevTierClusterType": { "type": "string", "enum": ["DEVTIER_UNSPECIFIED", "DEVTIER_CLASSIC", "DEVTIER_SERVERLESS"], "default": "DEVTIER_UNSPECIFIED", "title": "Used for Dev Tier \u0026 UI" }, "centralClusterNodeProfile": { "type": "object", "properties": { "name": { "type": "string" }, "display_name": { "type": "string" }, "default_storage_size_gi": { "type": "integer", "format": "int32" }, "cpu_num": { "type": "integer", "format": "int32" }, "memory_gi": { "type": "integer", "format": "int32" }, "default_node_num": { "type": "integer", "format": "int32" }, "min_storage_size_gi": { "type": "integer", "format": "int32" }, "max_storage_size_gi": { "type": "integer", "format": "int32" } }, "required": ["name", "cpu_num", "default_node_num", "min_storage_size_gi", "max_storage_size_gi"] }, "centralClusterStatus": { "type": "string", "enum": [ "NORMAL", "CREATING", "SCALING", "UPGRADING", "UNAVAILABLE", "RECOVERING", "IMPORTING", "PAUSED", "RESUMING", "DELETED", "MAINTAINING", "PAUSING" ], "default": "NORMAL" }, "centralClusters": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralCluster" } }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["total", "items"] }, "centralComponent": { "type": "object", "properties": { "replicas": { "type": "integer", "format": "int64" }, "node_profile": { "$ref": "#/definitions/centralNodeProfile" }, "modify_progress": { "$ref": "#/definitions/centralComponentModifyProgress", "title": "available if the cluster is modifying" } }, "required": ["replicas", "node_profile"] }, "centralComponentModifyProgress": { "type": "object", "properties": { "pending": { "type": "boolean" }, "expected_quantity": { "type": "integer", "format": "int32" }, "uptodate_quantity": { "type": "integer", "format": "int32" }, "remaining_deletion_quantity": { "type": "integer", "format": "int32" } }, "required": ["expected_quantity", "uptodate_quantity", "remaining_deletion_quantity"] }, "centralComponentNodeProfiles": { "type": "object", "properties": { "component_type": { "$ref": "#/definitions/centralComponentType" }, "default_profile_name": { "type": "string", "format": "uint64" }, "profiles": { "type": "array", "items": { "$ref": "#/definitions/centralClusterNodeProfile" } } }, "required": ["component_type", "default_profile_name", "profiles"] }, "centralComponentScale": { "type": "object", "properties": { "component_name": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" } }, "required": ["component_name", "replicas"] }, "centralComponentType": { "type": "string", "enum": [ "COMPONENT_TYPE_UNSPECIFIED", "COMPONENT_TYPE_TIDB", "COMPONENT_TYPE_TIKV", "COMPONENT_TYPE_TIFLASH", "COMPONENT_TYPE_PD", "COMPONENT_TYPE_TICDC" ], "default": "COMPONENT_TYPE_UNSPECIFIED" }, "centralCompute": { "type": "object", "properties": { "cpu": { "type": "number", "format": "float" }, "memory_mi": { "type": "integer", "format": "int64" } }, "required": ["cpu", "memory_mi"] }, "centralCreateAWSVpcPeeringReq": { "type": "object", "properties": { "tenant_region": { "type": "string" }, "tenant_vpc_id": { "type": "string" }, "tenant_account_id": { "type": "string" }, "tenant_vpc_cidr": { "type": "string" }, "region": { "type": "string" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": [ "tenant_region", "tenant_vpc_id", "tenant_account_id", "tenant_vpc_cidr", "region", "org_id", "project_id" ] }, "centralCreateAWSVpcPeeringResp": { "type": "object", "properties": { "vpc_peering_id": { "type": "string" }, "vpc_cidr": { "type": "string" }, "private_host_zone": { "type": "string" }, "region": { "type": "string" }, "id": { "type": "string", "format": "uint64" } }, "required": ["vpc_peering_id", "vpc_cidr", "private_host_zone", "region", "id"] }, "centralCreateAuditLogAccessRecordReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" }, "record": { "$ref": "#/definitions/centralAuditLogAccessRecord" } }, "required": ["org_id", "project_id", "cluster_id", "record"] }, "centralCreateAuditLogAccessRecordResp": { "type": "object" }, "centralCreateAuth0UserReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "token": { "type": "string" }, "password": { "type": "string" } }, "required": ["org_id", "token", "password"] }, "centralPaymentMethodAuditLogReq": { "type": "object", "properties": { "operation": { "$ref": "#/definitions/centralPaymentMethodAuditLogReqOperation" }, "is_success": { "type": "boolean" }, "card_number_last4": { "type": "string" } }, "required": ["operation", "is_success", "card_number_last4"] }, "centralPaymentMethodAuditLogReqOperation": { "type": "string", "enum": ["ADD", "UPDATE", "DELETE"], "default": "ADD" }, "centralCreateOpenAPIKeyReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "role": { "type": "string" }, "description": { "type": "string" } }, "required": ["org_id", "role", "description"] }, "centralCreatePocApplicationReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "questions": { "type": "array", "items": { "$ref": "#/definitions/centralPocQuestion" } }, "poc_record_type": { "type": "string" }, "sub_topic": { "type": "string" }, "msg": { "type": "string" } } }, "centralCreatePocApplicationResp": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["id", "base_resp"] }, "centralCreateClusterReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "is_dev_tier": { "type": "boolean", "format": "boolean" }, "components": { "type": "array", "items": { "$ref": "#/definitions/centralClusterComponent" } }, "primary_cluster_id": { "type": "string", "format": "uint64" }, "ignore_replication": { "type": "boolean" }, "port": { "type": "integer", "format": "int32" }, "cross_account_deployment_id": { "type": "string", "format": "uint64" }, "spend_limit": { "type": "number", "format": "int32" } }, "required": ["org_id", "project_id", "name", "provider", "region", "is_dev_tier", "components", "port"] }, "centralCreateClusterResp": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["id", "base_resp"] }, "centralCreateGcpVpcPeeringReq": { "type": "object", "properties": { "tenant_project_id": { "type": "string" }, "tenant_vpc_region": { "type": "string" }, "tenant_network_name": { "type": "string" }, "region": { "type": "string" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "tenant_vpc_cidr": { "type": "string" } }, "required": [ "tenant_project_id", "tenant_vpc_region", "tenant_network_name", "region", "org_id", "project_id", "tenant_vpc_cidr" ] }, "centralCreateCrossAccountDeploymentReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "provider": { "type": "string" }, "region": { "type": "string" }, "vpc_id": { "type": "string" }, "security_group_id": { "type": "string" }, "subnet_ids": { "type": "array", "items": { "type": "string" } }, "bucket_name": { "type": "string" }, "kms_key_arn": { "type": "string" }, "pca_arn_cluster_components": { "type": "string" }, "pca_arn_client": { "type": "string" }, "role_arn_tidb_cloud": { "type": "string" }, "role_arn_eks": { "type": "string" }, "role_arn_node": { "type": "string" } }, "required": [ "org_id", "project_id", "provider", "region", "vpc_id", "security_group_id", "subnet_ids", "bucket_name", "kms_key_arn", "pca_arn_cluster_components", "pca_arn_client", "role_arn_tidb_cloud", "role_arn_eks", "role_arn_node" ] }, "centralCreateCrossAccountDeploymentResp": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["id", "base_resp"] }, "centralCreateIamRoleReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "role_arn": { "type": "string" } }, "required": ["role_arn"] }, "centralCreateIamRoleResp": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["id", "base_resp"] }, "centralCreateGcpVpcPeeringResp": { "type": "object", "properties": { "project_id": { "type": "string" }, "network_name": { "type": "string" }, "region": { "type": "string" }, "id": { "type": "string", "format": "uint64" } }, "required": ["project_id", "network_name", "region", "id"] }, "centralGetAllMetricsKeyResp": { "type": "object", "properties": { "metrics_keys": { "type": "array", "items": { "$ref": "#/definitions/centralMetricsKey" } } } }, "centralCreateMetricsKeyResp": { "type": "object", "properties": { "key": { "$ref": "#/definitions/centralMetricsKey" } } }, "centralCreateProjectCIDRReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "provider": { "type": "string" }, "cidr": { "type": "string" } }, "required": ["org_id", "project_id", "provider", "cidr"] }, "centralCreateProjectReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "enable_xaccount_deploy": { "type": "boolean" }, "aws_cmek_enabled": { "type": "boolean" }, "type": { "type": "string" } }, "required": ["org_id", "name", "enable_xaccount_deploy"] }, "centralCredits": { "type": "object", "properties": { "amount": { "type": "string", "format": "int64" }, "created": { "type": "string", "format": "int64" } }, "required": ["amount", "created"] }, "centralCreditsHistory": { "type": "object", "properties": { "amount": { "type": "string", "format": "int64" }, "history": { "type": "array", "items": { "$ref": "#/definitions/centralCredits" } } }, "required": ["amount", "history"] }, "centralCreatePrivateLinkEndpointResp": { "type": "object", "properties": { "privatelink_endpoint": { "$ref": "#/definitions/centralPrivateLinkEndpoint" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["privatelink_endpoint", "base_resp"] }, "centralCreatePrivateLinkServiceResp": { "type": "object", "properties": { "privatelink_service": { "$ref": "#/definitions/centralPrivateLinkService" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["privatelink_service", "base_resp"] }, "centralCrossAccountDeployment": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "created_at": { "type": "string", "format": "date-time" }, "project_id": { "type": "string", "format": "uint64" }, "provider": { "type": "string" }, "region": { "type": "string" }, "region_name": { "type": "string" }, "vpc_id": { "type": "string" }, "security_group_id": { "type": "string" }, "subnet_ids": { "type": "array", "items": { "type": "string" } }, "bucket_name": { "type": "string" }, "kms_key_arn": { "type": "string" }, "pca_arn_cluster_components": { "type": "string" }, "pca_arn_client": { "type": "string" }, "role_arn_tidb_cloud": { "type": "string" }, "role_arn_eks": { "type": "string" }, "role_arn_node": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "created_at", "project_id", "provider", "region", "region_name", "vpc_id", "security_group_id", "subnet_ids", "bucket_name", "kms_key_arn", "pca_arn_cluster_components", "pca_arn_client", "role_arn_tidb_cloud", "role_arn_eks", "role_arn_node", "status" ] }, "centralDefaultResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["base_resp"] }, "centralDeleteAuditLogAccessRecordResp": { "type": "object" }, "centralDeletedCluster": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "region_name": { "type": "string" }, "profile_name": { "type": "string" }, "delete_time": { "type": "string", "format": "date-time" }, "latest_backup_size": { "type": "string", "format": "uint64" }, "cross_account_deployment_id": { "type": "string", "format": "uint64" } }, "required": [ "id", "name", "provider", "region", "region_name", "profile_name", "delete_time", "latest_backup_size" ] }, "centralDeletedClusters": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralDeletedCluster" } } }, "required": ["total", "items"] }, "centralEndpoint": { "type": "object", "properties": { "ready": { "type": "boolean", "format": "boolean" }, "address": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "token": { "type": "string" } }, "required": ["ready", "address", "port", "token"] }, "centralGcpVpcPeering": { "type": "object", "properties": { "region": { "type": "string" }, "region_name": { "type": "string" }, "network_name": { "type": "string" }, "project_id": { "type": "string" }, "tenant_project_id": { "type": "string" }, "tenant_network_name": { "type": "string" }, "status": { "type": "string" }, "vpc_cidr": { "type": "string" }, "id": { "type": "string", "format": "uint64" }, "tenant_vpc_cidr": { "type": "string" } }, "required": [ "region", "region_name", "network_name", "project_id", "tenant_project_id", "tenant_network_name", "status", "vpc_cidr", "id" ] }, "centralGcpVpcPeerings": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralGcpVpcPeering" } } }, "required": ["total", "items"] }, "centralGenClusterNameResp": { "type": "object", "properties": { "name": { "type": "string" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["name", "base_resp"] }, "centralGetAuditLogAccessRecordsResp": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/definitions/centralAuditLogAccessRecord" } } } }, "centralGetAuditLogStatusResp": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "audit_log_config": { "$ref": "#/definitions/centralAuditLogConfig" } }, "required": ["enabled", "audit_log_config"] }, "centralGetClientIPResp": { "type": "object", "properties": { "ip": { "type": "string" } }, "required": ["ip"] }, "centralGetClusterCACertificateReqType": { "type": "string", "enum": ["DOWNLOAD_URL", "PEM"], "default": "DOWNLOAD_URL" }, "centralGetClusterCACertificateResp": { "type": "object", "properties": { "certificate": { "type": "string", "format": "byte" }, "download_url": { "type": "string" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["certificate", "download_url", "base_resp"] }, "centralGetClusterResp": { "type": "object", "properties": { "cluster": { "$ref": "#/definitions/centralCluster" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["cluster", "base_resp"] }, "centralGetClusterTCUResp": { "type": "object", "properties": { "tcu_number": { "type": "string", "format": "uint64" } }, "required": ["tcu_number"] }, "centralPrecheckAuditLogConfigReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" }, "audit_log_config": { "$ref": "#/definitions/centralAuditLogConfig" } }, "required": ["org_id", "project_id", "cluster_id", "audit_log_config"] }, "centralPrecheckAuditLogConfigResp": { "type": "object", "properties": { "valid": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["valid", "message"] }, "centralGetPrivateEndpointResp": { "type": "object", "properties": { "status": { "$ref": "#/definitions/centralPrivateEndpointStatus" }, "domain": { "type": "string" }, "port": { "type": "string", "format": "uint64" } }, "required": ["status", "domain", "port"] }, "centralGetPrivateLinkServiceResp": { "type": "object", "properties": { "privatelink_service": { "$ref": "#/definitions/centralPrivateLinkService" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["privatelink_service", "base_resp"] }, "centralGetProjectRegionCIDRResp": { "type": "object", "properties": { "project_region_cidrs": { "type": "array", "items": { "$ref": "#/definitions/centralProjectRegionCIDR" } } } }, "centralGetTiDBCloudDelegationInfoResp": { "type": "object", "properties": { "account_id": { "type": "string" }, "external_id": { "type": "string" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["account_id", "external_id", "base_resp"] }, "centralGetUserAlertListResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/centralUserAlertItem" } } } }, "centralIamRole": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "arn": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "usages": { "type": "array", "items": { "$ref": "#/definitions/centralIamRoleUsage" } } }, "title": "cross account deployment service", "required": ["id", "arn", "created_at", "usages"] }, "centralIamRoleUsage": { "type": "object", "properties": { "service_name": { "type": "string" }, "provider_name": { "type": "string" }, "region": { "type": "string" }, "region_name": { "type": "string" } }, "required": ["service_name", "provider_name", "region", "region_name"] }, "centralImportGetRespStatus": { "type": "string", "enum": ["UNKNOWN", "PREPARING", "IMPORTING", "COMPLETED", "FAILED", "CANCELING", "CANCELED"], "default": "UNKNOWN" }, "centralInfraErrorCode": { "type": "string", "enum": ["INFRA_RESOURCES_DEPLETED"], "default": "INFRA_RESOURCES_DEPLETED" }, "centralIntegrationCreateReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "type": { "$ref": "#/definitions/centralIntegrationType" }, "payloads": { "type": "array", "items": { "$ref": "#/definitions/centralIntegrationPayload" } }, "datadog_api_key": { "type": "string" }, "datadog_site": { "$ref": "#/definitions/centralDatadogSite" }, "newrelic_api_key": { "type": "string" }, "newrelic_site": { "$ref": "#/definitions/centralNewrelicSite" } }, "required": ["org_id", "project_id", "type", "payloads"] }, "centralIntegrationDatadogValidateReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "datadog_api_key": { "type": "string" }, "datadog_site": { "$ref": "#/definitions/centralDatadogSite" } }, "required": ["datadog_api_key", "datadog_site"] }, "centralIntegrationDatadogValidateResp": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "valid": { "type": "boolean", "format": "boolean" } }, "required": ["org_id", "project_id", "valid"] }, "centralIntegrationListResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/centralIntegrationStatusResp" } }, "total": { "type": "integer", "format": "int32" } }, "required": ["items", "total"] }, "centralIntegrationNewrelicValidateReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "newrelic_api_key": { "type": "string" }, "newrelic_site": { "$ref": "#/definitions/centralNewrelicSite" } }, "required": ["newrelic_api_key", "newrelic_site"] }, "centralIntegrationNewrelicValidateResp": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "valid": { "type": "boolean" } }, "required": ["org_id", "project_id", "valid"] }, "centralIntegrationPayload": { "type": "string", "enum": [ "INTEGRATION_PAYLOAD_UNSPECIFIED", "INTEGRATION_PAYLOAD_METRICS", "INTEGRATION_PAYLOAD_LOGS", "INTEGRATION_PAYLOAD_TRACES" ], "default": "INTEGRATION_PAYLOAD_UNSPECIFIED" }, "centralIntegrationStatus": { "type": "string", "enum": [ "INTEGRATION_STATUS_UNSPECIFIED", "INTEGRATION_STATUS_NONE", "INTEGRATION_STATUS_ACTIVE", "INTEGRATION_STATUS_ERROR" ], "default": "INTEGRATION_STATUS_UNSPECIFIED" }, "centralIntegrationStatusResp": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "type": { "$ref": "#/definitions/centralIntegrationType" }, "status": { "$ref": "#/definitions/centralIntegrationStatus" }, "status_reason": { "type": "string", "description": "status_reason contains error message of the underlying data pipeline." }, "payloads": { "type": "array", "items": { "$ref": "#/definitions/centralIntegrationPayload" } }, "datadog_site": { "$ref": "#/definitions/centralDatadogSite" }, "datadog_site_url": { "type": "string" }, "datadog_dashboard_url": { "type": "string" }, "datadog_masked_api_key": { "type": "string" }, "newrelic_site": { "$ref": "#/definitions/centralNewrelicSite" }, "newrelic_site_url": { "type": "string" }, "newrelic_dashboard_url": { "type": "string" }, "newrelic_masked_api_key": { "type": "string" } }, "required": ["org_id", "project_id", "type", "status"] }, "centralIntegrationType": { "type": "string", "enum": [ "INTEGRATION_TYPE_UNSPECIFIED", "INTEGRATION_TYPE_DATADOG", "INTEGRATION_TYPE_PROMETHEUS", "INTEGRATION_TYPE_NEWRELIC" ], "default": "INTEGRATION_TYPE_UNSPECIFIED", "title": "Third-party integration service\nPlease refer to style guide: http://developers.google.com/protocol-buffers/docs/style#enums" }, "centralInviteUserReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "email": { "type": "string" }, "role": { "type": "string" } }, "required": ["org_id", "project_id", "email", "role"] }, "centralLastError": { "type": "object", "properties": { "codes": { "type": "array", "items": { "$ref": "#/definitions/centralInfraErrorCode" } } }, "required": ["codes"] }, "centralListCloudProvidersReq": { "type": "object", "properties": { "is_dev_tier": { "type": "boolean", "format": "boolean" }, "project_id": { "type": "string", "format": "uint64" } }, "required": ["is_dev_tier", "project_id"] }, "centralListCrossAccountDeploymentResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/centralCrossAccountDeployment" } }, "total": { "type": "integer", "format": "int32" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["items", "total", "base_resp"] }, "centralListIamRolesResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/centralIamRole" } }, "total": { "type": "integer", "format": "int32" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["items", "total", "base_resp"] }, "centralMakeClusterWritableReq": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": ["cluster_id", "org_id", "project_id"] }, "centralLoginMetricsReq": { "type": "object", "properties": { "event_type": { "type": "string" }, "event_result": { "type": "string" }, "event_time": { "type": "string" }, "error": { "type": "string" }, "token": { "type": "string" }, "cost": { "type": "string" }, "desc": { "type": "string" } }, "required": ["event_type", "event_result", "event_time"] }, "centralMetaData": { "type": "object", "properties": { "email": { "type": "string" }, "runtime": { "type": "string" }, "tenantId": { "type": "string", "format": "uint64" }, "use_mfa": { "type": "boolean", "format": "boolean" } }, "required": ["email", "runtime", "tenantId", "use_mfa"] }, "centralListPrivateLinkEndpointsResp": { "type": "object", "properties": { "endpoints": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/centralPrivateLinkEndpoint" } }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["endpoints", "base_resp"] }, "centralNodeProfile": { "type": "object", "properties": { "compute": { "$ref": "#/definitions/centralCompute" }, "storage_gi": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "display_name": { "type": "string" } }, "required": ["compute", "storage_gi", "name"] }, "centralGetEmailDomainsRsp": { "type": "object", "properties": { "email_domains": { "type": "array", "items": { "type": "string" } } } }, "centralGetOrgByCompanyNameRsp": { "type": "object", "properties": { "org": { "$ref": "#/definitions/centralOrganization" } } }, "centralOrgIdReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" } }, "required": ["org_id"] }, "centralOrganization": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "country": { "type": "string" }, "timezone": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "plan": { "type": "string" }, "total_credit": { "type": "string", "format": "int64" }, "remaining_credit": { "type": "string", "format": "int64" }, "active_clusters_count": { "type": "integer", "format": "int64" }, "has_discount": { "type": "boolean", "format": "boolean" }, "discount_description": { "type": "string" }, "discount": { "type": "string", "format": "int64" }, "can_replication": { "type": "boolean", "format": "boolean" }, "acknowledge_cn_policy": { "type": "boolean", "format": "boolean" }, "free_clusters_count": { "type": "integer", "format": "int64" }, "has_tried_dev_tier": { "type": "boolean", "format": "boolean" }, "third_party_account_provider": { "type": "string" }, "third_party_account_code": { "type": "string" }, "whitelist_flag": { "type": "integer", "format": "int64" }, "org_type": { "type": "string" }, "company_name": { "type": "string" }, "user_set_timezone": { "type": "string" } }, "required": [ "id", "name", "created_at", "email", "country", "timezone", "status", "plan", "total_credit", "remaining_credit", "active_clusters_count", "has_discount", "discount_description", "discount", "can_replication", "free_clusters_count", "acknowledge_cn_policy", "has_tried_dev_tier", "whitelist_flag", "org_type", "third_party_account_provider", "third_party_account_code", "user_set_timezone" ] }, "centralOrganizationList": { "type": "object", "properties": { "defaultCluster": { "type": "string" }, "isNewUser": { "type": "boolean" }, "orgs": { "type": "array", "items": { "$ref": "#/definitions/centralOrganization" } } } }, "centralPrivateEndpointStatus": { "type": "string", "enum": ["NO_VPC_PEERING", "VPC_PEERING_ERROR", "NO_DOMAIN", "CREATING", "NORMAL"], "default": "NO_VPC_PEERING" }, "centralPocQuestion": { "type": "object", "properties": { "number": { "type": "string", "format": "uint64" }, "type": { "$ref": "#/definitions/centralPocQuestionType" }, "question": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/definitions/PocQuestionOption" } }, "note": { "type": "string" } } }, "centralPocQuestionType": { "type": "string", "enum": ["RADIO", "CHECKBOX", "TEXT"], "default": "RADIO" }, "centralProject": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "active_clusters_count": { "type": "integer", "format": "int64" }, "users_count": { "type": "integer", "format": "int64" }, "aws_cmek_enabled": { "type": "boolean" }, "type": { "type": "string" } }, "required": ["id", "name", "active_clusters_count", "users_count"] }, "centralPrivateLinkEndpoint": { "type": "object", "properties": { "cloud_provider": { "type": "string" }, "cluster_id": { "type": "string", "format": "uint64" }, "cluster_name": { "type": "string" }, "region_name": { "type": "string" }, "endpoint_id": { "type": "string", "title": "[DEPRECATED] should use endpoint_name instead" }, "status": { "$ref": "#/definitions/centralPrivateLinkEndpointStatus" }, "message": { "type": "string" }, "service_name": { "type": "string" }, "service_status": { "$ref": "#/definitions/centralPrivateLinkServiceStatus" }, "cluster_status": { "$ref": "#/definitions/centralClusterStatus" }, "id": { "type": "string", "format": "uint64", "title": "Unique ID" }, "endpoint_name": { "type": "string" } } }, "centralPrivateLinkEndpointStatus": { "type": "string", "enum": ["NOT_CONFIGURE", "PENDING", "ACTIVE", "DELETING", "FAILED"], "default": "NOT_CONFIGURE", "title": "- PENDING: The following must be consistent with 'PrivateLinkServicePhase' defined in infra-api" }, "centralPrivateLinkService": { "type": "object", "properties": { "cloud_provider": { "type": "string" }, "name": { "type": "string" }, "status": { "$ref": "#/definitions/centralPrivateLinkServiceStatus" }, "dns_name": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "az_ids": { "type": "array", "items": { "type": "string" }, "title": "availability zones, for example: 'usw2-az2', 'usw2-az1'" } } }, "centralPrivateLinkServiceStatus": { "type": "string", "enum": ["NOT_CONFIGURE", "CREATING", "ACTIVE", "DELETING"], "default": "NOT_CONFIGURE", "title": "- CREATING: The following must be consistent with 'PrivateLinkServicePhase' defined in infra-api" }, "centralProjectCIDR": { "type": "object", "properties": { "cidr": { "type": "string" }, "is_default": { "type": "boolean", "format": "boolean" }, "region_cidr": { "type": "string" } }, "required": ["cidr", "is_default", "region_cidr"] }, "centralProjectId": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" } }, "required": ["id"] }, "centralProjectRegionCIDR": { "type": "object", "properties": { "provider": { "type": "string" }, "cidr": { "type": "string" }, "regions": { "type": "array", "items": { "$ref": "#/definitions/centralRegionCIDR" } } }, "required": ["provider", "cidr", "regions"] }, "centralProjects": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralProject" } } }, "required": ["total", "items"] }, "centralRegion": { "type": "object", "properties": { "name": { "type": "string" }, "display_name": { "type": "string" }, "cross_account_deployment_id": { "type": "string", "format": "uint64" } }, "required": ["name", "display_name"] }, "centralRegionCIDR": { "type": "object", "properties": { "region": { "type": "string" }, "region_name": { "type": "string" }, "cidr": { "type": "string" }, "active": { "type": "boolean", "format": "boolean" } }, "required": ["region", "region_name", "cidr", "active"] }, "centralMetricsKey": { "type": "object", "properties": { "key_id": { "type": "string", "format": "uint64" }, "key": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } }, "centralNewrelicSite": { "type": "string", "enum": ["NEWRELIC_SITE_UNSPECIFIED", "NEWRELIC_SITE_US_OTLP", "NEWRELIC_SITE_EU_OTLP"], "default": "NEWRELIC_SITE_UNSPECIFIED" }, "centralRegistrationReq": { "type": "object", "properties": { "country": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "job": { "type": "string" }, "company": { "type": "string" }, "phone_number": { "type": "string" }, "password": { "type": "string" }, "accept_service": { "type": "boolean", "format": "boolean" }, "recaptcha_response": { "type": "string" }, "third_party_account_provider": { "type": "string" }, "third_party_account_token": { "type": "string" }, "connection_type": { "$ref": "#/definitions/RegistrationReqConnectionType" }, "auth0_token": { "type": "string" }, "source": { "$ref": "#/definitions/centralRegistrationSource" }, "third_party_free_trial": { "type": "boolean" }, "channel": { "type": "boolean" } }, "required": [ "country", "first_name", "last_name", "email", "job", "company", "phone_number", "password", "accept_service", "recaptcha_response" ] }, "centralReplication": { "type": "object", "properties": { "primary_cluster_name": { "type": "string" }, "secondary_cluster_name": { "type": "string" }, "status": { "$ref": "#/definitions/centralReplicationStatus" }, "creation_time": { "type": "string", "format": "date-time" }, "detached_time": { "type": "string", "format": "date-time" }, "detached_tso": { "type": "string" }, "replication_lag": { "type": "string" }, "primary_cluster_id": { "type": "string", "format": "uint64" }, "secondary_cluster_id": { "type": "string", "format": "uint64" }, "replication_id": { "type": "string", "format": "uint64" }, "detach_user": { "type": "string" }, "creator": { "type": "string" }, "primary_write_status": { "$ref": "#/definitions/centralWriteStatus" }, "secondary_write_status": { "$ref": "#/definitions/centralWriteStatus" } }, "required": [ "replication_id", "primary_cluster_id", "secondary_cluster_id", "primary_cluster_name", "secondary_cluster_name", "creation_time", "detached_time", "detached_tso", "replication_lag", "primary_write_status", "secondary_write_status", "status", "detach_user", "creator" ] }, "centralReplicationStatus": { "type": "string", "enum": ["CREATING", "REPLICATING", "DETACHING", "DETACHED", "FAILED", "PAUSE"], "default": "CREATING" }, "centralRestoreResp": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" }, "org_id": { "type": "string", "format": "uint64" } }, "required": ["id", "cluster_id", "org_id"] }, "centralScaleClusterReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" }, "components": { "type": "array", "items": { "$ref": "#/definitions/centralClusterComponent" } } }, "required": ["org_id", "project_id", "cluster_id", "components"] }, "centralScaleComponentReq": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "components": { "type": "array", "items": { "$ref": "#/definitions/centralComponentScale" } }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": ["cluster_id", "components", "org_id", "project_id"] }, "centralGetSecondaryClusterProfilesResp": { "type": "object", "properties": { "secondary_cluster_profiles": { "type": "array", "items": { "$ref": "#/definitions/centralSecondaryClusterProfile" } }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": ["secondary_cluster_profiles", "base_resp"] }, "centralSecondaryClusterProfile": { "type": "object", "properties": { "region": { "$ref": "#/definitions/centralRegion" }, "node_profiles": { "type": "array", "items": { "$ref": "#/definitions/centralComponentNodeProfiles" } } }, "required": ["region", "node_profiles"] }, "centralRegistrationSource": { "type": "object", "properties": { "most_recent_referral_url": { "type": "string" }, "website_referrer_url": { "type": "string" }, "utm_campaign": { "type": "string" }, "utm_content": { "type": "string" }, "utm_medium": { "type": "string" }, "utm_source": { "type": "string" }, "utm_term": { "type": "string" }, "signup_source": { "type": "string" } } }, "centralSendPasswordVerifyCodeReq": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": ["cluster_id", "org_id", "project_id"] }, "centralSendVerificationEmailReq": { "type": "object", "properties": { "email": { "type": "string" } }, "required": ["email"] }, "centralSubscribeUserAlertReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "email": { "type": "string" } }, "required": ["org_id", "project_id", "email"] }, "centralSubscribeUserAlertResp": { "type": "object", "properties": { "message": { "type": "string" } } }, "centralTiDBNode": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "$ref": "#/definitions/centralTiDBNodeStatus" }, "az": { "type": "string" }, "compute": { "$ref": "#/definitions/centralCompute" }, "type": { "$ref": "#/definitions/centralTiDBNodeType" } }, "required": ["name", "status", "az", "compute", "type"] }, "centralTiDBNodeStatus": { "type": "string", "enum": ["AVAILABLE", "CREATING", "UNAVAILABLE", "DELETING"], "default": "AVAILABLE" }, "centralTiDBNodeType": { "type": "string", "enum": ["COMPUTING"], "default": "COMPUTING" }, "centralTiDBNodes": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralTiDBNode" } } }, "required": ["total", "items"] }, "centralTiFlashNode": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "$ref": "#/definitions/centralTiFlashNodeStatus" }, "az": { "type": "string" }, "compute": { "$ref": "#/definitions/centralCompute" }, "storage_gi": { "type": "integer", "format": "int64" }, "type": { "$ref": "#/definitions/centralTiFlashNodeType" } }, "required": ["name", "status", "az", "compute", "storage_gi", "type"] }, "centralTiFlashNodeStatus": { "type": "string", "enum": ["AVAILABLE", "CREATING", "UNAVAILABLE", "DELETING"], "default": "AVAILABLE" }, "centralTiFlashNodeType": { "type": "string", "enum": ["STORAGE"], "default": "STORAGE" }, "centralTiFlashNodes": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralTiFlashNode" } } }, "required": ["total", "items"] }, "centralTiKVNode": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "$ref": "#/definitions/centralTiKVNodeStatus" }, "az": { "type": "string" }, "compute": { "$ref": "#/definitions/centralCompute" }, "storage_gi": { "type": "integer", "format": "int64" }, "type": { "$ref": "#/definitions/centralTiKVNodeType" } }, "required": ["name", "status", "az", "compute", "storage_gi", "type"] }, "centralTiKVNodeStatus": { "type": "string", "enum": ["NORMAL", "CREATING", "UNAVAILABLE", "TERMINATING", "LEAVING"], "default": "NORMAL" }, "centralTiKVNodeType": { "type": "string", "enum": ["STORAGE"], "default": "STORAGE" }, "centralTiKVNodes": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralTiKVNode" } } }, "required": ["total", "items"] }, "centralTrafficFilter": { "type": "object", "properties": { "cidr": { "type": "string" }, "description": { "type": "string" } }, "required": ["cidr", "description"] }, "centralTrafficFilterList": { "type": "object", "properties": { "cidrs": { "type": "array", "items": { "$ref": "#/definitions/centralTrafficFilter" } } }, "required": ["cidrs"] }, "centralTrafficFilterResp": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "traffic_filters": { "$ref": "#/definitions/centralTrafficFilterList" } }, "required": ["total", "traffic_filters"] }, "centralUnsubscribeUserAlertResp": { "type": "object", "properties": { "message": { "type": "string" } } }, "centralUpdateAuditLogStatusReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" }, "enabled": { "type": "boolean" }, "restart": { "type": "boolean" }, "audit_log_config": { "$ref": "#/definitions/centralAuditLogConfig" } }, "required": ["org_id", "project_id", "cluster_id", "enabled", "restart", "audit_log_config"] }, "centralUpdateAuditLogStatusResp": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"] }, "centralUpdateMetaReq": { "type": "object", "properties": { "use_mfa": { "type": "boolean", "format": "boolean" } }, "required": ["use_mfa"] }, "centralUpdateOpenAPIKeyReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "api_key_id": { "type": "string", "format": "uint64" }, "role": { "type": "string" }, "description": { "type": "string" } }, "required": ["org_id", "api_key_id", "role", "description"] }, "centralUpdateOrgDefaultPaymentReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "default_source": { "type": "string" } }, "required": ["org_id", "default_source"] }, "centralUpdateProjectReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "name": { "type": "string" } }, "required": ["org_id", "project_id", "name"] }, "centralUpdateProjectTrafficFilterReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "traffic_filters": { "$ref": "#/definitions/centralTrafficFilterList" } }, "required": ["org_id", "project_id", "traffic_filters"] }, "centralUpdateTrafficFilterReq": { "type": "object", "properties": { "traffic_filters": { "$ref": "#/definitions/centralTrafficFilterList" }, "cluster_id": { "type": "string", "format": "int64" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": ["traffic_filters"] }, "centralUpdateUserAlertReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "emails": { "type": "array", "items": { "type": "string" } } }, "required": ["org_id", "project_id", "emails"] }, "centralUpdateUserAlertResp": { "type": "object", "properties": { "failed_emails": { "type": "array", "items": { "type": "string" } }, "latest_emails": { "type": "array", "items": { "type": "string" } } } }, "centralUpdateUserProfileReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": "string" }, "country": { "type": "string" }, "phone_number": { "type": "string" } }, "required": ["org_id", "first_name", "last_name"] }, "centralUpdateUserReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "user_id": { "type": "string", "format": "uint64" }, "role": { "type": "string" } }, "required": ["org_id", "user_id", "role"] }, "centralUser": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "invite_time": { "type": "string", "format": "date-time" }, "login_time": { "type": "string", "format": "date-time" }, "role": { "type": "string" }, "rbac_role": { "type": "string" } }, "required": ["id", "email", "name", "status", "invite_time", "rbac_role"] }, "centralUserAlertItem": { "type": "object", "properties": { "user_alert_id": { "type": "string", "format": "uint64" }, "email": { "type": "string" } }, "required": ["user_alert_id", "email"] }, "centralUserProfile": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "role": { "type": "string" }, "projects": { "type": "array", "items": { "$ref": "#/definitions/centralUserProject" } }, "company": { "type": "string" }, "country": { "type": "string" }, "phone_number": { "type": "string" }, "is_new_user": { "type": "boolean" }, "is_impersonated_user": { "type": "boolean" }, "rbac_role": { "type": "string" }, "user_created_at": { "type": "string" } }, "required": ["id", "email", "first_name", "last_name", "role", "projects", "rbac_role"] }, "centralUserProject": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "is_cross_account": { "type": "boolean" } }, "required": ["id", "name", "is_cross_account"] }, "centralListLoginUserRolesRsp": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralUserRole" } } } }, "centralUserRole": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uint64" }, "scope_type": { "type": "string" }, "scope_id": { "type": "string", "format": "uint64" }, "role_name": { "type": "string" }, "role_display_name": { "type": "string" }, "role_desc": { "type": "string" } }, "required": ["user_id", "scope_id", "scope_type", "role_name", "role_display_name", "role_desc"] }, "centralWriteStatus": { "type": "string", "enum": ["WRITABLE", "READONLY"], "default": "WRITABLE" }, "api.SwitchStruct": { "type": "object", "required": ["tenant_id"], "properties": { "is_allowed": { "type": "boolean" }, "tenant_id": { "type": "integer" } } }, "forms.Address": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "postal_code": { "type": "string" }, "state": { "type": "string" } } }, "forms.BillingDetails": { "type": "object", "properties": { "address": { "$ref": "#/definitions/forms.Address" }, "email": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" } } }, "forms.BillingInformation": { "type": "object", "properties": { "city": { "type": "string" }, "company_name": { "type": "string" }, "country_code": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "state": { "type": "string" }, "tax_vat": { "type": "string" }, "postal_code": { "type": "string" }, "tenant_id": { "type": "string" } } }, "forms.BillingInformationInput": { "type": "object", "properties": { "city": { "type": "string" }, "company_name": { "type": "string" }, "country_code": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "state": { "type": "string" }, "tax_vat": { "type": "string" }, "postal_code": { "type": "string" } } }, "forms.BindedSupportPlan": { "type": "object", "properties": { "active_date": { "type": "string" }, "binded_support_plan_id": { "type": "integer" }, "closed_date": { "type": "string" }, "fixed_charge_price": { "type": "string" }, "level": { "type": "string" }, "public": { "type": "boolean" }, "status": { "type": "string" }, "support_plan_id": { "type": "integer" }, "support_price_percentage": { "type": "string" }, "tenant_id": { "type": "integer" }, "type": { "type": "string" } } }, "forms.Card": { "type": "object", "properties": { "brand": { "type": "string" }, "country": { "type": "string" }, "exp_month": { "type": "string", "example": "0" }, "exp_year": { "type": "string", "example": "0" }, "fingerprint": { "type": "string" }, "funding": { "type": "string" }, "last4": { "type": "string" } } }, "forms.SupportPlan": { "type": "object", "properties": { "fixed_charge_price": { "type": "string" }, "level": { "type": "string" }, "public": { "type": "boolean" }, "support_plan_id": { "type": "integer" }, "support_price_percentage": { "type": "string" }, "type": { "type": "string" } } }, "forms.SupportPlanInput": { "type": "object", "properties": { "fixed_charge_price": { "type": "string" }, "level": { "type": "string" }, "public": { "type": "boolean" }, "support_price_percentage": { "type": "string" }, "type": { "type": "string" } } }, "forms.CategoryCosts": { "type": "object", "properties": { "category_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.Price" } }, "cost_price": { "type": "string" }, "raw_price": { "type": "string" }, "unit_costs": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitCosts" } }, "order": { "type": "number" } }, "required": ["cost_price"] }, "forms.MonthlycostExplorerResult": { "type": "object", "properties": { "binded_invoice_costs": { "$ref": "#/definitions/forms.Costs" }, "credits_costs": { "$ref": "#/definitions/forms.Costs" }, "invoice_costs": { "$ref": "#/definitions/forms.Costs" }, "invoice_generated": { "type": "boolean" }, "unbind_invoice_costs": { "$ref": "#/definitions/forms.Costs" }, "total_costs": { "$ref": "#/definitions/forms.Costs" } }, "required": ["credits_costs", "invoice_costs", "invoice_generated", "unbind_invoice_costs"] }, "forms.DataAPIUsageExplore": { "type": "object", "properties": { "month": { "type": "integer" }, "network_usage": { "type": "integer" }, "request_count": { "type": "integer" }, "tenant_id": { "type": "integer" } } }, "forms.Discount": { "type": "object", "properties": { "description": { "type": "string" }, "discount": { "type": "string" }, "discount_code": { "type": "string" }, "discount_id": { "type": "integer" }, "discount_sid": { "type": "string" }, "expired_at": { "type": "string" }, "started_at": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "string" }, "unit_filters": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitFilterSlim" } }, "usage": { "type": "string" } } }, "forms.Costs": { "type": "object", "properties": { "category_item_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryCosts" } }, "kind_category_units_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryCosts" } }, "category_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.Price" } }, "category_use_item": { "type": "boolean" }, "cost_price": { "type": "string" }, "label_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.LabelCosts" } }, "raw_price": { "type": "string" }, "discount_price": { "type": "string" }, "unit_costs": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitCosts" } } }, "required": ["cost_price", "raw_price"] }, "forms.CreateInvoiceReq": { "type": "object", "properties": { "start_date": { "type": "string" }, "type": { "type": "string" } } }, "forms.ExpressionLabel": { "type": "object", "properties": { "label": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } }, "forms.CreditTypeSlim": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parent_id": { "type": "integer" }, "type_id": { "type": "integer" } } }, "forms.CreditsPackage": { "type": "object", "properties": { "bind_types": { "type": "array", "items": { "$ref": "#/definitions/forms.CreditTypeSlim" } }, "closed_date": { "type": "string" }, "closed_reason": { "type": "string" }, "credits_code": { "type": "string" }, "credits_package_id": { "type": "integer" }, "expired_date": { "type": "string" }, "note": { "type": "string" }, "remaining_credits": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" }, "total_credits": { "type": "string" }, "type": { "type": "string" }, "usage": { "type": "string" } } }, "forms.CreditsSummary": { "type": "object", "properties": { "available_costed_credits": { "type": "string" }, "available_poc_credits": { "type": "string" }, "available_credits": { "type": "string" }, "available_remaining_credits": { "type": "string" }, "last_credits_closed_date": { "type": "string" }, "tenant_id": { "type": "integer" }, "total_costed_credits": { "type": "string" }, "total_credits": { "type": "string" } } }, "forms.CostQuota": { "type": "object", "properties": { "cost_quota_limit": { "type": "string" } } }, "forms.HibernateCluster": { "properties": { "cluster_id": { "type": "string" }, "hibernate_status": { "type": "string" } }, "type": "object" }, "forms.Contract": { "type": "object", "properties": { "contact_email": { "type": "string" }, "contract_id": { "type": "string" }, "contract_type": { "type": "string" }, "created_at": { "type": "string" }, "file_path": { "type": "string" }, "id": { "type": "integer" }, "last_operator_id": { "type": "integer" }, "reason_for_last_operation": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" }, "updated_at": { "type": "string" }, "operated_at": { "type": "string" } }, "required": ["contract_id"] }, "forms.ContractInput": { "type": "object", "required": ["contact_email", "file_path"], "properties": { "contact_email": { "type": "string" }, "contract_type": { "type": "string" }, "file_path": { "type": "string" } } }, "forms.ContractsResponse": { "type": "object", "properties": { "contracts": { "type": "array", "items": { "$ref": "#/definitions/forms.Contract" } }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "total_results": { "type": "integer" } } }, "forms.CostExplorerDetailsResult": { "type": "object", "properties": { "details": { "type": "array", "items": { "$ref": "#/definitions/forms.UsageDetails" } } } }, "forms.Invoice": { "type": "object", "properties": { "category_item_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryCosts" } }, "kind_category_units_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryCosts" } }, "category_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.Price" } }, "category_use_item": { "type": "boolean" }, "cost_price": { "type": "string" }, "end_date": { "type": "string" }, "invoice_id": { "type": "integer" }, "label_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.LabelCosts" } }, "raw_price": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" }, "type": { "type": "string" }, "unit_costs": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitCosts" } } } }, "forms.UnitFilterNode": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitFilterNode" } }, "description": { "type": "string" }, "filter_id": { "type": "integer" }, "name": { "type": "string" }, "parent_id": { "type": "integer" }, "type_id": { "description": "this field is a deprecated", "type": "integer" } } }, "forms.UnitFilterSlim": { "type": "object", "properties": { "description": { "type": "string" }, "filter_id": { "type": "integer" }, "name": { "type": "string" }, "parent_id": { "type": "integer" }, "type_id": { "description": "this field is a deprecated", "type": "integer" } } }, "forms.UsageDetails": { "type": "object", "properties": { "amount": { "type": "string" }, "billable_cost": { "type": "string" }, "billed_date": { "type": "string" }, "cluster_name": { "type": "string" }, "credit_usage": { "type": "string" }, "discount_cost": { "type": "string" }, "project_name": { "type": "string" }, "service": { "type": "string" } } }, "forms.LabelCosts": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryCosts" } }, "forms.OKType": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" } } }, "forms.Price": { "type": "object", "properties": { "cost_price": { "type": "string" }, "raw_price": { "type": "string" }, "discount_price": { "type": "string" }, "order": { "type": "number" } }, "required": ["cost_price"] }, "forms.PaymentMethod": { "type": "object", "properties": { "payable": { "type": "boolean" }, "payment_code": { "type": "string" }, "payment_method_id": { "type": "integer" }, "payment_type": { "type": "string" }, "tenant_id": { "type": "integer" } } }, "forms.SetupIntent": { "type": "object", "properties": { "client_secret": { "type": "string" }, "public_key": { "type": "string" } }, "required": ["client_secret", "public_key"] }, "forms.StripeCustomerInfo": { "type": "object", "properties": { "address": { "$ref": "#/definitions/forms.Address" }, "dbaas_id": { "type": "string" }, "default_source": { "type": "string" }, "description": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["default_source"] }, "forms.StripeInvoice": { "type": "object", "properties": { "amount_due": { "type": "string", "example": "0" }, "amount_paid": { "type": "string", "example": "0" }, "created": { "type": "string", "example": "0" }, "credit_used": { "type": "string", "example": "0" }, "currency": { "type": "string" }, "due_date": { "type": "string", "example": "0" }, "id": { "type": "string" }, "invoice_pdf": { "type": "string" }, "number": { "type": "string" }, "paid": { "type": "boolean" }, "status": { "type": "string" }, "total": { "type": "string", "example": "0" } } }, "forms.StripePaymentMethod": { "type": "object", "properties": { "billing_details": { "$ref": "#/definitions/forms.BillingDetails" }, "card": { "$ref": "#/definitions/forms.Card" }, "id": { "type": "string" } } }, "forms.CardValidateResult": { "type": "object", "properties": { "client_secret": { "type": "string" }, "payment_intent_id": { "type": "string" }, "public_key": { "type": "string" }, "status": { "type": "string" } } }, "forms.UnitCosts": { "type": "object", "properties": { "binded_package_id": { "type": "integer" }, "consumed_source": { "type": "string" }, "cost": { "type": "integer" }, "cost_id": { "type": "string" }, "cost_time_stamp": { "type": "integer" }, "invoice_id": { "type": "integer" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "package_id": { "type": "integer" }, "package_version": { "type": "integer" }, "price": { "type": "string" }, "raw_price": { "type": "string" }, "unit": { "type": "string" } } }, "forms.UnitCostsInput": { "type": "object", "properties": { "cost": { "type": "integer" }, "cost_id": { "description": "optional", "type": "string" }, "cost_time_stamp": { "type": "integer" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "unit": { "type": "string" } } }, "forms.UnitInfo": { "type": "object", "properties": { "category": { "description": "optional", "type": "string" }, "description": { "type": "string" }, "unit": { "type": "string", "minLength": 1 } } }, "UserDebugResponseMessage": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } } }, "UserDebugFeatureList": { "type": "object", "properties": { "org_id": { "type": "string" }, "features": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "status": { "type": "string" } } } } } }, "UserDebugAuthorization": { "type": "object", "properties": { "token": { "type": "string" }, "valid": { "type": "boolean" } } }, "UserDebugAuthorizedBy": { "type": "object", "properties": { "id": { "type": "integer", "x-omitempty": false }, "first_name": { "type": "string", "x-omitempty": false }, "last_name": { "type": "string", "x-omitempty": false }, "email": { "type": "string", "x-omitempty": false } } }, "UserDebugAuthorizationDetail": { "type": "object", "properties": { "id": { "type": "integer" }, "project_id": { "type": "integer" }, "project_name": { "type": "string" }, "cluster_id": { "type": "integer" }, "cluster_name": { "type": "string" }, "status": { "type": "string" }, "expires_at": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "authorized_by": { "$ref": "#/definitions/UserDebugAuthorizedBy" } } }, "UserDebugAuthorizationList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/UserDebugAuthorizationDetail" } }, "total": { "type": "integer", "x-omitempty": false } } }, "UserDebugAuthorizationRecordItem": { "type": "object", "properties": { "auth_id": { "type": "integer" }, "user": { "$ref": "#/definitions/UserDebugAuthorizedBy" }, "operation": { "type": "string" }, "created_at": { "type": "integer" }, "expires_at": { "type": "integer" }, "time_span": { "type": "integer" } } }, "UserDebugAuthorizationRecords": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/UserDebugAuthorizationRecordItem" } }, "total": { "type": "integer", "x-omitempty": false } } }, "HibernateClusterReq": { "type": "object", "properties": { "action": { "type": "string" }, "projectId": { "type": "string" } } }, "HibernateClusterReqV1": { "type": "object", "properties": { "action": { "type": "string" } } }, "HibernateClusterRspV1": { "type": "object", "properties": { "state": { "type": "string" } } }, "PlaygroundSQLReq": { "type": "object", "properties": { "sql": { "type": "string" } } }, "serverlessGetAllSpendLimitsResp": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "free_credit_max_count": { "type": "integer", "format": "int32" }, "has_free_credit_quota": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/definitions/serverlessGetClusterSpendLimitsResp" } } }, "required": ["total", "free_credit_max_count", "has_free_credit_quota", "items"] }, "serverlessGetSpendLimitDetailsResp": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "spend_limit": { "type": "integer", "format": "int64", "title": "spend limit in cents" }, "free_credit": { "type": "integer", "format": "int64", "title": "free credit in cents" }, "spent_total": { "type": "integer", "format": "int64", "title": "money spent so far in cents" }, "spent_free": { "$ref": "#/definitions/serverlessMoneySpents", "title": "money spent so far on free credit in cents" }, "spent_paid": { "$ref": "#/definitions/serverlessMoneySpents", "title": "money spent so far on spend limit in cents" }, "usages": { "$ref": "#/definitions/serverlessResourceUsages", "title": "resource usages" }, "update_at": { "type": "string" }, "base_resp": { "$ref": "#/definitions/baseBaseResp" } }, "required": ["cluster_id", "spend_limit", "free_credit", "spent_total", "base_resp", "update_at"] }, "serverlessGetClusterSpendLimitsResp": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "spend_limit": { "type": "number", "format": "float" }, "free_credit": { "type": "number" } }, "required": ["cluster_id", "spend_limit", "free_credit"] }, "serverlessSpendLimitsMeasureResp": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "spend_limit": { "type": "number" }, "free_credit": { "type": "number" }, "cost": { "type": "number", "format": "float" }, "spent": { "type": "number" }, "min_spend_limit": { "type": "number" }, "max_request_units": { "type": "number", "format": "float" }, "max_column_storage": { "type": "number", "format": "float" }, "max_row_storage": { "type": "number", "format": "float" }, "free_request_units": { "type": "number", "format": "float" }, "free_column_storage": { "type": "number", "format": "float" }, "free_row_storage": { "type": "number", "format": "float" }, "current_request_units": { "type": "number", "format": "float" }, "current_column_storage": { "type": "number", "format": "float" }, "current_row_storage": { "type": "number", "format": "float" }, "spent_request_units": { "type": "number", "format": "float" }, "spent_column_storage": { "type": "number", "format": "float" }, "spent_row_storage": { "type": "number", "format": "float" } }, "required": [ "cluster_id", "spend_limit", "free_credit", "spent", "min_spend_limit", "max_request_units", "max_column_storage", "max_row_storage", "free_request_units", "free_column_storage", "free_row_storage", "current_request_units", "current_column_storage", "current_row_storage", "spent_request_units", "spent_column_storage", "spent_row_storage" ] }, "PlaygroundSQLRespSucc": { "type": "object", "properties": { "details": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object" } }, "explain": { "type": "array", "items": { "type": "object" } } } }, "columns": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "string" } }, "explain": { "type": "array", "items": { "type": "string" } } } } } }, "PlaygroundSQLRespFail": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "type": "string" } } } }, "dto.ClusterMetaRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/entity.DBMeta" } }, "message": { "type": "string" } } }, "dto.GenericSuccessApiResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "entity.DataAppSettingsFormat": { "type": "object", "properties": { "enable_dataapi": { "type": "boolean" } } }, "entity.DBMeta": { "type": "object", "properties": { "name": { "type": "string" }, "tables": { "type": "array", "items": { "$ref": "#/definitions/entity.TablesMeta" } } } }, "entity.TablesMeta": { "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/definitions/entity.Columns" } }, "name": { "type": "string" } } }, "entity.SqlEditorOplogParam": { "type": "object", "required": ["event_type", "session_id", "sql_file_id"], "properties": { "affected_rows": { "type": "integer" }, "chat2query_sid": { "type": "string" }, "error_message": { "type": "string" }, "event_type": { "type": "string" }, "is_accept": { "type": "boolean" }, "is_modified": { "type": "boolean" }, "session_id": { "type": "string" }, "sql_content": { "type": "string" }, "sql_file_id": { "type": "integer" }, "start_time": { "type": "integer" }, "end_time": { "type": "integer" }, "status": { "type": "integer" }, "user_question": { "type": "string" }, "prompt_version": { "type": "string" } } }, "dto.BasicRes": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } } }, "dto.CreateSQLFileRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "integer" }, "message": { "type": "string" } } }, "dto.DeleteSQLFileRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "dto.IsDBTableExistRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.IsDBTableExist" }, "message": { "type": "string" } } }, "dto.ListSQLFileRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/entity.SqlEditorFile" } }, "message": { "type": "string" } } }, "dto.Settings": { "type": "object", "properties": { "enable_dataapi": { "type": "boolean" }, "limit": { "type": "integer" }, "show_system_db_schema": { "type": "boolean" } } }, "dto.SessionRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "dto.SampleInitializeRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "dto.ShowDBsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.DatabaseItem" } }, "message": { "type": "string" } } }, "dto.DatabaseItem": { "type": "object", "properties": { "has_table": { "type": "boolean" }, "name": { "type": "string" } } }, "dto.SchemaSearchRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.SchemaSearchItem" } }, "message": { "type": "string" } } }, "dto.SchemaSearchItem": { "type": "object", "properties": { "column": { "type": "string" }, "data_type": { "type": "string" }, "database": { "type": "string" }, "nullable": { "type": "boolean" }, "has_table": { "type": "boolean" }, "table": { "type": "string" }, "type": { "$ref": "#/definitions/dto.SchemaSearchType" } } }, "dto.SchemaSearchType": { "type": "string", "enum": ["database", "table", "column"], "x-enum-varnames": ["SchemaSearchTypeDatabase", "SchemaSearchTypeTable", "SchemaSearchTypeColumn"] }, "dto.ShowColumnsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/entity.Columns" } }, "message": { "type": "string" } } }, "entity.SessionParam": { "type": "object", "properties": { "database": { "type": "string" } } }, "dto.ShowSQLFileRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.SqlEditorFile" }, "message": { "type": "string" } } }, "dto.ShowSettingsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.Settings" }, "message": { "type": "string" } } }, "dto.ShowTableMetaRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.MetaRes" }, "message": { "type": "string" } } }, "dto.ShowTablesRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "type": "string" } }, "message": { "type": "string" } } }, "dto.StatementsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.DataRes" }, "message": { "type": "string" } } }, "dto.ShowUserInfoRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.UserInfo" }, "message": { "type": "string" } } }, "entity.UserInfoParam": { "type": "object", "properties": { "chat2query_init": { "type": "boolean" }, "is_privacy_allowed": { "type": "boolean" }, "privacy_box_count": { "type": "integer" } } }, "dto.UpdateUserInfoRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "entity.UserInfo": { "type": "object", "properties": { "chat2query_init": { "type": "boolean" }, "created_by": { "type": "string" }, "id": { "type": "integer" }, "is_privacy_allowed": { "type": "boolean" }, "privacy_box_count": { "type": "integer" } } }, "dto.UpdateSQLFileRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "entity.SettingsParam": { "type": "object", "properties": { "limit": { "type": "integer" }, "show_system_db_schema": { "type": "boolean" } } }, "dto.UpdateSettingsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "entity.Columns": { "type": "object", "properties": { "col": { "type": "string" }, "data_type": { "type": "string" }, "nullable": { "type": "boolean" } } }, "entity.DataRes": { "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/definitions/entity.Columns" } }, "databases": { "type": "array", "items": { "type": "string" } }, "start_time": { "type": "string" }, "end_time": { "type": "string" }, "start_time_ms": { "type": "integer" }, "end_time_ms": { "type": "integer" }, "execute_time": { "type": "string" }, "limit": { "type": "integer" }, "query": { "type": "string" }, "row_count": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "warn_count": { "type": "integer" }, "warn_messages": { "type": "array", "items": { "type": "string" } } } }, "entity.IsDBTableExist": { "type": "object", "properties": { "is_exist": { "type": "boolean" }, "session_id": { "type": "string" } } }, "entity.MetaRes": { "type": "object", "properties": { "clusterid": { "type": "integer" }, "columns": { "type": "array", "items": { "$ref": "#/definitions/entity.Columns" } }, "database": { "type": "string" }, "table": { "type": "string" } } }, "entity.SqlEditorFile": { "type": "object", "properties": { "cluster_id": { "type": "integer" }, "content": { "type": "string" }, "created_at": { "type": "string" }, "created_by": { "type": "string" }, "database": { "type": "string" }, "id": { "type": "integer" }, "is_deleted": { "type": "integer" }, "name": { "type": "string" }, "org_id": { "type": "integer" }, "project_id": { "type": "integer" }, "updated_at": { "type": "string" }, "updated_by": { "type": "string" } } }, "entity.StatementParam": { "type": "object", "properties": { "sessionid": { "type": "string" }, "sql": { "type": "string" }, "database": { "type": "string" }, "chat2query_sid": { "type": "string" }, "sql_file_id": { "type": "integer" } } }, "types.EventTypesResp": { "type": "object", "properties": { "event_types": { "type": "object", "additionalProperties": { "type": "string" } } } }, "types.ExportEvent": { "type": "object", "properties": { "cluster_id": { "type": "integer" }, "cluster_name": { "type": "string" }, "created_at": { "type": "string" }, "details": { "type": "string" }, "ends_at": { "type": "string" }, "id": { "type": "integer" }, "operator_email": { "type": "string" }, "operator_id": { "type": "integer" }, "operator_ip": { "type": "string" }, "operator_login_method": { "type": "string" }, "operator_type": { "type": "string" }, "org_id": { "type": "integer" }, "org_name": { "type": "string" }, "project_id": { "type": "integer" }, "project_name": { "type": "string" }, "result": { "type": "string" }, "trace_id": { "type": "string" }, "type": { "type": "string" } } }, "types.QueryAuditLogResp": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/definitions/types.ExportEvent" } }, "total_count": { "type": "integer" } } }, "types.QuerySettingsResp": { "type": "object", "properties": { "status": { "type": "integer" } } }, "types.UpdateSettingResp": { "type": "object", "properties": { "status": { "type": "integer" } }, "required": ["status"] }, "serverlessMoneySpents": { "type": "object", "properties": { "request_unit": { "type": "integer", "format": "int64" }, "row_storage": { "type": "integer", "format": "int64" }, "column_storage": { "type": "integer", "format": "int64" } }, "required": ["request_unit", "row_storage", "column_storage"] }, "serverlessResourceUsages": { "type": "object", "properties": { "request_unit": { "type": "string", "format": "uint64" }, "row_storage": { "type": "number", "format": "double" }, "column_storage": { "type": "number", "format": "double" } }, "required": ["request_unit", "row_storage", "column_storage"] }, "serverlessPredictSpendLimitResp": { "type": "object", "properties": { "spend_limit": { "type": "integer", "format": "int64", "title": "spend limit in cents" }, "free_credit": { "type": "integer", "format": "int64", "title": "free credit in cents" }, "max_request_units": { "type": "string", "format": "uint64" }, "max_column_storage": { "type": "number", "format": "double" }, "max_row_storage": { "type": "number", "format": "double" }, "free_request_units": { "type": "string", "format": "uint64" }, "free_column_storage": { "type": "number", "format": "double" }, "free_row_storage": { "type": "number", "format": "double" }, "base_resp": { "$ref": "#/definitions/baseBaseResp" } }, "required": [ "spend_limit", "free_credit", "max_request_units", "max_column_storage", "max_row_storage", "free_request_units", "free_column_storage", "free_row_storage", "base_resp" ] }, "serverlessSQLColumn": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "string" } }, "explain": { "type": "array", "items": { "type": "string" } } } } }, "securityDefinitions": { "bearer": { "type": "apiKey", "description": "Authentication token, prefixed by Bearer: Bearer \u003ctoken\u003e", "name": "Authorization", "in": "header" } }, "security": [ { "bearer": [] } ], "externalDocs": { "description": "DBaaS central", "url": "http://github.com/tidbcloud/dbaas" } }