参数配置

ConfigurationRestfulApi 类

接口地址:/api/rest_j/v1/configuration/addKeyForEngine

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

添加KeyForEngine

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
engineType engineType query false string
keyJson keyJson query false string
token token query false string
version version query false string

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

接口地址:/api/rest_j/v1/configuration/createFirstCategory

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

新增应用类型标签

请求示例:

1. {
2. "categoryName": “”,
3. "description": ""
4. }

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
categoryName 引用类型标签名称 String false String
description 描述 String false String

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "method": "/api/configuration/createFirstCategory",
3. "status": 0,
4. "message": "OK",
5. "data": {}
6. }

接口地址:/api/rest_j/v1/configuration/createSecondCategory

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

添加参数配置

请求示例:

1. {
2. categoryId: ,
3. description: "",
4. engineType: "",
5. version: ""
6. }

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
categoryId 参数配置Id String true String
description 描述 String true String
engineType 引擎类型 String true String
version 版本号 String true String

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "method": "/api/configuration/createSecondCategory",
3. "status": 0,
4. "message": "OK",
5. "data": {}
6. }

接口地址:/api/rest_j/v1/configuration/deleteCategory

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

删除参数配置

请求示例:

1. {
2. categoryId:
3. }

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
categoryId 参数配置Id String true String

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "method": "/api/configuration/deleteCategory",
3. "status": 0,
4. "message": "OK",
5. "data": {}
6. }

接口地址:/api/rest_j/v1/configuration/engineType

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取引擎类型列表

请求参数:

暂无

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "method": "/api/configuration/engineType",
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "engineType": []
7. }
8. }

接口地址:/api/rest_j/v1/configuration/getCategory

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

参数配置中应用类型标签

请求参数:

暂无

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "method": "/api/configuration/getCategory",
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "Category": [{
7. "categoryId": ,
8. "labelId": ,
9. "categoryName": "",
10. "childCategory": [],
11. "description": null,
12. "tag": null,
13. "createTime": ,
14. "updateTime": ,
15. "level": ,
16. "fatherCategoryName": ""
17. }],
18. "description": null,
19. "tag": null,
20. "createTime": ,
21. "updateTime": ,
22. "level": ,
23. "fatherCategoryName":
24. }]
25. }
26. }

接口地址:/api/rest_j/v1/configuration/getFullTreesByAppName

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

参数配置中的队列资源模块返回队列资源的列及值

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
creator 标签名称 query false string
engineType engineType query false string
version version query false string

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "method": "/api/configuration/getFullTreesByAppName",
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "fullTree": [{
7. "name": "队列资源",
8. "description": null,
9. "settings": [{
10. "id": ,
11. "key": "",
12. "description": "",
13. "name": "",
14. "defaultValue": "",
15. "validateType": "",
16. "validateRange": "[]",
17. "level": 1,
18. "engineType": ,
19. "treeName": "",
20. "valueId": ,
21. "configValue": "",
22. "configLabelId": ,
23. "unit": null,
24. "isUserDefined": ,
25. "hidden": ,
26. "advanced":
27. }]
28. }]
29. }
30. }

接口地址:/api/rest_j/v1/configuration/keyvalue

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取键值

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
configKey configKey query true string
creator creator query false string
engineType engineType query false string
version version query false string

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

接口地址:/api/rest_j/v1/configuration/keyvalue

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

保存键值

请求参数:

参数名称 参数说明 是否必须 请求类型 数据类型 schema
configKey configKey true String String
configValue configValue true String String
creator creator true String String
engineType engineType true String String
version version true String String
SaveKeyValue json body true SaveKeyValue SaveKeyValue

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

接口地址:/api/rest_j/v1/configuration/keyvalue

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

删除键值

请求参数:

参数名称 参数说明 是否必须 请求类型 数据类型 schema
configKey configKey true String String
creator creator true String String
engineType engineType true String String
version version true String String
DeleteKeyValue json body true DeleteKeyValue DeleteKeyValue

响应状态:

状态码 说明 schema
200 OK Message
204 No Content
401 Unauthorized
403 Forbidden

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

接口地址:/api/rest_j/v1/configuration/rpcTest

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

rpc测试

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
creator creator query false string
engineType engineType query false string
username username query false string
version version query false string

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

接口地址:/api/rest_j/v1/configuration/saveFullTree

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

保存队列资源

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
creator 应用类型名称 String true String
description 描述,属于fullTree中的内容 String true String
engineType 引擎类型 String true String
fullTree 应用类型下的详细信息 List true List
name 队列资源名称,属于fullTree中的内容 String true String
settings 队列资源中的详细内容,属于fullTree中的内容 List true List

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "method": "/api/configuration/saveFullTree",
3. "status": 0,
4. "message": "OK",
5. "data": {}
6. }

接口地址:/api/rest_j/v1/configuration/updateCategoryInfo

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

更新类别信息

响应示例:

1. {
2. description: "",
3. categoryId:
4. }

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
categoryId categoryId String true String
description description String true String

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "method": "/api/configuration/updateCategoryInfo",
3. "status": 0,
4. "message": "OK",
5. "data": {}
6. }