查询VPC内网IP信息

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

我的收藏

1. 接口描述

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

本接口(DescribeVpcPrivateIpAddresses)用于查询VPC内网IP信息。

只能查询已使用的IP信息,当查询未使用的IP时,本接口不会报错,但不会出现在返回结果里。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVpcPrivateIpAddresses。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
VpcId String VPC实例ID,形如:vpc-f49l6u0z
示例值:vpc-rkxd3pgh
PrivateIpAddresses.N Array of String 内网IP地址列表,批量查询单次请求最多支持10个。
示例值:["10.4.2.2\n","10.4.2.3\n","10.4.2.17\n"]

3. 输出参数

参数名称 类型 描述
VpcPrivateIpAddressSet Array of VpcPrivateIpAddress 内网IP地址信息列表。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 批量查询VPC内网IP信息

批量查询VPC内网IP信息

输入示例

https://vpc.tencentcloudapi.com/?Action=DescribeVpcPrivateIpAddresses
&VpcId=vpc-rkxd3pgh
&PrivateIpAddresses.0=10.4.2.2
&PrivateIpAddresses.1=10.4.2.3
&PrivateIpAddresses.2=10.4.2.17
&<公共请求参数>

输出示例

{
    "Response": {
        "VpcPrivateIpAddressSet": [
            {
                "PrivateIpAddress": "10.4.2.2",
                "PrivateIpAddressType": "CTSDB",
                "CidrBlock": "10.4.2.0/24",
                "CreatedTime": "2018-12-27 15:40:10"
            },
            {
                "PrivateIpAddress": "10.4.2.3",
                "PrivateIpAddressType": "CFS",
                "CidrBlock": "10.4.2.0/24",
                "CreatedTime": "2018-09-02 16:48:59"
            },
            {
                "PrivateIpAddress": "10.4.2.17",
                "PrivateIpAddressType": "CVM",
                "CidrBlock": "10.4.2.0/24",
                "CreatedTime": "2018-09-02 16:48:59"
            }
        ],
        "RequestId": "75221557-b667-440a-8cfe-ccd1bde2a234"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.ModuleError 内部模块错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.LimitExceeded 参数值超出限制。
InvalidParameterValue.Malformed 入参格式不合法。
ResourceNotFound 资源不存在。