指标系统OpenAPI
此手册用于记录大数据开发与管理平台中,指标系统所有对外开放的OpenAPI,阅读此手册,你将了解指标系统开放的OpenAPI能力与调用方法。
一、指标系统公共参数
1.1 响应格式
名称 | 类型 | 描述 |
---|---|---|
code | Number | 响应码 |
reqId | String | 请求ID |
cost | Number | 耗时,单位:ms |
msg | String | 响应消息 |
result | Object | 响应结果 |
1.2 错误码
响应码 | 说明 |
---|---|
-2 | 系统异常 |
1000 | 指标系统查询异常 |
1.3 枚举列表
1.3.1 ScopeType
自定义字段作用范围
枚举值 | 类型 | 名称 |
---|---|---|
0 | Number | 所有 |
1 | Number | 原子指标 |
2 | Number | 派生指标 |
3 | Number | 复合指标 |
4 | Number | 衍生原子指标 |
1.3.2 FieldType
自定义字段类型
枚举值 | 类型 | 名称 |
---|---|---|
1 | Number | 布尔 |
2 | Number | 枚举单选 |
3 | Number | 枚举多选 |
4 | Number | 多选或新增 |
5 | Number | 文本 |
6 | Number | 单选 |
1.3.3 IndexType
指标类型
枚举值 | 类型 | 名称 |
---|---|---|
0 | Number | 原子指标 |
1 | Number | 派生指标 |
2 | Number | 复合指标 |
1.3.4 IndexSubType
指标子类型
枚举值 | 类型 | 名称 |
---|---|---|
0 | Number | 主原子指标 |
1 | Number | 衍生原子指标 |
1.3.5 IndexStatus
指标状态
枚举值 | 类型 | 名称 |
---|---|---|
CREATED | String | 新建 |
DRAFT | String | 草稿 |
PUBLISHED | String | 发布 |
OFFLINED | String | 下线 |
1.3.6 GenType
自动生成类型
枚举值 | 类型 | 名称 |
---|---|---|
-1 | Number | 不支持 |
0 | Number | 标准方式 |
1 | Number | 系统自动生成 |
2 | Number | 指标标识专用 |
3 | Number | 第三方接口 |
1.4 响应实体列表
1.4.1 基础实体
PageResult
分页查询结果
字段 | 类型 | 描述 |
---|---|---|
pageSize | Number | 每页显示条数 |
pageNum | Number | 页数 |
totalCount | Number | 总条数 |
totalPage | Number | 总页数 |
list | Array<Object> | 当前页结果 |
User
用户信息
字段 | 类型 | 描述 |
---|---|---|
user | String | 账号邮箱 |
fullName | String | 用户名 |
BaseRefObjectVo
显示信息
字段 | 类型 | 描述 |
---|---|---|
label | String | 显示名称 |
value | Object | 显示值 |
1.4.2 指标
TimePeriod
指标系统支持的时间周期
字段 | 类型 | 描述 |
---|---|---|
id | Number | id |
name | String | 名称 |
identifier | String | 英文标识 |
IndexSimple
指标简要信息
字段 | 类型 | 描述 |
---|---|---|
id | Number | id |
groupId | Number | 项目组ID |
clusterId | String | 集群ID |
type | Number | 指标类型,[IndexType] |
subType | Number | 指标子类型,[IndexSubType] |
name | String | 指标名称 |
identifier | String | 指标标识 |
domainId | Number | 指标域ID |
customInfo | Map<String,Object> | 自定义字段信息 |
creator | User | 创建人 |
modifier | User | 更新人 |
createTime | Number | 创建时间,毫秒数 |
updateTime | Number | 最后更新时间,毫秒数 |
Index
指标信息
字段 | 类型 | 描述 |
---|---|---|
id | Number | id |
groupId | Number | 项目组ID |
clusterId | String | 集群ID |
type | Number | 指标类型,详见:[IndexType] |
subType | Number | 指标子类型,[IndexSubType] |
referredIndexIds | List<Number> | 依赖的指标Id列表 |
name | String | 指标名称 |
identifier | String | 指标唯一标识 |
coreIndex | Boolean | 是否核心指标 |
domainId | Number | 指标域ID |
analyzableDimensions | List<String> | 可分析维度 |
reportUrls | List<String> | 关联报表Url |
bizCaliber | String | 业务口径 |
bizCaliberReporter | User | 业务口径负责人 |
techCaliber | String | 技术口径 |
realTimeTechCaliber | User | 实时技术口径 |
techCaliberReporter | User | 技术口径负责人 |
derivativeIds | List<Number> | 衍生词Id列表 |
decorationIds | List<Number> | 修饰词ID列表 |
timePeriodId | Number | 时间周期Id |
exposure | Number | 指标查看次数 |
express | String | 表达式 |
customInfo | Map<String,Object> | 自定义字段信息 |
refCount | Number | 引用数量,直接引用数+间接引用数 |
creator | User | 创建人 |
modifier | User | 最后更新人 |
createTime | Number | 创建时间,毫秒数 |
updateTime | Number | 最后更新时间,毫秒数 |
IndexDetail
指标详情
字段 | 类型 | 描述 |
---|---|---|
id | Number | id |
groupId | Number | 项目组ID |
clusterId | String | 集群ID |
type | Number | 指标类型,详见:[IndexType] |
subType | Number | 指标子类型,[IndexSubType] |
referredIndexIds | List<Number> | 依赖的指标Id列表 |
name | String | 指标名称 |
identifier | String | 指标唯一标识 |
coreIndex | Boolean | 是否核心指标 |
domainId | Number | 指标域ID |
analyzableDimensions | List<String> | 可分析维度 |
reportUrls | List<String> | 关联报表Url |
bizCaliber | String | 业务口径 |
bizCaliberReporter | User | 业务口径负责人 |
techCaliber | String | 技术口径 |
realTimeTechCaliber | String | 实时技术口径 |
techCaliberReporter | User | 技术口径负责人 |
derivativeIds | List<Number> | 衍生词Id列表 |
decorationIds | List<Number> | 修饰词ID列表 |
timePeriodId | Number | 时间周期Id |
exposure | Number | 指标查看次数 |
express | String | 表达式 |
customInfo | Map<String,Object> | 自定义字段信息,key 字段中文名称,value 值 |
refCount | Number | 引用数量,直接引用数+间接引用数 |
creator | User | 创建人 |
modifier | User | 最后更新人 |
timePeriod | TimePeriod | 时间周期详情 |
domains | List<Domain> | 指标域信息 |
referredIndexs | List<IndexSimple> | 依赖指标简要信息 |
derivatives | List<Derivative> | 衍生词详情 |
decorations | List<Decoration> | 修饰词详情 |
idle | Boolean | 是否闲置,未被其他指标依赖、未被直接和间接引用、未被有数BI引用 |
createTime | Number | 创建时间,毫秒数 |
updateTime | Number | 最后更新时间,毫秒数 |
engfullName | String | 英文全称 |
securityLevel | String | 安全等级 |
dataAnalystUsers | List<User> | 数据分析师 |
indexContributorUsers | List<User> | 指标梳理贡献者 |
dqRulesDto | List<BaseRefObjectVo> | 质量规则 |
dataItemCategoryDto | Map<String,BaseRefObjectVo> | 数据目录,根目录名称--全路径名称 |
dataElementDto | BaseRefObjectVo | 关联数据元 |
detailPath | String | 详情链接,格式:/easyindex/dict/{指标ID}?productId={项目ID}&clusterId={集群ID} |
processIndexId | Number | 过程态指标id(草稿态指标id) |
TableReference
指标被表引用信息
字段 | 类型 | 描述 |
---|---|---|
catalog | String | catalog |
db | String | 数据库 |
table | String | 表名 |
tableUrl | String | 表url |
column | String | 字段名 |
columnDescription | String | 字段描述 |
dimFieldList | List<ReferenceField> | 维度列表 |
YouDataReportReference
有数报表引用情况
字段 | 类型 | 描述 |
---|---|---|
reportName | String | 报告名称 |
reportFormNames | List<String> | 报表名称 |
url | String | 报表 |
IndexReference
指标引用情况
字段 | 类型 | 描述 |
---|---|---|
tableReferenceList | List<TableReference> | 表引用情况 |
columnReferenceList | List<TableReference> | 字段引用情况 |
youdataReferenceList | List<YoudataReferenceList> | 有数引用情况 |
success | Boolean | 是否查询成功 |
IndexField
指标字段信息
字段 | 类型 | 描述 |
---|---|---|
field | String | 字段,对应[Index]对象中的字段 |
label | String | 字段显示名称 |
value | String | 值 |
IndexFieldGroup
指标字段分组,对应项目配置中分组管理的组信息
字段 | 类型 | 描述 |
---|---|---|
customGroupName | String | 分组名称 |
fieldList | List<IndexField> | 指标字段信息 |
IndexVersion
指标版本信息
字段 | 类型 | 描述 |
---|---|---|
indexId | Number | 指标ID |
version | String | 指标版本 |
status | String | 指标状态,详见:[IndexStatus] |
approver | User | 审批人 |
approvalTime | Number | 审批时间,毫秒数 |
IndexLineage
指标血缘
字段 | 类型 | 描述 |
---|---|---|
nodeList | List<LineageNode> | 血缘节点列表 |
edgeList | List<LineageEdge> | 血缘边列表 |
NodeId | Long | 中心节点ID |
LineageNode
指标血缘节点
字段 | 类型 | 描述 |
---|---|---|
id | Number | 指标ID |
type | Number | 指标类型,详见:[InexType] |
subType | Number | 指标子类型,详见:[InexSubType] |
name | String | 指标名称 |
identifier | String | 指标标识 |
domainName | String | 指标域 |
bizCaliber | String | 业务口径 |
bizCaliberReporterUser | User | 业务口径负责人 |
LineageEdge
指标血缘中的边
字段 | 类型 | 描述 |
---|---|---|
source | Long | 起点 |
dest | Long | 终点(source为dest依赖的指标) |
1.4.3 修饰词
Decoration
修饰词
字段 | 类型 | 描述 |
---|---|---|
id | Number | id |
groupId | Number | 修饰词类型ID |
name | String | 修饰词名称 |
dentifier | String | 修饰词标识 |
DecorationGroup
修饰词类型
字段 | 类型 | 描述 |
---|---|---|
id | Number | id |
groupId | Number | 修饰词类型ID |
name | String | 修饰词类型名称 |
decorations | List<Decoration> | 修饰词 |
description | String | 描述 |
creator | User | 创建人 |
modifier | User | 修改人 |
createTime | Number | 创建时间,毫秒数 |
updateTime | Number | 最后更新时间,毫秒数 |
1.4.4 衍生词
Derivative
衍生词
字段 | 类型 | 描述 |
---|---|---|
id | Number | 衍生词ID |
name | String | 衍生词 |
identifier | String | 衍生词标识 |
calculateCaliber | String | 计算口径 |
description | String | 描述 |
createTime | Number | 创建时间,毫秒数 |
updateTime | Number | 最后更新时间,毫秒数 |
creator | User | 创建人 |
modifier | User | 修改人 |
1.4.5 指标域
Domain
指标域
字段 | 类型 | 描述 |
---|---|---|
id | Number | id |
domainName | String | 指标域名称 |
parentDomainId | Number | 上级指标域ID |
owners | List<User> > | 指标域负责人 |
approve | Boolean | 是否开启审批 |
approvers | List<User> | 平台审批人 |
allRoles | Boolean | 是否所有角色可用 |
allowedRoles | List<String> | 允许使用的角色 |
identifier | String | 指标域标识 |
indexApprovers | List<User> | 指标审批者,一级指标域为空 |
creator | User | 创建人 |
modifier | User | 修改人 |
createTime | Number | 创建时间,毫秒数 |
updateTime | Number | 最后更新时间,毫秒数 |
DomainDetail
指标域详情
字段 | 类型 | 描述 |
---|---|---|
id | Number | id |
domainName | String | 指标域名称 |
parentDomainId | Number | 上级指标域ID |
owners | List<User> | 指标域负责人 |
approve | Boolean | 是否开启审批 |
approvers | List<User> | 平台审批人 |
allRoles | Boolean | 是否所有角色可用 |
allowedRoles | List<User> | 允许使用的角色 |
identifier | String | 指标域标识 |
indexApprovers | List<User> | 指标审批者,一级指标域为空 |
children | List<DomainDetail> | 子集 |
creator | User | 创建人 |
modifier | User | 修改人 |
createTime | Number | 创建时间,毫秒数 |
updateTime | Number | 最后更新时间,毫秒数 |
1.4.6 注册模版配置
CustomGroupVO
分组VO
字段 | 类型 | 描述 |
---|---|---|
id | Number | id |
groupId | Number | 项目组ID |
clusterId | Number | 集群ID |
customGroupName | String | 分组名称 |
seq | Number | 序号 |
systemFlag | Boolean | 是否系统预置分组 |
delete | Boolean | 是否可删除 |
update | Boolean | 是否可更新 |
move | Boolean | 是否可移动 |
groupCode | String | 组编码 |
fields | List<CustomFieldVO> | 分组中的注册属性列表 |
CustomFieldVO
注册属性VO
字段 | 类型 | 描述 |
---|---|---|
id | Number | id |
groupId | Number | 项目组ID |
clusterId | Number | 集群ID |
customId | String | 自定义id(uuid) |
CustomGroupId | Number | 所属分组id |
fieldName | String | 字段名称 |
fieldAlias | String | 字段别名 |
fieldType | Number | 类型,详见[FieldType] |
valueList | List<String> | 值域范围 |
required | Number? | 是否必填 |
prompt | String | 提示语 |
scopeType | List<Number> | 作用范围,详见[ScopeType] |
showSwitch | Number | 是否在列表中展示 |
searchSwitch | Number | 是否作为搜索项 |
systemFlag | Boolean | 是否系统预置 |
category | Number | |
enable | Number? | 是否启用 |
seq | Number | 序号 |
field | String | 只有系统内置字段有? |
valueListPrompt | String | |
valueListUrl | String | |
delete | Boolean | 是否可删除 |
move | Boolean | 是否可移动 |
update | Boolean | 是否可修改 |
upsert | Boolean | |
disables | List<String> | 前端在配置页面上置灰的字段列表 |
showAreas | List<String> | 字段显示区域 |
genType | Number | 自动生成类型,详见[GenType] |
autoGen | Boolean | 是否自动生成 |
uploadSystemPrompt | String | 系统导入提示 |
uploadCustomPrompt | String | 自定义导入提示 |
pattern | String | 正则格式 |
patternDesc | String | 正则描述 |
fieldDesc | String | 字段描述 |
frontAutoComplete | Boolean | 无 |
1.5 查询实体列表
1.5.1 IndexSearchQo
字段 | 类型 | 描述 | 是否必填 | 默认值 |
---|---|---|---|---|
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | |
user |
String | 用户账号,字段鉴权需要,不传不鉴权 | 否 | |
pageSize | Number | 每页条数 | 否 | 10 |
pageNum | Number | 第几页,不小于1 | 否 | 1 |
domainId | Number | 指标域ID | 否 | |
name | String | 指标名称,模糊匹配 | 否 | |
identifier | String | 指标标识,模糊匹配 | 否 | |
keyword | String | 关键字,目前只支持指标名称和指标标识 | 否 | |
type | Number | 指标类型,详见:[InexType] | 否 | 全部 |
subType | Number | 指标子类型,当只有当type=0时子类型才能生效,详见:[InexSubType] | 否 | |
bizCaliberReporters | List<String> | 业务口径负责人列表 | 否 | |
techCaliberReporters | List<String> | 技术口径负责人列表 | 否 | |
creators | List<String> | 创建人列表 | 否 | |
analyzableDimensions | List<String> | 可分析维度 | 否 | |
techCaliber | String | 技术口径 | 否 | |
realTimeTechCaliber | String | 实时技术口径 | 否 | |
orderField | String |
排序字段,createTime(创建时间)、exposure(查看次数)、refCount(引用次数) | 否 | createTime |
orderBy | String | 是否顺序排序,填 DESC 或 ASC | 否 | DESC |
coreIndex | Boolean | 是否核心指标 | 否 | |
customFieldFilter |
Map<String,Object> | 自定义字段过滤条件,key:自定义字段ID,value:查询条件 | 否 | |
idleDays |
Number | 自指标创建后的闲置天数,不填则返回结果中的“是否闲置”标识为Null | 否 | |
dataItemCategoryCode | String | 资源目录编码 | 无 |
二、OpenAPI列表
2.1 OpenAPI总览
2.2 指标API
2.2.1 分页搜索查询指标列表
POST /index/v3/search
产品版本:v2.3.0
描述:按条件搜索指标,返回分页结果
URL参数/请求体
详见:[IndexSearchQo]
请求示例:
{
"groupId":1,
"clusterId":"testCluster",
"name":"test",
"type":0
}
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | PageResult<IndexDetail> | 项目信息 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": {
"pageNum": 1,
"pageSize": 1,
"totalCount": 127,
"totalPage": 127,
"list": \[
{
"id": 1,
"groupId": 1,
"clusterId": "testCluster",
"type": 1,
"subType": null,
"product": "项目名称",
"referredIndexIds": \[
2
\],
"name": "指标名称",
"identifier": "index\_code",
"coreIndex": false,
"domainId": 1,
"analyzableDimensions": \["可分析维度1"\],
"reportUrl": "",
"bizCaliber": "业务口径",
"bizCaliberReporter": {
"user": "test@163.com",
"fullName": "测试用户"
},
"techCaliber": "技术口径",
"realTimeTechCaliber": "实时技术口径",
"techCaliberReporter": {
"user": "test@163.com",
"fullName": "测试用户"
},
"derivativeIds": \[1,2\],
"decorationIds": \[1,2\],
"timePeriodId": 3,
"exposure": 20,
"express": "表达式",
"customInfo": {
"自定义字段bool": false,
"自定义字段str": "值"
},
"ownerPermission": false,
"techPermission": false,
"techPermissionOnly": false,
"refCount": 0,
"youDataRefCount": 0,
"createTime": 1646731924000,
"updateTime": 1647942286000,
"creator": {
"user": "test@163.com",
"fullName": "测试用户"
},
"modifier": {
"user": "test@163.com",
"fullName": "测试用户"
},
"timePeriod": {
"id": 3,
"permissible": false,
"referred": false,
"deleted": false,
"operations": null,
"name": "昨日",
"identifier": "yd"
},
"domains": \[
{
"id": 1,
"permissible": false,
"referred": false,
"deleted": false,
"operations": null,
"createTime": 1645596603000,
"updateTime": 1645596603000,
"creator": "test@163.com",
"modifier": null,
"domainName": "指标域",
"parentDomainId": null,
"syncOwners": \[\],
"owners": \[
"test@163.com"
\],
"approve": false,
"syncApprovers": \[\],
"approvers": \[\],
"allRoles": false,
"allowedRoles": \[\],
"source": 0,
"sourceId": null,
"identifier": "xuz",
"indexApprovers": \[\]
}
\],
"referredIndexs": \[
{
"groupId": 1,
"clusterId": "testCluster",
"product": "项目名称",
"type": 0,
"subType": 0,
"name": "指标2",
"identifier": "code2",
"bizCaliber": "业务口径",
"domainId": 3,
"bizCaliberReporter": null,
"techCaliberReporter": null,
"express": null,
"customInfo": null,
"creator": null,
"modifier": null,
"createTime": null,
"updateTime": null
}
\],
"derivatives": \[\],
"decorations": \[\],
"decorationGroups": \[\],
"approvalInfo": null,
"idle": null,
"engfullName": null,
"securityLevel": "1-低",
"dataAnalystUsers": \[\],
"indexContributorUsers": \[\],
"dpRulesDto": {
"label": "非空",
"value": "NotNull"
},
"dataItemCategoryDto": {
"CL0": null,
"CL1": {
"label": "/CL1/CL12",
"value": "CL12"
},
"CL2": null,
"CL3": {
"label": "/CL3/CL13",
"value": "CL13"
}
},
"dataElementDto": {
"label": "测试",
"value": 422
}
}
\]
}
2.2.2 查询指标详细信息
GET /index/v3/get
产品版本:v2.3.0
描述:根据指标ID查询指标详细信息
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
id | Number | 指标ID | 是 | |
user | String | 用户邮箱,鉴权需要,不传不鉴权 | 否 | 无 |
请求示例:
id=1
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | IndexDetail | 指标详情 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": {
"id": 1,
"groupId": 1,
"clusterId": "testCluster",
"type": 1,
"subType": null,
"product": "项目名称",
"referredIndexIds": \[
2
\],
"name": "指标名称",
"identifier": "index\_code",
"coreIndex": false,
"domainId": 1,
"analyzableDimensions": \["可分析维度1"\],
"reportUrl": "",
"bizCaliber": "业务口径",
"bizCaliberReporter": {
"user": "test@163.com",
"fullName": "测试用户"
},
"techCaliber": "技术口径",
"realTimeTechCaliber": "实时技术口径",
"techCaliberReporter": {
"user": "test@163.com",
"fullName": "测试用户"
},
"derivativeIds": \[1,2\],
"decorationIds": \[1,2\],
"timePeriodId": 3,
"exposure": 20,
"express": "表达式",
"customInfo": {
"自定义字段bool": false,
"自定义字段str": "值"
},
"ownerPermission": false,
"techPermission": false,
"techPermissionOnly": false,
"refCount": 0,
"youDataRefCount": 0,
"createTime": 1646731924000,
"updateTime": 1647942286000,
"creator": {
"user": "test@163.com",
"fullName": "测试用户"
},
"modifier": {
"user": "test@163.com",
"fullName": "测试用户"
},
"timePeriod": {
"id": 3,
"permissible": false,
"referred": false,
"deleted": false,
"operations": null,
"name": "昨日",
"identifier": "yd"
},
"detailPath": "/easyindex/dict/11259?productId=25&clusterId=dev4"
"domains": \[
{
"id": 1,
"permissible": false,
"referred": false,
"deleted": false,
"operations": null,
"createTime": 1645596603000,
"updateTime": 1645596603000,
"creator": "test@163.com",
"modifier": null,
"domainName": "指标域",
"parentDomainId": null,
"syncOwners": \[\],
"owners": \[
"test@163.com"
\],
"approve": false,
"syncApprovers": \[\],
"approvers": \[\],
"allRoles": false,
"allowedRoles": \[\],
"source": 0,
"sourceId": null,
"identifier": "xuz",
"indexApprovers": \[\]
}
\],
"referredIndexs": \[
{
"groupId": 1,
"clusterId": "testCluster",
"product": "项目名称",
"type": 0,
"subType": 0,
"name": "指标2",
"identifier": "code2",
"bizCaliber": "业务口径",
"domainId": 3,
"bizCaliberReporter": null,
"techCaliberReporter": null,
"express": null,
"customInfo": null,
"creator": null,
"modifier": null,
"createTime": null,
"updateTime": null
}
\],
"derivatives": \[\],
"decorations": \[\],
"decorationGroups": \[\],
"approvalInfo": null,
"idle": null,
"engfullName": null,
"securityLevel": "1-低",
"dataAnalystUsers": \[\],
"indexContributorUsers": \[\],
"dpRulesDto": {
"label": "非空",
"value": "NotNull"
},
"dataItemCategoryDto": {
"CL0": null,
"CL1": {
"label": "/CL1/CL12",
"value": "CL12"
},
"CL2": null,
"CL3": {
"label": "/CL3/CL13",
"value": "CL13"
}
},
"dataElementDto": {
"label": "测试",
"value": 422
}
"detailPath": "/easyindex/dict/1?productId=1&clusterId=cluster1"
}
}
2.2.3 查询指标应用情况
GET /index/v3/ref/get
产品版本:v2.3.0
描述:查询指标的表级引用、字段级引用和有数BI中引用的情况
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
id | Number | 指标ID | 是 | |
user | String | 用户邮箱,鉴权需要,不传不鉴权 | 否 | 无 |
请求示例:
id=44&groupId=65&product=test&clusterId=dev4
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | IndexReference | 指标引用情况 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": {
"tableReferenceList": \[{
"catalog": "test-catalog",
"db": "test\_db",
"table": "ods\_test\_table",
"tableUrl": "http://dm-dev.bdms.netease.com/detail?tableName=ods\_test\_table&catalogName=test-catalog&databaseName=ods\_test\_table&accountId=1&clusterId=testCluster",
"dimFieldList": \[\]
}\],
"columnReferenceList": \[
{
"catalog": "test-catalog",
"db": "test\_db",
"table": "ods\_test\_table",
"tableUrl": "http://dm-dev.bdms.netease.com/detail?tableName=ods\_test\_table&catalogName=test-catalog&databaseName=ods\_test\_table&accountId=1&clusterId=testCluster",
"column": "test\_col",
"columnDescription": "测试字段",
"dimFieldList": \[\]
}
\],
"youdataReferenceList": \[
{
"reportName":"有数报告名称",
"reportFormNames":\["报表名称"\],
"url":"url"
}
\]
}
}
2.2.4 指标详情展示
GET /index/v3/show/get
产品版本:v2.4.1
描述:按照自定义字段设置展示指标详情,数据目录信息固定在最后的组信息中返回
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
id | Number | 指标ID | 是 | |
version | String | 版本 | 否 | 版本信息为空时查询当前指标版本信息 |
user | String | 用户邮箱,鉴权需要,不传不鉴权 | 否 | 无 |
请求示例:
id=44&version=1.0.0
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | ListIn<dexFieldGroup> | 指标详情显示信息 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": \[
{
"customGroupName": "基础信息",
"fieldList": \[
{
"field": "type",
"label": "指标类型",
"value": "原子指标"
},
{
"field": "subType",
"label": "原子指标分类",
"value": "主原子指标"
},
{
"field": "name",
"label": "指标名称",
"value": "ceshimulu"
},
{
"field": "domainId",
"label": "指标域",
"value": "zxm-sadwg"
},
{
"field": "identifier",
"label": "指标标识",
"value": "asd\_asd\_00016\_A\_-"
},
{
"field": "creator",
"label": "创建人",
"value": "陈佳"
},
{
"field": "createTime",
"label": "创建时间",
"value": ""
},
{
"field": "updateTime",
"label": "更新时间",
"value": ""
},
{
"field": "invalidTime",
"label": "失效时间",
"value": ""
},
{
"field": "approver",
"label": "审批人",
"value": "免审批"
},
{
"field": "approvalTime",
"label": "审核时间",
"value": ""
},
{
"field": "status",
"label": "指标状态",
"value": "新建"
},
{
"field": "version",
"label": "指标版本",
"value": "1.0.0"
},
{
"field": "coreIndex",
"label": "是否核心指标",
"value": "否"
},
{
"field": "analyzableDimension",
"label": "可分析维度",
"value": "- -"
},
{
"field": "reportUrl",
"label": "关联报表链接",
"value": "- -"
},
{
"field": "a8b00e758db24dc19304c03a9994780c",
"label": "指标标签",
"value": ""
},
{
"field": "securityLevel",
"label": "安全级别",
"value": null
},
{
"field": "dataElement",
"label": "引用标准",
"value": null
},
{
"field": "dqRules",
"label": "数据质量管理信息",
"value": ""
},
{
"field": "243a82ef8dba47f3957da420d98709f2",
"label": "备注",
"value": "测试openapi"
},
{
"field": "6cb8b8d951794c6d905ae58f7e03c160",
"label": "自定义",
"value": "测试自定义字段"
}
\]
},
{
"customGroupName": "口径定义",
"fieldList": \[
{
"field": "bizCaliber",
"label": "指标定义11",
"value": "yewukouj"
},
{
"field": "bizCaliberReporter",
"label": "指标owner",
"value": "陈虹宇"
},
{
"field": "techCaliber",
"label": "技术口径",
"value": "- -"
},
{
"field": "realTimeTechCaliber",
"label": "实时技术口径",
"value": "- -"
},
{
"field": "techCaliberReporter",
"label": "技术口径负责人",
"value": "- -"
}
\]
},
{
"customGroupName": "数据目录",
"fieldList": \[
{
"field": "ZTK",
"label": "数据分库",
"value": "/数据分库/主题库"
},
{
"field": "CL3",
"label": "业务过程",
"value": "/业务过程/CL8/CL3"
},
{
"field": "23",
"label": "应用系统",
"value": "/应用系统/23"
},
{
"field": "test1",
"label": "chenjiaTest",
"value": "/chenjiaTest/chenjiaTest"
}
\]
}
]
}
2.2.5 指标版本信息列表
GET /index/v3/version-list/get
产品版本:v2.4.1
描述:获取指标版本信息列表
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
id | Number | 指标ID | 是 | |
user | String | 用户邮箱,鉴权需要,不传不鉴权 | 否 | 无 |
请求示例:
id=44
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | ListIn<dexVersion> | 指标版本信息列表 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": \[
{
"indexId": 1,
"version": "1.0.1",
"status": "PUBLISHED",
"approver": {
"user": "test@163.com",
"fullName": "测试用户"
},
"approvalTime": 1654672508138
},
{
"indexId": 1,
"version": "1.0.0",
"status": "OFFLINED",
"approver": {
"user": "test@163.com",
"fullName": "测试用户"
},
"approvalTime": 1654662508138
}
\]
}
2.2.6 创建指标
POST /index/v3/create
产品版本:v2.8.4
描述:创建指标
URL参数/请求体
Content-Type: application/json
字段 | 类型 | 描述 | 是否必填 | 默认值 |
---|---|---|---|---|
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | |
productId |
Number | 项目ID | 是 | |
user | String | 操作用户邮箱(1-64个字符) | 是 | |
type | Number | 指标类型,详见:[InexType] | 是 | |
name | String | 指标名称(1-128个字符) | 是 | |
domainId | Number | 指标域 | 是 | |
bizCaliber | String | 业务口径 | 是 | |
bizCaliberReporter | String | 业务口径责任人邮箱(1-64个字符) | 是 | |
identifier | String | 指标标识符(1-128个字符) | 否 | |
subType | Number | 指标子类型,当只有当type=0时子类型才能生效,详见:[InexSubType] | 否 | |
referredIndexIds | List<Number> | 被引用指标Id集合 | 否 | |
coreIndex | Boolean | 是否核心指标 | 否 | |
analyzableDimensions | List<String> | 可分析维度(1-255个字符) | 否 | |
reportUrl | String | 关联报表 | 否 | |
techCaliber | String | 技术口径 | 否 | |
realTimeTechCaliber | String | 实时技术口径 | 否 | |
techCaliberReporter | String | 技术口径负责人邮箱(1-64个字符) | 否 | |
derivativeIds | List<Number> | 衍生词Id集合 | 否 | |
decorationIds | List<Number> | 修饰词Id集合 | 否 | |
express | String | 表达式 | 否 | |
engFullName | String | 英文全称(1-256个字符) | 否 | |
securityLevel | String | 安全等级(不固定枚举,见注册属性中"安全等级"字段的值域)(1-8个字符) | 否 | |
indexContributors | List<String> | 指标梳理贡献者邮箱 | 否 | |
dataAnalysts | List<String> | 数据分析师邮箱 | 否 | |
indexMetrics | List<String> | 指标度量(总长1-128个字符) | 否 | |
engName | String | 英文名称(1-128个字符) | 否 | |
department | String | 部门(1-256个字符) | 否 | |
customInfo | Map<String, Object> | 自定义字段信息(key 字段属性名称,value 值) | 否 | 无 |
请求示例:
curl -X POST \\
\-H "Content-Type: application/json" \\
\-d '{
"groupId":44,
"clusterId":"dev4",
"productId":1,
"user":"admin.netease.com",
"type":1,
"name":"test",
"domainId":123,
"bizCaliber":"bizCaliber",
"bizCaliberReporter":"adimn.netease.com",
"subType":1,
"referredIndexIds":\[123,456\],
"identifier":"identifier",
"coreIndex":true,
"analyzableDimensions":\["analyzableDimension1","analyzableDimension2"\],
"reportUrl":"reportUrl",
"techCaliber":"techCaliber",
"realTimeTechCaliber":"realTimeTechCaliber",
"techCaliberReporter":"admin.netease.com",
"derivativeIds":\[123,456\],
"decorationIds":\[123,456\],
"express":"express",
"engFullName":"engfullName",
"securityLevel":"1-低",
"indexContributors":\["admin.netease.com","contributor.netease.com"\],
"dataAnalysts":\["admin.netease.com","dataAnalyst.netease.com"\],
"indexMetrics":\["indexMetric1","indexMetric2"\],
"engName":"engName",
"department":"研发部",
"customInfo":{
"自定义文本型1":"test",
"自定义布尔型1":false,
"自定义枚举单选型1":"选项1",
"自定义枚举多选型1":\["选项1","选项2"\]
}
}' \\
http://easy-openapi.example.com/openapi/easyindex/index/v3/create
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | Number | 指标ID | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": 44
}
2.2.7 更新指标
POST /index/v3/update
产品版本:v2.8.4
描述:更新指标(只有toUpdateFields中的字段才会进行更新)
URL参数/请求体
Content-Type: application/json
字段 | 类型 | 描述 | 是否必填 | 默认值 |
---|---|---|---|---|
toUpdateFields | List<String> | 需要更新的字段列表(字段属性名称,系统字段+自定义字段) | 是 | 空集合(不更新,接口result字段返回null) |
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | |
id | Number | 指标ID | 是 | |
user | String | 操作用户邮箱(1-64个字符) | 是 | |
referredIndexIds | List<Number> | 被引用指标Id集合 | 否 | |
name | String | 指标名称(1-128个字符) | 否 | |
coreIndex | Boolean | 是否核心指标 | 否 | |
domainId | Number | 指标域 | 否 | |
analyzableDimensions | List<String> | 可分析维度(1-255个字符) | 否 | |
reportUrl | String | 关联报表 | 否 | |
bizCaliber | String | 业务口径 | 否 | |
bizCaliberReporter | String | 业务口径责任人邮箱(1-64个字符) | 否 | |
techCaliber | String | 技术口径 | 否 | |
realTimeTechCaliber | String | 实时技术口径 | 否 | |
techCaliberReporter | String | 技术口径负责人邮箱(1-64个字符) | 否 | |
derivativeIds | List<Number> | 衍生词Id集合 | 否 | |
decorationIds | List<Number> | 修饰词Id集合 | 否 | |
express | String | 表达式 | 否 | |
engFullName | String | 英文全称(1-256个字符) | 否 | |
securityLevel | String | 安全等级(不固定枚举,见注册属性中"安全等级"字段的值域)(1-8个字符) | 否 | |
indexContributors | List<String> | 指标梳理贡献者邮箱 | 否 | |
dataAnalysts | List<String> | 数据分析师邮箱 | 否 | |
indexMetrics | List<String> | 指标度量(总长1-128个字符) | 否 | |
engName | String | 英文名称(1-128个字符) | 否 | |
department | String | 部门(1-256个字符) | 否 | |
customInfo | Map<String, Object> | 自定义字段信息(key 字段属性名称,value 值) | 否 | 无 |
请求示例:
curl -X POST \\
\-H "Content-Type: application/json" \\
\-d '{
"toUpdateFields":\["指标名称","指标域","自定义文本型1"\],
"id":1,
"groupId":44,
"clusterId":"dev4",
"user":"admin.netease.com",
"name":"test",
"domainId":123,
"bizCaliber":"bizCaliber",
"bizCaliberReporter":"adimn.netease.com",
"referredIndexIds":\[123,456\],
"coreIndex":true,
"analyzableDimensions":\["analyzableDimension1","analyzableDimension2"\],
"reportUrl":"reportUrl",
"techCaliber":"techCaliber",
"realTimeTechCaliber":"realTimeTechCaliber",
"techCaliberReporter":"admin.netease.com",
"derivativeIds":\[123,456\],
"decorationIds":\[123,456\],
"express":"express",
"engFullName":"engfullName",
"securityLevel":"1-低",
"indexContributors":\["admin.netease.com","contributor.netease.com"\],
"dataAnalysts":\["admin.netease.com","dataAnalyst.netease.com"\],
"indexMetrics":\["indexMetric1","indexMetric2"\],
"engName":"engName",
"department":"研发部",
"customInfo":{
"自定义文本型1":"test",
"自定义布尔型1":false,
"自定义枚举单选型1":"选项1",
"自定义枚举多选型1":\["选项1","选项2"\]
}
}' \\
http://easy-openapi.example.com/openapi/easyindex/index/v3/update
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | Number | 指标id(若更新后生成了新的草稿态指标,则返回该草稿态指标id),为null时表示更新失败 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": 1
}
2.2.8 发布指标
POST /index/v3/publish
产品版本:v2.8.4
描述:发布指标(需要将用户配置成免审批用户,避免进入发布审批流程)
URL参数/请求体
Content-Type: application/json
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
id | Number | 指标ID | 是 | |
user | String | 用户邮箱 | 是 | |
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | 无 |
请求示例:
curl -X POST \\
\-H "Content-Type: application/json" \\
\-d '{
"groupId":1,
"clusterId":"dev4",
"id":44,
"user":"admin.netease.com"
}' \\
http://easy-openapi.example.com/openapi/easyindex/index/v3/publish
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | Boolean | 是否成功 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": true
}
2.2.9 下线指标
POST /index/v3/offline
产品版本:v2.8.4
描述:下线指标(需要将用户配置成免审批用户,避免进入下线审批流程)
URL参数/请求体
Content-Type: application/json
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
id | Number | 指标ID | 是 | |
user | String | 用户邮箱 | 是 | |
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | 无 |
请求示例:
curl -X POST \\
\-H "Content-Type: application/json" \\
\-d '{
"groupId":1,
"clusterId":"dev4",
"id":44,
"user":"admin.netease.com"
}' \\
http://easy-openapi.example.com/openapi/easyindex/index/v3/offline
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | Boolean | 是否操作成功 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": true
}
2.2.10 删除指标
POST /index/v3/delete
产品版本:v2.8.4
描述:删除指标(需先下线才可删除)
URL参数/请求体
Content-Type: application/json
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
id | Number | 指标ID | 是 | |
user | String | 用户邮箱 | 是 | |
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | 无 |
请求示例:
curl -X POST \\
\-H "Content-Type: application/json" \\
\-d '{
"groupId":1,
"clusterId":"dev4",
"id":44,
"user":"admin.netease.com"
}' \\
http://easy-openapi.example.com/openapi/easyindex/index/v3/delete
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | Boolean | 是否操作成功 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": true
}
2.2.11 获取指标血缘
GET /index/v3/lineage/get
产品版本:v2.8.4
描述:根据指标ID获取指标血缘
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
id | Number | 指标ID | 是 | |
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | 无 |
请求示例:
curl -X GET http://easy-openapi.example.com/openapi/easyindex/index/v3/lineage/get?id=1&groupId=1&clusterId=dev
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | IndexLineage | 指标血缘 | 是 | 无 |
响应示例:
{
"code": 0,
"action": 0,
"msg": null,
"result": {
"success": true,
"indexList": \[
{
"id": 5,
"type": 2,
"subType": null,
"name": "昨日熊ffffaaaaa可爱迷人衍生词一般般aaaaaaa",
"identifier": "aaaaaa\_dididi\_xiong\_ffffaa\_aaa\_yd",
"domainName": "物流-顺丰",
"bizCaliber": "昨日熊ffffaaaaa可爱迷人衍生词一般般aaaaaaa",
"bizCaliberReporterUser": {
"email": "test@corp.netease.com",
"fullName": "测试"
}
},
{
"id": 6,
"type": 0,
"subType": 0,
"name": "aqaq",
"identifier": "aqaq",
"domainName": "商品-大写二级主题域",
"bizCaliber": "aqaq",
"bizCaliberReporterUser": {
"email": "test@corp.netease.com",
"fullName": "测试"
}
},
{
"id": 7,
"type": 0,
"subType": 0,
"name": "lalala",
"identifier": "fff1",
"domainName": "商品-大写二级主题域",
"bizCaliber": "fdfd",
"bizCaliberReporterUser": {
"email": "test@corp.netease.com",
"fullName": "测试"
}
},
{
"id": 78,
"type": 2,
"subType": null,
"name": "移动端去年母婴页面活跃用户的数量",
"identifier": "userwa",
"domainName": "",
"bizCaliber": "验证不同情况下的批量上传问题",
"bizCaliberReporterUser": {
"email": "test@corp.netease.com",
"fullName": "测试"
}
},
{
"id": 104,
"type": 0,
"subType": 0,
"name": "隐藏test",
"identifier": "hide",
"domainName": "",
"bizCaliber": "隐藏testtest",
"bizCaliberReporterUser": {
"email": "test@corp.netease.com",
"fullName": "测试"
}
},
{
"id": 105,
"type": 0,
"subType": 0,
"name": "dsfsfsd",
"identifier": "sdfsdfsd",
"domainName": "",
"bizCaliber": "vvv",
"bizCaliberReporterUser": {
"email": "test@corp.netease.com",
"fullName": "测试"
}
},
{
"id": 107,
"type": 0,
"subType": 0,
"name": "aaafdsfa",
"identifier": "aaaasdfa",
"domainName": "",
"bizCaliber": "ddd",
"bizCaliberReporterUser": {
"email": "test@corp.netease.com",
"fullName": "测试"
}
}
\],
"relationList": \[
{
"dest": 6,
"source": 5
},
{
"dest": 104,
"source": 5
},
{
"dest": 7,
"source": 6
},
{
"dest": 78,
"source": 6
},
{
"dest": 105,
"source": 6
},
{
"dest": 107,
"source": 6
}
\],
"IndexId": 5
},
"reqId": "6fcaa54bfbe44fa7938bde8fca578ab1",
"cost": 15
}
2.3 修饰词API
2.3.1 修饰词分页搜索
POST /decoration/v3/group/search
产品版本:v2.3.0
描述:搜索修饰词,返回分页结果
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | |
pageSize | Number | 每页条数 | 否 | 10 |
pageNum | Number | 第几页 | 否 | 1 |
creators | List<String> | 创建者 | 否 | |
groupName | String | 修饰词类型名称 | 否 | |
name | String | 修饰词名 | 否 | |
identifier | String | 修饰词标识 | 否 | |
orderField | String | 排序字段,目前只有createTime | 否 | |
orderBy | String | 是否顺序排序,填 DESC 或 ASC | 否 | DESC |
user | String | 用户邮箱,鉴权需要,不传不鉴权 | 否 | 无 |
请求示例:
{
"groupId":1,
"clusterId":"testCluster",
"name":"test",
"pageSize":1
}
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
orderBy | String | 是否顺序排序,填 DESC 或 ASC | 否 | DESC |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": {
"pageNum": 1,
"pageSize": 1,
"totalCount": 2,
"totalPage": 2,
"list": \[
{
"id": 1,
"name": "修饰词组名称",
"decorationList": \[
{
"id": 2,
"groupId": 1,
"name": "修饰词名称",
"identifier": "test"
}
\],
"description": "",
"creator": {
"user": "test@corp.netease.com",
"fullName": "测试账号"
},
"modifier": null,
"createTime": 1615968050000,
"updateTime": 1615968050000
}
\]
}
}
2.3.2 查询修饰词组详情
GET /decoration/v3/group/get
产品版本:v2.3.0
描述:根据修饰词组ID查询修饰组信息
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | |
id | Number | 修饰词类型ID | 是 | |
user | String | 用户邮箱,鉴权需要,不传不鉴权 | 否 | 无 |
请求示例:
groupId=1&clusterId=testCluster&id=1
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | DecorationGroup | 修饰词详情 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result":{
"id": 1,
"name": "修饰词组",
"decorations": \[
{
"id": 2,
"groupId": 1,
"name": "修饰词1",
"identifier": "test1"
},
{
"id": 2,
"groupId": 1,
"name": "修饰词2",
"identifier": "test2"
}
\],
"description": "描述",
"creator": {
"user": "test@corp.netease.com",
"fullName": "测试账号"
},
"modifier": null,
"createTime": 1590584167000,
"updateTime": 1590584167000,
}
}
2.3.3 查询修饰词引用情况
GET /decoration/v3/group/ref/get
产品版本:v2.3.0
描述:根据修饰词组ID获取修饰词引用信息
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | |
id | Number | 修饰词类型ID | 是 | |
user | String | 用户邮箱,鉴权需要,不传不鉴权 | 否 | 无 |
请求示例:
groupId=1&clusterId=testCluster&id=1
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | Array<Object> | 修饰词引用情况 | 是 | 无 |
reslut详情
字段 | 类型 | 描述 |
---|---|---|
indexId | Number | 指标ID |
indexName | String | 指标名称 |
indexType | Number | 指标类型 |
indexSubType | Number | 指标子类型 |
bizCaliber | User | 业务口径负责人 |
decorationName | String | 修饰词名称 |
decorationIdentifier | String | 修饰词标识 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result":\[
{
"indexId": 1
"indexName": "被引用指标名称",
"indexType": 0,
"indexSubType": 1,
"bizCaliber": {
"user": "test@corp.netease.com",
"fullName": "测试账号"
}
}
\]
}
2.4 衍生词API
2.4.1 衍生词分页搜索
POST /derivative/v3/search
产品版本:v2.3.0
描述:搜索衍生词,返回分页结果
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | |
pageSize | Number | 每页条数 | 否 | 10 |
pageNum | Number | 第几页 | 否 | 1 |
creators | List<String> | 创建者 | 否 | |
name | String | 衍生词名称 | 否 | |
identifier | String | 衍生词标识 | 否 | |
orderField | String | 排序字段,目前只有createTime | 否 | |
orderBy | String | 排序方式,填 DESC或者ASC | 否 | DESC |
user | String | 用户邮箱,鉴权需要,不传不鉴权 | 否 | 无 |
请求示例:
{
"groupId":1,
"clusterId":"testCluster",
"name":"test",
"pageSize":1
}
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | PageResult<Derivative> | 衍生词列表 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result":{
"pageNum": 1,
"pageSize": 1,
"totalCount": 33,
"totalPage": 33,
"list": \[
{
"id": 1,
"groupId": 1,
"clusterId": "testCluster",
"name": "衍生词名称",
"identifier": "test",
"calculateCaliber": "test",
"description": "描述",
"createTime": 1640931986000,
"updateTime": 1640931986000,
"approvalInfo": null,
"creator": {
"user": "test@corp.netease.com",
"fullName": "测试账号"
},
"modifier": null
}
\]
},
}
2.4.2 查询衍生词信息
GET /derivative/v3/get
产品版本:v2.3.0
描述:根据衍生词D查询衍生词信息
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | |
id | Number | 衍生词ID | 是 | |
user | String | 用户邮箱,鉴权需要,不传不鉴权 | 否 | 无 |
请求示例:
groupId=1& clusterId=testCluster&id=1
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | Derivative | 衍生词信息 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result": {
"id": 1,
"groupId": 1,
"clusterId": "testCluster",
"name": "衍生词名称",
"identifier": "test",
"calculateCaliber": "test",
"description": "描述",
"createTime": 1590404437000,
"updateTime": 1590404437000,
"approvalInfo": {
"avoidApproval": false,
"indexApprover": {
"user": "test@corp.netease.com",
"fullName": "测试账号"
},
"platformApprover": null,
"approvalAdvice": null,
"approvalTime": null
},
"creator": {
"user": "test@corp.netease.com",
"fullName": "测试账号"
},
"modifierUser": null
}
}
2.4.3 查询衍生词引用情况
GET /derivative/v3/ref/get
产品版本:v2.3.0
描述:根据衍生词ID获取衍生词引用信息
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | |
id | Number | 衍生词ID | 是 | |
user | String | 用户邮箱,鉴权需要,不传不鉴权 | 否 | 无 |
请求示例:
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | Object | 衍生词引用情况 | 是 | 无 |
reslut详情
字段 | 类型 | 描述 |
---|---|---|
indexId | Number | 指标ID |
indexName | String | 指标名称 |
indexType | Number | 指标类型 |
indexSubType | Number | 指标子类型 |
bizCaliber | User | 业务口径负责人 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result":\[
{
"indexId": 15,
"indexName": "hhheaqaq",
"indexType": 0,
"indexSubType": 1,
"bizCaliber": {
"user": "test@corp.netease.com",
"fullName": "测试账号"
}
}
\]
}
2.5 指标域API
2.5.1 分页查询指标域列表信息
GET /domain/v3/tree/get
产品版本:v2.3.0
描述:分页查询指标域列表信息,按层级返回
URL参数/请求体
名称 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
groupId | Number | 项目组ID | 是 | |
clusterId | String | 集群ID | 是 | |
pageSize | Number | 每页大小 | 否 | 10 |
pageNum | Number | 第几页 | 否 | 1 |
user | String | 用户邮箱,鉴权需要,不传不鉴权 | 否 | 无 |
请求示例:
{
"groupId":1,
"clusterId":"testCluster",
"pageSize":1
}
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | PageResult<DomainDetail> | 指标域详情 | 是 | 无 |
响应示例:
{
"code": 0,
"cost": 10,
"reqId": "3b35310c3b024366b5600e66872214f5",
"msg": null,
"result":{
"pageNum": 1,
"pageSize": 1,
"totalCount": 65,
"totalPage": 65,
"list": \[
{
"id": 1,
"permissible": false,
"referred": true,
"deleted": false,
"operations": null,
"createTime": 1642399438000,
"updateTime": 1642399438000,
"creator": "test@corp.netease.com",
"modifier": null,
"domainName": "一级主题域名称",
"parentDomainId": null,
"syncOwners": \[\],
"owners": \[
{
"user": "test@163.com",
"fullName": "测试用户"
}
\],
"approve": false,
"syncApprovers": \[\],
"approvers": \[\],
"allRoles": false,
"allowedRoles": \[\],
"source": 0,
"sourceId": null,
"identifier": "test1",
"indexApprovers": \[\],
"list": \[
{
"id": 2,
"permissible": false,
"referred": true,
"deleted": false,
"operations": null,
"createTime": 1642399592000,
"updateTime": 1642661594000,
"creator": "test@corp.netease.com",
"modifier": null,
"domainName": "二级主题域名称",
"parentDomainId": 1,
"syncOwners": \[\],
"owners": \[\],
"approve": false,
"syncApprovers": \[\],
"approvers": \[\],
"allRoles": true,
"allowedRoles": \[\],
"source": 0,
"sourceId": null,
"identifier": "test2",
"indexApprovers": \[
{
"user": "test@163.com",
"fullName": "测试用户"
}
\],
"list": \[\],
"syncOwnerUserList": \[\],
"syncApproverUserList": \[\],
"ownerUserList": \[\],
"approverUserList": \[\],
"indexApproversUserList": \[
{
"user": "test@corp.netease.com",
"fullName": "测试账号"
}
\],
"creator":{
"user": "test@corp.netease.com",
"fullName": "测试账号"
},
"modifierUser": null
}
\]
}
\]
}
}
以上内容对您是否有帮助?