# 查询快照一致性组列表 - ListSnapshotGroup #### 功能介绍 查询快照一致性组列表。标准快照当前只在部分区域支持，具体的区域列表请通过控制台查询。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-evs/evs_04_0009.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-evs/evs_04_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | evs:snapshotGroups:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v5/{project_id}/snapshot-groups/detail 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-evs/evs_04_0046.html)。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释** 指定的快照一致性组ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | name | 否 | String | **参数解释** 快照一致性组名称。 **约束限制** 最大支持255个字节。 最小长度：0 最大长度：255 **取值范围** 不涉及。 **默认取值** 不涉及。 | | status | 否 | String | **参数解释** 快照一致性组的状态。 **约束限制** 不涉及。 **取值范围** - creating：创建中。 - available：创建成功。 - error：创建失败。 - deleting: 删除中。 - deleted：删除成功。 - error_deleting：删除失败。 **默认取值** 不涉及。 | | tag_key | 否 | String | **参数解释** 快照一致性组的标签的key。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | tags | 否 | String | **参数解释** 快照一致性组的标签的key/value对，例如\[{"key":"bbb","value":"bbb"}\]。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | enterprise_project_id | 否 | String | **参数解释** 快照一致性组的企业项目ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | limit | 否 | Integer | **参数解释** 返回结果个数限制。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | offset | 否 | Integer | **参数解释** 偏移量。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | sort_key | 否 | String | **参数解释** 返回结果按该关键字排序。 **约束限制** 不涉及。 **取值范围** - id：快照一致性组的ID。 - status：快照一致性组的状态。 - created_at：快照一致性组的创建时间。 **默认取值** created_at | | sort_dir | 否 | String | **参数解释** 返回结果按照降序或升序排列。 **约束限制** 不涉及。 **取值范围** - desc：降序。 - asc：升序。 **默认取值** desc | | server_id | 否 | String | **参数解释** 云服务器ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | snapshot_groups | Array of [SnapshotGroupDetail] objects | **参数解释** 快照一致性组列表信息。 **取值范围** 不涉及。 | 表5SnapshotGroupDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释** 快照一致性组的ID。 **取值范围** 不涉及。 | | project_id | String | **参数解释** 快照一致性组的项目ID。 **取值范围** 不涉及。 | | created_at | String | **参数解释** 快照一致性组的创建时间。 **取值范围** 不涉及。 | | status | String | **参数解释** 快照一致性组的状态。 **取值范围** - creating：创建中。 - available：创建成功。 - error：创建失败。 - deleting: 删除中。 - deleted：删除成功。 - error_deleting：删除失败。 | | updated_at | String | **参数解释** 快照一致性组的更新时间。 **取值范围** 不涉及。 | | name | String | **参数解释** 快照一致性组的名称。 **取值范围** 不涉及。 | | description | String | **参数解释** 快照一致性组的描述。 **取值范围** 不涉及。 | | enterprise_project_id | String | **参数解释** 快照一致性组的企业项目id。 **取值范围** 不涉及。 | | tags | Map\ | **参数解释** 快照一致性组的标签。 标签的value：String类型，最大长度43个字符，可以为空字符串。 由英文字母、数字、下划线、点、中划线、UNICODE字符（\\u4E00-\\u9FFF）组成。 标签的value：String类型，最大长度43个字符，可以为空字符串。 由英文字母、数字、下划线、点、中划线、UNICODE字符（\\u4E00-\\u9FFF）组成。 **取值范围** 不涉及。 | | server_id | String | **参数解释** 云服务器id。 **取值范围** 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释** 出现错误时，返回的错误信息。 **取值范围** 不涉及。 | 表7Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 出现错误时，返回的错误码。 **取值范围** 错误码和其对应的含义请[参考错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 | | message | String | **参数解释** 出现错误时，返回的错误消息。 **取值范围** 不涉及。 | #### 请求示例 无 #### 响应示例 **状态码：200** OK ``` { "snapshot_groups" : [ { "id" : "82700157-fa53-46bf-a51f-255624275cbe", "name" : "testSnapshotGroup", "description" : "test", "project_id" : "dae4ff26f73b4b3395a0f650a979beae", "enterprise_project_id" : "testEpId", "status" : "available", "tags" : { "key1" : "value1", "key2" : "value2", "key3" : "value3" }, "created_at" : "2025-04-10T09:40:12.204112", "updated_at" : "2025-04-10T09:40:12.607112", "server_id" : null } ] } ``` **状态码：400** Bad Request ``` { "error" : { "message" : "XXXX", "code" : "EVS.XXX" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。