11.2. Image [image.openshift.io/v1]


描述
镜像是容器镜像和元数据的不可变表示。镜像通过取其内容的哈希值(元数据和内容)以及格式、内容或元数据的更改来命名,这会导致新名称。images 资源主要供集群管理员使用,以及集群镜像 registry 等集成 - 最终用户通过 imagestreamtags 或 imagestreamimages 资源访问镜像。虽然镜像元数据存储在 API 中,实现容器镜像 registry API 的任何集成都必须为原始清单数据、镜像配置和层内容提供自己的存储。
类型
对象
必填
  • dockerImageLayers

11.2.1. 规格

Expand
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

dockerImageConfig

字符串

DockerImageConfig 是一个 JSON blob,运行时用于设置容器。这是清单模式 v2 的一部分。

dockerImageLayers

array

dockerImageLayers 代表镜像中的层。如果镜像没有定义这些数据,则无法设置。

dockerImageLayers[]

对象

ImageLayer 代表镜像的一个层。有些镜像可能有多个层。有些内容可能没有。

dockerImageManifest

字符串

DockerImageManifest 是清单的原始 JSON

dockerImageManifestMediaType

字符串

DockerImageManifestMediaType 指定清单的 mediaType。这是清单模式 v2 的一部分。

dockerImageMetadata

RawExtension

dockerImageMetadata 包含有关此镜像的元数据

dockerImageMetadataVersion

字符串

dockerImageMetadataVersion 传递了对象的版本,如果为空默认为 "1.0"

dockerImageReference

字符串

dockerImageReference 是可用于拉取此镜像的字符串。

dockerImageSignatures

数组(字符串)

DockerImageSignatures 提供签名作为不透明 Blob。这是清单模式 v1 的一部分。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

 

签名

array

签名包含镜像的所有签名。

signatures[]

对象

镜像签名包含镜像签名。只要签名被信任,就可以验证镜像身份和其他声明。根据此信息,可以将可运行的镜像限制为匹配的集群范围策略。必要字段应由执行镜像验证的客户端解析。其他对象由服务器从签名的内容解析。它们只用于说明目的。

11.2.1.1. .dockerImageLayers

描述
dockerImageLayers 代表镜像中的层。如果镜像没有定义这些数据,则无法设置。
类型
array

11.2.1.2. .dockerImageLayers[]

描述
ImageLayer 代表镜像的一个层。有些镜像可能有多个层。有些内容可能没有。
类型
对象
必填
  • name
  • size
  • mediaType
Expand
属性类型描述

mediaType

字符串

引用对象的 MediaType。

name

字符串

底层存储定义的层名称。

size

整数

由底层存储定义的层大小(以字节为单位)。

11.2.1.3. .signatures

描述
签名包含镜像的所有签名。
类型
array

11.2.1.4. .signatures[]

描述
镜像签名包含镜像签名。只要签名被信任,就可以验证镜像身份和其他声明。根据此信息,可以将可运行的镜像限制为匹配的集群范围策略。必要字段应由执行镜像验证的客户端解析。其他对象由服务器从签名的内容解析。它们只用于说明目的。
类型
对象
必填
  • type
  • content
Expand
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

conditions

array

条件代表签名当前状态的最新可用影响。

conditions[]

对象

SignatureCondition 描述了特定探测时特定类型的镜像签名条件。

content

字符串

必需:不透明二进制字符串,即镜像签名。

created

time

如果指定,这是签名创建的时间。

imageIdentity

字符串

代表镜像身份的人类可读字符串。它可以是产品名称和版本,也可以是镜像拉取规格(如 "registry.access.redhat.com/rhel7/rhel:7.2")。

issuedBy

对象

SignatureIssuer 包含有关签名证书或密钥签发者的信息。

issuedTo

对象

签名Subject 包含有关创建签名的个人或实体的信息。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

 

signedClaims

对象(字符串)

包含来自签名的声明。

type

字符串

必需:描述存储的 blob 类型。

11.2.1.5. .signatures[].conditions

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

11.2.1.6. .signatures[].conditions[]

描述
SignatureCondition 描述了特定探测时特定类型的镜像签名条件。
类型
对象
必填
  • type
  • status
Expand
属性类型描述

