MethodPathDescription
GET/v1/bdbs/{uid}/syncer_state/replicaGet 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 nameRoles
view_bdb_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer

Request

Example HTTP request

GET /v1/bdbs/1/syncer_state/replica

Headers

KeyValue
HostThe domain name or IP of the cluster.
Acceptapplication/json

URL parameters

FieldTypeDescription
uidintegerThe 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

CodeDescription
200 OKOK
404 Not FoundSyncer state key does not exist
500 Internal Server ErrorInternal error
503 Service UnavailableRedis connection error, service unavailable