2b59bb2d2b
This patch add some missing definition for cas read an write, the API definition is for completness only as we do not support cas yet. It also change a part of the definition from storage_service to storage_proxy as it should be. Signed-off-by: Amnon Heiman <amnon@cloudius-systems.com>
845 lines
22 KiB
JSON
845 lines
22 KiB
JSON
{
|
|
"apiVersion":"0.0.1",
|
|
"swaggerVersion":"1.2",
|
|
"basePath":"{{Protocol}}://{{Host}}",
|
|
"resourcePath":"/storage_proxy",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"apis":[
|
|
{
|
|
"path":"/storage_proxy/total_hints",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get total hints",
|
|
"type":"long",
|
|
"nickname":"get_total_hints",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/hinted_handoff_enabled",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Return true if hinted handoff enabled",
|
|
"type":"boolean",
|
|
"nickname":"get_hinted_handoff_enabled",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
},
|
|
{
|
|
"method":"POST",
|
|
"summary":"Set hinted handoff status",
|
|
"type":"void",
|
|
"nickname":"set_hinted_handoff_enabled",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"enable",
|
|
"description":"Set to true to enable hinted handoff",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"boolean",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/hinted_handoff_enabled_by_dc",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get the hinted handoff enabled by dc",
|
|
"type":"array",
|
|
"items":{
|
|
"type":"mapper_list"
|
|
},
|
|
"nickname":"get_hinted_handoff_enabled_by_dc",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
},
|
|
{
|
|
"method":"POST",
|
|
"summary":"Set the hinted handoff enabled by dc",
|
|
"type":"void",
|
|
"nickname":"set_hinted_handoff_enabled_by_dc_list",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"dcs",
|
|
"description":"The dcs to enable in the CSV format",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"string",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/max_hint_window",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get the max hint window",
|
|
"type":"int",
|
|
"nickname":"get_max_hint_window",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
},
|
|
{
|
|
"method":"POST",
|
|
"summary":"Set the max hint window",
|
|
"type":"void",
|
|
"nickname":"set_max_hint_window",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"ms",
|
|
"description":"max hint window in ms",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"int",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/max_hints_in_progress",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get max hints in progress",
|
|
"type":"int",
|
|
"nickname":"get_max_hints_in_progress",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
},
|
|
{
|
|
"method":"POST",
|
|
"summary":"Set max hints in progress",
|
|
"type":"void",
|
|
"nickname":"set_max_hints_in_progress",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"qs",
|
|
"description":"max hints in progress",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"int",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/hints_in_progress",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"get hints in progress",
|
|
"type":"int",
|
|
"nickname":"get_hints_in_progress",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/rpc_timeout",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get the RPC timeout",
|
|
"type":"long",
|
|
"nickname":"get_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
},
|
|
{
|
|
"method":"POST",
|
|
"summary":"Set the RPC timeout",
|
|
"type":"void",
|
|
"nickname":"set_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"timeout",
|
|
"description":"Timeout in millis",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"long",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/read_rpc_timeout",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get the read RPC timeout",
|
|
"type":"long",
|
|
"nickname":"get_read_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
},
|
|
{
|
|
"method":"POST",
|
|
"summary":"Set the read RPC timeout",
|
|
"type":"void",
|
|
"nickname":"set_read_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"timeout",
|
|
"description":"timeout_in_millis",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"long",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/write_rpc_timeout",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get the write RPC timeout",
|
|
"type":"long",
|
|
"nickname":"get_write_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
},
|
|
{
|
|
"method":"POST",
|
|
"summary":"Set the write RPC timeout",
|
|
"type":"void",
|
|
"nickname":"set_write_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"timeout",
|
|
"description":"timeout in millisecond",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"long",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/counter_write_rpc_timeout",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get counter write rpc timeout",
|
|
"type":"long",
|
|
"nickname":"get_counter_write_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
},
|
|
{
|
|
"method":"POST",
|
|
"summary":"Set counter write rpc timeout",
|
|
"type":"void",
|
|
"nickname":"set_counter_write_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"timeout",
|
|
"description":"timeout in millisecond",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"long",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/cas_contention_timeout",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get CAS contention timeout",
|
|
"type":"long",
|
|
"nickname":"get_cas_contention_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
},
|
|
{
|
|
"method":"POST",
|
|
"summary":"Set CAS contention timeout",
|
|
"type":"void",
|
|
"nickname":"set_cas_contention_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"timeout",
|
|
"description":"timeout in millisecond",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"long",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/range_rpc_timeout",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get range rpc timeout",
|
|
"type":"long",
|
|
"nickname":"get_range_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
},
|
|
{
|
|
"method":"POST",
|
|
"summary":"Set range rpc timeout",
|
|
"type":"void",
|
|
"nickname":"set_range_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"timeout",
|
|
"description":"timeout in millisecond",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"long",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/truncate_rpc_timeout",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get truncate rpc timeout",
|
|
"type":"long",
|
|
"nickname":"get_truncate_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
},
|
|
{
|
|
"method":"POST",
|
|
"summary":"Set truncate rpc timeout",
|
|
"type":"void",
|
|
"nickname":"set_truncate_rpc_timeout",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"timeout",
|
|
"description":"timeout in millisecond",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"long",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/reload_trigger_classes",
|
|
"operations":[
|
|
{
|
|
"method":"POST",
|
|
"summary":"Reload trigger classes",
|
|
"type":"void",
|
|
"nickname":"reload_trigger_classes",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/read_repair_attempted",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get read repair attempted",
|
|
"type":"long",
|
|
"nickname":"get_read_repair_attempted",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/read_repair_repaired_blocking",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get read repair repaired blocking",
|
|
"type":"long",
|
|
"nickname":"get_read_repair_repaired_blocking",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/read_repair_repaired_background",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get read repair repaired background",
|
|
"type":"long",
|
|
"nickname":"get_read_repair_repaired_background",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/schema_versions",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get a map of the schema versions",
|
|
"type":"array",
|
|
"items":{
|
|
"type":"mapper_list"
|
|
},
|
|
"nickname":"get_schema_versions",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/metrics/cas_read/timeouts",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get CAS read timeout",
|
|
"type":"long",
|
|
"nickname":"get_cas_read_timeouts",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/metrics/cas_read/unavailables",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get CAS read unavailables",
|
|
"type":"long",
|
|
"nickname":"get_cas_read_unavailables",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/metrics/cas_write/timeouts",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get CAS write timeout",
|
|
"type":"long",
|
|
"nickname":"get_cas_write_timeouts",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/storage_proxy/metrics/cas_write/unavailables",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Get CAS write unavailables",
|
|
"type":"long",
|
|
"nickname":"get_cas_write_unavailables",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/cas_write/unfinished_commit",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get cas write metrics",
|
|
"type": "int",
|
|
"nickname": "get_cas_write_metrics_unfinished_commit",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/cas_write/contention",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get cas write metrics",
|
|
"type": "array",
|
|
"nickname": "get_cas_write_metrics_contention",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/cas_write/condition_not_met",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get cas write metrics",
|
|
"type": "int",
|
|
"nickname": "get_cas_write_metrics_condition_not_met",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/cas_read/unfinished_commit",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get cas read metrics",
|
|
"type": "int",
|
|
"nickname": "get_cas_read_metrics_unfinished_commit",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/cas_read/contention",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get cas read metrics",
|
|
"type": "array",
|
|
"nickname": "get_cas_read_metrics_contention",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/cas_read/condition_not_met",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get cas read metrics",
|
|
"type": "int",
|
|
"nickname": "get_cas_read_metrics_condition_not_met",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/read/timeouts",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get read metrics",
|
|
"type": "int",
|
|
"nickname": "get_read_metrics_timeouts",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/read/unavailables",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get read metrics",
|
|
"type": "int",
|
|
"nickname": "get_read_metrics_unavailables",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/read/latency/histogram",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get read metrics",
|
|
"$ref": "#/utils/histogram",
|
|
"nickname": "get_read_metrics_latency_histogram",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/range/latency/histogram",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get range metrics",
|
|
"$ref": "#/utils/histogram",
|
|
"nickname": "get_range_metrics_latency_histogram",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/range/timeouts",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get range metrics",
|
|
"type": "int",
|
|
"nickname": "get_range_metrics_timeouts",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/range/unavailables",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get range metrics",
|
|
"type": "int",
|
|
"nickname": "get_range_metrics_unavailables",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/write/timeouts",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get write metrics",
|
|
"type": "int",
|
|
"nickname": "get_write_metrics_timeouts",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/write/unavailables",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get write metrics",
|
|
"type": "int",
|
|
"nickname": "get_write_metrics_unavailables",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/storage_proxy/metrics/write/latency/histogram",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get write metrics",
|
|
"$ref": "#/utils/histogram",
|
|
"nickname": "get_write_metrics_latency_histogram",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"models":{
|
|
"mapper_list":{
|
|
"id":"mapper_list",
|
|
"description":"Holds a key value which is a list",
|
|
"properties":{
|
|
"key":{
|
|
"type":"string",
|
|
"description":"The key"
|
|
},
|
|
"value":{
|
|
"type":"array",
|
|
"items":{
|
|
"type":"string"
|
|
},
|
|
"description":"The value"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|