com.aliyun.ecs20140526.models

类 RunInstancesRequest.RunInstancesRequestNetworkInterface

java.lang.Object

com.aliyun.tea.TeaModel

com.aliyun.ecs20140526.models.RunInstancesRequest.RunInstancesRequestNetworkInterface

封闭类:

RunInstancesRequest

public static class RunInstancesRequest.RunInstancesRequestNetworkInterface
extends com.aliyun.tea.TeaModel

字段概要

字段

限定符和类型	字段和说明
Boolean	deleteOnRelease Specifies whether to release ENI N when the associated instance is released.
String	description The description of ENI N.
String	instanceType The type of ENI N.
List<String>	ipv6Address The IPv6 addresses to assign to the primary ENI.
Long	ipv6AddressCount The number of IPv6 addresses to randomly generate for the primary ENI.
Integer	networkCardIndex The index of the network card for ENI N.
String	networkInterfaceId The ID of ENI N to attach to the instance.
String	networkInterfaceName The name of ENI N.
String	networkInterfaceTrafficMode The communication mode of ENI N.
String	primaryIpAddress The primary IP address to assign to ENI N.
Integer	queueNumber The number of queues supported by ENI N.
Long	queuePairNumber The number of queues supported by the ERI.
Integer	rxQueueSize The receive (Rx) queue depth of ENI N.
String	securityGroupId The ID of the security group to which to assign ENI N.
List<String>	securityGroupIds The IDs of security groups to which to assign ENI N.
Integer	txQueueSize The Tx queue depth of ENI N.
String	vSwitchId The ID of the vSwitch to which to connect ENI N.

构造器概要

构造器

构造器和说明
RunInstancesRequestNetworkInterface()

方法概要

限定符和类型	方法和说明
static RunInstancesRequest.RunInstancesRequestNetworkInterface	build(Map<String,?> map)
Boolean	getDeleteOnRelease()
String	getDescription()
String	getInstanceType()
List<String>	getIpv6Address()
Long	getIpv6AddressCount()
Integer	getNetworkCardIndex()
String	getNetworkInterfaceId()
String	getNetworkInterfaceName()
String	getNetworkInterfaceTrafficMode()
String	getPrimaryIpAddress()
Integer	getQueueNumber()
Long	getQueuePairNumber()
Integer	getRxQueueSize()
String	getSecurityGroupId()
List<String>	getSecurityGroupIds()
Integer	getTxQueueSize()
String	getVSwitchId()
RunInstancesRequest.RunInstancesRequestNetworkInterface	setDeleteOnRelease(Boolean deleteOnRelease)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setDescription(String description)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setInstanceType(String instanceType)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setIpv6Address(List<String> ipv6Address)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setIpv6AddressCount(Long ipv6AddressCount)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setNetworkCardIndex(Integer networkCardIndex)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setNetworkInterfaceId(String networkInterfaceId)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setNetworkInterfaceName(String networkInterfaceName)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setNetworkInterfaceTrafficMode(String networkInterfaceTrafficMode)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setPrimaryIpAddress(String primaryIpAddress)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setQueueNumber(Integer queueNumber)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setQueuePairNumber(Long queuePairNumber)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setRxQueueSize(Integer rxQueueSize)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setSecurityGroupId(String securityGroupId)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setSecurityGroupIds(List<String> securityGroupIds)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setTxQueueSize(Integer txQueueSize)
RunInstancesRequest.RunInstancesRequestNetworkInterface	setVSwitchId(String vSwitchId)

从类继承的方法 com.aliyun.tea.TeaModel

build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

deleteOnRelease

@NameInMap(value="DeleteOnRelease")
public Boolean deleteOnRelease

Specifies whether to release ENI N when the associated instance is released. Valid values:

• true
• false

Default value: true.

This parameter takes effect only for secondary ENIs.

example:

true

description

@NameInMap(value="Description")
public String description

The description of ENI N.

When you specify this parameter, take note of the following items:

