SchemaPower Management

Schemas

View as Markdown

PowerUnit

Power measurement with value and unit.

NameTypeRequiredDescription
valuenumber (double)YesPower value (must be >= 0).
unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt

Interval

Time window for load target scheduling.

NameTypeRequiredDescription
start_timestring (date-time)NoISO 8601 UTC start time. Defaults to now if omitted.
end_timestring (date-time)NoISO 8601 UTC end time. If omitted, target remains in effect until replaced.

Strategy

Load shedding strategy configuration.

NameTypeRequiredDescription
best_effortbooleanNoIf true, DPS sheds load non-disruptively by adjusting DPM-enabled jobs. If the constraint cannot be satisfied, DPS sheds as much as possible and leaves the feed in a non-compliant state until workl…

LoadConstraint

Power limit constraint.

NameTypeRequiredDescription
valuenumber (double)YesTarget power limit (must be > 0).
unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt

FeedTags

List of feed identifiers this target applies to (e.g., [“main-a”]). If omitted or empty, the target applies to all feeds.

Type: array<string>

List of feed identifiers this target applies to (e.g., [“main-a”]). If omitted or empty, the target applies to all feeds.

ShedHint

Resource-level load shedding recommendation. Shed hints are non-binding advisory suggestions. The Infrastructure Management Agent MAY override or augment based on topology and operational criteria.

NameTypeRequiredDescription
resource_idstringYesIdentifier of the resource to throttle.
resource_typestringYesType of resource. Values: node, gpu, chassis
actionstringYesRecommended action. Values: power_cap, throttle, suspend
priorityintegerYesShedding priority (1 = shed first, higher = shed later).
target_powerobjectNoPower measurement with value and unit.
target_power.valuenumber (double)YesPower value (must be >= 0).
target_power.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt

EnforcementResult

Per-resource enforcement outcome.

NameTypeRequiredDescription
resource_idstringYesThe resource identifier from the shed hint.
resource_typestringYesType of resource. Values: node, gpu, chassis
requested_actionstringYesThe action that was requested. Values: power_cap, throttle, suspend
codestringYesPer-resource enforcement status. Values: applied, failed, skipped
messagestringNoDiagnostic message (e.g., “BMC unreachable after 3 retries”).
applied_powerobjectNoPower measurement with value and unit.
applied_power.valuenumber (double)YesPower value (must be >= 0).
applied_power.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt

FeedMetadata

Static feed configuration. Values don’t change during a curtailment event.

NameTypeRequiredDescription
power_minimumobjectYesPower measurement with value and unit.
power_minimum.valuenumber (double)YesPower value (must be >= 0).
power_minimum.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt
power_maximumobjectYesPower measurement with value and unit.
power_maximum.valuenumber (double)YesPower value (must be >= 0).
power_maximum.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt
default_constraintobjectYesPower measurement with value and unit.
default_constraint.valuenumber (double)YesPower value (must be >= 0).
default_constraint.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt

FeedTarget

A load target for a feed — active or scheduled.

NameTypeRequiredDescription
activebooleanYestrue if this target is currently being enforced.
load_constraintLoadConstraintYesPower limit constraint.
load_constraint.valuenumber (double)YesTarget power limit (must be > 0).
load_constraint.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt
intervalIntervalYesTime window for load target scheduling.
interval.start_timestring (date-time)NoISO 8601 UTC start time. Defaults to now if omitted.
interval.end_timestring (date-time)NoISO 8601 UTC end time. If omitted, target remains in effect until replaced.
strategyStrategyYesLoad shedding strategy configuration.
strategy.best_effortbooleanNoIf true, DPS sheds load non-disruptively by adjusting DPM-enabled jobs. If the constraint cannot be satisfied, DPS sheds as much as possible and leaves the feed in a non-compliant state until workl…
correlation_idstring (uuid)YesThe correlationid from the grid.loadtarget.set.v1 that created this target.

FeedState

Current power state for a single feed.

