swagger: '2.0'
info:
  description: Configuration for NetScaler Capacity Utilization resource.
  version: 'v2'
  title: perf_capacity_utilization_report
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: perf_capacity_utilization_report
    description: NetScaler Capacity Utilization
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/perf_capacity_utilization_report:
    get:
      tags:
        - perf_capacity_utilization_report
      summary: GET all perf_capacity_utilization_report
      operationId: getall_perf_capacity_utilization_report
      description: Use this operation to get the NetScaler Capacity Utilization
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the perf_capacity_utilization_report resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the perf_capacity_utilization_report resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of perf_capacity_utilization_report resources.
          enum:
            - yes
      responses:
        200:
          description:  for perf_capacity_utilization_report
          schema: 
              $ref: '#/definitions/getperf_capacity_utilization_reportsResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  getperf_capacity_utilization_reportResponse:
    type: object
    required:
      - perf_capacity_utilization_report
    properties:
      perf_capacity_utilization_report:
        $ref: '#/definitions/perf_capacity_utilization_report'
    title: getperf_capacity_utilization_reportResponse
    example:
      perf_capacity_utilization_report:
        allnic_err_rl_rate_pkt_drops: "number_value"
        allnic_err_rl_pps_pkt_drops: "number_value"
        allnic_err_rl_cpu_pkt_drops: "number_value"
        report_level: "0"
        device_ip_address: "string_value"
        rl_tot_ssl_rl_data_limited: "number_value"
        timestamp: "number_value"
        allnic_err_rl_pkt_drops: "number_value"
        rl_tot_ssl_rl_sess_limited: "number_value"
        rl_tot_ssl_rl_enforced: "number_value"
        id: "string_value"
        agg_level: "0"
        report_start_time: "number_value"
        report_end_time: "number_value"

  getperf_capacity_utilization_reportsResponse:
    type: object
    required:
      - perf_capacity_utilization_report
    properties:
      perf_capacity_utilization_report:
        type: array
        items:
          $ref: '#/definitions/perf_capacity_utilization_report'
    title: getperf_capacity_utilization_reportsResponse
    example:
      perf_capacity_utilization_report:
        allnic_err_rl_rate_pkt_drops: "number_value"
        allnic_err_rl_pps_pkt_drops: "number_value"
        allnic_err_rl_cpu_pkt_drops: "number_value"
        report_level: "0"
        device_ip_address: "string_value"
        rl_tot_ssl_rl_data_limited: "number_value"
        timestamp: "number_value"
        allnic_err_rl_pkt_drops: "number_value"
        rl_tot_ssl_rl_sess_limited: "number_value"
        rl_tot_ssl_rl_enforced: "number_value"
        id: "string_value"
        agg_level: "0"
        report_start_time: "number_value"
        report_end_time: "number_value"

  perf_capacity_utilization_report_readwrite:
    type: object
    properties:
      allnic_err_rl_rate_pkt_drops:
        description: "allnic_err_rl_rate_pkt_drops Value "
        type: number
        format: double
      allnic_err_rl_pps_pkt_drops:
        description: "allnic_err_rl_pps_pkt_drops Value "
        type: number
        format: double
      allnic_err_rl_cpu_pkt_drops:
        description: "allnic_err_rl_cpu_pkt_drops Value "
        type: number
        format: double
      report_level:
        description: "whether the row is for minutely, hourly etc"
        type: integer
        format: int32
      device_ip_address:
        description: "Device IP Address"
        type: string
        format: IP Address
        minLength: 1
        maxLength: 64
      rl_tot_ssl_rl_data_limited:
        description: "rl_tot_ssl_rl_data_limited Value "
        type: number
        format: double
      timestamp:
        description: "timestamp in seconds (UTC)"
        type: number
        format: double
      allnic_err_rl_pkt_drops:
        description: "allnic_err_rl_pkt_drops Value"
        type: number
        format: double
      rl_tot_ssl_rl_sess_limited:
        description: "rl_tot_ssl_rl_sess_limited Value "
        type: number
        format: double
      rl_tot_ssl_rl_enforced:
        description: "rl_tot_ssl_rl_enforced Value "
        type: number
        format: double
      id:
        description: "Id is system generated key for all the entries in this perf table configuration"
        type: string
        format: string
        maxLength: 256
      agg_level:
        description: "whether the row is Aggregated for Avg, Min, Max etc"
        type: integer
        format: int32
      report_start_time:
        description: "report_start_time in seconds"
        type: number
        format: double
      report_end_time:
        description: "report_end_time in seconds"
        type: number
        format: double

  perf_capacity_utilization_report:
    allOf:
      - $ref: '#/definitions/perf_capacity_utilization_report_readwrite'

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
