Querying the Number of Snapshots
Function
This API is used to query the number of snapshots. Standard snapshots are available only in some regions. To check the supported regions, see the region information shown under "EVS Snapshots" in Function Overview
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/snapshots/count
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition The project ID. Constraints N/A Range For details, see Obtaining a Project ID. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
volume_id |
No |
String |
Definition The ID of the snapshot's source disk. You can obtain it on the disk list page of the EVS console. 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 255 characters. Default Value N/A |
status |
No |
String |
Definition The snapshot status. Constraints It can contain a maximum of 255 characters. Range N/A Default Value N/A |
id |
No |
String |
Definition The snapshot ID. You can obtain it on the snapshot list page of the EVS console. 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 snapshot's key-value pairs, for example, {"key1":"value1"}. 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
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
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Definition The quantity of resources. Range N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error |
Error object |
Definition The error information returned if an error occurs. Range N/A |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition The error code returned if an error occurs. Range For details about the error codes and their meanings, 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot