文档首页/ 虚拟私有云 VPC/ API参考/ API/ 安全组/ 查询安全组规则
更新时间：2024-05-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询安全组规则

功能介绍

查询单个安全组规则。

调试

您可以在API Explorer中调试该接口。

URI

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

参数说明请参见表1。
表1 参数说明

名称

是否必选

说明

project_id

是

项目ID，获取项目ID请参见获取项目ID。

security_group_rule_id

是

安全组规则唯一标识

请求参数

无

请求示例

GET https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62

响应参数

表2 响应参数

名称

参数类型

说明

security_group_rule

security_group_rule object

安全组规则对象，请参见表3。

表3 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。

响应示例

{
    "security_group_rule": {
        "direction": "ingress", 
        "ethertype": "IPv4", 
        "id": "2bc0accf-312e-429a-956e-e4407625eb62", 
        "description":"",
        "port_range_max": 80, 
        "port_range_min": 80, 
        "protocol": "tcp", 
        "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", 
        "remote_ip_prefix": null, 
        "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a", 
        "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
        "remote_address_group_id": null
    }
}

状态码

请参见状态码。

错误码

请参考错误码。

父主题： 安全组

相关文档