红帽全球峰会集群 API
集群 API 的参考指南
摘要
第 1 章 集群 API
1.1. IPAddress [ipam.cluster.x-k8s.io/v1beta1]
- 描述
- ipaddress 是 ipaddress API 的 Schema。
- 类型
-
object
1.2. IPAddressClaim [ipam.cluster.x-k8s.io/v1beta1]
- 描述
- ipAddressClaim 是 ipaddressclaim API 的 Schema。
- 类型
-
object
第 2 章 IPAddress [ipam.cluster.x-k8s.io/v1beta1]
- 描述
- ipaddress 是 ipaddress API 的 Schema。
- 类型
-
对象
2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| IPAddressSpec 是 IPAddress 的所需状态。 |
2.1.1. .spec
- 描述
- IPAddressSpec 是 IPAddress 的所需状态。
- 类型
-
object - 必填
-
address -
claimRef -
poolRef -
prefix
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| address 是 IP 地址。 |
|
|
| claimRef 是为此 IPAddress 创建的声明的引用。 |
|
|
| gateway 是地址来自的网络的网络网关。 |
|
|
| PoolRef 是创建此 IPAddress 的池的引用。 |
|
|
| prefix 是地址的前缀。 |
2.1.2. .spec.claimRef
- 描述
- claimRef 是为此 IPAddress 创建的声明的引用。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？ |
2.1.3. .spec.poolRef
- 描述
- PoolRef 是创建此 IPAddress 的池的引用。
- 类型
-
object - 必填
-
kind -
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIGroup 是所引用资源的组。如果没有指定 APIGroup，则指定的 Kind 必须位于 core API 组中。对于任何其他第三方类型，需要 APIGroup。 |
|
|
| kind 是被引用的资源类型 |
|
|
| name 是被引用的资源的名称 |
2.2. API 端点
可用的 API 端点如下：
/apis/ipam.cluster.x-k8s.io/v1beta1/ipaddresses-
GET: 列出类型为 IPAddress 的对象
-
/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses-
DELETE: 删除 IPAddress 集合 -
GET: 列出类型为 IPAddress 的对象 -
POST: 创建一个 IPAddress
-
/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses/{name}-
DELETE：删除 IPAddress -
GET：读取指定的 IPAddress -
PATCH: 部分更新指定的 IPAddress -
PUT：替换指定的 IPAddress
-
2.2.1. /apis/ipam.cluster.x-k8s.io/v1beta1/ipaddresses
- HTTP 方法
-
GET - 描述
- 列出类型为 IPAddress 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
2.2.2. /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses
- HTTP 方法
-
DELETE - 描述
- 删除 IPAddress 集合
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出类型为 IPAddress 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建一个 IPAddress
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
2.2.3. /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| IPAddress 的名称 |
- HTTP 方法
-
DELETE - 描述
- 删除 IPAddress
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 IPAddress
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 IPAddress
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 IPAddress
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 3 章 IPAddressClaim [ipam.cluster.x-k8s.io/v1beta1]
- 描述
- ipAddressClaim 是 ipaddressclaim API 的 Schema。
- 类型
-
对象
3.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| IPAddressClaimSpec 是 IPAddressClaim 的所需状态。 |
|
|
| IPAddressClaimStatus 是 IPAddressClaim 的观察状态。 |
3.1.1. .spec
- 描述
- IPAddressClaimSpec 是 IPAddressClaim 的所需状态。
- 类型
-
object - 必填
-
poolRef
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| PoolRef 是创建 IP 地址的池的引用。 |
3.1.2. .spec.poolRef
- 描述
- PoolRef 是创建 IP 地址的池的引用。
- 类型
-
object - 必填
-
kind -
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIGroup 是所引用资源的组。如果没有指定 APIGroup，则指定的 Kind 必须位于 core API 组中。对于任何其他第三方类型，需要 APIGroup。 |
|
|
| kind 是被引用的资源类型 |
|
|
| name 是被引用的资源的名称 |
3.1.3. .status
- 描述
- IPAddressClaimStatus 是 IPAddressClaim 的观察状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| AddressRef 是对此声明创建的地址的引用。 |
|
|
| 条件总结 IPAddressClaim 的当前状态 |
|
|
| condition 定义 Cluster API 资源操作状态的观察。 |
3.1.4. .status.addressRef
- 描述
- AddressRef 是对此声明创建的地址的引用。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？ |
3.1.5. .status.conditions
- 描述
- 条件总结 IPAddressClaim 的当前状态
- 类型
-
array
3.1.6. .status.conditions[]
- 描述
- condition 定义 Cluster API 资源操作状态的观察。
- 类型
-
object - 必填
-
lastTransitionTime -
status -
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。 |
|
|
| 人类可读的消息，指示有关转换的详细信息。此字段可能为空。 |
|
|
| 在 CamelCase 中条件最后一次转换的原因。特定的 API 可能会选择此字段是否被视为有保证的 API。此字段可能不是空的。 |
|
|
| 严重性提供了明确的 Reason 代码分类，因此用户或机器可以立即了解当前的情况并相应地操作。Severity 字段必须只在 Status=False 时才会设置。 |
|
|
| 条件的状态，True, False, Unknown 之一。 |
|
|
| CamelCase 或 foo.example.com/CamelCase 中的条件类型。许多 .condition.type 值在 Available 资源之间是一致的，但由于任意条件可能很有用（请参阅 .node.status.conditions），不限制性非常重要。 |
3.2. API 端点
可用的 API 端点如下：
/apis/ipam.cluster.x-k8s.io/v1beta1/ipaddressclaims-
GET: 列出类型为 IPAddressClaim 的对象
-
/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims-
DELETE: 删除 IPAddressClaim 集合 -
GET: 列出类型为 IPAddressClaim 的对象 -
POST: 创建一个 IPAddressClaim
-
/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}-
DELETE: delete an IPAddressClaim -
GET：读取指定的 IPAddressClaim -
PATCH: 部分更新指定的 IPAddressClaim -
PUT：替换指定的 IPAddressClaim
-
/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}/status-
GET: 指定 IPAddressClaim 的读取状态 -
PATCH: 部分更新指定 IPAddressClaim 的状态 -
PUT：替换指定 IPAddressClaim 的状态
-
3.2.1. /apis/ipam.cluster.x-k8s.io/v1beta1/ipaddressclaims
- HTTP 方法
-
GET - 描述
- 列出 kind IPAddressClaim 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
3.2.2. /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims
- HTTP 方法
-
DELETE - 描述
- 删除 IPAddressClaim 集合
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 kind IPAddressClaim 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- create an IPAddressClaim
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
3.2.3. /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| IPAddressClaim 的名称 |
- HTTP 方法
-
DELETE - 描述
- delete an IPAddressClaim
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 阅读指定的 IPAddressClaim
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 IPAddressClaim
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 IPAddressClaim
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
3.2.4. /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| IPAddressClaim 的名称 |
- HTTP 方法
-
GET - 描述
- 指定 IPAddressClaim 的读取状态
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 IPAddressClaim 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 IPAddressClaim 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
