Query Network Zones

Query network zones in RAM.

Interface URI

/ram/zone

Access Method

HTTP

GET

Parameters

Query parameters
name	Network zone name. String type. This parameter supports wildcard characters. Optional. No default value.
start	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	Total number of returned records. Integer type. Optional. The default value is 10. If a negative value is uploaded, the value takes 0. If the uploaded value is bigger than 1000, the value takes 1000.
orderBy	Field by which the returned result set is sorted. String type. Optional. Valid values are id and name. The default value is id.
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 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.

Return Values

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

Message body

<list>
  <zone>
    <zoneId>1</zoneId>
    <name>zone1</name>
    <description/>
  </zone>
  ...
</list>

Example

Query all network zones.

Request

GET http://localhost:8080/imcrs/ram/zone?name=zone1
accept: application/xml
...
        

Response

HTTP/1.1 200 OK
Content-Type: application/xml
...

<list>
   <zone>
    	<zoneId>1</zoneId>
   	<name>zone1</name>
    	<description/>
   </zone>
  ...
</list>