Подключиться
Yandex Managed Service for Greenplum®

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

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

Retrieves a list of Greenplum® clusters that belong to the specified folder.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters

Query parameters

Parameter Description
folderId

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

To get the folder ID, use a list request.

The maximum string length in characters is 50.
pageSize

The maximum number of results per page to return.

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

The maximum value is 1000.
pageToken

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

The maximum string length in characters is 100.
filter

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

The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "config": {
        "version": "string",
        "backupWindowStart": {
          "hours": "integer",
          "minutes": "integer",
          "seconds": "integer",
          "nanos": "integer"
        },
        "access": {
          "dataLens": true,
          "webSql": true,
          "dataTransfer": true
        },
        "zoneId": "string",
        "subnetId": "string",
        "assignPublicIp": true
      },
      "description": "string",
      "labels": "object",
      "environment": "string",
      "monitoring": [
        {
          "name": "string",
          "description": "string",
          "link": "string"
        }
      ],
      "masterConfig": {
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "segmentConfig": {
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "masterHostCount": "string",
      "segmentHostCount": "string",
      "segmentInHost": "string",
      "networkId": "string",
      "health": "string",
      "status": "string",
      "maintenanceWindow": {

        // `clusters[].maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
        "anytime": {},
        "weeklyMaintenanceWindow": {
          "day": "string",
          "hour": "string"
        },
        // end of the list of possible fields`clusters[].maintenanceWindow`

      },
      "plannedOperation": {
        "info": "string",
        "delayedUntil": "string"
      },
      "securityGroupIds": [
        "string"
      ],
      "userName": "string",
      "deletionProtection": true,
      "hostGroupIds": [
        "string"
      ],
      "clusterConfig": {
        "pool": {
          "effectiveConfig": {
            "mode": "string",
            "size": "integer",
            "clientIdleTimeout": "integer"
          },
          "userConfig": {
            "mode": "string",
            "size": "integer",
            "clientIdleTimeout": "integer"
          },
          "defaultConfig": {
            "mode": "string",
            "size": "integer",
            "clientIdleTimeout": "integer"
          }
        },

        // `clusters[].clusterConfig` includes only one of the fields `greenplumConfigSet_6_17`, `greenplumConfigSet_6_19`
        "greenplumConfigSet_6_17": {
          "effectiveConfig": {
            "maxConnections": "integer",
            "maxSlotWalKeepSize": "integer",
            "gpWorkfileLimitPerSegment": "integer",
            "gpWorkfileLimitPerQuery": "integer",
            "gpWorkfileLimitFilesPerQuery": "integer",
            "maxPreparedTransactions": "integer",
            "gpWorkfileCompression": true
          },
          "userConfig": {
            "maxConnections": "integer",
            "maxSlotWalKeepSize": "integer",
            "gpWorkfileLimitPerSegment": "integer",
            "gpWorkfileLimitPerQuery": "integer",
            "gpWorkfileLimitFilesPerQuery": "integer",
            "maxPreparedTransactions": "integer",
            "gpWorkfileCompression": true
          },
          "defaultConfig": {
            "maxConnections": "integer",
            "maxSlotWalKeepSize": "integer",
            "gpWorkfileLimitPerSegment": "integer",
            "gpWorkfileLimitPerQuery": "integer",
            "gpWorkfileLimitFilesPerQuery": "integer",
            "maxPreparedTransactions": "integer",
            "gpWorkfileCompression": true
          }
        },
        "greenplumConfigSet_6_19": {
          "effectiveConfig": {
            "maxConnections": "integer",
            "maxSlotWalKeepSize": "integer",
            "gpWorkfileLimitPerSegment": "integer",
            "gpWorkfileLimitPerQuery": "integer",
            "gpWorkfileLimitFilesPerQuery": "integer",
            "maxPreparedTransactions": "integer",
            "gpWorkfileCompression": true,
            "maxStatementMem": "integer",
            "logStatement": "string"
          },
          "userConfig": {
            "maxConnections": "integer",
            "maxSlotWalKeepSize": "integer",
            "gpWorkfileLimitPerSegment": "integer",
            "gpWorkfileLimitPerQuery": "integer",
            "gpWorkfileLimitFilesPerQuery": "integer",
            "maxPreparedTransactions": "integer",
            "gpWorkfileCompression": true,
            "maxStatementMem": "integer",
            "logStatement": "string"
          },
          "defaultConfig": {
            "maxConnections": "integer",
            "maxSlotWalKeepSize": "integer",
            "gpWorkfileLimitPerSegment": "integer",
            "gpWorkfileLimitPerQuery": "integer",
            "gpWorkfileLimitFilesPerQuery": "integer",
            "maxPreparedTransactions": "integer",
            "gpWorkfileCompression": true,
            "maxStatementMem": "integer",
            "logStatement": "string"
          }
        },
        // end of the list of possible fields`clusters[].clusterConfig`

      }
    }
  ],
  "nextPageToken": "string"
}
Field Description
clusters[] object

