运维平台API接口文档

简介

后台API接口

HOST:192.168.10.33:8888

联系人:

Version:1.0

接口路径:/v2/api-docs?group=项目接口

# 应用服务管理

# 应用服务删除

接口描述:

接口地址:/cfgApp/del/{ids}

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
ids ids path true string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 查询全部应用服务

接口描述:

接口地址:/cfgApp/find

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
401 Unauthorized
403 Forbidden
404 Not Found

# 应用服务分页列表

接口描述:

接口地址:/cfgApp/page

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"pageNumber": 0,
	"pageSize": 0,
	"paramVo": {
		"parameters": [
			{
				"name": "",
				"op": "",
				"value": {}
			}
		],
		"sorts": [
			{
				"name": "",
				"type": ""
			}
		],
		"vo": {}
	}
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
pageVo pageVo body true PageVo PageVo

schema属性说明

PageVo

参数名称 参数说明 in 是否必须 数据类型 schema
pageNumber body false integer(int32)
pageSize body false integer(int32)
paramVo body false ParamVo«object» ParamVo«object»

ParamVo«object»

参数名称 参数说明 in 是否必须 数据类型 schema
parameters body false array QueryParamEntity
sorts body false array QuerySortEntity
vo body false object

QueryParamEntity

参数名称 参数说明 in 是否必须 数据类型 schema
name body false string
op body false string
value body false object

QuerySortEntity

参数名称 参数说明 in 是否必须 数据类型 schema
name body false string
type body false string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 应用服务编辑

接口描述:

接口地址:/cfgApp/save

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"appCode": "",
	"appName": "",
	"appNo": 0,
	"baseUrl": "",
	"delState": "",
	"enableSecret": "",
	"enabled": "",
	"id": 0,
	"idleUrl": "",
	"imgBgc": "",
	"imgFileId": "",
	"indexUrl": "",
	"portalShow": "",
	"secretKey": ""
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
managerCfgAppDto 应用服务注册信息 body true manager_cfg_app对象 manager_cfg_app对象

schema属性说明

manager_cfg_app对象

参数名称 参数说明 in 是否必须 数据类型 schema
appCode 应用编码 body false string
appName 应用名称 body false string
appNo 应用排序 body false integer(int32)
baseUrl 应用的baseUrl body false string
delState 状态 body false string
enableSecret 是否启用该应用的加密,1为启用,0为不启用 body false string
enabled 应用的状态,是否启用 body false string
id 主键 body false integer(int64)
idleUrl 应用的心跳地址 body false string
imgBgc 应用图标背景色 body false string
imgFileId 应用图标文件ID body false string
indexUrl 应用的访问地址 body false string
portalShow 应用在门户是否显示 body false string
secretKey 应用的的密钥 body false string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 应用服务订购

# 根据应用ID查询订购信息

接口描述:

接口地址:/cfgAppOrder/findAllByAppId/{appId}

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
appId appId path true integer

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 根据用户id查询订购信息

接口描述:

接口地址:/cfgAppOrder/findAppbyUserId/{id}

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
id id path true integer

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 应用服务订购编辑

接口描述:

接口地址:/cfgAppOrder/save

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"appId": 0,
	"expireTime": 0,
	"orgId": []
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
appOrderVo appOrderVo body true AppOrderVo AppOrderVo

schema属性说明

AppOrderVo

参数名称 参数说明 in 是否必须 数据类型 schema
appId 应用ID body false integer(int64)
expireTime 到期时间 body false integer(int64)
orgId 机构ID body false array

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 用户管理

# 用户分配角色

接口描述:

接口地址:/user/assignRole

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"roleIds": [],
	"userId": 0
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
relationVo 运维平台用户角色关联信息 body true UserRoleRelationVo UserRoleRelationVo

schema属性说明

UserRoleRelationVo

参数名称 参数说明 in 是否必须 数据类型 schema
roleIds 角色主键集合 body false array
userId 用户主键 body false integer(int64)

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 用户信息删除

接口描述:

接口地址:/user/del/{id}

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
id id path true integer

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
401 Unauthorized
403 Forbidden
404 Not Found

# 用户信息编辑

接口描述:

接口地址:/user/edit

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"account": "",
	"createTime": 0,
	"email": "",
	"id": 0,
	"name": "",
	"password": "",
	"phone": "",
	"state": ""
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
userDto 运维平台用户信息 body true manager_user对象 manager_user对象

schema属性说明

manager_user对象

