com.aliyun.ecs20140526.models

类 DescribeInstancesRequest

java.lang.Object

com.aliyun.tea.TeaModel

com.aliyun.ecs20140526.models.DescribeInstancesRequest

public class DescribeInstancesRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	DescribeInstancesRequest.DescribeInstancesRequestFilter
static class	DescribeInstancesRequest.DescribeInstancesRequestTag

字段概要

字段

限定符和类型	字段和说明
List<String>	additionalAttributes The value of attribute N.
Boolean	deviceAvailable > This parameter is currently in invitational preview and unavailable for general users.
Boolean	dryRun Specifies whether to check the validity of the request without actually making the request.
String	eipAddresses The elastic IP addresses (EIPs) of instances.
List<DescribeInstancesRequest.DescribeInstancesRequestFilter>	filter
String	hpcClusterId The ID of the High Performance Computing (HPC) cluster to which the instance belongs.
String	httpEndpoint Specifies whether the access channel is enabled for instance metadata.
Integer	httpPutResponseHopLimit > This parameter is currently in invitational preview and unavailable for general users.
String	httpTokens Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.
String	imageId The ID of the image.
String	innerIpAddresses The internal IP addresses of instances located in the classic network.
String	instanceChargeType The billing method of the instance.
String	instanceIds The IDs of instances.
String	instanceName The name of the instance.
String	instanceNetworkType The network type of the instance.
String	instanceType The instance type of the instance.
String	instanceTypeFamily The instance family of the instance.
String	internetChargeType The billing method for network usage.
Boolean	ioOptimized Specifies whether the instance is I/O optimized.
List<String>	ipv6Address IPv6 address N of the elastic network interface (ENI).
String	keyPairName The name of the SSH key pair bound to the instance.
String	lockReason The reason why the instance is locked.
Integer	maxResults The maximum number of entries to return on each page.
Boolean	needSaleCycle > This parameter is currently in invitational preview and unavailable for general users.
String	nextToken The query token.
String	ownerAccount
Long	ownerId
Integer	pageNumber The number of the page to return.
Integer	pageSize The number of entries to return on each page.
String	privateIpAddresses The private IP addresses of instances located in VPCs.
String	publicIpAddresses The public IP addresses of instances.
String	rdmaIpAddresses The Remote Direct Memory Access (RDMA) IP address of the HPC instance.
String	regionId The region ID of the instance.
String	resourceGroupId The ID of the resource group to which the instance belongs.
String	resourceOwnerAccount
Long	resourceOwnerId
String	securityGroupId The ID of the security group to which the instance belongs.
String	status The state of the instance.
List<DescribeInstancesRequest.DescribeInstancesRequestTag>	tag The tags.
String	vpcId The ID of the virtual private cloud (VPC) to which the instance belongs.
String	vSwitchId The ID of the vSwitch to which the instance is connected.
String	zoneId The zone ID of the instance.

构造器概要

构造器

构造器和说明
DescribeInstancesRequest()

方法概要