NameTypeRequiredDescription
metadataFeedMetadataYesStatic feed configuration. Values don’t change during a curtailment event.
metadata.power_minimumobjectYesPower measurement with value and unit.
metadata.power_minimum.valuenumber (double)YesPower value (must be >= 0).
metadata.power_minimum.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt
metadata.power_maximumobjectYesPower measurement with value and unit.
metadata.power_maximum.valuenumber (double)YesPower value (must be >= 0).
metadata.power_maximum.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt
metadata.default_constraintobjectYesPower measurement with value and unit.
metadata.default_constraint.valuenumber (double)YesPower value (must be >= 0).
metadata.default_constraint.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt
targetsarray<FeedTarget>YesAll load targets for this feed — active and scheduled. Empty array if no targets exist.
calculated_loadobjectYesPower measurement with value and unit.
calculated_load.valuenumber (double)YesPower value (must be >= 0).
calculated_load.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt
in_flightbooleanYestrue if the agent is actively transitioning between power levels.
eventstringYesThe trigger that caused this status to be published: - target_set — a grid.loadtarget.set.v1 was received and schedule updated - start_ramp_down — constraint applied or tightened, redistribution be…
power_event_start_timestring (date-time)NoISO 8601 UTC timestamp when the current power event began. null if no event is active.
compliantbooleanYestrue if the calculated load is within the active target constraint. true when no target is active.

BreachDetails

Breach identification and timing.

NameTypeRequiredDescription
breach_idstring (uuid)YesUnique identifier for this breach instance (UUIDv4). Remains the same across active → escalated → resolved for the same breach.
detected_atstring (date-time)YesISO 8601 UTC timestamp when the breach was first detected.
resolved_atstring (date-time)NoISO 8601 UTC timestamp when the breach was resolved. Present only when status is resolved.

BreachTarget

The load target being breached.

NameTypeRequiredDescription
correlation_idstring (uuid)YesThe correlationid from the grid.loadtarget.set.v1 that established this target.
load_constraintLoadConstraintYesPower limit constraint.
load_constraint.valuenumber (double)YesTarget power limit (must be > 0).
load_constraint.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt

SetLoadTargetData

Payload for grid.loadtarget.set.v1.

NameTypeRequiredDescription
targetsarray<object>YesList of load target requests.

PowerStateStatusData

Payload for grid.powerstate.status.v1.

NameTypeRequiredDescription
snapshot_timestring (date-time)YesISO 8601 UTC timestamp of this snapshot.
feedsmap<string, FeedState>YesMap of feed_tag to power state.

PowerBreachAlertData

Payload for grid.powerbreach.alert.v1.

NameTypeRequiredDescription
feed_tagstringYesThe feed identifier where the breach was detected.
statusstringYesBreach lifecycle state. Values: active, escalated, resolved
severitystringYesBreach severity level: - warning — excess between threshold and 20% over target - critical — excess exceeds 20% over target Values: warning, critical
breachBreachDetailsYesBreach identification and timing.
breach.breach_idstring (uuid)YesUnique identifier for this breach instance (UUIDv4). Remains the same across active → escalated → resolved for the same breach.
breach.detected_atstring (date-time)YesISO 8601 UTC timestamp when the breach was first detected.
breach.resolved_atstring (date-time)NoISO 8601 UTC timestamp when the breach was resolved. Present only when status is resolved.
targetBreachTargetYesThe load target being breached.
target.correlation_idstring (uuid)YesThe correlationid from the grid.loadtarget.set.v1 that established this target.
target.load_constraintLoadConstraintYesPower limit constraint.
target.load_constraint.valuenumber (double)YesTarget power limit (must be > 0).
target.load_constraint.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt
measured_loadobjectYesPower measurement with value and unit.
measured_load.valuenumber (double)YesPower value (must be >= 0).
measured_load.unitstringYesUnit of measurement. Values: watt, kilowatt, megawatt
shed_hintsarray<ShedHint>NoOrdered list of load shedding recommendations. Present when status is active or escalated. Absent when resolved.
infrastructure_actionsarray<string>YesOrdered list of escalating infrastructure-level actions. Empty array when status is resolved. Ordered from least to most disruptive.

PowerBreachEnforcementData

Payload for grid.powerbreach.enforcement.v1.

NameTypeRequiredDescription
breach_idstring (uuid)YesThe breach_id from the originating grid.powerbreach.alert.v1 event.
feed_tagstringYesThe feed identifier this enforcement applies to.
actionstringYesWhat phase of enforcement this represents. Values: applied, reverted
codestringYesOverall enforcement outcome. Values: success, partial, error
diag_msgstringNoHuman-readable diagnostic message.
resultsarray<EnforcementResult>YesPer-resource enforcement outcome.
timestampstring (date-time)YesISO 8601 UTC timestamp when enforcement completed.

JwsCompactSerialization

JWS Compact Serialization (RFC 7515) containing a signed payload. This is the WIRE FORMAT for the “data” field in CloudEvents messages.

Structure: BASE64URL(JWS Header).BASE64URL(Payload).BASE64URL(Signature)

JWS Header (example): { “alg”: “ES256”, “kid”: “<signing-key-id>” }

