Catalyst throughput by appliance
GET /cluster/servicesets/{ssid}/services/cat/parametrics/throughput/
reports/{freq}
These reports will provide summation throughput and maximum session count metrics for the Catalyst service. The reports will contain a collection of properties for each and every time slot, defined by the frequency, within a given time period, defined by either the start and end times, or by the maximum logging period for the given frequency.
Table 55 Valid report frequency {freq} parameters
New in Version Description
Frequency
1.0 Reported metrics shall be at 5 second resolution for up to a period of 1 hour
5sec
1.0 Reported metrics shall be at 1 minute resolution for up to a period of 60 days min
1.0 Reported metrics shall be at 1 hour resolution for up to a period of 1 year
hour
A start time must be provided as a query string parameter. Additionally, the client may define the end time as a query string parameter.
Table 56 Start and end time parameters
New in Version Description
Type Parameter
1.0 This parameter is mandatory.
Defines the start time for the reported metrics. Metrics before this start time will not be included in the report.
Datetime (string) startTime
1.0 This parameter is optional.
Defines the end time for the reported metrics. Metrics after this end time will not be included in the report.
Datetime (string) endTime
Error messages are returned in the following cases:
• Invalid data: 400 Bad Request
• endTimeearlier than startTime: 400 Bad Request
• All other errors: Unexpected error – 500 Internal Error Catalyst throughput GET report details
Report details are returned from a GET call with the following properties:
Catalyst parametrics 41
Table 57 Catalyst throughput by appliance report parameters
New in Version Description
Type Property
1.0 Average data job receive bandwidth utilization in bytes per second, i.e., Long
dataJobRxBandwidth
actual data job (deduplicated content plus meta data) rate
1.0 Average data job receive throughput in bytes per second, i.e., apparent data job receive rate
Long dataJobRxThroughput
1.0 Average data job transmit bandwidth utilization in bytes per second, i.e., Long
dataJobTxBandwidth
actual data job (deduplicated content plus meta data) transmit rate
1.0 Average data job transmit throughput in bytes per second, i.e., apparent data job transmit rate
Long dataJobTxThroughput
1.0 Maximum data job session count
Integer dataJobSessionCount
1.0 Average copy job receive bandwidth in bytes per second, i.e., actual copy job Long
copyJobRxBandwidth
(deduplicated content plus meta data) receive rate
1.0 Average copy job receive throughput in bytes per second, i.e., apparent copy job receive rate
Long copyJobRxThroughput
1.0 Average copy job transmit bandwidth utilization in bytes per second, i.e., Long
copyJobTxBandwidth
actual copy job (deduplicated content plus meta data) transmit rate
1.0 Average copy job transmit throughput in bytes per second, i.e., apparent copy job transmit rate
Long copyJobTxThroughput
1.0 Maximum inbound copy job session count
Integer copyJobInSessionCount
1.0 Maximum outbound copy job session count
Integer copyJobOutSessionCount
1.0 UTC time for the metric
Datetime (string) timestamp
Catalyst all stores throughput reports GET
/cluster/servicesets/{ssid}/services/cat/parametrics/throughput/reports/
{freq}/stores
These reports return a list of URIs for which store metrics are available.
Table 58 Valid report frequency {freq} parameters
New in Version Description
Frequency
1.0 Reported metrics shall be at 5 second
resolution for up to a period of 1 hour 5sec
1.0 Reported metrics shall be at 1 minute
resolution for up to a period of 60 days min
1.0 Reported metrics shall be at 1 hour
resolution for up to a period of 1 year hour
All errors return the following message:
Unexpected error – 500 Internal Error Catalyst all stores GET report details
Report details are returned from a GET call with the following properties:
Table 59 Catalyst all stores parametrics parameters
New in Version Description
Type Property
1.0 A unique ID for the store Integer
storeId
1.0 A URI link to the metrics report
String report
Catalyst individual store throughput reports
GET /cluster/servicesets/{ssid}/services/cat/parametrics/throughput/
reports/{freq}/stores/{storeId}
These reports will provide user data stored and size on disk metrics for the specified Catalyst store id. The reports will contain a collection of properties for each and every time slot, defined by the frequency, within a given time period, defined by either the start and end times, or by the maximum logging period for the given frequency.
Table 60 Valid report frequency {freq} parameters
New in Version Description
Frequency
1.0 Reported metrics shall be at 5 second
resolution for up to a period of 1 hour 5sec
1.0 Reported metrics shall be at 1 minute
resolution for up to a period of 60 days min
1.0 Reported metrics shall be at 1 hour
resolution for up to a period of 1 year hour
A start time must be provided as a query string parameter. Additionally, the client may define the end time as a query string parameter.
Catalyst parametrics 43
Table 61 Start and end time parameters
New in Version Description
Type Parameter
1.0 This parameter is
mandatory.
Defines the start time for the reported metrics.
Datetime (string) startTime
Metrics before this start time will not be included in the report.
1.0 This parameter is optional.
Defines the end time for the reported metrics. Metrics Datetime (string)
endTime
after this end time will not be included in the report.
Error messages are returned in the following cases:
• Invalid data: 400 Bad Request
• endTimeearlier than startTime: 400 bad request
• All other errors (returned by the subsystem): Unexpected error – 500 Internal Error
Catalyst throughput GET report details
Report details are returned from a GET call with the following properties:
Table 62 Catalyst individual store throughput report parameters
New in Version Description
Type Property
1.0 Average data job receive bandwidth utilization in Long
dataJobRxBandwidth
bytes per second, i.e., actual data job
(deduplicated content plus meta data) rate
1.0 Average data job receive throughput in bytes per Long
dataJobRxThroughput
second, i.e., apparent data job receive rate
1.0 Average data job transmit bandwidth utilization in Long
dataJobTxBandwidth
bytes per second, i.e., actual data job
(deduplicated content plus meta data) transmit rate
1.0 Average data job transmit throughput in bytes per Long
dataJobTxThroughput
second, i.e., apparent data job transmit rate
1.0 Maximum data job session count
Integer dataJobSessionCount
1.0 Average copy job receive bandwidth in bytes per Long
copyJobRxBandwidth
second, i.e., actual copy job (deduplicated content plus meta data) receive rate
Table 62 Catalyst individual store throughput report parameters (continued)
New in Version Description
Type Property
1.0 Average copy job receive throughput in bytes per Long
copyJobRxThroughput
second, i.e., apparent copy job receive rate
1.0 Average copy job transmit bandwidth utilization in Long
copyJobTxBandwidth
bytes per second, i.e., actual copy job
(deduplicated content plus meta data) transmit rate
1.0 Average copy job transmit throughput in bytes per Long
copyJobTxThroughput
second, i.e., apparent copy job transmit rate
1.0 Maximum inbound copy job session count
Integer copyJobInSessionCount
1.0 Maximum outbound copy job session count Integer
copyJobOutSessionCount
1.0 UTC time for the metric
Datetime (string) timestamp