Querying Resources by Tag

Function

This API is used to query resources by tag.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.For details about how to obtain the project ID, see Obtaining the Project ID.
resource_type	Yes	String	Specifies the resource type. Possible values are: smn_topic: topic smn_sms: SMS smn_application: mobile push

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies a user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
tags	No	Array of ResourceTags objects	A maximum of 10 tag keys are allowed in each query operation. Each tag key can have up to 10 tag values. The structure body is mandatory. The tag key cannot be left blank or be an empty string. Each tag key and tag values of one key must be unique. Resources identified by different keys are in AND relationship.
tags_any	No	Array of ResourceTags objects	A maximum of 10 tag keys are allowed in each query operation. Each tag key can have up to 10 tag values. The structure body is mandatory. The tag key cannot be left blank or be an empty string. Each tag key and tag values of one key must be unique. Resources identified by different keys are in OR relationship.
not_tags	No	Array of ResourceTags objects	A maximum of 10 tag keys are allowed in each query operation. Each tag key can have up to 10 tag values. The structure body is mandatory. The tag key cannot be left blank or be an empty string. Each tag key and tag values of one key must be unique. Resources identified by different keys are in NAND relationship.
not_tags_any	No	Array of ResourceTags objects	A maximum of 10 tag keys are allowed in each query operation. Each tag key can have up to 10 tag values. The structure body is mandatory. The tag key cannot be left blank or be an empty string. Each tag key and tag values of one key must be unique. Resources identified by different keys are in NOR relationship.
offset	No	String	Specifies the index position. The query starts from the next data record indexed by this parameter. You do not need to specify this parameter when you query resources on the first page. When you query resources on subsequent pages, set this parameter to the location returned in the response body for the previous query.If action is set to count, this parameter does not take effect.If you set action to filter, the offset value is 0 by default. The offset value cannot be a negative integer. Default: 0
limit	No	String	Specifies the maximum number of resources to be queried. If action is set to count, this parameter does not take effect. If you set action to filter, the value of this parameter is 1000 by default. The maximum value of limit is 1000 and the minimum value is 1. Default: 1000
action	Yes	String	Specifies the operation to be performed. The value can be filter (filtering) or count (querying the total number). filter indicates pagination query. count indicates that the total number of query results meeting the search criteria will be returned.
matches	No	Array of TagMatch objects	Specifies the key-value pair to be matched. The key can only be resource_name. The value will be exactly matched.

**Table 4** ResourceTags
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. A key can contain a maximum of 127 Unicode characters. key must be specified.
values	Yes	Array of strings	Specifies the tag values. Each tag contains a maximum of 10 values. Values of the same tag must be unique. It can contain a maximum of 255 Unicode characters. If this parameter is left blank, any value can be used. All values of a tag key are in the OR relationship.

**Table 5** TagMatch
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the key field to be matched. key can only be resource_name. In such a case, value is the ECS name. The key must be unique, and the value is used for matching. The key field is a fixed dictionary value. key cannot be left blank.
value	Yes	String	Specifies the value. key can only be resource_name. In such a case, value is the ECS name. It can contain a maximum of 255 Unicode characters. This field cannot be left blank.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
resources	Array of TagResource objects	Specifies the returned resource list.
total_count	Integer	Specifies the total number of records.

**Table 7** TagResource
Parameter	Type	Description
resource_id	String	Specifies the resource ID.
resource_detail	ResourceDetail object	Specifies the resource details.
tags	Array of ResourceTag objects	Specifies the list of tags.
resource_name	String	Specifies the resource name.

**Table 8** ResourceDetail
Parameter	Type	Description
enterprise_project_id	String	Specifies the enterprise project ID.
detailId	String	Specifies the details ID.
topic_urn	String	Specifies the unique identifier of the topic.
display_name	String	Specifies the display name.

**Table 9** ResourceTag
Parameter	Type	Description
key	String	Specifies the key field to be matched. key can only be resource_name. In such a case, value is the ECS name. The key must be unique, and the value is used for matching. The key field is a fixed dictionary value. key cannot be left blank.
value	String	Specifies the value. key can only be resource_name. In such a case, value is the ECS name. It can contain a maximum of 255 Unicode characters. This field cannot be left blank.

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 403

**Table 11** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 404

**Table 12** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 500

**Table 13** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Example Requests

Using tags to filter resources

POST https://{SMN_Endpoint}/v2/{project_id}/{resource_type}/resource_instances/action

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

Using tags to query the total number of resources

POST https://{SMN_Endpoint}/v2/{project_id}/{resource_type}/resource_instances/action

{
  "action" : "count",
  "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" ]
  } ],
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resouurce"
  } ]
}

Example Responses

Status code: 200

{
  "resources" : {
    "resource_detail" : {
      "topic_urn" : "urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:resouece1",
      "display_name" : "testtest",
      "enterprise_project_id" : "0"
    },
    "resource_id" : "cffe4fc4c9a54219b60dbaf7b586e132",
    "resource_name" : "resouece1",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  },
  "total_count" : 1000
}