GCP MySQL instance backup

Select

Customer Managed

This operation is used to submit GCP MySQL instance backups.

application/json

Request Body

• taskInfo object

  associations object[] required

  clientName string

  Name of the cloud account

  instanceName string

  Name of the instance

  displayName string

  Display Name of the cloud account

  _type_ string

  Possible values: [SUBCLIENT_ENTITY]

  commCellName string

  backupsetName string

  Default value: defaultDummyBackupSet

  applicationId integer

  Default value: 104

  subclientName string

  Name of the database group to backup

  task object

  taskType string

  Possible values: [IMMEDIATE, SCHEDULE]

  subTasks object[]

  subTask object

  subTaskType string

  Default value: BACKUP

  operationType string

  Default value: BACKUP

  options object

  backupOpts object

  backupLevel string

  Default value: FULL

  commonOpts object

  notifyUserOnJobCompletion boolean

  Default value: true

Responses

• 200
• 400
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• taskId integer
• jobIds string[]

{
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

{
  "taskId": 9920,
  "jobIds": [
    "110468"
  ]
}

Bad Request

application/json

• Schema
• Example 1

---

Schema

• string

Request body is empty or format is invalid

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Failed to start backups as no eligible subclients were found.  ",
  "errorCode": 587207178
}

POST /createtask    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Full Backup

---

{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "commCellName": "string",
        "backupsetName": "defaultDummyBackupSet",
        "applicationId": 104,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "commCellName": "string",
        "backupsetName": "defaultDummyBackupSet",
        "applicationId": 104,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "commCellName": "string",
        "backupsetName": "defaultDummyBackupSet",
        "applicationId": 104,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "commCellName": "string",
        "backupsetName": "defaultDummyBackupSet",
        "applicationId": 104,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "commCellName": "string",
        "backupsetName": "defaultDummyBackupSet",
        "applicationId": 104,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "commCellName": "string",
        "backupsetName": "defaultDummyBackupSet",
        "applicationId": 104,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "commCellName": "string",
        "backupsetName": "defaultDummyBackupSet",
        "applicationId": 104,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "commCellName": "string",
        "backupsetName": "defaultDummyBackupSet",
        "applicationId": 104,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'