XSKY fs-ftp-sessions API

FSFTPSessionController provides API for fs FTP session

OpenAPI Specification

xsky-fs-ftp-sessions-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  description: XMS is the controller of distributed storage system
  version: SDS_4.2.000.0.200302
  title: XMS access-paths fs-ftp-sessions API
  contact: {}
  license:
    name: Commercial
basePath: /v1
tags:
- name: fs-ftp-sessions
  description: 'FSFTPSessionController provides API for fs FTP session

    '
paths:
  /fs-ftp-sessions/:
    get:
      tags:
      - fs-ftp-sessions
      description: List fs ftp sessions
      operationId: ListFSFTPSessions
      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: fs_ftp_share_id
        in: query
        description: fs ftp share id
        required: false
        type: integer
        format: int64
        x-exportParamName: FsFtpShareId
      - 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/FSFTPSessionsResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
definitions:
  FSFTPShare_Nestview:
    type: object
    properties:
      id:
        type: integer
        format: int64
    title: FSFTPShare_Nestview
    example:
      id: 6
  FSFTPSessionsResp:
    type: object
    required:
    - fs_ftp_sessions
    properties:
      fs_ftp_sessions:
        type: array
        description: fs ftp sessions
        items:
          $ref: '#/definitions/FSFTPSession'
    title: FSFTPSessionsResp
    example:
      fs_ftp_sessions:
      - client_port: 0
        create: '2000-01-23T04:56:07.000+00:00'
        update: '2000-01-23T04:56:07.000+00:00'
        client_ip: client_ip
        connected_at: '2000-01-23T04:56:07.000+00:00'
        id: 1
        fs_ftp_share:
          id: 6
        username: username
      - client_port: 0
        create: '2000-01-23T04:56:07.000+00:00'
        update: '2000-01-23T04:56:07.000+00:00'
        client_ip: client_ip
        connected_at: '2000-01-23T04:56:07.000+00:00'
        id: 1
        fs_ftp_share:
          id: 6
        username: username
  FSFTPSession:
    type: object
    properties:
      client_ip:
        type: string
      client_port:
        type: integer
        format: int64
      connected_at:
        type: string
        format: date-time
      create:
        type: string
        format: date-time
      fs_ftp_share:
        $ref: '#/definitions/FSFTPShare_Nestview'
      id:
        type: integer
        format: int64
      update:
        type: string
        format: date-time
      username:
        type: string
    title: FSFTPSession
    description: FSFTPSession defines model of FS FTP session
    example:
      client_port: 0
      create: '2000-01-23T04:56:07.000+00:00'
      update: '2000-01-23T04:56:07.000+00:00'
      client_ip: client_ip
      connected_at: '2000-01-23T04:56:07.000+00:00'
      id: 1
      fs_ftp_share:
        id: 6
      username: username
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