跳到主要内容

跨源配置 API

最近更新 2026/10/05

调用方法请参见Open API文档中的调用方法描述。

1. 创建跨源资产配置​

创建跨源资产配置。

接口URL

/open/route/createRoute?token=xxx&proejctId=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId102Integer是项目ID

请求Body参数

代码块
{
"routeConfig": {
"routeCode":"",//
"routeDesc":"",//跨源资产配置显示名
"remark":"",//配置说明
"viewResourceRouteType":"event",//资产类型[tag,event,user,dim]
"modelTable":"",//数据源
"highOrWideEnum":"",//高宽表[high,wide]
// event
"configEntityIdColumn":""//主体列 //event&dim
"dataPartTypeEnum":""//数据分区方式[column_date_part|auto_push_logic][日期信息列|自定义下推逻辑]
"configDateColumn":""//日期信息列
"configDateFormat":""//日期信息格式
"configBusinessPushLogic":""//下推逻辑
"businessEventNameSelectEnum":""//事件名取值方式[val|raw_column][固定值|读取列值]
"configEventName":""//事件名称
"configEventNameColumn":""//事件名称列
"businessEventDateValueSelectEnum":""//事件时间取值方式[raw_column|expression][读取列值|自定义SQL]
"configEventTimeColumn":""//事件时间列
"configEventTimeLogic":""//事件时间逻辑
"businessEventZoneOffsetSelectEnum":""//事件时区取值方式[raw_column|val|expression][读取列值|固定值|自定义SQL]
"configEventTimeTZColumn":""//事件时区列
"configEventTimeTZ":""//事件时区
"configEventTimeTZLogic":""//事件时区逻辑
//tag
"configEntityColumn":"",//主体列
"configEntityName":"",//分析主体-- 提交分析主体显示名
"configTagNameColumn":"",//标签名称列
"configTagValueColumn":"",//标签值列
"configDateColumn":"",//日期信息列
"tagHistoryVersion":"",//标签日期版本[onlyHistory,onlyLast,historyAndLast]
"configTagDateZoneOffsetVal":"",//标签日期时区
"configDateFormat":"",//日期信息格式
//user
"configDataUpdateTimeColumn":"", //数据更新时间列
//dim
"configEntityIdColumn":""//主体列
"configEntityProp":"",//主体属性
"propType":"",// 主体属性类型
"timeUnitFormat":""// 时间粒度

},
"eventMappings": [
{
"routeCodeFromEvent":"",//跨源资产配置名称
"targetEventName":"",//输出事件名
"sourceEventList":"",//原始事件列表
"targetEventDesc":"",//输出事件显示名
"remark":"",//备注
},
],
"propMappings":[
{
"routeCodeFromProp":""//跨源资产配置名称
"sourcePropName":""//原始属性名
"targetPropName":""//输出属性名
"targetPropDesc":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetPropTypeEnum":""//输出属性类型 [array_string]
"isPublic":true//是否公共属性
"propConfigRemark":""//备注
"enumValues":["",]//枚举文件标记

}
],
"eventPropMap":[//
{
"routeCodeFromEventPropMap":""//跨源资产配置名称
"eventName":""//输出事件名
"propName":""//输出属性名
}
],
"tagMappings": [
{
"routeCodeFromTag":"",//跨源资产配置名称
"routeResourceKey":"",//原始标签名
"targetTagName":"",//输出标签名
"targetTagDesc":"",//输出标签显示名
"sqlExpression":"",//取值方式
"routeSelectTypeEnum":"",//[number,string,datetime,bool,array]
"extRemark":"",//备注
"extValueZoneOffset":"",//值时区
"enumValues":["",]//枚举文件标记
},
],
"userPropMapping": [
{
"routeCodeFromUserProp":""//跨源资产配置名称
"sourcePropName":""//原始属性名
"targetPropName":""//输出属性名
"targetPropDesc":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetPropTypeEnum":""//输出属性类型
"propConfigRemark":""//备注
"enumValues":["",]//枚举文件标记
}
],
"dimPropMapping":[ //-> get.eventProps
{
"routeCodeFromDim":""//跨源资产配置名称
"sourceNameFromDim":""//原始属性名
"targetNameFromDim":""//输出属性名
"targetDescFromDim":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetTypeEnum":""//输出属性类型
"remark":""//备注
"enumValues":["",]//枚举文件标记
}
]
}
参数名

示例值

参数类型

是否必填

参数描述
routeConfig-Object是跨源资产配置信息
routeConfig.routeCoderoute_v1String是跨源资产配置名称(资产类型为user时 传user_entity_route)
routeConfig.routeDesc跨源资产配置String否跨源资产配置显示名
routeConfig.remark跨源资产配置说明String否配置说明
routeConfig.viewResourceRouteTypeeventString是资产类型,取值范围为[tag, event, user, dim]
routeConfig.modelTablehive.ta.table_2321String是数据源
routeConfig.highOrWideEnumwideString是高宽表,取值范围为[high, wide](事件类型仅支持宽表)
(event)
routeConfig.configEntityIdColumnentity_idString否主体列 (routeConfig.viewResourceRouteType=event|dim, 必填)
routeConfig.dataPartTypeEnumcolumn_date_partString是数据分区方式,取值范围为[column_date_part, auto_push_logic]
routeConfig.configDateColumn#event_timeString否日期信息列 (dataPartTypeEnum=column_date_part, 必填)
routeConfig.configDateFormatyyyy-MM-ddString否日期信息格式(dataPartTypeEnum=column_date_part, 必填)
routeConfig.configBusinessPushLogicString否下推逻辑 (dataPartTypeEnum=auto_push_logic时,必填)
routeConfig.businessEventNameSelectEnumraw_columnString是事件名取值方式,取值范围为[val, raw_column]
routeConfig.configEventNameloginString否事件名称 (businessEventNameSelectEnum=val, 必填)
routeConfig.configEventNameColumn#event_nameString否事件名称列 (businessEventNameSelectEnum=raw_column, 必填)
routeConfig.businessEventDateValueSelectEnumraw_columnString是事件时间取值方式,取值范围为[raw_column, expression]
routeConfig.configEventTimeColumn#event_timeString否事件时间列 (businessEventDateValueSelectEnum=raw_column, 必填)
routeConfig.configEventTimeLogicdate_parse( "ev_time", '%Y-%m-%d %H:%i:%s' )String否

