EMI.STAT.KEYS
This feature is still under development
This method is used to retrieve the information about the EMI.STAT keys and values.
Request Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| session | JSON String | yes | Session ID |
| key | JSON String or JSON Array of Strings | yes | Specify EMI.STAT key for which the information is to be retrieved |
| rec | JSON Boolean | no | Specify if the keys are traversed recursively. If set to “TRUE”, information for all sub keys of the specified key will also be retrieved. Default: “FALSE”. |
Response
| Name | Type | Description |
|---|---|---|
| data | JSON Array | Result array |
Result Array is JSON Array which contains JSON Objects. The contained JSON Object(s) Structure:
{
data:
[
{
"key": _JSON String_,
"type": _JSON String_
"value_type": _JSON String_
"value_name": _JSON String_
"description": _JSON String_
}, ...
]
}
Error Codes
| Reference | Description |
|---|---|
| EOK | No errors (contains warnings) |
| EBADPARAM | Error in parameters |
| ENOTFOUND | The specified EMI.STAT key not found |
| EGENERAL | Some other error |
| ESESSION | Session with the given ID is not found |
Examples
Request to EMI-RPC Server:
{
"EMI-RPC": "1.0",
"id": 2,
"method": "emi.stat.keys",
"params":
{ "session":"", "key":" bridge.*.name ", "rec":FALSE }
}
Response from EMI-RPC Server:
{
"EMI-RPC": "1.0",
"id": 2,
"result":{ "data" : [{"key":"bridge.*.name",
"type":"unique",
"value_type":"ascii_char[32]",
"value_name":"Bridge Interface Name",
"description":"some description"} ]}
}