参数名称 参数说明 in 是否必须 数据类型 schema
account 账号 body true string
createTime 创建时间 body false integer(int64)
email 邮箱 body true string
id 主键 body false integer(int64)
name 姓名 body true string
password 密码 body true string
phone 联系方式 body true string
state 状态 body false string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 查询用户所属角色

接口描述:

接口地址:/user/findByUserId/{userId}

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
userId userId path true integer

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
401 Unauthorized
403 Forbidden
404 Not Found

# 用户信息列表

接口描述:

接口地址:/user/page

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"pageNumber": 0,
	"pageSize": 0,
	"paramVo": {
		"parameters": [
			{
				"name": "",
				"op": "",
				"value": {}
			}
		],
		"sorts": [
			{
				"name": "",
				"type": ""
			}
		],
		"vo": {}
	}
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
pageVo pageVo body true PageVo PageVo

schema属性说明

PageVo

参数名称 参数说明 in 是否必须 数据类型 schema
pageNumber body false integer(int32)
pageSize body false integer(int32)
paramVo body false ParamVo«object» ParamVo«object»

ParamVo«object»

参数名称 参数说明 in 是否必须 数据类型 schema
parameters body false array QueryParamEntity
sorts body false array QuerySortEntity
vo body false object

QueryParamEntity

参数名称 参数说明 in 是否必须 数据类型 schema
name body false string
op body false string
value body false object

QuerySortEntity

参数名称 参数说明 in 是否必须 数据类型 schema
name body false string
type body false string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 登录管理

# 用户登录

接口描述:

接口地址:/login

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"account": "",
	"authcode": "",
	"password": ""
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
creationTime query false integer
id query false string
lastAccessedTime query false integer
loginVo loginVo body true LoginVo LoginVo
maxInactiveInterval query false integer
new query false boolean
servletContext.classLoader query false ref
servletContext.contextPath query false string
servletContext.defaultSessionTrackingModes 枚举类型,可用值:COOKIE,URL,SSL query false array string
servletContext.effectiveMajorVersion query false integer
servletContext.effectiveMinorVersion query false integer
servletContext.effectiveSessionTrackingModes 枚举类型,可用值:COOKIE,URL,SSL query false array string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].buffer query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].defaultContentType query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].deferredSyntaxAllowedAsLiteral query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].elIgnored query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].errorOnUndeclaredNamespace query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].includeCodas query false array string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].includePreludes query false array string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].isXml query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].pageEncoding query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].scriptingInvalid query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].trimDirectiveWhitespaces query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].urlPatterns query false array string
servletContext.jspConfigDescriptor.taglibs[0].taglibLocation query false string
servletContext.jspConfigDescriptor.taglibs[0].taglibURI query false string
servletContext.majorVersion query false integer
servletContext.minorVersion query false integer
servletContext.requestCharacterEncoding query false string
servletContext.responseCharacterEncoding query false string
servletContext.serverInfo query false string
servletContext.servletContextName query false string
servletContext.sessionCookieConfig.comment query false string
servletContext.sessionCookieConfig.domain query false string
servletContext.sessionCookieConfig.httpOnly query false boolean
servletContext.sessionCookieConfig.maxAge query false integer
servletContext.sessionCookieConfig.name query false string
servletContext.sessionCookieConfig.path query false string
servletContext.sessionCookieConfig.secure query false boolean
servletContext.sessionTimeout query false integer
servletContext.virtualServerName query false string
valueNames query false array string

schema属性说明

LoginVo

参数名称 参数说明 in 是否必须 数据类型 schema
account body false string
authcode body false string
password body false string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 退出

接口描述:

接口地址:/quit

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
creationTime query false integer
id query false string
lastAccessedTime query false integer
maxInactiveInterval query false integer
new query false boolean
servletContext.classLoader query false ref
servletContext.contextPath query false string
servletContext.defaultSessionTrackingModes 枚举类型,可用值:COOKIE,URL,SSL query false array string
servletContext.effectiveMajorVersion query false integer
servletContext.effectiveMinorVersion query false integer
servletContext.effectiveSessionTrackingModes 枚举类型,可用值:COOKIE,URL,SSL query false array string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].buffer query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].defaultContentType query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].deferredSyntaxAllowedAsLiteral query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].elIgnored query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].errorOnUndeclaredNamespace query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].includeCodas query false array string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].includePreludes query false array string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].isXml query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].pageEncoding query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].scriptingInvalid query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].trimDirectiveWhitespaces query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].urlPatterns query false array string
servletContext.jspConfigDescriptor.taglibs[0].taglibLocation query false string
servletContext.jspConfigDescriptor.taglibs[0].taglibURI query false string
servletContext.majorVersion query false integer
servletContext.minorVersion query false integer
servletContext.requestCharacterEncoding query false string
servletContext.responseCharacterEncoding query false string
servletContext.serverInfo query false string
servletContext.servletContextName query false string
servletContext.sessionCookieConfig.comment query false string
servletContext.sessionCookieConfig.domain query false string
servletContext.sessionCookieConfig.httpOnly query false boolean
servletContext.sessionCookieConfig.maxAge query false integer
servletContext.sessionCookieConfig.name query false string
servletContext.sessionCookieConfig.path query false string
servletContext.sessionCookieConfig.secure query false boolean
servletContext.sessionTimeout query false integer
servletContext.virtualServerName query false string
valueNames query false array string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
401 Unauthorized
403 Forbidden
404 Not Found

