一、1. 接口描述
弹性网卡申请内网 IP
默认接口请求频率限制:20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:AssignPrivateIpAddresses。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-19。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| NetworkInterfaceId | 是 | String | 弹性网卡实例ID,例如:eni-m6dyj72l。示例值:eni-ms7c7gcr |
| EcmRegion | 是 | String | ECM 地域,形如ap-xian-ecm。示例值:ap-hangzhou-ecm |
| PrivateIpAddresses.N | 否 | Array of PrivateIpAddressSpecification | 指定的内网IP信息,单次最多指定10个。与SecondaryPrivateIpAddressCount至少提供一个。示例值:[{"PrivateIpAddress": "10.0.0.11"}] |
| SecondaryPrivateIpAddressCount | 否 | Integer | 新申请的内网IP地址个数,与PrivateIpAddresses至少提供一个。内网IP地址个数总和不能超过配额数示例值:1 |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| PrivateIpAddressSet | Array of PrivateIpAddressSpecification | 内网IP详细信息。示例值:[{"PrivateIpAddress": "172.16.32.237"}] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
https://ecm.tencentcloudapi.com/?Action=AssignPrivateIpAddresses
&NetworkInterfaceId=eni-ms7c7gcr
&SecondaryPrivateIpAddressCount=1
&EcmRegion=ap-hangzhou-ecm
&<公共请求参数>
五、输出示例
{
"Response": {
"PrivateIpAddressSet": [
{
"PrivateIpAddress": "172.16.32.237",
"AddressId": "",
"PublicIpAddress": "",
"Primary": false,
"IsWanIpBlocked": false,
"State": "PENDING",
"Description": "demo"
}
],
"RequestId": "f23d1450-ed00-4442-98d4-be409e625e6c"
}
}
六、腾讯云 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: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
九、命令行工具
·Tencent Cloud CLI 3.0
十、6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
| FailedOperation.InternalOperationFailure | 内部操作错误。 |
| InvalidParameter.InvalidDataFormat | 数据格式不正确。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidPublicParam | 公共参数不合法。 |
| InvalidParameterValue.InvalidRegion | ecm region不合法。 |
| InvalidParameterValue.Malformed | 入参格式不合法。 |
| InvalidParameterValue.Range | 参数值不在指定范围。 |
| LimitExceeded.PrivateIPQuotaLimitExceeded | 内网IP超出限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |
| UnsupportedOperation.InvalidState | 资源状态不合法。 |