Create MySQL Database Group
This operation creates a database group in a MySQL Instance
- application/json
Request Body
subClientProperties object
MySQL database group general properties
subClientEntity object
subclientName string requiredDatabase group name
instanceName string requiredMySQL Instance name where database groups to be created
appName string requiredDefault value:
MySQL
clientName string requiredclient Name
entityInfo object
Internal Fields
companyId integercompanyName stringDefault value:
Commcell
Company name
multiCommcellId integercommonProperties objectcontent object[] required
Names of the databases to be added to the MySQL Database group content
mySQLContent object required
Database names to be added exclusive. Refer examples for more details.
databaseName string requiredDatabase name
contentOperationType string requiredDefault value:
OVERWRITE
mySqlSubclientProp object
MySQL Database group properties
numberOfBackupStreams integer requiredPossible values:
>= 1
and<= 100
Default value:
2
Number of streams for data backup
numberOfTransactionLogStreams integerDefault value:
1
fullInstanceXtraBackup booleanDefault value:
false
Set when Xtrabackup option enabled at MySQL Instance level
planEntity object required
planName stringPlan Name
Responses
- 200
- 400
- 401
- 409
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object
warningCode integererrorCode integerwarningMessage stringentity object
subclientId integerID of created database group
_type_ integer
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": {
"warningCode": 0,
"errorCode": 0,
"warningMessage": "string",
"entity": {
"subclientId": 0,
"_type_": 0
}
}
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "exitval",
"value": "0"
}
]
},
"response": {
"warningCode": 0,
"errorCode": 0,
"warningMessage": "",
"entity": {
"subclientId": 1081,
"_type_": 0
}
}
}
Bad Request
- application/json
- Schema
- Example
Schema
- string
Request body is empty or format is invalid
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access denied",
"errorCode": 5
}
Conflict
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "A subclient by this name already exists as part of this backup set.",
"errorCode": 3
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Failed to create new subclient.",
"errorCode": 1
}
{
"errorMessage": "User does not have [Use Plan] rights on plan(s)-[Invalid PlanId].",
"errorCode": 1
}
Loading...