查询VPC内网IP信息
最近更新时间: 2024-10-18 10:38:46
1. 接口描述
接口请求域名： vpc.api3.fincloud.tencent.cn。
本接口（DescribeVpcPrivateIpAddresses）用于查询VPC内网IP信息。
只能查询已使用的IP信息，当查询未使用的IP时，本接口不会报错，但不会出现在返回结果里。
默认接口请求频率限制：20次/秒。
接口更新时间：2020-01-09 10:58:39。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeVpcPrivateIpAddresses |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| VpcId | 是 | 否 | String | VPC实例ID，形如：vpc-f49l6u0z。 |
| PrivateIpAddresses | 是 | 否 | Array of String | 内网IP地址列表，批量查询单次请求最多支持10个。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| VpcPrivateIpAddressSet | VpcPrivateIpAddress | 此参数对外不可见。 内网 IP地址信息列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| ResourceNotFound | |
| InvalidParameterValue.LimitExceeded |