5.2 镜像标签
5.2.2 按条件查询租户镜像标签列表
– 使用image_tag请求样例
PUT https://{Endpoint}/v1/cloudimages/tags { "image_id": "67437ebd-2563-46e0-887e-ad1923977fa1", "image_tag": {"key":"key1","value":"value1"}
}
响应消息
● 响应参数 无
● 响应样例
STATUS CODE 204
返回值
● 正常 204
● 异常
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用。
5.2.2 按条件查询租户镜像标签列表
功能介绍
根据不同条件查询镜像标签列表信息。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/cloudimages/tags{?
__isregistered,__imagetype,__whole_image,__system__cmkid,protected,visibility,ow ner,id,status,name,flavor_id,container_format,disk_format,min_ram,min_disk,__os_
bit,__platform,marker,limit,sort_key,sort_dir,__os_type,tag,member_status,__suppor t_kvm,__support_xen,__support_largememory,__support_diskintensive,__support_hi ghperformance,__support_xen_gpu_type,__support_kvm_gpu_type,__support_xen_h ana,__support_kvm_infiniband,virtual_env_type,enterprise_project_id,created_at,up dated_at,architecture}
说明
可以在URI后面用‘?’和‘&’添加不同的查询条件组合，请参考请求样例。
表5-15 查询参数
参数 是否必选 参数类型 描述
__isregiste
red 否 String 镜像是否可用，取值为true，扩展接口会默 认为true，普通用户只能查询取值为true的 镜像。
__imagety
pe 否 String 镜像类型，目前支持以下类型：
● 公共镜像：gold
● 私有镜像：private
● 共享镜像：shared 说明
当前租户共享给其他租户的私有镜像或当前租户 接受的共享镜像中，__imagetype均为shared，
可用owner字段进行区分。当前租户接受的共享 镜像可用member_status进行过滤查询。
__whole_i
mage 否 Boolean 是否为整机镜像，取值为true/false。
__system_
_cmkid 否 String 加密镜像所使用的密钥ID。可以从镜像服务 控制台获取，或者调用查询镜像详情
（OpenStack原生）API查询。
protected 否 Boolean 镜像是否是受保护，取值为true/false，一 般查询公共镜像时候取值为true，查询私有 镜像可以不指定。
visibility 否 String 是否被其他租户可见，取值如下：
● public：公共镜像
● private：私有镜像
参数 是否必选 参数类型 描述
owner 否 String 镜像属于哪个租户。
id 否 String 镜像ID。
status 否 String 镜像状态。取值如下：
● queued：表示镜像元数据已经创建成 功，等待上传镜像文件。
● saving：表示镜像正在上传文件到后端 存储。
● deleted：表示镜像已经删除。
● killed：表示镜像上传错误。
● active：表示镜像可以正常使用。
name 否 String 镜像名称，匹配规则为精确匹配。name参 数说明请参考镜像属性。
flavor_id 否 String 用于通过云服务器规格过滤出可用公共镜 像，取值为规格ID。
约束：
● 仅支持通过单个规格进行过滤。
● 仅支持按照云服务器规格进行过滤，裸 金属服务器暂不支持。
如果需要查看某裸金属服务器规格支持 的公共镜像，可以使用
“__support_s4l=true”标签。其中，
s4l为裸金属服务器规格的board_type，
若规格为“physical.s4.large”，则填入
“s4l”。详细说明请参见“怎么确定裸 金属服务器规格的board_type？”。调 用示例请参考常用列表查询方法。
container_
format 否 String 容器类型，取值为bare。
disk_form
at 否 String 镜像格式，目前支持vhd、zvhd、raw、
qcow2、iso。默认值是zvhd2。
min_ram 否 Integer 镜像运行需要的最小内存，单位为MB。参 数取值依据云服务器的规格限制，一般设置 为0。
云服务器的规格限制，请参见规格清单。
min_disk 否 Integer 镜像运行需要的最小磁盘，单位为GB 。取 值为40～1024GB。
__os_bit 否 String 操作系统位数，一般取值为32或者64。
参数 是否必选 参数类型 描述
__platform 否 String 镜像平台分类，取值为Windows、
Ubuntu、RedHat、SUSE、CentOS、
Debian、OpenSUSE、Oracle Linux、
Fedora、Other、CoreOS和EulerOS。
marker 否 String 用于分页，表示从哪个镜像开始查询，取值 为镜像ID。
limit 否 Integer 用于分页，表示查询几条镜像记录，取值为 整数，默认取值为500。
sort_key 否 String 用于排序，表示按照哪个字段排序。取值为 镜像属性name、container_format、
disk_format、status、id、size、
created_at字段，默认为创建时间。
sort_dir 否 String 用于排序，表示升序还是降序，取值为asc 和desc。与sort_key一起组合使用，默认为 降序desc。
__os_type 否 String 镜像系统类型，取值如下：
● Linux
tatus 否 String 成员状态。目前取值有accepted、
rejected、pending。accepted表示已经接
kvm 否 String 如果镜像支持KVM，取值为true，否则无需 增加该属性。
__support_
xen 否 String 如果镜像支持XEN，取值为true，否则无需 增加该属性。
参数 是否必选 参数类型 描述
否 String 表示该镜像是支持XEN虚拟化平台下的GPU 优化类型，取值参考表9-2。如果不支持
否 String 表示该镜像是支持KVM虚拟化平台下的 GPU类型，取值参考表9-3。如果不支持 KVM虚拟化下GPU类型，无需添加该属 性。该属性与“__support_xen”和
“__support_kvm”属性不共存。
__support_
xen_hana 否 String 如果镜像支持XEN虚拟化下HANA类型，取 值为true。否则，无需添加该属性。
否 String 如果镜像支持KVM虚拟化下Infiniband网卡 类型，取值为true。否则，无需添加该属 性。
该属性与“__support_xen”属性不共存。
virtual_en
v_type 否 String 镜像使用环境类型：FusionCompute、
Ironic、DataImage、IsoImage。
参数 是否必选 参数类型 描述 enterprise
_project_id 否 String 表示查询某个企业项目下的镜像。
● 取值为0，表示查询属于default企业项
created_at 否 String 镜像创建时间。支持按照时间点过滤查询，
取值格式为“操作符:UTC时间”。
参数 是否必选 参数类型 描述 architectur
e 否 String 镜像架构类型。取值包括：
● x86
● arm
请求消息
● 请求参数 无
● 请求样例
GET https://{Endpoint}/v1/cloudimages/tags?limit=5&page=1
响应消息
● 响应参数
参数 参数类型 描述
tags Array of strings 标签列表
● 响应样例
STATUS CODE 200 { "tags": [
"jjjj.11111", "uuuu.22222", "234.4", "test", "image"
]}
说明
新规范中使用“=”作为分隔符。
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误，具体返回错误码请参考错误 码。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
返回值 说明
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用。