VPC Firewall Inventory

VPC Firewall 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
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 Valid Value 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 Valid Value 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 Valid Value 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 Valid Value 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"
    }
  ]
}