All Products
Search
Document Center

Elastic Compute Service:DeleteSnapshotGroup

Last Updated:Sep 29, 2024

Deletes a snapshot-consistent group.

Operation description

If you have custom images that were created from a disk snapshot contained in a snapshot-consistent group, the disk snapshot is retained when the snapshot-consistent group is deleted. Before you can delete the disk snapshot, you must call the DeleteImage operation to delete the custom images. After the custom images are deleted, you can call the DeleteSnapshot operation to delete the disk snapshot.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:DeleteSnapshotGroupdelete
  • SnapshotGroup
    acs:ecs:{#regionId}:{#accountId}:snapshotgroup/{#snapshotgroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the snapshot-consistent group. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
SnapshotGroupIdstringYes

The ID of the snapshot-consistent group. You can call the DescribeSnapshotGroups operation to query the IDs of one or more snapshot-consistent groups.

ssg-j6c9lpuyxo2uxxny****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

6EDE885A-FDC1-4FAE-BC44-6EACAEA6CC6E
OperationProgressSetarray<object>

Details about the delete operation.

OperationProgressobject
ErrorMsgstring

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
ErrorCodestring

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
OperationStatusstring

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
RelatedItemSetarray<object>

Details about the resources.

RelatedItemobject
Namestring

The name of the resource.

SnapshotId
Valuestring

The ID of the resource.

s-j6c9lpuyxo2uxxnx****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403SnapshotCreatedImageThe 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).
403Operation.ForbiddenThe operation is not permitted.The operation is not supported.
403SnapshotCreatedDiskThe 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.
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId provided does not exist
404InvalidSnapshotGroup.NotFoundThe SnapshotGroupId provided does not exist in our records.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history