DescribeAddressTemplates

Last updated: 2021-07-23 10:23:58

1. API Description

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

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

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeAddressTemplates.
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-name - String - (Filter condition) IP address template name. address-template-id - String - (Filter condition) IP address template instance ID, such as `ipm-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.
AddressTemplateSet	Array of AddressTemplate	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

Input Example

https://vpc.tencentcloudapi.com/?Action=DescribeAddressTemplates
&Version=2017-03-12
&Filters.0.Name=address-template-name
&Filters.0.Values.0=TestName
&Filters.1.Name=address-template-id
&Filters.1.Values.0=ipm-mdunqeb6
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 1,
    "AddressTemplateSet": [
      {
        "AddressTemplateName": "TestName",
        "AddressTemplateId": "ipm-mdunqeb6",
        "AddressSet": [
          "192.168.0.0/16",
          "192.128.8.8/17"
        ],
        "CreatedTime": "2017-12-31 10:06:05"
      }
    ],
    "RequestId": "20569756-56ba-4a13-b545-e1528d5cb239"
  }
}

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

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.LimitExceeded	The parameter value exceeds the limit.
InvalidParameterValue.Malformed	Invalid input parameter format.
InvalidParameterValue.Range	The parameter value is not in the specified range.

Recent Pages