Skip to main content

Add PostgreSQL Cluster Instance​

Select

SaaS
Customer Managed

This operation adds PostgreSQL Cluster Instance for a Cluster client. Please make sure that a PostgreSQL cluster client with the same name as instance is already created.

Request Body
  • instanceProperties object
  • instance object
  • instanceName string required

    Instance Name

  • applicationId integer required

    Default value: 125

    PostgreSQL app ID

  • clientName string required

    Cluster client Name under which instance needs to be created

  • planEntity object
  • planName string required

    Plan Name

  • postGreSQLInstance object
  • standbyOptions object
  • useMasterForDataBkp boolean required

    Default value: true

    Flag to determine if master can be used for data backup if all the standby nodes are down.

  • useMasterForLogBkp boolean required

    Default value: false

    Flag to specify whether log backups should always occur on the master node.

  • nodes object[]
  • physicalClient object
  • clientName string required

    Cluster node name

  • postgresProps object
  • ArchiveLogDirectory string

    Archive log directory path

  • BinaryDirectory string required

    PostgreSQL binary Directory

  • DBRole integer required

    Default value: 3

    Database role:

    Master: 1, Standby: 2, Unknown: 3

  • LibDirectory string required

    PostgreSQL library Directory

  • MaintainenceDB string required

    Maintainence Database for connection

  • managerBinDir string

    Cluster manager binary directory

  • managerConfig string

    Cluster manager config file path

  • port string required

    Database port

  • SAUser object
  • userName string required

    Database user

  • password string required

    Database password encoded in Base64

  • clusterPriority integer required

    The priority level of the cluster node. Each node in the cluster instance must have a unique priority, starting with 0 as the highest priority.

  • dbClusterManager integer required

    Possible values: >= 1 and <= 4

    PostgreSQL cluster manager type. 1=Patroni cluster 2=EDB Failover Manager 3=Repmgr for Postgres 4=Native Replication

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer
  • clientId integer
  • instanceName string

    Created cluster instance Name

  • instanceId integer

    Instance ID

  • _type_ integer
POST /instance

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
token
Content-Type
Body
{

  "instanceProperties": {

    "instance": {

      "instanceName": "string",

      "applicationId": 125,

      "clientName": "string"

    },

    "planEntity": {

      "planName": "string"

    },

    "postGreSQLInstance": {

      "standbyOptions": {

        "useMasterForDataBkp": true,

        "useMasterForLogBkp": false

      },

      "nodes": [

        {

          "physicalClient": {

            "clientName": "string"

          },

          "postgresProps": {

            "ArchiveLogDirectory": "string",

            "BinaryDirectory": "string",

            "DBRole": 3,

            "LibDirectory": "string",

            "MaintainenceDB": "string",

            "managerBinDir": "string",

            "managerConfig": "string",

            "port": "string",

            "SAUser": {

              "userName": "string",

              "password": "string"

            }

          },

          "clusterPriority": 0

        }

      ],

      "dbClusterManager": 1

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/INstance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 125,
      "clientName": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "postGreSQLInstance": {
      "standbyOptions": {
        "useMasterForDataBkp": true,
        "useMasterForLogBkp": false
      },
      "nodes": [
        {
          "physicalClient": {
            "clientName": "string"
          },
          "postgresProps": {
            "ArchiveLogDirectory": "string",
            "BinaryDirectory": "string",
            "DBRole": 3,
            "LibDirectory": "string",
            "MaintainenceDB": "string",
            "managerBinDir": "string",
            "managerConfig": "string",
            "port": "string",
            "SAUser": {
              "userName": "string",
              "password": "string"
            }
          },
          "clusterPriority": 0
        }
      ],
      "dbClusterManager": 1
    }
  }
}'