XSKY fs-gateway-groups API

FSGatewayGroupController provides APIs for file storage gateway group

Operations 7

GET /fs-gateway-groups/ #
POST /fs-gateway-groups/ #
GET /fs-gateway-groups/{fs_gateway_group_id} #
DELETE /fs-gateway-groups/{fs_gateway_group_id} #
PATCH /fs-gateway-groups/{fs_gateway_group_id} #
POST /fs-gateway-groups/{fs_gateway_group_id}:add-gateways #
POST /fs-gateway-groups/{fs_gateway_group_id}:remove-gateways #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/xsky-fs-gateway-groups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

xsky-fs-gateway-groups-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: XMS is the controller of distributed storage system
  version: SDS_4.2.000.0.200302
  title: XMS access-paths Fs Gateway Groups API
  contact: {}
  license:
    name: Commercial
servers:
- url: /v1
tags:
- name: fs-gateway-groups
  description: 'FSGatewayGroupController provides APIs for file storage gateway group

    '
paths:
  /fs-gateway-groups/:
    get:
      tags:
      - fs-gateway-groups
      description: List file storage gateway groups
      operationId: ListFSGatewayGroups
      parameters:
      - name: limit
        in: query
        description: paging param
        required: false
        x-exportParamName: Limit
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: paging param
        required: false
        x-exportParamName: Offset
        schema:
          type: integer
          format: int64
      - name: type
        in: query
        description: type of file storage gateway group
        required: false
        x-exportParamName: Type_
        schema:
          type: string
      - name: security
        in: query
        description: security of file storage gateway group
        required: false
        x-exportParamName: Security
        schema:
          type: string
      - name: q
        in: query
        description: query param of search
        required: false
        x-exportParamName: Q
        schema:
          type: string
      - name: sort
        in: query
        description: sort param of search
        required: false
        x-exportParamName: Sort
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSGatewayGroupsResp'
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    post:
      tags:
      - fs-gateway-groups
      description: Create file storage gateway group
      operationId: CreateFSGatewayGroup
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSGatewayGroupResp'
        400:
          description: BadRequest
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FSGatewayGroupCreateReq'
        description: gateway group info
        required: true
  /fs-gateway-groups/{fs_gateway_group_id}:
    get:
      tags:
      - fs-gateway-groups
      description: Get file storage gateway group
      operationId: GetFSGatewayGroup
      parameters:
      - name: fs_gateway_group_id
        in: path
        description: gateway group id
        required: true
        x-exportParamName: FsGatewayGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSGatewayGroupResp'
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    delete:
      tags:
      - fs-gateway-groups
      description: delete file storage gateway group
      operationId: DeleteFSGatewayGroup
      parameters:
      - name: fs_gateway_group_id
        in: path
        description: gateway group id
        required: true
        x-exportParamName: FsGatewayGroupId
        schema:
          type: integer
          format: int64
      - name: force
        in: query
        description: force delete or not
        required: false
        x-exportParamName: Force
        schema:
          type: boolean
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSGatewayGroupResp'
        404:
          description: NotFound
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    patch:
      tags:
      - fs-gateway-groups
      description: Update file storage gateway group
      operationId: UpdateFSGatewayGroup
      parameters:
      - name: fs_gateway_group_id
        in: path
        description: gateway group id
        required: true
        x-exportParamName: FsGatewayGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSGatewayGroupResp'
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSGatewayGroupResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FSGatewayGroupUpdateReq'
        description: gateway group info
        required: true
  /fs-gateway-groups/{fs_gateway_group_id}:add-gateways:
    post:
      tags:
      - fs-gateway-groups
      description: add file storage gateways
      operationId: AddFSGateways
      parameters:
      - name: fs_gateway_group_id
        in: path
        description: gateway group id
        required: true
        x-exportParamName: FsGatewayGroupId
        schema:
          type: integer
          format: int64
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSGatewayGroupResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FSGatewayGroupAddGatewaysReq'
        description: gateways info
        required: true
  /fs-gateway-groups/{fs_gateway_group_id}:remove-gateways:
    post:
      tags:
      - fs-gateway-groups
      description: remove gateways from gateway group
      operationId: RemoveFSGateways
      parameters:
      - name: fs_gateway_group_id
        in: path
        description: gateway group id
        required: true
        x-exportParamName: FsGatewayGroupId
        schema:
          type: integer
          format: int64
      - name: force
        in: query
        description: force delete or not
        required: false
        x-exportParamName: Force
        schema:
          type: boolean
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSGatewayGroupResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FSGatewayGroupRemoveGatewaysReq'
        description: gateways info
        required: true
