1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(AssignPrivateIpAddresses)用于弹性网卡申请内网 IP。
- 一个弹性网卡支持绑定的IP地址是有限制的,更多资源限制信息详见弹性网卡使用限制。
- 可以指定内网IP地址申请,内网IP地址类型不能为主IP,主IP已存在,不能修改,内网IP必须要在弹性网卡所在子网内,而且不能被占用。
- 在弹性网卡上申请一个到多个辅助内网IP,接口会在弹性网卡所在子网网段内返回指定数量的辅助内网IP。
说明:
本接口为异步接口,可调用 DescribeVpcTaskResult 接口查询任务执行结果,待任务执行成功后再进行其他操作。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AssignPrivateIpAddresses。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
NetworkInterfaceId | 是 | String | 弹性网卡实例ID,例如:eni-m6dyj72l。 示例值:eni-afo43z61 |
PrivateIpAddresses.N | 否 | Array of PrivateIpAddressSpecification | 指定的内网IP信息,单次最多指定10个。与SecondaryPrivateIpAddressCount至少提供一个。 |
SecondaryPrivateIpAddressCount | 否 | Integer | 新申请的内网IP地址个数,与PrivateIpAddresses至少提供一个。内网IP地址个数总和不能超过配额数,详见弹性网卡使用限制。 示例值:2 |
QosLevel | 否 | String | IP服务质量等级,和SecondaryPrivateIpAddressCount配合使用,可选值:PT、AU、AG、DEFAULT,分别代表云金、云银、云铜、默认四个等级。 示例值:PT |
ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PrivateIpAddressSet | Array of PrivateIpAddressSpecification | 内网IP详细信息。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 弹性网卡申请内网 IP
申请弹性网卡
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssignPrivateIpAddresses
<公共请求参数>
{
"NetworkInterfaceId": "eni-afo43z61",
"SecondaryPrivateIpAddressCount": "1"
}
输出示例
{
"Response": {
"PrivateIpAddressSet": [
{
"PrivateIpAddress": "172.16.32.237",
"Primary": false,
"PublicIpAddress": "",
"AddressId": "",
"Description": "",
"IsWanIpBlocked": false,
"State": "PENDING",
"QosLevel": "DEFAULT"
}
],
"RequestId": "f23d1450-ed00-4442-98d4-be409e625e6c"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.NetDetectTimeOut | 网络探测超时,请稍后重试。 |
InvalidParameterValue.DuplicatePara | 参数值存在重复。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
InvalidParameterValue.Reserved | 参数值是一个系统保留对象。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.ActionLimited | 接口请求次数超过限频。 |
MissingParameter | 缺少参数错误。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceInsufficient.Subnet | 子网IP资源不足, 无法分配IP。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.IdempotentParameterMismatch | 指定的客户令牌已经被使用。 |
UnsupportedOperation.IdempotentProcessing | 先前的幂等请求仍在处理中,请稍后重试。 |
UnsupportedOperation.InvalidState | 资源状态不合法。 |
UnsupportedOperation.MutexOperationTaskRunning | 资源互斥操作任务正在执行。 |
UnsupportedOperation.ResourceMismatch | 输入的资源ID与IP绑定的资源不匹配,请检查。 |