4 Cluster Start, Restart, Disconnect Status and Cluster Events APIs

Cluster Start Restart, Disconnect Status and Cluster Status Events APIs provide the APIs for displaying the status events like Start, Restart, Restore, Cluster Status Events.

Note:

  • "base-uri" will be "<db-monitor-svc service name>.<namespace>:8080"
  • The namespace "occne-cndbtier" is given in the documentation only as an indicative purpose.
  • Users must configure the name according to the environment.

4.1 Reset Cluster Restart/Disconnect Status for Current cnDBTier Cluster API

This API resets the cluster_restart_disconnect value to 0 for the current cnDBTier cluster.

URL: http://base-uri/db-tier/reset/parameter/cluster_restart_disconnect

Method: POST

API Type: Realtime API

API Definition

Request Payload Response Code Response Payload
NA

200 OK Successfully Updated cluster_restart_disconnect to 0

500 INTERNAL SERVER ERROR - failed to reset cluster_restart_disconnect

 NA

API Configurations

NA

4.2 Reset Cluster Restart/Disconnect Status for Specific cnDBTier Cluster API

This API resets the cluster_restart_disconnect value to 0 for the specific cnDBTier cluster API.

API Definition

URL: http://base-uri/db-tier/reset/cluster/{cluster-name}/parameter/cluster_restart_disconnect

Method: POST

API Type: Realtime API

Request Payload Response Code Response Payload
NA

200 OK Successfully Updated cluster_restart_disconnect to 0

404 Not Found - The cluster name has not been configured.

500 INTERNAL SERVER ERROR - failed to reset cluster_restart_disconnect

 NA

API Configuration

NA

4.3 Retrieve the current cluster Status Events along with last event occurred API

This API retrieves the current cnDBTier cluster status along with the most recent cluster status event that occurred.

API Definition

URL: http://base-uri/db-tier/cluster/status

Method: GET

API Type: Realtime API

Request Payload Response Code Response Payload
NA

200 OK - Successfully fetched the cluster status with the last event occurred

500 INTERNAL SERVER ERROR - Unable to fetch cluster status with the last event occurred

 
{
  "clusterName": "<cluster name>",
  "currentTS": "<current timestamp in UTC format>",
  "lastStartTS": "<last start Time Stamp if present else blank>",
  "lastRestoreTS": "<last restore Time Stamp if present else blank>",
  "lastDBResyncTS": "<last DB Resync Time Stamp if present else blank>",
  "lastRestartTS": "<last Restart Time Stamp if present else blank>",

  "lastFailureTS": "<last Failure Time Stamp if present else blank>",
  "lastCheckpointTS": "<last Checkpoint Time Stamp if present else blank>",
  "lastMonitorPollTS": "<last Monitor Poll Time Stamp if present else blank>",
  "clusterDisconnectCount": "<Cluster Disconnect Count>",
  "eventsList": [
    {
      "eventType": "<event Type>",
      "eventTS": "<Time Stamp at which event occurred>"
    }
  ],
  "remoteSitesMonitorTS": [
    {
      "clusterName": "<cluster name>",
      "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
    },
    {
      "clusterName": "<cluster name>",
      "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
    }
  ]
}

API Configuration

Field Description Details
clusterName This attribute displays the cluster name.

DataType: String

Constraints: NA

Default Value: NA

currentTS This attribute displays the current timestamp.

DataType: Timestamp

Constraints: NA

Default Value: NA

lastStartTS This attribute displays the last start Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastRestoreTS This attribute displays the last restore Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastDBResyncTS This attribute displays the last DB Resync Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastRestartTS This attribute displays the last Restart Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastFailureTS This attribute displays the last Failure Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastCheckpointTS This attribute displays the last Checkpoint Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastMonitorPollTS This attribute displays the last Monitor Poll Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

clusterDisconnectCount This attribute displays the Cluster Disconnect Count

DataType: Integer

Constraints: NA

Default Value: 0

eventsList This attribute displays the list of the event details.

DataType: List

Constraints: NA

Default Value: NA

eventType This attribute displays the event type.

DataType: String

Constraints: NA

Default Value: NA

eventTS This attribute displays the event timestamp.

