REST API for SCC Stats Service v1.0
Created Dec 18, 2020 at 07:15 PM

Resource: bw_usage

Depicts the bandwidth usage

http://{device}/api/cmc.stats/1.0/bandwidth/usage
  • JSON
  • {
    }
    Property Name Type Description Notes
    bw_usage <object> Depicts the bandwidth usage

    Resource: bw_timeseries

    Depicts the bandwidth timeseries

    http://{device}/api/cmc.stats/1.0/bandwidth/timeseries
  • JSON
  • {
    }
    Property Name Type Description Notes
    bw_timeseries <object> Depicts the bandwidth timeseries

    Resource: throughput

    Depicts the peak/p95 throughput timeseries

    http://{device}/api/cmc.stats/1.0/throughput
  • JSON
  • {
    }
    Property Name Type Description Notes
    throughput <object> Depicts the peak/p95 throughput timeseries

    Resource: connection_history

    Depicts the max/avg connection history timeseries

    http://{device}/api/cmc.stats/1.0/connection_history
  • JSON
  • {
    }
    Property Name Type Description Notes
    connection_history <object> Depicts the max/avg connection history timeseries

    Resource: connection_pooling

    Depicts the connection pooling timeseries

    http://{device}/api/cmc.stats/1.0/connection_pooling
  • JSON
  • {
    }
    Property Name Type Description Notes
    connection_pooling <object> Depicts the connection pooling timeseries

    Resource: connection_forwarding

    Depicts the connection forwarding timeseries

    http://{device}/api/cmc.stats/1.0/connection_forwarding
  • JSON
  • {
    }
    Property Name Type Description Notes
    connection_forwarding <object> Depicts the connection forwarding timeseries

    Resource: http

    Depicts the http timeseries

    http://{device}/api/cmc.stats/1.0/http
  • JSON
  • {
    }
    Property Name Type Description Notes
    http <object> Depicts the http timeseries

    Resource: nfs

    Depicts the nfs timeseries

    http://{device}/api/cmc.stats/1.0/nfs
  • JSON
  • {
    }
    Property Name Type Description Notes
    nfs <object> Depicts the nfs timeseries

    Resource: ssl

    Depicts the ssl timeseries

    http://{device}/api/cmc.stats/1.0/ssl
  • JSON
  • {
    }
    Property Name Type Description Notes
    ssl <object> Depicts the ssl timeseries

    Resource: disk_load

    Depicts the disk load timeseries

    http://{device}/api/cmc.stats/1.0/disk_load
  • JSON
  • {
    }
    Property Name Type Description Notes
    disk_load <object> Depicts the disk load timeseries

    Resource: sdr_adaptive

    Depicts the SDR Adaptive timeseries

    http://{device}/api/cmc.stats/1.0/sdr_adaptive
  • JSON
  • {
    }
    Property Name Type Description Notes
    sdr_adaptive <object> Depicts the SDR Adaptive timeseries

    Resource: memory_paging

    Depicts the memory paging timeseries

    http://{device}/api/cmc.stats/1.0/memory_paging
  • JSON
  • {
    }
    Property Name Type Description Notes
    memory_paging <object> Depicts the memory paging timeseries

    Resource: cpu_utilization

    Depicts the cpu utilization timeseries

    http://{device}/api/cmc.stats/1.0/cpu_utilization
  • JSON
  • {
    }
    Property Name Type Description Notes
    cpu_utilization <object> Depicts the cpu utilization timeseries

    Resource: pfs

    Depicts the pfs timeseries

    http://{device}/api/cmc.stats/1.0/pfs
  • JSON
  • {
    }
    Property Name Type Description Notes
    pfs <object> Depicts the pfs timeseries

    Resource: srdf

    Depicts the regular/peak srdf timeseries

    http://{device}/api/cmc.stats/1.0/srdf
  • JSON
  • {
    }
    Property Name Type Description Notes
    srdf <object> Depicts the regular/peak srdf timeseries

    Resource: snapmirror

    Depicts the regular/peak snapmirror timeseries

    http://{device}/api/cmc.stats/1.0/snapmirror
  • JSON
  • {
    }
    Property Name Type Description Notes
    snapmirror <object> Depicts the regular/peak snapmirror timeseries

    Resource: tcp_memory_pressure

    Depicts the regular/peak tcp memory pressure timeseries

    http://{device}/api/cmc.stats/1.0/tcp_memory_pressure
  • JSON
  • {
    }
    Property Name Type Description Notes
    tcp_memory_pressure <object> Depicts the regular/peak tcp memory pressure timeseries

    Resource: qos

    Depicts the outbound/inbound qos timeseries

    http://{device}/api/cmc.stats/1.0/qos
  • JSON
  • {
    }
    Property Name Type Description Notes
    qos <object> Depicts the outbound/inbound qos timeseries

    Resource: granite_lun_io

    Depicts the granite lun io timeseries

    http://{device}/api/cmc.stats/1.0/granite/lun_io
  • JSON
  • {
    }
    Property Name Type Description Notes
    granite_lun_io <object> Depicts the granite lun io timeseries

    Resource: granite_initiator_io

    Depicts the SteelFusion initiator io time-series

    http://{device}/api/cmc.stats/1.0/granite/initiator_io
  • JSON
  • {
    }
    Property Name Type Description Notes
    granite_initiator_io <object> Depicts the SteelFusion initiator io time-series

    Resource: granite_network_io

    Depicts the SteelFusion network IO timeseries

    http://{device}/api/cmc.stats/1.0/granite/network_io
  • JSON
  • {
    }
    Property Name Type Description Notes
    granite_network_io <object> Depicts the SteelFusion network IO timeseries

    Resource: granite_blockstore

    Depicts the SteelFusion blockstore timeseries

    http://{device}/api/cmc.stats/1.0/granite/blockstore
  • JSON
  • {
    }
    Property Name Type Description Notes
    granite_blockstore <object> Depicts the SteelFusion blockstore timeseries

    Resource: dns_usage

    Depicts the dns usage timeseries

    http://{device}/api/cmc.stats/1.0/dns/usage
  • JSON
  • {
    }
    Property Name Type Description Notes
    dns_usage <object> Depicts the dns usage timeseries

    Resource: dns_cache_hits

    Depicts the dns cache hits time-series

    http://{device}/api/cmc.stats/1.0/dns/cache_hits
  • JSON
  • {
    }
    Property Name Type Description Notes
    dns_cache_hits <object> Depicts the dns cache hits time-series

    Resource: bw_per_appliance

    Depicts the bandwidth per appliance data

    http://{device}/api/cmc.stats/1.0/bandwidth/per_appliance
  • JSON
  • {
    }
    Property Name Type Description Notes
    bw_per_appliance <object> Depicts the bandwidth per appliance data

    Resource: throughput_per_appliance

    Depicts the throughput per appliance data

    http://{device}/api/cmc.stats/1.0/throughput/per_appliance
  • JSON
  • {
    }
    Property Name Type Description Notes
    throughput_per_appliance <object> Depicts the throughput per appliance data

    Resource: logging

    Service logging parameters

    http://{device}/api/cmc.stats/1.0/logging
  • JSON
  • {
      "level": logging_level,
      <prop>: any
    }
    Property Name Type Description Notes
    logging <object> Service logging parameters Required properties: [level];
    logging.level <logging_level> Severity levels for logs emitted by the service Values: crit, err, warning, notice, info, debug;
    logging.<prop> <any> Optional;

    Type: port

    Port number

  • JSON
  • integer
    Property Name Type Description Notes
    port <integer> Port number Range: 1 to 65535;

    Type: device_id

    Case sensitive Device ID. Only alphanumeric permitted.

  • JSON
  • string
    Property Name Type Description Notes
    device_id <string> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';

    Type: granularity

    Specifies the granularity between successive time-series data

  • JSON
  • integer
    Property Name Type Description Notes
    granularity <integer> Specifies the granularity between successive time-series data Values: 300, 3600;

    Type: bw_criteria

    A list of fields to be defined in the request body when querying bandwidth data for time-series and per port bandwidth usage

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "traffic_type": string,
      "port": port,
      "devices": [ device_id ],
      <prop>: any
    }
    Property Name Type Description Notes
    bw_criteria <object> A list of fields to be defined in the request body when querying bandwidth data for time-series and per port bandwidth usage Required properties: [start_time, end_time];
    bw_criteria.start_time <timestamp> Seconds since January 1, 1970;
    bw_criteria.end_time <timestamp> Seconds since January 1, 1970;
    bw_criteria.traffic_type <string> Determines whether the query is for optimized traffic or the pass through Optional; Default is optimized; Values: optimized, passthrough;
    bw_criteria.port <port> Port number
    bw_criteria.devices <array of <device_id>> ' An array of devices being queried on. None implies all devices. If multiple devices are queried on, the data points are the sum across all the devices. This is optionally used in bandwidth usage and bw time-series queries. ' Optional;
    bw_criteria.devices[items] <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    bw_criteria.<prop> <any> Optional;

    Type: per_appl_bw_criteria

    A list of fields to be defined in the request body when querying the per appliance bw data

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "traffic_type": string,
      "devices": [ device_id ],
      <prop>: any
    }
    Property Name Type Description Notes
    per_appl_bw_criteria <object> A list of fields to be defined in the request body when querying the per appliance bw data Required properties: [start_time, end_time, devices];
    per_appl_bw_criteria.start_time <timestamp> Seconds since January 1, 1970;
    per_appl_bw_criteria.end_time <timestamp> Seconds since January 1, 1970;
    per_appl_bw_criteria.traffic_type <string> Determines whether the query is for optimized traffic or the pass through Optional; Default is optimized; Values: optimized, passthrough;
    per_appl_bw_criteria.devices <array of <device_id>> An array of devices being queried on. When multiple devices are queried on, the data points are returned for each of the devices.
    per_appl_bw_criteria.devices[items] <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    per_appl_bw_criteria.<prop> <any> Optional;

    Type: throughput_criteria

    A list of fields to be defined in the request body when querying for the through-put data.

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "traffic_type": string,
      "port": port,
      "device": device_id,
      <prop>: any
    }
    Property Name Type Description Notes
    throughput_criteria <object> A list of fields to be defined in the request body when querying for the through-put data. Required properties: [start_time, end_time, device];
    throughput_criteria.start_time <timestamp> Seconds since January 1, 1970;
    throughput_criteria.end_time <timestamp> Seconds since January 1, 1970;
    throughput_criteria.traffic_type <string> Determines whether the query is for peak traffic or the p95 Optional; Default is peak; Values: peak, p95;
    throughput_criteria.port <port> Port number
    throughput_criteria.device <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    throughput_criteria.<prop> <any> Optional;

    Type: per_appl_thrput_criteria

    A list of fields to be defined in the request body when querying for the per appliance through-put data.

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "traffic_type": string,
      "devices": [ device_id ],
      <prop>: any
    }
    Property Name Type Description Notes
    per_appl_thrput_criteria <object> A list of fields to be defined in the request body when querying for the per appliance through-put data. Required properties: [start_time, end_time, devices];
    per_appl_thrput_criteria.start_time <timestamp> Seconds since January 1, 1970;
    per_appl_thrput_criteria.end_time <timestamp> Seconds since January 1, 1970;
    per_appl_thrput_criteria.traffic_type <string> Determines whether the query is for peak traffic or the p95. Optional; Default is peak; Values: peak, p95;
    per_appl_thrput_criteria.devices <array of <device_id>> An array of devices being queried on. When multiple devices are queried on, the data points are returned for each of the devices.
    per_appl_thrput_criteria.devices[items] <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    per_appl_thrput_criteria.<prop> <any> Optional;

    Type: connection_history_criteria

    A list of fields to be defined in the request body when querying for the connection history

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "traffic_type": string,
      "device": device_id,
      <prop>: any
    }
    Property Name Type Description Notes
    connection_history_criteria <object> A list of fields to be defined in the request body when querying for the connection history Required properties: [start_time, end_time, device];
    connection_history_criteria.start_time <timestamp> Seconds since January 1, 1970;
    connection_history_criteria.end_time <timestamp> Seconds since January 1, 1970;
    connection_history_criteria.traffic_type <string> Determines whether the query is for avg or max stats in the connection history Optional; Default is max; Values: max, total;
    connection_history_criteria.device <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    connection_history_criteria.<prop> <any> Optional;

    Type: multiple_devices_criteria

    A generic list of fields to be defined in the request body when querying for multiple devices, no traffic type specified, time-series data

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "devices": [ device_id ],
      <prop>: any
    }
    Property Name Type Description Notes
    multiple_devices_criteria <object> A generic list of fields to be defined in the request body when querying for multiple devices, no traffic type specified, time-series data Required properties: [start_time, end_time];
    multiple_devices_criteria.start_time <timestamp> Seconds since January 1, 1970;
    multiple_devices_criteria.end_time <timestamp> Seconds since January 1, 1970;
    multiple_devices_criteria.devices <array of <device_id>> ' An array of devices being queried on. None implies all devices. If multiple devices are queried on, the data points are the sum across all the devices. ' Optional;
    multiple_devices_criteria.devices[items] <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    multiple_devices_criteria.<prop> <any> Optional;

    Type: multiple_devices_response_data

    ' This object is used to hold the response data of the multiple_devices_criteria queries with the generic characteristics of: 1. multiple devices being queried upon 2. do not specify a "traffic_type" 3. do not specify a "subclass" Currently, this is being used to hold the response data of: 1. HTTP time-series data for a specified set of devices 2. NFS time-series data for a specified set of devices 3. SSL time-series data for a specified set of devices 4. connection_pooling time-series data for a specified set of devices 5. connection_forwarding time-series data for a specified set of devices 6. disk_load time-series data for a specified set of devices 7. DNS usage time-series data for a specified set of devices 8. DNS cache hits time-series data for a specified set of devices '

  • JSON
  • {
      "query_criteria": multiple_devices_criteria,
      "granularity": granularity,
      "response_data": [
        {
          "timestamp": timestamp,
          "data": [
            number
          ],
          <prop>: any
        }
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    multiple_devices_response_data <object> ' This object is used to hold the response data of the multiple_devices_criteria queries with the generic characteristics of: 1. multiple devices being queried upon 2. do not specify a "traffic_type" 3. do not specify a "subclass" Currently, this is being used to hold the response data of: 1. HTTP time-series data for a specified set of devices 2. NFS time-series data for a specified set of devices 3. SSL time-series data for a specified set of devices 4. connection_pooling time-series data for a specified set of devices 5. connection_forwarding time-series data for a specified set of devices 6. disk_load time-series data for a specified set of devices 7. DNS usage time-series data for a specified set of devices 8. DNS cache hits time-series data for a specified set of devices '
    multiple_devices_response_data.
    query_criteria
    <multiple_devices_criteria> A generic list of fields to be defined in the request body when querying for multiple devices, no traffic type specified, time-series data
    multiple_devices_response_data.
    granularity
    <granularity> Specifies the granularity between successive time-series data Values: 300, 3600;
    multiple_devices_response_data.
    response_data
    <array of <object>> ' Each element in this array is one of the following: 1. {timestamp, http_data} tuple containing the timestamp and HTTP data at that time 2. {timestamp, nfs_data} tuple containing the timestamp and NFS data at that time 3. {timestamp, ssl_data} tuple containing the timestamp and SSL data at that time 4. {timestamp, connection_pooling_data} tuple containing the timestamp and connection pooling data at that time 5. {timestamp, connection_forwarding_data} tuple containing the timestamp and connection forwarding data at that time 6. {timestamp, disk_load_data} tuple containing the timestamp and disk load data at that time 7. {timestamp, dns_usage_data} tuple containing the timestamp and dns usage data at that time 8. {timestamp, dns_cache_hits_data} tuple containing the timestamp and dns cache hits data at that time ' Optional;
    multiple_devices_response_data.
    response_data[items]
    <object>
    multiple_devices_response_data.
    response_data[items].timestamp
    <timestamp> The epoch timestamp of this data point Optional; Seconds since January 1, 1970;
    multiple_devices_response_data.
    response_data[items].data
    <array of <number>> ' The [parse-and-prefetch_hits, misses, metadata_cache_hits, url-learning_hits] 4-tuple, exactly in that order, for each datapoint for HTTP. OR The [local_responses, delayed_responses, remote_responses, total_calls] 4-tuple, exactly in that order, for each datapoint for NFS. OR The [total_session_requests, established_sessions, blacklist_table_overflows] 3-tuple, exactly in that order, for each datapoint for SSL. OR The [total_connection_requests, reused_connections] 2-tuple, exactly in that order, for each datapoint for connection pool. OR The [packets_sent, bytes_sent] 2-tuple, exactly in that order, for each datapoint for connection forwarding. OR The [load] 1-tuple, for each datapoint for disk load. OR The [num_of_entries_in_cache, bytes_of_used_memory_in_cache] 2-tuple, exactly in that order, for each datapoint for DNS usage. OR The [success, referral, nxrrset, nxdomain, recursion, failure, miss] 7-tuple, in exactly the given order, for each datapoint for DNS cache hits. ' Optional;
    multiple_devices_response_data.
    response_data[items].data[items]
    <number>
    multiple_devices_response_data.
    response_data[items].<prop>
    <any> Optional;
    multiple_devices_response_data.<prop> <any> Optional;

    Type: single_device_criteria

    A generic list of fields to be defined in the request body when querying for a single device, no traffic type specified, timeseries data

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "device": device_id,
      <prop>: any
    }
    Property Name Type Description Notes
    single_device_criteria <object> A generic list of fields to be defined in the request body when querying for a single device, no traffic type specified, timeseries data Required properties: [start_time, end_time, device];
    single_device_criteria.start_time <timestamp> Seconds since January 1, 1970;
    single_device_criteria.end_time <timestamp> Seconds since January 1, 1970;
    single_device_criteria.device <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    single_device_criteria.<prop> <any> Optional;

    Type: single_device_response_data

    ' This object is used to hold the response data of the single_device_criteria queries with the generic characteristics of: 1. single device being queried upon 2. do not specify a "traffic_type" 3. do not specify a "subclass" Currently, this is being used to hold the response data of: 1. cpu_utilization timeseries data for a specified device 2. memory_paging timeseries data for a specified device 3. pfs timeseries data for a specified device 4. sdr_adaptive timeseries data for a specified device '

  • JSON
  • {
      "query_criteria": single_device_criteria,
      "granularity": granularity,
      "response_data": [
        {
          "timestamp": timestamp,
          "data": [
            number
          ],
          <prop>: any
        }
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    single_device_response_data <object> ' This object is used to hold the response data of the single_device_criteria queries with the generic characteristics of: 1. single device being queried upon 2. do not specify a "traffic_type" 3. do not specify a "subclass" Currently, this is being used to hold the response data of: 1. cpu_utilization timeseries data for a specified device 2. memory_paging timeseries data for a specified device 3. pfs timeseries data for a specified device 4. sdr_adaptive timeseries data for a specified device '
    single_device_response_data.
    query_criteria
    <single_device_criteria> A generic list of fields to be defined in the request body when querying for a single device, no traffic type specified, timeseries data
    single_device_response_data.granularity <granularity> Specifies the granularity between successive time-series data Values: 300, 3600;
    single_device_response_data.
    response_data
    <array of <object>> ' Each element in this array is one of the following: 1. {timestamp, cpu_utilization_data} tuple containing the timestamp and CPU utilization data at that time 2. {timestamp, memory_paging_data} tuple containing the timestamp and memory paging data at that time 3. {timestamp, pfs_data} tuple containing the timestamp and PFS data at that time 4. {timestamp, sdr_adaptive} tuple containing the timestamp and sdr_adaptive data at that time ' Optional;
    single_device_response_data.
    response_data[items]
    <object>
    single_device_response_data.
    response_data[items].timestamp
    <timestamp> The epoch timestamp of this datapoint Optional; Seconds since January 1, 1970;
    single_device_response_data.
    response_data[items].data
    <array of <number>> ' The [cpu_utilization_percentage] 1-tuple, for each datapoint for CPU utlization. OR The [num_of_pages_swapped_out] 1-tuple, for each datapoint for memory paging. OR The [share_size, bytes_received, bytes_sent] 3-tuple, exactly in that order, for each datapoint for PFS data. OR The [disk_pressure_only_compression, in_path_rule_only_compression, disk_pressure_only_in_mem_sdr, in_path_rule_only_in_mem_sdr] 4-tuple, for each datapoint for sdr_adaptive. ' Optional;
    single_device_response_data.
    response_data[items].data[items]
    <number>
    single_device_response_data.
    response_data[items].<prop>
    <any> Optional;
    single_device_response_data.<prop> <any> Optional;

    Type: reg_and_peak_traffic_type

    Determines whether the query is for regular/peak traffic.

  • JSON
  • string
    Property Name Type Description Notes
    reg_and_peak_traffic_type <string> Determines whether the query is for regular/peak traffic. Default is regular; Values: regular, peak;

    Type: reg_and_peak_traffic_criteria

    A list of fields to be defined in the request body when querying for the regular/peak time-series data for a single device

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "traffic_type": reg_and_peak_traffic_type,
      "device": device_id,
      <prop>: any
    }
    Property Name Type Description Notes
    reg_and_peak_traffic_criteria <object> A list of fields to be defined in the request body when querying for the regular/peak time-series data for a single device Required properties: [start_time, end_time, device];
    reg_and_peak_traffic_criteria.start_time <timestamp> Seconds since January 1, 1970;
    reg_and_peak_traffic_criteria.end_time <timestamp> Seconds since January 1, 1970;
    reg_and_peak_traffic_criteria.
    traffic_type
    <reg_and_peak_traffic_type> Determines whether the query is for regular/peak traffic. Default is regular; Values: regular, peak;
    reg_and_peak_traffic_criteria.device <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    reg_and_peak_traffic_criteria.<prop> <any> Optional;

    Type: reg_and_peak_response_data

    ' This object is used to hold the response data of the reg_and_peak_traffic_criteria queries with the generic characteristics of: 1. single device being queried upon 2. specify a "regular" (default) or peak "traffic_type" 3. do not specify a "subclass" Currently, this is being used to hold the response data of: 1. regular/peak srdf timeseries data for a specified device 2. regular/peak tcp_memory_pressure timeseries data for a specified device '

  • JSON
  • {
      "query_criteria": reg_and_peak_traffic_criteria,
      "granularity": granularity,
      "response_data": [
        {
          "timestamp": timestamp,
          "data": [
            number
          ],
          <prop>: any
        }
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    reg_and_peak_response_data <object> ' This object is used to hold the response data of the reg_and_peak_traffic_criteria queries with the generic characteristics of: 1. single device being queried upon 2. specify a "regular" (default) or peak "traffic_type" 3. do not specify a "subclass" Currently, this is being used to hold the response data of: 1. regular/peak srdf timeseries data for a specified device 2. regular/peak tcp_memory_pressure timeseries data for a specified device '
    reg_and_peak_response_data.
    query_criteria
    <reg_and_peak_traffic_criteria> A list of fields to be defined in the request body when querying for the regular/peak time-series data for a single device
    reg_and_peak_response_data.granularity <granularity> Specifies the granularity between successive time-series data Values: 300, 3600;
    reg_and_peak_response_data.response_data <array of <object>> ' Each element in this array is one of the following: 1. {timestamp, srdf_data} tuple containing the timestamp and regular/peak SRDF data at that time 2. {timestamp, tcp_memory_pressure_data} tuple containing the timestamp and regular/peak tcp memory pressure data at that time ' Optional;
    reg_and_peak_response_data.response_data
    [items]
    <object>
    reg_and_peak_response_data.response_data
    [items].timestamp
    <timestamp> The epoch timestamp of this datapoint Optional; Seconds since January 1, 1970;
    reg_and_peak_response_data.response_data
    [items].data
    <array of <number>> ' The [lan_bytes, wan_bytes] 2-tuple, exactly in that order, for each datapoint for regular/peak SRDF data. OR The [num_of_pages_used, PCT_time_spent_under_pressure] 2-tuple, exactly in that order, for each datapoint for regular TCP memory pressure data. OR The [enable_threshold, cutoff_threshold, max_threshold] 3-tuple, exactly in that order, for each datapoint for peak TCP memory pressure data. ' Optional;
    reg_and_peak_response_data.response_data
    [items].data[items]
    <number>
    reg_and_peak_response_data.response_data
    [items].<prop>
    <any> Optional;
    reg_and_peak_response_data.<prop> <any> Optional;

    Type: qos_criteria

    A list of fields to be defined in the request body when querying for the QoS data

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "qos_class_id": integer,
      "traffic_type": string,
      "device": device_id,
      <prop>: any
    }
    Property Name Type Description Notes
    qos_criteria <object> A list of fields to be defined in the request body when querying for the QoS data Required properties: [start_time, end_time, device];
    qos_criteria.start_time <timestamp> Seconds since January 1, 1970;
    qos_criteria.end_time <timestamp> Seconds since January 1, 1970;
    qos_criteria.qos_class_id <integer> Optional;
    qos_criteria.traffic_type <string> Determines whether the query is for outbound/inbound QoS traffic Optional; Default is outbound; Values: outbound, inbound;
    qos_criteria.device <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    qos_criteria.<prop> <any> Optional;

    Type: snapmirror_traffic_type_criteria

    A list of fields to be defined in the request body when querying for the regular/peak timeseries data for a single device

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "filer_id": integer,
      "traffic_type": reg_and_peak_traffic_type,
      "device": device_id,
      <prop>: any
    }
    Property Name Type Description Notes
    snapmirror_traffic_type_criteria <object> A list of fields to be defined in the request body when querying for the regular/peak timeseries data for a single device Required properties: [start_time, end_time, device];
    snapmirror_traffic_type_criteria.
    start_time
    <timestamp> Seconds since January 1, 1970;
    snapmirror_traffic_type_criteria.
    end_time
    <timestamp> Seconds since January 1, 1970;
    snapmirror_traffic_type_criteria.
    filer_id
    <integer> Optional;
    snapmirror_traffic_type_criteria.
    traffic_type
    <reg_and_peak_traffic_type> Determines whether the query is for regular/peak traffic. Default is regular; Values: regular, peak;
    snapmirror_traffic_type_criteria.device <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    snapmirror_traffic_type_criteria.<prop> <any> Optional;

    Type: granite_io_traffic_type

    Determines whether the query is for io/iops/io_time lun/initiator io traffic

  • JSON
  • string
    Property Name Type Description Notes
    granite_io_traffic_type <string> Determines whether the query is for io/iops/io_time lun/initiator io traffic Default is io; Values: io, iops, io_time;

    Type: lun_io_criteria

    A list of fields to be defined in the request body when querying for the SteelFusion LUN IO data

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "traffic_type": granite_io_traffic_type,
      "lun_subclass_id": integer,
      "device": device_id,
      <prop>: any
    }
    Property Name Type Description Notes
    lun_io_criteria <object> A list of fields to be defined in the request body when querying for the SteelFusion LUN IO data Required properties: [start_time, end_time, device];
    lun_io_criteria.start_time <timestamp> Seconds since January 1, 1970;
    lun_io_criteria.end_time <timestamp> Seconds since January 1, 1970;
    lun_io_criteria.traffic_type <granite_io_traffic_type> Determines whether the query is for io/iops/io_time lun/initiator io traffic Default is io; Values: io, iops, io_time;
    lun_io_criteria.lun_subclass_id <integer> Optional;
    lun_io_criteria.device <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    lun_io_criteria.<prop> <any> Optional;

    Type: lun_io_response_data

    ' This object holds the io/iops/io_time lun/initiator io data for a specified device. If no traffic type is specified, it defaults to io operations performed (io) lun/initiator io data. If no lun_subclass_id is specified, it defaults to lun_subclass_id 0. '

  • JSON
  • {
      "query_criteria": lun_io_criteria,
      "granularity": granularity,
      "response_data": [
        {
          "timestamp": timestamp,
          "data": [
            number
          ],
          <prop>: any
        }
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    lun_io_response_data <object> ' This object holds the io/iops/io_time lun/initiator io data for a specified device. If no traffic type is specified, it defaults to io operations performed (io) lun/initiator io data. If no lun_subclass_id is specified, it defaults to lun_subclass_id 0. '
    lun_io_response_data.query_criteria <lun_io_criteria> A list of fields to be defined in the request body when querying for the SteelFusion LUN IO data
    lun_io_response_data.granularity <granularity> Specifies the granularity between successive time-series data Values: 300, 3600;
    lun_io_response_data.response_data <array of <object>> Each element in this array is a {timestamp, lun/initiator_io_data} tuple containing the timestamp and lun/initiator IO data at that time Optional;
    lun_io_response_data.response_data
    [items]
    <object>
    lun_io_response_data.response_data
    [items].timestamp
    <timestamp> The epoch timestamp of this datapoint Optional; Seconds since January 1, 1970;
    lun_io_response_data.response_data
    [items].data
    <array of <number>> ' The [num_of_reads, num_of_writes] 2-tuple for each data point for io/iops/io_time lun/initiator io data. ' Optional;
    lun_io_response_data.response_data
    [items].data[items]
    <number>
    lun_io_response_data.response_data
    [items].<prop>
    <any> Optional;
    lun_io_response_data.<prop> <any> Optional;

    Type: initiator_io_criteria

    A list of fields to be defined in the request body when querying for the SteelFusion lun/initiator IO data

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "traffic_type": granite_io_traffic_type,
      "initiator_subclass_id": integer,
      "device": device_id,
      <prop>: any
    }
    Property Name Type Description Notes
    initiator_io_criteria <object> A list of fields to be defined in the request body when querying for the SteelFusion lun/initiator IO data Required properties: [start_time, end_time, device];
    initiator_io_criteria.start_time <timestamp> Seconds since January 1, 1970;
    initiator_io_criteria.end_time <timestamp> Seconds since January 1, 1970;
    initiator_io_criteria.traffic_type <granite_io_traffic_type> Determines whether the query is for io/iops/io_time lun/initiator io traffic Default is io; Values: io, iops, io_time;
    initiator_io_criteria.
    initiator_subclass_id
    <integer> Optional;
    initiator_io_criteria.device <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    initiator_io_criteria.<prop> <any> Optional;

    Type: network_io_criteria

    A list of fields to be defined in the request body when querying for the SteelFusion network IO data

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "traffic_type": string,
      "device": device_id,
      <prop>: any
    }
    Property Name Type Description Notes
    network_io_criteria <object> A list of fields to be defined in the request body when querying for the SteelFusion network IO data Required properties: [start_time, end_time, device];
    network_io_criteria.start_time <timestamp> Seconds since January 1, 1970;
    network_io_criteria.end_time <timestamp> Seconds since January 1, 1970;
    network_io_criteria.traffic_type <string> Determines whether the query is for throughput/prefetch network IO traffic Optional; Default is throughput; Values: throughput, prefetch;
    network_io_criteria.device <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    network_io_criteria.<prop> <any> Optional;

    Type: blockstore_criteria

    A list of fields to be defined in the request body when querying for the SteelFusion blockstore data

  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "traffic_type": string,
      "lun_subclass_id": integer,
      "device": device_id,
      <prop>: any
    }
    Property Name Type Description Notes
    blockstore_criteria <object> A list of fields to be defined in the request body when querying for the SteelFusion blockstore data Required properties: [start_time, end_time, device];
    blockstore_criteria.start_time <timestamp> Seconds since January 1, 1970;
    blockstore_criteria.end_time <timestamp> Seconds since January 1, 1970;
    blockstore_criteria.traffic_type <string> Determines whether the query is for hit_miss/uncmtd_first_classid/uncmtd_last_classid/commit_throughput/commit_delay blockstore traffic Optional; Default is commit_throughput; Values: hit_miss, uncmtd_first_classid, uncmtd_last_classid, commit_throughput, commit_delay;
    blockstore_criteria.lun_subclass_id <integer> Optional;
    blockstore_criteria.device <device_id> Case sensitive Device ID. Only alphanumeric permitted. Pattern: '^[a-zA-Z0-9]+$';
    blockstore_criteria.<prop> <any> Optional;

    Type: logging_level

    Severity levels for logs emitted by the service

  • JSON
  • string
    Property Name Type Description Notes
    logging_level <string> Severity levels for logs emitted by the service Values: crit, err, warning, notice, info, debug;