Inventory
Flow Collector 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. | 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 | 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. | 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 | Valid Value | 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 | Valid Value | 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 | Valid Value | 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 | Valid Value | 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 | Valid Value | 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
}