文档中心

云原生消息引擎

实例管理

ModifyInstanceTag - 编辑实例标签

调用 ModifyInstanceTag 接口，编辑实例的标签，支持新增、更新和删除标签。

请求说明

请求方式：POST

请求地址：https://open.volcengineapi.com?Action=ModifyInstanceTag&Version=2023-06-01

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：ModifyInstanceTag

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

Version string 必选示例值：2023-06-01

API的版本，取值：2023-06-01。

InstanceId string 必选示例值：o-00c0****m46c

需要编辑标签的实例 ID。

DeleteTags object[] 可选示例值：\-

需要删除的资源标签。

Keys string[] 可选示例值： ["tag-key-2"]

需要删除的标签键，多个标签键之间使用英文逗号（,）分隔。

Type string 必选示例值：CUSTOM

标签类型，取值如下：

CUSTOM：自定义设置的标签。

SYSTEM：系统标签。

UpdateTags object[] 可选示例值：\-

需要新增、更新的资源标签。

Kvs object 可选示例值：{"tag-key-1": "tag-value-1"}

需要新增、更新的标签的键值对信息，不同键值对之间使用英文逗号（,）分隔。

Type string 必选 `示例值：instance

标签类型，取值为 instance。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Status string 示例值：SUCCESS

操作状态。

Message string 示例值：OK

操作提示信息。

请求示例

POST /?Action=ModifyInstanceTag&Version=2023-06-01 HTTP/1.1​
Host: bmq.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20241104T130804Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=AK********/20241104/cn-beijing/bmq_dev/request, SignedHeaders=host;x-content-sha256;x-date, Signature=********​
​
{​
    "InstanceId": "o-00c0****m46c",​
    "UpdateTags": [​
        {​
            "Type": "intsance",​
            "Kvs": {​
                "tag-key-1": "tag-value-1"​
            }​
        }​
    ],​
    "DeleteTags": [​
        {​
            "Type": "CUSTOM",​
            "Keys": [​
                "tag-key-2"​
            ]​
        }​
    ]​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "2024110421080812703117506089****",​
    "Action": "ModifyInstanceTag",​
    "Version": "2023-06-01",​
    "Service": "bmq",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "Status": "SUCCESS",​
    "Message": "OK"​
  }​
}​

错误码

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

状态码	错误码	错误信息	说明
200	InvalidParameter	parameter is invalid, pls check parameters	参数值无效。
200	Unauthorized	authorized error	授权错误，请授权或切换账号后重试。
200	InternalServiceError	internal service error, please contact with admin	内部服务错误，请联系技术支持或提交工单。
200	DatabaseError	database error	数据库错误。
200	ParameterEncodingError	Failure encoding object into query map	参数编码异常，请联系技术支持或提交工单。

最近更新时间：2025.08.05 18:34:38

这个页面对您有帮助吗？

有用

无用