CreateSnapshotGroupRequest (ecs20140526 5.4.5 API)

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

public class CreateSnapshotGroupRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

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

static class CreateSnapshotGroupRequest.CreateSnapshotGroupRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`CreateSnapshotGroupRequest.CreateSnapshotGroupRequestTag`

字段概要

字段
限定符和类型	字段和说明
`String`	`clientToken` The client token that is used to ensure the idempotence of the request.
`String`	`description` The description of the snapshot-consistent group.
`List<String>`	`diskId` The ID of cloud disk N for which you want to create snapshots.
`List<String>`	`excludeDiskId` The ID of cloud disk N for which you do not want to create snapshots.
`String`	`instanceId` The instance ID.
`Boolean`	`instantAccess` Specifies whether to enable the instant access feature.
`Integer`	`instantAccessRetentionDays` The number of days for which the instant access feature is available.
`String`	`name` The name of the snapshot-consistent group.
`String`	`ownerAccount`
`Long`	`ownerId`
`String`	`regionId` The region ID of the instance.
`String`	`resourceGroupId` The ID of the resource group to which the snapshot-consistent group belongs.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`String`	`storageLocationArn` This parameter is unavailable for public use.
`List<CreateSnapshotGroupRequest.CreateSnapshotGroupRequestTag>`	`tag` The list of tags.

构造器概要

构造器
构造器和说明

CreateSnapshotGroupRequest()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateSnapshotGroupRequest`	`build(Map<String,?> map)`
`String`	`getClientToken()`
`String`	`getDescription()`
`List<String>`	`getDiskId()`
`List<String>`	`getExcludeDiskId()`
`String`	`getInstanceId()`
`Boolean`	`getInstantAccess()`
`Integer`	`getInstantAccessRetentionDays()`
`String`	`getName()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`String`	`getRegionId()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`String`	`getStorageLocationArn()`
`List<CreateSnapshotGroupRequest.CreateSnapshotGroupRequestTag>`	`getTag()`
`CreateSnapshotGroupRequest`	`setClientToken(String clientToken)`
`CreateSnapshotGroupRequest`	`setDescription(String description)`
`CreateSnapshotGroupRequest`	`setDiskId(List<String> diskId)`
`CreateSnapshotGroupRequest`	`setExcludeDiskId(List<String> excludeDiskId)`
`CreateSnapshotGroupRequest`	`setInstanceId(String instanceId)`
`CreateSnapshotGroupRequest`	`setInstantAccess(Boolean instantAccess)`
`CreateSnapshotGroupRequest`	`setInstantAccessRetentionDays(Integer instantAccessRetentionDays)`
`CreateSnapshotGroupRequest`	`setName(String name)`
`CreateSnapshotGroupRequest`	`setOwnerAccount(String ownerAccount)`
`CreateSnapshotGroupRequest`	`setOwnerId(Long ownerId)`
`CreateSnapshotGroupRequest`	`setRegionId(String regionId)`
`CreateSnapshotGroupRequest`	`setResourceGroupId(String resourceGroupId)`
`CreateSnapshotGroupRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`CreateSnapshotGroupRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`CreateSnapshotGroupRequest`	`setStorageLocationArn(String storageLocationArn)`
`CreateSnapshotGroupRequest`	`setTag(List<CreateSnapshotGroupRequest.CreateSnapshotGroupRequestTag> tag)`

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

- 字段详细资料
  - clientToken
```
@NameInMap(value="ClientToken")
public String clientToken
```
    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.
    example:
    123e4567-e89b-12d3-a456-426655440000
  - description
```
@NameInMap(value="Description")
public String description
```
    The description of the snapshot-consistent group. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
    example:
    This is description.
  - diskId
```
@NameInMap(value="DiskId")
public List<String> diskId
```
    The ID of cloud disk N for which you want to create snapshots. You can specify multiple cloud disk IDs across instances within the same zone. Valid values of N: 1 to 16. A single snapshot-consistent group can contain snapshots of up to 16 cloud disks whose total disk size does not exceed 32 TiB.
    
    Take note of the following items:
    - You cannot specify both DiskId.N and ExcludeDiskId.N in the same request.
    - If InstanceId is set, you can use DiskId.N to specify only cloud disks attached to the instance specified by InstanceId, and you cannot use DiskId.N to specify cloud disks attached to multiple instances.
  - excludeDiskId
```
@NameInMap(value="ExcludeDiskId")
public List<String> excludeDiskId
```
    The ID of cloud disk N for which you do not want to create snapshots. If this parameter is specified, the created snapshot-consistent group does not contain snapshots of the cloud disk. Valid values of N: 1 to 16.
    
    This parameter is empty by default, which indicates that snapshots are created for all the disks of the instance.
    
    You cannot specify ExcludeDiskId.N and DiskId.N in the same request.
    
    example:
    d-j6cf7l0ewidb78lq****
  - instanceId
```
@NameInMap(value="InstanceId")
public String instanceId
```
    The instance ID.
    example:
    i-j6ca469urv8ei629****
  - instantAccess
```
@NameInMap(value="InstantAccess")
public Boolean instantAccess
```
    Specifies whether to enable the instant access feature. Valid values:
    - true
    - false
    Default value: false.
    
    This parameter is no longer used. By default, new standard snapshots of ESSDs are upgraded to instant access snapshots free of charge without the need for additional configurations. For more information, see Use the instant access feature.
    
    example:
    false
  - instantAccessRetentionDays
```
@NameInMap(value="InstantAccessRetentionDays")
public Integer instantAccessRetentionDays
```
    The number of days for which the instant access feature is available. Unit: days. Valid values: 1 to 65535.
    
    This parameter takes effect only when InstantAccess is set to true. The instant access feature is automatically disabled when the specified duration ends.
    
    This parameter is left empty by default, which indicates that the instant access feature is automatically disabled when the instant access snapshots are released.
    
    This parameter is no longer used. By default, new standard snapshots of ESSDs are upgraded to instant access snapshots free of charge without the need for additional configurations. For more information, see Use the instant access feature.
    
    example:
    1
  - name
```
@NameInMap(value="Name")
public String name
```
    The name of the snapshot-consistent group. The name must be 2 to 128 characters in length. The name can contain letters, digits, periods (.), underscores (_), hyphens (-), and colons (:). It must start with a letter and cannot start with http:// or https://.
    example:
    testName
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the instance. You can call the DescribeRegions operation to query the most recent list of regions.
    
    This parameter is required.
    example:
    cn-hangzhou
  - resourceGroupId
```
@NameInMap(value="ResourceGroupId")
public String resourceGroupId
```
    The ID of the resource group to which the snapshot-consistent group belongs.
    example:
    rg-bp67acfmxazb4p****
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - storageLocationArn
```
@NameInMap(value="StorageLocationArn")
public String storageLocationArn
```
    This parameter is unavailable for public use.
    
    example:
    null
  - tag
```
@NameInMap(value="Tag")
public List<CreateSnapshotGroupRequest.CreateSnapshotGroupRequestTag> tag
```
    The list of tags.
- 构造器详细资料
  - CreateSnapshotGroupRequest
```
public CreateSnapshotGroupRequest()
```
- 方法详细资料
  - build
```
public static CreateSnapshotGroupRequest build(Map<String,?> map)
                                        throws Exception
