DescribeDisksRequest (ecs20140526 3.1.10 API)

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

public class DescribeDisksRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

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

static class DescribeDisksRequest.DescribeDisksRequestFilter

static class DescribeDisksRequest.DescribeDisksRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`DescribeDisksRequest.DescribeDisksRequestFilter`
`static class`	`DescribeDisksRequest.DescribeDisksRequestTag`

字段概要

字段
限定符和类型	字段和说明
`List<String>`	`additionalAttributes` The values of attributes.
`String`	`autoSnapshotPolicyId` The ID of the automatic snapshot policy that is applied to the cloud disk.
`String`	`category` The category of the disk.
`Boolean`	`deleteAutoSnapshot` Specifies whether to delete the automatic snapshots of the cloud disk when the disk is released.
`Boolean`	`deleteWithInstance` Specifies whether to release the cloud disk when its associated instance is released.
`String`	`diskChargeType` The billing method of the disk.
`String`	`diskIds` The IDs of disks.
`String`	`diskName` The name of the disk.
`String`	`diskType` The type of the disk.
`Boolean`	`dryRun` Specifies whether to check the validity of the request without actually making the request.
`Boolean`	`enableAutomatedSnapshotPolicy` Specifies whether an automatic snapshot policy is applied to the cloud disk.
`Boolean`	`enableAutoSnapshot` Specifies whether the automatic snapshot policy feature is enabled for the cloud disk.
`Boolean`	`enableShared` Specifies whether the disk is a Shared Block Storage device.
`Boolean`	`encrypted` Specifies whether to query only encrypted cloud disks.
`List<DescribeDisksRequest.DescribeDisksRequestFilter>`	`filter`
`String`	`instanceId` The ID of the instance to which the disk is attached.
`String`	`KMSKeyId` The ID of the Key Management Service (KMS) key used by the cloud disk.
`String`	`lockReason` The reason why the disk is locked.
`Integer`	`maxResults` The maximum number of entries to return on each page.
`String`	`multiAttach` Specifies whether the multi-attach feature is enabled for the disk.
`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.
`Boolean`	`portable` Specifies whether the disk is removable.
`String`	`regionId` The region ID of the disk.
`String`	`resourceGroupId` The ID of the resource group to which the disk belongs.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`String`	`snapshotId` The ID of the snapshot that was used to create the cloud disk.
`String`	`status` The state of the cloud disk.
`List<DescribeDisksRequest.DescribeDisksRequestTag>`	`tag` The tags.
`String`	`zoneId` The zone ID of the disk.

构造器概要

构造器
构造器和说明

DescribeDisksRequest()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static DescribeDisksRequest`	`build(Map<String,?> map)`
`List<String>`	`getAdditionalAttributes()`
`String`	`getAutoSnapshotPolicyId()`
`String`	`getCategory()`
`Boolean`	`getDeleteAutoSnapshot()`
`Boolean`	`getDeleteWithInstance()`
`String`	`getDiskChargeType()`
`String`	`getDiskIds()`
`String`	`getDiskName()`
`String`	`getDiskType()`
`Boolean`	`getDryRun()`
`Boolean`	`getEnableAutomatedSnapshotPolicy()`
`Boolean`	`getEnableAutoSnapshot()`
`Boolean`	`getEnableShared()`
`Boolean`	`getEncrypted()`
`List<DescribeDisksRequest.DescribeDisksRequestFilter>`	`getFilter()`
`String`	`getInstanceId()`
`String`	`getKMSKeyId()`
`String`	`getLockReason()`
`Integer`	`getMaxResults()`
`String`	`getMultiAttach()`
`String`	`getNextToken()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`Integer`	`getPageNumber()`
`Integer`	`getPageSize()`
`Boolean`	`getPortable()`
`String`	`getRegionId()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`String`	`getSnapshotId()`
`String`	`getStatus()`
`List<DescribeDisksRequest.DescribeDisksRequestTag>`	`getTag()`
`String`	`getZoneId()`
`DescribeDisksRequest`	`setAdditionalAttributes(List<String> additionalAttributes)`
`DescribeDisksRequest`	`setAutoSnapshotPolicyId(String autoSnapshotPolicyId)`
`DescribeDisksRequest`	`setCategory(String category)`
`DescribeDisksRequest`	`setDeleteAutoSnapshot(Boolean deleteAutoSnapshot)`
`DescribeDisksRequest`	`setDeleteWithInstance(Boolean deleteWithInstance)`
`DescribeDisksRequest`	`setDiskChargeType(String diskChargeType)`
`DescribeDisksRequest`	`setDiskIds(String diskIds)`
`DescribeDisksRequest`	`setDiskName(String diskName)`
`DescribeDisksRequest`	`setDiskType(String diskType)`
`DescribeDisksRequest`	`setDryRun(Boolean dryRun)`
`DescribeDisksRequest`	`setEnableAutomatedSnapshotPolicy(Boolean enableAutomatedSnapshotPolicy)`
`DescribeDisksRequest`	`setEnableAutoSnapshot(Boolean enableAutoSnapshot)`
`DescribeDisksRequest`	`setEnableShared(Boolean enableShared)`
`DescribeDisksRequest`	`setEncrypted(Boolean encrypted)`
`DescribeDisksRequest`	`setFilter(List<DescribeDisksRequest.DescribeDisksRequestFilter> filter)`
`DescribeDisksRequest`	`setInstanceId(String instanceId)`
`DescribeDisksRequest`	`setKMSKeyId(String KMSKeyId)`
`DescribeDisksRequest`	`setLockReason(String lockReason)`
`DescribeDisksRequest`	`setMaxResults(Integer maxResults)`
`DescribeDisksRequest`	`setMultiAttach(String multiAttach)`
`DescribeDisksRequest`	`setNextToken(String nextToken)`
`DescribeDisksRequest`	`setOwnerAccount(String ownerAccount)`
`DescribeDisksRequest`	`setOwnerId(Long ownerId)`
`DescribeDisksRequest`	`setPageNumber(Integer pageNumber)`
`DescribeDisksRequest`	`setPageSize(Integer pageSize)`
`DescribeDisksRequest`	`setPortable(Boolean portable)`
`DescribeDisksRequest`	`setRegionId(String regionId)`
`DescribeDisksRequest`	`setResourceGroupId(String resourceGroupId)`
`DescribeDisksRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`DescribeDisksRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`DescribeDisksRequest`	`setSnapshotId(String snapshotId)`
`DescribeDisksRequest`	`setStatus(String status)`
`DescribeDisksRequest`	`setTag(List<DescribeDisksRequest.DescribeDisksRequestTag> tag)`
`DescribeDisksRequest`	`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<DescribeDisksRequest.DescribeDisksRequestFilter> filter
```
  - additionalAttributes
