DescribeSecurityGroups

DescribeSecurityGroups

1. API Description

This API is used to query the information of one or more specified security groups. Users can search for security group information based on information such as security group ID, security group name, etc.

2. Input Parameters

The following request parameter list only provides API request parameters.

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

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
dataSet	Array of SecurityGroupInfo	Information on security groups.
totalCount	Integer	Number of security groups meeting the filtering conditions.

4. Code Example

Example

Obtain all security group information. Query all security groups without any parameters.

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"],
          }
      ]
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.