Versions Compared

Key

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

...

/api/v1/ledger/delete/: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/ledger/delete/: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

...

list/: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

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/:start_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

 

76. Bookies

/api/v1/bookie/format_bookie/: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_bookie_info

Get

Get current bookie disk usage.

Response

Code

...

Description

200successful operation.
403

Don't have permission

/api/v1/bookie/list_disk_files/: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/list_disk_files/:type

...

403  Don't have permission

 

/api/v1/bookie/format_bookie/:delete_cookie

PUT

Format a bookie.

Parameters

NameTypeRequiredDescription
delete_cookieBooleanNo

 whether delete its cookie on zookeeper.

Response

Code

Description

204successful operation.
403

Don't have permission

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

...

403  Don't have permission

...

/api/v1/bookie/format_bookie/:delete_cookie

PUT

Format a bookie.

Parameters

NameTypeRequiredDescription
delete_cookieBooleanNo

 whether delete its cookie on zookeeper.

Response

Code

Description

204successful operation.
403

Don't have permission

/api/v1/bookie/read_journal_file/:journal_dir/:journal_id/:print_msg

...

403  Don't have permission

404  File not found

...

/api/v1/bookie/format_bookie/:delete_cookie

PUT

Format a bookie.

Parameters

NameTypeRequiredDescription
delete_cookieBooleanNo

 whether delete its cookie on zookeeper.

Response

Code

Description

204successful operation.
403

Don't have permission

/api/v1/bookie/print_last_log_mark

...

403  Don't have permission

 

/api/v1/bookie/format_bookie/:delete_cookie

PUT

Format a bookie.

Parameters

NameTypeRequiredDescription
delete_cookieBooleanNo

 whether delete its cookie on zookeeper.

Response

Code

Description

204successful operation.
403

Don't have permission

/api/v1/bookie/expend_storage

...