Method addHosts

Creates new hosts for a cluster.

HTTP request

POST https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/{clusterId}/hosts:batchCreate

Path parameters

Parameter Description
clusterId Required. ID of the PostgreSQL cluster to add hosts to. To get the PostgreSQL cluster ID, use a list request. The maximum string length in characters is 50.

Body parameters

{
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "assignPublicIp": true,
      "replicationSource": "string",
      "priority": "integer",
      "configSpec": {

        // `hostSpecs[].configSpec` includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10`, `postgresqlConfig_11`
        "postgresqlConfig_9_6": {
          "recoveryMinApplyDelay": "integer",
          "sharedBuffers": "integer",
          "tempBuffers": "integer",
          "workMem": "integer",
          "replacementSortTuples": "integer",
          "tempFileLimit": "integer",
          "backendFlushAfter": "integer",
          "oldSnapshotThreshold": "integer",
          "maxStandbyStreamingDelay": "integer",
          "constraintExclusion": "string",
          "cursorTupleFraction": "number",
          "fromCollapseLimit": "integer",
          "joinCollapseLimit": "integer",
          "forceParallelMode": "string",
          "clientMinMessages": "string",
          "logMinMessages": "string",
          "logMinErrorStatement": "string",
          "logMinDurationStatement": "integer",
          "logCheckpoints": true,
          "logConnections": true,
          "logDisconnections": true,
          "logDuration": true,
          "logErrorVerbosity": "string",
          "logLockWaits": true,
          "logStatement": "string",
          "logTempFiles": "integer",
          "searchPath": "string",
          "rowSecurity": true,
          "defaultTransactionIsolation": "string",
          "statementTimeout": "integer",
          "lockTimeout": "integer",
          "idleInTransactionSessionTimeout": "integer",
          "byteaOutput": "string",
          "xmlbinary": "string",
          "xmloption": "string",
          "ginPendingListLimit": "integer",
          "deadlockTimeout": "integer",
          "maxLocksPerTransaction": "integer",
          "maxPredLocksPerTransaction": "integer",
          "arrayNulls": true,
          "backslashQuote": "string",
          "defaultWithOids": true,
          "escapeStringWarning": true,
          "loCompatPrivileges": true,
          "operatorPrecedenceWarning": true,
          "quoteAllIdentifiers": true,
          "standardConformingStrings": true,
          "synchronizeSeqscans": true,
          "transformNullEquals": true,
          "exitOnError": true,
          "seqPageCost": "number",
          "randomPageCost": "number",
          "sqlInheritance": true
        },
        "postgresqlConfig_10": {
          "recoveryMinApplyDelay": "integer",
          "sharedBuffers": "integer",
          "tempBuffers": "integer",
          "workMem": "integer",
          "replacementSortTuples": "integer",
          "tempFileLimit": "integer",
          "backendFlushAfter": "integer",
          "oldSnapshotThreshold": "integer",
          "maxStandbyStreamingDelay": "integer",
          "constraintExclusion": "string",
          "cursorTupleFraction": "number",
          "fromCollapseLimit": "integer",
          "joinCollapseLimit": "integer",
          "forceParallelMode": "string",
          "clientMinMessages": "string",
          "logMinMessages": "string",
          "logMinErrorStatement": "string",
          "logMinDurationStatement": "integer",
          "logCheckpoints": true,
          "logConnections": true,
          "logDisconnections": true,
          "logDuration": true,
          "logErrorVerbosity": "string",
          "logLockWaits": true,
          "logStatement": "string",
          "logTempFiles": "integer",
          "searchPath": "string",
          "rowSecurity": true,
          "defaultTransactionIsolation": "string",
          "statementTimeout": "integer",
          "lockTimeout": "integer",
          "idleInTransactionSessionTimeout": "integer",
          "byteaOutput": "string",
          "xmlbinary": "string",
          "xmloption": "string",
          "ginPendingListLimit": "integer",
          "deadlockTimeout": "integer",
          "maxLocksPerTransaction": "integer",
          "maxPredLocksPerTransaction": "integer",
          "arrayNulls": true,
          "backslashQuote": "string",
          "defaultWithOids": true,
          "escapeStringWarning": true,
          "loCompatPrivileges": true,
          "operatorPrecedenceWarning": true,
          "quoteAllIdentifiers": true,
          "standardConformingStrings": true,
          "synchronizeSeqscans": true,
          "transformNullEquals": true,
          "exitOnError": true,
          "seqPageCost": "number",
          "randomPageCost": "number",
          "enableBitmapscan": true,
          "enableHashagg": true,
          "enableHashjoin": true,
          "enableIndexscan": true,
          "enableIndexonlyscan": true,
          "enableMaterial": true,
          "enableMergejoin": true,
          "enableNestloop": true,
          "enableSeqscan": true,
          "enableSort": true,
          "enableTidscan": true,
          "maxParallelWorkers": "integer",
          "maxParallelWorkersPerGather": "integer",
          "timezone": "string"
        },
        "postgresqlConfig_11": {
          "recoveryMinApplyDelay": "integer",
          "sharedBuffers": "integer",
          "tempBuffers": "integer",
          "workMem": "integer",
          "tempFileLimit": "integer",
          "backendFlushAfter": "integer",
          "oldSnapshotThreshold": "integer",
          "maxStandbyStreamingDelay": "integer",
          "constraintExclusion": "string",
          "cursorTupleFraction": "number",
          "fromCollapseLimit": "integer",
          "joinCollapseLimit": "integer",
          "forceParallelMode": "string",
          "clientMinMessages": "string",
          "logMinMessages": "string",
          "logMinErrorStatement": "string",
          "logMinDurationStatement": "integer",
          "logCheckpoints": true,
          "logConnections": true,
          "logDisconnections": true,
          "logDuration": true,
          "logErrorVerbosity": "string",
          "logLockWaits": true,
          "logStatement": "string",
          "logTempFiles": "integer",
          "searchPath": "string",
          "rowSecurity": true,
          "defaultTransactionIsolation": "string",
          "statementTimeout": "integer",
          "lockTimeout": "integer",
          "idleInTransactionSessionTimeout": "integer",
          "byteaOutput": "string",
          "xmlbinary": "string",
          "xmloption": "string",
          "ginPendingListLimit": "integer",
          "deadlockTimeout": "integer",
          "maxLocksPerTransaction": "integer",
          "maxPredLocksPerTransaction": "integer",
          "arrayNulls": true,
          "backslashQuote": "string",
          "defaultWithOids": true,
          "escapeStringWarning": true,
          "loCompatPrivileges": true,
          "operatorPrecedenceWarning": true,
          "quoteAllIdentifiers": true,
          "standardConformingStrings": true,
          "synchronizeSeqscans": true,
          "transformNullEquals": true,
          "exitOnError": true,
          "seqPageCost": "number",
          "randomPageCost": "number",
          "enableBitmapscan": true,
          "enableHashagg": true,
          "enableHashjoin": true,
          "enableIndexscan": true,
          "enableIndexonlyscan": true,
          "enableMaterial": true,
          "enableMergejoin": true,
          "enableNestloop": true,
          "enableSeqscan": true,
          "enableSort": true,
          "enableTidscan": true,
          "maxParallelWorkers": "integer",
          "maxParallelWorkersPerGather": "integer",
          "timezone": "string"
        },
        // end of the list of possible fields`hostSpecs[].configSpec`

      }
    }
  ]
}
Field Description
hostSpecs[] object

