All Products
Search
Document Center

Elastic Compute Service:DescribeSnapshotsUsage

Last Updated:Nov 14, 2024

Queries the number of snapshots that are stored in a region and the total size of the snapshots.

Operation description

Usage notes

If you want to view the snapshot usage of each disk in the current region, we recommend that you call the DescribeSnapshotLinks operation to query snapshot chain information.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeSnapshotsUsageget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
SnapshotSizelong

The total size of snapshots stored in the current region. Unit: bytes.

122
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
SnapshotCountinteger

The number of snapshots stored in the current region.

5

Examples

Sample success responses

JSONformat

{
  "SnapshotSize": 122,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "SnapshotCount": 5
}

Error codes

HTTP status codeError codeError messageDescription
403InvalidParam.RegionIdThe specified region is not exist.The specified region does not exist.

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

Change history

Change timeSummary of changesOperation
No change history