Managed Service for Trino API, gRPC: ClusterService.Get

Статья создана

Yandex Cloud

Обновлена 24 апреля 2025 г.

gRPC request
GetClusterRequest
Cluster
Monitoring
TrinoConfig
CoordinatorConfig
Resources
WorkerConfig
WorkerScalePolicy
FixedScalePolicy
AutoScalePolicy
RetryPolicyConfig
ExchangeManagerConfig
ExchangeManagerStorage
ServiceS3
NetworkConfig
LoggingConfig
MaintenanceWindow
AnytimeMaintenanceWindow
WeeklyMaintenanceWindow
MaintenanceOperation

Returns the specified Trino Cluster resource.

gRPC request

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

{
  "cluster_id": "string"
}

Field

Description

cluster_id

string

Required field. ID of the Trino Cluster resource to return.

Cluster

{
  "id": "string",
  "folder_id": "string",
  "created_at": "google.protobuf.Timestamp",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "trino": {
    "coordinator_config": {
      "resources": {
        "resource_preset_id": "string"
      }
    },
    "worker_config": {
      "resources": {
        "resource_preset_id": "string"
      },
      "scale_policy": {
        // Includes only one of the fields `fixed_scale`, `auto_scale`
        "fixed_scale": {
          "count": "int64"
        },
        "auto_scale": {
          "min_count": "int64",
          "max_count": "int64"
        }
        // end of the list of possible fields
      }
    },
    "version": "string",
    "retry_policy": {
      "policy": "RetryPolicy",
      "exchange_manager": {
        "additional_properties": "map<string, string>",
        "storage": {
          // Includes only one of the fields `service_s3`
          "service_s3": "ServiceS3"
          // end of the list of possible fields
        }
      },
      "additional_properties": "map<string, string>"
    }
  },
  "health": "Health",
  "status": "Status",
  "network": {
    "subnet_ids": [
      "string"
    ],
    "security_group_ids": [
      "string"
    ]
  },
  "deletion_protection": "bool",
  "service_account_id": "string",
  "logging": {
    "enabled": "bool",
    // Includes only one of the fields `folder_id`, `log_group_id`
    "folder_id": "string",
    "log_group_id": "string",
    // end of the list of possible fields
    "min_level": "Level"
  },
  "coordinator_url": "string",
  "maintenance_window": {
    // Includes only one of the fields `anytime`, `weekly_maintenance_window`
    "anytime": "AnytimeMaintenanceWindow",
    "weekly_maintenance_window": {
      "day": "WeekDay",
      "hour": "int64"
    }
    // end of the list of possible fields
  },
  "planned_operation": {
    "info": "string",
    "delayed_until": "google.protobuf.Timestamp",
    "latest_maintenance_time": "google.protobuf.Timestamp",
    "next_maintenance_window_time": "google.protobuf.Timestamp"
  }
}

Trino cluster.

Field	Description
id	string Unique ID of the Trino cluster. This ID is assigned by Cloud in the process of creating a Trino cluster.
folder_id	string ID of the folder that the Trino cluster belongs to.
created_at	google.protobuf.Timestamp The time when the Trino cluster was created.
name	string Name of the Trino cluster. The name is unique within the folder. 1-64 characters long.
description	string Description of the Trino cluster. 0-256 characters long.
labels	object (map<string, string>) Resource labels as `key:value` pairs. Maximum of 64 per resource.
monitoring[]	Monitoring Monitoring systems relevant to the Trino cluster.
trino	TrinoConfig Configuration of the Trino cluster.
health	enum Health Aggregated cluster health. `HEALTH_UNKNOWN`: Object is in unknown state (we have no data) `ALIVE`: Object is alive and well (all hosts are alive) `DEAD`: Object is inoperable (it cannot perform any of its essential functions) `DEGRADED`: Object is partially alive (it can perform some of its essential functions)
status	enum Status Cluster status. `STATUS_UNKNOWN`: Cluster state is unknown. `CREATING`: Cluster is being created. `RUNNING`: Cluster is running normally. `ERROR`: Cluster encountered a problem and cannot operate. `STOPPING`: Cluster is stopping. `STOPPED`: Cluster is stopped. `STARTING`: Cluster is starting. `UPDATING`: Cluster is being updated.
network	NetworkConfig Network related configuration options.
deletion_protection	bool Deletion Protection inhibits deletion of the cluster.
service_account_id	string Service account used to access Cloud resources.
logging	LoggingConfig Cloud logging configuration.
coordinator_url	string Address of Trino Coordinator.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation 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
coordinator_config	CoordinatorConfig Required field. Configuration for the coordinator, specifying computational resources and other settings.
worker_config	WorkerConfig Required field. Configuration for worker nodes, including scaling policy and computational resources.
version	string Version of Trino.
retry_policy	RetryPolicyConfig Configuration for retry policy, specifying the spooling storage destination and other settings.

CoordinatorConfig

Field

Description

resources

Resources

Required field. Configuration for computational resources assigned to the coordinator instance.

Resources

Field

