有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTagValues。
Version String 公共参数,本接口取值:2018-08-13。
Region String 公共参数,本接口不需要传递此参数。
TagKeys.N Array of String 标签键列表
示例值:testKey
CreateUin Integer 创建者用户 Uin,不传或为空只将 Uin 作为条件查询
示例值:12345
Offset Integer 数据偏移量,默认为 0, 必须为Limit参数的整数倍
示例值:0
Limit Integer 每页大小,默认为 15
示例值:15
Category String 标签类型。取值: Custom:自定义标签。 System:系统标签。 All:全部标签。 默认值:All。
示例值:All

3. 输出参数

参数名称 类型 描述
TotalCount Integer 结果总数
示例值:10
Offset Integer 数据位移偏量
示例值:0
Limit Integer 每页大小
示例值:0
Tags Array of Tag 标签列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询标签值

输入示例

https://tag.tencentcloudapi.com/?Action=DescribeTagValues
&TagKeys.0=test1
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Offset": 0,
        "Limit": 15,
        "Tags": [
            {
                "TagKey": "test1",
                "TagValue": "test"
            }
        ],
        "RequestId": "69e59dbe-71e4-4497-a735-abdd7bf5f50a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameterValue.TagKeyEmpty 标签键不能为空值。
InvalidParameterValue.UinInvalid Uin参数不合法。