【旧版】标签创建 CreateTag--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】标签创建 CreateTag

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

在业务下创建标签（定义标签名称、标签描述等信息）。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	string	是	业务 ID
tag_name	string	是	标签名称
tag_desc	string	否	标签描述

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
tag_id	string	标签创建成功，返回创建的标签 ID

示例

请求示例

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

{  
    "product_id":"1608456935646xxxxxx",
    "tag_name":"TEST",
    "tag_desc":"tag for test"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "CreateTag",
        "Region": "cn-north-1",
        "RequestId": "202311301447378631AE5837715481E8B2",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "tag_id": "7307142253976xxxxxx"
    }
}

错误码

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