Query links, Interface uri, Access method – HP Intelligent Management Center Licenses User Manual

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

Advertising
background image

Query Links

Query device links based on predefined criteria.

Interface URI

/plat/res/link

Access Method

HTTP

GET

Parameters

Query parameter

Topology ID, or custom view ID. See the API document in Query Custom Views.

topoId

Long integer type. Required. No default value.

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: 7

Message body

<list>
<deviceLink>
<id>80</id>
<type>0</type>
<leftSymbolId>1092</leftSymbolId>
<leftIfDesc>Ethernet1/0/2</leftIfDesc>
<rightSymbolId>1029</rightSymbolId>
<rightIfDesc>GigabitEthernet4/0/15</rightIfDesc>
<status>1</status>
<bandWidth>100000000</bandWidth>
</deviceLink>
...
</list>

For description on each field, see the API document in “

Query Link Information

.”

118

Network Resource Management

Advertising