文档首页/ 虚拟私有云 VPC/ API参考/ API/ 安全组/ 查询安全组规则列表
更新时间:2024-10-11 GMT+08:00

查询安全组规则列表

功能介绍

查询安全组规则列表。

URI

GET /v1/{project_id}/security-group-rules

样例:
GET https://{Endpoint}/v1/{project_id}/security-group-rules?security_group_id=a7734e61-b545-452da3cd-0189cbd9747a&limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d
参数说明请参见表1
表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

项目ID,获取项目ID请参见获取项目ID

marker

String

分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。

marker需要和limit配合使用:

  • 若不传入marker和limit参数,查询结果返回第一页全部资源记录。
  • 若不传入marker参数,limit为10,查询结果返回第1~10条资源记录。
  • 若marker为第10条记录的资源ID,limit为10,查询结果返回第11~20条资源记录。
  • 若marker为第10条记录的资源ID,不传入limit参数,查询结果返回第11~2000条(limit默认值2000)资源记录。

limit

Integer

分页查询每页返回的记录个数,取值范围为0~intmax(2^31-1),默认值2000。

limit需要和marker配合使用,详细规则请见marker的参数说明。

security_group_id

String

功能说明:安全组标识

请求参数

请求示例

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

响应参数

名称

参数类型

说明

security_group_rules

Array of security_group_rule objects

安全组规则对象列表,请参见表2

表2 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、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。

响应示例

{
    "security_group_rules": [
        {
            "direction": "egress", 
            "ethertype": "IPv6", 
            "id": "3c0e45ff-adaf-4124-b083-bf390e5482ff", 
            "description": "",
            "port_range_max": null, 
            "port_range_min": null, 
            "protocol": null, 
            "remote_group_id": null, 
            "remote_ip_prefix": null, 
            "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", 
            "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
            "remote_address_group_id": null
        }, 
        {
            "direction": "egress", 
            "ethertype": "IPv4", 
            "id": "93aa42e5-80db-4581-9391-3a608bd0e448",
            "description": "", 
            "port_range_max": null, 
            "port_range_min": null, 
            "protocol": null, 
            "remote_group_id": null, 
            "remote_ip_prefix": null, 
            "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", 
            "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
            "remote_address_group_id": null
        }, 
        {
            "direction": "ingress", 
            "ethertype": "IPv6", 
            "id": "c0b09f00-1d49-4e64-a0a7-8a186d928138", 
            "description": "",
            "port_range_max": null, 
            "port_range_min": null, 
            "protocol": null, 
            "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", 
            "remote_ip_prefix": null, 
            "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", 
            "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
            "remote_address_group_id": null
        }, 
        {
            "direction": "ingress", 
            "ethertype": "IPv4", 
            "id": "f7d45c89-008e-4bab-88ad-d6811724c51c", 
            "description": "",
            "port_range_max": null, 
            "port_range_min": null, 
            "protocol": null, 
            "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", 
            "remote_ip_prefix": null, 
            "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", 
            "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
            "remote_address_group_id": null
        }
    ]
}

状态码

请参见状态码

错误码

请参考错误码