Replica syncer state requests
Replica syncer state requests
| Method | Path | Description |
|---|---|---|
| GET | /v1/bdbs/{uid}/syncer_state/replica |
Get a CRDB replica's syncer state |
Get replica syncer state
GET /v1/bdbs/{int: uid}/syncer_state/replica
Get a CRDB replica's syncer state as JSON.
Permissions
| Permission name | Roles |
|---|---|
| view_bdb_info | admin cluster_member cluster_viewer db_member db_viewer user_manager |
Request
Example HTTP request
GET /v1/bdbs/1/syncer_state/replica
Headers
| Key | Value |
|---|---|
| Host | The domain name or IP of the cluster. |
| Accept | application/json |
URL parameters
| Field | Type | Description |
|---|---|---|
| uid | integer | The unique ID of the database requested. |
Response
Returns a JSON object that represents the syncer state.
Example JSON body
{
"DB": 22,
"RunID": 1584086516,
// additional fields...
}
Status codes
| Code | Description |
|---|---|
| 200 OK | OK |
| 404 Not Found | Syncer state key does not exist |
| 500 Internal Server Error | Internal error |
| 503 Service Unavailable | Redis connection error, service unavailable |