文档中心>私有网络>API 文档>私有网络相关接口>查看子网或者vpc内IP使用情况

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

最近更新时间:2024-03-12 02:02:48

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUsedIpAddress。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
VpcId String VPC实例ID。
示例值:vpc-a26u781x
SubnetId String 子网实例ID。
示例值:subnet-amqye6ew
IpAddresses.N Array of String 查询是否占用的ip列表,ip需要在vpc或子网内。最多允许一次查询100个IP。
示例值:["192.168.2.10", "10.0.1.10"]
Filters.N Array of Filter 过滤条件,不支持同时指定IpAddresses和Filters参数。 支持的过滤条件如下:
  • ip-addresses:IP地址。
  • resource-id:资源ID。
  • Offset Integer 偏移量,默认为0。
    示例值:0
    Limit Integer 返回数量,默认为20,最大值为100。
    示例值:10

    3. 输出参数

    参数名称 类型 描述
    IpAddressStates Array of IpAddressStates 占用ip地址的资源信息
    注意:此字段可能返回 null,表示取不到有效值。
    TotalCount Integer 返回占用资源的个数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询子网下的ip使用情况,查询3个ip,只有2个ip被占用并返回资源信息

    查询子网下的ip使用情况,查询3个ip,只有2个ip被占用并返回资源信息

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeUsedIpAddress
    <公共请求参数>
    
    {
        "VpcId": "vpc-bx0vq623",
        "SubnetId": "subnet-dl3wd0vq",
        "IpAddresses": [
            "10.0.0.1",
            "10.0.0.2"
        ]
    }

    输出示例

    {
        "Response": {
            "IpAddressStates": [
                {
                    "VpcId": "vpc-bx0vq623",
                    "SubnetId": "subnet-dl3wd0vq",
                    "IpAddress": "10.0.0.1",
                    "ResourceType": "ENI",
                    "ResourceId": "eni-bjekqff1"
                },
                {
                    "VpcId": "vpc-bx0vq623",
                    "SubnetId": "subnet-dl3wd0vq",
                    "IpAddress": "10.0.0.2",
                    "ResourceType": "ENI",
                    "ResourceId": "eni-bjekqff2"
                }
            ],
            "TotalCount": 2,
            "RequestId": "2aaa54f5-2809-4b95-b3a5-13ce72d05759"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

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