云主机

产品文档

云主机

createImage

描述

为云主机创建私有镜像。
本地系统盘云主机状态必须为stopped;云盘系统盘主机状态必须为stoppedrunning
云主机没有正在进行中的任务才可制作镜像。
制作镜像以备份系统盘为基础,在此之上可选择全部或部分挂载数据盘制作整机镜像(如不做任何更改将默认制作整机镜像),制作镜像过程会为所挂载云硬盘创建快照并与镜像关联。
调用接口后,需要等待镜像状态变为ready后,才能正常使用镜像。

请求方式

POST

请求地址

https://vm.jdcloud-api.com/v1/regions/{regionId}/instances/{instanceId}:createImage

名称 类型 是否必需 默认值 描述
instanceId String True 云主机ID
regionId String True 地域ID

请求参数

名称 类型 是否必需 默认值 描述
dataDisks InstanceDiskAttachmentSpec[ ] False 数据盘列表,可以在实例已挂载数据盘的基础上,额外增加新的快照、空盘、或排除云主机中的数据盘。
description String False 镜像描述,参考公共参数规范
name String True 镜像名称,参考公共参数规范

InstanceDiskAttachmentSpec

名称 类型 是否必需 默认值 描述
autoDelete Boolean False 是否随云主机一起删除,即删除主机时是否自动删除此磁盘,默认为true,本地盘(local)不能更改此值。
如果云主机中的数据盘(cloud)是包年包月计费方式,此参数不生效。
如果云主机中的数据盘(cloud)是共享型数据盘,此参数不生效。
cloudDiskSpec DiskSpec False 数据盘配置
deviceName String False 数据盘逻辑挂载点,取值范围:vda,vdb,vdc,vdd,vde,vdf,vdg,vdh,vdi
diskCategory String False 磁盘分类,取值为本地盘(local)或者云硬盘(cloud)。
系统盘支持本地盘(local)或者云硬盘(cloud)。系统盘选择local类型,必须使用localDisk类型的镜像;同理系统盘选择cloud类型,必须使用cloudDisk类型的镜像。
数据盘仅支持云硬盘(cloud)。
noDevice Boolean False 排除设备,使用此参数noDevice配合deviceName一起使用。
创建整机镜像:如deviceName:vdb、noDevice:true,则表示云主机中的数据盘vdb不参与创建镜像。
创建模板:如deviceName:vdb、noDevice:true,则表示镜像中的数据盘vdb不参与创建主机。
创建主机:如deviceName:vdb、noDevice:true,则表示镜像中的数据盘vdb,或者模板(使用模板创建主机)中的数据盘vdb不参与创建主机。

DiskSpec

名称 类型 是否必需 默认值 描述
az String True 云硬盘所属的可用区
charge ChargeSpec False 计费配置;如不指定,默认计费类型是后付费-按使用时常付费
description String False 云硬盘描述
diskSizeGB Integer True 云硬盘大小,单位为 GiB,ssd 类型取值范围[20,1000]GB,步长为10G,premium-hdd 类型取值范围[20,3000]GB,步长为10G
diskType String True 云硬盘类型,取值为ssd、premium-hdd之一
multiAttachable Boolean False 云硬盘是否支持一盘多主机挂载,默认为false(不支持)
name String True 云硬盘名称
snapshotId String False 用于创建云硬盘的快照ID

ChargeSpec

名称 类型 是否必需 默认值 描述
chargeDuration Integer False 预付费计费时长,预付费必填,当chargeMode取值为prepaid_by_duration时有效。当chargeUnit为month时取值为:1~9,当chargeUnit为year时取值为:1、2、3
chargeMode String False postpaid_by_duration 计费模式,取值为:prepaid_by_duration,postpaid_by_usage或postpaid_by_duration,prepaid_by_duration表示预付费,postpaid_by_usage表示按用量后付费,postpaid_by_duration表示按配置后付费,默认为postpaid_by_duration.请参阅具体产品线帮助文档确认该产品线支持的计费类型
chargeUnit String False 预付费计费单位,预付费必填,当chargeMode为prepaid_by_duration时有效,取值为:month、year,默认为month

返回参数

名称 类型 描述
requestId String
result Result

Result

名称 类型 描述
imageId String 镜像ID

返回码

返回码 描述
400 Invalid parameter
401 Authentication failed
500 Internal server error
503 Service unavailable
200 OK
404 Not found
429 Quota exceeded
更新时间:2019-12-09 18:21:10