Red Hat SummitChapter 43. PodService
43.1. ExportPods
GET /v1/export/pods
43.1.1. Description
43.1.2. Parameters
43.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| timeout | - | null | ||
| query | - | null |
43.1.3. Return Type
43.1.4. Content Type
- application/json
43.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response.(streaming responses) | |
| 0 | An unexpected error response. |
43.1.6. Samples
43.1.7. Common object reference
43.1.7.1. PodContainerInstanceList
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| instances | List of StorageContainerInstance |
43.1.7.2. ProtobufAny
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}Example 2: Pack and unpack a message in 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 Gofoo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
43.1.7.2.1. JSON representation
The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| typeUrl | String |
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in | |||
| value | byte[] | Must be a valid serialized protocol buffer of the above specified type. | byte |
43.1.7.3. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
43.1.7.4. RuntimeStreamError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| grpcCode | Integer | int32 | |||
| httpCode | Integer | int32 | |||
| message | String | ||||
| httpStatus | String | ||||
| details | List of ProtobufAny |
43.1.7.5. StorageContainerInstance
ContainerInstanceID allows to uniquely identify a container within a cluster.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| instanceId | |||||
| containingPodId | String | The pod containing this container instance (kubernetes only). | |||
| containerName | String | Container name. | |||
| containerIps |
List of | The IP addresses of this container. | |||
| started | Date | date-time | |||
| imageDigest | String | ||||
| finished | Date | The finish time of the container, if it finished. | date-time | ||
| exitCode | Integer | The exit code of the container. Only valid when finished is populated. | int32 | ||
| terminationReason | String | The reason for the container’s termination, if it finished. |
43.1.7.6. StorageContainerInstanceID
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| containerRuntime | UNKNOWN_CONTAINER_RUNTIME, DOCKER_CONTAINER_RUNTIME, CRIO_CONTAINER_RUNTIME, | ||||
| id | String | The ID of the container, specific to the given runtime. | |||
| node | String | The node on which this container runs. |
43.1.7.7. StorageContainerRuntime
| Enum Values |
|---|
| UNKNOWN_CONTAINER_RUNTIME |
| DOCKER_CONTAINER_RUNTIME |
| CRIO_CONTAINER_RUNTIME |
43.1.7.8. StoragePod
Pod represents information for a currently running pod or deleted pod in an active deployment.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| deploymentId | String | ||||
| namespace | String | ||||
| clusterId | String | ||||
| liveInstances | List of StorageContainerInstance | ||||
| terminatedInstances | List of PodContainerInstanceList | Must be a list of lists, so we can perform search queries (does not work for maps that aren’t <string, string>) There is one bucket (list) per container name. | |||
| started | Date | Time Kubernetes reports the pod was created. | date-time |
43.1.7.9. StreamResultOfV1ExportPodResponse
Stream result of v1ExportPodResponse| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| result | |||||
| error |
43.1.7.10. V1ExportPodResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| pod |
43.2. GetPods
GET /v1/pods
GetPods returns the pods.
43.2.1. Description
43.2.2. Parameters
43.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
43.2.3. Return Type
43.2.4. Content Type
- application/json
43.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
43.2.6. Samples
43.2.7. Common object reference
43.2.7.1. PodContainerInstanceList
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| instances | List of StorageContainerInstance |
43.2.7.2. ProtobufAny
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}Example 2: Pack and unpack a message in 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 Gofoo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
43.2.7.2.1. JSON representation
The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| typeUrl | String |
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in | |||
| value | byte[] | Must be a valid serialized protocol buffer of the above specified type. | byte |
43.2.7.3. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
43.2.7.4. StorageContainerInstance
ContainerInstanceID allows to uniquely identify a container within a cluster.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| instanceId | |||||
| containingPodId | String | The pod containing this container instance (kubernetes only). | |||
| containerName | String | Container name. | |||
| containerIps |
List of | The IP addresses of this container. | |||
| started | Date | date-time | |||
| imageDigest | String | ||||
| finished | Date | The finish time of the container, if it finished. | date-time | ||
| exitCode | Integer | The exit code of the container. Only valid when finished is populated. | int32 | ||
| terminationReason | String | The reason for the container’s termination, if it finished. |
43.2.7.5. StorageContainerInstanceID
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| containerRuntime | UNKNOWN_CONTAINER_RUNTIME, DOCKER_CONTAINER_RUNTIME, CRIO_CONTAINER_RUNTIME, | ||||
| id | String | The ID of the container, specific to the given runtime. | |||
| node | String | The node on which this container runs. |
43.2.7.6. StorageContainerRuntime
| Enum Values |
|---|
| UNKNOWN_CONTAINER_RUNTIME |
| DOCKER_CONTAINER_RUNTIME |
| CRIO_CONTAINER_RUNTIME |
43.2.7.7. StoragePod
Pod represents information for a currently running pod or deleted pod in an active deployment.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| deploymentId | String | ||||
| namespace | String | ||||
| clusterId | String | ||||
| liveInstances | List of StorageContainerInstance | ||||
| terminatedInstances | List of PodContainerInstanceList | Must be a list of lists, so we can perform search queries (does not work for maps that aren’t <string, string>) There is one bucket (list) per container name. | |||
| started | Date | Time Kubernetes reports the pod was created. | date-time |
43.2.7.8. V1PodsResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| pods | List of StoragePod |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}