事件时间逻辑 (businessEventDateValueSelectEnum=expression, 必填)

routeConfig.businessEventZoneOffsetSelectEnumraw_columnString是

事件时区取值方式,取值范围为[raw_column, val, expression]

routeConfig.configEventTimeTZColumn#zone_offsetString否事件时区列 (businessEventZoneOffsetSelectEnum=raw_column, 必填)
routeConfig.configEventTimeTZ8String否事件时区 (businessEventZoneOffsetSelectEnum=val, 必填)
routeConfig.configEventTimeTZLogiccast( substr( "zone_offset", 3, 9 ) as double )String否事件时区逻辑 (businessEventZoneOffsetSelectEnum=expression, 必填)
(tag)
routeConfig.configEntityColumnentity_idString是主体列
routeConfig.configEntityNameuser_loginString是分析主体-- 提交分析主体显示名
routeConfig.configTagNameColumntag_name_colString是标签名称列
routeConfig.configTagValueColumntag_value_colString是标签值列

routeConfig.tagHistoryVersion

onlyLastString

是

标签日期版本,取值范围为[onlyHistory,onlyLast,historyAndLast]
routeConfig.configDateColumn#event_timeString

否

日期信息列 (选填) 选择日期分区所在的列, 若日期版本为"仅最新版本"则无需填写
routeConfig.configTagDateZoneOffsetVal

8

String

否

标签日期时区 , 日期信息列不为空时必填

routeConfig.configDateFormatyyyy-MM-ddString否日期信息格式,日期信息列不为空时必填
(user)
routeConfig.configDataUpdateTimeColumn#update_timeString否数据更新时间列
(dim)
routeConfig.configEntityIdColumn#id否主体列
routeConfig.configEntityProp#login否主体属性
routeConfig.propTypeuserPropEnum否主体属性类型 [userProp, eventProp]
routeConfig.timeUnitFormat

DATE_STR_YEAR

Enum否

时间粒度

[DATE_STR_YEAR, DATE_STR_MONTH, DATE_STR_DAY, DATE_STR_HOUR, DATE_STR_MINUTE, DATE_STR_SECOND, DATE_STR_MILLISECOND]

-
eventMappings-Array-
eventMappings.routeCodeFromEventroute_v1String是跨源资产配置名称
eventMappings.targetEventNameloginString是输出事件名
eventMappings.sourceEventList( 'event_1' , 'event_2' )String否原始事件列表
eventMappings.targetEventDesc登录String否输出事件显示名
eventMappings.remarkOSS登录String否备注
-
propMappings-Array-
propMappings.routeCodeFromProproute_v1String是跨源资产配置名称
propMappings.sourcePropNameaccountString否原始属性名
propMappings.targetPropNameaccountString是输出属性名
propMappings.targetPropDesc账户String否输出属性显示名
propMappings.sqlExpressionFromProp-String否取值方式
propMappings.targetPropTypeEnumStringString是输出属性类型[]
propMappings.isPublictrueBoolean否是否公共属性
propMappings.propConfigRemark-String否备注
propMappings.enumValues["user1","user2"]List<String>否枚举值
-
eventPropMap-Array-
eventPropMap.routeCodeFromEventPropMaproute_v1String是跨源资产配置名称
eventPropMap.eventName-String是输出事件名
eventPropMap.propName-String是输出属性名
-
tagMappings-Array
tagMappings.routeCodeFromTagroute_v1String是跨源资产配置名称
tagMappings.routeResourceKeytag_1String否原始标签名
tagMappings.targetTagNametag_nameString是输出标签名
tagMappings.targetTagDesctag_descString否输出标签显示名
tagMappings.sqlExpression-String否取值方式
tagMappings.routeSelectTypeEnumnumberString是取值范围为[number,string,datetime,bool,array]
tagMappings.extRemark-String否备注
tagMappings.extValueZoneOffset8String否值时区
tagMappings.enumValues["t_1","t_2"]List<String>否枚举文件标记
-
userPropMapping
userPropMapping.routeCodeFromUserProproute_v1String是跨源资产配置名称
userPropMapping.sourcePropNameaccountString否原始属性名
userPropMapping.targetPropNameaccountString是输出属性名
userPropMapping.targetPropDesc账户String否输出属性显示名
userPropMapping.sqlExpressionFromProp-String否取值方式
userPropMapping.targetPropTypeEnumStringString是输出属性类型[]
userPropMapping.propConfigRemark-String否备注
userPropMapping.enumValues["user1","user2"]List<String>否枚举值
-
dimPropMapping
dimPropMapping.routeCodeFromDimroute_v1String是跨源资产配置名称
dimPropMapping.sourceNameFormDimaccountString否原始属性名
dimPropMapping.targetNameFromDimaccountString是输出属性名
dimPropMapping.targetDescFromDim账户String否输出属性显示名
dimPropMapping.sqlExpressionFromProp-String否取值方式
dimPropMapping.targetTypeEnumStringString是输出属性类型[]
dimPropMapping.remark-String否备注
dimPropMapping.enumValues["user1","user2"]List<String>否枚举值

