接口功能介绍
调用接口listK8sConfigMaps获取K8s配置项列表
接口约束
无
URI
GET /v1/configmap/listK8sConfigMaps
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
configMapName | 否 | String | K8s配置项名称 | ||
pageNum | 否 | String | 分页查询时当前显示第几页,默认值为1。 | ||
pageSize | 否 | String | 分页查询时每页显示几条,默认值为10。 | ||
deployEnvName | 否 | String | 环境名称 | ||
projectId | 是 | String | 项目ID | 321 |
请求参数
请求头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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
configMapId | String | K8s配置项名称 | test_d5d362c1f288 | |
configMapName | String | 集群名称 | test_d2b54c8d577f | |
deployEnvId | Integer | 部署环境ID | 88 | |
deployEnvName | String | 部署环境名称 | test_d388bf553f1b | |
deployEnvCode | String | 部署环境代码 | test_5485147929e9 | |
clusterName | String | 集群名称 | test_eccdbf6c9793 | |
namespace | String | K8s命名空间 | test_096d522195bb | |
createTime | String | 创建时间 | 2015-05-30 11:12:56 | |
items | Array of Objects | K8s配置项列 | items |
表 items
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
name | String | K8s配置项列名 | test_95a85d6cc823 | |
value | String | K8s配置项列值 | test_db3fb838cdf9 | |
storagePath | String | K8s配置项存储路径 | test_c20ea72ef212 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode": 2000,
"message": "成功",
"returnObj": {
"total": 1,
"list": [
{
"configMapId": "a0ab23fd-ae89-487f-bfdd-925e9e026237",
"configMapName": "consumer-test",
"deployEnvId": "f3b6c552-4138-4060-96e1-b7b0e0b7e9d9",
"deployEnvName": "test",
"deployEnvCode": "cs-1_cshj",
"clusterName": "ccse-a82ckg",
"namespace": "test",
"createTime": "2023-07-28T02: 51: 55.000+00: 00",
"items": [
{
"name": "application.yml",
"value": ""
}
]
}
],
"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
}
}
状态码
请参考 状态码
错误码
请参考 错误码