public class DescribeInstancesRequest
extends com.aliyun.tea.TeaModel
限定符和类型 | 类和说明 |
---|---|
static class |
DescribeInstancesRequest.DescribeInstancesRequestFilter |
static class |
DescribeInstancesRequest.DescribeInstancesRequestTag |
限定符和类型 | 字段和说明 |
---|---|
List<String> |
additionalAttributes
The additional attributes.
|
Boolean |
deviceAvailable
This parameter is in invitational preview and is not publicly available.
|
Boolean |
dryRun
Specifies whether to perform only a dry run, without performing the actual 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 in invitational preview and is not publicly available.
|
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 ID of the instance.
|
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 an I/O optimized instance.
|
List<String> |
ipv6Address
The IPv6 addresses assigned to elastic network interfaces (ENIs).
|
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 per page.
|
Boolean |
needSaleCycle
This parameter is in invitational preview and is not publicly available.
|
String |
nextToken
The pagination token that is used in the next request to retrieve a new page of results.
|
String |
ownerAccount |
Long |
ownerId |
Integer |
pageNumber
The page number.
|
Integer |
pageSize
The number of entries per page.
|
String |
privateIpAddresses
The private IP addresses of instances located in a VPC.
|
String |
publicIpAddresses
The public IP addresses of instances.
|
String |
rdmaIpAddresses
The remote direct memory access (RDMA) IP addresses of the instance in the HPC cluster.
|
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 status of the instance.
|
List<DescribeInstancesRequest.DescribeInstancesRequestTag> |
tag
The tags of the instance.
|
String |
vpcId
The ID of the virtual private cloud (VPC).
|
String |
vSwitchId
The ID of the vSwitch.
|
String |
zoneId
The zone ID of the instance.
|
构造器和说明 |
---|
DescribeInstancesRequest() |
@NameInMap(value="Filter") public List<DescribeInstancesRequest.DescribeInstancesRequestFilter> filter
@NameInMap(value="AdditionalAttributes") public List<String> additionalAttributes
The additional attributes. Valid values of N: 1 to 20. Valid values:
META_OPTIONS
@NameInMap(value="DeviceAvailable") public Boolean deviceAvailable
example:This parameter is in invitational preview and is not publicly available.
false
@NameInMap(value="DryRun") public Boolean dryRun
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
Default value: false.
example:false
@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 (,).
example:["42.1.1.", "42.1.2.", … "42.1.10.**"]
@NameInMap(value="HpcClusterId") public String hpcClusterId
The ID of the high-performance computing (HPC) cluster to which the instance belongs.
example:hpc-bp67acfmxazb4p****
@NameInMap(value="HttpEndpoint") public String httpEndpoint
Specifies whether the access channel is enabled for instance metadata. Valid values:
Default value: enabled.
example:For information about instance metadata, see Access instance metadata.
enabled
@NameInMap(value="HttpPutResponseHopLimit") public Integer httpPutResponseHopLimit
example:This parameter is in invitational preview and is not publicly available.
0
@NameInMap(value="HttpTokens") public String httpTokens
Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata. Valid values:
Default value: optional.
example:For information about modes of accessing instance metadata, see Access instance metadata.
optional
@NameInMap(value="ImageId") public String imageId
The ID of the image.
example:m-bp67acfmxazb4p****
@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 (,).
example:["10.1.1.1", "10.1.2.1", … "10.1.10.1"]
@NameInMap(value="InstanceChargeType") public String instanceChargeType
The billing method of the instance. Valid values:
PostPaid
@NameInMap(value="InstanceIds") public 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 (,).
example:["i-bp67acfmxazb4p****", "i-bp67acfmxazb4p****", … "i-bp67acfmxazb4p****"]
@NameInMap(value="InstanceName") public String instanceName
The name of the instance. Fuzzy search with asterisk (\*) wildcard characters is supported.
example:Test
@NameInMap(value="InstanceNetworkType") public String instanceNetworkType
The network type of the instance. Valid values:
vpc
@NameInMap(value="InstanceType") public String instanceType
The instance type of the instance.
example:ecs.g5.large
@NameInMap(value="InstanceTypeFamily") public String instanceTypeFamily
The instance family of the instance.
example:ecs.g5
@NameInMap(value="InternetChargeType") public String internetChargeType
The billing method for network usage. Valid values:
example: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.
PayByTraffic
@NameInMap(value="IoOptimized") public Boolean ioOptimized
Specifies whether the instance is an I/O optimized instance. Valid values:
true
@NameInMap(value="Ipv6Address") public List<String> ipv6Address
The IPv6 addresses assigned to elastic network interfaces (ENIs).
if can be null:false
@NameInMap(value="KeyPairName") public String keyPairName
The name of the SSH key pair bound to the instance.
example:KeyPairNameTest
@NameInMap(value="LockReason") public String lockReason
The reason why the instance is locked. Valid values:
security
@NameInMap(value="MaxResults") public Integer maxResults
The maximum number of entries per page. Valid values: 1 to 100.
Default value:
10
@NameInMap(value="NeedSaleCycle") public Boolean needSaleCycle
example:This parameter is in invitational preview and is not publicly available.
false
@NameInMap(value="NextToken") public 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
.
caeba0bbb2be03f84eb48b699f0a4883
@NameInMap(value="OwnerAccount") public String ownerAccount
@NameInMap(value="OwnerId") public Long ownerId
@NameInMap(value="PageNumber") public Integer pageNumber
The page number.
Pages start from page 1.
Default value: 1.
example:1
@NameInMap(value="PageSize") public Integer pageSize
The number of entries per page.
Valid values: 1 to 100.
Default value: 10.
example:10
@NameInMap(value="PrivateIpAddresses") public 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 (,).
example:["172.16.1.1", "172.16.2.1", … "172.16.10.1"]
@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 (,).
example:["42.1.1.", "42.1.2.", … "42.1.10.**"]
@NameInMap(value="RdmaIpAddresses") public String rdmaIpAddresses
The remote direct memory access (RDMA) IP addresses of the instance in the HPC cluster.
example:10.10.10.102
@NameInMap(value="RegionId") public String regionId
The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.
This parameter is required.
example:cn-hangzhou
@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.
example:Resources in the default resource group are displayed in the response regardless of how this parameter is set.
rg-bp67acfmxazb4p****
@NameInMap(value="ResourceOwnerAccount") public String resourceOwnerAccount
@NameInMap(value="ResourceOwnerId") public Long resourceOwnerId
@NameInMap(value="SecurityGroupId") public String securityGroupId
The ID of the security group to which the instance belongs.
example:sg-bp67acfmxazb4p****
@NameInMap(value="Status") public String status
The status of the instance. Valid values:
Running
@NameInMap(value="Tag") public List<DescribeInstancesRequest.DescribeInstancesRequestTag> tag
The tags of the instance.
@NameInMap(value="VSwitchId") public String vSwitchId
The ID of the vSwitch.
example:vsw-bp67acfmxazb4p****
@NameInMap(value="VpcId") public String vpcId
The ID of the virtual private cloud (VPC).
example:v-bp67acfmxazb4p****
@NameInMap(value="ZoneId") public String zoneId
The zone ID of the instance.
example:cn-hangzhou-g
public static DescribeInstancesRequest build(Map<String,?> map) throws Exception
Exception
public DescribeInstancesRequest setFilter(List<DescribeInstancesRequest.DescribeInstancesRequestFilter> filter)
public List<DescribeInstancesRequest.DescribeInstancesRequestFilter> getFilter()
public DescribeInstancesRequest setAdditionalAttributes(List<String> additionalAttributes)
public DescribeInstancesRequest setDeviceAvailable(Boolean deviceAvailable)
public Boolean getDeviceAvailable()
public DescribeInstancesRequest setDryRun(Boolean dryRun)
public Boolean getDryRun()
public DescribeInstancesRequest setEipAddresses(String eipAddresses)
public String getEipAddresses()
public DescribeInstancesRequest setHpcClusterId(String hpcClusterId)
public String getHpcClusterId()
public DescribeInstancesRequest setHttpEndpoint(String httpEndpoint)
public String getHttpEndpoint()
public DescribeInstancesRequest setHttpPutResponseHopLimit(Integer httpPutResponseHopLimit)
public Integer getHttpPutResponseHopLimit()
public DescribeInstancesRequest setHttpTokens(String httpTokens)
public String getHttpTokens()
public DescribeInstancesRequest setImageId(String imageId)
public String getImageId()
public DescribeInstancesRequest setInnerIpAddresses(String innerIpAddresses)
public String getInnerIpAddresses()
public DescribeInstancesRequest setInstanceChargeType(String instanceChargeType)
public String getInstanceChargeType()
public DescribeInstancesRequest setInstanceIds(String instanceIds)
public String getInstanceIds()
public DescribeInstancesRequest setInstanceName(String instanceName)
public String getInstanceName()
public DescribeInstancesRequest setInstanceNetworkType(String instanceNetworkType)
public String getInstanceNetworkType()
public DescribeInstancesRequest setInstanceType(String instanceType)
public String getInstanceType()
public DescribeInstancesRequest setInstanceTypeFamily(String instanceTypeFamily)
public String getInstanceTypeFamily()
public DescribeInstancesRequest setInternetChargeType(String internetChargeType)
public String getInternetChargeType()
public DescribeInstancesRequest setIoOptimized(Boolean ioOptimized)
public Boolean getIoOptimized()
public DescribeInstancesRequest setIpv6Address(List<String> ipv6Address)
public DescribeInstancesRequest setKeyPairName(String keyPairName)
public String getKeyPairName()
public DescribeInstancesRequest setLockReason(String lockReason)
public String getLockReason()
public DescribeInstancesRequest setMaxResults(Integer maxResults)
public Integer getMaxResults()
public DescribeInstancesRequest setNeedSaleCycle(Boolean needSaleCycle)
public Boolean getNeedSaleCycle()
public DescribeInstancesRequest setNextToken(String nextToken)
public String getNextToken()
public DescribeInstancesRequest setOwnerAccount(String ownerAccount)
public String getOwnerAccount()
public DescribeInstancesRequest setOwnerId(Long ownerId)
public Long getOwnerId()
public DescribeInstancesRequest setPageNumber(Integer pageNumber)
public Integer getPageNumber()
public DescribeInstancesRequest setPageSize(Integer pageSize)
public Integer getPageSize()
public DescribeInstancesRequest setPrivateIpAddresses(String privateIpAddresses)
public String getPrivateIpAddresses()
public DescribeInstancesRequest setPublicIpAddresses(String publicIpAddresses)
public String getPublicIpAddresses()
public DescribeInstancesRequest setRdmaIpAddresses(String rdmaIpAddresses)
public String getRdmaIpAddresses()
public DescribeInstancesRequest setRegionId(String regionId)
public String getRegionId()
public DescribeInstancesRequest setResourceGroupId(String resourceGroupId)
public String getResourceGroupId()
public DescribeInstancesRequest setResourceOwnerAccount(String resourceOwnerAccount)
public String getResourceOwnerAccount()
public DescribeInstancesRequest setResourceOwnerId(Long resourceOwnerId)
public Long getResourceOwnerId()
public DescribeInstancesRequest setSecurityGroupId(String securityGroupId)
public String getSecurityGroupId()
public DescribeInstancesRequest setStatus(String status)
public String getStatus()
public DescribeInstancesRequest setTag(List<DescribeInstancesRequest.DescribeInstancesRequestTag> tag)
public List<DescribeInstancesRequest.DescribeInstancesRequestTag> getTag()
public DescribeInstancesRequest setVSwitchId(String vSwitchId)
public String getVSwitchId()
public DescribeInstancesRequest setVpcId(String vpcId)
public String getVpcId()
public DescribeInstancesRequest setZoneId(String zoneId)
public String getZoneId()
Copyright © 2024. All rights reserved.