• The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
• The description must be 2 to 256 characters in length and cannot start with http:// or https://.
• If you set NetworkInterface.N.InstanceType to Primary, you do not need to specify this parameter.

example:

Network_Description

instanceType

@NameInMap(value="InstanceType")
public String instanceType

The type of ENI N. The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.

Valid values:

• Primary: primary ENI.
• Secondary: secondary ENI.

Default value: Secondary.

example:

Secondary

ipv6Address

@NameInMap(value="Ipv6Address")
public List<String> ipv6Address

The IPv6 addresses to assign to the primary ENI. You can assign up to 10 IPv6 addresses to the primary ENI. Valid values of the second N: 1 to 10.

Example: Ipv6Address.1=2001:db8:1234:1a00::***.

When you specify this parameter, take note of the following items:

• This parameter is valid only when NetworkInterface.N.InstanceType is set to Primary. If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you cannot specify this parameter.
• If you specify this parameter, you must set Amount to 1 and cannot specify Ipv6AddressCount, Ipv6Address.N, or NetworkInterface.N.Ipv6AddressCount.

ipv6AddressCount

@NameInMap(value="Ipv6AddressCount")
public Long ipv6AddressCount

The number of IPv6 addresses to randomly generate for the primary ENI. Valid values: 1 to 10.

When you specify this parameter, take note of the following items:

• This parameter is valid only when NetworkInterface.N.InstanceType is set to Primary. If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you cannot specify this parameter.
• If you specify this parameter, you cannot specify Ipv6AddressCount, Ipv6Address.N, or NetworkInterface.N.Ipv6Address.N.

example:

1

networkCardIndex

@NameInMap(value="NetworkCardIndex")
public Integer networkCardIndex

The index of the network card for ENI N.

When you specify this parameter, take note of the following items:

• You can specify network card indexes only for instances of specific instance types.
• If you set NetworkInterface.N.InstanceType to Primary, you can set NetworkInterface.N.NetworkCardIndex only to 0 for instance types that support network cards.
• If you set NetworkInterface.N.InstanceType to Secondary or do not specify the parameter, you can specify NetworkInterface.N.NetworkCardIndex based on instance types if the instance types support network cards. For more information, see Overview of instance families.

example:

0

networkInterfaceId

@NameInMap(value="NetworkInterfaceId")
public String networkInterfaceId

The ID of ENI N to attach to the instance.

This parameter takes effect only for secondary ENIs. After you specify an existing secondary ENI, you cannot specify other ENI creation parameters.

example:

eni-bp1gn106np8jhxhj****

networkInterfaceName

@NameInMap(value="NetworkInterfaceName")
public String networkInterfaceName

The name of ENI N. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

When you specify this parameter, take note of the following items:

• The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
• If you set NetworkInterface.N.InstanceType to Primary, you do not need to specify this parameter.

example:

Network_Name

networkInterfaceTrafficMode

@NameInMap(value="NetworkInterfaceTrafficMode")
public String networkInterfaceTrafficMode

The communication mode of ENI N. Valid values:

• Standard: uses the TCP communication mode.
• HighPerformance: uses the remote direct memory access (RDMA) communication mode with Elastic RDMA Interface (ERI) enabled.

Default value: Standard.

The number of ERIs on an instance cannot exceed the maximum number of ERIs that the instance type supports. For more information, see Overview of instance families.

example:

Standard

primaryIpAddress

@NameInMap(value="PrimaryIpAddress")
public String primaryIpAddress

The primary IP address to assign to ENI N.

When you specify this parameter, take note of the following items:

• The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.

  • If the value of N is 1, you can configure a primary or secondary ENI. If you specify this parameter, set Amount to a numeric value greater than 1, and set NetworkInterface.N.InstanceType to Primary, the specified number of instances are created and consecutive primary IP addresses starting from the specified IP address are assigned to the instances. In this case, you cannot attach secondary ENIs to the instances.
  • If you specify this parameter, set Amount to a numeric value greater than 1, and set NetworkInterface.N.InstanceType to Primary, you cannot set NetworkInterface.2.InstanceType to Secondary to attach a secondary ENI.

