DescribeSecurityIPGroup
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query the configuration information of a security IP group, including the ID, name and content of the security IP group. The query result of this API only returns up to 2000 IPs or CIDR blocks for each IP group. If there is a very large IP group exceeding 2000 IPs or CIDR blocks, call DescribeSecurityIPGroupContent to perform a paging query.
A maximum of 20 requests can be initiated per second for this API.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeSecurityIPGroup. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | Site ID, used to specify the scope of the queried site. |
| GroupIds.N | No | Array of Integer | Specifies the security ip group id. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| IPGroups | Array of IPGroup | Detailed configuration information of security IP groups, including the ID, name, total number of IP/IP ranges, IP/IP range list information, and expiration time of each security IP group. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying the Configuration Information of ALL Security IP Groups under a Site
This example shows you how to query the configuration information of ALL security IP groups in a specified site.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityIPGroup
<Common request parameters>
{
"ZoneId": "zone-nqicqhasui"
}
Output Example
{
"Response": {
"IPGroups": [
{
"GroupId": 97,
"Name": "ExampleIpGroup",
"IPTotalCount": 2,
"Content": [
"2.2.2.2",
"23.23.23.0/24"
],
"IPExpireInfo": [
{
"ExpireTime": "2026-03-24T16:03:00+08:00",
"IPList": [
"2.2.2.2"
]
}
]
}
],
"RequestId": "ddf831fc-cf45-40fe-81b0-2d9cdd4c1bd6"
}
}
Example2 Querying the Configuration Information of Security IP Groups with Specified ID
This example shows you how to query the configuration information of security IP groups with specified ID in a site.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityIPGroup
<Common request parameters>
{
"ZoneId": "zone-ncacqeabax",
"GroupIds": [
100,
200
]
}
Output Example
{
"Response": {
"IPGroups": [
{
"GroupId": 100,
"Name": "ExampleIpGroup-1",
"IPTotalCount": 2,
"Content": [
"2.2.2.2",
"23.23.23.0/24"
],
"IPExpireInfo": [
{
"ExpireTime": "2026-03-24T16:03:00+08:00",
"IPList": [
"2.2.2.2"
]
}
]
},
{
"GroupId": 200,
"Name": "ExampleIpGroup-2",
"IPTotalCount": 2,
"Content": [
"1.1.1.1",
"23.23.23.0/24"
],
"IPExpireInfo": [
{
"ExpireTime": "2025-03-24T16:03:00+08:00",
"IPList": [
"1.1.1.1"
]
}
]
}
],
"RequestId": "ddf831fc-cf45-40fe-81b0-2d9cdd4c1bd6"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
- 1. API Description
- 2. Input Parameters
- 3. Output Parameters
- 4. Example
- Example1 Querying the Configuration Information of ALL Security IP Groups under a Site
- Example2 Querying the Configuration Information of Security IP Groups with Specified ID
- 5. Developer Resources
- SDK
- Command Line Interface
- 6. Error Code