Managed Service for Trino API, REST: Cluster.Get
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. |
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"
}
},
"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. |
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. |
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.). |
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. |
AutoScalePolicy
Field |
Description |
minCount |
string (int64) |
maxCount |
string (int64) |
RetryPolicyConfig
Field |
Description |
policy |
enum (RetryPolicy) Retry policy level.
|
exchangeManager |
Configuration for exchange manager. |
additionalProperties |
object (map<string, string>) Additional properties. |
ExchangeManagerConfig
Field |
Description |
additionalProperties |
object (map<string, string>) Additional properties. |
storage |
ExchangeManagerStorage
Field |
Description |
serviceS3 |
object Use service side s3 bucket for exchange manager. Includes only one of the fields |
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. Includes only one of the fields Destination of log records. |
logGroupId |
string Logs should be written to log group resolved by ID. 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. |
MaintenanceOperation
Field |
Description |
info |
string |
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 |