components:
  schemas:
    FSGatewayGroupRemoveGatewaysReq_GatewayGroup:
      type: object
      required:
      - fs_gateway_ids
      properties:
        fs_gateway_ids:
          type: array
          description: file storage gateway ids
          items:
            type: integer
            format: int64
      title: FSGatewayGroupRemoveGatewaysReq_GatewayGroup
    FSGatewayGroup:
      type: object
      properties:
        action_status:
          type: string
        create:
          type: string
          format: date-time
        description:
          type: string
        encoding:
          type: string
        folder_num:
          type: integer
          format: int64
        id:
          type: integer
          format: int64
        name:
          type: string
        nfs_versions:
          type: array
          description: NFS attributes
          items:
            type: string
        port:
          type: integer
          format: int64
          description: FTP attributes
        security:
          type: string
          description: SMB attributes
        smb1_enabled:
          type: boolean
        smb_ports:
          type: array
          items:
            type: integer
            format: int64
        status:
          type: string
        types:
          type: array
          items:
            type: string
        update:
          type: string
          format: date-time
        user_group_num:
          type: integer
          format: int64
        vip:
          type: string
        vip_mask:
          type: integer
          format: int64
      title: FSGatewayGroup
      description: FSGatewayGroup defines model of file storage gateway group @grpc-models-proto
      example:
        smb_ports:
        - 5
        - 5
        types:
        - types
        - types
        smb1_enabled: true
        description: description
        update: '2000-01-23T04:56:07.000+00:00'
        vip_mask: 2
        encoding: encoding
        security: security
        port: 1
        name: name
        create: '2000-01-23T04:56:07.000+00:00'
        nfs_versions:
        - nfs_versions
        - nfs_versions
        user_group_num: 5
        id: 6
        vip: vip
        action_status: action_status
        folder_num: 0
        status: status
    FSGatewayGroupUpdateReq:
      type: object
      required:
      - fs_gateway_group
      properties:
        fs_gateway_group:
          $ref: '#/components/schemas/FSGatewayGroupUpdateReq_GatewayGroup'
      title: FSGatewayGroupUpdateReq
    FSGatewayGroupAddGatewaysReq:
      type: object
      required:
      - fs_gateway_group
      properties:
        fs_gateway_group:
          $ref: '#/components/schemas/FSGatewayGroupAddGatewaysReq_GatewayGroup'
      title: FSGatewayGroupAddGatewaysReq
    FSGatewayGroupCreateReq:
      type: object
      required:
      - fs_gateway_group
      properties:
        fs_gateway_group:
          $ref: '#/components/schemas/FSGatewayGroupCreateReq_GatewayGroup'
      title: FSGatewayGroupCreateReq
    FSGatewayGroupCreateReq_GatewayGroup:
      type: object
      required:
      - fs_gateways
      - name
      - types
      - vip
      properties:
        description:
          type: string
          description: description of gateway group
        encoding:
          type: string
          description: ftp encoding format, default is utf8
        fs_gateways:
          type: array
          description: file storage gateways list
          items:
            $ref: '#/components/schemas/FSGatewayReq'
        name:
          type: string
          description: name of gateway group
        nfs_versions:
          type: array
          description: nfs versions of nfs supported
          items:
            type: string
        security:
          type: string
          description: smb security type
        smb1_enabled:
          type: boolean
          description: smb version 1.0 enabled
        smb_ports:
          type: array
          description: smb ports
          items:
            type: integer
            format: int64
        types:
          type: array
          description: types of supported (smb, nfs, ftp)
          items:
            type: string
        vip:
          type: string
          description: virtual ip of gateway group
      title: FSGatewayGroupCreateReq_GatewayGroup
    FSGatewayGroupsResp:
      type: object
      required:
      - fs_gateway_groups
      properties:
        fs_gateway_groups:
          type: array
          description: file storage gateway groups
          items:
            $ref: '#/components/schemas/FSGatewayGroup'
      title: FSGatewayGroupsResp
      example:
        fs_gateway_groups:
        - smb_ports:
          - 5
          - 5
          types:
          - types
          - types
          smb1_enabled: true
          description: description
          update: '2000-01-23T04:56:07.000+00:00'
          vip_mask: 2
          encoding: encoding
          security: security
          port: 1
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          nfs_versions:
          - nfs_versions
          - nfs_versions
          user_group_num: 5
          id: 6
          vip: vip
          action_status: action_status
          folder_num: 0
          status: status
        - smb_ports:
          - 5
          - 5
          types:
          - types
          - types
          smb1_enabled: true
          description: description
          update: '2000-01-23T04:56:07.000+00:00'
          vip_mask: 2
          encoding: encoding
          security: security
          port: 1
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          nfs_versions:
          - nfs_versions
          - nfs_versions
          user_group_num: 5
          id: 6
          vip: vip
          action_status: action_status
          folder_num: 0
          status: status
    FSGatewayGroupRemoveGatewaysReq:
      type: object
      required:
      - fs_gateway_group
      properties:
        fs_gateway_group:
          $ref: '#/components/schemas/FSGatewayGroupRemoveGatewaysReq_GatewayGroup'
      title: FSGatewayGroupRemoveGatewaysReq
    FSGatewayGroupAddGatewaysReq_GatewayGroup:
      type: object
      required:
      - fs_gateways
      properties:
        fs_gateways:
          type: array
          description: file storage gateways list
          items:
            $ref: '#/components/schemas/FSGatewayReq'
      title: FSGatewayGroupAddGatewaysReq_GatewayGroup
    FSGatewayReq:
      type: object
      required:
      - host_id
      properties:
        host_id:
          type: integer
          format: int64
          description: host id
        network_address_id:
          type: integer
          format: int64
          description: network address id
      title: FSGatewayReq
    FSGatewayGroupResp:
      type: object
      required:
      - fs_gateway_group
      properties:
        fs_gateway_group:
          description: file storage gateway group
          $ref: '#/components/schemas/FSGatewayGroup'
      title: FSGatewayGroupResp
      example:
        fs_gateway_group:
          smb_ports:
          - 5
          - 5
          types:
          - types
          - types
          smb1_enabled: true
          description: description
          update: '2000-01-23T04:56:07.000+00:00'
          vip_mask: 2
          encoding: encoding
          security: security
          port: 1
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          nfs_versions:
          - nfs_versions
          - nfs_versions
          user_group_num: 5
          id: 6
          vip: vip
          action_status: action_status
          folder_num: 0
          status: status
    FSGatewayGroupUpdateReq_GatewayGroup:
      type: object
      properties:
        description:
          type: string
          description: description of gateway group
        encoding:
          type: string
          description: ftp encoding format, default is utf8
        name:
          type: string
          description: name of gateway group
        nfs_versions:
          type: array
          description: nfs versions supported
          items:
            type: string
        security:
          type: string
          description: smb security type
        smb1_enabled:
          type: boolean
          description: smb version 1.0 enabled
        smb_ports:
          type: array
          description: smb ports
          items:
            type: integer
            format: int64
        types:
          type: array
          description: types of supported
          items:
            type: string
        vip:
          type: string
          description: virtual ip of gateway group
      title: FSGatewayGroupUpdateReq_GatewayGroup
  securitySchemes:
    tokenInHeader:
      description: auth by token
      type: apiKey
      name: Xms-Auth-Token
      in: header
    tokenInQuery:
      description: auth by token
      type: apiKey
      name: token
      in: query