查询指定数据实例的标签详情 - ShowTag
功能介绍
本接口用于查询指定模型的数据实例已绑定的所有标签详情,返回标签的完整定义信息及所属标签组信息。
在调用本接口前,请确保目标数据模型满足以下条件:
接口约束
目标数据模型已在应用设计态配置了“标签管理”功能。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/queryTag
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| identifier | 是 | String | 参数解释: 应用的唯一标识。 获取方法请参见获取运行服务清单 - ListEnvs。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| modelName | 是 | String | 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 以大写字母开头,只能包含字母、数字、“_”,且长度为1-60个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| applicationId | 否 | String | 参数解释: 应用ID,用于指定实例所属的应用。 当URL路径中已能明确应用上下文时,此参数可不传。 获取方法请参见获取租户下的应用清单 - ListApps。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| params | 是 | PersistObjectIdDTO object | 参数解释: 请求参数对象,包含待查询的目标实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 是 | String | 参数解释: 数据实例ID,用于指定待查询的数据实例。 获取方法请参见分页查询实例 - ShowFindUsingPost。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 |
响应参数
状态码:200
请求示例
示例:查询指定数据实例的标签详情
查询数据实例ID为1已绑定的所有标签详情。
POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/TagableModel/queryTag
{
"applicationId" : "04219627d6794f37ae26e8aba250415d",
"params" : {
"id" : "1"
}
} 响应示例
状态码:200
OK,表示请求成功。
{
"result": "SUCCESS",
"data": [
{
"id": "609779121987260416",
"creator": "test1",
"createTime": 2023-12-04T11:52:48.000+0000,
"modifier": "test1",
"lastUpdateTime": 2023-12-04T12:07:59.000+0000,
"rdmVersion": 1,
"rdmDeleteFlag": 0,
"rdmExtensionType": "Tag",
"tenant": {
"id": "-1",
"creator": "xdmAdmin",
"createTime": 2023-12-01T01:25:21.000+0000,
"modifier": "xdmAdmin",
"lastUpdateTime": 2023-12-01T01:25:21.000+0000,
"rdmVersion": 1,
"rdmDeleteFlag": 0,
"rdmExtensionType": "Tenant",
"tenant": null,
"className": "Tenant",
"name": "basicTenant",
"description": "默认租户",
"code": "basicTenant",
"disableFlag": false,
"dataSource": "DefaultDataSource"
},
"className": "Tag",
"name": null,
"description": "测试标签",
"kiaguid": null,
"securityLevel": "internal",
"nameCn": "测试标签",
"nameEn": "Tag1",
"type": null,
"group": {
"id": "609778926910181376",
"creator": "test1",
"modifier": "test1",
"createTime": 2024-03-14T08:03:45.000+0000,
"lastUpdateTime": 2024-03-14T08:04:17.000+0000,
"rdmVersion": 2,
"rdmDeleteFlag": 0,
"rdmExtensionType": "TagGroup",
"tenant": {
"id": -1,
"creator": "xdmAdmin",
"modifier": "xdmAdmin",
"createTime": 2023-12-01T01:25:21.000+0000,
"lastUpdateTime": 2023-12-01T01:25:21.000+0000,
"rdmVersion": 1,
"rdmDeleteFlag": 0,
"rdmExtensionType": "Tenant",
"tenant": null,
"className": "Tenant",
"name": "basicTenant",
"description": "默认租户",
"kiaguid": null,
"securityLevel": "internal",
"nameEn": null,
"code": "basicTenant",
"disableFlag": false,
"dataSource": "DefaultDataSource"
},
"className": "TagGroup",
"name": null,
"description": "这是一个标签",
"kiaguid": null,
"securityLevel": "internal",
"color": {
"code": "GRAY",
"cnName": "灰色",
"enName": "GRAY",
"alias": "GRAY"
},
"nameCn": "这是一个标签组",
"nameEn": "TagGroup1",
"rootNode": null,
"parentNode": null,
"leafFlag": true,
"fullPath": "609778926910181376",
"rawFullPath": "609778926910181376"
}
}
],
"errors": []
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK,表示请求成功。 |
错误码
请参见错误码。