开发者中心

# 开发指南

# 开发前必读

  1. 请求协议：生产环境的接口需使用HTTPS协议。
  2. 请求格式：JSON数据格式,UTF8编码。
  3. 返回结果/参数说明：开发者需根据code是否为0判断是否调用成功（code意义请见Api规约）。而msg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据。

# 接入指南

# 心跳推送

# 接口URL

运维总控（公有云时）：

  • 开发环境： http://192.169.0.220:5001/sevApi/healthy/healthyItem?token=

  • 测试环境： http://hhhmis.f3322.net:30010/sevApi/healthy/healthyItem?token=

  • 生产环境： https://m.jianxiecloud.com/sevApi/healthy/healthyItem?token=

    token为应用凭证

运维分控（私有云时）：

  • 生产环境： http://{运维分控地址}:{运维分控端口}/healthyItem

注意：运维分控端口只能内网访问

# 入参说明

请求方式：POST/JSON

请求参数 参数名 参数类型 说明
appId 应用id String 必填
appName 应用名称 String 首次登记有效
systemCode 应用编码 String
servicesId 服务id String 必填
servicesName 服务名称 String 首次登记有效
ip 实例IP String 必填
port 实例port String 必填
serviceProtected 实例保护的 String 必填。1：不保护，2：保护
# 入参格式示例
{
"appId":"zhujiangzulin111",
"appName":"珠江租赁",
"systemCode":"PEARL",
"servicesId":"mainServer",
"servicesName":"主服务",
"ip":"192.169.0.49",
"port":"8097",
"serviceProtected":2
}

# 出参说明

返回参数 参数名 参数类型 说明
code 状态码 int
status int
data 业务数据 Object
msg 返回说明 String
# 出参格式示例
{
    "code": 0,
    "status": 0,
    "data": true,
    "msg": "操作成功"
}

# 预警推送

# 接口Url

  • 开发环境： http://192.169.0.220:5001/sevApi/wraning/pushwraning?token=

  • 测试环境： http://hhhmis.f3322.net:30010/sevApi/wraning/pushwraning?token=

  • 生产环境： https://m.jianxiecloud.com/sevApi/wraning/pushwraning?token=

    token为应用凭证

# 入参说明

请求参数 参数名 参数类型 说明
appId 应用ID String 必填
serviceId 服务Id String
sources 推送消息数据源 Object 由用户自定义
properties 推送配置 Object 附表格
# properties - 附表格
请求参数 参数名 参数类型 说明
strategyId 推送配置策略主键 int 必填
templateId 推送配置模板主键 int 必填
# 入参格式示例
{
	"sources": {	

	},
	"properties": {	
		"strategyId":"2",
		"templateId":"2"	
	}
}

# 出参说明

返回参数 参数名 参数类型 说明
code 状态码 int
status int
data 业务数据 Object
msg 返回说明 String
# 出参格式示例
{
    "code": 0,
    "status": 0,
    "data": true,
    "msg": "操作成功"
}

# 登录日志采集

# 接口Url

  • 开发环境： http://192.169.0.220:5001/sevApi/appLogs/sendLoginLogs?token=
  • 测试环境： http://hhhmis.f3322.net:30010/sevApi/appLogs/sendLoginLogs?token=
  • 生产环境： https://m.jianxiecloud.com/sevApi/appLogs/sendLoginLogs?token=

# 入参说明

请求方式：POST/JSON

请求参数 参数名 参数类型 说明
data 信息对象 Object[] json数组

data数组内容

请求参数 参数名 参数类型 说明
appId 应用id String
id 日志主键 String
loginTime 登录时间 String
loginName 操作人账号 String
username 操作人名称 String
ip 操作人ip String
department 所属部门 String
departmentId 所属部门主键 String
token 登录凭证 String
loginRresult 登录出参 String
successOrFail 登录结果 String
# 入参格式示例
{
"data":[{
"appId":"1",    
"id":"1",   
"ip":"127.0.0.1",   
"loginTime":"2021-08-19 14:34:47",  
"loginName":"testysb1",
"username":"ysb",   
"department":"搬砖部1",    
"departmentId":"dep11", 
"token":"testtoken",    
"loginRresult":"null",  
"successOrFail":"ok"    
},{
"appId":"2",    
"id":"2",   
"ip":"127.0.0.1",   
"loginTime":"2021-08-19 14:34:47",  
"loginName":"testys2",
"username":"ysb改",  
"department":"搬砖部2",    
"departmentId":"dep22", 
"token":"testtoken",    
"loginRresult":"null",  
"successOrFail":"ok"    
}]
}