The payload, when verified, contains the JSON event data as defined by the message type schema.

Type: string

JWS Compact Serialization (RFC 7515) containing a signed payload. This is the WIRE FORMAT for the “data” field in CloudEvents messages.

Structure: BASE64URL(JWS Header).BASE64URL(Payload).BASE64URL(Signature)

JWS Header (example): { “alg”: “ES256”, “kid”: “<signing-key-id>” }

The payload, when verified, contains the JSON event data as defined by the message type schema.

BaseCloudEvent

Common CloudEvents 1.0.2 attributes shared by all events. Each event type extends this with a specific “data” field.

The “data” field is transmitted as a JWS compact serialization string. The plaintext JSON payload is signed with JWS (RFC 7515).

NameTypeRequiredDescription
specversionstringYesMUST be “1.0.2” — version of the CloudEvents specification. Must be 1.0.2.
idstring (uuid)YesMUST be a UUIDv4 — globally unique identifier for this event instance.
sourcestringYesStable URI identifying the publisher. Format: //grid/v1/<role>/<identifier>. Examples: - //grid/v1/isv/acme-energy - //grid/v1/poweragent/dps-prod - //grid/v1/infra/ima-prod
typestringYesEvent type following grid.<entity>.<action>.v1 or grid.<entity>.status.v1.
timestring (date-time)YesMUST be an ISO 8601 timestamp — time the event was created.
datacontenttypestringYesMUST be “application/json” — media type of the data payload. Must be application/json.
subjectstringYesResource subject identifying the domain object (e.g., loadtarget, powerstate, powerbreach).
correlationidstring (uuid)NoCloudEvents extension attribute. UUIDv4 correlation identifier. Generated by the ISV on grid.loadtarget.set.v1. Echoed by the Power Management Agent in status events for correlation.
traceparentstringYesREQUIRED per W3C Trace Context and CloudEvents Distributed Tracing Extension. Format: version-traceid-parentid-flags.
tracestatestringNoOPTIONAL per W3C Trace Context. Carries vendor-specific contextual information across tracing systems.

LoadTargetSetEvent

Common CloudEvents 1.0.2 attributes shared by all events. Each event type extends this with a specific “data” field.

The “data” field is transmitted as a JWS compact serialization string. The plaintext JSON payload is signed with JWS (RFC 7515).

NameTypeRequiredDescription
specversionstringYesMUST be “1.0.2” — version of the CloudEvents specification. Must be 1.0.2.
idstring (uuid)YesMUST be a UUIDv4 — globally unique identifier for this event instance.
sourcestringYesStable URI identifying the publisher. Format: //grid/v1/<role>/<identifier>. Examples: - //grid/v1/isv/acme-energy - //grid/v1/poweragent/dps-prod - //grid/v1/infra/ima-prod
typeanyYesMust be grid.loadtarget.set.v1.
timestring (date-time)YesMUST be an ISO 8601 timestamp — time the event was created.
datacontenttypestringYesMUST be “application/json” — media type of the data payload. Must be application/json.
subjectstringYesResource subject identifying the domain object (e.g., loadtarget, powerstate, powerbreach).
correlationidstring (uuid)NoCloudEvents extension attribute. UUIDv4 correlation identifier. Generated by the ISV on grid.loadtarget.set.v1. Echoed by the Power Management Agent in status events for correlation.
traceparentstringYesREQUIRED per W3C Trace Context and CloudEvents Distributed Tracing Extension. Format: version-traceid-parentid-flags.
tracestatestringNoOPTIONAL per W3C Trace Context. Carries vendor-specific contextual information across tracing systems.
dataJwsCompactSerialization or SetLoadTargetDataYesWIRE FORMAT: JWS compact serialization string (type: string). PLAINTEXT CONTENT: After JWS verification, the payload conforms to SetLoadTargetData schema (type: object).

PowerStateStatusEvent

Common CloudEvents 1.0.2 attributes shared by all events. Each event type extends this with a specific “data” field.

The “data” field is transmitted as a JWS compact serialization string. The plaintext JSON payload is signed with JWS (RFC 7515).

