website/content/zh-cn/docs/reference/kubernetes-api/config-and-storage-resources/config-map-v1.md

api_metadata	content_type	description	title	weight
apiVersion import kind v1 k8s.io/api/core/v1 ConfigMap	api_reference	ConfigMap 包含供 Pod 使用的配置数据。	ConfigMap	1

apiVersion: v1

import "k8s.io/api/core/v1"

ConfigMap

ConfigMap 包含供 Pod 使用的配置数据。

---

• apiVersion: v1

• kind: ConfigMap

• metadata (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta)

  标准的对象元数据。 更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

• binaryData (map[string][]byte)

  binaryData 包含二进制数据。 每个键必须由字母、数字、“-”、“_” 或 “.” 组成。 binaryData 可以包含不在 UTF-8 范围中的字节序列。 binaryData 中存储的键不得与 data 字段中的键重叠，这在验证过程中是强制要求。 使用此字段需要 apiserver 和 kubelet 的版本高于 1.10。

• data (map[string]string)

  data 包含配置数据。 每个键必须由字母、数字、“-”、“_” 或 “.” 组成。 如果值包含非 UTF-8 字节序列，则必须使用 binaryData 字段。 data 中存储的键不得与 binaryData 字段中的键重叠，这在验证过程中是强制要求。

• immutable (boolean)

  如果 immutable 设为 true， 则确保不会更新 ConfigMap 中存储的数据（只能修改对象元数据）。 如果未设为 true，则可以随时修改此字段。 默认为 nil。

ConfigMapList

ConfigMapList 是包含 ConfigMap 对象列表的资源。

---

• apiVersion: v1

• kind: ConfigMapList

• metadata (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta)

  更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

• items ([]<a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMap" >}}">ConfigMap)，必需

  items 是 ConfigMap 的列表。

操作

---

get 读取指定的 ConfigMap

HTTP 请求

GET /api/v1/namespaces/{namespace}/configmaps/{name}

参数

• name (路径参数): string，必需

  ConfigMap 的名称

• namespace (路径参数): string，必需

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• pretty (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMap" >}}">ConfigMap): OK

401: Unauthorized

list 列出或观测类别为 ConfigMap 的对象

HTTP 请求

GET /api/v1/namespaces/{namespace}/configmaps

参数

• namespace (路径参数): string，必需

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• allowWatchBookmarks (查询参数): boolean

  <a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks

• continue (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue

• fieldSelector (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector

• labelSelector (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector

• limit (查询参数): integer

  <a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit

• pretty (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

• resourceVersion (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion

• resourceVersionMatch (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch

• timeoutSeconds (查询参数): integer

  <a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds

• watch (查询参数): boolean

  <a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch

响应

200 (<a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMapList" >}}">ConfigMapList): OK

401: Unauthorized

list 列出或观测类别为 ConfigMap 的对象

HTTP 请求

GET /api/v1/configmaps

参数

• allowWatchBookmarks (查询参数): boolean

  <a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks

• continue (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue

• fieldSelector (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector

• labelSelector (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector

• limit (查询参数): integer

  <a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit

• pretty (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

• resourceVersion (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion

• resourceVersionMatch (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch

• timeoutSeconds (查询参数): integer

  <a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds

• watch (查询参数): boolean

  <a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch

响应

200 (<a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMapList" >}}">ConfigMapList): OK

401: Unauthorized

create 创建 ConfigMap

HTTP 请求

POST /api/v1/namespaces/{namespace}/configmaps

参数

• namespace (路径参数): string，必需

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMap" >}}">ConfigMap，必需

• dryRun (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• fieldValidation (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation

• pretty (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMap" >}}">ConfigMap): OK

201 (<a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMap" >}}">ConfigMap): Created

202 (<a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMap" >}}">ConfigMap): Accepted

401: Unauthorized

update 替换指定的 ConfigMap

HTTP 请求

PUT /api/v1/namespaces/{namespace}/configmaps/{name}

参数

• name (路径参数): string，必需

  ConfigMap 的名称

• namespace (路径参数): string，必需

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMap" >}}">ConfigMap，必需

• dryRun (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• fieldValidation (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation

• pretty (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMap" >}}">ConfigMap): OK

201 (<a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMap" >}}">ConfigMap): Created

401: Unauthorized

patch 部分更新指定的 ConfigMap

HTTP 请求

PATCH /api/v1/namespaces/{namespace}/configmaps/{name}

参数

• name (路径参数): string，必需

  ConfigMap 的名称

• namespace (路径参数): string，必需

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch，必需

• dryRun (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• fieldValidation (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation

• force (查询参数): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force

• pretty (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMap" >}}">ConfigMap): OK

201 (<a href="{{< ref "../config-and-storage-resources/config-map-v1#ConfigMap" >}}">ConfigMap): Created

401: Unauthorized

delete 删除 ConfigMap

HTTP 请求

DELETE /api/v1/namespaces/{namespace}/configmaps/{name}

参数

• name (路径参数): string，必需

  ConfigMap 的名称

• namespace (路径参数): string，必需

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions

• dryRun (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• gracePeriodSeconds (查询参数): integer

  <a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds

• pretty (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

• propagationPolicy (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy

响应

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK

202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): Accepted

401: Unauthorized

deletecollection 删除 ConfigMap 的集合

HTTP 请求

DELETE /api/v1/namespaces/{namespace}/configmaps

参数

• namespace (路径参数): string，必需

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions

• continue (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue

• dryRun (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldSelector (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector

• gracePeriodSeconds (查询参数): integer

  <a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds

• labelSelector (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector

• limit (查询参数): integer

  <a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit

• pretty (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

• propagationPolicy (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy

• resourceVersion (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion

• resourceVersionMatch (查询参数): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch

• timeoutSeconds (查询参数): integer

  <a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds

响应

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK

401: Unauthorized