通过标签查询资源列表并集-API 中心-腾讯云

1. 接口描述

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

通过标签查询资源列表并集

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeResourcesByTagsUnion。
Version	是	String	公共参数，本接口取值：2018-08-13。
Region	否	String	公共参数，本接口不需要传递此参数。
TagFilters.N	是	Array of TagFilter	标签过滤数组示例值：[ { "TagKey":"abc", "TagValue": "123"} ]
CreateUin	否	Integer	创建标签者uin 示例值：12345
Offset	否	Integer	数据偏移量，默认为 0, 必须为Limit参数的整数倍示例值：0
Limit	否	Integer	每页大小，默认为 15 示例值：15
ResourcePrefix	否	String	该业务类型对应的资源前缀，示例 cvm对应instance、image、volume等。也是资源六段式中的第六段，例如qcs::ckafka:ap-shanghai:uin/123456789:ckafkaId/ckafka-o85jq584中资源前缀为ckafkaId。cos存储桶为非必填，其他云资源为必填示例值：ckafkaId
ResourceId	否	String	资源唯一标记示例值：ckafka-o85jq584
ResourceRegion	否	String	资源所在地域，示例：ap-guangzhou 不区分地域的资源不需要传入该字段，区分地域的资源必填示例值：ap-guangzhou
ServiceType	否	String	业务类型，示例 cvm 。指资源所属业务类型，也是资源六段式中的第三段，例如qcs::ckafka:ap-shanghai:uin/123456789:ckafkaId/ckafka-o85jq584中业务类型为ckafka 示例值：ckafka

3. 输出参数

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

4. 示例

示例1 通过标签查询资源列表取并集

输入示例

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

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Offset": 0,
        "Limit": 15,
        "Rows": [
            {
                "ResourceRegion": "ap-guangzhou",
                "ServiceType": "cvm",
                "ResourcePrefix": "instance",
                "ResourceId": "ins-asdfsadf",
                "Tags": [
                    {
                        "TagKey": "key1",
                        "TagValue": "value1"
                    }
                ]
            }
        ],
        "RequestId": "5024400f-ae5c-4080-b3ca-f45bf9dae21a"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InvalidParameterValue.TagFilters	TagFilters参数错误。
InvalidParameterValue.TagFiltersLengthExceeded	过滤标签键对应标签值达到上限数 6。
InvalidParameterValue.UinInvalid	Uin参数不合法。