Weka Failure domains API

The Failure domains API from Weka — 2 operation(s) for failure domains.

OpenAPI Specification

weka-failure-domains-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: '@weka-api Active Directory Failure domains API'
  version: '5.1'
  description: "\n<div>\n  The WEKA system provides a RESTful API, enabling efficient\n  automation and integration into existing workflows or monitoring systems. To access\n  the REST API documentation within the cluster, navigate to <code>/api/v2/docs</code>\n  on port 14000 (e.g.,\n  <code>https://weka01:14000/api/v2/docs</code>).\n  <br>\n  <br>\n  For detailed guidance on using the REST API, including CLI command equivalents and related concepts, refer to the official\n  documentation:\n  <a href=\"https://docs.weka.io/getting-started-with-weka/getting-started-with-weka-rest-api\">Getting Started with the WEKA REST API</a>.\n  <br>\n  <br>\n  <div style=\"margin-top: 15px;\">\n    <b>Important:</b>\n    WEKA uses 64-bit numbers, which requires careful handling when interacting with the API across different programming languages.\n    In JavaScript, for instance, the\n    <code>\"json-bigint\"</code>\n    library is recommended.\n  </div>\n</div>"
servers:
- url: /api/v2
security:
- bearerAuth: []
tags:
- name: Failure domains
paths:
  /failureDomains:
    get:
      tags:
      - Failure domains
      summary: List failure domains
      description: Lists all failure domains in the cluster. A failure domain is a set of hardware components that can fail together from a single root cause.
      operationId: getFailureDomains
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/failureDomain'
        '401':
          $ref: '#/components/responses/401'
      parameters:
      - in: query
        name: show_removed
        schema:
          type: boolean
  /failureDomains/{uid}:
    get:
      tags:
      - Failure domains
      summary: Get failure domain details
      description: Returns details for a specific failure domain, including its resources and capacity.
      operationId: getSingleFailureDomain
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/failureDomain'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
      parameters:
      - in: path
        name: uid
        required: true
        schema:
          type: string
        description: The unique identifier of the failure domain.
components:
  responses:
    '404':
      description: Not Found
      content:
        application/json:
          schema:
            properties:
              message:
                type: string
                example: error message
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            properties:
              data:
                type: string
                example: Unauthorized
  schemas:
    failureDomain:
      type: object
      properties:
        id:
          type: string
          example: DOM-001
        uid:
          type: string
          example: uid_string
        drives:
          type: array
          items:
            type: string
            example: DiskId<2>
        hosts:
          type: array
          items:
            type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT