8 Console APIs
Each NF integrates cnDBTier APIs in their menuCncc.json file. A sample cnDBTier menuCncc.json file to be integrated with NF menuCncc.json file is mentioned below.
Note:
NFs and end users should not directly invoke the REST APIs described in this section. All configurations must be performed using the Console GUI, which automatically runs the required API calls.A sample menuCncc.json file:
{
"menu": {
"routeConfig": {
"home": {
"label": "Home",
"value": "home",
"isDefault": true
},
"commonServices": {
"label": "Common Services",
"value": "commonServices",
"isDefault": true
},
"services/{nf}/{service}": {
"label": "Services",
"value": "services"
},
"configurations/{nf}/{configType}": {
"label": "Configurations",
"value": "configurations"
}
},
"menuItems": [
{
"attr": {
"id": "cnDBTier",
"name": "cnDBTier",
"sequence": 10
},
"children": [
{
"attr": {
"id": "services/<NF Name>/dbconfig-backupList",
"name": "Backup List",
"sequence": 10
}
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-ndbBackupStatus",
"name": "cnDBTier Backup Status",
"sequence": 15
}
},
{
"attr": {
"id": "cnDBTierHealth",
"name": "cnDBTier Health",
"sequence": 20
},
"children": [
{
"attr": {
"id": "services/<NF Name>/dbconfig-backupHealthStatus",
"name": "Backup Manager Health Status",
"sequence": 100
}
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-monitorHealthStatus",
"name": "Monitor Health Status",
"sequence": 110
}
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-ndbHealthStatus",
"name": "NDB Health Status",
"sequence": 120
}
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-replicationHealthStatus",
"name": "Replication Health Status",
"sequence": 130
}
}
]
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-version",
"name": "cnDBTier Version",
"sequence": 30
}
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-databaseStatisticsReport",
"name": "Database Statistics Report",
"sequence": 40
}
},
{
"attr": {
"id": "GeoreplicationRecovery",
"name": "Georeplication Recovery",
"sequence": 50
},
"children": [
{
"attr": {
"id": "services/<NF Name>/dbconfig-updateClusterAsFailed",
"name": "Update Cluster As Failed",
"sequence": 100
}
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-startGeoreplicationRecovery",
"name": "Start Georeplication Recovery",
"sequence": 110
}
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-georeplicationRecoveryStatus",
"name": "Georeplication Recovery Status",
"sequence": 120
}
}
]
},
{
"attr": {
"id": "configurations/<NF Name>/dbconfig-geoReplicationStatus",
"name": "Georeplication Status",
"sequence": 60
}
},
{
"attr": {
"id": "configurations/<NF Name>/dbconfig-geoReplicationStatusAcrossAll",
"name": "Georeplication Status Across All Sites",
"sequence": 110
}
},
{
"attr": {
"id": "GracefullyStopAndStartGeoreplication",
"name": "Gracefully Stop And Start Georeplication",
"sequence": 140
},
"children": [
{
"attr": {
"id": "services/<NF Name>/dbconfig-stopGeoReplication",
"name": "Stop Georeplication",
"sequence": 100
}
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-startGeoReplication",
"name": "Start Georeplication",
"sequence": 110
}
}
]
},
{
"attr": {
"id": "configurations/<NF Name>/dbconfig-ipFamilyPreference",
"name": "IP Preference For Replication Channel",
"sequence": 120
}
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-clusterStatus",
"name": "Local Cluster Status",
"sequence": 70
}
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-onDemandBackup",
"name": "On Demand Backup",
"sequence": 80
}
},
{
"attr": {
"id": "services/<NF Name>/dbconfig-heartBeatStatus",
"name": "Replication HeartBeat Status",
"sequence": 90
}
}
]
}
]
}
}CNC-Console GUI is the consumer of these APIs
DB Tier Status API will facilitate CNC Console user interface to determine the status of the cnDBTier and associated cross-site replication. The DB Tier Status API is hosted by the DB Monitor service.
Note:
- The "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. The users are requested to configure the name according to their environment.
curl http://mysql-cluster-db-monitor-svc.occne-cndbtier:8080/ocdbtier/status/replication/realtime8.1 Site Specific Real Time Replication Status API
This API is used to check the real-time geo-replication status between the current cnDBTier site or cluster and a specific mate site.
API Definition
URI: http://base-uri/ocdbtier/status/replication/realtime/{remoteSiteName}
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK - Cross-site replication is active | |
| 503 Service Unavailable - - Cross-site replication is not enabled | |
|
| 400 Bad Request | |
|
| 404 Not Found | |
|
| 500 Internal Server Error | |
API Configuration
| Field | Description | Details |
|---|---|---|
| localSiteName | This attribute displays the name of the current site in which the cnDBTier cluster is deployed. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the name of the remote site where replication is established. |
DataType: string Constraints: NA Default Value: NA |
| replicationStatus | This attribute displays the replication status with corresponding sites. |
DataType: string Constraints: UP, DOWN, INITIALIZING Default Value: NA |
| secondsBehindRemote | This attribute displays the number of seconds that the last record read by the local site is behind the latest record written by the remote site for all the replication groups. |
DataType: long Constraints: NA Default Value: NA |
| replicationGroupDelay | This attribute displays the seconds behind the remote site for individual replication groups. |
DataType: list Constraints: NA Default Value: NA |
| replchannel_group_id | This attribute displays the ID of the replication channel group. |
DataType: string Constraints: NA Default Value: NA |
| channelDetails | This attribute displays all channel details such as Remote Replication IP and Role. |
DataType: list Constraints: NA Default Value: NA |
| remote_replication_ip | This attribute displays the IP of the remote replication channel. |
DataType: string Constraints: NA Default Value: NA |
| role | This attribute displays the role of the replication channel IP. |
DataType: string Constraints: ACTIVE, STANDBY Default Value: NA |
8.2 Real Time Overall Replication Status API
API Definition
URI: http://base-uri/ocdbtier/status/replication/realtime
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK - Cross-site replication is active | |
| 503 Service Unavailable - Cross-site replication is not enabled | |
|
| 500 Internal Server Error | |
API Configuration
| Field | Description | Details |
|---|---|---|
| localSiteName | This attribute displays the name of the current site in which the cnDBTier cluster is deployed. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the name of the remote site where replication is established. |
DataType: string Constraints: NA Default Value: NA |
| replicationStatus | This attribute displays the replication status with corresponding sites. |
DataType: string Constraints: UP, DOWN, INITIALIZING Default Value: NA |
| secondsBehindRemote | This attribute displays the number of seconds that the last record read by the local site is behind the latest record written by the remote site for all the replication groups. |
DataType: long Constraints: NA Default Value: NA |
| replicationGroupDelay | This attribute displays the seconds behind the remote site for individual replication groups. |
DataType: list Constraints: NA Default Value: NA |
| replchannel_group_id | This attribute displays the ID of the replication channel group. |
DataType: string Constraints: NA Default Value: NA |
8.3 Real Time Local Cluster Status API
This API provides the current operational status of a local cnDBTier cluster in real time.
API Definition
URI: http://base-uri/ocdbtier/status/cluster/local/realtime
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK- The local NDB cluster is UP or DOWN | |
| 500 Internal Server Error | |
API Configuration
| Field | Description | Details |
|---|---|---|
| clusterName | This attribute displays the name of the current cluster in which the cnDBTier cluster is deployed. |
DataType: string Constraints: NA Default Value: NA |
| clusterStatus | This attribute displays the local cluster status for the current cluster. |
DataType: string Constraints: UP, DOWN Default Value: NA |
8.4 cnDBTier Version API
This section provides cnDBTier Version API that provides version information for the cnDBTier deployment, including the cnDBTier software version and the NDB version.
API Definition
URI: http://base-uri/ocdbtier/version
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 500 Internal Server Error | |
API Configuration
| Field | Description | Details |
|---|---|---|
| cndbtier_version | This attribute displays the cnDBTier version. |
DataType: string Constraints: NA Default Value: NA |
| ndb_version | This attribute displays the network database (NDB) version. |
DataType: string Constraints: NA Default Value: NA |
8.5 Site Specific Listing the Completed Backups API
This API is used to retrieve the list of completed backups for a specific site.
API Definition
URI: http://base-uri/ocdbtier/list/backups
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK - Fetched the Heart Beat Status of every replication service running on the current cluster | {
"localSiteName": "<current_site_name>",
"backupDetails": [
{
"backupId": "<backup identifier>",
"backupSize": "<size of backup>",
"creationTimeStamp": "<timestamp at which backup was initiated>"
},
{
"backupId": "<backup identifier>",
"backupSize": "<size of backup>",
"creationTimeStamp": "<timestamp at which backup was initiated>"
},
{
"backupId": "<backup identifier>",
"backupSize": "<size of backup>",
"creationTimeStamp": "<timestamp at which backup was initiated>"
}
]
} |
| 404 NOT FOUND Table Missing | {
"title": "Not Found",
"status": 404,
"detail": "DBTIER_BACKUP_INFO table doesn't exist in the current site so cannot list the backup",
"cause": null,
"invalidParams": null
} |
|
| 500 INTERNAL SERVER ERROR | {
"title": "Internal Server Error",
"status": 500,
"detail": "Could not list the backups",
"cause": null,
"invalidParams": null
} |
API Configurations
| Field | Description | Details |
|---|---|---|
| localSiteName | This attribute displays the name of the current site in which the cnDBTier cluster is deployed. |
DataType: string Constraints: NA Default Value: NA |
| backupDetails | This attribute displays the following information like backup ID, backup size, and backup creation timestamp. |
DataType: List Constraints: NA Default Value: NA |
| backupId | This attribute displays the ID of the stored backup. |
DataType: big integer Constraints: NA Default Value: NA |
| backupSize | This attribute displays the size(in bytes) of the stored backup. |
DataType: big integer Constraints: NA Default Value: NA |
| creationTimeStamp | This attribute displays the time recorded when the backup was stored. |
DataType: timestamp Constraints: NA Default Value: NA |
8.6 Database Statistics Reports API
This API retrieves database statistics reports for the cnDBTier environment.
API Definition
URI: http://base-uri/ocdbtier/statistics/report/dbinfo
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 503 SERVICE_UNAVAILABLE | {
"title": "Service Unavailable",
"status": 503,
"detail": "<Exception details>",
"cause": null,
"invalidParams": null
} |
|
| 500 INTERNAL_SERVER_ERROR | {
"title": "Internal Server Error",
"status": 500,
"detail": "<Exception Details>",
"cause": null,
"invalidParams": null
} |
API Configuration
| Field | Description | Details |
|---|---|---|
| databaseCount | This attribute displays the number of available databases. |
DataType: integer Constraints: NA Default Value: NA |
| databaseTablesCount | This attribute displays the available database names and their table count. |
DataType: list Constraints: NA Default Value: NA |
| dbName | This attribute displays the database name. |
DataType: string Constraints: NA Default Value: NA |
| tableCount | This attribute displays the table count for each database. |
DataType: integer Constraints: NA Default Value: NA |
| databaseTableRowsCount | This attribute displays all the tables within a database along with their respective row counts. |
DataType: list Constraints: NA Default Value: NA |
| tables | This attribute displays the names of individual tables in a database along with the number of rows they contain. |
DataType: string Constraints: NA Default Value: NA |
| tableName | This attribute displays the table name. |
DataType: string Constraints: NA Default Value: NA |
| rowCount | This attribute displays the total count of rows within a table. |
DataType: string Constraints: NA Default Value: NA |
8.7 Overall HeartBeat Status API
This API checks the overall heartbeat status of the cnDBTier environment.
API Definition
URI: http://base-uri/ocdbtier/heartbeat/status
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | {
"heartBeatDetails": [
{
"remoteSiteName": "<remote_site_name>",
"heartBeatStatus": "<SUCCESS/FAILURE>",
"heartBeatLag": "<Heart Beat Lag in Seconds>",
"replicationChannelGroupId": <replication channel group id>
},
{
"remoteSiteName": "<remote_site_name>",
"heartBeatStatus": "<SUCCESS/FAILURE>",
"heartBeatLag": "<Heart Beat Lag in Seconds>",
"replicationChannelGroupId": <replication channel group id>
}
],
"siteName": "<current_site_name>", } |
| 503 SERVICE_UNAVAILABLE - Not able to query the Data Base | {
"title": "Service Unavailable",
"status": 503,
"detail": "Not able to query the Data Base",
"cause": null,
"invalidParams": null
} |
|
| 500 INTERNAL_SERVER_ERROR - Could Not Check The HeartBeat Status | {
"title": "Internal Server Error",
"status": 500,
"detail": "Could Not Check The HeartBeat Status",
"cause": null,
"invalidParams": null
} |
API Configuration
| Field | Description | Details |
|---|---|---|
| heartBeatDetails | This attribute displays the following information like remote site name, heartbeat status, heartbeat lag, and replication channel group ID. |
DataType: list Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the name of the remote site where replication is established. |
DataType: String Constraints: NA Default Value: NA |
| heartBeatStatus | This attribute displays the connectivity status with corresponding sites. |
DataType: String Constraints: SUCCESS, FAILURE Default Value: NA |
| heartBeatLag | This attribute displays the lag or latency in seconds it took to synchronize between sites. |
DataType: String Constraints: NA Default Value: NA |
| replicationChannelGroupId | This attribute displays the ID of the replication channel group. |
DataType: Integer Constraints: NA Default Value: NA |
| siteName | This attribute displays the name of the current site in which the cnDBTier cluster is deployed. |
DataType: String Constraints: NA Default Value: NA |
8.8 On Demand Backup GET API
This API retrieves information about an on-demand backup operation.
API Definition
URI: http://base-uri/ocdbtier/on-demand/backup/initiate
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | {
"siteName": "<current_site_name>",
"drStatus": "<drStatus>",
"backupId": "<backupId>",
"backupStatus": "<backupStatus>",
"remoteTransferStatus": "<remoteTransferStatus>",
"initiateBackup": false/true,
"transferStatus":"<transferStatus>"
} |
| 404 NOT FOUND | {
"title": "Not Found",
"status": 404,
"detail": "<Exception mesage>",
"cause": null,
"invalidParams": null
} |
|
| 500 INTERNAL_SERVER_ERROR | {
"title": "Internal Server Error",
"status": 500,
"detail": "<Exception message>",
"cause": null,
"invalidParams": null |
API Configuration
| Field | Description | Details |
|---|---|---|
| siteName | This attribute displays the name of the current site in which the cnDBTier cluster is deployed. |
DataType: string Constraints: NA Default Value: NA |
| drStatus | This attribute displays the disaster recovery status. |
DataType: string Constraints: NA Default Value: NA |
| backupId | This attribute displays the ID of the stored backup. |
DataType: string Constraints: NA Default Value: NA |
| backupStatus | This attribute displays the status of the backup. |
DataType: string Constraints: STARTED, FAILED, COMPLETED, PURGED, PURGED_EARLY Default Value: NA |
| remoteTransferStatus | The attribute displays the status of the remote transfer. |
DataType: string Constraints: NA Default Value: NA |
| transferStatus | The attribute displays the status of the local transfer. |
DataType: string Constraints: NA Default Value: NA |
| initiateBackup | The attribute displays whether the backup is initiated or not. |
DataType: boolean Constraints: true, false Default Value: NA |
8.9 On Demand Initiate Backup POST API
This API is used to start a new backup operation manually.
API Definition
URI: http://base-uri/ocdbtier/on-demand/backup/initiate
Method: POST
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
|
200 OK | {
"siteName": "<current_site_name>",
"drStatus": "<drStatus>",
"backupId": "<backupId>",
"backupStatus": "<backupStatus>",
"remoteTransferStatus": "<remoteTransferStatus>",
"initiateBackup": false/true,
"transferStatus":"<transferStatus>"
} |
| 400 BAD REQUEST | |
|
| 404 NOT FOUND | {
"title": "Not Found",
"status": 404,
"detail": "<Exception message>",
"cause": null,
"invalidParams": null
} |
|
| 500 INTERNAL_SERVER_ERROR | {
"title": "Internal Server Error",
"status": 500,
"detail": "BACKUP_INITIATION_FAILED",
"cause": null,
"invalidParams": null
} |
API Configuration
| Field | Description | Details |
|---|---|---|
| siteName | This attribute displays the name of the current site in which the cnDBTier cluster is deployed. |
DataType: string Constraints: NA Default Value: NA |
| drStatus | This attribute displays the disaster recovery status. |
DataType: string Constraints: NA Default Value: NA |
| backupId | This attribute displays the ID of the stored backup. |
DataType: string Constraints: NA Default Value: NA |
| backupStatus | This attribute displays the status of the backup. |
DataType: string Constraints: STARTED, FAILED, COMPLETED, PURGED, PURGED_EARLY Default Value: NA |
| remoteTransferStatus | The attribute displays the status of the remote transfer. |
DataType: string Constraints: NA Default Value: NA |
| transferStatus | The attribute displays the status of the local transfer. |
DataType: string Constraints: NA Default Value: NA |
| initiateBackup | The attribute displays whether the backup is initiated or not. |
DataType: boolean Constraints: true, false Default Value: NA |
8.10 Replication Health Status API
This API displays the health status of the cnDBTier replication service.
API Definition
URI: http://base-uri/ocdbtier/health-info/replication-svc/status
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | {
"localSiteName": "<siteName>",
"healthStatusDetails": [
{
"serviceName": "<serviceName>",
"serviceStatus": "UP/DOWN",
"connectionToDbStatus": "UP/DOWN",
"overAllReplicationServiceHealth": "UP/DOWN"
},
{
"serviceName": "<serviceName>",
"serviceStatus": "UP/DOWN",
"connectionToDbStatus": "UP/DOWN",
"overAllReplicationServiceHealth": "UP/DOWN"
}.......
]
} |
| 503 SERVICE_UNAVAILABLE - Replication Service IP is empty | {
"title": "Service Unavailable",
"status": 503,
"detail": "Replication Service IP is empty",
"cause": null,
"invalidParams": null
} |
|
| 500 INTERNAL_SERVER_ERROR - Could Not Check The Replication Health Status | {
"title": "Internal Server Error",
"status": 500,
"detail": "Could Not Check The Health Status",
"cause": null,
"invalidParams": null
} |
API Configuration
| Field | Description | Details |
|---|---|---|
| localSiteName | This attribute displays the name of the current site in which the cnDBTier cluster is deployed. |
DataType: string Constraints: NA Default Value: NA |
| healthStatusDetails | This attribute displays the following information like service name, service status, database connection status, and overall health of the replication service. |
DataType: list Constraints: NA Default Value: NA |
| serviceName | This attribute displays the name of the cnDBTier microservice followed by the namespace. |
DataType: string Constraints: NA Default Value: NA |
| serviceStatus | This attribute displays the status of the corresponding cnDBTier microservice. |
DataType: string Constraints: UP, DOWN Default Value: NA |
| connectionToDbStatus | This attribute displays the status of the database connection. |
DataType: string Constraints: UP, DOWN Default Value: NA |
| overAllReplicationServiceHealth | This attribute displays the operational well-being of the replication service. |
DataType: string Constraints: UP, DOWN Default Value: NA |
8.11 Monitor Service Health Status API
This API displays the health status of the cnDBTier monitor service.
API Definition
URI: http://base-uri/ocdbtier/health-info/monitor-svc/status
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK (Monitor Service is healthy) | |
API Configuration
| Field | Description | Details |
|---|---|---|
| serviceName | This attribute displays the name of the cnDBTier microservice. |
DataType: string Constraints: NA Default Value: NA |
| connectionToDbStatus | This attribute displays the status of the database connection. |
DataType: string Constraints: UP, DOWN Default Value: NA |
| metricScrapeStatus | This attribute indicates whether the monitor service can collect the metrics or not. |
DataType: string Constraints: UP, DOWN Default Value: NA |
| overAllMonitorServiceHealth | This attribute displays the operational well-being of the monitor service. |
DataType: string Constraints: UP, DOWN Default Value: NA |
8.12 All NDB Health Status API
This API displays the health status of all cnDBTier NDB service pods.
API Definition
URI: http://base-uri/ocdbtier/health-info/ndb-svc/status
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | {
"localSiteName": "<siteName>",
"ndbHealthStatusDetails": [
{
"serviceName": "<serviceName>",
"serviceStatus": "UP/DOWN",
"pvcHealthStatus": "UP/DOWN"
},
{
"serviceName": "<serviceName>",
"serviceStatus": "UP/DOWN",
"pvcHealthStatus": "UP/DOWN"
}.......
]
} |
| 404 NOT FOUND - sitename not found | {
"title": "Not Found",
"status": 404,
"detail": "sitename not found",
"cause": null,
"invalidParams": null
} |
|
| 500 INTERNAL_SERVER_ERROR - Could Not Check The Health Status | {
"title": "Internal Server Error",
"status": 500,
"detail": "Could Not Check The Health Status",
"cause": null,
"invalidParams": null
} |
API Configuration
| Field | Description | Details |
|---|---|---|
| localSiteName | This attribute displays the name of the current site in which the cnDBTier cluster is deployed. |
DataType: string Constraints: NA Default Value: NA |
| ndbHealthStatusDetails | This attribute displays the following information like service name, service status, PVC health status of management microservice, data microservice, replication SQL microservice, and application SQL microservice. |
DataType: list Constraints: NA Default Value: NA |
| serviceName | This attribute displays the name of the cnDBTier microservice. |
DataType: string Constraints: NA Default Value: NA |
| serviceStatus | This attribute displays the status of the corresponding cnDBTier microservice. |
DataType: string Constraints: UP, DOWN Default Value: NA |
| pvcHealthStatus | This attribute displays the PVC health status of the corresponding cnDBTier microservice. |
DataType: string Constraints: UP, DOWN Default Value: NA |
8.13 Backup Manager Service Health API
This API displays the health status of the cnDBTier backup manager service.
API Definition
URI: http://base-uri/ocdbtier/health-info/backup-mgr-svc/status
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 500 INTERNAL_SERVER_ERROR - Could Not Check The Health Status | {
"title": "Internal Server Error",
"status": 500,
"detail": "Could Not Check The Health Status",
"cause": null,
"invalidParams": null
} |
API Configuration
| Field | Description | Details |
|---|---|---|
| serviceName | This attribute displays the name of the cnDBTier microservice. |
DataType: string Constraints: NA Default Value: NA |
| connectionToDbStatus | This attribute displays the status of the database connection. |
DataType: string Constraints: UP, DOWN Default Value: NA |
| serviceStatus | This attribute displays the status of the corresponding cnDBTier microservice. |
DataType: string Constraints: UP, DOWN Default Value: NA |
| backupExecutorHealthStatus | This attribute displays the following information like node id, and database connection status. |
DataType: list Constraints: NA Default Value: NA |
| nodeId | This attribute displays the Node ID of the DB node. |
DataType: integer Constraints: NA Default Value: NA |
| overAllBackupManagerHealth | This attribute displays the operational well-being of the backup manager service. |
DataType: string Constraints: UP, DOWN Default Value: NA |
8.14 cnDBTier Cluster GRR Details API
This API displays the cnDBTier cluster details required for georeplication recovery.
API Definition
URI: http://base-uri/ocdbtier/list/clusterdetails
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 404 NOT FOUND | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| clusterName | This attribute displays the name of the current cluster in which the cnDBTier cluster is deployed. |
DataType: string Constraints: NA Default Value: NA |
| clusterId | This attribute displays the cluster ID. |
DataType: string Constraints: NA Default Value: NA |
| status | This attribute displays the local cluster GRR status for the current cluster. |
DataType: string Constraints: NOT_RUNNING, FAILED Default Value: NA |
8.15 Get cnDBTier Clusters Marked as Failed API
This API displays the cnDBTier clusters that are marked as failed. It helps users identify failed or disrupted clusters that may require georeplication recovery or other corrective actions.
API Definition
URI: http://base-uri/ocdbtier/markcluster/failed
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 404 NOT FOUND | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| clusterNameTobeMarkedAsFailed | This attribute displays the names of the clusters that has to be marked as failed. For this GET API it will be empty. |
DataType: string Constraints: NA Default Value: NA |
| failedClusterNames | This attribute displays the names of the clusters which has been marked as Failed |
DataType: list Constraints: NA Default Value: NA |
8.16 Mark cnDBTier Cluster As Failed API
This API marks a disrupted cnDBTier cluster as failed. It is used to identify the failed cluster before initiating georeplication recovery or other corrective actions.
API Definition
URI: http://base-uri/ocdbtier/markcluster/failed
Method: PUT
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
|
200 OK | |
| 404 NOT FOUND | |
|
| 400 BAD REQUEST | |
|
| 503 SERVICE_UNAVAILABLE | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| clusterNameTobeMarkedAsFailed | This attribute displays the name of the cluster that have to be marked as failed. In request Payload, It will be the site name which has to be marked as Failed but in response payload it will be empty. |
DataType: string Constraints: NA Default Value: NA |
| failedClusterNames | This attribute displays the names of the clusters which has been marked as Failed. In Request Payload it will be empty but in response it will contain all the clusters that has been marked as Failed. |
DataType: list Constraints: NA Default Value: NA |
8.17 Monitor Georeplication Recovery Status API
This API monitors the recovery status of georeplication for cnDBTier sites. This API is used to check the recovery state for both failed and active cnDBTier sites during or after a georeplication recovery operation.
API Definition
URI: http://base-uri/ocdbtier/faultrecovery/status
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | {
"localClusterName": "<local cluster name>",
"faultRecoverStatus": [
{
"clusterName": "<clusterName>",
"faultRecoverState": "<faultRecoverState>"
},
{
"clusterName": "<clusterName>",
"faultRecoverState": "<faultRecoverState>"
},
{
"clusterName": "<clusterName>",
"faultRecoverState": "<faultRecoverState>"
}
]
} |
| 404 NOT FOUND | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| localClusterName | This attribute displays the names of the local cluster from where the status API is called. |
DataType: string Constraints: NA Default Value: NA |
| faultRecoverStatus | This attribute displays the names of the clusters and their georeplication recovery state. |
DataType: list Constraints: NA Default Value: NA |
8.18 Start Georeplication Recovery API
This API is used to initiate recovery for a failed or disrupted cnDBTier cluster so that georeplication can be restored between the affected sites.
API Definition
URI: http://base-uri/ocdbtier/faultrecovery/start
Method: PUT
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
|
200 OK | |
| 404 NOT FOUND | |
|
| 400 BAD REQUEST | |
|
| 503 SERVICE_UNAVAILABLE | |
|
| 500 INTERNAL SERVER ERROR | |
|
| 409 CONFLICT | |
API Configuration
| Field | Description | Details |
|---|---|---|
| backupClusterName | This attribute displays the names of the cluster which will be used as backup cluster. |
DataType: string Constraints: NA Default Value: NA |
| failedClusterName | This attribute displays the names of the failed cluster. |
DataType: string Constraints: NA Default Value: NA |
8.19 cnDBTier Backup Status API
This API displays the current backup status of cnDBTier, including the current system time, current backup status, and the next scheduled backup time.
API Definition
URI: http://base-uri/ocdbtier/v1/backup/status
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload | API Type |
|---|---|---|---|
| NA | 200 OK | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| creationTs | This attribute displays the creation timestamp of the last backup. |
DataType: string Constraints: NA Default Value: NA |
| backupStatus | This attribute displays the last backup's status. |
DataType: boolean Constraints: NA Default Value: NA |
| nextBackupScheduleTime | This attribute displays the timestamp when he next backup is scheduled to start |
DataType: string Constraints: NA Default Value: NA |
8.20 Georeplication Status Across All Sites API
This API displays the real-time cross-site replication status for all configured mate or remote sites in a cnDBTier deployment.
API Definition
URI: http://base-uri/ocdbtier/replication/status/realtime
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 503 SERVICE_UNAVAILABLE | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| siteNameAndRemoteSiteName | This attribute displays site name and remote site name. |
DataType: String Constraints: NA Default Value: NA |
| siteName | This attribute displays site name. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the remote site name. |
DataType: string Constraints: NA Default Value: NA |
| status | This attribute displays the replication status between the site and remote site. |
DataType: string Constraints: UP/DOWN Default Value: NA |
| replicationDetailsPerGroupId | This attribute displays the replication channel details per group id. |
DataType: list Constraints: NA Default Value: NA |
| replicationGroupId | This attribute displays the replication channel group id. |
DataType: Integer Constraints: NA Default Value: NA |
| replicationDetailsPerGroupId.status | This attribute displays the replication channel status per group id. |
DataType: String Constraints: UP/DOWN Default Value: NA |
| allSqlStatusDetails | This attribute displays the all sql node details per group id. |
DataType: list Constraints: NA Default Value: NA |
| sqlNode | This attribute displays the sql node. |
DataType: String Constraints: NA Default Value: NA |
| sourceHost | This attribute displays the source host. |
DataType: String Constraints: NA Default Value: NA |
| externalIp | This attribute displays the external ip of the sql node. |
DataType: String Constraints: NA Default Value: NA |
| replicaIORunning | This attribute displays the replica IO is running. |
DataType: String Constraints: YES/NO Default Value: NA |
| replicaSQLRunning | This attribute displays the replica SQL is running. |
DataType: String Constraints: YES/NO Default Value: NA |
| serverId | This attribute displays the server id. |
DataType: Integer Constraints: NA Default Value: NA |
| role | This attribute displays the role of the sql node. |
DataType: String Constraints: ACTIVE/STANDBY/FAILED Default Value: NA |
| lastErrno | This attribute displays the last error. |
DataType: String Constraints: NA Default Value: NA |
| lastError | This attribute displays the last error number. |
DataType: String Constraints: NA Default Value: NA |
| lastIOErrno | This attribute displays the IO error number. |
DataType: String Constraints: NA Default Value: NA |
| lastIOError | This attribute displays the last IO error. |
DataType: String Constraints: NA Default Value: NA |
| lastSQLErrno | This attribute displays the last SQL error. |
DataType: String Constraints: NA Default Value: NA |
| lastSQLError | This attribute displays the last SQL error number. |
DataType: String Constraints: NA Default Value: NA |
| sqlRemainingDelay | This attribute displays the SQL remaining delay. |
DataType: String Constraints: NA Default Value: null |
| localAppliedEpoch | This attribute displays the Local Applied Epoch Value. |
DataType: Long Constraints: NA Default Value: NA |
| currentBinlogFileBeingReplicated | This attribute displays the Current Bin Log File Being Replicated. |
DataType: String Constraints: NA Default Value: null |
| binLogFileRange | This attribute displays the Bin Log File Range. |
DataType: String Constraints: NA Default Value: null |
| sourceSqlStatusDetails | This attribute displays the source SQL status details. |
DataType: map Constraints: NA Default Value: NA |
8.21 Georeplication Status Across All Given SiteName and Remote SiteName API
This API retrieves the current real-time georeplication status between a specified local site and a specified remote or mate site.
API Definition
URI: http://base-uri/ocdbtier/replication/status/realtime/{siteNameAndRemoteSiteName}
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 400 Bad Request | |
|
| 404 Not Found | |
|
| 503 SERVICE_UNAVAILABLE | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| siteNameAndRemoteSiteName | This attribute displays site name and remote site name. |
DataType: String Constraints: NA Default Value: NA |
| siteName | This attribute displays site name. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the remote site name. |
DataType: string Constraints: NA Default Value: NA |
| status | This attribute displays the replication status between the site and remote site. |
DataType: string Constraints: UP/DOWN Default Value: NA |
| replicationDetailsPerGroupId | This attribute displays the replication channel details per group id. |
DataType: list Constraints: NA Default Value: NA |
| replicationGroupId | This attribute displays the replication channel group id. |
DataType: Integer Constraints: NA Default Value: NA |
| replicationDetailsPerGroupId.status | This attribute displays the replication channel status per group id. |
DataType: String Constraints: UP/DOWN Default Value: NA |
| allSqlStatusDetails | This attribute displays the all sql node details per group id. |
DataType: list Constraints: NA Default Value: NA |
| sqlNode | This attribute displays the sql node. |
DataType: String Constraints: NA Default Value: |
| sourceHost | This attribute displays the source host. |
DataType: String Constraints: NA Default Value: NA |
| externalIp | This attribute displays the external IP of the SQL node. |
DataType: String Constraints: NA Default Value: NA |
| replicaIORunning | This attribute displays the replica IO is running. |
DataType: String Constraints: YES/NO Default Value: NA |
| replicaSQLRunning | This attribute displays the replica SQL is running. |
DataType: String Constraints: YES/NO Default Value: NA |
| serverId | This attribute displays the server id. |
DataType: Integer Constraints: NA Default Value: NA |
| role | This attribute displays the role of the sql node. |
DataType: String Constraints: ACTIVE/STANDBY/FAILED Default Value: NA |
| lastErrno | This attribute displays the last error. |
DataType: String Constraints: NA Default Value: NA |
| lastError | This attribute displays the last error number. |
DataType: String Constraints: NA Default Value: NA |
| lastIOErrno | This attribute displays the IO error number. |
DataType: String Constraints: NA Default Value: NA |
| lastIOError | This attribute displays the last IO error. |
DataType: String Constraints: NA Default Value: NA |
| lastSQLErrno | This attribute displays the last SQL error. |
DataType: String Constraints: NA Default Value: NA |
| lastSQLError | This attribute displays the last SQL error number. |
DataType: String Constraints: NA Default Value: NA |
| sqlRemainingDelay | This attribute displays the SQL remaining delay. |
DataType: String Constraints: NA Default Value: Null |
| localAppliedEpoch | This attribute displays the Local Applied Epoch Value. |
DataType: Long Constraints: NA Default Value: NA |
| currentBinlogFileBeingReplicated | This attribute displays the Current Bin Log File Being Replicated. |
DataType: String Constraints: NA Default Value: Null |
| binLogFileRange | This attribute displays the Bin Log File Range. |
DataType: String Constraints: NA Default Value: Null |
| sourceSqlStatusDetails | This attribute displays the source SQL status details. |
DataType: map Constraints: NA Default Value: NA |
8.22 Get IpFamily Preferences API
This API retrieves the configured IP family preference status used for cnDBTier site-to-site or site-to-mate-site communication.
API Definition
URI: http://base-uri/ocdbtier/preferred/ip-family/preferences
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 404 NOT FOUND | |
|
| 405 METHOD_NOT_ALLOWED | |
|
| 503 SERVICE_UNAVAILABLE | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| siteName | This attribute displays the name of the current site. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the remote site name. |
DataType: string Constraints: UP, DOWN Default Value: NA |
| preferredFamily | This attribute displays the preferred IP family. |
DataType: string Constraints: NA Default Value: NA |
| status | This attribute displays the status of the Ip family switchover. |
DataType: string Constraints: RUNNING/INPROGRESS Default Value: NA |
| siteNameAndRemoteSiteName | This attribute displays the site and remote site name. |
DataType: string Constraints: NA Default Value: NA |
8.23 Put IpFamily Preferences API
This API updates the IP family preferences for the cnDBTier configuration. The API can be used to set or modify the preferred IP family, such as IPv4, IPv6, or dual-stack behavior, depending on the supported deployment configuration.
API Definition
URI: http://base-uri/ocdbtier/preferred/ip-family/preferences
Method: PUT
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
|
200 OK | |
| 404 NOT FOUND | |
|
| 400 BAD REQUEST | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| preferredIpFamily | This attribute displays the preferred IP family. |
DataType: string Constraints: NA Default Value: NA |
| details | This attribute displays the details of the site. |
DataType: list Constraints: NA Default Value: NA |
| localSiteName | This attribute displays the site name. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the remote site name. |
DataType: string Constraints: NA Default Value: NA |
| replicationChannelGroupId | This attribute displays replication channel group id. |
DataType: Integer Constraints: NA Default Value: NA |
| status | This attribute displays the status IP family switchover. |
DataType: string Constraints: CREATED/IN_PROGRESS/PRE_COMPLETE/COMPLETED/FAILED Default Value: NA |
| commandId | This attribute displays command id. |
DataType: Integer Constraints: NA Default Value: NA |
8.24 Retrieve IP Family Preferences by Site and Remote Site API
This API retrieves the IP family preferences configured for a given site name and remote site name.
API Definition
URI: http://base-uri/ocdbtier/preferred/ip-family/preferences/{ siteNameAndRemoteSiteName }
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 404 NOT FOUND | |
|
| 400 BAD REQUEST | |
|
| 503 SERVICE_UNAVAILABLE | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| siteName | This attribute displays the name of the current site. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the remote site name. |
DataType: string Constraints: NA Default Value: NA |
| preferredFamily | This attribute displays the preferred IP family. |
DataType: string Constraints: NA Default Value: NA |
| status | This attribute displays the status of the Ip family switchover status. |
DataType: string Constraints: RUNNING/INPROGRESS Default Value: RUNNING |
| siteNameAndRemoteSiteName | This attribute displays the site and remote site name. |
DataType: string Constraints: NA Default Value: NA |
8.25 Get Mate Site details API
This API retrieves details of the mate site configured for the current cnDBTier site or cluster.
API Definition
URI: http://base-uri/ocdbtier/list/matesite/details
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 404 NOT FOUND | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| remoteSiteName | This attribute displays the remote site name. |
DataType: string Constraints: NA Default Value: NA |
8.26 Get Mate Site Replication Channel Group Id details API
This API retrieves the replication channel group details configured for cnDBTier mate sites. This API enables CNC Console users to view the remote site information and the corresponding replication channel group ID used for replication between site pairs.
API Definition
URI: http://base-uri/ocdbtier/list/matesite/replgroupid/details
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 404 NOT FOUND | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| replGroupId | This attribute displays the replication channel group Id. |
DataType: string Constraints: NA Default Value: NA |
8.27 Gracefully Stop Georeplication API (GET)
This API stops cnDBTier georeplication between sites using the cnDBTier switchover API. It can be used to stop replication for a site against all configured mate sites, for a specific remote site, or for a specific replication channel group.
API Definition
URI: http://base-uri /ocdbtier/georeplication/stop
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 404 NOT FOUND | |
|
| 503 SERVICE_UNAVAILABLE | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| siteName | This attribute displays the name of the current site. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteNames | This attribute displays the list of remote site names of the current site. |
DataType: list Constraints: NA Default Value: NA |
| replicationGroupIds | This attribute displays the list of replication group ids of the current site. |
DataType: list Constraints: NA Default Value: NA |
| replicationSwitchOverList | This attribute displays the replication switch over details. |
DataType: list Constraints: NA Default Value: NA |
| siteName | This attribute displays the name of the current site. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the remote site name. |
DataType: string Constraints: NA Default Value: NA |
| replicationGroupId | This attribute displays the replication group id. |
DataType: integer Constraints: NA Default Value: NA |
| replicationStatus | This attribute displays the status of the geo replication between sites. |
DataType: string Constraints: UP/DOWN Default Value: NA |
| switchOverStatus | This attribute displays the switch over status of the geo replication between sites |
DataType: string Constraints: SWITCH_OVER_ENABLED/SWITCH_OVER_DISABLED Default Value: NA |
8.28 Gracefully Stop Georeplication API (PUT)
This API stops cnDBTier georeplication between sites using the cnDBTier switchover API. It can be used to stop replication for a site against all configured mate sites, for a specific remote site, or for a specific replication channel group.
API Definition
URI: http://base-uri /ocdbtier/georeplication/stop
Method: PUT
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
|
200 OK | NA |
| 404 NOT FOUND | |
|
| 503 SERVICE_UNAVAILABLE | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| siteName | This attribute displays the name of the current site. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the remote site name. |
DataType: string Constraints: NA Default Value: NA |
| replicationGroupId | This attribute displays the replication group id. |
DataType: integer Constraints: NA Default Value: NA |
8.29 Gracefully Start Georeplication API (GET)
This API starts cnDBTier georeplication between sites using the cnDBTier switchover API. It can be used to start replication for a site against all configured mate sites, for a specific remote site, or for a specific replication channel group.
API Definition
URI: http://base-uri/ocdbtier/georeplication/start
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 404 NOT FOUND | |
|
| 503 SERVICE_UNAVAILABLE | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| siteName | This attribute displays the name of the current site. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteNames | This attribute displays the list of remote site names of the current site. |
DataType: list Constraints: NA Default Value: NA |
| replicationGroupIds | This attribute displays the list of replication group ids of the current site. |
DataType: list Constraints: NA Default Value: NA |
| replicationSwitchOverList | This attribute displays the replication switch over details. |
DataType: list Constraints: NA Default Value: NA |
| siteName | This attribute displays the name of the current site. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the remote site name. |
DataType: string Constraints: NA Default Value: NA |
| replicationGroupId | This attribute displays the replication group id. |
DataType: integer Constraints: NA Default Value: NA |
| replicationStatus | This attribute displays the status of the geo replication between sites. |
DataType: string Constraints: UP/DOWN Default Value: NA |
| switchOverStatus | This attribute displays the switch over status of the geo replication between sites |
DataType: string Constraints: SWITCH_OVER_ENABLED/SWITCH_OVER_DISABLED Default Value: NA |
8.30 Gracefully Start Georeplication API (PUT)
This API starts cnDBTier georeplication between sites using the cnDBTier switchover API. It can be used to start replication for a site against all configured mate sites, for a specific remote site, or for a specific replication channel group.
API Definition
URI: http://base-uri/ocdbtier/georeplication/start
Method: PUT
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
|
200 OK | NA |
| 404 NOT FOUND | |
|
| 503 SERVICE_UNAVAILABLE | |
|
| 500 INTERNAL SERVER ERROR | |
|
| 500 INTERNAL SERVER ERROR | |
API Configuration
| Field | Description | Details |
|---|---|---|
| siteName | This attribute displays the name of the current site. |
DataType: string Constraints: NA Default Value: NA |
| remoteSiteName | This attribute displays the remote site name. |
DataType: string Constraints: NA Default Value: NA |
| replicationGroupId | This attribute displays the replication group id. |
DataType: integer Constraints: NA Default Value: NA |