Versions Compared

Key

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

Statustatus

Current state"WIP/Under Discussion"

...

/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

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

...

...

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

...

read_entry_log/:print_msg/:ledger_id/:entry_id/:start_position/:end_positon

...

GET
Read entry log content from entry log files.

Parameters

Name

...

Type

...

Required

...

Description
print_msg

...

BooleanNo

whether print message body.

ledger_id

...

Long

...

Noonly read content of this ledger_id.
entry_id

...

Long

...

Noentry_id to read..
start_position

...

Long

...

No

start position to read

end_positon

...

Long

...

No 

...

end position of read

Response

Code

...

Description

200

...

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

...

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

...

print_last_log_mark

...

GET

Get the last log marker.

Response

Code

...

Description

200

...

successful operation.
403

...

Don't have permission

 

 whether delete its cookie on zookeeper

.

/api/v1/bookie/format_bookie/:delete_cookieexpend_storage

POSTPUT

Format a bookie.

Parameters

NameTypeRequiredDescription
delete_cookieBooleanNo

Response

Code

Description

204successful operation.
403

Don't have permission

/api/v1/bookie/expend_storage

POST

...

Response

...

 

...

204  successful operation.

403  Don't have permission

 

78. Recover

/api/v1/recover/who_is_auditor

GET
Get auditor id.

Response

Code

...

Description

200

...

successful operation.
403

...

Don't have permission

404

...

Not found under replication node for auditor

...

/api/v1/recover/triger_audit

PUT
Force trigger audit by resting the lostBookieRecoveryDelay.

Response

Code

...

Description

204

...

successful operation.
403

...

Don't have permission

404

...

Not found under replication node

 

/api/v1/recover/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/recover/lost_bookie_recovery_delay/:

...

seconds

POST

Set lostBookieRecoveryDelay value in seconds.

Parameters

Name

...

Type

...

Required

...

Description

...

secondsLongYes

 set delay value in seconds.

Response

Code

...

Description

204

...

successful operation.
403

...

Don't have permission

404

...

Not found under replication node

...

/api/v1/recover/decommission

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

Response

Code

...

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.

Response

Code

...

Description

200

...

successful operation.
403

...

Don't have permission

404

...

Not found under replication node

  ledger

 

Compatibility, Deprecation, and Migration Plan

...