This command lists the configurations that have been set up, optionally filtered by configuration name or type.

Request

HTTP Method: POST
Content Type: application/json

Parameters

Property	Type	Description
`configuration_id`	integer(int64)	list configuration with the specified configuration ID only (non-negative)
`configuration_name`	string	list configurations with the specified configuration name only
`configuration_type`	string	list configurations with the specified configuration type only (possible values: 'oracle', 'postgresql' and 'sqlserver')

{
    "params": {
        "configuration_id": 1,
        "configuration_name": "string",
        "configuration_type": "oracle"
    }
}

Response

HTTP Status: 200

Content Type: application/json

Response

Property	Type	Description
`error`	object of type `error_response`	error response
`result`	object of type `list_response`	list response
`successful`	boolean	response with error or not

error_response

Property	Type	Description
`message`	string	error message

list_response

Property	Type	Description
`configurations`	array of `configuration`	list of configurations

configuration

Property	Type	Description
`configuration_id`	integer(int64)	configuration ID (non-negative)
`configuration_name`	string	configuration name
`configuration_type`	string	configuration type (possible values: 'oracle', 'pgsql' and 'mssql')
`data_loss_exposure_formatted`	string	data loss exposure, formatted for display
`data_loss_exposure_seconds`	integer	number of seconds of transactions that would be lost if the primary database were lost now, based on redo received on the standby (including Zero Data Loss streaming); null if not available
`log_chain_intact`	boolean	for Oracle configurations, false if archive logs are missing from the standby's log chain (use log-gap-report for details); omitted for other configuration types
`observer`	object of type `observer_config`	observer configuration
`auto_update`	object of type `auto_update_config`	automated standby update configuration
`primary`	object of type `database_info`	information about the primary database or cluster
`replication_mode`	string	replication mode for PostgreSQL configurations, or empty for other configuration types (possible values: 'not available', 'ARCHIVING' and 'STREAMING')
`standby`	object of type `database_info`	information about the standby database or cluster
`time_gap_formatted`	string	time gap between primary and standby, formatted for display
`time_gap_seconds`	integer	number of seconds standby is behind primary, or null if not available
`update_delay`	object of type `update_delay_config`	standby update delay configuration
`zero_data_loss`	object of type `zero_data_loss_status`

auto_update_config

Property	Type	Description
`auto_apply`	boolean	whether to automatically apply logs on standby after transfer (Note: Automated Standby Update must be enabled in order for logs to be automatically applied on standby)
`enabled`	boolean	whether automated standby updated is enabled
`interval_seconds`	integer	the configured automated standby update interval in seconds
`zero_data_loss_config`	object of type `zero_data_loss_config`

zero_data_loss_config

Property	Type	Description
`enabled`	boolean	whether Zero Data Loss is enabled
`replication_mode`	string	Zero Data Loss replication mode
`send_email`	boolean	whether to send email notifications on Zero Data Loss failures
`send_slack`	boolean	whether to send Slack notifications on Zero Data Loss failures
`source_redo_mirror_dir`	string	Redo Log destination directory on source host
`standby_redo_mirror_dir`	string	Redo Log destination directory on standby host

database_info

Property	Type	Description
`host`	string	host name of the database, instance or cluster
`port`	integer	cluster port for PostgreSQL configurations, instance port for SQL Server configurations, or omitted for Oracle configurations
`state`	string	database or cluster state, if requested, otherwise empty

observer_config

Property	Type	Description
`check_interval_seconds`	integer	the configured observer check interval in seconds
`custom_script_primary`	string	full path of the custom script to use on the primary host
`custom_script_rule`	string	whether and how to use custom scripts to affect the Observer's behavior' (possible values: 'disabled', 'custom-only', 'either' and 'both')
`custom_script_standby`	string	full path of the custom script to use on the standby host
`emergency_action`	string	action to take once the maximum number of failures has been reached (possible values: 'activate' and 'notify')
`enabled`	boolean	whether the observer is enabled
`heartbeat_enabled`	boolean	whether to send a daily notification to confirm the observer is running; you need to have send_email or send_slack enabled for this to work
`heartbeat_hour`	integer	the hour of the day in the Control Center timezone at which to send the heartbeat notification (0-23)
`heartbeat_minute`	integer	the minute of the hour at which to send the heartbeat notification (0-59)
`max_fail_count`	integer	once this number of failures has been reached, the emergency action is taken and the observer is disabled
`send_email`	boolean	whether to send notifications to the email addresses configured for notifications on the configuration
`send_slack`	boolean	whether to send notifications to the Slack webhooks configured for notifications on the configuration
`time_gap_check_enabled`	boolean	whether to send a notification if the time gap exceeds the configured threshold
`time_gap_check_threshold_seconds`	integer	maximum number of seconds for the time gap check

