Filtering Desktops by Tag

Function

Filters desktops by tag.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v2/{project_id}/desktops/resource-instances/action

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
offset	No	String	The default value is 0.
limit	No	String	The default value is 1,000.
action	Yes	String	The value filter indicates pagination query. The value count indicates that the total number of query results meeting the search criteria will be returned.
without_any_tag	No	Boolean	Any tag is included. If this parameter is set to true, all resources without tags are queried.
matches	No	Array of Match objects	Match object.
tags	No	Array of Tags objects	Tag object included. The requirement is not met as long as one tag object is not included. One key corresponds to multiple values.
tags_any	No	Array of Tags objects	Any tag is included. If none of the tags is included, this requirement is not met. One key corresponds to multiple values.
not_tags	No	Array of Tags objects	Tags are not included. The requirement is met as long as one tag is not included. One key corresponds to multiple values.
not_tags_any	No	Array of Tags objects	Any tag is not included. The requirement is not met as long as one tag is included. One key corresponds to multiple values.

**Table 3** Match
Parameter	Mandatory	Type	Description
key	Yes	String	Field to be matched during the search.
value	Yes	String	Value to be matched during the search. If key is set to resource_name, fuzzy match is used.

**Table 4** Tags
Parameter	Mandatory	Type	Description
key	No	String	Tag key.
values	No	Array of strings	Tag value.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
offset	Integer	Offset of the specified information list query. The default value is 0.
resources	Array of TagResource objects	Resource object.
total_count	Integer	Quantity.

**Table 6** TagResource
Parameter	Type	Description
resource_detail	String	Desktop information.
resource_id	String	Desktop ID.
resource_name	String	Desktop name.
tags	Array of Tag objects	Tag object.

**Table 7** Tag
Parameter	Type	Description
key	String	Specifies the tag key. This parameter cannot be left blank and can contain a maximum of 128 Unicode characters. The value can contain uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). The value cannot contain the following characters: =*<>,\|/.
value	String	Value of a tag, which can contain a maximum of 43 Unicode characters. The value can contain uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). The value cannot contain the following characters: =*<>,\|/.

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

/v2/{project_id}/desktops/resource-instances/action

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

Example Responses

Status code: 200

Normal.

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

Status Codes

Status Code	Description
200	Normal.
400	Parameter error.
401	Authentication failed.
403	No permissions.
404	Resources not found.
500	Internal error.

Error Codes

See Error Codes.

Parent topic:Desktop Tag

Previous topic: Filtering Desktops by Tag (Deprecated)

Next topic: Adding Multiple Desktop Tags in Batches

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot