Create Instance
Select
SaaS
Customer Managed
This API creates GCP PaaS Database Instance for 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.
SAUser object
userName stringDatabase username
password stringDatabase password in base 64 encoded format
cloudDBEngineType string requiredPossible values: [
POSTGRESQL
]sslOpt object
sslEnabled booleanDefault is false
sslCa stringPath to SSL CA file on the Access Node
sslKey stringPath to Client Key file on the Access Node
sslCert stringPath to SSL Client Cert file on the Access Node
planEntity object required
planName stringName of the Plan
dbEngine string requiredPossible values: [
postgres
]
Responses
- 200
- 400
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example 1
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": 444,
"instanceName": "pg13db[asia-south1]",
"instanceId": 1060,
"_type_": 0
}
}
}
Bad Request
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
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": "Unable to connect to client [] to execute [PostgresBrowseAgent].\nPlease ensure that all iDataAgent software is properly installed.\nAlso check network connectivity and if this product's services are running.",
"errorCode": 4444,
"entity": {
"subclientId": 0,
"clientId": 444,
"instanceName": "pg13-db[us-central1]",
"instanceId": 1069,
"_type_": 0
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example 1
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": "pg14[us-east-2]",
"instanceId": 2,
"_type_": 0
}
}
Loading...