文档首页/ 云审计服务 CTS/ API参考/ API V3（推荐使用）/ 标签管理/ 根据标签过滤资源
更新时间：2024-07-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

根据标签过滤资源

功能介绍

根据标签过滤资源

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/{resource_type}/resource-instances/filter

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

resource_type

是

String

资源的类型：cts-tracker。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页返回的资源个数。 取值范围：1~1000 参数取值说明： 如果action为filter时，默认为1000。 如果action为count时，无此参数。

offset

否

String

分页查询起始偏移量，表示从偏移量的下一个资源开始查询。 取值范围：0~2147483647 默认值为0。 参数取值说明： 查询第一页数据时，不需要传入此参数。 查询后续页码数据时，将查询前一页数据时响应体中的值带入此参数。 如果action为filter时，默认为0，必须为数字，不能为负数。 如果action为count时，无此参数。

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

否

Boolean

true或false

tags

否

Array of TmsTags objects

包含标签。 最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。

tags_any

否

Array of TmsTags objects

最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。

not_tags

否

Array of TmsTags objects

最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。

not_tags_any

否

Array of TmsTags objects

最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。

sys_tags

否

Array of TmsTags objects

最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。

matches

否

Array of Match objects

key为要匹配的字段，value为匹配的值。 如果value为空字符串则精确匹配，否则模糊匹配。

action

否

String

操作标识（区分大小写）。 取值范围： filter：分页过滤查询 count：查询总条数

limit

否

String

每页返回的资源个数。 取值范围：1~1000 参数取值说明： 如果action为filter时，默认为1000。 如果action为count时，无此参数。

offset

否

String

分页查询起始偏移量，表示从偏移量的下一个资源开始查询。 取值范围：0~2147483647 默认值为0。 参数取值说明： 查询第一页数据时，不需要传入此参数。 查询后续页码数据时，将查询前一页数据时响应体中的值带入此参数。 如果action为filter时，默认为0，必须为数字，不能为负数。 如果action为count时，无此参数。
表4 TmsTags

参数

是否必选

参数类型

描述

key

否

String

键。最大长度128个unicode字符。标签的键可以包含任意语种字母、数字、空格和_ . : = + - @，但首尾不能含有空格

values

否

Array of strings

value列表
表5 Match

参数

是否必选

参数类型

描述

key

否

String

键。当前值限定为resource_name。

value

否

String

值。每个值最大长度255个unicode字符。不能包含“_”,“%”特殊字符。

响应参数

无

请求示例

根据标签过滤资源

https://{endpoint}/v3/{project_id}/{resource_type}/resource-instances/filter

{
  "offset" : "100",
  "limit" : "100",
  "action" : "filter",
  "without_any_tag" : true,
  "tags" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "tags_any" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "not_tags" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "not_tags_any" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "sys_tags" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ]
}

响应示例

状态码： 200

{
	"total_count": 1,
	"resources": [{
			"resource_id": "",
			"resource_detail": null,
			"tags": [{
					"key": "key1",
					"value": "value1"
				}, "sys_tags": [{
					"key": "key2",
					"value": "value2"
				}, "resource_name": ""]
			}]
	}

状态码

状态码

描述

200

错误码

请参见错误码。

父主题： 标签管理

相关文档