XtremIO REST API Performance Object

I am working with the XtremIO REST API and some documentation is difficult to follow. I am working from the 9/25 Rev. 05 P/N: 302-002-049

I have the following questions on the performance object. Page. 41

What are all valid values for entity input parameter?
What are all valid values for aggregation-type input parameter?
What are all valid values for time-frame input parameter?
What are all valid values for vertical input parameter?
What are all valid values for export-to-file input parameter and how is this used?

Also, on the performance object I have found the following issues in the documentation.

The prop input parameter is not listed in the table of input parameters, but is shown in the example request and does seem to work.
The syntax for the example request shows the use of the from-time parameter. This example shows a space and I needed to use a %20 for proper URL encoding to make this work properly.

Any assistance on the questions above is appreciated.

Thanks,

Dave

Responses(2)

A

Anonymous

5 Practitioner

•

274.2K Posts

0

October 26th, 2015 23:00

Hi,

We are currently enhancing the documentation of the Performance call in the REST API guide.

Here are the values of the parameters listed above:

Entity (the object type): Cluster , Initiator, SSD, Tag, TargetGroup, XEnv, DataProtectionGroup , InitiatorGroup , SnapshotGroup , Target , Volume, Xms

Granularity (the time granularity of the output data): auto ,one_day, one_hour, one_minute, raw, ten_minutes

Time-frame (the time frame of the request): custom_time , last_day , last_hour , last_week , last_year , real_time

Aggregation-type (aggregation function of the request - by default avg is used): avg, max, min

Please disregard the Vertical parameter.

The prop parameter is not specific for the Performance API call. It is a general capability supported by all GET API calls to define a partial list of output parameters. Please refer to section "Displaying Full or Partial Lists" of the guide.

If you are making direct protocol calls, you must specifically encode all reserved characters. The examples in the guide make use of a client library that automatically encodes the reserved characters of the URL. We will clarify this in the guide.

If you have specific questions, please contact me directly.

Regards, Iris

dmuegge

17 Posts

0

October 30th, 2015 05:00

Iris,

Thank you so much for your help and I appreciate the reply. The documentation is getting more clear with every update can't wait for the next one!

Dave

View All

No Events found!