Returned result, Status codes, Message header – HP Intelligent Management Center Licenses User Manual

Page 281: Message body

Advertising
background image

Query parameters

Alarm event OID.

faultOid

String type, supporting multiple elements. Optional. No default value.

Alarm source type.

originalType

Integer type. Optional. No default value. For the valid values, see Query Alarm Sources.

The position where the first returned record is located in the whole returned result.

start

Integer type. Optional. The default value is 0. If a negative value is uploaded, the default value is
used.

The total number of returned records.

size

Integer type. Optional. The default value is 10. If a negative value is uploaded, the default value is
used.

The sequencing field of the returned result set.

orderBy

String type. Optional. The default value is id. Valid values include id, label, ip, mask, status, contact,
location, sysOid, and sysName.

Whether or not the result is sequenced in reverse order.

desc

Boolean type. Optional. The default value is false. The parameter is valid only when the orderBy
parameter is specified.

Only the number of records that meet the requirements is returned.

total

Boolean type. Optional. The default value is false. When the value is true, the start and size attributes
are invalid, the returned message body is empty, and the Total attribute of the message header
returns the number of records that meet the requirements.

Returned Result

Status codes

200 (OK): Success.

Message header

When the total parameter takes true, the Total attribute returns the total number of records that
meet the requirements. The message body is empty.

HTTP/1.1 200 OK
Total: 150

Message body

<list>
<alarm>
<id>3655</id>
<OID>1.3.6.1.4.1.2011.10.4.1.1.2.6.4</OID>
<originalType>3</originalType>
<originalTypeDesc>iMC</originalTypeDesc>
<deviceId>347</deviceId>
<deviceIp>10.153.88.34</deviceIp>
<deviceName>Quidway</deviceName>
...
<alarmDetail>http://imc_host:port/imcrs/fault/alarm/3655</alarmDetail>
</alarm>
...
<link rel="next" href="http://imc_host:port/imcrs/fault/alarm?start=10&size=10"/>
</list>

For meanings of the fields in the returned value, see

Query Alarm Information

.

Query Alarms

281

Advertising