查询配置项列表 - ListConfigMaps
功能介绍
该API用于查询配置项列表。
URI
GET /v2/{project_id}/edgemgr/configmaps?{name=xxx,limit=xxx,offset=xxx}
|
名称 |
是否必选 |
说明 |
|---|---|---|
|
project_id |
是 |
项目ID,获取方法请参见获取项目ID。 |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
name |
否 |
String |
配置项名称,模糊匹配 |
|
limit |
否 |
String |
每页显示的条目数量,取值范围1~1000,默认为1000 |
|
offset |
否 |
String |
查询的起始位置,取值范围为非负整数,默认为0 |
- 如果不携带任何检索参数,将返回所有配置项。
- 可以同时携带多个检索参数,同时生效。
请求消息
|
参数 |
是否必选 |
类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
消息体的类型(格式) 推荐您使用默认值application/json。 |
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
ief-instance-id |
否 |
String |
铂金版实例ID,专业版实例为空值 |
响应消息
响应参数
|
名称 |
参数类型 |
说明 |
|---|---|---|
|
configmaps |
Array of 表5 objects |
配置项列表 |
|
count |
Integer |
满足条件的个数 |
|
名称 |
参数类型 |
说明 |
|---|---|---|
|
id |
String |
配置项ID |
|
name |
String |
配置项名称 |
|
description |
String |
配置项描述 |
|
configs |
Map<String, String> |
属性键列表 |
|
project_id |
String |
项目ID |
|
created_at |
String |
创建时间 |
|
updated_at |
String |
更新时间 |
响应示例
{
"count": 1,
"configmaps": [
{
"id": "12ns9eb6cc0d49a0941df2f31283mds8 ",
"name": "test-cm",
"description": "this is a test cm2",
"configs": {
"key1": "val1",
"key3": "val3"
},
"project_id": "d16e6eb6cc0d49a0941df2f31285757a",
"created_at": "2018-07-16T13:41:25.347335",
"updated_at": "2018-07-19T13:41:25.347335"
}
]
}
错误码
请参见错误码。