You need to enable JavaScript to run this app.
导航
私有网络
  • 文档首页
    • /私有网络/API参考/网卡/CreateNetworkInterface
CreateNetworkInterface
最近更新时间：2024.08.07 15:43:53首次发布时间：2021.07.29 14:11:54
我的收藏

调用 CreateNetworkInterface 接口，创建一张辅助网卡。

调用说明

  • 单账号单地域默认最多可创建的辅助网卡数量为5000张。若默认配额无法满足需求，请前往 配额中心 提升相应配额。
  • 本接口仅支持创建辅助网卡。
  • 您也可以调用 RunInstances 接口，按需传入NetworkInterfaces.N.SubnetId，可创建云服务器实例并创建挂载至该实例的辅助网卡。
  • CreateNetworkInterface为异步接口，即返回请求ID时，系统后台仍在创建。您可调用 DescribeNetworkInterfaceAttributes 查看网卡的状态，Creating表示创建中，Available 表示配置完成。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionString是CreateNetworkInterface要执行的操作。取值：CreateNetworkInterface。
VersionString是2020-04-01API版本信息，取值为：2020-04-01。

NetworkInterfaceName

String

否

eni-1

辅助网卡的名称。

  • 长度限制为1 ~ 128个字符。
  • 需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。
  • 不填默认是辅助网卡的ID。

Description

String

否

eni-1-description

辅助网卡的描述信息。

  • 长度限制为0~ 255个字符。
  • 需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
  • 不填默认空字符串。

SubnetId

String

是

subnet-h256yg29j****

辅助网卡所在子网的ID。
您可以调用 DescribeSubnets 接口，查询子网的ID。

PrimaryIpAddress

String

否

192.XX.XX.10

辅助网卡的主私有IPv4地址。

  • 如果指定，必须是对应子网中的一个空闲的私网IPv4地址。
  • 如果不指定，从对应子网中自动分配一个空闲的私网IPv4地址。

SecondaryPrivateIpAddressCount

Integer

否

1

为辅助网卡分配辅助私网IPv4地址数量，取值1~49。
传入该参数系统会自动从网卡所属子网中，分配相应数量的空闲IPv4地址作为新创建网卡的辅助私网IPv4地址。

说明

不可以同时传入参数SecondaryPrivateIpAddressCount和PrivateIpAddress.N。

PrivateIpAddress.N

String

否

PrivateIpAddress.1=192.168.XX.10&PrivateIpAddress.2=192.168.XX.12

为网卡指定辅助私网IPv4地址。

  • 参数 - N：表示辅助私网IPv4地址的序号，取值范围为1~49。
  • 多个私网IPv4地址之间用&分隔。
  • 指定的私网IPv4地址必须为网卡所属子网中的空闲私网IPv4地址。

说明

不可以同时传入参数SecondaryPrivateIpAddressCount和PrivateIpAddress.N。

Ipv6AddressCount

Integer

否

2

为网卡分配私网IPv6地址的数量。
传入该参数，系统会自动从网卡所属子网中，分配相应数量的空闲私网IPv6地址，作为网卡的私网IPv6地址。

说明

  • 不可以同时传入参数Ipv6Address.N和Ipv6AddressCount。
  • 为网卡分配IPv6地址正在邀测中，暂仅支持完成 企业认证 的账号申请试用，如需试用，请联系客户经理。

Ipv6Address.N

String

否

Ipv6Address.1=2408:4008:55b:XXXX:XXXX:922:96c4:e0&Ipv6Address.2=2408:4008:55b:XXXX:XXXX:5eb5:eadc:cda1

为网卡指定私网IPv6地址。

  • 参数 - N：表示私网IPv6地址的序号，取值范围由网卡状态决定。
    • 当网卡处于未挂载（Available）状态时，取值范围为1~10。
    • 当网卡处于已挂载（InUse）状态时，N的取值范围受到实例规格限制，更多详情请参见实例规格介绍。
  • 多个私网IPv6地址之间用&分隔。
  • 指定的IP必须为网卡所属子网中的空闲IP。

说明

  • 不可以同时传入参数Ipv6Address.N和Ipv6AddressCount。
  • 为网卡分配IPv6地址正在邀测中，暂仅支持完成 企业认证 的账号申请试用，如需试用，请联系客户经理。

SecurityGroupIds.N

String

是

SecurityGroupIds.1=sg-123edfgt8hhvj****&SecurityGroupIds.2=sg-840jkrvnfjer****

辅助网卡加入一个或多个安全组的ID。
您可以调用 DescribeSecurityGroups 接口，查询安全组的ID。

  • 安全组必须与辅助网卡在同一个VPC内。
  • 参数 - N：表示安全组ID的序号，单次调用数量上限5个ID。
  • 多个安全组用&分隔。

PortSecurityEnabled

Boolean

否

false

是否为网卡开启源/目的地址检查。 开启后，系统会自动阻止源地址或目的地址不是当前网卡的流量。

  • true：是。
  • false（默认值）：否。
ProjectNameString否default网卡所属项目的名称。不填默认加入default项目。

Tags.N.Key

String

否

Tags.1.Key=key1&Tags.2.Key=key2

