Add PostgreSQL Instance
Select
SaaS
Customer Managed
This operation adds a PostgreSQL Instance in Client
- application/json
Request Body
instanceProperties object
instance object
instanceId integerinstanceName string requiredName of the Instance to be created
applicationId integer requiredDefault value:
125
clientId integerclientName string requiredClient Name
commCellId integerplanEntity object
planId integer requiredpostGreSQLInstance object
MaintainenceDB string requiredMaintenance DB name
BinaryDirectory string requiredBinary Directory path
LibDirectory string requiredLibrary Directory path
ArchiveLogDirectory stringArchive log Directory path
port string requiredPostgreSQL database server port
SAUser object
userName string requiredDatabase User name
password string requiredDatabase password
osUser object
userName stringOs Username
standbyOptions object
Responses
- 200
- 400
- 401
- 409
- 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 stringName of the instance created
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": 4,
"instanceName": "pgauto1_4414_pg14",
"instanceId": 6884,
"_type_": 0
}
}
}
Bad Request
Response Headers
- 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
}
Conflict
- application/json
- Schema
- Example (from schema)
- Example 2
Schema
- errorMessage string
- errorCode integer
entity object
subclientId integerclientId integerinstanceName stringinstanceId integer_type_ integer
{
"errorMessage": "string",
"errorCode": 0,
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "string",
"instanceId": 0,
"_type_": 0
}
}
{
"errorMessage": "An instance by this name already exists.",
"errorCode": 3,
"entity": {
"subclientId": 0,
"clientId": 5,
"instanceName": "pgsqlwin_3306",
"instanceId": -1,
"_type_": 0
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Port Number already in use
- Invalid Library Directory
- Invalid Binary Directory
Schema
- errorMessage string
- errorCode integer
entity object
subclientId integerclientId integerinstanceName stringinstanceId integer_type_ integer
{
"errorMessage": "string",
"errorCode": 0,
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "string",
"instanceId": 0,
"_type_": 0
}
}
{
"errorMessage": "Provided Port Number [5432] is already in use. Please provide another port.",
"errorCode": 1,
"entity": {
"subclientId": 0,
"clientId": 4,
"instanceName": "pgauto1_4414_pg14",
"instanceId": -1,
"_type_": 0
}
}
{
"errorMessage": "Connection to PostgreSQL Server failed.\n[~Unable to locate libpq.so library file in PostGres Lib directory. Please provide valid PostGres Lib Path~]",
"errorCode": 4444,
"entity": {
"subclientId": 0,
"clientId": 4,
"instanceName": "pgauto1_4414_pg14",
"instanceId": 6882,
"_type_": 0
}
}
{
"errorMessage": "Invalid PostgreSQL bin directory.\n[~bin path directory:[/usr/pgsql-14] does not exist~]",
"errorCode": 4444,
"entity": {
"subclientId": 0,
"clientId": 4,
"instanceName": "pgauto1_4414_pg14",
"instanceId": 6883,
"_type_": 0
}
}
Loading...