# Query Snapshot Consistency Group - DescribeUSnapGroupList

## Overview

Query Snapshot Consistency Group






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeUSnapGroupList`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.sigcalcloud.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | Availability Zone. See [Availability Zone List](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |No|
| **GroupId** | string | Consistency group snapshot ID, if not filled, the default is to pull the full list |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **GroupList** | array[[*SnapGroupInfo*](#snapgroupinfo)] | Consistency Group Snapshot List Information |**Yes**|
| **TotalCount** | int | Number of Consistency Groups |No|

#### Data Model


#### SnapGroupInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Name** | string | Consistency Group Snapshot Name |**Yes**|
| **GroupId** | string | Consistency Group Snapshot ID |**Yes**|
| **Status** | string | Status: Creating in progress Creating Normal Completed Failed Failure |**Yes**|
| **CreateTime** | int | Creation Time |**Yes**|
| **SysCount** | int | Number of System Disk Snapshots |**Yes**|
| **DataCount** | int | Number of Data Disk Snapshots |**Yes**|

## Example

### Request Example
    
```
https://api.sigcalcloud.com/?Action=DescribeUSnapGroupList
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=qsjqWONX
&GroupId=AkcUQxwG
```

### Response Example
    
```json
{
  "Action": "DescribeUSnapGroupListResponse",
  "GroupList": [
    {
      "CreateTime": 4,
      "DataCount": 7,
      "GroupId": "ctZqDsMV",
      "Name": "XfVkjlHH",
      "Status": "lJqbmSCf",
      "SysCount": 3
    }
  ],
  "RetCode": 0,
  "TotalCount": 3
}
```