Status

Current state: "WIP/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 endpoint:

/api/v1

GET

Get all the available endpoints

Response

Code	Description
200	successful operation
403	Don't have permission

3. Config:

/api/v1/config/valuesserver_config

GET

Get value of all configured values overridden on local server config

Response

Code	Description
200	successful operation
403	Don't have permission
404Configuration	not foundError handling

/api/v1/config/server_config

POSTPUT

Update server configuration

Parameters

Name	Type	Required	Description
configName	String	Yes	Configuration name(key)
configValue	String	Yes	Configuration value(value)

Body

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

Response

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

POST

Format bookkeeper metadata

Parameters

Code	Description
204	successful operation
403	Don't have permission
404	Configuration not found

4. Bookkeeper:

	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/list_bookies/?type=<type>&print_hostnames=<hostnames>

GET

Get all the available bookies.

Parameters

Name	Type	Required	Description
type	String	Yes	value: rw/ro , list read-write/read-only bookies
hostnames	Boolean	No	whether print hostname of bookie

Response

Code	Description
200	successful operation
403	Don't have permission

/api/v1/bookkeeper/update_cookie/?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
404	Error handling
204	successful operation
403	Don't have permission
404	Not update, for errors

5. Ledger:

...

/api/v1/ledger/create/

...

Parameters

3. Ledger:

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

...

Don't have permission

...

/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

No ledger found

Code	Description
200	successful operation
403	Don't have permission
404	Error handling

/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
404No	ledger foundError handling

/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

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
404No	ledger foundError handling

64. Bookies

/api/v1/bookie/formatlist_bookiebookies/?delete_cookie=<delete_cookie>

PUT

type=<type>&print_hostnames=<hostnames>

GET

Get all the available bookiesFormat a bookie.

Parameters

delete_cookie whether delete its cookie on zookeeper.

Name	Type	Required	Description
type	String	Yes	value: rw/ro , list read-write/read-only bookies
hostnames	Boolean	No	whether print hostname of bookies

Response

204.

Code	Description
200	successful operation
403	Don't have permission

/api/v1/bookie/list_bookie_info

Get

Get current bookie bookies disk usage info of this cluster.

Response

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

file type: journal/entrylog/index

the last log marker.

/api/v1/bookie/listlast_disk_files/?file_type=<type>log_mark

GET

Get all the files on disk of current bookie.

Parameters

Name

Type

Required

Description

type

String

No

Response

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

/api/v1/bookie/readlist_entrydisk_logfile/?printfile_msg=<print_msg>&ledger_id=<ledger_id>

&entry_id=<entry_id>&start_position=<start_position>&end_positon=<end_positon>

GET

type=<type>

GET

Get all the files on disk of current bookie

Read entry log content from entry log files

.

Parameters

Name	Type	Required	Description
print_msgtype	BooleanString	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/bookie/print_last_log_mark

GET

Get the last log marker

file type: journal/entrylog/index.

Response

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

/api/v1/bookie/expendexpand_storage

POSTPUT

Format Expand storage for a bookie.

Response

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

75. Recover

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

PUTPOST

Ledger data recovery for failed bookie

Parameters

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

Body

{
"bookie_src": <bookie_src>[ "bookie_src1", "bookie_src2"... ],

"bookie_dest": <bookie_dest>[ "bookie_dest1", "bookie_dest2"... ],

"delete_cookie": <bool_value>

}

Response

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

/api/v1/recover/who_is_auditor/autorecovery/list_under_replicated_ledger/?missingreplica=<bookie_address>&excludingmissingreplica=<bookie_address>

GET

Get auditor id.all under replicated ledgers.

Parameters

Name	Type	Required	Description
missingreplica	String	No	missing replica bookieId
excludingmissingreplica	String	No	exclude missing replica bookieId

Response

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

/api/v1/autorecovery/who_is_auditor

GET

Get auditor bookie id.

Response

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

/api/v1/recoverautorecovery/trigertrigger_audit

PUT

Force trigger audit by resting the lostBookieRecoveryDelay.

Response

Code	Description
204200	successful operation.
403	Don't have permission
404Not	found under replication nodeError handling

/api/v1/recoverautorecovery/lost_bookie_recovery_delay

GET

Get lostBookieRecoveryDelay value in seconds.

Response

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

/api/v1/recoverautorecover/lost_bookie_recovery_delay/?delay_seconds=<seconds>

POSTPUT

Set lostBookieRecoveryDelay value in seconds.

Parameters

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

Body

{
"delay_seconds": <delay_seconds>

}

Response

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

/api/v1/recoverautorecovery/decommission

POSTPUT

Decommission Bookie, Force trigger Audittask and make sure all the ledgers stored in the decommissioning bookie are replicated.

Parameters

Name

Response

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

/api/v1/recover/list_under_replicated_ledger

GET

Get all under replicated ledgers.

bookie_src

String

Yes

Bookie src to decommission.

Body

{
"bookie_src": bookie_src,

}

Response

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

...

Compatibility, Deprecation, and Migration Plan

...

Child pages

Versions Compared

Old Version 13

New Version Current

Key

Status

Compatibility, Deprecation, and Migration Plan

Child pages

Page History

Versions Compared

Old Version 13

New Version Current

Key

Status

Compatibility, Deprecation, and Migration Plan