私有网络创建保留内网IP

1. 接口描述

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

创建内网保留IP

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateReserveIpAddresses。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
VpcId	是	String	VPC唯一 ID。示例值：vpc-mcqaoy0f
IpAddresses.N	否	Array of String	指定IP申请的内网保留IP地址。示例值：["10.0.1.9"]
IpAddressCount	否	Integer	不指定IP地址，指定个数自动分配保留内网IP。示例值：1
SubnetId	否	String	子网唯一 ID。示例值：subnet-j4oluywm
Name	否	String	内网保留 IP名称。示例值：reserve_ip
Description	否	String	内网保留 IP描述。示例值：desc_ivan
Tags.N	否	Array of Tag	指定绑定的标签列表，例如：[{"Key": "city", "Value": "shanghai"}]。示例值：[ { "Key": "ivan_tag", "Value": "hello" } ]
ClientToken	否	String	用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。示例值：B1B615C4-9EBE-40FD-BC8D-8E2BE19F0309

3. 输出参数

参数名称	类型	描述
ReserveIpAddressSet	Array of ReserveIpAddressInfo	内网保留 IP返回信息示例值：[ { "CreatedTime": "0000-00-00 00:00:00", "Description": "", "IpType": 0, "Name": "", "ReserveIpAddress": "10.0.5.78", "ReserveIpId": "rsvip-krj0sw6y", "ResourceId": "", "State": "UnBind", "TagSet": [ { "Key": "ivan_tag", "Value": "hello" } ], "VpcId": "vpc-mcqaoy0f" } ]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 指定个数，申请自动分配的保留 IP

指定个数，申请自动分配的保留 IP

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateReserveIpAddresses
<公共请求参数>

{
    "VpcId": "vpc-mcqaoy0f",
    "IpAddressCount": 2,
    "Name": "name_ivan",
    "Description": "desc_ivan"
}

输出示例

{
    "Response": {
        "RequestId": "14c27c62-fc90-4922-a20c-fca60c6b5330",
        "ReserveIpAddressSet": [
            {
                "CreatedTime": "2024-11-21 16:57:22",
                "Description": "desc_ivan",
                "IpType": 0,
                "Name": "name_ivan",
                "ReserveIpAddress": "10.0.5.99",
                "ReserveIpId": "rsvip-eaq2f4pc",
                "ResourceId": "",
                "State": "UnBind",
                "VpcId": "vpc-mcqaoy0f"
            },
            {
                "CreatedTime": "2024-11-21 16:57:22",
                "Description": "desc_ivan",
                "IpType": 0,
                "Name": "name_ivan",
                "ReserveIpAddress": "10.0.5.50",
                "ReserveIpId": "rsvip-2g134x24",
                "ResourceId": "",
                "State": "UnBind",
                "VpcId": "vpc-mcqaoy0f"
            }
        ]
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
UnknownParameter	未知参数错误。
UnknownParameter.WithGuess	参数无法识别，可以尝试相似参数代替。

创建保留内网IP

本页目录：