接口功能介绍
调用listConfigTemplates获取配置模板分页列表
接口约束
无
URI
GET /v1/config/template/listConfigTemplates
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
templateName | 否 | String | 配置模板名称 | ||
pageNum | 否 | String | 分页查询时当前显示第几页,默认值为1。 | ||
pageSize | 否 | String | 分页查询时每页显示几条,默认值为10。 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应编码 2000 success | 2000 | |
message | String | 消息内容 | 成功 | |
returnObj | Object | 返回数据 | returnObj | |
error | String | 调用错误时返回的错误编码 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
total | Integer | 总行数 | 1 | |
list | Array of Objects | 当前页记录列表 | list | |
pageNum | Integer | 当前页 | 1 | |
pageSize | Integer | 每页行数 | 10 | |
size | Integer | 从startRow到endRow的记录数 | 1 | |
startRow | Integer | 当前页第一个元素在所有元素的序号 | 0 | |
endRow | Integer | 当前页最后一个元素在所有元素的序号 | 0 | |
pages | Integer | 总页数 | 1 | |
prePage | Integer | 前一页 | 0 | |
nextPage | Integer | 下一页 | 0 | |
isFirstPage | String | 是否为第一页 | false | |
isLastPage | String | 是否为最后一页 | false | |
hasPreviousPage | String | 是否有前一页 | false | |
hasNextPage | String | 是否有下一页 | false | |
navigatePages | Integer | 导航页码数 | 0 | |
navigatepageNums | Array of Integers | 所有导航页页号,Integer数组 | null | |
navigateFirstPage | Integer | 导航条上的第一页 | 0 | |
navigateLastPage | Integer | 导航条上的最后一页 | 0 |
表 list
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
templateId | String | 配置模板ID | d0c0da3f-10e4-40f3-9eef-e96a90889253 | |
templateName | String | 模板名称,限字母、数字和划线 | yaml_template | |
templateType | String | 模板类型,限JSON、XML、YAML、Properties和KeyValue | YAML | |
desc | String | 模板内容 | 测试yaml模板 | |
templateContent | String | 模板内容 | ||
createTime | String | 创建时间 | 2022-07-11T09:55:38.000+08:00 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode": 2000,
"message": "成功",
"returnObj": {
"total": 1,
"list": [
{
"templateId": "d0c0da3f-10e4-40f3-9eef-e96a90889253",
"templateName": "yaml_template",
"templateType": "YAML",
"desc": "测试yaml模板",
"templateContent": "# default profile,
与环境无关\r\nspring: \r\n profiles: \r\n active: desk\r\n\r\n\r\n",
"createTime": "2022-07-11T09: 55: 38.000+08: 00"
}
],
"pageNum": 1,
"pageSize": 10,
"size": 1,
"startRow": 0,
"endRow": 0,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": false,
"isLastPage": false,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 0,
"navigatepageNums": null,
"navigateFirstPage": 0,
"navigateLastPage": 0
}
}
状态码
请参考 状态码
错误码
请参考 错误码