tencent cloud

标签

产品简介
产品概述
产品功能
应用场景
使用限制
支持标签 API 的资源类型
购买指南
快速入门
创建标签并绑定资源
通过标签查询资源
操作指南
创建标签
绑定资源
解绑标签
批量解绑或修改标签
删除标签
查看绑定资源
查询和编辑资源的标签
使用标签管理资源配额
资源标签导出
查询标签修改记录
创建者标签
标签策略
标签列表导出
API文档
History
Introduction
API Category
Making API Requests
Write APIs
Read APIs
Project APIs
Data Types
Error Codes
常见问题
词汇表
文档标签API文档Read APIsDescribeResourceTags

DescribeResourceTags

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 21:56:35

1. API Description

Domain name for API request: tag.intl.tencentcloudapi.com.

This API is used to query the tags associated with a resource.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeResourceTags.
Version Yes String Common Params. The value used for this API: 2018-08-13.
Region No String Common Params. This parameter is not required for this API.
CreateUin No Integer Creator uin
ResourceRegion No String Resource region.
ServiceType No String Service type.
ResourcePrefix No String Resource prefix
ResourceId No String Unique resource ID. Queries with ResourceId only may be slow or fail to return results. We recommend you also enter ServiceType, ResourcePrefix, and ResourceRegion (which can be ignored for resources that don't have the region attribute) when entering ResourceId.
Offset No Integer Data offset. Default value: 0. It must be an integer multiple of the Limit parameter
Limit No Integer Number of entries per page. Default value: 15
CosResourceId No Integer Whether it is a COS resource (0 or 1). This parameter is required when the entered ResourceId is a COS resource.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of results
Offset Integer Data offset.
Limit Integer Number of entries per page.
Note: this field may return null, indicating that no valid values can be obtained.
Rows Array of TagResource Resource tag
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the list of tags associated with resource

Input Example

https://tag.intl.tencentcloudapi.com/?Action=DescribeResourceTags
&ServiceType=cvm
&ResourcePrefix=instance
&ResourceRegion=ap-beijing
&ResourceId=ins-1234
&<Common request parameters>

Output Example

{
    "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"
    }
}

Example2 Querying tags associated with COS resource

The resourceId in COS is in the format of bucketname-appId.

Input Example

https://tag.intl.tencentcloudapi.com/?Action=DescribeResourceTags
&ServiceType=cos
&ResourceRegion=ap-beijing
&ResourceId=testbucket-1250000
&CosResourceId=1
&<Common request parameters>

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation The operation failed.

帮助和支持

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

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

文档反馈