lastProbeTime

time

检查条件最后一次的时间。

lastTransitionTime

time

条件从一个状态传输到另一个状态最后一次的时间。

message

字符串

人类可读的消息,指示最后一次转换的详细信息。

reason

字符串

(brief)条件最后一次转换的原因。

status

字符串

条件的状态,True, False, Unknown 之一。

type

字符串

签名条件类型,完成或失败。

11.2.1.7. .signatures[].issuedBy

描述
SignatureIssuer 包含有关签名证书或密钥签发者的信息。
类型
对象
Expand
属性类型描述

commonName

字符串

通用名称(如 openshift-signing-service)。

机构

字符串

机构名称。

11.2.1.8. .signatures[].issuedTo

描述
签名Subject 包含有关创建签名的个人或实体的信息。
类型
对象
必填
  • publicKeyID
Expand
属性类型描述

commonName

字符串

通用名称(如 openshift-signing-service)。

机构

字符串

机构名称。

publicKeyID

字符串

如果存在,它是属于验证镜像签名的主题的公钥的人类可读密钥 ID。它应至少包含 64 位公钥的指纹(例如 0x685ebe62bf278440)。

11.2.2. API 端点

可用的 API 端点如下:

  • /apis/image.openshift.io/v1/images

    • DELETE :删除镜像的集合
    • GET: 列出或监视类型为 Image 的对象
    • POST :创建镜像
  • /apis/image.openshift.io/v1/watch/images

    • GET: 观察对镜像列表的单个更改。已弃用:改为使用 'watch' 参数和列表操作。
  • /apis/image.openshift.io/v1/images/{name}

    • DELETE :删除镜像
    • GET :读取指定的镜像
    • PATCH :部分更新指定的镜像
    • PUT :替换指定的镜像
  • /apis/image.openshift.io/v1/watch/images/{name}

    • GET: 观察对类型为 Image 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。

11.2.2.1. /apis/image.openshift.io/v1/images

Expand
表 11.1. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除镜像集合
Expand
表 11.2. 查询参数
参数类型描述

继续

字符串

从服务器检索更多结果时,应设置 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
表 11.3. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
Expand
表 11.4. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出或监视类型为 Image 的对象
Expand
表 11.5. 查询参数
参数类型描述

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
表 11.6. HTTP 响应
HTTP 代码响应正文

200 - OK

ImageList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建镜像
Expand
表 11.7. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 11.8. 主体参数
参数类型描述

正文(body)

Image 模式

 
Expand
表 11.9. HTTP 响应
HTTP 代码响应正文

200 - OK

Image 模式

201 - Created

Image 模式

202 - Accepted

Image 模式

401 - Unauthorized

11.2.2.2. /apis/image.openshift.io/v1/watch/images

Expand
表 11.10. 全局查询参数
参数类型描述

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
描述
观察对镜像列表的单个更改。已弃用:改为使用 'watch' 参数以及 list 操作。
Expand
表 11.11. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

11.2.2.3. /apis/image.openshift.io/v1/images/{name}

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

name

字符串

镜像的名称

Expand
表 11.13. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除镜像
Expand
表 11.14. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。

propagationPolicy

字符串

是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。

Expand
表 11.15. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
Expand
表 11.16. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的镜像
Expand
表 11.17. HTTP 响应
HTTP 代码响应正文

200 - OK

Image 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的镜像
Expand
表 11.18. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段,但对于非应用补丁类型(JsonPatch、MergePatch、OptMergePatch)是可选的。

force

布尔值

强制将"强制"应用请求。这意味着用户会重新清空由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。

Expand
表 11.19. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 11.20. HTTP 响应
HTTP 代码响应正文

200 - OK

Image 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的镜像
Expand
表 11.21. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 11.22. 主体参数
参数类型描述

正文(body)

Image 模式

 
Expand
表 11.23. HTTP 响应
HTTP 代码响应正文

200 - OK

Image 模式

201 - Created

Image 模式

401 - Unauthorized

11.2.2.4. /apis/image.openshift.io/v1/watch/images/{name}

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

name

字符串

镜像的名称

Expand
表 11.25. 全局查询参数
参数类型描述

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
描述
观察对类型为 Image 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
Expand
表 11.26. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat