私有网络查询IP地址模板集合-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： vpc.tencentcloudapi.com 。

本接口（DescribeAddressTemplateGroups）用于查询IP地址模板集合。

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAddressTemplateGroups。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of Filter	过滤条件。 address-template-group-name - String - （过滤条件）IP地址模板集合名称。 address-template-group-id - String - （过滤条件）IP地址模板实集合例ID，例如：ipmg-mdunqeb6。
Offset	否	String	偏移量，默认为0。示例值：1
Limit	否	String	返回数量，默认为20，最大值为100。示例值：20
NeedMemberInfo	否	Boolean	是否查询IP地址模板成员标识。示例值：False

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的实例数量。示例值：10
AddressTemplateGroupSet	Array of AddressTemplateGroup	IP地址模板。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询IP地址模板集合

查询IP地址模板集合

输入示例

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
&<公共请求参数>

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter.FilterInvalidKey	指定过滤条件不存在。
InvalidParameterValue.Malformed	入参格式不合法。
InvalidParameterValue.Range	参数值不在指定范围。