Versions Compared

Old Version 8

changes.mady.by.user Jia Zhai

Saved on

compared with

New Version Current

changes.mady.by.user Jia Zhai

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Status

Current state: "WIP/Under DiscussionAccepted"

Discussion thread: N/A

JIRA: N/A

...

Github #278 introduces BookKeeper Http Endpoint module. However there are only two endpoints, which is “/heartbeat” and “/api/config/serverConfig”, defined in #278. In order to fully leverage the http modules, The goal is to add more endpoints to this modules.

 


Public Interfaces

N/A

Proposed Changes

1, Overview

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

CodeDescription
200successful operation
403Don't have permission

 

3. Config:

/api/v1/config/valuesserver_config

GET

Get value of all configured values overridden on local server config

Response

CodeDescription
200successful operation
403

Don't have permission

404Configuration not foundError handling


/api/v1/config/:configName/:configValueserver_config

PUTPOST
Update server configuration

Parameters

NameTypeRequiredDescription
configNameStringYesConfiguration name(key) 
configValueStringYesConfiguration value(value)

ResponseBody

CodeDescription
204successful operation
403

Don't have permission

404Configuration not found

 

4. Bookkeeper:

/api/v1/bookkeeper/format_metadata/:force

POST

Format bookkeeper metadata

Parameters

NameTypeRequiredDescription
forcebooleanNowhether to force format and delete the old data 

Response

CodeDescription
204successful operation
403

Don't have permission

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


/api/v1/bookkeeper/list_bookies/:type/:hostnames

GET
 Get all the available bookies.

Parameters

NameTypeRequiredDescription
typeStringYes

 value: rw/ro , list read-write/read-only bookies 

HostnamesBooleanNo whether print hostname of bookie  

Response

Parameters

NameTypeRequiredDescription
idTypeStringYes

 value:  hostname/ip ,  Id by hostname or IP address 

Response

CodeDescription
200successful operation
403

Don't have permission

/api/v1/bookkeeper/update_cookie/:idType

POST

Update bookie id in cookie.

Code
Description204successful operation
403

Don't have permission

404Not update, for errorsError handling

 

53. Ledger:

...

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

...

Parameters

...

 ensemble size 

...

 write quorum size

...

 ack quorum size

...

 

...

Response

passwordStringYespassword
CodeDescription
200successful created, return ledger_id.
403

Don't have permission

404No ledger found

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

DELETEDelete a ledger.

Parameters

NameTypeRequiredDescription
ledger_idLongYes

 ledger id of the ledger. 

Response

No ledger found
Code

Description

200successful operation
403

Don't have permission

404Error handling

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

GET

List all the ledgers

Parameters

NameTypeRequiredDescription
metadataBooleanNo

 whether print out metadata 

Response

Code

Description

200successful operation.
403

Don't have permission

404No ledger found

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

GET

Get the metadata of a ledger

Parameters

NameTypeRequiredDescription
ledger_idLongYes

 ledger id of the ledger 

Response

Code

Description

200successful operation.
403

Don't have permission

404No ledger foundError handling

/api/v1/ledger/read/:ledger_id/:start?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

NameTypeRequiredDescription
ledger_idLongYes

 ledger id of the ledger 

start_entry_idLongNo

 start entry id of read range

end_entry_idLongNo

 end entry id of read range

Response

Code

Description

200successful operation.
403

Don't have permission

404No ledger foundError handling

 

4. Bookies

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

PUT

bookie/list_bookies/?type=<type>&print_hostnames=<hostnames>

GET
 Get all the available bookies.Write a entry to ledger

Parameters

NameTypeRequiredDescription
ledger_idtypeLongStringYes

 ledger id of the ledger 

 value: rw/ro , list read-write/read-only bookies 

hostnamesBooleanNo whether print hostname of bookiesentry_data
StringYes data to be written to ledger

Response

204.404
CodeDescription
200successful operation
403

Don't have permission

