Solaris Zones Statistics Discovery API

openapi: 3.1.0
info:
  title: Solaris Zones Oracle Solaris Kernel Zones Archive Creation Statistics Discovery API
  description: REST API for creating and managing Oracle Solaris Kernel Zones via the RAD zonemgr module. Kernel Zones (brand solaris-kz) are non-global zones with their own kernel, providing greater independence and enhanced security isolation compared to native zones. They support live migration, independent patching, and hardware-assisted virtualization.
  version: '1.6'
  contact:
    name: Oracle Solaris Support
    url: https://www.oracle.com/solaris/support/
    email: solaris-support@oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
servers:
- url: https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6
  description: Oracle Solaris RAD REST endpoint
  variables:
    host:
      default: localhost
      description: Solaris host running RAD
    port:
      default: '6788'
      description: RAD REST API port
security:
- cookieAuth: []
tags:
- name: Statistics Discovery
  description: Discover available statistics and namespaces
paths:
  /:
    get:
      operationId: listSstoreInterfaces
      summary: Solaris Zones List Statsstore Interfaces
      description: Discover all available StatsStore interfaces and the hierarchical namespace of statistics identifiers (SSIDs).
      tags:
      - Statistics Discovery
      parameters:
      - $ref: '#/components/parameters/radDetail'
      responses:
        '200':
          description: Available StatsStore interfaces
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: array
                    items:
                      type: object
                      properties:
                        href:
                          type: string
                        type:
                          type: string
              examples:
                Listsstoreinterfaces200Example:
                  summary: Default listSstoreInterfaces 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                    - href: example_value
                      type: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Store/_rad_method/list:
    put:
      operationId: listStatistics
      summary: Solaris Zones List Available Statistics
      description: List statistics identifiers (SSIDs) matching the given pattern. SSIDs follow a hierarchical namespace format like //:class:module/statistic-name. Supports glob-style wildcards.
      tags:
      - Statistics Discovery
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - pattern
              properties:
                pattern:
                  type: string
                  description: 'SSID pattern with optional wildcards. Examples: //:class:zones/*, //:class:cpu/*, //:class:memory/*, //:class:net/*'
                  example: //:class:zones/*
            examples:
              ListstatisticsRequestExample:
                summary: Default listStatistics request
                x-microcks-default: true
                value:
                  pattern: example_value
      responses:
        '200':
          description: List of matching SSIDs
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: array
                    items:
                      $ref: '#/components/schemas/StatisticIdentifier'
              examples:
                Liststatistics200Example:
                  summary: Default listStatistics 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                    - ssid: '500123'
                      type: counter
                      description: A sample description.
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Store/_rad_method/describe:
    put:
      operationId: describeStatistic
      summary: Solaris Zones Describe a Statistic
      description: Get metadata about a statistic including its description, data type, unit, and collection interval.
      tags:
      - Statistics Discovery
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - ssid
              properties:
                ssid:
                  type: string
                  description: SSID to describe
                  example: //:class:zones/utilization/cpu
            examples:
              DescribestatisticRequestExample:
                summary: Default describeStatistic request
                x-microcks-default: true
                value:
                  ssid: '500123'
      responses:
        '200':
          description: Statistic metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    $ref: '#/components/schemas/StatisticMetadata'
              examples:
                Describestatistic200Example:
                  summary: Default describeStatistic 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      ssid: '500123'
                      description: A sample description.
                      type: counter
                      unit: example_value
                      interval: 10
                      persistent: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    StatisticIdentifier:
      type: object
      properties:
        ssid:
          type: string
          description: Statistics identifier in hierarchical namespace format (e.g., //:class:zones/zone-name/utilization/cpu)
          example: '500123'
        type:
          type: string
          description: Statistic data type
          enum:
          - counter
          - gauge
          - histogram
          - string
          example: counter
        description:
          type: string
          description: Human-readable description
          example: A sample description.
    RadError:
      type: object
      properties:
        status:
          type: string
          example: failure
        payload:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
          example: example_value
    StatisticMetadata:
      type: object
      properties:
        ssid:
          type: string
          description: Statistics identifier
          example: '500123'
        description:
          type: string
          description: Human-readable description
          example: A sample description.
        type:
          type: string
          description: Data type
          enum:
          - counter
          - gauge
          - histogram
          - string
          example: counter
        unit:
          type: string
          description: Unit of measurement (e.g., bytes, percent, count)
          example: example_value
        interval:
          type: integer
          description: Collection interval in seconds
          example: 10
        persistent:
          type: boolean
          description: Whether historical data is retained
          example: true
  responses:
    Unauthorized:
      description: Authentication required or session expired
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RadError'
  parameters:
    radDetail:
      name: _rad_detail
      in: query
      required: false
      description: Include detailed property information
      schema:
        type: boolean
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: _rad_session
      description: RAD session cookie obtained via authentication
externalDocs:
  description: Oracle Solaris Kernel Zones Documentation
  url: https://docs.oracle.com/en/operating-systems/solaris/oracle-solaris/11.4/kernel-zones/oracle-solaris-kernel-zones.html