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-replication-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.

GitHub Google LinkedIn

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

OpenAPI Specification

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 Replication Zones API
  contact: {}
  license:
    name: Commercial
servers:
- url: /v1
tags:
- name: os-replication-zones
  description: 'OSReplicationZoneController API /os-replication-zones.

    '
paths:
  /os-replication-zones/:
    get:
      tags:
      - os-replication-zones
      description: List os replication zones
      operationId: ListOSReplicationZones
      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: marker
        in: query
        description: paging param
        required: false
        x-exportParamName: Marker
        schema:
          type: string
      - name: replication_uuid
        in: query
        description: os replication uuid
        required: false
        x-exportParamName: ReplicationUuid
        schema:
          type: string
      - name: os_zone_uuid
        in: query
        description: os zone uuid
        required: false
        x-exportParamName: OsZoneUuid
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OSReplicationZoneRecordsResp'
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    post:
      tags:
      - os-replication-zones
      description: Create a os replication zone
      operationId: CreateOSReplicationZone
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OSReplicationZoneResp'
        400:
          description: BadRequest
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OSReplicationZoneCreateReq'
        description: os replication zone info
        required: true
  /os-replication-zones/{zone_uuid}:
    get:
      tags:
      - os-replication-zones
      description: Get a os replication zone
      operationId: GetOSReplicationZone
      parameters:
      - name: zone_uuid
        in: path
        description: os replication zone uuid
        required: true
        x-exportParamName: ZoneUuid
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OSReplicationZoneRecordResp'
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInHeader: []
      - tokenInQuery: []
    delete:
      tags:
      - os-replication-zones
      description: Delete a os replication zone
      operationId: DeleteOSReplicationZone
      parameters:
      - name: zone_uuid
        in: path
        description: os replication zone uuid
        required: true
        x-exportParamName: ZoneUuid
        schema:
          type: string
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OSReplicationZoneResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
  /os-replication-zones/{zone_uuid}/samples:
    get:
      tags:
      - os-replication-zones
      description: get an os replication zone's samples
      operationId: GetOSReplicationZoneSamples
      parameters:
      - name: zone_uuid
        in: path
        description: os replication 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/OSReplicationZoneSamplesResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
components:
  schemas:
    OSRemotePolicy_Nestview:
      type: object
      properties:
        name:
          type: string
        uuid:
          type: string
      title: OSRemotePolicy_Nestview
      example:
        name: name
        uuid: uuid
    OSReplicationZoneSamplesResp:
      type: object
      required:
      - os_replication_zone_samples
      properties:
        os_replication_zone_samples:
          type: array
          description: os replication zone samples
          items:
            $ref: '#/components/schemas/OSReplicationZoneStat'
      title: OSReplicationZoneSamplesResp
      example:
        os_replication_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
    ObjectStorageZone_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        uuid:
          type: string
      title: ObjectStorageZone_Nestview
      example:
        id: 7
        uuid: uuid
    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
    OSReplicationZoneResp:
      type: object
      properties:
        os_replication_zone:
          $ref: '#/components/schemas/OSReplicationZone'
      title: OSReplicationZoneResp
      example:
        os_replication_zone:
          dirty: true
          replication_uuid: replication_uuid
          os_zone:
            id: 7
            uuid: uuid
          os_remote_policy_uuid: os_remote_policy_uuid
          os_zone_uuid: os_zone_uuid
          update: '2000-01-23T04:56:07.000+00:00'
          os_remote_policy:
            name: name
            uuid: uuid
          uuid: uuid
          os_bucket_owner_zone:
            id: 7
            uuid: uuid
          os_bucket_owner_cluster:
            name: name
            id: 2
            fs_id: fs_id
            url: url
          os_bucket:
            lifecycle:
              rules:
              - '{}'
              - '{}'
              id: 6
              status: status
            name: name
            id: 0
          create: '2000-01-23T04:56:07.000+00:00'
          os_replication_path_num: 0
          status: status
    OSReplicationZoneRecord:
      title: OSReplicationZoneRecord
      allOf:
      - $ref: '#/components/schemas/OSReplicationZone'
      - properties:
          samples:
            type: array
            items:
              $ref: '#/components/schemas/OSReplicationZoneStat'
      description: 'OSReplicationZoneRecord is used to combine OSReplicationZone and

        OSReplicationZoneStat'
    OSReplicationZoneRecordsResp:
      type: object
      properties:
        os_replication_zones:
          type: array
          items:
            $ref: '#/components/schemas/OSReplicationZoneRecord'
      title: OSReplicationZoneRecordsResp
      example:
        os_replication_zones:
        - ''
        - ''
    OSReplicationZoneStat:
      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: OSReplicationZoneStat
      description: OSReplicationZoneStat contains sync stat info of os replication 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
    OSReplicationZoneRecordResp:
      type: object
      properties:
        os_replication_zone:
          $ref: '#/components/schemas/OSReplicationZoneRecord'
      title: OSReplicationZoneRecordResp
      example:
        os_replication_zone: ''
    OSReplicationZone:
      type: object
      properties:
        create:
          type: string
          format: date-time
        dirty:
          type: boolean
        os_bucket:
          $ref: '#/components/schemas/ObjectStorageBucket_Nestview'
        os_bucket_owner_cluster:
          $ref: '#/components/schemas/RemoteCluster_Nestview'
        os_bucket_owner_zone:
          $ref: '#/components/schemas/ObjectStorageZone_Nestview'
        os_remote_policy:
          $ref: '#/components/schemas/OSRemotePolicy_Nestview'
        os_remote_policy_uuid:
          type: string
        os_replication_path_num:
          type: integer
          format: int64
        os_zone:
          $ref: '#/components/schemas/ObjectStorageZone_Nestview'
        os_zone_uuid:
          type: string
        replication_uuid:
          type: string
        status:
          type: string
        update:
          type: string
          format: date-time
        uuid:
          type: string
      title: OSReplicationZone
      description: OSReplicationZone defines models of os replication zone.
      example:
        dirty: true
        replication_uuid: replication_uuid
        os_zone:
          id: 7
          uuid: uuid
        os_remote_policy_uuid: os_remote_policy_uuid
        os_zone_uuid: os_zone_uuid
        update: '2000-01-23T04:56:07.000+00:00'
        os_remote_policy:
          name: name
          uuid: uuid
        uuid: uuid
        os_bucket_owner_zone:
          id: 7
          uuid: uuid
        os_bucket_owner_cluster:
          name: name
          id: 2
          fs_id: fs_id
          url: url
        os_bucket:
          lifecycle:
            rules:
            - '{}'
            - '{}'
            id: 6
            status: status
          name: name
          id: 0
        create: '2000-01-23T04:56:07.000+00:00'
        os_replication_path_num: 0
        status: status
    ObjectStorageBucket_Nestview_lifecycle:
      properties:
        id:
          type: integer
          format: int64
        rules:
          type: array
          items:
            type: object
            properties: {}
        status:
          type: string
      example:
        rules:
        - '{}'
        - '{}'
        id: 6
        status: status
    OSReplicationZoneCreateReq_OSReplicationZone:
      type: object
      required:
      - os_bucket_id
      - uuid
      properties:
        os_bucket_id:
          type: integer
          format: int64
        uuid:
          type: string
      title: OSReplicationZoneCreateReq_OSReplicationZone
    ObjectStorageBucket_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        lifecycle:
          $ref: '#/components/schemas/ObjectStorageBucket_Nestview_lifecycle'
        name:
          type: string
      title: ObjectStorageBucket_Nestview
      example:
        lifecycle:
          rules:
          - '{}'
          - '{}'
          id: 6
          status: status
        name: name
        id: 0
    OSReplicationZoneCreateReq:
      type: object
      required:
      - os_replication_zone
      properties:
        os_replication_zone:
          $ref: '#/components/schemas/OSReplicationZoneCreateReq_OSReplicationZone'
      title: OSReplicationZoneCreateReq
  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