List
List retrieves a collection of resources based on the provided GVR and filters.
Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ”Define the version of the Connect protocol
Define the timeout, in ms
Request Body required
Section titled “Request Body required ”ListRequest defines the parameters for querying multiple resources.
object
The target Kubernetes cluster identifier.
Kubernetes API Group (e.g., “apps” for Deployments, "" for core resources like Pods).
Kubernetes API Version (e.g., “v1”).
Kubernetes API Resource name in plural (e.g., “pods”, “deployments”).
The namespace to query. If empty, the request may target all namespaces depending on cluster permissions.
A selector to restrict the list of returned objects by their labels.
A selector to restrict the list of returned objects by their fields (e.g., “status.phase=Running”).
The maximum number of items to return in a single page.
The continue token for pagination, retrieved from a previous ListResponse.
Responses
Section titled “ Responses ”Success
ListResponse contains the requested list of resources and pagination metadata.
object
The resourceVersion of the list, used to initiate a Watch from a specific point in time.
A token used to retrieve the next page of results. Empty if no more pages exist.
The estimated number of items remaining if pagination is used.
The list of resources found.
Resource represents a single Kubernetes object serialized as a JSON string.
default
Section titled “default ”Error
Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is no limit on the number of messages.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
object
A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.
The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.
Detailed error information.