Managed Service for Greenplum® API, REST: Cluster.List

Field

Description

folderId

string

Required field. ID of the folder to list Greenplum® clusters in.

To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

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 the 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_-]+.

Field

Description

clusters[]

Cluster

List of Greenplum® cluster resources.

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 has its own nextPageToken to continue paging through the results.

Field

Description

id

string

ID of the Greenplum® cluster.
This ID is assigned by the platform at the moment of cluster creation.

folderId

string

ID of the folder that the Greenplum® cluster belongs to.

createdAt

string (date-time)

Time when the 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

Required field. Name of the Greenplum® cluster.
The name is unique within the folder.

config

GreenplumConfig

Greenplum® cluster configuration.

description

string

Description of the Greenplum® cluster.

labels

object (map<string, string>)

Custom labels for the Greenplum® cluster as key:value pairs. Maximum 64 labels per resource.

environment

enum (Environment)

Deployment environment of the Greenplum® 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 Greenplum® cluster.

masterConfig

MasterSubclusterConfig

Configuration of the Greenplum® master subcluster.

segmentConfig

SegmentSubclusterConfig

Configuration of the Greenplum® segment subcluster.

masterHostCount

string (int64)

Number of hosts in the master subcluster.

segmentHostCount

string (int64)

Number of hosts in the segment subcluster.

segmentInHost

string (int64)

Number of segments per host.

networkId

string

ID of the cloud network that the cluster belongs to.

health

enum (Health)

Aggregated cluster health.

• HEALTH_UNKNOWN: Health of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
• ALIVE: Cluster is working normally (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).
• UNBALANCED: Cluster is working below capacity (Host.health for at least one host in the cluster is UNBALANCED).

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 has encountered a problem and cannot operate.
• UPDATING: Cluster is being updated.
• STOPPING: Cluster is stopping.
• STOPPED: Cluster has stopped.
• STARTING: Cluster is starting.

maintenanceWindow

MaintenanceWindow

A Greenplum® cluster maintenance window. Should be defined by either one of the two options.

plannedOperation

MaintenanceOperation

Maintenance operation planned at nearest maintenanceWindow.

securityGroupIds[]

string

User security groups.

userName

string

Owner user name.

deletionProtection

boolean

Determines whether the cluster is protected from being deleted.

hostGroupIds[]

string

Host groups hosting VMs of the cluster.

clusterConfig

ClusterConfigSet

Greenplum® and Odyssey® configuration.

cloudStorage

CloudStorage

Cloud storage settings

masterHostGroupIds[]

string

Host groups hosting VMs of the master subcluster.

segmentHostGroupIds[]

string

Host groups hosting VMs of the segment subcluster.

serviceAccountId

string

Service account that will be used to access a Yandex Cloud resources

logging

LoggingConfig

Cloud logging configuration

Field

Description

version

string

Version of the Greenplum® server software.

backupWindowStart

TimeOfDay

Time to start the daily backup, in the UTC timezone.

backupRetainPeriodDays

string (int64)

Retention policy of automated backups.

access

Access

Access policy for external services.

zoneId

string

ID of the availability zone the cluster belongs to.
To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.

subnetId

string

ID of the subnet the cluster belongs to. This subnet should be a part of the cloud network the cluster belongs to (see Cluster.networkId).

assignPublicIp

boolean

Determines whether the cluster has a public IP address.

After the cluster has been created, this setting cannot be changed.

Field

Description

hours

integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios like business closing time.

minutes

integer (int32)

Minutes of hour of day. Must be from 0 to 59.

seconds

integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.

nanos

integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Field

Description

dataLens

boolean

Allows data export from the cluster to DataLens.

webSql

boolean

Allows SQL queries to the cluster databases from the management console.

dataTransfer

boolean

Allows access for DataTransfer.

yandexQuery

boolean

Allow access for YandexQuery.

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 Greenplum® cluster.

Field

Description

resources

Resources

Computational resources allocated to Greenplum® master subcluster hosts.

Field

Description

resourcePresetId

string

ID of the preset for computational resources allocated to a host.

Available presets are listed in the documentation.

diskSize

string (int64)

Volume of the storage used by the host, in bytes.

diskTypeId

string

Type of the storage used by the host: network-hdd, network-ssd or local-ssd.

