查询快照一致性组列表
功能介绍
查询快照一致性组列表。标准快照当前只在部分区域支持，具体的区域列表请参见"功能总览"中快照页签下的区域信息。
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/snapshot-groups/detail
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释 项目ID。 约束限制 不涉及。 取值范围 获取方法请参见"获取项目ID"。 默认取值 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
指定的快照一致性组ID。 |
|
name |
否 |
String |
快照一致性组名称。最大支持255个字节。 最小长度：0 最大长度：255 |
|
status |
否 |
String |
快照一致性组的状态。N的取值范围：1~3。取值如下： creating：创建中。 avaialble：创建成功。 error：创建失败。 deleting: 删除中。 |
|
tag_key |
否 |
String |
快照一致性组的标签的key。 |
|
tags |
否 |
String |
快照一致性组的标签的key/value对，例如{"key1":"value1"} |
|
enterprise_project_id |
否 |
String |
快照一致性组的企业项目ID。 |
|
limit |
否 |
Integer |
返回结果个数限制。 |
|
offset |
否 |
Integer |
偏移量。 |
|
sort_key |
否 |
String |
返回结果按该关键字排序，支持id，status，size，created_at等关键字，默认为“created_at”。 |
|
sort_dir |
否 |
String |
返回结果按照降序或升序排列，默认为“desc”。 降序：desc 升序：asc |
|
server_id |
否 |
String |
云服务器ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
snapshot_groups |
Array of SnapshotGroupDetail objects |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
快照一致性组的ID。 |
|
created_at |
String |
快照一致性组的创建时间。 |
|
status |
String |
快照一致性组的状态。 |
|
updated_at |
String |
快照一致性组的更新时间。 |
|
name |
String |
快照一致性组的名称。 |
|
description |
String |
快照一致性组的描述。 |
|
enterprise_project_id |
String |
快照一致性组的企业项目id。 |
|
tags |
Map<String,String> |
快照一致性组的标签。 |
|
server_id |
String |
云服务器id。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Error object |
参数解释 出现错误时，返回的错误信息。 取值范围 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
错误码
请参见错误码。
