Querying a List of ConfigMaps

Function

This API is used to query a list of ConfigMaps.

URI

GET /v2/{project_id}/edgemgr/configmaps?{name=xxx,limit=xxx,offset=xxx}

**Table 1** Path parameter
Parameter	Mandatory	Description
project_id	Yes	Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
name	No	String	ConfigMap name, which supports fuzzy match.
limit	No	String	Number of records displayed on each page. The value range is 1–1000. The default value is 1000.
offset	No	String	Start position for a query. The value is a non-negative integer. The default value is 0.

If no query parameter is specified, all ConfigMaps of an account are returned.
If multiple query parameters are specified, the ConfigMaps that meet all the specified query parameters are returned.

Request

**Table 3** Parameters in the request header
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). The default value application/json is recommended.
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response

Response parameters

**Table 4** Parameters in the response body
Parameter	Type	Description
configmaps	Array of Table 5 objects	ConfigMap list.
count	Integer	Number of ConfigMaps that meet the conditions.

**Table 5** configmap
Parameter	Type	Description
id	String	ConfigMap ID.
name	String	ConfigMap name.
description	String	ConfigMap description.
configs	Map<String, String>	Configuration key list.
project_id	String	Project ID.
created_at	String	Time when the ConfigMap is created.
updated_at	String	Update time.

Example response

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