a9e985fcc9
This will allow to trigger the read barrier directly via the API, instead of doing work-arounds (like dropping a non-existent table). The intended use-case is in the Scylla Manager, to make sure that the database schema is up to date after the data has been backed up and before attempting to backup the database schema. The database schema in particular is being backed up just on a single node, which might not yet have the schema at least as new as the data (data can be migrated to a newer schema, but not a vice-versa). The read barrier issued on the node should ensure that the node should have the schema at least as new as the data or newer. Closes #19213
100 lines
3.4 KiB
JSON
100 lines
3.4 KiB
JSON
{
|
|
"apiVersion":"0.0.1",
|
|
"swaggerVersion":"1.2",
|
|
"basePath":"{{Protocol}}://{{Host}}",
|
|
"resourcePath":"/raft",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"apis":[
|
|
{
|
|
"path":"/raft/trigger_snapshot/{group_id}",
|
|
"operations":[
|
|
{
|
|
"method":"POST",
|
|
"summary":"Triggers snapshot creation and log truncation for the given Raft group",
|
|
"type":"string",
|
|
"nickname":"trigger_snapshot",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"group_id",
|
|
"description":"The ID of the group which should get snapshotted",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"string",
|
|
"paramType":"path"
|
|
},
|
|
{
|
|
"name":"timeout",
|
|
"description":"Timeout in seconds after which the endpoint returns a failure. If not provided, 60s is used.",
|
|
"required":false,
|
|
"allowMultiple":false,
|
|
"type":"long",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/raft/leader_host",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Returns host ID of the current leader of the given Raft group",
|
|
"type":"string",
|
|
"nickname":"get_leader_host",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"group_id",
|
|
"description":"The ID of the group. When absent, group0 is used.",
|
|
"required":false,
|
|
"allowMultiple":false,
|
|
"type":"string",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/raft/read_barrier",
|
|
"operations": [
|
|
{
|
|
"method": "POST",
|
|
"summary": "Triggers read barrier for the given Raft group to wait for previously committed commands in this group to be applied locally. For example, can be used on group 0 to wait for the node to obtain latest schema changes.",
|
|
"type": "string",
|
|
"nickname": "read_barrier",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"description": "The ID of the group. When absent, group0 is used.",
|
|
"required": false,
|
|
"allowMultiple": false,
|
|
"type": "string",
|
|
"paramType": "query"
|
|
},
|
|
{
|
|
"name": "timeout",
|
|
"description": "Timeout in seconds after which the endpoint returns a failure. If not provided, 60s is used.",
|
|
"required": false,
|
|
"allowMultiple": false,
|
|
"type": "long",
|
|
"paramType": "query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|