XSKY block-volume-groups API

VolumeGroupController Operations about volume group

Operations 7

GET /block-volume-groups/ #
POST /block-volume-groups/ #
GET /block-volume-groups/{block_volume_group_id} #
DELETE /block-volume-groups/{block_volume_group_id} #
PATCH /block-volume-groups/{block_volume_group_id} #
PUT /block-volume-groups/{block_volume_group_id}/block-volumes #
DELETE /block-volume-groups/{block_volume_group_id}/block-volumes #

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-block-volume-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-block-volume-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 Block Volume Groups API
  contact: {}
  license:
    name: Commercial
servers:
- url: /v1
tags:
- name: block-volume-groups
  description: 'VolumeGroupController Operations about volume group

    '
paths:
  /block-volume-groups/:
    get:
      tags:
      - block-volume-groups
      description: List block volume groups
      operationId: ListBlockVolumeGroups
      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: 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/VolumeGroupsResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    post:
      tags:
      - block-volume-groups
      description: Create block volume group
      operationId: CreateBlockVolumeGroup
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeGroupResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VolumeGroupCreateReq'
        description: volume group info
        required: true
  /block-volume-groups/{block_volume_group_id}:
    get:
      tags:
      - block-volume-groups
      description: get a block volume group
      operationId: GetBlockVolumeGroup
      parameters:
      - name: block_volume_group_id
        in: path
        description: block volume group id
        required: true
        x-exportParamName: BlockVolumeGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeGroupResp'
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    delete:
      tags:
      - block-volume-groups
      description: Delete a block volume group
      operationId: DeleteBlockVolumeGroup
      parameters:
      - name: block_volume_group_id
        in: path
        description: block volume group id
        required: true
        x-exportParamName: BlockVolumeGroupId
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: No Content
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInHeader: []
      - tokenInQuery: []
    patch:
      tags:
      - block-volume-groups
      description: Update block volume group
      operationId: UpdateBlockVolumeGroup
      parameters:
      - name: block_volume_group_id
        in: path
        description: block volume group id
        required: true
        x-exportParamName: BlockVolumeGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeGroupResp'
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeGroupResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInHeader: []
      - tokenInQuery: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VolumeGroupUpdateReq'
        description: volume group info
        required: true
  /block-volume-groups/{block_volume_group_id}/block-volumes:
    put:
      tags:
      - block-volume-groups
      description: Add block volume to block volume group
      operationId: AddBlockVolumeToBlockVolumeGroup
      parameters:
      - name: block_volume_group_id
        in: path
        description: block volume group id
        required: true
        x-exportParamName: BlockVolumeGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeGroupResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VolumeGroupAddVolumeReq'
        description: volume ids
        required: true
    delete:
      tags:
      - block-volume-groups
      description: Remove block volume from block volume group
      operationId: RemoveBlockVolumeFromBlockVolumeGroup
      parameters:
      - name: block_volume_group_id
        in: path
        description: block volume group id
        required: true
        x-exportParamName: BlockVolumeGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeGroupResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInHeader: []
      - tokenInQuery: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VolumeGroupRemoveVolumeReq'
        description: volume ids
        required: true
