获取标签列表

最近更新时间:2024-03-22 01:21:46

我的收藏

1. 接口描述

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

用于获取已建立的标签列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetTags。
Version String 公共参数,本接口取值:2018-08-13。
Region String 公共参数,本接口不需要传递此参数。
PaginationToken String 从上一页的响应中获取的下一页的Token值。
如果是第一次请求,设置为空。
示例值:POzXXYGXh2fRDHxx7PGaJnLApcyIuAYBC5HX25gKI4Sz2R*
MaxResults Integer 每一页返回的数据最大条数,最大1000。
缺省值:50。
示例值:50
TagKeys.N Array of String 标签键。
返回所有标签键列表对应的标签。
最大长度:20
Category String 标签类型。取值: Custom:自定义标签。 System:系统标签。 All:全部标签。 默认值:All。
示例值:All

3. 输出参数

参数名称 类型 描述
PaginationToken String 获取的下一页的Token值,如果当前是最后一页,返回为空
示例值:POzXXYGXh2fRDHxx7PGaJnLApcyIuAYBC5HX25gKI4Sz2R*
Tags Array of Tag 标签列表。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询标签列表

输入示例

POST / HTTP/1.1
Host: tag.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTags
<公共请求参数>

{
    "PaginationToken": "Ab9jDQQcwdAXTyU2IUabQzkIKltlrX19nJCB8MIuJD9Ck8*********",
    "MaxResults": "2"
}

输出示例

{
    "Response": {
        "PaginationToken": "t1eWpVGSKbAxvaIwRPttZIQq-Eu7e2hWKvN5iMyULmtF*********",
        "Tags": [
            {
                "TagKey": "key1",
                "TagValue": "value1"
            },
            {
                "TagKey": "key2",
                "TagValue": "value2"
            }
        ],
        "RequestId": "0ba573a8-0fdc-44eb-96d7-8f7f*********"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
InvalidParameter.PaginationTokenInvalid PaginationToken参数非法。
InvalidParameter.ReservedTagKey 系统预留标签键 qcloud、tencent和project 禁止创建。
InvalidParameterValue.TagKeyEmpty 标签键不能为空值。
LimitExceeded 超过配额限制。