一、用户标签列表查询API
此API用于查询客户该项目下的所有标签的列表信息
二、调用方法
API URL: https://higateway.haishuu.com/gateway/hi-api/v1/catalog-tag-list
请求方式:POST Content-Type: application/json
接口状态:正常
2.1 请求参数
名称 |
位置 |
类型 |
是否必填 |
描述 |
hi-api-key |
header |
String |
是 |
访问接口的权限key【获取hi-api-key】 |
字段 |
名称 |
类型 |
是否必填 |
描述 |
projectCode |
项目编码 |
String |
是 |
该数据所属的项目编码【项目编码获取】 |
startTime |
开始时间 |
String |
否 |
查询区间的开始时间,格式:yyyy-MM-dd HH:mm:ss,例如:2024-09-01 00:00:00 |
endTime |
结束时间 |
String |
否 |
查询区间的结束时间,格式:yyyy-MM-dd HH:mm:ss,例如:2024-09-18 00:00:00 |
createSource |
创建方式 |
String |
否 |
创建方式,参数为空时查询所有创建方式的标签,包括数值标签、自定义标签、初末次标签、SQL标签、导入标签,例如:自定义标签 |
curl --request POST \
--url https://higateway.haishuu.com/gateway/hi-api/v1/catalog-tag-list \
--header 'Content-Type: application/json' \
--header 'hi-api-key: #K-xxx' \
--data '{
"projectCode": "projectCode",
"startTime": "2024-09-12 00:00:00",
"endTime": "2024-09-13 00:00:00",
"createSource": "自定义标签"
}'
2.2 返回参数
字段 |
名称 |
类型 |
描述 |
status |
接口响应状态码 |
Integer |
成功=200 |
code |
业务响应编码 |
String |
成功=0 |
message |
业务响应描述 |
String |
操作成功 |
success |
接口成功标记 |
Boolean |
true 成功, false 失败 |
data |
返回数据 |
List |
返回列表数据 |
字段 |
名称 |
类型 |
描述 |
name |
标签名 |
String |
标签名 |
cname |
标签显示名 |
String |
标签显示名 |
clusterGroup |
标签分类 |
String |
标签分类 |
createSourceDesc |
创建方式 |
String |
创建方式,包括数值标签、自定义标签、初末次标签、SQL标签、导入标签 |
clusterTypeDesc |
数据类型 |
String |
数据类型,包括文本、数值、布尔、时间 |
isRoutineDesc |
更新方式 |
String |
更新方式,包括例行、手动、不更新 |
isBackupDesc |
备份方式 |
String |
备份方式,包括自动备份、不备份 |
analysisDesc |
分析主体 |
String |
分析主体,包括海纳ID和用户自定义的分析主体 |
lastUpdateTime |
规则更新时间 |
String |
规则更新时间 |
lastComputingTime |
最新计算时间 |
String |
最新计算时间 |
overwriteUsers |
标签覆盖用户数 |
Long |
标签覆盖用户数 |
createUserName |
创建人 |
String |
创建人 |
createTime |
创建时间 |
String |
创建时间 |
updateUserName |
更新人 |
String |
更新人 |
updateTime |
更新时间 |
String |
更新时间 |
{
"status": 200,
"code": "0",
"message": "操作成功",
"success": true,
"data": [
{
"name": "feature_20240912_246",
"cname": "标签_20240912_246",
"clusterGroup": "默认分类",
"createSourceDesc": "自定义标签",
"clusterTypeDesc": "文本",
"isRoutineDesc": "手动",
"isBackupDesc": "不备份",
"analysisDesc": "海纳ID",
"lastUpdateTime": "2024-09-12 18:01:22",
"lastComputingTime": "2024-09-12 18:01:22",
"overwriteUsers": 1,
"createUserName": "管理员",
"createTime": "2024-09-12 17:58:14",
"updateUserName": "管理员",
"updateTime": "2024-09-12 18:01:27"
}
]
}
三、错误码
接口响应状态码 |
接口响应状态码描述 |
业务响应编码 |
业务响应编码描述 |
200 |
成功 |
0 |
成功 |
5001 |
业务异常 |
API_KEY_EXPIRED |
API_KEY已过期 |
5001 |
业务异常 |
NOT_IN_IP_WHITE_LIST |
IP白名单限制 |
5001 |
业务异常 |
API_KEY_NOT_EXISTED |
API_KEY不存在 |
6001 |
参数验证异常 |
PARAM_VERIFY_FAIL |
参数验证失败 |
{
"status": 5001,
"code": "NOT_IN_IP_WHITE_LIST",
"message": "IP白名单限制 [172.23.7.64]",
"success": false,
"data": null
}
四、限制
类型 |
调用限制 |
描述 |
普通用户 |
QPS:2次/秒 |
接口限制 |
作者:超级管理员 创建时间:2024-09-18 09:52
最后编辑:梁松竹 更新时间:2025-04-01 16:17