Skip to main content

Modify PostgreSQL Cluster Instance​

Select

SaaS
Customer Managed

This operation is used to modify PostgreSQL Cluster instance property

Path Parameters
  • instanceId integer required

    InstanceId of the PostgreSQL Instance

Request Body
  • association object
  • entity object[]
  • instanceId integer
  • instanceName string required

    Instance Name

  • applicationId integer required

    Default value: 125

    Instance Name

  • clientId integer
  • clientName string required

    Client Name

  • commCellId integer
  • instanceProperties object
  • instance object
  • instanceId integer
  • instanceName string

    Instance Name

  • applicationId integer
  • clientId integer
  • clientName string
  • commCellId integer
  • planEntity object
  • planId integer

    Plan ID

  • postGreSQLInstance object
  • SAUser object
  • osUser object
  • ArchiveDelete boolean
  • standbyOptions object
  • useMasterForDataBkp boolean
  • useMasterForLogBkp boolean
  • planSchedAssocType integer
  • dbClusterManager string
  • nodes object[]
  • clusterPriority integer

    Cluster node priority

  • physicalClient object
  • clientId integer
  • clientName string

    Cluster node name

  • displayName string
  • postgresProps object
  • DBRole string

    Database role as per last backup:

    master: 1, standby: 2, unknown: 3

  • BinaryDirectory string

    Binary Directory

  • ArchiveLogDirectory string

    Archive log directory

  • managerBinDir string

    Cluster manager Binary Directory

  • MaintainenceDB string

    Maintainence Database

  • LibDirectory string

    Library Directory

  • managerConfig string

    Cluster manager config file path

  • port string

    Database port

  • sslOpt object
  • sslCa string
  • sslEnabled boolean
  • sslKey string
  • sslCert string
  • UNCUser object
  • userName string
  • SAUser object
  • userName string

    Database user

  • osUser object
  • userName string
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
  • instanceId integer
  • _type_ integer
POST /instance/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
token
instanceId — path required
Body
{

  "association": {

    "entity": [

      {

        "instanceId": 0,

        "instanceName": "string",

        "applicationId": 125,

        "clientId": 0,

        "clientName": "string",

        "commCellId": 0

      }

    ]

  },

  "instanceProperties": {

    "instance": {

      "instanceId": 0,

      "instanceName": "string",

      "applicationId": 0,

      "clientId": 0,

      "clientName": "string",

      "commCellId": 0

    },

    "planEntity": {

      "planId": 0

    },

    "postGreSQLInstance": {

      "SAUser": {},

      "osUser": {},

      "ArchiveDelete": true,

      "standbyOptions": {

        "useMasterForDataBkp": true,

        "useMasterForLogBkp": true

      },

      "planSchedAssocType": 0,

      "dbClusterManager": "string",

      "nodes": [

        {

          "clusterPriority": 0,

          "physicalClient": {

            "clientId": 0,

            "clientName": "string",

            "displayName": "string"

          },

          "postgresProps": {

            "DBRole": "string",

            "BinaryDirectory": "string",

            "ArchiveLogDirectory": "string",

            "managerBinDir": "string",

            "MaintainenceDB": "string",

            "LibDirectory": "string",

            "managerConfig": "string",

            "port": "string",

            "sslOpt": {

              "sslCa": "string",

              "sslEnabled": true,

              "sslKey": "string",

              "sslCert": "string"

            },

            "UNCUser": {

              "userName": "string"

            },

            "SAUser": {

              "userName": "string"

            },

            "osUser": {

              "userName": "string"

            }

          }

        }

      ]

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "instanceId": 0,
        "instanceName": "string",
        "applicationId": 125,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 0,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "postGreSQLInstance": {
      "SAUser": {},
      "osUser": {},
      "ArchiveDelete": true,
      "standbyOptions": {
        "useMasterForDataBkp": true,
        "useMasterForLogBkp": true
      },
      "planSchedAssocType": 0,
      "dbClusterManager": "string",
      "nodes": [
        {
          "clusterPriority": 0,
          "physicalClient": {
            "clientId": 0,
            "clientName": "string",
            "displayName": "string"
          },
          "postgresProps": {
            "DBRole": "string",
            "BinaryDirectory": "string",
            "ArchiveLogDirectory": "string",
            "managerBinDir": "string",
            "MaintainenceDB": "string",
            "LibDirectory": "string",
            "managerConfig": "string",
            "port": "string",
            "sslOpt": {
              "sslCa": "string",
              "sslEnabled": true,
              "sslKey": "string",
              "sslCert": "string"
            },
            "UNCUser": {
              "userName": "string"
            },
            "SAUser": {
              "userName": "string"
            },
            "osUser": {
              "userName": "string"
            }
          }
        }
      ]
    }
  }
}'