XSKY os-search-gateways API

OSSearchGatewayController provides API for os search gateways

Operations 3

GET /os-search-gateways/ #
GET /os-search-gateways/{gateway_id} #
GET /os-search-gateways/{gateway_id}/samples #

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-os-search-gateways-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-os-search-gateways-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 Os Search Gateways API
  contact: {}
  license:
    name: Commercial
servers:
- url: /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
      parameters:
      - name: os_search_engine_id
        in: query
        description: os search engine id
        required: false
        x-exportParamName: OsSearchEngineId
        schema:
          type: integer
          format: int64
      - 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/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
      parameters:
      - name: gateway_id
        in: path
        description: os search gateway id
        required: true
        x-exportParamName: GatewayId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      parameters:
      - name: gateway_id
        in: path
        description: os search gateway id
        required: true
        x-exportParamName: GatewayId
        schema:
          type: integer
          format: int64
      - name: duration_begin
        in: query
        description: duration begin timestamp
        required: false
        x-exportParamName: DurationBegin
        schema:
          type: string
      - name: duration_end
        in: query
        description: duration end timestamp
        required: false
        x-exportParamName: DurationEnd
        schema:
          type: string
      - name: period
        in: query
        description: samples period
        required: false
        x-exportParamName: Period
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OSSearchGatewaySamplesResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
components:
  schemas:
    OSSearchGatewaysResp:
      type: object
      required:
      - os_search_gateways
      properties:
        os_search_gateways:
          type: array
          items:
            $ref: '#/components/schemas/OSSearchGatewayRecord'
      title: OSSearchGatewaysResp
      example:
        os_search_gateways:
        - ''
        - ''
    Pool_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
      title: Pool_Nestview
      example:
        name: name
        id: 5
    OSSearchGatewayResp:
      type: object
      required:
      - os_search_gateway
      properties:
        os_search_gateway:
          $ref: '#/components/schemas/OSSearchGatewayRecord'
      title: OSSearchGatewayResp
      example:
        os_search_gateway: ''
    OSSearchGatewaySamplesResp:
      type: object
      required:
      - os_search_gateway_samples
      properties:
        os_search_gateway_samples:
          type: array
          items:
            $ref: '#/components/schemas/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
    OSSearchGatewayRecord:
      title: OSSearchGatewayRecord
      allOf:
      - $ref: '#/components/schemas/OSSearchGateway'
      - properties:
          samples:
            type: array
            items:
              $ref: '#/components/schemas/OSSearchGatewayStat'
      description: 'OSSearchGatewayRecord combine OSSearchGateway and OSSearchGatewayStat to let API

        comfortable'
    OSSearchGateway:
      type: object
      properties:
        action_status:
          type: string
        create:
          type: string
          format: date-time
        host:
          $ref: '#/components/schemas/Host_Nestview'
        id:
          type: integer
          format: int64
        pool:
          $ref: '#/components/schemas/Pool_Nestview'
        search_engine:
          $ref: '#/components/schemas/OSSearchEngine_Nestview'
        status:
          type: string
        update:
          type: string
          format: date-time
      title: OSSearchGateway
      description: OSSearchGateway defines model os OS search gateway
    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
    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
    OSSearchEngine_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
      title: OSSearchEngine_Nestview
  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