CreateImageRequest (ecs20140526 5.4.5 API)

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

public class CreateImageRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

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

static class CreateImageRequest.CreateImageRequestDiskDeviceMapping

static class CreateImageRequest.CreateImageRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`CreateImageRequest.CreateImageRequestDiskDeviceMapping`
`static class`	`CreateImageRequest.CreateImageRequestTag`

字段概要

字段
限定符和类型	字段和说明
`String`	`architecture` The system architecture of the system disk.
`String`	`bootMode` The boot mode of the image.
`String`	`clientToken` The client token that is used to ensure the idempotence of the request.
`String`	`description` The image description.
`String`	`detectionStrategy` The mode in which to check the custom image.
`List<CreateImageRequest.CreateImageRequestDiskDeviceMapping>`	`diskDeviceMapping` The information about the custom image.
`String`	`imageFamily` The name of the image family.
`String`	`imageName` The name of the custom image.
`String`	`imageVersion` The image version.
`String`	`instanceId` The instance ID.
`String`	`ownerAccount`
`Long`	`ownerId`
`String`	`platform` The operating system distribution for the system disk in the custom image.
`String`	`regionId` The region ID of the custom image that you want to create.
`String`	`resourceGroupId` The ID of the resource group to which to assign the custom image.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`String`	`snapshotId` The ID of the snapshot that you want to use to create the custom image.
`List<CreateImageRequest.CreateImageRequestTag>`	`tag` The tags.

构造器概要

构造器
构造器和说明

CreateImageRequest()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateImageRequest`	`build(Map<String,?> map)`
`String`	`getArchitecture()`
`String`	`getBootMode()`
`String`	`getClientToken()`
`String`	`getDescription()`
`String`	`getDetectionStrategy()`
`List<CreateImageRequest.CreateImageRequestDiskDeviceMapping>`	`getDiskDeviceMapping()`
`String`	`getImageFamily()`
`String`	`getImageName()`
`String`	`getImageVersion()`
`String`	`getInstanceId()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`String`	`getPlatform()`
`String`	`getRegionId()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`String`	`getSnapshotId()`
`List<CreateImageRequest.CreateImageRequestTag>`	`getTag()`
`CreateImageRequest`	`setArchitecture(String architecture)`
`CreateImageRequest`	`setBootMode(String bootMode)`
`CreateImageRequest`	`setClientToken(String clientToken)`
`CreateImageRequest`	`setDescription(String description)`
`CreateImageRequest`	`setDetectionStrategy(String detectionStrategy)`
`CreateImageRequest`	`setDiskDeviceMapping(List<CreateImageRequest.CreateImageRequestDiskDeviceMapping> diskDeviceMapping)`
`CreateImageRequest`	`setImageFamily(String imageFamily)`
`CreateImageRequest`	`setImageName(String imageName)`
`CreateImageRequest`	`setImageVersion(String imageVersion)`
`CreateImageRequest`	`setInstanceId(String instanceId)`
`CreateImageRequest`	`setOwnerAccount(String ownerAccount)`
`CreateImageRequest`	`setOwnerId(Long ownerId)`
`CreateImageRequest`	`setPlatform(String platform)`
`CreateImageRequest`	`setRegionId(String regionId)`
`CreateImageRequest`	`setResourceGroupId(String resourceGroupId)`
`CreateImageRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`CreateImageRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`CreateImageRequest`	`setSnapshotId(String snapshotId)`
`CreateImageRequest`	`setTag(List<CreateImageRequest.CreateImageRequestTag> 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

- 字段详细资料
  - architecture
```
@NameInMap(value="Architecture")
public String architecture
```
    The system architecture of the system disk. If you specify a data disk snapshot to create the system disk of the custom image, you must use Architecture to specify the system architecture of the system disk. Valid values:
    - i386
    - x86_64
    - arm64
    Default value: x86_64.
    example:
    x86_64
  - bootMode
```
@NameInMap(value="BootMode")
public String bootMode
```
    The boot mode of the image. Valid values:
    - BIOS: Basic Input/Output System (BIOS)
    - UEFI: Unified Extensible Firmware Interface (UEFI)
    - UEFI-Preferred: BIOS and UEFI
    Before you change the boot mode of an image, we recommend that you get familiar with the boot modes supported by the image to ensure that instances created from the image can start as expected. If you do not know which boot modes are supported by the image, we recommend that you use the image check feature to perform a check. For information about the image check feature, see Overview of image check.
    
    For information about the UEFI-Preferred boot mode, see Best practices for ECS instance boot modes.
    
    example:
    BIOS
  - 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 value of ClientToken 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 image description. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
    example:
    ImageTestDescription
  - detectionStrategy
```
@NameInMap(value="DetectionStrategy")
public String detectionStrategy
```
    The mode in which to check the custom image. If you do not specify this parameter, the image is not checked. Only the standard check mode is supported.
    
    This parameter is supported for most Linux and Windows operating system versions. For information about image check items and operating system limits for image check, see Overview of image check and Operating system limits for image check.
    
    example:
    Standard
  - diskDeviceMapping
```
@NameInMap(value="DiskDeviceMapping")
public List<CreateImageRequest.CreateImageRequestDiskDeviceMapping> diskDeviceMapping
```
    The information about the custom image.
  - imageFamily
```
@NameInMap(value="ImageFamily")
public String imageFamily
```
    The name of the image family. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with acs: or aliyun. The name cannot contain http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).
    example:
    hangzhou-daily-update
  - imageName
```
@NameInMap(value="ImageName")
public String imageName
```
    The name of the custom image. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).
    example:
    TestCentOS
  - imageVersion
