Skip to main content

Temporal Cloud operations reference

View Markdown
info

For the OPS limit itself and how it scales, see Operations per second. For the primary rate limit on a Namespace, see Actions and Capacity Modes.

Temporal Cloud rate limits each Namespace using three measures. Actions per second (APS) is the primary limit, and Capacity Modes are expressed in APS. Requests per second (RPS) and operations per second (OPS) are lower-level limits that protect the underlying services.

An operation is any work that puts load on Temporal Server, whether a user starts it directly or Temporal runs it in the background on the user's behalf. Visibility queries are the exception. They pass through Temporal Server, but most of their load falls on the Visibility store, so they have their own rate limits separate from OPS.

Each operation in the table lists the following:

  • Description: What the operation does.
  • Priority: Foreground operations have higher priority than background operations.
  • Effect of throttling: What you observe when Temporal Cloud throttles the operation.
Operation ↕Description ↕Priority ↕Effect of throttling ↕
ActivityRetryTimerInternal Timer that schedules the retry of a failed Activity Execution.BackgroundThe Activity retry is delayed.
ActivityTimeoutMarks an Activity as timed out when its deadline passes.BackgroundThe Activity Task stays in flight longer and the timeout is delayed, which also delays any retry.
CompleteNexusOperationCompletes a Nexus Operation after the Worker responds.ForegroundCleanup and completion of the Nexus Operation are delayed.
CreateScheduleCreates a Schedule.ForegroundThe Client receives a ResourceExhausted error, then backs off and retries.
CreateWorkflowRuleAdds a Worker Versioning rule for a Task Queue.ForegroundEnforcement of the rule is delayed.
DeleteScheduleDeletes a Schedule.ForegroundThe Schedule can keep running Actions briefly.
DeleteWorkerDeploymentDeletes a Worker Deployment record.ForegroundStale Worker Deployment metadata remains longer.
DeleteWorkerDeploymentVersionDeletes one version from a Worker Deployment.ForegroundThe version appears valid until the task is processed.
DeleteWorkflowExecutionPermanently deletes a Workflow Execution's Event History and state.ForegroundThe data stays visible and storage is freed later.
DeleteWorkflowRuleDeletes a Worker Versioning rule.ForegroundThe rule stays in effect until the task is processed.
DeprecateNamespaceMarks a Namespace as deprecated.ForegroundClients still see the Namespace as active.
DescribeBatchOperationReturns metadata for a batch operation.ForegroundReads from the Web UI and admin tools take longer.
DescribeDeploymentReturns details for a Worker Deployment.ForegroundThe response is delayed.
DescribeNamespaceReturns a Namespace's configuration.ForegroundThe response is delayed.
DescribeScheduleReturns a Schedule's current state.ForegroundThe response is delayed.
DescribeTaskQueueReturns statistics and configuration for a Task Queue.ForegroundMonitoring dashboards lag.
DescribeWorkerDeploymentReturns details for a specific Worker Deployment.ForegroundThe response is delayed.
DescribeWorkerDeploymentVersionReturns details for a specific Worker Deployment Version.ForegroundThe response is delayed.
DescribeWorkflowExecutionReturns summary information for a Workflow Execution.ForegroundThe Temporal CLI and diagnostic tools wait longer.
DescribeWorkflowRuleReturns a Worker Versioning rule.ForegroundThe response is delayed.
DispatchByEndpointRoutes a Nexus Task to Workers by Nexus Endpoint name.ForegroundNexus Task routing latency increases.
DispatchByNamespaceAndTaskQueueRoutes a Nexus Task to Workers by Namespace and Task Queue.ForegroundThe Nexus Task starts later.
ExecuteMultiOperationRuns several operations as one request, such as Update-With-Start.ForegroundThe request is delayed.
GetClusterInfoReturns the Temporal Service's capabilities and versions.ForegroundTemporal CLI and API calls take longer.
GetCurrentDeploymentReturns the current Worker Deployment.ForegroundRollout tooling sees stale information.
GetSearchAttributesLists custom Search Attribute definitions.ForegroundSDK and Temporal CLI calls wait longer.
GetSystemInfoReturns the Temporal Service's build and feature information.ForegroundThe response is delayed.
GetWorkerBuildIdCompatibilityReturns the Build ID compatibility sets for a Task Queue.ForegroundRollout decisions wait longer.
GetWorkerVersioningRulesLists Worker Versioning rules.ForegroundThe response is delayed.
GetWorkflowExecutionHistoryStreams a Workflow Execution's Event History in order.ForegroundEvent History loads slowly in the Web UI and the Temporal CLI.
GetWorkflowExecutionHistoryReverseStreams a Workflow Execution's Event History in reverse order.ForegroundEvent History loads slowly in the Web UI and the Temporal CLI.
ListNamespacesLists all Namespaces.ForegroundEach page of results in the Web UI and the Temporal CLI loads more slowly.
ListScheduleMatchingTimesReturns the upcoming times a Schedule will run.ForegroundThe preview takes longer.
ListTaskQueuePartitionsLists the partitions of a Task Queue.ForegroundPartition information lags.
ListWorkerDeploymentsLists all Worker Deployments.ForegroundThe response is delayed.
ListWorkflowRulesLists all Worker Versioning rules.ForegroundThe response is delayed.
PatchScheduleApplies a one-time change to a Schedule, such as triggering it or backfilling Actions.ForegroundThe change takes effect later.
PauseActivityPauses a running Activity.ForegroundThe Activity keeps running until the pause task is processed.
PollActivityTaskQueueWorker long-poll for Activity Tasks.ForegroundThe poller receives a ResourceExhausted error, then backs off and retries, which slows Activity Task processing.
PollNexusTaskQueueWorker long-poll for Nexus Tasks.ForegroundThe poller receives a ResourceExhausted error, then backs off and retries, which slows Nexus Task processing.
PollWorkflowExecutionUpdateClient poll for the result of a Workflow Update.ForegroundThe Client waits longer for the result.
PollWorkflowTaskQueueWorker long-poll for Workflow Tasks.ForegroundThe poller receives a ResourceExhausted error, then backs off and retries, which slows Workflow progress.
QueryWorkflowSends a Query to read a Workflow Execution's state.ForegroundThe caller receives the result later.
RecordActivityTaskHeartbeatRecords an Activity Heartbeat by task token.ForegroundHeartbeats are delayed, which can cause a Heartbeat Timeout even though the Activity is still running.
RecordActivityTaskHeartbeatByIdRecords an Activity Heartbeat by Workflow ID, Run ID, and Activity ID.ForegroundHeartbeats are delayed, which can cause a Heartbeat Timeout even though the Activity is still running.
RequestCancelWorkflowExecutionRequests cancellation of a Workflow Execution.ForegroundThe cancellation reaches the Workflow later.
ResetActivityRestarts an Activity from the beginning.ForegroundThe Activity keeps running until the reset takes effect.
ResetStickyTaskQueueClears a Workflow Execution's Sticky Execution affinity to a Worker.ForegroundWorkflow Tasks stay bound to the previous Worker longer.
ResetWorkflowExecutionResets a Workflow Execution to an earlier point in its Event History and starts a new run from there.ForegroundThe Workflow Execution continues from its current state until the reset takes effect.
RespondActivityTaskCanceledWorker confirms that an Activity was canceled, by task token.ForegroundThe Workflow waits longer for the confirmation.
RespondActivityTaskCanceledByIdWorker confirms that an Activity was canceled, by Activity ID.ForegroundThe Workflow waits longer for the confirmation.
RespondActivityTaskCompletedWorker returns an Activity result, by task token.ForegroundThe Workflow's next step is delayed.
RespondActivityTaskCompletedByIdWorker returns an Activity result, by Activity ID.ForegroundThe Workflow's next step is delayed.
RespondActivityTaskFailedWorker reports an Activity failure, by task token.ForegroundRetries and compensation logic are delayed.
RespondActivityTaskFailedByIdWorker reports an Activity failure, by Activity ID.ForegroundRetries and compensation logic are delayed.
RespondNexusTaskCompletedWorker returns a successful Nexus Task result.ForegroundCompletion of the Nexus call is delayed.
RespondNexusTaskFailedWorker reports a Nexus Task failure.ForegroundError handling is delayed.
RespondQueryTaskCompletedWorker returns a Query result.ForegroundThe Client waits longer for the result.
RespondWorkflowTaskCompletedWorker returns new Commands after completing a Workflow Task.ForegroundThe Temporal Service applies the Commands later.
RespondWorkflowTaskFailedWorker reports a Workflow Task failure.ForegroundThe retry of the Workflow Task is delayed.
SetCurrentDeploymentSets the current Worker Deployment for a Task Queue.ForegroundThe switch to the new version is delayed.
SetCurrentDeploymentVersionSets the current Build ID version.ForegroundThe rollout is held.
SetWorkerDeploymentCurrentVersionSets the current version of a Worker Deployment.ForegroundThe Worker Deployment stays on the previous version.
SetWorkerDeploymentRampingVersionSets the ramp percentage for a new Worker Deployment Version.ForegroundThe ramp is paused.
ShutdownWorkerNotifies the Temporal Service that a Worker is shutting down.ForegroundThe Worker keeps running longer.
SignalWithStartWorkflowExecutionSends a Signal to a running Workflow Execution, or starts a new one and sends the Signal.ForegroundThe Signal and the start are both delayed.
SignalWorkflowExecutionSends a Signal to a Workflow Execution.ForegroundThe Signal arrives later.
StartBatchOperationStarts a batch operation, such as resetting or terminating many Workflow Executions.ForegroundThe batch operation starts later.
StartWorkflowExecutionStarts a new Workflow Execution.ForegroundStart latency increases.
StateMachineOutboundSends outbound requests generated by the Temporal Service's internal state machines.BackgroundOutbound requests queue up, which delays their side effects.
StateMachineTimerFires Timers managed by the Temporal Service's internal state machines.BackgroundTimed events fire later.
StopBatchOperationStops a batch operation.ForegroundThe batch operation keeps running until the task is processed.
TerminateWorkflowExecutionTerminates a Workflow Execution.ForegroundThe Workflow Execution keeps running longer.
TransferActivityTaskAdds an Activity Task to its Task Queue for a Worker to pick up.BackgroundScheduling of the Activity Task is delayed.
TransferCancelExecutionDelivers a cancellation request to the target Workflow Execution.BackgroundThe target Workflow Execution receives the cancellation later.
TransferCloseExecutionCloses a running Workflow Execution.BackgroundThe Workflow Execution stays open longer.
TransferResetWorkflowStarts a reset of a Workflow Execution.BackgroundThe reset is delayed and the Workflow Execution continues from its current state.
TransferSignalExecutionDelivers a Signal to another Workflow Execution.BackgroundThe Signal arrives later, which delays the logic that depends on it.
TransferStartChildExecutionStarts a Child Workflow Execution.BackgroundThe Child Workflow Execution starts later.
TransferWorkflowTaskAdds a Workflow Task to its Task Queue for a Worker to pick up.BackgroundScheduling of the Workflow Task is delayed.
TriggerWorkflowRuleManually triggers a Worker Versioning rule.ForegroundThe rule takes effect later.
UnpauseActivityResumes a paused Activity.ForegroundThe Activity stays paused longer.
UpdateActivityOptionsChanges the Retry Policy or timeouts of a running Activity.ForegroundThe new options take effect later.
UpdateScheduleChanges the configuration of a Schedule.ForegroundThe new configuration takes effect later.
UpdateWorkerDeploymentVersionMetadataUpdates the metadata on a Worker Deployment Version.ForegroundThe metadata stays out of date longer.
UpdateWorkflowExecutionSends a Workflow Update to a Workflow Execution.ForegroundThe Update is accepted later.
UpdateWorkflowExecutionOptionsChanges the options of a Workflow Execution.ForegroundThe changes take effect later.
UserTimerFires a Timer created in Workflow code.BackgroundThe Timer fires later, including Timers created by a Workflow sleep.
VisibilityCloseExecutionUpdates the Visibility record of a Workflow Execution when it closes.BackgroundList results show the Workflow Execution as open until the task is processed.
VisibilityStartExecutionCreates the Visibility record for a new Workflow Execution.BackgroundThe Workflow Execution is missing from lists in the Web UI and the Temporal CLI until the task is processed.
VisibilityUpsertExecutionUpdates the Search Attributes in a Workflow Execution's Visibility record.BackgroundThe Search Attribute changes appear later.
WorkflowBackoffTimerTimer that delays the start of a Workflow retry or Continue-As-New run according to its backoff.BackgroundThe Workflow Execution starts later than the backoff specifies.
WorkflowExecutionTimeoutEnforces the Workflow Execution Timeout.BackgroundThe Workflow Execution Timeout fires later.
WorkflowRunTimeoutEnforces the Workflow Run Timeout.BackgroundThe Workflow Run Timeout fires later.
WorkflowTaskTimeoutTimes out a Workflow Task that a Worker didn't complete in time.BackgroundThe timed-out Workflow Task stays outstanding and its retry is delayed.