DescribeTags

1. API Description

This API is used to query pages of tags.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
pageNum	No	Integer	Number of pages returned. Default value: 1.
pageSize	No	Integer	Number of items in the current page result. Default value: 20;
keySort	No	String	Sort order for tag keys. ascend for ascending; descend for descending.
createdDateSort	No	String	Sort by creation time. ascend: oldest first; descend: newest first, default.
tagKeys	No	Array of String	List of tag keys.
tags	No	Array of Tag	List of tags.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
totalCount	Integer	Number of tags meeting the filtering conditions.
dataSet	Array of TagInfo	Information on tags.

4. Code Example

Example

Query a single page of tags.

POST /api/v2/zrm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeTags
<Common Request Params>

Request：
{
  "pageNum": 1,
  "pageSize": 20,
  "keySort": null,
  "createdDateSort": "ascend",
  "tagKeys": [
    "tagKeys_0a847c6582a7"
  ],
  "tags": [
    {
      "key": "key_e8a77c6a9fab",
      "value": "value_b1c085a59870"
    }
  ]
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "totalCount": 0,
    "dataSet": [
      {
        "key": "key_3c5889f34a5f",
        "value": "value_b8c861936bc3",
        "bindResourceCount": 0,
        "createdDate": "2025-10-14 15:56:36"
      }
    ]
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​​