接口功能介绍

查询云主机快照列表
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权

接口约束

快照状态应符合以下状态：创建中,成功,恢复中,错误

URI

POST /v4/ecs/snapshot/list

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池获取：查资源池列表查询	bb9fdb42056f11eda1610242ac110002
projectID	否	String	企业项目ID，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。您可以通过查看创建企业项目了解如何创建企业项目	0
pageNo	否	Integer	页码，取值范围：正整数（≥1），注：默认值为1	1
pageSize	否	Integer	每页记录数目，取值范围：[1, 50]，注：默认值为10	10
instanceID	否	String	云主机ID，您可以查看弹性云主机了解云主机的相关信息获取：查查询云主机列表创创建一台按量付费或包年包月的云主机创批量创建按量付费或包年包月云主机	b6e2966d-7b1c-385e-abe4-d940caa273b7
snapshotStatus	否	String	云主机快照状态，取值范围：pending（创建中）， available（可用）， restoring（恢复中）， error（错误）注：该参数大小写敏感	restoring
snapshotID	否	String	云主机快照ID，获取：查查询云主机快照列表查创建云主机快照	73e30bcd-119b-9653-f864-a50150434a90
queryContent	否	String	模糊查询查询内容,（匹配字段：instanceID、snapshotID、snapshotName）
snapshotName	否	String	云主机快照名称。满足以下规则：不能使用中文，且长度为2-63字符	snapshot_for_restore

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败）	800
errorCode	String	错误码，为product.module.code三段式码	Openapi.PatternCheck.NotValid
error	String	错误码，为product.module.code三段式码	Openapi.PatternCheck.NotValid
message	String	失败时的错误描述，一般为英文描述	SUCCESS
description	String	失败时的错误描述，一般为中文描述	成功
returnObj	Object	返回参数		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
currentCount	Integer	当前页记录数目	1
totalCount	Integer	总记录数	10
totalPage	Integer	总页数	1
results	Array of Objects	分页明细		results

表 results

参数	参数类型	说明	示例	下级对象
snapshotID	String	云主机快照ID	73e30bcd-119b-9653-f864-a50150434a90
instanceID	String	云主机ID	c4cb5146-a148-3427-0425-73dd2b81e60a
instanceName	String	云主机名称	openapi-vm833508
azName	String	可用区名称	az1
snapshotName	String	云主机快照名称	snapshot_for_restore
instanceStatus	String	云主机状态，取值范围： backingup: 备份中， creating: 创建中， expired: 已到期， freezing: 已冻结， rebuild: 重装， restarting: 重启中， running: 运行中， starting: 开机中， stopped: 已关机， stopping: 关机中， error: 错误， snapshotting: 快照创建中， unsubscribed: 包周期已退订， unsubscribing: 包周期退订中。更多云主机状态请通过状态枚举值查看云主机使用状态	stopped
snapshotStatus	String	云主机快照状态， pending: 创建中, available: 可用， restoring: 恢复中， error：错误	restoring
snapshotDescription	String	云主机快照描述
projectID	String	企业项目ID	0
createdTime	String	创建时间	2022-10-31 T02:08:52Z
updatedTime	String	更新时间	2022-10-31 T02:09:26Z
imageID	String	云主机镜像ID	b78812b0-ff50-4816-b58f-5c4fbc230b08
memory	Integer	云主机内存大小，单位 MB	2048
cpu	Integer	云主机cpu核数	1
flavorID	String	云主机规格ID	5f3ba144-98e4-ea85-ea9b-933394dded33
members	Array of Objects	云主机的云硬盘及其快照详细信息		members

表 members

参数	参数类型	说明	示例
diskType	String	云硬盘类型，取值范围： SATA：普通IO SAS：高IO SSD：超高IO SSD-genric：通用型SSD FAST-SSD：极速型SSD	SATA
diskID	String	云硬盘ID	f0c85685-c038-46e3-84cd-9f41ca98938d
diskName	String	云硬盘名称	openapi-ipType-volume_00
isBootable	Boolean	是否是可启动磁盘,取值范围： false：非启动盘， true：可启动盘	true
isEncrypt	Boolean	是否加密盘，取值范围： false：不加密， true：加密，默认值为false	false
diskSize	Integer	云硬盘大小	40
diskSnapshotID	String	云硬盘快照ID	56ac8923-87c7-4970-a71c-552f0df34752
diskSnapshotStatus	String	云硬盘快照状态	available

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

示例1：在华东1资源池查询一台云主机的快照名称为"snapshot_for_restore"的列表
{
  "regionID": "bb9fdb42056f11eda1610242ac110002",
  "projectID": "0", 
  "pageNo":1, 
  "pageSize":50, 
  "instanceID": "c4cb5146-a148-3427-0425-73dd2b81e60a", 
  "snapshotName" : "snapshot_for_restore"
}
示例2：查询华东1资源池所有云主机快照列表
{
  "regionID": "bb9fdb42056f11eda1610242ac110002"
}

响应示例

{
  "returnObj": {
      "currentCount": 1,
      "totalCount": 1,
      "totalPage": 1,
      "results": [
        {
          "snapshotID": "73e30bcd-119b-9653-f864-a50150434a90",
          "instanceID": "c4cb5146-a148-3427-0425-73dd2b81e60a",
          "instanceName": "openapi-vm833508",
          "snapshotName ": "snapshot_for_restore ",
          "azName": "cn-huadong1-jsnj1A-public-ctcloud",
          "instanceStatus ": "stopped",
          "snapshotStatus ": "restoring ",
          "snapshotDescription ": "",
          "projectID ": "0 ",
          "createdTime ": "2022-10-31 T02:08:52Z",
          "updatedTime ": "2022-10-31 T02:09:26Z",
          "imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08",
          "memory": 2048,
          "cpu": 1,
          "flavorID": "5f3ba144-98e4-ea85-ea9b-933394dded33",
          "members ": [
            {
              "diskType ": "SATA",
              "diskID ": "f0c85685-c038-46e3-84cd-9f41ca98938d",
              "diskName ": "openapi-ipType-volume_000",
              "isBootable ": true,
              "isEncrypt ": false,
              "diskSize ": 40,
              "diskSnapshotID ": "56ac8923-87c7-4970-a71c-552f0df34752",
              "diskSnapshotStatus ": "available"
            }
          ]
        }
      ]
    },
	"message": "SUCCESS", 
	"description": "成功", 
	"statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码