OpenShift 文档正在迁移，很快将只在 docs.redhat.com（所有 Red Hat 产品文档的中心）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

GetPods

GET /v1/pods

GetPods 返回 Pod。

描述

参数

查询参数

名称 描述 必填 默认值 模式

查询

-

空

pagination.limit

-

空

pagination.offset

-

空

pagination.sortOption.field

-

空

pagination.sortOption.reversed

-

空

pagination.sortOption.aggregateBy.aggrFunc

-

未设置

pagination.sortOption.aggregateBy.distinct

-

空

返回类型

V1PodsResponse

内容类型

  • application/json

响应

表 1. HTTP 响应代码
代码 消息 数据类型

200

成功的响应。

V1PodsResponse

0

意外的错误响应。

GooglerpcStatus

示例

常用对象引用

GooglerpcStatus

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

code

整数

int32

message

字符串

details

ProtobufAny 列表 ProtobufAny

PodContainerInstanceList

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

instances

StorageContainerInstance 列表 StorageContainerInstance

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 表示，则该表示将被嵌入，并添加一个包含自定义 JSON 的字段 value 以及 @type 字段。示例（对于消息 [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（或空方案）以外的方案。

StorageContainerInstance

ContainerInstanceID 用于唯一标识集群中的容器。

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

instanceId

StorageContainerInstanceID

containingPodId

字符串

包含此容器实例的 Pod（仅限 Kubernetes）。

containerName

字符串

容器名称。

containerIps

string 列表

此容器的 IP 地址。

started

日期

日期时间

imageDigest

字符串

finished

日期

容器的完成时间（如果已完成）。

日期时间

exitCode

整数

容器的退出代码。仅在填充 finished 时有效。

int32

terminationReason

字符串

容器终止的原因（如果已完成）。

StorageContainerInstanceID

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

containerRuntime

StorageContainerRuntime

UNKNOWN_CONTAINER_RUNTIME, DOCKER_CONTAINER_RUNTIME, CRIO_CONTAINER_RUNTIME,

id

字符串

容器的 ID，特定于给定的运行时。

node

字符串

此容器运行所在的节点。

StorageContainerRuntime

枚举值

UNKNOWN_CONTAINER_RUNTIME

DOCKER_CONTAINER_RUNTIME

CRIO_CONTAINER_RUNTIME

StoragePod

Pod 代表活动部署中当前正在运行的 Pod 或已删除的 Pod 的信息。

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

id

字符串

name

字符串

deploymentId

字符串

namespace

字符串

clusterId

字符串

liveInstances

StorageContainerInstance 列表 StorageContainerInstance

terminatedInstances

PodContainerInstanceList 列表

必须是列表的列表，以便我们可以执行搜索查询（不适用于不是 <string, string> 的映射）。每个容器名称都有一个桶（列表）。

started

日期

Kubernetes 报告 Pod 创建时间的时间。

日期时间

V1PodsResponse

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

pods

StoragePod 列表