/create-standby/sqlserver
Set up SQL Server disaster recovery
Request
HTTP Method: POST
Content Type: application/json
Parameters
Property | Type | Description | Default | Required |
|---|---|---|---|---|
| integer(int64) | configuration ID (non-negative) |
| required |
| boolean | enable observer | true |
|
| string | Introduced in 12.3 compress the initial backup sent to the standby (on, off). The instance's default will be used otherwise |
|
|
| string | Introduced in 12.3 compress log backups for this configuration (on, off, auto) | auto |
|
| boolean | enable automated standby update | true |
|
| integer(int32) | interval for automated standby update in seconds (minimum: 60) | 300 |
|
| string map | location for database files on standby host |
|
|
| string | directory for full database backup on source host |
|
|
| string | directory for full database backup on standby host |
|
|
{
"params": {
"auto_update": true,
"auto_update_interval": 300,
"configuration_id": 1,
"db_file_loc": {
"file_name1": "loc1",
"file_name2": "loc2"
},
"observer": true,
"compress_backup":"string",
"compress_logs":"string",
"source_backup_dir": "string",
"standby_backup_dir": "string"
}
}Response
HTTP Status: 200
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| object of type |
|
| boolean | response with error or not |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
task_response
Property | Type | Description |
|---|---|---|
| integer(int64) | task ID |
{
"error": {
"message": "string"
},
"result": {
"task_id": 1
},
"successful": true
}HTTP Status: 400
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| boolean | always false |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
{
"error": {
"message": "string"
},
"successful": false
}