• Distributed Message Service

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

Viewing All Tags of a Queue

Function

This API is used to view all tags of a specified queue.

URI

URI format: GET /v1.0/{project_id}/queue/{queue_id}/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.

queue_id

Yes

String

Indicates the queue ID.

Example

 /v1.0/67c01b92944144a19d2da968ef34a912/queue/dd713484-e0b6-4e70-9942-4250e773d17c/tags

Request

Request parameters

None.

Example request

None.

Response

Response parameters

Table 3 Parameter description

Parameter

Type

Description

tags

Array

Indicates a list of tags.

Table 4 tags parameter description

Parameter

Type

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), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), commas (,), vertical bars (|), and slashes (/).

value

String

Indicates a tag value, which can contain a maximum of 43 Unicode characters. It can be empty, but

cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>\,|/

Example response

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

Status Code

Status Code

Description

200

OK

400

Invalid parameter.

401

Authentication failed.

403

Insufficient permission.

404

No queue found.

500

System error.