DescribeTags

1. 接口描述

本接口(DescribeTags)用于标签分页列表

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称
必选
类型
描述

pageNum

Integer

页码,默认值1。

默认值:1。

pageSize

Integer

每页面展示数量,默认值20。

默认值:20。

keySort

String

标签键排序方式:ascend(正序),descend(倒序)。

createdDateSort

String

创建时间排序方式:ascend(正序),descend(倒序)。

默认倒序。

tagKeys

Array of String

筛选的标签键集合。

tags

Array of Tag

筛选的标签集合。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

totalCount

Integer

列表总数量。

dataSet

Array of TagInfo

数据列表。

4. 代码示例

1. 获取一页标签集合

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. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

HTTP状态码

错误码

说明

最后更新于