```
@NameInMap(value="ImageVersion")
public String imageVersion
```
    The image version.
    
    If you specify an instance by configuring InstanceId, and the instance uses an Alibaba Cloud Marketplace image or a custom image that is created from an Alibaba Cloud Marketplace image, you must leave this parameter empty or set this parameter to the value of ImageVersion of the instance.
    
    example:
    2017011017
  - instanceId
```
@NameInMap(value="InstanceId")
public String instanceId
```
    The instance ID.
    example:
    i-bp1g6zv0ce8oghu7****
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - platform
```
@NameInMap(value="Platform")
public String platform
```
    The operating system distribution for the system disk in the custom image. If you specify a data disk snapshot to create the system disk of the custom image, use Platform to specify the operating system distribution for the system disk. Valid values:
    - Aliyun
    - Anolis
    - CentOS
    - Ubuntu
    - CoreOS
    - SUSE
    - Debian
    - OpenSUSE
    - FreeBSD
    - RedHat
    - Kylin
    - UOS
    - Fedora
    - Fedora CoreOS
    - CentOS Stream
    - AlmaLinux
    - Rocky Linux
    - Gentoo
    - Customized Linux
    - Others Linux
    - Windows Server 2022
    - Windows Server 2019
    - Windows Server 2016
    - Windows Server 2012
    - Windows Server 2008
    - Windows Server 2003
    Default value: Others Linux.
    example:
    CentOS
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the custom image that you want to create. 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 to assign the custom image. If you do not specify this parameter, the image is assigned to the default resource group.
    
    If you call the CreateImage operation as a Resource Access Management (RAM) user who does not have the permissions to manage the default resource group and do not specify ResourceGroupId, the Forbbiden: User not authorized to operate on the specified resource error message is returned. You must specify the ID of a resource group that the RAM user has the permissions to manage or grant the RAM user the permissions to manage the default resource group before you call the CreateImage operation again.
    
    example:
    rg-bp67acfmxazb4p****
  - 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 you want to use to create the custom image.
    example:
    s-bp17441ohwkdca0****
  - tag
```
@NameInMap(value="Tag")
public List<CreateImageRequest.CreateImageRequestTag> tag
```
    The tags.
- 构造器详细资料
  - CreateImageRequest
```
public CreateImageRequest()
```
- 方法详细资料
  - build
```
public static CreateImageRequest build(Map<String,?> map)
                                throws Exception
```
    抛出:
    
    Exception
  - setArchitecture
```
public CreateImageRequest setArchitecture(String architecture)
```
  - getArchitecture
```
public String getArchitecture()
```
  - setBootMode
```
public CreateImageRequest setBootMode(String bootMode)
```
  - getBootMode
```
public String getBootMode()
```
  - setClientToken
```
public CreateImageRequest setClientToken(String clientToken)
```
  - getClientToken
```
public String getClientToken()
```
  - setDescription
```
public CreateImageRequest setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
  - setDetectionStrategy
```
public CreateImageRequest setDetectionStrategy(String detectionStrategy)
```
  - getDetectionStrategy
```
public String getDetectionStrategy()
```
  - setDiskDeviceMapping
```
public CreateImageRequest setDiskDeviceMapping(List<CreateImageRequest.CreateImageRequestDiskDeviceMapping> diskDeviceMapping)
```
  - getDiskDeviceMapping
```
public List<CreateImageRequest.CreateImageRequestDiskDeviceMapping> getDiskDeviceMapping()
```
  - setImageFamily
```
public CreateImageRequest setImageFamily(String imageFamily)
```
  - getImageFamily
```
public String getImageFamily()
```
  - setImageName
```
public CreateImageRequest setImageName(String imageName)
```
  - getImageName
```
public String getImageName()
```
  - setImageVersion
```
public CreateImageRequest setImageVersion(String imageVersion)
```
  - getImageVersion
```
public String getImageVersion()
```
  - setInstanceId
```
public CreateImageRequest setInstanceId(String instanceId)
```
  - getInstanceId
```
public String getInstanceId()
```
  - setOwnerAccount
```
public CreateImageRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public CreateImageRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setPlatform
```
public CreateImageRequest setPlatform(String platform)
```
  - getPlatform
```
public String getPlatform()
```
  - setRegionId
```
public CreateImageRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setResourceGroupId
```
public CreateImageRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public CreateImageRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public CreateImageRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setSnapshotId
```
public CreateImageRequest setSnapshotId(String snapshotId)
```
  - getSnapshotId
```
public String getSnapshotId()
```
  - setTag
```
public CreateImageRequest setTag(List<CreateImageRequest.CreateImageRequestTag> tag)
```
  - getTag
```
public List<CreateImageRequest.CreateImageRequestTag> getTag()
```

类 CreateImageRequest

嵌套类概要

字段概要

构造器概要

方法概要

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

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

字段详细资料

architecture

bootMode

clientToken

description

detectionStrategy

diskDeviceMapping

imageFamily

imageName

imageVersion

instanceId

ownerAccount

ownerId

platform

regionId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

snapshotId

tag

构造器详细资料

CreateImageRequest

方法详细资料

build

setArchitecture

getArchitecture

setBootMode

getBootMode

setClientToken

getClientToken

setDescription

getDescription

setDetectionStrategy

getDetectionStrategy

setDiskDeviceMapping

getDiskDeviceMapping

setImageFamily

getImageFamily

setImageName

getImageName

setImageVersion

getImageVersion

setInstanceId

getInstanceId

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setPlatform

getPlatform

setRegionId

getRegionId

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setSnapshotId

getSnapshotId

setTag

getTag