清单

流量监控搜集器清单( FlowCollector Inventory)

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		3.6.0
name	请参见资源属性		3.6.0
description	请参见资源属性	是	3.6.0
flowMeterUuid			3.6.0
port	搜集器的UDP端口		3.6.0
server	搜集器IP		3.6.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.6.0
createDate	请参见资源属性		3.6.0
lastOpDate	请参见资源属性		3.6.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.6.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.6.0

示例

{
  "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"
    }
  ]
}

流量监控资源清单( FlowMeter Inventory)

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		3.6.0
name	请参见资源属性		3.6.0
description	请参见资源属性	是	3.6.0
expireInterval	流发送间隔		3.6.0
sample	流的采样率		3.6.0
type	流量监控协议		3.6.0
version	流量监控协议的版本		3.6.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.6.0
createDate	请参见资源属性		3.6.0
lastOpDate	请参见资源属性		3.6.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.6.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.6.0

示例

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

开启流量监控的VPC网络清单( VRouterFlowMeterNetwork Inventory)

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		3.6.0
flowMeterUuid			3.6.0
l3NetworkUuid	三层网络UUID		3.6.0
vRouterUuid			3.6.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.6.0
createDate	请参见资源属性		3.6.0
lastOpDate	请参见资源属性		3.6.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.6.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.6.0

示例

{
  "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"
    }
  ]
}

端口镜像清单(PortMirror Inventory)

名字	描述	可选的	起始支持版本
description	请参见资源属性	是	3.7.0
mirrorNetworkUuid	镜像网络资源的UUID		3.7.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.7.0
createDate	请参见资源属性		3.7.0
lastOpDate	请参见资源属性		3.7.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.7.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.7.0

示例

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

端口镜像会话清单(PortMirrorSession Inventory)

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		3.7.0
name	请参见资源属性		3.7.0
description	请参见资源属性	是	3.7.0
dstEndPoint	镜像会话目的端口		3.7.0
internalId			3.7.0
portMirrorUuid	端口镜像服务的UUID		3.7.0
srcEndPoint	镜像会话源端口		3.7.0
status			3.7.0
type			3.7.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.7.0
createDate	请参见资源属性		3.7.0
lastOpDate	请参见资源属性		3.7.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.7.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.7.0

示例

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

端口镜像网络分配的IP清单(PortMirrorNetworkUsedIp Inventory)

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		3.7.0
description	请参见资源属性	是	3.7.0
clusterUuid	集群UUID		3.7.0
hostUuid	物理机UUID		3.7.0
l3NetworkUuid	三层网络UUID		3.7.0
usedIpInventory			3.7.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.7.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.7.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.7.0

示例

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

网络服务模块清单(NetworkServiceProvider Inventory)

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		2.2
name	请参见资源属性		2.2
description	请参见资源属性	是	2.2
attachedL2NetworkUuids	加载的L2网络UUID		2.2
networkServiceTypes	网络服务类型		2.2
type			2.2
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	2.2
createDate	请参见资源属性		2.2
lastOpDate	请参见资源属性		2.2
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	2.2
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	2.2

示例

{
    "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网络服务模块
            "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",//扁平网络服务模块
            "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",  //安全组网络服务模块
            "uuid": "5fad7c177d6041be9b76d5c55e742865"
        },
        {
            "attachedL2NetworkUuids": [
                "06787a08456b458db2af527c23ab110c",
                "8baa26aacfb740adb1d7709a369179ef",
                "fd91d394591e4b79a2979c34abac464d",
                "32d20dc18ef74adfb033fdfbce674bbf",
                "00e1a1bea98c46d59c4c9768357d4f62"
            ],
            "createDate": "Jun 20, 2018 10:45:45 AM",
            "description": "zstack virtual router network service provider",
            "lastOpDate": "Jun 20, 2018 10:45:45 AM",
            "name": "VirtualRouter",
            "networkServiceTypes": [
                "DNS",
                "SNAT",
                "LoadBalancer",
                "PortForwarding",
                "Eip",
                "DHCP"
            ],
            "type": "VirtualRouter",  //虚拟路由器网络服务模块，不建议使用
            "uuid": "9c4e250086ef43a1839f0c71c42c5d47"
        }
    ],
    "success": true
}

