Create instance

This API creates AWS PaaS Database Instance for MariaDB.

All the databases in the MariaDB 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: 104

  clientName string

  Name of the cloud account

  mySqlInstance object

  port string required

  It must be specified in hostname:port format

  EnableAutoDiscovery boolean required

  Default value is true.

  SAUser object required

  userName string

  Database username

  password string

  Database password in base 64 encoded format

  version string

  Database instance version

  cloudDBEngineType string

  Default value: MARIADB

  sslEnabled boolean

  Default is false

  sslCa string

  Path to SSL CA file on the Access Node

  planEntity object

  planName string

  Name of the plan

  dbEngine string

  Default value: mariadb

Responses

• 200
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Success

---

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": 2,
      "instanceName": "mariadb/enctest[ap-south-1]",
      "instanceId": 7,
      "_type_": 0
    }
  }
}

application/xml

• Schema
• Example (from schema)

---

Schema

• object

<root/>

multipart/form-data

• Schema
• Example (from schema)

---

Schema

• object

{}

text/html

• Schema
• Example (from schema)

---

Schema

• object

{}

text/plain

• Schema
• Example (from schema)

---

Schema

• object

{}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Failure

---

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": "Failed to connect to the MySQL server. Check that username, password, port and SSL parameters are valid.",
  "errorCode": 4444,
  "entity": {
    "subclientId": 0,
    "clientId": 2,
    "instanceName": "mariadb/enctest1[ap-south-1]",
    "instanceId": 7,
    "_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

{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 104,
      "clientName": "string"
    },
    "mySqlInstance": {
      "port": "string",
      "EnableAutoDiscovery": true,
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "version": "string",
      "cloudDBEngineType": "MARIADB",
      "sslEnabled": true,
      "sslCa": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "mariadb"
  }
}

Accept

application/jsonapplication/xmlmultipart/form-datatext/htmltext/plain

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": 104,
      "clientName": "string"
    },
    "mySqlInstance": {
      "port": "string",
      "EnableAutoDiscovery": true,
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "version": "string",
      "cloudDBEngineType": "MARIADB",
      "sslEnabled": true,
      "sslCa": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "mariadb"
  }
}'

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": 104,
      "clientName": "string"
    },
    "mySqlInstance": {
      "port": "string",
      "EnableAutoDiscovery": true,
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "version": "string",
      "cloudDBEngineType": "MARIADB",
      "sslEnabled": true,
      "sslCa": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "mariadb"
  }
}'

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": 104,
      "clientName": "string"
    },
    "mySqlInstance": {
      "port": "string",
      "EnableAutoDiscovery": true,
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "version": "string",
      "cloudDBEngineType": "MARIADB",
      "sslEnabled": true,
      "sslCa": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "mariadb"
  }
}'

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": 104,
      "clientName": "string"
    },
    "mySqlInstance": {
      "port": "string",
      "EnableAutoDiscovery": true,
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "version": "string",
      "cloudDBEngineType": "MARIADB",
      "sslEnabled": true,
      "sslCa": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "mariadb"
  }
}'

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": 104,
      "clientName": "string"
    },
    "mySqlInstance": {
      "port": "string",
      "EnableAutoDiscovery": true,
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "version": "string",
      "cloudDBEngineType": "MARIADB",
      "sslEnabled": true,
      "sslCa": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "mariadb"
  }
}'

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": 104,
      "clientName": "string"
    },
    "mySqlInstance": {
      "port": "string",
      "EnableAutoDiscovery": true,
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "version": "string",
      "cloudDBEngineType": "MARIADB",
      "sslEnabled": true,
      "sslCa": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "mariadb"
  }
}'

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": 104,
      "clientName": "string"
    },
    "mySqlInstance": {
      "port": "string",
      "EnableAutoDiscovery": true,
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "version": "string",
      "cloudDBEngineType": "MARIADB",
      "sslEnabled": true,
      "sslCa": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "mariadb"
  }
}'