有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(DescribeAddressTemplates)用于查询IP地址模板。

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

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

2. 输入参数

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

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

    3. 输出参数

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

    4. 示例

    示例1 查询IP地址模板

    查询IP地址模板

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeAddressTemplates
    &Filters.0.Name=address-template-name
    &Filters.0.Values.0=TestName
    &Filters.1.Name=address-template-id
    &Filters.1.Values.0=ipm-mdunqeb6
    &<公共请求参数>

    输出示例

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

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    UnsupportedOperation 操作不支持。