Create instance
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
instance object required
instanceName stringName of the instance
applicationId integerDefault value:
104
clientName stringName of the cloud Account
version stringDatabase instance version
mySqlInstance object required
port stringIt must be specified in hostname:port format. The cluster writer/reader endpoint must be mentioned for Aurora instances.
EnableAutoDiscovery booleanDefault value:
true
SAUser object required
userName stringDatabase username
password stringDatabase password in base 64 encoded format
version stringDatabase instance version
cloudDBEngineType stringPossible values: [
AURORA_MYSQL
,MYSQL
]sslEnabled booleanDefault is false
sslCa stringPath to SSL CA file on the Access Node
planEntity object required
planName stringName of the plan
dbEngine string requiredPossible values: [
aurora-mysql
,mysql
]
Responses
- 200
- 500
OK
- application/json
- application/xml
- multipart/form-data
- text/html
- text/plain
- Schema
- Example (from schema)
- Success
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": 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
subclientId integerclientId integerinstanceName stringinstanceId 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": "aurora/temptest[ap-south-1]",
"instanceId": 7,
"_type_": 0
}
}
Loading...