主页
产品
Red Hat Quay
3.2
测试 REST
28.5. TemplateInstance [template.openshift.io/v1]

28.5. TemplateInstance [template.openshift.io/v1]

描述

TemplateInstance 请求并记录模板实例化。TemplateInstance 是实验性 API 的一部分。

类型

对象

必填

spec

28.5.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`
`spec`	`对象`	TemplateInstanceSpec 描述了 TemplateInstance 的所需状态。
`status`	`对象`	TemplateInstanceStatus 描述了 TemplateInstance 的当前状态。

28.5.1.1. .spec
复制链接

描述

TemplateInstanceSpec 描述了 TemplateInstance 的所需状态。

类型

对象

必填

模板

Expand

属性	类型	描述
`requester`	`对象`	TemplateInstanceRequester 包含请求模板实例化的代理的身份。
`secret`	`LocalObjectReference_v2`	secret 是对包含所需模板参数的 Secret 对象的引用。
`模板`	`对象`	模板包含生成配置所需的输入。

28.5.1.2. .spec.requester
复制链接

描述: TemplateInstanceRequester 包含请求模板实例化的代理的身份。
类型: 对象

Expand

属性	类型	描述
`extra`	`对象`	额外包含验证器提供的其他信息。
`extra{}`	`数组（字符串）`
`groups`	`数组（字符串）`	groups 代表此用户所属的组。
`uid`	`字符串`	UID 是一个唯一值，可跨时间标识此用户；如果删除了此用户并且添加相同名称的其他用户，则它们将具有不同的 UID。
`username`	`字符串`	用户名在所有活跃用户中唯一标识此用户。

28.5.1.3. .spec.requester.extra
复制链接

描述: 额外包含验证器提供的其他信息。
类型: 对象

28.5.1.4. .spec.template
复制链接

描述

模板包含生成配置所需的输入。

类型

对象

必填

对象

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`labels`	`对象（字符串）`	标签是一组可选标签，在模板到配置转换过程中应用于每个对象。
`message`	`字符串`	Message 是一个可选指令信息，将在该模板实例化时显示。此字段应告知用户如何使用新创建的资源。显示消息之前，将对消息执行参数替换，以便输出中包含生成的凭据和其他参数。
`元数据`	`ObjectMeta`
`对象`	`数组(RawExtension)`	对象是该模板中包含的一组资源。如果在对象中硬编码了命名空间值，它将在模板实例化过程中删除，但如果命名空间值是或包含，则 ${PARAMETER_REFERENCE}，则参数替换后解析的值将会被遵守，并在该命名空间中创建对象。
`parameters`	`数组`	参数是模板期间用于配置转换期间使用的可选参数。
`parameters[]`	`对象`	参数定义要在模板到配置转换期间处理的 name/value 变量。

28.5.1.5. .spec.template.parameters
复制链接

描述: 参数是模板期间用于配置转换期间使用的可选参数。
类型: 数组

28.5.1.6. .spec.template.parameters[]
复制链接

描述

参数定义要在模板到配置转换期间处理的 name/value 变量。

类型

对象

必填

name

Expand

属性	类型	描述
`description`	`字符串`	参数的描述。可选。
`displayName`	`字符串`	可选：在 UI 中显示的名称而不是参数 'Name'
`from`	`字符串`	from 是生成器的输入值。可选。
`generate`	`字符串`	generate 指定用于从 From 字段指定的输入值生成随机字符串的生成器。结果字符串存储在 Value 字段中。如果为空，则不会使用生成器，则结果值保持不变。可选。唯一支持的生成器是 "expression"，它接受一个"from"值，格式为包括范围表达式 "[a-zA-Z0-9]"，以及长度表达式 "a{length}"。示例： from \| value ----------------------------- "test[0-9] the \| "test7x" "[0-1]{8}" \| "01001100" "0x[A-F0-9]{4}" \| "0xB3AF" "[a-zA-Z0-9]{8}" \| "hW4yQU5i"
`name`	`字符串`	必须设置名称，并可使用 ${PARAMETER_NAME} 在模板中引用它。必需。
`required`	`布尔值`	可选：指示参数必须具有值。默认为false。
`value`	`字符串`	值包含参数数据。如果指定，则生成器将被忽略。该值在模板到配置转换过程中替换 Parameter ${Name} 表达式的所有发生。可选。

28.5.1.7. .status
复制链接

描述: TemplateInstanceStatus 描述了 TemplateInstance 的当前状态。
类型: 对象

Expand

属性	类型	描述
`conditions`	`数组`	条件代表 TemplateInstance 当前状态的最新可用影响。
`conditions[]`	`对象`	TemplateInstanceCondition 包含 TemplateInstance 的条件信息。
`对象`	`数组`	对象引用 TemplateInstance 创建的对象。
`objects[]`	`对象`	TemplateInstanceObject 引用由 TemplateInstance 创建的对象。

28.5.1.8. .status.conditions
复制链接

描述: 条件代表 TemplateInstance 当前状态的最新可用影响。
类型: array

28.5.1.9. .status.conditions[]
复制链接

描述

TemplateInstanceCondition 包含 TemplateInstance 的条件信息。

类型

对象

必填

type
status
lastTransitionTime
reason
message

Expand

属性	类型	描述
`lastTransitionTime`	`time`	lastTransitionTime 是条件状态变为另一个状态最后一次的时间。
`message`	`字符串`	消息是最后一次转换的详细信息的人类可读描述，补充原因。
`reason`	`字符串`	reason 是条件最后一次转换的简短机器可读说明。
`status`	`字符串`	条件的状态，True、False 或 Unknown 之一。
`type`	`字符串`	条件类型，当前 Ready 或 InstantiateFailure。

28.5.1.10. .status.objects
复制链接

描述: 对象引用 TemplateInstance 创建的对象。
类型: 数组

28.5.1.11. .status.objects[]
复制链接

描述: TemplateInstanceObject 引用由 TemplateInstance 创建的对象。
类型: 对象

Expand

属性	类型	描述
`ref`	`ObjectReference_v2`	ref 是对所创建对象的引用。在 .spec 下使用时，只使用名称和命名空间；它们可以包含对参数的引用，该参数将在通常的规则后替换。

28.5.2. API 端点
复制链接

可用的 API 端点如下：

/apis/template.openshift.io/v1/templateinstances
- GET: list 或 watch 对象为 TemplateInstance
/apis/template.openshift.io/v1/watch/templateinstances
- GET: 观察对 TemplateInstance 列表的各个更改。已弃用：将 'watch' 参数与列表操作一起使用。
/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances
- DELETE ：删除 TemplateInstance 的集合
- GET: list 或 watch 对象为 TemplateInstance
- POST ：创建 TemplateInstance
/apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances
- GET: 观察对 TemplateInstance 列表的各个更改。已弃用：将 'watch' 参数与列表操作一起使用。
/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}
- DELETE ：删除 TemplateInstance
- GET ：读取指定的 TemplateInstance
- PATCH ：部分更新指定的 TemplateInstance
- PUT ：替换指定的 TemplateInstance
/apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances/{name}
- GET: 观察对 TemplateInstance 类型的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}/status
- GET: read status of the specified TemplateInstance
- PATCH ：部分更新指定 TemplateInstance 的状态
- PUT: 替换指定 TemplateInstance 的状态

28.5.2.1. /apis/template.openshift.io/v1/templateinstances
复制链接

Expand

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

HTTP 方法: GET
描述: 列出或监视 TemplateInstance 类型的对象

Expand

表 28.96. HTTP 响应
HTTP 代码	响应正文
200 - OK	`TemplateInstanceList` schema
401 - Unauthorized	空

28.5.2.2. /apis/template.openshift.io/v1/watch/templateinstances
复制链接

Expand

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

HTTP 方法: GET
描述: 观察对 TemplateInstance 列表的各个更改。已弃用：改为使用 'watch' 参数和列表操作。

Expand

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

28.5.2.3. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances
复制链接

Expand

表 28.99. 全局路径参数
参数	类型	描述
`namespace`	`字符串`	对象名称和身份验证范围，如团队和项目

Expand

表 28.100. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果 'true'，则输出被用户友善。

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

Expand

表 28.101. 查询参数
参数	类型	描述
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须在没有 continue 字段的情况下重启其列表。否则，客户端可能会发送另一个列表请求，并带有 410 错误收到的令牌，服务器将通过从下一个密钥开始的列表进行响应，但从最新的快照（从最后一个列表结果中不一致） - 在第一个列表请求后创建、修改或删除的对象将包含在响应中，只要其密钥在"next key"后。当 watch 为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视，而不丢失任何修改。
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldSelector`	`字符串`	用于限制返回的对象列表的选择器。默认为任何内容。
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值是 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`labelSelector`	`字符串`	通过标签限制返回的对象列表的选择器。默认为任何内容。
`limit`	`整数`	限制是列表调用要返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值，以检索下一个结果集。在过滤所有请求的对象时，设置限制可能会返回比请求的项目数量少（最多为零项），客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数，并将返回所有可用的结果。如果指定了限制，并且 continue 字段为空，客户端可能会假设没有更多可用的结果。如果 watch 为 true，则不支持此字段。服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象，则返回第一次列表结果时存在的对象版本。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false，"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置两者。
`propagationPolicy`	`字符串`	是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为： 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系； 'Foreground' - 一个删除前台所有依赖的级联策略。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	list/watch 调用的超时。这限制了调用的时间，无论任何活动或不活跃。

