5.7 标签管理
5.7.6 使用标签过滤资源(通道等)
功能介绍
该接口用于使用标签过滤资源(通道等)。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/{project_id}/stream/resource_instances/action
表5-156 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
请求参数
表5-157 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
通过调用IAM服务获取用户 Token接口获取(响应消息头中 X-Subject-Token的值)。
表5-158 请求 Body 参数
参数 是否必选 参数类型 描述
action 是 String 操作标识(仅限于filter,count)
● filter:分页查询
● count:查询总条数,只需按 照条件将总条数返回即可 枚举值:
参数 是否必选 参数类型 描述
limit 否 String 查询记录数(action为count时无 此参数)如果action为filter默认 为1000,limit最多为1000,不 能为负数,最小值为1
缺省值:1000
offset 否 String 索引位置, 从offset指定的下一 条数据开始查询。 查询第一页
tags 否 Array of Tags
objects 返回结果包含该参数中所有标签 对应的资源,该参数最多包含 10个key,每个key下面的value 最多10个,结构体不能缺失,
key不能为空或者空字符串。
tags_any 否 Array of Tags
objects 返回结果包含该参数中任意一个 标签对应的资源,该参数最多包
not_tags 否 Array of Tags
objects 返回结果不包含该参数中所有标 签对应的资源,该参数最多包含
not_tags_any 否 Array of Tags
objects 返回结果不包含该参数中任意一 个标签对应的资源,该参数最多
matches 否 String 搜索字段,key为要匹配的字
段,当前仅支持
resource_name。value为匹配 的值。此字段为固定字典值
表5-159 Tags
参数 是否必选 参数类型 描述
key 否 String 键。
● 不能为空。
● 对于同一资源键值唯一。
● 字符集:A-Z,a-z , 0-9,
‘-’,‘_’,UNICODE字 符(\u4E00-\u9FFF)。
最大长度:36 values 否 Array of
strings 标签值列表。
如果values为空列表,则表示 any_value。value之间为或的关 系。
响应参数
状态码: 200
表5-160 响应 Body 参数
参数 参数类型 描述
action String 操作标识(仅限于filter,count)
● filter:分页查询
● count:查询总条数,只需按照条件将总条数 返回即可
枚举值:
● filter
● count
limit String 查询记录数(action为count时无此参数)如果 action为filter默认为1000,limit最多为1000,不 能为负数,最小值为1
缺省值:1000
offset String 索引位置, 从offset指定的下一条数据开始查询。
查询第一页数据时,不需要传入此参数,查询后 续页码数据时,将查询前一页数据时响应体中的 值带入此参数(action为count时无此参数)如果 action为filter默认为0,必须为数字,不能为负数 tags Array of Tags 返回结果包含该参数中所有标签对应的资源,该
参数 参数类型 描述 tags_any Array of Tags
objects 返回结果包含该参数中任意一个标签对应的资 源,该参数最多包含10个key,每个key下面的 value最多10个,结构体不能缺失,key不能为空 或者空字符串。Key不能重复,同一个key中 values不能重复。
not_tags Array of Tags
objects 返回结果不包含该参数中所有标签对应的资源,
该参数最多包含10个key,每个key下面的value最 多10个, 结构体不能缺失,key不能为空或者空字 符串。Key不能重复,同一个key中values不能重 复。
not_tags_any Array of Tags
objects 返回结果不包含该参数中任意一个标签对应的资 源,该参数最多包含10个key,每个key下面的 value最多10个,结构体不能缺失,key不能为空 或者空字符串。Key不能重复,同一个key中 values不能重复。
matches String 搜索字段,key为要匹配的字段,当前仅支持 resource_name。value为匹配的值。此字段为固 定字典值
表5-161 Tags
参数 参数类型 描述
key String 键。
● 不能为空。
● 对于同一资源键值唯一。
● 字符集:A-Z,a-z , 0-9,‘-’,‘_’,
UNICODE字符(\u4E00-\u9FFF)。
最大长度:36 values Array of
strings 标签值列表。
如果values为空列表,则表示any_value。value 之间为或的关系。
请求示例
● 使用标签过滤资源(通道等),查询记录总数。
POST https://{Endpoint}/v2/{project_id}/stream/resource_instances/action { "action" : "count",
"tags" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] }, {
"key" : "key2",
"values" : [ "value1", "value2" ]
} ],
"matches" : [ {
"key" : "resource_name", "value" : "resource1"
} ] }
● 使用标签过滤资源(通道等),分页查询。
POST https://{Endpoint}/v2/{project_id}/stream/resource_instances/action { "offset" : "0",
"limit" : "100", "action" : "filter", "matches" : [ {
"key" : "resource_name", "value" : "resource1"
} ], "tags" : [ { "key" : "key1",
"values" : [ "*value1", "value2" ] } ] "resource_detail" : null,
"resource_id" : "cdfs_cefs_wesas_12_dsad", "resource_name" : "resouece1",
"tags" : [ {
"total_count" : 1000 }