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

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

Обновлена 30 октября 2025 г.

HTTP request
Body parameters
ConfigSpec
Resources
LoggingConfig
NetworkConfig
MaintenanceWindow
WeeklyMaintenanceWindow
Response
CreateClusterMetadata
Status
Cluster
Monitoring
ClusterConfig
Resources
LoggingConfig
NetworkConfig
MaintenanceWindow
WeeklyMaintenanceWindow
MaintenanceOperation

Creates a Metastore Cluster.

HTTP request

POST https://metastore.api.cloud.yandex.net/managed-metastore/v1/clusters

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "deletionProtection": "boolean",
  "version": "string",
  "configSpec": {
    "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
  }
}

Field	Description
folderId	string Required field. ID of the folder to create the Metastore Cluster in.
name	string Required field. Name of the Metastore Cluster. The name must be 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. For example: {"env": "prod"}.
deletionProtection	boolean Deletion Protection prevents deletion of the cluster.
version	string Metastore server version.
configSpec	ConfigSpec Configuration of the Metastore Cluster.
serviceAccountId	string Required field. Service account used to access Cloud resources.
logging	LoggingConfig Cloud logging configuration.
network	NetworkConfig Network-related configuration options.
maintenanceWindow	MaintenanceWindow Maintenance window.

ConfigSpec

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.

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"
      }
    ],
    "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"
    }
  }
  // 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	CreateClusterMetadata 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.

CreateClusterMetadata

Field

Description

clusterId

string

ID of the Metastore Cluster that is being created.

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

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

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

HTTP requestHTTP request

Body parametersBody parameters

ConfigSpecConfigSpec

ResourcesResources

LoggingConfigLoggingConfig

NetworkConfigNetworkConfig

MaintenanceWindowMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

ResponseResponse

CreateClusterMetadataCreateClusterMetadata

StatusStatus

ClusterCluster

MonitoringMonitoring

ClusterConfigClusterConfig

ResourcesResources

LoggingConfigLoggingConfig

NetworkConfigNetworkConfig

MaintenanceWindowMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

MaintenanceOperationMaintenanceOperation

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

HTTP request

Body parameters

ConfigSpec

Resources

LoggingConfig

NetworkConfig

MaintenanceWindow

WeeklyMaintenanceWindow

Response

CreateClusterMetadata

Status

Cluster

Monitoring

ClusterConfig

Resources

LoggingConfig

NetworkConfig

MaintenanceWindow

WeeklyMaintenanceWindow

MaintenanceOperation