限定符和类型	方法和说明
static DescribeInstancesRequest	build(Map<String,?> map)
List<String>	getAdditionalAttributes()
Boolean	getDeviceAvailable()
Boolean	getDryRun()
String	getEipAddresses()
List<DescribeInstancesRequest.DescribeInstancesRequestFilter>	getFilter()
String	getHpcClusterId()
String	getHttpEndpoint()
Integer	getHttpPutResponseHopLimit()
String	getHttpTokens()
String	getImageId()
String	getInnerIpAddresses()
String	getInstanceChargeType()
String	getInstanceIds()
String	getInstanceName()
String	getInstanceNetworkType()
String	getInstanceType()
String	getInstanceTypeFamily()
String	getInternetChargeType()
Boolean	getIoOptimized()
List<String>	getIpv6Address()
String	getKeyPairName()
String	getLockReason()
Integer	getMaxResults()
Boolean	getNeedSaleCycle()
String	getNextToken()
String	getOwnerAccount()
Long	getOwnerId()
Integer	getPageNumber()
Integer	getPageSize()
String	getPrivateIpAddresses()
String	getPublicIpAddresses()
String	getRdmaIpAddresses()
String	getRegionId()
String	getResourceGroupId()
String	getResourceOwnerAccount()
Long	getResourceOwnerId()
String	getSecurityGroupId()
String	getStatus()
List<DescribeInstancesRequest.DescribeInstancesRequestTag>	getTag()
String	getVpcId()
String	getVSwitchId()
String	getZoneId()
DescribeInstancesRequest	setAdditionalAttributes(List<String> additionalAttributes)
DescribeInstancesRequest	setDeviceAvailable(Boolean deviceAvailable)
DescribeInstancesRequest	setDryRun(Boolean dryRun)
DescribeInstancesRequest	setEipAddresses(String eipAddresses)
DescribeInstancesRequest	setFilter(List<DescribeInstancesRequest.DescribeInstancesRequestFilter> filter)
DescribeInstancesRequest	setHpcClusterId(String hpcClusterId)
DescribeInstancesRequest	setHttpEndpoint(String httpEndpoint)
DescribeInstancesRequest	setHttpPutResponseHopLimit(Integer httpPutResponseHopLimit)
DescribeInstancesRequest	setHttpTokens(String httpTokens)
DescribeInstancesRequest	setImageId(String imageId)
DescribeInstancesRequest	setInnerIpAddresses(String innerIpAddresses)
DescribeInstancesRequest	setInstanceChargeType(String instanceChargeType)
DescribeInstancesRequest	setInstanceIds(String instanceIds)
DescribeInstancesRequest	setInstanceName(String instanceName)
DescribeInstancesRequest	setInstanceNetworkType(String instanceNetworkType)
DescribeInstancesRequest	setInstanceType(String instanceType)
DescribeInstancesRequest	setInstanceTypeFamily(String instanceTypeFamily)
DescribeInstancesRequest	setInternetChargeType(String internetChargeType)
DescribeInstancesRequest	setIoOptimized(Boolean ioOptimized)
DescribeInstancesRequest	setIpv6Address(List<String> ipv6Address)
DescribeInstancesRequest	setKeyPairName(String keyPairName)
DescribeInstancesRequest	setLockReason(String lockReason)
DescribeInstancesRequest	setMaxResults(Integer maxResults)
DescribeInstancesRequest	setNeedSaleCycle(Boolean needSaleCycle)
DescribeInstancesRequest	setNextToken(String nextToken)
DescribeInstancesRequest	setOwnerAccount(String ownerAccount)
DescribeInstancesRequest	setOwnerId(Long ownerId)
DescribeInstancesRequest	setPageNumber(Integer pageNumber)
DescribeInstancesRequest	setPageSize(Integer pageSize)
DescribeInstancesRequest	setPrivateIpAddresses(String privateIpAddresses)
DescribeInstancesRequest	setPublicIpAddresses(String publicIpAddresses)
DescribeInstancesRequest	setRdmaIpAddresses(String rdmaIpAddresses)
DescribeInstancesRequest	setRegionId(String regionId)
DescribeInstancesRequest	setResourceGroupId(String resourceGroupId)
DescribeInstancesRequest	setResourceOwnerAccount(String resourceOwnerAccount)
DescribeInstancesRequest	setResourceOwnerId(Long resourceOwnerId)
DescribeInstancesRequest	setSecurityGroupId(String securityGroupId)
DescribeInstancesRequest	setStatus(String status)
DescribeInstancesRequest	setTag(List<DescribeInstancesRequest.DescribeInstancesRequestTag> tag)
DescribeInstancesRequest	setVpcId(String vpcId)
DescribeInstancesRequest	setVSwitchId(String vSwitchId)
DescribeInstancesRequest	setZoneId(String zoneId)

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

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

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

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

字段详细资料

filter

@NameInMap(value="Filter")
public List<DescribeInstancesRequest.DescribeInstancesRequestFilter> filter

additionalAttributes

@NameInMap(value="AdditionalAttributes")
public List<String> additionalAttributes

The value of attribute N. Valid values of N: 1 to 20.

deviceAvailable

@NameInMap(value="DeviceAvailable")
public Boolean deviceAvailable

> This parameter is currently in invitational preview and unavailable for general users.

dryRun

@NameInMap(value="DryRun")
public Boolean dryRun

Specifies whether to check the validity of the request without actually making the request. Default value: false. Valid values:

* true: The validity of the request is checked but the request is not made. Check items include whether your AccessKey pair is valid, whether RAM users are granted required permissions, and whether the required parameters are specified. If the check fails, the corresponding error is returned. If the check succeeds, the DryRunOperation error code is returned.

* false: The validity of the request is checked. If the check succeeds, a 2XX HTTP status code is returned and the request is made.

eipAddresses

@NameInMap(value="EipAddresses")
public String eipAddresses

