Managed Service for Trino API, REST: Cluster.Update

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

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

HTTP request
Path parameters
Body parameters
UpdateTrinoConfigSpec
UpdateCoordinatorConfig
Resources
UpdateWorkerConfig
WorkerScalePolicy
FixedScalePolicy
AutoScalePolicy
RetryPolicyConfig
ExchangeManagerConfig
ExchangeManagerStorage
UpdateNetworkConfigSpec
LoggingConfig
MaintenanceWindow
WeeklyMaintenanceWindow
Response
UpdateClusterMetadata
Status
Cluster
Monitoring
TrinoConfig
CoordinatorConfig
Resources
WorkerConfig
WorkerScalePolicy
FixedScalePolicy
AutoScalePolicy
RetryPolicyConfig
ExchangeManagerConfig
ExchangeManagerStorage
NetworkConfig
LoggingConfig
MaintenanceWindow
WeeklyMaintenanceWindow
MaintenanceOperation

Updates configuration of the specified Trino cluster.

HTTP request

PATCH https://trino.api.cloud.yandex.net/managed-trino/v1/clusters/{clusterId}

Path parameters

Field

Description

clusterId

string

Required field. ID of the Trino cluster.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "deletionProtection": "boolean",
  "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
      }
    },
    "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"
    }
  },
  "networkSpec": {
    "securityGroupIds": [
      "string"
    ]
  },
  "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"
  },
  "maintenanceWindow": {
    // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
    "anytime": "object",
    "weeklyMaintenanceWindow": {
      "day": "string",
      "hour": "string"
    }
    // end of the list of possible fields
  }
}

Field	Description
updateMask	string (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string Name of the Trino cluster. The name must be unique within the folder.
description	string Description of the Trino cluster.
labels	object (map<string, string>) Custom labels for the Trino cluster as `key:value` pairs. For example: {"env": "prod"}.
deletionProtection	boolean Deletion Protection inhibits deletion of the cluster.
trino	UpdateTrinoConfigSpec Configuration of Trino components.
networkSpec	UpdateNetworkConfigSpec Network related configuration options.
serviceAccountId	string Service account used to access Cloud resources.
logging	LoggingConfig Cloud logging configuration.
maintenanceWindow	MaintenanceWindow Window of maintenance operations.

UpdateTrinoConfigSpec

Field	Description
coordinatorConfig	UpdateCoordinatorConfig Configuration for the coordinator, specifying computational resources and other settings.
workerConfig	UpdateWorkerConfig Configuration for worker nodes, including scaling policy and computational resources.
retryPolicy	RetryPolicyConfig Configuration for retry policy, specifying the spooling storage destination and other settings.

UpdateCoordinatorConfig

Field

Description

resources

Resources

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.).

UpdateWorkerConfig

Field

Description

resources

Resources

Configuration for computational resources for worker instances.

scalePolicy

WorkerScalePolicy

Configuration for scaling policy for worker instances.

WorkerScalePolicy

Field

Description

fixedScale

FixedScalePolicy

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

Includes only one of the fields fixedScale, autoScale.

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

autoScale

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 fixedScale, autoScale.

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

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. `RETRY_POLICY_UNSPECIFIED` `QUERY` `TASK`
exchangeManager	ExchangeManagerConfig Configuration for exchange manager.
additionalProperties	object (map<string, string>) Additional properties.

ExchangeManagerConfig

Field

Description

additionalProperties

object (map<string, string>)

Additional properties.

storage

ExchangeManagerStorage

ExchangeManagerStorage

Field

Description

serviceS3

object

Use service side s3 bucket for exchange manager.

Includes only one of the fields serviceS3.

UpdateNetworkConfigSpec

Field

Description

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 `folderId`, `logGroupId`. Destination of log records.
logGroupId	string Logs should be written to log group resolved by ID. Includes only one of the fields `folderId`, `logGroupId`. Destination of log records.
minLevel	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

object

Includes only one of the fields anytime, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Includes only one of the fields anytime, weeklyMaintenanceWindow.

WeeklyMaintenanceWindow

Field

Description

day

enum (WeekDay)

WEEK_DAY_UNSPECIFIED
MON
TUE
WED
THU
FRI
SAT
SUN

hour

string (int64)

Hour of the day in UTC.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "clusterId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "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"
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	UpdateClusterMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Cluster The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

UpdateClusterMetadata

Field

Description

clusterId

string

ID of the Trino cluster that is being updated.

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.

