1. 接口描述
接口请求域名: tag.tencentcloudapi.com 。
为指定的多个云产品的多个云资源统一创建并绑定标签。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:TagResources。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-13。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ResourceList.N | 是 | Array of String | 待绑定的云资源,用标准的资源六段式表示。正确的资源六段式请参考:标准的资源六段式和支持标签的云产品及资源描述方式。 N取值范围:0~9 示例值:qcs::cvm:ap-beijing:uin/1234567:instance/ins-123 |
Tags.N | 是 | Array of Tag | 标签键和标签值。 如果指定多个标签,则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键,则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 N取值范围:0~9 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FailedResources | Array of FailedResource | 失败资源信息。 创建并绑定标签成功时,返回的FailedResources为空。 创建并绑定标签失败或部分失败时,返回的FailedResources会显示失败资源的详细信息。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 为资源绑定标签
为资源绑定标签
输入示例
POST / HTTP/1.1
Host: tag.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TagResources
<公共请求参数>
{
"ResourceList": [
"qcs::cvm:ap-beijing:uin/10000055****:instance/ins-****",
"qcs::cvm:ap-shanghai:uin/10000055****:volme/volme-****"
],
"Tags": [
{
"TagKey": "11",
"TagValue": "11"
},
{
"TagKey": "22",
"TagValue": "22"
}
]
}
输出示例
{
"Response": {
"FailedResources": [],
"RequestId": "a4c9f540-b04e-47c4-a267-4a398b70d2f5"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | 未通过CAM鉴权。 |
FailedOperation | 操作失败。 |
FailedOperation.PolicyEnforcedInvalid | 标签策略强制打标签限制 |
FailedOperation.ResourceTagProcessing | 资源标签正在处理中。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ReservedTagKey | 系统预留标签键 qcloud、tencent和project 禁止创建。 |
InvalidParameter.Tag | Tag参数错误。 |
InvalidParameter.UnsupportedService | 当前业务不支持标签操作。 |
InvalidParameterValue.ResourceDescriptionError | 资源描述错误。 |
InvalidParameterValue.TagKeyCharacterIllegal | 标签键包含非法字符。 |
InvalidParameterValue.TagKeyDuplicate | TagList中存在重复的TagKey。 |
InvalidParameterValue.TagKeyEmpty | 标签键不能为空值。 |
InvalidParameterValue.TagKeyLengthExceeded | 标签键长度超过限制。 |
InvalidParameterValue.TagValueCharacterIllegal | 标签值包含非法字符。 |
InvalidParameterValue.TagValueEmpty | 标签值不能为空值。 |
InvalidParameterValue.TagValueLengthExceeded | 标签值长度超过限制。 |
LimitExceeded.ResourceNumPerRequest | 单次请求的资源数达到上限。 |
LimitExceeded.TagNumPerRequest | 单次请求的标签数超过上限。 |
LimitExceeded.TagValue | 单个标签键对应标签值达到上限数 1000。 |