文档首页/ 智能数据湖 AI DataLake/ API参考/ 镜像快照管理/ 查询镜像快照列表 - ListV2TenantImageSnapshots
更新时间:2026-10-10 GMT+08:00
分享

查询镜像快照列表 - ListV2TenantImageSnapshots

功能介绍

查询当前租户下的全部镜像快照列表。此接口为同步接口,无配套使用接口和特殊场景。

调用方法

请参见如何调用API。

URI

GET /v2/image-snapshots

表1 Query参数

参数

是否必选

参数类型

描述

status

否

String

参数解释:镜像快照状态。

约束限制:不涉及。

取值范围:

  • Creating:创建中。

  • Available:可用。

  • Unavailable:不可用。

默认取值:不涉及。

offset

否

Integer

参数解释:分页偏移量。

约束限制:不涉及。

取值范围:0~10000。

默认取值:0。

limit

否

Integer

参数解释:分页大小。

约束限制:不涉及。

取值范围:1~1000。

默认取值:100。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:用户Token,通过调用获取IAM用户Token接口获取。

约束限制:不涉及。

取值范围:只能由英文字母、数字及特殊字符组成,长度不超过65534个字符。Token格式由IAM服务定义,具体字符集参见IAM服务相关文档。

默认取值:不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:快照总数。

取值范围:0~10000。

image_snapshots

Array of V2ImageSnapshotInfo objects

参数解释:镜像快照列表。

表4 V2ImageSnapshotInfo

参数

参数类型

描述

id

String

参数解释:镜像快照记录ID。

取值范围:长度为32~36的英文字符、数字和中划线的组合。

image_id

String

参数解释:镜像ID。

取值范围:长度为32~36的英文字符、数字和中划线的组合。

image_version_id

String

参数解释:镜像版本ID。

取值范围:长度为32~36的英文字符、数字和中划线的组合。

name

String

参数解释:镜像快照名称(用户指定)。

取值范围:以小写字母开头,小写字母、数字、中划线(-)组成,小写字母或数字结尾的1到190字符的字符串。

image_address

String

参数解释:镜像完整地址(含registry/namespace/name:version)。

取值范围:支持英文字母、数字、小数点、冒号、斜杠及连字符,长度为0~1024个字符。

image_name

String

参数解释:镜像名称。

取值范围:支持英文字母、数字、小数点、斜杠、冒号、下划线和连字符,长度为0~128个字符。

image_version

String

参数解释:镜像版本。

取值范围:支持英文字母、数字、小数点、冒号、下划线和连字符,长度为0~1024个字符。

status

String

参数解释:镜像快照状态。

取值范围:

  • Creating:创建中。

  • Available:可用。

  • Unavailable:不可用。

image_snapshot_size

Integer

参数解释:快照大小,单位GiB。

取值范围:20~400。

creation_mode

String

参数解释:创建方式。

取值范围:

  • Created:直接创建。

  • Associated:关联CCI已有快照。

reserved_days

Integer

参数解释:镜像快照保留天数。超过保留天数自动失效,0表示永久保留。

取值范围:0~65536。

expire_time

String

参数解释:镜像快照超期时间,null表示永久有效。使用UTC时间,ISO 8601格式,yyyy-MM-dd'T'HH:mm:ss.SSSXXX,例如:2025-01-10T03:37:12.000+00:00。

取值范围:不涉及。

failed_message

String

参数解释:镜像快照失效的提示信息。

取值范围:支持中文字符、英文字母、数字及常用符号,长度为0~65535个字符。

create_time

String

参数解释:创建时间,使用UTC时间,ISO 8601格式,yyyy-MM-dd'T'HH:mm:ss.SSSXXX,例如:2025-01-10T03:37:12.000+00:00。

取值范围:不涉及。

update_time

String

参数解释:更新时间,使用UTC时间,ISO 8601格式,yyyy-MM-dd'T'HH:mm:ss.SSSXXX,例如:2025-01-10T03:37:12.000+00:00。

取值范围:不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

请求示例

查询当前租户下状态为可用的镜像快照列表,从第0条开始查询10条。

GET /v2/image-snapshots?status=Available&offset=0&limit=10

响应示例

状态码:200

{
  "total" : 1,
  "image_snapshots" : [ {
    "id" : "1a2b3c4d-5e6f-7890-abcd-1e2f3a4b5c6d",
    "image_id" : "1a2b3c4d-5e6f-7890-abcd-1e2f3a4b5c6d",
    "image_version_id" : "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
    "name" : "my-snapshot",
    "image_address" : "swr.example.com/ns/my-image:v1.0",
    "image_name" : "my-image",
    "image_version" : "v1.0",
    "status" : "Available",
    "image_snapshot_size" : 60,
    "creation_mode" : "Created",
    "reserved_days" : 30,
    "expire_time" : "2026-09-25T00:00:00.000+00:00",
    "failed_message" : "",
    "create_time" : "2026-08-26T10:00:00.000+00:00",
    "update_time" : "2026-08-26T10:05:00.000+00:00"
  } ]
}

状态码:400

{
  "error_code" : "AIDataLake.00010151",
  "error_msg" : "Parameter value is invalid.",
  "solution_msg" : "Please input valid parameter value."
}

状态码:401

{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
  "solution_msg" : "Check whether the IAM authentication information is correct."
}

状态码:403

{
  "error_code" : "AIDataLake.00010150",
  "error_msg" : "The operation is not allowed.",
  "solution_msg" : "Check whether the operation is allowed in the current status."
}

状态码:500

{
  "error_code" : "AIDataLake.00011001",
  "error_msg" : "Internal error.",
  "solution_msg" : "Contact technical support or try again later."
}

状态码

状态码

描述

200

请求成功。

400

请求参数错误。

401

未授权。

403

禁止访问。

500

内部服务器错误。

相关文档