Cluster

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.
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 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
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.
deletionProtection	boolean Deletion Protection inhibits deletion of the cluster.
serviceAccountId	string Service account used to access Cloud resources.
logging	LoggingConfig Cloud logging configuration.
coordinatorUrl	string Address of Trino Coordinator.
maintenanceWindow	MaintenanceWindow Window of maintenance operations.
plannedOperation	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
coordinatorConfig	CoordinatorConfig Required field. Configuration for the coordinator, specifying computational resources and other settings.
workerConfig	WorkerConfig Required field. Configuration for worker nodes, including scaling policy and computational resources.
version	string Version of Trino.
retryPolicy	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

resourcePresetId

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.

scalePolicy

WorkerScalePolicy

Required field. Configuration for scaling policy for worker instances.

WorkerScalePolicy

Field

Description

fixedScale

FixedScalePolicy

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

Includes only one of the fields fixedScale, autoScale.

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

autoScale

AutoScalePolicy

Includes only one of the fields fixedScale, autoScale.

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

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. `RETRY_POLICY_UNSPECIFIED` `QUERY` `TASK`
exchangeManager	ExchangeManagerConfig Configuration for exchange manager.
additionalProperties	object (map<string, string>) Additional properties.

ExchangeManagerConfig

Field

Description

additionalProperties

object (map<string, string>)

Additional properties.

storage

ExchangeManagerStorage

ExchangeManagerStorage

Field

Description

serviceS3

object

Use service side s3 bucket for exchange manager.

Includes only one of the fields serviceS3.

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 `folderId`, `logGroupId`. Destination of log records.
logGroupId	string Logs should be written to log group resolved by ID. Includes only one of the fields `folderId`, `logGroupId`. Destination of log records.
minLevel	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

object

Includes only one of the fields anytime, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Includes only one of the fields anytime, weeklyMaintenanceWindow.

WeeklyMaintenanceWindow

Field

Description

day

enum (WeekDay)

WEEK_DAY_UNSPECIFIED
MON
TUE
WED
THU
FRI
SAT
SUN

hour

string (int64)

Hour of the day in UTC.

MaintenanceOperation

Field	Description
info	string
delayedUntil	string (date-time) String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
latestMaintenanceTime	string (date-time) String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
nextMaintenanceWindowTime	string (date-time) String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

Managed Service for Trino API, REST: Cluster.Update

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

UpdateTrinoConfigSpecUpdateTrinoConfigSpec

UpdateCoordinatorConfigUpdateCoordinatorConfig

ResourcesResources

UpdateWorkerConfigUpdateWorkerConfig

WorkerScalePolicyWorkerScalePolicy

FixedScalePolicyFixedScalePolicy

AutoScalePolicyAutoScalePolicy

RetryPolicyConfigRetryPolicyConfig

ExchangeManagerConfigExchangeManagerConfig

ExchangeManagerStorageExchangeManagerStorage

UpdateNetworkConfigSpecUpdateNetworkConfigSpec

LoggingConfigLoggingConfig

MaintenanceWindowMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

ResponseResponse

UpdateClusterMetadataUpdateClusterMetadata

StatusStatus

ClusterCluster

MonitoringMonitoring

TrinoConfigTrinoConfig

CoordinatorConfigCoordinatorConfig

ResourcesResources

WorkerConfigWorkerConfig

WorkerScalePolicyWorkerScalePolicy

FixedScalePolicyFixedScalePolicy

AutoScalePolicyAutoScalePolicy

RetryPolicyConfigRetryPolicyConfig

ExchangeManagerConfigExchangeManagerConfig

ExchangeManagerStorageExchangeManagerStorage

NetworkConfigNetworkConfig

LoggingConfigLoggingConfig

MaintenanceWindowMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

MaintenanceOperationMaintenanceOperation

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

HTTP request

Path parameters

Body parameters

UpdateTrinoConfigSpec

UpdateCoordinatorConfig

Resources

UpdateWorkerConfig

WorkerScalePolicy

FixedScalePolicy

AutoScalePolicy

RetryPolicyConfig

ExchangeManagerConfig

ExchangeManagerStorage

UpdateNetworkConfigSpec

LoggingConfig

MaintenanceWindow

WeeklyMaintenanceWindow

Response

UpdateClusterMetadata

Status

Cluster

Monitoring

TrinoConfig

CoordinatorConfig

Resources

WorkerConfig

WorkerScalePolicy

FixedScalePolicy

AutoScalePolicy

RetryPolicyConfig

ExchangeManagerConfig

ExchangeManagerStorage

NetworkConfig

LoggingConfig

MaintenanceWindow

WeeklyMaintenanceWindow

MaintenanceOperation