Tenant Cloud Network Virtual Private Cloud Network Parameter Template APIs DescribeAddressTemplates

DescribeAddressTemplates

Last Updated At: 2026-08-02 00:06:19

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

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

Default interface request rate limit: 100 times per second.

Interface update time: 2019-07-08 06:46:54.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeAddressTemplates
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
Filters No No Array of Filter Filter criteria.
  • address-template-name - String - (Filter criteria) IP address template name.
  • address-template-id - String - (Filter criteria) IP address template instance ID, e.g., ipm-mdunqeb6.

    • Example:View
    Offset No No String Offset. 0 by default.
    Example: 0
    Limit No No String Number of returns, 20 by default, up to 100.
    Example: 20

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of eligible instances.
    Example:
    AddressTemplateSet Array of AddressTemplate IP address template.
    Example:View
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue.Malformed Invalid input format.