用户标签的标签键。

  • 参数 - N：表示标签键的序号，取值范围：1～50。
  • 多个标签键之间用&分隔。
  • 不能以 volc:或sys:开头，包括任意大小写形式。
  • 长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（ ）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。
  • 若标签键开头或结尾存在空格，系统会自动为其去除。

说明

同一资源的标签键不允许重复。

Tags.N.Value

String

否

Tags.1.Value=value1&Tags.2.Value=value2

用户标签的标签值。

  • 参数 - N：表示标签值的序号，取值范围：1～50。
  • 多个标签值之间用&分隔。
  • 长度取值范围为0～256字符，不填默认为空。
  • 允许输入各国语言文字、数字、空格（ ）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。
  • 大小写敏感。
  • 若标签值开头或结尾存在空格，系统会自动为其去除。

说明

若传入该参数，则必须先传入Tags.N.Key。

ClientToken

String

否

123e4567-e89b-12d3-a456-42665544****

客户端Token，用于保证请求幂等性。

  • 由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
  • 仅支持ASCII字符，且不能超过64个字符。
  • 若不传入ClientToken，则此次API调用不进行幂等校验。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。
NetworkInterfaceIdStringeni-bp1fgnh68xyz9****新创建辅助网卡的ID。

请求示例

GET /?Action=CreateNetworkInterface&Version=2020-04-01&SubnetId=subnet-h256yg29j****&SecurityGroupIds.1=sg-123edfgt8hhvj****&PrimaryIpAddress=192.XX.XX.10&NetworkInterfaceName=eni-1 HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "CreateNetworkInterface",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "NetworkInterfaceId": "eni-bp1fg655nh68xyz9****",
        "RequestId": "2021062415303301022514515207C4****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode
错误码
错误信息
描述
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
400InsufficientIpInSubnetThe specified subnet does not contain enough free private IP addresses to fulfill your request.指定子网下可用IP不足。
400InvalidDescription.MalformedThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidEniIp.MalformedThe specified elastic network interface ip is malformed. If you are specifying an IP of an elastic network interface, ensure it must fall into the range of the CIDR block of the subnet to which the elastic network interface belongs to.指定的弹性网卡IP不合法。请确保网卡IP必须从属于所在子网的网段。
400InvalidEniType.MalformedThe specified elastic network interface type is malformed.指定的弹性网卡类型不合法。
400InvalidIpv6.MalformedThe specified IPv6 address is malformed.指定的IPv6地址不合法。
400InvalidName.MalformedThe specified name is malformed. Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400InvalidPrivateIp.MalformedThe specified private ip is malformed.指定的私网IP不合法。
400InvalidSecurityGroup.InvalidStatusThe specified security group is not in the correct status for the request.指定的安全组所处的状态无法响应该请求。
400InvalidSecurityGroup.VpcMismatchThe specified security group and elastic network interface are not in the same VPC.指定的安全组和弹性网卡不在同一个VPC。
400InvalidSubnet.DisableIpv6Specified subnet disable IPv6.子网尚未开启IPv6。
400InvalidSubnet.InvalidStatusThe specified subnet is not in the correct status for the request.指定的子网所处的状态无法响应该请求。
400InvalidTag.DisorderThe specified index order of tag is malformed.指定标签的索引顺序参数格式不合法。
400InvalidTagKey.MalformedThe specified parameter tag key is invalid.标签键不合法。
400InvalidTagValue.MalformedThe specified parameter tag value is invalid.标签值不合法。
400LimitExceeded.Ipv6AddressesPerEniYou've reached the limit on the number of IPv6 addresses per ENI that you can assign.已达到网卡可分配的IPv6地址的数量上限。
400LimitExceeded.PrivateIpsPerEniYou've reached the limit on the number of private IPs per ENI that you can assign.已达到网卡可分配的辅助IP的数量上限。
400LimitExceeded.TagsYou've reached the limit on the number of tags that you can operate at one time.已达到单次可操作标签数量的上限。
400QuotaExceeded.EniENI number exceeded quota.已达到可创建网卡的数量上限。
400QuotaExceeded.EniSecurityGroupYou've reached the limit on the number of elastic network interfaces that a security group can associate.已达到安全组可关联的弹性网卡数量上限
400QuotaExceeded.SecurityGroupThe number of security groups bound to the ENI exceeded quota.已达到当前网卡可绑定安全组的数量上限。
400QuotaExceeded.SecurityGroupIpThe number of IP addresses bound to the security group exceeded quota.已达到安全组可绑定IP地址的数量上限。
403ForbiddenYou are not authorized to perform operations on the specified security group. The specified security group is a service-managed security group.无权限对指定安全组进行操作。指定的安全组为云产品托管的安全组。
404InvalidProject.NotFoundThe specified Project does not exist.指定的项目不存在。
404InvalidSecurityGroupId.NotFoundThe specified security group does not exist.指定的安全组不存在。
404InvalidSubnet.NotFoundThe specified subnet does not exist.指定的子网不存在。
409InvalidIpAddress.InUseThe specified IP address is in use.指定的IP地址已被占用。
409InvalidParameter.ParameterConflictThe parameters for IP address number and IP addresses cannot be specified at the same time.该请求不允许同时传入IP地址数量以及IP地址。
409InvalidSecurityGroupId.ConflictThe specified security group is duplicated with another security group associated with the same elastic network interface.指定的安全组已关联至该网卡，无法重复绑定。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。