虚拟私有云 VPC-查询安全组列表:响应参数

时间:2024-10-12 09:48:13

响应参数

表2 响应参数

名称

参数类型

说明

security_groups

Array of security_group objects

安全组列表对象,请参见表3

表3 security_group字段说明

名称

参数类型

说明

name

String

安全组名称。

description

String

安全组描述。

id

String

安全组唯一标识。

vpc_id

String

安全组所在的vpc的资源标识。

说明:

当前该参数只作提示用,不约束安全组在此vpc下,不建议继续使用。

security_group_rules

Array of security_group_rule objects

默认安全组规则列表,保证安全组内互通。

enterprise_project_id

String

  • 功能说明:企业项目ID。创建安全组时,给安全组绑定企业项目ID。
  • 取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。
说明:

关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》

表4 security_group_rule对象

名称

参数类型

说明

id

String

安全组规则标识。

description

String

  • 功能说明:安全组规则描述。
  • 取值范围:0-255个字符,支持数字、字母、中文字符。

security_group_id

String

安全组标识。

direction

String

  • 功能说明:出入控制方向。
  • 取值范围:
    • egress:出方向
    • ingress:入方向

ethertype

String

  • 功能说明:IP协议类型。
  • 取值范围:IPv4,IPv6

protocol

String

  • 功能说明:协议类型。
  • 取值范围:icmp、tcp、udp、icmpv6、IP协议号(0~255)(如gre协议号为47)。
  • 约束:为空表示支持所有协议。

port_range_min

Integer

port_range_max

Integer

  • 功能说明:结束端口值。
  • 取值范围:1~65535
  • 约束:协议不为icmp时,取值不能小于port_range_min的值,为空表示所有端口,如果协议是icmp类型,取值范围请参见安全组规则icmp协议名称对应关系表

remote_ip_prefix

String

  • 功能说明:远端IP地址,当direction是egress时为虚拟机访问端的地址,当direction是ingress时为访问虚拟机的地址。
  • 取值范围:IP地址,或者cidr格式
  • 约束:和remote_group_id,remote_address_group_id互斥。

remote_group_id

String

  • 功能说明:对端安全组id。
  • 约束:和remote_ip_prefix,remote_address_group_id互斥。

remote_address_group_id

String

  • 功能说明:远端IP地址组ID。
  • 约束:和remote_ip_prefix,remote_group_id互斥。

tenant_id

String

  • 功能说明:安全组规则所属项目ID。
support.huaweicloud.com/api-vpc/vpc_sg01_0003.html