Modify PostgreSQL Cluster Instance

This operation is used to modify PostgreSQL Cluster instance property

Path Parameters

• instanceId integer required

  InstanceId of the PostgreSQL Instance

application/json

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

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

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

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "string",
      "entity": {
        "subclientId": 0,
        "clientId": 0,
        "instanceName": "string",
        "instanceId": 0,
        "_type_": 0
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "",
      "entity": {
        "subclientId": 0,
        "clientId": 0,
        "instanceName": "",
        "instanceId": 0,
        "_type_": 0
      }
    }
  ]
}

Bad Request

application/json

• Schema
• Example

---

Schema

• string

Request body is empty or format is invalid.

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

Forbidden

application/json

• Schema
• Example (from schema)
• Example 2

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "User does not have permission on the entity.",
  "errorCode": 587205847
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Failed to update properties because jobs are in progress for the Instance",
  "errorCode": 1
}

Loading...