Create instance
This API creates AWS PaaS Database Instance for PostgreSQL or Aurora PostgreSQL.
All the databases in the PostgreSQL instance will be backed up after creation.
- application/json
Request Body
instanceProperties object
instance object required
instanceName stringName of the instance
applicationId integerDefault value:
125
clientName stringName of the cloud account
version string requiredDatabase instance version
postGreSQLInstance object required
MaintainenceDB stringport stringIt must be specified in hostname:port format. The cluster writer/reader endpoint must be mentioned for Aurora instances.
SAUser object required
userName stringDatabase username
password stringDatabase password in base 64 encoded format
cloudDBEngineType string requiredPossible values: [
AURORA_POSTGRESQL
,POSTGRESQL
]sslOpt object
sslEnabled booleanDefault is false
sslCa stringPath to SSL CA file on the Access Node
planEntity object required
planName stringName of the Plan
dbEngine string requiredPossible values: [
postgres
,aurora-postgresql
]
Responses
- 200
- 400
- 500
OK
- application/json
- application/xml
- multipart/form-data
- text/html
- text/plain
- Schema
- Example (from schema)
- Success
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": 214,
"instanceName": "awspgdb14[us-east-1]",
"instanceId": 80,
"_type_": 0
}
}
}
- Schema
- Example (from schema)
Schema
- object
<root/>
- Schema
- Example (from schema)
Schema
- object
{}
- Schema
- Example (from schema)
Schema
- object
{}
- Schema
- Example (from schema)
Schema
- object
{}
Bad Request
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Failure
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": "Connection to PostgreSQL Server failed.\n[~Connection to Database Failed: could not connect to server: Connection timed out (0x0000274C/10060)\tIs the server running on host \"x.x.x.x\" and accepting\tTCP/IP connections on port 5432?~]",
"errorCode": 4444,
"entity": {
"subclientId": 0,
"clientId": 214,
"instanceName": "jah-pg14[us-east-2]",
"instanceId": 2,
"_type_": 0
}
}
Loading...