Required. Configurations for PostgreSQL hosts that should be added to the cluster.

Must contain at least one element.

hostSpecs[].
zoneId
string

ID of the availability zone where the host resides. To get a list of available zones, use the list request.

The maximum string length in characters is 50.

hostSpecs[].
subnetId
string

ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.networkId.

The maximum string length in characters is 50.

hostSpecs[].
assignPublicIp
boolean (boolean)

Whether the host should get a public IP address on creation.

After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assignPublicIp set as needed.

Possible values:

  • false — don't assign a public IP to the host.
  • true — the host should have a public IP address.
hostSpecs[].
replicationSource
string

name of the host to be used as the replication source (for cascading replication).

hostSpecs[].
priority
integer (int64)

Priority of the host as a replica. A higher value corresponds to higher priority.

The host with the highest priority is the synchronous replica. All others are asynchronous. The synchronous replica replaces the master when needed.

When a replica becomes the master, its priority is ignored.

hostSpecs[].
configSpec
object

Configuration of a PostgreSQL server for the host.

hostSpecs[].
configSpec.
postgresqlConfig_9_6
object
Configuration for a host with PostgreSQL 9.6 server deployed.
hostSpecs[].configSpec includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10, postgresqlConfig_11

Options and structure of PostgresqlHostConfig reflects parameters of a PostgreSQL configuration file. Detailed description is available in PostgreSQL documentation.

