All Products
Search

This Product

    Platform For AI:GetSnapshot

    Document Center

    Platform For AI:GetSnapshot

    Last Updated:May 26, 2026

    Retrieves the details of a snapshot.

    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:GetSnapshot

    get

    *All Resource

    *

    		 None None

    Request syntax

    GET /api/v1/langstudio/snapshots/{SnapshotId} HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    SnapshotId

    string

    No

    The snapshot ID.

    snap-asfg******123

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    WorkspaceId

    string

    No

    The workspace ID. To obtain a workspace ID, see ListWorkspaces.

    478***

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    RequestId

    string

    The request ID.

    963BD7F9-0C02-5594-9550-BCC6DD43E3C0
    WorkspaceId

    string

    The workspace ID. To obtain a workspace ID, see ListWorkspaces.

    478**
    Accessibility

    string

    The visibility of the snapshot. Valid values:

    • PRIVATE: The snapshot is visible only to you and administrators.

    • PUBLIC: The snapshot is visible to all users.

    PRIVATE
    Creator

    string

    The ID of the user who created the snapshot.

    2680******4103
    GmtCreateTime

    string

    The time the snapshot was created.

    2025-09-24T07:33:53Z
    GmtModifiedTime

    string

    The time the snapshot was last modified.

    2025-09-24T08:58:35Z
    SnapshotId

    string

    The ID of the snapshot.

    snap-asfg******123
    SnapshotName

    string

    The name of the snapshot.

    snapshot01
    Description

    string

    A description of the snapshot.

    This is description
    SnapshotResourceType

    string

    The resource type of the snapshot. Valid value:

    • Flow: A workflow.

    Flow
    SnapshotResourceId

    string

    The ID of the snapshot resource.

    flow-asfg******1234
    CreationType

    string

    The creation type of the snapshot. Valid values:

    • ManualCreated: The snapshot was created manually.

    • DeploymentAutoCreated: The snapshot was created automatically by a deployment service.

    • EvaluationAutoCreated: The snapshot was created automatically by an evaluation task.

    ManualCreated
    SnapshotStoragePath

    string

    The OSS path to the snapshot's source file.

    oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src
    WorkDir

    string

    The OSS working directory for the snapshot.

    oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/
    SnapshotUrl

    string

    The download URL for the snapshot.

    https://path/to/snapshot/zipfile
    SnapshotStatus

    string

    ErrorMessage

    string

    Examples

    Success response

    JSON format

    {
  "RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0",
  "WorkspaceId": "478**",
  "Accessibility": "PRIVATE",
  "Creator": "2680******4103",
  "GmtCreateTime": "2025-09-24T07:33:53Z",
  "GmtModifiedTime": "2025-09-24T08:58:35Z",
  "SnapshotId": "snap-asfg******123",
  "SnapshotName": "snapshot01",
  "Description": "This is description",
  "SnapshotResourceType": "Flow",
  "SnapshotResourceId": "flow-asfg******1234",
  "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": ""
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.