```
@NameInMap(value="AdditionalAttributes")
public List<String> additionalAttributes
```
    The values of attributes.
  - autoSnapshotPolicyId
```
@NameInMap(value="AutoSnapshotPolicyId")
public String autoSnapshotPolicyId
```
    The ID of the automatic snapshot policy that is applied to the cloud disk.
  - category
```
@NameInMap(value="Category")
public String category
```
    The category of the disk. Valid values:
    
    * all: all disk categories
    
    * cloud: basic disk
    
    * cloud_efficiency: ultra disk
    
    * cloud_ssd: standard SSD
    
    * cloud_essd: enhanced SSD (ESSD)
    
    * local\_ssd_pro: I/O-intensive local disk
    
    * local\_hdd_pro: throughput-intensive local disk
    
    * ephemeral: retired local disk
    
    * ephemeral_ssd: retired local SSD
    
    Default value: all.
  - deleteAutoSnapshot
```
@NameInMap(value="DeleteAutoSnapshot")
public Boolean deleteAutoSnapshot
```
    Specifies whether to delete the automatic snapshots of the cloud disk when the disk is released.
    
    * true: The automatic snapshots of the cloud disk are deleted when the disk is released.
    
    * false: The automatic snapshots of the cloud disk are not deleted when the disk is released.
    
    Default value: false.
  - deleteWithInstance
