/list
- Vijayganesh Sivaprakasam
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 |
|---|---|---|
| integer(int64) | list configuration with the specified configuration ID only (non-negative) |
| string | list configurations with the specified configuration name only |
| 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 |
|---|---|---|
| object of type | error response |
| object of type | list response |
| boolean | response with error or not |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
list_response
Property | Type | Description |
|---|---|---|
| array of configuration | list of configurations |
configuration
Property | Type | Description |
|---|---|---|
| integer(int64) | configuration ID (non-negative) |
| string | configuration name |
| string | configuration type (possible values: 'oracle', 'pgsql' and 'mssql') |
| object of type | observer configuration |
| object of type | automated standby update configuration |
| object of type | information about the primary database or cluster |
| string | replication mode for PostgreSQL configurations, or empty for other configuration types (possible values: 'not available', 'ARCHIVING', 'LOGSHIPPING' and 'STREAMING') |
| object of type | information about the standby database or cluster |
| string | time gap between primary and standby, formatted for display |
| integer | number of seconds standby is behind primary, or null if not available |
| object of type | standby update delay configuration |
auto_update_config
Property | Type | Description |
|---|---|---|
| boolean | whether automated standby updated is enabled |
| integer | the configured automated standby update interval in seconds |
database_info
Property | Type | Description |
|---|---|---|
| string | host name of the database, instance or cluster |
| integer | cluster port for PostgreSQL configurations, instance port for SQL Server configurations, or omitted for Oracle configurations |
| string | database or cluster state, if requested, otherwise empty |
observer_config
Property | Type | Description |
|---|---|---|
| integer | the configured observer check interval in seconds |
| string | full path of the custom script to use on the primary host |
| string | whether and how to use custom scripts to affect the Observer's behavior' (possible values: 'disabled', 'custom-only', 'either' and 'both') |
| string | full path of the custom script to use on the standby host |
| string | action to take once the maximum number of failures has been reached (possible values: 'activate' and 'notify') |
| boolean | whether the observer is 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 |
| integer | the hour of the day in the Control Center timezone at which to send the heartbeat notification (0-23) |
| integer | the minute of the hour at which to send the heartbeat notification (0-59) |
| integer | once this number of failures has been reached, the emergency action is taken and the observer is disabled |
| boolean | whether to send notifications to the email addresses configured for notifications on the configuration |
| boolean | whether to send notifications to the Slack webhooks configured for notifications on the configuration |
| boolean | whether to send a notification if the time gap exceeds the configured threshold |
| integer | maximum number of seconds for the time gap check |
update_delay_config
Property | Type | Description |
|---|---|---|
| integer | number of minutes to keep standby behind primary; 0 to disable |
{
"error": {
"message": "string"
},
"result": {
"configurations": [
{
"auto_update": {
"enabled": false,
"interval_seconds": 123
},
"configuration_id": 1,
"configuration_name": "string",
"configuration_type": "oracle",
"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
}
}
]
},
"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
}