Skip to main content
版本:1.6.0

参数配置

ConfigurationRestfulApi 类

添加KeyForEngine

接口地址:/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)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

新增应用类型

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

新增应用类型标签

请求示例:

{
"categoryName": “”,
"description": ""
}

请求参数:

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

响应状态:

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

响应参数:

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

响应示例:

{
"method": "/api/configuration/createFirstCategory",
"status": 0,
"message": "OK",
"data": {}
}

新增参数配置

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

添加参数配置

请求示例:

{
categoryId: ,
description: "",
engineType: "",
version: ""
}

请求参数:

参数名称参数说明请求类型是否必须数据类型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)

响应示例:

{
"method": "/api/configuration/createSecondCategory",
"status": 0,
"message": "OK",
"data": {}
}

删除配置

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

删除参数配置

请求示例:

{
categoryId:
}

请求参数:

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

响应状态:

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

响应参数:

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

响应示例:

{
"method": "/api/configuration/deleteCategory",
"status": 0,
"message": "OK",
"data": {}
}

引擎类型列表

接口地址:/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)

响应示例:

{
"method": "/api/configuration/engineType",
"status": 0,
"message": "OK",
"data": {
"engineType": []
}
}

应用类型

接口地址:/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)

响应示例:

{
"method": "/api/configuration/getCategory",
"status": 0,
"message": "OK",
"data": {
"Category": [{
"categoryId": ,
"labelId": ,
"categoryName": "",
"childCategory": [],
"description": null,
"tag": null,
"createTime": ,
"updateTime": ,
"level": ,
"fatherCategoryName": ""
}],
"description": null,
"tag": null,
"createTime": ,
"updateTime": ,
"level": ,
"fatherCategoryName":
}]
}
}

队列资源

接口地址:/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)

响应示例:

{
"method": "/api/configuration/getFullTreesByAppName",
"status": 0,
"message": "OK",
"data": {
"fullTree": [{
"name": "队列资源",
"description": null,
"settings": [{
"id": ,
"key": "",
"description": "",
"name": "",
"defaultValue": "",
"validateType": "",
"validateRange": "[]",
"level": 1,
"engineType": ,
"treeName": "",
"valueId": ,
"configValue": "",
"configLabelId": ,
"unit": null,
"isUserDefined": ,
"hidden": ,
"advanced":
}]
}]
}
}

获取键值

接口地址:/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)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

保存键值

接口地址:/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)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

删除键值

接口地址:/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)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

rpc测试

接口地址:/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)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

保存队列资源

接口地址:/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)

响应示例:

{
"method": "/api/configuration/saveFullTree",
"status": 0,
"message": "OK",
"data": {}
}

更新类别信息

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

更新类别信息

响应示例:

{
description: "",
categoryId:
}

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
categoryIdcategoryIdStringtrueString
descriptiondescriptionStringtrueString

响应状态:

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

响应参数:

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

响应示例:

{
"method": "/api/configuration/updateCategoryInfo",
"status": 0,
"message": "OK",
"data": {}
}