Configure Backup Client PostgreSQL Instance
Select
SaaS
Customer Managed
This API creates Cloud Database Instance for PostgreSQL.
All the databases in the PostgreSQL instance will be backed up after creation.
Use GET azuredb/postgresql/instance API to get the dbInstanceIdentifier and port.
- application/json
Request Body
- CreateInstance-SaaS
- CreateInstance-CustomerManaged
region object required
cloudAccount object required
- dbInstanceIdentifier string required
Database name. Use Select Instance API to fetch this
- endPoint string required
Database endpoint or hostname
- port integer required
Database port
plan object required
- sslEnabled boolean
Default is false
- SSL_CA_Certificate string
database object required
backupGateways object[]
cloudAccount object required
- dbInstanceIdentifier string required
Database name. Use Select Instance API to fetch this
- endPoint string required
Database endpoint or hostname
- port integer required
Database port
plan object required
- sslEnabled boolean
Default is false
- SSL_CA_Certificate string
database object required
Responses
- 200
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
instance object
{
"instance": {
"id": 0,
"name": "string"
}
}
{
"instance": {
"name": "pg11servereastus[eastus]",
"id": 1753
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- failedStage string
- errorCode integer
errorMessage object
{
"failedStage": "string",
"errorCode": 0,
"errorMessage": {
"errorMessage": "string",
"errorCode": "string",
"entity": {
"subclientId": "string",
"clientId": "string",
"instanceName": "string",
"instanceId": "string",
"_type_": "string"
}
}
}
{
"failedStage": "PostInstance",
"errorCode": -1,
"errorMessage": {
"errorMessage": "Unable to connect to client [] to execute [PostgreSQLBrowseAgent].\\\\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": "2015",
"instanceName": "pg11servereastus[eastus]",
"instanceId": "1962",
"_type_": "ROOT_ENTITY"
}
}
}
POST /v4/azuredb/postgresql/instance
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/postgresql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"region": {
"id": 0,
"name": "string"
},
"cloudAccount": {
"id": 0,
"name": "string"
},
"dbInstanceIdentifier": "string",
"endPoint": "string",
"port": 0,
"plan": {
"id": 0,
"name": "string"
},
"sslEnabled": true,
"SSL_CA_Certificate": "string",
"database": {
"username": "string",
"password": "string"
},
"backupGateways": [
{
"id": 0,
"name": "string"
}
]
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/postgresql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"region": {
"id": 0,
"name": "string"
},
"cloudAccount": {
"id": 0,
"name": "string"
},
"dbInstanceIdentifier": "string",
"endPoint": "string",
"port": 0,
"plan": {
"id": 0,
"name": "string"
},
"sslEnabled": true,
"SSL_CA_Certificate": "string",
"database": {
"username": "string",
"password": "string"
},
"backupGateways": [
{
"id": 0,
"name": "string"
}
]
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/postgresql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"region": {
"id": 0,
"name": "string"
},
"cloudAccount": {
"id": 0,
"name": "string"
},
"dbInstanceIdentifier": "string",
"endPoint": "string",
"port": 0,
"plan": {
"id": 0,
"name": "string"
},
"sslEnabled": true,
"SSL_CA_Certificate": "string",
"database": {
"username": "string",
"password": "string"
},
"backupGateways": [
{
"id": 0,
"name": "string"
}
]
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/postgresql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"region": {
"id": 0,
"name": "string"
},
"cloudAccount": {
"id": 0,
"name": "string"
},
"dbInstanceIdentifier": "string",
"endPoint": "string",
"port": 0,
"plan": {
"id": 0,
"name": "string"
},
"sslEnabled": true,
"SSL_CA_Certificate": "string",
"database": {
"username": "string",
"password": "string"
},
"backupGateways": [
{
"id": 0,
"name": "string"
}
]
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/postgresql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"region": {
"id": 0,
"name": "string"
},
"cloudAccount": {
"id": 0,
"name": "string"
},
"dbInstanceIdentifier": "string",
"endPoint": "string",
"port": 0,
"plan": {
"id": 0,
"name": "string"
},
"sslEnabled": true,
"SSL_CA_Certificate": "string",
"database": {
"username": "string",
"password": "string"
},
"backupGateways": [
{
"id": 0,
"name": "string"
}
]
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/postgresql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"region": {
"id": 0,
"name": "string"
},
"cloudAccount": {
"id": 0,
"name": "string"
},
"dbInstanceIdentifier": "string",
"endPoint": "string",
"port": 0,
"plan": {
"id": 0,
"name": "string"
},
"sslEnabled": true,
"SSL_CA_Certificate": "string",
"database": {
"username": "string",
"password": "string"
},
"backupGateways": [
{
"id": 0,
"name": "string"
}
]
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/postgresql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"region": {
"id": 0,
"name": "string"
},
"cloudAccount": {
"id": 0,
"name": "string"
},
"dbInstanceIdentifier": "string",
"endPoint": "string",
"port": 0,
"plan": {
"id": 0,
"name": "string"
},
"sslEnabled": true,
"SSL_CA_Certificate": "string",
"database": {
"username": "string",
"password": "string"
},
"backupGateways": [
{
"id": 0,
"name": "string"
}
]
}'