Field

Description

resources

Resources

Computational resources allocated to Greenplum® segment subcluster hosts.

Field

Description

anytime

object

An any-time maintenance window.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

A weekly maintenance window.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

Field

Description

day

enum (WeekDay)

Day of the week.

• WEEK_DAY_UNSPECIFIED
• MON: Monday
• TUE: Tuesday
• WED: Wednesday
• THU: Thursday
• FRI: Friday
• SAT: Saturday
• SUN: Sunday

hour

string (int64)

Hour of the day in the UTC timezone.

Field

Description

info

string

The description of the operation.

delayedUntil

string (date-time)

Delay time for the maintenance operation.

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

Field

Description

greenplumConfigSet_6_22

GreenplumConfigSet6_22

Includes only one of the fields greenplumConfigSet_6_22, greenplumConfigSet_6.

greenplumConfigSet_6

GreenplumConfigSet6

Includes only one of the fields greenplumConfigSet_6_22, greenplumConfigSet_6.

pool

ConnectionPoolerConfigSet

Odyssey® pool settings.

backgroundActivities

BackgroundActivitiesConfig

Managed Greenplum® background tasks configuration.

pxfConfig

PXFConfigSet

Field

Description

effectiveConfig

GreenplumConfig6_22

Required field. Effective settings for a Greenplum® cluster (a combination of settings defined in userConfig and defaultConfig).

userConfig

GreenplumConfig6_22

User-defined settings for a Greenplum® cluster.

defaultConfig

GreenplumConfig6_22

Default configuration for a Greenplum® cluster.

Field

Description

maxConnections

string (int64)

Maximum number of inbound connections on master segment

maxSlotWalKeepSize

string (int64)

Specify the maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time.
https://www.postgresql.org/docs/current/runtime-config-replication.html

gpWorkfileLimitPerSegment

string (int64)

Sets the maximum total disk size that all running queries are allowed to use for creating temporary spill files at each segment.
The default value is 0, which means a limit is not enforced.
https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment

gpWorkfileLimitPerQuery

string (int64)

Sets the maximum disk size an individual query is allowed to use for creating temporary spill files at each segment.
The default value is 0, which means a limit is not enforced.
https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query

gpWorkfileLimitFilesPerQuery

string (int64)

Sets the maximum number of temporary spill files (also known as workfiles) allowed per query per segment.
Spill files are created when executing a query that requires more memory than it is allocated.
The current query is terminated when the limit is exceeded.
Set the value to 0 (zero) to allow an unlimited number of spill files. master session reload
https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query
Default value is 10000

maxPreparedTransactions

string (int64)

Sets the maximum number of transactions that can be in the "prepared" state simultaneously
https://www.postgresql.org/docs/9.6/runtime-config-resource.html

gpWorkfileCompression

boolean

Specifies whether the temporary files created, when a hash aggregation or hash join operation spills to disk, are compressed.
https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_compression

maxStatementMem

string (int64)

Sets the maximum memory limit for a query. Helps avoid out-of-memory errors on a segment host during query processing as a result of setting statement_mem too high.
Taking into account the configuration of a single segment host, calculate max_statement_mem as follows:
(seghost_physical_memory) / (average_number_concurrent_queries)
When changing both max_statement_mem and statement_mem, max_statement_mem must be changed first, or listed first in the postgresql.conf file.
https://greenplum.docs.pivotal.io/6-19/ref_guide/config_params/guc-list.html#max_statement_mem
Default value is 2097152000 (2000MB)

logStatement

enum (LogStatement)

Controls which SQL statements are logged. DDL logs all data definition commands like CREATE, ALTER, and DROP commands.
MOD logs all DDL statements, plus INSERT, UPDATE, DELETE, TRUNCATE, and COPY FROM.
PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command is of an appropriate type.
https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement
Default value is ddl

• LOG_STATEMENT_UNSPECIFIED
• NONE: None statements are logged.
• DDL: Logs all data definition commands like CREATE, ALTER, and DROP. Default value.
• MOD: Logs all DDL statements, plus INSERT, UPDATE, DELETE, TRUNCATE, and COPY FROM.
• ALL: Logs all statements.

gpAddColumnInheritsTableSetting

boolean

