主页
产品
Red Hat Quay
3.2
测试 REST
9.7. ConsoleQuickStart [console.openshift.io/v1]

9.7. ConsoleQuickStart [console.openshift.io/v1]

描述

ConsoleQuickStart 是通过 OpenShift Web 控制台中各种工作流进行 guiding 用户的扩展。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

对象

必填

spec

9.7.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_v2`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	ConsoleQuickStartSpec 是所需的快速启动配置。

9.7.1.1. .spec
复制链接

描述

ConsoleQuickStartSpec 是所需的快速启动配置。

类型

对象

必填

description
displayName
durationMinutes
简介
tasks

Expand

属性	类型	描述
`accessReviewResources`	`array`	accessReviewResources 包含用户访问要根据其查看的资源列表，以便用户完成快速入门。如果任何访问检查失败，快速入门将会被隐藏。
`accessReviewResources[]`	`对象`	resourceAttributes 包括可用于 Authorizer 接口的资源请求的授权属性
`最后`	`字符串`	最后总结快速入门并推荐后续步骤。（包括标记）
`description`	`字符串`	description 是快速入门的描述（包括标记）
`displayName`	`字符串`	displayName 是 Quick Start 的显示名称。
`durationMinutes`	`整数`	durationMinutes 描述了完成快速入门所需的时间大约需要多少分钟。
`icon`	`字符串`	icon 是一个 base64 编码镜像，它将显示在 Quick Start 显示名称旁边。这个图标应该是用于轻松缩放的向量镜像。图标的大小应该是 40x40。
`简介`	`字符串`	简介描述了快速入门的目的（包括标记）
`nextQuickStart`	`数组（字符串）`	nextQuickStart 是以下快速入门列表，建议用户尝试。
`先决条件`	`数组（字符串）`	先决条件包含执行快速入门前需要满足的所有先决条件。（包括标记）
`tags`	`数组（字符串）`	标签是描述快速入门的字符串列表。
`tasks`	`array`	任务是用户必须执行的步骤列表来完成快速入门。
`tasks[]`	`对象`	ConsoleQuickStartTask 是快速入门中的一个步骤。

9.7.1.2. .spec.accessReviewResources
复制链接

描述: accessReviewResources 包含用户访问要根据其查看的资源列表，以便用户完成快速入门。如果任何访问检查失败，快速入门将会被隐藏。
类型: array

9.7.1.3. .spec.accessReviewResources[]
复制链接

描述: resourceAttributes 包括可用于 Authorizer 接口的资源请求的授权属性
类型: 对象

Expand

属性	类型	描述
`group`	`字符串`	group 是资源的 API 组。"Demo" 表示所有。
`name`	`字符串`	name 是为"get"请求的资源的名称，或者针对"delete"删除。"" （空）意味着所有。
`namespace`	`字符串`	namespace 是正在请求的操作的命名空间。目前，对于集群范围的资源 "" （空）没有命名空间和所有命名空间 "" （空）与命名空间范围资源不同，对于集群范围的资源 "" （空）意味着，来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围的资源"all"是"all"
`resource`	`字符串`	Resource 是现有资源类型之一。"Demo" 代表所有资源。
`子资源`	`字符串`	子资源是现有资源类型之一。"" 表示 none。
`verb`	`字符串`	verb 是一个 kubernetes 资源 API 动词，例如 get, list, watch, create, update, delete, proxy. " the all"。
`version`	`字符串`	version 是资源的 API 版本。"Demo" 代表所有。

9.7.1.4. .spec.tasks
复制链接

描述: 任务是用户必须执行的步骤列表来完成快速入门。
类型: array

9.7.1.5. .spec.tasks[]
复制链接

描述

ConsoleQuickStartTask 是快速入门中的一个步骤。

类型

对象

必填

description
title

Expand

属性	类型	描述
`description`	`字符串`	description 描述了完成任务所需的步骤。（包括标记）
`review`	`对象`	review 包含用于验证任务已完成的说明。用户将选择"是"或"否"。使用单选按钮，这表示步骤是否已成功完成。
`summary`	`对象`	Summary 包含有关传递步骤的信息。
`title`	`字符串`	标题描述了任务，并显示为步骤标题。

9.7.1.6. .spec.tasks[].review
复制链接

描述

review 包含用于验证任务已完成的说明。用户将选择"是"或"否"。使用单选按钮，这表示步骤是否已成功完成。

类型

对象

必填

failedTaskHelp
指令

Expand

属性	类型	描述
`failedTaskHelp`	`字符串`	failedTaskHelp 包含失败任务检查的建议，显示在任务末尾。（包括标记）
`指令`	`字符串`	指令包含用户需要执行的步骤，以便在执行任务后验证其工作。（包括标记）

9.7.1.7. .spec.tasks[].summary
复制链接

描述

Summary 包含有关传递步骤的信息。

类型

对象

必填

失败
success

Expand

属性	类型	描述
`失败`	`字符串`	失败简要描述了失败的通过任务。（包括标记）
`success`	`字符串`	success 描述了 succesfully passed 任务。

9.7.2. API 端点
复制链接

可用的 API 端点如下：

/apis/console.openshift.io/v1/consolequickstarts
- DELETE ：删除 ConsoleQuickStart 的集合
- GET: 列出 ConsoleQuickStart 类型的对象
- POST ：创建一个 ConsoleQuickStart
/apis/console.openshift.io/v1/consolequickstarts/{name}
- DELETE ：删除 ConsoleQuickStart
- GET: 读取指定的 ConsoleQuickStart
- PATCH ：部分更新指定的 ConsoleQuickStart
- PUT ：替换指定的 ConsoleQuickStart

9.7.2.1. /apis/console.openshift.io/v1/consolequickstarts
复制链接

Expand

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

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

Expand

表 9.147. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 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

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

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

Expand

表 9.149. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 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

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

HTTP 方法: POST
描述: 创建 ConsoleQuickStart

Expand

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

Expand

表 9.152. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleQuickStart` schema

