Create Instance

This API creates Alibaba 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 string

  Name of the Instance

  applicationId integer

  Default value: 125

  clientName string

  Name of the cloud account

  version string required

  Database instance version

  postGreSQLInstance object required

  MaintainenceDB string

  port string

  It must be specified in hostname:port format.

  SAUser object

  userName string

  Database username

  password string

  Database password in base 64 encoded format

  cloudDBEngineType string required

  Possible values: [POSTGRESQL]

  sslOpt object

  sslEnabled boolean

  Default is false

  sslCa string

  Path to SSL CA file on the Access Node

  planEntity object required

  planName string

  Name of the Plan

  dbEngine string required

  Possible values: [PostgreSQL]

Responses

• 200
• 400
• 404
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object

  warningCode integer

  errorCode integer

  warningMessage string

  entity object

  subclientId integer

  clientId integer

  instanceName string

  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": 444,
      "instanceName": "pgm-6gj1yy9fmpsm49d9[ap-south-1]",
      "instanceId": 1060,
      "_type_": 0
    }
  }
}

Bad Request

Not Found

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer
• entity object

  subclientId integer

  clientId integer

  instanceName string

  instanceId 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": "pgm-6gj1yy9fmpsm49d9[ap-south-1]",
    "instanceId": 1069,
    "_type_": 0
  }
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer
• entity object

  subclientId integer

  clientId integer

  instanceName string

  instanceId 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": "pgm-6gj1yy9fmpsm49d9[ap-south-1]",
    "instanceId": 2,
    "_type_": 0
  }
}

POST /instance    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Example 1

---

{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 125,
      "clientName": "string"
    },
    "version": "string",
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "cloudDBEngineType": "POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "string"
      }
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "PostgreSQL"
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 125,
      "clientName": "string"
    },
    "version": "string",
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "cloudDBEngineType": "POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "string"
      }
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "PostgreSQL"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 125,
      "clientName": "string"
    },
    "version": "string",
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "cloudDBEngineType": "POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "string"
      }
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "PostgreSQL"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 125,
      "clientName": "string"
    },
    "version": "string",
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "cloudDBEngineType": "POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "string"
      }
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "PostgreSQL"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 125,
      "clientName": "string"
    },
    "version": "string",
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "cloudDBEngineType": "POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "string"
      }
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "PostgreSQL"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 125,
      "clientName": "string"
    },
    "version": "string",
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "cloudDBEngineType": "POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "string"
      }
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "PostgreSQL"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 125,
      "clientName": "string"
    },
    "version": "string",
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "cloudDBEngineType": "POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "string"
      }
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "PostgreSQL"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 125,
      "clientName": "string"
    },
    "version": "string",
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "cloudDBEngineType": "POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "string"
      }
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "PostgreSQL"
  }
}'