```
    抛出:
    
    Exception
  - setClientToken
```
public CreateSnapshotGroupRequest setClientToken(String clientToken)
```
  - getClientToken
```
public String getClientToken()
```
  - setDescription
```
public CreateSnapshotGroupRequest setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
  - setDiskId
```
public CreateSnapshotGroupRequest setDiskId(List<String> diskId)
```
  - getDiskId
```
public List<String> getDiskId()
```
  - setExcludeDiskId
```
public CreateSnapshotGroupRequest setExcludeDiskId(List<String> excludeDiskId)
```
  - getExcludeDiskId
```
public List<String> getExcludeDiskId()
```
  - setInstanceId
```
public CreateSnapshotGroupRequest setInstanceId(String instanceId)
```
  - getInstanceId
```
public String getInstanceId()
```
  - setInstantAccess
```
public CreateSnapshotGroupRequest setInstantAccess(Boolean instantAccess)
```
  - getInstantAccess
```
public Boolean getInstantAccess()
```
  - setInstantAccessRetentionDays
```
public CreateSnapshotGroupRequest setInstantAccessRetentionDays(Integer instantAccessRetentionDays)
```
  - getInstantAccessRetentionDays
```
public Integer getInstantAccessRetentionDays()
```
  - setName
```
public CreateSnapshotGroupRequest setName(String name)
```
  - getName
```
public String getName()
```
  - setOwnerAccount
```
public CreateSnapshotGroupRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public CreateSnapshotGroupRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setRegionId
```
public CreateSnapshotGroupRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setResourceGroupId
```
public CreateSnapshotGroupRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public CreateSnapshotGroupRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public CreateSnapshotGroupRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setStorageLocationArn
```
public CreateSnapshotGroupRequest setStorageLocationArn(String storageLocationArn)
```
  - getStorageLocationArn
```
public String getStorageLocationArn()
```
  - setTag
```
public CreateSnapshotGroupRequest setTag(List<CreateSnapshotGroupRequest.CreateSnapshotGroupRequestTag> tag)
```
  - getTag
```
public List<CreateSnapshotGroupRequest.CreateSnapshotGroupRequestTag> getTag()
```

类 CreateSnapshotGroupRequest

嵌套类概要

字段概要

构造器概要

方法概要

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

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

字段详细资料

clientToken

description

diskId

excludeDiskId

instanceId

instantAccess

instantAccessRetentionDays

name

ownerAccount

ownerId

regionId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

storageLocationArn

tag

构造器详细资料

CreateSnapshotGroupRequest

方法详细资料

build

setClientToken

getClientToken

setDescription

getDescription

setDiskId

getDiskId

setExcludeDiskId

getExcludeDiskId

setInstanceId

getInstanceId

setInstantAccess

getInstantAccess

setInstantAccessRetentionDays

getInstantAccessRetentionDays

setName

getName

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setRegionId

getRegionId

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setStorageLocationArn

getStorageLocationArn

setTag

getTag