# 获取验证码

接口描述:

接口地址:/toAuthcode

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
creationTime query false integer
id query false string
lastAccessedTime query false integer
maxInactiveInterval query false integer
new query false boolean
servletContext.classLoader query false ref
servletContext.contextPath query false string
servletContext.defaultSessionTrackingModes 枚举类型,可用值:COOKIE,URL,SSL query false array string
servletContext.effectiveMajorVersion query false integer
servletContext.effectiveMinorVersion query false integer
servletContext.effectiveSessionTrackingModes 枚举类型,可用值:COOKIE,URL,SSL query false array string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].buffer query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].defaultContentType query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].deferredSyntaxAllowedAsLiteral query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].elIgnored query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].errorOnUndeclaredNamespace query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].includeCodas query false array string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].includePreludes query false array string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].isXml query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].pageEncoding query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].scriptingInvalid query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].trimDirectiveWhitespaces query false string
servletContext.jspConfigDescriptor.jspPropertyGroups[0].urlPatterns query false array string
servletContext.jspConfigDescriptor.taglibs[0].taglibLocation query false string
servletContext.jspConfigDescriptor.taglibs[0].taglibURI query false string
servletContext.majorVersion query false integer
servletContext.minorVersion query false integer
servletContext.requestCharacterEncoding query false string
servletContext.responseCharacterEncoding query false string
servletContext.serverInfo query false string
servletContext.servletContextName query false string
servletContext.sessionCookieConfig.comment query false string
servletContext.sessionCookieConfig.domain query false string
servletContext.sessionCookieConfig.httpOnly query false boolean
servletContext.sessionCookieConfig.maxAge query false integer
servletContext.sessionCookieConfig.name query false string
servletContext.sessionCookieConfig.path query false string
servletContext.sessionCookieConfig.secure query false boolean
servletContext.sessionTimeout query false integer
servletContext.virtualServerName query false string
valueNames query false array string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
401 Unauthorized
403 Forbidden
404 Not Found

# 能力服务接口管理

# 能力提供接口删除

接口描述:

接口地址:/ifs/del/{ids}

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
ids ids path true string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 能力提供接口列表

接口描述:

接口地址:/ifs/page

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"pageNumber": 0,
	"pageSize": 0,
	"paramVo": {
		"parameters": [
			{
				"name": "",
				"op": "",
				"value": {}
			}
		],
		"sorts": [
			{
				"name": "",
				"type": ""
			}
		],
		"vo": {}
	}
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
pageVo pageVo body true PageVo PageVo

schema属性说明

PageVo

参数名称 参数说明 in 是否必须 数据类型 schema
pageNumber body false integer(int32)
pageSize body false integer(int32)
paramVo body false ParamVo«object» ParamVo«object»

ParamVo«object»

参数名称 参数说明 in 是否必须 数据类型 schema
parameters body false array QueryParamEntity
sorts body false array QuerySortEntity
vo body false object

QueryParamEntity

参数名称 参数说明 in 是否必须 数据类型 schema
name body false string
op body false string
value body false object

QuerySortEntity

参数名称 参数说明 in 是否必须 数据类型 schema
name body false string
type body false string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 能力提供接口保存

接口描述:

接口地址:/ifs/save

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"appCode": "",
	"appName": "",
	"description": "",
	"dto": {
		"appCode": "",
		"appName": "",
		"description": "",
		"id": 0,
		"method": "",
		"name": "",
		"paramType": "",
		"reqDesc": "",
		"resDesc": "",
		"url": ""
	},
	"id": 0,
	"name": "",
	"paramType": "",
	"params": [
		{
			"dto": {
				"id": 0,
				"ifsId": 0,
				"musted": "",
				"paramDesc": "",
				"paramName": "",
				"paramType": "",
				"sourceFlag": ""
			},
			"id": 0,
			"ifsId": 0,
			"musted": "",
			"paramDesc": "",
			"paramName": "",
			"paramType": "",
			"sourceFlag": ""
		}
	],
	"reqDesc": "",
	"resDesc": "",
	"roles": [],
	"url": ""
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
ifsVo ifsVo body true IfsVo IfsVo

schema属性说明

IfsVo

参数名称 参数说明 in 是否必须 数据类型 schema
appCode body false string
appName body false string
description body false string
dto body false manager_cfg_ifs对象 manager_cfg_ifs对象
id body false integer(int64)
name body false string
paramType body false string
params body false array RequestParams
reqDesc body false string
resDesc body false string
roles body false array
url body false string

manager_cfg_ifs对象

参数名称 参数说明 in 是否必须 数据类型 schema
appCode 所属应用Code body false string
appName 所属应用名称 body false string
description 该接口说明 body false string
id 主键 body false integer(int64)
method 应用提供的请求方法 body false string
name 接口名称 body false string
paramType 请求参数类型 body false string
reqDesc 请求参数 body false string
resDesc 返回参数 body false string
url 提供能力服务的URL body false string

RequestParams

参数名称 参数说明 in 是否必须 数据类型 schema
dto body false ManagerCfgIfsParamsDto ManagerCfgIfsParamsDto
id body false integer(int64)
ifsId body false integer(int64)
musted body false string
paramDesc body false string
paramName body false string
paramType body false string
sourceFlag body false string

ManagerCfgIfsParamsDto

参数名称 参数说明 in 是否必须 数据类型 schema
id body false integer(int64)
ifsId body false integer(int64)
musted body false string
paramDesc body false string
paramName body false string
paramType body false string
sourceFlag body false string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 根据AppCode查询能力提供接口信息

接口描述:

接口地址:/ifs/{appCode}

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
appCode appCode path true string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 根据ID查询能力提供接口信息

接口描述:

接口地址:/ifs/{id}

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
id id path true integer

响应示例:

{
	"data": {
		"appCode": "",
		"appName": "",
		"description": "",
		"dto": {
			"appCode": "",
			"appName": "",
			"description": "",
			"id": 0,
			"method": "",
			"name": "",
			"paramType": "",
			"reqDesc": "",
			"resDesc": "",
			"url": ""
		},
		"id": 0,
		"name": "",
		"paramType": "",
		"params": [
			{
				"dto": {
					"id": 0,
					"ifsId": 0,
					"musted": "",
					"paramDesc": "",
					"paramName": "",
					"paramType": "",
					"sourceFlag": ""
				},
				"id": 0,
				"ifsId": 0,
				"musted": "",
				"paramDesc": "",
				"paramName": "",
				"paramType": "",
				"sourceFlag": ""
			}
		],
		"reqDesc": "",
		"resDesc": "",
		"roles": [],
		"url": ""
	},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data IfsVo IfsVo
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

IfsVo

参数名称 参数说明 类型 schema
appCode string
appName string
description string
dto manager_cfg_ifs对象 manager_cfg_ifs对象
id integer(int64)
name string
paramType string
params array RequestParams
reqDesc string
resDesc string
roles array
url string

manager_cfg_ifs对象

参数名称 参数说明 类型 schema
appCode 所属应用Code string
appName 所属应用名称 string
description 该接口说明 string
id 主键 integer(int64)
method 应用提供的请求方法 string
name 接口名称 string
paramType 请求参数类型 string
reqDesc 请求参数 string
resDesc 返回参数 string
url 提供能力服务的URL string

RequestParams

参数名称 参数说明 类型 schema
dto ManagerCfgIfsParamsDto ManagerCfgIfsParamsDto
id integer(int64)
ifsId integer(int64)
musted string
paramDesc string
paramName string
paramType string
sourceFlag string

ManagerCfgIfsParamsDto

参数名称 参数说明 类型 schema
id integer(int64)
ifsId integer(int64)
musted string
paramDesc string
paramName string
paramType string
sourceFlag string

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result«IfsVo»
401 Unauthorized
403 Forbidden
404 Not Found

# 角色管理

# 角色分配资源

接口描述:

接口地址:/role/assignResource

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"resourceIds": [],
	"roleId": 0
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
relationVo 运维平台角色资源关联信息 body true RoleResourceRelationVo RoleResourceRelationVo

schema属性说明

RoleResourceRelationVo

参数名称 参数说明 in 是否必须 数据类型 schema
resourceIds 资源主键集合 body false array
roleId 角色主键 body false integer(int64)

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 角色信息删除

接口描述:

接口地址:/role/del/{id}

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
id id path true integer

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
401 Unauthorized
403 Forbidden
404 Not Found

# 角色信息编辑

接口描述:

接口地址:/role/edit

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"createBy": "",
	"createId": 0,
	"createTime": 0,
	"enableState": "",
	"id": 0,
	"name": "",
	"roleDesc": ""
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
roleDto 运维平台角色信息 body true manager_role对象 manager_role对象

schema属性说明

manager_role对象

参数名称 参数说明 in 是否必须 数据类型 schema
createBy 创建人 body false string
createId 创建人id body false integer(int64)
createTime 创建时间 body false integer(int64)
enableState 是否启用 body false string
id 主键 body false integer(int64)
name 角色名称 body true string
roleDesc 备注 body false string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 角色信息集合

接口描述:

接口地址:/role/find

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
401 Unauthorized
403 Forbidden
404 Not Found

# 查询角色所属资源

接口描述:

接口地址:/role/findResourceByRoleId/{roleId}

请求方式GET

consumes:``

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
roleId roleId path true integer

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
401 Unauthorized
403 Forbidden
404 Not Found

# 角色信息列表

接口描述:

接口地址:/role/page

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"pageNumber": 0,
	"pageSize": 0,
	"paramVo": {
		"parameters": [
			{
				"name": "",
				"op": "",
				"value": {}
			}
		],
		"sorts": [
			{
				"name": "",
				"type": ""
			}
		],
		"vo": {}
	}
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
pageVo pageVo body true PageVo PageVo

schema属性说明

PageVo

参数名称 参数说明 in 是否必须 数据类型 schema
pageNumber body false integer(int32)
pageSize body false integer(int32)
paramVo body false ParamVo«object» ParamVo«object»

ParamVo«object»

参数名称 参数说明 in 是否必须 数据类型 schema
parameters body false array QueryParamEntity
sorts body false array QuerySortEntity
vo body false object

QueryParamEntity

参数名称 参数说明 in 是否必须 数据类型 schema
name body false string
op body false string
value body false object

QuerySortEntity

参数名称 参数说明 in 是否必须 数据类型 schema
name body false string
type body false string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 资源管理

# 资源信息删除

接口描述:

接口地址:/resource/del/{id}

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
id id path true integer

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 资源信息编辑

接口描述:

接口地址:/resource/edit

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"backUrl": "",
	"frontUrl": "",
	"id": 0,
	"name": "",
	"parentId": 0,
	"type": ""
}

