Связаться с намиПодключиться

Managed Service for Hive Metastore™ API, gRPC: ClusterService.Get

Статья создана
Обновлена 3 октября 2025 г.

Returns the specified Metastore Cluster.

gRPC request

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

{
  "cluster_id": "string"
}

Field

Description

cluster_id

string

Required field. ID of the Metastore Cluster 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"
    }
  ],
  "health": "Health",
  "status": "Status",
  "deletion_protection": "bool",
  "version": "string",
  "network_id": "string",
  "endpoint_ip": "string",
  "cluster_config": {
    "resources": {
      "resource_preset_id": "string"
    }
  },
  "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"
  },
  "network": {
    "subnet_ids": [
      "string"
    ],
    "security_group_ids": [
      "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"
  }
}

Metastore Cluster.

Field

Description

id

string

Unique ID of the Metastore Cluster.
This ID is assigned by Cloud in the process of creating a Trino cluster.

folder_id

string

ID of the folder that the Metastore Cluster belongs to.

created_at

google.protobuf.Timestamp

The time the Metastore Cluster was created at.

name

string

Name of the Metastore Cluster.
The name is unique within the folder.

description

string

Description of the Metastore Cluster.

labels

object (map<string, string>)

Custom labels for the Metastore Cluster as key:value pairs.

monitoring[]

Monitoring

Monitoring systems relevant to the Metastore Cluster.

health

enum Health

Aggregated cluster health.

  • HEALTH_UNKNOWN: Cluster is in unknown state (we have no data).
  • ALIVE: Cluster is alive and operates properly.
  • DEAD: Cluster is inoperable (it cannot perform any of its essential functions).
  • DEGRADED: Cluster 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.
  • UPDATING: Cluster is being updated.
  • STOPPING: Cluster is stopping.
  • STOPPED: Cluster stopped.
  • STARTING: Cluster is starting.

deletion_protection

bool

Deletion Protection prevents deletion of the cluster.

version

string

Metastore server version.

network_id

string

Metastore network ID.

endpoint_ip

string

IP address of the Metastore server load balancer.

cluster_config

ClusterConfig

Configuration of the Metastore Cluster.

service_account_id

string

Service account used to access Cloud resources.

logging

LoggingConfig

Cloud logging configuration.

network

NetworkConfig

Network-related configuration options.

maintenance_window

MaintenanceWindow

Maintenance window.

planned_operation

MaintenanceOperation

Maintenance operation scheduled for the nearest maintenance window.

Monitoring

Field

Description

name

string

Name of the monitoring system.

description

string

Description of the monitoring system.

link

string

Link to the monitoring system.

ClusterConfig

Field

Description

resources

Resources

Configuration for computational resources for Metastore server instances.

Resources

Field

Description

resource_preset_id

string

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

LoggingConfig

Field

Description

enabled

bool

Logs generated by the Metastore server are delivered to Cloud Logging.

folder_id

string

Logs will be written to the default log group of the specified folder.

Includes only one of the fields folder_id, log_group_id.

Destination of log records.

log_group_id

string

Logs will be written to the log group specified by its ID.

Includes only one of the fields folder_id, log_group_id.

Destination of log records.

min_level

enum Level

Minimum severity level for log entries.

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.

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.

MaintenanceWindow

Field

Description

anytime

AnytimeMaintenanceWindow

The cluster may be restarted for maintenance at any time.

Includes only one of the fields anytime, weekly_maintenance_window.

weekly_maintenance_window

WeeklyMaintenanceWindow

Maintenance is allowed only within the specified weekly window.

Includes only one of the fields anytime, weekly_maintenance_window.

AnytimeMaintenanceWindow

Field

Description

Empty

WeeklyMaintenanceWindow

Field

Description

day

enum WeekDay

Day of the week when maintenance can occur.

  • WEEK_DAY_UNSPECIFIED: Day of the week is not specified.
  • MON: Monday.
  • TUE: Tuesday.
  • WED: Wednesday.
  • THU: Thursday.
  • FRI: Friday.
  • SAT: Saturday.
  • SUN: Sunday.

hour

int64

Hour of the day in UTC when the maintenance window starts.

MaintenanceOperation

Field

Description

info

string

Information about the maintenance operation.

delayed_until

google.protobuf.Timestamp

Maintenance is postponed until the specified timestamp.

latest_maintenance_time

google.protobuf.Timestamp

Timestamp of the latest successfully completed maintenance.

next_maintenance_window_time

google.protobuf.Timestamp

Timestamp of the next scheduled maintenance window.
Предыдущая
Overview
Следующая
List