Querying Snapshot Statistics
Function
This API is used to query snapshot statistics.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/snapshots/statistics
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
cluster_id |
Yes |
String |
Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
statistics |
Array of SnapshotsStatistic objects |
Definition Snapshot statistics. Range N/A |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Definition Resource statistics name. Range storage.free: free capacity storage.paid: paid capacity storage.used: used capacity |
value |
Number |
Definition Resource statistics value. Range N/A |
unit |
String |
Definition Resource statistics unit. Range N/A |
Example Requests
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/snapshots/statistics
Example Responses
Status code: 200
Snapshot statistics queried.
{ "statistics" : [ { "name" : "storage.free", "value" : 300.0, "unit" : "GB" }, { "name" : "storage.paid", "value" : 0, "unit" : "GB" }, { "name" : "storage.used", "value" : 128.5, "unit" : "GB" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Snapshot statistics queried. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
You do not have required permissions. |
404 |
No resources found. |
500 |
Internal server error. |
503 |
Service unavailable. |
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