Versions Compared

Key

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

...

/api/v1/config/server_config

POST
Update server configuration

Parameters

NameTypeRequiredDescription
configNameStringYesConfiguration name(key) 
configValueStringYesConfiguration value(value)

Body

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


Response

CodeDescription
204successful operation
403

Don't have permission

404Configuration not found

 

4. Ledger:

 

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

DELETE
Delete a ledger.

Parameters

NameTypeRequiredDescription
ledger_idLongYes

 ledger id of the ledger. 

Response

CodeDescription
403

Don't have permission

404No ledger found

...

/api/v1/bookie/list_disk_file/?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

/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

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 end position of read

Response

Code

Description

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

NameTypeRequiredDescription
journal_dirStringYes

Journal directory

journal_idStringYes

Journal file name/id.

print_msgBooleanNowhether print message body.

Response

Code

Description

200successful operation.
403

Don't have permission

404File not found

/api/v1/bookie/expand_storage

POST

Expand storage for a bookie.

Response

Code

Description

204successful operation.
403

Don't have permission

...