tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAddressTemplateGroups

Last updated: 2024-11-25 20:04:26

    1. API Description

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

    This API (DescribeAddressTemplateGroups) is used to query an IP address template group.

    A maximum of 100 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: DescribeAddressTemplateGroups.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    Filters.N No Array of Filter Filter conditions.
  • address-template-group-name - String - (Filter condition) IP address template group name.
  • address-template-group-id - String - (Filter condition) IP address template group instance ID, such as ipmg-mdunqeb6.
    		•
    Offset No String Offset. The default value is 0.
    Limit No String Number of values to be returned. The default value is 20. Maximum is 100.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The number of instances meeting the filter condition.
    AddressTemplateGroupSet Array of AddressTemplateGroup IP address template.
    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 Query the list of IP address templates

    This example shows you how to query the list of IP address templates.

    Input Example

    https://vpc.intl.tencentcloudapi.com/?Action=DescribeAddressTemplateGroups
&Filters.0.Name=address-template-group-name
&Filters.0.Values.0=TestName
&Filters.1.Name=address-template-group-id
&Filters.1.Values.0=ipmg-mdunqeb6
&<common request parameters>

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "RequestId": "xx",
        "AddressTemplateGroupSet": [
            {
                "AddressTemplateGroupName": "test",
                "AddressTemplateGroupId": "ipmg-xxxxxxxx",
                "AddressTemplateIdSet": [
                    "ipm-xxxxxxxx",
                    "ipm-yyyyyyyy"
                ],
                "AddressTemplateSet": [
                    {
                        "AddressTemplateId": "ipm-xxxxxxxx",
                        "AddressTemplateName": "xxxxxxxx"
                    },
                    {
                        "AddressTemplateId": "ipm-yyyyyyyy",
                        "AddressTemplateName": "yyyyyyyy"
                    }
                ],
                "CreatedTime": "2022-12-06 20:00:00"
            }
        ]
    }
}

    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

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameter.FilterInvalidKey The specified filter condition does not exist.
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.Range The parameter value is not in the specified range.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy