DescribeInstancesRequest.Builder (alibabacloud-ecs20140526 5.0.19 API)

java.lang.Object
- com.aliyun.sdk.service.ecs20140526.models.DescribeInstancesRequest.Builder

所有已实现的接口:

darabonba.core.RequestModel.Builder<DescribeInstancesRequest,DescribeInstancesRequest.Builder>

封闭类:

DescribeInstancesRequest
```
public static final class DescribeInstancesRequest.Builder
extends Object
```

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DescribeInstancesRequest.Builder`	`additionalAttributes(List<String> additionalAttributes)` The additional attributes.
`DescribeInstancesRequest`	`build()`
`DescribeInstancesRequest.Builder`	`deviceAvailable(Boolean deviceAvailable)` > This parameter is in invitational preview and is not publicly available.
`DescribeInstancesRequest.Builder`	`dryRun(Boolean dryRun)` Specifies whether to perform only a dry run, without performing the actual request.
`DescribeInstancesRequest.Builder`	`eipAddresses(String eipAddresses)` The elastic IP addresses (EIPs) of instances.
`DescribeInstancesRequest.Builder`	`filter(List<DescribeInstancesRequest.Filter> filter)` Filter.
`DescribeInstancesRequest.Builder`	`hpcClusterId(String hpcClusterId)` The ID of the high-performance computing (HPC) cluster to which the instance belongs.
`DescribeInstancesRequest.Builder`	`httpEndpoint(String httpEndpoint)` Specifies whether the access channel is enabled for instance metadata.
`DescribeInstancesRequest.Builder`	`httpPutResponseHopLimit(Integer httpPutResponseHopLimit)` > This parameter is in invitational preview and is not publicly available.
`DescribeInstancesRequest.Builder`	`httpTokens(String httpTokens)` Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.
`DescribeInstancesRequest.Builder`	`imageId(String imageId)` The ID of the image.
`DescribeInstancesRequest.Builder`	`innerIpAddresses(String innerIpAddresses)` The internal IP addresses of instances located in the classic network.
`DescribeInstancesRequest.Builder`	`instanceChargeType(String instanceChargeType)` The billing method of the instance.
`DescribeInstancesRequest.Builder`	`instanceIds(String instanceIds)` The ID of the instance.
`DescribeInstancesRequest.Builder`	`instanceName(String instanceName)` The name of the instance.
`DescribeInstancesRequest.Builder`	`instanceNetworkType(String instanceNetworkType)` The network type of the instance.
`DescribeInstancesRequest.Builder`	`instanceType(String instanceType)` The instance type of the instance.
`DescribeInstancesRequest.Builder`	`instanceTypeFamily(String instanceTypeFamily)` The instance family of the instance.
`DescribeInstancesRequest.Builder`	`internetChargeType(String internetChargeType)` The billing method for network usage.
`DescribeInstancesRequest.Builder`	`ioOptimized(Boolean ioOptimized)` Specifies whether the instance is an I/O optimized instance.
`DescribeInstancesRequest.Builder`	`ipv6Address(List<String> ipv6Address)` The IPv6 addresses assigned to elastic network interfaces (ENIs).
`DescribeInstancesRequest.Builder`	`keyPairName(String keyPairName)` The name of the SSH key pair bound to the instance.
`DescribeInstancesRequest.Builder`	`lockReason(String lockReason)` The reason why the instance is locked.
`DescribeInstancesRequest.Builder`	`maxResults(Integer maxResults)` The maximum number of entries per page.
`DescribeInstancesRequest.Builder`	`needSaleCycle(Boolean needSaleCycle)` > This parameter is in invitational preview and is not publicly available.
`DescribeInstancesRequest.Builder`	`nextToken(String nextToken)` The pagination token that is used in the next request to retrieve a new page of results.
`DescribeInstancesRequest.Builder`	`ownerAccount(String ownerAccount)` OwnerAccount.
`DescribeInstancesRequest.Builder`	`ownerId(Long ownerId)` OwnerId.
`DescribeInstancesRequest.Builder`	`pageNumber(Integer pageNumber)` The page number.
`DescribeInstancesRequest.Builder`	`pageSize(Integer pageSize)` The number of entries per page.
`DescribeInstancesRequest.Builder`	`privateIpAddresses(String privateIpAddresses)` The private IP addresses of instances located in a VPC.
`DescribeInstancesRequest.Builder`	`publicIpAddresses(String publicIpAddresses)` The public IP addresses of instances.
`DescribeInstancesRequest.Builder`	`rdmaIpAddresses(String rdmaIpAddresses)` The remote direct memory access (RDMA) IP addresses of the instance in the HPC cluster.
`DescribeInstancesRequest.Builder`	`regionId(String regionId)` The region ID of the instance.
`DescribeInstancesRequest.Builder`	`resourceGroupId(String resourceGroupId)` The ID of the resource group to which the instance belongs.
`DescribeInstancesRequest.Builder`	`resourceOwnerAccount(String resourceOwnerAccount)` ResourceOwnerAccount.
`DescribeInstancesRequest.Builder`	`resourceOwnerId(Long resourceOwnerId)` ResourceOwnerId.
`DescribeInstancesRequest.Builder`	`securityGroupId(String securityGroupId)` The ID of the security group to which the instance belongs.
`DescribeInstancesRequest.Builder`	`sourceRegionId(String sourceRegionId)` SourceRegionId.
`DescribeInstancesRequest.Builder`	`status(String status)` The status of the instance.
`DescribeInstancesRequest.Builder`	`tag(List<DescribeInstancesRequest.Tag> tag)` The tags of the instance.
`DescribeInstancesRequest.Builder`	`vpcId(String vpcId)` The ID of the virtual private cloud (VPC).
`DescribeInstancesRequest.Builder`	`vSwitchId(String vSwitchId)` The ID of the vSwitch.
`DescribeInstancesRequest.Builder`	`zoneId(String zoneId)` The zone ID of the instance.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - filter
```
public DescribeInstancesRequest.Builder filter(List<DescribeInstancesRequest.Filter> filter)
```
    Filter.
  - sourceRegionId
```
public DescribeInstancesRequest.Builder sourceRegionId(String sourceRegionId)
```
    SourceRegionId.
  - additionalAttributes
```
public DescribeInstancesRequest.Builder additionalAttributes(List<String> additionalAttributes)
```
    The additional attributes. Valid values of N: 1 to 20. Valid values:
    * META_OPTIONS: instance metadata * DDH_CLUSTER: dedicated host cluster * NETWORK_PRIMARY_ENI_IP: secondary IP address associated with the primary ENI * CPU_OPTIONS_TOPOLOGY_TYPE: CPU topology type of the instance
  - deviceAvailable
```
public DescribeInstancesRequest.Builder deviceAvailable(Boolean deviceAvailable)
```
    > This parameter is in invitational preview and is not publicly available.
  - dryRun
```
public DescribeInstancesRequest.Builder dryRun(Boolean dryRun)
```
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:
    * true: performs only a dry run. The system checks the request for potential issues, including invalid AccessKey pairs, unauthorized RAM users, and missing parameter values. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned. * false: performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed. Default value: false.
  - eipAddresses
```
public DescribeInstancesRequest.Builder eipAddresses(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
```
public DescribeInstancesRequest.Builder hpcClusterId(String hpcClusterId)
```
    The ID of the high-performance computing (HPC) cluster to which the instance belongs.
  - httpEndpoint
```
public DescribeInstancesRequest.Builder httpEndpoint(String httpEndpoint)
```
    Specifies whether the access channel is enabled for instance metadata. Valid values:
    * enabled * disabled Default value: enabled. > For information about instance metadata, see [Access instance metadata](~~49122~~).
  - httpPutResponseHopLimit
```
public DescribeInstancesRequest.Builder httpPutResponseHopLimit(Integer httpPutResponseHopLimit)
```
    > This parameter is in invitational preview and is not publicly available.
  - httpTokens
```
public DescribeInstancesRequest.Builder httpTokens(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 information about modes of accessing instance metadata, see [Access instance metadata](~~150575~~).
  - imageId
```
public DescribeInstancesRequest.Builder imageId(String imageId)
```
    The ID of the image.
  - innerIpAddresses
```
public DescribeInstancesRequest.Builder innerIpAddresses(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
```
public DescribeInstancesRequest.Builder instanceChargeType(String instanceChargeType)
```
    The billing method of the instance. Valid values:
    * PostPaid: pay-as-you-go * PrePaid: subscription
  - instanceIds
```
public DescribeInstancesRequest.Builder instanceIds(String instanceIds)
```
    The ID of the instance. The value can be a JSON array that consists of up to 100 instance IDs. Separate the IDs with commas (,).
  - instanceName
```
public DescribeInstancesRequest.Builder instanceName(String instanceName)
```
    The name of the instance. Fuzzy search with asterisk (\*) wildcard characters is supported.
  - instanceNetworkType
```
public DescribeInstancesRequest.Builder instanceNetworkType(String instanceNetworkType)
```
    The network type of the instance. Valid values:
    * classic * vpc
  - instanceType
```
public DescribeInstancesRequest.Builder instanceType(String instanceType)
```
    The instance type of the instance.
  - instanceTypeFamily
```
public DescribeInstancesRequest.Builder instanceTypeFamily(String instanceTypeFamily)
```
    The instance family of the instance.
  - internetChargeType
```
public DescribeInstancesRequest.Builder internetChargeType(String internetChargeType)
```
    The billing method for network usage. Valid values:
    * PayByBandwidth * PayByTraffic > When the **pay-by-traffic** billing method is used for network usage, the maximum inbound and outbound bandwidths are used as the upper limits of bandwidths instead of guaranteed performance specifications. In scenarios in which demands exceed resource supplies, the maximum bandwidths may not be reached. If you want guaranteed bandwidths for your instance, use the **pay-by-bandwidth** billing method for network usage.
  - ioOptimized
```
public DescribeInstancesRequest.Builder ioOptimized(Boolean ioOptimized)
```
    Specifies whether the instance is an I/O optimized instance. Valid values:
    * true * false
  - ipv6Address
```
public DescribeInstancesRequest.Builder ipv6Address(List<String> ipv6Address)
```
    The IPv6 addresses assigned to elastic network interfaces (ENIs).
  - keyPairName
```
public DescribeInstancesRequest.Builder keyPairName(String keyPairName)
```
    The name of the SSH key pair bound to the instance.
  - lockReason
```
public DescribeInstancesRequest.Builder lockReason(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
```
public DescribeInstancesRequest.Builder maxResults(Integer maxResults)
```
    The maximum number of entries per page. Valid values: 1 to 100.
    Default value: * If you do not specify this parameter or if you set this parameter to a value that is smaller than 10, the default value is 10. * If you set this parameter to a value that is greater than 100, the default value is 100.
  - needSaleCycle
```
public DescribeInstancesRequest.Builder needSaleCycle(Boolean needSaleCycle)
```
    > This parameter is in invitational preview and is not publicly available.
  - nextToken
```
public DescribeInstancesRequest.Builder nextToken(String nextToken)
```
    The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.
  - ownerAccount
```
public DescribeInstancesRequest.Builder ownerAccount(String ownerAccount)
```
    OwnerAccount.
  - ownerId
```
public DescribeInstancesRequest.Builder ownerId(Long ownerId)
```
    OwnerId.
  - pageNumber
```
public DescribeInstancesRequest.Builder pageNumber(Integer pageNumber)
```
    The page number.
    Pages start from page 1. Default value: 1.
  - pageSize
```
public DescribeInstancesRequest.Builder pageSize(Integer pageSize)
```
    The number of entries per page.
    Valid values: 1 to 100. Default value: 10.
  - privateIpAddresses
```
public DescribeInstancesRequest.Builder privateIpAddresses(String privateIpAddresses)
```
    The private IP addresses of instances located in a VPC. 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
```
public DescribeInstancesRequest.Builder publicIpAddresses(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
```
public DescribeInstancesRequest.Builder rdmaIpAddresses(String rdmaIpAddresses)
```
    The remote direct memory access (RDMA) IP addresses of the instance in the HPC cluster.
  - regionId
```
public DescribeInstancesRequest.Builder regionId(String regionId)
```
    The region ID of the instance. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.
  - resourceGroupId
```
public DescribeInstancesRequest.Builder resourceGroupId(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
```
public DescribeInstancesRequest.Builder resourceOwnerAccount(String resourceOwnerAccount)
```
    ResourceOwnerAccount.
  - resourceOwnerId
```
public DescribeInstancesRequest.Builder resourceOwnerId(Long resourceOwnerId)
```
    ResourceOwnerId.
  - securityGroupId
```
public DescribeInstancesRequest.Builder securityGroupId(String securityGroupId)
```
    The ID of the security group to which the instance belongs.
  - status
```
public DescribeInstancesRequest.Builder status(String status)
```
    The status 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
```
public DescribeInstancesRequest.Builder tag(List<DescribeInstancesRequest.Tag> tag)
```
    The tags of the instance.
  - vSwitchId
```
public DescribeInstancesRequest.Builder vSwitchId(String vSwitchId)
```
    The ID of the vSwitch.
  - vpcId
```
public DescribeInstancesRequest.Builder vpcId(String vpcId)
```
    The ID of the virtual private cloud (VPC).
  - zoneId
```
public DescribeInstancesRequest.Builder zoneId(String zoneId)
```
    The zone ID of the instance.
  - build
```
public DescribeInstancesRequest build()
```

类 DescribeInstancesRequest.Builder

方法概要

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

方法详细资料

filter

sourceRegionId

additionalAttributes

deviceAvailable

dryRun

eipAddresses

hpcClusterId

httpEndpoint

httpPutResponseHopLimit

httpTokens

imageId

innerIpAddresses

instanceChargeType

instanceIds

instanceName

instanceNetworkType

instanceType

instanceTypeFamily

internetChargeType

ioOptimized

ipv6Address

keyPairName

lockReason

maxResults

needSaleCycle

nextToken

ownerAccount

ownerId

pageNumber

pageSize

privateIpAddresses

publicIpAddresses

rdmaIpAddresses

regionId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

securityGroupId

status

tag

vSwitchId

vpcId

zoneId

build