INC Platform - VCM Management

Query Details About All Networks

Query and list information about all networks, including general network information, VSI types and VSI type versions on each network, VSI type parameters, and authorized users.

Interface URI

/caas/vsiTypeGroup/allVsiTypeInfo

Access Method

HTTP
GET

Returned Results

Status code
  • 200 (OK): Success.
Message body
<?xml version="1.0" encoding="UTF-8"?>
<list>
  <vsiTypeGroup>
    <id>51</id>
    <name>adf</name>
    <vlanId>11</vlanId>
    <vsiType>
      <id>61</id>
      <name>access</name>
      <description/>
      <createTime>2015-2-16 10:07:00</createTime>
      <vsiTypeVersion>
        <id>62</id>
        <versionNo>1</versionNo>
        <name>access (V1)</name>
        <deployTime>2015-2-16 10:07:00</deployTime>
        <connectNo>0</connectNo>
        <vid>61</vid>
        <state>0</state>
        <link href="http://localhost:8080/imcrs/caas/vsiType/version/62" op="GET" rel="self"/>
      </vsiTypeVersion>
       <vsiTypeServiceUnitAndParam>
        <serviceUnit>
          <name>macAcl</name>
          <description>Restricts clients that can access the VM to ensure security.</description>
          <link href="http://localhost:8080/imcrs/caas/vsiType/serviceUnitParams/>macAcl" op="GET" rel="self"/>
        </serviceUnit>
        ...

      <paramList>
        <param>
          <key>USER-ACLID</key>
          <value>109</value>
        </param>
        ...

      </paramList>
      </vsiTypeServiceUnitAndParam>
      <link href="http://localhost:8080/imcrs/caas/vsiType/61" op="GET" rel="self"/>
    </vsiType>
   ...

   <connectNum>99999</connectNum>
    <description/>
    <operator>
      <id>1</id>
      <name>admin</name>
      <desc>Super administrator who has all privileges.</desc>
    </operator>
    ...

    <link href="http://localhost:8080/imcrs/caas/vsiTypeGroup/51" op="GET" rel="self"/>
  </vsiTypeGroup>
  ...
</list>
Element description
vsiTypeGroup subelements
id Network ID, which uniquely identifies a network.
Long integer type.
name Network name.
String type.
VLAN ID VLAN ID of the network.
Integer type.
connectNum Maximum number of connections allowed by the network.
Integer type.
description Network description.
String type.
vsiType VSI types on the network.
List type.
operator Administrators who can manage VSI types on the network.
List type.
link Link to network details.
Link type.
vsiType subelements
id VSI type ID, which uniquely identifies a VSI type.
Long integer type.
name Name of the VSI type.
String type.
description Description of the VSI type.
String type.
createTime Time when the VSI type was created.
String type. Format: yyyy-MM-dd HH:mm:ss.
vsiTypeVersion Versions released for the VSI type.
List type.
vsiTypeServiceUnitAndParam Service units and parameters in the VSI type.
Entity (vsiTypeServiceUnitAndParam) type.
link Link to detailed information about the VSI type.
Link type.
vsiTypeVersion subelements
id ID of the VSI type version, which uniquely identifies a VSI type version.
Long integer type.
versionNo Number of the VSI type version.
Long integer type.
name Name of the VSI type version.
String type.
description Description of the VSI type version.
String type.
deployTime Time when the VSI type version was released.
String type. Format: yyyy-MM-dd HH:mm:ss.
connectNo Number of connections that use the VSI type version.
Integer type.
vid ID of the VSI type to which the VSI type version belongs.
Long integer type.
state State of the VSI type version. 0: Unbound. 1: Bound.
Integer type.
param Service unit parameters in the VSI type version.
List type.
link Link to detailed information about the VSI type version.
Link type.
operator subelements
id Operator ID, which uniquely identifies an operator.
Long integer type.
name Operator name.
String type.
desc Operator description.
String type.
vsiTypeServiceUnitAndParam subelements
serviceUnit Set of service units.
List type.
param Service unit parameters.
List type.
serviceUnit subelements
name Name of the service unit.
String type.
description Description of the service unit.
String type.
link Link to parameter settings of the service unit.
Link type.
param subelements
key Parameter name.
String type.
value Parameter value.
String type.

Example

Query detailed information about all networks.

Request
GET http://host:8080/imcrs/caas/vsiTypeGroup/allVsiTypeInfo
accept: application/xml
...
Response
<?xml version="1.0" encoding="UTF-8"?>
<list>
  <vsiTypeGroup>
    <id>51</id>
    <name>adf</name>
    <vlanId>11</vlanId>
    <vsiType>
      <id>61</id>
      <name>access</name>
      <description/>
      <createTime>2015-2-16 10:07:00</createTime>
      <vsiTypeVersion>
        <id>62</id>
        <versionNo>1</versionNo>
        <name>access(V1)</name>
        <deployTime>2015-2-16 10:07:00</deployTime>
        <connectNo>0</connectNo>
        <vid>61</vid>
        <state>0</state>
        <link href="http://localhost:8080/imcrs/caas/vsiType/version/62" op="GET" rel="self"/>
      </vsiTypeVersion>
       <vsiTypeServiceUnitAndParam>
        <serviceUnit>
          <name>macAcl</name>
          <description>Restricts clients that can access the VM to ensure security.</description>
          <link href="http://localhost:8080/imcrs/caas/vsiType/serviceUnitParams/>macAcl" op="GET" rel="self"/>
        </serviceUnit>
        ...

      <paramList>
        <param>
          <key>USER-ACLID</key>
          <value>109</value>
        </param>
        ...

      </paramList>
      </vsiTypeServiceUnitAndParam>
      <link href="http://localhost:8080/imcrs/caas/vsiType/61" op="GET" rel="self"/>
    </vsiType>
   ...

   <connectNum>99999</connectNum>
    <description/>
    <operator>
      <id>1</id>
      <name>admin</name>
      <desc>Super administrator who has all privileges.</desc>
    </operator>
    ...

    <link href="http://localhost:8080/imcrs/caas/vsiTypeGroup/51" op="GET" rel="self"/>
  </vsiTypeGroup>
  ...
</list>