CubeFS Master API — Cluster

naftiko: 1.0.0-alpha2
info:
  label: CubeFS Master API — Cluster
  description: 'CubeFS Master API — Cluster. 3 operations. Lead operation: CubeFS Get cluster information. Self-contained
    Naftiko capability covering one Cubefs business surface.'
  tags:
  - Cubefs
  - Cluster
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CUBEFS_API_KEY: CUBEFS_API_KEY
capability:
  consumes:
  - type: http
    namespace: master-cluster
    baseUri: http://{masterHost}:{masterPort}
    description: CubeFS Master API — Cluster business capability. Self-contained, no shared references.
    resources:
    - name: admin-getCluster
      path: /admin/getCluster
      operations:
      - name: getcluster
        method: GET
        description: CubeFS Get cluster information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cluster-freeze
      path: /cluster/freeze
      operations:
      - name: freezecluster
        method: GET
        description: CubeFS Freeze or unfreeze the cluster
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: enable
          in: query
          type: string
          description: Set to true to freeze the cluster or false to unfreeze it.
          required: true
    - name: cluster-stat
      path: /cluster/stat
      operations:
      - name: getclusterstat
        method: GET
        description: CubeFS Get cluster statistics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: master-cluster-rest
    port: 8080
    description: REST adapter for CubeFS Master API — Cluster. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/admin/getcluster
      name: admin-getcluster
      description: REST surface for admin-getCluster.
      operations:
      - method: GET
        name: getcluster
        description: CubeFS Get cluster information
        call: master-cluster.getcluster
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/cluster/freeze
      name: cluster-freeze
      description: REST surface for cluster-freeze.
      operations:
      - method: GET
        name: freezecluster
        description: CubeFS Freeze or unfreeze the cluster
        call: master-cluster.freezecluster
        with:
          enable: rest.enable
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/cluster/stat
      name: cluster-stat
      description: REST surface for cluster-stat.
      operations:
      - method: GET
        name: getclusterstat
        description: CubeFS Get cluster statistics
        call: master-cluster.getclusterstat
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: master-cluster-mcp
    port: 9090
    transport: http
    description: MCP adapter for CubeFS Master API — Cluster. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: cubefs-get-cluster-information
      description: CubeFS Get cluster information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: master-cluster.getcluster
      outputParameters:
      - type: object
        mapping: $.
    - name: cubefs-freeze-unfreeze-cluster
      description: CubeFS Freeze or unfreeze the cluster
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: master-cluster.freezecluster
      with:
        enable: tools.enable
      outputParameters:
      - type: object
        mapping: $.
    - name: cubefs-get-cluster-statistics
      description: CubeFS Get cluster statistics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: master-cluster.getclusterstat
      outputParameters:
      - type: object
        mapping: $.