List of Greenplum® cluster resources.
clusters[].
id		 string

ID of the Greenplum® cluster. This ID is assigned by the platform at the moment of cluster creation.
clusters[].
folderId		 string

ID of the folder that the Greenplum® cluster belongs to.
clusters[].
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).
clusters[].
name		 string

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

The maximum string length in characters is 63.
clusters[].
config		 object

Greenplum® cluster configuration.
clusters[].
config.
version		 string

Version of the Greenplum® server software.
clusters[].
config.
backupWindowStart		 object

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

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
clusters[].
config.
backupWindowStart.
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.
clusters[].
config.
backupWindowStart.
minutes		 integer (int32)

Minutes of hour of day. Must be from 0 to 59.
clusters[].
config.
backupWindowStart.
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.
clusters[].
config.
backupWindowStart.
nanos		 integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
clusters[].
config.
access		 object

Access policy for external services.
clusters[].
config.
access.
dataLens		 boolean (boolean)

Allows data export from the cluster to DataLens.
clusters[].
config.
access.
webSql		 boolean (boolean)

Allows SQL queries to the cluster databases from the management console.
clusters[].
config.
access.
dataTransfer		 boolean (boolean)

Allows access for DataTransfer.
clusters[].
config.
zoneId		 string

ID of the availability zone the cluster belongs to. To get a list of available zones, use the list request.

The maximum string length in characters is 50.
clusters[].
config.
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).

The maximum string length in characters is 50.
clusters[].
config.
assignPublicIp		 boolean (boolean)

Determines whether the cluster has a public IP address.

After the cluster has been created, this setting cannot be changed.
clusters[].
description		 string

Description of the Greenplum® cluster.

The maximum string length in characters is 256.
clusters[].
labels		 object

Custom labels for the Greenplum® cluster as key:value pairs. Maximum 64 labels per resource.
clusters[].
environment		 string

Deployment environment of the Greenplum® cluster.

  • 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.
clusters[].
monitoring[]		 object

Description of monitoring systems relevant to the Greenplum® cluster.
clusters[].
monitoring[].
name		 string

Name of the monitoring system.
clusters[].
monitoring[].
description		 string

Description of the monitoring system.
clusters[].
monitoring[].
link		 string

Link to the monitoring system charts for the Greenplum® cluster.
clusters[].
masterConfig		 object

Configuration of the Greenplum® master subcluster.
clusters[].
masterConfig.
resources		 object

Computational resources allocated to Greenplum® master subcluster hosts.
clusters[].
masterConfig.
resources.
resourcePresetId		 string

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

Available presets are listed in the documentation.
clusters[].
masterConfig.
resources.
diskSize		 string (int64)

Volume of the storage used by the host, in bytes.
clusters[].
masterConfig.
resources.
diskTypeId		 string

Type of the storage used by the host: network-hdd, network-ssd or local-ssd.
clusters[].
segmentConfig		 object

Configuration of the Greenplum® segment subcluster.
clusters[].
segmentConfig.
resources		 object

Computational resources allocated to Greenplum® segment subcluster hosts.
clusters[].
segmentConfig.
resources.
resourcePresetId		 string

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

Available presets are listed in the documentation.
clusters[].
segmentConfig.
resources.
diskSize		 string (int64)

Volume of the storage used by the host, in bytes.
clusters[].
segmentConfig.
resources.
diskTypeId		 string

Type of the storage used by the host: network-hdd, network-ssd or local-ssd.
clusters[].
masterHostCount		 string (int64)

Number of hosts in the master subcluster.
clusters[].
segmentHostCount		 string (int64)

Number of hosts in the segment subcluster.
clusters[].
segmentInHost		 string (int64)

Number of segments per host.
clusters[].
networkId		 string

ID of the cloud network that the cluster belongs to.
clusters[].
health		 string

Aggregated cluster health.

  • HEALTH_UNKNOWN: Health of the cluster is unknown (health for every host in the cluster is UNKNOWN).
  • ALIVE: Cluster is working normally (health for every host in the cluster is ALIVE).
  • DEAD: Cluster is inoperable (health for every host in the cluster is DEAD).
  • DEGRADED: Cluster is working below capacity (health for at least one host in the cluster is not ALIVE).
  • UNBALANCED: Cluster is working below capacity (health for at least one host in the cluster is UNBALANCED).
clusters[].
status		 string

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.
clusters[].
maintenanceWindow		 object

A Greenplum® cluster maintenance window. Should be defined by either one of the two options.
clusters[].
maintenanceWindow.
anytime		 object
An any-time maintenance window.
clusters[].maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
clusters[].
maintenanceWindow.
weeklyMaintenanceWindow		 object
A weekly maintenance window.
clusters[].maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
clusters[].
maintenanceWindow.
weeklyMaintenanceWindow.
day		 string

Day of the week.

  • MON: Monday
  • TUE: Tuesday
  • WED: Wednesday
  • THU: Thursday
  • FRI: Friday
  • SAT: Saturday
  • SUN: Sunday
clusters[].
maintenanceWindow.
weeklyMaintenanceWindow.
hour		 string (int64)

Hour of the day in the UTC timezone.

Acceptable values are 1 to 24, inclusive.
clusters[].
plannedOperation		 object

Maintenance operation planned at nearest maintenanceWindow.
clusters[].
plannedOperation.
info		 string

The description of the operation.

The maximum string length in characters is 256.
clusters[].
plannedOperation.
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).
clusters[].
securityGroupIds[]		 string

User security groups.
clusters[].
userName		 string

Owner user name.
clusters[].
deletionProtection		 boolean (boolean)

Determines whether the cluster is protected from being deleted.
clusters[].
hostGroupIds[]		 string

Host groups hosting VMs of the cluster.
clusters[].
clusterConfig		 object

Greenplum® and Odyssey® configuration.
clusters[].
clusterConfig.
pool		 object
Odyssey® pool settings.
clusters[].
clusterConfig.
pool.
effectiveConfig		 object

Required. Effective settings for an Odyssey® pooler (a combination of settings defined in userConfig and defaultConfig).
clusters[].
clusterConfig.
pool.
effectiveConfig.
mode		 string

Route server pool mode.

  • SESSION: Assign server connection to a client until it disconnects. Default value.
  • TRANSACTION: Assign server connection to a client for a transaction processing.
