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

APIRequestCount [apiserver.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

对象

spec 定义资源的特性。

status

对象

status 包含资源的观察到的状态。

.spec

描述

spec 定义资源的特性。

类型

对象

属性 类型 描述

numberOfUsersToReport

整数

numberOfUsersToReport 是要包含在报告中的用户数量。如果未指定或为零，则默认为十。此默认值可能会更改。

.status

描述

status 包含资源的观察到的状态。

类型

对象

属性 类型 描述

conditions

数组

conditions 包含此 API 资源当前状态的详细信息。

conditions[]

对象

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在作为数组直接用于字段路径 .status.conditions。例如，类型 FooStatus struct{ // 代表对 foo 当前状态的观察。 // 已知的 .status.conditions.type 为：“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

currentHour

对象

currentHour 包含当前小时的请求历史记录。这是为了使 API 更易于让人们阅读，查看他们是否解决了问题。此字段在整点重置。

last24h

数组

last24h 包含过去 24 小时的请求历史记录，按小时索引，因此 12:00AM-12:59 在索引 0 中，6am-6:59am 在索引 6 中，依此类推。当前小时的索引实时更新，然后复制到 requestsLastHour 字段中。

last24h[]

对象

PerResourceAPIRequestLog 记录各种节点的请求。

removedInRelease

字符串

removedInRelease 指的是 API 将被删除的时间。

requestCount

整数

requestCount 是所有当前小时、节点和用户的 requestCounts 之和。

.status.conditions

描述

conditions 包含此 API 资源当前状态的详细信息。

类型

数组

.status.conditions[]

描述

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在作为数组直接用于字段路径 .status.conditions。例如，类型 FooStatus struct{ // 代表对 foo 当前状态的观察。 // 已知的 .status.conditions.type 为：“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

类型

对象

必需

  • lastTransitionTime

  • message

  • reason

  • status

  • type

属性 类型 描述

lastTransitionTime

字符串

lastTransitionTime 是条件从一种状态转换到另一种状态的最后时间。这应该是底层条件发生变化的时间。如果不知道，则可以使用 API 字段更改的时间。

message

字符串

message 是一条人性化的消息，指示有关转换的详细信息。这可能是一个空字符串。

observedGeneration

整数

observedGeneration 表示设置条件所基于的 .metadata.generation。例如，如果 .metadata.generation 当前为 12，但 .status.conditions[x].observedGeneration 为 9，则该条件相对于实例的当前状态已过期。

reason

字符串

reason 包含一个程序化标识符，指示条件最后一次转换的原因。特定条件类型的生产者可以为此字段定义预期的值和含义，以及值是否被认为是保证的 API。该值应为驼峰式字符串。此字段不能为空。

status

字符串

条件的状态，True、False、Unknown 之一。

type

字符串

条件类型，使用驼峰式命名法或 foo.example.com/CamelCase。——许多 .condition.type 值在资源之间是一致的，例如 Available，但是由于任意条件可能很有用（参见 .node.status.conditions），因此去重能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)?(qualifiedNameFmt)

.status.currentHour

描述

currentHour 包含当前小时的请求历史记录。这是为了使 API 更易于让人们阅读，查看他们是否解决了问题。此字段在整点重置。

类型

对象

属性 类型 描述

byNode

数组

byNode 包含每个节点的请求日志。

byNode[]

对象

PerNodeAPIRequestLog 包含对特定节点的请求日志。

requestCount

整数

requestCount 是所有节点的 requestCounts 之和。

.status.currentHour.byNode

描述

byNode 包含每个节点的请求日志。

类型

数组

.status.currentHour.byNode[]

描述

PerNodeAPIRequestLog 包含对特定节点的请求日志。

类型

对象

属性 类型 描述

byUser

数组

byUser 包含按前 top .spec.numberOfUsersToReport 个用户请求的详细信息。请注意，对于 apiserver，由于顶级用户的列表是在尽力而为的基础上确定的，因此该列表可能不精确。此外，某些系统用户可能会明确包含在列表中。

byUser[]

对象

PerUserAPIRequestCount 包含用户请求的日志。

nodeName

字符串

处理请求的 nodeName。

requestCount

整数

requestCount 是所有用户的 requestCounts 之和，即使是排名前 10 位之外的用户。

.status.currentHour.byNode[].byUser

描述

byUser 包含按前 top .spec.numberOfUsersToReport 个用户请求的详细信息。请注意，对于 apiserver，由于顶级用户的列表是在尽力而为的基础上确定的，因此该列表可能不精确。此外，某些系统用户可能会明确包含在列表中。

类型

数组

.status.currentHour.byNode[].byUser[]

描述

PerUserAPIRequestCount 包含用户请求的日志。

类型

对象

属性 类型 描述

byVerb

数组

按动词细分的 byVerb 详情。

byVerb[]

对象

PerVerbAPIRequestCount 按 API 请求动词统计的 requestCounts 请求。

requestCount

整数

用户跨所有动词的请求 requestCount。

userAgent

字符串

发出请求的 userAgent。同一用户通常有多个连接的二进制文件（具有多个容器的 Pod）。不同的二进制文件将具有不同的 userAgent，但用户相同。此外，我们有嵌入版本信息的 userAgent，而 userName 不太可能更改。

username

字符串

发出请求的 userName。

.status.currentHour.byNode[].byUser[].byVerb

描述

按动词细分的 byVerb 详情。

类型

数组

.status.currentHour.byNode[].byUser[].byVerb[]

描述

PerVerbAPIRequestCount 按 API 请求动词统计的 requestCounts 请求。

类型

对象

属性 类型 描述

requestCount

整数

动词的请求 requestCount。

verb

字符串

API 请求的动词 (get、list、create 等…)

.status.last24h

描述

last24h 包含过去 24 小时的请求历史记录，按小时索引，因此 12:00AM-12:59 在索引 0 中，6am-6:59am 在索引 6 中，依此类推。当前小时的索引实时更新，然后复制到 requestsLastHour 字段中。

类型

数组

.status.last24h[]

描述

PerResourceAPIRequestLog 记录各种节点的请求。

类型

对象

属性 类型 描述

byNode

数组

byNode 包含每个节点的请求日志。

byNode[]

对象

PerNodeAPIRequestLog 包含对特定节点的请求日志。

requestCount

整数

requestCount 是所有节点的 requestCounts 之和。

.status.last24h[].byNode

描述

byNode 包含每个节点的请求日志。

类型

数组

.status.last24h[].byNode[]

描述

PerNodeAPIRequestLog 包含对特定节点的请求日志。

类型

对象

属性 类型 描述

byUser

数组

byUser 包含按前 top .spec.numberOfUsersToReport 个用户请求的详细信息。请注意，对于 apiserver，由于顶级用户的列表是在尽力而为的基础上确定的，因此该列表可能不精确。此外，某些系统用户可能会明确包含在列表中。

byUser[]

对象

PerUserAPIRequestCount 包含用户请求的日志。

nodeName

字符串

处理请求的 nodeName。

requestCount

整数

requestCount 是所有用户的 requestCounts 之和，即使是排名前 10 位之外的用户。

.status.last24h[].byNode[].byUser

描述

byUser 包含按前 top .spec.numberOfUsersToReport 个用户请求的详细信息。请注意，对于 apiserver，由于顶级用户的列表是在尽力而为的基础上确定的，因此该列表可能不精确。此外，某些系统用户可能会明确包含在列表中。

类型

数组

.status.last24h[].byNode[].byUser[]

描述

PerUserAPIRequestCount 包含用户请求的日志。

类型

对象

属性 类型 描述

byVerb

数组

按动词细分的 byVerb 详情。

byVerb[]

对象

PerVerbAPIRequestCount 按 API 请求动词统计的 requestCounts 请求。

requestCount

整数

用户跨所有动词的请求 requestCount。

userAgent

字符串

发出请求的 userAgent。同一用户通常有多个连接的二进制文件（具有多个容器的 Pod）。不同的二进制文件将具有不同的 userAgent，但用户相同。此外，我们有嵌入版本信息的 userAgent，而 userName 不太可能更改。

username

字符串

发出请求的 userName。

.status.last24h[].byNode[].byUser[].byVerb

描述

按动词细分的 byVerb 详情。

类型

数组

.status.last24h[].byNode[].byUser[].byVerb[]

描述

PerVerbAPIRequestCount 按 API 请求动词统计的 requestCounts 请求。

类型

对象

属性 类型 描述

requestCount

整数

动词的请求 requestCount。

verb

字符串

API 请求的动词 (get、list、create 等…)

API 端点

提供以下 API 端点

  • /apis/apiserver.openshift.io/v1/apirequestcounts

    • DELETE：删除 APIRequestCount 集合

    • GET：列出 APIRequestCount 类型的对象

    • POST：创建 APIRequestCount

  • /apis/apiserver.openshift.io/v1/apirequestcounts/{name}

    • DELETE：删除 APIRequestCount

    • GET：读取指定的 APIRequestCount

    • PATCH：部分更新指定的 APIRequestCount

    • PUT：替换指定的 APIRequestCount

  • /apis/apiserver.openshift.io/v1/apirequestcounts/{name}/status

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

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

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

/apis/apiserver.openshift.io/v1/apirequestcounts

HTTP 方法

DELETE

描述

删除 APIRequestCount 集合

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

200 - OK

Status 模式

401 - Unauthorized

空
HTTP 方法

GET

描述

列出 APIRequestCount 类型的对象

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

200 - OK

APIRequestCountList 模式

401 - Unauthorized

空
HTTP 方法

POST

描述

创建 APIRequestCount

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

dryRun

字符串

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

fieldValidation

字符串

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

body

APIRequestCount 模式
表 5. HTTP 响应
HTTP 代码 响应正文

200 - OK

APIRequestCount 模式

201 - Created

APIRequestCount 模式

202 - Accepted

APIRequestCount 模式

401 - Unauthorized

空

/apis/apiserver.openshift.io/v1/apirequestcounts/{name}

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

name

字符串

APIRequestCount 的名称
HTTP 方法

DELETE

描述

删除 APIRequestCount

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

dryRun

字符串

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

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

空
HTTP 方法

GET

描述

读取指定的 APIRequestCount

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

200 - OK

APIRequestCount 模式

401 - Unauthorized

空
HTTP 方法

PATCH

描述

部分更新指定的 APIRequestCount

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

APIRequestCount 模式

401 - Unauthorized

空
HTTP 方法

PUT

描述

替换指定的 APIRequestCount

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

dryRun

字符串

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

fieldValidation

字符串

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

body

APIRequestCount 模式
表 14. HTTP 响应
HTTP 代码 响应正文

200 - OK

APIRequestCount 模式

201 - Created

APIRequestCount 模式

401 - Unauthorized

空

/apis/apiserver.openshift.io/v1/apirequestcounts/{name}/status

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

name

字符串

APIRequestCount 的名称
HTTP 方法

GET

描述

读取指定的 APIRequestCount 的状态

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

200 - OK

APIRequestCount 模式

401 - Unauthorized

空
HTTP 方法

PATCH

描述

部分更新指定的 APIRequestCount 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

APIRequestCount 模式

401 - Unauthorized

空
HTTP 方法

PUT

描述

替换指定的 APIRequestCount 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

body

APIRequestCount 模式
表 21. HTTP 响应
HTTP 代码 响应正文

200 - OK

APIRequestCount 模式

201 - Created

APIRequestCount 模式

401 - Unauthorized

空