1. 接口描述
本接口(CreateNetworkInterface)用于创建弹性网卡。
接口请求域名:vpc.api.qcloud.com
1) 创建弹性网卡时可以指定内网 IP,并且可以指定一个主 IP,指定的内网 IP 必须在弹性网卡所在子网内,而且不能被占用。
2) 创建弹性网卡时可以指定需要申请的内网 IP 数量,系统会随机生成内网 IP 地址。
3) 创建弹性网卡同时可以绑定已有安全组。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 CreateNetworkInterface。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
vpcId | 是 | String | 弹性网卡所在的私有网络 ID,推荐使用新 ID,例如 vpc-7t9nf3pu。 |
subnetId | 是 | String | 弹性网卡所在的子网 ID,推荐使用新 ID,例如 subnet-0ap8nwca。 |
eniName | 是 | String | 弹性网卡名称,可任意命名,但不得超过60个字符。 |
eniDescription | 否 | String | 弹性网卡描述,可任意命名,但不得超过60个字符。 |
privateIpAddressSet.n | 否 | Array | 指定的内网 IP 地址数组。 |
privateIpAddressSet.n.primary | 是 | Bool | 是否为主 IP,只能设置一个主 IP。 |
privateIpAddressSet.n.privateIpAddress | 是 | String | 指定的内网 IP 地址。 |
secondaryPrivateIpAddressCount | 否 | Int | 需要新申请的内网 IP 地址个数。 |
sgIds.n | 否 | Array | 指定绑定的安全组,例如 ['sg-1dd51d']。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 错误码。0: 成功, 其他值: 失败 |
message | String | 错误信息 |
taskId | Int | 任务 ID,操作结果可以用taskId查询,详见 查询任务执行结果接口。 |
4. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 VPC 错误码。
错误码 | 描述 |
---|---|
InvalidVpc.NotFound | 无效的 VPC,VPC 资源不存在。请再次核实您输入的资源信息是否正确,可通过 DescribeVpcEx 接口查询 VPC |
InvalidSubnet.NotFound | 无效的子网,子网资源不存在。请再次核实您输入的资源信息是否正确,可通过 DescribeSubnetEx 接口查询子网 |
InvalidNetworkInterfaceName | 弹性网卡名称不合法。可任意命名,但不得超过60个字符。 |
NetworkInterfaceLimitExceeded | 创建的弹性网卡数量超过上限。如果需要更多资源,请联系客服申请。更多 VPC 资源限制信息详见 VPC 使用限制 |
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=CreateNetworkInterface &<公共请求参数> &vpcId=vpc-7t9nf3pu &subnetId=subnet-0ap8nwca &eniName=eni &secondaryPrivateIpAddressCount=1 &sgIds.0=sg-1dd51d
输出
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data":
{
"taskId": 16284
}
}