1. 接口描述
接口请求域名： vpc.tencentcloudapi.com 。
查询内网保留 IP
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeReserveIpAddresses。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ReserveIpIds.N | 否 | Array of String | 内网保留IP唯一ID 列表 示例值：["rsvip-pvqgv9vi", "rsvip-calhlymy"] |
| Filters.N | 否 | Array of Filter | 过滤条件，参数不支持同时指定ReserveIpIds和Filters。 reserve-ip-id - String - （过滤条件）内网保留 IP唯一 ID，形如：rsvip-pvqgv9vi。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 subnet-id - String - （过滤条件）所属子网实例ID，形如：subnet-f49l6u0z。 address-ip - String - （过滤条件）内网保留 IP 地址，形如：192.168.0.10。 ip-type - String - （过滤条件）业务类型 ipType，0。 name - String - （过滤条件）名称。 state - String - （过滤条件）状态，可选值：Bind， UnBind。 resource-id - String - （过滤条件）绑定的实例资源，形如：eni-059qmnif。 tag-key - String -（过滤条件）按照标签键进行过滤。 tag:tag-key - String - （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 示例值：[ { "Name": "state", "Values": [ "UnBind" ] } ] |
| Offset | 否 | Integer | 偏移量。 示例值：0 |
| Limit | 否 | Integer | 请求对象个数。 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReserveIpAddressSet | Array of ReserveIpAddressInfo | 内网保留 IP返回信息。 示例值：[ { "CreatedTime": "2024-11-14 21:26:03", "Description": "", "IpType": 0, "Name": "", "ReserveIpAddress": "10.0.5.44", "ReserveIpId": "rsvip-prrua2m6", "ResourceId": "", "State": "UnBind", "TagSet": [ { "Key": "qcs:tag:createdBy", "Value": "Root:700000328799" }, { "Key": "ivan_tag", "Value": "hello" } ], "VpcId": "vpc-mcqaoy0f" } ] |
| TotalCount | Integer | 返回内网保留IP的个数。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询内网保留 IP
查询内网保留 IP
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReserveIpAddresses
<公共请求参数>
{
"ReserveIpIds": [
"rsvip-eaq2f4pc",
"rsvip-2g134x24"
]
}输出示例
{
"Response": {
"RequestId": "2d32beeb-0750-4ef9-a2f9-e4e7bbb0ec7f",
"ReserveIpAddressSet": [
{
"CreatedTime": "2024-11-06 12:01:57",
"Description": "desc_ivan",
"IpType": 0,
"Name": "name_ivan",
"ReserveIpAddress": "10.0.5.99",
"ReserveIpId": "rsvip-eaq2f4pc",
"ResourceId": "",
"State": "UnBind",
"TagSet": [],
"VpcId": "vpc-mcqaoy0f"
},
{
"CreatedTime": "2024-11-06 12:01:57",
"Description": "desc_ivan",
"IpType": 0,
"Name": "name_ivan",
"ReserveIpAddress": "10.0.5.50",
"ReserveIpId": "rsvip-2g134x24",
"ResourceId": "",
"State": "UnBind",
"TagSet": [],
"VpcId": "vpc-mcqaoy0f"
}
],
"TotalCount": 2
}
}示例2 根据标签过滤查询保留 IP
根据标签过滤查询保留 IP
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReserveIpAddresses
<公共请求参数>
{
"Filters": [
{
"Name": "tag-key",
"Values": [
"ivan_reserve_ip"
]
}
]
}输出示例
{
"Response": {
"RequestId": "e168d943-d647-4c0a-ada4-50a90015ded8",
"ReserveIpAddressSet": [
{
"CreatedTime": "2024-11-06 17:30:06",
"Description": "desc_ivan",
"IpType": 0,
"Name": "name_ivan",
"ReserveIpAddress": "10.0.5.89",
"ReserveIpId": "rsvip-du6lo6fu",
"ResourceId": "",
"State": "UnBind",
"TagSet": [
{
"Key": "ivan_reserve_ip",
"Value": "hello"
}
],
"VpcId": "vpc-mcqaoy0f"
}
],
"TotalCount": 1
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.ModuleError | 内部模块错误。 |
| InvalidParameter.Coexist | 参数不支持同时指定。 |
| InvalidParameter.FilterInvalidKey | 指定过滤条件不存在。 |
| InvalidParameter.FilterNotDict | 指定过滤条件不是键值对。 |
| InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
| InvalidParameterValue.Malformed | 入参格式不合法。 |
| InvalidParameterValue.ResourceNotFound | 未查询到该资源。 |
| ResourceNotFound | 资源不存在。 |