The elastic IP addresses (EIPs) of instances. This parameter is valid when InstanceNetworkType is set to vpc. The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

hpcClusterId

@NameInMap(value="HpcClusterId")
public String hpcClusterId

The ID of the High Performance Computing (HPC) cluster to which the instance belongs.

httpEndpoint

@NameInMap(value="HttpEndpoint")
public String httpEndpoint

Specifies whether the access channel is enabled for instance metadata. Valid values:

* enabled

* disabled

Default value: enabled.

> For more information about instance metadata, see [Overview of ECS instance metadata](~~49122~~).

httpPutResponseHopLimit

@NameInMap(value="HttpPutResponseHopLimit")
public Integer httpPutResponseHopLimit

> This parameter is currently in invitational preview and unavailable for general users.

httpTokens

@NameInMap(value="HttpTokens")
public String httpTokens

Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata. Valid values:

* optional: The security hardening mode (IMDSv2) is not forcefully used.

* required: The security hardening mode (IMDSv2) is forcefully used. After you set this parameter to required, you cannot access instance metadata in normal mode.

Default value: optional.

> For more information about modes of accessing instance metadata, see [Access mode of instance metadata](~~150575~~).

imageId

@NameInMap(value="ImageId")
public String imageId

The ID of the image.

innerIpAddresses

@NameInMap(value="InnerIpAddresses")
public String innerIpAddresses

The internal IP addresses of instances located in the classic network. This parameter is valid when InstanceNetworkType is set to classic. The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

instanceChargeType

@NameInMap(value="InstanceChargeType")
public String instanceChargeType

The billing method of the instance. Valid values:

* PostPaid: pay-as-you-go

* PrePaid: subscription

instanceIds

@NameInMap(value="InstanceIds")
public String instanceIds

The IDs of instances. The value can be a JSON array that consists of up to 100 instance IDs. Separate the IDs with commas (,).

instanceName

@NameInMap(value="InstanceName")
public String instanceName

The name of the instance. Fuzzy search with the asterisk (\*) wildcard characters is supported.

instanceNetworkType

@NameInMap(value="InstanceNetworkType")
public String instanceNetworkType

The network type of the instance. Valid values:

* classic: classic network

* vpc: VPC

instanceType

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

The instance type of the instance.

instanceTypeFamily

@NameInMap(value="InstanceTypeFamily")
public String instanceTypeFamily

The instance family of the instance.

internetChargeType

@NameInMap(value="InternetChargeType")
public String internetChargeType

The billing method for network usage. Valid values:

* PayByBandwidth: pay-by-bandwidth

* PayByTraffic: pay-by-traffic

> When the **pay-by-traffic** billing method for network usage is used, the maximum inbound and outbound bandwidth values are used as upper limits of bandwidths instead of guaranteed performance specifications. In scenarios where demand outstrips resource supplies, these maximum bandwidth values may not be reached. If you want guaranteed bandwidths for your instances, use the **pay-by-bandwidth** billing method for network usage.

ioOptimized

@NameInMap(value="IoOptimized")
public Boolean ioOptimized

Specifies whether the instance is I/O optimized.

ipv6Address

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

IPv6 address N of the elastic network interface (ENI). You can specify multiple IPv6 addresses. Valid values of N: 1 to 100.

keyPairName

@NameInMap(value="KeyPairName")
public String keyPairName

The name of the SSH key pair bound to the instance.

lockReason

@NameInMap(value="LockReason")
public String lockReason

The reason why the instance is locked. Valid values:

* financial: The instance is locked due to overdue payments.

* security: The instance is locked due to security reasons.

* recycling: The preemptible instance is locked and pending release.

* dedicatedhostfinancial: The instance is locked due to overdue payments for the dedicated host.

* refunded: The instance is locked because a refund is made for the instance.

maxResults

@NameInMap(value="MaxResults")
public Integer maxResults

The maximum number of entries to return on each page. Maximum value: 100.

Default value:

* If this parameter is not specified or is set to a value smaller than 10, the default value is 10.

* If this parameter is set to a value greater than 100, the default value is 100.

needSaleCycle

@NameInMap(value="NeedSaleCycle")
public Boolean needSaleCycle

> This parameter is currently in invitational preview and unavailable for general users.

nextToken

@NameInMap(value="NextToken")
public String nextToken

The query token. Set the value to the `NextToken` value returned in the last call to the DescribeInstances operation.

ownerAccount

