Versions Compared

Old Version 31

changes.mady.by.user Jia Zhai

Saved on

compared with

New Version 32

changes.mady.by.user Jia Zhai

Saved on

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. Bookkeeper:

 

/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/bookkeeper/update_cookie/?bookie_id_type=<idType>

POST

Update bookie id in cookie.

Parameters

NameTypeRequiredDescription
idTypeStringYes

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

Response

CodeDescription
204successful operation
403

Don't have permission

404Not update, for errors

 

5. 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/ledger/read/?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 found

 

65. Bookies

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

Get

Get bookies disk usage info.

Response

Code

Description

200successful operation.
403

Don't have permission

...

/api/v1/bookie/expand_storage

POST

Expand storage for a bookie.

Response

Code

Description

204successful operation.
403

Don't have permission

 

 

76. Recover

/api/v1/autorecovery/bookie/

POST
Ledger data recovery for failed bookie

Parameters

NameTypeRequiredDescription
bookie_srcStringYesbookie source to recovery
bookie_destStringNobookie data recovery destination
delete_cookieBooleanNoWhether 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

404Not found Bookie

...