This documentation is for a release that is no longer maintained.
You can select a different version or view all RHACS documentation.第 43 章 PodService
43.1. ExportPods 复制链接链接已复制到粘贴板!
GET /v1/export/pods
43.1.1. 描述 复制链接链接已复制到粘贴板!
43.1.2. 参数 复制链接链接已复制到粘贴板!
43.1.2.1. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| timeout | - | null | ||
| query | - | null |
43.1.3. 返回类型 复制链接链接已复制到粘贴板!
43.1.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
43.1.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。(流响应) | |
| 0 | 意外错误响应。 |
43.1.6. Samples 复制链接链接已复制到粘贴板!
43.1.7. 常规对象参考 复制链接链接已复制到粘贴板!
43.1.7.1. PodContainerInstanceList 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 实例 |
43.1.7.2. ProtobufAny 复制链接链接已复制到粘贴板!
any 包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 C++ 中解包信息。
示例 2:打包并解压缩 Java 消息。
Example 3: Pack and unpack a message in Python.
Example 3: Pack and unpack a message in Python.
Example 4: Pack and unpack a message in Go
Example 4: Pack and unpack a message in Go
默认情况下,protobuf 库提供的软件包方法将使用 'type.googleapis.com/full.type.name' 作为类型 URL,解包方法只使用类型 URL 中的完全限定类型名称,如 "foo.bar.com/x/x/y.z"。
43.1.7.2.1. JSON 表示 复制链接链接已复制到粘贴板!
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type。Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
如果嵌入式消息类型是知名且具有自定义 JSON 表示法,则该表示将被嵌入一个字段值,该值 除 @type 字段外还包含自定义 JSON。示例(用于消息 [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| typeUrl | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 | |||
| value | byte[] | 必须是上述指定类型的有效序列化协议缓冲。 | BYTE |
43.1.7.3. RuntimeError 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 错误 | 字符串 | ||||
| code | 整数 | int32 | |||
| message | 字符串 | ||||
| 详情 |
43.1.7.4. RuntimeStreamError 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| grpcCode | 整数 | int32 | |||
| httpCode | 整数 | int32 | |||
| message | 字符串 | ||||
| httpStatus | 字符串 | ||||
| 详情 |
43.1.7.5. StorageContainerInstance 复制链接链接已复制到粘贴板!
ContainerInstanceID 允许唯一标识集群中的容器。
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| instanceId | |||||
| containingPodId | 字符串 | 包含此容器实例的 pod (仅限kubernetes)。 | |||
| containerName | 字符串 | 容器名称。 | |||
| containerIps |
| 此容器的 IP 地址。 | |||
| started | Date | date-time | |||
| imageDigest | 字符串 | ||||
| finished | Date | 容器完成的时间(如果完成)。 | date-time | ||
| exitCode | 整数 | 容器的退出代码。仅在完成填充后有效。 | int32 | ||
| terminationReason | 字符串 | 容器终止的原因(如果完成)。 |
43.1.7.6. StorageContainerInstanceID 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| containerRuntime | UNKNOWN_CONTAINER_RUNTIME, DOCKER_CONTAINER_RUNTIME, CRIO_CONTAINER_RUNTIME, | ||||
| id | 字符串 | 容器 ID,特定于给定的运行时。 | |||
| node | 字符串 | 此容器运行的节点。 |
43.1.7.7. StorageContainerRuntime 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| UNKNOWN_CONTAINER_RUNTIME |
| DOCKER_CONTAINER_RUNTIME |
| CRIO_CONTAINER_RUNTIME |
43.1.7.8. StoragePod 复制链接链接已复制到粘贴板!
Pod 代表活跃部署中当前运行的 pod 或已删除的 pod 的信息。
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | ||||
| 名称 | 字符串 | ||||
| deploymentId | 字符串 | ||||
| namespace | 字符串 | ||||
| clusterId | 字符串 | ||||
| liveInstances | |||||
| terminatedInstances | 必须是一个列表列表,以便我们可以执行搜索查询(对于没有 <string, string>)的映射,每个容器名称都有一个存储桶(list)。 | ||||
| started | Date | Kubernetes 报告创建的时间。 | date-time |
43.1.7.9. StreamResultOfV1ExportPodResponse 复制链接链接已复制到粘贴板!
Stream result of v1ExportPodResponse
Stream result of v1ExportPodResponse
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| result | |||||
| 错误 |
43.1.7.10. V1ExportPodResponse 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| pod |