NAS throughput by appliance
GET /cluster/servicesets/{ssid}/services/nas/parametrics/throughput/
reports/{freq}
These reports will provide average throughput metrics for the NAS 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 29 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 30 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
NAS parametrics 33
Error messages
Error messages are returned in the following cases:
• Invalid data: 400 Bad Request
• All other errors: Unexpected error – 500 Internal Error NAS throughput GET report details
Report details are returned from a GET call with the following sections:
• Properties
Table 31 NAS throughput report parameters
New in Version Description
Type Property
1.0 Average write throughput (at sample) in bytes per second
Long writeThroughput
1.0 Average read throughput (at sample) in bytes per second
Long readThroughput
1.0 Maximum number of concurrent open files (File Descriptors) in the given interval
Long openFDCount
1.0 UTC timestamp for the metric
Datetime timestamp
NAS all shares throughput reports
GET /cluster/servicesets/{ssid}/services/nas/parametrics/throughput/
reports/{freq}/shares
These reports return a list of URIs for which share metrics are available.
Table 32 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 33 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
All errors (returned by the subsystem): Unexpected error – 500 Internal Error
NAS all shares GET report details
Report details are returned from a GET call with the following properties:
Table 34 NAS all shares parametrics parameters
New in Version Description
Type Property
1.0 A unique ID for the shares
Integer shareId
1.0 A URI link to the metrics report
String report
NAS individual share reports
GET /cluster/servicesets/{ssid}/services/nas/parametrics/throughput/
reports/{freq}/shares/{shareId}
These reports will provide average throughput metrics for the specified NAS share. The reports will contain a collection of properties for each and every time slot for the given share, 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. Note that the reports will provide all the metric data on the requested shareId, including deleted shares.
Table 35 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 36 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
• All other errors: Unexpected error – 500 Internal Error NAS throughput GET report details
Report details are returned from a GET call with the following properties:
NAS parametrics 35
Table 37 NAS throughput report parameters
New in Version Description
Type Property
1.0 Average write throughput (at sample) in bytes per second
Long writeThroughput
1.0 Average read throughput (at sample) in bytes per second
Long readThroughput
1.0 Maximum number of concurrent open files (File Descriptors) in the given interval
Long openFDCount
1.0 UTC timestamp for the metric
Datetime timestamp