https://docs.vmware.com/en/VMware-Tanzu-Greenplum/6/greenplum-database/GUID-ref_guide-config_params-guc-list.html#gp_add_column_inherits_table_setting

Field

Description

effectiveConfig

GreenplumConfig6

Required field. Effective settings for a Greenplum (a combination of settings defined
in userConfig and defaultConfig).

userConfig

GreenplumConfig6

User-defined settings for a Greenplum.

defaultConfig

GreenplumConfig6

Default configuration for a Greenplum.

Field

Description

maxConnections

string (int64)

Maximum number of inbound connections on master segment

maxSlotWalKeepSize

string (int64)

Specify the maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time.
https://www.postgresql.org/docs/current/runtime-config-replication.html

gpWorkfileLimitPerSegment

string (int64)

Sets the maximum total disk size that all running queries are allowed to use for creating temporary spill files at each segment.
The default value is 0, which means a limit is not enforced.
https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_limit_per_segment

gpWorkfileLimitPerQuery

string (int64)

Sets the maximum disk size an individual query is allowed to use for creating temporary spill files at each segment.
The default value is 0, which means a limit is not enforced.
https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_limit_per_query

gpWorkfileLimitFilesPerQuery

string (int64)

Sets the maximum number of temporary spill files (also known as workfiles) allowed per query per segment.
Spill files are created when executing a query that requires more memory than it is allocated.
The current query is terminated when the limit is exceeded.
Set the value to 0 (zero) to allow an unlimited number of spill files. master session reload
https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_limit_files_per_query
Default value is 10000

maxPreparedTransactions

string (int64)

Sets the maximum number of transactions that can be in the "prepared" state simultaneously
https://www.postgresql.org/docs/9.6/runtime-config-resource.html

gpWorkfileCompression

boolean

Specifies whether the temporary files created, when a hash aggregation or hash join operation spills to disk, are compressed.
https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_compression

maxStatementMem

string (int64)

Sets the maximum memory limit for a query. Helps avoid out-of-memory errors on a segment host during query processing as a result of setting statement_mem too high.
Taking into account the configuration of a single segment host, calculate max_statement_mem as follows:
(seghost_physical_memory) / (average_number_concurrent_queries)
When changing both max_statement_mem and statement_mem, max_statement_mem must be changed first, or listed first in the postgresql.conf file.
https://greenplum.docs.pivotal.io/6-19/ref_guide/config_params/guc-list.html#max_statement_mem
Default value is 2097152000 (2000MB)

logStatement

enum (LogStatement)

Controls which SQL statements are logged. DDL logs all data definition commands like CREATE, ALTER, and DROP commands.
MOD logs all DDL statements, plus INSERT, UPDATE, DELETE, TRUNCATE, and COPY FROM.
PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command is of an appropriate type.
https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#log_statement
Default value is ddl

• LOG_STATEMENT_UNSPECIFIED
• NONE: None statements are logged.
• DDL: Logs all data definition commands like CREATE, ALTER, and DROP. Default value.
• MOD: Logs all DDL statements, plus INSERT, UPDATE, DELETE, TRUNCATE, and COPY FROM.
• ALL: Logs all statements.

gpAddColumnInheritsTableSetting

boolean

https://docs.vmware.com/en/VMware-Tanzu-Greenplum/6/greenplum-database/GUID-ref_guide-config_params-guc-list.html#gp_add_column_inherits_table_setting

gpEnableGlobalDeadlockDetector

boolean

Controls whether the Greenplum Database Global Deadlock Detector is enabled to manage concurrent UPDATE and DELETE operations on heap tables to improve performance. See Inserting, Updating, and Deleting Datain the Greenplum Database Administrator Guide. The default is off, the Global Deadlock Detector is deactivated.
If the Global Deadlock Detector is deactivated (the default), Greenplum Database runs concurrent update and delete operations on a heap table serially.
If the Global Deadlock Detector is enabled, concurrent updates are permitted and the Global Deadlock Detector determines when a deadlock exists, and breaks the deadlock by cancelling one or more backend processes associated with the youngest transaction(s) involved.
https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_enable_global_deadlock_detector

gpGlobalDeadlockDetectorPeriod

string (int64)

Specifies the executing interval (in seconds) of the global deadlock detector background worker process.
https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_global_deadlock_detector_period

