> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/compute/vm/security-group/describesecuritygroups.md).

# DescribeSecurityGroups

## 1. 接口描述

本接口(DescribeSecurityGroups)用于查询一个或多个指定安全组的信息。用户可以根据安全组ID、安全组名称等信息来搜索安全组信息。

## 2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

| 参数名称              | 必选 | 类型              | 描述                                     |
| ----------------- | -- | --------------- | -------------------------------------- |
| securityGroupIds  | 否  | Array of String | <p>安全组ID集合。</p><p>最多支持100个ID查询。</p>    |
| securityGroupName | 否  | String          | 安全组名称。                                 |
| pageSize          | 否  | Integer         | <p>返回的分页大小。</p><p>默认为20，最大为1000。</p>   |
| pageNum           | 否  | Integer         | <p>返回的分页数。</p><p>默认为1。</p><p>默认值：1</p> |

## 3. 响应结果

| 参数名称       | 类型                                                                                            | 描述                                                       |
| ---------- | --------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| requestId  | String                                                                                        | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| totalCount | Integer                                                                                       | 符合条件的数据总数。                                               |
| dataSet    | Array of [SecurityGroupInfo](/api-reference/cn/compute/vm/datastructure.md#securitygroupinfo) | 安全组结果集。                                                  |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 获取所有安全组。**

```json
POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeSecurityGroups
<Common Request Params>

Request:
{
  "securityGroupIds": null,
  "securityGroupName": null,
  "pageSize": 5,
  "pageNum": 1
}

Response:
{
  "requestId": "T7977AF93-01C3-4862-A178-03953A4901C3",
  "response": {
    "requestId": "T7977AF93-01C3-4862-A178-03953A4901C3",
    "dataSet": [
      {
        "securityGroupId": "your-sucerity-id",
        "securityGroupName": "123",
        "securityGroupStatus": "Available",
        "createTime": "2022-01-01T01:00:00Z",
        "description": null,
        "instanceIds": [
          "your-instance-id"
        ],
        "ruleInfos": [
          {
            "ruleId": 120,
            "direction": "ingress",
            "policy": "drop",
            "ipProtocol": "all",
            "portRange": "-1/-1",
            "cidrIp": "0.0.0.0/0"
          },
          {
            "ruleId": 124,
            "direction": "ingress",
            "policy": "accept",
            "ipProtocol": "tcp",
            "portRange": "80/80",
            "cidrIp": "0.0.0.0/0"
          }
        ]，
        "isDefault": true
      }
    ],
    "totalCount": 1
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](/api-reference/cn/api-introduction/toolkit.md)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](/api-reference/cn/api-introduction/instruction/commonerrorcode.md)

| HTTP状态码 | 错误码 | 说明 |
| ------- | --- | -- |