×

规范

属性 类型 描述

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

对象

存储状态的规范。

status

对象

存储状态。

.spec

描述

存储状态的规范。

类型

对象

属性 类型 描述

resource

对象

此 storageState 所涉及的资源。

.spec.resource

描述

此 storageState 所涉及的资源。

类型

对象

属性 类型 描述

group

字符串

组的名称。

resource

字符串

资源的名称。

.status

描述

存储状态。

类型

对象

属性 类型 描述

currentStorageVersionHash

字符串

当前存储版本的哈希值,如 API 服务器提供的发现文档所示。存储版本是将对象转换为持久化之前的版本。

lastHeartbeatTime

字符串

LastHeartbeatTime 是存储迁移触发控制器最后一次检查发现文档中此资源的存储版本哈希值并更新此字段的时间。

persistedStorageVersionHashes

数组 (字符串)

持久化 spec.resource 实例可能仍然编码其中的存储版本的哈希值。“未知”是列表中的有效值,也是默认值。升级或降级到不支持此字段中列出的所有版本的 apiserver 二进制文件是不安全的,或者如果列出了“未知”。此资源的存储版本迁移完成后,此字段的值将被细化为仅包含 currentStorageVersionHash。apiserver 更改存储版本后,新存储版本将附加到列表中。

API 端点

以下 API 端点可用

  • /apis/migration.k8s.io/v1alpha1/storagestates

    • DELETE: 删除 StorageState 集合

    • GET: 列出 StorageState 对象

    • POST: 创建一个 StorageState

  • /apis/migration.k8s.io/v1alpha1/storagestates/{name}

    • DELETE: 删除一个 StorageState

    • GET: 读取指定的 StorageState

    • PATCH: 部分更新指定的 StorageState

    • PUT: 替换指定的 StorageState

  • /apis/migration.k8s.io/v1alpha1/storagestates/{name}/status

    • GET: 读取指定的 StorageState 状态

    • PATCH: 部分更新指定的 StorageState 状态

    • PUT: 替换指定的 StorageState 状态

/apis/migration.k8s.io/v1alpha1/storagestates

HTTP 方法

DELETE

描述

删除 StorageState 集合

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

200 - OK

Status 模式

401 - 未授权

HTTP 方法

GET

描述

列出 StorageState 对象

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

200 - OK

StorageStateList 模式

401 - 未授权

HTTP 方法

POST

描述

创建一个 StorageState

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

dryRun

字符串

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

fieldValidation

字符串

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

表 4. 请求体参数
参数 类型 描述

body

StorageState 模式

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

200 - OK

StorageState 模式

201 - 已创建

StorageState 模式

202 - 已接受

StorageState 模式

401 - 未授权

/apis/migration.k8s.io/v1alpha1/storagestates/{name}

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

name

字符串

StorageState 的名称

HTTP 方法

DELETE

描述

删除一个 StorageState

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

dryRun

字符串

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

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

HTTP 方法

GET

描述

读取指定的 StorageState

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

200 - OK

StorageState 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 StorageState

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

StorageState 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 StorageState

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

dryRun

字符串

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

fieldValidation

字符串

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

表 13. 请求体参数
参数 类型 描述

body

StorageState 模式

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

200 - OK

StorageState 模式

201 - 已创建

StorageState 模式

401 - 未授权

/apis/migration.k8s.io/v1alpha1/storagestates/{name}/status

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

name

字符串

StorageState 的名称

HTTP 方法

GET

描述

读取指定的 StorageState 状态

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

200 - OK

StorageState 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 StorageState 状态

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

StorageState 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 StorageState 状态

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

dryRun

字符串

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

fieldValidation

字符串

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

表 20. 请求体参数
参数 类型 描述

body

StorageState 模式

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

200 - OK

StorageState 模式

201 - 已创建

StorageState 模式

401 - 未授权