成功响应示例

{
"return_code": 0,
"return_message": "success"
}

2. 更新跨源资产配置​

接口URL

/open/route/updateRoute?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId102Integer是项目ID

请求Body参数

{
"routeConfig": {
"routeCode":"",//
"routeDesc":"",//跨源资产配置显示名
"remark":"",//配置说明
"viewResourceRouteType":"event",//资产类型[tag,event,user,dim]
"modelTable":"",//数据源
"highOrWideEnum":"",//高宽表[high,wide]
//event
"configEntityIdColumn":""//主体列
"dataPartTypeEnum":""//数据分区方式[column_date_part|auto_push_logic][日期信息列|自定义下推逻辑]
"configDateColumn":""//日期信息列
"configDateFormat":""//日期信息格式
"configBusinessPushLogic":""//下推逻辑
"businessEventNameSelectEnum":""//事件名取值方式[val|raw_column][固定值|读取列值]
"configEventName":""//事件名称
"configEventNameColumn":""//事件名称列
"businessEventDateValueSelectEnum":""//事件时间取值方式[raw_column|expression][读取列值|自定义SQL]
"configEventTimeColumn":""//事件时间列
"configEventTimeLogic":""//事件时间逻辑
"businessEventZoneOffsetSelectEnum":""//事件时区取值方式[raw_column|val|expression][读取列值|固定值|自定义SQL]
"configEventTimeTZColumn":""//事件时区列
"configEventTimeTZ":""//事件时区
"configEventTimeTZLogic":""//事件时区逻辑
//tag
"configEntityColumn":"",//主体列
"configEntityName":"",//分析主体-- 提交分析主体显示名
"configTagNameColumn":"",//标签名称列
"configTagValueColumn":"",//标签值列
"configDateColumn":"",//日期信息列
"tagHistoryVersion":"",//标签日期版本[onlyHistory,onlyLast,historyAndLast]
"configTagDateZoneOffsetVal":"",//标签日期时区
"configDateFormat":"",//日期信息格式
//user
"configDataUpdateTimeColumn":"", //数据更新时间列
//dim
"configEntityIdColumn":""//主体列
"configEntityProp":"",//主体属性
"propType":"",// 主体属性类型
"timeUnitFormat":""// 时间粒度
"configEntityIdColumn":""//主体列
},
"eventMappings": [
{
"routeCodeFromEvent":"",//跨源资产配置名称
"targetEventName":"",//输出事件名
"sourceEventList":"",//原始事件列表
"targetEventDesc":"",//输出事件显示名
"remark":"",//备注
},
],
"propMappings":[
{
"routeCodeFromProp":""//跨源资产配置名称
"sourcePropName":""//原始属性名
"targetPropName":""//输出属性名
"targetPropDesc":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetPropTypeEnum":""//输出属性类型
"isPublic":true//是否公共属性
"propConfigRemark":""//备注
}
],
"eventPropMap":[//
{
"routeCodeFromEventPropMap":""//跨源资产配置名称
"eventName":""//输出事件名
"propName":""//输出属性名
}
],
"tagMappings": [
{
"routeCodeFromTag":"",//跨源资产配置名称
"routeResourceKey":"",//原始标签名
"targetTagName":"",//输出标签名
"targetTagDesc":"",//输出标签显示名
"sqlExpression":"",//取值方式
"routeSelectTypeEnum":"",//[number,string,datetime,bool,array]
"extRemark":"",//备注
"extValueZoneOffset":"",//值时区
},
],
"userPropMapping": [
{
"routeCodeFromUserProp":""//跨源资产配置名称
"sourcePropName":""//原始属性名
"targetPropName":""//输出属性名
"targetPropDesc":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetPropTypeEnum":""//输出属性类型
"propConfigRemark":""//备注
}
],
"dimPropMapping":[ //-> get.eventProps
{
"routeCodeFromDim":""//跨源资产配置名称
"sourceNameFormDim":""//原始属性名
"targetNameFromDim":""//输出属性名
"targetDescFromDim":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetTypeEnum":""//输出属性类型
"remark":""//备注
}
]
}
参数名

示例值

参数类型

是否必填