Description

resource_preset_id

string

Required field. ID of the preset for computational resources allocated to a instance (e.g., CPU, memory, etc.).

WorkerConfig

Field

Description

resources

Resources

Required field. Configuration for computational resources for worker instances.

scale_policy

WorkerScalePolicy

Required field. Configuration for scaling policy for worker instances.

WorkerScalePolicy

Field

Description

fixed_scale

FixedScalePolicy

A fixed scaling policy that specifies a fixed number of worker instances.

Includes only one of the fields fixed_scale, auto_scale.

Defines the scaling type for worker instances.
Only one type of scaling can be specified at a time.

auto_scale

AutoScalePolicy

A scaling policy that dynamically adjusts the number of worker instances
based on the cluster's workload. The system automatically increases or
decreases the number of instances within the defined range.

Includes only one of the fields fixed_scale, auto_scale.

Defines the scaling type for worker instances.
Only one type of scaling can be specified at a time.

FixedScalePolicy

Field

Description

count

int64

Specifies the number of worker instances.

AutoScalePolicy

Field	Description
min_count	int64
max_count	int64

RetryPolicyConfig

Field	Description
policy	enum RetryPolicy Retry policy level. `RETRY_POLICY_UNSPECIFIED` `QUERY` `TASK`
exchange_manager	ExchangeManagerConfig Configuration for exchange manager.
additional_properties	object (map<string, string>) Additional properties.

ExchangeManagerConfig

Field

Description

additional_properties

object (map<string, string>)

Additional properties.

storage

ExchangeManagerStorage

ExchangeManagerStorage

Field

Description

service_s3

ServiceS3

Use service side s3 bucket for exchange manager.

Includes only one of the fields service_s3.

ServiceS3

Field	Description
Empty

NetworkConfig

Field

Description

subnet_ids[]

string

IDs of VPC network subnets where instances of the cluster are attached.

security_group_ids[]

string

User security groups.

LoggingConfig

Field	Description
enabled	bool Logs generated by the Trino components are delivered to Cloud Logging.
folder_id	string Logs should be written to default log group for specified folder. Includes only one of the fields `folder_id`, `log_group_id`. Destination of log records.
log_group_id	string Logs should be written to log group resolved by ID. Includes only one of the fields `folder_id`, `log_group_id`. Destination of log records.
min_level	enum Level Minimum log entry level. See LogLevel.Level for details. `LEVEL_UNSPECIFIED`: Default log level. Equivalent to not specifying log level at all. `TRACE`: Trace log level. Possible use case: verbose logging of some business logic. `DEBUG`: Debug log level. Possible use case: debugging special cases in application logic. `INFO`: Info log level. Mostly used for information messages. `WARN`: Warn log level. May be used to alert about significant events. `ERROR`: Error log level. May be used to alert about errors in infrastructure, logic, etc. `FATAL`: Fatal log level. May be used to alert about unrecoverable failures and events.

MaintenanceWindow

Field

Description

anytime

AnytimeMaintenanceWindow

Includes only one of the fields anytime, weekly_maintenance_window.

weekly_maintenance_window

WeeklyMaintenanceWindow

Includes only one of the fields anytime, weekly_maintenance_window.

AnytimeMaintenanceWindow

Field	Description
Empty

WeeklyMaintenanceWindow

Field

Description

day

enum WeekDay

WEEK_DAY_UNSPECIFIED
MON
TUE
WED
THU
FRI
SAT
SUN

hour

int64

Hour of the day in UTC.

MaintenanceOperation

Field	Description
info	string
delayed_until	google.protobuf.Timestamp
latest_maintenance_time	google.protobuf.Timestamp
next_maintenance_window_time	google.protobuf.Timestamp

Managed Service for Trino API, gRPC: ClusterService.Get

gRPC requestgRPC request

GetClusterRequestGetClusterRequest

ClusterCluster

MonitoringMonitoring

TrinoConfigTrinoConfig

CoordinatorConfigCoordinatorConfig

ResourcesResources

WorkerConfigWorkerConfig

WorkerScalePolicyWorkerScalePolicy

FixedScalePolicyFixedScalePolicy

AutoScalePolicyAutoScalePolicy

RetryPolicyConfigRetryPolicyConfig

ExchangeManagerConfigExchangeManagerConfig

ExchangeManagerStorageExchangeManagerStorage

ServiceS3ServiceS3

NetworkConfigNetworkConfig

LoggingConfigLoggingConfig

MaintenanceWindowMaintenanceWindow

AnytimeMaintenanceWindowAnytimeMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

MaintenanceOperationMaintenanceOperation

Была ли статья полезна?

gRPC request

GetClusterRequest

Cluster

Monitoring

TrinoConfig

CoordinatorConfig

Resources

WorkerConfig

WorkerScalePolicy

FixedScalePolicy

AutoScalePolicy

RetryPolicyConfig

ExchangeManagerConfig

ExchangeManagerStorage

ServiceS3

NetworkConfig

LoggingConfig

MaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

MaintenanceOperation