Expand

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

Expand

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

HTTP 方法: GET
描述: 列出或监视 TemplateInstance 类型的对象

Expand

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

Expand

表 28.105. HTTP 响应
HTTP 代码	响应正文
200 - OK	`TemplateInstanceList` schema
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 TemplateInstance

Expand

表 28.106. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand

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

Expand

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

28.5.2.4. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances
复制链接

Expand

表 28.109. 全局路径参数
参数	类型	描述
`namespace`	`字符串`	对象名称和身份验证范围，如团队和项目

Expand

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

HTTP 方法: GET
描述: 观察对 TemplateInstance 列表的各个更改。已弃用：改为使用 'watch' 参数和列表操作。

Expand

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

28.5.2.5. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}
复制链接

Expand

表 28.112. 全局路径参数
参数	类型	描述
`name`	`字符串`	TemplateInstance 的名称
`namespace`	`字符串`	对象名称和身份验证范围，如团队和项目

Expand

表 28.113. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果 'true'，则输出被用户友善。

HTTP 方法: DELETE
描述: 删除 TemplateInstance

Expand

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

Expand

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

Expand

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

HTTP 方法: GET
描述: 读取指定的 TemplateInstance

Expand

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

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

Expand

表 28.118. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对于非应用补丁类型(JsonPatch、MergePatch、OptMergePatch)是可选的。
`force`	`布尔值`	强制将"强制"应用请求。这意味着用户会重新清空由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

