doc-exports/docs/smn/api-ref/smn_api_56005.html

Querying Tags of a Topic

Description

• API name

  ListResourceTags

• Function

  Query tags of a topic.

URI

• URI format

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

• Parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID See Obtaining a Project ID.
  resource_type	Yes	String	Resource type Only smn_topic (topic) is supported.
  resource_id	Yes	String	Resource ID Obtain a resource ID: 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.

Request

• Parameter description

  None

• Example request

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

Response

• Parameter description

  Parameter	Type	Description
  tags	Resource_tag structure array	Tag list. For details, see Table 1.

  Table 1 Resource_tag structure

  Parameter	Type	Description	Constraint
  key	String	Tag key	A key can contain up to 36 Unicode characters, including only digits, letters, hyphens (-), and underscores (_). A key cannot be left blank, be an empty string, or start or end with a space.
  value	String	Tag value	A value can contain up to 43 Unicode characters, including only digits, letters, hyphens (-), and underscores (_). A value can be an empty string, but it cannot start or end with a space.

• Example response

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

Returned Value

See Returned Value.

Error Codes

See Error Codes.

Parent topic: Resource Tag Operations