Configure Backup Client for MariaDB Instance

Select

SaaS

Customer Managed

This API creates Cloud Database Instance for MariaDB.

All the databases in the MariaDB instance will be backed up after creation.

Use GET azuredb/maria/instance API to get the dbInstanceIdentifier and port.

application/json

Request Body

oneOf

• CreateMariaDB-SaaS
• CreateMariaDB-CustomerManaged

---

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

username string required

Database username

password string required

Database password in base 64 encoded format

region object

id integer

name string

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

username string required

Database username

password string required

Database password in base 64 encoded format

Responses

• 200
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• instance object

  id integer

  name string

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

{
  "instance": {
    "id": 1724,
    "name": "mariadb/mariadb103[eastus]"
  }
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Without db instance identifier

---

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": "Failed to create new instance.",
    "errorCode": "1",
    "entity": {
      "subclientId": "0",
      "clientId": "2015",
      "instanceName": "",
      "instanceId": "-1",
      "_type_": "ROOT_ENTITY"
    }
  }
}

POST /v4/azuredb/maria/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

---

{
  "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"
  },
  "region": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/maria/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "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"
  },
  "region": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/maria/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "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"
  },
  "region": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/maria/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "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"
  },
  "region": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/maria/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "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"
  },
  "region": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/maria/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "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"
  },
  "region": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/maria/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "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"
  },
  "region": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/maria/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "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"
  },
  "region": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'