Help Center/ Elastic Volume Service/ API Reference/ API/ Standard Snapshot Management/ Querying the Number of Snapshots
Updated on 2025-11-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Number of Snapshots

Function

This API is used to query the number of snapshots. Standard snapshots are only supported in some regions. You can check the supported regions on the console.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/snapshots/count

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

volume_id

No

String

Definition

The ID of the snapshot's source disk.

You can call the Querying Details About All EVS Disks API to obtain the disk ID.

Constraints

N/A

Range

N/A

Default Value

N/A

availability_zone

No

String

Definition

The AZ of the snapshot's source disk.

Constraints

N/A

Range

N/A

Default Value

N/A

name

No

String

Definition

The snapshot name.

Constraints

N/A

Range

It can contain a maximum of 64 characters.

Default Value

N/A

status

No

String

Definition

The snapshot status.

Constraints

It can contain a maximum of 255 characters.

Range

For details, see EVS Snapshot Status.

Default Value

N/A

id

No

String

Definition

The snapshot ID.

You can call the Querying Details About EVS Snapshots API to obtain the snapshot ID.

Constraints

N/A

Range

N/A

Default Value

N/A

snapshot_type

No

String

Definition

The snapshot creation source.

Constraints

N/A

Range

N/A

Default Value

N/A

enterprise_project_id

No

String

Definition

The ID of the enterprise project to which the snapshot belongs.

For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

Constraints

N/A

Range

N/A

Default Value

N/A

tag_key

No

String

Definition

The snapshot tag key.

Constraints

N/A

Range

N/A

Default Value

N/A

tags

No

String

Definition

The key-value pairs of the snapshot tags, for example, [{"key":"bbb","value":"bbb"}].

Constraints

N/A

Range

N/A

Default Value

N/A

snapshot_chain_id

No

String

Definition

The snapshot chain ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The user token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Definition

The resource quantity.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Error object

Definition

The error information returned if an error occurs.

Range

N/A
Table 6 Error

Parameter

Type

Description

code

String

Definition

The error code returned if an error occurs.

Range

For details about the error code, see Error Codes.

message

String

Definition

The error message returned if an error occurs.

Range

N/A

Example Requests

GET https://{endpoint}/v5/{project_id}/snapshots/count

Example Responses

Status code: 200

OK

{
  "count" : 100
}

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "EVS.XXX"
  }
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.