All Products
Search
Document Center

Direct Mail:QueryTagByParam

Last Updated:Jul 21, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Call QueryTagByParam to retrieve tags.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dm:QueryTagByParamget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNointegerNo

Page number

1
PageSizeintegerNo

Page size

10
KeyWordstringNo

Tag name, length 1-50, defaults to all tags if not specified.

1aTag

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

Page size

10
RequestIdstring

Request ID

10A1AD70-E48E-476D-98D9-39BD92193837
PageNumberinteger

Current page number

5
TotalCountinteger

Total count

2
dataarray<object>

Data records

tagobject
TagNamestring

Tag name

hellopal
TagIdstring

Tag ID

52366
TagDescriptionstring

Tag description

test description

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "PageNumber": 5,
  "TotalCount": 2,
  "data": {
    "tag": [
      {
        "TagName": "hellopal",
        "TagId": 52366,
        "TagDescription": "test description"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-12The response structure of the API has changedView Change Details