All Products
Search
Document Center

:QueryTagByParam

Last Updated:Oct 29, 2025

Query for tags

Description

The QueryTagByParam operation queries tags.

Request parameters

Name

Type

Required

Description

Action

String

Yes

A required parameter. Set the value to QueryTagByParam.

KeyWord

String

No

The tag name. The name can be 1 to 50 characters in length. If you do not specify this parameter, all tags are returned. Example: 1aTag

PageNo

Integer

No

The page number.

PageSize

Integer

No

The number of entries per page.

For information about other request parameters, see Common request parameters.

Response parameters

Name

Type

Description

PageNumber

Integer

The current page number.

PageSize

Integer

The number of entries per page.

TotalCount

Integer

The total number of entries.

data

Object []

The data records.

RequestId

String

The request ID.

data

Name

Type

Description

TagId

String

The tag ID.

TagName

String

The tag name.

Examples

Request example

http(s)://dm.aliyuncs.com/?Action=QueryTagByParam
&KeyWord=123
&PageNumber=1
&PageSize=5
&<Common request parameters>

Successful response example

JSON format

{
  "TotalCount": 1,
  "RequestId": "E3BB15D6-8B36-5445-BFD6-1648D46C6464",
  "PageSize": 500,
  "data": {
    "tag": [
      {
        "TagName": "dtest",
        "TagId": 84223
      }
    ]
  },
  "PageNumber": 1
}

Error codes

HttpCode

Description

HTTP status code

Semantics

InvalidKeyword.Malformed

The specified keyword is invalid.

400

The format of the specified keyword is invalid.