Previous Next JavaScript must be enabled to correctly display this content

## show events

post

/V0/nosql/admin/events

Displays event details or list of store events. The status events indicate changes in service status. Log events correspond to records written to the store log, except that only records logged at SEVERE are displayed; which should be investigated immediately. To view records logged at WARNING or lower, consult the store log file. Performance events are not usually critical but may merit investigation.

### Request

There are no request parameters for this operation.

Supported Media Types

- application/json

Request Body - application/json ()
Root Schema : schema
Type: `object`
Show Source

- arguments(required): array arguments
- command(required): string
  Allowed Values: `[ "show" ]`

    {
        "required":[
            "command",
            "arguments"
        ],
        "properties":{
            "command":{
                "type":"string",
                "enum":[
                    "show"
                ]
            },
            "arguments":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "argumentName":{
                            "type":"string"
                        },
                        "argumentValue":{
                            "oneOf":[
                                {
                                    "type":"string"
                                },
                                {
                                    "type":"boolean"
                                }
                            ]
                        }
                    }
                }
            }
        },
        "example":{
            "command":"show",
            "arguments":[
                {
                    "id":"Event id"
                },
                {
                    "from":"Start date of event information"
                },
                {
                    "to":"End date of event information"
                },
                {
                    "type":"stat|log|perf select one type of event to show"
                }
            ]
        }
    }

Example:

    {
        "command":"show",
        "arguments":[
            {
                "id":"Event id"
            },
            {
                "from":"Start date of event information"
            },
            {
                "to":"End date of event information"
            },
            {
                "type":"stat|log|perf select one type of event to show"
            }
        ]
    }

Nested Schema : arguments
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object",
            "properties":{
                "argumentName":{
                    "type":"string"
                },
                "argumentValue":{
                    "oneOf":[
                        {
                            "type":"string"
                        },
                        {
                            "type":"boolean"
                        }
                    ]
                }
            }
        }
    }

Nested Schema : items
Type: `object`
Show Source

- argumentName: string
- argumentValue: argumentValue

    {
        "type":"object",
        "properties":{
            "argumentName":{
                "type":"string"
            },
            "argumentValue":{
                "oneOf":[
                    {
                        "type":"string"
                    },
                    {
                        "type":"boolean"
                    }
                ]
            }
        }
    }

Nested Schema : argumentValue
Match One Schema
Show Source

- string
- boolean

    {
        "oneOf":[
            {
                "type":"string"
            },
            {
                "type":"boolean"
            }
        ]
    }

Back to Top

### Response

Supported Media Types

- application/json

#### 200 Response

Operation ended successfully
Body ()
Root Schema : commonResponse
Type: `object`
Show Source

- description(required): string
- operation(required): string
- returnCode(required): string
- returnValue(required): object returnValue

    {
        "properties":{
            "operation":{
                "type":"string"
            },
            "returnCode":{
                "type":"string"
            },
            "description":{
                "type":"string"
            },
            "returnValue":{
                "type":"object"
            }
        },
        "example":{
            "operation":"operation executed",
            "returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
            "description":"error description when returnCode != 5000",
            "returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
        },
        "required":[
            "operation",
            "returnCode",
            "description",
            "returnValue"
        ]
    }

Example:

    {
        "operation":"operation executed",
        "returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
        "description":"error description when returnCode != 5000",
        "returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
    }

Nested Schema : returnValue
Type: `object`
Back to Top