接口请求域名: tag.intl.tencentcloudapi.com 。
通过标签查询资源列表并集
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeResourcesByTagsUnion。 |
| Version | 是 | String | 公共参数,本接口取值:2018-08-13。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| TagFilters.N | 是 | Array of TagFilter | 标签过滤数组,数量最多六个 |
| CreateUin | 否 | Integer | 创建标签者uin |
| Offset | 否 | Integer | 数据偏移量,默认为 0, 必须为Limit参数的整数倍 |
| Limit | 否 | Integer | 每页大小,默认为 15 |
| ResourcePrefix | 否 | String | 该业务类型对应的资源前缀,示例 cvm对应instance、image、volume等。也是资源六段式中的第六段,例如qcs::ckafka:ap-shanghai:uin/123456789:ckafkaId/ckafka-o85jq584中资源前缀为ckafkaId。cos存储桶为非必填,其他云资源为必填 |
| ResourceId | 否 | String | 资源唯一标记 |
| ResourceRegion | 否 | String | 资源所在地域,示例:ap-guangzhou 不区分地域的资源不需要传入该字段,区分地域的资源必填 |
| ServiceType | 否 | String | 业务类型,示例 cvm 。指资源所属业务类型,也是资源六段式中的第三段,例如qcs::ckafka:ap-shanghai:uin/123456789:ckafkaId/ckafka-o85jq584中业务类型为ckafka |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 结果总数 |
| Offset | Integer | 数据位移偏量 |
| Limit | Integer | 每页大小 |
| Rows | Array of ResourceTag | 资源标签 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
https://tag.intl.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"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameterValue.TagFilters | TagFilters参数错误。 |
| InvalidParameterValue.TagFiltersLengthExceeded | 过滤标签键对应标签值达到上限数 6。 |
| InvalidParameterValue.UinInvalid | Uin参数不合法。 |
文档反馈