Status
Current state: "Under DiscussionAccepted"
Discussion thread: N/A
JIRA: N/A
...
Provide Http EndPoints for these components:
* Components:
* Root endpoint: List all the available endpoints
* * Config: Do the configuration.
* Bookkeeper : API related to BookKeeper.
* * Ledger: API related to ledgers
...
/api/v1/<component>/<action>
2. Root endpointConfig:
/api/v1 | ||||||
---|---|---|---|---|---|---|
GET | ||||||
Get all the available endpoints | ||||||
Response
|
3. Config:
/api/v1//config/server_config | ||||||||
---|---|---|---|---|---|---|---|---|
GET | ||||||||
Get value of all configured values overridden on local server config | ||||||||
Response
|
/api/v1/config/server_config | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
POSTPUT | |||||||||||||||||||||
Update server configuration | |||||||||||||||||||||
Parameters
Body
Response
|
4. Bookkeeper:
/api/v1/bookkeeper/list_bookies/?type=<type>&print_hostnames=<hostnames> | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | ||||||||||||||||||
Get all the available bookies. | ||||||||||||||||||
Parameters
Response POST
| ||||||||||||||||||
/api/v1/bookkeeper/update_cookie/?bookie_id_type=<idType> | ||||||||||||||||||
Update bookie id in cookie. | ||||||||||||||||||
Parameters
Response
|
53. Ledger:
/api/v1/ledger/delete/?ledger_id=<ledger_id> | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DELETE | ||||||||||||||||
Delete a ledger. | ||||||||||||||||
Parameters
Response
|
/api/v1/ledger/list/?print_metadata=<metadata> | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | ||||||||||||||||
List all the ledgers | ||||||||||||||||
Parameters
Response
|
/api/v1/ledger/metadata/?ledger_id=<ledger_id> | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | ||||||||||||||||
Get the metadata of a ledger | ||||||||||||||||
Parameters
Response
|
/api/v1/ledger/read/?ledger_id=<ledger_id>&start_entry_id=<start_entry_id>&end_entry_id=<end_entry_id> | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | ||||||||||||||||||||||||
Read a range of entries from ledger | ||||||||||||||||||||||||
Parameters
Response
|
64. Bookies
/api/v1/bookie/list_bookie_info | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get | ||||||||||||||||||||
Get current bookie disk usage. | ||||||||||||||||||||
Response
| ||||||||||||||||||||
bookies/?type=<type>&print_hostnames=<hostnames> | ||||||||||||||||||||
GET | ||||||||||||||||||||
Get all the available bookies | ||||||||||||||||||||
/api/v1/bookie/list_disk_files/?file_type=<type> | ||||||||||||||||||||
GET | ||||||||||||||||||||
Get all the files on disk of current bookie. | ||||||||||||||||||||
Parameters
Response
|
/api/v1/bookie/readlist_entry_log/?print_msg=<print_msg>&ledger_id=<ledger_id> &entry_id=<entry_id>&start_position=<start_position>&end_positon=<end_positon> bookie_info | ||||||
---|---|---|---|---|---|---|
Get | ||||||
Get bookies disk usage info of this cluster. | ||||||
Response
|
/api/v1/bookie/last_log_mark | ||||||
---|---|---|---|---|---|---|
GET | ||||||
Get the last log marker. | ||||||
GET | ||||||
Read entry log content from entry log files. | ||||||
Parameters | ||||||
Name | Type | Required | Description | |||
print_msg | Boolean | No | whether print message body. | |||
ledger_id | Long | No | only read content of this ledger_id. | |||
entry_id | Long | No | entry_id to read.. | |||
start_position | Long | No | start position to read | end_positon | Long | No | end position of read
Response
|
/api/v1/bookie/readlist_journaldisk_file/?journalfile_dir=<journal_dir>&journal_id=<journal_id>&print_msg=<print_msg> | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | ||||||||||||||||||||||||
type=<type> | ||||||||||||||||||||||||
GET | ||||||||||||||||||||||||
Get all the files on disk of current bookieRead journal fie content from disk. | ||||||||||||||||||||||||
Parameters
Response
| ||||||||||||||||||||||||
/api/v1/bookie/print_last_log_mark | ||||||||||||||||||||||||
GET | ||||||||||||||||||||||||
Response
|
/api/v1/bookie/expendexpand_storage | ||||||
---|---|---|---|---|---|---|
POSTPUT | ||||||
Expend Expand storage for a bookie. | ||||||
Response
|
75. Recover
/api/v1/autorecovery/bookie/ | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
POSTPUT | |||||||||||||||||||||||||
Ledger data recovery for failed bookie | |||||||||||||||||||||||||
Parameters
Body
Response
|
/api/v1/autorecovery/who_is_auditor/list_under_replicated_ledger/?missingreplica=<bookie_address>&excludingmissingreplica=<bookie_address> | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | ||||||||||||||||||||
Get auditor id.all under replicated ledgers. | ||||||||||||||||||||
Parameters
Response
|
/api/v1/autorecovery/who_is_auditor | ||||||||
---|---|---|---|---|---|---|---|---|
GET | ||||||||
Get auditor bookie id. | ||||||||
Response
|
/api/v1/autorecovery/trigertrigger_audit | ||||||||
---|---|---|---|---|---|---|---|---|
PUT | ||||||||
Force trigger audit by resting the lostBookieRecoveryDelay. | ||||||||
Response
|
/api/v1/autorecovery/lost_bookie_recovery_delay | ||||||||
---|---|---|---|---|---|---|---|---|
GET | ||||||||
Get lostBookieRecoveryDelay value in seconds. | ||||||||
Response
|
/api/v1/autorecover/lost_bookie_recovery_delay | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
POSTPUT | |||||||||||||||||
Set lostBookieRecoveryDelay value in seconds. | |||||||||||||||||
Parameters
Body
Response
|
/api/v1/autorecovery/decommission | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
POSTPUT | |||||||||||||||||
Decommission Bookie, Force trigger Audittask and make sure all the ledgers stored in the decommissioning bookie are replicated. | |||||||||||||||||
Parameters
Body
Response Response
| |||||||||||||||||
/api/v1/autorecovery/list_under_replicated_ledger | |||||||||||||||||
GET | |||||||||||||||||
Get all under replicated ledgers. | |||||||||||||||||
|
...
Compatibility, Deprecation, and Migration Plan
...