参数描述
routeConfig-Object是跨源资产配置信息
routeConfig.routeCoderoute_v1String是跨源资产配置名称
routeConfig.routeDesc跨源资产配置String否跨源资产配置显示名
routeConfig.remark跨源资产配置说明String否配置说明
routeConfig.viewResourceRouteTypeeventString是资产类型,取值范围为[tag, event, user, dim]
routeConfig.modelTablehive.ta.table_2321String是数据源
routeConfig.highOrWideEnumwideString是高宽表,取值范围为[high, wide](事件类型仅支持宽表)
(event)
routeConfig.configEntityIdColumnentity_idString否主体列
routeConfig.dataPartTypeEnumcolumn_date_partString是数据分区方式,取值范围为[column_date_part, auto_push_logic]
routeConfig.configDateColumn#event_timeString否日期信息列 (dataPartTypeEnum=column_date_part, 必填)
routeConfig.configDateFormatyyyy-MM-ddString否日期信息格式(dataPartTypeEnum=column_date_part, 必填)
routeConfig.configBusinessPushLogicString否下推逻辑 (dataPartTypeEnum=auto_push_logic时,必填)
routeConfig.businessEventNameSelectEnumraw_columnString是事件名取值方式,取值范围为[val, raw_column]
routeConfig.configEventNameloginString否事件名称 (businessEventNameSelectEnum=val, 必填)
routeConfig.configEventNameColumn#event_nameString否事件名称列 (businessEventNameSelectEnum=raw_column, 必填)
routeConfig.businessEventDateValueSelectEnumraw_columnString是事件时间取值方式,取值范围为[raw_column, expression]
routeConfig.configEventTimeColumn#event_timeString否事件时间列 (businessEventDateValueSelectEnum=raw_column, 必填)
routeConfig.configEventTimeLogicdate_parse( "ev_time", '%Y-%m-%d %H:%i:%s' )String否事件时间逻辑 (businessEventDateValueSelectEnum=expression, 必填)
routeConfig.businessEventZoneOffsetSelectEnumraw_columnString是事件时区取值方式,取值范围为[raw_column, val, expression]
routeConfig.configEventTimeTZColumn#zone_offsetString否事件时区列 (businessEventZoneOffsetSelectEnum=raw_column, 必填)
routeConfig.configEventTimeTZ8String否事件时区 (businessEventZoneOffsetSelectEnum=val, 必填)
routeConfig.configEventTimeTZLogiccast( substr( "zone_offset", 3, 9 ) as double )String否事件时区逻辑 (businessEventZoneOffsetSelectEnum=expression, 必填)
(tag)
routeConfig.configEntityColumnentity_idString是主体列
routeConfig.configEntityNameuser_loginString是分析主体-- 提交分析主体显示名
routeConfig.configTagNameColumntag_name_colString是标签名称列
routeConfig.configTagValueColumntag_value_colString是标签值列
routeConfig.tagHistoryVersiononlyLastString

是

标签日期版本,取值范围为[onlyHistory,onlyLast,historyAndLast]
routeConfig.configDateColumn#event_timeString否日期信息列 (选填) 选择日期分区所在的列, 若日期版本为"仅最新版本"则无需填写
routeConfig.configTagDateZoneOffsetVal8String否标签日期时区 , 日期信息列不为空时必填
routeConfig.configDateFormatyyyy-MM-ddString否日期信息格式,日期信息列不为空时必填
(user)
routeConfig.configDataUpdateTimeColumn#update_timeString否数据更新时间列
(dim)
routeConfig.configEntityIdColumn#id否主体列
routeConfig.configEntityProp#login否主体属性
routeConfig.propTypeuserPropEnum否主体属性类型 [userProp, eventProp]

routeConfig.timeUnitFormat

DATE_STR_YEAR

Enum否

时间粒度

[DATE_STR_YEAR, DATE_STR_MONTH, DATE_STR_DAY, DATE_STR_HOUR, DATE_STR_MINUTE, DATE_STR_SECOND, DATE_STR_MILLISECOND]

-
eventMappings-Array-
eventMappings.routeCodeFromEventroute_v1String是跨源资产配置名称
eventMappings.targetEventNameloginString是输出事件名
eventMappings.sourceEventList( 'event_1' , 'event_2' )String否原始事件列表
eventMappings.targetEventDesc登录String否输出事件显示名
eventMappings.remarkOSS登录String否备注
-
propMappings-Array-
propMappings.routeCodeFromProproute_v1String是跨源资产配置名称
propMappings.sourcePropNameaccountString否原始属性名
propMappings.targetPropNameaccountString是输出属性名
propMappings.targetPropDesc账户String否输出属性显示名
propMappings.sqlExpressionFromProp-String否取值方式
propMappings.targetPropTypeEnumStringString是输出属性类型
propMappings.isPublictrueBoolean否是否公共属性
propMappings.propConfigRemark-String否备注
-
eventPropMap-Array-
eventPropMap.routeCodeFromEventPropMaproute_v1String是跨源资产配置名称
eventPropMap.eventName-String是输出事件名
eventPropMap.propName-String是输出属性名
-
tagMappings-Array
tagMappings.routeCodeFromTagroute_v1String是跨源资产配置名称
tagMappings.routeResourceKeytag_1String否原始标签名
tagMappings.targetTagNametag_nameString是输出标签名
tagMappings.targetTagDesctag_descString否输出标签显示名
tagMappings.sqlExpression-String否取值方式
tagMappings.routeSelectTypeEnumnumberString是取值范围为[number,string,datetime,bool,array]
tagMappings.extRemark-String否备注
tagMappings.extValueZoneOffset8String否值时区
-
userPropMapping
userPropMapping.routeCodeFromUserProproute_v1String是跨源资产配置名称
userPropMapping.sourcePropNameaccountString否原始属性名
userPropMapping.targetPropNameaccountString是输出属性名
userPropMapping.targetPropDesc账户String否输出属性显示名
userPropMapping.sqlExpressionFromProp-String否取值方式
userPropMapping.targetPropTypeEnumStringString是输出属性类型[]
userPropMapping.propConfigRemark-String否备注
userPropMapping.enumValues["user1","user2"]List<String>否枚举值
-
dimPropMapping
dimPropMapping.routeCodeFromDimroute_v1String是跨源资产配置名称
dimPropMapping.sourceNameFormDimaccountString否原始属性名
dimPropMapping.targetNameFromDimaccountString是输出属性名
dimPropMapping.targetDescFromDim账户String否输出属性显示名
dimPropMapping.sqlExpressionFromProp-String否取值方式
dimPropMapping.targetTypeEnumStringString是输出属性类型[]
dimPropMapping.remark-String否备注
dimPropMapping.enumValues["user1","user2"]List<String>否枚举值

