使用标签过滤桌面（已废弃） - ListDesktopByTags

功能介绍

使用标签过滤桌面。该接口已废弃，请使用post /v2/{project_id}/desktops/resource-instances/action

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

请求参数

表2 请求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。

表3 Match
参数	是否必选	参数类型	描述
key	是	String	搜索时要匹配的字段。
value	是	String	搜索时匹配的值，当key=resource_name时为模糊匹配。

表4 Tags
参数	是否必选	参数类型	描述
key	否	String	标签key。
values	否	Array of strings	标签value。

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
offset	Integer	指定查询信息列表的偏移量，默认为0。
resources	Array of TagResource objects	资源对象。
total_count	Integer	数量。

表6 TagResource
参数	参数类型	描述
resource_detail	String	计算机信息。
resource_id	String	计算机id。
resource_name	String	计算机名称。
tags	Array of Tag objects	标签对象。

表7 Tag
参数	参数类型	描述
key	String	标签的键，不能为空，最大长度128个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“\|”,“/”。
value	String	标签的值，最大长度43个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“\|”,“/”。

状态码：400

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

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

{
  "offset" : "0",
  "limit" : "10",
  "action" : "filter",
  "without_any_tag" : false,
  "tags" : [ {
    "key" : "env_type",
    "values" : [ "PerfTest" ]
  } ]
}

响应示例

状态码：200

正常。

{
  "offset" : 0,
  "resources" : [ {
    "resource_id" : "4dcadc5a-c2e6-458f-913e-df2aa7e93a97",
    "resource_name" : "TEST",
    "tags" : [ {
      "key" : "env_type",
      "value" : "PerfTest"
    } ]
  } ],
  "total_count" : 1
}