按标签查询镜像

功能介绍

该接口用于按标签或其他条件对镜像进行过滤或者计数使用。

约束与限制

为兼容遗留数据，使用tags、not_tags、tags_any、not_tags_any参数时，不对查询 条件中标签的key、value进行字符集校验。

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/{project_id}/images/resource_instances/action 参数说明请参见表5-16。

表5-16 参数说明

参数 是否必选 参数类型 描述

project_id 是 String 项目ID

请求消息

● 请求参数

参数 是否必选 参数类型 描述

action 是 String 操作标识（区分大小写），支持 filter、count。filter就是分页查 询；count是只需按照条件将总条 数返回即可。

tags 否 Array of

objects 包含标签，最多包含10个key，每 个key对应的values最多包含10个 值，且key和values都不能重复。

不能为空列表。

参数 是否必选 参数类型 描述 tags_any 否 Array of

objects 包含任意标签，最多包含10个

not_tags 否 Array of

objects 不包含标签，最多包含10个key，

limit 否 String 最大查询记录数（action为count 时，此参数无效）。如果action为 filter，则limit默认为10，最多为 1000，不能为负数，最小值为1。

offset 否 String 索引位置， 从offset指定的下一条 数据开始查询。 查询第一页数据 时，不需要传入此参数（action为 count时，此参数无效），如果 action为filter，offset默认为0，

不能为负数。

matches 否 Array of

objects 搜索字段，key为要匹配的字段，

key 是 String 标签的键。最大长度127个

unicode字符，key不能为空。

参数 是否必选 参数类型 描述 values 是 Array of

strings 标签的值列表。每个值最大长度 255个unicode字符，如果values 为空列表，则标签的值可以是任 意值。值列表中的值之间为或的 关系。

表5-18 tags_any 字段数据结构说明

参数 是否必选 参数类型 描述

key 是 String 标签的键。最大长度127个

unicode字符，key不能为空。

values 是 Array of

strings 标签的值列表。每个值最大长度 255个unicode字符，如果values 为空列表，则标签的值可以是任 意值。值列表中的值之间为或的 关系。

表5-19 not_tags 字段数据结构说明

参数 是否必选 参数类型 描述

key 是 String 标签的键。最大长度127个

unicode字符，key不能为空。

values 是 Array of

strings 标签的值列表。每个值最大长度 255个unicode字符，如果values 为空列表，则标签的值可以是任 意值。值列表中的值之间为或的 关系。

表5-20 not_tags_any 字段数据结构说明

参数 是否必选 参数类型 描述

key 是 String 标签的键。最大长度127个

unicode字符，key不能为空。

values 是 Array of

strings 标签的值列表。每个值最大长度 255个unicode字符，如果values 为空列表，则标签的值可以是任 意值。值列表中的值之间为或的 关系。

表5-21 matches 字段数据结构说明

{ "action": "count", "matches": [{

"key": "resource_name", "value": "test100"

"not_tags_any": [{

"key": "key7", "values": ["value7"]

}]

}

– action为filter时的请求体示例

{ "action": "filter", "limit": "1", "offset": "0", "matches": [{

"key": "resource_name", "value": "test100"

"key": "key0", "values": ["valueXX"]

}],

"not_tags": [ { "key": "key9", "values": ["value9"]

}],

"not_tags_any": [{

"key": "key7", "values": ["value7"]

}]

}

响应消息

● 响应参数

参数 参数类型 描述

resources Array of resource

objects 镜像信息列表

total_count Integer 总记录数

表5-22 resource 字段数据结构说明

参数 参数类型 描述

resource_id String 镜像ID

resource_detail ResourceDetail object 镜像详情 tags Array of Tags objects 镜像的标签列表 resource_name String 镜像名称

表5-23 ResourceDetail object

名称 类型 必选 描述

status string 是 镜像状态

表5-24 resource_tag 字段数据结构说明

参数 参数类型 描述

key String 标签的键

value String 标签的值

– action为count时的响应示例 STATUS CODE 200

{ "total_count": 36 }

– action为filter时的响应示例 STATUS CODE 200

{ "total_count": 36, "resources": [{

"resource_name": "test10002", "resource_detail": {"status": "active"}, "tags": [{

"resource_id": "8693187d-1590-4f9f-ae34-eb9e3037cf68"

}]

400 Bad Request 请求错误。

返回值 说明 401 Unauthorized 鉴权失败。

403 Forbidden 没有操作权限。

404 Not Found 找不到资源。

500 Internal Server Error 服务内部错误。

503 Service Unavailable 服务不可用。