XSKY os-zones API

ObjectStorageZoneController API /os-zones

Operations 6

GET /os-zones/ #
POST /os-zones/ #
GET /os-zones/{zone_uuid} #
POST /os-zones/{zone_uuid} #
DELETE /os-zones/{zone_uuid} #
GET /os-zones/{zone_uuid}/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-zones-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-zones-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 Zones API
  contact: {}
  license:
    name: Commercial
servers:
- url: /v1
tags:
- name: os-zones
  description: 'ObjectStorageZoneController API /os-zones

    '
paths:
  /os-zones/:
    get:
      tags:
      - os-zones
      description: List object storage zones
      operationId: ListObjectStorageZones
      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
      - name: local
        in: query
        description: local or non-local zones
        required: false
        x-exportParamName: Local
        schema:
          type: boolean
      - name: master
        in: query
        description: master or non-master zones
        required: false
        x-exportParamName: Master
        schema:
          type: boolean
      - name: name
        in: query
        description: name of zone
        required: false
        x-exportParamName: Name
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageZonesRecordResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    post:
      tags:
      - os-zones
      description: Create a object storage zone
      operationId: CreateObjectStorageZone
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageZoneResp'
        400:
          description: BadRequest
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObjectStorageZoneCreateReq'
        description: zone info
        required: true
  /os-zones/{zone_uuid}:
    get:
      tags:
      - os-zones
      description: Get object storage zone
      operationId: GetObjectStorageZone
      parameters:
      - name: zone_uuid
        in: path
        description: object storage zone uuid
        required: true
        x-exportParamName: ZoneUuid
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageZoneRecordResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    post:
      tags:
      - os-zones
      description: update os zone pairs
      operationId: UpdateOSZonesClockDiff
      parameters:
      - name: zone_uuid
        in: path
        description: os zone uuid
        required: true
        x-exportParamName: ZoneUuid
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageZoneResp'
        400:
          description: BadRequest
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OSZonePairsUpdateReq'
        description: zone pairs info
        required: true
    delete:
      tags:
      - os-zones
      description: Delete a object storage zone
      operationId: DeleteObjectStorageZone
      parameters:
      - name: zone_uuid
        in: path
        description: os zone uuid
        required: true
        x-exportParamName: ZoneUuid
        schema:
          type: string
      - name: force
        in: query
        description: delete os zone forcefully or not
        required: false
        x-exportParamName: Force
        schema:
          type: boolean
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageZoneResp'
        400:
          description: BadRequest
        403:
          description: Forbidden
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
  /os-zones/{zone_uuid}/samples:
    get:
      tags:
      - os-zones
      description: get an object storage zone's Samples
      operationId: GetObjectStorageZoneSamples
      parameters:
      - name: zone_uuid
        in: path
        description: object storage zone uuid
        required: true
        x-exportParamName: ZoneUuid
        schema:
          type: string
          default: 'true'
      - 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/ObjectStorageZoneSamplesResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
components:
  schemas:
    OSZonePairsUpdateReq_Zone:
      type: object
      properties:
        target_zones:
          type: array
          items:
            $ref: '#/components/schemas/OSZonePairsUpdateReq_Zone_TargetZones_Elt'
      title: OSZonePairsUpdateReq_Zone
    OSZonePairsUpdateReq_Zone_TargetZones_Elt:
      type: object
      required:
      - clock_diff
      - zone_uuid
      properties:
        clock_diff:
          type: integer
          format: int64
        zone_uuid:
          type: string
      title: OSZonePairsUpdateReq_Zone_TargetZones_Elt
    ObjectStorageZoneResp:
      type: object
      properties:
        os_zone:
          $ref: '#/components/schemas/ObjectStorageZone'
      title: ObjectStorageZoneResp
      example:
        os_zone:
          endpoints:
          - endpoints
          - endpoints
          system_access_key: system_access_key
          system_secret_key: system_secret_key
          zonegroup_name: zonegroup_name
          update: '2000-01-23T04:56:07.000+00:00'
          uuid: uuid
          epoch_uuid: epoch_uuid
          local: true
          realm_name: realm_name
          switch_status: switch_status
          master: true
          connected: true
          remote_cluster:
            name: name
            id: 2
            fs_id: fs_id
            url: url
          s3_load_balancer_group:
            name: name
            id: 6
            status: status
          name: name
          alias: alias
          create: '2000-01-23T04:56:07.000+00:00'
          search_zone_uuid: search_zone_uuid
          id: 0
          system_user: system_user
          tier_type: tier_type
          status: status
    ObjectStorageZoneCreateReq:
      type: object
      properties:
        os_zone:
          $ref: '#/components/schemas/ObjectStorageZoneCreateReq_Zone'
      title: ObjectStorageZoneCreateReq
      example:
        os_zone:
          remote_cluster_id: 0
          alias: alias
          master: true
    ObjectStorageZonesRecordResp:
      type: object
      properties:
        os_zones:
          type: array
          items:
            $ref: '#/components/schemas/ObjectStorageZoneRecord'
      title: ObjectStorageZonesRecordResp
      example:
        os_zones:
        - ''
        - ''
    ObjectStorageZoneCreateReq_Zone:
      type: object
      required:
      - master
      - remote_cluster_id
      properties:
        alias:
          type: string
          description: os zone alias
        master:
          type: boolean
          description: is a master zone
        remote_cluster_id:
          type: integer
          format: int64
          description: remote cluster id
      title: ObjectStorageZoneCreateReq_Zone
      example:
        remote_cluster_id: 0
        alias: alias
        master: true
    RemoteCluster_Nestview:
      type: object
      properties:
        fs_id:
          type: string
        id:
          type: integer
          format: int64
        name:
          type: string
        url:
          type: string
      title: RemoteCluster_Nestview
      example:
        name: name
        id: 2
        fs_id: fs_id
        url: url
    OSZonePairsUpdateReq:
      type: object
      properties:
        os_zone:
          $ref: '#/components/schemas/OSZonePairsUpdateReq_Zone'
      title: OSZonePairsUpdateReq
    ObjectStorageZoneRecordResp:
      type: object
      properties:
        os_zone:
          $ref: '#/components/schemas/ObjectStorageZoneRecord'
      title: ObjectStorageZoneRecordResp
      example:
        os_zone: ''
    S3LoadBalancerGroup_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        status:
          type: string
      title: S3LoadBalancerGroup_Nestview
      example:
        name: name
        id: 6
        status: status
    ObjectStorageZoneStat:
      type: object
      properties:
        bandwidth_kbyte:
          type: number
          format: double
        create:
          type: string
          format: date-time
        object_kbytes_ps:
          type: number
          format: double
        objects_pm:
          type: number
          format: double
        total_bytes:
          type: integer
          format: int64
        total_object_bytes:
          type: integer
          format: int64
        total_objects:
          type: integer
          format: int64
      title: ObjectStorageZoneStat
      description: ObjectStorageZoneStat contains info of os zone
      example:
        object_kbytes_ps: 6.027456183070403
        total_objects: 2
        bandwidth_kbyte: 0.8008281904610115
        total_bytes: 5
        create: '2000-01-23T04:56:07.000+00:00'
        objects_pm: 1.4658129805029452
        total_object_bytes: 5
    ObjectStorageZone:
      type: object
      properties:
        alias:
          type: string
        connected:
          type: boolean
        create:
          type: string
          format: date-time
        endpoints:
          type: array
          items:
            type: string
        epoch_uuid:
          type: string
        id:
          type: integer
          format: int64
        local:
          type: boolean
        master:
          type: boolean
        name:
          type: string
        realm_name:
          type: string
        remote_cluster:
          $ref: '#/components/schemas/RemoteCluster_Nestview'
        s3_load_balancer_group:
          $ref: '#/components/schemas/S3LoadBalancerGroup_Nestview'
        search_zone_uuid:
          type: string
        status:
          type: string
        switch_status:
          type: string
        system_access_key:
          type: string
        system_secret_key:
          type: string
        system_user:
          type: string
        tier_type:
          type: string
        update:
          type: string
          format: date-time
        uuid:
          type: string
        zonegroup_name:
          type: string
      title: ObjectStorageZone
      description: ObjectStorageZone is the model of object_storage_zone
      example:
        endpoints:
        - endpoints
        - endpoints
        system_access_key: system_access_key
        system_secret_key: system_secret_key
        zonegroup_name: zonegroup_name
        update: '2000-01-23T04:56:07.000+00:00'
        uuid: uuid
        epoch_uuid: epoch_uuid
        local: true
        realm_name: realm_name
        switch_status: switch_status
        master: true
        connected: true
        remote_cluster:
          name: name
          id: 2
          fs_id: fs_id
          url: url
        s3_load_balancer_group:
          name: name
          id: 6
          status: status
        name: name
        alias: alias
        create: '2000-01-23T04:56:07.000+00:00'
        search_zone_uuid: search_zone_uuid
        id: 0
        system_user: system_user
        tier_type: tier_type
        status: status
    ObjectStorageZoneRecord:
      title: ObjectStorageZoneRecord
      allOf:
      - $ref: '#/components/schemas/ObjectStorageZone'
      - properties:
          samples:
            type: array
            items:
              $ref: '#/components/schemas/ObjectStorageZoneStat'
      description: 'ObjectStorageZoneRecord combine ObjectStorageZone and ObjectStorageZoneStat as

        API response'
    ObjectStorageZoneSamplesResp:
      type: object
      required:
      - os_zone_samples
      properties:
        os_zone_samples:
          type: array
          description: object storage zone samples
          items:
            $ref: '#/components/schemas/ObjectStorageZoneStat'
      title: ObjectStorageZoneSamplesResp
      example:
        os_zone_samples:
        - object_kbytes_ps: 6.027456183070403
          total_objects: 2
          bandwidth_kbyte: 0.8008281904610115
          total_bytes: 5
          create: '2000-01-23T04:56:07.000+00:00'
          objects_pm: 1.4658129805029452
          total_object_bytes: 5
        - object_kbytes_ps: 6.027456183070403
          total_objects: 2
          bandwidth_kbyte: 0.8008281904610115
          total_bytes: 5
          create: '2000-01-23T04:56:07.000+00:00'
          objects_pm: 1.4658129805029452
          total_object_bytes: 5
  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