Expand

表 9.153. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleQuickStart` schema
201 - Created	`ConsoleQuickStart` schema
202 - Accepted	`ConsoleQuickStart` schema
401 - Unauthorized	空

9.7.2.2. /apis/console.openshift.io/v1/consolequickstarts/{name}
复制链接

Expand

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

Expand

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

HTTP 方法: DELETE
描述: 删除 ConsoleQuickStart

Expand

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

Expand

表 9.157. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions_v2` schema

Expand

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

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

Expand

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

Expand

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

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

Expand

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

Expand

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

Expand

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

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

Expand

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

Expand

表 9.165. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleQuickStart` schema

Expand

表 9.166. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleQuickStart` schema
201 - Created	`ConsoleQuickStart` schema
401 - Unauthorized	空

返回顶部

9.7. ConsoleQuickStart [console.openshift.io/v1]

9.7.1. 规格
复制链接

9.7.1.1. .spec
复制链接

9.7.1.2. .spec.accessReviewResources
复制链接

9.7.1.3. .spec.accessReviewResources[]
复制链接

9.7.1.4. .spec.tasks
复制链接

9.7.1.5. .spec.tasks[]
复制链接

9.7.1.6. .spec.tasks[].review
复制链接

9.7.1.7. .spec.tasks[].summary
复制链接

9.7.2. API 端点
复制链接

9.7.2.1. /apis/console.openshift.io/v1/consolequickstarts
复制链接

9.7.2.2. /apis/console.openshift.io/v1/consolequickstarts/{name}
复制链接

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

9.7. ConsoleQuickStart [console.openshift.io/v1]

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

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

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

9.7.1.3. .spec.accessReviewResources[]复制链接链接已复制到粘贴板!

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

9.7.1.5. .spec.tasks[]复制链接链接已复制到粘贴板!

9.7.1.6. .spec.tasks[].review复制链接链接已复制到粘贴板!

9.7.1.7. .spec.tasks[].summary复制链接链接已复制到粘贴板!

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

9.7.2.1. /apis/console.openshift.io/v1/consolequickstarts复制链接链接已复制到粘贴板!

9.7.2.2. /apis/console.openshift.io/v1/consolequickstarts/{name}复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

9.7.1. 规格
复制链接

9.7.1.1. .spec
复制链接

9.7.1.2. .spec.accessReviewResources
复制链接

9.7.1.3. .spec.accessReviewResources[]
复制链接

9.7.1.4. .spec.tasks
复制链接

9.7.1.5. .spec.tasks[]
复制链接

9.7.1.6. .spec.tasks[].review
复制链接

9.7.1.7. .spec.tasks[].summary
复制链接

9.7.2. API 端点
复制链接

9.7.2.1. /apis/console.openshift.io/v1/consolequickstarts
复制链接

9.7.2.2. /apis/console.openshift.io/v1/consolequickstarts/{name}
复制链接