成功响应示例

{
"return_code": 0,
"return_message": "success"
}

3. 更新资产枚举值​

接口URL

/open/route/updateAssetEnumValues?token=xxx&projectId=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId102Integer是项目ID
routeId12Long是跨源配置ID
resourceTypeTAGenum是输出资产类型[TAG, EVENT_PROP, U_PROP, DIM_PROP]
resourceCodetag_1String是输出资产名

请求Body参数

["t_1","t_2"]

成功响应示例

{
"return_code": 0,
"return_message": "success"
}

4. 资产扫描-提交资产扫描任务​

接口URL

/open/route/searchTask/submit

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId102Integer是项目ID
isEventBoolean否跨源配置ID,是否为事件类型,默认为false。仅扫描事件时需要填写isEvent=true

请求Body参数

{
"routeConfig": {
"viewResourceRouteType":"event",//资产类型[tag,event,user,dim]
"modelTable":"",//数据源,==dataSource
"highOrWideEnum":"",//高宽表[high,wide]
"configTagNameColumn":"",//标签名称列
"configTagValueColumn":"",//标签值列
"businessEventNameSelectEnum":""//事件名取值方式[raw_column]
"configEventNameColumn":""//事件名称列
},
}
参数名示例值参数类型是否必填参数描述
viewResourceRouteTypetagEnum是资产类型 [tag, event, user, dim]
modelTablehive.ta.v_event_1String是数据源
highOrWideEnumhighEnum是高宽表[high,wide](仅tag类型支持high)
configTagNameColumn

tag_name_column

String

否

标签名称列 (viewResourceRouteType=tag时必填)
configTagValueColumntag_value_columnString否标签值列(viewResourceRouteType=tag时必填)
businessEventNameSelectEnumraw_columnEnum

否

事件名取值方式[raw_column](viewResourceRouteType=event是必传,固定传raw_column)

configEventNameColumn#event_nameString

否

事件名称列(viewResourceRouteType=event, isEvent=true时必填)
configEntityIdColumn#user_idString否主体列(viewResourceRouteType=dim时必填)

成功响应示例

