INC Platform - Resource Manager

Query IP Addresses

Query the assigned IP addresses with the specified IP segment ID.

Interface URI

/res/access/assignedIpScope/ip

Access Method

HTTP
GET
Query parameters
Query parameters
ipScopeId ID of the IP address segment.
Long integer type. Required. No default value.
total Only the number of records that meet the requirements is returned.
Boolean type. Optional. The default value is false. When the value is true, the returned message body is empty, and the Total attribute of the message header returns the number of records that meet the requirements.
orderBy The sequencing field of the returned result set.
String type. Optional. The default value is ip. Valid values include ip and name.
desc Whether or not the result is sequenced in reverse order.
Boolean type. Optional. The default value is false. The parameter is valid only when the orderBy parameter is specified.
start The position where the first returned record is located in the whole returned result.
Integer type. Optional. The default value is 0. If a negative value is uploaded, the default value is used.
size The total number of returned records.
Integer type. Optional. The default value is 10. If a negative value is uploaded, the default value is used.
ip IP address
String type. Optional. No default value.
name Owner.
String type. Optional. No default value.
description Description.
String type. Optional. No default value.

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: 3
Message body
<list>
    <assignedIpInfo>
    <id>4</id>
    <ip>10.153.89.12</ip>
    <parentId>2</parentId>
  </assignedIpInfo>
  <assignedIpInfo>
    <id>5</id>
    <ip>10.153.89.2</ip>
    <parentId>3</parentId>
  </assignedIpInfo>
  ...
</list>
Elements
assignedIpInfo sub-elements
id ID of the IP address.
Long integer type.
ip IP address.
String type.
name Owner.
String type.
description Description.
String type.
parentId ID of the IP address segment.
Long integer type.

Example

Query and list the assigned IP addresses that belong to the IP segment with ID 1.

Request
GET http://localhost:8080/imcrs/res/access/assignedIpScope/ip?ipScopeId=1
accept: application/xml
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml
...
 
<list>
  <assignedIpInfo>
    <id>4</id>
    <ip>10.153.89.12</ip>
    <parentId>2</parentId>
  </assignedIpInfo>
  <assignedIpInfo>
    <id>5</id>
    <ip>10.153.89.2</ip>
    <parentId>3</parentId>
  </assignedIpInfo>
  ...
</list>