No ledger found

 

6. Bookies

/api/v1/bookie/formatlist_bookie/:delete_cookieinfo

PUT

Format a bookie.

Get

Get bookies disk usage info of this cluster.

Parameters

NameTypeRequiredDescription
delete_cookieBooleanNo

 whether delete its cookie on zookeeper.

Response

Code

Description

204200successful operation.
403

Don't have permission

/api/v1/bookie/listlast_bookielog_infomark

GetGET

Get current bookie disk usagethe last log marker.

Response

Code

Description

200successful operation.
403

Don't have permission

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

GET

Get all the files on disk of current bookie.

Parameters

NameTypeRequiredDescription
typeStringNo

  file type: journal/entrylog/index.

Response

Code

Description

200successful operation.
403

Don't have permission

 end position of read

/api/v1/bookie/read_entry_log/:print_msg/:ledger_id/:entry_id/:start_position/:end_positon

GET
Read entry log content from entry log files.

expand_storage

PUT

Expand storage for a bookie.

Parameters

NameTypeRequiredDescription
print_msgBooleanNo

whether print message body.

ledger_idLongNoonly read content of this ledger_id.
entry_idLongNoentry_id to read..
start_positionLongNo

start position to read

end_positonLongNo

Response

Code

Description

200204successful operation.
403

Don't have permission

 

 

5. Recover

/read_journal_file/:journal_dir/:journal_id:print_msgRead journal fie content from disk.journaldirjournal_idprint_msgFile not

/api/v1/autorecovery/bookie

/

GET
PUT
Ledger data recovery for failed bookie

Parameters

NameTypeRequiredDescription
bookie_
srcStringYes

Journal directory

bookie source to recovery
bookie_dest
String
Yes

Journal file name/id.

Nobookie data recovery destination
delete_cookie
BooleanNo
whether print message body.
Whether delete cookie

Body

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

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

 "delete_cookie": <bool_value>

}

Response

Code

Description

200successful operation.
403

Don't have permission

404
Not found Bookie

/api/v1/bookie/print_last_log_markautorecovery/list_under_replicated_ledger/?missingreplica=<bookie_address>&excludingmissingreplica=<bookie_address>

GET
Get the last log marker.all under replicated ledgers.

Parameters

NameTypeRequired

Response

CodeDescription
200successful operation.
403

Don't have permission

/api/v1/bookie/expend_storage

POST
missingreplicaStringNomissing replica bookieId
excludingmissingreplicaStringNoexclude missing replica bookieId
Format a bookie.


Response

Code

Description

204200successful operation.
403

Don't have permission

 

 

...

404Not found under replication node

/api/v1/recoverautorecovery/who_is_auditor

GET
Get auditor bookie id.

Response

Code

Description

200successful operation.
403

Don't have permission

404Not found under replication node for auditorError handling

/api/v1/recoverautorecovery/trigertrigger_audit

PUT
Force trigger audit by resting the lostBookieRecoveryDelay.

Response

Code

Description

204200successful 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

200successful operation.
403

Don't have permission

404Not found under replication node

/api/v1/recoverautorecover/lost_bookie_recovery_delay/:seconds

POSTPUT

Set lostBookieRecoveryDelay value in seconds.

Parameters

NameTypeRequiredDescription
delay_seconds
LongYes

 set delay value in seconds.

Body

{
 "delay_seconds": <delay_seconds>

}

Response

Code

Description

204successful operation.
403

Don't have permission

404Not 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
TypeCodeRequiredDescription
204successful operation.
403

Don't have permission

404Not found under replication node

/api/v1/recover/list_under_replicated_ledger

GET
Get all under replicated ledgers.
bookie_srcStringYes

 Bookie src to decommission.

Body

{
  "bookie_src": bookie_src,

}

Response

Code

Description

200204successful operation.
403

Don't have permission

404Not found under replication node

...

 

Compatibility, Deprecation, and Migration Plan

...