tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud EdgeOne
    Documentation
    Download PDF

    DescribeSecurityIPGroupInfo

    Last updated:
    Download PDF

      1. API Description

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

      This API is used to query the configuration information of an IP group, including the IP group name, IP group content, and the site the IP group belongs to.

      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: DescribeSecurityIPGroupInfo.
      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 query scope.
      Limit No Integer Maximum number of entries returned in a single response. Default value: 20. Maximum query entries: 1000.
      Offset No Integer The starting entry offset for pagination queries. The default value is 0.

      3. Output Parameters

      Parameter Name Type Description
      TotalCount Integer The number of IP groups that meet the conditions.
      IPGroups Array of IPGroup Detailed configuration information of the IP group, including the ID, name, and IP/network segment list of each 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 an IP group

      This example shows you how to query the IP group configuration information for the specified site, and return the content of the first page with 10 records per page.

      Input Example

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

{
    "ZoneId": "zone-20hyebgyfsko",
    "Limit": 10,
    "Offset": 0
}

      Output Example

      {
    "Response": {
        "TotalCount": 1,
        "IPGroups": [
            {
                "GroupId": 123,
                "Name": "ExampleIpGroup",
                "Content": [
                    "123.123.123.0",
                    "23.23.23.0/24"
                ]
            }
        ],
        "RequestId": "5e5a0d0f-52f3-4bad-9bd3-dcf1d5c954e7"
    }
}

      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

      6. Error Code

      There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy