• Distributed Message Service

dms
  1. Help Center
  2. Distributed Message Service
  3. API Reference
  4. APIs for Managing Queue Tags
  5. Viewing All Tags for a Project

Viewing All Tags for a Project

Function

This API is used to view all tags of a project.

URI

URI format: GET /v1.0/{project_id}/queue/tags
Table 1 Request header

Parameter

Description

Mandatory or Not

Example

Content-type

Indicates the MIME types of a request body.

Yes

application/json

X-Auth-Token

Indicates the user token.

Yes

-

Table 2 Parameter description

Parameter

Mandatory or Not

Type

Description

project_id

Yes

String

Indicates the ID of a project.

Example

 /v1.0/67c01b92944144a19d2da968ef34a912/queue/tags

Request

Request parameters

None.

Example request

None.

Response

Response parameters

Table 3 Parameter description

Parameter

Parameter

Description

tags

Array

Indicates a list of tags.

Table 4 tags parameter description

Parameter

Parameter

Description

key

String

Indicates the tag key, which can contain a maximum of 36 Unicode characters. It cannot be left blank, and cannot contain the following characters: ASCII (0-31), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), and equal signs (=).

values

Array

Indicates a tag value, which can contain a maximum of 43 Unicode characters. It can be empty, but cannot contain the following characters: ASCII (0-31), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), and equal signs (=).

Example response

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

Status Code

Status Code

Description

200

OK

400

Invalid parameter.

401

Authentication failed.

403

Insufficient permission.

404

No queue found.

500

System error.