tencent cloud

文档标签API文档读接口查询资源关联标签

查询资源关联标签

PDF
聚焦模式
字号
最后更新时间: 2026-04-24 16:07:18

1. 接口描述

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

查询资源关联标签

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeResourceTags。
Version String 公共参数,本接口取值:2018-08-13。
Region String 公共参数,此参数为可选参数。
CreateUin Integer 资源创建者UIN
ResourceRegion String 资源所在地域,示例:ap-guangzhou 。不区分地域的资源则不需要传入该字段,区分地域的资源必填
ServiceType String 业务类型,示例 ckafka。指资源所属业务类型,也是资源六段式中的第三段,例如qcs::ckafka:ap-shanghai:uin/123456789:ckafkaId/ckafka-o85jq584中业务类型为ckafka
ResourcePrefix String 该业务类型对应的资源前缀,示例 cvm对应instance、image、volume等。也是资源六段式中的第六段,例如qcs::ckafka:ap-shanghai:uin/123456789:ckafkaId/ckafka-o85jq584中资源前缀为ckafkaId
ResourceId String 资源唯一标识(资源六段式中最后一段"/"后面的部分)。注:只输入ResourceId查询时,如资源量大可能较慢,或无法匹配到结果,建议在输入ResourceId的同时也输入ServiceType、ResourcePrefix和ResourceRegion(不区分地域的资源可忽略该参数)。若传入的是cos资源的Id,则CosResourceId 字段请同时传1。
Offset Integer 数据偏移量,默认为 0, 必须为Limit参数的整数倍
Limit Integer 每页大小,默认为 15
CosResourceId Integer 是否为cos的资源,取值 0 表示:非cos资源。取值1 表示:cos资源,且此时ResourceId也为必填。不填则默认为 0

3. 输出参数

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

4. 示例

示例1 查询资源关联的列表

输入示例

https://tag.intl.tencentcloudapi.com/?Action=DescribeResourceTags
&ServiceType=cvm
&ResourcePrefix=instance
&ResourceRegion=ap-beijing
&ResourceId=ins-1234
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Offset": 0,
        "Limit": 15,
        "Rows": [
            {
                "ServiceType": "cvm",
                "TagKey": "testkey",
                "TagKeyMd5": "abced",
                "TagValue": "testvalue",
                "TagValueMd5": "abced",
                "ResourceId": "ins-1234"
            }
        ],
        "RequestId": "5024400f-ae5c-4080-b3ca-f45bf9dae21a"
    }
}

示例2 查询COS资源关联的列表

cos的resourceId格式为bucketname-appId

输入示例

https://tag.intl.tencentcloudapi.com/?Action=DescribeResourceTags
&ServiceType=cos
&ResourceRegion=ap-beijing
&ResourceId=testbucket-1250000
&CosResourceId=1
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Offset": 0,
        "Limit": 15,
        "Rows": [
            {
                "ServiceType": "cos",
                "TagKey": "testkey",
                "TagKeyMd5": "abced",
                "TagValue": "testvalue",
                "TagValueMd5": "abced",
                "ResourceId": "testbucket-1250000"
            }
        ],
        "RequestId": "5024400f-ae5c-4080-b3ca-f45bf9dae21a"
    }
}

5. 开发者资源

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