1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(CreateDhcpIp)用于创建DhcpIp。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDhcpIp。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
VpcId | 是 | String | 私有网络ID 。示例值:vpc-12345678 |
SubnetId | 是 | String | 子网ID 。示例值:subnet-12345678 |
DhcpIpName | 是 | String | DhcpIp 名称。示例值:test |
SecondaryPrivateIpAddressCount | 否 | Integer | 新申请的内网IP地址个数。总数不能超过64个,为了兼容性,当前参数必填。 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DhcpIpSet | Array of DhcpIp | 新创建的DhcpIp 信息。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建DhcpIp
创建DhcpIp
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDhcpIp
<公共请求参数>
{
"SubnetId": "subnet-12345678",
"VpcId": "vpc-12345678",
"DhcpIpName": "test",
"SecondaryPrivateIpAddressCount": "1"
}
输出示例
{
"Response": {
"DhcpIpSet": [
{
"DhcpIpId": "dhcpip-12345678",
"DhcpIpName": "test",
"PrivateIpAddress": "10.0.0.13",
"VpcId": "vpc-12345678",
"SubnetId": "subnet-12345678",
"NetworkInterfaceId": "",
"InstanceId": "",
"AddressIp": "",
"State": "UNBIND",
"CreatedTime": "2018-10-10 17:03:09"
}
],
"RequestId": "fcb47621-838b-428e-8c33-6e210d93c451"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
InvalidParameterValue.Reserved | 参数值是一个系统保留对象。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInsufficient | 资源不足。 |
ResourceInsufficient.Subnet | 子网IP资源不足, 无法分配IP。 |
ResourceNotFound | 资源不存在。 |