参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Authorization | String | 是 | HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx | 详细介绍请查阅调用方式文档 |
X-Tenant | Int | 是 | 1 | 项目ID |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ApiAction | String | 是 | GetLabelTree | 固定值，对应“请求说明”中的“接口名称” |
ApiVersion | String | 是 | 2023-02-10 | 固定值，版本号： 2023-02-10 |
subjectId | Int | 否 | 1 | 主体ID，参考附录-主体ID获取方式（不传默认为1） |
无
下表仅列出返回参数中data字段内容。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
id | Int | 2 | 标签ID |
preNodeId | Int | null | 前端展示，排序相关 |
subjectId | Int | 1 | 主体ID |
projectId | Int | 1 | 项目ID |
name | String | 123 | 标签名称 |
desc | String | "" | 标签描述 |
nodeType | String | normal | 标签类型：System=系统标签 ，default=未分类，Normal=其他的 |
createTime | String | 2023-01-18 19:37:12 | 标签创建时间 |
updateTime | String | 2023-01-18 19:37:12 | 标签修改时间 |
index | Int | 0 | 排序，顺序相关 |
level | Int | 2 | 排序，层级相关 |
labelCount | Int | 0 | 当前标签树下的所有标签数量(包含子标签树下标签) |
display | Bool | true | 前端展示，是否展示，前端搜索不符合时为false |
subNodes | Object |
| 子节点，结构与父节点一致 |
labelInfos | Array | [ ] | 标签树下的标签列表 |
{ "subjectId": 1 }
{ "code": 0, "msg": "成功", "data": [ { "id": -1, "preNodeId": null, "subjectId": 1, "projectId": 1, "name": "系统标签", "desc": null, "nodeType": "System", "createTime": "1970-01-01 00:00:00", "updateTime": "1970-01-01 00:00:00", "index": null, "level": 1, "labelCount": 1, "display": true, "subNodes": [ ], "labelInfos": [ { "id": 1, "name": "主体1_改名_全量", "subjectId": 1, "projectId": 1, "orgId": 1, "entityId": 1, "entityType": "baseid", "labelType": "mautag", "dataType": "bigint", "baseValueType": "int", "conf": null, "labelRangeRules": null, "creator": "admin", "status": 0, "approvalStatus": null, "desc": "", "featureCode": null, "display": 1, "createTime": "2024-11-13 18:42:14", "updateTime": "2024-11-13 18:48:53", "computeType": "realtime", "isMautag": 1, "syncParams": { "scheduleConf": { "frequency": "d", "scheduleTime": "00:00:00" }, "syncType": 1 }, "taskId": 25, "dimMetId": 279, "updater": "admin", "dataSecurityLevel": "L3", "productKey": null, "createApiTask": false, "realtimeStatus": null, "realtimeTaskId": null, "realtimePrepTaskId": null, "labelTtl": 0, "outputMode": "direct", "kvKeyFormat": "full_key", "env": null, "syncStatus": null, "syncTime": null, "syncId": null, "nodeId": -1, "index": 1, "readable": true, "isCollected": false, "isTemplateLabel": false, "isOnlineService": false, "isGeneral": false, "refreshFreqDetails": null, "coverage": "100.00%", "userNum": 12042, "lastRunTime": null, "resultTableType": null, "appNames": null, "appIds": null, "udfMap": null, "udf": null } ] } ] }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | invalidParameter | PARAMETER INVALID | 参数非法，检查入参。 |