NameTypeRequiredDescription
specversionstringYesMUST be “1.0.2” — version of the CloudEvents specification. Must be 1.0.2.
idstring (uuid)YesMUST be a UUIDv4 — globally unique identifier for this event instance.
sourcestringYesStable URI identifying the publisher. Format: //grid/v1/<role>/<identifier>. Examples: - //grid/v1/isv/acme-energy - //grid/v1/poweragent/dps-prod - //grid/v1/infra/ima-prod
typeanyYesMust be grid.powerstate.status.v1.
timestring (date-time)YesMUST be an ISO 8601 timestamp — time the event was created.
datacontenttypestringYesMUST be “application/json” — media type of the data payload. Must be application/json.
subjectstringYesResource subject identifying the domain object (e.g., loadtarget, powerstate, powerbreach).
correlationidstring (uuid)NoCloudEvents extension attribute. UUIDv4 correlation identifier. Generated by the ISV on grid.loadtarget.set.v1. Echoed by the Power Management Agent in status events for correlation.
traceparentstringYesREQUIRED per W3C Trace Context and CloudEvents Distributed Tracing Extension. Format: version-traceid-parentid-flags.
tracestatestringNoOPTIONAL per W3C Trace Context. Carries vendor-specific contextual information across tracing systems.
dataJwsCompactSerialization or PowerStateStatusDataYesWIRE FORMAT: JWS compact serialization string (type: string). PLAINTEXT CONTENT: After JWS verification, the payload conforms to PowerStateStatusData schema (type: object).

PowerBreachAlertEvent

Common CloudEvents 1.0.2 attributes shared by all events. Each event type extends this with a specific “data” field.

The “data” field is transmitted as a JWS compact serialization string. The plaintext JSON payload is signed with JWS (RFC 7515).

NameTypeRequiredDescription
specversionstringYesMUST be “1.0.2” — version of the CloudEvents specification. Must be 1.0.2.
idstring (uuid)YesMUST be a UUIDv4 — globally unique identifier for this event instance.
sourcestringYesStable URI identifying the publisher. Format: //grid/v1/<role>/<identifier>. Examples: - //grid/v1/isv/acme-energy - //grid/v1/poweragent/dps-prod - //grid/v1/infra/ima-prod
typeanyYesMust be grid.powerbreach.alert.v1.
timestring (date-time)YesMUST be an ISO 8601 timestamp — time the event was created.
datacontenttypestringYesMUST be “application/json” — media type of the data payload. Must be application/json.
subjectstringYesResource subject identifying the domain object (e.g., loadtarget, powerstate, powerbreach).
correlationidstring (uuid)NoCloudEvents extension attribute. UUIDv4 correlation identifier. Generated by the ISV on grid.loadtarget.set.v1. Echoed by the Power Management Agent in status events for correlation.
traceparentstringYesREQUIRED per W3C Trace Context and CloudEvents Distributed Tracing Extension. Format: version-traceid-parentid-flags.
tracestatestringNoOPTIONAL per W3C Trace Context. Carries vendor-specific contextual information across tracing systems.
dataJwsCompactSerialization or PowerBreachAlertDataYesWIRE FORMAT: JWS compact serialization string (type: string). PLAINTEXT CONTENT: After JWS verification, the payload conforms to PowerBreachAlertData schema (type: object).

PowerBreachEnforcementEvent

Common CloudEvents 1.0.2 attributes shared by all events. Each event type extends this with a specific “data” field.

The “data” field is transmitted as a JWS compact serialization string. The plaintext JSON payload is signed with JWS (RFC 7515).

NameTypeRequiredDescription
specversionstringYesMUST be “1.0.2” — version of the CloudEvents specification. Must be 1.0.2.
idstring (uuid)YesMUST be a UUIDv4 — globally unique identifier for this event instance.
sourcestringYesStable URI identifying the publisher. Format: //grid/v1/<role>/<identifier>. Examples: - //grid/v1/isv/acme-energy - //grid/v1/poweragent/dps-prod - //grid/v1/infra/ima-prod
typeanyYesMust be grid.powerbreach.enforcement.v1.
timestring (date-time)YesMUST be an ISO 8601 timestamp — time the event was created.
datacontenttypestringYesMUST be “application/json” — media type of the data payload. Must be application/json.
subjectstringYesResource subject identifying the domain object (e.g., loadtarget, powerstate, powerbreach).
correlationidstring (uuid)NoCloudEvents extension attribute. UUIDv4 correlation identifier. Generated by the ISV on grid.loadtarget.set.v1. Echoed by the Power Management Agent in status events for correlation.
traceparentstringYesREQUIRED per W3C Trace Context and CloudEvents Distributed Tracing Extension. Format: version-traceid-parentid-flags.
tracestatestringNoOPTIONAL per W3C Trace Context. Carries vendor-specific contextual information across tracing systems.
dataJwsCompactSerialization or PowerBreachEnforcementDataYesWIRE FORMAT: JWS compact serialization string (type: string). PLAINTEXT CONTENT: After JWS verification, the payload conforms to PowerBreachEnforcementData schema (type: object).