All Products
Search
Document Center

Function Compute:PauseSession

Last Updated:Mar 13, 2026

Pauses and saves a session.

Operation description

Pauses an active session. This operation saves the state of the associated execution environment and then releases the compute resources. After you call this operation, the session state changes to Paused. A paused session does not accept function invocation requests. The operation retains the session configuration, such as the SessionTTL and SessionID. Use this operation to interrupt long-running tasks or save snapshots of a development environment. This helps optimize costs and manage state. This operation applies to custom image functions that use HEADER_FIELD or GENERATED_COOKIE affinity types and session isolation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

PUT /2023-03-30/functions/{functionName}/sessions/{sessionId}/pause HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

functionName

string

No

The name of the function.

my-func

sessionId

string

No

The ID of the session to save.

test-session-id-1

Request parameters

Parameter

Type

Required

Description

Example

qualifier

string

No

The function alias or version associated with the session to pause

aliasName1

Response elements

Element

Type

Description

Example

Session

The information about the session.

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.