6.4 标签管理接口
6.4.7 查询特定标签的集群列表
"key" : "key2",
"values" : [ "value1", "value2" ] } ]
}
状态码
状态码 描述
200 操作成功。
错误码
请参见错误码。
6.4.7 查询特定标签的集群列表
功能介绍
使用标签过滤集群。
集群默认按照创建时间倒序，集群tag也按照创建时间倒序。
接口约束
无
调试
您可以在API Explorer中调试该接口。
URI
POST /v1.1/{project_id}/clusters/resource_instances/action
表6-72 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目编号。获取方法，请参见获 取项目ID。 iValue objects
返回结果包含该参数中所有标签 对应的资源，该参数最多包含 10个key，每个key下面的value 最多10个，结构体不能缺失，
key不能为空或者空字符串。
tags_any 否 Array of TagWithMult iValue objects
返回结果包含该参数中任意一个
not_tags 否 Array of TagWithMult iValue objects
返回结果不包含该参数中所有标
not_tags_any 否 Array of TagWithMult iValue objects
返回结果不包含该参数中任意一
参数 是否必选 参数类型 描述
action 是 String 操作标识（仅限于filter，
count）：filter（过滤），
count(查询总条数)。
如果是filter则为分页查询，如 果是count会按照条件将总条数 返回。
limit 否 Integer 查询记录数（action为count时 无此参数）如果action为filter默 认为1000，limit最多为1000,不 能为负数，最小值为1。
offset 否 Integer （索引位置），从offset指定的 下一条数据开始查询。查询第一 页数据时，不需要传入此参数，
查询后续页码数据时，将查询前 一页数据时响应体中的值带入此 参数（action为count时无此参 数）如果action为filter默认为0, 必须为数字，不能为负数。
matches 否 Array of Match objects
搜索字段，key为要匹配的字 段，如resource_name等。
value为匹配的值。此字段为固 定字典值。 根据不同的字段确 认是否需要模糊匹配，如 resource_name默认为模糊搜 索，如果value为空字符串精确 匹配。
表6-74 TagWithMultiValue
参数 是否必选 参数类型 描述
key 是 String 键。标签的key值不能包含
“=”,“*”,“<”,“>”,“\”,
“,”,“|”,“/”，且首尾字符 不能为空格。
values 否 Array of
strings 值。标签的value值不能包含
“=”,“*”,“<”,“>”,“\”,
“,”,“|”,“/”，且首尾字符 不能为空格。
表6-75 Match
参数 是否必选 参数类型 描述
key 否 String 键。当前只有resource_name可
用，表示集群的名称，后续扩 展。
value 否 String 值。每个值最大长度64个
unicode字符。
响应参数
状态码： 200
表6-76 响应 Body 参数
参数 参数类型 描述
resources Array of MRSResource objects
资源列表
total_count Integer 资源总数
表6-77 MRSResource
参数 参数类型 描述
resource_id String 资源ID resource_deta
il String 资源详情
tags Array of TagPlain objects
标签
resource_nam
e String 资源名称
表6-78 TagPlain
参数 参数类型 描述
key String 键。标签的key值不能包含“=”,“*”,“<”,
“>”,“\”,“,”,“|”,“/”，且首尾字符不能 为空格。
参数 参数类型 描述
value String 值。标签的value值不能包含“=”,“*”,“<”,
“>”,“\”,“,”,“|”,“/”，且首尾字符不能 为空格。
请求示例
● action为filter时请求样例
POST https://{endpoint}/v1.1/{project_id}/{resource_type}/resource_instances/action { "offset" : "100",
"limit" : "100", "action" : "filter", "matches" : [ {
"key" : "resource_name", "value" : "clusterA"
} ],
"not_tags" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] } ],
"tags" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] } ],
"tags_any" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] } ],
"not_tags_any" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] } ]
}
● action为count时请求样例
POST https://{endpoint}/v1.1/{project_id}/{resource_type}/resource_instances/action { "action" : "count",
"not_tags" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] } ],
"tags" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] }, {
"key" : "key2",
"values" : [ "value1", "value2" ] } ],
"tags_any" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] } ],
"not_tags_any" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] } ],
"matches" : [ {
"key" : "resource_name", "value" : "clusterA"
} ] }
响应示例
状态码： 200 操作成功。
● 示例 1
{ "resources" : [ { "resource_detail" : null,
"resource_id" : "cdfs_cefs_wesas_12_dsad", "resource_name" : "clusterA",
"tags" : [ { "key" : "key1", "value" : "value1"
}, {
"key" : "key2", "value" : "value1"
} ] } ],
"total_count" : "1000"
}
● 示例 2
{ "total_count" : "1000"
}
状态码
状态码 描述
200 操作成功。
错误码
请参见错误码。