Inventory

Flow Collector Inventory

Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		3.6.0
name	The name. For more information, see Resource Property.		3.6.0
description	The description. For more information, see Resource Property.	Yes	3.6.0
flowMeterUuid			3.6.0
port	The UDP port of the flow collector.		3.6.0
server	The IP address of the flow collector.		3.6.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.6.0
createDate	The creation date. For more information, see Resource Property.		3.6.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0

Sample

{
  "inventories": [
    {
      "uuid": "e231c750a95b301cb4b6de429fa11bbc",
      "server": "192.168.48.12",
      "port": 2055.0,
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

Flow Meter Inventory

Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		3.6.0
name	The name. For more information, see Resource Property.		3.6.0
description	The description. For more information, see Resource Property.	Yes	3.6.0
expireInterval	The expiration interval of the flow.		3.6.0
sample	The sample rate of the flow meter.		3.6.0
type	The type of the flow meter protocol.		3.6.0
version	The version of the flow meter protocol.		3.6.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.6.0
createDate	The creation date. For more information, see Resource Property.		3.6.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0

Sample

{
  "inventories": [
    {
      "uuid": "4ba598ab40a1321798fb957a9eddb77d",
      "type": "NetFlow",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

vRouter Flow Meter Network Inventory

Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		3.6.0
flowMeterUuid			3.6.0
l3NetworkUuid	The L3 network UUID.		3.6.0
vRouterUuid			3.6.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.6.0
createDate	The creation date. For more information, see Resource Property.		3.6.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0

Sample

{
  "inventories": [
    {
      "uuid": "62413232b13c3ff496876495906d9254",
      "vRouterUuid": "276b37d53794342b8b93f11ffdab0b24",
      "flowMeterUuid": "606c59dee3e0371da1b6a829c249bb79",
      "l3NetworkUuid": "7d744eec67cb385cb8f55e84056a3a50",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

Port Mirror Inventory

Name	Description	Optional	Starting Version
description	The description. For more information, see Resource Property.	Yes	3.7.0
mirrorNetworkUuid	The UUID of the mirror network resource.		3.7.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.7.0
createDate	The creation date. For more information, see Resource Property.		3.7.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.7.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.7.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.7.0

Sample

{
    "inventories": [],
    "success": true
}

Port Mirror Session Inventory

Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		3.7.0
name	The name. For more information, see Resource Property.		3.7.0
description	The description. For more information, see Resource Property.	Yes	3.7.0
dstEndPoint	The destination endpoint of the mirror session.		3.7.0
internalId			3.7.0
portMirrorUuid	The port mirror UUID.		3.7.0
srcEndPoint	The source endpoint of the mirror session.		3.7.0
status			3.7.0
type			3.7.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.7.0
createDate	The creation date. For more information, see Resource Property.		3.7.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.7.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.7.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.7.0

Sample

{
    "inventories": [],
    "success": true
}

Port Mirror Network Used IP Inventory

Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		3.7.0
description	The description. For more information, see Resource Property.	Yes	3.7.0
clusterUuid	The cluster UUID.		3.7.0
hostUuid	The host UUID.		3.7.0
l3NetworkUuid	The L3 network UUID.		3.7.0
usedIpInventory			3.7.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.7.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.7.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.7.0

Sample

{
    "inventories": [],
    "success": true
}

Network Service Provider Inventory

Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		2.2
name	The name. For more information, see Resource Property.		2.2
description	The description. For more information, see Resource Property.	Yes	2.2
attachedL2NetworkUuids	The UUIDs of attached L2 networks.		2.2
networkServiceTypes	The network service types.		2.2
type			2.2
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	2.2
createDate	The creation date. For more information, see Resource Property.		2.2
lastOpDate	The last operation date. For more information, see Resource Property.		2.2
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.2
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.2

Sample

{
    "inventories": [
        {
            "attachedL2NetworkUuids": [
                "06787a08456b458db2af527c23ab110c",
                "8baa26aacfb740adb1d7709a369179ef",
                "fd91d394591e4b79a2979c34abac464d",
                "32d20dc18ef74adfb033fdfbce674bbf",
                "00e1a1bea98c46d59c4c9768357d4f62"
            ],
            "createDate": "Jun 20, 2018 10:45:45 AM",
            "description": "zstack vrouter network service provider",
            "lastOpDate": "Jun 20, 2018 10:45:45 AM",
            "name": "vrouter",
            "networkServiceTypes": [
                "IPsec",
                "VRouterRoute",
                "CentralizedDNS",
                "VipQos",
                "DNS",
                "SNAT",
                "LoadBalancer",
                "PortForwarding",
                "Eip",
                "DHCP"
            ],
            "type": "vrouter", //VPC vRouter network service module
            "uuid": "1b0e0976950b4dd1a57ec93f31957b53"
        },
        {
            "attachedL2NetworkUuids": [
                "aceca791929e472890aff8f2dbf5114b",
                "06787a08456b458db2af527c23ab110c",
                "9344c9a846564ae285a8150a317c4596",
                "ba8e717610854cfab8e6a98affb1e880",
                "21ba175a6b8c4e2e9e3b0efb103c3843",
                "40f4ad9d69954d9cb3bf5dc95c67ed83",
                "8baa26aacfb740adb1d7709a369179ef",
                "fd91d394591e4b79a2979c34abac464d",
                "e6f80f6348f146a3b0d4682be87c8bab",
                "32d20dc18ef74adfb033fdfbce674bbf",
                "00e1a1bea98c46d59c4c9768357d4f62",
                "aeac2cd1a74d4274b94bda5cc1b7689e"
            ],
            "createDate": "Jun 20, 2018 10:45:45 AM",
            "description": "Flat Network Service Provider",
            "lastOpDate": "Jun 20, 2018 10:45:45 AM",
            "name": "Flat Network Service Provider",
            "networkServiceTypes": [
                "VipQos",
                "DNS",
                "HostRoute",
                "Userdata",
                "Eip",
                "DHCP"
            ],
            "type": "Flat", //Flat network service module
            "uuid": "5716a451ebe040e5b70822df8e4423d7"
        },
        {
            "attachedL2NetworkUuids": [
                "06787a08456b458db2af527c23ab110c",
                "8baa26aacfb740adb1d7709a369179ef",
                "fd91d394591e4b79a2979c34abac464d",
                "32d20dc18ef74adfb033fdfbce674bbf",
                "00e1a1bea98c46d59c4c9768357d4f62"
            ],
            "createDate": "Jun 20, 2018 10:45:45 AM",
            "description": "zstack security group network service provider",
            "lastOpDate": "Jun 20, 2018 10:45:45 AM",
            "name": "SecurityGroup",
            "networkServiceTypes": [
                "SecurityGroup"
            ],
            "type": "SecurityGroup",  //Security group network service module
            "uuid": "5fad7c177d6041be9b76d5c55e742865"
        },
        {
            "attachedL2NetworkUuids": [
                "06787a08456b458db2af527c23ab110c",
                "8baa26aacfb740adb1d7709a369179ef",
                "fd91d394591e4b79a2979c34abac464d",
                "32d20dc18ef74adfb033fdfbce674bbf",
                "00e1a1bea98c46d59c4c9768357d4f62"
            ],
            "createDate": "Jun 20, 2018 10:45:45 AM",
            "description": "cloud virtual router network service provider",
            "lastOpDate": "Jun 20, 2018 10:45:45 AM",
            "name": "VirtualRouter",
            "networkServiceTypes": [
                "DNS",
                "SNAT",
                "LoadBalancer",
                "PortForwarding",
                "Eip",
                "DHCP"
            ],
            "type": "VirtualRouter", //Virtual router network service module, not recommended
            "uuid": "9c4e250086ef43a1839f0c71c42c5d47"
        }
    ],
    "success": true
}

VPC Firewall Inventory

Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		3.6.0
name	The name. For more information, see Resource Property.		3.6.0
description	The description. For more information, see Resource Property.		3.6.0
refs	The reference between the VPC firewall rule set and the network.		3.6.0
rulesets	The VPC firewall rule set.		3.6.0
createDate	The creation date. For more information, see Resource Property.		3.6.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.6.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0

Sample

{
  "inventories": [
    {
      "name": "name",
      "ruleSets": [
        {
          "name": "name",
          "vpcFirewallUuid": "76cbd34de351334bbd0f51ee0653d0ab",
          "actionType": "drop",
          "description": "example-des",
          "enableDefaultLog": false,
          "isDefault": false
        }
      ],
      "refs": [
        {
          "id": 1.0,
          "ruleSetUuid": "530b17414c29330db2d788c227c50134",
          "l3Uuid": "01a959eec095396eaed841c886219eec",
          "packetsForwardType": "in",
          "createDate": "Nov 14, 2017 10:20:57 PM",
          "lastOpDate": "Nov 14, 2017 10:20:57 PM"
        }
      ],
      "description": "example-des"
    }
  ]
}

Firewall Rule Set Inventory

Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			3.6.0
name	The name. For more information, see Resource Property.			3.6.0
description	The description. For more information, see Resource Property.			3.6.0
actionType	The action type.		drop reject accept	3.6.0
isDefault	The default value.			3.6.0
vpcFirewallUuid				3.6.0
createDate	The creation date. For more information, see Resource Property.			3.6.0
lastOpDate	The last operation date. For more information, see Resource Property.			3.6.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes		3.6.0
userTags	The user tags. For more information, see CreateUserTag	Yes		3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		3.6.0

Sample

{
  "inventories": [
    {
      "name": "name",
      "vpcFirewallUuid": "c4a963f2391f3d7195032ed37bad0b57",
      "actionType": "drop",
      "description": "example-des",
      "enableDefaultLog": false,
      "isDefault": false
    }
  ]
}

Firewall Rule Set and L3 Network Reference Inventory

Name	Description	Optional	Starting Version
id			3.6.0
l3NetworkUuid	The L3 network UUID.		3.6.0
packetsForwardType			3.6.0
ruleSetUuid	The rule set UUID.		3.6.0
vpcFirewallUuid	The firewall UUID.		3.6.0
createDate	The creation date. For more information, see Resource Property.		3.6.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.6.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.6.0
userTags	The user tags. For more information, see CreateUserTag	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0

Sample

{
  "inventories": [
    {
      "id": 1.0,
      "ruleSetUuid": "f4575926f7a13c82a0d610dfac995ffa",
      "l3Uuid": "85044a1e0ccb3c859c0b024e967fb191",
      "packetsForwardType": "in",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

Firewall IP Set Template Inventory

Name	Description	Optional	Starting Version
name	The template name.		4.0.0
sourceValue		Yes	4.0.0
destValue		Yes	4.0.0
type			4.0.0
accountUuid	The account UUID.	Yes	4.0.0
tagUuids	The tag UUIDs.	Yes	4.0.0
userTags	The user tags. For more information, see CreateUserTag	Yes	4.0.0
systemTags	The system tags. For more information, see CreateSystemTag	Yes	4.0.0
timeout		Yes

Sample

{
  "inventories": [
    {
      "name": "ipset-template",
      "sourceValue": "192.168.1.2",
      "destValue": "192.168.1.1,10.0.0.1/24",
      "type": "ip"
    }
  ]
}

Firewall Rule Inventory

Name	Description	Optional	Starting Version
name	The UUID. For more information, see Resource Property.		3.6.0
description	The description. For more information, see Resource Property.	Yes	3.6.0
action			3.6.0
allowStates			3.6.0
destIp			3.6.0
destPort			3.6.0
icmpTypeName			3.6.0
isDefault			3.6.0
protocol			3.6.0
ruleNumber			3.6.0
ruleSetName			3.6.0
ruleSetUuid			3.6.0
sourceIp			3.6.0
sourcePort			3.6.0
state			3.6.0
tcpFlag			3.6.0
vpcFirewallUuid			3.6.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.6.0
createDate	The creation date. For more information, see Resource Property.		3.6.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	4.0.0

Sample

{
  "inventories": [
    {
      "action": "accept",
      "protocol": "TCP",
      "destPort": "22",
      "sourcePort": "22",
      "sourceIp": "192.168.1.2",
      "destIp": "192.168.1.1",
      "allowStates": "invalid,new",
      "tcpFlag": "SYN",
      "icmpTypeName": "echo-reply",
      "ruleNumber": 1001.0,
      "enableLog": false,
      "state": "disable",
      "isDefault": false,
      "description": "example rule des"
    }
  ]
}

VPC Firewall and vRouter Reference Inventory

Name	Description	Optional	Starting Version
vpcFirewallUuid	The firewall UUID.		3.6.0
id			3.6.0
vRouterUuid	The vRouter UUID.		3.6.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.6.0
createDate	The creation date. For more information, see Resource Property.		3.6.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0

Sample

{
  "inventories": [
    {
      "id": 1.0,
      "vpcFirewallUuid": "cd7ab20e4768316c86230f2d982ae5a5",
      "vRouterUuid": "7013faeb3b4736d1800749b1e910a845",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

Security Group Inventory

Properties

Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			0.6
name	The name. For more information, see Resource Property.			0.6
description	The description. For more information, see Resource Property.	Yes		0.6
state	The state. For more information, see Resource Property.		Enabled Disabled	0.6
rules	The rules. For more information, see Security Group Rule Inventory.			0.6
attachedL3NetworkUuids	The UUIDs of the L3 Network to which the security group is attached.			0.6
createDate	The creation date. For more information, see Resource Property.			0.6
lastOpDate	The last operation date. For more information, see Resource Property.			0.6

Sample

 {
    "attachedL3NetworkUuids": [
        "0b48770e593e400c8f54e71fd4e7f514"
    ],
    "createDate": "Nov 16, 2015 1:02:22 AM",
    "lastOpDate": "Nov 16, 2015 1:02:22 AM",
    "name": "sg-in",
    "rules": [
        {
            "allowedCidr": "0.0.0.0/0",
            "createDate": "April 29, 2015 9:57:10 PM",
            "state": "Enabled",
            "endPort": 22,
            "lastOpDate": "Nov 29, 2015 9:57:10 PM",
            "protocol": "TCP",
            "securityGroupUuid": "9e0a72fe64814900baa22f78a1b9d235",
            "startPort": 22,
            "type": "Ingress",
            "uuid": "a338d11be18d4e288223597682964dc8"
        }
    ],
    "state": "Enabled",
    "uuid": "9e0a72fe64814900baa22f78a1b9d235"
}

Default Security Group Policy

For an empty security group, we have default polices for inbound traffics and outbound traffics.
For inbound traffics, the default policy is to deny, which means that all inbound traffics traveling to the NICs in this empty security group will be blocked.
For outbound traffics, the default policy is to allow, which means that all outbound traffics coming from the NICs in this empty security group will be allowed.

To change default policies, you can change the actions for Ingress.defaultPolicy and Egress.defaultPolicy in Global Setting.

Security Group Rule Inventory

Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			0.6
securityGroupUuid	The UUID of the parent security group.			0.6
remoteSecurityGroupUuid	The source security group, which indicates that only the VM instances specified in the security group are allowed.	Yes		0.6
type	The type. For more information, see Traffic Type.		Ingress Egress	0.6
protocol	The traffic protocol type.		TCP UDP ICMP	0.6
startPort	If the protocol is TCP or UDP, this parameter is the start port of the port range. If the protocol is ICMP, this parameter is ICMP type.		For TCP/UDP: 0 - 65535. For ICMP: use '-1' to represent all types. For more information, see ICMP type and code.	0.6
endPort	If the protocol is TCP/UDP, this parameter is the end port of the port range. If the protocol is ICMP, this parameter is ICMP type.		For TCP/UDP: 0 - 65535. For ICMP: use '-1' to represent all types. For more information, see ICMP type and code.	0.6
allowedCidr	The allowed CIDR. For more information, see Allowed CIDR.			0.6
state	The rule state, which is not implemented in the current version.		Enabled Disabled	0.6
createDate	The creation date. For more information, see Resource Property.			0.6
lastOpDate	The last operation date. For more information, see Resource Property.			0.6

Sample

{
     "allowedCidr": "0.0.0.0/0",
     "state": "Enabled",
     "startPort": 22,
     "endPort": 22,
     "protocol": "TCP",
     "type": "Ingress",
     "createDate": "Nov 29, 2015 9:57:10 PM",
     "lastOpDate": "Nov 29, 2015 9:57:10 PM",
     "uuid": "a338d11be18d4e288223597682964dc8"
     "securityGroupUuid": "9e0a72fe64814900baa22f78a1b9d235"
}

Traffic Type

Traffics have two types.

Ingress:
Inbound traffics that access a VM NIC.
Egress:
Outbound traffics that leave from a VM NIC.

Allowed CIDR

Allowed CIDR has different meanings according to different traffic types. The format of an allowed CIDR is as follows:

ipv4_address/network_prefix
For example: 12.12.12.12/24

If the traffic type is Ingress, the allowed CIDR is a source CIDR that is allowed to access VM NICs. The following is an example of an inbound rule:

startPort: 22
endPort: 22
protocol: TCP
type: Ingress
allowedCidr: 12.12.12.12/32

The example above indicates that only TCP traffics from the IP address (12.12.12.12) are allowed to access port 22.

If the traffic type is Egress, the allowed CIDR is a destination CIDR that is allowed to leave VM NICs. The following is an example of an outbound rule:

startPort: 22
endPort: 22
protocol: TCP
type: Egress
allowedCidr: 12.12.12.12/32

The example above indicates that only TCP traffics to port 22 of the IP address (12.12.12.12) are allowed to leave.

Note that CIDR 0.0.0.0/0 represents all IP addresses.

VmNicSecurityPolicy

Name	Description	Optional	Valid Value	Starting Version
vmNicUuid	The VM NIC UUID.			4.7.21
ingressPolicy	The ingress policy of the NIC.	Yes	DENY ALLOW	4.7.21
egressPolicy	The egress policy of the NIC.	Yes	DENY ALLOW	4.7.21
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes		4.7.21
userTag	The user tags. For more information, see CreateUserTag.	Yes		4.7.21
systemTag	The system tags. For more information, see CreateSystemTag.	Yes		4.7.21
userTags	The user tags. For more information, see CreateUserTag.	Yes		4.7.21
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		4.7.21
tagUuid	The tag UUID.	Yes		4.7.21
createDate	The creation date. For more information, see Resource Property.	Yes		4.7.21
lastOpDate	The last operation date. For more information, see Resource Property.	Yes		4.7.21

Sample

{
    "inventories": [
        {
            "createDate": "Sep 26, 2023 10:01:59 AM",
            "egressPolicy": "ALLOW",
            "ingressPolicy": "ALLOW",
            "lastOpDate": "Sep 26, 2023 10:31:44 AM",
            "vmNicUuid": "853f9465c02946eaa30ece686d0aceb9"
        }
    ],
    "success": true
}

VIP Inventory

Properties

Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			0.6
name	The name. For more information, see Resource Property.			0.6
description	The description. For more information, see Resource Property.	Yes		0.6
l3NetworkUuid	The UUID of the L3 network to which the VIP is allocated.			0.6
ip	The IP address of the IPv4 type.			0.6
state	The state of the VIP.		Enabled Disabled	0.6
gateway	The gateway.			0.6
netmask	The netmask.			0.6
serviceProvider	The service provider that provides the VIP service.	Yes		0.6
peerL3NetworkUuids	The L3 private network UUID or the VPC L3 network UUID.			0.6
useFor	The usage, such as port forwarding.	Yes	EIP PortForwarding LoadBalancer IPsec	0.6
createDate	The creation date. For more information, see Resource Property.			0.6
lastOpDate	The last operation date. For more information, see Resource Property.			0.6

Sample

 {
            "createDate": "Dec 1, 2017 8:24:43 PM",
            "description": "",
            "gateway": "10.0.0.1",
            "ip": "10.128.19.232",
            "l3NetworkUuid": "429f0e8a088b4ed688e64f42dab3c405",
            "lastOpDate": "Dec 1, 2017 8:25:00 PM",
            "name": "vip-for-lb-lb2",
            "netmask": "255.0.0.0",
            "peerL3NetworkUuids": [
                "62eeb35445144649acbbd72392cf2b40"
            ],
            "serviceProvider": "vrouter",
            "state": "Enabled",
            "useFor": "LoadBalancer",
            "uuid": "81806eb3a0034f529e80034e749b2a8a"
}

EIP Inventory

Properties

Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			0.6
name	The name. For more information, see Resource Property.			0.6
description	The description. For more information, see Resource Property.	Yes		0.6
vmNicUuid	The VM NIC UUID.	Yes		0.6
vipUuid	The VIP UUID.			0.6
state	The state of the EIP.		Enabled Disabled	0.6
vipIp	The IP address of the VIP.			0.6
guestIp	The IP address of the VM NIC.	Yes		0.6
createDate	The creation date. For more information, see Resource Property.			0.6
lastOpDate	The last operation date. For more information, see Resource Property.			0.6

Sample

 {
            "createDate": "Dec 1, 2017 4:19:28 PM",
            "description": "",
            "guestIp": "192.168.235.165",
            "lastOpDate": "Dec 1, 2017 5:10:57 PM",
            "name": "eip",
            "state": "Enabled",
            "uuid": "2d0373f98dc84dfea9bfe590ab40d3ba",
            "vipIp": "10.128.19.125",
            "vipUuid": "78cb2bf960624b678cc135c303735cf3",
            "vmNicUuid": "b1982434c6a4438a9fc1d1a3c465c210"
}

Port Forwarding Rule Inventory

Properties

Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			0.6
name	The name. For more information, see Resource Property.			0.6
description	The description. For more information, see Resource Property.	Yes		0.6
vipIp	The IP address of the VIP.			0.6
guestIp	The IP address of the VM NIC.	Yes
vipUuid	The VIP UUID.			0.6
vipPortStart	The start port of the VIP.		1 ~ 65535	0.6
vipPortEnd	The end port of the VIP.		1 ~ 65535	0.6
privatePortStart	The start port of guest IP address.		1 ~ 65535	0.6
privatePortEnd	The end port of guest IP address.		1 ~ 65535	0.6
vmNicUuid	The VM NIC UUID.	Yes		0.6
protocolType	The protocol type of the network traffic.		TCP UDP	0.6
state	The state of the rule.		Enabled Disabled	0.6
allowedCidr	The source CIDR. The port forwarding rule is only applied to the traffics of the source CIDR.			0.6
createDate	The creation date. For more information, see Resource Property.			0.6
lastOpDate	The last operation date. For more information, see Resource Property.			0.6

Sample

 {
            "allowedCidr": "0.0.0.0/0",
            "createDate": "Dec 1, 2017 7:55:35 PM",
            "description": "",
            "guestIp": "192.168.235.245",
            "lastOpDate": "Dec 1, 2017 7:55:38 PM",
            "name": "pf1",
            "privatePortEnd": 23,
            "privatePortStart": 23,
            "protocolType": "TCP",
            "state": "Enabled",
            "uuid": "474c3e0df7f64cdfbf9f921bcd4a92ab",
            "vipIp": "10.128.19.230",
            "vipPortEnd": 22,
            "vipPortStart": 22,
            "vipUuid": "0579cf3a57f84b99abbaa6c892acf873",
            "vmNicUuid": "e20efc6858ea4988950882934262b6d7"
}

Load Balancing Inventory

Properties

Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		0.6
name	The name. For more information, see Resource Property.		0.6
description	The description. For more information, see Resource Property.	Yes	0.6
state	The state, which is always Enabled.		0.6
vipUuid	The VIP UUID.		0.6
listeners	The listeners. For more information, see Listeners.		0.6

Sample

 {
            "description": "",
            "listeners": [
                {
                    "createDate": "Dec 1, 2017 8:24:44 PM",
                    "instancePort": 22,
                    "lastOpDate": "Dec 1, 2017 8:49:24 PM",
                    "loadBalancerPort": 22,
                    "loadBalancerUuid": "8a745a63e9f24e28af2d81e156d070bf",
                    "name": "lb2-listener",
                    "protocol": "tcp",
                    "uuid": "19a454f0c461492b8228b4ebe185d8a4",
                    "vmNicRefs": [
                        {
                            "createDate": "Dec 1, 2017 8:25:05 PM",
                            "id": 1,
                            "lastOpDate": "Dec 1, 2017 8:25:05 PM",
                            "listenerUuid": "19a454f0c461492b8228b4ebe185d8a4",
                            "status": "Active",
                            "vmNicUuid": "e20efc6858ea4988950882934262b6d7"
                        }
                    ]
                }
            ],
            "name": "lb2",
            "state": "Enabled",
            "uuid": "8a745a63e9f24e28af2d81e156d070bf",
            "vipUuid": "81806eb3a0034f529e80034e749b2a8a"
}

Listener

A listener defines how a load balancer routes incoming traffics from a VIP port (loadBalancer port) to a backend port (instancePort) of a VM instance. In addition, it defines a set of properties, such as the connection timeout and health check threshold.
From your perspectives, a listener simply defined two important ports: the frontend port (loadBalancerPort) where the incoming traffics visit, and the backend port where the incoming traffics are routed.
A load balancer can have multiple listeners. Each listener can be used to set different ports. In addition, ZStack defines a variety of properties as system tags for listeners to control listener behaviors, such as idle connection timeout, maximum connections, healthy threshold, and unhealthy threshold.

Load Balancer Listener Inventory

Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			0.6
name	The name. For more information, see Resource Property.			0.6
description	The description. For more information, see Resource Property.	Yes		0.6
loadBalancerUuid	The load balancer UUID.		1 ~ 65336	0.6
loadBalancerPort	The frontend port where the data reaches the VIP.		1 ~ 65336	0.6
instancePort	The backend port where the data is distributed to VM instances.		For TCP/UDP: 0 - 65535 For ICMP: Use '-1' to represent all types. For more information, see ICMP type and code.	0.6
protocol	The protocol. For more information, see Protocol.		http tcp	0.6
vmNicRefs	The VM NIC references. For more information, see VM NIC References Inventory.			0.6
createDate	The creation date. For more information, see Resource Property.			0.6
lastOpDate	The last operation date. For more information, see Resource Property.			0.6
aclRefs	For more information, see aclRefs Inventory			3.9.0
certificateRefs	For more information, see certificateRefs Inventory			2.3.2
serverGroupUuid				5.0.0
serverGroupRefs	For more information, see serverGroupRefs Inventory			5.0.0

Sample

{
            "createDate": "Dec 1, 2017 8:24:44 PM",
            "instancePort": 22,
            "lastOpDate": "Dec 1, 2017 8:49:24 PM",
            "loadBalancerPort": 22,
            "loadBalancerUuid": "8a745a63e9f24e28af2d81e156d070bf",
            "name": "lb2-listener",
            "protocol": "tcp",
            "uuid": "19a454f0c461492b8228b4ebe185d8a4",
            "vmNicRefs": [
                {
                    "createDate": "Dec 1, 2017 8:25:05 PM",
                    "id": 1,
                    "lastOpDate": "Dec 1, 2017 8:25:05 PM",
                    "listenerUuid": "19a454f0c461492b8228b4ebe185d8a4",
                    "status": "Inactive",
                    "vmNicUuid": "e20efc6858ea4988950882934262b6d7"
                }
            ]
}

Access Control List Inventory

Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		3.9.0
name	The name. For more information, see Resource Property.		3.9.0
description	The description. For more information, see Resource Property.		3.9.0
ipVersion	The IP version.		3.9.0
entries	The entries.		3.9.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.9.0
createDate	The creation date. For more information, see Resource Property.		3.9.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.9.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.9.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.9.0

Sample

{
  "inventories": [
    {
      "uuid": "0abdbd20b8173ccf89f881309b5e40d0",
      "name": "acl-group"
    }
  ]
}

Protocol

A protocol defines the type of data packets that a load balancer routes. Currently, two protocol modes are supported: TCP (layer 4) and HTTP (layer 7). Note that TCP is the default mode. When the protocol is TCP, the load balancer will work in a pure TCP mode. Then, a full-duplex connection will be established between client sides and server sides. When the protocol is HTTP, connections from client sides to the load balancer and from the load balancer to server sides will be established respectively.

Backend VM NICs

You can add a new VM instance to a load balancer by adding the VM NIC to the load balancer's listener. Once the VM NIC UUID is added successfully, the load balancer will route the incoming traffics at appropriate time according the corresponding load balancing algorithm. A VM NIC can be added to different listeners of different load balancers. No matter how many listeners you have added, the VM instances where the NIC is located must have the capability to handle corresponding network requests.

The load balancer listener will add the corresponding VM instances by invoking NIC references, as shown in the following table.

Load Balancer Server Group Inventory

Name	Description	Optional	Starting Version
uuid	The UUID of the server group.		4.0.0
name	The name of the server group.		4.0.0
description	The detailed description of the server group.		4.0.0
loadBalancerUuid	The load balancer UUID.		4.0.0
createDate	The time when the server group was created.		4.0.0
lastOpDate	The time when the server group was last modified.		4.0.0
listenerServerGroupRefs			4.0.0
serverIps			4.0.0
vmNicRefs			4.0.0
systemTags	The user tags. For more information, see CreateUserTag.	Yes	4.0.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	4.0.0

Sample

{
    "inventories": [
        {
            "createDate": "Dec 1, 2020 7:18:18 PM",
            "description": "default server group for load balancer shared2",
            "lastOpDate": "Dec 1, 2020 7:18:18 PM",
            "listenerServerGroupRefs": [],
            "loadBalancerUuid": "a20d5ce157f24494a98288022ce69ce0",
            "name": "default-server-group-shared2",
            "serverIps": [],
            "uuid": "5501293a2c2d4ea3855dae2051a5a29f",
            "vmNicRefs": []
        },
        {
            "createDate": "Dec 1, 2020 4:11:48 PM",
            "description": "default server group for load balancer slb1",
            "lastOpDate": "Dec 1, 2020 4:11:48 PM",
            "listenerServerGroupRefs": [],
            "loadBalancerUuid": "8d651d83ac424257abb66f766c793a7b",
            "name": "default-server-group-slb1",
            "serverIps": [],
            "uuid": "7ca8c9ad58774d698d833d79cbcdfb5c",
            "vmNicRefs": []
        },
        {
            "createDate": "Dec 4, 2020 3:55:17 PM",
            "description": "default server group for load balancer test-vip",
            "lastOpDate": "Dec 4, 2020 3:55:17 PM",
            "listenerServerGroupRefs": [],
            "loadBalancerUuid": "51e511c7ad5d49849509747a38a9c7dd",
            "name": "default-server-group-test-vip",
            "serverIps": [],
            "uuid": "89bc36bdf6674323844f4afe21ed5fb2",
            "vmNicRefs": []
        },
        {
            "createDate": "Dec 1, 2020 7:36:20 PM",
            "description": "default server group for load balancer flat",
            "lastOpDate": "Dec 1, 2020 7:36:20 PM",
            "listenerServerGroupRefs": [],
            "loadBalancerUuid": "b7597d60df48459fabee0809773ddf06",
            "name": "default-server-group-flat",
            "serverIps": [],
            "uuid": "b44ccf09cca74ab188d493177570865c",
            "vmNicRefs": []
        },
        {
            "createDate": "Dec 1, 2020 2:53:37 PM",
            "description": "default server group for load balancer Shared",
            "lastOpDate": "Dec 1, 2020 2:53:37 PM",
            "listenerServerGroupRefs": [
                {
                    "createDate": "Dec 2, 2020 11:20:00 AM",
                    "id": 1,
                    "lastOpDate": "Dec 2, 2020 11:20:00 AM",
                    "listenerUuid": "5631ff3bb6494fc98c16f3c135e2ebe9",
                    "serverGroupUuid": "b645b7e618ff482d8738d885426b2799"
                }
            ],
            "loadBalancerUuid": "6874bc033d4b41369a8c0216cb9b4b04",
            "name": "default-server-group-Shared",
            "serverIps": [],
            "uuid": "b645b7e618ff482d8738d885426b2799",
            "vmNicRefs": []
        }
    ],
    "success": true
}

Listener Server Group Refs Inventory

Name	Description	Starting Version
id		4.0.0
listenerUuid		4.0.0
serverGroupUuid		4.0.0
createDate	The time when the listener was created.	4.0.0
lastOpDate	The time when the listener was last modified.	4.0.0

SLB Group Inventory

Name	Type	Type
uuid	The UUID of the SLB group.	4.0.0
name	The name of the SLB group.	4.0.0
backendType		4.0.0
deployType		4.0.0
slbOfferingUuid		4.0.0
description	The detailed description of the SLB group.	4.0.0
groupBy		4.0.0
createDate	The time when the SLB group was created.	4.0.0
lastOpDate	The time when the SLB group was last modified.	4.0.0
slbVms		4.0.0
lbs		4.0.0
networks		4.0.0
systemTags	The user tags. For more information, see CreateUserTag	4.0.0
userTags	The system tags. For more information, see CreateSystemTag	4.0.0

Sample

{
  "inventories": [
    {
      "name": "slb",
      "backendType": "vyos",
      "deployType": "direct",
      "description": "slb test"
    }
  ]
}

SLB VM Instance Inventory

Name	Description	Starting Version
slbGroupUuid	SLB group UUID	5.1.0
configVersion		5.1.0
publicNetworkUuid		5.1.0
virtualRouterVips		5.1.0
applianceVmType		5.1.0
managementNetworkUuid		5.1.0
defaultRouteL3NetworkUuid		5.1.0
status		5.1.0
agentPort		5.1.0
haStatus		5.1.0
uuid		5.1.0
name		5.1.0
description		5.1.0
zoneUuid		5.1.0
clusterUuid	Clsuter UUID	5.1.0
imageUuid	Image UUID	5.1.0
hostUuid	Host UUID	5.1.0
lastHostUuid		5.1.0
instanceOfferingUuid	Instance Offering UUID	5.1.0
rootVolumeUuid	Root Volume UUID	5.1.0
platform		5.1.0
architecture		5.1.0
defaultL3NetworkUuid		5.1.0
type		5.1.0
hypervisorType		5.1.0
memorySize		5.1.0
reservedMemorySize		5.1.0
cpuNum		5.1.0
cpuSpeed		5.1.0
allocatorStrategy		5.1.0
createDate		5.1.0
lastOpDate		5.1.0
state		5.1.0
guestOsType		5.1.0
configTasks		5.1.0
systemTags	The system tags. For more information, see CreateSystemTag.	5.1.0
userTags	The user tags. For more information, see CreateUserTag.	5.1.0

SLB Offering Inventory

Name	Type	Description	Starting Version	Type
managementNetworkUuid	String	The management network UUID.	4.0.0
zoneUuid	String	The zone UUID.	4.0.0
imageUuid	String	The image UUID.	4.0.0
uuid	String	The record UUID.	4.0.0
name	String	The name of the SLB offering.	4.0.0
description	String	The detailed description of the SLB offering.	4.0.0
cpuNum	Integer		4.0.0
cpuSpeed	Integer		4.0.0
memorySize	Long		4.0.0
type	String		4.0.0
allocatorStrategy	String		4.0.0
sortKey	Integer		4.0.0
createDate	Timestamp	The time when the SLB offering was created.	4.0.0
systemTags	The user tags. For more information, see CreateUserTag			4.0.0
userTags	The system tags. For more information, see CreateSystemTag			4.0.0

Sample

{
  "inventories": [
    {
      "managementNetworkUuid": "fdd51745e9ee3a4cb5bca03cf021c22f",
      "zoneUuid": "305d0c8b5c5a3edd81a641911126c332",
      "imageUuid": "b2f980076c3e3e6f8e9f3d4fd22bb7fb",
      "name": "SLB-Offering",
      "cpuNum": 2.0,
      "cpuSpeed": 1.0,
      "memorySize": 1024.0,
      "type": "SLB"
    }
  ]
}

VM NIC References Inventory

Name	Description	Valid Value	Starting Version
id	The UUID of the VM NIC references.		0.6
listenerUuid	The listener UUID.		0.6
vmNicUuid	The VM NIC UUID.		0.6
status	The status. When the VM instance of the NIC is running, the status is Active. Otherwise, it is Inactive.	Active Inactive	0.6
createDate	The creation date. For more information, see Resource Property.		0.6

After a VM NIC is added successfully to a load balancer listener, if you stop the VM instance, the status of vmNicRefs will be changed to Inactive. If you start the VM instance, the status of vmNicRefs will be changed to Active. If you delete the VM instance, the corresponding NIC will be removed from the load balancer listener.

aclRefs Inventory

Name	Description	Starting Version
id	The resource UUID.	3.9.0
listenerUuid	The listener UUID.	3.9.0
aclUuid	The UUID of the access control list.	3.9.0
type	The access control type.	3.9.0
createDate	The creation date.	3.9.0
lastOpDate	The last operation date.	3.9.0

certificateRefs Inventory

Name	Description	Starting Version
id		2.3
listenerUuid		2.3
certificateUuid		2.3.2
createDate	The creation date.	0.6
lastOpDate	The last operation date.	0.6

serverGroupRefs Inventory

Name	Description	Starting Version
id		5.0.0
listenerUuid		5.0.0
serverGroupUuid		5.0.0
createDate	The creation date.	5.0.0
lastOpDate	The last operation date.	5.0.0

configTasks Inventory

Name	Description	Starting Version
vmInstanceUuid	VM instance UUID.	5.1.0
configVersion		5.1.0
taskName		5.1.0
taskData		5.1.0
retryNumber		5.1.0
lastFailedReason		5.1.0
createDate	The creation date.	5.1.0
lastOpDate	The last operation date.	5.1.0
status	See status.	5.1.0

status Inventory

Name	Description	Optional	Valid Value	Starting Version
Pending				5.1.0
Starting				5.1.0
Success				5.1.0
Failed				5.1.0

IPsec Inventory

Properties

Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			0.6
name	The name. For more information, see Resource Property.			0.6
description	The description. For more information, see Resource Property.	Yes		0.6
peerAddress	The destination IP address.			0.6
authMode	The authentication mode.		pskcerts	0.6
authKey	The authentication key.			0.6
vipUuid	The VIP UUID.			0.6
ikeAuthAlgorithm	The IKE authentication algorithm.		md5 sha1 sha256 sha384 sha512	0.6
ikeEncryptionAlgorithm	The IKE encryption algorithm.		3des aes-128 aes-192 aes-256	0.6
ikeDhGroup	The IKE DH group.			4.5.0
policyAuthAlgorithm	The ESP authentication algorithm.		md5 sha1 sha256 sha384 sha512	0.6
policyEncryptionAlgorithm	The ESP encryption algorithm.		3des aes-128 aes-192 aes-256	0.6
pfs	The PFS DH group.		none dh-group0 dh-group2 dh-group5 dh-group14 dh-group15 dh-group16 dh-group17 dh-group18 dh-group19 dh-group20 dh-group21 dh-group22 dh-group23 dh-group24 dh-group25 dh-group26	4.5.0
policyMode	The encapsulation mode.		tunnel transport	4.5.0
transformProtocol	The security protocol.		esp ahah-esp	4.5.0-
ikeVersion	The IKE version.			4.5.0
idType	The ID configuration method.			4.5.0
localId	The local ID.			4.5.0
remoteId	The remote ID.			4.5.0
state	The running state.		Enabled Disabled	4.5.0
status	The ready status.			4.5.0
ikeLifeTime	The IKE life time.			4.5.0
lifeTime	The IPsec life time.			4.5.0
createDate	The creation date. For more information, see Resource Property.			0.6
lastOpDate	The last operation date. For more information, see Resource Property.			0.6

Sample

{
    "inventories": [
        {
            "authKey": "123",
            "authMode": "psk",
            "createDate": "Sep 23, 2022 11:23:05 AM",
            "ikeAuthAlgorithm": "sha1",
            "ikeDhGroup": 2,
            "ikeEncryptionAlgorithm": "aes-128",
            "ikeLifeTime": 0,
            "ikeVersion": "ikev1",
            "l3NetworkRefs": [
                {
                    "connectionUuid": "13d92544a79845fd9c857954b77762d8",
                    "createDate": "Sep 23, 2022 11:23:05 AM",
                    "l3NetworkUuid": "e1c0d94c1fe9459da4fa2877261c0cb7",
                    "lastOpDate": "Sep 23, 2022 11:23:05 AM",
                    "uuid": "ba50c50bf8ec4e3a8bfe7b4fb4e89a87"
                }
            ],
            "lastOpDate": "Sep 23, 2022 11:23:25 AM",
            "lifeTime": 0,
            "name": "vr1-vr2",
            "peerAddress": "172.26.30.114",
            "peerCidrs": [
                {
                    "cidr": "192.168.139.0/24",
                    "connectionUuid": "13d92544a79845fd9c857954b77762d8",
                    "createDate": "Sep 23, 2022 11:23:05 AM",
                    "lastOpDate": "Sep 23, 2022 11:23:05 AM",
                    "uuid": "50a6d14f535c4c6191f36e011b0f24eb"
                }
            ],
            "pfs": "dh-group2",
            "policyAuthAlgorithm": "sha1",
            "policyEncryptionAlgorithm": "aes-128",
            "policyMode": "tunnel",
            "state": "Enabled",
            "status": "Ready",
            "transformProtocol": "esp",
            "uuid": "13d92544a79845fd9c857954b77762d8",
            "vipUuid": "348fae2b7cf9490590b13b374fcf171e"
        }
    ],
    "success": true
}

peerCidrs Inventory

Name	Description	Starting Version
uuid	For more information, see Resource Property.	4.5.0
cidr		4.5.0
ConnectionUuid		4.5.0
createDate	For more information, see Resource Property.	4.5.0
lastOpDate	For more information, see Resource Property.	4.5.0

Sample

{
    "cidr": "192.168.139.0/24",
    "connectionUuid": "13d92544a79845fd9c857954b77762d8",
    "createDate": "Sep 23, 2022 11:23:05 AM",
    "lastOpDate": "Sep 23, 2022 11:23:05 AM",
    "uuid": "50a6d14f535c4c6191f36e011b0f24eb"
}

l3NetworkRefs Inventory

Name	Description	Starting Version
uuid	For more information, see Resource Property.	4.5.0
ConnectionUuid		4.5.0
l3NetworkUuid	The l3 network UUID.	4.5.0
createDate	For more information, see Resource Property.	4.5.0
lastOpDate	For more information, see Resource Property.	4.5.0

Sample

{
    "connectionUuid": "13d92544a79845fd9c857954b77762d8",
    "createDate": "Sep 23, 2022 11:23:05 AM",
    "l3NetworkUuid": "e1c0d94c1fe9459da4fa2877261c0cb7",
    "lastOpDate": "Sep 23, 2022 11:23:05 AM",
    "uuid": "ba50c50bf8ec4e3a8bfe7b4fb4e89a87"
}

Shared Bandwidth Inventory

Properties

Name	Description	Starting Version
uuid	The UUID. For more information, see Resource Property.	5.1.0
name	The name. For more information, see Resource Property.	5.1.0
description	The description. For more information, see Resource Property.	5.1.0
l3NetworkUuid	The L3 network UUID.	5.1.0
vpcUuid	The VPC vRouter UUID.	5.1.0
bandwidth	The bandwidth size.	5.1.0
createDate	The creation date. For more information, see Resource Property.	5.1.0
lastOpDate	The last operation date. For more information, see Resource Property.	5.1.0

PreviousOverview NextOperations