VPC防火墙清单

防火墙清单（VpcFirewall Inventory）

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		3.6.0
name	请参见资源属性		3.6.0
description	请参见资源结构		3.6.0
refs	防火墙规则集与网络的关联		3.6.0
rulesets	防火墙规则集		3.6.0
createDate	请参见资源结构		3.6.0
lastOpDate	请参见资源结构		3.6.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.6.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.6.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.6.0

示例

{
  "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"
    }
  ]
}

防火墙规则集清单（FirewallRuleSet Inventory）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源属性			3.6.0
name	请参见资源属性			3.6.0
description	请参见资源结构			3.6.0
actionType	操作类型		drop reject accept	3.6.0
isDefault	默认			3.6.0
vpcFirewallUuid				3.6.0
createDate	请参见资源结构			3.6.0
lastOpDate	请参见资源结构			3.6.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是		3.6.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是		3.6.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是		3.6.0

示例

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

防火墙规则集与三层网络关联关系清单（FirewallRuleSetL3Ref Inventory）

名字	描述	可选的	起始支持版本
id			3.6.0
l3NetworkUuid	三层网络UUID		3.6.0
packetsForwardType			3.6.0
ruleSetUuid	规则集UUID		3.6.0
vpcFirewallUuid	防火墙UUID		3.6.0
createDate	请参见资源结构		3.6.0
lastOpDate	请参见资源结构		3.6.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.6.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.6.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.6.0

示例

{
  "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"
    }
  ]
}

防火墙IP或端口模板清单(FirewallIpSetTemplate Inventory)

名字	描述	可选的	起始支持版本
name	资源名称		4.0.0
sourceValue			4.0.0
destValue			4.0.0
createDate	创建时间		4.0.0
lastOpDate	最后一次修改时间		4.0.0
accountUuid	账户UUID		4.0.0
uuid	资源的UUID，唯一标示该资源		4.0.0
type			4.0.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	4.0.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	4.0.0

示例

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

防火墙规则清单(FirewallRule Inventory)

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		3.6.0
description	请参见资源属性	是	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	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.6.0
createDate	请参见资源属性		3.6.0
lastOpDate	请参见资源属性		3.6.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.6.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.6.0

示例

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

防火墙与单节点路由器关联关系清单(VpcFirewallVRouterRef Inventory)

名字	描述	可选的	起始支持版本
vpcFirewallUuid	防火墙UUID		3.6.0
id			3.6.0
vRouterUuid	路由器UUID		3.6.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.6.0
createDate	请参见资源属性		3.6.0
lastOpDate	请参见资源属性		3.6.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.6.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.6.0

示例

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

安全组清单

属性（Properties）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源属性			0.6
name	请参见资源属性			0.6
description	请参见资源属性	是		0.6
state	请参见资源属性		Enabled Disabled	0.6
rules	请参见 Security Group Rule Inventory			0.6
attachedL3NetworkUuids	安全组挂载的L3Network 的uuid列表			0.6
createDate	请参见资源属性			0.6
lastOpDate	请参见资源属性			0.6

示例

 {
    "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"
}

安全组默认策略（Security Group defaultPolicy）

空的安全组会有默认的策略控制进出的流量；
对于进入（Ingress）的流量，默认的策略是拒绝（deny），也就是说对于这个空白安全组的网卡所有的流入流量（inbound traffics）都被阻止（blocked）了；
对于外出（Egress）的流量，默认的策略是允许（allow），也就是说对于这个空白安全组的网卡所有的流出流量都被允许。

管理员可以通过修改全局设置 Ingress.defaultPolicy 和 Egress.defaultPolicy 来改变默认的策略。