• If you set NetworkInterface.N.InstanceType to Primary, this parameter is equivalent to PrivateIpAddress. You cannot specify both this parameter and PrivateIpAddress in the same request.

• If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, the specified primary IP address is assigned to the secondary ENI. The default value is an IP address that is randomly selected from within the CIDR block of the vSwitch to which to connect the secondary ENI.

• The first IP address and last three IP addresses of each vSwitch CIDR block are reserved. You cannot specify the IP addresses. For example, if a vSwitch CIDR block is 192.168.1.0/24, the following IP addresses are reserved: 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255.

example:

172.16.**.**

queueNumber

@NameInMap(value="QueueNumber")
public Integer queueNumber

The number of queues supported by ENI N.

When you specify this parameter, take note of the following items:

• The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
• The value of this parameter cannot exceed the maximum number of queues allowed per ENI.
• The total number of queues for all ENIs on the instance cannot exceed the queue quota for the instance type. To query the maximum number of queues per ENI and the queue quota for an instance type, you can call the DescribeInstanceTypes operation and check the MaximumQueueNumberPerEni and TotalEniQueueQuantity values in the response.
• If you specify this parameter and set NetworkInterface.N.InstanceType to Primary, you cannot specify NetworkInterfaceQueueNumber.

example:

8

queuePairNumber

@NameInMap(value="QueuePairNumber")
public Long queuePairNumber

The number of queues supported by the ERI.

example:

0

rxQueueSize

@NameInMap(value="RxQueueSize")
public Integer rxQueueSize

The receive (Rx) queue depth of ENI N.

When you specify this parameter, take note of the following items:

• The Rx queue depth of an ENI must be the same as the transmit (Tx) queue depth of the ENI. Valid values: powers of 2 in the range of 8192 to 16384.
• A larger Rx queue depth yields higher inbound throughput but consumes more memory.

example:

8192

securityGroupId

@NameInMap(value="SecurityGroupId")
public String securityGroupId

The ID of the security group to which to assign ENI N.

When you specify this parameter, take note of the following items:

• The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
• If you set NetworkInterface.N.InstanceType to Primary, you must specify this parameter. In this case, this parameter is equivalent to SecurityGroupId and you cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupIds.N.
• If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you do not need to specify this parameter. The default value is the ID of the security group to which to assign the instance.

example:

sg-bp67acfmxazb4p****

securityGroupIds

@NameInMap(value="SecurityGroupIds")
public List<String> securityGroupIds

The IDs of security groups to which to assign ENI N.

• The value of the first N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
• The second N indicates that one or more security group IDs can be specified. The valid values of the second N vary based on the maximum number of security groups to which an instance can belong. For more information, see the Security group limits section of the "Limits" topic.

When you specify this parameter, take note of the following items:

• If you set NetworkInterface.N.InstanceType to Primary, you must specify this parameter or NetworkInterface.N.SecurityGroupId. In this case, this parameter is equivalent to SecurityGroupIds.N, and you cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupId.
• If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you do not need to specify this parameter. The default value is the ID of the security group to which to assign the instance.

example:

sg-bp15ed6xe1yxeycg7****

txQueueSize

@NameInMap(value="TxQueueSize")
public Integer txQueueSize

The Tx queue depth of ENI N.

When you specify this parameter, take note of the following items:

• The Tx queue depth of an ENI must be the same as the Rx queue depth of the ENI. Valid values: powers of 2 in the range of 8192 to 16384.
• A larger Tx queue depth yields higher outbound throughput but consumes more memory.

example:

8192

vSwitchId

@NameInMap(value="VSwitchId")
public String vSwitchId

The ID of the vSwitch to which to connect ENI N.

When you specify this parameter, take note of the following items:

• The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
• If you set NetworkInterface.N.InstanceType to Primary, you must specify this parameter. In this case, this parameter is equivalent to VSwitchId. You cannot specify both NetworkInterface.N.VSwitchId and VSwitchId in the same request.
• If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you do not need to specify this parameter. The default value is the VSwitchId value.

