文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›CLI命令使用手册ZCF
文档目录

安全组

创建安全组（CreateSecurityGroup）

管理员可以使用CreateSecurityGroup创建安全组。例如：
CreateSecurityGroup name=SecurityGroup1

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
name 安全组名称 0.6
description 安全组的详细描述 是 0.6
resourceUuid 资源uuid 是 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 0.6
timeout 是

删除安全组（DeleteSecurityGroup）

管理员可以使用DeleteSecurityGroup删除安全组。例如：
DeleteSecurityGroup uuid=4b6b54354448429db419cdb9ca2b17ff

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 安全组uuid 0.6
deleteMode 请参见 删除资源(Delete Resources) 是
  • Permissive
  • Enforcing
 2.1
resourceUuid 资源uuid 是 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 0.6
timeout 是

查询安全组（QuerySecurityGroup）

管理员可以使用QuerySecurityGroup查询安全组。例如：
QuerySecurityGroup uuid=5a008ae4db7b4a7aa1010083f641cc80
QuerySecurityGroup rules.uuid=c6173478f10347f0be3398b9ccaed1cb

原生域查询（Primitive Fields of Query）

请参见 security group inventory

嵌套和扩展域查询（Nested and Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
l3Network L3network inventory 0.6
rules rules inventory 0.6
vmNics vm nic inventory 0.6

更新安全组（UpdateSecurityGroup）

管理员可以使用UpdateSecurityGroup更新安全组。例如：
UpdateSecurityGroup uuid=5a008ae4db7b4a7aa1010083f641cc80

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 安全组uuid 0.6
name 安全组名称 0.6
description 安全组的详细描述 是 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 0.6
timeout 是

改变安全组状态（ChangeSecurityGroupState）

管理员可以使用ChangeSecurityGroupState改变安全组状态。例如：
ChangeSecurityGroupState uuid=5a008ae4db7b4a7aa1010083f641cc80 stateEvent=enable

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 安全组uuid 0.6
stateEvent 安全组状态
  • enable
  • disable
 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 0.6
timeout 是

挂载安全组到L3网络（AttachSecurityGroupToL3Network）

管理员可以使用AttachSecurityGroupToL3Network挂载安全组到L3网络。例如：
AttachSecurityGroupToL3Network securityGroupUuid=5a008ae4db7b4a7aa1010083f641cc80 \
l3NetworkUuid=9082f45fce9c46f19b2ab5ff117511d6

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
securityGroupUuid 安全组uuid 0.6
l3NetworkUuid 三层网络uuid 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 0.6
timeout 是

从L3网络卸载安全组（DetachSecurityGroupFromL3Network）

管理员可以使用DetachSecurityGroupFromL3Network从L3网络卸载安全组。例如：
DetachSecurityGroupFromL3Network securityGroupUuid=5a008ae4db7b4a7aa1010083f641cc80 \
l3NetworkUuid=9082f45fce9c46f19b2ab5ff117511d6

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
securityGroupUuid 安全组uuid 0.6
l3NetworkUuid 三层网络uuid 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 0.6
timeout 是

获取网卡列表清单（GetCandidateVmNicForSecurityGroup）

管理员可以使用GetCandidateVmNicForSecurityGroup获取可应用安全组的网卡列表清单。例如：
GetCandidateVmNicForSecurityGroup securityGroupUuid=5a008ae4db7b4a7aa1010083f641cc80

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
securityGroupUuid 安全组uuid 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 0.6
timeout 是

添加虚拟机网卡到安全组（AddVmNicToSecurityGroup）

管理员可以使用AddVmNicToSecurityGroup添加虚拟机网卡到安全组。例如：
AddVmNicToSecurityGroup securityGroupUuid=5a008ae4db7b4a7aa1010083f641cc80 \
vmNicUuids=3e6a4cc2eb0941edbac7af24e2ff932f

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
securityGroupUuid 安全组uuid 0.6
vmNicUuids 云主机网卡uuid列表 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 0.6
timeout 是

从安全组删除虚拟机网卡（DeleteVmNicFromSecurityGroup）

