(-- api-linter: core::0131::synonyms=disabled aip.dev/not-precedent: ReadMetrics is a custom method on a singleton resource, not a standard Get method. The "read" verb is appropriate for metrics collection operations. --) Reads current resource usage metrics for the sandbox environment.

Returns a snapshot of memory, CPU, and disk statistics collected at the time of the request.

If metrics cannot be collected, behavior depends on strict_mode: returns an error in strict mode, or partial metrics with zero values otherwise.

Authorization: Only the creator of the SandboxEngine is allowed to call this method.

get/v1/{name}/metrics:read

Request

Base URL
https://docs.h2o.ai (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/docs/v1/:name/metrics:read/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

Required. The name of the sandbox engine to read metrics from. Format: workspaces/{workspace}/sandboxEngines/{sandbox_engine}

Query parameters

strictModeboolean

Optional. If true, returns an error if metrics cannot be collected. If false or unspecified, returns partial metrics with zero values for unavailable metrics (default behavior for graceful degradation).

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.