All Products
Search
Document Center

Direct Mail:QueryTagByParam

Last Updated:Mar 13, 2024

Query Tags

Description

QueryTagByParam Obtain Tags

Request Parameters

Parameter

Type

Required

Description

Action

String

Yes

The operation that you want to perform. Valid values: QueryTagByParam

KeyWord

String

No

The name of the tag. Length: 1 to 50. Default value: All tags. Example: 1aTag.

PageNo

Integer

No

Current page number

PageSize

Integer

No

Size per page

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

Response Parameters

Parameter

Type

Description

PageNumber

Integer

Current page number

PageSize

Integer

Size per page

TotalCount

Integer

The total number of records.

data

Object []

The data entries.

RequestId

String

The ID of the request.

Data

Parameter

Type

Description

TagId

String

The ID of the label.

TagName

String

Tag Key

Examples

Sample requests

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

Sample success responses

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

Description

InvalidKeyword.Malformed

The specified keyword is invalid.

400

The specified keyword is in the wrong format.