【旧版】实例打标签 AttachTag--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】实例打标签 AttachTag

最近更新时间：2024.06.17 19:36:21首次发布时间：2023.06.14 12:45:19

为指定实例添加分组标签（将指定标签批量关联绑定实例）。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	AttachTag
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-08-01

Body 参数

字段	类型	必填	说明
product_id	string	是	业务 ID
tag_id	string	是	标签 ID，空值为删除实例已绑定标签
pod_id_list	string[]	是	实例 ID 列表

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
Result	String	为指定实例添加分组标签成功，返回 success

示例

请求示例

POST https://open.volcengineapi.com?Action=AttachTag
&Version=2022-08-01
&<通过header传入的公共请求参数>

{
    "product_id":"1608456935646xxxxxx",
    "tag_id":"7269751760565xxxxxx",
    "pod_id_list":["7307097619996xxxxxx","7307097326618xxxxxx"]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "AttachTag",
        "Region": "cn-north-1",
        "RequestId": "20231130150820A5DDBB6D0F41C782A08B",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": "success"
}

错误码

错误码	说明	操作建议
8080000	标签相关错误	检查指定的标签是否存在
8080002	标签 ID 已经存在	检查标签 ID 是否已存在，使用其他标签 ID
8080001	标签名已经存在	检查标签名是否已存在，使用其他标签名称
8080003	标签不存在	检查指定的标签是否存在
8080004	标签与业务不匹配	检查指定的标签是否与业务相匹配