安全组规则清单（Security Group Rule Inventory）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源属性			0.6
securityGroupUuid	父安全组的uuid			0.6
remoteSecurityGroupUuid	源安全组，表示仅允许指定全组内的云主机才可通过	是		0.6
type	请参见 traffic type		Ingress Egress	0.6
protocol	流量协议类型		TCP UDP ICMP	0.6
startPort	如果协议是TCP/UDP，它是端口范围（port range）的起始端口号；如果协议是ICMP，它是ICMP类型（type）		对于TCP/UDP：0 - 65535 对于ICMP: 请参见 ICMP type and code ，使用‘-1’来表示所有的类型	0.6
endPort	如果协议是TCP/UDP，它是端口范围（port range）的结束端口号；如果协议是ICMP，它是ICMP类型（type）		对于TCP/UDP：0 - 65535 对于ICMP: 请参见 ICMP type and code ，使用‘-1’来表示所有的类型	0.6
allowedCidr	请参见 allowedCidr			0.6
state	规则的可用状态，当前版本未实现		Enabled Disabled	0.6
createDate	请参见资源属性			0.6
lastOpDate	请参见资源属性			0.6

示例

{
     "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）

有两种流量类型：

Ingress：
访问虚拟机网卡的流入的流量
Egress：
离开虚拟机网卡的流出的流量

允许的CIDR（Allowed CIDR）

根据流量类型的不同，允许的CIDR有不同的含义。格式为：

ipv4地址/网络前缀（network_prefix）
例如: 12.12.12.12/24

如果流量类型是Ingress，允许的CIDR是允许访问虚拟机网卡的源CIDR（source CIDR）；例如，规则：

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

表示只有从IP（12.12.12.12）来的TCP流量允许访问端口22。

如果流量类型是Egress，允许的CIDR是允许从虚拟机网卡离开并到达的目的地CIDR（destination CIDR）；例如，规则：

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

表示只允许从目的地为IP为12.12.12.12端口为22的TCP的流量允许流出。

特别的是，CIDR 0.0.0.0/0表示所有IP地址。

网卡的流量策略(VmNicSecurityPolicy)

名字	描述	可选的	可选的参数值	起始支持版本
vmNicUuid	网卡的UUID，唯一标示该资源			4.7.21
ingressPolicy	网卡入方向安全策略	是	DENY ALLOW	4.7.21
egressPolicy	网卡出方向安全策略	是	DENY ALLOW	4.7.21
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是		4.7.21
userTag	用户标签，请参见创建用户标签(CreateUserTag)	是		4.7.21
systemTag	系统标签，请参见创建系统标签(CreateSystemTag)	是		4.7.21
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是		4.7.21
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是		4.7.21
tagUuid	标签UUID	是		4.7.21
createDate	请参见资源属性	是		4.7.21
lastOpDate	请参见资源属性	是		4.7.21

示例

{
    "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
}

虚拟IP清单

属性（Properties）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源属性			0.6
name	请参见资源属性			0.6
description	请参见资源属性	是		0.6
l3NetworkUuid	分配VIP的L3网络的uuid			0.6
ip	IPv4类型的IP地址			0.6
state	VIP可用状态		Enabled Disabled	0.6
gateway	网关			0.6
netmask	子网掩码			0.6
serviceProvider	提供VIP服务的服务提供者	是		0.6
peerL3NetworkUuids	L3私有网络或VPC的L3网络的UUID			0.6
useFor	用途，例如：端口转发	是	EIP PortForwarding LoadBalancer IPsec	0.6
createDate	请参见资源属性			0.6
lastOpDate	请参见资源属性			0.6

示例

 {
            "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"
}

弹性IP清单

属性（Properties）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源属性			0.6
name	请参见资源属性			0.6
description	请参见资源属性	是		0.6
vmNicUuid	云主机网卡UUID	是		0.6
vipUuid	VIP UUID			0.6
state	EIP的可用状态		Enabled Disabled	0.6
vipIp	VIP的IP地址			0.6
guestIp	虚拟机网卡的IP地址	是		0.6
createDate	请参见资源属性			0.6
lastOpDate	请参见资源属性			0.6

示例

 {
            "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"
}

端口转发清单

属性（Properties）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源属性			0.6
name	请参见资源属性			0.6
description	请参见资源属性	是		0.6
vipIp	VIP的IP地址			0.6
guestIp	虚拟机网卡的IP地址	是
vipUuid	VIP UUID			0.6
vipPortStart	VIP的起始端口号		1 ~ 65535	0.6
vipPortEnd	VIP的结束端口号		1 ~ 65535	0.6
privatePortStart	客户IP的起始端口号		1 ~ 65535	0.6
privatePortEnd	客户IP的结束端口号		1 ~ 65535	0.6
vmNicUuid	云主机网卡UUID	是		0.6
protocolType	网络流量的协议类型		TCP UDP	0.6
state	规则可用状态		Enabled Disabled	0.6
allowedCidr	源CIDR；端口转发规则只作用于源CIDR的流量			0.6
createDate	请参见资源属性			0.6
lastOpDate	请参见资源属性			0.6

示例

 {
            "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"
}

负载均衡清单

属性（Properties）

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		0.6
name	请参见资源属性		0.6
description	请参见资源属性	是	0.6
state	可用状态，always Enabled		0.6
vipUuid	VIP UUID		0.6
listeners	请参见 listeners		0.6

示例

 {
            "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）

Listener定义了负载均衡应该如何处理发往VIP的网络包，设定将发往VIP某个端口（loadBalancerPort）的数据包分发到不同的后端云主机的端口（instancePort）。 Listener还定义了一些属性，例如连接超时、健康检查阀值等。
从用户的使用角度来说，Listener就是简单的定义了监听负载均衡IP的某个端口号，以及隐藏在私有网络上后端云主机用于接收的端口号。
负载均衡可以定义很多listeners，每个listener都可以设定不同的端口号。此外，ZStack Cloud通过系统标签（System Tags）定义了listener的额外属性：空闲连接超时，最大链接数，健康检查阀值，非健康监控阀值等。

负载均衡监听器清单（LoadBalancerListener Inventory）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源属性			0.6
name	请参见资源属性			0.6
description	请参见资源属性	是		0.6
loadBalancerUuid	load balancer uuid		1 ~ 65336	0.6
loadBalancerPort	前端端口号，数据到达VIP时的端口号		1 ~ 65336	0.6
instancePort	后端端口号，数据分发到云主机的端口号		对于TCP/UDP：0 - 65535 对于ICMP: 请参见 ICMP type and code ，使用‘-1’来表示所有的类型	0.6
protocol	请参见 protocol		http tcp	0.6
vmNicRefs	请参见 vmNicRefs			0.6
createDate	请参见资源属性			0.6
lastOpDate	请参见资源属性			0.6

示例

{
            "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"
                }
            ]
}