{
"data": {
"taskId":"***"
},
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
参数名示例值参数类型参数描述
data-Object
data.taskIdString扫描任务唯一标识

5. 资产扫描-检查资产扫描状态​

接口URL

/open/route/searchTask/check

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId102Integer是项目ID
taskIdxxxString是扫描任务唯一标识

成功响应示例

{
"data": {
"state":"error" //running、success、error
"msg":"失败原因" // it is existing when status == error
},
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
参数名示例值参数类型参数描述
data-Object
data.statesuccessEnum扫描状态[running, success, error]
data.msg-String失败原因

6. 资产扫描-获取扫描结果​

接口URL

/open/route/searchTask/result

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId102Integer是项目ID
taskIdxxxString是扫描任务唯一标识

成功响应示例

//标签
{
//limit 500
"data": [
{
"sourceName":"",//原始标签名
"sourceSelectType":"",//原始标签类型
"targetName":"",//目标资产名
"targetSelectType":""//目标资产类型
}
],
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
//事件属性
{
//limit 500
"data": [
{
"sourceName":"",//原始事件属性名
"sourceSelectType":"",//原始事件属性类型
"targetName":"",//目标资产名
"targetSelectType":""//目标资产类型
}
],
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
//事件
{
//limit 500
"data": ["","",""],
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}

标签&事件属性

参数名示例值参数类型参数描述
data-Object
data.sourceNametag_1String原始标签名
data.sourceSelectTypeStringString原始标签类型
data.targetNametag_1String目标资产名
data.targetSelectTypeStringString目标资产类型

事件

参数名示例值参数类型参数描述
data-Array事件名

7. 获取跨源配置详情​

接口URL

/open/route/get

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId102Integer是项目ID
id10Integer是配置id

请求Body参数

{
"data": {
"assetsList": [
"platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor"
],
"checkStatus": "check_fail",//[un_checked, checking, check_success, check_fail]
"configDesc": {
"tag_value_column": "tag_value_tm",//标签值列
"business_part_date_type": "仅历史版本",//标签日期版本
"entity_column": "#varchar_id",//分析主体列
"tag_zone_offset": "8",//标签日期时区
"tag_entity_name": "用户",//分析主体
"part_date_type": "bigint",//
"part_date_format": "yyyyMMdd",
"tag_name_column": "cluster_name",
"part_date_column": "$tag_date",
"business_data_part_type": "单列日期分区"
"business_event_date_value_select": "expression"
"business_event_name_select": "raw_column"
"business_event_zone_offset_select": "raw_column"
"event_name_column": "event_name_rename"
"event_time_column": "date_parse(\"etime_var1\", '%Y-%m-%d %H:%i:%s.%f')"
"event_time_tz_column": "#zone_offset_raw"
"event_u_entity_column": "cross_aid",
"configDataUpdateTimeColumn": "",
"column_table_type": "eventProp",
"timestamp_join_format": "DATE_STR_YEAR",
"join_key_column": "#time",
"prop_name_column": "#luky_day"
},
"eventResourceMap": {},
"id": 24101,
"modelTable": "hive.ws_lingzhi_product.cross_history_tag2",
"modelTableDesc": "",
"remark": "跨源用户标签 文本 tag_20241219_2",
"resourceType": "tag",
"routeCode": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor",
"routeDesc": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor",
"wideTable": false,
"msgMap":[],
"assetsResourceList": [
{
"checkStatusEnum": "check_fail",//[un_checked, checking, check_success, check_fail]
"checkStatusMsg": "主体列类型与分析主体类型不一致",
"extConfig": {
"remark": "没有显示名的标签",
"valueZoneOffset": "8.0"
},
"id": 457963,
"routeResourceKey": "tag_value_tm",
"sourceTagType": "timestamp",
"sqlExpression":"",
"targetSelectType": "datetime",
"targetTagDesc": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor",
"targetTagName": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor"
"enums":[""], // 枚举值样例 limit 10
"lastUpdateEnumTime":"", // 最后更新时间
"enumSize" : 10, // 枚举个数,
}
],
"eventResourceMap": {
"eventPropMappings": [
{
"targetEventName": "activity_attend",
"targetEventPropName": "reward_amount"
}
],
"eventProps": [
{
"checkStatusEnum": "check_success",
"checkStatusMsg": "",
"extConfig": {
"isPublic": 1,
"remark":""
},
"routeResourceKey": "#account_id",
"sourceEventPropType": "varchar",
"sqlExpression":"",
"targetEventPropDesc": "",
"targetEventPropName": "account_id",
"targetSelectType": "string"
//add props
"enums":[""], // 枚举值样例 limit 10
"lastUpdateEnumTime":"", // 最后更新时间
"enumSize" : 10, // 枚举个数,
}
],
"events": [
{
"checkStatusEnum": "check_success",
"checkStatusMsg": "",
"sourceUserPropType": "timestamp",
"targetEventDesc": "跨源-参与活动",
"targetEventList": "",
"targetEventName": "activity_attend"
}
]
},
"userResourceList":[
{
"checkStatusEnum": "check_success"
"checkStatusMsg": ""
"routeResourceKey": "cross_aid"
"sqlExpression": "",
"sourceDimPropType":"",
"targetSelectType": "string"
"targetUserPropDesc": "账户ID_cross"
"targetUserPropName": "cross_aid"
}
],
"dimResourceMap": [
{
"checkStatusEnum": "check_success",
"checkStatusMsg": "",
"extConfig": {
"remark": ""
},
"routeResourceKey": "time",
"sqlExpression":"",
"targetSelectType": "datetime",
"targetUserPropDesc": "",
"targetUserPropName": "luky_day@time"
},
]
},
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
参数名示例值参数类型参数描述
id24101Integer配置ID
modelTablehive.ta.tag2String数据源
modelTableDesctag2_descString数据源描述
remarkremarkString备注
resourceTypetagString资产类型[tag, event]
routeCoderoute_codeString跨源资产配置名称
routeDescroute_decString跨源资产配置描述
wideTabletrueboolean是否宽表
msgMap[]List<String>配置检查错误清单
assetsList[]List<String>资产名清单
checkStatuscheck_successEnum检查状态[un_checked, checking, check_success, check_fail]
configDesc-Object配置详情
configDesc.part_date_typebigintString日期分区类型
configDesc.part_date_formatyyyyMMddString日期分区格式
configDesc.part_date_column$part_dateString日期分区列
resourceType=tag
configDesc.tag_value_columntag_value_tmString标签值列
configDesc.business_part_date_type仅历史版本String

标签日期版本

configDesc.entity_column#varchar_idString分析主体列(resourceType=tag)
configDesc.tag_zone_offset8String标签日期时区(resourceType=tag)
configDesc.tag_entity_name用户String分析主体(resourceType=tag)
configDesc.tag_name_columncluster_nameString标签日期列(resourceType=tag)
resourceType=event
configDesc.business_data_part_typecolumn_date_partString数据分区方式
configDesc.business_event_date_value_selectexpressionString事件时间取值方式
configDesc.business_event_name_selectraw_columnString事件名取值方式
configDesc.business_event_zone_offset_selectraw_columnString事件时区取值方式
configDesc.event_name_columnevent_name_renameString事件名列
configDesc.event_time_column-String事件时间列
configDesc.event_time_tz_column-String事件时区列
configDesc.event_u_entity_column-String事件用户实体ID列
configDesc.event_date_column-String事件日期列
configDesc.event_date_type-String事件日期数据类型
configDesc.event_date_format-String事件日期格式
resourceType=user
configDesc.configDataUpdateTimeColumn-String数据更新时间列
resourceType=dim
configDesc.column_table_type-String主体属性类型
configDesc.timestamp_join_format-String时间粒度
configDesc.join_key_column-String主体列
configDesc.prop_name_column-String主体属性
assetsResourceList-Array标签资产列表
assetsResourceList.id457963Integer标签映射id
assetsResourceList.routeResourceKeytag_nameString原始标签名
assetsResourceList.sourceTagTypeStringString原始标签类型
assetsResourceList.sqlExpression-String取值方式
assetsResourceList.targetSelectTypeNumberString输出标签类型
assetsResourceList.targetTagDesc标签String输出标签显示名
assetsResourceList.targetTagNametag_aString输出标签名
assetsResourceList.enums[1,2,3]Array枚举值样例
assetsResourceList.lastUpdateEnumTime2024-01-19String枚举值最后更新时间
assetsResourceList.enumSizeInteger枚举个数
assetsResourceList.checkStatusEnumcheck_failEnum检查状态[un_checked, checking, check_success, check_fail]
assetsResourceList.checkStatusMsg主体列类型与分析主体类型不一致String错误信息
assetsResourceList.extConfig-Object扩展信息
assetsResourceList.extConfig.remark-String备注
assetsResourceList.extConfig.valueZoneOffset8String

标签时区

eventResourceMap-Object事件资产清单
eventResourceMap.eventPropMappings-Array事件属性关系
eventResourceMap.eventPropMappings.targetEventNameloginString输出事件名
eventResourceMap.eventPropMappings.targetEventPropName#account_idString输出属性名
eventResourceMap.eventProps-Array事件属性列表
eventResourceMap.eventProps.routeResourceKey#account_idString原始属性名
eventResourceMap.eventProps.sourceEventPropTypevarcharString原始属性类型
eventResourceMap.eventProps.sqlExpression-String

取值方式

eventResourceMap.eventProps.targetEventPropNameaccount_idString输出属性名
eventResourceMap.eventProps.targetEventPropDesc-String输出属性显示名
eventResourceMap.eventProps.targetSelectTypestringString输出属性类型
eventResourceMap.eventProps.checkStatusEnumcheck_successEnum检查状态
eventResourceMap.eventProps.checkStatusMsg-String错误信息
eventResourceMap.eventProps.enums["1","2"]Array

枚举值样例

eventResourceMap.eventProps.lastUpdateEnumTime2023-01-12String最后更新时间
eventResourceMap.eventProps.enumSize1203Integer枚举个数
eventResourceMap.eventProps.extConfig-Object扩展信息
eventResourceMap.eventProps.extConfig.isPublic1Integer是否为公共属性(1:是,0:否)
eventResourceMap.eventProps.extConfig.remark-String备注
eventResourceMap.events-Array事件列表
eventResourceMap.events.targetEventDesc跨源-参与活动String

输出事件显示名

eventResourceMap.events.targetEventList-String输出事件列表
eventResourceMap.events.targetEventNameactivity_attendString输出事件名
eventResourceMap.events.checkStatusEnumcheck_successEnum检查状态
eventResourceMap.events.checkStatusMsg-String错误信息
userResourceList-Array实体资产列表
userResourceList.checkStatusEnumcheck_successEnum检查状态
userResourceList.checkStatusMsg-String错误信息
userResourceList.routeResourceKey#account_idString原始属性名
eventResourceMap.eventProps.sqlExpression-String

取值方式

userResourceList.sourceUserPropTypestringString原始属性类型
userResourceList.targetSelectTypestringString输出属性类型
userResourceList.targetUserPropDesc-String

输出属性显示名

userResourceList.targetUserPropNameaccount_idString输出属性名
dimResourceMap-Array维度资产列表
dimResourceMap.checkStatusEnumcheck_successEnum检查状态
dimResourceMap.checkStatusMsg-String错误信息
dimResourceMap.extConfig.remark-String备注
dimResourceMap.routeResourceKey#account_idString原始属性名
dimResourceMap.sqlExpression-String

取值方式

dimResourceMap.sourceDimPropType-String原始属性类型
dimResourceMap.targetSelectTypestringString输出属性类型
dimResourceMap.targetUserPropDesc-String

输出属性显示名

dimResourceMap.targetUserPropNameaccount_idString输出属性名

8. 批量检查路由配置​

接口URL

/open/route/checkBatch

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId102Integer是项目ID

请求Body参数

//跨源配置id列表
[1, 2]

成功响应示例

{
"return_code": 0,
"return_message": "success"
}

9. 配置增量添加资产​

接口URL

/open/route/uploadAsset

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId102Integer是项目ID

请求Body参数

{
// 路由编码,用于标识要更新的路由配置
"routeCode": "example_route_code",

// 标签映射列表
"tagMappings": [
{
// 跨源资产配置名称
"routeCodeFromTag": "example_route_code",
// 原始标签名
"routeResourceKey": "original_tag_name",
// 输出标签名
"targetTagName": "output_tag_name",
// 输出标签显示名
"targetTagDesc": "输出标签显示名称",
// 取值方式(SQL表达式)
"sqlExpression": "SELECT tag_value FROM tag_table WHERE condition = ?",
// 输出标签类型 [number,string,datetime,bool,array]
"routeSelectTypeEnum": "string",
// 备注
"extRemark": "标签映射备注信息",
// 值时区
"extValueZoneOffset": "+08:00",
// 枚举文件标记
"enumKey": "tag_enum_key",
// 枚举值列表(OpenAPI接口直接传入)
"enumValues": ["value1", "value2", "value3"]
}
],

// 事件映射列表
"eventMappings": [
{
// 跨源资产配置名称
"routeCodeFromEvent": "example_route_code",
// 输出事件名
"targetEventName": "output_event_name",
// 原始事件列表
"sourceEventList": "original_event_list",
// 输出事件显示名
"targetEventDesc": "输出事件显示名称",
// 备注
"remark": "事件映射备注信息"
}
],

// 属性映射列表
"propMappings": [
{
// 跨源资产配置名称
"routeCodeFromProp": "example_route_code",
// 原始属性名
"sourcePropName": "original_prop_name",
// 输出属性名
"targetPropName": "output_prop_name",
// 输出属性显示名
"targetPropDesc": "输出属性显示名称",
// 取值方式(SQL表达式)
"sqlExpressionFromProp": "property_expression",
// 输出属性类型
"targetPropTypeEnum": "string",
// 是否公共属性
"isPublic": true,
// 备注
"propConfigRemark": "属性映射备注信息",
// 枚举文件标记
"enumKey": "prop_enum_key",
// 枚举值列表(OpenAPI接口直接传入)
"enumValues": ["prop_value1", "prop_value2"]
}
],

// 事件属性映射列表
"eventPropMap": [
{
// 跨源资产配置名称
"routeCodeFromEventPropMap": "example_route_code",
// 输出事件名
"eventName": "output_event_name",
// 输出属性名
"propName": "output_prop_name"
}
],
"userPropMappings":[
{
"routeCodeFromUserProp":""//跨源资产配置名称
"sourcePropName":""//原始属性名
"targetPropName":""//输出属性名
"targetPropDesc":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetPropTypeEnum":""//输出属性类型
"propConfigRemark":""//备注
"enumValues":["",]//枚举文件标记
}
],
"dimPropMappings":[ //-> get.eventProps
{
"routeCodeFromDim":""//跨源资产配置名称
"sourceNameFromDim":""//原始属性名
"targetNameFromDim":""//输出属性名
"targetDescFromDim":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetTypeEnum":""//输出属性类型
"remark":""//备注
"enumValues":["",]//枚举文件标记
}
]
}
参数名示例值参数类型是否必填参数描述
routeCodeexample_route_codeString是路由编码,用于标识要更新的路由配置
tagMappings-Array是标签映射列表
tagMappings.routeCodeFromTagexample_route_codeString是跨源资产配置名称
tagMappings.routeResourceKeyoriginal_tag_nameString否原始标签名
tagMappings.targetTagNameoutput_tag_name

String

是输出标签名
tagMappings.targetTagDesc输出标签显示名称String否输出标签显示名
tagMappings.sqlExpressionSELECT tag_value FROM tag_table WHERE condition = ?

String

否取值方式(SQL表达式)
tagMappings.routeSelectTypeEnumstring

String

是输出标签类型,取值范围为[number,string,datetime,bool,array]
tagMappings.extRemark标签映射备注信息String否备注
tagMappings.extValueZoneOffset8String否值时区
tagMappings.enumKeytag_enum_keyString否枚举文件标记
tagMappings.enumValues["value1", "value2", "value3"]List<String>否枚举值列表(OpenAPI接口直接传入)
eventMappings-Array是事件映射列表
eventMappings.routeCodeFromEventexample_route_codeString是跨源资产配置名称
eventMappings.targetEventNameoutput_event_nameString是输出事件名
eventMappings.sourceEventListoriginal_event_listString否原始事件列表
eventMappings.targetEventDesc输出事件显示名称String否输出事件显示名
eventMappings.remark事件映射备注信息String否备注
propMappings-Array是属性映射列表
propMappings.routeCodeFromPropexample_route_codeString是跨源资产配置名称
propMappings.sourcePropNameoriginal_prop_nameString否原始属性名
propMappings.targetPropNameoutput_prop_nameString是输出属性名
propMappings.targetPropDesc输出属性显示名称String否输出属性显示名
propMappings.sqlExpressionFromPropproperty_expressionString否取值方式(SQL表达式)
propMappings.targetPropTypeEnumstringString是输出属性类型
propMappings.isPublictrueBoolean否是否公共属性
propMappings.propConfigRemark属性映射备注信息String否备注
propMappings.enumKeyprop_enum_keyString否枚举文件标记
propMappings.enumValues["prop_value1", "prop_value2"]List<String>否枚举值列表(OpenAPI接口直接传入)
eventPropMap-Array是事件属性映射列表
eventPropMap.routeCodeFromEventPropMapexample_route_codeString是跨源资产配置名称
eventPropMap.eventNameoutput_event_nameString是输出事件名
eventPropMap.propNameoutput_prop_nameString是输出属性名
userPropMappings
userPropMappings.routeCodeFromUserProproute_v1String是跨源资产配置名称
userPropMappings.sourcePropNameaccountString否原始属性名
userPropMappings.targetPropNameaccountString是输出属性名
userPropMappings.targetPropDesc账户String否输出属性显示名
userPropMappings.sqlExpressionFromProp-String否取值方式
userPropMappings.targetPropTypeEnumStringString是输出属性类型[]
userPropMappings.propConfigRemark-String否备注
userPropMappings.enumValues["user1","user2"]List<String>否枚举值
dimPropMappings
dimPropMappings.routeCodeFromDimroute_v1String是跨源资产配置名称
dimPropMappings.sourceNameFromDimaccountString否原始属性名
dimPropMappings.targetNameFromDimaccountString是输出属性名
dimPropMappings.targetDescFromDim账户String否输出属性显示名
dimPropMappings.sqlExpressionFromProp-String否取值方式
dimPropMappings.targetTypeEnumStringString是输出属性类型[]
dimPropMappings.remark-String否备注
dimPropMappings.enumValues["user1","user2"]List<String>否枚举值

成功响应示例

{
"data": {
"state": "success",
"msg": []
},
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}

10. 下载枚举值文件​

说明:允许同时添加父子属性,不支持子属性或父属性单独添加

PATH:/open/route/downloadEnumFile

Method: GET

requestParam:

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId102Integer是项目ID
routeCodeexample_route_codeString是路由编码,用于标识要更新的路由配置

resourceType

TAGenum是

输出资产类型[TAG, EVENT_PROP, U_PROP, DIM_PROP]

resourceCode

tag_1

String

是

输出资产名

resopnse:file

这篇文档对你有帮助吗?