查询配置项列表 - ListConfigMaps

功能介绍

查询配置项列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v2/{project_id}/edgemgr/configmaps

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID

表2 Query参数
参数	是否必选	参数类型	描述
name	否	String	配置项名称，模糊匹配
limit	否	String	每页显示的条目数量，取值范围1~1000，默认为1000
offset	否	String	查询的起始位置，取值范围为非负整数，默认为0

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	消息体的类型（格式），默认取值为“application/json”。
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
ief-instance-id	否	String	企业版实例ID，专业版实例为空值。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
configmaps	Array of ConfigMapResp objects	配置项
count	Integer	满足条件的个数

表5 ConfigMapResp
参数	参数类型	描述
id	String	配置项ID
name	String	配置项名称
description	String	配置项描述
configs	Map<String,String>	配置项键列表
project_id	String	项目ID
created_at	String	创建时间
updated_at	String	更新时间

请求示例

无

响应示例

状态码：200

{
  "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"
  } ]
}