DescribeImagesRequest (ecs20140526 5.4.5 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.ecs20140526.models.DescribeImagesRequest

public class DescribeImagesRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类
限定符和类型类和说明

static class DescribeImagesRequest.DescribeImagesRequestFilter

static class DescribeImagesRequest.DescribeImagesRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`DescribeImagesRequest.DescribeImagesRequestFilter`
`static class`	`DescribeImagesRequest.DescribeImagesRequestTag`

字段概要

字段
限定符和类型	字段和说明
`String`	`actionType` The scenario in which the image is used.
`String`	`architecture` The architecture of the image.
`Boolean`	`dryRun` Specifies whether to perform only a dry run without performing the actual request.
`List<DescribeImagesRequest.DescribeImagesRequestFilter>`	`filter` The list of filter conditions used to query resources.
`String`	`imageFamily` The name of the image family.
`String`	`imageId` The image IDs.
`String`	`imageName` The image name.
`String`	`imageOwnerAlias` The image source.
`Long`	`imageOwnerId` The ID of the Alibaba Cloud account to which the image belongs.
`String`	`instanceType` The instance type for which the image can be used.
`Boolean`	`isPublic` Specifies whether to query published community images.
`Boolean`	`isSupportCloudinit` Specifies whether the image supports cloud-init.
`Boolean`	`isSupportIoOptimized` Specifies whether the image can be used on I/O optimized instances.
`String`	`OSType` The operating system type of the image.
`String`	`ownerAccount`
`Long`	`ownerId`
`Integer`	`pageNumber` The page number to return.
`Integer`	`pageSize` The number of entries per page.
`String`	`regionId` The region ID of the image.
`String`	`resourceGroupId` The ID of the resource group to which the custom image belongs.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`Boolean`	`showExpired` Specifies whether the subscription image has expired.
`String`	`snapshotId` The ID of the snapshot used to create the custom image.
`String`	`status` The status of the image.
`List<DescribeImagesRequest.DescribeImagesRequestTag>`	`tag` The tags list.
`String`	`usage` Specifies whether the image is running on an Elastic Compute Service (ECS) instance.

构造器概要

构造器
构造器和说明

DescribeImagesRequest()

构造器
构造器和说明
`DescribeImagesRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static DescribeImagesRequest`	`build(Map<String,?> map)`
`String`	`getActionType()`
`String`	`getArchitecture()`
`Boolean`	`getDryRun()`
`List<DescribeImagesRequest.DescribeImagesRequestFilter>`	`getFilter()`
`String`	`getImageFamily()`
`String`	`getImageId()`
`String`	`getImageName()`
`String`	`getImageOwnerAlias()`
`Long`	`getImageOwnerId()`
`String`	`getInstanceType()`
`Boolean`	`getIsPublic()`
`Boolean`	`getIsSupportCloudinit()`
`Boolean`	`getIsSupportIoOptimized()`
`String`	`getOSType()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`Integer`	`getPageNumber()`
`Integer`	`getPageSize()`
`String`	`getRegionId()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`Boolean`	`getShowExpired()`
`String`	`getSnapshotId()`
`String`	`getStatus()`
`List<DescribeImagesRequest.DescribeImagesRequestTag>`	`getTag()`
`String`	`getUsage()`
`DescribeImagesRequest`	`setActionType(String actionType)`
`DescribeImagesRequest`	`setArchitecture(String architecture)`
`DescribeImagesRequest`	`setDryRun(Boolean dryRun)`
`DescribeImagesRequest`	`setFilter(List<DescribeImagesRequest.DescribeImagesRequestFilter> filter)`
`DescribeImagesRequest`	`setImageFamily(String imageFamily)`
`DescribeImagesRequest`	`setImageId(String imageId)`
`DescribeImagesRequest`	`setImageName(String imageName)`
`DescribeImagesRequest`	`setImageOwnerAlias(String imageOwnerAlias)`
`DescribeImagesRequest`	`setImageOwnerId(Long imageOwnerId)`
`DescribeImagesRequest`	`setInstanceType(String instanceType)`
`DescribeImagesRequest`	`setIsPublic(Boolean isPublic)`
`DescribeImagesRequest`	`setIsSupportCloudinit(Boolean isSupportCloudinit)`
`DescribeImagesRequest`	`setIsSupportIoOptimized(Boolean isSupportIoOptimized)`
`DescribeImagesRequest`	`setOSType(String OSType)`
`DescribeImagesRequest`	`setOwnerAccount(String ownerAccount)`
`DescribeImagesRequest`	`setOwnerId(Long ownerId)`
`DescribeImagesRequest`	`setPageNumber(Integer pageNumber)`
`DescribeImagesRequest`	`setPageSize(Integer pageSize)`
`DescribeImagesRequest`	`setRegionId(String regionId)`
`DescribeImagesRequest`	`setResourceGroupId(String resourceGroupId)`
`DescribeImagesRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`DescribeImagesRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`DescribeImagesRequest`	`setShowExpired(Boolean showExpired)`
`DescribeImagesRequest`	`setSnapshotId(String snapshotId)`
`DescribeImagesRequest`	`setStatus(String status)`
`DescribeImagesRequest`	`setTag(List<DescribeImagesRequest.DescribeImagesRequestTag> tag)`
`DescribeImagesRequest`	`setUsage(String usage)`

从类继承的方法 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

- 字段详细资料
  - actionType
```
@NameInMap(value="ActionType")
public String actionType
```
    The scenario in which the image is used. Valid values:
    - CreateEcs: instance creation
    - ChangeOS: replacement of the system disk or OS
    example:
    CreateEcs
  - architecture
```
@NameInMap(value="Architecture")
public String architecture
```
    The architecture of the image. Valid values:
    - i386
    - x86_64
    - arm64
    example:
    i386
  - dryRun
```
@NameInMap(value="DryRun")
public Boolean dryRun
```
    Specifies whether to perform only a dry run without performing the actual request.
    - true: performs only a dry run. The system checks whether your AccessKey pair is valid, whether RAM users are granted required permissions, and whether the required parameters are specified. 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.
    example:
    false
  - filter
```
@NameInMap(value="Filter")
public List<DescribeImagesRequest.DescribeImagesRequestFilter> filter
```
    The list of filter conditions used to query resources.
  - imageFamily
```
@NameInMap(value="ImageFamily")
public String imageFamily
```
    The name of the image family. You can set this parameter to query images of the specified image family.
    
    This parameter is empty by default.
    
    For information about image families that are associated with Alibaba Cloud official images, see Overview of public images.
    
    example:
    hangzhou-daily-update
  - imageId
```
@NameInMap(value="ImageId")
public String imageId
```
    The image IDs.
    example:
    m-bp1g7004ksh0oeuc****
  - imageName
```
@NameInMap(value="ImageName")
public String imageName
```
    The image name.
    example:
    testImageName
  - imageOwnerAlias
```
@NameInMap(value="ImageOwnerAlias")
public String imageOwnerAlias
```
    The image source. Valid values:
    - system: images that are provided by Alibaba Cloud and are not released in Alibaba Cloud Marketplace, which are different from public images in the Elastic Compute Service (ECS) console.
    - self: your custom images
    - others: shared images (images shared by other Alibaba Cloud accounts) and community images (publicly available custom images that are published by other Alibaba Cloud accounts). Take note of the following items:
      
      To query community images, you must set IsPublic to true.
      
      To query shared images, you must set IsPublic to false or leave IsPublic empty.
    - marketplace: images released by Alibaba Cloud or independent software vendors (ISVs) in the Alibaba Cloud Marketplace, which must be purchased together with ECS instances. Take note of the billing details of the images.
    This parameter is empty by default.
    
    By default, this parameter is empty, which indicates that the following images are queried: public images provided by Alibaba Cloud, custom images in your repository, shared images from other Alibaba Cloud accounts, and community images that are published by other Alibaba Cloud accounts.
    
    example:
    self
  - imageOwnerId
```
@NameInMap(value="ImageOwnerId")
public Long imageOwnerId
```
    The ID of the Alibaba Cloud account to which the image belongs. This parameter takes effect only if you query shared images or community images.
    example:
    1234567890
  - instanceType
```
@NameInMap(value="InstanceType")
public String instanceType
```
    The instance type for which the image can be used.
    example:
    ecs.g5.large
  - isPublic
```
@NameInMap(value="IsPublic")
public Boolean isPublic
```
    Specifies whether to query published community images. Valid values:
    - true: queries published community images. When you set this parameter to true, you must set ImageOwnerAlias to others.
    - false: queries image types other than the community images type. The specific image types to be queried are determined by the ImageOwnerAlias value.
    Default value: false.
    example:
    false
  - isSupportCloudinit
```
@NameInMap(value="IsSupportCloudinit")
public Boolean isSupportCloudinit
```
    Specifies whether the image supports cloud-init.
    example:
    true
  - isSupportIoOptimized
```
@NameInMap(value="IsSupportIoOptimized")
public Boolean isSupportIoOptimized
```
    Specifies whether the image can be used on I/O optimized instances.
    example:
    true
  - OSType
```
@NameInMap(value="OSType")
public String OSType
```
    The operating system type of the image. Valid values:
    - windows
    - linux
    example:
    linux
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - pageNumber
```
@NameInMap(value="PageNumber")
public Integer pageNumber
```
    The page number to return.
    
    Pages start from page 1.
    
    Default value: 1.
    example:
    1
  - pageSize
```
@NameInMap(value="PageSize")
public Integer pageSize
```
    The number of entries per page.
    
    Valid values: 1 to 100.
    
    Default value: 10.
    example:
    1
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the image. You can call the DescribeRegions operation to query the most recent region list.
    
    This parameter is required.
    example:
    cn-hangzhou
  - resourceGroupId
```
@NameInMap(value="ResourceGroupId")
public String resourceGroupId
```
    The ID of the resource group to which the custom image belongs. If you specify this parameter to query resources, up to 1,000 resources that belong to the specified resource group can be returned.
    
    Resources in the default resource group are displayed in the response regardless of whether you specify this parameter.
    
    example:
    rg-bp67acfmxazb4p****
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - showExpired
```
@NameInMap(value="ShowExpired")
public Boolean showExpired
```
    Specifies whether the subscription image has expired.
    example:
    false
  - snapshotId
```
@NameInMap(value="SnapshotId")
public String snapshotId
```
    The ID of the snapshot used to create the custom image.
    example:
    s-bp17ot2q7x72ggtw****
  - status
```
@NameInMap(value="Status")
public String status
```
    The status of the image. By default, if you do not specify this parameter, only images in the Available state are returned. Valid values:
    - Creating: The image is being created.
    - Waiting: The image is waiting to be processed.
    - Available: The image is available.
    - UnAvailable: The image is unavailable.
    - CreateFailed: The image failed to be created.
    - Deprecated: The image is deprecated.
    Default value: Available. You can specify multiple values for this parameter. Separate the values with commas (,).
    example:
    Available
  - tag
```
@NameInMap(value="Tag")
public List<DescribeImagesRequest.DescribeImagesRequestTag> tag
```
    The tags list.
  - usage
```
@NameInMap(value="Usage")
public String usage
```
    Specifies whether the image is running on an Elastic Compute Service (ECS) instance. Valid values:
    - instance: The image is already in use and running on an ECS instance.
    - none: The image is idle.
    example:
    instance
- 构造器详细资料
  - DescribeImagesRequest
```
public DescribeImagesRequest()
```
- 方法详细资料
  - build
```
public static DescribeImagesRequest build(Map<String,?> map)
                                   throws Exception
```
    抛出:
    
    Exception
  - setActionType
```
public DescribeImagesRequest setActionType(String actionType)
```
  - getActionType
```
public String getActionType()
```
  - setArchitecture
```
public DescribeImagesRequest setArchitecture(String architecture)
```
  - getArchitecture
```
public String getArchitecture()
```
  - setDryRun
```
public DescribeImagesRequest setDryRun(Boolean dryRun)
```
  - getDryRun
```
public Boolean getDryRun()
```
  - setFilter
```
public DescribeImagesRequest setFilter(List<DescribeImagesRequest.DescribeImagesRequestFilter> filter)
```
  - getFilter
```
public List<DescribeImagesRequest.DescribeImagesRequestFilter> getFilter()
```
  - setImageFamily
```
public DescribeImagesRequest setImageFamily(String imageFamily)
```
  - getImageFamily
```
public String getImageFamily()
```
  - setImageId
```
public DescribeImagesRequest setImageId(String imageId)
```
  - getImageId
```
public String getImageId()
```
  - setImageName
```
public DescribeImagesRequest setImageName(String imageName)
```
  - getImageName
```
public String getImageName()
```
  - setImageOwnerAlias
```
public DescribeImagesRequest setImageOwnerAlias(String imageOwnerAlias)
```
  - getImageOwnerAlias
```
public String getImageOwnerAlias()
```
  - setImageOwnerId
```
public DescribeImagesRequest setImageOwnerId(Long imageOwnerId)
```
  - getImageOwnerId
```
public Long getImageOwnerId()
```
  - setInstanceType
```
public DescribeImagesRequest setInstanceType(String instanceType)
```
  - getInstanceType
```
public String getInstanceType()
```
  - setIsPublic
```
public DescribeImagesRequest setIsPublic(Boolean isPublic)
```
  - getIsPublic
```
public Boolean getIsPublic()
```
  - setIsSupportCloudinit
```
public DescribeImagesRequest setIsSupportCloudinit(Boolean isSupportCloudinit)
```
  - getIsSupportCloudinit
```
public Boolean getIsSupportCloudinit()
```
  - setIsSupportIoOptimized
```
public DescribeImagesRequest setIsSupportIoOptimized(Boolean isSupportIoOptimized)
```
  - getIsSupportIoOptimized
```
public Boolean getIsSupportIoOptimized()
```
  - setOSType
```
public DescribeImagesRequest setOSType(String OSType)
```
  - getOSType
```
public String getOSType()
```
  - setOwnerAccount
```
public DescribeImagesRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public DescribeImagesRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setPageNumber
```
public DescribeImagesRequest setPageNumber(Integer pageNumber)
```
  - getPageNumber
```
public Integer getPageNumber()
```
  - setPageSize
```
public DescribeImagesRequest setPageSize(Integer pageSize)
```
  - getPageSize
```
public Integer getPageSize()
```
  - setRegionId
```
public DescribeImagesRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setResourceGroupId
```
public DescribeImagesRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public DescribeImagesRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public DescribeImagesRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setShowExpired
```
public DescribeImagesRequest setShowExpired(Boolean showExpired)
```
  - getShowExpired
```
public Boolean getShowExpired()
```
  - setSnapshotId
```
public DescribeImagesRequest setSnapshotId(String snapshotId)
```
  - getSnapshotId
```
public String getSnapshotId()
```
  - setStatus
```
public DescribeImagesRequest setStatus(String status)
```
  - getStatus
```
public String getStatus()
```
  - setTag
```
public DescribeImagesRequest setTag(List<DescribeImagesRequest.DescribeImagesRequestTag> tag)
```
  - getTag
```
public List<DescribeImagesRequest.DescribeImagesRequestTag> getTag()
```
  - setUsage
```
public DescribeImagesRequest setUsage(String usage)
```
  - getUsage
```
public String getUsage()
```

类 DescribeImagesRequest

嵌套类概要

字段概要

构造器概要

方法概要

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

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

字段详细资料

actionType

architecture

dryRun

filter

imageFamily

imageId

imageName

imageOwnerAlias

imageOwnerId

instanceType

isPublic

isSupportCloudinit

isSupportIoOptimized

OSType

ownerAccount

ownerId

pageNumber

pageSize

regionId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

showExpired

snapshotId

status

tag

usage

构造器详细资料

DescribeImagesRequest

方法详细资料

build

setActionType

getActionType

setArchitecture

getArchitecture

setDryRun

getDryRun

setFilter

getFilter

setImageFamily

getImageFamily

setImageId

getImageId

setImageName

getImageName

setImageOwnerAlias

getImageOwnerAlias

setImageOwnerId

getImageOwnerId

setInstanceType

getInstanceType

setIsPublic

getIsPublic

setIsSupportCloudinit

getIsSupportCloudinit

setIsSupportIoOptimized

getIsSupportIoOptimized

setOSType

getOSType

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setPageNumber

getPageNumber

setPageSize

getPageSize

setRegionId

getRegionId

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount