All Products
Search

This Product

    Platform For AI:GetInstanceSnapshot

    Document Center

    Platform For AI:GetInstanceSnapshot

    Last Updated:Feb 25, 2026

    Call the GetInstanceSnapshot operation to retrieve an instance 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

    paidsw:GetInstanceSnapshot

    get

    *All Resource

    *

    		 None None

    Request syntax

    GET /api/v2/instances/{InstanceId}/snapshots/{SnapshotId} HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID. For more information, see ListInstances.

    dsw-730xxxxxxxxxx
    SnapshotId

    string

    Yes

    The instance snapshot ID. For more information, see ListInstanceSnapshot.

    snp-05cexxxxxxxxx

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    No parameters required.

    Response elements

    Element

    Type

    Description

    Example

    object

    The response object.

    RequestId

    string

    The request ID.

    E7D55162-4489-1619-AAF5-3F97D5FCA948
    Success

    boolean

    The success flag. Valid values:

    • true

    • false

    true
    Message

    string

    The returned message.

    "XXX"
    Code

    string

    The status code. Valid values:

    • InternalError: An internal error. This includes all errors except parameter validation errors.

    • ValidationError: A parameter validation error.

    null
    HttpStatusCode

    integer

    The HTTP status code. Valid values:

    • 400

    • 404

    null
    InstanceId

    string

    The instance ID.

    dsw-730xxxxxxxxxx
    SnapshotId

    string

    The instance snapshot ID.

    snp-05cexxxxxxxxx
    SnapshotName

    string

    The name of the instance snapshot.

    training_data_env
    Status

    string

    The status of the instance snapshot.

    Pushing
    ImageId

    string

    The image ID of the instance snapshot.

    image-05cefd0be2exxxx
    ImageUrl

    string

    The image URL of the instance snapshot.

    registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu
    ReasonCode

    string

    The error code of the instance snapshot.

    Internal Error
    ReasonMessage

    string

    The error message of the instance snapshot.

    ImagePullBackOff
    GmtCreateTime

    string

    The time when the instance snapshot was created.

    2021-01-12T14:36:01Z
    GmtModifiedTime

    string

    The time when the instance snapshot was last modified.

    2021-01-12T14:36:01Z
    Labels

    array<object>

    The custom tags.

    {'foo': 'bar'}

    object

    Key

    string

    The key of the custom tag.

    stsTokenOwner
    Value

    string

    The value of the custom tag.

    123xxxxxxxx
    ExcludePaths

    array

    A list of file paths to exclude. This parameter is supported only for ECI instances and is used to ignore specified folders or files when an image is created.

    string

    Examples

    Success response

    JSON format

    {
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "InstanceId": "dsw-730xxxxxxxxxx",
  "SnapshotId": "snp-05cexxxxxxxxx",
  "SnapshotName": "training_data_env",
  "Status": "Pushing",
  "ImageId": "image-05cefd0be2exxxx",
  "ImageUrl": "registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu",
  "ReasonCode": "Internal Error",
  "ReasonMessage": "ImagePullBackOff",
  "GmtCreateTime": "2021-01-12T14:36:01Z",
  "GmtModifiedTime": "2021-01-12T14:36:01Z",
  "Labels": [
    {
      "Key": "stsTokenOwner",
      "Value": "123xxxxxxxx"
    }
  ],
  "ExcludePaths": [
    ""
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.