{ "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/auth/api": { "get": { "operationId": "Auth", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "type_url", "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.", "in": "query", "required": false, "type": "string" }, { "name": "value", "description": "Must be a valid serialized protocol buffer of the above specified type.", "in": "query", "required": false, "type": "string", "format": "byte" } ], "tags": [ "AuthService" ] }, "delete": { "operationId": "Auth2", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "type_url", "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.", "in": "query", "required": false, "type": "string" }, { "name": "value", "description": "Must be a valid serialized protocol buffer of the above specified type.", "in": "query", "required": false, "type": "string", "format": "byte" } ], "tags": [ "AuthService" ] }, "post": { "operationId": "Auth3", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/protobufAny" } } ], "tags": [ "AuthService" ] }, "put": { "operationId": "Auth4", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/protobufAny" } } ], "tags": [ "AuthService" ] }, "patch": { "operationId": "Auth5", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/protobufAny" } } ], "tags": [ "AuthService" ] } }, "/api/v1/auth/meta": { "get": { "operationId": "Meta", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralMetaData" } } }, "tags": [ "AuthService" ] }, "put": { "operationId": "UpdateMeta", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralUpdateMetaReq" } } ], "tags": [ "AuthService" ] } }, "/api/v1/cloud_providers": { "post": { "operationId": "ListCloudProviders", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCloudProviders" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralListCloudProvidersReq" } } ], "tags": [ "ClusterService" ] } }, "/api/v1/mocker/tenant/{tenant_id}/image": { "get": { "operationId": "GetTenantCustomizedImage", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCustomizedTenantImage" } } }, "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "TestTokenService" ] }, "delete": { "operationId": "DeleteTenantCustomizedImage", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "TestTokenService" ] }, "post": { "operationId": "SetTenantCustomizedImage", "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/centralCustomizedTenantImage" } } ], "tags": [ "TestTokenService" ] } }, "/api/v1/my-ip": { "get": { "operationId": "GetClientIP", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetClientIPResp" } } }, "tags": [ "TenantService" ] } }, "/api/v1/node_profiles": { "post": { "operationId": "CalcNodeProfiles", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCalcNodeProfilesResp" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCalcNodeProfilesReq" } } ], "tags": [ "ClusterService" ] } }, "/api/v1/orgs": { "post": { "operationId": "Registration", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralRegistrationReq" } } ], "tags": [ "TenantService" ] } }, "/api/v1/orgs/me": { "get": { "operationId": "GetOrganization", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralOrganization" } } }, "tags": [ "TenantService" ] } }, "/api/v1/orgs/verification-email": { "post": { "operationId": "Send Verification Email", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralSendVerificationEmailReq" } } ], "tags": [ "TenantService" ] } }, "/api/v1/orgs/{org_id}": { "put": { "operationId": "UpdateOrganization", "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/centralUpdateOrgReq" } } ], "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}/access-logs": { "get": { "operationId": "ListTenantAccessLogs", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralListAccessLogResp" } } }, "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": "user", "in": "query", "required": false, "type": "string" }, { "name": "content", "in": "query", "required": false, "type": "string" }, { "name": "start_time", "in": "query", "required": false, "type": "string", "format": "int64" }, { "name": "end_time", "in": "query", "required": false, "type": "string", "format": "int64" } ], "tags": [ "TenantService" ] } }, "/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}/billing/credits": { "get": { "operationId": "GetCredits", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCredits" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "BillingService" ] } }, "/api/v1/orgs/{org_id}/billing/credits_history": { "get": { "operationId": "GetCreditsHistory", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCreditsHistory" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "BillingService" ] } }, "/api/v1/orgs/{org_id}/billing/setup-intent/confirm": { "post": { "operationId": "SetupIntentConfirm", "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/centralOrgIdReq" } } ], "tags": [ "BillingService" ] } }, "/api/v1/orgs/{org_id}/clusters/{cluster_id}/replications/{rep_id}/type/{detach_type}": { "delete": { "operationId": "DetachReplication", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDetachReplicationResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "rep_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "detach_type", "in": "path", "required": true, "type": "string", "enum": [ "Planned", "Force", "None" ] } ], "tags": [ "ClusterService" ] } }, "/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}/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" } ], "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}/cluster_fee": { "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" } ], "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}/backups": { "get": { "operationId": "ListBackups", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralBackups" } } }, "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": [ "BackupService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/backups/schedules": { "get": { "operationId": "GetAutoBackupSetting", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralAutoBackupSetting" } } }, "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": [ "BackupService" ] }, "post": { "operationId": "CreateBackupSchedule", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralBackupScheduleId" } } }, "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/centralBackupCreateReq" } } ], "tags": [ "BackupService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/backups/{id}": { "delete": { "operationId": "DeleteBackup", "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": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "BackupService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/backups/{id}/restore": { "post": { "operationId": "RestoreBackup", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralRestoreResp" } } }, "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" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralBackupRestoreReq" } } ], "tags": [ "BackupService" ] } }, "/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}/connectors": { "get": { "operationId": "ListConnectors", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralConnectors" } } }, "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" }, { "name": "connector_type", "in": "query", "required": false, "type": "string", "enum": [ "TOTAL", "KAFKA", "TIDB", "MYSQL" ], "default": "TOTAL" } ], "tags": [ "ConnectorService" ] }, "post": { "operationId": "CreateConnector", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralConnectorID" } } }, "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/centralConnectorCreateReq" } } ], "tags": [ "ConnectorService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/connectors/test": { "post": { "operationId": "TestConnector", "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/centralConnectorCreateReq" } } ], "tags": [ "ConnectorService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/connectors/{connector_id}": { "get": { "operationId": "GetConnector", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralConnector" } } }, "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": "connector_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ConnectorService" ] }, "delete": { "operationId": "DeleteConnector", "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": "connector_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ConnectorService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/data-ingestion-profile": { "get": { "operationId": "GetDataIngestionProfile", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDataIngestionProfile" } } }, "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}/imports": { "put": { "operationId": "CreateImport", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralClusterImportId" } } }, "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/centralImportCreateReq" } } ], "tags": [ "ImportService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/imports/{id}": { "get": { "operationId": "GetImport", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralImportGetResp" } } }, "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": [ "ImportService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/imports/{id}/cancel": { "post": { "summary": "Cancel the import and mark the status as 'canceled' status.", "operationId": "CancelImport", "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": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ImportService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/imports/{id}/exit": { "post": { "summary": "Exit make the cluster exit the importing status\nBy design, when the cluster in the importing status, will display the importing information\nand can not see the metrics than display at normal status and some operation like scale is also\nforbidden.\nAfter the import finish, the cluster will still keep on importing status\nfor user to check the result, the user must click the 'Exit' button to\nexit the importing status explicitly.\nonly finished status(success, failed, canceled) of a import can exit the importing status.", "operationId": "ExitImport", "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": "id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "ImportService" ] } }, "/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}/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/{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}/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}/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" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "CrossAccountDeploymentService" ] }, "post": { "summary": "Cross account deployment", "operationId": "CreateCrossAccountDeployment", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralCrossAccountDeploymentRecord" } } }, "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": [ "CrossAccountDeploymentService" ] } }, "/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" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "CrossAccountDeploymentService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/cross_account_deployments/iam_roles": { "get": { "summary": "IAM roles", "operationId": "ListIamRoles", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralListIamRolesResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "CrossAccountDeploymentService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/cross_account_deployments/iam_roles/unused": { "delete": { "operationId": "DeleteUnusedRoles", "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": [ "CrossAccountDeploymentService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/cross_account_deployments/{id}": { "delete": { "operationId": "DeleteCrossAccountDeployment", "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": [ "CrossAccountDeploymentService" ] }, "put": { "operationId": "UpdateCrossAccountDeployment", "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" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralCrossAccountDeploymentRecord" } } ], "tags": [ "CrossAccountDeploymentService" ] } }, "/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": { "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" ], "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" ], "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" } ], "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}/recycle-bin/{cluster_id}/backups": { "delete": { "operationId": "DeleteDeletedClusterAndBackups", "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": [ "BackupService" ] } }, "/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}/users": { "get": { "operationId": "ListProjectUsers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralUsers" } } }, "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": "email", "in": "query", "required": false, "type": "string" } ], "tags": [ "TenantService" ] }, "post": { "operationId": "InviteUser", "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/centralInviteUserReq" } } ], "tags": [ "TenantService" ] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/users/{user_id}": { "delete": { "operationId": "DeleteProjectUser", "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": "user_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "TenantService" ] } }, "/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": { "post": { "operationId": "ValidateProjectCIDR", "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": "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": { "get": { "operationId": "ListUsers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralUsers" } } }, "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": "email", "in": "query", "required": false, "type": "string" } ], "tags": [ "TenantService" ] } }, "/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/v1/orgs/{org_id}/users/{user_id}": { "delete": { "operationId": "DeleteUser", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "user_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "TenantService" ] }, "put": { "operationId": "UpdateUser", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "user_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralUpdateUserReq" } } ], "tags": [ "TenantService" ] } }, "/api/v1/test-token": { "post": { "operationId": "GenerateTestToken", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGenerateTestTokenResp" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralGenerateTestTokenReq" } } ], "tags": [ "TestTokenService" ] } }, "/debug-api/v1/auth/sign_out": { "post": { "operationId": "DebugPortalSignOut", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDebugPortalSignOutResp" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralDebugPortalSignOutReq" } } ], "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/me": { "get": { "operationId": "DebugPortalGetBasicSession", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDebugPortalGetBasicSessionResp" } } }, "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/oauth/config": { "get": { "operationId": "DebugPortalGetOAuthConfig", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDebugPortalGetOAuthConfigResp" } } }, "parameters": [ { "name": "redirect_uri", "in": "query", "required": false, "type": "string" } ], "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/oauth/exchange": { "post": { "operationId": "DebugPortalExchangeOAuthToken", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralDebugPortalExchangeOAuthTokenResp" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/centralDebugPortalExchangeOAuthTokenReq" } } ], "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/orgs": { "get": { "operationId": "DebugPortalListTenants", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralListTenantsResp" } } }, "parameters": [ { "name": "name", "in": "query", "required": false, "type": "string" }, { "name": "id", "in": "query", "required": false, "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": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/orgs/{org_id}": { "get": { "operationId": "DebugPortalGetTenantById", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralTenant" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/orgs/{org_id}/clusters": { "get": { "operationId": "DebugPortalListTenantClusters", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralListTenantClustersResp" } } }, "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" } ], "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/orgs/{org_id}/clusters/{cluster_id}/dashboard_links": { "get": { "operationId": "DebugPortalGetDashboardLinks", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetDashboardLinksResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/orgs/{org_id}/clusters/{cluster_id}/slow_query/databases": { "get": { "operationId": "DebugPortalGetSlowQueryDatabases", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetSlowQueryDatabasesResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "begin_time", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "end_time", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/orgs/{org_id}/clusters/{cluster_id}/slow_query/logs/detail": { "get": { "operationId": "DebugPortalGetSlowQueryDetails", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetSlowQueryDetailsResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/orgs/{org_id}/clusters/{cluster_id}/slow_query/logs/query": { "post": { "operationId": "DebugPortalQuerySlowQueries", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralQuerySlowQueriesResp" } } }, "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": { "$ref": "#/definitions/centralQuerySlowQueriesBody" } } ], "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/orgs/{org_id}/clusters/{cluster_id}/slow_query/table_columns": { "get": { "operationId": "DebugPortalGetSlowQueryFields", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralGetSlowQueryFieldsResp" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/topsql/instances": { "get": { "operationId": "TopSQLGetInstances", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralTopSQLGetInstanceResp" } } }, "parameters": [ { "name": "begin_ts", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "end_ts", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": [ "CentralDebugPortalService" ] } }, "/debug-api/v1/topsql/top_digests": { "get": { "operationId": "TopSQLGetTopDigests", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/centralTopSQLGetTopDigestResp" } } }, "parameters": [ { "name": "top_n", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "by", "in": "query", "required": false, "type": "string" }, { "name": "window_size_sec", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "begin_ts", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "end_ts", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "instance_id", "in": "query", "required": false, "type": "string" } ], "tags": [ "CentralDebugPortalService" ] } } }, "definitions": { "CalcClusterFeeRespComponentCost": { "type": "object", "properties": { "component_type": { "$ref": "#/definitions/centralComponentType" }, "compute": { "type": "number", "format": "double" }, "storage": { "type": "number", "format": "double" } } }, "ClusterClusterType": { "type": "string", "enum": [ "COMMON", "PRIMARY", "SECONDARY" ], "default": "COMMON" }, "ClusterCreateProgress": { "type": "string", "enum": [ "INITIALIZING", "PREPARING", "LAUNCHING", "COMPLETED", "BACKUPING", "RESTORING", "REPLICATION_PREPARING" ], "default": "INITIALIZING" }, "ClusterSecondaryStatus": { "type": "string", "enum": [ "HEALTHY", "UNHEALTHY" ], "default": "HEALTHY" }, "DetachReplicationReqDetachType": { "type": "string", "enum": [ "Planned", "Force", "None" ], "default": "Planned" }, "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" ] }, "centralAccessLog": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "happened_on": { "type": "string", "format": "int64" }, "user": { "type": "string" }, "content": { "type": "string" } }, "required": [ "id", "happened_on", "user", "content" ] }, "centralAcknowledgeCNPolicyReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" } }, "required": [ "org_id" ] }, "centralAutoBackupSetting": { "type": "object", "properties": { "backup_mode": { "$ref": "#/definitions/centralBackupMode" }, "backup_time": { "type": "string" }, "max_backups": { "type": "string", "format": "uint64" } }, "required": [ "backup_mode", "backup_time", "max_backups" ] }, "centralAwsVpcPeering": { "type": "object", "properties": { "region": { "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", "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" ] }, "centralBackup": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "cluster": { "$ref": "#/definitions/centralBackupCluster" }, "name": { "type": "string" }, "description": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "size": { "type": "string", "format": "uint64" }, "status": { "$ref": "#/definitions/centralBackupStatus" }, "type": { "$ref": "#/definitions/centralBackupType" }, "expiration_time": { "type": "string", "format": "date-time" } }, "required": [ "id", "cluster", "name", "description", "created_at", "size", "status", "type", "expiration_time" ] }, "centralBackupCluster": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "cluster_components": { "$ref": "#/definitions/centralClusterComponents" } }, "required": [ "cluster_id", "cluster_components" ] }, "centralBackupCreateReq": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "description": { "type": "string" }, "name": { "type": "string" }, "org_id": { "type": "string", "format": "uint64" }, "backup_type": { "$ref": "#/definitions/centralBackupType" }, "backup_time": { "type": "string" }, "max_backups": { "type": "string", "format": "uint64" }, "backup_mode": { "$ref": "#/definitions/centralBackupMode" }, "project_id": { "type": "string", "format": "uint64" } }, "required": [ "cluster_id", "description", "name", "org_id", "backup_type", "backup_time", "max_backups", "backup_mode", "project_id" ] }, "centralBackupMode": { "type": "string", "enum": [ "FULL" ], "default": "FULL" }, "centralBackupRestoreReq": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" }, "cluster_name": { "type": "string" }, "description": { "type": "string" }, "password": { "type": "string" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": [ "id", "cluster_id", "cluster_name", "description", "password", "org_id", "project_id" ] }, "centralBackupScheduleId": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" } }, "required": [ "id" ] }, "centralBackupStatus": { "type": "string", "enum": [ "UNKNOWN", "RUNNING", "SUCCESS", "FAILED", "PENDING" ], "default": "UNKNOWN" }, "centralBackupType": { "type": "string", "enum": [ "AUTO", "MANUAL", "ALL" ], "default": "AUTO" }, "centralBackups": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/centralBackup" } }, "total": { "type": "integer", "format": "int64" } }, "required": [ "items", "total" ] }, "centralBaseResp": { "type": "object", "properties": { "err_code": { "type": "string", "format": "int64" }, "err_msg": { "type": "string" } } }, "centralCalcClusterFeeReq": { "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" }, "components": { "type": "array", "items": { "$ref": "#/definitions/centralClusterComponent" } } }, "required": [ "org_id", "project_id", "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" }, "provider": { "type": "string" }, "region": { "type": "string" }, "is_dev_tier": { "type": "boolean", "format": "boolean" } }, "required": [ "org_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" }, "verify_code": { "type": "string" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": [ "cluster_id", "password", "verify_code", "org_id", "project_id" ] }, "centralCloudProvider": { "type": "object", "properties": { "name": { "type": "string" }, "regions": { "type": "array", "items": { "$ref": "#/definitions/centralRegion" } }, "cross_account_deployment_id": { "type": "string", "format": "uint64" } }, "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": "int64" }, "name": { "type": "string" }, "status": { "$ref": "#/definitions/centralClusterStatus" }, "secondary_status": { "$ref": "#/definitions/ClusterSecondaryStatus" }, "version": { "type": "string" }, "provider": { "type": "string" }, "region": { "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", "format": "boolean" }, "privateEndpoint": { "$ref": "#/definitions/centralEndpoint" }, "restored": { "type": "boolean", "format": "boolean" }, "role_arn": { "type": "string", "title": "only set when status is IMPORTING" }, "import_id": { "type": "string", "format": "uint64" }, "lastErrors": { "type": "array", "items": { "$ref": "#/definitions/centralLastError" } }, "replications": { "type": "array", "items": { "$ref": "#/definitions/centralReplication" } }, "cluster_type": { "$ref": "#/definitions/ClusterClusterType" }, "write_status": { "$ref": "#/definitions/centralWriteStatus" }, "is_dev_tier": { "type": "boolean", "format": "boolean" }, "cross_account_deployment_id": { "type": "string", "format": "uint64" } }, "required": [ "id", "name", "status", "secondary_status", "version", "provider", "region", "created_at", "created_by", "endpoint", "vpc_cidr_block", "capacity", "cluster_components", "create_progress", "prometheus_ready", "privateEndpoint", "restored", "role_arn", "import_id", "lastErrors", "replications", "cluster_type", "write_status" ] }, "centralClusterComponent": { "type": "object", "properties": { "component_type": { "$ref": "#/definitions/centralComponentType" }, "node_profile_id": { "type": "string", "format": "uint64" }, "replicas": { "type": "integer", "format": "int32" }, "storage_size_gi": { "type": "integer", "format": "int32" } }, "required": [ "component_type", "node_profile_id", "replicas", "storage_size_gi" ] }, "centralClusterComponents": { "type": "object", "properties": { "tikv": { "$ref": "#/definitions/centralComponent" }, "tidb": { "$ref": "#/definitions/centralComponent" }, "tiflash": { "$ref": "#/definitions/centralComponent" } }, "required": [ "tikv", "tidb", "tiflash" ] }, "centralClusterImportId": { "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" ] }, "centralClusterNodeProfile": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "default_node_num": { "type": "integer", "format": "int32" }, "min_storage_size_gi": { "type": "integer", "format": "int32" }, "max_storage_size_gi": { "type": "integer", "format": "int32" } } }, "centralClusterStatus": { "type": "string", "enum": [ "NORMAL", "CREATING", "SCALING", "UPGRADING", "UNAVAILABLE", "RECOVERING", "IMPORTING" ], "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" } }, "required": [ "replicas", "node_profile" ] }, "centralComponentNodeProfiles": { "type": "object", "properties": { "component_type": { "$ref": "#/definitions/centralComponentType" }, "profiles": { "type": "array", "items": { "$ref": "#/definitions/centralClusterNodeProfile" } } } }, "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" ] }, "centralConnector": { "type": "object", "properties": { "connector_id": { "type": "string", "format": "uint64" }, "connector_type": { "$ref": "#/definitions/centralConnectorType" }, "url": { "type": "string" }, "topic": { "type": "string" }, "user": { "type": "string" }, "status": { "$ref": "#/definitions/centralConnectorStatus" }, "error": { "type": "string" } }, "required": [ "connector_id", "connector_type", "url", "status" ] }, "centralConnectorCreateReq": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "org_id": { "type": "string", "format": "uint64" }, "connector_type": { "$ref": "#/definitions/centralConnectorType" }, "url": { "type": "string" }, "topic": { "type": "string" }, "user": { "type": "string" }, "password": { "type": "string" }, "start_tso": { "type": "string", "format": "uint64" }, "ignore_replication": { "type": "boolean", "format": "boolean" } }, "required": [ "cluster_id", "org_id", "connector_type", "project_id", "url" ] }, "centralConnectorID": { "type": "object", "properties": { "connector_id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" } }, "required": [ "connector_id", "cluster_id", "org_id", "project_id" ] }, "centralConnectorStatus": { "type": "string", "enum": [ "NORMAL", "UNAVAILABLE", "INVALID", "CREATING" ], "default": "NORMAL" }, "centralConnectorType": { "type": "string", "enum": [ "TOTAL", "KAFKA", "TIDB", "MYSQL" ], "default": "TOTAL" }, "centralConnectors": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/centralConnector" } }, "total": { "type": "integer", "format": "int64" } }, "required": [ "items", "total" ] }, "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" ] }, "centralCreateAuth0UserReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "token": { "type": "string" }, "password": { "type": "string" } }, "required": [ "org_id", "token", "password" ] }, "centralCreateClusterReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "root_password": { "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" }, "cross_account_deployment_id": { "type": "string", "format": "uint64" } }, "required": [ "org_id", "project_id", "name", "root_password", "provider", "region", "is_dev_tier", "components", "primary_cluster_id" ] }, "centralCreateClusterResp": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": [ "id", "base_resp" ] }, "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" }, "pac_arn_inside_cluster": { "type": "string" }, "pac_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", "pac_arn_inside_cluster", "pac_arn_client", "role_arn_tidb_cloud", "role_arn_eks", "role_arn_node" ] }, "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" ] }, "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" ] }, "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" } }, "required": [ "org_id", "name" ] }, "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" } } } }, "centralCrossAccountDeploymentRecord": { "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" }, "pac_arn_inside_cluster": { "type": "string" }, "pac_arn_client": { "type": "string" }, "role_arn_tidb_cloud": { "type": "string" }, "role_arn_eks": { "type": "string" }, "role_arn_node": { "type": "string" }, "id": { "type": "string", "format": "uint64" } }, "required": [ "org_id", "project_id", "provider", "region", "vpc_id", "security_group_id", "subnet_ids", "bucket_name", "kms_key_arn", "pac_arn_inside_cluster", "pac_arn_client", "role_arn_tidb_cloud", "role_arn_eks", "role_arn_node", "id" ] }, "centralCurrentTable": { "type": "object", "properties": { "name": { "type": "string" }, "size": { "type": "string", "format": "uint64" }, "completed_percent": { "type": "integer", "format": "int64" } }, "required": [ "name", "size", "completed_percent" ] }, "centralCustomCSVFormat": { "type": "object", "properties": { "separator": { "type": "string" }, "delimiter": { "type": "string" }, "header": { "type": "boolean", "format": "boolean" }, "not_null": { "type": "boolean", "format": "boolean" }, "null": { "type": "string" }, "backslash_escape": { "type": "boolean", "format": "boolean" }, "trim_last_separator": { "type": "boolean", "format": "boolean" } } }, "centralCustomizedTenantImage": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uint64" }, "tikv_image": { "$ref": "#/definitions/centralImage" }, "tidb_image": { "$ref": "#/definitions/centralImage" }, "tiflash_image": { "$ref": "#/definitions/centralImage" }, "pd_image": { "$ref": "#/definitions/centralImage" }, "backup_image": { "$ref": "#/definitions/centralImage" }, "restore_image": { "$ref": "#/definitions/centralImage" }, "default_version": { "type": "string" } } }, "centralDashboardLink": { "type": "object", "properties": { "name": { "type": "string" }, "link": { "type": "string" } }, "required": [ "name", "link" ] }, "centralDataIngestionProfile": { "type": "object", "properties": { "type": { "type": "string" }, "aws_external_id": { "type": "string" }, "aws_account_id": { "type": "string" }, "gcp_account_id": { "type": "string" }, "cross_account_node_role_arn": { "type": "string" } }, "required": [ "type", "aws_external_id", "aws_account_id", "gcp_account_id" ] }, "centralDatadogSite": { "type": "string", "enum": [ "DATADOG_SITE_UNSPECIFIED", "DATADOG_SITE_US1", "DATADOG_SITE_US3", "DATADOG_SITE_US5", "DATADOG_SITE_EU1", "DATADOG_SITE_US1_FED" ], "default": "DATADOG_SITE_UNSPECIFIED" }, "centralDebugPortalExchangeOAuthTokenReq": { "type": "object", "properties": { "redirect_uri": { "type": "string" }, "code": { "type": "string" }, "state": { "type": "string" }, "session_key_as_cookie": { "type": "boolean", "format": "boolean", "description": "Whether the returned session key should be placed in the cookie." } }, "required": [ "redirect_uri", "code", "state", "session_key_as_cookie" ] }, "centralDebugPortalExchangeOAuthTokenResp": { "type": "object", "properties": { "session_key": { "type": "string" } }, "required": [ "session_key" ] }, "centralDebugPortalGetBasicSessionResp": { "type": "object", "properties": { "email": { "type": "string" }, "username": { "type": "string" }, "csrf_token": { "type": "string" } }, "required": [ "email", "username", "csrf_token" ] }, "centralDebugPortalGetOAuthConfigResp": { "type": "object", "properties": { "auth_url": { "type": "string" } }, "required": [ "auth_url" ] }, "centralDebugPortalSignOutReq": { "type": "object", "properties": { "redirect_uri": { "type": "string" }, "session_key_as_cookie": { "type": "boolean", "format": "boolean", "description": "Whether the returned session key was placed in the cookie." } }, "required": [ "redirect_uri", "session_key_as_cookie" ] }, "centralDebugPortalSignOutResp": { "type": "object", "properties": { "oauth_sign_out_uri": { "type": "string" } }, "required": [ "oauth_sign_out_uri" ] }, "centralDefaultResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": [ "base_resp" ] }, "centralDeletedCluster": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "delete_time": { "type": "string", "format": "date-time" }, "latest_backup_size": { "type": "string", "format": "uint64" } }, "required": [ "id", "name", "provider", "region", "delete_time", "latest_backup_size" ] }, "centralDeletedClusters": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralDeletedCluster" } } }, "required": [ "total", "items" ] }, "centralDetachReplicationResp": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "replication_id": { "type": "string", "format": "uint64" } }, "required": [ "cluster_id", "replication_id" ] }, "centralEndpoint": { "type": "object", "properties": { "ready": { "type": "boolean", "format": "boolean" }, "address": { "type": "string" }, "port": { "type": "integer", "format": "int32" } }, "required": [ "ready", "address", "port" ] }, "centralGcpVpcPeering": { "type": "object", "properties": { "region": { "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", "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" ] }, "centralGenerateTestTokenReq": { "type": "object", "properties": { "email": { "type": "string" }, "auth0_domain": { "type": "string" }, "auth0_client_id": { "type": "string" }, "auth0_client_secret": { "type": "string" } } }, "centralGenerateTestTokenResp": { "type": "object", "properties": { "token": { "type": "string" }, "expire_at": { "type": "string", "format": "int64" } } }, "centralGetClientIPResp": { "type": "object", "properties": { "ip": { "type": "string" } }, "required": [ "ip" ] }, "centralGetClusterResp": { "type": "object", "properties": { "cluster": { "$ref": "#/definitions/centralCluster" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "required": [ "cluster", "base_resp" ] }, "centralGetDashboardLinksResp": { "type": "object", "properties": { "dashboards": { "type": "array", "items": { "$ref": "#/definitions/centralDashboardLink" } } }, "required": [ "dashboards" ] }, "centralGetPrivateEndpointResp": { "type": "object", "properties": { "status": { "$ref": "#/definitions/centralPrivateEndpointStatus" }, "domain": { "type": "string" }, "port": { "type": "string", "format": "uint64" } }, "required": [ "status", "domain", "port" ] }, "centralGetProjectRegionCIDRResp": { "type": "object", "properties": { "project_region_cidrs": { "type": "array", "items": { "$ref": "#/definitions/centralProjectRegionCIDR" } } } }, "centralGetSlowQueryDatabasesResp": { "type": "object", "properties": { "dbs": { "type": "array", "items": { "type": "string" } } } }, "centralGetSlowQueryDetailsResp": { "type": "object", "properties": { "log": { "$ref": "#/definitions/centralSlowQueryDetails" } } }, "centralGetSlowQueryFieldsResp": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } } } }, "centralGetTiDBCloudDelegationInfoResp": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "account_id": { "type": "string" }, "external_id": { "type": "string" } }, "required": [ "org_id", "project_id", "account_id", "external_id" ] }, "centralIamRole": { "type": "object", "properties": { "arn": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "usage": { "type": "array", "items": { "$ref": "#/definitions/centralIamRoleUsage" } }, "id": { "type": "string", "format": "uint64" } }, "title": "cross account deployment service", "required": [ "arn", "created_at", "usage", "id" ] }, "centralIamRoleUsage": { "type": "object", "properties": { "service_name": { "type": "string" }, "provider_name": { "type": "string" }, "region_name": { "type": "string" }, "usage_message": { "type": "string" } }, "required": [ "service_name", "provider_name", "region_name", "usage_message" ] }, "centralImage": { "type": "object", "properties": { "base_url": { "type": "string" }, "tag": { "type": "string" } } }, "centralImportCreateReq": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "source_url": { "type": "string", "title": "import info" }, "region": { "type": "string" }, "data_format": { "type": "integer", "format": "int64", "title": "1: sql statement(dumpling default format\n2: aurora snapshot(parquet)\n3: custom csv\n4: parquet format(not aurora)" }, "data_source_type": { "type": "integer", "format": "int64", "title": "1: aws s3\n2: GCS" }, "target_username": { "type": "string" }, "target_password": { "type": "string" }, "filter": { "type": "string" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "csv_format": { "$ref": "#/definitions/centralCustomCSVFormat" }, "aws_role_arn": { "type": "string" }, "object_name_pattern": { "type": "string" }, "target_table_pattern": { "type": "string" } }, "required": [ "cluster_id", "source_url", "region", "data_format", "data_source_type", "target_username", "target_password", "filter", "org_id", "project_id" ] }, "centralImportGetResp": { "type": "object", "properties": { "cluster_id": { "type": "string", "format": "uint64" }, "total_size": { "type": "string", "format": "uint64" }, "total_files": { "type": "integer", "format": "int64" }, "source_url": { "type": "string" }, "completed_tables": { "type": "integer", "format": "int64" }, "pending_tables": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/definitions/centralImportGetRespStatus" }, "completed_percent": { "type": "integer", "format": "int64" }, "current_tables": { "type": "array", "items": { "$ref": "#/definitions/centralCurrentTable" } }, "data_format": { "type": "integer", "format": "int64" }, "data_source_type": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "elapsed_time_seconds": { "type": "integer", "format": "int64" } }, "required": [ "cluster_id", "total_size", "total_files", "source_url", "completed_tables", "pending_tables", "created_at", "status", "completed_percent", "current_tables", "data_format", "data_source_type", "message", "elapsed_time_seconds" ] }, "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" } }, "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" ] }, "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" } }, "required": [ "org_id", "project_id", "type", "status" ] }, "centralIntegrationType": { "type": "string", "enum": [ "INTEGRATION_TYPE_UNSPECIFIED", "INTEGRATION_TYPE_DATADOG", "INTEGRATION_TYPE_PROMETHEUS" ], "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" ] }, "centralListAccessLogResp": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralAccessLog" } } }, "required": [ "total", "items" ] }, "centralListCloudProvidersReq": { "type": "object", "properties": { "is_dev_tier": { "type": "boolean", "format": "boolean" } }, "required": [ "is_dev_tier" ] }, "centralListCrossAccountDeploymentResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/centralCrossAccountDeploymentRecord" } }, "total": { "type": "integer", "format": "int32" } }, "required": [ "items", "total" ] }, "centralListIamRolesResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/centralIamRole" } }, "total": { "type": "integer", "format": "int32" } }, "required": [ "items", "total" ] }, "centralListTenantClustersResp": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralTenantCluster" } } }, "required": [ "total", "items" ] }, "centralListTenantsResp": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralTenant" } } }, "required": [ "total", "items" ] }, "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" ] }, "centralNodeProfile": { "type": "object", "properties": { "compute": { "$ref": "#/definitions/centralCompute" }, "storage_gi": { "type": "integer", "format": "int64" }, "node_profile_id": { "type": "string", "format": "uint64" }, "name": { "type": "string" } }, "required": [ "compute", "storage_gi", "node_profile_id", "name" ] }, "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" } }, "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" ] }, "centralPrivateEndpointStatus": { "type": "string", "enum": [ "NO_VPC_PEERING", "VPC_PEERING_ERROR", "NO_DOMAIN", "CREATING", "NORMAL" ], "default": "NO_VPC_PEERING" }, "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" }, "cross_account_deployment_ids": { "type": "array", "items": { "type": "string", "format": "uint64" } } }, "required": [ "id", "name", "active_clusters_count", "users_count" ] }, "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" ] }, "centralQuerySlowQueriesBody": { "type": "object", "properties": { "begin_time": { "type": "integer", "format": "int32" }, "end_time": { "type": "integer", "format": "int32" }, "db": { "type": "array", "items": { "type": "string" } }, "limit": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "orderBy": { "type": "string" }, "desc": { "type": "boolean", "format": "boolean" }, "plans": { "type": "array", "items": { "type": "string" } }, "digest": { "type": "string" }, "fields": { "type": "string" } } }, "centralQuerySlowQueriesResp": { "type": "object", "properties": { "logs": { "type": "array", "items": { "$ref": "#/definitions/centralSlowQueryDetails" } } } }, "centralRegion": { "type": "object", "properties": { "name": { "type": "string" }, "display_name": { "type": "string" } }, "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", "cidr", "active" ] }, "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" } }, "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": { "type": "string" }, "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" } } }, "centralRestoreResp": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" }, "org_id": { "type": "string", "format": "uint64" }, "base_resp": { "$ref": "#/definitions/centralBaseResp" } }, "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" ] }, "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" ] }, "centralSlowQueryDetails": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "digest": { "type": "string" }, "query": { "type": "string" }, "instance": { "type": "string" }, "db": { "type": "string" }, "connection_id": { "type": "string" }, "success": { "type": "integer", "format": "int32" }, "timestamp": { "type": "number", "format": "double" }, "query_time": { "type": "number", "format": "double" }, "parse_time": { "type": "number", "format": "double" }, "compile_time": { "type": "number", "format": "double" }, "rewrite_time": { "type": "number", "format": "double" }, "preproc_subqueries_time": { "type": "number", "format": "double" }, "optimize_time": { "type": "number", "format": "double" }, "wait_ts": { "type": "number", "format": "double" }, "cop_time": { "type": "number", "format": "double" }, "lock_keys_time": { "type": "number", "format": "double" }, "write_sql_response_total": { "type": "number", "format": "double" }, "exec_retry_time": { "type": "number", "format": "double" }, "memory_max": { "type": "integer", "format": "int32" }, "disk_max": { "type": "integer", "format": "int32" }, "txn_start_ts": { "type": "string" }, "prev_stmt": { "type": "string" }, "plan": { "type": "string" }, "is_internal": { "type": "integer", "format": "int32" }, "index_names": { "type": "string" }, "stats": { "type": "string" }, "backoff_types": { "type": "string" }, "user": { "type": "string" }, "host": { "type": "string" }, "process_time": { "type": "number", "format": "double" }, "wait_time": { "type": "number", "format": "double" }, "backoff_time": { "type": "number", "format": "double" }, "get_commit_ts_time": { "type": "number", "format": "double" }, "local_latch_wait_time": { "type": "number", "format": "double" }, "resolve_lock_time": { "type": "number", "format": "double" }, "prewrite_time": { "type": "number", "format": "double" }, "wait_prewrite_binlog_time": { "type": "number", "format": "double" }, "commit_time": { "type": "number", "format": "double" }, "commit_backoff_time": { "type": "number", "format": "double" }, "cop_proc_avg": { "type": "number", "format": "double" }, "cop_proc_p90": { "type": "number", "format": "double" }, "cop_proc_max": { "type": "number", "format": "double" }, "cop_wait_avg": { "type": "number", "format": "double" }, "cop_wait_p90": { "type": "number", "format": "double" }, "cop_wait_max": { "type": "number", "format": "double" }, "write_keys": { "type": "integer", "format": "int32" }, "write_size": { "type": "integer", "format": "int32" }, "prewrite_region": { "type": "integer", "format": "int32" }, "txn_retry": { "type": "integer", "format": "int32" }, "request_count": { "type": "integer", "format": "int32" }, "process_keys": { "type": "integer", "format": "int32" }, "total_keys": { "type": "integer", "format": "int32" }, "cop_proc_addr": { "type": "string" }, "cop_wait_addr": { "type": "string" }, "rocksdb_delete_skipped_count": { "type": "integer", "format": "int32" }, "rocksdb_key_skipped_count": { "type": "integer", "format": "int32" }, "rocksdb_block_cache_hit_count": { "type": "integer", "format": "int32" }, "rocksdb_block_read_count": { "type": "integer", "format": "int32" }, "rocksdb_block_read_byte": { "type": "integer", "format": "int32" } } }, "centralTenant": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "timezone": { "type": "integer", "format": "int32" }, "email": { "type": "string" }, "status": { "type": "string" }, "plan": { "type": "string" }, "discount": { "type": "string", "format": "int64" }, "discount_description": { "type": "string" }, "bind_credit_at": { "type": "string", "format": "date-time" }, "country": { "type": "string" }, "has_discount": { "type": "boolean", "format": "boolean" } }, "required": [ "id", "name", "timezone", "email", "status", "plan", "discount", "discount_description", "bind_credit_at", "country", "has_discount" ] }, "centralTenantCluster": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "profile": { "type": "string" }, "version": { "type": "string" }, "create_time": { "type": "string", "format": "date-time" }, "tenant_components": { "$ref": "#/definitions/centralTenantComponents" }, "status": { "$ref": "#/definitions/centralClusterStatus" } }, "required": [ "id", "name", "provider", "region", "profile", "version", "create_time", "tenant_components", "status" ] }, "centralTenantComponent": { "type": "object", "properties": { "replicas": { "type": "integer", "format": "int64" }, "machineType": { "type": "string" } }, "required": [ "replicas", "machineType" ] }, "centralTenantComponents": { "type": "object", "properties": { "pd": { "$ref": "#/definitions/centralTenantComponent" }, "tikv": { "$ref": "#/definitions/centralTenantComponent" }, "tidb": { "$ref": "#/definitions/centralTenantComponent" }, "tiflash": { "$ref": "#/definitions/centralTenantComponent" } }, "required": [ "pd", "tikv", "tidb", "tiflash" ] }, "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": [ "NORMAL", "CREATING", "UNAVAILABLE", "TERMINATING" ], "default": "NORMAL" }, "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": [ "NORMAL", "CREATING", "UNAVAILABLE", "TERMINATING", "LEAVING" ], "default": "NORMAL" }, "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" ] }, "centralTopSQLDigestCPUTimeRecord": { "type": "object", "properties": { "is_others": { "type": "boolean", "format": "boolean" }, "sql_digest": { "type": "string", "format": "byte" }, "sql_text": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/definitions/centralTopSQLTimestampCPUMsTuple" } } } }, "centralTopSQLGetInstanceResp": { "type": "object", "properties": { "instances": { "type": "array", "items": { "$ref": "#/definitions/centralTopSQLInstance" } } } }, "centralTopSQLGetTopDigestResp": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/definitions/centralTopSQLDigestCPUTimeRecord" } } } }, "centralTopSQLInstance": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "component": { "type": "string" } } }, "centralTopSQLTimestampCPUMsTuple": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "uint64" }, "cpu_time_ms": { "type": "integer", "format": "int64" } } }, "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" ] }, "centralUpdateMetaReq": { "type": "object", "properties": { "use_mfa": { "type": "boolean", "format": "boolean" } }, "required": [ "use_mfa" ] }, "centralUpdateOrgDefaultPaymentReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "default_source": { "type": "string" } }, "required": [ "org_id", "default_source" ] }, "centralUpdateOrgReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "name": { "type": "string" }, "timezone": { "type": "integer", "format": "int32" } }, "required": [ "org_id", "name", "timezone" ] }, "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", "cluster_id", "org_id", "project_id" ] }, "centralUpdateUserProfileReq": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "first_name": { "type": "string" }, "last_name": { "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" }, "role": { "type": "string" } }, "required": [ "id", "email", "name", "status", "invite_time", "role" ] }, "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" } } }, "required": [ "id", "email", "first_name", "last_name", "role", "projects" ] }, "centralUserProject": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "centralUsers": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/definitions/centralUser" } } }, "required": [ "total", "items" ] }, "centralWriteStatus": { "type": "string", "enum": [ "WRITABLE", "READONLY" ], "default": "WRITABLE" }, "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 }" } }, "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" } }