PauseSession - Function Compute - Alibaba Cloud Documentation Center

Operation description

Pauses an active session, persists the state of its associated execute environment, and releases the compute resource. After you invoke the operation, the session state changes to Paused, and the session no longer accepts function calling requests. This operation retains the session configurations, such as SessionTTL, and the session ID. You can use this operation to break long-running nodes or save snapshots of development environments for cost optimization and state management. This operation applies to custom container image functions configured with the HEADER_FIELD or GENERATED_COOKIE affinity type 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fc:PauseSession

update

*All Resource

*

None

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 for the session.	my-func
sessionId	string	No	The ID of the session to be saved.	test-session-id-1

Request parameters

Parameter	Type	Required	Description	Example
qualifier	string	No	The alias or version of the function associated with the session ID to be saved.	aliasName1
fileSystemOnly	string	No

Response elements

Element	Type	Description	Example
	Session	The session configuration information.

Examples

Success response

JSON format

{
  "allowInternetAccess": false,
  "autoPauseFileSystemOnly": false,
  "containerId": "c-68999e02-16a1955c-d2a03d1ccs",
  "createdTime": "2025-04-01T08:15:27Z",
  "disableSessionIdReuse": false,
  "enableAutoPause": false,
  "enableAutoResume": false,
  "functionName": "functionName1",
  "juiceFsConfig": {
    "envs": {
      "key": ""
    },
    "mountPoints": [
      {
        "args": [
          ""
        ],
        "mountDir": "",
        "remoteDir": "",
        "token": "",
        "volumeName": ""
      }
    ]
  },
  "lastModifiedTime": "2025-04-01T18:15:27Z",
  "nasConfig": {
    "groupId": 100,
    "mountPoints": [
      {
        "enableTLS": true,
        "mountDir": "/home/test",
        "serverAddr": "***-uni85.cn-hangzhou.nas.com:/"
      }
    ],
    "userId": 100
  },
  "network": {
    "allowOut": [
      ""
    ],
    "allowPublicTraffic": false,
    "denyOut": [
      ""
    ],
    "maskRequestHost": "",
    "rules": {
      "key": [
        {
          "transform": {
            "headerValueReplacements": [
              {
                "placeholder": "sbx-notion-key-0001",
                "value": "ntn_real_secret_xxx"
              }
            ],
            "headers": {
              "key": ""
            }
          }
        }
      ]
    }
  },
  "ossMountConfig": {
    "mountPoints": [
      {
        "bucketName": "my-bucket",
        "bucketPath": "/my-dir",
        "endpoint": "http://oss-cn-shanghai.aliyuncs.com",
        "mountDir": "/mnt/dir",
        "readOnly": true
      }
    ]
  },
  "polarFsConfig": {
    "groupId": 0,
    "mountPoints": [
      {
        "extraOptions": "--skip-delete-rows-check=false  --skip-dir-nlink=0 ",
        "instanceId": "pfs-xxx",
        "mountDir": "/mnt/polarfs",
        "readOnly": false,
        "remoteDir": "/share"
      }
    ],
    "userId": 0
  },
  "qualifier": "AliasName1",
  "sessionAffinityType": "HEADER_FIELD",
  "sessionId": "81f70ae156904eb9b7d43e12f511fe58",
  "sessionIdleTimeoutInSeconds": 1800,
  "sessionStatus": "Active",
  "sessionTTLInSeconds": 21600,
  "trafficAccessToken": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.