XSKY mapping-groups API

MappingGroupController Operations able mapping groups

Operations 8

GET /mapping-groups/ #
POST /mapping-groups/ #
GET /mapping-groups/{mapping_group_id} #
DELETE /mapping-groups/{mapping_group_id} #
PATCH /mapping-groups/{mapping_group_id} #
POST /mapping-groups/{mapping_group_id}/block-volumes #
DELETE /mapping-groups/{mapping_group_id}/block-volumes #
PATCH /mapping-groups/{mapping_group_id}/client-group #

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-mapping-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-mapping-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 Mapping Groups API
  contact: {}
  license:
    name: Commercial
servers:
- url: /v1
tags:
- name: mapping-groups
  description: 'MappingGroupController Operations able mapping groups

    '
paths:
  /mapping-groups/:
    get:
      tags:
      - mapping-groups
      description: List mapping groups
      operationId: ListMappingGroups
      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: access_path_id
        in: query
        description: access path id
        required: false
        x-exportParamName: AccessPathId
        schema:
          type: integer
          format: int64
      - name: client_group_id
        in: query
        description: client group id
        required: false
        x-exportParamName: ClientGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingGroupsResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    post:
      tags:
      - mapping-groups
      description: create a mapping group in access path
      operationId: CreateMappingGroup
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingGroupResp'
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingGroupResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInHeader: []
      - tokenInQuery: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MappingGroupCreateReq'
        description: mapping info
        required: true
  /mapping-groups/{mapping_group_id}:
    get:
      tags:
      - mapping-groups
      description: Get mapping group by id
      operationId: GetMappingGroup
      parameters:
      - name: mapping_group_id
        in: path
        description: mapping group id
        required: true
        x-exportParamName: MappingGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingGroupResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    delete:
      tags:
      - mapping-groups
      description: Delete mapping group
      operationId: DeleteMappingGroup
      parameters:
      - name: mapping_group_id
        in: path
        description: mapping group id
        required: true
        x-exportParamName: MappingGroupId
        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/MappingGroupResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    patch:
      tags:
      - mapping-groups
      description: update mapping group
      operationId: UpdateMappingGroup
      parameters:
      - name: mapping_group_id
        in: path
        description: mapping group id
        required: true
        x-exportParamName: MappingGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingGroupResp'
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingGroupResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MappingGroupUpdateReq'
        description: mapping info
        required: true
  /mapping-groups/{mapping_group_id}/block-volumes:
    post:
      tags:
      - mapping-groups
      description: add volumes to mapping group
      operationId: AddVolumes
      parameters:
      - name: mapping_group_id
        in: path
        description: mapping group id
        required: true
        x-exportParamName: MappingGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingGroupResp'
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingGroupResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MappingGroupAddVolumesReq'
        description: block volume ids
        required: true
    delete:
      tags:
      - mapping-groups
      description: remove volumes from mapping group
      operationId: RemoveVolumes
      parameters:
      - name: mapping_group_id
        in: path
        description: mapping group id
        required: true
        x-exportParamName: MappingGroupId
        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/MappingGroupResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MappingGroupRemoveVolumesReq'
        description: block volume ids
        required: true
  /mapping-groups/{mapping_group_id}/client-group:
    patch:
      tags:
      - mapping-groups
      description: update client group in mapping group
      operationId: UpdateMappingGroupClientGroup
      parameters:
      - name: mapping_group_id
        in: path
        description: mapping group id
        required: true
        x-exportParamName: MappingGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingGroupResp'
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingGroupResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MappingGroupUpdateClientGroupReq'
        description: client group id
        required: true
