CreateInstanceSnapshot - Platform For AI - Alibaba Cloud Documentation Center

Creates 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:CreateInstanceSnapshot

create

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. For more information about how to obtain an instance ID, see ListInstances.	dsw-730xxxxxxxxxx
body	object	No	The properties of the instance snapshot.
SnapshotName	string	Yes	The name of the instance snapshot. The name can contain only lowercase letters, digits, and hyphens (-). It is used for the display name of the custom image and the image version name in ACR.	snapshot-v1
SnapshotDescription	string	No	The description of the instance snapshot.	snapshot-v1
ImageUrl	string	Yes	The image URL. For more information about how to obtain an image URL, see ListImages.	registry.cn-shanghai.aliyuncs.com/test/example:snapshot-v1
Labels	array	No	The custom tags.	{'foo': 'bar'}
	object	No	A key-value pair of a custom tag.
Key	string	No	The key of the custom tag.	stsTokenOwner
Value	string	No	The value of the custom tag.	123xxxxxxxx
ExcludePaths	array	No	The 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.
	string	No
Overwrite	boolean	No	Specifies whether to overwrite an existing image tag in the image repository.

Response elements

Element	Type	Description	Example
	object	The result of the request.
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. All errors except parameter authentication errors are classified as internal errors. ValidationError: A parameter authentication error occurred.	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

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"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.