Page History

...

/api/v1/bookkeeper/format_metadata/:?force_format=<force>

POST

Format bookkeeper metadata

Parameters

Name	Type	Required	Description
force	boolean	No	whether to force format and delete the old data

Response

Code	Description
204	successful operation
403	Don't have permission

...

/api/v1/bookkeeper/update_cookie/:idType?bookie_id_type=<idType>

POST

Update bookie id in cookie.

Parameters

Name	Type	Required	Description
idType	String	Yes	value: hostname/ip , Id by hostname or IP address

Response

Code	Description
204	successful operation
403	Don't have permission
404	Not update, for errors

...

5. Ledger:

/api/v1/ledger/create/:ensemble_size/:write_quorum_size/:ack_quorum_size/:digest_type/:password

PUT

Create a ledger.

Parameters

Name	Type	Required	Description
ensemble_size	Int	Yes	ensemble size
write_quorum_size	Int	Yes	write quorum size
ack_quorum_size	Int	Yes	ack quorum size
digest_type	String	Yes	MAC or CRC32
password	String	Yes	password
medadata	<String, String>	No	custom metadata

Body

{
"ensemble_size": <int_value>,

"write_quorum_size": <int_value>,

"ack_quorum_size": <int_value>,

"digest_type": "MAC",

"password": <password_string>,

"medadata": {
"configName1": "configValue1",
"configName2": "configValue2"
}
}

Response

Code	Description
200	successful created, return ledger_id.
403	Don't have permission
404	No ledger found

/api/v1/ledger/delete/:?ledger_id=<ledger_id>

DELETE

Delete a ledger.

Parameters

Name	Type	Required	Description
ledger_id	Long	Yes	ledger id of the ledger.

Response

Code	Description
403	Don't have permission
404	No ledger found

/api/v1/ledger/list/:?print_metadata=<metadata>

GET

List all the ledgers

Parameters

Name	Type	Required	Description
metadata	Boolean	No	whether print out metadata

Response

Code	Description
200	successful operation.
403	Don't have permission
404	No ledger found

/api/v1/ledger/metadata/:?ledger_id=<ledger_id>

GET

Get the metadata of a ledger

Parameters

Name	Type	Required	Description
ledger_id	Long	Yes	ledger id of the ledger

Response

Code	Description
200	successful operation.
403	Don't have permission
404	No ledger found

/api/v1/ledger/read/:?ledger_id=<ledger_id/:id>&start_entry_id=<start_entry_id/:>&end_entry_id=<end_entry_id>

GET

Read a range of entries from ledger

Parameters

Name	Type	Required	Description
ledger_id	Long	Yes	ledger id of the ledger
start_entry_id	Long	No	start entry id of read range
end_entry_id	Long	No	end entry id of read range

Response

Code	Description
200	successful operation.
403	Don't have permission
404	No ledger found

/api/v1/ledger/read/:ledger_id/:entry_data

PUT

Write a entry to ledger

Parameters

Name	Type	Required	Description
ledger_id	Long	Yes	ledger id of the ledger
entry_data	String	Yes	data to be written to ledger

Response

Code	Description
204	successful operation.
403	Don't have permission
404	No ledger found

6. Bookies

/api/v1/bookie/format_bookie/:?delete_cookie=<delete_cookie>

PUT

Format a bookie.

Parameters

Name	Type	Required	Description
delete_cookie	Boolean	No	whether delete its cookie on zookeeper.

Response

Code	Description
204	successful operation.
403	Don't have permission

...

/api/v1/bookie/list_disk_files/:?file_type=<type>

GET

Get all the files on disk of current bookie.

Parameters

Name	Type	Required	Description
type	String	No	file type: journal/entrylog/index.

Response

Code	Description
200	successful operation.
403	Don't have permission

/api/v1/bookie/read_entry_log/:?print_msg=<print_msg/:>&ledger_id=<ledger_id/:>

&entry_id/:=<entry_id>&start_position/:=<start_position>&end_positon=<end_positon>

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

Code	Description
200	successful operation.
403	Don't have permission

/api/v1/bookie/read_journal_file/:?journal_dir=<journal_dir/:>&journal_id=<journal_id/:>&print_msg=<print_msg>

GET

Read journal fie content from disk.

Parameters

Name	Type	Required	Description
journal_dir	String	Yes	Journal directory
journal_id	String	Yes	Journal file name/id.
print_msg	Boolean	No	whether print message body.

Response

Code	Description
200	successful operation.
403	Don't have permission
404	File not found

...

/api/v1/recover/bookie/:bookie_src/:bookie_dest/:delete_cookie

POST

Ledger data recovery for failed bookie

Parameters

Name	Type	Required	Description
bookie_src	String	Yes	bookie source to recovery
bookie_dest	String	Yes	bookie data recovery destination
delete_cookie	Boolean	No	Whether delete cookie

Body

{
"bookie_src": <bookie_src>,

"bookie_dest": <bookie_dest>,

"delete_cookie": <bool_value>

}

Response

Code	Description
200	successful operation.
403	Don't have permission
404	Not found Bookie

...

/api/v1/recover/lost_bookie_recovery_delay/:?delay_seconds=<seconds>

POST

Set lostBookieRecoveryDelay value in seconds.

Parameters

Name	Type	Required	Description
seconds	Long	Yes	set delay value in seconds.

Response

Code	Description
204	successful operation.
403	Don't have permission
404	Not found under replication node

...

Child pages

Versions Compared

Old Version 12

New Version 13

Key