update_delay_config

Property	Type	Description
`delay_minutes`	integer	number of minutes to keep standby behind primary; 0 to disable

zero_data_loss_status

Property	Type	Description
`currently_replicating_member`	string	full path of the redo member currently being streamed to the standby; omitted unless replication_state is replicating
`error`	string	error that stopped redo log replication
`last_redo_timestamp_primary`	string	latest timestamp written to the online redo logs on the primary; omitted if the primary state is unknown (for example, primary unreachable)
`last_redo_timestamp_standby`	string	latest redo timestamp received in the online redo log mirror on the standby
`replicated_redo_members`	array of `redo_member`	the online redo log members on the primary that Zero Data Loss replicates, with the latest redo observed in each; empty in external replication mode and when no recent measurements are available
`replication_state`	string	current state of Dbvisit redo log replication: "bootstrapping" while the initial copy of the online redo logs is transferring “replicating" during continuous streaming “errored" when replication has failed; omitted for external replication.
`transfer_bytes_per_second`	integer	current redo transfer rate in bytes per second (1-second moving average); omitted unless replication_state is replicating

redo_member

Property	Type	Description
`latest_redo_timestamp`	string	latest timestamp observed in this member
`measurement_time`	string	when this member was last measured
`member`	string	full path of the redo log member on the primary
`sequence`	integer	redo log sequence currently in this member

{
    "error": {
        "message": "string"
    },
    "result": {
        "configurations": [
            {
                "auto_update": {
                    "auto_apply": false,
                    "enabled": false,
                    "interval_seconds": 123,
                    "zero_data_loss_config": {
                        "enabled": false,
                        "replication_mode": "string",
                        "send_email": false,
                        "send_slack": false,
                        "source_redo_mirror_dir": "string",
                        "standby_redo_mirror_dir": "string"
                    }
                },
                "configuration_id": 1,
                "configuration_name": "string",
                "configuration_type": "oracle",
                "data_loss_exposure_formatted": "string",
                "data_loss_exposure_seconds": 123,
                "log_chain_intact": false,
                "observer": {
                    "check_interval_seconds": 123,
                    "custom_script_primary": "string",
                    "custom_script_rule": "disabled",
                    "custom_script_standby": "string",
                    "emergency_action": "activate",
                    "enabled": false,
                    "heartbeat_enabled": false,
                    "heartbeat_hour": 123,
                    "heartbeat_minute": 123,
                    "max_fail_count": 123,
                    "send_email": false,
                    "send_slack": false,
                    "time_gap_check_enabled": false,
                    "time_gap_check_threshold_seconds": 123
                },
                "primary": {
                    "host": "string",
                    "port": 123,
                    "state": "string"
                },
                "replication_mode": "not available",
                "standby": {
                    "host": "string",
                    "port": 123,
                    "state": "string"
                },
                "time_gap_formatted": "string",
                "time_gap_seconds": 123,
                "update_delay": {
                    "delay_minutes": 123
                },
                "zero_data_loss": {
                      "currently_replicating_member": "string",
                      "error": "string",
                      "last_redo_timestamp_primary": "string",
                      "last_redo_timestamp_standby": "string",
                      "replicated_redo_members": [
                          {
                              "latest_redo_timestamp": "string",
                              "measurement_time": "string",
                              "member": "string",
                              "sequence": 123
                          }
                      ],
                      "replication_state": "string",
                      "transfer_bytes_per_second": 123
                    }
            }
        ]
    },
    "successful": true
}

HTTP Status: 400

Content Type: application/json

Response

Property	Type	Description
`error`	object of type `error_response`	error response
`successful`	boolean	always false

error_response

Property	Type	Description
`message`	string	error message

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

We're here to help!

/list

Request

Parameters

Response

HTTP Status: 200

Response

HTTP Status: 400

Response

Comments