管理员可以使用DeleteVmNicFromSecurityGroup从安全组删除虚拟机网卡。例如：
DeleteVmNicFromSecurityGroup securityGroupUuid=5a008ae4db7b4a7aa1010083f641cc80 \
vmNicUuids=3e6a4cc2eb0941edbac7af24e2ff932f

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
securityGroupUuid 安全组uuid 0.6
vmNicUuids 云主机网卡uuid列表 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 0.6
timeout 是

查询应用了安全组的网卡列表（QueryVmNicInSecurityGroup）

管理员可以使用QuerySecurityGroup查询应用了安全组的网卡列表。例如：
QueryVmNicInSecurityGroup securityGroupUuid=5a008ae4db7b4a7aa1010083f641cc80
QueryVmNicInSecurityGroup vmNic.uuid=3e6a4cc2eb0941edbac7af24e2ff932f

原生域查询（Primitive Fields of Query）

请参见 security group inventory

嵌套和扩展域查询（Nested and Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
securityGroup securitygroup inventory 0.6
vmNic vm nic inventory 应用了该安全组的网卡 0.6

添加规则到安全组（AddSecurityGroupRule）

管理员可以使用AddSecurityGroupRule添加规则到安全组。例如：
AddSecurityGroupRule rules="[{'type':'Ingress', 'protocol':'TCP', 'startPort':'22', \
'endPort':'22', 'allowedCidr':'0.0.0.0/0'}]" securityGroupUuid=090990371a5e4949a2a129628ba91275

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
securityGroupUuid 安全组uuid 0.6
rules 安全组中的规则 0.6
remoteSecurityGroupUuids 规则生效的源安全组 是 0.6
priority 规则优先级 是 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 0.6

删除安全组规则（DeleteSecurityGroupRule）

管理员可以使用DeleteSecurityGroupRule删除安全组规则。例如：
DeleteSecurityGroupRule ruleUuids=b59a266d49374b729cbcafbe2cc23f73

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
ruleUuids 安全组规则的uuid列表 是 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupRuleVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupRuleVO 是 0.6
timeout 是

查询安全组规则（QuerySecurityGroupRule）

管理员可以使用QuerySecurityGroupRule查询安全组规则。例如：
QuerySecurityGroupRule uuid=b59a266d49374b729cbcafbe2cc23f73
QuerySecurityGroupRule securityGroup.uuid=090990371a5e4949a2a129628ba91275

原生域查询（Primitive Fields of Query）

请参见 security group rule inventory

嵌套和扩展域查询（Nested and Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
securityGroup securitygroup inventory 0.6

检查安全组规则是否可用(ValidateSecurityGroupRule)

管理员可以使用ValidateSecurityGroupRule设置网卡的安全组。例如：
ValidateSecurityGroupRule securityGroupUuid=5309eb9abfea4694a1d589f1c3563553 type=Egress protocol=ALL

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
securityGroupUuid 安全组的UUID，唯一标示该资源 4.7.21
type 安全组规则的方向
  • Ingress
  • Egress
 4.7.21
protocol 安全组规则的协议类型
  • TCP
  • UDP
  • ICMP
  • ALL
 4.7.21
remoteSecurityGroupUuid 远端安全组的UUID，唯一标示该资源 是 4.7.21
ipVersion 安全组规则的IP版本 是
  • 4
  • 6
 4.7.21
srcIpRange 安全组规则的源ip范围 是 4.7.21
dstIpRange 安全组规则的目的ip范围 是 4.7.21
dstPortRange 安全组规则的目的端口范围 是 4.7.21
action 安全组规则的动作 是
  • ACCEPT
  • DROP
 4.7.21
startPort 安全组规则的起始端口 是 4.7.21
endPort 安全组规则的结束端口 是 4.7.21
allowedCidr 安全组规则的ip范围 是 4.7.21
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupRuleVO 是 4.7.21
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupRuleVO 是 4.7.21

修改安全组规则(ChangeSecurityGroupRule)

管理员可以使用ChangeSecurityGroupRule修改安全组规则。例如：
ChangeSecurityGroupRule uuid=1dd5d2e8229f445ca1779b9f977541b0

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 安全组规则的UUID，唯一标示该资源 4.7.21
description 规则的描述 是 4.7.21
remoteSecurityGroupUuid 应用组间策略的远端安全组UUID 是 4.7.21
action 规则的默认动作 是
  • DROP
  • ACCEPT
 4.7.21
