GetSnapshot - Function Compute - Alibaba Cloud Documentation Center

Operation description

This API operation retrieves the MicroSandbox snapshot information of a specified function for the user.
Snapshot details are returned only when the snapshot belongs to the current function, has a status of Available, and has not expired.
If the snapshot does not exist, has expired, is being created, is being deleted, is an internal snapshot, or does not belong to the current function, it is treated as invisible and a 404 SnapshotNotFound error is returned.

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

GET /2023-03-30/functions/{functionName}/snapshots/{snapshotId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
functionName	string	Yes	The function name.	myFunction
snapshotId	string	Yes	The snapshot ID.	8e7d6c5b-4a3f-4c1a-9b8e-1f2a3b4c5d6e

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	Snapshot	The snapshot resource information.

Examples

Success response

JSON format

{
  "snapshotId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Available",
  "createdTime": "2026-07-30T10:00:00Z",
  "expiredTime": "2026-08-29T10:00:00Z",
  "description": "Snapshot for production environment",
  "sourceSessionId": "custom-test-session-id",
  "functionName": "my-function",
  "qualifier": "production",
  "resolvedVersion": "1",
  "imageRepository": "registry-vpc.cn-hangzhou.aliyuncs.com/example/function",
  "imageDigest": "sha256:0123456789abcdef",
  "osType": "linux",
  "memoryMB": 3072,
  "cpu": 2,
  "diskSizeMB": 10240,
  "artifactMemUsedSizeInB": 1073741824,
  "artifactDiskUsedSizeInB": 2147483648,
  "startCommand": "/code/start.sh",
  "readyCommand": "/code/ready.sh",
  "envs": {
    "key": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.