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

Managed Service for Hive Metastore™ API, REST: Cluster.List

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

Retrieves a list of Metastore Clusters.

HTTP request

GET https://metastore.api.yandexcloud.kz/managed-metastore/v1/clusters

Query parameters

Field

Description

folderId

string

Required field. ID of the folder to list Metastore Clusters in.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListClustersResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, set pageToken to the ListClustersResponse.nextPageToken
returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

  1. The field name. Currently you can only use filtering with the Cluster.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 1-63 characters long and match the regular expression [a-zA-Z0-9_-]+.

Response

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "monitoring": [
        {
          "name": "string",
          "description": "string",
          "link": "string"
        }
      ],
      "health": "string",
      "status": "string",
      "deletionProtection": "boolean",
      "version": "string",
      "networkId": "string",
      "endpointIp": "string",
      "clusterConfig": {
        "resources": {
          "resourcePresetId": "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"
      },
      "network": {
        "subnetIds": [
          "string"
        ],
        "securityGroupIds": [
          "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"
      }
    }
  ],
  "nextPageToken": "string"
}

Field

Description

clusters[]

Cluster

List of Metastore Clusters.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListClustersRequest.pageSize, use the nextPageToken as the value
for the ListClustersRequest.pageToken parameter in the next list request. Each subsequent
list request will have its own nextPageToken to continue paging through the results.

Cluster

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.

folderId

string

ID of the folder that the Metastore Cluster belongs to.

createdAt

string (date-time)

The time the Metastore Cluster was created at.

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

deletionProtection

boolean

Deletion Protection prevents deletion of the cluster.

version

string

Metastore server version.

networkId

string

Metastore network ID.

endpointIp

string

IP address of the Metastore server load balancer.

clusterConfig

ClusterConfig

Configuration of the Metastore Cluster.

serviceAccountId

string

Service account used to access Cloud resources.

logging

LoggingConfig

Cloud logging configuration.

network

NetworkConfig

Network-related configuration options.

maintenanceWindow

MaintenanceWindow

Maintenance window.

plannedOperation

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

resourcePresetId

string

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

LoggingConfig

Field

Description

enabled

boolean

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

folderId

string

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

Includes only one of the fields folderId, logGroupId.

Destination of log records.

logGroupId

string

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

Includes only one of the fields folderId, logGroupId.

Destination of log records.

minLevel

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

subnetIds[]

string

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

securityGroupIds[]

string

User security groups.

MaintenanceWindow

Field

Description

anytime

object

The cluster may be restarted for maintenance at any time.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Maintenance is allowed only within the specified weekly window.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

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

string (int64)

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

MaintenanceOperation

Field

Description

info

string

Information about the maintenance operation.

delayedUntil

string (date-time)

Maintenance is postponed until the specified 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).

latestMaintenanceTime

string (date-time)

Timestamp of the latest successfully completed maintenance.

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)

Timestamp of the next scheduled maintenance window.

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).
Предыдущая
Get
Следующая
Create