/
/create-standby/oracle

/create-standby/oracle

Set up Oracle disaster recovery

Request

HTTP Method: POST
Content Type: application/json

Parameters

Property

Type

Description

Default

Required

Property

Type

Description

Default

Required

configuration_id

integer(int64)

configuration ID (non-negative)

required

observer

boolean

enable observer

true

auto_update

boolean

enable automated standby update

true

auto_update_interval

integer(int32)

interval for automated standby update in seconds (minimum: 60)

600

logship

boolean

ship archive logs from the source database while creating the standby database

true

parallel

boolean

perform backup, transfer and restore operations in parallel when possible

true

resume

boolean

resume a prior create-standby operation

false

save_template

boolean

save entered values for later use; does not perform the action

false

service_password

string(password)

password to use when creating the Windows service

service_user

string

user name to use when creating the Windows service

set_param

string map

set an Oracle database parameter for the standby database; set empty string value to delete the parameter(its default value will be used)

shared_space

boolean

assume source_backup_dir and standby_backup_dir are on a shared file system; skip transferring the backup

false

source_backup_dir

string

directory for database backup on source host

srvctl

boolean

register standby database with Oracle Restart or Clusterware

false

standby_backup_dir

string

directory for database backup on standby host

transportable

boolean

use transportable media for the database backup

false

use_existing_spfile

boolean

use existing spfile on standby host

use_template

boolean

use default values from a saved template

false

{ "params": { "auto_update": true, "auto_update_interval": 600, "configuration_id": 1, "logship": true, "observer": true, "parallel": true, "resume": false, "save_template": false, "service_password": "string", "service_user": "string", "set_param": { "del_key": "", "set_key": "value" }, "shared_space": false, "source_backup_dir": "string", "srvctl": false, "standby_backup_dir": "string", "transportable": false, "use_existing_spfile": false, "use_template": false } }

Response

HTTP Status: 200

Content Type: application/json

Response

Property

Type

Description

Property

Type

Description

error

object of type error_response

error response

result

object of type task_response

successful

boolean

response with error or not

error_response

Property

Type

Description

Property

Type

Description

message

string

error message

task_response

Property

Type

Description

Property

Type

Description

task_id

integer(int64)

task ID

{ "error": { "message": "string" }, "result": { "task_id": 1 }, "successful": true }

HTTP Status: 400

Content Type: application/json

Response

Property

Type

Description

Property

Type

Description

error

object of type error_response

error response

successful

boolean

always false

error_response

Property

Type

Description

Property

Type

Description

message

string

error message

{ "error": { "message": "string" }, "successful": false }

Related content

Creating The Standby Database
Creating The Standby Database
More like this
Create Standby Database (CSD)
Create Standby Database (CSD)
More like this
Appendix C: Create Standby Database Manually - Linux
Appendix C: Create Standby Database Manually - Linux
More like this