DataType: Timestamp

Constraints: NA

Default Value: NA

remoteSitesMonitorTS This attribute displays the remote site monitor timestamps.

DataType: Timestamp

Constraints: NA

Default Value: NA

monitorTS This attribute displays the Last Monitor Time Stamp for the cluster If present else blank.

DataType: Timestamp

Constraints: NA

Default Value: NA

4.4 Retrieve the current cluster Status Events along with last <numberOfLastEvents> event occurred API

This API retrieves the current DB Tier cluster status along with the most recent cluster status events.

API Definition

URL: http://base-uri/db-tier/cluster/status/events/{numberOfLastEvents}

Method: GET

API Type: Realtime API

Request Payload Response Code Response Payload
NA

200 OK - Successfully fetched the cluster status with the last <numberOfLastEvents> events occurred

400 BAD REQUEST - If {numberOfLastEvents} exceeds the configured max count which is by default 10

500 INTERNAL SERVER ERROR - Unable to fetch cluster status with the last event occurred

 
http://base-uri/db-tier/cluster/status/events/{numberOfLastEvents}	GET	NA	
200 OK - Successfully fetched the cluster status with the last <numberOfLastEvents> events occurred

400 BAD REQUEST - If {numberOfLastEvents} exceeds the configured max count which is by default 10

500 INTERNAL SERVER ERROR - Unable to fetch cluster status with the last event occurred

 

{
  "clusterName": "<cluster name>",
  "currentTS": "<current timestamp in UTC format>",
  "lastStartTS": "<last start Time Stamp if present else blank>",
  "lastRestoreTS": "<last restore Time Stamp if present else blank>",
  "lastDBResyncTS": "<last DB Resync Time Stamp if present else blank>",
  "lastRestartTS": "<last Restart Time Stamp if present else blank>",

  "lastFailureTS": "<last Failure Time Stamp if present else blank>",
  "lastCheckpointTS": "<last Checkpoint Time Stamp if present else blank>",
  "lastMonitorPollTS": "<last Monitor Poll Time Stamp if present else blank>",
  "clusterDisconnectCount": "<Cluster Disconnect Count>",
  "eventsList": [
    {
      "eventType": "<event Type>",
      "eventTS": "<Time Stamp at which event occurred>"
    },

    {
      "eventType": "<event Type>",
      "eventTS": "<Time Stamp at which event occurred>"
    }
  ],
  "remoteSitesMonitorTS": [
    {
      "clusterName": "<cluster name>",
      "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
    },
    {
      "clusterName": "<cluster name>",
      "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
    }
  ]
}

RealTime A

API Configuration

Field Description Details
clusterName This attribute displays the cluster name.

DataType: String

Constraints: NA

Default Value: NA

currentTS This attribute displays the current timestamp.

DataType: Timestamp

Constraints: NA

Default Value: NA

lastStartTS This attribute displays the last start Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastRestoreTS This attribute displays the last restore Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastDBResyncTS This attribute displays the last DB Resync Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastRestartTS This attribute displays the last Restart Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastFailureTS This attribute displays the last Failure Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastCheckpointTS This attribute displays the last Checkpoint Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastMonitorPollTS This attribute displays the last Monitor Poll Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

clusterDisconnectCount This attribute displays the Cluster Disconnect Count

DataType: Integer

Constraints: NA

Default Value: 0

eventsList This attribute displays the list of the event details.

DataType: List

Constraints: NA

Default Value: NA

eventType This attribute displays the event type.

DataType: String

Constraints: NA

Default Value: NA

eventTS This attribute displays the event timestamp.

DataType: Timestamp

Constraints: NA

Default Value: NA
remoteSitesMonitorTS This attribute displays the remote site monitor timestamps.

DataType: Timestamp

Constraints: NA

Default Value: NA

monitorTS This attribute displays the Last Monitor Time Stamp for the cluster If present else blank.

DataType: Timestamp

Constraints: NA

Default Value: NA

4.5 Retrieve all Cluster Status Events along with last event occurred API

This API retrieves the cnDBTier cluster status information for all cluster status events, including the most recent event that occurred.

API Definition

URL: http://base-uri/db-tier/all/cluster/status/

