Help Center/ Simple Message Notification/ API Reference/ APIs/ Tags/ Querying Resource Tags
Updated on 2025-10-31 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Resource Tags

Function

This API is used to query tags of a specified resource.

Calling Method

For details, see Calling APIs.

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, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    smn:tag:list

    Read

    topic *

    g:ResourceTag/<tag-key>

    -

    -

URI

GET /v2/{project_id}/{resource_type}/{resource_id}/tags

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.

The type can be the following:

smn_topic: topic

smn_sms: SMS

smn_application: mobile push

resource_id

Yes

String

Specifies the resource ID.

To obtain the value of resource_id, perform the following steps:

When resource_type is set to smn_topic:

Add X-SMN-RESOURCEID-TYPE=name in the request header and set the resource ID to the topic name.

Call the GetResourceInstances API to obtain the resource ID.

If you set resource_type to smn_sms, the resource ID is the signature ID, which can be obtained on the console.

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of ResourceTag objects

Specifies resource tags.
Table 4 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 5 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 6 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 7 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 8 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

Querying resource tags

GET https://{SMN_Endpoint}/v2/{project_id}/{resource_type}/{resource_id}/tags

null

Example Responses

Status code: 200

OK

{
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value3"
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent Topic: Tags