文档首页/ 云硬盘 EVS/ API参考/ API/ 标准快照管理/ 查询快照一致性组列表
更新时间:2025-09-28 GMT+08:00
分享

查询快照一致性组列表

功能介绍

查询快照一致性组列表。标准快照当前只在部分区域支持,具体的区域列表请参见"功能总览"中快照页签下的区域信息。

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/snapshot-groups/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

id

String

参数解释

指定的快照一致性组ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

name

String

参数解释

快照一致性组名称。

约束限制

最大支持255个字节。

最小长度:0

最大长度:255

取值范围

不涉及。

默认取值

不涉及。

status

String

参数解释

快照一致性组的状态。

约束限制

不涉及。

取值范围

  • creating:创建中。

  • avaialble:创建成功。

  • 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

参数解释

快照一致性组列表信息。

取值范围

不涉及。

表5 SnapshotGroupDetail

参数

参数类型

描述

id

String

参数解释

快照一致性组的ID。

取值范围

不涉及。

project_id

String

参数解释

快照一致性组的项目ID。

取值范围

不涉及。

created_at

String

参数解释

快照一致性组的创建时间。

取值范围

不涉及。

status

String

参数解释

快照一致性组的状态。

取值范围

  • creating:创建中。

  • avaialble:创建成功。

  • error:创建失败。

  • deleting: 删除中。

  • deleted:删除成功。

  • error_deleting:删除失败。

updated_at

String

参数解释

快照一致性组的更新时间。

取值范围

不涉及。

name

String

参数解释

快照一致性组的名称。

取值范围

不涉及。

description

String

参数解释

快照一致性组的描述。

取值范围

不涉及。

enterprise_project_id

String

参数解释

快照一致性组的企业项目id。

取值范围

不涉及。

tags

Map<String,String>

参数解释

快照一致性组的标签。

取值范围

不涉及。

server_id

String

参数解释

云服务器id。

取值范围

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error

Error object

参数解释

出现错误时,返回的错误信息。

取值范围

不涉及。

表7 Error

参数

参数类型

描述

code

String

参数解释

出现错误时,返回的错误码。

取值范围

错误码和其对应的含义请参考错误码说明

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

错误码

请参见错误码

相关文档