example:

vsw-bp67acfmxazb4p****

构造器详细资料

RunInstancesRequestNetworkInterface

public RunInstancesRequestNetworkInterface()

方法详细资料

build

public static RunInstancesRequest.RunInstancesRequestNetworkInterface build(Map<String,?> map)
                                                                     throws Exception

抛出:

Exception

setDeleteOnRelease

public RunInstancesRequest.RunInstancesRequestNetworkInterface setDeleteOnRelease(Boolean deleteOnRelease)

getDeleteOnRelease

public Boolean getDeleteOnRelease()

setDescription

public RunInstancesRequest.RunInstancesRequestNetworkInterface setDescription(String description)

getDescription

public String getDescription()

setInstanceType

public RunInstancesRequest.RunInstancesRequestNetworkInterface setInstanceType(String instanceType)

getInstanceType

public String getInstanceType()

setIpv6Address

public RunInstancesRequest.RunInstancesRequestNetworkInterface setIpv6Address(List<String> ipv6Address)

getIpv6Address

public List<String> getIpv6Address()

setIpv6AddressCount

public RunInstancesRequest.RunInstancesRequestNetworkInterface setIpv6AddressCount(Long ipv6AddressCount)

getIpv6AddressCount

public Long getIpv6AddressCount()

setNetworkCardIndex

public RunInstancesRequest.RunInstancesRequestNetworkInterface setNetworkCardIndex(Integer networkCardIndex)

getNetworkCardIndex

public Integer getNetworkCardIndex()

setNetworkInterfaceId

public RunInstancesRequest.RunInstancesRequestNetworkInterface setNetworkInterfaceId(String networkInterfaceId)

getNetworkInterfaceId

public String getNetworkInterfaceId()

setNetworkInterfaceName

public RunInstancesRequest.RunInstancesRequestNetworkInterface setNetworkInterfaceName(String networkInterfaceName)

getNetworkInterfaceName

public String getNetworkInterfaceName()

setNetworkInterfaceTrafficMode

public RunInstancesRequest.RunInstancesRequestNetworkInterface setNetworkInterfaceTrafficMode(String networkInterfaceTrafficMode)

getNetworkInterfaceTrafficMode

public String getNetworkInterfaceTrafficMode()

setPrimaryIpAddress

public RunInstancesRequest.RunInstancesRequestNetworkInterface setPrimaryIpAddress(String primaryIpAddress)

getPrimaryIpAddress

public String getPrimaryIpAddress()

setQueueNumber

public RunInstancesRequest.RunInstancesRequestNetworkInterface setQueueNumber(Integer queueNumber)

getQueueNumber

public Integer getQueueNumber()

setQueuePairNumber

public RunInstancesRequest.RunInstancesRequestNetworkInterface setQueuePairNumber(Long queuePairNumber)

getQueuePairNumber

public Long getQueuePairNumber()

setRxQueueSize

public RunInstancesRequest.RunInstancesRequestNetworkInterface setRxQueueSize(Integer rxQueueSize)

getRxQueueSize

public Integer getRxQueueSize()

setSecurityGroupId

public RunInstancesRequest.RunInstancesRequestNetworkInterface setSecurityGroupId(String securityGroupId)

getSecurityGroupId

public String getSecurityGroupId()

setSecurityGroupIds

public RunInstancesRequest.RunInstancesRequestNetworkInterface setSecurityGroupIds(List<String> securityGroupIds)

getSecurityGroupIds

public List<String> getSecurityGroupIds()

setTxQueueSize

public RunInstancesRequest.RunInstancesRequestNetworkInterface setTxQueueSize(Integer txQueueSize)

getTxQueueSize

public Integer getTxQueueSize()

setVSwitchId

public RunInstancesRequest.RunInstancesRequestNetworkInterface setVSwitchId(String vSwitchId)

getVSwitchId

public String getVSwitchId()