租户端 网络 私有网络（VPC） 私有网络相关接口 查看子网或者vpc内IP使用情况

查看子网或者vpc内IP使用情况

最近更新时间: 2026-07-12 00:27:07

1. 接口描述

接口请求域名： vpc.api3.fincloud.tencent.com。

本接口(DescribeUsedIpAddress)用于查询Subnet或者Vpc内的ip的使用情况，
如ip被占用，返回占用ip的资源类别与id；如未被占用，返回空值

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

接口更新时间：2025-09-01 11:37:29。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeUsedIpAddress
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Filters 否 是 Array of Filter 过滤条件，不支持同时指定IpAddresses和Filters参数。 支持的过滤条件如下： 
  • ip-addresses：IP地址。
    •  
  • resource-id：资源ID。

    • 示例值：查看
    Offset 否 是 Uint64 偏移量，默认为0。
    示例值： 0
    Limit 否 是 Uint64 返回数量，默认为20，最大值为100。
    示例值： 10
    VpcId 是 是 String VPC实例ID。
    示例值： vpc-a26u781x
    SubnetId 否 是 String 子网实例ID。
    示例值： subnet-amqye6ew
    IpAddresses 否 是 Array of String 查询是否占用的ip列表，ip需要在vpc或子网内。最多允许一次查询100个IP。
    示例值： ["192.168.2.10", "10.0.1.10"]

    3. 输出参数

    参数名称 类型 描述
    IpAddressStates Array of IpAddressStates 占用ip地址的资源信息
    示例值：查看
    TotalCount Uint64 返回占用资源的个数
    示例值： 1
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

    错误码 描述
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.ParameterMismatch