获取配置项列表
更新时间 2026-08-19 15:14:48
最近更新时间: 2026-08-19 15:14:48
接口功能介绍
获取指定命名空间下的配置项列表
接口约束
无
URI
GET /v1/cae/namespace/list-configmaps
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| names | 否 | String | 支持多个配置名称作为查询条件（逗号分隔） | my-config,other-config | |
| namespaceID | 是 | String | 命名空间ID | 0b7b7988-xxxx-xxxx-af7d-244e82424221 | |
| order | 否 | String | ASC升序，DESC降序，默认降序 | DESC | |
| orderBy | 否 | String | 排序字段名，默认按创建时间排序 | createTime | |
| pageNo | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 分页大小 | 10 | |
| search | 否 | String | 模糊查询的关键字，默认为空 | test |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池 ID | bb9fdb42056xxxeda1610242ac1xxxxx | |
| locale | 否 | String | 指定客户端期望的响应语言偏好，默认语言为中文 | en英文，zh-CH中文 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 业务状态码（800为成功，900为失败） | 800 | |
| message | String | 业务状态码为900时的错误信息 | success | |
| description | String | 业务状态码为900时的错误描述 | 成功 | |
| returnObj | Object | 业务数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| configmaps | Array of Objects | 配置列表 | ConfigMapData | |
| currentCount | Integer | 当前页数量 | 10 | |
| pageNo | Integer | 当前页 | 1 | |
| pageSize | Integer | 页面大小 | 10 | |
| totalCount | Integer | 总数 | 100 | |
| requestID | String | 请求ID | 5fd3e6f7-9229-4fb4-a352-0f91bfd638b1 |
表 ConfigMapData
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| configmapID | String | 配置ID | 09db72fa-xxxx-xxxx-a1d8-24a420181216 | |
| configmapName | String | 配置名称 | my-config | |
| createTime | Integer | 创建时间 | 1634544000000 | |
| data | Object | 数据 | ||
| description | String | 描述 | My configmap | |
| namespaceID | String | 命名空间ID | 0b7b7988-xxxx-xxxx-af7d-244e82424221 | |
| namespaceName | String | 命名空间名称 | default | |
| relateApps | Array of Objects | 关联应用 | RelateApp | |
| updateTime | Integer | 更新时间 | 1634544000000 |
表 RelateApp
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| appID | String | 应用ID | 09db72fa-xxxx-xxxx-a1d8-24a420181216 | |
| appName | String | 应用名称 | my-app |
枚举参数
无
请求示例
请求url
GET /v1/cae/namespace/list-configmaps
请求头header
regionId:20000000***1852
请求体body
无
响应示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"returnObj": {
"configmaps": [
{
"configmapID": "09db72fa-xxxx-xxxx-a1d8-24a420181216",
"configmapName": "my-config",
"createTime": 1634544000000,
"data": {
"key": "string"
},
"description": "My configmap",
"namespaceID": "0b7b7988-xxxx-xxxx-af7d-244e82424221",
"namespaceName": "default",
"relateApps": [
{
"appID": "09db72fa-xxxx-xxxx-a1d8-24a420181216",
"appName": "my-app"
}
],
"updateTime": 1634544000000
}
],
"currentCount": 10,
"pageNo": 1,
"pageSize": 10,
"totalCount": 100,
"requestID": "5fd3e6f7-9229-4fb4-a352-0f91bfd638b1"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
