OpenAPI Specification
swagger: '2.0'
info:
description: XMS is the controller of distributed storage system
version: SDS_4.2.000.0.200302
title: XMS access-paths event-logs API
contact: {}
license:
name: Commercial
basePath: /v1
tags:
- name: event-logs
description: 'EventLogController Operations about EventLog
'
paths:
/event-logs/:
get:
tags:
- event-logs
description: List event logs
operationId: ListEventLogs
consumes:
- application/json
produces:
- application/json
parameters:
- name: limit
in: query
description: paging param
required: false
type: integer
format: int64
x-exportParamName: Limit
- name: offset
in: query
description: paging param
required: false
type: integer
format: int64
x-exportParamName: Offset
- name: status
in: query
description: status of event logs
required: false
type: string
x-exportParamName: Status
- name: resource_type
in: query
description: resource type of event logs
required: false
type: string
x-exportParamName: ResourceType
- name: duration_begin
in: query
description: duration begin timestamp
required: false
type: string
x-exportParamName: DurationBegin
- name: duration_end
in: query
description: duration end timestamp
required: false
type: string
x-exportParamName: DurationEnd
- name: q
in: query
description: query param of search
required: false
type: string
x-exportParamName: Q
- name: sort
in: query
description: sort param of search
required: false
type: string
x-exportParamName: Sort
responses:
200:
description: OK
schema:
$ref: '#/definitions/EventLogsResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
definitions:
User_Nestview:
type: object
properties:
id:
type: integer
format: int64
description: id of user
name:
type: string
description: name of user
title: User_Nestview
example:
name: name
id: 6
Host_Nestview:
type: object
required:
- admin_ip
properties:
admin_ip:
type: string
id:
type: integer
format: int64
name:
type: string
title: Host_Nestview
example:
name: name
admin_ip: admin_ip
id: 0
EventLog:
type: object
properties:
create:
type: string
format: date-time
description: create time
data:
type: object
description: dumped resource data
properties: {}
event:
type: string
description: evnet type
host:
description: host eventlog generated on
$ref: '#/definitions/Host_Nestview'
id:
type: integer
format: int64
message:
type: string
description: debug message
resource_id:
type: integer
format: int64
description: resource id
resource_type:
type: string
description: resource type
user:
description: eventlog created by
$ref: '#/definitions/User_Nestview'
title: EventLog
description: EventLog defines a system event
example:
data: '{}'
host:
name: name
admin_ip: admin_ip
id: 0
resource_type: resource_type
create: '2000-01-23T04:56:07.000+00:00'
resource_id: 6
id: 0
event: event
message: message
user:
name: name
id: 6
EventLogsResp:
type: object
required:
- event_logs
properties:
event_logs:
type: array
items:
$ref: '#/definitions/EventLog'
title: EventLogsResp
example:
event_logs:
- data: '{}'
host:
name: name
admin_ip: admin_ip
id: 0
resource_type: resource_type
create: '2000-01-23T04:56:07.000+00:00'
resource_id: 6
id: 0
event: event
message: message
user:
name: name
id: 6
- data: '{}'
host:
name: name
admin_ip: admin_ip
id: 0
resource_type: resource_type
create: '2000-01-23T04:56:07.000+00:00'
resource_id: 6
id: 0
event: event
message: message
user:
name: name
id: 6
securityDefinitions:
tokenInHeader:
description: auth by token
type: apiKey
name: Xms-Auth-Token
in: header
tokenInQuery:
description: auth by token
type: apiKey
name: token
in: query