参数配置

ConfigurationRestfulApi 类

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

请求方式:GET

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

响应数据类型:*/*

接口描述:

添加KeyForEngine

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
engineTypeengineTypequeryfalsestring
keyJsonkeyJsonqueryfalsestring
tokentokenqueryfalsestring
versionversionqueryfalsestring

响应状态:

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

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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引用类型标签名称StringfalseString
description描述StringfalseString

响应状态:

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

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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参数配置IdStringtrueString
description描述StringtrueString
engineType引擎类型StringtrueString
version版本号StringtrueString

响应状态:

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

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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参数配置IdStringtrueString

响应状态:

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

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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标签名称queryfalsestring
engineTypeengineTypequeryfalsestring
versionversionqueryfalsestring

响应状态:

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

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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
configKeyconfigKeyquerytruestring
creatorcreatorqueryfalsestring
engineTypeengineTypequeryfalsestring
versionversionqueryfalsestring

响应状态:

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

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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
configKeyconfigKeytrueStringString
configValueconfigValuetrueStringString
creatorcreatortrueStringString
engineTypeengineTypetrueStringString
versionversiontrueStringString
SaveKeyValuejsonbodytrueSaveKeyValueSaveKeyValue

响应状态:

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

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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
configKeyconfigKeytrueStringString
creatorcreatortrueStringString
engineTypeengineTypetrueStringString
versionversiontrueStringString
DeleteKeyValuejsonbodytrueDeleteKeyValueDeleteKeyValue

响应状态:

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

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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
creatorcreatorqueryfalsestring
engineTypeengineTypequeryfalsestring
usernameusernamequeryfalsestring
versionversionqueryfalsestring

响应状态:

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

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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应用类型名称StringtrueString
description描述,属于fullTree中的内容StringtrueString
engineType引擎类型StringtrueString
fullTree应用类型下的详细信息ListtrueList
name队列资源名称,属于fullTree中的内容StringtrueString
settings队列资源中的详细内容,属于fullTree中的内容ListtrueList

响应状态:

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

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
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
categoryIdcategoryIdStringtrueString
descriptiondescriptionStringtrueString

响应状态:

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

响应参数:

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

响应示例:

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