components:
  schemas:
    VolumeGroupSnapshot_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
      title: VolumeGroupSnapshot_Nestview
      example:
        name: name
        id: 6
    VolumeGroupsResp:
      type: object
      properties:
        block_volume_groups:
          type: array
          items:
            $ref: '#/components/schemas/VolumeGroup'
      title: VolumeGroupsResp
      example:
        block_volume_groups:
        - flattened: true
          block_volume_num: 6
          description: description
          update: '2000-01-23T04:56:07.000+00:00'
          latest_snapshot_time: '2000-01-23T04:56:07.000+00:00'
          block_volume_group_snapshot_num: 0
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          progress: 5.962133916683182
          id: 1
          action_status: action_status
          block_volume_group_snapshot:
            name: name
            id: 6
          status: status
        - flattened: true
          block_volume_num: 6
          description: description
          update: '2000-01-23T04:56:07.000+00:00'
          latest_snapshot_time: '2000-01-23T04:56:07.000+00:00'
          block_volume_group_snapshot_num: 0
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          progress: 5.962133916683182
          id: 1
          action_status: action_status
          block_volume_group_snapshot:
            name: name
            id: 6
          status: status
    VolumeGroupUpdateReq:
      type: object
      required:
      - block_volume_group
      properties:
        block_volume_group:
          $ref: '#/components/schemas/VolumeGroupUpdateReq_VolumeGroup'
      title: VolumeGroupUpdateReq
      example:
        block_volume_group:
          flattened: true
          name: name
          description: description
    VolumeGroupCreateReq_VolumeGroup:
      type: object
      required:
      - name
      properties:
        block_volume_group_snapshot_id:
          type: integer
          format: int64
        block_volume_ids:
          type: array
          items:
            type: integer
            format: int64
        description:
          type: string
        flattened:
          type: boolean
        name:
          type: string
      title: VolumeGroupCreateReq_VolumeGroup
      example:
        flattened: true
        block_volume_ids:
        - 6
        - 6
        name: name
        description: description
        block_volume_group_snapshot_id: 0
    VolumeGroupRemoveVolumeReq:
      type: object
      required:
      - block_volume_ids
      properties:
        block_volume_ids:
          type: array
          items:
            type: integer
            format: int64
      title: VolumeGroupRemoveVolumeReq
      example:
        block_volume_ids:
        - 0
        - 0
    VolumeGroup:
      type: object
      properties:
        action_status:
          type: string
        block_volume_group_snapshot:
          $ref: '#/components/schemas/VolumeGroupSnapshot_Nestview'
        block_volume_group_snapshot_num:
          type: integer
          format: int64
        block_volume_num:
          type: integer
          format: int64
        create:
          type: string
          format: date-time
        description:
          type: string
        flattened:
          type: boolean
        id:
          type: integer
          format: int64
        latest_snapshot_time:
          type: string
          format: date-time
        name:
          type: string
        progress:
          type: number
          format: double
        status:
          type: string
        update:
          type: string
          format: date-time
      title: VolumeGroup
      description: VolumeGroup defines the model of volume group
      example:
        flattened: true
        block_volume_num: 6
        description: description
        update: '2000-01-23T04:56:07.000+00:00'
        latest_snapshot_time: '2000-01-23T04:56:07.000+00:00'
        block_volume_group_snapshot_num: 0
        name: name
        create: '2000-01-23T04:56:07.000+00:00'
        progress: 5.962133916683182
        id: 1
        action_status: action_status
        block_volume_group_snapshot:
          name: name
          id: 6
        status: status
    VolumeGroupAddVolumeReq:
      type: object
      required:
      - block_volume_ids
      properties:
        block_volume_ids:
          type: array
          items:
            type: integer
            format: int64
      title: VolumeGroupAddVolumeReq
      example:
        block_volume_ids:
        - 0
        - 0
    VolumeGroupCreateReq:
      type: object
      required:
      - block_volume_group
      properties:
        block_volume_group:
          $ref: '#/components/schemas/VolumeGroupCreateReq_VolumeGroup'
      title: VolumeGroupCreateReq
      example:
        block_volume_group:
          flattened: true
          block_volume_ids:
          - 6
          - 6
          name: name
          description: description
          block_volume_group_snapshot_id: 0
    VolumeGroupResp:
      type: object
      properties:
        block_volume_group:
          $ref: '#/components/schemas/VolumeGroup'
      title: VolumeGroupResp
      example:
        block_volume_group:
          flattened: true
          block_volume_num: 6
          description: description
          update: '2000-01-23T04:56:07.000+00:00'
          latest_snapshot_time: '2000-01-23T04:56:07.000+00:00'
          block_volume_group_snapshot_num: 0
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          progress: 5.962133916683182
          id: 1
          action_status: action_status
          block_volume_group_snapshot:
            name: name
            id: 6
          status: status
    VolumeGroupUpdateReq_VolumeGroup:
      type: object
      required:
      - name
      properties:
        description:
          type: string
        flattened:
          type: boolean
        name:
          type: string
      title: VolumeGroupUpdateReq_VolumeGroup
      example:
        flattened: true
        name: name
        description: description
  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