ListImages - ImageService | API 参考 | Red Hat Advanced Cluster Security for Kubernetes 4.6

GET /v1/images

ListImages 返回所有与输入查询匹配的镜像。

描述

参数

查询参数

名称	必填	默认值
query	-	空
pagination.limit	-	空
pagination.offset	-	空
pagination.sortOption.field	-	空
pagination.sortOption.reversed	-	空
pagination.sortOption.aggregateBy.aggrFunc	-	未设置
pagination.sortOption.aggregateBy.distinct	-	空

名称

描述

必填

默认值

模式

query

空

pagination.limit

空

pagination.offset

空

pagination.sortOption.field

空

pagination.sortOption.reversed

空

pagination.sortOption.aggregateBy.aggrFunc

未设置

pagination.sortOption.aggregateBy.distinct

空

返回类型

V1ListImagesResponse

内容类型

application/json

响应

表 1. HTTP 响应代码
代码	消息	数据类型
200	成功的响应。	V1ListImagesResponse
0	意外的错误响应。	GooglerpcStatus

示例

常用对象引用

GooglerpcStatus

字段名称

必填

可空

类型

描述

格式

code

整数

int32

message

字符串

details

ProtobufAny 列表

ProtobufAny

Any 包含任意序列化的协议缓冲区消息以及描述序列化消息类型的 URL。

Protobuf 库提供支持，以实用程序函数或 Any 类型的其他生成方法的形式打包/解包 Any 值。

示例 1：在 C++ 中打包和解包消息。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

示例 2：在 Java 中打包和解包消息。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

protobuf 库提供的打包方法默认使用 'type.googleapis.com/full.type.name' 作为类型 URL，而解包方法只使用类型 URL 中最后一个 '/' 之后完全限定的类型名称，例如 "foo.bar.com/x/y.z" 将得到类型名称 "y.z"。

JSON 表示

Any 值的 JSON 表示使用反序列化嵌入消息的常规表示，并添加一个包含类型 URL 的额外字段 @type。示例

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

如果嵌入的消息类型是众所周知的并且具有自定义 JSON 表示，则该表示将被嵌入，除了 @type 字段外，还会添加一个包含自定义 JSON 的 value 字段。示例（对于消息 [google.protobuf.Duration][]）

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

字段名称必填可空类型描述格式

字段名称	必填	可空	类型	描述	格式
@type			字符串	一个唯一标识序列化协议缓冲区消息类型的 URL/资源名称。此字符串必须包含至少一个“/”字符。URL 路径的最后一部分必须表示类型的完全限定名称（如 `path/google.protobuf.Duration`）。名称应采用规范形式（例如，不接受前导“.”）。实际上，团队通常会将其预期在 Any 上下文中使用的所有类型预编译到二进制文件中。但是，对于使用方案 `http`、`https` 或无方案的 URL，可以选择设置一个类型服务器，该服务器将类型 URL 映射到消息定义，如下所示：* 如果未提供方案，则假定为 `https`。* 对 URL 的 HTTP GET 必须产生二进制格式的 [google.protobuf.Type][] 值，或产生错误。* 应用程序可以根据 URL 缓存查找结果，或将其预编译到二进制文件中以避免任何查找。因此，需要在类型更改时保持二进制兼容性。（使用版本化的类型名称来管理重大更改。）注意：此功能目前在官方 protobuf 版本中不可用，并且不用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月，没有广泛使用的类型服务器实现，也没有计划实现一个。除 `http`、`https`（或空方案）以外的其他方案可能会与实现特定的语义一起使用。

@type

字符串

一个唯一标识序列化协议缓冲区消息类型的 URL/资源名称。此字符串必须包含至少一个“/”字符。URL 路径的最后一部分必须表示类型的完全限定名称（如 path/google.protobuf.Duration）。名称应采用规范形式（例如，不接受前导“.”）。实际上，团队通常会将其预期在 Any 上下文中使用的所有类型预编译到二进制文件中。但是，对于使用方案 http、https 或无方案的 URL，可以选择设置一个类型服务器，该服务器将类型 URL 映射到消息定义，如下所示：* 如果未提供方案，则假定为 https。* 对 URL 的 HTTP GET 必须产生二进制格式的 [google.protobuf.Type][] 值，或产生错误。* 应用程序可以根据 URL 缓存查找结果，或将其预编译到二进制文件中以避免任何查找。因此，需要在类型更改时保持二进制兼容性。（使用版本化的类型名称来管理重大更改。）注意：此功能目前在官方 protobuf 版本中不可用，并且不用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月，没有广泛使用的类型服务器实现，也没有计划实现一个。除 http、https（或空方案）以外的其他方案可能会与实现特定的语义一起使用。

StorageListImage

字段名称

必填

可空

类型

描述

格式

字符串

名称

字符串

组件

整数

int32

cves

整数

int32

可修复的cves

整数

int32

创建时间

日期

日期时间

最后更新时间

日期

日期时间

优先级

字符串

int64

V1ListImagesResponse

字段名称

必填

可空

类型

描述

格式

镜像

StorageListImage 列表