Skip to main content
BlueXP backup and recovery
All cloud providers
  • Amazon Web Services
  • Google Cloud
  • Microsoft Azure
  • All cloud providers

Back up cloud-native Microsoft SQL Server databases

Contributors netapp-soumikd

You can create scheduled or on-demand backups by assigning the policies that you created.

Create backup policy

You can run this API to create the backup policy.

'POST snapcenter.cloudmanager.cloud.netapp.com/api/mssql/backup/policies'

For more information, refer to: https://snapcenter.cloudmanager.cloud.netapp.com/api-doc/#/MSSQL%20Backup%20Policies/MSSQLBackupPolicyService_CreateMSSQLBackupPolicy

This API creates a job that can be tracked from the Job Monitor tab in the BlueXP UI.

Parameters

Name Type Required

name

string

True

backup_type

string

True

copy_only_backup

string

False

is_system_defined

string

False

backup_name_format

string

True

schedule_type

string

True

start_time

number

True

hours_interval

number

True

minutes_interval

number

True

retention_type

string

True

retention_count

number

True

end_time

number

True

Response

If the API is executed successfully, response code 201 is displayed.

Example:

{
    "_links": {
    "self": {
        "href": "/api/resourcelink"
      }
    }
}

Assign policy to SQL database instance

You can run this API to assign policy to SQL database instance.

'POST snapcenter.cloudmanager.cloud.netapp.com/api/mssql/instances/{id}/policy-assignment'

Where, id is MSSQL instance ID obtained by running the discover database instance API. For more information, refer to Discover the database instances.

Array of IDs is the input here. For example:

[
  "c9f3e68d-1f9c-44dc-b9af-72a9dfc54320"
]

For more information, refer to: https://snapcenter.cloudmanager.cloud.netapp.com/api-doc/#/MSSQL%20Policy%20Assignment/PostMSSQLInstanceAssignPolicyRequest

This API creates a job that can be tracked from the Job Monitor tab in the BlueXP UI.

Response

If the API is executed successfully, response code 202 is displayed.

Example:

{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Create an on-demand backup

You can run this API to create an on-demand backup.

'POST snapcenter.cloudmanager.cloud.netapp.com/api/mssql/backups'

For more information, refer to: https://snapcenter.cloudmanager.cloud.netapp.com/api-doc/#/MSSQL%20Backups/CreateMSSQLBackupRequest

This API creates a job that can be tracked from the Job Monitor tab in the BlueXP UI.

Parameters

Name Type Required

id

Note This is ID of the MSSQL database instance.

string

True

resource_type

string

True

policy_id

string

True

schedule_type

string

True

Response

If the API is executed successfully, response code 202 is displayed.

Example:

{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

View the backups

You can run these APIs to list view all the backups and also to view details of a particular backup.

'GET snapcenter.cloudmanager.cloud.netapp.com/api/mssql/backups'

'GET snapcenter.cloudmanager.cloud.netapp.com/api/mssql/backups/{id}'

For more information, refer to: https://snapcenter.cloudmanager.cloud.netapp.com/api-doc/#/MSSQL%20Backups/MSSQLGetBackupsRequest

Response

If the API is executed successfully, response code 200 is displayed.

Example:

{
    "total_records": 1,
    "num_records": 1,
    "records": [
        {
            "backup_id": "602d7796-8074-43fc-a178-eee8c78566ac",
            "resource_id": "a779578d-cf78-46f3-923d-b9223255938c",
            "backup_name": "Hourly_policy2_scspa2722211001_NAMEDINSTANCE1_2023_08_08_07_02_01_81269_0",
            "policy_name": "policy2",
            "schedule_type": "Hourly",
            "start_time": "2023-08-08T07:02:10.203Z",
            "end_time": "0001-01-01T00:00:00Z",
            "backup_status": "success",
            "backup_type": "FullBackup"
        }
    ],
    "_links": {
        "next": {}
    }
}