Configure Backup Client MySQL Instance

Select

SaaS

Customer Managed

Configure Backup Client MySQL Instance

application/json

Request Body

oneOf

• CreateInstance-SaaS
• CreateInstance-CustomerManaged

---

region object required

id integer

name string

cloudAccount object required

id integer

name string

dbInstanceIdentifier string required

Database name. Use Select Instance API to fetch this

endPoint string required

Database endpoint or hostname

port integer required

Database port

plan object required

id integer

name string

sslEnabled boolean

Default is false

SSL_CA_Certificate string

database object required

Database connection credentials

username string required

DB user name

password string

DB Password. Optional - Not needed if its AD User

backupGateways object[]

List of backupGateways or AccessNodes for Azure DB backup

Optional : Not required if the directCloudBackup is set to true

id integer

Backup Gateway ID

name string

Backup Gateway Name

cloudAccount object required

id integer

name string

dbInstanceIdentifier string required

Database name. Use Select Instance API to fetch this

endPoint string required

Database endpoint or hostname

port integer required

Database port

plan object required

id integer

name string

sslEnabled boolean

Default is false

SSL_CA_Certificate string

database object required

Database connection credentials

username string required

DB user name

password string

DB Password. Optional - Not needed if its AD User

Responses

• 200
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• instance object

  name string

  id integer

{
  "instance": {
    "name": "string",
    "id": 0
  }
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Backup Gateway offline
• D B Info not provided

---

Schema

• failedStage string
• errorCode integer
• errorMessage object

  errorMessage string

  errorCode string

  entity object

  subclientId string

  clientId string

  instanceName string

  instanceId string

  _type_ string

{
  "failedStage": "string",
  "errorCode": 0,
  "errorMessage": {
    "errorMessage": "string",
    "errorCode": "string",
    "entity": {
      "subclientId": "string",
      "clientId": "string",
      "instanceName": "string",
      "instanceId": "string",
      "_type_": "string"
    }
  }
}

{
  "failedStage": "PostInstance",
  "errorCode": -1,
  "errorMessage": {
    "errorMessage": "Unable to connect to client [azmetallic5-MI] to execute [MySqlBrowseAgent].\\\\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": "2034",
      "instanceName": "mysqltestserver[eastus]",
      "instanceId": "1961",
      "_type_": "ROOT_ENTITY"
    }
  }
}

{
  "failedStage": "PostInstance",
  "errorCode": -1,
  "errorMessage": {
    "errorMessage": "Failed to create new instance.",
    "errorCode": "1",
    "entity": {
      "subclientId": "0",
      "clientId": "2034",
      "instanceName": "",
      "instanceId": "-1",
      "_type_": "ROOT_ENTITY"
    }
  }
}

POST /v4/azuredb/mysql/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
• DB info not provided

---

{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "dbInstanceIdentifier": "string",
  "endPoint": "string",
  "port": 0,
  "plan": {
    "id": 0,
    "name": "string"
  },
  "sslEnabled": true,
  "SSL_CA_Certificate": "string",
  "database": {
    "username": "string",
    "password": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mysql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "dbInstanceIdentifier": "string",
  "endPoint": "string",
  "port": 0,
  "plan": {
    "id": 0,
    "name": "string"
  },
  "sslEnabled": true,
  "SSL_CA_Certificate": "string",
  "database": {
    "username": "string",
    "password": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mysql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "dbInstanceIdentifier": "string",
  "endPoint": "string",
  "port": 0,
  "plan": {
    "id": 0,
    "name": "string"
  },
  "sslEnabled": true,
  "SSL_CA_Certificate": "string",
  "database": {
    "username": "string",
    "password": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mysql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "dbInstanceIdentifier": "string",
  "endPoint": "string",
  "port": 0,
  "plan": {
    "id": 0,
    "name": "string"
  },
  "sslEnabled": true,
  "SSL_CA_Certificate": "string",
  "database": {
    "username": "string",
    "password": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mysql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "dbInstanceIdentifier": "string",
  "endPoint": "string",
  "port": 0,
  "plan": {
    "id": 0,
    "name": "string"
  },
  "sslEnabled": true,
  "SSL_CA_Certificate": "string",
  "database": {
    "username": "string",
    "password": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mysql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "dbInstanceIdentifier": "string",
  "endPoint": "string",
  "port": 0,
  "plan": {
    "id": 0,
    "name": "string"
  },
  "sslEnabled": true,
  "SSL_CA_Certificate": "string",
  "database": {
    "username": "string",
    "password": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mysql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "dbInstanceIdentifier": "string",
  "endPoint": "string",
  "port": 0,
  "plan": {
    "id": 0,
    "name": "string"
  },
  "sslEnabled": true,
  "SSL_CA_Certificate": "string",
  "database": {
    "username": "string",
    "password": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mysql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "dbInstanceIdentifier": "string",
  "endPoint": "string",
  "port": 0,
  "plan": {
    "id": 0,
    "name": "string"
  },
  "sslEnabled": true,
  "SSL_CA_Certificate": "string",
  "database": {
    "username": "string",
    "password": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'