文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面标签/ 使用标签过滤桌面
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

使用标签过滤桌面

功能介绍

使用标签过滤桌面

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/desktops/resource_instances/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

否

String

发送的实体的MIME类型
表3 请求Body参数

参数

是否必选

参数类型

描述

offset

否

String

默认为0

limit

否

String

默认为1000

action

否

String

如果是filter就是分页查询，如果是count只需按照条件将总条数返回即可

without_any_tag

否

Boolean

包含任意一个标签,该字段为true时查询所有不带标签的资源

matches

否

Array of Match objects

match对象

tags

否

Array of Tags objects

包含的标签对象，只要有一个不包含，就不符合，一个key对应多个value

tags_any

否

Array of Tags objects

包含任意标签，若全都不包含，不符合，一个key对应多个value

not_tags

否

Array of Tags objects

不包含标签，只要有一个不包含，就符合了，一个key对应多个value

not_tags_any

否

Array of Tags objects

不包含任意标签，只要包含其中一个，就不符合，一个key对应多个value
表4 Match

参数

是否必选

参数类型

描述

key

是

String

搜索时要匹配的字段

value

是

String

搜索时匹配的值，当key=resource_name时为模糊匹配
表5 Tags

参数

是否必选

参数类型

描述

key

否

String

标签key。

values

否

Array of strings

标签value。

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

offset

Integer

指定查询信息列表的偏移量，默认为0

resources

Array of TagResource objects

资源对象

total_count

Integer

数量
表7 TagResource

参数

参数类型

描述

resource_detail

String

计算机信息

resource_id

String

计算机id

resource_name

String

计算机名称

tags

Array of Tag objects

标签对象
表8 Tag

参数

参数类型

描述

key

String

标签的键，不能为空，最大长度128个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value

String

标签的值，最大长度43个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

/v2/{project_id}/desktops/resource_instances/action

{
  "offset" : "100",
  "limit" : "100",
  "action" : "filter",
  "matchs" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ],
  "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" ]
  } ]
}

响应示例

无

状态码

状态码

描述

200

正常

400

参数错误

401

鉴权失败

403

无权限范围

404

资源不存在

500

内部错误

错误码

请参见错误码。

父主题： 桌面标签

相关文档