hostSpecs[].
configSpec.
postgresqlConfig_9_6.
recoveryMinApplyDelay
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
sharedBuffers
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
tempBuffers
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
workMem
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
replacementSortTuples
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
tempFileLimit
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
backendFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_9_6.
oldSnapshotThreshold
integer (int64)

Acceptable values are -1 to 86400, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_9_6.
maxStandbyStreamingDelay
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
constraintExclusion
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
cursorTupleFraction
number (double)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
fromCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_9_6.
joinCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_9_6.
forceParallelMode
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
clientMinMessages
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
logMinMessages
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
logMinErrorStatement
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
logMinDurationStatement
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
logCheckpoints
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
logConnections
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
logDisconnections
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
logDuration
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
logErrorVerbosity
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
logLockWaits
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
logStatement
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
logTempFiles
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
searchPath
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
rowSecurity
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
defaultTransactionIsolation
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
statementTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
lockTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
idleInTransactionSessionTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
byteaOutput
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
xmlbinary
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
xmloption
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
ginPendingListLimit
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
deadlockTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
maxLocksPerTransaction
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
maxPredLocksPerTransaction
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
arrayNulls
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
backslashQuote
string
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
defaultWithOids
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
escapeStringWarning
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
loCompatPrivileges
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
operatorPrecedenceWarning
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
quoteAllIdentifiers
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
standardConformingStrings
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
synchronizeSeqscans
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
transformNullEquals
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
exitOnError
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
seqPageCost
number (double)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
randomPageCost
number (double)
hostSpecs[].
configSpec.
postgresqlConfig_9_6.
sqlInheritance
boolean (boolean)

This option has been removed in PostgreSQL 10.

hostSpecs[].
configSpec.
postgresqlConfig_10
object
Configuration for a host with PostgreSQL 10 server deployed.
hostSpecs[].configSpec includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10, postgresqlConfig_11

Options and structure of PostgresqlHostConfig reflects PostgreSQL configuration file parameters whose detailed description is available in PostgreSQL documentation.

hostSpecs[].
configSpec.
postgresqlConfig_10.
recoveryMinApplyDelay
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
sharedBuffers
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
tempBuffers
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
workMem
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
replacementSortTuples
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
tempFileLimit
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
backendFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_10.
oldSnapshotThreshold
integer (int64)

Acceptable values are -1 to 86400, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_10.
maxStandbyStreamingDelay
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
constraintExclusion
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
cursorTupleFraction
number (double)
hostSpecs[].
configSpec.
postgresqlConfig_10.
fromCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_10.
joinCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_10.
forceParallelMode
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
clientMinMessages
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
logMinMessages
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
logMinErrorStatement
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
logMinDurationStatement
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
logCheckpoints
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
logConnections
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
logDisconnections
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
logDuration
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
logErrorVerbosity
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
logLockWaits
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
logStatement
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
logTempFiles
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
searchPath
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
rowSecurity
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
defaultTransactionIsolation
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
statementTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
lockTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
idleInTransactionSessionTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
byteaOutput
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
xmlbinary
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
xmloption
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
ginPendingListLimit
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
deadlockTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
maxLocksPerTransaction
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
maxPredLocksPerTransaction
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_10.
arrayNulls
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
backslashQuote
string
hostSpecs[].
configSpec.
postgresqlConfig_10.
defaultWithOids
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
escapeStringWarning
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
loCompatPrivileges
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
operatorPrecedenceWarning
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
quoteAllIdentifiers
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
standardConformingStrings
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
synchronizeSeqscans
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
transformNullEquals
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
exitOnError
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
seqPageCost
number (double)
hostSpecs[].
configSpec.
postgresqlConfig_10.
randomPageCost
number (double)
hostSpecs[].
configSpec.
postgresqlConfig_10.
enableBitmapscan
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
enableHashagg
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
enableHashjoin
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
enableIndexscan
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
enableIndexonlyscan
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
enableMaterial
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
enableMergejoin
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
enableNestloop
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
enableSeqscan
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
enableSort
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
enableTidscan
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_10.
maxParallelWorkers
integer (int64)