# 出参说明

返回参数 参数名 参数类型 说明
code 状态码 int
status int
data 业务数据 Object
msg 返回说明 String
# 出参格式示例
{
    "code": 0,
    "status": 0,
    "data": null,
    "msg": "操作成功"
}

# 执行日志采集

# 接口Url

  • 开发环境： http://192.169.0.220:5001/sevApi/appLogs/sendRunLogs?token=
  • 测试环境： http://hhhmis.f3322.net:30010/sevApi/appLogs/sendRunLogs?token=
  • 生产环境： https://m.jianxiecloud.com/sevApi/appLogs/sendRunLogs?token=

# 入参说明

请求方式：POST/JSON

请求参数 参数名 参数类型 说明
data 信息对象 Object[] json数组

data数组内容

请求参数 参数名 参数类型 说明
appId 应用id String
id 日志主键 String
logType 日志类型 Byte 0:异常日志，1:正常日志,2:运行日志,3:登录日志,4接口日志
operateTime 操作时间 String
operateInfo 操作内容 String
logSrc 业务方法 String
timeSpend 耗时ms Long
serviceName 服务名称 String
loginName 操作人账号 String
username 操作人名称 String
ip 操作人ip String
operateName 受理名称 String
msg 结果信息 String
# 入参格式示例
{
"data":[{
"appId":"31",   
"id":"31",  
"logType":0,
"operateTime":"2021-08-19 14:34:47",
"operateInfo":"operateContext1",    
"logSrc":"sendRunLogs1",    
"timeSpend":1000, 
"serviceName":"testservice1",   
"loginName":"testysb1", 
"username":"ysb改",  
"ip":"127.0.0.1",   
"operateName":"operateName1",   
"msg":"正常运行"
},{
"appId":"32",   
"id":"32",  
"logType":"1",
"operateTime":"2021-08-19 14:34:47",
"operateInfo":"operateContext2",    
"logSrc":"sendRunLogs2",    
"timeSpend":1000, 
"serviceName":"testservice2",   
"loginName":"testysb2", 
"username":"ysb",   
"ip":"127.0.0.1",   
"operateName":"operateName2",   
"msg":"正常运行"
}]
}

# 出参说明

返回参数 参数名 参数类型 说明
code 状态码 int
status int
data 业务数据 Object
msg 返回说明 String
# 出参格式示例
{
    "code": 0,
    "status": 0,
    "data": null,
    "msg": "操作成功"
}

# 错误日志采集

# 接口Url

  • 开发环境： http://192.169.0.220:5001/sevApi/appLogs/sendErrorLogs?token=
  • 测试环境： http://hhhmis.f3322.net:30010/sevApi/appLogs/sendErrorLogs?token=
  • 生产环境： https://m.jianxiecloud.com/sevApi/appLogs/sendErrorLogs?token=

# 入参说明

请求方式：POST/JSON

请求参数 参数名 参数类型 说明
data 信息对象 Object[] json数组

data数组内容

请求参数 参数名 参数类型 说明
appId 应用id String
id 日志主键 String
method 业务方法 String
errorLog 异常内容 String
errorData 异常入参 String
createTime 创建时间 String
loginName 操作人账号 String
username 操作人名称 String
serviceName 服务名称 String
errorLine 错误行 Long
# 入参格式示例
{
"data":[{
"appId":"21",   
"id":"21",  
"method":"sendErrorLogs1",    
"errorLog":"ExceptionContext1", 
"errorData":"ExceptionParam:para",  
"createTime":"2021-08-19 14:34:47", 
"loginName":"testysb1", 
"username":"ysb",   
"serviceName":"testservice1",   
"errorLine":1
},{
"appId":"22",   
"id":"22",  
"method":"sendErrorLogs2",    
"errorLog":"ExceptionContext2", 
"errorData":"ExceptionParam:para",  
"createTime":"2021-08-19 14:34:47", 
"loginName":"testysb12",    
"username":"ysb",   
"serviceName":"testservice2",   
"errorLine":2 
}]
}

# 出参说明

返回参数 参数名 参数类型 说明
code 状态码 int
status int
data 业务数据 Object
msg 返回说明 String
# 出参格式示例
{
    "code": 0,
    "status": 0,
    "data": null,
    "msg": "操作成功"
}