文档中心>API 中心>专线接入>专线接入相关接口>获取用户互联网公网地址信息

获取用户互联网公网地址信息

最近更新时间:2025-01-14 01:13:46

我的收藏

1. 接口描述

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

获取用户互联网公网地址信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInternetAddress。
Version String 公共参数,本接口取值:2018-04-10。
Region String 公共参数,此参数为可选参数。
Offset Integer 偏移量,默认为0
示例值:0
Limit Integer 返回数量,默认为20,最大值100
示例值:20
Filters.N Array of Filter 过滤条件:
  • AddrType,地址类型。0:BGP 1;1: 电信;2:移动;3:联通
  • AddrProto,地址类型。0:IPv4;1:IPv6
  • Status,地址状态。 0:使用中;1:已停用; 2:已退还
  • Subnet,互联网公网地址。数组
  • InstanceIds,互联网公网地址ID。数组
  • 3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 互联网公网地址数量
    示例值:1
    Subnets Array of InternetAddressDetail 互联网公网地址列表
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 通过远程出口过滤用户IP段

    通过远程出口过滤用户IP段

    输入示例

    POST / HTTP/1.1
    Host: dc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeInternetAddress
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Values": [
                    "nj-1"
                ],
                "Name": "RemoteArea"
            }
        ]
    }

    输出示例

    {
        "Response": {
            "Subnets": [
                {
                    "Subnet": "2402:4e00:4020::",
                    "Region": "nj",
                    "ApplyTime": "2022-08-17 10:44:02",
                    "StopTime": "00-00-00 00:00:00",
                    "ReleaseTime": "00-00-00 00:00:00",
                    "Status": 1,
                    "AddrType": 0,
                    "MaskLen": 64,
                    "ReserveTime": 8,
                    "InstanceId": "ipv6-0yiowoa9",
                    "AppId": 251009028,
                    "AddrProto": 1
                },
                {
                    "Subnet": "10.10.10.0",
                    "Region": "nj",
                    "ApplyTime": "2022-08-16 20:24:54",
                    "StopTime": "00-00-00 00:00:00",
                    "ReleaseTime": "00-00-00 00:00:00",
                    "Status": 1,
                    "AddrType": 1,
                    "MaskLen": 30,
                    "ReserveTime": 8,
                    "InstanceId": "ipv4-ljm17pbl",
                    "AppId": 251009028,
                    "AddrProto": 0
                }
            ],
            "RequestId": "eee7d064-e3ae-4020-8db9-dc0cf245ccd2",
            "TotalCount": 2
        }
    }

    示例2 获取用户申请的公网地址信息

    获取用户申请的公网地址信息

    输入示例

    https://dc.tencentcloudapi.com/?Action=DescribeInternetAddress
    &Limit=20
    &Offset=1
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "Subnets": [
                {
                    "Status": 0,
                    "Subnet": "220.110.1.0",
                    "MaskLen": 30,
                    "AddrType": 0,
                    "AppId": 251010426,
                    "InstanceId": "ipv4-qmda2nqv",
                    "AddrProto": 0,
                    "StopTime": "2020-09-22 00:00:00",
                    "Region": "gz",
                    "ApplyTime": "2020-09-22 00:00:00",
                    "ReleaseTime": "2020-09-22 00:00:00",
                    "ReserveTime": 8
                }
            ],
            "RequestId": "24a0d7e5-4c13-49be-aa16-94f698fbef3e"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

    该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码