com.tencentcloudapi.cvm.v20170312.models

Class CreateImageRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cvm.v20170312.models.CreateImageRequest

public class CreateImageRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateImageRequest()
CreateImageRequest(CreateImageRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String[]	getDataDiskIds() Get 基于实例创建整机镜像时，指定包含在镜像里的数据盘ID。 DataDiskIds 只能在指定 InstanceId 实例所包含的数据盘范围内指定。 可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的 `DataDisks` 获取。
Boolean	getDryRun() Get 检测本次请求的是否成功，但不会对操作的资源产生任何影响。默认取值为false。
String	getForcePoweroff() Get 是否执行强制关机以制作镜像。 取值范围： true：表示关机之后制作镜像 false：表示开机状态制作镜像 默认取值：false。 开机状态制作镜像，可能导致部分数据未备份，影响数据安全。
String	getImageDescription() Get 镜像描述。 最多支持 256 个字符。
String	getImageFamily() Get 镜像族
String	getImageName() Get 镜像名称。 最多支持60个字符。
String	getInstanceId() Get 需要制作镜像的实例ID。基于实例创建镜像时，为必填参数。 InstanceId 和 SnapshotIds 为二选一必填参数。 可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。
String[]	getSnapshotIds() Get 基于快照创建镜像，指定快照ID，必须包含一个系统盘快照。不可与 InstanceId 同时传入。 InstanceId 和 SnapshotIds 为二选一必填参数。 可通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/362/15647) 接口返回值中的`SnapshotId`获取。
String	getSysprep() Get 创建Windows镜像时是否启用Sysprep。 取值范围：true或false，传true表示启用Sysprep，传false表示不启用，默认取值为false。 关于Sysprep的详情请参考[链接](https://cloud.tencent.com/document/product/213/43498)。
TagSpecification[]	getTagSpecification() Get 标签描述列表。通过指定该参数可以同时绑定标签到自定义镜像。 可通过 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 接口返回值中的 `TagKey` 和 `TagValue` 获取。
void	setDataDiskIds(String[] DataDiskIds) Set 基于实例创建整机镜像时，指定包含在镜像里的数据盘ID。 DataDiskIds 只能在指定 InstanceId 实例所包含的数据盘范围内指定。 可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的 `DataDisks` 获取。
void	setDryRun(Boolean DryRun) Set 检测本次请求的是否成功，但不会对操作的资源产生任何影响。默认取值为false。
void	setForcePoweroff(String ForcePoweroff) Set 是否执行强制关机以制作镜像。 取值范围： true：表示关机之后制作镜像 false：表示开机状态制作镜像 默认取值：false。 开机状态制作镜像，可能导致部分数据未备份，影响数据安全。
void	setImageDescription(String ImageDescription) Set 镜像描述。 最多支持 256 个字符。
void	setImageFamily(String ImageFamily) Set 镜像族
void	setImageName(String ImageName) Set 镜像名称。 最多支持60个字符。
void	setInstanceId(String InstanceId) Set 需要制作镜像的实例ID。基于实例创建镜像时，为必填参数。 InstanceId 和 SnapshotIds 为二选一必填参数。 可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。
void	setSnapshotIds(String[] SnapshotIds) Set 基于快照创建镜像，指定快照ID，必须包含一个系统盘快照。不可与 InstanceId 同时传入。 InstanceId 和 SnapshotIds 为二选一必填参数。 可通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/362/15647) 接口返回值中的`SnapshotId`获取。
void	setSysprep(String Sysprep) Set 创建Windows镜像时是否启用Sysprep。 取值范围：true或false，传true表示启用Sysprep，传false表示不启用，默认取值为false。 关于Sysprep的详情请参考[链接](https://cloud.tencent.com/document/product/213/43498)。
void	setTagSpecification(TagSpecification[] TagSpecification) Set 标签描述列表。通过指定该参数可以同时绑定标签到自定义镜像。 可通过 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 接口返回值中的 `TagKey` 和 `TagValue` 获取。
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateImageRequest

public CreateImageRequest()

CreateImageRequest

public CreateImageRequest(CreateImageRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getImageName

public String getImageName()

Get 镜像名称。 最多支持60个字符。

Returns:

ImageName 镜像名称。 最多支持60个字符。

setImageName

public void setImageName(String ImageName)

Set 镜像名称。 最多支持60个字符。

Parameters:

ImageName - 镜像名称。 最多支持60个字符。

getInstanceId

public String getInstanceId()

Get 需要制作镜像的实例ID。基于实例创建镜像时，为必填参数。 InstanceId 和 SnapshotIds 为二选一必填参数。 可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。

Returns:

InstanceId 需要制作镜像的实例ID。基于实例创建镜像时，为必填参数。 InstanceId 和 SnapshotIds 为二选一必填参数。 可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。

setInstanceId

public void setInstanceId(String InstanceId)

Set 需要制作镜像的实例ID。基于实例创建镜像时，为必填参数。 InstanceId 和 SnapshotIds 为二选一必填参数。 可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。

Parameters:

InstanceId - 需要制作镜像的实例ID。基于实例创建镜像时，为必填参数。 InstanceId 和 SnapshotIds 为二选一必填参数。 可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。

getImageDescription

public String getImageDescription()

Get 镜像描述。 最多支持 256 个字符。

Returns:

ImageDescription 镜像描述。 最多支持 256 个字符。

setImageDescription

public void setImageDescription(String ImageDescription)

Set 镜像描述。 最多支持 256 个字符。

Parameters:

ImageDescription - 镜像描述。 最多支持 256 个字符。

getForcePoweroff

public String getForcePoweroff()

Get 是否执行强制关机以制作镜像。 取值范围：

true：表示关机之后制作镜像
false：表示开机状态制作镜像

默认取值：false。

开机状态制作镜像，可能导致部分数据未备份，影响数据安全。

Returns:

ForcePoweroff 是否执行强制关机以制作镜像。 取值范围：

true：表示关机之后制作镜像

false：表示开机状态制作镜像

默认取值：false。

开机状态制作镜像，可能导致部分数据未备份，影响数据安全。

setForcePoweroff

public void setForcePoweroff(String ForcePoweroff)

Set 是否执行强制关机以制作镜像。 取值范围：

true：表示关机之后制作镜像
false：表示开机状态制作镜像

默认取值：false。

开机状态制作镜像，可能导致部分数据未备份，影响数据安全。