API文档

创建弹性网卡并绑定云主机

最近更新时间:2020-08-11 08:25:25

1. 接口描述

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

本接口(CreateAndAttachNetworkInterface)用于创建弹性网卡并绑定云主机。

  • 创建弹性网卡时可以指定内网IP,并且可以指定一个主IP,指定的内网IP必须在弹性网卡所在子网内,而且不能被占用。
  • 创建弹性网卡时可以指定需要申请的内网IP数量,系统会随机生成内网IP地址。
  • 一个弹性网卡支持绑定的IP地址是有限制的,更多资源限制信息详见弹性网卡使用限制
  • 创建弹性网卡同时可以绑定已有安全组。
  • 创建弹性网卡同时可以绑定标签, 应答里的标签列表代表添加成功的标签。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAndAttachNetworkInterface。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
VpcId String VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。
NetworkInterfaceName String 弹性网卡名称,最大长度不能超过60个字节。
SubnetId String 弹性网卡所在的子网实例ID,例如:subnet-0ap8nwca。
InstanceId String 云主机实例ID。
PrivateIpAddresses.N Array of PrivateIpAddressSpecification 指定的内网IP信息,单次最多指定10个。
SecondaryPrivateIpAddressCount Integer 新申请的内网IP地址个数,内网IP地址个数总和不能超过配数。
SecurityGroupIds.N Array of String 指定绑定的安全组,例如:['sg-1dd51d']。
NetworkInterfaceDescription String 弹性网卡描述,可任意命名,但不得超过60个字符。
Tags.N Array of Tag 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]

3. 输出参数

参数名称 类型 描述
NetworkInterface NetworkInterface 弹性网卡实例。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建弹性网卡并绑定云主机

输入示例

https://vpc.tencentcloudapi.com/?Action=CreateAndAttachNetworkInterface
&VpcId=vpc-0akbol5v
&SubnetId=subnet-76r802pg
&NetworkInterfaceName=TestNIC
&NetworkInterfaceDescription=TestDesc
&PrivateIpAddresses.0.PrivateIpAddress=172.16.64.13
&PrivateIpAddresses.0.Primary=true
&SecondaryPrivateIpAddressCount=1
&SecurityGroupIds.0=sg-05bb4upy
&InstanceId=ins-12345678
&Tags.0.Key=city
&Tags.0.Value=shanghai
&<公共请求参数>

输出示例

{
  "Response": {
    "NetworkInterface": {
      "NetworkInterfaceId": "eni-irk5qhhl",
      "VpcId": "vpc-0akbol5v",
      "SubnetId": "subnet-76r802pg",
      "NetworkInterfaceName": "TestNIC",
      "NetworkInterfaceDescription": "TestDesc",
      "MacAddress": "20:90:6F:62:33:E2",
      "PrivateIpAddressSet": [
        {
          "PrivateIpAddress": "172.16.64.13",
          "Primary": true,
          "AddressId": "",
          "PublicIpAddress": "",
          "Description": "",
          "IsWanIpBlocked": false,
          "State": "PENDING"
        }
      ],
      "Attachment": {
        "InstanceId": "ins-12345678"
      },
      "GroupSet": [],
      "Primary": false,
      "State": "PENDING",
      "Zone": "",
      "CreatedTime": "",
      "Ipv6AddressSet": [],
      "TagSet": [
        {
          "Key": "city",
          "Value": "shanghai"
        }
      ]
    },
    "RequestId": "5cf1a813-d4f8-4e0c-8f90-c155a84a3ea1"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue 参数值不合法。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.Range 参数值不在指定范围。
InvalidParameterValue.Reserved 参数值是一个系统保留对象。
InvalidParameterValue.TooLong 无效参数值。参数值太长。
LimitExceeded 超过配额限制。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。
目录