INC Platform - Performance Management

Query Performance Views

Query performance views with certain criteria.

Interface URI

/perf/perfView/list

Access Method

HTTP
GET
Parameters
Query parameters
loginName User name.
String type. Required. No default value.
viewType Performance view type.
Integer type. Required. No default value. Valid values are 0 (folders), 1 (trend analysis), 2 (summary data), 3 (at a glance), and 4 (topN).

Return Values

Status codes
  • 200(OK): Success.
Message header
HTTP/1.1 200 OK
Message body
<list>
  <perfRsViewEntity>
    <viewId>1000001</viewId>
    <viewName>TopN</viewName>
    <viewType>4</viewType>
    <viewParentId>-1</viewParentId>
    <perfViewFormList>
      <formId>1</formId>
      <formName>CPU usage ratio topN</formName>
      <itemId>2</itemId>
    </perfViewFormList>
    ...
  </perfRsViewEntity>
</list>
Element description
perfItem subelements
viewId Performance view ID.
Long integer type.
viewName Performance view name.
String type.
viewType Performance view type.
Integer type.
viewParentId ID of the parent performance view.
Long integer type.
perfViewFormList.formId Performance data display form ID.
Integer type.
perfViewFormList.formName Performance data display form name.
String type.
perfViewFormList.itemId Performance index ID.
Integer type.

Example

Display performance views of the topN type with user name admin .

Request
GET http://host:8080/imcrs/perf/perfView/list?loginName=admin&viewType=4
accept: application/xml
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml
...
<list>
  <perfRsViewEntity>
    <viewId>1000001</viewId>
    <viewName>TopN</viewName>
    <viewType>4</viewType>
    <viewParentId>-1</viewParentId>
    <perfViewFormList>
      <formId>1</formId>
      <formName>CPU usage ratio topN</formName>
      <itemId>2</itemId>
    </perfViewFormList>
    <perfViewFormList>
      <formId>2</formId>
      <formName>Memory usage ratio topN</formName>
      <itemId>4</itemId>
    </perfViewFormList>
    <perfViewFormList>
      <formId>3</formId>
      <formName>Device response time topN</formName>
      <itemId>6</itemId>
    </perfViewFormList>
    <perfViewFormList>
      <formId>4</formId>
      <formName>Device unreachability percentage topN</formName>
      <itemId>8</itemId>
    </perfViewFormList>
    ...
  </perfRsViewEntity>
</list>