ListInstanceSnapshot - Platform For AI - Alibaba Cloud Documentation Center

Lists instance 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

paidsw:ListInstanceSnapshot

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. For more information, see ListInstances.	dsw-730xxxxxxxxxx
PageNumber	integer	No	The page number. The value must be greater than or equal to 1. The default value is 1.	1
PageSize	integer	No	The number of instance snapshots to return on each page. The default value is 10.	10
SortBy	string	No	The field to sort the results by. Set the value to gmtCreate.	gmtCreate
Order	string	No	The sort order. Valid values: Desc: Sorts the results in descending order. Asc: Sorts the results in ascending order.	DESC

Response elements

Element	Type	Description	Example
	object	The list of instance snapshots.
RequestId	string	The request ID.	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Message	string	The returned message.	"XXX"
Code	string	The status code. Valid values: InternalError: An internal error occurred. This includes all errors except for parameter validation errors. ValidationError: A parameter validation error occurred.	null
HttpStatusCode	integer	The HTTP status code. Valid values: 400 404	null
TotalCount	integer	The total number of instances.	35
Snapshots	array<object>	The list of instance snapshots on the current page.
	object	The instance snapshot object.
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 URL of the image for the instance snapshot.	registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu
ReasonCode	string	The error code for the instance snapshot.	Internal Error
ReasonMessage	string	The error message for 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	The key-value pair of the custom tag.
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. It is used to ignore specified folders or files when you create an image.	["/path1","/path2"]
	string

Examples

Success response

JSON format

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "TotalCount": 35,
  "Snapshots": [
    {
      "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.