请求参数

参数名称 参数说明 in 是否必须 数据类型 schema
resourceDto 运维平台资源信息 body true manager_resource对象 manager_resource对象

schema属性说明

manager_resource对象

参数名称 参数说明 in 是否必须 数据类型 schema
backUrl 服务端路由 body true string
frontUrl 前端路由 body true string
id 主键 body false integer(int64)
name 资源名称 body true string
parentId 父资源id body true integer(int64)
type 资源类型 body true string

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

# 资源集合

接口描述:

接口地址:/resource/find

请求方式GET

consumes:``

produces:["*/*"]

请求参数: 暂无

响应示例:

{
	"data": {},
	"e": {
		"cause": {
			"cause": {
				"cause": {},
				"localizedMessage": "",
				"message": "",
				"stackTrace": [
					{
						"className": "",
						"fileName": "",
						"lineNumber": 0,
						"methodName": "",
						"nativeMethod": true
					}
				],
				"suppressed": [
					{}
				]
			},
			"localizedMessage": "",
			"message": "",
			"stackTrace": [
				{
					"className": "",
					"fileName": "",
					"lineNumber": 0,
					"methodName": "",
					"nativeMethod": true
				}
			],
			"suppressed": [
				{}
			]
		},
		"localizedMessage": "",
		"message": "",
		"stackTrace": [
			{
				"className": "",
				"fileName": "",
				"lineNumber": 0,
				"methodName": "",
				"nativeMethod": true
			}
		],
		"suppressed": [
			{}
		]
	},
	"message": "",
	"retCode": 0
}

响应参数:

参数名称 参数说明 类型 schema
data object
e Exception Exception
message string
retCode integer(int32) integer(int32)

schema属性说明

Exception

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

Throwable

参数名称 参数说明 类型 schema
cause Throwable Throwable
localizedMessage string
message string
stackTrace array StackTraceElement
suppressed array Throwable

StackTraceElement

参数名称 参数说明 类型 schema
className string
fileName string
lineNumber integer(int32)
methodName string
nativeMethod boolean

响应状态:

状态码 说明 schema
200 OK Result
401 Unauthorized
403 Forbidden
404 Not Found