PrevNext
search by keyword

Recent Pages

Documentation
Virtual Private Cloud
    Documentation
    Download PDF

    DescribeAddressTemplateGroups

    Last updated: 2022-01-18 17:05:22
    Download PDF

    1. API Description

    Domain name for API request: vpc.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.
    This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: DescribeAddressTemplateGroups.
    Version Yes String Common parameter. The value used for this API: 2017-03-12.
    Region Yes String Common parameter. 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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying an IP address template group

    Input Example

    https://vpc.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": [
      {
        "CreatedTime": "2020-12-03 16:12:15",
        "AddressTemplateGroupName": "test1",
        "AddressTemplateIdSet": [
          "ipm-mdunqeb6"
        ],
        "AddressTemplateSet": [
          {
            "To": "10.1.1.2/22",
            "From": "10.1.1.3/22"
          }
        ],
        "AddressTemplateGroupId": "ipmg-ivrc58q8"
      }
    ]
  }
}

    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.
    tencent
    Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy