ListSnapshots-阿里云帮助中心

Lists snapshots.

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

pailangstudio:ListSnapshots

list

*All Resource

*

None

Request syntax

GET /api/v1/langstudio/snapshots HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	No	The workspace ID. To find the workspace ID, see ListWorkspaces.	478**
NextToken	string	No	The pagination token used to retrieve the next page of results. For the first request, leave this parameter empty. For subsequent requests, set this parameter to the `NextToken` value from the previous response.	10
MaxResults	integer	No	The maximum number of items to return for this request.	20
SortBy	string	No	The field to sort the results by. Defaults to `GmtCreateTime`. Valid values: `GmtCreateTime` (default): Sorts by creation time. `GmtModifiedTime`: Sorts by modification time.	GmtCreateTime
Order	string	No	The sort order. `ASC`: Ascending order. `DESC`: Descending order.	DESC
SnapshotId	string	No	The snapshot ID.	snap-asfg******123
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of items to return per page. Default: 10.	10
SnapshotResourceType	string	No	The type of the snapshot resource. Valid value: `Flow`: A workflow.	Flow
SnapshotResourceId	string	No	The ID of the snapshot resource.	flow-asfg******1234
Creator	string	No	The creator ID.	2003******4844
CreationType	string	No	The creation type of the snapshot. To specify multiple types, separate the values with a comma (,).	ManualCreated,DeploymentAutoCreated
SnapshotStatus	string	No

Response elements

Element	Type	Description	Example
	object	The data returned.
Snapshots	array	The list of snapshots.
	Snapshot	The snapshot details.
MaxResults	integer	The maximum number of items returned per page.	10
NextToken	string	The pagination token to retrieve the next page of results. This value is empty if there are no more results.	11
TotalCount	integer	The total number of snapshots.	25
RequestId	string	The request ID.	963BD7F9-0C02-5594-9550-BCC6DD43E3C0

Examples

Success response

JSON format

{
  "Snapshots": [
    {
      "WorkspaceId": "478**",
      "Accessibility": "PRIVATE",
      "Creator": "2680******4103",
      "GmtCreateTime": "2025-09-24T07:33:53Z",
      "GmtModifiedTime": "2025-09-24T08:58:35Z",
      "SnapshotId": "snap-qhn3******b369c0vo",
      "SnapshotName": "name01",
      "Description": "This is description",
      "SnapshotResourceType": "Flow",
      "SnapshotResourceId": "flow-6rymo******m7j0z4p",
      "CreationType": "ManualCreated",
      "SnapshotStoragePath": "oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src",
      "WorkDir": "oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/",
      "SnapshotUrl": "https://path/to/snapshot/zipfile",
      "SnapshotStatus": "",
      "ErrorMessage": ""
    }
  ],
  "MaxResults": 10,
  "NextToken": "11",
  "TotalCount": 25,
  "RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.