DescribeSecurityIPGroupContent

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to perform a paging query for the IP address list in a designated IP group. When the number of IP addresses in the group exceeds 2000, you can use this API to perform a paging query to obtain the complete IP address list.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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: DescribeSecurityIPGroupContent.
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	Zone ID.
GroupId	Yes	Integer	Specifies the IP group ID.
Limit	No	Integer	Paginated query limit. default value: 2000, maximum value: 100000.
Offset	No	Integer	The offset of paginated query. Default value: 0.

3. Output Parameters

Parameter Name	Type	Description
IPTotalCount	Integer	Specifies the number of effective ips or IP ranges in the IP group.
IPList	Array of String	List of ips or ranges that meet the query conditions. limited by the Offset and Limit parameters.
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 IP or Ranges in an IP Group

This example shows you how to query the IP or IP range list in a group by specifying the GroupId. If the number of IPs or IP ranges exceeds 100000, you can gradually retrieve all data via paging query.

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityIPGroupContent
<Common request parameters>

{
    "ZoneId": "zone-nqicqhasui",
    "GroupId": 100121,
    "Limit": 1000,
    "Offset": 0
}

Output Example

{
    "Response": {
        "IPTotalCount": 5,
        "IPList": [
            "1.1.1.1",
            "1.2.3.1",
            "1.2.4.1",
            "1.5.3.1",
            "6.2.3.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.

Command Line Interface

Tencent Cloud CLI 3.0

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 IP or Ranges in an IP Group
5. Developer Resources
SDK
Command Line Interface
6. Error Code