文档首页/ 虚拟私有云 VPC/ API参考/ API V3/ 安全组规则/ 查询安全组规则列表
更新时间：2025-02-07 GMT+08:00
查看PDF
分享

查询安全组规则列表

功能介绍

查询安全组规则列表。

URI

GET /v3/{project_id}/vpc/security-group-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方式请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

  • 功能说明：每页返回个数。

  • 取值范围：0-2000。

marker

否

String

分页查询起始的资源ID，为空时查询第一页。

id

否

Array of strings

  • 功能说明：安全组规则ID，支持多个ID过滤。

security_group_id

否

Array of strings

  • 功能说明：安全组规则所属安全组ID，支持多个ID过滤。

protocol

否

Array of strings

  • 功能说明：安全组规则协议，支持多条过滤。

description

否

Array of strings

  • 功能说明：安全组描述新增。可以使用该字段精确过滤安全组，支持传入多个描述进行过滤。

remote_group_id

否

Array of strings

  • 功能说明：远端安全组ID，支持多ID过滤。

direction

否

String

  • 功能说明：安全组规则方向。

  • 取值范围：ingress表示入方向，egress表示出方向。

action

否

String

  • 功能说明：安全组规则生效策略。

  • 取值范围：allow表示允许，deny表示拒绝。

remote_ip_prefix

否

String

  • 功能说明：远端IP地址。

  • 取值范围：cidr格式。

priority

否

Array of integers

  • 功能说明：优先级，支持多条过滤。

ethertype

否

Array of strings

  • 功能说明：IP协议类型，支持多条过滤。

  • 取值范围：IPv4,IPv6,ipv4,ipv6

remote_address_group_id

否

Array of strings

  • 功能说明：远端IP地址组ID，支持多ID过滤。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

security_group_rules

Array of SecurityGroupRule objects

安全组规则列表响应体。

page_info

PageInfo object

分页信息。
表4 SecurityGroupRule

参数

参数类型

描述

id

String

  • 功能描述：安全组规则对应的唯一标识。

  • 取值范围：带“-”的标准UUID格式。

description

String

  • 功能说明：安全组规则的描述信息。

  • 取值范围：0-255个字符，不能包含“<”和“>”。

security_group_id

String

  • 功能说明：安全组规则所属的安全组ID。

direction

String

  • 功能说明：安全组规则的出入控制方向。

  • 取值范围：

    • ingress 表示入方向。

    • egress 表示出方向。

protocol

String

  • 功能说明：协议类型。

  • 取值范围：icmp、tcp、udp、icmpv6或IP协议号。

  • 约束：为空表示支持所有协议。协议为icmpv6时，网络类型应该为IPv6；协议为icmp时，网络类型应该为IPv4。

ethertype

String

  • 功能说明：IP地址协议类型。

  • 取值范围：IPv4，IPv6。

  • 约束：不填默认值为IPv4。

multiport

String

  • 功能说明：端口取值范围。

  • 取值范围：支持单端口(80)，连续端口(1-30)以及不连续端口(22,3389,80)。

action

String

  • 功能说明：安全组规则生效策略。

  • 取值范围：

    • allow 表示允许。

    • deny 表示拒绝。

  • 约束：默认值为deny。

priority

Integer

  • 功能说明：优先级。

  • 取值范围：1~100，1代表最高优先级。

remote_group_id

String

  • 功能说明：远端安全组ID，表示该安全组内的流量允许或拒绝。

  • 取值范围：租户下存在的安全组ID。

  • 约束：与remote_ip_prefix，remote_address_group_id功能互斥。

remote_ip_prefix

String

  • 功能说明：远端IP地址，

    • 当direction是egress时为虚拟机访问端的地址；

    • 当direction是ingress时为访问虚拟机的地址。

  • 取值范围：IP地址，或者cidr格式。

  • 约束：与remote_group_id、remote_address_group_id功能互斥。

remote_address_group_id

String

  • 功能说明：远端地址组ID。

  • 取值范围：租户下存在的地址组ID。

  • 约束：与remote_ip_prefix，remote_group_id功能互斥。

created_at

String

  • 功能说明：安全组规则创建时间。

  • 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ssZ。

updated_at

String

  • 功能说明：安全组规则更新时间。

  • 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ssZ。

project_id

String

  • 功能说明：安全组规则所属项目ID。
表5 PageInfo

参数

参数类型

描述

previous_marker

String

当前页第一条记录。

current_count

Integer

当前页总数。

next_marker

String

当前页最后一条记录，最后一页时无next_marker字段。

请求示例

查询安全组规则列表。

GET https://{Endpoint}/v3/{project_id}/vpc/security-group-rules

响应示例

状态码：200

GET操作正常返回，更多状态码请参见状态码。

  • {
  "request_id" : "80747d36e3376c0894ba8f9a9156355d",
  "security_group_rules" : [ {
    "id" : "f626eb24-d8bd-4d26-ae0b-c16bb65730cb",
    "project_id" : "060576782980d5762f9ec014dd2f1148",
    "security_group_id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
    "direction" : "ingress",
    "protocol" : "tcp",
    "description" : "security group rule description",
    "created_at" : "2020-08-13T07:12:36.000+00:00",
    "updated_at" : "2020-08-13T07:12:36.000+00:00",
    "ethertype" : "IPv4",
    "remote_ip_prefix" : "10.10.0.0/16",
    "multiport" : 333,
    "action" : "allow",
    "priority" : 1,
    "remote_group_id" : null,
    "remote_address_group_id" : null
  } ]
}

状态码

状态码

描述

200

GET操作正常返回，更多状态码请参见状态码。

错误码

请参见错误码。

父主题： 安全组规则