Expand

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

Expand

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

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

Expand

表 28.121. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand

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

Expand

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

28.5.2.6. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances/{name}
复制链接

Expand

表 28.124. 全局路径参数
参数	类型	描述
`name`	`字符串`	TemplateInstance 的名称
`namespace`	`字符串`	对象名称和身份验证范围，如团队和项目

Expand

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

HTTP 方法: GET
描述: 观察对类型为 TemplateInstance 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。

Expand

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

28.5.2.7. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}/status
复制链接

Expand

表 28.127. 全局路径参数
参数	类型	描述
`name`	`字符串`	TemplateInstance 的名称
`namespace`	`字符串`	对象名称和身份验证范围，如团队和项目

Expand

表 28.128. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果 'true'，则输出被用户友善。

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

Expand

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

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

Expand

表 28.130. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对于非应用补丁类型(JsonPatch、MergePatch、OptMergePatch)是可选的。
`force`	`布尔值`	强制将"强制"应用请求。这意味着用户会重新清空由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

Expand

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

Expand

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

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

Expand

表 28.133. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand

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

Expand

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

返回顶部

28.5. TemplateInstance [template.openshift.io/v1]

28.5.1. 规格
复制链接

28.5.1.1. .spec
复制链接

28.5.1.2. .spec.requester
复制链接