@NameInMap(value="OwnerAccount")
public String ownerAccount

ownerId

@NameInMap(value="OwnerId")
public Long ownerId

pageNumber

@NameInMap(value="PageNumber")
public Integer pageNumber

The number of the page to return.

Pages start from page 1.

Default value: 1.

pageSize

@NameInMap(value="PageSize")
public Integer pageSize

The number of entries to return on each page.

Maximum value: 100.

Default value: 10.

privateIpAddresses

@NameInMap(value="PrivateIpAddresses")
public String privateIpAddresses

The private IP addresses of instances located in VPCs. This parameter is valid when InstanceNetworkType is set to vpc. The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

publicIpAddresses

@NameInMap(value="PublicIpAddresses")
public String publicIpAddresses

The public IP addresses of instances. The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

rdmaIpAddresses

@NameInMap(value="RdmaIpAddresses")
public String rdmaIpAddresses

The Remote Direct Memory Access (RDMA) IP address of the HPC instance.

regionId

@NameInMap(value="RegionId")
public String regionId

The region ID of the instance. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.

resourceGroupId

@NameInMap(value="ResourceGroupId")
public String resourceGroupId

The ID of the resource group to which the instance belongs. If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.

> Resources in the default resource group are displayed in the response regardless of how this parameter is set.

resourceOwnerAccount

@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount

resourceOwnerId

@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId

securityGroupId

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

The ID of the security group to which the instance belongs.

status

@NameInMap(value="Status")
public String status

The state of the instance. Valid values:

* Pending: The instance is being created.

* Running: The instance is running.

* Starting: The instance is being started.

* Stopping: The instance is being stopped.

* Stopped: The instance is stopped.

tag

@NameInMap(value="Tag")
public List<DescribeInstancesRequest.DescribeInstancesRequestTag> tag

The tags.

vSwitchId

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

The ID of the vSwitch to which the instance is connected.

vpcId

@NameInMap(value="VpcId")
public String vpcId

The ID of the virtual private cloud (VPC) to which the instance belongs.

zoneId

@NameInMap(value="ZoneId")
public String zoneId

The zone ID of the instance.

构造器详细资料

DescribeInstancesRequest

public DescribeInstancesRequest()

方法详细资料

build

public static DescribeInstancesRequest build(Map<String,?> map)
                                      throws Exception

抛出:

Exception

setFilter

public DescribeInstancesRequest setFilter(List<DescribeInstancesRequest.DescribeInstancesRequestFilter> filter)

getFilter

public List<DescribeInstancesRequest.DescribeInstancesRequestFilter> getFilter()

setAdditionalAttributes

public DescribeInstancesRequest setAdditionalAttributes(List<String> additionalAttributes)

getAdditionalAttributes

public List<String> getAdditionalAttributes()

setDeviceAvailable

public DescribeInstancesRequest setDeviceAvailable(Boolean deviceAvailable)

getDeviceAvailable

public Boolean getDeviceAvailable()

setDryRun

public DescribeInstancesRequest setDryRun(Boolean dryRun)

getDryRun

public Boolean getDryRun()

setEipAddresses

public DescribeInstancesRequest setEipAddresses(String eipAddresses)

getEipAddresses

public String getEipAddresses()

setHpcClusterId

public DescribeInstancesRequest setHpcClusterId(String hpcClusterId)

getHpcClusterId

public String getHpcClusterId()

setHttpEndpoint

public DescribeInstancesRequest setHttpEndpoint(String httpEndpoint)

getHttpEndpoint

public String getHttpEndpoint()

setHttpPutResponseHopLimit

public DescribeInstancesRequest setHttpPutResponseHopLimit(Integer httpPutResponseHopLimit)

getHttpPutResponseHopLimit

public Integer getHttpPutResponseHopLimit()

setHttpTokens

public DescribeInstancesRequest setHttpTokens(String httpTokens)

getHttpTokens

public String getHttpTokens()

setImageId

public DescribeInstancesRequest setImageId(String imageId)

getImageId

public String getImageId()

setInnerIpAddresses

public DescribeInstancesRequest setInnerIpAddresses(String innerIpAddresses)

getInnerIpAddresses

public String getInnerIpAddresses()

setInstanceChargeType

public DescribeInstancesRequest setInstanceChargeType(String instanceChargeType)

getInstanceChargeType

public String getInstanceChargeType()

setInstanceIds

public DescribeInstancesRequest setInstanceIds(String instanceIds)

