Modify PostgreSQL Instance
Select
SaaS
Customer Managed
This operation is used to modify PostgreSQL instance property
Path Parameters
- instanceId integer required
InstanceId of the PostgreSQL Instance
- application/json
Request Body
instanceProperties object
instance object
instanceId integerInstance ID
instanceName stringInstance Name
applicationId integerclientId integerClient ID
clientName stringClient Name
commCellId integerplanEntity object
planId integerPlan ID
postGreSQLInstance object
MaintainenceDB stringBinaryDirectory stringBinary directory Path
LibDirectory stringLibrary directory Path
ArchiveLogDirectory stringArchive log directory Path
port stringPort associated with PostgreSQL server
SAUser object
userName stringosUser object
userName stringArchiveDelete booleanstandbyOptions object
isStandbyEnabled boolean
Responses
- 200
- 400
- 401
- 403
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object[]
warningCode integererrorCode integerwarningMessage stringentity object
subclientId integerclientId integerinstanceName stringinstanceId 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...