XSKY os-search-gateways API

swagger: '2.0'
info:
  description: XMS is the controller of distributed storage system
  version: SDS_4.2.000.0.200302
  title: XMS access-paths os-search-gateways API
  contact: {}
  license:
    name: Commercial
basePath: /v1
tags:
- name: os-search-gateways
  description: 'OSSearchGatewayController provides API for os search gateways

    '
paths:
  /os-search-gateways/:
    get:
      tags:
      - os-search-gateways
      description: List OS Search Gateways
      operationId: ListOSSearchGateways
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: os_search_engine_id
        in: query
        description: os search engine id
        required: false
        type: integer
        format: int64
        x-exportParamName: OsSearchEngineId
      - 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/OSSearchGatewaysResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
  /os-search-gateways/{gateway_id}:
    get:
      tags:
      - os-search-gateways
      description: Get OS Search Gateway
      operationId: GetOSSearchGateways
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: gateway_id
        in: path
        description: os search gateway id
        required: true
        type: integer
        format: int64
        x-exportParamName: GatewayId
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/OSSearchGatewayResp'
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
  /os-search-gateways/{gateway_id}/samples:
    get:
      tags:
      - os-search-gateways
      description: get a os search gateway's samples
      operationId: GetOSSearchGatewaySamples
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: gateway_id
        in: path
        description: os search gateway id
        required: true
        type: integer
        format: int64
        x-exportParamName: GatewayId
      - 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: period
        in: query
        description: samples period
        required: false
        type: string
        x-exportParamName: Period
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/OSSearchGatewaySamplesResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
definitions:
  OSSearchGateway:
    type: object
    properties:
      action_status:
        type: string
      create:
        type: string
        format: date-time
      host:
        $ref: '#/definitions/Host_Nestview'
      id:
        type: integer
        format: int64
      pool:
        $ref: '#/definitions/Pool_Nestview'
      search_engine:
        $ref: '#/definitions/OSSearchEngine_Nestview'
      status:
        type: string
      update:
        type: string
        format: date-time
    title: OSSearchGateway
    description: OSSearchGateway defines model os OS search gateway
  OSSearchGatewayRecord:
    title: OSSearchGatewayRecord
    allOf:
    - $ref: '#/definitions/OSSearchGateway'
    - properties:
        samples:
          type: array
          items:
            $ref: '#/definitions/OSSearchGatewayStat'
    description: 'OSSearchGatewayRecord combine OSSearchGateway and OSSearchGatewayStat to let API

      comfortable'
  OSSearchGatewaysResp:
    type: object
    required:
    - os_search_gateways
    properties:
      os_search_gateways:
        type: array
        items:
          $ref: '#/definitions/OSSearchGatewayRecord'
    title: OSSearchGatewaysResp
    example:
      os_search_gateways:
      - ''
      - ''
  OSSearchGatewaySamplesResp:
    type: object
    required:
    - os_search_gateway_samples
    properties:
      os_search_gateway_samples:
        type: array
        items:
          $ref: '#/definitions/OSSearchGatewayStat'
    title: OSSearchGatewaySamplesResp
    example:
      os_search_gateway_samples:
      - read_bandwidth_kbyte: 1.4658129805029452
        write_bandwidth_kbyte: 2.3021358869347655
        mem_usage_percent: 6.027456183070403
        create: '2000-01-23T04:56:07.000+00:00'
        write_iops: 7.061401241503109
        write_latency_us: 9.301444243932576
        read_latency_us: 5.637376656633329
        cpu_util: 0.8008281904610115
        read_iops: 5.962133916683182
      - read_bandwidth_kbyte: 1.4658129805029452
        write_bandwidth_kbyte: 2.3021358869347655
        mem_usage_percent: 6.027456183070403
        create: '2000-01-23T04:56:07.000+00:00'
        write_iops: 7.061401241503109
        write_latency_us: 9.301444243932576
        read_latency_us: 5.637376656633329
        cpu_util: 0.8008281904610115
        read_iops: 5.962133916683182
  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
  Pool_Nestview:
    type: object
    properties:
      id:
        type: integer
        format: int64
      name:
        type: string
    title: Pool_Nestview
    example:
      name: name
      id: 5
  OSSearchEngine_Nestview:
    type: object
    properties:
      id:
        type: integer
        format: int64
    title: OSSearchEngine_Nestview
  OSSearchGatewayResp:
    type: object
    required:
    - os_search_gateway
    properties:
      os_search_gateway:
        $ref: '#/definitions/OSSearchGatewayRecord'
    title: OSSearchGatewayResp
    example:
      os_search_gateway: ''
  OSSearchGatewayStat:
    type: object
    properties:
      cpu_util:
        type: number
        format: double
      create:
        type: string
        format: date-time
      mem_usage_percent:
        type: number
        format: double
      read_bandwidth_kbyte:
        type: number
        format: double
      read_iops:
        type: number
        format: double
      read_latency_us:
        type: number
        format: double
      write_bandwidth_kbyte:
        type: number
        format: double
      write_iops:
        type: number
        format: double
      write_latency_us:
        type: number
        format: double
    title: OSSearchGatewayStat
    description: OSSearchGatewayStat defines model os OS search gateway stat
    example:
      read_bandwidth_kbyte: 1.4658129805029452
      write_bandwidth_kbyte: 2.3021358869347655
      mem_usage_percent: 6.027456183070403
      create: '2000-01-23T04:56:07.000+00:00'
      write_iops: 7.061401241503109
      write_latency_us: 9.301444243932576
      read_latency_us: 5.637376656633329
      cpu_util: 0.8008281904610115
      read_iops: 5.962133916683182
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