有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

本接口用于修改资源关联的所有标签

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyResourceTags。
Version String 公共参数,本接口取值:2018-08-13。
Region String 公共参数,本接口不需要传递此参数。
Resource String 资源六段式描述
示例值:qcs::cvm:ap-beijing:uin/1234567:instance/ins-123
ReplaceTags.N Array of Tag 需要增加或修改的标签集合。如果Resource描述的资源未关联输入的标签键,则增加关联;若已关联,则将该资源关联的键对应的标签值修改为输入值。本接口中ReplaceTags和DeleteTags二者必须存在其一,且二者不能包含相同的标签键。可以不传该参数,但不能是空数组。
DeleteTags.N Array of TagKeyObject 需要解关联的标签集合。本接口中ReplaceTags和DeleteTags二者必须存在其一,且二者不能包含相同的标签键。可以不传该参数,但不能是空数组。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 给资源解除绑定多个标签

输入示例

POST / HTTP/1.1
Host: tag.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyResourceTags
<公共请求参数>

{
    "DeleteTags": [
        {
            "TagKey": "testTagKey2"
        },
        {
            "TagKey": "testTagKey1"
        }
    ],
    "Resource": "qcs::cvm:ap-beijing:uin/1234567:instance/ins-123"
}

输出示例

{
    "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

示例2 将资源关联的标签替换为输入的标签集合

输入示例

POST / HTTP/1.1
Host: tag.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyResourceTags
<公共请求参数>

{
    "ReplaceTags": [
        {
            "TagKey": "testTagKey2",
            "TagValue": "testTagValue2"
        },
        {
            "TagKey": "testTagKey1",
            "TagValue": "testTagValue1"
        }
    ],
    "Resource": "qcs::cvm:ap-beijing:uin/1234567:instance/ins-123"
}

输出示例

{
    "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.PolicyEnforcedInvalid 标签策略强制打标签限制
InvalidParameter.ReservedTagKey 系统预留标签键 qcloud、tencent和project 禁止创建。
InvalidParameter.Tag Tag参数错误。
InvalidParameterValue.DeleteTagsParamError DeleteTags中不能包含ReplaceTags或AddTags中元素。
InvalidParameterValue.ResourceDescriptionError 资源描述错误。
InvalidParameterValue.TagKeyCharacterIllegal 标签键包含非法字符。
InvalidParameterValue.TagKeyEmpty 标签键不能为空值。
InvalidParameterValue.TagKeyLengthExceeded 标签键长度超过限制。
InvalidParameterValue.TagValueCharacterIllegal 标签值包含非法字符。
InvalidParameterValue.TagValueLengthExceeded 标签值长度超过限制。
LimitExceeded.Quota 超过配额限制。
LimitExceeded.ResourceAttachedTags 资源关联的标签数超过限制。
LimitExceeded.TagKey 用户创建标签键达到上限数 1000。
LimitExceeded.TagValue 单个标签键对应标签值达到上限数 1000。