Create instance
Select
SaaS
Customer Managed
This API creates AWS PaaS Database Instance for MySQL or Aurora MySQL.
All the databases in the MySQL instance will be backed up after creation.
- application/json
Request Body
instanceProperties object
Responses
- 200
- 500
OK
- application/json
- application/xml
- multipart/form-data
- text/html
- text/plain
- Schema
- Example (from schema)
- Success
Schema
processinginstructioninfo object
response object
{
"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": "aurora/temptest[ap-south-1]",
"instanceId": 803,
"_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
{}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Failure
Schema
- errorMessage string
- errorCode integer
entity object
{
"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": "aurora/temptest[ap-south-1]",
"instanceId": 7,
"_type_": 0
}
}
POST /instance
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
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"
},
"version": "string",
"mySqlInstance": {
"port": "string",
"EnableAutoDiscovery": true,
"SAUser": {
"userName": "string",
"password": "string"
},
"version": "string",
"cloudDBEngineType": "AURORA_MYSQL",
"sslEnabled": true,
"sslCa": "string"
},
"planEntity": {
"planName": "string"
},
"dbEngine": "aurora-mysql"
}
}'
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"
},
"version": "string",
"mySqlInstance": {
"port": "string",
"EnableAutoDiscovery": true,
"SAUser": {
"userName": "string",
"password": "string"
},
"version": "string",
"cloudDBEngineType": "AURORA_MYSQL",
"sslEnabled": true,
"sslCa": "string"
},
"planEntity": {
"planName": "string"
},
"dbEngine": "aurora-mysql"
}
}'
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"
},
"version": "string",
"mySqlInstance": {
"port": "string",
"EnableAutoDiscovery": true,
"SAUser": {
"userName": "string",
"password": "string"
},
"version": "string",
"cloudDBEngineType": "AURORA_MYSQL",
"sslEnabled": true,
"sslCa": "string"
},
"planEntity": {
"planName": "string"
},
"dbEngine": "aurora-mysql"
}
}'
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"
},
"version": "string",
"mySqlInstance": {
"port": "string",
"EnableAutoDiscovery": true,
"SAUser": {
"userName": "string",
"password": "string"
},
"version": "string",
"cloudDBEngineType": "AURORA_MYSQL",
"sslEnabled": true,
"sslCa": "string"
},
"planEntity": {
"planName": "string"
},
"dbEngine": "aurora-mysql"
}
}'
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"
},
"version": "string",
"mySqlInstance": {
"port": "string",
"EnableAutoDiscovery": true,
"SAUser": {
"userName": "string",
"password": "string"
},
"version": "string",
"cloudDBEngineType": "AURORA_MYSQL",
"sslEnabled": true,
"sslCa": "string"
},
"planEntity": {
"planName": "string"
},
"dbEngine": "aurora-mysql"
}
}'
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"
},
"version": "string",
"mySqlInstance": {
"port": "string",
"EnableAutoDiscovery": true,
"SAUser": {
"userName": "string",
"password": "string"
},
"version": "string",
"cloudDBEngineType": "AURORA_MYSQL",
"sslEnabled": true,
"sslCa": "string"
},
"planEntity": {
"planName": "string"
},
"dbEngine": "aurora-mysql"
}
}'
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"
},
"version": "string",
"mySqlInstance": {
"port": "string",
"EnableAutoDiscovery": true,
"SAUser": {
"userName": "string",
"password": "string"
},
"version": "string",
"cloudDBEngineType": "AURORA_MYSQL",
"sslEnabled": true,
"sslCa": "string"
},
"planEntity": {
"planName": "string"
},
"dbEngine": "aurora-mysql"
}
}'