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

CredentialsRequest [cloudcredential.openshift.io/v1]

规范

属性 类型 描述

apiVersion

字符串

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

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

spec

对象

CredentialsRequestSpec 定义了 CredentialsRequest 的期望状态

status

对象

CredentialsRequestStatus 定义了 CredentialsRequest 的观察状态

.spec

描述

CredentialsRequestSpec 定义了 CredentialsRequest 的期望状态

类型

对象

必需

  • secretRef

属性 类型 描述

cloudTokenPath

字符串

cloudTokenPath 是 Kubernetes ServiceAccount 令牌（JSON Web 令牌）在请求凭据密钥的工作负载部署中挂载的路径。此字段与其他字段（例如 spec.providerSpec.stsIAMRoleARN）一起出现，表明 CCO 应该代理创建包含基于令牌的身份验证方法（例如使用 AWS 安全令牌服务 (STS)）所需字段的凭据密钥。cloudTokenPath 也可用于指定 ccoctl 生成的 Azure 配置密钥中使用的 azure_federated_token_file 路径。默认为“/var/run/secrets/openshift/serviceaccount/token”。

providerSpec

``

ProviderSpec 包含云提供商特定的凭据规范。

secretRef

对象

SecretRef 指向生成后应存储凭据的密钥。

serviceAccountNames

数组 (字符串)

ServiceAccountNames 包含将使用与此 CredentialsRequest 关联的权限的服务帐户列表。CCO 未使用此信息，但需要此信息才能在使用服务帐户作为云凭据流程一部分时正确设置云提供商中的访问控制。

.spec.secretRef

描述

SecretRef 指向生成后应存储凭据的密钥。

类型

对象

属性 类型 描述

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

如果引用的是对象的一部分而不是整个对象，则此字符串应包含有效的 JSON/Go 字段访问语句，例如 desiredState.manifest.containers[2]。例如，如果对象引用指向 pod 中的容器，则其值将类似于：“spec.containers{name}”（其中“name”指的是触发事件的容器名称）或者如果没有指定容器名称，则为“spec.containers[2]”（此 pod 中索引为 2 的容器）。选择此语法只是为了具有一种定义明确的方式来引用对象的一部分。待办事项：此设计尚未最终确定，此字段将来可能会更改。

kind

字符串

引用的种类。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

引用的名称。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names

namespace

字符串

引用的命名空间。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

字符串

此引用的特定 resourceVersion（如果存在）。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

字符串

引用的 UID。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#uids

.status

描述

CredentialsRequestStatus 定义了 CredentialsRequest 的观察状态

类型

对象

必需

  • lastSyncGeneration

  • provisioned

属性 类型 描述

conditions

数组

Conditions 包含 CredentialsRequest 的详细状态。

conditions[]

对象

CredentialsRequestCondition 包含 CredentialsRequest 对象上任何条件的详细信息。

lastSyncCloudCredsSecretResourceVersion

字符串

LastSyncCloudCredsSecretResourceVersion 是上次同步凭据请求资源时云凭据密钥资源的资源版本。用于确定自上次同步以来云凭据是否已更新。

lastSyncGeneration

整数

LastSyncGeneration 是上次同步的凭据请求资源的代数。用于确定对象是否已更改并需要同步。

lastSyncTimestamp

字符串

LastSyncTimestamp 是上次同步凭据的时间。

providerStatus

``

ProviderStatus 包含云提供商特定的状态。

provisioned

布尔值

初始配置凭据后，Provisioned 为 true。

.status.conditions

描述

Conditions 包含 CredentialsRequest 的详细状态。

类型

数组

.status.conditions[]

描述

CredentialsRequestCondition 包含 CredentialsRequest 对象上任何条件的详细信息。

类型

对象

必需

  • status

  • type

属性 类型 描述

lastProbeTime

字符串

LastProbeTime 是我们上次探测条件的时间。

lastTransitionTime

字符串

LastTransitionTime 是条件从一种状态转换到另一种状态的最后时间。

message

字符串

Message 是一个易于理解的消息，指示有关上次转换的详细信息。

reason

字符串

Reason 是条件上次转换的唯一、单字、驼峰式原因。

status

字符串

Status 是条件的状态。

type

字符串

Type 是条件的特定类型。

API 端点

提供以下 API 端点

  • /apis/cloudcredential.openshift.io/v1/credentialsrequests

    • GET：列出 CredentialsRequest 类型的对象

  • /apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests

    • DELETE：删除 CredentialsRequest 集合

    • GET：列出 CredentialsRequest 类型的对象

    • POST：创建一个 CredentialsRequest

  • /apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests/{name}

    • DELETE：删除一个 CredentialsRequest

    • GET：读取指定的 CredentialsRequest

    • PATCH：部分更新指定的 CredentialsRequest

    • PUT：替换指定的 CredentialsRequest

  • /apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests/{name}/status

    • GET：读取指定的 CredentialsRequest 的状态

    • PATCH：部分更新指定的 CredentialsRequest 的状态

    • PUT：替换指定的 CredentialsRequest 的状态

/apis/cloudcredential.openshift.io/v1/credentialsrequests

HTTP 方法

GET

描述

列出 CredentialsRequest 类型的对象

表 1. HTTP 响应
HTTP 代码 响应正文

200 - OK

CredentialsRequestList 模式

401 - 未授权

空

/apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests

HTTP 方法

DELETE

描述

删除 CredentialsRequest 集合

表 2. HTTP 响应
HTTP 代码 响应正文

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 CredentialsRequest 类型的对象

表 3. HTTP 响应
HTTP 代码 响应正文

200 - OK

CredentialsRequestList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建一个 CredentialsRequest

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

dryRun

字符串

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

fieldValidation

字符串

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

body

CredentialsRequest 模式
表 6. HTTP 响应
HTTP 代码 响应正文

200 - OK

CredentialsRequest 模式

201 - 已创建

CredentialsRequest 模式

202 - 已接受

CredentialsRequest 模式

401 - 未授权

空

/apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests/{name}

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

name

字符串

CredentialsRequest 的名称
HTTP 方法

DELETE

描述

删除 CredentialsRequest

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 CredentialsRequest

表 10. HTTP 响应
HTTP 代码 响应正文

200 - OK

CredentialsRequest 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 CredentialsRequest

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

CredentialsRequest 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 CredentialsRequest

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

dryRun

字符串

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

fieldValidation

字符串

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

body

CredentialsRequest 模式
表 15. HTTP 响应
HTTP 代码 响应正文

200 - OK

CredentialsRequest 模式

201 - 已创建

CredentialsRequest 模式

401 - 未授权

空

/apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests/{name}/status

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

name

字符串

CredentialsRequest 的名称
HTTP 方法

GET

描述

读取指定的 CredentialsRequest 的状态

表 17. HTTP 响应
HTTP 代码 响应正文

200 - OK

CredentialsRequest 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 CredentialsRequest 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

CredentialsRequest 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 CredentialsRequest 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

body

CredentialsRequest 模式
表 22. HTTP 响应
HTTP 代码 响应正文

200 - OK

CredentialsRequest 模式

201 - 已创建

CredentialsRequest 模式

401 - 未授权

空