{ "swagger": "2.0", "info": { "title": "TiDB Cloud Premium API", "description": "TiDB Cloud Premium API", "version": "v1beta2" }, "tags": [ { "name": "DatabaseAuditLogService" } ], "host": "cloud.tidbapi.com", "basePath": "/api/v2025/cloud/v1beta2", "schemes": ["https"], "consumes": ["application/json"], "produces": ["application/json"], "paths": { "/api/v2025/cloud/v1beta2/tidbs/{tidbId}/auditLogFilterRules": { "get": { "summary": "List audit log filter rules", "description": "Lists all database audit log filter rules for a specific TiDB Cloud Premium instance.", "operationId": "DatabaseAuditLogService_ListAuditLogFilterRules", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/nextgenv1beta2ListAuditLogFilterRulesResponse" } }, "400": { "description": "A request field is invalid.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "401": { "description": "The API key cannot be authenticated.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "403": { "description": "The API key does not have permission to access the resource.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "429": { "description": "You have exceeded the rate limit.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "tidbId", "in": "path", "required": true, "type": "string" }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageToken", "in": "query", "required": false, "type": "string" }, { "name": "skip", "description": "The number of individual resources to skip before starting to return results.\nIf the skip value causes the cursor to move past the end of the collection,\nthe response will be 200 OK with an empty result set and no next_page_token.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": ["DatabaseAuditLogService"] }, "post": { "summary": "Create an audit log filter rule", "description": "Creates a new database audit log filter rule for a specific TiDB Cloud Premium instance.", "operationId": "DatabaseAuditLogService_CreateAuditLogFilterRule", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/nextgenv1beta2AuditLogFilterRule" } }, "400": { "description": "A request field is invalid.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "401": { "description": "The API key cannot be authenticated.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "403": { "description": "The API key does not have permission to access the resource.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "429": { "description": "You have exceeded the rate limit.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "tidbId", "in": "path", "required": true, "type": "string" }, { "name": "auditLogFilterRule", "in": "body", "required": true, "schema": { "$ref": "#/definitions/nextgenv1beta2AuditLogFilterRule" } }, { "name": "validateOnly", "in": "query", "required": false, "type": "boolean" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": ["DatabaseAuditLogService"] } }, "/api/v2025/cloud/v1beta2/tidbs/{tidbId}/auditLogFilterRules/{auditLogFilterRuleId}": { "get": { "summary": "Get an audit log filter rule", "description": "Retrieves details of a specific database audit log filter rule.", "operationId": "DatabaseAuditLogService_GetAuditLogFilterRule", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/nextgenv1beta2AuditLogFilterRule" } }, "400": { "description": "A request field is invalid.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "401": { "description": "The API key cannot be authenticated.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "403": { "description": "The API key does not have permission to access the resource.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "429": { "description": "You have exceeded the rate limit.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "tidbId", "in": "path", "required": true, "type": "string" }, { "name": "auditLogFilterRuleId", "description": "audit_log_filter_rule_id is a unique identifier for the rule. Currently, the value is the same as user_expr.\nFor legacy, the audit_log_filter_rule_id is a number.", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": ["DatabaseAuditLogService"] }, "delete": { "summary": "Delete an audit log filter rule", "description": "Deletes a database audit log filter rule from a specific TiDB Cloud Premium instance.", "operationId": "DatabaseAuditLogService_DeleteAuditLogFilterRule", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "400": { "description": "A request field is invalid.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "401": { "description": "The API key cannot be authenticated.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "403": { "description": "The API key does not have permission to access the resource.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "429": { "description": "You have exceeded the rate limit.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "tidbId", "in": "path", "required": true, "type": "string" }, { "name": "auditLogFilterRuleId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": ["DatabaseAuditLogService"] }, "patch": { "summary": "Update an audit log filter rule", "description": "Updates an existing database audit log filter rule for a specific TiDB Cloud Premium instance.", "operationId": "DatabaseAuditLogService_UpdateAuditLogFilterRule", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/nextgenv1beta2AuditLogFilterRule" } }, "400": { "description": "A request field is invalid.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "401": { "description": "The API key cannot be authenticated.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "403": { "description": "The API key does not have permission to access the resource.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "429": { "description": "You have exceeded the rate limit.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "tidbId", "in": "path", "required": true, "type": "string" }, { "name": "auditLogFilterRuleId", "description": "The ID of the audit log filter rule to update.", "in": "path", "required": true, "type": "string" }, { "name": "auditLogFilterRule", "in": "body", "required": true, "schema": { "$ref": "#/definitions/nextgenv1beta2AuditLogFilterRule" } }, { "name": "validateOnly", "in": "query", "required": false, "type": "boolean" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": ["DatabaseAuditLogService"] } }, "/api/v2025/cloud/v1beta2/tidbs/{tidbId}/auditLogSetting": { "get": { "summary": "Get audit log setting", "description": "Retrieves the database audit log setting for a specific TiDB Cloud Premium instance.", "operationId": "DatabaseAuditLogService_GetAuditLogSetting", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/nextgenv1beta2AuditLogSetting" } }, "400": { "description": "A request field is invalid.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "401": { "description": "The API key cannot be authenticated.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "403": { "description": "The API key does not have permission to access the resource.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "429": { "description": "You have exceeded the rate limit.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "tidbId", "in": "path", "required": true, "type": "string" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": ["DatabaseAuditLogService"] }, "patch": { "summary": "Update audit log setting", "description": "Updates the database audit log setting for a specific TiDB Cloud Premium instance.", "operationId": "DatabaseAuditLogService_UpdateAuditLogSetting", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/nextgenv1beta2AuditLogSetting" } }, "400": { "description": "A request field is invalid.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "401": { "description": "The API key cannot be authenticated.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "403": { "description": "The API key does not have permission to access the resource.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "429": { "description": "You have exceeded the rate limit.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/googlerpcStatus" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "tidbId", "in": "path", "required": true, "type": "string" }, { "name": "auditLogSetting", "in": "body", "required": true, "schema": { "$ref": "#/definitions/nextgenv1beta2AuditLogSetting" } }, { "name": "validateOnly", "in": "query", "required": false, "type": "boolean" }, { "name": "orgId", "description": "Organization id", "in": "query", "required": true, "type": "string", "format": "uint64" }, { "name": "projectId", "description": "Project id", "in": "query", "required": true, "type": "string", "format": "uint64" } ], "tags": ["DatabaseAuditLogService"] } } }, "definitions": { "AuditLogSettingStorageSetting": { "type": "object", "properties": { "bucketRegionId": { "type": "string", "title": "Format: {cloud_provider}-{region_code}" }, "bucketUri": { "type": "string" }, "cloudRoleIdentity": { "description": "aws role arn, gcp serviceaccount, or azure SAS token.\nLeave empty(not nil) on Azure to use the kubelet identity instead of SAS token auth.", "type": "string", "x-nullable": true } }, "required": ["bucketUri", "bucketRegionId"] }, "googlerpcStatus": { "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).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].", "type": "integer", "format": "int32" }, "details": { "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { "$ref": "#/definitions/protobufAny", "type": "object" } }, "message": { "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.", "type": "string" } } }, "nextgenv1beta2AuditLogFilterRule": { "type": "object", "properties": { "auditLogFilterRuleId": { "type": "string", "readOnly": true }, "disabled": { "description": "Default is enabled.", "type": "boolean", "x-nullable": true }, "displayName": { "description": "If not set, default to the value of `user_expr`.", "type": "string", "x-nullable": true }, "eventTypes": { "type": "array", "items": { "$ref": "#/definitions/nextgenv1beta2AuditLogFilterRuleEventType" } }, "name": { "type": "string", "readOnly": true, "title": "Format: tidbs/{tidb_id}/auditLogFilterRules/{audit_log_filter_rule_id}" }, "tables": { "description": "If empty, it means all tables.", "type": "array", "items": { "type": "string" } }, "tidbId": { "type": "string", "readOnly": true }, "userExpr": { "description": "Format: @.\nThe audit user @ consists of the username and hostname with @ as separator, where @ and are optional.\nBoth username and hostname can be identifiers with wildcards:\n - % for matching any username/hostname.\n - _ for matching any character.\nFor multiple filter rules, if their user_expr fields match the same username, that matches the longest username takes effect.\nIn general, this field is required.", "type": "string", "x-nullable": true } } }, "nextgenv1beta2AuditLogFilterRuleEventType": { "type": "string", "enum": [ "CONNECTION", "CONNECT", "DISCONNECT", "CHANGE_USER", "QUERY", "TRANSACTION", "EXECUTE", "QUERY_DML", "INSERT", "REPLACE", "UPDATE", "DELETE", "LOAD_DATA", "SELECT", "QUERY_DDL", "ALL_EVENTS" ], "title": "DB audit logging includes the following event types:\n - CONNECTION\n - CONNECT\n - DISCONNECT\n - CHANGE_USER\n - QUERY\n - TRANSACTION\n - EXECUTE\n - QUERY_DML\n - INSERT\n - REPLACE\n - UPDATE\n - DELETE\n - LOAD DATA\n - SELECT\n - QUERY_DDL" }, "nextgenv1beta2AuditLogSetting": { "type": "object", "properties": { "bucketWriteCheck": { "allOf": [ { "$ref": "#/definitions/v1beta2AuditLogSettingBucketWriteCheck" } ], "readOnly": true }, "enabled": { "description": "Default is disabled.", "type": "boolean", "x-nullable": true }, "format": { "$ref": "#/definitions/v1beta2AuditLogSettingFormat" }, "name": { "type": "string", "readOnly": true, "title": "Format: tidbs/{tidb_id}/auditLogSetting" }, "rotationPolicy": { "$ref": "#/definitions/v1beta2AuditLogSettingRotationPolicy" }, "storageSetting": { "$ref": "#/definitions/AuditLogSettingStorageSetting" }, "tidbId": { "type": "string", "readOnly": true }, "unredacted": { "type": "boolean", "x-nullable": true } } }, "nextgenv1beta2ListAuditLogFilterRulesResponse": { "type": "object", "properties": { "auditLogFilterRules": { "type": "array", "items": { "$ref": "#/definitions/nextgenv1beta2AuditLogFilterRule", "type": "object" } }, "nextPageToken": { "type": "string" }, "totalSize": { "type": "integer", "format": "int32" } } }, "protobufAny": { "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(&foo)) {\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 := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.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\": ,\n \"lastName\": \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 }", "type": "object", "additionalProperties": {}, "properties": { "@type": { "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.", "type": "string" } } }, "v1beta2AuditLogSettingBucketWriteCheck": { "type": "object", "properties": { "errorReason": { "description": "The reason why the bucket is not writable. Output only when `writable` is false.", "type": "string", "readOnly": true }, "writable": { "type": "boolean", "readOnly": true } } }, "v1beta2AuditLogSettingFormat": { "type": "string", "enum": ["TEXT", "JSON"] }, "v1beta2AuditLogSettingRotationPolicy": { "type": "object", "properties": { "maxAgeSecond": { "description": "Set the time limitation for audit logs. A log rotation is triggered if the log file exceeds this limitation.\nSetting this variable to 0 means to disable automatic log rotation by time.", "type": "integer", "format": "int32", "default": "86400", "maximum": 2592000, "x-nullable": true }, "maxSizeMib": { "description": "Set the file size limitation for audit logs. A log rotation is triggered if the log file exceeds this limitation.\nIn the current version, If you set this variable to 0, TiDB automatically changes it to 10.", "type": "integer", "format": "int32", "default": "10", "maximum": 100, "minimum": 1 } } } } }