```
@NameInMap(value="DeleteWithInstance")
public Boolean deleteWithInstance
```
    Specifies whether to release the cloud disk when its associated instance is released. Valid values:
    
    * true: The cloud disk is released when its associated instance is released.
    
    * false: The cloud disk is not released but is retained as a pay-as-you-go data disk when its associated instance is released.
    
    Default value: false.
  - diskChargeType
```
@NameInMap(value="DiskChargeType")
public String diskChargeType
```
    The billing method of the disk. Valid values:
    
    * PrePaid: subscription
    
    * PostPaid: pay-as-you-go
  - diskIds
```
@NameInMap(value="DiskIds")
public String diskIds
```
    The IDs of disks. The value is a JSON array that consists of up to 100 disk IDs. Separate the disk IDs with commas (,).
  - diskName
```
@NameInMap(value="DiskName")
public String diskName
```
    The name of the disk.
  - diskType
```
@NameInMap(value="DiskType")
public String diskType
```
    The type of the disk. Valid values:
    
    * all: system disk and data disk
    
    * system: system disk
    
    * data: data disk
    
    Default value: all.
  - dryRun
```
@NameInMap(value="DryRun")
public Boolean dryRun
```
    Specifies whether to check the validity of the request without actually making the request. 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 Resource Access Management (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.
    
    Default value: false.
  - enableAutoSnapshot
```
@NameInMap(value="EnableAutoSnapshot")
public Boolean enableAutoSnapshot
```
    Specifies whether the automatic snapshot policy feature is enabled for the cloud disk.
    
    * true: The automatic snapshot policy feature is enabled for the cloud disk.
    
    * false: The automatic snapshot policy feature is not enabled for the cloud disk.
    
    > By default, the automatic snapshot policy feature is enabled for created cloud disks. You only need to apply an automatic snapshot policy to a cloud disk before you can use the automatic snapshot policy.
  - enableAutomatedSnapshotPolicy
```
@NameInMap(value="EnableAutomatedSnapshotPolicy")
public Boolean enableAutomatedSnapshotPolicy
```
    Specifies whether an automatic snapshot policy is applied to the cloud disk.
    
    * true: An automatic snapshot policy is applied to the cloud disk.
    
    * false: No automatic snapshot policy is applied to the cloud disk.
    
    Default value: false.
  - enableShared
```
@NameInMap(value="EnableShared")
public Boolean enableShared
```
    Specifies whether the disk is a Shared Block Storage device.
  - encrypted
```
@NameInMap(value="Encrypted")
public Boolean encrypted
```
    Specifies whether to query only encrypted cloud disks.
    
    * true: queries only encrypted cloud disks.
    
    * false: does not query encrypted cloud disks.
    
    Default value: false.
  - instanceId
```
@NameInMap(value="InstanceId")
public String instanceId
```
    The ID of the instance to which the disk is attached.
  - KMSKeyId
```
@NameInMap(value="KMSKeyId")
public String KMSKeyId
```
    The ID of the Key Management Service (KMS) key used by the cloud disk.
  - lockReason
```
@NameInMap(value="LockReason")
public String lockReason
```
    The reason why the disk is locked. Valid values:
    
    * financial: The disk is locked due to overdue payments.
    
    * security: The disk 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.
  - maxResults
```
@NameInMap(value="MaxResults")
public Integer maxResults
```
    The maximum number of entries to return on each page. Valid values: 1 to 500.
    
    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 500, the default value is 500.
  - multiAttach
```
@NameInMap(value="MultiAttach")
public String multiAttach
```
    Specifies whether the multi-attach feature is enabled for the disk. Valid values:
    
    * Disabled: The multi-attach feature is not enabled for the disk.
    
    * Enabled: The multi-attach feature is enabled for the disk.
    
    * LegacyShared: Shared Block Storage devices are queried.
    
    The multi-attach feature is in invitational preview. To use this feature, [submit a ticket](https://workorder-intl.console.aliyun.com/console.htm#/ticket/list).
  - nextToken
```
@NameInMap(value="NextToken")
public String nextToken
```
    The query token. Set the value to the `NextToken` value returned in the last call to the Describedisks operation.
    
    For more information about how to check the responses returned by this operation, see the preceding "Description" section.
  - 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.
    
    Page 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.
  - portable
```
@NameInMap(value="Portable")
public Boolean portable
```
    Specifies whether the disk is removable. Valid values:
    
    * true: The disk is removable. A removable disk can independently exist and can be attached to or detached from an instance within the same zone.
    
    * false: The disk is not removable. A disk that is not removable cannot independently exist or be attached to or detached from an instance within the same zone.
    
    The `Portable` attribute of the following disks is `false`, and these disks share the same lifecycle with their associated instances:
    
    * Local disks
    
    * Local SSDs
    
    * Subscription data disks
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the disk. 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 disk 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
```
  - snapshotId
```
@NameInMap(value="SnapshotId")
public String snapshotId
```
    The ID of the snapshot that was used to create the cloud disk.
  - status
```
@NameInMap(value="Status")
public String status
```
    The state of the cloud disk. For more information, see [Disk states](~~25689~~). Valid values:
    
    * In_use
    
    * Available
    
    * Attaching
    
    * Detaching
    
    * Creating
    
    * ReIniting
    
    * All
    
    Default value: All.
  - tag
```
@NameInMap(value="Tag")
public List<DescribeDisksRequest.DescribeDisksRequestTag> tag
```
    The tags.
  - zoneId
```
@NameInMap(value="ZoneId")
public String zoneId
```
    The zone ID of the disk.
- 构造器详细资料
  - DescribeDisksRequest
```
public DescribeDisksRequest()
```
- 方法详细资料
  - build
```
public static DescribeDisksRequest build(Map<String,?> map)
                                  throws Exception
```
    抛出:
    
    Exception
  - setFilter
```
public DescribeDisksRequest setFilter(List<DescribeDisksRequest.DescribeDisksRequestFilter> filter)
```
  - getFilter
```
public List<DescribeDisksRequest.DescribeDisksRequestFilter> getFilter()
```
  - setAdditionalAttributes
```
public DescribeDisksRequest setAdditionalAttributes(List<String> additionalAttributes)
```
  - getAdditionalAttributes
```
public List<String> getAdditionalAttributes()
```
  - setAutoSnapshotPolicyId
```
public DescribeDisksRequest setAutoSnapshotPolicyId(String autoSnapshotPolicyId)
```
  - getAutoSnapshotPolicyId
```
public String getAutoSnapshotPolicyId()
```
  - setCategory
```
public DescribeDisksRequest setCategory(String category)
```
  - getCategory
```
public String getCategory()
```
  - setDeleteAutoSnapshot
```
public DescribeDisksRequest setDeleteAutoSnapshot(Boolean deleteAutoSnapshot)
```
  - getDeleteAutoSnapshot
```
public Boolean getDeleteAutoSnapshot()
```
  - setDeleteWithInstance
```
public DescribeDisksRequest setDeleteWithInstance(Boolean deleteWithInstance)
```
  - getDeleteWithInstance
```
public Boolean getDeleteWithInstance()
```
  - setDiskChargeType
```
public DescribeDisksRequest setDiskChargeType(String diskChargeType)
```
  - getDiskChargeType
```
public String getDiskChargeType()
```
  - setDiskIds
```
public DescribeDisksRequest setDiskIds(String diskIds)
```
  - getDiskIds
```
public String getDiskIds()
```
  - setDiskName
```
public DescribeDisksRequest setDiskName(String diskName)
```
  - getDiskName
```
public String getDiskName()
```
  - setDiskType
```
public DescribeDisksRequest setDiskType(String diskType)
```
  - getDiskType
```
public String getDiskType()
```
  - setDryRun
```
public DescribeDisksRequest setDryRun(Boolean dryRun)
```
  - getDryRun
```
public Boolean getDryRun()
```
  - setEnableAutoSnapshot
```
public DescribeDisksRequest setEnableAutoSnapshot(Boolean enableAutoSnapshot)
```
  - getEnableAutoSnapshot
```
public Boolean getEnableAutoSnapshot()
```
  - setEnableAutomatedSnapshotPolicy
```
public DescribeDisksRequest setEnableAutomatedSnapshotPolicy(Boolean enableAutomatedSnapshotPolicy)
```
  - getEnableAutomatedSnapshotPolicy
```
public Boolean getEnableAutomatedSnapshotPolicy()
```
  - setEnableShared
```
public DescribeDisksRequest setEnableShared(Boolean enableShared)
```
  - getEnableShared
```
public Boolean getEnableShared()
```
  - setEncrypted
```
public DescribeDisksRequest setEncrypted(Boolean encrypted)
```
  - getEncrypted
```
public Boolean getEncrypted()
```
  - setInstanceId
```
public DescribeDisksRequest setInstanceId(String instanceId)
```
  - getInstanceId
```
public String getInstanceId()
```
  - setKMSKeyId
```
public DescribeDisksRequest setKMSKeyId(String KMSKeyId)
```
  - getKMSKeyId
```
public String getKMSKeyId()
```
  - setLockReason
```
public DescribeDisksRequest setLockReason(String lockReason)
```
  - getLockReason
```
public String getLockReason()
```
  - setMaxResults
```
public DescribeDisksRequest setMaxResults(Integer maxResults)
```
  - getMaxResults
```
public Integer getMaxResults()
```
  - setMultiAttach
```
public DescribeDisksRequest setMultiAttach(String multiAttach)
```
  - getMultiAttach
```
public String getMultiAttach()
```
  - setNextToken
```
public DescribeDisksRequest setNextToken(String nextToken)
```
  - getNextToken
```
public String getNextToken()
```
  - setOwnerAccount
```
public DescribeDisksRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public DescribeDisksRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setPageNumber
```
public DescribeDisksRequest setPageNumber(Integer pageNumber)
```
  - getPageNumber
```
public Integer getPageNumber()
```
  - setPageSize
```
public DescribeDisksRequest setPageSize(Integer pageSize)
```
  - getPageSize
```
public Integer getPageSize()
```
  - setPortable
```
public DescribeDisksRequest setPortable(Boolean portable)
```
  - getPortable
```
public Boolean getPortable()
```
  - setRegionId
```
public DescribeDisksRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setResourceGroupId
```
public DescribeDisksRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public DescribeDisksRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public DescribeDisksRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setSnapshotId
```
public DescribeDisksRequest setSnapshotId(String snapshotId)
```
  - getSnapshotId
```
public String getSnapshotId()
```
  - setStatus
```
public DescribeDisksRequest setStatus(String status)
```
  - getStatus
```
public String getStatus()
```
  - setTag
```
public DescribeDisksRequest setTag(List<DescribeDisksRequest.DescribeDisksRequestTag> tag)
```
  - getTag
```
public List<DescribeDisksRequest.DescribeDisksRequestTag> getTag()
```
  - setZoneId
```
public DescribeDisksRequest setZoneId(String zoneId)
```
  - getZoneId
```
public String getZoneId()
```

类 DescribeDisksRequest

嵌套类概要

字段概要

构造器概要

方法概要

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

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

字段详细资料

filter

additionalAttributes

autoSnapshotPolicyId

category

deleteAutoSnapshot

deleteWithInstance

diskChargeType

diskIds

diskName

diskType

dryRun

enableAutoSnapshot

enableAutomatedSnapshotPolicy

enableShared

encrypted

instanceId

KMSKeyId

lockReason

maxResults

multiAttach

nextToken

ownerAccount

ownerId

pageNumber

pageSize

portable

regionId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

snapshotId

status

tag

zoneId

构造器详细资料

DescribeDisksRequest

方法详细资料

build

setFilter

getFilter

setAdditionalAttributes

getAdditionalAttributes

setAutoSnapshotPolicyId

getAutoSnapshotPolicyId

setCategory

getCategory

setDeleteAutoSnapshot

getDeleteAutoSnapshot

setDeleteWithInstance

getDeleteWithInstance

setDiskChargeType

getDiskChargeType

setDiskIds

getDiskIds

setDiskName

getDiskName

setDiskType

getDiskType

setDryRun

getDryRun

setEnableAutoSnapshot

getEnableAutoSnapshot

setEnableAutomatedSnapshotPolicy

getEnableAutomatedSnapshotPolicy

setEnableShared

getEnableShared

setEncrypted

getEncrypted

setInstanceId

getInstanceId

setKMSKeyId

getKMSKeyId