6.2. API 端点

可用的 API 端点如下：

/apis/operators.coreos.com/v1/operators
- DELETE ：删除 Operator 集合
- GET: 列出类型为 Operator 的对象
- POST ：创建 Operator
/apis/operators.coreos.com/v1/operators/{name}
- DELETE ：删除 Operator
- GET ：读取指定的 Operator
- PATCH: 部分更新指定的 Operator
- PUT ：替换指定的 Operator
/apis/operators.coreos.com/v1/operators/{name}/status
- GET ：指定 Operator 的读取状态
- PATCH: 部分更新指定 Operator 的状态
- PUT ：替换指定 Operator 的状态

6.2.1. /apis/operators.coreos.com/v1/operators

表 6.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 Operator 集合

表 6.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 6.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 Operator 类型的对象

表 6.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 6.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`operatorList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 Operator

表 6.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

表 6.7. 主体参数
参数	类型	描述
`正文（body）`	`Operator` 模式

表 6.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Operator` 模式
201 - Created	`Operator` 模式
202 - Accepted	`Operator` 模式
401 - Unauthorized	空

6.2.2. /apis/operators.coreos.com/v1/operators/{name}

表 6.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	Operator 的名称

表 6.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 Operator

表 6.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

表 6.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

表 6.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 Operator

表 6.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 6.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Operator` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 Operator

表 6.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

表 6.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 6.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Operator` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 Operator

表 6.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

表 6.20. 主体参数
参数	类型	描述
`正文（body）`	`Operator` 模式

表 6.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Operator` 模式
201 - Created	`Operator` 模式
401 - Unauthorized	空

6.2.3. /apis/operators.coreos.com/v1/operators/{name}/status

表 6.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	Operator 的名称

表 6.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 Operator 的读取状态

表 6.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 6.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Operator` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 Operator 的状态

表 6.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

表 6.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 6.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Operator` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 Operator 的状态

表 6.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

表 6.30. 主体参数
参数	类型	描述
`正文（body）`	`Operator` 模式

表 6.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Operator` 模式
201 - Created	`Operator` 模式
401 - Unauthorized	空

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

© 2024 Red Hat, Inc.