# DescribeSecurityGroups

## 1. API Description

This API (DescribeSecurityGroups) is used to query security group information in the account. You can filter results by security group ID or name. Supports pagination.

## 2. Input Parameters

The following request parameter list only provides API request parameters.

| Parameter Name    | Required | Type            | Description                                                                                                                              |
| ----------------- | -------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| securityGroupIds  | No       | Array of String | <p>The security group ID.</p><p>Values can consist of multiple security group IDs. The maximum number of IDs in each request is 100.</p> |
| securityGroupName | No       | String          | Security group name.                                                                                                                     |
| pageSize          | No       | Integer         | <p>Number of items in the current page result.</p><p>Default value: 20 ;</p><p>Maximum value: 1000 .</p><p>Default value: 20</p>         |
| pageNum           | No       | Integer         | <p>Number of pages returned.</p><p>Default value: 1 .</p><p>Default value: 1</p>                                                         |

## 3. Output Parameters

| Parameter Name | Type                                                                                        | Description                                                                                                           |
| -------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| requestId      | String                                                                                      | <p>The unique request ID, which is returned for each request.</p><p>RequestId is required for locating a problem.</p> |
| totalCount     | Integer                                                                                     | Number of security groups meeting the filtering conditions.                                                           |
| dataSet        | Array of [SecurityGroupInfo](/api-reference/compute/zec/datastructure.md#securitygroupinfo) | Information on security groups.                                                                                       |

## 4. Code Example

{% tabs %}
{% tab title="Example" %}
**Obtain all security group information. Query all security groups without any parameters.**

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

Request：
{
  "securityGroupIds": [],
  "securityGroupName": "",
  "pageSize": 5,
  "pageNum": 1
}

Response:
{
  "requestId": "T4237F94B-6A3B-4BD6-A9D5-398F4A049714",
  "response": {
      "requestId": "T4237F94B-6A3B-4BD6-A9D5-398F4A049714",
      "totalCount": 1,
      "dataSet": [
          {
              "securityGroupId": "<securityGroupId>",
              "securityGroupName": "Default-Security-Group",
              "isDefault": true,
              "nicIdList": ["xxx"],
              "createTime": "2024-08-14T02:31:57Z",
              "scope": "Global",
              "natIdList": ["xxx"],
              "vpcIds": ["xxx"],
              "loadBalancerIdList": ["xxx"],
              "haVipIdList": ["havip-xxxxxxxx"]
          }
      ]
  }
}
```

{% endtab %}
{% endtabs %}

## 5. Developer Resources

Zenlayer Cloud API 2.0 integrates [SDKs](/api-reference/api-introduction/toolkit/api-sdk.md)，to make it easier for you to call APIs. More programming languages will be supported.

## 6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see [Common Error Codes](/api-reference/api-introduction/instruction/commonerrorcode.md).

| HTTP Status Code | Error Code | Description |
| ---------------- | ---------- | ----------- |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.console.zenlayer.com/api-reference/compute/zec/security-group/describesecuritygroups.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.