getInstanceIds

public String getInstanceIds()

setInstanceName

public DescribeInstancesRequest setInstanceName(String instanceName)

getInstanceName

public String getInstanceName()

setInstanceNetworkType

public DescribeInstancesRequest setInstanceNetworkType(String instanceNetworkType)

getInstanceNetworkType

public String getInstanceNetworkType()

setInstanceType

public DescribeInstancesRequest setInstanceType(String instanceType)

getInstanceType

public String getInstanceType()

setInstanceTypeFamily

public DescribeInstancesRequest setInstanceTypeFamily(String instanceTypeFamily)

getInstanceTypeFamily

public String getInstanceTypeFamily()

setInternetChargeType

public DescribeInstancesRequest setInternetChargeType(String internetChargeType)

getInternetChargeType

public String getInternetChargeType()

setIoOptimized

public DescribeInstancesRequest setIoOptimized(Boolean ioOptimized)

getIoOptimized

public Boolean getIoOptimized()

setIpv6Address

public DescribeInstancesRequest setIpv6Address(List<String> ipv6Address)

getIpv6Address

public List<String> getIpv6Address()

setKeyPairName

public DescribeInstancesRequest setKeyPairName(String keyPairName)

getKeyPairName

public String getKeyPairName()

setLockReason

public DescribeInstancesRequest setLockReason(String lockReason)

getLockReason

public String getLockReason()

setMaxResults

public DescribeInstancesRequest setMaxResults(Integer maxResults)

getMaxResults

public Integer getMaxResults()

setNeedSaleCycle

public DescribeInstancesRequest setNeedSaleCycle(Boolean needSaleCycle)

getNeedSaleCycle

public Boolean getNeedSaleCycle()

setNextToken

public DescribeInstancesRequest setNextToken(String nextToken)

getNextToken

public String getNextToken()

setOwnerAccount

public DescribeInstancesRequest setOwnerAccount(String ownerAccount)

getOwnerAccount

public String getOwnerAccount()

setOwnerId

public DescribeInstancesRequest setOwnerId(Long ownerId)

getOwnerId

public Long getOwnerId()

setPageNumber

public DescribeInstancesRequest setPageNumber(Integer pageNumber)

getPageNumber

public Integer getPageNumber()

setPageSize

public DescribeInstancesRequest setPageSize(Integer pageSize)

getPageSize

public Integer getPageSize()

setPrivateIpAddresses

public DescribeInstancesRequest setPrivateIpAddresses(String privateIpAddresses)

getPrivateIpAddresses

public String getPrivateIpAddresses()

setPublicIpAddresses

public DescribeInstancesRequest setPublicIpAddresses(String publicIpAddresses)

getPublicIpAddresses

public String getPublicIpAddresses()

setRdmaIpAddresses

public DescribeInstancesRequest setRdmaIpAddresses(String rdmaIpAddresses)

getRdmaIpAddresses

public String getRdmaIpAddresses()

setRegionId

public DescribeInstancesRequest setRegionId(String regionId)

getRegionId

public String getRegionId()

setResourceGroupId

public DescribeInstancesRequest setResourceGroupId(String resourceGroupId)

getResourceGroupId

public String getResourceGroupId()

setResourceOwnerAccount

public DescribeInstancesRequest setResourceOwnerAccount(String resourceOwnerAccount)

getResourceOwnerAccount

public String getResourceOwnerAccount()

setResourceOwnerId

public DescribeInstancesRequest setResourceOwnerId(Long resourceOwnerId)

getResourceOwnerId

public Long getResourceOwnerId()

setSecurityGroupId

public DescribeInstancesRequest setSecurityGroupId(String securityGroupId)

getSecurityGroupId

public String getSecurityGroupId()

setStatus

public DescribeInstancesRequest setStatus(String status)

getStatus

public String getStatus()

setTag

public DescribeInstancesRequest setTag(List<DescribeInstancesRequest.DescribeInstancesRequestTag> tag)

getTag

public List<DescribeInstancesRequest.DescribeInstancesRequestTag> getTag()

setVSwitchId

public DescribeInstancesRequest setVSwitchId(String vSwitchId)

getVSwitchId

public String getVSwitchId()

setVpcId

public DescribeInstancesRequest setVpcId(String vpcId)

getVpcId

public String getVpcId()

setZoneId

public DescribeInstancesRequest setZoneId(String zoneId)

getZoneId

public String getZoneId()