28.5.1.3. .spec.requester.extra
复制链接

28.5.1.4. .spec.template
复制链接

28.5.1.5. .spec.template.parameters
复制链接

28.5.1.6. .spec.template.parameters[]
复制链接

28.5.1.7. .status
复制链接

28.5.1.8. .status.conditions
复制链接

28.5.1.9. .status.conditions[]
复制链接

28.5.1.10. .status.objects
复制链接

28.5.1.11. .status.objects[]
复制链接

28.5.2. API 端点
复制链接

28.5.2.1. /apis/template.openshift.io/v1/templateinstances
复制链接

28.5.2.2. /apis/template.openshift.io/v1/watch/templateinstances
复制链接

28.5.2.3. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances
复制链接

28.5.2.4. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances
复制链接

28.5.2.5. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}
复制链接

28.5.2.6. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances/{name}
复制链接

28.5.2.7. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}/status
复制链接

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

28.5. TemplateInstance [template.openshift.io/v1]

28.5.1. 规格复制链接链接已复制到粘贴板!

28.5.1.1. .spec复制链接链接已复制到粘贴板!

28.5.1.2. .spec.requester复制链接链接已复制到粘贴板!

28.5.1.3. .spec.requester.extra复制链接链接已复制到粘贴板!

28.5.1.4. .spec.template复制链接链接已复制到粘贴板!

28.5.1.5. .spec.template.parameters复制链接链接已复制到粘贴板!

28.5.1.6. .spec.template.parameters[]复制链接链接已复制到粘贴板!

28.5.1.7. .status复制链接链接已复制到粘贴板!

28.5.1.8. .status.conditions复制链接链接已复制到粘贴板!

28.5.1.9. .status.conditions[]复制链接链接已复制到粘贴板!

28.5.1.10. .status.objects复制链接链接已复制到粘贴板!

28.5.1.11. .status.objects[]复制链接链接已复制到粘贴板!

28.5.2. API 端点复制链接链接已复制到粘贴板!

28.5.2.1. /apis/template.openshift.io/v1/templateinstances复制链接链接已复制到粘贴板!

28.5.2.2. /apis/template.openshift.io/v1/watch/templateinstances复制链接链接已复制到粘贴板!

28.5.2.3. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances复制链接链接已复制到粘贴板!

28.5.2.4. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances复制链接链接已复制到粘贴板!

28.5.2.5. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}复制链接链接已复制到粘贴板!

28.5.2.6. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances/{name}复制链接链接已复制到粘贴板!

28.5.2.7. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}/status复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

28.5.1. 规格
复制链接

28.5.1.1. .spec
复制链接

28.5.1.2. .spec.requester
复制链接

28.5.1.3. .spec.requester.extra
复制链接

28.5.1.4. .spec.template
复制链接

28.5.1.5. .spec.template.parameters
复制链接

28.5.1.6. .spec.template.parameters[]
复制链接

28.5.1.7. .status
复制链接

28.5.1.8. .status.conditions
复制链接

28.5.1.9. .status.conditions[]
复制链接

28.5.1.10. .status.objects
复制链接

28.5.1.11. .status.objects[]
复制链接

28.5.2. API 端点
复制链接

28.5.2.1. /apis/template.openshift.io/v1/templateinstances
复制链接

28.5.2.2. /apis/template.openshift.io/v1/watch/templateinstances
复制链接

28.5.2.3. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances
复制链接

28.5.2.4. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances
复制链接

28.5.2.5. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}
复制链接

28.5.2.6. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances/{name}
复制链接

28.5.2.7. /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}/status
复制链接