更新时间:2026-07-28 GMT+08:00
分享

绑定标签 - AddTag

功能介绍

本接口用于为指定数据模型的数据实例绑定预定义的标签。

在调用本接口前,请确保目标数据模型满足以下条件:

  1. 已在应用设计态创建并发布一个具有“标签管理”功能的数据模型。具体操作请参见创建数据实体创建关系实体应用发布

  2. 已将对应应用成功部署至运行态。具体操作请参见部署应用

  3. 已在应用运行态的“基础数据管理 > 标签”中创建目标标签。具体操作请参见标签

接口约束

  • 目标数据模型已在应用设计态配置了“标签管理”功能。

  • 绑定的标签必须已存在于当前租户下。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

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

URI

POST /rdm_{identifier}_app/publicservices/api/{modelName}/addTag

表1 路径参数

参数

是否必选

参数类型

描述

identifier

String

参数解释:

应用的唯一标识。

  • 于2023年06月01日之前创建的应用,其唯一标识为该应用的名称。

  • 于2023年06月01日之后创建的应用,其唯一标识为该应用的ID。

获取方法请参见获取运行服务清单 - ListEnvs

约束限制:

不涉及。

取值范围:

  • 于2023年06月01日之前创建的应用:由英文字母和数字组成,长度为1-36个字符。

  • 于2023年06月01日之后创建的应用:由英文字母和数字组成,且长度为32个字符。

默认取值:

不涉及。

modelName

String

参数解释:

数据模型的英文名称。

约束限制:

不涉及。

取值范围:

以大写字母开头,只能包含字母、数字、“_”,且长度为1-60个字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

IAM用户的token。

获取方法请参见获取IAM用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

String

参数解释:

应用ID,用于指定实例所属的应用。

当URL路径中已能明确应用上下文时,此参数可不传。

获取方法请参见获取租户下的应用清单 - ListApps

约束限制:

不涉及。

取值范围:

由英文字母和数字组成,且长度固定为1-32个字符。

默认取值:

不涉及。

params

TagOperationDTO object

参数解释:

请求参数对象,指定待操作的实例、标签及操作人信息。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 TagOperationDTO

参数

是否必选

参数类型

描述

objectId

String

参数解释:

目标数据实例ID。

获取方法请参见分页查询实例 - ShowFindUsingPost

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

tagId

String

参数解释:

当前租户下标签ID。

获取方法请参见全量数据服务

约束限制:

不涉及。

取值范围:

-9223372036854775808到9223372036854775807的整数。

默认取值:

不涉及。

modifier

String

参数解释:

更新者账号,用于记录执行此操作的用户标识。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释:

请求处理结果状态。

取值范围:

  • SUCCESS:操作成功。

  • FAIL:操作失败。

data

Array of integers

参数解释:

请求数据。

取值范围:

不涉及。

errors

Array of strings

参数解释:

异常信息列表。当result为FAIL时,返回具体的错误描述,包含失败原因及建议处理方式。

取值范围:

不涉及。

请求示例

示例:为单个数据实例绑定标签

为数据实例ID为1绑定标签ID为610167941333258240。

POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/TagableModel/addTag

{
  "applicationId" : "04219627d6794f37ae26e8aba250415d",
  "params" : {
    "tagId" : "610167941333258240",
    "objectId" : "1"
  }
}

响应示例

状态码:200

OK,表示请求成功。

{
  "result" : "SUCCESS",
  "data" : [ 1 ],
  "errors" : [ ]
}

状态码

状态码

描述

200

OK,表示请求成功。

错误码

请参见错误码

相关文档