com.aliyun.ecs20140526.models

类 DescribeSnapshotsRequest

java.lang.Object

com.aliyun.tea.TeaModel

com.aliyun.ecs20140526.models.DescribeSnapshotsRequest

public class DescribeSnapshotsRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	DescribeSnapshotsRequest.DescribeSnapshotsRequestFilter
static class	DescribeSnapshotsRequest.DescribeSnapshotsRequestTag

字段概要

字段

限定符和类型	字段和说明
String	category The type of the snapshot.
String	diskId The ID of the disk.
Boolean	dryRun Specifies whether to perform a dry run.
Boolean	encrypted Specifies whether the snapshot is encrypted.
List<DescribeSnapshotsRequest.DescribeSnapshotsRequestFilter>	filter
String	instanceId The ID of the instance.
String	KMSKeyId The ID of the Key Management Service (KMS) key that is used for the data disk.
Integer	maxResults The maximum number of entries to return on each page.
String	nextToken The token used to start the query.
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	regionId The region ID of the disk.
String	resourceGroupId The ID of the resource group to which the snapshot belongs.
String	resourceOwnerAccount
Long	resourceOwnerId
String	snapshotIds The IDs of snapshots.
String	snapshotLinkId The ID of the snapshot chain.
String	snapshotName The name of the snapshot.
String	snapshotType The type of the snapshot.
String	sourceDiskType The type of the source disk for which the snapshot was created.
String	status The state of the snapshot.
List<DescribeSnapshotsRequest.DescribeSnapshotsRequestTag>	tag The tags of the snapshot.
String	usage Specifies whether the snapshot has been used to create custom images or disks.

构造器概要

构造器

构造器和说明
DescribeSnapshotsRequest()

方法概要

限定符和类型	方法和说明
static DescribeSnapshotsRequest	build(Map<String,?> map)
String	getCategory()
String	getDiskId()
Boolean	getDryRun()
Boolean	getEncrypted()
List<DescribeSnapshotsRequest.DescribeSnapshotsRequestFilter>	getFilter()
String	getInstanceId()
String	getKMSKeyId()
Integer	getMaxResults()
String	getNextToken()
String	getOwnerAccount()
Long	getOwnerId()
Integer	getPageNumber()
Integer	getPageSize()
String	getRegionId()
String	getResourceGroupId()
String	getResourceOwnerAccount()
Long	getResourceOwnerId()
String	getSnapshotIds()
String	getSnapshotLinkId()
String	getSnapshotName()
String	getSnapshotType()
String	getSourceDiskType()
String	getStatus()
List<DescribeSnapshotsRequest.DescribeSnapshotsRequestTag>	getTag()
String	getUsage()
DescribeSnapshotsRequest	setCategory(String category)
DescribeSnapshotsRequest	setDiskId(String diskId)
DescribeSnapshotsRequest	setDryRun(Boolean dryRun)
DescribeSnapshotsRequest	setEncrypted(Boolean encrypted)
DescribeSnapshotsRequest	setFilter(List<DescribeSnapshotsRequest.DescribeSnapshotsRequestFilter> filter)
DescribeSnapshotsRequest	setInstanceId(String instanceId)
DescribeSnapshotsRequest	setKMSKeyId(String KMSKeyId)
DescribeSnapshotsRequest	setMaxResults(Integer maxResults)
DescribeSnapshotsRequest	setNextToken(String nextToken)
DescribeSnapshotsRequest	setOwnerAccount(String ownerAccount)
DescribeSnapshotsRequest	setOwnerId(Long ownerId)
DescribeSnapshotsRequest	setPageNumber(Integer pageNumber)
DescribeSnapshotsRequest	setPageSize(Integer pageSize)
DescribeSnapshotsRequest	setRegionId(String regionId)
DescribeSnapshotsRequest	setResourceGroupId(String resourceGroupId)
DescribeSnapshotsRequest	setResourceOwnerAccount(String resourceOwnerAccount)
DescribeSnapshotsRequest	setResourceOwnerId(Long resourceOwnerId)
DescribeSnapshotsRequest	setSnapshotIds(String snapshotIds)
DescribeSnapshotsRequest	setSnapshotLinkId(String snapshotLinkId)
DescribeSnapshotsRequest	setSnapshotName(String snapshotName)
DescribeSnapshotsRequest	setSnapshotType(String snapshotType)
DescribeSnapshotsRequest	setSourceDiskType(String sourceDiskType)
DescribeSnapshotsRequest	setStatus(String status)
DescribeSnapshotsRequest	setTag(List<DescribeSnapshotsRequest.DescribeSnapshotsRequestTag> tag)
DescribeSnapshotsRequest	setUsage(String usage)