Method: GET

API Type: Realtime API

Request Payload Response Code Response Payload
NA

200 OK - Successfully fetched the cluster status with the last event occurred

500 INTERNAL SERVER ERROR - Unable to fetch cluster status with the last event occurred

 
[
    {
      "clusterName": "<cluster name>",
      "currentTS": "<current timestamp in UTC format>",
      "lastStartTS": "<last start Time Stamp if present else blank>",
      "lastRestoreTS": "<last restore Time Stamp if present else blank>",
      "lastDBResyncTS": "<last DB Resync Time Stamp if present else blank>",
      "lastRestartTS": "<last Restart Time Stamp if present else blank>",

      "lastFailureTS": "<last Failure Time Stamp if present else blank>",
      "lastCheckpointTS": "<last Checkpoint Time Stamp if present else blank>",
      "lastMonitorPollTS": "<last Monitor Poll Time Stamp if present else blank>",
      "clusterDisconnectCount": "<Cluster Disconnect Count>",
      "eventsList": [
        {
          "eventType": "<event Type>",
          "eventTS": "<Time Stamp at which event occurred>"
        }
      ],
      "remoteSitesMonitorTS": [
        {
          "clusterName": "<cluster name>",
          "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
        },
        {
          "clusterName": "<cluster name>",
          "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
        }
      ]
    },

 {
      "clusterName": "<cluster name>",
      "currentTS": "<current timestamp in UTC format>",
      "lastStartTS": "<last start Time Stamp if present else blank>",
      "lastRestoreTS": "<last restore Time Stamp if present else blank>",
      "lastDBResyncTS": "<last DB Resync Time Stamp if present else blank>",
      "lastRestartTS": "<last Restart Time Stamp if present else blank>",

      "lastFailureTS": "<last Failure Time Stamp if present else blank>",
      "lastCheckpointTS": "<last Checkpoint Time Stamp if present else blank>",
      "lastMonitorPollTS": "<last Monitor Poll Time Stamp if present else blank>",
      "clusterDisconnectCount": "<Cluster Disconnect Count>",
      "eventsList": [
        {
          "eventType": "<event Type>",
          "eventTS": "<Time Stamp at which event occurred>"
        }
      ],
      "remoteSitesMonitorTS": [
        {
          "clusterName": "<cluster name>",
          "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
        },
        {
          "clusterName": "<cluster name>",
          "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
        }
      ]
    }
]

API Configuration

Field Description Details
clusterName This attribute displays the cluster name.

DataType: String

Constraints: NA

Default Value: NA

currentTS This attribute displays the current timestamp.

DataType: Timestamp

Constraints: NA

Default Value: NA

lastStartTS This attribute displays the last start Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastRestoreTS This attribute displays the last restore Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastDBResyncTS This attribute displays the last DB Resync Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastRestartTS This attribute displays the last Restart Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastFailureTS This attribute displays the last Failure Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastCheckpointTS This attribute displays the last Checkpoint Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastMonitorPollTS This attribute displays the last Monitor Poll Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

clusterDisconnectCount This attribute displays the Cluster Disconnect Count

DataType: Integer

Constraints: NA

Default Value: 0

eventsList This attribute displays the list of the event details.

DataType: List

Constraints: NA

Default Value: NA

eventType This attribute displays the event type.

DataType: String

Constraints: NA

Default Value: NA

eventTS This attribute displays the event timestamp.

DataType: Timestamp

Constraints: NA

Default Value: NA

remoteSitesMonitorTS This attribute displays the remote site monitor timestamps.

DataType: Timestamp

Constraints: NA

Default Value: NA

monitorTS This attribute displays the Last Monitor Time Stamp for the cluster If present else blank.

DataType: Timestamp

Constraints: NA

Default Value: NA

4.6 Retrieve all cluster Status Events along with last <numberOfLastEvents> event occurred API

This API retrieves the cnDBTier cluster status information for all cluster status events, including the most recent event that occurred.

API Definition

URL: http://base-uri/db-tier/all/cluster/status/events/{numberOfLastEvents}

Method: GET

API Type: Realtime API

Request Payload Response Code Response Payload
NA

