Help Center/ Intelligent EdgeFabric/ API Reference/ API/ ConfigMap Management/ Querying Details About a ConfigMap
Updated on 2023-11-23 GMT+08:00

Querying Details About a ConfigMap

Function

This API is used to query details about a ConfigMap.

URI

GET /v2/{project_id}/edgemgr/configmaps/{configmap_id}

Table 1 Path parameters

Parameter

Mandatory

Description

project_id

Yes

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

configmap_id

Yes

ConfigMap ID.

Request

Table 2 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 3 Parameters in the response body

Parameter

Type

Description

configmap

Table 4 object

ConfigMap information.

Table 4 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

{
    "configmap": {
        "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"
    }
}

Error Codes

For details, see Error Codes.