访问控制策略组清单（AccessControlList Inventory）

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		3.9.0
name	请参见资源属性		3.9.0
description	请参见资源属性		3.9.0
ipVersion	IP地址版本		3.9.0
entries	条目		3.9.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.9.0
createDate	请参见资源属性		3.9.0
lastOpDate	请参见资源属性		3.9.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.9.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.9.0

示例

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

协议（protocol）

协议定义了负载均衡应该处理的数据包的类型。目前支持两种模式：tcp（网络第四层）和 http（网络第七层）。其中tcp是默认的模式，负载均衡会工作在纯粹的TCP模式，一个双向的链接会建立在客户端和服务器端之间。当设置协议为http时，从客户端到负载均衡，以及负载均衡到服务器端都会建立对应的链接。

后端云主机网卡

用户可以把一个新的云主机添加到负载均衡的队列中来。一旦一个网卡的UUID被添加，就会遵循负载均衡对应的算法在合适的时间被调度。一块网卡可以添加到不同的负载均衡的不同的listener上。当然不论添加多少listener，该网卡所在的云主机应该配置有处理相应网络请求的能力。

负载均衡listener通过调用 nic reference 来添加对应的云主机：

vmNicRefs 清单（vmNicRefs inventory）

名字	描述	可选的参数值	起始支持版本
id	vmNicRefs的uuid		0.6
listenerUuid	listener uuid		0.6
vmNicUuid	VM nic uuid		0.6
status	当网卡所在云主机为运行的时候，状态是active，否则是inactive	Active Inactive	0.6
createDate	请参见资源属性		0.6

当一个网卡加入了负载均衡listener之后，停止云主机会把vmNicRefs 的状态改成 Inactive；启动云主机后会改变该状态为 Active；删除云主机会把对应的NIC从listener中移除。

负载均衡器服务器组清单(LoadBalancerServerGroup Inventory)

