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

密钥 [v1]

规范

属性 类型 描述

apiVersion

字符串

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

data

对象（字符串）

Data 包含秘密数据。每个键必须由字母数字字符、“-”、“_”或“.”组成。秘密数据的序列化形式是一个 base64 编码的字符串，表示此处任意（可能是非字符串）数据值。在https://tools.ietf.org/html/rfc4648#section-4中描述

immutable

布尔值

Immutable，如果设置为 true，则确保存储在 Secret 中的数据无法更新（只能修改对象元数据）。如果未设置为 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

stringData

对象（字符串）

stringData 允许以字符串形式指定非二进制秘密数据。它作为方便易用的只写输入字段提供。写入时，所有键和值都合并到 data 字段中，覆盖任何现有值。从 API 读取时，stringData 字段永远不会输出。

type

字符串

用于方便程序化处理秘密数据。更多信息：https://kubernetes.ac.cn/docs/concepts/configuration/secret/#secret-types

API 端点

以下 API 端点可用

  • /api/v1/secrets

    • GET：列出或监视 Secret 对象

  • /api/v1/watch/secrets

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

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

    • DELETE：删除 Secret 集合

    • GET：列出或监视 Secret 对象

    • POST：创建 Secret

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

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

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

    • DELETE：删除 Secret

    • GET：读取指定的 Secret

    • PATCH：部分更新指定的 Secret

    • PUT：替换指定的 Secret

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

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

/api/v1/secrets

HTTP 方法

GET

描述

列出或监视 Secret 对象

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

200 - OK

SecretList 模式

401 - 未授权

空

/api/v1/watch/secrets

HTTP 方法

GET

描述

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

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

200 - OK

WatchEvent 模式

401 - 未授权

空

/api/v1/namespaces/{namespace}/secrets

HTTP 方法

DELETE

描述

删除 Secret 集合

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

dryRun

字符串

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

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出或监视 Secret 对象

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

200 - OK

SecretList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 Secret

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

dryRun

字符串

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

fieldValidation

字符串

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

主体

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

200 - OK

Secret 模式

201 - 已创建

Secret 模式

202 - 已接受

Secret 模式

401 - 未授权

空

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

HTTP 方法

GET

描述

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

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

200 - OK

WatchEvent 模式

401 - 未授权

空

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

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

name

字符串

Secret 的名称
HTTP 方法

DELETE

描述

删除 Secret

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 Secret

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

200 - OK

Secret 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 Secret

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

Secret 模式

201 - 已创建

Secret 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 Secret

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

dryRun

字符串

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

fieldValidation

字符串

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

主体

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

200 - OK

Secret 模式

201 - 已创建

Secret 模式

401 - 未授权

空

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

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

name

字符串

Secret 的名称
HTTP 方法

GET

描述

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

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

200 - OK

WatchEvent 模式

401 - 未授权

空