Managed Service for Trino API, REST: Cluster.Get
- HTTP request
- Path parameters
- Response
- Monitoring
- TrinoConfig
- CoordinatorConfig
- Resources
- WorkerConfig
- WorkerScalePolicy
- FixedScalePolicy
- AutoScalePolicy
- RetryPolicyConfig
- ExchangeManagerConfig
- ExchangeManagerStorage
- AccessControlConfig
- CatalogAccessRule
- CatalogAccessRuleMatcher
- CatalogIds
- CatalogNames
- SchemaAccessRule
- SchemaAccessRuleMatcher
- SchemaNames
- TableAccessRule
- TableAccessRuleMatcher
- TableNames
- Column
- FunctionAccessRule
- FunctionAccessRuleMatcher
- FunctionNames
- ProcedureAccessRule
- ProcedureAccessRuleMatcher
- ProcedureNames
- QueryAccessRule
- SystemSessionPropertyAccessRule
- PropertyAccessRuleMatcher
- PropertyNames
- CatalogSessionPropertyAccessRule
- ResourceManagementConfig
- ResourceGroupsConfig
- ResourceGroupConfig
- SelectorRuleConfig
- QueryConfig
- TLSConfig
- NetworkConfig
- LoggingConfig
- MaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
Returns the specified Trino Cluster resource.
HTTP request
GET https://trino.api.cloud.yandex.net/managed-trino/v1/clusters/{clusterId}
Path parameters
|
Field |
Description |
|
clusterId |
string Required field. ID of the Trino Cluster resource to return. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"trino": {
"coordinatorConfig": {
"resources": {
"resourcePresetId": "string"
}
},
"workerConfig": {
"resources": {
"resourcePresetId": "string"
},
"scalePolicy": {
// Includes only one of the fields `fixedScale`, `autoScale`
"fixedScale": {
"count": "string"
},
"autoScale": {
"minCount": "string",
"maxCount": "string"
}
// end of the list of possible fields
}
},
"version": "string",
"retryPolicy": {
"policy": "string",
"exchangeManager": {
"additionalProperties": "object",
"storage": {
// Includes only one of the fields `serviceS3`
"serviceS3": "object"
// end of the list of possible fields
}
},
"additionalProperties": "object"
},
"accessControl": {
"catalogs": [
{
"users": [
"string"
],
"groups": [
"string"
],
"catalog": {
// Includes only one of the fields `nameRegexp`, `ids`, `names`
"nameRegexp": "string",
"ids": {
"any": [
"string"
]
},
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"permission": "string",
"description": "string"
}
],
"schemas": [
{
"users": [
"string"
],
"groups": [
"string"
],
"catalog": {
// Includes only one of the fields `nameRegexp`, `ids`, `names`
"nameRegexp": "string",
"ids": {
"any": [
"string"
]
},
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"schema": {
// Includes only one of the fields `nameRegexp`, `names`
"nameRegexp": "string",
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"owner": "string",
"description": "string"
}
],
"tables": [
{
"users": [
"string"
],
"groups": [
"string"
],
"catalog": {
// Includes only one of the fields `nameRegexp`, `ids`, `names`
"nameRegexp": "string",
"ids": {
"any": [
"string"
]
},
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"schema": {
// Includes only one of the fields `nameRegexp`, `names`
"nameRegexp": "string",
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"table": {
// Includes only one of the fields `nameRegexp`, `names`
"nameRegexp": "string",
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"privileges": [
"string"
],
"columns": [
{
"name": "string",
"access": "string",
"mask": "string"
}
],
"filter": "string",
"description": "string"
}
],
"functions": [
{
"users": [
"string"
],
"groups": [
"string"
],
"catalog": {
// Includes only one of the fields `nameRegexp`, `ids`, `names`
"nameRegexp": "string",
"ids": {
"any": [
"string"
]
},
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"schema": {
// Includes only one of the fields `nameRegexp`, `names`
"nameRegexp": "string",
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"function": {
// Includes only one of the fields `nameRegexp`, `names`
"nameRegexp": "string",
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"privileges": [
"string"
],
"description": "string"
}
],
"procedures": [
{
"users": [
"string"
],
"groups": [
"string"
],
"catalog": {
// Includes only one of the fields `nameRegexp`, `ids`, `names`
"nameRegexp": "string",
"ids": {
"any": [
"string"
]
},
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"schema": {
// Includes only one of the fields `nameRegexp`, `names`
"nameRegexp": "string",
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"procedure": {
// Includes only one of the fields `nameRegexp`, `names`
"nameRegexp": "string",
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"privileges": [
"string"
],
"description": "string"
}
],
"queries": [
{
"users": [
"string"
],
"groups": [
"string"
],
"queryOwners": [
"string"
],
"privileges": [
"string"
],
"description": "string"
}
],
"systemSessionProperties": [
{
"users": [
"string"
],
"groups": [
"string"
],
"property": {
// Includes only one of the fields `nameRegexp`, `names`
"nameRegexp": "string",
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"allow": "string",
"description": "string"
}
],
"catalogSessionProperties": [
{
"users": [
"string"
],
"groups": [
"string"
],
"catalog": {
// Includes only one of the fields `nameRegexp`, `ids`, `names`
"nameRegexp": "string",
"ids": {
"any": [
"string"
]
},
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"property": {
// Includes only one of the fields `nameRegexp`, `names`
"nameRegexp": "string",
"names": {
"any": [
"string"
]
}
// end of the list of possible fields
},
"allow": "string",
"description": "string"
}
]
},
"resourceManagement": {
"resourceGroups": {
"rootGroups": [
{
"name": "string",
"maxQueued": "string",
"softConcurrencyLimit": "string",
"hardConcurrencyLimit": "string",
"softMemoryLimit": "string",
"softCpuLimit": "string",
"hardCpuLimit": "string",
"schedulingPolicy": "string",
"schedulingWeight": "string",
"subGroups": [
"object"
]
}
],
"selectors": [
{
"user": "string",
"userGroup": "string",
"source": "string",
"queryType": "string",
"clientTags": [
"string"
],
"group": "string"
}
],
"cpuQuotaPeriod": "string"
},
"query": {
"properties": "object"
}
},
"tls": {
"trustedCertificates": [
"string"
]
}
},
"health": "string",
"status": "string",
"network": {
"subnetIds": [
"string"
],
"securityGroupIds": [
"string"
]
},
"deletionProtection": "boolean",
"serviceAccountId": "string",
"logging": {
"enabled": "boolean",
// Includes only one of the fields `folderId`, `logGroupId`
"folderId": "string",
"logGroupId": "string",
// end of the list of possible fields
"minLevel": "string"
},
"coordinatorUrl": "string",
"maintenanceWindow": {
// Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": "object",
"weeklyMaintenanceWindow": {
"day": "string",
"hour": "string"
}
// end of the list of possible fields
},
"plannedOperation": {
"info": "string",
"delayedUntil": "string",
"latestMaintenanceTime": "string",
"nextMaintenanceWindowTime": "string"
}
}
Trino cluster.
|
Field |
Description |
|
id |
string Unique ID of the Trino cluster. |
|
folderId |
string ID of the folder that the Trino cluster belongs to. |
|
createdAt |
string (date-time) The time when the Trino cluster was created. String in RFC3339 To work with values in this field, use the APIs described in the |
|
name |
string Name of the Trino cluster. |
|
description |
string Description of the Trino cluster. 0-256 characters long. |
|
labels |
object (map<string, string>) Resource labels as |
|
monitoring[] |
Monitoring systems relevant to the Trino cluster. |
|
trino |
Configuration of the Trino cluster. |
|
health |
enum (Health) Aggregated cluster health.
|
|
status |
enum (Status) Cluster status.
|
|
network |
Network related configuration options. |
|
deletionProtection |
boolean Deletion Protection inhibits deletion of the cluster. |
|
serviceAccountId |
string Service account used to access Cloud resources. The maximum string length in characters is 50. |
|
logging |
Cloud logging configuration. |
|
coordinatorUrl |
string Address of Trino Coordinator. |
|
maintenanceWindow |
Window of maintenance operations. |
|
plannedOperation |
Maintenance operation planned at nearest maintenance_window. |
Monitoring
Monitoring system.
|
Field |
Description |
|
name |
string Name of the monitoring system. |
|
description |
string Description of the monitoring system. |
|
link |
string Link to the monitoring system. |
TrinoConfig
|
Field |
Description |
|
coordinatorConfig |
Required field. Configuration for the coordinator, specifying computational resources and other settings. |
|
workerConfig |
Required field. Configuration for worker nodes, including scaling policy and computational resources. |
|
version |
string Version of Trino. |
|
retryPolicy |
Configuration for retry policy, specifying the spooling storage destination and other settings. |
|
accessControl |
Configuration for access control, specifying the fine-grained rules of accesses. |
|
resourceManagement |
Configuration for resource management, specifying the resource groups and other settings. |
|
tls |
Configuration for TLS. |
CoordinatorConfig
|
Field |
Description |
|
resources |
Required field. Configuration for computational resources assigned to the coordinator instance. |
Resources
|
Field |
Description |
|
resourcePresetId |
string Required field. ID of the preset for computational resources allocated to a instance (e.g., CPU, memory, etc.). The maximum string length in characters is 50. |
WorkerConfig
|
Field |
Description |
|
resources |
Required field. Configuration for computational resources for worker instances. |
|
scalePolicy |
Required field. Configuration for scaling policy for worker instances. |
WorkerScalePolicy
|
Field |
Description |
|
fixedScale |
A fixed scaling policy that specifies a fixed number of worker instances. Includes only one of the fields Defines the scaling type for worker instances. |
|
autoScale |
A scaling policy that dynamically adjusts the number of worker instances Includes only one of the fields Defines the scaling type for worker instances. |
FixedScalePolicy
|
Field |
Description |
|
count |
string (int64) Specifies the number of worker instances. Acceptable values are 1 to 512, inclusive. |
AutoScalePolicy
|
Field |
Description |
|
minCount |
string (int64) Acceptable values are 0 to 512, inclusive. |
|
maxCount |
string (int64) Acceptable values are 1 to 512, inclusive. |
RetryPolicyConfig
|
Field |
Description |
|
policy |
enum (RetryPolicy) Retry policy level.
|
|
exchangeManager |
Configuration for exchange manager. |
|
additionalProperties |
object (map<string, string>) Additional properties. No more than 256 per resource. The maximum string length in characters for each value is 128. Each value must match the regular expression |
ExchangeManagerConfig
|
Field |
Description |
|
additionalProperties |
object (map<string, string>) Additional properties. No more than 256 per resource. The maximum string length in characters for each value is 128. Each value must match the regular expression |
|
storage |
ExchangeManagerStorage
|
Field |
Description |
|
serviceS3 |
object Use service side s3 bucket for exchange manager. Includes only one of the fields |
AccessControlConfig
|
Field |
Description |
|
catalogs[] |
Catalog access control rules. |
|
schemas[] |
Schema access control rules. |
|
tables[] |
Table access control rules. |
|
functions[] |
Function access control rules. |
|
procedures[] |
Procedures access control rules. |
|
queries[] |
Queries access control rules. |
|
systemSessionProperties[] |
SystemSessionPropertyAccessRule System session property access control rules. |
|
catalogSessionProperties[] |
CatalogSessionPropertyAccessRule Catalog session property access control rules. |
CatalogAccessRule
|
Field |
Description |
|
users[] |
string IAM user IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
groups[] |
string IAM group IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
catalog |
Catalog matcher specifying what catalogs the rule is applied to. |
|
permission |
enum (Permission) Required field. Permission granted by the rule.
|
|
description |
string Rule description. The maximum string length in characters is 128. |
CatalogAccessRuleMatcher
|
Field |
Description |
|
nameRegexp |
string Catalog name regexp the rule is applied to. The maximum string length in characters is 256. Includes only one of the fields |
|
ids |
Catalog IDs rule is applied to. Includes only one of the fields |
|
names |
Catalog names rule is applied to. Includes only one of the fields |
CatalogIds
|
Field |
Description |
|
any[] |
string The maximum number of elements is 128. The maximum string length in characters for each value is 63. |
CatalogNames
|
Field |
Description |
|
any[] |
string The maximum number of elements is 128. The maximum string length in characters for each value is 63. |
SchemaAccessRule
|
Field |
Description |
|
users[] |
string IAM user IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
groups[] |
string IAM group IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
catalog |
Catalog matcher specifying what catalogs the rule is applied to. |
|
schema |
Schema matcher specifying what schemas the rule is applied to. |
|
owner |
enum (Owner) Required field. Ownership granted by the rule.
|
|
description |
string Rule description. The maximum string length in characters is 128. |
SchemaAccessRuleMatcher
|
Field |
Description |
|
nameRegexp |
string Schema name regexp the rule is applied to. The maximum string length in characters is 256. Includes only one of the fields |
|
names |
Schema names the rule is applied to. Includes only one of the fields |
SchemaNames
|
Field |
Description |
|
any[] |
string The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
TableAccessRule
|
Field |
Description |
|
users[] |
string IAM user IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
groups[] |
string IAM group IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
catalog |
Catalog matcher specifying what catalogs the rule is applied to. |
|
schema |
Schema matcher specifying what schemas the rule is applied to. |
|
table |
Table matcher specifying what tables the rule is applied to. |
|
privileges[] |
enum (Privilege) Permission granted by the rule.
|
|
columns[] |
Column rules. |
|
filter |
string Boolean SQL expression to filter table rows for particular user. The maximum string length in characters is 128. |
|
description |
string Rule description. The maximum string length in characters is 128. |
TableAccessRuleMatcher
|
Field |
Description |
|
nameRegexp |
string Table name regexp the rule is applied to. The maximum string length in characters is 256. Includes only one of the fields |
|
names |
Table names the rule is applied to. Includes only one of the fields |
TableNames
|
Field |
Description |
|
any[] |
string The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
Column
|
Field |
Description |
|
name |
string Required field. Column name. The maximum string length in characters is 63. Value must match the regular expression |
|
access |
enum (AccessMode) Required field. Column access mode.
|
|
mask |
string SQL expression mask to evaluate instead of original column values. The maximum string length in characters is 128. |
FunctionAccessRule
|
Field |
Description |
|
users[] |
string IAM user IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
groups[] |
string IAM group IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
catalog |
Catalog matcher specifying what catalogs the rule is applied to. |
|
schema |
Schema matcher specifying what schema the rule is applied to. |
|
function |
Function matcher specifying what functions the rule is applied to. |
|
privileges[] |
enum (Privilege) Privileges granted by the rule.
|
|
description |
string Rule description. The maximum string length in characters is 128. |
FunctionAccessRuleMatcher
|
Field |
Description |
|
nameRegexp |
string Function name regexp the rule is applied to. The maximum string length in characters is 256. Includes only one of the fields |
|
names |
Function names the rule is applied to. Includes only one of the fields |
FunctionNames
|
Field |
Description |
|
any[] |
string The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
ProcedureAccessRule
|
Field |
Description |
|
users[] |
string IAM user IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
groups[] |
string IAM group IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
catalog |
Catalog matcher specifying what catalogs the rule is applied to. |
|
schema |
Schema matcher specifying what schema the rule is applied to. |
|
procedure |
Procedure matcher specifying what functions the rule is applied to. |
|
privileges[] |
enum (Privilege) Privileges granted by the rule.
|
|
description |
string Rule description. The maximum string length in characters is 128. |
ProcedureAccessRuleMatcher
|
Field |
Description |
|
nameRegexp |
string Procedure name regexp the rule is applied to. The maximum string length in characters is 256. Includes only one of the fields |
|
names |
Procedure names the rule is applied to. Includes only one of the fields |
ProcedureNames
|
Field |
Description |
|
any[] |
string The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
QueryAccessRule
|
Field |
Description |
|
users[] |
string IAM user IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
groups[] |
string IAM group IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
queryOwners[] |
string Owners of queries the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
privileges[] |
enum (Privilege) Privileges granted by the user.
|
|
description |
string Rule description. The maximum string length in characters is 128. |
SystemSessionPropertyAccessRule
|
Field |
Description |
|
users[] |
string IAM user IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
groups[] |
string IAM group IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
property |
Property matcher specifying what properties the rule is applied to. |
|
allow |
enum (Allow) Required field. Whether the rule allows setting the property.
|
|
description |
string Rule description. The maximum string length in characters is 128. |
PropertyAccessRuleMatcher
|
Field |
Description |
|
nameRegexp |
string Property name regexp the rule is applied to. The maximum string length in characters is 256. Includes only one of the fields |
|
names |
Property names the rule is applied to. Includes only one of the fields |
PropertyNames
|
Field |
Description |
|
any[] |
string The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
CatalogSessionPropertyAccessRule
|
Field |
Description |
|
users[] |
string IAM user IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
groups[] |
string IAM group IDs the rule is applied to. The maximum number of elements is 128. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
catalog |
Catalog matcher specifying what catalogs the rule is applied to. |
|
property |
Property matcher specifying what properties the rule is applied to. |
|
allow |
enum (Allow) Required field. Whether the rule allows setting the property.
|
|
description |
string Rule description. The maximum string length in characters is 128. |
ResourceManagementConfig
|
Field |
Description |
|
resourceGroups |
Resource groups configuration. |
|
query |
Query management confiugration. |
ResourceGroupsConfig
|
Field |
Description |
|
rootGroups[] |
Root resource groups configuration. The number of elements must be greater than 0. |
|
selectors[] |
Selector rules for routing queries to resource groups. The number of elements must be greater than 0. |
|
cpuQuotaPeriod |
string Period for CPU quota calculations. |
ResourceGroupConfig
|
Field |
Description |
|
name |
string Required field. Resource group name. |
|
maxQueued |
string (int64) Maximum number of queued queries. Value must be greater than 0. |
|
softConcurrencyLimit |
string (int64) Number of concurrently running queries after which new queries only run if peer groups are below soft limits. |
|
hardConcurrencyLimit |
string (int64) Maximum number of queries that can run concurrently. Value must be greater than 0. |
|
softMemoryLimit |
string Maximum amount of distributed memory this group can use. |
|
softCpuLimit |
string Maximum CPU time per period this group can use before applying penalty to running queries (requires hard_cpu_limit). |
|
hardCpuLimit |
string Maximum CPU time per period this group can use. |
|
schedulingPolicy |
enum (SchedulingPolicy) Policy for selecting queued queries and sub-group eligibility.
|
|
schedulingWeight |
string (int64) Weight for weighted and weighted_fair scheduling policies. |
|
subGroups[] |
List of sub-groups. |
SelectorRuleConfig
|
Field |
Description |
|
user |
string Regex to match against username. |
|
userGroup |
string Regex to match against user groups. |
|
source |
string Regex to match against query source. |
|
queryType |
enum (QueryType) Type of query to match.
|
|
clientTags[] |
string Tags that must all be present in the query's client tags. |
|
group |
string Required field. Target resource group name. |
QueryConfig
|
Field |
Description |
|
properties |
object (map<string, string>) Query properties. |
TLSConfig
|
Field |
Description |
|
trustedCertificates[] |
string Trusted CA-certificates. Each element should contain single self-signed CA-certificate or The maximum number of elements is 8. The maximum string length in characters for each value is 8192. |
NetworkConfig
|
Field |
Description |
|
subnetIds[] |
string IDs of VPC network subnets where instances of the cluster are attached. |
|
securityGroupIds[] |
string User security groups. |
LoggingConfig
|
Field |
Description |
|
enabled |
boolean Logs generated by the Trino components are delivered to Cloud Logging. |
|
folderId |
string Logs should be written to default log group for specified folder. Value must match the regular expression Includes only one of the fields Destination of log records. |
|
logGroupId |
string Logs should be written to log group resolved by ID. Value must match the regular expression Includes only one of the fields Destination of log records. |
|
minLevel |
enum (Level) Minimum log entry level. See LogLevel.Level for details.
|
MaintenanceWindow
|
Field |
Description |
|
anytime |
object Includes only one of the fields |
|
weeklyMaintenanceWindow |
Includes only one of the fields |
WeeklyMaintenanceWindow
|
Field |
Description |
|
day |
enum (WeekDay)
|
|
hour |
string (int64) Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
|
Field |
Description |
|
info |
string The maximum string length in characters is 256. |
|
delayedUntil |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
|
latestMaintenanceTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
|
nextMaintenanceWindowTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |