接口请求域名: tag.intl.tencentcloudapi.com 。
根据标签键获取资源标签
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeResourceTagsByTagKeys。 |
| Version | 是 | String | 公共参数,本接口取值:2018-08-13。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ServiceType | 是 | String | 业务类型,示例 cvm 。指资源所属业务类型,也是资源六段式中的第三段,例如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。cos存储桶为非必填,其他云资源为必填 |
| ResourceRegion | 是 | String | 资源所在地域,示例:ap-guangzhou 不区分地域的资源不需要传入该字段,区分地域的资源必填 |
| ResourceIds.N | 是 | Array of String | 资源唯一标识ID的列表,列表容量不超过20 |
| TagKeys.N | 是 | Array of String | 资源标签键列表,列表容量不超过20 |
| Limit | 否 | Integer | 每页大小,默认为 400 |
| Offset | 否 | Integer | 数据偏移量,默认为 0, 必须为Limit参数的整数倍 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 结果总数 |
| Offset | Integer | 数据位移偏量 |
| Limit | Integer | 每页大小 |
| Rows | Array of ResourceIdTag | 资源标签 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
根据标签键获取资源标签
https://tag.intl.tencentcloudapi.com/?Action=DescribeResourceTagsByTagKeys
&ServiceType=cvm
&ResourcePrefix=instance
&ResourceRegion=ap-beijing
&ResourceIds.0=ins-1234
&TagKeys.0=key1
&TagKeys.1=key2
&<公共请求参数>
{
"Response": {
"TotalCount": 1,
"Offset": 0,
"Limit": 15,
"Rows": [
{
"ResourceId": "ins-asdfsadf",
"TagKeyValues": [
{
"TagKey": "key1",
"TagValue": "val1"
}
]
}
],
"RequestId": "5024400f-ae5c-4080-b3ca-f45bf9dae21a"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter.Tag | Tag参数错误。 |
| InvalidParameterValue.RegionInvalid | 地域错误。 |
| InvalidParameterValue.ResourceIdInvalid | 资源Id错误。 |
| InvalidParameterValue.ResourcePrefixInvalid | 资源前缀错误。 |
| InvalidParameterValue.TagKeyCharacterIllegal | 标签键包含非法字符。 |
| InvalidParameterValue.TagKeyEmpty | 标签键不能为空值。 |
| InvalidParameterValue.TagKeyLengthExceeded | 标签键长度超过限制。 |
文档反馈