You need to enable JavaScript to run this app.
导航
ModifyInstanceTag - 编辑实例标签
最近更新时间:2024.12.11 16:59:15首次发布时间:2023.12.20 16:49:50

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

请求说明

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

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

ModifyInstanceTag

要执行的操作,取值:ModifyInstanceTag。

Version
String

2023-06-01

API的版本,取值:2023-06-01。

InstanceId
String

o-00c0****m46c

需要编辑标签的实例 ID。

DeleteTags
Array of Object

-

需要删除的资源标签。

UpdateTags
Array of Object

-

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

返回参数

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

参数
类型
示例值
描述
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

参数编码异常,请联系技术支持或提交工单