{
  "id": "string",
  "folder_id": "string",
  "created_at": "google.protobuf.Timestamp",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "environment": "Environment",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "spqr_config": {
      "router": {
        "config": {
          "show_notice_messages": "google.protobuf.BoolValue",
          "time_quantiles": [
            "double"
          ],
          "default_route_behavior": "DefaultRouteBehavior",
          "prefer_same_availability_zone": "google.protobuf.BoolValue"
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        }
      },
      "coordinator": {
        "config": "CoordinatorSettings",
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        }
      },
      "postgresql": {
        "config": "PostgreSQLSettings",
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        }
      },
      "infra": {
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "router": {
          "show_notice_messages": "google.protobuf.BoolValue",
          "time_quantiles": [
            "double"
          ],
          "default_route_behavior": "DefaultRouteBehavior",
          "prefer_same_availability_zone": "google.protobuf.BoolValue"
        },
        "coordinator": "CoordinatorSettings"
      },
      "log_level": "LogLevel",
      "balancer": {
        "cpu_threshold": "google.protobuf.DoubleValue",
        "space_threshold": "google.protobuf.DoubleValue",
        "stat_interval_sec": "google.protobuf.Int64Value",
        "max_move_count": "google.protobuf.Int64Value",
        "keys_per_move": "google.protobuf.Int64Value",
        "timeout": "google.protobuf.Int64Value"
      }
    },
    "backup_window_start": "google.type.TimeOfDay",
    "backup_retain_period_days": "google.protobuf.Int64Value",
    "access": {
      "data_lens": "bool",
      "web_sql": "bool",
      "data_transfer": "bool",
      "serverless": "bool"
    },
    "sox_audit": "google.protobuf.BoolValue"
  },
  "network_id": "string",
  "health": "Health",
  "status": "Status",
  "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"
  },
  "security_group_ids": [
    "string"
  ],
  "deletion_protection": "bool"
}

A managed SPQR cluster. For more information, see the documentation.

Field	Description
id	string ID of the SPQR cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the SPQR cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the SPQR cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the SPQR cluster. 0-256 characters long.
labels	object (map<string, string>) Custom labels for the SPQR cluster as `key:value` pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the SPQR cluster. `ENVIRONMENT_UNSPECIFIED` `PRODUCTION`: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. `PRESTABLE`: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the SPQR cluster.
config	ClusterConfig Configuration of the SPQR cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. `HEALTH_UNKNOWN`: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). `ALIVE`: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). `DEAD`: Cluster is inoperable (Host.health for every host in the cluster is DEAD). `DEGRADED`: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. `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.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest `maintenance_window`.
security_group_ids[]	string User security groups
deletion_protection	bool Deletion Protection inhibits deletion of the cluster

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 charts for the SPQR cluster.

ClusterConfig

Field	Description
spqr_config	SPQRConfig Configuration for SPQR servers in the cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
backup_retain_period_days	google.protobuf.Int64Value Retain period of automatically created backup in days
access	Access Access policy to DB
sox_audit	google.protobuf.BoolValue

SPQRConfig

Field	Description
router	RouterConfig SPQR router settings.
coordinator	CoordinatorConfig SPQR coordinator settings.
postgresql	PostgreSQLConfig PostgreSQL settings.
infra	InfraConfig SPQR Infra (router+coordinator) settings.
log_level	enum LogLevel SPQR default log level `LOG_LEVEL_UNSPECIFIED` `DEBUG` `INFO` `WARNING` `ERROR` `FATAL` `PANIC`
balancer	BalancerSettings SPQR Balancer settings.

RouterConfig

Field	Description
config	RouterSettings
resources	Resources

RouterSettings

Configuration of a SPQR router.

Field	Description
show_notice_messages	google.protobuf.BoolValue
time_quantiles[]	double
default_route_behavior	enum DefaultRouteBehavior `DEFAULT_ROUTE_BEHAVIOR_UNSPECIFIED` `BLOCK` `ALLOW`
prefer_same_availability_zone	google.protobuf.BoolValue

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-hdd - network HDD drive, network-ssd - network SSD drive, local-ssd - local SSD storage.

CoordinatorConfig

Field	Description
config	CoordinatorSettings
resources	Resources

CoordinatorSettings

Configuration of a SPQR coordinator.

Field	Description
Empty

PostgreSQLConfig

Field	Description
config	PostgreSQLSettings
resources	Resources

PostgreSQLSettings

Configuration of a PostgreSQL.

Field	Description
Empty

InfraConfig

Field	Description
resources	Resources
router	RouterSettings
coordinator	CoordinatorSettings

BalancerSettings

Field	Description
cpu_threshold	google.protobuf.DoubleValue
space_threshold	google.protobuf.DoubleValue
stat_interval_sec	google.protobuf.Int64Value
max_move_count	google.protobuf.Int64Value
keys_per_move	google.protobuf.Int64Value
timeout	google.protobuf.Int64Value

Access

Field	Description
data_lens	bool Allow access for DataLens.
web_sql	bool Allow access for Web SQL.
data_transfer	bool Allow access for DataTransfer.
serverless	bool Allow access for Serverless. NOTE: Do not propagate to public API until Serverless integration is required.

MaintenanceWindow

A maintenance window settings.

Field

Description

anytime

AnytimeMaintenanceWindow

Maintenance operation can be scheduled anytime.

Includes only one of the fields anytime, weekly_maintenance_window.

The maintenance policy in effect.

weekly_maintenance_window

WeeklyMaintenanceWindow

Maintenance operation can be scheduled on a weekly basis.

Includes only one of the fields anytime, weekly_maintenance_window.

The maintenance policy in effect.

AnytimeMaintenanceWindow

Field	Description
Empty

WeeklyMaintenanceWindow

Weelky maintenance window settings.

Field

Description

day

enum WeekDay

Day of the week (in DDD format).

WEEK_DAY_UNSPECIFIED
MON
TUE
WED
THU
FRI
SAT
SUN

hour

int64

Hour of the day in UTC (in HH format).

MaintenanceOperation

A planned maintenance operation.

Field	Description
info	string Information about this maintenance operation.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.
latest_maintenance_time	google.protobuf.Timestamp
next_maintenance_window_time	google.protobuf.Timestamp

Managed Service for SPQR API, gRPC: ClusterService.Get

gRPC requestgRPC request

GetClusterRequestGetClusterRequest

ClusterCluster

MonitoringMonitoring

ClusterConfigClusterConfig

SPQRConfigSPQRConfig

RouterConfigRouterConfig

RouterSettingsRouterSettings

ResourcesResources

CoordinatorConfigCoordinatorConfig

CoordinatorSettingsCoordinatorSettings

PostgreSQLConfigPostgreSQLConfig

PostgreSQLSettingsPostgreSQLSettings

InfraConfigInfraConfig

BalancerSettingsBalancerSettings

AccessAccess

MaintenanceWindowMaintenanceWindow

AnytimeMaintenanceWindowAnytimeMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

MaintenanceOperationMaintenanceOperation

Was the article helpful?

gRPC request

GetClusterRequest

Cluster