名字	描述	可选的	起始支持版本
uuid	负载均衡器服务器组uuid		4.0.0
vmNicRefs	后端云主机网卡		4.0.0
serverIps	后端服务器IP		4.0.0
name	服务器组名字		4.0.0
loadBalancerUuid	负载均衡器uuid		4.0.0
description	描述		4.0.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type		4.0.0
createDate	创建日期		4.0.0
lastOpDate	最后一次修改日期		4.0.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)		4.0.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)		4.0.0
timeout		是

示例

{
    "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
}

listenerServerGroupRefs 清单(listenerServerGroupRefs inventory)

名字	描述	起始支持版本
id		4.0.0
listenerUuid		4.0.0
serverGroupUuid		4.0.0
createDate	创建时间	4.0.0
lastOpDate	最后一次修改时间	4.0.0

性能独享型负载均衡器组清单(SlbGroup Inventory)

名字	描述	起始支持版本
uuid	资源的UUID，唯一标示该资源	4.0.0
name	资源名字	4.0.0
backendType		4.0.0
deployType		4.0.0
slbOfferingUuid		4.0.0
description	资源的详细描述	4.0.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	4.0.0
createDate	创建日期	4.0.0
lastOpDate	最后一次修改日期	4.0.0
slbVms		4.0.0
lbs		4.0.0
networks		4.0.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	4.0.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	4.0.0

示例

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

性能独享型负载均衡器规格清单(QuerySlbOffering Inventory)

名字	描述	起始支持版本
managementNetworkUuid	资源的UUID，唯一标示该资源	4.0.0
zoneUuid	区域UUID	4.0.0
imageUuid	镜像UUID	4.0.0
uuid	资源的UUID，唯一标示该资源	4.0.0
name	资源名称	4.0.0
description	资源的详细描述	4.0.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	4.0.0
cpuNum		4.0.0
cpuSpeed		4.0.0
memorySize		4.0.0
type		4.0.0
allocatorStrategy		4.0.0
sortKey		4.0.0
createDate	创建日期	4.0.0
lastOpDate	最后一次修改日期	4.0.0
state		4.0.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	4.0.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	4.0.0

示例

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

IPsec清单

属性（Properties）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源属性			0.6
name	请参见资源属性			0.6
description	请参见资源属性	是		0.6
peerAddress	远端网络地址			4.5.0
authMode	认证模式		pskcerts	0.6
authKey	认证密钥			0.6
vipUuid	VIP UUID			0.6
ikeAuthAlgorithm	IKE验证算法		md5 sha1 sha256 sha384 sha512	0.6
ikeEncryptionAlgorithm	IKE加密算法		3des aes-128 aes-192 aes-256	0.6
ikeDhGroup	IKE DH组			4.5.0
policyAuthAlgorithm	ESP认证算法		md5 sha1 sha256 sha384 sha512	0.6
policyEncryptionAlgorithm	ESP加密算法		3des aes-128 aes-192 aes-256	0.6
pfs	PFS DH组		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	封装模式		tunnel transport	4.5.0
transformProtocol	安全协议		esp ahah-esp	4.5.0
ikeVersion	IKE版本			4.5.0
idType	ID配置方法			4.5.0
localId	本端ID			4.5.0
remoteId	对端ID			4.5.0
state	启用状态		Enabled Disabled	4.5.0
status	就绪状态			4.5.0
ikeLifeTime	IKE存活时间			4.5.0
lifeTime	IPsec存活时间			4.5.0
createDate	请参见资源属性			0.6
lastOpDate	请参见资源属性			0.6

示例

{
    "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
}

目的网络CIDR清单（peerCidrs inventory）

名字	描述	起始支持版本
uuid	请参见资源属性	4.5.0
cidr		4.5.0
ConnectionUuid		4.5.0
createDate	请参见资源属性	4.5.0
lastOpDate	请参见资源属性	4.5.0

示例

{
    "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）

名字	描述	起始支持版本
uuid	请参见资源属性	4.5.0
ConnectionUuid		4.5.0
l3NetworkUuid	三层网络UUID	4.5.0
createDate	请参见资源属性	4.5.0
lastOpDate	请参见资源属性	4.5.0

示例

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

上一篇概览下一篇操作（Operations）