PortForward

POST

/otterscale.runtime.v1.RuntimeService/PortForward

PortForward opens a port-forward session to a pod and streams data back. Due to browser limitations, bidirectional streaming cannot be used; data to the pod is sent via the separate WritePortForward RPC.

Parameters

Header Parameters

Connect-Protocol-Version

required

Connect-Protocol-Version

Define the version of the Connect protocol

number

Allowed values: 1

Connect-Timeout-Ms

Connect-Timeout-Ms

Define the timeout, in ms

number

Request Body ^required

PortForwardRequest

PortForwardRequest defines the parameters for starting a port-forward session.

object

cluster

cluster

The target Kubernetes cluster identifier.

string

namespace

namespace

The namespace of the pod.

string

name

name

The name of the pod.

string

port

port

The container port to forward to.

integer format: int32

PortForwardRequest

PortForwardRequest defines the parameters for starting a port-forward session.

object

cluster

cluster

The target Kubernetes cluster identifier.

string

namespace

namespace

The namespace of the pod.

string

name

name

The name of the pod.

string

port

port

The container port to forward to.

integer format: int32

PortForwardRequest

PortForwardRequest defines the parameters for starting a port-forward session.

object

cluster

cluster

The target Kubernetes cluster identifier.

string

namespace

namespace

The namespace of the pod.

string

name

name

The name of the pod.

string

port

port

The container port to forward to.

integer format: int32

PortForwardRequest

PortForwardRequest defines the parameters for starting a port-forward session.

object

cluster

cluster

The target Kubernetes cluster identifier.

string

namespace

namespace

The namespace of the pod.

string

name

name

The name of the pod.

string

port

port

The container port to forward to.

integer format: int32

PortForwardRequest

PortForwardRequest defines the parameters for starting a port-forward session.

object

cluster

cluster

The target Kubernetes cluster identifier.

string

namespace

namespace

The namespace of the pod.

string

name

name

The name of the pod.

string

port

port

The container port to forward to.

integer format: int32

PortForwardRequest

PortForwardRequest defines the parameters for starting a port-forward session.

object

cluster

cluster

The target Kubernetes cluster identifier.

string

namespace

namespace

The namespace of the pod.

string

name

name

The name of the pod.

string

port

port

The container port to forward to.

integer format: int32

PortForwardRequest

PortForwardRequest defines the parameters for starting a port-forward session.

object

cluster

cluster

The target Kubernetes cluster identifier.

string

namespace

namespace

The namespace of the pod.

string

name

name

The name of the pod.

string

port

port

The container port to forward to.

integer format: int32

PortForwardRequest

PortForwardRequest defines the parameters for starting a port-forward session.

object

cluster

cluster

The target Kubernetes cluster identifier.

string

namespace

namespace

The namespace of the pod.

string

name

name

The name of the pod.

string

port

port

The container port to forward to.

integer format: int32

Responses

200

Success

PortForwardResponse

PortForwardResponse streams data received from the forwarded port.

object

sessionId

session_id

The session identifier, set only in the first response message. Subsequent WritePortForward calls must reference this ID.

string

data

data

Data received from the forwarded port on the pod.

string format: byte

PortForwardResponse

PortForwardResponse streams data received from the forwarded port.

object

sessionId

session_id

The session identifier, set only in the first response message. Subsequent WritePortForward calls must reference this ID.

string

data

data

Data received from the forwarded port on the pod.

string format: byte

PortForwardResponse

PortForwardResponse streams data received from the forwarded port.

object

sessionId

session_id

The session identifier, set only in the first response message. Subsequent WritePortForward calls must reference this ID.

string

data

data

Data received from the forwarded port on the pod.

string format: byte

PortForwardResponse

PortForwardResponse streams data received from the forwarded port.

object

sessionId

session_id

The session identifier, set only in the first response message. Subsequent WritePortForward calls must reference this ID.

string

data

data

Data received from the forwarded port on the pod.

string format: byte

PortForwardResponse

PortForwardResponse streams data received from the forwarded port.

object

sessionId

session_id

The session identifier, set only in the first response message. Subsequent WritePortForward calls must reference this ID.

string

data

data

Data received from the forwarded port on the pod.

string format: byte

PortForwardResponse

PortForwardResponse streams data received from the forwarded port.

object

sessionId

session_id

The session identifier, set only in the first response message. Subsequent WritePortForward calls must reference this ID.

string

data

data

Data received from the forwarded port on the pod.

string format: byte

PortForwardResponse

PortForwardResponse streams data received from the forwarded port.

object

sessionId

session_id

The session identifier, set only in the first response message. Subsequent WritePortForward calls must reference this ID.

string

data

data

Data received from the forwarded port on the pod.

string format: byte

PortForwardResponse

PortForwardResponse streams data received from the forwarded port.

object

sessionId

session_id

The session identifier, set only in the first response message. Subsequent WritePortForward calls must reference this ID.

string

data

data

Data received from the forwarded port on the pod.

string format: byte

default

Error

Connect Error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string

Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated

message

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.

string

details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

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

type

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.

string

value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary

debug

One of: discriminator: type

Any

Any

Detailed error information.

object

key

additional properties

any

key

additional properties

any

key

additional properties

any

Connect Error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string

Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated

message

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.

string

details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

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

type

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.

string

value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary

debug

One of: discriminator: type

Any

Any

Detailed error information.

object

key

additional properties

any

key

additional properties

any

key

additional properties

any

Connect Error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string

Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated

message

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.

string

details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

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

type

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.

string

value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary

debug

One of: discriminator: type

Any

Any

Detailed error information.

object

key

additional properties

any

key

additional properties

any

key

additional properties

any

Connect Error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string

Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated

message

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.

string

details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

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

type

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.

string

value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary

debug

One of: discriminator: type

Any

Any

Detailed error information.

object

key

additional properties

any

key

additional properties

any

key

additional properties

any

Connect Error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string

Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated

message

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.

string

details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

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

type

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.

string

value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary

debug

One of: discriminator: type

Any

Any

Detailed error information.

object

key

additional properties

any

key

additional properties

any

key

additional properties

any

Connect Error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string

Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated

message

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.

string

details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

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

type

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.

string

value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary

debug

One of: discriminator: type

Any

Any

Detailed error information.

object

key

additional properties

any

key

additional properties

any

key

additional properties

any

Connect Error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string

Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated

message

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.

string

details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

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

type

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.

string

value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary

debug

One of: discriminator: type

Any

Any

Detailed error information.

object

key

additional properties

any

key

additional properties

any

key

additional properties

any

Connect Error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string

Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated

message

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.

string

details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

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

type

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.

string

value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary

debug

One of: discriminator: type

Any

Any

Detailed error information.

object

key

additional properties

any

key

additional properties

any

key

additional properties

any