clusters[].
clusterConfig.
pool.
effectiveConfig.
size		 integer (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.
clusters[].
clusterConfig.
pool.
effectiveConfig.
clientIdleTimeout		 integer (int64)

Server pool idle timeout, in seconds.

A server connection closes after being idle for the specified time.

Set to zero to disable the limit.
clusters[].
clusterConfig.
pool.
userConfig		 object

User-defined settings for an Odyssey® pooler.
clusters[].
clusterConfig.
pool.
userConfig.
mode		 string

Route server pool mode.

  • SESSION: Assign server connection to a client until it disconnects. Default value.
  • TRANSACTION: Assign server connection to a client for a transaction processing.
clusters[].
clusterConfig.
pool.
userConfig.
size		 integer (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.
clusters[].
clusterConfig.
pool.
userConfig.
clientIdleTimeout		 integer (int64)

Server pool idle timeout, in seconds.

A server connection closes after being idle for the specified time.

Set to zero to disable the limit.
clusters[].
clusterConfig.
pool.
defaultConfig		 object

Default configuration for an Odyssey® pooler.
clusters[].
clusterConfig.
pool.
defaultConfig.
mode		 string

Route server pool mode.

  • SESSION: Assign server connection to a client until it disconnects. Default value.
  • TRANSACTION: Assign server connection to a client for a transaction processing.
clusters[].
clusterConfig.
pool.
defaultConfig.
size		 integer (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.
clusters[].
clusterConfig.
pool.
defaultConfig.
clientIdleTimeout		 integer (int64)

Server pool idle timeout, in seconds.

A server connection closes after being idle for the specified time.

Set to zero to disable the limit.
clusters[].
clusterConfig.
greenplumConfigSet_6_17		 object
clusters[].clusterConfig includes only one of the fields greenplumConfigSet_6_17, greenplumConfigSet_6_19

Configuration settings version 6.17
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
effectiveConfig		 object

Required. Effective settings for a Greenplum® cluster (a combination of settings defined in userConfig and defaultConfig).
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
effectiveConfig.
maxConnections		 integer (int64)

Maximum number of inbound connections on master segment.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
effectiveConfig.
maxSlotWalKeepSize		 integer (int64)

The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
effectiveConfig.
gpWorkfileLimitPerSegment		 integer (int64)

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 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
effectiveConfig.
gpWorkfileLimitPerQuery		 integer (int64)

The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment.

The default value is 0 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
effectiveConfig.
gpWorkfileLimitFilesPerQuery		 integer (int64)

The maximum number of temporary spill files allowed per query at each segment.

Spill files, also known as workfiles, are created when a query requires more memory than there is allocated.

The current query is terminated if the limit is exceeded.

Set to zero to disable the limit.

Master session reloads if the parameter changes.

Default value is 10000.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
effectiveConfig.
maxPreparedTransactions		 integer (int64)

The maximum number of transactions that can be in the prepared state simultaneously.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
effectiveConfig.
gpWorkfileCompression		 boolean (boolean)

Whether the spill files are compressed or not.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
userConfig		 object

User-defined settings for a Greenplum® cluster.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
userConfig.
maxConnections		 integer (int64)

Maximum number of inbound connections on master segment.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
userConfig.
maxSlotWalKeepSize		 integer (int64)

The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
userConfig.
gpWorkfileLimitPerSegment		 integer (int64)

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 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
userConfig.
gpWorkfileLimitPerQuery		 integer (int64)

The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment.

The default value is 0 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
userConfig.
gpWorkfileLimitFilesPerQuery		 integer (int64)

The maximum number of temporary spill files allowed per query at each segment.

Spill files, also known as workfiles, are created when a query requires more memory than there is allocated.

The current query is terminated if the limit is exceeded.

Set to zero to disable the limit.

Master session reloads if the parameter changes.

Default value is 10000.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
userConfig.
maxPreparedTransactions		 integer (int64)

The maximum number of transactions that can be in the prepared state simultaneously.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
userConfig.
gpWorkfileCompression		 boolean (boolean)

Whether the spill files are compressed or not.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
defaultConfig		 object

Default configuration for a Greenplum® cluster.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
defaultConfig.
maxConnections		 integer (int64)

Maximum number of inbound connections on master segment.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
defaultConfig.
maxSlotWalKeepSize		 integer (int64)

The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
defaultConfig.
gpWorkfileLimitPerSegment		 integer (int64)

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 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
defaultConfig.
gpWorkfileLimitPerQuery		 integer (int64)

The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment.

The default value is 0 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
defaultConfig.
gpWorkfileLimitFilesPerQuery		 integer (int64)

The maximum number of temporary spill files allowed per query at each segment.

Spill files, also known as workfiles, are created when a query requires more memory than there is allocated.

The current query is terminated if the limit is exceeded.

Set to zero to disable the limit.

Master session reloads if the parameter changes.

Default value is 10000.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
defaultConfig.
maxPreparedTransactions		 integer (int64)

The maximum number of transactions that can be in the prepared state simultaneously.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_17.
defaultConfig.
gpWorkfileCompression		 boolean (boolean)

Whether the spill files are compressed or not.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19		 object
clusters[].clusterConfig includes only one of the fields greenplumConfigSet_6_17, greenplumConfigSet_6_19

Configuration settings version 6.19
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
effectiveConfig		 object

Required. Effective settings for a Greenplum® cluster (a combination of settings defined in userConfig and defaultConfig).
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
effectiveConfig.
maxConnections		 integer (int64)

Maximum number of inbound connections on master segment.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
effectiveConfig.
maxSlotWalKeepSize		 integer (int64)

The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
effectiveConfig.
gpWorkfileLimitPerSegment		 integer (int64)

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 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
effectiveConfig.
gpWorkfileLimitPerQuery		 integer (int64)

The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment.

The default value is 0 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
effectiveConfig.
gpWorkfileLimitFilesPerQuery		 integer (int64)

The maximum number of temporary spill files allowed per query at each segment.

Spill files, also known as workfiles, are created when a query requires more memory than there is allocated.

The current query is terminated if the limit is exceeded.

Set to zero to disable the limit.

Master session reloads if the parameter changes.

Default value is 10000.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
effectiveConfig.
maxPreparedTransactions		 integer (int64)

The maximum number of transactions that can be in the prepared state simultaneously.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
effectiveConfig.
gpWorkfileCompression		 boolean (boolean)

Whether the spill files are compressed or not.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
effectiveConfig.
maxStatementMem		 integer (int64)

The maximum memory limit for a query, in bytes.

Helps to 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 maxStatementMem as follows: seghost_physical_memory / average_number_concurrent_queries.

When changing both maxStatementMem and statement_mem, maxStatementMem must be changed first, or listed first in the postgresql.conf file.

Default value is 2097152000 (2000 MB).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
effectiveConfig.
logStatement		 string

Logged SQL statements.

PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type.

More info in Greenplum® documentation.

  • 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.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
userConfig		 object

User-defined settings for a Greenplum® cluster.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
userConfig.
maxConnections		 integer (int64)

Maximum number of inbound connections on master segment.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
userConfig.
maxSlotWalKeepSize		 integer (int64)

The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
userConfig.
gpWorkfileLimitPerSegment		 integer (int64)

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 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
userConfig.
gpWorkfileLimitPerQuery		 integer (int64)

The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment.

The default value is 0 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
userConfig.
gpWorkfileLimitFilesPerQuery		 integer (int64)

The maximum number of temporary spill files allowed per query at each segment.

Spill files, also known as workfiles, are created when a query requires more memory than there is allocated.

The current query is terminated if the limit is exceeded.

Set to zero to disable the limit.

Master session reloads if the parameter changes.

Default value is 10000.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
userConfig.
maxPreparedTransactions		 integer (int64)

The maximum number of transactions that can be in the prepared state simultaneously.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
userConfig.
gpWorkfileCompression		 boolean (boolean)

Whether the spill files are compressed or not.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
userConfig.
maxStatementMem		 integer (int64)

The maximum memory limit for a query, in bytes.

Helps to 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 maxStatementMem as follows: seghost_physical_memory / average_number_concurrent_queries.

When changing both maxStatementMem and statement_mem, maxStatementMem must be changed first, or listed first in the postgresql.conf file.

Default value is 2097152000 (2000 MB).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
userConfig.
logStatement		 string

Logged SQL statements.

PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type.

More info in Greenplum® documentation.

  • 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.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
defaultConfig		 object

Default configuration for a Greenplum® cluster.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
defaultConfig.
maxConnections		 integer (int64)

Maximum number of inbound connections on master segment.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
defaultConfig.
maxSlotWalKeepSize		 integer (int64)

The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
defaultConfig.
gpWorkfileLimitPerSegment		 integer (int64)

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 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
defaultConfig.
gpWorkfileLimitPerQuery		 integer (int64)

The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment.

The default value is 0 (no limit).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
defaultConfig.
gpWorkfileLimitFilesPerQuery		 integer (int64)

The maximum number of temporary spill files allowed per query at each segment.

Spill files, also known as workfiles, are created when a query requires more memory than there is allocated.

The current query is terminated if the limit is exceeded.

Set to zero to disable the limit.

Master session reloads if the parameter changes.

Default value is 10000.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
defaultConfig.
maxPreparedTransactions		 integer (int64)

The maximum number of transactions that can be in the prepared state simultaneously.

More info in PostgreSQL® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
defaultConfig.
gpWorkfileCompression		 boolean (boolean)

Whether the spill files are compressed or not.

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
defaultConfig.
maxStatementMem		 integer (int64)

The maximum memory limit for a query, in bytes.

Helps to 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 maxStatementMem as follows: seghost_physical_memory / average_number_concurrent_queries.

When changing both maxStatementMem and statement_mem, maxStatementMem must be changed first, or listed first in the postgresql.conf file.

Default value is 2097152000 (2000 MB).

More info in Greenplum® documentation.
clusters[].
clusterConfig.
greenplumConfigSet_6_19.
defaultConfig.
logStatement		 string

Logged SQL statements.

PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type.

More info in Greenplum® documentation.

  • 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.
nextPageToken string

This token allows you to get the next page of results for list requests.

If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request.

Each subsequent list request has its own nextPageToken to continue paging through the results.
В этой статье: