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

Querying Tags in a Specified Project

Description

• API name

  GetProjectTags

• Function

  Query all tags of a resource type in a specified project.

URI

• URI format

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

• Parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID See Obtaining a Project ID.
  resource_type	Yes	String	Resource type The value can be the following: smn_topic: topic

Request

• Parameter description

  None

• Request example

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

Response

• Parameter description

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

  Table 1 Tags structure

  Parameter	Mandatory	Type	Description	Constraint
  key	Yes	String	Tag key	A key contains 127 Unicode characters and cannot be blank.
  values	Yes	String list	Value list	Each value contains a maximum of 255 Unicode characters. If the value starts with an asterisk (*), the character string following the asterisk is fuzzy-matched. The values field cannot be missing, but can be an empty list. If it is empty, any value will be matched. The values are in OR relationship.

• Response example

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

Returned Value

See section Returned Value.

Error Code

See section Error Code.

Parent topic: Resource Tag Operations