# 查询安全组列表（废弃）
#### 功能介绍
查询安全组列表。
当前API已废弃，请使用"[查询安全组](https://support.huaweicloud.com/api-vpc/vpc_sg02_0001.html)"。
#### URI
GET /v2.1/{project_id}/os-security-groups
参数说明请参见[表1]。
 表1参数说明 
| 参数                                 | 是否必选                     | 描述                                                                                                              |
|:---|:---|:---|
| project_id | 是 | 项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-ecs/ecs_01_0016.html)。 |
   
![](https://support.huaweicloud.com/api-ecs/public_sys-resources/note_3.0-zh-cn.png)
不支持分页查询。
#### 请求消息
不涉及
#### 响应消息
响应参数如[表2]所示。
 表2响应参数 
| 参数       | 参数类型       | 描述                                                                      |
|:---|:---|:---|
| security_groups | Array of objects | security_group列表，参见[表3]。 |
   
 表3security_group对象 
| 参数                            | 参数类型                                    | 描述                                                                                     |
|:---|:---|:---|
| description | String          | 安全组描述信息，长度0-255                                                     |
| id          | String          | 安全组ID，UUID格式。                                                       |
| name       | String          | 安全组名字，长度0-255                                                       |
| rules      | Array of objects | 安全组规则列表，参见[表4]。 |
| tenant_id  | String          | 租户ID或项目ID                                                           |
   
 表4security_group_rule对象 
| 参数                                       | 参数类型                            | 描述                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|
| parent_group_id | String  | 相关联的安全组ID，UUID格式。                                                                                                                                                                                                                                                                                                                                 |
| ip_protocol     | String   | 协议类型或直接指定IP协议号，取值可为icmp，tcp，udp或IP协议号。                                                                                                                                                                                                                                                                                                            |
| from_port       | Integer | 起始端口，范围1-65535，且不大于to_port。 ip_protocol设置为icmp时，from_port表示ICMP类型字段（type），范围是0-255。 说明： ICMP的消息类型由报文中的类型字段和代码字段共同决定，具体映射关系请参见《虚拟私有云API参考》的"附录 \> 安全组规则icmp协议名称对应关系表"章节。其中，字段**port_range_min** 表示ICMP的类型字段，**port_range_max**表示ICMP的代码字段。 |
| to_port          | Integer | 终止端口，范围1-65535，且不小于from_port。 ip_protocol设置为icmp时，to_port表示ICMP代码字段（code），范围是0-255。 说明： ICMP的消息类型由报文中的类型字段和代码字段共同决定，具体映射关系请参见《虚拟私有云API参考》的"附录 \> 安全组规则icmp协议名称对应关系表"章节。其中，字段**port_range_min** 表示ICMP的类型字段，**port_range_max**表示ICMP的代码字段。                      |
| ip_range         | Object  | 对端IP网段，cidr格式，参见[表5]。 约束：ip_range和group两个参数二选一。                                                                                                                                                                                     |
| group           | Object  | 对端安全组的名称和对端安全组所属租户的租户ID，参见[表6]。 约束：ip_range和group两个参数二选一。                                                                                                                                                                          |
| id                | String  | 安全组规则ID，UUID格式。                                                                                                                                                                                                                                                                                                                                   |
   
 表5ip_range对象 
| 参数                         | 参数类型                          | 描述                                      |
|:---|:---|:---|
| cidr | String | 对端IP网段，cidr格式。 |
   
 表6group对象 
| 参数                                | 参数类型                            | 描述                                       |
|:---|:---|:---|
| tenant_id | String | 对端安全组所属租户的租户ID。 |
| name      | String | 对端安全组的名称。       |
   
#### 请求示例
```
GET https://{endpoint}/v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups
```
#### 响应示例
```
{
    "security_groups": [
        {
            "rules": [
                {
                    "from_port": null,
                    "group": {
                        "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
                        "name": "default"
                    },
                    "ip_protocol": null,
                    "to_port": null,
                    "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450",
                    "ip_range": {},
                    "id": "bb3cc988-e06a-49f6-b668-600e8bf193ee"
                },
                {
                    "from_port": null,
                    "group": {
                        "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
                        "name": "default"
                    },
                    "ip_protocol": null,
                    "to_port": null,
                    "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450",
                    "ip_range": {},
                    "id": "f9371051-d7e1-4be4-8748-77b1e0913730"
                }
            ],
            "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
            "description": "default",
            "id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450",
            "name": "default"
        },
        {
            "rules": [
                {
                    "from_port": 200,
                    "group": {},
                    "ip_protocol": "tcp",
                    "to_port": 400,
                    "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5",
                    "ip_range": {
                        "cidr": "0.0.0.0/0"
                    },
                    "id": "3330120d-bbd1-4a73-bda9-0196a84d5670"
                },
                {
                    "from_port": 201,
                    "group": {},
                    "ip_protocol": "tcp",
                    "to_port": 400,
                    "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5",
                    "ip_range": {
                        "cidr": "0.0.0.0/0"
                    },
                    "id": "b550c9a6-970a-462d-984e-265e88020818"
                }
            ],
            "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
            "description": "desc-sg",
            "id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5",
            "name": "test-sg"
        }
    ]
}
```
#### 返回值
请参考[通用请求返回值](https://support.huaweicloud.com/api-ecs/ecs_07_0001.html)。