{ "swagger": "2.0", "info": { "title": "regional/serverless/v1/services.proto", "version": "2.0" }, "tags": [ { "name": "ServerlessRegionalService" }, { "name": "ServerlessImportRegionalService" }, { "name": "ServerlessDMRegionalService" }, { "name": "ServerlessPrivateLinkConnectionRegionalService" } ], "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/serverless/regional/v1/desc": { "get": { "summary": "Self description", "operationId": "ServerlessRegionalService_DescRegion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerlessRegionalServiceDescRegionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "tags": [ "ServerlessRegionalService" ] } }, "/serverless/regional/v1/clusters/{clusterId}": { "get": { "operationId": "ServerlessRegionalService_GetCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerlessRegionalServiceGetClusterResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "projectId", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": [ "ServerlessRegionalService" ] }, "delete": { "operationId": "ServerlessRegionalService_DeleteCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerlessRegionalServiceDeleteClusterResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "tenantId", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "projectId", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": [ "ServerlessRegionalService" ] }, "post": { "summary": "Clusters CRUD", "operationId": "ServerlessRegionalService_CreateCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerlessRegionalServiceCreateClusterResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "description": "The cluster-id is pre-created before cluster in global", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1ServerlessRegionalServiceCreateClusterBody" } } ], "tags": [ "ServerlessRegionalService" ] }, "patch": { "operationId": "ServerlessRegionalService_UpdateCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerlessRegionalServiceUpdateClusterResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "clusterId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1ServerlessRegionalServiceUpdateClusterBody" } } ], "tags": [ "ServerlessRegionalService" ] } }, "/serverless/regional/v1/clusters": { "get": { "operationId": "ServerlessRegionalService_ListClusters", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerlessRegionalServiceListClustersResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "type": "string", "format": "int64" }, { "name": "page_size", "in": "query", "required": false, "type": "string", "format": "int64" }, { "name": "states", "description": " - CLUSTER_STATE_READY: The cluster can be accessed only when it is `READY`", "in": "query", "required": false, "type": "array", "items": { "type": "string", "enum": [ "CLUSTER_STATE_READY", "CLUSTER_STATE_CREATING", "CLUSTER_STATE_DELETING", "CLUSTER_STATE_DELETED" ] }, "collectionFormat": "multi" }, { "name": "cluster_ids", "description": "repeated ClusterState exclude_states = 5;", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "project_ids", "in": "query", "required": false, "type": "array", "items": { "type": "string", "format": "uint64" }, "collectionFormat": "multi" } ], "tags": [ "ServerlessRegionalService" ] } }, "/serverless/regional/v1/clusters:checkCloudStoragePermission": { "post": { "operationId": "ServerlessRegionalService_CheckCloudStoragePermission", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1CheckCloudStoragePermissionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1CheckCloudStoragePermissionRequest" } } ], "tags": [ "ServerlessRegionalService" ] } }, "/serverless/regional/v1/import:checkPermission": { "post": { "operationId": "ServerlessImportRegionalService_CheckImportPermission", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1CheckImportPermissionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1CheckImportPermissionRequest" } } ], "tags": [ "ServerlessImportRegionalService" ] } }, "/serverless/regional/v1/import:precheck": { "post": { "operationId": "ServerlessImportRegionalService_Precheck", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1PrecheckResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1PrecheckRequest" } } ], "tags": [ "ServerlessImportRegionalService" ] } }, "/serverless/regional/v1/dm:precheck": { "post": { "operationId": "ServerlessDMRegionalService_Precheck", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerlessDMRegionalServicePrecheckResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1ServerlessDMRegionalServicePrecheckRequest" } } ], "tags": [ "ServerlessDMRegionalService" ] } }, "/serverless/regional/v1/dm:createVpcEndpoint": { "post": { "operationId": "ServerlessDMRegionalService_CreateVpcEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1CreateVpcEndpointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1CreateVpcEndpointRequest" } } ], "tags": [ "ServerlessDMRegionalService" ] } }, "/serverless/regional/v1/dm:describeVpcEndpoint": { "post": { "operationId": "ServerlessDMRegionalService_DescribeVpcEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1DescribeVpcEndpointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DescribeVpcEndpointRequest" } } ], "tags": [ "ServerlessDMRegionalService" ] } }, "/serverless/regional/v1/dm:deleteVpcEndpoint": { "post": { "operationId": "ServerlessDMRegionalService_DeleteVpcEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteVpcEndpointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteVpcEndpointRequest" } } ], "tags": [ "ServerlessDMRegionalService" ] } }, "/serverless/regional/v1/dm:listVpcEndpointZones": { "post": { "summary": "List zones of a VPC endpoint", "operationId": "ServerlessDMRegionalService_ListVpcEndpointZones", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1ListVpcEndpointZonesResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1ListVpcEndpointZonesRequest" } } ], "tags": [ "ServerlessDMRegionalService" ] } }, "/serverless/regional/v1/dm:removeZoneFromVpcEndpoint": { "post": { "summary": "Remove a zone from a VPC endpoint", "operationId": "ServerlessDMRegionalService_RemoveZoneFromVpcEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RemoveZoneFromVpcEndpointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1RemoveZoneFromVpcEndpointRequest" } } ], "tags": [ "ServerlessDMRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:createAWSVpcEndpoint": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_CreateAWSVpcEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAWSVpcEndpointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAWSVpcEndpointRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:describeAWSVpcEndpoint": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_DescribeAWSVpcEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1DescribeAWSVpcEndpointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DescribeAWSVpcEndpointRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:deleteAWSVpcEndpoint": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_DeleteAWSVpcEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteAWSVpcEndpointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteAWSVpcEndpointRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:createAliCloudVpcEndpoint": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_CreateAliCloudVpcEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAliCloudVpcEndpointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAliCloudVpcEndpointRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:describeAliCloudVpcEndpoint": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_DescribeAliCloudVpcEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1DescribeAliCloudVpcEndpointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DescribeAliCloudVpcEndpointRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:deleteAliCloudVpcEndpoint": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_DeleteAliCloudVpcEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteAliCloudVpcEndpointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteAliCloudVpcEndpointRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:getZoneIds": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_GetZoneIds", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1GetZoneIdsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1GetZoneIdsRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:listAliCloudVpcEndpointZones": { "post": { "summary": "List zones of a VPC endpoint", "operationId": "ServerlessPrivateLinkConnectionRegionalService_ListAliCloudVpcEndpointZones", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1ListAliCloudVpcEndpointZonesResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1ListAliCloudVpcEndpointZonesRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:removeZoneFromAliCloudVpcEndpoint": { "post": { "summary": "Remove a zone from a VPC endpoint", "operationId": "ServerlessPrivateLinkConnectionRegionalService_RemoveAliCloudZoneFromVpcEndpoint", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RemoveAliCloudZoneFromVpcEndpointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1RemoveAliCloudZoneFromVpcEndpointRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:createAliCloudDNSRecord": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_CreateAliCloudDNSRecord", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAliCloudDNSRecordResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAliCloudDNSRecordRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:deleteAliCloudDNSRecord": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_DeleteAliCloudDNSRecord", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteAliCloudDNSRecordResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteAliCloudDNSRecordRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:createAWSRoute53Records": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_CreateAWSRoute53Records", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAWSRoute53RecordsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAWSRoute53RecordsRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:deleteAWSRoute53Records": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_DeleteAWSRoute53Records", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteAWSRoute53RecordsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteAWSRoute53RecordsRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:getAWSRoute53Change": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_GetAWSRoute53Change", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1GetAWSRoute53ChangeResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1GetAWSRoute53ChangeRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:createAWSRoute53PrivateHostedZone": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_CreateAWSRoute53PrivateHostedZone", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAWSRoute53PrivateHostedZoneResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAWSRoute53PrivateHostedZoneRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:deleteAWSRoute53PrivateHostedZone": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_DeleteAWSRoute53PrivateHostedZone", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteAWSRoute53PrivateHostedZoneResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteAWSRoute53PrivateHostedZoneRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:createAliCloudDNSPrivateHostedZone": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_CreateAliCloudDNSPrivateHostedZone", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAliCloudDNSPrivateHostedZoneResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1CreateAliCloudDNSPrivateHostedZoneRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:deleteAliCloudDNSPrivateHostedZone": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_DeleteAliCloudDNSPrivateHostedZone", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteAliCloudDNSPrivateHostedZoneResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteAliCloudDNSPrivateHostedZoneRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:attachVpcToAliCloudDNSPrivateHostedZone": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_AttachVpcToAliCloudDNSPrivateHostedZone", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1AttachVpcToAliCloudDNSPrivateHostedZoneResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1AttachVpcToAliCloudDNSPrivateHostedZoneRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:detachVpcFromAliCloudDNSPrivateHostedZone": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_DetachVpcFromAliCloudDNSPrivateHostedZone", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1DetachVpcFromAliCloudDNSPrivateHostedZoneResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DetachVpcFromAliCloudDNSPrivateHostedZoneRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:createMSKVPCConnection": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_CreateMSKVPCConnection", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1CreateMSKVPCConnectionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1CreateMSKVPCConnectionRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:deleteMSKVPCConnection": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_DeleteMSKVPCConnection", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteMSKVPCConnectionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1DeleteMSKVPCConnectionRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } }, "/serverless/regional/v1/privateLinkConnection:getMSKVPCConnection": { "post": { "operationId": "ServerlessPrivateLinkConnectionRegionalService_GetMSKVPCConnection", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/regionalserverlessv1GetMSKVPCConnectionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/regionalserverlessv1GetMSKVPCConnectionRequest" } } ], "tags": [ "ServerlessPrivateLinkConnectionRegionalService" ] } } }, "definitions": { "DMPrecheckBlockAllowRules": { "type": "object", "properties": { "doDbs": { "type": "array", "items": { "type": "string" } }, "doTables": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/serverlessv1Table" }, "title": "support blocklist in the future\n repeated string ignore_dbs = 3;\n repeated Table ignore_tables = 4;" } } }, "DMPrecheckConnProfile": { "type": "object", "properties": { "host": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "user": { "type": "string" }, "password": { "type": "string" }, "security": { "title": "optional, if not set, use default", "allOf": [ { "$ref": "#/definitions/DMPrecheckSecurity" } ] } } }, "DMPrecheckSecurity": { "type": "object", "properties": { "certAllowedCn": { "type": "array", "items": { "type": "string" } }, "sslCaContent": { "type": "string", "format": "byte" }, "sslCertContent": { "type": "string", "format": "byte" }, "sslKeyContent": { "type": "string", "format": "byte" } } }, "DMPrecheckSource": { "type": "object", "properties": { "connProfile": { "$ref": "#/definitions/DMPrecheckConnProfile" }, "rules": { "$ref": "#/definitions/DMPrecheckBlockAllowRules" }, "binlogName": { "type": "string", "x-nullable": true }, "binlogPos": { "type": "integer", "format": "int32", "x-nullable": true }, "binlogGtid": { "type": "string", "x-nullable": true }, "needPkCheck": { "type": "boolean" }, "routeRules": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/DMPrecheckTableRouteRule" } } } }, "DMPrecheckTableRouteRule": { "type": "object", "properties": { "schemaPattern": { "type": "string" }, "tablePattern": { "type": "string" }, "targetSchema": { "type": "string" }, "targetTable": { "type": "string" } } }, "DMPrecheckTargetDatabase": { "type": "object", "properties": { "host": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "user": { "type": "string" }, "password": { "type": "string" } } }, "DMPrecheckTaskMode": { "type": "string", "enum": [ "TASK_MODE_ALL", "TASK_MODE_INCREMENTAL" ] }, "VpcEndpointDetailsAlicloudDetail": { "type": "object", "properties": { "endpointState": { "type": "string" }, "connectionState": { "type": "string" } } }, "VpcEndpointDetailsProviderType": { "type": "string", "enum": [ "TYPE_ALICLOUD" ] }, "googlerpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code]." }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client." }, "details": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protobufAny" }, "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use." } }, "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors)." }, "protobufAny": { "type": "object", "properties": { "@type": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. 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`, `https`, 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, `https` 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. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics." } }, "additionalProperties": {}, "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 // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\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 := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(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\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 }" }, "regionalserverlessv1AttachVpcToAliCloudDNSPrivateHostedZoneRequest": { "type": "object", "properties": { "hostedZoneId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1AttachVpcToAliCloudDNSPrivateHostedZoneResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1AzureBlobCloudStorage": { "type": "object", "properties": { "authType": { "$ref": "#/definitions/v1AzureBlobCloudStorageAuthType" }, "sasToken": { "type": "string", "title": "The SAS token to access Azure Blob Storage" } } }, "regionalserverlessv1CheckCloudStoragePermissionRequest": { "type": "object", "properties": { "clusterId": { "type": "string" }, "cloudStorage": { "$ref": "#/definitions/regionalserverlessv1CloudStorage" }, "featureName": { "$ref": "#/definitions/regionalserverlessv1CheckCloudStoragePermissionRequestFeatureName" } } }, "regionalserverlessv1CheckCloudStoragePermissionRequestFeatureName": { "type": "string", "enum": [ "DATABASE_AUDIT_LOG", "EXPORT", "CHANGEFEED" ] }, "regionalserverlessv1CheckCloudStoragePermissionResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1CheckImportPermissionRequest": { "type": "object", "properties": { "cloudStorage": { "$ref": "#/definitions/regionalserverlessv1CloudStorage" } } }, "regionalserverlessv1CheckImportPermissionResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1CloudProvider": { "type": "string", "enum": [ "CLOUD_PROVIDER_AWS", "CLOUD_PROVIDER_GCP", "CLOUD_PROVIDER_AZURE", "CLOUD_PROVIDER_ALICLOUD" ], "title": "TODO: move to base definition" }, "regionalserverlessv1CloudStorage": { "type": "object", "properties": { "cloudStorageType": { "$ref": "#/definitions/regionalserverlessv1CloudStorageType" }, "s3": { "$ref": "#/definitions/regionalserverlessv1S3CloudStorage" }, "gcs": { "$ref": "#/definitions/regionalserverlessv1GCSCloudStorage" }, "azureBlob": { "$ref": "#/definitions/regionalserverlessv1AzureBlobCloudStorage" }, "s3Compatible": { "$ref": "#/definitions/v1S3CompatibleCloudStorage" }, "oss": { "$ref": "#/definitions/regionalserverlessv1OSSCloudStorage" }, "uri": { "type": "string", "description": "The URI of the cloud storage data dir." } } }, "regionalserverlessv1CloudStorageType": { "type": "string", "enum": [ "S3", "GCS", "AZURE_BLOB", "OSS", "S3_COMPATIBLE", "INTERNAL" ], "title": "- S3_COMPATIBLE: S3 compatible storage\n - INTERNAL: Internal source storage, no authentication required" }, "regionalserverlessv1CreateAWSRoute53PrivateHostedZoneRequest": { "type": "object", "properties": { "hostedZoneName": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1CreateAWSRoute53PrivateHostedZoneResponse": { "type": "object", "properties": { "hostedZoneId": { "type": "string" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1CreateAWSRoute53RecordsRequest": { "type": "object", "properties": { "records": { "type": "object", "additionalProperties": { "type": "string" } }, "hostedZoneName": { "type": "string", "title": "only used by tidb cloud managed hosted zone" }, "hostedZoneId": { "type": "string" } } }, "regionalserverlessv1CreateAWSRoute53RecordsResponse": { "type": "object", "properties": { "changeId": { "type": "string" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1CreateAWSVpcEndpointRequest": { "type": "object", "properties": { "endpointServiceName": { "type": "string" }, "endpointServiceRegion": { "type": "string", "title": "optional, use it when you want to connect to cross-region endpoint service" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } }, "title": "The following messages are for Private Link Connection service" }, "regionalserverlessv1CreateAWSVpcEndpointResponse": { "type": "object", "properties": { "endpoint": { "$ref": "#/definitions/v1AWSVpcEndpoint" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1CreateAliCloudDNSPrivateHostedZoneRequest": { "type": "object", "properties": { "hostedZoneName": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1CreateAliCloudDNSPrivateHostedZoneResponse": { "type": "object", "properties": { "hostedZoneId": { "type": "string" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1CreateAliCloudDNSRecordRequest": { "type": "object", "properties": { "record": { "type": "string" }, "value": { "type": "string" }, "hostedZoneName": { "type": "string", "title": "only used by tidb cloud managed hosted zone" }, "hostedZoneId": { "type": "string" } } }, "regionalserverlessv1CreateAliCloudDNSRecordResponse": { "type": "object", "properties": { "recordId": { "type": "string", "format": "int64" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1CreateAliCloudVpcEndpointRequest": { "type": "object", "properties": { "endpointServiceName": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1CreateAliCloudVpcEndpointResponse": { "type": "object", "properties": { "endpoint": { "$ref": "#/definitions/v1AliCloudVpcEndpoint" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1CreateMSKVPCConnectionRequest": { "type": "object", "properties": { "mskArn": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" }, "kubernetes": { "type": "string" } } }, "regionalserverlessv1CreateMSKVPCConnectionResponse": { "type": "object", "properties": { "mskVpcConnection": { "$ref": "#/definitions/v1MSKVpcConnection" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1CreateVpcEndpointRequest": { "type": "object", "properties": { "serviceName": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1CreateVpcEndpointResponse": { "type": "object", "properties": { "endpointDetails": { "$ref": "#/definitions/v1VpcEndpointDetails" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1DeleteAWSRoute53PrivateHostedZoneRequest": { "type": "object", "properties": { "hostedZoneId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1DeleteAWSRoute53PrivateHostedZoneResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1DeleteAWSRoute53RecordsRequest": { "type": "object", "properties": { "records": { "type": "object", "additionalProperties": { "type": "string" } }, "hostedZoneName": { "type": "string", "title": "only used by tidb cloud managed hosted zone" }, "hostedZoneId": { "type": "string" } } }, "regionalserverlessv1DeleteAWSRoute53RecordsResponse": { "type": "object", "properties": { "changeId": { "type": "string" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1DeleteAWSVpcEndpointRequest": { "type": "object", "properties": { "endpointId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1DeleteAliCloudDNSPrivateHostedZoneRequest": { "type": "object", "properties": { "hostedZoneId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1DeleteAliCloudDNSPrivateHostedZoneResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1DeleteAliCloudDNSRecordRequest": { "type": "object", "properties": { "recordId": { "type": "string", "format": "int64" } } }, "regionalserverlessv1DeleteAliCloudVpcEndpointRequest": { "type": "object", "properties": { "endpointId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1DeleteMSKVPCConnectionRequest": { "type": "object", "properties": { "mskVpcConnectionArn": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" }, "kubernetes": { "type": "string" } } }, "regionalserverlessv1DeleteMSKVPCConnectionResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1DeleteVpcEndpointRequest": { "type": "object", "properties": { "endpointId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1DescribeAWSVpcEndpointRequest": { "type": "object", "properties": { "endpointId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1DescribeAWSVpcEndpointResponse": { "type": "object", "properties": { "endpoint": { "$ref": "#/definitions/v1AWSVpcEndpoint" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1DescribeAliCloudVpcEndpointRequest": { "type": "object", "properties": { "endpointId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1DescribeAliCloudVpcEndpointResponse": { "type": "object", "properties": { "endpoint": { "$ref": "#/definitions/v1AliCloudVpcEndpoint" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1DescribeVpcEndpointRequest": { "type": "object", "properties": { "endpointId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1DescribeVpcEndpointResponse": { "type": "object", "properties": { "endpointDetails": { "$ref": "#/definitions/v1VpcEndpointDetails" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1DetachVpcFromAliCloudDNSPrivateHostedZoneRequest": { "type": "object", "properties": { "hostedZoneId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1DetachVpcFromAliCloudDNSPrivateHostedZoneResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1GCSCloudStorage": { "type": "object", "properties": { "authType": { "$ref": "#/definitions/v1GCSCloudStorageAuthType" }, "serviceAccountKey": { "type": "string" } } }, "regionalserverlessv1GetAWSRoute53ChangeRequest": { "type": "object", "properties": { "changeId": { "type": "string" } } }, "regionalserverlessv1GetAWSRoute53ChangeResponse": { "type": "object", "properties": { "changeId": { "type": "string" }, "state": { "$ref": "#/definitions/v1Route53ChangeStateEnum" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1GetMSKVPCConnectionRequest": { "type": "object", "properties": { "mskVpcConnectionArn": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" }, "kubernetes": { "type": "string" } } }, "regionalserverlessv1GetMSKVPCConnectionResponse": { "type": "object", "properties": { "mskVpcConnection": { "$ref": "#/definitions/v1MSKVpcConnection" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1GetZoneIdsRequest": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" }, "kubernetes": { "type": "string" } } }, "regionalserverlessv1GetZoneIdsResponse": { "type": "object", "properties": { "zoneIds": { "type": "array", "items": { "type": "string" } }, "baseResp": { "$ref": "#/definitions/v1BaseResp" }, "accountId": { "type": "string" } } }, "regionalserverlessv1ListAliCloudVpcEndpointZonesRequest": { "type": "object", "properties": { "endpointId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1ListAliCloudVpcEndpointZonesResponse": { "type": "object", "properties": { "zones": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1AliCloudVpcEndpointZone" } }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1ListVpcEndpointZonesRequest": { "type": "object", "properties": { "endpointId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1ListVpcEndpointZonesResponse": { "type": "object", "properties": { "zones": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1VpcEndpointZone" } }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1OSSCloudStorage": { "type": "object", "properties": { "authType": { "$ref": "#/definitions/v1OSSCloudStorageAuthType" }, "roleArn": { "title": "The role arn", "allOf": [ { "$ref": "#/definitions/v1OSSCloudStorageRoleArn" } ] }, "accessKey": { "title": "The access key to access OSS", "allOf": [ { "$ref": "#/definitions/regionalserverlessv1OSSCloudStorageAccessKey" } ] } } }, "regionalserverlessv1OSSCloudStorageAccessKey": { "type": "object", "properties": { "accessKeyId": { "type": "string", "title": "The access key ID to access OSS" }, "accessKeySecret": { "type": "string", "title": "The access key secret to access OSS" } } }, "regionalserverlessv1PrecheckRequest": { "type": "object", "properties": { "cloudStorage": { "$ref": "#/definitions/regionalserverlessv1CloudStorage" }, "dbCredential": { "$ref": "#/definitions/v1DatabaseCredential" }, "fileRouteRules": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1FileRouteRule" } }, "useCustomFileMapping": { "type": "boolean" } } }, "regionalserverlessv1PrecheckResponse": { "type": "object", "properties": { "tableResults": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1TableResult" } }, "status": { "$ref": "#/definitions/v1ImportPrecheckStatus" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "regionalserverlessv1Region": { "type": "object", "properties": { "name": { "type": "string" }, "displayName": { "type": "string" }, "cloudProvider": { "$ref": "#/definitions/regionalserverlessv1CloudProvider" } }, "title": "TODO: move to base definition" }, "regionalserverlessv1RemoveAliCloudZoneFromVpcEndpointRequest": { "type": "object", "properties": { "endpointId": { "type": "string" }, "zoneId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1RemoveZoneFromVpcEndpointRequest": { "type": "object", "properties": { "endpointId": { "type": "string" }, "zoneId": { "type": "string" }, "projectId": { "type": "string", "format": "uint64" }, "clusterId": { "type": "string" } } }, "regionalserverlessv1S3CloudStorage": { "type": "object", "properties": { "authType": { "$ref": "#/definitions/v1S3CloudStorageAuthType" }, "roleArn": { "title": "The role arn", "allOf": [ { "$ref": "#/definitions/v1S3CloudStorageRoleArn" } ] }, "accessKey": { "description": "The access key.", "allOf": [ { "$ref": "#/definitions/regionalserverlessv1S3CloudStorageAccessKey" } ] } } }, "regionalserverlessv1S3CloudStorageAccessKey": { "type": "object", "properties": { "accessKeyId": { "type": "string", "title": "The access key ID to access S3" }, "secretAccessKey": { "type": "string", "title": "The secret access key to access S3" } } }, "serverlessv1ClusterState": { "type": "string", "enum": [ "CLUSTER_STATE_READY", "CLUSTER_STATE_CREATING", "CLUSTER_STATE_DELETING", "CLUSTER_STATE_DELETED" ], "description": "- CLUSTER_STATE_READY: The cluster can be accessed only when it is `READY`", "title": "These is the regional related cluster status info, not the same with global\ndefinition" }, "serverlessv1Endpoints": { "type": "object", "properties": { "public": { "$ref": "#/definitions/serverlessv1PublicEndpoint" }, "private": { "$ref": "#/definitions/v1PrivateEndpoint" } } }, "serverlessv1PublicEndpoint": { "type": "object", "properties": { "host": { "type": "string" }, "port": { "type": "string", "format": "int64" }, "disabled": { "type": "boolean" }, "authorizedNetwork": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1PublicEndpointAuthorizedNetwork" } } }, "title": "TODO: move to base definition" }, "serverlessv1Table": { "type": "object", "properties": { "schema": { "type": "string" }, "table": { "type": "string" } } }, "v1AWSVpcEndpoint": { "type": "object", "properties": { "endpointId": { "type": "string" }, "endpointServiceName": { "type": "string" }, "endpointServiceRegion": { "type": "string" }, "state": { "$ref": "#/definitions/v1AWSVpcEndpointStateEnum" }, "vpcId": { "type": "string" }, "createTs": { "type": "string", "format": "int64" }, "domains": { "type": "array", "items": { "type": "string" } }, "failureMessage": { "type": "string" }, "availableZones": { "type": "object", "additionalProperties": { "type": "string" }, "title": "A map of availability zone ID to availability zone name" } } }, "v1AWSVpcEndpointStateEnum": { "type": "string", "enum": [ "PENDING", "PENDING_ACCEPTANCE", "REJECTED", "EXPIRED", "FAILED", "DELETED", "DELETING", "AVAILABLE" ] }, "v1AliCloudVpcEndpoint": { "type": "object", "properties": { "endpointId": { "type": "string" }, "endpointServiceName": { "type": "string" }, "state": { "$ref": "#/definitions/v1AliCloudVpcEndpointStateEnum" }, "connectionState": { "$ref": "#/definitions/v1AliCloudVpcEndpointConnectionStateEnum" }, "vpcId": { "type": "string" }, "createTs": { "type": "string", "format": "int64" }, "domain": { "type": "string" } } }, "v1AliCloudVpcEndpointConnectionStateEnum": { "type": "string", "enum": [ "CONNECTING", "PENDING", "CONNECTED", "DISCONNECTED", "DISCONNECTING", "DELETING" ] }, "v1AliCloudVpcEndpointStateEnum": { "type": "string", "enum": [ "PENDING", "CREATING", "ACTIVE", "DELETING" ] }, "v1AliCloudVpcEndpointZone": { "type": "object", "properties": { "zoneId": { "type": "string" }, "zoneStatus": { "type": "string", "title": "The state of the zone (e.g. Creating, Wait, Connected, Deleting, Disconnecting, Disconnected, Connecting)" } } }, "v1AlicloudPrivateEndpoint": { "type": "object", "properties": { "serviceName": { "type": "string" }, "availabilityZone": { "type": "array", "items": { "type": "string" } } } }, "v1AwsPrivateEndpoint": { "type": "object", "properties": { "serviceName": { "type": "string" }, "availabilityZone": { "type": "array", "items": { "type": "string" } } }, "title": "TODO: move to base definition" }, "v1AzureBlobCloudStorageAuthType": { "type": "string", "enum": [ "SAS_TOKEN" ], "title": "- SAS_TOKEN: Use SAS token to access Azure Blob Storage" }, "v1BaseResp": { "type": "object", "properties": { "errCode": { "type": "string", "format": "int64" }, "errMsg": { "type": "string" } } }, "v1DMPrecheck": { "type": "object", "properties": { "sources": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/DMPrecheckSource" } }, "targetDb": { "$ref": "#/definitions/DMPrecheckTargetDatabase" }, "mode": { "$ref": "#/definitions/DMPrecheckTaskMode" }, "fullInstanceMigration": { "type": "boolean" }, "item": { "$ref": "#/definitions/v1DMPrecheckPrecheckItem" } } }, "v1DMPrecheckPrecheckItem": { "type": "string", "enum": [ "PRECHECK_ITEM_DUMP_PRIVILEGE_CHECKING", "PRECHECK_ITEM_REPLICATION_PRIVILEGE_CHECKING", "PRECHECK_ITEM_VERSION_CHECKING", "PRECHECK_ITEM_SERVER_ID_CHECKING", "PRECHECK_ITEM_BINLOG_ENABLE_CHECKING", "PRECHECK_ITEM_BINLOG_FORMAT_CHECKING", "PRECHECK_ITEM_BINLOG_ROW_IMAGE_CHECKING", "PRECHECK_ITEM_TABLE_SCHEMA_CHECKING", "PRECHECK_ITEM_BINLOG_DB_CHECKING", "PRECHECK_ITEM_CONN_NUMBER_CHECKING", "PRECHECK_ITEM_TARGET_DB_PRIVILEGE_CHECKING", "PRECHECK_ITEM_META_POSITION_CHECKING", "PRECHECK_ITEM_PRIMARY_KEY_CHECKING" ] }, "v1DatabaseCredential": { "type": "object", "properties": { "userName": { "type": "string" }, "credential": { "type": "string", "title": "password or auth token" } } }, "v1DeleteAWSVpcEndpointResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "v1DeleteAliCloudDNSRecordResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "v1DeleteAliCloudVpcEndpointResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "v1DeleteVpcEndpointResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "v1FileRouteRule": { "type": "object", "properties": { "pattern": { "type": "string" }, "schema": { "type": "string" }, "table": { "type": "string" }, "type": { "type": "string" } } }, "v1GCSCloudStorageAuthType": { "type": "string", "enum": [ "SERVICE_ACCOUNT_KEY" ], "title": "- SERVICE_ACCOUNT_KEY: Use service account key to access GCS" }, "v1GcpPrivateEndpoint": { "type": "object", "properties": { "targetServiceAttachment": { "type": "string" }, "availabilityZone": { "type": "string" } } }, "v1ImportPrecheckStatus": { "type": "string", "enum": [ "COMPLETED", "TIMEOUT", "TRUNCATED" ], "description": " - COMPLETED: The precheck is completed.\n - TIMEOUT: The precheck is timeout and return partial result.\n - TRUNCATED: The precheck result is truncated." }, "v1MSKVpcConnection": { "type": "object", "properties": { "mskArn": { "type": "string" }, "mskVpcConnectionArn": { "type": "string" }, "state": { "$ref": "#/definitions/v1MSKVpcConnectionStateEnum" }, "bootstrapBroker": { "type": "string" }, "availableZones": { "type": "object", "additionalProperties": { "type": "string" }, "title": "A map of availability zone ID to availability zone name" } } }, "v1MSKVpcConnectionStateEnum": { "type": "string", "enum": [ "CREATING", "AVAILABLE", "INACTIVE", "DEACTIVATING", "DELETING", "FAILED", "REJECTED", "REJECTING" ] }, "v1OSSCloudStorageAuthType": { "type": "string", "enum": [ "ROLE_ARN", "ACCESS_KEY" ], "title": "- ROLE_ARN: Use role ARN to access OSS\n - ACCESS_KEY: Use access key and secret access key to access OSS" }, "v1OSSCloudStorageRoleArn": { "type": "object", "properties": { "roleArn": { "type": "string", "title": "The role ARN to access OSS" }, "externalId": { "type": "string", "title": "The external ID to access OSS" } } }, "v1PrivateEndpoint": { "type": "object", "properties": { "host": { "type": "string" }, "port": { "type": "string", "format": "int64" }, "disabled": { "type": "boolean" }, "cloudProvider": { "title": "TODO: TBD: this field is redundant with the cluster's, remove it ?", "allOf": [ { "$ref": "#/definitions/regionalserverlessv1CloudProvider" } ] }, "aws": { "$ref": "#/definitions/v1AwsPrivateEndpoint" }, "gcp": { "$ref": "#/definitions/v1GcpPrivateEndpoint" }, "alicloud": { "title": "AzurePrivateEndpoint azure = 7;", "allOf": [ { "$ref": "#/definitions/v1AlicloudPrivateEndpoint" } ] }, "authorizedNetwork": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1PrivateEndpointAuthorizedNetwork" } } } }, "v1PrivateEndpointAuthorizedNetwork": { "type": "object", "properties": { "vpcEndpointId": { "type": "string" }, "displayName": { "type": "string" } } }, "v1PublicEndpointAuthorizedNetwork": { "type": "object", "properties": { "startIpAddress": { "type": "string" }, "endIpAddress": { "type": "string" }, "displayName": { "type": "string" } } }, "v1RemoveAliCloudZoneFromVpcEndpointResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "v1RemoveZoneFromVpcEndpointResponse": { "type": "object", "properties": { "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "v1Route53ChangeStateEnum": { "type": "string", "enum": [ "PENDING", "INSYNC" ] }, "v1S3CloudStorageAuthType": { "type": "string", "enum": [ "ROLE_ARN", "ACCESS_KEY" ], "title": "- ROLE_ARN: Use role ARN to access S3\n - ACCESS_KEY: Use access key and secret access key to access S3" }, "v1S3CloudStorageRoleArn": { "type": "object", "properties": { "roleArn": { "type": "string", "title": "The role ARN to access S3" }, "externalId": { "type": "string", "title": "The external ID to access S3" } } }, "v1S3CompatibleCloudStorage": { "type": "object", "properties": { "authType": { "$ref": "#/definitions/v1S3CompatibleCloudStorageAuthType" }, "accessKey": { "title": "The access key to access S3 compatible storage", "allOf": [ { "$ref": "#/definitions/v1S3CompatibleCloudStorageAccessKey" } ] }, "endpoint": { "type": "string", "title": "The endpoint of the S3 compatible storage" } } }, "v1S3CompatibleCloudStorageAccessKey": { "type": "object", "properties": { "accessKeyId": { "type": "string", "title": "The access key ID to access S3 compatible storage" }, "secretAccessKey": { "type": "string", "title": "The secret access key to access S3 compatible storage" } } }, "v1S3CompatibleCloudStorageAuthType": { "type": "string", "enum": [ "ACCESS_KEY" ], "title": "- ACCESS_KEY: Use access key and secret access key to access S3 compatible storage" }, "v1ServerlessDMRegionalServicePrecheckRequest": { "type": "object", "properties": { "dmPrecheck": { "$ref": "#/definitions/v1DMPrecheck" } } }, "v1ServerlessDMRegionalServicePrecheckResponse": { "type": "object", "properties": { "result": { "type": "string", "format": "byte" }, "baseResp": { "$ref": "#/definitions/v1BaseResp" } } }, "v1ServerlessRegionalServiceClusterInfo": { "type": "object", "properties": { "clusterId": { "type": "string", "title": "The cluster-id should equal to the request one" }, "createTs": { "type": "string", "format": "int64", "title": "The creating request timestamp" }, "createdTs": { "type": "string", "format": "int64", "title": "The creating finished timestamp" }, "deleteTs": { "type": "string", "format": "int64", "title": "The deleting request timestamp" }, "updatedTs": { "type": "string", "format": "int64", "title": "The most recent status updated timestamp" }, "tenantId": { "type": "string", "format": "uint64" }, "projectId": { "type": "string", "format": "uint64" }, "version": { "type": "string", "title": "The cluster version" }, "region": { "title": "The cluster region", "allOf": [ { "$ref": "#/definitions/regionalserverlessv1Region" } ] }, "endpoints": { "title": "The cluster endpoints", "allOf": [ { "$ref": "#/definitions/serverlessv1Endpoints" } ] }, "state": { "$ref": "#/definitions/serverlessv1ClusterState" }, "userPrefix": { "type": "string" }, "proxyEndpoint": { "type": "string" }, "tokenBasedAuthEnabled": { "type": "boolean" }, "enhancedEncryptionEnabled": { "type": "boolean" }, "restoreCluster": { "type": "boolean" }, "zoneRedundantEnabled": { "type": "boolean" }, "kubernetes": { "type": "string" }, "providerType": { "type": "string" }, "auditLogConfig": { "$ref": "#/definitions/v1ServerlessRegionalServiceClusterInfoAuditLogConfig" }, "keyspaceId": { "type": "integer", "format": "int64" }, "annotations": { "type": "object", "additionalProperties": { "type": "string" }, "title": "The underlying regional cluster annotations, originally from the cluster cr" }, "autoScaling": { "$ref": "#/definitions/v1ServerlessRegionalServiceClusterInfoAutoScaling" } } }, "v1ServerlessRegionalServiceClusterInfoAuditLogConfig": { "type": "object", "properties": { "enabled": { "type": "boolean", "x-nullable": true }, "unredacted": { "type": "boolean", "x-nullable": true }, "cloudStorage": { "$ref": "#/definitions/regionalserverlessv1CloudStorage" }, "rotationIntervalSeconds": { "type": "string", "format": "int64", "x-nullable": true, "title": "The rotation interval in seconds" }, "rotationSizeBytes": { "type": "string", "format": "int64", "x-nullable": true, "title": "The rotation size in bytes" } } }, "v1ServerlessRegionalServiceClusterInfoAutoScaling": { "type": "object", "properties": { "minRcu": { "type": "integer", "format": "int64" }, "maxRcu": { "type": "integer", "format": "int64" } } }, "v1ServerlessRegionalServiceCreateClusterBody": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uint64" }, "tenantId": { "type": "string", "format": "uint64" }, "endpoints": { "$ref": "#/definitions/serverlessv1Endpoints" }, "enhancedEncryptionEnabled": { "type": "boolean" }, "restoreCluster": { "type": "boolean" }, "zoneRedundantEnabled": { "type": "boolean" }, "auditLogConfig": { "$ref": "#/definitions/v1ServerlessRegionalServiceClusterInfoAuditLogConfig" }, "kubernetes": { "type": "string" }, "autoScaling": { "$ref": "#/definitions/v1ServerlessRegionalServiceClusterInfoAutoScaling" }, "annotations": { "type": "object", "additionalProperties": { "type": "string" } } } }, "v1ServerlessRegionalServiceCreateClusterResponse": { "type": "object", "properties": { "cluster": { "$ref": "#/definitions/v1ServerlessRegionalServiceClusterInfo" } } }, "v1ServerlessRegionalServiceDeleteClusterResponse": { "type": "object", "properties": { "cluster": { "$ref": "#/definitions/v1ServerlessRegionalServiceClusterInfo" } }, "title": "TODO: TBD: use nested style?" }, "v1ServerlessRegionalServiceDescRegionResponse": { "type": "object", "properties": { "name": { "type": "string", "title": "TODO: TBD: use nested style?\nRegion region = 1;" }, "displayName": { "type": "string" }, "cloudProvider": { "$ref": "#/definitions/regionalserverlessv1CloudProvider" } } }, "v1ServerlessRegionalServiceGetClusterResponse": { "type": "object", "properties": { "cluster": { "$ref": "#/definitions/v1ServerlessRegionalServiceClusterInfo" } }, "title": "TODO: TBD: use nested style?\nSame as CreateClusterResponse" }, "v1ServerlessRegionalServiceListClustersResponse": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1ServerlessRegionalServiceClusterInfo" } } } }, "v1ServerlessRegionalServiceUpdateClusterBody": { "type": "object", "properties": { "endpoints": { "$ref": "#/definitions/serverlessv1Endpoints" }, "projectId": { "type": "string", "format": "uint64" }, "annotations": { "type": "object", "additionalProperties": { "type": "string" } }, "auditLogConfig": { "$ref": "#/definitions/v1ServerlessRegionalServiceClusterInfoAuditLogConfig" }, "autoScaling": { "$ref": "#/definitions/v1ServerlessRegionalServiceClusterInfoAutoScaling" } }, "title": "TODO: TBD: use nested style?" }, "v1ServerlessRegionalServiceUpdateClusterResponse": { "type": "object", "properties": { "cluster": { "$ref": "#/definitions/v1ServerlessRegionalServiceClusterInfo" } } }, "v1TableResult": { "type": "object", "properties": { "dataFiles": { "type": "array", "items": { "type": "string" } }, "schemaFile": { "type": "string" }, "table": { "$ref": "#/definitions/serverlessv1Table" }, "errorMsg": { "type": "string" }, "useSchemaFile": { "type": "boolean", "title": "If true, the schema_file is used to create the table" } } }, "v1VpcEndpointDetails": { "type": "object", "properties": { "endpointId": { "type": "string" }, "serviceName": { "type": "string" }, "state": { "$ref": "#/definitions/v1VpcEndpointState" }, "vpcId": { "type": "string" }, "creationTimestamp": { "type": "string" }, "domain": { "type": "string" }, "type": { "$ref": "#/definitions/VpcEndpointDetailsProviderType" }, "alicloud": { "$ref": "#/definitions/VpcEndpointDetailsAlicloudDetail" } } }, "v1VpcEndpointState": { "type": "string", "enum": [ "VPC_ENDPOINT_STATE_NOT_READY", "VPC_ENDPOINT_STATE_ACTIVE", "VPC_ENDPOINT_STATE_DELETED", "VPC_ENDPOINT_STATE_FAILED", "VPC_ENDPOINT_STATE_PENDING_APPROVE", "VPC_ENDPOINT_STATE_NOT_CONNECTED" ], "description": "VpcEndpointState represents the lifecycle state of a VPC endpoint.\n\n - VPC_ENDPOINT_STATE_NOT_READY: The endpoint is being created or configured. Users should continue polling until it becomes Active.\n - VPC_ENDPOINT_STATE_ACTIVE: The endpoint is ready and can be used by users.\n - VPC_ENDPOINT_STATE_DELETED: The endpoint has been successfully deleted.\n - VPC_ENDPOINT_STATE_FAILED: The endpoint is in an unrecoverable state. Users need to create a new endpoint.\n - VPC_ENDPOINT_STATE_PENDING_APPROVE: The endpoint is pending approval.\n - VPC_ENDPOINT_STATE_NOT_CONNECTED: The endpoint is not connected." }, "v1VpcEndpointZone": { "type": "object", "properties": { "zoneId": { "type": "string" }, "zoneStatus": { "type": "string", "title": "The state of the zone (e.g. Creating, Wait, Connected, Deleting, Disconnecting, Disconnected, Connecting)" } }, "title": "Details of a VPC endpoint zone" } }, "externalDocs": { "description": "TODO: Add description", "url": "TODO: Add URL" } }