state 规则的状态 是
  • Enabled
  • Disabled
 4.7.21
priority 规则的优先级 是 4.7.21
protocol 规则的协议类型 是
  • ALL
  • TCP
  • UDP
  • ICMP
 4.7.21
srcIpRange 规则的源方向IP范围 是 4.7.21
dstIpRange 规则的目的方向IP范围 是 4.7.21
dstPortRange 规则的目的方向端口范围 是 4.7.21
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 4.7.21
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 4.7.21

修改安全组规则状态(ChangeSecurityGroupRuleState)

管理员可以使用ChangeSecurityGroupRuleState修改安全组规则状态。例如：
ChangeSecurityGroupRuleState securityGroupUuid=5309eb9abfea4694a1d589f1c3563553
ruleUuids='["uuid=1dd5d2e8229f445ca1779b9f977541b0","uuid=c7255fff6c194cb7adc33e28de68cc7e"]' state=Disabled

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
securityGroupUuid 安全组的UUID，唯一标示该资源 4.7.21
ruleUuids 规则的UUID列表 4.7.21
state 规则的状态 是
  • Enabled
  • Disabled
 4.7.21
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 4.7.21
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 4.7.21

更新安全组规则优先级(UpdateSecurityGroupRulePriority)

管理员可以使用UpdateSecurityGroupRulePriority更新安全组规则优先级。例如：
UpdateSecurityGroupRulePriority securityGroupUuid=5309eb9abfea4694a1d589f1c3563553 type='Ingress'
rules='[{"ruleUuid":"dbc5f1add1de4b848f69ca7507c56441","priority":1},{"ruleUuid":"c7255fff6c194cb7adc33e28de68cc7e","priority":2}]'

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
securityGroupUuid 安全组的UUID，唯一标示该资源 4.7.21
type 规则的类型
  • Ingress
  • Egress
 4.7.21
rules 规则的优先级 4.7.21
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupRuleVO 是 4.7.21
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupRuleVO 是 4.7.21

查询网卡的默认流量策略（QueryVmNicSecurityPolicy）

管理员可以使用QueryVmNicSecurityPolicy查询网卡的流量策略。例如：
QueryVmNicSecurityPolicy vmNic.uuid=853f9465c02946eaa30ece686d0aceb9

原生域查询（Primitive Fields of Query）

请参见网卡的流量策略(VmNicSecurityPolicy)

嵌套和扩展域查询（Nested and Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
vmNic vm nic inventory 应用了该安全组的网卡 4.7.21

修改网卡的默认流量策略(ChangeVmNicSecurityPolicy)

管理员可以使用ChangeVmNicSecurityPolicy修改网卡的流量策略。例如：
ChangeVmNicSecurityPolicy vmNicUuid=853f9465c02946eaa30ece686d0aceb9 ingressPolicy=DENY

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
vmNicUuid 网卡的UUID，唯一标示该资源 4.7.21
ingressPolicy 网卡入方向安全策略 是
  • DENY
  • ALLOW
 4.7.21
egressPolicy 网卡出方向安全策略 是
  • DENY
  • ALLOW
 4.7.21
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupVO 是 4.7.21
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupVO 是 4.7.21

设置网卡的安全组(SetVmNicSecurityGroup)

管理员可以使用SetVmNicSecurityGroup设置网卡的安全组。例如：
SetVmNicSecurityGroup vmNicUuid=3449c8442f5443e3b245cf3d80762e2f
refs='[{"securityGroupUuid": "5309eb9abfea4694a1d589f1c3563553","priority":1}]'

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
vmNicUuid 网卡的UUID，唯一标示该资源 4.7.21
refs 网卡挂载的安全组 4.7.21
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 SecurityGroupRuleVO 是 4.7.21
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 SecurityGroupRuleVO 是 4.7.21
上一篇VPC防火墙下一篇虚拟IP
CLI命令使用手册 | 5.5.30 | ZStack Cloud · ZCF | ZStack 资源中心