Skip to main content

RDS Snap Restore​

Select

SaaS
Customer Managed

This operation is used to submit restore operations for RDS Snap.

Request Body
  • taskInfo object
  • associations object[]
  • clientName string required

    Cloud account name

  • instanceName string required

    RDS Instance name.

  • displayName string required

    Display name of cloud account.

  • appName string required

    Possible values: [Cloud Apps]

  • cloudInstanceType string

    Possible values: [AMAZON_RDS]

  • backupsetName string

    Possible values: [defaultBackupSet]

  • _type_ string

    Possible values: [INSTANCE_ENTITY, SUBCLIENT_ENTITY]

  • task object
  • taskType string

    Possible values: [IMMEDIATE, SCHEDULED]

  • subTasks object[]
  • subTask object
  • subTaskType string

    Default value: RESTORE

  • operationType string

    Default value: RESTORE

  • options object
  • restoreOptions object
  • browseOption object
  • commCellId integer
  • timeRange object
  • fromTime integer
  • toTime integer
  • destination object
  • destClient object
  • clientName string required

    Cloud account name of desti

  • destinationInstance object
  • clientName string required

    Name of Cloud account.

  • instanceName string required

    Name of RDS instance.

  • displayName string required

    Name of RDS instance.

  • appName string

    Possible values: [Cloud Apps]

  • entityName string
  • cloudInstanceType string

    Possible values: [AMAZON_RDS]

  • backupsetName string

    Possible values: [defaultBackupSet]

  • fileOption object
  • sourceItem string[]

    snap region along with snap identifier.

  • cloudAppsRestoreOptions object
  • instanceType integer
  • rdsRestoreOptions object
  • isMultiAZ boolean
  • sourceInstance object
  • clientName string required

    Cloud Account Name.

  • instanceName string required

    RDS instance name.

  • displayName string required

    Name of RDS instance.

  • appName string

    Possible values: [Cloud Apps]

  • cloudInstanceType string required

    Possible values: [AMAZON_RDS]

  • entityName string
  • backupsetName string

    Possible values: [defaultBackupSet]

  • publicAccess boolean
  • targetDbName string required

    Database name to be restored.

  • targetSecurityGroupValue string required

    Security group on the destination account.

  • sourceSnap object
  • copyId integer
  • commcellId integer
  • createTime integer
  • dbName string
  • dbType string
  • archFileId integer
  • snapShotName string
  • status integer
  • rdsAttributes object
  • dbInstanceARN string
  • availabilityZone string
  • dbSubnetGroup string
  • leafNode boolean
  • label string
  • id string
  • displayName string
  • isFile boolean
  • hasChildren boolean
  • flags object
  • directory boolean
  • file boolean
  • isDrilldownAllowed boolean
  • path string
  • expanded boolean
  • selected boolean
  • autoMinorVersionUpgrade boolean
  • isCrossAccountRestore boolean
  • commonOpts object
  • notifyUserOnJobCompletion boolean
  • prePostOpts object
  • preRecoveryCommand string
  • postRecoveryCommand string
  • runPostWhenFail boolean
Responses

OK

Schema
  • taskId integer
  • jobIds string[]
POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
token
Body
{

  "taskInfo": {

    "associations": [

      {

        "clientName": "string",

        "instanceName": "string",

        "displayName": "string",

        "appName": "Cloud Apps",

        "cloudInstanceType": "AMAZON_RDS",

        "backupsetName": "defaultBackupSet",

        "_type_": "INSTANCE_ENTITY"

      }

    ],

    "task": {

      "taskType": "IMMEDIATE"

    },

    "subTasks": [

      {

        "subTask": {

          "subTaskType": "RESTORE",

          "operationType": "RESTORE"

        },

        "options": {

          "restoreOptions": {

            "browseOption": {

              "commCellId": 0,

              "timeRange": {

                "fromTime": 0,

                "toTime": 0

              }

            },

            "destination": {

              "destClient": {

                "clientName": "string"

              },

              "destinationInstance": {

                "clientName": "string",

                "instanceName": "string",

                "displayName": "string",

                "appName": "Cloud Apps",

                "entityName": "string",

                "cloudInstanceType": "AMAZON_RDS",

                "backupsetName": "defaultBackupSet"

              }

            },

            "fileOption": {

              "sourceItem": [

                "string"

              ]

            },

            "cloudAppsRestoreOptions": {

              "instanceType": 0,

              "rdsRestoreOptions": {

                "isMultiAZ": true,

                "sourceInstance": {

                  "clientName": "string",

                  "instanceName": "string",

                  "displayName": "string",

                  "appName": "Cloud Apps",

                  "cloudInstanceType": "AMAZON_RDS",

                  "entityName": "string",

                  "backupsetName": "defaultBackupSet"

                },

                "publicAccess": true,

                "targetDbName": "string",

                "targetSecurityGroupValue": "string",

                "sourceSnap": {

                  "copyId": 0,

                  "commcellId": 0,

                  "createTime": 0,

                  "dbName": "string",

                  "dbType": "string",

                  "archFileId": 0,

                  "snapShotName": "string",

                  "status": 0,

                  "rdsAttributes": {

                    "dbInstanceARN": "string",

                    "availabilityZone": "string",

                    "dbSubnetGroup": "string"

                  },

                  "leafNode": true,

                  "label": "string",

                  "id": "string",

                  "displayName": "string",

                  "isFile": true,

                  "hasChildren": true,

                  "flags": {

                    "directory": true,

                    "file": true

                  },

                  "isDrilldownAllowed": true,

                  "path": "string",

                  "expanded": true,

                  "selected": true

                },

                "autoMinorVersionUpgrade": true,

                "isCrossAccountRestore": true

              }

            }

          },

          "commonOpts": {

            "notifyUserOnJobCompletion": true,

            "prePostOpts": {

              "preRecoveryCommand": "string",

              "postRecoveryCommand": "string",

              "runPostWhenFail": 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",
        "appName": "Cloud Apps",
        "cloudInstanceType": "AMAZON_RDS",
        "backupsetName": "defaultBackupSet",
        "_type_": "INSTANCE_ENTITY"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "RESTORE",
          "operationType": "RESTORE"
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 0,
              "timeRange": {
                "fromTime": 0,
                "toTime": 0
              }
            },
            "destination": {
              "destClient": {
                "clientName": "string"
              },
              "destinationInstance": {
                "clientName": "string",
                "instanceName": "string",
                "displayName": "string",
                "appName": "Cloud Apps",
                "entityName": "string",
                "cloudInstanceType": "AMAZON_RDS",
                "backupsetName": "defaultBackupSet"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "cloudAppsRestoreOptions": {
              "instanceType": 0,
              "rdsRestoreOptions": {
                "isMultiAZ": true,
                "sourceInstance": {
                  "clientName": "string",
                  "instanceName": "string",
                  "displayName": "string",
                  "appName": "Cloud Apps",
                  "cloudInstanceType": "AMAZON_RDS",
                  "entityName": "string",
                  "backupsetName": "defaultBackupSet"
                },
                "publicAccess": true,
                "targetDbName": "string",
                "targetSecurityGroupValue": "string",
                "sourceSnap": {
                  "copyId": 0,
                  "commcellId": 0,
                  "createTime": 0,
                  "dbName": "string",
                  "dbType": "string",
                  "archFileId": 0,
                  "snapShotName": "string",
                  "status": 0,
                  "rdsAttributes": {
                    "dbInstanceARN": "string",
                    "availabilityZone": "string",
                    "dbSubnetGroup": "string"
                  },
                  "leafNode": true,
                  "label": "string",
                  "id": "string",
                  "displayName": "string",
                  "isFile": true,
                  "hasChildren": true,
                  "flags": {
                    "directory": true,
                    "file": true
                  },
                  "isDrilldownAllowed": true,
                  "path": "string",
                  "expanded": true,
                  "selected": true
                },
                "autoMinorVersionUpgrade": true,
                "isCrossAccountRestore": true
              }
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true,
            "prePostOpts": {
              "preRecoveryCommand": "string",
              "postRecoveryCommand": "string",
              "runPostWhenFail": true
            }
          }
        }
      }
    ]
  }
}'