5.1 镜像
5.1.2 更新镜像信息
]}
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误，具体返回错误码请参考错误 码。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用。
5.1.2 更新镜像信息
功能介绍
更新镜像信息接口，主要用于镜像属性的修改。
说明
当前仅支持可用（active）状态的镜像更新相关信息。
调试
您可以API Explorer中调试该接口。
URI
参数说明请参见表5-3。
表5-3 参数说明
参数 是否必选 参数类型 描述
image_id 是 String 私有镜像ID。
如何获取镜像ID，请参见查询镜像列 表。
请求消息
● 请求参数
参数 是否必选 参数类型 描述
[数组] 是 Array of
objects 详情请参见表5-4。
表5-4 [数组]字段说明
参数 是否必选 参数类型 描述
op 是 String 操作类型，目前取值为add、replace 和remove。
参数 是否必选 参数类型 描述
path 是 String 需要操作的属性名称，需要在属性名 称前加“/”。
目前用户可以修改以下属性：
● name：镜像名称
● __description：镜像描述
● __support_kvm：支持kvm虚拟化
● __support_xen：支持xen虚拟化
● __support_diskintensive：支持密 集存储
● __support_highperformance：支 持高性能计算
● __support_xen_gpu_type：支持 xen虚拟化gpu类型
● __support_kvm_gpu_type：支持 kvm虚拟化gpu类型
● __is_config_init：是否完成初始化 配置
● enterprise_project_id：企业项目ID
● min_ram：最小内存
● hw_vif_multiqueue_enabled：支 持网卡多队列
● hw_firmware_type：启动方式，取 值为bios或uefi
用户可以自定义添加或者删除一些自 有的扩展属性。
value 是 String 需要操作的属性的值。参数说明请参 考镜像属性。
● 请求样例
PATCH https://{Endpoint}/v2/cloudimages/33ad552d-1149-471c-8190-ff6776174a00 [ {
"op": "replace", "path": "/name", "value": "ims_test"
} ]
响应消息
● 响应参数
参数 参数类型 描述
file String 镜像文件下载和上传链接。
参数 参数类型 描述
owner String 镜像属于哪个租户。
id String 镜像ID。
size Long 目前暂时不使用。
self String 镜像链接信息。
schema String 镜像视图。
status String 镜像状态。取值如下：
● queued：表示镜像元数据已经创建 成功，等待上传镜像文件。
● saving：表示镜像正在上传文件到后 端存储。
● deleted：表示镜像已经删除。
● killed：表示镜像上传错误。
● active：表示镜像可以正常使用。
tags Array of strings 镜像标签列表，提供用户可以自定义管 理私有镜像的能力。用户可以通过镜像 标签接口为每个镜像增加不同的标签，
在查询接口中可以根据标签进行过滤。
visibility String 是否被其他租户可见。取值如下：
● private：私有镜像
● public：公共镜像
● shared：共享镜像
name String 镜像名称。name参数说明请参考镜像属 性。
checksum String 目前暂时不使用。
protected Boolean 是否是受保护的，受保护的镜像不允许 删除。取值为true或false。
container_form
at String 容器类型。
min_ram Integer 镜像运行需要的最小内存，单位为MB。
参数取值依据云服务器的规格限制，默 认设置为0。
云服务器的规格限制，请参见规格清 单。
max_ram String 镜像支持的最大内存，单位为MB。参数 取值可以参考云服务器的规格限制，默 认不设置。
云服务器的规格限制，请参见规格清 单。
参数 参数类型 描述
updated_at String 更新时间。格式为UTC时间。
__os_bit String 操作系统位数，一般取值为“32”或者
“64”。
__os_version String 操作系统具体版本。
__description String 镜像描述信息。_description参数说明请 参考镜像属性。
disk_format String 镜像的格式，目前支持vhd、zvhd、
zvhd2、raw、qcow2、iso。默认值是 vhd。
__isregistered String 是否是注册过的镜像，取值为“true”
或者“false”。
__platform String 镜像平台分类，取值为Windows、
Ubuntu、RedHat、SUSE、CentOS、
Debian、OpenSUSE、Oracle Linux、
Fedora、Other、CoreOS和EulerOS。
__os_type String 操作系统类型，目前取值Linux、
Windows、Other。
__system__cmki
d String 加密镜像所使用的密钥ID。
min_disk Integer 镜像运行需要的最小磁盘容量，单位为 GB 。取值为40～1024GB。
virtual_env_type String 镜像使用环境类型：FusionCompute、
Ironic、DataImage、IsoImage。
● 如果是云服务器镜像（即系统盘镜 像），则取值为FusionCompute。
● 如果是数据卷镜像，则取值是 DataImage。
● 如果是裸金属服务器镜像，则取值是 Ironic。
● 如果是ISO镜像，则取值是 IsoImage。
__image_source
_type String 镜像后端存储类型，目前只支持uds。
__imagetype String 镜像类型，目前支持：
● 公共镜像（gold）
● 私有镜像（private）
● 共享镜像（shared）
created_at String 创建时间。格式为UTC时间。
参数 参数类型 描述
virtual_size Integer 目前暂时不使用。
__originalimage
name String 父镜像ID。
公共镜像或通过文件创建的私有镜像，
取值为空。
__backup_id String 备份ID。如果是备份创建的镜像，则填 写为备份的ID，否则无此参数。
__productcode String 市场镜像的产品ID。
__image_size String 镜像文件的大小，单位为字节。必须大 于0。
__data_origin String 镜像来源。
公共镜像为空。
__root_origin String 表示当前镜像来源是从外部导入。取 值：file。
__lazyloading String 镜像是否支持延迟加载。取值为
“True”或“False”。
active_at String 镜像状态变为正常的时间。
__os_feature_list String 镜像附加属性。该属性采用JSON格式来 标识镜像支持的高级特性清单。
__account_code String 收费镜像标识。
hw_firmware_ty
pe String 云服务器的启动方式。目前支持：
● bios：表示bios引导启动。如果无此 参数，表示bios启动方式。
● uefi：表示uefi引导启动。
说明当镜像的架构类型为ARM时，启动方式只支
持uefi。
hw_vif_multique
ue_enabled String 镜像是否支持网卡多队列。取值为
“true”或者“false”。
__support_kvm String 如果镜像支持KVM，取值为true，否则 无需增加该属性。
__support_xen String 如果镜像支持XEN，取值为true，否则 无需增加该属性。
__support_large
memory String 表示该镜像是否支持超大内存特性。如 果镜像支持超大内存，取值为true，否 则无此属性。
镜像操作系统类型请参考“弹性云服务 器类型与支持的操作系统版本”。
参数 参数类型 描述 __support_diski
ntensive String 表示该镜像是否支持密集存储性特性。
如果镜像支持密集存储性能，则值为 true，否则无此属性。
__support_highp
erformance String 表示该镜像是否支持高计算性能的特 性。如果镜像支持高计算性能，则值为 true，否则无此属性。
__support_xen_
gpu_type String 表示该镜像是支持XEN虚拟化平台下的 GPU类型，取值参考表9-2。如果不支 持，则无此属性。该属性与
“__support_xen”和
“__support_kvm”属性不共存。
__support_kvm_
gpu_type String 表示该镜像是支持KVM虚拟化平台下的 GPU类型，取值参考表9-3。
如果不支持，则无此属性。该属性与
“__support_xen”和
“__support_kvm”属性不共存。
__support_xen_
hana String 如果镜像支持XEN虚拟化下HANA类 型，取值为true。否则，无此属性。
该属性与“__support_xen”和
“__support_kvm”属性不共存。
__support_kvm_
infiniband String 如果镜像支持KVM虚拟化下Infiniband 网卡类型，取值为true。否则，无此属 性。
该属性与“__support_xen”属性不共 存。
__system_suppo
rt_market Boolean 表示当前镜像是否支持发布为市场镜 像。
● true：支持
● false：不支持
__is_offshelved String 表示当前市场镜像是否下架。
● true：已下架
● false：未下架 enterprise_proje
ct_id String 表示当前镜像所属的企业项目。
● 取值为0或无该值，表示属于default
参数 参数类型 描述
ect String 表示当前镜像支持Cloud-Init密码/密钥 注入方式。
__support_arm String 是否为ARM架构类型的镜像。取值为
“true”或者“false”。
__support_agent
_list String 镜像是否支持企业主机安全或主机监
控。
__support_amd String 是否是AMD架构类型的镜像。取值为
“true”或者“false”。
● 响应样例
STATUS CODE 200
{ "file": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00/file", "owner": "0b1e494e2660441a957313163095fe5c",
"id": "33ad552d-1149-471c-8190-ff6776174a00", "size": 2,
"self": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00", "schema": "/v2/schemas/image",
"status": "active", "tags": [],
"visibility": "private", "name": "ims_test",
"checksum": "99914b932bd37a50b983c5e7c90ae93b", "hw_vif_multiqueue_enabled": "true",
"protected": false,
"container_format": "bare", "min_ram": 0,
"updated_at": "2015-12-08T02:30:49Z", "__os_bit": "64",
"__os_version": "Ubuntu 14.04 server 64bit", "__description": "ims test",
"disk_format": "vhd", "__isregistered": "true", "__platform": "Ubuntu", "__os_type": "Linux",
"min_disk": 40,
"virtual_env_type": "FusionCompute", "__image_source_type": "uds", "__imagetype": "private",
"created_at": "2015-12-04T09:45:33Z", "virtual_size": 0,
"__originalimagename": "33ad552d-1149-471c-8190-ff6776174a00", "__backup_id": "",
"__productcode": "",
"__image_size": "449261568", "__support_fc_inject":"true", "__data_origin": null, "hw_firmware_type": "bios"
}
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误，具体返回错误码请参见错误码。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用。