接口请求域名: tag.intl.tencentcloudapi.com 。
查询绑定了标签的资源列表。
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetResources。 |
| Version | 是 | String | 公共参数,本接口取值:2018-08-13。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ResourceList.N | 否 | Array of String | 资源六段式列表。腾讯云使用资源六段式描述一个资源。 例如:ResourceList.1 = qcs::${ServiceType}:${Region}:${Account}:${ResourcePreifx}/${ResourceId}。 如果传入了此参数会返回所有匹配的资源列表,指定的MaxResults会失效。 N取值范围:0~9 |
| TagFilters.N | 否 | Array of TagFilter | 标签键和标签值。 指定多个标签,会查询同时绑定了该多个标签的资源。 N取值范围:0~5。 每个TagFilters中的TagValue最多支持10个 |
| PaginationToken | 否 | String | 从上一页的响应中获取的下一页的Token值。 如果是第一次请求,设置为空。 |
| MaxResults | 否 | Integer | 每一页返回的数据最大条数,最大200。 缺省值:50。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| PaginationToken | String | 获取的下一页的Token值 |
| ResourceTagMappingList | Array of ResourceTagMapping | 资源及关联的标签(键和值)列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: tag.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetResources
<公共请求参数>
{
"ResourceList": [
"qcs::cvm:ap-beijing:uin/100000558920:instance/ins-123",
"qcs::cvm:ap-shanghai:uin/100000558920:instance/ins-345"
],
"TagFilters": [
{
"TagKey": "11",
"TagValue": [
"11"
]
},
{
"TagKey": "22",
"TagValue": [
"22"
]
}
]
}
{
"Response": {
"PaginationToken": "",
"ResourceTagMappingList": [
{
"Resource": "qcs::cvm:ap-beijing:uin/100000558920:instance/ins-123",
"Tags": [
{
"TagKey": "22",
"TagValue": "22"
},
{
"TagKey": "11",
"TagValue": "11"
}
]
},
{
"Resource": "qcs::cvm:ap-shanghai:uin/100000558920:instance/ins-345",
"Tags": [
{
"TagKey": "22",
"TagValue": "22"
},
{
"TagKey": "11",
"TagValue": "11"
}
]
}
],
"RequestId": "07cfd251-4ed1-426c-8133-e04a583063c0"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | 未通过CAM鉴权。 |
| FailedOperation | 操作失败。 |
| FailedOperation.ResourceTagProcessing | 资源标签正在处理中。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.PaginationTokenInvalid | PaginationToken参数非法。 |
| InvalidParameter.ReservedTagKey | 系统预留标签键 qcloud、tencent和project 禁止创建。 |
| InvalidParameter.Tag | Tag参数错误。 |
| InvalidParameterValue.ResourceDescriptionError | 资源描述错误。 |
| InvalidParameterValue.TagKeyDuplicate | TagList中存在重复的TagKey。 |
| InvalidParameterValue.TagKeyEmpty | 标签键不能为空值。 |
| InvalidParameterValue.TagKeyLengthExceeded | 标签键长度超过限制。 |
| InvalidParameterValue.TagValueCharacterIllegal | 标签值包含非法字符。 |
| InvalidParameterValue.TagValueLengthExceeded | 标签值长度超过限制。 |
| LimitExceeded.ResourceNumPerRequest | 单次请求的资源数达到上限。 |
| LimitExceeded.TagNumPerRequest | 单次请求的标签数超过上限。 |
| LimitExceeded.TagValue | 单个标签键对应标签值达到上限数 1000。 |
文档反馈