Acceptable values are 0 to 1024, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_10.
maxParallelWorkersPerGather
integer (int64)

Acceptable values are 0 to 1024, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_10.
timezone
string
hostSpecs[].
configSpec.
postgresqlConfig_11
object
Configuration for a host with PostgreSQL 11 server deployed.
hostSpecs[].configSpec includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10, postgresqlConfig_11

Options and structure of PostgresqlConfig reflects PostgreSQL configuration file parameters which detailed description is available in PostgreSQL documentation.

hostSpecs[].
configSpec.
postgresqlConfig_11.
recoveryMinApplyDelay
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
sharedBuffers
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
tempBuffers
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
workMem
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
tempFileLimit
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
backendFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_11.
oldSnapshotThreshold
integer (int64)

Acceptable values are -1 to 86400, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_11.
maxStandbyStreamingDelay
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
constraintExclusion
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
cursorTupleFraction
number (double)
hostSpecs[].
configSpec.
postgresqlConfig_11.
fromCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_11.
joinCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_11.
forceParallelMode
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
clientMinMessages
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
logMinMessages
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
logMinErrorStatement
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
logMinDurationStatement
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
logCheckpoints
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
logConnections
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
logDisconnections
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
logDuration
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
logErrorVerbosity
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
logLockWaits
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
logStatement
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
logTempFiles
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
searchPath
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
rowSecurity
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
defaultTransactionIsolation
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
statementTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
lockTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
idleInTransactionSessionTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
byteaOutput
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
xmlbinary
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
xmloption
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
ginPendingListLimit
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
deadlockTimeout
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
maxLocksPerTransaction
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
maxPredLocksPerTransaction
integer (int64)
hostSpecs[].
configSpec.
postgresqlConfig_11.
arrayNulls
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
backslashQuote
string
hostSpecs[].
configSpec.
postgresqlConfig_11.
defaultWithOids
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
escapeStringWarning
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
loCompatPrivileges
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
operatorPrecedenceWarning
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
quoteAllIdentifiers
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
standardConformingStrings
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
synchronizeSeqscans
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
transformNullEquals
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
exitOnError
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
seqPageCost
number (double)
hostSpecs[].
configSpec.
postgresqlConfig_11.
randomPageCost
number (double)
hostSpecs[].
configSpec.
postgresqlConfig_11.
enableBitmapscan
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
enableHashagg
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
enableHashjoin
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
enableIndexscan
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
enableIndexonlyscan
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
enableMaterial
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
enableMergejoin
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
enableNestloop
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
enableSeqscan
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
enableSort
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
enableTidscan
boolean (boolean)
hostSpecs[].
configSpec.
postgresqlConfig_11.
maxParallelWorkers
integer (int64)

Acceptable values are 0 to 1024, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_11.
maxParallelWorkersPerGather
integer (int64)

Acceptable values are 0 to 1024, inclusive.

hostSpecs[].
configSpec.
postgresqlConfig_11.
timezone
string

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // 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.

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.

done boolean (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 object

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 object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response

The error result of the operation in case of failure or cancellation.

error.
code
integer (int32)

Error code. An enum value of google.rpc.Code.

error.
message
string

An error message.

error.
details[]
object

A list of messages that carry the error details.

response object
includes only one of the fields error, response

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.