Delete a snapshot-consistent group using the DeleteSnapshotGroup API - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Deletes a snapshot-consistent group.

Operation description

If disk snapshots in a snapshot-consistent group have been used to create custom images, the related disk snapshots are not deleted when the snapshot-consistent group is deleted. To delete the related disk snapshots, first delete the custom images (DeleteImage), and then delete the related disk snapshots (DeleteSnapshot).

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

ecs:DeleteSnapshotGroup

delete

*SnapshotGroup

acs:ecs:{#regionId}:{#accountId}:snapshotgroup/{#snapshotgroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the snapshot-consistent group. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
SnapshotGroupId	string	Yes	The ID of the snapshot-consistent group. You can call DescribeSnapshotGroups to query snapshot-consistent group IDs.	ssg-j6c9lpuyxo2uxxny****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	6EDE885A-FDC1-4FAE-BC44-6EACAEA6CC6E
OperationProgressSet	object
OperationProgress	array<object>	The collection of operation status information when the snapshot-consistent group is deleted.
	array<object>
ErrorMsg	string	The error message. This parameter is empty when the operation is successful. For information about error codes and error messages, visit the API error center.	testErrorMsg
ErrorCode	string	The error code. This parameter is empty when the operation is successful. For information about error codes and error messages, visit the API error center.	400
OperationStatus	string	Indicates whether the operation was successful. If the operation was successful, a value of Success is returned. If the operation failed, an error code and an error message are returned.	Success
RelatedItemSet	object
RelatedItem	array<object>	Details about the resources.
	object
Name	string	The name of the resource.	SnapshotId
Value	string	The ID of the resource.	s-j6c9lpuyxo2uxxnx****

Examples

Success response

JSON format

{
  "RequestId": "6EDE885A-FDC1-4FAE-BC44-6EACAEA6CC6E",
  "OperationProgressSet": {
    "OperationProgress": [
      {
        "ErrorMsg": "testErrorMsg",
        "ErrorCode": "400",
        "OperationStatus": "Success",
        "RelatedItemSet": {
          "RelatedItem": [
            {
              "Name": "SnapshotId",
              "Value": "s-j6c9lpuyxo2uxxnx****"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to an internal error and you may retry later or contact support with the request ID.
403	SnapshotCreatedImage	The snapshot has been used to create user defined image(s).	The snapshot has been used to create custom images and cannot be deleted. The snapshot can be deleted only after the created custom images are deleted (DeleteImage).
403	Operation.Forbidden	The operation is not permitted.	The operation is not supported.
403	SnapshotCreatedDisk	The snapshot that you are trying to delete is in use by one or more Disks.	The snapshot that you are attempting to delete has been used to create one or more disks.
403	InvalidOperation.ResourceManagedByCloudProduct	The current operation is not supported because the resource is managed by a cloud product. Please contact the relevant cloud product to confirm the reason.	This operation is not supported because the resource is managed by cloud products. Contact the corresponding cloud product to confirm the reason.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	InvalidSnapshotGroup.NotFound	The SnapshotGroupId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.