文档中心

消息队列 Kafka版

标签管理

AddTagsToResource - 添加实例标签

调用 AddTagsToResource 接口为指定实例绑定标签。

使用说明

设置标签时，标签键（Key）和标签值（Key）需满足一定的规则。详细信息，请参见绑定标签。

同一实例下多个标签的标签键不可重复，且每个标签键只能有一个标签值。

若新绑定的标签键与实例已绑定的标签键重合，则新标签值将覆盖原标签值，请谨慎操作。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：AddTagsToResource

要执行的操作，取值：AddTagsToResource。

Version string 必选示例值：2022-05-01

API的版本，取值：2022-05-01。

InstanceIds string[] 必选示例值：["kafka-cnngoanq4pxw****"]

需要绑定标签的实例 ID。

支持一次传入多个实例 ID，最多同时传入 50 个实例 ID。

Tags object[] 必选示例值：--

需要绑定的标签键和标签值数组对象。

支持一次传入多组标签键值对像，多组标签键值对像间用英文逗号（,）分隔。最多同时传入 20 组标签键值对。

标签键值需满足设置规则，详细信息请参见绑定标签。

Key string 必选示例值：owner

标签的键。

Value string 必选示例值：zhangsan

标签的值。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://kafka.volcengineapi.com/?Action=AddTagsToResource&Version=2022-01-01 HTTP/1.1​
Accept: application/json​
Content-Type: application/json​
Host: kafka.volcengineapi.com​
X-Date: 20210328T100802Z​
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=********​
​
{​
   "InstanceIds":["kafka-cnngoanq4pxw****"],​
   "Tags":[{"Key":"test","Value":"test"}]​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230227222006AC5A41DE7FA9D36772F9",​
        "Action": "AddTagsToResource",​
        "Version": "2022-05-01",​
        "Service": "Kafka",​
        "Region": "cn-beijing"​
    },​
    "Result": null​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	OperationDenied.InstanceClosed	The operation is not permitted due to the instance has overdue or expired.	当前实例已关停，无法执行该操作。

最近更新时间：2025.08.08 17:47:28

这个页面对您有帮助吗？

有用

无用