Skip to content
OtterScale

SubResourceAction

POST
/otterscale.runtime.v1.RuntimeService/SubResourceAction

SubResourceAction performs a generic action on a Kubernetes subresource, such as KubeVirt VM start/stop/restart. The request is forwarded to kube-apiserver via impersonation, so RBAC is enforced automatically. Only PUT and POST methods are allowed.

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “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

Section titled “Request Body required ”
SubResourceActionRequest

SubResourceActionRequest defines the parameters for invoking a subresource action on any Kubernetes resource. This is designed for operations like KubeVirt VM start/stop/restart/migrate that use PUT or POST on a named subresource path.

object
cluster
cluster

The target Kubernetes cluster identifier.

string
group
group

Kubernetes API Group (e.g., “kubevirt.io”).

string
version
version

Kubernetes API Version (e.g., “v1”).

string
resource
resource

Kubernetes API Resource name in plural (e.g., “virtualmachines”).

string
namespace
namespace

The namespace of the resource.

string
name
name

The name of the resource.

string
subresource
subresource

The subresource to invoke (e.g., “start”, “stop”, “restart”).

string
method
method

The HTTP method for the subresource action. Only “PUT” and “POST” are allowed; DELETE and PATCH have dedicated RPCs.

string
body
body

Optional JSON body (e.g., KubeVirt StopOptions with gracePeriod).

string format: byte

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

SubResourceActionResponse

SubResourceActionResponse contains the optional response body from the subresource action.

object
result
result

The JSON response body returned by the API server, if any.

object
key
additional properties
One of:
null

default

Section titled “default ”

Error

Connect Error
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

Detailed error information.

object
key
additional properties
any
key
additional properties
any
key
additional properties
any