Querying the Number of Snapshot Consistency Groups
Function
This API is used to query the number of snapshot consistency groups. 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}/snapshot-groups/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 |
---|---|---|---|
name |
No |
String |
The name of the snapshot consistency group. |
status |
No |
String |
The status of the snapshot consistency group. |
id |
No |
String |
The ID of the snapshot consistency group. |
enterprise_project_id |
No |
String |
The ID of the enterprise project to which the snapshot consistency group belongs. |
tag_key |
No |
String |
The tag key of the snapshot consistency group. |
tags |
No |
String |
The key-value pairs of the snapshot consistency group tags, for example, {"key1":"value1"}. |
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 |
The number of resources. |
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}/snapshot-groups/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