从类继承的方法 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<DescribeSnapshotsRequest.DescribeSnapshotsRequestFilter> filter

category

@NameInMap(value="Category")
public String category

The type of the snapshot. Valid values:

* Standard: normal snapshot

* Flash: local snapshot

The local snapshot feature is replaced by the instant access feature. When you specify this parameter, take note of the following items:

* If you have used local snapshots before December 14, 2020, you can use this parameter.

* If you have not used local snapshots before December 14, 2020, you cannot use this parameter.

For more information, see [Snapshot service upgrade and addition of a new billable item on December 14, 2020](https://help.aliyun.com/noticelist/articleid/1060755542.html).

> This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility.

diskId

@NameInMap(value="DiskId")
public String diskId

The ID of the disk.

dryRun

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

Specifies whether to perform a dry run. Default value: false. Valid values:

* true: performs a dry run. The system checks your AccessKey pair, the permissions of the RAM user, and the required parameters. 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 sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.

encrypted

@NameInMap(value="Encrypted")
public Boolean encrypted

Specifies whether the snapshot is encrypted. Default value: false.

instanceId

@NameInMap(value="InstanceId")
public String instanceId

The ID of the instance.

KMSKeyId

@NameInMap(value="KMSKeyId")
public String KMSKeyId

The ID of the Key Management Service (KMS) key that is used for the data disk.

maxResults

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

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

Default value: 10.

nextToken

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

The token used to start the query. Set the value to the NextToken value obtained from the response to the previous request.

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.

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 snapshot 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

snapshotIds

@NameInMap(value="SnapshotIds")
public String snapshotIds

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

snapshotLinkId

@NameInMap(value="SnapshotLinkId")
public String snapshotLinkId

The ID of the snapshot chain. The value is a JSON array that consists of up to 100 snapshot chain IDs. Separate the snapshot chain IDs with commas (,).

snapshotName

@NameInMap(value="SnapshotName")
public String snapshotName

The name of the snapshot.

snapshotType

@NameInMap(value="SnapshotType")
public String snapshotType

The type of the snapshot. Valid values:

* auto: automatic snapshot

* user: manual snapshot

* all: This parameter indicates all snapshot types.

sourceDiskType

@NameInMap(value="SourceDiskType")
public String sourceDiskType

The type of the source disk for which the snapshot was created. Valid values:

* System: system disk

* data: data disk

> The value of this parameter is case-insensitive.

status

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

The state of the snapshot. Default value: all. Valid values:

* progressing: The snapshot is being created.

* accomplished: The snapshot is created.

* failed: The snapshot fails to be created.

* all: This parameter indicates all snapshot states.

tag

@NameInMap(value="Tag")
public List<DescribeSnapshotsRequest.DescribeSnapshotsRequestTag> tag

The tags of the snapshot.

usage

@NameInMap(value="Usage")
public String usage

Specifies whether the snapshot has been used to create custom images or disks. Valid values:

* image: The snapshot has been used to create custom images.

* disk: The snapshot is used to create disks.

* image_disk: The snapshot has been used to create both custom images and data disks.

* none: The snapshot has not been used to create custom images or disks.

构造器详细资料

DescribeSnapshotsRequest

public DescribeSnapshotsRequest()

方法详细资料

build

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

抛出:

Exception

setFilter

public DescribeSnapshotsRequest setFilter(List<DescribeSnapshotsRequest.DescribeSnapshotsRequestFilter> filter)

getFilter

public List<DescribeSnapshotsRequest.DescribeSnapshotsRequestFilter> getFilter()

setCategory

public DescribeSnapshotsRequest setCategory(String category)

getCategory

public String getCategory()

setDiskId

public DescribeSnapshotsRequest setDiskId(String diskId)

getDiskId

public String getDiskId()

setDryRun

public DescribeSnapshotsRequest setDryRun(Boolean dryRun)

getDryRun

public Boolean getDryRun()

setEncrypted

public DescribeSnapshotsRequest setEncrypted(Boolean encrypted)

getEncrypted

public Boolean getEncrypted()

setInstanceId

public DescribeSnapshotsRequest setInstanceId(String instanceId)

getInstanceId

public String getInstanceId()

setKMSKeyId

public DescribeSnapshotsRequest setKMSKeyId(String KMSKeyId)

getKMSKeyId

public String getKMSKeyId()

setMaxResults

public DescribeSnapshotsRequest setMaxResults(Integer maxResults)

getMaxResults

public Integer getMaxResults()

setNextToken

public DescribeSnapshotsRequest setNextToken(String nextToken)

getNextToken

public String getNextToken()

setOwnerAccount

public DescribeSnapshotsRequest setOwnerAccount(String ownerAccount)

getOwnerAccount

public String getOwnerAccount()

setOwnerId

public DescribeSnapshotsRequest setOwnerId(Long ownerId)

getOwnerId

public Long getOwnerId()

setPageNumber

public DescribeSnapshotsRequest setPageNumber(Integer pageNumber)

getPageNumber

public Integer getPageNumber()

setPageSize

public DescribeSnapshotsRequest setPageSize(Integer pageSize)

getPageSize

public Integer getPageSize()

setRegionId

public DescribeSnapshotsRequest setRegionId(String regionId)

getRegionId

public String getRegionId()

setResourceGroupId

public DescribeSnapshotsRequest setResourceGroupId(String resourceGroupId)

getResourceGroupId

public String getResourceGroupId()

setResourceOwnerAccount

public DescribeSnapshotsRequest setResourceOwnerAccount(String resourceOwnerAccount)

getResourceOwnerAccount

public String getResourceOwnerAccount()

setResourceOwnerId

public DescribeSnapshotsRequest setResourceOwnerId(Long resourceOwnerId)

getResourceOwnerId

public Long getResourceOwnerId()

setSnapshotIds

public DescribeSnapshotsRequest setSnapshotIds(String snapshotIds)

getSnapshotIds

public String getSnapshotIds()

setSnapshotLinkId

public DescribeSnapshotsRequest setSnapshotLinkId(String snapshotLinkId)

getSnapshotLinkId

public String getSnapshotLinkId()

setSnapshotName

public DescribeSnapshotsRequest setSnapshotName(String snapshotName)

getSnapshotName

public String getSnapshotName()

setSnapshotType

public DescribeSnapshotsRequest setSnapshotType(String snapshotType)

getSnapshotType

public String getSnapshotType()

setSourceDiskType

public DescribeSnapshotsRequest setSourceDiskType(String sourceDiskType)

getSourceDiskType

public String getSourceDiskType()

setStatus

public DescribeSnapshotsRequest setStatus(String status)

getStatus

public String getStatus()

setTag

public DescribeSnapshotsRequest setTag(List<DescribeSnapshotsRequest.DescribeSnapshotsRequestTag> tag)

getTag

public List<DescribeSnapshotsRequest.DescribeSnapshotsRequestTag> getTag()

setUsage

public DescribeSnapshotsRequest setUsage(String usage)

getUsage

public String getUsage()