OpenShift 文档正在迁移，很快将仅在 docs.redhat.com（所有 Red Hat 产品文档的首页）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

ConfigMap [v1]

规范

属性 类型 描述

apiVersion

字符串

APIVersion 定义此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

binaryData

对象 (字符串)

BinaryData 包含二进制数据。每个键必须由字母数字字符、'-'、'_' 或 '.' 组成。BinaryData 可以包含不在 UTF-8 范围内的字节序列。BinaryData 中存储的键不得与 Data 字段中的键重叠，这在验证过程中强制执行。使用此字段需要 1.10+ apiserver 和 kubelet。

data

对象 (字符串)

数据包含配置数据。每个键必须由字母数字字符、'-'、'_' 或 '.' 组成。包含非 UTF-8 字节序列的值必须使用 BinaryData 字段。Data 中存储的键不得与 BinaryData 字段中的键重叠，这在验证过程中强制执行。

immutable

布尔值

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

kind

字符串

Kind 是一个字符串值，表示此对象代表的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。使用驼峰命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

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

API 端点

提供以下 API 端点

  • /api/v1/configmaps

    • GET：列出或监视 ConfigMap 类型的对象

  • /api/v1/watch/configmaps

    • GET：监视 ConfigMap 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

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

    • DELETE：删除 ConfigMap 集合

    • GET：列出或监视 ConfigMap 类型的对象

    • POST：创建一个 ConfigMap

  • /api/v1/watch/namespaces/{namespace}/configmaps

    • GET：监视 ConfigMap 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

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

    • DELETE：删除一个 ConfigMap

    • GET：读取指定的 ConfigMap

    • PATCH：部分更新指定的 ConfigMap

    • PUT：替换指定的 ConfigMap

  • /api/v1/watch/namespaces/{namespace}/configmaps/{name}

    • GET：监视 ConfigMap 类型对象的更改。已弃用：改为使用列表操作中的“watch”参数，并使用“fieldSelector”参数过滤为单个项目。

/api/v1/configmaps

HTTP 方法

GET

描述

列出或监视 ConfigMap 类型的对象

表 1. HTTP 响应
HTTP 代码 响应体

200 - OK

ConfigMapList 模式

401 - 未授权

空

/api/v1/watch/configmaps

HTTP 方法

GET

描述

监视 ConfigMap 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

WatchEvent 模式

401 - 未授权

空

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

HTTP 方法

DELETE

描述

删除 ConfigMap 集合

表 3. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
表 4. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出或监视 ConfigMap 类型的对象

表 5. HTTP 响应
HTTP 代码 响应体

200 - OK

ConfigMapList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建一个 ConfigMap

表 6. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 7. 请求体参数
参数 类型 描述

body

ConfigMap 模式
表 8. HTTP 响应
HTTP 代码 响应体

200 - OK

ConfigMap 模式

201 - 已创建

ConfigMap 模式

202 - 已接受

ConfigMap 模式

401 - 未授权

空

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

HTTP 方法

GET

描述

监视 ConfigMap 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

表 9. HTTP 响应
HTTP 代码 响应体

200 - OK

WatchEvent 模式

401 - 未授权

空

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

表 10. 全局路径参数
参数 类型 描述

name

字符串

ConfigMap 的名称
HTTP 方法

DELETE

描述

删除一个 ConfigMap

表 11. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
表 12. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 ConfigMap

表 13. HTTP 响应
HTTP 代码 响应体

200 - OK

ConfigMap 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 ConfigMap

表 14. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 15. HTTP 响应
HTTP 代码 响应体

200 - OK

ConfigMap 模式

201 - 已创建

ConfigMap 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 ConfigMap

表 16. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 17. 请求体参数
参数 类型 描述

body

ConfigMap 模式
表 18. HTTP 响应
HTTP 代码 响应体

200 - OK

ConfigMap 模式

201 - 已创建

ConfigMap 模式

401 - 未授权

空

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

表 19. 全局路径参数
参数 类型 描述

name

字符串

ConfigMap 的名称
HTTP 方法

GET

描述

监视 ConfigMap 类型对象的更改。已弃用：改为使用列表操作中的“watch”参数，并使用“fieldSelector”参数过滤为单个项目。

表 20. HTTP 响应
HTTP 代码 响应体

200 - OK

WatchEvent 模式

401 - 未授权

空