Field

Description

effectiveConfig

ConnectionPoolerConfig

Required field. Effective settings for an Odyssey® pooler (a combination of settings defined in ConnectionPoolerConfigSet.userConfig and ConnectionPoolerConfigSet.defaultConfig).

userConfig

ConnectionPoolerConfig

User-defined settings for an Odyssey® pooler.

defaultConfig

ConnectionPoolerConfig

Default configuration for an Odyssey® pooler.

Field

Description

mode

enum (PoolMode)

Route server pool mode.

• POOL_MODE_UNSPECIFIED
• SESSION: Assign server connection to a client until it disconnects. Default value.
• TRANSACTION: Assign server connection to a client for a transaction processing.

size

string (int64)

The number of servers in the server pool. Clients are placed in a wait queue when all servers are busy.

Set to zero to disable the limit.

clientIdleTimeout

string (int64)

Client pool idle timeout, in seconds.

Drop stale client connection after this much seconds of idleness, which is not in transaction.

Set to zero to disable.

idleInTransactionTimeout

string (int64)

Client pool idle in transaction timeout, in seconds.

Drop client connection in transaction after this much seconds of idleness.

Set to zero to disable.

Field

Description

tableSizes

TableSizes

Enables scripts that collects tables sizes to *_sizes tables in mdb_toolkit schema.

analyzeAndVacuum

AnalyzeAndVacuum

Configuration for ANALYZE and VACUUM operations.

queryKillerScripts

QueryKillerScripts

Configuration for long running queries killer.

Field

Description

starts[]

BackgroundActivityStartAt

Field

Description

hours

string (int64)

minutes

string (int64)

Field

Description

start

BackgroundActivityStartAt

analyzeTimeout

string (int64)

Maximum duration of the ANALYZE operation, in seconds. The default value is 36000. As soon as this period expires, the ANALYZE operation will be forced to terminate.

vacuumTimeout

string (int64)

Maximum duration of the VACUUM operation, in seconds. The default value is 36000. As soon as this period expires, the VACUUM operation will be forced to terminate.

Field

Description

idle

QueryKiller

Configuration of script that kills long running queries that are in idle state.

idleInTransaction

QueryKiller

Configuration of script that kills long running queries that are in idle in transaction state.

longRunning

QueryKiller

Configuration of script that kills long running queries (in any state).

Field

Description

enable

boolean

maxAge

string (int64)

Maximum duration for this type of queries (in seconds).

ignoreUsers[]

string

Ignore these users when considering queries to terminate

Field

Description

effectiveConfig

PXFConfig

Required field.

userConfig

PXFConfig

User-defined settings.

defaultConfig

PXFConfig

Default configuration.

Field

Description

connectionTimeout

string (int64)

Timeout for connection to the Apache Tomcat® server when making read requests.

Specify values in seconds.

uploadTimeout

string (int64)

Timeout for connection to the Apache Tomcat® server when making write requests.

Specify the values in seconds.

maxThreads

string (int64)

Maximum number of the Apache Tomcat® threads.

To prevent situations when requests get stuck or fail due to running out of memory or malfunctioning of the Java garbage collector, specify the number of the Apache Tomcat® threads. Learn more about adjusting the number of threads in the VMware Greenplum® Platform Extension Framework documentation.

poolAllowCoreThreadTimeout

boolean

Determines whether the timeout for core streaming threads is permitted.

poolCoreSize

string (int64)

Number of core streaming threads per pool.

poolQueueCapacity

string (int64)

Maximum number of requests you can add to a pool queue for core streaming threads.

If 0, no pool queue is generated.

poolMaxSize

string (int64)

Maximum allowed number of core streaming threads.

xmx

string (int64)

Initial size, in megabytes, of the JVM heap for the PXF daemon.

xms

string (int64)

Maximum size, in megabytes, of the JVM heap for the PXF daemon.

Field

Description

enable

boolean

enable Cloud Storage for cluster

Field

Description

enabled

boolean

folderId

string

Includes only one of the fields folderId, logGroupId.

logGroupId

string

Includes only one of the fields folderId, logGroupId.

commandCenterEnabled

boolean

send Yandex Command Center logs

greenplumEnabled

boolean

send Greenplum logs

poolerEnabled

boolean

send Pooler logs