Versions Compared

Key

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

...

/api/v1/config

POST
Update configuration

Parameters

NameTypeRequiredDescription
configNameStringYesConfiguration name(key) 
configValueStringYesConfiguration value(value)

Body

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


Response

CodeDescription
204successful operation
403

Don't have permission

404Configuration not found

 

4. Bookkeeper:

...

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

...

Format bookkeeper metadata

Parameters

...

 

Response

CodeDescription
204successful operation
403

Don't have permission

/api/v1/bookkeeper/list_bookies/?type=<type>&print_hostnames=<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

CodeDescription
200successful operation
403

Don't have permission

...

/api/v1/bookie/expend_storage

POST

Format a bookie.

Response

Code

Description

204successful operation.
403

Don't have permission

 

 

7. Recover

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

POST
Ledger data recovery for failed bookie

Parameters

NameTypeRequiredDescription
bookie_srcStringYesbookie source to recovery
bookie_destStringYesbookie data recovery destination
delete_cookieBooleanNoWhether delete cookie

Body

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

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

 "delete_cookie": <bool_value>

}

Response

Code

Description

200successful operation.
403

Don't have permission

404Not found Bookie

/api/v1/recoverautorecovery/who_is_auditor

GET
Get auditor id.

Response

Code

Description

200successful operation.
403

Don't have permission

404Not found under replication node for auditor

/api/v1/recoverautorecovery/triger_audit

PUT
Force trigger audit by resting the lostBookieRecoveryDelay.

Response

Code

Description

204successful operation.
403

Don't have permission

404Not found under replication node

/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/?delay_seconds=<seconds>

POST

Set lostBookieRecoveryDelay value in seconds.

Parameters

NameTypeRequiredDescription
secondsLongYes

 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

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

Parameters

NameTypeRequiredDescription
bookie_srcStringYes

 Bookie src to decommission.

 

Body

{
 "bookie_src": bookie_src,

}


Response

Code

Description

204successful operation.
403

Don't have permission

404Not found under replication node

/api/v1/recoverautorecovery/list_under_replicated_ledger

GET
Get all under replicated ledgers.

Response

Code

Description

200successful operation.
403

Don't have permission

404Not found under replication node

...