200 OK - Successfully fetched the cluster status with the last <numberOfLastEvents> events occurred

400 BAD REQUEST - If {numberOfLastEvents} exceeds the configured max count which is by default 10

500 INTERNAL SERVER ERROR - Unable to fetch cluster status with the last event occurred

 
[
    {
    
      "clusterName": "<cluster name>",
      "currentTS": "<current timestamp in UTC format>",
      "lastStartTS": "<last start Time Stamp if present else blank>",
      "lastRestoreTS": "<last restore Time Stamp if present else blank>",
      "lastDBResyncTS": "<last DB Resync Time Stamp if present else blank>",
      "lastRestartTS": "<last Restart Time Stamp if present else blank>",

      "lastFailureTS": "<last Failure Time Stamp if present else blank>",
      "lastCheckpointTS": "<last Checkpoint Time Stamp if present else blank>",
      "lastMonitorPollTS": "<last Monitor Poll Time Stamp if present else blank>",
      "clusterDisconnectCount": "<Cluster Disconnect Count>",
      "eventsList": [
        {
          "eventType": "<event Type>",
          "eventTS": "<Time Stamp at which event occurred>"
        },
    
        {
          "eventType": "<event Type>",
          "eventTS": "<Time Stamp at which event occurred>"
        }
      ],
      "remoteSitesMonitorTS": [
        {
          "clusterName": "<cluster name>",
          "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
        },
        {
          "clusterName": "<cluster name>",
          "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
        }
      ]
    },
    
    
    {
      "clusterName": "<cluster name>",
      "currentTS": "<current timestamp in UTC format>",
      "lastStartTS": "<last start Time Stamp if present else blank>",
      "lastRestoreTS": "<last restore Time Stamp if present else blank>",
      "lastDBResyncTS": "<last DB Resync Time Stamp if present else blank>",
      "lastRestartTS": "<last Restart Time Stamp if present else blank>",

      "lastFailureTS": "<last Failure Time Stamp if present else blank>",
      "lastCheckpointTS": "<last Checkpoint Time Stamp if present else blank>",
      "lastMonitorPollTS": "<last Monitor Poll Time Stamp if present else blank>",
      "clusterDisconnectCount": "<Cluster Disconnect Count>",
      "eventsList": [
        {
          "eventType": "<event Type>",
          "eventTS": "<Time Stamp at which event occurred>"
        },
    
        {
          "eventType": "<event Type>",
          "eventTS": "<Time Stamp at which event occurred>"
        }
      ],
      "remoteSitesMonitorTS": [
        {
          "clusterName": "<cluster name>",
          "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
        },
        {
          "clusterName": "<cluster name>",
          "monitorTS": "<Last Monitor Time Stamp for the cluster If present else blank>"
        }
      ]
    }
]

API Configuration

Field Description Details
clusterName This attribute displays the cluster name.

DataType: String

Constraints: NA

Default Value: NA

currentTS This attribute displays the current timestamp.

DataType: Timestamp

Constraints: NA

Default Value: NA

lastStartTS This attribute displays the last start Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastRestoreTS This attribute displays the last restore Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastDBResyncTS This attribute displays the last DB Resync Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastRestartTS This attribute displays the last Restart Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastFailureTS This attribute displays the last Failure Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastCheckpointTS This attribute displays the last Checkpoint Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

lastMonitorPollTS This attribute displays the last Monitor Poll Time Stamp if present else blank

DataType: Timestamp

Constraints: NA

Default Value: NA

clusterDisconnectCount This attribute displays the Cluster Disconnect Count

DataType: Integer

Constraints: NA

Default Value: 0
eventsList This attribute displays the list of the event details.

DataType: List

Constraints: NA

Default Value: NA

eventType This attribute displays the event type.

DataType: String

Constraints: NA

Default Value: NA

eventTS This attribute displays the event timestamp.

DataType: Timestamp

Constraints: NA

Default Value: NA

remoteSitesMonitorTS This attribute displays the remote site monitor timestamps.

DataType: Timestamp

Constraints: NA

Default Value: NA

monitorTS This attribute displays the Last Monitor Time Stamp for the cluster If present else blank.

DataType: Timestamp

Constraints: NA

Default Value: NA