components:
  schemas:
    MappingGroupRemoveVolumesReq:
      type: object
      required:
      - block_volume_ids
      properties:
        block_volume_ids:
          type: array
          items:
            type: integer
            format: int64
      title: MappingGroupRemoveVolumesReq
      example:
        block_volume_ids:
        - 0
        - 0
    MappingGroupResp:
      type: object
      required:
      - mapping_group
      properties:
        mapping_group:
          $ref: '#/components/schemas/MappingGroup'
      title: MappingGroupResp
      example:
        mapping_group:
          client_group:
            name: name
            id: 5
          access_path:
            name: name
            id: 0
          create: '2000-01-23T04:56:07.000+00:00'
          update: '2000-01-23T04:56:07.000+00:00'
          id: 6
          status: status
    MappingGroup:
      type: object
      properties:
        access_path:
          $ref: '#/components/schemas/AccessPath_Nestview'
        client_group:
          $ref: '#/components/schemas/ClientGroup_Nestview'
        create:
          type: string
          format: date-time
        id:
          type: integer
          format: int64
        status:
          type: string
        update:
          type: string
          format: date-time
      title: MappingGroup
      description: MappingGroup defines the mapping group of volumes and client groups
      example:
        client_group:
          name: name
          id: 5
        access_path:
          name: name
          id: 0
        create: '2000-01-23T04:56:07.000+00:00'
        update: '2000-01-23T04:56:07.000+00:00'
        id: 6
        status: status
    AccessPath_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
      title: AccessPath_Nestview
      example:
        name: name
        id: 0
    MappingGroupCreateReq:
      type: object
      required:
      - mapping_group
      properties:
        mapping_group:
          $ref: '#/components/schemas/MappingGroupReq'
      title: MappingGroupCreateReq
      example:
        mapping_group:
          client_group_id: 5
          block_volume_ids:
          - 1
          - 1
          access_path_id: 6
    MappingGroupReq:
      type: object
      properties:
        access_path_id:
          type: integer
          format: int64
        block_volume_ids:
          type: array
          items:
            type: integer
            format: int64
        client_group_id:
          type: integer
          format: int64
      title: MappingGroupReq
      example:
        client_group_id: 5
        block_volume_ids:
        - 1
        - 1
        access_path_id: 6
    ClientGroup_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
      title: ClientGroup_Nestview
      example:
        name: name
        id: 5
    MappingGroupUpdateClientGroupReq:
      type: object
      required:
      - client_group_id
      properties:
        client_group_id:
          type: integer
          format: int64
      title: MappingGroupUpdateClientGroupReq
      example:
        client_group_id: 0
    MappingGroupsResp:
      type: object
      required:
      - mapping_groups
      properties:
        mapping_groups:
          type: array
          items:
            $ref: '#/components/schemas/MappingGroup'
      title: MappingGroupsResp
      example:
        mapping_groups:
        - client_group:
            name: name
            id: 5
          access_path:
            name: name
            id: 0
          create: '2000-01-23T04:56:07.000+00:00'
          update: '2000-01-23T04:56:07.000+00:00'
          id: 6
          status: status
        - client_group:
            name: name
            id: 5
          access_path:
            name: name
            id: 0
          create: '2000-01-23T04:56:07.000+00:00'
          update: '2000-01-23T04:56:07.000+00:00'
          id: 6
          status: status
    MappingGroupAddVolumesReq:
      type: object
      required:
      - block_volume_ids
      properties:
        block_volume_ids:
          type: array
          items:
            type: integer
            format: int64
      title: MappingGroupAddVolumesReq
      example:
        block_volume_ids:
        - 0
        - 0
    MappingGroupUpdateReq:
      type: object
      required:
      - mapping_group
      properties:
        mapping_group:
          $ref: '#/components/schemas/MappingGroupUpdateReq_MappingGroup'
      title: MappingGroupUpdateReq
      example:
        mapping_group:
          block_volume_ids:
          - 0
          - 0
    MappingGroupUpdateReq_MappingGroup:
      type: object
      properties:
        block_volume_ids:
          type: array
          items:
            type: integer
            format: int64
      title: MappingGroupUpdateReq_MappingGroup
      example:
        block_volume_ids:
        - 0
        - 0
  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