2 Status APIs
The Status APIs facilitate NF applications to determine the status of cnDBTier and associated cross-site replications. These APIs are 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. Users must configure the name according to their environment.
Example:
Example: curl http://mysql-cluster-db-monitor-svc.occne-cndbtier:8080/db-tier/status/replication/realtime2.1 Site Specific Real Time Replication Status API
This API is used to monitor the real-time georeplication status between cnDBTier sites or clusters.
API Definition
URI: http://base-uri/db-tier/status/replication/{mate-site-name}/realtime
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK - Cross-site replication is active | |
| 404 Not Found | NA | |
| 400 Bad Request | NA | |
| 503 Service Unavailable - Cross-site replication is not enabled and/or DOWN | NA |
API Configuration
| Field | Description | Details |
|---|---|---|
| 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 |
| siteDetails | 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 |
2.2 Real Time Overall Replication Status API
This API retrieves the current end-to-end replication status for cnDBTier in multisite deployments.
API Definition
URI: http://base-uri/db-tier/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 | NA |
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 |
2.3 Real Time Local Cluster Status API
This section provides Real Time Local Cluster Status API that are used to monitor the current health and runtime status of a local database cluster in real time.
API Definition
URI: http://base-uri/db-tier/status/cluster/local/realtime
Method: GET
Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK- The local NDB cluster is available | NA |
API Configurations
None
2.4 Database Statistics Report API
This section provides Database Statistics Report APIs that are used to monitor and collect database performance and usage statistics for monitoring and analysis.
API Definition
URI: http://base-uri/db-tier/statistics/dbinfo
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK Data is available |
|
| 503 Service Unavailable - DB statistics reports is empty | NA | |
| 500 INTERNAL SERVER ERROR - Could not list the DB statistics reports |
API Configuration
| Fields | 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: list
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: integer
Constraints: NA Default Value: NA |
2.5 cnDBTier Version API
This API retrieves the current cnDBTier software version from a deployed DB Tier environment.
API Definition
URI: http://base-uri/db-tier/version
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 500 INTERNAL SERVER ERROR - failed to get version" | |
API Configuration
| Fields | 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 |
2.6 NDB Backup Status API
This API retrieves the current NDB backup status for the cnDBTier cluster.
API Definition
URI: http://base-uri/db-tier/status/cluster/local/backup
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK | |
| 500 INTERNAL SERVER ERROR | Not able to fetch Current NDB Backup Status |
API Configuration
| Fields | Description | Details |
|---|---|---|
| isNdbBackupInProgress | This attribute displays if an NDB backup is in progress or not. | DataType: boolean
Constraints: true/false Default Value: NA |
| nextBackupScheduleTime | This attribute displays timestamp for the next scheduled routine backup. | DataType: string
Constraints: NA Default Value: NA |
| currentTimestamp | This attribute displays the current timestamp from the NDB cluster | DataType: string
Constraints: NA Default Value: NA |
2.7 Cluster Real Time Replication Status across all sites API
This API retrieves the real-time replication status of the cnDBTier cluster across all configured sites.
API Definition
URI: http://base-uri/db-tier/replication/status/realtime
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK Data is available | |
| 404 Not Found | NA | |
| 400 Bad Request | ||
| 503 Service Unavailable |
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 |
2.8 Current Replication Status of a Given Site and all mates sites in the Cluster API
This API retrieves the current replication status of a specified site and all its mate sites within the cluster.
API Definition
URI: http://base-uri/db-tier/replication/status/realtime/sitename/{siteName}
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK Data is available | [
[
{
"siteNameAndRemoteSiteName": "ses1,ses2",
"siteName": "ses1",
"remoteSiteName": "ses2",
"status": "UP",
"replicationDetailsPerGroupId": [
{
"replicationGroupId": 1,
"status": "UP",
"allSqlStatusDetails": [
{
"sqlNode": "ndbmysqld-0",
"sourceHost": "10.233.19.91",
"externalIp": "10.233.31.67",
"replicaIORunning": "Yes",
"replicaSQLRunning": "Yes",
"serverId": 2000,
"role": "ACTIVE",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005",
"sourceSqlStatusDetails": {
"sqlNode": "ndbmysqld-0",
"sourceHost": "10.233.31.67",
"externalIp": "10.233.19.91",
"replicaIORunning": "Yes",
"replicaSQLRunning": "Yes",
"serverId": 1000,
"role": "ACTIVE",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005"
}
},
{
"sqlNode": "ndbmysqld-1",
"sourceHost": "10.233.6.238",
"externalIp": "10.233.35.109",
"replicaIORunning": "No",
"replicaSQLRunning": "No",
"serverId": 2001,
"role": "STANDBY",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005",
"sourceSqlStatusDetails": {
"sqlNode": "ndbmysqld-1",
"sourceHost": "10.233.35.109",
"externalIp": "10.233.6.238",
"replicaIORunning": "No",
"replicaSQLRunning": "No",
"serverId": 1001,
"role": "STANDBY",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005"
}
}
]
}
]
},
{
"siteNameAndRemoteSiteName": "ses1,ses3",
"siteName": "ses1",
"remoteSiteName": "ses3",
"status": "UP",
"replicationDetailsPerGroupId": [
{
"replicationGroupId": 1,
"status": "UP",
"allSqlStatusDetails": [
{
"sqlNode": "ndbmysqld-2",
"sourceHost": "10.233.35.195",
"externalIp": "10.233.29.41",
"replicaIORunning": "Yes",
"replicaSQLRunning": "Yes",
"serverId": 3000,
"role": "ACTIVE",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005",
"sourceSqlStatusDetails": {
"sqlNode": "ndbmysqld-0",
"sourceHost": "10.233.29.41",
"externalIp": "10.233.35.195",
"replicaIORunning": "Yes",
"replicaSQLRunning": "Yes",
"serverId": 1002,
"role": "ACTIVE",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005"
}
},
{
"sqlNode": "ndbmysqld-3",
"sourceHost": "10.233.35.129",
"externalIp": "10.233.50.242",
"replicaIORunning": "No",
"replicaSQLRunning": "No",
"serverId": 3001,
"role": "STANDBY",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005",
"sourceSqlStatusDetails": {
"sqlNode": "ndbmysqld-1",
"sourceHost": "10.233.50.242",
"externalIp": "10.233.35.129",
"replicaIORunning": "No",
"replicaSQLRunning": "No",
"serverId": 1003,
"role": "STANDBY",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005"
}
}
]
}
]
}
]
|
| 404 Not Found | NA | |
| 400 Bad Request | ||
| 503 Service Unavailable |
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 or NO Default Value: NA |
| replicaSQLRunning | This attribute displays the replica SQL is running. |
DataType: String Constraints: YES or 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 |
2.9 Current Replication Status of a Given Site and Specific Remote Site API
This API retrieves the current real-time replication status between the specified site and remote site.
API Definition
URI: http://base-uri/db-tier/replication/status/realtime/sitename/{siteName}/remotesitename/{remoteSiteName}
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK Data is available | [
{
"siteNameAndRemoteSiteName": "ses1,ses2",
"siteName": "ses1",
"remoteSiteName": "ses2",
"status": "UP",
"replicationDetailsPerGroupId": [
{
"replicationGroupId": 1,
"status": "UP",
"allSqlStatusDetails": [
{
"sqlNode": "ndbmysqld-0",
"sourceHost": "10.233.19.91",
"externalIp": "10.233.31.67",
"replicaIORunning": "Yes",
"replicaSQLRunning": "Yes",
"serverId": 2000,
"role": "ACTIVE",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005",
"sourceSqlStatusDetails": {
"sqlNode": "ndbmysqld-0",
"sourceHost": "10.233.31.67",
"externalIp": "10.233.19.91",
"replicaIORunning": "Yes",
"replicaSQLRunning": "Yes",
"serverId": 1000,
"role": "ACTIVE",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005"
}
},
{
"sqlNode": "ndbmysqld-1",
"sourceHost": "10.233.6.238",
"externalIp": "10.233.35.109",
"replicaIORunning": "No",
"replicaSQLRunning": "No",
"serverId": 2001,
"role": "STANDBY",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005",
"sourceSqlStatusDetails": {
"sqlNode": "ndbmysqld-1",
"sourceHost": "10.233.35.109",
"externalIp": "10.233.6.238",
"replicaIORunning": "No",
"replicaSQLRunning": "No",
"serverId": 1001,
"role": "STANDBY",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005"
}
}
]
}
]
}
]
|
| 404 Not Found | NA | |
| 400 Bad Request | ||
| 503 Service Unavailable |
API Configuration
| Fields | 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 |
2.10 Current Replication Status of a Given Site and Specific Remote Site and Group ID in the Cluster API
This API retrieves the current replication status between a specified local site and a specific remote site for a given replication channel group ID
API Definition
URI: http://base-uri/db-tier/replication/status/realtime/sitename/{siteName}/remotesitename/{remoteSiteName}/replgroupid/{replGroupId}
Method: GET
API Type: Realtime API
| Request Payload | Response Code | Response Payload |
|---|---|---|
| NA | 200 OK Data is available | [
{
"siteNameAndRemoteSiteName": "ses1,ses2",
"siteName": "ses1",
"remoteSiteName": "ses2",
"status": "UP",
"replicationDetailsPerGroupId": [
{
"replicationGroupId": 1,
"status": "UP",
"allSqlStatusDetails": [
{
"sqlNode": "ndbmysqld-0",
"sourceHost": "10.233.19.91",
"externalIp": "10.233.31.67",
"replicaIORunning": "Yes",
"replicaSQLRunning": "Yes",
"serverId": 2000,
"role": "ACTIVE",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005",
"sourceSqlStatusDetails": {
"sqlNode": "ndbmysqld-0",
"sourceHost": "10.233.31.67",
"externalIp": "10.233.19.91",
"replicaIORunning": "Yes",
"replicaSQLRunning": "Yes",
"serverId": 1000,
"role": "ACTIVE",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005"
}
},
{
"sqlNode": "ndbmysqld-1",
"sourceHost": "10.233.6.238",
"externalIp": "10.233.35.109",
"replicaIORunning": "No",
"replicaSQLRunning": "No",
"serverId": 2001,
"role": "STANDBY",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005",
"sourceSqlStatusDetails": {
"sqlNode": "ndbmysqld-1",
"sourceHost": "10.233.35.109",
"externalIp": "10.233.6.238",
"replicaIORunning": "No",
"replicaSQLRunning": "No",
"serverId": 1001,
"role": "STANDBY",
"lastErrno": 0,
"lastError": "",
"lastIOErrno": 0,
"lastIOError": "",
"lastSQLErrno": 0,
"lastSQLError": "",
"sqlRemainingDelay": null,
"localAppliedEpoch": 3100966387723,
"currentBinlogFileBeingReplicated": "mysql-bin.000005",
"binLogFileRange": "mysql-bin.000001 - mysql-bin.000005"
}
}
]
}
]
}
] |
| 404 Not Found | NA | |
| 400 Bad Request | ||
| 503 Service Unavailable |
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/FAILE 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 |