Managed Service for ClickHouse Audit Trails Events: CreateClusterExternalDictionary
Event JSON schema
{
"eventId": "string",
"eventSource": "string",
"eventType": "string",
"eventTime": "string",
"authentication": {
"authenticated": "boolean",
// Includes only one of the fields `subjectType`
"subjectType": "string",
// end of the list of possible fields
// Includes only one of the fields `subjectId`
"subjectId": "string",
// end of the list of possible fields
// Includes only one of the fields `subjectName`
"subjectName": "string",
// end of the list of possible fields
// Includes only one of the fields `federationId`
"federationId": "string",
// end of the list of possible fields
// Includes only one of the fields `federationName`
"federationName": "string",
// end of the list of possible fields
// Includes only one of the fields `federationType`
"federationType": "string",
// end of the list of possible fields
"tokenInfo": {
"maskedIamToken": "string",
// Includes only one of the fields `iamTokenId`
"iamTokenId": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorId`
"impersonatorId": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorType`
"impersonatorType": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorName`
"impersonatorName": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorFederationId`
"impersonatorFederationId": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorFederationName`
"impersonatorFederationName": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorFederationType`
"impersonatorFederationType": "string"
// end of the list of possible fields
}
},
"authorization": {
"authorized": "boolean"
},
"resourceMetadata": {
"path": [
{
"resourceType": "string",
"resourceId": "string",
// Includes only one of the fields `resourceName`
"resourceName": "string"
// end of the list of possible fields
}
]
},
"requestMetadata": {
"remoteAddress": "string",
"userAgent": "string",
"requestId": "string",
// Includes only one of the fields `remotePort`
"remotePort": "string"
// end of the list of possible fields
},
"eventStatus": "string",
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"details": {
"clusterId": "string",
"externalDictionaryName": "string",
"externalDictionary": {
"name": "string",
"structure": {
"id": {
"name": "string"
},
"key": {
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "boolean",
"injective": "boolean"
}
]
},
"rangeMin": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "boolean",
"injective": "boolean"
},
"rangeMax": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "boolean",
"injective": "boolean"
},
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "boolean",
"injective": "boolean"
}
]
},
"layout": {
"type": "string",
"sizeInCells": "string",
"allowReadExpiredKeys": "boolean",
"maxUpdateQueueSize": "string",
"updateQueuePushTimeoutMilliseconds": "string",
"queryWaitTimeoutMilliseconds": "string",
"maxThreadsForUpdates": "string",
"initialArraySize": "string",
"maxArraySize": "string",
"accessToKeyFromAttributes": "boolean"
},
// Includes only one of the fields `fixedLifetime`, `lifetimeRange`
"fixedLifetime": "string",
"lifetimeRange": {
"min": "string",
"max": "string"
},
// end of the list of possible fields
// Includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
"httpSource": {
"url": "string",
"format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
]
},
"mysqlSource": {
"db": "string",
"table": "string",
"port": "string",
"user": "string",
"password": "string",
"replicas": [
{
"host": "string",
"priority": "string",
"port": "string",
"user": "string",
"password": "string"
}
],
"where": "string",
"invalidateQuery": "string",
"closeConnection": "boolean",
"shareConnection": "boolean"
},
"clickhouseSource": {
"db": "string",
"table": "string",
"host": "string",
"port": "string",
"user": "string",
"password": "string",
"where": "string",
"secure": "boolean"
},
"mongodbSource": {
"db": "string",
"collection": "string",
"host": "string",
"port": "string",
"user": "string",
"password": "string",
"options": "string"
},
"postgresqlSource": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "string",
"user": "string",
"password": "string",
"invalidateQuery": "string",
"sslMode": "string"
}
// end of the list of possible fields
},
"clusterName": "string"
},
"requestParameters": "object",
"response": "object"
}
Field description
|
Field |
Description |
|
eventId |
string |
|
eventSource |
string |
|
eventType |
string |
|
eventTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
|
authentication |
|
|
authorization |
|
|
resourceMetadata |
|
|
requestMetadata |
|
|
eventStatus |
enum (EventStatus)
|
|
error |
The error result of the operation in case of failure or cancellation. |
|
details |
|
|
requestParameters |
object |
|
response |
object |
IamAuthentication
|
Field |
Description |
|
authenticated |
boolean |
|
subjectType |
enum (IamSubjectType) Includes only one of the fields
|
|
subjectId |
string Includes only one of the fields |
|
subjectName |
string Includes only one of the fields |
|
federationId |
string Includes only one of the fields |
|
federationName |
string Includes only one of the fields |
|
federationType |
enum (FederationType) Includes only one of the fields
|
|
tokenInfo |
IamTokenInfo
|
Field |
Description |
|
maskedIamToken |
string |
|
iamTokenId |
string Includes only one of the fields |
|
impersonatorId |
string Includes only one of the fields |
|
impersonatorType |
enum (IamSubjectType) Includes only one of the fields
|
|
impersonatorName |
string Includes only one of the fields |
|
impersonatorFederationId |
string Includes only one of the fields |
|
impersonatorFederationName |
string Includes only one of the fields |
|
impersonatorFederationType |
enum (FederationType) Includes only one of the fields
|
Authorization
|
Field |
Description |
|
authorized |
boolean |
ResourceMetadata
|
Field |
Description |
|
path[] |
Resource
|
Field |
Description |
|
resourceType |
string |
|
resourceId |
string |
|
resourceName |
string Includes only one of the fields |
RequestMetadata
|
Field |
Description |
|
remoteAddress |
string |
|
userAgent |
string |
|
requestId |
string |
|
remotePort |
string (int64) Includes only one of the fields |
Status
The error result of the operation in case of failure or cancellation.
|
Field |
Description |
|
code |
integer (int32) Error code. An enum value of google.rpc.Code |
|
message |
string An error message. |
|
details[] |
object A list of messages that carry the error details. |
ExternalDictionaryEventDetails
|
Field |
Description |
|
clusterId |
string |
|
externalDictionaryName |
string |
|
externalDictionary |
|
|
clusterName |
string |
ExternalDictionary
|
Field |
Description |
|
name |
string |
|
structure |
|
|
layout |
|
|
fixedLifetime |
string (int64) Includes only one of the fields |
|
lifetimeRange |
Includes only one of the fields |
|
httpSource |
Includes only one of the fields |
|
mysqlSource |
Includes only one of the fields |
|
clickhouseSource |
Includes only one of the fields |
|
mongodbSource |
Includes only one of the fields |
|
postgresqlSource |
Includes only one of the fields |
Structure
|
Field |
Description |
|
id |
|
|
key |
|
|
rangeMin |
|
|
rangeMax |
|
|
attributes[] |
The number of elements must be greater than 0. |
Id
|
Field |
Description |
|
name |
string |
Key
|
Field |
Description |
|
attributes[] |
The number of elements must be greater than 0. |
Attribute
|
Field |
Description |
|
name |
string |
|
type |
string |
|
nullValue |
string |
|
expression |
string |
|
hierarchical |
boolean |
|
injective |
boolean |
Layout
|
Field |
Description |
|
type |
enum (Type)
|
|
sizeInCells |
string (int64) The minimum value is 0. |
|
allowReadExpiredKeys |
boolean |
|
maxUpdateQueueSize |
string (int64) The minimum value is 0. |
|
updateQueuePushTimeoutMilliseconds |
string (int64) The minimum value is 0. |
|
queryWaitTimeoutMilliseconds |
string (int64) The minimum value is 0. |
|
maxThreadsForUpdates |
string (int64) The minimum value is 0. |
|
initialArraySize |
string (int64) The minimum value is 0. |
|
maxArraySize |
string (int64) The minimum value is 0. |
|
accessToKeyFromAttributes |
boolean |
Range
|
Field |
Description |
|
min |
string (int64) |
|
max |
string (int64) |
HttpSource
|
Field |
Description |
|
url |
string |
|
format |
string |
|
headers[] |
Header
|
Field |
Description |
|
name |
string |
|
value |
string |
MysqlSource
|
Field |
Description |
|
db |
string |
|
table |
string |
|
port |
string (int64) Acceptable values are 0 to 65535, inclusive. |
|
user |
string |
|
password |
string |
|
replicas[] |
|
|
where |
string |
|
invalidateQuery |
string |
|
closeConnection |
boolean |
|
shareConnection |
boolean |
Replica
|
Field |
Description |
|
host |
string The maximum string length in characters is 253. |
|
priority |
string (int64) The minimum value is 0. |
|
port |
string (int64) Acceptable values are 0 to 65535, inclusive. |
|
user |
string |
|
password |
string |
ClickhouseSource
|
Field |
Description |
|
db |
string |
|
table |
string |
|
host |
string The maximum string length in characters is 253. |
|
port |
string (int64) Acceptable values are 0 to 65535, inclusive. |
|
user |
string |
|
password |
string |
|
where |
string |
|
secure |
boolean |
MongodbSource
|
Field |
Description |
|
db |
string |
|
collection |
string |
|
host |
string The maximum string length in characters is 253. |
|
port |
string (int64) Acceptable values are 0 to 65535, inclusive. |
|
user |
string |
|
password |
string |
|
options |
string |
PostgresqlSource
|
Field |
Description |
|
db |
string |
|
table |
string |
|
hosts[] |
string |
|
port |
string (int64) Acceptable values are 0 to 65535, inclusive. |
|
user |
string |
|
password |
string |
|
invalidateQuery |
string |
|
sslMode |
enum (SslMode)
|