Query device interface information, Interface uri, Access method – HP Intelligent Management Center Licenses User Manual

Page 131: Returned result, Interface uri access method returned result

Advertising
background image

Query Device Interface Information

Query device interface information based on predefined criteria.

Interface URI

/plat/res/device/{deviceId}/interface

Access Method

HTTP

GET

Path parameter

Path parameter

Device ID.

deviceId

Long integer type. Required. No default value.

Query parameters

Query parameter

Location of the first returned record in the query result.

start

Integer type. Optional. The default value is 0. If the input parameter is smaller than 0, the default
value 0 is used.

Total returned records.

size

Integer type. Optional. The default value is 10. If the input parameter is smaller than 0, the default
value 10 is used.

Sort records in descending order.

desc

Boolean type. Optional. The default value is false. Interface index is used to sort interfaces by default.

Only records that match the sort criteria are 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 Message Header field gives the records
that match the sort criteria.

Returned Result

Status codes

200 (OK): Success.

Message header

If the total parameter is true, the Total field gives all the records that match the sort criteria. The
message body is empty.

HTTP/1.1 200 OK
Total: 47

Query Device Interface Information

131

Advertising