Help Center> Simple Message Notification> API Reference> APIs> Resource Tag Operations> Querying Project Tags
View PDF

Querying Project Tags

Function

This API is used to query all tags of a resource type in a specified region.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

See Obtaining a Project ID.

resource_type

Yes

String

Specifies the resource type. The value can be the following:

  • smn_topic: topic
  • smn_sms: SMS message
  • smn_application: mobile push

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of ResourceTags objects

Specifies resource tags.
Table 4 ResourceTags

Parameter

Type

Description

key

String

Specifies the tag key.

  • The tag key contains a maximum of 127 Unicode characters.
  • The tag key cannot be left blank.

values

Array of strings

Specifies the tag values.

  • Each key has a maximum of 10 values.
  • Values must be unique for each key.
  • Each value contains a maximum of 255 Unicode characters.
  • If this parameter is left blank, any value can be used.
  • Values are in the OR relationship.

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 project tags

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

null

Example Responses

Status code: 200

OK

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

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: Resource Tag Operations