tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSecurityIPGroup

Last updated: 2024-12-03 16:17:21

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.

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: 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 ID of a security IP group.
  • When this parameter is provided, only the configuration of the security IP group with the specified ID is queried.
  • When this parameter is not provided, information of all security IP groups under the site is returned.
    		•

    3. Output Parameters

    Parameter Name Type Description
    IPGroups Array of IPGroup Detailed configuration information of security IP groups, including the ID, name, and IP/IP range list information 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 security IP groups

    This example shows you how to query the configuration information of security IP groups in a specified site.

    Input Example

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

{
    "ZoneId": "zone-nqicqhasui"
}

    Output Example

    {
    "Response": {
        "IPGroups": [
            {
                "GroupId": 123,
                "Name": "ExampleIpGroup",
                "Content": [
                    "2.2.2.2",
                    "23.23.23.0/24"
                ]
            }
        ],
        "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

    6. Error Code

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

    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy