文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 用户标签/ 编辑用户标签 - UpdateUserTag
更新时间：2025-11-25 GMT+08:00
查看PDF
分享

编辑用户标签 - UpdateUserTag

功能介绍

编辑用户标签。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

PUT /v1/{project_id}/tags/{tag_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

tag_id

是

String

参数解释：

标签ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

description

否

String

参数解释：

标签描述。

取值范围：

不涉及

name

是

String

参数解释：

标签名。

取值范围：

不涉及

type

是

String

参数解释：

标签类型，分为用户标签及用户组标签。

取值范围：

  • user：用户类型标签

  • userGroup：用户组类型标签

default_value_type

是

String

参数解释：

默认标签值类型，默认为NULL。

取值范围：

  • NULL：为空

  • ALL：所有值

  • ENUM：枚举值，default_value必须有枚举值配置

  • IGNORE：<无>，如标签值计算时，忽略当前标签值

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

Boolean

参数解释：

执行结果。

取值范围：

  • true：成功

  • false：失败

请求示例

PUT https://{endpoint}/v1/{project_id}/tags/{tag_id}

{
  "name" : "测试20241127",
  "description" : "测试新增",
  "type" : "user",
  "default_value_type" : "ENUM",
  "default_value" : [ "测试" ]
}

响应示例

无

状态码

状态码

描述

200

编辑用户标签成功。

错误码

请参见错误码。

父主题： 用户标签

相关文档