查询标签列表

最近更新时间:2019-07-24 15:32:46

1. 接口描述

接口请求域名: tag.tencentcloudapi.com 。

用于查询已建立的标签列表。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTags
Version String 公共参数,本接口取值:2018-08-13
Region String 公共参数,本接口不需要传递此参数。
TagKey String 标签键,与标签值同时存在或同时不存在,不存在时表示查询该用户所有标签
TagValue String 标签值,与标签键同时存在或同时不存在,不存在时表示查询该用户所有标签
Offset Integer 数据偏移量,默认为 0, 必须为Limit参数的整数倍
Limit Integer 每页大小,默认为 15
CreateUin Integer 创建者用户 Uin,不传或为空只将 Uin 作为条件查询

3. 输出参数

参数名称 类型 描述
TotalCount Integer 结果总数
Offset Integer 数据位移偏量
Limit Integer 每页大小
Tags Array of TagWithDelete 标签列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询标签

输入示例

https://tag.tencentcloudapi.com/?Action=DescribeTags
&TagKey=testTagKey
&TagValue=testTagValue
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 1,
    "Offset": 0,
    "Limit": 15,
    "Tags": [
      {
        "TagKey": "abc",
        "TagValue": "123",
        "CanDelete": 1
      }
    ],
    "RequestId": "0eebf6af-7ae1-44ec-9cae-3752e8bb911a"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterValue.UinInvalid Uin参数不合法。